Query Bank Debit Agreement API
In this page, you will learn how to query Bank Debit Agreement.
Query Bank Debit Agreement
To test query Bank Debit Agreement, you need to request using the POST method in our sandbox environment.
-Here is the request URL:
https://sandboxapi.opaycheckout.com/api/v1/international/payment/agreement/query
-Once you have a fully tested payment flow and you are ready for production, use the following production API endpoint URL instead
https://api.opaycheckout.com/api/v1/international/payment/agreement/query
-Request Parameters:
- Header: Authorization(API Calls Signature), MerchantId
- Json object containing the transaction information:
Authorization : Bearer {signature}
MerchantId : 256612345678901
{
"agreementId": "2203211****647368855"
}
HTTP POST parameters
-Here is a detailed description for the parameters you need to complete the POST request:
| Parameter | type | required | Description | |
|---|---|---|---|---|
| agreementId | String |
required | Agreement ID. | |
-An example of Query Agreement request is as follows :
class BankDebitAgreementIDOnlyController
{
private $secretkey;
private $merchantId;
private $url;
public function __construct() {
$this->merchantId = '281821120675251';
$this->secretkey = 'OPAYPRV1638774******57474';
$this->url = 'https://sandboxapi.opaycheckout.com/api/v1/international/payment/agreement/query';
}
public function test(){
$data = [
'agreementId'=>'220321148180647368855'
]
;
$data2 = (string) json_encode($data,JSON_UNESCAPED_SLASHES);
$auth = $this->auth($data2);
$header = ['Content-Type:application/json', 'Authorization:Bearer '. $auth, 'MerchantId:'.$this->merchantId];
$response = $this->http_post($this->url, $header, json_encode($data));
$result = $response?$response:null;
return $result;
}
private function http_post ($url, $header, $data) {
if (!function_exists('curl_init')) {
throw new Exception('php not found curl', 500);
}
$ch = curl_init();
curl_setopt($ch, CURLOPT_TIMEOUT, 60);
curl_setopt($ch, CURLOPT_URL, $url);
curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, false);
curl_setopt($ch, CURLOPT_SSL_VERIFYHOST, false);
curl_setopt($ch, CURLOPT_HEADER, false);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_POST, true);
curl_setopt($ch, CURLOPT_POSTFIELDS, $data);
curl_setopt($ch, CURLOPT_HTTPHEADER, $header);
$response = curl_exec($ch);
$httpStatusCode = curl_getinfo($ch, CURLINFO_HTTP_CODE);
$error=curl_error($ch);
curl_close($ch);
if (200 != $httpStatusCode) {
print_r("invalid httpstatus:{$httpStatusCode} ,response:$response,detail_error:" . $error, $httpStatusCode);
}
return $response;
}
public function auth ( $data ) {
$secretKey = $this->secretkey;
$auth = hash_hmac('sha512', $data, $secretKey);
return $auth;
}
}
const request = require('request');
var sha512 = require('js-sha512');
const formData = {
"agreementId": "123321"
};
var privateKey = "OPAYPRV1638774******57474"
var hash = sha512.hmac.create(privateKey);
hash.update(JSON.stringify(formData));
hmacsignature = hash.hex();
console.log(hmacsignature)
request({
url: 'https://sandboxapi.opaycheckout.com/api/v1/international/payment/agreement/query',
method: 'POST',
headers: {
'MerchantId': '281821120675251',
'Authorization': 'Bearer '+hmacsignature
},
json: true,
body: formData
}, function (error, response, body) {
console.log('body: ')
console.log(body)
}
)
curl --location --request POST 'https://sandboxapi.opaycheckout.com/api/v1/international/agreement/query' \
--header 'MerchantId: 281821120675251' \
--header 'Authorization: Bearer 38d469216d845f844dc571e6e2d36359f3b0bd3af011cd5f4cc54f1bd60ab2b652768a85746d8614cdcccb8c8a4d4decb26b2285709ad94fea1b3903e02d429c' \
--header 'Content-Type: application/json' \
--data-raw '{
"agreementId": "test2021_1643349294500"
}'
import com.google.gson.Gson;
import org.apache.commons.codec.binary.Hex;
import javax.crypto.Mac;
import javax.crypto.spec.SecretKeySpec;
import java.io.BufferedReader;
import java.io.InputStreamReader;
import java.io.OutputStream;
import java.net.HttpURLConnection;
import java.net.URL;
import java.nio.charset.StandardCharsets;
import java.util.TreeMap;
import java.util.UUID;
public class BankDebitAgreementIDOnly {
private static final String privateKey = "OPAYPRV1638774******57474";
private static final String endpoint = "https://sandboxapi.opaycheckout.com";
private static final String merchantId = "281821120675251";
public static void main(String[] args) throws Exception {
String addr = endpoint + "/api/v1/international/payment/agreement/query";
Gson gson = new Gson();
TreeMap data = new TreeMap<>();
data.put("agreementId","123321");
String requestBody = gson.toJson(data);
System.out.println("--request:");
System.out.println(requestBody);
String oPaySignature = hmacSHA512(requestBody, privateKey);
System.out.println("--signature:");
System.out.println(oPaySignature);
URL url = new URL(addr);
HttpURLConnection con = (HttpURLConnection)url.openConnection();
con.setRequestMethod("POST");
con.setRequestProperty("Content-Type", "application/json; utf-8");
con.setRequestProperty("Authorization", "Bearer "+oPaySignature);
con.setRequestProperty("MerchantId", merchantId);
con.setDoOutput(true);
OutputStream os = con.getOutputStream();
byte[] input = requestBody.getBytes(StandardCharsets.UTF_8);
os.write(input, 0, input.length);
BufferedReader br = new BufferedReader(new InputStreamReader(con.getInputStream(), StandardCharsets.UTF_8));
StringBuilder response = new StringBuilder();
String responseLine = null;
while ((responseLine = br.readLine()) != null) {
response.append(responseLine.trim());
}
System.out.println("--response:");
System.out.println(response.toString());
//close your stream and connection
}
public static String hmacSHA512(final String data, final String secureKey) throws Exception{
byte[] bytesKey = secureKey.getBytes();
final SecretKeySpec secretKey = new SecretKeySpec(bytesKey, "HmacSHA512");
Mac mac = Mac.getInstance("HmacSHA512");
mac.init(secretKey);
final byte[] macData = mac.doFinal(data.getBytes());
byte[] hex = new Hex().encode(macData);
return new String(hex, StandardCharsets.UTF_8);
}
}
Query Agreement Response
-Response Parameters:
the parameters contained in the response received whenever you call the query agreement API as a JSON Object.
{
"code":"00000",
"message":"SUCCESSFUL",
"data":{
"agreementId":"104123398",
"expiredTime":"1653988447",
"createTime":"1653988447",
"agreementStatus":"SUCCESS",
"userId":"123",
"bankDetails":{
"cardNumber":"123****",
"cardBrand":"card brand",
"bankName":"eg bank",
"cardType":"card type",
"expiryYear":"2022",
"expiryMonth":"12",
}
}
}
-Here is a detailed description for the parameters received in the response:
| Parameter | type | Description | example | |
|---|---|---|---|---|
| agreementId | String |
Agreement Id. | 123321 | |
| expiredTime | String |
Agreement expire time | 1653988447 | |
| createTime | String |
Agreement create time | 1653988447 | |
| agreementStatus | String |
[INITIAL, EXPIRED, SUCCESS, FAIL, CLOSE] | SUCCESS | |
| userId | String |
user id | 123 | |
| bankDetails | ||||
| cardNumber | string |
card number | 512345*********0008 | |
| cardBrand | string |
card brand | MASTERCARD | |
| bankName | string |
bank name | ***************BANK | |
| cardType | string |
card type | CREDIT | |
| expiryYear | string |
expire year | 2022 | |
| expiryMonth | string |
expire month | 12 | |
Error Handling
After submitting an API call to OPay, you receive a response back to inform you that
your request was received and processed. A successful OPay API should return a status code 00,
meanwhile, in a situation where any payment processing error occurred, you will receive an error code with a
message to describe the reason of the error. A sample error response can be found below.
{
"code": "05057",
"message": "The agreementId already exists."
}
Depending on the HTTP status code of the response, you should build some logic to handle any errors that a request or the system may return. A list of possible potential error codes that you may receive can be found below. A full list of all possible error codes can be found in the Error Codes section.
| Error Code | Error Message |
|---|---|
| 02000 | authentication failed. |
| 02001 | request parameters not valid. |
| 02003 | payMethod not support. |
| 02004 | the payment reference already exists. |
| 02002 | merchant not configured with this function. |
| 05057 | The agreementId does not exist |
| 05058 | The agreementId already exists |
| 05059 | The agreementId is invalid! |
| 05060 | The agreement has expired |
| 05061 | The agreement status is unavailable |
| 02007 | merchant not available. |
| 50003 | service not available, please try again. |
| 5023 | The %s parameter is required |
| 5024 | The value of enable3DS must be true |
