POST
/
transfers
Initiate a transfer
curl --request POST \
  --url https://api.notchpay.co/transfers \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '{
  "amount": 5000,
  "currency": "XAF",
  "channel": "cm.mtn",
  "beneficiary": "ben_123456789",
  "recipient": "ben_123456789",
  "description": "Paiement de salaire",
  "reference": "ref_123456789"
}'
{
  "status": "Accepted",
  "message": "Transfer initialized",
  "code": 201,
  "transfer": {
    "id": "trf_123456789",
    "reference": "ref_123456789",
    "amount": 5000,
    "currency": "XAF",
    "status": "complete",
    "beneficiary": "ben_123456789",
    "created_at": "2023-01-01T12:00:00.000Z",
    "completed_at": "2023-01-01T12:05:00.000Z",
    "payment_method": "pm.ndzAfIh555VCPML1"
  }
}

Authorizations

​
Authorization
string
header
required

Body

application/json
​
amount
number
required
Example:

5000

​
currency
string
required
Example:

"XAF"

​
beneficiary
string
required
Example:

"ben_123456789"

​
description
string
required
Example:

"Paiement de salaire"

​
channel
string
Example:

"cm.mtn"

​
recipient
string
Example:

"ben_123456789"

​
reference
string
Example:

"ref_123456789"

Response

Transfer initialized

​
status
string
required
Example:

"Accepted"

​
message
string
required
Example:

"Transfer initialized"

​
code
integer
required
Example:

201

​
transfer
any
required