Skip to main content
PUT
admin_gateways_collector_credentials_put

Authorizations

x-api-key
string
header
required

X-API-Key authentication for accessing admin endpoints. Use Create api-key to create a key.

The content of the header should look like the following:

Query Parameters

overwrite
boolean
default:false

Overwrite an existing credentials

validate_credential
boolean
default:true

Body

application/json
name
string
required

The unique id that identifies the credential (store_id)

data
object
required
description
string
promote
object[]

Use the credential to configure gateway and/or gateway overrides Will create new credential from existing gateway / override so existing transactions created with the old configuration can continue to work

Response

Updated

name
string
required

The unique name that identifies the credential

created_at
string<date-time>
required
created_by
string
required
updated_at
string<date-time>
required
version
integer
required
Example:

1

updated_by
string
Last modified on July 14, 2026