Créer un reversement

Opération

POST /partner_api/transfers

Authentification

ApiKey``ApiKeyId

X-API-KEY

Emplacement : header

X-API-KEY-ID

Emplacement : header

Corps de la requête

application/json

Définitions TypeScript

Utilisez le type du corps de requête dans TypeScript.

CreateTransferWithContactIdRequest

Create transfer using an existing beneficiary contact

contactId*string

Contact identifier (beneficiary) to receive funds

Formatuuid

storeId*string

Identifiant du magasin from which to transfer funds

Formatuuid

amountCents*integer

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

Intervalle500 <= value

currency*string

Code devise (ISO 4217)

Longueur3 <= length <= 3

description?string

Optional description for the transfer

Longueurlength <= 255

reference?string

Partner reference for reconciliation (echoed in responses and webhooks when provided)

Longueur5 <= length <= 100

Réponses

200 application/json

400 application/json

401 application/json

403 application/json

404 application/json

409 application/json

422 application/json

500 application/json

cURL

JavaScript

Go

Python

Java

C#

Rust

curl -X POST "https://api.kelyko.invalid/partner_api/transfers" \
  -H "X-API-KEY: " \
  -H "X-API-KEY-ID: " \
  -H "Content-Type: application/json" \
  -d '{
    "contactId": "b5ec5d98-4bee-4da1-ad24-dde86346cb1d",
    "storeId": "b8adcdc8-9238-4168-90f8-77b2d14c211c",
    "amountCents": 500,
    "currency": "str"
  }'

200400401403404409422500

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

Demander à l'IA ⌘I