Consulter un reversement

Opération

GET /partner_api/transfers/{id}

Authentification

ApiKey``ApiKeyId

X-API-KEY

Emplacement : header

X-API-KEY-ID

Emplacement : header

Paramètres de chemin

id*string

Transfer identifier

Formatuuid

Réponses

200 application/json

401 application/json

404 application/json

500 application/json

cURL

JavaScript

Go

Python

Java

C#

Rust

curl -X GET "https://api.kelyko.invalid/partner_api/transfers/497f6eca-6276-4993-bfeb-53cbbbba6f08" \
  -H "X-API-KEY: " \
  -H "X-API-KEY-ID: "

200401404500

{
  "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"
  }
}

Create transfer (Partner API)POST\ \ 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`\ - **Kelyko store:** `paymentMethod: "Kelyko"` and `destinationStoreId` — credits that store's wallet.\ Name is loaded from the store. `contactId` on the response is a hidden internal contact.\ **Async PSP payouts:** When the business has `is_async_payout_enabled` true, mobile-money\ rails (`orange`, `wave`, `mtn`, `moov`, `djamo`) return **200** with `status: "pending"` after\ funds are reserved. The provider call runs on a background worker. **200** means accepted, not\ paid — poll `GET /partner_api/transfers/{id}` or wait for `TRANSACTION_COMPLETED`.\ Kelyko-to-Kelyko and bank transfers are unchanged (inline, no async job).\ **PI:** `paymentMethod: "pi"` with `identifier.alias` sends to a PI beneficiary alias (inline,\ never the async worker). **200** means the send was accepted, `status: "pending"`, not that the\ beneficiary has the funds. Available only when PI is enabled for your business (otherwise 422\ on an inline beneficiary). List beneficiary contacts (Partner API)GET\ \ Next Page

Demander à l'IA ⌘I