Developer
Initiates a new payment transaction.
{{base_url}}/payment/create
{{base_url}}/payment/api-direct
| Parameter | Type | Details |
|---|---|---|
| amount | decimal | Your Amount , Must be rounded at 2 precision. |
| currency | string | Currency Code, Must be in Upper Case (Alpha-3 code) |
| return_url | string | Enter your return or success URL |
| cancel_url | string (optional) | Enter your cancel or failed URL |
| custom | string (optional) | Transaction ID that can be used in your project transaction. |
| type | string (optional) | Set as 'qrcode' to receive a QR code image instead of a payment URL. |
Request Example (guzzle)
<?php
require_once('vendor/autoload.php');
$client = new \GuzzleHttp\Client();
$response = $client->request('POST', '{{base_url}}/payment/create', [
'json' => [
'amount' => '100.00',
'currency' => 'USD',
'return_url' => 'www.example.com/success',
'cancel_url' => 'www.example.com/cancel',
'custom' => '123456789ABCD',
'type' => 'qrcode', // Request QR Code instead of payment URL
],
'headers' => [
'Authorization' => 'Bearer {{access_token}}',
'accept' => 'application/json',
'content-type' => 'application/json',
],
]);
echo $response->getBody();
Request Example (guzzle)
<?php
require_once('vendor/autoload.php');
$client = new \GuzzleHttp\Client();
$response = $client->request('POST', '{{base_url}}/payment/api-direct', [
'json' => [
'phone_number' => '670701414',
'network' => 'MTN', // Can either be mtn or orange ['MTN', 'ORANGE']
'amount' => 200,//greater than 100
'currency' => 'XAF',
'client_id' => 'hprGqN3xkkyJFzJCowHo8kSC3hGuH8xm4gdfvdfvmkXmeyb8v1NeD9p3xCA61HqXUHBKfBUabq2sMcGWgMmgbS39ODtDqJ44yH5T7EZzDy',
'secret_id' => 'O74ZS9UZRdAi5nD9GSbC8Yi1SxfYcrbajpdbvPdfvdfvpbPlMYWH2Rsh9h4OHMc9xZPtfhVft1zlNiZQFoES3kgpU16e4WnZJeObzn3dJ1'
],
'headers' => [
'Authorization' => 'Bearer {{access_token}}',
'Accept' => 'application/json',
'Content-Type' => 'application/json',
],
]);
echo $response->getBody();
**Response: SUCCESS (200 OK)**
For a standard payment URL:
{
"message": {
"code": 200,
"success": ["CREATED"]
},
"data": {
"token": "2zMRmT3KeYT2BWMAyGhqEfuw4tOYOfGXKeyKqehZ8mF1E35hMwE69gPpyo3e",
"payment_url": "www.example.com/pay/sandbox/v1/user/authentication/form/2zMRmT3KeYT2BWMAyGhqEfuw4tOYOfGXKeyKqehZ8mF1E35hMwE69gPpyo3e"
},
"type": "success"
}
**Response: QR Code (200 OK)**
If 'type' is set to 'qrcode', the response will include a QR code instead of a payment URL:
{
"message": {
"code": 200,
"success": ["CREATED"]
},
"data": {
"token": "2zMRmT3KeYT2BWMAyGhqEfuw4tOYOfGXKeyKqehZ8mF1E35hMwE69gPpyo3e",
"qr_code": "https://quickchart.io/qr?text=https://www.example.com/pay/sandbox/v1/user/authentication/form/2zMRmT3KeYT2BWMAyGhqEfuw4tOYOfGXKeyKqehZ8mF1E35hMwE69gPpyo3e&size=300&ecLevel=H&margin=10¢erImageUrl=https://whapplepay.com/qrcodedata.png"
},
"type": "success"
}
**Response: APi Direct response failed**
Response: ERROR (400 FAILED)
{
"message": {
"code": 400,
"success": []
},
"data": {
"trx_id": "baAUF1ihp8oe2gnb",
"custom": "123456789ABCD"
},
"details": "The payment has failed! (Error during the processing of the transaction)",
"type": "FAILED"
}
**Response: ERROR (403 FAILED)**
{
"message": {
"code": 403,
"error": ["Requested with invalid token!"]
},
"data": [],
"type": "error"
}