Payments
Object samples
Getting started
Payments
Object samples
Authentication Successful example
{
"id": "pi_tffiDaXyWQu203rIXhujW",
"createdAt": "2022-07-18T06:35:25.932Z",
"updatedAt": "2022-07-18T07:20:05.765Z",
"merchantId": "XXXXX",
"purchaseReference": "Test_YYYY_MM_DD_01",
"customerReference": "Test_01",
"amount": 200,
"currency": "XOF",
"token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpbnRlbnRJZCI6InBpX3RmZmlEYVh5V1F1MjAzcklYaHVqVyIsIm1lcmNoYW50SWQiOiIzIiwibW9kZSI6InNhbmRib3giLCJpYXQiOjE2NTgxMjYxMjV9.1eB6ifC2ldfRw5UstnVa-bQqIdx9_IGLRdwWyXzZR4o",
"status": "successful",
"payments": [
{
"id": "pay_GBc53h6dHvuuq4vlcP6dY",
"intentId": "pi_tffiDaXyWQu203rIXhujW",
"createdAt": "2022-07-18T06:39:20.721Z",
"updatedAt": "2022-07-18T07:20:05.765Z",
"amount": 207,
"currency": "XOF",
"status": "successful",
"method": "mobile_money",
"country": "CI",
"provider": "orange",
"number": "00000001",
"fees": [
{
"currency": "XOF",
"id": "fee_bDf6JT6q2JdDOkM153e1A",
"label": "payments.payment_processor_fee",
"rate": 3,
"rateType": "percent",
"amount": 7
}
]
}
],
"mode": "sandbox"
}
Some payments failed and one succeeded example
The Payments
objects in the payments
array are not chronologically ordered.
{
"id": "pi_-SYVsnP7J35bhAFna5lT9",
"createdAt": "2022-07-18T07:29:57.209Z",
"updatedAt": "2022-07-18T07:39:39.453Z",
"merchantId": "XXXXX",
"purchaseReference": "df_test_2022_07_18_02",
"customerReference": "df_test_2022",
"amount": 200,
"currency": "XOF",
"token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpbnRlbnRJZCI6InBpXy1TWVZzblA3SjM1YmhBRm5hNWxUOSIsIm1lcmNoYW50SWQiOiIzIiwibW9kZSI6InNhbmRib3giLCJpYXQiOjE2NTgxMjkzOTd9.hLCH3W_1QdLD8xKzwvteo82Zhx2pxdo2Y8Mg3MT82L8",
"status": "successful",
"payments": [
{
"id": "pay_TFdgUPOtJUk8AFQm4uKR0",
"intentId": "pi_-SYVsnP7J35bhAFna5lT9",
"createdAt": "2022-07-18T07:30:18.906Z",
"updatedAt": "2022-07-18T07:39:39.453Z",
"amount": 207,
"currency": "XOF",
"status": "failed",
"method": "mobile_money",
"country": "CI",
"provider": "orange",
"number": "00000100",
"fees": [
{
"currency": "XOF",
"id": "fee_kk7BYFirka7FrHg3N6Kdj",
"label": "payments.payment_processor_fee",
"rate": 3,
"rateType": "percent",
"amount": 7
}
],
"failure": {
"code": "authentication_failed",
"message": "La validation du paiement par la client a échoué, le paiement a été annulé."
}
},
{
"id": "pay_3Ar1m6sEb8ikLvSuI5oyh",
"intentId": "pi_-SYVsnP7J35bhAFna5lT9",
"createdAt": "2022-07-18T07:39:31.837Z",
"updatedAt": "2022-07-18T07:39:39.453Z",
"amount": 207,
"currency": "XOF",
"status": "successful",
"method": "mobile_money",
"country": "CI",
"provider": "orange",
"number": "00000001",
"fees": [
{
"currency": "XOF",
"id": "fee_ck0eYEbWAB4ONdIqxWhnF",
"label": "payments.payment_processor_fee",
"rate": 3,
"rateType": "percent",
"amount": 7
}
]
},
{
"id": "pay_pbouB8iyXvmvj1UuLuiua",
"intentId": "pi_-SYVsnP7J35bhAFna5lT9",
"createdAt": "2022-07-18T07:32:57.096Z",
"updatedAt": "2022-07-18T07:39:39.453Z",
"amount": 207,
"currency": "XOF",
"status": "failed",
"method": "mobile_money",
"country": "CI",
"provider": "orange",
"number": "00000100",
"fees": [
{
"currency": "XOF",
"id": "fee_PKZjBxVFqu3F97pDFiIVq",
"label": "payments.payment_processor_fee",
"rate": 3,
"rateType": "percent",
"amount": 7
}
],
"failure": {
"code": "authentication_failed",
"message": "La validation du paiement par la client a échoué, le paiement a été annulé."
}
},
{
"id": "pay_C4QiTpenPNQwuT0aTpDDz",
"intentId": "pi_-SYVsnP7J35bhAFna5lT9",
"createdAt": "2022-07-18T07:33:21.932Z",
"updatedAt": "2022-07-18T07:39:39.453Z",
"amount": 207,
"currency": "XOF",
"status": "failed",
"method": "mobile_money",
"country": "CI",
"provider": "orange",
"number": "00000100",
"fees": [
{
"currency": "XOF",
"id": "fee_wEfL3AzP3fU2CGrCs1hjh",
"label": "payments.payment_processor_fee",
"rate": 3,
"rateType": "percent",
"amount": 7
}
],
"failure": {
"code": "authentication_failed",
"message": "La validation du paiement par la client a échoué, le paiement a été annulé."
}
}
],
"lastPaymentFailure": {
"code": "authentication_failed",
"message": "La validation du paiement par la client a échoué, le paiement a été annulé."
},
"mode": "sandbox"
}