GET Get Transfer History By Receiver account

https://api.magmaonepay.com/v1/payout/transfer/history/:receiver_account

Replace :receiver_account with the correct value of the receiver's account.

Headers

Header	Value
Authorization	Bearer TOKEN

NB: TOKEN is your private secret key dependant on your mode (live or test) for server-side

Usage

This endpoint is used to retrieve the history of all transfer transactions associated with a specific receiver account. It provides a detailed view of each transaction, including amounts, dates, and statuses.

Response Fields

The response is a JSON array, with each object in the array representing a transaction in the receiver's transfer history.

Array Object Fields

Each object in the response array contains the following fields:

Field	Description	Type
created_at	Timestamp when the transfer was created	String
done_at	Timestamp when the transfer was completed (if applicable)	String
transfer_token	Unique token of the transfer	String
merchant_transaction_id	Unique identifier of the transaction	String
country_name	Name of the country associated with the transfer	String
country_code	Country code (e.g., CI)	String
amount	Amount transferred	Number
currency	Currency code (e.g., XOF)	String
description	Description of the transfer	String
channel	Channel used for the transfer	String
receiver_account	Account number of the receiver	String
receiver_first_name	First name of the receiver	String
receiver_last_name	Last name of the receiver	String
webhook_url	URL for webhook notifications	String
custom_field	Any custom field provided	String
status	Current status of the transfer	String

Example Response

{
  "code": 200,
  "message": "OK",
  "data": [
    // Array of objects representing each transfer transaction
    {
            "created_at": "2024-06-04T00:46:19.000000Z",
            "done_at": null,
            "transfer_token": "da578aa9-cf07-481c-83d9-6c71ca980644",
            "merchant_transaction_id": "JGVDHUSJGBJs",
            "country_name": "Côte d'Ivoire",
            "country_code": "CI",
            "amount": 150,
            "currency": "XOF",
            "description": "Transfer test",
            "channel": "mobile_money",
            "receiver_account": "+2250707000200",
            "receiver_first_name": "Cheick",
            "receiver_last_name": "Cheick",
            "webhook_url": "https://webhook.site",
            "custom_field": "123456",
            "status": "new"
        }
    // Additional transaction objects...
  ]
}