For AI agents: the complete documentation index is at /llms.txt, and the full text of every page is at /llms-full.txt. Most pages are also available as Markdown by adding .md to the URL.

Convert Transaction Amount

Request the conversion of a Sale or Refund Transaction amount to the equivalent amount in the currency of the Payer.

Header Parameters

authorizationstringrequired

Bearer access token value used to access the API.

example: Bearer G3FA4TuYGCBiCWs4YpzrALGCYXZJ

default: Bearer G3FA4TuYGCBiCWs4YpzrALGCYXZJ

x-gp-idempotencystring

Integrator generated value submitted in the request header that is checked to ensure the same value has not been seen in the last 24 hours. It is used to ensure idempotency is maintained with this action.

minLength: 1

maxLength: 50

x-gp-versionstringrequired

Indicates the version of the GP-API for this message.

default: 2021-03-22

minLength: 1

maxLength: 50

content-typestringrequired

Indicates the format of the message.

default: application/json

Request Parameters

account_namestringrequired

A meaningful label for the merchant account set by Global Payments.

example: DCC

minLength: 1

maxLength: 50

transaction_typestring

Describes whether the transaction is a SALE, that moves funds from Payer to Merchant, or a REFUND where funds move from Merchant to Payer.

SALE - indicates the movement, or the attempt to move, funds from payer to a merchant.
REFUND - indicates the movement, or the attempt to move, funds from merchant to the payer.

example: SALE

default: SALE

possible values:

channelstringrequired

Describes whether the transaction was processed in a face to face(CP) scenario or a Customer Not Present (CNP) scenario.

CP - A Customer Present transaction is when the payer and the merchant are in direct face to face contact when exchanging payment method information to fulfill a transaction. e.g. in a store and paying at the counter that is attended by a clerk.
CNP - A Customer NOT Present transaction is when the payer and the merchant are not together when exchanging payment method information to fulfill a transaction. e.g. a transaction executed from a merchant's website or over the phone

example: CNP

possible values:

countrystringrequired

The country in ISO-3166-1(alpha-2 code) format.

example: US

minLength: 1

maxLength: 255

amountstringrequired

The amount to transfer between Payer and Merchant for a SALE or a REFUND. It is always represented in the lowest denomiation of the related currency.

example: 11099

currencystringrequired

The currency of the amount in ISO-4217(alpha-3)

example: USD

minLength: 3

maxLength: 3

referencestringrequired

Merchant defined field to reference the transaction.

example: becf9f3e-4d33-459c-8ed2-0c4affc9555e

minLength: 8

maxLength: 50

payment_methodobjectrequired

Response Parameters

Endpoints

POSThttps://apis.sandbox.globalpay.com/ucp/currency-conversions

POSThttps://apis.globalpay.com/ucp/currency-conversions

Examples

NO BODY REQUIRED

Currency Conversion | Global Payments

Policies

Connect

Additional Resources

Convert Transaction Amount

Header Parameters

Request Parameters

Response Parameters

Endpoints

Convert Transaction Amount

Header Parameters

Request Parameters

Response Parameters200 Success

Endpoints

200 SuccessCOPY

Response Parameters