Articles on: Getting Started

Getting Started with the Diool API | Transfer Endpoint

The general details about the Diool's RESTful API and the prerequisites to use or test this endpoint with Postman can be found on the introductory article: Getting Started with the Diool API | Introduction.

The transfer endpoint executes a request for money to be transferred to a beneficiary identified by a mobile money account. The amount of the transfer will be taken from the sender's Diool account and will be deposited in the beneficiary's mobile money account.

The Request includes the beneficiary's account identifier (a mobile money account number), the amount to be transferred, and the code for the mobile money provider.

HTTP Method: POST

Request Parameters: accountIdentifier (required), amount (required), providerIdentifier (required).


Request parameters for Transfer endpoint

Sample Request



# Here is a curl example of a transfer request
  curl -d 
 '{ "accountIdentifier": "237xxxxxxxxx", "amount": "100",
  "providerIdentifier" :"62401"}'
  -H "Authorization: Bearer [API-KEY]"
  -H "Content-Type: application/json"
  -X POST "ENVIRONMENT_URL/transfer"


Transfer Endpoint - Sample Request

Sample Response - Prod



{
    "code": 0,
    "message": "Transfer processed successfully",
    "developerMessage": "Transfer processed successfully",
    "moreInfo": "www.diool.com",
    "resultType": "SUCCESS",
    "result": {
        "transferId": 17166,
        "transferRef": "NHKCDAWH",
        "responseCode": "OK",
        "responseMessage": "Operation Successful",
        "userFees": null,
        "userRevenue": 0.16,
        "userLoyaltyPoints": null,
        "currencyExchangeRate": 1,
        "extSenderTransactionRef": null,
        "extSenderTransactionTimestamp": null,
        "extRecipientTransactionRef": null,
        "extRecipientTransactionTimestamp": "2023-08-21T14:00:56.954Z",
        "senderAmount": null,
        "senderCurrency": null,
        "recipientAmount": 100.00,
        "recipientCurrency": "XAF",
        "uniqueReference": "NHKCDAWH",
        "timeStamp": "1692626457019"
    }
}



Need Help?



Already using or testing the API and need a hand?

Self service: Check out the FAQ.
Have a question..? Chat with us instantly through the Live Chat on our Help Center.
Totally stuck..? Send us a mail at helpdesk@diool.com and we will get back to you as soon as possible.

Updated on: 23/08/2023

Was this article helpful?

Share your feedback

Cancel

Thank you!