# List the deposit fiat routes of an account with their readiness

Source: https://business-api-docs.youhodler.com/api/reference/funding-endpoints/funding-routes-readiness

**Authentication:** Send `Authorization: Bearer <access_token>`.

Returns active deposit fiat route candidates from the asset catalog, including routes blocked by commercial eligibility, feature flags or runtime readiness. No crypto route is returned. `attribution_mode` names the setup call a route takes: `virtual_account` through `POST /funding-endpoints`, `payment_reference` through `POST /deposit-instructions`, null when the route has no configured mode. A null mode can also mean no commercial route owner could be resolved. Routes are sorted by rail then currency; the complete list has no external pagination. Requires a bound enterprise/client operating scope: missing or platform bindings return 403, and an account outside the bound scope is hidden with 404. An unavailable route carries the reasons it is blocked, the same ones setup refuses it with; `fiat_international_verification_required` means the account holder must complete the international verification first; `fiat_party_not_supported` means the provider of the route does not serve this kind of account holder, so the route stays closed for this account.

## Parameters

| Name | Location | Type | Required | Description and constraints |
| --- | --- | --- | --- | --- |
| `account_ref` | query | string | Yes | pattern: `^(master-accounts\|client-accounts)\/([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$` |

## Request

**Request URL — GET**
```http
GET /funding-routes/readiness
```

## Responses

**200 Operation succeeded**

Operation succeeded.

```json
{
  "account_ref": "client-accounts/b8e2f1a0-4c3d-4e5f-9a1b-2c3d4e5f6a7b",
  "routes": [
    {
      "attribution_mode": "virtual_account",
      "availability": "unavailable",
      "currency": "USD",
      "method": "fedwire",
      "rail": "fedwire",
      "rail_class": "fiat",
      "reasons": [
        {
          "code": "fiat_international_verification_required",
          "source": "runtime"
        }
      ]
    },
    {
      "attribution_mode": "virtual_account",
      "availability": "available",
      "currency": "ARS",
      "method": "local_bank_transfer",
      "rail": "local_bank_transfer",
      "rail_class": "fiat",
      "reasons": []
    }
  ]
}
```

**400 Invalid request payload**

Invalid request payload, query, or parameter shape.

**401 Caller is not authenticated or the bearer token is invalid**

Caller is not authenticated or the bearer token is invalid.

**403 Caller lacks the required capability or permitted scope**

Caller lacks the required capability or permitted scope.

**404 Resource not found**

Resource not found.

**500 An unexpected internal failure occurred**

An unexpected internal failure occurred. The public error code is temporarily_unavailable; internal details are not exposed.

**502 Upstream service returned an unexpected error**

Upstream service returned an unexpected error.

**503 Service is temporarily unavailable**

Service is temporarily unavailable; retry with backoff.
### Response 200 schema

Content type: `application/json`.

#### application/json body

| Field | Type | Required | Description and constraints |
| --- | --- | --- | --- |
| `account_ref` | string | Yes | pattern: `^(master-accounts\|client-accounts)\/([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$` |
| `routes` | object[] | Yes |  |

Additional fields are not accepted.

##### application/json body.routes

Type: `object[]`. 

###### application/json body.routes item

| Field | Type | Required | Description and constraints |
| --- | --- | --- | --- |
| `attribution_mode` | "virtual_account" / "payment_reference" or null | Yes |  |
| `availability` | "available" / "unavailable" | Yes |  |
| `currency` | string | Yes | Currency code (ISO-4217 or on-chain ticker) pattern: `^[A-Z0-9]{1,16}$` |
| `method` | string | Yes | pattern: `^[a-z0-9_]+$` |
| `rail` | "sepa_credit_transfer" / "faster_payments" / "swift" / "local_bank_transfer" / "fedwire" | Yes |  |
| `rail_class` | "fiat" | Yes |  |
| `reasons` | object or object or object or object[] | Yes |  |

Additional fields are not accepted.

###### application/json body.routes item.attribution_mode

At least one alternative must match.

###### application/json body.routes item.attribution_mode: alternative 1

Type: `"virtual_account" / "payment_reference"`. 

###### application/json body.routes item.attribution_mode: alternative 2

Type: `null`. 

###### application/json body.routes item.reasons

Type: `object or object or object or object[]`. 

###### application/json body.routes item.reasons item

Exactly one alternative must match.

###### application/json body.routes item.reasons item: alternative 1

| Field | Type | Required | Description and constraints |
| --- | --- | --- | --- |
| `code` | "asset_rail_direction_unsupported" | Yes |  |
| `source` | "technical" | Yes |  |

Additional fields are not accepted.

###### application/json body.routes item.reasons item: alternative 2

| Field | Type | Required | Description and constraints |
| --- | --- | --- | --- |
| `code` | "service_family_ineligible" | Yes |  |
| `source` | "commercial" | Yes |  |

Additional fields are not accepted.

###### application/json body.routes item.reasons item: alternative 3

| Field | Type | Required | Description and constraints |
| --- | --- | --- | --- |
| `code` | "crypto_route_unavailable" / "crypto_provider_projection_missing" / "crypto_provider_disabled" / "crypto_provider_capability_unavailable" / "crypto_provider_adapter_unavailable" / "fiat_operation_not_implemented" / "fiat_provider_unavailable" / "fiat_catalog_unsupported" / "fiat_provider_disabled" / "fiat_pooled_endpoint_missing" / "fiat_pooled_endpoint_inactive" / "fiat_unsupported_mode" / "fiat_unsupported_currency" / "fiat_unsupported_rail_method" / "fiat_inbound_forwarding_disabled" / "fiat_international_verification_required" / "fiat_party_not_supported" | Yes |  |
| `source` | "runtime" | Yes |  |

Additional fields are not accepted.

###### application/json body.routes item.reasons item: alternative 4

| Field | Type | Required | Description and constraints |
| --- | --- | --- | --- |
| `code` | "service_family_disabled" | Yes |  |
| `source` | "feature_flag" | Yes |  |

Additional fields are not accepted.

### Response 400 schema

Content type: `application/json`.

#### application/json body

| Field | Type | Required | Description and constraints |
| --- | --- | --- | --- |
| `code` | string | Yes |  |
| `data` | object | No | No additional fields |
| `details` | object | No | Additional fields allowed |
| `message` | string | Yes |  |

Additional fields are not accepted.

##### application/json body.data

| Field | Type | Required | Description and constraints |
| --- | --- | --- | --- |
| `acr_values` | string | No | RFC 9470 step-up challenge (`insufficient_user_authentication`). |
| `blockers` | object[] | No | For `closure_preconditions_not_met` on a terminal lifecycle verb: what must be resolved before the transition. |
| `code` | string | No | For legal refusals: the document code the refusal is about. |
| `max_age` | string | No | RFC 9470 step-up challenge (`insufficient_user_authentication`). |
| `max_source_amount` | object | No | For `amount_below_minimum` / `amount_above_maximum`: the product maximum in source asset units; null means no maximum. No additional fields |
| `min_source_amount` | object | No | For `amount_below_minimum` / `amount_above_maximum`: the effective minimum in source asset units, fees included. No additional fields |
| `published_version` | string | No | For `document_version_superseded`: the version currently published. |
| `reason` | string | No | Typed refinement of `code`, from the failing service's contract. |
| `resource` | string | No | Resource kind a `resource_not_found` refers to. |
| `retry_after_ms` | integer | No | Suggested back-off in milliseconds for throttling or temporary unavailability; null means no delay is known. minimum: 0 |
| `source` | string | No | For `not_admissible`: the gate that denied (verification, lifecycle, policy, compliance). |

Additional fields are not accepted.

###### application/json body.data.blockers

For `closure_preconditions_not_met` on a terminal lifecycle verb: what must be resolved before the transition.

Type: `object[]`. 

###### application/json body.data.blockers item

| Field | Type | Required | Description and constraints |
| --- | --- | --- | --- |
| `description` | string | Yes |  |
| `type` | "non_zero_balance" / "active_sub_resources" / "pending_operations" / "active_users" / "active_service_accounts" / "active_role_assignments" | Yes |  |
| `assets` | object[] | No | minItems: 1 |
| `count` | integer | No | minimum: 0; maximum: 9007199254740991 |

Additional fields are not accepted.

###### application/json body.data.blockers item.assets

Type: `object[]`. minItems: 1

###### application/json body.data.blockers item.assets item

| Field | Type | Required | Description and constraints |
| --- | --- | --- | --- |
| `asset` | string | Yes | Currency code (ISO-4217 or on-chain ticker) pattern: `^[A-Z0-9]{1,16}$` |
| `kind` | "balance" / "held" / "owed" / "unsettled" | Yes |  |

Additional fields are not accepted.

###### application/json body.data.max_source_amount

For `amount_below_minimum` / `amount_above_maximum`: the product maximum in source asset units; null means no maximum.

| Field | Type | Required | Description and constraints |
| --- | --- | --- | --- |
| `currency` | string | Yes |  |
| `value` | string | Yes |  |

Additional fields are not accepted.

###### application/json body.data.min_source_amount

For `amount_below_minimum` / `amount_above_maximum`: the effective minimum in source asset units, fees included.

| Field | Type | Required | Description and constraints |
| --- | --- | --- | --- |
| `currency` | string | Yes |  |
| `value` | string | Yes |  |

Additional fields are not accepted.

### Response 401 schema

Content type: `application/json`.

#### application/json body

| Field | Type | Required | Description and constraints |
| --- | --- | --- | --- |
| `code` | string | Yes |  |
| `data` | object | No | No additional fields |
| `details` | object | No | Additional fields allowed |
| `message` | string | Yes |  |

Additional fields are not accepted.

##### application/json body.data

| Field | Type | Required | Description and constraints |
| --- | --- | --- | --- |
| `acr_values` | string | No | RFC 9470 step-up challenge (`insufficient_user_authentication`). |
| `blockers` | object[] | No | For `closure_preconditions_not_met` on a terminal lifecycle verb: what must be resolved before the transition. |
| `code` | string | No | For legal refusals: the document code the refusal is about. |
| `max_age` | string | No | RFC 9470 step-up challenge (`insufficient_user_authentication`). |
| `max_source_amount` | object or null | No | For `amount_below_minimum` / `amount_above_maximum`: the product maximum in source asset units; null means no maximum. No additional fields |
| `min_source_amount` | object | No | For `amount_below_minimum` / `amount_above_maximum`: the effective minimum in source asset units, fees included. No additional fields |
| `published_version` | string | No | For `document_version_superseded`: the version currently published. |
| `reason` | string | No | Typed refinement of `code`, from the failing service's contract. |
| `resource` | string | No | Resource kind a `resource_not_found` refers to. |
| `retry_after_ms` | integer or null | No | Suggested back-off in milliseconds for throttling or temporary unavailability; null means no delay is known. minimum: 0 |
| `source` | string | No | For `not_admissible`: the gate that denied (verification, lifecycle, policy, compliance). |

Additional fields are not accepted.

###### application/json body.data.blockers

For `closure_preconditions_not_met` on a terminal lifecycle verb: what must be resolved before the transition.

Type: `object[]`. 

###### application/json body.data.blockers item

| Field | Type | Required | Description and constraints |
| --- | --- | --- | --- |
| `description` | string | Yes |  |
| `type` | "non_zero_balance" / "active_sub_resources" / "pending_operations" / "active_users" / "active_service_accounts" / "active_role_assignments" | Yes |  |
| `assets` | object[] | No | minItems: 1 |
| `count` | integer | No | minimum: 0; maximum: 9007199254740991 |

Additional fields are not accepted.

###### application/json body.data.blockers item.assets

Type: `object[]`. minItems: 1

###### application/json body.data.blockers item.assets item

| Field | Type | Required | Description and constraints |
| --- | --- | --- | --- |
| `asset` | string | Yes | Currency code (ISO-4217 or on-chain ticker) pattern: `^[A-Z0-9]{1,16}$` |
| `kind` | "balance" / "held" / "owed" / "unsettled" | Yes |  |

Additional fields are not accepted.

###### application/json body.data.max_source_amount

For `amount_below_minimum` / `amount_above_maximum`: the product maximum in source asset units; null means no maximum.

| Field | Type | Required | Description and constraints |
| --- | --- | --- | --- |
| `currency` | string | Yes |  |
| `value` | string | Yes |  |

Additional fields are not accepted.

###### application/json body.data.min_source_amount

For `amount_below_minimum` / `amount_above_maximum`: the effective minimum in source asset units, fees included.

| Field | Type | Required | Description and constraints |
| --- | --- | --- | --- |
| `currency` | string | Yes |  |
| `value` | string | Yes |  |

Additional fields are not accepted.

### Response 403 schema

Content type: `application/json`.

See [response 401 schema](#response-401-schema).

### Response 404 schema

Content type: `application/json`.

See [response 401 schema](#response-401-schema).

### Response 500 schema

Content type: `application/json`.

See [response 401 schema](#response-401-schema).

### Response 502 schema

Content type: `application/json`.

See [response 400 schema](#response-400-schema).

### Response 503 schema

Content type: `application/json`.

See [response 400 schema](#response-400-schema).
