Transactions (1.0)
Download OpenAPI specification:Download
Transactions API requests specification. Get information about all your payments
Get transaction by ID
Get a transaction by ID
path Parameters
id required | string Example: 62b48c5b6ba2cd6a040b20a8 Mongoose Object ID of the target entity |
header Parameters
terminal-secret required | string <uuid> Example: 3858f642-e92f-431c-9d38-46d15efb7fba |
terminal-id required | string Example: 62b48adf6ba2cd6a040b1eec |
Responses
Response samples
- 200
- 401
- 403
- 404
- 500
Content type
application/json; charset=utf-8
{- "id": "62b48c5b6ba2cd6a040b20a8",
- "amount": "0.50",
- "status": "unable_to_check",
- "createdAt": "2022-12-24T00:00:00Z",
- "parentEntityType": "Payment",
- "parentEntityId": "62b48c5b6ba2cd6a040b20a8",
- "isSandbox": false,
- "direction": "incoming",
- "expectedCompletedDate": "2024-01-24T00:00:00Z",
- "completedAt": "2022-12-24T00:00:00Z"
}
Transactions list
Get a paginated list of transactions
query Parameters
page | integer Default: 1 Example: page=4 Current page number |
limit | integer Default: 25 Example: limit=10 Number of items per page |
header Parameters
terminal-secret required | string <uuid> Example: 3858f642-e92f-431c-9d38-46d15efb7fba |
terminal-id required | string Example: 62b48adf6ba2cd6a040b1eec |
Responses
Response samples
- 200
- 401
- 403
- 404
- 500
Content type
application/json; charset=utf-8
{- "data": {
- "page": 1,
- "totalDocs": 100,
- "totalPages": 5,
- "limit": 25,
- "hasNextPage": true,
- "docs": [
- {
- "id": "62b48c5b6ba2cd6a040b20a8",
- "amount": "0.50",
- "status": "unable_to_check",
- "createdAt": "2022-12-24T00:00:00Z",
- "parentEntityType": "Payment",
- "parentEntityId": "62b48c5b6ba2cd6a040b20a8",
- "isSandbox": false,
- "direction": "incoming",
- "expectedCompletedDate": "2024-01-24T00:00:00Z",
- "completedAt": "2022-12-24T00:00:00Z"
}
]
}
}