Sign in

v1

latestOpenAPI 3.0.22026-07-2667277423.4 KB
Platform Model

Merchant: Update

Updates a sub-merchant's settings, including payment and payout toggles, email notification preferences, and payment method expiry settings.

patch/merchants/{id}

Path parameters

idstring required

A unique 25-character alphanumeric resource identifier.

Request body

payments_enabledboolean
payouts_enabledboolean
send_payment_instruction_emailboolean
send_payment_receipt_emailboolean
send_payment_reminder_emailboolean
send_payment_capture_emailboolean
send_payment_refund_emailboolean

Example request

{
  "expiry_settings": [
    {
      "currency": "JPY"
    }
  ]
}

Response

200 response

idstring required

Unique identifier for this sub-merchant.

liveboolean required

Whether this merchant is operating in live (production) mode.

created_atstring date-time required

Timestamp when this merchant was created.

updated_atstring date-time required

Timestamp when this merchant record was last updated.

account_idstring required

Account identifier associated with this merchant.

namestring required

Display name of the sub-merchant.

platform_role'seller' | 'payout' required
statusstring required

Current account/application status of the merchant.

payments_enabledboolean required

Whether payments are currently enabled for this merchant.

payouts_enabledboolean required

Whether payouts are currently enabled for this merchant.

send_payment_instruction_emailboolean

Whether payment instruction emails are sent to customers for this merchant. Omitted for payout-role merchants.

send_payment_receipt_emailboolean

Whether payment receipt emails are sent to customers for this merchant. Omitted for payout-role merchants.

send_payment_reminder_emailboolean

Whether payment reminder emails are sent to customers for this merchant. Omitted for payout-role merchants.

send_payment_refund_emailboolean

Whether refund notification emails are sent to customers for this merchant. Omitted for payout-role merchants.

publishable_keystring required

The merchant's publishable API key for client-side use.

Example response

{
  "expiry_settings": [
    {
      "currency": "JPY"
    }
  ],
  "active_payment_methods": [
    {
      "currency": "JPY"
    }
  ]
}