GET Retrieve Transfer Details

https://api.magmaonepay.com/v1/payout/transfer/:transfer_token

To use this endpoint, replace :transfer_token in the URL with the unique transfer token assigned to the transaction during the payment initialization process.

Usage

This endpoint is used to retrieve the details of a transfer transaction. It is especially useful for verifying transaction details and handling disputes or customer inquiries.

Response Fields

The response from this endpoint will be a JSON object containing the following fields:

Field	Description	Type
code	HTTP response code	Number
message	Response message	String
data	Object containing transfer details	Object

Data Object Fields

Within the data object, the following fields are included:

Field	Description	Type
created_at	Date of create transfer	String
done_at	Date of finish transfer	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
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": {
        "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"
    }
}

This structure provides a comprehensive overview of the endpoint, including how to use it, the response structure, and an example of the response data.