Sign in
Gateway Profiles

Update a Gateway Profile

Update an existing Gateway Profile with the provided details

post/gateway-profiles/{id}

Path parameters

idstring required

Request body

titlestring

Display name for the gateway profile

activeboolean

Whether the gateway profile is active

Example request

{
  "title": "Stripe Test mode",
  "active": true,
  "configuration": {
    "type": "stripe",
    "environment": "test",
    "secretKey": "sk_test_...",
    "webhookSecret": "whsec_w051d0fwarc"
  }
}

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

ID of the Gateway Profile

activeboolean required

Whether the gateway profile is active and available for processing

titlestring required

Title of the Gateway Profile

integration'stripe' | 'adyen' | 'checkout' | 'paypal' required

Associated Gateway Integration

environment'live' | 'test' | 'null' nullable required

The environment the gateway profile operates in

supportedPaymentMethodsstring[] required

Supported payment methods for the Gateway Profile

Example response

{
  "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",
  "configuration": {
    "type": "stripe",
    "environment": "test",
    "secretKey": "sk_test_..."
  }
}

Changes

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