Skip to main content
POST
/
v1
/
transfers
Create transfer
curl --request POST \
  --url https://api.adullam.dev/v1/transfers \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'Idempotency-Key: <idempotency-key>' \
  --data '
{
  "amount": 10000,
  "currency": "XOF",
  "recipient_phone": "+22507123456",
  "channel": "mtnCI",
  "description": "Salary payment",
  "reference": "PAY_001",
  "metadata": {
    "employee_id": "EMP_123"
  }
}
'
{
  "id": "txf_abc123",
  "status": "processing",
  "amount": 10000,
  "currency": "XOF",
  "recipient_phone": "+22507123456",
  "recipient_name": "DIALLO IBRAHIM",
  "channel": "mtnCI",
  "description": "Salary payment",
  "reference": "PAY_001",
  "ussd_reference": "MP240115.1032.T98765",
  "fees": 50,
  "metadata": {
    "employee_id": "EMP_123"
  },
  "created_at": "2024-01-15T10:30:00Z",
  "updated_at": "2024-01-15T10:30:00Z",
  "completed_at": null,
  "failure_reason": null
}

​
Create Transfer

Initiating a single transfer allows you to send funds to a recipient from your Adullam account. Use the Create Transfer API to specify transfer details such as amount, currency, and recipient information.

Authorizations

​
Authorization
string
header
required

Use the access token obtained from /v1/auth/token

Headers

​
Idempotency-Key
string<uuid>
required

UUID for idempotent requests

Body

application/json
​
amount
integer
required
Required range: x >= 100
Example:

10000

​
currency
enum<string>
required
Available options:
XOF
Example:

"XOF"

​
recipient_phone
string
required
Example:

"+22507123456"

​
channel
enum<string>
required
Available options:
orangeCI,
mtnCI,
moovCI,
waveCI
Example:

"mtnCI"

​
description
string
Maximum string length: 200
Example:

"Salary payment"

​
reference
string
Maximum string length: 100
Example:

"PAY_001"

​
metadata
object
Example:
{ "employee_id": "EMP_123" }

Response

Transfer created

​
id
string
Example:

"txf_abc123"

​
status
enum<string>
Available options:
pending,
processing,
completed,
failed,
cancelled
Example:

"processing"

​
amount
integer
Example:

10000

​
currency
string
Example:

"XOF"

​
recipient_phone
string
Example:

"+22507123456"

​
recipient_name
string | null
Example:

"DIALLO IBRAHIM"

​
channel
enum<string>
Available options:
orangeCI,
mtnCI,
moovCI,
waveCI
Example:

"mtnCI"

​
description
string
Example:

"Salary payment"

​
reference
string
Example:

"PAY_001"

​
ussd_reference
string | null
Example:

"MP240115.1032.T98765"

​
fees
integer
Example:

50

​
metadata
object
Example:
{ "employee_id": "EMP_123" }
​
created_at
string<date-time>
Example:

"2024-01-15T10:30:00Z"

​
updated_at
string<date-time>
Example:

"2024-01-15T10:30:00Z"

​
completed_at
string<date-time> | null
Example:

null

​
failure_reason
string | null
Example:

null