Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance. Project price only 1 $
You can buy this project and download/modify it how often you want.
Java SDK to be used with a First Data Gateway account. This SDK has been created and packaged to offer the easiest way to integrate your application into the First Data Gateway. This SDK gives you the ability to run transactions such as sales, preauthorizations, postauthorizations, credits, voids, and returns; transaction inquiries; setting up scheduled payments and much more.
/*
* Payment Gateway API Specification.
* The documentation here is designed to provide all of the technical guidance required to consume and integrate with our APIs for payment processing. To learn more about our APIs please visit https://docs.firstdata.com/org/gateway.
*
* The version of the OpenAPI document: 21.2.0.20210406.001
*
*
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
* https://openapi-generator.tech
* Do not edit the class manually.
*/
package com.github.GBSEcom.api;
import com.github.GBSEcom.client.ApiCallback;
import com.github.GBSEcom.client.ApiClient;
import com.github.GBSEcom.client.ApiException;
import com.github.GBSEcom.client.ApiResponse;
import com.github.GBSEcom.client.Configuration;
import com.github.GBSEcom.client.Pair;
import com.github.GBSEcom.client.ProgressRequestBody;
import com.github.GBSEcom.client.ProgressResponseBody;
import com.google.gson.reflect.TypeToken;
import java.io.IOException;
import com.github.GBSEcom.model.ErrorResponse;
import com.github.GBSEcom.model.PaymentUrlDetailResponse;
import com.github.GBSEcom.model.PaymentUrlRequest;
import com.github.GBSEcom.model.PaymentUrlResponse;
import java.lang.reflect.Type;
import java.util.ArrayList;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
public class PaymentUrlApi {
private ApiClient localVarApiClient;
public PaymentUrlApi() {
this(Configuration.getDefaultApiClient());
}
public PaymentUrlApi(ApiClient apiClient) {
this.localVarApiClient = apiClient;
}
public ApiClient getApiClient() {
return localVarApiClient;
}
public void setApiClient(ApiClient apiClient) {
this.localVarApiClient = apiClient;
}
/**
* Build call for createPaymentUrl
* @param contentType Content type. (required)
* @param clientRequestId A client-generated ID for request tracking and signature creation, unique per request. This is also used for idempotency control. We recommend 128-bit UUID format. (required)
* @param apiKey Key given to merchant after boarding associating their requests with the appropriate app in Apigee. (required)
* @param timestamp Epoch timestamp in milliseconds in the request from a client system. Used for Message Signature generation and time limit (5 mins). (required)
* @param paymentUrlRequest Accepted request type: PaymentUrlRequest. (required)
* @param messageSignature Used to ensure the request has not been tampered with during transmission. The Message-Signature is the Base64 encoded HMAC hash (SHA256 algorithm with the API Secret as the key.) For more information, refer to the supporting documentation on the Developer Portal. (optional)
* @param region Indicates the region where the client wants the transaction to be processed. This will override the default processing region identified for the client. Available options are argentina, brazil, germany, india and northamerica. Region specific store setup and APIGEE boarding is required in order to use an alternate region for processing. (optional)
* @param _callback Callback for upload/download progress
* @return Call to execute
* @throws ApiException If fail to serialize the request body object
Status Code
Description
Response Headers
200
Success response.
-
400
The request cannot be validated.
-
401
The request was unauthorized.
-
404
The requested resource doesn't exist.
-
409
There was a problem communicating with the endpoint.
-
415
Format that is not supported by the server for the HTTP method.
-
500
An unexpected internal server error occurred.
-
*/
public okhttp3.Call createPaymentUrlCall(String contentType, String clientRequestId, String apiKey, Long timestamp, PaymentUrlRequest paymentUrlRequest, String messageSignature, String region, final ApiCallback _callback) throws ApiException {
Object localVarPostBody = paymentUrlRequest;
// create path and map variables
String localVarPath = "/payment-url";
List localVarQueryParams = new ArrayList();
List localVarCollectionQueryParams = new ArrayList();
Map localVarHeaderParams = new HashMap();
if (contentType != null) {
localVarHeaderParams.put("Content-Type", localVarApiClient.parameterToString(contentType));
}
if (clientRequestId != null) {
localVarHeaderParams.put("Client-Request-Id", localVarApiClient.parameterToString(clientRequestId));
}
if (apiKey != null) {
localVarHeaderParams.put("Api-Key", localVarApiClient.parameterToString(apiKey));
}
if (timestamp != null) {
localVarHeaderParams.put("Timestamp", localVarApiClient.parameterToString(timestamp));
}
if (messageSignature != null) {
localVarHeaderParams.put("Message-Signature", localVarApiClient.parameterToString(messageSignature));
}
if (region != null) {
localVarHeaderParams.put("Region", localVarApiClient.parameterToString(region));
}
Map localVarFormParams = new HashMap();
final String[] localVarAccepts = {
"application/json"
};
final String localVarAccept = localVarApiClient.selectHeaderAccept(localVarAccepts);
if (localVarAccept != null) {
localVarHeaderParams.put("Accept", localVarAccept);
}
final String[] localVarContentTypes = {
"application/json"
};
final String localVarContentType = localVarApiClient.selectHeaderContentType(localVarContentTypes);
localVarHeaderParams.put("Content-Type", localVarContentType);
String[] localVarAuthNames = new String[] { };
return localVarApiClient.buildCall(localVarPath, "POST", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarFormParams, localVarAuthNames, _callback);
}
@SuppressWarnings("rawtypes")
private okhttp3.Call createPaymentUrlValidateBeforeCall(String contentType, String clientRequestId, String apiKey, Long timestamp, PaymentUrlRequest paymentUrlRequest, String messageSignature, String region, final ApiCallback _callback) throws ApiException {
// verify the required parameter 'contentType' is set
if (contentType == null) {
throw new ApiException("Missing the required parameter 'contentType' when calling createPaymentUrl(Async)");
}
// verify the required parameter 'clientRequestId' is set
if (clientRequestId == null) {
throw new ApiException("Missing the required parameter 'clientRequestId' when calling createPaymentUrl(Async)");
}
// verify the required parameter 'apiKey' is set
if (apiKey == null) {
throw new ApiException("Missing the required parameter 'apiKey' when calling createPaymentUrl(Async)");
}
// verify the required parameter 'timestamp' is set
if (timestamp == null) {
throw new ApiException("Missing the required parameter 'timestamp' when calling createPaymentUrl(Async)");
}
// verify the required parameter 'paymentUrlRequest' is set
if (paymentUrlRequest == null) {
throw new ApiException("Missing the required parameter 'paymentUrlRequest' when calling createPaymentUrl(Async)");
}
okhttp3.Call localVarCall = createPaymentUrlCall(contentType, clientRequestId, apiKey, timestamp, paymentUrlRequest, messageSignature, region, _callback);
return localVarCall;
}
/**
* Create a payment URL.
* Use this to generate an embedding payment link.
* @param contentType Content type. (required)
* @param clientRequestId A client-generated ID for request tracking and signature creation, unique per request. This is also used for idempotency control. We recommend 128-bit UUID format. (required)
* @param apiKey Key given to merchant after boarding associating their requests with the appropriate app in Apigee. (required)
* @param timestamp Epoch timestamp in milliseconds in the request from a client system. Used for Message Signature generation and time limit (5 mins). (required)
* @param paymentUrlRequest Accepted request type: PaymentUrlRequest. (required)
* @param messageSignature Used to ensure the request has not been tampered with during transmission. The Message-Signature is the Base64 encoded HMAC hash (SHA256 algorithm with the API Secret as the key.) For more information, refer to the supporting documentation on the Developer Portal. (optional)
* @param region Indicates the region where the client wants the transaction to be processed. This will override the default processing region identified for the client. Available options are argentina, brazil, germany, india and northamerica. Region specific store setup and APIGEE boarding is required in order to use an alternate region for processing. (optional)
* @return PaymentUrlResponse
* @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body
Status Code
Description
Response Headers
200
Success response.
-
400
The request cannot be validated.
-
401
The request was unauthorized.
-
404
The requested resource doesn't exist.
-
409
There was a problem communicating with the endpoint.
-
415
Format that is not supported by the server for the HTTP method.
-
500
An unexpected internal server error occurred.
-
*/
public PaymentUrlResponse createPaymentUrl(String contentType, String clientRequestId, String apiKey, Long timestamp, PaymentUrlRequest paymentUrlRequest, String messageSignature, String region) throws ApiException {
ApiResponse localVarResp = createPaymentUrlWithHttpInfo(contentType, clientRequestId, apiKey, timestamp, paymentUrlRequest, messageSignature, region);
return localVarResp.getData();
}
/**
* Create a payment URL.
* Use this to generate an embedding payment link.
* @param contentType Content type. (required)
* @param clientRequestId A client-generated ID for request tracking and signature creation, unique per request. This is also used for idempotency control. We recommend 128-bit UUID format. (required)
* @param apiKey Key given to merchant after boarding associating their requests with the appropriate app in Apigee. (required)
* @param timestamp Epoch timestamp in milliseconds in the request from a client system. Used for Message Signature generation and time limit (5 mins). (required)
* @param paymentUrlRequest Accepted request type: PaymentUrlRequest. (required)
* @param messageSignature Used to ensure the request has not been tampered with during transmission. The Message-Signature is the Base64 encoded HMAC hash (SHA256 algorithm with the API Secret as the key.) For more information, refer to the supporting documentation on the Developer Portal. (optional)
* @param region Indicates the region where the client wants the transaction to be processed. This will override the default processing region identified for the client. Available options are argentina, brazil, germany, india and northamerica. Region specific store setup and APIGEE boarding is required in order to use an alternate region for processing. (optional)
* @return ApiResponse<PaymentUrlResponse>
* @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body
Status Code
Description
Response Headers
200
Success response.
-
400
The request cannot be validated.
-
401
The request was unauthorized.
-
404
The requested resource doesn't exist.
-
409
There was a problem communicating with the endpoint.
-
415
Format that is not supported by the server for the HTTP method.
-
500
An unexpected internal server error occurred.
-
*/
public ApiResponse createPaymentUrlWithHttpInfo(String contentType, String clientRequestId, String apiKey, Long timestamp, PaymentUrlRequest paymentUrlRequest, String messageSignature, String region) throws ApiException {
okhttp3.Call localVarCall = createPaymentUrlValidateBeforeCall(contentType, clientRequestId, apiKey, timestamp, paymentUrlRequest, messageSignature, region, null);
Type localVarReturnType = new TypeToken(){}.getType();
return localVarApiClient.execute(localVarCall, localVarReturnType);
}
/**
* Create a payment URL. (asynchronously)
* Use this to generate an embedding payment link.
* @param contentType Content type. (required)
* @param clientRequestId A client-generated ID for request tracking and signature creation, unique per request. This is also used for idempotency control. We recommend 128-bit UUID format. (required)
* @param apiKey Key given to merchant after boarding associating their requests with the appropriate app in Apigee. (required)
* @param timestamp Epoch timestamp in milliseconds in the request from a client system. Used for Message Signature generation and time limit (5 mins). (required)
* @param paymentUrlRequest Accepted request type: PaymentUrlRequest. (required)
* @param messageSignature Used to ensure the request has not been tampered with during transmission. The Message-Signature is the Base64 encoded HMAC hash (SHA256 algorithm with the API Secret as the key.) For more information, refer to the supporting documentation on the Developer Portal. (optional)
* @param region Indicates the region where the client wants the transaction to be processed. This will override the default processing region identified for the client. Available options are argentina, brazil, germany, india and northamerica. Region specific store setup and APIGEE boarding is required in order to use an alternate region for processing. (optional)
* @param _callback The callback to be executed when the API call finishes
* @return The request call
* @throws ApiException If fail to process the API call, e.g. serializing the request body object
Status Code
Description
Response Headers
200
Success response.
-
400
The request cannot be validated.
-
401
The request was unauthorized.
-
404
The requested resource doesn't exist.
-
409
There was a problem communicating with the endpoint.
-
415
Format that is not supported by the server for the HTTP method.
-
500
An unexpected internal server error occurred.
-
*/
public okhttp3.Call createPaymentUrlAsync(String contentType, String clientRequestId, String apiKey, Long timestamp, PaymentUrlRequest paymentUrlRequest, String messageSignature, String region, final ApiCallback _callback) throws ApiException {
okhttp3.Call localVarCall = createPaymentUrlValidateBeforeCall(contentType, clientRequestId, apiKey, timestamp, paymentUrlRequest, messageSignature, region, _callback);
Type localVarReturnType = new TypeToken(){}.getType();
localVarApiClient.executeAsync(localVarCall, localVarReturnType, _callback);
return localVarCall;
}
/**
* Build call for deletePaymentUrl
* @param contentType Content type. (required)
* @param clientRequestId A client-generated ID for request tracking and signature creation, unique per request. This is also used for idempotency control. We recommend 128-bit UUID format. (required)
* @param apiKey Key given to merchant after boarding associating their requests with the appropriate app in Apigee. (required)
* @param timestamp Epoch timestamp in milliseconds in the request from a client system. Used for Message Signature generation and time limit (5 mins). (required)
* @param messageSignature Used to ensure the request has not been tampered with during transmission. The Message-Signature is the Base64 encoded HMAC hash (SHA256 algorithm with the API Secret as the key.) For more information, refer to the supporting documentation on the Developer Portal. (optional)
* @param region Indicates the region where the client wants the transaction to be processed. This will override the default processing region identified for the client. Available options are argentina, brazil, germany, india and northamerica. Region specific store setup and APIGEE boarding is required in order to use an alternate region for processing. (optional)
* @param storeId An optional outlet ID for clients that support multiple stores in the same developer app. (optional)
* @param transactionId Gateway transaction identifier as returned in the parameter ipgTransactionId or merchantTransactionId. (optional)
* @param orderId Gateway order identifier as returned in the parameter orderId. (optional)
* @param paymentUrlId The ID code from the payment URL. (optional)
* @param transactionTime The transaction time in seconds since epoch. (optional)
* @param _callback Callback for upload/download progress
* @return Call to execute
* @throws ApiException If fail to serialize the request body object
Status Code
Description
Response Headers
200
Success response.
-
400
The request cannot be validated.
-
401
The request was unauthorized.
-
404
The requested resource doesn't exist.
-
409
There was a problem communicating with the endpoint.
-
415
Format that is not supported by the server for the HTTP method.
-
500
An unexpected internal server error occurred.
-
*/
public okhttp3.Call deletePaymentUrlCall(String contentType, String clientRequestId, String apiKey, Long timestamp, String messageSignature, String region, String storeId, String transactionId, String orderId, String paymentUrlId, String transactionTime, final ApiCallback _callback) throws ApiException {
Object localVarPostBody = null;
// create path and map variables
String localVarPath = "/payment-url";
List localVarQueryParams = new ArrayList();
List localVarCollectionQueryParams = new ArrayList();
if (storeId != null) {
localVarQueryParams.addAll(localVarApiClient.parameterToPair("storeId", storeId));
}
if (transactionId != null) {
localVarQueryParams.addAll(localVarApiClient.parameterToPair("transactionId", transactionId));
}
if (orderId != null) {
localVarQueryParams.addAll(localVarApiClient.parameterToPair("orderId", orderId));
}
if (paymentUrlId != null) {
localVarQueryParams.addAll(localVarApiClient.parameterToPair("paymentUrlId", paymentUrlId));
}
if (transactionTime != null) {
localVarQueryParams.addAll(localVarApiClient.parameterToPair("transactionTime", transactionTime));
}
Map localVarHeaderParams = new HashMap();
if (contentType != null) {
localVarHeaderParams.put("Content-Type", localVarApiClient.parameterToString(contentType));
}
if (clientRequestId != null) {
localVarHeaderParams.put("Client-Request-Id", localVarApiClient.parameterToString(clientRequestId));
}
if (apiKey != null) {
localVarHeaderParams.put("Api-Key", localVarApiClient.parameterToString(apiKey));
}
if (timestamp != null) {
localVarHeaderParams.put("Timestamp", localVarApiClient.parameterToString(timestamp));
}
if (messageSignature != null) {
localVarHeaderParams.put("Message-Signature", localVarApiClient.parameterToString(messageSignature));
}
if (region != null) {
localVarHeaderParams.put("Region", localVarApiClient.parameterToString(region));
}
Map localVarFormParams = new HashMap();
final String[] localVarAccepts = {
"application/json"
};
final String localVarAccept = localVarApiClient.selectHeaderAccept(localVarAccepts);
if (localVarAccept != null) {
localVarHeaderParams.put("Accept", localVarAccept);
}
final String[] localVarContentTypes = {
};
final String localVarContentType = localVarApiClient.selectHeaderContentType(localVarContentTypes);
localVarHeaderParams.put("Content-Type", localVarContentType);
String[] localVarAuthNames = new String[] { };
return localVarApiClient.buildCall(localVarPath, "DELETE", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarFormParams, localVarAuthNames, _callback);
}
@SuppressWarnings("rawtypes")
private okhttp3.Call deletePaymentUrlValidateBeforeCall(String contentType, String clientRequestId, String apiKey, Long timestamp, String messageSignature, String region, String storeId, String transactionId, String orderId, String paymentUrlId, String transactionTime, final ApiCallback _callback) throws ApiException {
// verify the required parameter 'contentType' is set
if (contentType == null) {
throw new ApiException("Missing the required parameter 'contentType' when calling deletePaymentUrl(Async)");
}
// verify the required parameter 'clientRequestId' is set
if (clientRequestId == null) {
throw new ApiException("Missing the required parameter 'clientRequestId' when calling deletePaymentUrl(Async)");
}
// verify the required parameter 'apiKey' is set
if (apiKey == null) {
throw new ApiException("Missing the required parameter 'apiKey' when calling deletePaymentUrl(Async)");
}
// verify the required parameter 'timestamp' is set
if (timestamp == null) {
throw new ApiException("Missing the required parameter 'timestamp' when calling deletePaymentUrl(Async)");
}
okhttp3.Call localVarCall = deletePaymentUrlCall(contentType, clientRequestId, apiKey, timestamp, messageSignature, region, storeId, transactionId, orderId, paymentUrlId, transactionTime, _callback);
return localVarCall;
}
/**
* Delete a payment URL.
* Use this to delete an embedding payment link.
* @param contentType Content type. (required)
* @param clientRequestId A client-generated ID for request tracking and signature creation, unique per request. This is also used for idempotency control. We recommend 128-bit UUID format. (required)
* @param apiKey Key given to merchant after boarding associating their requests with the appropriate app in Apigee. (required)
* @param timestamp Epoch timestamp in milliseconds in the request from a client system. Used for Message Signature generation and time limit (5 mins). (required)
* @param messageSignature Used to ensure the request has not been tampered with during transmission. The Message-Signature is the Base64 encoded HMAC hash (SHA256 algorithm with the API Secret as the key.) For more information, refer to the supporting documentation on the Developer Portal. (optional)
* @param region Indicates the region where the client wants the transaction to be processed. This will override the default processing region identified for the client. Available options are argentina, brazil, germany, india and northamerica. Region specific store setup and APIGEE boarding is required in order to use an alternate region for processing. (optional)
* @param storeId An optional outlet ID for clients that support multiple stores in the same developer app. (optional)
* @param transactionId Gateway transaction identifier as returned in the parameter ipgTransactionId or merchantTransactionId. (optional)
* @param orderId Gateway order identifier as returned in the parameter orderId. (optional)
* @param paymentUrlId The ID code from the payment URL. (optional)
* @param transactionTime The transaction time in seconds since epoch. (optional)
* @return PaymentUrlResponse
* @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body
Status Code
Description
Response Headers
200
Success response.
-
400
The request cannot be validated.
-
401
The request was unauthorized.
-
404
The requested resource doesn't exist.
-
409
There was a problem communicating with the endpoint.
-
415
Format that is not supported by the server for the HTTP method.
-
500
An unexpected internal server error occurred.
-
*/
public PaymentUrlResponse deletePaymentUrl(String contentType, String clientRequestId, String apiKey, Long timestamp, String messageSignature, String region, String storeId, String transactionId, String orderId, String paymentUrlId, String transactionTime) throws ApiException {
ApiResponse localVarResp = deletePaymentUrlWithHttpInfo(contentType, clientRequestId, apiKey, timestamp, messageSignature, region, storeId, transactionId, orderId, paymentUrlId, transactionTime);
return localVarResp.getData();
}
/**
* Delete a payment URL.
* Use this to delete an embedding payment link.
* @param contentType Content type. (required)
* @param clientRequestId A client-generated ID for request tracking and signature creation, unique per request. This is also used for idempotency control. We recommend 128-bit UUID format. (required)
* @param apiKey Key given to merchant after boarding associating their requests with the appropriate app in Apigee. (required)
* @param timestamp Epoch timestamp in milliseconds in the request from a client system. Used for Message Signature generation and time limit (5 mins). (required)
* @param messageSignature Used to ensure the request has not been tampered with during transmission. The Message-Signature is the Base64 encoded HMAC hash (SHA256 algorithm with the API Secret as the key.) For more information, refer to the supporting documentation on the Developer Portal. (optional)
* @param region Indicates the region where the client wants the transaction to be processed. This will override the default processing region identified for the client. Available options are argentina, brazil, germany, india and northamerica. Region specific store setup and APIGEE boarding is required in order to use an alternate region for processing. (optional)
* @param storeId An optional outlet ID for clients that support multiple stores in the same developer app. (optional)
* @param transactionId Gateway transaction identifier as returned in the parameter ipgTransactionId or merchantTransactionId. (optional)
* @param orderId Gateway order identifier as returned in the parameter orderId. (optional)
* @param paymentUrlId The ID code from the payment URL. (optional)
* @param transactionTime The transaction time in seconds since epoch. (optional)
* @return ApiResponse<PaymentUrlResponse>
* @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body
Status Code
Description
Response Headers
200
Success response.
-
400
The request cannot be validated.
-
401
The request was unauthorized.
-
404
The requested resource doesn't exist.
-
409
There was a problem communicating with the endpoint.
-
415
Format that is not supported by the server for the HTTP method.
-
500
An unexpected internal server error occurred.
-
*/
public ApiResponse deletePaymentUrlWithHttpInfo(String contentType, String clientRequestId, String apiKey, Long timestamp, String messageSignature, String region, String storeId, String transactionId, String orderId, String paymentUrlId, String transactionTime) throws ApiException {
okhttp3.Call localVarCall = deletePaymentUrlValidateBeforeCall(contentType, clientRequestId, apiKey, timestamp, messageSignature, region, storeId, transactionId, orderId, paymentUrlId, transactionTime, null);
Type localVarReturnType = new TypeToken(){}.getType();
return localVarApiClient.execute(localVarCall, localVarReturnType);
}
/**
* Delete a payment URL. (asynchronously)
* Use this to delete an embedding payment link.
* @param contentType Content type. (required)
* @param clientRequestId A client-generated ID for request tracking and signature creation, unique per request. This is also used for idempotency control. We recommend 128-bit UUID format. (required)
* @param apiKey Key given to merchant after boarding associating their requests with the appropriate app in Apigee. (required)
* @param timestamp Epoch timestamp in milliseconds in the request from a client system. Used for Message Signature generation and time limit (5 mins). (required)
* @param messageSignature Used to ensure the request has not been tampered with during transmission. The Message-Signature is the Base64 encoded HMAC hash (SHA256 algorithm with the API Secret as the key.) For more information, refer to the supporting documentation on the Developer Portal. (optional)
* @param region Indicates the region where the client wants the transaction to be processed. This will override the default processing region identified for the client. Available options are argentina, brazil, germany, india and northamerica. Region specific store setup and APIGEE boarding is required in order to use an alternate region for processing. (optional)
* @param storeId An optional outlet ID for clients that support multiple stores in the same developer app. (optional)
* @param transactionId Gateway transaction identifier as returned in the parameter ipgTransactionId or merchantTransactionId. (optional)
* @param orderId Gateway order identifier as returned in the parameter orderId. (optional)
* @param paymentUrlId The ID code from the payment URL. (optional)
* @param transactionTime The transaction time in seconds since epoch. (optional)
* @param _callback The callback to be executed when the API call finishes
* @return The request call
* @throws ApiException If fail to process the API call, e.g. serializing the request body object
Status Code
Description
Response Headers
200
Success response.
-
400
The request cannot be validated.
-
401
The request was unauthorized.
-
404
The requested resource doesn't exist.
-
409
There was a problem communicating with the endpoint.
-
415
Format that is not supported by the server for the HTTP method.
-
500
An unexpected internal server error occurred.
-
*/
public okhttp3.Call deletePaymentUrlAsync(String contentType, String clientRequestId, String apiKey, Long timestamp, String messageSignature, String region, String storeId, String transactionId, String orderId, String paymentUrlId, String transactionTime, final ApiCallback _callback) throws ApiException {
okhttp3.Call localVarCall = deletePaymentUrlValidateBeforeCall(contentType, clientRequestId, apiKey, timestamp, messageSignature, region, storeId, transactionId, orderId, paymentUrlId, transactionTime, _callback);
Type localVarReturnType = new TypeToken(){}.getType();
localVarApiClient.executeAsync(localVarCall, localVarReturnType, _callback);
return localVarCall;
}
/**
* Build call for paymentUrlDetail
* @param contentType Content type. (required)
* @param clientRequestId A client-generated ID for request tracking and signature creation, unique per request. This is also used for idempotency control. We recommend 128-bit UUID format. (required)
* @param apiKey Key given to merchant after boarding associating their requests with the appropriate app in Apigee. (required)
* @param timestamp Epoch timestamp in milliseconds in the request from a client system. Used for Message Signature generation and time limit (5 mins). (required)
* @param fromDate The start date for payment URL in seconds since epoch. (required)
* @param toDate The end date for payment URL search query in seconds since epoch. (required)
* @param messageSignature Used to ensure the request has not been tampered with during transmission. The Message-Signature is the Base64 encoded HMAC hash (SHA256 algorithm with the API Secret as the key.) For more information, refer to the supporting documentation on the Developer Portal. (optional)
* @param region Indicates the region where the client wants the transaction to be processed. This will override the default processing region identified for the client. Available options are argentina, brazil, germany, india and northamerica. Region specific store setup and APIGEE boarding is required in order to use an alternate region for processing. (optional)
* @param storeId An optional outlet ID for clients that support multiple stores in the same developer app. (optional)
* @param orderId Gateway order identifier as returned in the parameter orderId. (optional)
* @param merchantTransactionId Gateway merchant identifier as returned in the parameter merchantTransactionId. (optional)
* @param status The status of payment URL. (optional)
* @param _callback Callback for upload/download progress
* @return Call to execute
* @throws ApiException If fail to serialize the request body object
Status Code
Description
Response Headers
200
Success response.
-
400
The request cannot be validated.
-
401
The request was unauthorized.
-
404
The requested resource doesn't exist.
-
409
There was a problem communicating with the endpoint.
-
415
Format that is not supported by the server for the HTTP method.
-
500
An unexpected internal server error occurred.
-
*/
public okhttp3.Call paymentUrlDetailCall(String contentType, String clientRequestId, String apiKey, Long timestamp, String fromDate, String toDate, String messageSignature, String region, String storeId, String orderId, String merchantTransactionId, String status, final ApiCallback _callback) throws ApiException {
Object localVarPostBody = null;
// create path and map variables
String localVarPath = "/payment-url";
List localVarQueryParams = new ArrayList();
List localVarCollectionQueryParams = new ArrayList();
if (storeId != null) {
localVarQueryParams.addAll(localVarApiClient.parameterToPair("storeId", storeId));
}
if (orderId != null) {
localVarQueryParams.addAll(localVarApiClient.parameterToPair("orderId", orderId));
}
if (merchantTransactionId != null) {
localVarQueryParams.addAll(localVarApiClient.parameterToPair("merchantTransactionId", merchantTransactionId));
}
if (fromDate != null) {
localVarQueryParams.addAll(localVarApiClient.parameterToPair("fromDate", fromDate));
}
if (toDate != null) {
localVarQueryParams.addAll(localVarApiClient.parameterToPair("toDate", toDate));
}
if (status != null) {
localVarQueryParams.addAll(localVarApiClient.parameterToPair("status", status));
}
Map localVarHeaderParams = new HashMap();
if (contentType != null) {
localVarHeaderParams.put("Content-Type", localVarApiClient.parameterToString(contentType));
}
if (clientRequestId != null) {
localVarHeaderParams.put("Client-Request-Id", localVarApiClient.parameterToString(clientRequestId));
}
if (apiKey != null) {
localVarHeaderParams.put("Api-Key", localVarApiClient.parameterToString(apiKey));
}
if (timestamp != null) {
localVarHeaderParams.put("Timestamp", localVarApiClient.parameterToString(timestamp));
}
if (messageSignature != null) {
localVarHeaderParams.put("Message-Signature", localVarApiClient.parameterToString(messageSignature));
}
if (region != null) {
localVarHeaderParams.put("Region", localVarApiClient.parameterToString(region));
}
Map localVarFormParams = new HashMap();
final String[] localVarAccepts = {
"application/json"
};
final String localVarAccept = localVarApiClient.selectHeaderAccept(localVarAccepts);
if (localVarAccept != null) {
localVarHeaderParams.put("Accept", localVarAccept);
}
final String[] localVarContentTypes = {
};
final String localVarContentType = localVarApiClient.selectHeaderContentType(localVarContentTypes);
localVarHeaderParams.put("Content-Type", localVarContentType);
String[] localVarAuthNames = new String[] { };
return localVarApiClient.buildCall(localVarPath, "GET", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarFormParams, localVarAuthNames, _callback);
}
@SuppressWarnings("rawtypes")
private okhttp3.Call paymentUrlDetailValidateBeforeCall(String contentType, String clientRequestId, String apiKey, Long timestamp, String fromDate, String toDate, String messageSignature, String region, String storeId, String orderId, String merchantTransactionId, String status, final ApiCallback _callback) throws ApiException {
// verify the required parameter 'contentType' is set
if (contentType == null) {
throw new ApiException("Missing the required parameter 'contentType' when calling paymentUrlDetail(Async)");
}
// verify the required parameter 'clientRequestId' is set
if (clientRequestId == null) {
throw new ApiException("Missing the required parameter 'clientRequestId' when calling paymentUrlDetail(Async)");
}
// verify the required parameter 'apiKey' is set
if (apiKey == null) {
throw new ApiException("Missing the required parameter 'apiKey' when calling paymentUrlDetail(Async)");
}
// verify the required parameter 'timestamp' is set
if (timestamp == null) {
throw new ApiException("Missing the required parameter 'timestamp' when calling paymentUrlDetail(Async)");
}
// verify the required parameter 'fromDate' is set
if (fromDate == null) {
throw new ApiException("Missing the required parameter 'fromDate' when calling paymentUrlDetail(Async)");
}
// verify the required parameter 'toDate' is set
if (toDate == null) {
throw new ApiException("Missing the required parameter 'toDate' when calling paymentUrlDetail(Async)");
}
okhttp3.Call localVarCall = paymentUrlDetailCall(contentType, clientRequestId, apiKey, timestamp, fromDate, toDate, messageSignature, region, storeId, orderId, merchantTransactionId, status, _callback);
return localVarCall;
}
/**
* Retrieve the state of payment URL.
* Use this query to get the current state of an existing paymentURL.
* @param contentType Content type. (required)
* @param clientRequestId A client-generated ID for request tracking and signature creation, unique per request. This is also used for idempotency control. We recommend 128-bit UUID format. (required)
* @param apiKey Key given to merchant after boarding associating their requests with the appropriate app in Apigee. (required)
* @param timestamp Epoch timestamp in milliseconds in the request from a client system. Used for Message Signature generation and time limit (5 mins). (required)
* @param fromDate The start date for payment URL in seconds since epoch. (required)
* @param toDate The end date for payment URL search query in seconds since epoch. (required)
* @param messageSignature Used to ensure the request has not been tampered with during transmission. The Message-Signature is the Base64 encoded HMAC hash (SHA256 algorithm with the API Secret as the key.) For more information, refer to the supporting documentation on the Developer Portal. (optional)
* @param region Indicates the region where the client wants the transaction to be processed. This will override the default processing region identified for the client. Available options are argentina, brazil, germany, india and northamerica. Region specific store setup and APIGEE boarding is required in order to use an alternate region for processing. (optional)
* @param storeId An optional outlet ID for clients that support multiple stores in the same developer app. (optional)
* @param orderId Gateway order identifier as returned in the parameter orderId. (optional)
* @param merchantTransactionId Gateway merchant identifier as returned in the parameter merchantTransactionId. (optional)
* @param status The status of payment URL. (optional)
* @return PaymentUrlDetailResponse
* @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body
Status Code
Description
Response Headers
200
Success response.
-
400
The request cannot be validated.
-
401
The request was unauthorized.
-
404
The requested resource doesn't exist.
-
409
There was a problem communicating with the endpoint.
-
415
Format that is not supported by the server for the HTTP method.
-
500
An unexpected internal server error occurred.
-
*/
public PaymentUrlDetailResponse paymentUrlDetail(String contentType, String clientRequestId, String apiKey, Long timestamp, String fromDate, String toDate, String messageSignature, String region, String storeId, String orderId, String merchantTransactionId, String status) throws ApiException {
ApiResponse localVarResp = paymentUrlDetailWithHttpInfo(contentType, clientRequestId, apiKey, timestamp, fromDate, toDate, messageSignature, region, storeId, orderId, merchantTransactionId, status);
return localVarResp.getData();
}
/**
* Retrieve the state of payment URL.
* Use this query to get the current state of an existing paymentURL.
* @param contentType Content type. (required)
* @param clientRequestId A client-generated ID for request tracking and signature creation, unique per request. This is also used for idempotency control. We recommend 128-bit UUID format. (required)
* @param apiKey Key given to merchant after boarding associating their requests with the appropriate app in Apigee. (required)
* @param timestamp Epoch timestamp in milliseconds in the request from a client system. Used for Message Signature generation and time limit (5 mins). (required)
* @param fromDate The start date for payment URL in seconds since epoch. (required)
* @param toDate The end date for payment URL search query in seconds since epoch. (required)
* @param messageSignature Used to ensure the request has not been tampered with during transmission. The Message-Signature is the Base64 encoded HMAC hash (SHA256 algorithm with the API Secret as the key.) For more information, refer to the supporting documentation on the Developer Portal. (optional)
* @param region Indicates the region where the client wants the transaction to be processed. This will override the default processing region identified for the client. Available options are argentina, brazil, germany, india and northamerica. Region specific store setup and APIGEE boarding is required in order to use an alternate region for processing. (optional)
* @param storeId An optional outlet ID for clients that support multiple stores in the same developer app. (optional)
* @param orderId Gateway order identifier as returned in the parameter orderId. (optional)
* @param merchantTransactionId Gateway merchant identifier as returned in the parameter merchantTransactionId. (optional)
* @param status The status of payment URL. (optional)
* @return ApiResponse<PaymentUrlDetailResponse>
* @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body
Status Code
Description
Response Headers
200
Success response.
-
400
The request cannot be validated.
-
401
The request was unauthorized.
-
404
The requested resource doesn't exist.
-
409
There was a problem communicating with the endpoint.
-
415
Format that is not supported by the server for the HTTP method.
-
500
An unexpected internal server error occurred.
-
*/
public ApiResponse paymentUrlDetailWithHttpInfo(String contentType, String clientRequestId, String apiKey, Long timestamp, String fromDate, String toDate, String messageSignature, String region, String storeId, String orderId, String merchantTransactionId, String status) throws ApiException {
okhttp3.Call localVarCall = paymentUrlDetailValidateBeforeCall(contentType, clientRequestId, apiKey, timestamp, fromDate, toDate, messageSignature, region, storeId, orderId, merchantTransactionId, status, null);
Type localVarReturnType = new TypeToken(){}.getType();
return localVarApiClient.execute(localVarCall, localVarReturnType);
}
/**
* Retrieve the state of payment URL. (asynchronously)
* Use this query to get the current state of an existing paymentURL.
* @param contentType Content type. (required)
* @param clientRequestId A client-generated ID for request tracking and signature creation, unique per request. This is also used for idempotency control. We recommend 128-bit UUID format. (required)
* @param apiKey Key given to merchant after boarding associating their requests with the appropriate app in Apigee. (required)
* @param timestamp Epoch timestamp in milliseconds in the request from a client system. Used for Message Signature generation and time limit (5 mins). (required)
* @param fromDate The start date for payment URL in seconds since epoch. (required)
* @param toDate The end date for payment URL search query in seconds since epoch. (required)
* @param messageSignature Used to ensure the request has not been tampered with during transmission. The Message-Signature is the Base64 encoded HMAC hash (SHA256 algorithm with the API Secret as the key.) For more information, refer to the supporting documentation on the Developer Portal. (optional)
* @param region Indicates the region where the client wants the transaction to be processed. This will override the default processing region identified for the client. Available options are argentina, brazil, germany, india and northamerica. Region specific store setup and APIGEE boarding is required in order to use an alternate region for processing. (optional)
* @param storeId An optional outlet ID for clients that support multiple stores in the same developer app. (optional)
* @param orderId Gateway order identifier as returned in the parameter orderId. (optional)
* @param merchantTransactionId Gateway merchant identifier as returned in the parameter merchantTransactionId. (optional)
* @param status The status of payment URL. (optional)
* @param _callback The callback to be executed when the API call finishes
* @return The request call
* @throws ApiException If fail to process the API call, e.g. serializing the request body object
Status Code
Description
Response Headers
200
Success response.
-
400
The request cannot be validated.
-
401
The request was unauthorized.
-
404
The requested resource doesn't exist.
-
409
There was a problem communicating with the endpoint.
-
415
Format that is not supported by the server for the HTTP method.
