Initiate a payment

STATUSES

  • PENDING = "PENDING" - A transaction record has been created but user hasn't started anything

  • NO_CONSENT = "NO_CONSENT", - User interacted with the payment but later cancelled the flow

  • AWAITING_AUTHORIZATION = "AWAITING_AUTHORIZATION", - User needs to authorize payment on app

  • PROCESSING = "PROCESSING", - Payment made by user and it's processing and awaiting confirmation

  • COMPLETED = "COMPLETED", - Payment confirmed to have left customers account, awaiting confirmation on receipt

  • SETTLED = "SETTLED", - Payment has settled in the settlement account. (You can now give value)

  • REFUNDED = "REFUNDED", - Payment refunded/rejected

  • FAILED = "FAILED", - Payment failed /rejected by bank

  • EXPIRED = "EXPIRED", - Payment link has expired. New call should be made

  • CANCELLED = "CANCELLED", - Payment cancelled by system

Initiate a payment

post
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Header parameters
X-CLIENTIDstringRequired

Client identifier for the API.

Example: sdfgfd-sdfgf4d-sdfgfdsd-sdfgfds
Body
amountnumberOptional

The amount to be paid.

Example: 5
currencystringOptional

The currency of the payment.

Example: GBP
settlement_accountstringOptional

The account to settle the payment.

Example: 987d28af0d
transaction_refstringOptional

Reference for the transaction.

Example: 34534redf3d00
narrationstringOptional

A description or reason for the payment.

Example: Gift
webhook_urlstringOptional

URL for webhook notifications related to this payment.

Example: https://webhook.site/481927c8-36d7-4cc0-a9de-49562206d9b1
redirect_urlstringOptional

URL to redirect after payment.

Example: https://wikipedia.com
Responses
200

Payment initiated successfully.

application/json
post
/initiate-payment/
POST /initiate-payment/ HTTP/1.1
Host: endozapi.celergate.net
Authorization: Bearer YOUR_SECRET_TOKEN
X-CLIENTID: text
Content-Type: application/json
Accept: */*
Content-Length: 356

{
  "amount": 5,
  "currency": "GBP",
  "settlement_account": "987d28af0d",
  "transaction_ref": "34534redf3d00",
  "narration": "Gift",
  "webhook_url": "https://webhook.site/481927c8-36d7-4cc0-a9de-49562206d9b1",
  "redirect_url": "https://wikipedia.com",
  "payer": {
    "first_name": "Ahmad",
    "last_name": "Sharafudeen",
    "email_address": "ahmadsharafudeen@gmail.com",
    "address": "Lugbe, Abuja"
  }
}
{
  "reference": "202503131111096386ed356c98f9a4",
  "hosted_url": "https://endozpay.celergate.net?payload=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJwYXltZW50X2lkIjo1MywicmVmZXJlbmNlIjoiMzQ1MzRyZWRmM2QwMCIsImFtb3VudCI6NS4wLCJjdXJyZW5jeSI6Ilx1MDBhMyIsImNsaWVudCI6IkVuZG96IERldiJ9.qC5iILRh0zmSD0jMpY4Csv9UZHBZ3sGmcCFipGzz6qs"
}
PreviousLoginNextWebhook

Last updated