OuiPay
API StatusOuiPay WebsiteSign Up
API ReferenceTransfers

Transfers

The transfer resource : payouts to beneficiaries.

A transfer pays out from a wallet to a beneficiary: recorded as a transaction with a hold on funds until settlement.

The transfer object

{
  "id": "01M2S18...",
  "transaction_id": "01M2S18...",
  "customer_id": "01M2S17...",
  "beneficiary_id": "01M2S17...",
  "amount_minor": 250000,
  "currency": "NGN",
  "narration": "Invoice 8842 payout",
  "status": "processing",
  "created_at": "2026-09-18T02:00:00Z"
}
FieldTypeNotes
transaction_idstringThe transaction entry: source of truth
beneficiary_idstringVerified destination
statusstringMirrors the transaction's status

Endpoints

MethodPathDescription
POST/v1/transfersCreate
GET/v1/transfers/{id}Retrieve
POST/v1/beneficiariesCreate a beneficiary

Retrieve a payment

GET /v1/payments/{id} : fetch a payment's current state.

Create a transfer

POST /v1/transfers : submit a payout to a beneficiary.

On this page

The transfer objectEndpoints