Available

Bank Details

get/v1/available/bank-details

Query parameters

rail'wire' | 'ach' | 'pix' | 'pix_safe' | 'ted' | 'spei_bitso' | 'transfers_bitso' | 'ach_cop_bitso' | 'international_swift' | 'rtp' | 'sepa' 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' | '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' | '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

No recorded changes to this endpoint across all 3 revisions of this API.