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

# Institution Codes

> Resolves a bank code (SWIFT code or US routing number) to the corresponding bank or institution name.

Resolves payment method user information for bank accounts or mobile money.


## OpenAPI

````yaml GET /api/v1/payment-method/institution/codes
openapi: 3.1.0
info:
  title: Afriex Business API
  version: 1.0.8
  description: >-
    Welcome to the Afriex Business API. This API allows you to manage customers,
    process payments, handle payouts, and receive real-time notifications via
    webhooks.


    For detailed guidance on authentication, pagination, error handling, and
    webhooks, please refer to the [dedicated guides](https://docs.afriex.com) in
    the top bar. The guide provides a step-by-step instructions to help you
    integrate seamlessly.
  termsOfService: https://www.afriex.com/terms-and-condition
  contact:
    name: Afriex API Support
    email: eng@afriex.co
    url: https://docs.afriex.com
  license:
    name: Proprietary
    url: https://www.afriex.com/terms-and-condition
servers:
  - url: https://sandbox.api.afriex.com
    description: Staging Base URL
  - url: https://api.afriex.com
    description: Production Base URL
security:
  - ApiKey: []
tags:
  - name: Customers
    description: Create and manage your customers.
  - name: Payment Methods
    description: Register and resolve customer payout and collection methods.
  - name: Transactions
    description: Create and track deposits, withdrawals, and swaps.
  - name: Balance
    description: View and top up your business wallet balances.
  - name: Rates
    description: Fetch real-time exchange rates.
  - name: Checkout Sessions
    description: Create hosted checkout sessions.
  - name: Webhooks
    description: Webhook event payloads and sandbox webhook testing.
  - name: Media
    description: Generate presigned URLs for secure file uploads.
paths:
  /api/v1/payment-method/institution/codes:
    parameters:
      - $ref: '#/components/parameters/x-api-signature'
      - $ref: '#/components/parameters/x-api-version'
    get:
      tags:
        - Payment Methods
      summary: Resolve bank code to institution name
      description: >-
        Resolves a bank code (SWIFT code or US routing number) to the
        corresponding bank or institution name.
      operationId: resolveInstitutionCode
      parameters:
        - name: searchTerm
          in: query
          description: >-
            The bank code to resolve. A US routing number (8-9 digits) when
            codeType is routing_number, otherwise a SWIFT code.
          required: true
          schema:
            type: string
        - name: country
          in: query
          description: >-
            ISO country code of the institution. Defaults to US. routing_number
            lookups are only supported for US; all other countries use
            swift_code.
          required: true
          schema:
            type: string
            default: US
        - name: codeType
          in: query
          description: >-
            The type of bank code. routing_number is only valid when country is
            US; for every other country only swift_code is accepted.
          required: true
          schema:
            type: string
            enum:
              - swift_code
              - routing_number
      responses:
        '200':
          description: Bank code resolved successfully.
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    $ref: '#/components/schemas/BankCodeResolverResponse'
              examples:
                routingNumberFound:
                  summary: Routing number resolved
                  value:
                    data:
                      bankName: JPMORGAN CHASE BANK
                notFound:
                  summary: Bank code not found
                  value:
                    data: null
        '400':
          description: Invalid request parameters.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                missingParams:
                  summary: Missing required parameters
                  value:
                    code: VALIDATION_ERROR
                    error: >-
                      Failed to parse request. Issues: 'country' is required,
                      'codeType' is required, 'searchTerm' is required
                    details: {}
                invalidFormat:
                  summary: Invalid routing number format
                  value:
                    code: VALIDATION_ERROR
                    error: >-
                      Failed to parse request. Issues: US routing number must be
                      between 8 and 9 digits
                    details: {}
                swiftCountryMismatch:
                  summary: SWIFT code country mismatch
                  value:
                    code: VALIDATION_ERROR
                    error: >-
                      Failed to parse request. Issues: SWIFT code country DE
                      does not match input US
                    details: {}
        '401':
          description: Unauthorized.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                missingApiKey:
                  summary: Missing API key
                  value:
                    code: AUTHENTICATION_ERROR
                    error: Authorization header is missing
                    details: {}
                invalidApiKey:
                  summary: Invalid API key
                  value:
                    code: AUTHENTICATION_ERROR
                    error: Invalid authorization header
                    details: {}
        '500':
          description: Server error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                serverError:
                  summary: Unexpected server error
                  value:
                    code: INTERNAL_SERVER_ERROR
                    error: It's not you, it's us, please reach out to support
                    details: {}
components:
  parameters:
    x-api-signature:
      name: x-api-signature
      in: header
      required: false
      description: >-
        Signature of the request payload, used for request authentication where
        payload signing is enabled for your business.
      schema:
        type: string
    x-api-version:
      name: x-api-version
      in: header
      required: false
      description: >-
        API version in ISO 8601 format (e.g. 2025-12-28). Defaults to latest
        stable.
      schema:
        type: string
  schemas:
    BankCodeResolverResponse:
      type:
        - object
        - 'null'
      properties:
        bankName:
          type: string
          description: The resolved bank or institution name.
    ErrorResponse:
      type: object
      properties:
        code:
          type: string
          description: Machine-readable error code.
        error:
          type: string
          description: Human-readable error message.
        details:
          $ref: '#/components/schemas/ErrorDetails'
    ErrorDetails:
      type: object
      properties:
        errorMessage:
          type: string
          description: Detailed/technical error message.
        friendlyMessage:
          type: string
          description: User-facing error message safe to display.
        data:
          type: object
          description: >-
            Optional caller-safe context for the error. On a customer-create
            uniqueness conflict (EMAIL_ALREADY_EXISTS /
            PHONE_NUMBER_ALREADY_EXISTS) this carries the existing customer's
            id, so you can adopt it without a follow-up lookup.
          properties:
            customerId:
              type: string
              description: Id of the existing customer (on a create conflict).
  securitySchemes:
    ApiKey:
      type: apiKey
      in: header
      name: x-api-key
      description: >-
        Static business API key issued from the dashboard. A business can
        provision **multiple API keys**, each scoped to a configurable set of
        **permissions** (e.g. read transactions, create deposits, etc).
        Permissions are chosen per key at creation time in the dashboard and may
        be revoked by deleting the key. Requests made with a key that does not
        include the permission required by the target endpoint will be rejected
        with a `403 Forbidden` response; an unrecognised, malformed or revoked
        key returns `401 Unauthorized`. Manage your keys and their permissions
        under **Developer → API keys** in the dashboard.

````