Skip to main content
Create a merchant

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

Idempotency-Key
string
required

1 to 255 printable ASCII characters with no spaces, quotes or backslashes, in double quotes as the IETF draft defines, or without them. We recommend a UUID. Make one for each thing you mean to happen once and store it before you send the request, so a retry after a crash sends the same key. Keys are scoped to your account and the endpoint, not to a token, so a new token or a rotated secret doesn't affect a retry. A partner and its merchant are separate accounts, so the same key sent with each credential starts two requests. Keys are kept for at least 7 days. After that, the same key starts a new request.

Required string length: 1 - 257
Pattern: ^(?:([\x21\x23-\x5B\x5D-\x7E]{1,255})|"([\x21\x23-\x5B\x5D-\x7E]{1,255})")$

Path Parameters

id
string
required
Minimum string length: 1

Body

application/json
brand_name
string
required
Required string length: 1 - 255
website_url
string<uri>
required
Maximum string length: 255
Pattern: ^https://
category_code
string
required

An ISO 18245 merchant category code: four digits, 0742 for veterinary services.

Pattern: ^[0-9]{4}$
country
string
Pattern: ^[A-Z]{2}$
account_owners
object[]

At most one, who becomes the primary owner.

Maximum array length: 1

The person accepts the agreements every merchant accepts: merchant_terms, privacy_notice, data_processing_addendum, prohibited_use_policy, pricing_plan, third_party_services and banking_partner_authorization. agreements must hold the current version of each, and nothing else: list agreements for them. Optional. Send it to record the person's acceptance with the create, or accept later through agreement_acceptance.

Response

The merchant, in the full view.

result
object
required
entities
object
required

Nothing can be included here.

not_included
object[]
required