Sign in
Merchant Configuration

Update a Merchant Configuration

Update an existing Merchant Configuration by its ID

post/merchant-configs/{id}

Path parameters

idstring required

Request body

displayCurrency'usd' | 'eur' | 'gbp' | 'cad' | 'aud' | 'pln' | 'czk' | 'sek' | 'dkk'

Display currency to be used for the merchant. If not provided, will be set to USD.

timezonestring

Timezone for the merchant, in IANA format. If not provided, will be set to UTC.

enableRecurringPaymentBundlingboolean

Whether to bundle recurring payments for the same customer into a single charge.

preferCaptureAtNightboolean

Whether delayed captures should be scheduled at night in the shopper's local time, derived from the UTC offset their browser reported at authorization. Captures fall back to the standard schedule when no offset was reported.

lineItemDescriptionSource'price' | 'product'

Which name a line item description defaults to when none is supplied on the request: the name of the price it references, or the name of the product behind that price. If not provided, will be set to price.

relatedSubscriptionWindowMinutesinteger

How many minutes apart two of the same customer's subscriptions may be created and still be presented as related in the dashboard. 0 disables the time window; subscriptions sharing a setup payment are grouped regardless. If not provided, will be set to 0.

Example request

{
  "defaultPaymentMethodOptions": {
    "card": {
      "mode": "cascade",
      "captureMethod": "automatic",
      "captureDelay": 7,
      "recurringCaptureMethod": "automatic",
      "recurringCaptureDelay": 7
    },
    "paypal": {
      "captureMethod": "automatic",
      "captureDelay": 7,
      "recurringCaptureMethod": "automatic",
      "recurringCaptureDelay": 7
    },
    "applePay": {
      "captureMethod": "automatic",
      "captureDelay": 7,
      "recurringCaptureMethod": "automatic",
      "recurringCaptureDelay": 7
    }
  },
  "displayCurrency": "usd",
  "timezone": "Europe/Paris",
  "lineItemDescriptionSource": "price"
}

Response

OK

createdAtstring date-time required

The date and time when the entity was created.

updatedAtstring date-time nullable required

The date and time when the entity was last updated.

metadataobject nullable

Metadata used by merchants to store additional information about the entity.

idstring required

The unique identifier of the merchant configuration

displayCurrency'usd' | 'eur' | 'gbp' | 'cad' | 'aud' | 'pln' | 'czk' | 'sek' | 'dkk' required

Display currency for the merchant. Used in statistics.

timezonestring required

Timezone for the merchant, in IANA format.

enableRecurringPaymentBundlingboolean required

Whether to bundle recurring payments for the same customer into a single charge.

preferCaptureAtNightboolean required

Whether delayed captures should be scheduled at night in the shopper's local time, derived from the UTC offset their browser reported at authorization. Captures fall back to the standard schedule when no offset was reported.

lineItemDescriptionSource'price' | 'product' required

Which name a line item description defaults to when none is supplied on the request: the name of the price it references, or the name of the product behind that price.

relatedSubscriptionWindowMinutesnumber required

How many minutes apart two of the same customer's subscriptions may be created and still be presented as related in the dashboard. 0 disables the time window; subscriptions sharing a setup payment are grouped regardless.

Example response

{
  "createdAt": "2024-02-18T12:00:00Z",
  "updatedAt": "2024-02-21T12:15:00Z",
  "metadata": {
    "key1": "value1",
    "key2": "value2"
  },
  "defaultPaymentMethodOptions": {
    "captureMethod": "automatic",
    "captureDelay": 7,
    "recurringCaptureMethod": "automatic",
    "recurringCaptureDelay": 7,
    "card": {
      "mode": "cascade",
      "gatewayProfile": {
        "createdAt": "2024-02-18T12:00:00Z",
        "updatedAt": "2024-02-21T12:15:00Z",
        "metadata": {
          "key1": "value1",
          "key2": "value2"
        },
        "id": "gwp_2QC7PqoUeOxQEWscJJt6B3PkvyL",
        "active": true,
        "title": "Profile #1",
        "integration": "stripe",
        "environment": "test"
      },
      "cascade": {
        "createdAt": "2024-02-18T12:00:00Z",
        "updatedAt": "2024-02-21T12:15:00Z",
        "metadata": {
          "key1": "value1",
          "key2": "value2"
        },
        "name": "My Cascade",
        "description": "Simple cascade",
        "active": true,
        "algorithm": "weightedRoundRobin"
      },
      "captureMethod": "automatic",
      "captureDelay": 7,
      "recurringCaptureMethod": "automatic",
      "recurringCaptureDelay": 7
    },
    "paypal": {
      "mode": "direct",
      "gatewayProfile": {
        "createdAt": "2024-02-18T12:00:00Z",
        "updatedAt": "2024-02-21T12:15:00Z",
        "metadata": {
          "key1": "value1",
          "key2": "value2"
        },
        "id": "gwp_2QC7PqoUeOxQEWscJJt6B3PkvyL",
        "active": true,
        "title": "Profile #1",
        "integration": "stripe",
        "environment": "test"
      },
      "captureMethod": "automatic",
      "captureDelay": 7,
      "recurringCaptureMethod": "automatic",
      "recurringCaptureDelay": 7
    },
    "applePay": {
      "mode": "direct",
      "gatewayProfile": {
        "createdAt": "2024-02-18T12:00:00Z",
        "updatedAt": "2024-02-21T12:15:00Z",
        "metadata": {
          "key1": "value1",
          "key2": "value2"
        },
        "id": "gwp_2QC7PqoUeOxQEWscJJt6B3PkvyL",
        "active": true,
        "title": "Profile #1",
        "integration": "stripe",
        "environment": "test"
      },
      "captureMethod": "automatic",
      "captureDelay": 7,
      "recurringCaptureMethod": "automatic",
      "recurringCaptureDelay": 7
    }
  },
  "displayCurrency": "usd",
  "timezone": "UTC",
  "lineItemDescriptionSource": "price"
}

Changes

No recorded changes to this endpoint across all 1 revision of this API.