---
title: "Payout to a Interledger Wallet Address."
method: POST
path: "/v0.2.4/payouts/interledger-wallet-address"
tags: ["Payouts", "Interledger"]
---

# Payout to a Interledger Wallet Address.

`POST /v0.2.4/payouts/interledger-wallet-address`

## Request

- Base URL: `https://api.chimoney.io`
- URL: `https://api.chimoney.io/v0.2.4/payouts/interledger-wallet-address`
- Auth: API key in header `X-API-KEY`
- TypeScript: <https://skmtc.dev/chimoney/apis/chimoney-api-docs/docs/v0.2.4/payouts/interledger-wallet-address/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.
  - `debitCurrency` string: Wallet Currency to debit from to settle the amountToDeliver values.
  - `interledgerWallets` object[], required: Interledger Wallet Address payload.
    - `interledgerWalletAddress` string, required: Interledger Wallet Address (Payment Pointer) to settle the Payment in. Must be issued by a Chimoney Interledger pair
    - `currency` string: Currency/ILP Asset ID to deliver to the user.
    - `amountToDeliver` number: Amount to deliver to the user.
    - `amount` number: DEPRECATED. Value in 'currency' to send.
    - `valueInUSD` number: DEPRECATED. Value in USD to send.
    - `narration` string: Narration/Description of payment to be included notification to user
    - `collectionPaymentIssueID` string: issue ID for the payment payout initiated.

## Response `200`

Success.

- object
  - `status` string: Status of the request.
  - `message` string: Message of the request.
  - `data` object
    - `paymentLink` string
    - `data` object[]
    - `chimoneys` object[]
    - `error` string
    - `payouts` object
      - `additionalProperties` object
      - `issueID` string

## 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)