This application allows you to perform easily and securely many transactions, such as online pruchase, instant money loading to company`s wallet accounts, money transfers via Virtual POS and Kiosk.
\nTop up instantly your virtual wallet account from your bank card or kiosk terminals.
\nLoad money to your wallet account from our contracted kiosk points.
\nGet transaction status of transaction, wallet account information and reconciliation services.
\nApplication provides its API service authentication with JWT (Json Web Token). With the token information sent with the \"Bearer \" prefix or sent token as value and \"x-auth-token\" as key in the header, the services offered by the application can be used.
\nNotes:
\nThe information requested in the body is provided by the United Payment.
\nToken expiration is until 01:00:00 (1 Hour).
\nThen the token must be renewed.
\nRequest (Body raw as JSON):
\nemail - required
\npassword - required
\nDashboard URL : https://test-vpos.unitedpayment.az/client/login
\n","_postman_id":"00815f4e-58f0-4325-8be9-35c83bd82d21"},{"name":"E-commerce API","item":[{"name":"Checkout","id":"8ffc58d9-c0a4-492b-a56b-094aa580902e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"x-auth-token","value":"","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"amount\": 1,\r\n \"successUrl\": \"https://www.success.com\",\r\n \"cancelUrl\": \"https://www.cancel.com\",\r\n \"declineUrl\": \"https://www.decline.com\",\r\n \"webhookUrl\": \"https://www.webhook.com\",\r\n \"clientOrderId\": \"Any unique value.\",\r\n \"clientName\": \"TestClientName\",\r\n \"phoneNumber\": \"TestPhoneNumber\",\r\n \"email\": \"example@gmail.com\",\r\n \"language\": \"EN\",\r\n \"currency\": \"AZN\",\r\n \"description\": \"This is test description.\",\r\n \"partnerId\": \"3\",\r\n \"memberId\": \"Test member id.\",\r\n \"addCard\": false,\r\n \"applePay\": false,\r\n \"additionalInformation\": \"test AdditionalInformation\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://test-vpos.unitedpayment.az/api/transactions/checkout","description":"This api is to get the link to play from a simple iframe.
\nNotes:
\nIf you get unknown error try to remove unnecessary fields (Try first AddCard).
\nIf your user is connected to 1 merchant, you can omit the partnerId parameter.
\nIf your user is connected to multiple merchants, make sure you enter the partnerID parameter correctly.
\nRequest (Body raw as JSON):
\nAmount — Required | Decimal, range 0–10000
\nLanguage — Required | Default: \"EN\"
\nSuccessUrl — Required (when payment is successful end user redirect this url)
\nCancelUrl — Required (when payment is canceled end user redirect this url)
\nDeclineUrl — Required (when payment is declined end user redirect this url)
\nWebhookUrl — Optional | Valid URL, max 1000 chars (If you want webhook firstly need to contact us otherwise webhook will not work if you don't just ignore this field)
\nClientOrderId — Optional (Your unique id for this transaction. This field for help you track transactions.)
\nCurrency — Optional (Use only AZN)
\nPartnerId — Optional
\nDescription — Optional
\nMemberId — Optional
\nAdditionalInformation — Optional
\nEmail — Optional
\nPhoneNumber — Optional
\nClientName — Optional
\nAddCard — Optional | Default: false
\nApplePay — Optional | Default: false (If this true you can see apple or google pay button in the url.)
\nThis api is used to save cards via iframe. If the request is successful, the link is given, and when the request is completed, the success url is given in base64 and the uuid value to be used for that card.
\nNote:
\nIn order to complete the order, the customer who is provided with the link must have at least 1 credit on his card
\nIf your user is connected to 1 merchant, you can omit the partnerId parameter.
\nIf your user is connected to multiple merchants, make sure you enter the partnerID parameter correctly.
\nRequest (Body raw as JSON):
\nSuccessUrl — Required (when payment is successful end user redirect this url)
\nCancelUrl — Required (when payment is canceled end user redirect this url)
\nDeclineUrl — Required (when payment is declined end user redirect this url)
\nWebhookUrl — Optional | Valid URL, max 1000 chars (If you want webhook firstly need to contact us otherwise webhook will not work if you don't just ignore this field)
\nClientOrderId — Optional (Your unique id for this transaction. This field for help you track transactions.)
\nMemberId — Optional (This field is optional but you must send this variable. Also this variable reflect userId from your system.)
\nPartnerId — Optional
\nDescription — Optional
\nLanguage — Optional
\nAdditionalInformation — Optional
\nThis method is used to track the list of registered cards associated with a MemberID. Card data is encrypted under the name CardUid. It is possible to make a payment without entering card data with CardUiD.
\nNote:
\nIf your user is connected to 1 merchant, you can omit the partnerId parameter.
\nIf your user is connected to multiple merchants, make sure you enter the partnerID parameter correctly.
\nRequest (Body raw as JSON):
\nMemberId — Optional (If you want to get the correct card UiD, make sure you submit this field)
\nPartnerId — Optional
\nThe method is used to delete saved cards where the customer has sent their UiD and MemberId.
\nNote:
\nIf your user is connected to 1 merchant, you can omit the partnerId parameter.
\nIf your user is connected to multiple merchants, make sure you enter the partnerID parameter correctly.
\nRequest (Body raw as JSON):
\nMemberId — Optional (If you want to delete the correct saved card, make sure you submit this field)
\nCardUID — Optional (If you want to delete the correct saved card, make sure you submit this field)
\nPartnerId — Optional
\nThis method is used to perform a recurring payment transaction with a memory card. The recurring payment will go directly.
\nNotes:
\nWhen this api is called, the application is executed without opening the Bank iframe.
\nFor card memory, the customer must use the card registration recurring service.
\nIf your user is connected to 1 merchant, you can omit the partnerId parameter.
\nIf your user is connected to multiple merchants, make sure you enter the partnerID parameter correctly.
\nRequest (Body raw as JSON):
\nAmount — Required | Decimal, range 0–10000
\nCardUID — Required (This parameter can be obtained from the card registration recurring service.)
\nClientOrderId — Optional (Your unique id for this transaction. This field for help you track transactions.)
\nLanguage — Optional
\nPartnerId — Optional
\nDescription — Optional
\nAdditionalInformation — Optional
\nMemberId — Optional
\nBlocking the requested amount from the customer's card. After the goods or services are provided, a PreauthCompletion request is sent to resolve this transaction.
\nNotes:
\nIf PreauthCompletion does not occur within 30 days, the Preauth transaction is automatically canceled.
\nIf your user is connected to 1 merchant, you can omit the partnerId parameter.
\nIf your user is connected to multiple merchants, make sure you enter the partnerID parameter correctly.
\nRequest (Body raw as JSON):
\nAmount — Required | Decimal, range 0–10000
\nLanguage — Required | Default: \"EN\"
\nSuccessUrl — Required (when payment is successful end user redirect this url)
\nCancelUrl — Required (when payment is canceled end user redirect this url)
\nDeclineUrl — Required (when payment is declined end user redirect this url)
\nWebhookUrl — Optional | Valid URL, max 1000 chars (If you want webhook firstly need to contact us otherwise webhook will not work if you don't just ignore this field)
\nClientOrderId — Optional (Your unique id for this transaction. This field for help you track transactions.)
\nCurrency — Optional (Use only AZN)
\nPartnerId — Optional
\nMemberId — Optional
\nAdditionalInformation — Optional
\nPayment of the blocked amount (Preauth) from the customer's card. The completion of the pre-authorization will be in full or in part of the transaction amount.
\nNotes:
\nIt is possible to complete with a lower amount than the amount in the pre-authorization. However, it is possible to complete only once.
\nIt is possible to complete with more than the amount previously authorized. However, in this case, it is only possible to top up 15% more than that amount.
\nIf you use clientOrderId, it must be absolutely unique.
\nIf your user is connected to 1 merchant, you can omit the partnerId parameter.
\nIf your user is connected to multiple merchants, make sure you enter the partnerID parameter correctly.
\nRequest (Body raw as JSON):
\nTransactionId — Required | Integer
\nAmount — Required | Decimal, range 0–10000
\nLanguage — Required | Default: \"EN\"
\nPartnerId — Optional | max 35 chars
\nAdditionalInformation — Optional
\nClientOrderId — Optional | max 499 chars (Your unique id for this transaction. This field for help you track transactions.)
\nThis API gives you a link to pay, after clicking on that link you can get a code to pay with the terminal, pay with a card, or send the link with QR.
\nNotes:
\nRequest (Body raw as JSON):
\nAmount — Required | Decimal, range 0–10000
\nInstallment — Optional | Integer, range 1–50, default: 1
\nDescription — Optional
\nEmail — Optional (A link will be sent as a message to the email you entered here.)
\nTelephone — Optional
\nMemberId — Optional
\nOrderId — Optional (Your unique id for this transaction. This field for help you track transactions.)
\nSuccessUrl — Optional | Nullable
\nDeclineUrl — Optional | Nullable
\nCancelUrl — Optional | Nullable
\nThis API is being considered for installment payments, where the new payment is split into 3, 6, 9, etc. installments on the card side.
\nRequest (Body raw as JSON):
\nAmount — Required | Decimal, range 0–10000
\nLanguage — Required
\nSuccessUrl — Required (when payment is successful end user redirect this url)
\nCancelUrl — Required (when payment is canceled end user redirect this url)
\nDeclineUrl — Required (when payment is declined end user redirect this url)
\nWebhookUrl — Optional | Valid URL, max 1000 chars (If you want webhook firstly need to contact us otherwise webhook will not work if you don't just ignore this field)
\nClientOrderId — Optional (Your unique id for this transaction. This field for help you track transactions.)
\nInstallment — Required | Integer, range 1–50
\nBankId — Optional (This parameter is to indicate which bank card the payment will be made with. If the parameter is not entered, it is sent to the kapital bank. If you enter 2, it is sent to abb, if you enter 15, it is sent to the kapital bank.)
\nDescription — Optional
\nPartnerId — Optional
\nMemberId — Optional | Nullable
\nAdditionalInformation — Optional | Nullable
\nNotes:
\nTest card info:
\nPAN: 4169 7413 3015 1778
ExpDate: 06/27
CVV2: 591
\nPAN: 5239 1517 4718 3468
ExpDate: 11/27
CVV2: 602
\nPAN: 4169 7388 7920 6542
ExpDate: 11/27
CVV2: 401
Error status codes and meanings:
\n","_postman_id":"d94a48db-55e3-4bf6-ad11-c7b0a7a3b08d"},{"name":"Transfers","item":[{"name":"Transfer with Pan","id":"a18678cf-e278-4350-b256-3cba79bc02a4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"x-auth-token","value":"","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"amount\": 20,\r\n \"pan\": \"4169741370562587\",\r\n \"clientOrderId\": \"23231\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://test-vpos.unitedpayment.az/api/transactions/transfer-to-unsaved-card","description":"This api is for sending the amount from the merchant budget to a specific pan card.
\nNotes:
\nIf your user is connected to 1 merchant, you can omit the partnerId parameter.
\nIf your user is connected to multiple merchants, make sure you enter the partnerID parameter correctly.
\nRequest (Body raw as JSON):
\nAmount — Required | Must be greater than 0.009
\nPan — Required
\nPartnerId — Optional
\nClientOrderId — Optional
\nAdditionalInformation — Optional
\nMemberId — Optional
\nÖdənişin geri qaytarılması servisi
\n","urlObject":{"path":["transactions","transfer-to-saved-card"],"host":["https://test-vpos.unitedpayment.az/api"],"query":[],"variable":[]}},"response":[],"_postman_id":"7af6a6ea-0972-4b8f-bc9c-e30bd371e602"},{"name":"Transfer with unsaved card ATB","id":"00f516c6-c6ac-4ba4-ab6b-100edb151608","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"x-auth-token","value":"","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"amount\": 0.01,\r\n \"pan\": \"4169738819066873\",\r\n \"clientOrderId\": \"23231\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://test-vpos.unitedpayment.az/api/transactions/v3/transfer-to-unsaved-card","description":"Ödənişin geri qaytarılması servisi
\n","urlObject":{"path":["transactions","v3","transfer-to-unsaved-card"],"host":["https://test-vpos.unitedpayment.az/api"],"query":[],"variable":[]}},"response":[],"_postman_id":"00f516c6-c6ac-4ba4-ab6b-100edb151608"}],"id":"a34de9e3-cbcb-44d8-85f1-8ebd6ad6f582","description":"Transfer is used to send money from the merchant's account to the end user's card.
\nYou can perform this transfer either by using the card PAN or the UID of a saved card. To save a card and obtain its UID, you can use Card Registration Recurring, or Checkout (to save a card via Checkout, the AddCard field must be sent as true).
\nTo use the transfer service, you must contact us and have the configuration of the merchant account that will perform the transfers enabled. Otherwise, you will receive an \"Access Denied\" error.
\nIf your transfer balance is 0, your transfer transaction will be declined. If you increase your balance using the Top Up APIs, the added amount cannot be used for transfers on the same day. The balance will become available for transfer transactions on the next day.
\nThere are two types of transfers.
\nThe first type is Surcharge. In this model, the transaction commission is charged to the merchant. For example, if the commission is set to 10% and a transfer of 100 AZN is made, the end user's card receives 100 AZN, while the merchant's balance decreases by 110 AZN (100 AZN transfer amount + 10 AZN commission).
\nThe second type is Service Fee. In this model, the commission is charged to the end user. For example, if the commission is 10% and a transfer of 100 AZN is made, the end user receives 90 AZN, while 10 AZN is deducted as the commission fee. The merchant's balance decreases by 100 AZN.
\nThe method is used to check the status of processed transaction in United Payment system.
\norderId (tnx ID in Merchant system) should be given in the body.Sifariş nömrəsinə görə axtarış
\n","urlObject":{"path":["transactions","transaction-status-by-order-id-detailed"],"host":["https://test-vpos.unitedpayment.az/api"],"query":[],"variable":[]}},"response":[{"id":"1b192fa0-86dd-4950-b37e-220e2d1f52b6","name":"TransactionStatusByOrderId Example","originalRequest":{"method":"POST","header":[{"key":"x-auth-token","value":"","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"transactionId\": 273\r\n}","options":{"raw":{"language":"json"}}},"url":"https://test-vpos.unitedpayment.az/api/transactions/transaction-status-by-trx-id"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"X-Powered-By","value":"Express"},{"key":"X-XSS-Protection","value":"0"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Allow-Headers","value":"Origin, X-Requested-With, Content-Type, Accept, x-auth-token"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Access-Control-Allow-Methods","value":"POST, GET, DELETE, PUT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"40"},{"key":"ETag","value":"W/\"28-MFE266gNvuP+zFr2CSXnTlSY27c\""},{"key":"Date","value":"Tue, 11 Oct 2022 06:01:37 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"msg\": \"No token. Authorization denied\"\n}"}],"_postman_id":"5be1a93f-04c1-448e-aca1-0268b33991fa"},{"name":"TransactionStatusByTransactionId","id":"b2f8ae19-9201-4317-9e9c-cf5196d0b67e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"x-auth-token","value":"","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"transactionId\": 275\r\n}","options":{"raw":{"language":"json"}}},"url":"https://test-vpos.unitedpayment.az/api/transactions/transaction-status-by-trx-id","description":"The method is used to check the status of processed transaction in United Payment system.
\nprocessGuid (tnx ID in United Payment system) should be given in the body.Əməliyyat nömrəsinə görə axtarış
\n","urlObject":{"path":["transactions","transaction-status-by-trx-id-detailed"],"host":["https://test-vpos.unitedpayment.az/api"],"query":[],"variable":[]}},"response":[{"id":"522c4995-f2d4-4369-a9bd-5ca1e199a5ed","name":"TransactionStatusByTransactionId Example","originalRequest":{"method":"POST","header":[{"key":"x-auth-token","value":"","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"transactionId\": 275\r\n}","options":{"raw":{"language":"json"}}},"url":"https://test-vpos.unitedpayment.az/api/transactions/transaction-status-by-trx-id"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"X-Powered-By","value":"Express"},{"key":"X-XSS-Protection","value":"0"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Allow-Headers","value":"Origin, X-Requested-With, Content-Type, Accept, x-auth-token"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Access-Control-Allow-Methods","value":"POST, GET, DELETE, PUT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"40"},{"key":"ETag","value":"W/\"28-MFE266gNvuP+zFr2CSXnTlSY27c\""},{"key":"Date","value":"Tue, 11 Oct 2022 05:57:38 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"msg\": \"No token. Authorization denied\"\n}"}],"_postman_id":"60a40264-1725-4517-a9ad-0f689d46a4fa"}],"id":"1450c6ac-3e70-4958-9751-26569c8d7faa","_postman_id":"1450c6ac-3e70-4958-9751-26569c8d7faa","description":""},{"name":"Reconciliation","item":[{"name":"GetAggrementDetail","id":"a8d36f5c-6a6e-4861-ae2a-1d1c3a6ce144","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"x-auth-token","value":"","type":"text"}],"url":"https://test-vpos.unitedpayment.az/api/aggrement/GetAggrementDetail?startDate=01/06/2023&endDate=06/06/2023","urlObject":{"path":["aggrement","GetAggrementDetail"],"host":["https://test-vpos.unitedpayment.az/api"],"query":[{"key":"startDate","value":"01/06/2023"},{"key":"endDate","value":"06/06/2023"},{"disabled":true,"key":"partnerId","value":"33801"}],"variable":[]}},"response":[],"_postman_id":"a8d36f5c-6a6e-4861-ae2a-1d1c3a6ce144"},{"name":"GetAggrementSummary","id":"fce65100-645f-487a-8943-42dffaaafaad","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"x-auth-token","value":""}],"url":"https://test-vpos.unitedpayment.az/api/aggrement/GetAggrementSummary?startDate=20/04/2023&endDate=06/07/2024","urlObject":{"path":["aggrement","GetAggrementSummary"],"host":["https://test-vpos.unitedpayment.az/api"],"query":[{"key":"startDate","value":"20/04/2023"},{"key":"endDate","value":"06/07/2024"},{"disabled":true,"key":"partnerId","value":"33801"}],"variable":[]}},"response":[],"_postman_id":"fce65100-645f-487a-8943-42dffaaafaad"},{"name":"PaginatedAggrementDetail","id":"6dce064a-0f8a-4b33-8cb0-20a55f363b4e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"x-auth-token","value":""}],"url":"https://test-vpos.unitedpayment.az/api/aggrement/PaginatedAggrementDetail ?startDate=20/04/2023&endDate=06/07/2024&pageIndex=0&pageSize=100","urlObject":{"path":["aggrement","PaginatedAggrementDetail "],"host":["https://test-vpos.unitedpayment.az/api"],"query":[{"key":"startDate","value":"20/04/2023"},{"key":"endDate","value":"06/07/2024"},{"key":"pageIndex","value":"0"},{"key":"pageSize","value":"100"},{"disabled":true,"key":"partnerId","value":null}],"variable":[]}},"response":[{"id":"01c22a6a-bb00-495c-a8f7-a65aa4b24ebe","name":"PaginatedAggrementDetail","originalRequest":{"method":"GET","header":[{"key":"x-auth-token","value":""}],"url":{"raw":"https://test-vpos.unitedpayment.az/api/aggrement/PaginatedAggrementDetail?startDate=20/04/2023&endDate=06/07/2025&pageIndex=0&pageSize=10","host":["https://test-vpos.unitedpayment.az/api"],"path":["aggrement","PaginatedAggrementDetail"],"query":[{"key":"startDate","value":"20/04/2023"},{"key":"partnerId","value":null,"type":"text","disabled":true},{"key":"endDate","value":"06/07/2025"},{"key":"pageIndex","value":"0"},{"key":"pageSize","value":"10"}]}},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\n \"data\": {\n \"from\": 0,\n \"index\": 0,\n \"size\": 10,\n \"count\": 6170,\n \"pages\": 617,\n \"items\": [\n {\n \"transactionId\": 38532,\n \"status\": \"CANCELED\",\n \"transactionType\": \"Purchase\",\n \"amount\": 10,\n \"currencyCode\": 944,\n \"createDate\": \"2024-04-30T18:34:21.6487167\",\n \"bankOrderId\": \"776125\",\n \"bankSessionId\": \"89EA562198C31DA93CB83624F28985B9\",\n \"clientOrderId\": \"20\",\n \"settlementDate\": \"2024-04-30T12:00:00\"\n },\n {\n \"transactionId\": 38533,\n \"status\": \"CANCELED\",\n \"transactionType\": \"Purchase\",\n \"amount\": 10,\n \"currencyCode\": 944,\n \"createDate\": \"2024-04-30T18:34:33.6645883\",\n \"bankOrderId\": \"776126\",\n \"bankSessionId\": \"D3E2852EE09C7861074364C1BB6DF179\",\n \"clientOrderId\": \"21\",\n \"settlementDate\": \"2024-04-30T12:00:00\"\n },\n {\n \"transactionId\": 38580,\n \"status\": \"CANCELED\",\n \"transactionType\": \"Purchase\",\n \"amount\": 100,\n \"currencyCode\": 944,\n \"createDate\": \"2024-05-02T09:52:00.5067553\",\n \"bankOrderId\": \"776654\",\n \"bankSessionId\": \"4E690571F3C3C615E7869E48A08599D7\",\n \"clientOrderId\": \"23\",\n \"settlementDate\": \"2024-05-02T12:00:00\"\n },\n {\n \"transactionId\": 38581,\n \"status\": \"CANCELED\",\n \"transactionType\": \"Purchase\",\n \"amount\": 100,\n \"currencyCode\": 944,\n \"createDate\": \"2024-05-02T09:52:02.8140892\",\n \"bankOrderId\": \"776655\",\n \"bankSessionId\": \"73842DADD1C803B99F4F0AD3EEFE9F48\",\n \"clientOrderId\": \"24\",\n \"settlementDate\": \"2024-05-02T12:00:00\"\n },\n {\n \"transactionId\": 38582,\n \"status\": \"CANCELED\",\n \"transactionType\": \"Purchase\",\n \"amount\": 20,\n \"currencyCode\": 944,\n \"createDate\": \"2024-05-02T09:53:48.1031215\",\n \"bankOrderId\": \"776656\",\n \"bankSessionId\": \"E766A043D110A3CE11F81F10DA92E167\",\n \"clientOrderId\": \"25\",\n \"settlementDate\": \"2024-05-02T12:00:00\"\n },\n {\n \"transactionId\": 38606,\n \"status\": \"CANCELED\",\n \"transactionType\": \"Purchase\",\n \"amount\": 0.01,\n \"currencyCode\": 944,\n \"createDate\": \"2024-05-03T07:50:57.8124981\",\n \"bankOrderId\": \"776934\",\n \"bankSessionId\": \"1622327652A5AC2377BE6D06802CBF59\",\n \"clientOrderId\": \"0110\",\n \"settlementDate\": \"2024-05-05T12:00:00\"\n },\n {\n \"transactionId\": 38622,\n \"status\": \"APPROVED\",\n \"transactionType\": \"Purchase\",\n \"amount\": 10,\n \"currencyCode\": 944,\n \"createDate\": \"2024-05-03T12:44:56.7476109\",\n \"toProcessId\": \"17366557\",\n \"bankOrderId\": \"777032\",\n \"bankSessionId\": \"17E0E32BD2D8FF270CBDE65850EE3C00\",\n \"clientOrderId\": \"27\",\n \"settlementDate\": \"2024-05-05T12:00:00\"\n },\n {\n \"transactionId\": 38623,\n \"status\": \"APPROVED\",\n \"transactionType\": \"Purchase\",\n \"amount\": 10,\n \"currencyCode\": 944,\n \"createDate\": \"2024-05-03T12:46:55.4670737\",\n \"toProcessId\": \"17366562\",\n \"bankOrderId\": \"777039\",\n \"bankSessionId\": \"EB4060775088A0C2D78E62337C8E3F02\",\n \"clientOrderId\": \"28\",\n \"settlementDate\": \"2024-05-05T12:00:00\"\n },\n {\n \"transactionId\": 38628,\n \"memberId\": \"1382241\",\n \"status\": \"CANCELED\",\n \"transactionType\": \"Purchase\",\n \"amount\": 200,\n \"currencyCode\": 944,\n \"createDate\": \"2024-05-06T08:38:05.3492578\",\n \"bankOrderId\": \"777428\",\n \"bankSessionId\": \"CD290634E6203B74D250F0171C27EDB5\",\n \"clientOrderId\": \"78091-4402-6277-6844-0882-8931-0615-7847\",\n \"settlementDate\": \"2024-05-06T12:00:00\"\n },\n {\n \"transactionId\": 38629,\n \"memberId\": \"1382241\",\n \"status\": \"CANCELED\",\n \"transactionType\": \"Purchase\",\n \"amount\": 200,\n \"currencyCode\": 944,\n \"createDate\": \"2024-05-06T08:40:08.7509823\",\n \"bankOrderId\": \"777430\",\n \"bankSessionId\": \"314906D63304DB6D615F24ED166B0A43\",\n \"clientOrderId\": \"35114-0711-6883-8696-2798-5076-4947-5800\",\n \"settlementDate\": \"2024-05-06T12:00:00\"\n }\n ],\n \"hasPrevious\": false,\n \"hasNext\": true\n },\n \"statusCode\": \"00\",\n \"statusDescription\": \"Success\",\n \"merchantName\": \"United Payment\"\n}"}],"_postman_id":"6dce064a-0f8a-4b33-8cb0-20a55f363b4e"}],"id":"7b0a859b-1530-4194-b1f6-4926f178a134","_postman_id":"7b0a859b-1530-4194-b1f6-4926f178a134","description":""},{"name":"Reverse/Refund","item":[{"name":"Refund","id":"f107b806-01fa-425f-a9e8-2786dd10f554","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"x-auth-token","value":"","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"amount\": \"100\",\r\n \"transactionId\": 555\r\n}","options":{"raw":{"language":"json"}}},"url":"https://test-vpos.unitedpayment.az/api/transactions/refund","description":"Refund service is used to return transaction amount fully or in partial.
\nRefund and partial refund can be made within 90 days.
Refund is completed within 3-5 days at the latest.
Sometimes it is instant or on the same day. This may vary depending on the rules of banks and the end of the day.
During 24 hours reversal service is used for transaction cancellation
\nIf only TransactionId is implemented on json body transaction will be full reversed. Otherwise, transaction will be considered as partial reverse while amount that are less than transaction amount is declared on json body.
\nRevers and partial revers must be done within one day maximum. The amount of transaction is instantly returned to the card at the time of reversal.
\n","urlObject":{"path":["transactions","reverse"],"host":["{{localhost}}"],"query":[],"variable":[]}},"response":[{"id":"cc55b22b-7d98-474d-a9fb-e538f379e596","name":"Reversal Example","originalRequest":{"method":"POST","header":[{"key":"x-auth-token","value":"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VySWQiOiI5OCIsIm5iZiI6MTc0MTA4MzE2NiwiZXhwIjoxNzQxMDg2NzY2LCJpYXQiOjE3NDEwODMxNjYsImlzcyI6InlvdXJpc3N1ZXIxMjMiLCJhdWQiOiJ5b3VyYXVkaWVuY2UxMjMifQ.uz7AQjJC4Yiqjj8HkX9_819kw4LhuR0Km-u9lIzbOYM","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"transactionId\": 275,\r\n \"amount\": 0\r\n}","options":{"raw":{"language":"json"}}},"url":"https://test-vpos.unitedpayment.az/api/transactions/reverse"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"X-Powered-By","value":"Express"},{"key":"X-XSS-Protection","value":"0"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Allow-Headers","value":"Origin, X-Requested-With, Content-Type, Accept, x-access-token"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Access-Control-Allow-Methods","value":"POST, GET, DELETE, PUT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"111"},{"key":"ETag","value":"W/\"6f-6SINkfg2AI8HLtr7nbSU6o1fDJ4\""},{"key":"Date","value":"Wed, 21 Sep 2022 13:05:59 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"REVERSED\",\n \"transaction\": 55421,\n \"bankTransaction\": \"93427\",\n \"cardMask\": \"416973XXXXXX7308\",\n \"message\": \"Successful\"\n}"}],"_postman_id":"7194483e-5911-48f7-be70-43fa36c1586a"}],"id":"ba4b7259-933a-403a-9800-c25367ad623c","_postman_id":"ba4b7259-933a-403a-9800-c25367ad623c","description":""},{"name":"Integrated Payment","item":[{"name":"Create Order","id":"11cc8243-0aaf-42b3-ad5c-e212d4a8770f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"x-auth-token","value":"","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"transactionType\": \"string\", //TransactionType [\"Purchase\"],[\"PreAuth\"],[\"Installment\"],[\"CardRegistration\"]\r\n \"AddCard\": false,\r\n \"amount\": 1.5,\r\n \"Otptype\": false, //OtpType true - [\"WithOtp\"],false - [\"nonOtp\"]\r\n \"callbackUrl\":\"string\", //If Otptype is true, this parameter is mandatory.\r\n \"CvvType\":false,\r\n \"language\": \"string\",\r\n \"currency\": \"string\",\r\n \"clientOrderId\": \"string\",\r\n \"description\": \"string\",\r\n \"installment\": 0,\r\n \"partnerId\": \"string\",\r\n \"memberId\": \"string\",\r\n \"countryCode\":\"string\",\r\n \"binNumber\":\"string\",\r\n \"notificationUrl\": \"string\",\r\n \"executable\": false\r\n}","options":{"raw":{"language":"json"}}},"url":"https://test-vpos.unitedpayment.az/api/IntegratedPayments/Order/Create","description":"The API is designed for creation of H2H transaction
\nTransactionType: Payment process type (required)
\nAddCard: Card registration after direct payment process (optional)
\nAmount: Amount of payment (required)
\nCvvType: (required)
\nOTPType: Transaction OTP validation from issuer bank (required)
\nCallBackUrl: Merchant callback url when OTP process true (optional)
\nLanguage: Language Abbreviation (optional)
\nCurrency: Payment currency type (optional)
\nClientOrderId: Merchant transaction Id (required)
\nDescription: Additional Info (optional)
\nInstallment: Count of Payment Installment (optional). If you want to use installment, you must first write \"Installment\" in the transactionType field.
\nMember ID: customer of merchant (optional)
\nPartner Id: our sub-customer unique ID (optional)
\nFor the countryCode parameter, the expected value for domestic cards is \"AZ\" (required)
\nbinNumber - The first 6 digits of the card to be used for payment (required)
\nnotificationUrl - URL is an optional parameter. If a payment is sent with OTP: true, a webhook request will be sent to the specified notificationUrl but firstly you need notify us for you want to use the webhook.The following request body will be sent to the webhook API:
\nIsSuccess: bool
Message: string
Status: string
BankOrderId: string
TransactionId: int
ClientOrderId: string
ToProcessId: string
Eci: string
TransactionType: string
The webhook request will be sent 12 minutes after the request is made to the /DirectPayment API.
\nThe system will retry sending the request to the notificationUrl up to 12 times until an HTTP 200 OK response is received from the API.
HMAC will be used during authentication. The usage method is as follows:
UP Service (Sender)
Serializes the webhook payload to JSON
\nGenerates an HMAC-SHA256 signature using the JSON string and a shared secret key
\nEncodes the signature as URL-safe Base64 (replacing + with -, / with _, and removing =)
\nSends an HTTP POST request with the payload and signature in the X-Signature header
\nReceiver Application
\nReceives the webhook POST request
\nExtracts the X-Signature header
\nRe-serializes the request body to JSON (exactly as received)
\nGenerates your own HMAC using the same secret key
\nCompares your computed HMAC with the received signature
\nProcesses the webhook only if signatures match
\ntrue, the result of the 3D Secure step is returned by the DirectPayment API. To complete the payment, a request must be made to /IntegratedPayments/{{orderId}}. (optional)The API is processing payment with non-saved card
\nPAN: Card Pan Number (required)
\nCVV: CVV of card (required)
\nExpiredDate: Expiration of card (required)
\nTest card for DirectPayment
\nPAN: 4169737756227308
\nCVV: 660
\nExpiredDate: 10/35
\nAfter the transaction is completed on the OPT (3ds2url) page, a redirect is made to the callbackUrl in Base64 format, as shown below.
\n\nDecode example:
\n{\"IsSuccess\":true,\"Message\":null,\"Status\":\"APPROVED\",\"BankOrderId\":\"141526\",\"TransactionId\":64560,\"ClientOrderId\":\"dc44f27c-1d48-45d9-8621-0004\",\"ToProcessId\":\"818732136545\"}
\n","urlObject":{"path":["IntegratedPayments","Order","{{OrderId}}","DirectPayment"],"host":["https://test-vpos.unitedpayment.az/api"],"query":[],"variable":[]}},"response":[{"id":"b0e1d36b-78f6-44be-8113-8a225e546ce5","name":"Direct Payment","originalRequest":{"method":"POST","header":[{"key":"x-auth-token","value":"Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VySWQiOjExLCJkZWZhdWx0UHJvamVjdElkIjoxMSwicGhvbmUiOiIrOTk0ICg3NykgNzc3IDc3IDc3IiwiaWF0IjoxNjY3MDIxOTk3LCJleHAiOjE2NjcwMjU1OTd9.olgF8QNCsm-OPR9dGuPgQxRSRNS51b1J0Q_u55eNYhw","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"pan\": \"4169737756227308\",\r\n \"cvv\": \"101\",\r\n \"expiredDate\": \"1025\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://test-vpos.unitedpayment.az/api/IntegratedPayments/Order/{OrderId}/DirectPayment"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"X-Powered-By","value":"Express"},{"key":"X-XSS-Protection","value":"0"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Allow-Headers","value":"Origin, X-Requested-With, Content-Type, Accept, x-access-token"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Access-Control-Allow-Methods","value":"POST, GET, DELETE, PUT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"200"},{"key":"ETag","value":"W/\"c8-ydOwGeof23cgOPA4IpcvLOyQk4Y\""},{"key":"Date","value":"Mon, 26 Sep 2022 13:12:40 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"clientOrderId\": \"dc44f27c-1d48-45d9-8621-0012\",\n \"transactionType\": \"PreAuth\",\n \"transactionId\": 64557,\n \"orderId\": 141522,\n \"toProcessId\": \"328062136516\",\n \"status\": \"APPROVED\",\n \"statusCode\": \"00\",\n \"message\": \"APPROVED\"\n}"}],"_postman_id":"3620709d-46fc-483a-bb7d-26b906f190b6"},{"name":"Preauth Completion","id":"9ff03121-ee09-4cd1-ba4e-8a09d74aa415","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"x-auth-token","value":"","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"transactionId\": 0,\r\n \"amount\": 0,\r\n \"language\": \"EN\",\r\n \"partnerId\": \"string\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://test-vpos.unitedpayment.az/api/transactions/preauth-completion","description":"Settlement of the blocked (Preauth) amount from the customer card. Preauthcompletion could be at a full or partial transaction amount.
PreAuth Completion transaction can be only refunded
\nPreAuth Completion can be made up to 15% more than the amount of the PreAuth transaction. It can be increased depending on the situation.
\nWhen set to true in the executable CreateOrder API, the result of the 3D Secure step is returned by the DirectPayment API. To complete the payment, a request must be made to /IntegratedPayments/{{orderId}}.
The Collection is designed for H2H(Host to host) environment
\nPurchase transaction can be reversed and refunded
\nPreAuth transaction can be only full reversed
\nThis API is designed for Apple Pay Transaction Creation
\nThe merchant creates an order by sending a request to perform the Create Order action to Vpos.
\nVpos creates the order and sends a response to the merchant containing the order ID and other data.
\nThis API is designed for online payment through website
\nThe merchant checks via the Apple Pay JavaScript API in the customer’s browser if the Apple Pay payment method is available on the device from which the customer initiated the order.
\nThe merchant creates a session JS object based on the response to the Request Order Information query
\nUsing the Apple Pay JavaScript API through the customer’s browser, the merchant retrieves URLs for verifying the merchant and creating the merchant session from the Apple Pay server
\nstring nullable
\n","type":"text/plain"},"key":"partnerId","value":"Guid"}],"variable":[]}},"response":[],"_postman_id":"55a2f5be-a40d-4b2b-8f7b-86a08a783114"},{"name":"Complete","id":"ee6b8f0a-7d96-400d-9a31-050d2b2484d9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"paymentTokenData\": {\r\n \"data\": \"string\",\r\n \"signature\": \"string\",\r\n \"header\": {\r\n \"publicKeyHash\": \"string\",\r\n \"ephemeralPublicKey\": \"string\",\r\n \"transactionId\": \"string\"\r\n },\r\n \"version\": \"string\"\r\n },\r\n \"partnerId\": \"string\",\r\n \"memberId\": \"string\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://test-vpos.unitedpayment.az/api/TokenPayments/Order/{{orderId}}/ApplePay/Complete","description":"This API is for Apple Pay payment completion
\nPaymentTokenData from Apple pay token is required
\nMember ID represents customer of merchant (optional)
\nPartner Id is our sub-customer unique ID (optional)
\n","urlObject":{"path":["TokenPayments","Order","{{orderId}}","ApplePay","Complete"],"host":["https://test-vpos.unitedpayment.az/api"],"query":[],"variable":[]}},"response":[{"id":"5d086d09-5134-45e7-881a-c16db2398108","name":"Complete","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"paymentTokenData\": {\r\n \"data\": \"string\",\r\n \"signature\": \"string\",\r\n \"header\": {\r\n \"publicKeyHash\": \"string\",\r\n \"ephemeralPublicKey\": \"string\",\r\n \"transactionId\": \"string\"\r\n },\r\n \"version\": \"string\"\r\n },\r\n \"partnerId\": \"string\",\r\n \"memberId\": \"string\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://test-vpos.unitedpayment.az/api/TokenPayments/Order/{{orderId}}/ApplePay/Complete"},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\r\n \"clientOrderId\": \"string\",\r\n \"status\": \"string\",\r\n \"transactionType\": \"string\",\r\n \"transactionId\": 0,\r\n \"orderId\": 0,\r\n \"message\": \"string\"\r\n}"}],"_postman_id":"ee6b8f0a-7d96-400d-9a31-050d2b2484d9"}],"id":"a45d701d-42bb-4c1a-a5f9-4e16e48ad5ce","description":"This collection is responsible for Apple Pay transaction process
\nBaseUrl for Production Environment:https://vpos.unitedpayment.az/api
Additional requirements:
\nThis API is designed for Apple Pay Transaction Creation
\nThe merchant creates an order by sending a request to perform the Create Order action to Vpos.
\nVpos creates the order and sends a response to the merchant containing the order ID and other data.
\nThis API is designed for Apple Pay Transaction Creation
\nThe merchant creates an order by sending a request to perform the Create Order action to Vpos.
\nVpos creates the order and sends a response to the merchant containing the order ID and other data.
\nThis API is designed for Google Pay Transaction Creation
\nThe merchant creates an order by sending a request to perform the Create Order action to Vpos.
\nVpos creates the order and sends a response to the merchant containing the order ID and other data.
\nThe API is for completion of Google Pay payment
\nGenerated token from Google Pay is for paymentTokenData that is required field
\nMember ID represents customer of merchant (optional)
\nPartner Id is our sub-customer unique ID (optional)
\nTest Environment:https://test-vpos.unitedpayment.az/api
Production Environment:https://vpos.unitedpayment.az/api
Data for Google Pay™
gatewayid: ecommercekapitalbank
gatewayMerchantId: testmerch
Note: This gatewayMerchantId is used for providing operations in test environment. After passing sucessfull tests you will get your gatewayMarchantId in production environment.
This API is designed for Google Pay Transaction Creation
\nThe merchant creates an order by sending a request to perform the Create Order action to Vpos.
\nVpos creates the order and sends a response to the merchant containing the order ID and other data.
\nThis API is designed for Google Pay Transaction Creation
\nThe merchant creates an order by sending a request to perform the Create Order action to Vpos.
\nVpos creates the order and sends a response to the merchant containing the order ID and other data.
\n