Update merchant account profile

PATCH /merchant

Error

A valid request URL is required to generate request examples

200

{
  "data": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "userId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "companyName": "<string>",
    "logoUrl": "<string>",
    "billingAddressLine1": "<string>",
    "billingAddressLine2": "<string>",
    "billingCity": "<string>",
    "billingState": "<string>",
    "billingPostalCode": "<string>",
    "billingCountry": "<string>",
    "billingVatId": "<string>",
    "billingTaxId": "<string>",
    "selfBillingConsentAt": "2023-11-07T05:31:56Z",
    "billingTier": "<string>",
    "billingRequirementStatus": "not_required",
    "paymentStatus": "<string>",
    "lastPaymentFailedAt": "2023-11-07T05:31:56Z",
    "defaultCookieDuration": 123,
    "defaultPayoutThreshold": 123,
    "timezone": "<string>",
    "trackingRequiresConsent": true,
    "trackingParamAliases": [
      "<string>"
    ],
    "notificationPreferences": {},
    "onboardingCompleted": true,
    "onboardingStep": 123,
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z"
  },
  "meta": {
    "requestId": "<string>"
  }
}

Authorizations

Authorization · string · header · required

Use API key as Bearer token, for example: Bearer ak_live_xxx

Body

application/json

companyName · string

Required string length: 1 - 100

logoUrl · string<uri> enum<string>

billingAddressLine1 · string enum<string>

Maximum string length: 200

billingAddressLine2 · string enum<string>

Maximum string length: 200

billingCity · string enum<string>

Maximum string length: 100

billingState · string enum<string>

Maximum string length: 100

billingPostalCode · string enum<string>

Maximum string length: 20

billingCountry · string enum<string>

Maximum string length: 2

billingVatId · string enum<string>

Maximum string length: 50

billingTaxId · string enum<string>

Maximum string length: 50

selfBillingConsent · boolean

timezone · string

defaultCookieDuration · number

Required range: 1 <= x <= 365

defaultPayoutThreshold · number

Required range: 1000 <= x <= 100000

trackingRequiresConsent · boolean

trackingParamAliases · string[]

Maximum array length: 10

Required string length: 1 - 64

Response

200 - application/json

Updated merchant account profile

data · object · required

Show child attributes

meta · object · required

Show child attributes