Download Retailers Transfers

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

This endpoint retrieves all transfers made by the marketplace to the selected retailer(s) in CSV format.

It allows the user to download the transfers of the retailers operating under the marketplace, allowing the marketplace to search and retrieve transfer the records as CSV using various filters, including date range, payout ID, settlement ID, and more.

Body Params
period
object
required
merchants
array of strings

To filter by the merchant IDs

merchants
payouts
array of strings

To filter by the payout IDs

payouts
retailers
array of strings

To filter by the retailer IDs

retailers
destination_transactions
array of strings
destination_transactions
transfers
array of strings
transfers
string
string
customers
array of strings

To filter by the customers IDs

customers
payment_methods
array of strings

To filter by the payment methods, for example: VISA,MASTERCARD,MADA

payment_methods
charges
array of strings

To filter by the charge IDs

charges
sources
array of strings

To filter by the token IDs

sources
filters
object
string

To get the transfer after the selected transfer, the API is limited to return 100K records only, to get the transfers after this number you can get the Last_destination_id from the response header and get the records if Has_more is true

Responses

Language
Credentials
Header
LoadingLoading…
Response
Choose an example:
application/json