{
"id": "pi_z1urYtVFgEebtcj8fxp4v",
"merchantId": "<string>",
"createdAt": "2020-10-15T12:09:49.355Z",
"updatedAt": "2020-10-15T12:16:26.128Z",
"token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJtZXJjaGFudElkIjoiMTYiLCJtb2RlIjoic2FuZGJveCIsInBheW1lbnRJZCI6InBpX3oxdXJZdFZGZ0VlYnRjajhmeHA0diIsImlhdCI6MTYwMjc1OTE4M30.OZ0fDnMVWvcT-gRthyBD58PFC20gabGKt1UPRe4aNi4",
"purchaseReference": "ref_2020_11_10_001",
"customerReference": "cust_01924059",
"status": "successful",
"amount": 100,
"currency": "XOF",
"payments": [
{
"id": "pay_QW2d6JnqiatcH8KhK0mD1",
"intentId": "pi_z1urYtVFgEebtcj8fxp4v",
"createdAt": "2020-10-15T12:09:49.355Z",
"updatedAt": "2020-10-15T12:16:26.128Z",
"status": "successful",
"amount": 100,
"currency": "XOF",
"method": "credit_card",
"country": "CI",
"failure": {
"code": "internal_error",
"message": "<string>",
"params": [
"<string>"
]
},
"fees": [
{
"id": "lAe5HnFpvOjwdT9vSIgPA",
"rate": 123,
"rateType": "percent",
"amount": 5,
"currency": "XOF",
"label": "<string>",
"taxes": [
"<string>"
]
}
],
"nextAction": {
"type": "ussd",
"message": "<string>",
"data": {
"url": "<string>",
"urls": "<string>",
"method": "post",
"headers": {},
"data": {}
}
},
"providerReference": "<string>",
"gatewayId": "<string>",
"number": "<string>",
"onSuccessRedirectionUrl": "https://my.website.com/cancel",
"onFailedRedirectionUrl": "https://my.website.com/finish",
"billing": {}
}
],
"mode": "live",
"nextAction": {
"type": "ussd",
"message": "<string>",
"data": {
"url": "<string>",
"urls": "<string>",
"method": "post",
"headers": {},
"data": {}
}
},
"lastPaymentFailure": {
"code": "internal_error",
"message": "<string>",
"params": [
"<string>"
]
},
"overrideBusinessName": "MyBusiness"
}
Some circuit have authentication restrictions which requires an extra step. This endpoint is here to allow you to make that extra steps. It happens after a payment has been requested and when that payment moved to the “action_required” state.
{
"id": "pi_z1urYtVFgEebtcj8fxp4v",
"merchantId": "<string>",
"createdAt": "2020-10-15T12:09:49.355Z",
"updatedAt": "2020-10-15T12:16:26.128Z",
"token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJtZXJjaGFudElkIjoiMTYiLCJtb2RlIjoic2FuZGJveCIsInBheW1lbnRJZCI6InBpX3oxdXJZdFZGZ0VlYnRjajhmeHA0diIsImlhdCI6MTYwMjc1OTE4M30.OZ0fDnMVWvcT-gRthyBD58PFC20gabGKt1UPRe4aNi4",
"purchaseReference": "ref_2020_11_10_001",
"customerReference": "cust_01924059",
"status": "successful",
"amount": 100,
"currency": "XOF",
"payments": [
{
"id": "pay_QW2d6JnqiatcH8KhK0mD1",
"intentId": "pi_z1urYtVFgEebtcj8fxp4v",
"createdAt": "2020-10-15T12:09:49.355Z",
"updatedAt": "2020-10-15T12:16:26.128Z",
"status": "successful",
"amount": 100,
"currency": "XOF",
"method": "credit_card",
"country": "CI",
"failure": {
"code": "internal_error",
"message": "<string>",
"params": [
"<string>"
]
},
"fees": [
{
"id": "lAe5HnFpvOjwdT9vSIgPA",
"rate": 123,
"rateType": "percent",
"amount": 5,
"currency": "XOF",
"label": "<string>",
"taxes": [
"<string>"
]
}
],
"nextAction": {
"type": "ussd",
"message": "<string>",
"data": {
"url": "<string>",
"urls": "<string>",
"method": "post",
"headers": {},
"data": {}
}
},
"providerReference": "<string>",
"gatewayId": "<string>",
"number": "<string>",
"onSuccessRedirectionUrl": "https://my.website.com/cancel",
"onFailedRedirectionUrl": "https://my.website.com/finish",
"billing": {}
}
],
"mode": "live",
"nextAction": {
"type": "ussd",
"message": "<string>",
"data": {
"url": "<string>",
"urls": "<string>",
"method": "post",
"headers": {},
"data": {}
}
},
"lastPaymentFailure": {
"code": "internal_error",
"message": "<string>",
"params": [
"<string>"
]
},
"overrideBusinessName": "MyBusiness"
}
Your api key. To create a key, please get into our dashboard. If you don't have access to it, please reach the Support team.
Your merchant ID. This information is available in our dashboard. If you don't have access to it, please reach the Support team.
Allow you to choose between the sandbox mode to perform some tests or the live mode for real world transactions.
live
, sandbox
Identifier of the PaymentIntent requiring authentication.
The response is of type object
.