Accepter un paiement

Initiez un paiement mobile money avec l'endpoint suivant.

Endpoint

POST https://api.openpay-cg.com/v1/transaction/payment

Paramètres de la requête

Paramètre	Type	Requis	Description
amount	number	Obligatoire	Montant de la transaction en XAF
payment_phone_number	string	Obligatoire	Numéro de téléphone du client (format: 242XXXXXXXXX)
provider	string	Obligatoire	Opérateur mobile : `MTN,` `AIRTEL`
customer_external_id	string	Optionnel	ID unique du client dans votre système
customer	object	Optionnel	Informations du client (`name`, `phone`)
metadata	object	Optionnel	Données additionnelles pour votre usage

amountObligatoire

number

Montant de la transaction en XAF

payment_phone_numberObligatoire

string

Numéro de téléphone du client (format: 242XXXXXXXXX)

providerObligatoire

string

Opérateur mobile : MTN, AIRTEL

customer_external_idOptionnel

string

ID unique du client dans votre système

customerOptionnel

object

Informations du client (name, phone)

metadataOptionnel

object

Données additionnelles pour votre usage

Exemple de requête

JSON body

{
  "amount": 1,
  "payment_phone_number": "242066203420",
  "customer_external_id": "1111",
  "customer": {
    "name": "azerty",
    "phone": "242066203420"
  },
  "provider": "MTN",
  "metadata": {
    "order_id": "123456",
    "customer_name": "Jean Dupont"
  }
}

Réponse de succès

JSON200 OK

{
  "reference": "PTXN26042237B99A5D9",
  "amount": "1000",
  "currency": "XAF",
  "paymentPhoneNumber": "242066203420",
  "provider": "MTN",
  "type": "payment",
  "status": "success",
  "message": "Paiement effectué avec succès.",
  "metadata": null
}

Callback après un paiement

Une fois le paiement traité, OpenPay envoie un POST JSON vers le callback_url de votre plateforme (configurable dans l’espace partenaire). Le corps reprend le même format que la réponse API ci-dessus. Politique de relance et timeout : documentation Callback URL. Votre endpoint doit répondre HTTP 200.

Payload - type paymentPOST

{
  "reference": "PTXN26042237B99A5D9",
  "amount": "1000",
  "currency": "XAF",
  "paymentPhoneNumber": "242066203420",
  "provider": "MTN",
  "type": "payment",
  "status": "success",
  "message": "Paiement effectué avec succès.",
  "metadata": {
    "order_id": "123456",
    "customer_name": "Jean Dupont"
  }
}