---
title: "Initiate a payment request"
method: POST
path: "/v0.2.4/payment/initiate"
tags: ["Payments"]
---

# Initiate a payment request

`POST /v0.2.4/payment/initiate`

## Request body

- object
  - `valueInUSD` number — Amount in USD to collect.
  - `payerEmail` string, required — Email of the one making the payment.
  - `currency` 'USD' | 'NGN' | 'CAD' — ISO Currency String like CAD, USD, NGN etc.
  - `amount` string — Amount in specified "currency" to collect. Required if currency is set.
  - `redirect_url` string — URL to redirect to after payment is confirmed.
  - `walletID` string — ID of the wallet to settle the payment to (optional)
  - `narration` string — Narration for the payment (optional)
  - `subAccount` string — Subaccount if any.
  - `meta` object — Object containing metadata you want to pass to the request to use later.
  - `turnOffNotification` boolean — Disables email and other notifications from Chimoney.
  - `redeemData` object — Object containing redeem data.
  - `paymentMethod` union — Payment method configuration to direct users to specific payment options
    - object
      - `type` 'card', required
      - `cardRegion` 'Africa' | 'Americas/Canada' | 'Europe' | 'Asia' — Card region (USD: all regions, CAD: all except Africa, NGN: only Africa)
    - object
      - `type` 'wallet', required
    - object — Only available for USD
      - `type` 'interledger', required
      - `interledgerWalletAddress` string — Interledger wallet address (only available for USD)
    - object — Only available for USD
      - `type` 'bank', required
      - `paymentRail` 'ach' | 'swift' | 'clabe'
    - object — Only available for CAD
      - `type` 'interac', required
      - `interacOption` 'send' | 'request'
      - `fullName` string — Full name of the initiator
      - `email` string — Email address of the initiator

## Response `200`

Success.

- object
  - `status` string — Status of the request.
  - `message` string
  - `data` object
    - `paymentLink` string
    - `valueInUSD` number
    - `chimoney` number
    - `issueID` string
    - `type` string
    - `issuer` string
    - `payerEmail` string
    - `initiatedBy` string
    - `issueDate` string
    - `status` string
    - `chiRef` string
    - `error` string
    - `data` object[]
    - `cryptoPayment` object
      - `xrpl` object
      - `eth` object
      - `bsc` object

## Other responses

- `400` — Validation error in the request.
- `401` — Access to this resource is not available for unauthenticated users.
- `403` — Access to this resource is forbidden.
- `404` — Resource not found.
- `500` — Indicates an internal server error.

---

[API](https://skmtc.net/chimoney/apis/chimoney-api-docs.md) · [All operations](https://skmtc.net/chimoney/apis/chimoney-api-docs/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/chimoney/chimoney-api-docs/revisions/227751df36a0/schema)