v50

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

Gateway account credentials

Create credentials for a gateway account

post/v1/api/accounts/{accountId}/credentials

Path parameters

accountIdinteger required

Gateway account ID

Request body

credentialsobject

payment_providerstring

Payment provider. Accepted values - stripe, worldpay

Example request

{
  "credentials": {
    "stripe_account_id": "accnt_id"
  },
  "payment_provider": "stripe"
}

Response

active_end_datestring date-time

active_start_datestring date-time

created_datestring date-time

external_idstring

gateway_account_credential_idinteger

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_credential_id": 1,
  "gateway_account_id": 1,
  "last_updated_by_user_external_id": "vdwke0d16d4a4d14b4c94787b8f427d",
  "payment_provider": "stripe",
  "state": "ACTIVE"
}