v1

latestOpenAPI 3.1.02026-07-132363652.9 MB

Merchants

Self-service merchant registration for users with global:user role

post/api/v1/merchants/register

Request body

brand_namestring required

The brand name of the merchant

uristring required

The URI of the merchant's website (protocol optional, will be normalized)

category_codestring required

The merchant category code (MCC)

countrystring

The country of the merchant

Example request

{
  "brand_name": "My Store",
  "uri": "my-store.com",
  "category_code": "4816",
  "country": "GB",
  "clientEvidence": {
    "checkout_page_version": "a1b2c3d",
    "timezone": "Europe/Dublin",
    "consented_agreements": [
      {
        "kind": "merchant_tos",
        "agreement_id": "00000000-0000-0000-0000-000000000001"
      },
      {
        "kind": "quidkey_privacy",
        "agreement_id": "00000000-0000-0000-0000-000000000002"
      },
      {
        "kind": "merchant_dpa",
        "agreement_id": "00000000-0000-0000-0000-000000000003"
      },
      {
        "kind": "merchant_prohibited_use",
        "agreement_id": "00000000-0000-0000-0000-000000000004"
      },
      {
        "kind": "merchant_pricing_plan",
        "agreement_id": "00000000-0000-0000-0000-000000000005"
      },
      {
        "kind": "third_party_provider_agreements",
        "agreement_id": "00000000-0000-0000-0000-000000000006"
      },
      {
        "kind": "transfermate_authorization",
        "agreement_id": "00000000-0000-0000-0000-000000000007"
      }
    ],
    "checkbox_language": [
      {
        "checkbox_id": "consent-quidkey",
        "rendered_text": "I confirm I am an authorized representative of this business and agree to Quidkey's …",
        "covers_kinds": [
          "merchant_tos",
          "quidkey_privacy",
          "merchant_dpa",
          "merchant_prohibited_use",
          "merchant_pricing_plan",
          "third_party_provider_agreements"
        ]
      },
      {
        "checkbox_id": "consent-transfermate",
        "rendered_text": "I confirm by ticking this box I authorise Quidkey to view and enter transactions with TransferMate on my behalf …",
        "covers_kinds": [
          "transfermate_authorization"
        ]
      }
    ]
  }
}

Response

Created

successboolean required

Indicates if the request was successful

Example response

{
  "success": true,
  "data": {
    "merchant": {
      "id": "123e4567-e89b-12d3-a456-426614174001",
      "brand_name": "Example Brand",
      "uri": "https://example-merchant.com",
      "category_code": "4816",
      "country": "GB",
      "settlement_currency": "EUR",
      "multi_account_setting": true,
      "refund_retention_rate": "0.0500",
      "client_id": "merchant_123",
      "has_client_secret": true,
      "account_owners": []
    }
  }
}