{"id":437,"date":"2024-08-08T18:48:20","date_gmt":"2024-08-08T18:48:20","guid":{"rendered":"https:\/\/lddpay.com\/?post_type=docs&#038;p=437"},"modified":"2025-04-26T06:34:49","modified_gmt":"2025-04-26T06:34:49","password":"","slug":"checkout-integration","status":"publish","type":"docs","link":"https:\/\/lddpay.com\/zh\/docs\/checkout-integration\/","title":{"rendered":"Checkout Integrations"},"content":{"rendered":"<h1 class=\"wp-block-heading\">Checkout Integrations<\/h1>\n\n\n\n<p>Version: 6.4.4<br>Released: 2025\/03\/01<\/p>\n\n\n\n<p>Copyrighted by lddPay<\/p>\n\n\n\n<h2 class=\"wp-block-heading\" id=\"introduction\">Introduction<\/h2>\n\n\n\n<hr class=\"wp-block-separator has-alpha-channel-opacity\"\/>\n\n\n\n<p>This document describes the Checkout integration procedures between Checkout service and the website for e-commerce merchants.<br>To make your integration easier, please download collection and try it out:<br><a href=\"https:\/\/identity.getpostman.com\/accounts?continue=https%3A%2F%2Fgo.postman.co%2Fnetwork%2Fimport%3Fcollection%3D7445020-069ec96c-fc25-4f5f-b255-26dcecfe6d8e-TVKFyFni%26referrer%3Dhttps%253A%252F%252Fdocumenter.getpostman.com%252Fview%252F7445020%252FTVKFyFni%2523intro%26versionTag%3Dlatest%26traceId%3Dundefined\" target=\"_blank\" rel=\"noreferrer noopener\"><ins>Postman Collection<\/ins><\/a><\/p>\n\n\n\n<h2 class=\"wp-block-heading\" id=\"general-information\">General Information<\/h2>\n\n\n\n<hr class=\"wp-block-separator has-alpha-channel-opacity\"\/>\n\n\n\n<p>Checkout service is a fast and easy way to create a secure payment page. It allows collecting and submitting payments and sending them for processing.<\/p>\n\n\n\n<p>To use the Checkout service on the site you have to perform integration. Checkout integration provides a set of APIs that allow customizing payment processing for the business. These protocols implement acquiring payments (purchases) using specific API interaction with the merchant websites.<\/p>\n\n\n\n<p>The API requires request data as json string data and responds also with json string data.<\/p>\n\n\n\n<h3 class=\"wp-block-heading\" id=\"checkout-process\">Checkout process<\/h3>\n\n\n\n<p>Checkout payment flow is shown below.<\/p>\n\n\n\n<figure class=\"wp-block-image size-full is-resized\"><img fetchpriority=\"high\" decoding=\"async\" width=\"942\" height=\"608\" src=\"https:\/\/lddpay.com\/wp-content\/uploads\/2024\/08\/checkout_payment_flow-d609482b6e1bfde71815abab40e1a57b.png\" alt=\"\" class=\"wp-image-439\" style=\"width:1011px;height:auto\" srcset=\"https:\/\/lddpay.com\/wp-content\/uploads\/2024\/08\/checkout_payment_flow-d609482b6e1bfde71815abab40e1a57b.png 942w, https:\/\/lddpay.com\/wp-content\/uploads\/2024\/08\/checkout_payment_flow-d609482b6e1bfde71815abab40e1a57b-300x194.png 300w, https:\/\/lddpay.com\/wp-content\/uploads\/2024\/08\/checkout_payment_flow-d609482b6e1bfde71815abab40e1a57b-768x496.png 768w, https:\/\/lddpay.com\/wp-content\/uploads\/2024\/08\/checkout_payment_flow-d609482b6e1bfde71815abab40e1a57b-18x12.png 18w\" sizes=\"(max-width: 942px) 100vw, 942px\" \/><\/figure>\n\n\n\n<p>When a Customer wants to make a purchase on your site the following happens:<\/p>\n\n\n\n<ol>\n<li>Customer places an order and initiates payment on the site.<\/li>\n\n\n\n<li>Site confirms the order and sends the payment processing request to the Checkout system with information about the order, payment and hash.<\/li>\n\n\n\n<li>Checkout system validates the request and sends to the site the response with the redirect link.<\/li>\n\n\n\n<li>The site redirects the Customer on the Checkout page by redirect link.<\/li>\n\n\n\n<li>Customer selects the payment method, enters the payment data and confirms the payment. The payment method will be specifying automatically If only one method is available.<\/li>\n\n\n\n<li>The payment processes at Payment Gateway.<\/li>\n\n\n\n<li>Payment Gateway sends a callback to the site with the payment result.<\/li>\n\n\n\n<li>The payment result is shown to the Customer.<\/li>\n<\/ol>\n\n\n\n<p>The payment could be declined in case of invalid data detection.<\/p>\n\n\n\n<h3 class=\"wp-block-heading\" id=\"protocol-mapping\">Protocol Mapping<\/h3>\n\n\n\n<p>It is necessary to check the existence of the protocol mapping before using the Checkout integration. Merchants can\u2019t make payments if the CHECKOUT protocol is not mapped.<\/p>\n\n\n\n<h3 class=\"wp-block-heading\" id=\"customer-return-after-payment\">Customer return after payment<\/h3>\n\n\n\n<p>After completing the payment, the payer will be returned to the URL specified in the Authentication request in the &#8220;success_url&#8221; and &#8220;cancel_url&#8221; parameters. If you need to get additional parameters in the return URLs, you should configure it in the Protocol Mappings modules by enabling the &#8220;Return parameters&#8221; attribute. In that case, &#8220;success_url&#8221; and &#8220;cancel_url&#8221; will contain the following data:<\/p>\n\n\n\n<figure class=\"wp-block-table\"><table><thead><tr><th><strong>Parameter<\/strong><\/th><th><strong>Description<\/strong><\/th><\/tr><\/thead><tbody><tr><td><code>payment_id<\/code><\/td><td>Payment ID<br><strong>Example:<\/strong> dc66cdd8-d702-11ea-9a2f-0242c0a87002<\/td><\/tr><tr><td><code>trans_id<\/code><\/td><td>Transaction ID<br><strong>Example:<\/strong> dc66cdd8-d702-11ea-9a2f-0242c0a87002<\/td><\/tr><tr><td><code>order_id<\/code><\/td><td>Order ID<br><strong>Example:<\/strong> order-1234<\/td><\/tr><tr><td><code>hash<\/code><\/td><td>Special signature, used to validate data. Addition in Signature section.<br>Must be SHA1 of MD5 encoded string (uppercased): payment_public_id + order.number + order.amount + order.currency + order.description + merchant.pass<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n<p>\u26a0\ufe0f <strong>Pay attention<\/strong><\/p>\n\n\n\n<blockquote class=\"wp-block-quote is-layout-flow wp-block-quote-is-layout-flow\">\n<p><em>that for &#8220;cancel_url&#8221;, the payer&#8217;s return to the merchant with parameters is possible only after the decline has happened and the payer has closed the payment form (not the browser tab). If the payer closes the payment form without initiating the payment (pressing the PAY button), the redirection to &#8220;cancel_url&#8221; occurs without passing additional parameters.<\/em><\/p>\n<\/blockquote>\n\n\n\n<h3 class=\"wp-block-heading\" id=\"dms-mode\">DMS mode<\/h3>\n\n\n\n<p>If you need to use Checkout integration to work with payments in DMS-mode (two-step payments), you should set the corresponding MID configuration in the admin panel. Specify DMS-mode for the MID attribute. In this case, the payment request will be processed as an authorization stage for DMS-mode. The capture requests will be generated and gathered in the queue. You could monitor and manage the capture request queue via the admin panel as well. For detailed information, please contact your administrator.<\/p>\n\n\n\n<h3 class=\"wp-block-heading\" id=\"checkout-page-description\">Checkout page description<\/h3>\n\n\n\n<hr class=\"wp-block-separator has-alpha-channel-opacity\"\/>\n\n\n\n<p>Checkout page is shown to the Customer after a payment initiation. There are the fields to enter the payment data.<\/p>\n\n\n\n<h3 class=\"wp-block-heading\" id=\"fields-and-validation\">Fields and Validation<\/h3>\n\n\n\n<p>The list of the fields on the Checkout page depends on the request parameters and the specified payment method.<\/p>\n\n\n\n<p>Your customers will not see the fields if the acquirer does not need the information that is transmitted in them. For example, if an alternative payment method is specified, the card data is not displayed on the Checkout page.<\/p>\n\n\n\n<p>As well, pay attention to the conditional fields such as e-mail or billing address. If the e-mail and billing address (data object) parameters are specified in the request, the Checkout page will not contain them.<\/p>\n\n\n\n<p>Additional fields can also be displayed if a payment method is selected that requests additional data from the Customer.<\/p>\n\n\n\n<p>The Checkout page has the fields validation. In case of the invalid data the error message will be shown and the field will be highlighted.<\/p>\n\n\n\n<p>The list of the general fields and possible errors on the Checkout page is below:<\/p>\n\n\n\n<figure class=\"wp-block-table\"><table><thead><tr><th><strong>Fields<\/strong><\/th><th><strong>Type<\/strong><\/th><th><strong>Limitations<\/strong><\/th><th><strong>Error<\/strong><\/th><\/tr><\/thead><tbody><tr><td><code>Card number<\/code><\/td><td><em>Integral<\/em><\/td><td>Lun algorithm, length 14-19 numbers<\/td><td>Invalid card number<\/td><\/tr><tr><td><code>Expir\u0443 Date<\/code><\/td><td><em>Date<\/em><\/td><td>2-2 numbers (in the format mm-yy),<br>after today&#8217;s date<\/td><td>The expiration date of card is expired<br>and not valid.<\/td><\/tr><tr><td><code>Security code<\/code><\/td><td><em>Integral<\/em><\/td><td>Up to 4 characters<\/td><td>Invalid security code<\/td><\/tr><tr><td><code>Name on card<\/code><\/td><td><em>String<\/em><\/td><td>Up to 32 characters<\/td><td>The name on card field<br>Must contain at least 2 words: first name and last name. Allowed special characters: hyphens, apostrophes, diacritics<\/td><\/tr><tr><td><code>Country<\/code><\/td><td><em>List<\/em><\/td><td>2-letters code<\/td><td>Country is required.<br>Please enter a valid Country<\/td><\/tr><tr><td><code>State\/Region<\/code><\/td><td><em>String<\/em><br><em>List<\/em> &#8211; for USA,<br>Canada, Australia,<br>Japan, India<\/td><td><\/td><td><\/td><\/tr><tr><td><code>City<\/code><\/td><td><em>String<\/em><\/td><td>Up to 32 characters<\/td><td>City is required.<br>Please enter a valid City<\/td><\/tr><tr><td><code>Address line<\/code><\/td><td><em>String<\/em><\/td><td>Up to 32 characters<\/td><td>Address line is required.<br>Please enter a valid Address line<\/td><\/tr><tr><td><code>Zip code<\/code><\/td><td><em>String<\/em><\/td><td>Up to 32 characters<\/td><td>Zip code is required.<br>Please enter a valid Zip code<\/td><\/tr><tr><td><code>Phone number<\/code><\/td><td><em>String<\/em><\/td><td>Up to 32 characters<\/td><td>Phone number is required.<br>Please enter a valid Phone number<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n<h3 class=\"wp-block-heading\" id=\"pre-routing\">Pre-routing<\/h3>\n\n\n\n<p>To make payment method choice easier for the Customer, pre-routing is provided on the Checkout.<\/p>\n\n\n\n<p>The functionality allows you to set up matches in the admin panel via the Custom routing module, which will determine the list of payment methods suitable for the current payment.<\/p>\n\n\n\n<p>This way, you can restrict your Customers from randomly choosing a payment method that is not available in their region, for example. This will help you to increase the number of successful payments and reduce the risk of declined transactions.<\/p>\n\n\n\n<p>Note that if the Authentication request contains a list of the payment methods in the <code>methods<\/code> array, then the pre-routing configurations will be ignored.<\/p>\n\n\n\n<h3 class=\"wp-block-heading\" id=\"card-data-tokenization\">Card data tokenization<\/h3>\n\n\n\n<p>For regular customers, we have made the payment page even more convenient and simple.<\/p>\n\n\n\n<p>You can save the customer&#8217;s card data so that they can reuse it for future payments.<\/p>\n\n\n\n<p>To do this, you need to send the <code>req_token = true<\/code> parameter in the Authentication request. And then, in the callback, you will receive a card token.<\/p>\n\n\n\n<p>Use the token when sending the next Authentication request and your client will see anonymized card details on the payment form, which will greatly simplify the payment process.<\/p>\n\n\n\n<h3 class=\"wp-block-heading\" id=\"web-information\">Web information<\/h3>\n\n\n\n<p>Checkout service gathers information about browser, which the Customer uses.<\/p>\n\n\n\n<p>When the Customer is on the Checkout page, the service gets the data about the Customer&#8217;s OS, browser, and browser language. That information is sent to the acquirer in some cases.<\/p>\n\n\n\n<h3 class=\"wp-block-heading\" id=\"iframe-option\">iFrame option<\/h3>\n\n\n\n<p>You can use iFrame option to show Checkout page on your domain. All you need is just to past in the code redirect url received in the response to the Authentication request.<\/p>\n\n\n\n<p>Please follow the example:<\/p>\n\n\n\n<pre class=\"wp-block-code\"><code>&lt;iframe src=redirect_url height=\"600\" width=\"300\"&gt;&lt;\/iframe&gt;<\/code><\/pre>\n\n\n\n<p>Note that screen size can be adjusted according to your requirements.<\/p>\n\n\n\n<p><em>Important:<\/em> cross-domain requests are prohibited by security policy of our service.<\/p>\n\n\n\n<p>\u26a0\ufe0f <strong>Pay attention<\/strong><\/p>\n\n\n\n<blockquote class=\"wp-block-quote is-layout-flow wp-block-quote-is-layout-flow\">\n<p><em>By adding our Checkout Payment Page to the iframe on your site, ensure you ALLOW ACCESS TO COOKIE STORAGE.<\/em><br><em>This is required to avoid issues when redirecting the payer back to your site, such as after 3DS authentication. If you prohibit the storage of third-party data in your cookies, you will prevent the identification of the payer after returning from 3DS. This can cause interruptions in the payment session.<\/em><\/p>\n<\/blockquote>\n\n\n\n<h3 class=\"wp-block-heading\" id=\"page-customization\">Page Customization<\/h3>\n\n\n\n<p>The administration service provides the ability to stylize the Checkout page in accordance with the preferences of the merchant. The action is available for the authorized users only. To customize the payment page you need:<\/p>\n\n\n\n<ol>\n<li>Click the \u201cConfiguration \u2192 Branding\u201d item on the menu bar. The settings are displayed in the work area.<\/li>\n\n\n\n<li>Select a page template to make changes.<\/li>\n\n\n\n<li>Change the settings:\n<ol>\n<li>login icon selection;<\/li>\n\n\n\n<li>color selection for the following items:\n<ol>\n<li>heading;<\/li>\n\n\n\n<li>background;<\/li>\n\n\n\n<li>buttons;<\/li>\n<\/ol>\n<\/li>\n<\/ol>\n<\/li>\n\n\n\n<li>Click the \u201cSubmit\u201d button to apply the settings. The selected settings will be displayed to the Customers on the Checkout page.<\/li>\n<\/ol>\n\n\n\n<h2 class=\"wp-block-heading\" id=\"authentication-request-parameters\">Authentication request parameters<\/h2>\n\n\n\n<hr class=\"wp-block-separator has-alpha-channel-opacity\"\/>\n\n\n\n<p>The merchant submits an authorization request and as a result of successful response receives the <code>redirect_url<\/code> &#8211; link on the Checkout page.<\/p>\n\n\n\n<pre class=\"wp-block-code\"><code>\/api\/v1\/session<\/code><\/pre>\n\n\n\n<p>The authentication performs when the payment is initiated.<\/p>\n\n\n\n<p>You need to send an authentication POST request in JSON format on Checkout form URL (CHECKOUT_URL) to start checkout process for the Customers. As a result of the authentication request you will receive the following:<\/p>\n\n\n\n<ul>\n<li>An authentication session is created with a unique identifier (Session ID). The session expires after one hour.<\/li>\n\n\n\n<li>A link is generated to redirect to the Checkout page: one link corresponds to one payment. The link becomes invalid after a successful payment. The authentication request parameters are below.<\/li>\n<\/ul>\n\n\n\n<p>If DMS-mode (two-stages payment) is available, after successful authentication it is necessary to capture. The capture would be performed automatically according to the settings or you can do it manually in the admin portal.<\/p>\n\n\n\n<h3 class=\"wp-block-heading\" id=\"request-parameters\">Request Parameters<\/h3>\n\n\n\n<figure class=\"wp-block-table\"><table><thead><tr><th><strong>Parameter<\/strong><\/th><th><strong>Type<\/strong><\/th><th><strong>Mandatory, Limitations<\/strong><\/th><th><strong>Description<\/strong><\/th><\/tr><\/thead><tbody><tr><td><code>merchant_key<\/code><\/td><td><em>String<\/em><\/td><td>Required<\/td><td>Key for Merchant identification<br><strong>Example:<\/strong> xxxxx-xxxxx-xxxxx<\/td><\/tr><tr><td><code>operation<\/code><\/td><td><em>String<\/em><\/td><td>Required<\/td><td>Defines a payment transaction<br><strong>Possible values:<\/strong> purchase, debit, transfer<br>Send the \u201cpurchase\u201d value so that the payment page for sale initiation will be shown to the customer.<br>Send the \u201cdebit\u201d value so that the payment page for debit initiation will be shown to the customer.<br>Send the \u201ctransfer\u201d value so that the payment page for transfer initiation will be shown to the customer.<br><strong>Example:<\/strong> purchase<\/td><\/tr><tr><td><code>methods<\/code><\/td><td><em>Array<\/em><\/td><td>Optional<\/td><td>An array of payment methods. Limits the available methods on the Checkout page (the list of the possible values in the Payment methods section). In the case of parameter absence, the pre-routing rules are applied. If pre-routing rules are not configured, all available payment methods are displayed.<br><strong>Condition:<\/strong> for purchase operation only<br>For purchase and debit operations.<br><strong>Example:<\/strong> card, paypal, googlepay<\/td><\/tr><tr><td><code>session_expiry<\/code><\/td><td><em>Integer<\/em><\/td><td>Optional<br>Values from 1 to 720 min<\/td><td>Session expiration time in minutes.<br>Default value = 60.<br>Could not be zero.<br><strong>Example:<\/strong> 60<\/td><\/tr><tr><td><code>success_url<\/code><\/td><td><em>String<\/em><\/td><td>Required<br>Valid URL<br>max: 1024<\/td><td>URL to redirect the Customer in case of the successful payment<br><strong>Example:<\/strong> <a href=\"https:\/\/example.domain.com\/success\" target=\"_blank\" rel=\"noreferrer noopener\">https:\/\/example.domain.com\/success<\/a><br>The return of additional parameters can be configured for success_url. See the \u201cCustomer return after payment\u201d section for details.<\/td><\/tr><tr><td><code>cancel_url<\/code><\/td><td><em>String<\/em><\/td><td>Optional<br>Valid URL<br>min: 0 max: 1024<\/td><td>URL to return Customer in case of a payment cancellation (\u201cClose\u201d button on the Checkout page). The logic of redirection on \u201ccancel_url\u201d could be configured in the admin panel (Configuration -&gt; Protocol Mappings section): use the \u201cMaximum count declines\u201d field to set the payment failed attempts quantity before redirection. For example, if the field value is set to &#8220;1&#8221;, then after the first declined attempt, a payer will be redirected to &#8220;cancel_url.&#8221;<br><strong>Example:<\/strong> <a href=\"https:\/\/example.domain.com\/cancel\" target=\"_blank\" rel=\"noreferrer noopener\">https:\/\/example.domain.com\/cancel<\/a><br>The return of additional parameters can be configured for cancel_url. See the \u201cCustomer return after payment\u201d section for details.<\/td><\/tr><tr><td><code>expiry_url<\/code><\/td><td><em>String<\/em><\/td><td>Optional<br>Valid URL<br>min: 0 max: 1024<\/td><td>URL where the payer will be redirected in case of session expiration<br><strong>Example: <\/strong><a href=\"https:\/\/example.domain.com\/expiry\" target=\"_blank\" rel=\"noreferrer noopener\">https:\/\/example.domain.com\/expiry<\/a><\/td><\/tr><tr><td><code>url_target<\/code><\/td><td><em>String<\/em><\/td><td>Optional<br>Possible values: <code>_blank<\/code>, <code>_self<\/code>, <code>_parent<\/code>, <code>_top<\/code> or custom iframe name.<br>Find the result of applying the values in the HTML standard description (<a href=\"https:\/\/html.spec.whatwg.org\/#valid-browsing-context-name\" target=\"_blank\" rel=\"noreferrer noopener\">Browsing context names<\/a>)<\/td><td>Name of, or keyword for a browsing context where Customer should be returned according to HTML specification.<br><strong>Example:<\/strong> _parent<\/td><\/tr><tr><td><code>req_token<\/code><\/td><td><em>Boolean<\/em><\/td><td>Optional<br>default &#8211; false<\/td><td>Special attribute pointing for further tokenization<br>If the <code>card_token<\/code> is specified, <code>req_token<\/code> will be ignored.<br>For purchase and debit operations.<br><strong>Example:<\/strong> false<\/td><\/tr><tr><td><code>card_token<\/code><\/td><td><em>Array of Strings<\/em><\/td><td>Optional<br>String 64 characters<\/td><td>Credit card token value<br>For purchase and debit operations.<br><strong>Example:<\/strong> f5d6a0ab6fcfb6487a39e2256e50fff3c95aaa97<\/td><\/tr><tr><td><code>recurring_init<\/code><\/td><td><em>Boolean<\/em><\/td><td>Optional<br>default &#8211; false<\/td><td>Initialization of the transaction with possible following recurring<br>Only for purchase operation<br><strong>Example:<\/strong> true<\/td><\/tr><tr><td><code>schedule_id<\/code><\/td><td><em>String<\/em><\/td><td>Optional<br>It s available when recurring_init = true<\/td><td>Schedule ID for recurring payments<br>Only for purchase operation<br><strong>Example:<\/strong> 57fddecf-17b9-4d38-9320-a670f0c29ec0<\/td><\/tr><tr><td><code>vat_calc<\/code><\/td><td><em>Boolean<\/em><\/td><td>Conditional<br>true or false<br>default &#8211; false<\/td><td>Indicates the need of calculation for the VAT amount<br>\u2022 &#8216;true&#8217; &#8211; if VAT calculation needed<br>\u2022 &#8216;false&#8217; &#8211; if VAT should not be calculated for current payment.<br>Only for purchase operation<br><strong>Example:<\/strong> false<\/td><\/tr><tr><td><code>hash<\/code><\/td><td><em>String<\/em><\/td><td>Required<\/td><td>Special signature to validate your request to Payment Platform Addition in Signature section.<br><strong>Example:<\/strong> <ins>Must be SHA1 of MD5 encoded string (uppercased):<\/ins> order_number + order_amount + order_currency + order_description + password<\/td><\/tr><tr><td><strong>order<\/strong><\/td><td><em>Object<\/em><\/td><td>Required<\/td><td>Information about an order<\/td><\/tr><tr><td><code>number<\/code><\/td><td><em>String<\/em><\/td><td>Required<br>max: 255<br>[a-z A-Z 0-9 -!&#8221;#$%&amp;'()*+,.\/:;&amp;@]<\/td><td>Order ID<br><strong>Example:<\/strong> order-1234<\/td><\/tr><tr><td><code>amount<\/code><\/td><td><em>String<\/em><\/td><td>Required<br>Greater then 0<br>[0-9]<br>max: 255<\/td><td>Format depends on currency.<br>Send Integer type value for currencies with zero-exponent. <strong>Example:<\/strong> 1000<br>Send Float type value for currencies with exponents 2, 3, 4.<br>Format for 2-exponent currencies: XX.XX <strong>Example:<\/strong> 100.99<br><strong>Pay attention<\/strong> that currencies &#8216;UGX&#8217;, &#8216;JPY&#8217;, &#8216;KRW&#8217;, &#8216;CLP&#8217; must be send in the format XX.XX, with the zeros after comma. <strong>Example:<\/strong> 100.00<br>Format for 3-exponent currencies: XXX.XXX <strong>Example:<\/strong> 100.999.<br>Format for 4-exponent currencies: XXX.XXXX <strong>Example:<\/strong> 100.9999<br><strong>For transfer operation:<\/strong><br>Send amount if you want to show default value in the amount field on the Checkout. The customers can change the value manually on the payment form.Send &#8220;-1&#8221; value if you want to show empty amount field on the Checkout so that the Customers could enter the value manually.<\/td><\/tr><tr><td><code>currency<\/code><\/td><td><em>String<\/em><\/td><td>Required<br>3 characters<br>[A-Z]<br><a href=\"https:\/\/www.xe.com\/iso4217.php\" target=\"_blank\" rel=\"noreferrer noopener\">ISO 4217<\/a><\/td><td>Currency<br><strong>Example:<\/strong> USD<\/td><\/tr><tr><td><code>description<\/code><\/td><td><em>String<\/em><\/td><td>Required<br>min: 2 max: 1024<br>[a-z A-Z 0-9 !&#8221;#$%&amp;'()*+,.\/:;&amp;@]<\/td><td>Product name<br><strong>Example:<\/strong> Very important gift &#8211; # 9<\/td><\/tr><tr><td><strong>customer<\/strong><\/td><td><em>Object<\/em><\/td><td>Conditional<\/td><td>Customer&#8217;s information. Send an object if a payment method needs<\/td><\/tr><tr><td><code>name<\/code><\/td><td><em>String<\/em><\/td><td>Conditional<br>min: 2 max: 32<br>Latin basic<br>[a-z A-Z]<\/td><td>Customer&#8217;s name<br>Condition: If the parameter is NOT specified in the request, then it will be displayed on the Checkout page (if a payment method needs) &#8211; the &#8220;Cardholder&#8221; field<br><strong>Example:<\/strong> John Doe<\/td><\/tr><tr><td><code>email<\/code><\/td><td><em>String<\/em><\/td><td>Conditional<br>min: 2 max: 255<br>email format<\/td><td>Customer&#8217;s email address<br>Condition: If the parameter is NOT specified in the request, then it will be displayed on the Checkout page (if a payment method needs) &#8211; the &#8220;E-mail&#8221; field<br><strong>Example:<\/strong> <a href=\"https:\/\/docs.lddpay.com\/url\">example@mail.com<\/a><\/td><\/tr><tr><td><code>birth_date<\/code><\/td><td><em>String<\/em><\/td><td>Conditional<br>format: yyyy-mm-dd<br><a href=\"https:\/\/en.wikipedia.org\/wiki\/ISO_8601\" target=\"_blank\" rel=\"noreferrer noopener\">ISO 8601<\/a><\/td><td>Payer&#8217;s birth date<br><strong>Example:<\/strong> 1970-02-17<\/td><\/tr><tr><td><strong>billing_address<\/strong><\/td><td><em>Object<\/em><\/td><td>Conditional<\/td><td>Billing address information.<br><strong>Condition:<\/strong> If the object or some object&#8217;s parameters are NOT specified in the request, then it will be displayed on the Checkout page (if a payment method needs)<\/td><\/tr><tr><td><code>country<\/code><\/td><td><em>String<\/em><\/td><td>Conditional 2 characters<br>(alpha-2 code)<br><a href=\"https:\/\/www.iban.com\/country-codes\" target=\"_blank\" rel=\"noreferrer noopener\">ISO 3166-1<\/a><\/td><td>Billing country<br><strong>Example:<\/strong> US<\/td><\/tr><tr><td><code>state<\/code><\/td><td><em>String<\/em><\/td><td>Optional<br>min: 2 max: 32<br>[a-z A-Z]<br>It is 2-letters code for USA, Canada, Australia, Japan, India<\/td><td>Billing state address<br><strong>Example:<\/strong> CA<\/td><\/tr><tr><td><code>city<\/code><\/td><td><em>String<\/em><\/td><td>Conditional<br>min: 2 max: 40<br>[a-z A-Z]<\/td><td>Billing city<br><strong>Example:<\/strong> Los Angeles<\/td><\/tr><tr><td><code>district<\/code><\/td><td><em>String<\/em><\/td><td>Optional<br>min: 2 max: 32<br>[a-z A-Z 0-9 &#8211; space]<\/td><td>City district<br><strong>Example:<\/strong> Beverlywood<\/td><\/tr><tr><td><code>address<\/code><\/td><td><em>String<\/em><\/td><td>Conditional<br>min: 2 max: 32<br>[a-z A-Z 0-9]<\/td><td>Billing address<br><strong>Example:<\/strong> Moor Building<\/td><\/tr><tr><td><code>house_number<\/code><\/td><td><em>String<\/em><\/td><td>Optional<br>min: 1 max: 9<br>[a-z A-Z 0-9\/ &#8211; space]<\/td><td>House number<br><strong>Example:<\/strong> 17\/2<\/td><\/tr><tr><td><code>zip<\/code><\/td><td><em>String<\/em><\/td><td>Conditional<br>min: 2 max: 10<br>[a-z A-Z 0-9]<\/td><td>Billing zip code<br><strong>Example:<\/strong> 123456, MK77<\/td><\/tr><tr><td><code>phone<\/code><\/td><td><em>String<\/em><\/td><td>Conditional<br>min: 1 max: 32<br>[0-9 + () -]<\/td><td>Customer phone number<br><strong>Example:<\/strong> 347771112233<\/td><\/tr><tr><td><strong>payee<\/strong><\/td><td><em>Object<\/em><\/td><td>Conditional<\/td><td>Payee&#8217;s information.<br>Specify additional information about Payee for transfer operation if it is required by payment provider.<\/td><\/tr><tr><td><code>name<\/code><\/td><td><em>String<\/em><\/td><td>Required<br>min: 2 max: 32<br>Latin basic<br>[a-z A-Z]<\/td><td>Customer&#8217;s name.<br><strong>Example:<\/strong> John Doe<\/td><\/tr><tr><td><code>email<\/code><\/td><td><em>String<\/em><\/td><td>Conditional<br>email format<\/td><td>Customer&#8217;s email address.<br><strong>Example:<\/strong> <a href=\"mailto:example@mail.com\" target=\"_blank\" rel=\"noreferrer noopener\">example@mail.com<\/a><\/td><\/tr><tr><td><strong>payee_billing_address<\/strong><\/td><td><em>Object<\/em><\/td><td>Conditional<\/td><td>Billing address information for Payee.<\/td><\/tr><tr><td><code>country<\/code><\/td><td><em>String<\/em><\/td><td>Conditional 2 characters<br>(alpha-2 code)<br><a href=\"https:\/\/www.iban.com\/country-codes\" target=\"_blank\" rel=\"noreferrer noopener\">ISO 3166-1<\/a><\/td><td>Billing country<br><strong>Example:<\/strong> US<\/td><\/tr><tr><td><code>state<\/code><\/td><td><em>String<\/em><\/td><td>Optional<br>min: 2 max: 32<br>[a-z A-Z]<br>It is 2-letters code for USA, Canada, Australia, Japan, India<\/td><td>Billing state address<br><strong>Example:<\/strong> CA<\/td><\/tr><tr><td><code>city<\/code><\/td><td><em>String<\/em><\/td><td>Conditional<br>min: 2 max: 40<br>[a-z A-Z]<\/td><td>Billing city<br><strong>Example:<\/strong> Los Angeles<\/td><\/tr><tr><td><code>district<\/code><\/td><td><em>String<\/em><\/td><td>Optional<br>min: 2 max: 32<br>[a-z A-Z 0-9 &#8211; space]<\/td><td>City district<br><strong>Example:<\/strong> Beverlywood<\/td><\/tr><tr><td><code>address<\/code><\/td><td><em>String<\/em><\/td><td>Conditional<br>min: 2 max: 32<br>[a-z A-Z 0-9]<\/td><td>Billing address<br><strong>Example:<\/strong> Moor Building<\/td><\/tr><tr><td><code>house_number<\/code><\/td><td><em>String<\/em><\/td><td>Optional<br>min: 1 max: 9<br>[a-z A-Z 0-9\/ &#8211; space]<\/td><td>House number<br><strong>Example:<\/strong> 17\/2<\/td><\/tr><tr><td><code>zip<\/code><\/td><td><em>String<\/em><\/td><td>Conditional<br>min: 2 max: 10<br>[a-z A-Z 0-9]<\/td><td>Billing zip code<br><strong>Example:<\/strong> 123456, MK77<\/td><\/tr><tr><td><code>phone<\/code><\/td><td><em>String<\/em><\/td><td>Conditional<br>min: 1 max: 32<br>[0-9 + () -]<\/td><td>Customer phone number<br><strong>Example:<\/strong> 347771112233<\/td><\/tr><tr><td><strong>parameters<\/strong><\/td><td><em>Object<\/em><\/td><td>Optional<\/td><td>Extra-parameters required for specific payment method<br><strong>Example:<\/strong><br><code>\"parameters\": { \"payment_method\": { \"param1\":\"val1\", \"param2\":\"val2\" } }<\/code><\/td><\/tr><tr><td><strong>custom_data<\/strong><\/td><td><em>Object<\/em><\/td><td>Optional<\/td><td>Custom data<br>This block can contain arbitrary data, which will be returned in the callback.<br><strong>Example:<\/strong><br><code>\u201ccustom_data\u201d: {\u201cparam1\u201d:\u201dvalue1\u201d, \u201cparam2\u201d:\u201dvalue2\u201d, \u201cparam3\u201d:\u201dvalue3\u201d}<\/code><\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n<div\n    class=\"betterdocs-faq-wrapper layout-classic icon-before betterdocs-faq-layout-2 betterdocs-faq-t8nvall betterdocs-shortcode\">\n    <h2 class=\"betterdocs-faq-layout-2 betterdocs-faq-t8nvall betterdocs-faq-section-title\">\n            <\/h2>\n\n    <div class=\"betterdocs-faq-inner-wrapper\">\n        <div class=\"betterdocs-faq-title\">\n    <h2>Request parameter<\/h2>\n<\/div>\n<ul class=\"betterdocs-faq-list\"><li><div class=\"betterdocs-faq-group\"><div class=\"betterdocs-faq-post\">\n    <div class=\"betterdocs-faq-post-icon-group\"><svg class=\"betterdocs-faq-iconplus\" xmlns=\"http:\/\/www.w3.org\/2000\/svg\" viewbox=\"0 0 24 24\"><path fill=\"#000000\" d=\"M18 10h-4V6h-4v4H6v4h4v4h4v-4h4\"><\/path><\/svg><svg class=\"betterdocs-faq-iconminus\" xmlns=\"http:\/\/www.w3.org\/2000\/svg\" viewbox=\"0 0 24 24\"><path fill=\"#000000\" d=\"M6 10h12v4H6z\"><\/path><\/svg><\/div>    <span class=\"betterdocs-faq-post-name\">\n        Authentication (OK)    <\/span>\n    <\/div>\n<div class=\"betterdocs-faq-main-content\">\n    <p>curl &#8211;location -g &#8211;request POST &#8216;{{CHECKOUT_HOST}}\/api\/v1\/session&#8217; <\/p>\n<p>&#8211;header &#8216;Content-Type: application\/json&#8217; <\/p>\n<p>&#8211;data-raw &#8216;{<\/p>\n<p>&nbsp;&nbsp;&#8220;merchant_key&#8221;: &#8220;xxxxx-xxxxx-xxxxx&#8221;,<\/p>\n<p>&nbsp;&nbsp;&#8220;operation&#8221;: &#8220;purchase&#8221;,<\/p>\n<p>&nbsp;&nbsp;&#8220;methods&#8221;: [<\/p>\n<p>&nbsp;&nbsp;&nbsp;&nbsp;&#8220;card&#8221;,<\/p>\n<p>&nbsp;&nbsp;&nbsp;&nbsp;&#8220;method1&#8221;<\/p>\n<p>&nbsp;&nbsp;],<\/p>\n<p>&nbsp;&nbsp;&#8220;parameters&#8221;: {<\/p>\n<p>&nbsp;&nbsp;&nbsp;&nbsp;&#8220;card&#8221;: {<\/p>\n<p>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&#8220;param1&#8221;: &#8220;val-1&#8221;,<\/p>\n<p>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&#8220;param2&#8221;: &#8220;val-2&#8221;<\/p>\n<p>&nbsp;&nbsp;&nbsp;&nbsp;},<\/p>\n<p>&nbsp;&nbsp;&nbsp;&nbsp;&#8220;method1&#8221;: {<\/p>\n<p>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&#8220;param1&#8221;: &#8220;val-3&#8221;,<\/p>\n<p>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&#8220;param2&#8221;: &#8220;val-4&#8221;<\/p>\n<p>&nbsp;&nbsp;&nbsp;&nbsp;}<\/p>\n<p>&nbsp;&nbsp;},<\/p>\n<p>&nbsp;&nbsp;&#8220;session_expiry&#8221;: 60,<\/p>\n<p>&nbsp;&nbsp;&#8220;order&#8221;: {<\/p>\n<p>&nbsp;&nbsp;&nbsp;&nbsp;&#8220;number&#8221;: &#8220;order-1234&#8221;,<\/p>\n<p>&nbsp;&nbsp;&nbsp;&nbsp;&#8220;amount&#8221;: &#8220;0.19&#8221;,<\/p>\n<p>&nbsp;&nbsp;&nbsp;&nbsp;&#8220;currency&#8221;: &#8220;USD&#8221;,<\/p>\n<p>&nbsp;&nbsp;&nbsp;&nbsp;&#8220;description&#8221;: &#8220;Important gift&#8221;<\/p>\n<p>&nbsp;&nbsp;},<\/p>\n<p>&nbsp;&nbsp;&#8220;cancel_url&#8221;: &#8220;https:\/\/example.domain.com\/cancel&#8221;,<\/p>\n<p>&nbsp;&nbsp;&#8220;success_url&#8221;: &#8220;https:\/\/example.domain.com\/success&#8221;,<\/p>\n<p>&nbsp;&nbsp;&#8220;expiry_url&#8221;: &#8220;https:\/\/example.domain.com\/expiry&#8221;,<\/p>\n<p>&nbsp;&nbsp;&#8220;url_target&#8221;: &#8220;_blank&#8221;,<\/p>\n<p>&nbsp;&nbsp;&#8220;customer&#8221;: {<\/p>\n<p>&nbsp;&nbsp;&nbsp;&nbsp;&#8220;name&#8221;: &#8220;John Doe&#8221;,<\/p>\n<p>&nbsp;&nbsp;&nbsp;&nbsp;&#8220;email&#8221;: &#8220;test@gmail.com&#8221;<\/p>\n<p>&nbsp;&nbsp;},<\/p>\n<p>&nbsp;&nbsp;&#8220;billing_address&#8221;: {<\/p>\n<p>&nbsp;&nbsp;&nbsp;&nbsp;&#8220;country&#8221;: &#8220;US&#8221;,<\/p>\n<p>&nbsp;&nbsp;&nbsp;&nbsp;&#8220;state&#8221;: &#8220;CA&#8221;,<\/p>\n<p>&nbsp;&nbsp;&nbsp;&nbsp;&#8220;city&#8221;: &#8220;Los Angeles&#8221;,<\/p>\n<p>&nbsp;&nbsp;&nbsp;&nbsp;&#8220;disctrict&#8221;: &#8220;Beverlywood&#8221;,<\/p>\n<p>&nbsp;&nbsp;&nbsp;&nbsp;&#8220;address&#8221;: &#8220;Moor Building 35274&#8221;,<\/p>\n<p>&nbsp;&nbsp;&nbsp;&nbsp;&#8220;house_number&#8221;: &#8220;17\/2&#8221;,<\/p>\n<p>&nbsp;&nbsp;&nbsp;&nbsp;&#8220;zip&#8221;: &#8220;123456&#8221;,<\/p>\n<p>&nbsp;&nbsp;&nbsp;&nbsp;&#8220;phone&#8221;: &#8220;347771112233&#8221;<\/p>\n<p>&nbsp;&nbsp;},<\/p>\n<p>&nbsp;&nbsp;&#8220;card_token&#8221;: [<\/p>\n<p>&nbsp;&nbsp;&nbsp;&nbsp;&#8220;f5d6a0ab6fcfb6487a39e2256e50fff3c95aaa97075ee5e539bb662fceff4dc1&#8221;<\/p>\n<p>&nbsp;&nbsp;],<\/p>\n<p>&nbsp;&nbsp;&#8220;req_token&#8221;: true,<\/p>\n<p>&nbsp;&nbsp;&#8220;recurring_init&#8221;: true,<\/p>\n<p>&nbsp;&nbsp;&#8220;schedule_id&#8221;: &#8220;9d0f5cc4-f07b-11ec-abf4-0242ac120006&#8221;,<\/p>\n<p>&nbsp;&nbsp;&#8220;hash&#8221;: &#8220;{{session_hash}}&#8221;<\/p>\n<p>}<\/p>\n<p>&#8216;<\/p>\n<\/div>\n<\/div><\/li><li><div class=\"betterdocs-faq-group\"><div class=\"betterdocs-faq-post\">\n    <div class=\"betterdocs-faq-post-icon-group\"><svg class=\"betterdocs-faq-iconplus\" xmlns=\"http:\/\/www.w3.org\/2000\/svg\" viewbox=\"0 0 24 24\"><path fill=\"#000000\" d=\"M18 10h-4V6h-4v4H6v4h4v4h4v-4h4\"><\/path><\/svg><svg class=\"betterdocs-faq-iconminus\" xmlns=\"http:\/\/www.w3.org\/2000\/svg\" viewbox=\"0 0 24 24\"><path fill=\"#000000\" d=\"M6 10h12v4H6z\"><\/path><\/svg><\/div>    <span class=\"betterdocs-faq-post-name\">\n        Debit Operation (OK)    <\/span>\n    <\/div>\n<div class=\"betterdocs-faq-main-content\">\n    <p>curl &#8211;location -g &#8211;request POST &#8216;{{CHECKOUT_HOST}}\/api\/v1\/session&#8217; <\/p>\n<p>&#8211;header &#8216;Content-Type: application\/json&#8217; <\/p>\n<p>&#8211;data-raw &#8216;{<\/p>\n<p>&nbsp;&nbsp;&#8220;merchant_key&#8221;: &#8220;xxxxx-xxxxx-xxxxx&#8221;,<\/p>\n<p>&nbsp;&nbsp;&#8220;operation&#8221;: &#8220;debit&#8221;,<\/p>\n<p>&nbsp;&nbsp;&#8220;methods&#8221;: [<\/p>\n<p>&nbsp;&nbsp;&nbsp;&nbsp;&#8220;card&#8221;<\/p>\n<p>&nbsp;&nbsp;],<\/p>\n<p>&nbsp;&nbsp;&#8220;parameters&#8221;: {<\/p>\n<p>&nbsp;&nbsp;&nbsp;&nbsp;&#8220;card&#8221;: {<\/p>\n<p>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&#8220;param1&#8221;: &#8220;val-1&#8221;,<\/p>\n<p>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&#8220;param2&#8221;: &#8220;val-2&#8221;<\/p>\n<p>&nbsp;&nbsp;&nbsp;&nbsp;},<\/p>\n<p>&nbsp;&nbsp;&nbsp;&nbsp;&#8220;session_expiry&#8221;: 60,<\/p>\n<p>&nbsp;&nbsp;&nbsp;&nbsp;&#8220;order&#8221;: {<\/p>\n<p>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&#8220;number&#8221;: &#8220;order-1234&#8221;,<\/p>\n<p>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&#8220;amount&#8221;: &#8220;0.19&#8221;,<\/p>\n<p>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&#8220;currency&#8221;: &#8220;USD&#8221;,<\/p>\n<p>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&#8220;description&#8221;: &#8220;Important gift&#8221;<\/p>\n<p>&nbsp;&nbsp;&nbsp;&nbsp;},<\/p>\n<p>&nbsp;&nbsp;&nbsp;&nbsp;&#8220;cancel_url&#8221;: &#8220;https:\/\/example.domain.com\/cancel&#8221;,<\/p>\n<p>&nbsp;&nbsp;&nbsp;&nbsp;&#8220;success_url&#8221;: &#8220;https:\/\/example.domain.com\/success&#8221;,<\/p>\n<p>&nbsp;&nbsp;&nbsp;&nbsp;&#8220;expiry_url&#8221;: &#8220;https:\/\/example.domain.com\/expiry&#8221;,<\/p>\n<p>&nbsp;&nbsp;&nbsp;&nbsp;&#8220;url_target&#8221;: &#8220;_blank&#8221;,<\/p>\n<p>&nbsp;&nbsp;&nbsp;&nbsp;&#8220;customer&#8221;: {<\/p>\n<p>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&#8220;name&#8221;: &#8220;John Doe&#8221;,<\/p>\n<p>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&#8220;email&#8221;: &#8220;test@gmail.com&#8221;<\/p>\n<p>&nbsp;&nbsp;&nbsp;&nbsp;},<\/p>\n<p>&nbsp;&nbsp;&nbsp;&nbsp;&#8220;billing_address&#8221;: {<\/p>\n<p>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&#8220;country&#8221;: &#8220;US&#8221;,<\/p>\n<p>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&#8220;state&#8221;: &#8220;CA&#8221;,<\/p>\n<p>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&#8220;city&#8221;: &#8220;Los Angeles&#8221;,<\/p>\n<p>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&#8220;disctrict&#8221;: &#8220;Beverlywood&#8221;,<\/p>\n<p>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&#8220;address&#8221;: &#8220;Moor Building 35274&#8221;,<\/p>\n<p>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&#8220;house_number&#8221;: &#8220;17\/2&#8221;,<\/p>\n<p>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&#8220;zip&#8221;: &#8220;123456&#8221;,<\/p>\n<p>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&#8220;phone&#8221;: &#8220;347771112233&#8221;<\/p>\n<p>&nbsp;&nbsp;&nbsp;&nbsp;},<\/p>\n<p>&nbsp;&nbsp;&nbsp;&nbsp;&#8220;card_token&#8221;: [<\/p>\n<p>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&#8220;f5d6a0ab6fcfb6487a39e2256e50fff3c95aaa97075ee5e539bb662fceff4dc1&#8221;<\/p>\n<p>&nbsp;&nbsp;&nbsp;&nbsp;],<\/p>\n<p>&nbsp;&nbsp;&nbsp;&nbsp;&#8220;req_token&#8221;: true,<\/p>\n<p>&nbsp;&nbsp;&nbsp;&nbsp;&#8220;hash&#8221;: &#8220;{{session_hash}}&#8221;<\/p>\n<p>&nbsp;&nbsp;}<\/p>\n<p>}<\/p>\n<p>&#8216;<\/p>\n<\/div>\n<\/div><\/li><li><div class=\"betterdocs-faq-group\"><div class=\"betterdocs-faq-post\">\n    <div class=\"betterdocs-faq-post-icon-group\"><svg class=\"betterdocs-faq-iconplus\" xmlns=\"http:\/\/www.w3.org\/2000\/svg\" viewbox=\"0 0 24 24\"><path fill=\"#000000\" d=\"M18 10h-4V6h-4v4H6v4h4v4h4v-4h4\"><\/path><\/svg><svg class=\"betterdocs-faq-iconminus\" xmlns=\"http:\/\/www.w3.org\/2000\/svg\" viewbox=\"0 0 24 24\"><path fill=\"#000000\" d=\"M6 10h12v4H6z\"><\/path><\/svg><\/div>    <span class=\"betterdocs-faq-post-name\">\n        Transfer Operation (OK)    <\/span>\n    <\/div>\n<div class=\"betterdocs-faq-main-content\">\n    <p>curl &#8211;location -g &#8211;request POST &#8216;{{CHECKOUT_HOST}}\/api\/v1\/session&#8217; <\/p>\n<p>&#8211;header &#8216;Content-Type: application\/json&#8217; <\/p>\n<p>&#8211;data-raw &#8216;{&nbsp;&nbsp;<\/p>\n<p>&nbsp;&nbsp;&nbsp;&#8220;merchant_key&#8221;:&#8221;xxxxx-xxxxx-xxxxx&#8221;,<\/p>\n<p>&nbsp;&nbsp;&nbsp;&#8220;operation&#8221;:&#8221;transfer&#8221;,<\/p>\n<p>&nbsp;&nbsp;&nbsp;&#8220;order&#8221;:{<\/p>\n<p>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&#8220;number&#8221;:&#8221;order-1234&#8243;,<\/p>\n<p>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&#8220;amount&#8221;: &#8220;100.55&#8221;,<\/p>\n<p>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&#8220;currency&#8221;:&#8221;USD&#8221;,<\/p>\n<p>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&#8220;description&#8221;:&#8221;Important gift&#8221;<\/p>\n<p>&nbsp;&nbsp;&nbsp;},<\/p>\n<p>&nbsp;&nbsp;&nbsp;&#8220;cancel_url&#8221;:&#8221;https:\/\/example.com\/cancel&#8221;,<\/p>\n<p>&nbsp;&nbsp;&nbsp;&#8220;success_url&#8221;:&#8221;https:\/\/example.com\/success&#8221;,<\/p>\n<p>&nbsp;&nbsp;&nbsp;&#8220;customer&#8221;:{<\/p>\n<p>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&#8220;name&#8221;:&#8221;John Doe&#8221;,<\/p>\n<p>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&#8220;email&#8221;:&#8221;success@gmail.com&#8221;<\/p>\n<p>&nbsp;&nbsp;&nbsp;&nbsp;},<\/p>\n<p>&nbsp;&nbsp;&nbsp;&nbsp;&#8220;payee&#8221;: {<\/p>\n<p>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&#8220;name&#8221;:&#8221;John Doe&#8221;,<\/p>\n<p>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&#8220;email&#8221;:&#8221;success@gmail.com&#8221;<\/p>\n<p>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;},<\/p>\n<p>&nbsp;&nbsp;&nbsp;&nbsp;&#8220;billing_address&#8221;:{<\/p>\n<p>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&#8220;country&#8221;:&#8221;US&#8221;,<\/p>\n<p>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&#8220;state&#8221;:&#8221;California&#8221;,<\/p>\n<p>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&#8220;city&#8221;:&#8221;Los Angeles&#8221;,<\/p>\n<p>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&#8220;address&#8221;:&#8221;Moor Building 35274 State ST Fremont. U.S.A&#8221;,<\/p>\n<p>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&#8220;zip&#8221;:&#8221;94538&#8243;,<\/p>\n<p>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&#8220;phone&#8221;:&#8221;0987654321&#8243;,<\/p>\n<p>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&#8220;district&#8221;:&#8221;Brentwood&#8221;,<\/p>\n<p>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&#8220;house_number&#8221;:&#8221;123&#8243;<\/p>\n<p>&nbsp;&nbsp;&nbsp;&nbsp;},<\/p>\n<p>&nbsp;&nbsp;&nbsp;&nbsp;&#8220;payee_billing_address&#8221;:{<\/p>\n<p>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&#8220;country&#8221;:&#8221;US&#8221;,<\/p>\n<p>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&#8220;state&#8221;:&#8221;New York&#8221;,<\/p>\n<p>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&#8220;city&#8221;:&#8221;New York&#8221;,<\/p>\n<p>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&#8220;address&#8221;:&#8221;Moor Building 35274 State ST Fremont. U.S.A&#8221;,<\/p>\n<p>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&#8220;zip&#8221;:&#8221;94538&#8243;,<\/p>\n<p>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&#8220;phone&#8221;:&#8221;0987654321&#8243;,<\/p>\n<p>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&#8220;district&#8221;:&#8221;Brentwood&#8221;,<\/p>\n<p>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&#8220;house_number&#8221;:&#8221;123&#8243;<\/p>\n<p>&nbsp;&nbsp;&nbsp;&nbsp;},<\/p>\n<p>&nbsp;&nbsp;&nbsp;&#8220;hash&#8221;:&#8221;{{session_hash}}&#8221;<\/p>\n<p>}<\/p>\n<p>&#8216;<\/p>\n<\/div>\n<\/div><\/li><li><div class=\"betterdocs-faq-group\"><div class=\"betterdocs-faq-post\">\n    <div class=\"betterdocs-faq-post-icon-group\"><svg class=\"betterdocs-faq-iconplus\" xmlns=\"http:\/\/www.w3.org\/2000\/svg\" viewbox=\"0 0 24 24\"><path fill=\"#000000\" d=\"M18 10h-4V6h-4v4H6v4h4v4h4v-4h4\"><\/path><\/svg><svg class=\"betterdocs-faq-iconminus\" xmlns=\"http:\/\/www.w3.org\/2000\/svg\" viewbox=\"0 0 24 24\"><path fill=\"#000000\" d=\"M6 10h12v4H6z\"><\/path><\/svg><\/div>    <span class=\"betterdocs-faq-post-name\">\n        Example Response (OK)    <\/span>\n    <\/div>\n<div class=\"betterdocs-faq-main-content\">\n    <p>{<\/p>\n<p>&nbsp;&nbsp;&#8220;redirect_url&#8221;: &#8220;{{CHECKOUT_HOST}\/auth\/ZXlKMGVYQWlPaUpLVjFRaUxDSmhiR2NpT2lKU1V6STFOaUo5LmV5SnBZWFFpT2pFMU9UWXhPRFl6T0Rnc0ltcDBhU0k2SWpGbE5qTTNObVZoTFdRek1HUXRNVEZsWVMxaE16QXlMVEF5TkRKak1HRTRNekF4TWlJc0ltVjRjQ0k2TVRVNU5qRTRPVGs0T0gwLm9CMmVhdlRtTU5DMXFTajlDVFlqQ0dOMDlHdUs1NXRkQTVpWFR3d2F2cWR0cEpEU2NRWWFaT3Z5dmJSVjJUSFNUVlFlS0NUX3pRdFNycDlKS1M4X0pqUzRMclM5MnUyNXRfSHNGa1FUQ0VOdGtadHQtaGxONERYdVhkLTU5cEhKLUN1RXBqSmZ4UDZEQXhFaVAxWEpRZDlyQldNa1RQVDdGZm1ac0g4LTM5YnV6LTI3MWxKMndkekdvSGJYa0NKVnNTNFJldGxrbno2U3dGd3ZFMW5KNDhwYTBGMDNLWjBpNnhpRFVPR3p2U0ZKdGZfMndDTTdzTTdsemc1TlBmSDl0Q0RKQmZEaG1hUmJCRmR6RlZMZlJncG5tMzB3VWpTMGMxbmt6SkkxOGJTd2Z6Z0hfZFpnc1cyUFhCM2ZLdG9pWDJXeFRsQzlxR204QTRYVm9EQy1mOWxvRHlMd0F5eV9xY3JrWmNuQTJVSjk5Zl91c0cwODZKUlBTT0I4VHVRZndSTzUxSEN2bEU2TXdFYzVYRmtnYjBleEZRcXdpNGE4S2RlWV9HX3ZQam42bnpZODdtVzFINlpQMjJ0dzVzazYtUENMeHdvNXctUmFBWC1mYVVhcEVHTzFLZkVHbndaQWZBZVNyc3U4MV9XQUFJMlN5RUxGWi1IU1lXMUZLWFgybzNNeF93Ty1DS3FLTWZsUTV1cGc2eDAybzhsbFhoeGJlVmVIOWlkMHgzYldRWE9vWk5hWm1MeVpJMmJsT2dtVDV0cHR4NHNQNDNqT0NtYW1sdkxyUkZvQmxCNTJ4V0RUQTBZQnhBLW5meUxCRHRJN0dPaVRWQjJ5cWd1Z1lBdGRfbWFQN2x2YTJpbVJWaHhxT0R5SlRiZThxcDdhWkw4bkJvTHZocnZDOHlv&#8221;<\/p>\n<p>}<\/p>\n<\/div>\n<\/div><\/li><\/ul><script type=\"application\/ld+json\">{\"@context\":\"https:\\\/\\\/schema.org\",\"@type\":\"FAQPage\",\"mainEntity\":[{\"@type\":\"Question\",\"name\":\"Authentication (OK)\",\"acceptedAnswer\":{\"@type\":\"Answer\",\"text\":\"<p>curl --location -g --request POST '{{CHECKOUT_HOST}}\\\/api\\\/v1\\\/session' <\\\/p>\\n<p>--header 'Content-Type: application\\\/json' <\\\/p>\\n<p>--data-raw '{<\\\/p>\\n<p>&nbsp;&nbsp;\\\"merchant_key\\\": \\\"xxxxx-xxxxx-xxxxx\\\",<\\\/p>\\n<p>&nbsp;&nbsp;\\\"operation\\\": \\\"purchase\\\",<\\\/p>\\n<p>&nbsp;&nbsp;\\\"methods\\\": [<\\\/p>\\n<p>&nbsp;&nbsp;&nbsp;&nbsp;\\\"card\\\",<\\\/p>\\n<p>&nbsp;&nbsp;&nbsp;&nbsp;\\\"method1\\\"<\\\/p>\\n<p>&nbsp;&nbsp;],<\\\/p>\\n<p>&nbsp;&nbsp;\\\"parameters\\\": {<\\\/p>\\n<p>&nbsp;&nbsp;&nbsp;&nbsp;\\\"card\\\": {<\\\/p>\\n<p>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;\\\"param1\\\": \\\"val-1\\\",<\\\/p>\\n<p>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;\\\"param2\\\": \\\"val-2\\\"<\\\/p>\\n<p>&nbsp;&nbsp;&nbsp;&nbsp;},<\\\/p>\\n<p>&nbsp;&nbsp;&nbsp;&nbsp;\\\"method1\\\": {<\\\/p>\\n<p>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;\\\"param1\\\": \\\"val-3\\\",<\\\/p>\\n<p>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;\\\"param2\\\": \\\"val-4\\\"<\\\/p>\\n<p>&nbsp;&nbsp;&nbsp;&nbsp;}<\\\/p>\\n<p>&nbsp;&nbsp;},<\\\/p>\\n<p>&nbsp;&nbsp;\\\"session_expiry\\\": 60,<\\\/p>\\n<p>&nbsp;&nbsp;\\\"order\\\": {<\\\/p>\\n<p>&nbsp;&nbsp;&nbsp;&nbsp;\\\"number\\\": \\\"order-1234\\\",<\\\/p>\\n<p>&nbsp;&nbsp;&nbsp;&nbsp;\\\"amount\\\": \\\"0.19\\\",<\\\/p>\\n<p>&nbsp;&nbsp;&nbsp;&nbsp;\\\"currency\\\": \\\"USD\\\",<\\\/p>\\n<p>&nbsp;&nbsp;&nbsp;&nbsp;\\\"description\\\": \\\"Important gift\\\"<\\\/p>\\n<p>&nbsp;&nbsp;},<\\\/p>\\n<p>&nbsp;&nbsp;\\\"cancel_url\\\": \\\"https:\\\/\\\/example.domain.com\\\/cancel\\\",<\\\/p>\\n<p>&nbsp;&nbsp;\\\"success_url\\\": \\\"https:\\\/\\\/example.domain.com\\\/success\\\",<\\\/p>\\n<p>&nbsp;&nbsp;\\\"expiry_url\\\": \\\"https:\\\/\\\/example.domain.com\\\/expiry\\\",<\\\/p>\\n<p>&nbsp;&nbsp;\\\"url_target\\\": \\\"_blank\\\",<\\\/p>\\n<p>&nbsp;&nbsp;\\\"customer\\\": {<\\\/p>\\n<p>&nbsp;&nbsp;&nbsp;&nbsp;\\\"name\\\": \\\"John Doe\\\",<\\\/p>\\n<p>&nbsp;&nbsp;&nbsp;&nbsp;\\\"email\\\": \\\"test@gmail.com\\\"<\\\/p>\\n<p>&nbsp;&nbsp;},<\\\/p>\\n<p>&nbsp;&nbsp;\\\"billing_address\\\": {<\\\/p>\\n<p>&nbsp;&nbsp;&nbsp;&nbsp;\\\"country\\\": \\\"US\\\",<\\\/p>\\n<p>&nbsp;&nbsp;&nbsp;&nbsp;\\\"state\\\": \\\"CA\\\",<\\\/p>\\n<p>&nbsp;&nbsp;&nbsp;&nbsp;\\\"city\\\": \\\"Los Angeles\\\",<\\\/p>\\n<p>&nbsp;&nbsp;&nbsp;&nbsp;\\\"disctrict\\\": \\\"Beverlywood\\\",<\\\/p>\\n<p>&nbsp;&nbsp;&nbsp;&nbsp;\\\"address\\\": \\\"Moor Building 35274\\\",<\\\/p>\\n<p>&nbsp;&nbsp;&nbsp;&nbsp;\\\"house_number\\\": \\\"17\\\/2\\\",<\\\/p>\\n<p>&nbsp;&nbsp;&nbsp;&nbsp;\\\"zip\\\": \\\"123456\\\",<\\\/p>\\n<p>&nbsp;&nbsp;&nbsp;&nbsp;\\\"phone\\\": \\\"347771112233\\\"<\\\/p>\\n<p>&nbsp;&nbsp;},<\\\/p>\\n<p>&nbsp;&nbsp;\\\"card_token\\\": [<\\\/p>\\n<p>&nbsp;&nbsp;&nbsp;&nbsp;\\\"f5d6a0ab6fcfb6487a39e2256e50fff3c95aaa97075ee5e539bb662fceff4dc1\\\"<\\\/p>\\n<p>&nbsp;&nbsp;],<\\\/p>\\n<p>&nbsp;&nbsp;\\\"req_token\\\": true,<\\\/p>\\n<p>&nbsp;&nbsp;\\\"recurring_init\\\": true,<\\\/p>\\n<p>&nbsp;&nbsp;\\\"schedule_id\\\": \\\"9d0f5cc4-f07b-11ec-abf4-0242ac120006\\\",<\\\/p>\\n<p>&nbsp;&nbsp;\\\"hash\\\": \\\"{{session_hash}}\\\"<\\\/p>\\n<p>}<\\\/p>\\n<p>'<\\\/p>\\n\"}},{\"@type\":\"Question\",\"name\":\"Debit Operation (OK)\",\"acceptedAnswer\":{\"@type\":\"Answer\",\"text\":\"<p>curl --location -g --request POST '{{CHECKOUT_HOST}}\\\/api\\\/v1\\\/session' <\\\/p>\\n<p>--header 'Content-Type: application\\\/json' <\\\/p>\\n<p>--data-raw '{<\\\/p>\\n<p>&nbsp;&nbsp;\\\"merchant_key\\\": \\\"xxxxx-xxxxx-xxxxx\\\",<\\\/p>\\n<p>&nbsp;&nbsp;\\\"operation\\\": \\\"debit\\\",<\\\/p>\\n<p>&nbsp;&nbsp;\\\"methods\\\": [<\\\/p>\\n<p>&nbsp;&nbsp;&nbsp;&nbsp;\\\"card\\\"<\\\/p>\\n<p>&nbsp;&nbsp;],<\\\/p>\\n<p>&nbsp;&nbsp;\\\"parameters\\\": {<\\\/p>\\n<p>&nbsp;&nbsp;&nbsp;&nbsp;\\\"card\\\": {<\\\/p>\\n<p>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;\\\"param1\\\": \\\"val-1\\\",<\\\/p>\\n<p>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;\\\"param2\\\": \\\"val-2\\\"<\\\/p>\\n<p>&nbsp;&nbsp;&nbsp;&nbsp;},<\\\/p>\\n<p>&nbsp;&nbsp;&nbsp;&nbsp;\\\"session_expiry\\\": 60,<\\\/p>\\n<p>&nbsp;&nbsp;&nbsp;&nbsp;\\\"order\\\": {<\\\/p>\\n<p>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;\\\"number\\\": \\\"order-1234\\\",<\\\/p>\\n<p>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;\\\"amount\\\": \\\"0.19\\\",<\\\/p>\\n<p>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;\\\"currency\\\": \\\"USD\\\",<\\\/p>\\n<p>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;\\\"description\\\": \\\"Important gift\\\"<\\\/p>\\n<p>&nbsp;&nbsp;&nbsp;&nbsp;},<\\\/p>\\n<p>&nbsp;&nbsp;&nbsp;&nbsp;\\\"cancel_url\\\": \\\"https:\\\/\\\/example.domain.com\\\/cancel\\\",<\\\/p>\\n<p>&nbsp;&nbsp;&nbsp;&nbsp;\\\"success_url\\\": \\\"https:\\\/\\\/example.domain.com\\\/success\\\",<\\\/p>\\n<p>&nbsp;&nbsp;&nbsp;&nbsp;\\\"expiry_url\\\": \\\"https:\\\/\\\/example.domain.com\\\/expiry\\\",<\\\/p>\\n<p>&nbsp;&nbsp;&nbsp;&nbsp;\\\"url_target\\\": \\\"_blank\\\",<\\\/p>\\n<p>&nbsp;&nbsp;&nbsp;&nbsp;\\\"customer\\\": {<\\\/p>\\n<p>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;\\\"name\\\": \\\"John Doe\\\",<\\\/p>\\n<p>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;\\\"email\\\": \\\"test@gmail.com\\\"<\\\/p>\\n<p>&nbsp;&nbsp;&nbsp;&nbsp;},<\\\/p>\\n<p>&nbsp;&nbsp;&nbsp;&nbsp;\\\"billing_address\\\": {<\\\/p>\\n<p>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;\\\"country\\\": \\\"US\\\",<\\\/p>\\n<p>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;\\\"state\\\": \\\"CA\\\",<\\\/p>\\n<p>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;\\\"city\\\": \\\"Los Angeles\\\",<\\\/p>\\n<p>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;\\\"disctrict\\\": \\\"Beverlywood\\\",<\\\/p>\\n<p>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;\\\"address\\\": \\\"Moor Building 35274\\\",<\\\/p>\\n<p>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;\\\"house_number\\\": \\\"17\\\/2\\\",<\\\/p>\\n<p>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;\\\"zip\\\": \\\"123456\\\",<\\\/p>\\n<p>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;\\\"phone\\\": \\\"347771112233\\\"<\\\/p>\\n<p>&nbsp;&nbsp;&nbsp;&nbsp;},<\\\/p>\\n<p>&nbsp;&nbsp;&nbsp;&nbsp;\\\"card_token\\\": [<\\\/p>\\n<p>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;\\\"f5d6a0ab6fcfb6487a39e2256e50fff3c95aaa97075ee5e539bb662fceff4dc1\\\"<\\\/p>\\n<p>&nbsp;&nbsp;&nbsp;&nbsp;],<\\\/p>\\n<p>&nbsp;&nbsp;&nbsp;&nbsp;\\\"req_token\\\": true,<\\\/p>\\n<p>&nbsp;&nbsp;&nbsp;&nbsp;\\\"hash\\\": \\\"{{session_hash}}\\\"<\\\/p>\\n<p>&nbsp;&nbsp;}<\\\/p>\\n<p>}<\\\/p>\\n<p>'<\\\/p>\\n\"}},{\"@type\":\"Question\",\"name\":\"Transfer Operation (OK)\",\"acceptedAnswer\":{\"@type\":\"Answer\",\"text\":\"<p>curl --location -g --request POST '{{CHECKOUT_HOST}}\\\/api\\\/v1\\\/session' <\\\/p>\\n<p>--header 'Content-Type: application\\\/json' <\\\/p>\\n<p>--data-raw '{&nbsp;&nbsp;<\\\/p>\\n<p>&nbsp;&nbsp;&nbsp;\\\"merchant_key\\\":\\\"xxxxx-xxxxx-xxxxx\\\",<\\\/p>\\n<p>&nbsp;&nbsp;&nbsp;\\\"operation\\\":\\\"transfer\\\",<\\\/p>\\n<p>&nbsp;&nbsp;&nbsp;\\\"order\\\":{<\\\/p>\\n<p>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;\\\"number\\\":\\\"order-1234\\\",<\\\/p>\\n<p>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;\\\"amount\\\": \\\"100.55\\\",<\\\/p>\\n<p>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;\\\"currency\\\":\\\"USD\\\",<\\\/p>\\n<p>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;\\\"description\\\":\\\"Important gift\\\"<\\\/p>\\n<p>&nbsp;&nbsp;&nbsp;},<\\\/p>\\n<p>&nbsp;&nbsp;&nbsp;\\\"cancel_url\\\":\\\"https:\\\/\\\/example.com\\\/cancel\\\",<\\\/p>\\n<p>&nbsp;&nbsp;&nbsp;\\\"success_url\\\":\\\"https:\\\/\\\/example.com\\\/success\\\",<\\\/p>\\n<p>&nbsp;&nbsp;&nbsp;\\\"customer\\\":{<\\\/p>\\n<p>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;\\\"name\\\":\\\"John Doe\\\",<\\\/p>\\n<p>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;\\\"email\\\":\\\"success@gmail.com\\\"<\\\/p>\\n<p>&nbsp;&nbsp;&nbsp;&nbsp;},<\\\/p>\\n<p>&nbsp;&nbsp;&nbsp;&nbsp;\\\"payee\\\": {<\\\/p>\\n<p>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;\\\"name\\\":\\\"John Doe\\\",<\\\/p>\\n<p>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;\\\"email\\\":\\\"success@gmail.com\\\"<\\\/p>\\n<p>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;},<\\\/p>\\n<p>&nbsp;&nbsp;&nbsp;&nbsp;\\\"billing_address\\\":{<\\\/p>\\n<p>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;\\\"country\\\":\\\"US\\\",<\\\/p>\\n<p>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;\\\"state\\\":\\\"California\\\",<\\\/p>\\n<p>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;\\\"city\\\":\\\"Los Angeles\\\",<\\\/p>\\n<p>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;\\\"address\\\":\\\"Moor Building 35274 State ST Fremont. U.S.A\\\",<\\\/p>\\n<p>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;\\\"zip\\\":\\\"94538\\\",<\\\/p>\\n<p>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;\\\"phone\\\":\\\"0987654321\\\",<\\\/p>\\n<p>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;\\\"district\\\":\\\"Brentwood\\\",<\\\/p>\\n<p>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;\\\"house_number\\\":\\\"123\\\"<\\\/p>\\n<p>&nbsp;&nbsp;&nbsp;&nbsp;},<\\\/p>\\n<p>&nbsp;&nbsp;&nbsp;&nbsp;\\\"payee_billing_address\\\":{<\\\/p>\\n<p>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;\\\"country\\\":\\\"US\\\",<\\\/p>\\n<p>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;\\\"state\\\":\\\"New York\\\",<\\\/p>\\n<p>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;\\\"city\\\":\\\"New York\\\",<\\\/p>\\n<p>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;\\\"address\\\":\\\"Moor Building 35274 State ST Fremont. U.S.A\\\",<\\\/p>\\n<p>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;\\\"zip\\\":\\\"94538\\\",<\\\/p>\\n<p>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;\\\"phone\\\":\\\"0987654321\\\",<\\\/p>\\n<p>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;\\\"district\\\":\\\"Brentwood\\\",<\\\/p>\\n<p>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;\\\"house_number\\\":\\\"123\\\"<\\\/p>\\n<p>&nbsp;&nbsp;&nbsp;&nbsp;},<\\\/p>\\n<p>&nbsp;&nbsp;&nbsp;\\\"hash\\\":\\\"{{session_hash}}\\\"<\\\/p>\\n<p>}<\\\/p>\\n<p>'<\\\/p>\\n\"}},{\"@type\":\"Question\",\"name\":\"Example Response (OK)\",\"acceptedAnswer\":{\"@type\":\"Answer\",\"text\":\"<p>{<\\\/p>\\n<p>&nbsp;&nbsp;\\\"redirect_url\\\": \\\"{{CHECKOUT_HOST}\\\/auth\\\/ZXlKMGVYQWlPaUpLVjFRaUxDSmhiR2NpT2lKU1V6STFOaUo5LmV5SnBZWFFpT2pFMU9UWXhPRFl6T0Rnc0ltcDBhU0k2SWpGbE5qTTNObVZoTFdRek1HUXRNVEZsWVMxaE16QXlMVEF5TkRKak1HRTRNekF4TWlJc0ltVjRjQ0k2TVRVNU5qRTRPVGs0T0gwLm9CMmVhdlRtTU5DMXFTajlDVFlqQ0dOMDlHdUs1NXRkQTVpWFR3d2F2cWR0cEpEU2NRWWFaT3Z5dmJSVjJUSFNUVlFlS0NUX3pRdFNycDlKS1M4X0pqUzRMclM5MnUyNXRfSHNGa1FUQ0VOdGtadHQtaGxONERYdVhkLTU5cEhKLUN1RXBqSmZ4UDZEQXhFaVAxWEpRZDlyQldNa1RQVDdGZm1ac0g4LTM5YnV6LTI3MWxKMndkekdvSGJYa0NKVnNTNFJldGxrbno2U3dGd3ZFMW5KNDhwYTBGMDNLWjBpNnhpRFVPR3p2U0ZKdGZfMndDTTdzTTdsemc1TlBmSDl0Q0RKQmZEaG1hUmJCRmR6RlZMZlJncG5tMzB3VWpTMGMxbmt6SkkxOGJTd2Z6Z0hfZFpnc1cyUFhCM2ZLdG9pWDJXeFRsQzlxR204QTRYVm9EQy1mOWxvRHlMd0F5eV9xY3JrWmNuQTJVSjk5Zl91c0cwODZKUlBTT0I4VHVRZndSTzUxSEN2bEU2TXdFYzVYRmtnYjBleEZRcXdpNGE4S2RlWV9HX3ZQam42bnpZODdtVzFINlpQMjJ0dzVzazYtUENMeHdvNXctUmFBWC1mYVVhcEVHTzFLZkVHbndaQWZBZVNyc3U4MV9XQUFJMlN5RUxGWi1IU1lXMUZLWFgybzNNeF93Ty1DS3FLTWZsUTV1cGc2eDAybzhsbFhoeGJlVmVIOWlkMHgzYldRWE9vWk5hWm1MeVpJMmJsT2dtVDV0cHR4NHNQNDNqT0NtYW1sdkxyUkZvQmxCNTJ4V0RUQTBZQnhBLW5meUxCRHRJN0dPaVRWQjJ5cWd1Z1lBdGRfbWFQN2x2YTJpbVJWaHhxT0R5SlRiZThxcDdhWkw4bkJvTHZocnZDOHlv\\\"<\\\/p>\\n<p>}<\\\/p>\\n\"}}]}<\/script>    <\/div>\n<\/div>\n\n\n\n<h2 class=\"wp-block-heading\" id=\"authentication-request-possible-errors\">Authentication request possible errors<\/h2>\n\n\n\n<hr class=\"wp-block-separator has-alpha-channel-opacity\"\/>\n\n\n\n<h3 class=\"wp-block-heading\" id=\"parameter-values-validation\">Parameter Values Validation<\/h3>\n\n\n\n<p>Checkout service validates the request parameters and sends the error responses in case of an invalid data detection.<\/p>\n\n\n<div\n    class=\"betterdocs-faq-wrapper layout-classic icon-before betterdocs-faq-layout-2 betterdocs-faq-xgfv0iu betterdocs-shortcode\">\n    <h2 class=\"betterdocs-faq-layout-2 betterdocs-faq-xgfv0iu betterdocs-faq-section-title\">\n            <\/h2>\n\n    <div class=\"betterdocs-faq-inner-wrapper\">\n        <div class=\"betterdocs-faq-title\">\n    <h2>Parameter Values Validation<\/h2>\n<\/div>\n<ul class=\"betterdocs-faq-list\"><li><div class=\"betterdocs-faq-group\"><div class=\"betterdocs-faq-post\">\n    <div class=\"betterdocs-faq-post-icon-group\"><svg class=\"betterdocs-faq-iconplus\" xmlns=\"http:\/\/www.w3.org\/2000\/svg\" viewbox=\"0 0 24 24\"><path fill=\"#000000\" d=\"M18 10h-4V6h-4v4H6v4h4v4h4v-4h4\"><\/path><\/svg><svg class=\"betterdocs-faq-iconminus\" xmlns=\"http:\/\/www.w3.org\/2000\/svg\" viewbox=\"0 0 24 24\"><path fill=\"#000000\" d=\"M6 10h12v4H6z\"><\/path><\/svg><\/div>    <span class=\"betterdocs-faq-post-name\">\n        Example Request &#8211; Validation (bad)    <\/span>\n    <\/div>\n<div class=\"betterdocs-faq-main-content\">\n    <p>curl &#8211;location -g &#8211;request POST &#8216;{{CHECKOUT_HOST}}\/api\/v1\/session&#8217; <\/p>\n<p>&#8211;header &#8216;Content-Type: application\/json&#8217; <\/p>\n<p>&#8211;data-raw &#8216;{&nbsp;&nbsp;<\/p>\n<p>&nbsp;&nbsp;&nbsp;&#8220;merchant_key&#8221;:&#8221;xxxxx-xxxxx-xxxxx&#8221;,<\/p>\n<p>&nbsp;&nbsp;&nbsp;&#8220;operation&#8221;:&#8221;credit&#8221;,<\/p>\n<p>&nbsp;&nbsp;&nbsp;&#8220;methods&#8221;:[ &#8220;&#8221; ],<\/p>\n<p>&nbsp;&nbsp;&nbsp;&#8220;order&#8221;:{<\/p>\n<p>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&#8220;number&#8221;:&#8221;&#8221;,<\/p>\n<p>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&#8220;amount&#8221;: &#8220;1.2&#8221;,<\/p>\n<p>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&#8220;currency&#8221;:&#8221;Dollar&#8221;,<\/p>\n<p>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&#8220;description&#8221;:&#8221;&#8221;<\/p>\n<p>&nbsp;&nbsp;&nbsp;},<\/p>\n<p>&nbsp;&nbsp;&nbsp;&#8220;cancel_url&#8221;:&#8221;1.com&#8221;,<\/p>\n<p>&nbsp;&nbsp;&nbsp;&#8220;success_url&#8221;:&#8221;&#8221;,<\/p>\n<p>&nbsp;&nbsp;&nbsp;&#8220;customer&#8221;:{<\/p>\n<p>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&#8220;name&#8221;:&#8221;John Doe&#8221;,<\/p>\n<p>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&#8220;email&#8221;:&#8221;example@mail.com&#8221;<\/p>\n<p>&nbsp;&nbsp;&nbsp;},<\/p>\n<p>&nbsp;&nbsp;&nbsp;&#8220;recurring_init&#8221;: &#8220;true&#8221;,<\/p>\n<p>&nbsp;&nbsp;&nbsp;&#8220;hash&#8221;:&#8221;728d13b95cf2b6b3ee04b20dc2fc9889ffff1cf4&#8243;<\/p>\n<p>}<\/p>\n<p>&#8216;<\/p>\n<\/div>\n<\/div><\/li><li><div class=\"betterdocs-faq-group\"><div class=\"betterdocs-faq-post\">\n    <div class=\"betterdocs-faq-post-icon-group\"><svg class=\"betterdocs-faq-iconplus\" xmlns=\"http:\/\/www.w3.org\/2000\/svg\" viewbox=\"0 0 24 24\"><path fill=\"#000000\" d=\"M18 10h-4V6h-4v4H6v4h4v4h4v-4h4\"><\/path><\/svg><svg class=\"betterdocs-faq-iconminus\" xmlns=\"http:\/\/www.w3.org\/2000\/svg\" viewbox=\"0 0 24 24\"><path fill=\"#000000\" d=\"M6 10h12v4H6z\"><\/path><\/svg><\/div>    <span class=\"betterdocs-faq-post-name\">\n        Example Response &#8211; 400 Bad Request    <\/span>\n    <\/div>\n<div class=\"betterdocs-faq-main-content\">\n    <p>{<\/p>\n<p>&nbsp;&nbsp;&#8220;error_code&#8221;: 0,<\/p>\n<p>&nbsp;&nbsp;&#8220;error_message&#8221;: &#8220;Request data is invalid.&#8221;,<\/p>\n<p>&nbsp;&nbsp;&#8220;errors&#8221;: [<\/p>\n<p>&nbsp;&nbsp;&nbsp;&nbsp;{<\/p>\n<p>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&#8220;error_code&#8221;: 100000,<\/p>\n<p>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&#8220;error_message&#8221;: &#8220;operation: The value you selected is not a valid choice.&#8221;<\/p>\n<p>&nbsp;&nbsp;&nbsp;&nbsp;},<\/p>\n<p>&nbsp;&nbsp;&nbsp;&nbsp;{<\/p>\n<p>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&#8220;error_code&#8221;: 100000,<\/p>\n<p>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&#8220;error_message&#8221;: &#8220;methods: This value should not be blank.&#8221;<\/p>\n<p>&nbsp;&nbsp;&nbsp;&nbsp;},<\/p>\n<p>&nbsp;&nbsp;&nbsp;&nbsp;{<\/p>\n<p>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&#8220;error_code&#8221;: 100000,<\/p>\n<p>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&#8220;error_message&#8221;: &#8220;order.number: This value should not be blank.&#8221;<\/p>\n<p>&nbsp;&nbsp;&nbsp;&nbsp;},<\/p>\n<p>&nbsp;&nbsp;&nbsp;&nbsp;{<\/p>\n<p>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&#8220;error_code&#8221;: 100000,<\/p>\n<p>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&#8220;error_message&#8221;: &#8220;order.amount: This value should be greater than 0.&#8221;<\/p>\n<p>&nbsp;&nbsp;&nbsp;&nbsp;},<\/p>\n<p>&nbsp;&nbsp;&nbsp;&nbsp;{<\/p>\n<p>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&#8220;error_code&#8221;: 100000,<\/p>\n<p>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&#8220;error_message&#8221;: &#8220;order.currency: This value is not valid.&#8221;<\/p>\n<p>&nbsp;&nbsp;&nbsp;&nbsp;},<\/p>\n<p>&nbsp;&nbsp;&nbsp;&nbsp;{<\/p>\n<p>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&#8220;error_code&#8221;: 100000,<\/p>\n<p>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&#8220;error_message&#8221;: &#8220;order.description: This value should not be blank.&#8221;<\/p>\n<p>&nbsp;&nbsp;&nbsp;&nbsp;},<\/p>\n<p>&nbsp;&nbsp;&nbsp;&nbsp;{<\/p>\n<p>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&#8220;error_code&#8221;: 100000,<\/p>\n<p>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&#8220;error_message&#8221;: &#8220;cancel_url: This value is not a valid URL.&#8221;<\/p>\n<p>&nbsp;&nbsp;&nbsp;&nbsp;},<\/p>\n<p>&nbsp;&nbsp;&nbsp;&nbsp;{<\/p>\n<p>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&#8220;error_code&#8221;: 100000,<\/p>\n<p>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&#8220;error_message&#8221;: &#8220;success_url: This value should not be blank.&#8221;<\/p>\n<p>&nbsp;&nbsp;&nbsp;&nbsp;}<\/p>\n<p>&nbsp;&nbsp;]<\/p>\n<p>}<\/p>\n<\/div>\n<\/div><\/li><\/ul><script type=\"application\/ld+json\">{\"@context\":\"https:\\\/\\\/schema.org\",\"@type\":\"FAQPage\",\"mainEntity\":[{\"@type\":\"Question\",\"name\":\"Example Request &#8211; Validation (bad)\",\"acceptedAnswer\":{\"@type\":\"Answer\",\"text\":\"<p>curl --location -g --request POST '{{CHECKOUT_HOST}}\\\/api\\\/v1\\\/session' <\\\/p>\\n<p>--header 'Content-Type: application\\\/json' <\\\/p>\\n<p>--data-raw '{&nbsp;&nbsp;<\\\/p>\\n<p>&nbsp;&nbsp;&nbsp;\\\"merchant_key\\\":\\\"xxxxx-xxxxx-xxxxx\\\",<\\\/p>\\n<p>&nbsp;&nbsp;&nbsp;\\\"operation\\\":\\\"credit\\\",<\\\/p>\\n<p>&nbsp;&nbsp;&nbsp;\\\"methods\\\":[ \\\"\\\" ],<\\\/p>\\n<p>&nbsp;&nbsp;&nbsp;\\\"order\\\":{<\\\/p>\\n<p>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;\\\"number\\\":\\\"\\\",<\\\/p>\\n<p>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;\\\"amount\\\": \\\"1.2\\\",<\\\/p>\\n<p>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;\\\"currency\\\":\\\"Dollar\\\",<\\\/p>\\n<p>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;\\\"description\\\":\\\"\\\"<\\\/p>\\n<p>&nbsp;&nbsp;&nbsp;},<\\\/p>\\n<p>&nbsp;&nbsp;&nbsp;\\\"cancel_url\\\":\\\"1.com\\\",<\\\/p>\\n<p>&nbsp;&nbsp;&nbsp;\\\"success_url\\\":\\\"\\\",<\\\/p>\\n<p>&nbsp;&nbsp;&nbsp;\\\"customer\\\":{<\\\/p>\\n<p>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;\\\"name\\\":\\\"John Doe\\\",<\\\/p>\\n<p>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;\\\"email\\\":\\\"example@mail.com\\\"<\\\/p>\\n<p>&nbsp;&nbsp;&nbsp;},<\\\/p>\\n<p>&nbsp;&nbsp;&nbsp;\\\"recurring_init\\\": \\\"true\\\",<\\\/p>\\n<p>&nbsp;&nbsp;&nbsp;\\\"hash\\\":\\\"728d13b95cf2b6b3ee04b20dc2fc9889ffff1cf4\\\"<\\\/p>\\n<p>}<\\\/p>\\n<p>'<\\\/p>\\n\"}},{\"@type\":\"Question\",\"name\":\"Example Response &#8211; 400 Bad Request\",\"acceptedAnswer\":{\"@type\":\"Answer\",\"text\":\"<p>{<\\\/p>\\n<p>&nbsp;&nbsp;\\\"error_code\\\": 0,<\\\/p>\\n<p>&nbsp;&nbsp;\\\"error_message\\\": \\\"Request data is invalid.\\\",<\\\/p>\\n<p>&nbsp;&nbsp;\\\"errors\\\": [<\\\/p>\\n<p>&nbsp;&nbsp;&nbsp;&nbsp;{<\\\/p>\\n<p>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;\\\"error_code\\\": 100000,<\\\/p>\\n<p>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;\\\"error_message\\\": \\\"operation: The value you selected is not a valid choice.\\\"<\\\/p>\\n<p>&nbsp;&nbsp;&nbsp;&nbsp;},<\\\/p>\\n<p>&nbsp;&nbsp;&nbsp;&nbsp;{<\\\/p>\\n<p>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;\\\"error_code\\\": 100000,<\\\/p>\\n<p>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;\\\"error_message\\\": \\\"methods: This value should not be blank.\\\"<\\\/p>\\n<p>&nbsp;&nbsp;&nbsp;&nbsp;},<\\\/p>\\n<p>&nbsp;&nbsp;&nbsp;&nbsp;{<\\\/p>\\n<p>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;\\\"error_code\\\": 100000,<\\\/p>\\n<p>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;\\\"error_message\\\": \\\"order.number: This value should not be blank.\\\"<\\\/p>\\n<p>&nbsp;&nbsp;&nbsp;&nbsp;},<\\\/p>\\n<p>&nbsp;&nbsp;&nbsp;&nbsp;{<\\\/p>\\n<p>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;\\\"error_code\\\": 100000,<\\\/p>\\n<p>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;\\\"error_message\\\": \\\"order.amount: This value should be greater than 0.\\\"<\\\/p>\\n<p>&nbsp;&nbsp;&nbsp;&nbsp;},<\\\/p>\\n<p>&nbsp;&nbsp;&nbsp;&nbsp;{<\\\/p>\\n<p>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;\\\"error_code\\\": 100000,<\\\/p>\\n<p>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;\\\"error_message\\\": \\\"order.currency: This value is not valid.\\\"<\\\/p>\\n<p>&nbsp;&nbsp;&nbsp;&nbsp;},<\\\/p>\\n<p>&nbsp;&nbsp;&nbsp;&nbsp;{<\\\/p>\\n<p>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;\\\"error_code\\\": 100000,<\\\/p>\\n<p>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;\\\"error_message\\\": \\\"order.description: This value should not be blank.\\\"<\\\/p>\\n<p>&nbsp;&nbsp;&nbsp;&nbsp;},<\\\/p>\\n<p>&nbsp;&nbsp;&nbsp;&nbsp;{<\\\/p>\\n<p>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;\\\"error_code\\\": 100000,<\\\/p>\\n<p>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;\\\"error_message\\\": \\\"cancel_url: This value is not a valid URL.\\\"<\\\/p>\\n<p>&nbsp;&nbsp;&nbsp;&nbsp;},<\\\/p>\\n<p>&nbsp;&nbsp;&nbsp;&nbsp;{<\\\/p>\\n<p>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;\\\"error_code\\\": 100000,<\\\/p>\\n<p>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;\\\"error_message\\\": \\\"success_url: This value should not be blank.\\\"<\\\/p>\\n<p>&nbsp;&nbsp;&nbsp;&nbsp;}<\\\/p>\\n<p>&nbsp;&nbsp;]<\\\/p>\\n<p>}<\\\/p>\\n\"}}]}<\/script>    <\/div>\n<\/div>\n\n\n\n<h3 class=\"wp-block-heading\" id=\"hash-validation\">Hash Validation<\/h3>\n\n\n\n<p>The Checkout service always performs <code>hash<\/code> validation. The request will be rejected if the <code>hash<\/code> value is invalid.<\/p>\n\n\n<div\n    class=\"betterdocs-faq-wrapper layout-classic icon-before betterdocs-faq-layout-2 betterdocs-faq-cgzvkx9 betterdocs-shortcode\">\n    <h2 class=\"betterdocs-faq-layout-2 betterdocs-faq-cgzvkx9 betterdocs-faq-section-title\">\n            <\/h2>\n\n    <div class=\"betterdocs-faq-inner-wrapper\">\n        <div class=\"betterdocs-faq-title\">\n    <h2>Hash validation<\/h2>\n<\/div>\n<ul class=\"betterdocs-faq-list\"><li><div class=\"betterdocs-faq-group\"><div class=\"betterdocs-faq-post\">\n    <div class=\"betterdocs-faq-post-icon-group\"><svg class=\"betterdocs-faq-iconplus\" xmlns=\"http:\/\/www.w3.org\/2000\/svg\" viewbox=\"0 0 24 24\"><path fill=\"#000000\" d=\"M18 10h-4V6h-4v4H6v4h4v4h4v-4h4\"><\/path><\/svg><svg class=\"betterdocs-faq-iconminus\" xmlns=\"http:\/\/www.w3.org\/2000\/svg\" viewbox=\"0 0 24 24\"><path fill=\"#000000\" d=\"M6 10h12v4H6z\"><\/path><\/svg><\/div>    <span class=\"betterdocs-faq-post-name\">\n        Example Request &#8211; Hash Validation    <\/span>\n    <\/div>\n<div class=\"betterdocs-faq-main-content\">\n    <p>curl &#8211;location -g &#8211;request POST &#8216;{{CHECKOUT_HOST}}\/api\/v1\/session&#8217; <\/p>\n<p>&#8211;header &#8216;Content-Type: application\/json&#8217; <\/p>\n<p>&#8211;data-raw &#8216;{&nbsp;&nbsp;<\/p>\n<p>&nbsp;&nbsp;&nbsp;&#8220;merchant_key&#8221;:&#8221;xxxxx-xxxxx-xxxxx&#8221;,<\/p>\n<p>&nbsp;&nbsp;&nbsp;&#8220;operation&#8221;:&#8221;purchase&#8221;,<\/p>\n<p>&nbsp;&nbsp;&nbsp;&#8220;methods&#8221;:[<\/p>\n<p>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&#8220;card&#8221;<\/p>\n<p>&nbsp;&nbsp;&nbsp;],<\/p>\n<p>&nbsp;&nbsp;&nbsp;&#8220;order&#8221;:{<\/p>\n<p>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&#8220;number&#8221;:&#8221;order-1234&#8243;,<\/p>\n<p>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&#8220;amount&#8221;: &#8220;0.19&#8221;,<\/p>\n<p>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&#8220;currency&#8221;:&#8221;USD&#8221;,<\/p>\n<p>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&#8220;description&#8221;:&#8221;Important gift&#8221;<\/p>\n<p>&nbsp;&nbsp;&nbsp;},<\/p>\n<p>&nbsp;&nbsp;&nbsp;&#8220;cancel_url&#8221;:&#8221;https:\/\/example.com\/cancel&#8221;,<\/p>\n<p>&nbsp;&nbsp;&nbsp;&#8220;success_url&#8221;:&#8221;https:\/\/example.com\/success&#8221;,<\/p>\n<p>&nbsp;&nbsp;&nbsp;&#8220;customer&#8221;:{<\/p>\n<p>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&#8220;name&#8221;:&#8221;John Doe&#8221;<\/p>\n<p>&nbsp;&nbsp;&nbsp;},<\/p>\n<p>&nbsp;&nbsp;&nbsp;&#8220;hash&#8221;:&#8221;wrong hash&#8221;<\/p>\n<p>}<\/p>\n<p>&#8216;<\/p>\n<\/div>\n<\/div><\/li><li><div class=\"betterdocs-faq-group\"><div class=\"betterdocs-faq-post\">\n    <div class=\"betterdocs-faq-post-icon-group\"><svg class=\"betterdocs-faq-iconplus\" xmlns=\"http:\/\/www.w3.org\/2000\/svg\" viewbox=\"0 0 24 24\"><path fill=\"#000000\" d=\"M18 10h-4V6h-4v4H6v4h4v4h4v-4h4\"><\/path><\/svg><svg class=\"betterdocs-faq-iconminus\" xmlns=\"http:\/\/www.w3.org\/2000\/svg\" viewbox=\"0 0 24 24\"><path fill=\"#000000\" d=\"M6 10h12v4H6z\"><\/path><\/svg><\/div>    <span class=\"betterdocs-faq-post-name\">\n        Example Response &#8211; Hash error    <\/span>\n    <\/div>\n<div class=\"betterdocs-faq-main-content\">\n    <p>{<\/p>\n<p>&nbsp;&nbsp;&#8220;error_code&#8221;: 0,<\/p>\n<p>&nbsp;&nbsp;&#8220;error_message&#8221;: &#8220;Request data is invalid.&#8221;,<\/p>\n<p>&nbsp;&nbsp;&#8220;errors&#8221;: [<\/p>\n<p>&nbsp;&nbsp;&nbsp;&nbsp;{<\/p>\n<p>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&#8220;error_code&#8221;: 100000,<\/p>\n<p>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&#8220;error_message&#8221;: &#8220;hash: Hash is not valid.&#8221;<\/p>\n<p>&nbsp;&nbsp;&nbsp;&nbsp;}<\/p>\n<p>&nbsp;&nbsp;]<\/p>\n<p>}<\/p>\n<\/div>\n<\/div><\/li><\/ul><script type=\"application\/ld+json\">{\"@context\":\"https:\\\/\\\/schema.org\",\"@type\":\"FAQPage\",\"mainEntity\":[{\"@type\":\"Question\",\"name\":\"Example Request &#8211; Hash Validation\",\"acceptedAnswer\":{\"@type\":\"Answer\",\"text\":\"<p>curl --location -g --request POST '{{CHECKOUT_HOST}}\\\/api\\\/v1\\\/session' <\\\/p>\\n<p>--header 'Content-Type: application\\\/json' <\\\/p>\\n<p>--data-raw '{&nbsp;&nbsp;<\\\/p>\\n<p>&nbsp;&nbsp;&nbsp;\\\"merchant_key\\\":\\\"xxxxx-xxxxx-xxxxx\\\",<\\\/p>\\n<p>&nbsp;&nbsp;&nbsp;\\\"operation\\\":\\\"purchase\\\",<\\\/p>\\n<p>&nbsp;&nbsp;&nbsp;\\\"methods\\\":[<\\\/p>\\n<p>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;\\\"card\\\"<\\\/p>\\n<p>&nbsp;&nbsp;&nbsp;],<\\\/p>\\n<p>&nbsp;&nbsp;&nbsp;\\\"order\\\":{<\\\/p>\\n<p>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;\\\"number\\\":\\\"order-1234\\\",<\\\/p>\\n<p>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;\\\"amount\\\": \\\"0.19\\\",<\\\/p>\\n<p>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;\\\"currency\\\":\\\"USD\\\",<\\\/p>\\n<p>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;\\\"description\\\":\\\"Important gift\\\"<\\\/p>\\n<p>&nbsp;&nbsp;&nbsp;},<\\\/p>\\n<p>&nbsp;&nbsp;&nbsp;\\\"cancel_url\\\":\\\"https:\\\/\\\/example.com\\\/cancel\\\",<\\\/p>\\n<p>&nbsp;&nbsp;&nbsp;\\\"success_url\\\":\\\"https:\\\/\\\/example.com\\\/success\\\",<\\\/p>\\n<p>&nbsp;&nbsp;&nbsp;\\\"customer\\\":{<\\\/p>\\n<p>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;\\\"name\\\":\\\"John Doe\\\"<\\\/p>\\n<p>&nbsp;&nbsp;&nbsp;},<\\\/p>\\n<p>&nbsp;&nbsp;&nbsp;\\\"hash\\\":\\\"wrong hash\\\"<\\\/p>\\n<p>}<\\\/p>\\n<p>'<\\\/p>\\n\"}},{\"@type\":\"Question\",\"name\":\"Example Response &#8211; Hash error\",\"acceptedAnswer\":{\"@type\":\"Answer\",\"text\":\"<p>{<\\\/p>\\n<p>&nbsp;&nbsp;\\\"error_code\\\": 0,<\\\/p>\\n<p>&nbsp;&nbsp;\\\"error_message\\\": \\\"Request data is invalid.\\\",<\\\/p>\\n<p>&nbsp;&nbsp;\\\"errors\\\": [<\\\/p>\\n<p>&nbsp;&nbsp;&nbsp;&nbsp;{<\\\/p>\\n<p>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;\\\"error_code\\\": 100000,<\\\/p>\\n<p>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;\\\"error_message\\\": \\\"hash: Hash is not valid.\\\"<\\\/p>\\n<p>&nbsp;&nbsp;&nbsp;&nbsp;}<\\\/p>\\n<p>&nbsp;&nbsp;]<\\\/p>\\n<p>}<\\\/p>\\n\"}}]}<\/script>    <\/div>\n<\/div>\n\n\n\n<h2 class=\"wp-block-heading\" id=\"callback-notification\">Callback Notification<\/h2>\n\n\n\n<hr class=\"wp-block-separator has-alpha-channel-opacity\"\/>\n\n\n\n<p>Checkout service sends the callback on the merchant <code>notification_URL<\/code> as a result of an operation.<\/p>\n\n\n\n<p>You can receive the callback for the next operation types:<\/p>\n\n\n\n<ul>\n<li>SALE<\/li>\n\n\n\n<li>3DS<\/li>\n\n\n\n<li>REDIRECT<\/li>\n\n\n\n<li>REFUND<\/li>\n\n\n\n<li>VOID<\/li>\n\n\n\n<li>RECURRING<\/li>\n\n\n\n<li>CHARGEBACK<\/li>\n\n\n\n<li>DEBIT<\/li>\n\n\n\n<li>TRANSFER<\/li>\n<\/ul>\n\n\n\n<p>\u26a0\ufe0f <strong>Pay attention<\/strong><\/p>\n\n\n\n<blockquote class=\"wp-block-quote is-layout-flow wp-block-quote-is-layout-flow\">\n<p><em>Note that the notification URL may be temporarily blocked due to consistently receiving timeouts in response to the callback.<\/em> <em>If five timeouts accumulate within five minutes for a merchant\u2019s notification URL, it will be blocked for 15 minutes. During this block,<\/em> <em>all merchants associated with the URL will not receive notifications.<\/em> <em>The block automatically lifts after 15 minutes.<\/em> <em>Additionally, it is possible to manually unblock the URL through the admin panel by navigating to Configuration \u2192 Merchants \u2192 Edit<\/em> <em>Merchant. In this case, the block will be removed immediately.<\/em> <em>The timeout counter resets if a callback response is successfully processed. For instance, if there are four timeouts within five minutes<\/em> <em>but a successful response on the sixth minute, the counter resets.<\/em><\/p>\n<\/blockquote>\n\n\n\n<p>\u26a0\ufe0f <strong>Pay attention<\/strong><\/p>\n\n\n\n<blockquote class=\"wp-block-quote is-layout-flow wp-block-quote-is-layout-flow\">\n<p><em>In the case of cascading, the logic for sending callbacks differs.<br>If cascading is triggered for the order, in general case you will receive only callback for the last payment attempt, where the final status of the order (settled or declined) is determined. In the particular cases, you will receive callback for the first payment attempt with the data for customer\u2019s redirection if it is required by payment provider. Callbacks for intermediate attempts (between the first decline and the last payment attempt) are not sent.<\/em><\/p>\n<\/blockquote>\n\n\n\n<h3 class=\"wp-block-heading\" id=\"list-of-possible-transaction-statuses\">List of Possible Transaction Statuses<\/h3>\n\n\n\n<p>The possible statuses are listed below:<\/p>\n\n\n\n<figure class=\"wp-block-table\"><table><thead><tr><th><strong>Transaction Status<\/strong><\/th><th><strong>Operation type<\/strong><\/th><th><strong>Description<\/strong><\/th><\/tr><\/thead><tbody><tr><td>SUCCESS<\/td><td>sale, 3ds, redirect, refund, void, recurring, chargeback, debit, transfer<\/td><td>Transaction is successfully completed in Payment Platform<\/td><\/tr><tr><td>FAIL<\/td><td>sale, refund, void, recurring, debit, transfer<\/td><td>Transaction has the errors and is not validated by Payment Platform<\/td><\/tr><tr><td>WAITING<\/td><td>sale, refund, void, recurring, debit, transfer<\/td><td>Transaction is being processed by Payment Platform<\/td><\/tr><tr><td>UNDEFINED<\/td><td>sale, 3ds, redirect, refund, void, recurring, debit, transfer<\/td><td>Uncertain payment status due to problems interacting with the payment provider<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n<p>\u26a0\ufe0f <strong>Pay attention<\/strong><\/p>\n\n\n\n<blockquote class=\"wp-block-quote is-layout-flow wp-block-quote-is-layout-flow\">\n<p><strong><em>that successful transaction does not mean successful final status for the payment.<\/em><\/strong><\/p>\n\n\n\n<blockquote class=\"wp-block-quote is-layout-flow wp-block-quote-is-layout-flow\">\n<p><strong><em>For example:<\/em><\/strong><br><em>Payment is successfully completed if transaction has <code>status<\/code> = success and <code>type<\/code> = sale. Payment is not completed if transaction has <code>status<\/code> = success and <code>type<\/code> = redirect.<\/em><\/p>\n<\/blockquote>\n<\/blockquote>\n\n\n\n<h3 class=\"wp-block-heading\" id=\"callback-parameters\">Callback parameters<\/h3>\n\n\n\n<p>Callback is HTTP POST request whcih includes the following data:<\/p>\n\n\n\n<figure class=\"wp-block-table\"><table><thead><tr><th><strong>Parameter<\/strong><\/th><th><strong>Type<\/strong><\/th><th><strong>Mandatory, Limitations<\/strong><\/th><th><strong>Description<\/strong><\/th><\/tr><\/thead><tbody><tr><td><code>id<\/code><\/td><td>String<\/td><td>Required<\/td><td>Transaction ID<br><strong>Example:<\/strong> dc66cdd8-d702-11ea-9a2f-0242c0a87002<\/td><\/tr><tr><td><code>order_number<\/code><\/td><td><em>String<\/em><\/td><td>Required Up to 255 characters<\/td><td>Order ID<br><strong>Example:<\/strong> order-1234<\/td><\/tr><tr><td><code>order_amount<\/code><\/td><td><em>Float<\/em><\/td><td>Required Format: XX.XX, without leading zeroes<\/td><td>Product price<br><strong>Example:<\/strong> 0.19<\/td><\/tr><tr><td><code>order_currency<\/code><\/td><td><em>String<\/em><\/td><td>Required Up to 3 characters<\/td><td>Currency (3-characters code)<br><strong>Example:<\/strong> USD<\/td><\/tr><tr><td><code>order_description<\/code><\/td><td><em>String<\/em><\/td><td>Required Up to 1024 characters<\/td><td>Product description<br><strong>Example:<\/strong> Important gift<\/td><\/tr><tr><td><code>order_status<\/code><\/td><td><em>String<\/em><\/td><td>Required Up to 20 characters<\/td><td>Payment status: prepare, settled, pending, 3ds, redirect, decline, refund, reversal, chargeback<br><strong>Example:<\/strong> 3ds<\/td><\/tr><tr><td><code>type<\/code><\/td><td><em>String<\/em><\/td><td>Required Up to 36 characters<\/td><td>Operation type: sale, 3ds, redirect, refund, void, chargeback, debit, transfer<br><strong>Example:<\/strong> sale<\/td><\/tr><tr><td><code>status<\/code><\/td><td><em>String<\/em><\/td><td>Required Up to 20 characters<\/td><td>Transaction status: success, fail, waiting, undefined<br><strong>Example:<\/strong> success<\/td><\/tr><tr><td><code>payment_status<\/code><\/td><td><em>String<\/em><\/td><td>Required Up to 20 characters<\/td><td>Payment status: prepare, settled, pending, 3ds, redirect, decline, refund, reversal,chargeback<br><strong>Example:<\/strong> 3ds<\/td><\/tr><tr><td><code>reason<\/code><\/td><td><em>String<\/em><\/td><td>Optional Up to 1024 characters<\/td><td>Decline or error reason. It displays only if the transaction has FAIL status.<br><strong>Example:<\/strong> The operation was rejected. Please contact the site support<\/td><\/tr><tr><td><code>payee_name<\/code><\/td><td><em>String<\/em><\/td><td>Optional<\/td><td>Payee&#8217;s first and last name<br>Returns only for transfer operation<br><strong>Example:<\/strong> John Rickher<\/td><\/tr><tr><td><code>payee_email<\/code><\/td><td><em>String<\/em><\/td><td>Optional<\/td><td>Payee&#8217;s e-mail<br>Returns only for transfer operation<br><strong>Example:<\/strong> <a href=\"mailto:example@mail.com\" target=\"_blank\" rel=\"noreferrer noopener\">example@mail.com<\/a><\/td><\/tr><tr><td><code>payee_country<\/code><\/td><td><em>String<\/em><\/td><td>Optional<br>Up to 3 characters<\/td><td>Payee&#8217;s country<br>Returns only for transfer operation<br><strong>Example:<\/strong> US<\/td><\/tr><tr><td><code>payee_state<\/code><\/td><td><em>String<\/em><\/td><td>Optional<br>Up to 32 characters<\/td><td>Payee&#8217;s state<br>Returns only for transfer operation<br><strong>Example:<\/strong> California<\/td><\/tr><tr><td><code>payee_city<\/code><\/td><td><em>String<\/em><\/td><td>Optional<br>Up to 32 characters<\/td><td>Payee&#8217;s city<br>Returns only for transfer operation<br><strong>Example:<\/strong> Los Angeles<\/td><\/tr><tr><td><code>payee_address<\/code><\/td><td><em>String<\/em><\/td><td>Optional<br>Up to 32 characters<\/td><td>Payee&#8217;s city<br>Returns only for transfer operation<br><strong>Example:<\/strong> 123 Sample Street<\/td><\/tr><tr><td><code>rrn<\/code><\/td><td><em>String<\/em><\/td><td>Optional<\/td><td>Retrieval Reference Number value from the acquirer system<\/td><\/tr><tr><td><code>approval_code<\/code><\/td><td><em>String<\/em><\/td><td>Optional<\/td><td>Approval code value from the acquirer system<\/td><\/tr><tr><td><code>card<\/code><\/td><td><em>String<\/em><\/td><td>Optional<br>Format: \u0425\u0425\u0425\u0425\u0425\u0425******\u0425\u0425\u0425\u0425<\/td><td>Card number mask<br><strong>Example:<\/strong> 411111******1111<\/td><\/tr><tr><td><code>card_expiration_date<\/code><\/td><td><em>String<\/em><\/td><td>Optional<\/td><td>Card expiration date<br><strong>Example:<\/strong> 12\/2022<\/td><\/tr><tr><td><code>payee_card<\/code><\/td><td><em>String<\/em><\/td><td>Optional<\/td><td>Payee card number mask<br>Returns only for transfer operation<br><strong>Example:<\/strong> 411111******1111<\/td><\/tr><tr><td><code>card_token<\/code><\/td><td><em>String<\/em><\/td><td>Optional<\/td><td>Card token. It is available if the parameter <code>req_token<\/code> was enabled<br>It is available only for purchase operation<br><strong>Example:<\/strong> VjFRaUxDSmhiR2NpT2lKU1V6STFO<\/td><\/tr><tr><td><code>customer_name<\/code><\/td><td><em>String<\/em><\/td><td>Optional<\/td><td>Customer&#8217;s first and last name<br><strong>Example:<\/strong> John Rickher<\/td><\/tr><tr><td><code>customer_email<\/code><\/td><td><em>String<\/em><\/td><td>Optional<br>Format: <a href=\"https:\/\/docs.lddpay.com\/url\">example@mail.com<\/a><\/td><td>Customer&#8217;s email address<br><strong>Example:<\/strong> <a href=\"https:\/\/docs.lddpay.com\/url\">fdfd@dfsds.ds<\/a><\/td><\/tr><tr><td><code>customer_country<\/code><\/td><td><em>String<\/em><\/td><td>Optional<br>Up to 3 characters<\/td><td>Customer&#8217;s country<br><strong>Example:<\/strong> US<\/td><\/tr><tr><td><code>customer_state<\/code><\/td><td><em>String<\/em><\/td><td>Optional<br>Up to 32 characters<\/td><td>Customer&#8217;s state<br><strong>Example:<\/strong> California<\/td><\/tr><tr><td><code>customer_city<\/code><\/td><td><em>String<\/em><\/td><td>Optional<\/td><td>Customer&#8217;s city<br><strong>Example:<\/strong> Los Angeles<\/td><\/tr><tr><td><code>customer_address<\/code><\/td><td><em>String<\/em><\/td><td>Optional<br>Up to 32 characters<\/td><td>Customer&#8217;s address<br><strong>Example:<\/strong> 123 Sample Street<\/td><\/tr><tr><td><code>customer_ip<\/code><\/td><td><em>String<\/em><\/td><td>Required<\/td><td>Customer&#8217;s IP<br><strong>Example:<\/strong> 255.41.45.57<\/td><\/tr><tr><td><code>date<\/code><\/td><td><em>Date<\/em><\/td><td>Optional<br>Format: YYYY-MM-DD hh:mm:ss<\/td><td>Transaction date<br><strong>Example:<\/strong> 2020-08-05 07:41:10<\/td><\/tr><tr><td><code>recurring_init_trans_id<\/code><\/td><td><em>String<\/em><\/td><td>Optional<\/td><td>Reference to the first transaction that initializes the recurring (provided if recurring was initialized)<br>It is available only for purchase operation<br><strong>Example:<\/strong> dc66cdd8-d702-11ea-9a2f-0242c0a87099<\/td><\/tr><tr><td><code>recurring_token<\/code><\/td><td><em>String<\/em><\/td><td>Optional<\/td><td>Recurring token (provided if recurring was initialized)<br><strong>Example:<\/strong> e5f60b35485e<\/td><\/tr><tr><td><code>schedule_id<\/code><\/td><td><em>String<\/em><\/td><td>Optional<\/td><td>It is available if schedule is used for recurring sale<br>It is available only for purchase operation<\/td><\/tr><tr><td><code>exchange_rate<\/code><\/td><td><em>Decimal<\/em><\/td><td>Optional<\/td><td>Rate used to make exchange.<br>It returns if the currency exchange has been applied for the payment.<\/td><\/tr><tr><td><code>exchange_rate_base<\/code><\/td><td><em>Decimal<\/em><\/td><td>Optional<\/td><td>The rate used in the double conversion to convert the original currency to the base currency.<br>It returns if the currency exchange has been applied for the payment.<\/td><\/tr><tr><td><code>exchange_currency<\/code><\/td><td><em>Dictionary<\/em><\/td><td>Optional<\/td><td>Original currency.<br>It returns if the currency exchange has been applied for the payment.<\/td><\/tr><tr><td><code>exchange_amount<\/code><\/td><td><em>Integer<\/em><\/td><td>Optional<\/td><td>Original amount.<br>It returns if the currency exchange has been applied for the payment.<\/td><\/tr><tr><td><code>vat_amount<\/code><\/td><td><em>Float<\/em><\/td><td>Optional<br>Format: XX.XX, without leading zeroes<\/td><td>Product VAT<br>Returns if VAT has been calculated for the payment.<br>It is available only for purchase operation<br><strong>Example:<\/strong> 0.09<\/td><\/tr><tr><td><strong>custom_data<\/strong><\/td><td><em>Object<\/em><\/td><td>Optional<\/td><td>Custom data<br>This block duplicates the arbitrary parameters that were passed in the payment request<br><strong>Example:<\/strong><br><code>\u201ccustom_data\u201d: {\u201cparam1\u201d:\u201dvalue1\u201d, \u201cparam2\u201d:\u201dvalue2\u201d, \u201cparam3\u201d:\u201dvalue3\u201d}<\/code><\/td><\/tr><tr><td><code>hash<\/code><\/td><td><em>String<\/em><\/td><td>Required<\/td><td>Special signature, used to validate callback Addition in Signature section.<br><strong>Example:<\/strong> <ins>Must be SHA1 of MD5 encoded string (uppercased):<\/ins> payment_public_id + order.number + order.amount + order.currency + order.description + merchant.pass<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n<h2 class=\"wp-block-heading\">Examples<\/h2>\n\n\n<div\n    class=\"betterdocs-faq-wrapper layout-classic icon-before betterdocs-faq-layout-2 betterdocs-faq-jtcq5us betterdocs-shortcode\">\n    <h2 class=\"betterdocs-faq-layout-2 betterdocs-faq-jtcq5us betterdocs-faq-section-title\">\n            <\/h2>\n\n    <div class=\"betterdocs-faq-inner-wrapper\">\n        <div class=\"betterdocs-faq-title\">\n    <h2>Callback Example<\/h2>\n<\/div>\n<ul class=\"betterdocs-faq-list\"><li><div class=\"betterdocs-faq-group\"><div class=\"betterdocs-faq-post\">\n    <div class=\"betterdocs-faq-post-icon-group\"><svg class=\"betterdocs-faq-iconplus\" xmlns=\"http:\/\/www.w3.org\/2000\/svg\" viewbox=\"0 0 24 24\"><path fill=\"#000000\" d=\"M18 10h-4V6h-4v4H6v4h4v4h4v-4h4\"><\/path><\/svg><svg class=\"betterdocs-faq-iconminus\" xmlns=\"http:\/\/www.w3.org\/2000\/svg\" viewbox=\"0 0 24 24\"><path fill=\"#000000\" d=\"M6 10h12v4H6z\"><\/path><\/svg><\/div>    <span class=\"betterdocs-faq-post-name\">\n        Merchant successful sale callback    <\/span>\n    <\/div>\n<div class=\"betterdocs-faq-main-content\">\n    <p>&nbsp;&nbsp;id=f0a51dfa-fc43-11ec-8128-0242ac120004&amp;order_number=order-1234&amp;order_amount=3.01&amp;order_currency=USD&amp;order_description=bloodline&amp;order_status=settled&amp;type=sale&amp;status=success&amp;card=411111****1111&amp;card_expiration_date=12\/2022&amp;schedule_id=4e46866c-f84b-11ec-8b4c-0242ac120007&amp;recurring_init_trans_id=f0a51dfa-fc43-11ec-8128-0242ac120004&amp;recurring_token=f0e24964-fc43-11ec-a7e0-0242ac120004&amp;date=2022-07-05 09:22:09&amp;hash=6d8d440e25bdfc5288616ce567496948d2562852&amp;customer_name=D D&amp;customer_email=success@gmail.com&amp;customer_country=US&amp;customer_state=California&amp;customer_city=Los Angeles&amp;customer_address=Moor Building 35274 State ST Fremont. U.S.A&amp;customer_ip=10.10.10.2&amp;exchange_rate_base=26.19&amp;exchange_rate=6.47&amp;exchange_currency=UAH&amp;exchange_amount=100.00<\/p>\n<p><\/p>\n<\/div>\n<\/div><\/li><li><div class=\"betterdocs-faq-group\"><div class=\"betterdocs-faq-post\">\n    <div class=\"betterdocs-faq-post-icon-group\"><svg class=\"betterdocs-faq-iconplus\" xmlns=\"http:\/\/www.w3.org\/2000\/svg\" viewbox=\"0 0 24 24\"><path fill=\"#000000\" d=\"M18 10h-4V6h-4v4H6v4h4v4h4v-4h4\"><\/path><\/svg><svg class=\"betterdocs-faq-iconminus\" xmlns=\"http:\/\/www.w3.org\/2000\/svg\" viewbox=\"0 0 24 24\"><path fill=\"#000000\" d=\"M6 10h12v4H6z\"><\/path><\/svg><\/div>    <span class=\"betterdocs-faq-post-name\">\n        Merchant successful debit callback    <\/span>\n    <\/div>\n<div class=\"betterdocs-faq-main-content\">\n    <p>id=f0a51dfa-fc43-11ec-8128-0242ac120004&amp;order_number=order-1234&amp;order_amount=3.01&amp;order_currency=USD&amp;order_description=bloodline&amp;order_status=settled&amp;type=debit&amp;status=success&amp;card=411111****1111&amp;card_expiration_date=12\/2022&amp;date=2022-07-05+09:22:09&amp;hash=6d8d440e25bdfc5288616ce567496948d2562852&amp;customer_name=D D&amp;customer_email=success@gmail.com&amp;customer_country=US&amp;customer_state=California&amp;customer_city=Los Angeles&amp;customer_address=Moor Building 35274 State ST Fremont. U.S.A&amp;customer_ip=10.10.10.2<\/p>\n<\/div>\n<\/div><\/li><li><div class=\"betterdocs-faq-group\"><div class=\"betterdocs-faq-post\">\n    <div class=\"betterdocs-faq-post-icon-group\"><svg class=\"betterdocs-faq-iconplus\" xmlns=\"http:\/\/www.w3.org\/2000\/svg\" viewbox=\"0 0 24 24\"><path fill=\"#000000\" d=\"M18 10h-4V6h-4v4H6v4h4v4h4v-4h4\"><\/path><\/svg><svg class=\"betterdocs-faq-iconminus\" xmlns=\"http:\/\/www.w3.org\/2000\/svg\" viewbox=\"0 0 24 24\"><path fill=\"#000000\" d=\"M6 10h12v4H6z\"><\/path><\/svg><\/div>    <span class=\"betterdocs-faq-post-name\">\n        Merchant successful refund callback    <\/span>\n    <\/div>\n<div class=\"betterdocs-faq-main-content\">\n    <p>&nbsp;id=f0a51dfa-fc43-11ec-8128-0242ac120004&amp;order_number=order-1234&amp;order_amount=3.01&amp;order_currency=USD&amp;order_description=bloodline&amp;order_status=settled&amp;type=refund&amp;status=success&amp;card=411111****1111&amp;card_expiration_date=12\/2022&amp;schedule_id=4e46866c-f84b-11ec-8b4c-0242ac120007&amp;date=2022-07-05+09:28:01&amp;hash=6d8d440e25bdfc5288616ce567496948d2562852&amp;customer_name=D D&amp;customer_email=success@gmail.com&amp;customer_country=US&amp;customer_state=California&amp;customer_city=Los Angeles&amp;customer_address=Moor Building 35274 State ST Fremont. U.S.A&amp;customer_ip=10.10.10.2<\/p>\n<\/div>\n<\/div><\/li><li><div class=\"betterdocs-faq-group\"><div class=\"betterdocs-faq-post\">\n    <div class=\"betterdocs-faq-post-icon-group\"><svg class=\"betterdocs-faq-iconplus\" xmlns=\"http:\/\/www.w3.org\/2000\/svg\" viewbox=\"0 0 24 24\"><path fill=\"#000000\" d=\"M18 10h-4V6h-4v4H6v4h4v4h4v-4h4\"><\/path><\/svg><svg class=\"betterdocs-faq-iconminus\" xmlns=\"http:\/\/www.w3.org\/2000\/svg\" viewbox=\"0 0 24 24\"><path fill=\"#000000\" d=\"M6 10h12v4H6z\"><\/path><\/svg><\/div>    <span class=\"betterdocs-faq-post-name\">\n        Merchant successful transfer callback    <\/span>\n    <\/div>\n<div class=\"betterdocs-faq-main-content\">\n    <p>id=f0a51dfa-fc43-11ec-8128-0242ac120004&amp;order_number=order-1234&amp;order_amount=3.01&amp;order_currency=USD&amp;order_description=bloodline&amp;order_status=settled&amp;type=transfer&amp;status=success&amp;card=411111****1111&amp;card_expiration_date=12\/2022&amp;payee_card=422222****2222&amp;date=2022-07-05+09:22:09&amp;hash=6d8d440e25bdfc5288616ce567496948d2562852&amp;customer_name=D D&amp;customer_email=success@gmail.com&amp;customer_country=US&amp;customer_state=California&amp;customer_city=Los Angeles&amp;customer_address=Moor Building 35275&amp;customer_ip=10.10.10.2&amp;payee_name=D D&amp;payee_email=success@gmail.com&amp;payee_country=US&amp;payee_state=California&amp;payee_city=Los Angeles&amp;payee_address=Moor Building 35274 State ST Fremont. U.S.A<\/p>\n<\/div>\n<\/div><\/li><li><div class=\"betterdocs-faq-group\"><div class=\"betterdocs-faq-post\">\n    <div class=\"betterdocs-faq-post-icon-group\"><svg class=\"betterdocs-faq-iconplus\" xmlns=\"http:\/\/www.w3.org\/2000\/svg\" viewbox=\"0 0 24 24\"><path fill=\"#000000\" d=\"M18 10h-4V6h-4v4H6v4h4v4h4v-4h4\"><\/path><\/svg><svg class=\"betterdocs-faq-iconminus\" xmlns=\"http:\/\/www.w3.org\/2000\/svg\" viewbox=\"0 0 24 24\"><path fill=\"#000000\" d=\"M6 10h12v4H6z\"><\/path><\/svg><\/div>    <span class=\"betterdocs-faq-post-name\">\n        Merchant unsuccessful sale callback    <\/span>\n    <\/div>\n<div class=\"betterdocs-faq-main-content\">\n    <p>id=1f34f446-fc45-11ec-a50f-0242ac120004&amp;order_number=order-1234&amp;order_amount=3.01&amp;order_currency=USD&amp;order_description=bloodline&amp;order_status=decline&amp;type=sale&amp;status=fail&amp;card=411111****1111&amp;card_expiration_date=12\/2022&amp;reason=Declined by processing.&amp;date=2022-07-05+09:30:35&amp;hash=7f15d178e9b2c8507dea57f8ed1efddb9573fa6b&amp;customer_name=D D&amp;customer_email=success@gmail.com&amp;customer_country=US&amp;customer_state=California&amp;customer_city=Los Angeles&amp;customer_address=Moor Building 35274 State ST Fremont. U.S.A&amp;customer_ip=10.10.10.2<\/p>\n<\/div>\n<\/div><\/li><li><div class=\"betterdocs-faq-group\"><div class=\"betterdocs-faq-post\">\n    <div class=\"betterdocs-faq-post-icon-group\"><svg class=\"betterdocs-faq-iconplus\" xmlns=\"http:\/\/www.w3.org\/2000\/svg\" viewbox=\"0 0 24 24\"><path fill=\"#000000\" d=\"M18 10h-4V6h-4v4H6v4h4v4h4v-4h4\"><\/path><\/svg><svg class=\"betterdocs-faq-iconminus\" xmlns=\"http:\/\/www.w3.org\/2000\/svg\" viewbox=\"0 0 24 24\"><path fill=\"#000000\" d=\"M6 10h12v4H6z\"><\/path><\/svg><\/div>    <span class=\"betterdocs-faq-post-name\">\n        Merchant unsuccessful debit callback    <\/span>\n    <\/div>\n<div class=\"betterdocs-faq-main-content\">\n    <p>id=1f34f446-fc45-11ec-a50f-0242ac120004&amp;order_number=order-1234&amp;order_amount=3.01&amp;order_currency=USD&amp;order_description=bloodline&amp;order_status=decline&amp;type=debit&amp;status=fail&amp;card=411111****1111&amp;card_expiration_date=12\/2022&amp;reason=Declined by processing.&amp;date=2022-07-05+09:30:35&amp;hash=7f15d178e9b2c8507dea57f8ed1efddb9573fa6b&amp;customer_name=D D&amp;customer_email=success@gmail.com&amp;customer_country=US&amp;customer_state=California&amp;customer_city=Los Angeles&amp;customer_address=Moor Building 35274 State ST Fremont. U.S.A&amp;customer_ip=10.10.10.2<\/p>\n<\/div>\n<\/div><\/li><li><div class=\"betterdocs-faq-group\"><div class=\"betterdocs-faq-post\">\n    <div class=\"betterdocs-faq-post-icon-group\"><svg class=\"betterdocs-faq-iconplus\" xmlns=\"http:\/\/www.w3.org\/2000\/svg\" viewbox=\"0 0 24 24\"><path fill=\"#000000\" d=\"M18 10h-4V6h-4v4H6v4h4v4h4v-4h4\"><\/path><\/svg><svg class=\"betterdocs-faq-iconminus\" xmlns=\"http:\/\/www.w3.org\/2000\/svg\" viewbox=\"0 0 24 24\"><path fill=\"#000000\" d=\"M6 10h12v4H6z\"><\/path><\/svg><\/div>    <span class=\"betterdocs-faq-post-name\">\n        Merchant unsuccessful refund callback    <\/span>\n    <\/div>\n<div class=\"betterdocs-faq-main-content\">\n    <p>id=ba290c62-fc45-11ec-9e91-0242ac120004&amp;order_number=order-1234&amp;order_amount=3.01&amp;order_currency=USD&amp;order_description=bloodline&amp;order_status=decline&amp;type=refund&amp;status=fail&amp;card=411111****1111&amp;card_expiration_date=12\/2022&amp;reason=Declined by processing.&amp;schedule_id=4e46866c-f84b-11ec-8b4c-0242ac120007&amp;recurring_init_trans_id=ba290c62-fc45-11ec-9e91-0242ac120004&amp;recurring_token=ba51844e-fc45-11ec-932c-0242ac120004&amp;date=2022-07-05+09:38:00&amp;hash=bcd78ff8b8e6b75aa1743910641217be6edc3a43&amp;customer_name=D D&amp;customer_email=success@gmail.com&amp;customer_country=US&amp;customer_state=California&amp;customer_city=Los Angeles&amp;customer_address=Moor Building 35274 State ST Fremont. U.S.A&amp;customer_ip=10.10.10.2<\/p>\n<\/div>\n<\/div><\/li><li><div class=\"betterdocs-faq-group\"><div class=\"betterdocs-faq-post\">\n    <div class=\"betterdocs-faq-post-icon-group\"><svg class=\"betterdocs-faq-iconplus\" xmlns=\"http:\/\/www.w3.org\/2000\/svg\" viewbox=\"0 0 24 24\"><path fill=\"#000000\" d=\"M18 10h-4V6h-4v4H6v4h4v4h4v-4h4\"><\/path><\/svg><svg class=\"betterdocs-faq-iconminus\" xmlns=\"http:\/\/www.w3.org\/2000\/svg\" viewbox=\"0 0 24 24\"><path fill=\"#000000\" d=\"M6 10h12v4H6z\"><\/path><\/svg><\/div>    <span class=\"betterdocs-faq-post-name\">\n        Merchant unsuccessful transfer callback    <\/span>\n    <\/div>\n<div class=\"betterdocs-faq-main-content\">\n    <p>id=1f34f446-fc45-11ec-a50f-0242ac120004&amp;order_number=order-1234&amp;order_amount=3.01&amp;order_currency=USD&amp;order_description=bloodline&amp;order_status=decline&amp;type=transfer&amp;status=fail&amp;card=411111****1111&amp;card_expiration_date=12\/2022&amp;payee_card=422222****2222&amp;date=2022-07-05+09:22:09&amp;hash=6d8d440e25bdfc5288616ce567496948d2562852&amp;customer_name=D D&amp;customer_email=success@gmail.com&amp;customer_country=US&amp;customer_state=California&amp;customer_city=Los Angeles&amp;customer_address=Moor Building 35275&amp;customer_ip=10.10.10.2&amp;payee_name=D D&amp;payee_email=success@gmail.com&amp;payee_country=US&amp;payee_state=California&amp;payee_city=Los Angeles&amp;payee_address=Moor Building 35274 State ST Fremont. U.S.A&amp;vat_amount=0.3<\/p>\n<\/div>\n<\/div><\/li><\/ul><script type=\"application\/ld+json\">{\"@context\":\"https:\\\/\\\/schema.org\",\"@type\":\"FAQPage\",\"mainEntity\":[{\"@type\":\"Question\",\"name\":\"Merchant successful sale callback\",\"acceptedAnswer\":{\"@type\":\"Answer\",\"text\":\"<p>&nbsp;&nbsp;id=f0a51dfa-fc43-11ec-8128-0242ac120004&amp;order_number=order-1234&amp;order_amount=3.01&amp;order_currency=USD&amp;order_description=bloodline&amp;order_status=settled&amp;type=sale&amp;status=success&amp;card=411111****1111&amp;card_expiration_date=12\\\/2022&amp;schedule_id=4e46866c-f84b-11ec-8b4c-0242ac120007&amp;recurring_init_trans_id=f0a51dfa-fc43-11ec-8128-0242ac120004&amp;recurring_token=f0e24964-fc43-11ec-a7e0-0242ac120004&amp;date=2022-07-05 09:22:09&amp;hash=6d8d440e25bdfc5288616ce567496948d2562852&amp;customer_name=D D&amp;customer_email=success@gmail.com&amp;customer_country=US&amp;customer_state=California&amp;customer_city=Los Angeles&amp;customer_address=Moor Building 35274 State ST Fremont. U.S.A&amp;customer_ip=10.10.10.2&amp;exchange_rate_base=26.19&amp;exchange_rate=6.47&amp;exchange_currency=UAH&amp;exchange_amount=100.00<\\\/p>\\n<p><\\\/p>\\n\"}},{\"@type\":\"Question\",\"name\":\"Merchant successful debit callback\",\"acceptedAnswer\":{\"@type\":\"Answer\",\"text\":\"<p>id=f0a51dfa-fc43-11ec-8128-0242ac120004&amp;order_number=order-1234&amp;order_amount=3.01&amp;order_currency=USD&amp;order_description=bloodline&amp;order_status=settled&amp;type=debit&amp;status=success&amp;card=411111****1111&amp;card_expiration_date=12\\\/2022&amp;date=2022-07-05+09:22:09&amp;hash=6d8d440e25bdfc5288616ce567496948d2562852&amp;customer_name=D D&amp;customer_email=success@gmail.com&amp;customer_country=US&amp;customer_state=California&amp;customer_city=Los Angeles&amp;customer_address=Moor Building 35274 State ST Fremont. U.S.A&amp;customer_ip=10.10.10.2<\\\/p>\\n\"}},{\"@type\":\"Question\",\"name\":\"Merchant successful refund callback\",\"acceptedAnswer\":{\"@type\":\"Answer\",\"text\":\"<p>&nbsp;id=f0a51dfa-fc43-11ec-8128-0242ac120004&amp;order_number=order-1234&amp;order_amount=3.01&amp;order_currency=USD&amp;order_description=bloodline&amp;order_status=settled&amp;type=refund&amp;status=success&amp;card=411111****1111&amp;card_expiration_date=12\\\/2022&amp;schedule_id=4e46866c-f84b-11ec-8b4c-0242ac120007&amp;date=2022-07-05+09:28:01&amp;hash=6d8d440e25bdfc5288616ce567496948d2562852&amp;customer_name=D D&amp;customer_email=success@gmail.com&amp;customer_country=US&amp;customer_state=California&amp;customer_city=Los Angeles&amp;customer_address=Moor Building 35274 State ST Fremont. U.S.A&amp;customer_ip=10.10.10.2<\\\/p>\\n\"}},{\"@type\":\"Question\",\"name\":\"Merchant successful transfer callback\",\"acceptedAnswer\":{\"@type\":\"Answer\",\"text\":\"<p>id=f0a51dfa-fc43-11ec-8128-0242ac120004&amp;order_number=order-1234&amp;order_amount=3.01&amp;order_currency=USD&amp;order_description=bloodline&amp;order_status=settled&amp;type=transfer&amp;status=success&amp;card=411111****1111&amp;card_expiration_date=12\\\/2022&amp;payee_card=422222****2222&amp;date=2022-07-05+09:22:09&amp;hash=6d8d440e25bdfc5288616ce567496948d2562852&amp;customer_name=D D&amp;customer_email=success@gmail.com&amp;customer_country=US&amp;customer_state=California&amp;customer_city=Los Angeles&amp;customer_address=Moor Building 35275&amp;customer_ip=10.10.10.2&amp;payee_name=D D&amp;payee_email=success@gmail.com&amp;payee_country=US&amp;payee_state=California&amp;payee_city=Los Angeles&amp;payee_address=Moor Building 35274 State ST Fremont. U.S.A<\\\/p>\\n\"}},{\"@type\":\"Question\",\"name\":\"Merchant unsuccessful sale callback\",\"acceptedAnswer\":{\"@type\":\"Answer\",\"text\":\"<p>id=1f34f446-fc45-11ec-a50f-0242ac120004&amp;order_number=order-1234&amp;order_amount=3.01&amp;order_currency=USD&amp;order_description=bloodline&amp;order_status=decline&amp;type=sale&amp;status=fail&amp;card=411111****1111&amp;card_expiration_date=12\\\/2022&amp;reason=Declined by processing.&amp;date=2022-07-05+09:30:35&amp;hash=7f15d178e9b2c8507dea57f8ed1efddb9573fa6b&amp;customer_name=D D&amp;customer_email=success@gmail.com&amp;customer_country=US&amp;customer_state=California&amp;customer_city=Los Angeles&amp;customer_address=Moor Building 35274 State ST Fremont. U.S.A&amp;customer_ip=10.10.10.2<\\\/p>\\n\"}},{\"@type\":\"Question\",\"name\":\"Merchant unsuccessful debit callback\",\"acceptedAnswer\":{\"@type\":\"Answer\",\"text\":\"<p>id=1f34f446-fc45-11ec-a50f-0242ac120004&amp;order_number=order-1234&amp;order_amount=3.01&amp;order_currency=USD&amp;order_description=bloodline&amp;order_status=decline&amp;type=debit&amp;status=fail&amp;card=411111****1111&amp;card_expiration_date=12\\\/2022&amp;reason=Declined by processing.&amp;date=2022-07-05+09:30:35&amp;hash=7f15d178e9b2c8507dea57f8ed1efddb9573fa6b&amp;customer_name=D D&amp;customer_email=success@gmail.com&amp;customer_country=US&amp;customer_state=California&amp;customer_city=Los Angeles&amp;customer_address=Moor Building 35274 State ST Fremont. U.S.A&amp;customer_ip=10.10.10.2<\\\/p>\\n\"}},{\"@type\":\"Question\",\"name\":\"Merchant unsuccessful refund callback\",\"acceptedAnswer\":{\"@type\":\"Answer\",\"text\":\"<p>id=ba290c62-fc45-11ec-9e91-0242ac120004&amp;order_number=order-1234&amp;order_amount=3.01&amp;order_currency=USD&amp;order_description=bloodline&amp;order_status=decline&amp;type=refund&amp;status=fail&amp;card=411111****1111&amp;card_expiration_date=12\\\/2022&amp;reason=Declined by processing.&amp;schedule_id=4e46866c-f84b-11ec-8b4c-0242ac120007&amp;recurring_init_trans_id=ba290c62-fc45-11ec-9e91-0242ac120004&amp;recurring_token=ba51844e-fc45-11ec-932c-0242ac120004&amp;date=2022-07-05+09:38:00&amp;hash=bcd78ff8b8e6b75aa1743910641217be6edc3a43&amp;customer_name=D D&amp;customer_email=success@gmail.com&amp;customer_country=US&amp;customer_state=California&amp;customer_city=Los Angeles&amp;customer_address=Moor Building 35274 State ST Fremont. U.S.A&amp;customer_ip=10.10.10.2<\\\/p>\\n\"}},{\"@type\":\"Question\",\"name\":\"Merchant unsuccessful transfer callback\",\"acceptedAnswer\":{\"@type\":\"Answer\",\"text\":\"<p>id=1f34f446-fc45-11ec-a50f-0242ac120004&amp;order_number=order-1234&amp;order_amount=3.01&amp;order_currency=USD&amp;order_description=bloodline&amp;order_status=decline&amp;type=transfer&amp;status=fail&amp;card=411111****1111&amp;card_expiration_date=12\\\/2022&amp;payee_card=422222****2222&amp;date=2022-07-05+09:22:09&amp;hash=6d8d440e25bdfc5288616ce567496948d2562852&amp;customer_name=D D&amp;customer_email=success@gmail.com&amp;customer_country=US&amp;customer_state=California&amp;customer_city=Los Angeles&amp;customer_address=Moor Building 35275&amp;customer_ip=10.10.10.2&amp;payee_name=D D&amp;payee_email=success@gmail.com&amp;payee_country=US&amp;payee_state=California&amp;payee_city=Los Angeles&amp;payee_address=Moor Building 35274 State ST Fremont. U.S.A&amp;vat_amount=0.3<\\\/p>\\n\"}}]}<\/script>    <\/div>\n<\/div>\n\n\n\n<h2 class=\"wp-block-heading\" id=\"recurring\">Recurring<\/h2>\n\n\n\n<hr class=\"wp-block-separator has-alpha-channel-opacity\"\/>\n\n\n\n<p>Recurring payments are commonly used to create new transactions based on already stored cardholder information from previous operations. This request is sent by POST in JSON format.<\/p>\n\n\n\n<p><strong>RECURRING request<\/strong><\/p>\n\n\n\n<pre class=\"wp-block-code\"><code>\/api\/v1\/payment\/recurring<\/code><\/pre>\n\n\n\n<h3 class=\"wp-block-heading\" id=\"request-parameters-1\">Request Parameters<\/h3>\n\n\n\n<figure class=\"wp-block-table\"><table><thead><tr><th><strong>Parameter<\/strong><\/th><th><strong>Type<\/strong><\/th><th><strong>Mandatory, Limitations<\/strong><\/th><th><strong>Description<\/strong><\/th><\/tr><\/thead><tbody><tr><td><code>merchant_key<\/code><\/td><td><em>String<\/em><\/td><td>Required<\/td><td>Key for Merchant identification<br><strong>Example:<\/strong> xxxxx-xxxxx-xxxxx<\/td><\/tr><tr><td><code>recurring_init_trans_id<\/code><\/td><td><em>String<\/em><\/td><td>Required<\/td><td>Transaction ID of the primary transaction in the Payment Platform<br><strong>Example:<\/strong> dc66cdd8-d702-11ea-9a2f-0242c0a87002<\/td><\/tr><tr><td><code>recurring_token<\/code><\/td><td><em>String<\/em><\/td><td>Required<\/td><td>Recurring token<br><strong>Example:<\/strong> 9a2f-0242c0a87002<\/td><\/tr><tr><td><code>schedule_id<\/code><\/td><td><em>String<\/em><\/td><td>Optional<\/td><td>Schedule ID for recurring payments<\/td><\/tr><tr><td><code>hash<\/code><\/td><td><em>String<\/em><\/td><td>Required<\/td><td>Special signature to validate your request to Payment Platform Addition in Signature section<br><ins>Must be SHA1 of MD5 encoded string (uppercased):<\/ins> recurring_init_trans_id + recurring_token + order.number + order.amount + order.description + merchant_pass<\/td><\/tr><tr><td><strong>order<\/strong><\/td><td><em>Object<\/em><\/td><td><\/td><td><\/td><\/tr><tr><td><code>number<\/code><\/td><td><em>String<\/em><\/td><td>Required<br>Not blank<br>max: 255<br>[a-zA-Z0-9-]<\/td><td>Order ID<br><strong>Example:<\/strong> order-1234<\/td><\/tr><tr><td><code>amount<\/code><\/td><td><em>Float<\/em><\/td><td>Required<br>Not blank<br>Greater then 0<br>0-9<br>max: 255<\/td><td>Format depends on currency.<br>Send Integer type value for currencies with zero-exponent. <strong>Example:<\/strong> 1000<br>Send Float type value for currencies with exponents 2, 3, 4.<br>Format for 2-exponent currencies: XX.XX <strong>Example:<\/strong> 100.99<br><strong>Pay attention<\/strong> that currencies &#8216;UGX&#8217;, &#8216;JPY&#8217;, &#8216;KRW&#8217;, &#8216;CLP&#8217; must be send in the format XX.XX, with the zeros after comma. <strong>Example:<\/strong> 100.00<br>Format for 3-exponent currencies: XXX.XXX <strong>Example:<\/strong> 100.999.<br>Format for 4-exponent currencies: XXX.XXXX <strong>Example:<\/strong> 100.9999<\/td><\/tr><tr><td><code>description<\/code><\/td><td><em>String<\/em><\/td><td>Required<br>min: 2 max: 1024<br>[a-zA-Z0-9!&#8221;#$%&amp;'()*+,.\/:;&amp;@]<\/td><td>Product name<br><strong>Example:<\/strong> Very important gift &#8211; # 9<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n<h3 class=\"wp-block-heading\" id=\"response-parameters\">Response Parameters<\/h3>\n\n\n\n<figure class=\"wp-block-table\"><table><thead><tr><th><strong>Parameter<\/strong><\/th><th><strong>Type<\/strong><\/th><th><strong>Mandatory, Limitations<\/strong><\/th><th><strong>Description<\/strong><\/th><\/tr><\/thead><tbody><tr><td><code>status<\/code><\/td><td><em>String<\/em><\/td><td>Required<\/td><td>Payment status<br><strong>Example:<\/strong> SETTLED, PENDING, DECLINE<\/td><\/tr><tr><td><code>reason<\/code><\/td><td><em>String<\/em><\/td><td>Optional<\/td><td>Decline reason translation for unsuccessful payment.<br>It displays only if the transaction is unsuccessful<br><strong>Example:<\/strong> The operation was rejected. Please contact the site support<\/td><\/tr><tr><td><code>payment_id<\/code><\/td><td><em>String<\/em><\/td><td>Required<br>Up to 255 characters<\/td><td>Transaction ID (public)<br><strong>Example:<\/strong> dc66cdd8-d702-11ea-9a2f-0242c0a87002<\/td><\/tr><tr><td><code>date<\/code><\/td><td><em>String<\/em><\/td><td>Required<br>Format: YYYY-MM-DD hh:mm:ss<\/td><td>Transaction date<br><strong>Example:<\/strong> 2020-08-05 07:41:10<\/td><\/tr><tr><td><code>schedule_id<\/code><\/td><td><em>String<\/em><\/td><td>Optional<\/td><td>Schedule ID for recurring payments<\/td><\/tr><tr><td><strong>order<\/strong><\/td><td><em>Object<\/em><\/td><td><\/td><td><\/td><\/tr><tr><td><code>number<\/code><\/td><td><em>String<\/em><\/td><td>Required<br>max: 255<\/td><td>Order ID<br><strong>Example:<\/strong> order-1234<\/td><\/tr><tr><td><code>amount<\/code><\/td><td><em>String<\/em><\/td><td>Required<br>Format: XX.XX<\/td><td>Product price (currency will be defined by the first payment)<br><strong>Example:<\/strong> 0.19<\/td><\/tr><tr><td><code>currency<\/code><\/td><td><em>String<\/em><\/td><td>Required<br>3 characters<\/td><td>Currency<br><strong>Example:<\/strong> USD<\/td><\/tr><tr><td><code>description<\/code><\/td><td><em>String<\/em><\/td><td>Required<br>max: 1024<\/td><td>Product name<br><strong>Example:<\/strong> Very important gift &#8211; # 9<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n<div\n    class=\"betterdocs-faq-wrapper layout-classic icon-before betterdocs-faq-layout-2 betterdocs-faq-815xiyw betterdocs-shortcode\">\n    <h2 class=\"betterdocs-faq-layout-2 betterdocs-faq-815xiyw betterdocs-faq-section-title\">\n            <\/h2>\n\n    <div class=\"betterdocs-faq-inner-wrapper\">\n        <div class=\"betterdocs-faq-title\">\n    <h2>Example Request<\/h2>\n<\/div>\n<ul class=\"betterdocs-faq-list\"><li><div class=\"betterdocs-faq-group\"><div class=\"betterdocs-faq-post\">\n    <div class=\"betterdocs-faq-post-icon-group\"><svg class=\"betterdocs-faq-iconplus\" xmlns=\"http:\/\/www.w3.org\/2000\/svg\" viewbox=\"0 0 24 24\"><path fill=\"#000000\" d=\"M18 10h-4V6h-4v4H6v4h4v4h4v-4h4\"><\/path><\/svg><svg class=\"betterdocs-faq-iconminus\" xmlns=\"http:\/\/www.w3.org\/2000\/svg\" viewbox=\"0 0 24 24\"><path fill=\"#000000\" d=\"M6 10h12v4H6z\"><\/path><\/svg><\/div>    <span class=\"betterdocs-faq-post-name\">\n        Recurring (settled)    <\/span>\n    <\/div>\n<div class=\"betterdocs-faq-main-content\">\n    <p>curl &#8211;location -g &#8211;request POST &#8216;{{CHECKOUT_HOST}}\/api\/v1\/payment\/recurring&#8217; <\/p>\n<p>&#8211;header &#8216;Content-Type: application\/json&#8217; <\/p>\n<p>&#8211;data-raw &#8216;{&nbsp;<\/p>\n<p>&nbsp;&nbsp;&nbsp;&#8220;merchant_key&#8221;:&#8221;xxxxx-xxxxx-xxxxx&#8221;,<\/p>\n<p>&nbsp;&nbsp;&nbsp;&#8220;order&#8221;:{<\/p>\n<p>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&#8220;number&#8221;:&#8221;order-1234&#8243;,<\/p>\n<p>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&#8220;amount&#8221;: &#8220;0.19&#8221;,<\/p>\n<p>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&#8220;description&#8221;:&#8221;very important gift&#8221;<\/p>\n<p>},<\/p>\n<p>&nbsp;&nbsp;&nbsp;&nbsp;&#8220;customer&#8221;: {<\/p>\n<p>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&#8220;name&#8221;: &#8220;John Doe&#8221;,<\/p>\n<p>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&#8220;email&#8221;: &#8220;success@gmail.com&#8221;<\/p>\n<p>&nbsp;&nbsp;&nbsp;&nbsp;},&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<\/p>\n<p>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&#8220;recurring_init_trans_id&#8221;:&#8221;dc66cdd8-d702-11ea-9a2f-0242c0a87002&#8243;,&nbsp;<\/p>\n<p>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&#8220;recurring_token&#8221;:&#8221;9a2f-0242c0a87002&#8243;,<\/p>\n<p>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&#8220;schedule_id&#8221;:&#8221;57fddecf-17b9-4d38-9320-a670f0c29ec0&#8243;,&nbsp;<\/p>\n<p>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&#8220;hash&#8221;:&#8221;{{session_hash}}&#8221;<\/p>\n<p>}&#8217;<\/p>\n<\/div>\n<\/div><\/li><li><div class=\"betterdocs-faq-group\"><div class=\"betterdocs-faq-post\">\n    <div class=\"betterdocs-faq-post-icon-group\"><svg class=\"betterdocs-faq-iconplus\" xmlns=\"http:\/\/www.w3.org\/2000\/svg\" viewbox=\"0 0 24 24\"><path fill=\"#000000\" d=\"M18 10h-4V6h-4v4H6v4h4v4h4v-4h4\"><\/path><\/svg><svg class=\"betterdocs-faq-iconminus\" xmlns=\"http:\/\/www.w3.org\/2000\/svg\" viewbox=\"0 0 24 24\"><path fill=\"#000000\" d=\"M6 10h12v4H6z\"><\/path><\/svg><\/div>    <span class=\"betterdocs-faq-post-name\">\n        Recurring (declined)    <\/span>\n    <\/div>\n<div class=\"betterdocs-faq-main-content\">\n    <p>curl &#8211;location -g &#8211;request POST &#8216;{{CHECKOUT_HOST}}\/api\/v1\/payment\/recurring&#8217; <\/p>\n<p>&#8211;header &#8216;Content-Type: application\/json&#8217; <\/p>\n<p>&#8211;data-raw &#8216;{&nbsp;<\/p>\n<p>&nbsp;&nbsp;&nbsp;&nbsp;&#8220;payment_id&#8221;: &#8220;1f34f446-fc45-11ec-a50f-0242ac120004&#8221;,<\/p>\n<p>&nbsp;&nbsp;&nbsp;&nbsp;&#8220;date&#8221;: &#8220;2022-07-05 09:30:34&#8221;,<\/p>\n<p>&nbsp;&nbsp;&nbsp;&nbsp;&#8220;status&#8221;: &#8220;decline&#8221;,<\/p>\n<p>&nbsp;&nbsp;&nbsp;&nbsp;&#8220;reason&#8221;: &#8220;Declined by processing.&#8221;,<\/p>\n<p>&nbsp;&nbsp;&nbsp;&nbsp;&#8220;order&#8221;: {<\/p>\n<p>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&#8220;number&#8221;: &#8220;order-1234&#8221;,<\/p>\n<p>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&#8220;amount&#8221;: &#8220;3.01&#8221;,<\/p>\n<p>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&#8220;currency&#8221;: &#8220;USD&#8221;,<\/p>\n<p>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&#8220;description&#8221;: &#8220;bloodline&#8221;<\/p>\n<p>&nbsp;&nbsp;&nbsp;&nbsp;},<\/p>\n<p>&nbsp;&nbsp;&nbsp;&nbsp;&#8220;customer&#8221;: {<\/p>\n<p>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&#8220;name&#8221;: &#8220;John Doe&#8221;,<\/p>\n<p>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&#8220;email&#8221;: &#8220;success@gmail.com&#8221;<\/p>\n<p>&nbsp;&nbsp;&nbsp;&nbsp;}<\/p>\n<p>}&#8217;<\/p>\n<\/div>\n<\/div><\/li><\/ul><script type=\"application\/ld+json\">{\"@context\":\"https:\\\/\\\/schema.org\",\"@type\":\"FAQPage\",\"mainEntity\":[{\"@type\":\"Question\",\"name\":\"Recurring (settled)\",\"acceptedAnswer\":{\"@type\":\"Answer\",\"text\":\"<p>curl --location -g --request POST '{{CHECKOUT_HOST}}\\\/api\\\/v1\\\/payment\\\/recurring' <\\\/p>\\n<p>--header 'Content-Type: application\\\/json' <\\\/p>\\n<p>--data-raw '{&nbsp;<\\\/p>\\n<p>&nbsp;&nbsp;&nbsp;\\\"merchant_key\\\":\\\"xxxxx-xxxxx-xxxxx\\\",<\\\/p>\\n<p>&nbsp;&nbsp;&nbsp;\\\"order\\\":{<\\\/p>\\n<p>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;\\\"number\\\":\\\"order-1234\\\",<\\\/p>\\n<p>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;\\\"amount\\\": \\\"0.19\\\",<\\\/p>\\n<p>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;\\\"description\\\":\\\"very important gift\\\"<\\\/p>\\n<p>},<\\\/p>\\n<p>&nbsp;&nbsp;&nbsp;&nbsp;\\\"customer\\\": {<\\\/p>\\n<p>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;\\\"name\\\": \\\"John Doe\\\",<\\\/p>\\n<p>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;\\\"email\\\": \\\"success@gmail.com\\\"<\\\/p>\\n<p>&nbsp;&nbsp;&nbsp;&nbsp;},&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<\\\/p>\\n<p>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;\\\"recurring_init_trans_id\\\":\\\"dc66cdd8-d702-11ea-9a2f-0242c0a87002\\\",&nbsp;<\\\/p>\\n<p>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;\\\"recurring_token\\\":\\\"9a2f-0242c0a87002\\\",<\\\/p>\\n<p>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;\\\"schedule_id\\\":\\\"57fddecf-17b9-4d38-9320-a670f0c29ec0\\\",&nbsp;<\\\/p>\\n<p>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;\\\"hash\\\":\\\"{{session_hash}}\\\"<\\\/p>\\n<p>}'<\\\/p>\\n\"}},{\"@type\":\"Question\",\"name\":\"Recurring (declined)\",\"acceptedAnswer\":{\"@type\":\"Answer\",\"text\":\"<p>curl --location -g --request POST '{{CHECKOUT_HOST}}\\\/api\\\/v1\\\/payment\\\/recurring' <\\\/p>\\n<p>--header 'Content-Type: application\\\/json' <\\\/p>\\n<p>--data-raw '{&nbsp;<\\\/p>\\n<p>&nbsp;&nbsp;&nbsp;&nbsp;\\\"payment_id\\\": \\\"1f34f446-fc45-11ec-a50f-0242ac120004\\\",<\\\/p>\\n<p>&nbsp;&nbsp;&nbsp;&nbsp;\\\"date\\\": \\\"2022-07-05 09:30:34\\\",<\\\/p>\\n<p>&nbsp;&nbsp;&nbsp;&nbsp;\\\"status\\\": \\\"decline\\\",<\\\/p>\\n<p>&nbsp;&nbsp;&nbsp;&nbsp;\\\"reason\\\": \\\"Declined by processing.\\\",<\\\/p>\\n<p>&nbsp;&nbsp;&nbsp;&nbsp;\\\"order\\\": {<\\\/p>\\n<p>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;\\\"number\\\": \\\"order-1234\\\",<\\\/p>\\n<p>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;\\\"amount\\\": \\\"3.01\\\",<\\\/p>\\n<p>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;\\\"currency\\\": \\\"USD\\\",<\\\/p>\\n<p>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;\\\"description\\\": \\\"bloodline\\\"<\\\/p>\\n<p>&nbsp;&nbsp;&nbsp;&nbsp;},<\\\/p>\\n<p>&nbsp;&nbsp;&nbsp;&nbsp;\\\"customer\\\": {<\\\/p>\\n<p>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;\\\"name\\\": \\\"John Doe\\\",<\\\/p>\\n<p>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;\\\"email\\\": \\\"success@gmail.com\\\"<\\\/p>\\n<p>&nbsp;&nbsp;&nbsp;&nbsp;}<\\\/p>\\n<p>}'<\\\/p>\\n\"}}]}<\/script>    <\/div>\n<\/div>\n\n\n<div\n    class=\"betterdocs-faq-wrapper layout-classic icon-before betterdocs-faq-layout-2 betterdocs-faq-pja1bix betterdocs-shortcode\">\n    <h2 class=\"betterdocs-faq-layout-2 betterdocs-faq-pja1bix betterdocs-faq-section-title\">\n            <\/h2>\n\n    <div class=\"betterdocs-faq-inner-wrapper\">\n        <div class=\"betterdocs-faq-title\">\n    <h2>Example Response<\/h2>\n<\/div>\n<ul class=\"betterdocs-faq-list\"><li><div class=\"betterdocs-faq-group\"><div class=\"betterdocs-faq-post\">\n    <div class=\"betterdocs-faq-post-icon-group\"><svg class=\"betterdocs-faq-iconplus\" xmlns=\"http:\/\/www.w3.org\/2000\/svg\" viewbox=\"0 0 24 24\"><path fill=\"#000000\" d=\"M18 10h-4V6h-4v4H6v4h4v4h4v-4h4\"><\/path><\/svg><svg class=\"betterdocs-faq-iconminus\" xmlns=\"http:\/\/www.w3.org\/2000\/svg\" viewbox=\"0 0 24 24\"><path fill=\"#000000\" d=\"M6 10h12v4H6z\"><\/path><\/svg><\/div>    <span class=\"betterdocs-faq-post-name\">\n        Status Declined    <\/span>\n    <\/div>\n<div class=\"betterdocs-faq-main-content\">\n    <p>{<\/p>\n<p>&nbsp;&nbsp;&#8220;status&#8221;: &#8220;declined&#8221;,<\/p>\n<p>&nbsp;&nbsp;&#8220;reason&#8221;: &#8220;declined by processing&#8221;,<\/p>\n<p>&nbsp;&nbsp;&#8220;payment_id&#8221;: &#8220;dc66cdd8-d702-11ea-9a2f-0242c0a87002&#8221;,<\/p>\n<p>&nbsp;&nbsp;&#8220;schedule_id&#8221;:&#8221;57fddecf-17b9-4d38-9320-a670f0c29ec0&#8243;,<\/p>\n<p>&nbsp;&nbsp;&#8220;date&#8221;: &#8220;2020-08-05 07:41:10&#8221;,<\/p>\n<p>&nbsp;&nbsp;&#8220;order&#8221;: {<\/p>\n<p>&nbsp;&nbsp;&nbsp;&nbsp;&#8220;number&#8221;: &#8220;order-1234&#8221;,<\/p>\n<p>&nbsp;&nbsp;&nbsp;&nbsp;&#8220;amount&#8221;: &#8220;0.19&#8221;,<\/p>\n<p>&nbsp;&nbsp;&nbsp;&nbsp;&#8220;currency&#8221;: &#8220;USD&#8221;,<\/p>\n<p>&nbsp;&nbsp;&nbsp;&nbsp;&#8220;description&#8221;: &#8220;very important gift&#8221;<\/p>\n<p>&nbsp;&nbsp;}<\/p>\n<p>}<\/p>\n<\/div>\n<\/div><\/li><li><div class=\"betterdocs-faq-group\"><div class=\"betterdocs-faq-post\">\n    <div class=\"betterdocs-faq-post-icon-group\"><svg class=\"betterdocs-faq-iconplus\" xmlns=\"http:\/\/www.w3.org\/2000\/svg\" viewbox=\"0 0 24 24\"><path fill=\"#000000\" d=\"M18 10h-4V6h-4v4H6v4h4v4h4v-4h4\"><\/path><\/svg><svg class=\"betterdocs-faq-iconminus\" xmlns=\"http:\/\/www.w3.org\/2000\/svg\" viewbox=\"0 0 24 24\"><path fill=\"#000000\" d=\"M6 10h12v4H6z\"><\/path><\/svg><\/div>    <span class=\"betterdocs-faq-post-name\">\n        Status Settled    <\/span>\n    <\/div>\n<div class=\"betterdocs-faq-main-content\">\n    <p>{<\/p>\n<p>&nbsp;&nbsp;&#8220;status&#8221;: &#8220;settled&#8221;,<\/p>\n<p>&nbsp;&nbsp;&#8220;payment_id&#8221;: &#8220;dc66cdd8-d702-11ea-9a2f-0242c0a87002&#8221;,<\/p>\n<p>&nbsp;&nbsp;&#8220;date&#8221;: &#8220;2020-08-05 07:41:10&#8221;,<\/p>\n<p>&nbsp;&nbsp;&#8220;schedule_id&#8221;:&#8221;57fddecf-17b9-4d38-9320-a670f0c29ec0&#8243;,<\/p>\n<p>&nbsp;&nbsp;&#8220;order&#8221;: {<\/p>\n<p>&nbsp;&nbsp;&nbsp;&nbsp;&#8220;number&#8221;: &#8220;order-1234&#8221;,<\/p>\n<p>&nbsp;&nbsp;&nbsp;&nbsp;&#8220;amount&#8221;: &#8220;0.19&#8221;,<\/p>\n<p>&nbsp;&nbsp;&nbsp;&nbsp;&#8220;currency&#8221;: &#8220;USD&#8221;,<\/p>\n<p>&nbsp;&nbsp;&nbsp;&nbsp;&#8220;description&#8221;: &#8220;very important gift&#8221;<\/p>\n<p>&nbsp;&nbsp;}<\/p>\n<p>}<\/p>\n<\/div>\n<\/div><\/li><\/ul><script type=\"application\/ld+json\">{\"@context\":\"https:\\\/\\\/schema.org\",\"@type\":\"FAQPage\",\"mainEntity\":[{\"@type\":\"Question\",\"name\":\"Status Declined\",\"acceptedAnswer\":{\"@type\":\"Answer\",\"text\":\"<p>{<\\\/p>\\n<p>&nbsp;&nbsp;\\\"status\\\": \\\"declined\\\",<\\\/p>\\n<p>&nbsp;&nbsp;\\\"reason\\\": \\\"declined by processing\\\",<\\\/p>\\n<p>&nbsp;&nbsp;\\\"payment_id\\\": \\\"dc66cdd8-d702-11ea-9a2f-0242c0a87002\\\",<\\\/p>\\n<p>&nbsp;&nbsp;\\\"schedule_id\\\":\\\"57fddecf-17b9-4d38-9320-a670f0c29ec0\\\",<\\\/p>\\n<p>&nbsp;&nbsp;\\\"date\\\": \\\"2020-08-05 07:41:10\\\",<\\\/p>\\n<p>&nbsp;&nbsp;\\\"order\\\": {<\\\/p>\\n<p>&nbsp;&nbsp;&nbsp;&nbsp;\\\"number\\\": \\\"order-1234\\\",<\\\/p>\\n<p>&nbsp;&nbsp;&nbsp;&nbsp;\\\"amount\\\": \\\"0.19\\\",<\\\/p>\\n<p>&nbsp;&nbsp;&nbsp;&nbsp;\\\"currency\\\": \\\"USD\\\",<\\\/p>\\n<p>&nbsp;&nbsp;&nbsp;&nbsp;\\\"description\\\": \\\"very important gift\\\"<\\\/p>\\n<p>&nbsp;&nbsp;}<\\\/p>\\n<p>}<\\\/p>\\n\"}},{\"@type\":\"Question\",\"name\":\"Status Settled\",\"acceptedAnswer\":{\"@type\":\"Answer\",\"text\":\"<p>{<\\\/p>\\n<p>&nbsp;&nbsp;\\\"status\\\": \\\"settled\\\",<\\\/p>\\n<p>&nbsp;&nbsp;\\\"payment_id\\\": \\\"dc66cdd8-d702-11ea-9a2f-0242c0a87002\\\",<\\\/p>\\n<p>&nbsp;&nbsp;\\\"date\\\": \\\"2020-08-05 07:41:10\\\",<\\\/p>\\n<p>&nbsp;&nbsp;\\\"schedule_id\\\":\\\"57fddecf-17b9-4d38-9320-a670f0c29ec0\\\",<\\\/p>\\n<p>&nbsp;&nbsp;\\\"order\\\": {<\\\/p>\\n<p>&nbsp;&nbsp;&nbsp;&nbsp;\\\"number\\\": \\\"order-1234\\\",<\\\/p>\\n<p>&nbsp;&nbsp;&nbsp;&nbsp;\\\"amount\\\": \\\"0.19\\\",<\\\/p>\\n<p>&nbsp;&nbsp;&nbsp;&nbsp;\\\"currency\\\": \\\"USD\\\",<\\\/p>\\n<p>&nbsp;&nbsp;&nbsp;&nbsp;\\\"description\\\": \\\"very important gift\\\"<\\\/p>\\n<p>&nbsp;&nbsp;}<\\\/p>\\n<p>}<\\\/p>\\n\"}}]}<\/script>    <\/div>\n<\/div>\n\n\n\n<h2 class=\"wp-block-heading\" id=\"get-transaction-status\">Get transaction status<\/h2>\n\n\n\n<hr class=\"wp-block-separator has-alpha-channel-opacity\"\/>\n\n\n\n<p>This request is sent by POST in JSON format.<\/p>\n\n\n\n<p>To get order status you can use one the identifiers:<\/p>\n\n\n\n<p>\u2022 <code>payment_id<\/code> \u2013 transaction ID in the Payment Platform<br>\u2022 <code>order_id<\/code> \u2013 merchant\u2019s transaction ID<\/p>\n\n\n\n<pre class=\"wp-block-code\"><code>\/api\/v1\/payment\/status<\/code><\/pre>\n\n\n\n<p><strong>GET_TRANS_STATUS by <code>payment_id<\/code><\/strong><\/p>\n\n\n\n<h3 class=\"wp-block-heading\" id=\"request-parameters-by-payment_id\">Request Parameters by <code>payment_id<\/code><\/h3>\n\n\n\n<figure class=\"wp-block-table\"><table><thead><tr><th><strong>Parameter<\/strong><\/th><th><strong>Type<\/strong><\/th><th><strong>Mandatory, Limitations<\/strong><\/th><th><strong>Description<\/strong><\/th><\/tr><\/thead><tbody><tr><td><code>merchant_key<\/code><\/td><td><em>String<\/em><\/td><td>Required<\/td><td>Key for Merchant identification<br><strong>Example:<\/strong> xxxxx-xxxxx-xxxxx<\/td><\/tr><tr><td><code>payment_id<\/code><\/td><td><em>String<\/em><\/td><td>Required<br>Up to 255 characters<\/td><td>Payment ID (public)<br><strong>Example:<\/strong> dc66cdd8-d702-11ea-9a2f-0242c0a87002<\/td><\/tr><tr><td><code>hash<\/code><\/td><td><em>String<\/em><\/td><td>Required<\/td><td>Special signature to validate your request to Payment Platform Addition in Signature section.<br><ins>Must be SHA1 of MD5 encoded string (uppercased):<\/ins> payment_id + merchant_pass<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n<h3 class=\"wp-block-heading\" id=\"response-parameters-by-payment_id\">Response Parameters by <code>payment_id<\/code><\/h3>\n\n\n\n<figure class=\"wp-block-table\"><table><thead><tr><th><strong>Parameter<\/strong><\/th><th><strong>Type<\/strong><\/th><th><strong>Mandatory, Limitations<\/strong><\/th><th><strong>Description<\/strong><\/th><\/tr><\/thead><tbody><tr><td><code>payment_id<\/code><\/td><td><em>String<\/em><\/td><td>Required<br>Up to 255 characters<\/td><td>Payment ID (public)<br><strong>Example:<\/strong> dc66cdd8-d702-11ea-9a2f-0242c0a87002<\/td><\/tr><tr><td><code>date<\/code><\/td><td><em>String<\/em><\/td><td>Required<br>Format: YYYY-MM-DD hh:mm:ss<\/td><td>Transaction date<br><strong>Example:<\/strong> 2020-08-05 07:41:10<\/td><\/tr><tr><td><code>status<\/code><\/td><td><em>String<\/em><\/td><td>Required<\/td><td>Payment status: prepare, settled, pending, 3ds, redirect, decline, refund, reversal, void, chargeback<br><strong>Example:<\/strong> settled<\/td><\/tr><tr><td><code>reason<\/code><\/td><td><em>String<\/em><\/td><td>Optional<\/td><td>Decline reason translation for unsuccessful payment. It displays only if the transaction is unsuccessful<br><strong>Example:<\/strong> The operation was rejected. Please contact the site support<\/td><\/tr><tr><td><code>recurring_token<\/code><\/td><td><em>String<\/em><\/td><td>Optional<\/td><td>Recurring token (provided if recurring was initialized)<br><strong>Example:<\/strong> e5f60b35485e<\/td><\/tr><tr><td><code>shedule_id<\/code><\/td><td><em>String<\/em><\/td><td>Optional<\/td><td>Schedule ID for recurring payments. Only for purchase operation<br><strong>Example:<\/strong> 57fddecf-17b9-4d38-9320-a670f0c29ec0<\/td><\/tr><tr><td><strong>order<\/strong><\/td><td><em>Object<\/em><\/td><td><\/td><td><\/td><\/tr><tr><td><code>number<\/code><\/td><td><em>String<\/em><\/td><td>Required<br>Up to 255 characters<\/td><td>Order ID<br><strong>Example:<\/strong> order-1234<\/td><\/tr><tr><td><code>amount<\/code><\/td><td><em>String<\/em><\/td><td>Required<br>Format: XX.XX<\/td><td>Product price<br><strong>Example:<\/strong> 0.19<\/td><\/tr><tr><td><code>currency<\/code><\/td><td><em>String<\/em><\/td><td>Required<br>Up to 3 characters<\/td><td>Currency<br><strong>Example:<\/strong> USD<\/td><\/tr><tr><td><code>description<\/code><\/td><td><em>String<\/em><\/td><td>Required<br>Up to 1024 characters<\/td><td>Product name<br><strong>Example:<\/strong> Very important gift<\/td><\/tr><tr><td><strong>customer<\/strong><\/td><td><em>Object<\/em><\/td><td><\/td><td><\/td><\/tr><tr><td><code>name<\/code><\/td><td><em>String<\/em><\/td><td>Required<\/td><td>Customer&#8217;s name<br><strong>Example:<\/strong> John Doe<\/td><\/tr><tr><td><code>email<\/code><\/td><td><em>String<\/em><\/td><td>Required<\/td><td>Customer&#8217;s email address<br><strong>Example:<\/strong> <a href=\"mailto:example@mail.com\" target=\"_blank\" rel=\"noreferrer noopener\">example@mail.com<\/a><\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n<p>Example RequestExample Response<\/p>\n\n\n\n<p><strong>GET_TRANS_STATUS by <code>order_id<\/code><\/strong><\/p>\n\n\n\n<p>Use this request to get the status of the most recent transaction in the order&#8217;s transaction subsequence.<\/p>\n\n\n\n<p>It is recommended to send an unique order number (the <code>order.number<\/code> parameter) in the Authorization request. That way, it will be easier to uniquely identify the payment by <code>order_id<\/code>. This is especially important if cascading is configured. In this case, several intermediate transactions could be created within one payment.<\/p>\n\n\n\n<h3 class=\"wp-block-heading\" id=\"request-parameters-by-order_id\">Request Parameters by <code>order_id<\/code><\/h3>\n\n\n\n<figure class=\"wp-block-table\"><table><thead><tr><th><strong>Parameter<\/strong><\/th><th><strong>Type<\/strong><\/th><th><strong>Mandatory, Limitations<\/strong><\/th><th><strong>Description<\/strong><\/th><\/tr><\/thead><tbody><tr><td><code>merchant_key<\/code><\/td><td><em>String<\/em><\/td><td>Required<\/td><td>Key for Merchant identification<br><strong>Example:<\/strong> xxxxx-xxxxx-xxxxx<\/td><\/tr><tr><td><code>order_id<\/code><\/td><td><em>String<\/em><\/td><td>Required<br>Up to 255 characters<\/td><td>Merchant\u2019s Order Number<br><strong>Example:<\/strong> dc66cdd8-d702-11ea-9a2f-0242c0a87002<\/td><\/tr><tr><td><code>hash<\/code><\/td><td><em>String<\/em><\/td><td>Required<\/td><td>Special signature to validate your request to Payment Platform Addition in Signature section.<br><ins>Must be SHA1 of MD5 encoded string (uppercased):<\/ins> order_id + merchant_pass<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n<h3 class=\"wp-block-heading\" id=\"response-parameters-by-order_id\">Response Parameters by <code>order_id<\/code><\/h3>\n\n\n\n<figure class=\"wp-block-table\"><table><thead><tr><th><strong>Parameter<\/strong><\/th><th><strong>Type<\/strong><\/th><th><strong>Mandatory, Limitations<\/strong><\/th><th><strong>Description<\/strong><\/th><\/tr><\/thead><tbody><tr><td><code>payment_id<\/code><\/td><td><em>String<\/em><\/td><td>Required<br>Up to 255 characters<\/td><td>Transaction ID in Payment Platform<br><strong>Example:<\/strong> dc66cdd8-d702-11ea-9a2f-0242c0a87002<\/td><\/tr><tr><td><code>date<\/code><\/td><td><em>String<\/em><\/td><td>Required<br>Format: YYYY-MM-DD hh:mm:ss<\/td><td>Transaction date<br><strong>Example:<\/strong> 2020-08-05 07:41:10<\/td><\/tr><tr><td><code>status<\/code><\/td><td><em>String<\/em><\/td><td>Required<br>Up to 20 characters<\/td><td>Payment status: prepare, settled, pending, 3ds, redirect, decline, refund, reversal, void, chargeback<br><strong>Example:<\/strong> settled<\/td><\/tr><tr><td><code>reason<\/code><\/td><td><em>String<\/em><\/td><td>Optional<br>Up to 1024 characters<\/td><td>Decline reason translation for unsuccessful payment. It displays only if the transaction is unsuccessful<br><strong>Example:<\/strong> The operation was rejected. Please contact the site support<\/td><\/tr><tr><td><code>recurring_token<\/code><\/td><td><em>String<\/em><\/td><td>Optional<\/td><td>Recurring token (provided if recurring was initialized)<br><strong>Example:<\/strong> e5f60b35485e<\/td><\/tr><tr><td><code>shedule_id<\/code><\/td><td><em>String<\/em><\/td><td>Optional<\/td><td>Schedule ID for recurring payments. Only for purchase operation<br><strong>Example:<\/strong> 57fddecf-17b9-4d38-9320-a670f0c29ec0<\/td><\/tr><tr><td><strong>order<\/strong><\/td><td><em>Object<\/em><\/td><td><\/td><td><\/td><\/tr><tr><td><code>number<\/code><\/td><td><em>String<\/em><\/td><td>Required<br>Up to 255 characters<\/td><td>Merchant\u2019s Order ID<br><strong>Example:<\/strong> order-1234<\/td><\/tr><tr><td><code>amount<\/code><\/td><td><em>String<\/em><\/td><td>Required<br>Format: XX.XX<\/td><td>Product price (currency will be defined by the first payment)<br><strong>Example:<\/strong> 0.19<\/td><\/tr><tr><td><code>currency<\/code><\/td><td><em>String<\/em><\/td><td>Required<br>Up to 3 characters<\/td><td>Currency<br><strong>Example:<\/strong> USD<\/td><\/tr><tr><td><code>description<\/code><\/td><td><em>String<\/em><\/td><td>Required<br>Up to 1024 characters<\/td><td>Product name or other additional information<br><strong>Example:<\/strong> Very important gift<\/td><\/tr><tr><td><strong>customer<\/strong><\/td><td><em>Object<\/em><\/td><td><\/td><td><\/td><\/tr><tr><td><code>name<\/code><\/td><td><em>String<\/em><\/td><td>Required<\/td><td>Customer&#8217;s name<br><strong>Example:<\/strong> John Doe<\/td><\/tr><tr><td><code>email<\/code><\/td><td><em>String<\/em><\/td><td>Required<\/td><td>Customer&#8217;s email address<br><strong>Example:<\/strong> <a href=\"mailto:example@mail.com\" target=\"_blank\" rel=\"noreferrer noopener\">example@mail.com<\/a><\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n<div\n    class=\"betterdocs-faq-wrapper layout-classic icon-before betterdocs-faq-layout-2 betterdocs-faq-h9yk3nv betterdocs-shortcode\">\n    <h2 class=\"betterdocs-faq-layout-2 betterdocs-faq-h9yk3nv betterdocs-faq-section-title\">\n            <\/h2>\n\n    <div class=\"betterdocs-faq-inner-wrapper\">\n        <div class=\"betterdocs-faq-title\">\n    <h2>Example Request Parameter by ID<\/h2>\n<\/div>\n<ul class=\"betterdocs-faq-list\"><li><div class=\"betterdocs-faq-group\"><div class=\"betterdocs-faq-post\">\n    <div class=\"betterdocs-faq-post-icon-group\"><svg class=\"betterdocs-faq-iconplus\" xmlns=\"http:\/\/www.w3.org\/2000\/svg\" viewbox=\"0 0 24 24\"><path fill=\"#000000\" d=\"M18 10h-4V6h-4v4H6v4h4v4h4v-4h4\"><\/path><\/svg><svg class=\"betterdocs-faq-iconminus\" xmlns=\"http:\/\/www.w3.org\/2000\/svg\" viewbox=\"0 0 24 24\"><path fill=\"#000000\" d=\"M6 10h12v4H6z\"><\/path><\/svg><\/div>    <span class=\"betterdocs-faq-post-name\">\n        Example Request    <\/span>\n    <\/div>\n<div class=\"betterdocs-faq-main-content\">\n    <p>curl &#8211;location -g &#8211;request POST &#8216;{{CHECKOUT_HOST}}\/api\/v1\/payment\/status&#8217; <\/p>\n<p>&#8211;header &#8216;Content-Type: application\/json&#8217; <\/p>\n<p>&#8211;data-raw &#8216;{&nbsp;&nbsp;<\/p>\n<p>&nbsp;&nbsp;&nbsp;&#8220;merchant_key&#8221;:&#8221;xxxxx-xxxxx-xxxxx&#8221;,<\/p>\n<p>&nbsp;&nbsp;&nbsp;&#8220;order_id&#8221;:&#8221;63c781cc-de3d-11eb-a1f1-0242ac130006&#8243;,<\/p>\n<p>&nbsp;&nbsp;&nbsp;&#8220;hash&#8221;:&#8221;{{operation_hash}}&#8221;<\/p>\n<p>}<\/p>\n<p>&#8216;<\/p>\n<\/div>\n<\/div><\/li><\/ul><script type=\"application\/ld+json\">{\"@context\":\"https:\\\/\\\/schema.org\",\"@type\":\"FAQPage\",\"mainEntity\":[{\"@type\":\"Question\",\"name\":\"Example Request\",\"acceptedAnswer\":{\"@type\":\"Answer\",\"text\":\"<p>curl --location -g --request POST '{{CHECKOUT_HOST}}\\\/api\\\/v1\\\/payment\\\/status' <\\\/p>\\n<p>--header 'Content-Type: application\\\/json' <\\\/p>\\n<p>--data-raw '{&nbsp;&nbsp;<\\\/p>\\n<p>&nbsp;&nbsp;&nbsp;\\\"merchant_key\\\":\\\"xxxxx-xxxxx-xxxxx\\\",<\\\/p>\\n<p>&nbsp;&nbsp;&nbsp;\\\"order_id\\\":\\\"63c781cc-de3d-11eb-a1f1-0242ac130006\\\",<\\\/p>\\n<p>&nbsp;&nbsp;&nbsp;\\\"hash\\\":\\\"{{operation_hash}}\\\"<\\\/p>\\n<p>}<\\\/p>\\n<p>'<\\\/p>\\n\"}}]}<\/script>    <\/div>\n<\/div>\n\n\n<div\n    class=\"betterdocs-faq-wrapper layout-classic icon-before betterdocs-faq-layout-2 betterdocs-faq-jnffosy betterdocs-shortcode\">\n    <h2 class=\"betterdocs-faq-layout-2 betterdocs-faq-jnffosy betterdocs-faq-section-title\">\n            <\/h2>\n\n    <div class=\"betterdocs-faq-inner-wrapper\">\n        <div class=\"betterdocs-faq-title\">\n    <h2>Example Response Parameters by ID<\/h2>\n<\/div>\n<ul class=\"betterdocs-faq-list\"><li><div class=\"betterdocs-faq-group\"><div class=\"betterdocs-faq-post\">\n    <div class=\"betterdocs-faq-post-icon-group\"><svg class=\"betterdocs-faq-iconplus\" xmlns=\"http:\/\/www.w3.org\/2000\/svg\" viewbox=\"0 0 24 24\"><path fill=\"#000000\" d=\"M18 10h-4V6h-4v4H6v4h4v4h4v-4h4\"><\/path><\/svg><svg class=\"betterdocs-faq-iconminus\" xmlns=\"http:\/\/www.w3.org\/2000\/svg\" viewbox=\"0 0 24 24\"><path fill=\"#000000\" d=\"M6 10h12v4H6z\"><\/path><\/svg><\/div>    <span class=\"betterdocs-faq-post-name\">\n        Status Settled    <\/span>\n    <\/div>\n<div class=\"betterdocs-faq-main-content\">\n    <p>{<\/p>\n<p>&nbsp;&nbsp;&nbsp;&nbsp;&#8220;payment_id&#8221;: &#8220;24f7401c-fc47-11ec-8d07-0242ac120015&#8221;,<\/p>\n<p>&nbsp;&nbsp;&nbsp;&nbsp;&#8220;date&#8221;: &#8220;2022-07-05 09:45:03&#8221;,<\/p>\n<p>&nbsp;&nbsp;&nbsp;&nbsp;&#8220;status&#8221;: &#8220;settled&#8221;,<\/p>\n<p>&nbsp;&nbsp;&nbsp;&nbsp;&#8220;recurring_token&#8221;: &#8220;e5f60b35485e&#8221;,<\/p>\n<p>&nbsp;&nbsp;&nbsp;&nbsp;&#8220;shedule_id &#8220;: &#8220;57fddecf-17b9-4d38-9320-a670f0c29ec0&#8221;,<\/p>\n<p>&nbsp;&nbsp;&nbsp;&nbsp;&#8220;order&#8221;: {<\/p>\n<p>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&#8220;number&#8221;: &#8220;f0a51dfa-fc43-11ec-8128-0242ac120004-1&#8221;,<\/p>\n<p>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&#8220;amount&#8221;: &#8220;3.01&#8221;,<\/p>\n<p>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&#8220;currency&#8221;: &#8220;USD&#8221;,<\/p>\n<p>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&#8220;description&#8221;: &#8220;bloodline&#8221;<\/p>\n<p>&nbsp;&nbsp;&nbsp;&nbsp;},<\/p>\n<p>&nbsp;&nbsp;&nbsp;&nbsp;&#8220;customer&#8221;: {<\/p>\n<p>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&#8220;name&#8221;: &#8220;John Doe&#8221;,<\/p>\n<p>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&#8220;email&#8221;: &#8220;success@gmail.com&#8221;<\/p>\n<p>&nbsp;&nbsp;&nbsp;&nbsp;}<\/p>\n<p>}<\/p>\n<\/div>\n<\/div><\/li><li><div class=\"betterdocs-faq-group\"><div class=\"betterdocs-faq-post\">\n    <div class=\"betterdocs-faq-post-icon-group\"><svg class=\"betterdocs-faq-iconplus\" xmlns=\"http:\/\/www.w3.org\/2000\/svg\" viewbox=\"0 0 24 24\"><path fill=\"#000000\" d=\"M18 10h-4V6h-4v4H6v4h4v4h4v-4h4\"><\/path><\/svg><svg class=\"betterdocs-faq-iconminus\" xmlns=\"http:\/\/www.w3.org\/2000\/svg\" viewbox=\"0 0 24 24\"><path fill=\"#000000\" d=\"M6 10h12v4H6z\"><\/path><\/svg><\/div>    <span class=\"betterdocs-faq-post-name\">\n        Status Decline    <\/span>\n    <\/div>\n<div class=\"betterdocs-faq-main-content\">\n    <p>{<\/p>\n<p>&nbsp;&nbsp;&#8220;payment_id&#8221;: &#8220;03e46e96-de42-11eb-aea7-0242ac140002&#8221;,<\/p>\n<p>&nbsp;&nbsp;&#8220;date&#8221;: &#8220;2021-07-06 10:07:47&#8221;,<\/p>\n<p>&nbsp;&nbsp;&#8220;status&#8221;: &#8220;decline&#8221;,<\/p>\n<p>&nbsp;&nbsp;&#8220;reason&#8221;: &#8220;Declined by processing&#8221;,<\/p>\n<p>&nbsp;&nbsp;&#8220;order&#8221;: {<\/p>\n<p>&nbsp;&nbsp;&nbsp;&nbsp;&#8220;number&#8221;: &#8220;order-1234&#8221;,<\/p>\n<p>&nbsp;&nbsp;&nbsp;&nbsp;&#8220;amount&#8221;: &#8220;0.19&#8221;,<\/p>\n<p>&nbsp;&nbsp;&nbsp;&nbsp;&#8220;currency&#8221;: &#8220;USD&#8221;,<\/p>\n<p>&nbsp;&nbsp;&nbsp;&nbsp;&#8220;description&#8221;: &#8220;Important gift&#8221;<\/p>\n<p>&nbsp;&nbsp;},<\/p>\n<p>&nbsp;&nbsp;&#8220;customer&#8221;: {<\/p>\n<p>&nbsp;&nbsp;&nbsp;&nbsp;&#8220;name&#8221;: &#8220;John Doe&#8221;,<\/p>\n<p>&nbsp;&nbsp;&nbsp;&nbsp;&#8220;email&#8221;: &#8220;test@mail.com&#8221;<\/p>\n<p>&nbsp;&nbsp;}<\/p>\n<p>}<\/p>\n<\/div>\n<\/div><\/li><\/ul><script type=\"application\/ld+json\">{\"@context\":\"https:\\\/\\\/schema.org\",\"@type\":\"FAQPage\",\"mainEntity\":[{\"@type\":\"Question\",\"name\":\"Status Settled\",\"acceptedAnswer\":{\"@type\":\"Answer\",\"text\":\"<p>{<\\\/p>\\n<p>&nbsp;&nbsp;&nbsp;&nbsp;\\\"payment_id\\\": \\\"24f7401c-fc47-11ec-8d07-0242ac120015\\\",<\\\/p>\\n<p>&nbsp;&nbsp;&nbsp;&nbsp;\\\"date\\\": \\\"2022-07-05 09:45:03\\\",<\\\/p>\\n<p>&nbsp;&nbsp;&nbsp;&nbsp;\\\"status\\\": \\\"settled\\\",<\\\/p>\\n<p>&nbsp;&nbsp;&nbsp;&nbsp;\\\"recurring_token\\\": \\\"e5f60b35485e\\\",<\\\/p>\\n<p>&nbsp;&nbsp;&nbsp;&nbsp;\\\"shedule_id \\\": \\\"57fddecf-17b9-4d38-9320-a670f0c29ec0\\\",<\\\/p>\\n<p>&nbsp;&nbsp;&nbsp;&nbsp;\\\"order\\\": {<\\\/p>\\n<p>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;\\\"number\\\": \\\"f0a51dfa-fc43-11ec-8128-0242ac120004-1\\\",<\\\/p>\\n<p>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;\\\"amount\\\": \\\"3.01\\\",<\\\/p>\\n<p>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;\\\"currency\\\": \\\"USD\\\",<\\\/p>\\n<p>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;\\\"description\\\": \\\"bloodline\\\"<\\\/p>\\n<p>&nbsp;&nbsp;&nbsp;&nbsp;},<\\\/p>\\n<p>&nbsp;&nbsp;&nbsp;&nbsp;\\\"customer\\\": {<\\\/p>\\n<p>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;\\\"name\\\": \\\"John Doe\\\",<\\\/p>\\n<p>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;\\\"email\\\": \\\"success@gmail.com\\\"<\\\/p>\\n<p>&nbsp;&nbsp;&nbsp;&nbsp;}<\\\/p>\\n<p>}<\\\/p>\\n\"}},{\"@type\":\"Question\",\"name\":\"Status Decline\",\"acceptedAnswer\":{\"@type\":\"Answer\",\"text\":\"<p>{<\\\/p>\\n<p>&nbsp;&nbsp;\\\"payment_id\\\": \\\"03e46e96-de42-11eb-aea7-0242ac140002\\\",<\\\/p>\\n<p>&nbsp;&nbsp;\\\"date\\\": \\\"2021-07-06 10:07:47\\\",<\\\/p>\\n<p>&nbsp;&nbsp;\\\"status\\\": \\\"decline\\\",<\\\/p>\\n<p>&nbsp;&nbsp;\\\"reason\\\": \\\"Declined by processing\\\",<\\\/p>\\n<p>&nbsp;&nbsp;\\\"order\\\": {<\\\/p>\\n<p>&nbsp;&nbsp;&nbsp;&nbsp;\\\"number\\\": \\\"order-1234\\\",<\\\/p>\\n<p>&nbsp;&nbsp;&nbsp;&nbsp;\\\"amount\\\": \\\"0.19\\\",<\\\/p>\\n<p>&nbsp;&nbsp;&nbsp;&nbsp;\\\"currency\\\": \\\"USD\\\",<\\\/p>\\n<p>&nbsp;&nbsp;&nbsp;&nbsp;\\\"description\\\": \\\"Important gift\\\"<\\\/p>\\n<p>&nbsp;&nbsp;},<\\\/p>\\n<p>&nbsp;&nbsp;\\\"customer\\\": {<\\\/p>\\n<p>&nbsp;&nbsp;&nbsp;&nbsp;\\\"name\\\": \\\"John Doe\\\",<\\\/p>\\n<p>&nbsp;&nbsp;&nbsp;&nbsp;\\\"email\\\": \\\"test@mail.com\\\"<\\\/p>\\n<p>&nbsp;&nbsp;}<\\\/p>\\n<p>}<\\\/p>\\n\"}}]}<\/script>    <\/div>\n<\/div>\n\n\n\n<h2 class=\"wp-block-heading\" id=\"refund\">Refund<\/h2>\n\n\n\n<hr class=\"wp-block-separator has-alpha-channel-opacity\"\/>\n\n\n\n<p>To make refund you can use Refund request. Use payment public ID from Payment Platform in the request.<\/p>\n\n\n\n<p>This request is sent by POST in JSON format.<\/p>\n\n\n\n<p><strong>Refund request<\/strong><\/p>\n\n\n\n<pre class=\"wp-block-code\"><code>\/api\/v1\/payment\/refund<\/code><\/pre>\n\n\n\n<h3 class=\"wp-block-heading\" id=\"request-parameters-2\">Request Parameters<\/h3>\n\n\n\n<figure class=\"wp-block-table\"><table><thead><tr><th><strong>Parameter<\/strong><\/th><th><strong>Type<\/strong><\/th><th><strong>Mandatory, Limitations<\/strong><\/th><th><strong>Description<\/strong><\/th><\/tr><\/thead><tbody><tr><td><code>merchant_key<\/code><\/td><td><em>String<\/em><\/td><td>Required<\/td><td>Key for Merchant identification<br><strong>Example:<\/strong> xxxxx-xxxxx-xxxxx<\/td><\/tr><tr><td><code>payment_id<\/code><\/td><td><em>String<\/em><\/td><td>Required<br>Up to 255 characters<\/td><td>Payment ID (public)<br><strong>Example:<\/strong> dc66cdd8-d702-11ea-9a2f-0242c0a87002<\/td><\/tr><tr><td><code>amount<\/code><\/td><td><em>String<\/em><\/td><td>Required<br>Format: XX.XX, without leading zeroes<\/td><td>Amount to refund. It is required for particular refund.<br><strong>Example:<\/strong> 0.19<\/td><\/tr><tr><td><code>hash<\/code><\/td><td><em>String<\/em><\/td><td>Required<\/td><td>Special signature to validate your request to Payment Platform Addition in Signature section.<br><ins>Must be SHA1 of MD5 encoded string (uppercased):<\/ins> payment.id + amount + merchant.pass<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n<h3 class=\"wp-block-heading\" id=\"response-parameters-1\">Response Parameters<\/h3>\n\n\n\n<figure class=\"wp-block-table\"><table><thead><tr><th><strong>Parameter<\/strong><\/th><th><strong>Type<\/strong><\/th><th><strong>Mandatory, Limitations<\/strong><\/th><th><strong>Description<\/strong><\/th><\/tr><\/thead><tbody><tr><td><code>payment_id<\/code><\/td><td><em>String<\/em><\/td><td>Required Up to 255 characters<\/td><td>Transaction ID (public)<br><strong>Example:<\/strong> dc66cdd8-d702-11ea-9a2f-0242c0a87002<\/td><\/tr><tr><td><code>result<\/code><\/td><td><em>String<\/em><\/td><td>Required<\/td><td>Refund request result <strong>Example:<\/strong> accepted<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n<p>Example RequestExample Response: Refund request accepted<\/p>\n\n\n\n<h2 class=\"wp-block-heading\" id=\"void\">Void<\/h2>\n\n\n\n<hr class=\"wp-block-separator has-alpha-channel-opacity\"\/>\n\n\n\n<p>To make a void for an operation which was performed the same financial day you can use Void request.<\/p>\n\n\n\n<p>The Void request is allowed for the payments in SETTLED status only.<\/p>\n\n\n\n<p>Use payment public ID from Payment Platform in the request.<\/p>\n\n\n\n<p><strong>Void request<\/strong><\/p>\n\n\n\n<pre class=\"wp-block-code\"><code>\/api\/v1\/payment\/void<\/code><\/pre>\n\n\n\n<h3 class=\"wp-block-heading\" id=\"request-parameters-3\">Request Parameters<\/h3>\n\n\n\n<figure class=\"wp-block-table\"><table><thead><tr><th><strong>Parameter<\/strong><\/th><th><strong>Type<\/strong><\/th><th><strong>Mandatory, Limitations<\/strong><\/th><th><strong>Description<\/strong><\/th><\/tr><\/thead><tbody><tr><td><code>merchant_key<\/code><\/td><td><em>String<\/em><\/td><td>Required<\/td><td>Key for Merchant identification<br><strong>Example:<\/strong> xxxxx-xxxxx-xxxxx<\/td><\/tr><tr><td><code>payment_id<\/code><\/td><td><em>String<\/em><\/td><td>Required Up to 255 characters<\/td><td>Payment ID (public)<br><strong>Example:<\/strong> dc66cdd8-d702-11ea-9a2f-0242c0a87002<\/td><\/tr><tr><td><code>hash<\/code><\/td><td><em>String<\/em><\/td><td>Required<\/td><td>Special signature to validate your request to Payment Platform Addition in Signature section.<br><ins>Must be SHA1 of MD5 encoded string (uppercased):<\/ins> payment.id + merchant.pass<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n<h3 class=\"wp-block-heading\" id=\"response-parameters-2\">Response Parameters<\/h3>\n\n\n\n<figure class=\"wp-block-table\"><table><thead><tr><th><strong>Parameter<\/strong><\/th><th><strong>Type<\/strong><\/th><th><strong>Mandatory, Limitations<\/strong><\/th><th><strong>Description<\/strong><\/th><\/tr><\/thead><tbody><tr><td><code>status<\/code><\/td><td><em>String<\/em><\/td><td>Required<\/td><td>Payment status<br><strong>Example:<\/strong> VOID \/ SETTLED<\/td><\/tr><tr><td><code>payment_id<\/code><\/td><td><em>String<\/em><\/td><td>Required Up to 255 characters<\/td><td>Transaction ID (public)<br><strong>Example:<\/strong> dc66cdd8-d702-11ea-9a2f-0242c0a87002<\/td><\/tr><tr><td><code>date<\/code><\/td><td><em>String<\/em><\/td><td>Required<br>Format: YYYY-MM-DD hh:mm:ss<\/td><td>Transaction date<br><strong>Example:<\/strong> 2020-08-05 07:41:10<\/td><\/tr><tr><td><code>reason<\/code><\/td><td><em>String<\/em><\/td><td>Optional<\/td><td>Decline or error reason (for &#8220;sale&#8221;, &#8220;void &#8220;and &#8220;refund&#8221; operation types). It displays only if the transaction has FAIL status<br><strong>Example:<\/strong> The operation was rejected. Please contact the site support<\/td><\/tr><tr><td><strong>order<\/strong><\/td><td><em>Object<\/em><\/td><td><\/td><td><\/td><\/tr><tr><td><code>number<\/code><\/td><td><em>String<\/em><\/td><td>Required<\/td><td>Order ID<br><strong>Example:<\/strong> order-1234<\/td><\/tr><tr><td><code>amount<\/code><\/td><td><em>String<\/em><\/td><td>Required<\/td><td>Product price<br><strong>Example:<\/strong> 0.19<\/td><\/tr><tr><td><code>currency<\/code><\/td><td><em>String<\/em><\/td><td>Required Up to 3 characters<\/td><td>Currency<br><strong>Example:<\/strong> USD<\/td><\/tr><tr><td><code>description<\/code><\/td><td><em>String<\/em><\/td><td>Required Up to 1024 characters<\/td><td>Product name<br><strong>Example:<\/strong> Very important gift<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n<div\n    class=\"betterdocs-faq-wrapper layout-classic icon-before betterdocs-faq-layout-2 betterdocs-faq-ea7kuvz betterdocs-shortcode\">\n    <h2 class=\"betterdocs-faq-layout-2 betterdocs-faq-ea7kuvz betterdocs-faq-section-title\">\n            <\/h2>\n\n    <div class=\"betterdocs-faq-inner-wrapper\">\n        <div class=\"betterdocs-faq-title\">\n    <h2>Void Example Request<\/h2>\n<\/div>\n<ul class=\"betterdocs-faq-list\"><li><div class=\"betterdocs-faq-group\"><div class=\"betterdocs-faq-post\">\n    <div class=\"betterdocs-faq-post-icon-group\"><svg class=\"betterdocs-faq-iconplus\" xmlns=\"http:\/\/www.w3.org\/2000\/svg\" viewbox=\"0 0 24 24\"><path fill=\"#000000\" d=\"M18 10h-4V6h-4v4H6v4h4v4h4v-4h4\"><\/path><\/svg><svg class=\"betterdocs-faq-iconminus\" xmlns=\"http:\/\/www.w3.org\/2000\/svg\" viewbox=\"0 0 24 24\"><path fill=\"#000000\" d=\"M6 10h12v4H6z\"><\/path><\/svg><\/div>    <span class=\"betterdocs-faq-post-name\">\n        Example Request    <\/span>\n    <\/div>\n<div class=\"betterdocs-faq-main-content\">\n    <p>curl &#8211;location -g &#8211;request POST &#8216;{{CHECKOUT_HOST}}\/api\/v1\/payment\/void&#8217; <\/p>\n<p>&#8211;header &#8216;Content-Type: application\/json&#8217; <\/p>\n<p>&#8211;data-raw &#8216;{&nbsp;&nbsp;<\/p>\n<p>&nbsp;&nbsp;&nbsp;&#8220;merchant_key&#8221;:&#8221;xxxxx-xxxxx-xxxxx&#8221;,<\/p>\n<p>&nbsp;&nbsp;&nbsp;&#8220;payment_id&#8221;:&#8221;63c781cc-de3d-11eb-a1f1-0242ac130006&#8243;,<\/p>\n<p>&nbsp;&nbsp;&nbsp;&#8220;hash&#8221;:&#8221;{{operation_hash}}&#8221;<\/p>\n<p>}<\/p>\n<p>&#8216;<\/p>\n<\/div>\n<\/div><\/li><li><div class=\"betterdocs-faq-group\"><div class=\"betterdocs-faq-post\">\n    <div class=\"betterdocs-faq-post-icon-group\"><svg class=\"betterdocs-faq-iconplus\" xmlns=\"http:\/\/www.w3.org\/2000\/svg\" viewbox=\"0 0 24 24\"><path fill=\"#000000\" d=\"M18 10h-4V6h-4v4H6v4h4v4h4v-4h4\"><\/path><\/svg><svg class=\"betterdocs-faq-iconminus\" xmlns=\"http:\/\/www.w3.org\/2000\/svg\" viewbox=\"0 0 24 24\"><path fill=\"#000000\" d=\"M6 10h12v4H6z\"><\/path><\/svg><\/div>    <span class=\"betterdocs-faq-post-name\">\n        Example Response: Void successful    <\/span>\n    <\/div>\n<div class=\"betterdocs-faq-main-content\">\n    <p>{<\/p>\n<p>&nbsp;&nbsp;&#8220;status&#8221;: &#8220;SUCCESS&#8221;,&nbsp;<\/p>\n<p>&nbsp;&nbsp;&#8220;payment_status&#8221;: &#8220;void&#8221;,<\/p>\n<p>&nbsp;&nbsp;&#8220;payment_id&#8221;: &#8220;dc66cdd8-d702-11ea-9a2f-0242c0a87002&#8221;,<\/p>\n<p>&nbsp;&nbsp;&#8220;date&#8221;: &#8220;2020-08-05 07:41:10&#8221;,<\/p>\n<p>&nbsp;&nbsp;&#8220;order&#8221;: {<\/p>\n<p>&nbsp;&nbsp;&nbsp;&nbsp;&#8220;number&#8221;: &#8220;order-1234&#8221;,<\/p>\n<p>&nbsp;&nbsp;&nbsp;&nbsp;&#8220;amount&#8221;: &#8220;0.19&#8221;,<\/p>\n<p>&nbsp;&nbsp;&nbsp;&nbsp;&#8220;currency&#8221;: &#8220;USD&#8221;,<\/p>\n<p>&nbsp;&nbsp;&nbsp;&nbsp;&#8220;description&#8221;: &#8220;very important gift&#8221;<\/p>\n<p>&nbsp;&nbsp;}<\/p>\n<p>}<\/p>\n<\/div>\n<\/div><\/li><li><div class=\"betterdocs-faq-group\"><div class=\"betterdocs-faq-post\">\n    <div class=\"betterdocs-faq-post-icon-group\"><svg class=\"betterdocs-faq-iconplus\" xmlns=\"http:\/\/www.w3.org\/2000\/svg\" viewbox=\"0 0 24 24\"><path fill=\"#000000\" d=\"M18 10h-4V6h-4v4H6v4h4v4h4v-4h4\"><\/path><\/svg><svg class=\"betterdocs-faq-iconminus\" xmlns=\"http:\/\/www.w3.org\/2000\/svg\" viewbox=\"0 0 24 24\"><path fill=\"#000000\" d=\"M6 10h12v4H6z\"><\/path><\/svg><\/div>    <span class=\"betterdocs-faq-post-name\">\n        Example Response: Void failed    <\/span>\n    <\/div>\n<div class=\"betterdocs-faq-main-content\">\n    <p>{<\/p>\n<p>&nbsp;&nbsp;&#8220;status&#8221;: &#8220;FAIL&#8221;,&nbsp;<\/p>\n<p>&nbsp;&nbsp;&#8220;payment_status&#8221;: &#8220;settled&#8221;,<\/p>\n<p>&nbsp;&nbsp;&#8220;payment_id&#8221;: &#8220;dc66cdd8-d702-11ea-9a2f-0242c0a87002&#8221;,<\/p>\n<p>&nbsp;&nbsp;&#8220;date&#8221;: &#8220;2020-08-05 07:41:10&#8221;,<\/p>\n<p>&nbsp;&nbsp;&#8220;reason&#8221;: &#8220;Declined by processing&#8221;,<\/p>\n<p>&nbsp;&nbsp;&nbsp;&#8220;order&#8221;: {<\/p>\n<p>&nbsp;&nbsp;&nbsp;&nbsp;&#8220;number&#8221;: &#8220;order-1234&#8221;,<\/p>\n<p>&nbsp;&nbsp;&nbsp;&nbsp;&#8220;amount&#8221;: &#8220;0.19&#8221;,<\/p>\n<p>&nbsp;&nbsp;&nbsp;&nbsp;&#8220;currency&#8221;: &#8220;USD&#8221;,<\/p>\n<p>&nbsp;&nbsp;&nbsp;&nbsp;&#8220;description&#8221;: &#8220;very important gift&#8221;<\/p>\n<p>&nbsp;&nbsp;}<\/p>\n<p>}<\/p>\n<\/div>\n<\/div><\/li><\/ul><script type=\"application\/ld+json\">{\"@context\":\"https:\\\/\\\/schema.org\",\"@type\":\"FAQPage\",\"mainEntity\":[{\"@type\":\"Question\",\"name\":\"Example Request\",\"acceptedAnswer\":{\"@type\":\"Answer\",\"text\":\"<p>curl --location -g --request POST '{{CHECKOUT_HOST}}\\\/api\\\/v1\\\/payment\\\/void' <\\\/p>\\n<p>--header 'Content-Type: application\\\/json' <\\\/p>\\n<p>--data-raw '{&nbsp;&nbsp;<\\\/p>\\n<p>&nbsp;&nbsp;&nbsp;\\\"merchant_key\\\":\\\"xxxxx-xxxxx-xxxxx\\\",<\\\/p>\\n<p>&nbsp;&nbsp;&nbsp;\\\"payment_id\\\":\\\"63c781cc-de3d-11eb-a1f1-0242ac130006\\\",<\\\/p>\\n<p>&nbsp;&nbsp;&nbsp;\\\"hash\\\":\\\"{{operation_hash}}\\\"<\\\/p>\\n<p>}<\\\/p>\\n<p>'<\\\/p>\\n\"}},{\"@type\":\"Question\",\"name\":\"Example Response: Void successful\",\"acceptedAnswer\":{\"@type\":\"Answer\",\"text\":\"<p>{<\\\/p>\\n<p>&nbsp;&nbsp;\\\"status\\\": \\\"SUCCESS\\\",&nbsp;<\\\/p>\\n<p>&nbsp;&nbsp;\\\"payment_status\\\": \\\"void\\\",<\\\/p>\\n<p>&nbsp;&nbsp;\\\"payment_id\\\": \\\"dc66cdd8-d702-11ea-9a2f-0242c0a87002\\\",<\\\/p>\\n<p>&nbsp;&nbsp;\\\"date\\\": \\\"2020-08-05 07:41:10\\\",<\\\/p>\\n<p>&nbsp;&nbsp;\\\"order\\\": {<\\\/p>\\n<p>&nbsp;&nbsp;&nbsp;&nbsp;\\\"number\\\": \\\"order-1234\\\",<\\\/p>\\n<p>&nbsp;&nbsp;&nbsp;&nbsp;\\\"amount\\\": \\\"0.19\\\",<\\\/p>\\n<p>&nbsp;&nbsp;&nbsp;&nbsp;\\\"currency\\\": \\\"USD\\\",<\\\/p>\\n<p>&nbsp;&nbsp;&nbsp;&nbsp;\\\"description\\\": \\\"very important gift\\\"<\\\/p>\\n<p>&nbsp;&nbsp;}<\\\/p>\\n<p>}<\\\/p>\\n\"}},{\"@type\":\"Question\",\"name\":\"Example Response: Void failed\",\"acceptedAnswer\":{\"@type\":\"Answer\",\"text\":\"<p>{<\\\/p>\\n<p>&nbsp;&nbsp;\\\"status\\\": \\\"FAIL\\\",&nbsp;<\\\/p>\\n<p>&nbsp;&nbsp;\\\"payment_status\\\": \\\"settled\\\",<\\\/p>\\n<p>&nbsp;&nbsp;\\\"payment_id\\\": \\\"dc66cdd8-d702-11ea-9a2f-0242c0a87002\\\",<\\\/p>\\n<p>&nbsp;&nbsp;\\\"date\\\": \\\"2020-08-05 07:41:10\\\",<\\\/p>\\n<p>&nbsp;&nbsp;\\\"reason\\\": \\\"Declined by processing\\\",<\\\/p>\\n<p>&nbsp;&nbsp;&nbsp;\\\"order\\\": {<\\\/p>\\n<p>&nbsp;&nbsp;&nbsp;&nbsp;\\\"number\\\": \\\"order-1234\\\",<\\\/p>\\n<p>&nbsp;&nbsp;&nbsp;&nbsp;\\\"amount\\\": \\\"0.19\\\",<\\\/p>\\n<p>&nbsp;&nbsp;&nbsp;&nbsp;\\\"currency\\\": \\\"USD\\\",<\\\/p>\\n<p>&nbsp;&nbsp;&nbsp;&nbsp;\\\"description\\\": \\\"very important gift\\\"<\\\/p>\\n<p>&nbsp;&nbsp;}<\\\/p>\\n<p>}<\\\/p>\\n\"}}]}<\/script>    <\/div>\n<\/div>\n\n\n\n<h2 class=\"wp-block-heading\" id=\"signature\">Signature<\/h2>\n\n\n\n<hr class=\"wp-block-separator has-alpha-channel-opacity\"\/>\n\n\n\n<p>Sign is signature rule used either to validate your requests to payment platform or to validate callback from payment platform to your system.<\/p>\n\n\n\n<h3 class=\"wp-block-heading\" id=\"authentication-signature\">Authentication Signature<\/h3>\n\n\n\n<p>It must be SHA1 of MD5 encoded string and calculated by the formula below:<\/p>\n\n\n\n<p>*sha1(md5(strtoupper(id.order.amount.currency.description.PASSWORD)))<\/p>\n\n\n\n<p>\/\/ Use the CryptoJSvar<\/p>\n\n\n\n<h4 class=\"wp-block-heading\" id=\"example-for-js\">Example for JS<\/h4>\n\n\n\n<pre class=\"wp-block-code\"><code>var to_md5 = order.number + order.amount + order.currency + order.description + merchant.pass;<\/code><\/pre>\n\n\n\n<p>\/\/ Use the CryptoJS<\/p>\n\n\n\n<p><em>var hash = CryptoJS.SHA1(CryptoJS.MD5(to_md5.toUpperCase()).toString());<\/em><\/p>\n\n\n\n<p><em>var result = CryptoJS.enc.Hex.stringify(hash);<\/em><\/p>\n\n\n\n<h3 class=\"wp-block-heading\" id=\"get-transaction-status-signature-by-payment_id\">Get Transaction Status Signature (by <code>payment_id<\/code>)<\/h3>\n\n\n\n<p>It must be SHA1 of MD5 encoded string and calculated by the formula below:<\/p>\n\n\n\n<p><em>hash = CryptoJS.SHA1(CryptoJS.MD5(to_md5.toUpperCase()).toString());<\/em><\/p>\n\n\n\n<p><em>*sha1(md5(strtoupper))<\/em><\/p>\n\n\n\n<p>\/\/ Use the CryptoJSvar<\/p>\n\n\n\n<h4 class=\"wp-block-heading\" id=\"example-for-js-1\">Example for JS<\/h4>\n\n\n\n<pre class=\"wp-block-code\"><code>var to_md5 = payment.id + merchant.pass;<\/code><\/pre>\n\n\n\n<p>\/\/ Use the CryptoJS<\/p>\n\n\n\n<p><em>var hash = CryptoJS.SHA1(CryptoJS.MD5(to_md5.toUpperCase()).toString());<\/em><\/p>\n\n\n\n<p><em>var result = CryptoJS.enc.Hex.stringify(hash);<\/em><\/p>\n\n\n\n<h3 class=\"wp-block-heading\" id=\"get-transaction-status-signature-by-order_id\">Get Transaction Status Signature (by <code>order_id<\/code>)<\/h3>\n\n\n\n<p>It must be SHA1 of MD5 encoded string and calculated by the formula below:<\/p>\n\n\n\n<p><em>hash = CryptoJS.SHA1(CryptoJS.MD5(to_md5.toUpperCase()).toString());<\/em><\/p>\n\n\n\n<p><em>*sha1(md5(strtoupper))<\/em><\/p>\n\n\n\n<p>\/\/ Use the CryptoJSvar<\/p>\n\n\n\n<h4 class=\"wp-block-heading\" id=\"example-for-js-2\">Example for JS<\/h4>\n\n\n\n<pre class=\"wp-block-code\"><code>var to_md5 = order.id + merchant.pass;<\/code><\/pre>\n\n\n\n<p>\/\/ Use the CryptoJS<\/p>\n\n\n\n<p><em>var hash = CryptoJS.SHA1(CryptoJS.MD5(to_md5.toUpperCase()).toString());<\/em><\/p>\n\n\n\n<p><em>var result = CryptoJS.enc.Hex.stringify(hash);<\/em><\/p>\n\n\n\n<h3 class=\"wp-block-heading\" id=\"refund-signature\">Refund Signature<\/h3>\n\n\n\n<p>It must be SHA1 of MD5 encoded string and calculated by the formula below:<\/p>\n\n\n\n<p><em>hash = CryptoJS.SHA1(CryptoJS.MD5(to_md5.toUpperCase()).toString()); *sha1(md5(strtoupper))<\/em><\/p>\n\n\n\n<p>\/\/ Use the CryptoJSvar<\/p>\n\n\n\n<h4 class=\"wp-block-heading\" id=\"example-for-js-3\">Example for JS<\/h4>\n\n\n\n<pre class=\"wp-block-code\"><code>var to_md5 = payment.id + amount + merchant.pass;<\/code><\/pre>\n\n\n\n<p>\/\/ Use the CryptoJS<\/p>\n\n\n\n<p><em>var hash = CryptoJS.SHA1(CryptoJS.MD5(to_md5.toUpperCase()).toString());<\/em><\/p>\n\n\n\n<p><em>var result = CryptoJS.enc.Hex.stringify(hash);<\/em><\/p>\n\n\n\n<h3 class=\"wp-block-heading\" id=\"void-signature\">Void Signature<\/h3>\n\n\n\n<p>It must be SHA1 of MD5 encoded string and calculated by the formula below:<\/p>\n\n\n\n<p><em>hash = CryptoJS.SHA1(CryptoJS.MD5(to_md5.toUpperCase()).toString()); *sha1(md5(strtoupper))<\/em><\/p>\n\n\n\n<p>\/\/ Use the CryptoJSvar<\/p>\n\n\n\n<h4 class=\"wp-block-heading\" id=\"example-for-js-4\">Example for JS<\/h4>\n\n\n\n<pre class=\"wp-block-code\"><code>var to_md5 = payment.id + merchant.pass;<\/code><\/pre>\n\n\n\n<p>\/\/ Use the CryptoJS<\/p>\n\n\n\n<p><em>var hash = CryptoJS.SHA1(CryptoJS.MD5(to_md5.toUpperCase()).toString());<\/em><\/p>\n\n\n\n<p><em>var result = CryptoJS.enc.Hex.stringify(hash);<\/em><\/p>\n\n\n\n<h3 class=\"wp-block-heading\" id=\"recurring-signature\">Recurring Signature<\/h3>\n\n\n\n<p>It must be SHA1 of MD5 encoded string and calculated by the formula below:<\/p>\n\n\n\n<p>*sha1(md5(strtoupper(recurring_init_trans_id.recurring_token.order_id.amount.description.merchant.pass)))<\/p>\n\n\n\n<p>\/\/ Use the CryptoJS<\/p>\n\n\n\n<h4 class=\"wp-block-heading\" id=\"example-for-js-5\">Example for JS<\/h4>\n\n\n\n<pre class=\"wp-block-code\"><code>var to_md5 = recurring_init_trans_id + recurring_token + order.number + order.amount + order.description + merchant.pass;<\/code><\/pre>\n\n\n\n<p>\/\/ Use the CryptoJS<\/p>\n\n\n\n<p>var hash = CryptoJS.SHA1(CryptoJS.MD5(to_md5.toUpperCase()).toString());<\/p>\n\n\n\n<p>var result = CryptoJS.enc.Hex.stringify(hash);<\/p>\n\n\n\n<h3 class=\"wp-block-heading\" id=\"signature-for-return\">Signature for return<\/h3>\n\n\n\n<p>It must be SHA1 of MD5 encoded string and calculated by the formula below:<\/p>\n\n\n\n<p><em>hash = CryptoJS.SHA1(CryptoJS.MD5(to_md5.toUpperCase()).toString());<\/em> *sha1(md5(strtoupper(payment_public_id.order_id.amount.currency.description.PASSWORD)))<\/p>\n\n\n\n<p>Example for JS<\/p>\n\n\n\n<pre class=\"wp-block-code\"><code>var to_md5 = payment_public_id + order.number + order.amount + order.currency + order.description + merchant.pass;<\/code><\/pre>\n\n\n\n<p>\/\/ Use the CryptoJS<\/p>\n\n\n\n<p><em>var hash = CryptoJS.SHA1(CryptoJS.MD5(to_md5.toUpperCase()).toString());<\/em><\/p>\n\n\n\n<p><em>var result = CryptoJS.enc.Hex.stringify(hash);<\/em><\/p>\n\n\n\n<h3 class=\"wp-block-heading\" id=\"callback-signature\">Callback Signature<\/h3>\n\n\n\n<p>It must be SHA1 of MD5 encoded string and calculated by the formula below:<\/p>\n\n\n\n<p><em>hash = CryptoJS.SHA1(CryptoJS.MD5(to_md5.toUpperCase()).toString()); *sha1(md5(strtoupper(payment_public_id.order_id.amount.currency.description.PASSWORD)))<\/em><\/p>\n\n\n\n<h4 class=\"wp-block-heading\" id=\"example-for-js-6\">Example for JS<\/h4>\n\n\n\n<pre class=\"wp-block-code\"><code>var to_md5 = payment_public_id + order.number + order.amount + order.currency + order.description + merchant.pass;<\/code><\/pre>\n\n\n\n<p>\/\/ Use the CryptoJS<\/p>\n\n\n\n<p><em>var hash = CryptoJS.SHA1(CryptoJS.MD5(to_md5.toUpperCase()).toString());<\/em><\/p>\n\n\n\n<p><em>var result = CryptoJS.enc.Hex.stringify(hash);<\/em><\/p>\n\n\n\n<h2 class=\"wp-block-heading\" id=\"testing\">Testing<\/h2>\n\n\n\n<hr class=\"wp-block-separator has-alpha-channel-opacity\"\/>\n\n\n\n<p>You can test your integration. To do the test you need to perform the actions with the API using (in test mode). For instance, send the request and receive the response with a link on the Checkout page.<br>To mark your transactions as test in the system, you should use Merchant Test Key as value of the <code>merchant_key<\/code> parameter. You can contact your administrator to make sure that you have the necessary settings to work with test transactions.<\/p>\n\n\n\n<p>Use the following test data to emulate the different scenarios.<\/p>\n\n\n\n<p><strong>Scenario: SUCCESS payment<\/strong><\/p>\n\n\n\n<p><strong>Card data:<\/strong><\/p>\n\n\n\n<p><code>Card number<\/code> 4111 1111 1111 1111<br><code>Expiry Date<\/code> 01\/38<br><code>CVV2<\/code> any 3 digits<\/p>\n\n\n\n<p>\u26a0\ufe0f Use that card data to create recurring payments and get a recurring token for the initial recurring. Testing recurring payments does not work with other test cards.<\/p>\n\n\n\n<p><strong>Result:<\/strong> customer is redirected to the &#8220;success_URL&#8221;<\/p>\n\n\n\n<p><strong>Scenario: FAILED payment (decline)<\/strong><\/p>\n\n\n\n<p><strong>Card data:<\/strong><\/p>\n\n\n\n<p><code>Card number<\/code> 4111 1111 1111 1111<br><code>Expiry Date<\/code> 02\/38<br><code>CVV2<\/code> any 3 digits<\/p>\n\n\n\n<p><strong>Result:<\/strong> customer gets an error message: Declined by processing.<\/p>\n\n\n\n<p><strong>Scenario: SUCCESS 3DS payment<\/strong><\/p>\n\n\n\n<p><strong>Card data:<\/strong><\/p>\n\n\n\n<p><code>Card number<\/code> 4111 1111 1111 1111<br><code>Expiry Date<\/code> 05\/38<br><code>CVV2<\/code> any 3 digits<\/p>\n\n\n\n<p><strong>Result:<\/strong> customer is redirected to the &#8220;success_URL&#8221; after 3DS verification<\/p>\n\n\n\n<p><strong>Scenario: FAILED 3DS payment<\/strong><\/p>\n\n\n\n<p><strong>Card data:<\/strong><\/p>\n\n\n\n<p><code>Card number<\/code> 4111 1111 1111 1111<br><code>Expiry Date<\/code> 06\/38<br><code>CVV2<\/code> any 3 digits<\/p>\n\n\n\n<p><strong>Result:<\/strong> customer gets unsuccessful sale after 3DS verification<\/p>\n\n\n\n<p><strong>Scenario: FAILED payment (Luhn algorithm)<\/strong><\/p>\n\n\n\n<p><strong>Card data:<\/strong><\/p>\n\n\n\n<p><code>Card number<\/code> 1111 2222 3333 4444<br><code>Expiry Date<\/code> 01\/38<br><code>CVV2<\/code> any 3 digits<\/p>\n\n\n\n<p><strong>Result:<\/strong> customer gets an error message: Bad Request. Brand of card does not support.<\/p>\n\n\n\n<h2 class=\"wp-block-heading\" id=\"payment-methods\">Payment methods<\/h2>\n\n\n\n<hr class=\"wp-block-separator has-alpha-channel-opacity\"\/>\n\n\n\n<p>You can choose the payment methods that you want to display on the payment form. Use <code>methods<\/code> array in the Authentication request and specify the values that correspond to the payment methods. As well, you can use the value of the payment method to add specific parameters to the Authentification request for the <code>paramaters<\/code> object. These parameters will be sent to the acquirer to pass the necessary data for successful payment.<\/p>\n\n\n\n<h3 class=\"wp-block-heading\" id=\"card\">card<\/h3>\n\n\n\n<p>If the payer chooses the <code>card<\/code> payment method, fields with card data will be displayed on the Checkout page.<\/p>\n\n\n\n<p>For some connector services, it is necessary to send additional parameters in the Authenticaion request for the <code>paramaters<\/code> object (for more information, contact your manager).<\/p>\n\n\n\n<h4 class=\"wp-block-heading\" id=\"additional-parameters---set-1-bng\">Additional parameters &#8211; Set 1 (BNG)<\/h4>\n\n\n\n<figure class=\"wp-block-table\"><table><thead><tr><th><strong>Parameter<\/strong><\/th><th><strong>Type<\/strong><\/th><th><strong>Mandatory<\/strong><\/th><th><strong>Description<\/strong><\/th><\/tr><\/thead><tbody><tr><td><code>bnrg_installm_def<\/code><\/td><td><em>Numeric justified to 2 digits<\/em><\/td><td>Required<\/td><td>Indicates the number of months that will elapse from the purchase until the total or partial charge is made to the cardholder&#8217;s account (initial deferral).<br>Possible values:<br><code>01<\/code> &#8211; one month<br><code>00<\/code> &#8211; no delay initial<\/td><\/tr><tr><td><code>bnrg_installm_months<\/code><\/td><td><em>Numeric justified to 2 digits<\/em><\/td><td>Required<\/td><td>Indicates the number of monthly payments in which the total amount of the transaction will be divided.<br>Example: <code>03<\/code> &#8211; 3 months<\/td><\/tr><tr><td><code>bnrg_installm_plan<\/code><\/td><td><em>Numeric justified to 2 digits<\/em><\/td><td>Required<\/td><td>Indicates if the promotion It will be \u0301 with interest or without interest.<br>Possible values:<br><code>03<\/code> &#8211; no interest<br><code>05<\/code> &#8211; with interest<br><code>07<\/code> &#8211; defer only initial.<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n<div\n    class=\"betterdocs-faq-wrapper layout-classic icon-before betterdocs-faq-layout-2 betterdocs-faq-86d9ida betterdocs-shortcode\">\n    <h2 class=\"betterdocs-faq-layout-2 betterdocs-faq-86d9ida betterdocs-faq-section-title\">\n            <\/h2>\n\n    <div class=\"betterdocs-faq-inner-wrapper\">\n        <div class=\"betterdocs-faq-title\">\n    <h2>Card Authentication Request Example<\/h2>\n<\/div>\n<ul class=\"betterdocs-faq-list\"><li><div class=\"betterdocs-faq-group\"><div class=\"betterdocs-faq-post\">\n    <div class=\"betterdocs-faq-post-icon-group\"><svg class=\"betterdocs-faq-iconplus\" xmlns=\"http:\/\/www.w3.org\/2000\/svg\" viewbox=\"0 0 24 24\"><path fill=\"#000000\" d=\"M18 10h-4V6h-4v4H6v4h4v4h4v-4h4\"><\/path><\/svg><svg class=\"betterdocs-faq-iconminus\" xmlns=\"http:\/\/www.w3.org\/2000\/svg\" viewbox=\"0 0 24 24\"><path fill=\"#000000\" d=\"M6 10h12v4H6z\"><\/path><\/svg><\/div>    <span class=\"betterdocs-faq-post-name\">\n        Authentication request example    <\/span>\n    <\/div>\n<div class=\"betterdocs-faq-main-content\">\n    <p>curl &#8211;location -g &#8211;request POST &#8216;{{CHECKOUT_HOST}}\/api\/v1\/session&#8217; <\/p>\n<p>&#8211;header &#8216;Content-Type: application\/json&#8217; <\/p>\n<p>&#8211;data-raw &#8216;{<\/p>\n<p>&nbsp;&nbsp;&nbsp;&nbsp;&#8220;merchant_key&#8221;: &#8220;xxxxx-xxxxx-xxxxx&#8221;,<\/p>\n<p>&nbsp;&nbsp;&nbsp;&nbsp;&#8220;operation&#8221;: &#8220;purchase&#8221;,<\/p>\n<p>&nbsp;&nbsp;&nbsp;&nbsp;&#8220;methods&#8221;: [<\/p>\n<p>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&#8220;card&#8221;<\/p>\n<p>&nbsp;&nbsp;&nbsp;&nbsp;],<\/p>\n<p>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&#8220;parameters&#8221;: {<\/p>\n<p>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&#8220;card&#8221;: {<\/p>\n<p>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&#8220;bnrg_installm_def&#8221;: &#8220;03&#8221;,<\/p>\n<p>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&#8220;bnrg_installm_months&#8221;: &#8220;03&#8221;,<\/p>\n<p>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&#8220;bnrg_installm_plan&#8221;: &#8220;03&#8221;<\/p>\n<p>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;}<\/p>\n<p>&nbsp;&nbsp;&nbsp;&nbsp;},&nbsp;&nbsp;&nbsp;<\/p>\n<p>&nbsp;&nbsp;&nbsp;&nbsp;&#8220;order&#8221;: {<\/p>\n<p>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&#8220;number&#8221;: &#8220;order-1234&#8221;,<\/p>\n<p>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&#8220;amount&#8221;: &#8220;1000.19&#8221;,<\/p>\n<p>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&#8220;currency&#8221;: &#8220;MXN&#8221;,<\/p>\n<p>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&#8220;description&#8221;: &#8220;Important gift&#8221;<\/p>\n<p>&nbsp;&nbsp;&nbsp;&nbsp;},<\/p>\n<p>&nbsp;&nbsp;&nbsp;&nbsp;&#8220;cancel_url&#8221;: &#8220;https:\/\/example.com\/cancel&#8221;,<\/p>\n<p>&nbsp;&nbsp;&nbsp;&nbsp;&#8220;success_url&#8221;: &#8220;https:\/\/example.com\/success&#8221;,<\/p>\n<p>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&#8220;customer&#8221;: {<\/p>\n<p>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&#8220;name&#8221;: &#8220;John Doe&#8221;,<\/p>\n<p>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&#8220;email&#8221;: &#8220;test@gmail.com&#8221;<\/p>\n<p>&nbsp;&nbsp;&nbsp;&nbsp;},<\/p>\n<p>&nbsp;&nbsp;&nbsp;&nbsp;&#8220;billing_address&#8221;: {<\/p>\n<p>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&#8220;country&#8221;: &#8220;US&#8221;,<\/p>\n<p>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&#8220;state&#8221;: &#8220;CA&#8221;,<\/p>\n<p>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&#8220;city&#8221;: &#8220;Los Angeles&#8221;,<\/p>\n<p>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&#8220;address&#8221;: &#8220;Moor Building 35274&#8221;,<\/p>\n<p>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&#8220;zip&#8221;: &#8220;123456&#8221;,<\/p>\n<p>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&#8220;phone&#8221;: &#8220;347771112233&#8221;<\/p>\n<p>&nbsp;&nbsp;&nbsp;&nbsp;},<\/p>\n<p>&nbsp;&nbsp;&nbsp;&nbsp;&#8220;hash&#8221;: &#8220;{{session_hash}}&#8221;,<\/p>\n<p>}<\/p>\n<p>&#8216;<\/p>\n<\/div>\n<\/div><\/li><\/ul><script type=\"application\/ld+json\">{\"@context\":\"https:\\\/\\\/schema.org\",\"@type\":\"FAQPage\",\"mainEntity\":[{\"@type\":\"Question\",\"name\":\"Authentication request example\",\"acceptedAnswer\":{\"@type\":\"Answer\",\"text\":\"<p>curl --location -g --request POST '{{CHECKOUT_HOST}}\\\/api\\\/v1\\\/session' <\\\/p>\\n<p>--header 'Content-Type: application\\\/json' <\\\/p>\\n<p>--data-raw '{<\\\/p>\\n<p>&nbsp;&nbsp;&nbsp;&nbsp;\\\"merchant_key\\\": \\\"xxxxx-xxxxx-xxxxx\\\",<\\\/p>\\n<p>&nbsp;&nbsp;&nbsp;&nbsp;\\\"operation\\\": \\\"purchase\\\",<\\\/p>\\n<p>&nbsp;&nbsp;&nbsp;&nbsp;\\\"methods\\\": [<\\\/p>\\n<p>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;\\\"card\\\"<\\\/p>\\n<p>&nbsp;&nbsp;&nbsp;&nbsp;],<\\\/p>\\n<p>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;\\\"parameters\\\": {<\\\/p>\\n<p>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;\\\"card\\\": {<\\\/p>\\n<p>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;\\\"bnrg_installm_def\\\": \\\"03\\\",<\\\/p>\\n<p>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;\\\"bnrg_installm_months\\\": \\\"03\\\",<\\\/p>\\n<p>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;\\\"bnrg_installm_plan\\\": \\\"03\\\"<\\\/p>\\n<p>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;}<\\\/p>\\n<p>&nbsp;&nbsp;&nbsp;&nbsp;},&nbsp;&nbsp;&nbsp;<\\\/p>\\n<p>&nbsp;&nbsp;&nbsp;&nbsp;\\\"order\\\": {<\\\/p>\\n<p>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;\\\"number\\\": \\\"order-1234\\\",<\\\/p>\\n<p>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;\\\"amount\\\": \\\"1000.19\\\",<\\\/p>\\n<p>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;\\\"currency\\\": \\\"MXN\\\",<\\\/p>\\n<p>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;\\\"description\\\": \\\"Important gift\\\"<\\\/p>\\n<p>&nbsp;&nbsp;&nbsp;&nbsp;},<\\\/p>\\n<p>&nbsp;&nbsp;&nbsp;&nbsp;\\\"cancel_url\\\": \\\"https:\\\/\\\/example.com\\\/cancel\\\",<\\\/p>\\n<p>&nbsp;&nbsp;&nbsp;&nbsp;\\\"success_url\\\": \\\"https:\\\/\\\/example.com\\\/success\\\",<\\\/p>\\n<p>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;\\\"customer\\\": {<\\\/p>\\n<p>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;\\\"name\\\": \\\"John Doe\\\",<\\\/p>\\n<p>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;\\\"email\\\": \\\"test@gmail.com\\\"<\\\/p>\\n<p>&nbsp;&nbsp;&nbsp;&nbsp;},<\\\/p>\\n<p>&nbsp;&nbsp;&nbsp;&nbsp;\\\"billing_address\\\": {<\\\/p>\\n<p>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;\\\"country\\\": \\\"US\\\",<\\\/p>\\n<p>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;\\\"state\\\": \\\"CA\\\",<\\\/p>\\n<p>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;\\\"city\\\": \\\"Los Angeles\\\",<\\\/p>\\n<p>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;\\\"address\\\": \\\"Moor Building 35274\\\",<\\\/p>\\n<p>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;\\\"zip\\\": \\\"123456\\\",<\\\/p>\\n<p>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;\\\"phone\\\": \\\"347771112233\\\"<\\\/p>\\n<p>&nbsp;&nbsp;&nbsp;&nbsp;},<\\\/p>\\n<p>&nbsp;&nbsp;&nbsp;&nbsp;\\\"hash\\\": \\\"{{session_hash}}\\\",<\\\/p>\\n<p>}<\\\/p>\\n<p>'<\\\/p>\\n\"}}]}<\/script>    <\/div>\n<\/div>\n\n\n\n<h4 class=\"wp-block-heading\" id=\"additional-parameters---set-2-fcp\">Additional parameters &#8211; Set 2 (FCP)<\/h4>\n\n\n\n<figure class=\"wp-block-table\"><table><thead><tr><th><strong>Parameter<\/strong><\/th><th><strong>Type<\/strong><\/th><th><strong>Mandatory<\/strong><\/th><th><strong>Description<\/strong><\/th><\/tr><\/thead><tbody><tr><td><code>document_type<\/code><\/td><td><em>String<\/em><\/td><td>Required<\/td><td>Type of the document number specified above. Possibe values: cpf<\/td><\/tr><tr><td><code>document_number<\/code><\/td><td><em>String<\/em><\/td><td>Required<\/td><td>Client\u2019s document number<\/td><\/tr><tr><td><code>social_name<\/code><\/td><td><em>String<\/em><\/td><td>Required<\/td><td>Client&#8217;s social name<\/td><\/tr><tr><td><code>fiscal_country<\/code><\/td><td><em>String<\/em><\/td><td>Required<\/td><td>An alpha-2 country code of the customer\u2019s tax country<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n<div\n    class=\"betterdocs-faq-wrapper layout-classic icon-before betterdocs-faq-layout-2 betterdocs-faq-cmp098h betterdocs-shortcode\">\n    <h2 class=\"betterdocs-faq-layout-2 betterdocs-faq-cmp098h betterdocs-faq-section-title\">\n            <\/h2>\n\n    <div class=\"betterdocs-faq-inner-wrapper\">\n        <div class=\"betterdocs-faq-title\">\n    <h2>Additional parameters &#8211; Set 2 (FCP) &#8211; Reuest Example<\/h2>\n<\/div>\n<ul class=\"betterdocs-faq-list\"><li><div class=\"betterdocs-faq-group\"><div class=\"betterdocs-faq-post\">\n    <div class=\"betterdocs-faq-post-icon-group\"><svg class=\"betterdocs-faq-iconplus\" xmlns=\"http:\/\/www.w3.org\/2000\/svg\" viewbox=\"0 0 24 24\"><path fill=\"#000000\" d=\"M18 10h-4V6h-4v4H6v4h4v4h4v-4h4\"><\/path><\/svg><svg class=\"betterdocs-faq-iconminus\" xmlns=\"http:\/\/www.w3.org\/2000\/svg\" viewbox=\"0 0 24 24\"><path fill=\"#000000\" d=\"M6 10h12v4H6z\"><\/path><\/svg><\/div>    <span class=\"betterdocs-faq-post-name\">\n        Authentication request example    <\/span>\n    <\/div>\n<div class=\"betterdocs-faq-main-content\">\n    <p>curl &#8211;location -g &#8211;request POST &#8216;{{CHECKOUT_HOST}}\/api\/v1\/session&#8217; <\/p>\n<p>&#8211;header &#8216;Content-Type: application\/json&#8217; <\/p>\n<p>&#8211;data-raw &#8216;{<\/p>\n<p>&nbsp;&nbsp;&nbsp;&nbsp;&#8220;merchant_key&#8221;: &#8220;xxxxx-xxxxx-xxxxx&#8221;,<\/p>\n<p>&nbsp;&nbsp;&nbsp;&nbsp;&#8220;operation&#8221;: &#8220;purchase&#8221;,<\/p>\n<p>&nbsp;&nbsp;&nbsp;&nbsp;&#8220;methods&#8221;: [<\/p>\n<p>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&#8220;card&#8221;<\/p>\n<p>&nbsp;&nbsp;&nbsp;&nbsp;],<\/p>\n<p>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&#8220;parameters&#8221;: {<\/p>\n<p>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&#8220;card&#8221;: {<\/p>\n<p>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&#8220;document_type&#8221;: &#8220;cpf&#8221;,<\/p>\n<p>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&#8220;document_number&#8221;: &#8220;231.002.999-00&#8221;,<\/p>\n<p>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&#8220;social_name&#8221;: &#8220;Harry Potter&#8221;,<\/p>\n<p>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&#8220;fiscal_country&#8221;: &#8220;BR&#8221;,<\/p>\n<p>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&#8220;toBankAccountId&#8221;: &#8220;a1a1134a-32c6-442c-90c9-66b587d5be00&#8221;<\/p>\n<p>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;}<\/p>\n<p>&nbsp;&nbsp;&nbsp;&nbsp;},&nbsp;&nbsp;&nbsp;<\/p>\n<p>&nbsp;&nbsp;&nbsp;&nbsp;&#8220;order&#8221;: {<\/p>\n<p>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&#8220;number&#8221;: &#8220;order-1234&#8221;,<\/p>\n<p>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&#8220;amount&#8221;: &#8220;1000.19&#8221;,<\/p>\n<p>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&#8220;currency&#8221;: &#8220;BRL&#8221;,<\/p>\n<p>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&#8220;description&#8221;: &#8220;Important gift&#8221;<\/p>\n<p>&nbsp;&nbsp;&nbsp;&nbsp;},<\/p>\n<p>&nbsp;&nbsp;&nbsp;&nbsp;&#8220;cancel_url&#8221;: &#8220;https:\/\/example.com\/cancel&#8221;,<\/p>\n<p>&nbsp;&nbsp;&nbsp;&nbsp;&#8220;success_url&#8221;: &#8220;https:\/\/example.com\/success&#8221;,<\/p>\n<p>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&#8220;customer&#8221;: {<\/p>\n<p>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&#8220;name&#8221;: &#8220;John Doe&#8221;,<\/p>\n<p>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&#8220;email&#8221;: &#8220;test@gmail.com&#8221;<\/p>\n<p>&nbsp;&nbsp;&nbsp;&nbsp;},<\/p>\n<p>&nbsp;&nbsp;&nbsp;&nbsp;&#8220;billing_address&#8221;: {<\/p>\n<p>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&#8220;country&#8221;: &#8220;US&#8221;,<\/p>\n<p>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&#8220;state&#8221;: &#8220;CA&#8221;,<\/p>\n<p>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&#8220;city&#8221;: &#8220;Los Angeles&#8221;,<\/p>\n<p>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&#8220;address&#8221;: &#8220;Moor Building 35274&#8221;,<\/p>\n<p>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&#8220;zip&#8221;: &#8220;123456&#8221;,<\/p>\n<p>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&#8220;phone&#8221;: &#8220;347771112233&#8221;<\/p>\n<p>&nbsp;&nbsp;&nbsp;&nbsp;},<\/p>\n<p>&nbsp;&nbsp;&nbsp;&nbsp;&#8220;hash&#8221;: &#8220;{{session_hash}}&#8221;,<\/p>\n<p>}&#8217;<\/p>\n<\/div>\n<\/div><\/li><\/ul><script type=\"application\/ld+json\">{\"@context\":\"https:\\\/\\\/schema.org\",\"@type\":\"FAQPage\",\"mainEntity\":[{\"@type\":\"Question\",\"name\":\"Authentication request example\",\"acceptedAnswer\":{\"@type\":\"Answer\",\"text\":\"<p>curl --location -g --request POST '{{CHECKOUT_HOST}}\\\/api\\\/v1\\\/session' <\\\/p>\\n<p>--header 'Content-Type: application\\\/json' <\\\/p>\\n<p>--data-raw '{<\\\/p>\\n<p>&nbsp;&nbsp;&nbsp;&nbsp;\\\"merchant_key\\\": \\\"xxxxx-xxxxx-xxxxx\\\",<\\\/p>\\n<p>&nbsp;&nbsp;&nbsp;&nbsp;\\\"operation\\\": \\\"purchase\\\",<\\\/p>\\n<p>&nbsp;&nbsp;&nbsp;&nbsp;\\\"methods\\\": [<\\\/p>\\n<p>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;\\\"card\\\"<\\\/p>\\n<p>&nbsp;&nbsp;&nbsp;&nbsp;],<\\\/p>\\n<p>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;\\\"parameters\\\": {<\\\/p>\\n<p>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;\\\"card\\\": {<\\\/p>\\n<p>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;\\\"document_type\\\": \\\"cpf\\\",<\\\/p>\\n<p>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;\\\"document_number\\\": \\\"231.002.999-00\\\",<\\\/p>\\n<p>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;\\\"social_name\\\": \\\"Harry Potter\\\",<\\\/p>\\n<p>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;\\\"fiscal_country\\\": \\\"BR\\\",<\\\/p>\\n<p>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;\\\"toBankAccountId\\\": \\\"a1a1134a-32c6-442c-90c9-66b587d5be00\\\"<\\\/p>\\n<p>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;}<\\\/p>\\n<p>&nbsp;&nbsp;&nbsp;&nbsp;},&nbsp;&nbsp;&nbsp;<\\\/p>\\n<p>&nbsp;&nbsp;&nbsp;&nbsp;\\\"order\\\": {<\\\/p>\\n<p>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;\\\"number\\\": \\\"order-1234\\\",<\\\/p>\\n<p>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;\\\"amount\\\": \\\"1000.19\\\",<\\\/p>\\n<p>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;\\\"currency\\\": \\\"BRL\\\",<\\\/p>\\n<p>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;\\\"description\\\": \\\"Important gift\\\"<\\\/p>\\n<p>&nbsp;&nbsp;&nbsp;&nbsp;},<\\\/p>\\n<p>&nbsp;&nbsp;&nbsp;&nbsp;\\\"cancel_url\\\": \\\"https:\\\/\\\/example.com\\\/cancel\\\",<\\\/p>\\n<p>&nbsp;&nbsp;&nbsp;&nbsp;\\\"success_url\\\": \\\"https:\\\/\\\/example.com\\\/success\\\",<\\\/p>\\n<p>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;\\\"customer\\\": {<\\\/p>\\n<p>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;\\\"name\\\": \\\"John Doe\\\",<\\\/p>\\n<p>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;\\\"email\\\": \\\"test@gmail.com\\\"<\\\/p>\\n<p>&nbsp;&nbsp;&nbsp;&nbsp;},<\\\/p>\\n<p>&nbsp;&nbsp;&nbsp;&nbsp;\\\"billing_address\\\": {<\\\/p>\\n<p>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;\\\"country\\\": \\\"US\\\",<\\\/p>\\n<p>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;\\\"state\\\": \\\"CA\\\",<\\\/p>\\n<p>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;\\\"city\\\": \\\"Los Angeles\\\",<\\\/p>\\n<p>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;\\\"address\\\": \\\"Moor Building 35274\\\",<\\\/p>\\n<p>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;\\\"zip\\\": \\\"123456\\\",<\\\/p>\\n<p>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;\\\"phone\\\": \\\"347771112233\\\"<\\\/p>\\n<p>&nbsp;&nbsp;&nbsp;&nbsp;},<\\\/p>\\n<p>&nbsp;&nbsp;&nbsp;&nbsp;\\\"hash\\\": \\\"{{session_hash}}\\\",<\\\/p>\\n<p>}'<\\\/p>\\n\"}}]}<\/script>    <\/div>\n<\/div>\n\n\n\n<h4 class=\"wp-block-heading\" id=\"additional-parameters---set-3-lbp\">Additional parameters &#8211; Set 3 (LBP)<\/h4>\n\n\n\n<figure class=\"wp-block-table\"><table><thead><tr><th><strong>Parameter<\/strong><\/th><th><strong>Type<\/strong><\/th><th><strong>Mandatory<\/strong><\/th><th><strong>Description<\/strong><\/th><\/tr><\/thead><tbody><tr><td><code>descriptor<\/code><\/td><td><em>String<\/em> (20 characters)<\/td><td>Optional<\/td><td>Transaction descriptor<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n<div\n    class=\"betterdocs-faq-wrapper layout-classic icon-before betterdocs-faq-layout-2 betterdocs-faq-01j5evm betterdocs-shortcode\">\n    <h2 class=\"betterdocs-faq-layout-2 betterdocs-faq-01j5evm betterdocs-faq-section-title\">\n            <\/h2>\n\n    <div class=\"betterdocs-faq-inner-wrapper\">\n        <div class=\"betterdocs-faq-title\">\n    <h2>Additional parameters &#8211; Set 3 (LBP) &#8211; Authentication<\/h2>\n<\/div>\n<ul class=\"betterdocs-faq-list\"><li><div class=\"betterdocs-faq-group\"><div class=\"betterdocs-faq-post\">\n    <div class=\"betterdocs-faq-post-icon-group\"><svg class=\"betterdocs-faq-iconplus\" xmlns=\"http:\/\/www.w3.org\/2000\/svg\" viewbox=\"0 0 24 24\"><path fill=\"#000000\" d=\"M18 10h-4V6h-4v4H6v4h4v4h4v-4h4\"><\/path><\/svg><svg class=\"betterdocs-faq-iconminus\" xmlns=\"http:\/\/www.w3.org\/2000\/svg\" viewbox=\"0 0 24 24\"><path fill=\"#000000\" d=\"M6 10h12v4H6z\"><\/path><\/svg><\/div>    <span class=\"betterdocs-faq-post-name\">\n        Authentication request example    <\/span>\n    <\/div>\n<div class=\"betterdocs-faq-main-content\">\n    <p>curl &#8211;location -g &#8211;request POST &#8216;{{CHECKOUT_HOST}}\/api\/v1\/session&#8217; <\/p>\n<p>&#8211;header &#8216;Content-Type: application\/json&#8217; <\/p>\n<p>&#8211;data-raw &#8216;{<\/p>\n<p>&nbsp;&nbsp;&nbsp;&nbsp;&#8220;merchant_key&#8221;: &#8220;xxxxx-xxxxx-xxxxx&#8221;,<\/p>\n<p>&nbsp;&nbsp;&nbsp;&nbsp;&#8220;operation&#8221;: &#8220;purchase&#8221;,<\/p>\n<p>&nbsp;&nbsp;&nbsp;&nbsp;&#8220;methods&#8221;: [<\/p>\n<p>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&#8220;card&#8221;<\/p>\n<p>&nbsp;&nbsp;&nbsp;&nbsp;],<\/p>\n<p>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&#8220;parameters&#8221;: {<\/p>\n<p>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&#8220;card&#8221;: {<\/p>\n<p>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&#8220;descriptor&#8221;: &#8220;Testy International LTD&#8221;<\/p>\n<p>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;}<\/p>\n<p>&nbsp;&nbsp;&nbsp;&nbsp;},&nbsp;&nbsp;&nbsp;<\/p>\n<p>&nbsp;&nbsp;&nbsp;&nbsp;&#8220;order&#8221;: {<\/p>\n<p>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&#8220;number&#8221;: &#8220;order-1234&#8221;,<\/p>\n<p>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&#8220;amount&#8221;: &#8220;1000.19&#8221;,<\/p>\n<p>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&#8220;currency&#8221;: &#8220;BRL&#8221;,<\/p>\n<p>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&#8220;description&#8221;: &#8220;Important gift&#8221;<\/p>\n<p>&nbsp;&nbsp;&nbsp;&nbsp;},<\/p>\n<p>&nbsp;&nbsp;&nbsp;&nbsp;&#8220;cancel_url&#8221;: &#8220;https:\/\/example.com\/cancel&#8221;,<\/p>\n<p>&nbsp;&nbsp;&nbsp;&nbsp;&#8220;success_url&#8221;: &#8220;https:\/\/example.com\/success&#8221;,<\/p>\n<p>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&#8220;customer&#8221;: {<\/p>\n<p>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&#8220;name&#8221;: &#8220;John Doe&#8221;,<\/p>\n<p>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&#8220;email&#8221;: &#8220;test@gmail.com&#8221;<\/p>\n<p>&nbsp;&nbsp;&nbsp;&nbsp;},<\/p>\n<p>&nbsp;&nbsp;&nbsp;&nbsp;&#8220;billing_address&#8221;: {<\/p>\n<p>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&#8220;country&#8221;: &#8220;US&#8221;,<\/p>\n<p>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&#8220;state&#8221;: &#8220;CA&#8221;,<\/p>\n<p>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&#8220;city&#8221;: &#8220;Los Angeles&#8221;,<\/p>\n<p>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&#8220;address&#8221;: &#8220;Moor Building 35274&#8221;,<\/p>\n<p>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&#8220;zip&#8221;: &#8220;123456&#8221;,<\/p>\n<p>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&#8220;phone&#8221;: &#8220;347771112233&#8221;<\/p>\n<p>&nbsp;&nbsp;&nbsp;&nbsp;},<\/p>\n<p>&nbsp;&nbsp;&nbsp;&nbsp;&#8220;hash&#8221;: &#8220;{{session_hash}}&#8221;,<\/p>\n<p>}<\/p>\n<p>&#8216;<\/p>\n<\/div>\n<\/div><\/li><\/ul><script type=\"application\/ld+json\">{\"@context\":\"https:\\\/\\\/schema.org\",\"@type\":\"FAQPage\",\"mainEntity\":[{\"@type\":\"Question\",\"name\":\"Authentication request example\",\"acceptedAnswer\":{\"@type\":\"Answer\",\"text\":\"<p>curl --location -g --request POST '{{CHECKOUT_HOST}}\\\/api\\\/v1\\\/session' <\\\/p>\\n<p>--header 'Content-Type: application\\\/json' <\\\/p>\\n<p>--data-raw '{<\\\/p>\\n<p>&nbsp;&nbsp;&nbsp;&nbsp;\\\"merchant_key\\\": \\\"xxxxx-xxxxx-xxxxx\\\",<\\\/p>\\n<p>&nbsp;&nbsp;&nbsp;&nbsp;\\\"operation\\\": \\\"purchase\\\",<\\\/p>\\n<p>&nbsp;&nbsp;&nbsp;&nbsp;\\\"methods\\\": [<\\\/p>\\n<p>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;\\\"card\\\"<\\\/p>\\n<p>&nbsp;&nbsp;&nbsp;&nbsp;],<\\\/p>\\n<p>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;\\\"parameters\\\": {<\\\/p>\\n<p>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;\\\"card\\\": {<\\\/p>\\n<p>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;\\\"descriptor\\\": \\\"Testy International LTD\\\"<\\\/p>\\n<p>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;}<\\\/p>\\n<p>&nbsp;&nbsp;&nbsp;&nbsp;},&nbsp;&nbsp;&nbsp;<\\\/p>\\n<p>&nbsp;&nbsp;&nbsp;&nbsp;\\\"order\\\": {<\\\/p>\\n<p>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;\\\"number\\\": \\\"order-1234\\\",<\\\/p>\\n<p>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;\\\"amount\\\": \\\"1000.19\\\",<\\\/p>\\n<p>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;\\\"currency\\\": \\\"BRL\\\",<\\\/p>\\n<p>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;\\\"description\\\": \\\"Important gift\\\"<\\\/p>\\n<p>&nbsp;&nbsp;&nbsp;&nbsp;},<\\\/p>\\n<p>&nbsp;&nbsp;&nbsp;&nbsp;\\\"cancel_url\\\": \\\"https:\\\/\\\/example.com\\\/cancel\\\",<\\\/p>\\n<p>&nbsp;&nbsp;&nbsp;&nbsp;\\\"success_url\\\": \\\"https:\\\/\\\/example.com\\\/success\\\",<\\\/p>\\n<p>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;\\\"customer\\\": {<\\\/p>\\n<p>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;\\\"name\\\": \\\"John Doe\\\",<\\\/p>\\n<p>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;\\\"email\\\": \\\"test@gmail.com\\\"<\\\/p>\\n<p>&nbsp;&nbsp;&nbsp;&nbsp;},<\\\/p>\\n<p>&nbsp;&nbsp;&nbsp;&nbsp;\\\"billing_address\\\": {<\\\/p>\\n<p>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;\\\"country\\\": \\\"US\\\",<\\\/p>\\n<p>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;\\\"state\\\": \\\"CA\\\",<\\\/p>\\n<p>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;\\\"city\\\": \\\"Los Angeles\\\",<\\\/p>\\n<p>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;\\\"address\\\": \\\"Moor Building 35274\\\",<\\\/p>\\n<p>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;\\\"zip\\\": \\\"123456\\\",<\\\/p>\\n<p>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;\\\"phone\\\": \\\"347771112233\\\"<\\\/p>\\n<p>&nbsp;&nbsp;&nbsp;&nbsp;},<\\\/p>\\n<p>&nbsp;&nbsp;&nbsp;&nbsp;\\\"hash\\\": \\\"{{session_hash}}\\\",<\\\/p>\\n<p>}<\\\/p>\\n<p>'<\\\/p>\\n\"}}]}<\/script>    <\/div>\n<\/div>\n\n\n\n<h4 class=\"wp-block-heading\" id=\"additional-parameters---set-4-twd\">Additional parameters &#8211; set 4 TWD<\/h4>\n\n\n\n<figure class=\"wp-block-table\"><table><thead><tr><th><strong>Parameter<\/strong><\/th><th><strong>Type<\/strong><\/th><th><strong>Mandatory<\/strong><\/th><th><strong>Description<\/strong><\/th><\/tr><\/thead><tbody><tr><td><code>customer_phone<\/code><\/td><td><em>String<\/em><\/td><td>Optional<\/td><td>Phone number of the customer.<\/td><\/tr><tr><td><code>customer_telnocc<\/code><\/td><td><em>String<\/em><\/td><td>Optional<\/td><td>Country phone code of the customer.<\/td><\/tr><tr><td><code>shipping_street1<\/code><\/td><td><em>String<\/em><\/td><td>Optional<\/td><td>Building name, and\/or street name of the customer&#8217;s shipping address.<\/td><\/tr><tr><td><code>shipping_city<\/code><\/td><td><em>String<\/em><\/td><td>Optional<\/td><td>City of the customer&#8217;s shipping address.<\/td><\/tr><tr><td><code>shipping_state<\/code><\/td><td><em>String<\/em><\/td><td>Optional<\/td><td>State or region of the customer&#8217;s shipping address.<\/td><\/tr><tr><td><code>shipping_postcode<\/code><\/td><td><em>String<\/em><\/td><td>Optional<\/td><td>Postal code\/ Zip code of the customer&#8217;s shipping address.<br>Max \u2013 9 digits.<\/td><\/tr><tr><td><code>shipping_country<\/code><\/td><td><em>String<\/em><\/td><td>Optional<\/td><td>Country of the shipping address.<br>3-digits code<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n<div\n    class=\"betterdocs-faq-wrapper layout-classic icon-before betterdocs-faq-layout-2 betterdocs-faq-lcdv0jx betterdocs-shortcode\">\n    <h2 class=\"betterdocs-faq-layout-2 betterdocs-faq-lcdv0jx betterdocs-faq-section-title\">\n            <\/h2>\n\n    <div class=\"betterdocs-faq-inner-wrapper\">\n        <div class=\"betterdocs-faq-title\">\n    <h2>Additional parameters &#8211; set 4 TWD &#8211; Authentication<\/h2>\n<\/div>\n<ul class=\"betterdocs-faq-list\"><li><div class=\"betterdocs-faq-group\"><div class=\"betterdocs-faq-post\">\n    <div class=\"betterdocs-faq-post-icon-group\"><svg class=\"betterdocs-faq-iconplus\" xmlns=\"http:\/\/www.w3.org\/2000\/svg\" viewbox=\"0 0 24 24\"><path fill=\"#000000\" d=\"M18 10h-4V6h-4v4H6v4h4v4h4v-4h4\"><\/path><\/svg><svg class=\"betterdocs-faq-iconminus\" xmlns=\"http:\/\/www.w3.org\/2000\/svg\" viewbox=\"0 0 24 24\"><path fill=\"#000000\" d=\"M6 10h12v4H6z\"><\/path><\/svg><\/div>    <span class=\"betterdocs-faq-post-name\">\n        Authentication request example    <\/span>\n    <\/div>\n<div class=\"betterdocs-faq-main-content\">\n    <p>curl &#8211;location -g &#8211;request POST &#8216;{{CHECKOUT_HOST}}\/api\/v1\/session&#8217; <\/p>\n<p>&#8211;header &#8216;Content-Type: application\/json&#8217; <\/p>\n<p>&#8211;data-raw &#8216;{<\/p>\n<p>&nbsp;&nbsp;&#8220;merchant_key&#8221;: &#8220;xxxxx-xxxxx-xxxxx&#8221;,<\/p>\n<p>&nbsp;&nbsp;&#8220;operation&#8221;: &#8220;purchase&#8221;,<\/p>\n<p>&nbsp;&nbsp;&#8220;methods&#8221;: [<\/p>\n<p>&nbsp;&nbsp;&nbsp;&nbsp;&#8220;card&#8221;<\/p>\n<p>&nbsp;&nbsp;],<\/p>\n<p>&nbsp;&nbsp;&#8220;parameters&#8221;: {<\/p>\n<p>&nbsp;&nbsp;&nbsp;&nbsp;&#8220;card&#8221;: {<\/p>\n<p>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&#8220;customer_phone&#8221;: &#8220;1234567890&#8221;,<\/p>\n<p>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&#8220;customer_telnocc &#8220;: &#8220;123&#8221;,<\/p>\n<p>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&#8220;shipping_street1&#8243;: &#8221; Moor Building 35274&#8243;,<\/p>\n<p>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&#8220;shipping_ city&#8221;: &#8220;Los Angeles&#8221;,<\/p>\n<p>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&#8220;shipping_state&#8221;: &#8220;CA&#8221;,<\/p>\n<p>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&#8220;shipping_postcode&#8221;: &#8220;809654321&#8221;,<\/p>\n<p>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&#8220;shipping_ country&#8221;: &#8220;US&#8221;<\/p>\n<p>&nbsp;&nbsp;&nbsp;&nbsp;}<\/p>\n<p>&nbsp;&nbsp;},<\/p>\n<p>&nbsp;&nbsp;&#8220;order&#8221;: {<\/p>\n<p>&nbsp;&nbsp;&nbsp;&nbsp;&#8220;number&#8221;: &#8220;order-1234&#8221;,<\/p>\n<p>&nbsp;&nbsp;&nbsp;&nbsp;&#8220;amount&#8221;: &#8220;1000.19&#8221;,<\/p>\n<p>&nbsp;&nbsp;&nbsp;&nbsp;&#8220;currency&#8221;: &#8220;USD&#8221;,<\/p>\n<p>&nbsp;&nbsp;&nbsp;&nbsp;&#8220;description&#8221;: &#8220;Important gift&#8221;<\/p>\n<p>&nbsp;&nbsp;},<\/p>\n<p>&nbsp;&nbsp;&#8220;cancel_url&#8221;: &#8220;https:\/\/example.com\/cancel&#8221;,<\/p>\n<p>&nbsp;&nbsp;&#8220;success_url&#8221;: &#8220;https:\/\/example.com\/success&#8221;,<\/p>\n<p>&nbsp;&nbsp;&#8220;customer&#8221;: {<\/p>\n<p>&nbsp;&nbsp;&nbsp;&nbsp;&#8220;name&#8221;: &#8220;John Doe&#8221;,<\/p>\n<p>&nbsp;&nbsp;&nbsp;&nbsp;&#8220;email&#8221;: &#8220;test@gmail.com&#8221;<\/p>\n<p>&nbsp;&nbsp;},<\/p>\n<p>&nbsp;&nbsp;&#8220;billing_address&#8221;: {<\/p>\n<p>&nbsp;&nbsp;&nbsp;&nbsp;&#8220;country&#8221;: &#8220;US&#8221;,<\/p>\n<p>&nbsp;&nbsp;&nbsp;&nbsp;&#8220;state&#8221;: &#8220;CA&#8221;,<\/p>\n<p>&nbsp;&nbsp;&nbsp;&nbsp;&#8220;city&#8221;: &#8220;Los Angeles&#8221;,<\/p>\n<p>&nbsp;&nbsp;&nbsp;&nbsp;&#8220;address&#8221;: &#8220;Moor Building 35274&#8221;,<\/p>\n<p>&nbsp;&nbsp;&nbsp;&nbsp;&#8220;zip&#8221;: &#8220;123456&#8221;,<\/p>\n<p>&nbsp;&nbsp;&nbsp;&nbsp;&#8220;phone&#8221;: &#8220;347771112233&#8221;<\/p>\n<p>&nbsp;&nbsp;},<\/p>\n<p>&nbsp;&nbsp;&#8220;hash&#8221;: &#8220;{{session_hash}}&#8221;<\/p>\n<p>}<\/p>\n<p>&#8216;<\/p>\n<\/div>\n<\/div><\/li><\/ul><script type=\"application\/ld+json\">{\"@context\":\"https:\\\/\\\/schema.org\",\"@type\":\"FAQPage\",\"mainEntity\":[{\"@type\":\"Question\",\"name\":\"Authentication request example\",\"acceptedAnswer\":{\"@type\":\"Answer\",\"text\":\"<p>curl --location -g --request POST '{{CHECKOUT_HOST}}\\\/api\\\/v1\\\/session' <\\\/p>\\n<p>--header 'Content-Type: application\\\/json' <\\\/p>\\n<p>--data-raw '{<\\\/p>\\n<p>&nbsp;&nbsp;\\\"merchant_key\\\": \\\"xxxxx-xxxxx-xxxxx\\\",<\\\/p>\\n<p>&nbsp;&nbsp;\\\"operation\\\": \\\"purchase\\\",<\\\/p>\\n<p>&nbsp;&nbsp;\\\"methods\\\": [<\\\/p>\\n<p>&nbsp;&nbsp;&nbsp;&nbsp;\\\"card\\\"<\\\/p>\\n<p>&nbsp;&nbsp;],<\\\/p>\\n<p>&nbsp;&nbsp;\\\"parameters\\\": {<\\\/p>\\n<p>&nbsp;&nbsp;&nbsp;&nbsp;\\\"card\\\": {<\\\/p>\\n<p>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;\\\"customer_phone\\\": \\\"1234567890\\\",<\\\/p>\\n<p>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;\\\"customer_telnocc \\\": \\\"123\\\",<\\\/p>\\n<p>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;\\\"shipping_street1\\\": \\\" Moor Building 35274\\\",<\\\/p>\\n<p>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;\\\"shipping_ city\\\": \\\"Los Angeles\\\",<\\\/p>\\n<p>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;\\\"shipping_state\\\": \\\"CA\\\",<\\\/p>\\n<p>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;\\\"shipping_postcode\\\": \\\"809654321\\\",<\\\/p>\\n<p>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;\\\"shipping_ country\\\": \\\"US\\\"<\\\/p>\\n<p>&nbsp;&nbsp;&nbsp;&nbsp;}<\\\/p>\\n<p>&nbsp;&nbsp;},<\\\/p>\\n<p>&nbsp;&nbsp;\\\"order\\\": {<\\\/p>\\n<p>&nbsp;&nbsp;&nbsp;&nbsp;\\\"number\\\": \\\"order-1234\\\",<\\\/p>\\n<p>&nbsp;&nbsp;&nbsp;&nbsp;\\\"amount\\\": \\\"1000.19\\\",<\\\/p>\\n<p>&nbsp;&nbsp;&nbsp;&nbsp;\\\"currency\\\": \\\"USD\\\",<\\\/p>\\n<p>&nbsp;&nbsp;&nbsp;&nbsp;\\\"description\\\": \\\"Important gift\\\"<\\\/p>\\n<p>&nbsp;&nbsp;},<\\\/p>\\n<p>&nbsp;&nbsp;\\\"cancel_url\\\": \\\"https:\\\/\\\/example.com\\\/cancel\\\",<\\\/p>\\n<p>&nbsp;&nbsp;\\\"success_url\\\": \\\"https:\\\/\\\/example.com\\\/success\\\",<\\\/p>\\n<p>&nbsp;&nbsp;\\\"customer\\\": {<\\\/p>\\n<p>&nbsp;&nbsp;&nbsp;&nbsp;\\\"name\\\": \\\"John Doe\\\",<\\\/p>\\n<p>&nbsp;&nbsp;&nbsp;&nbsp;\\\"email\\\": \\\"test@gmail.com\\\"<\\\/p>\\n<p>&nbsp;&nbsp;},<\\\/p>\\n<p>&nbsp;&nbsp;\\\"billing_address\\\": {<\\\/p>\\n<p>&nbsp;&nbsp;&nbsp;&nbsp;\\\"country\\\": \\\"US\\\",<\\\/p>\\n<p>&nbsp;&nbsp;&nbsp;&nbsp;\\\"state\\\": \\\"CA\\\",<\\\/p>\\n<p>&nbsp;&nbsp;&nbsp;&nbsp;\\\"city\\\": \\\"Los Angeles\\\",<\\\/p>\\n<p>&nbsp;&nbsp;&nbsp;&nbsp;\\\"address\\\": \\\"Moor Building 35274\\\",<\\\/p>\\n<p>&nbsp;&nbsp;&nbsp;&nbsp;\\\"zip\\\": \\\"123456\\\",<\\\/p>\\n<p>&nbsp;&nbsp;&nbsp;&nbsp;\\\"phone\\\": \\\"347771112233\\\"<\\\/p>\\n<p>&nbsp;&nbsp;},<\\\/p>\\n<p>&nbsp;&nbsp;\\\"hash\\\": \\\"{{session_hash}}\\\"<\\\/p>\\n<p>}<\\\/p>\\n<p>'<\\\/p>\\n\"}}]}<\/script>    <\/div>\n<\/div>\n\n\n\n<h4 class=\"wp-block-heading\" id=\"additional-parameters---set-5-ers\">Additional parameters &#8211; Set 5 (ERS)<\/h4>\n\n\n\n<p>This set should be used for debit operation.<\/p>\n\n\n\n<figure class=\"wp-block-table\"><table><thead><tr><th>Parameter<\/th><th>Type<\/th><th>Mandatory<\/th><th>Description<\/th><\/tr><\/thead><tbody><tr><td><code>payer_identity_type<\/code><\/td><td><em>String<\/em><\/td><td>Optional<\/td><td>The type of Senders identification document<\/td><\/tr><tr><td><code>payer_identity_id<\/code><\/td><td><em>String<\/em><\/td><td>Optional<\/td><td>The number of Senders identification document<\/td><\/tr><tr><td><code>payer_identity_country<\/code><\/td><td><em>String<\/em><\/td><td>Optional<\/td><td>The country of issuance of the Senders identification document<\/td><\/tr><tr><td><code>payer_identity_exp_date<\/code><\/td><td><em>String<\/em><\/td><td>Optional<\/td><td>The expiration date of the Senders identification document<\/td><\/tr><tr><td><code>payer_nationality<\/code><\/td><td><em>String<\/em><\/td><td>Optional<\/td><td>Senders nationality<\/td><\/tr><tr><td><code>payer_country_of_birth<\/code><\/td><td><em>String<\/em><\/td><td>Optional<\/td><td>Senders country of birth<\/td><\/tr><tr><td><code>payee_first_name<\/code><\/td><td><em>String<\/em><\/td><td>Optional<\/td><td>Receivers first name<\/td><\/tr><tr><td><code>payer_last_name<\/code><\/td><td><em>String<\/em><\/td><td>Optional<\/td><td>Receivers last name<\/td><\/tr><tr><td><code>payee_middle_name<\/code><\/td><td><em>String<\/em><\/td><td>Optional<\/td><td>Receivers middle name<\/td><\/tr><tr><td><code>payee_address<\/code><\/td><td><em>String<\/em><\/td><td>Optional<\/td><td>Receivers street<\/td><\/tr><tr><td><code>payee_city<\/code><\/td><td><em>String<\/em><\/td><td>Optional<\/td><td>Receivers city<\/td><\/tr><tr><td><code>payee_state<\/code><\/td><td><em>String<\/em><\/td><td>Optional<\/td><td>Receivers state<\/td><\/tr><tr><td><code>payee_country<\/code><\/td><td><em>String<\/em><\/td><td>Optional<\/td><td>Receivers country<\/td><\/tr><tr><td><code>payee_zip<\/code><\/td><td><em>String<\/em><\/td><td>Optional<\/td><td>Receivers postal code<\/td><\/tr><tr><td><code>payee_phone<\/code><\/td><td><em>String<\/em><\/td><td>Optional<\/td><td>Receivers phone number<\/td><\/tr><tr><td><code>payee_birth_date<\/code><\/td><td><em>String<\/em><\/td><td>Optional<\/td><td>Receivers date of birth<\/td><\/tr><tr><td><code>payee_identity_type<\/code><\/td><td><em>String<\/em><\/td><td>Optional<\/td><td>The type of Receivers identification document<\/td><\/tr><tr><td><code>payee_identity_id<\/code><\/td><td><em>String<\/em><\/td><td>Optional<\/td><td>The number of Receivers identification document<\/td><\/tr><tr><td><code>payee_identity_country<\/code><\/td><td><em>String<\/em><\/td><td>Optional<\/td><td>The country of issuance of Receivers identification document<\/td><\/tr><tr><td><code>payee_identity_exp_date<\/code><\/td><td><em>String<\/em><\/td><td>Optional<\/td><td>The expiration date of Receivers identification document<\/td><\/tr><tr><td><code>payee_nationality<\/code><\/td><td><em>String<\/em><\/td><td>Optional<\/td><td>Receivers nationality<\/td><\/tr><tr><td><code>payee_country_of_birth<\/code><\/td><td><em>String<\/em><\/td><td>Optional<\/td><td>Receivers country of birth<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n<div\n    class=\"betterdocs-faq-wrapper layout-classic icon-before betterdocs-faq-layout-2 betterdocs-faq-kjdo7hs betterdocs-shortcode\">\n    <h2 class=\"betterdocs-faq-layout-2 betterdocs-faq-kjdo7hs betterdocs-faq-section-title\">\n            <\/h2>\n\n    <div class=\"betterdocs-faq-inner-wrapper\">\n        <div class=\"betterdocs-faq-title\">\n    <h2>Additional parameters &#8211; Set 5 (ERS) &#8211; Authentication<\/h2>\n<\/div>\n<ul class=\"betterdocs-faq-list\"><li><div class=\"betterdocs-faq-group\"><div class=\"betterdocs-faq-post\">\n    <div class=\"betterdocs-faq-post-icon-group\"><svg class=\"betterdocs-faq-iconplus\" xmlns=\"http:\/\/www.w3.org\/2000\/svg\" viewbox=\"0 0 24 24\"><path fill=\"#000000\" d=\"M18 10h-4V6h-4v4H6v4h4v4h4v-4h4\"><\/path><\/svg><svg class=\"betterdocs-faq-iconminus\" xmlns=\"http:\/\/www.w3.org\/2000\/svg\" viewbox=\"0 0 24 24\"><path fill=\"#000000\" d=\"M6 10h12v4H6z\"><\/path><\/svg><\/div>    <span class=\"betterdocs-faq-post-name\">\n        Authentication request example    <\/span>\n    <\/div>\n<div class=\"betterdocs-faq-main-content\">\n    <p>curl &#8211;location -g &#8211;request POST &#8216;{{CHECKOUT_HOST}}\/api\/v1\/session&#8217; <\/p>\n<p>&#8211;header &#8216;Content-Type: application\/json&#8217; <\/p>\n<p>&#8211;data-raw &#8216;{<\/p>\n<p>&nbsp;&nbsp;&#8220;merchant_key&#8221;: &#8220;xxxxx-xxxxx-xxxxx&#8221;,<\/p>\n<p>&nbsp;&nbsp;&#8220;operation&#8221;: &#8220;purchase&#8221;,<\/p>\n<p>&nbsp;&nbsp;&#8220;methods&#8221;: [<\/p>\n<p>&nbsp;&nbsp;&nbsp;&nbsp;&#8220;card&#8221;<\/p>\n<p>&nbsp;&nbsp;],<\/p>\n<p>&nbsp;&nbsp;&#8220;parameters&#8221;: {<\/p>\n<p>&nbsp;&nbsp;&nbsp;&nbsp;&#8220;card&#8221;: {<\/p>\n<p>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&#8220;payer_identity_type&#8221;: &#8220;Passport&#8221;,<\/p>\n<p>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&#8220;payer_identity_id&#8221;: &#8220;ABC123456&#8221;,<\/p>\n<p>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&#8220;payer_identity_country&#8221;: &#8220;KZ&#8221;,<\/p>\n<p>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&#8220;payer_identity_exp_date&#8221;: &#8220;2026-05-15&#8221;,<\/p>\n<p>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&#8220;payer_nationality&#8221;: &#8220;Kazakhstani&#8221;,<\/p>\n<p>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&#8220;payer_country_of_birth&#8221;: &#8220;Kazakhstan&#8221;,<\/p>\n<p>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&#8220;payee_first_name&#8221;: &#8220;John&#8221;,<\/p>\n<p>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&#8220;payer_last_name&#8221;: &#8220;Doe&#8221;,<\/p>\n<p>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&#8220;payee_middle_name&#8221;: &#8220;Smith&#8221;,<\/p>\n<p>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&#8220;payee_address&#8221;: &#8220;123 Main Street&#8221;,<\/p>\n<p>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&#8220;payee_city&#8221;: &#8220;Almaty&#8221;,<\/p>\n<p>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&#8220;payee_state&#8221;: &#8220;Almaty Province&#8221;,<\/p>\n<p>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&#8220;payee_country&#8221;: &#8220;Kazakhstan&#8221;,<\/p>\n<p>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&#8220;payee_zip&#8221;: &#8220;050000&#8221;,<\/p>\n<p>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&#8220;payee_phone&#8221;: &#8220;77123456789&#8221;,<\/p>\n<p>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&#8220;payee_birth_date&#8221;: &#8220;1990-01-01&#8221;,<\/p>\n<p>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&#8220;payee_identity_type&#8221;: &#8220;National ID&#8221;,<\/p>\n<p>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&#8220;payee_identity_id&#8221;: &#8220;XYZ987654&#8221;,<\/p>\n<p>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&#8220;payee_identity_country&#8221;: &#8220;Kazakhstan&#8221;,<\/p>\n<p>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&#8220;payee_identity_exp_date&#8221;: &#8220;2030-12-31&#8221;,<\/p>\n<p>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&#8220;payee_nationality&#8221;: &#8220;Kazakhstani&#8221;,<\/p>\n<p>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&#8220;payee_country_of_birth&#8221;: &#8220;Kazakhstan&#8221;<\/p>\n<p>&nbsp;&nbsp;&nbsp;&nbsp;}<\/p>\n<p>&nbsp;&nbsp;},<\/p>\n<p>&nbsp;&nbsp;&#8220;order&#8221;: {<\/p>\n<p>&nbsp;&nbsp;&nbsp;&nbsp;&#8220;number&#8221;: &#8220;order-1234&#8221;,<\/p>\n<p>&nbsp;&nbsp;&nbsp;&nbsp;&#8220;amount&#8221;: &#8220;1000.19&#8221;,<\/p>\n<p>&nbsp;&nbsp;&nbsp;&nbsp;&#8220;currency&#8221;: &#8220;USD&#8221;,<\/p>\n<p>&nbsp;&nbsp;&nbsp;&nbsp;&#8220;description&#8221;: &#8220;Important gift&#8221;<\/p>\n<p>&nbsp;&nbsp;},<\/p>\n<p>&nbsp;&nbsp;&#8220;cancel_url&#8221;: &#8220;https:\/\/example.com\/cancel&#8221;,<\/p>\n<p>&nbsp;&nbsp;&#8220;success_url&#8221;: &#8220;https:\/\/example.com\/success&#8221;,<\/p>\n<p>&nbsp;&nbsp;&#8220;customer&#8221;: {<\/p>\n<p>&nbsp;&nbsp;&nbsp;&nbsp;&#8220;name&#8221;: &#8220;John Doe&#8221;,<\/p>\n<p>&nbsp;&nbsp;&nbsp;&nbsp;&#8220;email&#8221;: &#8220;test@gmail.com&#8221;<\/p>\n<p>&nbsp;&nbsp;},<\/p>\n<p>&nbsp;&nbsp;&#8220;billing_address&#8221;: {<\/p>\n<p>&nbsp;&nbsp;&nbsp;&nbsp;&#8220;country&#8221;: &#8220;US&#8221;,<\/p>\n<p>&nbsp;&nbsp;&nbsp;&nbsp;&#8220;state&#8221;: &#8220;CA&#8221;,<\/p>\n<p>&nbsp;&nbsp;&nbsp;&nbsp;&#8220;city&#8221;: &#8220;Los Angeles&#8221;,<\/p>\n<p>&nbsp;&nbsp;&nbsp;&nbsp;&#8220;address&#8221;: &#8220;Moor Building 35274&#8221;,<\/p>\n<p>&nbsp;&nbsp;&nbsp;&nbsp;&#8220;zip&#8221;: &#8220;123456&#8221;,<\/p>\n<p>&nbsp;&nbsp;&nbsp;&nbsp;&#8220;phone&#8221;: &#8220;347771112233&#8221;<\/p>\n<p>&nbsp;&nbsp;},<\/p>\n<p>&nbsp;&nbsp;&#8220;hash&#8221;: &#8220;{{session_hash}}&#8221;<\/p>\n<p>}<\/p>\n<p>&#8216;<\/p>\n<\/div>\n<\/div><\/li><\/ul><script type=\"application\/ld+json\">{\"@context\":\"https:\\\/\\\/schema.org\",\"@type\":\"FAQPage\",\"mainEntity\":[{\"@type\":\"Question\",\"name\":\"Authentication request example\",\"acceptedAnswer\":{\"@type\":\"Answer\",\"text\":\"<p>curl --location -g --request POST '{{CHECKOUT_HOST}}\\\/api\\\/v1\\\/session' <\\\/p>\\n<p>--header 'Content-Type: application\\\/json' <\\\/p>\\n<p>--data-raw '{<\\\/p>\\n<p>&nbsp;&nbsp;\\\"merchant_key\\\": \\\"xxxxx-xxxxx-xxxxx\\\",<\\\/p>\\n<p>&nbsp;&nbsp;\\\"operation\\\": \\\"purchase\\\",<\\\/p>\\n<p>&nbsp;&nbsp;\\\"methods\\\": [<\\\/p>\\n<p>&nbsp;&nbsp;&nbsp;&nbsp;\\\"card\\\"<\\\/p>\\n<p>&nbsp;&nbsp;],<\\\/p>\\n<p>&nbsp;&nbsp;\\\"parameters\\\": {<\\\/p>\\n<p>&nbsp;&nbsp;&nbsp;&nbsp;\\\"card\\\": {<\\\/p>\\n<p>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;\\\"payer_identity_type\\\": \\\"Passport\\\",<\\\/p>\\n<p>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;\\\"payer_identity_id\\\": \\\"ABC123456\\\",<\\\/p>\\n<p>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;\\\"payer_identity_country\\\": \\\"KZ\\\",<\\\/p>\\n<p>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;\\\"payer_identity_exp_date\\\": \\\"2026-05-15\\\",<\\\/p>\\n<p>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;\\\"payer_nationality\\\": \\\"Kazakhstani\\\",<\\\/p>\\n<p>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;\\\"payer_country_of_birth\\\": \\\"Kazakhstan\\\",<\\\/p>\\n<p>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;\\\"payee_first_name\\\": \\\"John\\\",<\\\/p>\\n<p>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;\\\"payer_last_name\\\": \\\"Doe\\\",<\\\/p>\\n<p>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;\\\"payee_middle_name\\\": \\\"Smith\\\",<\\\/p>\\n<p>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;\\\"payee_address\\\": \\\"123 Main Street\\\",<\\\/p>\\n<p>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;\\\"payee_city\\\": \\\"Almaty\\\",<\\\/p>\\n<p>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;\\\"payee_state\\\": \\\"Almaty Province\\\",<\\\/p>\\n<p>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;\\\"payee_country\\\": \\\"Kazakhstan\\\",<\\\/p>\\n<p>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;\\\"payee_zip\\\": \\\"050000\\\",<\\\/p>\\n<p>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;\\\"payee_phone\\\": \\\"77123456789\\\",<\\\/p>\\n<p>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;\\\"payee_birth_date\\\": \\\"1990-01-01\\\",<\\\/p>\\n<p>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;\\\"payee_identity_type\\\": \\\"National ID\\\",<\\\/p>\\n<p>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;\\\"payee_identity_id\\\": \\\"XYZ987654\\\",<\\\/p>\\n<p>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;\\\"payee_identity_country\\\": \\\"Kazakhstan\\\",<\\\/p>\\n<p>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;\\\"payee_identity_exp_date\\\": \\\"2030-12-31\\\",<\\\/p>\\n<p>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;\\\"payee_nationality\\\": \\\"Kazakhstani\\\",<\\\/p>\\n<p>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;\\\"payee_country_of_birth\\\": \\\"Kazakhstan\\\"<\\\/p>\\n<p>&nbsp;&nbsp;&nbsp;&nbsp;}<\\\/p>\\n<p>&nbsp;&nbsp;},<\\\/p>\\n<p>&nbsp;&nbsp;\\\"order\\\": {<\\\/p>\\n<p>&nbsp;&nbsp;&nbsp;&nbsp;\\\"number\\\": \\\"order-1234\\\",<\\\/p>\\n<p>&nbsp;&nbsp;&nbsp;&nbsp;\\\"amount\\\": \\\"1000.19\\\",<\\\/p>\\n<p>&nbsp;&nbsp;&nbsp;&nbsp;\\\"currency\\\": \\\"USD\\\",<\\\/p>\\n<p>&nbsp;&nbsp;&nbsp;&nbsp;\\\"description\\\": \\\"Important gift\\\"<\\\/p>\\n<p>&nbsp;&nbsp;},<\\\/p>\\n<p>&nbsp;&nbsp;\\\"cancel_url\\\": \\\"https:\\\/\\\/example.com\\\/cancel\\\",<\\\/p>\\n<p>&nbsp;&nbsp;\\\"success_url\\\": \\\"https:\\\/\\\/example.com\\\/success\\\",<\\\/p>\\n<p>&nbsp;&nbsp;\\\"customer\\\": {<\\\/p>\\n<p>&nbsp;&nbsp;&nbsp;&nbsp;\\\"name\\\": \\\"John Doe\\\",<\\\/p>\\n<p>&nbsp;&nbsp;&nbsp;&nbsp;\\\"email\\\": \\\"test@gmail.com\\\"<\\\/p>\\n<p>&nbsp;&nbsp;},<\\\/p>\\n<p>&nbsp;&nbsp;\\\"billing_address\\\": {<\\\/p>\\n<p>&nbsp;&nbsp;&nbsp;&nbsp;\\\"country\\\": \\\"US\\\",<\\\/p>\\n<p>&nbsp;&nbsp;&nbsp;&nbsp;\\\"state\\\": \\\"CA\\\",<\\\/p>\\n<p>&nbsp;&nbsp;&nbsp;&nbsp;\\\"city\\\": \\\"Los Angeles\\\",<\\\/p>\\n<p>&nbsp;&nbsp;&nbsp;&nbsp;\\\"address\\\": \\\"Moor Building 35274\\\",<\\\/p>\\n<p>&nbsp;&nbsp;&nbsp;&nbsp;\\\"zip\\\": \\\"123456\\\",<\\\/p>\\n<p>&nbsp;&nbsp;&nbsp;&nbsp;\\\"phone\\\": \\\"347771112233\\\"<\\\/p>\\n<p>&nbsp;&nbsp;},<\\\/p>\\n<p>&nbsp;&nbsp;\\\"hash\\\": \\\"{{session_hash}}\\\"<\\\/p>\\n<p>}<\\\/p>\\n<p>'<\\\/p>\\n\"}}]}<\/script>    <\/div>\n<\/div>\n\n\n\n<h3 class=\"wp-block-heading\" id=\"apple-pay\">Apple Pay<\/h3>\n\n\n\n<p>payment_method = <code>applepay<\/code><\/p>\n\n\n\n<p>To use <code>applepay<\/code> payment method, you should configure the Wallets setting in the admin dashboard. Make sure that the payment provider has confirmed the Apple Pay certificates and your domain, which has been verified in the Apple Pay account.<\/p>\n\n\n\n<p>To provide the payers with the possibility of Apple Pay payments you can connect to the Checkout or work directly via S2S VPG protocol.<\/p>\n\n\n\n<p>If you work via Checkout page you don\u2019t need any additional development on your side.<\/p>\n\n\n\n<p>If you work via S2S VPG protocol, you must pass you must be able to obtain Apple Pay payment token that must be passed in the SALE request.<\/p>\n\n\n\n<p>Regardless of the protocol you have to make settings in the admin panel and set the following configurations:<\/p>\n\n\n\n<p>\u2022 Merchant Identifier, Country and Shop Name \u2013 according to the merchant\u2019s data from <a href=\"https:\/\/idmsa.apple.com\/IDMSWebAuth\/signin?appIdKey=891bd3417a7776362562d2197f89480a8547b108fd934911bcbea0110d07f757&amp;path=%2Faccount%2Fresources%2Fidentifiers%2Flist%2Fmerchant&amp;rv=1\" target=\"_blank\" rel=\"noreferrer noopener\"><ins>Apple Pay Developper account<\/ins><\/a><br>\u2022 Certificate and Private Key \u2013 generated Apple Pay certificate and private key<br>\u2022 Merchant Capabilities and Supported Networks \u2013 configurations for Apple Pay payments<br>\u2022 Processing Private Key \u2013 private key that uses for payment token decryption (requires if payment provider supports).<\/p>\n\n\n\n<p>\u26a0\ufe0f <strong>Pay attention<\/strong><\/p>\n\n\n\n<blockquote class=\"wp-block-quote is-layout-flow wp-block-quote-is-layout-flow\">\n<p><em>Before using Apple Pay via S2S VPG protocol, you should review next section carefully.<\/em><br><em>There is a description on how you can obtain Apple Pay payment token (it refers to the official <a href=\"https:\/\/developer.apple.com\/documentation\/apple_pay_on_the_web\" target=\"_blank\" rel=\"noreferrer noopener\"><ins>Apple Pay documentation<\/ins><\/a>)<\/em><\/p>\n<\/blockquote>\n\n\n\n<ol>\n<li>Each payment must be checked for <a href=\"https:\/\/developer.apple.com\/documentation\/apple_pay_on_the_web\/apple_pay_js_api\/checking_for_apple_pay_availability\" target=\"_blank\" rel=\"noreferrer noopener\"><ins>Apple Pay accessibility<\/ins><\/a><\/li>\n\n\n\n<li><a href=\"https:\/\/developer.apple.com\/documentation\/apple_pay_on_the_web\/displaying_apple_pay_buttons_using_css\" target=\"_blank\" rel=\"noreferrer noopener\"><ins>Show Apple Pay button<\/ins><\/a> to your payers<\/li>\n\n\n\n<li><a href=\"https:\/\/developer.apple.com\/documentation\/apple_pay_on_the_web\/apple_pay_js_api\/requesting_an_apple_pay_payment_session\" target=\"_blank\" rel=\"noreferrer noopener\"><ins>Validate the merchant<\/ins><\/a> identity<\/li>\n\n\n\n<li>Provide a payment request and <a href=\"https:\/\/developer.apple.com\/documentation\/apple_pay_on_the_web\/apple_pay_js_api\/creating_an_apple_pay_session\" target=\"_blank\" rel=\"noreferrer noopener\"><ins>create a session<\/ins><\/a><\/li>\n\n\n\n<li>Receive Apple Pay payment token (paymentData object)<\/li>\n<\/ol>\n\n\n\n<p>After you implement Apple Pay payment tokens generation on your site, you need to pass for the SALE request:<\/p>\n\n\n\n<p>\u2022 <code>brand<\/code> = applepay<br>\u2022 <code>parameters[paymentToken]<\/code> &#8211; Apple Pay payment token<\/p>\n\n\n<div\n    class=\"betterdocs-faq-wrapper layout-classic icon-before betterdocs-faq-layout-2 betterdocs-faq-jt6k9e1 betterdocs-shortcode\">\n    <h2 class=\"betterdocs-faq-layout-2 betterdocs-faq-jt6k9e1 betterdocs-faq-section-title\">\n            <\/h2>\n\n    <div class=\"betterdocs-faq-inner-wrapper\">\n        <div class=\"betterdocs-faq-title\">\n    <h2>Apple Pay Request Example<\/h2>\n<\/div>\n<ul class=\"betterdocs-faq-list\"><li><div class=\"betterdocs-faq-group\"><div class=\"betterdocs-faq-post\">\n    <div class=\"betterdocs-faq-post-icon-group\"><svg class=\"betterdocs-faq-iconplus\" xmlns=\"http:\/\/www.w3.org\/2000\/svg\" viewbox=\"0 0 24 24\"><path fill=\"#000000\" d=\"M18 10h-4V6h-4v4H6v4h4v4h4v-4h4\"><\/path><\/svg><svg class=\"betterdocs-faq-iconminus\" xmlns=\"http:\/\/www.w3.org\/2000\/svg\" viewbox=\"0 0 24 24\"><path fill=\"#000000\" d=\"M6 10h12v4H6z\"><\/path><\/svg><\/div>    <span class=\"betterdocs-faq-post-name\">\n        Request example    <\/span>\n    <\/div>\n<div class=\"betterdocs-faq-main-content\">\n    <p>curl \u2013d &#8220;action=SALE&amp;client_key=c2b8fb04-110f-11ea-bcd3-0242c0a85004&amp;brand=applepay&amp;order_id=ORDER12345&amp;order_amount=100<\/p>\n<p>&amp;order_currency=USD&amp;order_description=Product&amp;payer_ip=127.0.0.0&amp;return_url=https\/\/:apple.com&amp;identifier=0987654321<\/p>\n<p>&amp;parameters[paymentToken]= {&#8220;paymentData&#8221;:{&#8220;data&#8221;:&#8221;sSnxW26Va2jj0+QqIrK6zyBve6z3L5j6mNk3iaVcfUwmz76\/bu8008BfkRRp7wZvsUtmrMbaHv0MCNCTW70QLAvLCw61kNidMNEzu2r4rGOXUGJQMMvgPgjXuRafWA8628HcOrrrvAtoljlaAbm\/8ucZVNhDdOFRgfCENqI13GVXhit2sNsN9MsgMsN4odCl7qX837RfJoXgCv7OC00L9ciqpqlMV0pc7jXb2XWN47DCyyRwja5OGMMHuD+heQ8OwCDq5g1mDBww6Neeubl6zpksdNafBjhtEl4nDJ1nPH6IJET4uPgcbgii9rkaEIHXbKVILB0AjUbX4X8Adk91jG7scRAYmB92H75\/6uRvREFvhqvIAlc8C4F5b3ObiB1MpwZt7DwcZIpWz3QJ2WSUGwmc+Qiv4pRV8d5Xw2sSGiEG&#8221;,&#8221;signature&#8221;:&#8221;MIAGCSqGSIb3DQEHAqCAMIACAQExDTALBglghkgBZQMEAgEwgAYJKoZIhvcNAQcBAACggDCCA+MwggOIoAMCAQICCEwwQUlRnVQ2MAoGCCqGSM49BAMCMHoxLjAsBgNVBAMMJUFwcGxlIEFwcGxpY2F0aW9uIEludGVncmF0aW9uIENBIC0gRzMxJjAkBgNVBAsMHUFwcGxlIENlcnRpZmljYXRpb24gQXV0aG9yaXR5MRMwEQYDVQQKDApBcHBsZSBJbmMuMQswCQYDVQQGEwJVUzAeFw0xOTA1MTgwMTMyNTdaFw0yNDA1MTYwMTMyNTdaMF8xJTAjBgNVBAMMHGVjYy1zbXAtYnJva2VyLXNpZ25fVUM0LVBST0QxFDASBgNVBAsMC2lPUyBTeXN0ZW1zMRMwEQYDVQQKDApBcHBsZSBJbmMuMQswCQYDVQQGEwJVUzBZMBMGByqGSM49AgEGCCqGSM49AwEHA0IABMIVd+3r1seyIY9o3XCQoSGNx7C9bywoPYRgldlK9KVBG4NCDtgR80B+gzMfHFTD9+syINa61dTv9JKJiT58DxOjggIRMIICDTAMBgNVHRMBAf8EAjAAMB8GA1UdIwQYMBaAFCPyScRPk+TvJ+bE9ihsP6K7\/S5LMEUGCCsGAQUFBwEBBDkwNzA1BggrBgEFBQcwAYYpaHR0cDovL29jc3AuYXBwbGUuY29tL29jc3AwNC1hcHBsZWFpY2EzMDIwggEdBgNVHSAEggEUMIIBEDCCAQwGCSqGSIb3Y2QFATCB\/jCBwwYIKwYBBQUHAgIwgbYMgbNSZWxpYW5jZSBvbiB0aGlzIGNlcnRpZmljYXRlIGJ5IGFueSBwYXJ0eSBhc3N1bWVzIGFjY2VwdGFuY2Ugb2YgdGhlIHRoZW4gYXBwbGljYWJsZSBzdGFuZGFyZCB0ZXJtcyBhbmQgY29uZGl0aW9ucyBvZiB1c2UsIGNlcnRpZmljYXRlIHBvbGljeSBhbmQgY2VydGlmaWNhdGlvbiBwcmFjdGljZSBzdGF0ZW1lbnRzLjA2BggrBgEFBQcCARYqaHR0cDovL3d3dy5hcHBsZS5jb20vY2VydGlmaWNhdGVhdXRob3JpdHkvMDQGA1UdHwQtMCswKaAnoCWGI2h0dHA6Ly9jcmwuYXBwbGUuY29tL2FwcGxlYWljYTMuY3JsMB0GA1UdDgQWBBSUV9tv1XSBhomJdi9+V4UH55tYJDAOBgNVHQ8BAf8EBAMCB4AwDwYJKoZIhvdjZAYdBAIFADAKBggqhkjOPQQDAgNJADBGAiEAvglXH+ceHnNbVeWvrLTHL+tEXzAYUiLHJRACth69b1UCIQDRizUKXdbdbrF0YDWxHrLOh8+j5q9svYOAiQ3ILN2qYzCCAu4wggJ1oAMCAQICCEltL786mNqXMAoGCCqGSM49BAMCMGcxGzAZBgNVBAMMEkFwcGxlIFJvb3QgQ0EgLSBHMzEmMCQGA1UECwwdQXBwbGUgQ2VydGlmaWNhdGlvbiBBdXRob3JpdHkxEzARBgNVBAoMCkFwcGxlIEluYy4xCzAJBgNVBAYTAlVTMB4XDTE0MDUwNjIzNDYzMFoXDTI5MDUwNjIzNDYzMFowejEuMCwGA1UEAwwlQXBwbGUgQXBwbGljYXRpb24gSW50ZWdyYXRpb24gQ0EgLSBHMzEmMCQGA1UECwwdQXBwbGUgQ2VydGlmaWNhdGlvbiBBdXRob3JpdHkxEzARBgNVBAoMCkFwcGxlIEluYy4xCzAJBgNVBAYTAlVTMFkwEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAE8BcRhBnXZIXVGl4lgQd26ICi7957rk3gjfxLk+EzVtVmWzWuItCXdg0iTnu6CP12F86Iy3a7ZnC+yOgphP9URaOB9zCB9DBGBggrBgEFBQcBAQQ6MDgwNgYIKwYBBQUHMAGGKmh0dHA6Ly9vY3NwLmFwcGxlLmNvbS9vY3NwMDQtYXBwbGVyb290Y2FnMzAdBgNVHQ4EFgQUI\/JJxE+T5O8n5sT2KGw\/orv9LkswDwYDVR0TAQH\/BAUwAwEB\/zAfBgNVHSMEGDAWgBS7sN6hWDOImqSKmd6+veuv2sskqzA3BgNVHR8EMDAuMCygKqAohiZodHRwOi8vY3JsLmFwcGxlLmNvbS9hcHBsZXJvb3RjYWczLmNybDAOBgNVHQ8BAf8EBAMCAQYwEAYKKoZIhvdjZAYCDgQCBQAwCgYIKoZIzj0EAwIDZwAwZAIwOs9yg1EWmbGG+zXDVspiv\/QX7dkPdU2ijr7xnIFeQreJ+Jj3m1mfmNVBDY+d6cL+AjAyLdVEIbCjBXdsXfM4O5Bn\/Rd8LCFtlk\/GcmmCEm9U+Hp9G5nLmwmJIWEGmQ8Jkh0AADGCAYcwggGDAgEBMIGGMHoxLjAsBgNVBAMMJUFwcGxlIEFwcGxpY2F0aW9uIEludGVncmF0aW9uIENBIC0gRzMxJjAkBgNVBAsMHUFwcGxlIENlcnRpZmljYXRpb24gQXV0aG9yaXR5MRMwEQYDVQQKDApBcHBsZSBJbmMuMQswCQYDVQQGEwJVUwIITDBBSVGdVDYwCwYJYIZIAWUDBAIBoIGTMBgGCSqGSIb3DQEJAzELBgkqhkiG9w0BBwEwHAYJKoZIhvcNAQkFMQ8XDTI0MDExNzE4MTkzM1owKAYJKoZIhvcNAQk0MRswGTALBglghkgBZQMEAgGhCgYIKoZIzj0EAwIwLwYJKoZIhvcNAQkEMSIEIIQ9tom6W3WBqvRdnqAgXd7UW2Qg8ls2rvUEAmfYApD6MAoGCCqGSM49BAMCBEYwRAIgV0aosrF2PwHNfZGkiETl7IXJhCvC+lAq2Nw0qD6aNtYCIF7vK1mGv3qZXi38i4iyfLvMd5TwHID3T2EyN1H7EP7gAAAAAAAA&#8221;,&#8221;header&#8221;:{&#8220;publicKeyHash&#8221;:&#8221;nNc4Fl8dRqE+1J\/ibwLTPoXuzYtF3ZJlu7D5CUBZc5w=&#8221;,&#8221;ephemeralPublicKey&#8221;:&#8221;MFkwEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAE6ah1mcW4JkG9jdptrUmprzlOjvF3iK7JOt3wom28HS1MLwrWIKNY7R3Mmp\/tJqMeInAwZZWgXCXXmnujA3Bcig==&#8221;,&#8221;transactionId&#8221;:&#8221;d71de566079d19b44545fa7aa3be682f916f995f5de585021fa9af8cb115a461&#8243;},&#8221;version&#8221;:&#8221;EC_v1&#8243;},&#8221;paymentMethod&#8221;:{&#8220;displayName&#8221;:&#8221;Visa 6244&#8243;,&#8221;network&#8221;:&#8221;Visa&#8221;,&#8221;type&#8221;:&#8221;credit&#8221;},&#8221;transactionIdentifier&#8221;:&#8221;d71de566079d19b44545fa7aa3be682f916f995f5de585021fa9af8cb115a461&#8243;}&#8221;,&#8221;transactionId&#8221;:&#8221;5145cb84015f49a24e9add4752737b6b3124e9cf98f3ab247c4f4a8017f17286&#8243;},&#8221;version&#8221;:&#8221;EC_v1&#8243;},&#8221;paymentMethod&#8221;:{&#8220;displayName&#8221;:&#8221;Visa 0224&#8243;,&#8221;network&#8221;:&#8221;Visa&#8221;,&#8221;type&#8221;:&#8221;debit&#8221;},&#8221;transactionIdentifier&#8221;:&#8221;5145CB84015F49A24E9ADD4752737B6B3124E9CF98F3AB247C4F4A8017F17286&#8243;}<\/p>\n<p>[&amp;hash=](http:\/\/client.site.com\/return.php&amp;recurring_init=Y&amp;hash=02cdb60b5c923e06c1b1d71da94b2a39)&#8221;a1a6de416405ada72bb47a49176471dc&#8221;[ https:\/\/test.apiurl.com](https:\/\/test.apiurl.com\/) -k<\/p>\n<\/div>\n<\/div><\/li><\/ul><script type=\"application\/ld+json\">{\"@context\":\"https:\\\/\\\/schema.org\",\"@type\":\"FAQPage\",\"mainEntity\":[{\"@type\":\"Question\",\"name\":\"Request example\",\"acceptedAnswer\":{\"@type\":\"Answer\",\"text\":\"<p>curl \\u2013d \\\"action=SALE&amp;client_key=c2b8fb04-110f-11ea-bcd3-0242c0a85004&amp;brand=applepay&amp;order_id=ORDER12345&amp;order_amount=100<\\\/p>\\n<p>&amp;order_currency=USD&amp;order_description=Product&amp;payer_ip=127.0.0.0&amp;return_url=https\\\/\\\/:apple.com&amp;identifier=0987654321<\\\/p>\\n<p>&amp;parameters[paymentToken]= {\\\"paymentData\\\":{\\\"data\\\":\\\"sSnxW26Va2jj0+QqIrK6zyBve6z3L5j6mNk3iaVcfUwmz76\\\/bu8008BfkRRp7wZvsUtmrMbaHv0MCNCTW70QLAvLCw61kNidMNEzu2r4rGOXUGJQMMvgPgjXuRafWA8628HcOrrrvAtoljlaAbm\\\/8ucZVNhDdOFRgfCENqI13GVXhit2sNsN9MsgMsN4odCl7qX837RfJoXgCv7OC00L9ciqpqlMV0pc7jXb2XWN47DCyyRwja5OGMMHuD+heQ8OwCDq5g1mDBww6Neeubl6zpksdNafBjhtEl4nDJ1nPH6IJET4uPgcbgii9rkaEIHXbKVILB0AjUbX4X8Adk91jG7scRAYmB92H75\\\/6uRvREFvhqvIAlc8C4F5b3ObiB1MpwZt7DwcZIpWz3QJ2WSUGwmc+Qiv4pRV8d5Xw2sSGiEG\\\",\\\"signature\\\":\\\"MIAGCSqGSIb3DQEHAqCAMIACAQExDTALBglghkgBZQMEAgEwgAYJKoZIhvcNAQcBAACggDCCA+MwggOIoAMCAQICCEwwQUlRnVQ2MAoGCCqGSM49BAMCMHoxLjAsBgNVBAMMJUFwcGxlIEFwcGxpY2F0aW9uIEludGVncmF0aW9uIENBIC0gRzMxJjAkBgNVBAsMHUFwcGxlIENlcnRpZmljYXRpb24gQXV0aG9yaXR5MRMwEQYDVQQKDApBcHBsZSBJbmMuMQswCQYDVQQGEwJVUzAeFw0xOTA1MTgwMTMyNTdaFw0yNDA1MTYwMTMyNTdaMF8xJTAjBgNVBAMMHGVjYy1zbXAtYnJva2VyLXNpZ25fVUM0LVBST0QxFDASBgNVBAsMC2lPUyBTeXN0ZW1zMRMwEQYDVQQKDApBcHBsZSBJbmMuMQswCQYDVQQGEwJVUzBZMBMGByqGSM49AgEGCCqGSM49AwEHA0IABMIVd+3r1seyIY9o3XCQoSGNx7C9bywoPYRgldlK9KVBG4NCDtgR80B+gzMfHFTD9+syINa61dTv9JKJiT58DxOjggIRMIICDTAMBgNVHRMBAf8EAjAAMB8GA1UdIwQYMBaAFCPyScRPk+TvJ+bE9ihsP6K7\\\/S5LMEUGCCsGAQUFBwEBBDkwNzA1BggrBgEFBQcwAYYpaHR0cDovL29jc3AuYXBwbGUuY29tL29jc3AwNC1hcHBsZWFpY2EzMDIwggEdBgNVHSAEggEUMIIBEDCCAQwGCSqGSIb3Y2QFATCB\\\/jCBwwYIKwYBBQUHAgIwgbYMgbNSZWxpYW5jZSBvbiB0aGlzIGNlcnRpZmljYXRlIGJ5IGFueSBwYXJ0eSBhc3N1bWVzIGFjY2VwdGFuY2Ugb2YgdGhlIHRoZW4gYXBwbGljYWJsZSBzdGFuZGFyZCB0ZXJtcyBhbmQgY29uZGl0aW9ucyBvZiB1c2UsIGNlcnRpZmljYXRlIHBvbGljeSBhbmQgY2VydGlmaWNhdGlvbiBwcmFjdGljZSBzdGF0ZW1lbnRzLjA2BggrBgEFBQcCARYqaHR0cDovL3d3dy5hcHBsZS5jb20vY2VydGlmaWNhdGVhdXRob3JpdHkvMDQGA1UdHwQtMCswKaAnoCWGI2h0dHA6Ly9jcmwuYXBwbGUuY29tL2FwcGxlYWljYTMuY3JsMB0GA1UdDgQWBBSUV9tv1XSBhomJdi9+V4UH55tYJDAOBgNVHQ8BAf8EBAMCB4AwDwYJKoZIhvdjZAYdBAIFADAKBggqhkjOPQQDAgNJADBGAiEAvglXH+ceHnNbVeWvrLTHL+tEXzAYUiLHJRACth69b1UCIQDRizUKXdbdbrF0YDWxHrLOh8+j5q9svYOAiQ3ILN2qYzCCAu4wggJ1oAMCAQICCEltL786mNqXMAoGCCqGSM49BAMCMGcxGzAZBgNVBAMMEkFwcGxlIFJvb3QgQ0EgLSBHMzEmMCQGA1UECwwdQXBwbGUgQ2VydGlmaWNhdGlvbiBBdXRob3JpdHkxEzARBgNVBAoMCkFwcGxlIEluYy4xCzAJBgNVBAYTAlVTMB4XDTE0MDUwNjIzNDYzMFoXDTI5MDUwNjIzNDYzMFowejEuMCwGA1UEAwwlQXBwbGUgQXBwbGljYXRpb24gSW50ZWdyYXRpb24gQ0EgLSBHMzEmMCQGA1UECwwdQXBwbGUgQ2VydGlmaWNhdGlvbiBBdXRob3JpdHkxEzARBgNVBAoMCkFwcGxlIEluYy4xCzAJBgNVBAYTAlVTMFkwEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAE8BcRhBnXZIXVGl4lgQd26ICi7957rk3gjfxLk+EzVtVmWzWuItCXdg0iTnu6CP12F86Iy3a7ZnC+yOgphP9URaOB9zCB9DBGBggrBgEFBQcBAQQ6MDgwNgYIKwYBBQUHMAGGKmh0dHA6Ly9vY3NwLmFwcGxlLmNvbS9vY3NwMDQtYXBwbGVyb290Y2FnMzAdBgNVHQ4EFgQUI\\\/JJxE+T5O8n5sT2KGw\\\/orv9LkswDwYDVR0TAQH\\\/BAUwAwEB\\\/zAfBgNVHSMEGDAWgBS7sN6hWDOImqSKmd6+veuv2sskqzA3BgNVHR8EMDAuMCygKqAohiZodHRwOi8vY3JsLmFwcGxlLmNvbS9hcHBsZXJvb3RjYWczLmNybDAOBgNVHQ8BAf8EBAMCAQYwEAYKKoZIhvdjZAYCDgQCBQAwCgYIKoZIzj0EAwIDZwAwZAIwOs9yg1EWmbGG+zXDVspiv\\\/QX7dkPdU2ijr7xnIFeQreJ+Jj3m1mfmNVBDY+d6cL+AjAyLdVEIbCjBXdsXfM4O5Bn\\\/Rd8LCFtlk\\\/GcmmCEm9U+Hp9G5nLmwmJIWEGmQ8Jkh0AADGCAYcwggGDAgEBMIGGMHoxLjAsBgNVBAMMJUFwcGxlIEFwcGxpY2F0aW9uIEludGVncmF0aW9uIENBIC0gRzMxJjAkBgNVBAsMHUFwcGxlIENlcnRpZmljYXRpb24gQXV0aG9yaXR5MRMwEQYDVQQKDApBcHBsZSBJbmMuMQswCQYDVQQGEwJVUwIITDBBSVGdVDYwCwYJYIZIAWUDBAIBoIGTMBgGCSqGSIb3DQEJAzELBgkqhkiG9w0BBwEwHAYJKoZIhvcNAQkFMQ8XDTI0MDExNzE4MTkzM1owKAYJKoZIhvcNAQk0MRswGTALBglghkgBZQMEAgGhCgYIKoZIzj0EAwIwLwYJKoZIhvcNAQkEMSIEIIQ9tom6W3WBqvRdnqAgXd7UW2Qg8ls2rvUEAmfYApD6MAoGCCqGSM49BAMCBEYwRAIgV0aosrF2PwHNfZGkiETl7IXJhCvC+lAq2Nw0qD6aNtYCIF7vK1mGv3qZXi38i4iyfLvMd5TwHID3T2EyN1H7EP7gAAAAAAAA\\\",\\\"header\\\":{\\\"publicKeyHash\\\":\\\"nNc4Fl8dRqE+1J\\\/ibwLTPoXuzYtF3ZJlu7D5CUBZc5w=\\\",\\\"ephemeralPublicKey\\\":\\\"MFkwEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAE6ah1mcW4JkG9jdptrUmprzlOjvF3iK7JOt3wom28HS1MLwrWIKNY7R3Mmp\\\/tJqMeInAwZZWgXCXXmnujA3Bcig==\\\",\\\"transactionId\\\":\\\"d71de566079d19b44545fa7aa3be682f916f995f5de585021fa9af8cb115a461\\\"},\\\"version\\\":\\\"EC_v1\\\"},\\\"paymentMethod\\\":{\\\"displayName\\\":\\\"Visa 6244\\\",\\\"network\\\":\\\"Visa\\\",\\\"type\\\":\\\"credit\\\"},\\\"transactionIdentifier\\\":\\\"d71de566079d19b44545fa7aa3be682f916f995f5de585021fa9af8cb115a461\\\"}\\\",\\\"transactionId\\\":\\\"5145cb84015f49a24e9add4752737b6b3124e9cf98f3ab247c4f4a8017f17286\\\"},\\\"version\\\":\\\"EC_v1\\\"},\\\"paymentMethod\\\":{\\\"displayName\\\":\\\"Visa 0224\\\",\\\"network\\\":\\\"Visa\\\",\\\"type\\\":\\\"debit\\\"},\\\"transactionIdentifier\\\":\\\"5145CB84015F49A24E9ADD4752737B6B3124E9CF98F3AB247C4F4A8017F17286\\\"}<\\\/p>\\n<p>[&amp;hash=](http:\\\/\\\/client.site.com\\\/return.php&amp;recurring_init=Y&amp;hash=02cdb60b5c923e06c1b1d71da94b2a39)\\\"a1a6de416405ada72bb47a49176471dc\\\"[ https:\\\/\\\/test.apiurl.com](https:\\\/\\\/test.apiurl.com\\\/) -k<\\\/p>\\n\"}}]}<\/script>    <\/div>\n<\/div>\n\n\n\n<p>We also recommend checking out the demo provided by Apple for Apple Pay: <a href=\"https:\/\/applepaydemo.apple.com\/\" target=\"_blank\" rel=\"noreferrer noopener\">https:\/\/applepaydemo.apple.com\/<\/a><\/p>\n\n\n\n<h3 class=\"wp-block-heading\" id=\"google-pay\">Google Pay<\/h3>\n\n\n\n<p>To provide the payers with the possibility of Google Pay\u2122 payment you can connect to the Checkout or work directly via S2S VPG protocol. Before using <code>googlepay<\/code> payment method, you should review this section carefully to meet all the Google Pay\u2122 requirements:<\/p>\n\n\n\n<ol>\n<li>Overview the documentation on Google Pay Integration first:<br>\u2022 for sites &#8211; <a href=\"https:\/\/developers.google.com\/pay\/api\/web\" target=\"_blank\" rel=\"noreferrer noopener\"><ins>Google Pay Web developer documentation<\/ins><\/a><br>\u2022 for Android app &#8211; <a href=\"https:\/\/developers.google.com\/pay\/api\/android\" target=\"_blank\" rel=\"noreferrer noopener\"><ins>Google Pay Android developer documentation<\/ins><\/a><\/li>\n\n\n\n<li>Make sure you complete all the items on the integration checklist:<br>\u2022 for sites &#8211;&nbsp;<a href=\"https:\/\/developers.google.com\/pay\/api\/web\/guides\/test-and-deploy\/integration-checklist\" target=\"_blank\" rel=\"noreferrer noopener\"><ins>Google Pay Web integration checklist<\/ins><\/a><br>\u2022 for Android app &#8211;&nbsp;<a href=\"https:\/\/developers.google.com\/pay\/api\/android\/guides\/test-and-deploy\/integration-checklist\" target=\"_blank\" rel=\"noreferrer noopener\"><ins>Google Pay Android integration checklist<\/ins><\/a><\/li>\n\n\n\n<li>To brand your site with Google Pay elements, you must meet the requirements:<br>\u2022 for sites &#8211; <a href=\"https:\/\/developers.google.com\/pay\/api\/web\/guides\/brand-guidelines\" target=\"_blank\" rel=\"noreferrer noopener\"><ins>Google Pay Web Brand Guidelines<\/ins><\/a><br>\u2022 for Android app &#8211; <a href=\"https:\/\/developers.google.com\/pay\/api\/android\/guides\/brand-guidelines\" target=\"_blank\" rel=\"noreferrer noopener\"><ins>Google Pay Android brand guidelines<\/ins><\/a><\/li>\n\n\n\n<li>The merchants must adhere to the Google Pay APIs&nbsp;<a href=\"https:\/\/payments.developers.google.com\/terms\/aup\" target=\"_blank\" rel=\"noreferrer noopener\"><ins>Acceptable Use Policy<\/ins><\/a>&nbsp;and accept the terms that the <a href=\"https:\/\/payments.developers.google.com\/terms\/sellertos\" target=\"_blank\" rel=\"noreferrer noopener\"><ins>Google Pay API Terms of Service<\/ins><\/a> defines.<\/li>\n<\/ol>\n\n\n\n<p>To work with Google Pay\u2122 payments through gateway, you need to make settings in the admin panel. You can set the following configurations:<br>\u2022 choose the environment: <code>TEST<\/code> or <code>PRODUCTION<\/code><br>\u2022 specify &#8220;Allowed Auth Method&#8221; &#8211; <code>PAN_ONLY<\/code> or <code>CRYPTOGRAM_3DS<\/code><br>\u2022 determine &#8220;Supported Networks&#8221; &#8211; MASTERCARD, VISA, AMEX, DISCOVER, JCB<br>These configuration will be applied and used when platform interacts with Google Pay.<br>If you are using <strong>Checkout integration<\/strong> to work with <code>googlepay<\/code> payment method, it requires no additional code implementation.<\/p>\n\n\n\n<p>If you are using <strong>S2S VPG integration<\/strong> to work with <code>googlepay<\/code> payment method, you need to pass the additional parameters in the SALE request:<br>\u2022 <code>brand<\/code> = googlepay<br>\u2022 <code>parameters[paymentToken]<\/code> &#8211; Google Pay payment token.<br>To obtain Google Pay payment token you should get the PaymentData according to the Google Pay API Integration documentation (see the links above).<br>Pass the following parameters to receive PaymentData:<br>\u2022 <code>allowPaymentMethods<\/code>: CARD<br>\u2022 <code>tokenizationSpecification<\/code> = { &#8220;type&#8221;: &#8220;PAYMENT_GATEWAY&#8221;}<br>\u2022 <code>allowedCardNetworks<\/code> = [&#8216;MASTERCARD&#8217;, &#8216;VISA&#8217;, &#8216;AMEX&#8217;, &#8216;DISCOVER&#8217;, &#8216;JCB&#8217;];<br>\u2022 <code>allowedCardAuthMethods<\/code> = [&#8216;PAN_ONLY&#8217;, &#8216;CRYPTOGRAM_3DS&#8217;];<br>\u2022 <code>gateway<\/code> = value provided by your support manager<br>\u2022 <code>gatewayMerchantId<\/code> = CLIENT_KEY (API key)<\/p>\n\n\n<div\n    class=\"betterdocs-faq-wrapper layout-classic icon-before betterdocs-faq-layout-2 betterdocs-faq-a2ivg68 betterdocs-shortcode\">\n    <h2 class=\"betterdocs-faq-layout-2 betterdocs-faq-a2ivg68 betterdocs-faq-section-title\">\n            <\/h2>\n\n    <div class=\"betterdocs-faq-inner-wrapper\">\n        <div class=\"betterdocs-faq-title\">\n    <h2>Google Pay PaymentData<\/h2>\n<\/div>\n<ul class=\"betterdocs-faq-list\"><li><div class=\"betterdocs-faq-group\"><div class=\"betterdocs-faq-post\">\n    <div class=\"betterdocs-faq-post-icon-group\"><svg class=\"betterdocs-faq-iconplus\" xmlns=\"http:\/\/www.w3.org\/2000\/svg\" viewbox=\"0 0 24 24\"><path fill=\"#000000\" d=\"M18 10h-4V6h-4v4H6v4h4v4h4v-4h4\"><\/path><\/svg><svg class=\"betterdocs-faq-iconminus\" xmlns=\"http:\/\/www.w3.org\/2000\/svg\" viewbox=\"0 0 24 24\"><path fill=\"#000000\" d=\"M6 10h12v4H6z\"><\/path><\/svg><\/div>    <span class=\"betterdocs-faq-post-name\">\n        Example of data to get PaymentData    <\/span>\n    <\/div>\n<div class=\"betterdocs-faq-main-content\">\n    <p>{<\/p>\n<p>\u00a0\u00a0\u00a0\u00a0&#8220;apiVersionMinor&#8221;: 0,<\/p>\n<p>\u00a0\u00a0\u00a0\u00a0&#8220;apiVersion&#8221;: 2,<\/p>\n<p>\u00a0\u00a0\u00a0\u00a0&#8220;paymentMethodData&#8221;: {<\/p>\n<p>\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0&#8220;description&#8221;: &#8220;Mastercard \u2022\u2022\u2022\u2022 5179&#8221;,<\/p>\n<p>\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0&#8220;tokenizationData&#8221;: {<\/p>\n<p>\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0&#8220;type&#8221;: &#8220;PAYMENT_GATEWAY&#8221;,<\/p>\n<p>\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0&#8220;token&#8221;: {<\/p>\n<p>\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0&#8220;signature&#8221;: &#8220;MEYCIQC+IHxUu9Wwra2Vu6tBa2wJPCMT3pWtN1VphLGYtNVLLwIhAOkdbNje\/\/eLrXVc+n6LOlc4PqxWOUcqwrmki\/CNA1ur&#8221;,<\/p>\n<p>\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0&#8220;intermediateSigningKey&#8221;: {<\/p>\n<p>\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0&#8220;signedKey&#8221;: &#8220;{&#8220;keyValue&#8221;:&#8221;MFkwEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAEwhRrvGB0kZ1248MEJAPwX0YfrQInhyyRM7nyGFjQuzGSViZG3QC9NMvXR9Zd6uVcVzAz+6K\/+NEGIWbX8zbk6A\\u003d\\u003d&#8221;,&#8221;keyExpiration&#8221;:&#8221;1571208568000&#8243;}&#8221;,<\/p>\n<p>\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0&#8220;signatures&#8221;: [<\/p>\n<p>\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0&#8220;MEUCIQCR6vIEiyHB8qmlho4\/tLd7W8CIGrZDJlCI48CBHeFPvQIgLZJIe4cZv6pYtYYa56QCI\/vvg1GqXTP3bTBjO49r5mI=&#8221;<\/p>\n<p>\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0]<\/p>\n<p>\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0},<\/p>\n<p>\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0&#8220;protocolVersion&#8221;: &#8220;ECv2&#8221;,<\/p>\n<p>\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0&#8220;signedMessage&#8221;: {<\/p>\n<p>\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0&#8220;encryptedMessage&#8221;: &#8220;k85CGUMmd5PaGmQlHFqHc0HrDZmjM1yG82rFB\/p31ZyUleN5nihzjOZif\/BKXwg3XA2oLXqBSSWcAdfZwXxCEOqvAQE+kpTC7qVO4wTPip6RruraT6vO9M9FtIf0kcqzYSAN7pl1SUA5jC9rHrqucPoh0Sspup78SWBt8TnmVKC9O3sQhIZ3SMoGOG4mdjtIrgCwWH2cbrxUH0dHAqOe5ANGOY\/mII4nTEp7xaKu41hK\/kFE15zVyqgPJXP9bPxzMVk\/ozEZSfhSzVTS+9stjkUkT5EibKB3O1bbxyybKcGQ5vxBOtNOBKKdNuqNmN2eEK3UbSKb1M3gv45gT9cCeEvlzO7Wg0N100vUBp9RPDN9TH4tj4w578sWFKfTi6FsSrZB27SGWcU0EaKHO9buo94mRBY5yqffF3bKg5mAMPzjDhyHSujqWKAs9C5fBzMEuEr2z7A23kfLqBceH5uS9LJMiZyVKCwfpY9u2XyCjKdp7Iu003d&#8221;,<\/p>\n<p>\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0&#8220;ephemeralPublicKey&#8221;: &#8220;BAMDAtfgcPNuzItrwGLigGj3rtxmyHhZLwx1B4RJZ2oo11jpFf3SA6a3utryCMmlCEcqLfLn6WDH2ArrNBGnEwu003d&#8221;,<\/p>\n<p>\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0&#8220;tag&#8221;: &#8220;TqhZXY53Fe4QBKafm6NqS6EzwVeiKXhRlp8NeWrAu003d&#8221;<\/p>\n<p>\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0}<\/p>\n<p>\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0}<\/p>\n<p>\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0},<\/p>\n<p>\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0&#8220;type&#8221;: &#8220;CARD&#8221;,<\/p>\n<p>\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0&#8220;info&#8221;: {<\/p>\n<p>\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0&#8220;cardNetwork&#8221;: &#8220;MASTERCARD&#8221;,<\/p>\n<p>\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0&#8220;cardDetails&#8221;: &#8220;5179&#8221;<\/p>\n<p>\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0}<\/p>\n<p>\u00a0\u00a0\u00a0\u00a0}<\/p>\n<p>}<\/p>\n<\/div>\n<\/div><\/li><\/ul><script type=\"application\/ld+json\">{\"@context\":\"https:\\\/\\\/schema.org\",\"@type\":\"FAQPage\",\"mainEntity\":[{\"@type\":\"Question\",\"name\":\"Example of data to get PaymentData\",\"acceptedAnswer\":{\"@type\":\"Answer\",\"text\":\"<p>{<\\\/p>\\n<p>\\u00a0\\u00a0\\u00a0\\u00a0\\\"apiVersionMinor\\\": 0,<\\\/p>\\n<p>\\u00a0\\u00a0\\u00a0\\u00a0\\\"apiVersion\\\": 2,<\\\/p>\\n<p>\\u00a0\\u00a0\\u00a0\\u00a0\\\"paymentMethodData\\\": {<\\\/p>\\n<p>\\u00a0\\u00a0\\u00a0\\u00a0\\u00a0\\u00a0\\u00a0\\u00a0\\\"description\\\": \\\"Mastercard \\u2022\\u2022\\u2022\\u2022 5179\\\",<\\\/p>\\n<p>\\u00a0\\u00a0\\u00a0\\u00a0\\u00a0\\u00a0\\u00a0\\u00a0\\\"tokenizationData\\\": {<\\\/p>\\n<p>\\u00a0\\u00a0\\u00a0\\u00a0\\u00a0\\u00a0\\u00a0\\u00a0\\u00a0\\u00a0\\u00a0\\u00a0\\\"type\\\": \\\"PAYMENT_GATEWAY\\\",<\\\/p>\\n<p>\\u00a0\\u00a0\\u00a0\\u00a0\\u00a0\\u00a0\\u00a0\\u00a0\\u00a0\\u00a0\\u00a0\\u00a0\\\"token\\\": {<\\\/p>\\n<p>\\u00a0\\u00a0\\u00a0\\u00a0\\u00a0\\u00a0\\u00a0\\u00a0\\u00a0\\u00a0\\u00a0\\u00a0\\u00a0\\u00a0\\u00a0\\u00a0\\\"signature\\\": \\\"MEYCIQC+IHxUu9Wwra2Vu6tBa2wJPCMT3pWtN1VphLGYtNVLLwIhAOkdbNje\\\/\\\/eLrXVc+n6LOlc4PqxWOUcqwrmki\\\/CNA1ur\\\",<\\\/p>\\n<p>\\u00a0\\u00a0\\u00a0\\u00a0\\u00a0\\u00a0\\u00a0\\u00a0\\u00a0\\u00a0\\u00a0\\u00a0\\u00a0\\u00a0\\u00a0\\u00a0\\\"intermediateSigningKey\\\": {<\\\/p>\\n<p>\\u00a0\\u00a0\\u00a0\\u00a0\\u00a0\\u00a0\\u00a0\\u00a0\\u00a0\\u00a0\\u00a0\\u00a0\\u00a0\\u00a0\\u00a0\\u00a0\\u00a0\\u00a0\\u00a0\\u00a0\\\"signedKey\\\": \\\"{\\\"keyValue\\\":\\\"MFkwEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAEwhRrvGB0kZ1248MEJAPwX0YfrQInhyyRM7nyGFjQuzGSViZG3QC9NMvXR9Zd6uVcVzAz+6K\\\/+NEGIWbX8zbk6A\\\\u003d\\\\u003d\\\",\\\"keyExpiration\\\":\\\"1571208568000\\\"}\\\",<\\\/p>\\n<p>\\u00a0\\u00a0\\u00a0\\u00a0\\u00a0\\u00a0\\u00a0\\u00a0\\u00a0\\u00a0\\u00a0\\u00a0\\u00a0\\u00a0\\u00a0\\u00a0\\u00a0\\u00a0\\u00a0\\u00a0\\\"signatures\\\": [<\\\/p>\\n<p>\\u00a0\\u00a0\\u00a0\\u00a0\\u00a0\\u00a0\\u00a0\\u00a0\\u00a0\\u00a0\\u00a0\\u00a0\\u00a0\\u00a0\\u00a0\\u00a0\\u00a0\\u00a0\\u00a0\\u00a0\\u00a0\\u00a0\\u00a0\\u00a0\\\"MEUCIQCR6vIEiyHB8qmlho4\\\/tLd7W8CIGrZDJlCI48CBHeFPvQIgLZJIe4cZv6pYtYYa56QCI\\\/vvg1GqXTP3bTBjO49r5mI=\\\"<\\\/p>\\n<p>\\u00a0\\u00a0\\u00a0\\u00a0\\u00a0\\u00a0\\u00a0\\u00a0\\u00a0\\u00a0\\u00a0\\u00a0\\u00a0\\u00a0\\u00a0\\u00a0\\u00a0\\u00a0\\u00a0\\u00a0]<\\\/p>\\n<p>\\u00a0\\u00a0\\u00a0\\u00a0\\u00a0\\u00a0\\u00a0\\u00a0\\u00a0\\u00a0\\u00a0\\u00a0\\u00a0\\u00a0\\u00a0\\u00a0},<\\\/p>\\n<p>\\u00a0\\u00a0\\u00a0\\u00a0\\u00a0\\u00a0\\u00a0\\u00a0\\u00a0\\u00a0\\u00a0\\u00a0\\u00a0\\u00a0\\u00a0\\u00a0\\\"protocolVersion\\\": \\\"ECv2\\\",<\\\/p>\\n<p>\\u00a0\\u00a0\\u00a0\\u00a0\\u00a0\\u00a0\\u00a0\\u00a0\\u00a0\\u00a0\\u00a0\\u00a0\\u00a0\\u00a0\\u00a0\\u00a0\\\"signedMessage\\\": {<\\\/p>\\n<p>\\u00a0\\u00a0\\u00a0\\u00a0\\u00a0\\u00a0\\u00a0\\u00a0\\u00a0\\u00a0\\u00a0\\u00a0\\u00a0\\u00a0\\u00a0\\u00a0\\u00a0\\u00a0\\u00a0\\u00a0\\\"encryptedMessage\\\": \\\"k85CGUMmd5PaGmQlHFqHc0HrDZmjM1yG82rFB\\\/p31ZyUleN5nihzjOZif\\\/BKXwg3XA2oLXqBSSWcAdfZwXxCEOqvAQE+kpTC7qVO4wTPip6RruraT6vO9M9FtIf0kcqzYSAN7pl1SUA5jC9rHrqucPoh0Sspup78SWBt8TnmVKC9O3sQhIZ3SMoGOG4mdjtIrgCwWH2cbrxUH0dHAqOe5ANGOY\\\/mII4nTEp7xaKu41hK\\\/kFE15zVyqgPJXP9bPxzMVk\\\/ozEZSfhSzVTS+9stjkUkT5EibKB3O1bbxyybKcGQ5vxBOtNOBKKdNuqNmN2eEK3UbSKb1M3gv45gT9cCeEvlzO7Wg0N100vUBp9RPDN9TH4tj4w578sWFKfTi6FsSrZB27SGWcU0EaKHO9buo94mRBY5yqffF3bKg5mAMPzjDhyHSujqWKAs9C5fBzMEuEr2z7A23kfLqBceH5uS9LJMiZyVKCwfpY9u2XyCjKdp7Iu003d\\\",<\\\/p>\\n<p>\\u00a0\\u00a0\\u00a0\\u00a0\\u00a0\\u00a0\\u00a0\\u00a0\\u00a0\\u00a0\\u00a0\\u00a0\\u00a0\\u00a0\\u00a0\\u00a0\\u00a0\\u00a0\\u00a0\\u00a0\\\"ephemeralPublicKey\\\": \\\"BAMDAtfgcPNuzItrwGLigGj3rtxmyHhZLwx1B4RJZ2oo11jpFf3SA6a3utryCMmlCEcqLfLn6WDH2ArrNBGnEwu003d\\\",<\\\/p>\\n<p>\\u00a0\\u00a0\\u00a0\\u00a0\\u00a0\\u00a0\\u00a0\\u00a0\\u00a0\\u00a0\\u00a0\\u00a0\\u00a0\\u00a0\\u00a0\\u00a0\\u00a0\\u00a0\\u00a0\\u00a0\\\"tag\\\": \\\"TqhZXY53Fe4QBKafm6NqS6EzwVeiKXhRlp8NeWrAu003d\\\"<\\\/p>\\n<p>\\u00a0\\u00a0\\u00a0\\u00a0\\u00a0\\u00a0\\u00a0\\u00a0\\u00a0\\u00a0\\u00a0\\u00a0\\u00a0\\u00a0\\u00a0\\u00a0}<\\\/p>\\n<p>\\u00a0\\u00a0\\u00a0\\u00a0\\u00a0\\u00a0\\u00a0\\u00a0\\u00a0\\u00a0\\u00a0\\u00a0}<\\\/p>\\n<p>\\u00a0\\u00a0\\u00a0\\u00a0\\u00a0\\u00a0\\u00a0\\u00a0},<\\\/p>\\n<p>\\u00a0\\u00a0\\u00a0\\u00a0\\u00a0\\u00a0\\u00a0\\u00a0\\\"type\\\": \\\"CARD\\\",<\\\/p>\\n<p>\\u00a0\\u00a0\\u00a0\\u00a0\\u00a0\\u00a0\\u00a0\\u00a0\\\"info\\\": {<\\\/p>\\n<p>\\u00a0\\u00a0\\u00a0\\u00a0\\u00a0\\u00a0\\u00a0\\u00a0\\u00a0\\u00a0\\u00a0\\u00a0\\\"cardNetwork\\\": \\\"MASTERCARD\\\",<\\\/p>\\n<p>\\u00a0\\u00a0\\u00a0\\u00a0\\u00a0\\u00a0\\u00a0\\u00a0\\u00a0\\u00a0\\u00a0\\u00a0\\\"cardDetails\\\": \\\"5179\\\"<\\\/p>\\n<p>\\u00a0\\u00a0\\u00a0\\u00a0\\u00a0\\u00a0\\u00a0\\u00a0}<\\\/p>\\n<p>\\u00a0\\u00a0\\u00a0\\u00a0}<\\\/p>\\n<p>}<\\\/p>\\n\"}}]}<\/script>    <\/div>\n<\/div>\n\n\n\n<p>As a result you receive you will be returned a dataset with <code>PaymentData.token<\/code>&nbsp;object contains data that you need add to the SALE request as <code>parameters[paymentToken]<\/code>&nbsp;parameter.<\/p>\n\n\n<div\n    class=\"betterdocs-faq-wrapper layout-classic icon-before betterdocs-faq-layout-2 betterdocs-faq-b8u7zdf betterdocs-shortcode\">\n    <h2 class=\"betterdocs-faq-layout-2 betterdocs-faq-b8u7zdf betterdocs-faq-section-title\">\n            <\/h2>\n\n    <div class=\"betterdocs-faq-inner-wrapper\">\n        <div class=\"betterdocs-faq-title\">\n    <h2>Google Pay Request Example<\/h2>\n<\/div>\n<ul class=\"betterdocs-faq-list\"><li><div class=\"betterdocs-faq-group\"><div class=\"betterdocs-faq-post\">\n    <div class=\"betterdocs-faq-post-icon-group\"><svg class=\"betterdocs-faq-iconplus\" xmlns=\"http:\/\/www.w3.org\/2000\/svg\" viewbox=\"0 0 24 24\"><path fill=\"#000000\" d=\"M18 10h-4V6h-4v4H6v4h4v4h4v-4h4\"><\/path><\/svg><svg class=\"betterdocs-faq-iconminus\" xmlns=\"http:\/\/www.w3.org\/2000\/svg\" viewbox=\"0 0 24 24\"><path fill=\"#000000\" d=\"M6 10h12v4H6z\"><\/path><\/svg><\/div>    <span class=\"betterdocs-faq-post-name\">\n        Request Example    <\/span>\n    <\/div>\n<div class=\"betterdocs-faq-main-content\">\n    <p>curl \u2013d &#8220;action=SALE&amp;client_key=c2b8fb04-110f-11ea-bcd3-0242c0a85004&amp;brand=googlepay&amp;order_id=ORDER12345&amp;order_amount=100<\/p>\n<p>&amp;order_currency=USD&amp;order_description=Product&amp;payer_ip=127.0.0.0&amp;return_url=https\/\/:apple.com&amp;identifier=0987654321&amp;<\/p>\n<p>parameters[paymentToken] = {&#8220;apiVersionMinor&#8221;:0,&#8221;apiVersion&#8221;:2,&#8221;paymentMethodData&#8221;:{&#8220;description&#8221;:&#8221;Visa u2006u2022u2022u2022u2022u20065237&#8243;,&#8221;tokenizationData&#8221;:{&#8220;type&#8221;:&#8221;PAYMENT_GATEWAY&#8221;,&#8221;token&#8221;:&#8221;{&#8220;signature&#8221;:&#8221;MEUCIQCmG9CSxMYyrdHr93\/0VPjgM2tLy6t\/+kwTngBtHCguNAIgfsh6MWiaYtoEfkWJp0KpmiyWTu6f\/845UXU96ERnxT0\\u003d&#8221;,&#8221;intermediateSigningKey&#8221;:{&#8220;signedKey&#8221;:&#8221;{\\&#8221;keyValue\\&#8221;:\\&#8221;MFkwEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAEUDf+weSWhii31Exn8d3WHufrnsiQP4weDoRQgF8VlaBbdTxm5xlxrfseZU3IDaUGKwwpNTRhkWVo\/+arRrXf1A\\\\u003d\\\\u003d\\&#8221;,\\&#8221;keyExpiration\\&#8221;:\\&#8221;1706136902000\\&#8221;}&#8221;,&#8221;signatures&#8221;:[&#8220;MEYCIQDfIHM6RIj7HEE8y1T6oSOVbd8iDCtTFSmJidRphrOP\/wIhAPRjdHe1ulwr1gUEzxLGdA73dEoc6IbqHoSJJqtEMSYk&#8221;]},&#8221;protocolVersion&#8221;:&#8221;ECv2&#8243;,&#8221;signedMessage&#8221;:&#8221;{\\&#8221;encryptedMessage\\&#8221;:\\&#8221;gNZVNFqhgZc8WFPjCljFC4NtSWpLI9NyEEKuNnPoMtZM4yfELLf34vtfL1lWORuxup+sCQ+CPEdPFZJsFmZtox8sEsNTfDFP0sJOfGwA10+0\/2b8NeewNjbzU5VIyc+nwtn2Au3XgoLDYgDyPBJ6exuaY2yjTR3\/UpeHK5JEIgbmN+fdPCOPngIzRkGURTauIvDibQUZeNjDhzHgebcoWF5m0gs2jO1jkAaSrajDa8g6emin2aNXImt41Rk0+hk9kOi6QqZavo2wV4+Lf17o9HlNWERNVKFqhECJ57Rkp7MRlzQyFyaIhfGkynY\/KHJNc8HZ04CWyx1Dco0lARiLNIfVF2mploPf8Va8DcCC67FbLLOH0YoY3UmWGLlGY8qNmpsMsL5ULEeSUGMLCxr4mhZZ\/C4rBf7tDcz\/Auh9qkbsz7rNsa\/9l88jc5UcIMHVeTOOXjHnGR3yB4O5AFKvOob9XaDaKDJjXlUtycynCKu9Mo03C2AFGqkzBNh\/I8pCLKiqzd4ntauyKeLDvNqTaLLbZOVoqRN4Z0gtUfL7yaYqmSiAgg0N+lOiM\/qsqoKFrxiATduxl5kgxffXQAY\\\\u003d\\&#8221;,\\&#8221;ephemeralPublicKey\\&#8221;:\\&#8221;BPluTrJ3LqHzodjl0ZXjIRy2XKWWLibakj4hdf9vlnSsGR1kzdTpyFitSJ9DqyKdxmCbyAh2A7gcJf5XlcX3k9k\\\\u003d\\&#8221;,\\&#8221;tag\\&#8221;:\\&#8221;br8r3h8GF5jQwgfxAcNH\/nQXt5+ySEUuaHRmpqYqWek\\\\u003d\\&#8221;}&#8221;}&#8221;},&#8221;type&#8221;:&#8221;CARD&#8221;,&#8221;info&#8221;:{&#8220;cardNetwork&#8221;:&#8221;VISA&#8221;,&#8221;cardDetails&#8221;:&#8221;5237&#8243;}}}<\/p>\n<p>[&amp;hash=](http:\/\/client.site.com\/return.php&amp;recurring_init=Y&amp;hash=02cdb60b5c923e06c1b1d71da94b2a39)&#8221;a1a6de416405ada72bb47a49176471dc&#8221;[ https:\/\/test.apiurl.com](https:\/\/test.apiurl.com\/) -k<\/p>\n<p>\u00a0\u00a0\u00a0<\/p>\n<\/div>\n<\/div><\/li><\/ul><script type=\"application\/ld+json\">{\"@context\":\"https:\\\/\\\/schema.org\",\"@type\":\"FAQPage\",\"mainEntity\":[{\"@type\":\"Question\",\"name\":\"Request Example\",\"acceptedAnswer\":{\"@type\":\"Answer\",\"text\":\"<p>curl \\u2013d \\\"action=SALE&amp;client_key=c2b8fb04-110f-11ea-bcd3-0242c0a85004&amp;brand=googlepay&amp;order_id=ORDER12345&amp;order_amount=100<\\\/p>\\n<p>&amp;order_currency=USD&amp;order_description=Product&amp;payer_ip=127.0.0.0&amp;return_url=https\\\/\\\/:apple.com&amp;identifier=0987654321&amp;<\\\/p>\\n<p>parameters[paymentToken] = {\\\"apiVersionMinor\\\":0,\\\"apiVersion\\\":2,\\\"paymentMethodData\\\":{\\\"description\\\":\\\"Visa u2006u2022u2022u2022u2022u20065237\\\",\\\"tokenizationData\\\":{\\\"type\\\":\\\"PAYMENT_GATEWAY\\\",\\\"token\\\":\\\"{\\\"signature\\\":\\\"MEUCIQCmG9CSxMYyrdHr93\\\/0VPjgM2tLy6t\\\/+kwTngBtHCguNAIgfsh6MWiaYtoEfkWJp0KpmiyWTu6f\\\/845UXU96ERnxT0\\\\u003d\\\",\\\"intermediateSigningKey\\\":{\\\"signedKey\\\":\\\"{\\\\\\\"keyValue\\\\\\\":\\\\\\\"MFkwEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAEUDf+weSWhii31Exn8d3WHufrnsiQP4weDoRQgF8VlaBbdTxm5xlxrfseZU3IDaUGKwwpNTRhkWVo\\\/+arRrXf1A\\\\\\\\u003d\\\\\\\\u003d\\\\\\\",\\\\\\\"keyExpiration\\\\\\\":\\\\\\\"1706136902000\\\\\\\"}\\\",\\\"signatures\\\":[\\\"MEYCIQDfIHM6RIj7HEE8y1T6oSOVbd8iDCtTFSmJidRphrOP\\\/wIhAPRjdHe1ulwr1gUEzxLGdA73dEoc6IbqHoSJJqtEMSYk\\\"]},\\\"protocolVersion\\\":\\\"ECv2\\\",\\\"signedMessage\\\":\\\"{\\\\\\\"encryptedMessage\\\\\\\":\\\\\\\"gNZVNFqhgZc8WFPjCljFC4NtSWpLI9NyEEKuNnPoMtZM4yfELLf34vtfL1lWORuxup+sCQ+CPEdPFZJsFmZtox8sEsNTfDFP0sJOfGwA10+0\\\/2b8NeewNjbzU5VIyc+nwtn2Au3XgoLDYgDyPBJ6exuaY2yjTR3\\\/UpeHK5JEIgbmN+fdPCOPngIzRkGURTauIvDibQUZeNjDhzHgebcoWF5m0gs2jO1jkAaSrajDa8g6emin2aNXImt41Rk0+hk9kOi6QqZavo2wV4+Lf17o9HlNWERNVKFqhECJ57Rkp7MRlzQyFyaIhfGkynY\\\/KHJNc8HZ04CWyx1Dco0lARiLNIfVF2mploPf8Va8DcCC67FbLLOH0YoY3UmWGLlGY8qNmpsMsL5ULEeSUGMLCxr4mhZZ\\\/C4rBf7tDcz\\\/Auh9qkbsz7rNsa\\\/9l88jc5UcIMHVeTOOXjHnGR3yB4O5AFKvOob9XaDaKDJjXlUtycynCKu9Mo03C2AFGqkzBNh\\\/I8pCLKiqzd4ntauyKeLDvNqTaLLbZOVoqRN4Z0gtUfL7yaYqmSiAgg0N+lOiM\\\/qsqoKFrxiATduxl5kgxffXQAY\\\\\\\\u003d\\\\\\\",\\\\\\\"ephemeralPublicKey\\\\\\\":\\\\\\\"BPluTrJ3LqHzodjl0ZXjIRy2XKWWLibakj4hdf9vlnSsGR1kzdTpyFitSJ9DqyKdxmCbyAh2A7gcJf5XlcX3k9k\\\\\\\\u003d\\\\\\\",\\\\\\\"tag\\\\\\\":\\\\\\\"br8r3h8GF5jQwgfxAcNH\\\/nQXt5+ySEUuaHRmpqYqWek\\\\\\\\u003d\\\\\\\"}\\\"}\\\"},\\\"type\\\":\\\"CARD\\\",\\\"info\\\":{\\\"cardNetwork\\\":\\\"VISA\\\",\\\"cardDetails\\\":\\\"5237\\\"}}}<\\\/p>\\n<p>[&amp;hash=](http:\\\/\\\/client.site.com\\\/return.php&amp;recurring_init=Y&amp;hash=02cdb60b5c923e06c1b1d71da94b2a39)\\\"a1a6de416405ada72bb47a49176471dc\\\"[ https:\\\/\\\/test.apiurl.com](https:\\\/\\\/test.apiurl.com\\\/) -k<\\\/p>\\n<p>\\u00a0\\u00a0\\u00a0<\\\/p>\\n\"}}]}<\/script>    <\/div>\n<\/div>\n\n\n\n<p>\u26a0\ufe0f <strong>Pay attention<\/strong><\/p>\n\n\n\n<blockquote class=\"wp-block-quote is-layout-flow wp-block-quote-is-layout-flow\">\n<p><em>in the case of PAN_ONLY, the responsibility for passing 3ds is transferred to the acquirer, through which the payment is processed<\/em><\/p>\n<\/blockquote>\n\n\n\n<h3 class=\"wp-block-heading\" id=\"paypal\">paypal<\/h3>\n\n\n\n<p>payment_method = <code>paypal<\/code><\/p>\n\n\n\n<h3 class=\"wp-block-heading\" id=\"pix\">pix<\/h3>\n\n\n\n<p>If the payer chooses the <code>pix<\/code> payment method, the field for entering the document number will be additionally displayed on the Checkout page. After the <em>Pay<\/em> button is clicked, the QR-code could be displayed to the payer. The payer should use the code to finish the payment.<\/p>\n\n\n\n<h3 class=\"wp-block-heading\" id=\"sepa\">sepa<\/h3>\n\n\n\n<p>If the payer chooses the <code>sepa<\/code> payment method, the redirection to another page will happen to finish the payment.<\/p>\n\n\n\n<h3 class=\"wp-block-heading\" id=\"skrill\">skrill<\/h3>\n\n\n\n<p>If the payer chooses the <code>skrill<\/code> payment method, the redirection to another page will happen to finish the payment.<\/p>\n\n\n\n<h3 class=\"wp-block-heading\" id=\"stripe-js\">stripe-js<\/h3>\n\n\n\n<p>If the payer chooses the <code>stripe-js<\/code> payment method, the redirection to another page will happen to finish the payment.<\/p>\n\n\n\n<h3 class=\"wp-block-heading\" id=\"unipay\">unipay<\/h3>\n\n\n\n<p>payment_method = <code>unipay<\/code><\/p>","protected":false},"excerpt":{"rendered":"<p>Checkout Integrations Version: 6.4.4Released: 2025\/03\/01 Copyrighted by lddPay Introduction This document describes the Checkout integration procedures between Checkout service and [&hellip;]<\/p>","protected":false},"author":1,"featured_media":0,"comment_status":"open","ping_status":"closed","template":"","meta":{"site-sidebar-layout":"default","site-content-layout":"","ast-site-content-layout":"","site-content-style":"default","site-sidebar-style":"default","ast-global-header-display":"","ast-banner-title-visibility":"","ast-main-header-display":"","ast-hfb-above-header-display":"","ast-hfb-below-header-display":"","ast-hfb-mobile-header-display":"","site-post-title":"","ast-breadcrumbs-content":"","ast-featured-img":"","footer-sml-layout":"","theme-transparent-header-meta":"","adv-header-id-meta":"","stick-header-meta":"","header-above-stick-meta":"","header-main-stick-meta":"","header-below-stick-meta":"","astra-migrate-meta-layouts":"default","ast-page-background-enabled":"default","ast-page-background-meta":{"desktop":{"background-color":"var(--ast-global-color-4)","background-image":"","background-repeat":"repeat","background-position":"center center","background-size":"auto","background-attachment":"scroll","background-type":"","background-media":"","overlay-type":"","overlay-color":"","overlay-opacity":"","overlay-gradient":""},"tablet":{"background-color":"","background-image":"","background-repeat":"repeat","background-position":"center center","background-size":"auto","background-attachment":"scroll","background-type":"","background-media":"","overlay-type":"","overlay-color":"","overlay-opacity":"","overlay-gradient":""},"mobile":{"background-color":"","background-image":"","background-repeat":"repeat","background-position":"center center","background-size":"auto","background-attachment":"scroll","background-type":"","background-media":"","overlay-type":"","overlay-color":"","overlay-opacity":"","overlay-gradient":""}},"ast-content-background-meta":{"desktop":{"background-color":"var(--ast-global-color-5)","background-image":"","background-repeat":"repeat","background-position":"center center","background-size":"auto","background-attachment":"scroll","background-type":"","background-media":"","overlay-type":"","overlay-color":"","overlay-opacity":"","overlay-gradient":""},"tablet":{"background-color":"var(--ast-global-color-5)","background-image":"","background-repeat":"repeat","background-position":"center center","background-size":"auto","background-attachment":"scroll","background-type":"","background-media":"","overlay-type":"","overlay-color":"","overlay-opacity":"","overlay-gradient":""},"mobile":{"background-color":"var(--ast-global-color-5)","background-image":"","background-repeat":"repeat","background-position":"center center","background-size":"auto","background-attachment":"scroll","background-type":"","background-media":"","overlay-type":"","overlay-color":"","overlay-opacity":"","overlay-gradient":""}},"footnotes":""},"doc_category":[9],"doc_tag":[],"year_month":"2026-04","word_count":6541,"total_views":0,"reactions":{"happy":0,"normal":0,"sad":0},"author_info":{"author_nicename":"admin","author_url":"https:\/\/lddpay.com\/zh\/author\/admin\/"},"doc_category_info":[{"term_name":"CHECKOUT INTEGRATIONS","term_url":"https:\/\/lddpay.com\/zh\/docs-category\/checkout-integrations\/"}],"doc_tag_info":[],"author_list":[{"ID":"3","user_login":"jony","display_name":"jony","id":"3"},{"ID":"2","user_login":"Merchantlogin","display_name":"Merchantlogin","id":"2"},{"ID":"1","user_login":"w2863431","display_name":"admin","id":"1"}],"_links":{"self":[{"href":"https:\/\/lddpay.com\/zh\/wp-json\/wp\/v2\/docs\/437"}],"collection":[{"href":"https:\/\/lddpay.com\/zh\/wp-json\/wp\/v2\/docs"}],"about":[{"href":"https:\/\/lddpay.com\/zh\/wp-json\/wp\/v2\/types\/docs"}],"author":[{"embeddable":true,"href":"https:\/\/lddpay.com\/zh\/wp-json\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"https:\/\/lddpay.com\/zh\/wp-json\/wp\/v2\/comments?post=437"}],"version-history":[{"count":47,"href":"https:\/\/lddpay.com\/zh\/wp-json\/wp\/v2\/docs\/437\/revisions"}],"predecessor-version":[{"id":832,"href":"https:\/\/lddpay.com\/zh\/wp-json\/wp\/v2\/docs\/437\/revisions\/832"}],"wp:attachment":[{"href":"https:\/\/lddpay.com\/zh\/wp-json\/wp\/v2\/media?parent=437"}],"wp:term":[{"taxonomy":"doc_category","embeddable":true,"href":"https:\/\/lddpay.com\/zh\/wp-json\/wp\/v2\/doc_category?post=437"},{"taxonomy":"doc_tag","embeddable":true,"href":"https:\/\/lddpay.com\/zh\/wp-json\/wp\/v2\/doc_tag?post=437"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}