Available

Bank Details

Changed on

Returns the fields a bank account needs for a payout rail, so a recipient form can collect and validate them before calling create bank account. Each field has a label, the request body key to send it under, a validation regex, and, where the value comes from a fixed list (banks, countries, account types), the allowed items. Get valid rail values from GET /v1/available/rails. Public: no API key required.

get/v1/available/bank-details

Request

  • Base URL: https://blindpay.com (the document declares no server; this is the origin it was published from)
  • URL: https://blindpay.com/v1/available/bank-details
  • Auth: none required

Query parameters

rail'wire' | 'ach' | 'pix' | 'pix_safe' | 'ted' | 'spei_bitso' | 'transfers_bitso' | 'ach_cop_bitso' | 'international_swift' | 'rtp' | 'sepa' | 'faster_payments' required

Response

Retrieve bank details by rail

labelstring required
regexstring required
key'type' | 'name' | 'status' | 'recipient_relationship' | 'swift_payment_code' | 'pix_key' | 'force_cpf_cnpj' | 'beneficiary_name' | 'routing_number' | 'account_number' | 'account_type' | 'account_class' | 'address_line_1' | 'address_line_2' | 'city' | 'state_province_region' | 'country' | 'postal_code' | 'checkbook_account_id' | 'checkbook_user_key' | 'onemoney_external_account_id' | 'pix_safe_bank_code' | 'pix_safe_branch_code' | 'pix_safe_cpf_cnpj' | 'ted_bank_code' | 'ted_branch_code' | 'ted_cpf_cnpj' | 'spei_protocol' | 'spei_institution_code' | 'spei_clabe' | 'transfers_type' | 'transfers_account' | 'ach_cop_beneficiary_first_name' | 'ach_cop_beneficiary_last_name' | 'ach_cop_document_id' | 'ach_cop_document_type' | 'ach_cop_email' | 'ach_cop_bank_code' | 'ach_cop_bank_account' | 'swift_code_bic' | 'swift_account_holder_name' | 'swift_account_number_iban' | 'swift_beneficiary_address_line_1' | 'swift_beneficiary_address_line_2' | 'swift_beneficiary_country' | 'swift_beneficiary_city' | 'swift_beneficiary_state_province_region' | 'swift_beneficiary_postal_code' | 'swift_bank_name' | 'swift_bank_address_line_1' | 'swift_bank_address_line_2' | 'swift_bank_country' | 'swift_bank_city' | 'swift_bank_state_province_region' | 'swift_bank_postal_code' | 'swift_ifsc_branch_code' | 'swift_intermediary_bank_swift_code_bic' | 'swift_intermediary_bank_account_number_iban' | 'swift_intermediary_bank_name' | 'swift_intermediary_bank_country' | 'swift_intermediary_bank_routing_number' | 'sepa_iban' | 'sepa_beneficiary_bic' | 'sepa_beneficiary_legal_name' | 'sepa_beneficiary_address_line_1' | 'sepa_beneficiary_address_line_2' | 'sepa_beneficiary_city' | 'sepa_beneficiary_state_province_region' | 'sepa_beneficiary_postal_code' | 'sepa_beneficiary_country' | 'faster_payments_sort_code' | 'faster_payments_account_number' | 'faster_payments_beneficiary_legal_name' | 'faster_payments_beneficiary_address_line_1' | 'faster_payments_beneficiary_address_line_2' | 'faster_payments_beneficiary_city' | 'faster_payments_beneficiary_state_province_region' | 'faster_payments_beneficiary_postal_code' | 'faster_payments_beneficiary_country' | 'business_industry' | 'phone_number' | 'tax_id' | 'date_of_birth' required
requiredboolean nullable

Example response

[
  {
    "label": "Account Number",
    "regex": "^[0-9]{9}$",
    "key": "account_number",
    "items": [
      {
        "label": "United States of America",
        "value": "US",
        "is_active": true
      }
    ],
    "requiredWhen": {
      "field": "country",
      "operator": "in",
      "values": [
        "US",
        "GB"
      ]
    }
  }
]

Changes

  • 5e4f8b62871cRevision changes
    • warning

      added the new faster_payments_account_number enum value to the / response property for the response status

    • warning

      added the new faster_payments_account_number enum value to the // response property for the response status

    • warning

      added the new faster_payments_beneficiary_address_line_1 enum value to the / response property for the response status

    • warning

      added the new faster_payments_beneficiary_address_line_1 enum value to the // response property for the response status

    • warning

      added the new faster_payments_beneficiary_address_line_2 enum value to the / response property for the response status

    • warning

      added the new faster_payments_beneficiary_address_line_2 enum value to the // response property for the response status

    • warning

      added the new faster_payments_beneficiary_city enum value to the / response property for the response status

    • warning

      added the new faster_payments_beneficiary_city enum value to the // response property for the response status

    • warning

      added the new faster_payments_beneficiary_country enum value to the / response property for the response status

    • warning

      added the new faster_payments_beneficiary_country enum value to the // response property for the response status

    • warning

      added the new faster_payments_beneficiary_legal_name enum value to the / response property for the response status

    • warning

      added the new faster_payments_beneficiary_legal_name enum value to the // response property for the response status

    • warning

      added the new faster_payments_beneficiary_postal_code enum value to the / response property for the response status

    • warning

      added the new faster_payments_beneficiary_postal_code enum value to the // response property for the response status

    • warning

      added the new faster_payments_beneficiary_state_province_region enum value to the / response property for the response status

    • warning

      added the new faster_payments_beneficiary_state_province_region enum value to the // response property for the response status

    • warning

      added the new faster_payments_sort_code enum value to the / response property for the response status

    • warning

      added the new faster_payments_sort_code enum value to the // response property for the response status

    • info

      added the new enum value faster_payments to the query request parameter rail

  • da76422a3609Revision changes
    • warning

      added the new swift_intermediary_bank_routing_number enum value to the / response property for the response status

    • warning

      added the new swift_intermediary_bank_routing_number enum value to the // response property for the response status