Initiate a payment

STATUSES

• SETTLED - Transaction completed, Amount has been deducted from customer, and settled into client's settlement account

• REFUNDED - Payment refunded/rejected

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

• CANCELLED - Payment cancelled by system

• FAILED - Payment failed /rejected by bank

• COMPLETED - Amount has been deducted from customer into Endoz' account, waiting to be settled into client's settlement account

• PROCESSING - Transaction initiated, Customer has approved removal of the money, but theira bank is still communicating with Endoz Bank API

• AWAITNG AUTHORIZATION - Customer landed on the Endoz (Open Banking) Interface, selected a bank, proceeded to their bank app but didn't approve the removal of the money.

• NO CONSENT - Customer landed on the Endoz (Open Banking) Interface, selected a bank but didn't proceed to their bank app nor scan the QR code.

• PENDING - Customer landed on the Endoz (Open Banking) Interface but didn't proceed to do any other thing.

Initiate a payment

post

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Header parameters

X-CLIENTIDstringRequired

Client identifier for the API.

Example: sdfgfd-sdfgf4d-sdfgfdsd-sdfgfds

Body

application/json

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

referencestringOptional

Reference for the payment.

hosted_urlstringOptional

URL to redirect to for payment.

400

Bad Request - Invalid data or missing required fields.

application/json

401

Unauthorized - Missing or invalid X-CLIENTID header.

application/json

500

Server error

application/json

post

/initiate-payment/

HTTPcURLJavaScriptPython

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": "[e-mail]",
    "address": "Lugbe, Abuja"
  }
}

{
  "reference": "202503131111096386ed356c98f9a4",
  "hosted_url": "https://endozpay.celergate.net?payload=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJwYXltZW50X2lkIjo1MywicmVmZXJlbmNlIjoiMzQ1MzRyZWRmM2QwMCIsImFtb3VudCI6NS4wLCJjdXJyZW5jeSI6Ilx1MDBhMyIsImNsaWVudCI6IkVuZG96IERldiJ9.qC5iILRh0zmSD0jMpY4Csv9UZHBZ3sGmcCFipGzz6qs"
}