{"info":{"_postman_id":"6406c6c4-09dc-4458-a15c-24ade571dd74","name":"NovixPay API Documentation - Live","description":"

Overview

NovixPay is a payment gateway optimization and intelligence service that merchants can use to provide a remote and frictionless payment experience.

This documentation will help you get started with integrating NovixPay but if you have any questions, please do not hesitate to reach out to us via email at info@novixpay.io

Please be advised that our support team is only available during standard business hours.

Environments

These are the BaseUrls for the APIs on different environments:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Environment	Base URL
Production	https://app.novixpay.io/api/v1
Sandbox	https://app.novixpay.io/api/v1 `Note: set the Sandbox flag true (checked) in your merchant account. As shown in the image below`

Authentication

To 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.

AUTHORIZATION: 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.

\n\n

To 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.\"

\n\n

Reiterating, 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)

Request Headers

Use these headers on every API call unless noted.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Header	Value	Required	Notes
`Content-Type`	`application/json`	Yes	All endpoints. Send JSON payloads.
`Authorization`	`Bearer {MERCHANT_API_KEY}`	Yes	All endpoints. Replace with your merchant API key.
`BrandId`	`{YOUR_BRAND_ID}`	Conditional	Session and CustomerAPIs. optional in customer APIs but Mandatory in Session APIs

","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":"50038237","collectionId":"6406c6c4-09dc-4458-a15c-24ade571dd74","publishedId":"2sBXc8qjgg","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"publishDate":"2026-02-09T06:20:07.000Z"},"item":[{"name":"⚙️ Integration Steps","item":[],"id":"dd25012c-b863-4552-a729-665397b87c9b","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.

1. Setup & check merchant details

The 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.

Start 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.

API Key - necessary to send transactions via API
\n
Brand ID - needed to send transaction. Use different brand IDs for different shops or brands.
\n
Public Key - needed to signature verification received in headers of the webhook
\n
Webhook - 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.
\n

2. Test the integration in Sandbox Mode

After finishing your integration, make sure your code is working as intended and test the purchase flow in the staging environment.

Testing Credentials (only on Sandbox mode)

You 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.

The cards mentioned above will stop working and the below mentioned cards will be used:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

card_type	Card Numbers	auth_type	Behaviour
Master	5141922635866282	3D Secure	Authentication Successful
Master	5169811636324572	3D Secure	Authentication Failed
Master	5143312606271514	2D Secure	Insufficient funds
Master	5199805409482512	2D Secure	Pending execution
Master	5146669487735546	2D Secure	Incorrect card expiry
Master	5151735930865446	3D Secure	Incorrect cvv
Master	5185151885032695	3D Secure	Processor timeout
Master	5149446104369687	2D Secure	Refund failed
Master	5127160683722580	3D Secure	Transaction expired
Master	5159971600530380	3D Secure	Risk check failed
Master	5198134892284199	2D Secure	Issuer decline
Master	5116213113429327	2D Secure	Authentication successful
Master	5112857124909935	2D Secure	Authentication failed
Master	5156216152193051	3D Secure	Insufficient funds
Master	5170361568993009	3D Secure	Pending execution
Master	5559161923541480	3D Secure	Incorrect card expiry
Master	5110339832985475	2D Secure	Incorrect cvv
Master	5136528486494418	2D Secure	Processor timeout
Master	5162164630471008	3D Secure	Refund failed
Master	5140378358642890	2D Secure	Transaction expired
Master	5192488343990234	2D Secure	Risk check failed
Master	5115438560834809	3D Secure	Issuer decline
VISA	4079722589318630	2D Secure	Authentication successful
VISA	4878397953290146	3D Secure	Authentication successful
VISA	4125485445527190	2D Secure	Authentication failed
VISA	4984823599573265	3D Secure	Insufficient funds
VISA	4710793097358785	2D Secure	Pending execution
VISA	4500682811540204	3D Secure	Incorrect card expiry
VISA	4935648707390280	2D Secure	Incorrect cvv
VISA	4241214813524459	3D Secure	Refund failed
VISA	4342346318195134	3D Secure	Risk check failed
VISA	4618889598319798	3D Secure	Issuer decline
VISA	4195258724913240	3D Secure	Authentication failed
VISA	4662922293431520	2D Secure	Insufficient funds
VISA	4994455060632359	3D Secure	Pending execution
VISA	4460652052832634	2D Secure	Incorrect card expiry
VISA	4383025225665997	3D Secure	Incorrect cvv
VISA	4568730114361775	2D Secure	Processor timeout
VISA	4163340122068617	3D Secure	Processor timeout
VISA	4405935956954713	2D Secure	Refund failed
VISA	4945208335596614	2D Secure	Transaction expired
VISA	4566329901944380	3D Secure	Transaction expired
VISA	4588381711517694	2D Secure	Risk check failed
VISA	4401279985739470	2D Secure	Issuer decline

Note:
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.

3. Create and test credentials on the Live Mode

After 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.

4. Go live!

Inform your Account Manager when the setup is done to get started with processing live traffic.

Overview

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.

The callback includes full transaction details so the merchant can update order status in real time.

Webhook Events for Payins

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Event type	Status	When is the event triggered	Is this a terminal event?
purchase created	`created`	Triggered when a new purchase request is initialized and recorded in the system.	❌ No
payment in process	`payment_in_process`	Triggered when the payment is initiated and awaiting confirmation from the PSP/bank.	❌ No
purchase overdue	`overdue`	Triggered when a purchase remains in the CREATED state and the configured Transaction Overdue Hours (from Admin Settings) have elapsed, the system automatically updates the purchase status to OVERDUE	❌ No (may lead to failed/expired/paid later)
purchase paid	`paid`	Triggered when the payment is successfully completed and confirmed.	✅ Yes
purchase failed	`error`	Triggered when the payment attempt fails due to technical error, insufficient funds, or rejection by PSP/bank.	✅ Yes
purchase cancelled	`cancelled`	Triggered when the customer or system cancels the purchase before completion.	✅ Yes
purchase expired	`expired`	Triggered when the purchase is not paid within the allowed expiry time.	✅ Yes
refund in process	`refund_in_process`	Triggered when a refund has been initiated but is not yet completed/settled.	❌ No
payment refund	`refunded` / `fraud_refunded`	Triggered when the completed payment is refunded, refunded due to fraud, or reversed via chargeback.	✅ Yes
Chargeback	`chargeback`	Triggered when a chargeback is applied	✅ Yes

Webhook Payload Specification

Fields Description

Key	Description
message.purchaseId	Unique identifier of the purchase generated by NovixPay.
message.client	Customer’s ID in merchant’s system (if available), otherwise \"NA\".
message.client.email	Customer’s email address.
message.client.phone	Customer’s phone number (with country code).
message.client.full_name	Full name of the customer.
message.client.date_of_birth	Customer’s date of birth in YYYY-MM-DD format.
message.client.street_address	Customer’s full street address.
message.client.country	ISO 2-letter country code of the customer.
message.client.city	City name (and state, if applicable).
message.client.zip_code	Postal / ZIP code.
message.client.stateCode	ISO 2-letter state code.
message.updated_on	UNIX timestamp of the last update to the transaction.
message.type	Type of transaction (e.g., \"purchase\").
message.paymentMethod	Comma-separated list of payment methods used (e.g., \"MASTER,VISA,JCB\").
message.amountUnit	Unit of amount — \"MAJOR\" for full currency unit, \"MINOR\" for subunits.
message.errorMsg	Message describing the transaction result — success message or error details.
message.created_on	UNIX timestamp when the purchase was created.
message.merchantRef	Unique transaction reference from the merchant.
message.merchantName	Registered merchant name in NovixPay.
message.purchase.currency	Currency code (ISO 4217).
message.purchase.products	Array of product details (name, quantity, price, discount, tax).
message.purchase.total	Total amount for all products (in amount unit).
message.purchase.language	Language code for the transaction (ISO 639-1).
message.payment.payment_type	Type of payment (e.g., \"PURCHASE\").
message.payment.amount	Payment amount.
message.payment.currency	Payment currency.
message.payment.paid_on	UNIX timestamp when the payment was completed.
message.status	Current transaction status.
message.status_history	Array of all past statuses with timestamps.
message.reference	PaySecure’s unique transaction reference.
status (root-level)	Duplicate of current status for quick access.

Possible Status Values

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

status	description
error	purchase failed due to an error.
cancelled	purchase was cancelled by the user or system.
created	purchase record created but not paid yet.
expired	payment link or session expired.
overdue	payment overdue.
paid	payment completed successfully.
refunded	payment refunded.
fraud_refunded	refunded due to fraud detection.
chargeback	reversed due to chargeback.
payment_in_process	payment is in progress.
refund_in_process	refund process started but not completed.

🔐 Key Pair Generation

NovixPay uses RSA key pairs to digitally sign webhooks, ensuring all notifications are both secure and authentic.

1. Generate Your Keys

\n\n

Click “Generate Key Pair” in the dashboard.
\n
A unique RSA private key and public key are created for your merchant ID.
\n

2. Key Storage

\n\n

Private Key → Stored securely by NovixPay (never exposed).
\n
Public Key → Displayed to you once on the screen. Copy and save it for verifying signatures.
\n

3. Webhook Signing

Every webhook payload is signed using NovixPay’s private key.
\n
The signature is included in webhook headers:
\n
- paysecure-sign or paysecure_sign
\n

4. Verification

Use your public key to verify the paysecure-sign header against the webhook body.
\n
This ensures the webhook came from NovixPay and was not tampered with.
\n

🔏 Signature: paysecure-sign (or paysecure_sign)

The paysecure-sign header is a Base64-encoded digital signature generated using your merchant-specific RSA private key.

🔨 How the Signature is Generated

Message Construction

Concatenate the following fields in order:

{purchaseId}|{message.status}|{brandId}\n\n

Example

1234567890|PAID|BRAND_001\n\n

2. Signing Algorithm

Algorithm: SHA256withRSA
\n
Output: Base64-encoded signature (sent in the paysecure-sign header).
\n

✅ How to Verify the Signature

Rebuild the Message

From the webhook JSON body, extract:

purchaseId
\n
status (convert to uppercase)
\n
brandId
\n

Reconstruct the string in the same format:
{purchaseId}|{message.status}|{brandId}

2. Verification Steps

Use your stored public key.
\n
Decode the paysecure-sign header from Base64.
\n
Verify using SHA256withRSA.
\n
If verification succeeds, the webhook is authentic and untampered.
\n

💻 Java Verification Example

public 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\n

message → The reconstructed string (purchaseId|STATUS|brandId)
\n
signatureBase64 → Value from paysecure-sign header
\n
publicKey → Your saved NovixPay public key
\n

\n","_postman_id":"2c99d7ce-01b3-43f6-b15a-22a0824f7538"},{"name":"Payout","item":[],"id":"62312cf8-ef15-4e86-a629-ca711bbeced1","description":"

Overview

When 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.

The callback includes full transaction details so the merchant can update order status in real time.

Webhook Events for Payouts

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Event type (Condition applied in code)	Status	When is the event triggered	Is this a terminal event
Payout – Created	created	When the payout request is created	No
Payout – in Process	payout_in_process	When the Payout request is triggered to the bank, and the status is in pending	No
Payout – Pending Review	pending_review	When the payout request needs manual review from the merchant	No
payout – failure	error	Triggered when the payout request fails (system/PSP error, rejection, etc.).	✅ Yes
payout – success	paid	Triggered when the payout is processed successfully and funds are released.	✅ Yes

Webhook Payload Specification

Fields Description

Key	Description
payload.payoutId	Unique identifier of the payout generated by NovixPay.
payload.client.customerId	Customer’s ID in the merchant’s system (if available), otherwise \"NA\".
payload.client.email	Customer’s email address.
payload.client.phone	Customer’s phone number (with country code).
payload.client.full_name	Full name of the customer.
payload.client.country	ISO 2-letter country code of the customer.
payload.updated_on	UNIX timestamp of the last update to the payout transaction.
payload.payoutMethod	Payout method used (e.g., \"PAYOUT-INTERAC\").
payload.amountUnit	Unit of amount — \"MAJOR\" for full currency unit, \"MINOR\" for subunits.
payload.amount	Total payout amount.
payload.errorMsg	Message describing the payout result — success message or error details.
payload.purpose	Purpose/description of the payout.
payload.created_on	UNIX timestamp when the payout was created.
payload.merchantRef	Unique transaction reference from the merchant.
payload.merchantName	Registered merchant name in NovixPay.
payload.currency	Currency code of the payout (ISO 4217).
payload.fx_Currency	FX (foreign exchange) currency used (if applicable).
payload.fx_Amount	FX-adjusted payout amount.
payload.transFees	Transaction fee amount.
payload.paymentOn	UNIX timestamp when the payout was completed/paid.
payload.payOutDetails.name	Payout instrument name (e.g., \"INTERAC E-TRANSFER\").
payload.payOutDetails.emailAddress	Payout recipient email address.
payload.payOutDetails.secretQA	Security question used for payout (if applicable).
payload.payOutDetails.secretAnswer	Security answer used for payout (if applicable).
payload.taxAmount	Tax amount applied to the payout.
payload.taxPercent	Tax percentage applied to the payout.
payload.redirectType	Redirect method after payout completion (e.g., \"POST\").
payload.pendingReview	Indicates if the payout is under review (\"Yes\"/\"No\").
payload.surcharge	Surcharge amount applied (if any).
payload.success_callback	Callback URL invoked on payout success.
payload.failure_callback	Callback URL invoked on payout failure.

Possible Status Values

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

status	description
error	Payout failed due to an error.
created	Payout record created but not paid yet.
paid	payment completed successfully.
payout_in_process	Payout is in progress.
pending_review	Payout needs to be reviewed

🔐 Key Pair Generation

NovixPay uses RSA key pairs to digitally sign webhooks, ensuring all notifications are both secure and authentic.

1. Generate Your Keys

\n\n

Click “Generate Key Pair” in the dashboard.
\n
A unique RSA private key and public key are created for your merchant ID
\n

2. Key Storage

\n\n

Private Key → Stored securely by NovixPay (never exposed).
\n
Public Key → Displayed to you once on the screen. Copy and save it for verifying signatures.
\n

3. Webhook Signing

Every webhook payload is signed using NovixPay’s private key.
\n
The signature is included in webhook headers:
\n
- paysecure-sign or paysecure_sign
\n

4. Verification

Use your public key to verify the paysecure-sign header against the webhook body.
\n
This ensures the webhook came from NovixPay and was not tampered with.
\n

🔏 Signature: paysecure-sign (or paysecure_sign)

The paysecure-sign header is a Base64-encoded digital signature generated using your merchant-specific RSA private key.

🔨 How the Signature is Generated

Message Construction

Concatenate the following fields in order:

{payoutId}|{payload.status}\n\n

Example:

1234567890|paid<strong class=&#x27;preserveHtml&#x27; class=&#x27;preserveHtml&#x27; class=&#x27;preserveHtml&#x27; class=&#x27;preserveHtml&#x27; class=&#x27;preserveHtml&#x27; class=&#x27;preserveHtml&#x27; >\n</b>\n\n

2. Signing Algorithm

Algorithm: SHA256withRSA
\n
Output: Base64-encoded signature (sent in the paysecure-sign header).
\n

✅ How to Verify the Signature

Rebuild the Message

From the webhook JSON body, extract:

payoutId
\n
payload.status (convert to lowercase)
\n

Reconstruct the string in the same format:
{payoutId}|{payload.status}

2. Verification Steps

Use your stored public key.
\n
Decode the paysecure-sign header from Base64.
\n
Verify using SHA256withRSA.
\n
If verification succeeds, the webhook is authentic and untampered.
\n

public 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\n

message → The reconstructed string (payoutId|status)
\n
signatureBase64 → Value from paysecure-sign header
\n
publicKey → Your saved NovixPay public key
\n

\n","_postman_id":"62312cf8-ef15-4e86-a629-ca711bbeced1"}],"id":"2d3a5877-4a2e-49d6-afd1-3ea4b493269c","description":"

To receive information about various transaction status and events, you will need to set up an endpoint which accepts payloads sent by NovixPay. Your endpoint will receive POST requests with content-type: application/json.

Configuring the webhook endpoint

The webhook endpoint can be set up on Partner Dashboard -> Webhooks -> New Webhook.

\n\n

Make sure you save the endpoint by clicking \"Create\".

NovixPay 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 NovixPay get status API to verify the status of a purchase.

Steps to Configure a Webhook

\n\n

1.Add a New Webhook:

Click on the “New Webhook” button.

2. Provide Details:

Name: Give the webhook a descriptive name.
\n
Payment Method Selection:
\n

a. Choose a specific payment method or select “All” for universal callbacks.

Enter URL:

a. Provide the callback URL where the event notifications will be sent.

3. Select Event Triggers:

a. Choose from a list of available events (Note: Depending on the payment method, not all events may be available.)

4. Save configuration:

a. Click “Save” to store the webhook settings.**

Notes:

You can setup one URL for all the events or individual URLs for each of the events. NovixPay 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.
\n
In 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.novixpay.io/api/v1/purchases/{purchaseId}/
\n

Available Event for subscription

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.

The callback includes full transaction details so the merchant can update order status in real time.

HTTP Method & Headers

Method: POST

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Header	Description
Content-Type	application/json; charset=utf-8 — Indicates the payload format is JSON in UTF-8 encoding.
User-Agent	Always set to \"NovixPay\" — Identifies the request origin as NovixPay.
paysecure_sign	Present only if a signature value (paysecure_sign) is generated(see the logic below). This is used for validating the authenticity of the callback.
paysecure-sign	Same signature value as paysecure_sign but provided in an alternate header name for better compatibility.

Webhook structure

We add a signature as “paysecure_sign” or \"paysecure-sign\" in the webhook header for verifying the payload, If you have already created a public key from your merchant dashboard.

To verify this signature, decrypt the signature with your public key. Compare this with the values which you received in your payload.

Use the following method (in Java) for signature verification.

 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\n

Where the message is the combination of values which you received in the payload:
\n
1. For Payins: the message is a combination of purchaseId+\"|\"+status(uppercase)+\"|\"+brandId
  \n
2. Payouts: this message is a combination of p**ayoutId+\"|\"+status(lowercase)**
  \n
\n
The signature is the value of the “paysecure_sign” or \"paysecure-sign\" you received in webhook.
\n
You can obtain the Public Key from your merchant dashboard.
\n

\n","_postman_id":"2d3a5877-4a2e-49d6-afd1-3ea4b493269c"},{"name":"🖥️ Status Code","item":[{"name":"Transaction Status and Their Meaning","item":[],"id":"2841798e-7cca-4a28-9255-afc90400df51","description":"

The lifecycle of a transaction is reflected through the status of the transaction.

This section details various statuses of a transaction and what it means and when does it appears.

The status of a transaction can be read from the \"status\" field of the responses or webhook payload.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Status	Description	When it Appears	Is it Final?
CREATED	Purchase is created in the system.	When Purchase API is called, the transaction is created as \"CREATED\".	N
CANCELLED	Purchase is cancelled in the system. Only transactions in \"CREATED\" status can be cancelled.	When Cancel API is called.	Y
PENDING EXECUTE	Purchase hasn't been completed yet. Only transactions in \"CREATED\" status can become \"PENDING EXECUTE\" after S2S API call.	The callback URL provided in the S2S call response hasn't been called by merchant yet.	N
OVERDUE	Purchase hasn't been completed yet. Only transactions in \"CREATED\" status can become \"OVERDUE\" if S2S API hasn't been called in 2 hours.	S2S API hasn't been called within 2 hours since transaction creation.	N
EXPIRED	Purchase hasn't been completed. Only transactions in \"PAYMENT IN PROCESS\" and \"PENDING EXECUTE\" status can become \"EXPIRED\". After payment in process, no data is provided.	The callback URL provided in the S2S call response hasn't been called by the merchant after the specific time period.	Y
PAID	Purchase has been completed successfully. Only transactions in \"PAYMENT IN PROCESS\" status can become \"PAID\".	The callback URL provided in the S2S call response has been called by the merchant.	Y
PAYMENT IN PROCESS	Purchase hasn't been completed. Only transactions in \"PENDING EXECUTE\" status can become \"PAYMENT IN PROCESS\".	When the user's action is pending (e.g., OTP confirmation). Transaction can stay in this status for 24 hours since creation.	N
CHARGEBACK	Transaction type that allows customers to receive money back.	When requested by customer or merchant (manual process).	Y
REFUNDED	Only transactions in \"REFUND IN PROCESS\" status can become \"REFUNDED\".	When the provider confirms the refund.	Y
REFUND IN PROCESS	Only transactions in \"PAID\" status can become \"REFUND IN PROCESS\".	When Refund API is called and a response is received with \"REFUND IN PROCESS\" status.	N
ERROR	Only transactions in statuses: \"PENDING EXECUTE\", \"PAYMENT IN PROCESS\", \"PAYOUT IN PROCESS\" or \"REFUND IN PROCESS\" can become \"ERROR\".	Refers to the Errors list for possible errors.	Y

Note:

If 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":"f9591757-a854-431b-9db3-6a7016ef7db7"}},{"listen":"test","script":{"type":"text/javascript","exec":[""],"id":"dc027071-a0bb-4065-b4c5-6d147dbc1bef"}}],"_postman_id":"2841798e-7cca-4a28-9255-afc90400df51"}],"id":"9508126b-198e-4328-9e84-211bf71fa13f","description":"

HTTP Response Code

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Code	Triggering Event
200	Successful Response
202	Successful / Accepted
400	Bad request, the given data is invalid, or additional data is required
401	unauthorized request
404	page not found
405	Method Not Allowed (GET/POST)
415	unsupported media type
422	Unprocessable content, data is required
429	Too many request attempt
500	Internal server error

You will not get Error codes if HTTPS response code is 200 or 202.

Error Codes and Messages

with http code (400, 404, 401, 405, 415)

Below is the list of possible error codes and the corresponding messages from NovixPay System

Format

{\n    \"message\": \"descriptive error message\",\n    \"code\": \"error_code\"\n}\n\n

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Code	Message	APIs that could generate the error code
Authentication_failed	Authorization header missing	All
already_in_process	Some Processing is running on this purchaseId	All
unsupported_media_type	Unsupported media type \"text/plain; charset=ISO-8859-1\" in request.	All
authentication_failed	Incorrect secret_key/Invalid Merchant Type	All
transaction_error	See the table below	See the table below

\"transaction_error\" Message List

All the Messages possible when \"transaction_error\" is in reponse:

Message	APIs that generate the error Message
Cvv_error	after executing callback_url
Expired card	after executing callback_url
expiry_date_error	after executing callback_url
Insufficient fund	after executing callback_url
Invalid card number	after executing callback_url
Issuing bank - do not honer	after executing callback_url
Picking card	after executing callback_url
Temp error - card blocked	after executing callback_url
Transaction declined - try again	after executing callback_url
PurchaseId Not found.	after executing callback_url
Only purchases that can be paid for can be initiated for payment.	after executing callback_url
Customer/Ip is Blocked	after executing callback_url
Client Ip could not be match with Merchant Ip	s2s calling
Invalid Card Information	s2s calling
Card is Blocked	s2s calling
Different Type of key used to create purchase and payment	s2s calling
You charges setting is in complete .Please Contact to Administrator.	s2s calling
Allowed Attempt for this Transaction has been consumed	s2s calling
Customer not allowed For transaction	s2s calling
Invalid Card Expiry(Valid Format:MM/YY) must be greater than current month/year	s2s calling
Customer profile is Blocked	s2s calling
Customer/Card not allowed for transaction	s2s calling
Allowed Limit for this card for particular time period has been consumed	create purchase
some Mandatory Parameter are missing	create purchase
Invalid_Parameter	create purchase
Invalid format of Date_of_Birth[allowed format: yyyy-mm-dd]	create purchase
Invalid Email Format	create purchase
Please submit Valid Alpha2 Country Code Ex:(AF,IN) in \\\"country\\\" parameter	create purchase
Please pass Valid State Code	create purchase
Please pass valid street address in \\\"street_address\\\" parameter	create purchase
Please pass valid city name in \\\"city\\\" parameter	create purchase
Please pass valid postal Code name in \\\"zip_code\\\" parameter	create purchase
You are not Allowed for Live Transaction	create purchase
Merchant Limit is not set	create purchase
Minimum amount is not set for this merchant	create purchase
Brand not found!	create purchase
Your charges setting is incomplete .Plese Contact to Administrator.	create purchase
Only “curr_name” currency is allowed	create purchase
Transaction amount must be equal or greater to minimum trans amount	create purchase
Transaction amount must not be greater to maximum trans amount	create purchase
This Purchase was already fully refunded.	`/refund/`
Previous Refund Request already in Process	`/refund/`
Max Time for Refund was elapsed.	`/refund/`
Refund can not be initiated .Please contact Administrator.	`/refund/`
Only Purchases with `status == (paid)` can be refunded.	`/refund/`
Only purchases that can be paid for can be cancelled.	`/cancel/`

","auth":{"type":"noauth","isInherited":false},"event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":[""],"id":"024244ef-cf09-42c4-9bbf-b87afa7ca9d1"}},{"listen":"test","script":{"type":"text/javascript","exec":[""],"id":"0fbeae3b-279a-472f-af9a-092a63524956"}}],"_postman_id":"9508126b-198e-4328-9e84-211bf71fa13f"},{"name":"Payment Methods","item":[{"name":"💳 Card Payments","item":[{"name":"Concepts","item":[],"id":"0f33e94f-892e-49e6-97ad-f8a4326ac606","description":"

NovixPay Card Payments

Get started

NovixPay’s Server-to-Server (S2S) integration allows merchants to process card payments entirely from their backend systems. In this model, the client application or browser does not interact directly with NovixPay APIs. All sensitive payment operations are handled securely on the server.

This integration is recommended for merchants who require:

Full control over the checkout experience
\n
Reduced exposure of platform endpoints
\n
A secure and compliant payment architecture
\n

How it works

The S2S card payment flow follows a three-step process:

Create a purchase
Register the transaction and generate a unique purchaseId.
\n
Submit card details (S2S)
Send card and device details securely from your server.
\n
Handle callbacks and redirects
Complete the transaction using 2D or 3D Secure flows.
\n

This integration supports:

2D (non-3DS) transactions
\n
3D Secure Frictionless transactions
\n
3D Secure Challenge transactions
\n

Before you begin

Before starting the integration, ensure the following prerequisites are met:

You have received your API credentials from NovixPay
\n
Your server can make secure HTTPS requests
\n
You are PCI-DSS compliant for handling card data
\n
You have configured the following redirect URLs:
\n
- success_redirec
  \n
- pending_redirect
  \n
- failure_redirect
  \n
\n
You have a valid brand_id provided by NovixPay
\n

Create a New Payment Session

A payment session is created when a purchase is initialized in the NovixPay system. This session represents the starting point of a transaction and is required before submitting any payment details or initiating authentication flows.

Creating a payment session registers the transaction details, configures redirect URLs, and generates a unique identifier (purchaseId) that is used in all subsequent Server-to-Server (S2S) payment operations.

When to create a payment session

You must create a new payment session when:

A customer initiates a new checkout
\n
A new payment attempt is required
\n
You want to process a card payment using S2S integration
\n
You need to support 2D or 3D Secure payment flows
\n

Each payment session corresponds to one transaction attempt.

Payment Session Flow

Your server sends a request to the Create Purchase API with customer, product, and redirect details.
\n
NovixPay validates the request and creates a new payment session.
\n
A unique purchaseId is generated for the session.
\n
The payment session remains in the CREATED state until payment details are submitted.
\n
The purchaseId is used to continue the payment flow via S2S APIs.
\n

Card Payments

Card payments enable customers to pay online using debit or credit cards issued by card networks such as Visa, Mastercard, and others. During a card payment , the customer’s card details are submitted securely and sent through the payment processor , card network, and issuing bank to determine whether the transaction can be authorized.

Card payment checks include:

Card validity and available balance
\n
Risk and fraud assessment
\n
Authorization by the issuing bank
\n

Depending on the security requirements, region, and risk profile, a card payment can be processed as either:

2D (Non-3DS) payment
\n
3D Secure (3DS) payment
\n

2D (non-3DS) Payments

2D payments are standard card transactions that do not include an additional cardholder authentication step by issuing bank. Authorization is based on the card details and internal risk checks performed by the payment processor and issuer.

2D Payment Flow

The customer provide card details (card number, expiry, cvv)
\n
The transaction is authorized or declined by the issuing bank
\n
The customer is directly redirected to the final outcome URL
\n

Characteristics

Faster checkout experience
\n
Lower protection against fraud and chargebacks
\n
No callback URL generated
\n
No 3D Secure authentication
\n

Typical Use Case

Low-risk transactions
\n
Trusted customers
\n
Regions or scenarios where 3DS is not mandatory
\n

3D Secure (3DS) Payments

3D secure (3DS) Payments add an extra layer of security by requiring the cardholder to be authenticated by issuing bank. This helps reduce fraud and protects merchants against certain types of chargebacks.

3DS Payment Flow

The transaction is evaluated by the card network and issuing bank
\n
Based on risk assessment, the transaction proceeds through either a Frictionless or Challenge flow
\n
After authentication, the transaction is authorized or declined
\n
The customer is redirected to the appropriate URL
\n

3DS Authentication Flows

3D Secure Challenge Flow

The customer is redirected to the issuer’s ACS (Access Control Server)
\n
The cardholder must authenticate (OTP, biometric, or password)
\n
After authentication, the customer is redirected to the appropriate URL
\n

3DS payments provide higher security, better fraud prevention, and improved compliance with regulatory requirements such as PSD2 (Second Payment Service Directive).

3D Secure Frictionless Flow

No user interaction is required
\n
Authentication is completed automatically in the background
\n
The customer is directly redirected to the appropriate URL
\n

2D vs 3D Secure - Comparison Table

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Feature	2D (Non-3DS) Payments	3D Secure (3DS) Payments
Cardholder authentication	Not required	Required (Frictionless or Challenge)
User interaction	Not required	Required only in Challenge flow
Security level	Standard	High
Fraud protection	Limited	Strong
Chargeback liability shift	No	Yes (subject to scheme rules)
Callback URL	Not generated	Generated when authentication is required
Redirect handling	Direct redirect to final URL	Redirect after authentication
Checkout speed	Faster	Slightly slower (Challenge flow only)
Regulatory compliance	Not always sufficient	Helps meet PSD2 and similar regulations
Typical use case	Low-risk transactions	Medium to high-risk transactions

Required configuration

To successfully create a payment session, the following must be provided:

Customer information (name, email, location)
\n
Purchase details (currency and products)
\n
A valid brand_id
\n
Redirect URLs to handle the final transaction outcome:
\n
- success_redirect
  \n
- pending_redirect
  \n
- failure_redirect
  \n
\n

These redirect URLs are mandatory and are used later during 2D or 3D Secure flows.

Redirect Handling

After successful background authentication, the user is redirected to one of the following URLs, which must be configured during the Purchase Creation step:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Redirect URL	Description
success_redirect	Payment completed successfully
pending_redirect	Payment is still under processing
failure_redirect	Payment failed or was declined

The final redirect depends on the authorization and authentication outcome returned by the issuer.

API Used for Card Payment

| POST /api/v1/purchases |

Step 1: Transaction Initiation – Create a Purchase

Overview

To begin a transaction, a Purchase must first be created in the system. This is done by initiating a purchase request that registers all required transaction details and prepares the system for further processing.

This step applies equally to both 2D and non-2D transactions and follows the same flow regardless of transaction type.

Purchase Creation Process

A purchase is initiated by sending a POST request to the purchase creation endpoint ({baseURL}/purchase/).
\n
During this step, the system validates the request and creates a Purchase record.
\n
Once the Purchase is successfully created, the system generates a unique purchaseId, which is required for subsequent server-to-server operations.
\n

Mandatory Redirect URLs

To successfully create a Purchase, the following redirect URLs must be defined and must contain valid URLs:

success_redirect
Redirects the customer after a successful transaction.
\n
pending_redirect
Redirects the customer when the transaction remains in a pending or processing state.
\n
failure_redirect
Redirects the customer if the transaction fails.
\n

merchantRef (Merchant Reference)

Although not mandatory, the merchantRef parameter is strongly recommended for all merchants.

Purpose and Benefits

Prevention of Duplicate Transactions
\n
- merchantRef acts as a unique merchant-defined reference.
  \n
- If a subsequent purchase request is sent using the same merchantRef, the system identifies it as a duplicate and prevents accidental repeat transactions.
  \n
\n
Transaction Retrieval and Recovery
\n
- If the purchase creation response times out or the purchaseId is not received,
  the merchant can use merchantRef to retrieve the corresponding transaction details.
  \n
- This ensures reliable tracking and reconciliation even when immediate responses are unavailable.
  \n
\n

System Behavior Without merchantRef

If merchantRef is not provided, the platform automatically assigns an internal purchaseId.
\n
This internally generated purchaseId then becomes the sole reference for that transaction.
\n

Purchase Creation Outcome

On successful creation of a Purchase:
\n
- The system returns a purchaseId.
  \n
- This purchaseId uniquely identifies the transaction within the platform.
  \n
\n

Step 2: Server-to-Server (S2S) Processing

After receiving the purchaseId, merchants must proceed with the server-to-server (S2S) call using the following pattern:

This call is required to continue processing the transaction securely on the server side.

| p/{purchaseId}/?s2s=true |

Step 3: Transaction Flows After Calling callback_url

After the callback URL is invoked, the transaction can proceed through one of the following three flows:

3D Secure Challenge Flow

The user is redirected to the ACS (Access Control Server) page of the issuing bank.
\n
The cardholder is required to complete authentication (e.g., OTP, biometric, or password).
\n
After successful or failed authentication, the user is redirected to one of the URLs configured during the Purchase Creation API:
\n
- Success_redirect
  \n
- Pending_redirect
  \n
- failure_redirect
  \n
\n

The final redirect depends on the transaction outcome.

3D Secure Frictionless Flow

The 3D Secure Frictionless Flow is a streamlined authentication process where the cardholder does not need to perform any additional action. The authentication is completed automatically in the background based on risk assessment performed by the card network and the issuing bank.

This flow is designed to deliver a fast and seamless checkout experience while still complying with 3D Secure regulations.

When Frictionless Flow Occurs

A transaction may qualify for the frictionless flow when:

The transaction amount is considered low risk
\n
The issuing bank trusts the merchant and transaction context
\n
Accurate device and browser information is provided
\n
The cardholder has a positive transaction history
\n

Note: The final decision to apply frictionless authentication is made solely by the issuing bank.

Important:

Calling the callback_url is mandatory for all transactions returning a 202 response.
\n
All redirect URLs must be predefined during the Purchase Creation step.
\n
Merchants should ensure proper handling of all three redirect outcomes to deliver a seamless user experience.
\n

Operational Flow

The merchant submits the card payment request using the Server-to-Server (S2S) API.
\n
NovixPay sends the transaction details to the card network and issuing bank for 3D Secure evaluation.
\n
The issuing bank determines that no challenge is required based on:
\n
- Cardholder risk profile
  \n
- Transaction amount
  \n
- Device and browser data
  \n
- Merchant trust level
  \n
\n
Authentication is successfully completed in the background without redirecting the user to an authentication (ACS) page.
\n
Once authentication and authorization are completed, the user is automatically redirected to the appropriate URL configured during the Purchase Creation API.
\n

HTTP Response Codes

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Code	Triggering Event
200	Request processed successfully
202	Request accepted and processing is pending
400	Bad request – invalid data provided or required data is missing
401	Unauthorized request – invalid or missing authentication credentials
404	Resource or page not found
405	Method not allowed (unsupported HTTP method such as GET or POST)
415	Unsupported media type
422	Unprocessable content – required data is missing or invalid
429	Too many requests – rate limit exceeded
500	Internal server error

Please see the Status Code section for further details.

If the response code is 202, upon receiving the response body, redirect the customer to the callback_url provided in the response.

If the card requires 3D Secure verification, the user will be redirected to a verification or challenge screen by the card issuing bank. After successful user verification, the user will be redirected to the success URL provided in the /purchase API from Step 1.

If, for any reason, the transaction is unsuccessful, the user will be redirected the failure URL provided in the /purchase API from Step 1.

\n","auth":{"type":"noauth","isInherited":false},"event":[{"listen":"prerequest","script":{"type":"text/javascript","packages":{},"requests":{},"exec":[""],"id":"a5449d47-0b98-4963-a535-f1f4e4e9314c"}},{"listen":"test","script":{"type":"text/javascript","packages":{},"requests":{},"exec":[""],"id":"b7bdc0ae-4e26-4f83-b18f-2671dd02e376"}}],"_postman_id":"0f33e94f-892e-49e6-97ad-f8a4326ac606"},{"name":"APIs","item":[{"name":"Purchase","id":"42952a8e-fc52-4d9f-af91-94f6fb6f4939","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"client\": {\r\n \"email\": \"example@novixpay.io\",\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 \"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":"app.novixpay.io/purchases","description":"

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.

The following (see table below) are the mandatory parameters that are required to create a purchase request.

Mandatory parameters in the request body:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Notes
client.email	The customer's email.
client.city	The customer's city.
client.country	ISO-3166 Country Code. Must be upper case. Example “SG” (Alpha2)
client.stateCode	Example “AL”, “XZ”. Must be in upper case.
Client.street_address	The customer's address.
client.zip_code	The customer's ZIP or postal code. If country=US, zip format must be NNNNN or NNNNN-NNNN.
purchase.currency	ISO 4217 code for currency you want to send the transaction in. Please note, the currency has to be enabled by the account manager for your account.
purchase.products	An object which contains the list of products which the customer is buying.
purchase.products.name	The name of the product.
purchase.products.price	Price in decimal format. example 1: EUR 5 , should be sent as 5.00 example 2: USD 10 and 37 cents , should be sent as 10.37
brand_id	Obtain from Dashboard section of your merchant account login.
success_redirect	URL to send the user if the transactions is successful.
pending_redirect	URL to send the user if the transactions is in pending.
failure_redirect	URL to send the user if the transactions is unsuccessful.

Essential Optional Parameters

merchantRef

The 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.
\n
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.
\n

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.

Upon 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 .

paymentMethod

The paymentMethod parameter identifies which payment solution merchant wants to use to perform a transaction. If parameter is provided, than NovixPay will perform direct payment with the selected payment method instead of loading NovixPay URL.

Errors

If there are any errors then it'll be in the format of :

{\n    \"message\": \"descriptive error message\",\n    \"code\": \"error_code\"\n}\n\n

Possible Error Messages

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Error Messages
Allowed Limit for this card for particular time period has been consumed
some Mandatory Parameter are missing
Invalid format of Date_of_Birth [allowed format: yyyy-mm-dd]
Invalid Email Format
Please submit Valid Alpha2 Country Code Ex:(AF,IN) in \\\"country\\\" parameter
Please pass Valid State Code
Please pass valid street address in \\\"street_address\\\" parameter
Please pass valid city name in \\\"city\\\" parameter
Please pass valid postal Code name in \\\"zip_code\\\" parameter
You are not Allowed for Live Transaction
Merchant Limit is not set
Minimum amount is not set for this merchant
Brand not found !
Your charges setting is incomplete .Plese Contact to Administrator.
Only {{currencyCode}} currency is allowed.
Transaction amount must be equal or greater to minimum trans amount
Invalid_Parameter You'd usually get it when one or more mandatory parameters are not present in the request.

","urlObject":{"path":["purchases"],"host":["app","novixpay","io"],"query":[],"variable":[]}},"response":[{"id":"27d0c789-96b4-4e1d-b908-c61c14353829","name":"Purchase","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text","disabled":true}],"body":{"mode":"raw","raw":"{\r\n \"client\": {\r\n \"email\": \"example@novixpay.io\",\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\": \"9999999999\"\r\n },\r\n \"purchase\": {\r\n \"currency\": \"USD\",\r\n \"products\": [\r\n {\r\n \"name\": \"product name\",\r\n \"price\": \"10\"\r\n }\r\n ]\r\n },\r\n \"merchantRef\": \"d9db7ec0-f94c-4a9d-8883-54c19c222d81\",\r\n \"status\": \"created\",\r\n \"brand_id\": \"bd69e8a5-adcf-40de-9e43-2b87cb129a5e \",\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":"app.novixpay.io/purchases"},"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:22:14 GMT"},{"key":"Keep-Alive","value":"timeout=60"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\n \"purchaseId\": \"64b032c3c6dccf7d329d9e7e\",\n \"client\": {\n \"bank_account\": \"\",\n \"bank_code\": \"\",\n \"email\": \"dev@novixpay.io\",\n \"phone\": \"\",\n \"full_name\": \"\",\n \"date_of_birth\": \"\",\n \"personal_code\": \"\",\n \"street_address\": \"test test\",\n \"country\": \"IN\",\n \"city\": \"123\",\n \"zip_code\": \"234567\",\n \"shipping_street_address\": \"\",\n \"shipping_country\": \"\",\n \"shipping_city\": \"\",\n \"shipping_zip_code\": \"\",\n \"cc\": [],\n \"bcc\": [],\n \"legal_name\": \"\",\n \"brand_name\": \"\",\n \"registration_number\": \"\",\n \"tax_number\": \"\",\n \"stateCode\": \"ca\"\n },\n \"updated_on\": 1689268934,\n \"type\": \"purchase\",\n \"force_recurring\": false,\n \"created_on\": 1689268934,\n \"purchase\": {\n \"currency\": \"USD\",\n \"products\": [\n {\n \"name\": \"dk\",\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 \"request_client_details\": [],\n \"timezone\": \"America/Edmonton\",\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 \"bank_account\": \"\",\n \"bank_code\": \"\"\n }\n ],\n \"legal_name\": \"shoes\",\n \"brand_name\": \"shoes\",\n \"registration_number\": \"\",\n \"tax_number\": \"\"\n },\n \"transaction_data\": {\n \"payment_method\": \"\",\n \"flow\": \"payform\",\n \"extra\": {},\n \"country\": \"\",\n \"attempts\": []\n },\n \"status\": \"CREATED\",\n \"status_history\": [\n {\n \"status\": \"created\",\n \"timestamp\": 1689268934\n }\n ],\n \"is_test\": false,\n \"brand_id\": \"bd69e8a5-adcf-40de-9e43-2b87cb129a5e\",\n \"is_recurring_token\": false,\n \"reference_generated\": \"PS161\",\n \"merchantRef\":\"d9db7ec0-f94c-4a9d-8883-54c19c222d81\",\n \"issued\": \"2023-07-13\",\n \"due\": 1689268934,\n \"refund_upto\": 0,\n \"cc_descriptor\": \"\",\n \"refund_availability\": \"NONE\",\n \"refundable_amount\": 0,\n \"success_redirect\": \"https://your.success.redirect.com\",\n \"failure_redirect\": \"https://your.failure.redirect.com\",\n \"cancel_redirect\": \"\",\n \"success_callback\": \"\",\n \"platform\": \"API\",\n \"created_from_ip\": \"149.86.53.48\",\n \"checkout_url\": \"http://app.novixpay.io/payments/64b032c3c6dccf7d329d9e7e/\",\n \"direct_post_url\": \"http://app.novixpay.io/api/v1/p/64b032c3c6dccf7d329d9e7e/\"\n}"}],"_postman_id":"42952a8e-fc52-4d9f-af91-94f6fb6f4939"},{"name":"S2S","id":"0d923985-33ac-4e3f-8ff8-734b3ac6c9a3","protocolProfileBehavior":{"disableUrlEncoding":false,"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 \"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":"app.novixpay.io/p/64bff4fff63e36669499e9c8/?s2s=true","description":"

This 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.

Mandatory parameters in request body:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Notes
remote_ip	IP address of the customer’s device used for transaction. Helps in fraud checks and risk scoring. Ex- 157.38.242.7
user_agent	Full browser and operating system details captured from HTTP header. EX- Chrome/5.0 (X11; Linux x86_64)
accept_header	Browser’s accepted content types (from HTTP header). Used for validating request origin and device info. EX- text/html

Essential parameters in request body:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Notes
cardholder_name	Name of the cardholder
card_number	The card numbers Must be 10-20 characters.
expires	must be greater than the current month/year.
cvc	3 or 4 digit

Other optional parameters in request body:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Notes
language	Preferred language of the user’s browser . EX - en-US
java_enabled	Indicates if Java is enabled in the browser. Helps PSPs in device profiling. Ex- true/false
javascript_enabled	Indicates if JavaScript is enabled in the client browser. Used for 3DS or risk-based checks. Ex- true
color_depth	Bit depth of the display screen. Ex- 24
utc_offset	Difference in minutes between local time and UTC. Used for location and timezone checks. Ex- 330
screen_width	Width of the device screen in pixels. Used in device profiling. Ex- 1920
screen_height	Height of the device screen in pixels. Ex- 1080

Successful Response

If all the details are correct you'll get a 202 response with staus as Pending

{\n    \"status\": \"pending\",\n    \"callback_url\": \"https://novixpay.io/payment/63bd0bf80fb42a076e8a4dd1/\",\n    \"method\": \"GET\"\n}\n\n

If the response code is 202, after receiving the response body, direct the customer to the callback_url provided in the response.

Errors

If there are any errors then it'll be in the format of :

{\n    \"message\": \"descriptive error message\",\n    \"code\": \"error_code\"\n}\n\n

Please see the Status Code section for further details.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Error Messages
Client Ip could not be matched with Merchant Ip
Invalid Card Information
Card is Blocked
Different Type of key used to create purchase and payment
You charges setting is incomplete .Plese Contact to adminstrartor.
Allowed Attempt for this Transaction has been consumed
Invalid Card Expiry(Valid Format:MM/YY) must be greator than current month/year
Customer profile is Blocked
Customer/Card not allowed for transaction

","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"a787d836-5e11-40eb-8684-89a6067c21fb","id":"a787d836-5e11-40eb-8684-89a6067c21fb","name":"APIs","type":"folder"}},"urlObject":{"path":["p","64bff4fff63e36669499e9c8",""],"host":["app","novixpay","io"],"query":[{"key":"s2s","value":"true"}],"variable":[]}},"response":[{"id":"e7681424-9454-482d-8b68-e69a6bfc236e","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":"app.novixpay.io/p/64bff4fff63e36669499e9c8/?s2s=true","host":["app","novixpay","io"],"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://app.novixpay.io/api/v1/payment/64b034ecc6dccf7d329d9eb3/\",\n \"method\": \"GET\"\n}"},{"id":"81aeedc0-60a4-4f64-9e53-95b76d084778","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":"app.novixpay.io/p/64bff4fff63e36669499e9c8/?s2s=true","host":["app","novixpay","io"],"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":"0d923985-33ac-4e3f-8ff8-734b3ac6c9a3"},{"name":"Payment (To be initiated From client browser)","id":"891a5e87-2965-4258-a4de-088f154e8cab","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{Production}}/payment/64bff12bf63e36669499e97d/","description":"

This is the callback URL that is in the response object ofthe Server-to-Server Call

When this URL is called from the end user's browser, the user would be redirected to the success_redirect or failure_redirect URL given by the merchant at the time of create purchase

When this URL is called from the end user's browser, if card is 3DS enrolled, the user user will be redirect to a verification screen or challenge by the issuing bank and upon successful user verification, the user would be redictected to the success URL given in /purchases API .

If for some reason the transactions is unsuccessful, the user will be redirect to failure URL given in /purchases API API .

This API tells you about all the details of a purchase, including its history

Mandatory

you need to pass the PurchaseID in the API URL

Possible Value of Status

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Status	Notes
created	When Purchase order is created.
paid	Transaction Successful
payment_in_process	Payment is under Processing
chargeback	Payment is chargeback state
refund_in_process	Refund is under Processing.
expired	Purchase has Expired.
overdue	Purchase is Overdued.
cancelled	Purchase is cancelled.
error	Transaction has Failed.
refunded	Payment is refunded

Response Examples

In the response examples you can see instances of both Paid and Error Status purchases.

Error Details

If there are any issues on the Purchase you can get more details from the transaction_data.attempts.error attribute of the response object

Errors

If there are any errors then it'll be in the format of :

{\n    \"message\": \"descriptive error message\",\n    \"code\": \"error_code\"\n}\n\n

Please see the Status Code section for further details.

\n","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"a787d836-5e11-40eb-8684-89a6067c21fb","id":"a787d836-5e11-40eb-8684-89a6067c21fb","name":"APIs","type":"folder"}},"urlObject":{"path":["purchases","64bff12bf63e36669499e97d",""],"host":["app","novixpay","io"],"query":[],"variable":[]}},"response":[{"id":"424eb931-c913-44c2-bb59-678e3fb9d4f9","name":"Purchases-error","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"url":"http://18.214.100.20/api/v1/purchases/64bfd7c9f63e36669499e779/"},"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":"Tue, 25 Jul 2023 15:44:06 GMT"},{"key":"Keep-Alive","value":"timeout=60"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\n \"purchaseId\": \"64bfd7c9f63e36669499e779\",\n \"client\": {\n \"bank_account\": \"\",\n \"bank_code\": \"\",\n \"email\": \"example@novixpay.io\",\n \"phone\": \"\",\n \"full_name\": \"\",\n \"date_of_birth\": \"\",\n \"personal_code\": \"\",\n \"street_address\": \"test test\",\n \"country\": \"IN\",\n \"city\": \"123\",\n \"zip_code\": \"234567\",\n \"shipping_street_address\": \"\",\n \"shipping_country\": \"\",\n \"shipping_city\": \"\",\n \"shipping_zip_code\": \"\",\n \"cc\": [],\n \"bcc\": [],\n \"legal_name\": \"\",\n \"brand_name\": \"\",\n \"registration_number\": \"\",\n \"tax_number\": \"\",\n \"stateCode\": \"ca\"\n },\n \"updated_on\": 1690294251,\n \"type\": \"purchase\",\n \"force_recurring\": false,\n \"created_on\": 1690294220,\n \"purchase\": {\n \"currency\": \"USD\",\n \"products\": [\n {\n \"name\": \"dk\",\n \"quantity\": 1,\n \"price\": 100,\n \"discount\": 0,\n \"tax_percent\": \"0.00\"\n }\n ],\n \"total\": 100,\n \"language\": \"en\",\n \"notes\": \"\",\n \"debt\": 0,\n \"total_formatted\": 1,\n \"request_client_details\": [],\n \"timezone\": \"America/Edmonton\",\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 \"bank_account\": \"\",\n \"bank_code\": \"\"\n }\n ],\n \"legal_name\": \"shoes\",\n \"brand_name\": \"shoes\",\n \"registration_number\": \"\",\n \"tax_number\": \"\"\n },\n \"transaction_data\": {\n \"payment_method\": \"\",\n \"flow\": \"payform\",\n \"extra\": {\n \"expiry_month\": \"10\",\n \"amount\": 100,\n \"card_issuer\": \"1-800-432-3117\",\n \"masked_pan\": \"411111XXXXXX1111\",\n \"card_brand\": \"VISA\",\n \"card_issuer_country\": \"US\",\n \"cardholder_name\": \"dk\",\n \"expiry_year\": \"23\"\n },\n \"country\": \"\",\n \"attempts\": [\n {\n \"client_ip\": \"149.86.53.48\",\n \"type\": \"execute\",\n \"payment_method\": \"VISA\",\n \"flow\": \"payform\",\n \"successful\": false,\n \"country\": \"US\",\n \"processing_time\": 1690294279,\n \"extra\": {\n \"expiry_month\": \"10\",\n \"amount\": 100,\n \"card_issuer\": \"1-800-432-3117\",\n \"masked_pan\": \"411111XXXXXX1111\",\n \"card_brand\": \"VISA\",\n \"card_issuer_country\": \"US\",\n \"cardholder_name\": \"dk\",\n \"expiry_year\": \"23\"\n },\n \"error\": {\n \"message\": \"Transaction Failed\",\n \"code\": \"transaction_error\"\n }\n }\n ]\n },\n \"status\": \"ERROR\",\n \"status_history\": [\n {\n \"status\": \"created\",\n \"timestamp\": 1690294220\n },\n {\n \"status\": \"pending_execute\",\n \"timestamp\": 1690294251\n },\n {\n \"status\": \"error\",\n \"timestamp\": 1690294299\n },\n {\n \"status\": \"viewed\",\n \"timestamp\": 1690294382\n }\n ],\n \"viewedOn\": 1690299845,\n \"is_test\": false,\n \"brand_id\": \"bd69e8a5-adcf-40de-9e43-2b87cb129a5e\",\n \"send_receipt\": false,\n \"is_recurring_token\": false,\n \"skip_capture\": false,\n \"reference_generated\": \"PS188\",\n \"issued\": \"2023-07-25\",\n \"due\": 1690294220,\n \"refund_upto\": 0,\n \"cc_descriptor\": \"\",\n \"refund_availability\": \"NONE\",\n \"refundable_amount\": 0,\n \"success_redirect\": \"https://google.com\",\n \"failure_redirect\": \"https://yahoo.com\",\n \"cancel_redirect\": \"\",\n \"success_callback\": \"\",\n \"platform\": \"API\",\n \"created_from_ip\": \"149.86.53.48\",\n \"checkout_url\": \"http://app.novixpay.io/payments/64bfd7c9f63e36669499e779/\",\n \"direct_post_url\": \"http://app.novixpay.io/api/v1/p/64bfd7c9f63e36669499e779/\"\n}"},{"id":"619ca0c0-992d-4ecd-bd05-53455d17d172","name":"Purchases - success","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"url":"http://18.214.100.20/api/v1/purchases/64bfdb7df63e36669499e82f/"},"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":"Tue, 25 Jul 2023 15:45:29 GMT"},{"key":"Keep-Alive","value":"timeout=60"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\n \"purchaseId\": \"64bfdb7df63e36669499e82f\",\n \"client\": {\n \"bank_account\": \"\",\n \"bank_code\": \"\",\n \"email\": \"example@novixpay.io\",\n \"phone\": \"\",\n \"full_name\": \"\",\n \"date_of_birth\": \"\",\n \"personal_code\": \"\",\n \"street_address\": \"test test\",\n \"country\": \"IN\",\n \"city\": \"123\",\n \"zip_code\": \"234567\",\n \"shipping_street_address\": \"\",\n \"shipping_country\": \"\",\n \"shipping_city\": \"\",\n \"shipping_zip_code\": \"\",\n \"cc\": [],\n \"bcc\": [],\n \"legal_name\": \"\",\n \"brand_name\": \"\",\n \"registration_number\": \"\",\n \"tax_number\": \"\",\n \"stateCode\": \"ca\"\n },\n \"updated_on\": 1690296521,\n \"type\": \"purchase\",\n \"force_recurring\": false,\n \"created_on\": 1690295168,\n \"purchase\": {\n \"currency\": \"USD\",\n \"products\": [\n {\n \"name\": \"dk\",\n \"quantity\": 1,\n \"price\": 9,\n \"discount\": 0,\n \"tax_percent\": \"0.00\"\n }\n ],\n \"total\": 9,\n \"language\": \"en\",\n \"notes\": \"\",\n \"debt\": 0,\n \"total_formatted\": 1,\n \"request_client_details\": [],\n \"timezone\": \"America/Edmonton\",\n \"email_message\": \"\"\n },\n \"payment\": {\n \"is_outgoing\": false,\n \"payment_type\": \"PURCHASE\",\n \"amount\": 9,\n \"currency\": \"USD\",\n \"net_amount\": 9,\n \"fee_amount\": 10.2591,\n \"pending_amount\": 0,\n \"pending_unfreeze_on\": null,\n \"description\": \"\",\n \"paid_on\": 1690295205,\n \"remote_paid_on\": 1690295205\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 \"bank_account\": \"\",\n \"bank_code\": \"\"\n }\n ],\n \"legal_name\": \"shoes\",\n \"brand_name\": \"shoes\",\n \"registration_number\": \"\",\n \"tax_number\": \"\"\n },\n \"transaction_data\": {\n \"payment_method\": \"\",\n \"flow\": \"payform\",\n \"extra\": {\n \"expiry_month\": \"10\",\n \"amount\": 9,\n \"card_issuer\": \"1-800-432-3117\",\n \"masked_pan\": \"411111XXXXXX1111\",\n \"card_brand\": \"VISA\",\n \"card_issuer_country\": \"US\",\n \"cardholder_name\": \"dk\",\n \"expiry_year\": \"23\"\n },\n \"country\": \"\",\n \"attempts\": [\n {\n \"client_ip\": \"149.86.53.48\",\n \"type\": \"execute\",\n \"payment_method\": \"VISA\",\n \"flow\": \"payform\",\n \"successful\": true,\n \"country\": \"US\",\n \"processing_time\": 1690295205,\n \"extra\": {\n \"expiry_month\": \"10\",\n \"amount\": 9,\n \"card_issuer\": \"1-800-432-3117\",\n \"masked_pan\": \"411111XXXXXX1111\",\n \"card_brand\": \"VISA\",\n \"card_issuer_country\": \"US\",\n \"cardholder_name\": \"dk\",\n \"expiry_year\": \"23\"\n }\n }\n ]\n },\n \"status\": \"PAID\",\n \"status_history\": [\n {\n \"status\": \"created\",\n \"timestamp\": 1690295168\n },\n {\n \"status\": \"pending_execute\",\n \"timestamp\": 1690295193\n },\n {\n \"status\": \"payment_in_process\",\n \"timestamp\": 1690295205\n },\n {\n \"status\": \"paid\",\n \"timestamp\": 1690296521\n },\n {\n \"status\": \"viewed\",\n \"timestamp\": 1690299929\n }\n ],\n \"viewedOn\": 1690299929,\n \"is_test\": false,\n \"brand_id\": \"bd69e8a5-adcf-40de-9e43-2b87cb129a5e\",\n \"merchantRef\":\"d9db7ec0-f94c-4a9d-8883-54c19c222d81\",\n \"send_receipt\": false,\n \"is_recurring_token\": false,\n \"skip_capture\": false,\n \"reference_generated\": \"PS192\",\n \"issued\": \"2023-07-25\",\n \"due\": 1690295168,\n \"refund_upto\": 1705843623,\n \"cc_descriptor\": \"test-cardeye\",\n \"refund_availability\": \"NONE\",\n \"refundable_amount\": 9,\n \"success_redirect\": \"https://google.com\",\n \"failure_redirect\": \"https://yahoo.com\",\n \"cancel_redirect\": \"\",\n \"success_callback\": \"\",\n \"platform\": \"API\",\n \"created_from_ip\": \"149.86.53.48\",\n \"checkout_url\": \"http://app.novixpay.io/payments/64bfdb7df63e36669499e82f/\",\n \"direct_post_url\": \"http://app.novixpay.io/api/v1/p/64bfdb7df63e36669499e82f/\"\n}"}],"_postman_id":"363c0507-acdd-4c88-a6a1-de8d51fbabd9"},{"name":"Cancel","id":"e1083af0-a89f-4bbc-879b-590318a2a14d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"url":"app.novixpay.io/purchases/64bff556f63e36669499e9d3/cancel","description":"

As the name implies this API is used to cancel purchases that have been posted

either after creating a purchase or
\n
after doing the server-to-server call, but before redirecting the user to the callbackURL.
\n

Purchase ID is mandatory for this API.

Response Examples

In the response examples you can see instances of cancelling a purchase that has Paid and Error Status.

This API is used to initate refund of the purchases that have status as PAID can be initiated for refund

Once the refund has been initiated, the status of the purchase would become REFUND_IN_PROCESS and once the refund has been approved by the bank, the status woud become REFUNDED

Purchase ID is mandatory for this API.

Currently we don't support partial refunds.

Response Examples

In the response examples you can see instances of both successful and unsuccessful in refund of purchases.

\n","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"a787d836-5e11-40eb-8684-89a6067c21fb","id":"a787d836-5e11-40eb-8684-89a6067c21fb","name":"APIs","type":"folder"}},"urlObject":{"path":["purchases","657af976c3fceb7beb30eeb4","refund"],"host":["app","novixpay","io"],"query":[],"variable":[]}},"response":[{"id":"337a59d6-d339-4d4f-8740-a7a27a37a792","name":"Refund - Success","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer Token","type":"text"}],"url":"app.novixpay.io/purchases/657af976c3fceb7beb30eeb4/refund"},"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":"Tue, 25 Jul 2023 16:33:43 GMT"},{"key":"Keep-Alive","value":"timeout=60"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\n \"purchaseId\": \"64bfdb7df63e36669499e82f\",\n \"client\": {\n \"bank_account\": \"\",\n \"bank_code\": \"\",\n \"email\": \"example@novixpay.io\",\n \"phone\": \"\",\n \"full_name\": \"\",\n \"date_of_birth\": \"\",\n \"personal_code\": \"\",\n \"street_address\": \"test test\",\n \"country\": \"IN\",\n \"city\": \"123\",\n \"zip_code\": \"234567\",\n \"shipping_street_address\": \"\",\n \"shipping_country\": \"\",\n \"shipping_city\": \"\",\n \"shipping_zip_code\": \"\",\n \"cc\": [],\n \"bcc\": [],\n \"legal_name\": \"\",\n \"brand_name\": \"\",\n \"registration_number\": \"\",\n \"tax_number\": \"\",\n \"stateCode\": \"ca\"\n },\n \"updated_on\": 1690302819,\n \"type\": \"purchase\",\n \"force_recurring\": false,\n \"created_on\": 1690295168,\n \"purchase\": {\n \"currency\": \"USD\",\n \"products\": [\n {\n \"name\": \"dk\",\n \"quantity\": 1,\n \"price\": 9,\n \"discount\": 0,\n \"tax_percent\": \"0.00\"\n }\n ],\n \"total\": 9,\n \"language\": \"en\",\n \"notes\": \"\",\n \"debt\": 0,\n \"total_formatted\": 1,\n \"request_client_details\": [],\n \"timezone\": \"America/Edmonton\",\n \"email_message\": \"\"\n },\n \"payment\": {\n \"is_outgoing\": false,\n \"payment_type\": \"PURCHASE\",\n \"amount\": 9,\n \"currency\": \"USD\",\n \"net_amount\": 9,\n \"fee_amount\": 10.2591,\n \"pending_amount\": 0,\n \"pending_unfreeze_on\": null,\n \"description\": \"\",\n \"paid_on\": 1690295205,\n \"remote_paid_on\": 1690295205\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 \"bank_account\": \"\",\n \"bank_code\": \"\"\n }\n ],\n \"legal_name\": \"shoes\",\n \"brand_name\": \"shoes\",\n \"registration_number\": \"\",\n \"tax_number\": \"\"\n },\n \"transaction_data\": {\n \"payment_method\": \"\",\n \"flow\": \"payform\",\n \"extra\": {\n \"expiry_month\": \"10\",\n \"amount\": 9,\n \"card_issuer\": \"1-800-432-3117\",\n \"masked_pan\": \"411111XXXXXX1111\",\n \"card_brand\": \"VISA\",\n \"card_issuer_country\": \"US\",\n \"cardholder_name\": \"dk\",\n \"expiry_year\": \"23\"\n },\n \"country\": \"\",\n \"attempts\": [\n {\n \"client_ip\": \"149.86.53.48\",\n \"type\": \"execute\",\n \"payment_method\": \"VISA\",\n \"flow\": \"payform\",\n \"successful\": true,\n \"country\": \"US\",\n \"processing_time\": 1690295205,\n \"extra\": {\n \"expiry_month\": \"10\",\n \"amount\": 9,\n \"card_issuer\": \"1-800-432-3117\",\n \"masked_pan\": \"411111XXXXXX1111\",\n \"card_brand\": \"VISA\",\n \"card_issuer_country\": \"US\",\n \"cardholder_name\": \"dk\",\n \"expiry_year\": \"23\"\n }\n },\n {\n \"client_ip\": \"149.86.53.48\",\n \"type\": \"refund\",\n \"successful\": true,\n \"processing_time\": 1690302819,\n \"extra\": {\n \"amount\": 9\n }\n }\n ]\n },\n \"status\": \"REFUNDED\",\n \"status_history\": [\n {\n \"status\": \"created\",\n \"timestamp\": 1765294731\n },\n {\n \"status\": \"pending_execute\",\n \"timestamp\": 1765294744\n },\n {\n \"status\": \"payment_in_process\",\n \"timestamp\": 1765294754\n },\n {\n \"status\": \"paid\",\n \"timestamp\": 1765297331\n },\n {\n \"status\": \"refunded\",\n \"timestamp\": 1765624009\n }\n ],\n \"viewedOn\": 1690299929,\n \"is_test\": false,\n \"brand_id\": \"bd69e8a5-adcf-40de-9e43-2b87cb129a5e\",\n \"send_receipt\": false,\n \"is_recurring_token\": false,\n \"skip_capture\": false,\n \"reference_generated\": \"PS192\",\n \"issued\": \"2023-07-25\",\n \"due\": 1690295168,\n \"refund_upto\": 1705843623,\n \"cc_descriptor\": \"test-cardeye\",\n \"refund_availability\": \"NONE\",\n \"refundable_amount\": 0,\n \"success_redirect\": \"https://google.com\",\n \"failure_redirect\": \"https://yahoo.com\",\n \"cancel_redirect\": \"\",\n \"success_callback\": \"\",\n \"platform\": \"API\",\n \"created_from_ip\": \"149.86.53.48\",\n \"checkout_url\": \"http://app.novixpay.io/payments/64bfdb7df63e36669499e82f/\",\n \"direct_post_url\": \"http://app.novixpay.io/api/v1/p/64bfdb7df63e36669499e82f/\"\n}"},{"id":"969695b3-432a-41c3-84a6-6d0d9b4405b1","name":"Refund - Pending","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer Token","type":"text"}],"url":"app.novixpay.io/purchases/657af976c3fceb7beb30eeb4/refund"},"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":"Tue, 25 Jul 2023 16:33:43 GMT"},{"key":"Keep-Alive","value":"timeout=60"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\n \"purchaseId\": \"64bfdb7df63e36669499e82f\",\n \"client\": {\n \"bank_account\": \"\",\n \"bank_code\": \"\",\n \"email\": \"example@novixpay.io\",\n \"phone\": \"\",\n \"full_name\": \"\",\n \"date_of_birth\": \"\",\n \"personal_code\": \"\",\n \"street_address\": \"test test\",\n \"country\": \"IN\",\n \"city\": \"123\",\n \"zip_code\": \"234567\",\n \"shipping_street_address\": \"\",\n \"shipping_country\": \"\",\n \"shipping_city\": \"\",\n \"shipping_zip_code\": \"\",\n \"cc\": [],\n \"bcc\": [],\n \"legal_name\": \"\",\n \"brand_name\": \"\",\n \"registration_number\": \"\",\n \"tax_number\": \"\",\n \"stateCode\": \"ca\"\n },\n \"updated_on\": 1690302819,\n \"type\": \"purchase\",\n \"force_recurring\": false,\n \"created_on\": 1690295168,\n \"purchase\": {\n \"currency\": \"USD\",\n \"products\": [\n {\n \"name\": \"dk\",\n \"quantity\": 1,\n \"price\": 9,\n \"discount\": 0,\n \"tax_percent\": \"0.00\"\n }\n ],\n \"total\": 9,\n \"language\": \"en\",\n \"notes\": \"\",\n \"debt\": 0,\n \"total_formatted\": 1,\n \"request_client_details\": [],\n \"timezone\": \"America/Edmonton\",\n \"email_message\": \"\"\n },\n \"payment\": {\n \"is_outgoing\": false,\n \"payment_type\": \"PURCHASE\",\n \"amount\": 9,\n \"currency\": \"USD\",\n \"net_amount\": 9,\n \"fee_amount\": 10.2591,\n \"pending_amount\": 0,\n \"pending_unfreeze_on\": null,\n \"description\": \"\",\n \"paid_on\": 1690295205,\n \"remote_paid_on\": 1690295205\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 \"bank_account\": \"\",\n \"bank_code\": \"\"\n }\n ],\n \"legal_name\": \"shoes\",\n \"brand_name\": \"shoes\",\n \"registration_number\": \"\",\n \"tax_number\": \"\"\n },\n \"transaction_data\": {\n \"payment_method\": \"\",\n \"flow\": \"payform\",\n \"extra\": {\n \"expiry_month\": \"10\",\n \"amount\": 9,\n \"card_issuer\": \"1-800-432-3117\",\n \"masked_pan\": \"411111XXXXXX1111\",\n \"card_brand\": \"VISA\",\n \"card_issuer_country\": \"US\",\n \"cardholder_name\": \"dk\",\n \"expiry_year\": \"23\"\n },\n \"country\": \"\",\n \"attempts\": [\n {\n \"client_ip\": \"149.86.53.48\",\n \"type\": \"execute\",\n \"payment_method\": \"VISA\",\n \"flow\": \"payform\",\n \"successful\": true,\n \"country\": \"US\",\n \"processing_time\": 1690295205,\n \"extra\": {\n \"expiry_month\": \"10\",\n \"amount\": 9,\n \"card_issuer\": \"1-800-432-3117\",\n \"masked_pan\": \"411111XXXXXX1111\",\n \"card_brand\": \"VISA\",\n \"card_issuer_country\": \"US\",\n \"cardholder_name\": \"dk\",\n \"expiry_year\": \"23\"\n }\n },\n {\n \"client_ip\": \"149.86.53.48\",\n \"type\": \"refund\",\n \"successful\": true,\n \"processing_time\": 1690302819,\n \"extra\": {\n \"amount\": 9\n }\n }\n ]\n },\n \"status\": \"REFUND_IN_PROCESS\",\n \"status_history\": [\n {\n \"status\": \"created\",\n \"timestamp\": 1690295168\n },\n {\n \"status\": \"pending_execute\",\n \"timestamp\": 1690295193\n },\n {\n \"status\": \"payment_in_process\",\n \"timestamp\": 1690295205\n },\n {\n \"status\": \"paid\",\n \"timestamp\": 1690296521\n },\n {\n \"status\": \"viewed\",\n \"timestamp\": 1690299929\n },\n {\n \"status\": \"refund_in_process\",\n \"timestamp\": 1690302819\n }\n ],\n \"viewedOn\": 1690299929,\n \"is_test\": false,\n \"brand_id\": \"bd69e8a5-adcf-40de-9e43-2b87cb129a5e\",\n \"send_receipt\": false,\n \"is_recurring_token\": false,\n \"skip_capture\": false,\n \"reference_generated\": \"PS192\",\n \"issued\": \"2023-07-25\",\n \"due\": 1690295168,\n \"refund_upto\": 1705843623,\n \"cc_descriptor\": \"test-cardeye\",\n \"refund_availability\": \"NONE\",\n \"refundable_amount\": 0,\n \"success_redirect\": \"https://google.com\",\n \"failure_redirect\": \"https://yahoo.com\",\n \"cancel_redirect\": \"\",\n \"success_callback\": \"\",\n \"platform\": \"API\",\n \"created_from_ip\": \"149.86.53.48\",\n \"checkout_url\": \"http://app.novixpay.io/payments/64bfdb7df63e36669499e82f/\",\n \"direct_post_url\": \"http://app.novixpay.io/api/v1/p/64bfdb7df63e36669499e82f/\"\n}"},{"id":"7f8e0533-ae4d-45ae-b295-8fcf0276707b","name":"Refund - Error","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer Token","type":"text"}],"url":"app.novixpay.io/purchases/657af976c3fceb7beb30eeb4/refund"},"status":"Bad Request","code":400,"_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:49:58 GMT"},{"key":"Connection","value":"close"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Only Purchases with `status == (paid)` can be refunded.\",\n \"code\": \"transaction_error\"\n}"}],"_postman_id":"71fc2f2b-1618-4754-bccf-e4e945f3fe23"},{"name":"Payment Methods","id":"19633a6a-a899-4df7-92f5-4d7197a31b47","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer Token","type":"text"}],"url":"app.novixpay.io/payment_methods","description":"

This API gives back the list of Payment methods available for the merchant's account.

Overview

NovixPay supports the concept of whitelisted cards. The merchant can send NovixPay a list of cards that are to be whitelisted. Once whitelisted, only whitelisted cards are allowed to be transacted for that merchant.

The merchant can check the individual card status with this API by giving the email and card numbers of the customers.

Mandatory Parameters (in body)

\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameters
email
card_num

Other parameters:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameters
signup_date
deposit_date
number_of_deposits

Response Examples

In the response examples, you can observe both instances of verifying whether a card exists in a merchant's whitelist, one for an existing card and another for a non-existing card.

Overview

The merchant can upload a list of whitelist cards and email ids through this API. All cards successfully uploaded will be considered whitelisted and allowed for that merchant.

Mandatory parameters in the request body:

\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Notes
csvFile	Upload a CSV file

Please note:

CSV file should contain the following headers (both mandatory)
\n
1. card_number
  \n
2. email_id
  \n
\n
CSV file should not be empty
\n

public class FileUploader {\n    public static void uploadFile(String apiUrl, String filePath, String authorizationHeader) {\n        try {\n            File file = new File(filePath);\n            OkHttpClient client = new OkHttpClient();\n            RequestBody requestBody = new MultipartBody.Builder().setType(MultipartBody.FORM)\n                    .addFormDataPart(\"csvFile\", file.getName(), RequestBody.create(MediaType.parse(\"text/csv\"), file))\n                    .build();\n            Request request = new Request.Builder().url(apiUrl).post(requestBody)\n                    .addHeader(\"Authorization\", authorizationHeader).build();\n            Response response = client.newCall(request).execute();\n            if (response.code() == 202) {\n                System.out.println(\"File uploaded successfully!\");\n                System.out.println(\"Response: \" + response.body().string());\n            } else {\n                System.out.println(\"File upload failed.\");\n                System.out.println(\"Status: \" + response.code());\n                System.out.println(\"Error: \" + response.body().string());\n            }\n        } catch (IOException e) {\n            e.printStackTrace();\n        }\n    }\n    public static void main(String[] args) {\n        String apiUrl = \"https://{{base_url}}/api/v1/whitelist/upload\";\n        String filePath = \"whitelist.csv.file.path\";\n        String authorizationHeader = \"Bearer YOUR API KEY\";\n        uploadFile(apiUrl, filePath, authorizationHeader);\n    }\n}\n\n

\n","urlObject":{"protocol":"https","path":["api","v1","whitelist","upload",""],"host":["app","novixpay","io"],"query":[],"variable":[]}},"response":[{"id":"ceed2ef8-c4f4-47b8-bfad-a61fdb28948f","name":"Whitelist Upload success","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"multipart/form-data; boundary=","disabled":true}],"body":{"mode":"formdata","formdata":[{"key":"csvFile","type":"file","fileNotInWorkingDirectoryWarning":"This file isn't in your working directory. Teammates you share this request with won't be able to use this file. To make collaboration easier you can setup your working directory in Settings.","filesNotInWorkingDirectory":["/C:/Users/HP/Desktop/Important/upladingfile/merchantwhitlist.csv"],"src":[]}]},"url":"https://app.novixpay.io/api/v1/whitelist/upload/"},"status":"Accepted","code":202,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Fri, 14 Jun 2024 09:10:47 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":"Strict-Transport-Security","value":"max-age=31536000 ; includeSubDomains"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"Referrer-Policy","value":"no-referrer"},{"key":"CF-Cache-Status","value":"DYNAMIC"},{"key":"Report-To","value":"{\"endpoints\":[{\"url\":\"https:\\/\\/a.nel.cloudflare.com\\/report\\/v4?s=bIgUFhs3TU2505qZe4IpSLiaJtI2gsplNDvsVWdKl76AWQdcisezEHOW6t%2BxTCj%2Bxs%2B23gnSeMCWrqwG0CYQONFHXhXb9ZHNtIYMuHWzvjLhVEChIX%2BYpODoLqzs9OP4r5q%2F9ABSXBs%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":"893930730b8b0c3f-MRS"},{"key":"alt-svc","value":"h3=\":443\"; ma=86400"}],"cookie":[],"responseTime":null,"body":"{\n \"totalRecords\": 3,\n \"totalApproved\": 3,\n \"status\": \"success\"\n}"},{"id":"0364c2ca-2b02-4cb7-b992-a85b4e413184","name":"Whitelist Upload failure","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"multipart/form-data; boundary=","disabled":true}],"body":{"mode":"formdata","formdata":[{"key":"csvFile","type":"file","fileNotInWorkingDirectoryWarning":"This file isn't in your working directory. Teammates you share this request with won't be able to use this file. To make collaboration easier you can setup your working directory in Settings.","filesNotInWorkingDirectory":["/C:/Users/HP/Desktop/Important/upladingfile/merchantwhitlist.csv"],"src":[]}]},"url":"https://app.novixpay.io/api/v1/whitelist/upload/"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Fri, 14 Jun 2024 09:11:50 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":"Strict-Transport-Security","value":"max-age=31536000 ; includeSubDomains"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"Referrer-Policy","value":"no-referrer"},{"key":"CF-Cache-Status","value":"DYNAMIC"},{"key":"Report-To","value":"{\"endpoints\":[{\"url\":\"https:\\/\\/a.nel.cloudflare.com\\/report\\/v4?s=9tel4sXa6ymyhRDTyNC%2B%2Bg2Msz1MivhgHbawlLF7JvTAgfonvRaas8MQeMtVVK95cziZLoZUKaThXJOAAeZW6iZ6fqlK5flpZjGxKwInEyKzZJr9JLDSQbNt5Um%2BK4zdbMZfkHV2seg%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":"893931f998280c3f-MRS"},{"key":"alt-svc","value":"h3=\":443\"; ma=86400"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Authorization header missing\",\n \"code\": \"authentication_failed\",\n \"status\": \"fail\"\n}"}],"_postman_id":"89258783-2e07-40ac-9251-73c22db15fc8"},{"name":"PayOut","id":"2666a24d-9324-4b7e-a262-a8c3f5cac7b5","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\": \"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 \"cardDetails\": {\n \"destinationCardNumber\": \"5431240006334004\",\n \"destinationExpiryYear\": \"2030\",\n \"destinationExpiryMonth\": \"11\"\n }\n }\n}","options":{"raw":{"language":"json"}}},"url":"app.novixpay.io/payout/","description":"

Overview

The 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.

This feature is designed for high-velocity industries that require frictionless, real-time payouts, such as:

Gaming & Betting: Real-time withdrawal of player winnings.
\n
Marketplaces: Payouts to sellers or service providers.
\n
Corporate Disbursements: Instant insurance claims, rebates, or compensation payments.
\n
Merchant Settlements: Faster access to processed funds for sub-merchants.
\n

By utilizing the NovixPay /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.

Integration Steps

Enable OCT: Ensure \"Push to Card\" permissions are enabled for your merchant account in the NovixPay Merchant Portal.
\n
Collect Card Details: Use a secure method to collect the recipient's card number and expiry date or can you NovixPay's cashier to do that.
\n
Execute Payout: Call the /payout endpoint with the OCT-specific payout method.
\n
Handle Webhooks: Listen for the paid or failure events to update your internal records.
\n

Mandatory parameters in the request body:

Parameter	Required	Notes
client.email	Yes	The customer's email.
client.phone	Yes	The customer's phone number along with the country code. Example: +91 9634088651
client.city	Yes	The customer's city.
client.country	Yes	ISO-3166 Country Code. Must be upper case. Example “SG” (Alpha2)
client.stateCode	Optional	Example “AL”, “XZ”. Must be in upper case.
Client.street_address	Optional	The customer's address.
client.zip_code	Optional	The customer's ZIP or postal code. If country=US, zip format must be NNNNN or NNNNN-NNNN.
currency	Yes	ISO 4217 code for currency you want to send the transaction in. Please note, the currency has to be enabled by the account manager for your account.
amount	Yes	amount in decimal format. example 1: EUR 5 , should be sent as 5.00 example 2: USD 10 and 37 cents , should be sent as 10.37
payoutMethod	Optional	example: PAYOUT-CARDS
success_redirect	Yes	URL to send the user if the transactions is successful.
pending_redirect	Yes	URL to send the user if the transactions is in pending.
failure_redirect	Yes	URL to send the user if the transactions is unsuccessful.
Purpose	Optional	The purpose of doing a payout.
extraParam.cardDetails	Yes	The receiver's card details object.
extraParam.cardDetails.destinationCardNumber	Yes	The recipient's 16-digit card number.
extraParam.cardDetails.destinationExpiryYear	Yes	YYYY format (e.g., 2028).
extraParam.cardDetails.destinationExpiryMonth	Yes	MM format (e.g., 05).

Note:

If the merchant is not PCI DSS compliant then they will need to use our cashier and asking the user to enter the card details there. Check the cashier section for more details.

If the merchant is PCI DSS compliant then they can use the payout API and send the card details as shown above.

\n","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"a787d836-5e11-40eb-8684-89a6067c21fb","id":"a787d836-5e11-40eb-8684-89a6067c21fb","name":"APIs","type":"folder"}},"urlObject":{"path":["payout",""],"host":["app","novixpay","io"],"query":[],"variable":[]}},"response":[{"id":"069c978d-2209-4813-b2e0-168cf44ee82f","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 \"client\": {\r\n \"email\": \"rahul@gmail.com\",\r\n \"country\": \"GB\",\r\n \"city\": \"London\",\r\n \"stateCode\": \"QLD\",\r\n \"full_name\": \"Rahul Jain\",\r\n \"street_address\": \"10 New Burlington Street Apt. 214\",\r\n \"zip_code\": \"W1S 3BE\",\r\n \"phone\": \"+44 9876543210\",\r\n \"gender\": \"M\",\r\n \"date_of_birth\": \"1970-07-10\"\r\n },\r\n \"purpose\": \"Testing cards payout\",\r\n \"currency\": \"GBP\",\r\n \"merchantRef\": \"YOUR ORDER ID\", // optional\r\n \"payoutMethod\": \"PAYOUT-CARDS\",\r\n \"amount\": 100.0,\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 \"extraParam\": {\r\n \"cardDetails\": {\r\n \"destinationCardNumber\": \"5431240006334004\",\r\n \"destinationExpiryYear\": \"2030\",\r\n \"destinationExpiryMonth\": \"11\"\r\n }\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"app.novixpay.io/payout/"},"status":"Accepted","code":202,"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":"{\r\n \"payoutId\": \"6977137755e0628e3600c562\",\r\n \"client\": {\r\n \"email\": \"rahul@gmail.com\",\r\n \"country\": \"GB\",\r\n \"city\": \"London\",\r\n \"stateCode\": \"QLD\",\r\n \"full_name\": \"Rahul Jain\",\r\n \"street_address\": \"10 New Burlington Street Apt. 214\",\r\n \"zip_code\": \"W1S 3BE\",\r\n \"phone\": \"+44 9876543210\",\r\n \"gender\": \"M\",\r\n \"date_of_birth\": \"1970-07-10\"\r\n },\r\n \"updated_on\": 1769411447,\r\n \"extraParam\": {\r\n \"cardDetails\": {\r\n \"destinationCardNumber\": \"5431240006334004\",\r\n \"destinationExpiryYear\": \"2030\",\r\n \"destinationExpiryMonth\": \"11\"\r\n }\r\n \"payoutMethod\": \"PAYOUT-CARDS\",\r\n \"amountUnit\": \"MAJOR\",\r\n \"amount\": 100.0,\r\n \"errorMsg\": \"\",\r\n \"purpose\": \"Testing cards payout\",\r\n \"created_on\": 1769411447,\r\n \"merchantRef\": \"YOUR ORDER ID\",\r\n \"status\": \"PAID\",\r\n \"status_history\": [\r\n {\r\n \"status\": \"created\",\r\n \"timestamp\": 1769411447\r\n },\r\n {\r\n \"status\": \"payout_in_process\",\r\n \"timestamp\": 1769411447\r\n },\r\n {\r\n \"status\": \"paid\",\r\n \"timestamp\": 1769411447\r\n },\r\n\r\n ],\r\n \"currency\": \"GBP\",\r\n \"extraFee\": \"0\",\r\n \"paymentOn\": 0,\r\n \"checkout_url\": \"https://test4.paymentsclub.net/payout/092e59f94279a3742fa3715fe9a2112a/\",\r\n \"taxAmount\": 0.0,\r\n \"taxPercent\": 0.0,\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 \"redirectType\": \"POST\",\r\n \"sessionId\": \"\",\r\n \"surcharge\": 0.0,\r\n \"surchargeType\": \"\",\r\n \"trxMethod\": \"CARDS\",\r\n \"success_callback\": \"\",\r\n \"failure_callback\": \"\"\r\n}"},{"id":"c28764cb-5f8b-4b7d-81a7-6af0911a360d","name":"Error","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 \"client\": {\r\n \"email\": \"rahul@gmail.com\",\r\n \"country\": \"GB\",\r\n \"city\": \"London\",\r\n \"stateCode\": \"QLD\",\r\n \"full_name\": \"Rahul Jain\",\r\n \"street_address\": \"10 New Burlington Street Apt. 214\",\r\n \"zip_code\": \"W1S 3BE\",\r\n \"phone\": \"+44 9876543210\",\r\n \"gender\": \"M\",\r\n \"date_of_birth\": \"1970-07-10\"\r\n },\r\n \"purpose\": \"Testing cards payout\",\r\n \"currency\": \"GBP\",\r\n \"merchantRef\": \"YOUR ORDER ID\", // optional\r\n \"payoutMethod\": \"PAYOUT-CARDS\",\r\n \"amount\": 100.0,\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 \"extraParam\": {\r\n \"cardDetails\": {\r\n \"destinationCardNumber\": \"5431240006334004\",\r\n \"destinationExpiryYear\": \"2030\",\r\n \"destinationExpiryMonth\": \"11\"\r\n }\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"app.novixpay.io/payout/"},"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":"{\r\n \"payoutId\": \"6977137755e0628e3600c562\",\r\n \"client\": {\r\n \"email\": \"rahul@gmail.com\",\r\n \"country\": \"GB\",\r\n \"city\": \"London\",\r\n \"stateCode\": \"QLD\",\r\n \"full_name\": \"Rahul Jain\",\r\n \"street_address\": \"10 New Burlington Street Apt. 214\",\r\n \"zip_code\": \"W1S 3BE\",\r\n \"phone\": \"+44 9876543210\",\r\n \"gender\": \"M\",\r\n \"date_of_birth\": \"1970-07-10\"\r\n },\r\n \"updated_on\": 1769411447,\r\n \"extraParam\": {\r\n \"cardDetails\": {\r\n \"destinationCardNumber\": \"5431240006334004\",\r\n \"destinationExpiryYear\": \"2030\",\r\n \"destinationExpiryMonth\": \"11\"\r\n }\r\n \"payoutMethod\": \"PAYOUT-CARDS\",\r\n \"amountUnit\": \"MAJOR\",\r\n \"amount\": 100.0,\r\n \"errorMsg\": \"\",\r\n \"purpose\": \"Testing cards payout\",\r\n \"created_on\": 1769411447,\r\n \"merchantRef\": \"YOUR ORDER ID\",\r\n \"status\": \"error\",\r\n \"status_history\": [\r\n {\r\n \"status\": \"created\",\r\n \"timestamp\": 1769411447\r\n },\r\n {\r\n \"status\": \"error\",\r\n \"timestamp\": 1769411447\r\n },\r\n\r\n ],\r\n \"currency\": \"GBP\",\r\n \"extraFee\": \"0\",\r\n \"paymentOn\": 0,\r\n \"checkout_url\": \"https://test4.paymentsclub.net/payout/092e59f94279a3742fa3715fe9a2112a/\",\r\n \"taxAmount\": 0.0,\r\n \"taxPercent\": 0.0,\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 \"redirectType\": \"POST\",\r\n \"sessionId\": \"\",\r\n \"surcharge\": 0.0,\r\n \"surchargeType\": \"\",\r\n \"trxMethod\": \"BANKTRANSFER\",\r\n \"success_callback\": \"\",\r\n \"failure_callback\": \"\"\r\n}"}],"_postman_id":"2666a24d-9324-4b7e-a262-a8c3f5cac7b5"}],"id":"a787d836-5e11-40eb-8684-89a6067c21fb","auth":{"type":"noauth","isInherited":false},"event":[{"listen":"prerequest","script":{"type":"text/javascript","packages":{},"requests":{},"exec":[""],"id":"c16338d7-3c1f-481c-a0e3-0887e9b71484"}},{"listen":"test","script":{"type":"text/javascript","packages":{},"requests":{},"exec":[""],"id":"ee6b136c-4e88-422c-9089-344a2ca4710c"}}],"_postman_id":"a787d836-5e11-40eb-8684-89a6067c21fb","description":""}],"id":"b775a538-01fd-46b8-be7c-620496ab9f21","auth":{"type":"noauth","isInherited":false},"event":[{"listen":"prerequest","script":{"type":"text/javascript","packages":{},"exec":[""],"id":"29bbb8fd-941b-4789-a485-c3045a2c9e3b"}},{"listen":"test","script":{"type":"text/javascript","packages":{},"exec":[""],"id":"94fde5a6-5b3c-42f7-804d-80539138a587"}}],"_postman_id":"b775a538-01fd-46b8-be7c-620496ab9f21","description":""}],"id":"551c84ff-b95f-40b0-a642-ec9242436ec1","_postman_id":"551c84ff-b95f-40b0-a642-ec9242436ec1","description":""},{"name":"Trust Score","item":[{"name":"TrustScore Detailed","id":"9185620c-c980-44df-8ac0-b6d53b80046b","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":"app.novixpay.io/trustScore","description":"

Overview

NovixPay 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.

Our 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.

Also, 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.

Trust Score & Usage

TrustScore 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.

On 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.

Detailed TrustScore

Trust 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.

Every 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.

Permission

Access to this API has to be given to you by the admin. So please contact your sales representative at NovixPay to get access to this API, if you get a 401 error of \"You are not allowed to call this API service\".

Mandatory Parameters (in body)

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameters	Description
ip	IP of the user. Both IP4 and IP6 are valid
email	The email id of the user you want to trust score on
url	The URL on which the user is trying to purchase or consume a product, service or data.

Other optional paramters:

The optional parameters are self-explanatory and appropriate values can be given in string format.

Parameters	Values
last_bets	String
last_wins	String
total_bonuses	String
last_real_bets	String
last_real_wins	String
total_deposits	String
last_bonus_bets	String
last_bonus_wins	String
average_real_bet	String
last_bets_amount	String
last_wins_amount	String
average_bonus_bet	String
bonus_to_deposits	String
last_deposit_date	String
total_withdrawals	String
is_phone_confirmed	String
money_in_money_out	String
last_deposit_amount	String
last_freespins_date	String
last_freespins_name	String
last_free_bonus_date	String
last_free_bonus_name	String
total_bonuses_amount	String
last_freespins_amount	String
last_freespins_status	String
last_real_bets_amount	String
last_real_wins_amount	String
total_deposits_amount	String
last_bonus_bets_amount	String
last_bonus_wins_amount	String
last_free_bonus_amount	String
last_free_bonus_status	String
last_deposit_bonus_date	String
last_deposit_bonus_name	String
last_freespins_currency	String
last_freespins_wagering	String
withdrawals_to_deposits	String
last_free_bonus_currency	String
last_free_bonus_wagering	String
total_withdrawals_amount	String
withdrawal_ewallet_email	String
last_deposit_bonus_amount	String
last_deposit_bonus_status	String
last_deposit_bonus_currency	String
last_deposit_bonus_wagering	String
session	String
payment_mode	String
card_fullname	String
card_bin	String
card_hash	String
card_last	String
card_expire	String
avs_result	String
cvv_result	String
sca_method	String
user_bank_account	String
user_bank_name	String
user_balance	String
user_verification_level	String
status_3d	String
regulation	String
payment_provider	String
phone_number	String
transaction_type	String
transaction_amount	String
transaction_currency	String
merchant_id	String
details_url	String
name	String
person_type	String
gender	String

Response

In the response examples, you can observe both instances of a successful TrustScore response and an unsuccessful one.

Please 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.

in a successful trust score call the following data would be provided:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Response Item	Description	Possible Values
trustScore	The trust score attributed to the user by our algorithms	Integer 0 to 5
deliverable	Whether the email is deliverable, usually false means it wouldn't be a trustable user.	Boolean
proxy	Is this IP address suspected to be a proxy? (SOCKS, Elite, Anonymous, VPN, Tor, etc.)	Boolean
vpn	Is this IP suspected of being a VPN connection? This can include data center ranges which can become active VPNs at any time. The \"proxy\" status will always be true when this value is true.	Boolean
tor	Is this IP suspected of being a TOR connection? This can include previously active TOR nodes and exits which can become active TOR exits at any time. The \"proxy\" status will always be true when this value is true.	Boolean
active_vpn	Identifies active VPN connections used by popular VPN services and private VPN servers.	Boolean
active_tor	Identifies active TOR exits on the TOR network.	Boolean
recent_abuse	This value indicates whether the IP address has been associated with any recently verified abuse on our network, such as a confirmed chargeback, compromised device, or fake app install.	Boolean
bot_status	Shows whether bots or non-human traffic recently used this IP address to engage in automated fraud. This provides strong evidence that the IP address is suspicious.	Boolean

Errors

If there are any errors then it'll be in the format of :

{\n    \"message\": \"descriptive error message\",\n    \"code\": \"error_code\"\n}\n\n

Possible Error Messages

the possible error codes one can get on calling this APIs are:

\n\n\n\n\n\n\n\n\n\n\n

Code
400, 404, 401, 415, 405

for example:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Code	Error Messages
401	Incorrect secret_key
401	You are not Allowed to call this API service

","urlObject":{"path":["trustScore"],"host":["app","novixpay","io"],"query":[],"variable":[]}},"response":[{"id":"c11509fd-3e18-42f1-b29f-1588d8d0ab40","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":"https://app.novixpay.io/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":"1b878025-7d41-4486-bd77-180fd160d10d","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":"https://app.novixpay.io/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":"9185620c-c980-44df-8ac0-b6d53b80046b"},{"name":"checkTransactionAllowed","id":"cb613d25-dd7a-4a65-b091-ce5c3b7d0136","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":"app.novixpay.io/checkTransAllowed","description":"

General TrustScore

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.

Permission

Mandatory Parameters (in body)

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameters	Description
ip	IP of the user. Both IP4 and IP6 are valid
email	The email id of the user you want to trust score on
url	The URL on which the user is trying to purchase or consume a product, service or data.

Other optional paramters:

The optional parameters are self-explanatory and appropriate values can be given in string format.

Parameters	Values
last_bets	String
last_wins	String
total_bonuses	String
last_real_bets	String
last_real_wins	String
total_deposits	String
last_bonus_bets	String
last_bonus_wins	String
average_real_bet	String
last_bets_amount	String
last_wins_amount	String
average_bonus_bet	String
bonus_to_deposits	String
last_deposit_date	String
total_withdrawals	String
is_phone_confirmed	String
money_in_money_out	String
last_deposit_amount	String
last_freespins_date	String
last_freespins_name	String
last_free_bonus_date	String
last_free_bonus_name	String
total_bonuses_amount	String
last_freespins_amount	String
last_freespins_status	String
last_real_bets_amount	String
last_real_wins_amount	String
total_deposits_amount	String
last_bonus_bets_amount	String
last_bonus_wins_amount	String
last_free_bonus_amount	String
last_free_bonus_status	String
last_deposit_bonus_date	String
last_deposit_bonus_name	String
last_freespins_currency	String
last_freespins_wagering	String
withdrawals_to_deposits	String
last_free_bonus_currency	String
last_free_bonus_wagering	String
total_withdrawals_amount	String
withdrawal_ewallet_email	String
last_deposit_bonus_amount	String
last_deposit_bonus_status	String
last_deposit_bonus_currency	String
last_deposit_bonus_wagering	String
session	String
payment_mode	String
card_fullname	String
card_bin	String
card_hash	String
card_last	String
card_expire	String
avs_result	String
cvv_result	String
sca_method	String
user_bank_account	String
user_bank_name	String
user_balance	String
user_verification_level	String
status_3d	String
regulation	String
payment_provider	String
phone_number	String
transaction_type	String
transaction_amount	String
transaction_currency	String
merchant_id	String
details_url	String
name	String
person_type	String
gender	String

Response

Response contains a single parameter: transactionAllowed which can either be YES or NO .

{\n\"transactionAllowed\" : \"YES\"\n}\n\n

If there are any errors then it'll be in the format of :

{\n    \"message\": \"descriptive error message\",\n    \"code\": \"error_code\"\n}\n\n

Possible Error Messages

the possible error codes one can get on calling this APIs are:

\n\n\n\n\n\n\n\n\n\n\n

Code
400, 404, 401, 415, 405

for example:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Code	Error Messages
401	Incorrect secret_key
401	You are not Allowed to call this API service

","urlObject":{"path":["checkTransAllowed"],"host":["app","novixpay","io"],"query":[],"variable":[]}},"response":[{"id":"c9b5c316-ef71-46a9-8f1b-498531598634","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":"https://app.novixpay.io/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":"64134a3a-df9c-4e09-b232-a1c19c57771f","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":"https://app.novixpay.io/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":"cb613d25-dd7a-4a65-b091-ce5c3b7d0136"}],"id":"80ee358c-d8ed-4418-8cca-0770f4546de1","_postman_id":"80ee358c-d8ed-4418-8cca-0770f4546de1","description":""},{"name":"Cashier APIs","item":[{"name":"Customer","id":"bb3fecc4-914f-4036-9af2-e3263cae2ef1","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@novixpay.io\",\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@novixpay.io\",\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://app.novixpay.io/api/v1/customer","description":"

OVERIEW

The createCustomer API allows merchants to create a customer profile on NovixPay when a user visits their website, facilitating a seamless payment experience by pre-filling the customer's details, on the NovixPay 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.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description	Example
merchantCustomerId	String	Yes	unique customer ID provided by merchant. This can be email, mobile or an alphanumeric string	rahultestcustomer@novixpay.io
fullName	String	Yes	Full name of the customer.	Rahul Agarwal
emailId	String	Yes	Email address of the customer.	test@novixpay.io
dateOfBirth	String	Optional	Customer's date of birth in YYYY-MM-DD format.	1995-12-27
phoneNo	String	Yes	Customer's phone number. Preferred with the country code	+91 797639082
city	String	Optional	City of the customer.	Jaipur
stateCode	String	Yes	State code of the customer.	RJ
zipCode	String	Optional	Postal code of the customer's location.	302018
address	String	Optional	Full address of the customer.	House Number 53, Vaishali Nagar, Jaipur
country	String	Yes	Country code (ISO 3166-1 alpha-2).	IN
custRegDate	Sting	Optional	Customer registration date on merchant site in YYYY-MM-DD format.	2023-12-27
successTxn	String	Optional	Number of successful transactions customer has carried on merchant site.	32

User Flow

Customer visits merchant's website: The customer selects the product or service and proceeds to checkout page.
\n
Merchant calls the createCustomer API: The merchant sends a POST request to the NovixPay API with the customer's details.
\n
Customer ID generation: NovixPay processes the request and generates a unique customerId which is returned in the response.
\n
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.
\n

Benefits

Seamless user experience: The customer does not have to enter their details manually for every purchase.
\n
Faster Checkout: The merchant can use the customerId for faster payment processing.
\n
Data Security: Customer details are stored securely and can be reused across transactions, reducing the chances of errors.
\n

Implementing createCustomer on merchant site:

The createCustomer can be implemented on merchant site in one of two ways, depending on merchant’s integration flow:

At Checkout:

When 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.
\n
Use of Customer ID: Pass the returned customer ID in Session API, when creating a payment session.
\n

Upon Customer Login:

Alternatively, 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.
\n
Integration Flexibility: This is useful for merchants who want to initialize customer data early in the customer journey rather than during checkout.
\n

The 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 NovixPay API.

Request

The 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.

Response

The response of this request can be documented as a JSON schema.

Customer ID	First Name	Last Name	Email	Phone
{{response.customerId}}	{{response.firstName}}	{{response.lastName}}	{{response.email}}	{{response.phone}}

","`;","","function constructVisualizerPayload() {"," return {response: pm.response.json()}","}","","pm.visualizer.set(template, constructVisualizerPayload());"],"type":"text/javascript","packages":{},"requests":{},"id":"c4662d4f-8a7c-439f-bbf8-e479628e60a1"}}],"id":"4c6cdc0d-1351-448e-a1e0-019f95f9f401","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"PATCH","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":"{\n \"fullName\": \"Gouri Shankar3\",\n \"emailId\": \"gouri@novixpay.io\",\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}","options":{"raw":{"language":"json"}}},"url":"https://app.novixpay.io/api/v1/{NovixPayCustomerId}/patchCustomer","description":"

Whenever a customer or the merchant updates customer details on the merchant site, a PATCH request must be made to synchronize these changes with NovixPay.

This API endpoint allows you to update the customer details using an HTTP PATCH request. The request should be sent to https://app.novixpay.io/api/v1/{customerId}/patchCustomer.

Request Body

The request body should be in raw format and include the following parameters:

fullName (string): The full name of the customer.
\n
emailId (string): The email address of the customer.
\n
dateOfBirth (string): The date of birth of the customer.
\n
phoneNo (string): The phone number of the customer.
\n
city (string): The city of the customer.
\n
stateCode (string): The state code of the customer.
\n
zipCode (string): The zip code of the customer.
\n
address (string): The address of the customer.
\n
country (string): The country of the customer.
\n
createdOn (string): Time when the customer was created.
\n
custRegDate (string): Customer registration date (Non-Mandatory).
\n
successTxn (string): Success transaction details (Non-Mandatory).
\n
lastActivity (string): Time of the last activity.
\n
lastUpdated (string): Time when the last patch was called.
\n
extraParam (object): Additional parameters including param1, param2, param3, param4 with their respective values.
\n

Response

The response will contain the updated customer details or a success message upon successful update.

\n","urlObject":{"protocol":"https","path":["api","v1","{NovixPayCustomerId}","patchCustomer"],"host":["app","novixpay","io"],"query":[],"variable":[]}},"response":[{"id":"9f2d9cd6-1331-46bf-902c-9865522a7272","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@novixpay.io\",\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://app.novixpay.io/api/v1/{NovixPayCustomerId}/patchCustomer"},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":"{\n \"customerId\": \"691afbc6fd96d34a8113a34d\",\n \"merchantCustomerId\": \"rahultestcustomer1@novixpay.io\",\n \"fullName\": \"Gouri Shankar3\",\n \"emailId\": \"gouri@novixpay.io\",\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":"4c6cdc0d-1351-448e-a1e0-019f95f9f401"},{"name":"Purchase Session","id":"88644605-b93d-4ecf-ba16-7bb1c1533d5c","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@novixpay.io\", // 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://app.novixpay.io/api/v1/createSession","description":"

OVERIEW

The 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.

Mandatory Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Description	Example
customerId	String	The unique ID of the customer (generated from createCustomer).	6731a609b6bb5a43ad66c4a6

Show Crypto Conversion

Additionally, there are some default extra parameters that you can pass for allowing Crypto Conversion on NovixPay's cashier itself.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

	Type	Description	Example
extraParam.showCryptoConversion	String	This optional parameter allows customer to see crypto value equivelant to the Fiat amount the customer is planning to pay.	Yes
extraParam.cryptoCurrencies	String	Pass here the allowed crypto tokens on the cashier, where customer can see the the conversion value	[\\\"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\\\"]

Usage Flow

Customer 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.
\n
Merchant sends createSession request: The merchant sends a POST request to the createSession API with the customer’s customerId and the merchant’s brandId.
\n
Session created automatically on the checkout URL: NovixPay 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.
\n
Customer 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.
\n
Session 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.
\n

Benefits

Seamless Checkout: The session URL is automatically generated and active at the backend, ensuring a smoother and uninterrupted customer experience.
\n
Reduced Transaction Failures: By ensuring the session remains active during the payment process, the chances of transaction failures due to session timeouts are minimized.
\n
Improved 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.
\n

\n","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"0749a26a-5709-49b6-bf75-81a5ff4e2e0c","id":"0749a26a-5709-49b6-bf75-81a5ff4e2e0c","name":"Cashier APIs","type":"folder"}},"urlObject":{"protocol":"https","path":["api","v1","createSession"],"host":["app","novixpay","io"],"query":[],"variable":[]}},"response":[{"id":"654304db-fd29-40c1-abb2-bb12e716c41c","name":"Success","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"*/*","type":"text"},{"key":"BrandId","value":"brand_id_value","description":"it is mandatory to pass the BrandId in header for each createSession request. ","type":"text"},{"key":"Authorization","value":"Bearer Token","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"customerId\": \"68fed1855ebbe829416b08c6\",\r\n \"merchantRef\": \"rahultestcustomer1@novixpay.io\", // 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 \"param3\": \"value3\",\r\n \"param4\": \"value4\"\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"https://app.novixpay.io/api/v1/createSession"},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":"{\r\n \"sessionUrl\": \"https://app.novixpay.io/payment-session/691b02b48c73dd76eedaa379/\",\r\n \"brandId\": \"brand_id_value\",\r\n \"customerId\": \"68fed1855ebbe829416b08c6\",\r\n \"sessionId\": \"691b02b48c73dd76eedaa379\",\r\n \"expiryOn\": 1763378744,\r\n \"createdOn\": 1763377844\r\n}"},{"id":"ee9e9d81-1b22-44b5-af0a-e296a92b1838","name":"Session with CryptoConversion","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"*/*","type":"text"},{"key":"BrandId","value":"brand_id_value","description":"it is mandatory to pass the BrandId in header for each createSession request. ","type":"text"},{"key":"Authorization","value":"Bearer Token","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"customerId\": \"68fed1855ebbe829416b08c6\",\r\n \"merchantRef\": \"rahultestcustomer1@novixpay.io\", // 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://app.novixpay.io/api/v1/createSession"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"sessionUrl\": \"https://app.novixpay.io/payment-session/691b02b48c73dd76eedaa379/\",\n \"brandId\": \"brand_id_value\",\n \"customerId\": \"68fed1855ebbe829416b08c6\",\n \"sessionId\": \"691b02b48c73dd76eedaa379\",\n \"expiryOn\": 1763378744,\n \"createdOn\": 1763377844\n}"},{"id":"e1fc763f-ad65-446a-969a-487a9b28184f","name":"Invalid Session","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"*/*","type":"text"},{"key":"BrandId","value":"brand_id_value","description":"it is mandatory to pass the BrandId in header for each createSession request. ","type":"text"},{"key":"Authorization","value":"Bearer Token","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"customerId\": \"68fed1855ebbe829416b08c6\",\r\n \"merchantRef\": \"rahultestcustomer1@novixpay.io\", // 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 \"param3\": \"value3\",\r\n \"param4\": \"value4\"\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"https://app.novixpay.io/api/v1/createSession"},"status":"Bad Request","code":400,"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":"{\r\n \"message\": \"Customer does not exist with this Customer Id\",\r\n \"code\": \"Customer Id is invalid\"\r\n}"}],"_postman_id":"88644605-b93d-4ecf-ba16-7bb1c1533d5c"},{"name":"Payout Session","id":"00671bce-1e8d-4b48-ac58-6cb0fae2111c","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"},{"key":"Accept","value":"*/*","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"customerId\": \"67c9983fba18400ab6cceb8f\",\r\n \"currency\": \"USD\",\r\n \"products\": [\r\n {\r\n \"name\": \"Product1\",\r\n \"price\": \"2\"\r\n }\r\n ],\r\n \"totalAmount\": \"2\",\r\n \"tax_amount\": \"\", // optional\r\n \"tax_percent\": \"\", // optional\r\n \"type\": \"payout\",\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 \"extraParam\": {\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 }\r\n}","options":{"raw":{"language":"json"}}},"url":"https://app.novixpay.io/api/v1/createSession","description":"

This 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.

Parameters:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Description
customerId	string	The unique ID of the customer for whom the payout session is created. This ID is generated by the `createCustomer` API.
currency	string	The currency of the payout session (e.g., USD).
products	array	A list of products associated with the payout (e.g., name and price).
totalAmount	string	The total payout amount (optional. calculated dynamically if value is not passed).
tax_amount	string	The tax amount to be applied (optional).
tax_percent	string	The tax percentage to be applied (optional).
type	string	Should be set to \"payout\" to initiate a payout session.
success_redirect	string	The URL where the customer will be redirected after a successful payout.
pending_redirect	string	The URL where the customer will be redirected after a pending payout.
failure_redirect	string	The URL where the customer will be redirected after a failed payout attempt.
success_callback	string	The callback URL for successful payout.
failure_callback	string	The callback URL for failed payout.
extraParam	object	Contains additional parameters for the payout session.
extraParam.showCryptoConversion	string	Set to \"yes\" to display cryptocurrency conversion.
extraParam.cryptoCurrencies	string	A list of accepted cryptocurrencies (e.g., BTC, ETH, USDT).

Request Headers:

BrandId: Your unique brand ID (required).
\n
Content-Type: application/json (required).
\n

Response:

The 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.novixpay.io/payoutSession/68341ad35f895955355d5452/\",\n    \"brandId\": \"brand_id_value\",\n    \"customerId\": \"67c9983fba18400ab6cceb8f\",\n    \"sessionId\": \"68341ad35f895955355d5452\",\n    \"expiryOn\": 1748246103,\n    \"createdOn\": 1748245203\n}\n\n

This endpoint retrieves the details of a session identified by the provided session ID.

\n
Note that this API only respond once the SessionURL, received in the response for session API, is clicked.
\n

\n
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

\n","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"0749a26a-5709-49b6-bf75-81a5ff4e2e0c","id":"0749a26a-5709-49b6-bf75-81a5ff4e2e0c","name":"Cashier APIs","type":"folder"}},"urlObject":{"protocol":"https","path":["api","v1","purchases","{Session ID}",""],"host":["app","novixpay","io"],"query":[],"variable":[]}},"response":[{"id":"c1f38d1f-2c16-46e2-97ce-be5f2904fb62","name":"202 Success","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer Token"}],"url":"https://app.novixpay.io/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@novixpay.io\",\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.choicepay.ca/payments/adb6e07f74ec6197ef764909736d478e/\",\n \"direct_post_url\": \"https://api.choicepay.ca/api/v1/p/6950e4e3e4a1b008c2fae5c3/\",\n \"payoutProcess\": false\n}"},{"id":"8ac0a60b-ff9c-4253-935a-0f411e72d7a2","name":"400 Bad Request","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer Token"}],"url":"https://app.novixpay.io/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":"c1a8893a-6b1a-46c1-9832-505ee6da8bb5","name":"401 Unauthorized","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer Token"}],"url":"https://app.novixpay.io/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":"bb1a6554-79ca-4986-acbc-b9caff552315"}],"id":"0749a26a-5709-49b6-bf75-81a5ff4e2e0c","description":"

NovixPay 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.

To 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.

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.

Once 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.

Adding a User Defined Field

Click Add Parameters.
\n
Enter the Parameter Name.
\n
Choose the Value Type (Numeric, String, or Boolean).
\n
Click Add to save.
\n

Here is how you can define UDFs in NovixPay's app.

\n\n

Using UDF in API Requests

Once 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\n

Best Practices

Use consistent naming conventions for parameters to avoid confusion across integrations.
\n
Keep the number of UDFs minimal — only add fields that provide clear value (e.g., customer segment, order type, risk score).
\n
Leverage UDFs in rule-based routing to optimize processing flows (e.g., route high-value transactions to a specific MID).
\n
Document your UDFs internally so operations and support teams can easily reference them.
\n

Note:
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.

For cases where the Merchant handles the scheduling:

\n\n \n

For cases where NovixPay handles the scheduling:

","auth":{"type":"noauth","isInherited":false},"event":[{"listen":"prerequest","script":{"type":"text/javascript","packages":{},"requests":{},"exec":[""],"id":"33345aea-4d75-4150-b562-aa544579888d"}},{"listen":"test","script":{"type":"text/javascript","packages":{},"requests":{},"exec":[""],"id":"4cc7c11b-0b2d-465b-83fe-319e291e042a"}}],"_postman_id":"e44dabcd-64cd-4982-ad5d-c62b469ddc5b"},{"name":"APIs","item":[{"name":"Create Customer","id":"7f037f76-c779-48ad-b219-dfe2563ecadc","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":"{\n \"fullName\": \"Rahul Agarwal\",\n \"emailId\": \"rahul+26@novixpay.io\",\n \"dateOfBirth\": \"1994-06-03\",\n \"phoneNo\": \"+91 797639082\",\n \"city\": \"Jaipur\",\n \"stateCode\": \"RJ\",\n \"zipCode\": \"302018\",\n \"address\": \"House Number 53, Vaishali Nagar, Jaipur\",\n \"country\": \"IN\",\n \"merchantCustomerId\": \"rahultestcustomer@novixpay.io\",\n \"CustRegDate\": \"2023-12-27\", //non-mandatory - customer registration date on merchant site\n \"SuccessTxn\": \"32\", //non-mandatory - total successful customer orders on merchant site\n \"extraParam\": {\n \"param1\": \"value1\",\n \"param2\": \"value2\",\n \"param3\": \"value3\",\n \"param4\": \"value4\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"app.novixpay.io/api/v1/customer","description":"

OVERIEW

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.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description	Example
merchantCustomerId	String	Yes	unique customer ID provided by merchant. This can be email, mobile or an alphanumeric string	rahultestcustomer@novixpay.io
fullName	String	Yes	Full name of the customer.	Rahul Agarwal
emailId	String	Yes	Email address of the customer.	test@novixpay.io
dateOfBirth	String	Optional	Customer's date of birth in YYYY-MM-DD format.	1995-12-27
phoneNo	String	Yes	Customer's phone number. Preferred with the country code	+91 797639082
city	String	Optional	City of the customer.	Jaipur
stateCode	String	Yes	State code of the customer.	RJ
zipCode	String	Optional	Postal code of the customer's location.	302018
address	String	Optional	Full address of the customer.	House Number 53, Vaishali Nagar, Jaipur
country	String	Yes	Country code (ISO 3166-1 alpha-2).	IN
custRegDate	Sting	Optional	Customer registration date on merchant site in YYYY-MM-DD format.	2023-12-27
successTxn	String	Optional	Number of successful transactions customer has carried on merchant site.	32

User Flow

Customer visits merchant's website: The customer selects the product or service and proceeds to checkout page.
\n
Merchant calls the createCustomer API: The merchant sends a POST request to the NovixPay API with the customer's details.
\n
Customer ID generation: NovixPay processes the request and generates a unique customerId which is returned in the response.
\n
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.
\n

Benefits

Seamless user experience: The customer does not have to enter their details manually for every purchase.
\n
Faster Checkout: The merchant can use the customerId for faster payment processing.
\n
Data Security: Customer details are stored securely and can be reused across transactions, reducing the chances of errors.
\n

Implementing createCustomer on merchant site:

The createCustomer can be implemented on merchant site in one of two ways, depending on merchant’s integration flow:

At Checkout:

When 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.
\n
Use of Customer ID: Pass the returned customer ID in Session API, when creating a payment session.
\n

Upon Customer Login:

Alternatively, 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.
\n
Integration Flexibility: This is useful for merchants who want to initialize customer data early in the customer journey rather than during checkout.
\n

This endpoint makes an HTTP GET request to retrieve customer information from the NovixPay API.

Request

The 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.

Response

The response of this request can be documented as a JSON schema.

OVERIEW

This API improves the user experience by reducing transaction failures and enhancing the overall payment process, thus reducing transaction churn rates.

Mandatory Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Description	Example
customerId	String	The unique ID of the customer (generated from createCustomer).	6731a609b6bb5a43ad66c4a6

To register a mandate, pass mandate related parameters in the Create Session API to create a mandate registration purchase. Post transaction completion, use Get Status API and Webhooks to capture mandate registration details.

Additional parameters for this usecase:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Notes
payment_type	Mandatory. To be passed as \"mandate\".
mandate	Mandatory. This object is mandatory for mandate flow
mandate.mandate_max_amount	Optional Maximum amount for a mandate.
mandate.amount_variability	Optional Specifies whether the amount is fixed or variable for each recurrence. Possible values: Fixed or Variable
mandate.start_date	Mandatory Specifies the time when the mandate will start.
mandate.end_date	Mandatory Specifies the time when the mandate will end.
mandate.frequency	Mandatory Defines the frequency of mandate execution, how often a customer should be charged. Possible Values: ONETIME: This is for a one-time mandate. The customer provides authorisation to debit their account a single time for a specific amount. DAILY: Recurring mandate. The customer provides authorisation to debit their account daily for a specific amount. WEEKLY: Recurring mandate. Authorisation given by a customer to debit their account weekly once for a specified amount. FORTNIGHTLY: Recurring mandate. The customer provides authorisation to debit their account fortnightly for a specific amount. MONTHLY: Recurring mandate. The customer provides authorisation to debit their account monthly for a specific amount. BIMONTHLY: Recurring mandate. The customer provides authorisation to debit their account bimonthly for a specific amount. QUARTERLY: Recurring mandate. The customer provides authorisation to debit their account quarterly for a specific amount. HALFYEARLY: Recurring mandate. The customer provides authorisation to debit their account once in every 6 months for a specific amount. YEARLY: Recurring mandate. The customer provides authorisation to debit their account once a year for a specific amount. ASPRESENTED: For cases where the scheduling is handled by the merchant. The customer provides authorization to debit their account whenever there is an execution request.
mandate.rule	Optional. Indicates the recurrence rule of the mandate. This rule is not required for onetime, daily, and aspresented recurrence patterns. Possible values: on/before/after By Default: on
mandate.value	Conditional. The recurrence Value of the mandate. It is not required for ONETIME, DAILY and ASPRESENTED frequencies. Possible values: For WEEKLY: The value should be 1-Monday to 7-Sunday. For MONTHLY, BIMONTHLY, QUARTERLY, HALFYEARLY or YEARLY: The value should be between 1 to 30/31 days. By Default: The value will be treated as 1.

Usage Flow

Customer 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.
\n
Merchant sends createSession request: The merchant sends a POST request to the createSession API with the customer’s customerId and the merchant’s brandId.
\n
Session created automatically on the checkout URL: NovixPay 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.
\n
Customer 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.
\n
Session 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.
\n

Benefits

Seamless Checkout: The session URL is automatically generated and active at the backend, ensuring a smoother and uninterrupted customer experience.
\n
Reduced Transaction Failures: By ensuring the session remains active during the payment process, the chances of transaction failures due to session timeouts are minimized.
\n
Improved 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.
\n

This endpoint will be used to get all the details of a particular mandate. You can search for a particular mandate id or for a particular session id.

Response parameters:

totalDeductedAmount
This is the total amount which is deducted from the user's account.
\n
recurringMandateIds
This object returns a list of all the MIT transactions done for the respective mandate.
\n
nextMandateDate
This is the date when the next recurring payment will happen.
\n

After the successful Mandate registration, Merchant will receive a mandate_id from NovixPay that should be stored against a customer at their end.

If the merchant handles their own scheduling, then for the subsequent transactions, the merchant is supposed to pass a combination of customer_id and mandate_id to do a debit. This API will perform a transaction with a PSP based on the mandate_id passed in the request.

If NovixPay handles the scheduling for the merchant on their behalf, then this API is not for them. The MIT transactions will be handled by NovixPay from our side.

Note:
Recurring payments should only be done if the mandate registration has been successful and the mandate is ACTIVE.

\n","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"d63c071f-61d5-4d18-a441-9988c361a97d","id":"d63c071f-61d5-4d18-a441-9988c361a97d","name":"Recurring Payments","type":"folder"}},"urlObject":{"protocol":"https","path":["api","v1","purchases"],"host":["app","novixpay","io"],"query":[],"variable":[]}},"response":[{"id":"75ee6f06-246b-4d16-86da-036a788ba122","name":"Success","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer Token","type":"text"},{"key":"Accept","value":"*/*","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"client\": {\r\n \"customerId\": \"685f870cf3435a2d5b35ee08\", // mandatory\r\n \"email\": \"abby.aadeniran@gmail.com\",\r\n \"phone\": \"+44 07932665877\",\r\n \"full_name\": \"Navya Jain\",\r\n \"street_address\": \"Flat 61 Priory Court Romford RM7 0FY\",\r\n \"country\": \"GB\",\r\n \"city\": \"London\",\r\n \"zip_code\": \"234567\",\r\n \"stateCode\": \"LO\"\r\n },\r\n \"purchase\": {\r\n \"currency\": \"INR\",\r\n \"products\": [\r\n {\r\n \"name\": \"test\",\r\n \"price\": 100\r\n }\r\n ]\r\n },\r\n \"merchantRef\": \"test12\", // optional\r\n \"brand_id\": \"{{merchant_brand_id}}\",\r\n \"payment_type\": \"recurring\",\r\n \"mandate_id\": \"6905c387faca6576ebf01528\",\r\n \"success_callback\": \"https://your.success.callback.com\",\r\n \"failure_callback\": \"https://your.failure.callback.com\"\r\n}"},"url":"https://app.novixpay.io/api/v1/purchases"},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[{"key":"Date","value":"Sun, 01 Feb 2026 07:33:08 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":"37f1854e-59ef-4553-928a-273030e84769"},{"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 adbd5a952eb287ac84e05fd5fd42328e.cloudfront.net (CloudFront)"},{"key":"X-Amz-Cf-Pop","value":"IAD61-P10"},{"key":"X-Amz-Cf-Id","value":"7AJkDib2VzETAS6vS-ZJxKBYVyLrDSEJQl_Tnle4M6l-IWwqo2asaA=="},{"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=EtWT1DIhR3ebhY8soSvPlHMZW8ROhPoWtuiPSMSlWz3I2qU3notH7b6tEnFIyl%2B6iQZs2wFrTKESZRcMCfuxDwqNPDAccnSfvR5gjUb7kUs%3D\"}]}"},{"key":"CF-RAY","value":"9c6fc2486bdc311a-IAD"}],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\n \"purchaseId\": \"6905c387faca6576ebf01528\",\n \"client\": {\n \"customerId\": \"NA\",\n \"email\": \"abby.aadeniran@gmail.com\",\n \"phone\": \"+44 07932665877\",\n \"full_name\": \"Navya Jain\",\n \"street_address\": \"Flat 61 Priory Court Romford RM7 0FY\",\n \"country\": \"GB\",\n \"city\": \"London\",\n \"zip_code\": \"234567\",\n \"cc\": [],\n \"bcc\": [],\n \"stateCode\": \"LO\"\n },\n \"updated_on\": 1761985415,\n \"type\": \"purchase\",\n \"paymentMethod\": \"MASTER\",\n \"amountUnit\": \"MAJOR\",\n \"errorMsg\": \"\",\n \"errorCode\": \"NA\",\n \"redirectType\": \"POST\",\n \"force_recurring\": false,\n \"created_on\": 1761985415,\n \"merchantRef\": \"6905c387faca6576ebf01528\",\n \"merchantName\": \"rahul_test\",\n \"merchantType\": \"MERCHANT\",\n \"purchase\": {\n \"currency\": \"GBP\",\n \"products\": [\n {\n \"name\": \"product name\",\n \"quantity\": 1.0,\n \"price\": 10.0,\n \"discount\": 0,\n \"tax_percent\": \"0.00\"\n }\n ],\n \"total\": 1.0,\n \"requestAmount\": 1.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 \"country\": \"\",\n \"attempts\": []\n },\n \"status\": \"PAID\",\n \"payment_type\": \"recurring\",\n \"mandate\": {\n \"mandate_id\": \"6905c387faca6576ebf01528\",\n \"amount_variability\": \"Fixed\",\n \"status\": \"ACTIVE\",\n \"mandate_max_amount\": \"5000\",\n \"start_date\": \"1598965200\",\n \"end_date\": \"1914141600\",\n \"frequency\": \"ASPRESENTED\",\n \"rule\": \"on\",\n \"value\": 1\n },\n \"mandate_id\": \"6905c387faca6576ebf01528\",\n \"status_history\": [\n {\n \"status\": \"paid\",\n \"timestamp\": 1761985415\n }\n ],\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\": \"PS236\",\n \"issued\": \"2025-11-01\",\n \"due\": 1761985415,\n \"refund_upto\": 0,\n \"cc_descriptor\": \"\",\n \"fraudScore\": \"NA\",\n \"trustScore\": \"NA\",\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\": 0.0,\n \"success_redirect\": \"https://merchant.com/success\",\n \"pending_redirect\": \"https://merchant.com/pending\",\n \"failure_redirect\": \"https://merchant.com/failure\",\n \"success_callback\": \"https://merchant.com/webhook/success\",\n \"failure_callback\": \"https://merchant.com/webhook/failure\",\n \"platform\": \"API\",\n \"created_from_ip\": \"183.83.53.16, 172.71.172.187, 130.176.161.204\",\n \"checkout_url\": \"https://api.choicepay.ca/payments/1f1d15ebf4f4adcfce479f6220757e30/\",\n \"direct_post_url\": \"https://api.choicepay.ca/api/v1/p/6905c387faca6576ebf01528/\",\n \"payoutProcess\": false\n}"}],"_postman_id":"58d4543e-4b17-4934-8522-6d95f92ddf5c"},{"name":"Revoke Mandate","id":"44ce1525-a32c-4597-9526-4e4801a93c6a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Accept","value":"application/json","type":"text"},{"key":"Brandid","value":"your-brand-id","type":"text"},{"key":"Authorization","value":"Bearer Token","type":"text"}],"body":{"mode":"raw","raw":"{\n \"mandate_id\": \"685cc8515e3af922dd0e8c31\",\n \"command\": \"revoke\"\n}","options":{"raw":{"language":"json"}}},"url":"https://app.novixpay.io/api/v1/mandate","description":"

Required for cases where the NovixPay is handling the scheduling of recurring payments. Use this API to revoke/cancel an ACTIVE mandate.

Note:
Revoking a mandate should be done at the same instance this API is called. The mandate status should be updated to “REVOKED” at the same instant.

Required for cases where the NovixPay is handling the scheduling of recurring payments. Use this API to pause an ACTIVE mandate.

Additional parameters for this usecase:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Notes
command	Mandatory. To be passed as \"pause\".
mandate_id	Mandatory.
pause_start_date	Optional Date in UNIX EPOCH timestamp (UTC timezone) format, when the mandate will be paused. If not passed, Default value will be the current date.
pause_end_date	Mandatory Date in UNIX EPOCH timestamp (UTC timezone) format, when the mandate status will be automatically changed to ACTIVE.

Note:
For pausing a mandate you need to keep the exact timestamp in mind.
If a recurring payment is scheduled between the pause_start_date and pause_end_date then it will not be executed.

This endpoint will be used to list all the mandates for a particular customer of a merchant.

Response parameters:

totalDeductedAmount
This is the total amount which is deducted from the user's account.
\n
recurringMandateIds
This object returns a list of all the MIT transactions done for the respective mandate.
\n
nextMandateDate
This is the date when the next recurring payment will happen.
\n

\n","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"d63c071f-61d5-4d18-a441-9988c361a97d","id":"d63c071f-61d5-4d18-a441-9988c361a97d","name":"Recurring Payments","type":"folder"}},"urlObject":{"protocol":"https","path":["api","v1","mandate"],"host":["app","novixpay","io"],"query":[{"key":"customerId","value":"696bd627b0c24568ade4675e"},{"key":"email","value":"test@gmail.com"}],"variable":[]}},"response":[{"id":"fca2e02c-6385-4f36-ade9-510bd6f411dd","name":"Success","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json","type":"text"},{"key":"BrandId","value":"your-brand-id","type":"text"},{"key":"Authorization","value":"Bearer Token","type":"text"}],"url":{"raw":"https://app.novixpay.io/api/v1/mandate?customerId=696bd627b0c24568ade4675e&email=test@gmail.com","protocol":"https","host":["app","novixpay","io"],"path":["api","v1","mandate"],"query":[{"key":"customerId","value":"696bd627b0c24568ade4675e"},{"key":"email","value":"test@gmail.com"}]}},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[{"key":"Date","value":"Sun, 01 Feb 2026 07:45:33 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":"f16548e2-fc87-44fc-bbf1-767f2c82af0c"},{"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":"ywr-KbYLgcl2CP9ZyFndEJjR7VI6jATRNoLeJen1sLm6hmk4VPBSGw=="},{"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=SuOGk1BmR%2B6RDq9oMjQI0y4v%2B2wZpehSeXuXxwibUF8%2B%2Fg6CIX9K27%2F1oT205007Yq63%2BR2d2casubErbR9yDAk78NgFsX%2Bd%2FGq2v9VBBGY%3D\"}]}"},{"key":"CF-RAY","value":"9c6fd4788b13c5ce-IAD"}],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\n \"mandates\": [\n {\n \"status\": \"ACTIVE\",\n \"frequency\": \"WEEKLY\",\n \"rule\": \"after\",\n \"value\": 4,\n \"totalDeductedAmount\": \"10.00\",\n \"recurringMandateIds\": [\n \"6973ad04fa54ee2cf14f438c\",\n \"697ce750e6446c7babfe4727\"\n ],\n \"email\": \"test@gmail.com\",\n \"nextMandateDate\": 1770398106,\n \"customer_id\": \"696bd627b0c24568ade4675e\",\n \"mandate_id\": \"696bc39a7bc779fac5201357\",\n \"mandate_max_amount\": 120,\n \"amount_variability\": \"Variable\",\n \"start_date\": \"1768670106\"\n },\n {\n \"status\": \"CREATED\",\n \"frequency\": \"WEEKLY\",\n \"rule\": \"on\",\n \"value\": 6,\n \"totalDeductedAmount\": \"0\",\n \"email\": \"test@gmail.com\",\n \"customer_id\": \"696bd627b0c24568ade4675e\",\n \"mandate_id\": \"696bd627b0c24568ade4675e\",\n \"mandate_max_amount\": 120,\n \"amount_variability\": \"Variable\",\n \"start_date\": \"1768674855\",\n \"session_id\": \"\"\n },\n {\n \"status\": \"ACTIVE\",\n \"frequency\": \"WEEKLY\",\n \"rule\": \"after\",\n \"value\": 4,\n \"totalDeductedAmount\": \"0\",\n \"email\": \"test@gmail.com\",\n \"customer_id\": \"696bd627b0c24568ade4675e\",\n \"mandate_id\": \"69788a5dd1ed27eeb5fb89d6\",\n \"mandate_max_amount\": 120,\n \"amount_variability\": \"Variable\",\n \"start_date\": \"1769507493\",\n \"session_id\": \"\"\n },\n {\n \"status\": \"ACTIVE\",\n \"frequency\": \"WEEKLY\",\n \"rule\": \"after\",\n \"value\": 4,\n \"totalDeductedAmount\": \"1000\",\n \"recurringMandateIds\": [\n \"6973ad04fa54ee2cf14f438c\",\n \"697ce750e6446c7babfe4727\"\n ],\n \"email\": \"test@gmail.com\",\n \"customer_id\": \"696bd627b0c24568ade4675e\",\n \"mandate_id\": \"69788d2f0ea4df4fd4e6eb5b\",\n \"mandate_max_amount\": 120,\n \"amount_variability\": \"Variable\",\n \"start_date\": \"1769508214\",\n \"session_id\": \"\"\n },\n {\n \"status\": \"FAILED\",\n \"frequency\": \"WEEKLY\",\n \"rule\": \"after\",\n \"value\": 4,\n \"totalDeductedAmount\": \"0\",\n \"email\": \"test@gmail.com\",\n \"customer_id\": \"696bd627b0c24568ade4675e\",\n \"mandate_id\": \"697b533b34d180d90cfb2f5f\",\n \"mandate_max_amount\": 120,\n \"amount_variability\": \"Variable\",\n \"start_date\": \"1769689915\",\n \"session_id\": \"\"\n },\n {\n \"status\": \"CREATED\",\n \"frequency\": \"WEEKLY\",\n \"rule\": \"after\",\n \"value\": 4,\n \"totalDeductedAmount\": \"0\",\n \"email\": \"test@gmail.com\",\n \"customer_id\": \"696bd627b0c24568ade4675e\",\n \"mandate_id\": \"697de0e15d2e562bf8b4552a\",\n \"mandate_max_amount\": 120,\n \"amount_variability\": \"Variable\",\n \"start_date\": \"1769857249\",\n \"session_id\": \"\"\n }\n ]\n}"}],"_postman_id":"23abc2da-e500-42a3-bfe9-57f608f9d3a6"},{"name":"Get Status","id":"51f93e29-08ce-4a00-a766-8aacdd1cf5df","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer Token","type":"text"}],"url":"app.novixpay.io/purchases/{purchaseId}/","description":"

This API tells you about all the details of a recurring payment which occurred

Mandatory

you need to pass the PurchaseID in the API URL

Possible Value of Status

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Status	Notes
paid	Transaction Successful
expired	Purchase has Expired.
error	Transaction has Failed.

Response Examples

In the response examples you can see instances of both Paid and Error Status purchases.

Error Details

If there are any issues on the Purchase you can get more details from the transaction_data.attempts.error attribute of the response object

Errors

If there are any errors then it'll be in the format of :

{\n    \"message\": \"descriptive error message\",\n    \"code\": \"error_code\"\n}\n\n

Please see the Status Code section for further details.

\n","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"d63c071f-61d5-4d18-a441-9988c361a97d","id":"d63c071f-61d5-4d18-a441-9988c361a97d","name":"Recurring Payments","type":"folder"}},"urlObject":{"path":["purchases","{purchaseId}",""],"host":["app","novixpay","io"],"query":[],"variable":[]}},"response":[{"id":"3c137ac4-eb19-453b-986b-78e851883b9a","name":"Success","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer Token","type":"text"}],"url":"app.novixpay.io/purchases/{purchaseId}/"},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[{"key":"Date","value":"Sun, 01 Feb 2026 07:59:35 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":"e222737a-b9e9-4562-94de-5b80b056c180"},{"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":"eUcDXjdNU1qDjwPQst7oM9Kbi8qYyd8sncr30-6kphukYSEGv-qwUg=="},{"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=i8qaRQprp0TLqlSo5At%2FjpQANnSZgP8iEeVFnMasIN8xyAN2mdqYXVqP3dXt2AbZRL8fj6SRWa%2BFA1dybSS8ebE5scTH8BsB6Ubx8ppJSxc%3D\"}]}"},{"key":"CF-RAY","value":"9c6fe9092c493ec9-IAD"}],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\n \"purchaseId\": \"6973ad04fa54ee2cf14f438c\",\n \"client\": {\n \"customerId\": \"NA\",\n \"email\": \"sl68792.bravo@bravapay.com\",\n \"phone\": \"0557719399\",\n \"full_name\": \"Test user\",\n \"date_of_birth\": \"2004-07-12\",\n \"street_address\": \"10 New Burlington StreetApt. 214\",\n \"country\": \"CA\",\n \"city\": \"London\",\n \"zip_code\": \"W1S 3BE\",\n \"cc\": [],\n \"bcc\": [],\n \"tax_number\": \"+447755564318\",\n \"bankAccountNumber\": \"1345789678\",\n \"stateCode\": \"QLD\"\n },\n \"updated_on\": 1769188614,\n \"type\": \"purchase\",\n \"paymentMethod\": \"VISA\",\n \"amountUnit\": \"MAJOR\",\n \"errorMsg\": \"ERROR_PARSING_GROUP_ID\",\n \"errorCode\": \"NA\",\n \"force_recurring\": false,\n \"created_on\": 1769188612,\n \"merchantRef\": \"6973ad04fa54ee2cf14f438c\",\n \"purchase\": {\n \"currency\": \"USD\",\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 \"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\": \"zenith\",\n \"brand_name\": \"zenith\",\n \"registration_number\": \"\",\n \"tax_number\": \"\"\n },\n \"transaction_data\": {\n \"payment_method\": \"\",\n \"flow\": \"payform\",\n \"extra\": {\n \"expiry_month\": \"01\",\n \"amount\": 10.0,\n \"card_issuer\": \"VISION BANK\",\n \"masked_pan\": \"42222222*2222\",\n \"card_brand\": \"VISA\",\n \"card_issuer_country\": \"SA\",\n \"card_type\": \"DEBIT\",\n \"cardholder_name\": \"fgjhknms\",\n \"expiry_year\": \"29\"\n },\n \"country\": \"\",\n \"attempts\": [\n {\n \"client_ip\": \"49.36.232.107\",\n \"type\": \"execute\",\n \"payment_method\": \"VISA\",\n \"flow\": \"payform\",\n \"successful\": false,\n \"country\": \"VISA\",\n \"processing_time\": 1769188612,\n \"extra\": {\n \"amount\": 10.0,\n \"masked_pan\": \"VISA\",\n \"card_brand\": \"VISA\",\n \"card_issuer_country\": \"VISA\",\n \"cardholder_name\": \"Test user\"\n },\n \"error\": {\n \"message\": \"This customer can not be processed !\",\n \"code\": \"transaction_error\"\n }\n },\n {\n \"client_ip\": \"\",\n \"type\": \"execute\",\n \"payment_method\": \"VISA\",\n \"flow\": \"payform\",\n \"successful\": false,\n \"country\": \"SA\",\n \"processing_time\": 1769188613,\n \"extra\": {\n \"expiry_month\": \"01\",\n \"amount\": 10.0,\n \"card_issuer\": \"VISION BANK\",\n \"masked_pan\": \"42222222*2222\",\n \"card_brand\": \"VISA\",\n \"card_issuer_country\": \"SA\",\n \"card_type\": \"DEBIT\",\n \"cardholder_name\": \"fgjhknms\",\n \"expiry_year\": \"29\"\n },\n \"error\": {\n \"message\": \"ERROR_PARSING_GROUP_ID\",\n \"code\": \"transaction_error\"\n }\n }\n ]\n },\n \"status\": \"ERROR\",\n \"status_history\": [\n {\n \"status\": \"created\",\n \"timestamp\": 1769188612\n },\n {\n \"status\": \"pending_execute\",\n \"timestamp\": 1769188612\n },\n {\n \"status\": \"error\",\n \"timestamp\": 1769188613\n },\n {\n \"status\": \"pending_execute\",\n \"timestamp\": 1769188613\n },\n {\n \"status\": \"error\",\n \"timestamp\": 1769188614\n },\n {\n \"status\": \"viewed\",\n \"timestamp\": 1770016552\n }\n ],\n \"viewedOn\": 1770016552,\n \"is_test\": false,\n \"brand_id\": \"555c458b-e737-4905-adb2-2451d37cbb6e\",\n \"send_receipt\": false,\n \"is_recurring_token\": false,\n \"skip_capture\": false,\n \"reference_generated\": \"PS1841\",\n \"issued\": \"2026-01-23\",\n \"due\": 1769188612,\n \"refund_upto\": 0,\n \"cc_descriptor\": \"\",\n \"fraudScore\": \"NA\",\n \"trustScore\": \"NA\",\n \"extraFee\": \"0\",\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\": 0.0,\n \"success_redirect\": \"https://app.novixpay.io/getResponse.jsp?issucces=true\",\n \"failure_redirect\": \"https://app.novixpay.io/getResponse.jsp?issucces=false\",\n \"pending_redirect\": \"https://app.novixpay.io/getResponse.jsp?issucces=pending \",\n \"cancel_redirect\": \"\",\n \"success_callback\": \"https://www.google.com/\",\n \"failure_callback\": \"https://app.novixpay.io/merchant\",\n \"platform\": \"API\",\n \"created_from_ip\": \"49.36.232.107\",\n \"checkout_url\": \"https://test4.paymentsclub.net/payments/a28ed9974a22a4cbd5f2f49cc26cc334/\",\n \"direct_post_url\": \"https://test4.paymentsclub.net/api/v1/p/6973ad04fa54ee2cf14f438c/\",\n \"payoutProcess\": false,\n \"payment_type\": \"internal recurring\",\n \"mandate_id\": \"696bc39a7bc779fac5201357\"\n}"}],"_postman_id":"51f93e29-08ce-4a00-a766-8aacdd1cf5df"}],"id":"67af5c81-b596-43a9-ac12-22d52f23e9df","_postman_id":"67af5c81-b596-43a9-ac12-22d52f23e9df","description":"","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"d63c071f-61d5-4d18-a441-9988c361a97d","id":"d63c071f-61d5-4d18-a441-9988c361a97d","name":"Recurring Payments","type":"folder"}}}],"id":"d63c071f-61d5-4d18-a441-9988c361a97d","description":"

Overview

The NovixPay Subscription module (also known as Mandates) enables merchants to automate recurring billing for products and services. Unlike standard one-off transactions, this feature creates a persistent link between the merchant and the customer's payment method, allowing for future charges without requiring the customer to be present or re-enter their details.

This system is built around two fundamental transaction types that define the lifecycle of a subscription:

1. Mandate Registration (CIT)

The Customer Initiated Transaction (CIT) is the setup phase. It occurs when the customer is actively on your site or app (\"in-session\").

Purpose: To capture payment details, validate the card (often via 3D Secure), and obtain customer consent for future charges.
\n
Outcome: A successful CIT generates a unique mandate_id. This ID serves as a secure token representing the agreement and is used to authorize all future payments.
\n
Use Case: A user signing up for a streaming service and paying the first month's fee.
\n

2. Recurring Payments (MIT)

The Merchant Initiated Transaction (MIT) is the execution phase. These transactions are triggered by your system (or NovixPay's scheduler) automatically (\"off-session\").

Purpose: To debit the customer's account according to the agreed schedule or usage.
\n
Mechanism: You send a request to the /purchases API referencing the mandate_id instead of raw card details. Because the mandate is already authorized, these transactions typically bypass the 3D Secure challenge, ensuring a frictionless experience.
\n
Use Case: The automatic renewal charge that happens one month later.
\n

Key Capabilities

Flexible Scheduling: Define rigid schedules (Daily, Weekly, Monthly, Yearly) or use \"As Presented\" for irregular billing intervals.
\n
Amount Variability: Support for Fixed amounts (e.g., $10/month license) or Variable amounts (e.g., utility bills where the cost changes based on usage).
\n
Smart Management:
\n
- Merchant Managed: You track the dates and trigger the API call when payment is due.
  \n
- NovixPay Managed: You define the rules (start date, end date, frequency), and NovixPay handles the execution logic.
  \n
\n
Analytics & Operations: Includes a dedicated dashboard for monitoring signup performance, renewal success rates, and managing cancellations.
\n

There are 2 ways in which subscriptions are handled at NovixPay’s end:

Merchant handles the scheduling: Merchant creates a subscription and then calls the recurring API as per their own schedule.
\n
NovixPay handles the scheduling: Merchant creates a subscription on our end and provides the recurring payment schedule and we handle the scheduling.
\n

Prerequisites

Before you start integration, make sure below configuration for mandates are in place:

Mandate Enablement at PSP’s side

Set up mandate-related features on the respective PSP’s dashboard.

Configuration on the NovixPay Dashboard

If you are a whitelabel merchant or using our whitelabel solution, you will need to go inside the mid settings (of your PSP) and enable the toggle for mandate support. This will make sure that the PSP is supporting the mandates and NovixPay can route the transactions accordingly.
If you are a merchant of NovixPay, this will be handled by us, Please contact your account manager for the same.