Create an Ecommerce Payment

Example JSON Body

{
    "asset": "USD",
    "amount": "3",
    "email": "your_email@example.com",
    "description": "some description",
    "reference": "some-ref",
    "auto_settle": "true",
    "apiKey": "Your API Key",
    "apiSecret": "Your API Secret",
    "cart_items": [ "E-book,Crypto Trading,1,3" ]
}

400 - Payment Creation Failed with reason

{
    "status": "nok",
    "message": "Operation Failed!",
    "error": "Asset is required, Amount is required",
    "validated": false
}

201: Created Payment Successfully Created

{
    "status": "ok",
    "paymentId": "X8sjfaja8",
    "paymentShortId": "",
    "mobile_check_url": "",
    "payment_url": "/en/payment/detail/X8sjfaja8",
    "payment_address": "",
    "message": "Payment successfully created!" 
}

Examples

Create a Payment & Custom Deliver

This is used when you would like to handle how the payment is delivered to your user.

The default response (show_payment_html=false or null) returns a JSON response with URLs that you can present to your customer any way you wish. QR code, SMS, email, or a payment button are common examples. If your account supports mobile payments you can present the mobile_check_url which will attempt to launch any installed mobile app for payment, otherwise, it will default the user to the payment page.

Create a Payment & Redirect User

To simplify your integration you can post to the endpoint from a form and with show_payment_html=true we will generate the payment and display the payment page on the fly.

Get Payment

The Get Payment Details endpoint allows merchants to request and review comprehensive information about a specific payment.

This endpoint returns the current status, transaction history, and key details associated with the payment, enabling merchants to track and verify payment progression accurately. Use this endpoint to monitor the state of each transaction, confirm payment amounts, and access metadata for customer support or reconciliation purposes. This ensures you stay updated on payment statuses without relying on notifications or redirects alone.

Request Body

400: OK Get Payment Failed

{
    "status": "nok",
    "message": "Get Payment Detail Failed!",
    "error": "Payment Code is required",
    "validated": false
}

200: OK Get Payment Success

{
    "status": "ok",
    "payment": {
        "status": "success",
        "details": { ... }
    }
}