GET
/
api
/
payouts
/
bank
Get a bank payout
curl --request GET \
  --url https://app.sandbox.rio.trade/api/payouts/bank \
  --header 'x-api-key: <api-key>'
{
  "orderId": "6661ca61cc4633bc6412d0d9",
  "bankAccountId": "65ba521a4b3e1bd9eb6a5107",
  "originBank": "interbank",
  "status": "initialized",
  "payouts": [
    {
      "amount": 123,
      "SPEITrackingNumber": "<string>",
      "SPIDTrackingNumber": "<string>",
      "CEPLink": "<string>",
      "reference": "<string>",
      "sentAt": "2021-06-01T00:00:00.000Z"
    }
  ],
  "id": "6661ca680703d81fb0e1b6ba"
}

Requirements to consume the endpoint.

User approved

The user must be approved in at least one country.

Authorizations

x-api-key
string
header
required

Query Parameters

orderId
string

Id of the order for which you wish to know the status of the payment made.

Response

OK

orderId
string

Id of the order.

Example:

"6661ca61cc4633bc6412d0d9"

bankAccountId
string

Id of the bank account.

Example:

"65ba521a4b3e1bd9eb6a5107"

originBank
enum<string>

Origin bank.

Available options:
interbank,
swift,
spei,
spid,
ksr,
bridge,
bitso
status
enum<string>

Status of the payout.

Available options:
initialized,
processing,
complete,
failed,
cancelled
payouts
object[]

Payout details.

id
string

Id of the payout.

Example:

"6661ca680703d81fb0e1b6ba"