### Create Order API Example Request (cURL) Source: https://documenter.getpostman.com/view/17619441/2s93Xu3644 An example of how to make a POST request to the Create Order API endpoint using cURL. Includes necessary headers and a sample JSON payload. ```curl curl --location 'https://test-vpos.unitedpayment.az/api/IntegratedPayments/Order/Create' \ --header 'x-auth-token: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VySWQiOiIzIiwibmJmIjoxNjc4MzQ4OTIyLCJleHAiOjE2NzgzNTI1MjIsImlhdCI6MTY3ODM0ODkyMiwiaXNzIjoieW91cmlzc3VlcjEyMyIsImF1ZCI6InlvdXJhdWRpZW5jZTEyMyJ9.9tnoaiYFF2Mc0imtvXYo71HOBfFadx84sJNz2O_kYQQ' \ --data '{ "transactionType": "string", //TransactionType ["Purchase"],["PreAuth"],["Installment"],["CardRegistration"] "AddCard": false, "amount": 1.5, "Otptype": false, //OtpType true - ["Otp"],false - ["nonOtp"] "callbackUrl":"string", //if type ["Otp"] "CvvType":false, "language": "string", "currency": "string", "clientOrderId": "string", "description": "string", "installment": 0, "partnerId": "string", "memberId": "string", "countryCode":"string", "binNumber":"string", "notificationUrl": "string" }' ``` -------------------------------- ### Example Checkout Request Source: https://documenter.getpostman.com/view/17619441/2s93Xu3644#intro Example cURL request for initiating a checkout transaction. Ensure the x-auth-token and request body are correctly formatted. ```curl curl --location 'https://test-vpos.unitedpayment.az/api/transactions/checkout' \ --header 'x-auth-token: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VySWQiOiI5OCIsIm5iZiI6MTc0MTA4MzE2NiwiZXhwIjoxNzQxMDg2NzY2LCJpYXQiOjE3NDEwODMxNjYsImlzcyI6InlvdXJpc3N1ZXIxMjMiLCJhdWQiOiJ5b3VyYXVkaWVuY2UxMjMifQ.uz7AQjJC4Yiqjj8HkX9_819kw4LhuR0Km-u9lIzbOYM' \ --data '{ "clientOrderId": "0110", "amount": "0.3", "language": "EN", "successUrl": "www.unitedpayment.az", "cancelUrl": "www.yandex.com", "declineUrl": "www.google.com" }' ``` -------------------------------- ### Preauth Completion cURL Request Source: https://documenter.getpostman.com/view/17619441/2s93Xu3644 Example cURL command to execute a preauth completion request. ```bash curl --location 'https://test-vpos.unitedpayment.az/api/transactions/preauth-completion' \ --header 'x-auth-token: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VySWQiOjExLCJkZWZhdWx0UHJvamVjdElkIjoxMSwicGhvbmUiOiIrOTk0ICg3NykgNzc3IDc3IDc3IiwiaWF0IjoxNjY3MDIxOTk3LCJleHAiOjE2NjcwMjU1OTd9.olgF8QNCsm-OPR9dGuPgQxRSRNS51b1J0Q_u55eNYhw' \ --data '{ "transactionId": 0, "amount": 0, "language": "EN", "partnerId": "string" }' ``` -------------------------------- ### Create Order cURL Request Source: https://documenter.getpostman.com/view/17619441/2s93Xu3644#intro Example cURL command to initiate a transaction creation request. ```curl curl --location 'https://test-vpos.unitedpayment.az/api/IntegratedPayments/Order/Create' \ --header 'x-auth-token: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VySWQiOiIzIiwibmJmIjoxNjc4MzQ4OTIyLCJleHAiOjE2NzgzNTI1MjIsImlhdCI6MTY3ODM0ODkyMiwiaXNzIjoieW91cmlzc3VlcjEyMyIsImF1ZCI6InlvdXJhdWRpZW5jZTEyMyJ9.9tnoaiYFF2Mc0imtvXYo71HOBfFadx84sJNz2O_kYQQ' \ --data '{ "transactionType": "string", //TransactionType ["Purchase"],["PreAuth"],["Installment"],["CardRegistration"] "AddCard": false, "amount": 1.5, "Otptype": false, //OtpType true - ["Otp"],false - ["nonOtp"] "callbackUrl":"string", //if type ["Otp"] "CvvType":false, "language": "string", "currency": "string", "clientOrderId": "string", "description": "string", "installment": 0, "partnerId": "string", "memberId": "string", "countryCode":"string", "binNumber":"string", "notificationUrl": "string" }' ``` -------------------------------- ### cURL Direct Payment Source: https://documenter.getpostman.com/view/17619441/2s93Xu3644 Example cURL request for processing a direct payment. ```bash curl --location -g 'https://test-vpos.unitedpayment.az/api/IntegratedPayments/Order/{OrderId}/DirectPayment' \ --header 'x-auth-token: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VySWQiOjExLCJkZWZhdWx0UHJvamVjdElkIjoxMSwicGhvbmUiOiIrOTk0ICg3NykgNzc3IDc3IDc3IiwiaWF0IjoxNjY3MDIxOTk3LCJleHAiOjE2NjcwMjU1OTd9.olgF8QNCsm-OPR9dGuPgQxRSRNS51b1J0Q_u55eNYhw' \ --data '{ "pan": "4169737756227308", "cvv": "101", "expiredDate": "1025" }' ``` -------------------------------- ### cURL Payment with Saved Card Source: https://documenter.getpostman.com/view/17619441/2s93Xu3644 Example cURL request for processing a payment with a saved card. ```bash curl --location -g 'https://test-vpos.unitedpayment.az/api/IntegratedPayments/Order/{OrderId}/PaymentWithSaveCard' \ --header 'x-auth-token: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VySWQiOjExLCJkZWZhdWx0UHJvamVjdElkIjoxMSwicGhvbmUiOiIrOTk0ICg3NykgNzc3IDc3IDc3IiwiaWF0IjoxNjY3MDIxOTk3LCJleHAiOjE2NjcwMjU1OTd9.olgF8QNCsm-OPR9dGuPgQxRSRNS51b1J0Q_u55eNYhw' \ --data '{ "cardUID": "string", "partnerId": "string" }' ``` -------------------------------- ### Execute Login Request via cURL Source: https://documenter.getpostman.com/view/17619441/2s93Xu3644#intro Example cURL command to perform the login operation. Ensure the Content-Type header is set to application/json. ```bash curl --location 'https://test-vpos.unitedpayment.az/api/auth/' \ --header 'Content-Type: application/json' \ --data-raw '{ "email" : "support@birlesikodeme.com", "password" : "XP@qJM06W!3@" }' ``` -------------------------------- ### POST /api/IntegratedPayments/Order/Create Source: https://documenter.getpostman.com/view/17619441/2s93Xu3644 Creates a new H2H transaction order. Supports various transaction types and optional features like card registration, installments, and webhook notifications. ```APIDOC ## POST /api/IntegratedPayments/Order/Create ### Description Creates a new H2H transaction order. This endpoint supports various payment processes including Purchase, PreAuth, Installment, and CardRegistration. ### Method POST ### Endpoint https://test-vpos.unitedpayment.az/api/IntegratedPayments/Order/Create ### Parameters #### Request Body - **transactionType** (string) - Required - Transaction type: ["Purchase"], ["PreAuth"], ["Installment"], ["CardRegistration"] - **AddCard** (boolean) - Optional - Card registration after direct payment process - **amount** (number) - Required - Amount of payment - **Otptype** (boolean) - Required - true for ["WithOtp"], false for ["nonOtp"] - **callbackUrl** (string) - Optional - Merchant callback URL (mandatory if Otptype is true) - **CvvType** (boolean) - Required - CVV validation type - **language** (string) - Optional - Language Abbreviation - **currency** (string) - Optional - Payment currency type - **clientOrderId** (string) - Optional - Merchant transaction Id - **description** (string) - Optional - Additional Info - **installment** (integer) - Optional - Count of Payment Installment - **partnerId** (string) - Optional - Sub-customer unique ID - **memberId** (string) - Optional - Customer of merchant - **countryCode** (string) - Optional - Country code (e.g., "AZ" for domestic) - **binNumber** (string) - Optional - First 6 digits of the card - **notificationUrl** (string) - Optional - Webhook URL for transaction status updates ### Request Example { "transactionType": "Purchase", "AddCard": false, "amount": 1.5, "Otptype": false, "callbackUrl": "https://merchant.com/callback", "CvvType": false, "language": "AZ", "currency": "AZN", "clientOrderId": "ORD-123", "description": "Test Payment", "installment": 0, "partnerId": "P-99", "memberId": "M-88", "countryCode": "AZ", "binNumber": "411111", "notificationUrl": "https://merchant.com/webhook" } ### Response #### Success Response (200) - **clientOrderId** (string) - Merchant transaction Id - **status** (string) - Transaction status - **transactionType** (string) - Type of transaction - **transactionId** (integer) - Unique transaction ID - **orderId** (integer) - Unique order ID - **message** (string) - Response message #### Response Example { "clientOrderId": "ORD-123", "status": "Success", "transactionType": "Purchase", "transactionId": 12345, "orderId": 67890, "message": "Transaction successful" } ``` -------------------------------- ### Checkout Transaction Response Source: https://documenter.getpostman.com/view/17619441/2s93Xu3644#intro Example successful response for a checkout transaction. The response includes status, transaction details, and a redirect URL for payment processing. ```json { "clientOrderId": "0110", "status": "00", "transactionType": "Purchase", "transactionId": 23, "url": "https://tstpg.kapitalbank.az/index.jsp?ORDERID=12671&SESSIONID=DB214874BBA113834029F53D49795236" } ``` -------------------------------- ### Create Order Response Schema Source: https://documenter.getpostman.com/view/17619441/2s93Xu3644#intro The expected JSON response structure upon a successful 200 OK request. ```json { "clientOrderId": "string", "status": "string", "transactionType": "string", "transactionId": 0, "orderId": 0, "message": "string" } ``` -------------------------------- ### POST /api/auth/ Source: https://documenter.getpostman.com/view/17619441/2s93Xu3644#intro Authenticates with the API using JWT. A token is provided in the response, which should be used in subsequent requests with the 'Bearer' prefix in the Authorization header. ```APIDOC ## POST /api/auth/ ### Description Authenticates with the API using JWT. A token is provided in the response, which should be used in subsequent requests with the 'Bearer' prefix in the Authorization header. ### Method POST ### Endpoint https://test-vpos.unitedpayment.az/api/auth/ ### Request Body - **email** (string) - Required - The email address for authentication. - **password** (string) - Required - The password for authentication. ### Request Example ```json { "email" : "support@unitedpayment.com", "password" : "XP@qJM06W!3@" } ``` ### Response #### Success Response (200) - **token** (string) - The JWT token for authentication, prefixed with 'Bearer '. #### Response Example ```json { "token": "Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VySWQiOjYsImRlZmF1bHRQcm9qZWN0SWQiOjExLCJwcm9qZWN0cyI6W3sidmVyaWZpZWQiOnRydWUsIl9pZCI6IjYzM2FkY2I3M2UxODljM2I2Y2I4MGUyMyIsInByb2plY3RJZCI6MTEsInJvbGVJZCI6MTV9XSwicGhvbmUiOiIrOTk0ICg4OCkgODg4IDg4IDg4IiwiaWF0IjoxNjY1MzkyMzAzLCJleHAiOjE2NjUzOTU5MDN9._qJkKn9BT9aDGjz_tct_4aXXBXK3djs6bB79oarcf38" } ``` ``` -------------------------------- ### Handle Login Response Source: https://documenter.getpostman.com/view/17619441/2s93Xu3644#intro The API returns a JSON object containing the Bearer token upon successful authentication. ```json { "token": "Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VySWQiOjYsImRlZmF1bHRQcm9qZWN0SWQiOjExLCJwcm9qZWN0cyI6W3sidmVyaWZpZWQiOnRydWUsIl9pZCI6IjYzM2FkY2I3M2UxODljM2I2Y2I4MGUyMyIsInByb2plY3RJZCI6MTEsInJvbGVJZCI6MTV9XSwicGhvbmUiOiIrOTk0ICg4OCkgODg4IDg4IDg4IiwiaWF0IjoxNjY1MzkyMzAzLCJleHAiOjE2NjUzOTU5MDN9._qJkKn9BT9aDGjz_tct_4aXXBXK3djs6bB79oarcf38" } ``` -------------------------------- ### Preauth Completion Response Body Source: https://documenter.getpostman.com/view/17619441/2s93Xu3644 JSON response structure returned upon a successful 200 OK status. ```json { "clientOrderId": "string", "status": "00", "transactionType": "Purchase", "transactionId": 12, "url": "https://tstpg.kapitalbank.az/index.jsp?ORDERID=8095&SESSIONID=A4FC1C3E66E8B42803ECFE81D7293B34" } ``` -------------------------------- ### Create Order Request Body Source: https://documenter.getpostman.com/view/17619441/2s93Xu3644#intro JSON schema for the request body required to create a new order. ```json { "transactionType": "string", //TransactionType ["Purchase"],["PreAuth"],["Installment"],["CardRegistration"] "AddCard": false, "amount": 1.5, "Otptype": false, //OtpType true - ["WithOtp"],false - ["nonOtp"] "callbackUrl":"string", //If Otptype is true, this parameter is mandatory. "CvvType":false, "language": "string", "currency": "string", "clientOrderId": "string", "description": "string", "installment": 0, "partnerId": "string", "memberId": "string", "countryCode":"string", "binNumber":"string", "notificationUrl": "string" } ``` -------------------------------- ### POST /api/transactions/preauth-completion Source: https://documenter.getpostman.com/view/17619441/2s93Xu3644 Settles the blocked (Preauth) amount from a customer card. This can be a full or partial transaction and can be refunded. The completion amount can be up to 15% more than the original Preauth amount. ```APIDOC ## POST /api/transactions/preauth-completion ### Description Settles the blocked (Preauth) amount from a customer card. This can be a full or partial transaction and can be refunded. The completion amount can be up to 15% more than the original Preauth amount. ### Method POST ### Endpoint https://test-vpos.unitedpayment.az/api/transactions/preauth-completion ### Headers - **x-auth-token** (string) - Required - Authentication token ### Request Body - **transactionId** (integer) - Required - The ID of the preauthorization transaction. - **amount** (number) - Required - The amount to complete. - **language** (string) - Optional - The language for the transaction (e.g., "EN"). - **partnerId** (string) - Required - The ID of the partner making the request. ### Request Example ```json { "transactionId": 0, "amount": 0, "language": "EN", "partnerId": "string" } ``` ### Response #### Success Response (200) - **clientOrderId** (string) - The unique order ID generated by the client. - **status** (string) - The status code of the transaction (e.g., "00"). - **transactionType** (string) - The type of transaction (e.g., "Purchase"). - **transactionId** (integer) - The unique ID of the completed transaction. - **url** (string) - A URL for further transaction processing or redirection. #### Response Example ```json { "clientOrderId": "string", "status": "00", "transactionType": "Purchase", "transactionId": 12, "url": "https://tstpg.kapitalbank.az/index.jsp?ORDERID=8095&SESSIONID=A4FC1C3E66E8B42803ECFE81D7293B34" } ``` ``` -------------------------------- ### Authenticate with Login API Source: https://documenter.getpostman.com/view/17619441/2s93Xu3644#intro Use this JSON payload to authenticate and receive a JWT token. The token must be included in the header with the 'Bearer' prefix for subsequent requests. ```json { "email" : "support@unitedpayment.com", "password" : "XP@qJM06W!3@" } ``` -------------------------------- ### POST Checkout Transaction Source: https://documenter.getpostman.com/view/17619441/2s93Xu3644#intro Use this method to perform a standard payment transaction with a new card. Required fields include amount, processGuid, orderId, and approveURL. ```json { "clientOrderId": "011-090003304-11-70-15620100", "amount": "6", "language": "EN", "successUrl": "https://www.google.com", "cancelUrl": "https://www.google.com", "declineUrl": "https://www.google.com" } ``` -------------------------------- ### Preauth Completion Request Body Source: https://documenter.getpostman.com/view/17619441/2s93Xu3644 JSON structure required for the POST request to the preauth-completion endpoint. ```json { "transactionId": 0, "amount": 0, "language": "EN", "partnerId": "string" } ``` -------------------------------- ### POST Create Order Source: https://documenter.getpostman.com/view/17619441/2s93Xu3644#intro API endpoint for creating a new payment order. It supports various transaction types and optional parameters for enhanced functionality. ```APIDOC ## POST /api/IntegratedPayments/Order/Create ### Description This API is designed for the creation of H2H (Host-to-Host) transactions. It supports different transaction types and allows for optional parameters such as card registration, callback URLs, and installment plans. ### Method POST ### Endpoint https://test-vpos.unitedpayment.az/api/IntegratedPayments/Order/Create ### Parameters #### Query Parameters - **countryCode** (string) - Optional - The expected value for domestic cards is "AZ". - **binNumber** (string) - Optional - The first 6 digits of the card to be used for payment. #### Request Body - **transactionType** (string) - Required - TransactionType can be one of: ["Purchase"],["PreAuth"],["Installment"],["CardRegistration"] - **AddCard** (boolean) - Optional - Card registration after direct payment process. - **amount** (number) - Required - Amount of payment. - **Otptype** (boolean) - Required - OtpType: true for "WithOtp", false for "nonOtp". - **callbackUrl** (string) - Optional - Merchant callback url when OTP process is true. Mandatory if Otptype is true. - **CvvType** (boolean) - Required. - **language** (string) - Optional - Language Abbreviation. - **currency** (string) - Optional - Payment currency type. - **clientOrderId** (string) - Optional - Merchant transaction Id. - **description** (string) - Optional - Additional Info. - **installment** (integer) - Optional - Count of Payment Installment. - **memberId** (string) - Optional - Customer of merchant. - **partnerId** (string) - Optional - Our sub-customer unique ID. - **notificationUrl** (string) - Optional - If a payment is sent with OTP: true, a webhook request will be sent to this URL. ### Request Example ```json { "transactionType": "Purchase", "AddCard": false, "amount": 1.5, "Otptype": false, "callbackUrl": "string", "CvvType": false, "language": "string", "currency": "string", "clientOrderId": "string", "description": "string", "installment": 0, "partnerId": "string", "memberId": "string", "countryCode": "string", "binNumber": "string", "notificationUrl": "string" } ``` ### Response #### Success Response (200) - **clientOrderId** (string) - Description. - **status** (string) - Description. - **transactionType** (string) - Description. - **transactionId** (integer) - Description. - **orderId** (integer) - Description. - **message** (string) - Description. #### Response Example ```json { "clientOrderId": "string", "status": "string", "transactionType": "string", "transactionId": 0, "orderId": 0, "message": "string" } ``` ### Webhook Notification If `notificationUrl` is provided and `OTP: true`, a webhook request will be sent to the specified URL 10 minutes after the request to the `/DirectPayment` API. The system will retry sending the request up to 10 times until an HTTP 200 OK response is received. **Webhook Payload:** - **IsSuccess** (boolean) - **Message** (string) - **Status** (string) - **BankOrderId** (string) - **TransactionId** (integer) - **ClientOrderId** (string) - **ToProcessId** (string) - **Eci** (string) - **TransactionType** (string) ### Authentication HMAC-SHA256 signature will be used for authentication. The sender serializes the webhook payload to JSON, generates an HMAC-SHA256 signature using the JSON string and a shared secret key, encodes the signature as URL-safe Base64, and sends it in the `X-Signature` header. The receiver must verify this signature. ``` -------------------------------- ### POST /api/transactions/checkout Source: https://documenter.getpostman.com/view/17619441/2s93Xu3644#intro Performs a standard payment transaction with a new card. Requires relevant fields in the request body. ```APIDOC ## POST /api/transactions/checkout ### Description This method is used to perform the standard payment transaction with a new card by entering the relevant fields in the request message. ### Method POST ### Endpoint https://test-vpos.unitedpayment.az/api/transactions/checkout ### Parameters #### Request Body - **clientOrderId** (string) - Required - Unique identifier for the client's order. - **amount** (string) - Required - The transaction amount. - **language** (string) - Required - The language code for the transaction (e.g., 'EN'). - **successUrl** (string) - Required - The URL to redirect to upon successful transaction. - **cancelUrl** (string) - Required - The URL to redirect to if the transaction is cancelled. - **declineUrl** (string) - Required - The URL to redirect to if the transaction is declined. ### Request Example ```json { "clientOrderId": "011-090003304-11-70-15620100", "amount": "6", "language": "EN", "successUrl": "https://www.google.com", "cancelUrl": "https://www.google.com", "declineUrl": "https://www.google.com" } ``` ### Response #### Success Response (200 OK) - **clientOrderId** (string) - The client's order identifier. - **status** (string) - The status code of the transaction (e.g., '00' for success). - **transactionType** (string) - The type of transaction (e.g., 'Purchase'). - **transactionId** (integer) - The unique identifier for the transaction. - **url** (string) - The URL for further transaction processing or redirection. #### Response Example ```json { "clientOrderId": "0110", "status": "00", "transactionType": "Purchase", "transactionId": 23, "url": "https://tstpg.kapitalbank.az/index.jsp?ORDERID=12671&SESSIONID=DB214874BBA113834029F53D49795236" } ``` ### Error Codes #### Transaction Decline Status Codes - **E000** - No Records Found - **E001** - Transaction is exist - **E002** - A system error was received while creating the record - **E003** - Phone format is incorrect (994XXXXXXXXX). - **E007** - It is mandatory to fill in the relevant fields. Please try again. - **E009** - Message invalid format - **E014** - No wallet information found. - **E015** - Login information is incorrect. - **E016** - User information is incorrect. - **E019** - Passport ID is mandatory - **E023** - Amount field must be greater than 0. - **E024** - OrderNo is mandatory - **E029** - The Process Guid field is required. - **E031** - The ReferenceCode field is required. - **E033** - Recipient bank information is incorrect. - **E034** - The SenderName field is required. - **E039** - Client ID is mandatory - **E043** - No record found for the entered process guid. - **E045** - The amount to be transferred must be entered correctly. - **E053** - ProcessGuid has been used before. - **E057** - RRN is mandatory - **E059** - email & password are mandatory - **E060** - Phone number is mandatory - **E065** - Email adresi formatı hatalıdır. - **E066** - The start and end date range cannot exceed 30 days. - **E072** - The user is restricted - **E078** - Card ID is mandatory - **E083** - No Customer Found. - **E108** - RRN is not found - **E127** - Partner is not found - **E172** - Member ID is mandatory - **E175** - ApproveUrl is required - **E176** - CancelURL is required - **E177** - DeclineURL is required - **E901** - Connection error - **E999** - Unknown GeneralError #### Transaction Error Messages - **E200** - An unknown error has occurred, please try again later. - **E202** - Invalid transaction, try again please - **E203** - CVV error - **E204** - Invalid amount - **E205** - Transaction not supported - **E206** - Wrong customer information - **E207** - Expired card - **E208** - Wrong authorization code - **E209** - Duplicate transaction received - **E210** - Wrong OTP - **E211** - Transaction not supported - **E212** - Amount over maximum - **E213** - 3D Secure not enrolled - **E214** - Dynamic OTP Expired - **E215** - Invalid card status - **E216** - Invalid credit PAN - **E217** - Wrong personal info - **E218** - Insufficient funds - **E219** - Canceled by customer. - **E220** - Transaction was reversed. - **E221** - Transaction was refunded. - **E222** - Pre status. - **E223** - Pending transaction. - **E224** - Failure transaction. - **E225** - Expired request. ``` -------------------------------- ### Payment with Saved Card Request Source: https://documenter.getpostman.com/view/17619441/2s93Xu3644 JSON schema for the payment request using a saved card UID. ```json { "cardUID": "string", "partnerId": "string" } ``` -------------------------------- ### Payment Response Schema Source: https://documenter.getpostman.com/view/17619441/2s93Xu3644 Standard JSON response structure for payment operations. ```json { "clientOrderId": "string", "status": "string", "transactionType": "string", "transactionId": 0, "orderId": 0, "message": "string", "3DS2Url": "string" } ``` -------------------------------- ### Direct Payment Response Schema Source: https://documenter.getpostman.com/view/17619441/2s93Xu3644 JSON response structure for direct payment operations. ```json { "clientOrderId": "dc44f27c-1d48-45d9-8621-0012", "transactionType": "PreAuth", "transactionId": 64557, "orderId": 141522, "toProcessId": "328062136516", "status": "APPROVED", "statusCode": "00", "message": "APPROVED" } ``` -------------------------------- ### POST /api/IntegratedPayments/Order/{OrderId}/DirectPayment Source: https://documenter.getpostman.com/view/17619441/2s93Xu3644 Processes a payment using card details directly (non-saved card). ```APIDOC ## POST /api/IntegratedPayments/Order/{OrderId}/DirectPayment ### Description The API is processing payment with non-saved card. ### Method POST ### Endpoint https://test-vpos.unitedpayment.az/api/IntegratedPayments/Order/{OrderId}/DirectPayment ### Parameters #### Path Parameters - **OrderId** (string) - Required - The unique identifier of the order. #### Request Body - **PAN** (string) - Required - Card Pan Number - **CVV** (string) - Required - CVV of card - **expiredDate** (string) - Required - Expiration of card - **partnerId** (string) - Optional - Partner identifier ### Request Example { "PAN": "4169737756227308", "CVV": "101", "expiredDate": "1025", "partnerId": "string" } ### Response #### Success Response (200) - **clientOrderId** (string) - Client order identifier - **transactionType** (string) - Type of transaction - **transactionId** (number) - Unique transaction ID - **orderId** (number) - Order ID - **toProcessId** (string) - Process identifier - **status** (string) - Transaction status - **statusCode** (string) - Status code - **message** (string) - Response message #### Response Example { "clientOrderId": "dc44f27c-1d48-45d9-8621-0012", "transactionType": "PreAuth", "transactionId": 64557, "orderId": 141522, "toProcessId": "328062136516", "status": "APPROVED", "statusCode": "00", "message": "APPROVED" } ``` -------------------------------- ### Direct Payment Request Schema Source: https://documenter.getpostman.com/view/17619441/2s93Xu3644 JSON schema for processing a payment with a non-saved card. ```json { "PAN": "string", "CVV":"string", "expiredDate":"string", "partnerId": "string" } ``` -------------------------------- ### POST /api/IntegratedPayments/Order/{OrderId}/PaymentWithSaveCard Source: https://documenter.getpostman.com/view/17619441/2s93Xu3644 Processes a payment using a previously saved card identified by its unique ID. ```APIDOC ## POST /api/IntegratedPayments/Order/{OrderId}/PaymentWithSaveCard ### Description The API is processing payment with saved card. ### Method POST ### Endpoint https://test-vpos.unitedpayment.az/api/IntegratedPayments/Order/{OrderId}/PaymentWithSaveCard ### Parameters #### Path Parameters - **OrderId** (string) - Required - The unique identifier of the order. #### Request Body - **cardUID** (string) - Required - VPOS card unique id - **partnerId** (string) - Required - Partner identifier ### Request Example { "cardUID": "string", "partnerId": "string" } ### Response #### Success Response (200) - **clientOrderId** (string) - Client order identifier - **status** (string) - Transaction status - **transactionType** (string) - Type of transaction - **transactionId** (number) - Unique transaction ID - **orderId** (number) - Order ID - **message** (string) - Response message - **3DS2Url** (string) - URL for 3DS2 authentication #### Response Example { "clientOrderId": "string", "status": "string", "transactionType": "string", "transactionId": 0, "orderId": 0, "message": "string", "3DS2Url": "string" } ``` === COMPLETE CONTENT === This response contains all available snippets from this library. No additional content exists. Do not make further requests.