Skip to navigation

Save PSP credentials

View as Markdown

This API allows a merchant to securely store credentials for a selected Payment Service Provider (PSP). Each PSP may require different credentials

Request Body

FieldTypeRequiredDescription
pspIdstringYesUnique identifier of the Payment Service Provider
credentialKeystringYesCredential key used to identify the specific credential type for the PSP
credentialSecretstringYesThe credential value or secret associated with the key
pspClientIdstringyes(nium only)client id in nium

Response Body

200 OK

FieldType
timestampdate(yyyy-MM-dd’T’HH:mm:ss.SSS’Z’)
messagestring

400 BAD REQUEST - 403 FORBIDDEN - 401 UNAUTHORIZED - 500 INTERNAL ERROR

Fieldtype
timestampdate(yyyy-MM-dd’T’HH:mm:ss.SSS’Z’)
titlestring
typestring
statusnumber
soaCodestring
detailstring

Request

This endpoint expects an object.
pspIdstringRequired
pspClientIdstringRequired
credentialKeystringRequired
credentialSecretstringRequired

Response

OK
messagestring
timestampstring