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
Property | Type | Contract | Description |
---|---|---|---|
| string | required | Token identifying the client application. |
| string | required | Access token of the client application. |
| string | required | Name and version of the client application. |
| array of string | optional, max 1000 items | Unique identifiers of the Enterprises. If not specified, the operation returns data for all enterprises within scope of the Access Token. |
| string | optional, max 1000 items | Unique identifiers of the requested Payment requests. |
| array of string | optional, max 1000 items | Unique identifiers of Customer accounts to which payment requests were issued. |
| array of string | optional, max 1000 items | Unique identifiers of specific Reservations to which payment requests belong. |
| optional, max length 3 months | Interval in which Payment request was updated. | |
| optional | A list of payment request states to filter by. | |
| required | Limitation on the quantity of payment requests returned (using cursor pagination). |
Response
Property | Type | Contract | Description |
---|---|---|---|
| array of Payment requests | required | The filtered payment requests. |
| string | optional | Unique identifier of the last and hence oldest payment request returned. This can be used in Limitation in a subsequent request to fetch the next batch of older payment requests. |
Payment request
Property | Type | Contract | Description |
---|---|---|---|
| string | required | Unique identifier of the payment request. |
| string | required | Unique identifier of the Enterprise. |
| string | required | Unique identifier of the Customer to which the payment request was issued. |
| string | optional | Unique identifier of the Reservation the payment request belongs to. |
| string | required | Creation date and time of the payment request in UTC timezone in ISO 8601 format. |
| string | required | Last update date and time of the payment request in UTC timezone in ISO 8601 format. |
| string | optional | Unique identifier of the Reservation group. |
| required | A payment request state. | |
| required | Amount of the payment request. | |
| required | A payment request type. | |
| required | A payment request reason. | |
| string | required | Date and time of the payment request's expiration in ISO 8601 format. |
| string | required | Description of the payment request. |
| 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
Property | Type | Contract | Description |
---|---|---|---|
| string | required | Token identifying the client application. |
| string | required | Access token of the client application. |
| string | required | Name and version of the client application. |
| string | optional | Unique identifier of the Enterprise. Required when using a Portfolio Access Token, ignored otherwise. |
| array of Payment request parameters | required, max 1000 items | Payment requests to be added. |
Payment request parameters
Property | Type | Contract | Description |
---|---|---|---|
| string | required | Unique identifier of the Customer account to which the payment request is issued. |
| required | Amount of the payment request. | |
| required | A payment request type. | |
| required | A payment request reason. | |
| string | required | Date and time of the payment request's expiration in ISO 8601 format. |
| string | required, max 1000 characters | Description of the payment request. |
| string | optional | Unique identifier of the Reservation the payment request belongs to. |
| string | optional, max 1000 characters | Payment request's notes. |
Currency value
Property | Type | Contract | Description |
---|---|---|---|
| string | required | ISO-4217 code of the Currency. |
| number | required | Amount in the currency. |
Response
Property | Type | Contract | Description |
---|---|---|---|
| array of Payment requests | 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
Property | Type | Contract | Description |
---|---|---|---|
| string | required | Token identifying the client application. |
| string | required | Access token of the client application. |
| string | required | Name and version of the client application. |
| array of string | required, max 1000 items | Identifiers of payment requests to be canceled. |
Response
Property | Type | Contract | Description |
---|---|---|---|
| array of Payment requests | required | Canceled payment requests. |
Last updated