Global Blue CC Web API Help Page

Introduction

This help page describes JSON API for DCC services provided by Global Blue.

Authorized external systems shall establish HTTP connection and send the JSON message using HTTP POST method, with content type set to “application/json”, and the response from host is encoded in UTF-8. It is also recommended that the message is sent with UTF-8 encoded so that in the event the message contain non-ASCII characters, it will be decoded properly by the host.

RateRequest

API	Description
POST convertTransaction	This operation is to convert a local currency transaction to a DCC currency transaction.
POST convertTx	This operation is to convert a local currency transaction to a DCC currency transaction.

ExchangeRates

API	Description
POST rates	This operation retrieves exchange rates for all supported currencies, for informational purpose (e.g. for merchant to publish to their customers).

PaymentRates

API	Description
POST payment/rates	For acquirer MOONEY. This operation retrieves payment rates for all supported currencies, for informational purpose (e.g. for merchant to publish to their customers).

Activation

API	Description
POST activateDCC	This operation is for front-end DCC client to activate DCC service in GB Host. Upon successful activation, the client shall receive a unique device ID and list of DCC parameters.Subsequently, the client shall use the device ID for other operations. Note that this operation may not be relevant for a host-to-host setup (e.g.front-end terminals connect to GB Host via gateway), as for such setup, the front-end client/terminals usually use its own message protocol to communicate with the gateway and has its own type of operations.

API

Description

POST activateDCC

This operation is for front-end DCC client to activate DCC service in GB Host. Upon successful activation, the client shall receive a unique device ID and list of DCC parameters.Subsequently, the client shall use the device ID for other operations.

Note that this operation may not be relevant for a host-to-host setup (e.g.front-end terminals connect to GB Host via gateway), as for such setup, the front-end client/terminals usually use its own message protocol to communicate with the gateway and has its own type of operations.

Update

API	Description
POST updateDCC	This operation is very similar to DCC Activation, except that it is generally used by an already-activated terminal/device to update the DCC Parameters. In order to ensure the front-end client/terminal receives the update in timely basis, it is recommended to perform this operation in trigger/scheduled basis, e.g.: • Upon terminal start-up • On daily basis at specific time • By manual trigger This operation may not be relevant for a host-to-host setup, due to the same reason explained in “Activation” section.

API

Description

POST updateDCC

This operation is very similar to DCC Activation, except that it is generally used by an already-activated terminal/device to update the DCC Parameters.

In order to ensure the front-end client/terminal receives the update in timely basis, it is recommended to perform this operation in trigger/scheduled basis, e.g.:
• Upon terminal start-up
• On daily basis at specific time
• By manual trigger

This operation may not be relevant for a host-to-host setup, due to the same reason explained in “Activation” section.

TerminalUpdate

API	Description
POST updateTerminal	This operation is used for updating the device information of a front-end client/terminal to GB Host. It is recommended to perform this operation in trigger/scheduled basis, e.g.: • Upon terminal start-up • On daily basis at specific time • By manual trigger This is a cut-down version of the DCC Update operation; Update Terminal responds only the result of the operation while DCC Update includes updated parameters such as supported currencies.

API

Description

POST updateTerminal

This operation is used for updating the device information of a front-end client/terminal to GB Host. It is recommended to perform this operation in trigger/scheduled basis, e.g.:
• Upon terminal start-up
• On daily basis at specific time
• By manual trigger

This is a cut-down version of the DCC Update operation; Update Terminal responds only the result of the operation while DCC Update includes updated parameters such as supported currencies.

RetrieveLastRateRequest

API	Description
POST lastDCC	This operation is to retrieve last DCC transaction performed by the Terminal.
POST pollDCC	This operation is to poll for the DCC transaction being performed by the Terminal.

AuthAdvice

API	Description
POST completion	Authorization advice flow must be used by terminal to notify to CHS all successful transactions made with foreign card.