Jèko
Transfers

Create transfer (Partner API)

POST
/partner_api/transfers

Creates a transfer from a store wallet to a beneficiary.

Beneficiary resolution (provide exactly one):

  • Existing contact: contactId of a previously created beneficiary
  • Inline beneficiary: name, paymentMethod, and identifier — auto-creates a hidden contact that is excluded from GET /partner_api/contacts until explicitly created via POST /partner_api/contacts

Authorization

ApiKey ApiKeyId
X-API-KEY<token>

In: header

X-API-KEY-ID<token>

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Create transfer using an existing beneficiary contact

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/partner_api/transfers" \  -H "Content-Type: application/json" \  -d '{    "contactId": "b5ec5d98-4bee-4da1-ad24-dde86346cb1d",    "storeId": "b8adcdc8-9238-4168-90f8-77b2d14c211c",    "amountCents": 500,    "currency": "str"  }'
{  "id": "string",  "storeId": "b8adcdc8-9238-4168-90f8-77b2d14c211c",  "contactId": "b5ec5d98-4bee-4da1-ad24-dde86346cb1d",  "amount": {    "amount": 0,    "currency": "XOF"  },  "fees": {    "amount": 0,    "currency": "XOF"  },  "status": "pending",  "paymentMethod": "orange",  "beneficiary": "string",  "description": "string",  "reference": "string",  "createdAt": "2019-08-24T14:15:22Z",  "transaction": {    "id": "string",    "status": "pending"  }}

List store transactions (Partner API) GET

Previous Page

Get transfer by ID (Partner API) GET

Retrieves a transfer by its ID, including current status and transaction details. **Authentication:** - Requires API key headers `X-API-KEY` and `X-API-KEY-ID` **Access Control:** - Only returns transfers that belong to the authenticated business