PaymentsStandard Checkout

Standard Checkout

The Standard Checkout integration allows you to generate a unique payment URL that your customers can use to securely complete their transactions.

  1. Initialize the Payment
    Make a server-side POST request to the payment initialization endpoint:
    https://mainapi.cashonrails.com/api/v1/transaction/initialize.

  2. Redirect the Customer
    Upon a successful request, we’ll return a unique link or access code for the payment page. Redirect your customer to this page to complete their payment.

  3. After the Payment
    Once the payment is completed, the customer will be redirected back to your provided redirectUrl. You can use this event to confirm the transaction and update your records.

Step 1: Initialize the Payment

Make a server-side POST request to the payment initialization endpoint with the following payload:

{
  "email": "customer@example.com",
  "first_name": "John",
  "last_name": "Doe",
  "amount": "5000",
  "currency": "NGN",
  "reference": "unique-ref-12345",
  "redirectUrl": "https://example.com/payment-complete",
  "logoUrl": "https://example.com/logo.png"
}
FieldTypeRequiredDescription
emailstringYesCustomer’s email address (e.g., customer@example.com)
first_namestringYesCustomer’s first name (e.g., John)
last_namestringYesCustomer’s last name (e.g., Doe)
amountstringYesThe amount to be charged (e.g., 5000)
currencystringYesThe currency of the transaction (e.g., NGN)
referencestringYesA unique reference for the transaction (e.g., unique-ref-12345)
redirectUrlstringNoThe URL to redirect after payment (e.g., https://example.com/payment-complete)
logoUrlstringNoThe URL of the logo to display (e.g., https://example.com/logo.png)

Step 2: Redirect the Customer

Upon a successful request, we’ll return a unique link or access code for the payment page. Redirect your customer to this page to complete their payment.

Response

{
  "success": true,
  "message": "Transaction Initialized Successfully",
  "data": {
    "authorization_url": null,
    "access_code": "x012345678abcdefghijkl",
    "checkout_link": "https://checkout.cashonrails.com/pay/x012345678abcdefghijkl",
    "transactionRef": "COR-qqlmex9vo62pdcl84rdzb",
    "reference": "78248692"
  }
}

Step 3: After the Payment

After the payment is completed, the following actions will occur:

  1. The customer will be redirected to your redirect_url with query parameters status, reference.
  2. If webhooks are enabled, a notification will be sent to your webhook endpoint. Learn more about webhooks.
  3. An email receipt will be sent to the customer if the payment was successful, unless this feature is disabled.
  4. You will receive an email notification, unless this feature is disabled.

On your server, you should handle the redirect and always verify the final state of the transaction.

Inline CheckoutIntroduction