Skip to content
Wajub
Loading keys…

Authorization

default
Authorization<token>

A public key (pk./pk_test.) is accepted on /payments, /customers, /links, /invoices and the catalogue reads (/channels, /providers, /countries, /currencies); anything that moves money out, reads the balance or manages the account answers 406 to it. It is an identifier, never an authorization. Use a secret key (sk./sk_test.) for sensitive operations (transfers, refunds, balance), or a restricted key (rk./rk_test.) scoped to specific permissions. The _test. variant of any key selects the sandbox environment, there is no separate sandbox URL. Never expose your secret key in client-side code.

In: header

Path Parameters

idstringrequired

Payment `id`.

Header Parameters

Idempotency-Keystring

Your key for this request, 1 to 128 characters of letters, digits and `. _ : -`. The same request sent again with the same key returns the first answer instead of doing the work twice. See [Idempotency](/api/idempotency).

Request Body

application/json

channelstringrequired

Same as `POST /payments/{id}`. In live, a Mobile Money channel.

dataobject

The payer's details for this channel.

phonestring

Mobile Money number, in international format.

split_countinteger

Split into this many equal instalments: 2, 3 or 4, in whole units, the last one taking the rest. Sets the plan on the first call.

split_amountsarray<number>

Or give each instalment's amount, 2 to 4 of them, adding up to what the payer pays: `amount`, or `amount_total` when the payer bears the fee.

split_currencystring

Currency of `split_amounts`, ISO 4217.

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://api.wajub.com/payments/trx_test_CSUGajfv9xh0XQ5wu2lx/splits" \  -H "Idempotency-Key: order-1042-part-1" \  -H "Content-Type: application/json" \  -d '{    "channel": "cm.mtn"  }'
POST
/payments/{id}/splits
{  "code": 200,  "status": "OK",  "message": "Confirm the transaction on your phone.",  "transaction": {    "id": "trx_Rk4Wm8Zq2Lp6Xv9Tb3Nh",    "amount": 600000,    "amount_paid": 300000,    "currency": "XAF",    "status": "partial",    "split": {      "id": "splt_Jc5Ny7Qd1Hs8Mv3Ka6Wf",      "split_number": 1,      "total_splits": 2,      "split_currency": "XAF",      "amount": 300000,      "status": "succeeded"    }  }}

Instalment confirmed at once, the payment partial

What did you think of this content?