Multi Payments
Fetch mass payments
GET
Fetch mass payments
Fetch the mass payments of a client, optionally filtered
The MassPaymentStatus field will provide the latest status whether processing is complete or still running. API consumers can retrieve a mass payment using an external_reference_id provided at the time of the mass payment submission.
Headers
The access token.
Query Parameters
The identifier of a client.
Filter by mass payment ID
Filter by the external reference of the mass payment
Minimum string length:
1Filter by the sell currency of the mass payment
Pattern:
^[A-Z]{3}$The desired page number for pagination. By default is 1.
The number of items per page for pagination. By default is 50.
Response
List of mass payments
The UUID of the MassPayment
External reference of the mass payment
An error message.
This is an enumeration of the status of a MassPayment
Available options:
Queued for processing, Processing, Processed, Queued for creating, Creating, Created, Cancelled, Failed Sell currency
Number of trades created