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

# Get destination requirements

> The fields a destination needs. With no `method` and `currency`, lists every supported corridor. With both, returns that corridor's fields and schemes.

`pattern` on a field is a hint for client-side validation. The payment network is the final validator, so don't make your own checks stricter than the pattern.

Requires the `recipients:read` scope.



## OpenAPI

````yaml /api-reference/openapi.yaml get /v1/destination-requirements
openapi: 3.1.0
info:
  title: Talescria API
  version: 1.0.0
  description: >-
    Accounts, recipients, payments, transfers between your accounts, payment
    links, customers and invoices. Authenticate with an access token from your
    OAuth client.
servers:
  - url: https://api.talescria.com
    description: Production (test and live keys)
security:
  - bearerAuth: []
tags:
  - name: Accounts
    description: Your accounts and their balances.
  - name: Recipients
    description: People and businesses you pay, and where to pay them.
  - name: Payments
    description: Paying recipients, including across currencies.
  - name: Transfers
    description: Moving money between your own accounts.
  - name: Payment links
    description: Links anyone can open to pay you by card.
  - name: Customers
    description: People and businesses who pay you.
  - name: Invoices
    description: One-off invoices and recurring series.
paths:
  /v1/destination-requirements:
    get:
      tags:
        - Recipients
      summary: Get destination requirements
      description: >-
        The fields a destination needs. With no `method` and `currency`, lists
        every supported corridor. With both, returns that corridor's fields and
        schemes.


        `pattern` on a field is a hint for client-side validation. The payment
        network is the final validator, so don't make your own checks stricter
        than the pattern.


        Requires the `recipients:read` scope.
      operationId: destinationRequirements
      parameters:
        - name: method
          in: query
          schema:
            type: string
            enum:
              - bank_transfer
              - mobile_money
              - stablecoin
              - internal_transfer
        - name: currency
          in: query
          description: Required together with `method`. ISO 4217, or `USDC`.
          schema:
            type: string
        - name: country
          in: query
          description: ISO 3166-1 alpha-2. Narrows a currency that several corridors serve.
          schema:
            type: string
      responses:
        '200':
          description: One corridor, or all of them.
          content:
            application/json:
              schema:
                type: object
                required:
                  - corridors
                properties:
                  corridors:
                    type: array
                    items:
                      $ref: '#/components/schemas/DestinationRequirements'
        '400':
          description: '`VALIDATION`: A field is missing or malformed. `message` says which.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '401':
          description: >-
            `UNAUTHENTICATED`: The access token is missing, expired or revoked.
            Get a new token.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '403':
          description: >-
            `ENVIRONMENT_UNAVAILABLE`: Live mode isn't available until your
            account is approved.


            `INSUFFICIENT_SCOPE`: Your API key lacks the scope this operation
            needs. The scope is named in `message` and the `WWW-Authenticate`
            header.


            `ENVIRONMENT_MISMATCH`: The request named a different environment
            from the key's.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '409':
          description: >-
            `NOT_VERIFIED`: Your account hasn't finished verification. Finish
            onboarding, then retry.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '422':
          description: >-
            `UNSUPPORTED`: This can't work as asked, for example an unsupported
            currency, corridor or account. `message` says why.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '429':
          description: '`RATE_LIMITED`: Too many requests. Wait for `Retry-After` seconds.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '500':
          description: >-
            `MISCONFIGURED`: Something is wrong on our side. Contact support
            with the `x-request-id`.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '502':
          description: >-
            `UPSTREAM_ERROR`: A service we depend on answered unexpectedly.
            Retry, and contact support with the `x-request-id` if it persists.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '503':
          description: '`UPSTREAM_UNAVAILABLE`: Temporarily unavailable. Retry with backoff.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      security:
        - bearerAuth: []
components:
  schemas:
    DestinationRequirements:
      type: object
      required:
        - method
        - currency
        - schemes
        - fields
      properties:
        method:
          type: string
          enum:
            - bank_transfer
            - mobile_money
            - stablecoin
            - internal_transfer
        currency:
          type: string
        country:
          type: string
        schemes:
          type: array
          items:
            type: string
          description: >-
            The rails this corridor offers. More than one means `scheme` must be
            chosen when creating a destination.
          example:
            - ach
            - wire
            - rtp
        fields:
          type: array
          items:
            $ref: '#/components/schemas/DestinationField'
    Error:
      type: object
      required:
        - error
      properties:
        error:
          type: object
          required:
            - code
            - message
          properties:
            code:
              type: string
              description: Branch on this, not on `message`. See Errors.
            message:
              type: string
              description: For people. Wording can change.
    DestinationField:
      type: object
      required:
        - key
        - label
        - required
      properties:
        key:
          type: string
          description: The key to send this value back under, inside `fields`.
          example: sort_code
        label:
          type: string
          example: Sort code
        required:
          type: boolean
        pattern:
          type: string
          description: >-
            A hint for client-side validation, **not** the validator of record,
            the provider decides what it accepts. A stricter pattern here would
            refuse a payment that would have worked.
          example: ^\d{2}-?\d{2}-?\d{2}$
        example:
          type: string
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: >-
        An access token (`at_test_…` or `at_live_…`) from `POST
        https://idp.talescria.com/oauth/token`.

````

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