> ## Documentation Index
> Fetch the complete documentation index at: https://public-openfx.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# AED payout integration guide

> Pay a UAE bank account in AED: register the IBAN, then meet the purpose, funding, memo, and limit rules.

Pay a UAE bank account in UAE dirhams (<span class="ofx-enum">AED</span>).

For the general flow, see [Payout lifecycle](/v3/payouts). The quote, confirm, and webhook steps are the same as for EUR, and so is the fee model. [Supported payout currencies](/v3/payouts#supported-payout-currencies) compares every payout currency side by side.

## Before you start

* Your organization must be enabled for AED. Until it is, a request in it fails with `403` <span class="ofx-enum">PAYOUT\_CURRENCY\_NOT\_ENABLED</span>.
* The recipient's account needs the UAE-dirham receiving capability, <span class="ofx-enum">ACTIVE</span> before you pay. [Capabilities](/v3/capabilities#the-capability-catalog) lists the id, and [Be paid in UAE dirhams](/v3/capabilities#be-paid-in-uae-dirhams) lists the identity the recipient owes.
* AED has no sending capability. Don't send a `sender` on a quote or payout, or it fails with `422` <span class="ofx-enum">SENDER\_NOT\_SUPPORTED</span>.
* Every `POST` needs an `Idempotency-Key` header. See [Idempotency](/v3/idempotency#payments-endpoints).

## Register the bank account and create the payout

A UAE bank account is identified by its IBAN and paid over <span class="ofx-enum">AE\_LOCAL</span>. The recipient owes a name and an address with `line1` and `country`, in any country, and no identity document. See [Be paid in UAE dirhams](/v3/capabilities#be-paid-in-uae-dirhams).

Register the account with `routingFamily` <span class="ofx-enum">AE\_LOCAL</span> and the UAE IBAN as `accountNumber`. The IBAN carries the bank, so you send no BIC, bank code, or account type. No name check runs, so `verifications[]` stays empty. The `accountHolderName` can be at most 75 bytes. [Be paid in UAE dirhams](/v3/capabilities#be-paid-in-uae-dirhams) lists the characters it can use.

```bash cURL theme={"theme":{"light":"poimandres","dark":"poimandres"}}
curl -X POST https://api.openfx.com/v3/payments/payout-addresses \
  -H "Authorization: Bearer $OPENFX_JWT" \
  -H "X-Request-Signature: $OPENFX_SIGNATURE" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{
    "payoutAddressType": "BANK_ACCOUNT",
    "accountId": "acc_BMY3UenpGBn8ZQ8hio4BgE",
    "bankAccount": { "routingFamily": "AE_LOCAL", "accountNumber": "AE070331234567890123456" }
  }'
```

Three rules apply only to AED:

* **Every payout needs a `purpose`.** Send one of <span class="ofx-enum">GOODS\_AND\_SERVICES</span>, <span class="ofx-enum">INVESTMENTS</span>, <span class="ofx-enum">PAYROLL</span>, or <span class="ofx-enum">TREASURY\_MANAGEMENT</span>. <span class="ofx-enum">OTHER</span> is refused. A missing or refused value fails with `400` <span class="ofx-enum">PURPOSE\_INVALID</span>. A quote carries no `purpose`, so send it when you create the payout.
* **You fund it from a stablecoin or AED balance.** The financial account must hold <span class="ofx-enum">USDC</span>, <span class="ofx-enum">USDT</span>, <span class="ofx-enum">EURC</span>, or <span class="ofx-enum">AED</span>. Any other send currency fails with `422` <span class="ofx-enum">QUOTE\_SEND\_CURRENCY\_UNAVAILABLE</span>.
* **Per-payout limits apply.** A `receiveAmount` outside them is refused when the payout is priced, with `422` <span class="ofx-enum">AMOUNT\_OUT\_OF\_RANGE</span>. `error.details` carries the exact bound.

```bash cURL theme={"theme":{"light":"poimandres","dark":"poimandres"}}
curl -X POST https://api.openfx.com/v3/payments/payouts \
  -H "Authorization: Bearer $OPENFX_JWT" \
  -H "X-Request-Signature: $OPENFX_SIGNATURE" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{
    "type": "INLINE",
    "financialAccountId": "finacc_AmKC5dMVXUbiAW8VzKBfqz",
    "receiver": { "payoutAddressId": "pytadd_PbDQ126YUAbkNrNX6XbGL" },
    "receiveAmount": "5000.00",
    "receiveCurrency": "AED",
    "purpose": "GOODS_AND_SERVICES",
    "receiverMemo": "Invoice 4012"
  }'
```

The payout starts in <span class="ofx-enum">REQUIRES\_CONFIRMATION</span>. [Confirm it](/v3/payouts#send-the-payout) as you would any payout.

## Memos

On <span class="ofx-enum">AE\_LOCAL</span>, a `receiverMemo` is at most 100 letters, digits, and spaces. A memo that is too long or holds any other character fails with `400` <span class="ofx-enum">RECEIVER\_MEMO\_INVALID</span>. OpenFX never truncates it.

## Track settlement

On an <span class="ofx-enum">AE\_LOCAL</span> payout, `settlementTraceId.status` reads <span class="ofx-enum">UNSUPPORTED</span>. [Trace a payout with the receiving bank](/v3/payouts#trace-a-payout-with-the-receiving-bank) lists the key for every rail.

## Common mistakes

* **Naming a `sender`.** AED has no sending capability. Remove `sender` from the quote and the payout.
* **Leaving out `purpose`, or sending <span class="ofx-enum">OTHER</span>.** Both fail with `400` <span class="ofx-enum">PURPOSE\_INVALID</span>. Pick the closest of the other four values.
* **Funding the payout from another currency.** Fund it from <span class="ofx-enum">USDC</span>, <span class="ofx-enum">USDT</span>, <span class="ofx-enum">EURC</span>, or <span class="ofx-enum">AED</span>.

## What's next

<CardGroup cols={2}>
  <Card title="Payout lifecycle" icon="https://public-assets.openfx.com/docs/icons/withdrawals.svg" href="/v3/payouts">
    The general payout flow.
  </Card>

  <Card title="Capabilities" icon="https://public-assets.openfx.com/docs/icons/capabilities.svg" href="/v3/capabilities#the-capability-catalog">
    The receiving capability and identity each currency needs.
  </Card>

  <Card title="EUR payout integration guide" icon="https://public-assets.openfx.com/currencies/EUR.svg" href="/v3/eur-payout-integration">
    Paying euro accounts over SEPA or SWIFT.
  </Card>

  <Card title="MXN payout integration guide" icon="https://public-assets.openfx.com/currencies/MXN.svg" href="/v3/mxn-payout-integration">
    Paying Mexican bank accounts over SPEI.
  </Card>

  <Card title="COP payout integration guide" icon="https://public-assets.openfx.com/currencies/COP.svg" href="/v3/cop-payout-integration">
    Paying Colombian bank accounts and Bre-B keys.
  </Card>

  <Card title="Payment Webhooks" icon="https://public-assets.openfx.com/docs/icons/webhooks-setup.svg" href="/v3/webhooks/payments/payouts-webhooks/payout-created">
    Every payout and address event.
  </Card>
</CardGroup>
