Transfers

Send funds to a Mobile Money wallet, a Djamo wallet or another Wajub account via the Transfers API.

A Transfer is an outgoing payout from the balance held by our licensed payment partner, to a Mobile Money wallet, a phone-addressed wallet such as Djamo, or another Wajub account. A bank payout goes only through a payout account added in the Dashboard, which this API cannot pay. Transfers are asynchronous, listen to transfer.succeeded and transfer.failed.

private key required

Transfers require the private key (sk...) in the Authorization header.

Marketplaces: acting on behalf of a subaccount

Platforms can pay out on behalf of a connected subaccount by sending an X-Sync header alongside their own key (requires the withdrawals capability). See Subaccounts for the rules and error cases.

Endpoints

Method	Path	Description
`POST`	`/transfers`	Create a transfer
`POST`	`/transfers/batch`	Create up to 500 transfers in a call
`GET`	`/transfers`	List transfers
`GET`	`/transfers/{id}`	Retrieve a transfer

The Transfer object

A transfer is read by its id. Its reference is yours and never checked for uniqueness, so GET /transfers/{id} does not accept it. The Transfers guide shows a full example.

idstringoptional

The identifier for every other call: po_… in live, po_test_… in sandbox.

referencestring?optional

Your own reference, as sent on creation, or the line reference on a batch. Not unique.

provider_referencestring?optional

The operator's own reference, once the payout reaches it.

amountnumberoptional

Amount in the major unit of the currency.

currencystringoptional

ISO 4217 code.

descriptionstring?optional

Descriptive label.

reasonstring?optional

The free-text reason you sent on creation. Not a failure code: see failure_reason.

statusenumoptional

processing, review, succeeded, failed or cancelled, or pending for a Dashboard payout awaiting your confirmation. cancelled is a payout cancelled before it was sent. A payout the operator cancels on its side ends failed.

completebooleanoptional

true only once the transfer has succeeded. It stays false on failed and cancelled: read status to know whether a transfer is finished.

sourcestringoptional

api for a payout your integration created, dashboard or recurring for one started from the Konsole.

failure_reasonstringoptional

The failure code, present only when status is failed or cancelled.

failure_messagestringoptional

The failure in one sentence, present only when status is failed or cancelled.

metadataobjectoptional

Your own key-value data. Some keys are reserved by Wajub.

ledger_balance_currencystring?optional

The sandbox wallet that was debited. Null on a live payout.

sandboxbooleanoptional

true for a sandbox payout.

providerobject?optional

slug and name of the provider that carries the payout. null on a sandbox payout at creation.

beneficiaryobjectoptional

id, name, phone, email and deleted. A beneficiary deleted since stays here, with deleted: true.

payment_methodobjectoptional

id, account_number and phone of the destination.

succeeded_atdatetime?optional

ISO 8601 timestamp of completion.

created_atdatetimeoptional

ISO 8601 creation timestamp (UTC).

updated_atdatetimeoptional

ISO 8601 timestamp of the last change.

Lifecycle

A live payout is created processing, or review when it is held. A Dashboard payout awaiting your confirmation reads pending: confirmed, it goes on like a new payout; rejected, it ends cancelled.

Events

Event	Trigger
`transfer.created`	Transfer created
`transfer.processing`	Transfer submitted to the operator
`transfer.succeeded`	Transfer successfully executed
`transfer.failed`	Transfer failed
`transfer.cancelled`	Stopped before it was sent. Today such a payout is announced as `transfer.failed`

Endpoints

The Transfer object

Lifecycle

Events

What did you think of this content?