v1

latestOpenAPI 3.1.02026-07-132363652.9 MB
Countries

Get a list of all available CountryConfig records

Get a list of all available CountryConfig records

get/api/v1/countries/config

Response

Success

successboolean required

Indicates if the request was successful

Example response

{
  "success": true,
  "data": [
    {
      "name": "Germany",
      "iso2": "GB",
      "short": "gb",
      "grouping": "EU",
      "config": {
        "phone_data": {
          "countryCode": "44",
          "phoneFormat": ".... ......",
          "patterns": {
            "/^4/": "... ... ...",
            "default": ". .... ...."
          }
        },
        "postal_code": {
          "label": "Postal Code",
          "min": 4,
          "max": 8,
          "pattern": "^[A-Z0-9]{8}$",
          "placeholder": "SW1A 1AA",
          "format": "..-.......",
          "required": true
        },
        "company_number": {
          "label": "Postal Code",
          "min": 4,
          "max": 8,
          "pattern": "^[A-Z0-9]{8}$",
          "placeholder": "SW1A 1AA",
          "format": "..-.......",
          "required": true
        },
        "vat": {
          "label": "Postal Code",
          "min": 4,
          "max": 8,
          "pattern": "^[A-Z0-9]{8}$",
          "placeholder": "SW1A 1AA",
          "format": "..-.......",
          "required": true
        },
        "tax_id": {
          "label": "Postal Code",
          "min": 4,
          "max": 8,
          "pattern": "^[A-Z0-9]{8}$",
          "placeholder": "SW1A 1AA",
          "format": "..-.......",
          "required": true
        },
        "entity_structure": [
          {
            "label": "Private Limited Company (LTD)",
            "fields": [
              {
                "type": "company_number",
                "required": true
              }
            ]
          }
        ],
        "required_address_lines": [
          "address_line1",
          "city",
          "postal_code"
        ],
        "state_province": [
          {
            "label": "New South Wales",
            "reviewLabel": "NSW",
            "value": "New South Wales"
          }
        ]
      },
      "payment_schemes": [
        {
          "name": "Faster Payments",
          "fields": [
            {
              "label": "Postal Code",
              "min": 4,
              "max": 8,
              "pattern": "^[A-Z0-9]{8}$",
              "placeholder": "SW1A 1AA",
              "required": true,
              "type": "company_number"
            }
          ]
        }
      ]
    }
  ]
}