Integration Guide

https://guides.gitbook.io/integrationguide
Admin
This guide provides the information required to integrate with a Payment Gateway and gives a very...
Tokens:120,801
Snippets:1,412
Trust Score:9.8
Update:4 months ago
Show doc for...
Tokens:
Raw
### 3-D Secure Options Example

Source: https://guides.gitbook.io/integrationguide/readme/changelog

Example demonstrating the use of threeDSOptions for 3-D Secure configurations.

```json
{
  "threeDSOptions": {
    "threeDSRequestor": {
      "threeDSRequestorID": "AB12345678",
      "threeDSRequestorName": "MyCompany",
      "threeDSRequestorURL": "https://www.mycompany.com/3ds"
    }
  }
}
```

--------------------------------

### Querying Documentation with HTTP GET

Source: https://guides.gitbook.io/integrationguide/gateway-functionality/payment-methods/qi-digital-transactions/benefits-and-limitations

Demonstrates how to ask dynamic questions about the documentation using an HTTP GET request with the 'ask' query parameter.

```http
GET https://guides.gitbook.io/integrationguide/gateway-functionality/payment-methods/qi-digital-transactions/benefits-and-limitations.md?ask=<question>
```

--------------------------------

### Query Documentation Dynamically

Source: https://guides.gitbook.io/integrationguide/references/code-references/integration-libraries/hosted-payment-page-library

To get additional information not directly on the page, perform an HTTP GET request with the 'ask' query parameter.

```http
GET https://guides.gitbook.io/integrationguide/references/code-references/integration-libraries/hosted-payment-page-library.md?ask=<question>
```

--------------------------------

### Batch Submission Request Example

Source: https://guides.gitbook.io/integrationguide/references/code-references/example-http-requests

This example demonstrates a PUT request to submit a batch of transactions. It includes multipart/mixed content with individual transaction details.

```http
PUT /batch/?validate=0 HTTP/1.1
Authorization: Basic bmljay50dXJuZXI6dGVzdGluZzI=
Host: gateway.example.com
Accept: */*
Content-type: multipart/mixed; charset=UTF-8; boundary=5de63a42507a9
Content-length: 1404

--5de63a42507a9
Content-Id: TX5de63a42507ac
Content-Type: application/x-www-form-urlencoded; charset=UTF-8

merchantID=100001&action=SALE&type=1&currencyCode=826&countryCode=826&amount=680&transactionUnique=5de63a42507ac&orderRef=Test+Transaction&cardNumber=4929+4212+3460+0821&cardExpiryDate=1219&duplicateDelay=0&signature=3cd686fdd40449ef33534baa62732c95fc127ff591fae3b5b611ccb38573ad921d199396e27cffd14faa4f46df8dde310252920fd1b33607b029b9b6ff669e2b

--5de63a42507a9
Content-Id: TX5de63a42af062
Content-Type: application/x-www-form-urlencoded; charset=UTF-8

merchantID=100001&action=SALE&type=1&currencyCode=826&countryCode=826&amount=681&transactionUnique=5de63a42af062&orderRef=Test+Transaction&cardNumber=4929+4212+3460+0821&cardExpiryDate=1219&duplicateDelay=0&signature=55f411d40954be7f7089e84fe489438f09fc1b37c0964e46b0fab8bdcb44e13ed3ea11b9deb9da89a6d7b45133709a126bd3581f6329bf888b83231184597231

--5de63a42507a9
Content-Id: TX5de63a42ca9cd
Content-Type: application/x-www-form-urlencoded; charset=UTF-8

merchantID=100001&action=SALE&type=1&currencyCode=826&countryCode=826&amount=682&transactionUnique=5de63a42ca9cd&orderRef=Test+Transaction&cardNumber=4929+4212+3460+0821&cardExpiryDate=1219&duplicateDelay=0&signature=c296266cb9bc8082957c700da9651d98add176dd8bd62eb3b7098566c7d8e23a3426b776de815e99149c6681978b1addedac762339563732d8a449b6cca3a3c2

--5de63a42507a9--
```

--------------------------------

### Transaction Request Example (Hosted Integration)

Source: https://guides.gitbook.io/integrationguide/references/code-references/example-http-requests

Example of a transaction request sent to the gateway for hosted integration. Ensure all parameters and the signature are correctly formatted.

```http
HTTP/1.1 200 OK  
POST /hosted/ HTTP/1.1  
Host: gateway.example.com  
Accept: */*  
Content-Length: 314  
Content-Type: application/x-www-form-urlencoded  
	  
merchantID=100001&action=SALE&type=1&currencyCode=826&countryCode=826&amount=680&transactionUnique=5de651c7c5379&orderRef=Test+Transaction&redirectURL=https%3A%2F%2Fmyshop.com&signature=ba12b0766a3412782448f154be15e8f61eea390387b1b23d4688c82c9f28f81df593de5890426546cca365943cc7b5c4897c9721b663a0e17680e1e796f1ad55
```

--------------------------------

### Query Documentation Dynamically

Source: https://guides.gitbook.io/integrationguide/gateway-functionality/features/risk-checking/response-fields

To get more information not directly on the page, perform an HTTP GET request with the 'ask' query parameter. The question should be specific and in natural language.

```HTTP
GET https://guides.gitbook.io/integrationguide/gateway-functionality/features/risk-checking/response-fields.md?ask=<question>
```

--------------------------------

### Hosted Payment Fields Integration Example

Source: https://guides.gitbook.io/integrationguide/references/code-references/example-library-code

This example demonstrates setting up and styling Hosted Payment Fields, integrating with jQuery validator, and tokenizing payment data for direct submission to the Gateway. It includes general and specific styles for the fields.

```html
<html>
<head>
	<!-- Load the jQuery library -->
	<script src="https://code.jquery.com/jquery-3.4.1.min.js" integrity="sha256-CSXorXvZcTkaix6Yvo6HppcZGetbYMGWSFlBw8HfCJo=" crossorigin="anonymous"></script>

	<!-- Load the jQuery Validator plugin -->
	<script src="https://cdn.jsdelivr.net/npm/jquery-validation@1.19.1/dist/jquery.validate.min.js"></script>

	<!-- Load the Hosted Payment Field library -->
	<script src="https://gateway.example.com/sdk/web/v1/js/hostedfields.min.js"></script>

	<!-- General styles -->
	<style>
		body {
			font-size: 14px;
		}

		.form-group {
			margin: 4px 0 15px 0;
		}

		.form-group LABEL {
			display: inline-block;
			max-width: 100%;
			margin-bottom: 5px;
			font-weight: bold;
		}

		.form-control {
			display: block;
			box-sizing: border-box;
			height: 34px;
			width: 400px;
			padding: 6px 12px;
			font-size: 14px;
			color: #555;
			background-color: #fff;
			background-image: none;
			border: 1px solid #ccc;
			border-radius: 4px;
			-webkit-box-shadow: inset 0 1px 1px rgba(0, 0, 0, .075);
			box-shadow: inset 0 1px 1px rgba(0, 0, 0, .075);
			-webkit-transition: border-color ease-in-out .15s, -webkit-box-shadow ease-in-out .15s;
			-o-transition: border-color ease-in-out .15s, box-shadow ease-in-out .15s;
			transition: border-color ease-in-out .15s, box-shadow ease-in-out .15s;
		}

		.form-control.hf-focus {
			border-color: #66afe9;
			outline: 0;
			-webkit-box-shadow: inset 0 1px 1px rgba(0,0,0,.075), 0 0 8px rgba(102,175,233,.6);
			box-shadow: inset 0 1px 1px rgba(0,0,0,.075), 0 0 8px rgba(102,175,233,.6);
		}

		.has-error .form-control.hf-focus {
			border-color: #843534;
			-webkit-box-shadow: inset 0 1px 1px rgba(0,0,0,.075), 0 0 6px #ce8483;
			box-shadow: inset 0 1px 1px rgba(0,0,0,.075), 0 0 6px #ce8483;
		}
	</style>

	<!-- Hosted Field internal styles -->
	<style class="hostedfield">
		/* Grey out when disabled */
		.hostedfield:disabled {
			cursor: not-allowed;
			background-color: #eee;
			opacity: 1;
		}

		/* Change border and text to green when valid */
		.form-control:valid,
		.hostedfield:valid {
			border-color: #28a745 !important;
			color: #28a745 !important;
		}

		/* Change border and text to red when invalid */
		.form-control:invalid,
		.hostedfield:invalid {
			border-color: #a94442 !important;
			color: #a94442 !important;
		}

		/* Change text to light grey when readonly */
		.form-control:readonly,
		.hostedfield:readonly {
			color: lightgrey !important;
		}

		/* Emulate webkit auto fill style */
		.form-control.hf-autofill, .hostedfield.hf-autofill {
			background-color: rgb(250, 255, 189) !important;
			background-image: none !important;
			color: rgb(0, 0, 0) !important;
		}

		/* Add light blue placeholder */
		.form-control::placeholder,
		.hostedfield::placeholder {
			color: lightblue;
		}

		/* Show hovering over the control */
		.form-control:hover,
		.hostedfield:hover {
			font-style: italic;
		}

		/* Style by id (hosted field will have '-hostedfield' appended to the id) */
		#form-card-number, #form-card-number-hostedfield {
			color: darkcyan;
		}

	</style>

	<!-- Hosted Field card-number internal styles -->
	<style class="card-number">

		.hostedfield::placeholder {
			color: orange
		}

	</style>
</head>

<body>
	<!-- tokenise payment data and send directly to the Gateway -->
	<form id="form" method="POST" novalidate="novalidate" lang="en"
		action="https://gateway.example.com/direct/"
		data-hostedform-tokenize='{"#form-customer-name": "customerName"}'>
		<input type="hidden" name="merchantID" value="100001">
		<input type="hidden" name="action" value="SALE">
		<input type="hidden" name="type" value="1">
		<input type="hidden" name="countryCode" value="826">
		<input type="hidden" name="currencyCode" value="826">
		<input type="hidden" name="amount" value="1001">
		<input type="hidden" name="orderRef" value="Test purchase">

```

--------------------------------

### JavaScript Automatic Setup for Hosted Payment Fields

Source: https://guides.gitbook.io/integrationguide/references/code-references/example-library-code

Initializes the payment form using the Hosted Payment Fields library's automatic setup, configuring fields and event listeners for validation and submission.

```javascript
var automatic_setup = true;

		$(document).ready(function () {

			var $form = $('#form');
			// Listen for events on the form to see those sent from the Hosted Payment Fields
			// (For demonstration purposes only)
			$form.on(events);

			if (automatic_setup) {
				///////////////////////////////////////////////////////////////
				// FORM AUTOMATIC SETUP
				///////////////////////////////////////////////////////////////

				var opts = {
					// Auto setup the form creating all hosted fields (default)
					autoSetup: true,

					// Auto validate, tokenise and submit the form (default)
					autoSubmit: true,

					// Optional field configuration (by type)
					fields: {
						any: {
							nativeEvents: true,
						},
						cardNumber: {
							selector: $('#form-card-number'),
							style: 'text-decoration: green wavy underline;',
							stylesheet: $('style.hostedfields, style.card-number')
						}
					}
				};

				try {
					// Create form, automatically creating all child Hosted Payment Fields
					$form.hostedForm(opts);
				} catch(e) {
					showError('Failed to create hosted form: ' + e);
					throw e; // Can't continue with this script
				}

				// Listen for some events from the form thrown by the auto methods
				$form.on({
					// Let jQuery Validator check the form on submission
					'hostedform:presubmit': function (event) {
						console.log('Form submitting');
						return $form.valid();
					},

					// Show form is valid
					'hostedform:valid': function (event) {
						console.log('Form valid');
						return true;
					},

					// Show any validation errors
					'hostedform:invalid': function (event, details) {
						console.log('Form invalid');
						showFieldErrors(details.invalid); return true;
					},

					// Show general error
					'hostedform:error': function (event, details) {
						showError(details.message);
						return true;
					}
				});

				// Use jQuery validator to validate the form
				$form.validate();
				// End of form automatic setup

			} else {
```

--------------------------------

### JavaScript Manual Setup for Hosted Payment Fields

Source: https://guides.gitbook.io/integrationguide/references/code-references/example-library-code

Manually initializes individual hosted fields on the payment form, providing fine-grained control over each field's configuration.

```javascript
				///////////////////////////////////////////////////////////////
				// FORM MANUAL SETUP
				///////////////////////////////////////////////////////////////

				try {
					// Create the card number field with custom options
					$('#form-card-number').hostedField({
						nativeEvents: true,
						style: 'text-decoration: green wavy underline;',
						stylesheet: $('style.hostedfields, style.card-number')
					});

					// Create the remaining hosted fields
					$('.form-control-hosted:input', $form).hostedField({
						nativeEvents: true
					});

				} catch (e) {
					showError('Failed to create hosted fields: ' + e);
					throw e; // Can't continue with this script
				}

				$form.validate({
					// Get the hosted form widget for the submitted form (Form1 only)

```

--------------------------------

### Create Hosted Sale Transaction with jQuery

Source: https://guides.gitbook.io/integrationguide/references/code-references/example-library-code

This example demonstrates how to create a payment form using jQuery to open the Hosted Payment Page in a lightbox. It requires the jQuery and Hosted Payment Page libraries to be loaded.

```php
<html>
  <head>
    <!-- Load the jQuery library -->    
    <script src="https://code.jquery.com/jquery-3.4.1.min.js" integrity="sha256-CSXorXvZcTkaix6Yvo6HppcZGetbYMGWSFlBw8HfCJo=" crossorigin="anonymous"></script>  
  
    <!-- Load the Hosted Payment Page library -->  
    <script src="https://gateway.example.com/sdk/web/v1/js/hostedforms.min.js"></script>  
  </head>  
  <body>  
    <!— Pay button placeholder -->  
    <div id="paynow"></div>  
    <script>  
        // Create a new Hosted Form object which will render a payment button which will load  
        // the Hosted Payment Pageo load into a modal overlay over this page.

        // The request can be provided from your server.  
        var req = {  
          merchantID: '100001',
          action: 'SALE',
          type: '1',
          currencyCode: '826',
          countryCode: '826',
          amount: '1001',
          orderRef: 'Test purchase',
          redirectURL: 'https://www.merchant.com/payment/',
          signature: '07599ef4cdb2e26cb2bf34a9c65190a7ce82494bc1df144c3bb0d20ee2655d8278dc663b2b0421ef12b8f081e821151bb4c644277c5d65b5523a96539b53b5aa',
        };

        var data = {  
          id: 'my-payment-form',
          url: 'https://gateway.example.com/hosted/modal/',
          modal: true,
          data: req,
          submit: {  
            type: 'button',
            label: 'Pay <i>Now</i>'
          }
        };

        var form = $('#paynow').hostedForm(data);
    </script>  
  </body>  
</html>  
```

--------------------------------

### Example Transaction Data

Source: https://guides.gitbook.io/integrationguide/references/feature-references/sample-signature-calculation

An example array representing transaction details before signing.

```php
$tran = array (
'merchantID' => '100001',
'action' => 'SALE',
'type' => '1',
'currencyCode' => '826'
'countryCode' => '826',
'amount' => '2691',
'transactionUnique' => '55f025addd3c2',
'orderRef' => 'Signature Test',
'cardNumber' => '4929 4212 3460 0821'
'cardExpiryDate' => '1213',
)
```

--------------------------------

### Transaction Submission Example

Source: https://guides.gitbook.io/integrationguide/references/code-references/example-http-requests

This example shows the structure of a POST request to submit a transaction, including all necessary parameters for processing.

```APIDOC
## POST /direct/

### Description
Submits a transaction for processing.

### Method
POST

### Endpoint
/direct/

### Parameters
#### Request Body
- **merchantID** (string) - Required - The ID of the merchant.
- **action** (string) - Required - The type of action (e.g., SALE).
- **type** (string) - Required - The transaction type.
- **currencyCode** (string) - Required - The currency code.
- **countryCode** (string) - Required - The country code.
- **amount** (string) - Required - The transaction amount.
- **transactionUnique** (string) - Required - A unique identifier for the transaction.
- **orderRef** (string) - Required - The order reference.
- **cardNumber** (string) - Required - The card number.
- **cardCVV** (string) - Required - The card's CVV.
- **cardExpiryDate** (string) - Required - The card's expiry date.
- **threeDSRequired** (string) - Required - Indicates if 3D Secure is required.
- **avscv2CheckRequired** (string) - Required - Indicates if AVS/CVV2 check is required.
- **duplicateDelay** (string) - Required - Delay for duplicate transaction checks.
- **signature** (string) - Required - A signature for transaction verification.

### Request Example
```
merchantID=100001&action=SALE&type=1&currencyCode=826&countryCode=826&amount=680&transactionUnique=5de65b552499e&orderRef=Test+Transaction&cardNumber=4929+4212+3460+0821&cardCVV=356&cardExpiryDate=1219&threeDSRequired=N&avscv2CheckRequired=N&duplicateDelay=0&signature=06b01e06c8fc761943d676d5f3aa2e9264758fed72e7bcb058a2a35cf23e8e45403099537bb0363054d6bc8ea951ce1ad86e582dbf0b435855b9c97507fcf844
```

### Response
#### Success Response (200 OK)
- **merchantID** (string) - The merchant ID.
- **threeDSEnabled** (string) - Indicates if 3D Secure is enabled.
- **avscv2CheckEnabled** (string) - Indicates if AVS/CVV2 check is enabled.
- **riskCheckEnabled** (string) - Indicates if risk check is enabled.
- **caEnabled** (string) - Indicates if Cardholder Authentication is enabled.
- **rtsEnabled** (string) - Indicates if Real-Time Settlement is enabled.
- **cftEnabled** (string) - Indicates if Card Funding Transaction is enabled.
- **threeDSCheckPref** (string) - Preference for 3D Secure check.
- **cv2CheckPref** (string) - Preference for CVV2 check.
- **addressCheckPref** (string) - Preference for address check.
- **postcodeCheckPref** (string) - Preference for postcode check.
- **cardCVVMandatory** (string) - Indicates if CVV is mandatory.
- **riskCheckPref** (string) - Preference for risk check.
- **notifyEmail** (string) - Email address for notifications.
- **customerReceiptsRequired** (string) - Indicates if customer receipts are required.
- **merchantCategoryCode** (string) - Merchant category code.
- **surchargeEnabled** (string) - Indicates if surcharge is enabled.
- **surchargeRequired** (string) - Indicates if surcharge is required.
- **surchargeRules** (array) - Rules for surcharges.
- **action** (string) - The action performed.
- **type** (string) - The transaction type.
- **currencyCode** (string) - The currency code.
- **countryCode** (string) - The country code.
- **amount** (string) - The transaction amount.
- **transactionUnique** (string) - The unique transaction identifier.
- **orderRef** (string) - The order reference.
- **cardExpiryDate** (string) - The card expiry date.
- **threeDSRequired** (string) - Indicates if 3D Secure was required.
- **avscv2CheckRequired** (string) - Indicates if AVS/CVV2 check was required.
- **duplicateDelay** (string) - The duplicate delay setting.
- **requestID** (string) - The request ID.
- **responseCode** (string) - The response code.
- **responseMessage** (string) - The response message.
- **state** (string) - The transaction state.
- **requestMerchantID** (string) - The merchant ID from the request.
- **processMerchantID** (string) - The merchant ID for processing.
- **paymentMethod** (string) - The payment method used.
- **cardType** (string) - The type of card used.
- **cardTypeCode** (string) - The code for the card type.
- **cardScheme** (string) - The card scheme.
- **cardSchemeCode** (string) - The code for the card scheme.
- **cardIssuer** (string) - The card issuer.
- **cardIssuerCountry** (string) - The country of the card issuer.
- **cardIssuerCountryCode** (string) - The country code of the card issuer.
- **cardFlags** (string) - Flags associated with the card.
- **cardNumberMask** (string) - Masked card number.
- **cardNumberValid** (string) - Indicates if the card number is valid.
- **xref** (string) - Cross-reference identifier.
- **cardExpiryMonth** (string) - The card expiry month.
- **cardExpiryYear** (string) - The card expiry year.
- **authorisationCode** (string) - The authorisation code.
- **transactionID** (string) - The transaction ID.
- **responseStatus** (string) - The response status.
- **responseTimestamp** (string) - The timestamp of the response.
- **amountApproved** (string) - The approved amount.
- **amountReceived** (string) - The received amount.
- **amountRetained** (string) - The retained amount.
- **avscv2ResponseCode** (string) - The AVS/CVV2 response code.
- **avscv2ResponseMessage** (string) - The AVS/CVV2 response message.
- **avscv2AuthEntity** (string) - The AVS/CVV2 authorization entity.
- **cv2Check** (string) - The CVV2 check result.
- **addressCheck** (string) - The address check result.
- **postcodeCheck** (string) - The postcode check result.
- **notifyEmailResponseCode** (string) - Response code for email notification.
- **notifyEmailResponseMessage** (string) - Response message for email notification.
- **vcsResponseCode** (string) - Response code for Velocity Check System.
- **vcsResponseMessage** (string) - Response message for Velocity Check System.
- **currencyExponent** (string) - The currency exponent.
- **signature** (string) - The signature of the response.

### Response Example
```
merchantID=100001&threeDSEnabled=Y&avscv2CheckEnabled=Y&riskCheckEnabled=N&caEnabled=Y&rtsEnabled=Y&cftEnabled=Y&threeDSCheckPref=not+known%2Cnot+checked%2Cauthenticated%2Cattempted+authentication&cv2CheckPref=matched&addressCheckPref=not+known%2Cnot+checked%2Cmatched%2Cpartially+matched&postcodeCheckPref=not+known%2Cnot+checked%2Cmatched%2Cpartially+matched&cardCVVMandatory=Y&riskCheckPref=not+known%3Dfinished%2Cnot+checked%3Ddecline2%2Capprove%3Dcontinue%2Cdecline%3Ddecline1%2Creview%3Ddecline2%2Cescalate%3Dfinished&notifyEmail=an.operator%40merchant.com&customerReceiptsRequired=Y&merchantCategoryCode=6013&surchargeEnabled=Y&surchargeRequired=N&surchargeRules%5B0%5D%5BcardType%5D=CC&surchargeRules%5B0%5D%5Bsurcharge%5D=10.1235&surchargeRules%5B1%5D%5BcardType%5D=CC&surchargeRules%5B1%5D%5Bcurrency%5D=GBP&surchargeRules%5B1%5D%5Bsurcharge%5D=2.5000&surchargeRules%5B2%5D%5BcardType%5D=VC&surchargeRules%5B2%5D%5Bsurcharge%5D=3.5000&surchargeRules%5B3%5D%5BcardType%5D=VC&surchargeRules%5B3%5D%5Bcurrency%5D=GBP&surchargeRules%5B3%5D%5Bsurcharge%5D=4.5000&surchargeRules%5B4%5D%5BcardType%5D=DD&surchargeRules%5B4%5D%5Bsurcharge%5D=5.5000&action=SALE&type=1¤cyCode=826&countryCode=826&amount=680&transactionUnique=5de65b552499e&orderRef=Test+Transaction&cardExpiryDate=1219&threeDSRequired=N&avscv2CheckRequired=N&duplicateDelay=0&requestID=5de65b562496f&responseCode=0&responseMessage=AUTHCODE%3A347414&state=captured&requestMerchantID=100001&processMerchantID=100001&paymentMethod=card&cardType=Visa+Credit&cardTypeCode=VC&cardScheme=Visa+&cardSchemeCode=VC&cardIssuer=BARCLAYS+BANK+PLC&cardIssuerCountry=United+Kingdom&cardIssuerCountryCode=GBR&cardFlags=8323072&cardNumberMask=492942%2A%2A%2A%2A%2A%2A0821&cardNumberValid=Y&xref=19120312NG55CM51QH35JRL&cardExpiryMonth=12&cardExpiryYear=19&authorisationCode=347414&transactionID=10018201&responseStatus=0×tamp=2019-12-03+12%3A55%3A52&amountApproved=680&amountReceived=680&amountRetained=680&avscv2ResponseCode=244100&avscv2ResponseMessage=SECURITY+CODE+MATCH+ONLY&avscv2AuthEntity=merchant+host&cv2Check=matched&addressCheck=not+matched&postcodeCheck=not+matched&notifyEmailResponseCode=0&notifyEmailResponseMessage=Email+successfully+queued&vcsResponseCode=0&vcsResponseMessage=Success+-+no+velocity+check+rules+applied&currencyExponent=2&signature=e5c65e5d0340e0ec0de8782affcb6caba2e4d202a6873a1677ddbf6415cb1dd52cc597e43c758b233afd121367d300a57d0faade7abf6b4b88a1a1b974e55d33
```
```

--------------------------------

### Query Documentation via HTTP GET

Source: https://guides.gitbook.io/integrationguide/gateway-functionality/payment-methods/secureplus-transactions/direct-implementation

Use this method to ask questions about the documentation dynamically. The response includes direct answers and relevant excerpts.

```bash
GET https://guides.gitbook.io/integrationguide/gateway-functionality/payment-methods/secureplus-transactions/direct-implementation.md?ask=<question>
```

--------------------------------

### Querying Documentation with HTTP GET

Source: https://guides.gitbook.io/integrationguide/gateway-functionality/payment-methods/click-to-pay/request-fields

Use this method to ask questions about the documentation. The response includes direct answers and relevant excerpts.

```bash
GET https://guides.gitbook.io/integrationguide/gateway-functionality/payment-methods/click-to-pay/request-fields.md?ask=<question>
```

--------------------------------

### Query Documentation

Source: https://guides.gitbook.io/integrationguide/gateway-functionality/payment-methods/ppro-transactions/benefits-and-limitations

Use this GET request to ask questions about the documentation. Include your question in the 'ask' query parameter.

```HTTP
GET https://guides.gitbook.io/integrationguide/gateway-functionality/payment-methods/ppro-transactions/benefits-and-limitations.md?ask=<question>
```

--------------------------------

### Query Documentation API

Source: https://guides.gitbook.io/integrationguide/gateway-functionality/payment-methods/obmc-transactions/response-fields

To get additional information not directly available on a page, perform an HTTP GET request with the 'ask' query parameter.

```bash
GET https://guides.gitbook.io/integrationguide/gateway-functionality/payment-methods/obmc-transactions/response-fields.md?ask=<question>
```

--------------------------------

### Querying Documentation Dynamically

Source: https://guides.gitbook.io/integrationguide/references/feature-references/request-checking-only

Perform an HTTP GET request to the documentation URL with the 'ask' query parameter to ask questions about the content. The response includes direct answers and relevant excerpts.

```http
GET https://guides.gitbook.io/integrationguide/references/feature-references/request-checking-only.md?ask=<question>
```

--------------------------------

### Query Documentation Dynamically

Source: https://guides.gitbook.io/integrationguide/gateway-functionality/features/3-d-secure-authentication/advanced-features

Use this method to ask questions about the documentation. Perform an HTTP GET request on the page URL with the 'ask' query parameter.

```http
GET https://guides.gitbook.io/integrationguide/gateway-functionality/features/3-d-secure-authentication/advanced-features.md?ask=<question>
```

--------------------------------

### Query Documentation Dynamically

Source: https://guides.gitbook.io/integrationguide/gateway-functionality/features/advanced-data/merchant-request-fields

Use this HTTP GET request to query the documentation dynamically. Append your question as the 'ask' query parameter to the page URL.

```bash
GET https://guides.gitbook.io/integrationguide/gateway-functionality/features/advanced-data/merchant-request-fields.md?ask=<question>
```

--------------------------------

### Querying Documentation

Source: https://guides.gitbook.io/integrationguide/gateway-functionality/features/uk-mcc-6012-merchants

To get information not explicitly on the page, make an HTTP GET request to the page URL with an 'ask' query parameter containing your question.

```http
GET https://guides.gitbook.io/integrationguide/gateway-functionality/features/uk-mcc-6012-merchants.md?ask=<question>
```

--------------------------------

### Query Documentation Dynamically

Source: https://guides.gitbook.io/integrationguide/gateway-functionality/payment-methods/paypal-transactions

Use this method to ask questions about the documentation. The response includes direct answers and relevant excerpts.

```HTTP
GET https://guides.gitbook.io/integrationguide/gateway-functionality/payment-methods/paypal-transactions.md?ask=<question>
```

--------------------------------

### Query Documentation Dynamically

Source: https://guides.gitbook.io/integrationguide/gateway-functionality/features/acquirer-data/request-fields

Use this HTTP GET request to query the documentation dynamically. Include your specific question in the 'ask' query parameter to receive a direct answer and relevant excerpts.

```http
GET https://guides.gitbook.io/integrationguide/gateway-functionality/features/acquirer-data/request-fields.md?ask=<question>
```

--------------------------------

### Batch Submission Response Example

Source: https://guides.gitbook.io/integrationguide/references/code-references/example-http-requests

This example shows a successful batch submission response, indicating a 201 Created status. It includes transaction IDs and their processing status.

```http
HTTP/1.1 201 Created
Date: Tue, 01 Jan 2019 09:30:45 GMT
Server: Apache/2.4.23 (Win64) OpenSSL/1.0.2k-fips PHP/5.4.12
X-Powered-By: PHP/5.4.12
x p3 token: YTo1OntzOjc6InZlcnNpb24iO3M6ODoiUDNUSy8yLjAiO3M6NzoicHVycG9zZSI7czo0OiJhdXRoIjtzOjc6ImNyZWF0b3IiO3M6NToiQkFUQ0giO3M6NzoiY3JlYXRlZCI7aToxNTc1MzY5Mjg1O3M6NzoiZXhwaXJlcyI7aToxNTc1MzcyODg1O30.czozOiI2MjkiOw.zdfxxXYtC2Wc4yyk-lEos-wZ99pEJtPGYpXR4KCiWW_56nmOysarOaMucrWPIt-NzwFzgq3-7u4Ud6uYkQcWBQ
Location: /batch/2D6D-AC2C-BF55-2A8C
Content-disposition: attachment; filename="batch-2D6D-AC2C-BF55-2A8C"
Content-Length: 1857
Content-Type: multipart/mixed; charset=UTF-8; boundary=5de63a5c1a071

Transaction 'TX5de63a42507ac' - pending - queued for processing
Transaction 'TX5de63a42af062' - pending - queued for processing
Transaction 'TX5de63a42ca9cd' - pending - queued for processing

--5de63a5c1a071
Content-Id: TX5de63a42507ac
Content-Type: application/x-www-form-urlencoded; charset=UTF-8
X-Transaction-ID: 
X-Transaction-Response: pending - queued for processing

merchantID=100001&action=SALE&type=1¤cyCode=826&countryCode=826&amount=680&transactionUnique=5de63a42507ac&orderRef=Test+Transaction&cardNumber=492942%2A%2A%2A%2A%2A%2A0821&cardExpiryDate=1219&duplicateDelay=0&signature=0384bbf6ca0fc153e1e27a0cfc51f3b1cd1c2cff7a49aa4e9439bba38262183e9ac7d156f218eba1ef8d04f9e6a7fa6fbc9c2b3ab990c70e06dc7c6923e5b27b

--5de63a5c1a071
Content-Id: TX5de63a42af062
Content-Type: application/x-www-form-urlencoded; charset=UTF-8
X-Transaction-ID: 
X-Transaction-Response: pending - queued for processing

merchantID=100001&action=SALE&type=1¤cyCode=826&countryCode=826&amount=681&transactionUnique=5de63a42af062&orderRef=Test+Transaction&cardNumber=492942%2A%2A%2A%2A%2A%2A0821&cardExpiryDate=1219&duplicateDelay=0&signature=1e13e23c2b90a30f4403d604ac20302b5504b886b0b5c9ace0764fc8d966d120f5a1beca975805292780c22953b4e6ca71f67f499804f19d2718518463a598c4

--5de63a5c1a071
Content-Id: TX5de63a42ca9cd
Content-Type: application/x-www-form-urlencoded; charset=UTF-8
X-Transaction-ID: 
X-Transaction-Response: pending - queued for processing

merchantID=100001&action=SALE&type=1¤cyCode=826&countryCode=826&amount=682&transactionUnique=5de63a42ca9cd&orderRef=Test+Transaction&cardNumber=492942%2A%2A%2A%2A%2A%2A0821&cardExpiryDate=1219&duplicateDelay=0&signature=c456aa211f8e3e568a40051bfd38406be02566fcd72d3bb1547f4d43e75db1d069eaa4158aa035337cac084633df945a13471db6b1a3fcd6c0749626d9bc0044

--5de63a5c1a071--
```
Tokens:
Raw