Retrieve a single payout payment
GET/api/payout_transaction_details/:id
This API endpoint is designed to retrieve detailed information about a specific payout payment, providing access to all relevant details of an individual payout payment transaction.
Request
Path Parameters
PayoutTransactionDetail identifier
Responses
- 200
- 401
- 403
- 404
OK - The request was processed successfully.
- application/json
- Schema
- Example (from schema)
Schema
- Beneficiary-PayoutTransactionDetailView
Possible values: [created, pending, transferred, canceled, pending_execution, executed, execution_error]
If left empty, the next possible execution date will be selected automatically
This text will be seen by the beneficiary
Possible values: [DEBT, SHAR, CRED]
For LOCAL payments leave it empty, for SWIFT payments provide a value
beneficiary object
The beneficiary field is required, except for payments to IBANs linked to existing amnis customers.
{
"id": 1,
"account": 1,
"currency": "CHF",
"amount": "100.00",
"status": "executed",
"executionDate": "2023-01-01T00:00:00+00:00",
"transferredAt": "2023-01-01T00:00:00+00:00",
"finishedAt": "2023-01-01T00:00:00+00:00",
"reference": "Payment for car rental",
"feeSchedule": "SHAR",
"contact": 1,
"beneficiary": {},
"fromAutomation": true
}
Unauthorised -- Your access token is wrong.
- application/json
- Schema
- Example (from schema)
Schema
{
"type": "string",
"title": "string",
"detail": "string"
}
Forbidden -- Access to the requested resource or action is forbidden.
- application/json
- Schema
- Example (from schema)
Schema
{
"type": "string",
"title": "string",
"detail": "string"
}
Not Found -- The requested resource could not be found.