Checkout link
Simplify payments with a simple link!
The Checkout link functions similarly to the checkout inline; however, it's produced as a straightforward on-the-fly link. Unlike the checkout inline, there's no necessity for an HTML form. By encoding your payment specifics as query strings, you can craft a personalized checkout link. This approach ensures a seamless payment process and guarantees a smooth return of customers to your platform for uninterrupted interactions.
Try Payment below
Experiment with the payment process by obtaining Test Data and initiating a sample payment.
Sample Card:
Card number: 5531 8866 5214 2950
Expiry Date: 09/32
CVV: 555,
You can get more sample cards in Test Data and play around with the widget
Simple walk-through
- Create a payment link by adding payment parameters as query string to base URL
- Redirect customer to the link to make payment
- When payment is completed, the customer is redirected back to your charge url.
Each of the query string is explained in the table below
https://checkout.paga.com/checkout/params?public_key="23A3E317-7382-4032-94DE-50BA4B653EE5"&amount="1000.00"¤cy="NGN"&payment_reference="JHX-18743567"&charge_url="https://neutral.site/payment/confirmation"&phone_number="+2348063334156"&email="[email protected]"&display_image="https://neutral.site/payment/company_logo"&callback_url="https://neutral.site/payment/callback"&funding_sources="CARD,PAGA,TRANSFER,AGENT,USSD"
Base URL
Live environment - https://checkout.paga.com/?
Test Environment - https://beta-checkout.paga.com/?
Query Strings | Data Type | Required | Description |
---|---|---|---|
public_key | String | Yes | Public Key for your Paga business account |
amount | Number | Yes | Amount you want customer to pay |
currency | String | No | Default is NGN , specify if otherwise |
payment_reference | String | No | Payment identifier, if not provided, paga will generate |
charge_url | String | No | Location to redirect your customer after payment |
phone_number | String | No | Customer's phone number |
String | No | Customer's email address | |
display_image | String | No | Merchant preferred image on checkout |
callback_url | String | No | To receive callback for payment, indicate callback url |
funding_sources | List | No | Default is all payment method available. If specific payment method is preffered, specify and separate with comma in preferred orderCARD,PAGA,TRANSFER,AGENT,USSD |
After Payment
Three actions will happen immediately after payment is completed
- Customer will be redirected automatically to
data-charge_url
provided in the script tag withcharge_reference=JHX-18743567
&status_message=success
&status_code=0
https://neutral.site/payment/confirmation?charge_reference=JHX-7045679&status_message=success&status_code=0
Params | Data Type | Required | Description |
---|---|---|---|
charge_reference | String | Yes | This is payment reference you provided in the script tag, if not provided we generate one for you |
status_message | String | Yes | success - Indicate the payment was successful |
status_code | Number | Yes | 0 - Success Payment |
- We'll send you a webhook if you provide
data-callback_url
{
"statusCode": 0,
"statusMessage": "success",
"paymentReference": "JHX-18743567",
"amount": 1000,
"currency": "NGN",
"timeStamp": "2021-03-08T15:52:13.000Z",
"description": "Payment successful",
"customerEmail": "[email protected]",
"customerPhoneNumber": "+2348063334156"
}
- We'll send you an email if you've enabled notification on your business account
Verify Charge
This service allows the merchant to verify the status and details of an executed process to determine if a transaction was indeed executed on Paga system using the pre-shared transaction payment reference number.
https://checkout.paga.com/checkout/transaction/verify
POST /checkout/transaction/verify HTTP/1.1
Content-Type: application/json
Accept: application/json
Authorization: "Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ=="
{
paymentReference:"JHX-18743567",
amount:1000,
currency:"NGN"
}
{
"status_code": 0,
"status_message": "successful",
"chargeId":"",
"amount": 1000,
"currency": "NGN"
}
Response | Type | Mandatory(M)/Optional(0) | Description |
---|---|---|---|
status_code | String | M | A status code of 0 indicating successful transaction |
status_message | String | M | A human-readable message describing the transaction result (success or fail) |
chargeId | String | M | The unique reference number code provided with the request |
amount | Number | M | amount charged |
currrencu | String | M | NGN by default |
Updated 7 months ago