Skip to main content
POST
/
partner_api
/
transfers
curl --request POST \
  --url https://api.jeko.africa/partner_api/transfers \
  --header 'Content-Type: application/json' \
  --header 'X-API-KEY: <api-key>' \
  --data '
{
  "storeId": "59ae202a-f583-4a15-970f-9e99bd1e0baa",
  "contactId": "29f81706-03a6-492f-92ee-5f0b2e9b18e7",
  "amountCents": 50000,
  "currency": "XOF",
  "description": "Monthly salary payment",
  "reference": "PAYROLL-APR-001"
}
'
{
  "id": "wth_abc123def456",
  "storeId": "59ae202a-f583-4a15-970f-9e99bd1e0baa",
  "contactId": "29f81706-03a6-492f-92ee-5f0b2e9b18e7",
  "amount": {
    "amount": 50000,
    "currency": "XOF"
  },
  "fees": {
    "amount": 500,
    "currency": "XOF"
  },
  "status": "pending",
  "paymentMethod": "wave",
  "beneficiary": "+2250701234567",
  "description": "Monthly salary payment",
  "reference": "PAYROLL-APR-001",
  "createdAt": "2024-01-15T14:30:25.000Z"
}

Authorizations

​
X-API-KEY
string
header
required

Clé API pour les requêtes de l'API Partenaire

Body

application/json

Request schema for creating a transfer

​
storeId
string<uuid>
required

Identifiant du magasin from which to transfer funds

Example:

"59ae202a-f583-4a15-970f-9e99bd1e0baa"

​
contactId
string<uuid>
required

Contact identifier (beneficiary) to receive funds

Example:

"29f81706-03a6-492f-92ee-5f0b2e9b18e7"

​
amountCents
integer
required

Amount to transfer in cents (minimum 500 cents = 5 XOF)

Required range: x >= 500
Example:

50000

​
currency
string
required

Code devise (ISO 4217)

Required string length: 3
Example:

"XOF"

​
description
string

Optional description for the transfer

Maximum string length: 255
Example:

"Monthly salary payment"

​
reference
string

Référence partenaire pour la réconciliation (renvoyée dans les réponses et les webhooks lorsqu’elle est fournie)

Required string length: 5 - 100
Example:

"PAYROLL-APR-001"

Response

Virement créé avec succès

Response schema for transfer operations

​
id
string
required

Transfer identifier

Example:

"wth_abc123def456"

​
storeId
string<uuid>
required

Identifiant du magasin

Example:

"59ae202a-f583-4a15-970f-9e99bd1e0baa"

​
amount
object
required

Money amount representation

​
fees
object
required

Money amount representation

​
status
enum<string>
required

Transfer status

Available options:
pending,
success,
error
Example:

"success"

​
paymentMethod
enum<string>
required

Payment method used for transfer

Available options:
wave,
orange,
mtn,
moov,
djamo,
bank
Example:

"wave"

​
beneficiary
string
required

Beneficiary identifier (phone number or bank account)

Example:

"+2250701234567"

​
description
string
required

Transfer description

Example:

"Monthly salary payment"

​
createdAt
string<date-time>
required

Transfer creation timestamp (ISO 8601)

Example:

"2024-01-15T14:30:25.000Z"

​
contactId
string<uuid>

Contact identifier (beneficiary)

Example:

"29f81706-03a6-492f-92ee-5f0b2e9b18e7"

​
reference
string | null

Référence partenaire fournie lors de la création, le cas échéant

Required string length: 5 - 100
Example:

"PAYROLL-APR-001"

​
transaction
object

Associated transaction details (present when transaction is created)