Appendix C
Additional parameters
When using some connector services, it is necessary to send additional parameters in the specific request. You can add specific parameters in the parameters object.
For more information, contact your manager.
Apple Pay
To use the applepay payment method, configure the Wallets setting in the admin dashboard. Ensure that the payment provider has confirmed the Apple Pay certificates and verified your domain in the Apple Pay account.
To enable payers to make Apple Pay payments, you can either connect to the Checkout page or work directly via the S2S protocol:
Checkout Page: No additional development is required on your side.
S2S Protocol: You must be able to obtain the Apple Pay payment token and include it in the SALE request.
Regardless of the protocol you have to make settings in the admin panel and set the following configurations:
- Merchant Identifier, Country and Shop Name – according to the merchant’s data from Apple Pay Developer account
- Certificate and Private Key – generated Apple Pay certificate and private key
- Merchant Capabilities and Supported Networks – configurations for Apple Pay payments
- Processing Private Key – private key that uses for payment token decryption (requires if payment provider supports).
⚠️ Pay attention
Before using Apple Pay via S2S CARD protocol, you should review next section carefully. There is a description on how you can obtain Apple Pay payment token (it refers to the official Apple Pay documentation)
- Each payment must be checked for Apple Pay accessibility
- Show Apple Pay button to your payers
- Validate the merchant identity
- Provide a payment request and create a session
- Receive Apple Pay payment token (paymentData object)
Once you have implemented Apple Pay payment token generation on your site, you need to include the following in the SALE request:
digital_wallet= applepaypayment_token- Apple Pay payment token
When providing a digital wallet token, you must omit card data (card_number, card_exp_month, card_exp_year, card_cvv2).
Request example
curl -d "action=SALE
&client_key=c2b8fb04-110f-11ea-bcd3-0242c0a85004
&order_id=ORDER12345&
&order_amount=1.99
&order_currency=USD
&order_description=Product
&payer_first_name=John
&payer_last_name=Doe
&payer_address=BigStreet
&payer_country=US
&payer_state=CA
&payer_city=City
&payer_zip=123456
&[email protected]
&payer_phone=199999999
&payer_ip=123.123.123.123
&term_url_3ds=http://client.site.com/return.php
&digital_wallet=applepay
&payment_token={"paymentData":{"data":"YOUR_ENCRYPTED_DATA","signature":"YOUR_SIGNATURE","header":{"publicKeyHash":"YOUR_PUBLIC_KEY_HASH","ephemeralPublicKey":"YOUR_EPHEMERAL_PUBLIC_KEY","transactionId":"YOUR_TRANSACTION_ID"},"version":"EC_v1"},"paymentMethod":{"displayName":"Visa 6244","network":"Visa","type":"credit"},"transactionIdentifier":"YOUR_TRANSACTION_IDENTIFIER"},{"transactionId":"TRANSACTION_ID_2","version":"EC_v1"},{"paymentMethod":{"displayName":"Visa 0224","network":"Visa","type":"debit"},"transactionIdentifier":"TRANSACTION_IDENTIFIER_2"}
¶meters[param1]=value1
¶meters[param2]=value2
¶meters[param3]=value3
&hash=2702ae0c4f99506dc29b5615ba9ee3c0" https://test.apiurl.com -k
We also recommend checking out the demo provided by Apple for Apple Pay: https://applepaydemo.apple.com
Set up Apple Pay
If you are using the S2S protocol for Apple Pay payments, you will need to configure your Apple Developer account. Follow these steps to set up Apple Pay in your Apple Developer account:
1. Create a Merchant ID in the "Certificates, Identifiers & Profiles" section.
2. Register and verify the domains involved in the interaction with Apple Pay (e.g., the checkout page URL where the Apple Pay button is placed) in the "Merchant Domains" section.
3. Create a Merchant Identity Certificate in the "Merchant Identity Certificate" section:
- Generate a pair of certificates (*.csr and *.key) and upload the *.csr file in the "Merchant Identity Certificate" section.
- Create a Merchant Identity Certificate based on the generated CSR file.
- Download the *.pem file from the portal.
⚠️ Note
The *.csr file can be obtained from the payment provider that processes Apple Pay, and the *.pem file should be uploaded to your payment provider's dashboard, following their instructions.
4. Create a Processing Private Key in the "Apple Pay Payment Processing Certificate" section:
- Generate a pair of certificates (*.csr and *.key) and upload the *.csr file.
- Create a Payment Processing Certificate based on the generated CSR file.
For more detailed instructions on setting up Apple Pay, refer to the following resource: Learn more about setting up Apple Pay
Next, enter the data from your Apple Pay developer account into the platform's admin panel: Go to the "Merchants" section, initiate editing, open the "Wallets" tab, navigate to the Apple Pay settings, and fill in the following fields:
- Merchant Identifier: Enter the Merchant ID.
- Certificate: Upload the *.pem file downloaded from the "Merchant Identity Certificate" section.
- Private Key: Upload the *.key file from the certificate pair generated for the Merchant Identity Certificate.
- Processing Private Key (required for token decryption): Paste the text from the Processing Private Key file. Ensure it is a single line of text (without spaces or breaks) placed between "BEGIN" and "END."
Apple Pay Payment Flow
Processing payments via the S2S CARD protocol is supported by select providers. Contact support to check if your provider supports card flow.
By default, all Apple Pay payments on the platform are classified as virtual. As a result:
- Card details are not stored for these transactions.
- Functionality is limited for DMS payments and the creation of recurring transactions.
To access the card flow for Apple Pay payments, you need to:
- Set up the Processing Private Key in the admin panel settings ("Merchants" section → "Wallets" tab) to enable token decryption.
- Verify that your payment provider supports card flow processing (ask your support if available).
How It Works:
- If both requirements are met, the system will always decrypt the Apple Pay token during payment and store the decrypted card data for future transactions.
- You can view decrypted card details in the Transaction Details section of the admin panel.
- If any requirement is not met, the SALE request returns error.
- If your provider supports card flow but does not accept decrypted data, platform can still store the card details for processing. However, some features (e.g., smart routing and cascading) will not be available.
Google Pay™
To provide the payers with the possibility of Google Pay™ payment you can connect to the Checkout or work directly via S2S CARD protocol.
If you are using Checkout integration to work with googlepay payment method, it requires no additional code implementation.
If you are using S2S integration to work with googlepay payment method, you must be able to obtain the Google Pay payment token and include it in the SALE request.
Before using googlepay brand in S2S CARD solution, you need to review this section carefully to meet all the Google Pay™ requirements:
- Overview the documentation on Google Pay Integration first:
• for sites - Google Pay Web developer documentation
• for Android app - Google Pay Android developer documentation - Make sure you complete all the items on the integration checklist:
• for sites - Google Pay Web integration checklist
• for Android app - Google Pay Android integration checklist - To brand your site with Google Pay elements, you must meet the requirements:
• for sites - Google Pay Web Brand Guidelines
• for Android app - Google Pay Android brand guidelines - The merchants must adhere to the Google Pay APIs Acceptable Use Policy and accept the terms that the Google Pay API Terms of Service defines.
To obtain Google Pay payment token you have to get the PaymentData according to the Google Pay API Integration documentation (see the links above). Pass the following parameters to receive PaymentData:
allowPaymentMethods: CARDtokenizationSpecification = { "type": "PAYMENT_GATEWAY"}allowedCardNetworks= ['MASTERCARD', 'VISA', 'AMEX', 'DISCOVER', 'JCB'];allowedCardAuthMethods= ['PAN_ONLY', 'CRYPTOGRAM_3DS'];gateway= value provided by your support managergatewayMerchantId= CLIENT_KEY (API key)
Once you have implemented Google Pay payment token generation on your site, you need to include the following in the SALE request:
digital_wallet= googlepaypayment_token- Google Pay payment token
When providing a digital wallet token, you must omit card data (card_number, card_exp_month, card_exp_year, card_cvv2).
Request example
curl -d "action=SALE
&client_key=c2b8fb04-110f-11ea-bcd3-0242c0a85004
&order_id=ORDER12345&
&order_amount=1.99
&order_currency=USD
&order_description=Product
&payer_first_name=John
&payer_last_name=Doe
&payer_address=BigStreet
&payer_country=US
&payer_state=CA
&payer_city=City
&payer_zip=123456
&[email protected]
&payer_phone=199999999
&payer_ip=123.123.123.123
&term_url_3ds=http://client.site.com/return.php
&digital_wallet=googlepay
&payment_token={\"apiVersionMinor\": 0, \"apiVersion\": 2, \"paymentMethodData\": {\"description\": \"Mastercard •••• 5179\", \"tokenizationData\": {\"type\": \"PAYMENT_GATEWAY\", \"token\": {\"signature\": \"YOUR_SIGNATURE\", \"intermediateSigningKey\": {\"signedKey\": \"YOUR_SIGNED_KEY\", \"signatures\": [\"YOUR_SIGNATURE_2\"]}, \"protocolVersion\": \"ECv2\", \"signedMessage\": {\"encryptedMessage\": \"ENCRYPTED_MESSAGE\", \"ephemeralPublicKey\": \"EPHEMERAL_PUBLIC_KEY\", \"tag\": \"TAG\"}}}, \"type\": \"CARD\", \"info\": {\"cardNetwork\": \"MASTERCARD\", \"cardDetails\": \"5179\"}}}
¶meters[param1]=value1
¶meters[param2]=value2
¶meters[param3]=value3
&hash=2702ae0c4f99506dc29b5615ba9ee3c0" https://test.apiurl.com -k
Set up Google Pay
The admin panel settings apply to merchants integrated with the platform via the Checkout protocol.
For merchants using the S2S protocol and obtaining the Google Pay payment token independently, these settings will not apply.
Exceptions are "Environment" and “Private Key” configurations.
The "Environment" configuration remains relevant, as it defines the environment where the token was generated and from which the platform expects to receive payment data. Ensure that the environment used to generate the payment token matches the corresponding setting in the admin panel to avoid processing issues.
The “Private Key” is required for Google token decryption. If it is absent, the card flow cannot be applied to the payment.
Additionally, to work with Google Pay payments, you must verify the website domains from which Google Pay is processed in the Google Business Console.
Google Pay Payment Flow
Processing payments via the S2S CARD protocol is supported by select providers. Contact support to check if your provider supports card flow.
By default, all Google Pay payments on the platform are classified as virtual. As a result:
- Card details are not stored for these transactions.
- Functionality is limited for DMS payments and the creation of recurring transactions.
To access the card flow for Google Pay payments, you need to:
- Set up the Private Key in the admin panel settings ("Merchants" section → "Wallets" tab) to enable token decryption.
- Verify that your payment provider supports card flow processing (ask your support if available).
How It Works:
- If both requirements are met, the system will always decrypt the Google Pay token during payment and store the decrypted card data for future transactions.
- You can view decrypted card details in the Transaction Details section of the admin panel.
- If any requirement is not met, the SALE request returns error.
- If your provider supports card flow but does not accept decrypted data, platform can still store the card details for processing. However, some features (e.g., smart routing and cascading) will not be available.
SALE request
Additional parameters - Set 1 (BNG)
| Parameter | Description | Values | Required field |
|---|---|---|---|
bnrg_installm_def | Indicates the number of months that will elapse from the purchase until the total or partial charge is made to the cardholder's account (initial deferral). Possible values: 01 - one month 00 - no delay initial | Numeric justified to 2 digits | + |
bnrg_installm_months | Indicates the number of monthly payments in which the total amount of the transaction will be divided. Example: 03 - 3 months | Numeric justified to 2 digits | + |
bnrg_installm_plan | Indicates if the promotion It will be ́ with interest or without interest. Possible values: 03 - no interest05 - with interest07 - defer only initial . | Numeric justified to 2 digits | + |
Sample curl request
curl -d "action=SALE&client_key=c2b8fb04-110f-11ea-bcd3-0242c0a85004&order_id=ORDER12345&
order_amount=1000.99&order_currency=MXN&order_description=Product&
card_number=4111111111111111&card_exp_month=01&card_exp_year=2025&card_cvv2=000&
payer_first_name=John&payer_last_name=Doe&payer_address=BigStreet&
payer_country=US&payer_state=CA&payer_city=City&payer_zip=123456&
[email protected]&payer_phone=199999999&
payer_ip=123.123.123.123&term_url_3ds=http://client.site.com/return.php&
parameters[bnrg_installm_def]=00¶meters[bnrg_installm_months]=03¶meters[bnrg_installm_plan]=03&
hash=2702ae0c4f99506dc29b5615ba9ee3c0"
https://test.apiurl.com -k
Additional parameters - Set 2 (FCP)
| Parameter | Description | Values | Required field |
|---|---|---|---|
document_type | Type of the document number specified above. Possibe values: cpf | String | + |
document_number | Client’s document number | String | + |
social_name | Client's social name | String | + |
fiscal_country | An alpha-2 country code of the customer’s tax country | String | + |
Sample curl request
curl -d "action=SALE&client_key=c2b8fb04-110f-11ea-bcd3-0242c0a85004&order_id=ORDER12345&
order_amount=1000.99&order_currency=BRL&order_description=Product&card_number=4111111111111111&
card_exp_month=01&card_exp_year=2025&card_cvv2=000&payer_first_name=John&payer_last_name=Doe&
payer_address=BigStreet&payer_country=US&payer_state=CA&payer_city=City&payer_zip=123456&
[email protected]&payer_phone=199999999&payer_ip=123.123.123.123
&term_url_3ds=http://client.site.com/return.php
¶meters[document_type]=cpf¶meters[document_number]=231.002.999-00
¶meters[social_name]=Harry Potter¶meters[fiscal_country]=BR
¶meters[toBankAccountId]=a1a1134a-32c6-442c-90c9-66b587d5be00&
hash=2702ae0c4f99506dc29b5615ba9ee3c0" https://test.apiurl.com -k
Additional parameters - Set 3 (TWD)
| Parameter | Description | Values | Required field |
|---|---|---|---|
customer_phone | Phone number of the customer. | String | - |
customer_telnocc | Country phone code of the customer. | String | - |
shipping_street1 | Building name, and/or street name of the customer's shipping address. | String | - |
shipping_city | City of the customer's shipping address. | String | - |
shipping_state | State or region of the customer's shipping address. | String | - |
shipping_postcode | Postal code/ Zip code of the customer's shipping address. Max – 9 digits. | String | - |
shipping_country | Country of the shipping address. 3-digits code | String | - |
Sample curl request
curl -d "action=SALE&client_key=c2b8fb04-110f-11ea-bcd3-0242c0a85004&order_id=ORDER12345&
order_amount=1000.99&order_currency=USD&order_description=Product&
card_number=4111111111111111&card_exp_month=01&card_exp_year=2025&card_cvv2=000&
payer_first_name=John&payer_last_name=Doe&payer_address=BigStreet&
payer_country=US&payer_state=CA&payer_city=City&payer_zip=123456&
[email protected]&payer_phone=199999999&
payer_ip=123.123.123.123&term_url_3ds=http://client.site.com/return.php&
parameters[customer_phone]=1234567890¶meters[customer_telnocc]=123&
parameters[shipping_street1]= Moor Building 35274¶meters[shipping_city]=Los Angeles&
parameters[shipping_state]=CA¶meters[shipping_postcode]=098765432&
parameters[shipping_country]=US&hash=2702ae0c4f99506dc29b5615ba9ee3c0"
https://test.apiurl.com -k
Additional parameters - Set 4 (APC)
| Parameter | Description | Values | Required field |
|---|---|---|---|
shipping.street1 | The door number, floor, building number, building name, and/or street name of the shipping address | String(100) | Conditional |
shipping.street2 | The adjoining road or locality (if required) of the shipping address | String(100) | Conditional |
shipping.houseNumber1 | Primary house number (door number or building number) of the shipping address | String(100) | Optional |
shipping.houseNumber2 | Secondary house number of the shipping address | String(100) | Optional |
shipping.city | The town, district or city of the shipping address | String(80) | Conditional |
shipping.state | The county, state or region of the shipping address | String(50) | Conditional |
shipping.postcode | The postal code or zip code of the shipping address | String(16) | Conditional |
shipping.country | The country of the shipping address (ISO 3166-1) | String(2) | |
shipping.method | Method of the shipping | String(30) | Conditional |
shipping.cost | The total amount of the shipping costs | String(16) | Conditional |
shipping.comment | A comment for the shipping | String(160) | Conditional |
shipping.expectedDate | The expected delivery date | String(10) | Optional |
shipping.logisticsProvider | The logistics provider of the shipping | String(255) | Optional |
shipping.trackingNumber | The tracking number of the shipping | String(255) | Optional |
shipping.normalized | The normalized shipping address | String(255) | Optional |
shipping.validationStatus | Indicates whether an address got validated and confirmed by the consumer | String(255) | Optional |
shipping.warehouse | The warehouse that fulfilled the order | String(100) | Optional |
shipping.preference | Indicates the shipping preference | String(21) | Optional |
shipping.middleName | The middle name for the shipping address | String(50) | Optional |
shipping.companyName | The company name for the shipping address | String(60) | Optional |
shipping.phone | The phone number for the shipping address | String(25) | Optional |
shipping.workPhone | The work phone number for the shipping address | String(25) | Optional |
shipping.mobile | The mobile number for the shipping address | String(25) | Optional |
shipping.email | The email address for the shipping address | String(128) | Optional |
shipping.type | Defines type of shipping (return or shipment) | String(8) | Optional |
cart.items[n].name | The name of the item in the shopping cart | String(255) | Conditional |
cart.items[n].merchantItemId | The unique identifier of the item in the shopping cart | String(255) | Conditional |
cart.items[n].quantity | The number of items in the shopping cart | String(5) | Conditional |
cart.items[n].type | The type of the purchased item in the shopping cart | String(255) | Conditional |
cart.items[n].sku | The sku cart item | String(255) | Optional |
cart.items[n].currency | The currency of the price of the shopping cart | String(3) | Conditional |
cart.items[n].description | The description of the item in the shopping cart | String(2048) | Conditional |
cart.items[n].commodityCode | L3 Card data, product commodity code | String(8) | Optional |
cart.items[n].commodityDescription | L3 Card data, product commodity description | String(50) | Optional |
cart.items[n].originalPrice | The price of the item (excluding tax and discount) | String(255) | Optional |
cart.items[n].price | The price of the item (including tax and discount) | String(13) | Conditional |
cart.items[n].totalAmount | The total amount of the cart item including quantity | String(13) | Conditional |
cart.items[n].taxAmount | The tax amount of the cart item (independent of quantity) | String(13) | Conditional |
cart.items[n].totalTaxAmount | The total tax amount of the cart item | String(13) | Conditional |
cart.items[n].tax | The tax percentage applied to the item | String(13) | Conditional |
cart.items[n].taxCategory | Mandatory L3 Card data tax category | String(13) | Conditional |
cart.items[n].shipping | The shipping amount applied to the item | String(12) | Conditional |
cart.items[n].discount | The discount percentage applied to the item | String(13) | Conditional |
cart.items[n].giftMessage | Gift Message for the specific cart item | String(255) | Optional |
cart.items[n].shippingMethod | Shipping method for the cart item | String(255) | Optional |
cart.items[n].shippingInstructions | Shipping instructions for the cart item | String(255) | Optional |
cart.items[n].shippingTrackingNumber | Shipping tracking number for the cart item | String(255) | Optional |
cart.items[n].quantityUnit | The cart item's unit of quantity | String Possible values: M, CM, KG, G, COUNT(default) | Optional |
cart.items[n].productUrl | The cart item's URL | String(255) | Optional |
cart.items[n].imageUrl | The cart item's image URL | String(255) | Optional |
cart.items[n].totalDiscountAmount | The cart item's total discount amount | String(12) | Optional |
cart.items[n].productCode | The cart item's product code | String(30) | Optional |
cart.items[n].partNumber | Manufacturer-provided part number | String(30) | Optional |
cart.items[n].itemNumber | Line number of this item on the invoice | String(3) | Optional |
cart.items[n].vatReferenceNumber | Reference number to identify the VAT invoice/tax receipt | String(30) | Optional |
cart.items[n].sellerId | Unique identifier of the marketplace seller | String(255) | Optional |
cart.items[n].recipient.salutation | Recipient title | String(5) | Optional |
cart.items[n].recipient.firstName | Recipient first name | String(48) | Optional |
cart.items[n].recipient.middleName | Recipient middle name | String(50) | Optional |
cart.items[n].recipient.lastName | Recipient last name | String(48) | Optional |
cart.items[n].recipient.apartment | Recipient apartment number | String(100) | Optional |
cart.items[n].recipient.street | Recipient address line 1 | String(100) | Optional |
cart.items[n].recipient.address | Recipient address line 2 | String(100) | Optional |
cart.items[n].recipient.city | Recipient city | String(80) | Optional |
cart.items[n].recipient.state | Recipient state | String(50) | Optional |
cart.items[n].recipient.postcode | Recipient postal code | String(16) | Optional |
cart.items[n].recipient.country | Recipient country code | String(5) | Optional |
cart.items[n].recipient.phone | Recipient phone number | String(25) | Optional |
cart.items[n].recipient.email | Recipient email address | String(128) | Optional |
cart.items[n].deliveryDate | Delivery date of the cart item | String(10) | Optional |
cart.payments[n].name | The name of the payment method | String(255) | Optional |
cart.payments[n].type | The type of the used payment (GIFTCARD, PROMOTION) | String(255) | Optional |
cart.payments[n].amount | The amount of the used payment method | String(12) | Optional |
cart.payments[n].currency | Currency of the payment amount | String(3) | Optional |
cart.payments[n].status | Status of the payment method (pending, authorized, captured) | String(255) | Optional |
cart.payments[n].brand | Brand of the payment method | String(255) | Optional |
cart.payments[n].primary | Identifies if this is the primary payment method | Boolean | Optional |
marketPlace.sellers[n].id | Unique identifier of the seller | String(255) | Optional |
marketPlace.sellers[n].amount | Total amount of the items under the seller | String(13) | Optional |
Sample curl request
curl -d "action=SALE&
client_key=c2b8fb04-110f-11ea-bcd3-0242c0a85004&
order_id=ORDER12345&
order_amount=1000.99&
order_currency=USD&
order_description=Product&
card_number=4111111111111111&
card_exp_month=01&
card_exp_year=2025&
card_cvv2=000&
payer_first_name=John&
payer_last_name=Doe&
payer_address=BigStreet&
payer_country=US&
payer_state=CA&
payer_city=City&
payer_zip=123456&
[email protected]&
payer_phone=199999999&
payer_ip=123.123.123.123&
term_url_3ds=http://client.site.com/return.php&
parameters[shipping][street1]=Street&
parameters[cart][payments][0][primary]=true&
parameters[cart][items][0][name]=item&
parameters[cart][payments][1][primary]=false&
parameters[cart][items][1][name]=item 2&
&hash=2702ae0c4f99506dc29b5615ba9ee3c0"
https://test.apiurl.com -k
DEBIT request
Additional parameters - Set 1 (ERS)
| Parameter | Description | Values | Required field |
|---|---|---|---|
payer_identity_type | The type of Sender’s identification document | String | - |
payer_identity_id | The number of Sender’s identification document | String | - |
payer_identity_country | The country of issuance of the Sender's identification document | String | - |
payer_identity_exp_date | The expiration date of the Sender's identification document | String | - |
payer_nationality | Sender’s nationality | String | - |
payer_country_of_birth | Sender’s country of birth | String | - |
payee_first_name | Receiver’s first name | String | - |
payee_last_name | Receiver’s last name | String | - |
payee_middle_name | Receiver’s middle name | String | - |
payee_address | Receiver’s street | String | - |
payee_city | Receiver’s city | String | - |
payee_state | Receiver’s state | String | - |
payee_country | Receiver’s country | String | - |
payee_zip | Receiver’s postal code | String | - |
payee_phone | Receiver’s phone number | String | - |
payee_birth_date | Receiver’s date of the birth | String | - |
payee_identity_type | The type of Receiver’s identification document | String | - |
payee_identity_id | The number of Receiver’s identification documentt | String | - |
payee_identity_country | The country of issuance of Receiver’s identification document | String | - |
payee_identity_exp_date | The expiration date of Receiver’s identification document | String | - |
payee_nationality | Receiver’s nationality | String | - |
payee_country_of_birth | Receiver’s country of birth | String | - |
Sample curl request
curl -d "action=DEBIT&client_key=c2b8fb04-110f-11ea-bcd3-0242c0a85004&order_id=ORDER12345&order_amount=1000.99&order_currency=USD
&order_description=Product&card_number=4111111111111111
&card_exp_month=01&card_exp_year=2025&card_cvv2=000&
payer_first_name=John&payer_last_name=Doe&payer_address=BigStreet&
payer_country=US&payer_state=CA&payer_city=City&payer_zip=123456&
[email protected]&payer_phone=199999999&
payer_ip=123.123.123.123&term_url_3ds=http://client.site.com/return.php&
parameters[payer_identity_type]=document type&
parameters[payer_identity_id]=03090807656¶meters[payer_identity_country]=KZ&
parameters[payer_identity_exp_date]=December 2030&
parameters[payer_nationality]=happy nation¶meters[payer_country_of_birth]=KZ&
parameters[payee_first_name]=Jane¶meters[payee_last_name]=Doe&
parameters[payee_middle_name]=middle¶meters[payee_address]=happy nation&
parameters[payee_city]=city name¶meters[payee_state]=state&
parameters[payee_country]=KZ¶meters[payee_zip]=123456&
parameters[payee_phone]=street name¶meters[payee_birth_date]=21.09.1990&
parameters[payee_identity_type]=document type&
parameters[payee_identity_id]=7573829201¶meters[payee_identity_country]=KZ&
parameters[payee_identity_exp_date]=April 2025&
parameters[payee_nationality]=happy nation¶meters[payee_country_of_birth]=KZ&
hash=2702ae0c4f99506dc29b5615ba9ee3c0"
https://test.apiurl.com/post -k
CREDIT2CARD request
Additional parameters - Set 1 (ERS)
| Parameter | Description | Values | Required field |
|---|---|---|---|
payer_account_number | Sender's account number. If the source of funds is for card payment, then PAN should be indicated here. If it is an independent account, which, in the event of a request, can be quickly determined and information provided - you can show #NA. | String | + |
payer_identity_type | The type of Sender’s identification document | String | - |
payer_identity_id | The number of Sender’s identification document | String | - |
payer_identity_country | The country of issuance of the Sender's identification document | String | - |
payer_identity_exp_date | The expiration date of the Sender's identification document | String | - |
payer_nationality | Sender’s nationality | String | - |
payer_country_of_birth | Sender’s country of birth | String | - |
payee_identity_type | The type of Receiver’s identification document | String | - |
payee_identity_id | The number of Receiver’s identification documentt | String | - |
payee_identity_country | The country of issuance of Receiver’s identification document | String | - |
payee_identity_exp_date | The expiration date of Receiver’s identification document | String | - |
payee_nationality | Receiver’s nationality | String | - |
payee_country_of_birth | Receiver’s country of birth | String | - |
Sample curl request
curl -d "action=CREDIT2CARD&client_key=c2b8fb04-110f-11ea-bcd3-0242c0a85004&
channel_id=test&order_id=123456789&order_amount=1.03&order_currency=USD&
order_description=wine&card_number=4917111111111111&
payee_first_name=John&payee_last_name=Doe&payee_address=BigStreet&payee_country=US&payee_state=CA&payee_city=City&payee_zip=123456&[email protected]&
payee_phone=199999999&payer_first_name=John&payer_last_name=Doe&
payer_address=BigStreet&payer_country=US&payer_state=CA&payer_city=City&
payer_zip=123456&[email protected]&payer_phone=199999999&
payer_ip=123.123.123.123¶meters[payer_account_number]= 4111111111111111&
parameters[payer_identity_type]=document type&
parameters[payer_identity_id]=03090807656¶meters[payer_identity_country]=KZ&
parameters[payer_identity_exp_date]=December 2030&
parameters[payer_nationality]=happy nation¶meters[payer_country_of_birth]=KZ&
parameters[payee_identity_type]=document type&
parameters[payee_identity_id]=7573829201¶meters[payee_identity_country]=KZ&
parameters[payee_identity_exp_date]=April 2025&
parameters[payee_nationality]=happy nation¶meters[payee_country_of_birth]=KZ&
hash=2702ae0c4f99506dc29b5615ba9ee3c0"
https://test.apiurl.com/post -k
Additional parameters - Set 2 (PWD)
| Parameter | Description | Values | Required field |
|---|---|---|---|
card_exp_month | Expiration month for payee’s card | String 2 digits | + |
card_exp_year | Expiration year for payee’s card | String 4 digits | + |
Sample curl request
curl -d "action=CREDIT2CARD&client_key=c2b8fb04-110f-11ea-bcd3-0242c0a85004&
channel_id=test&order_id=123456789&order_amount=1.03&order_currency=USD&
order_description=wine&card_number=4917111111111111&
payee_first_name=John&payee_last_name=Doe&payee_address=BigStreet&payee_country=US&payee_state=CA&payee_city=City&payee_zip=123456&[email protected]&
payee_phone=199999999&payer_first_name=John&payer_last_name=Doe&
payer_address=BigStreet&payer_country=US&payer_state=CA&payer_city=City&
payer_zip=123456&[email protected]&payer_phone=199999999&
payer_ip=123.123.123.123¶meters[card_exp_month]=11&
parameters[card_exp_year]=2030&
hash=2702ae0c4f99506dc29b5615ba9ee3c0"
https://test.apiurl.com/post -k
Additional parameters - Set 3 (NSP)
| Parameter | Description | Values | Required field |
|---|---|---|---|
expiry | Card expiry (format MM/YYYY) | String | + |
Sample curl request
curl -d "action=CREDIT2CARD&client_key=c2b8fb04-110f-11ea-bcd3-0242c0a85004&
channel_id=test&order_id=123456789&order_amount=1.03&order_currency=USD&
order_description=wine&card_number=4917111111111111&
payee_first_name=John&payee_last_name=Doe&payee_address=BigStreet&payee_country=US&payee_state=CA&payee_city=City&payee_zip=123456&[email protected]&
payee_phone=199999999&payer_first_name=John&payer_last_name=Doe&
payer_address=BigStreet&payer_country=US&payer_state=CA&payer_city=City&
payer_zip=123456&[email protected]&payer_phone=199999999&
payer_ip=123.123.123.123¶meters[expiry]=01/2038&
hash=2702ae0c4f99506dc29b5615ba9ee3c0"
https://test.apiurl.com/post -k
CARD2CARD request
Additional parameters - Set 1 (PRC)
| Parameter | Description | Values | Required field |
|---|---|---|---|
payer_identity_type | Identification document type: 1 – passport; 2 – driver’s license; 3 – social security number; 4 – Taxpayer Identification Number; 5 – national identifier; 6 – foreign passport; 7 – military ID; 8 – other type of document | String | - |
payer_identity_id | Identification document number | String | - |
payer_type | Possible values: 0 – unknown; 1 – on-us; 2 – resident; 3 – foreign | String | - |
Sample curl request
curl -d "action=CARD2CARD&client_key=c2b8fb04-110f-11ea-bcd3-0242c0a85004&order_id=ORDER12345&order_amount=1000.99&order_currency=USD&
order_description=Product&card_number=4111111111111111&card_exp_month=01&
card_exp_year=2025&card_cvv2=000&payer_first_name=John&payer_last_name=Doe&
payer_address=BigStreet&payer_country=US&payer_state=CA&payer_city=City&
payer_zip=123456&[email protected]&payer_phone=199999999&
payer_ip=123.123.123.123& payee_card_number=4444111111112222&
payee_first_name=John&payee_last_name=Doe&
payee_address=BigStreet&payee_country=US&payee_state=CA&payee_city=City&
payee_zip=123456&[email protected]&payee_phone=199999999&
term_url_3ds=http://client.site.com/return.php&
parameters[payer_identity_type]=document&
parameters[payer_identity_id]=234556678603¶meters[payer_type]=0&
hash=2702ae0c4f99506dc29b5615ba9ee3c0"
https://test.apiurl.com -k
See also
For related S2S Card documentation, see the following pages:
- S2S Card overview: integration overview and action list.
- Payment operation types: per-action request and response shapes.
- Appendix A: hash formulas used by S2S CARD requests and callbacks.
- Appendix B: worked request and response examples.