---
title: "Initiate Chimoney transaction."
method: POST
path: "/v0.2.4/payouts/initiate-chimoney"
tags: ["Payouts"]
---

# Initiate Chimoney transaction.

`POST /v0.2.4/payouts/initiate-chimoney`

## Request

- Base URL: `https://api.chimoney.io`
- URL: `https://api.chimoney.io/v0.2.4/payouts/initiate-chimoney`
- Auth: API key in header `X-API-KEY`
- TypeScript: <https://skmtc.dev/chimoney/apis/chimoney-api-docs/docs/v0.2.4/payouts/initiate-chimoney/post.ts> (a function with typed inputs; its response is checked against the schema)

## Request body

- object
  - `subAccount` string: Subaccount (Wallet Account) to payout from, if any.
  - `turnOffNotification` boolean: disables email and other notifications from Chimoney.
  - `redirect_url` string: url to redirect to after payment is confirmed
  - `debitCurrency` string: Wallet Currency to debit from.
  - `chimoneys` object[], required: Chimoneys payload.
    - `email` string: Recipient email address.
    - `phone` string: Recipient Phone Number with country code.
    - `valueInUSD` number: Value in USD. Defaults to valueInUSD and ignores amount if both set.
    - `amount` number: Amount in debitCurrency to send. debitCurrency is required if set.
    - `twitter` string: Twitter handle.
    - `redeemData` object
      - `walletID` string: Chimoney Wallet ID to deposit the value to.
      - `interledgerWalletAddress` string: Interledger Wallet Address (Payment Pointer) to settle the Payment in. Must be issued by a Chimoney Interledger pair
      - `account_bank` string: Bank code.
      - `account_number` string: Recipient account number.
      - `currency` string: Local currency to payout to.
      - `branch_code` string: branch_code from /info/bank-branches. Required for all countries except Nigeria
      - `fullname` string: fullname of the receiver of the bank payout
  - `enableXUMMPayment` boolean: Generate a Xumm transaction sign link
  - `enableInterledgerPayment` boolean: Generate an Open Payment payment request to pay with Interledger
  - `cryptoPayment` object[]: Crypto payload.
    - `xrpl` object: XRP object.
      - `address` string: Wallet address.
      - `issuer` string: Issuer.
      - `currency` string: Currency.

## Response `200`

Success.

- object
  - `status` string: Status of the request.
  - `message` string: Message describing the outcome.
  - `data` object
    - `paymentLink` string
    - `error` string
    - `data` object[]
    - `cryptoPayment` object
      - `xrpl` object
      - `eth` object
      - `bsc` object
      - `xummPayment` string
    - `interledgerPayment` 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.
- `500`: Indicates an internal server error.

---

[API](https://skmtc.dev/chimoney/apis/chimoney-api-docs.md) - [All operations](https://skmtc.dev/chimoney/apis/chimoney-api-docs/llms.txt) - [OpenAPI document](https://skmtc.dev/chimoney/apis/chimoney-api-docs/revisions/227751df36a0?raw)