Sign in

v1

latestOpenAPI 3.0.02026-07-14866188.2 KB
Payments

Initiate a payment request

post/v0.2.4/payment/initiate

Request body

valueInUSDnumber

Amount in USD to collect.

payerEmailstring required

Email of the one making the payment.

currency'USD' | 'NGN' | 'CAD'

ISO Currency String like CAD, USD, NGN etc.

amountstring

Amount in specified "currency" to collect. Required if currency is set.

redirect_urlstring

URL to redirect to after payment is confirmed.

walletIDstring

ID of the wallet to settle the payment to (optional)

narrationstring

Narration for the payment (optional)

subAccountstring

Subaccount if any.

metaobject

Object containing metadata you want to pass to the request to use later.

turnOffNotificationboolean

Disables email and other notifications from Chimoney.

redeemDataobject

Object containing redeem data.

Example request

{
  "redirect_url": "https://example.com/confirm"
}

Response

Success.

statusstring

Status of the request.

messagestring

Example response

{
  "status": "success",
  "message": "Payment initiated successfully",
  "data": {
    "paymentLink": "https://dash.chimoney.io/pay/?issueID=XQTUvRBntIU3AHgQ3jFuN9ZcHIC3_1_1661120543057",
    "valueInUSD": 5,
    "chimoney": 5000,
    "issueID": "dji-29848400404-date",
    "type": "api-payment",
    "issuer": "dji-29848400404",
    "payerEmail": "name@mail.com",
    "initiatedBy": "dji-29848400404",
    "issueDate": "2024/10/23",
    "status": "unpaid",
    "chiRef": "djeoeuk-mdhhmmr-mdnhe-kei8e",
    "error": "None"
  }
}