Payins
List payins
Endpoint to list all payins associated with your account.
get/payins
Request
- Base URLhttps://api.enterprise.airtm.com/v2
- AuthHTTP basic
- TypeScriptA function with typed inputs. Its response is checked against the schema.
Query parameters
beforestring
Gets results before the specified cursor.
afterstring
Gets results after the specified cursor.
perPageinteger
The maximum number of items to fetch.
status'CREATED' | 'CONFIRMED' | 'CANCELED' | 'PROCESSING' | 'FAILED' | 'BRIDGE_FAILED' | 'BRIDGE_CANCELED'
The current status of the payin
- CREATED: The payin has been created but not yet confirmed.
- CONFIRMED: The payin has been confirmed and is ready for processing.
- CANCELED: The payin has been canceled by the user or system.
- PROCESSING: The payin is currently being processed.
- FAILED: The payin has failed due to an error.
- BRIDGE_FAILED: The payin has failed due to an error in Bridge.
- BRIDGE_CANCELED: The payin has been canceled due to an error in Bridge.
enterpriseIdstring
Response
Ok
Example response
{
"items": [
{
"amount": 10,
"netAmount": 9.5,
"airtmFee": 0.5,
"items": [
{
"amount": 10,
"quantity": 1
}
]
}
]
}Changes
No recorded changes to this operation across all 1 revision of this API.