> ## Documentation Index
> Fetch the complete documentation index at: https://docs.endl.io/llms.txt
> Use this file to discover all available pages before exploring further.

# Update account

> Moves an ONRAMP account to another of the customer's wallets. The account keeps its id and bank details.

Changes the wallet an account settles to. Send the new `walletId` — a custodial wallet, or an external one registered with `type: EXTERNAL` — owned by the same customer. Returns `200` with the account, shaped exactly like Get account.

**Only the destination changes** — the account keeps its `id`, its deposit instructions, its rail and its settlement asset. `fundingInstructions.destination.walletId` names the new wallet.

**The network rules follow Open account** — USD, EUR, GBP, MXN and BRL need an **EVM** wallet, and the change is applied at the provider during the call. AED accepts EVM or TRON, but a USDC-settling AED account cannot move to TRON.

**Naming the wallet (and, for AED, the chain) the account already uses is a no-op** — `200` with the current account, no webhook. A real change emits `account.updated`.

**Wallet delete protection follows the account** — the new wallet becomes protected (`409 ERRWLT_1012` on Delete wallet); the old one can be deleted once no other live account settles to it.

Requires the `accounts` permission.

## Errors

| Status | Code | When |
| - | - | - |
| `400` | `ERRACC_1000` | The `{userId}` path segment is blank or whitespace. **field:** `userId` |
| `400` | `ERRACC_1014` | `walletId` is missing or blank. **field:** `walletId` |
| `400` | `ERRREF_1000` | `{accountId}` is blank, malformed, or not an `acct_…` reference. **field:** `accountId` |
| `400` | `ERRREF_1000` | `walletId` is malformed or not a `wlt_…` reference. **field:** `walletId` |
| `400` | `ERRACC_1015` | The wallet belongs to another customer, or has been deleted. **field:** `walletId` |
| `400` | `ERRACC_1008` | A non-EVM (TRON) wallet for a USD, EUR, GBP, MXN or BRL account. **field:** `walletId` |
| `400` | `ERRACC_1008` | The account settles on a non-EVM rail (`tron`, `solana`, `stellar`) and cannot be moved to an EVM wallet. **field:** `walletId` |
| `400` | `ERRACC_1008` | `chainCode` was sent for a non-AED account. **field:** `chainCode` |
| `400` | `ERRACC_1008` | AED only: `chainCode` is from the other address family (EVM vs TRON) than the wallet. **field:** `chainCode` |
| `400` | `ERRACC_1008` | AED only: the account's settlement currency is not available on the resulting chain — USDC on TRON. **field:** `chainCode`, or `walletId` when no `chainCode` was sent |
| `400` | `ERRACC_1021` | The provider answered and refused the change. The message carries the provider's reason. **Not retryable.** **field:** `walletId` |
| `400` | `ERRCORE_1001` | The version header is missing, malformed, or names a version the server does not support. **field:** `Api-Version` |
| `400` | `ERRCORE_1001` | The raw path contains a doubled slash, an encoded slash, a backslash or a control character. |
| `401` | `ERRCORE_1004` | The `Api-Key` header is missing, does not match an active credential, or its partner is inactive. |
| `403` | `ERRCORE_1005` | The key is valid but lacks the `accounts` permission. |
| `403` | `ERRCORE_1005` | The calling IP is outside the allow-list configured on the key. |
| `404` | `ERRREF_1001` | `{userId}` resolves to nothing, belongs to another partner, or the customer is soft-deleted. **field:** `userId` |
| `404` | `ERRREF_1001` | A well-formed account reference that resolves to no row. **field:** `accountId` |
| `404` | `ERRREF_1001` | A well-formed `wlt_…` reference that resolves to no wallet. **field:** `walletId` |
| `404` | `ERRACC_1001` | No such account belongs to *this* customer. Crypto accounts, which are not exposed on this API, are reported the same way. **field:** `accountId` |
| `405` | `ERRCORE_1001` | Wrong verb on a real path, e.g. `PUT` on Get Account. |
| `409` | `ERRACC_1002` | The account is deactivated. Reactivate it first. **field:** `accountId` |
| `409` | `ERRACC_1019` | The account is closed. **field:** `accountId` |
| `409` | `ERRACC_1003` | The account is `FIAT` (`A FIAT account has no settlement wallet`), or sits with a provider other than the USD/EUR/GBP/MXN/BRL provider or AED. **field:** `accountId` |
| `409` | `ERRACC_1020` | The customer already has a live account with this account's name on the target wallet. **field:** `walletId` |
| `415` | `ERRCORE_1001` | A non-JSON `Content-Type`. |
| `429` | `ERRCORE_1006` | The per-API-key limit was exhausted. Carries `X-RateLimit-Limit` and `X-RateLimit-Remaining`. |
| `500` | `ERRCORE_1000` | An unexpected server error. Quote the `X-Request-ID` when reporting it. |
| `503` | `ERRACC_1012` | The provider is down or timed out, and the change did not apply. **Safe to retry.** |

Plus the shared errors — see [Accounts errors](https://docs.endl.io/api-reference/accounts/errors.md).

```bash cURL — USD (EVM wallet) theme={null}
curl --request PATCH \
  --url https://api-sandbox.endl.io/api/v0/accounts/cus_9FpQ2LmZ8sW4TxKn1BvD/acct_7Kq2XbN4mR8vLp1DcYtZ \
  --header 'API-KEY: <api-key>' \
  --header 'Api-Version: 2026-09.1' \
  --header 'Content-Type: application/json' \
  --data '{ "walletId": "wlt_6PwK3sLx9NdT2RbQ8vHe" }'
```

```bash cURL — AED to a TRON wallet theme={null}
curl --request PATCH \
  --url https://api-sandbox.endl.io/api/v0/accounts/cus_9FpQ2LmZ8sW4TxKn1BvD/acct_2RtM8wQc5ZpL1XvNa4Kd \
  --header 'API-KEY: <api-key>' \
  --header 'Api-Version: 2026-09.1' \
  --header 'Content-Type: application/json' \
  --data '{ "walletId": "wlt_8TxJ4nVb2MqR7LcWp5Zs", "chainCode": "tron" }'
```

```json 200 — USD theme={null}
{
  "id": "acct_7Kq2XbN4mR8vLp1DcYtZ",
  "name": "USD Account",
  "displayName": "Operating USD",
  "status": "ACTIVE",
  "category": "ONRAMP",
  "currency": "USD",
  "balance": { "amount": "12450.00", "currency": "USD" },
  "createdAt": "2026-09-02T11:41:07Z",
  "updatedAt": "2026-10-30T09:14:02Z",
  "fundingInstructions": {
    "source": {
      "currency": "USD",
      "beneficiaryName": "Example Finance Ltd",
      "payoutRails": [
        {
          "payoutRail": "ach_push",
          "accountNumber": "213774930314",
          "routingNumber": "123456789",
          "bank": {
            "name": "Example Bank N.A.",
            "address": "100 Example Street, Springfield, MO 65801"
          },
          "depositFee": { "percentage": "0.5" }
        },
        {
          "payoutRail": "wire",
          "accountNumber": "213774930314",
          "routingNumber": "123456789",
          "bank": {
            "name": "Example Bank N.A.",
            "address": "100 Example Street, Springfield, MO 65801"
          },
          "depositFee": { "percentage": "0.5", "amount": "10.00", "currency": "USD" }
        }
      ]
    },
    "destination": { "asset": "USDC", "chain": "base", "walletId": "wlt_6PwK3sLx9NdT2RbQ8vHe" }
  }
}
```

```json 200 — AED to TRON theme={null}
{
  "id": "acct_2RtM8wQc5ZpL1XvNa4Kd",
  "name": "AED Account",
  "displayName": "Operating AED",
  "status": "ACTIVE",
  "category": "ONRAMP",
  "currency": "AED",
  "balance": { "amount": "0.00", "currency": "AED" },
  "createdAt": "2026-09-12T08:03:51Z",
  "updatedAt": "2026-10-30T09:20:47Z",
  "fundingInstructions": {
    "source": {
      "currency": "AED",
      "beneficiaryName": "Acme Trading LLC",
      "payoutRails": [
        {
          "payoutRail": "uaefts",
          "iban": "AE070331234567890123456",
          "bic": "EXMPAEAAXXX",
          "bank": { "name": "Example Bank PJSC" },
          "depositFee": { "percentage": "0.1" }
        },
        {
          "payoutRail": "uaeipp",
          "iban": "AE070331234567890123456",
          "bic": "EXMPAEAAXXX",
          "bank": { "name": "Example Bank PJSC" },
          "depositFee": { "percentage": "0.1" }
        }
      ]
    },
    "destination": { "asset": "USDT", "chain": "tron", "walletId": "wlt_8TxJ4nVb2MqR7LcWp5Zs" }
  }
}
```

```json 400 theme={null}
{
  "code": 400,
  "message": "This account type requires an EVM wallet",
  "status": "ERROR",
  "data": null,
  "errors": [
    {
      "code": "ERRACC_1008",
      "message": "This account type requires an EVM wallet",
      "field": "walletId"
    }
  ]
}
```

```json 400 — provider refused theme={null}
{
  "code": 400,
  "message": "The account provider refused this update",
  "status": "ERROR",
  "data": null,
  "errors": [
    {
      "code": "ERRACC_1021",
      "message": "The account provider refused this update",
      "field": "walletId"
    }
  ]
}
```

```json 401 theme={null}
{
  "code": 401,
  "message": "Partner API key required",
  "status": "ERROR",
  "data": null,
  "errors": [
    {
      "code": "ERRCORE_1004",
      "message": "Partner API key required",
      "field": null
    }
  ]
}
```

```json 403 theme={null}
{
  "code": 403,
  "message": "Insufficient permissions",
  "status": "ERROR",
  "data": null,
  "errors": [
    {
      "code": "ERRCORE_1005",
      "message": "Insufficient permissions",
      "field": null
    }
  ]
}
```

```json 404 theme={null}
{
  "code": 404,
  "message": "Account not found",
  "status": "ERROR",
  "data": null,
  "errors": [
    {
      "code": "ERRACC_1001",
      "message": "Account not found",
      "field": "accountId"
    }
  ]
}
```

```json 409 theme={null}
{
  "code": 409,
  "message": "A FIAT account has no settlement wallet",
  "status": "ERROR",
  "data": null,
  "errors": [
    {
      "code": "ERRACC_1003",
      "message": "A FIAT account has no settlement wallet",
      "field": "accountId"
    }
  ]
}
```

```json 429 theme={null}
{
  "code": 429,
  "message": "Rate limit exceeded, please retry later",
  "status": "ERROR",
  "data": null,
  "errors": [
    {
      "code": "ERRCORE_1006",
      "message": "Rate limit exceeded, please retry later",
      "field": null
    }
  ]
}
```

```json 500 theme={null}
{
  "code": 500,
  "message": "An error occurred while processing your request",
  "status": "ERROR",
  "data": null,
  "errors": [
    {
      "code": "ERRCORE_1000",
      "message": "An error occurred while processing your request",
      "field": null
    }
  ]
}
```

```json 503 theme={null}
{
  "code": 503,
  "message": "The account provider is temporarily unavailable. Please try again later",
  "status": "ERROR",
  "data": null,
  "errors": [
    {
      "code": "ERRACC_1012",
      "message": "The account provider is temporarily unavailable. Please try again later",
      "field": null
    }
  ]
}
```


## OpenAPI

````yaml api-reference/endl-partner-api.json PATCH /api/v0/accounts/{userId}/{accountId}
openapi: 3.1.0
info:
  title: Endl Partner API
  version: '0'
  description: >-
    REST API for Endl partners: wallets, quotes, recipients, accounts and
    transactions.


    All endpoints are authenticated with an `API-KEY` header, are scoped to the
    partner that owns the credential, and return the standard response envelope.
servers:
  - url: https://api-sandbox.endl.io
    description: Sandbox
security:
  - apiKey: []
tags:
  - name: Wallets
    description: Create and manage user wallets.
  - name: Quotes
    description: Price a transfer before submitting it.
  - name: Recipients
    description: Manage the parties a user pays out to.
  - name: Accounts
    description: Open and inspect user accounts.
  - name: Transactions
    description: Fund, submit, and track transfers.
  - name: Reference
    description: 'Static catalogues: currencies, countries, rates, rails, codes.'
paths:
  /api/v0/accounts/{userId}/{accountId}:
    patch:
      tags:
        - Accounts
      summary: Update account
      description: >-
        Moves an ONRAMP account to another of the customer's wallets. The
        account keeps its id and bank details.


        Changes the wallet an account settles to. Send the new `walletId` — a
        custodial wallet, or an external one registered with `type: EXTERNAL` —
        owned by the same customer. Returns `200` with the account, shaped
        exactly like Get account.


        **Only the destination changes** — the account keeps its `id`, its
        deposit instructions, its rail and its settlement asset.
        `fundingInstructions.destination.walletId` names the new wallet.


        **The network rules follow Open account** — USD, EUR, GBP, MXN and BRL
        need an **EVM** wallet, and the change is applied at the provider during
        the call. AED accepts EVM or TRON, but a USDC-settling AED account
        cannot move to TRON.


        **Naming the wallet (and, for AED, the chain) the account already uses
        is a no-op** — `200` with the current account, no webhook. A real change
        emits `account.updated`.


        **Wallet delete protection follows the account** — the new wallet
        becomes protected (`409 ERRWLT_1012` on Delete wallet); the old one can
        be deleted once no other live account settles to it.


        Requires the `accounts` permission.
      parameters:
        - $ref: '#/components/parameters/ApiVersion'
        - name: userId
          in: path
          required: true
          description: >-
            The customer the account belongs to. Must be a `cus_…` reference id,
            and must belong to your partner account. Blank → `400 ERRACC_1000`;
            unknown, soft-deleted or another partner's customer → `404
            ERRREF_1001`.
          schema:
            type: string
            example: cus_9HqA2mT7xK4vRb1NdLpZ
        - name: accountId
          in: path
          required: true
          description: >-
            The account to act on. Must be an `acct_…` reference id. Malformed →
            `400 ERRREF_1000`; well-formed but unknown → `404 ERRREF_1001`.
          schema:
            type: string
            example: acct_7Kq2XbN4mR8vLp1DcYtZ
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                walletId:
                  type: string
                  example: wlt_6PwK3sLx9NdT2RbQ8vHe
                  description: >-
                    The wallet the account should settle to from now on. A
                    `wlt_…` reference of a custodial wallet or a registered
                    `EXTERNAL` wallet owned by the same customer. Missing → `400
                    ERRACC_1014`; not found, another customer's, or deleted →
                    `400 ERRACC_1015`. Every currency except AED requires an EVM
                    wallet (`400 ERRACC_1008`).
                chainCode:
                  type: string
                  example: tron
                  description: >-
                    **AED only.** The chain the stablecoin is sent on. Must be
                    the same address family as the wallet (TRON vs EVM). When
                    omitted, a TRON wallet uses its own chain; an EVM wallet
                    keeps the account's current EVM chain, or `ethereum` if it
                    had none or was on TRON. On any other currency → `400
                    ERRACC_1008` on field `chainCode`.
              required:
                - walletId
            examples:
              USD:
                summary: USD — move to another EVM wallet
                value:
                  walletId: wlt_6PwK3sLx9NdT2RbQ8vHe
              AED to TRON:
                summary: AED — move to a TRON wallet
                value:
                  walletId: wlt_8TxJ4nVb2MqR7LcWp5Zs
                  chainCode: tron
      responses:
        '200':
          description: >-
            The account after the change — the same object as Get account, with
            `fundingInstructions`. Also returned, unchanged, for a no-op.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PartnerAccount'
              examples:
                AED to TRON:
                  summary: AED moved to a TRON wallet
                  value:
                    id: acct_2RtM8wQc5ZpL1XvNa4Kd
                    name: AED Account
                    displayName: Operating AED
                    status: ACTIVE
                    category: ONRAMP
                    currency: AED
                    balance:
                      amount: '0.00'
                      currency: AED
                    createdAt: '2026-09-12T08:03:51Z'
                    updatedAt: '2026-10-30T09:20:47Z'
                    fundingInstructions:
                      source:
                        currency: AED
                        beneficiaryName: Acme Trading LLC
                        payoutRails:
                          - payoutRail: uaefts
                            iban: AE070331234567890123456
                            bic: EXMPAEAAXXX
                            bank:
                              name: Example Bank PJSC
                            depositFee:
                              percentage: '0.1'
                      destination:
                        asset: USDT
                        chain: tron
                        walletId: wlt_8TxJ4nVb2MqR7LcWp5Zs
        '400':
          description: >-
            `ERRACC_1000` — The `{userId}` path segment is blank or whitespace.


            `ERRACC_1014` — `walletId` is missing or blank.


            `ERRREF_1000` — `{accountId}` is blank, malformed, or not an
            `acct_…` reference.


            `ERRACC_1015` — The wallet is not found, belongs to another
            customer, or has been deleted.


            `ERRACC_1008` — The network does not fit: a non-EVM wallet on a
            USD/EUR/GBP/MXN/BRL account, an account on a non-EVM rail moving to
            an EVM wallet, `chainCode` on a non-AED account, a `chainCode` from
            the other address family than the wallet, or a settlement currency
            not available on the resulting chain.


            `ERRACC_1021` — The provider answered and refused the change. Not
            retryable.


            `ERRCORE_1001` — The version header is missing, malformed, or names
            a version the server does not support.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              example:
                code: 400
                message: This account type requires an EVM wallet
                status: ERROR
                data: null
                errors:
                  - code: ERRACC_1008
                    message: This account type requires an EVM wallet
                    field: walletId
        '401':
          description: >-
            `ERRCORE_1004` — The `Api-Key` header is missing, does not match an
            active credential, or its partner is inactive.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              example:
                code: 401
                message: Partner API key required
                status: ERROR
                data: null
                errors:
                  - code: ERRCORE_1004
                    message: Partner API key required
                    field: null
        '403':
          description: >-
            `ERRCORE_1005` — The key lacks the `accounts` permission, or the
            calling IP is outside the key's allow-list.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              example:
                code: 403
                message: Insufficient permissions
                status: ERROR
                data: null
                errors:
                  - code: ERRCORE_1005
                    message: Insufficient permissions
                    field: null
        '404':
          description: >-
            `ERRREF_1001` — `{userId}` or `{accountId}` resolves to nothing.


            `ERRACC_1001` — No such account belongs to this customer. Crypto
            accounts, which are not exposed on this API, are reported the same
            way.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              example:
                code: 404
                message: Account not found
                status: ERROR
                data: null
                errors:
                  - code: ERRACC_1001
                    message: Account not found
                    field: accountId
        '409':
          description: >-
            `ERRACC_1002` — The account is deactivated.


            `ERRACC_1019` — The account is closed.


            `ERRACC_1003` — The account is `FIAT`, or its provider does not
            support changing the wallet.


            `ERRACC_1020` — The customer already has a live account with this
            account's name on the target wallet.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              example:
                code: 409
                message: A FIAT account has no settlement wallet
                status: ERROR
                data: null
                errors:
                  - code: ERRACC_1003
                    message: A FIAT account has no settlement wallet
                    field: accountId
        '429':
          description: >-
            `ERRCORE_1006` — The per-API-key limit was exhausted. Carries
            `X-RateLimit-Limit` and `X-RateLimit-Remaining`. Safe to retry.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              example:
                code: 429
                message: Rate limit exceeded, please retry later
                status: ERROR
                data: null
                errors:
                  - code: ERRCORE_1006
                    message: Rate limit exceeded, please retry later
                    field: null
        '500':
          description: >-
            `ERRCORE_1000` — An unexpected server error. Quote the
            `X-Request-ID` when reporting it.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              example:
                code: 500
                message: An error occurred while processing your request
                status: ERROR
                data: null
                errors:
                  - code: ERRCORE_1000
                    message: An error occurred while processing your request
                    field: null
        '503':
          description: >-
            `ERRACC_1012` — The provider is down or timed out and the change did
            not apply. Safe to retry.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              example:
                code: 503
                message: >-
                  The account provider is temporarily unavailable. Please try
                  again later
                status: ERROR
                data: null
                errors:
                  - code: ERRACC_1012
                    message: >-
                      The account provider is temporarily unavailable. Please
                      try again later
                    field: null
components:
  parameters:
    ApiVersion:
      name: Api-Version
      in: header
      required: true
      description: >-
        The API version this request targets. Required on every `/api/v0/*`
        call. Format `YYYY-MM.<release>`; `2026-09.1` is the latest. The version
        that served the request is echoed back on the response. Missing,
        malformed or unsupported values are rejected with `400`.
      schema:
        type: string
        pattern: ^\d{4}-\d{2}\.\d+$
        default: 2026-09.1
      example: 2026-09.1
  schemas:
    PartnerAccount:
      type: object
      properties:
        id:
          type: string
          description: >-
            The account's reference id. Always `acct_…`. Absent on the
            async-PENDING branch of Open Account and on static-template rows.
        name:
          type: string
          description: The account's name at the provider, as supplied in `accountName`.
        displayName:
          type:
            - string
            - 'null'
          description: >-
            Your own customer-facing nickname for the account. The one key
            guaranteed present even when null. Set at creation; cannot be
            changed through this API.
        status:
          type: string
          enum:
            - ACTIVE
            - PENDING
            - DEACTIVATED
            - CLOSED
            - FROZEN
            - UNDER_REVIEW
            - DORMANT
          description: >-
            The account's current state. One of `ACTIVE`, `PENDING`,
            `DEACTIVATED`, `CLOSED`, `FROZEN`, `UNDER_REVIEW`, `DORMANT`.
        category:
          type: string
          enum:
            - FIAT
            - ONRAMP
          description: >-
            What the account does with money that lands in it. `FIAT` holds what
            it receives · `ONRAMP` converts it onward. Derived server-side, not
            echoed back from your request — always read it off the response.
        currency:
          type: string
          description: >-
            The account's own denomination, upper-cased. Deliberately outside
            `balance` so it survives a balance that failed to load.
        balance:
          allOf:
            - $ref: '#/components/schemas/Money'
          description: >-
            The available (spendable) balance. Omitted entirely when the
            underlying amount is null.
        createdAt:
          type: string
          format: date-time
          description: When the account was created.
        updatedAt:
          type: string
          format: date-time
          description: When the account last changed.
        fundingInstructions:
          allOf:
            - $ref: '#/components/schemas/FundingInstructions'
          description: >-
            How to fund this account — bank coordinates and, for ONRAMP, what it
            settles into. Reliable on **Get Account**. On **Open Account** it is
            requested but only materialises if the provider has already returned
            deposit coordinates — see that endpoint's caveat. **Never** present
            on List.
      required:
        - displayName
    ErrorResponse:
      type: object
      properties:
        code:
          type: integer
          example: 400
          description: The HTTP status, repeated in the body.
        message:
          type: string
          example: Validation failed
          description: A human-readable summary of the failure.
        status:
          type: string
          example: ERROR
          description: '`ERROR` on failure; `SUCCESS` on the equivalent success envelope.'
        data:
          type:
            - object
            - 'null'
          example: null
          description: '`null` on failure — no payload is returned when a request fails.'
        errors:
          type: array
          items:
            $ref: '#/components/schemas/FieldError'
          description: >-
            One entry per field that failed validation. Empty for failures that
            are not field-level.
    Money:
      type: object
      properties:
        amount:
          type: string
          description: Decimal amount as a plain string. Never a JSON number.
        currency:
          type: string
          description: ISO currency or asset code, upper-cased.
      required:
        - amount
        - currency
    FundingInstructions:
      type: object
      properties:
        source:
          allOf:
            - $ref: '#/components/schemas/FundingSource'
          description: >-
            Where money comes in — the coordinates you give the payer. Bank
            coordinates. Identical in shape for FIAT and ONRAMP accounts.
        destination:
          allOf:
            - $ref: '#/components/schemas/FundingDestination'
          description: >-
            What the deposit settles into. **Only present when `category` is
            `ONRAMP`.** A FIAT account holds what it receives, so it has no
            destination.
        depositFeeNote:
          type: string
          description: >-
            Free-text deposit-fee copy to display to the customer. **AED FIAT
            accounts only**, and only on Get Account. Display it verbatim — do
            not parse it as a number.
    FieldError:
      type: object
      properties:
        code:
          type: string
          example: ERRACC_1009
          description: >-
            Stable machine-readable error code, `ERR<MODULE>_<nnnn>`. Match on
            this, never on `message`. See the [error
            catalogue](/api-reference/error-codes).
        message:
          type: string
          example: must not be blank
          description: What is wrong with this specific field.
        field:
          type: string
          example: sourceAmount
          description: >-
            Which request field the problem refers to, or `null` when the error
            is not about a specific input.
    FundingSource:
      type: object
      properties:
        currency:
          type: string
          description: The currency the payer must send, upper-cased.
        beneficiaryName:
          type: string
          description: >-
            The name the payer pays. For USD, MXN and BRL this is the provider's
            own legal entity, **not your customer**. For EUR and GBP it is the
            real customer name. Always display the value you are given.
        paymentReference:
          type: string
          description: >-
            The reference the payer must quote so the deposit is attributed.
            **Not currently populated.** Treat it as absent and do not build
            deposit attribution on it.
        payoutRails:
          type: array
          items:
            $ref: '#/components/schemas/PayoutRail'
          description: >-
            Every rail this account can be funded over. The whole `source` is
            omitted when the rail list is empty.
      required:
        - currency
        - beneficiaryName
        - payoutRails
    FundingDestination:
      type: object
      properties:
        asset:
          type: string
          description: >-
            The asset the deposit settles into, upper-cased. Taken from the
            wallet named in `walletId`.
        chain:
          type: string
          description: The settlement network. Taken from the same wallet.
        walletId:
          type: string
          example: wlt_3HdR9zNc6QeW2XmT5bLa
          description: >-
            The `wlt_…` reference of the wallet the account settles to — the one
            named at open, or the one it was last moved to with Update account.
            A reference id only, never an address. Omitted if the wallet has no
            reference id.
      description: >-
        `asset`, `chain` and `walletId` always mirror the wallet the account
        currently settles to — the `walletId` passed when it was opened, or the
        one set later with Update account. **No address is exposed here** — the
        settlement address belongs to that wallet, so read it from the wallet
        rather than from the account, and never present it to a payer.
    PayoutRail:
      type: object
      properties:
        payoutRail:
          type: string
          description: >-
            Rail identifier, e.g. `ach_push`, `wire`, `sepa`, `faster_payments`,
            `spei`, `pix`, `uaefts`, `uaeipp`. A provider-supplied free string,
            not a fixed enum. Match it case-insensitively and tolerate unknown
            values.
        accountNumber:
          type: string
          description: Bank account number for this rail.
        sortCode:
          type: string
          description: UK sort code.
        iban:
          type: string
          description: IBAN.
        bic:
          type: string
          description: SWIFT / BIC code.
        routingNumber:
          type: string
          description: US routing number (ABA).
        clabe:
          type: string
          description: Mexican CLABE.
        brCode:
          type: string
          description: Brazilian PIX BR Code payload.
        bank:
          allOf:
            - $ref: '#/components/schemas/BankDetails'
          description: >-
            The institution for *this* rail. Per-rail rather than hoisted to the
            account, so a correspondent bank can differ from the domestic one.
        depositFee:
          allOf:
            - $ref: '#/components/schemas/DepositFee'
          description: >-
            What it costs to deposit over this rail. Get Account only, and never
            together with `depositFeeNote`.
    BankDetails:
      type: object
      properties:
        name:
          type: string
          description: Institution name.
        address:
          type: string
          description: >-
            Institution address as a single unstructured line. Not returned for
            AED. Present for the other currencies.
        addressDetails:
          type: object
          properties:
            line1:
              type: string
            line2:
              type: string
            city:
              type: string
            state:
              type: string
            postalCode:
              type: string
            country:
              type: string
          description: >-
            Structured institution address (`line1`, `line2`, `city`, `state`,
            `postalCode`, `country`). **Not currently populated.** Read
            `address` instead.
    DepositFee:
      type: object
      properties:
        percentage:
          type: string
          description: >-
            Percentage rate — `"0.5"` means 0.5%. Trailing zeros are stripped,
            deliberately unlike `amount`.
        amount:
          type: string
          description: >-
            Flat charge, denominated in `currency`. Not stripped, so it reads
            like money (`"10.00"`).
        currency:
          type: string
          description: Currency of `amount`, upper-cased.
  securitySchemes:
    apiKey:
      type: apiKey
      in: header
      name: API-KEY
      description: Your partner API key.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.