GET
/
api
/
payments
/
bank
/
bulk
/
{id}

Requirements to consume the endpoint.

User approved

The user must be approved in at least one country.

Authorizations

x-api-key
string
header
required

Path Parameters

id
string
required

Id of the bulk bank payment

Response

200 - application/json
amount
number

The total amount of the orders

bankName
string

The name of the bank

CLABE
string

The 18-digit code used to identify bank accounts in Mexico

companyAddress
string

The address of the company

companyName
string

The name of the company

createdAt
string

The date and time the order was created

fiat
enum<string>

The type of fiat currency involved in the order

Available options:
USD,
MXN,
PEN
id
string

The unique identifier of the bulk bank payment

orderIds
string[]

List of order IDs associated pending payment

orderIdsPaid
string[]

List of order IDs that have been paid

reference
string

The reference for the bulk payment

RFC
string

The tax identification number in Mexico

status
enum<string>

The current status of the bulk bank payment

Available options:
awaitingPayment,
complete,
failed,
cancelled,
insufficientAmountReceived,
excessAmountReceived
userId
string

The unique identifier of the user