Country specifications

The Country Specifications resource streamlines the checkout process by providing detailed schemas based on the selling entity and country combination. It assists in determining the necessity and format of address components and tax identifiers, ensuring compliance with country-specific requirements. By leveraging this API, businesses can enhance their international operations and reduce friction during cross-border transactions.

The Country Specs API returns schemas based on the selling entity and country combination you provide. You can then use these schemas to determine whether an address component or tax identifier is required and also whether it is properly formatted.

Returns an array containing a country specification

get

Gets a country specification.

Authorizations
Query parameters
countrystringRequired

Represents the expected billing or ship to country of the customer.

sellingEntitystringRequired

Represents the selling entity assigned to the order.

Responses
200
200 OK
application/json
get
GET /country-specs HTTP/1.1
Host: api.digitalriver.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
  "data": [
    {
      "country": "US",
      "sellingEntity": "DR_IRELAND-ENTITY",
      "billingAddressSchema": "text",
      "shippingAddressSchema": "text",
      "billingAddressOnlySchema": "text",
      "individualTaxIdentifiersSchemas": [
        "text"
      ],
      "businessTaxIdentifiersSchemas": [
        "text"
      ],
      "taxIdentifiersInfo": {
        "type": "ie",
        "customerType": "business",
        "isRequired": false,
        "formatPattern": "^[Ii][Ee]\\\\d\\\\d\\\\d\\\\d\\\\d\\\\d\\\\d[A-Za-z]$|^[Ii][Ee]\\\\d\\\\d\\\\d\\\\d\\\\d\\\\d[A-Za-z]$|^[Ii][Ee]\\\\d\\\\d\\\\d\\\\d\\\\d\\\\d\\\\d[A-Za-z][A-Za-z]$|^[Ii][Ee]\\\\d[A-Za-z]\\\\d\\\\d\\\\d\\\\d\\\\d[A-Za-z]$",
        "locales": "en_IE"
      },
      "invoiceAttributeInfo": {
        "isRequired": false,
        "individual": {
          "type": "cn_individual_general",
          "attributes": {
            "invoiceTitle": "Invoice title",
            "regAccount": "87654",
            "regAddress": "123 Example st.",
            "regBank": "Bank",
            "regPhone": "8005551234"
          }
        },
        "business": {
          "type": "cn_business_general",
          "attributes": [
            {
              "invoiceTitle": "Invoice title",
              "regAccount": "87654",
              "regAddress": "123 Example st.",
              "regBank": "Bank",
              "regPhone": "8005551234"
            }
          ]
        }
      },
      "liveMode": false
    }
  ]
}

Last updated