Exchange Rate
The Exchange Rate API allows merchants to show customers exchange rate information.
Refer to the links below for parameters and code samples for each step:
- Generate Payment Token
- Prepare Exchange Rate Request
- Retrieve Exchange Rate Response
- Full Sample Code
Â
API Method
References
1. Generate Payment Token
To prepare a payment token request, refer to the required parameters below.
{
"merchantID": "JT04",
"invoiceNo": "1595219400",
"description": "2 days 1 night hotel room",
"amount": 10.0,
"currencyCode": "THB",
"nonceStr": "a8092512-b144-41b0-8284-568bb5e9264c",
"paymentChannel": ["ALL"]
}
Â
2. Receive Payment Token Response
To receive a payment token response, refer to the sample payment token response below. The response will contain the payment token ID which must be passed to the merchant application.
String paymentToken = "roZG9I1hk/GYjNt+BYPYbxQtKElbZDs9M5cXuEbE+Z0QTr/yUcl1oG7t0AGoOJlBhzeyBtf5mQi1UqGbjC66E85S4m63CfV/awwNbbLbkxsvfgzn0KSv7JzH3gcs/OIL";
val paymentToken = "roZG9I1hk/GYjNt+BYPYbxQtKElbZDs9M5cXuEbE+Z0QTr/yUcl1oG7t0AGoOJlBhzeyBtf5mQi1UqGbjC66E85S4m63CfV/awwNbbLbkxsvfgzn0KSv7JzH3gcs/OIL"
NSString *paymentToken = @"roZG9I1hk/GYjNt+BYPYbxQtKElbZDs9M5cXuEbE+Z0QTr/yUcl1oG7t0AGoOJlBhzeyBtf5mQi1UqGbjC66E85S4m63CfV/awwNbbLbkxsvfgzn0KSv7JzH3gcs/OIL";
let paymentToken: String = "roZG9I1hk/GYjNt+BYPYbxQtKElbZDs9M5cXuEbE+Z0QTr/yUcl1oG7t0AGoOJlBhzeyBtf5mQi1UqGbjC66E85S4m63CfV/awwNbbLbkxsvfgzn0KSv7JzH3gcs/OIL"
String paymentToken = 'roZG9I1hk/GYjNt+BYPYbxQtKElbZDs9M5cXuEbE+Z0QTr/yUcl1oG7t0AGoOJlBhzeyBtf5mQi1UqGbjC66E85S4m63CfV/awwNbbLbkxsvfgzn0KSv7JzH3gcs/OIL';
let paymentToken = 'roZG9I1hk/GYjNt+BYPYbxQtKElbZDs9M5cXuEbE+Z0QTr/yUcl1oG7t0AGoOJlBhzeyBtf5mQi1UqGbjC66E85S4m63CfV/awwNbbLbkxsvfgzn0KSv7JzH3gcs/OIL';
Payment Token API
Refer to: Payment Token API
3. Prepare Exchange Rate Request
To prepare an exchange rate request, refer to the parameters below.
Request API Parameters
Refer to: Exchange Rate Request API Parameters
ExchangeRateRequest exchangeRateRequest = new ExchangeRateRequest(paymentToken);
exchangeRateRequest.setBin("411111");
val exchangeRateRequest = ExchangeRateRequest(paymentToken).apply {
bin = "411111"
}
ExchangeRateRequest *exchangeRateRequest = [[ExchangeRateRequest alloc] initWithPaymentToken: paymentToken];
exchangeRateRequest.bin = @"41111";
let exchangeRateRequest: ExchangeRateRequest = ExchangeRateRequest(paymentToken: paymentToken)
exchangeRateRequest.bin = "411111"
Map<String, dynamic> exchangeRateRequest = {
'paymentToken': paymentToken,
'bin': '411111'
};
let exchangeRateRequest = {
'paymentToken': paymentToken,
'bin': '411111'
};
4. Retrieve Exchange Rate Response
To retrieve an exchange rate response, refer to the parameters below.
Response API Parameters
Refer to: Exchange Rate Response API Parameters
PGWSDK.getInstance().exchangeRate(exchangeRateRequest, new APIResponseCallback<ExchangeRateResponse>() {
@Override
public void onResponse(ExchangeRateResponse response) {
if(response.getResponseCode().equals(APIResponseCode.APISuccess)) {
//Read exchange rate response.
} else {
//Get error response and display error.
}
}
@Override
public void onFailure(Throwable error) {
//Get error response and display error.
}
});
PGWSDK.getInstance().exchangeRate(exchangeRateRequest, object : APIResponseCallback<ExchangeRateResponse> {
override fun onResponse(response: ExchangeRateResponse) {
if (response.responseCode == APIResponseCode.APISuccess) {
//Read exchange rate response.
} else {
//Get error response and display error.
}
}
override fun onFailure(error: Throwable) {
//Get error response and display error.
}
})
[[PGWSDK shared] exchangeRateWithExchangeRateRequest: exchangeRateRequest response: ^(ExchangeRateResponse * _Nonnull response) {
if([response.responseCode isEqualToString: APIResponseCode.APISuccess]) {
//Read exchange rate response.
} else {
//Get error response and display error.
}
} failure: ^(NSError * _Nonnull error) {
//Get error response and display error.
}];
PGWSDK.shared.exchangeRate(exchangeRateRequest: exchangeRateRequest, { (response: ExchangeRateResponse) in
if response.responseCode == APIResponseCode.APISuccess {
//Read exchange rate response.
} else {
//Get error response and display error.
}
}) { (error: NSError) in
//Get error response and display error.
}
PGWSDK().exchangeRate(exchangeRateRequest, (response) {
if (response['responseCode'] == APIResponseCode.apiSuccess) {
//Read exchange rate response.
} else {
//Get error response and display error.
}
}, (error) {
//Get error response and display error.
});
await RTNPGW.exchangeRate(JSON.stringify(exchangeRateRequest)).then((response: string) => {
let exchangeRateResponse = JSON.parse(response);
if (exchangeRateResponse?.responseCode == APIResponseCode.apiSuccess) {
//Read exchange rate response.
} else {
//Get error response and display error
}
}).catch ((error: Error) => {
//Get error response and display error
});
Full Sample Code
The following sample code demonstrates requests and parameters for each step of the process.
//Step 1: Generate payment token.
String paymentToken = "roZG9I1hk/GYjNt+BYPYbxQtKElbZDs9M5cXuEbE+Z0QTr/yUcl1oG7t0AGoOJlBhzeyBtf5mQi1UqGbjC66E85S4m63CfV/awwNbbLbkxsvfgzn0KSv7JzH3gcs/OIL";
//Step 2: Construct exchange rate request.
ExchangeRateRequest exchangeRateRequest = new ExchangeRateRequest(paymentToken);
exchangeRateRequest.setBin("411111");
//Step 3: Retrieve exchange rate response.
PGWSDK.getInstance().exchangeRate(exchangeRateRequest, new APIResponseCallback<ExchangeRateResponse>() {
@Override
public void onResponse(ExchangeRateResponse response) {
if(response.getResponseCode().equals(APIResponseCode.APISuccess)) {
//Read exchange rate response.
} else {
//Get error response and display error.
}
}
@Override
public void onFailure(Throwable error) {
//Get error response and display error.
}
});
//Step 1: Generate payment token.
val paymentToken = "roZG9I1hk/GYjNt+BYPYbxQtKElbZDs9M5cXuEbE+Z0QTr/yUcl1oG7t0AGoOJlBhzeyBtf5mQi1UqGbjC66E85S4m63CfV/awwNbbLbkxsvfgzn0KSv7JzH3gcs/OIL"
//Step 2: Construct exchange rate request.
val exchangeRateRequest = ExchangeRateRequest(paymentToken).apply {
bin = "411111"
}
//Step 3: Retrieve exchange rate response.
PGWSDK.getInstance().exchangeRate(exchangeRateRequest, object : APIResponseCallback<ExchangeRateResponse> {
override fun onResponse(response: ExchangeRateResponse) {
if (response.responseCode == APIResponseCode.APISuccess) {
//Read exchange rate response.
} else {
//Get error response and display error.
}
}
override fun onFailure(error: Throwable) {
//Get error response and display error.
}
})
//Step 1: Generate payment token.
NSString *paymentToken = @"roZG9I1hk/GYjNt+BYPYbxQtKElbZDs9M5cXuEbE+Z0QTr/yUcl1oG7t0AGoOJlBhzeyBtf5mQi1UqGbjC66E85S4m63CfV/awwNbbLbkxsvfgzn0KSv7JzH3gcs/OIL";
//Step 2: Construct exchange rate request.
ExchangeRateRequest *exchangeRateRequest = [[ExchangeRateRequest alloc] initWithPaymentToken: paymentToken];
exchangeRateRequest.bin = @"41111";
//Step 3: Retrieve exchange rate response.
[[PGWSDK shared] exchangeRateWithExchangeRateRequest: exchangeRateRequest response: ^(ExchangeRateResponse * _Nonnull response) {
if([response.responseCode isEqualToString: APIResponseCode.APISuccess]) {
//Read exchange rate response.
} else {
//Get error response and display error.
}
} failure: ^(NSError * _Nonnull error) {
//Get error response and display error.
}];
//Step 1: Generate payment token.
let paymentToken: String = "roZG9I1hk/GYjNt+BYPYbxQtKElbZDs9M5cXuEbE+Z0QTr/yUcl1oG7t0AGoOJlBhzeyBtf5mQi1UqGbjC66E85S4m63CfV/awwNbbLbkxsvfgzn0KSv7JzH3gcs/OIL"
//Step 2: Construct exchange rate info request.
let exchangeRateRequest: ExchangeRateRequest = ExchangeRateRequest(paymentToken: paymentToken)
exchangeRateRequest.bin = "411111"
//Step 3: Retrieve exchange rate response.
PGWSDK.shared.exchangeRate(exchangeRateRequest: exchangeRateRequest, { (response: ExchangeRateResponse) in
if response.responseCode == APIResponseCode.APISuccess {
//Read exchange rate response.
} else {
//Get error response and display error.
}
}) { (error: NSError) in
//Get error response and display error.
}
//Step 1: Generate payment token.
String paymentToken = 'roZG9I1hk/GYjNt+BYPYbxQtKElbZDs9M5cXuEbE+Z0QTr/yUcl1oG7t0AGoOJlBhzeyBtf5mQi1UqGbjC66E85S4m63CfV/awwNbbLbkxsvfgzn0KSv7JzH3gcs/OIL';
//Step 2: Construct exchange rate info request.
Map<String, dynamic> exchangeRateRequest = {
'paymentToken': paymentToken,
'bin': '411111'
};
//Step 3: Retrieve exchange rate response.
PGWSDK().exchangeRate(exchangeRateRequest, (response) {
if (response['responseCode'] == APIResponseCode.apiSuccess) {
//Read exchange rate response.
} else {
//Get error response and display error.
}
}, (error) {
//Get error response and display error.
});
//Step 1: Generate payment token.
let paymentToken = 'roZG9I1hk/GYjNt+BYPYbxQtKElbZDs9M5cXuEbE+Z0QTr/yUcl1oG7t0AGoOJlBhzeyBtf5mQi1UqGbjC66E85S4m63CfV/awwNbbLbkxsvfgzn0KSv7JzH3gcs/OIL';
//Step 2: Construct exchange rate info request.
let exchangeRateRequest = {
'paymentToken': paymentToken,
'bin': '411111'
};
//Step 3: Retrieve exchange rate response.
await RTNPGW.exchangeRate(JSON.stringify(exchangeRateRequest)).then((response: string) => {
let exchangeRateResponse = JSON.parse(response);
if (exchangeRateResponse?.responseCode == APIResponseCode.apiSuccess) {
//Read exchange rate response.
} else {
//Get error response and display error
}
}).catch ((error: Error) => {
//Get error response and display error
});
Updated 8 days ago