Payment requests
Get all payment requests
Get all payment requests belonging to the specified customer accounts. Note this operation uses Pagination and supports Portfolio Access Tokens.
Request
[PlatformAddress]/api/connector/v1/paymentRequests/getAll
ClientToken
string
required
Token identifying the client application.
AccessToken
string
required
Access token of the client application.
Client
string
required
Name and version of the client application.
EnterpriseIds
array of string
optional, max 1000 items
PaymentRequestIds
string
optional, max 1000 items
AccountIds
array of string
optional, max 1000 items
ReservationIds
array of string
optional, max 1000 items
UpdatedUtc
optional, max length 3 months
States
optional
A list of payment request states to filter by.
Limitation
required
Limitation on the quantity of payment requests returned (using cursor pagination).
Response
PaymentRequests
required
The filtered payment requests.
Cursor
string
optional
Payment request
Id
string
required
Unique identifier of the payment request.
EnterpriseId
string
required
AccountId
string
required
ReservationId
string
optional
CreatedUtc
string
required
Creation date and time of the payment request in UTC timezone in ISO 8601 format.
UpdatedUtc
string
required
Last update date and time of the payment request in UTC timezone in ISO 8601 format.
ReservationGroupId
string
optional
State
required
A payment request state.
Amount
required
Amount of the payment request.
Type
required
A payment request type.
Reason
required
A payment request reason.
ExpirationUtc
string
required
Date and time of the payment request's expiration in ISO 8601 format.
Description
string
required
Description of the payment request.
Notes
string
optional
Payment request's notes.
Payment request state
Pending
- payment request is active and waiting for completion.Completed
- payment request was fulfilled.Canceled
- payment request was canceled.Expired
- payment request is past its expiration date and no longer active.
Payment request type
Payment
- indicates that a payment is requested.Preauthorization
- indicates that a Preauthorization is requested.
Payment request reason
PaymentCardMissing
PaymentCardDeclined
Prepayment
Fee
Other
...
Add payment requests
Creates a payment request to the specified Customer. Note this operation supports Portfolio Access Tokens.
Request
[PlatformAddress]/api/connector/v1/paymentRequests/add
ClientToken
string
required
Token identifying the client application.
AccessToken
string
required
Access token of the client application.
Client
string
required
Name and version of the client application.
EnterpriseId
string
optional
PaymentRequests
required, max 1000 items
Payment requests to be added.
Payment request parameters
AccountId
string
required
Amount
required
Amount of the payment request.
Type
required
A payment request type.
Reason
required
A payment request reason.
ExpirationUtc
string
required
Date and time of the payment request's expiration in ISO 8601 format.
Description
string
required, max 1000 characters
Description of the payment request.
ReservationId
string
optional
Notes
string
optional, max 1000 characters
Payment request's notes.
Currency value
Currency
string
required
Value
number
required
Amount in the currency.
Response
PaymentRequests
required
Added payment requests.
Cancel payment requests
Cancels specified payment requests. Only payment requests which are in Pending
state can be canceled.
Request
[PlatformAddress]/api/connector/v1/paymentRequests/cancel
ClientToken
string
required
Token identifying the client application.
AccessToken
string
required
Access token of the client application.
Client
string
required
Name and version of the client application.
PaymentRequestIds
array of string
required, max 1000 items
Identifiers of payment requests to be canceled.
Response
PaymentRequests
required
Canceled payment requests.
Last updated