Retrieve a single payout payment
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.
Path Parameters
- id string required
PayoutTransactionDetail identifier
- 200
- 401
- 403
- 404
OK - The request was processed successfully.
- application/json
- Schema
- Example (from schema)
Schema
- id integer
- account integer
- currency string
- amount string
- status string
Possible values: [
created
,pending
,transferred
,canceled
,pending_execution
,executed
,execution_error
] - executionDate stringnull
If left empty, the next possible execution date will be selected automatically
- transferredAt stringnull
- finishedAt stringnull
- reference string
This text will be seen by the beneficiary
- feeSchedule string
Possible values: [
DEBT
,SHAR
,CRED
]For LOCAL payments leave it empty, for SWIFT payments provide a value
- contact integer
beneficiary object
The beneficiary field is required, except for payments to IBANs linked to existing amnis customers.
accountNumber stringbankName string nullablebankCountry string nullablename stringaddress string nullablecity string nullablezip string nullablecountry string nullablecontact string nullable- fromAutomation boolean
{
"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": {
"accountNumber": "string",
"bankName": "string",
"bankCountry": "string",
"name": "string",
"address": "string",
"city": "string",
"zip": "string",
"country": "string",
"contact": "string"
},
"fromAutomation": true
}
Unauthorised -- Your access token is wrong.
- application/json
- Schema
- Example (from schema)
Schema
- type string
- title string
- detail string
{
"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
{
"type": "string",
"title": "string",
"detail": "string"
}
Not Found -- The requested resource could not be found.