Integration Endpoints

account/set-global-pay-credentials

This endpoint is used to configure the optional integration with a Global Pay account. For more information please visit our integration section.

post/account/set-global-pay-credentials

Request

Base URL
https://earthnode-dev.vopay.com/api/v2
URL
https://earthnode-dev.vopay.com/api/v2/account/set-global-pay-credentials
Auth
none declared

Request body application/x-www-form-urlencoded

AccountIDstring required

Your account ID

Keystring required

API key for the account

Signaturestring required

Hashed signature for the request

GlobalPayAppIDstring required

Your unique Global Pay app ID

GlobalPaySharedSecretstring required

Your unique Global Pay shared secret

Currencystring

Currency the credentials apply to (CAD or USD). Defaults to CAD

Response

Successboolean required

True if the request was successful, false if it failed

ErrorMessagestring required

Contains a description of the error if the request failed

GlobalPayAppIDstring required

Your updated Global Pay App ID

GlobalPaySharedSecretstring required

Your updated Global Pay shared secret key

Currencystring required

Currency the credentials were stored for

Statusstring required

Request status

Example response

{
  "Success": true,
  "GlobalPayAppID": "{GlobalPayAppID}",
  "GlobalPaySharedSecret": "{GlobalPaySharedSecret}",
  "Currency": "CAD",
  "Status": "Updated"
}

Changes

No recorded changes to this operation across all 1 revision of this API.