Skip to main content
This model is a representation of a mass payment. Fields
​
string
Unique UUID of the mass payment.
​
string
Unique ID of the external reference submitted by the client.
​
object
The generic error message for the mass payment request, if any.
​
string
The MassPaymentStatus.
​
string
The sell currency of the mass payment.
​
number
Total number of created trades.
​
object
The PaymentsSummaryTypes
​
object
Links to the PaymentsSummaryLinks

​
MassPaymentStatus

The mass_payment_status values of the mass payment instruction. Values

​
PaymentsSummary Types

This is an enumeration of PaymentsSummary types. Fields
​
number
Total count of received payments
​
number
Total count of processed payments
​
number
Total count of errored payments
​
number
Total count of created payments
This is an enumeration of PaymentsSummary Links. Each link helps the user agent to fetch resources related to payment errors, payments created successfully, trade and funding accounts associated with the mass payment id. The mass_payment_id does not need to be stored as the said resources may be accessed with the provided links. Fields
​
string
/mass-payments/$mass_payment_id/errors **
​
string
/payments?mass_payment_id=$mass_payment_id *
​
string
/trades?client_id=$client_id&mass_payment_id=$mass_payment_id *
​
string
/mass-payments/$mass_payment_id/funding_account *
** Following URL response will return back data when mass_payment_status is “processed” and includes errors. * Following URL response will return back data when mass_payment_status is “created”.