BAbanqzinc
Merchants

Create a new merchant

Changed on

Create a new merchant

post/api/v1/merchants

Request

Request body

partner_idstring uuid

Partner ID. Defaults to the logged-in partner if not provided. Required for admin tokens.

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

countrystring

The country of the merchant

Example request

{
  "partner_id": "550e8400-e29b-41d4-a716-446655440000",
  "brand_name": "Example Brand",
  "uri": "example-merchant.com",
  "category_code": "4816",
  "country": "GB",
  "account_owner": {
    "full_name": "John Doe",
    "email": "john.doe@example.com",
    "phone_number": "44;7395236209",
    "role": "Owner"
  }
}

Response

Created

successboolean required

Indicates if the request was successful

Example response

{
  "success": true,
  "data": {
    "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": []
  }
}

Changes

  • b372e7d5563dRevision changes
    • breaking

      the / response's property type changed from string to no type for status

    • warning

      removed the optional property / from the response with the status

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      the request property became optional

    • info

      the request property format was generalized from uri to no format

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added subschema #1 subschema #2 to the / response property allOf list for the response status

    • info

      added the required property / to the response with the status

    • info

      added the required property / to the response with the status

  • 6637b341d86dRevision changes
    • info

      endpoint added