Skip to main content
POST
/
partner_api
/
payment_requests
Créer une demande de paiement
curl --request POST \
  --url https://api.jeko.africa/partner_api/payment_requests \
  --header 'Content-Type: application/json' \
  --header 'X-API-KEY: <api-key>' \
  --data '
{
  "amountCents": 10000,
  "currency": "XOF",
  "reference": "PAY-2024-001",
  "storeId": "59ae202a-f583-4a15-970f-9e99bd1e0baa",
  "paymentDetails": {
    "type": "redirect",
    "data": {
      "paymentMethod": "wave",
      "successUrl": "https://example.com/success",
      "errorUrl": "https://example.com/error",
      "deviceId": "DEVICE-123",
      "forceProviderDirect": false,
      "payerPhone": "+2250765432108"
    }
  }
}
'
{
  "id": "d22c81f3-ee04-4ec5-8bd2-cd8af5dabcfc",
  "storeId": "59ae202a-f583-4a15-970f-9e99bd1e0baa",
  "reference": "PAY-2024-001",
  "type": "redirect",
  "paymentMethod": "wave",
  "status": "success",
  "redirectUrl": "https://pay.jeko.africa/payment/d22c81f3-ee04-4ec5-8bd2-cd8af5dabcfc",
  "errorReason": "Payment failed",
  "transaction": {
    "id": "txn_1234567890",
    "amount": {
      "amount": 10000,
      "currency": "XOF"
    },
    "fees": {
      "amount": 10000,
      "currency": "XOF"
    },
    "status": "success",
    "counterpartLabel": "Customer Name",
    "counterpartIdentifier": "+2250701234567",
    "description": "Payment for order #12345",
    "executedAt": "2024-01-15 14:30:25"
  }
}

Authorizations

​
X-API-KEY
string
header
required

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

Body

application/json
​
amountCents
integer
required

Montant en centimes

Required range: x >= 100
Example:

10000

​
currency
string
required

Code devise (ISO 4217)

Required string length: 3
Example:

"XOF"

​
reference
string
required

Payment reference

Required string length: 1 - 100
Example:

"PAY-2024-001"

​
storeId
string<uuid>
required

Identifiant du magasin

Example:

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

​
paymentDetails
object
required

Response

Demande de paiement créée avec succès. Retourne les détails du paiement incluant l'URL de redirection pour les paiements web ou le contenu du code QR pour les paiements sur appareil.

Schéma de réponse pour récupérer une demande de paiement par ID

​
id
string
required

Payment request identifier

Example:

"d22c81f3-ee04-4ec5-8bd2-cd8af5dabcfc"

​
storeId
string
required

Identifiant du magasin

Example:

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

​
reference
string
required

Référence de paiement fournie dans la requête originale

Example:

"PAY-2024-001"

​
type
enum<string>
required

Payment type

Available options:
redirect,
soundbox
Example:

"redirect"

​
paymentMethod
enum<string>
required

Payment method used

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

"wave"

​
status
enum<string>
required

Statut actuel de la demande de paiement

Available options:
pending,
error,
success
Example:

"success"

​
redirectUrl
string<uri>
required

URL de redirection pour les paiements web

Example:

"https://pay.jeko.africa/payment/d22c81f3-ee04-4ec5-8bd2-cd8af5dabcfc"

​
errorReason
string | null

Raison de l'erreur

Example:

"Payment failed"

​
transaction
object

Détails de transaction lorsque le paiement est terminé