GET
/
api
/
payments
/
bank

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
accountNumber
string

Account Number

bankAddress
string

Bank Address

bankName
string

Bank Name

companyAddress
string

Company Address

companyName
string

Company Name

id
string

Bank payment id

orderId
string

Order ID

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.

routingNumber
string

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

status
enum<string>

Status

Available options:
initiated,
sent,
passed,
cancelled
USBankTransferMethod
enum<string>

Indicates the method of bank transfer in the United States.

Available options:
ach_push,
wire