GOgovernment-digital-service
Gateway accounts

Switch payment provider of a gateway account

Changed on
post/v1/api/accounts/{accountId}/switch-psp

Request

  • The document declares no server URL.
  • Auth
    none declared

Path parameters

accountIdinteger required

Gateway account ID

Request body

gateway_account_credential_external_idstring required

Gateway account credential external ID to switch to

user_external_idstring required

User external ID switching payment service provider

Example request

{
  "gateway_account_credential_external_id": "dfokpo23ji0213ldsm0123ofsm213kdfg",
  "user_external_id": "vfrg4245bd0e7453c9b1b0d7e6999f11b"
}

Response

OK

Changes

  • 042ba06d9017Revision changes
    • info

      removed the AMOUNT_BELOW_MINIMUM enum value from the response property for the response status

  • 4e93196bd6aaRevision changes
    • warning

      added the new AMOUNT_BELOW_MINIMUM_FOR_ADYEN enum value to the response property for the response status

    • warning

      added the new AMOUNT_BELOW_MINIMUM_FOR_STRIPE enum value to the response property for the response status