Retrieve Payments allows the Agent to access payment information related to bookings and transactions, facilitating retrieval of payment data.
| Method | Endpoint | Description |
|---|
| GET | v2023.07.31/payments | Returns Payment details |
| Parameter | Required / Optional | Description | Data Type |
|---|
| page | Optional | The page to be shown | int |
| pageSize | Optional | Limits the number of returned results | int |
| startDate | Optional | Beginning date for payments to return | date-time |
| endDate | Optional | End date for payments to return | date-time |
| reservationId | Optional | Unique Identifier for reservation | int |
| reservationIds | Optional | Unique Identifiers for reservations | array |
| transactionId | Optional | Unique Identifier for transaction | int |
| transactionIds | Optional | Unique Identifiers for transactions | array |
| paymentStatus | Optional | Indicates status of payments to return | int |
| decimalPlaces | Optional | Decimal places to use | int |
| Response Item | Description | Data Type |
|---|
"recordCount" | The total count of records in the response | int |
"data" | An object containing data related to transactions | object |
| Response Item | Description | Data Type |
|---|
"transactions" | An array of transaction records | array |
| Response Item | Description | Data Type |
|---|
"start_date" | The date and time when the transaction can start (be charged) | date-time |
"reservation_id" | The unique identifier for the reservation associated with the transaction | int |
"value" | The monetary value of the transaction | float |
"transaction_id" | The unique identifier for the transaction | int |
"target_id" | The identifier for the target or recipient of the transaction | int |
"creation_date" | The date and time when the transaction record was created | date-time |
curl --location --request GET 'https://api.ciiruspartners.com/v2023.07.31/payments?page=1&pageSize=25&startDate=2023-09-01' \
{
"recordCount": 29,
"data": {
"transactions": [
{
"start_date": "2023-09-16T19:00:00",
"reservation_id": 38419112,
"value": 5.20,
"target_id": 1429,
"creation_date": "2023-09-14T15:22:07.67"
},
{
"start_date": "2023-09-15T19:00:00",
"reservation_id": 38415598,
"value": 5.00,
"transaction_id": 100118754,
"target_id": 1429,
"creation_date": "2023-09-13T14:33:57.607"
},
...
]
}
}
