Transfer

POST {{base_url}}/disbursement/v1_0/transfer

Request Body

  • amount (string) - The amount to be transferred.

  • currency (string) - The currency in which the amount is specified.

  • externalId (string) - An ID to uniquely identify the transfer.

  • payee (object) - Information about the payee.

    • partyIdType (string) - Type of ID for the payee.
    • partyId (string) - ID of the payee.
  • payerMessage (string) - Message from the payer.

  • payeeNote (string) - Note for the payee.

Response

The response for this request is a JSON schema, which will be in the format specified by the Content-Type header. The last execution returned a status of 202 with Content-Type as text/xml. As per the user's request, the response should be documented as a JSON schema.

Headers

  • Content-Type - The format of the response.

Other

  • This API endpoint allows you to initiate a transfer for disbursement. The request should be sent as an HTTP POST to {{baseurl}}/disbursement/v10/transfer.

Request Body

{"amount"=>"5900", "currency"=>"EUR", "externalId"=>"890695", "payee"=>{"partyIdType"=>"MSISDN", "partyId"=>"{{MSISDN}}"}, "payerMessage"=>"Salary Payment April 2023", "payeeNote"=>"Salary Payment April 2023"}

HEADERS

KeyDatatypeRequiredDescription
X-Callback-Urlstring
X-Reference-Idstring
X-Target-Environmentstring
Content-Typestring
Ocp-Apim-Subscription-Keystring