Payture API
MobilePay
https://{Environment}.payture.com/api/MobilePayThe MobilePay method is used to quickly process a Customer payment in a single action (one-step payment) via the Apple Pay, Google Pay, and Samsung Pay mobile payment systems.
Request
curl https://sandbox3.payture.com/api/MobilePay \
-X POST \
-H "Content-Type: application/x-www-form-urlencoded" \
-d Key=Merchant \
-d PayToken={PayToken} \
-d OrderId=5f63838d-fb03-00c6-c890-c67cfc1c54ea \
-d Checksum=true \
-d Amount=12480 \Parameter names in requests are case-sensitive
| Parameter | Description | Format |
|---|---|---|
| PayToken | Payment data: for Apple Pay — paymentData from PKPaymentToken, Base64-encoded for Google Pay — token from paymentData, Base64-encoded for Samsung Pay — paymentCredential, Base64-encoded | String Mandatory |
| Key | Payment terminal name Provided with the test/production access credentials | String Mandatory |
| OrderId | Unique payment ID in the Merchant's system Recommended format: GUID/UUID or alphanumeric. Other formats may cause failures in banking services. | String [1..50] Mandatory |
| Amount | Payment amount in kopecks (or another minor unit of the terminal currency) Required for Google Pay. Amount must match the amount in the token. For Samsung Pay and Apple Pay, it is used only when “Checksum=True” (for Samsung Pay and Apple Pay, the payment amount is taken from the token) | Integer Optional |
| SecureCode | CVV2/CVC2 code Required when paying with a non-tokenized card via Google Pay | Integer Optional |
| CustomFields | Additional transaction fields URL-encoded string of key-value pairs separated by “;” (semicolon). Keys and values are separated by “=” (equals sign) | String Optional |
| Checksum | Flag used to verify that the amount in the Apple Pay or Samsung Pay token matches the Amount parameter, with a tolerance of 100 kopecks | Boolean Optional |
| Cheque | Fiscal receipt data in JSON format, Base64-encoded | String Optional |
Response
Response examples
<Pay OrderId="5f63838d-fb03-00c6-c890-c67cfc1c54ea" Key="Merchant" Success="True" Amount="12480"/>XML string with the Pay element
| Parameter | Description | Format |
|---|---|---|
| Success | Operation success flag. Possible values:True — the operation succeededFalse — the operation failed3DS — 3‑D Secure authentication is required | String Mandatory |
| OrderId | Payment ID in the Merchant's system Matches the value passed in the request | String [1..50] Mandatory |
| Key | Payment terminal name Matches the value passed in the request | String Mandatory |
| Amount | Payment amount in kopecks (or another minor unit of the terminal currency) Returned if “Success=True” or “Success=3DS” | Integer Optional |
| ACSUrl | 3-D Secure authentication server (ACS) URL Returned if “Success=3DS” | String Optional |
| PaReq | 3-D Secure authentication request Returned if “Success=3DS” | String Optional |
| ThreeDSKey | Unique transaction ID (MD) Returned if “Success=3DS” | String Optional |
| ThreeDSVersion | 3-D Secure protocol version: 1.0 — version 1 2.1 — version 2 Returned if “Success=3DS” | String Optional |
| FinalTerminal | Final terminal on which the payment was processed Returned if the payment was redirected to another terminal | String Optional |
| AddInfo | Additional transaction parameters that can be returned in the payment gateway response by arrangement with Payture support A description of the format and available parameters is available here (in Russian) | Object Optional |
| ErrCode | Error code. See error codes Returned if “Success=False” | String Optional |
MobileBlock
https://{Environment}.payture.com/api/MobileBlockThe MobileBlock method lets you hold funds on the Customer's card added to Apple Pay, Google Pay, or Samsung Pay.
Request
curl https://sandbox3.payture.com/api/MobileBlock \
-X POST \
-H "Content-Type: application/x-www-form-urlencoded" \
-d Key=Merchant \
-d PayToken={PayToken} \
-d OrderId=5f63838d-fb03-00c6-c890-c67cfc1c54ea \
-d Checksum=true \
-d Amount=12480 \Parameter names in requests are case-sensitive
| Parameter | Description | Format |
|---|---|---|
| PayToken | Payment data: for Apple Pay — paymentData from PKPaymentToken, Base64-encoded for Google Pay — token from paymentData, Base64-encoded for Samsung Pay — paymentCredential, Base64-encoded | String Mandatory |
| Key | Payment terminal name Provided with the test/production access credentials | String Mandatory |
| OrderId | Unique payment ID in the Merchant's system Recommended format: GUID/UUID or alphanumeric. Other formats may cause failures in banking services. | String [1..50] Mandatory |
| Amount | Payment amount in kopecks (or another minor unit of the terminal currency) Required for Google Pay. Amount must match the amount in the token. For Samsung Pay and Apple Pay, it is used only when “Checksum=True” (for Samsung Pay and Apple Pay, the payment amount is taken from the token) | Integer Optional |
| SecureCode | CVV2/CVC2 code Required when paying with a non-tokenized card via Google Pay | Integer Optional |
| CustomFields | Additional transaction fields URL-encoded string of key-value pairs separated by “;” (semicolon). Keys and values are separated by “=” (equals sign) | String Optional |
| Checksum | Flag used to verify that the amount in the Apple Pay or Samsung Pay token matches the Amount parameter, with a tolerance of 100 kopecks | Boolean Optional |
| Cheque | Fiscal receipt data in JSON format, Base64-encoded | String Optional |
Response
Response examples
<Block OrderId="5f63838d-fb03-00c6-c890-c67cfc1c54ea" Key="Merchant" Success="True" Amount="12480"/>XML string with the Block element
| Parameter | Description | Format |
|---|---|---|
| Success | Operation success flag. Possible values:True — the operation succeededFalse — the operation failed3DS — 3‑D Secure authentication is required | String Mandatory |
| OrderId | Payment ID in the Merchant's system Matches the value passed in the request | String [1..50] Mandatory |
| Key | Payment terminal name Matches the value passed in the request | String Mandatory |
| Amount | Payment amount in kopecks (or another minor unit of the terminal currency) Returned if “Success=True” or “Success=3DS” | Integer Optional |
| ACSUrl | 3-D Secure authentication server (ACS) URL Returned if “Success=3DS” | String Optional |
| PaReq | 3-D Secure authentication request Returned if “Success=3DS” | String Optional |
| ThreeDSKey | Unique transaction ID (MD) Returned if “Success=3DS” | String Optional |
| ThreeDSVersion | 3-D Secure protocol version: 1.0 — version 1 2.1 — version 2 Returned if “Success=3DS” | String Optional |
| FinalTerminal | Final terminal on which the payment was processed Returned if the payment was redirected to another terminal | String Optional |
| AddInfo | Additional transaction parameters that can be returned in the payment gateway response by arrangement with Payture support A description of the format and available parameters is available here (in Russian) | Object Optional |
| ErrCode | Error code. See error codes Returned if “Success=False” | String Optional |
API
The Payture API lets customers pay for purchases in one tap using Apple Pay, Google Pay, and Samsung Pay card wallets. It gives the Merchant an additional way to accept payments…
Payture eWallet
The vwapi/Pay request with a PayToken is used to make a payment via Apple Pay, Google Pay, or Samsung Pay.
