Bank payments API
Get bank payment
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
headerrequiredQuery Parameters
orderId
string
Id of the order for which you want to know the status of the expected payment.
Response
200 - application/json
orderId
string
Order ID
bankName
string
Bank Name
USBankTransferMethod
enum<string>
Indicates the method of bank transfer in the United States.
Available options:
ach_push
, wire
companyName
string
Company Name
companyAddress
string
Company Address
bankAddress
string
Bank Address
accountNumber
string
Account Number
routingNumber
string
Nine-digit code identifying the financial institution in the United States.
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.
id
string
Bank payment id