v1

latestOpenAPI 3.1.02026-07-26540161.7 KB

Initiate a charge

This API lets you charge using any of the available payment methods

post/checkout/charges

Headers

api-keystring required

x-business-idstring required

Request body

amountinteger required

The amount to charge the customer

referencestring required

The unique transaction reference identifies the transaction on your application. If you do not provide one, a unique transaction reference would be generated for the transaction.

currency'NGN' | 'GHS' | 'KES' | 'ZAR' | 'UGX' | 'TZS' | 'ZMW' | 'XAF' | 'XOF' required

The currency in which the customer should be charged e.g ZAR, NGN etc.

type'card' | 'bank_transfer' | 'mobile_money' | 'eft' | 'payattitude' required

This payment method which can either be card, bank_transfer, mobile_money, payattitude or eft.

phonestring

The customer's payAttitude account phone number. This is required if "type" is payattitude or mobile_money

descriptionstring

The description of the transaction

settlementDestination'wallet' | 'bank_account'

A settlement destination is the location where you want your payments to be settled. It could be wallet or a bank account.

callbackUrlstring

The URL to redirect your customer when the transaction is complete.It's the url of your payment page you want your users to return to after 3ds authorization.

operator'MTN' | 'AIRTEL' | 'AIRTELTIGO' | 'MPESA' | 'TIGO'

This is required if type is mobile money

quoteReferencestring

This is only required when initiating a cross currency charge

webhookUrlstring

The URL to receive transaction notifications.

Response

200

statusboolean

messagestring

Example response

{
  "status": true,
  "message": "Charge created",
  "data": {
    "id": 280,
    "authorization": {
      "mode": "PIN"
    },
    "auth_model": "PIN",
    "amount": 150000,
    "currency": "NGN",
    "fee": 2000,
    "message": "Card PIN required",
    "status": "processing",
    "reference": "KPHHHHSS",
    "type": "card",
    "customer": {
      "name": "Fincra Developers",
      "email": "developers@fincra.com",
      "phoneNumber": "+2348142986562"
    },
    "settlementDestination": "wallet"
  }
}