v1

latestOpenAPI 3.1.02026-07-26540161.7 KB

Initiate Checkout

post/checkout/payments

Headers

x-pub-keystring

Your public key. This can be found in the settings page of your portal

x-business-idstring

The unique Identifier of the parent business

Request body

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

The currency in which the customer should be charged. (NGN, KES, GHS, UGX,XAF,XOF)

amountinteger required

The amount to charge the customer

paymentMethodsstring[]

The payment method you want to make available to your customers . e.g bank_transfer, card and payAttitude

referencestring

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.

feeBearer'customer' | 'business'

Decide who will bear the transaction fees.

settlementDestination'wallet'

A settlement destination is the location where you want your payments to be settled. The settlement destination is your Fincra wallet by default.

redirectUrlstring

The URL to redirect your customer when the transaction is complete.

defaultPaymentMethod'bank_transfer' | 'card' | 'payAttitude'

The Payment method that should be active by default on the checkout page

metadataobject

Add any information you would like to send e.g metadata: {userId: "my_user_id" }

quoteReferencestring

This is only required when initiating a cross currency checkout

Response

200

statusboolean

messagestring

Example response

{
  "status": true,
  "message": "Hosted link generated",
  "data": {
    "link": "https://sandbox-checkout.fincra.com/pay/fcr-p-08e0c36289",
    "reference": "KB-909",
    "payCode": "fcr-p-08e0c36289"
  }
}