v50

latestOpenAPI 3.0.1raw.githubusercontent.com2026-07-169377194.1 KB

Gateway account credentials

Update a gateway account credential by service ID and account Type

A generic endpoint that allows the patching of credentials, credentials/worldpay/one_off_customer_initiated credentials/worldpay/recurring_customer_initiated, credentials/worldpay/recurring_merchant_initiated, last_updated_by_user_external_id, state, gateway_merchant_id, credentials/gateway_merchant_id, using a JSON Patch-esque message body.

patch/v1/api/service/{serviceId}/account/{accountType}/credentials/{credentialsId}

Path parameters

serviceIdstring required

Service external ID

accountType'test' | 'live' required

Account type

credentialsIdstring required

Credential external ID

Request body

string required

Response

active_end_datestring date-time

active_start_datestring date-time

created_datestring date-time

external_idstring

gateway_account_idinteger

last_updated_by_user_external_idstring

User external ID

payment_providerstring

state'CREATED' | 'ENTERED' | 'VERIFIED_WITH_LIVE_PAYMENT' | 'ACTIVE' | 'RETIRED'

Example response

{
  "active_start_date": "2022-06-28T16:40:56.869Z",
  "created_date": "2022-06-30T15:44:19.323Z",
  "external_id": "787460d16d4a4d14b4c94787b8f427db",
  "gateway_account_id": 1,
  "last_updated_by_user_external_id": "vdwke0d16d4a4d14b4c94787b8f427d",
  "payment_provider": "stripe",
  "state": "ACTIVE"
}