GET
/
api
/
payments
/
bank
curl --request GET \
  --url https://app.sandbox.rio.trade/api/payments/bank \
  --header 'x-api-key: <api-key>'
{
  "orderId": "6661a7c3cc4633bc6412b3da",
  "bankName": "Sandbox Bank",
  "USBankTransferMethod": "ach_push",
  "companyName": "Bank Name",
  "companyAddress": "21750 Hardy Oak Blvd Ste 104 PMB 77950 San Antonio, TX 78258",
  "bankAddress": "Sandbox Bank Address, 12345, Sandbox City, Sandbox Country",
  "accountNumber": "123456",
  "routingNumber": "021000021",
  "status": "initiated",
  "reference": "<string>",
  "CCI": null,
  "CLABE": "123456789012345678",
  "RUC": "<string>",
  "RFC": "RBL2206107N8",
  "id": "6661a7c48eefd7b52058f901"
}

​
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 want to know the status of the expected payment.

Response

200
application/json
OK
​
orderId
string

Order ID

Example:

"6661a7c3cc4633bc6412b3da"

​
bankName
string

Bank Name

Example:

"Sandbox Bank"

​
USBankTransferMethod
enum<string>

Indicates the method of bank transfer in the United States.

Available options:
ach_push,
wire
​
companyName
string

Company Name

Example:

"Bank Name"

​
companyAddress
string

Company Address

Example:

"21750 Hardy Oak Blvd Ste 104 PMB 77950 San Antonio, TX 78258"

​
bankAddress
string

Bank Address

Example:

"Sandbox Bank Address, 12345, Sandbox City, Sandbox Country"

​
accountNumber
string

Account Number

Example:

"123456"

​
routingNumber
string

Nine-digit code identifying the financial institution in the United States.

Example:

"021000021"

​
status
enum<string>

Status

Available options:
initiated,
sent,
passed,
cancelled
​
reference
string

This value MUST BE SENT with the payment. In Mexico its sent as the “concepto”, in the United States its sent as the wire message and in Peru its sent as the bank transfer reference.

​
CCI
string

20-digit code used to identify bank accounts, only applies in Peru

Example:

null

​
CLABE
string

18-digit code used to identify bank accounts, only applies in Mexico

Example:

"123456789012345678"

​
RUC
string

Registry containing the identification data of economic activities in Peru

​
RFC
string

The tax identification number in Mexico

Example:

"RBL2206107N8"

​
id
string

Bank payment id

Example:

"6661a7c48eefd7b52058f901"