Aviorapay is a payment gateway optimization and intelligence service that merchants can use to provide a remote and frictionless payment experience.
\nThis documentation will help you get started with integrating Aviorapay but if you have any questions, please do not hesitate to reach out to us via email at info@aviorapay.com
\nPlease be advised that our support team is only available during standard business hours.
\nThese are the BaseUrls for the APIs on different environments:
\nTo access the API, you must acquire your unique API key from the merchant dashboard -> API Keys section in your account. Make sure to use this key as a bearer token in the Authorization header for every request you send.
\nAUTHORIZATION: Bearer Token
Token: {{APIKey}} .
Access your sandbox API key credentials by navigating to your merchant login and checking the 'is sandbox' option, located in the top right corner under merchant profile.
\nTo get to the live API key, uncheck the 'Is Sandbox' option in the top right corner of your merchant dashboard. After unchecking, the page will refresh, and you can generate an API key for live transactions in this environment.\"
\nReiterating, the API keys in Sandbox mode are for testing (when 'is sandbox' is CHECKED in the top right corner under merchant profile). The live API key credentials are for processing actual card transactions in Live mode (when 'is sandbox' is UNCHECKED in the same location)
\nUse these headers on every API call unless noted.
\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[{"content":"Overview","slug":"overview"},{"content":"Environments","slug":"environments"},{"content":"Authentication","slug":"authentication"},{"content":"Request Headers","slug":"request-headers"}],"owner":"54431596","collectionId":"e4d70019-075d-4657-9364-3463dc56cc40","publishedId":"2sBXwwnnYx","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"6C84A8"},"publishDate":"2026-06-24T07:01:56.000Z"},"item":[{"name":"⚙️ Integration Steps","item":[],"id":"62004153-90c9-4655-94e2-6c51f3f222de","description":"To start integrating you should already have your Merchant access to our admin portal and sandbox credentials which you will need to complete the integration.
\nThe first step in getting your integration ready is to check whether all the details about you as a merchant are correct on our Merchant portal. If you detect anomalies, then please contact your Account Manager.
\nStart with sandbox mode (see top right-hand corner on your merchant portal to toggle between modes) and generate API Key, Brand ID and Public Key and also set up the callback URLs for subscribing to webhooks.
\nAPI Key - necessary to send transactions via API
\nBrand ID - needed to send transaction. Use different brand IDs for different shops or brands.
\nPublic Key - needed to signature verification received in headers of the webhook
\nWebhook - recommended to get notifications from our server to your server to inform you of transaction status changes and notifications about transactions. You can check all the details of how our webhooks work on the Webhooks page.
\nAfter finishing your integration, make sure your code is working as intended and test the purchase flow in the staging environment.
\nYou have the opportunity to test the APIs by performing test purchases using the below test cards. We have introduced new test cards from 18th December 2025 onwards, which will have more exhaustive error messages helping you test different types of card transactions.
\nThe cards mentioned above will stop working and the below mentioned cards will be used:
\nNote:
You can enter any expiry month and year which is larger or equal to the current month/year.
You can enter any cvv.
OTP will only be 123456 for 3ds cases.
Currently, only card payment testing is supported in the sandbox environment. Testing Alternative Payment Methods (APMs) is not available in the sandbox at this time.
\nAfter finishing your integration in sandbox mode, set up your production environment by turning off the sandbox mode from merchant dashboard and following the same steps mentioned in step one. Test the integration using small amounts to ensure everything is working.
\nInform your Account Manager when the setup is done to get started with processing live traffic.
\n","auth":{"type":"noauth","isInherited":false},"event":[{"listen":"prerequest","script":{"type":"text/javascript","packages":{},"requests":{},"exec":[""],"id":"12a00859-3e08-480f-9d2f-2442d896e1c9"}},{"listen":"test","script":{"type":"text/javascript","packages":{},"requests":{},"exec":[""],"id":"ee72d64b-7a7a-49a9-a289-5547d20fa23f"}}],"_postman_id":"62004153-90c9-4655-94e2-6c51f3f222de"},{"name":"🔌 Webhooks","item":[{"name":"PayIn","item":[],"id":"669710a2-7795-4a17-a3d7-ee2253a00a63","description":"When a transaction status changes to a terminal state (e.g., paid, refunded, expired), our payment gateway sends a server-to-server POST callback to the merchant's configured Webhook URL.
\nThe callback includes full transaction details so the merchant can update order status in real time.
\nFields Description
\nAviorapay uses RSA key pairs to digitally sign webhooks, ensuring all notifications are both secure and authentic.
\n1. Generate Your Keys
\nClick “Generate Key Pair” in the dashboard.
\nA unique RSA private key and public key are created for your merchant ID.
\n2. Key Storage
\nPrivate Key → Stored securely by Aviorapay (never exposed).
\nPublic Key → Displayed to you once on the screen. Copy and save it for verifying signatures.
\n3. Webhook Signing
\nEvery webhook payload is signed using Aviorapay’s private key.
\nThe signature is included in webhook headers:
\n4. Verification
\nUse your public key to verify the aviorapay-sign header against the webhook body.
\nThis ensures the webhook came from Aviorapay and was not tampered with.
\nThe aviorapay-sign header is a Base64-encoded digital signature generated using your merchant-specific RSA private key.
\nConcatenate the following fields in order:
\n{purchaseId}|{message.status}|{brandId}\n\nExample
\n1234567890|PAID|BRAND_001\n\n2. Signing Algorithm
\nAlgorithm: SHA256withRSA
\nOutput: Base64-encoded signature (sent in the aviorapay-sign header).
\nFrom the webhook JSON body, extract:
\npurchaseId
\nstatus (convert to uppercase)
\nbrandId
\nReconstruct the string in the same format:
{purchaseId}|{message.status}|{brandId}
2. Verification Steps
\nUse your stored public key.
\nDecode the aviorapay-sign header from Base64.
\nVerify using SHA256withRSA.
\nIf verification succeeds, the webhook is authentic and untampered.
\npublic static boolean verifySignature(String message, String signatureBase64, PublicKey publicKey) throws Exception {\n Signature signature = Signature.getInstance(\"SHA256withRSA\");\n signature.initVerify(publicKey);\n signature.update(message.getBytes());\n byte[] signatureBytes = Base64.getDecoder().decode(signatureBase64);\n return signature.verify(signatureBytes);\n}\n\nmessage → The reconstructed string (purchaseId|STATUS|brandId)
\nsignatureBase64 → Value from aviorapay-sign header
\npublicKey → Your saved Aviorapay public key
\nSample Webhook
\n{\n \"message\": {\n \"purchaseId\": \"6808127876673d75156df3e6\",\n \"client\": {\n \"customerId\": \"NA\",\n \"email\": \"daler101@hotmail.com\",\n \"phone\": \"+17808752869\",\n \"full_name\": \"Dale Richardson\",\n \"date_of_birth\": \"1800-01-01\",\n \"street_address\": \"48 AVE , ALBERTA BEACH\",\n \"country\": \"CA\",\n \"city\": \"ALBERTA\",\n \"zip_code\": \"T0E 0A0\",\n \"shipping_street_address\": \" \",\n \"shipping_country\": \"\",\n \"shipping_city\": \"\",\n \"shipping_zip_code\": \"\",\n \"cc\": [],\n \"bcc\": [],\n \"stateCode\": \"AB\"\n },\n \"updated_on\": 1745359929,\n \"type\": \"purchase\",\n \"isFraud\": \"NO\",\n \"paymentMethod\": \"INTERAC,MASTER,VISA,JCB\",\n \"amountUnit\": \"MAJOR\",\n \"errorMsg\": \"Transaction succeeded-APPROVED\",\n \"detailedMsg\": \"Transaction succeeded-APPROVED\",\n \"redirectType\": \"POST\",\n \"force_recurring\": false,\n \"created_on\": 1745359481,\n \"merchantRef\": \"7235\",\n \"merchantName\": \"firstinvestacademy\",\n \"pspReference\": \"pKlSYNsPOdOL2FCmSAjXEOHzDDpSP5\",\n \"bankmid\": \"waverlite\",\n \"bankname\": \"waverlite\",\n \"purchase\": {\n \"currency\": \"CAD\",\n \"products\": [\n {\n \"name\": \"Payment\",\n \"quantity\": 1,\n \"price\": 294,\n \"discount\": 0,\n \"tax_percent\": \"0.00\"\n }\n ],\n \"total\": 294,\n \"language\": \"en\",\n \"notes\": \"Micro+ Plan\",\n \"debt\": 0,\n \"total_formatted\": 1,\n \"expireInMin\": \"43800\",\n \"taxAmount\": 0,\n \"taxPercent\": 0,\n \"request_client_details\": [],\n \"email_message\": \"\"\n },\n \"payment\": {\n \"is_outgoing\": false,\n \"payment_type\": \"PURCHASE\",\n \"amount\": 294,\n \"currency\": \"CAD\",\n \"net_amount\": 294,\n \"fee_amount\": 0,\n \"pending_amount\": 0,\n \"pending_unfreeze_on\": null,\n \"description\": \"\",\n \"paid_on\": 1745359487,\n \"remote_paid_on\": 1745359487\n },\n \"issuer_details\": {\n \"website\": \"\",\n \"legal_street_address\": \"\",\n \"legal_country\": \"\",\n \"legal_city\": \"\",\n \"legal_zip_code\": \"\",\n \"bank_accounts\": [\n {}\n ],\n \"legal_name\": \"FISCOM\",\n \"brand_name\": \"FISCOM\",\n \"registration_number\": \"\",\n \"tax_number\": \"\"\n },\n \"transaction_data\": {\n \"payment_method\": \"\",\n \"flow\": \"payform\",\n \"extra\": {\n \"amount\": 294,\n \"masked_pan\": \"INTERAC\"\n },\n \"country\": \"\",\n \"attempts\": [\n {\n \"client_ip\": \"185.199.101.249\",\n \"type\": \"execute\",\n \"payment_method\": \"INTERAC\",\n \"flow\": \"payform\",\n \"successful\": true,\n \"country\": \"INTERAC\",\n \"processing_time\": 1745359487,\n \"extra\": {\n \"amount\": 294,\n \"masked_pan\": \"INTERAC\"\n }\n }\n ]\n },\n \"status\": \"PAID\",\n \"status_history\": [\n {\n \"status\": \"created\",\n \"timestamp\": 1745359481\n },\n {\n \"status\": \"pending_execute\",\n \"timestamp\": 1745359487\n },\n {\n \"status\": \"payment_in_process\",\n \"timestamp\": 1745359491\n },\n {\n \"status\": \"viewed\",\n \"timestamp\": 1745359500\n },\n {\n \"status\": \"paid 294.0\",\n \"timestamp\": 1745359929\n }\n ],\n \"viewedOn\": 1745359932,\n \"is_test\": false,\n \"brand_id\": \"88f25364-8d96-4c2f-8dae-d4aa2756e4e3\",\n \"send_receipt\": false,\n \"is_recurring_token\": false,\n \"skip_capture\": false,\n \"reference_generated\": \"PS4754\",\n \"reference\": \"7235\",\n \"issued\": \"2025-04-22\",\n \"due\": 1745359481,\n \"refund_upto\": 0,\n \"cc_descriptor\": \"Africhange Technologies\",\n \"fraudScore\": \"NA\",\n \"trustScore\": \"NA\",\n \"fx_Currency\": \"CAD\",\n \"fx_Amount\": \"294.00\",\n \"transFees\": \"0.44\",\n \"refundFee\": \"NA\",\n \"chargeBackFee\": \"NA\",\n \"rollingReserve\": \"0.00\",\n \"cascade_Num\": \"NA\",\n \"debitOrcredit\": \"NA\",\n \"conversionRiskFactorApplied\": \"0\",\n \"payInDetails\": {\n \"name\": \"INTERAC E-TRANSFER\",\n \"emailAddress\": \"transfer@ieft.ca\",\n \"secretQA\": \"q4754199\",\n \"secretAnswer\": \"a4754199\"\n },\n \"paidOn\": 1745359929,\n \"receivedAmt\": 294,\n \"refund_availability\": \"NONE\",\n \"refundable_amount\": 0,\n \"success_redirect\": \"https://firstinvestschool.com/?wc-api=wc_gateway_aviorapay_payments&id=7235&action=paid\",\n \"failure_redirect\": \"https://firstinvestschool.com/?wc-api=wc_gateway_aviorapay_payments&id=7235&action=cancel\",\n \"cancel_redirect\": \"https://firstinvestschool.com/?wc-api=wc_gateway_aviorapay_payments&id=7235&action=cancel\",\n \"success_callback\": \"https://firstinvestschool.com/?wc-api=wc_gateway_aviorapay_payments&id=7235&action=paid\",\n \"failure_callback\": \"\",\n \"creator_agent\": \"Aviorapay Payments for WooCommerce: v1.2.3\",\n \"platform\": \"API\",\n \"created_from_ip\": \"54.229.186.248, 172.70.58.20, 15.158.56.19\",\n \"checkout_url\": \"https://api.aviorapay.com/payments/6808127876673d75156df3e6/\",\n \"direct_post_url\": \"https://api.aviorapay.com/api/v1/p/6808127876673d75156df3e6/\",\n \"mdr\": \"13.52\",\n \"payoutProcess\": false\n },\n \"status\": \"paid\"\n}\n\nWhen a transaction status changes to a terminal state (e.g., paid, pending_review (in development)), our payment gateway sends a server-to-server POST callback to the merchant's configured Webhook URL.
\nThe callback includes full transaction details so the merchant can update order status in real time.
\nAviorapay uses RSA key pairs to digitally sign webhooks, ensuring all notifications are both secure and authentic.
\nClick “Generate Key Pair” in the dashboard.
\nA unique RSA private key and public key are created for your merchant ID
\nPrivate Key → Stored securely by Aviorapay (never exposed).
\nPublic Key → Displayed to you once on the screen. Copy and save it for verifying signatures.
\nEvery webhook payload is signed using Aviorapay’s private key.
\nThe signature is included in webhook headers:
\nUse your public key to verify the aviorapay-sign header against the webhook body.
\nThis ensures the webhook came from Aviorapay and was not tampered with.
\nThe aviorapay-sign header is a Base64-encoded digital signature generated using your merchant-specific RSA private key.
\nConcatenate the following fields in order:
\n{payoutId}|{payload.status}\n\nExample:
\n1234567890|paid\n\n2. Signing Algorithm
\nAlgorithm: SHA256withRSA
\nOutput: Base64-encoded signature (sent in the aviorapay-sign header).
\nFrom the webhook JSON body, extract:
\npayoutId
\npayload.status (convert to lowercase)
\nReconstruct the string in the same format:
{payoutId}|{payload.status}
2. Verification Steps
\nUse your stored public key.
\nDecode the aviorapay-sign header from Base64.
\nVerify using SHA256withRSA.
\nIf verification succeeds, the webhook is authentic and untampered.
\npublic static boolean verifySignature(String message, String signatureBase64, PublicKey publicKey) throws Exception {\n Signature signature = Signature.getInstance(\"SHA256withRSA\");\n signature.initVerify(publicKey);\n signature.update(message.getBytes());\n byte[] signatureBytes = Base64.getDecoder().decode(signatureBase64);\n return signature.verify(signatureBytes);\n}\n\nmessage → The reconstructed string (payoutId|status)
\nsignatureBase64 → Value from aviorapay-sign header
\npublicKey → Your saved Aviorapay public key
\nSample Webhook:
\n{\n \"payload\": {\n \"payoutId\": \"68b02af16c4f71530ae1d73b\",\n \"client\": {\n \"customerId\": \"NA\",\n \"email\": \"ashishm.21190@gmail.com\",\n \"phone\": \"+14377717874\",\n \"full_name\": \"Ashish Mistry\",\n \"country\": \"CA\"\n },\n \"updated_on\": 1756375793,\n \"payoutMethod\": \"PAYOUT-INTERAC-ETRANSFER\",\n \"amountUnit\": \"MAJOR\",\n \"amount\": 6,\n \"errorMsg\": \"\",\n \"purpose\": \"test payout\",\n \"created_on\": 1756375793,\n \"merchantRef\": \"68b02af16c4f71530ae1d73b\",\n \"merchantName\": \"arunsinghal\",\n \"status\": \"PAID\",\n \"status_history\": [\n {\n \"status\": \"created\",\n \"timestamp\": 1756375793\n },\n {\n \"status\": \"paid\",\n \"timestamp\": 1756375810\n }\n ],\n \"currency\": \"CAD\",\n \"fx_Currency\": \"CAD\",\n \"fx_Amount\": \"6.00\",\n \"transFees\": \"0.3\",\n \"paymentOn\": 1756375810,\n \"payOutDetails\": {\n \"name\": \"INTERAC E-TRANSFER\",\n \"emailAddress\": \"ashishm.21190@gmail.com\",\n \"secretQA\": \"q680216471530173202\",\n \"secretAnswer\": \"a680216471530173202\"\n },\n \"taxAmount\": 0,\n \"taxPercent\": 0,\n \"redirectType\": \"POST\",\n \"pendingReview\": \"No\",\n \"surcharge\": 0,\n \"success_callback\": \"https://webhook.site/d7660184-d724-480c-bad0-cf0480f5518e\",\n \"failure_callback\": \"https://webhook.site/d7660184-d724-480c-bad0-cf0480f5518e\",\n \"mdr\": \"0.00\"\n },\n \"status\": \"paid\"\n}\n\nTo receive information about various transaction status and events, you will need to set up an endpoint which accepts payloads sent by Aviorapay. Your endpoint will receive POST requests with content-type: application/json.
\nThe webhook endpoint can be set up on Partner Dashboard -> Webhooks -> New Webhook.
Make sure you save the endpoint by clicking \"Create\".
\nAviorapay will post all payloads to the specified URLs. Please note that if merchant face any issues with accepting the webhook, it will not be resent. Alternatively the merchant can call Aviorapay get status API to verify the status of a purchase.
\n1.Add a New Webhook:
\n2. Provide Details:
\nName: Give the webhook a descriptive name.
\nPayment Method Selection:
\na. Choose a specific payment method or select “All” for universal callbacks.
\na. Provide the callback URL where the event notifications will be sent.
\n3. Select Event Triggers:
\na. Choose from a list of available events (Note: Depending on the payment method, not all events may be available.)
\n4. Save configuration:
\na. Click “Save” to store the webhook settings.**
\nYou can setup one URL for all the events or individual URLs for each of the events. Aviorapay would call the webhooks based on whatever the setup is. If only one URL, the developer will need to extract the message from the payload information.
\nIn case of a success_callback (webhook) or failure_callback (webhook) is given the /purchases API or /createSession API, then priority will be given to API callback webhooks, and not the webhooks set in the merchant dashboard. In other words, the webhooks given in the API will override the webhooks set in the merchant dashboard. The webhook posted would be a JSON object (either purchase or payout object as the case might be) containing the status. This object is the same as the one you will get in the /getStatus API call https://app.aviorapay.com/api/v1/purchases/{purchaseId}/
When a transaction status changes to a terminal state (e.g., paid, refunded, expired), our payment gateway sends a server-to-server POST callback to the merchant's configured Webhook URL.
\nThe callback includes full transaction details so the merchant can update order status in real time.
\nMethod: POST
\nWe add a signature as “aviorapay_sign” or \"aviorapay-sign\" in the webhook header for verifying the payload, If you have already created a public key from your merchant dashboard.
\nTo verify this signature, decrypt the signature with your public key. Compare this with the values which you received in your payload.
\nUse the following method (in Java) for signature verification.
\n private static boolean verify(String message,String signature, PublicKey publicKey) throws Exception \n{\n Signature verifier = Signature.getInstance(\"SHA256withRSA\");\n verifier.initVerify(publicKey);\n verifier.update(message.getBytes());\n return verifier.verify(Base64.getDecoder().decode(signature.getBytes()));\n}\n\nWhere the message is the combination of values which you received in the payload:
\nFor Payins: the message is a combination of purchaseId+\"|\"+status(uppercase)+\"|\"+brandId
Payouts: this message is a combination of p**ayoutId+\"|\"+status(lowercase)**
The signature is the value of the “aviorapay_sign” or \"aviorapay-sign\" you received in webhook.
\nYou can obtain the Public Key from your merchant dashboard.
\nThe lifecycle of a transaction is reflected through the status of the transaction.
\nThis section details various statuses of a transaction and what it means and when does it appears.
\nThe status of a transaction can be read from the \"status\" field of the responses or webhook payload.
Note:
\nIf you want a more detailed error message, please rely on the \"errorMsg\" field in the responses or webhook payload.
\n","auth":{"type":"noauth","isInherited":false},"event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":[""],"id":"2720bb29-627f-457f-b949-7a29ccda4ce8"}},{"listen":"test","script":{"type":"text/javascript","exec":[""],"id":"4920df39-0615-4033-b358-014b15a32810"}}],"_postman_id":"f07b383f-8210-4535-bc6b-8805b70a8d53"}],"id":"9d520b07-4e03-4f49-932d-cc96bbb630df","description":"You will not get Error codes if HTTPS response code is 200 or 202.
\nBelow is the list of possible error codes and the corresponding messages from Aviorapay System
\n{\n \"message\": \"descriptive error message\",\n \"code\": \"error_code\"\n}\n\nAll the Messages possible when \"transaction_error\" is in reponse:
\n","auth":{"type":"noauth","isInherited":false},"event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":[""],"id":"aa89f70d-f4a9-4798-a626-fb5feec09a81"}},{"listen":"test","script":{"type":"text/javascript","exec":[""],"id":"07490d15-25a9-4344-911c-d507014a426c"}}],"_postman_id":"9d520b07-4e03-4f49-932d-cc96bbb630df"},{"name":"Payment Methods","item":[{"name":"💰 APMs (Alternative Payment Methods)","item":[{"name":"🇮🇳 UPI Solution","item":[{"name":"Concepts","item":[],"id":"b17e9369-77b0-46cb-aae1-aeb6b5486935","description":"The Unified Payments Interface (UPI) technology unifies various banking functions, smooth fund routing, and merchant payments under one roof by enabling numerous bank accounts into a single mobile application (of any participating bank).
\nPayIns: Consumers can utilise UPI to transfer funds from their bank account, through their bank’s app or website.
\nPayouts: Facilitate real-time disbursements directly to consumers' accounts by UPI ID, IMPS, RTGS,NEFT.
\nHow it works
\nAviorapay’s UPI PayIn API lets the platforms collect funds from payers through intent flow/payment link without entering the payer's VPA. Suitable for app or mobile-based flows.
\nKey Steps
\nFlow
\nInitiate Transfer Request: The merchant sends a request to the UPI PayIn API to initiate a PayIn (deposit/collections) transaction. This request includes the customer’s email address or mobile number, the amount to be collected, and an optional message.
\nUPI payment options: The API generates a Multiple payment option (PayTM, GPay, PhonePe apps as well by scanning QR code) where end user can select any one payment option to complete the transaction.
\nUser pays using their App: User will then pay the amount using their desired payment app and method through default UPI apps or by scanning the QR code via any bank app)
\nConfirm Transfer Completion: Once the transfer is completed by the end user, the aviorapay would send webhook of payment completion with the status. The balance of merchant would be updated to reflect the new transaction’s outcome.
\nUpdate Merchant’s Account: The merchant would then update (on the merchant’s system) the customer’s account balance to reflect the received funds.
\nHow it works
\nOur APIs enable payouts through various channels, including IMPS, UPI, RTGS, and NEFT, to user's bank accounts.
\nHere are some common use cases, though not limited to these:
\nVendor Payouts: Quickly settle payments for goods or services with your vendors or distributors.
\nPayroll & Reimbursements: Disburse salaries, ad-hoc payments, or employee reimbursements to staff or agents.
\nDisbursements: Facilitate loan or credit disbursements to merchants or consumers' bank accounts via your own or a lender's account.
\n*Key Steps*
\nFlow
\nWe recommend that merchan't validate the bank accounts of their customer's bank account before doing payouts.
\nEnsure that enough balance is there in your merchant account do the payout.
\nThe merchant platform initiates the creation of a payout by passing beneficiary details, along with payout details.
\nBeneficiary's bank details
\nBeneficiary's transfer Type (IMPS, RTGS, NEFT, UPI)
\nBeneficiary's ifsc Code (if transferType is either of IMPS, RTGS, or NEFT)
\nBeneficiary's payee Name (if transferType is either of IMPS, RTGS, or NEFT)
\nBeneficiary's bank Account Number (if transferType is either of IMPS, RTGS, or NEFT)
\nUpon completion of the payout, reaching either a Success or Failure state, Aviorapay notifies the merchant’s platform via webhook, providing the final status of the transaction and additional details.
\nTo Initiate a payment, the very first call to make is /purchases with the required data in the request body.
To generate a Purchase, you are required to provide the Brand ID (in the request body) and API key (in the header) Both can be located in the Dashboard section of your merchant account login.
The request body structure is shown on the request body of the example request shown here.
\nThe following (see table below) are the mandatory parameters that are required to create a purchase request.
\nThis parameter, when passed in the PayIn request, sets the time window within which a customer should make the Interac payment through their bank's app. If a customer doesn't complete the payment within the configured time window, the status of the payment will be marked as 'EXPIRED' in Aviorapay.
\nHowever, in certain cases, a payment made outside of this window could still be successful i.e. customer's account may be debited which would result in inconsistencies among Aviorapay's, merchant's and customer's status of the transaction. To avoid such cases it is advised to set the expiry time limit appropriately and advise the customers to make payment within this window. However, if there is an inconsistency between the status at Aviorapay and at customer's Bank, the merchant and Aviorapay will reconcile the amounts during the settlement.
\nThe merchantRef parameter, although not mandatory, is strongly advised for merchants to specify. Its inclusion offers two significant advantages for the merchant:
Prevention of Duplicate Requests: When a merchantRef is utilized, it acts as a unique identifier. This means that if a second purchase request is made using the same merchantRef (reference number), the system will recognize it and prevent duplicate transactions from occurring. This prevents unintended or duplicate purchases.
Facilitation of Transaction Retrieval: In situations where the response from the initial purchase request times out or the 'purchaseId' isn't received, having the merchantRef allows the merchant to retrieve detailed transaction information. This ensures they can track and access the specific purchase details related to that reference, even if the immediate response was not received.
However, if the merchant does not specify the 'merchantRef' parameter, the platform will automatically assign and use an internal 'purchaseId' as a reference for that transaction.
\nThe paymentMethod parameter identifies which payment solution merchant wants to use to perform a transaction. If parameter is provided, than Aviorapay will perform direct payment with the selected payment method instead of loading Aviorapay URL.
Possible Payment Methods allowed: UPI-QR and UPI-INTENT
\nThis API tells you about all the details of a purchase (PayIn), including its history
\nNote: With respect to bank transfers, the purchase request is synonymous with the PayIn request.
\nyou need to pass the PurchaseID in the API URL
In the response examples you can see instances of both Paid and Error Status purchases.
If there are any issues on the Purchase you can get more details from the transaction_data.attempts.error attribute of the response object
If there are any errors then it'll be in the format of :
\n{\n \"message\": \"descriptive error message\",\n \"code\": \"error_code\"\n}\n\nPlease see the Status Code section for further details.
\n","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"3c5cf351-d112-4376-b758-c6cee9885adb","id":"3c5cf351-d112-4376-b758-c6cee9885adb","name":"PayIn API","type":"folder"}},"urlObject":{"path":["purchases","{purchaseId}",""],"host":["https://app.aviorapay.com/api/v1"],"query":[],"variable":[]}},"response":[{"id":"35d4f2e1-71a9-45ca-af88-73fccd244945","name":"Success","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer Token"}],"url":"https://app.aviorapay.com/api/v1/purchases/{purchaseId}/"},"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":"{\r\n \"purchaseId\": \"66c4667bb993c970367c288a\",\r\n \"client\": {\r\n \"email\": \"deepakdeepaksinghal@gmail.com\",\r\n \"date_of_birth\": \"1970-07-10\",\r\n \"street_address\": \"10 New Burlington Street Apt. 214\",\r\n \"country\": \"IN\",\r\n \"city\": \"London\",\r\n \"zip_code\": \"W1S 3BE\",\r\n \"cc\": [],\r\n \"bcc\": [],\r\n \"stateCode\": \"QLD\"\r\n },\r\n \"updated_on\": 1724147324,\r\n \"type\": \"purchase\",\r\n \"paymentMethod\": \"UPI\",\r\n \"amountUnit\": \"MAJOR\",\r\n \"errorMsg\": \"\",\r\n \"redirectType\": \"POST\",\r\n \"force_recurring\": false,\r\n \"created_on\": 1724147324,\r\n \"merchantRef\": \"66c4667bb993c970367c288a\",\r\n \"merchantName\": \"merchant002\",\r\n \"purchase\": {\r\n \"currency\": \"INR\",\r\n \"products\": [\r\n {\r\n \"name\": \"test\",\r\n \"quantity\": 1.0,\r\n \"price\": 10.0,\r\n \"discount\": 0,\r\n \"tax_percent\": \"0.00\"\r\n }\r\n ],\r\n \"total\": 10.0,\r\n \"language\": \"en\",\r\n \"notes\": \"\",\r\n \"debt\": 0,\r\n \"total_formatted\": 1.0,\r\n \"expireInMin\": \"35\",\r\n \"request_client_details\": [],\r\n \"timezone\": \"MIT\",\r\n \"email_message\": \"\"\r\n },\r\n \"payment\": {\r\n \"is_outgoing\": false,\r\n \"payment_type\": \"PURCHASE\",\r\n \"amount\": 10.0,\r\n \"currency\": \"INR\",\r\n \"net_amount\": 10.0,\r\n \"fee_amount\": 0.0,\r\n \"pending_amount\": 0.0,\r\n \"pending_unfreeze_on\": null,\r\n \"description\": \"\",\r\n \"paid_on\": 1724147324,\r\n \"remote_paid_on\": 1724147324\r\n },\r\n \"issuer_details\": {\r\n \"website\": \"\",\r\n \"legal_street_address\": \"\",\r\n \"legal_country\": \"\",\r\n \"legal_city\": \"\",\r\n \"legal_zip_code\": \"\",\r\n \"bank_accounts\": [\r\n {}\r\n ],\r\n \"legal_name\": \"test6\",\r\n \"brand_name\": \"test6\",\r\n \"registration_number\": \"\",\r\n \"tax_number\": \"\"\r\n },\r\n \"transaction_data\": {\r\n \"payment_method\": \"\",\r\n \"flow\": \"payform\",\r\n \"extra\": {\r\n \"amount\": 10.0,\r\n \"masked_pan\": \"UPI\"\r\n },\r\n \"country\": \"\",\r\n \"attempts\": [\r\n {\r\n \"client_ip\": \"103.59.75.113\",\r\n \"type\": \"execute\",\r\n \"payment_method\": \"UPI\",\r\n \"flow\": \"payform\",\r\n \"successful\": true,\r\n \"country\": \"UPI\",\r\n \"processing_time\": 1724147324,\r\n \"extra\": {\r\n \"amount\": 10.0,\r\n \"masked_pan\": \"UPI\"\r\n }\r\n }\r\n ]\r\n },\r\n \"status\": \"PAYMENT_IN_PROCESS\",\r\n \"status_history\": [\r\n {\r\n \"status\": \"created\",\r\n \"timestamp\": 1724147324\r\n },\r\n {\r\n \"status\": \"pending_execute\",\r\n \"timestamp\": 1724147324\r\n },\r\n {\r\n \"status\": \"payment_in_process\",\r\n \"timestamp\": 1724147324\r\n }\r\n ],\r\n \"is_test\": false,\r\n \"brand_id\": \"c4003b2c-22d4-4dc1-ad0c-c6b54f8c9636\",\r\n \"send_receipt\": false,\r\n \"is_recurring_token\": false,\r\n \"skip_capture\": false,\r\n \"reference_generated\": \"PS10907\",\r\n \"issued\": \"2024-08-20\",\r\n \"due\": 1724147324,\r\n \"refund_upto\": 1725871728,\r\n \"cc_descriptor\": \"test1\",\r\n \"fraudScore\": \"NA\",\r\n \"trustScore\": \"NA\",\r\n \"payInDetails\": {\r\n \"expiration_date\": \"2025-03-27 23:59:59\",\r\n \"qrCode\": \"iVBORw0KGgoAAAANSUhEUgAAAb0AAAG9AQAAAACpVZXpAAAH7UlEQVR4nO1cQY7qSgw0yiJLjpCbJBdDIhIXg5vkCCyzQPi7qtwkM2/zNcsYpIfeQFcvTNtdLtsx/9trtS/wC/wCv8A/AZ9mdnpevb9bt6zj+TWso3Uen17i33nGkgverotN/orP7FoHeHV/AG1nfnoZ+kfYrcdKv8ei/gEMvljxRkQZ4MVi5Ww2nm9LbBF/xnLYd7YVVu3dZ262hPUvA3+CUsCnDesJ39/PHhidtlg5cRFek9+WtSgwPO595ldGI4dTAohX/8ZpG2Hp8MdiQPnjEL7XIWJdEae6BfvgC0SxCGCx2Q2fvf5x5GMDGckRov7X2+8r4NhAvW6O82QrHBBeuGBHHjSHK7rDtDxtv8jD0YERv8PPwAHcRjogbv43/BF/wuZwytgHO9r4serxgbIg7vvzPNALY1GHzXDrwYJji2JgTsvOkY8PxGnDDYeVsPHcYjWoUtx6jF04cjPsa8PmjxWAroMWUbtbdPPHPuGZsOqdX8SfOJXGu26zagVgLILHraTWvOUDjRuuU4jq4a2xj8y9hLd6HaArFcMtD997gVoHJYCRwa8H2HzgWVxBDkoBxR5lraVHxIpgdWXEcjJKHrmw+S2Z071F8gLA+JSGCkwEbISoOFnJHiNtvSAhgc0RpyKmw/BeBqgUFUcJGIPWAZnjY1VXis+bUMdw93McHph0kXedfA/pBfMx5CKLlJCJ9n3+FEkOD1QSiuUyrSWaQfyuc0eS3UElm+m8ZYDNqrCbkQMgMMGWEcCQhdEB6a1Jsps/VgCGybASWTtOFu1Lz8SlD/lsgheepBXFupaUFQEiC4MXzozaRjYQrnhRAksioORDbx8doAAQkfwM3qzrP4MVI3lwRqeEOEgTgc37eyVg5zxFZNAuboR0HlkY5VZdbszbELtk6SpAk/DV44yBB2H5zFSWgR3KPAkSKIHZT3nt6EA4INgPmKJRim/1L1MljKI8zS0NbSwElG5qrX6DwsQkDQh5Kr91prI3V4jfqHUBYKfKH9jPQPbDCpchTkmop/xzgiYi9dULASm2863TQeuxGYuDYVUzmtFOm3tuxaDjA+Fi0AehAZFB0zOpfxikD4Uo7YOw9SFIBYAqkN4UyRnY4ZnNFWnfVlpX7WeTEI8PBGWepDvLZCDPopBZOQVVgj+CCNwaaaoBxP8p/zDloN5jZI/sQABGeYe7ctftyBUAPpmmozqBpAyZ/ArxmXmqfJTqIZVWbLGJJBWAtCXqN8rCqIN1rqh9N0qIs84dGzU2raMAkPEbJjMWt85atJg1fZXZhm7CURyqDvCpWpejnUci4QrxmWSSVQwqRGwT47qdEFQBOPCWpxeCPBulsl55KiyIOM96hiLWw+sAndSQB+1KqQxnjEBmIC+xb2NNjFnJp95RASjimEViKtAiTWoEM1bf1YHK2vKOPR4fiJuLyrIZuk0hNOP6Z9McsxJk8gsJEm44sYEqQHaghvF4fQk9ch+9MXR3aOdRJA9KsJVKDw9k1FbDE1WyiOkUghiwSQlQycmyz5mCRyWgZxAyFU2dJJvxm59RsgerlmS/XXMFgOzfYU3H1OFuSlaRnq288JyuyL5dhLJPB0IBIBa9mbCrOYxaqkqlqPwhlcU1B89Ud/wnklcABjdCmi4dEcoyo1Nrt2yVsDGrGGpqrgNUqY8siQblQXMeOcZv6Ijr1LpYdjWd4wM9h2yYcanE02gRxY3WmSHSxBKP1wFK4NFVz0i0jZUwO2Viz3PHA7nrfD4+8MlRLCRl4NITs42WxPdZxKGQdpXSah/aWQDo5IcJVB2ZhBrHi0UcmjY7eH/8HAWAraaTxMfSAU1ah9E9L8pAVD6tBGQnt/h1bMFGg3fLMdjUwvaMNfMOzCJtR+7wQPWucKBmZjjnV61DjJtxXkJpiO1qOhWAOV/TYhKcUpM2F91rxqGJVrHYdXcXAPIA5dDsIPXwnUZWOxRpgrMjEzORW8GrAnDO4tbE8QnORrCfBeeOMvSk3h/LLR6FgNtIIyui1OglaTAhYXNYamicufGdIx8eqFz9ZTkMYWy8dA1vqRp4Ir/2WcLINlBQAPgkIWQQz0c8OFvlkl8zA5lzGAeHz9+FgO6ii+y9QCRSowHdTtH9xOZTjWBn6asKUK2VvtBaUuFH+R62oAZkObLfKzM71wHCqhyVaFPpIs/emndV+mLfBmtivv85Dg9kAwajE+K3kg8lpq3YA0dlY48GAM+FgDklq7wDoVtUaVT/e/YdJDdiUcPrAHmeFJhemkBKMunZ/y6nZDeYGMKmzB8eCBshHW1T6VhuqdabzmI+P2Tpm1OWAWoei88uSBV+o9G7eimfN4O0f9e/enyg9PgL5Xk9tqDP9OKmKilbCNU0dxL6Wgr4aOlo/yGOagQ7yeZqwYRnXndlxArAnNHfRvbzXlML5ktJmWdij2rgsxAQVlVJMF2xaUCcGuUH6n9SpX3f9XR8IF7qQIiTlUWcznXf5/CRZfflqIGuaxkgDEVqaOyX4+VmnNvic2SyTCi5VRWfdgVUAF5dUVtj6KrpwL545dMX7TNg/LMaeHygnr7YxNM2JcEvVOLJrISKolk9oPpxW7ep+JJodLJqnkpN9Vs1IFxsarqzpLKHsrUXGaW1+vrFfj3w8+BA+iOHA1omrxbCJ9F67IP2oUK04+QFgC2Sq8U7x5CGTyVsaL3LLjIp9ywC/NPrC/wCv8Av8C/A/wCpreUSrYyOqQAAAABJRU5ErkJggg==\"\r\n },\r\n \"refund_availability\": \"NONE\",\r\n \"refundable_amount\": 10.0,\r\n \"success_redirect\": \"https://staging.aviorapay.com/getResponse.jsp?success=true\",\r\n \"failure_redirect\": \"https://staging.aviorapay.com/getResponse.jsp?success=false\",\r\n \"cancel_redirect\": \"\",\r\n \"success_callback\": \"https://staging.aviorapay.com\",\r\n \"failure_callback\": \"https://staging.aviorapay.com\",\r\n \"platform\": \"API\",\r\n \"created_from_ip\": \"103.59.75.113\",\r\n \"checkout_url\": \"https://staging.aviorapay.com/payments/66c4667bb993c970367c288a/\",\r\n \"payoutProcess\": false\r\n}"},{"id":"3f213e5a-bd23-4345-a4f8-2d076bbd7409","name":"Failure","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer Token","type":"text"}],"url":"https://app.aviorapay.com/api/v1/purchases/{purchaseId}/"},"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":"{\r\n \"message\": \"Error Message\",\r\n \"code\": \"error_code\"\r\n}"}],"_postman_id":"e2b97430-5d3e-40e8-a463-c01d8c452163"}],"id":"3c5cf351-d112-4376-b758-c6cee9885adb","description":"API Flow
\n![](\"https://lh7-us.googleusercontent.com/cfWw_RYZ9eZVEKzKjeRW4I_VwbBTyqH78LUrJG6ulp7FkE1pXVD6DZr9MnQXB9KH_oLFasJDb156naCsBc2bgotPaVY7LtGOJNifpTOb5uks3fjAKpgVhU4dsXQmQ7hFKNFIVhZEl2p8fCN1YufsRaA\"){kind=spacer}
\n\nThe merchant initiates the purchase via the create purchase API. If successful, they receive a checkout URL in the response JSON. Sometimes they can also get an object of PayIn Details which they can use to make the payment.
\nThe merchant then has 2 options
\nUpon utilizing the checkout URL, depending on the payment method passed, the user will be presented with several payment choices from which to choose in order to complete the payment:
\nQR Code
\nPhonePe, Googlepay or Paytm intent flow
\nRetrieve the PayIn details in the response JSON (as shown below).
\nAfter a successful or failed payment by the end user, an appropriate webhook would be sent to the merchant. If option 2a was the method employed, the user would be redirected to the appropriate redirect URL.
\nAvailable Payment Methods: UPI-QR and UPI-INTENT
\n","auth":{"type":"noauth","isInherited":false},"event":[{"listen":"prerequest","script":{"type":"text/javascript","packages":{},"requests":{},"exec":[""],"id":"5c2bdad9-bf6d-49dd-b5a9-79ce0e846a3d"}},{"listen":"test","script":{"type":"text/javascript","packages":{},"requests":{},"exec":[""],"id":"61bf8e65-62c8-4304-97bc-99b194599993"}}],"_postman_id":"3c5cf351-d112-4376-b758-c6cee9885adb"},{"name":"Payout","item":[{"name":"PayOut","id":"05e52be4-1b7b-406f-be68-aad74454be16","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Accept","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer Token","type":"text"}],"body":{"mode":"raw","raw":"{\n \"client\": {\n \"email\": \"customer141@gmail.com\",\n \"phone\": \"+91 9634088651\",\n \"country\": \"IN\",\n \"zip_code\": \"302018\",\n \"city\": \"Jaipur\",\n \"street_address\": \"Vaishali Nagar\",\n \"full_name\": \"Rahul Jain\",\n \"stateCode\": \"RJ\"\n },\n \"beneficiaryDetail\": {\n \"bankAccountName\": \"Rahul Jain\",\n \"bankAccountNumber\": \"123456789012\",\n \"ifscCode\": \"HDFC021212\"\n },\n \"payoutMethod\": \"Payout-BANKTRANSFER\",\n \"amount\": 100,\n \"currency\": \"INR\",\n \"purpose\": \"payout for testing\",\n \"success_redirect\": \"https://your.success.redirect.com\",\n \"pending_redirect\": \"https://your.pending.redirect.com\",\n \"failure_redirect\": \"https://your.failure.redirect.com\",\n \"success_callback\": \"https://your.success.callback.com\",\n \"failure_callback\": \"https://your.failure.callback.com\"\n}","options":{"raw":{"language":"json"}}},"url":"https://app.aviorapay.com/api/v1/payout/","description":"To Initiate a payment, the very first API call to make is /payout/ with the required data in the request body.
To generate a Payout, you are required to provide the API key (in the header) can be located in the Dashboard section of your merchant account login.
The request body structure is shown on the request body of the example request shown here.
\nThe following (see table below) are the mandatory parameters that are required to create a Payout request.
\nBank Names:
\nThis API tells you about all the details of a Payout, including its history.
\nyou need to pass the payoutId in the API URL
\nAPI Flow
\n![](\"https://lh7-us.googleusercontent.com/Uxy8jmp5RP-c360-oIMAZy2As8naqJdARgKsWU0x_BtszfJlwdRVM6-obffbtjTABfI9V0hxH4Ad-Ns96We42lIMdL434tTzLJ6aEQBt0dzX_ZXeM4RtG_kmEeem7WIsN520Zh5PS3xTFYNzOmks0ak\")
\n\nThe merchant initiates the payout via the create payout API. If successful, they will receive a paid status in the response. If any additional fields are required from the user, the status would be in pending and the user needs to be redirected to the checkout_url.
\nAfter a successful or failed payment by the end user, an appropriate webhook would be sent to the merchant. If the user would be redirected to the checkout_url for some additional details, once the user clicks on Pay, the user will be redirected to the appropriate redirect URL.
\nAvailable payout methods: PAYOUT-BANKTRANSFER
\n","auth":{"type":"noauth","isInherited":false},"event":[{"listen":"prerequest","script":{"type":"text/javascript","packages":{},"requests":{},"exec":[""],"id":"fc549b52-bf35-4689-a427-8c67657625c7"}},{"listen":"test","script":{"type":"text/javascript","packages":{},"requests":{},"exec":[""],"id":"be900170-a5c5-46bc-8b73-562759f87e62"}}],"_postman_id":"5b384f19-5ee6-40b9-874a-6502a00de091"}],"id":"d5af708c-c10f-41e9-919e-22e398c1fab3","auth":{"type":"noauth","isInherited":false},"event":[{"listen":"prerequest","script":{"type":"text/javascript","packages":{},"requests":{},"exec":[""],"id":"98e0a267-ce8e-4c9b-9f4c-f09a1f1e31ef"}},{"listen":"test","script":{"type":"text/javascript","packages":{},"requests":{},"exec":[""],"id":"22075ed9-f3a3-4512-be6e-12ab6dad570d"}}],"_postman_id":"d5af708c-c10f-41e9-919e-22e398c1fab3","description":""}],"id":"e8a601de-8ff8-4b60-acdb-6cb3d4076aac","_postman_id":"e8a601de-8ff8-4b60-acdb-6cb3d4076aac","description":""},{"name":"3rd Party Cashiers","item":[{"name":"ThirdParty UPI","item":[{"name":"Concepts","item":[],"id":"474e6273-9232-488b-a80d-aab05b9baa26","description":"APM Integration: Merchants integrate with set of Aviorapay APIs to manage both incoming (pay-ins) and outgoing (payouts) funds.
\nAsynchronous Communication: Both payin and payout flows use callback URLs and webhooks to confirm transaction statuses, ensuring the merchant system stays updated.
\nSecure Redirection: Customers are securely redirected from the merchant site to the 3rd-party's cashier page for payments and back to the merchant site upon completion.
\nUPI Payment Options: The integration supports UPI-based payments, presenting customers with choices, like UPI Dynamic QR and UPI intevent via VPA, during the checkout process.
\nBeneficiary Details: For payouts, essential beneficiary details, including the Virtual Payment Address (VPA), must be provided to correctly route funds.
\nCustomer Selection:
The customer selects UPI as the payment method on the merchant’s website.
API Call to Create Purchase:
The merchant system calls the Aviorapay createPurchase API to initiate the transaction.
Redirection to Third-Party Cashier Page:
The customer is redirected to 3rd-party's cashier page using the provided checkout URL.
Payment Options Display:
On the cashier page, the customer is presented with multiple UPI payment options, such as:
UPI Dynamic QR
\nUPI Intent (via VPA)
\nTransaction Execution:
The customer completes the payment using their UPI app.
Callback & Confirmation:
Upon a successful payment, success callback is sent to the merchant’s designated URL. The customer is then redirected back to the merchant’s checkout page, where they see confirmation of a successful payment and an updated balance.
Payout Request Initiation:
The customer initiates a payout request directly on the merchant’s website.
Beneficiary Details Entry:
The customer enters the Virtual Payment Address (VPA) where they wish to receive the payout.
API Call to Process Payout:
The merchant calls the payout API to process the request.
Input: Payout amount, beneficiary details (including VPA), and other required parameters.
\nCallback: A callback URL is set up to receive asynchronous updates.
\nPayout Execution:
Payout is processed to the customer’s specified VPA.
Webhook Notification:
A success webhook is triggered upon the successful completion of the payout.
Balance Update:
Both the customer’s and merchant’s account balances are updated to reflect the transaction.
To Initiate a payment, the very first call to make is /purchases with the required data in the request body.
To generate a Purchase, you are required to provide the Brand ID (in the request body) and API key (in the header) Both can be located in the Dashboard section of your merchant account login.
The request body structure is shown on the request body of the example request shown here.
\nThe following (see table below) are the mandatory parameters that are required to create a purchase request.
\nThis parameter, when passed in the PayIn request, sets the time window within which a customer should make the Interac payment through their bank's app. If a customer doesn't complete the payment within the configured time window, the status of the payment will be marked as 'EXPIRED' in Aviorapay.
\nHowever, in certain cases, a payment made outside of this window could still be successful i.e. customer's account may be debited which would result in inconsistencies among Aviorapay's, merchant's and customer's status of the transaction. To avoid such cases it is advised to set the expiry time limit appropriately and advise the customers to make payment within this window. However, if there is an inconsistency between the status at Aviorapay and at customer's Bank, the merchant and Aviorapay will reconcile the amounts during the settlement.
\nThe merchantRef parameter, although not mandatory, is strongly advised for merchants to specify. Its inclusion offers two significant advantages for the merchant:
Prevention of Duplicate Requests: When a merchantRef is utilized, it acts as a unique identifier. This means that if a second purchase request is made using the same merchantRef (reference number), the system will recognize it and prevent duplicate transactions from occurring. This prevents unintended or duplicate purchases.
Facilitation of Transaction Retrieval: In situations where the response from the initial purchase request times out or the 'purchaseId' isn't received, having the merchantRef allows the merchant to retrieve detailed transaction information. This ensures they can track and access the specific purchase details related to that reference, even if the immediate response was not received.
However, if the merchant does not specify the 'merchantRef' parameter, the platform will automatically assign and use an internal 'purchaseId' as a reference for that transaction.
\nThe paymentMethod parameter identifies which payment solution merchant wants to use to perform a transaction. If parameter is provided, than Aviorapay will perform direct payment with the selected payment method instead of loading Aviorapay URL.
Note: For certain use cases, in addition to long format purchase Id, Aviorapay also provides a 7 digit unique code for each purchase starting with digit 4, eg 4000001
\n“purchaseIdShortCode”: “4000013\"
\n","urlObject":{"path":["purchases",""],"host":["https://app.aviorapay.com/api/v1"],"query":[],"variable":[]}},"response":[],"_postman_id":"6b8fb934-3ab8-417a-aab0-6a5ed46c9e05"},{"name":"Get Status","id":"3b5a20b0-1dce-4ec7-b294-9da924ee49a1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer Token","type":"text"}],"url":"https://app.aviorapay.com/api/v1/purchases/{purchaseId}/","description":"This API tells you about all the details of a purchase (PayIn), including its history
\nNote: With respect to bank transfers, the purchase request is synonymous with the PayIn request.
\nyou need to pass the PurchaseID in the API URL
In the response examples you can see instances of both Paid and Error Status purchases.
If there are any issues on the Purchase you can get more details from the transaction_data.attempts.error attribute of the response object
If there are any errors then it'll be in the format of :
\n{\n \"message\": \"descriptive error message\",\n \"code\": \"error_code\"\n}\n\nPlease see the Status Code section for further details.
\n","urlObject":{"path":["purchases","{purchaseId}",""],"host":["https://app.aviorapay.com/api/v1"],"query":[],"variable":[]}},"response":[{"id":"f7df36ac-08c7-4f20-8e79-0b28f7540eaf","name":"Purchases-success","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer Token"}],"url":"https://app.aviorapay.com/api/v1/purchases/{purchaseId}/"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"purchaseId\": \"66c4667bb993c970367c288a\",\n \"client\": {\n \"email\": \"deepakdeepaksinghal@gmail.com\",\n \"date_of_birth\": \"1970-07-10\",\n \"street_address\": \"10 New Burlington Street Apt. 214\",\n \"country\": \"IN\",\n \"city\": \"London\",\n \"zip_code\": \"W1S 3BE\",\n \"cc\": [],\n \"bcc\": [],\n \"stateCode\": \"QLD\"\n },\n \"updated_on\": 1724147324,\n \"type\": \"purchase\",\n \"paymentMethod\": \"UPI\",\n \"amountUnit\": \"MAJOR\",\n \"errorMsg\": \"\",\n \"redirectType\": \"POST\",\n \"force_recurring\": false,\n \"created_on\": 1724147324,\n \"merchantRef\": \"66c4667bb993c970367c288a\",\n \"merchantName\": \"merchant002\",\n \"purchase\": {\n \"currency\": \"INR\",\n \"products\": [\n {\n \"name\": \"test\",\n \"quantity\": 1,\n \"price\": 10,\n \"discount\": 0,\n \"tax_percent\": \"0.00\"\n }\n ],\n \"total\": 10,\n \"language\": \"en\",\n \"notes\": \"\",\n \"debt\": 0,\n \"total_formatted\": 1,\n \"expireInMin\": \"35\",\n \"request_client_details\": [],\n \"timezone\": \"MIT\",\n \"email_message\": \"\"\n },\n \"payment\": {\n \"is_outgoing\": false,\n \"payment_type\": \"PURCHASE\",\n \"amount\": 10,\n \"currency\": \"INR\",\n \"net_amount\": 10,\n \"fee_amount\": 0,\n \"pending_amount\": 0,\n \"pending_unfreeze_on\": null,\n \"description\": \"\",\n \"paid_on\": 1724147324,\n \"remote_paid_on\": 1724147324\n },\n \"issuer_details\": {\n \"website\": \"\",\n \"legal_street_address\": \"\",\n \"legal_country\": \"\",\n \"legal_city\": \"\",\n \"legal_zip_code\": \"\",\n \"bank_accounts\": [\n {}\n ],\n \"legal_name\": \"test6\",\n \"brand_name\": \"test6\",\n \"registration_number\": \"\",\n \"tax_number\": \"\"\n },\n \"transaction_data\": {\n \"payment_method\": \"\",\n \"flow\": \"payform\",\n \"extra\": {\n \"amount\": 10,\n \"masked_pan\": \"UPI\"\n },\n \"country\": \"\",\n \"attempts\": [\n {\n \"client_ip\": \"103.59.75.113\",\n \"type\": \"execute\",\n \"payment_method\": \"UPI\",\n \"flow\": \"payform\",\n \"successful\": true,\n \"country\": \"UPI\",\n \"processing_time\": 1724147324,\n \"extra\": {\n \"amount\": 10,\n \"masked_pan\": \"UPI\"\n }\n }\n ]\n },\n \"status\": \"PAYMENT_IN_PROCESS\",\n \"status_history\": [\n {\n \"status\": \"created\",\n \"timestamp\": 1724147324\n },\n {\n \"status\": \"pending_execute\",\n \"timestamp\": 1724147324\n },\n {\n \"status\": \"payment_in_process\",\n \"timestamp\": 1724147324\n }\n ],\n \"is_test\": false,\n \"brand_id\": \"c4003b2c-22d4-4dc1-ad0c-c6b54f8c9636\",\n \"send_receipt\": false,\n \"is_recurring_token\": false,\n \"skip_capture\": false,\n \"reference_generated\": \"PS10907\",\n \"issued\": \"2024-08-20\",\n \"due\": 1724147324,\n \"refund_upto\": 1725871728,\n \"cc_descriptor\": \"test1\",\n \"fraudScore\": \"NA\",\n \"trustScore\": \"NA\",\n \"payInDetails\": {\n \"qrCode\": \"iVBORw0KGgoAAAANSUhEUgAAAb0AAAG9AQAAAACpVZXpAAAH7UlEQVR4nO1cQY7qSgw0yiJLjpCbJBdDIhIXg5vkCCyzQPi7qtwkM2/zNcsYpIfeQFcvTNtdLtsx/9trtS/wC/wCv8A/AZ9mdnpevb9bt6zj+TWso3Uen17i33nGkgverotN/orP7FoHeHV/AG1nfnoZ+kfYrcdKv8ei/gEMvljxRkQZ4MVi5Ww2nm9LbBF/xnLYd7YVVu3dZ262hPUvA3+CUsCnDesJ39/PHhidtlg5cRFek9+WtSgwPO595ldGI4dTAohX/8ZpG2Hp8MdiQPnjEL7XIWJdEae6BfvgC0SxCGCx2Q2fvf5x5GMDGckRov7X2+8r4NhAvW6O82QrHBBeuGBHHjSHK7rDtDxtv8jD0YERv8PPwAHcRjogbv43/BF/wuZwytgHO9r4serxgbIg7vvzPNALY1GHzXDrwYJji2JgTsvOkY8PxGnDDYeVsPHcYjWoUtx6jF04cjPsa8PmjxWAroMWUbtbdPPHPuGZsOqdX8SfOJXGu26zagVgLILHraTWvOUDjRuuU4jq4a2xj8y9hLd6HaArFcMtD997gVoHJYCRwa8H2HzgWVxBDkoBxR5lraVHxIpgdWXEcjJKHrmw+S2Z071F8gLA+JSGCkwEbISoOFnJHiNtvSAhgc0RpyKmw/BeBqgUFUcJGIPWAZnjY1VXis+bUMdw93McHph0kXedfA/pBfMx5CKLlJCJ9n3+FEkOD1QSiuUyrSWaQfyuc0eS3UElm+m8ZYDNqrCbkQMgMMGWEcCQhdEB6a1Jsps/VgCGybASWTtOFu1Lz8SlD/lsgheepBXFupaUFQEiC4MXzozaRjYQrnhRAksioORDbx8doAAQkfwM3qzrP4MVI3lwRqeEOEgTgc37eyVg5zxFZNAuboR0HlkY5VZdbszbELtk6SpAk/DV44yBB2H5zFSWgR3KPAkSKIHZT3nt6EA4INgPmKJRim/1L1MljKI8zS0NbSwElG5qrX6DwsQkDQh5Kr91prI3V4jfqHUBYKfKH9jPQPbDCpchTkmop/xzgiYi9dULASm2863TQeuxGYuDYVUzmtFOm3tuxaDjA+Fi0AehAZFB0zOpfxikD4Uo7YOw9SFIBYAqkN4UyRnY4ZnNFWnfVlpX7WeTEI8PBGWepDvLZCDPopBZOQVVgj+CCNwaaaoBxP8p/zDloN5jZI/sQABGeYe7ctftyBUAPpmmozqBpAyZ/ArxmXmqfJTqIZVWbLGJJBWAtCXqN8rCqIN1rqh9N0qIs84dGzU2raMAkPEbJjMWt85atJg1fZXZhm7CURyqDvCpWpejnUci4QrxmWSSVQwqRGwT47qdEFQBOPCWpxeCPBulsl55KiyIOM96hiLWw+sAndSQB+1KqQxnjEBmIC+xb2NNjFnJp95RASjimEViKtAiTWoEM1bf1YHK2vKOPR4fiJuLyrIZuk0hNOP6Z9McsxJk8gsJEm44sYEqQHaghvF4fQk9ch+9MXR3aOdRJA9KsJVKDw9k1FbDE1WyiOkUghiwSQlQycmyz5mCRyWgZxAyFU2dJJvxm59RsgerlmS/XXMFgOzfYU3H1OFuSlaRnq288JyuyL5dhLJPB0IBIBa9mbCrOYxaqkqlqPwhlcU1B89Ud/wnklcABjdCmi4dEcoyo1Nrt2yVsDGrGGpqrgNUqY8siQblQXMeOcZv6Ijr1LpYdjWd4wM9h2yYcanE02gRxY3WmSHSxBKP1wFK4NFVz0i0jZUwO2Viz3PHA7nrfD4+8MlRLCRl4NITs42WxPdZxKGQdpXSah/aWQDo5IcJVB2ZhBrHi0UcmjY7eH/8HAWAraaTxMfSAU1ah9E9L8pAVD6tBGQnt/h1bMFGg3fLMdjUwvaMNfMOzCJtR+7wQPWucKBmZjjnV61DjJtxXkJpiO1qOhWAOV/TYhKcUpM2F91rxqGJVrHYdXcXAPIA5dDsIPXwnUZWOxRpgrMjEzORW8GrAnDO4tbE8QnORrCfBeeOMvSk3h/LLR6FgNtIIyui1OglaTAhYXNYamicufGdIx8eqFz9ZTkMYWy8dA1vqRp4Ir/2WcLINlBQAPgkIWQQz0c8OFvlkl8zA5lzGAeHz9+FgO6ii+y9QCRSowHdTtH9xOZTjWBn6asKUK2VvtBaUuFH+R62oAZkObLfKzM71wHCqhyVaFPpIs/emndV+mLfBmtivv85Dg9kAwajE+K3kg8lpq3YA0dlY48GAM+FgDklq7wDoVtUaVT/e/YdJDdiUcPrAHmeFJhemkBKMunZ/y6nZDeYGMKmzB8eCBshHW1T6VhuqdabzmI+P2Tpm1OWAWoei88uSBV+o9G7eimfN4O0f9e/enyg9PgL5Xk9tqDP9OKmKilbCNU0dxL6Wgr4aOlo/yGOagQ7yeZqwYRnXndlxArAnNHfRvbzXlML5ktJmWdij2rgsxAQVlVJMF2xaUCcGuUH6n9SpX3f9XR8IF7qQIiTlUWcznXf5/CRZfflqIGuaxkgDEVqaOyX4+VmnNvic2SyTCi5VRWfdgVUAF5dUVtj6KrpwL545dMX7TNg/LMaeHygnr7YxNM2JcEvVOLJrISKolk9oPpxW7ep+JJodLJqnkpN9Vs1IFxsarqzpLKHsrUXGaW1+vrFfj3w8+BA+iOHA1omrxbCJ9F67IP2oUK04+QFgC2Sq8U7x5CGTyVsaL3LLjIp9ywC/NPrC/wCv8Av8C/A/wCpreUSrYyOqQAAAABJRU5ErkJggg==\",\n \"gpayUri\": \"gpay://upi/pay?ver=01&mode=15&am=5.00&mam=1.00&cu=INR&pa=npstpay@timecosmos&pn=NPST%20PAY&mc=6012&tr=NPST040120220010&tn=QR%20SIT%20testing&mid=NPSTPAY001&msid=NPSTPAY001-001&mtid=NPSTPAY001-001&category=02&url=http://google.com\",\n \"phonepeUri\": \"phonepe://pay?ver=01&mode=15&am=5.00&mam=1.00&cu=INR&pa=npstpay@timecosmos&pn=NPST%20PAY&mc=6012&tr=NPST040120220010&tn=QR%20SIT%20testing&mid=NPSTPAY001&msid=NPSTPAY001-001&mtid=NPSTPAY001-001&category=02&url=http://google.com\",\n \"paytmUri\": \"paytmmp://pay?ver=01&mode=15&am=5.00&mam=1.00&cu=INR&pa=npstpay@timecosmos&pn=NPST%20PAY&mc=6012&tr=NPST040120220010&tn=QR%20SIT%20testing&mid=NPSTPAY001&msid=NPSTPAY001-001&mtid=NPSTPAY001-001&category=02&url=http://google.com\",\n \"generatedLink\": \"https://staging.decf.in/pay/514o5z3m9z\"\n },\n \"refund_availability\": \"NONE\",\n \"refundable_amount\": 10,\n \"success_redirect\": \"https://staging.aviorapay.com/getResponse.jsp?success=true\",\n \"failure_redirect\": \"https://staging.aviorapay.com/getResponse.jsp?success=false\",\n \"cancel_redirect\": \"\",\n \"success_callback\": \"https://staging.aviorapay.com\",\n \"failure_callback\": \"https://staging.aviorapay.com\",\n \"platform\": \"API\",\n \"created_from_ip\": \"103.59.75.113\",\n \"checkout_url\": \"https://staging.aviorapay.com/payments/66c4667bb993c970367c288a/\",\n \"payoutProcess\": false\n}"},{"id":"2e1a248d-be3b-49f6-9286-44472d0a2c66","name":"Purchases","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer Token","type":"text"}],"url":"https://app.aviorapay.com/api/v1/purchases/{purchaseId}/"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Error Message\",\n \"code\": \"error_code\"\n}"}],"_postman_id":"3b5a20b0-1dce-4ec7-b294-9da924ee49a1"}],"id":"f2e0b074-4cc5-49d2-b8cc-2e3409995260","description":"Initiation:
\nMerchant system calls aviorapay Purchases API.
Response: Returns a checkout URL and initiates a callback URL.
\nRedirection:
\nPayment Method Selection:
\nTransaction Processing:
\nSuccess Callback:
\nFinalization:
\nTo Initiate a payment, the very first call to make is /payout/ with the required data in the request body.
To generate a Payout, you are required to provide the API key (in the header) can be located in the Dashboard section of your merchant account login.
The request body structure is shown on the request body of the example request shown here.
\nThe following (see table below) are the mandatory parameters that are required to create a Payout request.
\nThis API tells you about all the details of a Payout, including its history
\nyou need to pass the payoutId in the API URL
\nThe webhook will only be triggered for paid transactions or errors.
\nPaid: \"success_callback\": \"https://success.com\",
\nError: \"failure_callback\": “https://failure.com”
\n","urlObject":{"path":["getpayout","{payoutId}",""],"host":["https://app.aviorapay.com/api/v1"],"query":[],"variable":[]}},"response":[{"id":"152a0eaf-3099-4847-b052-75fb1f9d6a22","name":"Get success Status","originalRequest":{"method":"GET","header":[],"url":"https://app.aviorapay.com/api/v1/getpayout/{payoutId}/"},"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":"{\r\n \"payoutId\": \"66838ae86d41e41c10a8656d\",\r\n \"client\": {\r\n \"email\": \"Yogesh@gmail.com\",\r\n \"phone\": \"766533230591\",\r\n \"full_name\": \"Test Person-uk\",\r\n \"country\": \"CA\"\r\n },\r\n \"updated_on\": 1719896808,\r\n \"payoutMethod\": \"PAYOUT-UPI\",\r\n \"beneficiaryDetail\": {\r\n \"upi\": \"charles.babbage@okhdfc\",\r\n \"transferType\": \"UPI\"\r\n },\r\n \"amountUnit\": \"MAJOR\",\r\n \"amount\": 10.0,\r\n \"errorMsg\": \"\",\r\n \"purpose\": \"test payout\",\r\n \"created_on\": 1719896808,\r\n \"merchantRef\": \"66838ae86d41e41c10a8656d\",\r\n \"merchantName\": \"newMerchant777\",\r\n \"status\": \"PAYOUT_IN_PROCESS\",\r\n \"status_history\": [\r\n {\r\n \"status\": \"created\",\r\n \"timestamp\": 1719896808\r\n },\r\n {\r\n \"status\": \"payout_in_process\",\r\n \"timestamp\": 1719896810\r\n },\r\n {\r\n \"status\": \"viewed\",\r\n \"timestamp\": 1719900796\r\n }\r\n ],\r\n \"viewedOn\": 1719900796,\r\n \"currency\": \"INR\",\r\n \"paymentOn\": 0,\r\n \"success_callback\": \"https://success.com\",\r\n \"failure_callback\": \"https://failure.com\"\r\n}\r\n"},{"id":"d850ee18-3a10-4498-8d47-bad44f973f99","name":"Get Error Status","originalRequest":{"method":"GET","header":[],"url":"https://app.aviorapay.com/api/v1/getpayout/{payoutId}/"},"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":"{\r\n \"message\": \"Error Message\",\r\n \"code\": \"error_code\"\r\n}"}],"_postman_id":"e91f81e7-9eba-43cd-ae30-ee7243d4e1a1"}],"id":"a146a948-36d1-4b07-978e-913a7b962f28","description":"Customer Action:
\nInitiation:
\nMerchant system calls its payout API.
\nInput Data: Includes payout amount, beneficiary details (with VPA), and callback URL.
\nProcessing:
\nWebhook Notification:
\nFinalization:
\nThis is a versatile payment solution that supports both pay-ins (customer payments) and payouts (customer withdrawals) primarily using UPI-based transactions. This integration enables merchants to provide seamless payment experiences on their platforms, offering multiple UPI payment options such as UPI Dynamic QR and UPI Intent (via VPA) payments. The integration leverages asynchronous callbacks and webhooks to ensure real-time transaction status updates and balance synchronization.
\n","_postman_id":"69f9fc09-b1a7-4396-b1d5-abade5dd1142"}],"id":"41201b32-f481-4fd1-aa1e-6c27594a2f05","_postman_id":"41201b32-f481-4fd1-aa1e-6c27594a2f05","description":""}],"id":"ea8c9aab-9875-4de7-9c98-1fee2228513e","_postman_id":"ea8c9aab-9875-4de7-9c98-1fee2228513e","description":""},{"name":"Trust Score","item":[{"name":"TrustScore Detailed","id":"87aa4817-a040-4c14-b16e-97de7f08edc6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"requiredinput\": {\r\n \"ip\": \"111.11.11.11\",\r\n \"email\": \"test@gmail.com\",\r\n \"url\": \"https://www.asos.com/\"\r\n },\r\n \"optionalInput\": {\r\n \"last_bets\": null,\r\n \"last_wins\": \"\",\r\n \"total_bonuses\": \"\",\r\n \"last_real_bets\": \"\",\r\n \"last_real_wins\": \"\",\r\n \"total_deposits\": \"\",\r\n \"last_bonus_bets\": \"\",\r\n \"last_bonus_wins\": \"\",\r\n \"average_real_bet\": \"\",\r\n \"last_bets_amount\": \"\",\r\n \"last_wins_amount\": \"\",\r\n \"average_bonus_bet\": \"\",\r\n \"bonus_to_deposits\": \"\",\r\n \"last_deposit_date\": \"\",\r\n \"total_withdrawals\": \"\",\r\n \"is_phone_confirmed\": \"\",\r\n \"money_in_money_out\": \"\",\r\n \"last_deposit_amount\": \"\",\r\n \"last_freespins_date\": \"\",\r\n \"last_freespins_name\": \"\",\r\n \"last_free_bonus_date\": \"\",\r\n \"last_free_bonus_name\": \"\",\r\n \"total_bonuses_amount\": \"\",\r\n \"last_freespins_amount\": \"\",\r\n \"last_freespins_status\": \"\",\r\n \"last_real_bets_amount\": \"\",\r\n \"last_real_wins_amount\": \"\",\r\n \"total_deposits_amount\": \"\",\r\n \"last_bonus_bets_amount\": \"\",\r\n \"last_bonus_wins_amount\": \"\",\r\n \"last_free_bonus_amount\": \"\",\r\n \"last_free_bonus_status\": \"\",\r\n \"last_deposit_bonus_date\": \"\",\r\n \"last_deposit_bonus_name\": \"\",\r\n \"last_freespins_currency\": \"\",\r\n \"last_freespins_wagering\": \"\",\r\n \"withdrawals_to_deposits\": \"\",\r\n \"last_free_bonus_currency\": \"\",\r\n \"last_free_bonus_wagering\": \"\",\r\n \"total_withdrawals_amount\": \"\",\r\n \"withdrawal_ewallet_email\": \"\",\r\n \"last_deposit_bonus_amount\": \"\",\r\n \"last_deposit_bonus_status\": \"\",\r\n \"last_deposit_bonus_currency\": \"\",\r\n \"last_deposit_bonus_wagering\": \"\",\r\n \"session\": \"\",\r\n \"payment_mode\": \"\",\r\n \"card_fullname\": \"\",\r\n \"card_bin\": \"\",\r\n \"card_hash\": \"\",\r\n \"card_last\": \"\",\r\n \"card_expire\": \"\",\r\n \"avs_result\": \"\",\r\n \"cvv_result\": \"\",\r\n \"sca_method\": \"\",\r\n \"user_bank_account\": \"\",\r\n \"user_bank_name\": \"\",\r\n \"user_balance\": \"\",\r\n \"user_verification_level\": \"\",\r\n \"status_3d\": \"\",\r\n \"regulation\": \"\",\r\n \"payment_provider\": \"\",\r\n \"phone_number\": \"\",\r\n \"transaction_type\": \"\",\r\n \"transaction_amount\": \"\",\r\n \"transaction_currency\": \"\",\r\n \"merchant_id\": \"\",\r\n \"details_url\": \"\",\r\n \"name\": \"\",\r\n \"person_type\": \"\",\r\n \"gender\": \"\"\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"https://app.aviorapay.com/api/v1/trustScore","description":"Aviorapay TrustScore's proprietary API combines email, phone number, IP and URL so that you can request and receive a user trust score from our enriched data, rules, and scoring in a single API call.
\nOur take on Trust is different from the usual approach to fraud. This API tells you how much you can trust this user. It’s based on 100+ data points to which we have access. We use complex algorithms based on data sanity and customer behaviour in our partner network.
\nAlso, the additional optional parameter would be used to boost the accuracy of our response. So the more data we get the better we can ascertain the users' trust. So please endeavour to send as much information about the user as possible.
\nTrustScore offers two distinct endpoints: General and Detailed.
The General endpoint provides basic information by indicating whether a transaction is permitted or not. It gives a simple 'yes' or 'no' response regarding whether the transaction can proceed.
\nOn the other hand, the Detailed endpoint offers a more comprehensive evaluation. It furnishes an in-depth analysis of the transaction's authenticity, providing a detailed assessment beyond a simple allowance or denial, offering nuanced insights and information about the transaction's legitimacy.
\nTrust scores range from 0 to 5. A trust score of 0 indicates that we have limited information about the user, and it corresponds to the lowest level of trust. In addition to the TrustScore, we offer eight other flags to help assess the user's overall profile and determine appropriate actions to take. We suggest flagging or blocking users, transactions, or clicks as high risk based on a combination of the following factors: email deliverability, proxy usage, VPN usage, Tor usage, and recent abusive behavior.
\nEvery company has a unique target audience, so you might achieve better results by only flagging or blocking entities with low trust scores and recent instances of abuse. Keep in mind that mobile IP addresses are frequently misused and recycled by mobile carriers. Therefore, for mobile lookups, we advise giving more weight to the trust score, VPN usage, and Tor usage, as opposed to proxy usage.
\nAccess to this API has to be given to you by the admin. So please contact your sales representative at Aviorapay to get access to this API, if you get a 401 error of \"You are not allowed to call this API service\".
\nThe optional parameters are self-explanatory and appropriate values can be given in string format.
\nIn the response examples, you can observe both instances of a successful TrustScore response and an unsuccessful one.
\nPlease note that there are a lot of parameters to determine the trust level and give you some additional details on the email and IP of the user.
\nin a successful trust score call the following data would be provided:
\nIf there are any errors then it'll be in the format of :
\n{\n \"message\": \"descriptive error message\",\n \"code\": \"error_code\"\n}\n\nthe possible error codes one can get on calling this APIs are:
\nfor example:
\n","urlObject":{"path":["trustScore"],"host":["https://app.aviorapay.com/api/v1"],"query":[],"variable":[]}},"response":[{"id":"3a73c581-edd5-4e59-acc5-d2b2600bd629","name":"TrustScoreExists","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"requiredinput\": {\r\n \"ip\": \"2001:8004:cc2:fadb:9958:4523:6c42:e3f2\",\r\n \"email\": \"test@gmail.com\",\r\n \"url\": \"http://test.com\"\r\n },\r\n \"optionalInput\": {\r\n \"last_bets\": null,\r\n \"last_wins\": \"\",\r\n \"total_bonuses\": \"\",\r\n \"last_real_bets\": \"\",\r\n \"last_real_wins\": \"\",\r\n \"total_deposits\": \"\",\r\n \"last_bonus_bets\": \"\",\r\n \"last_bonus_wins\": \"\",\r\n \"average_real_bet\": \"\",\r\n \"last_bets_amount\": \"\",\r\n \"last_wins_amount\": \"\",\r\n \"average_bonus_bet\": \"\",\r\n \"bonus_to_deposits\": \"\",\r\n \"last_deposit_date\": \"\",\r\n \"total_withdrawals\": \"\",\r\n \"is_phone_confirmed\": \"\",\r\n \"money_in_money_out\": \"\",\r\n \"last_deposit_amount\": \"\",\r\n \"last_freespins_date\": \"\",\r\n \"last_freespins_name\": \"\",\r\n \"last_free_bonus_date\": \"\",\r\n \"last_free_bonus_name\": \"\",\r\n \"total_bonuses_amount\": \"\",\r\n \"last_freespins_amount\": \"\",\r\n \"last_freespins_status\": \"\",\r\n \"last_real_bets_amount\": \"\",\r\n \"last_real_wins_amount\": \"\",\r\n \"total_deposits_amount\": \"\",\r\n \"last_bonus_bets_amount\": \"\",\r\n \"last_bonus_wins_amount\": \"\",\r\n \"last_free_bonus_amount\": \"\",\r\n \"last_free_bonus_status\": \"\",\r\n \"last_deposit_bonus_date\": \"\",\r\n \"last_deposit_bonus_name\": \"\",\r\n \"last_freespins_currency\": \"\",\r\n \"last_freespins_wagering\": \"\",\r\n \"withdrawals_to_deposits\": \"\",\r\n \"last_free_bonus_currency\": \"\",\r\n \"last_free_bonus_wagering\": \"\",\r\n \"total_withdrawals_amount\": \"\",\r\n \"withdrawal_ewallet_email\": \"\",\r\n \"last_deposit_bonus_amount\": \"\",\r\n \"last_deposit_bonus_status\": \"\",\r\n \"last_deposit_bonus_currency\": \"\",\r\n \"last_deposit_bonus_wagering\": \"\",\r\n \"session\": \"\",\r\n \"payment_mode\": \"\",\r\n \"card_fullname\": \"\",\r\n \"card_bin\": \"\",\r\n \"card_hash\": \"\",\r\n \"card_last\": \"\",\r\n \"card_expire\": \"\",\r\n \"avs_result\": \"\",\r\n \"cvv_result\": \"\",\r\n \"sca_method\": \"\",\r\n \"user_bank_account\": \"\",\r\n \"user_bank_name\": \"\",\r\n \"user_balance\": \"\",\r\n \"user_verification_level\": \"\",\r\n \"status_3d\": \"\",\r\n \"regulation\": \"\",\r\n \"payment_provider\": \"\",\r\n \"phone_number\": \"\",\r\n \"transaction_type\": \"\",\r\n \"transaction_amount\": \"\",\r\n \"transaction_currency\": \"\",\r\n \"merchant_id\": \"\",\r\n \"details_url\": \"\",\r\n \"name\": \"\",\r\n \"person_type\": \"\",\r\n \"gender\": \"\"\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"{{StagingBaseURL}}/trustScore"},"status":"Accepted","code":202,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Sun, 29 Oct 2023 09:21:22 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"Cache-Control","value":"no-cache, no-store, max-age=0, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Expires","value":"0"},{"key":"X-Frame-Options","value":"DENY"},{"key":"CF-Cache-Status","value":"DYNAMIC"},{"key":"Report-To","value":"{\"endpoints\":[{\"url\":\"https:\\/\\/a.nel.cloudflare.com\\/report\\/v3?s=r2%2FuLwSilxdD1lpiI1VqpgF0Tu9etiNhupySeBHl0zcU8XV1z8kwR%2FJ00ti4xpMdrTXW%2BkqZkLGrkkaUnMWFsaYlg%2FfA9UC4wIKwmc9LHUwna491EmnC3b3vlabzhUJ11CMpnVmicUE%3D\"}],\"group\":\"cf-nel\",\"max_age\":604800}"},{"key":"NEL","value":"{\"success_fraction\":0,\"report_to\":\"cf-nel\",\"max_age\":604800}"},{"key":"Server","value":"cloudflare"},{"key":"CF-RAY","value":"81da590e8d4345a0-LHR"},{"key":"alt-svc","value":"h3=\":443\"; ma=86400"}],"cookie":[],"responseTime":null,"body":"{\n \"trustScore\": 0,\n \"deliverable\": \"false\",\n \"proxy\": \"false\",\n \"vpn\": \"false\",\n \"tor\": \"false\",\n \"active_vpn\": \"false\",\n \"active_tor\": \"false\",\n \"recent_abuse\": \"false\",\n \"bot_status\": \"false\"\n}"},{"id":"04f31725-7409-40fe-a5d8-170be5342559","name":"TrustScoreError","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"requiredinput\": {\r\n \"ip\": \"2001:8004:cc2:fadb:9958:4523:6c42:e3f2\",\r\n \"email\": \"test@gmail.com\",\r\n \"url\": \"http://test.com\"\r\n },\r\n \"optionalInput\": {\r\n \"last_bets\": null,\r\n \"last_wins\": \"\",\r\n \"total_bonuses\": \"\",\r\n \"last_real_bets\": \"\",\r\n \"last_real_wins\": \"\",\r\n \"total_deposits\": \"\",\r\n \"last_bonus_bets\": \"\",\r\n \"last_bonus_wins\": \"\",\r\n \"average_real_bet\": \"\",\r\n \"last_bets_amount\": \"\",\r\n \"last_wins_amount\": \"\",\r\n \"average_bonus_bet\": \"\",\r\n \"bonus_to_deposits\": \"\",\r\n \"last_deposit_date\": \"\",\r\n \"total_withdrawals\": \"\",\r\n \"is_phone_confirmed\": \"\",\r\n \"money_in_money_out\": \"\",\r\n \"last_deposit_amount\": \"\",\r\n \"last_freespins_date\": \"\",\r\n \"last_freespins_name\": \"\",\r\n \"last_free_bonus_date\": \"\",\r\n \"last_free_bonus_name\": \"\",\r\n \"total_bonuses_amount\": \"\",\r\n \"last_freespins_amount\": \"\",\r\n \"last_freespins_status\": \"\",\r\n \"last_real_bets_amount\": \"\",\r\n \"last_real_wins_amount\": \"\",\r\n \"total_deposits_amount\": \"\",\r\n \"last_bonus_bets_amount\": \"\",\r\n \"last_bonus_wins_amount\": \"\",\r\n \"last_free_bonus_amount\": \"\",\r\n \"last_free_bonus_status\": \"\",\r\n \"last_deposit_bonus_date\": \"\",\r\n \"last_deposit_bonus_name\": \"\",\r\n \"last_freespins_currency\": \"\",\r\n \"last_freespins_wagering\": \"\",\r\n \"withdrawals_to_deposits\": \"\",\r\n \"last_free_bonus_currency\": \"\",\r\n \"last_free_bonus_wagering\": \"\",\r\n \"total_withdrawals_amount\": \"\",\r\n \"withdrawal_ewallet_email\": \"\",\r\n \"last_deposit_bonus_amount\": \"\",\r\n \"last_deposit_bonus_status\": \"\",\r\n \"last_deposit_bonus_currency\": \"\",\r\n \"last_deposit_bonus_wagering\": \"\",\r\n \"session\": \"\",\r\n \"payment_mode\": \"\",\r\n \"card_fullname\": \"\",\r\n \"card_bin\": \"\",\r\n \"card_hash\": \"\",\r\n \"card_last\": \"\",\r\n \"card_expire\": \"\",\r\n \"avs_result\": \"\",\r\n \"cvv_result\": \"\",\r\n \"sca_method\": \"\",\r\n \"user_bank_account\": \"\",\r\n \"user_bank_name\": \"\",\r\n \"user_balance\": \"\",\r\n \"user_verification_level\": \"\",\r\n \"status_3d\": \"\",\r\n \"regulation\": \"\",\r\n \"payment_provider\": \"\",\r\n \"phone_number\": \"\",\r\n \"transaction_type\": \"\",\r\n \"transaction_amount\": \"\",\r\n \"transaction_currency\": \"\",\r\n \"merchant_id\": \"\",\r\n \"details_url\": \"\",\r\n \"name\": \"\",\r\n \"person_type\": \"\",\r\n \"gender\": \"\"\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"{{StagingBaseURL}}/trustScore"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Sun, 29 Oct 2023 09:28:33 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"Cache-Control","value":"no-cache, no-store, max-age=0, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Expires","value":"0"},{"key":"X-Frame-Options","value":"DENY"},{"key":"CF-Cache-Status","value":"DYNAMIC"},{"key":"Report-To","value":"{\"endpoints\":[{\"url\":\"https:\\/\\/a.nel.cloudflare.com\\/report\\/v3?s=herXY1o%2BFZa%2F3qNFjvh4ANgP%2FD0DdAVVFm0vUZDAst2rFkieItm%2Fu0VN24DYrdp7MHMHFKWLvrsBYVIxjDPDaLgJjeGBvlTP2iZoB5EnG1hPPHUVXRNP%2FGMmOTh%2Fp7gsyj0vihW1kMk%3D\"}],\"group\":\"cf-nel\",\"max_age\":604800}"},{"key":"NEL","value":"{\"success_fraction\":0,\"report_to\":\"cf-nel\",\"max_age\":604800}"},{"key":"Server","value":"cloudflare"},{"key":"CF-RAY","value":"81da6398ab144913-LHR"},{"key":"alt-svc","value":"h3=\":443\"; ma=86400"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Incorrect secret_key\",\n \"code\": \"authentication_failed\"\n}"}],"_postman_id":"87aa4817-a040-4c14-b16e-97de7f08edc6"},{"name":"checkTransactionAllowed","id":"59ea737c-20f3-42e8-8fa1-baf34782084b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"requiredinput\": {\r\n \"ip\": \"111.11.11.11\",\r\n \"email\": \"test@gmail.com\",\r\n \"url\": \"https://www.asos.com/\"\r\n },\r\n \"optionalInput\": {\r\n \"last_bets\": null,\r\n \"last_wins\": \"\",\r\n \"total_bonuses\": \"\",\r\n \"last_real_bets\": \"\",\r\n \"last_real_wins\": \"\",\r\n \"total_deposits\": \"\",\r\n \"last_bonus_bets\": \"\",\r\n \"last_bonus_wins\": \"\",\r\n \"average_real_bet\": \"\",\r\n \"last_bets_amount\": \"\",\r\n \"last_wins_amount\": \"\",\r\n \"average_bonus_bet\": \"\",\r\n \"bonus_to_deposits\": \"\",\r\n \"last_deposit_date\": \"\",\r\n \"total_withdrawals\": \"\",\r\n \"is_phone_confirmed\": \"\",\r\n \"money_in_money_out\": \"\",\r\n \"last_deposit_amount\": \"\",\r\n \"last_freespins_date\": \"\",\r\n \"last_freespins_name\": \"\",\r\n \"last_free_bonus_date\": \"\",\r\n \"last_free_bonus_name\": \"\",\r\n \"total_bonuses_amount\": \"\",\r\n \"last_freespins_amount\": \"\",\r\n \"last_freespins_status\": \"\",\r\n \"last_real_bets_amount\": \"\",\r\n \"last_real_wins_amount\": \"\",\r\n \"total_deposits_amount\": \"\",\r\n \"last_bonus_bets_amount\": \"\",\r\n \"last_bonus_wins_amount\": \"\",\r\n \"last_free_bonus_amount\": \"\",\r\n \"last_free_bonus_status\": \"\",\r\n \"last_deposit_bonus_date\": \"\",\r\n \"last_deposit_bonus_name\": \"\",\r\n \"last_freespins_currency\": \"\",\r\n \"last_freespins_wagering\": \"\",\r\n \"withdrawals_to_deposits\": \"\",\r\n \"last_free_bonus_currency\": \"\",\r\n \"last_free_bonus_wagering\": \"\",\r\n \"total_withdrawals_amount\": \"\",\r\n \"withdrawal_ewallet_email\": \"\",\r\n \"last_deposit_bonus_amount\": \"\",\r\n \"last_deposit_bonus_status\": \"\",\r\n \"last_deposit_bonus_currency\": \"\",\r\n \"last_deposit_bonus_wagering\": \"\",\r\n \"session\": \"\",\r\n \"payment_mode\": \"\",\r\n \"card_fullname\": \"\",\r\n \"card_bin\": \"\",\r\n \"card_hash\": \"\",\r\n \"card_last\": \"\",\r\n \"card_expire\": \"\",\r\n \"avs_result\": \"\",\r\n \"cvv_result\": \"\",\r\n \"sca_method\": \"\",\r\n \"user_bank_account\": \"\",\r\n \"user_bank_name\": \"\",\r\n \"user_balance\": \"\",\r\n \"user_verification_level\": \"\",\r\n \"status_3d\": \"\",\r\n \"regulation\": \"\",\r\n \"payment_provider\": \"\",\r\n \"phone_number\": \"\",\r\n \"transaction_type\": \"\",\r\n \"transaction_amount\": \"\",\r\n \"transaction_currency\": \"\",\r\n \"merchant_id\": \"\",\r\n \"details_url\": \"\",\r\n \"name\": \"\",\r\n \"person_type\": \"\",\r\n \"gender\": \"\"\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"https://app.aviorapay.com/api/v1/checkTransAllowed","description":"Request for the checkTransactionAllowed endpoint is identical to the TrustScore API. Only thing different is the response. Instead of detailed score, this endpoint only returns transactionAllowed parameter that can have either YES or NO value.
Access to this API has to be given to you by the admin. So please contact your sales representative at Aviorapay to get access to this API, if you get a 401 error of \"You are not allowed to call this API service\".
\nThe optional parameters are self-explanatory and appropriate values can be given in string format.
\nResponse contains a single parameter: transactionAllowed which can either be YES or NO .
{\n\"transactionAllowed\" : \"YES\"\n}\n\nIf there are any errors then it'll be in the format of :
\n{\n \"message\": \"descriptive error message\",\n \"code\": \"error_code\"\n}\n\nthe possible error codes one can get on calling this APIs are:
\nfor example:
\n","urlObject":{"path":["checkTransAllowed"],"host":["https://app.aviorapay.com/api/v1"],"query":[],"variable":[]}},"response":[{"id":"cdaf39c0-2c00-4848-a6b4-b96c5941b3be","name":"TrustScoreExists","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"requiredinput\": {\r\n \"ip\": \"2001:8004:cc2:fadb:9958:4523:6c42:e3f2\",\r\n \"email\": \"test@gmail.com\",\r\n \"url\": \"http://test.com\"\r\n },\r\n \"optionalInput\": {\r\n \"last_bets\": null,\r\n \"last_wins\": \"\",\r\n \"total_bonuses\": \"\",\r\n \"last_real_bets\": \"\",\r\n \"last_real_wins\": \"\",\r\n \"total_deposits\": \"\",\r\n \"last_bonus_bets\": \"\",\r\n \"last_bonus_wins\": \"\",\r\n \"average_real_bet\": \"\",\r\n \"last_bets_amount\": \"\",\r\n \"last_wins_amount\": \"\",\r\n \"average_bonus_bet\": \"\",\r\n \"bonus_to_deposits\": \"\",\r\n \"last_deposit_date\": \"\",\r\n \"total_withdrawals\": \"\",\r\n \"is_phone_confirmed\": \"\",\r\n \"money_in_money_out\": \"\",\r\n \"last_deposit_amount\": \"\",\r\n \"last_freespins_date\": \"\",\r\n \"last_freespins_name\": \"\",\r\n \"last_free_bonus_date\": \"\",\r\n \"last_free_bonus_name\": \"\",\r\n \"total_bonuses_amount\": \"\",\r\n \"last_freespins_amount\": \"\",\r\n \"last_freespins_status\": \"\",\r\n \"last_real_bets_amount\": \"\",\r\n \"last_real_wins_amount\": \"\",\r\n \"total_deposits_amount\": \"\",\r\n \"last_bonus_bets_amount\": \"\",\r\n \"last_bonus_wins_amount\": \"\",\r\n \"last_free_bonus_amount\": \"\",\r\n \"last_free_bonus_status\": \"\",\r\n \"last_deposit_bonus_date\": \"\",\r\n \"last_deposit_bonus_name\": \"\",\r\n \"last_freespins_currency\": \"\",\r\n \"last_freespins_wagering\": \"\",\r\n \"withdrawals_to_deposits\": \"\",\r\n \"last_free_bonus_currency\": \"\",\r\n \"last_free_bonus_wagering\": \"\",\r\n \"total_withdrawals_amount\": \"\",\r\n \"withdrawal_ewallet_email\": \"\",\r\n \"last_deposit_bonus_amount\": \"\",\r\n \"last_deposit_bonus_status\": \"\",\r\n \"last_deposit_bonus_currency\": \"\",\r\n \"last_deposit_bonus_wagering\": \"\",\r\n \"session\": \"\",\r\n \"payment_mode\": \"\",\r\n \"card_fullname\": \"\",\r\n \"card_bin\": \"\",\r\n \"card_hash\": \"\",\r\n \"card_last\": \"\",\r\n \"card_expire\": \"\",\r\n \"avs_result\": \"\",\r\n \"cvv_result\": \"\",\r\n \"sca_method\": \"\",\r\n \"user_bank_account\": \"\",\r\n \"user_bank_name\": \"\",\r\n \"user_balance\": \"\",\r\n \"user_verification_level\": \"\",\r\n \"status_3d\": \"\",\r\n \"regulation\": \"\",\r\n \"payment_provider\": \"\",\r\n \"phone_number\": \"\",\r\n \"transaction_type\": \"\",\r\n \"transaction_amount\": \"\",\r\n \"transaction_currency\": \"\",\r\n \"merchant_id\": \"\",\r\n \"details_url\": \"\",\r\n \"name\": \"\",\r\n \"person_type\": \"\",\r\n \"gender\": \"\"\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"{{StagingBaseURL}}/checkTransAllowed"},"status":"Accepted","code":202,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Sun, 29 Oct 2023 09:21:22 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"Cache-Control","value":"no-cache, no-store, max-age=0, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Expires","value":"0"},{"key":"X-Frame-Options","value":"DENY"},{"key":"CF-Cache-Status","value":"DYNAMIC"},{"key":"Report-To","value":"{\"endpoints\":[{\"url\":\"https:\\/\\/a.nel.cloudflare.com\\/report\\/v3?s=r2%2FuLwSilxdD1lpiI1VqpgF0Tu9etiNhupySeBHl0zcU8XV1z8kwR%2FJ00ti4xpMdrTXW%2BkqZkLGrkkaUnMWFsaYlg%2FfA9UC4wIKwmc9LHUwna491EmnC3b3vlabzhUJ11CMpnVmicUE%3D\"}],\"group\":\"cf-nel\",\"max_age\":604800}"},{"key":"NEL","value":"{\"success_fraction\":0,\"report_to\":\"cf-nel\",\"max_age\":604800}"},{"key":"Server","value":"cloudflare"},{"key":"CF-RAY","value":"81da590e8d4345a0-LHR"},{"key":"alt-svc","value":"h3=\":443\"; ma=86400"}],"cookie":[],"responseTime":null,"body":"{\n \"transactionAllowed\": \"YES\"\n}"},{"id":"ea31c9d5-676b-438b-951d-ba788493a98f","name":"TrustScoreError","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"requiredinput\": {\r\n \"ip\": \"2001:8004:cc2:fadb:9958:4523:6c42:e3f2\",\r\n \"email\": \"test@gmail.com\",\r\n \"url\": \"http://test.com\"\r\n },\r\n \"optionalInput\": {\r\n \"last_bets\": null,\r\n \"last_wins\": \"\",\r\n \"total_bonuses\": \"\",\r\n \"last_real_bets\": \"\",\r\n \"last_real_wins\": \"\",\r\n \"total_deposits\": \"\",\r\n \"last_bonus_bets\": \"\",\r\n \"last_bonus_wins\": \"\",\r\n \"average_real_bet\": \"\",\r\n \"last_bets_amount\": \"\",\r\n \"last_wins_amount\": \"\",\r\n \"average_bonus_bet\": \"\",\r\n \"bonus_to_deposits\": \"\",\r\n \"last_deposit_date\": \"\",\r\n \"total_withdrawals\": \"\",\r\n \"is_phone_confirmed\": \"\",\r\n \"money_in_money_out\": \"\",\r\n \"last_deposit_amount\": \"\",\r\n \"last_freespins_date\": \"\",\r\n \"last_freespins_name\": \"\",\r\n \"last_free_bonus_date\": \"\",\r\n \"last_free_bonus_name\": \"\",\r\n \"total_bonuses_amount\": \"\",\r\n \"last_freespins_amount\": \"\",\r\n \"last_freespins_status\": \"\",\r\n \"last_real_bets_amount\": \"\",\r\n \"last_real_wins_amount\": \"\",\r\n \"total_deposits_amount\": \"\",\r\n \"last_bonus_bets_amount\": \"\",\r\n \"last_bonus_wins_amount\": \"\",\r\n \"last_free_bonus_amount\": \"\",\r\n \"last_free_bonus_status\": \"\",\r\n \"last_deposit_bonus_date\": \"\",\r\n \"last_deposit_bonus_name\": \"\",\r\n \"last_freespins_currency\": \"\",\r\n \"last_freespins_wagering\": \"\",\r\n \"withdrawals_to_deposits\": \"\",\r\n \"last_free_bonus_currency\": \"\",\r\n \"last_free_bonus_wagering\": \"\",\r\n \"total_withdrawals_amount\": \"\",\r\n \"withdrawal_ewallet_email\": \"\",\r\n \"last_deposit_bonus_amount\": \"\",\r\n \"last_deposit_bonus_status\": \"\",\r\n \"last_deposit_bonus_currency\": \"\",\r\n \"last_deposit_bonus_wagering\": \"\",\r\n \"session\": \"\",\r\n \"payment_mode\": \"\",\r\n \"card_fullname\": \"\",\r\n \"card_bin\": \"\",\r\n \"card_hash\": \"\",\r\n \"card_last\": \"\",\r\n \"card_expire\": \"\",\r\n \"avs_result\": \"\",\r\n \"cvv_result\": \"\",\r\n \"sca_method\": \"\",\r\n \"user_bank_account\": \"\",\r\n \"user_bank_name\": \"\",\r\n \"user_balance\": \"\",\r\n \"user_verification_level\": \"\",\r\n \"status_3d\": \"\",\r\n \"regulation\": \"\",\r\n \"payment_provider\": \"\",\r\n \"phone_number\": \"\",\r\n \"transaction_type\": \"\",\r\n \"transaction_amount\": \"\",\r\n \"transaction_currency\": \"\",\r\n \"merchant_id\": \"\",\r\n \"details_url\": \"\",\r\n \"name\": \"\",\r\n \"person_type\": \"\",\r\n \"gender\": \"\"\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"{{StagingBaseURL}}/checkTransAllowed"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Sun, 29 Oct 2023 09:28:33 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"Cache-Control","value":"no-cache, no-store, max-age=0, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Expires","value":"0"},{"key":"X-Frame-Options","value":"DENY"},{"key":"CF-Cache-Status","value":"DYNAMIC"},{"key":"Report-To","value":"{\"endpoints\":[{\"url\":\"https:\\/\\/a.nel.cloudflare.com\\/report\\/v3?s=herXY1o%2BFZa%2F3qNFjvh4ANgP%2FD0DdAVVFm0vUZDAst2rFkieItm%2Fu0VN24DYrdp7MHMHFKWLvrsBYVIxjDPDaLgJjeGBvlTP2iZoB5EnG1hPPHUVXRNP%2FGMmOTh%2Fp7gsyj0vihW1kMk%3D\"}],\"group\":\"cf-nel\",\"max_age\":604800}"},{"key":"NEL","value":"{\"success_fraction\":0,\"report_to\":\"cf-nel\",\"max_age\":604800}"},{"key":"Server","value":"cloudflare"},{"key":"CF-RAY","value":"81da6398ab144913-LHR"},{"key":"alt-svc","value":"h3=\":443\"; ma=86400"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Incorrect secret_key\",\n \"code\": \"authentication_failed\"\n}"}],"_postman_id":"59ea737c-20f3-42e8-8fa1-baf34782084b"}],"id":"96dfcc61-8bd6-40b7-861f-42c30bf0a25b","_postman_id":"96dfcc61-8bd6-40b7-861f-42c30bf0a25b","description":""},{"name":"Cashier APIs","item":[{"name":"Customer","id":"d54def31-7a30-4b3b-97f5-d61f8027f721","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"Bearer Token","type":"text"},{"key":"BrandId","value":"brand_id_value","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"fullName\": \"Rahul Agarwal\",\r\n \"emailId\": \"rahul+26@aviorapay.com\",\r\n \"dateOfBirth\": \"1994-06-03\",\r\n \"phoneNo\": \"+91 797639082\",\r\n \"city\": \"Jaipur\",\r\n \"stateCode\": \"RJ\",\r\n \"zipCode\": \"302018\",\r\n \"address\": \"House Number 53, Vaishali Nagar, Jaipur\",\r\n \"country\": \"IN\",\r\n \"merchantCustomerId\": \"rahultestcustomer@aviorapay.com\",\r\n \"CustRegDate\": \"2023-12-27\", //non-mandatory - customer registration date on merchant site\r\n \"SuccessTxn\": \"32\", //non-mandatory - total successful customer orders on merchant site\r\n \"extraParam\": {\r\n \"param1\": \"value1\",\r\n \"param2\": \"value2\",\r\n \"param3\": \"value3\",\r\n \"param4\": \"value4\"\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.aviorapay.com/api/v1/customer","description":"OVERIEW
\nThe createCustomer API allows merchants to create a customer profile on Aviorapay when a user visits their website, facilitating a seamless payment experience by pre-filling the customer's details, on the Aviorapay Cashier. The API takes in customer information and returns a unique customerID that can be passed in purchase payload, eliminating the need for customers to manually enter their details during transactions.
\nCustomer visits merchant's website: The customer selects the product or service and proceeds to checkout page.
\nMerchant calls the createCustomer API: The merchant sends a POST request to the Aviorapay API with the customer's details.
Customer ID generation: Aviorapay processes the request and generates a unique customerId which is returned in the response.
Payment Process: The merchant uses the customerId for subsequent session creation, ensuring the customer doesn’t need to re-enter their details for future payments.
Seamless user experience: The customer does not have to enter their details manually for every purchase.
\nFaster Checkout: The merchant can use the customerId for faster payment processing.
Data Security: Customer details are stored securely and can be reused across transactions, reducing the chances of errors.
\nThe createCustomer can be implemented on merchant site in one of two ways, depending on merchant’s integration flow:
At Checkout:
\nWhen a customer initiates the checkout process, your system should invoke the createCustomer API, before actually starting the session.
Call createCustomer: This API call generates a unique customer ID.
Use of Customer ID: Pass the returned customer ID in Session API, when creating a payment session.
\nUpon Customer Login:
\nAlternatively, merchants may choose to call createCustomer at the time of customer login on their site.
Persistent Customer Profiles: This approach can help build or maintain a persistent customer profile, ensuring the customer ID is available for any subsequent payment sessions without needing to call createCustomer again.
Integration Flexibility: This is useful for merchants who want to initialize customer data early in the customer journey rather than during checkout.
\nThe method you choose depends on your business requirements and how your system is architected. Regardless of when you call it, the resulting customer ID must be passed to the createSession API to initiate a payment session.
This endpoint makes an HTTP GET request to retrieve customer information from the Aviorapay API.
\nThe request does not include any query parameters, but it uses a raw request body with the following parameter \"merchantCustomerId\", which will be the customer id on the merchant's side.
\nThe response of this request can be documented as a JSON schema.
\n","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"c3e3767a-26ba-4a32-89a9-3e620a7d0847","id":"c3e3767a-26ba-4a32-89a9-3e620a7d0847","name":"Cashier APIs","type":"folder"}},"urlObject":{"protocol":"https","path":["api","v1","customer"],"host":["app","aviorapay","com"],"query":[],"variable":[]}},"response":[{"id":"c62577c0-9993-4477-be25-3d0afece2d45","name":"Success","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"*/*","type":"text"},{"key":"BrandId","value":"brand_id_value","type":"text"},{"key":"Authorization","value":"Bearer Token","type":"text"}],"url":"https://app.aviorapay.com/api/v1/customer"},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":"{\n \"customerId\": \"691afbc6fd96d34a8113a34d\",\n \"merchantCustomerId\": \"rahultestcustomer1@aviorapay.com\",\n \"fullName\": \"Rahul Agarwal\",\n \"emailId\": \"rahul+26@aviorapay.com\",\n \"dateOfBirth\": \"1994-06-03\",\n \"phoneNo\": \"+91 797639082\",\n \"brandID\": \"1d666074-39be-4b90-aec9-e9de78fbdcb9\",\n \"city\": \"Jaipur\",\n \"zipCode\": \"302018\",\n \"address\": \"House Number 53, Vaishali Nagar, Jaipur\",\n \"country\": \"IN\",\n \"stateCode\": \"RJ\",\n \"custRegDate\": \"2023-12-27\",\n \"successTrans\": 0,\n \"createdOn\": 1763376070,\n \"lastUpdated\": 0,\n \"lastActivity\": 1763376070,\n \"extraParam\": {\n \"param1\": \"value1\",\n \"param2\": \"value2\",\n \"param3\": \"value3\",\n \"param4\": \"value4\"\n }\n}"},{"id":"6a8737c7-f48c-4fa6-8b55-d6a7b940f820","name":"Invalid Customer","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"*/*","type":"text"},{"key":"BrandId","value":"brand_id_value","type":"text"},{"key":"Authorization","value":"Bearer Token","type":"text"}],"url":"https://app.aviorapay.com/api/v1/customer"},"status":"Bad Request","code":400,"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Customer with this information does not exist\",\n \"code\": \"customer_does_not_exist\"\n}"}],"_postman_id":"5404d2e4-addc-4ad6-87bf-fc520f75e9ff"},{"name":"Customer","event":[{"listen":"test","script":{"exec":["var template = `","","","| Customer ID | ","First Name | ","Last Name | ","Phone | ","|
|---|---|---|---|---|
| {{response.customerId}} | ","{{response.firstName}} | ","{{response.lastName}} | ","{{response.email}} | ","{{response.phone}} | ","
Whenever a customer or the merchant updates customer details on the merchant site, a PATCH request must be made to synchronize these changes with Aviorapay.
\nThis API endpoint allows you to update the customer details using an HTTP PATCH request. The request should be sent to https://app.aviorapay.com/api/v1/{customerId}/patchCustomer.
\nThe request body should be in raw format and include the following parameters:
\nfullName (string): The full name of the customer.
emailId (string): The email address of the customer.
dateOfBirth (string): The date of birth of the customer.
phoneNo (string): The phone number of the customer.
city (string): The city of the customer.
stateCode (string): The state code of the customer.
zipCode (string): The zip code of the customer.
address (string): The address of the customer.
country (string): The country of the customer.
createdOn (string): Time when the customer was created.
custRegDate (string): Customer registration date (Non-Mandatory).
successTxn (string): Success transaction details (Non-Mandatory).
lastActivity (string): Time of the last activity.
lastUpdated (string): Time when the last patch was called.
extraParam (object): Additional parameters including param1, param2, param3, param4 with their respective values.
The response will contain the updated customer details or a success message upon successful update.
\n","urlObject":{"protocol":"https","path":["api","v1","{AviorapayCustomerId}","patchCustomer"],"host":["api","aviorapay","com"],"query":[],"variable":[]}},"response":[{"id":"bc609f4b-3f79-40ad-acdc-4e419a09cc23","name":"Success","originalRequest":{"method":"PATCH","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"*/*","type":"text"},{"key":"BrandId","value":"brand_id_value","type":"text"},{"key":"Authorisation","value":"Bearer Token","type":"text"}],"body":{"mode":"raw","raw":"{\n \"fullName\": \"Gouri Shankar3\",\n \"emailId\": \"gouri@aviorapay.com\",\n \"dateOfBirth\": \"1990-11-27\",\n \"phoneNo\": \"+91 9413666514\",\n \"city\": \"Dausa\",\n \"stateCode\": \"Raj\",\n \"zipCode\": \"202021\",\n \"address\": \"Somnath Nagar\",\n \"country\": \"IN\",\n \"CustRegDate\": \"2023-12-28\",\n \"SuccessTxn\": \"33\",\n \"extraParam\": {\n \"param1\": \"value1\",\n \"param2\": \"value2\",\n \"param3\": \"value3\",\n \"param4\": \"value4\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://api.aviorapay.com/api/v1/{AviorapayCustomerId}/patchCustomer"},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":"{\n \"customerId\": \"691afbc6fd96d34a8113a34d\",\n \"merchantCustomerId\": \"rahultestcustomer1@aviorapay.com\",\n \"fullName\": \"Gouri Shankar3\",\n \"emailId\": \"gouri@aviorapay.com\",\n \"dateOfBirth\": \"1990-11-27\",\n \"phoneNo\": \"+91 9413666514\",\n \"brandID\": \"brandID\",\n \"city\": \"Dausa\",\n \"zipCode\": \"202021\",\n \"address\": \"Somnath Nagar\",\n \"country\": \"IN\",\n \"stateCode\": \"Raj\",\n \"custRegDate\": \"2023-12-28\",\n \"successTrans\": 0,\n \"createdOn\": 1763376070,\n \"lastUpdated\": 1763377024,\n \"lastActivity\": 1763377024,\n \"extraParam\": {\n \"param1\": \"value1\",\n \"param2\": \"value2\",\n \"param3\": \"value3\",\n \"param4\": \"value4\"\n }\n}"}],"_postman_id":"3a64d84a-13f5-4597-a64c-badbe05baba5"},{"name":"Purchase Session","id":"bdb65dee-5ea2-4d42-badb-eca0b5bb62e5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"Bearer Token","type":"text"},{"key":"BrandId","value":"brand_id_value","type":"text"},{"key":"Accept","value":"*/*","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"customerId\": \"68fed1855ebbe829416b08c6\",\r\n \"merchantRef\": \"rahultestcustomer1@aviorapay.com\", // optional\r\n \"currency\": \"EUR\",\r\n \"products\": [\r\n {\r\n \"name\": \"Product1\",\r\n \"price\": \"10\"\r\n },\r\n {\r\n \"name\": \"Product2\",\r\n \"price\": \"12\"\r\n }\r\n ],\r\n \"totalAmount\": \"22\", // optional, but if present have precedence over sum of prices mentioned above.\r\n \"paymentMethod\": \"VISA\", //optional\r\n \"success_redirect\": \"https://merchant-success-page.com/\",\r\n \"failure_redirect\": \"https://merchant-failure-page.com/\",\r\n \"pending_redirect\": \"https://merchant-pending-page.com/\",\r\n \"success_callback\": \"https://your.success.callback.com\",\r\n \"failure_callback\": \"https://your.failure.callback.com\",\r\n \"extraParam\": {\r\n \"param1\": \"value1\",\r\n \"showCryptoConversion\": \"yes\",\r\n \"cryptoCurrencies\": \"[\\\"BTC\\\",\\\"ETH\\\",\\\"USDT\\\",\\\"XRP\\\",\\\"LTC\\\",\\\"DOGE\\\",\\\"ETC\\\",\\\"BNB\\\",\\\"USDC\\\",\\\"SOL\\\",\\\"ADA\\\",\\\"BCH\\\",\\\"DASH\\\",\\\"BTG\\\",\\\"ZEC\\\",\\\"DGB\\\",\\\"EOS\\\",\\\"XLM\\\",\\\"TRX\\\",\\\"QTUM\\\",\\\"POL\\\",\\\"SHIB\\\",\\\"LINK\\\",\\\"DAI\\\",\\\"TON\\\",\\\"AVAX\\\",\\\"FDUSD\\\",\\\"ARB\\\",\\\"OP\\\"]\",\r\n \"param3\": \"value3\",\r\n \"param4\": \"value4\"\r\n }\r\n }","options":{"raw":{"language":"json"}}},"url":"https://api.aviorapay.com/api/v1/createSession","description":"OVERIEW
\nThe createSession API is designed to initiate a payment session for a customer after their profile has been created via the createCustomer API. The session is automatically generated at the backend on the merchant’s checkout URL. This session allows the customer to continue with their transaction without having to manually interact with the session URL, and ensures the session remains active until the payment is completed or the session expires.
This API improves the user experience by reducing transaction failures and enhancing the overall payment process, thus reducing transaction churn rates.
\nAdditionally, there are some default extra parameters that you can pass for allowing Crypto Conversion on Aviorapay's cashier itself.
\nCustomer completes the createCustomer API: Once the customer is created via the createCustomer API, the merchant proceeds to call the createSession API to generate a session.
Merchant sends createSession request: The merchant sends a POST request to the createSession API with the customer’s customerId and the merchant’s brandId.
Session created automatically on the checkout URL: Aviorapay creates the session and associates it with the merchant’s checkout page. This session remains active on the backend, allowing the customer to continue the payment process without interruption.
\nCustomer proceeds to checkout: The customer is redirected to the checkout page as part of the merchant's payment flow, where the session is automatically validated. The session remains active for a set period, allowing the customer to complete the payment without needing to manually interact with the session URL.
\nSession Expiry: The session expires after the set expiration time (expiryOn), ensuring the payment process is completed within the defined window. Default is 15 mins from the creation time.
Seamless Checkout: The session URL is automatically generated and active at the backend, ensuring a smoother and uninterrupted customer experience.
\nReduced Transaction Failures: By ensuring the session remains active during the payment process, the chances of transaction failures due to session timeouts are minimized.
\nImproved User Experience: The customer does not need to click on a session URL or navigate away from the page, leading to faster and more secure payment processing.
\nThis API is used to initiate a payout session for a customer. By passing the customerId (generated via the createCustomer API) and specifying \"type\": \"payout\", a payout session is started.
A sessionURL is returned in the response, which can be used to redirect the customer to the payout cashier. The customer can then select the payout method, pass required parameters, and the payout will be processed.
BrandId: Your unique brand ID (required).
\nContent-Type: application/json (required).
\nThe API will return a JSON object containing the sessionURL that can be used to redirect the customer to the payout cashier.
{\n \"sessionUrl\": \"https://app.aviorapay.com/payoutSession/68341ad35f895955355d5452/\",\n \"brandId\": \"brand_id_value\",\n \"customerId\": \"67c9983fba18400ab6cceb8f\",\n \"sessionId\": \"68341ad35f895955355d5452\",\n \"expiryOn\": 1748246103,\n \"createdOn\": 1748245203\n}\n\nThis endpoint retrieves the details of a session identified by the provided session ID.
\n\n\nNote that this API only respond once the SessionURL, received in the response for session API, is clicked.
\n
\n\n","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"c3e3767a-26ba-4a32-89a9-3e620a7d0847","id":"c3e3767a-26ba-4a32-89a9-3e620a7d0847","name":"Cashier APIs","type":"folder"}},"urlObject":{"protocol":"https","path":["api","v1","purchases","{Session ID}",""],"host":["api","aviorapay","com"],"query":[],"variable":[]}},"response":[{"id":"2d6e1a16-04b1-44e9-a979-a0ddb17c8ac2","name":"202 Success","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer Token"}],"url":"https://api.aviorapay.com/api/v1/purchases/6950e4ba5205280b71ac2010/"},"status":"Accepted","code":202,"_postman_previewlanguage":"Text","header":[{"key":"Date","value":"Sun, 28 Dec 2025 08:03:36 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Nel","value":"{\"report_to\":\"cf-nel\",\"success_fraction\":0.0,\"max_age\":604800}"},{"key":"X-Frame-Options","value":"ALLOW-FROM *"},{"key":"Referrer-Policy","value":"no-referrer"},{"key":"x-session-id","value":"d5308b2a-537d-466a-8273-f754ba3491b8"},{"key":"Vary","value":"Origin"},{"key":"Vary","value":"Access-Control-Request-Method"},{"key":"Vary","value":"Access-Control-Request-Headers"},{"key":"Server","value":"cloudflare"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"0"},{"key":"Cache-Control","value":"no-cache, no-store, max-age=0, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Expires","value":"0"},{"key":"Strict-Transport-Security","value":"max-age=31536000 ; includeSubDomains"},{"key":"X-Cache","value":"Error from cloudfront"},{"key":"Via","value":"1.1 f89daa99b6a349030b23247a4977cb5e.cloudfront.net (CloudFront)"},{"key":"X-Amz-Cf-Pop","value":"IAD61-P10"},{"key":"X-Amz-Cf-Id","value":"Ed-N_b__1xPz7yrAt9mMc6JrgiZqMiuPi3uJbZ4AeuUKm-Ziiohlcw=="},{"key":"cf-cache-status","value":"DYNAMIC"},{"key":"Report-To","value":"{\"group\":\"cf-nel\",\"max_age\":604800,\"endpoints\":[{\"url\":\"https://a.nel.cloudflare.com/report/v4?s=V90OEeQkl%2Fh028giW2T2qMbuNADZ5EvKMZG33harMVuXpmo%2BnNQm5JeDtH2802Oa8hw5kJG737sqfdiLVuvIq%2F5E5tHoRdK8Zj6OU6yO255A\"}]}"},{"key":"CF-RAY","value":"9b4f8ac7caf2f4ca-IAD"},{"key":"alt-svc","value":"h3=\":443\"; ma=86400"}],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\n \"purchaseId\": \"6950e4e3e4a1b008c2fae5c3\",\n \"client\": {\n \"customerId\": \"69034a5a61b460084d20c23b\",\n \"email\": \"rahul+23@aviorapay.com\",\n \"phone\": \"+919634088561\",\n \"full_name\": \"Rahul Agarwal\",\n \"street_address\": \"Vaishali Jaipur\",\n \"country\": \"NA\",\n \"city\": \"jaipur\",\n \"zip_code\": \"202020\",\n \"cc\": [],\n \"bcc\": [],\n \"stateCode\": \"RA\"\n },\n \"updated_on\": 1766909180,\n \"type\": \"purchase\",\n \"paymentMethod\": \"MASTER,VISA,JCB,AMEX,CRYPTO-BRIDGE,FawryPay,INTERAC-E-TRANSFER,INTERAC-REQUEST-MONEY,MOBILEMONEY,NEOSURF,PAYID,PIX,SPEI,THIRDPARTY-UPI,DISCOVER,BANKTRANSFER,VIRTUAL-IBAN,UPI-COLLECT,UPI-QR,VIRTUAL-ACCOUNT,DINERS,NETBANKING,THIRDPARTY-NETBANKING,MAYA,GCASH,INTERAC-EXPRESS,QRPH\",\n \"amountUnit\": \"MAJOR\",\n \"errorMsg\": \"This customer can not be processed !\",\n \"errorCode\": \"NA\",\n \"savedCardUsed\": \"NO\",\n \"redirectType\": \"POST\",\n \"force_recurring\": false,\n \"created_on\": 1766909155,\n \"merchantRef\": \"6950e4e3e4a1b008c2fae5c3\",\n \"merchantName\": \"rahul_test\",\n \"merchantType\": \"MERCHANT\",\n \"purchase\": {\n \"currency\": \"EUR\",\n \"products\": [\n {\n \"name\": \"NA\",\n \"quantity\": 1.0,\n \"price\": 22.0,\n \"discount\": 0,\n \"tax_percent\": \"0.00\"\n }\n ],\n \"total\": 22.0,\n \"requestAmount\": 22.0,\n \"language\": \"en\",\n \"notes\": \"\",\n \"debt\": 0,\n \"total_formatted\": 1.0,\n \"taxAmount\": 0.0,\n \"taxPercent\": 0.0,\n \"request_client_details\": [],\n \"email_message\": \"\"\n },\n \"issuer_details\": {\n \"website\": \"\",\n \"legal_street_address\": \"\",\n \"legal_country\": \"\",\n \"legal_city\": \"\",\n \"legal_zip_code\": \"\",\n \"bank_accounts\": [\n {}\n ],\n \"legal_name\": \"Testing\",\n \"brand_name\": \"Testing\",\n \"registration_number\": \"\",\n \"tax_number\": \"\"\n },\n \"transaction_data\": {\n \"payment_method\": \"\",\n \"flow\": \"payform\",\n \"extra\": {\n \"expiry_month\": \"07\",\n \"amount\": 22.0,\n \"card_issuer\": \"CIAGROUP\",\n \"masked_pan\": \"55555555****4444\",\n \"card_brand\": \"MASTER\",\n \"card_issuer_country\": \"BR\",\n \"card_type\": \"DEBIT\",\n \"cardholder_name\": \"rahul\",\n \"expiry_year\": \"30\"\n },\n \"country\": \"\",\n \"attempts\": [\n {\n \"client_ip\": \"183.83.53.214\",\n \"type\": \"execute\",\n \"payment_method\": \"MASTER\",\n \"flow\": \"payform\",\n \"successful\": false,\n \"country\": \"BR\",\n \"processing_time\": 1766909179,\n \"extra\": {\n \"expiry_month\": \"07\",\n \"amount\": 22.0,\n \"card_issuer\": \"CIAGROUP\",\n \"masked_pan\": \"55555555****4444\",\n \"card_brand\": \"MASTER\",\n \"card_issuer_country\": \"BR\",\n \"card_type\": \"DEBIT\",\n \"cardholder_name\": \"rahul\",\n \"expiry_year\": \"30\"\n },\n \"error\": {\n \"message\": \"This customer can not be processed !\",\n \"code\": \"no_mid_found\"\n }\n }\n ]\n },\n \"status\": \"ERROR\",\n \"status_history\": [\n {\n \"status\": \"created\",\n \"timestamp\": 1766909155\n },\n {\n \"status\": \"pending_execute\",\n \"timestamp\": 1766909179\n },\n {\n \"status\": \"error\",\n \"timestamp\": 1766909180\n },\n {\n \"status\": \"viewed\",\n \"timestamp\": 1766909186\n }\n ],\n \"viewedOn\": 1766909186,\n \"is_test\": false,\n \"brand_id\": \"59c5ed48-caf9-464a-ba54-26e1e02bc1bc\",\n \"send_receipt\": false,\n \"is_recurring_token\": false,\n \"skip_capture\": false,\n \"reference_generated\": \"PS334\",\n \"issued\": \"2025-12-28\",\n \"due\": 1766909155,\n \"refund_upto\": 0,\n \"cc_descriptor\": \"\",\n \"fraudScore\": \"0\",\n \"trustScore\": \"0\",\n \"extraFee\": \"0\",\n \"paidOn\": 0,\n \"receivedAmt\": 0.0,\n \"taxAmount\": 0.0,\n \"surcharge\": 0.0,\n \"surchargeType\": \"\",\n \"sessionId\": \"6950e4ba5205280b71ac2010\",\n \"refund_availability\": \"NONE\",\n \"refundable_amount\": 0.0,\n \"success_redirect\": \"https://google.com/\",\n \"failure_redirect\": \"https://google.com/\",\n \"pending_redirect\": \"https://google.com/\",\n \"cancel_redirect\": \"\",\n \"success_callback\": \"https://your.success.callback.com\",\n \"failure_callback\": \"https://your.failure.callback.com\",\n \"platform\": \"API\",\n \"checkout_url\": \"https://api.aviorapay.com/payments/adb6e07f74ec6197ef764909736d478e/\",\n \"direct_post_url\": \"https://api.aviorapay.com/api/v1/p/6950e4e3e4a1b008c2fae5c3/\",\n \"payoutProcess\": false\n}"},{"id":"73bb9001-36bc-44c2-a268-bce11fa3063b","name":"400 Bad Request","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer Token"}],"url":"https://api.aviorapay.com/api/v1/purchases/6950e4ba5205280b71ac2010/"},"status":"Bad Request","code":400,"_postman_previewlanguage":"Text","header":[{"key":"Date","value":"Sun, 28 Dec 2025 08:03:36 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Nel","value":"{\"report_to\":\"cf-nel\",\"success_fraction\":0.0,\"max_age\":604800}"},{"key":"X-Frame-Options","value":"ALLOW-FROM *"},{"key":"Referrer-Policy","value":"no-referrer"},{"key":"x-session-id","value":"d5308b2a-537d-466a-8273-f754ba3491b8"},{"key":"Vary","value":"Origin"},{"key":"Vary","value":"Access-Control-Request-Method"},{"key":"Vary","value":"Access-Control-Request-Headers"},{"key":"Server","value":"cloudflare"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"0"},{"key":"Cache-Control","value":"no-cache, no-store, max-age=0, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Expires","value":"0"},{"key":"Strict-Transport-Security","value":"max-age=31536000 ; includeSubDomains"},{"key":"X-Cache","value":"Error from cloudfront"},{"key":"Via","value":"1.1 f89daa99b6a349030b23247a4977cb5e.cloudfront.net (CloudFront)"},{"key":"X-Amz-Cf-Pop","value":"IAD61-P10"},{"key":"X-Amz-Cf-Id","value":"Ed-N_b__1xPz7yrAt9mMc6JrgiZqMiuPi3uJbZ4AeuUKm-Ziiohlcw=="},{"key":"cf-cache-status","value":"DYNAMIC"},{"key":"Report-To","value":"{\"group\":\"cf-nel\",\"max_age\":604800,\"endpoints\":[{\"url\":\"https://a.nel.cloudflare.com/report/v4?s=V90OEeQkl%2Fh028giW2T2qMbuNADZ5EvKMZG33harMVuXpmo%2BnNQm5JeDtH2802Oa8hw5kJG737sqfdiLVuvIq%2F5E5tHoRdK8Zj6OU6yO255A\"}]}"},{"key":"CF-RAY","value":"9b4f8ac7caf2f4ca-IAD"},{"key":"alt-svc","value":"h3=\":443\"; ma=86400"}],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\n \"message\": \"PurchaseId Not found.\",\n \"code\": \"transaction_error\"\n}"},{"id":"950b8718-695a-4e51-b005-22c86a5cac63","name":"401 Unauthorized","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer Token"}],"url":"https://api.aviorapay.com/api/v1/purchases/{Session ID}/"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"Text","header":[{"key":"Date","value":"Sun, 28 Dec 2025 08:03:36 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Nel","value":"{\"report_to\":\"cf-nel\",\"success_fraction\":0.0,\"max_age\":604800}"},{"key":"X-Frame-Options","value":"ALLOW-FROM *"},{"key":"Referrer-Policy","value":"no-referrer"},{"key":"x-session-id","value":"d5308b2a-537d-466a-8273-f754ba3491b8"},{"key":"Vary","value":"Origin"},{"key":"Vary","value":"Access-Control-Request-Method"},{"key":"Vary","value":"Access-Control-Request-Headers"},{"key":"Server","value":"cloudflare"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"0"},{"key":"Cache-Control","value":"no-cache, no-store, max-age=0, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Expires","value":"0"},{"key":"Strict-Transport-Security","value":"max-age=31536000 ; includeSubDomains"},{"key":"X-Cache","value":"Error from cloudfront"},{"key":"Via","value":"1.1 f89daa99b6a349030b23247a4977cb5e.cloudfront.net (CloudFront)"},{"key":"X-Amz-Cf-Pop","value":"IAD61-P10"},{"key":"X-Amz-Cf-Id","value":"Ed-N_b__1xPz7yrAt9mMc6JrgiZqMiuPi3uJbZ4AeuUKm-Ziiohlcw=="},{"key":"cf-cache-status","value":"DYNAMIC"},{"key":"Report-To","value":"{\"group\":\"cf-nel\",\"max_age\":604800,\"endpoints\":[{\"url\":\"https://a.nel.cloudflare.com/report/v4?s=V90OEeQkl%2Fh028giW2T2qMbuNADZ5EvKMZG33harMVuXpmo%2BnNQm5JeDtH2802Oa8hw5kJG737sqfdiLVuvIq%2F5E5tHoRdK8Zj6OU6yO255A\"}]}"},{"key":"CF-RAY","value":"9b4f8ac7caf2f4ca-IAD"},{"key":"alt-svc","value":"h3=\":443\"; ma=86400"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Incorrect secret_key\",\n \"code\": \"authentication_failed\"\n}"}],"_postman_id":"fc4bc788-49fb-4f3e-ac1e-e8a5f594cc85"},{"name":"Check Status - Payout","id":"c4a206ad-0671-4baf-8bad-897b42396959","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer Token","type":"text"}],"url":"https://app.aviorapay.com/api/v1/getpayout/{Session ID}/","description":"Once the SessionURL is clicked and the user has selected a payment method and click on \"Pay\" button, a purchase is created on our backend. If you call this API before that, you will get an error.
\n
This API tells you about all the details of a Payout, including its history
\nyou need to pass the payoutId or session id in the API URL
\nAviorapay Cashier is a unified payment management solution that connects with leading PSP and acquirers, offering merchants one convenient access point to simplify transaction processing and enhance efficiency.
\nTo start the cashier system, a payment session is initiated—a secure, temporary environment generated by our payment gateway. This session encapsulates all transaction details and state information before the cashier loads, overseeing the complete lifecycle of a payment attempt—from initial setup to final completion—ensuring every necessary detail is managed safely and consistently.
\n","auth":{"type":"noauth","isInherited":false},"event":[{"listen":"prerequest","script":{"type":"text/javascript","packages":{},"requests":{},"exec":[""],"id":"7b6af6f5-e36d-4585-ae0f-e267ece6a389"}},{"listen":"test","script":{"type":"text/javascript","packages":{},"requests":{},"exec":[""],"id":"73c5a523-b769-4d6e-ad74-4677990ef25c"}}],"_postman_id":"c3e3767a-26ba-4a32-89a9-3e620a7d0847"},{"name":"User Defined Fields (UDF)","item":[],"id":"677dd0a5-67f9-4122-8fd6-b8eea5ebc478","description":"User Defined Fields (also referred to as Merchant Defined Parameters) allow you to attach custom identifiers to transactions. These identifiers can help you map transactions to your internal systems and configure advanced routing rules.
\nOnce created, you can pass the parameter in the purchases or session API using the extraParam object in the payload, to receive the same in the API response and the following webhooks.
Click Add Parameters.
\nEnter the Parameter Name.
\nChoose the Value Type (Numeric, String, or Boolean).
\nClick Add to save.
\nHere is how you can define UDFs in Aviorapay's app.
\nOnce created, you can pass the parameter in the purchases or session API using the extraParam object in the payload, to receive the same in the API response and the following webhooks.
\"extraParam\": {\n \"userDefinedParameter\": \"value\"\n}\n\nUse consistent naming conventions for parameters to avoid confusion across integrations.
\nKeep the number of UDFs minimal — only add fields that provide clear value (e.g., customer segment, order type, risk score).
\nLeverage UDFs in rule-based routing to optimize processing flows (e.g., route high-value transactions to a specific MID).
\nDocument your UDFs internally so operations and support teams can easily reference them.
\nNote:
This feature is enabled only for the whitelabel merchant solution. If you are using a merchant solution, please contact your Account Manager for doing these changes.
Fetches a paginated list of transactions. This endpoint is optimized for high-volume retrieval and returns a summary view of each transaction (ID and Status).
\nRetrieves the complete details for a specific transaction. This includes customer info, payment method details, bank response codes, and hierarchy metadata (parent/child transactions).
\nThe Transaction Reporting APIs allow merchants to retrieve detailed logs of their payment activity programmatically. This is useful for:
\nReconciliation: Matching Aviorapay records with your internal order system.
\nAudit Trails: Tracking the status history of specific transactions.
\nData Export: Pulling transaction data into your own analytics tools.
\nThere are two primary endpoints:
\nList Transactions: Retrieves a paginated list of all transactions for a specific Brand ID.
\nGet Transaction Details: Retrieves the full data payload for a single transaction ID, including metadata and sub-transaction details.
\nBefore you can use network tokenisation in your payment flow, the feature must be enabled and configured on your merchant account. This section walks through the setup steps in the Aviorapay Dashboard.
\nNetwork tokenisation requires activation at the merchant level. Follow these steps in the Aviorapay Dashboard:
\nLog in to your Aviorapay merchant account.
\nNavigate to Merchant Details → Allowed Services.
\nEnable “Allow Network Token” to activate tokenisation for your account.
\nAdmin Activation Required
Network tokenisation must first be enabled at the platform level by your Aviorapay account administrator. If you do not see the “Allow Network Token” option in your dashboard, contact your Aviorapay account manager to request activation.
After enabling network tokenisation, configure the Aviorapay Token Service with your merchant details:
\nIn the Aviorapay Dashboard, navigate to Global Settings → Aviorapay Token Service.
\nFill in all the required fields accurately.
\nEnter your Category Code — this represents your merchant business type code (MCC).
\nClick Save.
\nAfter saving, verify that the status shows as Pending (visible in the top-right corner of the page).
\nThe status will automatically update to Active or Error once your token profile is created.
\nStatus Update Timing: The status update from Pending to Active may take up to 1 hour. Do not attempt to use tokenisation APIs until the status shows Active. If the status changes to Error, contact your Aviorapay account manager for resolution.
\nRetrieve all saved card tokens for a given customer. Returns the last 4 digits of each card and its associated token_reference.
Use this API to display saved cards to the customer for selection before initiating a payment via the S2S API.
\nThe token_reference does not expire. It remains valid as long as the saved card has not been deleted.
Show saved cards to the customer using card_last_four alongside a card brand icon (Visa / Mastercard).
The token_reference should only be stored and used server-side.
Show saved cards using cardlast4 alongside a card brand icon (Visa / Mastercard).
The token_reference should only be stored and used server-side.
Initiate a payment transaction. This is the standard Aviorapay Purchase API.
\nWhen a customer completes the purchase on the Aviorapay checkout page and opts to save their card, Aviorapay provisions a network token in the background and generates a token_reference linked to the customer.
When the customer completes payment via checkout_url and opts to save their card, Aviorapay provisions a network token. The token_reference is then available via the List Saved Cards API.
Process a payment using a saved card's token_reference. Aviorapay resolves the token reference to the underlying network token and processes the payment securely. If the selected MID does not accept tokens, Aviorapay automatically falls back to the card number.
The S2S API accepts different input types depending on the scenario:
\nScenario 1 (New card via S2S): token_reference returned in Check Status and Webhook.
Scenario 2 (Existing token_reference): token_reference returned in response and Webhook.
CVC is required even when using a token_reference.
All browser fields are required for 3D Secure authentication.
\nResponse follows the standard Aviorapay payment response format.
\nMust be \"true\" for server-to-server requests.
\n","type":"text/plain"},"key":"s2s","value":"true"}],"variable":[]}},"response":[{"id":"82da42d1-8fbc-4891-87a3-7bbd5cae17d6","name":"Success","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer {{APIKey}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"Token_reference\": \"token_7178aa7208614544a285656da38ae5ac\",\n \"cvc\": \"791\",\n \"remember_card\": \"off\",\n \"remote_ip\": \"157.38.242.7\",\n \"user_agent\": \"Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/51.0.2704.103 Safari/537.36\",\n \"accept_header\": \"text/html\",\n \"language\": \"en-US\",\n \"java_enabled\": false,\n \"javascript_enabled\": true,\n \"color_depth\": 24,\n \"utc_offset\": 0,\n \"screen_width\": 1920,\n \"screen_height\": 1080\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://app.aviorapay.com/api/v1/api/v1/p/6980e509b5e99e61f3bd4ccf/?s2s=true","host":["https://app.aviorapay.com/api/v1"],"path":["api","v1","p","6980e509b5e99e61f3bd4ccf",""],"query":[{"key":"s2s","value":"true"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"pending\",\n \"callback_url\": \"http://18.214.100.20/api/v1/payment/64b034ecc6dccf7d329d9eb3/\",\n \"method\": \"GET\"\n}"}],"_postman_id":"2c4ed2b7-a85f-46e2-9263-8af580010fc9"},{"name":"Delete Token","id":"71cdf402-aef6-4d79-b911-91160eff15ed","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"Authorization","value":"Bearer {{APIKey}}","type":"text"}],"url":"https://app.aviorapay.com/api/v1/tokens/v1/deleteToken/{{token_reference}}","description":"Permanently delete a saved card and deactivate the associated network token. This action is irreversible.
\nDeleting a token is permanent. The token_reference can no longer be used for payments.
The associated network token is deactivated with the card network.
\nIf the customer wants to pay with this card again, they will need to re-enter their card details.
\nCustomer explicitly requests removal of their saved card.
\nGDPR or data retention compliance when a customer closes their account.
\nConsider implementing a \"Remove Card\" option in your account management UI.
\nThe Original Credit Transaction (OCT), commonly referred to as Push to Card, enables merchants to facilitate near-instantaneous fund transfers directly to a customer’s eligible Visa or Mastercard debit or credit card. Unlike traditional refund processes that can only return funds from a previous purchase, OCT allows for independent disbursements of funds to a cardholder's account.
\nThis feature is designed for high-velocity industries that require frictionless, real-time payouts, such as:
\nGaming & Betting: Real-time withdrawal of player winnings.
\nMarketplaces: Payouts to sellers or service providers.
\nCorporate Disbursements: Instant insurance claims, rebates, or compensation payments.
\nMerchant Settlements: Faster access to processed funds for sub-merchants.
\nBy utilizing the Aviorapay /payout API with the PAYOUT-CARDS method, you benefit from a unified orchestration layer that handles the complexities of card network routing, ensuring high success rates and global reach while maintaining the same security standards as your standard payment integrations.
Enable OCT: Ensure \"Push to Card\" permissions are enabled for your merchant account in the Aviorapay Merchant Portal.
\nCollect Card Details: Use a secure method to collect the recipient's card number and expiry date or can you Aviorapay's cashier to do that.
\nExecute Payout: Call the /payout endpoint with the OCT-specific payout method.
Handle Webhooks: Listen for the paid or failure events to update your internal records.
Note:
\nIf the merchant is not PCI DSS compliant then they will need to use our cashier and we will show the user all the saved cards for him/her. Based on the card chosen, Aviorapay will pick up the token_reference from our Back end.
\nIf the merchant is PCI DSS compliant then they can use the payout API and send the token reference as shown above.
\n","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"a71c6d13-f943-41cd-a9f8-bf60f11c5ca3","id":"a71c6d13-f943-41cd-a9f8-bf60f11c5ca3","name":"APIs","type":"folder"}},"urlObject":{"path":["payout",""],"host":["https://app.aviorapay.com/api/v1"],"query":[],"variable":[]}},"response":[{"id":"6c687a95-e191-4ff8-acbc-890918484264","name":"Success","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer Token","type":"text"}],"body":{"mode":"raw","raw":"{\n \"client\": {\n \"email\": \"rahul@gmail.com\",\n \"country\": \"GB\",\n \"city\": \"London\",\n \"stateCode\": \"QLD\",\n \"full_name\": \"Rahul Jain\",\n \"street_address\": \"10 New Burlington Street Apt. 214\",\n \"zip_code\": \"W1S 3BE\",\n \"phone\": \"+44 9876543210\",\n \"gender\": \"M\",\n \"date_of_birth\": \"1970-07-10\"\n },\n \"purpose\": \"Testing cards payout\",\n \"currency\": \"GBP\",\n \"merchantRef\": \"YOUR ORDER ID\", // optional\n \"payoutMethod\": \"PAYOUT-CARDS\",\n \"amount\": 100.0,\n \"success_redirect\": \"https://your.success.redirect.com\",\n \"pending_redirect\": \"https://your.pending.redirect.com\",\n \"failure_redirect\": \"https://your.failure.redirect.com\",\n \"success_callback\": \"https://your.success.callback.com\",\n \"failure_callback\": \"https://your.failure.callback.com\",\n \"extraParam\": {\n \"token_reference\": \"token_ref\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://app.aviorapay.com/api/v1/payout/"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"Text","header":[{"key":"Date","value":"Fri, 13 Mar 2026 00:01:17 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Nel","value":"{\"report_to\":\"cf-nel\",\"success_fraction\":0.0,\"max_age\":604800}"},{"key":"X-Frame-Options","value":"ALLOW-FROM *"},{"key":"Referrer-Policy","value":"no-referrer"},{"key":"x-session-id","value":"3ef27476-f274-4f6a-bb18-4c37e01d6dc2"},{"key":"Vary","value":"Origin"},{"key":"Vary","value":"Access-Control-Request-Method"},{"key":"Vary","value":"Access-Control-Request-Headers"},{"key":"Server","value":"cloudflare"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"0"},{"key":"Cache-Control","value":"no-cache, no-store, max-age=0, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Expires","value":"0"},{"key":"Strict-Transport-Security","value":"max-age=31536000 ; includeSubDomains"},{"key":"X-Cache","value":"Error from cloudfront"},{"key":"Via","value":"1.1 05a63efd5ebb043211ccf075f3a8aa68.cloudfront.net (CloudFront)"},{"key":"X-Amz-Cf-Pop","value":"IAD61-P10"},{"key":"X-Amz-Cf-Id","value":"Iw6KuTkxZqm0RH8GJOXAh7uLEPJ6wj8OJbaFWdN_qDx31b5TSinnIA=="},{"key":"cf-cache-status","value":"DYNAMIC"},{"key":"Report-To","value":"{\"group\":\"cf-nel\",\"max_age\":604800,\"endpoints\":[{\"url\":\"https://a.nel.cloudflare.com/report/v4?s=g%2FW8jRMDFXKvTeXNugr1sgR4%2FoTXfyEHsscr3hqeIr2aPhFEVlSs%2FGiTjFw09%2BReVDjxT2esg2Wg0fdBf4oD3snlEv4p1JkITe2l7oLC%2Bkg%3D\"}]}"},{"key":"CF-RAY","value":"9db6c366997196a2-IAD"}],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\n \"payoutId\": \"6977137755e0628e3600c562\",\n \"client\": {\n \"email\": \"rahul@gmail.com\",\n \"country\": \"GB\",\n \"city\": \"London\",\n \"stateCode\": \"QLD\",\n \"full_name\": \"Rahul Jain\",\n \"street_address\": \"10 New Burlington Street Apt. 214\",\n \"zip_code\": \"W1S 3BE\",\n \"phone\": \"+44 9876543210\",\n \"gender\": \"M\",\n \"date_of_birth\": \"1970-07-10\"\n },\n \"updated_on\": 1769411447,\n \"extraParam\": {\n \"token_reference\": \"token_ref\"\n },\n \"payoutMethod\": \"PAYOUT-CARDS\",\n \"amountUnit\": \"MAJOR\",\n \"amount\": 100.0,\n \"errorMsg\": \"\",\n \"purpose\": \"Testing cards payout\",\n \"created_on\": 1769411447,\n \"merchantRef\": \"YOUR ORDER ID\",\n \"status\": \"PAID\",\n \"status_history\": [\n {\n \"status\": \"created\",\n \"timestamp\": 1769411447\n },\n {\n \"status\": \"payout_in_process\",\n \"timestamp\": 1769411447\n },\n {\n \"status\": \"paid\",\n \"timestamp\": 1769411447\n },\n\n ],\n \"currency\": \"GBP\",\n \"extraFee\": \"0\",\n \"paymentOn\": 0,\n \"checkout_url\": \"https://test4.paymentsclub.net/payout/092e59f94279a3742fa3715fe9a2112a/\",\n \"taxAmount\": 0.0,\n \"taxPercent\": 0.0,\n \"success_redirect\": \"https://your.success.redirect.com\",\n \"pending_redirect\": \"https://your.pending.redirect.com\",\n \"failure_redirect\": \"https://your.failure.redirect.com\",\n \"success_callback\": \"https://your.success.callback.com\",\n \"failure_callback\": \"https://your.failure.callback.com\"\n \"redirectType\": \"POST\",\n \"sessionId\": \"\",\n \"surcharge\": 0.0,\n \"surchargeType\": \"\",\n \"trxMethod\": \"CARDS\",\n \"success_callback\": \"\",\n \"failure_callback\": \"\"\n}"}],"_postman_id":"22986ac8-b261-4ac9-8f53-c4a204453916"}],"id":"a71c6d13-f943-41cd-a9f8-bf60f11c5ca3","description":"Network tokenisation in Aviorapay uses four APIs. Together they cover the complete flow: retrieving saved cards, initiating a purchase (with card saving), processing payments with saved tokens, and deleting tokens.
\n","auth":{"type":"noauth","isInherited":false},"event":[{"listen":"prerequest","script":{"type":"text/javascript","packages":{},"requests":{},"exec":[""],"id":"c09d32b5-7d03-4354-b53b-82c6d91ee649"}},{"listen":"test","script":{"type":"text/javascript","packages":{},"requests":{},"exec":[""],"id":"3b9fc878-d786-4394-9bc9-63dcaa1d84f7"}}],"_postman_id":"a71c6d13-f943-41cd-a9f8-bf60f11c5ca3"},{"name":"FAQs","item":[],"id":"41cd3afc-1ee5-465f-a949-1a8ec464bc34","description":"Q1: Do I need to change my existing integration to use network tokenisation?
No. If you already use the Aviorapay Purchase API and the S2S API with token_reference, your integration is already compatible. You just need to enable and configure network tokenisation in your Dashboard (see Section 3).
Q2: What is a token_reference?
A token_reference (e.g., token_7178aa7208614544a285656da38aefac) is Aviorapay’s internal identifier for a saved card. You use it to charge the saved card or delete it. It is not the card number or the network token — Aviorapay manages those internally.
Q3: Does the token_reference expire?
No. The token_reference does not expire. It remains valid as long as the saved card has not been deleted.
Q4: What happens when a customer’s card expires or is replaced?
\nThe card network automatically updates the data linked to the token. Your token_reference stays the same, and payments continue to work without action from you or the customer.
\nQ5: Is CVC required even when using a token_reference?
Yes. CVC is required even when a token_reference is provided. This is needed for 3D Secure authentication on customer-initiated transactions.
Q6: What if a card doesn’t support network tokenisation?
Aviorapay handles this automatically. If a card is not eligible, or if the selected MID does not accept tokens, Aviorapay falls back to the card number. The API response and flow remain the same.
Q7: How long does the token service setup take?
After saving your configuration in Dashboard → Global Settings → Aviorapay Token Service, the status changes to Pending. It may take up to 1 hour to update to Active. Do not use tokenisation APIs until the status is Active.
Q8: Are email addresses case-sensitive for token lookup?
Yes. Email addresses are case-sensitive. Ensure consistent formatting (always lowercase) when creating and retrieving tokens to avoid duplicate or missing entries.
Q9: How do I delete a saved card?
Use the Delete Token API (DELETE /tokens/v1/deleteToken/{token_reference}). This permanently removes the card and deactivates the network token.
Q10: Is there an additional cost?
Pricing details are communicated by your Aviorapay account manager. Some card networks offer reduced interchange fees for tokenised transactions, which may offset service costs.
Aviorapay supports Network Tokenisation to help merchants process card payments with improved security, higher authorisation rates, and seamless card lifecycle management.
\nNetwork tokenisation works entirely behind the scenes. When a cardholder saves their card during a purchase, Aviorapay securely provisions a network token and returns a token_reference. You use this reference for all future payments — you never handle actual card numbers or network tokens directly.
Higher Approval Rates — Payments made with network tokens are recognised as more secure by issuers.
\nAutomatic Card Updates — Card replacements are handled silently by the card network.
\nStronger Security — Each token is merchant-specific and protected by a per-transaction cryptogram.
\nReduced PCI Burden — Store token_reference instead of card numbers.
Zero Integration Overhead — Your existing API integration works as-is.
\nNetwork tokenisation is fully managed by Aviorapay. The integration follows the standard Aviorapay payment APIs:
\nCall the List Saved Cards API to check if the customer has saved cards
\nIf no saved cards exist, initiate a new payment via the Purchase + S2S API
→ If the merchant opts to save the customer card, Aviorapay provisions a network token
→ Customer completes payment
→ A token_reference is generated and linked to the customer and card
For returning customers with saved cards:
→ Display saved cards using cardlast4 from List Saved Cards
→ Customer selects a card and provides CVC
→ Submit token_reference + CVC via the purchase + S2S API
To remove a saved card, call the Delete Token API.
\nNetwork tokenisation happens behind the scenes with no additional API calls and no changes to your existing flow.
\nList Saved Cards — Check if the customer has saved cards
\nPurchase — Initiate a new payment (customer can save card during checkout)
\nS2S Payment — Charge a saved card using token_reference
Delete Token — Remove a saved card permanently
\nYou never see or handle the actual network token. Aviorapay abstracts it entirely behind the token_reference. Your integration stays simple while your customers get the security and reliability benefits of network tokenisation.
\nBefore integrating the pre-authorisation flow, ensure you have the following:
\nAll API requests must include your API key in the request header.
Aviorapay uses bearer token authentication.
Authorization: Bearer {your_api_key}
\nContent-Type: application/json
\nImportant: Never expose your API key in client-side code or public repositories. All API calls must be made server-to-server.
\n","auth":{"type":"noauth","isInherited":false},"event":[{"listen":"prerequest","script":{"type":"text/javascript","packages":{},"requests":{},"exec":[""],"id":"8cb95d1d-43c3-4f50-8687-557f3300877e"}},{"listen":"test","script":{"type":"text/javascript","packages":{},"requests":{},"exec":[""],"id":"6c5cab32-080c-49c9-a3cf-f4d138cb5282"}}],"_postman_id":"93126908-e30c-4fc0-9283-ef684a413138"},{"name":"Payment Flow Overview","item":[],"id":"29612fe3-baef-4d8d-ab9f-6f5d1411b9b5","description":"The pre-authorisation and capture flow involves three distinct stages. Below is a high-level summary of each path the transaction can follow after authorisation.
\nStep 1 - The merchant sends a pre-authorisation request to reserve funds on the customer’s card. If successful, the transaction enters an AUTHORISED state.
\nStep 2a (Capture Path) - The merchant sends a capture request for the full or partial authorised amount. On success, the transaction moves to CAPTURED and funds are settled.
\nStep 2b (Void Path) - If the merchant no longer needs to collect the payment, they send a void request. The hold is released and the transaction moves to VOIDED.
\nThe following diagram describes all possible states:
\nℹ️ Note
\nOnce a transaction is PAID or VOIDED, it cannot be reversed through this flow. Use the Refund API for post-capture reversals.
\nCard networks enforce maximum hold periods. If you do not capture within the validity window, the authorisation expires automatically and funds are released.
\n⚠️ Best Practice
\nCapture as soon as the order is ready to ship or the service is delivered. Delaying capture increases the risk of authorisation expiry and declines.
\n","auth":{"type":"noauth","isInherited":false},"event":[{"listen":"prerequest","script":{"type":"text/javascript","packages":{},"requests":{},"exec":[""],"id":"a560b939-c0fc-4b1a-a117-f2d8385625db"}},{"listen":"test","script":{"type":"text/javascript","packages":{},"requests":{},"exec":[""],"id":"79f9be21-651a-49fb-a386-c7671cbc8194"}}],"_postman_id":"29612fe3-baef-4d8d-ab9f-6f5d1411b9b5"},{"name":"APIs","item":[{"name":"Purchase","id":"9e19c301-d873-4f20-b1af-6c92d89c092e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer Token","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"client\": {\r\n \"email\": \"example@aviorapay.com\",\r\n \"country\": \"IN\",\r\n \"city\": \"123\",\r\n \"stateCode\": \"ca\",\r\n \"street_address\": \"test test\",\r\n \"zip_code\": \"234567\",\r\n \"phone\": \"+91 9999999999\"\r\n },\r\n \"purchase\": {\r\n \"products\": [\r\n {\r\n \"name\": \"dk\",\r\n \"price\": \"10\"\r\n }\r\n ]\r\n },\r\n \"status\": \"created\",\r\n \"brand_id\": \"bd69e8a5-adcf-40de-9e43-2b87cb129a5e\",\r\n \"skip_capture\": true,\r\n \"merchantRef\": \"d9db7ec0-f94c-4a9d-8883-54c19c222d81\",\r\n \"success_redirect\": \"https://your.success.redirect.com\",\r\n \"pending_redirect\": \"https://your.pending.redirect.com\",\r\n \"failure_redirect\": \"https://your.failure.redirect.com\",\r\n \"success_callback\": \"https://your.success.callback.com\",\r\n \"failure_callback\": \"https://your.failure.callback.com\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://app.aviorapay.com/api/v1/purchases","description":"Use this endpoint to authorise a payment without capturing it. This places a temporary hold on the customer’s funds for the specified amount.
\nTo Initiate a payment, the very first call to make is /purchases with the required data in the request body.
To generate a Purchase, you are required to provide the Brand ID (in the request body) and API key (in the header) Both can be located in the Dashboard section of your merchant account login.
The request body structure is shown on the request body of the example request shown here.
\nThe following (see table below) are the mandatory parameters that are required to create a purchase request.
\nThe merchantRef parameter, although not mandatory, is strongly advised for merchants to specify. Its inclusion offers two significant advantages for the merchant:
Prevention of Duplicate Requests: When a merchantRef is utilized, it acts as a unique identifier. This means that if a second purchase request is made using the same merchantRef (reference number), the system will recognize it and prevent duplicate transactions from occurring. This prevents unintended or duplicate purchases.
Facilitation of Transaction Retrieval: In situations where the response from the initial purchase request times out or the 'purchaseId' isn't received, having the merchantRef allows the merchant to retrieve detailed transaction information. This ensures they can track and access the specific purchase details related to that reference, even if the immediate response was not received.
However, if the merchant does not specify the 'merchantRef' parameter, the platform will automatically assign and use an internal 'purchaseId' as a reference for that transaction.
\nUpon successul create on a Purchase you'd get a \"purchaseId\" . Use this ID for the next step in Server to server call by calling p/{purchaseId}/?s2s=true .
The paymentMethod parameter identifies which payment solution merchant wants to use to perform a transaction. If parameter is provided, than Aviorapay will perform direct payment with the selected payment method instead of loading Aviorapay URL.
If there are any errors then it'll be in the format of :
\n{\n \"message\": \"descriptive error message\",\n \"code\": \"error_code\"\n}\n\nThis API would be the 2nd in sequence to call if the call to /purchases/ was successful in step 1. and you want to do the transaction via Server-to-Server mode.
The request body would contain the details of the card that's to be transacted upon.
\nNote:
If you want to use token_reference for doing a card transaction, please have a look at Network Tokenisation Section.
**
Other optional parameters in request body:**
If all the details are correct you'll get a 202 response with staus as Pending
\n{\n \"status\": \"pending\",\n \"callback_url\": \"https://aviorapay.com/payment/63bd0bf80fb42a076e8a4dd1/\",\n \"method\": \"GET\"\n}\n\nIf the response code is 202, after receiving the response body, direct the customer to the callback_url provided in the response.
\nIf there are any errors then it'll be in the format of :
\n{\n \"message\": \"descriptive error message\",\n \"code\": \"error_code\"\n}\n\nPlease see the Status Code section for further details.
\n","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"9e4aaa75-0954-44a4-bb2e-44944b0761e7","id":"9e4aaa75-0954-44a4-bb2e-44944b0761e7","name":"APIs","type":"folder"}},"urlObject":{"path":["p","64bff4fff63e36669499e9c8",""],"host":["https://app.aviorapay.com/api/v1"],"query":[{"key":"s2s","value":"true"}],"variable":[]}},"response":[{"id":"d2df9f32-ce92-4f70-96c8-62ce25558e57","name":"Success","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer Token","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"cardholder_name\": \"dk\",\r\n \"card_number\": \"411111111111111\",\r\n \"expires\": \"10/23\",\r\n \"cvc\": \"345\",\r\n \"remember_card\": \"on\",\r\n \"remote_ip\": \"157.38.242.7\",\r\n \"user_agent\": \"Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/51.0.2704.103 Safari/537.36\",\r\n \"accept_header\": \"text/html\",\r\n \"language\": \"en-US\",\r\n \"java_enabled\": false,\r\n \"javascript_enabled\": true,\r\n \"color_depth\": 24,\r\n \"utc_offset\": 0,\r\n \"screen_width\": 1920,\r\n \"screen_height\": 1080\r\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://app.aviorapay.com/api/v1/p/64bff4fff63e36669499e9c8/?s2s=true","host":["https://app.aviorapay.com/api/v1"],"path":["p","64bff4fff63e36669499e9c8",""],"query":[{"key":"s2s","value":"true"}]}},"status":"Accepted","code":202,"_postman_previewlanguage":"json","header":[{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"Cache-Control","value":"no-cache, no-store, max-age=0, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Expires","value":"0"},{"key":"X-Frame-Options","value":"DENY"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Date","value":"Thu, 13 Jul 2023 17:31:55 GMT"},{"key":"Keep-Alive","value":"timeout=60"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"pending\",\n \"callback_url\": \"http://18.214.100.20/api/v1/payment/64b034ecc6dccf7d329d9eb3/\",\n \"method\": \"GET\"\n}"},{"id":"108a4aee-37d9-4456-a97a-3a5d6f1eca59","name":"Failure","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer Token","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"cardholder_name\": \"dk\",\r\n \"card_number\": \"4111111111111111\",\r\n \"expires\": \"10/23\",\r\n \"cvc\": \"345\",\r\n \"remember_card\": \"on\",\r\n \"remote_ip\": \"157.38.242.7\",\r\n \"user_agent\": \"Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/51.0.2704.103 Safari/537.36\",\r\n \"accept_header\": \"text/html\",\r\n \"language\": \"en-US\",\r\n \"java_enabled\": false,\r\n \"javascript_enabled\": true,\r\n \"color_depth\": 24,\r\n \"utc_offset\": 0,\r\n \"screen_width\": 1920,\r\n \"screen_height\": 1080\r\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://app.aviorapay.com/api/v1/p/64bff4fff63e36669499e9c8/?s2s=true","host":["https://app.aviorapay.com/api/v1"],"path":["p","64bff4fff63e36669499e9c8",""],"query":[{"key":"s2s","value":"true"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"Text","header":[{"key":"Date","value":"Tue, 06 Jan 2026 05:57:10 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Nel","value":"{\"report_to\":\"cf-nel\",\"success_fraction\":0.0,\"max_age\":604800}"},{"key":"X-Frame-Options","value":"ALLOW-FROM *"},{"key":"Referrer-Policy","value":"no-referrer"},{"key":"x-session-id","value":"cc434220-0bcd-42c7-9078-53503b81a221"},{"key":"Vary","value":"Origin"},{"key":"Vary","value":"Access-Control-Request-Method"},{"key":"Vary","value":"Access-Control-Request-Headers"},{"key":"Server","value":"cloudflare"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"0"},{"key":"Cache-Control","value":"no-cache, no-store, max-age=0, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Expires","value":"0"},{"key":"Strict-Transport-Security","value":"max-age=31536000 ; includeSubDomains"},{"key":"X-Cache","value":"Error from cloudfront"},{"key":"Via","value":"1.1 9bce423254194c16408d5cf7234126e2.cloudfront.net (CloudFront)"},{"key":"X-Amz-Cf-Pop","value":"IAD61-P10"},{"key":"X-Amz-Cf-Id","value":"FgTt6KEGIk0CH79DQDOvB1tYb1pGfaz0ryIVmQ0CCpDShyhsJGuAkA=="},{"key":"cf-cache-status","value":"DYNAMIC"},{"key":"Report-To","value":"{\"group\":\"cf-nel\",\"max_age\":604800,\"endpoints\":[{\"url\":\"https://a.nel.cloudflare.com/report/v4?s=9SnHJOEjnd1y7hArGsRLWmrk8H9ExaiR%2Fc%2BQMWhAvHlNPYCNEjS60wTjIyODXpca0ZD9%2BalkhLJ63boMGg%2B8iI6eFtXfW%2BxwGaBP1p1ZcwpA\"}]}"},{"key":"CF-RAY","value":"9b98f9f4684505e7-IAD"},{"key":"alt-svc","value":"h3=\":443\"; ma=86400"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Authorization header missing\",\n \"code\": \"authentication_failed\"\n}"}],"_postman_id":"653fdbd8-3ee6-4bb0-97be-44ad0eb96e53"},{"name":"Capture","id":"656886bb-73ac-4159-8d09-d77d21914b15","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer Token"}],"body":{"mode":"raw","raw":"{\n \"merchant_reference\": \"64534345\"\n}","options":{"raw":{"language":"json"}}},"url":"https://app.aviorapay.com/api/v1/purchases/69cd26b053d7b783ebf6b6e9/capture","description":"After a successful pre-authorisation, use this endpoint to capture (settle) the held funds. You may capture the full authorised amount or a partial amount.
\n","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"9e4aaa75-0954-44a4-bb2e-44944b0761e7","id":"9e4aaa75-0954-44a4-bb2e-44944b0761e7","name":"APIs","type":"folder"}},"urlObject":{"path":["purchases","69cd26b053d7b783ebf6b6e9","capture"],"host":["https://app.aviorapay.com/api/v1"],"query":[],"variable":[]}},"response":[{"id":"194e4f63-f96c-4f41-ac0f-153c5eae79c2","name":"Capture","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer Token"}],"body":{"mode":"raw","raw":"{\n \"merchant_reference\": \"64534345\"\n}","options":{"raw":{"language":"json"}}},"url":"https://app.aviorapay.com/api/v1/purchases/69cd26b053d7b783ebf6b6e9/capture"},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"Text","header":[{"key":"Date","value":"Wed, 01 Apr 2026 17:16:51 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Nel","value":"{\"report_to\":\"cf-nel\",\"success_fraction\":0.0,\"max_age\":604800}"},{"key":"X-Frame-Options","value":"ALLOW-FROM *"},{"key":"Referrer-Policy","value":"no-referrer"},{"key":"x-session-id","value":"72818dba-381a-449a-8351-390453ddbf72"},{"key":"Vary","value":"Origin"},{"key":"Vary","value":"Access-Control-Request-Method"},{"key":"Vary","value":"Access-Control-Request-Headers"},{"key":"Server","value":"cloudflare"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"0"},{"key":"Cache-Control","value":"no-cache, no-store, max-age=0, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Expires","value":"0"},{"key":"Strict-Transport-Security","value":"max-age=31536000 ; includeSubDomains"},{"key":"X-Cache","value":"Error from cloudfront"},{"key":"Via","value":"1.1 3578d122de1401ebc52a7afd35dd5d0c.cloudfront.net (CloudFront)"},{"key":"X-Amz-Cf-Pop","value":"IAD61-P10"},{"key":"X-Amz-Cf-Id","value":"zEG99N28vChcugkKEe-mJxhNgum-PAK1lcn_2mKqagcBd5deWquIjw=="},{"key":"cf-cache-status","value":"DYNAMIC"},{"key":"Report-To","value":"{\"group\":\"cf-nel\",\"max_age\":604800,\"endpoints\":[{\"url\":\"https://a.nel.cloudflare.com/report/v4?s=EnQbeJo0VkBTF%2BqefkY%2BZ1OejkL%2BkIkR76eA5%2FtL3qaxYlOL1ehFjmSIpGl5i91OldfFB41NXeRXp3E43WxFSEhlUj7OgOqbI6eYZs%2B%2BcUBdewUDmvk46tJrDA5WO53Bib8q\"}]}"},{"key":"CF-RAY","value":"9e593e77fb953ec9-IAD"}],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\n \"purchaseId\": \"69cd361053d7b783ebf7324d\",\n \"client\": {\n \"customerId\": \"NA\",\n \"email\": \"kailashvishnoi126741@aviorapay.co\",\n \"full_name\": \"akshaya singhal\",\n \"date_of_birth\": \"1800-01-01\",\n \"street_address\": \"123\",\n \"country\": \"ZM\",\n \"city\": \"jaipur\",\n \"zip_code\": \"234567\",\n \"cc\": [],\n \"bcc\": [],\n \"stateCode\": \"CA\"\n },\n \"updated_on\": 1775056447,\n \"type\": \"purchase\",\n \"paymentMethod\": \"MASTER,VISA,VIRTUAL-IBAN,CRYPTO-WALLET,MAYA,GCASH,QRPH,BANKTRANSFER,NETBANKING,UPI-QR,PAYPLAY,UPI-INTENT,MOBILEMONEY,GOOGLEPAY,APPLEPAY\",\n \"amountUnit\": \"MAJOR\",\n \"errorMsg\": \"\",\n \"errorCode\": \"NA\",\n \"force_recurring\": false,\n \"created_on\": 1775056400,\n \"extraParam\": {\n \"aft\": {\n \"account_owner_address1\": \"test\",\n \"account_owner_address2\": \"test\",\n \"account_owner_street\": \"test\",\n \"account_owner_postal_code\": \"123\",\n \"account_owner_city\": \"test\",\n \"account_owner_country\": \"UK\",\n \"merchant_postal_code\": \"123\",\n \"merchant_state\": \"FRA\",\n \"acceptor_legal_name\": \"test\",\n \"sender_address\": \"test\",\n \"sender_city\": \"test\",\n \"sender_state\": \"RJ\",\n \"sender_country\": \"FRA\",\n \"sender_name\": \"test\",\n \"sender_account_number\": \"test\",\n \"recipient_name\": \"test\",\n \"bai\": \"AA\"\n }\n },\n \"merchantRef\": \"69cd361053d7b783ebf7324d\",\n \"purchase\": {\n \"currency\": \"EUR\",\n \"products\": [\n {\n \"name\": \"gaming cards\",\n \"quantity\": 1.0,\n \"price\": 10.0,\n \"discount\": 0,\n \"tax_percent\": \"0.00\"\n }\n ],\n \"total\": 10.0,\n \"requestAmount\": 10.0,\n \"language\": \"en\",\n \"notes\": \"\",\n \"debt\": 0,\n \"total_formatted\": 1.0,\n \"taxAmount\": 0.0,\n \"taxPercent\": 0.0,\n \"request_client_details\": [],\n \"email_message\": \"\"\n },\n \"payment\": {\n \"is_outgoing\": false,\n \"payment_type\": \"PURCHASE\",\n \"amount\": 10.0,\n \"currency\": \"EUR\",\n \"net_amount\": 10.0,\n \"fee_amount\": 0.0,\n \"pending_amount\": 0.0,\n \"pending_unfreeze_on\": null,\n \"description\": \"\",\n \"paid_on\": 1775056410,\n \"remote_paid_on\": 1775056410\n },\n \"issuer_details\": {\n \"website\": \"\",\n \"legal_street_address\": \"\",\n \"legal_country\": \"\",\n \"legal_city\": \"\",\n \"legal_zip_code\": \"\",\n \"bank_accounts\": [\n {}\n ],\n \"legal_name\": \"ECOMTEST1\",\n \"brand_name\": \"ECOMTEST1\",\n \"registration_number\": \"\",\n \"tax_number\": \"\"\n },\n \"transaction_data\": {\n \"payment_method\": \"\",\n \"flow\": \"payform\",\n \"extra\": {\n \"expiry_month\": \"12\",\n \"amount\": 10.0,\n \"card_issuer\": \"ING BELGIUM, S.A.\",\n \"masked_pan\": \"46401701****6658\",\n \"card_brand\": \"VISA\",\n \"card_issuer_country\": \"BE\",\n \"card_type\": \"CREDIT\",\n \"cardholder_name\": \"Sank\",\n \"expiry_year\": \"28\"\n },\n \"country\": \"\",\n \"attempts\": [\n {\n \"client_ip\": \"223.235.99.134\",\n \"type\": \"execute\",\n \"payment_method\": \"VISA\",\n \"flow\": \"payform\",\n \"successful\": true,\n \"country\": \"BE\",\n \"processing_time\": 1775056410,\n \"extra\": {\n \"expiry_month\": \"12\",\n \"amount\": 10.0,\n \"card_issuer\": \"ING BELGIUM, S.A.\",\n \"masked_pan\": \"46401701****6658\",\n \"card_brand\": \"VISA\",\n \"card_issuer_country\": \"BE\",\n \"card_type\": \"CREDIT\",\n \"cardholder_name\": \"Sank\",\n \"expiry_year\": \"28\"\n }\n }\n ]\n },\n \"status\": \"PAID\",\n \"status_history\": [\n {\n \"status\": \"created\",\n \"timestamp\": 1775056400\n },\n {\n \"status\": \"pending_execute\",\n \"timestamp\": 1775056410\n },\n {\n \"status\": \"payment_in_process\",\n \"timestamp\": 1775056410\n },\n {\n \"status\": \"3DS success\",\n \"timestamp\": 1775056424\n },\n {\n \"status\": \"preauthorized\",\n \"timestamp\": 1775056428\n },\n {\n \"status\": \"capture_in_process\",\n \"timestamp\": 1775056447\n },\n {\n \"status\": \"paid\",\n \"timestamp\": 1775056447\n }\n ],\n \"is_test\": false,\n \"brand_id\": \"bab077d5-df4d-4fda-8c6c-2f78d97c9a16\",\n \"send_receipt\": false,\n \"is_recurring_token\": false,\n \"skip_capture\": true,\n \"reference_generated\": \"PS1673\",\n \"issued\": \"2026-04-01\",\n \"due\": 1775056400,\n \"refund_upto\": 1776089649,\n \"cc_descriptor\": \"\",\n \"fraudScore\": \"NA\",\n \"trustScore\": \"NA\",\n \"extraFee\": \"0\",\n \"pix_payload\": {},\n \"payInDetails\": {},\n \"paidOn\": 1775056449,\n \"receivedAmt\": 0.0,\n \"captureTxns\": [\n {\n \"captureId\": \"41e31f9f-1e98-4f4d-b48c-7d1ed488fc3f\",\n \"purchaseId\": \"69cd361053d7b783ebf7324d\",\n \"amount\": 10.0,\n \"fxAmount\": 10.0,\n \"status\": \"PAID\",\n \"pspReference\": null,\n \"merchantReference\": \"64534345\",\n \"createdAt\": 1775056447,\n \"updatedAt\": 1775056447,\n \"whiteId\": 0,\n \"fxCurrency\": \"EUR\",\n \"bankMid\": \"payneticsexternal3ds\",\n \"isTest\": false,\n \"currency\": \"EUR\",\n \"amountInUsd\": 11.85,\n \"merchantName\": \"KailashMerchant\",\n \"bankName\": \"paynatics-aft_\",\n \"bankId\": \"532\",\n \"trxMethod\": \"CARDS\",\n \"rollingReserve\": 0.0,\n \"transFees\": 0.0,\n \"mdr\": 0.0,\n \"isSettlementPending\": 0,\n \"parentId\": 0,\n \"transSettlementId\": null,\n \"errorSettlementId\": null,\n \"merchantId\": \"589\"\n }\n ],\n \"taxAmount\": 0.0,\n \"surcharge\": 0.0,\n \"surchargeType\": \"\",\n \"sessionId\": \"\",\n \"refund_availability\": \"NONE\",\n \"refundable_amount\": 10.0,\n \"success_redirect\": \"https://google.com/getResponse.jsp?issucces=true\",\n \"failure_redirect\": \"https://google.com/getResponse.jsp?issucces=false\",\n \"cancel_redirect\": \"\",\n \"success_callback\": \"https://www.google.com/\",\n \"failure_callback\": \"https://staging.aviorapay.com/merchant\",\n \"platform\": \"API\",\n \"created_from_ip\": \"223.235.99.134\",\n \"checkout_url\": \"https://staging.aviorapay.com/payments/47395a8217d29014a4af6b1c494ac06b/\",\n \"direct_post_url\": \"https://staging.aviorapay.com/api/v1/p/69cd361053d7b783ebf7324d/\",\n \"payoutProcess\": false\n}"}],"_postman_id":"656886bb-73ac-4159-8d09-d77d21914b15"},{"name":"Cancel","id":"777f18dc-46c1-4359-beb5-fcb229f0ef62","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"Bearer 309855a6e22c2bc9873f11ee5997cb3ff246a8e8ec4f009f2924ad7178b2ad7b"}],"url":"https://app.aviorapay.com/api/v1/purchases/69ca76dbace4fa4413db928c/cancel","description":"Use this endpoint to cancel an authorised payment before it has been captured. Voiding releases the held funds back to the customer immediately.
\n","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"9e4aaa75-0954-44a4-bb2e-44944b0761e7","id":"9e4aaa75-0954-44a4-bb2e-44944b0761e7","name":"APIs","type":"folder"}},"urlObject":{"path":["purchases","69ca76dbace4fa4413db928c","cancel"],"host":["https://app.aviorapay.com/api/v1"],"query":[],"variable":[]}},"response":[{"id":"1ca5fbf1-1242-4661-b633-d87ab21fa380","name":"Cancel","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer 309855a6e22c2bc9873f11ee5997cb3ff246a8e8ec4f009f2924ad7178b2ad7b"}],"url":"https://app.aviorapay.com/api/v1/purchases/69ca76dbace4fa4413db928c/cancel"},"status":"Method Not Allowed","code":405,"_postman_previewlanguage":"Text","header":[{"key":"Date","value":"Wed, 01 Apr 2026 17:18:25 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Nel","value":"{\"report_to\":\"cf-nel\",\"success_fraction\":0.0,\"max_age\":604800}"},{"key":"X-Frame-Options","value":"ALLOW-FROM *"},{"key":"Referrer-Policy","value":"no-referrer"},{"key":"x-session-id","value":"1c9b7d67-8dec-4e71-b35b-7952f23b67ed"},{"key":"Vary","value":"Origin"},{"key":"Vary","value":"Access-Control-Request-Method"},{"key":"Vary","value":"Access-Control-Request-Headers"},{"key":"Server","value":"cloudflare"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"0"},{"key":"Cache-Control","value":"no-cache, no-store, max-age=0, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Expires","value":"0"},{"key":"Strict-Transport-Security","value":"max-age=31536000 ; includeSubDomains"},{"key":"X-Cache","value":"Error from cloudfront"},{"key":"Via","value":"1.1 8bd3b44b8e417f2b75cd6e631907112a.cloudfront.net (CloudFront)"},{"key":"X-Amz-Cf-Pop","value":"IAD61-P10"},{"key":"X-Amz-Cf-Id","value":"WSuVRaHm9E64itnjsFWAyBSPCR8YOFpZr7jY-NAhT-Ae-3_bc-hNTw=="},{"key":"cf-cache-status","value":"DYNAMIC"},{"key":"Report-To","value":"{\"group\":\"cf-nel\",\"max_age\":604800,\"endpoints\":[{\"url\":\"https://a.nel.cloudflare.com/report/v4?s=%2FOrvZsMz3WoHOQDEvKgGSADamNtnaGrILftqtr5BiqYIlUvgXZT89lPPwyXtpIDJW8BNOXjG%2FgAQmYnOUsUpQZ%2BDIVJsSDsxo4FxOEgIKcxPYcG21xgzcTNpNqbnk%2Fnw%2FEki\"}]}"},{"key":"CF-RAY","value":"9e5940bd580a07ed-IAD"}],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\n \"purchaseId\": \"69cd36c353d7b783ebf743e9\",\n \"client\": {\n \"customerId\": \"NA\",\n \"email\": \"kailashvishnoi126741@aviorapay.co\",\n \"full_name\": \"akshaya singhal\",\n \"date_of_birth\": \"1800-01-01\",\n \"street_address\": \"123\",\n \"country\": \"ZM\",\n \"city\": \"jaipur\",\n \"zip_code\": \"234567\",\n \"cc\": [],\n \"bcc\": [],\n \"stateCode\": \"CA\"\n },\n \"updated_on\": 1775056649,\n \"type\": \"purchase\",\n \"paymentMethod\": \"MASTER,VISA,VIRTUAL-IBAN,CRYPTO-WALLET,MAYA,GCASH,QRPH,BANKTRANSFER,NETBANKING,UPI-QR,PAYPLAY,UPI-INTENT,MOBILEMONEY,GOOGLEPAY,APPLEPAY\",\n \"amountUnit\": \"MAJOR\",\n \"errorMsg\": \"\",\n \"errorCode\": \"NA\",\n \"force_recurring\": false,\n \"created_on\": 1775056579,\n \"extraParam\": {\n \"aft\": {\n \"account_owner_address1\": \"test\",\n \"account_owner_address2\": \"test\",\n \"account_owner_street\": \"test\",\n \"account_owner_postal_code\": \"123\",\n \"account_owner_city\": \"test\",\n \"account_owner_country\": \"UK\",\n \"merchant_postal_code\": \"123\",\n \"merchant_state\": \"FRA\",\n \"acceptor_legal_name\": \"test\",\n \"sender_address\": \"test\",\n \"sender_city\": \"test\",\n \"sender_state\": \"RJ\",\n \"sender_country\": \"FRA\",\n \"sender_name\": \"test\",\n \"sender_account_number\": \"test\",\n \"recipient_name\": \"test\",\n \"bai\": \"AA\"\n }\n },\n \"merchantRef\": \"69cd36c353d7b783ebf743e9\",\n \"purchase\": {\n \"currency\": \"EUR\",\n \"products\": [\n {\n \"name\": \"gaming cards\",\n \"quantity\": 1.0,\n \"price\": 10.0,\n \"discount\": 0,\n \"tax_percent\": \"0.00\"\n }\n ],\n \"total\": 10.0,\n \"requestAmount\": 10.0,\n \"language\": \"en\",\n \"notes\": \"\",\n \"debt\": 0,\n \"total_formatted\": 1.0,\n \"taxAmount\": 0.0,\n \"taxPercent\": 0.0,\n \"request_client_details\": [],\n \"email_message\": \"\"\n },\n \"payment\": {\n \"is_outgoing\": false,\n \"payment_type\": \"PURCHASE\",\n \"amount\": 10.0,\n \"currency\": \"EUR\",\n \"net_amount\": 10.0,\n \"fee_amount\": 0.0,\n \"pending_amount\": 0.0,\n \"pending_unfreeze_on\": null,\n \"description\": \"\",\n \"paid_on\": 1775056600,\n \"remote_paid_on\": 1775056600\n },\n \"issuer_details\": {\n \"website\": \"\",\n \"legal_street_address\": \"\",\n \"legal_country\": \"\",\n \"legal_city\": \"\",\n \"legal_zip_code\": \"\",\n \"bank_accounts\": [\n {}\n ],\n \"legal_name\": \"ECOMTEST1\",\n \"brand_name\": \"ECOMTEST1\",\n \"registration_number\": \"\",\n \"tax_number\": \"\"\n },\n \"transaction_data\": {\n \"payment_method\": \"\",\n \"flow\": \"payform\",\n \"extra\": {\n \"expiry_month\": \"12\",\n \"amount\": 10.0,\n \"card_issuer\": \"JPMORGAN CHASE BANK, N.A.\",\n \"masked_pan\": \"42000000****0000\",\n \"card_brand\": \"VISA\",\n \"card_issuer_country\": \"US\",\n \"card_type\": \"CREDIT\",\n \"cardholder_name\": \"Sank\",\n \"expiry_year\": \"28\"\n },\n \"country\": \"\",\n \"attempts\": [\n {\n \"client_ip\": \"223.235.99.134\",\n \"type\": \"execute\",\n \"payment_method\": \"VISA\",\n \"flow\": \"payform\",\n \"successful\": true,\n \"country\": \"US\",\n \"processing_time\": 1775056600,\n \"extra\": {\n \"expiry_month\": \"12\",\n \"amount\": 10.0,\n \"card_issuer\": \"JPMORGAN CHASE BANK, N.A.\",\n \"masked_pan\": \"42000000****0000\",\n \"card_brand\": \"VISA\",\n \"card_issuer_country\": \"US\",\n \"card_type\": \"CREDIT\",\n \"cardholder_name\": \"Sank\",\n \"expiry_year\": \"28\"\n }\n }\n ]\n },\n \"status\": \"CANCELLED\",\n \"status_history\": [\n {\n \"status\": \"created\",\n \"timestamp\": 1775056579\n },\n {\n \"status\": \"pending_execute\",\n \"timestamp\": 1775056600\n },\n {\n \"status\": \"payment_in_process\",\n \"timestamp\": 1775056600\n },\n {\n \"status\": \"3DS success\",\n \"timestamp\": 1775056607\n },\n {\n \"status\": \"preauthorized\",\n \"timestamp\": 1775056611\n },\n {\n \"status\": \"void_in_process\",\n \"timestamp\": 1775056632\n },\n {\n \"status\": \"preauthorized\",\n \"timestamp\": 1775056632\n },\n {\n \"status\": \"void_in_process\",\n \"timestamp\": 1775056647\n },\n {\n \"status\": \"cancelled\",\n \"timestamp\": 1775056649\n }\n ],\n \"is_test\": false,\n \"brand_id\": \"bab077d5-df4d-4fda-8c6c-2f78d97c9a16\",\n \"send_receipt\": false,\n \"is_recurring_token\": false,\n \"skip_capture\": true,\n \"reference_generated\": \"PS1675\",\n \"issued\": \"2026-04-01\",\n \"due\": 1775056579,\n \"refund_upto\": 1776089849,\n \"cc_descriptor\": \"\",\n \"fraudScore\": \"NA\",\n \"trustScore\": \"NA\",\n \"extraFee\": \"0\",\n \"pix_payload\": {},\n \"payInDetails\": {},\n \"paidOn\": 0,\n \"receivedAmt\": 0.0,\n \"taxAmount\": 0.0,\n \"surcharge\": 0.0,\n \"surchargeType\": \"\",\n \"sessionId\": \"\",\n \"refund_availability\": \"NONE\",\n \"refundable_amount\": 10.0,\n \"success_redirect\": \"https://google.com/getResponse.jsp?issucces=true\",\n \"failure_redirect\": \"https://google.com/getResponse.jsp?issucces=false\",\n \"cancel_redirect\": \"\",\n \"success_callback\": \"https://www.google.com/\",\n \"failure_callback\": \"https://staging.aviorapay.com/merchant\",\n \"platform\": \"API\",\n \"created_from_ip\": \"223.235.99.134\",\n \"checkout_url\": \"https://staging.aviorapay.com/payments/23182fc42998cb02b4a3e6aa5c3e26c8/\",\n \"direct_post_url\": \"https://staging.aviorapay.com/api/v1/p/69cd36c353d7b783ebf743e9/\",\n \"payoutProcess\": false\n}"}],"_postman_id":"777f18dc-46c1-4359-beb5-fcb229f0ef62"}],"id":"9e4aaa75-0954-44a4-bb2e-44944b0761e7","auth":{"type":"noauth","isInherited":false},"event":[{"listen":"prerequest","script":{"type":"text/javascript","packages":{},"requests":{},"exec":[""],"id":"f023ce6b-dd21-41d0-bb9f-dc7eb0747f46"}},{"listen":"test","script":{"type":"text/javascript","packages":{},"requests":{},"exec":[""],"id":"ff4ef428-1186-45b1-abd5-247a34baeb66"}}],"_postman_id":"9e4aaa75-0954-44a4-bb2e-44944b0761e7","description":""},{"name":"Transaction Status Lifecycle","item":[],"id":"462574e2-2e32-4b4f-9d72-669ef0086d10","description":"Every payment processed through the pre-authorisation flow passes through a series of statuses. Understanding these statuses is critical for building robust integrations.
\n","_postman_id":"462574e2-2e32-4b4f-9d72-669ef0086d10"},{"name":"Best Practices","item":[],"id":"d77c82fb-234c-4882-b2b6-bc5728e69408","description":"Capture payments as soon as the goods are shipped or the service is delivered. The longer you wait, the higher the risk of authorisation expiry, customer disputes, and declined captures.
\nAlways include the X-Idempotency-Key header for all write operations (authorise, capture, void). This protects against duplicate transactions caused by network timeouts or retries.
\nDo not rely solely on synchronous API responses for business logic. Implement webhook handlers to receive real-time status updates and use them as the source of truth for transaction state in your system.
\nImplement retry logic with exponential backoff for 5xx errors and 429 (rate limit) responses. For 4xx errors, parse the error response body and handle each error code appropriately in your application logic.
\nIf you are handling raw card numbers, you must be PCI DSS Level 1 certified. Aviorapay strongly recommends using tokenised payment methods to minimise your PCI scope. Use the Aviorapay Cashier or client-side SDK to tokenise card details before they reach your server.
\nUse the reference field on authorise, capture, and void requests to associate Aviorapay transactions with your internal order system. The balances object in every response provides a real-time breakdown for reconciliation.
\nEnable 3DS for all pre-authorisation requests where supported. This shifts fraud liability to the card issuer and reduces chargebacks. Aviorapay supports 3DS 2.x with frictionless and challenge flows.
\n","auth":{"type":"noauth","isInherited":false},"event":[{"listen":"prerequest","script":{"type":"text/javascript","packages":{},"requests":{},"exec":[""],"id":"c99b06a1-1fc9-45d7-8f65-ca87c5169b0b"}},{"listen":"test","script":{"type":"text/javascript","packages":{},"requests":{},"exec":[""],"id":"c9eb61ce-7df4-4961-890d-475f37bb4949"}}],"_postman_id":"d77c82fb-234c-4882-b2b6-bc5728e69408"},{"name":"Frequently Asked Questions","item":[],"id":"daa5e1bb-9f2a-4ec9-a23d-b4a092632fbb","description":"Q: Can I capture more than the authorised amount?
\nA: No. The capture amount must be less than or equal to the authorised amount. If you need to charge more, you must create a new authorisation for the additional amount.
\nQ: Can I perform multiple partial captures on a single authorisation?
\nA: Yes. Aviorapay supports multiple captures per authorisation. But you will need to contact the support team for enabling the same.
\nQ: What happens if I do not capture before the authorisation expires?
\nA: The authorisation automatically expires and the held funds are released back to the customer. You will receive a payment.expired webhook event. You must create a new authorisation to charge the customer.
\nQ: Can I void a payment after it has been captured?
\nA: No. Once a payment is captured, you must use the Refund API to return funds. The void endpoint only works for payments in AUTHORISED status.
\nQ: How long does a void take to reflect on the customer’s statement?
\nA: Typically, the hold is removed within 1–3 business days, depending on the issuing bank. Some banks may take up to 7 days to release the hold.
\nQ: Does the customer see the pre-authorisation on their statement?
\nA: Yes. The customer will see a pending charge for the authorised amount. This pending charge is released upon void or expiry, or replaced by the final charge upon capture.
\nQ: Can I use pre-authorisation with non-card payment methods?
\nA: Pre-authorisation is primarily supported for card payments. Support for alternative payment methods varies. Check the Aviorapay payment methods documentation for details.
\nQ: Is 3D Secure required for pre-authorisations?
\nA: 3DS is not required but is strongly recommended. It reduces fraud liability and chargeback risk. Aviorapay supports 3DS on all card pre-authorisation requests.
\n","_postman_id":"daa5e1bb-9f2a-4ec9-a23d-b4a092632fbb"}],"id":"88962324-13c3-4ee5-93c0-ad1cbc63c2bf","description":"Pre-authorisation (also known as \"auth only\") is a two-step payment process where a merchant first reserves (holds) funds on a customer’s payment method without immediately capturing the amount. This allows the merchant to verify fund availability before fulfilling an order, then capture (settle) the payment at a later time — or void (cancel) the hold if the order is not fulfilled.
\nPre-authorisation is ideal for scenarios where the final transaction amount may change, or where goods/services are not delivered immediately. Common use cases include:
\nURL :- /getBalance/
\nRequestType: POST
\nRequest Body
\nNote: Currency is not a mandatory parameter. If no parameter is specified then all respective currency balances would be provided, if any specific currency parameter is provided then only that currency balance would be provided.
\n","urlObject":{"path":["getBalance"],"host":[""],"query":[],"variable":[]}},"response":[{"id":"e7f63979-e40e-49a1-ba67-2e6a76898c59","name":"Checking Balance payout-success","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{ \r\n \"paymentMethod\" : \"PAYOUT-INTERAC-ETRANSFER\"\r\n}\r\n","options":{"raw":{"language":"json"}}},"url":"/getBalance"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"paymentMethod\": \"PAYOUT-INTERAC-ETRANSFER\",\n \"status\": \"success\",\n \"gateways\": [\n {\n \"gatewayName\": \"payhost\",\n \"status\": \"success\",\n \"error\": null,\n \"balances\": [\n {\n \"currency\": \"CAD\",\n \"balance\": 808.380000\n },\n {\n \"currency\": \"USD\",\n \"balance\": 803.380000\n }\n ]\n },\n {\n \"gatewayName\": \"aviorapay\",\n \"status\": \"success\",\n \"error\": null,\n \"balances\": [\n {\n \"currency\": \"CAD\",\n \"balance\": 808.380000\n },\n {\n \"currency\": \"USD\",\n \"balance\": 808.380000\n }\n ]\n }\n ],\n \"aggregatedBalances\": [\n {\n \"currency\": \"CAD\",\n \"balance\": 1616.760000\n },\n {\n \"currency\": \"USD\",\n \"balance\": 1611.760000\n }\n ]\n}"},{"id":"24403941-1a72-42ca-82b9-96e8a3935877","name":"Checking Balance partial-success","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{ \r\n \"paymentMethod\" : \"CARDS\"\r\n}\r\n","options":{"raw":{"language":"json"}}},"url":"/getBalance"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"paymentMethod\": \"CARDS\",\n \"status\": \"partial\",\n \"gateways\": [\n {\n \"gatewayName\": \"a55Mandate\",\n \"status\": \"failed\",\n \"error\": {\n \"code\": \"error\",\n \"message\": \"Bank does not provide balance\"\n },\n \"balances\": []\n },\n {\n \"gatewayName\": \"bk_sbx_smilepayz_pix_payin\",\n \"status\": \"success\",\n \"error\": null,\n \"balances\": [\n {\n \"currency\": \"IDR\",\n \"balance\": 250000.000000\n }\n ]\n },\n {\n \"gatewayName\": \"aviorapay\",\n \"status\": \"success\",\n \"error\": null,\n \"balances\": [\n {\n \"currency\": \"AED\",\n \"balance\": 0.000000\n },\n {\n \"currency\": \"AUD\",\n \"balance\": 3412.000000\n },\n {\n \"currency\": \"BRL\",\n \"balance\": 100.089996\n },\n {\n \"currency\": \"BTC\",\n \"balance\": 0.000000\n },\n {\n \"currency\": \"BXC\",\n \"balance\": 0.000000\n },\n {\n \"currency\": \"CAD\",\n \"balance\": 1000.000000\n },\n {\n \"currency\": \"CDF\",\n \"balance\": 0.000000\n },\n {\n \"currency\": \"COP\",\n \"balance\": 0.000000\n },\n {\n \"currency\": \"DKK\",\n \"balance\": 0.000000\n },\n {\n \"currency\": \"EGP\",\n \"balance\": 0.000000\n },\n {\n \"currency\": \"ETH\",\n \"balance\": 0.000000\n },\n {\n \"currency\": \"EUR\",\n \"balance\": 0.000000\n },\n {\n \"currency\": \"GBP\",\n \"balance\": -24.327801\n },\n {\n \"currency\": \"GHS\",\n \"balance\": 0.000000\n },\n {\n \"currency\": \"IDR\",\n \"balance\": 1000.000000\n },\n {\n \"currency\": \"INR\",\n \"balance\": 0.000000\n },\n {\n \"currency\": \"JPY\",\n \"balance\": 0.000000\n },\n {\n \"currency\": \"KES\",\n \"balance\": 0.000000\n },\n {\n \"currency\": \"MWK\",\n \"balance\": 0.000000\n },\n {\n \"currency\": \"MXN\",\n \"balance\": -4.770000\n },\n {\n \"currency\": \"NGN\",\n \"balance\": 0.000000\n },\n {\n \"currency\": \"NZD\",\n \"balance\": 0.000000\n },\n {\n \"currency\": \"RWF\",\n \"balance\": 0.000000\n },\n {\n \"currency\": \"THB\",\n \"balance\": 0.000000\n },\n {\n \"currency\": \"TZS\",\n \"balance\": 0.000000\n },\n {\n \"currency\": \"UGX\",\n \"balance\": 0.000000\n },\n {\n \"currency\": \"USD\",\n \"balance\": 167.457992\n },\n {\n \"currency\": \"USDC\",\n \"balance\": 0.000000\n },\n {\n \"currency\": \"USDT\",\n \"balance\": 0.000000\n },\n {\n \"currency\": \"UZS\",\n \"balance\": 0.000000\n },\n {\n \"currency\": \"XAF\",\n \"balance\": 0.000000\n },\n {\n \"currency\": \"XOF\",\n \"balance\": 0.000000\n },\n {\n \"currency\": \"ZAR\",\n \"balance\": 120.000000\n },\n {\n \"currency\": \"ZMW\",\n \"balance\": 0.000000\n }\n ]\n },\n {\n \"gatewayName\": \"payhost\",\n \"status\": \"failed\",\n \"error\": {\n \"code\": \"error\",\n \"message\": \"Bank does not provide balance\"\n },\n \"balances\": []\n }\n ],\n \"aggregatedBalances\": [\n {\n \"currency\": \"AED\",\n \"balance\": 0.000000\n },\n {\n \"currency\": \"AUD\",\n \"balance\": 3412.000000\n },\n {\n \"currency\": \"BRL\",\n \"balance\": 100.089996\n },\n {\n \"currency\": \"BTC\",\n \"balance\": 0.000000\n },\n {\n \"currency\": \"BXC\",\n \"balance\": 0.000000\n },\n {\n \"currency\": \"CAD\",\n \"balance\": 1000.000000\n },\n {\n \"currency\": \"CDF\",\n \"balance\": 0.000000\n },\n {\n \"currency\": \"COP\",\n \"balance\": 0.000000\n },\n {\n \"currency\": \"DKK\",\n \"balance\": 0.000000\n },\n {\n \"currency\": \"EGP\",\n \"balance\": 0.000000\n },\n {\n \"currency\": \"ETH\",\n \"balance\": 0.000000\n },\n {\n \"currency\": \"EUR\",\n \"balance\": 0.000000\n },\n {\n \"currency\": \"GBP\",\n \"balance\": -24.327801\n },\n {\n \"currency\": \"GHS\",\n \"balance\": 0.000000\n },\n {\n \"currency\": \"IDR\",\n \"balance\": 251000.000000\n },\n {\n \"currency\": \"INR\",\n \"balance\": 0.000000\n },\n {\n \"currency\": \"JPY\",\n \"balance\": 0.000000\n },\n {\n \"currency\": \"KES\",\n \"balance\": 0.000000\n },\n {\n \"currency\": \"MWK\",\n \"balance\": 0.000000\n },\n {\n \"currency\": \"MXN\",\n \"balance\": -4.770000\n },\n {\n \"currency\": \"NGN\",\n \"balance\": 0.000000\n },\n {\n \"currency\": \"NZD\",\n \"balance\": 0.000000\n },\n {\n \"currency\": \"RWF\",\n \"balance\": 0.000000\n },\n {\n \"currency\": \"THB\",\n \"balance\": 0.000000\n },\n {\n \"currency\": \"TZS\",\n \"balance\": 0.000000\n },\n {\n \"currency\": \"UGX\",\n \"balance\": 0.000000\n },\n {\n \"currency\": \"USD\",\n \"balance\": 167.457992\n },\n {\n \"currency\": \"USDC\",\n \"balance\": 0.000000\n },\n {\n \"currency\": \"USDT\",\n \"balance\": 0.000000\n },\n {\n \"currency\": \"UZS\",\n \"balance\": 0.000000\n },\n {\n \"currency\": \"XAF\",\n \"balance\": 0.000000\n },\n {\n \"currency\": \"XOF\",\n \"balance\": 0.000000\n },\n {\n \"currency\": \"ZAR\",\n \"balance\": 120.000000\n },\n {\n \"currency\": \"ZMW\",\n \"balance\": 0.000000\n }\n ]\n}"},{"id":"b758ca7b-cafc-4e61-b502-19aa8b786d76","name":"Checking Balance payout-error","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{ \r\n \"paymentMethod\" : \"PAYOUT-INTERAC\"\r\n}\r\n","options":{"raw":{"language":"json"}}},"url":"/getBalance"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"paymentMethod\": \"PAYOUT-INTERAC\",\n \"status\": \"failed\",\n \"gateways\": [\n {\n \"gatewayName\": \"payhost\",\n \"status\": \"failed\",\n \"error\": {\n \"code\": \"error\",\n \"message\": \"Bank does not provide balance\"\n },\n \"balances\": []\n }\n ],\n \"aggregatedBalances\": []\n}"}],"_postman_id":"81da4baf-cffb-4559-b558-23fb0559b2e5"}],"id":"1afcb95b-6a37-4171-afd4-91ff7acbda34","description":"The Get Balance API (V2) provides orchestrator-level visibility into available balances across multiple payment methods and banking partners. This version enhances the existing balance API by aggregating and returning balance details for all supported payment methods associated with all the PSPs for the merchant
\nOverview
\nPurpose: Retrieve available balance information across different banks/payment methods.
\nScope: Orchestrator-level (not limited to a single merchant or payment method).
\nEnhancement over previous version:
\nReturns balances for all payment methods linked to the orchestrator.
\nProvides both consolidated and MID-level (Merchant ID) breakdowns.
\nRequest Parameters
\nBehavior
\nWhen a valid paymentMethod is provided, the API retrieves:
\nBalance details across all associated banks/payment methods.
\nMID-level breakdown for each bank.
\nConsolidated balance per payment method.
\nThe API is designed specifically for orchestrators and returns aggregated data across multiple merchants and banking integrations.
\nSuccess Response
\nOn successful retrieval, the API returns:
\nPayment Method Details
\nList of Banks / Payment Providers
\nMID-Level Breakdown
\nConsolidated Balance
\nPartial Success Response
\nA Partial Success response is returned when balance information is retrieved successfully for some payment methods or banks, while one or more fail to return balance data.
\nThis scenario typically occurs when:
\nA merchant is associated with multiple payment methods or banking partners, and
\nAt least one provider returns a valid balance, while others fail due to unavailability, timeout, or missing data.
\nReturn values-
\nStatus as \"Partial\"
\nPayment Method Details
\nList of Banks / Payment Providers
\nMID-Level Breakdown
\nConsolidated Balance
\nError Handling
\nIf balance details are not found or the request cannot be processed, the API returns:
\nAppropriate status code
\nError message
\nWhen a payout threshold limit is configured and a transaction falls within the defined threshold criteria, the system can take one of the following actions:
\nAutomatic Rejection – The transaction is rejected immediately.
\nManual Review – The transaction is routed for manual evaluation.
\nDuring the manual review process, the reviewer can perform one of the following actions:
\nApprove – The payout request is approved and processed.
\nReject – The payout request is rejected.
\nThe final status of the customer’s payout request is determined based on the outcome of the review process.
\nAPI which give details of the payout transactions.
\nApprove or reject a payout that is currently in pending_review status.
Endpoint
\nPOST /api/v1/payouts/{payout_id}/action?action={approve|reject}\n\nThis API uses Bearer Token Authentication.
\n{\n \"remarks\": \"Optional remarks\",\n \"reviewed_by\": \"optional_reviewer\"\n}\n\ncurl -X POST 'https://app.aviorapay.com/api/v1/payouts/69d4a15b7c7e1d98769872eb/action?action=approve' \\\n -H 'Authorization: Bearer your_api_key_here' \\\n -H 'Content-Type: application/json' \\\n -d '{}'\n\ncurl -X POST 'https://app.aviorapay.com/api/v1/payouts/69d4a15b7c7e1d98769872eb/action?action=approve' \\\n -H 'Authorization: Bearer your_api_key_here' \\\n -H 'Content-Type: application/json' \\\n -d '{\n \"remarks\": \"Verified against invoice #4821\"\n }'\n\ncurl -X POST 'https://app.aviorapay.com/api/v1/payouts/69d4a15b7c7e1d98769872eb/action?action=approve' \\\n -H 'Authorization: Bearer your_api_key_here' \\\n -H 'Content-Type: application/json' \\\n -d '{\n \"remarks\": \"Approved after compliance review\",\n \"reviewed_by\": \"compliance_team_lead\"\n }'\n\ncurl -X POST 'https://app.aviorapay.com/api/v1/payouts/69ce44f1b2dd73d0d148c7d5/action?action=reject' \\\n -H 'Authorization: Bearer your_api_key_here' \\\n -H 'Content-Type: application/json' \\\n -d '{}'\n\ncurl -X POST 'https://app.aviorapay.com/api/v1/payouts/69ce44f1b2dd73d0d148c7d5/action?action=reject' \\\n -H 'Authorization: Bearer your_api_key_here' \\\n -H 'Content-Type: application/json' \\\n -d '{\n \"remarks\": \"Suspicious transaction pattern detected\"\n }'\n\ncurl -X POST 'https://app.aviorapay.com/api/v1/payouts/69ce44f1b2dd73d0d148c7d5/action?action=reject' \\\n -H 'Authorization: Bearer your_api_key_here' \\\n -H 'Content-Type: application/json' \\\n -d '{\n \"remarks\": \"Failed KYC verification\",\n \"reviewed_by\": \"risk_team_admin\"\n }'\n\nHTTP Status: 200 OK
{\n \"status\": \"success\",\n \"data\": {\n \"payout_id\": \"69d4a15b7c7e1d98769872eb\",\n \"previous_status\": \"pending_review\",\n \"current_status\": \"paid\",\n \"action_performed\": \"approve\",\n \"reviewed_by\": \"merchant_user_123\",\n \"reviewed_at\": \"2026-04-16T10:30:45Z\",\n \"remarks\": \"Verified against invoice #4821\"\n }\n}\n\nNote: All responses return HTTP 200 OK.
Error details are returned in the response body.
{\n \"message\": \"invalid post data\"\n}\n\n{\n \"message\": \"Unauthorized\"\n}\n\nMissing Authorization header
\nInvalid Bearer token
\nWrong merchant API key
\nInvalid API credentials
\n{\n \"message\": \"Payout Id Not Found :- 69d4a15b7c7e1d98769872eb\"\n}\n\nInvalid payout ID
\nPayout belongs to another merchant
\n{\n \"status\": \"error\",\n \"data\": {\n \"payout_id\": \"69d4a15b7c7e1d98769872eb\",\n \"current_status\": \"paid\",\n \"message\": \"Payout already processed\"\n }\n}\n\nPayout status is already one of:
\npaid
error
payout_in_process
dispatched
created
{\n \"status\": \"error\",\n \"data\": {\n \"payout_id\": \"69d4a15b7c7e1d98769872eb\",\n \"message\": \"Insufficient Balance [250.00]\"\n }\n}\n\nInsufficient Balance [amount]
Payout Method not allowed
charge/limit/mdr setting not found
You are not Allowed for Live Transaction
Validate Bearer token
\nLoad merchant profile
\nVerify payout ownership
\nValidate payout status
\nProcess action
\nDuplicate approve/reject requests are safely blocked.
\nPOST /api/v1/payouts/abc123/action?action=approve\n\n{\n \"status\": \"success\"\n}\n\nPOST /api/v1/payouts/abc123/action?action=approve\n\n{\n \"status\": \"error\",\n \"data\": {\n \"message\": \"Payout already processed\"\n }\n}\n\nA partial refund allows merchants to refund a portion of a successfully paid purchase.
Multiple partial refunds can be performed until the total refunded amount equals the original purchase amount.
The purchase must be in paid status.
\nThe refund amount must be greater than 0.
\nThe refund amount must not exceed the remaining refundable amount.
\nRefunds are processed in the same currency as the original purchase.
\nPurchase Amount: 10
\nRefund Amount: 8
\nResult:
\nRefunded Amount: 8
\nRemaining Refundable Amount: 2
\nTransaction Status: PARTIALLY_REFUNDED
\nFull Refund Using Partial Refund API
\nPurchase Amount: 10
\nRefund Amount: 10
\nResult:
\nRefunded Amount: 10
\nRemaining Refundable Amount: 0
\nTransaction Status: PARTIAL REFUNDED
\nPurchase Amount: 10
\nRefund #1: 3
\nRefund #2: 2
\nRefund #3: 5
\nResult:
\nTotal Refunded Amount: 10
\nRemaining Refundable Amount: 0
\nFinal Transaction Status: PARTIAL REFUNDED
\n","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"367012ec-f721-4bce-90f8-066b88b4b46f","id":"367012ec-f721-4bce-90f8-066b88b4b46f","name":"API","type":"folder"}},"urlObject":{"path":["purchases","purchaseid","refund"],"host":["https://app.aviorapay.com/api/v1"],"query":[],"variable":[]}},"response":[{"id":"b9076c95-cdd9-44b4-bc06-414510f22fec","name":"Success","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer Token"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"*/*"}],"body":{"mode":"raw","raw":"{\n \"amount\": \"5.12\",\n \"reason\": \"Partial Refunds Testing\"\n}","options":{"raw":{"language":"json"}}},"url":"https://app.aviorapay.com/api/v1/purchases/purchaseid/refund"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"Text","header":[{"key":"Date","value":"Fri, 05 Jun 2026 08:59:38 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Nel","value":"{\"report_to\":\"cf-nel\",\"success_fraction\":0.0,\"max_age\":604800}"},{"key":"X-Frame-Options","value":"ALLOW-FROM *"},{"key":"Referrer-Policy","value":"no-referrer"},{"key":"x-session-id","value":"7aec019b-8a08-4e3d-a158-b092f8c8f998"},{"key":"Vary","value":"Origin"},{"key":"Vary","value":"Access-Control-Request-Method"},{"key":"Vary","value":"Access-Control-Request-Headers"},{"key":"Server","value":"cloudflare"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"0"},{"key":"Cache-Control","value":"no-cache, no-store, max-age=0, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Expires","value":"0"},{"key":"Strict-Transport-Security","value":"max-age=31536000 ; includeSubDomains"},{"key":"X-Cache","value":"Error from cloudfront"},{"key":"Via","value":"1.1 2af44885a7fc4faf5a3444e606d6c02c.cloudfront.net (CloudFront)"},{"key":"X-Amz-Cf-Pop","value":"IAD61-P10"},{"key":"X-Amz-Cf-Id","value":"rWo0eMrwpvBts9xS0P4ftqKaridLKfm2xH9Y5H2CF3k6R1LxgTFMZQ=="},{"key":"cf-cache-status","value":"DYNAMIC"},{"key":"Report-To","value":"{\"group\":\"cf-nel\",\"max_age\":604800,\"endpoints\":[{\"url\":\"https://a.nel.cloudflare.com/report/v4?s=IFwED2Y1XrzWhlXDeYjRi0o%2BPWMlBxaVhLXiHVdLbjLb1oaWhC9H%2BdjTxbu3jV8o0RDcmxT%2BvN3omG1bscFcmMeqERUAG%2BooUZMEJ%2BrFdLVe7yaObwbg963WTVC8cyx7dfvT\"}]}"},{"key":"CF-RAY","value":"a06dfb7c4ed3c995-IAD"}],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\n \"refundId\": \"refundid\",\n \"purchaseId\": \"purchaseid\",\n \"amount\": 5.12,\n \"createdOn\": 1780637310,\n \"refundOn\": 0,\n \"status\": \"REFUND_IN_PROCESS\",\n \"reason\": \"Partial Refunds Testing\",\n \"currency\": \"USD\"\n}"},{"id":"25a8cbe9-0ef4-4c08-ac3e-4f28ff45e575","name":"Refund Amt Exceeds Purchase Amt","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer Token"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"*/*"}],"body":{"mode":"raw","raw":"{\n \"amount\": \"11\", // Purchase Amount: 10\n \"reason\": \"Partial Refunds Testing\"\n}","options":{"raw":{"language":"json"}}},"url":"https://app.aviorapay.com/api/v1/purchases/purchaseid/refund"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"Text","header":[{"key":"Date","value":"Fri, 05 Jun 2026 09:03:16 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Nel","value":"{\"report_to\":\"cf-nel\",\"success_fraction\":0.0,\"max_age\":604800}"},{"key":"X-Frame-Options","value":"ALLOW-FROM *"},{"key":"Referrer-Policy","value":"no-referrer"},{"key":"x-session-id","value":"9f888ccb-1238-4e02-b6dc-764560604b14"},{"key":"Vary","value":"Origin"},{"key":"Vary","value":"Access-Control-Request-Method"},{"key":"Vary","value":"Access-Control-Request-Headers"},{"key":"Server","value":"cloudflare"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"0"},{"key":"Cache-Control","value":"no-cache, no-store, max-age=0, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Expires","value":"0"},{"key":"Strict-Transport-Security","value":"max-age=31536000 ; includeSubDomains"},{"key":"X-Cache","value":"Error from cloudfront"},{"key":"Via","value":"1.1 acbc1e922360be31edf0371abdc7a3a4.cloudfront.net (CloudFront)"},{"key":"X-Amz-Cf-Pop","value":"EWR53-P1"},{"key":"X-Amz-Cf-Id","value":"u0f10ZilZAVELaSZM0QkCGivhENfvhb491tRfbtZBfNmilJhavDeeA=="},{"key":"cf-cache-status","value":"DYNAMIC"},{"key":"Report-To","value":"{\"group\":\"cf-nel\",\"max_age\":604800,\"endpoints\":[{\"url\":\"https://a.nel.cloudflare.com/report/v4?s=G0WYUY8ZL0X6%2BdnZTxN8KgKkvqqBezW18wEdyF5wktbOdTwbgtdIp9wsRiNbSp250CnbNX1q74X0cENF8dT3V5P8gbQ2kw%2BW1%2FWf9LNh1aVj8tHeCAfooAi0il9zhZGaj7z4\"}]}"},{"key":"CF-RAY","value":"a06e00cefac89c79-IAD"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Refund amount exceeds refundable amount\",\n \"code\": \"validation_error\"\n}"},{"id":"d2683ab5-f6ab-4f08-8dbe-6ff85fd4366f","name":"Refund Amt Is 0 or -ve","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer Token"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"*/*"}],"body":{"mode":"raw","raw":"{\n \"amount\": \"-5.12\",\n \"reason\": \"Partial Refunds Testing\"\n}","options":{"raw":{"language":"json"}}},"url":"https://app.aviorapay.com/api/v1/purchases/purchaseid/refund"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"Text","header":[{"key":"Date","value":"Fri, 05 Jun 2026 09:04:29 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Nel","value":"{\"report_to\":\"cf-nel\",\"success_fraction\":0.0,\"max_age\":604800}"},{"key":"X-Frame-Options","value":"ALLOW-FROM *"},{"key":"Referrer-Policy","value":"no-referrer"},{"key":"x-session-id","value":"2e380b48-7668-448d-af95-980482c35c8f"},{"key":"Vary","value":"Origin"},{"key":"Vary","value":"Access-Control-Request-Method"},{"key":"Vary","value":"Access-Control-Request-Headers"},{"key":"Server","value":"cloudflare"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"0"},{"key":"Cache-Control","value":"no-cache, no-store, max-age=0, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Expires","value":"0"},{"key":"Strict-Transport-Security","value":"max-age=31536000 ; includeSubDomains"},{"key":"X-Cache","value":"Error from cloudfront"},{"key":"Via","value":"1.1 3578d122de1401ebc52a7afd35dd5d0c.cloudfront.net (CloudFront)"},{"key":"X-Amz-Cf-Pop","value":"IAD61-P10"},{"key":"X-Amz-Cf-Id","value":"B705OGUJpsFVyyUtTS_xidVoz9_kniiAFlHKn0_sL6R6oOQ9BMHZFA=="},{"key":"cf-cache-status","value":"DYNAMIC"},{"key":"Report-To","value":"{\"group\":\"cf-nel\",\"max_age\":604800,\"endpoints\":[{\"url\":\"https://a.nel.cloudflare.com/report/v4?s=Wd5pKM%2B%2BBY35cSdYdYOJesaPTVX3KJ1M%2Bd68og7dF7hMaOL00aU4Xm3A7Ab%2BKitUSfwtu5owy8TVmxjQ%2BRNaOp1w2WiatUO7z%2Bayx4TPFfNzLk2eAlmERpeO%2F5Dy18l6%2F4H1\"}]}"},{"key":"CF-RAY","value":"a06e02977d392431-IAD"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Refund amount must be greater than 0\",\n \"code\": \"validation_error\"\n}"},{"id":"bbc16641-6e09-45f3-ab13-08216d9955a6","name":"Empty Refund Amt","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer Token"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"*/*"}],"body":{"mode":"raw","raw":"{\n \"reason\": \"Partial Refunds Testing\"\n}","options":{"raw":{"language":"json"}}},"url":"https://app.aviorapay.com/api/v1/purchases/purchaseid/refund"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"Text","header":[{"key":"Date","value":"Fri, 05 Jun 2026 09:05:38 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Nel","value":"{\"report_to\":\"cf-nel\",\"success_fraction\":0.0,\"max_age\":604800}"},{"key":"X-Frame-Options","value":"ALLOW-FROM *"},{"key":"Referrer-Policy","value":"no-referrer"},{"key":"x-session-id","value":"5573f74e-1147-4a84-ad79-08260f6c229d"},{"key":"Vary","value":"Origin"},{"key":"Vary","value":"Access-Control-Request-Method"},{"key":"Vary","value":"Access-Control-Request-Headers"},{"key":"Server","value":"cloudflare"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"0"},{"key":"Cache-Control","value":"no-cache, no-store, max-age=0, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Expires","value":"0"},{"key":"Strict-Transport-Security","value":"max-age=31536000 ; includeSubDomains"},{"key":"X-Cache","value":"Error from cloudfront"},{"key":"Via","value":"1.1 70e9f6c79b570a07593d98d3c3eb2fc6.cloudfront.net (CloudFront)"},{"key":"X-Amz-Cf-Pop","value":"IAD61-P10"},{"key":"X-Amz-Cf-Id","value":"XhGSCeKH6brQ_0b2TQ7RfvwMzYyCp3-qSQ4N2rErhuolIMcxqQB3tw=="},{"key":"cf-cache-status","value":"DYNAMIC"},{"key":"Report-To","value":"{\"group\":\"cf-nel\",\"max_age\":604800,\"endpoints\":[{\"url\":\"https://a.nel.cloudflare.com/report/v4?s=X2YEtc%2F6jCxDP78BlzJBFZfi11NZuirslkboc3hUZCfp1XYpHRAdPv8X3hzhFfHJHJPCjCOZrphGL%2FkrohE%2FC6yvIPVC8Tn7G1%2B0Km7nQ16umqQe%2BdDFT%2BkMIkIKPRqdaErn\"}]}"},{"key":"CF-RAY","value":"a06e0449a9f91de9-IAD"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Amount is required\",\n \"code\": \"validation_error\"\n}"},{"id":"476d4904-ab09-4279-9d68-5e343a249e09","name":"Invalid Purchase ID","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer Token"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"*/*"}],"body":{"mode":"raw","raw":"{\n \"amount\": \"5.12\",\n \"reason\": \"Partial Refunds Testing\"\n}","options":{"raw":{"language":"json"}}},"url":"https://app.aviorapay.com/api/v1/purchases/purchaseid/refund"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"Text","header":[{"key":"Date","value":"Fri, 05 Jun 2026 09:06:14 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Nel","value":"{\"report_to\":\"cf-nel\",\"success_fraction\":0.0,\"max_age\":604800}"},{"key":"X-Frame-Options","value":"ALLOW-FROM *"},{"key":"Referrer-Policy","value":"no-referrer"},{"key":"x-session-id","value":"193bc177-e65b-4f27-8e3d-a1c3242b44c0"},{"key":"Vary","value":"Origin"},{"key":"Vary","value":"Access-Control-Request-Method"},{"key":"Vary","value":"Access-Control-Request-Headers"},{"key":"Server","value":"cloudflare"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"0"},{"key":"Cache-Control","value":"no-cache, no-store, max-age=0, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Expires","value":"0"},{"key":"Strict-Transport-Security","value":"max-age=31536000 ; includeSubDomains"},{"key":"X-Cache","value":"Error from cloudfront"},{"key":"Via","value":"1.1 347540535e60ba585992da68b62d1ae8.cloudfront.net (CloudFront)"},{"key":"X-Amz-Cf-Pop","value":"SIN2-P6"},{"key":"X-Amz-Cf-Id","value":"nQfeXU4EOHhf5w662MDpgndsZOJ2Lv5MJudzq5Ks9OK3S8zPhDXpRw=="},{"key":"cf-cache-status","value":"DYNAMIC"},{"key":"Report-To","value":"{\"group\":\"cf-nel\",\"max_age\":604800,\"endpoints\":[{\"url\":\"https://a.nel.cloudflare.com/report/v4?s=kzHplT3Ggl%2Fu0lxeqmQOcBQxukHE9gO%2F7R0wyfqoD4IiGWSbD1mmaIha7sf9GSp8o%2FJHy9NV8RMdynlScuqpoZI%2FuKo1OF%2F5j96iBu7iEdqO%2Fx9nKqKfAPDFaka%2FR7kfDqRQ\"}]}"},{"key":"CF-RAY","value":"a06e05207bbe52d6-IAD"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Transaction not found\",\n \"code\": \"transaction_error\"\n}"},{"id":"fed2cdae-a9b4-4d98-a682-56b4c6507f76","name":"Refund on Failed or Pending Transactions","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer Token"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"*/*"}],"body":{"mode":"raw","raw":"{\n \"amount\": \"5.12\",\n \"reason\": \"Partial Refunds Testing\"\n}","options":{"raw":{"language":"json"}}},"url":"https://app.aviorapay.com/api/v1/purchases/purchaseid/refund"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"Text","header":[{"key":"Date","value":"Fri, 05 Jun 2026 09:06:38 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Nel","value":"{\"report_to\":\"cf-nel\",\"success_fraction\":0.0,\"max_age\":604800}"},{"key":"X-Frame-Options","value":"ALLOW-FROM *"},{"key":"Referrer-Policy","value":"no-referrer"},{"key":"x-session-id","value":"6a7e4072-0cb1-41a9-9669-afc26d71050d"},{"key":"Vary","value":"Origin"},{"key":"Vary","value":"Access-Control-Request-Method"},{"key":"Vary","value":"Access-Control-Request-Headers"},{"key":"Server","value":"cloudflare"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"0"},{"key":"Cache-Control","value":"no-cache, no-store, max-age=0, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Expires","value":"0"},{"key":"Strict-Transport-Security","value":"max-age=31536000 ; includeSubDomains"},{"key":"X-Cache","value":"Error from cloudfront"},{"key":"Via","value":"1.1 a863373015dd073e91a52d99d8ad6bfc.cloudfront.net (CloudFront)"},{"key":"X-Amz-Cf-Pop","value":"IAD61-P10"},{"key":"X-Amz-Cf-Id","value":"KIIfqqaMKmLQqAQbuawRHDuPpcu4EnErL0aeEgFHGYY-FdmMISHmgg=="},{"key":"cf-cache-status","value":"DYNAMIC"},{"key":"Report-To","value":"{\"group\":\"cf-nel\",\"max_age\":604800,\"endpoints\":[{\"url\":\"https://a.nel.cloudflare.com/report/v4?s=8hGQxlHaR2s3QJOa7YijWckCFTcGSeOoU555kG9iM743FjcOdN2Q8IUlKe1015LzlbfPT0b6ZJT0eiE2mmp09iUU%2F%2BCQPt8qnEeD6PJkMkWpn45xqNeHO20Wl8PjbJuI0XZV\"}]}"},{"key":"CF-RAY","value":"a06e05ba9e43c975-IAD"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Only Purchases with `status == (paid)` can be refunded.\",\n \"code\": \"transaction_error\"\n}"},{"id":"b973942f-ee6e-4108-ac67-2dd7dafc06cb","name":"Refund on an Already Refunded Purchase","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer Token"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"*/*"}],"body":{"mode":"raw","raw":"{\n \"amount\": \"5.12\",\n \"reason\": \"Partial Refunds Testing\"\n}","options":{"raw":{"language":"json"}}},"url":"https://app.aviorapay.com/api/v1/purchases/purchaseid/refund"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"Text","header":[{"key":"Date","value":"Fri, 05 Jun 2026 09:07:09 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Nel","value":"{\"report_to\":\"cf-nel\",\"success_fraction\":0.0,\"max_age\":604800}"},{"key":"X-Frame-Options","value":"ALLOW-FROM *"},{"key":"Referrer-Policy","value":"no-referrer"},{"key":"x-session-id","value":"560fb162-4210-4496-8249-26bf3393409e"},{"key":"Vary","value":"Origin"},{"key":"Vary","value":"Access-Control-Request-Method"},{"key":"Vary","value":"Access-Control-Request-Headers"},{"key":"Server","value":"cloudflare"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"0"},{"key":"Cache-Control","value":"no-cache, no-store, max-age=0, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Expires","value":"0"},{"key":"Strict-Transport-Security","value":"max-age=31536000 ; includeSubDomains"},{"key":"X-Cache","value":"Error from cloudfront"},{"key":"Via","value":"1.1 1a12f863197f986ec10d35ed76e104f0.cloudfront.net (CloudFront)"},{"key":"X-Amz-Cf-Pop","value":"IAD61-P10"},{"key":"X-Amz-Cf-Id","value":"tYQhkaUXrvj3OWc-rQiJp_FnzIBB3mubhjv7yn0w0TaAb6YzKH1Tww=="},{"key":"cf-cache-status","value":"DYNAMIC"},{"key":"Report-To","value":"{\"group\":\"cf-nel\",\"max_age\":604800,\"endpoints\":[{\"url\":\"https://a.nel.cloudflare.com/report/v4?s=SWrtdoBSkmhyNXsahHAdETrqPoOxh89DlcFUaF8D4DOftFPt0BtSVkjBR%2B7G8VbZfModmKZEwe1drtHOkeYMq9oz2PqsnSgYghGs%2Bi%2BqNA%2B4GZ6Z8mYI5BNCiuOJ5k%2FxY9HN\"}]}"},{"key":"CF-RAY","value":"a06e0680dc6724ad-IAD"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Purchase has already been fully refunded\",\n \"code\": \"transaction_error\"\n}"},{"id":"dfaaea3e-0ca4-4ea5-be72-ed4de8d19abd","name":"Refund Exceeds Remaining Balance After a Partial Refund","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer Token"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"*/*"}],"body":{"mode":"raw","raw":"{\n \"amount\": \"5.12\", // Remaining Refundable Amount is 2.0\n \"reason\": \"Partial Refunds Testing\"\n}","options":{"raw":{"language":"json"}}},"url":"https://app.aviorapay.com/api/v1/purchases/purchaseid/refund"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"Text","header":[{"key":"Date","value":"Fri, 05 Jun 2026 09:09:03 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Nel","value":"{\"report_to\":\"cf-nel\",\"success_fraction\":0.0,\"max_age\":604800}"},{"key":"X-Frame-Options","value":"ALLOW-FROM *"},{"key":"Referrer-Policy","value":"no-referrer"},{"key":"x-session-id","value":"aced1038-4a60-45fb-a14b-f4cdc9ca63b4"},{"key":"Vary","value":"Origin"},{"key":"Vary","value":"Access-Control-Request-Method"},{"key":"Vary","value":"Access-Control-Request-Headers"},{"key":"Server","value":"cloudflare"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"0"},{"key":"Cache-Control","value":"no-cache, no-store, max-age=0, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Expires","value":"0"},{"key":"Strict-Transport-Security","value":"max-age=31536000 ; includeSubDomains"},{"key":"X-Cache","value":"Error from cloudfront"},{"key":"Via","value":"1.1 1a12f863197f986ec10d35ed76e104f0.cloudfront.net (CloudFront)"},{"key":"X-Amz-Cf-Pop","value":"IAD61-P10"},{"key":"X-Amz-Cf-Id","value":"ALmfTGjt9X7OliM6NeGzmkWzns9dzm9J5TnVUAV3egqzFolwOcidoA=="},{"key":"cf-cache-status","value":"DYNAMIC"},{"key":"Report-To","value":"{\"group\":\"cf-nel\",\"max_age\":604800,\"endpoints\":[{\"url\":\"https://a.nel.cloudflare.com/report/v4?s=UtL7zsQvnJ1BIIU8L%2FUyyQd4LiG%2BxMTEzuq%2B0zEM8dhVVZByPP5HkJW7urlk62Rzg%2BFG2Af9VAyMi4REGU5EPnIty%2BthzF4%2FojIE8%2FiFA0flLX5zu%2B4Kb3vJ4AoTU5mEyWf2\"}]}"},{"key":"CF-RAY","value":"a06e094ab9763210-IAD"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Refund amount exceeds refundable amount: 2.0\",\n \"code\": \"validation_error\"\n}"}],"_postman_id":"a9c2f49c-74e5-46bf-921d-60ea403c83e2"},{"name":"Partial Refund Status API","id":"19981634-df17-4e57-a731-7d11940c2c49","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"Bearer 8959a18e22a25ef94c30fb1b90c50bc332c28d8b0add750fa1afe71f48438b2d"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"refundId\": \"refundid\"\n}","options":{"raw":{"language":"json"}}},"url":"https://app.aviorapay.com/api/v1/refundStatus/purchaseid/","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"367012ec-f721-4bce-90f8-066b88b4b46f","id":"367012ec-f721-4bce-90f8-066b88b4b46f","name":"API","type":"folder"}},"urlObject":{"path":["refundStatus","purchaseid",""],"host":["https://app.aviorapay.com/api/v1"],"query":[],"variable":[]}},"response":[{"id":"676edd6c-78a5-4f40-9d30-6aa20b717e0e","name":"Success","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer 8959a18e22a25ef94c30fb1b90c50bc332c28d8b0add750fa1afe71f48438b2d"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"refundId\": \"refundid\"\n}","options":{"raw":{"language":"json"}}},"url":"https://app.aviorapay.com/api/v1/refundStatus/purchaseid/"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"Text","header":[{"key":"Date","value":"Wed, 10 Jun 2026 15:09:28 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Nel","value":"{\"report_to\":\"cf-nel\",\"success_fraction\":0.0,\"max_age\":604800}"},{"key":"X-Frame-Options","value":"ALLOW-FROM *"},{"key":"Referrer-Policy","value":"no-referrer"},{"key":"x-session-id","value":"5be6468d-a804-478e-8e27-8fd83f43359b"},{"key":"Vary","value":"Origin"},{"key":"Vary","value":"Access-Control-Request-Method"},{"key":"Vary","value":"Access-Control-Request-Headers"},{"key":"Server","value":"cloudflare"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"0"},{"key":"Cache-Control","value":"no-cache, no-store, max-age=0, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Expires","value":"0"},{"key":"Strict-Transport-Security","value":"max-age=31536000 ; includeSubDomains"},{"key":"X-Cache","value":"Error from cloudfront"},{"key":"Via","value":"1.1 9d35ce6897d7f02042955443076a54de.cloudfront.net (CloudFront)"},{"key":"X-Amz-Cf-Pop","value":"EWR53-P1"},{"key":"X-Amz-Cf-Id","value":"Z2XLcFaGFRDj2ZuwTFJHQEaWWHB-I3MUtw5N2nMV7CNy55ImAEtfow=="},{"key":"cf-cache-status","value":"DYNAMIC"},{"key":"Report-To","value":"{\"group\":\"cf-nel\",\"max_age\":604800,\"endpoints\":[{\"url\":\"https://a.nel.cloudflare.com/report/v4?s=WE1Q25t02u566zmtnXqm%2F%2FBAsilvCpOzlMzs3i%2F3Py3%2BJO%2FnNNBSHDCXlW4OtMYjNBc6jOpCsAMj0plUVemEWy8KMy8TLLPi0Vrte%2BET6ZNPsDzZXkEqXiFkpjTFGyTde9HC\"}]}"},{"key":"CF-RAY","value":"a0994c1f8a41311a-IAD"}],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\n \"refundId\": \"refundid\",\n \"purchaseId\": \"purchaseid\",\n \"amount\": 3.0,\n \"createdOn\": 1780982811,\n \"refundOn\": 1780982814,\n \"status\": \"REFUNDED\",\n \"reason\": \"test\",\n \"currency\": \"USD\"\n}\n"}],"_postman_id":"19981634-df17-4e57-a731-7d11940c2c49"}],"id":"367012ec-f721-4bce-90f8-066b88b4b46f","auth":{"type":"noauth","isInherited":false},"event":[{"listen":"prerequest","script":{"type":"text/javascript","packages":{},"requests":{},"exec":[""],"id":"f9e9867c-9fc2-4547-b0c4-762a71746bf1"}},{"listen":"test","script":{"type":"text/javascript","packages":{},"requests":{},"exec":[""],"id":"037b5a0e-c73e-46bd-94e1-cbda2fcd8e7a"}}],"_postman_id":"367012ec-f721-4bce-90f8-066b88b4b46f","description":""}],"id":"1957ddb1-f1e4-4a59-b483-89a1eebc1f6b","auth":{"type":"noauth","isInherited":false},"event":[{"listen":"prerequest","script":{"type":"text/javascript","packages":{},"requests":{},"exec":[""],"id":"04325aa6-477a-4bb8-80eb-c4799ab35a52"}},{"listen":"test","script":{"type":"text/javascript","packages":{},"requests":{},"exec":[""],"id":"20e72cb3-82b6-4663-82b2-df811f8b6219"}}],"_postman_id":"1957ddb1-f1e4-4a59-b483-89a1eebc1f6b","description":""}],"event":[{"listen":"prerequest","script":{"type":"text/javascript","requests":{},"exec":[""],"id":"fbb88c34-ab87-49b4-9baa-55f0157bd8ec"}},{"listen":"test","script":{"type":"text/javascript","requests":{},"exec":[""],"id":"34daecc4-4c12-4f67-83b9-4ca8d66416cf"}}],"variable":[{"key":"BaseURL","value":"https://app.aviorapay.com/api/v1"},{"key":"StagingAPIKey","value":""},{"key":"BaseV2URL","value":""}]}