Create Remittance

Use this call to begin the remittance process.
This will perform all the validations before the transaction is approved.
This call returns the transactionReferenceNumber which you are going to use in the Execute remittance call.
You can utilize the links provided in the response to perform CHECK or EXECUTE.

⚠️ For Basic Authentication, use SECRET API KEY. Learn more →

⚠️ Make sure that you use pymy as channel.

Body Params
string
required
length between 3 and 3

Country of origin in 3-letter country code

sender
object
required

Sender details

beneficiary
object
required

Beneficiary details

string
required
length between 10 and 16

If channel is pymy, account should be a valid MSISDN. If channel is smny, account should be a 16-digit Agent Alias.

string
enum
required

Channel where to send money. pymy - maya account, smny - maya agents

Allowed:
amount
object
required

Amount details

string
length between 0 and 100

Will be used as a WebHook

Headers
string

Client's reference number

Responses

Language
Credentials
Basic
base64
:
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json