{"info":{"_postman_id":"b3cbddbd-6c11-4452-8e3f-07fd4418eedc","name":"Paysecure API Documentation - Live","description":"

Overview

Paysecure 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 Paysecure but if you have any questions, please do not hesitate to reach out to us via email at info@paysecure.net

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://api.paysecure.net/api/v1
Sandbox	https://api.paysecure.net/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":"48350069","collectionId":"b3cbddbd-6c11-4452-8e3f-07fd4418eedc","publishedId":"2sBY4VJcdT","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"5223BC"},"publishDate":"2026-08-06T06:51:21.000Z"},"item":[{"name":"⚙️ Integration Steps","item":[],"id":"b81b7d5e-d4a8-48a1-ac5c-048c30aea8c7","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 sandbox environment.

Test cards and Testing simulators can be found at the end of this document.

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

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

Webhook Payload Specification

Fields Description

Key	Description
message.purchaseId	Unique identifier of the purchase generated by Paysecure.
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 PaySecure.
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

Paysecure 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 Paysecure (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 Paysecure’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 Paysecure 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 Paysecure public key
\n

Sample Webhook

{\n  \"message\": {\n    \"purchaseId\": \"6808127876673d75156df3e6\",\n    \"client\": {\n      \"customerId\": \"NA\",\n      \"email\": \"user6091@example.com\",\n      \"phone\": \"+17808752869\",\n      \"full_name\": \"Dale Richardson\",\n      \"date_of_birth\": \"1800-01-01\",\n      \"street_address\": \"48 AVE , ALBERTA BEACH\",\n      \"country\": \"CA\",\n      \"city\": \"ALBERTA\",\n      \"zip_code\": \"T0E 0A0\",\n      \"shipping_street_address\": \" \",\n      \"shipping_country\": \"\",\n      \"shipping_city\": \"\",\n      \"shipping_zip_code\": \"\",\n      \"cc\": [],\n      \"bcc\": [],\n      \"stateCode\": \"AB\"\n    },\n    \"updated_on\": 1745359929,\n    \"type\": \"purchase\",\n    \"isFraud\": \"NO\",\n    \"paymentMethod\": \"INTERAC,MASTER,VISA,JCB\",\n    \"amountUnit\": \"MAJOR\",\n    \"errorMsg\": \"Transaction succeeded-APPROVED\",\n    \"detailedMsg\": \"Transaction succeeded-APPROVED\",\n    \"redirectType\": \"POST\",\n    \"force_recurring\": false,\n    \"created_on\": 1745359481,\n    \"merchantRef\": \"7235\",\n    \"merchantName\": \"firstinvestacademy\",\n    \"pspReference\": \"pKlSYNsPOdOL2FCmSAjXEOHzDDpSP5\",\n    \"bankmid\": \"waverlite\",\n    \"bankname\": \"waverlite\",\n    \"purchase\": {\n      \"currency\": \"CAD\",\n      \"products\": [\n        {\n          \"name\": \"Payment\",\n          \"quantity\": 1,\n          \"price\": 294,\n          \"discount\": 0,\n          \"tax_percent\": \"0.00\"\n        }\n      ],\n      \"total\": 294,\n      \"language\": \"en\",\n      \"notes\": \"Micro+ Plan\",\n      \"debt\": 0,\n      \"total_formatted\": 1,\n      \"expireInMin\": \"43800\",\n      \"taxAmount\": 0,\n      \"taxPercent\": 0,\n      \"request_client_details\": [],\n      \"email_message\": \"\"\n    },\n    \"payment\": {\n      \"is_outgoing\": false,\n      \"payment_type\": \"PURCHASE\",\n      \"amount\": 294,\n      \"currency\": \"CAD\",\n      \"net_amount\": 294,\n      \"fee_amount\": 0,\n      \"pending_amount\": 0,\n      \"pending_unfreeze_on\": null,\n      \"description\": \"\",\n      \"paid_on\": 1745359487,\n      \"remote_paid_on\": 1745359487\n    },\n    \"issuer_details\": {\n      \"website\": \"\",\n      \"legal_street_address\": \"\",\n      \"legal_country\": \"\",\n      \"legal_city\": \"\",\n      \"legal_zip_code\": \"\",\n      \"bank_accounts\": [\n        {}\n      ],\n      \"legal_name\": \"FISCOM\",\n      \"brand_name\": \"FISCOM\",\n      \"registration_number\": \"\",\n      \"tax_number\": \"\"\n    },\n    \"transaction_data\": {\n      \"payment_method\": \"\",\n      \"flow\": \"payform\",\n      \"extra\": {\n        \"amount\": 294,\n        \"masked_pan\": \"INTERAC\"\n      },\n      \"country\": \"\",\n      \"attempts\": [\n        {\n          \"client_ip\": \"203.0.113.119\",\n          \"type\": \"execute\",\n          \"payment_method\": \"INTERAC\",\n          \"flow\": \"payform\",\n          \"successful\": true,\n          \"country\": \"INTERAC\",\n          \"processing_time\": 1745359487,\n          \"extra\": {\n            \"amount\": 294,\n            \"masked_pan\": \"INTERAC\"\n          }\n        }\n      ]\n    },\n    \"status\": \"PAID\",\n    \"status_history\": [\n      {\n        \"status\": \"created\",\n        \"timestamp\": 1745359481\n      },\n      {\n        \"status\": \"pending_execute\",\n        \"timestamp\": 1745359487\n      },\n      {\n        \"status\": \"payment_in_process\",\n        \"timestamp\": 1745359491\n      },\n      {\n        \"status\": \"viewed\",\n        \"timestamp\": 1745359500\n      },\n      {\n        \"status\": \"paid 294.0\",\n        \"timestamp\": 1745359929\n      }\n    ],\n    \"viewedOn\": 1745359932,\n    \"is_test\": false,\n    \"brand_id\": \"your-brand-id\",\n    \"send_receipt\": false,\n    \"is_recurring_token\": false,\n    \"skip_capture\": false,\n    \"reference_generated\": \"PS4754\",\n    \"reference\": \"7235\",\n    \"issued\": \"2025-04-22\",\n    \"due\": 1745359481,\n    \"refund_upto\": 0,\n    \"cc_descriptor\": \"Africhange Technologies\",\n    \"fraudScore\": \"NA\",\n    \"trustScore\": \"NA\",\n    \"fx_Currency\": \"CAD\",\n    \"fx_Amount\": \"294.00\",\n    \"transFees\": \"0.44\",\n    \"refundFee\": \"NA\",\n    \"chargeBackFee\": \"NA\",\n    \"rollingReserve\": \"0.00\",\n    \"cascade_Num\": \"NA\",\n    \"debitOrcredit\": \"NA\",\n    \"conversionRiskFactorApplied\": \"0\",\n    \"payInDetails\": {\n      \"name\": \"INTERAC E-TRANSFER\",\n      \"emailAddress\": \"user9999@example.com\",\n      \"secretQA\": \"q4754199\",\n      \"secretAnswer\": \"a4754199\"\n    },\n    \"paidOn\": 1745359929,\n    \"receivedAmt\": 294,\n    \"refund_availability\": \"NONE\",\n    \"refundable_amount\": 0,\n    \"success_redirect\": \"https://your.success.redirect.com\",\n    \"failure_redirect\": \"https://your.failure.redirect.com\",\n    \"cancel_redirect\": \"https://firstinvestschool.com/?wc-api=wc_gateway_paysecure_payments&id=7235&action=cancel\",\n    \"success_callback\": \"https://your.success.callback.com\",\n    \"failure_callback\": \"https://your.failure.callback.com\",\n    \"creator_agent\": \"PaySecure Payments for WooCommerce: v1.2.3\",\n    \"platform\": \"API\",\n    \"created_from_ip\": \"203.0.113.13, 203.0.113.137, 203.0.113.122\",\n    \"checkout_url\": \"https://api.paysecure.net/payments/6808127876673d75156df3e6/\",\n    \"direct_post_url\": \"https://api.paysecure.net/api/v1/p/6808127876673d75156df3e6/\",\n    \"mdr\": \"13.52\",\n    \"payoutProcess\": false\n  },\n  \"status\": \"paid\"\n}\n\n

\n","_postman_id":"99961dcb-0f63-457f-a1b2-e9bdf48a5e5b"},{"name":"Payout","item":[],"id":"78fa6239-ee23-46a1-9fe7-59c1ae53a9f6","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 Paysecure.
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 Paysecure.
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

Paysecure 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 Paysecure (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 Paysecure’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 Paysecure 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\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 Paysecure public key
\n

Sample Webhook:

{\n  \"payload\": {\n    \"payoutId\": \"68b02af16c4f71530ae1d73b\",\n    \"client\": {\n      \"customerId\": \"NA\",\n      \"email\": \"user5890@example.com\",\n      \"phone\": \"+14377717874\",\n      \"full_name\": \"Blake Mensah\",\n      \"country\": \"CA\"\n    },\n    \"updated_on\": 1756375793,\n    \"payoutMethod\": \"PAYOUT-INTERAC-ETRANSFER\",\n    \"amountUnit\": \"MAJOR\",\n    \"amount\": 6,\n    \"errorMsg\": \"\",\n    \"purpose\": \"test payout\",\n    \"created_on\": 1756375793,\n    \"merchantRef\": \"68b02af16c4f71530ae1d73b\",\n    \"merchantName\": \"Skyler Nakamurasinghal\",\n    \"status\": \"PAID\",\n    \"status_history\": [\n      {\n        \"status\": \"created\",\n        \"timestamp\": 1756375793\n      },\n      {\n        \"status\": \"paid\",\n        \"timestamp\": 1756375810\n      }\n    ],\n    \"currency\": \"CAD\",\n    \"fx_Currency\": \"CAD\",\n    \"fx_Amount\": \"6.00\",\n    \"transFees\": \"0.3\",\n    \"paymentOn\": 1756375810,\n    \"payOutDetails\": {\n      \"name\": \"INTERAC E-TRANSFER\",\n      \"emailAddress\": \"user5890@example.com\",\n      \"secretQA\": \"q680216471530173202\",\n      \"secretAnswer\": \"a680216471530173202\"\n    },\n    \"taxAmount\": 0,\n    \"taxPercent\": 0,\n    \"redirectType\": \"POST\",\n    \"pendingReview\": \"No\",\n    \"surcharge\": 0,\n    \"success_callback\": \"https://your.success.callback.com\",\n    \"failure_callback\": \"https://your.failure.callback.com\",\n    \"mdr\": \"0.00\"\n  },\n  \"status\": \"paid\"\n}\n\n

\n","_postman_id":"78fa6239-ee23-46a1-9fe7-59c1ae53a9f6"}],"id":"c68850cd-cf18-43cc-84ec-dcfd7660fc31","description":"

To receive information about various transaction status and events, you will need to set up an endpoint which accepts payloads sent by Paysecure. 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\".

Paysecure 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 Paysecure 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. Paysecure 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://api.paysecure.net/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 \"PaySecure\" — Identifies the request origin as PaySecure.
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":"c68850cd-cf18-43cc-84ec-dcfd7660fc31"},{"name":"🖥️ Status Code","item":[{"name":"Transaction Status and Their Meaning","item":[],"id":"f63d3ddd-92cd-4de8-87ba-1973fddae179","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":"965d7e98-0a38-4dff-97ed-85c397e4abbd"}},{"listen":"test","script":{"type":"text/javascript","exec":[""],"id":"7cd1360e-6e4b-4000-aec2-be42fb387c2d"}}],"_postman_id":"f63d3ddd-92cd-4de8-87ba-1973fddae179"}],"id":"1545f9ae-e6ed-4b95-aca9-c479494ceca8","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 Paysecure 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":"09d538fe-5c6e-452b-8aa1-7ff3cb4a82d3"}},{"listen":"test","script":{"type":"text/javascript","exec":[""],"id":"82233cc4-5456-4eff-994c-6eb43affeba3"}}],"_postman_id":"1545f9ae-e6ed-4b95-aca9-c479494ceca8"},{"name":"Payment Methods","item":[{"name":"💳 Card Payments","item":[{"name":"Concepts","item":[],"id":"9bd5e5d2-53a1-4799-8478-3f0678c56d05","description":"

Paysecure Card Payments

Get started

Paysecure’s Server-to-Server (S2S) integration allows merchants to process card payments entirely from their backend systems.

In this integration model, all payment initiation and sensitive card operations are performed from the merchant backend. However, during 3D Secure authentication flows, the customer browser may be redirected to the issuing bank’s authentication page to complete verification.

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

Note:
callback_url is used only to continue the authentication or processing flow.

success_redirect, pending_redirect, and failure_redirect are final outcome URLs where the customer is redirected after transaction completion.

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 Paysecure
\n
Your server can make secure HTTPS requests
\n
Since card details are collected and transmitted from the merchant server, merchants are fully responsible for PCI-DSS compliance and secure handling of sensitive cardholder data.
\n
You have configured the following redirect URLs:
\n
- success_redirect
  \n
- pending_redirect
  \n
- failure_redirect
  \n
\n
You have a valid brand_id provided by Paysecure
\n

Create a New Payment Session

A payment session is created when a purchase is initialized in the Paysecure 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
Paysecure 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
Typically, no callback_url is required for standard 2D transactions.
\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

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 3D transactions and follows the same flow regardless of transaction type.

| POST /api/v1/purchases |

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.

| POST 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
Paysecure 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.

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 Paysecure will perform direct payment with the selected payment method instead of loading Paysecure 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.

","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"6b9c72fa-b351-485a-a846-1d9e3635a094","id":"6b9c72fa-b351-485a-a846-1d9e3635a094","name":"APIs","type":"folder"}},"urlObject":{"path":["purchases"],"host":["https://api.paysecure.net/api/v1"],"query":[],"variable":[]}},"response":[{"id":"c18960c3-d865-4f7f-bd7f-c32dc41ac429","name":"Success","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer {{APIKey}}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"client\": {\r\n \"email\": \"user1599@example.com\",\r\n \"street_address\": \"90 Fixture Close\",\r\n \"city\": \"Riverton\",\r\n \"full_name\": \"Reese Nakamura\",\r\n \"zip_code\": \"01000-000\",\r\n \"country\": \"IN\",\r\n \"date_of_birth\": \"1991-07-10\",\r\n \"stateCode\": \"SP\",\r\n \"phone\": \"+91 9634458881\"\r\n },\r\n \"purchase\": {\r\n \"currency\": \"EUR\",\r\n \"products\": [\r\n {\r\n \"name\": \"e-commerce\",\r\n \"price\": \"5\"\r\n }\r\n ]\r\n },\r\n \"paymentMethod\": \"MASTER\",\r\n \"brand_id\": \"your-brand-id\",\r\n \"success_redirect\": \"https://your.success.redirect.com\",\r\n \"pending_redirect\": \"https://your.pending.redirect.com\",\r\n \"failure_redirect\": \"https://your.failure.redirect.com\",\r\n \"success_callback\": \"https://your.success.callback.com\",\r\n \"failure_callback\": \"https://your.failure.callback.com\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.paysecure.net/api/v1/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\": \"6a1d26a3d373e5fd3c44ae14\",\n \"client\": {\n \"customerId\": \"NA\",\n \"email\": \"user1599@example.com\",\n \"phone\": \"6393000899\",\n \"street_address\": \"test test\",\n \"country\": \"IN\",\n \"city\": \"123\",\n \"zip_code\": \"234567\",\n \"cc\": [],\n \"bcc\": [],\n \"stateCode\": \"ca\"\n },\n \"updated_on\": 1780295331,\n \"type\": \"purchase\",\n \"paymentMethod\": \"MASTER,VISA,JCB,VIRTUAL-CARD,MOBILEMONEY,UPI-INTENT,UPI-QR,INTERAC-E-TRANSFER,INTERAC-REQUEST-MONEY,INTERAC-EXPRESS,PIX,FawryPay,OPEN-BANKING,SPEI\",\n \"amountUnit\": \"MAJOR\",\n \"errorMsg\": \"\",\n \"errorCode\": \"NA\",\n \"force_recurring\": false,\n \"created_on\": 1780295331,\n \"merchantRef\": \"user5957@example.com\",\n \"purchase\": {\n \"currency\": \"USD\",\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\": 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\": \"Final_cashier\",\n \"brand_name\": \"Final_cashier\",\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\": 1780295331\n }\n ],\n \"is_test\": false,\n \"brand_id\": \"your-brand-id\",\n \"send_receipt\": false,\n \"is_recurring_token\": false,\n \"skip_capture\": false,\n \"reference_generated\": \"PS1172\",\n \"issued\": \"2026-06-01\",\n \"due\": 1780295331,\n \"refund_upto\": 0,\n \"cc_descriptor\": \"\",\n \"fraudScore\": \"NA\",\n \"trustScore\": \"NA\",\n \"extraFee\": \"0\",\n \"totalRefunded\": 0.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://your.success.redirect.com\",\n \"failure_redirect\": \"https://your.failure.redirect.com\",\n \"pending_redirect\": \"https://your.pending.redirect.com\",\n \"cancel_redirect\": \"\",\n \"success_callback\": \"https://your.success.callback.com\",\n \"failure_callback\": \"https://your.failure.callback.com\",\n \"platform\": \"API\",\n \"created_from_ip\": \"203.0.113.232\",\n \"checkout_url\": \"https://api.paysecure.net/payments/c3f2eee71c5824b75c7b52ff41e76814/\",\n \"direct_post_url\": \"https://api.paysecure.net/api/v1/p/6a1d26a3d373e5fd3c44ae14/\",\n \"payoutProcess\": false\n}"},{"id":"6bc50a59-3117-432a-8db6-190d8a492243","name":"Failure","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer {{APIKey}}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"client\": {\r\n \"email\": \"user1599@example.com\",\r\n \"street_address\": \"90 Fixture Close\",\r\n \"city\": \"Riverton\",\r\n \"full_name\": \"Reese Nakamura\",\r\n \"zip_code\": \"01000-000\",\r\n \"country\": \"IN\",\r\n \"date_of_birth\": \"1991-07-10\",\r\n \"stateCode\": \"SP\",\r\n \"phone\": \"+91 9634458881\"\r\n },\r\n \"purchase\": {\r\n \"currency\": \"EUR\",\r\n \"products\": [\r\n {\r\n \"name\": \"e-commerce\",\r\n \"price\": \"5\"\r\n }\r\n ]\r\n },\r\n \"merchantRef\": \"Morgan Costa2345test\", // optional\r\n \"paymentMethod\": \"MASTER\",\r\n \"brand_id\": \"your-brand-id\",\r\n \"success_redirect\": \"https://your.success.redirect.com\",\r\n \"pending_redirect\": \"https://your.pending.redirect.com\",\r\n \"failure_redirect\": \"https://your.failure.redirect.com\",\r\n \"success_callback\": \"https://your.success.callback.com\",\r\n \"failure_callback\": \"https://your.failure.callback.com\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.paysecure.net/api/v1/purchases"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"Text","header":[{"key":"Date","value":"Thu, 23 Jul 2026 05:43:15 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":"c07bd249-d2e4-4e74-9ed0-c965c1dda2da"},{"key":"Vary","value":"Origin"},{"key":"Vary","value":"Access-Control-Request-Method"},{"key":"Vary","value":"Access-Control-Request-Headers"},{"key":"Server","value":"cloudflare"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"0"},{"key":"Cache-Control","value":"no-cache, no-store, max-age=0, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Expires","value":"0"},{"key":"Strict-Transport-Security","value":"max-age=31536000 ; includeSubDomains"},{"key":"X-Cache","value":"Error from cloudfront"},{"key":"Via","value":"1.1 a863373015dd073e91a52d99d8ad6bfc.cloudfront.net (CloudFront)"},{"key":"X-Amz-Cf-Pop","value":"IAD61-P10"},{"key":"X-Amz-Cf-Id","value":"U2b6w0TFxlY3b7tonscz71FODjmdZYELG6dLUj2_xoJrHfVOfrvINw=="},{"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=y%2BGEIJ%2Bk5LUPJPukL601IMsbHpT426vsZPHtXNnbIrQl17sOhZMHt1S5g%2B0PlJ8tDNpAVwsGq8otMh2f2H1qVF%2Bc1PSkl3Ru1NotMmZJfFDRZLf9It3qA8EU067KuPjMWaPF\"}]}"},{"key":"CF-RAY","value":"a1f85dcfacfdd635-IAD"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Incorrect secret_key\",\n \"code\": \"authentication_failed\"\n}"}],"_postman_id":"9acce252-73c1-44fc-b5b6-8080e1ad5992"},{"name":"S2S","id":"e0c1ce5c-a390-4ee0-becc-babdd279e598","protocolProfileBehavior":{"disableUrlEncoding":false,"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer {{APIKey}}","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\": \"203.0.113.121\",\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":"https://api.paysecure.net/api/v1/p/purchaseid/?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\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- 203.0.113.42
remember_card	\"on\" or \"off\" if you want us to store the card details on our end.
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

Note:
If you want to use token_reference for doing a card transaction, please have a look at Network Tokenisation Section.

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. MM/YY format.
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://api.paysecure.net/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

This is the callback URL that is in the response object of the 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 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":"6b9c72fa-b351-485a-a846-1d9e3635a094","id":"6b9c72fa-b351-485a-a846-1d9e3635a094","name":"APIs","type":"folder"}},"urlObject":{"path":["purchases","purchaseid",""],"host":["https://api.paysecure.net/api/v1"],"query":[],"variable":[]}},"response":[{"id":"818a5e51-f650-405f-805f-c92757462456","name":"Success","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer {{APIKey}}","type":"text"}],"url":"https://api.paysecure.net/api/v1/purchases/purchaseid/"},"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\": \"user6085@example.com\",\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\": \"203.0.113.133\",\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\": \"your-brand-id\",\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://your.success.redirect.com\",\n \"failure_redirect\": \"https://your.failure.redirect.com\",\n \"cancel_redirect\": \"\",\n \"success_callback\": \"https://your.success.callback.com\",\n \"platform\": \"API\",\n \"created_from_ip\": \"203.0.113.133\",\n \"checkout_url\": \"https://api.paysecure.net/payments/64bfdb7df63e36669499e82f/\",\n \"direct_post_url\": \"https://api.paysecure.net/api/v1/p/64bfdb7df63e36669499e82f/\"\n}"},{"id":"cfa2be46-6aa2-4bb6-8634-391724937f21","name":"Failure","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer {{APIKey}}","type":"text"}],"url":"https://api.paysecure.net/api/v1/purchases/purchaseid/"},"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\": \"user6085@example.com\",\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\": \"203.0.113.133\",\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\": \"your-brand-id\",\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://your.success.redirect.com\",\n \"failure_redirect\": \"https://your.failure.redirect.com\",\n \"cancel_redirect\": \"\",\n \"success_callback\": \"https://your.success.callback.com\",\n \"platform\": \"API\",\n \"created_from_ip\": \"203.0.113.133\",\n \"checkout_url\": \"https://api.paysecure.net/payments/64bfd7c9f63e36669499e779/\",\n \"direct_post_url\": \"https://api.paysecure.net/api/v1/p/64bfd7c9f63e36669499e779/\"\n}"}],"_postman_id":"0bf2b85e-e2ca-4230-8d6b-65a52cc40528"},{"name":"Refund","id":"0b8bbd7e-aa4a-4d45-94e2-7d3caed2003c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer {{APIKey}}","type":"text"}],"url":"https://api.paysecure.net/api/v1/purchases/purchaseid/refund","description":"

This API is used to initate refund (Full 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":"6b9c72fa-b351-485a-a846-1d9e3635a094","id":"6b9c72fa-b351-485a-a846-1d9e3635a094","name":"APIs","type":"folder"}},"urlObject":{"path":["purchases","purchaseid","refund"],"host":["https://api.paysecure.net/api/v1"],"query":[],"variable":[]}},"response":[{"id":"bf45cf1e-7bd5-4086-ae5e-f9af800ea03c","name":"Refund - Success","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer {{APIKey}}","type":"text"}],"url":"https://api.paysecure.net/api/v1/purchases/purchaseid/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 \"customerId\": \"NA\",\n \"email\": \"user3747@example.com\",\n \"phone\": \"6393000899\",\n \"full_name\": \"Test\",\n \"date_of_birth\": \"05/05/1995\",\n \"street_address\": \"test test\",\n \"country\": \"IN\",\n \"city\": \"123\",\n \"zip_code\": \"234567\",\n \"cc\": [],\n \"bcc\": [],\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\": \"203.0.113.133\",\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\": \"203.0.113.133\",\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\": \"your-brand-id\",\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://your.success.redirect.com\",\n \"failure_redirect\": \"https://your.failure.redirect.com\",\n \"cancel_redirect\": \"\",\n \"success_callback\": \"https://your.success.callback.com\",\n \"platform\": \"API\",\n \"created_from_ip\": \"203.0.113.133\",\n \"checkout_url\": \"https://api.paysecure.net/payments/64bfdb7df63e36669499e82f/\",\n \"direct_post_url\": \"https://api.paysecure.net/api/v1/p/64bfdb7df63e36669499e82f/\"\n}"},{"id":"d1c4584f-3a1f-4153-89da-3983721762c7","name":"Refund - Pending","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer {{APIKey}}","type":"text"}],"url":"https://api.paysecure.net/api/v1/purchases/purchaseid/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 \"customerId\": \"NA\",\n \"email\": \"user3747@example.com\",\n \"phone\": \"6393000899\",\n \"full_name\": \"Test\",\n \"date_of_birth\": \"05/05/1995\",\n \"street_address\": \"test test\",\n \"country\": \"IN\",\n \"city\": \"123\",\n \"zip_code\": \"234567\",\n \"cc\": [],\n \"bcc\": [],\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\": \"203.0.113.133\",\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\": \"203.0.113.133\",\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\": \"your-brand-id\",\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://your.success.redirect.com\",\n \"failure_redirect\": \"https://your.failure.redirect.com\",\n \"cancel_redirect\": \"\",\n \"success_callback\": \"https://your.success.callback.com\",\n \"platform\": \"API\",\n \"created_from_ip\": \"203.0.113.133\",\n \"checkout_url\": \"https://api.paysecure.net/payments/64bfdb7df63e36669499e82f/\",\n \"direct_post_url\": \"https://api.paysecure.net/api/v1/p/64bfdb7df63e36669499e82f/\"\n}"},{"id":"49f97102-c90c-43ec-bf70-f49f42e917e9","name":"Refund - Error","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer {{APIKey}}","type":"text"}],"url":"https://api.paysecure.net/api/v1/purchases/purchaseid/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":"0b8bbd7e-aa4a-4d45-94e2-7d3caed2003c"},{"name":"Payment Methods","id":"d32e5ab5-1cab-4b41-866c-b2e27ee7cf96","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer {{APIKey}}","type":"text"}],"url":"https://api.paysecure.net/api/v1/payment_methods?brand_id=your-brand-id","description":"

This API gives back the list of Payment methods available for a brand.

Cancels an in-progress or completed purchase transaction, preventing further processing or reversing the authorization hold. Use this endpoint to void a transaction that has not yet been settled to the merchant's account.

When to use:

Post-creation cancellation: Cancel a purchase immediately after it has been created via the Purchase API, before the customer completes the payment flow.
\n
Pre-redirect cancellation: Cancel a transaction after completing the server-to-server (S2S) call but before redirecting the cardholder to the callbackURL. This is useful when your backend validation logic determines the transaction should not proceed (e.g., inventory check failure, fraud flag, duplicate order detection).
\n

Purchase ID is mandatory for this API.

Overview

Paysecure supports the concept of whitelisted cards. The merchant can send PaySecure 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

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 Paysecure /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 Paysecure Merchant Portal.
\n
Collect Card Details: Collect the recipient's card details securely, or use Paysecure's Cashier to collect the card information on your behalf.
\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.cardNumber	Yes	The recipient's 16-digit card number.
extraParam.expiryYear	Yes	YYYY format (e.g., 2028).
extraParam.expiryMonth	Yes	MM format (e.g., 05).
extraParam.cardHolderName	Yes	The receiver's Full Name. Preferred a 2 word name with each word atleast 3 characters long.

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.

If the merchant wants to use token_reference for doing a payout, then please have a look at the Network Tokenisation Section.

\n","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"6b9c72fa-b351-485a-a846-1d9e3635a094","id":"6b9c72fa-b351-485a-a846-1d9e3635a094","name":"APIs","type":"folder"}},"urlObject":{"path":["payout",""],"host":["https://api.paysecure.net/api/v1"],"query":[],"variable":[]}},"response":[{"id":"3834a594-7694-4206-8171-c4ca9406f6d4","name":"Success","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer {{APIKey}}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"client\": {\r\n \"email\": \"user3069@example.com\",\r\n \"country\": \"GB\",\r\n \"city\": \"Milford\",\r\n \"stateCode\": \"QLD\",\r\n \"full_name\": \"Reese Moreau\",\r\n \"street_address\": \"13 Documentation Way\",\r\n \"zip_code\": \"68403\",\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 \"cardNumber\": \"5431240006334004\",\r\n \"cardHolderName\": \"Reese Nakamura\",\r\n \"expiryYear\": \"2030\",\r\n \"expiryMonth\": \"11\"\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.paysecure.net/api/v1/payout/"},"status":"Accepted","code":202,"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":"{\r\n \"payoutId\": \"6977137755e0628e3600c562\",\r\n \"client\": {\r\n \"email\": \"user3069@example.com\",\r\n \"country\": \"GB\",\r\n \"city\": \"Milford\",\r\n \"stateCode\": \"QLD\",\r\n \"full_name\": \"Reese Moreau\",\r\n \"street_address\": \"13 Documentation Way\",\r\n \"zip_code\": \"68403\",\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 \"cardNumber\": \"5431240006334004\",\r\n \"cardHolderName\": \"Reese Nakamura\",\r\n \"expiryYear\": \"2030\",\r\n \"expiryMonth\": \"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://api.paysecure.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\": \"https://your.success.callback.com\",\r\n \"failure_callback\": \"https://your.failure.callback.com\"\r\n}"},{"id":"e32a1818-9cae-4b2a-8b13-a8c10c17682b","name":"Error","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer {{APIKey}}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"client\": {\r\n \"email\": \"user3069@example.com\",\r\n \"country\": \"GB\",\r\n \"city\": \"Milford\",\r\n \"stateCode\": \"QLD\",\r\n \"full_name\": \"Reese Moreau\",\r\n \"street_address\": \"13 Documentation Way\",\r\n \"zip_code\": \"68403\",\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 \"cardNumber\": \"5431240006334004\",\r\n \"cardHolderName\": \"Reese Nakamura\",\r\n \"expiryYear\": \"2030\",\r\n \"expiryMonth\": \"11\"\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.paysecure.net/api/v1/payout/"},"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":"{\r\n \"payoutId\": \"6977137755e0628e3600c562\",\r\n \"client\": {\r\n \"email\": \"user3069@example.com\",\r\n \"country\": \"GB\",\r\n \"city\": \"Milford\",\r\n \"stateCode\": \"QLD\",\r\n \"full_name\": \"Reese Moreau\",\r\n \"street_address\": \"13 Documentation Way\",\r\n \"zip_code\": \"68403\",\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 \"cardNumber\": \"5431240006334004\",\r\n \"cardHolderName\": \"Reese Nakamura\",\r\n \"expiryYear\": \"2030\",\r\n \"expiryMonth\": \"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://api.paysecure.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\": \"https://your.success.callback.com\",\r\n \"failure_callback\": \"https://your.failure.callback.com\"\r\n}"}],"_postman_id":"3e26ec87-1a12-4214-9388-5ae7437cb5e0"}],"id":"6b9c72fa-b351-485a-a846-1d9e3635a094","auth":{"type":"noauth","isInherited":false},"event":[{"listen":"prerequest","script":{"type":"text/javascript","packages":{},"requests":{},"exec":[""],"id":"07049582-40b3-49c9-bd5c-93d5c6293c92"}},{"listen":"test","script":{"type":"text/javascript","packages":{},"requests":{},"exec":[""],"id":"2ac6d522-9434-4b88-8db4-90df6c7312da"}}],"_postman_id":"6b9c72fa-b351-485a-a846-1d9e3635a094","description":""}],"id":"fc723b1e-0378-4ed9-b442-73ff853b3644","auth":{"type":"noauth","isInherited":false},"event":[{"listen":"prerequest","script":{"type":"text/javascript","packages":{},"exec":[""],"id":"c7af5b7e-12fb-4f4f-b6a6-490b27da8ace"}},{"listen":"test","script":{"type":"text/javascript","packages":{},"exec":[""],"id":"2fb4293e-f80b-40c3-95cf-282a9954a3dd"}}],"_postman_id":"fc723b1e-0378-4ed9-b442-73ff853b3644","description":""},{"name":"💰 APMs (Alternative Payment Methods)","item":[{"name":"🇨🇦 Interac e-Transfer","item":[{"name":"Concepts","item":[{"name":"New Folder","item":[],"id":"f335c4b7-13fb-451b-bd50-2a7b4ab0bf36","_postman_id":"f335c4b7-13fb-451b-bd50-2a7b4ab0bf36","description":""}],"id":"05439b74-be65-4429-9869-957f0d92c92c","description":"

Interac Overview

Interac is a leading Canadian payment network that facilitates secure, real-time transactions between bank accounts. It offers multiple payment options, including Interac e-Transfers.

Interac e-Transfer allows users to send and receive money directly between bank accounts using email or SMS. It provides a fast, secure, and convenient alternative to traditional payment methods, accessible through most Canadian banks' online and mobile banking platforms.

Paysecure’s Interac product suite enables merchants to initiate:

PayIns: Consumers can utilise Interac e-Transfer to transfer funds from their bank account, through their bank’s app or website.
\n
Payouts: Facilitate real-time disbursements directly to consumers' accounts.
\n

PayIn Flows

How it works

Interac e-Transfer enables merchants with capability to support easy collection from customers. Merchants can initiate payment requests to provide secure, efficient, and flexible options for collecting payments from customers.

Key Steps

\n\n

Flow

Initiate Payment Request: The merchant initiates a PayIn (deposit/collection) transaction by sending a request to the Paysecure /purchases API. The payload must specify INTERAC-ETRANSFER as the payment method and include the customer’s email address or mobile number, the amount to be collected, and an optional message.
\n
Generate Security Question & Answer: The API responds with a security question and answer that the customer must use to complete the transfer, adding an additional layer of security. By default, the request remains valid for 30 days. The merchant can configure a longer expiry period, but not shorter than 30 days.
\n
Customer Completes the Transfer: The customer logs into their online banking platform, inputs the amount, enter the deposit email and security question and answer, and authorizes the transfer to the merchant’s account.
\n
Confirm Transfer Completion: Once the funds are successfully transferred, Paysecure sends a webhook to the merchant containing the transaction details and confirmation of payment status.
\n
Update Merchant’s Account: The merchant’s system updates the customer’s account balance to reflect the successful receipt of funds.
\n

PayOut flows

How it works
Paysecure offers the ability to make payouts to customers', individuals', or businesses' bank accounts using Interac e-Transfers. Whether for refunds, rewards, or other types of disbursements, the Payouts API ensures efficient and reliable transactions, supporting real-time fund transfers and comprehensive transaction tracking over Interac e-transfers.

Key Steps

\n\n

Flow

Initiate Payout Request: The merchant calls the Paysecure /Payout API. This request includes the customer’s email address or mobile number, the amount to be transferred, and an optional message.
\n
Security Question & Answers (Optional): For the customers that have their auto-deposit turned off , the merchant can share the security question and answer at their cashier or via email. The customer must use these Security question and answer to receive the funds, adding an extra layer of security. For customers with auto-deposit turned on, the funds will be received instanteneously.
\n
Customer Deposits Funds (Optional): The customer with auto-deposit turned off, will have to follows the link received on their email from Interac and follow the instructions to receive the funds into their acount. For customers with auto-deposit turned on, the funds will be received instanteneously.
\n
Confirm Payout Completion: Upon successful deposit, the merchant will receive the webhook with transaction info and the status.
\n
Update Merchant’s Account: The merchant’s system updates the customer’s account balance to reflect the withdrawn funds.
\n

Transaction Limits:

The limits outlined below are generally for personal accounts and can vary by financial institution and account type. For business accounts, higher limits may apply. It’s advisable to check with your bank for the most accurate limits pertaining to your account

Pay Ins:

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

Criteria	Min Amount	Max Amount
Per Transaction	0.01 CAD	3,000 CAD
Per Day	0.01 CAD	3,000 CAD
Per User (over a 7 day rolling period)	0.01 CAD	10,000 CAD
Per Month (over a 30 day rolling period)	0.01 CAD	20,000 CAD

Pay Outs:

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

Criteria	Min Amount	Max Amount
Per Transaction	10 CAD	3,000 CAD
Per Day	10 CAD	10,000 CAD
Per User (over a 7 day rolling period)	10 CAD	70,000 CAD
Per Month (over a 30 day rolling period)	10 CAD	100,000 CAD

","_postman_id":"05439b74-be65-4429-9869-957f0d92c92c"},{"name":"PayIn API","item":[{"name":"Purchases","id":"67ae39b6-9f69-4605-bcc5-1fe75be2718a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer {{APIKey}}"}],"body":{"mode":"raw","raw":"{\r\n \"client\": {\r\n \"email\": \"user2308@example.com\",\r\n \"street_address\": \"13 Documentation Way\",\r\n \"city\": \"Milford\",\r\n \"full_name\": \"Test test\",\r\n \"zip_code\": \"68403\",\r\n \"country\": \"CA\",\r\n \"stateCode\": \"QLD\",\r\n \"phone\": \"+447755564318\"\r\n },\r\n \"purchase\": {\r\n \"currency\": \"CAD\",\r\n \"expireInMin\": \"80\",\r\n \"products\": [\r\n {\r\n \"name\": \"test \",\r\n \"price\": 100\r\n }\r\n ]\r\n },\r\n \"paymentMethod\": \"INTERAC-ETRANSFER\",\r\n \"brand_id\": \"your-brand-id\",\r\n \"success_redirect\": \"https://your.success.redirect.com\",\r\n \"pending_redirect\": \"https://your.pending.redirect.com\",\r\n \"failure_redirect\": \"https://your.failure.redirect.com\",\r\n \"success_callback\": \"https://your.success.callback.com\",\r\n \"failure_callback\": \"https://your.failure.callback.com\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.paysecure.net/api/v1/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) which 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\n\n\n\n

Parameter	Notes
client.email	An Identifier for a user
client.city	An Identifier for a user
client.country	ISO-3166 Country Code. It must be upper case. This should be \"CA\" for Interac
client.stateCode	Example “AL”, “XZ”.. Must be in upper case.
client.street_address
client.zip_code
client.phone
client.full_name
purchase.currency	ISO 4217 code for currency you want to send the transaction in. This should be 'CAD' for Interac
purchase.products.name	name of the product or service
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 progress
failure_redirect	URL to send the user if the transactions is UNSUCCESSFUL

Optional Parameters

expireInMin

The purchase.expireInMin, when passed in the PayIn request, sets the time window within which a customer should make the Interac payment through their bank's app. If a customer doesn't complete the payment within the configured time window, the status of the payment will be marked as 'EXPIRED' in Paysecure.

However, in certain cases, a payment made outside of this window could still be successful i.e. customer's account may be debited which would result in inconsistencies among Paysecure's, merchant's and customer's status of the transaction. To avoid such cases it is advised to set the expiry time limit appropriately and advise the customers to make payment within this window. However, if there is an inconsistency between the status at Paysecure and at customer's Bank, the merchant and Paysecure will reconcile the amounts during the settlement.

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.

paymentMethod

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\n\n\n\n\n\n\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	Description
Invalid format of Date_of_Birth[allowed format: yyyy-mm-dd]
Enter Valid Email
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
Minimum amount is not set for this merchant
success_redirect/failure_redirect/brand_id is missing
brand_id cannot be null
success_redirect cannot be null
failure_redirect cannot be null
Invalid failure_redirect: minimum 10 characters
purchase.products.price cannot be null
purchase.products[0].name/purchase.products[0].price are missing
Your charges setting is incomplete .Plese Contact to Administrator.
Currency \"{curr_name}\" is Not Allowed
Transaction amount must be equal or greater to minimum trans amount
Allowed Limit for this card for particular time period has been consumed

Note: For certain use cases, in addition to long format purchase Id, Paysecure also provides a 7 digit unique code for each purchase starting with digit 4, eg 4000001

“purchaseIdShortCode”: “4000013\"

\n","urlObject":{"path":["purchases",""],"host":["https://api.paysecure.net/api/v1"],"query":[],"variable":[]}},"response":[{"id":"2d02476f-dc22-4658-afab-8693ba3e2561","name":"Purchase- success","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer {{APIKey}}"}],"body":{"mode":"raw","raw":"{\r\n \"client\": {\r\n \"email\": \"user2308@example.com\",\r\n \"street_address\": \"13 Documentation Way\",\r\n \"city\": \"Milford\",\r\n \"full_name\": \"Test test\",\r\n \"zip_code\": \"68403\",\r\n \"country\": \"CA\",\r\n \"stateCode\": \"QLD\",\r\n \"phone\": \"+447755564318\"\r\n },\r\n \"purchase\": {\r\n \"currency\": \"CAD\",\r\n \"expireInMin\": \"80\",\r\n \"products\": [\r\n {\r\n \"name\": \"test \",\r\n \"price\": 100\r\n }\r\n ]\r\n },\r\n \"paymentMethod\": \"INTERAC-ETRANSFER\",\r\n \"brand_id\": \"your-brand-id\",\r\n \"success_redirect\": \"https://your.success.redirect.com\",\r\n \"pending_redirect\": \"https://your.pending.redirect.com\",\r\n \"failure_redirect\": \"https://your.failure.redirect.com\",\r\n \"success_callback\": \"https://your.success.callback.com\",\r\n \"failure_callback\": \"https://your.failure.callback.com\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.paysecure.net/api/v1/purchases"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\"purchaseId\":\"67efd0ff97be603f97a3a697\",\"client\":{\"customerId\":\"NA\",\"email\":\"user5890@example.com\",\"phone\":\"+447755564318\",\"full_name\":\"Test test\",\"date_of_birth\":\"1970-07-10\",\"street_address\":\"13 Documentation Way\",\"country\":\"CA\",\"city\":\"Milford\",\"zip_code\":\"68403\",\"cc\":[],\"bcc\":[],\"gender\":\"MALE\",\"avatarUrl\":\"https://res.cloudinary.com/w22/image/upload/v1663783641/photos/currencies/ngn.png\",\"stateCode\":\"QLD\"},\"updated_on\":1743769856,\"type\":\"purchase\",\"paymentMethod\":\"INTERAC-ETRANSFER\",\"amountUnit\":\"MAJOR\",\"errorMsg\":\"\",\"redirectType\":\"GET\",\"force_recurring\":false,\"created_on\":1743769855,\"merchantRef\":\"67efd0ff97be603f97a3a697\",\"merchantName\":\"Skyler Nakamurasinghal\",\"purchase\":{\"currency\":\"CAD\",\"products\":[{\"name\":\"test\",\"quantity\":1.0,\"price\":1.0,\"discount\":0,\"tax_percent\":\"0.00\"}],\"total\":1.0,\"language\":\"en\",\"notes\":\"\",\"debt\":0,\"total_formatted\":1.0,\"expireInMin\":\"43200\",\"taxAmount\":0.0,\"taxPercent\":0.0,\"request_client_details\":[],\"email_message\":\"\"},\"payment\":{\"is_outgoing\":false,\"payment_type\":\"PURCHASE\",\"amount\":1.0,\"currency\":\"CAD\",\"net_amount\":1.0,\"fee_amount\":0.0,\"pending_amount\":0.0,\"pending_unfreeze_on\":null,\"description\":\"\",\"paid_on\":1743769855,\"remote_paid_on\":1743769855},\"issuer_details\":{\"website\":\"\",\"legal_street_address\":\"\",\"legal_country\":\"\",\"legal_city\":\"\",\"legal_zip_code\":\"\",\"bank_accounts\":[{}],\"legal_name\":\"test6\",\"brand_name\":\"test6\",\"registration_number\":\"\",\"tax_number\":\"\"},\"transaction_data\":{\"payment_method\":\"\",\"flow\":\"payform\",\"extra\":{\"amount\":1.0,\"masked_pan\":\"INTERAC-ETRANSFER\"},\"country\":\"\",\"attempts\":[{\"client_ip\": \"203.0.113.80, 203.0.113.228, 203.0.113.208\",\"type\":\"execute\",\"payment_method\":\"INTERAC-ETRANSFER\",\"flow\":\"payform\",\"successful\":true,\"country\":\"INTERAC-ETRANSFER\",\"processing_time\":1743769855,\"extra\":{\"amount\":1.0,\"masked_pan\":\"INTERAC-ETRANSFER\"}}]},\"status\":\"PAYMENT_IN_PROCESS\",\"status_history\":[{\"status\":\"created\",\"timestamp\":1743769855},{\"status\":\"pending_execute\",\"timestamp\":1743769855},{\"status\":\"payment_in_process\",\"timestamp\":1743769856},{\"status\":\"viewed\",\"timestamp\":1744026697}],\"viewedOn\":1744026697,\"is_test\":false,\"brand_id\":\"your-brand-id\",\"send_receipt\":false,\"is_recurring_token\":false,\"skip_capture\":false,\"reference_generated\":\"PS620\",\"issued\":\"2025-04-04\",\"due\":1743769855,\"refund_upto\":0,\"cc_descriptor\":\"Africhange Technologies\",\"fraudScore\":\"NA\",\"trustScore\":\"NA\",\"payInDetails\":{\"name\":\"INTERAC\",\"emailAddress\":\"user9999@example.com\",\"secretQA\":\"66a8c78af1fc2f768304bce4\",\"secretAnswer\":\"ps8766a8af\"},\"paidOn\":0,\"receivedAmt\":0.0,\"refund_availability\":\"NONE\",\"refundable_amount\":0.0,\"success_redirect\":\"https://your.success.redirect.com\",\"failure_redirect\":\"https://your.failure.redirect.com\",\"cancel_redirect\":\"\",\"success_callback\":\"https://your.success.callback.com\",\"failure_callback\":\"https://your.failure.callback.com\",\"platform\":\"API\",\"created_from_ip\": \"203.0.113.80, 203.0.113.228, 203.0.113.208\",\"checkout_url\":\"https://api.paysecure.net/payments/67efd0ff97be603f97a3a697/\",\"payoutProcess\":false}"}],"_postman_id":"67ae39b6-9f69-4605-bcc5-1fe75be2718a"},{"name":"Get Status","id":"aad280a3-9ad1-4b27-a254-f24fee1d3ca1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer {{APIKey}}","type":"text"}],"url":"https://api.paysecure.net/api/v1/purchases/{purchaseId}/","description":"

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

Note: With respect to bank transfers, the purchase request is synonymous with the PayIn request.

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

Status	Notes
paid	Transaction Successful
payment_in_process	Payment is under Processing
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","urlObject":{"path":["purchases","{purchaseId}",""],"host":["https://api.paysecure.net/api/v1"],"query":[],"variable":[]}},"response":[{"id":"0efd8ffa-0c17-4021-8a2c-2c33b12cf72e","name":"Purchases-success","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer {{APIKey}}"}],"url":"https://api.paysecure.net/api/v1/purchases/{purchaseId}/"},"status":"Accepted","code":202,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"purchaseId\": \"6790e75fa46a5a5bb0b00e55\",\n \"client\": {\n \"customerId\": \"NA\",\n \"email\": \"user5890@example.com\",\n \"phone\": \"+14377717874\",\n \"full_name\": \"Test test\",\n \"date_of_birth\": \"1970-07-10\",\n \"street_address\": \"13 Documentation Way\",\n \"country\": \"CA\",\n \"city\": \"Milford\",\n \"zip_code\": \"68403\",\n \"cc\": [],\n \"bcc\": [],\n \"gender\": \"MALE\",\n \"stateCode\": \"QLD\"\n },\n \"updated_on\": 1737549752,\n \"type\": \"purchase\",\n \"paymentMethod\": \"INTERAC-ETRANSFER\",\n \"amountUnit\": \"MAJOR\",\n \"errorMsg\": \"Transaction succeeded-APPROVED\",\n \"redirectType\": \"GET\",\n \"force_recurring\": false,\n \"created_on\": 1737549663,\n \"merchantRef\": \"6790e75fa46a5a5bb0b00e55\",\n \"merchantName\": \"Skyler Nakamurasinghal\",\n \"purchase\": {\n \"currency\": \"CAD\",\n \"products\": [\n {\n \"name\": \"test\",\n \"quantity\": 1,\n \"price\": 1,\n \"discount\": 0,\n \"tax_percent\": \"0.00\"\n }\n ],\n \"total\": 2,\n \"language\": \"en\",\n \"notes\": \"\",\n \"debt\": 0,\n \"total_formatted\": 1,\n \"expireInMin\": \"43200\",\n \"request_client_details\": [],\n \"email_message\": \"\"\n },\n \"payment\": {\n \"is_outgoing\": false,\n \"payment_type\": \"PURCHASE\",\n \"amount\": 1,\n \"currency\": \"CAD\",\n \"net_amount\": 1,\n \"fee_amount\": 0,\n \"pending_amount\": 0,\n \"pending_unfreeze_on\": null,\n \"description\": \"\",\n \"paid_on\": 1737549663,\n \"remote_paid_on\": 1737549663\n },\n \"issuer_details\": {\n \"website\": \"\",\n \"legal_street_address\": \"\",\n \"legal_country\": \"\",\n \"legal_city\": \"\",\n \"legal_zip_code\": \"\",\n \"bank_accounts\": [\n {}\n ],\n \"legal_name\": \"test6\",\n \"brand_name\": \"test6\",\n \"registration_number\": \"\",\n \"tax_number\": \"\"\n },\n \"transaction_data\": {\n \"payment_method\": \"\",\n \"flow\": \"payform\",\n \"extra\": {\n \"amount\": 1,\n \"masked_pan\": \"INTERAC-ETRANSFER\"\n },\n \"country\": \"\",\n \"attempts\": [\n {\n \"client_ip\": \"203.0.113.128, 203.0.113.179, 203.0.113.62\",\n \"type\": \"execute\",\n \"payment_method\": \"INTERAC-ETRANSFER\",\n \"flow\": \"payform\",\n \"successful\": true,\n \"country\": \"INTERAC\",\n \"processing_time\": 1737549663,\n \"extra\": {\n \"amount\": 1,\n \"masked_pan\": \"INTERAC-ETRANSFER\"\n }\n }\n ]\n },\n \"status\": \"PAID\",\n \"status_history\": [\n {\n \"status\": \"created\",\n \"timestamp\": 1737549663\n },\n {\n \"status\": \"pending_execute\",\n \"timestamp\": 1737549663\n },\n {\n \"status\": \"payment_in_process\",\n \"timestamp\": 1737549664\n },\n {\n \"status\": \"paid 2.0\",\n \"timestamp\": 1737549752\n },\n {\n \"status\": \"viewed\",\n \"timestamp\": 1737549750\n }\n ],\n \"viewedOn\": 1738749942,\n \"is_test\": false,\n \"brand_id\": \"your-brand-id\",\n \"send_receipt\": false,\n \"is_recurring_token\": false,\n \"skip_capture\": false,\n \"reference_generated\": \"PS376\",\n \"issued\": \"2025-01-22\",\n \"due\": 1737549663,\n \"refund_upto\": 0,\n \"cc_descriptor\": \"Africhange Technologies\",\n \"fraudScore\": \"NA\",\n \"trustScore\": \"NA\",\n \"payInDetails\": {\n \"name\": \"INTERAC\",\n \"emailAddress\": \"user6989@example.com\",\n \"secretQA\": \"66a8c78af1fc2f768304bce4\",\n \"secretAnswer\": \"ps8766a8af\"\n },\n \"paidOn\": 1737549752,\n \"receivedAmt\": 2,\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\": \"https://your.success.callback.com\",\n \"failure_callback\": \"https://your.failure.callback.com\",\n \"platform\": \"API\",\n \"created_from_ip\": \"203.0.113.128, 203.0.113.179, 203.0.113.62\",\n \"checkout_url\": \"https://api.paysecure.net/payments/6790e75fa46a5a5bb0b00e55/\",\n \"payoutProcess\": false\n}"},{"id":"9ce00ed1-760b-490a-b8fd-f5701f3b94c2","name":"Purchases Error","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer {{APIKey}}","type":"text"}],"url":"https://api.paysecure.net/api/v1/purchases/{purchaseId}/"},"code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Error Message\",\n \"code\": \"error_code\"\n}"}],"_postman_id":"aad280a3-9ad1-4b27-a254-f24fee1d3ca1"}],"id":"1454c312-da5a-4e59-a1ce-49e9090b8299","description":"

API Flow

\n\n

The merchant initiates the purchase via the create purchase API. If successful, they receive PayIn details along with a checkout URL in the response JSON
\n
The merchant then has 2 options
\n
1. Redirect the end-user to the checkoutURL present in the response, where the customer is shown the following details required to make Interac payments:
  \n
  1. Payment Amount
    \n
  2. Deposit email address
    \n
  3. Secret Question
    \n
  4. Secret Answer
    \n
  \n
2. Retrieve the PayIn details in the response JSON (as shown below) to create a webpage within the merchant’s IT estate, and show to user the PayIn instruction
  \n
\n
After a successful or failed payment by the end user, an appropriate webhook would be sent to the merchant. If option 2a was employed, the user would be redirected to the appropriate success or failure redirect URL.
\n

 \"payInDetails\": {\n        \"name\": \"INTERAC-ETRANSFER\",\n        \"emailAddress\": \"user6989@example.com\",\n        \"secretQA\": \"6789df35bbefe612e3cb4641\",\n        \"secretAnswer\": \"PS7466835\"\n   }\n\n

\n","_postman_id":"1454c312-da5a-4e59-a1ce-49e9090b8299"},{"name":"PayOut API","item":[{"name":"Create PayOut","id":"30bf2068-06d2-40b3-a69e-0e4991a5bc01","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer {{APIKey}}"},{"key":"brandId","value":"your-brand-id","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"client\": {\r\n \"phone\": \"+14378817874\",\r\n \"email\": \"user7850@example.com\",\r\n \"full_name\": \"Casey Novak\",\r\n \"stateCode\": \"CT\",\r\n \"country\": \"CA\",\r\n \"city\": \"Oakdale\",\r\n \"street_address\": \"test test\",\r\n \"zip_code\": \"234567\"\r\n },\r\n \"payoutMethod\": \"PAYOUT-INTERAC-ETRANSFER\",\r\n \"purpose\": \"entertainment\",\r\n \"currency\": \"CAD\",\r\n \"amount\": 5.00,\r\n \"success_redirect\": \"https://your.success.redirect.com\",\r\n \"failure_redirect\": \"https://your.failure.redirect.com\",\r\n \"pending_redirect\": \"https://your.pending.redirect.com\",\r\n \"success_callback\": \"https://your.success.callback.com\",\r\n \"failure_callback\": \"https://your.failure.callback.com\" \r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.paysecure.net/api/v1/payout/","description":"

To Initiate a payment, the very first call to make is /payout/

with the required data in the request body.

To generate a Payout, you are required to provide the API key (in the header) can be located in the Dashboard section of your merchant account login.

The request body structure is shown on the request body of the example request shown here.

The following (see table below) are the mandatory parameters that are required to create a Payout 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

Parameter	Notes
client.email	An Identifier for a user
client.full_name	An Identifier for a user
client.country	CA
payoutMethod	PAYOUT-INTERAC-ETRANSFER
Currency	CAD
Amount	Payout Amount
Purpose	Transfer Reversed

","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"a737b4a8-7a02-436e-a757-3897eff497f1","id":"a737b4a8-7a02-436e-a757-3897eff497f1","name":"PayOut API","type":"folder"}},"urlObject":{"path":["payout",""],"host":["https://api.paysecure.net/api/v1"],"query":[],"variable":[]}},"response":[{"id":"adea5a25-06ea-49d5-b0c0-b74d4c95026d","name":"create payout-success","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer {{APIKey}}","type":"text"},{"key":"brandId","value":"your-brand-id","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"client\": {\r\n \"phone\": \"+14378817874\",\r\n \"email\": \"user7850@example.com\",\r\n \"full_name\": \"Casey Novak\",\r\n \"stateCode\": \"CT\",\r\n \"country\": \"CA\",\r\n \"city\": \"Oakdale\",\r\n \"street_address\": \"test test\",\r\n \"zip_code\": \"234567\"\r\n },\r\n \"payoutMethod\": \"PAYOUT-INTERAC-ETRANSFER\",\r\n \"purpose\": \"entertainment\",\r\n \"currency\": \"CAD\",\r\n \"amount\": 5.00,\r\n \"success_redirect\": \"https://your.success.redirect.com\",\r\n \"failure_redirect\": \"https://your.failure.redirect.com\",\r\n \"pending_redirect\": \"https://your.pending.redirect.com\",\r\n \"success_callback\": \"https://your.success.callback.com\",\r\n \"failure_callback\": \"https://your.failure.callback.com\" \r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.paysecure.net/api/v1/payout/"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"_type\": \"Payout\",\n \"payoutId\": \"69cd1236e36738557e988399\",\n \"client\": {\n \"_type\": \"PClientDetails\",\n \"customerId\": \"NA\",\n \"email\": \"user7850@example.com\",\n \"phone\": \"+14378817874\",\n \"full_name\": \"Blake Mensah\",\n \"date_of_birth\": null,\n \"street_address\": \"test test\",\n \"country\": \"CA\",\n \"city\": \"Oakdale\",\n \"zip_code\": \"234567\",\n \"documentId\": null,\n \"documentType\": null,\n \"spei_clabe\": null,\n \"spei_debitCard\": null,\n \"spei_mobileNo\": null,\n \"stateCode\": \"CT\"\n },\n \"updated_on\": 1775047222,\n \"payoutMethod\": \"PAYOUT-INTERAC-ETRANSFER\",\n \"beneficiaryDetail\": null,\n \"amountUnit\": \"MAJOR\",\n \"amount\": 5,\n \"errorMsg\": \"paid\",\n \"issued\": \"2026-04-01\",\n \"responseMsg\": null,\n \"purpose\": \"Transfer Interac\",\n \"created_on\": 1775047222,\n \"custUniqueId\": \"user5890@example.com\",\n \"amount_in_usd\": 3.6,\n \"merchantRef\": \"69cd1236e36738557e988399\",\n \"instruction\": null,\n \"merchant_id\": null,\n \"usePrivateKey\": null,\n \"merchantName\": null,\n \"agentId\": 0,\n \"parentId\": 0,\n \"whiteId\": 0,\n \"year\": null,\n \"month\": null,\n \"day\": null,\n \"hour\": 12,\n \"bankid\": null,\n \"setCurr\": \"CAD\",\n \"pspReference\": null,\n \"bankmid\": null,\n \"bankname\": null,\n \"status\": \"paid\",\n \"status_history\": [\n {\n \"_type\": \"Status\",\n \"status\": \"created\",\n \"timestamp\": 1775047222,\n \"updatedBy\": null,\n \"paidReason\": null\n },\n {\n \"_type\": \"Status\",\n \"status\": \"paid\",\n \"timestamp\": 1775047239,\n \"updatedBy\": null,\n \"paidReason\": null\n }\n ],\n \"viewedOn\": null,\n \"currency\": \"CAD\",\n \"actionStatus\": {\n \"_type\": \"ApiError\",\n \"message\": null,\n \"actualMessage\": null,\n \"merchantName\": null,\n \"code\": \"success\",\n \"status\": \"paid\",\n \"callback_url\": null,\n \"method\": null,\n \"beneficiaryId\": null,\n \"profileId\": null,\n \"payInBankDetail\": null,\n \"pix_payload\": null,\n \"payInDetails\": {\n \"_type\": \"PayInDetail\",\n \"name\": \"INTERAC E-TRANSFER\",\n \"emailAddress\": \"user5890@example.com\",\n \"secretQA\": \"q691236367385579883992851\",\n \"secretAnswer\": \"a691236367385579883992851\",\n \"reference_number\": null,\n \"payment_method\": null,\n \"transaction_expiry\": null,\n \"qrCode\": null,\n \"gpayUri\": null,\n \"phonepeUri\": null,\n \"paytmUri\": null,\n \"intentUri\": null,\n \"generatedLink\": null,\n \"instruction\": null,\n \"paymentUrl\": null,\n \"script\": null,\n \"clabe\": null,\n \"beneficiary\": null,\n \"amount\": null,\n \"linkExpiresOn\": null,\n \"cardExpiresOn\": null,\n \"subStatus\": null\n },\n \"balance\": null,\n \"vab\": null,\n \"authKey\": null,\n \"methodExecutionTime\": null,\n \"password\": null,\n \"salt\": null,\n \"nextCall\": null,\n \"nextURL\": null,\n \"descriptor\": null,\n \"currentTime\": 1775047239,\n \"custVerificationString\": null,\n \"instructions\": null,\n \"trustScore\": null,\n \"trustLevel\": null,\n \"no_Of_Cust_Hits\": null,\n \"no_Of_Hits\": null,\n \"referer\": null,\n \"clientIp\": null,\n \"merchantIp\": null,\n \"isS2s\": null,\n \"otp\": null,\n \"userDeviceId\": null,\n \"isAllowed\": null,\n \"logo_url\": null,\n \"transactionExpireInMin\": null,\n \"mandateReferenceId\": null\n },\n \"fx_Currency\": null,\n \"fx_Amount\": null,\n \"referer\": null,\n \"clientIp\": \"203.0.113.19\",\n \"merchantIp\": \"203.0.113.19\",\n \"transFees\": null,\n \"MDR\": null,\n \"ruleName\": \"Rule_Not_Applied\",\n \"cascade_Num\": null,\n \"conversionRiskFactorApplied\": null,\n \"feesDeducted\": 0,\n \"signature\": null,\n \"puId\": \"\",\n \"uId\": 0,\n \"authKey\": \"\",\n \"currency_conversion\": null,\n \"success_callback\": \"https://your.success.callback.com\",\n \"failure_callback\": \"https://your.failure.callback.com\",\n \"success_redirect\": \"https://your.success.redirect.com\",\n \"failure_redirect\": \"https://your.failure.redirect.com\",\n \"pending_redirect\": \"https://your.pending.redirect.com\"\n}"},{"id":"66f86329-e8c3-45b5-8ef5-08f02c3fae67","name":"create payout-error","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer {{APIKey}}","type":"text"},{"key":"brandId","value":"your-brand-id","type":"text"}],"body":{"mode":"raw","raw":"{\n \"client\": {\n \"phone\": \"+14378817874\",\n \"email\": \"user7850@example.com\",\n \"full_name\": \"Casey Novak\",\n \"stateCode\": \"CT\",\n \"country\": \"CA\",\n \"city\": \"Oakdale\",\n \"street_address\": \"test test\",\n \"zip_code\": \"234567\"\n },\n \"payoutMethod\": \"PAYOUT-INTERAC-ETRANSFER\",\n \"purpose\": \"entertainment\",\n \"currency\": \"CAD\",\n \"amount\": 5.00,\n \"success_redirect\": \"https://your.success.redirect.com\",\n \"failure_redirect\": \"https://your.failure.redirect.com\",\n \"pending_redirect\": \"https://your.pending.redirect.com\",\n \"success_callback\": \"https://your.success.callback.com\",\n \"failure_callback\": \"https://your.failure.callback.com\" \n}","options":{"raw":{"language":"json"}}},"url":"https://api.paysecure.net/api/v1/payout/"},"code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Insufficient Balance [5.23]\",\n \"code\": \"transaction_error\"\n}"}],"_postman_id":"30bf2068-06d2-40b3-a69e-0e4991a5bc01"},{"name":"Get Status","id":"bd505713-9b9a-4358-89e5-48231cf67211","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.paysecure.net/api/v1/getpayout/{payoutId}/","description":"

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

Mandatory

you need to pass the payoutId 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
payout_in_process	payout is under Processing.
error	Transaction has Failed.

The webhook will only be triggered for paid transactions or errors.

Paid: \"success_callback\": \"https://your.success.callback.com\",

Error: \"failure_callback\": “https://failure.com”

\n","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"a737b4a8-7a02-436e-a757-3897eff497f1","id":"a737b4a8-7a02-436e-a757-3897eff497f1","name":"PayOut API","type":"folder"}},"urlObject":{"path":["getpayout","{payoutId}",""],"host":["https://api.paysecure.net/api/v1"],"query":[],"variable":[]}},"response":[{"id":"c07868e1-9597-4926-af6c-ce7f9261a1bb","name":"Get success Status","originalRequest":{"method":"GET","header":[],"url":"https://api.paysecure.net/api/v1/getpayout/{payoutId}/"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"payoutId\": \"66bf2e76e3defc36cd575481\",\n \"client\": {\n \"customerId\": \"NA\",\n \"email\": \"user5890@example.com\",\n \"phone\": \"+14377717874\",\n \"full_name\": \"Blake Mensah\",\n \"country\": \"CA\"\n },\n \"updated_on\": 1723805728,\n \"payoutMethod\": \"PAYOUT-INTERAC-ETRANSFER\",\n \"amountUnit\": \"MAJOR\",\n \"amount\": 12,\n \"errorMsg\": \"\",\n \"purpose\": \"test payout\",\n \"created_on\": 1723805302,\n \"merchantRef\": \"66bf2e76e3defc36cd575481\",\n \"merchantName\": \"Skyler Nakamurasinghal\",\n \"status\": \"PAID\",\n \"status_history\": [\n {\n \"status\": \"created\",\n \"timestamp\": 1723805302\n },\n {\n \"status\": \"payout_in_process\",\n \"timestamp\": 1723805310\n },\n {\n \"status\": \"paid\",\n \"timestamp\": 1723805728\n },\n {\n \"status\": \"viewed\",\n \"timestamp\": 1738750221\n }\n ],\n \"viewedOn\": 1738750221,\n \"currency\": \"USD\",\n \"paymentOn\": 1723805728,\n \"payOutDetails\": {\n \"name\": \"INTERAC E-TRANSFER\",\n \"emailAddress\": \"user5890@example.com\",\n \"secretQA\": \"q66276336575481202\",\n \"secretAnswer\": \"a66276336575481202\"\n },\n \"success_callback\": \"https://your.success.callback.com\",\n \"failure_callback\": \"https://your.failure.callback.com\"\n}"},{"id":"1e1a5f48-316d-4e0a-bc7a-38b5eed75024","name":"Get Error Status","originalRequest":{"method":"GET","header":[],"url":"https://api.paysecure.net/api/v1/getpayout/{payoutId}/"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Error Message\",\n \"code\": \"error_code\"\n}"}],"_postman_id":"bd505713-9b9a-4358-89e5-48231cf67211"}],"id":"a737b4a8-7a02-436e-a757-3897eff497f1","description":"

API Flow

\n\n

The merchant initiates a PayOut via the payout API.
\n
After a successful or failed payment attempt, the status is reflected on the response, and the details on the status history. You can also get the status through getStatus (purchases/{payID}) API.
\n

API for checking available balance

URL :- /getBalance/
\n
RequestType: POST
\n
Request Body
\n

Note: Currency is not a mandatory parameter. If no parameter is specified then all respective currency balances would be provided, if any specific currency parameter is provided then only that currency balance would be provided.

\n","urlObject":{"path":["getBalance"],"host":["https://api.paysecure.net/api/v1"],"query":[],"variable":[]}},"response":[{"id":"d5977de1-c998-4a54-a70d-8b35b0502dd4","name":"Checking Balance payout-success","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{ \r\n \"paymentMethod\" : \"INTERAC-ETRANSFER\"\r\n}\r\n","options":{"raw":{"language":"json"}}},"url":"https://api.paysecure.net/api/v1/getBalance"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"paymentMethod\": \"INTERAC-ETRANSFER\",\n \"status\": \"success\",\n \"data\": [\n {\n \"currency\": \"AUD\",\n \"balance\": \"0.00\"\n },\n {\n \"currency\": \"BRL\",\n \"balance\": \"0.00\"\n },\n {\n \"currency\": \"EUR\",\n \"balance\": \"0.00\"\n },\n {\n \"currency\": \"INR\",\n \"balance\": \"0.00\"\n },\n {\n \"currency\": \"JPY\",\n \"balance\": \"0.00\"\n },\n {\n \"currency\": \"USD\",\n \"balance\": \"0.00\"\n }\n ]\n}"},{"id":"92c15551-e3ce-43a1-b9b5-6a065528151a","name":"Checking Balance payout-error","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{ \r\n \"paymentMethod\" : \"INTERAC-ETRANSFER\"\r\n}\r\n","options":{"raw":{"language":"json"}}},"url":"https://api.paysecure.net/api/v1/getBalance"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Error Message\",\n \"code\": \"No currency account found\"\n}"}],"_postman_id":"e1d14a2d-3896-43e2-976c-08875cd1ea7a"}],"id":"9f199b26-8ab9-4025-ad36-51df5e257da9","_postman_id":"9f199b26-8ab9-4025-ad36-51df5e257da9","description":""}],"id":"53d0b3f2-c992-4b5b-a8d4-54710449be7f","_postman_id":"53d0b3f2-c992-4b5b-a8d4-54710449be7f","description":""},{"name":"🇨🇦 Interac Request Money","item":[{"name":"Concepts","item":[],"id":"9c35cdf5-bd62-4ca4-94c2-2692a083e58b","description":"

PayIn Flows

How It Works

With Interac Request Money, payments are made seamless and secure. Customers are provided with a deposit link upon initiating a transaction on the merchant's website. They are redirected to a secure payment page, where their bank is selected, and the payment is completed effortlessly. Payments are processed instantly, ensuring real-time confirmation and updates. This method enhances the checkout experience, builds customer trust, and increases conversions, making it an ideal choice for businesses seeking a reliable payment solution.

Key Steps

\n\n

Flow

Initiate Transfer Request: Upon the custeomer's intent to pay, the merchant calls the /purchases API with INTERAC-REQUEST-MONEY in the Payment Method Param, to initiate a PayIn (deposit/collections) transaction. This request includes the customerʼs email address, mobile number, the amount to be collected, and an optional message. With this method, the customer do not need any security question and answer to proceed with the payment.
\n
Deposit Link:
\n
1. A unique deposit link is generated and presented to the customer. This link will be valid for 24 hrs. This time cannot be changed.
\n
Redirection to Payment Page:
\n
1. The customer is redirected to the deposit link and shown payment details:
  \n
  1. Amount due.
    \n
  2. A list of supported banks.
    \n
  \n
\n
Bank Selection:
\n
1. The customer selects their bank from a dropdown menu.
  \n
2. They are redirected to their banking portal.
  \n
\n
Payment Confirmation:
\n
1. The customer logs into their banking portal
  \n
2. Completes the payment on their banking app/website.
  \n
3. Instant payment confirmation is displayed on the merchant’s website.
  \n
4. The customer’s balance is updated.
  \n
\n

PayOut flows

How it works

Paysecure offers the ability to make payouts to customers', individuals', or
businesses' bank accounts using Interac e-Transfers. Whether for refunds,
rewards, or other types of disbursements, the Interac Payouts API ensures
efficient and reliable transactions, supporting real-time fund transfers and
comprehensive transaction tracking.

Key Steps

\n\n

Flow

Initiate Payout Request: The merchant calls /payout API. This request includes the customerʼs email address or mobile number, the amount to be transferred, and an optional message. the Payout Method is PAYOUT-INTERAC-REQUEST-MONEY.
\n
Generate Security Question & Answer (Optional): If necessary, the merchant can show the security question and answer (received in the response) that the customer may need to provide to receive the funds, adding an extra layer of security.
\n
Send Notification: The customer receives an email notification with payout instructions. If the customerʼs Interac auto deposit is turned on, the funds will automatically be deposited to the customerʼs designated account, without needing to enter the security question and answer.
\n
1. If customer's auto-deposit is turned off, The customer logs into their banking portal, follow the payment instructions and completes the payment.
\n
Confirm Payout Completion: Upon successful payout, a success webhook will be received, with information about the transaction along with the status.
\n
Update Merchantʼs Account: The merchantʼs system updates the customerʼs account balance to reflect the withdrawn funds.
\n

Transaction Limits:

Pay Ins:

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

Criteria	Min Amount	Max Amount
Per Transaction	0.01 CAD	3,000 CAD
Per Day	0.01 CAD	3,000 CAD
Per User (over a 7 day rolling period)	0.01 CAD	10,000 CAD
Per Month (over a 30 day rolling period)	0.01 CAD	20,000 CAD

Pay Outs:

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

Criteria	Min Amount	Max Amount
Per Transaction	10 CAD	3,000 CAD
Per Day	10 CAD	10,000 CAD
Per User (over a 7 day rolling period)	10 CAD	70,000 CAD
Per Month (over a 30 day rolling period)	10 CAD	100,000 CAD

","auth":{"type":"noauth","isInherited":false},"event":[{"listen":"prerequest","script":{"type":"text/javascript","packages":{},"requests":{},"exec":[""],"id":"0eb2d008-67a1-4c88-a07e-cd34649474e5"}},{"listen":"test","script":{"type":"text/javascript","packages":{},"requests":{},"exec":[""],"id":"7d7cc118-dc4c-4dea-a3b9-5115292d400d"}}],"_postman_id":"9c35cdf5-bd62-4ca4-94c2-2692a083e58b"},{"name":"PayIn API","item":[{"name":"Create Purchase","id":"e67b9344-cd56-4137-9dbb-9eeb1c60afa7","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer {{APIKey}}"}],"body":{"mode":"raw","raw":"{\r\n \"client\": {\r\n \"email\": \"user5890@example.com\",\r\n \"street_address\": \"13 Documentation Way\",\r\n \"city\": \"Milford\",\r\n \"full_name\": \"Test test\",\r\n \"zip_code\": \"68403\",\r\n \"country\": \"CA\",\r\n \"stateCode\": \"QLD\",\r\n \"phone\": \"+447755564318\",\r\n \"gender\": \"MALE\",\r\n \"date_of_birth\": \"1970-07-10\"\r\n },\r\n \"purchase\": {\r\n \"currency\": \"CAD\",\r\n \"products\": [\r\n {\r\n \"name\": \"test \",\r\n \"price\": 1\r\n }\r\n ]\r\n },\r\n \"paymentMethod\": \"INTERAC-REQUEST-MONEY\",\r\n \"brand_id\": \"your-brand-id\",\r\n \"success_redirect\": \"https://your.success.redirect.com\",\r\n \"failure_redirect\": \"https://your.failure.redirect.com\",\r\n \"success_callback\": \"https://your.success.callback.com\",\r\n \"failure_callback\": \"https://your.failure.callback.com\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.paysecure.net/api/v1/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	An Identifier for a user
client.city
client.country	ISO-3166 Country Code. It must be upper case. This should be \"CA\" for Interac
client.stateCode	Example “AL”, “XZ”.. Must be in upper case.
client.street_address
client.zip_code
client.phone
client.full_name
purchase.currency	ISO 4217 code for currency you want to send the transaction in. This should be 'CAD' for Interac
purchase.products.name
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
failure_redirect	URL to send the user if the transactions is UNSUCCESSFUL

Optional Parameters

expireInMin

This parameter, when passed in the PayIn request, sets the time window within which a customer should make the Interac payment through their bank's app. If a customer doesn't complete the payment within the configured time window, the status of the payment will be marked as 'EXPIRED' in Paysecure.

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.

paymentMethod

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\n\n\n\n\n\n\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	Description
Invalid format of Date_of_Birth[allowed format: yyyy-mm-dd]
Enter Valid Email
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
Minimum amount is not set for this merchant
success_redirect/failure_redirect/brand_id is missing
brand_id cannot be null
success_redirect cannot be null
failure_redirect cannot be null
Invalid failure_redirect: minimum 10 characters
purchase.products.price cannot be null
purchase.products[0].name/purchase.products[0].price are missing
Your charges setting is incomplete .Plese Contact to Administrator.
Currency \"{curr_name}\" is Not Allowed
Transaction amount must be equal or greater to minimum trans amount
Allowed Limit for this card for particular time period has been consumed

Note: For certain use cases, in addition to long format purchase Id, Paysecure also provides a 7 digit unique code for each purchase starting with digit 4, eg 4000001

“purchaseIdShortCode”: “4000013\"

\n","urlObject":{"path":["purchases",""],"host":["https://api.paysecure.net/api/v1"],"query":[],"variable":[]}},"response":[{"id":"4a5d0be3-66c1-4731-904e-5d0b2767cf4b","name":"Success","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer {{APIKey}}"}],"body":{"mode":"raw","raw":"{\r\n \"client\": {\r\n \"email\": \"user5890@example.com\",\r\n \"street_address\": \"13 Documentation Way\",\r\n \"city\": \"Milford\",\r\n \"full_name\": \"Test test\",\r\n \"zip_code\": \"68403\",\r\n \"country\": \"CA\",\r\n \"stateCode\": \"QLD\",\r\n \"phone\": \"+447755564318\",\r\n \"gender\": \"MALE\",\r\n \"date_of_birth\": \"1970-07-10\"\r\n },\r\n \"purchase\": {\r\n \"currency\": \"CAD\",\r\n \"products\": [\r\n {\r\n \"name\": \"test \",\r\n \"price\": 1\r\n }\r\n ]\r\n },\r\n \"paymentMethod\": \"INTERAC-REQUEST-MONEY\",\r\n \"brand_id\": \"your-brand-id\",\r\n \"success_redirect\": \"https://your.success.redirect.com\",\r\n \"failure_redirect\": \"https://your.failure.redirect.com\",\r\n \"success_callback\": \"https://your.success.callback.com\",\r\n \"failure_callback\": \"https://your.failure.callback.com\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.paysecure.net/api/v1/purchases"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"purchaseId\": \"670cb0affcc7f4706acb65e0\",\n \"client\": {\n \"email\": \"user5890@example.com\",\n \"phone\": \"+447755564318\",\n \"full_name\": \"Test test\",\n \"date_of_birth\": \"1970-07-10\",\n \"street_address\": \"13 Documentation Way\",\n \"country\": \"CA\",\n \"city\": \"Milford\",\n \"zip_code\": \"68403\",\n \"cc\": [],\n \"bcc\": [],\n \"gender\": \"MALE\",\n \"avatarUrl\": \"https://res.cloudinary.com/w22/image/upload/v1663783641/photos/currencies/ngn.png\",\n \"stateCode\": \"QLD\"\n },\n \"updated_on\": 1728884911,\n \"type\": \"purchase\",\n \"paymentMethod\": \"INTERAC-REQUEST-MONEY\",\n \"amountUnit\": \"MAJOR\",\n \"errorMsg\": \"\",\n \"redirectType\": \"POST\",\n \"force_recurring\": false,\n \"created_on\": 1728884911,\n \"merchantRef\": \"670cb0affcc7f4706acb65e0\",\n \"merchantName\": \"ajay03\",\n \"purchase\": {\n \"currency\": \"CAD\",\n \"products\": [\n {\n \"name\": \"test\",\n \"quantity\": 1,\n \"price\": 1,\n \"discount\": 0,\n \"tax_percent\": \"0.00\"\n }\n ],\n \"total\": 1,\n \"language\": \"en\",\n \"notes\": \"\",\n \"debt\": 0,\n \"total_formatted\": 1,\n \"expireInMin\": \"1440\",\n \"request_client_details\": [],\n \"email_message\": \"\"\n },\n \"payment\": {\n \"is_outgoing\": false,\n \"payment_type\": \"PURCHASE\",\n \"amount\": 1,\n \"currency\": \"CAD\",\n \"net_amount\": 1,\n \"fee_amount\": 0,\n \"pending_amount\": 0,\n \"pending_unfreeze_on\": null,\n \"description\": \"\",\n \"paid_on\": 1728884911,\n \"remote_paid_on\": 1728884911\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\": \"r4\",\n \"brand_name\": \"r4\",\n \"registration_number\": \"\",\n \"tax_number\": \"\"\n },\n \"transaction_data\": {\n \"payment_method\": \"\",\n \"flow\": \"payform\",\n \"extra\": {\n \"amount\": 1,\n \"masked_pan\": \"INTERAC-DEBIT\"\n },\n \"country\": \"\",\n \"attempts\": [\n {\n \"client_ip\": \"203.0.113.26\",\n \"type\": \"execute\",\n \"payment_method\": \"INTERAC-DEBIT\",\n \"flow\": \"payform\",\n \"successful\": true,\n \"country\": \"INTERAC-DEBIT\",\n \"processing_time\": 1728884911,\n \"extra\": {\n \"amount\": 1,\n \"masked_pan\": \"INTERAC-DEBIT\"\n }\n }\n ]\n },\n \"status\": \"PAYMENT_IN_PROCESS\",\n \"status_history\": [\n {\n \"status\": \"created\",\n \"timestamp\": 1728884911\n },\n {\n \"status\": \"pending_execute\",\n \"timestamp\": 1728884911\n },\n {\n \"status\": \"payment_in_process\",\n \"timestamp\": 1728884911\n }\n ],\n \"is_test\": false,\n \"brand_id\": \"your-brand-id\",\n \"send_receipt\": false,\n \"is_recurring_token\": false,\n \"skip_capture\": false,\n \"reference_generated\": \"PS3\",\n \"issued\": \"2024-10-14\",\n \"due\": 1728884911,\n \"refund_upto\": 1744433315,\n \"cc_descriptor\": \"\",\n \"fraudScore\": \"NA\",\n \"trustScore\": \"NA\",\n \"refund_availability\": \"NONE\",\n \"refundable_amount\": 1,\n \"success_redirect\": \"https://your.success.redirect.com\",\n \"failure_redirect\": \"https://your.failure.redirect.com\",\n \"cancel_redirect\": \"\",\n \"success_callback\": \"https://your.success.callback.com\",\n \"failure_callback\": \"https://your.failure.callback.com\",\n \"platform\": \"API\",\n \"created_from_ip\": \"203.0.113.26\",\n \"checkout_url\": \"https://api.paysecure.net/payments/670cb0affcc7f4706acb65e0/\",\n \"payoutProcess\": false\n}"},{"id":"975089e9-7024-493b-bfac-3e93e6bbdd9c","name":"Failure","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer {{APIKey}}"}],"body":{"mode":"raw","raw":"{\n \"client\": {\n \"email\": \"user5890@example.com\",\n \"street_address\": \"13 Documentation Way\",\n \"city\": \"Milford\",\n \"full_name\": \"Test test\",\n \"zip_code\": \"68403\",\n \"country\": \"CA\",\n \"stateCode\": \"QLD\",\n \"phone\": \"+447755564318\",\n \"gender\": \"MALE\",\n \"date_of_birth\": \"1970-07-10\"\n },\n \"purchase\": {\n \"currency\": \"CAD\",\n \"products\": [\n {\n \"name\": \"test \",\n \"price\": 1\n }\n ]\n },\n \"paymentMethod\": \"INTERAC-REQUEST-MONEY\",\n \"brand_id\": \"your-brand-id\",\n \"success_redirect\": \"https://your.success.redirect.com\",\n \"failure_redirect\": \"https://your.failure.redirect.com\",\n \"success_callback\": \"https://your.success.callback.com\",\n \"failure_callback\": \"https://your.failure.callback.com\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.paysecure.net/api/v1/purchases"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Error Message\",\n \"code\": \"error_code\"\n}"}],"_postman_id":"e67b9344-cd56-4137-9dbb-9eeb1c60afa7"},{"name":"Get Status","id":"c35f5043-8fec-42a5-b410-c12cda59b9ec","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer {{APIKey}}","type":"text"}],"url":"https://api.paysecure.net/api/v1/purchases/{purchaseId}/","description":"

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

Note: With respect to bank transfers, the purchase request is synonymous with the PayIn request.

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

Status	Notes
paid	Transaction Successful
payment_in_process	Payment is under Processing
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","urlObject":{"path":["purchases","{purchaseId}",""],"host":["https://api.paysecure.net/api/v1"],"query":[],"variable":[]}},"response":[{"id":"c2d4bf72-6a17-40b3-8c07-647275c788fe","name":"Success","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer {{APIKey}}"}],"url":"https://api.paysecure.net/api/v1/purchases/{purchaseId}/"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\r\n \"purchaseId\": \"670cb0affcc7f4706acb65e0\",\r\n \"client\": {\r\n \"email\": \"user5890@example.com\",\r\n \"phone\": \"+447755564318\",\r\n \"full_name\": \"Test test\",\r\n \"date_of_birth\": \"1970-07-10\",\r\n \"street_address\": \"13 Documentation Way\",\r\n \"country\": \"CA\",\r\n \"city\": \"Milford\",\r\n \"zip_code\": \"68403\",\r\n \"cc\": [],\r\n \"bcc\": [],\r\n \"gender\": \"MALE\",\r\n \"avatarUrl\": \"https://res.cloudinary.com/w22/image/upload/v1663783641/photos/currencies/ngn.png\",\r\n \"stateCode\": \"QLD\"\r\n },\r\n \"updated_on\": 1728884911,\r\n \"type\": \"purchase\",\r\n \"paymentMethod\": \"INTERAC-REQUEST-MONEY\",\r\n \"amountUnit\": \"MAJOR\",\r\n \"errorMsg\": \"\",\r\n \"redirectType\": \"POST\",\r\n \"force_recurring\": false,\r\n \"created_on\": 1728884911,\r\n \"merchantRef\": \"670cb0affcc7f4706acb65e0\",\r\n \"merchantName\": \"ajay03\",\r\n \"purchase\": {\r\n \"currency\": \"CAD\",\r\n \"products\": [\r\n {\r\n \"name\": \"test\",\r\n \"quantity\": 1,\r\n \"price\": 1,\r\n \"discount\": 0,\r\n \"tax_percent\": \"0.00\"\r\n }\r\n ],\r\n \"total\": 1,\r\n \"language\": \"en\",\r\n \"notes\": \"\",\r\n \"debt\": 0,\r\n \"total_formatted\": 1,\r\n \"expireInMin\": \"1440\",\r\n \"request_client_details\": [],\r\n \"email_message\": \"\"\r\n },\r\n \"payment\": {\r\n \"is_outgoing\": false,\r\n \"payment_type\": \"PURCHASE\",\r\n \"amount\": 1,\r\n \"currency\": \"CAD\",\r\n \"net_amount\": 1,\r\n \"fee_amount\": 0,\r\n \"pending_amount\": 0,\r\n \"pending_unfreeze_on\": null,\r\n \"description\": \"\",\r\n \"paid_on\": 1728884911,\r\n \"remote_paid_on\": 1728884911\r\n },\r\n \"issuer_details\": {\r\n \"website\": \"\",\r\n \"legal_street_address\": \"\",\r\n \"legal_country\": \"\",\r\n \"legal_city\": \"\",\r\n \"legal_zip_code\": \"\",\r\n \"bank_accounts\": [\r\n {}\r\n ],\r\n \"legal_name\": \"r4\",\r\n \"brand_name\": \"r4\",\r\n \"registration_number\": \"\",\r\n \"tax_number\": \"\"\r\n },\r\n \"transaction_data\": {\r\n \"payment_method\": \"\",\r\n \"flow\": \"payform\",\r\n \"extra\": {\r\n \"amount\": 1,\r\n \"masked_pan\": \"INTERAC-DEBIT\"\r\n },\r\n \"country\": \"\",\r\n \"attempts\": [\r\n {\r\n \"client_ip\": \"203.0.113.26\",\r\n \"type\": \"execute\",\r\n \"payment_method\": \"INTERAC-DEBIT\",\r\n \"flow\": \"payform\",\r\n \"successful\": true,\r\n \"country\": \"INTERAC-DEBIT\",\r\n \"processing_time\": 1728884911,\r\n \"extra\": {\r\n \"amount\": 1,\r\n \"masked_pan\": \"INTERAC-DEBIT\"\r\n }\r\n }\r\n ]\r\n },\r\n \"status\": \"PAID\",\r\n \"status_history\": [\r\n {\r\n \"status\": \"created\",\r\n \"timestamp\": 1728884911\r\n },\r\n {\r\n \"status\": \"pending_execute\",\r\n \"timestamp\": 1728884911\r\n },\r\n {\r\n \"status\": \"payment_in_process\",\r\n \"timestamp\": 1728884911\r\n },\r\n {\r\n \"status\": \"paid\",\r\n \"timestamp\": 1728884911\r\n }\r\n ],\r\n \"is_test\": false,\r\n \"brand_id\": \"your-brand-id\",\r\n \"send_receipt\": false,\r\n \"is_recurring_token\": false,\r\n \"skip_capture\": false,\r\n \"reference_generated\": \"PS3\",\r\n \"issued\": \"2024-10-14\",\r\n \"due\": 1728884911,\r\n \"refund_upto\": 1744433315,\r\n \"cc_descriptor\": \"\",\r\n \"fraudScore\": \"NA\",\r\n \"trustScore\": \"NA\",\r\n \"refund_availability\": \"NONE\",\r\n \"refundable_amount\": 1,\r\n \"success_redirect\": \"https://your.success.redirect.com\",\r\n \"failure_redirect\": \"https://your.failure.redirect.com\",\r\n \"cancel_redirect\": \"\",\r\n \"success_callback\": \"https://your.success.callback.com\",\r\n \"failure_callback\": \"https://your.failure.callback.com\",\r\n \"platform\": \"API\",\r\n \"created_from_ip\": \"203.0.113.26\",\r\n \"checkout_url\": \"https://api.paysecure.net/payments/670cb0affcc7f4706acb65e0/\",\r\n \"payoutProcess\": false\r\n}"},{"id":"17000a4c-c010-4b0a-a5ee-4cb0b54a34b6","name":"Failure","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer {{APIKey}}","type":"text"}],"url":"https://api.paysecure.net/api/v1/purchases/{purchaseId}/"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Error Message\",\n \"code\": \"error_code\"\n}"}],"_postman_id":"c35f5043-8fec-42a5-b410-c12cda59b9ec"}],"id":"62936761-a0b5-4c77-afb5-8860bdcd950d","description":"

API Flow

\n\n

The merchant calls the INTERAC-REQUEST-MONEY /purchases API to initiate a Payin (deposit/collections) transaction.
\n
Payment link is generated, and customer is redirected to follow the payment instructions.
\n
After successful or failed payment by the end user, an appropriate webhook would be sent back to the merchant.
\n

\n","_postman_id":"62936761-a0b5-4c77-afb5-8860bdcd950d","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"35039738-2093-4b0b-ad45-a684b72648c3","id":"35039738-2093-4b0b-ad45-a684b72648c3","name":"🇨🇦 Interac Request Money","type":"folder"}}},{"name":"PayOut API","item":[{"name":"Create PayOut","id":"bf0ec462-8dcd-4b80-b015-d25e6957c570","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer {{APIKey}}"},{"key":"brandId","value":"your-brand-id","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"client\": {\r\n \"email\": \"user5890@example.com\",\r\n \"country\": \"CA\",\r\n \"phone\": \"+14377717874\",\r\n \"full_name\": \"Blake Mensah\"\r\n },\r\n \"purpose\": \"Transfer Reversed\",\r\n \"currency\": \"CAD\",\r\n \"payoutMethod\": \"PAYOUT-INTERAC-REQUEST-MONEY\",\r\n \"amount\": 1,\r\n \"success_callback\": \"https://your.success.callback.com\",\r\n \"failure_callback\": \"https://your.failure.callback.com\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.paysecure.net/api/v1/payout/","description":"

To Initiate a payment, the very first call to make is /payout/

with the required data in the request body.

To generate a Payout, you are required to provide the API key (in the header) can be located in the Dashboard section of your merchant account login.

The request body structure is shown on the request body of the example request shown here.

The following (see table below) are the mandatory parameters that are required to create a Payout 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

Parameter	Notes
client.email or client.phone	An Identifier for a user
client.full_name	Full Name of the user
client.country	CA
payoutMethod	PAYOUT-INTERAC-REQUEST-MONEY
Currency	Note this is currency account for which you have balance
Amount	amount in CAD
Purpose	eg. \"Transfer Reversed\"

","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"3183553b-d5a7-4319-a023-c5ea4e0c76dc","id":"3183553b-d5a7-4319-a023-c5ea4e0c76dc","name":"PayOut API","type":"folder"}},"urlObject":{"path":["payout",""],"host":["https://api.paysecure.net/api/v1"],"query":[],"variable":[]}},"response":[{"id":"c1e54a6b-f8f4-43c4-a52c-1d5932c52c2e","name":"Success","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer {{APIKey}}","type":"text"},{"key":"brandId","value":"your-brand-id","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"client\": {\r\n \"email\": \"user5890@example.com\",\r\n \"country\": \"CA\",\r\n \"phone\": \"+14377717874\",\r\n \"full_name\": \"Avery Larsen\"\r\n },\r\n \"purpose\": \"test payout\",\r\n \"currency\": \"CAD\",\r\n \"payoutMethod\": \"PAYOUT-INTERAC-REQUEST-MONEY\",\r\n \"amount\": 10,\r\n \"success_callback\": \"https://your.success.callback.com\",\r\n \"failure_callback\": \"https://your.failure.callback.com\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.paysecure.net/api/v1/payout/"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"payoutId\": \"670cb200fcc7f4706acb6759\",\n \"client\": {\n \"email\": \"user5890@example.com\",\n \"phone\": \"+14377717874\",\n \"full_name\": \"Blake Mensah\",\n \"country\": \"CA\"\n },\n \"updated_on\": 1728885248,\n \"payoutMethod\": \"PAYOUT-INTERAC-REQUEST-MONEY\",\n \"amountUnit\": \"MAJOR\",\n \"amount\": 1,\n \"errorMsg\": \"\",\n \"purpose\": \"test payout\",\n \"created_on\": 1728885248,\n \"merchantRef\": \"670cb200fcc7f4706acb6759\",\n \"status\": \"PAYOUT_IN_PROCESS\",\n \"status_history\": [\n {\n \"status\": \"created\",\n \"timestamp\": 1728885248\n },\n {\n \"status\": \"payout_in_process\",\n \"timestamp\": 1728885253\n }\n ],\n \"currency\": \"CAD\",\n \"paymentOn\": 0,\n \"payOutDetails\": {\n \"emailAddress\": \"user5890@example.com\",\n \"secretQA\": \"q670200747066759362\",\n \"secretAnswer\": \"a670200747066759362\"\n },\n \"success_callback\": \"https://your.success.callback.com\",\n \"failure_callback\": \"https://your.failure.callback.com\"\n}"},{"id":"7cde07d3-80fc-4a2d-b0a8-c16face0e777","name":"Failure","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer {{APIKey}}","type":"text"},{"key":"brandId","value":"your-brand-id","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"client\": {\r\n \"email\": \"user5890@example.com\",\r\n \"country\": \"CA\",\r\n \"phone\": \"+14377717874\",\r\n \"full_name\": \"Avery Larsen\"\r\n },\r\n \"purpose\": \"test payout\",\r\n \"currency\": \"CAD\",\r\n \"payoutMethod\": \"PAYOUT-INTERAC-REQUEST-MONEY\",\r\n \"amount\": 10,\r\n \"success_callback\": \"https://your.success.callback.com\",\r\n \"failure_callback\": \"https://your.failure.callback.com\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.paysecure.net/api/v1/payout/"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Error Message\",\n \"code\": \"error_code\"\n}"}],"_postman_id":"bf0ec462-8dcd-4b80-b015-d25e6957c570"},{"name":"Get Status","id":"dd562716-254c-4e33-9efe-5b09d7be9e65","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.paysecure.net/api/v1/getpayout/{payoutId}/","description":"

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

Mandatory

you need to pass the payoutId 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
payout_in_process	payout is under Processing.
error	Transaction has Failed.

The webhook will only be triggered for paid transactions or errors.

Paid: \"success_callback\": \"https://your.success.callback.com\",

Error: \"failure_callback\": “https://failure.com”

\n","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"3183553b-d5a7-4319-a023-c5ea4e0c76dc","id":"3183553b-d5a7-4319-a023-c5ea4e0c76dc","name":"PayOut API","type":"folder"}},"urlObject":{"path":["getpayout","{payoutId}",""],"host":["https://api.paysecure.net/api/v1"],"query":[],"variable":[]}},"response":[{"id":"a15567e0-93db-4762-8658-8fe07f7c2370","name":"Get success Status","originalRequest":{"method":"GET","header":[],"url":"https://api.paysecure.net/api/v1/getpayout/{payoutId}/"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"payoutId\": \"670926784600a76f8d8a1b43\",\n \"client\": {\n \"email\": \"user5890@example.com\",\n \"phone\": \"+14377717874\",\n \"full_name\": \"Blake Mensah\",\n \"country\": \"CA\"\n },\n \"updated_on\": 1728653103,\n \"payoutMethod\": \"PAYOUT-INTERAC-DEBIT\",\n \"amountUnit\": \"MAJOR\",\n \"amount\": 1,\n \"errorMsg\": \"\",\n \"purpose\": \"test payout\",\n \"created_on\": 1728652920,\n \"merchantRef\": \"670926784600a76f8d8a1b43\",\n \"merchantName\": \"Ajay002\",\n \"status\": \"PAID\",\n \"status_history\": [\n {\n \"status\": \"created\",\n \"timestamp\": 1728652920\n },\n {\n \"status\": \"payout_in_process\",\n \"timestamp\": 1728652924\n },\n {\n \"status\": \"paid\",\n \"timestamp\": 1728653103\n },\n {\n \"status\": \"viewed\",\n \"timestamp\": 1729154507\n }\n ],\n \"viewedOn\": 1729154507,\n \"currency\": \"CAD\",\n \"paymentOn\": 1728653103,\n \"payOutDetails\": {\n \"emailAddress\": \"user5890@example.com\",\n \"secretQA\": \"q6709267846007688143362\",\n \"secretAnswer\": \"a6709267846007688143362\"\n },\n \"success_callback\": \"https://your.success.callback.com\",\n \"failure_callback\": \"https://your.failure.callback.com\"\n}"},{"id":"499e5809-2e89-4087-b3ac-c50e4ef164ff","name":"Get Error Status","originalRequest":{"method":"GET","header":[],"url":"https://api.paysecure.net/api/v1/getpayout/{payoutId}/"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Error Message\",\n \"code\": \"error_code\"\n}"}],"_postman_id":"dd562716-254c-4e33-9efe-5b09d7be9e65"}],"id":"3183553b-d5a7-4319-a023-c5ea4e0c76dc","description":"

API Flow

\n\n

The merchant initiates a PayOut via the payout API.
\n
Retrieve the PayOut details in the response JSON, where the customer is shown the following details required to make Interac payout: Security Question, Security Answer
\n
After a successful or failed payment attempt, the status is reflected on the response, and the details of the status history. You can also get the status through getStatus (purchases/{payID}) API.
\n

API for Checking Balance payout

URL :- /getBalance/
\n
RequestType: POST
\n
Request Body
\n

\n","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"633b0099-9e11-46e0-bccf-6d5a4d69f6bf","id":"633b0099-9e11-46e0-bccf-6d5a4d69f6bf","name":"Get Balance API","type":"folder"}},"urlObject":{"path":["getBalance"],"host":["https://api.paysecure.net/api/v1"],"query":[],"variable":[]}},"response":[{"id":"707465cd-2bc1-4c37-a517-91d874bef205","name":"Success","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\r\n \"paymentMethod\": \"INTERAC-REQUEST-MONEY\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.paysecure.net/api/v1/getBalance"},"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":"{\r\n \"currency\": \"CAD\",\r\n \"balance\": \"2.22\",\r\n \"paymentMethod\": \"INTERAC-REQUEST-MONEY\",\r\n \"status\": \"success\"\r\n}"},{"id":"532f74f0-bfff-4e82-9b31-55e00cecc870","name":"Failure","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\r\n \"paymentMethod\": \"INTERAC-REQUEST-MONEY\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.paysecure.net/api/v1/getBalance"},"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":"{\r\n \"message\": \"Error Message\",\r\n \"code\": \"No currency account found\"\r\n}"}],"_postman_id":"927ac195-8d67-4236-8a0f-f23f11a0368d"}],"id":"633b0099-9e11-46e0-bccf-6d5a4d69f6bf","auth":{"type":"noauth","isInherited":false},"event":[{"listen":"prerequest","script":{"type":"text/javascript","packages":{},"requests":{},"exec":[""],"id":"797fd015-c6e9-4f35-9aba-a54385ffd2a9"}},{"listen":"test","script":{"type":"text/javascript","packages":{},"requests":{},"exec":[""],"id":"33eabc8f-0330-4294-9c5c-128fedd9ef08"}}],"_postman_id":"633b0099-9e11-46e0-bccf-6d5a4d69f6bf","description":""}],"id":"35039738-2093-4b0b-ad45-a684b72648c3","description":"

Interac Request Money Overview

Interac is a leading Canadian payment network that facilitates secure, real-time transactions between bank accounts. It offers multiple payment methods, including Request Money.

Interac Request Money method allows users to send and receive money directly between bank accounts using payment link. It provides a fast, secure, and convenient alternative to traditional payment methods, accessible through most Canadian banks' online and mobile banking platforms.

Interac Request Money payment suite enables merchants to initiate:

PayIns: Consumers can utilise Interac e-Transfer to transfer funds from their bank account, through their bank’s app or website.
\n
Payouts: Facilitate real-time disbursements directly to consumers' accounts.
\n

Customer Payment Journey

Merchant creates a payment request via Paysecure API and receives a Reference ID.
\n
Customer is shown the Reference ID, the recipient email/mobile, and the exact amount.
\n
Customer logs into their bank and initiates a transfer using these details.
\n
Customer must input the Reference ID in the message/memo field of the transfer.
\n
Paysecure matches the Reference ID and the payment amount to validate the transaction.
\n

Edge Cases

Incorrect or Missing Reference ID: Payment cannot be matched. The transaction will not be marked as successful and the amount will be auto-refunded after the transaction expires.
\n
Overpayment: The transaction will be marked as Paid and the excess amount will be auto-refunded to the customer.
\n
Underpayment: The transaction remains in In Progress status. The customer can:
\n
- Pay the remaining amount using the same Reference ID, which will update the status to Paid, OR
  \n
- Wait for expiry, after which the initial payment is auto-refunded.
  \n
\n
Expired Transactions: All transactions are valid for 24 hours. Any payment made after expiry is auto-refunded.
\n

\n","_postman_id":"d88addad-febc-49dd-922d-86a9168d9703"},{"name":"Payin API","item":[{"name":"Purchases","id":"0c903e97-f01b-44da-a150-1a50972996aa","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer {{APIKey}}"}],"body":{"mode":"raw","raw":"{\r\n \"client\": {\r\n \"email\": \"user2308@example.com\",\r\n \"street_address\": \"13 Documentation Way\",\r\n \"city\": \"Milford\",\r\n \"full_name\": \"Test Customer\",\r\n \"zip_code\": \"68403\",\r\n \"country\": \"CA\",\r\n \"stateCode\": \"QLD\",\r\n \"phone\": \"+447755564318\"\r\n },\r\n \"purchase\": {\r\n \"currency\": \"CAD\",\r\n \"expireInMin\": \"80\",\r\n \"products\": [\r\n {\r\n \"name\": \"test \",\r\n \"price\": 100\r\n }\r\n ]\r\n },\r\n \"paymentMethod\": \"INTERAC-EXPRESS\",\r\n \"brand_id\": \"your-brand-id\",\r\n \"success_redirect\": \"https://your.success.redirect.com\",\r\n \"pending_redirect\": \"https://your.pending.redirect.com\",\r\n \"failure_redirect\": \"https://your.failure.redirect.com\",\r\n \"success_callback\": \"https://your.success.callback.com\",\r\n \"failure_callback\": \"https://your.failure.callback.com\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.paysecure.net/api/v1/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\n\n\n\n

Parameter	Notes
client.email	An Identifier for a user
client.city	An Identifier for a user
client.country	ISO-3166 Country Code. It must be upper case. This should be \"CA\" for Interac
client.stateCode	Example “AL”, “XZ”.. Must be in upper case.
client.street_address
client.zip_code
client.phone
client.full_name
purchase.currency	ISO 4217 code for currency you want to send the transaction in. This should be 'CAD' for Interac
purchase.products.name	name of the product or service
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 progress
failure_redirect	URL to send the user if the transactions is UNSUCCESSFUL

Optional Parameters

expireInMin

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.

paymentMethod

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\n\n\n\n\n\n\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	Description
Invalid format of Date_of_Birth[allowed format: yyyy-mm-dd]
Enter Valid Email
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
Minimum amount is not set for this merchant
success_redirect/failure_redirect/brand_id is missing
brand_id cannot be null
success_redirect cannot be null
failure_redirect cannot be null
Invalid failure_redirect: minimum 10 characters
purchase.products.price cannot be null
purchase.products[0].name/purchase.products[0].price are missing
Your charges setting is incomplete .Plese Contact to Administrator.
Currency \"{curr_name}\" is Not Allowed
Transaction amount must be equal or greater to minimum trans amount
Allowed Limit for this card for particular time period has been consumed

Note: For certain use cases, in addition to long format purchase Id, Paysecure also provides a 7 digit unique code for each purchase starting with digit 4, eg 4000001

“purchaseIdShortCode”: “4000013\"

\n","urlObject":{"path":["purchases",""],"host":["https://api.paysecure.net/api/v1"],"query":[],"variable":[]}},"response":[{"id":"fb37d1e2-bc0b-49bf-8a5b-aee067cfb8a5","name":"Purchase- success","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer {{APIKey}}"}],"body":{"mode":"raw","raw":"{\r\n \"client\": {\r\n \"email\": \"user2308@example.com\",\r\n \"street_address\": \"13 Documentation Way\",\r\n \"city\": \"Milford\",\r\n \"full_name\": \"Test test\",\r\n \"zip_code\": \"68403\",\r\n \"country\": \"CA\",\r\n \"stateCode\": \"QLD\",\r\n \"phone\": \"+447755564318\"\r\n },\r\n \"purchase\": {\r\n \"currency\": \"CAD\",\r\n \"expireInMin\": \"80\",\r\n \"products\": [\r\n {\r\n \"name\": \"test \",\r\n \"price\": 100\r\n }\r\n ]\r\n },\r\n \"paymentMethod\": \"INTERAC-EXPRESS\",\r\n \"brand_id\": \"your-brand-id\",\r\n \"success_redirect\": \"https://your.success.redirect.com\",\r\n \"pending_redirect\": \"https://your.pending.redirect.com\",\r\n \"failure_redirect\": \"https://your.failure.redirect.com\",\r\n \"success_callback\": \"https://your.success.callback.com\",\r\n \"failure_callback\": \"https://your.failure.callback.com\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.paysecure.net/api/v1/purchases"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"purchaseId\": \"6890aba7faa4173bbbbb76c6\",\n \"client\": {\n \"customerId\": \"NA\",\n \"email\": \"user2308@example.com\",\n \"phone\": \"+447755564318\",\n \"full_name\": \"Test test\",\n \"date_of_birth\": \"1970-07-10\",\n \"street_address\": \"13 Documentation Way\",\n \"country\": \"CA\",\n \"city\": \"Milford\",\n \"zip_code\": \"68403\",\n \"cc\": [],\n \"bcc\": [],\n \"stateCode\": \"QLD\"\n },\n \"updated_on\": 1754311599,\n \"type\": \"purchase\",\n \"paymentMethod\": \"INTERAC-EXPRESS\",\n \"amountUnit\": \"MAJOR\",\n \"errorMsg\": \"\",\n \"redirectType\": \"GET\",\n \"force_recurring\": false,\n \"created_on\": 1754311591,\n \"extraParam\": {\n \"reference\": \"wkdjabf43\"\n },\n \"merchantRef\": \"6890aba7faa4173bbbbb76c6\",\n \"merchantName\": \"Skyler Nakamurasinghal\",\n \"purchase\": {\n \"currency\": \"CAD\",\n \"products\": [\n {\n \"name\": \"test\",\n \"quantity\": 1.0,\n \"price\": 100.0,\n \"discount\": 0,\n \"tax_percent\": \"0.00\"\n }\n ],\n \"total\": 100.0,\n \"language\": \"en\",\n \"notes\": \"\",\n \"debt\": 0,\n \"total_formatted\": 1.0,\n \"expireInMin\": \"1440\",\n \"taxAmount\": 0.0,\n \"taxPercent\": 0.0,\n \"request_client_details\": [],\n \"email_message\": \"\"\n },\n \"payment\": {\n \"is_outgoing\": false,\n \"payment_type\": \"PURCHASE\",\n \"amount\": 100.0,\n \"currency\": \"CAD\",\n \"net_amount\": 100.0,\n \"fee_amount\": 0.0,\n \"pending_amount\": 0.0,\n \"pending_unfreeze_on\": null,\n \"description\": \"\",\n \"paid_on\": 1754311592,\n \"remote_paid_on\": 1754311592\n },\n \"issuer_details\": {\n \"website\": \"\",\n \"legal_street_address\": \"\",\n \"legal_country\": \"\",\n \"legal_city\": \"\",\n \"legal_zip_code\": \"\",\n \"bank_accounts\": [\n {}\n ],\n \"legal_name\": \"test6\",\n \"brand_name\": \"test6\",\n \"registration_number\": \"\",\n \"tax_number\": \"\"\n },\n \"transaction_data\": {\n \"payment_method\": \"\",\n \"flow\": \"payform\",\n \"extra\": {\n \"amount\": 100.0,\n \"masked_pan\": \"INTERAC-EXPRESS\"\n },\n \"country\": \"\",\n \"attempts\": [\n {\n \"client_ip\": \"203.0.113.249, 203.0.113.117, 203.0.113.109\",\n \"type\": \"execute\",\n \"payment_method\": \"INTERAC-EXPRESS\",\n \"flow\": \"payform\",\n \"successful\": true,\n \"country\": \"INTERAC-EXPRESS\",\n \"processing_time\": 1754311592,\n \"extra\": {\n \"amount\": 100.0,\n \"masked_pan\": \"INTERAC-EXPRESS\"\n }\n }\n ]\n },\n \"status\": \"PAYMENT_IN_PROCESS\",\n \"status_history\": [\n {\n \"status\": \"created\",\n \"timestamp\": 1754311591\n },\n {\n \"status\": \"pending_execute\",\n \"timestamp\": 1754311592\n },\n {\n \"status\": \"payment_in_process\",\n \"timestamp\": 1754311599\n }\n ],\n \"is_test\": false,\n \"brand_id\": \"your-brand-id\",\n \"is_recurring_token\": false,\n \"reference_generated\": \"PS1060\",\n \"issued\": \"2025-08-04\",\n \"due\": 1754311591,\n \"refund_upto\": 0,\n \"cc_descriptor\": \"\",\n \"fraudScore\": \"0\",\n \"trustScore\": \"0\",\n \"payInDetails\": {\n \"name\": \"INTERAC E-TRANSFER\",\n \"emailAddress\": \"user2624@example.com\",\n \"reference_number\": \"8g1lya\"\n },\n \"paidOn\": 0,\n \"receivedAmt\": 0.0,\n \"refund_availability\": \"NONE\",\n \"refundable_amount\": 0.0,\n \"success_redirect\": \"https://your.success.redirect.com\",\n \"failure_redirect\": \"https://your.failure.redirect.com\",\n \"cancel_redirect\": \"\",\n \"success_callback\": \"https://your.success.callback.com\",\n \"failure_callback\": \"https://your.failure.callback.com\",\n \"platform\": \"API\",\n \"created_from_ip\": \"203.0.113.249, 203.0.113.117, 203.0.113.109\",\n \"checkout_url\": \"https://api.paysecure.net/payments/6890aba7faa4173bbbbb76c6/\",\n \"payoutProcess\": false\n}"}],"_postman_id":"0c903e97-f01b-44da-a150-1a50972996aa"}],"id":"9cffca87-588a-4dff-b031-1dac6a552bff","description":"

How It Works

Interac-Express uses a Reference ID-based flow to streamline collections. Merchants generate a transaction-specific ID which customers must include when transferring funds from their bank account. This ensures precise, secure, and automated payment reconciliation.

Key Steps

Flow:

Initiate Payment Request
Merchant initiates a PayIn by calling the /purchases API. The request must include:
\n
- paymentMethod: INTERAC-EXPRESS
  \n
- Customer email or mobile
  \n
- Amount
  \n
- Optional message
  \n
\n
Reference ID Generation
Paysecure returns a unique Reference ID associated with the transaction. This ID is valid for 24 hours and must be included by the customer in the message/memo field during their bank transfer.
\n
Customer Transfer
The customer logs into their online or mobile banking, inputs the transfer amount, adds the Paysecure-provided email or mobile, and includes the Reference ID exactly as provided.
\n
Validation & Matching
Paysecure validates the incoming transfer by matching the Reference ID and amount.
\n
- If matched correctly, the transaction is marked as successful.
  \n
- See edge cases above for incorrect, underpaid, overpaid, or expired scenarios.
  \n
\n
Webhook Notification
Once the transfer is matched and verified, Paysecure sends a webhook to the merchant with full transaction details and status.
\n
Merchant Reconciliation
Merchant updates the customer account or order status based on the received webhook data.
\n

\n","_postman_id":"9cffca87-588a-4dff-b031-1dac6a552bff"},{"name":"Payout API","item":[{"name":"Create Payout","id":"e4078542-bd1a-44ea-8bff-db4ace0275cd","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer {{APIKey}}"},{"key":"brandId","value":"your-brand-id","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"client\": {\r\n \"email\": \"user5890@example.com\",\r\n \"country\": \"CA\",\r\n \"phone\": \"+14377717874\",\r\n \"full_name\": \"Avery Larsen\"\r\n },\r\n \"purpose\": \"Transfer Reversed\",\r\n \"currency\": \"CAD\",\r\n \"payoutMethod\": \"PAYOUT-INTERAC-ETRANSFER\",\r\n \"amount\": 10,\r\n \"success_callback\": \"https://your.success.callback.com\",\r\n \"failure_callback\": \"https://your.failure.callback.com\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.paysecure.net/api/v1/payout/","description":"

To Initiate a payment, the very first call to make is /payout/

with the required data in the request body.

To generate a Payout, you are required to provide the API key (in the header) can be located in the Dashboard section of your merchant account login.

The request body structure is shown on the request body of the example request shown here.

The following (see table below) are the mandatory parameters that are required to create a Payout 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

Parameter	Notes
client.email client.phone	An Identifier for a user
client.full_name	An Identifier for a user
client.country	CA
payoutMethod	PAYOUT-INTERAC-EXPRESS
Currency	CAD
Amount	Payout Amount
Purpose	Transfer Reversed

","urlObject":{"path":["payout",""],"host":["https://api.paysecure.net/api/v1"],"query":[],"variable":[]}},"response":[{"id":"71bbbc72-36b2-41a6-a7c4-c18bb055fdbe","name":"create payout-success","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer {{APIKey}}","type":"text"},{"key":"brandId","value":"your-brand-id","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"client\": {\r\n \"email\": \"user5890@example.com\",\r\n \"country\": \"CA\",\r\n \"phone\": \"+14377717874\",\r\n \"full_name\": \"Avery Larsen\"\r\n },\r\n \"purpose\": \"test payout\",\r\n \"currency\": \"CAD\",\r\n \"payoutMethod\": \"PAYOUT-INTERAC-EXPRESS\",\r\n \"amount\": 10,\r\n \"success_callback\": \"https://your.success.callback.com\",\r\n \"failure_callback\": \"https://your.failure.callback.com\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.paysecure.net/api/v1/payout/"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"payoutId\": \"67efc0586720dd3a164fe8b3\",\n \"client\": {\n \"customerId\": \"NA\",\n \"email\": \"user5890@example.com\",\n \"country\": \"CA\",\n \"phone\": \"+14377717874\",\n \"full_name\": \"Avery Larsen\"\n },\n \"updated_on\": 1743765592,\n \"payoutMethod\": \"PAYOUT-INTERAC-EXPRESS\",\n \"amountUnit\": \"MAJOR\",\n \"amount\": 10,\n \"errorMsg\": \"\",\n \"purpose\": \"test payout\",\n \"created_on\": 1743765592,\n \"merchantRef\": \"67efc0586720dd3a164fe8b3\",\n \"merchantName\": \"Skyler Nakamurasinghal\",\n \"status\": \"PAID\",\n \"status_history\": [\n {\n \"status\": \"created\",\n \"timestamp\": 1743765592\n },\n {\n \"status\": \"paid\",\n \"timestamp\": 1743765610\n },\n {\n \"status\": \"viewed\",\n \"timestamp\": 1744025266\n }\n ],\n \"viewedOn\": 1744026844,\n \"currency\": \"CAD\",\n \"paymentOn\": 1743765610,\n \"success_callback\": \"https://your.success.callback.com\",\n \"failure_callback\": \"https://your.failure.callback.com\"\n}"}],"_postman_id":"e4078542-bd1a-44ea-8bff-db4ace0275cd"}],"id":"5c0c4f1d-7558-415d-be3d-affc0a912729","description":"

How It Works

Merchants can send funds to customers using Interac-Express by specifying the recipient’s email or mobile. Funds are typically delivered in real-time, depending on the recipient’s bank setup.

Key Steps

Flow:

Initiate Payout Request
Merchant initiates a payout using the /payout API, passing:
\n
- paymentMethod: INTERAC-EXPRESS
  \n
- Recipient email or mobile number
  \n
- Amount
  \n
- Optional message
  \n
\n
Recipient Notification
The customer receives a notification from their bank to accept the incoming funds. If the recipient has Auto-Deposit enabled, funds are deposited instantly. Otherwise, the customer must manually claim the payment via the bank’s standard process.
\n
Webhook Confirmation
Paysecure notifies the merchant via webhook once the payout has been successfully claimed or credited.
\n
Update Records
Merchant updates the customer's profile or balance based on payout status.
\n

\n","_postman_id":"5c0c4f1d-7558-415d-be3d-affc0a912729"}],"id":"cf6119cc-3f3c-4707-bda2-ac78e30bae25","description":"

Overview

Interac-Express is a real-time Canadian payment method that enables secure bank-to-bank transfers through customer-initiated actions via their banking apps or websites. It’s designed for fast, reference-based validation—no security questions, no delays.

Paysecure enables merchants to use Interac-Express for:

PayIns: Customers initiate bank transfers referencing a unique ID tied to their transaction.
\n
Payouts: Businesses can send funds directly to customer accounts in near real-time.
\n

\n","_postman_id":"cf6119cc-3f3c-4707-bda2-ac78e30bae25"},{"name":"🇧🇷 PIX","item":[{"name":"Concepts","item":[],"id":"b3f9dd5d-c274-4b0a-900f-8c3f910643e4","description":"

PayIn Flows

How it works
To initiate a PIX payment, a payer can scan the code using their PIX payment app (such as Itau, NuBank, etc).
These codes comply with BCB’s infrastructure requirements to ensure that the merchant's details are stored securely and there are no errors during the payment journey.

Key Steps

\n\n

Flow

Merchant platforms can create a dynamic QR code by passing the relevant parameter using Paysecure’s API.
\n
The platform can display the dynamic QR code on its app or any website at checkout or on a third-party app.
\n
The payer scans the QR code from the PIX app of their choice on their mobile.
\n
The payer authorizes the transaction on the app by entering a valid PIN.
\n
Once the payment is done, the merchant platform receives a transaction status callback from Paysecure to a pre-configured endpoint.
\n
The platform can also check the request status using the reference ID generated from the collection request using the Check Payment Status API.
\n

PayOut flows

How it works

To initiate a payout, the merchant has to give Paysecure the PIX details such as the recipient's PIX key (e.g., CPF/CNPJ, phone number, or email), amount, and any additional information.

If the merchant has enough balance, then the transaction amount will be deducted from the merchant balance and sent to the user.

Key Steps

\n\n

Flow

Initiation:
\n
- User initiates: The process starts with a user requesting payout from the merchant.
  \n
- Merchant approval: if everything is OK, the merchant approves payout request
  \n
\n
Processing:
\n
- Payment details: Using Paysecure’s API, the merchant provides the recipient's Pix key (which can be a phone number, email, CPF/CNPJ, or random key) and the transfer amount.
  \n
- Funds check: Paysecure verifies if sufficient funds are available in the merchant account to cover the transfer.
  \n
- Processing & Key mapping: the recipient's Pix key is validated using the DICT (Transactional Identifier Directory). This central database links Pix keys with users' bank accounts.
  \n
\n
Payout:
\n
- Instant transfer: If everything checks out, the payer's bank instantly transfers the funds to the recipient's bank account. The recipient typically receives confirmation messages from their respective bank about the successful transaction.
\n

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.

Request Body 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

Parameter	Notes
client.full_name	Conditional. But Recommended to pass the complete name of the client. Atleast 2 words recommended.
client.email	Conditional. But Recommended to pass a correct email id.
client.tax_number	Mandatory. Pass the CPF (Brazilian tax identification number of customer), must contain 11 digits.
paymentMethod	Conditional. Mandatory if you are not using Paysecure Cashier. Else Non Mandatory. Value: PIX
purchase.currency	Mandatory. ISO 4217 code for currency you want to send the transaction in. This should be 'BRL' for PIX.
purchase.products.name	Mandatory.
purchase.products.price	Mandatory. Price in decimal format upto 2 decimals. 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	Mandatory. Obtain from Dashboard section of your merchant account login.
success_redirect	Mandatory. URL to send the user if the transactions is successful.
pending_redirect	Mandatory. URL to send the user if the transactions is in progress state.
failure_redirect	Mandatory URL to send the user if the transactions has failed.

Note: the object “pix_payload.payload” contains all the necessary fields to create a page containing a QR code and other information on the merchant portal. The field “pix_payload.qr_code” value is in Base64. This can be used to show the QR code image. The field \"pix_payload.expiration_date\" is in UTC time.

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.

paymentMethod

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

Error Messages	Description
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 `“{curr_name}\"` 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.

","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"d3858958-c155-4543-bc36-61ca5bd961c5","id":"d3858958-c155-4543-bc36-61ca5bd961c5","name":"PayIn API","type":"folder"}},"urlObject":{"path":["purchases",""],"host":["https://api.paysecure.net/api/v1"],"query":[],"variable":[]}},"response":[{"id":"837f6577-f302-44c0-9f28-0733a8be270f","name":"Purchase- success","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer {{APIKey}}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"client\": {\r\n \"email\": \"user5772@example.com\",\r\n \"full_name\": \"test test\",\r\n \"country\": \"BR\",\r\n \"city\": \"Ashford\",\r\n \"stateCode\": \"SP\",\r\n \"street_address\": \"58 Testing Lane\",\r\n \"zip_code\": \"57312-140\",\r\n \"date_of_birth\": \"1994-31-04\",\r\n \"phone\": \"+558262362732\",\r\n \"tax_number\": \"39933551809\"\r\n },\r\n \"purchase\": {\r\n \"currency\": \"BRL\",\r\n \"products\": [\r\n {\r\n \"name\": \"test \",\r\n \"price\": 10\r\n }\r\n ]\r\n },\r\n \"paymentMethod\": \"PIX\",\r\n \"merchantRef\": \"test12\",\r\n \"brand_id\": \"your-brand-id\",\r\n \"success_redirect\": \"https://your.success.redirect.com\",\r\n \"pending_redirect\": \"https://your.pending.redirect.com\",\r\n \"failure_redirect\": \"https://your.failure.redirect.com\",\r\n \"success_callback\": \"https://your.success.callback.com\",\r\n \"failure_callback\": \"https://your.failure.callback.com\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.paysecure.net/api/v1/purchases"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"purchaseId\": \"65f9368cb905381ba207b3c4\",\n \"client\": {\n \"email\": \"user5772@example.com\",\n \"full_name\": \"test test\",\n \"country\": \"BR\",\n \"city\": \"Ashford\",\n \"stateCode\": \"SP\",\n \"street_address\": \"58 Testing Lane\",\n \"zip_code\": \"57312-140\",\n \"date_of_birth\": \"1994-31-04\",\n \"phone\": \"+558262362732\",\n \"tax_number\": \"39933551809\"\n },\n \"updated_on\": 1710831244,\n \"type\": \"purchase\",\n \"paymentMethod\": \"PIX\",\n \"amountUnit\": \"MAJOR\",\n \"errorMsg\": \"\",\n \"redirectType\": \"POST\",\n \"force_recurring\": false,\n \"created_on\": 1710831244,\n \"merchantRef\": \"65f9368cb905381ba207b3c4\",\n \"merchantName\": \"test\",\n \"purchase\": {\n \"currency\": \"USD\",\n \"products\": [\n {\n \"price\": 10\n }\n ],\n \"total\": 10,\n \"language\": \"en\",\n \"total_formatted\": 1,\n \"timezone\": \"MIT\"\n },\n \"issuer_details\": {\n \"bank_accounts\": [\n {\n \"bank_account\": \"\",\n \"bank_code\": \"\"\n }\n ],\n \"legal_name\": \"newbrand\",\n \"brand_name\": \"newbrand\"\n },\n \"transaction_data\": {},\n \"status\": \"CREATED\",\n \"status_history\": [\n {\n \"status\": \"created\",\n \"timestamp\": 1764922723\n },\n {\n \"status\": \"pending_execute\",\n \"timestamp\": 1764922723\n },\n {\n \"status\": \"payment_in_process\",\n \"timestamp\": 1764922727\n }\n ],\n \"pix_payload\": {\n \"payload\": \"00020101021226800014br.gov.bcb.pix2558pix.asaas.com/qr/cobv/e3eb36eb-7e9b-404d-9bd3-b486a42da3445204000053039865802BR5925A55 CONSULTORIA EM CREDIT6009Sao Paulo61080455202062070503***630451CA\",\n \"qr_code\": \"iVBORw0KGgoAAAANSUhEUgAAAZ8AAAGfCAIAAAAPgEjDAAAP4UlEQVR42u3bUY7cSA4EUN … ..\",\n \"expiration_date\": \"2025-03-27 23:59:59\"\n },\n \"is_test\": false,\n \"brand_id\": \"your-brand-id\",\n \"send_receipt\": false,\n \"is_recurring_token\": false,\n \"skip_capture\": false,\n \"reference_generated\": \"PS2696\",\n \"issued\": \"2024-03-19\",\n \"due\": 1710831244,\n \"refund_upto\": 0,\n \"cc_descriptor\": \"\",\n \"fraudScore\": \"NA\",\n \"trustScore\": \"NA\",\n \"refund_availability\": \"NONE\",\n \"refundable_amount\": 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 \"platform\": \"API\",\n \"created_from_ip\": \"203.0.113.113\",\n \"checkout_url\": \"https://api.paysecure.net/payments/33ddc21c6073a7ac722288f0b2ec35be/\",\n \"payoutProcess\": false\n}"},{"id":"fb499cc5-bd2c-4226-821b-441940fdad20","name":"Purchase-error","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer {{APIKey}}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"client\": {\r\n \"email\": \"user5772@example.com\",\r\n \"full_name\": \"test test\",\r\n \"country\": \"BR\",\r\n \"city\": \"Ashford\",\r\n \"stateCode\": \"SP\",\r\n \"street_address\": \"58 Testing Lane\",\r\n \"zip_code\": \"57312-140\",\r\n \"date_of_birth\": \"1994-31-04\",\r\n \"phone\": \"+558262362732\",\r\n \"tax_number\": \"39933551809\"\r\n },\r\n \"purchase\": {\r\n \"currency\": \"BRL\",\r\n \"products\": [\r\n {\r\n \"name\": \"test \",\r\n \"price\": 10\r\n }\r\n ]\r\n },\r\n \"paymentMethod\": \"PIX\",\r\n \"merchantRef\": \"test12\",\r\n \"brand_id\": \"your-brand-id\",\r\n \"success_redirect\": \"https://your.success.redirect.com\",\r\n \"pending_redirect\": \"https://your.pending.redirect.com\",\r\n \"failure_redirect\": \"https://your.failure.redirect.com\",\r\n \"success_callback\": \"https://your.success.callback.com\",\r\n \"failure_callback\": \"https://your.failure.callback.com\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.paysecure.net/api/v1/purchases"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Brand not found!\",\n \"code\": \"transaction_error\"\n}"}],"_postman_id":"e8fc456c-15b4-489d-a8b5-a0cf2755ad1c"},{"name":"Get Status","id":"323fad39-74dc-45fb-bc5f-bf951753880b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer {{APIKey}}","type":"text"}],"url":"https://api.paysecure.net/api/v1/purchases/{purchaseId}/","description":"

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

Status	Notes
paid	Transaction Successful
payment_in_process	Payment is under Processing
expired	The 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","urlObject":{"path":["purchases","{purchaseId}",""],"host":["https://api.paysecure.net/api/v1"],"query":[],"variable":[]}},"response":[{"id":"85e8d686-597f-45bd-9441-6070799b1ccf","name":"Success","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer {{APIKey}}","type":"text"}],"url":"https://api.paysecure.net/api/v1/purchases/{purchaseId}/"},"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":"{\r\n \"purchaseId\": \"65f9368cb905381ba207b3c4\",\r\n \"client\": {\r\n \"email\": \"user5772@example.com\",\r\n \"full_name\": \"Test test\",\r\n \"tax_number\": \"39933551809\"\r\n },\r\n \"updated_on\": 1710831244,\r\n \"type\": \"purchase\",\r\n \"paymentMethod\": \"PIX\",\r\n \"amountUnit\": \"MAJOR\",\r\n \"errorMsg\": \"\",\r\n \"redirectType\": \"POST\",\r\n \"force_recurring\": false,\r\n \"created_on\": 1710831244,\r\n \"merchantRef\": \"65f9368cb905381ba207b3c4\",\r\n \"merchantName\": \"test\",\r\n \"purchase\": {\r\n \"currency\": \"USD\",\r\n \"products\": [\r\n {\r\n \"price\": 10.0\r\n }\r\n ],\r\n \"total\": 10.0,\r\n \"language\": \"en\",\r\n \"total_formatted\": 1.0,\r\n \"timezone\": \"MIT\"\r\n },\r\n \"issuer_details\": {\r\n \"bank_accounts\": [\r\n {\r\n \"bank_account\": \"\",\r\n \"bank_code\": \"\"\r\n }\r\n ],\r\n \"legal_name\": \"newbrand\",\r\n \"brand_name\": \"newbrand\"\r\n },\r\n \"transaction_data\": {},\r\n \"status\": \"CREATED\",\r\n \"status_history\": [\r\n {\r\n \"status\": \"created\",\r\n \"timestamp\": 1710831244\r\n }\r\n ],\r\n \"is_test\": false,\r\n \"brand_id\": \"your-brand-id\",\r\n \"send_receipt\": false,\r\n \"is_recurring_token\": false,\r\n \"skip_capture\": false,\r\n \"reference_generated\": \"PS2696\",\r\n \"issued\": \"2024-03-19\",\r\n \"due\": 1710831244,\r\n \"refund_upto\": 0,\r\n \"cc_descriptor\": \"\",\r\n \"fraudScore\": \"NA\",\r\n \"trustScore\": \"NA\",\r\n \"refund_availability\": \"NONE\",\r\n \"refundable_amount\": 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 \"cancel_redirect\": \"\",\r\n \"success_callback\": \"https://your.success.callback.com\",\r\n \"failure_callback\": \"https://your.failure.callback.com\",\r\n \"platform\": \"API\",\r\n \"created_from_ip\": \"203.0.113.152\",\r\n \"checkout_url\": \"https://api.paysecure.net/payments/65f9368cb905381ba207b3c4/\"\r\n}\r\n"},{"id":"8557ea60-a76f-4406-aa3a-62413c605a49","name":"Failure","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer {{APIKey}}","type":"text"}],"url":"https://api.paysecure.net/api/v1/purchases/{purchaseId}/"},"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":"{\r\n \"message\": \"Error Message\",\r\n \"code\": \"error_code\"\r\n}\r\n"}],"_postman_id":"323fad39-74dc-45fb-bc5f-bf951753880b"}],"id":"d3858958-c155-4543-bc36-61ca5bd961c5","description":"

API Flow

\n\n

Initiate Purchase: The merchant calls the create purchase API to start the purchase process.
\n
Get Checkout URL: If the API call is successful, the response body contains a checkout URL.
\n
Redirect Client: The merchant redirects the client to the checkout URL received.
\n
Client Payment: The client is presented with a QR code to complete the payment.
\n
1. Please note that instead of redirecting to the checkout URL, the information to create a page on the merchant’s digital estate itself containing the QR code and other information can be achieved by utilizing the data on the “pix_payload“ object in the response.
\n
Payment Outcome: After the payment attempt, the client is redirected to a URL indicating success or failure, which was specified in the create purchase API.
\n
Callback Posting: Upon successful or failed payment, the entire payload of the transaction is posted to designated success or failure callback URLs.
\n

This API is used to initate refund of the purchases that have status as PAID

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.

If due to some reason, the refund has failed, the status would again become PAID

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":"49d735a9-ca35-4db2-b3fb-e1f5ee3f0865","id":"49d735a9-ca35-4db2-b3fb-e1f5ee3f0865","name":"Refund API","type":"folder"}},"urlObject":{"path":["purchases","657af976c3fceb7beb30eeb4","refund"],"host":["https://api.paysecure.net/api/v1"],"query":[],"variable":[]}},"response":[{"id":"b3004bbd-8824-436c-ae54-e1ccbdcb7ee3","name":"Refund - Pending","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer {{APIKey}}","type":"text"}],"url":"https://api.paysecure.net/api/v1/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\": \"user6085@example.com\",\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\": \"203.0.113.133\",\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\": \"203.0.113.133\",\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\": \"your-brand-id\",\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://your.success.redirect.com\",\n \"failure_redirect\": \"https://your.failure.redirect.com\",\n \"cancel_redirect\": \"\",\n \"success_callback\": \"https://your.success.callback.com\",\n \"platform\": \"API\",\n \"created_from_ip\": \"203.0.113.133\",\n \"checkout_url\": \"https://api.paysecure.net/payments/64bfdb7df63e36669499e82f/\",\n \"direct_post_url\": \"https://api.paysecure.net/api/v1/p/64bfdb7df63e36669499e82f/\"\n}"},{"id":"b2d88c97-b1e2-4c3f-aea4-272be6cf83ab","name":"Refund - Success","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer {{APIKey}}","type":"text"}],"url":"https://api.paysecure.net/api/v1/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\": \"user6085@example.com\",\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\": \"203.0.113.133\",\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\": \"203.0.113.133\",\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\": 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\": \"refunded\",\n \"timestamp\": 1690302819\n }\n ],\n \"viewedOn\": 1690299929,\n \"is_test\": false,\n \"brand_id\": \"your-brand-id\",\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://your.success.redirect.com\",\n \"failure_redirect\": \"https://your.failure.redirect.com\",\n \"cancel_redirect\": \"\",\n \"success_callback\": \"https://your.success.callback.com\",\n \"platform\": \"API\",\n \"created_from_ip\": \"203.0.113.133\",\n \"checkout_url\": \"https://api.paysecure.net/payments/64bfdb7df63e36669499e82f/\",\n \"direct_post_url\": \"https://api.paysecure.net/api/v1/p/64bfdb7df63e36669499e82f/\"\n}"},{"id":"361a6946-f1a2-4035-a3dd-219f64a855b6","name":"Refund - Error","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer {{APIKey}}","type":"text"}],"url":"https://api.paysecure.net/api/v1/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":"d3c959ec-ba32-4c0e-b75d-18898ae41a14"}],"id":"49d735a9-ca35-4db2-b3fb-e1f5ee3f0865","auth":{"type":"noauth","isInherited":false},"event":[{"listen":"prerequest","script":{"type":"text/javascript","packages":{},"requests":{},"exec":[""],"id":"80b55aee-b95a-4c19-b3c0-910744824b50"}},{"listen":"test","script":{"type":"text/javascript","packages":{},"requests":{},"exec":[""],"id":"0e53f849-06fa-42db-9573-5c59ab37b790"}}],"_postman_id":"49d735a9-ca35-4db2-b3fb-e1f5ee3f0865","description":""},{"name":"PayOut API","item":[{"name":"Create PayOut","id":"5c761add-e7f4-4146-8a92-3a0d6671e4b1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer {{APIKey}}"}],"body":{"mode":"raw","raw":"{\r\n \"client\": {\r\n \"email\": \"user5772@example.com\",\r\n \"full_name\": \"test test\",\r\n \"country\": \"BR\",\r\n \"city\": \"Ashford\",\r\n \"stateCode\": \"SP\",\r\n \"street_address\": \"58 Testing Lane\",\r\n \"zip_code\": \"57312-140\",\r\n \"date_of_birth\": \"1994-31-04\",\r\n \"phone\": \"+558262362732\",\r\n \"documentId\": \" 97c1c590-554b-4449-a0f1-8da9f9756937\", \r\n \"documentType\": \"evp\"\r\n },\r\n \"purpose\": \"payout to test\",\r\n \"payoutMethod\": \"Payout-PIX\",\r\n \"brand_id\": \"your-brand-id\", \r\n \"amount\": 10,\r\n \"currency\": \"BRL\",\r\n \"success_redirect\": \"https://your.success.redirect.com\",\r\n \"pending_redirect\": \"https://your.pending.redirect.com\",\r\n \"failure_redirect\": \"https://your.failure.redirect.com\",\r\n \"success_callback\": \"https://your.success.callback.com\",\r\n \"failure_callback\": \"https://your.failure.callback.com\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.paysecure.net/api/v1/payout/","description":"

To Initiate a payout, the very first call to make is /payout/ API with the required data in the request body.

To generate a PayOut, you are required to provide the API key (in the header), which can be located in the Dashboard section of your merchant account login.

The following (see table below) are the mandatory parameters that are required to create a payout 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.phone	The customer's phone number along with the country code. Example: +91 9634088651
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.
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.
amount	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	example: PAYOUT-PIX
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.
Purpose	The purpose of doing a payout.

Additional parameters for this usecase:

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

Parameter	Notes
client.documentType	Mandatory. Document Type Supported : cpf, cnpj, evp, email, phone cpf is Brazil's tax_id cnpj is Business tax_id evp is random key generated by the bank email is the email which supports pix phone is the phone number which supports pix
client.documentId	Mandatory. Document value of the type above.

","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"19413a2e-ff2d-45e5-987d-d050bbc036f8","id":"19413a2e-ff2d-45e5-987d-d050bbc036f8","name":"PayOut API","type":"folder"}},"urlObject":{"path":["payout",""],"host":["https://api.paysecure.net/api/v1"],"query":[],"variable":[]}},"response":[{"id":"6aa90092-8aac-4b5c-9cbf-617a5ff5b728","name":"Success","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer {{APIKey}}"}],"body":{"mode":"raw","raw":"{\r\n \"client\": {\r\n \"email\": \"user5772@example.com\",\r\n \"full_name\": \"test test\",\r\n \"country\": \"BR\",\r\n \"city\": \"Ashford\",\r\n \"stateCode\": \"SP\",\r\n \"street_address\": \"58 Testing Lane\",\r\n \"zip_code\": \"57312-140\",\r\n \"date_of_birth\": \"1994-31-04\",\r\n \"phone\": \"+558262362732\",\r\n \"documentId\": \" 97c1c590-554b-4449-a0f1-8da9f9756937\", \r\n \"documentType\": \"evp\"\r\n },\r\n \"purpose\": \"payout to test\",\r\n \"payoutMethod\": \"Payout-PIX\",\r\n \"brand_id\": \"your-brand-id\", \r\n \"amount\": 10,\r\n \"currency\": \"BRL\",\r\n \"success_redirect\": \"https://your.success.redirect.com\",\r\n \"pending_redirect\": \"https://your.pending.redirect.com\",\r\n \"failure_redirect\": \"https://your.failure.redirect.com\",\r\n \"success_callback\": \"https://your.success.callback.com\",\r\n \"failure_callback\": \"https://your.failure.callback.com\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.paysecure.net/api/v1/payout/"},"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":"{\r\n \"payoutId\": \"65f93895c96bae142f7b1765\",\r\n \"client\": {\r\n \"email\": \"user5772@example.com\",\r\n \"full_name\": \"test test\",\r\n \"country\": \"BR\",\r\n \"city\": \"Ashford\",\r\n \"stateCode\": \"SP\",\r\n \"street_address\": \"58 Testing Lane\",\r\n \"zip_code\": \"57312-140\",\r\n \"date_of_birth\": \"1994-31-04\",\r\n \"phone\": \"+558262362732\",\r\n \"documentId\": \" 97c1c590-554b-4449-a0f1-8da9f9756937\",\r\n \"documentType\": \"evp\"\r\n },\r\n \"updated_on\": 1710831765,\r\n \"payoutMethod\": \"Payout-PIX\",\r\n \"amountUnit\": \"MAJOR\",\r\n \"amount\": 10.0,\r\n \"errorMsg\": \"\",\r\n \"created_on\": 1710831768,\r\n \"merchantName\": \"test\",\r\n \"status\": \"PAID\",\r\n \"status_history\": [\r\n {\r\n \"status\": \"created\",\r\n \"timestamp\": 1710831765\r\n },\r\n {\r\n \"status\": \"paid\",\r\n \"timestamp\": 1710831768\r\n }\r\n ],\r\n \"currency\": \"BRL\",\r\n \"purpose\": \"payout to test\",\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}"},{"id":"c56b34aa-760c-4272-9f67-b2af5df4696b","name":"Failure","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer {{APIKey}}"}],"body":{"mode":"raw","raw":"{\r\n \"client\": {\r\n \"email\": \"user5772@example.com\",\r\n \"full_name\": \"test test\",\r\n \"country\": \"BR\",\r\n \"city\": \"Ashford\",\r\n \"stateCode\": \"SP\",\r\n \"street_address\": \"58 Testing Lane\",\r\n \"zip_code\": \"57312-140\",\r\n \"date_of_birth\": \"1994-31-04\",\r\n \"phone\": \"+558262362732\",\r\n \"documentId\": \" 97c1c590-554b-4449-a0f1-8da9f9756937\", \r\n \"documentType\": \"evp\"\r\n },\r\n \"purpose\": \"payout to test\",\r\n \"payoutMethod\": \"Payout-PIX\",\r\n \"brand_id\": \"your-brand-id\", \r\n \"amount\": 10,\r\n \"currency\": \"BRL\",\r\n \"success_redirect\": \"https://your.success.redirect.com\",\r\n \"pending_redirect\": \"https://your.pending.redirect.com\",\r\n \"failure_redirect\": \"https://your.failure.redirect.com\",\r\n \"success_callback\": \"https://your.success.callback.com\",\r\n \"failure_callback\": \"https://your.failure.callback.com\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.paysecure.net/api/v1/payout/"},"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":"{\r\n \"payoutId\": \"65f93895c96bae142f7b1765\",\r\n \"client\": {\r\n \"email\": \"user5772@example.com\",\r\n \"full_name\": \"test test\",\r\n \"country\": \"BR\",\r\n \"city\": \"Ashford\",\r\n \"stateCode\": \"SP\",\r\n \"street_address\": \"58 Testing Lane\",\r\n \"zip_code\": \"57312-140\",\r\n \"date_of_birth\": \"1994-31-04\",\r\n \"phone\": \"+558262362732\",\r\n \"documentId\": \" 97c1c590-554b-4449-a0f1-8da9f9756937\", \r\n \"documentType\": \"evp\"\r\n },\r\n \"updated_on\": 1710831765,\r\n \"payoutMethod\": \"Payout-PIX\",\r\n \"amountUnit\": \"MAJOR\",\r\n \"amount\": 20.0,\r\n \"errorMsg\": \"errors.wallet.transfer_balance_insufficient\",\r\n \"created_on\": 1710831768,\r\n \"merchantRef\": \"65f93895c96bae142f7b1765\",\r\n \"merchantName\": \"test\",\r\n \"status\": \"ERROR\",\r\n \"status_history\": [\r\n {\r\n \"status\": \"created\",\r\n \"timestamp\": 1710831765\r\n },\r\n {\r\n \"status\": \"error\",\r\n \"timestamp\": 1710831768\r\n }\r\n ],\r\n \"currency\": \"BRL\",\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}\r\n"}],"_postman_id":"5c761add-e7f4-4146-8a92-3a0d6671e4b1"},{"name":"Get Status","id":"38282022-d30e-409e-8422-072417e24c66","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{APIKey}}","type":"text"}],"url":"https://api.paysecure.net/api/v1/getpayout/{payoutId}/","description":"

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

Mandatory

you need to pass the payoutId 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
payout_in_process	payout is under Processing.
error	Transaction has Failed.

The webhook will only be triggered for paid transactions or errors.

Paid: \"success_callback\": \"https://your.success.callback.com\",

Error: \"failure_callback\": “https://failure.com”

\n","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"19413a2e-ff2d-45e5-987d-d050bbc036f8","id":"19413a2e-ff2d-45e5-987d-d050bbc036f8","name":"PayOut API","type":"folder"}},"urlObject":{"path":["getpayout","{payoutId}",""],"host":["https://api.paysecure.net/api/v1"],"query":[],"variable":[]}},"response":[{"id":"2d44fd09-39d1-4b65-b24b-ae2104ac2306","name":"Success","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer {{APIKey}}","type":"text"}],"url":"https://api.paysecure.net/api/v1/getpayout/{payoutId}/"},"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":"{\r\n \"payoutId\": \"65f93895c96bae142f7b1765\",\r\n \"client\": {\r\n \"email\": \"user5772@example.com\",\r\n \"full_name\": \"test test\",\r\n \"country\": \"BR\",\r\n \"city\": \"Ashford\",\r\n \"stateCode\": \"SP\",\r\n \"street_address\": \"58 Testing Lane\",\r\n \"zip_code\": \"57312-140\",\r\n \"date_of_birth\": \"1994-31-04\",\r\n \"phone\": \"+558262362732\",\r\n \"documentId\": \" 97c1c590-554b-4449-a0f1-8da9f9756937\",\r\n \"documentType\": \"evp\"\r\n },\r\n \"updated_on\": 1710831765,\r\n \"payoutMethod\": \"Payout-PIX\",\r\n \"amountUnit\": \"MAJOR\",\r\n \"amount\": 10.0,\r\n \"errorMsg\": \"\",\r\n \"created_on\": 1710831768,\r\n \"merchantName\": \"test\",\r\n \"status\": \"PAID\",\r\n \"status_history\": [\r\n {\r\n \"status\": \"created\",\r\n \"timestamp\": 1710831765\r\n },\r\n {\r\n \"status\": \"paid\",\r\n \"timestamp\": 1710831768\r\n }\r\n ],\r\n \"currency\": \"BRL\",\r\n \"purpose\": \"payout to test\",\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}"},{"id":"53cb9a04-5503-4ad9-85a0-2ab2227c8e76","name":"Failure","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer {{APIKey}}","type":"text"}],"url":"https://api.paysecure.net/api/v1/getpayout/{payoutId}/"},"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":"{\n \"payoutId\": \"65f93895c96bae142f7b1765\",\n \"client\": {\n \"email\": \"user5772@example.com\",\n \"full_name\": \"test test\",\n \"country\": \"BR\",\n \"city\": \"Ashford\",\n \"stateCode\": \"SP\",\n \"street_address\": \"58 Testing Lane\",\n \"zip_code\": \"57312-140\",\n \"date_of_birth\": \"1994-31-04\",\n \"phone\": \"+558262362732\",\n \"documentId\": \" 97c1c590-554b-4449-a0f1-8da9f9756937\", \n \"documentType\": \"evp\"\n },\n \"updated_on\": 1710831765,\n \"payoutMethod\": \"Payout-PIX\",\n \"amountUnit\": \"MAJOR\",\n \"amount\": 20.0,\n \"errorMsg\": \"errors.wallet.transfer_balance_insufficient\",\n \"created_on\": 1710831768,\n \"merchantRef\": \"65f93895c96bae142f7b1765\",\n \"merchantName\": \"test\",\n \"status\": \"ERROR\",\n \"status_history\": [\n {\n \"status\": \"created\",\n \"timestamp\": 1710831765\n },\n {\n \"status\": \"error\",\n \"timestamp\": 1710831768\n }\n ],\n \"currency\": \"BRL\",\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}"}],"_postman_id":"38282022-d30e-409e-8422-072417e24c66"}],"id":"19413a2e-ff2d-45e5-987d-d050bbc036f8","description":"

Payout API Flow

\n\n

API Steps

The merchant initiates a PayOut via the payout API.
\n
After a successful or failed payment attempt, the status is reflected on the response and the details of the status history.
\n
To get the status of the transaction, call “/purchases/{purchaseId}/” API.
\n

Fawry Overview

Fawry is a leading Egyptian payment network that facilitates secure, online and offline transactions across various financial services. It offers multiple payment options, including Fawry Pay, enabling seamless transactions between businesses and consumers.

Fawry Pay allows users to make and receive payments directly through various channels, such as retail points, mobile apps, and online platforms. It provides a fast, secure, and convenient alternative to traditional payment methods, accessible through numerous banks and financial institutions in Egypt.

Paysecure’s Fawry product suite enables merchants to initiate:

PayIns: Consumers can use Fawry Pay to transfer funds from their bank account or via Fawry’s extensive network of retail locations and online services.
\n
Payouts*: Facilitate real-time disbursements directly to consumers' accounts or through Fawry's network.
\n

*Note: Payouts APIs are under development and will be availabe soon

PayIn Flows

How it works

Paysecure’s Fawry PayIn leverages Fawry’s payment network to support a wide range of collection scenarios. Merchants can initiate payment requests via various channels such as mobile apps, online platforms, or physical retail points, providing secure, efficient, and flexible options for collecting payments from customers.

Key Steps

\n\n

PayIn Flow

Initiate Payment: The customer initiates a payment by clicking on a ”Pay with FAWRY” button and selecting the deposit amount on the merchant’s website or app.
\n
Receive Unique Reference Code: The customer is provided with a unique reference code for the payment.
\n
Go to Fawry Agent: The customer visits a Fawry agent, which can be any shop or retail location within Fawry’s extensive network.
\n
Provide Reference Code: The customer provides the unique reference code to the Fawry agent.
\n
Make Payment: The customer pays the amount due in cash or through available electronic payment methods at the Fawry agent.
\n
Receive Confirmation: The customer receives a confirmation message indicating that the payment was successful, either via SMS, email, or app notification.
\n

Transaction Limits:

Pay Ins:

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

Criteria	Min Amount	Max Amount
Per Transaction	10 EGP	100,000 EGP
Per Day
Per User
Per Month

Pay Outs:

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

Criteria	Min Amount	Max Amount
Per Transaction	100 EGP	150,000 EGP
Per Day
Per User
Per Month

","_postman_id":"9964fa32-d236-40c8-b7cd-5246080e0708"},{"name":"PayIn API","item":[{"name":"Purchases","id":"cf878eea-93d1-40f7-afe9-b73b2beb3a21","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer {{APIKey}}"}],"body":{"mode":"raw","raw":"{\r\n \"client\": {\r\n \"email\": \"user7886@example.com\",\r\n \"street_address\": \"13 Documentation Way\",\r\n \"city\": \"Milford\",\r\n \"full_name\": \"Test test\",\r\n \"zip_code\": \"68403\",\r\n \"country\": \"EG\",\r\n \"stateCode\": \"QLD\",\r\n \"phone\": \"+447755564318\"\r\n },\r\n \"purchase\": {\r\n \"currency\": \"EGP\",\r\n \"products\": [\r\n {\r\n \"name\": \"test \",\r\n \"price\": 10\r\n }\r\n ]\r\n },\r\n \"paymentMethod\": \"FawryPay\",\r\n \"brand_id\": \"your-brand-id\",\r\n \"success_redirect\": \"https://your.success.redirect.com\",\r\n \"pending_redirect\": \"https://your.pending.redirect.com\",\r\n \"failure_redirect\": \"https://your.failure.redirect.com\",\r\n \"success_callback\": \"https://your.success.callback.com\",\r\n \"failure_callback\": \"https://your.failure.callback.com\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.paysecure.net/api/v1/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	An Identifier for a user
client.city
client.country	ISO-3166 Country Code. It must be upper case. Example “SG” (Alpha2)
client.stateCode	Example “AL”, “XZ”.. Must be in upper case.
client.street_address
client.zip_code
client.phone
client.full_name
purchase.currency	ISO 4217 code for currency you want to send the transaction in. Please note, the currency has to be enbaled by the account manager for your account.
purchase.products.name
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
failure_redirect	URL to send the user if the transactions is UNSUCCESSFUL

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.

paymentMethod

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\n\n\n\n\n\n\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	Description
Invalid format of Date_of_Birth[allowed format: yyyy-mm-dd]
Enter Valid Email
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
Minimum amount is not set for this merchant
success_redirect/failure_redirect/brand_id is missing
brand_id cannot be null
success_redirect cannot be null
failure_redirect cannot be null
Invalid failure_redirect: minimum 10 characters
purchase.products.price cannot be null
purchase.products[0].name/purchase.products[0].price are missing
Your charges setting is incomplete .Plese Contact to Administrator.
Currency \"{curr_name}\" is Not Allowed
Transaction amount must be equal or greater to minimum trans amount
Allowed Limit for this card for particular time period has been consumed

Note: For certain use cases, in addition to long format purchase Id, Paysecure also provides a 7 digit unique code for each purchase starting with digit 4, eg 4000001

“purchaseIdShortCode”: “4000013\"

\n","urlObject":{"path":["purchases",""],"host":["https://api.paysecure.net/api/v1"],"query":[],"variable":[]}},"response":[{"id":"170a6954-2894-48d4-92f2-f0a074c1112a","name":"Purchase- success","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer {{APIKey}}"}],"body":{"mode":"raw","raw":"{\r\n \"client\": {\r\n \"email\": \"user7886@example.com\",\r\n \"street_address\": \"13 Documentation Way\",\r\n \"city\": \"Milford\",\r\n \"full_name\": \"Test test\",\r\n \"zip_code\": \"68403\",\r\n \"country\": \"EG\",\r\n \"stateCode\": \"QLD\",\r\n \"phone\": \"+447755564318\"\r\n },\r\n \"purchase\": {\r\n \"currency\": \"EGP\",\r\n \"products\": [\r\n {\r\n \"name\": \"test \",\r\n \"price\": 10\r\n }\r\n ]\r\n },\r\n \"paymentMethod\": \"FawryPay\",\r\n \"brand_id\": \"your-brand-id\",\r\n \"success_redirect\": \"https://your.success.redirect.com\",\r\n \"pending_redirect\": \"https://your.pending.redirect.com\",\r\n \"failure_redirect\": \"https://your.failure.redirect.com\",\r\n \"success_callback\": \"https://your.success.callback.com\",\r\n \"failure_callback\": \"https://your.failure.callback.com\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.paysecure.net/api/v1/purchases"},"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":"{\r\n \"purchaseId\": \"667cfb2cf0bd8d672c8fc562\",\r\n \"client\": {\r\n \"email\": \"user1571@example.com\",\r\n \"phone\": \"+447755564318\",\r\n \"full_name\": \"Test test\",\r\n \"date_of_birth\": \"1970-07-10\",\r\n \"street_address\": \"13 Documentation Way\",\r\n \"country\": \"EG\",\r\n \"city\": \"Milford\",\r\n \"zip_code\": \"68403\",\r\n \"cc\": [],\r\n \"bcc\": [],\r\n \"stateCode\": \"QLD\"\r\n },\r\n \"updated_on\": 1719466796,\r\n \"type\": \"purchase\",\r\n \"paymentMethod\": \"FAWRYPAY\",\r\n \"amountUnit\": \"MAJOR\",\r\n \"errorMsg\": \"\",\r\n \"redirectType\": \"POST\",\r\n \"force_recurring\": false,\r\n \"created_on\": 1719466796,\r\n \"merchantRef\": \"667cfb2cf0bd8d672c8fc562\",\r\n \"instruction\": \"Please use the reference number 9350804722 to pay 10 EGP for this order at Fawrypay store. Complete the payment before 6/29/2024 5:39:59 AM +00:00\",\r\n \"merchantName\": \"merchant002\",\r\n \"purchase\": {\r\n \"currency\": \"EGP\",\r\n \"products\": [\r\n {\r\n \"name\": \"test\",\r\n \"quantity\": 1.0,\r\n \"price\": 10.0,\r\n \"discount\": 0,\r\n \"tax_percent\": \"0.00\"\r\n }\r\n ],\r\n \"total\": 10.0,\r\n \"language\": \"en\",\r\n \"notes\": \"\",\r\n \"debt\": 0,\r\n \"total_formatted\": 1.0,\r\n \"request_client_details\": [],\r\n \"timezone\": \"MIT\",\r\n \"email_message\": \"\"\r\n },\r\n \"payment\": {\r\n \"is_outgoing\": false,\r\n \"payment_type\": \"PURCHASE\",\r\n \"amount\": 10.0,\r\n \"currency\": \"EGP\",\r\n \"net_amount\": 10.0,\r\n \"fee_amount\": 0.0,\r\n \"pending_amount\": 0.0,\r\n \"pending_unfreeze_on\": null,\r\n \"description\": \"\",\r\n \"paid_on\": 1719466796,\r\n \"remote_paid_on\": 1719466796\r\n },\r\n \"issuer_details\": {\r\n \"website\": \"\",\r\n \"legal_street_address\": \"\",\r\n \"legal_country\": \"\",\r\n \"legal_city\": \"\",\r\n \"legal_zip_code\": \"\",\r\n \"bank_accounts\": [\r\n {}\r\n ],\r\n \"legal_name\": \"test6\",\r\n \"brand_name\": \"test6\",\r\n \"registration_number\": \"\",\r\n \"tax_number\": \"\"\r\n },\r\n \"transaction_data\": {\r\n \"payment_method\": \"\",\r\n \"flow\": \"payform\",\r\n \"extra\": {\r\n \"amount\": 10.0,\r\n \"masked_pan\": \"FAWRYPAY\"\r\n },\r\n \"country\": \"\",\r\n \"attempts\": [\r\n {\r\n \"client_ip\": \"203.0.113.226\",\r\n \"type\": \"execute\",\r\n \"payment_method\": \"FAWRYPAY\",\r\n \"flow\": \"payform\",\r\n \"successful\": true,\r\n \"country\": \"FAWRYPAY\",\r\n \"processing_time\": 1719466796,\r\n \"extra\": {\r\n \"amount\": 10.0,\r\n \"masked_pan\": \"FAWRYPAY\"\r\n }\r\n }\r\n ]\r\n },\r\n \"status\": \"PAYMENT_IN_PROCESS\",\r\n \"status_history\": [\r\n {\r\n \"status\": \"created\",\r\n \"timestamp\": 1719466796\r\n },\r\n {\r\n \"status\": \"pending_execute\",\r\n \"timestamp\": 1719466796\r\n },\r\n {\r\n \"status\": \"payment_in_process\",\r\n \"timestamp\": 1719466796\r\n }\r\n ],\r\n \"is_test\": false,\r\n \"brand_id\": \"your-brand-id\",\r\n \"send_receipt\": false,\r\n \"is_recurring_token\": false,\r\n \"skip_capture\": false,\r\n \"reference_generated\": \"PS10252\",\r\n \"issued\": \"2024-06-27\",\r\n \"due\": 1719466796,\r\n \"refund_upto\": 1735015199,\r\n \"cc_descriptor\": \"\",\r\n \"fraudScore\": \"NA\",\r\n \"trustScore\": \"NA\",\r\n \"payInDetails\": {\r\n \"reference_number\": \"9350804722\",\r\n \"payment_method\": \"PAYATFAWRY\",\r\n \"transaction_expiry\": \"29 Jun 2024 05:39:59:054 +0000\"\r\n },\r\n \"refund_availability\": \"NONE\",\r\n \"refundable_amount\": 10.0,\r\n \"success_redirect\": \"https://your.success.redirect.com\",\r\n \"failure_redirect\": \"https://your.failure.redirect.com\",\r\n \"cancel_redirect\": \"\",\r\n \"success_callback\": \"https://your.success.callback.com\",\r\n \"failure_callback\": \"https://your.failure.callback.com\",\r\n \"platform\": \"API\",\r\n \"created_from_ip\": \"203.0.113.226\",\r\n \"checkout_url\": \"https://api.paysecure.net/payments/667cfb2cf0bd8d672c8fc562/\"\r\n}"},{"id":"7a9948db-94d6-4766-ae3a-620c1afcffc7","name":"Create Purchase","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer {{APIKey}}"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"https://api.paysecure.net/api/v1/purchases"},"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":"{\r\n \"message\": \"Error Message\",\r\n \"code\": \"error_code\"\r\n}\r\n"}],"_postman_id":"cf878eea-93d1-40f7-afe9-b73b2beb3a21"},{"name":"Get Status","id":"1e0589a4-ba3a-45c3-82a1-30c7e1546d8b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer {{APIKey}}","type":"text"}],"url":"https://api.paysecure.net/api/v1/purchases/{purchaseId}/","description":"

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

Note: With respect to bank transfers, the purchase request is synonymous with the PayIn request.

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

Status	Notes
paid	Transaction Successful
payment_in_process	Payment is under Processing
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","urlObject":{"path":["purchases","{purchaseId}",""],"host":["https://api.paysecure.net/api/v1"],"query":[],"variable":[]}},"response":[{"id":"33c8f5b3-464f-47c6-b137-63a855018bca","name":"Purchases-success","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer {{APIKey}}"}],"url":"https://api.paysecure.net/api/v1/purchases/{purchaseId}/"},"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":"{\r\n \"purchaseId\": \"667cfc59f0bd8d672c8fc6c8\",\r\n \"client\": {\r\n \"email\": \"user1571@example.com\",\r\n \"phone\": \"+447755564318\",\r\n \"full_name\": \"Test test\",\r\n \"date_of_birth\": \"1970-07-10\",\r\n \"street_address\": \"13 Documentation Way\",\r\n \"country\": \"EG\",\r\n \"city\": \"Milford\",\r\n \"zip_code\": \"68403\",\r\n \"cc\": [],\r\n \"bcc\": [],\r\n \"stateCode\": \"QLD\"\r\n },\r\n \"updated_on\": 1719467097,\r\n \"type\": \"purchase\",\r\n \"paymentMethod\": \"FAWRYPAY\",\r\n \"amountUnit\": \"MAJOR\",\r\n \"errorMsg\": \"\",\r\n \"redirectType\": \"POST\",\r\n \"force_recurring\": false,\r\n \"created_on\": 1719467097,\r\n \"merchantRef\": \"667cfc59f0bd8d672c8fc6c8\",\r\n \"instruction\": \"Please use the reference number 9350717665 to pay 10 EGP for this order at Fawrypay store. Complete the payment before 6/29/2024 5:45:00 AM +00:00\",\r\n \"merchantName\": \"merchant002\",\r\n \"purchase\": {\r\n \"currency\": \"EGP\",\r\n \"products\": [\r\n {\r\n \"name\": \"test\",\r\n \"quantity\": 1.0,\r\n \"price\": 10.0,\r\n \"discount\": 0,\r\n \"tax_percent\": \"0.00\"\r\n }\r\n ],\r\n \"total\": 10.0,\r\n \"language\": \"en\",\r\n \"notes\": \"\",\r\n \"debt\": 0,\r\n \"total_formatted\": 1.0,\r\n \"request_client_details\": [],\r\n \"timezone\": \"MIT\",\r\n \"email_message\": \"\"\r\n },\r\n \"payment\": {\r\n \"is_outgoing\": false,\r\n \"payment_type\": \"PURCHASE\",\r\n \"amount\": 10.0,\r\n \"currency\": \"EGP\",\r\n \"net_amount\": 10.0,\r\n \"fee_amount\": 0.0,\r\n \"pending_amount\": 0.0,\r\n \"pending_unfreeze_on\": null,\r\n \"description\": \"\",\r\n \"paid_on\": 1719467097,\r\n \"remote_paid_on\": 1719467097\r\n },\r\n \"issuer_details\": {\r\n \"website\": \"\",\r\n \"legal_street_address\": \"\",\r\n \"legal_country\": \"\",\r\n \"legal_city\": \"\",\r\n \"legal_zip_code\": \"\",\r\n \"bank_accounts\": [\r\n {}\r\n ],\r\n \"legal_name\": \"test6\",\r\n \"brand_name\": \"test6\",\r\n \"registration_number\": \"\",\r\n \"tax_number\": \"\"\r\n },\r\n \"transaction_data\": {\r\n \"payment_method\": \"\",\r\n \"flow\": \"payform\",\r\n \"extra\": {\r\n \"amount\": 10.0,\r\n \"masked_pan\": \"FAWRYPAY\"\r\n },\r\n \"country\": \"\",\r\n \"attempts\": [\r\n {\r\n \"client_ip\": \"203.0.113.226\",\r\n \"type\": \"execute\",\r\n \"payment_method\": \"FAWRYPAY\",\r\n \"flow\": \"payform\",\r\n \"successful\": true,\r\n \"country\": \"FAWRYPAY\",\r\n \"processing_time\": 1719467097,\r\n \"extra\": {\r\n \"amount\": 10.0,\r\n \"masked_pan\": \"FAWRYPAY\"\r\n }\r\n }\r\n ]\r\n },\r\n \"status\": \"PAYMENT_IN_PROCESS\",\r\n \"status_history\": [\r\n {\r\n \"status\": \"created\",\r\n \"timestamp\": 1719467097\r\n },\r\n {\r\n \"status\": \"pending_execute\",\r\n \"timestamp\": 1719467097\r\n },\r\n {\r\n \"status\": \"payment_in_process\",\r\n \"timestamp\": 1719467097\r\n },\r\n {\r\n \"status\": \"viewed\",\r\n \"timestamp\": 1719467160\r\n }\r\n ],\r\n \"viewedOn\": 1719467160,\r\n \"is_test\": false,\r\n \"brand_id\": \"your-brand-id\",\r\n \"send_receipt\": false,\r\n \"is_recurring_token\": false,\r\n \"skip_capture\": false,\r\n \"reference_generated\": \"PS10253\",\r\n \"issued\": \"2024-06-27\",\r\n \"due\": 1719467097,\r\n \"refund_upto\": 1735015500,\r\n \"cc_descriptor\": \"\",\r\n \"fraudScore\": \"NA\",\r\n \"trustScore\": \"NA\",\r\n \"payInDetails\": {\r\n \"reference_number\": \"9350717665\",\r\n \"payment_method\": \"PAYATFAWRY\",\r\n \"transaction_expiry\": \"29 Jun 2024 05:45:00:245 +0000\"\r\n },\r\n \"refund_availability\": \"NONE\",\r\n \"refundable_amount\": 10.0,\r\n \"success_redirect\": \"https://your.success.redirect.com\",\r\n \"failure_redirect\": \"https://your.failure.redirect.com\",\r\n \"cancel_redirect\": \"\",\r\n \"success_callback\": \"https://your.success.callback.com\",\r\n \"failure_callback\": \"https://your.failure.callback.com\",\r\n \"platform\": \"API\",\r\n \"created_from_ip\": \"203.0.113.226\",\r\n \"checkout_url\": \"https://api.paysecure.net/payments/667cfb2cf0bd8d672c8fc562/\"\r\n}"},{"id":"aeee0333-2a5b-4812-8170-6a1690b3f457","name":"Purchases","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer {{APIKey}}","type":"text"}],"url":"https://api.paysecure.net/api/v1/purchases/{purchaseId}/"},"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":"{\r\n \"message\": \"Error Message\",\r\n \"code\": \"error_code\"\r\n}\r\n"}],"_postman_id":"1e0589a4-ba3a-45c3-82a1-30c7e1546d8b"}],"id":"b79ff71f-d862-4bc3-be46-9bb1304cae76","description":"

API Flow

\n\n

The merchant initiates the purchase via the create purchase API. If successful, they receive PayIn details (Unique Ref Code) along with a checkout URL in the response JSON
\n
The merchant then has 2 options
\n
1. Use the PayIn details in the JSON to create a webpage within the merchant’s IT estate, and show to user the PayIn instruction
  \n
2. Or direct the end-user to our checkout URL, where the client sees bank details for payment.
  \n
\n
After a successful or failed payment by the end user, an appropriate webhook would be sent to the merchant. If option 2b was the method employed, the user would be redirected to the appropriate redirect URL.
\n

\n","_postman_id":"b79ff71f-d862-4bc3-be46-9bb1304cae76"},{"name":"PayOut API","item":[{"name":"Create PayOut","id":"9549c867-611c-44c5-b95d-ba89448953a6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer {{APIKey}}"}],"body":{"mode":"raw","raw":"{\r\n \"client\": {\r\n \"email\": \"user5772@example.com\",\r\n \"country\" : \"EG\",\r\n \"phone\" : \"9586445444\",\r\n\"full_name\": \"Avery Larsen\",\r\n\"documentId\":\"29206260104051\"\r\n },\r\n \"purpose\" : \"test payout\",\r\n \"currency\" : \"EGP\",\r\n \"payoutMethod\" : \"Payout-fawrypay\",\r\n \"amount\" : 20,\r\n \"success_callback\": \"https://your.success.callback.com\",\r\n \"failure_callback\": \"https://your.failure.callback.com\"\r\n \r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.paysecure.net/api/v1/payout/","description":"

To Initiate a payment, the very first call to make is/payout/

with the required data in the request body.

To generate a Payout, you are required to provide the API key (in the header) can be located in the Dashboard section of your merchant account login.

The request body structure is shown on the request body of the example request shown here.

The following (see table below) are the mandatory parameters that are required to create a Payout 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

Parameter	Notes
client.email or client.phone	An Identifier for a user
client.full_name
client.country
payoutMethod
Currency	Note this is currency account for which you have balance
Amount
Purpose

","urlObject":{"path":["payout",""],"host":["https://api.paysecure.net/api/v1"],"query":[{"disabled":true,"key":"","value":null},{"disabled":true,"key":null,"value":""}],"variable":[]}},"response":[{"id":"8ee8634d-bcee-45b0-a712-b657f87e0fe6","name":"create payout-success","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer {{APIKey}}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"client\": {\r\n \"email\": \"user5772@example.com\",\r\n \"country\" : \"EG\",\r\n \"phone\" : \"9586445444\",\r\n\"full_name\": \"Avery Larsen\",\r\n\"documentId\":\"29206260104051\"\r\n },\r\n \"purpose\" : \"test payout\",\r\n \"currency\" : \"EGP\",\r\n \"payoutMethod\" : \"Payout-fawrypay\",\r\n \"amount\" : 20,\r\n \"success_callback\": \"https://your.success.callback.com\",\r\n \"failure_callback\": \"https://your.failure.callback.com\"\r\n \r\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://api.paysecure.net/api/v1/payout/","host":["https://api.paysecure.net/api/v1"],"path":["payout",""],"query":[{"key":"","value":null,"disabled":true},{"key":null,"value":"","disabled":true}]}},"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":"{\r\n \"payoutId\": \"6687d86dde5d5c0feecf7621\",\r\n \"client\": {\r\n \"email\": \"user5772@example.com\",\r\n \"phone\": \"9586445444\",\r\n \"full_name\": \"Avery Larsen\",\r\n \"country\": \"EG\",\r\n \"documentId\": \"29206260104051\"\r\n },\r\n \"updated_on\": 1720178797,\r\n \"payoutMethod\": \"PAYOUT-FAWRYPAY\",\r\n \"amountUnit\": \"MAJOR\",\r\n \"amount\": 20.0,\r\n \"errorMsg\": \"\",\r\n \"purpose\": \"test payout\",\r\n \"created_on\": 1720178797,\r\n \"merchantRef\": \"6687d86dde5d5c0feecf7621\",\r\n \"status\": \"PAYOUT_IN_PROCESS\",\r\n \"status_history\": [\r\n {\r\n \"status\": \"created\",\r\n \"timestamp\": 1720178797\r\n },\r\n {\r\n \"status\": \"payout_in_process\",\r\n \"timestamp\": 1720178799\r\n }\r\n ],\r\n \"currency\": \"EGP\",\r\n \"paymentOn\": 0,\r\n \"payOutDetails\": {\r\n \"instruction\": \"Please use transaction reference 20514294 with the BTC 77361 at any Fawry store to get cashout within 72 hrs\"\r\n },\r\n \"success_callback\": \"https://your.success.callback.com\",\r\n \"failure_callback\": \"https://your.failure.callback.com\"\r\n}"},{"id":"b4f0f8fb-affa-4f6e-903b-206da00b1591","name":"create payout-error","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer {{APIKey}}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"client\": {\r\n \"email\": \"user5772@example.com\",\r\n \"country\" : \"EG\",\r\n \"phone\" : \"9586445444\",\r\n\"full_name\": \"Avery Larsen\",\r\n\"documentId\":\"29206260104051\"\r\n },\r\n \"purpose\" : \"test payout\",\r\n \"currency\" : \"EGP\",\r\n \"payoutMethod\" : \"Payout-fawrypay\",\r\n \"amount\" : 20,\r\n \"success_callback\": \"https://your.success.callback.com\",\r\n \"failure_callback\": \"https://your.failure.callback.com\"\r\n \r\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://api.paysecure.net/api/v1/payout/","host":["https://api.paysecure.net/api/v1"],"path":["payout",""],"query":[{"key":"","value":null,"disabled":true},{"key":null,"value":"","disabled":true}]}},"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":" {\r\n \"message\": \"Error Message\",\r\n \"code\": \"error_code\"\r\n}\r\n"}],"_postman_id":"9549c867-611c-44c5-b95d-ba89448953a6"},{"name":"Get Status","id":"86f7c369-43c7-4165-bc25-0e251d4864d7","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.paysecure.net/api/v1/getpayout/{payoutId}/","description":"

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

Mandatory

you need to pass the payoutId 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
payout_in_process	payout is under Processing.
error	Transaction has Failed.

The webhook will only be triggered for paid transactions or errors.

Paid: \"success_callback\": \"https://your.success.callback.com\",

Error: \"failure_callback\": “https://failure.com”

\n","urlObject":{"path":["getpayout","{payoutId}",""],"host":["https://api.paysecure.net/api/v1"],"query":[],"variable":[]}},"response":[{"id":"c193e84f-1bb3-48a5-8b38-0ed15ac3fa59","name":"Get success Status","originalRequest":{"method":"GET","header":[],"url":"https://api.paysecure.net/api/v1/getpayout/{payoutId}/"},"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":"{\r\n \"payoutId\": \"6685467c0e5b201a73f91256\",\r\n \"client\": {\r\n \"email\": \"user5772@example.com\",\r\n \"phone\": \"9586445444\",\r\n \"full_name\": \"Avery Larsen\",\r\n \"country\": \"EG\",\r\n \"documentId\": \"29206260104051\"\r\n },\r\n \"updated_on\": 1720010823,\r\n \"payoutMethod\": \"PAYOUT-FAWRYPAY\",\r\n \"beneficiaryDetail\": {\r\n \"bankAccountNumber\": \"123456789011\",\r\n \"upi\": \"charles.babbage@okhdfc\",\r\n \"transferType\": \"IMPS\",\r\n \"ifscCode\": \"SBIN0001077\",\r\n \"payeeName\": \"Morgan Costa\"\r\n },\r\n \"amountUnit\": \"MAJOR\",\r\n \"amount\": 20.0,\r\n \"errorMsg\": \"\",\r\n \"purpose\": \"test payout\",\r\n \"created_on\": 1720010364,\r\n \"merchantRef\": \"6685467c0e5b201a73f91256\",\r\n \"merchantName\": \"test\",\r\n \"status\": \"PAID\",\r\n \"status_history\": [\r\n {\r\n \"status\": \"created\",\r\n \"timestamp\": 1720010364\r\n },\r\n {\r\n \"status\": \"payout_in_process\",\r\n \"timestamp\": 1720010367\r\n },\r\n {\r\n \"status\": \"viewed\",\r\n \"timestamp\": 1720010582\r\n },\r\n {\r\n \"status\": \"paid\",\r\n \"timestamp\": 1720010823\r\n }\r\n ],\r\n \"viewedOn\": 1720179568,\r\n \"currency\": \"EGP\",\r\n \"paymentOn\": 1720010823,\r\n \"success_callback\": \"https://your.success.callback.com\",\r\n \"failure_callback\": \"https://your.failure.callback.com\"\r\n}"},{"id":"5fe50856-99f4-4ec7-866c-70648fccafd8","name":"Get Error Status","originalRequest":{"method":"GET","header":[],"url":"https://api.paysecure.net/api/v1/getpayout/{payoutId}/"},"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":"{\r\n \"message\": \"Error Message\",\r\n \"code\": \"error_code\"\r\n}"}],"_postman_id":"86f7c369-43c7-4165-bc25-0e251d4864d7"}],"id":"856ce615-c87f-4d18-afab-66edf20ece37","description":"

API Flow

\n\n

The merchant initiates a PayOut via the payout API.
\n
After a successful or failed payment attempt, the status is reflected on the response, and the details on the status history. You can also get the status through getStatus (purchases/{payID}) API.
\n

\n","_postman_id":"856ce615-c87f-4d18-afab-66edf20ece37"},{"name":"Get Balance API","item":[{"name":"Checking Balance","id":"9c6f0d8f-776e-47af-ac5e-3113436bbeb8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{APIKey}}","type":"text"}],"body":{"mode":"raw","raw":"{ \r\n \"paymentMethod\" : \"INTERAC\"\r\n\r\n}\r\n","options":{"raw":{"language":"json"}}},"url":"https://api.paysecure.net/api/v1/getBalance","description":"

API for Checking Balance payout

URL :- /getBalance/
\n
RequestType: POST
\n
Request Body
\n

\n","urlObject":{"path":["getBalance"],"host":["https://api.paysecure.net/api/v1"],"query":[],"variable":[]}},"response":[{"id":"000ec21f-0078-4460-ab79-5f7e5934f117","name":"Checking Balance payout-success","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{ \r\n \"paymentMethod\" : \"INTERAC\"\r\n\r\n}\r\n","options":{"raw":{"language":"json"}}},"url":"https://api.paysecure.net/api/v1/getBalance"},"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":"{\r\n \"paymentMethod\": \"FAWRYPAY\",\r\n \"status\": \"success\",\r\n \"data\": [\r\n {\r\n \"currency\": \"AUD\",\r\n \"balance\": \"0.00\"\r\n },\r\n {\r\n \"currency\": \"CAD\",\r\n \"balance\": \"0.00\"\r\n },\r\n {\r\n \"currency\": \"EGP\",\r\n \"balance\": \"-1.20\"\r\n },\r\n {\r\n \"currency\": \"EUR\",\r\n \"balance\": \"0.00\"\r\n },\r\n {\r\n \"currency\": \"GBP\",\r\n \"balance\": \"0.00\"\r\n },\r\n {\r\n \"currency\": \"INR\",\r\n \"balance\": \"0.00\"\r\n },\r\n {\r\n \"currency\": \"NGN\",\r\n \"balance\": \"0.00\"\r\n },\r\n {\r\n \"currency\": \"USD\",\r\n \"balance\": \"0.00\"\r\n },\r\n {\r\n \"currency\": \"ZAR\",\r\n \"balance\": \"0.00\"\r\n }\r\n ]\r\n}\r\n"},{"id":"e0de1243-7265-479a-bb4e-199862dfe841","name":"Checking Balance payout-error","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{ \r\n \"paymentMethod\" : \"INTERAC\"\r\n\r\n}\r\n","options":{"raw":{"language":"json"}}},"url":"https://api.paysecure.net/api/v1/getBalance"},"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":"{\r\n \"message\": \"Error Message\",\r\n \"code\": \"No currency account found\"\r\n}\r\n"}],"_postman_id":"9c6f0d8f-776e-47af-ac5e-3113436bbeb8"}],"id":"eae8d9d8-9ca8-4137-ace9-b52a05a1d544","_postman_id":"eae8d9d8-9ca8-4137-ace9-b52a05a1d544","description":""}],"id":"47d75ccc-29c2-4b1a-9fc6-43b7d0ac66e8","_postman_id":"47d75ccc-29c2-4b1a-9fc6-43b7d0ac66e8","description":""},{"name":"🇮🇳 UPI Solution","item":[{"name":"Concepts","item":[],"id":"1de2d0d3-e894-4a93-bfd6-ed648c550b69","description":"

UPI Overview

The Unified Payments Interface (UPI) technology unifies various banking functions, smooth fund routing, and merchant payments under one roof by enabling numerous bank accounts into a single mobile application (of any participating bank).

Paysecure’s UPI product suite enables merchants to initiate:

PayIns: Consumers can utilise UPI to transfer funds from their bank account, through their bank’s app or website.
\n
Payouts: Facilitate real-time disbursements directly to consumers' accounts by UPI ID, IMPS, RTGS,NEFT.
\n

PayIn Flows

How it works

Paysecure’s UPI PayIn API lets the platforms collect funds from payers through intent flow/payment link without entering the payer's VPA. Suitable for app or mobile-based flows.

Key Steps

\n\n

Flow

Initiate Transfer Request: The merchant sends a request to the UPI PayIn API to initiate a PayIn (deposit/collections) transaction. This request includes the customer’s email address or mobile number, the amount to be collected, and an optional message.
\n
UPI payment options: The API generates a Multiple payment option (PayTM, GPay, PhonePe apps as well by scanning QR code) where end user can select any one payment option to complete the transaction.
\n
User pays using their App: User will then pay the amount using their desired payment app and method through default UPI apps or by scanning the QR code via any bank app)
\n
Confirm Transfer Completion: Once the transfer is completed by the end user, the paysecure would send webhook of payment completion with the status. The balance of merchant would be updated to reflect the new transaction’s outcome.
\n
Update Merchant’s Account: The merchant would then update (on the merchant’s system) the customer’s account balance to reflect the received funds.
\n

PayOut flows

How it works

Our APIs enable payouts through various channels, including IMPS, UPI, RTGS, and NEFT, to user's bank accounts.

Here are some common use cases, though not limited to these:

Vendor Payouts: Quickly settle payments for goods or services with your vendors or distributors.
\n
Payroll & Reimbursements: Disburse salaries, ad-hoc payments, or employee reimbursements to staff or agents.
\n
Disbursements: Facilitate loan or credit disbursements to merchants or consumers' bank accounts via your own or a lender's account.
\n

*Key Steps*

\n\n

Flow

We recommend that merchan't validate the bank accounts of their customer's bank account before doing payouts.
\n
Ensure that enough balance is there in your merchant account do the payout.
\n
The merchant platform initiates the creation of a payout by passing beneficiary details, along with payout details.
\n
Beneficiary's bank details
\n
- Beneficiary's transfer Type (IMPS, RTGS, NEFT, UPI)
  \n
- Beneficiary's ifsc Code (if transferType is either of IMPS, RTGS, or NEFT)
  \n
- Beneficiary's payee Name (if transferType is either of IMPS, RTGS, or NEFT)
  \n
- Beneficiary's bank Account Number (if transferType is either of IMPS, RTGS, or NEFT)
  \n
\n
Upon completion of the payout, reaching either a Success or Failure state, Paysecure notifies the merchant’s platform via webhook, providing the final status of the transaction and additional details.
\n

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.

Optional Parameters

expireInMin

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.

paymentMethod

Possible Payment Methods allowed: UPI-QR and UPI-INTENT

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 payment method 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.

","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"692d92d3-a2fd-42ee-be95-e0971624f41c","id":"692d92d3-a2fd-42ee-be95-e0971624f41c","name":"PayIn API","type":"folder"}},"urlObject":{"path":["purchases",""],"host":["https://api.paysecure.net/api/v1"],"query":[],"variable":[]}},"response":[{"id":"9dd85b02-c9ba-4f17-b321-7dc05634c7c6","name":"UPI-QR","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer {{APIKey}}"}],"body":{"mode":"raw","raw":"{\r\n \"client\": {\r\n \"email\": \"user5772@example.com\",\r\n \"full_name\": \"test test\",\r\n \"country\": \"IN\",\r\n \"city\": \"Riverton\",\r\n \"stateCode\": \"RJ\",\r\n \"street_address\": \"58 Testing Lane\",\r\n \"zip_code\": \"302022\",\r\n \"date_of_birth\": \"1994-31-04\",\r\n \"phone\": \"+91 9634988765\"\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 \"paymentMethod\": \"UPI-QR\",\r\n \"merchantRef\": \"test12\", // optional\r\n \"brand_id\": \"your-brand-id\",\r\n \"success_redirect\": \"https://your.success.redirect.com\",\r\n \"pending_redirect\": \"https://your.pending.redirect.com\",\r\n \"failure_redirect\": \"https://your.failure.redirect.com\",\r\n \"success_callback\": \"https://your.success.callback.com\",\r\n \"failure_callback\": \"https://your.failure.callback.com\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.paysecure.net/api/v1/purchases"},"status":"Success","code":202,"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":"{\r\n \"purchaseId\": \"6682942d5273633e7b8d30c8\",\r\n \"client\": {\r\n \"email\": \"user1571@example.com\",\r\n \"date_of_birth\": \"1970-07-10\",\r\n \"street_address\": \"13 Documentation Way\",\r\n \"country\": \"EG\",\r\n \"city\": \"Milford\",\r\n \"zip_code\": \"68403\",\r\n \"cc\": [],\r\n \"bcc\": [],\r\n \"stateCode\": \"QLD\"\r\n },\r\n \"updated_on\": 1719833645,\r\n \"type\": \"purchase\",\r\n \"paymentMethod\": \"UPI-QR\",\r\n \"amountUnit\": \"MAJOR\",\r\n \"errorMsg\": \"\",\r\n \"redirectType\": \"POST\",\r\n \"force_recurring\": false,\r\n \"created_on\": 1719833645,\r\n \"merchantRef\": \"6682942d5273633e7b8d30c8\",\r\n \"merchantName\": \"merchant002\",\r\n \"purchase\": {\r\n \"currency\": \"INR\",\r\n \"products\": [\r\n {\r\n \"name\": \"test\",\r\n \"quantity\": 1.0,\r\n \"price\": 10.0,\r\n \"discount\": 0,\r\n \"tax_percent\": \"0.00\"\r\n }\r\n ],\r\n \"total\": 10.0,\r\n \"language\": \"en\",\r\n \"notes\": \"\",\r\n \"debt\": 0,\r\n \"total_formatted\": 1.0,\r\n \"request_client_details\": [],\r\n \"timezone\": \"MIT\",\r\n \"email_message\": \"\"\r\n },\r\n \"payment\": {\r\n \"is_outgoing\": false,\r\n \"payment_type\": \"PURCHASE\",\r\n \"amount\": 10.0,\r\n \"currency\": \"INR\",\r\n \"net_amount\": 10.0,\r\n \"fee_amount\": 0.0,\r\n \"pending_amount\": 0.0,\r\n \"pending_unfreeze_on\": null,\r\n \"description\": \"\",\r\n \"paid_on\": 1719833645,\r\n \"remote_paid_on\": 1719833645\r\n },\r\n \"issuer_details\": {\r\n \"website\": \"\",\r\n \"legal_street_address\": \"\",\r\n \"legal_country\": \"\",\r\n \"legal_city\": \"\",\r\n \"legal_zip_code\": \"\",\r\n \"bank_accounts\": [\r\n {}\r\n ],\r\n \"legal_name\": \"test6\",\r\n \"brand_name\": \"test6\",\r\n \"registration_number\": \"\",\r\n \"tax_number\": \"\"\r\n },\r\n \"transaction_data\": {\r\n \"payment_method\": \"\",\r\n \"flow\": \"payform\",\r\n \"extra\": {\r\n \"amount\": 10.0,\r\n \"masked_pan\": \"UPI\"\r\n },\r\n \"country\": \"\",\r\n \"attempts\": [\r\n {\r\n \"client_ip\": \"203.0.113.113\",\r\n \"type\": \"execute\",\r\n \"payment_method\": \"UPI-QR\",\r\n \"flow\": \"payform\",\r\n \"successful\": true,\r\n \"country\": \"UPI\",\r\n \"processing_time\": 1719833645,\r\n \"extra\": {\r\n \"amount\": 10.0,\r\n \"masked_pan\": \"UPI\"\r\n }\r\n }\r\n ]\r\n },\r\n \"status\": \"PAYMENT_IN_PROCESS\",\r\n \"status_history\": [\r\n {\r\n \"status\": \"created\",\r\n \"timestamp\": 1719833645\r\n },\r\n {\r\n \"status\": \"pending_execute\",\r\n \"timestamp\": 1719833645\r\n },\r\n {\r\n \"status\": \"payment_in_process\",\r\n \"timestamp\": 1719833645\r\n }\r\n ],\r\n \"is_test\": false,\r\n \"brand_id\": \"your-brand-id\",\r\n \"send_receipt\": false,\r\n \"is_recurring_token\": false,\r\n \"skip_capture\": false,\r\n \"reference_generated\": \"PS10421\",\r\n \"issued\": \"2024-07-01\",\r\n \"due\": 1719833645,\r\n \"refund_upto\": 0,\r\n \"cc_descriptor\": \"\",\r\n \"fraudScore\": \"NA\",\r\n \"trustScore\": \"NA\",\r\n \"payInDetails\": {\r\n \"expiration_date\": \"2025-03-27 23:59:59\",\r\n \"qrCode\": \"iVBORw0KGgoAAAANSUhEUgAAAb0AAAG9AQAAAACpVZXpAAAH7UlEQVR4nO1cQY7qSgw0yiJLjpCbJBdDIhIXg5vkCCyzQPi7qtwkM2/zNcsYpIfeQFcvTNtdLtsx/9trtS/wC/wCv8A/AZ9mdnpevb9bt6zj+TWso3Uen17i33nGkgverotN/orP7FoHeHV/AG1nfnoZ+kfYrcdKv8ei/gEMvljxRkQZ4MVi5Ww2nm9LbBF/xnLYd7YVVu3dZ262hPUvA3+CUsCnDesJ39/PHhidtlg5cRFek9+WtSgwPO595ldGI4dTAohX/8ZpG2Hp8MdiQPnjEL7XIWJdEae6BfvgC0SxCGCx2Q2fvf5x5GMDGckRov7X2+8r4NhAvW6O82QrHBBeuGBHHjSHK7rDtDxtv8jD0YERv8PPwAHcRjogbv43/BF/wuZwytgHO9r4serxgbIg7vvzPNALY1GHzXDrwYJji2JgTsvOkY8PxGnDDYeVsPHcYjWoUtx6jF04cjPsa8PmjxWAroMWUbtbdPPHPuGZsOqdX8SfOJXGu26zagVgLILHraTWvOUDjRuuU4jq4a2xj8y9hLd6HaArFcMtD997gVoHJYCRwa8H2HzgWVxBDkoBxR5lraVHxIpgdWXEcjJKHrmw+S2Z071F8gLA+JSGCkwEbISoOFnJHiNtvSAhgc0RpyKmw/BeBqgUFUcJGIPWAZnjY1VXis+bUMdw93McHph0kXedfA/pBfMx5CKLlJCJ9n3+FEkOD1QSiuUyrSWaQfyuc0eS3UElm+m8ZYDNqrCbkQMgMMGWEcCQhdEB6a1Jsps/VgCGybASWTtOFu1Lz8SlD/lsgheepBXFupaUFQEiC4MXzozaRjYQrnhRAksioORDbx8doAAQkfwM3qzrP4MVI3lwRqeEOEgTgc37eyVg5zxFZNAuboR0HlkY5VZdbszbELtk6SpAk/DV44yBB2H5zFSWgR3KPAkSKIHZT3nt6EA4INgPmKJRim/1L1MljKI8zS0NbSwElG5qrX6DwsQkDQh5Kr91prI3V4jfqHUBYKfKH9jPQPbDCpchTkmop/xzgiYi9dULASm2863TQeuxGYuDYVUzmtFOm3tuxaDjA+Fi0AehAZFB0zOpfxikD4Uo7YOw9SFIBYAqkN4UyRnY4ZnNFWnfVlpX7WeTEI8PBGWepDvLZCDPopBZOQVVgj+CCNwaaaoBxP8p/zDloN5jZI/sQABGeYe7ctftyBUAPpmmozqBpAyZ/ArxmXmqfJTqIZVWbLGJJBWAtCXqN8rCqIN1rqh9N0qIs84dGzU2raMAkPEbJjMWt85atJg1fZXZhm7CURyqDvCpWpejnUci4QrxmWSSVQwqRGwT47qdEFQBOPCWpxeCPBulsl55KiyIOM96hiLWw+sAndSQB+1KqQxnjEBmIC+xb2NNjFnJp95RASjimEViKtAiTWoEM1bf1YHK2vKOPR4fiJuLyrIZuk0hNOP6Z9McsxJk8gsJEm44sYEqQHaghvF4fQk9ch+9MXR3aOdRJA9KsJVKDw9k1FbDE1WyiOkUghiwSQlQycmyz5mCRyWgZxAyFU2dJJvxm59RsgerlmS/XXMFgOzfYU3H1OFuSlaRnq288JyuyL5dhLJPB0IBIBa9mbCrOYxaqkqlqPwhlcU1B89Ud/wnklcABjdCmi4dEcoyo1Nrt2yVsDGrGGpqrgNUqY8siQblQXMeOcZv6Ijr1LpYdjWd4wM9h2yYcanE02gRxY3WmSHSxBKP1wFK4NFVz0i0jZUwO2Viz3PHA7nrfD4+8MlRLCRl4NITs42WxPdZxKGQdpXSah/aWQDo5IcJVB2ZhBrHi0UcmjY7eH/8HAWAraaTxMfSAU1ah9E9L8pAVD6tBGQnt/h1bMFGg3fLMdjUwvaMNfMOzCJtR+7wQPWucKBmZjjnV61DjJtxXkJpiO1qOhWAOV/TYhKcUpM2F91rxqGJVrHYdXcXAPIA5dDsIPXwnUZWOxRpgrMjEzORW8GrAnDO4tbE8QnORrCfBeeOMvSk3h/LLR6FgNtIIyui1OglaTAhYXNYamicufGdIx8eqFz9ZTkMYWy8dA1vqRp4Ir/2WcLINlBQAPgkIWQQz0c8OFvlkl8zA5lzGAeHz9+FgO6ii+y9QCRSowHdTtH9xOZTjWBn6asKUK2VvtBaUuFH+R62oAZkObLfKzM71wHCqhyVaFPpIs/emndV+mLfBmtivv85Dg9kAwajE+K3kg8lpq3YA0dlY48GAM+FgDklq7wDoVtUaVT/e/YdJDdiUcPrAHmeFJhemkBKMunZ/y6nZDeYGMKmzB8eCBshHW1T6VhuqdabzmI+P2Tpm1OWAWoei88uSBV+o9G7eimfN4O0f9e/enyg9PgL5Xk9tqDP9OKmKilbCNU0dxL6Wgr4aOlo/yGOagQ7yeZqwYRnXndlxArAnNHfRvbzXlML5ktJmWdij2rgsxAQVlVJMF2xaUCcGuUH6n9SpX3f9XR8IF7qQIiTlUWcznXf5/CRZfflqIGuaxkgDEVqaOyX4+VmnNvic2SyTCi5VRWfdgVUAF5dUVtj6KrpwL545dMX7TNg/LMaeHygnr7YxNM2JcEvVOLJrISKolk9oPpxW7ep+JJodLJqnkpN9Vs1IFxsarqzpLKHsrUXGaW1+vrFfj3w8+BA+iOHA1omrxbCJ9F67IP2oUK04+QFgC2Sq8U7x5CGTyVsaL3LLjIp9ywC/NPrC/wCv8Av8C/A/wCpreUSrYyOqQAAAABJRU5ErkJggg==\",\r\n },\r\n \"refund_availability\": \"NONE\",\r\n \"refundable_amount\": 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 \"platform\": \"API\",\r\n \"created_from_ip\": \"203.0.113.113\",\r\n \"checkout_url\": \"https://api.paysecure.net/payments/6682942d5273633e7b8d30c8/\"\r\n}\r\n"},{"id":"09767f32-af02-4c5b-b164-1f67ee5e4918","name":"UPI-INTENT","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer {{APIKey}}"}],"body":{"mode":"raw","raw":"{\r\n \"client\": {\r\n \"email\": \"user5772@example.com\",\r\n \"full_name\": \"test test\",\r\n \"country\": \"IN\",\r\n \"city\": \"Riverton\",\r\n \"stateCode\": \"RJ\",\r\n \"street_address\": \"58 Testing Lane\",\r\n \"zip_code\": \"302022\",\r\n \"date_of_birth\": \"1994-31-04\",\r\n \"phone\": \"+91 9634988765\"\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 \"paymentMethod\": \"UPI-INTENT\",\r\n \"merchantRef\": \"test12\", // optional\r\n \"brand_id\": \"your-brand-id\",\r\n \"success_redirect\": \"https://your.success.redirect.com\",\r\n \"pending_redirect\": \"https://your.pending.redirect.com\",\r\n \"failure_redirect\": \"https://your.failure.redirect.com\",\r\n \"success_callback\": \"https://your.success.callback.com\",\r\n \"failure_callback\": \"https://your.failure.callback.com\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.paysecure.net/api/v1/purchases"},"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":"{\r\n \"purchaseId\": \"6682942d5273633e7b8d30c8\",\r\n \"client\": {\r\n \"email\": \"user1571@example.com\",\r\n \"date_of_birth\": \"1970-07-10\",\r\n \"street_address\": \"13 Documentation Way\",\r\n \"country\": \"EG\",\r\n \"city\": \"Milford\",\r\n \"zip_code\": \"68403\",\r\n \"cc\": [],\r\n \"bcc\": [],\r\n \"stateCode\": \"QLD\"\r\n },\r\n \"updated_on\": 1719833645,\r\n \"type\": \"purchase\",\r\n \"paymentMethod\": \"UPI-INTENT\",\r\n \"amountUnit\": \"MAJOR\",\r\n \"errorMsg\": \"\",\r\n \"redirectType\": \"POST\",\r\n \"force_recurring\": false,\r\n \"created_on\": 1719833645,\r\n \"merchantRef\": \"6682942d5273633e7b8d30c8\",\r\n \"merchantName\": \"merchant002\",\r\n \"purchase\": {\r\n \"currency\": \"INR\",\r\n \"products\": [\r\n {\r\n \"name\": \"test\",\r\n \"quantity\": 1.0,\r\n \"price\": 10.0,\r\n \"discount\": 0,\r\n \"tax_percent\": \"0.00\"\r\n }\r\n ],\r\n \"total\": 10.0,\r\n \"language\": \"en\",\r\n \"notes\": \"\",\r\n \"debt\": 0,\r\n \"total_formatted\": 1.0,\r\n \"request_client_details\": [],\r\n \"timezone\": \"MIT\",\r\n \"email_message\": \"\"\r\n },\r\n \"payment\": {\r\n \"is_outgoing\": false,\r\n \"payment_type\": \"PURCHASE\",\r\n \"amount\": 10.0,\r\n \"currency\": \"INR\",\r\n \"net_amount\": 10.0,\r\n \"fee_amount\": 0.0,\r\n \"pending_amount\": 0.0,\r\n \"pending_unfreeze_on\": null,\r\n \"description\": \"\",\r\n \"paid_on\": 1719833645,\r\n \"remote_paid_on\": 1719833645\r\n },\r\n \"issuer_details\": {\r\n \"website\": \"\",\r\n \"legal_street_address\": \"\",\r\n \"legal_country\": \"\",\r\n \"legal_city\": \"\",\r\n \"legal_zip_code\": \"\",\r\n \"bank_accounts\": [\r\n {}\r\n ],\r\n \"legal_name\": \"test6\",\r\n \"brand_name\": \"test6\",\r\n \"registration_number\": \"\",\r\n \"tax_number\": \"\"\r\n },\r\n \"transaction_data\": {\r\n \"payment_method\": \"\",\r\n \"flow\": \"payform\",\r\n \"extra\": {\r\n \"amount\": 10.0,\r\n \"masked_pan\": \"UPI\"\r\n },\r\n \"country\": \"\",\r\n \"attempts\": [\r\n {\r\n \"client_ip\": \"203.0.113.113\",\r\n \"type\": \"execute\",\r\n \"payment_method\": \"UPI-COLLECT\",\r\n \"flow\": \"payform\",\r\n \"successful\": true,\r\n \"country\": \"UPI\",\r\n \"processing_time\": 1719833645,\r\n \"extra\": {\r\n \"amount\": 10.0,\r\n \"masked_pan\": \"UPI\"\r\n }\r\n }\r\n ]\r\n },\r\n \"status\": \"PAYMENT_IN_PROCESS\",\r\n \"status_history\": [\r\n {\r\n \"status\": \"created\",\r\n \"timestamp\": 1719833645\r\n },\r\n {\r\n \"status\": \"pending_execute\",\r\n \"timestamp\": 1719833645\r\n },\r\n {\r\n \"status\": \"payment_in_process\",\r\n \"timestamp\": 1719833645\r\n }\r\n ],\r\n \"is_test\": false,\r\n \"brand_id\": \"your-brand-id\",\r\n \"send_receipt\": false,\r\n \"is_recurring_token\": false,\r\n \"skip_capture\": false,\r\n \"reference_generated\": \"PS10421\",\r\n \"issued\": \"2024-07-01\",\r\n \"due\": 1719833645,\r\n \"refund_upto\": 0,\r\n \"cc_descriptor\": \"\",\r\n \"fraudScore\": \"NA\",\r\n \"trustScore\": \"NA\",\r\n \"payInDetails\": {\r\n \"transaction_expiry\": \"2026-02-21 07:11:13\",\r\n \"intentUri\": \"upi://pay?pa=bom260101330774%40mahb&am=101&tn=jamb&tr=jamb&pn=V%20S%20ENTERPRISEScu=\"\r\n },\r\n \"refund_availability\": \"NONE\",\r\n \"refundable_amount\": 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 \"platform\": \"API\",\r\n \"created_from_ip\": \"203.0.113.113\",\r\n \"checkout_url\": \"https://api.paysecure.net/payments/6682942d5273633e7b8d30c8/\"\r\n}"}],"_postman_id":"fbaaf9fe-5552-43d7-9c43-212db6b6f1ee"},{"name":"Get Status","id":"4c6bec94-c878-4b3d-be81-82c35c7c5944","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer {{APIKey}}","type":"text"}],"url":"https://api.paysecure.net/api/v1/purchases/{purchaseId}/","description":"

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

Note: With respect to bank transfers, the purchase request is synonymous with the PayIn request.

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

Status	Notes
paid	Transaction Successful
payment_in_process	Payment is under Processing
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":"692d92d3-a2fd-42ee-be95-e0971624f41c","id":"692d92d3-a2fd-42ee-be95-e0971624f41c","name":"PayIn API","type":"folder"}},"urlObject":{"path":["purchases","{purchaseId}",""],"host":["https://api.paysecure.net/api/v1"],"query":[],"variable":[]}},"response":[{"id":"cb572bcb-dcb6-435a-92b6-edd546ae9d9f","name":"Success","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer {{APIKey}}"}],"url":"https://api.paysecure.net/api/v1/purchases/{purchaseId}/"},"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":"{\r\n \"purchaseId\": \"66c4667bb993c970367c288a\",\r\n \"client\": {\r\n \"email\": \"user1571@example.com\",\r\n \"date_of_birth\": \"1970-07-10\",\r\n \"street_address\": \"13 Documentation Way\",\r\n \"country\": \"IN\",\r\n \"city\": \"Milford\",\r\n \"zip_code\": \"68403\",\r\n \"cc\": [],\r\n \"bcc\": [],\r\n \"stateCode\": \"QLD\"\r\n },\r\n \"updated_on\": 1724147324,\r\n \"type\": \"purchase\",\r\n \"paymentMethod\": \"UPI\",\r\n \"amountUnit\": \"MAJOR\",\r\n \"errorMsg\": \"\",\r\n \"redirectType\": \"POST\",\r\n \"force_recurring\": false,\r\n \"created_on\": 1724147324,\r\n \"merchantRef\": \"66c4667bb993c970367c288a\",\r\n \"merchantName\": \"merchant002\",\r\n \"purchase\": {\r\n \"currency\": \"INR\",\r\n \"products\": [\r\n {\r\n \"name\": \"test\",\r\n \"quantity\": 1.0,\r\n \"price\": 10.0,\r\n \"discount\": 0,\r\n \"tax_percent\": \"0.00\"\r\n }\r\n ],\r\n \"total\": 10.0,\r\n \"language\": \"en\",\r\n \"notes\": \"\",\r\n \"debt\": 0,\r\n \"total_formatted\": 1.0,\r\n \"expireInMin\": \"35\",\r\n \"request_client_details\": [],\r\n \"timezone\": \"MIT\",\r\n \"email_message\": \"\"\r\n },\r\n \"payment\": {\r\n \"is_outgoing\": false,\r\n \"payment_type\": \"PURCHASE\",\r\n \"amount\": 10.0,\r\n \"currency\": \"INR\",\r\n \"net_amount\": 10.0,\r\n \"fee_amount\": 0.0,\r\n \"pending_amount\": 0.0,\r\n \"pending_unfreeze_on\": null,\r\n \"description\": \"\",\r\n \"paid_on\": 1724147324,\r\n \"remote_paid_on\": 1724147324\r\n },\r\n \"issuer_details\": {\r\n \"website\": \"\",\r\n \"legal_street_address\": \"\",\r\n \"legal_country\": \"\",\r\n \"legal_city\": \"\",\r\n \"legal_zip_code\": \"\",\r\n \"bank_accounts\": [\r\n {}\r\n ],\r\n \"legal_name\": \"test6\",\r\n \"brand_name\": \"test6\",\r\n \"registration_number\": \"\",\r\n \"tax_number\": \"\"\r\n },\r\n \"transaction_data\": {\r\n \"payment_method\": \"\",\r\n \"flow\": \"payform\",\r\n \"extra\": {\r\n \"amount\": 10.0,\r\n \"masked_pan\": \"UPI\"\r\n },\r\n \"country\": \"\",\r\n \"attempts\": [\r\n {\r\n \"client_ip\": \"203.0.113.192\",\r\n \"type\": \"execute\",\r\n \"payment_method\": \"UPI\",\r\n \"flow\": \"payform\",\r\n \"successful\": true,\r\n \"country\": \"UPI\",\r\n \"processing_time\": 1724147324,\r\n \"extra\": {\r\n \"amount\": 10.0,\r\n \"masked_pan\": \"UPI\"\r\n }\r\n }\r\n ]\r\n },\r\n \"status\": \"PAYMENT_IN_PROCESS\",\r\n \"status_history\": [\r\n {\r\n \"status\": \"created\",\r\n \"timestamp\": 1724147324\r\n },\r\n {\r\n \"status\": \"pending_execute\",\r\n \"timestamp\": 1724147324\r\n },\r\n {\r\n \"status\": \"payment_in_process\",\r\n \"timestamp\": 1724147324\r\n }\r\n ],\r\n \"is_test\": false,\r\n \"brand_id\": \"your-brand-id\",\r\n \"send_receipt\": false,\r\n \"is_recurring_token\": false,\r\n \"skip_capture\": false,\r\n \"reference_generated\": \"PS10907\",\r\n \"issued\": \"2024-08-20\",\r\n \"due\": 1724147324,\r\n \"refund_upto\": 1725871728,\r\n \"cc_descriptor\": \"test1\",\r\n \"fraudScore\": \"NA\",\r\n \"trustScore\": \"NA\",\r\n \"payInDetails\": {\r\n \"expiration_date\": \"2025-03-27 23:59:59\",\r\n \"qrCode\": \"iVBORw0KGgoAAAANSUhEUgAAAb0AAAG9AQAAAACpVZXpAAAH7UlEQVR4nO1cQY7qSgw0yiJLjpCbJBdDIhIXg5vkCCyzQPi7qtwkM2/zNcsYpIfeQFcvTNtdLtsx/9trtS/wC/wCv8A/AZ9mdnpevb9bt6zj+TWso3Uen17i33nGkgverotN/orP7FoHeHV/AG1nfnoZ+kfYrcdKv8ei/gEMvljxRkQZ4MVi5Ww2nm9LbBF/xnLYd7YVVu3dZ262hPUvA3+CUsCnDesJ39/PHhidtlg5cRFek9+WtSgwPO595ldGI4dTAohX/8ZpG2Hp8MdiQPnjEL7XIWJdEae6BfvgC0SxCGCx2Q2fvf5x5GMDGckRov7X2+8r4NhAvW6O82QrHBBeuGBHHjSHK7rDtDxtv8jD0YERv8PPwAHcRjogbv43/BF/wuZwytgHO9r4serxgbIg7vvzPNALY1GHzXDrwYJji2JgTsvOkY8PxGnDDYeVsPHcYjWoUtx6jF04cjPsa8PmjxWAroMWUbtbdPPHPuGZsOqdX8SfOJXGu26zagVgLILHraTWvOUDjRuuU4jq4a2xj8y9hLd6HaArFcMtD997gVoHJYCRwa8H2HzgWVxBDkoBxR5lraVHxIpgdWXEcjJKHrmw+S2Z071F8gLA+JSGCkwEbISoOFnJHiNtvSAhgc0RpyKmw/BeBqgUFUcJGIPWAZnjY1VXis+bUMdw93McHph0kXedfA/pBfMx5CKLlJCJ9n3+FEkOD1QSiuUyrSWaQfyuc0eS3UElm+m8ZYDNqrCbkQMgMMGWEcCQhdEB6a1Jsps/VgCGybASWTtOFu1Lz8SlD/lsgheepBXFupaUFQEiC4MXzozaRjYQrnhRAksioORDbx8doAAQkfwM3qzrP4MVI3lwRqeEOEgTgc37eyVg5zxFZNAuboR0HlkY5VZdbszbELtk6SpAk/DV44yBB2H5zFSWgR3KPAkSKIHZT3nt6EA4INgPmKJRim/1L1MljKI8zS0NbSwElG5qrX6DwsQkDQh5Kr91prI3V4jfqHUBYKfKH9jPQPbDCpchTkmop/xzgiYi9dULASm2863TQeuxGYuDYVUzmtFOm3tuxaDjA+Fi0AehAZFB0zOpfxikD4Uo7YOw9SFIBYAqkN4UyRnY4ZnNFWnfVlpX7WeTEI8PBGWepDvLZCDPopBZOQVVgj+CCNwaaaoBxP8p/zDloN5jZI/sQABGeYe7ctftyBUAPpmmozqBpAyZ/ArxmXmqfJTqIZVWbLGJJBWAtCXqN8rCqIN1rqh9N0qIs84dGzU2raMAkPEbJjMWt85atJg1fZXZhm7CURyqDvCpWpejnUci4QrxmWSSVQwqRGwT47qdEFQBOPCWpxeCPBulsl55KiyIOM96hiLWw+sAndSQB+1KqQxnjEBmIC+xb2NNjFnJp95RASjimEViKtAiTWoEM1bf1YHK2vKOPR4fiJuLyrIZuk0hNOP6Z9McsxJk8gsJEm44sYEqQHaghvF4fQk9ch+9MXR3aOdRJA9KsJVKDw9k1FbDE1WyiOkUghiwSQlQycmyz5mCRyWgZxAyFU2dJJvxm59RsgerlmS/XXMFgOzfYU3H1OFuSlaRnq288JyuyL5dhLJPB0IBIBa9mbCrOYxaqkqlqPwhlcU1B89Ud/wnklcABjdCmi4dEcoyo1Nrt2yVsDGrGGpqrgNUqY8siQblQXMeOcZv6Ijr1LpYdjWd4wM9h2yYcanE02gRxY3WmSHSxBKP1wFK4NFVz0i0jZUwO2Viz3PHA7nrfD4+8MlRLCRl4NITs42WxPdZxKGQdpXSah/aWQDo5IcJVB2ZhBrHi0UcmjY7eH/8HAWAraaTxMfSAU1ah9E9L8pAVD6tBGQnt/h1bMFGg3fLMdjUwvaMNfMOzCJtR+7wQPWucKBmZjjnV61DjJtxXkJpiO1qOhWAOV/TYhKcUpM2F91rxqGJVrHYdXcXAPIA5dDsIPXwnUZWOxRpgrMjEzORW8GrAnDO4tbE8QnORrCfBeeOMvSk3h/LLR6FgNtIIyui1OglaTAhYXNYamicufGdIx8eqFz9ZTkMYWy8dA1vqRp4Ir/2WcLINlBQAPgkIWQQz0c8OFvlkl8zA5lzGAeHz9+FgO6ii+y9QCRSowHdTtH9xOZTjWBn6asKUK2VvtBaUuFH+R62oAZkObLfKzM71wHCqhyVaFPpIs/emndV+mLfBmtivv85Dg9kAwajE+K3kg8lpq3YA0dlY48GAM+FgDklq7wDoVtUaVT/e/YdJDdiUcPrAHmeFJhemkBKMunZ/y6nZDeYGMKmzB8eCBshHW1T6VhuqdabzmI+P2Tpm1OWAWoei88uSBV+o9G7eimfN4O0f9e/enyg9PgL5Xk9tqDP9OKmKilbCNU0dxL6Wgr4aOlo/yGOagQ7yeZqwYRnXndlxArAnNHfRvbzXlML5ktJmWdij2rgsxAQVlVJMF2xaUCcGuUH6n9SpX3f9XR8IF7qQIiTlUWcznXf5/CRZfflqIGuaxkgDEVqaOyX4+VmnNvic2SyTCi5VRWfdgVUAF5dUVtj6KrpwL545dMX7TNg/LMaeHygnr7YxNM2JcEvVOLJrISKolk9oPpxW7ep+JJodLJqnkpN9Vs1IFxsarqzpLKHsrUXGaW1+vrFfj3w8+BA+iOHA1omrxbCJ9F67IP2oUK04+QFgC2Sq8U7x5CGTyVsaL3LLjIp9ywC/NPrC/wCv8Av8C/A/wCpreUSrYyOqQAAAABJRU5ErkJggg==\"\r\n },\r\n \"refund_availability\": \"NONE\",\r\n \"refundable_amount\": 10.0,\r\n \"success_redirect\": \"https://your.success.redirect.com\",\r\n \"failure_redirect\": \"https://your.failure.redirect.com\",\r\n \"cancel_redirect\": \"\",\r\n \"success_callback\": \"https://your.success.callback.com\",\r\n \"failure_callback\": \"https://your.failure.callback.com\",\r\n \"platform\": \"API\",\r\n \"created_from_ip\": \"203.0.113.192\",\r\n \"checkout_url\": \"https://api.paysecure.net/payments/66c4667bb993c970367c288a/\",\r\n \"payoutProcess\": false\r\n}"},{"id":"f80ea9cb-c599-49f3-bfc1-0614b4781063","name":"Failure","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer {{APIKey}}","type":"text"}],"url":"https://api.paysecure.net/api/v1/purchases/{purchaseId}/"},"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":"{\r\n \"message\": \"Error Message\",\r\n \"code\": \"error_code\"\r\n}"}],"_postman_id":"4c6bec94-c878-4b3d-be81-82c35c7c5944"}],"id":"692d92d3-a2fd-42ee-be95-e0971624f41c","description":"

API Flow

\n\n

The merchant initiates the purchase via the create purchase API. If successful, they receive a checkout URL in the response JSON. Sometimes they can also get an object of PayIn Details which they can use to make the payment.
\n
The merchant then has 2 options
\n
1. Upon utilizing the checkout URL, depending on the payment method passed, the user will be presented with several payment choices from which to choose in order to complete the payment:
  \n
  1. QR Code
    \n
  2. PhonePe, Googlepay or Paytm intent flow
    \n
  \n
2. Retrieve the PayIn details in the response JSON (as shown below).
  \n
\n
After a successful or failed payment by the end user, an appropriate webhook would be sent to the merchant. If option 2a was the method employed, the user would be redirected to the appropriate redirect URL.
\n

Available Payment Methods: UPI-QR and UPI-INTENT

To Initiate a payment, the very first API call to make is /payout/ with the required data in the request body.

To generate a Payout, you are required to provide the API key (in the header) can be located in the Dashboard section of your merchant account login.

The request body structure is shown on the request body of the example request shown here.

The following (see table below) are the mandatory parameters that are required to create a Payout 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.phone	The customer's phone number along with the country code. Example: +91 9634088651
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.
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.
amount	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	example: PAYOUT-BANKTRANSFER
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.
Purpose	The purpose of doing a payout.

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

Parameter	Notes
beneficiaryDetail.bankName	The Bank Name in which the customer want's to credit the money. Optional Field. If passed, only use the mentioned bank names below. Anything else might lead to payout failures. If you don't want to pass, then you might need to open our checkout_url in the response and user can select the Bank from the dropdown.
beneficiaryDetail.bankAccountName	Mandatory Field. Account Holder's Full Name. It is advised to have atleast 2 words in the name.
beneficiaryDetail.bankAccountCurrency	Optional Field. The Currency in which the money will be credited. Generally the same as the `currency` field mentioned above.
beneficiaryDetail.bankAccountNumber	Mandatory Field. Account Holder's Account Number. This is the account in which the money will be credited.
beneficiaryDetail.ifscCode	Mandatory Field. IFSC code of the account in which the money will be credited.
beneficiaryDetail.bankCountryCode	Optional Field. The country code in which the account exist. Generally the same as the `country` field mentioned above.

Bank Names:

","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"d23b2b5b-4b22-4a1c-8d1e-e93801f3506b","id":"d23b2b5b-4b22-4a1c-8d1e-e93801f3506b","name":"Payout","type":"folder"}},"urlObject":{"path":["payout",""],"host":["https://api.paysecure.net/api/v1"],"query":[],"variable":[]}},"response":[{"id":"e469b468-6baf-4cea-a14e-3366956e9558","name":"Success","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer {{APIKey}}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"client\": {\r\n \"email\": \"user9320@example.com\",\r\n \"phone\": \"+91 9634088651\",\r\n \"country\": \"IN\",\r\n \"zip_code\": \"302018\",\r\n \"city\": \"Riverton\",\r\n \"street_address\": \"58 Testing Lane\",\r\n \"full_name\": \"Reese Moreau\",\r\n \"stateCode\": \"RJ\"\r\n },\r\n \"beneficiaryDetail\": {\r\n \"bankAccountName\": \"Reese Moreau\",\r\n \"bankAccountNumber\": \"123456789012\",\r\n \"ifscCode\": \"HDFC021212\"\r\n },\r\n \"payoutMethod\": \"PAYOUT-BANKTRANSFER\",\r\n \"brand_id\": \"your-brand-id\",\r\n \"amount\": 100,\r\n \"currency\": \"INR\",\r\n \"purpose\": \"payout for testing\",\r\n \"success_redirect\": \"https://your.success.redirect.com\",\r\n \"pending_redirect\": \"https://your.pending.redirect.com\",\r\n \"failure_redirect\": \"https://your.failure.redirect.com\",\r\n \"success_callback\": \"https://your.success.callback.com\",\r\n \"failure_callback\": \"https://your.failure.callback.com\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.paysecure.net/api/v1/payout/"},"status":"Accepted","code":202,"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":"{\r\n \"payoutId\": \"6977137755e0628e3600c562\",\r\n \"client\": {\r\n \"customerId\": \"NA\",\r\n \"email\": \"user9320@example.com\",\r\n \"phone\": \"+91 9634088651\",\r\n \"country\": \"IN\",\r\n \"zip_code\": \"302018\",\r\n \"city\": \"Riverton\",\r\n \"street_address\": \"58 Testing Lane\",\r\n \"full_name\": \"Reese Moreau\",\r\n \"stateCode\": \"RJ\"\r\n },\r\n \"updated_on\": 1769411447,\r\n \"payoutMethod\": \"PAYOUT-BANKTRANSFER\",\r\n \"beneficiaryDetail\": {\r\n \"bankAccountName\": \"Reese Moreau\",\r\n \"bankAccountNumber\": \"123456789012\",\r\n \"ifscCode\": \"HDFC021212\"\r\n },\r\n \"amountUnit\": \"MAJOR\",\r\n \"amount\": 100.0,\r\n \"errorMsg\": \"\",\r\n \"purpose\": \"payout for testing\",\r\n \"created_on\": 1769411447,\r\n \"merchantRef\": \"6977137755e0628e3600c562\",\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\": \"paid\",\r\n \"timestamp\": 1769411447\r\n },\r\n\r\n ],\r\n \"currency\": \"INR\",\r\n \"extraFee\": \"0\",\r\n \"paymentOn\": 0,\r\n \"checkout_url\": \"https://api.paysecure.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\": \"https://your.success.callback.com\",\r\n \"failure_callback\": \"https://your.failure.callback.com\"\r\n}"},{"id":"7fa260c0-6966-48c8-8cf2-34c1cdbefa41","name":"Error","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer {{APIKey}}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"client\": {\r\n \"email\": \"user9320@example.com\",\r\n \"phone\": \"+91 9634088651\",\r\n \"country\": \"IN\",\r\n \"zip_code\": \"302018\",\r\n \"city\": \"Riverton\",\r\n \"street_address\": \"58 Testing Lane\",\r\n \"full_name\": \"Reese Moreau\",\r\n \"stateCode\": \"RJ\"\r\n },\r\n \"beneficiaryDetail\": {\r\n \"bankAccountName\": \"Reese Moreau\",\r\n \"bankAccountNumber\": \"123456789012\",\r\n \"ifscCode\": \"HDFC021212\"\r\n },\r\n \"payoutMethod\": \"PAYOUT-BANKTRANSFER\",\r\n \"brand_id\": \"your-brand-id\",\r\n \"amount\": 100,\r\n \"currency\": \"INR\",\r\n \"purpose\": \"payout for testing\",\r\n \"success_redirect\": \"https://your.success.redirect.com\",\r\n \"pending_redirect\": \"https://your.pending.redirect.com\",\r\n \"failure_redirect\": \"https://your.failure.redirect.com\",\r\n \"success_callback\": \"https://your.success.callback.com\",\r\n \"failure_callback\": \"https://your.failure.callback.com\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.paysecure.net/api/v1/payout/"},"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":"{\r\n \"payoutId\": \"6977137755e0628e3600c562\",\r\n \"client\": {\r\n \"customerId\": \"NA\",\r\n \"email\": \"user9320@example.com\",\r\n \"phone\": \"+91 9634088651\",\r\n \"country\": \"IN\",\r\n \"zip_code\": \"302018\",\r\n \"city\": \"Riverton\",\r\n \"street_address\": \"58 Testing Lane\",\r\n \"full_name\": \"Reese Moreau\",\r\n \"stateCode\": \"RJ\"\r\n },\r\n \"updated_on\": 1769411447,\r\n \"payoutMethod\": \"PAYOUT-BANKTRANSFER\",\r\n \"beneficiaryDetail\": {\r\n \"bankAccountName\": \"Reese Moreau\",\r\n \"bankAccountNumber\": \"123456789012\",\r\n \"ifscCode\": \"HDFC021212\"\r\n },\r\n \"amountUnit\": \"MAJOR\",\r\n \"amount\": 100.0,\r\n \"errorMsg\": \"This customer can not be processed !\",\r\n \"purpose\": \"payout for testing\",\r\n \"created_on\": 1769411447,\r\n \"merchantRef\": \"6977137755e0628e3600c562\",\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 \"currency\": \"INR\",\r\n \"extraFee\": \"0\",\r\n \"paymentOn\": 0,\r\n \"checkout_url\": \"https://api.paysecure.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\": \"https://your.success.callback.com\",\r\n \"failure_callback\": \"https://your.failure.callback.com\"\r\n}"}],"_postman_id":"3eb5d872-a189-48e5-a778-5198bfbbaa85"},{"name":"Get Status","id":"c7a17546-458b-49b5-865e-1c43721b82f9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[],"url":"https://api.paysecure.net/api/v1/getpayout/{payoutId}/","description":"

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

Mandatory

you need to pass the payoutId 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
payout_in_process	payout is under Processing.
error	Transaction has Failed.

","urlObject":{"path":["getpayout","{payoutId}",""],"host":["https://api.paysecure.net/api/v1"],"query":[],"variable":[]}},"response":[{"id":"4efaf686-7d36-49c0-a7b0-17b2ce869a16","name":"Success","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer {{APIKey}}","type":"text"}],"url":"https://api.paysecure.net/api/v1/getpayout/{payoutId}/"},"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":"{\r\n \"payoutId\": \"6977137755e0628e3600c562\",\r\n \"client\": {\r\n \"customerId\": \"NA\",\r\n \"email\": \"user9320@example.com\",\r\n \"phone\": \"+91 9634088651\",\r\n \"country\": \"IN\",\r\n \"zip_code\": \"302018\",\r\n \"city\": \"Riverton\",\r\n \"street_address\": \"58 Testing Lane\",\r\n \"full_name\": \"Reese Moreau\",\r\n \"stateCode\": \"RJ\"\r\n },\r\n \"updated_on\": 1769411447,\r\n \"payoutMethod\": \"PAYOUT-BANKTRANSFER\",\r\n \"beneficiaryDetail\": {\r\n \"bankAccountName\": \"Reese Moreau\",\r\n \"bankAccountNumber\": \"123456789012\",\r\n \"ifscCode\": \"HDFC021212\"\r\n },\r\n \"amountUnit\": \"MAJOR\",\r\n \"amount\": 100.0,\r\n \"errorMsg\": \"\",\r\n \"purpose\": \"payout for testing\",\r\n \"created_on\": 1769411447,\r\n \"merchantRef\": \"6977137755e0628e3600c562\",\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\": \"paid\",\r\n \"timestamp\": 1769411447\r\n },\r\n\r\n ],\r\n \"currency\": \"INR\",\r\n \"extraFee\": \"0\",\r\n \"paymentOn\": 0,\r\n \"checkout_url\": \"https://api.paysecure.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\": \"https://your.success.callback.com\",\r\n \"failure_callback\": \"https://your.failure.callback.com\"\r\n}"},{"id":"1646acec-d972-470d-9d3c-93704b7f00d2","name":"Error","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer {{APIKey}}","type":"text"}],"url":"https://api.paysecure.net/api/v1/getpayout/{payoutId}/"},"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":"{\r\n \"payoutId\": \"6977137755e0628e3600c562\",\r\n \"client\": {\r\n \"customerId\": \"NA\",\r\n \"email\": \"user9320@example.com\",\r\n \"phone\": \"+91 9634088651\",\r\n \"country\": \"IN\",\r\n \"zip_code\": \"302018\",\r\n \"city\": \"Riverton\",\r\n \"street_address\": \"58 Testing Lane\",\r\n \"full_name\": \"Reese Moreau\",\r\n \"stateCode\": \"RJ\"\r\n },\r\n \"updated_on\": 1769411447,\r\n \"payoutMethod\": \"PAYOUT-BANKTRANSFER\",\r\n \"beneficiaryDetail\": {\r\n \"bankAccountName\": \"Reese Moreau\",\r\n \"bankAccountNumber\": \"123456789012\",\r\n \"ifscCode\": \"HDFC021212\"\r\n },\r\n \"amountUnit\": \"MAJOR\",\r\n \"amount\": 100.0,\r\n \"errorMsg\": \"This customer can not be processed !\",\r\n \"purpose\": \"payout for testing\",\r\n \"created_on\": 1769411447,\r\n \"merchantRef\": \"6977137755e0628e3600c562\",\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 \"currency\": \"INR\",\r\n \"extraFee\": \"0\",\r\n \"paymentOn\": 0,\r\n \"checkout_url\": \"https://api.paysecure.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\": \"https://your.success.callback.com\",\r\n \"failure_callback\": \"https://your.failure.callback.com\"\r\n}"}],"_postman_id":"c7a17546-458b-49b5-865e-1c43721b82f9"}],"id":"d23b2b5b-4b22-4a1c-8d1e-e93801f3506b","description":"

API Flow

\n\n

The merchant initiates the payout via the create payout API. If successful, they will receive a paid status in the response. If any additional fields are required from the user, the status would be in pending and the user needs to be redirected to the checkout_url.
\n
After a successful or failed payment by the end user, an appropriate webhook would be sent to the merchant. If the user would be redirected to the checkout_url for some additional details, once the user clicks on Pay, the user will be redirected to the appropriate redirect URL.
\n

Available payout methods: PAYOUT-BANKTRANSFER

CLABE (Clave Bancaria Estandarizada): A 18-digit standardized bank account identifier used to route funds correctly.
\n
Expiration Window: SPEI instructions typically expire within a 3 days; merchants must display clear expiry times to reduce failed payments.
\n
Webhook-Driven Confirmation: Once funds arrive, the SPEI network triggers a webhook to notify your system—no polling required.
\n

Customer Journey

Select SPEI at Checkout:
\n
- User adds items to cart, proceeds to checkout, and clicks “Pay with SPEI.”
  \n
- Merchant’s site sends a Payin API request to generate SPEI instructions.
  \n
\n
Display Payment Instructions:
\n
- Merchant shows a summary screen with:
  \n
  - Beneficiary CLABE (One-time CLABE)
    \n
  - Beneficiary Name
    \n
  - Amount (MXN)
    \n
  - Expiration Time (e.g., “Expires in 2 hours”)
    \n
  \n
\n
Customer Initiates Transfer:
\n
- Customer logs into their bank’s web/mobile app.
  \n
- They select “Transfer via SPEI,” enter the provided CLABE, amount, and reference.
  \n
- Customer confirms transfer (two-factor auth, OTP, or biometric—bank-dependent).
  \n
\n
Funds Sent & Confirmation:
\n
- Once Banco de México settles the transfer (typically <15 minutes), PaySecure’s SPEI webhook fires.
  \n
- Merchant backend receives webhook payload with transaction status = “paid” (or “error,” “cancelled,” as applicable).
  \n
\n
Merchant Acknowledges Payment:
\n
- Backend updates order status to “Paid”
  \n
- Frontend redirects customer to success page or sends confirmation email/SMS.
  \n
\n
Edge Cases & Failure Handling:
\n
- If customer never initiates transfer before expiration, status = “expired.”
  \n
- If customer sends incorrect CLABE/amount, merchant receives webhook with error codes—trigger “error” flow.
  \n
\n

1. Request Payload Structure

Supply a JSON payload with these top‐level objects:

client (customer details)
\n
purchase (order details)
\n
paymentMethod (string, must be \"SPEI\")
\n
extraParam (optional, leave {} if unused)
\n
status (set to \"created\")
\n
brand_id (your merchant/brand UUID)
\n
Redirect & callback URLs
\n

2. Displaying SPEI Instructions to End User

Once you parse payInDetails from the response:

Show CLABE, Beneficiary & Amount
\n
Display Expiration
\n
Show Redirect Path (Optional)
\n
- If you’re using the hosted checkout_url, simply redirect customers to it and let Paysecure handle the UI.
\n

3. Webhook Handling & Status Transitions

Configure Webhooks
\n
- In Paysecure’s Dashboard, set your success_callback and failure_callback URLs (one for each event type).
\n
Listen for These Events:
\n
- payment.paid – Banco de México has settled the transfer.
  \n
- payment.error – CLABE/amount mismatch or network error.
  \n
- payment.expired – Customer did not pay before expireInMin.
  \n
\n
Update Order Status:
\n
- On payment.paid: mark as paid, trigger fulfillment, send confirmation.
  \n
- On payment.error: alert customer, allow retry or alternative payment.
  \n
- On payment.expired: cancel order.
  \n
\n

\n","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"02da3a93-6fe0-4a6f-be48-c9c684af4434","id":"02da3a93-6fe0-4a6f-be48-c9c684af4434","name":"Payin API","type":"folder"}},"urlObject":{"path":["purchases"],"host":["https://api.paysecure.net/api/v1"],"query":[],"variable":[]}},"response":[{"id":"f7905b3b-3a4e-4198-b614-0fde12d22eb1","name":"Success","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer {{APIKey}}"}],"body":{"mode":"raw","raw":"{\n \"client\": {\n \"email\": \"user5890@example.com\",\n \"country\": \"MX\",\n \"city\": \"123\",\n \"stateCode\": \"ca\",\n \"full_name\": \"Test test\",\n \"street_address\": \"test test\",\n \"zip_code\": \"234567\",\n \"phone\": \"9999999999\"\n },\n \"purchase\": {\n \"currency\": \"MXN\",\n \"products\": [\n {\n \"name\": \"dk\",\n \"price\": \"100\"\n }\n ]\n },\n \"paymentMethod\": \"SPEI\",\n \"brand_id\": \"your-brand-id\",\n \"success_redirect\": \"https://your.success.redirect.com\",\n \"pending_redirect\": \"https://your.pending.redirect.com\",\n \"failure_redirect\": \"https://your.failure.redirect.com\",\n \"success_callback\": \"https://your.success.callback.com\",\n \"failure_callback\": \"https://your.failure.callback.com\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.paysecure.net/api/v1/purchases"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"purchaseId\": \"683d768a22ae19559d740836\",\n \"client\": {\n \"customerId\": \"NA\",\n \"email\": \"user5890@example.com\",\n \"phone\": \"9999999999\",\n \"full_name\": \"Test test\",\n \"date_of_birth\": \"1970-07-10\",\n \"street_address\": \"test test\",\n \"country\": \"MX\",\n \"city\": \"123\",\n \"zip_code\": \"234567\",\n \"cc\": [],\n \"bcc\": [],\n \"stateCode\": \"ca\"\n },\n \"updated_on\": 1748858506,\n \"type\": \"purchase\",\n \"paymentMethod\": \"SPEI\",\n \"amountUnit\": \"MAJOR\",\n \"errorMsg\": \"\",\n \"redirectType\": \"GET\",\n \"force_recurring\": false,\n \"created_on\": 1748858506,\n \"extraParam\": {},\n \"merchantRef\": \"683d768a22ae19559d740836\",\n \"merchantName\": \"Skyler Nakamurasinghal\",\n \"purchase\": {\n \"currency\": \"MXN\",\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 \"expireInMin\": \"4320\",\n \"taxAmount\": 0,\n \"taxPercent\": 0,\n \"request_client_details\": [],\n \"email_message\": \"\"\n },\n \"payment\": {\n \"is_outgoing\": false,\n \"payment_type\": \"PURCHASE\",\n \"amount\": 100,\n \"currency\": \"MXN\",\n \"net_amount\": 100,\n \"fee_amount\": 0,\n \"pending_amount\": 0,\n \"pending_unfreeze_on\": null,\n \"description\": \"\",\n \"paid_on\": 1748858506,\n \"remote_paid_on\": 1748858506\n },\n \"issuer_details\": {\n \"website\": \"\",\n \"legal_street_address\": \"\",\n \"legal_country\": \"\",\n \"legal_city\": \"\",\n \"legal_zip_code\": \"\",\n \"bank_accounts\": [\n {}\n ],\n \"legal_name\": \"test6\",\n \"brand_name\": \"test6\",\n \"registration_number\": \"\",\n \"tax_number\": \"\"\n },\n \"transaction_data\": {\n \"payment_method\": \"\",\n \"flow\": \"payform\",\n \"extra\": {\n \"amount\": 100,\n \"masked_pan\": \"SPEI\"\n },\n \"country\": \"\",\n \"attempts\": [\n {\n \"client_ip\": \"203.0.113.205, 203.0.113.140, 203.0.113.61\",\n \"type\": \"execute\",\n \"payment_method\": \"SPEI\",\n \"flow\": \"payform\",\n \"successful\": true,\n \"country\": \"SPEI\",\n \"processing_time\": 1748858506,\n \"extra\": {\n \"amount\": 100,\n \"masked_pan\": \"SPEI\"\n }\n }\n ]\n },\n \"status\": \"PAYMENT_IN_PROCESS\",\n \"status_history\": [\n {\n \"status\": \"created\",\n \"timestamp\": 1748858506\n },\n {\n \"status\": \"pending_execute\",\n \"timestamp\": 1748858506\n },\n {\n \"status\": \"payment_in_process\",\n \"timestamp\": 1748858506\n }\n ],\n \"is_test\": false,\n \"brand_id\": \"your-brand-id\",\n \"is_recurring_token\": false,\n \"reference_generated\": \"PS786\",\n \"issued\": \"2025-06-02\",\n \"due\": 1748858506,\n \"refund_upto\": 1749891706,\n \"cc_descriptor\": \"\",\n \"fraudScore\": \"0\",\n \"trustScore\": \"2\",\n \"payInDetails\": {\n \"clabe\": \"710969000049618169\",\n \"beneficiary\": \"SAMPLEPAY LTD.\",\n \"amount\": \"100.00\"\n },\n \"paidOn\": 0,\n \"refund_availability\": \"NONE\",\n \"refundable_amount\": 100,\n \"success_redirect\": \"https://your.success.redirect.com\",\n \"failure_redirect\": \"https://your.failure.redirect.com\",\n \"cancel_redirect\": \"\",\n \"success_callback\": \"https://your.success.callback.com\",\n \"failure_callback\": \"https://your.failure.callback.com\",\n \"platform\": \"API\",\n \"created_from_ip\": \"203.0.113.205, 203.0.113.140, 203.0.113.61\",\n \"checkout_url\": \"https://api.paysecure.net/payments/683d768a22ae19559d740836/\",\n \"payoutProcess\": false\n}"}],"_postman_id":"fdea1c13-df61-4424-8b74-01d7dc9ec706"}],"id":"02da3a93-6fe0-4a6f-be48-c9c684af4434","auth":{"type":"noauth","isInherited":false},"event":[{"listen":"prerequest","script":{"type":"text/javascript","packages":{},"requests":{},"exec":[""],"id":"7150842f-032d-4267-bf20-d9496a75e483"}},{"listen":"test","script":{"type":"text/javascript","packages":{},"requests":{},"exec":[""],"id":"80d4b210-1d15-41ab-86d1-d3965bbb892d"}}],"_postman_id":"02da3a93-6fe0-4a6f-be48-c9c684af4434","description":""},{"name":"Payout API","item":[{"name":"Payout API","id":"686b236e-6de9-41cc-bb32-d544730cdb78","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer {{APIKey}}"}],"body":{"mode":"raw","raw":"{\n \"client\": {\n \"email\": \"user5890@example.com\",\n \"country\": \"MX\",\n \"phone\": \"+14377717874\",\n \"full_name\": \"Sam Novak\",\n \"stateCode\": \"test\",\n \"spei_clabe\": \"012180027944986158\"\n },\n \"purpose\": \"payout\",\n \"currency\": \"MXN\",\n \"payoutMethod\": \"PAYOUT-SPEI\",\n \"brand_id\": \"your-brand-id\",\n \"amount\": 20,\n \"success_redirect\": \"https://your.success.redirect.com\",\n \"pending_redirect\": \"https://your.pending.redirect.com\",\n \"failure_redirect\": \"https://your.failure.redirect.com\",\n \"success_callback\": \"https://your.success.callback.com\",\n \"failure_callback\": \"https://your.failure.callback.com\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.paysecure.net/api/v1/payout/","description":"

Payout API Integration (SPEI)

1. Request Payload Structure

Submit a JSON payload containing:

client (beneficiary details)
\n
purpose (should be \"payout\")
\n
currency (always \"MXN\")
\n
payoutMethod (must be \"PAYOUT-SPEI\")
\n
amount (numeric, in major units)
\n
Redirect & callback URLs
\n

jsonCopy{\n  \"client\": {\n    \"email\": \"user5890@example.com\",\n    \"country\": \"MX\",\n    \"phone\": \"+14377717874\",\n    \"full_name\": \"Sam Novak\",\n    \"stateCode\": \"test\",\n    \"spei_clabe\": \"012180027944986158\"\n  },\n  \"purpose\": \"payout\",\n  \"currency\": \"MXN\",\n  \"payoutMethod\": \"PAYOUT-SPEI\",\n  \"amount\": 20,\n  \"success_redirect\": \"https://your.success.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}\n\n

client.email, client.phone, client.full_name, client.country, client.stateCode: Required beneficiary/contact info.
\n
client.spei_clabe: 18-digit CLABE of beneficiary’s bank account (validate format client-side to avoid runtime failures).
\n
purpose: Always set to \"payout\".
\n
currency: Must be \"MXN\".
\n
payoutMethod: Must be \"PAYOUT-SPEI\".
\n
amount: Numeric amount (e.g., 20 for MXN 20.00).
\n
success_redirect / failure_redirect: URLs for end-user redirect after they click “Return to Merchant” (GET).
\n
success_callback / failure_callback: Webhook endpoints for asynchronous payout status notifications.
\n

2. Sample Response & Key Fields

jsonCopy{\n  \"payoutId\": \"683d778dc74d23074a56ea94\",\n  \"client\": {\n    \"customerId\": \"NA\",\n    \"email\": \"user5890@example.com\",\n    \"phone\": \"+14377717874\",\n    \"full_name\": \"Sam Novak\",\n    \"country\": \"MX\",\n    \"spei_clabe\": \"012180027944986155\",\n    \"stateCode\": \"test\"\n  },\n  \"updated_on\": 1748858765,\n  \"payoutMethod\": \"PAYOUT-SPEI\",\n  \"amountUnit\": \"MAJOR\",\n  \"amount\": 20.0,\n  \"errorMsg\": \"This customer can not be processed !\",\n  \"purpose\": \"test payout\",\n  \"created_on\": 1748858765,\n  \"merchantRef\": \"683d778dc74d23074a56ea94\",\n  \"status\": \"ERROR\",\n  \"status_history\": [\n    {\n      \"status\": \"created\",\n      \"timestamp\": 1748858765\n    },\n    {\n      \"status\": \"error\",\n      \"timestamp\": 1748858765\n    }\n  ],\n  \"currency\": \"MXN\",\n  \"paymentOn\": 0,\n  \"taxAmount\": 0.0,\n  \"taxPercent\": 0.0,\n  \"success_redirect\": \"https://your.success.redirect.com\",\n  \"failure_redirect\": \"https://your.failure.redirect.com\",\n  \"redirectType\": \"GET\",\n  \"success_callback\": \"https://your.success.callback.com\",\n  \"failure_callback\": \"https://your.failure.callback.com\"\n}\n\n

payoutId (string): Unique PaySecure identifier for this payout request.
\n
client.customerId: \"NA\" for a new beneficiary or your internal customer ID if returning.
\n
client.spei_clabe: Echoed beneficiary CLABE (note: if the CLABE in response differs by a digit, double-check formatting/validation).
\n
updated_on / created_on: Unix timestamps (seconds since epoch).
\n
payoutMethod: \"PAYOUT-SPEI\".
\n
amountUnit: \"MAJOR\" indicates amount is in MXN major units (no subunit conversion required).
\n
amount: 20.0 (MXN 20.00).
\n
errorMsg: Describes any immediate rejection reason. If non-empty, status will be \"ERROR\".
\n
purpose: Echo of the \"payout\" field or any custom string you passed.
\n
merchantRef: Mirror of payoutId by default; can be overwritten if you pass a custom reference.
\n
status: One of:
\n
- \"created\" → request accepted, preparing SPEI transfer
  \n
- \"processing\" → SPEI transfer initiated, awaiting Banco de México settlement
  \n
- \"success\" → funds successfully delivered
  \n
- \"error\" → immediate failure (e.g., invalid CLABE, validation issue)
  \n
\n
status_history: Array showing timestamped states from \"created\" → \"processing\" → (\"success\" or \"error\").
\n
paymentOn: Unix timestamp when the transfer actually occurred (0 if not delivered).
\n
redirectType: Always \"GET\", meaning customer is redirected via HTTP GET to your provided URL.
\n
success_redirect / failure_redirect / success_callback / failure_callback: Echo of whatever you passed in request.
\n

Note: If you see \"status\": \"ERROR\" and an errorMsg, do not retry automatically—inspect the message, correct client data, then reinitiate a new payout request.

3. Handling Payout Webhooks & Status Flow

Configure Webhooks
\n
- In your PaySecure Dashboard, register your success_callback and failure_callback URLs (these will receive POSTs once SPEI settles or fails).
\n
Listen for Events
\n
- payout.success: Banco de México confirmed the credit to beneficiary’s CLABE.
  \n
- payout.error: CLABE invalid, account closed, or transfer rejected.
  \n
\n
Update Your Records
\n
- On payout.success: Mark disbursement as complete; notify your finance/operations teams.
  \n
- On payout.error: Log failure details, alert operations for manual review, and optionally retry after fixing the root cause.
  \n
\n

\n","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"99e082c5-31f1-4c7e-b175-d11115bab689","id":"99e082c5-31f1-4c7e-b175-d11115bab689","name":"Payout API","type":"folder"}},"urlObject":{"path":["payout",""],"host":["https://api.paysecure.net/api/v1"],"query":[],"variable":[]}},"response":[{"id":"15684b7b-c173-427d-8c16-c5fff29941c1","name":"Success","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer {{APIKey}}"}],"body":{"mode":"raw","raw":"{\n \"client\": {\n \"email\": \"user5890@example.com\",\n \"country\": \"MX\",\n \"phone\": \"+14377717874\",\n \"full_name\": \"Sam Novak\",\n \"stateCode\": \"test\",\n \"spei_clabe\": \"012180027944986158\"\n },\n \"purpose\": \"payout\",\n \"currency\": \"MXN\",\n \"payoutMethod\": \"PAYOUT-SPEI\",\n \"brand_id\": \"your-brand-id\",\n \"amount\": 20,\n \"success_redirect\": \"https://your.success.redirect.com\",\n \"pending_redirect\": \"https://your.pending.redirect.com\",\n \"failure_redirect\": \"https://your.failure.redirect.com\",\n \"success_callback\": \"https://your.success.callback.com\",\n \"failure_callback\": \"https://your.failure.callback.com\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.paysecure.net/api/v1/payout/"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"payoutId\": \"683d778dc74d23074a56ea94\",\n \"client\": {\n \"customerId\": \"NA\",\n \"email\": \"user5890@example.com\",\n \"phone\": \"+14377717874\",\n \"full_name\": \"Sam Novak\",\n \"country\": \"MX\",\n \"spei_clabe\": \"012180027944986155\",\n \"stateCode\": \"test\"\n },\n \"updated_on\": 1748858765,\n \"payoutMethod\": \"PAYOUT-SPEI\",\n \"amountUnit\": \"MAJOR\",\n \"amount\": 20,\n \"errorMsg\": \"\",\n \"purpose\": \"test payout\",\n \"created_on\": 1748858765,\n \"merchantRef\": \"683d778dc74d23074a56ea94\",\n \"status\": \"paid\",\n \"status_history\": [\n {\n \"status\": \"created\",\n \"timestamp\": 1748858765\n },\n {\n \"status\": \"paid\",\n \"timestamp\": 1748858765\n }\n ],\n \"currency\": \"MXN\",\n \"paymentOn\": 0,\n \"taxAmount\": 0,\n \"taxPercent\": 0,\n \"success_redirect\": \"https://your.success.redirect.com\",\n \"failure_redirect\": \"https://your.failure.redirect.com\",\n \"redirectType\": \"GET\",\n \"success_callback\": \"https://your.success.callback.com\",\n \"failure_callback\": \"https://your.failure.callback.com\"\n}"}],"_postman_id":"686b236e-6de9-41cc-bb32-d544730cdb78"}],"id":"99e082c5-31f1-4c7e-b175-d11115bab689","auth":{"type":"noauth","isInherited":false},"event":[{"listen":"prerequest","script":{"type":"text/javascript","packages":{},"requests":{},"exec":[""],"id":"2eb3cbc3-3744-477b-b76d-e909ef526d41"}},{"listen":"test","script":{"type":"text/javascript","packages":{},"requests":{},"exec":[""],"id":"701a169b-d2c4-412d-a9fe-3ae45aab7705"}}],"_postman_id":"99e082c5-31f1-4c7e-b175-d11115bab689","description":""}],"id":"2a11c664-e3d2-41fe-b424-8a9ec80b622c","description":"

Overview

SPEI (Sistema de Pagos Electrónicos Interbancarios) is Mexico’s real-time interbank transfer network operated by Banco de México. By integrating SPEI as a payment option, merchants can offer a frictionless, low-cost alternative to cards—funds settle in minutes, not days. SPEI is ubiquitous in Mexico (think coffee-to-cash within seconds), and this integration lets you tap into that network without reinventing the wheel.

Key benefits:

Instant Settlement: Funds move from payer’s bank to merchant’s account in near real-time.
\n
Broad Adoption: Over 90% of Mexican bank accounts are SPEI-enabled.
\n
Low Fees: Typically lower transaction fees compared to card rails.
\n
Regulatory Compliance: Leverages Banco de México’s secure infrastructure and industry-standard validations.
\n

Mobile Money Overview

Mobile Money is a digital payment service that allows users to send, receive, and manage money via their mobile devices. It facilitates secure and instant transactions directly between mobile wallets in the country, offering a convenient alternative to traditional banking methods in Africa.

This payment method enables merchants to accept payments via Mobile Money from number of countries in Africa, and also to do payouts as well (to cutomer's local mobile wallet)

Payins

How It Works

The payin process harnesses mobile money capabilities to support effortless collections. Merchants can initiate payment requests via USSD, offering a secure, efficient, and flexible method to collect customer payments.

\n
💡 Note that the refunds are not possible over Mobile Money. Merchants have to initiate a PayOut request manually to process any refunds.
\n

Key Steps

Initiate Transfer Request:
The merchant sends a transaction request to the Mobile Money PayIn API. This request includes the customer’s mobile number, the collection amount, and an optional message.
\n
Send Notification:
The customer receives a USSD pop-up with payment instructions on their mobile device.
\n
Customer Completes Transfer:
The customer follows the USSD instructions, enters their security PIN if required, and authorizes the transfer of funds to the merchant’s account.
\n
Confirm Transfer Completion:
Once the payment is successful, the merchant receives a confirmation via a webhook indicating a successful transaction.
\n
Update Merchant’s Account:
The merchant’s system updates the customer’s account balance to reflect the received funds.
\n

\n\n

Payouts

The payout API offers seamless payouts to customers over mobile money. Whether processing refunds, rewards, or other disbursements, our APIs delivers efficient, reliable transactions with real-time fund transfers and detailed transaction tracking.

Key Steps:

Initiate Payout Request:
When a customer requests a withdrawal, the merchant site calls the Paysecure Payouts API to start the mobile money payout. This request includes the customer’s mobile number, the transfer amount, and the currency.
\n
Send Notification:
Customers receive an immediate USSD notification confirming the successful payout, while merchants are notified via an instant webhook.
\n
Update Merchant’s Account:
The merchant’s account balance is promptly updated to reflect the transaction.
\n

Fully Supported Countries: Pay-ins & Pay-outs

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

Country	Region	Telco	Settlement Type
Cameroon	FSSA	MTN	Crossborder – USD, EUR
Cameroon*	FSSA	Orange	Crossborder – USD, EUR
DRC	SEA	Airtel	Crossborder – USD, EUR
DRC	SEA	Orange	Crossborder – USD, EUR
DRC	SEA	Vodacom	Crossborder – USD, EUR
Uganda	SEA	Airtel	Crossborder – USD, EUR
Uganda	SEA	MTN**	Crossborder – USD, EUR
Zambia	SEA	Airtel_*\\_	Crossborder – USD, EUR
Zambia	SEA	MTN	Crossborder – USD, EUR

Footnotes:

For Cameroon, a licence is required.
\n
MTN support in Uganda covers only pay-ins (collections).
\n
Airtel support in Zambia covers only pay-ins (collections).
\n

Partially Supported Countries

Pay-ins (Collections) Only – Crossborder

Country	Region	Telco	Settlement Type
Benin	FSSA	Moov	Crossborder – USD, EUR
Benin	FSSA	MTN	Crossborder – USD, EUR
Burkina Faso	FSSA	Moov	Crossborder – USD, EUR
Burkina Faso	FSSA	Orange	Crossborder – USD, EUR
Burkina Faso	FSSA	Mobicash	Crossborder – USD, EUR
Côte d'Ivoire	FSSA	Moov	Crossborder – USD, EUR
Côte d'Ivoire	FSSA	MTN	Crossborder – USD, EUR
Côte d'Ivoire	FSSA	Orange	Crossborder – USD, EUR
Côte d'Ivoire	FSSA	Wave	Crossborder – USD, EUR
Guinea Conakry	FSSA	MTN	Crossborder – USD, EUR
Guinea Conakry	FSSA	Orange	Crossborder – USD, EUR
Kenya	SEA	M-Pesa	Crossborder – USD, EUR
Mali	FSSA	Mobicash	Crossborder – USD, EUR
Mali	FSSA	Orange	Crossborder – USD, EUR
Nigeria	AWA	Baxi	Crossborder – USD, EUR
Nigeria	AWA	Banks	Crossborder – USD, EUR
Rwanda	SEA	Airtel	Crossborder – USD, EUR
Rwanda	SEA	MTN	Crossborder – USD, EUR
Senegal	FSSA	Free	Crossborder – USD, EUR
Senegal	FSSA	Orange	Crossborder – USD, EUR
Senegal	FSSA	Wave	Crossborder – USD, EUR
Tanzania	SEA	Airtel	Crossborder – USD, EUR
Tanzania	SEA	Vodacom	Crossborder – USD, EUR
Tanzania	SEA	Tigo	Crossborder – USD, EUR
Togo	FSSA	Moov – Flooz	Crossborder – USD, EUR
Togo	FSSA	Togocell T-Money	Crossborder – USD, EUR

Additional countries going live in General Release in Q2 2025: Botswana, Congo Brazzaville, and Gabon.

South Africa will go liver in Q3 2025.

Pay-outs (Disbursement) Only – Crossborder

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

Country	Region	Telco	Disbursement Type
Ethiopia	FSSA	Amole	Crossborder – USD, EUR
Malawi	SEA	Airtel	Crossborder – USD, EUR
Malawi	SEA	TNM	Crossborder – USD, EUR
South Sudan	FSSA	Mgurush	Crossborder – USD, EUR

Additional countries going live in General Release in Q2 2025 (subject to successful testing and compliance review): Botswana, Congo Brazzaville, Gabon, Ivory Coast (Côte d'Ivoire), Nigeria, Rwanda, Senegal, and Tanzania.
South Africa will go live in Q3.
More countries to be launched in Q2 – please speak with your Account Manager or Sales Representative for further details.

Region Abbreviations:

FSSA: Francophone Sub-Saharan Africa
\n
SEA: Southern and Eastern Africa
\n
AWA: Anglophone West Africa
\n

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

Parameter	Notes
client.email	An Identifier for a user, should be a valid email.
client.city	City of the user.
client.country	ISO-3166 Country Code. It must be upper case.
client.stateCode	ISO-3166-2 State Code. Must be in upper case.
client.street_address	street address of the user.
client.zip_code	zip code of the user.
client.phone	Phone number of the user. Country code is mandatory. Example: +234999999999
client.full_name	Full name of the user. Minimum 2 words with atleast 1 character in each word.
purchase.currency	ISO 4217 code for currency you want to send the transaction in. eg. This should be 'TZS' for Tanzania CDF for Congo.
purchase.products.name
purchase.products.price	Amount in decimal upto 2 places.
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 progress
failure_redirect	URL to send the user if the transactions is UNSUCCESSFUL

Optional Parameters

expireInMin

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.

paymentMethod

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\n\n\n\n\n\n\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	Description
Invalid format of Date_of_Birth[allowed format: yyyy-mm-dd]
Enter Valid Email
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
Minimum amount is not set for this merchant
success_redirect/failure_redirect/brand_id is missing
brand_id cannot be null
success_redirect cannot be null
failure_redirect cannot be null
Invalid failure_redirect: minimum 10 characters
purchase.products.price cannot be null
purchase.products[0].name/purchase.products[0].price are missing
Your charges setting is incomplete .Plese Contact to Administrator.
Currency \"{curr_name}\" is Not Allowed
Transaction amount must be equal or greater to minimum trans amount
Allowed Limit for this card for particular time period has been consumed

Note: For certain use cases, in addition to long format purchase Id, Paysecure also provides a 7 digit unique code for each purchase starting with digit 4, eg 4000001

“purchaseIdShortCode”: “4000013\"

\n","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"fb832894-72c2-498a-a6e9-17c92b5ff5d6","id":"fb832894-72c2-498a-a6e9-17c92b5ff5d6","name":"PayIn API","type":"folder"}},"urlObject":{"path":["purchases",""],"host":["https://api.paysecure.net/api/v1"],"query":[],"variable":[]}},"response":[{"id":"e8d519a0-c534-4ddc-a2cd-3112d415dec6","name":"Success","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer {{APIKey}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"client\": {\n \"full_name\": \"Riley Haddad\",\n \"email\": \"user9023@example.com\",\n \"country\": \"CD\",\n \"city\": \"Milford\",\n \"stateCode\": \"RJ\",\n \"street_address\": \"90 Fixture Close\",\n \"zip_code\": \"68403\",\n \"date_of_birth\": \"1994-31-04\",\n \"phone\": \"+243999999999\"\n },\n \"purchase\": {\n \"currency\": \"CDF\",\n \"products\": [\n {\n \"name\": \"Test Product\",\n \"price\": \"100\"\n }\n ]\n },\n \"paymentMethod\": \"MOBILEMONEY\",\n \"brand_id\": \"your-brand-id\",\n \"success_redirect\": \"https://your.success.redirect.com\",\n \"pending_redirect\": \"https://your.pending.redirect.com\",\n \"failure_redirect\": \"https://your.failure.redirect.com\",\n \"success_callback\": \"https://your.success.callback.com\",\n \"failure_callback\": \"https://your.failure.callback.com\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.paysecure.net/api/v1/purchases/"},"status":"Accepted","code":202,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Fri, 06 Dec 2024 14:59:14 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Vary","value":"Origin"},{"key":"Vary","value":"Access-Control-Request-Method"},{"key":"Vary","value":"Access-Control-Request-Headers"},{"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=pWCTJZboe33ICYkJiwuwk9QQ4TLxjgXAKCGEbQUbwdP%2Bdbr%2FHFvOVzWWsAS7UIypOGSXOnu52hAILUoGn0yrB2iqXMR9PhPHoTuxnVIEyihZEXx8Fv7QXgASe%2F4CUAQc%2BMupXRwPfFI%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":"8edd237addbf0f97-EWR"},{"key":"alt-svc","value":"h3=\":443\"; ma=86400"},{"key":"server-timing","value":"cfL4;desc=\"?proto=TCP&rtt=223565&min_rtt=223292&rtt_var=63299&sent=15&recv=16&lost=0&retrans=0&sent_bytes=4524&recv_bytes=3359&delivery_rate=19323&cwnd=255&unsent_bytes=0&cid=6b5591269d33c417&ts=10327&x=0\""}],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\n \"purchaseId\": \"69ec68f9f76f0f58bd700058\",\n \"client\": {\n \"customerId\": \"NA\",\n \"email\": \"user2893@example.com\",\n \"phone\": \"243995980380\",\n \"full_name\": \"Reese Nakamura\",\n \"date_of_birth\": \"1994-31-04\",\n \"street_address\": \"90 Fixture Close\",\n \"country\": \"CD\",\n \"city\": \"Riverton\",\n \"zip_code\": \"68403\",\n \"cc\": [],\n \"bcc\": [],\n \"stateCode\": \"RJ\"\n },\n \"updated_on\": 1777101049,\n \"type\": \"purchase\",\n \"paymentMethod\": \"MOBILEMONEY\",\n \"amountUnit\": \"MAJOR\",\n \"errorMsg\": \"\",\n \"errorCode\": \"NA\",\n \"force_recurring\": false,\n \"created_on\": 1777101049,\n \"merchantRef\": \"69ec68f9f76f0f58bd700058\",\n \"purchase\": {\n \"currency\": \"CDF\",\n \"products\": [\n {\n \"name\": \"gaming cards\",\n \"quantity\": 1.0,\n \"price\": 1000.0,\n \"discount\": 0,\n \"tax_percent\": \"0.00\"\n }\n ],\n \"total\": 1000.0,\n \"requestAmount\": 1000.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\": \"CREATED\",\n \"status_history\": [\n {\n \"status\": \"created\",\n \"timestamp\": 1777101049\n }\n ],\n \"is_test\": false,\n \"brand_id\": \"your-brand-id\",\n \"send_receipt\": false,\n \"is_recurring_token\": false,\n \"skip_capture\": false,\n \"reference_generated\": \"PS1711\",\n \"issued\": \"2026-04-25\",\n \"due\": 1777101049,\n \"refund_upto\": 0,\n \"cc_descriptor\": \"\",\n \"fraudScore\": \"NA\",\n \"trustScore\": \"NA\",\n \"extraFee\": \"0\",\n \"totalRefunded\": 0.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://your.success.redirect.com\",\n \"failure_redirect\": \"https://your.failure.redirect.com\",\n \"pending_redirect\": \"https://your.pending.redirect.com\",\n \"cancel_redirect\": \"\",\n \"success_callback\": \"https://your.success.callback.com\",\n \"failure_callback\": \"https://your.failure.callback.com\",\n \"platform\": \"API\",\n \"created_from_ip\": \"2406:b400:75:584c:8889:bfe5:9552:8720\",\n \"checkout_url\": \"https://api.paysecure.net/payments/5f95c39387eefc684560013794f41455/\",\n \"payoutProcess\": false\n}"}],"_postman_id":"375c9baf-8f35-4675-b879-85aea67499ac"}],"id":"fb832894-72c2-498a-a6e9-17c92b5ff5d6","auth":{"type":"noauth","isInherited":false},"event":[{"listen":"prerequest","script":{"type":"text/javascript","packages":{},"requests":{},"exec":[""],"id":"3349e2ed-209f-4fbd-98e7-3b7f8e796122"}},{"listen":"test","script":{"type":"text/javascript","packages":{},"requests":{},"exec":[""],"id":"6c4878e4-4ed9-4695-ad00-76adcadec78d"}}],"_postman_id":"fb832894-72c2-498a-a6e9-17c92b5ff5d6","description":""},{"name":"Payout API","item":[{"name":"Payout","id":"ad166edc-8e44-4c27-8a6c-87f92d79011d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer {{APIKey}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"client\": {\n \"full_name\": \"Riley Haddad\",\n \"email\": \"user9023@example.com\",\n \"country\": \"CD\",\n \"city\": \"Milford\",\n \"stateCode\": \"RJ\",\n \"street_address\": \"90 Fixture Close\",\n \"zip_code\": \"68403\",\n \"date_of_birth\": \"1994-31-04\",\n \"phone\": \"+243999999999\"\n },\n \"purpose\": \"Testing payout\",\n \"currency\": \"CDF\",\n \"payoutMethod\": \"PAYOUT-MOBILEMONEY\",\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}","options":{"raw":{"language":"json"}}},"url":"https://api.paysecure.net/api/v1/payout/","description":"

To Initiate a payout, the very first call to make is /payout/ API with the required data in the request body.

To generate a PayOut, you are required to provide the API key (in the header), which 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.full_name	Full name of the receiver. Minimum 2 words with atleast 1 character in each word.
client.email	An Identifier for a receiver, should be a valid email.
client.country	ISO-3166 Country Code. It must be upper case.
client.stateCode	ISO-3166-2 State Code. Must be in upper case.
client.street_address	street address of the receiver.
client.zip_code	zip code of the receiver.
client.phone	Phone number of the receiver. Country code is mandatory. Example: +234999999999
payoutMethod	Payout-MOBILEMONEY
Amount	Amount in currency upto 2 decimal points
Currency	Note this is currency account for which you have balance.
success_redirect	URL to send the user if the payout is successful
pending_redirect	URL to send the user if the payout is in progress
failure_redirect	URL to send the user if the payout is unsuccessful.
Purpose	Purpose of Payout

","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"365cb5b2-22d6-4cb7-b67f-dba581a96911","id":"365cb5b2-22d6-4cb7-b67f-dba581a96911","name":"Payout API","type":"folder"}},"urlObject":{"path":["payout",""],"host":["https://api.paysecure.net/api/v1"],"query":[],"variable":[]}},"response":[{"id":"1a6cd897-d20f-49f2-a1c6-676ed9e73b5f","name":"Success","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer {{APIKey}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"client\": {\n \"full_name\": \"Riley Haddad\",\n \"email\": \"user9023@example.com\",\n \"country\": \"CD\",\n \"city\": \"Milford\",\n \"stateCode\": \"RJ\",\n \"street_address\": \"90 Fixture Close\",\n \"zip_code\": \"68403\",\n \"date_of_birth\": \"1994-31-04\",\n \"phone\": \"+243999999999\"\n },\n \"purpose\": \"Testing payout\",\n \"currency\": \"CDF\",\n \"payoutMethod\": \"PAYOUT-MOBILEMONEY\",\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}","options":{"raw":{"language":"json"}}},"url":"https://api.paysecure.net/api/v1/payout/"},"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":"{\n \"payoutId\": \"69ec70c5b7b9052cc4823367\",\n \"client\": {\n \"customerId\": \"NA\",\n \"full_name\": \"Riley Haddad\",\n \"email\": \"user9023@example.com\",\n \"country\": \"CD\",\n \"city\": \"Milford\",\n \"stateCode\": \"RJ\",\n \"street_address\": \"90 Fixture Close\",\n \"zip_code\": \"68403\",\n \"date_of_birth\": \"1994-31-04\",\n \"phone\": \"+243999999999\"\n },\n \"updated_on\": 1777103045,\n \"payoutMethod\": \"PAYOUT-MOBILEMONEY\",\n \"amountUnit\": \"MAJOR\",\n \"amount\": 100.0,\n \"errorMsg\": \"\",\n \"is_test\": false,\n \"purpose\": \"Testing payout\",\n \"created_on\": 1777103045,\n \"merchantRef\": \"69ec70c5b7b9052cc4823367\",\n \"status\": \"PAID\",\n \"status_history\": [\n {\n \"status\": \"created\",\n \"timestamp\": 1777103045\n },\n {\n \"status\": \"paid\",\n \"timestamp\": 1777103045\n }\n ],\n \"currency\": \"CDF\",\n \"extraFee\": \"0\",\n \"paymentOn\": 0,\n \"checkout_url\": \"https://api.paysecure.net/payout/0685d9437d0eb79e48ee8158542d9918/\",\n \"taxAmount\": 0.0,\n \"taxPercent\": 0.0,\n \"success_redirect\": \"https://your.success.redirect.com\",\n \"pending_redirect\": \"https://your.pending.redirect.com\",\n \"failure_redirect\": \"https://your.failure.redirect.com\",\n \"redirectType\": \"POST\",\n \"sessionId\": \"\",\n \"surcharge\": 0.0,\n \"surchargeType\": \"\",\n \"trxMethod\": \"\",\n \"success_callback\": \"https://your.success.callback.com\",\n \"failure_callback\": \"https://your.failure.callback.com\"\n \"utc_offset\": \"NA\"\n}"}],"_postman_id":"ad166edc-8e44-4c27-8a6c-87f92d79011d"}],"id":"365cb5b2-22d6-4cb7-b67f-dba581a96911","auth":{"type":"noauth","isInherited":false},"event":[{"listen":"prerequest","script":{"type":"text/javascript","packages":{},"requests":{},"exec":[""],"id":"8d5fddc5-e71d-48f2-81c9-d9728703c3f8"}},{"listen":"test","script":{"type":"text/javascript","packages":{},"requests":{},"exec":[""],"id":"4ab4fa08-3251-44ab-9f07-fd478403f82d"}}],"_postman_id":"365cb5b2-22d6-4cb7-b67f-dba581a96911","description":""}],"id":"f358b47f-356f-4e37-8106-38de9315e6cb","auth":{"type":"noauth","isInherited":false},"event":[{"listen":"prerequest","script":{"type":"text/javascript","packages":{},"requests":{},"exec":[""],"id":"cbc80400-79f9-4d0b-9f19-82944afc0329"}},{"listen":"test","script":{"type":"text/javascript","packages":{},"requests":{},"exec":[""],"id":"d6c33588-f4d4-47ae-ba78-dac39a1c5842"}}],"_postman_id":"f358b47f-356f-4e37-8106-38de9315e6cb","description":""},{"name":"🌎 Google Pay Redirect","item":[{"name":"Concepts","item":[],"id":"c89d09c8-9396-44b2-9251-cd37a143e335","description":"

Overview

Google Pay enables customers to make payments on a merchant’s website or app using credit or debit cards securely stored in their Google Account. During checkout, Google Pay presents a payment sheet where customers can select their preferred card and confirm the transaction.

Customers add their payment cards to the Google Pay wallet, which securely stores the card details. When making a purchase, they simply choose Google Pay as the payment method and complete the payment using a saved card—eliminating the need to enter card information repeatedly.

Features

Convenient: Customers can pay using cards already saved in Google Pay, reducing friction during checkout.
\n
Secure: Uses tokenization to ensure sensitive card information is never exposed during the payment flow.
\n
3D Secure support: The payment handle created through the integration supports 3D Secure authentication when required, enabling secure transactions.
\n
Wide coverage: Supported across multiple regions and currencies.
\n

By integrating Google Pay through the Paysecure API, you can offer your customers a fast, secure, and seamless payment experience.

Note

This is a redirection-based payment method. During the payment flow, the user is redirected to a third-party application or interface, where the Google Pay button is displayed for completing the transaction.

To Initiate a payment, the very first call to make is /purchases with the required data in the request body.

To generate a Purchase, you are required to provide the Brand ID (in the request body) and API key (in the header) Both can be located in the Dashboard section of your merchant account login.

The request body structure is shown on the request body of the example request shown here.

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

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

Parameter	Notes
client.full_name	Conditional. But Recommended to pass the complete name of the client. Atleast 2 words recommended.
client.email	Conditional. But Recommended to pass a correct email id.
paymentMethod	Conditional. Mandatory if you are not using Paysecure Cashier. Else Non Mandatory. Value: GOOGLEPAY-REDIRECT
purchase.currency	Mandatory. ISO 4217 code for currency you want to send the transaction in. This should be 'BRL' for PIX.
purchase.products.name	Mandatory.
purchase.products.price	Mandatory. Price in decimal format upto 2 decimals. 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	Mandatory. Obtain from Dashboard section of your merchant account login.
success_redirect	Mandatory. URL to send the user if the transactions is successful.
pending_redirect	Mandatory. URL to send the user if the transactions is in progress state.
failure_redirect	Mandatory URL to send the user if the transactions has failed.

Optional Parameters

expireInMin

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.

paymentMethod

\n","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"3eb82563-4c53-418b-bd24-91ea8f589ad0","id":"3eb82563-4c53-418b-bd24-91ea8f589ad0","name":"APIs","type":"folder"}},"urlObject":{"path":["purchases",""],"host":["https://api.paysecure.net/api/v1"],"query":[],"variable":[]}},"response":[{"id":"3456312b-b049-476e-84b4-0b18a5f6adbf","name":"Purchase - success","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer {{APIKey}}"}],"body":{"mode":"raw","raw":"{\r\n \"client\": {\r\n \"email\": \"user1599@example.com\",\r\n \"country\": \"GB\",\r\n \"city\": \"Milford\",\r\n \"stateCode\": \"RJ\",\r\n \"street_address\": \"90 Fixture Close\",\r\n \"zip_code\": \"68403\",\r\n \"date_of_birth\": \"1994-31-04\",\r\n \"phone\": \"+91 9634088561\",\r\n \"full_name\": \"Reese Nakamura\"\r\n },\r\n \"purchase\": {\r\n \"currency\": \"EUR\",\r\n \"products\": [\r\n {\r\n \"name\": \"gaming cards \",\r\n \"price\": 10\r\n }\r\n ]\r\n },\r\n \"brand_id\": \"your-brand-id\",\r\n \"paymentMethod\": \"GOOGLEPAY-REDIRECT\",\r\n \"success_redirect\": \"https://your.success.redirect.com\",\r\n \"pending_redirect\": \"https://your.pending.redirect.com\",\r\n \"failure_redirect\": \"https://your.failure.redirect.com\",\r\n \"success_callback\": \"https://your.success.callback.com\",\r\n \"failure_callback\": \"https://your.failure.callback.com\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.paysecure.net/api/v1/purchases"},"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":"{\r\n \"purchaseId\": \"69634df44549cbd3547ac750\",\r\n \"client\": {\r\n \"customerId\": \"NA\",\r\n \"email\": \"user1599@example.com\",\r\n \"phone\": \"+91 9634088561\",\r\n \"full_name\": \"Reese Nakamura\",\r\n \"date_of_birth\": \"1994-31-04\",\r\n \"street_address\": \"90 Fixture Close\",\r\n \"country\": \"GB\",\r\n \"city\": \"Milford\",\r\n \"zip_code\": \"68403\",\r\n \"cc\": [],\r\n \"bcc\": [],\r\n \"stateCode\": \"RJ\"\r\n },\r\n \"updated_on\": 1768115701,\r\n \"type\": \"purchase\",\r\n \"paymentMethod\": \"GOOGLEPAY-REDIRECT\",\r\n \"amountUnit\": \"MAJOR\",\r\n \"errorMsg\": \"\",\r\n \"errorCode\": \"NA\",\r\n \"force_recurring\": false,\r\n \"created_on\": 1768115700,\r\n \"merchantRef\": \"69634df44549cbd3547ac750\",\r\n \"purchase\": {\r\n \"currency\": \"EUR\",\r\n \"products\": [\r\n {\r\n \"name\": \"gaming cards\",\r\n \"quantity\": 1.0,\r\n \"price\": 1.0,\r\n \"discount\": 0,\r\n \"tax_percent\": \"0.00\"\r\n }\r\n ],\r\n \"total\": 1.0,\r\n \"requestAmount\": 1.0,\r\n \"language\": \"en\",\r\n \"notes\": \"\",\r\n \"debt\": 0,\r\n \"total_formatted\": 1.0,\r\n \"taxAmount\": 0.0,\r\n \"taxPercent\": 0.0,\r\n \"request_client_details\": [],\r\n \"email_message\": \"\"\r\n },\r\n \"payment\": {\r\n \"is_outgoing\": false,\r\n \"payment_type\": \"PURCHASE\",\r\n \"amount\": 1.0,\r\n \"currency\": \"EUR\",\r\n \"net_amount\": 1.0,\r\n \"fee_amount\": 0.0,\r\n \"pending_amount\": 0.0,\r\n \"pending_unfreeze_on\": null,\r\n \"description\": \"\",\r\n \"paid_on\": 1768115700,\r\n \"remote_paid_on\": 1768115700\r\n },\r\n \"issuer_details\": {\r\n \"website\": \"\",\r\n \"legal_street_address\": \"\",\r\n \"legal_country\": \"\",\r\n \"legal_city\": \"\",\r\n \"legal_zip_code\": \"\",\r\n \"bank_accounts\": [\r\n {}\r\n ],\r\n \"legal_name\": \"Testing\",\r\n \"brand_name\": \"Testing\",\r\n \"registration_number\": \"\",\r\n \"tax_number\": \"\"\r\n },\r\n \"transaction_data\": {\r\n \"payment_method\": \"\",\r\n \"flow\": \"payform\",\r\n \"extra\": {\r\n \"amount\": 1.0,\r\n \"masked_pan\": \"GOOGLEPAY-REDIRECT\"\r\n },\r\n \"country\": \"\",\r\n \"attempts\": [\r\n {\r\n \"client_ip\": \"203.0.113.224\",\r\n \"type\": \"execute\",\r\n \"payment_method\": \"GOOGLEPAY-REDIRECT\",\r\n \"flow\": \"payform\",\r\n \"successful\": true,\r\n \"country\": \"GOOGLEPAY-REDIRECT\",\r\n \"processing_time\": 1768115700,\r\n \"extra\": {\r\n \"amount\": 1.0,\r\n \"masked_pan\": \"GOOGLEPAY-REDIRECT\"\r\n }\r\n }\r\n ]\r\n },\r\n \"status\": \"PAYMENT_IN_PROCESS\",\r\n \"status_history\": [\r\n {\r\n \"status\": \"created\",\r\n \"timestamp\": 1768115700\r\n },\r\n {\r\n \"status\": \"pending_execute\",\r\n \"timestamp\": 1768115700\r\n },\r\n {\r\n \"status\": \"payment_in_process\",\r\n \"timestamp\": 1768115701\r\n }\r\n ],\r\n \"is_test\": false,\r\n \"brand_id\": \"your-brand-id\",\r\n \"send_receipt\": false,\r\n \"is_recurring_token\": false,\r\n \"skip_capture\": false,\r\n \"reference_generated\": \"PS363\",\r\n \"issued\": \"2026-01-11\",\r\n \"due\": 1768115700,\r\n \"refund_upto\": 1783664101,\r\n \"cc_descriptor\": \"\",\r\n \"fraudScore\": \"0\",\r\n \"trustScore\": \"1\",\r\n \"extraFee\": \"0\",\r\n \"pix_payload\": {},\r\n \"payInDetails\": {},\r\n \"paidOn\": 0,\r\n \"receivedAmt\": 0.0,\r\n \"taxAmount\": 0.0,\r\n \"surcharge\": 0.0,\r\n \"surchargeType\": \"\",\r\n \"sessionId\": \"\",\r\n \"refund_availability\": \"NONE\",\r\n \"refundable_amount\": 1.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 \"platform\": \"API\",\r\n \"created_from_ip\": \"203.0.113.224\",\r\n \"checkout_url\": \"https://api.paysecure.net/payments/deb852445bd4b0fa6c4587f652174ab9/\",\r\n \"payoutProcess\": false\r\n}"},{"id":"dd02cbd7-c771-4579-bbf8-9f6c61d82e0d","name":"Purchase - failure","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer {{APIKey}}"}],"body":{"mode":"raw","raw":"{\r\n \"client\": {\r\n \"email\": \"user1599@example.com\",\r\n \"country\": \"GB\",\r\n \"city\": \"Milford\",\r\n \"stateCode\": \"RJ\",\r\n \"street_address\": \"90 Fixture Close\",\r\n \"zip_code\": \"68403\",\r\n \"date_of_birth\": \"1994-31-04\",\r\n \"phone\": \"+91 9634088561\",\r\n \"full_name\": \"Reese Nakamura\"\r\n },\r\n \"purchase\": {\r\n \"currency\": \"EUR\",\r\n \"products\": [\r\n {\r\n \"name\": \"gaming cards \",\r\n \"price\": 10\r\n }\r\n ]\r\n },\r\n \"brand_id\": \"your-brand-id\",\r\n \"paymentMethod\": \"GOOGLEPAY-REDIRECT\",\r\n \"success_redirect\": \"https://your.success.redirect.com\",\r\n \"pending_redirect\": \"https://your.pending.redirect.com\",\r\n \"failure_redirect\": \"https://your.failure.redirect.com\",\r\n \"success_callback\": \"https://your.success.callback.com\",\r\n \"failure_callback\": \"https://your.failure.callback.com\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.paysecure.net/api/v1/purchases"},"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":"{\r\n \"message\": \"Error Message\",\r\n \"code\": \"error_code\"\r\n}"}],"_postman_id":"f50368d3-5f01-42cb-b05f-f404278bf151"},{"name":"Session","id":"6b6c456e-d937-42b9-ba0f-d401ad655508","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"https://api.paysecure.net/api/v1/createSession","description":"

OVERVIEW

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

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: PaySecure 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","urlObject":{"path":["createSession"],"host":["https://api.paysecure.net/api/v1"],"query":[],"variable":[]}},"response":[{"id":"4413c734-7f63-4240-ab77-e5c25c8b24f5","name":"Success","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"*/*","type":"text"},{"key":"BrandId","value":"your-brand-id","description":"it is mandatory to pass the BrandId in header for each createSession request. ","type":"text"},{"key":"Authorization","value":"Bearer {{APIKey}}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"customerId\": \"69034a5a61b460084d20c23b\",\r\n \"merchantRef\": \"user5489@example.com\", // optional\r\n \"currency\": \"EUR\",\r\n \"products\": [\r\n {\r\n \"name\": \"Product1\",\r\n \"price\": \"10\"\r\n },\r\n {\r\n \"name\": \"Product2\",\r\n \"price\": \"12\"\r\n }\r\n ],\r\n \"totalAmount\": \"22\", // optional, but if present have precedence over sum of prices.\r\n \"paymentMethod\": \"GOOGLEPAY-REDIRECT\", //optional\r\n \"success_redirect\": \"https://your.success.redirect.com\",\r\n \"pending_redirect\": \"https://your.pending.redirect.com\",\r\n \"failure_redirect\": \"https://your.failure.redirect.com\",\r\n \"success_callback\": \"https://your.success.callback.com\",\r\n \"failure_callback\": \"https://your.failure.callback.com\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.paysecure.net/api/v1/createSession"},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":"{\r\n \"sessionUrl\": \"https://api.paysecure.net/payment-session/6963533a0a18ea65153a81e7/\",\r\n \"brandId\": \"your-brand-id\",\r\n \"customerId\": \"69034a5a61b460084d20c23b\",\r\n \"sessionId\": \"6963533a0a18ea65153a81e7\",\r\n \"expiryOn\": 1768117950,\r\n \"createdOn\": 1768117050\r\n}"},{"id":"130a8933-158b-4513-bed7-4c27b8542a72","name":"Invalid Session","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"*/*","type":"text"},{"key":"BrandId","value":"your-brand-id","description":"it is mandatory to pass the BrandId in header for each createSession request. ","type":"text"},{"key":"Authorization","value":"Bearer {{APIKey}}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"customerId\": \"69034a5a61b460084d20c23b\",\r\n \"merchantRef\": \"user5489@example.com\", // optional\r\n \"currency\": \"EUR\",\r\n \"products\": [\r\n {\r\n \"name\": \"Product1\",\r\n \"price\": \"10\"\r\n },\r\n {\r\n \"name\": \"Product2\",\r\n \"price\": \"12\"\r\n }\r\n ],\r\n \"totalAmount\": \"22\", // optional, but if present have precedence over sum of prices.\r\n \"paymentMethod\": \"GOOGLEPAY-REDIRECT\", //optional\r\n \"success_redirect\": \"https://your.success.redirect.com\",\r\n \"pending_redirect\": \"https://your.pending.redirect.com\",\r\n \"failure_redirect\": \"https://your.failure.redirect.com\",\r\n \"success_callback\": \"https://your.success.callback.com\",\r\n \"failure_callback\": \"https://your.failure.callback.com\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.paysecure.net/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":"6b6c456e-d937-42b9-ba0f-d401ad655508"},{"name":"Get Status","id":"b7ad03fd-41b0-4b16-9ad1-66e731debccd","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer {{APIKey}}","type":"text"}],"url":"https://api.paysecure.net/api/v1/purchases/{purchaseId}/","description":"

This API tells you about all the details of a purchase (PayIn), 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

Status	Notes
paid	Transaction Successful
payment_in_process	Payment is under Processing
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":"3eb82563-4c53-418b-bd24-91ea8f589ad0","id":"3eb82563-4c53-418b-bd24-91ea8f589ad0","name":"APIs","type":"folder"}},"urlObject":{"path":["purchases","{purchaseId}",""],"host":["https://api.paysecure.net/api/v1"],"query":[],"variable":[]}},"response":[{"id":"ebe52f92-af68-4849-b0c8-640a2eed040e","name":"Purchase - success","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer {{APIKey}}"}],"url":"https://api.paysecure.net/api/v1/purchases/{purchaseId}/"},"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":"{\r\n \"purchaseId\": \"69634df44549cbd3547ac750\",\r\n \"client\": {\r\n \"customerId\": \"NA\",\r\n \"email\": \"user1599@example.com\",\r\n \"phone\": \"+91 9634088561\",\r\n \"full_name\": \"Reese Nakamura\",\r\n \"date_of_birth\": \"1994-31-04\",\r\n \"street_address\": \"90 Fixture Close\",\r\n \"country\": \"GB\",\r\n \"city\": \"Milford\",\r\n \"zip_code\": \"68403\",\r\n \"cc\": [],\r\n \"bcc\": [],\r\n \"stateCode\": \"RJ\"\r\n },\r\n \"updated_on\": 1768115701,\r\n \"type\": \"purchase\",\r\n \"paymentMethod\": \"GOOGLEPAY-REDIRECT\",\r\n \"amountUnit\": \"MAJOR\",\r\n \"errorMsg\": \"\",\r\n \"errorCode\": \"NA\",\r\n \"force_recurring\": false,\r\n \"created_on\": 1768115700,\r\n \"merchantRef\": \"69634df44549cbd3547ac750\",\r\n \"purchase\": {\r\n \"currency\": \"EUR\",\r\n \"products\": [\r\n {\r\n \"name\": \"gaming cards\",\r\n \"quantity\": 1.0,\r\n \"price\": 1.0,\r\n \"discount\": 0,\r\n \"tax_percent\": \"0.00\"\r\n }\r\n ],\r\n \"total\": 1.0,\r\n \"requestAmount\": 1.0,\r\n \"language\": \"en\",\r\n \"notes\": \"\",\r\n \"debt\": 0,\r\n \"total_formatted\": 1.0,\r\n \"taxAmount\": 0.0,\r\n \"taxPercent\": 0.0,\r\n \"request_client_details\": [],\r\n \"email_message\": \"\"\r\n },\r\n \"payment\": {\r\n \"is_outgoing\": false,\r\n \"payment_type\": \"PURCHASE\",\r\n \"amount\": 1.0,\r\n \"currency\": \"EUR\",\r\n \"net_amount\": 1.0,\r\n \"fee_amount\": 0.0,\r\n \"pending_amount\": 0.0,\r\n \"pending_unfreeze_on\": null,\r\n \"description\": \"\",\r\n \"paid_on\": 1768115700,\r\n \"remote_paid_on\": 1768115700\r\n },\r\n \"issuer_details\": {\r\n \"website\": \"\",\r\n \"legal_street_address\": \"\",\r\n \"legal_country\": \"\",\r\n \"legal_city\": \"\",\r\n \"legal_zip_code\": \"\",\r\n \"bank_accounts\": [\r\n {}\r\n ],\r\n \"legal_name\": \"Testing\",\r\n \"brand_name\": \"Testing\",\r\n \"registration_number\": \"\",\r\n \"tax_number\": \"\"\r\n },\r\n \"transaction_data\": {\r\n \"payment_method\": \"\",\r\n \"flow\": \"payform\",\r\n \"extra\": {\r\n \"amount\": 1.0,\r\n \"masked_pan\": \"GOOGLEPAY-REDIRECT\"\r\n },\r\n \"country\": \"\",\r\n \"attempts\": [\r\n {\r\n \"client_ip\": \"203.0.113.224\",\r\n \"type\": \"execute\",\r\n \"payment_method\": \"GOOGLEPAY-REDIRECT\",\r\n \"flow\": \"payform\",\r\n \"successful\": true,\r\n \"country\": \"GOOGLEPAY-REDIRECT\",\r\n \"processing_time\": 1768115700,\r\n \"extra\": {\r\n \"amount\": 1.0,\r\n \"masked_pan\": \"GOOGLEPAY-REDIRECT\"\r\n }\r\n }\r\n ]\r\n },\r\n \"status\": \"PAID\",\r\n \"status_history\": [\r\n {\r\n \"status\": \"created\",\r\n \"timestamp\": 1768115700\r\n },\r\n {\r\n \"status\": \"pending_execute\",\r\n \"timestamp\": 1768115700\r\n },\r\n {\r\n \"status\": \"payment_in_process\",\r\n \"timestamp\": 1768115701\r\n },\r\n {\r\n \"status\": \"paid\",\r\n \"timestamp\": 1768115701\r\n }\r\n ],\r\n \"is_test\": false,\r\n \"brand_id\": \"your-brand-id\",\r\n \"send_receipt\": false,\r\n \"is_recurring_token\": false,\r\n \"skip_capture\": false,\r\n \"reference_generated\": \"PS363\",\r\n \"issued\": \"2026-01-11\",\r\n \"due\": 1768115700,\r\n \"refund_upto\": 1783664101,\r\n \"cc_descriptor\": \"\",\r\n \"fraudScore\": \"0\",\r\n \"trustScore\": \"1\",\r\n \"extraFee\": \"0\",\r\n \"pix_payload\": {},\r\n \"payInDetails\": {},\r\n \"paidOn\": 0,\r\n \"receivedAmt\": 0.0,\r\n \"taxAmount\": 0.0,\r\n \"surcharge\": 0.0,\r\n \"surchargeType\": \"\",\r\n \"sessionId\": \"\",\r\n \"refund_availability\": \"NONE\",\r\n \"refundable_amount\": 1.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 \"platform\": \"API\",\r\n \"created_from_ip\": \"203.0.113.224\",\r\n \"checkout_url\": \"https://api.paysecure.net/payments/deb852445bd4b0fa6c4587f652174ab9/\",\r\n \"payoutProcess\": false\r\n}"},{"id":"680d776b-1f02-411d-8ac9-132c9036d722","name":"Purchase - failure","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer {{APIKey}}","type":"text"}],"url":"https://api.paysecure.net/api/v1/purchases/{purchaseId}/"},"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":"{\r\n \"message\": \"Error Message\",\r\n \"code\": \"error_code\"\r\n}"}],"_postman_id":"b7ad03fd-41b0-4b16-9ad1-66e731debccd"}],"id":"3eb82563-4c53-418b-bd24-91ea8f589ad0","description":"

API Flow

The merchant initiates the purchase via the create purchase API and passing the appropriate payment method. If successful, they receive a checkout URL in the response JSON.
\n
Upon utilizing the checkout URL, the user will be presented with a screen where he will be shown a button to pay via Googlepay.
\n
After clicking the button, the user will see all the cards stored in the google wallet and he can choose one of the cards to make the purchase.
\n
After a successful or failed payment by the end user, an appropriate webhook would be sent to the merchant. The user would also be redirected to the appropriate redirect URL.
\n

Overview

Apple Pay enables customers to make payments on a merchant’s website or app using credit or debit cards securely stored in their Apple Wallet. During checkout, Apple Pay presents a payment sheet where customers can select their preferred card and confirm the payment using Touch ID, Face ID, or their device passcode.

Customers add their payment cards to Apple Wallet, which securely stores the card information. When making a purchase, they simply select Apple Pay as the payment method and complete the transaction using a saved card—eliminating the need to manually enter card details for each payment.

Features

Convenient: Customers can pay using cards already saved in Apple Pay, reducing checkout friction.
\n
Secure: Uses device-specific tokenization (DPAN/MPAN) to protect sensitive card data during the payment process.
\n
3D Secure support: The payment handle created through the integration supports 3D Secure authentication when required, ensuring secure transactions.
\n
Wide coverage: Supported across multiple regions and currencies.
\n

By integrating Apple Pay through the Paysecure API, you can provide your customers with a fast, secure, and seamless payment experience.

Note

This is a redirection-based payment method. During the payment flow, the user is redirected to a third-party application or interface, where the Apple Pay button is displayed to complete the payment.

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.

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

Parameter	Notes
client.full_name	Conditional. But Recommended to pass the complete name of the client. Atleast 2 words recommended.
client.email	Conditional. But Recommended to pass a correct email id.
paymentMethod	Conditional. Mandatory if you are not using Paysecure Cashier. Else Non Mandatory. Value: APPLEPAY-REDIRECT
purchase.currency	Mandatory. ISO 4217 code for currency you want to send the transaction in. This should be 'BRL' for PIX.
purchase.products.name	Mandatory.
purchase.products.price	Mandatory. Price in decimal format upto 2 decimals. 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	Mandatory. Obtain from Dashboard section of your merchant account login.
success_redirect	Mandatory. URL to send the user if the transactions is successful.
pending_redirect	Mandatory. URL to send the user if the transactions is in progress state.
failure_redirect	Mandatory URL to send the user if the transactions has failed.

Optional Parameters

expireInMin

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.

paymentMethod

\n","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"f00d3191-4475-4a08-ae4e-b2538547aa4f","id":"f00d3191-4475-4a08-ae4e-b2538547aa4f","name":"APIs","type":"folder"}},"urlObject":{"path":["purchases",""],"host":["https://api.paysecure.net/api/v1"],"query":[],"variable":[]}},"response":[{"id":"ff74f432-19d0-49e6-a1ad-1c61999e83a5","name":"Success","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer {{APIKey}}"}],"body":{"mode":"raw","raw":"{\r\n \"client\": {\r\n \"email\": \"user1599@example.com\",\r\n \"country\": \"GB\",\r\n \"city\": \"Milford\",\r\n \"stateCode\": \"RJ\",\r\n \"street_address\": \"90 Fixture Close\",\r\n \"zip_code\": \"68403\",\r\n \"date_of_birth\": \"1994-31-04\",\r\n \"phone\": \"+91 9634088561\",\r\n \"full_name\": \"Reese Nakamura\"\r\n },\r\n \"purchase\": {\r\n \"currency\": \"EUR\",\r\n \"products\": [\r\n {\r\n \"name\": \"gaming cards \",\r\n \"price\": 10\r\n }\r\n ]\r\n },\r\n \"brand_id\": \"your-brand-id\",\r\n \"paymentMethod\": \"APPLEPAY-REDIRECT\",\r\n \"success_redirect\": \"https://your.success.redirect.com\",\r\n \"pending_redirect\": \"https://your.pending.redirect.com\",\r\n \"failure_redirect\": \"https://your.failure.redirect.com\",\r\n \"success_callback\": \"https://your.success.callback.com\",\r\n \"failure_callback\": \"https://your.failure.callback.com\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.paysecure.net/api/v1/purchases"},"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":"{\r\n \"purchaseId\": \"69634df44549cbd3547ac750\",\r\n \"client\": {\r\n \"customerId\": \"NA\",\r\n \"email\": \"user1599@example.com\",\r\n \"phone\": \"+91 9634088561\",\r\n \"full_name\": \"Reese Nakamura\",\r\n \"date_of_birth\": \"1994-31-04\",\r\n \"street_address\": \"90 Fixture Close\",\r\n \"country\": \"GB\",\r\n \"city\": \"Milford\",\r\n \"zip_code\": \"68403\",\r\n \"cc\": [],\r\n \"bcc\": [],\r\n \"stateCode\": \"RJ\"\r\n },\r\n \"updated_on\": 1768115701,\r\n \"type\": \"purchase\",\r\n \"paymentMethod\": \"APPLEPAY-REDIRECT\",\r\n \"amountUnit\": \"MAJOR\",\r\n \"errorMsg\": \"\",\r\n \"errorCode\": \"NA\",\r\n \"force_recurring\": false,\r\n \"created_on\": 1768115700,\r\n \"merchantRef\": \"69634df44549cbd3547ac750\",\r\n \"purchase\": {\r\n \"currency\": \"EUR\",\r\n \"products\": [\r\n {\r\n \"name\": \"gaming cards\",\r\n \"quantity\": 1.0,\r\n \"price\": 1.0,\r\n \"discount\": 0,\r\n \"tax_percent\": \"0.00\"\r\n }\r\n ],\r\n \"total\": 1.0,\r\n \"requestAmount\": 1.0,\r\n \"language\": \"en\",\r\n \"notes\": \"\",\r\n \"debt\": 0,\r\n \"total_formatted\": 1.0,\r\n \"taxAmount\": 0.0,\r\n \"taxPercent\": 0.0,\r\n \"request_client_details\": [],\r\n \"email_message\": \"\"\r\n },\r\n \"payment\": {\r\n \"is_outgoing\": false,\r\n \"payment_type\": \"PURCHASE\",\r\n \"amount\": 1.0,\r\n \"currency\": \"EUR\",\r\n \"net_amount\": 1.0,\r\n \"fee_amount\": 0.0,\r\n \"pending_amount\": 0.0,\r\n \"pending_unfreeze_on\": null,\r\n \"description\": \"\",\r\n \"paid_on\": 1768115700,\r\n \"remote_paid_on\": 1768115700\r\n },\r\n \"issuer_details\": {\r\n \"website\": \"\",\r\n \"legal_street_address\": \"\",\r\n \"legal_country\": \"\",\r\n \"legal_city\": \"\",\r\n \"legal_zip_code\": \"\",\r\n \"bank_accounts\": [\r\n {}\r\n ],\r\n \"legal_name\": \"Testing\",\r\n \"brand_name\": \"Testing\",\r\n \"registration_number\": \"\",\r\n \"tax_number\": \"\"\r\n },\r\n \"transaction_data\": {\r\n \"payment_method\": \"\",\r\n \"flow\": \"payform\",\r\n \"extra\": {\r\n \"amount\": 1.0,\r\n \"masked_pan\": \"APPLEPAY-REDIRECT\"\r\n },\r\n \"country\": \"\",\r\n \"attempts\": [\r\n {\r\n \"client_ip\": \"203.0.113.224\",\r\n \"type\": \"execute\",\r\n \"payment_method\": \"APPLEPAY-REDIRECT\",\r\n \"flow\": \"payform\",\r\n \"successful\": true,\r\n \"country\": \"APPLEPAY-REDIRECT\",\r\n \"processing_time\": 1768115700,\r\n \"extra\": {\r\n \"amount\": 1.0,\r\n \"masked_pan\": \"APPLEPAY-REDIRECT\"\r\n }\r\n }\r\n ]\r\n },\r\n \"status\": \"PAID\",\r\n \"status_history\": [\r\n {\r\n \"status\": \"created\",\r\n \"timestamp\": 1768115700\r\n },\r\n {\r\n \"status\": \"pending_execute\",\r\n \"timestamp\": 1768115700\r\n },\r\n {\r\n \"status\": \"payment_in_process\",\r\n \"timestamp\": 1768115701\r\n },\r\n {\r\n \"status\": \"paid\",\r\n \"timestamp\": 1768115701\r\n }\r\n ],\r\n \"is_test\": false,\r\n \"brand_id\": \"your-brand-id\",\r\n \"send_receipt\": false,\r\n \"is_recurring_token\": false,\r\n \"skip_capture\": false,\r\n \"reference_generated\": \"PS363\",\r\n \"issued\": \"2026-01-11\",\r\n \"due\": 1768115700,\r\n \"refund_upto\": 1783664101,\r\n \"cc_descriptor\": \"\",\r\n \"fraudScore\": \"0\",\r\n \"trustScore\": \"1\",\r\n \"extraFee\": \"0\",\r\n \"pix_payload\": {},\r\n \"payInDetails\": {},\r\n \"paidOn\": 0,\r\n \"receivedAmt\": 0.0,\r\n \"taxAmount\": 0.0,\r\n \"surcharge\": 0.0,\r\n \"surchargeType\": \"\",\r\n \"sessionId\": \"\",\r\n \"refund_availability\": \"NONE\",\r\n \"refundable_amount\": 1.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 \"platform\": \"API\",\r\n \"created_from_ip\": \"203.0.113.224\",\r\n \"checkout_url\": \"https://api.paysecure.net/payments/deb852445bd4b0fa6c4587f652174ab9/\",\r\n \"payoutProcess\": false\r\n}"},{"id":"0ee1a8a7-dd51-4d7f-9452-135a54d1f17b","name":"Failure","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer {{APIKey}}"}],"body":{"mode":"raw","raw":"{\r\n \"client\": {\r\n \"email\": \"user1599@example.com\",\r\n \"country\": \"GB\",\r\n \"city\": \"Milford\",\r\n \"stateCode\": \"RJ\",\r\n \"street_address\": \"90 Fixture Close\",\r\n \"zip_code\": \"68403\",\r\n \"date_of_birth\": \"1994-31-04\",\r\n \"phone\": \"+91 9634088561\",\r\n \"full_name\": \"Reese Nakamura\"\r\n },\r\n \"purchase\": {\r\n \"currency\": \"EUR\",\r\n \"products\": [\r\n {\r\n \"name\": \"gaming cards \",\r\n \"price\": 10\r\n }\r\n ]\r\n },\r\n \"brand_id\": \"your-brand-id\",\r\n \"paymentMethod\": \"APPLEPAY-REDIRECT\",\r\n \"success_redirect\": \"https://your.success.redirect.com\",\r\n \"pending_redirect\": \"https://your.pending.redirect.com\",\r\n \"failure_redirect\": \"https://your.failure.redirect.com\",\r\n \"success_callback\": \"https://your.success.callback.com\",\r\n \"failure_callback\": \"https://your.failure.callback.com\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.paysecure.net/api/v1/purchases"},"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":"{\r\n \"message\": \"Error Message\",\r\n \"code\": \"error_code\"\r\n}"}],"_postman_id":"cbde58f0-e17a-4fab-bb65-30b81f232d53"},{"name":"Session","id":"0deb6d60-edf3-48d0-8f28-9745a87bdb52","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"https://api.paysecure.net/api/v1/createSession","description":"

OVERVIEW

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

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: PaySecure 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","urlObject":{"path":["createSession"],"host":["https://api.paysecure.net/api/v1"],"query":[],"variable":[]}},"response":[{"id":"fcda09f4-18f6-486e-b7d5-20b412491c84","name":"Success","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"*/*","type":"text"},{"key":"BrandId","value":"your-brand-id","description":"it is mandatory to pass the BrandId in header for each createSession request. ","type":"text"},{"key":"Authorization","value":"Bearer {{APIKey}}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"customerId\": \"69034a5a61b460084d20c23b\",\r\n \"merchantRef\": \"user5489@example.com\", // optional\r\n \"currency\": \"EUR\",\r\n \"products\": [\r\n {\r\n \"name\": \"Product1\",\r\n \"price\": \"10\"\r\n },\r\n {\r\n \"name\": \"Product2\",\r\n \"price\": \"12\"\r\n }\r\n ],\r\n \"totalAmount\": \"22\", // optional, but if present have precedence over sum of prices.\r\n \"paymentMethod\": \"APPLEPAY-REDIRECT\", //optional\r\n \"success_redirect\": \"https://your.success.redirect.com\",\r\n \"pending_redirect\": \"https://your.pending.redirect.com\",\r\n \"failure_redirect\": \"https://your.failure.redirect.com\",\r\n \"success_callback\": \"https://your.success.callback.com\",\r\n \"failure_callback\": \"https://your.failure.callback.com\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.paysecure.net/api/v1/createSession"},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":"{\r\n \"sessionUrl\": \"https://api.paysecure.net/payment-session/6963533a0a18ea65153a81e7/\",\r\n \"brandId\": \"your-brand-id\",\r\n \"customerId\": \"69034a5a61b460084d20c23b\",\r\n \"sessionId\": \"6963533a0a18ea65153a81e7\",\r\n \"expiryOn\": 1768117950,\r\n \"createdOn\": 1768117050\r\n}"},{"id":"5479e363-4a3c-4fc7-941f-aa620aa06527","name":"Invalid Session","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"*/*","type":"text"},{"key":"BrandId","value":"your-brand-id","description":"it is mandatory to pass the BrandId in header for each createSession request. ","type":"text"},{"key":"Authorization","value":"Bearer {{APIKey}}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"customerId\": \"69034a5a61b460084d20c23b\",\r\n \"merchantRef\": \"user5489@example.com\", // optional\r\n \"currency\": \"EUR\",\r\n \"products\": [\r\n {\r\n \"name\": \"Product1\",\r\n \"price\": \"10\"\r\n },\r\n {\r\n \"name\": \"Product2\",\r\n \"price\": \"12\"\r\n }\r\n ],\r\n \"totalAmount\": \"22\", // optional, but if present have precedence over sum of prices.\r\n \"paymentMethod\": \"APPLEPAY-REDIRECT\", //optional\r\n \"success_redirect\": \"https://your.success.redirect.com\",\r\n \"pending_redirect\": \"https://your.pending.redirect.com\",\r\n \"failure_redirect\": \"https://your.failure.redirect.com\",\r\n \"success_callback\": \"https://your.success.callback.com\",\r\n \"failure_callback\": \"https://your.failure.callback.com\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.paysecure.net/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":"0deb6d60-edf3-48d0-8f28-9745a87bdb52"},{"name":"Get Status","id":"81e88e5e-003c-467d-ace6-c134c936d18d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer {{APIKey}}","type":"text"}],"url":"https://api.paysecure.net/api/v1/purchases/{purchaseId}/","description":"

This API tells you about all the details of a purchase (PayIn), 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

Status	Notes
paid	Transaction Successful
payment_in_process	Payment is under Processing
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":"f00d3191-4475-4a08-ae4e-b2538547aa4f","id":"f00d3191-4475-4a08-ae4e-b2538547aa4f","name":"APIs","type":"folder"}},"urlObject":{"path":["purchases","{purchaseId}",""],"host":["https://api.paysecure.net/api/v1"],"query":[],"variable":[]}},"response":[{"id":"9ce5f0c5-4344-4b12-b4d4-2c0987ad3e4b","name":"Purchase - success","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer {{APIKey}}"}],"url":"https://api.paysecure.net/api/v1/purchases/{purchaseId}/"},"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":"{\r\n \"purchaseId\": \"69634df44549cbd3547ac750\",\r\n \"client\": {\r\n \"customerId\": \"NA\",\r\n \"email\": \"user1599@example.com\",\r\n \"phone\": \"+91 9634088561\",\r\n \"full_name\": \"Reese Nakamura\",\r\n \"date_of_birth\": \"1994-31-04\",\r\n \"street_address\": \"90 Fixture Close\",\r\n \"country\": \"GB\",\r\n \"city\": \"Milford\",\r\n \"zip_code\": \"68403\",\r\n \"cc\": [],\r\n \"bcc\": [],\r\n \"stateCode\": \"RJ\"\r\n },\r\n \"updated_on\": 1768115701,\r\n \"type\": \"purchase\",\r\n \"paymentMethod\": \"APPLEPAY-REDIRECT\",\r\n \"amountUnit\": \"MAJOR\",\r\n \"errorMsg\": \"\",\r\n \"errorCode\": \"NA\",\r\n \"force_recurring\": false,\r\n \"created_on\": 1768115700,\r\n \"merchantRef\": \"69634df44549cbd3547ac750\",\r\n \"purchase\": {\r\n \"currency\": \"EUR\",\r\n \"products\": [\r\n {\r\n \"name\": \"gaming cards\",\r\n \"quantity\": 1.0,\r\n \"price\": 1.0,\r\n \"discount\": 0,\r\n \"tax_percent\": \"0.00\"\r\n }\r\n ],\r\n \"total\": 1.0,\r\n \"requestAmount\": 1.0,\r\n \"language\": \"en\",\r\n \"notes\": \"\",\r\n \"debt\": 0,\r\n \"total_formatted\": 1.0,\r\n \"taxAmount\": 0.0,\r\n \"taxPercent\": 0.0,\r\n \"request_client_details\": [],\r\n \"email_message\": \"\"\r\n },\r\n \"payment\": {\r\n \"is_outgoing\": false,\r\n \"payment_type\": \"PURCHASE\",\r\n \"amount\": 1.0,\r\n \"currency\": \"EUR\",\r\n \"net_amount\": 1.0,\r\n \"fee_amount\": 0.0,\r\n \"pending_amount\": 0.0,\r\n \"pending_unfreeze_on\": null,\r\n \"description\": \"\",\r\n \"paid_on\": 1768115700,\r\n \"remote_paid_on\": 1768115700\r\n },\r\n \"issuer_details\": {\r\n \"website\": \"\",\r\n \"legal_street_address\": \"\",\r\n \"legal_country\": \"\",\r\n \"legal_city\": \"\",\r\n \"legal_zip_code\": \"\",\r\n \"bank_accounts\": [\r\n {}\r\n ],\r\n \"legal_name\": \"Testing\",\r\n \"brand_name\": \"Testing\",\r\n \"registration_number\": \"\",\r\n \"tax_number\": \"\"\r\n },\r\n \"transaction_data\": {\r\n \"payment_method\": \"\",\r\n \"flow\": \"payform\",\r\n \"extra\": {\r\n \"amount\": 1.0,\r\n \"masked_pan\": \"APPLEPAY-REDIRECT\"\r\n },\r\n \"country\": \"\",\r\n \"attempts\": [\r\n {\r\n \"client_ip\": \"203.0.113.224\",\r\n \"type\": \"execute\",\r\n \"payment_method\": \"APPLEPAY-REDIRECT\",\r\n \"flow\": \"payform\",\r\n \"successful\": true,\r\n \"country\": \"APPLEPAY-REDIRECT\",\r\n \"processing_time\": 1768115700,\r\n \"extra\": {\r\n \"amount\": 1.0,\r\n \"masked_pan\": \"APPLEPAY-REDIRECT\"\r\n }\r\n }\r\n ]\r\n },\r\n \"status\": \"PAID\",\r\n \"status_history\": [\r\n {\r\n \"status\": \"created\",\r\n \"timestamp\": 1768115700\r\n },\r\n {\r\n \"status\": \"pending_execute\",\r\n \"timestamp\": 1768115700\r\n },\r\n {\r\n \"status\": \"payment_in_process\",\r\n \"timestamp\": 1768115701\r\n },\r\n {\r\n \"status\": \"paid\",\r\n \"timestamp\": 1768115701\r\n }\r\n ],\r\n \"is_test\": false,\r\n \"brand_id\": \"your-brand-id\",\r\n \"send_receipt\": false,\r\n \"is_recurring_token\": false,\r\n \"skip_capture\": false,\r\n \"reference_generated\": \"PS363\",\r\n \"issued\": \"2026-01-11\",\r\n \"due\": 1768115700,\r\n \"refund_upto\": 1783664101,\r\n \"cc_descriptor\": \"\",\r\n \"fraudScore\": \"0\",\r\n \"trustScore\": \"1\",\r\n \"extraFee\": \"0\",\r\n \"pix_payload\": {},\r\n \"payInDetails\": {},\r\n \"paidOn\": 0,\r\n \"receivedAmt\": 0.0,\r\n \"taxAmount\": 0.0,\r\n \"surcharge\": 0.0,\r\n \"surchargeType\": \"\",\r\n \"sessionId\": \"\",\r\n \"refund_availability\": \"NONE\",\r\n \"refundable_amount\": 1.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 \"platform\": \"API\",\r\n \"created_from_ip\": \"203.0.113.224\",\r\n \"checkout_url\": \"https://api.paysecure.net/payments/deb852445bd4b0fa6c4587f652174ab9/\",\r\n \"payoutProcess\": false\r\n}"},{"id":"976f7cd0-0c04-4dfd-ba2b-58a4a0c852c4","name":"Purchase - failure","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer {{APIKey}}","type":"text"}],"url":"https://api.paysecure.net/api/v1/purchases/{purchaseId}/"},"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":"{\r\n \"message\": \"Error Message\",\r\n \"code\": \"error_code\"\r\n}"}],"_postman_id":"81e88e5e-003c-467d-ace6-c134c936d18d"}],"id":"f00d3191-4475-4a08-ae4e-b2538547aa4f","description":"

API Flow

The merchant initiates the purchase via the create purchase API and passing the appropriate payment method. If successful, they receive a checkout URL in the response JSON.
\n
Upon utilizing the checkout URL, the user will be presented with a screen where he will be shown a button to pay via Applepay.
\n
After clicking the button, the user will see all the cards stored in the Apple wallet and he can choose one of the cards to make the purchase.
\n
After a successful or failed payment by the end user, an appropriate webhook would be sent to the merchant. The user would also be redirected to the appropriate redirect URL.
\n

Overview

ACH Payout allows merchants to create a payout request by providing customer and beneficiary bank details. After successful request creation, the API returns a payoutId and a checkout_url for payout processing.

\n\n

This is an asynchronous operation. The create response confirms only that the payout request was accepted — the final result arrives via webhook (or by polling Get Status) once the ACH transfer completes.

PayOut Flow

The merchant sends a payout request to the Payout API along with customer and beneficiary bank details.
\n
The Payout API validates the request and creates a payout.
\n
The API returns the payoutId and checkout_url in the response.
\n
The payout is created with the initial status created.
\n
Processing starts and the status changes to payout_in_process.
\n
Once the payout is successfully completed, the status changes to paid.
\n
The merchant receives the final payout status through the configured callback (webhook) and redirect URLs.
\n

Payout Statuses

\n\n\n\n\n\n\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	Terminal?
`created`	Payout request created and validated	❌
`payout_in_process`	Transfer submitted to the ACH network	❌
`paid`	Funds successfully credited to the beneficiary	✅
`error`	Payout failed or was rejected	✅

In API responses and webhooks the top-level status is uppercase (e.g. PAID); entries in status_history are lowercase.

If Payout Manual Review is enabled on your account, a payout can be held for approval before processing (pendingReview = Yes) — see the Payout Manual Review section of these docs.

Webhook

Once the payout reaches a terminal status, Paysecure sends a server-to-server POST to your configured callback URL. The payload carries the full payout object under payload, with the outer status in lowercase. Verify the signature using your Public Key as described in the 🔌 Webhooks section.

Webhook sample — paid

{\n  \"payload\": {\n    \"payoutId\": \"6a158153a62bcd7745c51746\",\n    \"client\": {\n      \"customerId\": \"NA\",\n      \"email\": \"user5772@example.com\",\n      \"phone\": \"+1 2025550123\",\n      \"full_name\": \"test test\",\n      \"date_of_birth\": \"1994-07-10\",\n      \"street_address\": \"1 Example Street\",\n      \"country\": \"US\",\n      \"city\": \"Brookfield\",\n      \"zip_code\": \"10001\",\n      \"stateCode\": \"NY\"\n    },\n    \"updated_on\": 1783690301,\n    \"payoutMethod\": \"PAYOUT-ACH\",\n    \"beneficiaryDetail\": {\n      \"bankAccountName\": \"test test\",\n      \"bankName\": \"JPMorgan Chase\",\n      \"bankAccountNumber\": \"1234567890120000\"\n    },\n    \"amountUnit\": \"MAJOR\",\n    \"amount\": 5,\n    \"errorMsg\": \"Transaction succeeded-APPROVED\",\n    \"is_test\": false,\n    \"purpose\": \"test payout\",\n    \"created_on\": 1783690051,\n    \"merchantRef\": \"6a158153a62bcd7745c51746\",\n    \"merchantName\": \"Testing\",\n    \"status\": \"PAID\",\n    \"status_history\": [\n      {\n        \"status\": \"created\",\n        \"timestamp\": 1783690051\n      },\n      {\n        \"status\": \"payout_in_process\",\n        \"timestamp\": 1783690071\n      },\n      {\n        \"status\": \"paid\",\n        \"timestamp\": 1783690301\n      }\n    ],\n    \"currency\": \"USD\",\n    \"fx_Currency\": \"USD\",\n    \"fx_Amount\": \"5.0\",\n    \"transFees\": \"-1.0\",\n    \"extraFee\": \"0\",\n    \"paymentOn\": 1783690301,\n    \"payOutDetails\": {},\n    \"checkout_url\": \"https://api.paysecure.net/payout/6a158153a62bcd7745c51746/\",\n    \"taxAmount\": 0,\n    \"taxPercent\": 0,\n    \"success_redirect\": \"https://your.success.redirect.com\",\n    \"failure_redirect\": \"https://your.failure.redirect.com\",\n    \"pending_redirect\": \"https://your.pending.redirect.com\",\n    \"redirectType\": \"POST\",\n    \"pendingReview\": \"No\",\n    \"sessionId\": \"\",\n    \"extraParam\": {\n      \"productType\": \"Compensation\",\n      \"ssn\": \"1234\",\n      \"ach_type\": \"same_day\"\n    },\n    \"surcharge\": 0,\n    \"surchargeType\": \"\",\n    \"trxMethod\": \"ACH\",\n    \"success_callback\": \"https://your.success.callback.com\",\n    \"failure_callback\": \"https://your.failure.callback.com\",\n    \"utc_offset\": \"-330\",\n    \"mdr\": \"0.00\"\n  },\n  \"status\": \"paid\"\n}\n\n

To create an ACH payout, call /payout/ with the customer details, beneficiary bank details, amount and currency in the request body.

You are required to provide the API key in the header — it can be located in the Dashboard section of your merchant account login.

The response returns a payoutId (store it — it identifies the payout in all subsequent operations) and a checkout_url. The final result arrives asynchronously via webhook or the Get Status API.

Request Body Parameters

Parameter	Notes
client.full_name	Mandatory. Customer name.
client.email	Mandatory. Customer email address.
client.country	Mandatory. ISO 3166-1 alpha-2 country code — `US` for ACH.
client.stateCode	Mandatory. Customer state code (e.g. `NY`).
client.city	Mandatory. Customer city.
client.phone	Mandatory. Customer phone number.
client.date_of_birth	Mandatory. Customer date of birth in YYYY-MM-DD format.
client.street_address	Optional. Customer street address.
client.zip_code	Optional. Customer ZIP code.
beneficiaryDetail.bankAccountNumber	Mandatory. Beneficiary account number.
beneficiaryDetail.bankAccountName	Optional. But recommended — beneficiary account holder name.
beneficiaryDetail.routingNumber	Mandatory . 9-digit ABA routing number of the beneficiary bank (e.g. `021000021`).
beneficiaryDetail.bankName	Optional. Beneficiary bank name.
purpose	Optional. Purpose of the payout.
currency	Mandatory. ISO 4217 code. Supported value: `USD`.
amount	Mandatory. Payout amount in decimal format up to 2 decimals (e.g. `5.00`).
extraParam.last4_ssn	Conditional. Customer last 4 SSN digits as required for compliance.
extraParam.ach_type	Optional. ACH processing type, e.g. `same_day`.
merchantRef	Optional. Strongly recommended — prevents duplicate payouts and lets you retrieve the payout if the response times out.
success_redirect	Mandatory. URL for successful completion.
pending_redirect	Mandatory. URL while the payout is in progress.
failure_redirect	Mandatory. URL if the payout fails.
success_callback	Optional. Merchant webhook endpoint for success notifications.
failure_callback	Optional. Merchant webhook endpoint for failure notifications.

Response

The success response echoes the full payout object with status = CREATED. Key fields: payoutId, checkout_url, fx_Currency/fx_Amount (FX details), transFees (transaction fee), and pendingReview (whether the payout is held for manual review).

\n","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"788af4c0-5e08-438e-b767-55e372ed6500","id":"788af4c0-5e08-438e-b767-55e372ed6500","name":"🇺🇸 ACH Payout","type":"folder"}},"urlObject":{"path":["payout"],"host":["https://api.paysecure.net/api/v1"],"query":[],"variable":[]}},"response":[{"id":"577bda93-17f4-4849-a8fc-bdea7715fd6a","name":"Create PayOut - Success (Created)","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer {{APIKey}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"client\": {\n \"email\": \"user5772@example.com\",\n \"phone\": \"+1 2025550123\",\n \"full_name\": \"test test\",\n \"zip_code\": \"10001\",\n \"street_address\": \"1 Example Street\",\n \"city\": \"Brookfield\",\n \"stateCode\": \"NY\",\n \"country\": \"US\",\n \"date_of_birth\": \"1994-07-10\"\n },\n \"beneficiaryDetail\": {\n \"bankAccountName\": \"test test\",\n \"bankAccountNumber\": \"1234567890120000\",\n \"routingNumber\": \"021000021\",\n \"bankName\": \"JPMorgan Chase\"\n },\n \"purpose\": \"test payout\",\n \"currency\": \"USD\",\n \"amount\": 5.0,\n \"merchantRef\": \"test_ach_001\",\n \"extraParam\": {\n \"last4_ssn\": \"1234\",\n \"ach_type\": \"same_day\"\n },\n \"success_redirect\": \"https://your.success.redirect.com\",\n \"failure_redirect\": \"https://your.failure.redirect.com\",\n \"pending_redirect\": \"https://your.pending.redirect.com\",\n \"success_callback\": \"https://your.success.callback.com\",\n \"failure_callback\": \"https://your.failure.callback.com\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.paysecure.net/api/v1/payout"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"payoutId\": \"6a158153a62bcd7745c51746\",\n \"client\": {\n \"customerId\": \"NA\",\n \"email\": \"user5772@example.com\",\n \"phone\": \"+1 2025550123\",\n \"full_name\": \"test test\",\n \"date_of_birth\": \"1994-07-10\",\n \"street_address\": \"1 Example Street\",\n \"country\": \"US\",\n \"city\": \"Brookfield\",\n \"zip_code\": \"10001\",\n \"stateCode\": \"NY\"\n },\n \"updated_on\": 1783690301,\n \"payoutMethod\": \"PAYOUT-ACH\",\n \"beneficiaryDetail\": {\n \"bankAccountName\": \"test test\",\n \"bankName\": \"JPMorgan Chase\",\n \"bankAccountNumber\": \"1234567890120000\"\n },\n \"amountUnit\": \"MAJOR\",\n \"amount\": 5,\n \"errorMsg\": \"NA\",\n \"is_test\": false,\n \"purpose\": \"test payout\",\n \"created_on\": 1783690051,\n \"merchantRef\": \"6a158153a62bcd7745c51746\",\n \"merchantName\": \"Testing\",\n \"status\": \"CREATED\",\n \"status_history\": [\n {\n \"status\": \"created\",\n \"timestamp\": 1783690051\n }\n ],\n \"currency\": \"USD\",\n \"fx_Currency\": \"USD\",\n \"fx_Amount\": \"5.0\",\n \"transFees\": \"-1.0\",\n \"extraFee\": \"0\",\n \"paymentOn\": 0,\n \"payOutDetails\": {},\n \"checkout_url\": \"https://api.paysecure.net/payout/6a158153a62bcd7745c51746/\",\n \"taxAmount\": 0,\n \"taxPercent\": 0,\n \"success_redirect\": \"https://your.success.redirect.com\",\n \"failure_redirect\": \"https://your.failure.redirect.com\",\n \"pending_redirect\": \"https://your.pending.redirect.com\",\n \"redirectType\": \"POST\",\n \"pendingReview\": \"No\",\n \"sessionId\": \"\",\n \"extraParam\": {\n \"productType\": \"Compensation\",\n \"ssn\": \"1234\",\n \"ach_type\": \"same_day\"\n },\n \"surcharge\": 0,\n \"surchargeType\": \"\",\n \"trxMethod\": \"ACH\",\n \"success_callback\": \"https://your.success.callback.com\",\n \"failure_callback\": \"https://your.failure.callback.com\",\n \"utc_offset\": \"-330\",\n \"mdr\": \"0.00\"\n}"},{"id":"3fdf7baa-d0d9-4f55-9c2f-92ae74244ee6","name":"Create PayOut - Error (Processing exception)","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer {{APIKey}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"client\": {\n \"email\": \"user5772@example.com\",\n \"phone\": \"+1 2025550123\",\n \"full_name\": \"test test\",\n \"zip_code\": \"10001\",\n \"street_address\": \"1 Example Street\",\n \"city\": \"Brookfield\",\n \"stateCode\": \"NY\",\n \"country\": \"US\",\n \"date_of_birth\": \"1994-07-10\"\n },\n \"beneficiaryDetail\": {\n \"bankAccountName\": \"test test\",\n \"bankAccountNumber\": \"1234567890120000\",\n \"routingNumber\": \"021000021\",\n \"bankName\": \"JPMorgan Chase\"\n },\n \"purpose\": \"test payout\",\n \"currency\": \"USD\",\n \"amount\": 5.0,\n \"merchantRef\": \"test_ach_001\",\n \"extraParam\": {\n \"last4_ssn\": \"1234\",\n \"ach_type\": \"same_day\"\n },\n \"success_redirect\": \"https://your.success.redirect.com\",\n \"failure_redirect\": \"https://your.failure.redirect.com\",\n \"pending_redirect\": \"https://your.pending.redirect.com\",\n \"success_callback\": \"https://your.success.callback.com\",\n \"failure_callback\": \"https://your.failure.callback.com\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.paysecure.net/api/v1/payout"},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"something went wrong\",\n \"code\": \"exception\",\n \"status\": \"error\"\n}"},{"id":"d3e3c09b-28c9-4879-8ae9-7282f6863d68","name":"Create PayOut - Error (Validation)","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer {{APIKey}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"client\": {\n \"email\": \"user5772@example.com\",\n \"phone\": \"+1 2025550123\",\n \"full_name\": \"test test\",\n \"zip_code\": \"10001\",\n \"street_address\": \"1 Example Street\",\n \"city\": \"Brookfield\",\n \"stateCode\": \"NY\",\n \"country\": \"US\",\n \"date_of_birth\": \"1994-07-10\"\n },\n \"beneficiaryDetail\": {\n \"bankAccountName\": \"test test\",\n \"bankAccountNumber\": \"1234567890120000\",\n \"routingNumber\": \"021000021\",\n \"bankName\": \"JPMorgan Chase\"\n },\n \"purpose\": \"test payout\",\n \"currency\": \"USD\",\n \"amount\": 5.0,\n \"merchantRef\": \"test_ach_001\",\n \"extraParam\": {\n \"last4_ssn\": \"1234\",\n \"ach_type\": \"same_day\"\n },\n \"success_redirect\": \"https://your.success.redirect.com\",\n \"failure_redirect\": \"https://your.failure.redirect.com\",\n \"pending_redirect\": \"https://your.pending.redirect.com\",\n \"success_callback\": \"https://your.success.callback.com\",\n \"failure_callback\": \"https://your.failure.callback.com\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.paysecure.net/api/v1/payout"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Brand not found!\",\n \"code\": \"transaction_error\"\n}"}],"_postman_id":"70f9d755-14ae-4544-b952-e4569e7883c8"},{"name":"Get Status","id":"d00cd95a-ef04-4785-b35f-f2e74a79a88c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{APIKey}}","type":"text"}],"url":"https://api.paysecure.net/api/v1/getpayout/{payoutId}","description":"

Poll the current state of a payout using the payoutId returned when the payout was created. This is the fallback to webhooks.

Possible Payout Statuses

\n\n\n\n\n\n\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	Terminal?
`created`	Payout request created	❌
`payout_in_process`	Transfer submitted to the ACH network	❌
`paid`	Funds credited to the beneficiary	✅
`error`	Payout failed or was rejected	✅

","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"788af4c0-5e08-438e-b767-55e372ed6500","id":"788af4c0-5e08-438e-b767-55e372ed6500","name":"🇺🇸 ACH Payout","type":"folder"}},"urlObject":{"path":["getpayout","{payoutId}"],"host":["https://api.paysecure.net/api/v1"],"query":[],"variable":[]}},"response":[{"id":"cf6b8997-3123-4137-8399-f248ecbe9dce","name":"Get Status - Paid","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{APIKey}}","type":"text"}],"url":"https://api.paysecure.net/api/v1/getpayout/{payoutId}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"payoutId\": \"6a158153a62bcd7745c51746\",\n \"client\": {\n \"customerId\": \"NA\",\n \"email\": \"user5772@example.com\",\n \"phone\": \"+1 2025550123\",\n \"full_name\": \"test test\",\n \"date_of_birth\": \"1994-07-10\",\n \"street_address\": \"1 Example Street\",\n \"country\": \"US\",\n \"city\": \"Brookfield\",\n \"zip_code\": \"10001\",\n \"stateCode\": \"NY\"\n },\n \"updated_on\": 1783690301,\n \"payoutMethod\": \"PAYOUT-ACH\",\n \"beneficiaryDetail\": {\n \"bankAccountName\": \"test test\",\n \"bankName\": \"JPMorgan Chase\",\n \"bankAccountNumber\": \"1234567890120000\"\n },\n \"amountUnit\": \"MAJOR\",\n \"amount\": 5,\n \"errorMsg\": \"Transaction succeeded-APPROVED\",\n \"is_test\": false,\n \"purpose\": \"test payout\",\n \"created_on\": 1783690051,\n \"merchantRef\": \"6a158153a62bcd7745c51746\",\n \"merchantName\": \"Testing\",\n \"status\": \"PAID\",\n \"status_history\": [\n {\n \"status\": \"created\",\n \"timestamp\": 1783690051\n },\n {\n \"status\": \"payout_in_process\",\n \"timestamp\": 1783690071\n },\n {\n \"status\": \"paid\",\n \"timestamp\": 1783690301\n }\n ],\n \"currency\": \"USD\",\n \"fx_Currency\": \"USD\",\n \"fx_Amount\": \"5.0\",\n \"transFees\": \"-1.0\",\n \"extraFee\": \"0\",\n \"paymentOn\": 1783690301,\n \"payOutDetails\": {},\n \"checkout_url\": \"https://api.paysecure.net/payout/6a158153a62bcd7745c51746/\",\n \"taxAmount\": 0,\n \"taxPercent\": 0,\n \"success_redirect\": \"https://your.success.redirect.com\",\n \"failure_redirect\": \"https://your.failure.redirect.com\",\n \"pending_redirect\": \"https://your.pending.redirect.com\",\n \"redirectType\": \"POST\",\n \"pendingReview\": \"No\",\n \"sessionId\": \"\",\n \"extraParam\": {\n \"productType\": \"Compensation\",\n \"ssn\": \"1234\",\n \"ach_type\": \"same_day\"\n },\n \"surcharge\": 0,\n \"surchargeType\": \"\",\n \"trxMethod\": \"ACH\",\n \"success_callback\": \"https://your.success.callback.com\",\n \"failure_callback\": \"https://your.failure.callback.com\",\n \"utc_offset\": \"-330\",\n \"mdr\": \"0.00\"\n}"},{"id":"af4c31fd-b6c3-44fa-82f7-6c5447c72abe","name":"Get Status - Error (Payout not found)","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{APIKey}}","type":"text"}],"url":"https://api.paysecure.net/api/v1/getpayout/{payoutId}"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Payout not found!\",\n \"code\": \"transaction_error\"\n}"}],"_postman_id":"d00cd95a-ef04-4785-b35f-f2e74a79a88c"}],"id":"ba1671ff-0cf1-4a2c-b8a5-34dcde093736","description":"

Create an ACH payout and track it to a terminal status.

\n","_postman_id":"ba1671ff-0cf1-4a2c-b8a5-34dcde093736","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"788af4c0-5e08-438e-b767-55e372ed6500","id":"788af4c0-5e08-438e-b767-55e372ed6500","name":"🇺🇸 ACH Payout","type":"folder"}}}],"id":"788af4c0-5e08-438e-b767-55e372ed6500","description":"

ACH Payout lets you send funds to a customer's US bank account over the ACH network. You create a payout with the customer's and beneficiary's bank details; Paysecure validates the request, processes the transfer, and notifies you by webhook when it completes.

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

Property	Details
Payment type	Bank transfer payout (ACH, push)
Countries	🇺🇸 United States
Processing currency	`USD`
PayIn	❌ (payout only — see Bank Transfers / other methods for pay-ins)
PayOut	✅
Processing speed	`ach_type`: `same_day` or standard ACH windows
Chargebacks	❌ Not applicable — merchant-initiated credit
Status confirmation	Asynchronous — webhook on terminal status; Get Status API for polling
Manual review	Payouts may be held for review (`pendingReview`) if enabled on your account — see Payout Manual Review
Transaction limits	As configured for your merchant account

Overview

Skrill is a wallet-based payment method that allows customers to complete payments using their Skrill account balance. The merchant initiates a purchase using the Purchase API; Paysecure returns a unique purchaseId and a checkout_url used to redirect the customer to the Skrill payment page.

\n\n

On the Skrill payment page, the customer can authenticate and pay using either of:

Logging in to their Skrill account with email address and password.
\n
Scanning the QR code displayed on the payment page and completing the payment in the Skrill mobile application.
\n

After successful authentication, Skrill processes the payment and communicates the result to Paysecure. Paysecure then sends a webhook notification to the merchant with the transaction status, and the customer is redirected to the configured redirect URL.

Rely on the webhook (server-to-server callback) for the final transaction status. Redirect URLs are for customer experience only.

Prerequisites

Merchant account configured in Paysecure, with valid API credentials and a valid brand_id.
\n
Redirect URLs and callback URLs configured.
\n
Customer details collected before initiating the payment.
\n
The customer has an active Skrill wallet with sufficient balance.
\n
The customer must authenticate at Skrill with the same email address passed in the Purchase API (client.email).
\n

PayIn Flow

Create Purchase — the merchant creates a purchase using the Purchase API with paymentMethod = SKRILL.
\n
Receive Checkout URL — the response returns a checkout_url.
\n
Redirect Customer — the customer is redirected to the checkout URL.
\n
Skrill Authentication — the customer scans the QR code with the Skrill app, or logs in with email and password.
\n
Payment Authorization — Skrill validates the wallet credentials and checks the wallet balance.
\n
Payment Completion — if sufficient balance is available, the payment is completed.
\n
Merchant Notification — the merchant receives the webhook notification and the customer is redirected.
\n

Checkout Experience

After redirection, the customer is presented with the Skrill payment page. This scanner appears on opening the checkout URL:

\n\n

Choosing \"continue in browser\" shows the login screen:

\n\n

Error Handling

\n\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	Description
Transaction Failed	Payment could not be completed.
transaction_error	Transaction processing failed.
Authentication Failed	Customer authentication at Skrill failed.
Insufficient Balance	Wallet balance is insufficient.

When a payment fails, the purchase moves to error (shown as payment_failed in status_history) and the attempt carries an error object — see the webhook sample below.

Webhook

When the transaction status changes, Paysecure sends a server-to-server POST to your configured callback URL with the full purchase object. Verify the signature using your Public Key as described in the 🔌 Webhooks section.

Webhook sample — failed payment

{\n  \"message\": {\n    \"purchaseId\": \"6a3a7edaccf6ad8dcb121f26\",\n    \"client\": {\n      \"customerId\": \"NA\",\n      \"email\": \"user5772@example.com\",\n      \"phone\": \"+44 07000000000\",\n      \"full_name\": \"test test\",\n      \"date_of_birth\": \"1994-07-10\",\n      \"street_address\": \"1 Example Street\",\n      \"country\": \"GB\",\n      \"city\": \"Milford\",\n      \"zip_code\": \"234567\",\n      \"cc\": [],\n      \"bcc\": [],\n      \"stateCode\": \"LO\"\n    },\n    \"updated_on\": 1783690167,\n    \"type\": \"purchase\",\n    \"paymentMethod\": \"SKRILL\",\n    \"amountUnit\": \"MAJOR\",\n    \"errorMsg\": \"Transaction Failed\",\n    \"errorCode\": \"NA\",\n    \"force_recurring\": false,\n    \"created_on\": 1783690051,\n    \"merchantRef\": \"6a3a7edaccf6ad8dcb121f26\",\n    \"purchase\": {\n      \"currency\": \"EUR\",\n      \"products\": [\n        {\n          \"name\": \"e-commerce\",\n          \"quantity\": 1,\n          \"price\": 11.5,\n          \"discount\": 0,\n          \"tax_percent\": \"0.00\"\n        }\n      ],\n      \"total\": 11.5,\n      \"requestAmount\": 11.5,\n      \"language\": \"en\",\n      \"notes\": \"\",\n      \"debt\": 0,\n      \"total_formatted\": 1,\n      \"taxAmount\": 0,\n      \"taxPercent\": 0,\n      \"request_client_details\": [],\n      \"email_message\": \"\"\n    },\n    \"payment\": {\n      \"is_outgoing\": false,\n      \"payment_type\": \"PURCHASE\",\n      \"amount\": 11.5,\n      \"currency\": \"EUR\",\n      \"net_amount\": 11.5,\n      \"fee_amount\": 0,\n      \"pending_amount\": 0,\n      \"pending_unfreeze_on\": null,\n      \"description\": \"\",\n      \"paid_on\": 1783690059,\n      \"remote_paid_on\": 1783690059\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        \"amount\": 11.5,\n        \"masked_pan\": \"SKRILL\"\n      },\n      \"country\": \"\",\n      \"attempts\": [\n        {\n          \"client_ip\": \"203.0.113.81\",\n          \"type\": \"execute\",\n          \"payment_method\": \"SKRILL\",\n          \"flow\": \"payform\",\n          \"successful\": false,\n          \"country\": \"SKRILL\",\n          \"processing_time\": 1783690067,\n          \"extra\": {\n            \"amount\": 11.5,\n            \"masked_pan\": \"SKRILL\"\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\": 1783690051\n      },\n      {\n        \"status\": \"pending_execute\",\n        \"timestamp\": 1783690059\n      },\n      {\n        \"status\": \"payment_in_process\",\n        \"timestamp\": 1783690065\n      },\n      {\n        \"status\": \"payment_failed\",\n        \"timestamp\": 1783690167\n      }\n    ],\n    \"is_test\": false,\n    \"brand_id\": \"your-brand-id\",\n    \"send_receipt\": false,\n    \"is_recurring_token\": false,\n    \"skip_capture\": false,\n    \"reference_generated\": \"PS5858\",\n    \"issued\": \"2026-07-10\",\n    \"due\": 1783690051,\n    \"refund_upto\": 0,\n    \"cc_descriptor\": \"\",\n    \"fraudScore\": \"NA\",\n    \"trustScore\": \"NA\",\n    \"extraFee\": \"0\",\n    \"totalRefunded\": 0,\n    \"pix_payload\": {},\n    \"payInDetails\": {},\n    \"paidOn\": 0,\n    \"receivedAmt\": 0,\n    \"taxAmount\": 0,\n    \"surcharge\": 0,\n    \"surchargeType\": \"\",\n    \"sessionId\": \"\",\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    \"pending_redirect\": \"https://your.pending.redirect.com\",\n    \"cancel_redirect\": \"\",\n    \"success_callback\": \"https://your.success.callback.com\",\n    \"failure_callback\": \"https://your.failure.callback.com\",\n    \"platform\": \"API\",\n    \"created_from_ip\": \"203.0.113.81\",\n    \"checkout_url\": \"https://api.paysecure.net/payments/6a3a7edaccf6ad8dcb121f26/\",\n    \"payoutProcess\": false\n  },\n  \"status\": \"error\"\n}\n\n

A successful payment sends the same envelope with status = PAID and a paid entry in status_history.

\n","_postman_id":"16bc1ad5-8b27-4782-bf54-a4678903d02d","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"05acc050-4695-4934-833c-8a15284ec129","id":"05acc050-4695-4934-833c-8a15284ec129","name":"🌎 Skrill","type":"folder"}}},{"name":"PayIn API","item":[{"name":"Purchases","id":"713f14cf-a08b-4a5e-91fc-073470a5714e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer {{APIKey}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"client\": {\n \"email\": \"user5772@example.com\",\n \"full_name\": \"test test\",\n \"country\": \"GB\",\n \"city\": \"Milford\",\n \"stateCode\": \"LO\",\n \"street_address\": \"1 Example Street\",\n \"zip_code\": \"234567\",\n \"date_of_birth\": \"1994-07-10\",\n \"phone\": \"+44 07000000000\"\n },\n \"purchase\": {\n \"currency\": \"EUR\",\n \"products\": [\n {\n \"name\": \"e-commerce\",\n \"price\": 11.5\n }\n ]\n },\n \"paymentMethod\": \"SKRILL\",\n \"merchantRef\": \"test_skrill_001\",\n \"brand_id\": \"your-brand-id\",\n \"success_redirect\": \"https://your.success.redirect.com\",\n \"pending_redirect\": \"https://your.pending.redirect.com\",\n \"failure_redirect\": \"https://your.failure.redirect.com\",\n \"success_callback\": \"https://your.success.callback.com\",\n \"failure_callback\": \"https://your.failure.callback.com\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.paysecure.net/api/v1/purchases","description":"

To initiate a Skrill 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 response returns a checkout_url — redirect your customer there to authenticate with Skrill and complete the payment. The response does not confirm payment; the final status arrives via webhook or by polling Get Status.

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

Parameter	Notes
client.email	Mandatory. Customer email address. Must match the customer's Skrill wallet email at login.
client.street_address	Mandatory. Customer street address.
client.city	Mandatory. Customer city.
client.zip_code	Mandatory. Customer postal code.
client.country	Mandatory. ISO 3166-1 alpha-2 country code in uppercase.
client.full_name	Optional. But recommended — customer full name, at least 2 words.
client.phone	Optional. Customer phone number.
client.stateCode	Optional. State code in uppercase format.
client.date_of_birth	Optional. Customer date of birth in YYYY-MM-DD format.
purchase.currency	Mandatory. ISO 4217 currency code (e.g. `EUR`).
purchase.products.name	Mandatory. Product or service name.
purchase.products.price	Mandatory. Price in decimal format up to 2 decimals. Example: EUR 11 and 50 cents → `11.50`.
purchase.expireInMin	Optional. Checkout expiration time in minutes.
paymentMethod	Conditional. Mandatory if you are not using Paysecure Cashier. Value: `SKRILL`.
brand_id	Mandatory. Obtain from the Dashboard section of your merchant account login.
merchantRef	Optional. Strongly recommended — see Essential Optional Parameters below.
success_redirect	Mandatory. URL to send the customer to if the transaction is successful.
pending_redirect	Mandatory. URL to send the customer to while the payment is pending.
failure_redirect	Mandatory. URL to send the customer to if the transaction has failed.
success_callback	Optional. Merchant webhook endpoint for successful payment notifications.
failure_callback	Optional. Merchant webhook endpoint for failed payment notifications.

Essential Optional Parameters

merchantRef

The merchantRef parameter, although not mandatory, is strongly advised. Its inclusion offers two significant advantages:

Prevention of Duplicate Requests: if a second purchase request is made using the same merchantRef, the system recognises it and prevents duplicate transactions.
\n
Facilitation of Transaction Retrieval: if the response times out or the purchaseId isn't received, the merchantRef allows you to retrieve the transaction details.
\n

Response

The success response echoes the full purchase object. The fields that drive your next step are purchaseId (store it) and checkout_url (redirect the customer to it). status is CREATED at this point; the final result arrives by webhook.

\n","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"8a32d5db-7f4e-4c7b-858c-aad14fd0480d","id":"8a32d5db-7f4e-4c7b-858c-aad14fd0480d","name":"PayIn API","type":"folder"}},"urlObject":{"path":["purchases"],"host":["https://api.paysecure.net/api/v1"],"query":[],"variable":[]}},"response":[{"id":"54077081-169e-4f31-b543-b9367dbc677b","name":"Purchase - Success (Created)","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer {{APIKey}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"client\": {\n \"email\": \"user5772@example.com\",\n \"full_name\": \"test test\",\n \"country\": \"GB\",\n \"city\": \"Milford\",\n \"stateCode\": \"LO\",\n \"street_address\": \"1 Example Street\",\n \"zip_code\": \"234567\",\n \"date_of_birth\": \"1994-07-10\",\n \"phone\": \"+44 07000000000\"\n },\n \"purchase\": {\n \"currency\": \"EUR\",\n \"products\": [\n {\n \"name\": \"e-commerce\",\n \"price\": 11.5\n }\n ]\n },\n \"paymentMethod\": \"SKRILL\",\n \"merchantRef\": \"test_skrill_001\",\n \"brand_id\": \"your-brand-id\",\n \"success_redirect\": \"https://your.success.redirect.com\",\n \"pending_redirect\": \"https://your.pending.redirect.com\",\n \"failure_redirect\": \"https://your.failure.redirect.com\",\n \"success_callback\": \"https://your.success.callback.com\",\n \"failure_callback\": \"https://your.failure.callback.com\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.paysecure.net/api/v1/purchases"},"status":"Accepted","code":202,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"purchaseId\": \"6a44fd1061ad9b6b462f5df9\",\n \"client\": {\n \"customerId\": \"NA\",\n \"email\": \"user5772@example.com\",\n \"phone\": \"+44 07000000000\",\n \"full_name\": \"test test\",\n \"date_of_birth\": \"1994-07-10\",\n \"street_address\": \"1 Example Street\",\n \"country\": \"GB\",\n \"city\": \"Milford\",\n \"zip_code\": \"234567\",\n \"cc\": [],\n \"bcc\": [],\n \"stateCode\": \"LO\"\n },\n \"updated_on\": 1783690167,\n \"type\": \"purchase\",\n \"paymentMethod\": \"SKRILL\",\n \"amountUnit\": \"MAJOR\",\n \"errorMsg\": \"\",\n \"errorCode\": \"NA\",\n \"force_recurring\": false,\n \"created_on\": 1783690051,\n \"merchantRef\": \"6a44fd1061ad9b6b462f5df9\",\n \"purchase\": {\n \"currency\": \"EUR\",\n \"products\": [\n {\n \"name\": \"e-commerce\",\n \"quantity\": 1,\n \"price\": 11.5,\n \"discount\": 0,\n \"tax_percent\": \"0.00\"\n }\n ],\n \"total\": 11.5,\n \"requestAmount\": 11.5,\n \"language\": \"en\",\n \"notes\": \"\",\n \"debt\": 0,\n \"total_formatted\": 1,\n \"taxAmount\": 0,\n \"taxPercent\": 0,\n \"request_client_details\": [],\n \"email_message\": \"\"\n },\n \"payment\": {\n \"is_outgoing\": false,\n \"payment_type\": \"PURCHASE\",\n \"amount\": 11.5,\n \"currency\": \"EUR\",\n \"net_amount\": 11.5,\n \"fee_amount\": 0,\n \"pending_amount\": 0,\n \"pending_unfreeze_on\": null,\n \"description\": \"\",\n \"paid_on\": null,\n \"remote_paid_on\": null\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\": \"CREATED\",\n \"status_history\": [\n {\n \"status\": \"created\",\n \"timestamp\": 1783690051\n }\n ],\n \"is_test\": false,\n \"brand_id\": \"your-brand-id\",\n \"send_receipt\": false,\n \"is_recurring_token\": false,\n \"skip_capture\": false,\n \"reference_generated\": \"PS5858\",\n \"issued\": \"2026-07-10\",\n \"due\": 1783690051,\n \"refund_upto\": 0,\n \"cc_descriptor\": \"\",\n \"fraudScore\": \"NA\",\n \"trustScore\": \"NA\",\n \"extraFee\": \"0\",\n \"totalRefunded\": 0,\n \"pix_payload\": {},\n \"payInDetails\": {},\n \"paidOn\": 0,\n \"receivedAmt\": 0,\n \"taxAmount\": 0,\n \"surcharge\": 0,\n \"surchargeType\": \"\",\n \"sessionId\": \"\",\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 \"pending_redirect\": \"https://your.pending.redirect.com\",\n \"cancel_redirect\": \"\",\n \"success_callback\": \"https://your.success.callback.com\",\n \"failure_callback\": \"https://your.failure.callback.com\",\n \"platform\": \"API\",\n \"created_from_ip\": \"203.0.113.81\",\n \"checkout_url\": \"https://api.paysecure.net/payments/6a44fd1061ad9b6b462f5df9/\",\n \"payoutProcess\": false\n}"},{"id":"1611b819-8c43-4453-a6ee-1f8bf0d3e139","name":"Purchase - Error (Brand not found)","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer {{APIKey}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"client\": {\n \"email\": \"user5772@example.com\",\n \"full_name\": \"test test\",\n \"country\": \"GB\",\n \"city\": \"Milford\",\n \"stateCode\": \"LO\",\n \"street_address\": \"1 Example Street\",\n \"zip_code\": \"234567\",\n \"date_of_birth\": \"1994-07-10\",\n \"phone\": \"+44 07000000000\"\n },\n \"purchase\": {\n \"currency\": \"EUR\",\n \"products\": [\n {\n \"name\": \"e-commerce\",\n \"price\": 11.5\n }\n ]\n },\n \"paymentMethod\": \"SKRILL\",\n \"merchantRef\": \"test_skrill_001\",\n \"brand_id\": \"your-brand-id\",\n \"success_redirect\": \"https://your.success.redirect.com\",\n \"pending_redirect\": \"https://your.pending.redirect.com\",\n \"failure_redirect\": \"https://your.failure.redirect.com\",\n \"success_callback\": \"https://your.success.callback.com\",\n \"failure_callback\": \"https://your.failure.callback.com\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.paysecure.net/api/v1/purchases"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Brand not found!\",\n \"code\": \"transaction_error\"\n}"}],"_postman_id":"713f14cf-a08b-4a5e-91fc-073470a5714e"},{"name":"Get Status","id":"44c82037-232e-4002-8e76-4c46fd899bd2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{APIKey}}","type":"text"}],"url":"https://api.paysecure.net/api/v1/purchases/{purchaseId}","description":"

Poll the current status and details of a purchase using the purchaseId returned by the Purchase API. This is the fallback to webhooks.

Possible Payment Statuses

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\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	Terminal?
`created`	Purchase order created, awaiting customer	❌
`pending_execute`	Customer redirected to the checkout page	❌
`payment_in_process`	Payment is under processing at Skrill	❌
`paid`	Transaction successful	✅
`error`	Transaction failed (`payment_failed` in `status_history`)	✅
`expired`	Purchase has expired	✅
`overdue`	Purchase is overdue	✅
`cancelled`	Purchase is cancelled	✅
`refund_in_process`	Refund is under processing	❌
`refunded`	Payment is refunded	✅
`chargeback`	Payment is in chargeback state	✅

The top-level status in the response is uppercase (e.g. PAID); entries in status_history are lowercase. Refund and chargeback statuses apply only where those features are enabled for your account.

\n","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"8a32d5db-7f4e-4c7b-858c-aad14fd0480d","id":"8a32d5db-7f4e-4c7b-858c-aad14fd0480d","name":"PayIn API","type":"folder"}},"urlObject":{"path":["purchases","{purchaseId}"],"host":["https://api.paysecure.net/api/v1"],"query":[],"variable":[]}},"response":[{"id":"25caa9ef-28e6-47e3-bbcb-826019496a1c","name":"Get Status - Paid","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{APIKey}}","type":"text"}],"url":"https://api.paysecure.net/api/v1/purchases/{purchaseId}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"purchaseId\": \"6a3a7edaccf6ad8dcb121f26\",\n \"client\": {\n \"customerId\": \"NA\",\n \"email\": \"user5772@example.com\",\n \"phone\": \"+44 07000000000\",\n \"full_name\": \"test test\",\n \"date_of_birth\": \"1994-07-10\",\n \"street_address\": \"1 Example Street\",\n \"country\": \"GB\",\n \"city\": \"Milford\",\n \"zip_code\": \"234567\",\n \"cc\": [],\n \"bcc\": [],\n \"stateCode\": \"LO\"\n },\n \"updated_on\": 1783690167,\n \"type\": \"purchase\",\n \"paymentMethod\": \"SKRILL\",\n \"amountUnit\": \"MAJOR\",\n \"errorMsg\": \"Transaction succeeded-APPROVED\",\n \"errorCode\": \"NA\",\n \"force_recurring\": false,\n \"created_on\": 1783690051,\n \"merchantRef\": \"6a3a7edaccf6ad8dcb121f26\",\n \"purchase\": {\n \"currency\": \"EUR\",\n \"products\": [\n {\n \"name\": \"e-commerce\",\n \"quantity\": 1,\n \"price\": 11.5,\n \"discount\": 0,\n \"tax_percent\": \"0.00\"\n }\n ],\n \"total\": 11.5,\n \"requestAmount\": 11.5,\n \"language\": \"en\",\n \"notes\": \"\",\n \"debt\": 0,\n \"total_formatted\": 1,\n \"taxAmount\": 0,\n \"taxPercent\": 0,\n \"request_client_details\": [],\n \"email_message\": \"\"\n },\n \"payment\": {\n \"is_outgoing\": false,\n \"payment_type\": \"PURCHASE\",\n \"amount\": 11.5,\n \"currency\": \"EUR\",\n \"net_amount\": 11.5,\n \"fee_amount\": 0,\n \"pending_amount\": 0,\n \"pending_unfreeze_on\": null,\n \"description\": \"\",\n \"paid_on\": 1783690059,\n \"remote_paid_on\": 1783690059\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 \"amount\": 11.5,\n \"masked_pan\": \"SKRILL\"\n },\n \"country\": \"\",\n \"attempts\": [\n {\n \"client_ip\": \"203.0.113.81\",\n \"type\": \"execute\",\n \"payment_method\": \"SKRILL\",\n \"flow\": \"payform\",\n \"successful\": true,\n \"country\": \"SKRILL\",\n \"processing_time\": 1783690067,\n \"extra\": {\n \"amount\": 11.5,\n \"masked_pan\": \"SKRILL\"\n }\n }\n ]\n },\n \"status\": \"PAID\",\n \"status_history\": [\n {\n \"status\": \"created\",\n \"timestamp\": 1783690051\n },\n {\n \"status\": \"pending_execute\",\n \"timestamp\": 1783690059\n },\n {\n \"status\": \"payment_in_process\",\n \"timestamp\": 1783690065\n },\n {\n \"status\": \"paid\",\n \"timestamp\": 1783690167\n }\n ],\n \"is_test\": false,\n \"brand_id\": \"your-brand-id\",\n \"send_receipt\": false,\n \"is_recurring_token\": false,\n \"skip_capture\": false,\n \"reference_generated\": \"PS5858\",\n \"issued\": \"2026-07-10\",\n \"due\": 1783690051,\n \"refund_upto\": 0,\n \"cc_descriptor\": \"\",\n \"fraudScore\": \"NA\",\n \"trustScore\": \"NA\",\n \"extraFee\": \"0\",\n \"totalRefunded\": 0,\n \"pix_payload\": {},\n \"payInDetails\": {},\n \"paidOn\": 1783690167,\n \"receivedAmt\": 11.5,\n \"taxAmount\": 0,\n \"surcharge\": 0,\n \"surchargeType\": \"\",\n \"sessionId\": \"\",\n \"refund_availability\": \"NONE\",\n \"refundable_amount\": 11.5,\n \"success_redirect\": \"https://your.success.redirect.com\",\n \"failure_redirect\": \"https://your.failure.redirect.com\",\n \"pending_redirect\": \"https://your.pending.redirect.com\",\n \"cancel_redirect\": \"\",\n \"success_callback\": \"https://your.success.callback.com\",\n \"failure_callback\": \"https://your.failure.callback.com\",\n \"platform\": \"API\",\n \"created_from_ip\": \"203.0.113.81\",\n \"checkout_url\": \"https://api.paysecure.net/payments/6a3a7edaccf6ad8dcb121f26/\",\n \"payoutProcess\": false\n}"},{"id":"bcbccf7b-6360-44e1-94f9-a78e254adc83","name":"Get Status - Error (Failed payment)","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{APIKey}}","type":"text"}],"url":"https://api.paysecure.net/api/v1/purchases/{purchaseId}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"purchaseId\": \"6a3a7edaccf6ad8dcb121f26\",\n \"client\": {\n \"customerId\": \"NA\",\n \"email\": \"user5772@example.com\",\n \"phone\": \"+44 07000000000\",\n \"full_name\": \"test test\",\n \"date_of_birth\": \"1994-07-10\",\n \"street_address\": \"1 Example Street\",\n \"country\": \"GB\",\n \"city\": \"Milford\",\n \"zip_code\": \"234567\",\n \"cc\": [],\n \"bcc\": [],\n \"stateCode\": \"LO\"\n },\n \"updated_on\": 1783690167,\n \"type\": \"purchase\",\n \"paymentMethod\": \"SKRILL\",\n \"amountUnit\": \"MAJOR\",\n \"errorMsg\": \"Transaction Failed\",\n \"errorCode\": \"NA\",\n \"force_recurring\": false,\n \"created_on\": 1783690051,\n \"merchantRef\": \"6a3a7edaccf6ad8dcb121f26\",\n \"purchase\": {\n \"currency\": \"EUR\",\n \"products\": [\n {\n \"name\": \"e-commerce\",\n \"quantity\": 1,\n \"price\": 11.5,\n \"discount\": 0,\n \"tax_percent\": \"0.00\"\n }\n ],\n \"total\": 11.5,\n \"requestAmount\": 11.5,\n \"language\": \"en\",\n \"notes\": \"\",\n \"debt\": 0,\n \"total_formatted\": 1,\n \"taxAmount\": 0,\n \"taxPercent\": 0,\n \"request_client_details\": [],\n \"email_message\": \"\"\n },\n \"payment\": {\n \"is_outgoing\": false,\n \"payment_type\": \"PURCHASE\",\n \"amount\": 11.5,\n \"currency\": \"EUR\",\n \"net_amount\": 11.5,\n \"fee_amount\": 0,\n \"pending_amount\": 0,\n \"pending_unfreeze_on\": null,\n \"description\": \"\",\n \"paid_on\": 1783690059,\n \"remote_paid_on\": 1783690059\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 \"amount\": 11.5,\n \"masked_pan\": \"SKRILL\"\n },\n \"country\": \"\",\n \"attempts\": [\n {\n \"client_ip\": \"203.0.113.81\",\n \"type\": \"execute\",\n \"payment_method\": \"SKRILL\",\n \"flow\": \"payform\",\n \"successful\": false,\n \"country\": \"SKRILL\",\n \"processing_time\": 1783690067,\n \"extra\": {\n \"amount\": 11.5,\n \"masked_pan\": \"SKRILL\"\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\": 1783690051\n },\n {\n \"status\": \"pending_execute\",\n \"timestamp\": 1783690059\n },\n {\n \"status\": \"payment_in_process\",\n \"timestamp\": 1783690065\n },\n {\n \"status\": \"payment_failed\",\n \"timestamp\": 1783690167\n }\n ],\n \"is_test\": false,\n \"brand_id\": \"your-brand-id\",\n \"send_receipt\": false,\n \"is_recurring_token\": false,\n \"skip_capture\": false,\n \"reference_generated\": \"PS5858\",\n \"issued\": \"2026-07-10\",\n \"due\": 1783690051,\n \"refund_upto\": 0,\n \"cc_descriptor\": \"\",\n \"fraudScore\": \"NA\",\n \"trustScore\": \"NA\",\n \"extraFee\": \"0\",\n \"totalRefunded\": 0,\n \"pix_payload\": {},\n \"payInDetails\": {},\n \"paidOn\": 0,\n \"receivedAmt\": 0,\n \"taxAmount\": 0,\n \"surcharge\": 0,\n \"surchargeType\": \"\",\n \"sessionId\": \"\",\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 \"pending_redirect\": \"https://your.pending.redirect.com\",\n \"cancel_redirect\": \"\",\n \"success_callback\": \"https://your.success.callback.com\",\n \"failure_callback\": \"https://your.failure.callback.com\",\n \"platform\": \"API\",\n \"created_from_ip\": \"203.0.113.81\",\n \"checkout_url\": \"https://api.paysecure.net/payments/6a3a7edaccf6ad8dcb121f26/\",\n \"payoutProcess\": false\n}"},{"id":"6c710151-34ba-4bec-9fec-3e97abb1e4b1","name":"Get Status - Error (Purchase not found)","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{APIKey}}","type":"text"}],"url":"https://api.paysecure.net/api/v1/purchases/{purchaseId}"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Purchase not found!\",\n \"code\": \"transaction_error\"\n}"}],"_postman_id":"44c82037-232e-4002-8e76-4c46fd899bd2"}],"id":"8a32d5db-7f4e-4c7b-858c-aad14fd0480d","description":"

Create a Skrill purchase and track it to a terminal status. Both calls use the standard Paysecure purchase contract.

Skrill is a wallet-based payment method: the customer pays from their Skrill account balance, either by logging in with email and password or by scanning a QR code with the Skrill mobile app. You create a standard purchase with paymentMethod = SKRILL and redirect the customer to the returned checkout_url.

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

Property	Details
Payment type	Digital wallet
Countries	Global (as enabled for your merchant account)
Processing currency	ISO 4217 fiat (e.g. `EUR`)
PayIn	✅
PayOut	❌
Refunds	Contact your Account Manager (`refund_availability` shown per transaction)
Recurring / MIT	❌
Customer flow	Redirect to hosted page → Skrill login or QR scan in Skrill app
Payment confirmation	Asynchronous — final status via webhook; redirect is for customer experience only
Key constraint	The email used at Skrill login must be the customer's Skrill wallet email
Transaction limits	As configured for your merchant account

Overview

iDEAL is a Dutch online banking payment method. Instead of entering card details, the customer is redirected to the iDEAL payment page and completes the payment inside their own bank's app or internet-banking session. The bank authorises the transfer in real time and iDEAL confirms it back to Paysecure, so you learn the outcome within seconds rather than days.

iDEAL is available to any customer holding a payment account at a participating Dutch bank, and it is the default expectation for consumer checkouts in the Netherlands. It is a push payment: the customer initiates and approves the transfer, which is why the payment cannot later be reversed as a chargeback.

\n\n

Coverage & Limits

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

Country	Currency	Minimum	Maximum	Expiry window	Confirmation delay
🇳🇱 Netherlands	EUR	EUR 1	Set per merchant profile, and additionally capped by the customer's own issuing bank	Approximately 15 minutes from creation of the purchase	Real-time — seconds after the customer approves

Notes:

Currency is EUR only. A purchase sent with paymentMethod = IDEAL and any other purchase.currency is rejected at creation.
\n
Country. client.country must be NL. The customer's address fields are not used for bank selection — the customer chooses their own bank on the iDEAL payment page.
\n
Expiry. If the customer does not complete the payment before the window closes, the purchase becomes terminal and unpayable, and the checkout_url stops accepting payment. Create a new purchase to let the customer retry; never reuse an expired purchaseId.
\n
Refund window. Refunds must be initiated within the period shown by refund_upto on the purchase object. Always read refund_availability and refundable_amount from the purchase rather than assuming.
\n

PayIn Flow

How it works

You create a purchase with paymentMethod = IDEAL and redirect the customer to the checkout_url returned in the response. On the iDEAL payment page the customer either scans the displayed QR code with their banking app, or presses Select your bank to continue through internet banking. Once the customer approves the transfer in their bank, iDEAL confirms it to Paysecure, Paysecure fires the paid webhook to your success_callback and returns the customer to your success_redirect.

Flow

Merchant creates the purchase: call POST https://api.paysecure.net/api/v1/purchases/ with paymentMethod = IDEAL, purchase.currency = EUR, your brand_id and the redirect/callback URLs. The response is the full purchase object with status = CREATED.
\n
Merchant redirects the customer: send the customer's browser to the checkout_url from the response. Do not rebuild this URL yourself — always use the value returned by the API.
\n
Customer chooses how to pay: the iDEAL payment page offers two paths — scan the QR code with a banking app (typical on desktop), or Select your bank and continue in internet banking (typical on mobile, which app-switches straight into the bank). Once the customer reaches the page and starts the payment, the purchase moves to pending_execute.
\n
Customer approves in their bank: the customer confirms the amount and the beneficiary inside their own banking session. At this point the purchase moves to payment_in_process.
\n
Paysecure confirms the payment: on receiving confirmation from iDEAL, the purchase moves to paid and Paysecure POSTs the webhook to your success_callback.
\n
Customer is returned to your site: the customer is redirected to success_redirect on success, pending_redirect while the outcome is still settling, and failure_redirect if the payment failed or the customer pressed Cancel on the iDEAL page.
\n
Merchant confirms server-side: treat the webhook — or a GET https://api.paysecure.net/api/v1/purchases/{purchaseId}/ call — as the only authority on the outcome. Never fulfil an order on the strength of the browser landing on success_redirect; a customer can reach that URL without a payment having completed.
\n

Unhappy paths your integration must handle

Customer abandons the iDEAL page → the purchase stays CREATED, or PENDING_EXECUTE if the customer reached the page and started the payment, until the expiry window closes and it becomes terminal. No webhook fires at the moment of abandonment — the expired webhook is what tells you.
\n
Customer presses Cancel → the customer returns to failure_redirect and the purchase ends in a non-paid terminal state.
\n
Bank declines or the authorisation fails → the purchase moves to error and the customer returns to failure_redirect.
\n
Customer closes the browser after approving → the payment still completes. The webhook is the reason your integration must be webhook-driven, not redirect-driven.
\n

Webhook Events for iDEAL

Non-failure events are delivered to success_callback, failure events to failure_callback. Two lifecycle statuses produce no webhook at all — they are visible only on the purchase object.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\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	Status	When it fires	Delivered to	Terminal?
purchase created	`created`	Purchase registered, `checkout_url` issued, awaiting the customer	No webhook — returned synchronously in the create response	❌
payment started	`pending_execute`	Customer reached the iDEAL payment page and started the payment	No webhook — read via Get Status	❌
payment in process	`payment_in_process`	Customer approved in their bank, awaiting confirmation from iDEAL	`success_callback`, where intermediate notifications are enabled on your profile	❌
purchase paid	`paid`	Funds confirmed — safe to fulfil	`success_callback`	✅
purchase expired	`expired`	Customer did not complete the payment within the expiry window	`failure_callback`	✅
purchase error	`error`	Payment failed, was declined, or was cancelled by the customer	`failure_callback`	✅
purchase refunded	`refunded`	A full refund was processed back to the customer's account	`success_callback`	✅

For the webhook payload shape, retry behaviour and signature verification, see the 🔌 Webhooks section of these docs — it is not duplicated here.

Two rules that save integration time:

Be idempotent. A webhook can be delivered more than once for the same status. Key your handler on purchaseId plus status.
\n
Do not rely on ordering. Under normal conditions statuses arrive in the order above, but always re-read status from the payload rather than inferring it from which handler was hit.
\n

Testing in Sandbox

In sandbox, POST /purchases/ with paymentMethod = IDEAL returns a checkout_url exactly as production does, so you can verify your create-purchase call, your redirect, your webhook handler and your status polling end to end.

To test each outcome:

Success — open the checkout_url and complete the simulated payment. The purchase moves to paid and your success_callback is invoked.
\n
Failure / cancellation — press Cancel on the payment page. The purchase ends in a non-paid terminal state and the customer is returned to failure_redirect.
\n
Expiry — create a purchase and simply do not pay it. Wait out the expiry window and confirm your integration handles the terminal non-paid state without leaving the order stuck in a pending state.
\n

Sandbox iDEAL does not use real bank credentials. If you need deterministic test outcomes or specific decline reasons wired into your sandbox brand, contact your Account Manager — the available simulator options depend on how your sandbox account is provisioned.

Before you go live, confirm: iDEAL is enabled on your production merchant profile, your production webhook URLs are registered and reachable over HTTPS, and your brand_id is the production one.

FAQs

Do I need to ask the customer which bank they use?
No. Bank selection happens on the iDEAL payment page — the customer either scans the QR code with their banking app or presses Select your bank there. You do not send an issuer or bank code in the request.

Can iDEAL be charged in a currency other than EUR?
No. iDEAL settles in EUR and a purchase in any other currency is rejected at creation. If you price in another currency, convert to EUR before calling /purchases/.

Can I take recurring payments with iDEAL?
Not through this endpoint. iDEAL authorises a single push payment per purchase. If you need recurring collection in the Netherlands, discuss SEPA Direct Debit with your Account Manager.

Can an iDEAL payment be charged back?
No. The customer authorises the transfer inside their own bank, so there is no card-style chargeback right. Disputes are handled commercially — you refund the customer.

Can I partially refund an iDEAL payment?
No. iDEAL supports full refunds only on this integration; refund_availability on a paid iDEAL purchase reads FULL_ONLY.

Why does the payment page show iDEAL together with Wero branding?
iDEAL is part of the European Payments Initiative, which also operates Wero, and the payment page carries the co-branding. It has no effect on your integration, your request, or the status values you receive.

How long should I wait before treating a purchase as failed?
Until the expiry window closes. A customer who has app-switched into their bank may take several minutes. Do not time out your own order earlier than the purchase does, or you will cancel orders that are about to be paid.

To initiate an iDEAL payment, the very first call to make is /purchases. It registers the purchase against your brand and returns the full purchase object, including the checkout_url you redirect the customer to. The response arrives with status = CREATED; the payment itself has not happened yet.

paymentMethod must be IDEAL (uppercase) and purchase.currency must be EUR. You do not send a bank or issuer code — the customer selects their bank on the iDEAL payment page.

Request Body 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	Notes
paymentMethod	Mandatory. Must be `IDEAL` (uppercase) to route the purchase to iDEAL.
brand_id	Mandatory. Identifies which of your brands the purchase belongs to. Can be located in the Dashboard section of your merchant account login.
purchase.currency	Mandatory. ISO 4217 code. Must be `EUR` for iDEAL — any other currency is rejected.
purchase.products.name	Mandatory. Description of the item shown to the customer. At least one product is required.
purchase.products.price	Mandatory. Amount for this product as a string. Send it as a decimal with two places — EUR 1 → `1.00`, EUR 12.50 → `12.50`. Integers such as `1` are accepted and interpreted as `1.00`.
client.email	Conditional. Not used by iDEAL itself, but strongly recommended: it is how the purchase is traced in the Dashboard and how the receipt is sent. Pass a correct email address.
client.country	Mandatory. ISO 3166-1 alpha-2 code. Must be `NL` for iDEAL.
client.full_name	Conditional. Recommended for reconciliation and fraud screening. Not matched against the bank account name by iDEAL.
client.phone	Optional. Include the country dialling code. Used for support and fraud screening, not for the payment itself.
client.city	Optional. Billing city. Not used for bank selection.
client.stateCode	Optional. Region/province code for the billing address. The Netherlands has no state requirement for iDEAL; pass it only if you hold the value.
client.street_address	Optional. Billing street address. Not used for bank selection.
client.zip_code	Optional. Billing postcode. Not used for bank selection.
client.date_of_birth	Optional. `YYYY-MM-DD`. Used for fraud screening where your profile is configured for it.
success_redirect	Mandatory. Browser URL the customer is returned to after a successful payment. Never fulfil an order on this redirect alone — confirm server-side.
pending_redirect	Optional. Browser URL the customer is returned to while the outcome is still settling. If omitted, the customer is sent to `success_redirect`.
failure_redirect	Mandatory. Browser URL the customer is returned to if the payment fails or they press Cancel on the iDEAL page.
success_callback	Mandatory. Server-to-server webhook URL for non-failure events — `paid`, `refunded`, and `payment_in_process` where intermediate notifications are enabled on your profile. Must be HTTPS and publicly reachable. This is the authoritative notification of the outcome.
failure_callback	Mandatory. Server-to-server webhook URL for failure events — `error` and `expired`. Must be HTTPS and publicly reachable.

Essential Optional Parameters

merchantRef is your own reference for the transaction, and passing it is strongly recommended:

Duplicate prevention — if the same merchantRef is submitted twice, the duplicate purchase is rejected rather than double-charging your customer. This matters most on retries after a network timeout, where you cannot tell whether the first call landed.
Transaction retrieval — you can look a purchase up by your own order or invoice number in the Dashboard and in reporting, without having to store and index Paysecure's purchaseId first.

If you do not send merchantRef, Paysecure generates one and returns it on the purchase object.

Response

The API echoes the complete purchase object. For an iDEAL create-purchase the fields that drive your next step are:

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

Field	What to do with it
`purchaseId`	Store it against your order. It is the key for `GET /purchases/{purchaseId}/`, for refunds, and for matching webhooks.
`checkout_url`	Redirect the customer's browser here. This is the iDEAL payment page that shows the QR code and the Select your bank option. Use the returned value as-is.
`status`	`CREATED` at this point. The payment has not been made yet.
`status_history`	Lowercase statuses with Unix timestamps — the audit trail of the purchase.
`refund_availability`	`NONE` until the purchase is paid; it becomes `FULL_ONLY` once `status` is `PAID`.
`merchantRef`	Your reference, or the one Paysecure generated if you did not send one.

There is no iDEAL-specific payload object in the response: unlike QR-first methods, iDEAL does not hand you a raw QR payload to render yourself — the payment page renders it.

Note that purchase.products.price is returned as a number (1) even when it was submitted as a string (\"1\"), and monetary fields on payment are numbers throughout.

\n","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"e5dc3fb9-44b0-492c-8311-88a559428b6a","id":"e5dc3fb9-44b0-492c-8311-88a559428b6a","name":"PayIn API","type":"folder"}},"urlObject":{"path":["purchases",""],"host":["https://api.paysecure.net/api/v1"],"query":[],"variable":[]}},"response":[{"id":"774b4b1d-3bf1-41c6-896c-6bfed1152767","name":"Purchase - Success","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer {{APIKey}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"client\": {\n \"email\": \"user3705@example.com\",\n \"country\": \"NL\",\n \"city\": \"Milford\",\n \"stateCode\": \"LO\",\n \"street_address\": \"1 Example Street\",\n \"zip_code\": \"234567\",\n \"full_name\": \"Reese Nakamura\",\n \"phone\": \"+44 07932665877\",\n \"date_of_birth\": \"1994-07-10\"\n },\n \"purchase\": {\n \"currency\": \"EUR\",\n \"products\": [\n {\n \"name\": \"e-commerce\",\n \"price\": \"1\"\n }\n ]\n },\n \"paymentMethod\": \"IDEAL\",\n \"brand_id\": \"your-brand-id\",\n \"success_redirect\": \"https://your.success.redirect.com\",\n \"pending_redirect\": \"https://your.pending.redirect.com\",\n \"failure_redirect\": \"https://your.failure.redirect.com\",\n \"success_callback\": \"https://your.success.callback.com\",\n \"failure_callback\": \"https://your.failure.callback.com\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.paysecure.net/api/v1/purchases/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"purchaseId\": \"68b1f4c2a9d3e14f27c5b810\",\n \"client\": {\n \"bank_account\": \"\",\n \"bank_code\": \"\",\n \"email\": \"user3705@example.com\",\n \"phone\": \"+44 07932665877\",\n \"full_name\": \"Reese Nakamura\",\n \"date_of_birth\": \"1994-07-10\",\n \"personal_code\": \"\",\n \"street_address\": \"1 Example Street\",\n \"country\": \"NL\",\n \"city\": \"Milford\",\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\": \"LO\"\n },\n \"updated_on\": 1785918915,\n \"type\": \"purchase\",\n \"force_recurring\": false,\n \"created_on\": 1785918915,\n \"purchase\": {\n \"currency\": \"EUR\",\n \"products\": [\n {\n \"name\": \"e-commerce\",\n \"quantity\": 1,\n \"price\": 1,\n \"discount\": 0,\n \"tax_percent\": \"0.00\"\n }\n ],\n \"total\": 1,\n \"language\": \"en\",\n \"notes\": \"\",\n \"debt\": 0,\n \"total_formatted\": 1,\n \"request_client_details\": [],\n \"timezone\": \"Europe/Amsterdam\",\n \"email_message\": \"\"\n },\n \"payment\": {\n \"is_outgoing\": false,\n \"payment_type\": \"PURCHASE\",\n \"amount\": 1,\n \"currency\": \"EUR\",\n \"net_amount\": 0,\n \"fee_amount\": 0,\n \"pending_amount\": 0,\n \"pending_unfreeze_on\": null,\n \"description\": \"\",\n \"paid_on\": null,\n \"remote_paid_on\": null\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\": \"Example Store BV\",\n \"brand_name\": \"Example Store\",\n \"registration_number\": \"\",\n \"tax_number\": \"\"\n },\n \"transaction_data\": {\n \"payment_method\": \"IDEAL\",\n \"flow\": \"payform\",\n \"extra\": {},\n \"country\": \"\",\n \"attempts\": []\n },\n \"status\": \"PAID\",\n \"status_history\": [\n {\n \"status\": \"created\",\n \"timestamp\": 1785999644\n },\n {\n \"status\": \"pending_execute\",\n \"timestamp\": 1785999644\n },\n {\n \"status\": \"payment_in_process\",\n \"timestamp\": 1785999645\n },\n {\n \"status\": \"paid\",\n \"timestamp\": 1785999645\n }\n ],\n \"viewedOn\": null,\n \"is_test\": false,\n \"brand_id\": \"your-brand-id\",\n \"merchantRef\": \"b7c1e6a4-2f83-4d19-9a5c-0e3f7d2b48c1\",\n \"send_receipt\": false,\n \"is_recurring_token\": false,\n \"skip_capture\": false,\n \"reference_generated\": \"PS41207\",\n \"issued\": \"2026-08-05\",\n \"due\": 1785918915,\n \"refund_upto\": 1801470915,\n \"cc_descriptor\": \"EXAMPLE STORE\",\n \"refund_availability\": \"NONE\",\n \"refundable_amount\": 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 \"cancel_redirect\": \"\",\n \"success_callback\": \"https://your.success.callback.com\",\n \"failure_callback\": \"https://your.failure.callback.com\",\n \"platform\": \"API\",\n \"created_from_ip\": \"203.0.113.138\",\n \"checkout_url\": \"https://api.paysecure.net/payments/68b1f4c2a9d3e14f27c5b810/\",\n \"direct_post_url\": \"https://api.paysecure.net/api/v1/p/68b1f4c2a9d3e14f27c5b810/\"\n}"},{"id":"1ef2d69c-5e02-4e5d-9f54-52bfab13f5e1","name":"Purchase - Error (Brand not found)","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer {{APIKey}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"client\": {\n \"email\": \"user3705@example.com\",\n \"country\": \"NL\",\n \"city\": \"Milford\",\n \"stateCode\": \"LO\",\n \"street_address\": \"1 Example Street\",\n \"zip_code\": \"234567\",\n \"full_name\": \"Reese Nakamura\",\n \"phone\": \"+44 07932665877\",\n \"date_of_birth\": \"1994-07-10\"\n },\n \"purchase\": {\n \"currency\": \"EUR\",\n \"products\": [\n {\n \"name\": \"e-commerce\",\n \"price\": \"1\"\n }\n ]\n },\n \"paymentMethod\": \"IDEAL\",\n \"brand_id\": \"your-brand-id\",\n \"success_redirect\": \"https://your.success.redirect.com\",\n \"pending_redirect\": \"https://your.pending.redirect.com\",\n \"failure_redirect\": \"https://your.failure.redirect.com\",\n \"success_callback\": \"https://your.success.callback.com\",\n \"failure_callback\": \"https://your.failure.callback.com\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.paysecure.net/api/v1/purchases/"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Brand not found\",\n \"code\": \"transaction_error\"\n}"},{"id":"b4e1e854-980a-4157-8365-3947180a7cc1","name":"Purchase - Error (Currency not supported)","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer {{APIKey}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"client\": {\n \"email\": \"user3705@example.com\",\n \"country\": \"NL\",\n \"city\": \"Milford\",\n \"stateCode\": \"LO\",\n \"street_address\": \"1 Example Street\",\n \"zip_code\": \"234567\",\n \"full_name\": \"Reese Nakamura\",\n \"phone\": \"+44 07932665877\",\n \"date_of_birth\": \"1994-07-10\"\n },\n \"purchase\": {\n \"currency\": \"USD\",\n \"products\": [\n {\n \"name\": \"e-commerce\",\n \"price\": \"1\"\n }\n ]\n },\n \"paymentMethod\": \"IDEAL\",\n \"brand_id\": \"your-brand-id\",\n \"success_redirect\": \"https://your.success.redirect.com\",\n \"pending_redirect\": \"https://your.pending.redirect.com\",\n \"failure_redirect\": \"https://your.failure.redirect.com\",\n \"success_callback\": \"https://your.success.callback.com\",\n \"failure_callback\": \"https://your.failure.callback.com\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.paysecure.net/api/v1/purchases/"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Payment method IDEAL is not available for currency USD\",\n \"code\": \"transaction_error\"\n}"}],"_postman_id":"12a04964-3a94-4cf6-a098-3cc95eee1699"},{"name":"Get Status","id":"9786bb83-b90a-49a7-8dea-29ea1ce87c90","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{APIKey}}","type":"text"}],"url":"https://api.paysecure.net/api/v1/purchases/{purchaseId}/","description":"

Use this call to read the current state of an iDEAL purchase. It returns the same complete purchase object as the create call, with status, status_history and the payment block updated to reflect reality.

Call it when you receive a webhook (to confirm the state from the source rather than trusting the payload alone), when a customer returns to your success_redirect, and during end-of-day reconciliation. Do not poll it in a tight loop as a substitute for handling webhooks — for a purchase awaiting customer action, once every 30–60 seconds until the expiry window closes is ample.

Path Parameters

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

Parameter	Notes
purchaseId	Mandatory. The `purchaseId` returned by `POST /purchases/`. Path parameter, e.g. `https://api.paysecure.net/api/v1/purchases/68b1f4c2a9d3e14f27c5b810/`.

Status values for iDEAL

Top-level status is uppercase; the entries in status_history are lowercase with Unix timestamps.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\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	Meaning	Terminal?
`CREATED`	Purchase registered, `checkout_url` issued, customer has not paid yet	❌
`PENDING_EXECUTE`	Customer has landed on the iDEAL page and started the payment	❌
`PAYMENT_IN_PROCESS`	Customer approved in their bank, awaiting confirmation from iDEAL	❌
`PAID`	Funds confirmed — safe to fulfil the order	✅
`EXPIRED`	Customer did not complete the payment within the expiry window	✅
`ERROR`	Payment failed, was declined, or was cancelled by the customer	✅
`REFUNDED`	The full amount was refunded to the customer	✅

status_history can also contain informational entries that never appear as a top-level status — most commonly viewed, recorded when the purchase or receipt page was opened. Ignore these when driving your state machine: they carry no payment meaning, and an unrecognised entry in status_history must not break your parser.

Fulfil only on PAID. Treat EXPIRED and ERROR as final for that purchaseId — to let the customer try again, create a new purchase.

Returns the full purchase amount to the bank account the customer paid from. iDEAL refunds are pushed back over SEPA, so the money lands in the customer's account rather than being reversed on a card.

Only a purchase whose status is PAID can be refunded, and only within the window shown by refund_upto on the purchase object. Read refund_availability before calling: for a paid iDEAL purchase it reads FULL_ONLY, which means the whole amount or nothing — iDEAL does not support partial refunds on this integration. No request body is required; the full refundable_amount is returned.

Path Parameters

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

Parameter	Notes
purchaseId	Mandatory. The `purchaseId` of the paid purchase to refund. Path parameter, e.g. `https://api.paysecure.net/api/v1/purchases/68b1f4c2a9d3e14f27c5b810/refund/`.

Response

The complete purchase object is returned with status = REFUNDED, a refunded entry appended to status_history, refund_availability back to NONE and refundable_amount at 0. A refunded webhook is also delivered to your success_callback.

The customer's bank may take one to a few business days to show the credit. Treat the REFUNDED status as confirmation that Paysecure has released the refund, not that it has already appeared on the customer's statement.

Common reasons a refund is rejected:

The purchase is not PAID (for example still CREATED, or EXPIRED).
The refund window has passed — compare against refund_upto.
The purchase has already been refunded, so refundable_amount is 0.

The iDEAL PayIn integration is Paysecure's standard /purchases contract with paymentMethod set to IDEAL. There is no iDEAL-specific request object and no method-specific payload in the response — everything the customer needs is served by the checkout_url that Paysecure returns.

Two calls cover the integration, with a third for refunds:

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

Request	Endpoint	Purpose
Purchases	`POST https://api.paysecure.net/api/v1/purchases/`	Create the purchase and get the `checkout_url` to redirect the customer to
Get Status	`GET https://api.paysecure.net/api/v1/purchases/{purchaseId}/`	Read the current state of a purchase (reconciliation, webhook verification)
Refund	`POST https://api.paysecure.net/api/v1/purchases/{purchaseId}/refund/`	Return the full amount to the customer's bank account

Your Brand ID and API key can be located in the Dashboard section of your merchant account login. Authenticate every call with Authorization: Bearer {{APIKey}}.

iDEAL is the dominant online payment method in the Netherlands, accounting for the large majority of Dutch e-commerce transactions. The customer authorises a real-time transfer inside their own banking app — either by scanning a QR code or by selecting their bank on the iDEAL payment page — so the funds are confirmed before you release the goods or credit the account. Because the payment is pushed by the customer from their own bank account, there are no card-style chargebacks.

Enabling iDEAL alongside cards is normally the single largest conversion lift available for a Netherlands-facing checkout: Dutch consumers expect it, and many will abandon a checkout that only offers cards.

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

Property	Details
Payment type	Real-time bank transfer (push payment)
Countries	🇳🇱 Netherlands
Processing currency	EUR
PayIn	✅
PayOut	❌ Not supported
Refunds	✅ Full refund only (no partial refunds)
Recurring / MIT	❌ Not supported on this endpoint
Chargebacks	❌ Not applicable — the customer authorises the push in their own bank
Customer flow	Redirect to the iDEAL payment page → QR scan in the banking app, or bank selection for internet banking
Payment confirmation	Real-time — the `paid` webhook normally arrives within seconds of the customer approving
Transaction limits	Set per merchant profile and additionally capped by the customer's issuing bank — contact your Account Manager
Settlement	T+1 in EUR (confirm your contracted cycle with your Account Manager)
`paymentMethod` enum	`IDEAL`

Overview

Bancontact is the Belgian domestic payment scheme, issued as a debit card by every major Belgian bank and usable online through the Bancontact app. On your checkout the customer chooses Bancontact, is redirected to the hosted payment page, and confirms the payment either by scanning a QR code with the Bancontact app or by entering their Bancontact card number and authenticating. The bank authorises in real time, so you learn the outcome within seconds rather than days.

Because Bancontact is a debit scheme, the funds are checked against the customer's account at authorisation — there is no deferred-settlement risk in the way there is with an invoice-based method. Your integration is a redirect integration: you never touch card data, and 3-D Secure is handled inside the Bancontact flow rather than by you.

\n\n

Coverage & Limits

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

Country	Currency	Minimum	Maximum	Expiry window	Confirmation delay
🇧🇪 Belgium	EUR	EUR 0.01	Set per merchant profile, and additionally capped by the customer's own issuing bank	Approximately 15 minutes from creation of the purchase	Real-time — seconds after the customer confirms

Notes:

Currency is EUR only. A purchase sent with paymentMethod = BANCONTACT and any other purchase.currency is rejected at creation.
\n
Country. client.country must be BE. The customer's address fields play no part in the authorisation — the customer authenticates with their own app or card.
\n
Expiry. If the customer does not confirm before the window closes, the purchase becomes terminal and unpayable, and the checkout_url stops accepting payment. Create a new purchase to let the customer retry; never reuse an expired purchaseId.
\n
Refund window. Refunds must be initiated within the period shown by refund_upto on the purchase object. Always read refund_availability and refundable_amount from the purchase rather than assuming.
\n

PayIn Flow

How it works

You create a purchase with paymentMethod = BANCONTACT and redirect the customer to the checkout_url returned in the response. On the hosted page the customer either scans the displayed QR code with the Bancontact app and confirms there, or enters their Bancontact card number and completes the authentication their bank asks for. Once the bank authorises, Paysecure fires the paid webhook to your success_callback and returns the customer to your success_redirect.

Flow

Merchant creates the purchase: call POST https://api.paysecure.net/api/v1/purchases/ with paymentMethod = BANCONTACT, purchase.currency = EUR, your brand_id and the redirect/callback URLs. The response is the full purchase object with status = CREATED.
\n
Merchant redirects the customer: send the customer's browser to the checkout_url from the response. Do not rebuild this URL yourself — always use the value returned by the API.
\n
Customer chooses how to confirm: the hosted page offers two paths — scan the QR code with the Bancontact app (typical on desktop), or enter Bancontact card details and authenticate (typical when the app is not installed). On a mobile browser the QR path app-switches straight into the Bancontact app. Once the customer reaches the page and starts the payment, the purchase moves to pending_execute.
\n
Customer authorises: the customer confirms the amount and the beneficiary in the app, or completes their bank's authentication step for the card path. At this point the purchase moves to payment_in_process.
\n
Paysecure confirms the payment: on receiving the authorisation, the purchase moves to paid and Paysecure POSTs the webhook to your success_callback.
\n
Customer is returned to your site: the customer is redirected to success_redirect on success, pending_redirect while the outcome is still settling, and failure_redirect if the payment failed or the customer cancelled on the hosted page.
\n
Merchant confirms server-side: treat the webhook — or a GET https://api.paysecure.net/api/v1/purchases/{purchaseId}/ call — as the only authority on the outcome. Never fulfil an order on the strength of the browser landing on success_redirect; a customer can reach that URL without a payment having completed.
\n

Unhappy paths your integration must handle

Customer abandons the hosted page → the purchase stays CREATED, or PENDING_EXECUTE if the customer reached the page and started the payment, until the expiry window closes and it becomes terminal. No webhook fires at the moment of abandonment — the expired webhook is what tells you.
\n
Customer cancels on the hosted page → the customer returns to failure_redirect and the purchase ends in a non-paid terminal state.
\n
Insufficient funds, or the bank declines the authorisation → the purchase moves to error and the customer returns to failure_redirect. Because Bancontact is a debit scheme, a declined authorisation on an account with too little balance is a normal, expected outcome — surface a retry, not an error page.
\n
Authentication is not completed in time → the purchase moves to error or expires, depending on where the customer stopped. Handle both as non-paid.
\n
Customer closes the browser after confirming → the payment still completes. The webhook is the reason your integration must be webhook-driven, not redirect-driven.
\n

Webhook Events for Bancontact

Non-failure events are delivered to success_callback, failure events to failure_callback. Two lifecycle statuses produce no webhook at all — they are visible only on the purchase object.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\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	Status	When it fires	Delivered to	Terminal?
purchase created	`created`	Purchase registered, `checkout_url` issued, awaiting the customer	No webhook — returned synchronously in the create response	❌
payment started	`pending_execute`	Customer reached the hosted page and started the payment	No webhook — read via Get Status	❌
payment in process	`payment_in_process`	Customer confirmed, awaiting the bank's authorisation	`success_callback`, where intermediate notifications are enabled on your profile	❌
purchase paid	`paid`	Authorisation confirmed — safe to fulfil	`success_callback`	✅
purchase expired	`expired`	Customer did not confirm within the expiry window	`failure_callback`	✅
purchase error	`error`	Payment failed, was declined, or was cancelled by the customer	`failure_callback`	✅
purchase refunded	`refunded`	A full refund was processed back to the customer	`success_callback`	✅

For the webhook payload shape, retry behaviour and signature verification, see the 🔌 Webhooks section of these docs — it is not duplicated here.

Two rules that save integration time:

Be idempotent. A webhook can be delivered more than once for the same status. Key your handler on purchaseId plus status.
\n
Do not rely on ordering. Under normal conditions statuses arrive in the order above, but always re-read status from the payload rather than inferring it from which handler was hit.
\n

Testing in Sandbox

In sandbox, POST /purchases/ with paymentMethod = BANCONTACT returns a checkout_url exactly as production does, so you can verify your create-purchase call, your redirect, your webhook handler and your status polling end to end.

To test each outcome:

Success — open the checkout_url and complete the simulated payment. The purchase moves to paid and your success_callback is invoked.
\n
Failure / cancellation — cancel on the hosted page. The purchase ends in a non-paid terminal state and the customer is returned to failure_redirect.
\n
Expiry — create a purchase and simply do not pay it. Wait out the expiry window and confirm your integration handles the terminal non-paid state without leaving the order stuck in a pending state.
\n

Sandbox Bancontact does not use real cards or a real Bancontact app. If you need deterministic test outcomes or specific decline reasons wired into your sandbox brand, contact your Account Manager — the available simulator options depend on how your sandbox account is provisioned.

Before you go live, confirm: Bancontact is enabled on your production merchant profile, your production webhook URLs are registered and reachable over HTTPS, and your brand_id is the production one.

FAQs

Do I need to collect card details for the card path?
No. Both paths are completed on the hosted page reached via checkout_url, so card data never enters your systems — this is the lowest-scope way to accept it. Confirm your own PCI DSS obligations (typically SAQ A for a redirect integration) with your compliance team.

Do I need to integrate 3-D Secure?
No. Authentication is part of the Bancontact flow itself — the app confirmation or the bank's card authentication step. There is no separate 3DS call for you to make and no authentication result for you to interpret.

Can Bancontact be charged in a currency other than EUR?
No. Bancontact settles in EUR and a purchase in any other currency is rejected at creation. If you price in another currency, convert to EUR before calling /purchases/.

Can I take recurring payments with Bancontact?
Not through this endpoint. Bancontact authorises a single payment per purchase. If you need recurring collection in Belgium, discuss SEPA Direct Debit with your Account Manager.

Can I partially refund a Bancontact payment?
No. Bancontact supports full refunds only on this integration; refund_availability on a paid Bancontact purchase reads FULL_ONLY.

Is Bancontact the same thing as Mister Cash?
Yes — Mister Cash was the scheme's former name and the pairing is sometimes still written as \"Bancontact Mister Cash\" or abbreviated BCMC in other providers' documentation. In the Paysecure API the enum is BANCONTACT.

How long should I wait before treating a purchase as failed?
Until the expiry window closes. A customer who has app-switched into the Bancontact app may take several minutes. Do not time out your own order earlier than the purchase does, or you will cancel orders that are about to be paid.

\n","auth":{"type":"noauth","isInherited":false},"event":[{"listen":"prerequest","script":{"id":"7952da53-4305-4419-bae8-7aa37949d54b","type":"text/javascript","packages":{},"requests":{},"exec":[""]}},{"listen":"test","script":{"id":"ef7f488f-9f5e-4ab0-9e97-5b97b30e0451","type":"text/javascript","packages":{},"requests":{},"exec":[""]}}],"_postman_id":"a7bf3592-2c9b-422a-8142-a29e991921a6"},{"name":"PayIn API","item":[{"name":"Purchases","id":"7c8cc3fd-5551-4cc1-9a95-1e716d090dc2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer {{APIKey}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"client\": {\n \"email\": \"customer@example.com\",\n \"country\": \"BE\",\n \"city\": \"Brussels\",\n \"stateCode\": \"BRU\",\n \"street_address\": \"Rue de la Loi 16\",\n \"zip_code\": \"1000\",\n \"full_name\": \"Jan Peeters\",\n \"phone\": \"+32 470 12 34 56\",\n \"date_of_birth\": \"1990-04-12\"\n },\n \"purchase\": {\n \"currency\": \"EUR\",\n \"products\": [\n {\n \"name\": \"e-commerce\",\n \"price\": \"1.00\"\n }\n ]\n },\n \"paymentMethod\": \"BANCONTACT\",\n \"brand_id\": \"your-brand-id\",\n \"merchantRef\": \"ORDER-10245\",\n \"success_redirect\": \"https://your.success.redirect.com\",\n \"pending_redirect\": \"https://your.pending.redirect.com\",\n \"failure_redirect\": \"https://your.failure.redirect.com\",\n \"success_callback\": \"https://your.success.callback.com\",\n \"failure_callback\": \"https://your.failure.callback.com\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.paysecure.net/api/v1/purchases/","description":"

To initiate a Bancontact payment, the very first call to make is /purchases. It registers the purchase against your brand and returns the full purchase object, including the checkout_url you redirect the customer to. The response arrives with status = CREATED; the payment itself has not happened yet.

paymentMethod must be BANCONTACT (uppercase) and purchase.currency must be EUR. You do not send card details, a QR payload, or any authentication data — the hosted page handles the customer's chosen path.

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

Parameter	Notes
paymentMethod	Mandatory. Must be `BANCONTACT` (uppercase) to route the purchase to Bancontact.
brand_id	Mandatory. Identifies which of your brands the purchase belongs to. Can be located in the Dashboard section of your merchant account login.
purchase.currency	Mandatory. ISO 4217 code. Must be `EUR` for Bancontact — any other currency is rejected.
purchase.products.name	Mandatory. Description of the item shown to the customer. At least one product is required.
purchase.products.price	Mandatory. Amount for this product as a string. Send it as a decimal with two places — EUR 1 → `1.00`, EUR 12.50 → `12.50`. Integers such as `1` are accepted and interpreted as `1.00`.
merchantRef	Optional. Strongly recommended. Your own order or invoice reference. See Essential Optional Parameters below for why you want it. If omitted, Paysecure generates one and returns it.
client.email	Conditional. Not used by Bancontact itself, but strongly recommended: it is how the purchase is traced in the Dashboard and how the receipt is sent. Pass a correct email address.
client.country	Mandatory. ISO 3166-1 alpha-2 code. Must be `BE` for Bancontact.
client.full_name	Conditional. Recommended for reconciliation and fraud screening. Not matched against the cardholder name by Bancontact.
client.phone	Optional. Include the country dialling code. Used for support and fraud screening, not for the payment itself.
client.city	Optional. Billing city. Plays no part in the authorisation.
client.stateCode	Optional. Region/province code for the billing address. Belgium has no state requirement for Bancontact; pass it only if you hold the value.
client.street_address	Optional. Billing street address. Plays no part in the authorisation.
client.zip_code	Optional. Billing postcode. Plays no part in the authorisation.
client.date_of_birth	Optional. `YYYY-MM-DD`. Used for fraud screening where your profile is configured for it.
success_redirect	Mandatory. Browser URL the customer is returned to after a successful payment. Never fulfil an order on this redirect alone — confirm server-side.
pending_redirect	Optional. Browser URL the customer is returned to while the outcome is still settling. If omitted, the customer is sent to `success_redirect`.
failure_redirect	Mandatory. Browser URL the customer is returned to if the payment fails or they cancel on the hosted page.
success_callback	Mandatory. Server-to-server webhook URL for non-failure events — `paid`, `refunded`, and `payment_in_process` where intermediate notifications are enabled on your profile. Must be HTTPS and publicly reachable. This is the authoritative notification of the outcome.
failure_callback	Mandatory. Server-to-server webhook URL for failure events — `error` and `expired`. Must be HTTPS and publicly reachable.

Essential Optional Parameters

merchantRef is your own reference for the transaction, and passing it is strongly recommended:

Duplicate prevention — if the same merchantRef is submitted twice, the duplicate purchase is rejected rather than double-charging your customer. This matters most on retries after a network timeout, where you cannot tell whether the first call landed.
Transaction retrieval — you can look a purchase up by your own order or invoice number in the Dashboard and in reporting, without having to store and index Paysecure's purchaseId first.

Response

The API echoes the complete purchase object. For a Bancontact create-purchase the fields that drive your next step are:

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

Field	What to do with it
`purchaseId`	Store it against your order. It is the key for `GET /purchases/{purchaseId}/`, for refunds, and for matching webhooks.
`checkout_url`	Redirect the customer's browser here. This is the hosted page that shows the Bancontact QR code and the card-entry option. Use the returned value as-is.
`status`	`CREATED` at this point. The payment has not been made yet.
`status_history`	Lowercase statuses with Unix timestamps — the audit trail of the purchase.
`refund_availability`	`NONE` until the purchase is paid; it becomes `FULL_ONLY` once `status` is `PAID`.
`merchantRef`	Your reference, echoed back, or the one Paysecure generated if you did not send one.

There is no Bancontact-specific payload object in the response: the QR code is rendered by the hosted page, so you are not handed a raw payload to render yourself.

Note that purchase.products.price is returned as a number (1) even when it was submitted as a string (\"1.00\"), and monetary fields on payment are numbers throughout.

\n","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"4b9cb7a5-c684-446a-8e10-c89fb250c5bc","id":"4b9cb7a5-c684-446a-8e10-c89fb250c5bc","name":"PayIn API","type":"folder"}},"urlObject":{"path":["purchases",""],"host":["https://api.paysecure.net/api/v1"],"query":[],"variable":[]}},"response":[{"id":"66d1a5c2-cbaf-4b73-a4d7-fdea703c9bdf","name":"Purchase - Success","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer {{APIKey}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"client\": {\n \"email\": \"customer@example.com\",\n \"country\": \"BE\",\n \"city\": \"Brussels\",\n \"stateCode\": \"BRU\",\n \"street_address\": \"Rue de la Loi 16\",\n \"zip_code\": \"1000\",\n \"full_name\": \"Jan Peeters\",\n \"phone\": \"+32 470 12 34 56\",\n \"date_of_birth\": \"1990-04-12\"\n },\n \"purchase\": {\n \"currency\": \"EUR\",\n \"products\": [\n {\n \"name\": \"e-commerce\",\n \"price\": \"1.00\"\n }\n ]\n },\n \"paymentMethod\": \"BANCONTACT\",\n \"brand_id\": \"your-brand-id\",\n \"merchantRef\": \"ORDER-10245\",\n \"success_redirect\": \"https://your.success.redirect.com\",\n \"pending_redirect\": \"https://your.pending.redirect.com\",\n \"failure_redirect\": \"https://your.failure.redirect.com\",\n \"success_callback\": \"https://your.success.callback.com\",\n \"failure_callback\": \"https://your.failure.callback.com\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.paysecure.net/api/v1/purchases/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"purchaseId\": \"68b2a71e4c8d95f30b17ea62\",\n \"client\": {\n \"bank_account\": \"\",\n \"bank_code\": \"\",\n \"email\": \"customer@example.com\",\n \"phone\": \"+32 470 12 34 56\",\n \"full_name\": \"Jan Peeters\",\n \"date_of_birth\": \"1990-04-12\",\n \"personal_code\": \"\",\n \"street_address\": \"Rue de la Loi 16\",\n \"country\": \"BE\",\n \"city\": \"Brussels\",\n \"zip_code\": \"1000\",\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\": \"BRU\"\n },\n \"updated_on\": 1785931200,\n \"type\": \"purchase\",\n \"force_recurring\": false,\n \"created_on\": 1785931200,\n \"purchase\": {\n \"currency\": \"EUR\",\n \"products\": [\n {\n \"name\": \"e-commerce\",\n \"quantity\": 1,\n \"price\": 1,\n \"discount\": 0,\n \"tax_percent\": \"0.00\"\n }\n ],\n \"total\": 1,\n \"language\": \"en\",\n \"notes\": \"\",\n \"debt\": 0,\n \"total_formatted\": 1,\n \"request_client_details\": [],\n \"timezone\": \"Europe/Brussels\",\n \"email_message\": \"\"\n },\n \"payment\": {\n \"is_outgoing\": false,\n \"payment_type\": \"PURCHASE\",\n \"amount\": 1,\n \"currency\": \"EUR\",\n \"net_amount\": 0,\n \"fee_amount\": 0,\n \"pending_amount\": 0,\n \"pending_unfreeze_on\": null,\n \"description\": \"\",\n \"paid_on\": null,\n \"remote_paid_on\": null\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\": \"Example Store BV\",\n \"brand_name\": \"Example Store\",\n \"registration_number\": \"\",\n \"tax_number\": \"\"\n },\n \"transaction_data\": {\n \"payment_method\": \"BANCONTACT\",\n \"flow\": \"payform\",\n \"extra\": {},\n \"country\": \"\",\n \"attempts\": []\n },\n \"status\": \"PAID\",\n \"status_history\": [\n {\n \"status\": \"created\",\n \"timestamp\": 1785931200\n },\n {\n \"status\": \"pending_execute\",\n \"timestamp\": 1785931231\n },\n {\n \"status\": \"payment_in_process\",\n \"timestamp\": 1785931244\n },\n {\n \"status\": \"paid\",\n \"timestamp\": 1785931252\n }\n ],\n \"viewedOn\": null,\n \"is_test\": false,\n \"brand_id\": \"your-brand-id\",\n \"merchantRef\": \"ORDER-10245\",\n \"send_receipt\": false,\n \"is_recurring_token\": false,\n \"skip_capture\": false,\n \"reference_generated\": \"PS41318\",\n \"issued\": \"2026-08-05\",\n \"due\": 1785931200,\n \"refund_upto\": 1801483200,\n \"cc_descriptor\": \"EXAMPLE STORE\",\n \"refund_availability\": \"NONE\",\n \"refundable_amount\": 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 \"cancel_redirect\": \"\",\n \"success_callback\": \"https://your.success.callback.com\",\n \"failure_callback\": \"https://your.failure.callback.com\",\n \"platform\": \"API\",\n \"created_from_ip\": \"203.0.113.48\",\n \"checkout_url\": \"https://api.paysecure.net/payments/68b2a71e4c8d95f30b17ea62/\",\n \"direct_post_url\": \"https://api.paysecure.net/api/v1/p/68b2a71e4c8d95f30b17ea62/\"\n}"},{"id":"423c9821-f090-474e-83d1-a71b04aaac6a","name":"Purchase - Error (Brand not found)","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer {{APIKey}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"client\": {\n \"email\": \"customer@example.com\",\n \"country\": \"BE\",\n \"city\": \"Brussels\",\n \"stateCode\": \"BRU\",\n \"street_address\": \"Rue de la Loi 16\",\n \"zip_code\": \"1000\",\n \"full_name\": \"Jan Peeters\",\n \"phone\": \"+32 470 12 34 56\",\n \"date_of_birth\": \"1990-04-12\"\n },\n \"purchase\": {\n \"currency\": \"EUR\",\n \"products\": [\n {\n \"name\": \"e-commerce\",\n \"price\": \"1.00\"\n }\n ]\n },\n \"paymentMethod\": \"BANCONTACT\",\n \"brand_id\": \"invalid-brand-id\",\n \"merchantRef\": \"ORDER-10245\",\n \"success_redirect\": \"https://your.success.redirect.com\",\n \"pending_redirect\": \"https://your.pending.redirect.com\",\n \"failure_redirect\": \"https://your.failure.redirect.com\",\n \"success_callback\": \"https://your.success.callback.com\",\n \"failure_callback\": \"https://your.failure.callback.com\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.paysecure.net/api/v1/purchases/"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Brand not found\",\n \"code\": \"transaction_error\"\n}"},{"id":"3a4ecb2b-588a-4e12-9861-75c173b18e9a","name":"Purchase - Error (Currency not supported)","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer {{APIKey}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"client\": {\n \"email\": \"customer@example.com\",\n \"country\": \"BE\",\n \"city\": \"Brussels\",\n \"stateCode\": \"BRU\",\n \"street_address\": \"Rue de la Loi 16\",\n \"zip_code\": \"1000\",\n \"full_name\": \"Jan Peeters\",\n \"phone\": \"+32 470 12 34 56\",\n \"date_of_birth\": \"1990-04-12\"\n },\n \"purchase\": {\n \"currency\": \"USD\",\n \"products\": [\n {\n \"name\": \"e-commerce\",\n \"price\": \"1.00\"\n }\n ]\n },\n \"paymentMethod\": \"BANCONTACT\",\n \"brand_id\": \"your-brand-id\",\n \"merchantRef\": \"ORDER-10245\",\n \"success_redirect\": \"https://your.success.redirect.com\",\n \"pending_redirect\": \"https://your.pending.redirect.com\",\n \"failure_redirect\": \"https://your.failure.redirect.com\",\n \"success_callback\": \"https://your.success.callback.com\",\n \"failure_callback\": \"https://your.failure.callback.com\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.paysecure.net/api/v1/purchases/"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Payment method BANCONTACT is not available for currency USD\",\n \"code\": \"transaction_error\"\n}"}],"_postman_id":"7c8cc3fd-5551-4cc1-9a95-1e716d090dc2"},{"name":"Get Status","id":"bbd32713-56ea-4846-a918-c567fd05d020","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{APIKey}}","type":"text"}],"url":"https://api.paysecure.net/api/v1/purchases/{purchaseId}/","description":"

Use this call to read the current state of a Bancontact purchase. It returns the same complete purchase object as the create call, with status, status_history and the payment block updated to reflect reality.

Path Parameters

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

Parameter	Notes
purchaseId	Mandatory. The `purchaseId` returned by `POST /purchases/`. Path parameter, e.g. `https://api.paysecure.net/api/v1/purchases/68b2a71e4c8d95f30b17ea62/`.

Status values for Bancontact

Top-level status is uppercase; the entries in status_history are lowercase with Unix timestamps.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\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	Meaning	Terminal?
`CREATED`	Purchase registered, `checkout_url` issued, customer has not paid yet	❌
`PENDING_EXECUTE`	Customer has landed on the hosted page and started the payment	❌
`PAYMENT_IN_PROCESS`	Customer confirmed, awaiting the bank's authorisation	❌
`PAID`	Authorisation confirmed — safe to fulfil the order	✅
`EXPIRED`	Customer did not confirm within the expiry window	✅
`ERROR`	Payment failed, was declined, or was cancelled by the customer	✅
`REFUNDED`	The full amount was refunded to the customer	✅

Fulfil only on PAID. Treat EXPIRED and ERROR as final for that purchaseId — to let the customer try again, create a new purchase.

Returns the full purchase amount to the customer, credited back to the Bancontact account or card used for the original payment.

Only a purchase whose status is PAID can be refunded, and only within the window shown by refund_upto on the purchase object. Read refund_availability before calling: for a paid Bancontact purchase it reads FULL_ONLY, which means the whole amount or nothing — Bancontact does not support partial refunds on this integration. No request body is required; the full refundable_amount is returned.

Path Parameters

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

Parameter	Notes
purchaseId	Mandatory. The `purchaseId` of the paid purchase to refund. Path parameter, e.g. `https://api.paysecure.net/api/v1/purchases/68b2a71e4c8d95f30b17ea62/refund/`.

Response

Common reasons a refund is rejected:

The purchase is not PAID (for example still CREATED, or EXPIRED).
The refund window has passed — compare against refund_upto.
The purchase has already been refunded, so refundable_amount is 0.

The Bancontact PayIn integration is Paysecure's standard /purchases contract with paymentMethod set to BANCONTACT. There is no Bancontact-specific request object and no method-specific payload in the response — everything the customer needs, QR code included, is served by the checkout_url that Paysecure returns.

Two calls cover the integration, with a third for refunds:

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

Request	Endpoint	Purpose
Purchases	`POST https://api.paysecure.net/api/v1/purchases/`	Create the purchase and get the `checkout_url` to redirect the customer to
Get Status	`GET https://api.paysecure.net/api/v1/purchases/{purchaseId}/`	Read the current state of a purchase (reconciliation, webhook verification)
Refund	`POST https://api.paysecure.net/api/v1/purchases/{purchaseId}/refund/`	Return the full amount to the customer

Your Brand ID and API key can be located in the Dashboard section of your merchant account login. Authenticate every call with Authorization: Bearer {{APIKey}}.

\n","auth":{"type":"noauth","isInherited":false},"event":[{"listen":"prerequest","script":{"id":"fafe43a8-2e85-4a1f-9387-bd515f3aadd2","type":"text/javascript","packages":{},"requests":{},"exec":[""]}},{"listen":"test","script":{"id":"8165601a-8dae-43a5-96bd-0fa32a4c907b","type":"text/javascript","packages":{},"requests":{},"exec":[""]}}],"_postman_id":"4b9cb7a5-c684-446a-8e10-c89fb250c5bc"}],"id":"20748a16-3191-4c36-9e19-9def41b7b483","description":"

Bancontact is Belgium's domestic payment scheme and the payment method Belgian consumers reach for first — it is accepted essentially everywhere in the country and is the default expectation at a Belgian checkout. The customer authorises the payment either by scanning a QR code with the Bancontact app (also branded Payconiq) or by entering their Bancontact card details and confirming, so the authorisation is always strongly authenticated and you learn the outcome in real time.

You never handle card data and you do not integrate 3-D Secure separately: the customer authenticates inside the Bancontact flow on the hosted page reached via checkout_url.

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

Property	Details
Payment type	Domestic debit scheme — QR-based app confirmation or Bancontact card entry
Countries	🇧🇪 Belgium
Processing currency	EUR
PayIn	✅
PayOut	❌ Not supported
Refunds	✅ Full refund only (no partial refunds)
Recurring / MIT	❌ Not supported on this endpoint
Chargebacks	⚠️ Limited — fraud claims rarely reach you because authentication is mandatory on every payment; non-fraud complaints are handled commercially (you refund). Confirm your dispute process with your Account Manager
Customer flow	Redirect to the hosted page → QR scan in the Bancontact app, or Bancontact card entry
Payment confirmation	Real-time — the `paid` webhook normally arrives within seconds of the customer confirming
Transaction limits	Set per merchant profile and additionally capped by the customer's issuing bank — contact your Account Manager
Settlement	T+1 in EUR (confirm your contracted cycle with your Account Manager)
`paymentMethod` enum	`BANCONTACT`

","auth":{"type":"noauth","isInherited":false},"event":[{"listen":"prerequest","script":{"id":"91c0a7bf-7cb8-4221-8a86-6e20a318c985","type":"text/javascript","packages":{},"requests":{},"exec":[""]}},{"listen":"test","script":{"id":"8e78ae03-9702-4e46-af67-365145330db8","type":"text/javascript","packages":{},"requests":{},"exec":[""]}}],"_postman_id":"20748a16-3191-4c36-9e19-9def41b7b483"},{"name":"🇦🇷 QR","item":[{"name":"Concepts","item":[],"id":"0ee56d7b-0935-44eb-8962-b395b60ca82f","description":"

Overview

QR is Argentina's interoperable QR payment standard: a single QR code that a customer can scan with their own bank app or wallet, review, and approve as a transfer from their account. Because the standard is interoperable, you do not need to know or ask which app the customer uses — one QR works across participating banks and wallets.

For your integration it behaves as a push payment. Paysecure registers the purchase, the hosted page renders the QR, and the customer initiates the transfer from their side. That means no chargebacks, but also that you cannot force the timing: the customer decides when to scan.

\n\n

Coverage & Limits

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

Country	Currency	Minimum	Maximum	Expiry window	Confirmation delay
🇦🇷 Argentina	ARS	Set per merchant profile	Set per merchant profile, and additionally capped by the customer's own bank or wallet transfer limits	Approximately 24 hours from creation of the purchase	Real-time from the moment the customer confirms in their app

Notes:

Currency is ARS only. A purchase sent with paymentMethod = QR and any other purchase.currency is rejected at creation.
\n
Country. Set client.country to AR. The customer's address fields play no part in the transfer — the customer authorises inside their own app.
\n
The 24-hour expiry is the defining characteristic of this method. The hosted page shows the customer a live countdown. Until that countdown reaches zero the purchase is payable, so your order must stay open and your stock reservation (if any) must survive it.
\n
Refund window. Refunds must be initiated within the period shown by refund_upto on the purchase object. Always read refund_availability and refundable_amount from the purchase rather than assuming.
\n

PayIn Flow

How it works

You create a purchase with paymentMethod = QR and redirect the customer to the checkout_url returned in the response. The hosted page displays the QR code together with the amount in ARS and a countdown to expiry. The customer scans it with their bank app or wallet, confirms the transfer there, and Paysecure fires the paid webhook to your success_callback as soon as the transfer is confirmed.

Flow

Merchant creates the purchase: call POST https://api.paysecure.net/api/v1/purchases/ with paymentMethod = QR, purchase.currency = ARS, your brand_id and the redirect/callback URLs. The response is the full purchase object with status = CREATED.
\n
Merchant redirects the customer: send the customer's browser to the checkout_url from the response. Do not rebuild this URL yourself — always use the value returned by the API.
\n
Customer scans the QR: the hosted page shows the QR, the ARS amount and the remaining time. The customer opens their own bank app or wallet, scans, and reviews the transfer. Once the customer reaches the page, the purchase moves to pending_execute.
\n
Customer confirms in their app: the transfer is authorised inside the customer's app, not on your site or on the hosted page. At this point the purchase moves to payment_in_process.
\n
Paysecure confirms the payment: on receiving confirmation of the transfer, the purchase moves to paid and Paysecure POSTs the webhook to your success_callback.
\n
Merchant confirms server-side: the webhook — or a GET https://api.paysecure.net/api/v1/purchases/{purchaseId}/ call — is the only authority on the outcome. Never fulfil an order on the strength of the browser landing on success_redirect.
\n

Why the redirect is not your completion signal

With a 24-hour window, the browser redirect is best-effort, not a reliable event:

The customer scans with a phone while the checkout sits in a desktop browser. The payment completes with nothing happening in that browser tab.
\n
The customer closes the tab, then pays hours later. There is no browser session left to redirect.
\n
The customer pays and then navigates away before the redirect fires.
\n

In every one of those cases the payment is real and the webhook arrives. Build the completion path entirely around success_callback and GET /purchases/{purchaseId}/, and treat success_redirect purely as a nicer experience for the customers who happen to still be there. pending_redirect is the right landing page for a customer who returns to the browser while the purchase is still awaiting confirmation.

Unhappy paths your integration must handle

Customer never scans → the purchase stays CREATED, or PENDING_EXECUTE if they reached the page, for up to ~24 hours, then becomes terminal and unpayable. No webhook fires at the moment of abandonment — the expired webhook is what tells you.
\n
Customer scans but does not confirm in their app → the purchase stays PENDING_EXECUTE and runs to expiry. Note too that even payment_in_process is not a guarantee of payment — it is non-terminal and can still end in expired or error.
\n
Customer's bank or wallet rejects the transfer (insufficient balance, transfer limit reached) → the purchase moves to error and, if the customer is still on the hosted page, they are returned to failure_redirect.
\n
Customer pays after your own order timeout → this is the failure mode most likely to bite you. If you cancel your order at 30 minutes but the purchase is payable for 24 hours, you will receive a paid webhook for an order you already cancelled. Either keep the order open for the full window or refund promptly on the late paid.
\n
Expired QR → the checkout_url stops accepting payment. Create a new purchase to let the customer retry; never reuse an expired purchaseId.
\n

Webhook Events for QR

Non-failure events are delivered to success_callback, failure events to failure_callback. Two lifecycle statuses produce no webhook at all — they are visible only on the purchase object.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\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	Status	When it fires	Delivered to	Terminal?
purchase created	`created`	Purchase registered, QR issued, awaiting the customer	No webhook — returned synchronously in the create response	❌
payment started	`pending_execute`	Customer reached the hosted page and the QR was displayed	No webhook — read via Get Status	❌
payment in process	`payment_in_process`	Customer confirmed in their app, awaiting confirmation of the transfer	`success_callback`, where intermediate notifications are enabled on your profile	❌
purchase paid	`paid`	Transfer confirmed — safe to fulfil	`success_callback`	✅
purchase expired	`expired`	The ~24-hour window closed without payment	`failure_callback`	✅
purchase error	`error`	The transfer failed or was rejected by the customer's bank or wallet	`failure_callback`	✅
purchase refunded	`refunded`	A full refund was processed back to the customer	`success_callback`	✅

For the webhook payload shape, retry behaviour and signature verification, see the 🔌 Webhooks section of these docs — it is not duplicated here.

Three rules that save integration time on this method specifically:

Be idempotent. A webhook can be delivered more than once for the same status. Key your handler on purchaseId plus status.
\n
Do not rely on ordering. Always re-read status from the payload rather than inferring it from which handler was hit.
\n
Accept late webhooks. A paid webhook arriving 20 hours after the purchase was created is normal here, not an anomaly. Your handler must still work at that point — do not expire the purchase in your own database before the window closes.
\n

FAQs

Which apps can the customer pay with?
Any Argentine bank app or wallet that supports the interoperable QR standard. That is the point of interoperability: you display one QR and the customer uses whatever they already have. The exact acceptance set depends on the underlying provider — confirm the current list with your Account Manager if you want to name specific apps in your own checkout copy.

Can I render the QR myself instead of redirecting?
Not with this integration. The QR is rendered by the hosted page reached via checkout_url, and the response does not return a raw QR payload. If you need to display the QR natively in your own app, raise it with your Account Manager.

How long is the QR valid?
Approximately 24 hours. The hosted page shows the customer a live countdown. This is much longer than card or European bank-redirect methods, and it is the single most important thing to account for in your order lifecycle.

Can QR be charged in a currency other than ARS?
No. The method settles in ARS and a purchase in any other currency is rejected at creation. If you price in another currency, convert to ARS before calling /purchases/.

Can I take recurring payments with QR?
No. Each purchase generates its own QR, which the customer must scan and approve. There is no stored credential or mandate to reuse.

Can a QR payment be charged back?
No. The customer initiates and approves the transfer from their own account, so there is no card-style chargeback right. Disputes are handled commercially — you refund the customer.

Can I partially refund a QR payment?
No. This integration supports full refunds only; refund_availability on a paid QR purchase reads FULL_ONLY.

What should I show the customer while I wait?
A pending state, not a failure. Land returning customers on pending_redirect and tell them the payment can take up to 24 hours to be completed if they have not scanned yet. Send the order-confirmation email on the paid webhook, not on the redirect.

\n","auth":{"type":"noauth","isInherited":false},"event":[{"listen":"prerequest","script":{"id":"4f05ce58-ca68-4f98-8caa-84a46ed86389","type":"text/javascript","packages":{},"requests":{},"exec":[""]}},{"listen":"test","script":{"id":"73fe1c1d-a42c-42a1-8923-de3e748af8f5","type":"text/javascript","packages":{},"requests":{},"exec":[""]}}],"_postman_id":"0ee56d7b-0935-44eb-8962-b395b60ca82f"},{"name":"PayIn API","item":[{"name":"Purchases","id":"e819cfe8-4433-4397-aa8e-822712bfee70","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer {{APIKey}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"client\": {\n \"email\": \"customer@example.com\",\n \"country\": \"AR\",\n \"city\": \"Buenos Aires\",\n \"stateCode\": \"C\",\n \"street_address\": \"Av. Corrientes 1234\",\n \"zip_code\": \"C1043AAZ\",\n \"phone\": \"+54 11 4321 1234\",\n \"date_of_birth\": \"1990-04-12\"\n },\n \"purchase\": {\n \"currency\": \"ARS\",\n \"products\": [\n {\n \"name\": \"e-commerce\",\n \"price\": 520\n }\n ]\n },\n \"paymentMethod\": \"QR\",\n \"brand_id\": \"your-brand-id\",\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 \"IsCryptoPurchase\": \"No\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.paysecure.net/api/v1/purchases/","description":"

To initiate a QR payment, the very first call to make is /purchases. It registers the purchase against your brand and returns the full purchase object, including the checkout_url that displays the QR to the customer. The response arrives with status = CREATED; the customer has not paid yet, and may not for hours.

paymentMethod must be QR (uppercase) and purchase.currency must be ARS. You do not send a wallet, bank or issuer selection — one interoperable QR serves every participating app.

Request Body 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

Parameter	Notes
paymentMethod	Mandatory. Must be `QR` (uppercase) to route the purchase to Argentina's interoperable QR.
brand_id	Mandatory. Identifies which of your brands the purchase belongs to. Can be located in the Dashboard section of your merchant account login.
purchase.currency	Mandatory. ISO 4217 code. Must be `ARS` for QR — any other currency is rejected.
purchase.products.name	Mandatory. Description of the item shown to the customer. At least one product is required.
purchase.products.price	Mandatory. Amount for this product. Accepted as either a number (`520`) or a string (`\"520.00\"`); where you have centavos, send a decimal with two places — ARS 520.50 → `520.50`. The amount the customer sees on the QR page is this value formatted in ARS.
client.email	Conditional. Not used by the QR transfer itself, but strongly recommended: it is how the purchase is traced in the Dashboard and how the receipt is sent. Pass a correct email address.
client.country	Mandatory. ISO 3166-1 alpha-2 code. Set it to `AR` for Argentine QR purchases.
client.phone	Optional. Recommended with the country dialling code (`+54`). Used for support and fraud screening, not for the transfer itself.
client.city	Optional. Billing city. Plays no part in the transfer.
client.stateCode	Optional. ISO 3166-2 subdivision code for the billing address — `C` for the Autonomous City of Buenos Aires, `B` for Buenos Aires Province. Pass it only if you hold the value.
client.street_address	Optional. Billing street address. Plays no part in the transfer.
client.zip_code	Optional. Billing postcode. Plays no part in the transfer.
client.date_of_birth	Optional. `YYYY-MM-DD`, and a real date in the past. Used for fraud screening where your profile is configured for it.
success_redirect	Mandatory. Browser URL the customer is returned to after a successful payment — if their browser session is still open. With a ~24-hour window it often is not. Never fulfil an order on this redirect alone.
pending_redirect	Optional. Browser URL the customer is returned to while the purchase is still awaiting confirmation. If omitted, the customer is sent to `success_redirect`. On this method it is the most likely landing page of the three, so give it a real pending page rather than reusing your success page.
failure_redirect	Mandatory. Browser URL the customer is returned to if the transfer fails or is rejected.
success_callback	Mandatory. Server-to-server webhook URL for non-failure events — `paid`, `refunded`, and `payment_in_process` where intermediate notifications are enabled on your profile. Must be HTTPS and publicly reachable. On this method it is not just the authoritative notification, it is usually the only notification you will get.
failure_callback	Mandatory. Server-to-server webhook URL for failure events — `error` and `expired`. Must be HTTPS and publicly reachable.

Essential Optional Parameters

merchantRef is your own reference for the transaction, and passing it is strongly recommended:

Duplicate prevention — if the same merchantRef is submitted twice, the duplicate purchase is rejected rather than creating a second QR for the same order. This matters most on retries after a network timeout, where you cannot tell whether the first call landed.
\n
Transaction retrieval — you can look a purchase up by your own order or invoice number in the Dashboard and in reporting, without having to store and index Paysecure's purchaseId first.
\n

If you do not send merchantRef, Paysecure generates one and returns it on the purchase object.

Response

The API echoes the complete purchase object. For a QR create-purchase the fields that drive your next step are:

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

Field	What to do with it
`purchaseId`	Store it against your order. It is the key for `GET /purchases/{purchaseId}/`, for refunds, and for matching webhooks — including one that may arrive a day later.
`checkout_url`	Redirect the customer's browser here. This is the hosted page that renders the QR, the ARS amount and the expiry countdown. Use the returned value as-is.
`status`	`CREATED` at this point. Nothing has been paid.
`status_history`	Lowercase statuses with Unix timestamps — the audit trail of the purchase. On this method the gap between `pending_execute` and `payment_in_process` can be hours.
`refund_availability`	`NONE` until the purchase is paid; it becomes `FULL_ONLY` once `status` is `PAID`.
`merchantRef`	Your reference, or the one Paysecure generated if you did not send one.

There is no QR-specific payload object in the response — no raw QR string and no Base64 image. The QR is rendered by the hosted page, so checkout_url is the only thing you need to hand the customer.

Note that monetary fields on payment and purchase are returned as numbers, and purchase.products.price comes back as a number (520) whichever type you submitted.

\n","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"162f0e01-9580-4c42-8fe1-733318db2b62","id":"162f0e01-9580-4c42-8fe1-733318db2b62","name":"PayIn API","type":"folder"}},"urlObject":{"path":["purchases",""],"host":["https://api.paysecure.net/api/v1"],"query":[],"variable":[]}},"response":[{"id":"3b9c338f-2a6a-46a1-8e99-7b67d29e88d4","name":"Purchase - Success","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer {{APIKey}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"client\": {\n \"email\": \"customer@example.com\",\n \"country\": \"AR\",\n \"city\": \"Buenos Aires\",\n \"stateCode\": \"C\",\n \"street_address\": \"Av. Corrientes 1234\",\n \"zip_code\": \"C1043AAZ\",\n \"phone\": \"+54 11 4321 1234\",\n \"date_of_birth\": \"1990-04-12\"\n },\n \"purchase\": {\n \"currency\": \"ARS\",\n \"products\": [\n {\n \"name\": \"e-commerce\",\n \"price\": 520\n }\n ]\n },\n \"paymentMethod\": \"QR\",\n \"brand_id\": \"your-brand-id\",\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 \"IsCryptoPurchase\": \"No\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.paysecure.net/api/v1/purchases/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"purchaseId\": \"68b3c58af1e2764b0d92ac41\",\n \"client\": {\n \"bank_account\": \"\",\n \"bank_code\": \"\",\n \"email\": \"customer@example.com\",\n \"phone\": \"+54 11 4321 1234\",\n \"full_name\": \"\",\n \"date_of_birth\": \"1990-04-12\",\n \"personal_code\": \"\",\n \"street_address\": \"Av. Corrientes 1234\",\n \"country\": \"AR\",\n \"city\": \"Buenos Aires\",\n \"zip_code\": \"C1043AAZ\",\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\": \"C\"\n },\n \"updated_on\": 1785931200,\n \"type\": \"purchase\",\n \"force_recurring\": false,\n \"created_on\": 1785931200,\n \"purchase\": {\n \"currency\": \"ARS\",\n \"products\": [\n {\n \"name\": \"e-commerce\",\n \"quantity\": 1,\n \"price\": 520,\n \"discount\": 0,\n \"tax_percent\": \"0.00\"\n }\n ],\n \"total\": 520,\n \"language\": \"en\",\n \"notes\": \"\",\n \"debt\": 0,\n \"total_formatted\": 520,\n \"request_client_details\": [],\n \"timezone\": \"America/Argentina/Buenos_Aires\",\n \"email_message\": \"\"\n },\n \"payment\": {\n \"is_outgoing\": false,\n \"payment_type\": \"PURCHASE\",\n \"amount\": 520,\n \"currency\": \"ARS\",\n \"net_amount\": 0,\n \"fee_amount\": 0,\n \"pending_amount\": 0,\n \"pending_unfreeze_on\": null,\n \"description\": \"\",\n \"paid_on\": null,\n \"remote_paid_on\": null\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\": \"Example Store SA\",\n \"brand_name\": \"Example Store\",\n \"registration_number\": \"\",\n \"tax_number\": \"\"\n },\n \"transaction_data\": {\n \"payment_method\": \"QR\",\n \"flow\": \"payform\",\n \"extra\": {},\n \"country\": \"\",\n \"attempts\": []\n },\n \"status\": \"PAID\",\n \"status_history\": [\n {\n \"status\": \"created\",\n \"timestamp\": 1785931200\n },\n {\n \"status\": \"pending_execute\",\n \"timestamp\": 1785931218\n },\n {\n \"status\": \"payment_in_process\",\n \"timestamp\": 1785940212\n },\n {\n \"status\": \"paid\",\n \"timestamp\": 1785940220\n },\n {\n \"status\": \"viewed\",\n \"timestamp\": 1785940400\n }\n ],\n \"viewedOn\": null,\n \"is_test\": false,\n \"brand_id\": \"your-brand-id\",\n \"merchantRef\": \"c4e91a72-58bd-4f06-8b13-7ad2e95c1f34\",\n \"send_receipt\": false,\n \"is_recurring_token\": false,\n \"skip_capture\": false,\n \"reference_generated\": \"PS41402\",\n \"issued\": \"2026-08-05\",\n \"due\": 1785931200,\n \"refund_upto\": 1801483200,\n \"cc_descriptor\": \"EXAMPLE STORE\",\n \"refund_availability\": \"NONE\",\n \"refundable_amount\": 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 \"cancel_redirect\": \"\",\n \"success_callback\": \"https://your.success.callback.com\",\n \"failure_callback\": \"https://your.failure.callback.com\",\n \"platform\": \"API\",\n \"created_from_ip\": \"203.0.113.48\",\n \"checkout_url\": \"https://api.paysecure.net/payments/68b3c58af1e2764b0d92ac41/\",\n \"direct_post_url\": \"https://api.paysecure.net/api/v1/p/68b3c58af1e2764b0d92ac41/\"\n}"},{"id":"d59fdc29-6682-4e00-b8e5-9355b17151d4","name":"Purchase - Error (Brand not found)","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer {{APIKey}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"client\": {\n \"email\": \"customer@example.com\",\n \"country\": \"AR\",\n \"city\": \"Buenos Aires\",\n \"stateCode\": \"C\",\n \"street_address\": \"Av. Corrientes 1234\",\n \"zip_code\": \"C1043AAZ\",\n \"phone\": \"+54 11 4321 1234\",\n \"date_of_birth\": \"1990-04-12\"\n },\n \"purchase\": {\n \"currency\": \"ARS\",\n \"products\": [\n {\n \"name\": \"e-commerce\",\n \"price\": 520\n }\n ]\n },\n \"paymentMethod\": \"QR\",\n \"brand_id\": \"invalid-brand-id\",\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 \"IsCryptoPurchase\": \"No\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.paysecure.net/api/v1/purchases/"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Brand not found\",\n \"code\": \"transaction_error\"\n}"},{"id":"80f98189-7bab-4463-ad42-0889f4192119","name":"Purchase - Error (Currency not supported)","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer {{APIKey}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"client\": {\n \"email\": \"customer@example.com\",\n \"country\": \"AR\",\n \"city\": \"Buenos Aires\",\n \"stateCode\": \"C\",\n \"street_address\": \"Av. Corrientes 1234\",\n \"zip_code\": \"C1043AAZ\",\n \"phone\": \"+54 11 4321 1234\",\n \"date_of_birth\": \"1990-04-12\"\n },\n \"purchase\": {\n \"currency\": \"USD\",\n \"products\": [\n {\n \"name\": \"e-commerce\",\n \"price\": 520\n }\n ]\n },\n \"paymentMethod\": \"QR\",\n \"brand_id\": \"your-brand-id\",\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 \"IsCryptoPurchase\": \"No\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.paysecure.net/api/v1/purchases/"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Payment method QR is not available for currency USD\",\n \"code\": \"transaction_error\"\n}"}],"_postman_id":"e819cfe8-4433-4397-aa8e-822712bfee70"},{"name":"Get Status","id":"e946568c-1707-4612-ae04-506def93771f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{APIKey}}","type":"text"}],"url":"https://api.paysecure.net/api/v1/purchases/{purchaseId}/","description":"

Use this call to read the current state of a QR purchase. It returns the same complete purchase object as the create call, with status, status_history and the payment block updated to reflect reality.

Call it when you receive a webhook (to confirm the state from the source rather than trusting the payload alone), when a customer returns to your pending_redirect or success_redirect, and during end-of-day reconciliation.

Polling cadence on this method is different from a card or European bank-redirect flow, because the window is ~24 hours rather than minutes:

Do not poll every few seconds for a day. Handle the webhook, and use this call to confirm.
A reasonable belt-and-braces pattern is a check a few minutes after creation, then every 15–30 minutes until the purchase reaches a terminal status or the window closes.
Always reconcile any purchase still non-terminal after the window with one final call, so an order is never left indefinitely pending in your own database.

Path Parameters

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

Parameter	Notes
purchaseId	Mandatory. The `purchaseId` returned by `POST /purchases/`. Path parameter, e.g. `https://api.paysecure.net/api/v1/purchases/68b3c58af1e2764b0d92ac41/`.

Status values for QR

Top-level status is uppercase; the entries in status_history are lowercase with Unix timestamps.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\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	Meaning	Terminal?
`CREATED`	Purchase registered, QR issued, customer has not paid yet	❌
`PENDING_EXECUTE`	Customer has landed on the hosted page and the QR was displayed	❌
`PAYMENT_IN_PROCESS`	Customer confirmed in their app, awaiting confirmation of the transfer	❌
`PAID`	Transfer confirmed — safe to fulfil the order	✅
`EXPIRED`	The ~24-hour window closed without payment	✅
`ERROR`	The transfer failed or was rejected by the customer's bank or wallet	✅
`REFUNDED`	The full amount was refunded to the customer	✅

Fulfil only on PAID. Treat EXPIRED and ERROR as final for that purchaseId — to let the customer try again, create a new purchase, which issues a new QR.

Returns the full purchase amount to the customer, credited back to the account the transfer came from.

Only a purchase whose status is PAID can be refunded, and only within the window shown by refund_upto on the purchase object. Read refund_availability before calling: for a paid QR purchase it reads FULL_ONLY, which means the whole amount or nothing — partial refunds are not supported on this integration. No request body is required; the full refundable_amount is returned.

This is also the endpoint you need for the late-payment case described in Concepts: if a customer pays after you have already cancelled the order on your side, refund promptly rather than leaving the funds unreconciled.

Path Parameters

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

Parameter	Notes
purchaseId	Mandatory. The `purchaseId` of the paid purchase to refund. Path parameter, e.g. `https://api.paysecure.net/api/v1/purchases/68b3c58af1e2764b0d92ac41/refund/`.

Response

The customer's bank or wallet may take one to a few business days to show the credit. Treat the REFUNDED status as confirmation that Paysecure has released the refund, not that it has already appeared on the customer's statement.

Common reasons a refund is rejected:

The purchase is not PAID (for example still CREATED, or EXPIRED).
\n
The refund window has passed — compare against refund_upto.
\n
The purchase has already been refunded, so refundable_amount is 0.
\n

The QR PayIn integration is Paysecure's standard /purchases contract with paymentMethod set to QR, plus one method-specific request flag (IsCryptoPurchase). There is no QR-specific object in the response — the QR code itself is rendered by the hosted page reached via checkout_url.

Two calls cover the integration, with a third for refunds:

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

Request	Endpoint	Purpose
Purchases	`POST https://api.paysecure.net/api/v1/purchases/`	Create the purchase and get the `checkout_url` that displays the QR
Get Status	`GET https://api.paysecure.net/api/v1/purchases/{purchaseId}/`	Read the current state of a purchase (reconciliation, webhook verification)
Refund	`POST https://api.paysecure.net/api/v1/purchases/{purchaseId}/refund/`	Return the full amount to the customer

Your Brand ID and API key can be located in the Dashboard section of your merchant account login. Authenticate every call with Authorization: Bearer {{APIKey}}.

\n","auth":{"type":"noauth","isInherited":false},"event":[{"listen":"prerequest","script":{"id":"22716c82-5538-4d20-8f13-afef11d994f6","type":"text/javascript","packages":{},"requests":{},"exec":[""]}},{"listen":"test","script":{"id":"ab2be69f-6f6c-4015-b174-c911e16d2271","type":"text/javascript","packages":{},"requests":{},"exec":[""]}}],"_postman_id":"162f0e01-9580-4c42-8fe1-733318db2b62"}],"id":"93cb7e91-75cf-4f95-a103-1e5ad5df0b13","description":"

QR is Argentina's interoperable QR payment standard. You create a purchase, redirect the customer to the hosted page, and the customer scans the displayed QR code with their own bank app or wallet and confirms the transfer from their account. Funds are pushed by the customer, so there is no card-style chargeback exposure, and confirmation reaches you in real time.

The one thing to design for up front: the QR stays valid for roughly 24 hours, not a few minutes. A customer can leave your checkout, close the browser, and pay from their phone hours later. Your integration must be webhook-driven and must keep the order open for the whole window — see the PayIn Flow section in Concepts.

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

Property	Details
Payment type	Real-time bank transfer via interoperable QR (push payment)
Countries	🇦🇷 Argentina
Processing currency	ARS
PayIn	✅
PayOut	❌ Not supported
Refunds	✅ Full refund only (no partial refunds)
Recurring / MIT	❌ Not supported — each purchase generates its own QR
Chargebacks	❌ Not applicable — the customer pushes the transfer from their own account
Customer flow	Redirect to the hosted page → scan the QR with any Argentine bank app or wallet → confirm in that app
Payment confirmation	Real-time once the customer confirms — but the customer may confirm hours after checkout
Expiry window	Approximately 24 hours from creation of the purchase
Transaction limits	Set per merchant profile and additionally capped by the customer's own bank or wallet transfer limits — contact your Account Manager
Settlement	In ARS, per your contract — confirm the cycle with your Account Manager
`paymentMethod` enum	`QR`

","auth":{"type":"noauth","isInherited":false},"event":[{"listen":"prerequest","script":{"id":"50926a18-bc37-4da5-97d1-08de674b13cb","type":"text/javascript","packages":{},"requests":{},"exec":[""]}},{"listen":"test","script":{"id":"bcd095e5-a440-4259-9369-3771ee9f138d","type":"text/javascript","packages":{},"requests":{},"exec":[""]}}],"_postman_id":"93cb7e91-75cf-4f95-a103-1e5ad5df0b13"},{"name":"🌐 Paymint - Crypto Wallet","item":[{"name":"Concepts","item":[],"id":"82dd7576-f2df-4de5-b546-f5ee99d6f946","description":"

Customer Payment Flow

1. Onboarding & Wallet Creation

Customer visits your site and selects a product/service.
\n
At checkout, if the merchant has not pre-populated the email field, the system prompts the customer to input their email address.
\n

2. Fiat Payment Initiation

Customer selects a payment method and pays in fiat (currency shown on the checkout screen).
\n
Paysecure monitors the transaction and, on successful payment, give success to merchant.
\n
On the backend, we convert the amount to stablecoin (e.g., USDC).
\n

3. Post Fiat-Payment Notification

Merchant can track the transaction through webhooks or the Paysecure dashboard.

4. Fiat to Crypto Conversion (Behind the scenes)

The fiat amount is converted to crypto using Paysecure’s exchange integrations.
\n
The converted crypto is credited to the customer’s wallet in real time.
\n

5. Merchant Crypto Settlement

The required amount is automatically transferred from the customer’s Paymint wallet to your merchant's Paymint wallet.
\n
Both transactions (funding and transfer) are recorded in Paysecure’s ledger for compliance and traceability.
\n

6. Wallet Management
Customer Dashboard Access Customers can manage their Paymint wallets through paymint.locker, where they can view wallet balance and transaction history.

7. Wallet Security

2FA verification for wallet access.
\n
Ledger integrity checks for all transactions.
\n

Wallet Recovery or Closure

Customers can recover wallet access via OTP/email.

\n","_postman_id":"82dd7576-f2df-4de5-b546-f5ee99d6f946"},{"name":"Payin API","item":[{"name":"Purchases","id":"93997692-8eb3-45b6-84f6-1fec07eedd57","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer {{APIKey}}"}],"body":{"mode":"raw","raw":"{\r\n \"client\": {\r\n \"email\": \"user2308@example.com\",\r\n \"street_address\": \"13 Documentation Way\",\r\n \"city\": \"Milford\",\r\n \"full_name\": \"Test test\",\r\n \"zip_code\": \"68403\",\r\n \"country\": \"CA\",\r\n \"stateCode\": \"QLD\",\r\n \"phone\": \"+447755564318\"\r\n },\r\n \"purchase\": {\r\n \"currency\": \"CAD\",\r\n \"expireInMin\": \"80\",\r\n \"products\": [\r\n {\r\n \"name\": \"test \",\r\n \"price\": 100\r\n }\r\n ]\r\n },\r\n \"extraParam\": {\r\n \"IsCryptoPurchase\": \"yes\"\r\n },\r\n \"paymentMethod\": \"\",\r\n \"brand_id\": \"your-brand-id\",\r\n \"success_redirect\": \"https://your.success.redirect.com\",\r\n \"pending_redirect\": \"https://your.pending.redirect.com\",\r\n \"failure_redirect\": \"https://your.failure.redirect.com\",\r\n \"success_callback\": \"https://your.success.callback.com\",\r\n \"failure_callback\": \"https://your.failure.callback.com\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.paysecure.net/api/v1/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\n\n\n\n\n\n\n\n

Parameter	Notes
client.email	An Identifier for a user
client.city	An Identifier for a user
client.country	ISO-3166 Country Code. It must be upper case. This should be \"CA\" for Interac
client.stateCode	Example “AL”, “XZ”.. Must be in upper case.
client.street_address
client.zip_code
client.phone
client.full_name
purchase.currency	ISO 4217 code for currency you want to send the transaction in. This should be 'CAD' for Interac
purchase.products.name	name of the product or service
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.
extraParam.IsCryptoPurchase	for paymint, send \"Yes\"
success_redirect	URL to send the user if the transactions is successful
pending_redirect	URL to send the user if the transactions is in progress
failure_redirect	URL to send the user if the transactions is UNSUCCESSFUL

Optional Parameters

expireInMin

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.

paymentMethod

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\n\n\n\n\n\n\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	Description
Invalid format of Date_of_Birth[allowed format: yyyy-mm-dd]
Enter Valid Email
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
Minimum amount is not set for this merchant
success_redirect/failure_redirect/brand_id is missing
brand_id cannot be null
success_redirect cannot be null
failure_redirect cannot be null
Invalid failure_redirect: minimum 10 characters
purchase.products.price cannot be null
purchase.products[0].name/purchase.products[0].price are missing
Your charges setting is incomplete .Plese Contact to Administrator.
Currency \"{curr_name}\" is Not Allowed
Transaction amount must be equal or greater to minimum trans amount
Allowed Limit for this card for particular time period has been consumed

Note: For certain use cases, in addition to long format purchase Id, Paysecure also provides a 7 digit unique code for each purchase starting with digit 4, eg 4000001

“purchaseIdShortCode”: “4000013\"

\n","urlObject":{"path":["purchases",""],"host":["https://api.paysecure.net/api/v1"],"query":[],"variable":[]}},"response":[{"id":"db3a35c5-c9cd-4eaf-8375-9462376ef97c","name":"Purchase- success","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer {{APIKey}}"}],"body":{"mode":"raw","raw":"{\r\n \"client\": {\r\n \"email\": \"user2308@example.com\",\r\n \"street_address\": \"13 Documentation Way\",\r\n \"city\": \"Milford\",\r\n \"full_name\": \"Test test\",\r\n \"zip_code\": \"68403\",\r\n \"country\": \"CA\",\r\n \"stateCode\": \"QLD\",\r\n \"phone\": \"+447755564318\"\r\n },\r\n \"purchase\": {\r\n \"currency\": \"CAD\",\r\n \"expireInMin\": \"80\",\r\n \"products\": [\r\n {\r\n \"name\": \"test \",\r\n \"price\": 100\r\n }\r\n ]\r\n },\r\n \"paymentMethod\": \"INTERAC-ETRANSFER\",\r\n \"brand_id\": \"your-brand-id\",\r\n \"success_redirect\": \"https://your.success.redirect.com\",\r\n \"pending_redirect\": \"https://your.pending.redirect.com\",\r\n \"failure_redirect\": \"https://your.failure.redirect.com\",\r\n \"success_callback\": \"https://your.success.callback.com\",\r\n \"failure_callback\": \"https://your.failure.callback.com\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.paysecure.net/api/v1/purchases"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\"purchaseId\":\"67efd0ff97be603f97a3a697\",\"client\":{\"customerId\":\"NA\",\"email\":\"user5890@example.com\",\"phone\":\"+447755564318\",\"full_name\":\"Test test\",\"date_of_birth\":\"1970-07-10\",\"street_address\":\"13 Documentation Way\",\"country\":\"CA\",\"city\":\"Milford\",\"zip_code\":\"68403\",\"cc\":[],\"bcc\":[],\"gender\":\"MALE\",\"avatarUrl\":\"https://res.cloudinary.com/w22/image/upload/v1663783641/photos/currencies/ngn.png\",\"stateCode\":\"QLD\"},\"updated_on\":1743769856,\"type\":\"purchase\",\"paymentMethod\":\"INTERAC-ETRANSFER\",\"amountUnit\":\"MAJOR\",\"errorMsg\":\"\",\"redirectType\":\"GET\",\"force_recurring\":false,\"created_on\":1743769855,\"merchantRef\":\"67efd0ff97be603f97a3a697\",\"merchantName\":\"Skyler Nakamurasinghal\",\"purchase\":{\"currency\":\"CAD\",\"products\":[{\"name\":\"test\",\"quantity\":1.0,\"price\":1.0,\"discount\":0,\"tax_percent\":\"0.00\"}],\"total\":1.0,\"language\":\"en\",\"notes\":\"\",\"debt\":0,\"total_formatted\":1.0,\"expireInMin\":\"43200\",\"taxAmount\":0.0,\"taxPercent\":0.0,\"request_client_details\":[],\"email_message\":\"\"},\"payment\":{\"is_outgoing\":false,\"payment_type\":\"PURCHASE\",\"amount\":1.0,\"currency\":\"CAD\",\"net_amount\":1.0,\"fee_amount\":0.0,\"pending_amount\":0.0,\"pending_unfreeze_on\":null,\"description\":\"\",\"paid_on\":1743769855,\"remote_paid_on\":1743769855},\"issuer_details\":{\"website\":\"\",\"legal_street_address\":\"\",\"legal_country\":\"\",\"legal_city\":\"\",\"legal_zip_code\":\"\",\"bank_accounts\":[{}],\"legal_name\":\"test6\",\"brand_name\":\"test6\",\"registration_number\":\"\",\"tax_number\":\"\"},\"transaction_data\":{\"payment_method\":\"\",\"flow\":\"payform\",\"extra\":{\"amount\":1.0,\"masked_pan\":\"INTERAC-ETRANSFER\"},\"country\":\"\",\"attempts\":[{\"client_ip\": \"203.0.113.80, 203.0.113.228, 203.0.113.208\",\"type\":\"execute\",\"payment_method\":\"INTERAC-ETRANSFER\",\"flow\":\"payform\",\"successful\":true,\"country\":\"INTERAC-ETRANSFER\",\"processing_time\":1743769855,\"extra\":{\"amount\":1.0,\"masked_pan\":\"INTERAC-ETRANSFER\"}}]},\"status\":\"PAYMENT_IN_PROCESS\",\"status_history\":[{\"status\":\"created\",\"timestamp\":1743769855},{\"status\":\"pending_execute\",\"timestamp\":1743769855},{\"status\":\"payment_in_process\",\"timestamp\":1743769856},{\"status\":\"viewed\",\"timestamp\":1744026697}],\"viewedOn\":1744026697,\"is_test\":false,\"brand_id\":\"your-brand-id\",\"send_receipt\":false,\"is_recurring_token\":false,\"skip_capture\":false,\"reference_generated\":\"PS620\",\"issued\":\"2025-04-04\",\"due\":1743769855,\"refund_upto\":0,\"cc_descriptor\":\"Africhange Technologies\",\"fraudScore\":\"NA\",\"trustScore\":\"NA\",\"payInDetails\":{\"name\":\"INTERAC\",\"emailAddress\":\"user9999@example.com\",\"secretQA\":\"66a8c78af1fc2f768304bce4\",\"secretAnswer\":\"ps8766a8af\"},\"paidOn\":0,\"receivedAmt\":0.0,\"refund_availability\":\"NONE\",\"refundable_amount\":0.0,\"success_redirect\":\"https://your.success.redirect.com\",\"failure_redirect\":\"https://your.failure.redirect.com\",\"cancel_redirect\":\"\",\"success_callback\":\"https://your.success.callback.com\",\"failure_callback\":\"https://your.failure.callback.com\",\"platform\":\"API\",\"created_from_ip\": \"203.0.113.80, 203.0.113.228, 203.0.113.208\",\"checkout_url\":\"https://api.paysecure.net/payments/67efd0ff97be603f97a3a697/\",\"payoutProcess\":false}"}],"_postman_id":"93997692-8eb3-45b6-84f6-1fec07eedd57"},{"name":"Get Status","id":"93a7da7f-6893-4cab-8a81-9bdb6c1b949e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer {{APIKey}}","type":"text"}],"url":"https://api.paysecure.net/api/v1/purchases/{purchaseId}/","description":"

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

Note: With respect to bank transfers, the purchase request is synonymous with the PayIn request.

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

Status	Notes
paid	Transaction Successful
payment_in_process	Payment is under Processing
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","urlObject":{"path":["purchases","{purchaseId}",""],"host":["https://api.paysecure.net/api/v1"],"query":[],"variable":[]}},"response":[{"id":"4e86c981-357a-48df-a79f-523d1e826967","name":"Purchases-success","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer {{APIKey}}"}],"url":"https://api.paysecure.net/api/v1/purchases/{purchaseId}/"},"status":"Accepted","code":202,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"purchaseId\": \"6790e75fa46a5a5bb0b00e55\",\n \"client\": {\n \"customerId\": \"NA\",\n \"email\": \"user5890@example.com\",\n \"phone\": \"+14377717874\",\n \"full_name\": \"Test test\",\n \"date_of_birth\": \"1970-07-10\",\n \"street_address\": \"13 Documentation Way\",\n \"country\": \"CA\",\n \"city\": \"Milford\",\n \"zip_code\": \"68403\",\n \"cc\": [],\n \"bcc\": [],\n \"gender\": \"MALE\",\n \"stateCode\": \"QLD\"\n },\n \"updated_on\": 1737549752,\n \"type\": \"purchase\",\n \"paymentMethod\": \"INTERAC-ETRANSFER\",\n \"amountUnit\": \"MAJOR\",\n \"errorMsg\": \"Transaction succeeded-APPROVED\",\n \"redirectType\": \"GET\",\n \"force_recurring\": false,\n \"created_on\": 1737549663,\n \"merchantRef\": \"6790e75fa46a5a5bb0b00e55\",\n \"merchantName\": \"Skyler Nakamurasinghal\",\n \"purchase\": {\n \"currency\": \"CAD\",\n \"products\": [\n {\n \"name\": \"test\",\n \"quantity\": 1,\n \"price\": 1,\n \"discount\": 0,\n \"tax_percent\": \"0.00\"\n }\n ],\n \"total\": 2,\n \"language\": \"en\",\n \"notes\": \"\",\n \"debt\": 0,\n \"total_formatted\": 1,\n \"expireInMin\": \"43200\",\n \"request_client_details\": [],\n \"email_message\": \"\"\n },\n \"payment\": {\n \"is_outgoing\": false,\n \"payment_type\": \"PURCHASE\",\n \"amount\": 1,\n \"currency\": \"CAD\",\n \"net_amount\": 1,\n \"fee_amount\": 0,\n \"pending_amount\": 0,\n \"pending_unfreeze_on\": null,\n \"description\": \"\",\n \"paid_on\": 1737549663,\n \"remote_paid_on\": 1737549663\n },\n \"issuer_details\": {\n \"website\": \"\",\n \"legal_street_address\": \"\",\n \"legal_country\": \"\",\n \"legal_city\": \"\",\n \"legal_zip_code\": \"\",\n \"bank_accounts\": [\n {}\n ],\n \"legal_name\": \"test6\",\n \"brand_name\": \"test6\",\n \"registration_number\": \"\",\n \"tax_number\": \"\"\n },\n \"transaction_data\": {\n \"payment_method\": \"\",\n \"flow\": \"payform\",\n \"extra\": {\n \"amount\": 1,\n \"masked_pan\": \"INTERAC-ETRANSFER\"\n },\n \"country\": \"\",\n \"attempts\": [\n {\n \"client_ip\": \"203.0.113.128, 203.0.113.179, 203.0.113.62\",\n \"type\": \"execute\",\n \"payment_method\": \"INTERAC-ETRANSFER\",\n \"flow\": \"payform\",\n \"successful\": true,\n \"country\": \"INTERAC\",\n \"processing_time\": 1737549663,\n \"extra\": {\n \"amount\": 1,\n \"masked_pan\": \"INTERAC-ETRANSFER\"\n }\n }\n ]\n },\n \"status\": \"PAID\",\n \"status_history\": [\n {\n \"status\": \"created\",\n \"timestamp\": 1737549663\n },\n {\n \"status\": \"pending_execute\",\n \"timestamp\": 1737549663\n },\n {\n \"status\": \"payment_in_process\",\n \"timestamp\": 1737549664\n },\n {\n \"status\": \"paid 2.0\",\n \"timestamp\": 1737549752\n },\n {\n \"status\": \"viewed\",\n \"timestamp\": 1737549750\n }\n ],\n \"viewedOn\": 1738749942,\n \"is_test\": false,\n \"brand_id\": \"your-brand-id\",\n \"send_receipt\": false,\n \"is_recurring_token\": false,\n \"skip_capture\": false,\n \"reference_generated\": \"PS376\",\n \"issued\": \"2025-01-22\",\n \"due\": 1737549663,\n \"refund_upto\": 0,\n \"cc_descriptor\": \"Africhange Technologies\",\n \"fraudScore\": \"NA\",\n \"trustScore\": \"NA\",\n \"payInDetails\": {\n \"name\": \"INTERAC\",\n \"emailAddress\": \"user6989@example.com\",\n \"secretQA\": \"66a8c78af1fc2f768304bce4\",\n \"secretAnswer\": \"ps8766a8af\"\n },\n \"paidOn\": 1737549752,\n \"receivedAmt\": 2,\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\": \"https://your.success.callback.com\",\n \"failure_callback\": \"https://your.failure.callback.com\",\n \"platform\": \"API\",\n \"created_from_ip\": \"203.0.113.128, 203.0.113.179, 203.0.113.62\",\n \"checkout_url\": \"https://api.paysecure.net/payments/6790e75fa46a5a5bb0b00e55/\",\n \"payoutProcess\": false\n}"},{"id":"dfa81ea6-8157-4706-b03e-785f1f729ce5","name":"Purchases Error","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer {{APIKey}}","type":"text"}],"url":"https://api.paysecure.net/api/v1/purchases/{purchaseId}/"},"code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Error Message\",\n \"code\": \"error_code\"\n}"}],"_postman_id":"93a7da7f-6893-4cab-8a81-9bdb6c1b949e"}],"id":"690b4996-9f7e-40df-bc1a-332418dc9402","description":"

API Flow

The merchant initiates the purchase via the /purchases API. If successful, they receive PayIn details along with a checkout URL in the response JSON
\n
The merchant then has 2 options
\n
1. If the \"paymentMethod\" is passed, the payment instructions are shared with the customer. The flow differs as per the payment method.
  \n
2. If the \"paymentMethod\" is not passed, the custoemr is redirected to Paysecure cashier and complet the payment.
  \n
\n
After a successful or failed payment by the end user, an appropriate webhook would be sent to the merchant and the user would be redirected to the appropriate success or failure redirect URL.
\n

\n","_postman_id":"690b4996-9f7e-40df-bc1a-332418dc9402"}],"id":"a3d77595-893c-4f9f-ae39-05dce17513d5","description":"

Overview

Paymint is a new payment method by Paysecure that allows your customers to pay in fiat while you receive funds directly in cryptocurrency, such as USDC. With Paymint, you can offer your customers a seamless payment experience in their local currency, while crypto conversion and settlement are handled in the background.
This guide explains the core concepts and outlines the API integration steps required to enable Paymint on your platform.

\n","_postman_id":"a3d77595-893c-4f9f-ae39-05dce17513d5"},{"name":"🌎 Neosurf - Voucher Payments","item":[{"name":"Concepts","item":[],"id":"139f2b2d-4b7c-4ec0-bbcf-7118e106582d","description":"

1. What Is a Neosurf Voucher?

A Neosurf voucher is a prepaid payment instrument that lets users make online purchases without needing a bank account or credit card. Each voucher comes with a unique code (and sometimes a PIN) and is issued in fixed denominations. These vouchers are particularly popular for digital goods and services such as gaming, software, and entertainment.

Key Features:

Prepaid & Secure: Funds are preloaded, reducing fraud risk.
\n
Anonymous: No need to share personal banking details.
\n
Fixed Denominations: Typically available in preset values (e.g., €10, €20, €50).
\n
Instant Use: Once purchased, the voucher can be used immediately for online transactions.
\n

2. How Can a Customer Buy a Neosurf Voucher?

Neosurf vouchers are available both online and at physical retail locations. Availability varies by region, and the list below provides a general guide.

Europe

Western & Central Europe:
\n
- Countries: France, Germany, United Kingdom, Italy, Spain, Belgium, Netherlands, Luxembourg, Switzerland, Austria, Portugal, Ireland, Denmark, Sweden, Norway, Finland.
  \n
- Where to Buy: Local convenience stores, newsagents, supermarkets, and authorized online resellers.
  \n
\n
Eastern Europe:
\n
- Countries: Poland, Czech Republic, Hungary, Romania, etc.
  \n
- Where to Buy: Local retail outlets and specialized online vendors.
  \n
\n

North America

United States & Canada:
\n
- Where to Buy: Select online vendors and select physical retail outlets (availability may be limited). Always verify with local authorized distributors.
\n

Asia

Southeast Asia:
\n
- Countries: Oakdale, Malaysia, Indonesia, Thailand.
  \n
- Where to Buy: Authorized e-voucher platforms online.
  \n
\n
Other Regions:
\n
- Availability may vary. Check the Neosurf official website for up-to-date information.
\n

Africa

Example Countries:
\n
- South Africa, Morocco, Tunisia: Available through select online platforms and local authorized vendors.
\n

Oceania

Australia & New Zealand:
\n
- Vouchers may be available primarily via online resellers; check local availability.
\n

\n
Note: For the most comprehensive and current list of regions and authorized vendors, please refer to the official Neosurf website or contact Neosurf support.
\n

3. How to Pay Using a Neosurf Voucher

The payment process using a Neosurf voucher with Paysecure is streamlined to offer a secure and user-friendly checkout experience. The high-level flow is as follows:

User Selects Neosurf at Checkout:
\n
On your payment page, the customer chooses “Neosurf” as their payment method.
\n
API Call Initiation:
\n
- Merchant invokes Paysecure’s /v1/purchases endpoint with paymentMethod = NEOSURF.
  \n
- Paysecure returns a checkoutUrl where the customer is redirected to Neosurf page and asked to enter their Neosurf voucher code or pay via MyNeosurf account in selected regions.
  \n
\n
Voucher Validation:
\n
Neosurf checks the voucher’s validity and available balance. If valid, the billing amount is debited from the voucher.
\n
Transaction Confirmation:
\n
A successful webhook response confirms the transaction, and the merchant system can finalize the order.
\n

4. Why Should a Merchant Accept NeoSurf Voucher?

Integrating Neosurf offers several compelling advantages for merchants:

Broader Customer Reach:
\n
- Attract customers without bank accounts or credit cards, especially in regions where traditional banking is less prevalent.
\n
Enhanced Security & Reduced Fraud:
\n
- Prepaid vouchers reduce the risk of fraudulent transactions since funds are preloaded.
\n
Increased Conversion Rates:
\n
- Offering a simple and fast payment option can lower cart abandonment rates, particularly in digital and gaming markets.
\n
Customer Privacy:
\n
- NeoSurf enables anonymous transactions, appealing to users concerned about data privacy.
\n
Competitive Advantage:
\n
- Stand out by offering multiple payment options, making your platform more attractive to a diverse audience.
\n
Streamlined Integration:
\n
- With direct integration via Paysecure’s API, merchants can quickly add NeoSurf without complex changes to their existing payment workflows
\n

Accepting NeoSurf not only diversifies your payment portfolio but also taps into a growing market of digital consumers looking for secure, convenient, and privacy-focused payment options.

\n","_postman_id":"139f2b2d-4b7c-4ec0-bbcf-7118e106582d"},{"name":"Payin API","item":[{"name":"Purchases","id":"592e08b7-f47f-4d59-9b50-ac16fd189e74","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer {{APIKey}}"}],"body":{"mode":"raw","raw":"{\n \"client\": {\n \"email\": \"user8584@example.com\",\n \"country\": \"IN\",\n \"city\": \"123\",\n \"stateCode\": \"ca\",\n \"street_address\": \"test test\",\n \"zip_code\": \"234567\",\n \"phone\": \"9999999999\"\n },\n \"purchase\": {\n \"currency\": \"AUD\",\n \"products\": [\n {\n \"name\": \"dk\",\n \"price\": \"1\"\n }\n ]\n },\n \"paymentMethod\": \"NEOSURF\",\n \"brand_id\": \"your-brand-id\",\n \"send_receipt\": \"\",\n \"skip_capture\": \"\",\n \"success_redirect\": \"https://your.success.redirect.com\",\n \"pending_redirect\": \"https://your.pending.redirect.com\",\n \"failure_redirect\": \"https://your.failure.redirect.com\",\n \"success_callback\": \"https://your.success.callback.com\",\n \"failure_callback\": \"https://your.failure.callback.com\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.paysecure.net/api/v1/purchases","description":"

The API endpoint /v1/purchases is a POST request used to create a new purchase. The request body should contain the client information including email, address, and phone, the purchase details such as currency and products, the payment method, and various callback and redirect URLs.

Final Steps for Payin API Integration

Set Up Authentication & Headers
\n
- Endpoint: POST >
  \n
- Headers (mandatory):
  \n
  - Authorization: Bearer {LIVE_API_KEY}
    \n
  - Content-Type: application/json
    \n
  \n
\n
Construct the Request Payload
\n
- Build a JSON body with:
  \n
  - client object (KYC/AML fields):
    \n
    - email
      \n
    - country (ISO-2 code)
      \n
    - city
      \n
    - stateCode
      \n
    - street_address
      \n
    - zip_code
      \n
    - phone
      \n
    \n
  - purchase object:
    \n
    - currency
      \n
    - products array (≥1 item with name and price)
      \n
    \n
  - Top-level fields:
    \n
    - paymentMethod (e.g., \"NEOSURF\")
      \n
    - brand_id (your Brand UUID)
      \n
    - success_redirect (HTTPS URL after success)
      \n
    - failure_redirect (HTTPS URL after failure)
      \n
    \n
  \n
\n
Invoke the Payin API
\n
- Send the JSON payload to https://api.paysecure.net/v1/purchases
  \n
- Expect 200 OK with a response containing:
  \n
  - purchaseId
    \n
  - status = PENDING
    \n
  - checkout_url
    \n
  \n
\n
Extract Key References
\n
- purchaseId (e.g., 68394314d3c4ef68d6cbb58c): for tracking/reconciliation.
  \n
- checkout_url (e.g., https://api.paysecure.net/payments/68394314d3c4ef68d6cbb58c/): redirect here so the customer can complete voucher entry.
  \n
- Redirect Customer window.location.href = response.checkout_url; Customer enters their 10-digit Neosurf voucher on redirected page.
  \n
\n
Listen for Webhook Notifications
\n
- Ensure your endpoint handles:
  \n
  - purchase.paid
    \n
  - purchase.error
    \n
  - purchase.cancelled
    \n
  \n
- Each payload will include purchaseId, status, amount, currency, etc.
  \n
\n

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

Field	Type	Description
Authorization	string	`Bearer {API_KEY}` (replace with your live or sandbox API key).
Content-Type	string	Must be `application/json`.
client.email	string	Customer’s email (e.g., `user8584@example.com`).
client.country	string	ISO‐3166 Alpha-2 code (e.g., `IN`).
client.city	string	City name or code (e.g., `123`).
client.stateCode	string	State or province code (two letters where possible, e.g., `ca`).
client.street_address	string	Street address line (e.g., `test test`).
client.zip_code	string	Postal/ZIP code (e.g., `234567`).
client.phone	string	Customer’s phone number (E.164 recommended, e.g., `9999999999`).
purchase.currency	string	Currency code (e.g., `AUD`).
purchase.products	array	Must contain at least one object with `name` and `price`.
└─ products.name	string	Product name or SKU (e.g., `dk`).
└─ products.price	string	Unit price in major currency units (e.g., `\"1\"` = 1.00 AUD).
paymentMethod	string	Payment rail code (e.g., `NEOSURF`).
brand_id	string	Live or sandbox Brand UUID (e.g., `c4003b2c-22d4-4dc1-ad0c-c6b54f8c9636`).
success_redirect	string	HTTPS URL to redirect after successful payment (e.g., `https://your.success.redirect.com`).
failure_redirect	string	HTTPS URL to redirect after failed payment (e.g., `https://your.failure.redirect.com`).

","urlObject":{"path":["purchases"],"host":["https://api.paysecure.net/api/v1"],"query":[],"variable":[]}},"response":[{"id":"49f6b685-8b1c-40c3-98ba-b7cd78f3b3a7","name":"Success","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer {{APIKey}}"}],"body":{"mode":"raw","raw":"{\n \"client\": {\n \"email\": \"user8584@example.com\",\n \"country\": \"IN\",\n \"city\": \"123\",\n \"stateCode\": \"ca\",\n \"street_address\": \"test test\",\n \"zip_code\": \"234567\",\n \"phone\": \"9999999999\"\n },\n \"purchase\": {\n \"currency\": \"AUD\",\n \"products\": [\n {\n \"name\": \"dk\",\n \"price\": \"1\"\n }\n ]\n },\n \"paymentMethod\": \"NEOSURF\",\n \"brand_id\": \"your-brand-id\",\n \"send_receipt\": \"\",\n \"skip_capture\": \"\",\n \"success_redirect\": \"https://your.success.redirect.com\",\n \"pending_redirect\": \"https://your.pending.redirect.com\",\n \"failure_redirect\": \"https://your.failure.redirect.com\",\n \"success_callback\": \"https://your.success.callback.com\",\n \"failure_callback\": \"https://your.failure.callback.com\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.paysecure.net/api/v1/purchases"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"purchaseId\": \"683d6bab12b471481d4f66cf\",\n \"client\": {\n \"customerId\": \"NA\",\n \"email\": \"user8584@example.com\",\n \"phone\": \"9999999999\",\n \"date_of_birth\": \"1800-01-01\",\n \"street_address\": \"test test\",\n \"country\": \"IN\",\n \"city\": \"123\",\n \"zip_code\": \"234567\",\n \"cc\": [],\n \"bcc\": [],\n \"stateCode\": \"ca\"\n },\n \"updated_on\": 1748855724,\n \"type\": \"purchase\",\n \"paymentMethod\": \"NEOSURF\",\n \"amountUnit\": \"MAJOR\",\n \"errorMsg\": \"\",\n \"redirectType\": \"GET\",\n \"force_recurring\": false,\n \"created_on\": 1748855723,\n \"merchantRef\": \"683d6bab12b471481d4f66cf\",\n \"merchantName\": \"Skyler Nakamurasinghal\",\n \"purchase\": {\n \"currency\": \"AUD\",\n \"products\": [\n {\n \"name\": \"dk\",\n \"quantity\": 1,\n \"price\": 1,\n \"discount\": 0,\n \"tax_percent\": \"0.00\"\n }\n ],\n \"total\": 1,\n \"language\": \"en\",\n \"notes\": \"\",\n \"debt\": 0,\n \"total_formatted\": 1,\n \"taxAmount\": 0,\n \"taxPercent\": 0,\n \"request_client_details\": [],\n \"email_message\": \"\"\n },\n \"payment\": {\n \"is_outgoing\": false,\n \"payment_type\": \"PURCHASE\",\n \"amount\": 1,\n \"currency\": \"AUD\",\n \"net_amount\": 1,\n \"fee_amount\": 0,\n \"pending_amount\": 0,\n \"pending_unfreeze_on\": null,\n \"description\": \"\",\n \"paid_on\": 1748855723,\n \"remote_paid_on\": 1748855723\n },\n \"issuer_details\": {\n \"website\": \"\",\n \"legal_street_address\": \"\",\n \"legal_country\": \"\",\n \"legal_city\": \"\",\n \"legal_zip_code\": \"\",\n \"bank_accounts\": [\n {}\n ],\n \"legal_name\": \"test6\",\n \"brand_name\": \"test6\",\n \"registration_number\": \"\",\n \"tax_number\": \"\"\n },\n \"transaction_data\": {\n \"payment_method\": \"\",\n \"flow\": \"payform\",\n \"extra\": {\n \"amount\": 1,\n \"masked_pan\": \"NEOSURF\"\n },\n \"country\": \"\",\n \"attempts\": [\n {\n \"client_ip\": \"203.0.113.205, 203.0.113.38, 203.0.113.161\",\n \"type\": \"execute\",\n \"payment_method\": \"NEOSURF\",\n \"flow\": \"payform\",\n \"successful\": true,\n \"country\": \"NEOSURF\",\n \"processing_time\": 1748855723,\n \"extra\": {\n \"amount\": 1,\n \"masked_pan\": \"NEOSURF\"\n }\n }\n ]\n },\n \"status\": \"PAYMENT_IN_PROCESS\",\n \"status_history\": [\n {\n \"status\": \"created\",\n \"timestamp\": 1748855723\n },\n {\n \"status\": \"pending_execute\",\n \"timestamp\": 1748855723\n },\n {\n \"status\": \"payment_in_process\",\n \"timestamp\": 1748855724\n }\n ],\n \"is_test\": false,\n \"brand_id\": \"your-brand-id\",\n \"is_recurring_token\": false,\n \"reference_generated\": \"PS784\",\n \"issued\": \"2025-06-02\",\n \"due\": 1748855723,\n \"refund_upto\": 1749024924,\n \"cc_descriptor\": \"\",\n \"fraudScore\": \"0\",\n \"trustScore\": \"0\",\n \"paidOn\": 0,\n \"refund_availability\": \"NONE\",\n \"refundable_amount\": 1,\n \"success_redirect\": \"https://your.success.redirect.com\",\n \"failure_redirect\": \"https://your.failure.redirect.com\",\n \"cancel_redirect\": \"\",\n \"success_callback\": \"https://your.success.callback.com\",\n \"failure_callback\": \"https://your.failure.callback.com\",\n \"platform\": \"API\",\n \"created_from_ip\": \"203.0.113.205, 203.0.113.38, 203.0.113.161\",\n \"checkout_url\": \"https://api.paysecure.net/payments/683d6bab12b471481d4f66cf/\",\n \"payoutProcess\": false\n}"}],"_postman_id":"592e08b7-f47f-4d59-9b50-ac16fd189e74"}],"id":"32c074c9-f25f-46f6-b77f-232db92951a0","_postman_id":"32c074c9-f25f-46f6-b77f-232db92951a0","description":""},{"name":"Payout API","item":[{"name":"Payout API","id":"87946c23-d83b-45a8-9d2d-882e9fb7b995","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer {{APIKey}}"}],"body":{"mode":"raw","raw":"{\n \"client\": {\n \"email\": \"user6245@example.com\",\n \"country\": \"AU\",\n \"phone\": \"+11111111\",\n \"full_name\": \"PAYOUT USER\",\n \"stateCode\": \"test\"\n },\n \"purpose\": \"test payout\",\n \"currency\": \"AUD\",\n \"payoutMethod\": \"PAYOUT-NEOSURF\",\n \"amount\": 1,\n \"success_callback\": \"https://your.success.callback.com\",\n \"failure_callback\": \"https://your.failure.callback.com\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.paysecure.net/api/v1/payout/","description":"

Create Payout

This endpoint allows you to initiate a payout transaction.

Request Body

client (object, required): Details of the client initiating the payout.
\n
- email (string): The email of the client.
  \n
- country (string): The country of the client.
  \n
- phone (string): The phone number of the client.
  \n
- full_name (string): The full name of the client.
  \n
- stateCode (string): The state code of the client.
  \n
\n
purpose (string, required): The purpose of the payout.
\n
currency (string, required): The currency of the payout.
\n
payoutMethod (string, required): The method of payout.
\n
amount (number, required): The amount of the payout.
\n
success_callback (string, required): The URL to which the success callback will be sent.
\n
failure_callback (string, required): The URL to which the failure callback will be sent.
\n

Response Body

The response will contain the details of the initiated payout transaction.

\n","urlObject":{"path":["payout",""],"host":["https://api.paysecure.net/api/v1"],"query":[],"variable":[]}},"response":[{"id":"530db251-d79b-4ab4-89f2-92b365a50afd","name":"New Request","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer {{APIKey}}"}],"body":{"mode":"raw","raw":"{\n \"client\": {\n \"email\": \"user6245@example.com\",\n \"country\": \"AU\",\n \"phone\": \"+11111111\",\n \"full_name\": \"PAYOUT USER\",\n \"stateCode\": \"test\"\n },\n \"purpose\": \"test payout\",\n \"currency\": \"AUD\",\n \"payoutMethod\": \"PAYOUT-NEOSURF\",\n \"amount\": 1,\n \"success_callback\": \"https://your.success.callback.com\",\n \"failure_callback\": \"https://your.failure.callback.com\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.paysecure.net/api/v1/payout/"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"payoutId\": \"683d6fee57aff00ab5faf3c6\",\n \"client\": {\n \"customerId\": \"NA\",\n \"email\": \"user6245@example.com\",\n \"phone\": \"+11111111\",\n \"full_name\": \"PAYOUT USER\",\n \"country\": \"AU\",\n \"stateCode\": \"test\"\n },\n \"updated_on\": 1748856814,\n \"payoutMethod\": \"PAYOUT-NEOSURF\",\n \"amountUnit\": \"MAJOR\",\n \"amount\": 1,\n \"errorMsg\": \"\",\n \"purpose\": \"test payout\",\n \"created_on\": 1748856814,\n \"merchantRef\": \"683d6fee57aff00ab5faf3c6\",\n \"status\": \"PAID\",\n \"status_history\": [\n {\n \"status\": \"created\",\n \"timestamp\": 1748856814\n },\n {\n \"status\": \"paid\",\n \"timestamp\": 1748856816\n }\n ],\n \"currency\": \"AUD\",\n \"paymentOn\": 1748856816,\n \"taxAmount\": 0,\n \"taxPercent\": 0,\n \"redirectType\": \"POST\",\n \"success_callback\": \"https://your.success.callback.com\",\n \"failure_callback\": \"https://your.failure.callback.com\"\n}"}],"_postman_id":"87946c23-d83b-45a8-9d2d-882e9fb7b995"}],"id":"a5d29cd0-970b-4b8d-a8b8-356b7f213d09","_postman_id":"a5d29cd0-970b-4b8d-a8b8-356b7f213d09","description":""}],"id":"686cd3e9-85e9-45e6-8d15-814d27e139b2","description":"

Neosurf is now available as a payment method on Paysecure, giving your customers a fast, secure, and convenient prepaid payment option. This guide explains what a Neosurf voucher is, how to acquire one across different regions, how to process a payment with it, and other key details of the integration.

\n","_postman_id":"686cd3e9-85e9-45e6-8d15-814d27e139b2"},{"name":"🇦🇺 PayID","item":[{"name":"Concepts","item":[],"id":"87f65122-49aa-4e41-af78-3f7a1beb30bc","description":"

What is a PayID?

A PayID is a user-friendly alias (such as an email, mobile number, or ABN) linked to a bank account. Payments made to a PayID are resolved in real-time via the NPP (New Payments Platform) to the associated account.

Use Cases

PayIn: Accept customer payments instantly with lower failure rates and no chargebacks.
\n
PayOut: Send real-time refunds, payroll, commissions, or supplier settlements via PayID.
\n

PayIn Customer Journey

Customer Initiates Payment
On the merchant’s checkout page or app, the user selects PayID as the payment method and proceeds.
\n
API Call to Paysecure
The merchant initiates a POST /purchases request with transaction details (amount, currency). Paysecure responds with a purchaseId, checkoutUrl, and a merchant PayID to which the customer should transfer funds.
\n
Customer Authorizes via Banking App
The customer logs into their internet or mobile banking, enters the PayID (received from Paysecure), the exact amount, and confirms the transfer.
\n
Real-time Bank Transfer
The customer’s bank processes the payment via NPP. Funds are instantly credited to Paysecure’s account.
\n
Webhook Notification
Once payment is received, Paysecure sends a webhook (purchase.paid) to the merchant. Merchant updates order status to “paid.”
\n
Error Handling
If the payment fails (due to invalid PayID, rejection by bank, or insufficient funds), Paysecure returns a purchase.failed status.
\n

PayOut Customer Journey

User Requests Withdrawal
A user initiates a payout (e.g., a refund, reward, or withdrawal) from the merchant interface.
\n
Merchant Approval
The merchant verifies and approves the request.
\n
API Call to Paysecure
Merchant sends a POST /payouts request with:
\n
- Recipient's PayID (e.g., email or phone)
  \n
- Amount
  \n
- Currency
  \n
- Optional reference or metadata
  \n
\n
Bank Transfer via NPP
Paysecure initiates the payout. Funds are credited to the recipient’s bank account in real-time via NPP.
\n
Webhook Notification
Once successful, Paysecure notifies the merchant (payout.success) so they can update their system.
\n
Failure Scenarios
If the PayID is invalid or unregistered, the payout fails. Paysecure responds with an error, and the merchant can retry after fixing the issue.
\n

\n","_postman_id":"87f65122-49aa-4e41-af78-3f7a1beb30bc"},{"name":"Payin API","item":[{"name":"Purchases","id":"5a3074af-676e-4f91-bc48-4d4389e6c17e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"client\": {\n \"email\": \"user2308@example.com\",\n \"street_address\": \"13 Documentation Way\",\n \"city\": \"Kingsport\",\n \"full_name\": \"Test test\",\n \"zip_code\": \"68403\",\n \"country\": \"AU\",\n \"stateCode\": \"QLD\",\n \"phone\": \"+447755564318\"\n },\n \"purchase\": {\n \"currency\": \"AUD\",\n \"products\": [\n {\n \"name\": \"test\",\n \"price\": 100\n }\n ]\n },\n \"paymentMethod\": \"PAYID\",\n \"brand_id\": \"your-brand-id\",\n \"success_redirect\": \"https://your.success.redirect.com\",\n \"pending_redirect\": \"https://your.pending.redirect.com\",\n \"failure_redirect\": \"https://your.failure.redirect.com\",\n \"success_callback\": \"https://your.success.callback.com\",\n \"failure_callback\": \"https://your.failure.callback.com\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.paysecure.net/api/v1/purchases","description":"

Purchase API Endpoint

This endpoint allows you to create a new purchase transaction. It processes the purchase details, including client information, product details, and payment method, and returns the result of the transaction.

Request Format

Method: POST
\n
URL: https://api.paysecure.net/api/v1/purchases
\n
Request Body: The request should be in JSON format and must include the following structure:
\n

Response Structure

The response will contain the result of the purchase transaction. The structure of the response may include:

status: Indicates the success or failure of the transaction.
\n
message: A descriptive message regarding the transaction status.
\n
transaction_id: Unique identifier for the transaction (if successful).
\n
redirect_url: URL to redirect the user based on the transaction result.
\n

Make sure to handle the response appropriately based on the status returned.

\n","urlObject":{"path":["purchases"],"host":["https://api.paysecure.net/api/v1"],"query":[],"variable":[]}},"response":[{"id":"16f83595-671e-4af8-bd5a-d87498b362d3","name":"Success","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"client\": {\n \"email\": \"user2308@example.com\",\n \"street_address\": \"13 Documentation Way\",\n \"city\": \"Kingsport\",\n \"full_name\": \"Test test\",\n \"zip_code\": \"68403\",\n \"country\": \"AU\",\n \"stateCode\": \"QLD\",\n \"phone\": \"+447755564318\"\n },\n \"purchase\": {\n \"currency\": \"AUD\",\n \"products\": [\n {\n \"name\": \"test\",\n \"price\": 100\n }\n ]\n },\n \"paymentMethod\": \"PAYID\",\n \"brand_id\": \"your-brand-id\",\n \"success_redirect\": \"https://your.success.redirect.com\",\n \"pending_redirect\": \"https://your.pending.redirect.com\",\n \"failure_redirect\": \"https://your.failure.redirect.com\",\n \"success_callback\": \"https://your.success.callback.com\",\n \"failure_callback\": \"https://your.failure.callback.com\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.paysecure.net/api/v1/purchases"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"purchaseId\": \"68441c2a7559cf659fd7e835\",\n \"client\": {\n \"customerId\": \"NA\",\n \"email\": \"user3718@example.com\",\n \"phone\": \"+237679544810\",\n \"full_name\": \"Jordan Moreau\",\n \"street_address\": \"test test\",\n \"country\": \"AU\",\n \"city\": \"123\",\n \"zip_code\": \"234567\",\n \"cc\": [],\n \"bcc\": [],\n \"stateCode\": \"ca\"\n },\n \"updated_on\": 1749294123,\n \"type\": \"purchase\",\n \"paymentMethod\": \"PAYID\",\n \"amountUnit\": \"MAJOR\",\n \"errorMsg\": \"\",\n \"redirectType\": \"POST\",\n \"force_recurring\": false,\n \"created_on\": 1749294123,\n \"merchantRef\": \"68441c2a7559cf659fd7e835\",\n \"merchantName\": \"Merchant002\",\n \"purchase\": {\n \"currency\": \"AUD\",\n \"products\": [\n {\n \"name\": \"test\",\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 \"taxAmount\": 0,\n \"taxPercent\": 0,\n \"request_client_details\": [],\n \"timezone\": \"MIT\",\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\": \"44\",\n \"brand_name\": \"44\",\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\": 1749294123\n }\n ],\n \"is_test\": false,\n \"brand_id\": \"your-brand-id\",\n \"send_receipt\": false,\n \"is_recurring_token\": false,\n \"skip_capture\": false,\n \"reference_generated\": \"PS19963\",\n \"issued\": \"2025-06-07\",\n \"due\": 1749294123,\n \"refund_upto\": 0,\n \"cc_descriptor\": \"\",\n \"fraudScore\": \"NA\",\n \"trustScore\": \"NA\",\n \"paidOn\": 0,\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\": \"https://your.success.callback.com\",\n \"failure_callback\": \"https://your.failure.callback.com\",\n \"platform\": \"API\",\n \"created_from_ip\": \"203.0.113.17\",\n \"checkout_url\": \"\",\n \"payoutProcess\": false\n}"}],"_postman_id":"5a3074af-676e-4f91-bc48-4d4389e6c17e"}],"id":"d00ad951-f09f-456a-aac9-5c56e65ee1a2","_postman_id":"d00ad951-f09f-456a-aac9-5c56e65ee1a2","description":""},{"name":"Payout API","item":[{"name":"New Request","id":"39595d20-1b33-4975-8503-7db260fafa1a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer {{APIKey}}"}],"body":{"mode":"raw","raw":"{\n \"client\": {\n \"email\": \"user5890@example.com\",\n \"country\": \"CA\",\n \"phone\": \"7665230591\",\n \"full_name\": \"Avery Larsen\"\n },\n \"purpose\": \"testing payout\",\n \"currency\": \"AUD\",\n \"payoutMethod\": \"PAYOUT-PAYID\",\n \"amount\": 50,\n \"extraParam\": {\n \"payId\": \"KeU6r2egQmQZeqUfkPYC7HSU1EDrn2GYyU\",\n \"bankName\": \"test bank name\",\n \"accountName\": \"Skyler Nakamura\"\n },\n \"success_callback\": \"https://your.success.callback.com\",\n \"failure_callback\": \"https://your.failure.callback.com\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.paysecure.net/api/v1/payout/","description":"

Payout Request API

This endpoint allows clients to initiate a payout transaction. It requires specific details about the client and the payout method to process the request successfully.

Request Format

The request must be sent as a JSON object in the raw body. The following parameters are expected:

client: An object containing client information.
\n
- email (string): The email address of the client.
  \n
- country (string): The country of the client.
  \n
- phone (string): The phone number of the client.
  \n
- full_name (string): The full name of the client.
  \n
\n
purpose (string): A brief description of the reason for the payout (e.g., \"testing payout\").
\n
currency (string): The currency in which the payout is to be made (e.g., \"AUD\").
\n
payoutMethod (string): The method used for the payout (e.g., \"PAYOUT-PAYID\").
\n
amount (number): The amount to be paid out.
\n
extraParam: An object containing additional payout parameters.
\n
- payId (string): The unique identifier for the payout.
  \n
- bankName (string): The name of the bank associated with the payout.
  \n
- accountName (string): The name on the account receiving the payout.
  \n
\n
success_callback (string): A URL that will be called upon successful completion of the payout.
\n
failure_callback (string): A URL that will be called if the payout fails.
\n

Response Structure

The response from this endpoint will typically include details about the status of the payout request, which may include:

A success message or error details.
\n
A transaction ID for tracking purposes.
\n
Any additional information relevant to the payout process.
\n

Ensure to handle both success and failure callbacks appropriately based on the response received from this endpoint.

\n","urlObject":{"path":["payout",""],"host":["https://api.paysecure.net/api/v1"],"query":[],"variable":[]}},"response":[{"id":"181d8f36-3e83-41b8-8ee0-93201e476ce6","name":"Success","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer {{APIKey}}"}],"body":{"mode":"raw","raw":"{\n \"client\": {\n \"email\": \"user5890@example.com\",\n \"country\": \"CA\",\n \"phone\": \"7665230591\",\n \"full_name\": \"Avery Larsen\"\n },\n \"purpose\": \"testing payout\",\n \"currency\": \"AUD\",\n \"payoutMethod\": \"PAYOUT-PAYID\",\n \"amount\": 50,\n \"extraParam\": {\n \"payId\": \"KeU6r2egQmQZeqUfkPYC7HSU1EDrn2GYyU\",\n \"bankName\": \"test bank name\",\n \"accountName\": \"Skyler Nakamura\"\n },\n \"success_callback\": \"https://your.success.callback.com\",\n \"failure_callback\": \"https://your.failure.callback.com\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.paysecure.net/api/v1/payout/"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"payoutId\": \"683d6fee57aff00ab5faf3c6\",\n \"client\": {\n \"customerId\": \"NA\",\n \"email\": \"user6245@example.com\",\n \"phone\": \"+11111111\",\n \"full_name\": \"PAYOUT USER\",\n \"country\": \"AU\",\n \"stateCode\": \"test\"\n },\n \"updated_on\": 1748856814,\n \"payoutMethod\": \"PAYOUT-PAYID\",\n \"amountUnit\": \"MAJOR\",\n \"amount\": 1,\n \"errorMsg\": \"\",\n \"purpose\": \"test payout\",\n \"created_on\": 1748856814,\n \"merchantRef\": \"683d6fee57aff00ab5faf3c6\",\n \"status\": \"PAID\",\n \"status_history\": [\n {\n \"status\": \"created\",\n \"timestamp\": 1748856814\n },\n {\n \"status\": \"paid\",\n \"timestamp\": 1748856816\n }\n ],\n \"currency\": \"AUD\",\n \"paymentOn\": 1748856816,\n \"taxAmount\": 0,\n \"taxPercent\": 0,\n \"redirectType\": \"POST\",\n \"success_callback\": \"https://your.success.callback.com\",\n \"failure_callback\": \"https://your.failure.callback.com\"\n}"},{"id":"af311c5a-1054-4e4f-bef3-e43ba809d7a2","name":"Error","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer {{APIKey}}"}],"body":{"mode":"raw","raw":"{\n \"client\": {\n \"email\": \"user5890@example.com\",\n \"country\": \"CA\",\n \"phone\": \"7665230591\",\n \"full_name\": \"Avery Larsen\"\n },\n \"purpose\": \"testing payout\",\n \"currency\": \"AUD\",\n \"payoutMethod\": \"PAYOUT-PAYID\",\n \"amount\": 50,\n \"extraParam\": {\n \"payId\": \"KeU6r2egQmQZeqUfkPYC7HSU1EDrn2GYyU\",\n \"bankName\": \"test bank name\",\n \"accountName\": \"Skyler Nakamura\"\n },\n \"success_callback\": \"https://your.success.callback.com\",\n \"failure_callback\": \"https://your.failure.callback.com\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.paysecure.net/api/v1/payout/"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"payoutId\": \"683d6fee57aff00ab5faf3c6\",\n \"client\": {\n \"customerId\": \"NA\",\n \"email\": \"user6245@example.com\",\n \"phone\": \"+11111111\",\n \"full_name\": \"PAYOUT USER\",\n \"country\": \"AU\",\n \"stateCode\": \"test\"\n },\n \"updated_on\": 1748856814,\n \"payoutMethod\": \"PAYOUT-PAYID\",\n \"amountUnit\": \"MAJOR\",\n \"amount\": 1,\n \"errorMsg\": \"\",\n \"purpose\": \"test payout\",\n \"created_on\": 1748856814,\n \"merchantRef\": \"683d6fee57aff00ab5faf3c6\",\n \"status\": \"PAID\",\n \"status_history\": [\n {\n \"status\": \"created\",\n \"timestamp\": 1748856814\n },\n {\n \"status\": \"paid\",\n \"timestamp\": 1748856816\n }\n ],\n \"currency\": \"AUD\",\n \"paymentOn\": 1748856816,\n \"taxAmount\": 0,\n \"taxPercent\": 0,\n \"redirectType\": \"POST\",\n \"success_callback\": \"https://your.success.callback.com\",\n \"failure_callback\": \"https://your.failure.callback.com\"\n}"}],"_postman_id":"39595d20-1b33-4975-8503-7db260fafa1a"}],"id":"610c462c-a6c7-4f16-a686-b9ad1b3cab57","_postman_id":"610c462c-a6c7-4f16-a686-b9ad1b3cab57","description":""}],"id":"45f11c6e-10d0-4aab-a02f-e7c55d5ca25e","description":"

PayID is a real-time payment method in Australia built on the New Payments Platform (NPP). It allows customers to make or receive payments using simple identifiers like their mobile number or email address, eliminating the need to remember BSB and account numbers.

Paysecure enables merchants to both accept payments (PayIn) and send payouts (PayOut) using PayID. Transactions are settled instantly, and users benefit from seamless user experience with low friction.

\n","_postman_id":"45f11c6e-10d0-4aab-a02f-e7c55d5ca25e"},{"name":"🌐 CryptoBridge","item":[{"name":"Concepts","item":[],"id":"a9134d87-4fc5-47e0-a60e-4afeba0ebfbc","description":"

💸 Customer PayIn Journey

Checkout
Customer chooses CryptoBridge as the payment method on merchant's checkout page.
\n
Payment Pop-up Opens
A secure pop-up opens where the customer:
\n
- Selects their preferred exchange or DeFi wallet
  \n
- Links the account
  \n
- Selects the eligible token and blockchain network
  \n
\n
Fee Preview
Customer reviews the full fee structure:
\n
- Gas Fee: Network charge
  \n
- Institution Fee: Fee from exchange or wallet provider
  \n
- Client Fee: Optional merchant fee (can be configured via clientFee param)
  \n
\n
Authentication & Confirmation
The customer authenticates (if required by the linked wallet or exchange) and confirms the transfer.
\n
Payment & Notification
On successful transfer:
\n
- Crypto is sent to the merchant's receiver address
  \n
- Webhook is triggered to notify merchant of successful payment
  \n
- Customer is redirected to success or failure URL based on transaction outcome
  \n
\n
Smart-Finding (Auto Swap)
If customer lacks sufficient balance in selected token, the system suggests a real-time token swap—reducing drop-offs and boosting conversions.
\n

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.

💡 Key Fields Explained

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

Field	Description
`paymentMethod`	Always use `\"CRYPTO-BRIDGE\"` to trigger this payment method
`currency`	The fiat currency for the order (e.g., USD, EUR). You will be paid in crypto but this defines how much the customer will pay
`products`	One or more items being sold, with name and price
`extraParam.clientFee`	Optional: A custom fee you (the merchant) want to charge — shown to the user at checkout
`extraParam.toAddress`	Optional. Merchant can provide the list of wallet addresses, where they want to collect the deposit from the user. Can pass multiple addresses.
`extraParam.toAddress.symbol`	The symbol of the digital asset. Example: ETH, USDC etc. Possible Values: AAVE, ADA, APE, APT, ARB, AVAX, BLAST, BLUR, BNB, BTC, BUSD, CAKE, CASH, CRO, DAI, DEXE, DEVNETSOL, DOGE, ENA, ETH, EURC, FARTCOIN, FDUSD, FORM, FTM, GRT, HYPE, IMX, INJ, LDO, LEO, LINK, LTC, MANA, MATIC, MKR, MNT, MON, OP, PAXG, PENGU, POL, PYUSD, QNT, RLUSD, RNDR, S, SAND, SEPOLIAETH, SHIB, SNX, SOL, SUI, TON, TRUMP, TRX, TUSD, UNI, USD1, USD₮0, USDC, USDD, USDG, USDH, USDP, USDT, VIRTUAL, WAVAX, WBNB, WBTC, WETH, WHYPE, WIF, WMATIC, WMON, XLM, XRP
`extraParam.toAddress.networkName`	The network of the token. Example: ETHEREUM, POLYGON etc. Possible values: ETHEREUM, POLYGON, BSC, ARBITRUM, OPTIMISM, BASE, AVALANCHEC, BLAST, HYPEREVM, SOLANA, BITCOIN, TRON, LITECOIN, DOGECOIN, RIPPLE, APTOS, CARDANO, STELLAR, SUI, TON, SONIC, INJECTIVE, AVALANCHEX
`extraParam.toAddress.address`	The address to send the asset to.
`success_redirect` / `success_redirect` / `failure_redirect`	Where the user should land after completing or canceling the payment or if the transaction is in pending state.
`success_callback` / `failure_callback`	Your backend URL to receive transaction status via webhook.
`client`	Customer billing info

","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"7cbee3a2-6b7b-49fc-906e-678d6393d7e6","id":"7cbee3a2-6b7b-49fc-906e-678d6393d7e6","name":"Payin API","type":"folder"}},"urlObject":{"path":["purchases"],"host":["https://api.paysecure.net/api/v1"],"query":[],"variable":[]}},"response":[{"id":"789b8f07-78d0-4b5e-bc72-71b8ce978f67","name":"Purchases","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer {{APIKey}}"}],"body":{"mode":"raw","raw":"{\n \"client\": {\n \"email\": \"user4639@example.com\",\n \"full_name\": \"Gaurav Test\",\n \"country\": \"US\",\n \"city\": \"123\",\n \"stateCode\": \"NYC\",\n \"street_address\": \"test test\",\n \"zip_code\": \"234567\",\n \"phone\": \"9999999999\"\n },\n \"purchase\": {\n \"currency\": \"USD\",\n \"products\": [\n {\n \"name\": \"product name\",\n \"price\": 5.86\n }\n ]\n },\n \"paymentMethod\": \"CRYPTO-BRIDGE\",\n \"brand_id\": \"your-brand-id\",\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 \"clientFee\": 0.1, //optional\n \"toAddress\": [\n {\n \"symbol\": \"ETH\",\n \"networkName\": \"ETHEREUM\",\n \"address\": \"90 Fixture Close\"\n },\n {\n \"symbol\": \"USDC\",\n \"networkName\": \"POLYGON\",\n \"address\": \"1 Example Street\"\n }\n ]\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://api.paysecure.net/api/v1/purchases"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"purchaseId\": \"6874ce9402f0f25ed8fc66a7\",\n \"client\": {\n \"customerId\": \"NA\",\n \"email\": \"user4639@example.com\",\n \"phone\": \"9999999999\",\n \"full_name\": \"Test test\",\n \"date_of_birth\": \"1800-01-01\",\n \"street_address\": \"test test\",\n \"country\": \"US\",\n \"city\": \"123\",\n \"zip_code\": \"234567\",\n \"cc\": [],\n \"bcc\": [],\n \"tax_number\": \"39933551809\",\n \"stateCode\": \"NYC\"\n },\n \"updated_on\": 1752485524,\n \"type\": \"purchase\",\n \"paymentMethod\": \"CRYPTO-BRIDGE\",\n \"amountUnit\": \"MAJOR\",\n \"errorMsg\": \"\",\n \"redirectType\": \"GET\",\n \"force_recurring\": false,\n \"created_on\": 1752485524,\n \"extraParam\": {\n \"clientFee\": 0.1,\n \"toAddress\": [\n {\n \"symbol\": \"ETH\",\n \"network\": \"ETHEREUM\",\n \"address\": \"90 Fixture Close\"\n },\n {\n \"symbol\": \"USDC\",\n \"network\": \"POLYGON\",\n \"address\": \"1 Example Street\"\n }\n ]\n },\n \"merchantRef\": \"6874ce9402f0f25ed8fc66a7\",\n \"merchantName\": \"test\",\n \"purchase\": {\n \"currency\": \"USD\",\n \"products\": [\n {\n \"name\": \"product name\",\n \"quantity\": 1,\n \"price\": 5.86,\n \"discount\": 0,\n \"tax_percent\": \"0.00\"\n }\n ],\n \"total\": 5.86,\n \"language\": \"en\",\n \"notes\": \"\",\n \"debt\": 0,\n \"total_formatted\": 1,\n \"taxAmount\": 0,\n \"taxPercent\": 0,\n \"request_client_details\": [],\n \"timezone\": \"Asia/Hong_Kong\",\n \"email_message\": \"\"\n },\n \"payment\": {\n \"is_outgoing\": false,\n \"payment_type\": \"PURCHASE\",\n \"amount\": 5.86,\n \"currency\": \"USD\",\n \"net_amount\": 5.86,\n \"fee_amount\": 0,\n \"pending_amount\": 0,\n \"pending_unfreeze_on\": null,\n \"description\": \"\",\n \"paid_on\": 1752485524,\n \"remote_paid_on\": 1752485524\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\": \"iUnicharge\",\n \"brand_name\": \"iUnicharge\",\n \"registration_number\": \"\",\n \"tax_number\": \"\"\n },\n \"transaction_data\": {\n \"payment_method\": \"\",\n \"flow\": \"payform\",\n \"extra\": {\n \"amount\": 5.86,\n \"masked_pan\": \"CRYPTO-BRIDGE\"\n },\n \"country\": \"\",\n \"attempts\": [\n {\n \"client_ip\": \"203.0.113.46, 203.0.113.110, 203.0.113.141\",\n \"type\": \"execute\",\n \"payment_method\": \"CRYPTO-BRIDGE\",\n \"flow\": \"payform\",\n \"successful\": true,\n \"country\": \"CRYPTO-BRIDGE\",\n \"processing_time\": 1752485524,\n \"extra\": {\n \"amount\": 5.86,\n \"masked_pan\": \"CRYPTO-BRIDGE\"\n }\n }\n ]\n },\n \"status\": \"PAYMENT_IN_PROCESS\",\n \"status_history\": [\n {\n \"status\": \"created\",\n \"timestamp\": 1752485524\n },\n {\n \"status\": \"pending_execute\",\n \"timestamp\": 1752485524\n },\n {\n \"status\": \"payment_in_process\",\n \"timestamp\": 1752485524\n }\n ],\n \"is_test\": false,\n \"brand_id\": \"your-brand-id\",\n \"send_receipt\": false,\n \"is_recurring_token\": false,\n \"skip_capture\": false,\n \"reference_generated\": \"PS1682\",\n \"issued\": \"2025-07-14\",\n \"due\": 1752485524,\n \"refund_upto\": 0,\n \"cc_descriptor\": \"\",\n \"fraudScore\": \"100\",\n \"trustScore\": \"2\",\n \"paidOn\": 0,\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\": \"https://your.success.callback.com\",\n \"failure_callback\": \"https://your.failure.callback.com\",\n \"platform\": \"API\",\n \"created_from_ip\": \"203.0.113.46, 203.0.113.110, 203.0.113.141\",\n \"checkout_url\": \"https://api.paysecure.net/payments/6874ce9402f0f25ed8fc66a7/\",\n \"payoutProcess\": false\n}"}],"_postman_id":"b3330a46-9c06-49bd-bb28-c50ed2187514"}],"id":"7cbee3a2-6b7b-49fc-906e-678d6393d7e6","description":"

🔗 How to Accept Payments with CryptoBridge (PayIn API)

To let your customers pay in crypto (while you list your prices in fiat), you need to initiate a Create Purchase API call from your backend when a customer selects CryptoBridge at checkout. This API tells PaySecure the details of the transaction, customer, and where to redirect the user after payment.

🔥 What Happens When You Call This API

You send order details (amount, products, etc.) in USD or any fiat currency
\n
You specify that the payment method is CRYPTO-BRIDGE
\n
Optionally, you can add your own processing fee using clientFee — this will be shown to the customer before they confirm payment
\n
PaySecure returns a secure checkout_url which you can use to redirect the customer to a crypto payment pop-up
\n
The customer pays using their crypto wallet or exchange, and once it's confirmed:
\n
- You get an instant webhook notification
  \n
- The user is redirected back to your success or failure page
  \n
\n

📖 Overview

CryptoBridge is a fiat-denominated crypto payment method that allows merchants to list goods and services in fiat while accepting payment in crypto. The platform automatically handles real-time conversion, token selection, and network routing—abstracting all crypto complexities from the merchant.

Customers can link their exchange or DeFi wallets (from over 400+ supported providers including Binance, Coinbase, Metamask, etc.) and make seamless crypto transfers. Fees such as gas, institutional charges, and optional merchant processing fees are transparently displayed and deducted before confirmation.

✅ Key Benefits

Fiat-based pricing with crypto-native checkout
\n
No crypto inventory management needed
\n
Real-time conversion of fiat to eligible tokens
\n
Access to 400+ exchanges and DeFi wallets
\n
Smart token swapping feature for low-balance users – improves approval rates by up to 40%
\n
Full transparency in fee breakdown: gas, institutional, merchant/client fee
\n
Webhook-based confirmation for real-time order processing
\n

Payin

The PayIn flow proceeds as follows:

Customer Initiates: The merchant’s site or app presents Virtual Account as a payment option to its customers. The customer selects it and clicks on Pay.
\n
API Request: The merchant calls Paysecure’s PayIn API (e.g. POST /purchases ) with the transaction amount and the currency. Paysecure returns a purchase ID and provide a URL for the customer to continue.
\n
Virtual Account Displayed: The customer is shown their unique bank account details in which they need to deposit the money.
\n
Customer Authorisation: The customer logs into their online/mobile banking and adds the bank account as a beneficiary and amount provided by Paysecure. They confirm the transaction in their banking app.
\n
Real-time Transfer: The customer’s bank sends the funds to the virtual account generated for the user.
\n
Notification: Once payment is received, Paysecure triggers a webhook to the merchant with details (amount, currency, payer info, timestamp, etc.). The purchase status in Paysecure can also be queried via the get status API.
\n
Merchant Fulfillment: Upon webhook confirmation, the merchant fulfills the order or credits the customer’s wallet.
\n
If any step fails (e.g. the bank account is invalid, the customer’s bank declines the transfer, or there are insufficient funds), Paysecure returns an error status. The merchant sees the payment failed and can prompt the customer to retry or choose another method.
\n

\n","_postman_id":"f0d38046-207d-4948-8f0b-17ed4477af07"},{"name":"Payin","item":[{"name":"Create Purchase","id":"a851c05b-59c3-4e33-8159-981f6805ad1b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer {{APIKey}}"}],"body":{"mode":"raw","raw":"{\n \"client\": {\n \"email\": \"user2308@example.com\",\n \"street_address\": \"13 Documentation Way\",\n \"city\": \"Kingsport\",\n \"full_name\": \"Test test\",\n \"zip_code\": \"68403\",\n \"country\": \"KR\",\n \"stateCode\": \"QLD\",\n \"phone\": \"+447755564318\",\n \"date_of_birth\": \"1970-07-10\"\n },\n \"purchase\": {\n \"currency\": \"KRW\",\n \"products\": [\n {\n \"name\": \"test\",\n \"price\": 100\n }\n ]\n },\n \"paymentMethod\": \"VIRTUAL-ACCOUNT\",\n \"brand_id\": \"your-brand-id\",\n \"success_redirect\": \"https://your.success.redirect.com\",\n \"pending_redirect\": \"https://your.pending.redirect.com\",\n \"failure_redirect\": \"https://your.failure.redirect.com\",\n \"success_callback\": \"https://your.success.callback.com\",\n \"failure_callback\": \"https://your.failure.callback.com\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.paysecure.net/api/v1/purchases","description":"

Payin API

\n\n

Integration Steps: To integrate Virtual Account payments with Paysecure, follow these steps:

Enable Virtual Account in Paysecure: Sign up with Paysecure and ensure the Virtual Account payment method is enabled for your merchant account. Get your API keys for authentication (test and live).
\n
Configure Webhooks: Set up Paysecure webhooks (e.g. transaction.paid, transaction.failed) so your system is notified of payment status changes.
\n
Implement PayIn (Customer Payments): In your checkout flow, allow the customer to choose Virtual Account and then call Paysecure’s PayIn API (e.g. POST /purchases ) with parameters such as amount, currency and paymentMethod=VIRTUAL-ACCOUNT. 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.
\n

\n","urlObject":{"path":["purchases"],"host":["https://api.paysecure.net/api/v1"],"query":[],"variable":[]}},"response":[{"id":"b55ccbc8-0043-4091-9c11-391b976f218f","name":"purchase-sucess","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer {{APIKey}}"}],"body":{"mode":"raw","raw":"{\n \"client\": {\n \"email\": \"user2308@example.com\",\n \"street_address\": \"13 Documentation Way\",\n \"city\": \"Kingsport\",\n \"full_name\": \"Test test\",\n \"zip_code\": \"68403\",\n \"country\": \"KR\",\n \"stateCode\": \"QLD\",\n \"phone\": \"+447755564318\",\n \"date_of_birth\": \"1970-07-10\"\n },\n \"purchase\": {\n \"currency\": \"KRW\",\n \"products\": [\n {\n \"name\": \"test\",\n \"price\": 100\n }\n ]\n },\n \"paymentMethod\": \"VIRTUAL-ACCOUNT\",\n \"brand_id\": \"your-brand-id\",\n \"success_redirect\": \"https://your.success.redirect.com\",\n \"pending_redirect\": \"https://your.pending.redirect.com\",\n \"failure_redirect\": \"https://your.failure.redirect.com\",\n \"success_callback\": \"https://your.success.callback.com\",\n \"failure_callback\": \"https://your.failure.callback.com\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.paysecure.net/api/v1/purchases"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\n \"purchaseId\": \"68441c2a7559cf659fd7e835\",\n \"client\": {\n \"customerId\": \"NA\",\n \"email\": \"user3718@example.com\",\n \"phone\": \"+237679544810\",\n \"full_name\": \"Jordan Moreau\",\n \"street_address\": \"test test\",\n \"country\": \"KR\",\n \"city\": \"123\",\n \"zip_code\": \"234567\",\n \"cc\": [],\n \"bcc\": [],\n \"stateCode\": \"ca\"\n },\n \"updated_on\": 1749294123,\n \"type\": \"purchase\",\n \"paymentMethod\": \"VIRTUAL-ACCOUNT\",\n \"amountUnit\": \"MAJOR\",\n \"errorMsg\": \"\",\n \"redirectType\": \"POST\",\n \"force_recurring\": false,\n \"created_on\": 1749294123,\n \"merchantRef\": \"68441c2a7559cf659fd7e835\",\n \"merchantName\": \"Merchant002\",\n \"purchase\": {\n \"currency\": \"KRW\",\n \"products\": [\n {\n \"name\": \"test\",\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 \"taxAmount\": 0,\n \"taxPercent\": 0,\n \"request_client_details\": [],\n \"timezone\": \"MIT\",\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\": \"44\",\n \"brand_name\": \"44\",\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\": 1749294123\n }\n ],\n \"is_test\": false,\n \"brand_id\": \"your-brand-id\",\n \"send_receipt\": false,\n \"is_recurring_token\": false,\n \"skip_capture\": false,\n \"reference_generated\": \"PS19963\",\n \"issued\": \"2025-06-07\",\n \"due\": 1749294123,\n \"refund_upto\": 0,\n \"cc_descriptor\": \"\",\n \"fraudScore\": \"NA\",\n \"trustScore\": \"NA\",\n \"paidOn\": 0,\n \"refund_availability\": \"NONE\",\n \"refundable_amount\": 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 \"cancel_redirect\": \"\",\n \"success_callback\": \"https://your.success.callback.com\",\n \"failure_callback\": \"https://your.failure.callback.com\",\n \"platform\": \"API\",\n \"created_from_ip\": \"203.0.113.17\",\n \"checkout_url\": \"https://api.paysecure.net/payments/68441c2a7559cf659fd7e835/\",\n \"payoutProcess\": false\n}"}],"_postman_id":"a851c05b-59c3-4e33-8159-981f6805ad1b"},{"name":"Get Status","id":"bf050f42-e587-4432-b266-e2f87a6bddec","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer {{APIKey}}","type":"text"}],"url":"https://api.paysecure.net/api/v1/purchases/{purchaseId}/","description":"

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

Note: With respect to bank transfers, the purchase request is synonymous with the PayIn request.

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

Status	Notes
paid	Transaction Successful
payment_in_process	Payment is under Processing
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","urlObject":{"path":["purchases","{purchaseId}",""],"host":["https://api.paysecure.net/api/v1"],"query":[],"variable":[]}},"response":[{"id":"5257683c-c2f0-44d7-911a-77208628e7ef","name":"Purchases-success","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer {{APIKey}}","type":"text"}],"url":"https://api.paysecure.net/api/v1/purchases/{purchaseId}/"},"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":"{\r\n \"purchaseId\": \"65f95faa70fe897720c40a15\",\r\n \"client\": {\r\n----\r\n },\r\n \"updated_on\": 1710841770,\r\n \"type\": \"purchase\",\r\n \"amountUnit\": \"MAJOR\",\r\n \"errorMsg\": \"\",\r\n \"redirectType\": \"POST\",\r\n \"force_recurring\": false,\r\n \"created_on\": 1710841770,\r\n \"merchantRef\": \"65f95faa70fe897720c40a15\",\r\n \"merchantName\": \"test\",\r\n \"purchase\": {\r\n----\r\n },\r\n \"issuer_details\": {\r\n-----\r\n },\r\n \"transaction_data\": {\r\n----\r\n },\r\n \"status\": \"CREATED\",\r\n \"status_history\": [\r\n {\r\n \"status\": \"created\",\r\n \"timestamp\": 1710841770\r\n }\r\n ],\r\n \"is_test\": false,\r\n \"brand_id\": \"your-brand-id\",\r\n \"send_receipt\": false,\r\n \"is_recurring_token\": false,\r\n \"skip_capture\": false,\r\n \"reference_generated\": \"PS2697\",\r\n \"issued\": \"2024-03-19\",\r\n \"due\": 1710841770,\r\n \"refund_upto\": 0,\r\n \"cc_descriptor\": \"\",\r\n \"fraudScore\": \"NA\",\r\n \"trustScore\": \"NA\",\r\n \"refund_availability\": \"NONE\",\r\n \"refundable_amount\": 0.0,\r\n \"paymentMethod\" : \"BANKTRANSFER\",\r\n \"brand_id\": \"your-brand-id\",\r\n \"success_redirect\": \"https://your.success.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 \"cancel_redirect\": \"\",\r\n \"platform\": \"API\",\r\n \"created_from_ip\": \"203.0.113.104\",\r\n \"checkout_url\": \"https://app.paysecure.net/payments/65f95faa70fe897720c40a15/\"\r\n}\r\n"},{"id":"36873a9c-2b41-4ac5-ad72-25b44a60f80a","name":"Purchases","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer {{APIKey}}","type":"text"}],"url":"https://api.paysecure.net/api/v1/purchases/{purchaseId}/"},"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":"{\r\n \"message\": \"Error Message\",\r\n \"code\": \"error_code\"\r\n}\r\n"}],"_postman_id":"bf050f42-e587-4432-b266-e2f87a6bddec"}],"id":"768695d8-8a36-4901-b32c-2ed2d9acf114","_postman_id":"768695d8-8a36-4901-b32c-2ed2d9acf114","description":""}],"id":"ff07740d-73c0-467c-9562-62cfb6e54952","description":"

A Virtual Account (VA) is a unique, system-generated bank account number provided to a merchant or end-customer for the purpose of collecting payments.

Unlike a traditional pooled account where many customers pay into the same bank account and merchants must rely on payer references to reconcile funds, a Virtual Account is unique per customer, transaction, or use case. This ensures that when a payment is received, it is automatically mapped and reconciled to the correct merchant/customer without manual intervention.

Concepts

Unique Identifiers: Each VA has its own account number or IBAN.
\n
Seamless Reconciliation: Payments are matched automatically based on the VA, eliminating reliance on free-text references.
\n
Local & Cross-Border Coverage: Can be issued in multiple currencies and geographies (e.g., USD ACH, EUR SEPA, GBP FPS, INR UPI).
\n
Temporary or Permanent: Can be dynamic (per transaction/session) or static (per customer).
\n
Bank-Grade Security: Issued through Paysecure’s partner banks and fully compliant with local regulations.
\n

Benefits

Operational Efficiency – no manual reconciliation of payer references.
\n
Improved Customer Experience – clear payment instructions, fewer failed/misapplied payments.
\n
Global Reach – merchants can collect funds locally in multiple regions without needing a local bank entity.
\n
Scalability – supports thousands of customers with individual VAs.
\n

Use Cases

User-Specific Collections & Attribution: Assign a unique VA to each user or customer, enabling precise tracking and reconciliation. Ideal for platforms needing granular visibility into who sent what and when.
\n
Digital Wallets & Balances: Support digital wallets by integrating dedicated VAs per wallet to manage real-time balances.
\n
In-House Banking / Treasury Management: Use VAs to simulate an internal banking structure. This supports efficient ledger transfers between your internal entities, lowering operational cost and friction.
\n
One-Time Transaction Handling (Events, Invoices, Deposits): Create temporary or dynamic VAs for specific, short-term needs.
\n
Local & Multi-Currency Receivables: Facilitate local payments in multiple currencies and countries without opening physical accounts.
\n

\n","_postman_id":"ff07740d-73c0-467c-9562-62cfb6e54952"},{"name":"🌎 Paypal Wallet","item":[{"name":"Purchase","id":"d4e6c4cc-81ab-4684-96ac-aa75f2ba9f58","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer {{APIKey}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"client\": {\n \"email\": \"user6085@example.com\",\n \"country\": \"US\",\n \"city\": \"Brookfield\",\n \"stateCode\": \"ca\",\n \"street_address\": \"test test\",\n \"zip_code\": \"234567\",\n \"phone\": \"+1 202 555 0185\"\n },\n \"purchase\": {\n \"products\": [\n {\n \"name\": \"Apple\",\n \"price\": \"10\"\n }\n ]\n },\n \"brand_id\": \"your-brand-id\",\n \"merchantRef\": \"d9db7ec0-f94c-4a9d-8883-54c19c222d81\",\n \"paymentMethod\" : \"PAYPAL\",\n \"success_redirect\": \"https://your.success.redirect.com\",\n \"pending_redirect\": \"https://your.pending.redirect.com\",\n \"failure_redirect\": \"https://your.failure.redirect.com\",\n \"success_callback\": \"https://your.success.callback.com\",\n \"failure_callback\": \"https://your.failure.callback.com\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.paysecure.net/api/v1/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

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.

","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"cdf7cf15-95fa-4cc0-8593-6b14c683fead","id":"cdf7cf15-95fa-4cc0-8593-6b14c683fead","name":"🌎 Paypal Wallet","type":"folder"}},"urlObject":{"path":["purchases"],"host":["https://api.paysecure.net/api/v1"],"query":[],"variable":[]}},"response":[{"id":"98b6c8fd-c2b3-4d9e-89b4-00a2877d6cb7","name":"Success","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer {{APIKey}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"client\": {\n \"email\": \"user6085@example.com\",\n \"country\": \"US\",\n \"city\": \"Brookfield\",\n \"stateCode\": \"ca\",\n \"street_address\": \"test test\",\n \"zip_code\": \"234567\",\n \"phone\": \"+1 202 555 0185\"\n },\n \"purchase\": {\n \"products\": [\n {\n \"name\": \"Apple\",\n \"price\": \"10\"\n }\n ]\n },\n \"brand_id\": \"your-brand-id\",\n \"merchantRef\": \"d9db7ec0-f94c-4a9d-8883-54c19c222d81\",\n \"paymentMethod\" : \"PAYPAL\",\n \"success_redirect\": \"https://your.success.redirect.com\",\n \"pending_redirect\": \"https://your.pending.redirect.com\",\n \"failure_redirect\": \"https://your.failure.redirect.com\",\n \"success_callback\": \"https://your.success.callback.com\",\n \"failure_callback\": \"https://your.failure.callback.com\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.paysecure.net/api/v1/purchases"},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[{"key":"Date","value":"Sun, 15 Feb 2026 03:50:02 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":"bff1fdeb-28e1-453f-b2c0-99f3a69a4938"},{"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 3b66cea026f27925ba048cc96a0885ca.cloudfront.net (CloudFront)"},{"key":"X-Amz-Cf-Pop","value":"IAD61-P10"},{"key":"X-Amz-Cf-Id","value":"yfsFsvL9XV7VqG78CQKk9laeRufDW3YWnRMAbS5V0kuDeFbLRHCRoA=="},{"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=ph60P%2FQ%2BttujGhCyzKI4n0CieSKGeWXBq3hNAFV28RI6CHN0ZTI40y6TOdReaik7ID1%2BIrBFGqV3ifMplb6P4ahjmnh9pVLeT9kmoh4DzVA%3D\"}]}"},{"key":"CF-RAY","value":"9ce1d6ba4e8891fa-IAD"}],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\n \"purchaseId\": \"64b032c3c6dccf7d329d9e7e\",\n \"client\": {\n \"email\": \"user6085@example.com\",\n \"country\": \"US\",\n \"city\": \"Brookfield\",\n \"stateCode\": \"ca\",\n \"street_address\": \"test test\",\n \"zip_code\": \"234567\",\n \"phone\": \"+1 202 555 0185\"\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 \"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\": \"Apple\",\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\": \"your-brand-id\",\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 \"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 \"platform\": \"API\",\n \"created_from_ip\": \"203.0.113.133\",\n \"checkout_url\": \"http://api.paysecure.net/payments/64b032c3c6dccf7d329d9e7e/\",\n \"direct_post_url\": \"http://api.paysecure.net/api/v1/p/64b032c3c6dccf7d329d9e7e/\"\n}"}],"_postman_id":"d4e6c4cc-81ab-4684-96ac-aa75f2ba9f58"}],"id":"cdf7cf15-95fa-4cc0-8593-6b14c683fead","description":"

Overview

The PayPal Wallet integration enables merchants to accept payments from over 400 million active users worldwide. As one of the most trusted names in digital payments, offering PayPal can significantly increase conversion rates by providing a familiar, secure, and friction-free checkout experience.

Unlike traditional card payments where users must manually enter sensitive details, the PayPal Wallet allows customers to pay using their stored credentials (credit cards, bank accounts, or PayPal balance) via a secure login.

Key Features & Benefits

Higher Approval Rates: Transactions are authenticated directly by the user via their PayPal app or login, reducing the risk of fraud and issuer declines.
\n
Frictionless Checkout: Supports \"One Touch™\" payments, allowing returning users to skip login and pay in a single click.
\n
Global Reach: Automatically handles currency conversion, allowing you to accept payments from customers in 200+ markets.
\n
Security: Sensitive financial details are never shared with the merchant, minimizing your PCI compliance burden.
\n

How it Works

Since PayPal requires user authentication, the integration follows a Redirect pattern:

Initiate: You send a purchase request to Paysecure with paymentMethod: PAYPAL.
\n
Redirect: Paysecure returns a checkout_url. You send the customer's browser to this URL.
\n
Authenticate: The customer logs into PayPal and approves the amount.
\n
Return: PayPal redirects the customer back to your success_redirect URL, and Paysecure triggers a server-to-server webhook to confirm the status.
\n

OVERIEW

The createCustomer API allows merchants to create a customer profile on PaySecure when a user visits their website, facilitating a seamless payment experience by pre-filling the customer's details, on the PaySecure 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	user8912@example.com
fullName	String	Yes	Full name of the customer.	Reese Nakamura
emailId	String	Yes	Email address of the customer.	user3456@example.com
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.	Riverton
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.	24 Sample Avenue
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 Paysecure API with the customer's details.
\n
Customer ID generation: Paysecure 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.

\n","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"6e00f7c7-d2f5-4e70-b5ae-878896f194c8","id":"6e00f7c7-d2f5-4e70-b5ae-878896f194c8","name":"💳 Virtual Cards Payout","type":"folder"}},"urlObject":{"path":["customer"],"host":["https://api.paysecure.net/api/v1"],"query":[],"variable":[]}},"response":[{"id":"bfe382bd-d85e-4b19-86be-83a9e64c0f1b","name":"Success","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"*/*","type":"text"},{"key":"BrandId","value":"your-brand-id","description":"If this parameter is passed in the header, a unique customer will be created under that particular Brand Name. else, the customer will be created under the main merchant (irrespective of the brands)","type":"text"},{"key":"Authorization","value":"Bearer {{APIKey}}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"fullName\": \"Reese Nakamura\",\r\n \"emailId\": \"user7734@example.com\",\r\n \"dateOfBirth\": \"1994-06-03\",\r\n \"phoneNo\": \"+91 797639082\",\r\n \"city\": \"Riverton\",\r\n \"stateCode\": \"RJ\",\r\n \"zipCode\": \"302018\",\r\n \"address\": \"24 Sample Avenue\",\r\n \"country\": \"IN\",\r\n \"merchantCustomerId\": \"user8912@example.com\",\r\n \"CustRegDate\": \"2023-12-27\", //non-mandatory - customer registration date on merchant site\r\n \"SuccessTxn\": \"32\", //non-mandatory - total successful customer orders on merchant site\r\n \"extraParam\": {\r\n \"param1\": \"value1\",\r\n \"param2\": \"value2\",\r\n \"param3\": \"value3\",\r\n \"param4\": \"value4\"\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.paysecure.net/api/v1/customer"},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":"{\r\n \"customerId\": \"691afbc6fd96d34a8113a34d\",\r\n \"merchantCustomerId\": \"user8912@example.com\",\r\n \"fullName\": \"Reese Nakamura\",\r\n \"emailId\": \"user7734@example.com\",\r\n \"dateOfBirth\": \"1994-06-03\",\r\n \"phoneNo\": \"+91 797639082\",\r\n \"brandID\": \"your-brand-id\",\r\n \"city\": \"Riverton\",\r\n \"zipCode\": \"302018\",\r\n \"address\": \"24 Sample Avenue\",\r\n \"country\": \"IN\",\r\n \"stateCode\": \"RJ\",\r\n \"custRegDate\": \"2023-12-27\",\r\n \"successTrans\": 0,\r\n \"createdOn\": 1763376070,\r\n \"lastUpdated\": 0,\r\n \"lastActivity\": 1763376070,\r\n \"extraParam\": {\r\n \"param1\": \"value1\",\r\n \"param2\": \"value2\",\r\n \"param3\": \"value3\",\r\n \"param4\": \"value4\"\r\n }\r\n}"},{"id":"b3ebcf8e-fbd6-4765-8e12-a4e759537a87","name":"Failure","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"*/*","type":"text"},{"key":"BrandId","value":"your-brand-id","description":"If this parameter is passed in the header, a unique customer will be created under that particular Brand Name. else, the customer will be created under the main merchant (irrespective of the brands)","type":"text"},{"key":"Authorization","value":"Bearer {{APIKey}}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"fullName\": \"Reese Nakamura\",\r\n \"emailId\": \"user7734@example.com\",\r\n \"dateOfBirth\": \"1994-06-03\",\r\n \"phoneNo\": \"+91 797639082\",\r\n \"city\": \"Riverton\",\r\n \"stateCode\": \"RJ\",\r\n \"zipCode\": \"302018\",\r\n \"address\": \"24 Sample Avenue\",\r\n \"country\": \"IN\",\r\n \"merchantCustomerId\": \"user8912@example.com\",\r\n \"CustRegDate\": \"2023-12-27\", //non-mandatory - customer registration date on merchant site\r\n \"SuccessTxn\": \"32\", //non-mandatory - total successful customer orders on merchant site\r\n \"extraParam\": {\r\n \"param1\": \"value1\",\r\n \"param2\": \"value2\",\r\n \"param3\": \"value3\",\r\n \"param4\": \"value4\"\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.paysecure.net/api/v1/customer"},"status":"Bad Request","code":400,"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":"{\r\n \"message\": \"Invalid Email Format\",\r\n \"code\": \"invalid_email\"\r\n}"},{"id":"895b9336-f73d-4c6c-9cb1-ed709300621f","name":"Existing Customer","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"*/*","type":"text"},{"key":"BrandId","value":"your-brand-id","description":"If this parameter is passed in the header, a unique customer will be created under that particular Brand Name. else, the customer will be created under the main merchant (irrespective of the brands)","type":"text"},{"key":"Authorization","value":"Bearer {{APIKey}}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"fullName\": \"Reese Nakamura\",\r\n \"emailId\": \"user7734@example.com\",\r\n \"dateOfBirth\": \"1994-06-03\",\r\n \"phoneNo\": \"+91 797639082\",\r\n \"city\": \"Riverton\",\r\n \"stateCode\": \"RJ\",\r\n \"zipCode\": \"302018\",\r\n \"address\": \"24 Sample Avenue\",\r\n \"country\": \"IN\",\r\n \"merchantCustomerId\": \"user8912@example.com\",\r\n \"CustRegDate\": \"2023-12-27\", //non-mandatory - customer registration date on merchant site\r\n \"SuccessTxn\": \"32\", //non-mandatory - total successful customer orders on merchant site\r\n \"extraParam\": {\r\n \"param1\": \"value1\",\r\n \"param2\": \"value2\",\r\n \"param3\": \"value3\",\r\n \"param4\": \"value4\"\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.paysecure.net/api/v1/customer"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":"{\r\n \"message\": \"Customer already exists with this information\",\r\n \"code\": \"customer_already_exists\"\r\n}"}],"_postman_id":"43c62cd4-9498-43c1-a8da-439e7b53eb70"},{"name":"Get Customer","id":"268704d8-586a-41ad-a1e9-1cb4b27a7111","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{APIKey}}","type":"text"},{"key":"BrandId","value":"your-brand-id","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"*/*","type":"text"}],"body":{"mode":"raw","raw":"{\n \"merchantCustomerId\": \"user5489@example.com\"\n}","options":{"raw":{"language":"json"}}},"url":"/customer","description":"

This endpoint makes an HTTP GET request to retrieve customer information from the Paysecure 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.

To Initiate a payout, the very first call to make is /payout/

with the required data in the request body.

To generate a Payout, you are required to provide the API key (in the header) can be located in the Dashboard section of your merchant account login.

The request body structure is shown on the request body of the example request shown here.

\n","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"6e00f7c7-d2f5-4e70-b5ae-878896f194c8","id":"6e00f7c7-d2f5-4e70-b5ae-878896f194c8","name":"💳 Virtual Cards Payout","type":"folder"}},"urlObject":{"path":["payout",""],"host":["https://api.paysecure.net/api/v1"],"query":[],"variable":[]}},"response":[{"id":"02d8d10f-0740-4156-b85c-6e5052bd6e02","name":"success","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer {{APIKey}}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"client\": {\r\n \"customerId\": \"684fe5700eb6476b179037aa\",\r\n \"email\": \"user5424@example.com\",\r\n \"phone\": \"1234567890\",\r\n \"country\": \"SG\",\r\n \"full_name\": \"Avery Larsen\"\r\n },\r\n \"payoutMethod\": \"Payout-virtual-cards\",\r\n \"amount\": 10,\r\n \"currency\": \"USD\",\r\n \"purpose\": \"payout to test\",\r\n \"success_callback\": \"https://your.success.callback.com\",\r\n \"failure_callback\": \"https://your.failure.callback.com\",\r\n \"extraParam\": {\r\n \"productType\": \"WELFARE\"\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.paysecure.net/api/v1/payout/"},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":"{\r\n \"payoutId\": \"685faaf0b93cc30dd78957c6\",\r\n \"client\": {\r\n \"customerId\": \"685fa7d7b93cc30dd78956c1\",\r\n \"email\": \"user3602@example.com\",\r\n \"phone\": \"+918839471520\",\r\n \"full_name\": \"Reese Nakamura\",\r\n \"street_address\": \"90 Fixture Close\",\r\n \"country\": \"FR\",\r\n \"city\": \"Ashford\",\r\n \"zip_code\": \"202020\",\r\n \"stateCode\": \"RA\"\r\n },\r\n \"updated_on\": 1751100145,\r\n \"payoutMethod\": \"PAYOUT-VIRTUAL-CARDS\",\r\n \"amountUnit\": \"MAJOR\",\r\n \"amount\": 5.0,\r\n \"errorMsg\": \"\",\r\n \"purpose\": \"payout to test\",\r\n \"created_on\": 1751100145,\r\n \"merchantRef\": \"685faaf0b93cc30dd78957c6\",\r\n \"status\": \"PAID\",\r\n \"status_history\": [\r\n {\r\n \"status\": \"created\",\r\n \"timestamp\": 1751100145\r\n },\r\n {\r\n \"status\": \"paid\",\r\n \"timestamp\": 1751100145\r\n }\r\n ],\r\n \"currency\": \"EUR\",\r\n \"paymentOn\": 1751100145,\r\n \"taxAmount\": 0.0,\r\n \"taxPercent\": 0.0,\r\n \"redirectType\": \"POST\",\r\n \"extraParam\": {\r\n \"productType\": \"HOTAC\"\r\n },\r\n \"success_callback\": \"https://your.success.callback.com\",\r\n \"failure_callback\": \"https://your.failure.callback.com\"\r\n}"},{"id":"d00b7afe-1879-4293-bfbd-3cd0bf9605ea","name":"Failure","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer {{APIKey}}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"client\": {\r\n \"customerId\": \"684fe5700eb6476b179037aa\",\r\n \"email\": \"user5424@example.com\",\r\n \"phone\": \"1234567890\",\r\n \"country\": \"SG\",\r\n \"full_name\": \"Avery Larsen\"\r\n },\r\n \"payoutMethod\": \"Payout-virtual-cards\",\r\n \"amount\": 10,\r\n \"currency\": \"USD\",\r\n \"purpose\": \"payout to test\",\r\n \"success_callback\": \"https://your.success.callback.com\",\r\n \"failure_callback\": \"https://your.failure.callback.com\",\r\n \"extraParam\": {\r\n \"productType\": \"WELFARE\"\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.paysecure.net/api/v1/payout/"},"status":"Bad Request","code":400,"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":"{\r\n \"payoutId\": \"684fe6980696787075207f8d\",\r\n \"client\": {\r\n \"customerId\": \"684fe5700eb6476b179037aa\",\r\n \"email\": \"user5424@example.com\",\r\n \"phone\": \"1234567890\",\r\n \"country\": \"SG\",\r\n \"full_name\": \"Avery Larsen\"\r\n },\r\n \"updated_on\": 1750066843,\r\n \"payoutMethod\": \"PAYOUT-VIRTUAL-CARDS\",\r\n \"amountUnit\": \"MAJOR\",\r\n \"amount\": 100,\r\n \"errorMsg\": \"Deep link was not able to create\",\r\n \"purpose\": \"testing payout\",\r\n \"created_on\": 1750066843,\r\n \"merchantRef\": \"684fe6980696787075207f8d\",\r\n \"status\": \"ERROR\",\r\n \"status_history\": [\r\n {\r\n \"status\": \"created\",\r\n \"timestamp\": 1750066843\r\n },\r\n {\r\n \"status\": \"error\",\r\n \"timestamp\": 1750067894\r\n }\r\n ],\r\n \"currency\": \"USD\",\r\n \"extraParam\": {\r\n\t\t \"productType\" : \"Hotac\"\r\n },\r\n \"paymentOn\": 0,\r\n \"taxAmount\": 0,\r\n \"taxPercent\": 0,\r\n \"redirectType\": \"POST\",\r\n \"success_callback\": \"https://your.success.callback.com\",\r\n \"failure_callback\": \"https://your.failure.callback.com\"\r\n}"}],"_postman_id":"536bca07-e4de-42eb-b12c-7ace6cb1cd36"}],"id":"6e00f7c7-d2f5-4e70-b5ae-878896f194c8","description":"

Overview

The Virtual Card Payout solution is designed to modernize how merchants distribute funds to their users. Traditionally, payouts (winnings, compensation, or rewards) required collecting sensitive bank details, which added friction and delayed access to funds.

With Paysecure's Swiipr integration, merchants can instantly issue Virtual Mastercards directly to a user's mobile device. These cards are immediately usable online or in-store via digital wallets (Apple Pay / Google Pay).

Core Use Cases

Gaming & Sweepstakes: Instantly pay out winnings to players without waiting for bank transfers.
\n
Airline Compensation: Issue immediate funds for delayed flights or lost luggage (e.g., for food/hotel vouchers).
\n
Welfare & Relief: Distribute emergency funds securely and instantly.
\n

The \"Deeplink\" User Journey

Unlike standard payouts that go to an account, this flow delivers a card to the user:

Merchant Request: You send a payout request to Paysecure with the user's mobile number and amount.
\n
Instant Notification: The user receives an SMS or Email containing a secure Deeplink.
\n
Activation:
\n
- New Users: The link prompts them to download the Swiipr App.
  \n
- Existing Users: The link opens the app directly.
  \n
\n
Claim & Spend: The user validates their mobile number, claims the virtual card, and provisions it to their Apple Wallet or Google Pay in one tap.
\n

Key Features

Instant Issuance: Cards are generated in real-time.
\n
Mobile-First: The entire experience is handled via the user's smartphone.
\n
Secure: No sensitive bank data is exchanged; funds are loaded onto a prepaid Mastercard.
\n
Flexible Funding: Merchants pre-fund their account, ensuring 100% approval rates for valid requests.
\n

PayIn Flows

How it works

Paysecure's A2A paying system, utilizes the powerful Virtual Accounts capabilities, enabling you to support a wide range of scenarios using the following methods.

Key Steps

\n\n

Flow

The merchant platform retrieves the account details (Account number, IBAN, and SWIFT code) for the merchant-assigned currency account intended for the PayIn.
\n
These account details are then provided to the payer, who is instructed to make the payment to this account.
\n
The payer accesses their banking app and inputs the provided account details along with the transaction amount.
\n
Upon receiving the money from the payer, Paysecure promptly receives an Inward Credit Notification (ICN) webhook from its banking partner, confirming that the funds have been deposited into the corresponding virtual account.
\n
The ICN contains all relevant transaction details. Paysecure forwards this notification to the merchant to inform them of the transaction.
\n

PayOut flows

How it works
Paysecure offers the ability to make payments to customers', individuals', or businesses' bank accounts using various transfer methods via its dashboard or suite of APIs. The dashboard consolidates all available features accessible through APIs, allowing you to easily go live with minimal technical setup.\"

Key Steps

\n\n

Flow

The merchant platform initiates the creation of a payout by passing beneficiary details, along with payout details.
\n
Beneficiary details include
\n
Beneficiary ID (email or phone)
\n
Beneficiary's address (is mandatory but not validated. So if you have this data we recommend you send it, otherwise, use some random value.)
\n
Beneficiary's bank details
\n
Beneficiary's name
\n
Upon completion of the payout, reaching either a Success or Failure state, Paysecure notifies the merchant’s platform via webhook, providing the final status of the transaction and additional details.
\n

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 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,415,405)

Below is the list of possible error codes and the corresponding messages from Paysecure 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

","auth":{"type":"noauth","isInherited":false},"event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":[""],"id":"0ba6dba6-6a48-4303-80ca-c9baf38f801e"}},{"listen":"test","script":{"type":"text/javascript","exec":[""],"id":"5c5b819c-4d8c-4efb-8974-12fcb2c7d454"}}],"_postman_id":"701ee845-08ce-451d-93c7-7843f452459c"},{"name":"PayIn API","item":[{"name":"Create Purchase","id":"78e6a798-84ff-4a85-a1d9-f94e6c15627c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer {{APIKey}}"}],"body":{"mode":"raw","raw":"{\r\n \"client\": {\r\n \"email\": \"user5772@example.com\",\r\n \"street_address\": \"13 Documentation Way\",\r\n \"city\": \"Riverton\",\r\n \"full_name\": \"Test test\",\r\n \"zip_code\": \"68403\",\r\n \"country\": \"DE\",\r\n \"date_of_birth\": \"1970-07-10\",\r\n \"stateCode\": \"QLD\",\r\n \"phone\": \"+447755564318\"\r\n },\r\n \"purchase\": {\r\n \"currency\": \"EUR\",\r\n \"products\": [\r\n {\r\n \"name\": \"product name\",\r\n \"price\": \"16\"\r\n }\r\n ]\r\n },\r\n \"merchantRef\": \"your-order-id\",\r\n \"paymentMethod\": \"BANKTRANSFER\",\r\n \"brand_id\": \"your-brand-id\",\r\n \"success_redirect\": \"https://your.success.redirect.com\",\r\n \"pending_redirect\": \"https://your.pending.redirect.com\",\r\n \"failure_redirect\": \"https://your.failure.redirect.com\",\r\n \"success_callback\": \"https://your.success.callback.com\",\r\n \"failure_callback\": \"https://your.failure.callback.com\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.paysecure.net/api/v1/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

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

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.

Digital Signature (Optional Parameter) :

To ensure authenticity and non-repudiation of the the pay in request, there is an option to digitally sign the pay in request by using the merchant's public key.

Public key generation :-

\n\n

Signature generation :-

This digitial signature is generated by encrypting the following elements of the pay in request:
Plaintext= Client.email+purchase.currency+ purchase.products.price+brand_id

Example of encrypt plaintext with public key in java:-

private String encryptData(String plaintext, PublicKey publicKey) throws Exception {\n    Cipher cipher = Cipher.getInstance(\"RSA\");\n    cipher.init(Cipher.ENCRYPT_MODE, publicKey);\n    byte[] encryptedbytes = cipher.doFinal(message.getBytes());\n    return new String(Base64.getEncoder * ().encode(encryptedbytes));\n}\n\n

paymentMethod

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\n\n\n\n\n\n\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	Description
Invalid format of Date_of_Birth[allowed format: yyyy-mm-dd]
Enter Valid Email
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
Minimum amount is not set for this merchant
success_redirect/failure_redirect/brand_id is missing
brand_id cannot be null
success_redirect cannot be null
failure_redirect cannot be null
Invalid failure_redirect: minimum 10 characters
purchase.products.price cannot be null
purchase.products[0].name/purchase.products[0].price are missing
Your charges setting is incomplete .Plese Contact to Administrator.
Currency \"{curr_name}\" is Not Allowed
Transaction amount must be equal or greater to minimum trans amount
Allowed Limit for this card for particular time period has been consumed

Note: For certain use cases, in addition to long format purchase Id, Paysecure also provides a 7 digit unique code for each purchase starting with digit 4, eg 4000001

“purchaseIdShortCode”: “4000013\"

\n","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"30ec36dc-7a51-4ca4-b9b7-51677f55095a","id":"30ec36dc-7a51-4ca4-b9b7-51677f55095a","name":"PayIn API","type":"folder"}},"urlObject":{"path":["purchases",""],"host":["https://api.paysecure.net/api/v1"],"query":[],"variable":[]}},"response":[{"id":"03da0328-735a-4abf-a3dd-35f26c45677f","name":"Success","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer {{APIKey}}"}],"body":{"mode":"raw","raw":"{\r\n \"client\": {\r\n \"email\": \"user5772@example.com\",\r\n \"street_address\": \"13 Documentation Way\",\r\n \"city\": \"Riverton\",\r\n \"full_name\": \"Test test\",\r\n \"zip_code\": \"68403\",\r\n \"country\": \"DE\",\r\n \"date_of_birth\": \"1970-07-10\",\r\n \"stateCode\": \"QLD\",\r\n \"phone\": \"+447755564318\"\r\n },\r\n \"purchase\": {\r\n \"currency\": \"EUR\",\r\n \"products\": [\r\n {\r\n \"name\": \"product name\",\r\n \"price\": \"16\"\r\n }\r\n ]\r\n },\r\n \"merchantRef\": \"your-order-id\",\r\n \"paymentMethod\": \"BANKTRANSFER\",\r\n \"brand_id\": \"your-brand-id\",\r\n \"success_redirect\": \"https://your.success.redirect.com\",\r\n \"pending_redirect\": \"https://your.pending.redirect.com\",\r\n \"failure_redirect\": \"https://your.failure.redirect.com\",\r\n \"success_callback\": \"https://your.success.callback.com\",\r\n \"failure_callback\": \"https://your.failure.callback.com\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.paysecure.net/api/v1/purchases"},"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":"{\r\n \"purchaseId\": \"66334635a2cf2a7da7b192ab\",\r\n \"client\": {\r\n \"bank_account\": \"\",\r\n \"bank_code\": \"\",\r\n \"email\": \"user5590@example.com\",\r\n \"phone\": \"+447755564318\",\r\n \"full_name\": \"\",\r\n \"date_of_birth\": \"1970-07-10\",\r\n \"personal_code\": \"\",\r\n \"street_address\": \"asdfsa\",\r\n \"country\": \"GB\",\r\n \"city\": \"a\",\r\n \"zip_code\": \"68403\",\r\n \"shipping_street_address\": \"\",\r\n \"shipping_country\": \"\",\r\n \"shipping_city\": \"\",\r\n \"shipping_zip_code\": \"\",\r\n \"cc\": [],\r\n \"bcc\": [],\r\n \"legal_name\": \"\",\r\n \"brand_name\": \"\",\r\n \"registration_number\": \"\",\r\n \"tax_number\": \"\",\r\n \"documentId\": \"\",\r\n \"documentType\": \"\",\r\n \"bankAccountNumber\": \"\",\r\n \"bankAccount\": \"\",\r\n \"bankCode\": \"\",\r\n \"description\": \"\",\r\n \"stateCode\": \"QLD\"\r\n },\r\n \"updated_on\": 1714636341,\r\n \"type\": \"purchase\",\r\n \"paymentMethod\": \"BANKTRANSFER\",\r\n \"amountUnit\": \"MAJOR\",\r\n \"errorMsg\": \"\",\r\n \"redirectType\": \"GET\",\r\n \"force_recurring\": false,\r\n \"created_on\": 1714636341,\r\n \"merchantRef\": \"66334635a2cf2a7da7b192ab\",\r\n \"merchantName\": \"merchant002\",\r\n \"feesDeducted\": 0.3,\r\n \"purchaseIdShortCode\": “4000013\",\r\n \"purchase\": {\r\n \"currency\": \"JPY\",\r\n \"products\": [\r\n {\r\n \"name\": \"test\",\r\n \"quantity\": 1.0,\r\n \"price\": 5000.0,\r\n \"discount\": 0,\r\n \"tax_percent\": \"0.00\"\r\n }\r\n ],\r\n \"total\": 5000.0,\r\n \"language\": \"en\",\r\n \"notes\": \"\",\r\n \"debt\": 0,\r\n \"total_formatted\": 1.0,\r\n \"request_client_details\": [],\r\n \"timezone\": \"MIT\",\r\n \"email_message\": \"\"\r\n },\r\n \"payment\": {\r\n \"is_outgoing\": false,\r\n \"payment_type\": \"PURCHASE\",\r\n \"amount\": 5000.0,\r\n \"currency\": \"JPY\",\r\n \"net_amount\": 5000.0,\r\n \"fee_amount\": 0.0,\r\n \"pending_amount\": 0.0,\r\n \"pending_unfreeze_on\": null,\r\n \"description\": \"\",\r\n \"paid_on\": 1714636341,\r\n \"remote_paid_on\": 1714636341\r\n },\r\n \"issuer_details\": {\r\n \"website\": \"\",\r\n \"legal_street_address\": \"\",\r\n \"legal_country\": \"\",\r\n \"legal_city\": \"\",\r\n \"legal_zip_code\": \"\",\r\n \"bank_accounts\": [\r\n {\r\n \"bank_account\": \"\",\r\n \"bank_code\": \"\"\r\n }\r\n ],\r\n \"legal_name\": \"gdhnb\",\r\n \"brand_name\": \"gdhnb\",\r\n \"registration_number\": \"\",\r\n \"tax_number\": \"\"\r\n },\r\n \"transaction_data\": {\r\n \"payment_method\": \"\",\r\n \"flow\": \"payform\",\r\n \"extra\": {\r\n \"amount\": 5000.0,\r\n \"masked_pan\": \"BANKTRANSFER\"\r\n },\r\n \"country\": \"\",\r\n \"attempts\": [\r\n {\r\n \"client_ip\": \"203.0.113.80\",\r\n \"type\": \"execute\",\r\n \"payment_method\": \"BANKTRANSFER\",\r\n \"flow\": \"payform\",\r\n \"successful\": true,\r\n \"country\": \"BANKTRANSFER\",\r\n \"processing_time\": 1714636341,\r\n \"extra\": {\r\n \"amount\": 5000.0,\r\n \"masked_pan\": \"BANKTRANSFER\"\r\n }\r\n }\r\n ]\r\n },\r\n \"status\": \"PAYMENT_IN_PROCESS\",\r\n \"status_history\": [\r\n {\r\n \"status\": \"created\",\r\n \"timestamp\": 1714636341\r\n },\r\n {\r\n \"status\": \"pending_execute\",\r\n \"timestamp\": 1714636341\r\n },\r\n {\r\n \"status\": \"payment_in_process\",\r\n \"timestamp\": 1714636341\r\n }\r\n ],\r\n \"is_test\": false,\r\n \"brand_id\": \"your-brand-id\",\r\n \"send_receipt\": false,\r\n \"is_recurring_token\": false,\r\n \"skip_capture\": false,\r\n \"reference_generated\": \"PS8937\",\r\n \"issued\": \"2024-05-02\",\r\n \"due\": 1714636341,\r\n \"refund_upto\": 0,\r\n \"cc_descriptor\": \"\",\r\n \"fraudScore\": \"NA\",\r\n \"trustScore\": \"NA\",\r\n \"payInBankDetails\": {\r\n \"accountName\": \"ｴｱｰｳｵﾚﾂｸｽｼﾞｬﾊﾟﾝｶﾌﾞｼｷｶｲｼｬ\",\r\n \"accountNumber\": \"3194368\",\r\n \"bankName\": \"MUFG BANK, LTD. 三菱UFJ銀行\",\r\n \"swiftCode\": \"BOTKJPJT\",\r\n \"branchName\": \"ワカタケ\",\r\n \"accountType\": \"CHECKING\",\r\n \"payment_routing_parameters\": {\r\n \"BANK_CODE\": \"0005\",\r\n \"BRANCH_CODE\": \"809\"\r\n }\r\n },\r\n \"refund_availability\": \"NONE\",\r\n \"refundable_amount\": 0.0,\r\n \"success_redirect\": \"https://your.success.redirect.com\",\r\n \"failure_redirect\": \"https://your.failure.redirect.com\",\r\n \"cancel_redirect\": \"\",\r\n \"success_callback\": \"https://your.success.callback.com\",\r\n \"failure_callback\": \"https://your.failure.callback.com\",\r\n \"platform\": \"API\",\r\n \"created_from_ip\": \"203.0.113.80\",\r\n \"checkout_url\": \"https://api.paysecure.net/payments/66334635a2cf2a7da7b192ab/\"\r\n}"},{"id":"376c19a7-2dcb-494f-abaf-575d62cf6176","name":"Failure","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer {{APIKey}}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"client\": {\r\n \"email\": \"user5772@example.com\",\r\n \"street_address\": \"13 Documentation Way\",\r\n \"city\": \"Riverton\",\r\n \"full_name\": \"Test test\",\r\n \"zip_code\": \"68403\",\r\n \"country\": \"DE\",\r\n \"date_of_birth\": \"1970-07-10\",\r\n \"stateCode\": \"QLD\",\r\n \"phone\": \"+447755564318\"\r\n },\r\n \"purchase\": {\r\n \"currency\": \"EUR\",\r\n \"products\": [\r\n {\r\n \"name\": \"product name\",\r\n \"price\": \"16\"\r\n }\r\n ]\r\n },\r\n \"merchantRef\": \"your-order-id\",\r\n \"paymentMethod\": \"BANKTRANSFER\",\r\n \"brand_id\": \"your-brand-id\",\r\n \"success_redirect\": \"https://your.success.redirect.com\",\r\n \"pending_redirect\": \"https://your.pending.redirect.com\",\r\n \"failure_redirect\": \"https://your.failure.redirect.com\",\r\n \"success_callback\": \"https://your.success.callback.com\",\r\n \"failure_callback\": \"https://your.failure.callback.com\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.paysecure.net/api/v1/purchases"},"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":"{\r\n \"message\": \"Error Message\",\r\n \"code\": \"error_code\"\r\n}\r\n"}],"_postman_id":"78e6a798-84ff-4a85-a1d9-f94e6c15627c"},{"name":"Get Status","id":"b9c091f6-c8b0-4425-8914-c909fb1d62df","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer {{APIKey}}","type":"text"}],"url":"https://api.paysecure.net/api/v1/purchases/{purchaseId}/","description":"

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

Note: With respect to bank transfers, the purchase request is synonymous with the PayIn request.

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

Status	Notes
paid	Transaction Successful
payment_in_process	Payment is under Processing
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.

API Flow

\n\n

The merchant initiates the purchase via the create purchase API. If successful, they receive PayIn bank details along with a checkout URL in the response JSON
\n
The merchant then has 2 options
\n
1. Use the PayIn bank details in the JSON to create a webpage within the merchant’s IT estate, and show to user the PayIn instruction
  \n
2. Or direct the end-user to our checkout URL, where the client sees bank details for payment.
  \n
\n
After a successful or failed payment by the end user, an appropriate webhook would be sent to the merchant. If option 2b was the method employed, the user would be redirected to the appropriate redirect URL.
\n

To Initiate a payment, the very first call to make is /payout/ with the required data in the request body.

To generate a Payout, you are required to provide the API key (in the header) can be located in the Dashboard section of your merchant account login.

The request body structure is shown on the request body of the example request shown here.

The following (see table below) are the mandatory parameters that are required to create a Payout 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.full_name	Full name of the receiver. Minimum 2 words with atleast 1 character in each word.
client.email	An Identifier for a receiver, should be a valid email.
client.country	ISO-3166 Country Code. It must be upper case.
client.stateCode	State of the receiver. Must be in upper case.
client.street_address	street address of the receiver.
client.zip_code	zip code of the receiver.
client.phone	Phone number of the receiver. Country code is mandatory. Example: +234999999999
payoutMethod	Payout-MOBILEMONEY
Amount	Amount in currency upto 2 decimal points
Currency	Note this is currency account for which you have balance.
success_redirect	URL to send the user if the payout is successful
pending_redirect	URL to send the user if the payout is in progress
failure_redirect	URL to send the user if the payout is unsuccessful.
Purpose	Purpose of Payout

Required parameters in the request body for this use case:

\n\n\n\n\n\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
beneficiaryDetail.bankName	The Bank Name in which the customer want's to credit the money. Optional Field. If passed, only use the mentioned bank names below. Anything else might lead to payout failures. If you don't want to pass, then you might need to open our checkout_url in the response and user can select the Bank from the dropdown.
beneficiaryDetail.bankAccountName	Mandatory Field. Account Holder's Full Name. It is advised to have atleast 2 words in the name.
beneficiaryDetail.bankAccountCurrency	Optional Field. The Currency in which the money will be credited. Generally the same as the currency field mentioned above.
beneficiaryDetail.bankAccountNumber	Mandatory Field. Account Holder's Account Number. This is the account in which the money will be credited.
beneficiaryDetail.bankCountryCode	Optional Field. The country code in which the account exist. Generally the same as the country field mentioned above.

","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"c65b8afb-aa46-4a33-8118-b7d216b9c105","id":"c65b8afb-aa46-4a33-8118-b7d216b9c105","name":"PayOut API","type":"folder"}},"urlObject":{"path":["payout",""],"host":["https://api.paysecure.net/api/v1"],"query":[],"variable":[]}},"response":[{"id":"0a4fe3dc-f18a-4837-a841-7a19aaaaa281","name":"Success","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer {{APIKey}}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"client\": {\r\n \"email\": \"user3069@example.com\",\r\n \"country\": \"AT\",\r\n \"city\": \"Riverton\",\r\n \"stateCode\": \"QLD\",\r\n \"full_name\": \"Test test\",\r\n \"street_address\": \"13 Documentation Way\",\r\n \"zip_code\": \"68403\",\r\n \"phone\": \"+448839471521\",\r\n \"gender\": \"M\",\r\n \"date_of_birth\": \"1970-07-10\"\r\n },\r\n \"beneficiaryDetail\": {\r\n \"bankAccountName\": \"Reese Nakamura\",\r\n \"bankAccountNumber\": \"645101511808\",\r\n \"bankCountryCode\": \"AT\"\r\n },\r\n \"purpose\": \"Testing payout\",\r\n \"currency\": \"EUR\",\r\n \"payoutMethod\": \"PAYOUT-BANKTRANSFER\",\r\n \"amount\": 10.0,\r\n \"brandId\": \"your-brand-id\",\r\n \"success_redirect\": \"https://your.success.redirect.com\",\r\n \"pending_redirect\": \"https://your.pending.redirect.com\",\r\n \"failure_redirect\": \"https://your.failure.redirect.com\",\r\n \"success_callback\": \"https://your.success.callback.com\",\r\n \"failure_callback\": \"https://your.failure.callback.com\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.paysecure.net/api/v1/payout/"},"status":"Accepted","code":202,"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":"{\r\n \"payoutId\": \"65ffadb4c1c83822903a9205\",\r\n \"client\": {\r\n \"email\": \"user3069@example.com\",\r\n \"country\": \"DE\",\r\n \"city\": \"Riverton\",\r\n \"stateCode\": \"QLD\",\r\n \"full_name\": \"Test test\",\r\n \"street_address\": \"13 Documentation Way\",\r\n \"zip_code\": \"68403\",\r\n \"phone\": \"+448839471521\",\r\n \"gender\": \"M\",\r\n \"date_of_birth\": \"1970-07-10\"\r\n },\r\n \"updated_on\": 1711254964,\r\n \"payoutMethod\": \"Payout-BANKTRANSFER\",\r\n\t\"beneficiaryDetail\":{\r\n \"bankAccountName\": \"Reese Nakamura\",\r\n \"bankAccountNumber\": \"645101511808\",\r\n \"bankName\": \"ICICI Bank\"\r\n },\r\n \"amountUnit\": \"MAJOR\",\r\n \"amount\": 10.0,\r\n \"errorMsg\": \"Currency Account has insufficient balance.\",\r\n \"purpose\": \"test payout\",\r\n \"created_on\": 1711254972,\r\n \"merchantRef\": \"65ffadb4c1c83822903a9205\",\r\n \"status\": \"PAID\",\r\n \"status_history\": [\r\n {\r\n \"status\": \"created\",\r\n \"timestamp\": 1711254964\r\n },\r\n {\r\n \"status\": \"paid\",\r\n \"timestamp\": 1711254972\r\n }\r\n ],\r\n \"currency\": \"EUR\",\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}\r\n"},{"id":"f6334fb6-23fe-4cde-ac4d-2b3f7d853ed1","name":"Failure","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer {{APIKey}}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"client\": {\r\n \"email\": \"user3069@example.com\",\r\n \"country\": \"DE\",\r\n \"city\": \"Riverton\",\r\n \"stateCode\": \"QLD\",\r\n \"full_name\": \"Test test\",\r\n \"street_address\": \"13 Documentation Way\",\r\n \"zip_code\": \"68403\",\r\n \"phone\": \"+448839471521\",\r\n \"gender\": \"M\",\r\n \"date_of_birth\": \"1970-07-10\"\r\n },\r\n \"beneficiaryDetail\": {\r\n \"bankAccountName\": \"Reese Nakamura\",\r\n \"bankAccountNumber\": \"645101511808\",\r\n \"bankName\": \"ICICI Bank\"\r\n },\r\n \"purpose\": \"Testing payout\",\r\n \"currency\": \"EUR\",\r\n \"payoutMethod\": \"PAYOUT-BANKTRANSFER\",\r\n \"amount\": 10.0,\r\n \"brandId\": \"your-brand-id\",\r\n \"success_redirect\": \"https://your.success.redirect.com\",\r\n \"pending_redirect\": \"https://your.pending.redirect.com\",\r\n \"failure_redirect\": \"https://your.failure.redirect.com\",\r\n \"success_callback\": \"https://your.success.callback.com\",\r\n \"failure_callback\": \"https://your.failure.callback.com\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.paysecure.net/api/v1/payout/"},"status":"Bad Request","code":400,"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":" {\r\n \"message\": \"Error Message\",\r\n \"code\": \"error_code\"\r\n}"}],"_postman_id":"13bb8bb5-ba5a-47ff-b447-a235cb7462ce"},{"name":"Get Status","id":"4680e0d3-8a01-4465-a913-69fb7bc7535f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.paysecure.net/api/v1/getpayout/{payoutId}/","description":"

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

Mandatory

you need to pass the payoutId 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
payout_in_process	payout is under Processing.
error	Transaction has Failed.

The webhook will only be triggered for paid transactions or errors.

Paid: \"success_callback\": \"https://your.success.callback.com\",

Error: \"failure_callback\": “https://failure.com”

\n","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"c65b8afb-aa46-4a33-8118-b7d216b9c105","id":"c65b8afb-aa46-4a33-8118-b7d216b9c105","name":"PayOut API","type":"folder"}},"urlObject":{"path":["getpayout","{payoutId}",""],"host":["https://api.paysecure.net/api/v1"],"query":[],"variable":[]}},"response":[{"id":"4aaf7cf6-a9fa-474f-9cf1-65c8a3357da6","name":"Get Status","originalRequest":{"method":"GET","header":[],"url":"https://api.paysecure.net/api/v1/getpayout/{payoutId}/"},"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":"{\r\n \"payoutId\": \"65ffadb4c1c83822903a9205\",\r\n \"client\": {\r\n \"email\": \"user5424@example.com\",\r\n \"full_name\": \"Avery Larsen\",\r\n \"street_address\": \"13 Documentation Way\",\r\n \"country\": \"SG\",\r\n \"city\": \"Oakdale\",\r\n \"zip_code\": \"123456\",\r\n \"stateCode\": \"test\"\r\n },\r\n \"updated_on\": 1711254964,\r\n \"payoutMethod\": \"Payout-BANKTRANSFER\",\r\n \"beneficiaryDetail\":{\r\n \"bankName\": \"DBS Bank\", \r\n \"bankAccountName\": \"test test\",\r\n \"bankAccountCurrency\": \"SGD\",\r\n \"bankAccountNumber\": \"12345640\",\r\n \"bankCountryCode\" : \"SG\",\r\n \"swiftCode\": \"DBSSSGSG\",\r\n \"routing_param\" :\r\n {\r\n \"bankCode\": \"897678\",\r\n \"bankBranchCode\" : \"888\"\r\n \r\n }\r\n },\r\n \"amountUnit\": \"MAJOR\",\r\n \"amount\": 1000.0,\r\n \"errorMsg\": \"Currency Account has insufficient balance.\",\r\n \"purpose\": \"test payout\",\r\n \"created_on\": 1711254972,\r\n \"merchantRef\": \"65ffadb4c1c83822903a9205\",\r\n \"status\": \"ERROR\",\r\n \"status_history\": [\r\n {\r\n \"status\": \"created\",\r\n \"timestamp\": 1711254964\r\n },\r\n {\r\n \"status\": \"error\",\r\n \"timestamp\": 1711254972\r\n }\r\n ],\r\n \"currency\": \"USD\",\r\n \"success_callback\": \"https://your.success.callback.com\",\r\n \"failure_callback\": \"https://your.failure.callback.com\"\r\n}\r\n"},{"id":"c6a68505-4f0b-4c76-a4dc-5408be9eee82","name":"Get Status-error","originalRequest":{"method":"GET","header":[],"url":"https://api.paysecure.net/api/v1/getpayout/{payoutId}/"},"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":"{\r\n \"message\": \"Error Message\",\r\n \"code\": \"error_code\"\r\n}"}],"_postman_id":"4680e0d3-8a01-4465-a913-69fb7bc7535f"}],"id":"c65b8afb-aa46-4a33-8118-b7d216b9c105","description":"

API Flow

\n\n

At the time of onboarding, the merchant will be given the option of currency accounts. Typically, a merchant will have one currency account in one jurisdiction, but our platform allows for multiple currency accounts for merchants. Please contact your account manager if you need multicurrency accounts. Please note that there may be some restrictions on multicurrency accounts depending on the jurisdictions and commercials.

Our system also caters to multiple business accounts within one merchant account for better financial risk management. If more than one business is onboarded for a merchant (each needing its own KYB), then our system would handle the complexity of balance distribution among the accounts in the backend and give simple easy-to-use APIs for merchants.

API for Checking Balance payout

URL :- /getBalance/
\n
RequestType: POST
\n
Request Body
\n

\n","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"0dcc34d7-1480-45be-8bb6-5375e32a5bb7","id":"0dcc34d7-1480-45be-8bb6-5375e32a5bb7","name":"Get Balance API","type":"folder"}},"urlObject":{"path":["getBalance"],"host":["https://api.paysecure.net/api/v1"],"query":[],"variable":[]}},"response":[{"id":"f3e52157-3334-4844-ae5a-a80a099640ba","name":"Success","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\r\n \"paymentMethod\": \"BANKTRANSFER\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.paysecure.net/api/v1/getBalance"},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":"{\r\n \"paymentMethod\": \"BANKTRANSFER\",\r\n \"status\": \"success\",\r\n \"data\": [\r\n {\r\n \"currency\": \"AUD\",\r\n \"balance\": \"0.00\"\r\n },\r\n {\r\n \"currency\": \"USD\",\r\n \"balance\": \"46813.79\"\r\n },\r\n {\r\n \"currency\": \"JPY\",\r\n \"balance\": \"1012.00\"\r\n }\r\n ]\r\n}\r\n"},{"id":"150c749f-2a3b-473e-a333-806f487ff10d","name":"Failure","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\r\n \"paymentMethod\": \"BANKTRANSFER\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.paysecure.net/api/v1/getBalance"},"status":"Bad Request","code":400,"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":"{\r\n \"message\": \"Error Message\",\r\n \"code\": \"No currency account found\"\r\n}\r\n"}],"_postman_id":"5275fca1-8102-48f4-92ab-9d41e195e0e3"}],"id":"0dcc34d7-1480-45be-8bb6-5375e32a5bb7","auth":{"type":"noauth","isInherited":false},"event":[{"listen":"prerequest","script":{"type":"text/javascript","packages":{},"requests":{},"exec":[""],"id":"7a7d1ac0-83ad-465e-8c58-91b57121efb9"}},{"listen":"test","script":{"type":"text/javascript","packages":{},"requests":{},"exec":[""],"id":"8e8be744-66dd-4344-bfb0-50bdf1a85f83"}}],"_postman_id":"0dcc34d7-1480-45be-8bb6-5375e32a5bb7","description":""}],"id":"3e586c4a-498e-4db9-a239-f7b725c57250","_postman_id":"3e586c4a-498e-4db9-a239-f7b725c57250","description":""},{"name":"OpenBanking - EUR 🇪🇺 & UK 🇬🇧","item":[{"name":"Concepts","item":[],"id":"3fe29883-279e-4bb7-bc9b-c586aa80dcf6","description":"

Overview

Paysecure leverages its Open Banking network across Europe and the UK to make secure, fast, bank-to-bank payments. Customers pay in EUR or GBP via the Paysecure Gateway, directly from their bank account. This is a top choice for customers in these regions who prefer paying from their bank over cards.

The Paysecure Gateway is a hosted web page that handles all user interaction during payment initiation: credential input, interactive confirmation, progress reporting, and error reporting. After your application receives the payment URL (checkout_url), you redirect the customer to it; they pick their provider/bank, authenticate, and are redirected back to your application.

\n\n

Coverage & Limits

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

Region	Processing currency	Countries
Europe	`EUR`	Austria, Belgium, Bulgaria, Czech Republic, Denmark, Estonia, Finland, France, Germany, Hungary, Ireland, Italy, Latvia, Lithuania, Luxembourg, Netherlands, Norway, Poland, Portugal, Romania, Slovakia, Spain, Sweden, Switzerland
United Kingdom	`GBP`	United Kingdom

Transaction limits and the purchase expiry window (how long the customer has to complete payment before the purchase moves to expired) are set per merchant profile / provider. Contact your Account Manager for the exact values enabled on your account.

PayIn Flow

How it works: you create a purchase with paymentMethod set to OPEN-BANKING. Paysecure returns a checkout_url; you redirect the customer there, they select their bank and authorise the payment inside their bank, and Paysecure notifies you of the result via webhook while redirecting the customer back to your site.

Flow

Customer selects Open Banking: at checkout, the customer chooses Open Banking as the payment method.
\n
Merchant creates the purchase: you call POST https://api.paysecure.net/api/v1/purchases/ with paymentMethod = OPEN-BANKING and receive a purchaseId and checkout_url.
\n
Redirect to bank: you redirect the customer to the checkout_url; on the Paysecure Gateway they select their provider/bank and are taken to their bank's login page.
\n
Customer authenticates: the customer logs in to their online banking and reviews the pre-filled payment details. Credentials stay with the bank - they are never shared with you or Paysecure.
\n
Customer authorises: the customer authorises the payment using their bank's method (e.g. OTP, app approval). The bank debits the account.
\n
Confirmation: the bank confirms to Paysecure; Paysecure fires the paid webhook to your success_callback and the purchase status becomes paid.
\n
Redirect back: the customer is redirected to your success_redirect, where you show a confirmation page. Always treat the webhook (or a Get Status call) as the source of truth, not the redirect alone.
\n

Unhappy paths: if the customer abandons or does not complete authorisation in time, the purchase becomes expired; if the bank declines, it becomes error. Handle both in your integration.

Webhook Events

These are the events you can expect for an Open Banking purchase. See the global Webhooks section for the payload shape and signature verification.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\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	Status	When it fires	Terminal?
purchase created	`created`	Purchase registered, awaiting customer	No
payment in process	`payment_in_process`	Customer authorised at the bank, awaiting settlement confirmation	No
purchase paid	`paid`	Funds confirmed by the bank	Yes
purchase expired	`expired`	Customer did not complete payment within the allowed window	Yes
purchase error	`error`	Payment failed or was declined	Yes
refund in process	`refund_in_process`	A refund has been initiated, awaiting the bank	No
purchase refunded	`refunded`	Refund confirmed by the bank	Yes

FAQs

Which currencies can I charge in? EUR for the European countries listed above and GBP for the UK. The customer's bank may convert from their local currency.

Are refunds supported? Yes - full refunds only, once the purchase is paid. Partial refunds are not supported.

Are chargebacks possible? Open Banking is a bank-to-bank push payment, so card-style chargebacks do not apply. Disputes, where they occur, are handled bank-side and are rare.

How fast is confirmation? Typically real-time - you receive the paid webhook once the customer's bank confirms the transfer.

To initiate a payment, the very first call to make is /purchases with the required data in the request body. Set paymentMethod to OPEN-BANKING to route the purchase through the Open Banking flow.

To generate a purchase you must provide your brand_id (in the request body) and your API key (in the Authorization header). Both can be located in the Dashboard section of your merchant account login.

On success you receive a purchaseId and a checkout_url; redirect the customer to the checkout_url to complete the payment at their bank.

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

Parameter	Notes
client.email	Mandatory. The customer's email address.
client.full_name	Optional. The customer's full name.
client.country	Mandatory. ISO 3166-1 alpha-2 country code, upper case (e.g. `GB`, `DE`). Must be a supported Open Banking country.
client.city	Mandatory. The customer's city.
client.stateCode	Mandatory. State / region code, upper case (e.g. `LND`).
client.street_address	Mandatory. The customer's street address.
client.zip_code	Mandatory. The customer's ZIP / postal code.
client.date_of_birth	Optional. Format `yyyy-mm-dd`.
client.phone	Optional. Customer phone in international format (e.g. `+44...`).
client.gender	Optional. `male` / `female`.
purchase.currency	Mandatory. ISO 4217 code. Must be `EUR` (Europe) or `GBP` (UK) for Open Banking, and enabled on your account by your Account Manager.
purchase.products.name	Mandatory. Name of each product in the order.
purchase.products.price	Mandatory. Price in decimal with 2 places: EUR 5 -> `5.00`; GBP 10.37 -> `10.37`.
purchase.total	Optional. Order total. If omitted, Paysecure sums the product prices.
paymentMethod	Mandatory. Must be `OPEN-BANKING`. This performs a direct Open Banking payment instead of loading the full method-selection page.
brand_id	Mandatory. Your Brand ID, from the Dashboard section of your merchant account login.
merchantRef	Optional (recommended). Your unique transaction reference - see Essential Optional Parameters below.
success_redirect	Mandatory. URL to send the customer to if the transaction is successful.
pending_redirect	Mandatory. URL to send the customer to if the transaction is pending.
failure_redirect	Mandatory. URL to send the customer to if the transaction is unsuccessful.
success_callback	Optional. Server-to-server (webhook) URL called on success.
failure_callback	Optional. Server-to-server (webhook) URL called on failure.

Essential Optional Parameters

merchantRef - although not mandatory, it is strongly advised. It gives you two advantages:

Prevention of duplicate requests: merchantRef acts as a unique identifier. If a second purchase is sent with the same merchantRef, the system recognises it and prevents a duplicate transaction.
\n
Transaction retrieval: if the response to the initial purchase times out or the purchaseId is not received, you can still retrieve the transaction using your merchantRef.
\n

If you do not send a merchantRef, Paysecure assigns the internal purchaseId as the reference for that transaction.

Response

A successful create returns HTTP 202 ACCEPTED and the full purchase envelope, including purchaseId, status (e.g. PAYMENT_IN_PROCESS), status_history, and the checkout_url you redirect the customer to. refund_availability is NONE until the purchase reaches paid.

Errors

Errors are returned in the form {\"message\": \"...\", \"code\": \"...\"}. Common messages include: Brand not found !, some Mandatory Parameter are missing, Invalid Email Format, Please submit Valid Alpha2 Country Code Ex:(AF,IN) in \"country\" parameter, Please pass Valid State Code, Only {{currencyCode}} currency is allowed., You are not Allowed for Live Transaction, and Transaction amount must be equal or greater to minimum trans amount.

\n","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"ccc71b4f-7236-4bae-bcb1-e0a5ef81d946","id":"ccc71b4f-7236-4bae-bcb1-e0a5ef81d946","name":"APIs","type":"folder"}},"urlObject":{"path":["purchases"],"host":["https://api.paysecure.net/api/v1"],"query":[],"variable":[]}},"response":[{"id":"719dfe0d-a571-44dd-8f83-ebf9d3a98b77","name":"Purchases - Success","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer {{APIKey}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"client\": {\n \"email\": \"user5540@example.com\",\n \"country\": \"GB\",\n \"city\": \"Milford\",\n \"stateCode\": \"LND\",\n \"street_address\": \"1 Example Street\",\n \"zip_code\": \"59016\",\n \"full_name\": \"Riley Costa\",\n \"date_of_birth\": \"1994-04-21\",\n \"phone\": \"+447755564318\",\n \"gender\": \"male\"\n },\n \"purchase\": {\n \"currency\": \"GBP\",\n \"products\": [\n {\n \"name\": \"e-commerce\",\n \"price\": \"10.00\"\n },\n {\n \"name\": \"retail\",\n \"price\": \"11.00\"\n }\n ],\n \"total\": 21\n },\n \"paymentMethod\": \"OPEN-BANKING\",\n \"brand_id\": \"your-brand-id\",\n \"merchantRef\": \"\",\n \"success_redirect\": \"https://your.success.redirect.com\",\n \"pending_redirect\": \"https://your.pending.redirect.com\",\n \"failure_redirect\": \"https://your.failure.redirect.com\",\n \"success_callback\": \"https://your.success.callback.com\",\n \"failure_callback\": \"https://your.failure.callback.com\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.paysecure.net/api/v1/purchases"},"status":"Accepted","code":202,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"purchaseId\": \"68c3a4a031ee334ef2c02b2a\",\n \"client\": {\n \"customerId\": \"NA\",\n \"email\": \"user5540@example.com\",\n \"date_of_birth\": \"1994-04-21\",\n \"street_address\": \"1 Example Street\",\n \"country\": \"GB\",\n \"city\": \"Milford\",\n \"zip_code\": \"59016\",\n \"full_name\": \"Riley Costa\",\n \"phone\": \"+447755564318\",\n \"gender\": \"male\",\n \"stateCode\": \"LND\"\n },\n \"updated_on\": 1757652134,\n \"type\": \"purchase\",\n \"paymentMethod\": \"OPEN-BANKING\",\n \"amountUnit\": \"MAJOR\",\n \"errorMsg\": \"\",\n \"errorCode\": \"NA\",\n \"redirectType\": \"POST\",\n \"force_recurring\": false,\n \"created_on\": 1757652128,\n \"merchantRef\": \"68c3a4a031ee334ef2c02b2a\",\n \"merchantName\": \"merchantName\",\n \"purchase\": {\n \"currency\": \"GBP\",\n \"products\": [\n {\n \"name\": \"e-commerce\",\n \"quantity\": 1,\n \"price\": 10,\n \"discount\": 0,\n \"tax_percent\": \"0.00\"\n },\n {\n \"name\": \"retail\",\n \"quantity\": 1,\n \"price\": 11,\n \"discount\": 0,\n \"tax_percent\": \"0.00\"\n }\n ],\n \"total\": 21,\n \"language\": \"en\",\n \"notes\": \"\",\n \"debt\": 0,\n \"total_formatted\": 21,\n \"taxAmount\": 0,\n \"taxPercent\": 0,\n \"request_client_details\": [],\n \"email_message\": \"\"\n },\n \"payment\": {\n \"is_outgoing\": false,\n \"payment_type\": \"PURCHASE\",\n \"amount\": 21,\n \"currency\": \"GBP\",\n \"net_amount\": 21,\n \"fee_amount\": 0,\n \"pending_amount\": 0,\n \"pending_unfreeze_on\": null,\n \"description\": \"\",\n \"paid_on\": 1757652129,\n \"remote_paid_on\": 1757652129\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\": \"OPEN-BANKING\",\n \"flow\": \"payform\",\n \"extra\": {\n \"amount\": 21,\n \"masked_pan\": \"OPEN-BANKING\"\n },\n \"country\": \"GB\",\n \"attempts\": [\n {\n \"client_ip\": \"203.0.113.3\",\n \"type\": \"execute\",\n \"payment_method\": \"OPEN-BANKING\",\n \"flow\": \"payform\",\n \"successful\": true,\n \"country\": \"GB\",\n \"processing_time\": 1757652129,\n \"extra\": {\n \"amount\": 21,\n \"masked_pan\": \"OPEN-BANKING\"\n }\n }\n ]\n },\n \"status\": \"PAYMENT_IN_PROCESS\",\n \"status_history\": [\n {\n \"status\": \"created\",\n \"timestamp\": 1757652128\n },\n {\n \"status\": \"pending_execute\",\n \"timestamp\": 1757652129\n },\n {\n \"status\": \"payment_in_process\",\n \"timestamp\": 1757652134\n }\n ],\n \"is_test\": false,\n \"brand_id\": \"your-brand-id\",\n \"send_receipt\": false,\n \"is_recurring_token\": false,\n \"skip_capture\": false,\n \"reference_generated\": \"PS93\",\n \"issued\": \"2025-09-12\",\n \"due\": 1757652128,\n \"refund_upto\": 0,\n \"cc_descriptor\": \"\",\n \"fraudScore\": \"0\",\n \"trustScore\": \"0\",\n \"paidOn\": 0,\n \"taxAmount\": 0,\n \"surcharge\": 0,\n \"surchargeType\": \"\",\n \"sessionId\": \"\",\n \"refund_availability\": \"NONE\",\n \"refundable_amount\": 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 \"platform\": \"API\",\n \"created_from_ip\": \"203.0.113.3\",\n \"checkout_url\": \"https://gateway.paysecure.net/payments/63cddfa1a4948aba8e8ee9f319e3428f/\",\n \"payoutProcess\": false\n}"},{"id":"07964b54-671d-4379-b32e-2b58bf78414d","name":"Purchases - Error (Brand not found)","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer {{APIKey}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"client\": {\n \"email\": \"user5540@example.com\",\n \"country\": \"GB\",\n \"city\": \"Milford\",\n \"stateCode\": \"LND\",\n \"street_address\": \"1 Example Street\",\n \"zip_code\": \"59016\",\n \"full_name\": \"Riley Costa\",\n \"date_of_birth\": \"1994-04-21\",\n \"phone\": \"+447755564318\",\n \"gender\": \"male\"\n },\n \"purchase\": {\n \"currency\": \"GBP\",\n \"products\": [\n {\n \"name\": \"e-commerce\",\n \"price\": \"10.00\"\n },\n {\n \"name\": \"retail\",\n \"price\": \"11.00\"\n }\n ],\n \"total\": 21\n },\n \"paymentMethod\": \"OPEN-BANKING\",\n \"brand_id\": \"your-brand-id\",\n \"merchantRef\": \"\",\n \"success_redirect\": \"https://your.success.redirect.com\",\n \"pending_redirect\": \"https://your.pending.redirect.com\",\n \"failure_redirect\": \"https://your.failure.redirect.com\",\n \"success_callback\": \"https://your.success.callback.com\",\n \"failure_callback\": \"https://your.failure.callback.com\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.paysecure.net/api/v1/purchases"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Brand not found !\",\n \"code\": \"transaction_error\"\n}"}],"_postman_id":"571d967c-f427-4aad-8897-3f85d9c5e71a"},{"name":"Refund","id":"63d8070a-1ec0-4ef6-a3f6-244760e057ac","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{APIKey}}","type":"text"}],"url":"https://api.paysecure.net/api/v1/purchases/{purchaseId}/refund","description":"

This call initiates a refund of a purchase. Only purchases with status paid can be refunded.

Once a refund is initiated, the purchase status becomes refund_in_process; once the bank approves the refund, it becomes refunded.

Mandatory: pass the purchaseId in the URL: GET https://api.paysecure.net/api/v1/purchases/{purchaseId}/refund.

Partial refunds are not supported for Open Banking - a refund always returns the full amount.

Response

Returns the full purchase envelope with the updated status (refund_in_process, then refunded once confirmed). Watch the refund_in_process and refunded webhooks for the final outcome.

\n","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"ccc71b4f-7236-4bae-bcb1-e0a5ef81d946","id":"ccc71b4f-7236-4bae-bcb1-e0a5ef81d946","name":"APIs","type":"folder"}},"urlObject":{"path":["purchases","{purchaseId}","refund"],"host":["https://api.paysecure.net/api/v1"],"query":[],"variable":[]}},"response":[{"id":"5ccab2a9-affc-4454-87c9-478a8ab1a633","name":"Refund - Success","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer {{APIKey}}","type":"text"}],"url":"https://api.paysecure.net/api/v1/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\": \"user6085@example.com\",\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\": \"203.0.113.133\",\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\": \"203.0.113.133\",\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\": \"your-brand-id\",\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://your.success.redirect.com\",\n \"failure_redirect\": \"https://your.failure.redirect.com\",\n \"cancel_redirect\": \"\",\n \"success_callback\": \"https://your.success.callback.com\",\n \"platform\": \"API\",\n \"created_from_ip\": \"203.0.113.133\",\n \"checkout_url\": \"https://api.paysecure.net/payments/64bfdb7df63e36669499e82f/\",\n \"direct_post_url\": \"https://api.paysecure.net/api/v1/p/64bfdb7df63e36669499e82f/\"\n}"},{"id":"42ba7217-2c37-49d8-9c9a-4e12353b3550","name":"Refund - Success (Refund in process)","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{APIKey}}","type":"text"}],"url":"https://api.paysecure.net/api/v1/purchases/{purchaseId}/refund"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"purchaseId\": \"68c3a4a031ee334ef2c02b2a\",\n \"client\": {\n \"customerId\": \"NA\",\n \"email\": \"user5540@example.com\",\n \"date_of_birth\": \"1994-04-21\",\n \"street_address\": \"1 Example Street\",\n \"country\": \"GB\",\n \"city\": \"Milford\",\n \"zip_code\": \"59016\",\n \"full_name\": \"Riley Costa\",\n \"phone\": \"+447755564318\",\n \"gender\": \"male\",\n \"stateCode\": \"LND\"\n },\n \"updated_on\": 1757652134,\n \"type\": \"purchase\",\n \"paymentMethod\": \"OPEN-BANKING\",\n \"amountUnit\": \"MAJOR\",\n \"errorMsg\": \"\",\n \"errorCode\": \"NA\",\n \"redirectType\": \"POST\",\n \"force_recurring\": false,\n \"created_on\": 1757652128,\n \"merchantRef\": \"68c3a4a031ee334ef2c02b2a\",\n \"merchantName\": \"merchantName\",\n \"purchase\": {\n \"currency\": \"GBP\",\n \"products\": [\n {\n \"name\": \"e-commerce\",\n \"quantity\": 1,\n \"price\": 10,\n \"discount\": 0,\n \"tax_percent\": \"0.00\"\n },\n {\n \"name\": \"retail\",\n \"quantity\": 1,\n \"price\": 11,\n \"discount\": 0,\n \"tax_percent\": \"0.00\"\n }\n ],\n \"total\": 21,\n \"language\": \"en\",\n \"notes\": \"\",\n \"debt\": 0,\n \"total_formatted\": 21,\n \"taxAmount\": 0,\n \"taxPercent\": 0,\n \"request_client_details\": [],\n \"email_message\": \"\"\n },\n \"payment\": {\n \"is_outgoing\": false,\n \"payment_type\": \"PURCHASE\",\n \"amount\": 21,\n \"currency\": \"GBP\",\n \"net_amount\": 21,\n \"fee_amount\": 0,\n \"pending_amount\": 0,\n \"pending_unfreeze_on\": null,\n \"description\": \"\",\n \"paid_on\": 1757652129,\n \"remote_paid_on\": 1757652129\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\": \"OPEN-BANKING\",\n \"flow\": \"payform\",\n \"extra\": {\n \"amount\": 21,\n \"masked_pan\": \"OPEN-BANKING\"\n },\n \"country\": \"GB\",\n \"attempts\": [\n {\n \"client_ip\": \"203.0.113.3\",\n \"type\": \"execute\",\n \"payment_method\": \"OPEN-BANKING\",\n \"flow\": \"payform\",\n \"successful\": true,\n \"country\": \"GB\",\n \"processing_time\": 1757652129,\n \"extra\": {\n \"amount\": 21,\n \"masked_pan\": \"OPEN-BANKING\"\n }\n }\n ]\n },\n \"status\": \"REFUND_IN_PROCESS\",\n \"status_history\": [\n {\n \"status\": \"created\",\n \"timestamp\": 1757652128\n },\n {\n \"status\": \"pending_execute\",\n \"timestamp\": 1757652129\n },\n {\n \"status\": \"payment_in_process\",\n \"timestamp\": 1757652134\n },\n {\n \"status\": \"paid\",\n \"timestamp\": 1757652140\n },\n {\n \"status\": \"refund_in_process\",\n \"timestamp\": 1757655000\n }\n ],\n \"is_test\": false,\n \"brand_id\": \"your-brand-id\",\n \"send_receipt\": false,\n \"is_recurring_token\": false,\n \"skip_capture\": false,\n \"reference_generated\": \"PS93\",\n \"issued\": \"2025-09-12\",\n \"due\": 1757652128,\n \"refund_upto\": 0,\n \"cc_descriptor\": \"\",\n \"fraudScore\": \"0\",\n \"trustScore\": \"0\",\n \"paidOn\": 1757652140,\n \"taxAmount\": 0,\n \"surcharge\": 0,\n \"surchargeType\": \"\",\n \"sessionId\": \"\",\n \"refund_availability\": \"NONE\",\n \"refundable_amount\": 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 \"platform\": \"API\",\n \"created_from_ip\": \"203.0.113.3\",\n \"checkout_url\": \"https://gateway.paysecure.net/payments/63cddfa1a4948aba8e8ee9f319e3428f/\",\n \"payoutProcess\": false\n}"},{"id":"cac26828-c0cb-4777-b449-dee6321f65d4","name":"Refund - Error (Not refundable)","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{APIKey}}","type":"text"}],"url":"https://api.paysecure.net/api/v1/purchases/{purchaseId}/refund"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Refund is allowed only for paid purchases\",\n \"code\": \"transaction_error\"\n}"}],"_postman_id":"63d8070a-1ec0-4ef6-a3f6-244760e057ac"},{"name":"Get Status","id":"0a98fa82-eeb8-425e-b5d7-7b082e7db7ae","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{APIKey}}","type":"text"}],"url":"https://api.paysecure.net/api/v1/purchases/{purchaseId}","description":"

This call returns all the details of a purchase, including its full status history. Use it to confirm the outcome of an Open Banking payment (alongside the webhook).

Mandatory: pass the purchaseId in the URL: GET https://api.paysecure.net/api/v1/purchases/{purchaseId}/.

Possible values 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	Meaning
`created`	Purchase order has been created.
`payment_in_process`	Payment is under processing.
`paid`	Transaction successful.
`refund_in_process`	A refund is under processing.
`refunded`	Payment has been refunded.
`chargeback`	Payment is in a chargeback state.
`expired`	Purchase has expired.
`overdue`	Purchase is overdue.
`cancelled`	Purchase was cancelled.
`error`	Transaction has failed.

Error details

If there are issues with the purchase, you can get more detail from the transaction_data.attempts.error attribute of the response object.

The Open Banking PayIn endpoints follow Paysecure's standard /purchases contract. Create a purchase with paymentMethod = OPEN-BANKING, redirect the customer to the returned checkout_url, then confirm the result with the webhook or the Get Status call.

Open Banking lets your customers pay directly from their bank account through a secure, bank-hosted authentication flow, instead of using a card or a wallet. It is the preferred way to pay in many European markets and the UK, where real-time bank transfers are trusted and widely used.

Paysecure connects to local Open Banking / bank-transfer networks so you get one integration for many countries, with compliance (PSD2 in Europe), security, and real-time confirmation handled for you.

Key benefits

Localised payment options — region-specific bank rails your customers already trust.
\n
Secure transactions — payments are authorised inside the customer's own bank; credentials are never shared with you or Paysecure.
\n
Real-time verification — payment confirmation arrives via webhook, improving cash flow and reducing risk.
\n
Compliance — adheres to PSD2 (Europe) and local regulatory standards.
\n

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

Property	Details
Payment type	Real-time bank transfer (Open Banking / PSD2)
Countries	Europe (24) + UK (1) — 25 in total (see Concepts -> Coverage & Limits)
Processing currency	`EUR` (Europe), `GBP` (UK)
`paymentMethod` enum	`OPEN-BANKING`
PayIn	Yes
PayOut	No
Refunds	Yes - full only (no partial refunds)
Recurring / MIT	No
Chargebacks	Rare - bank-to-bank push payment; a `chargeback` status exists on the platform but card-style disputes do not apply
Customer flow	Redirect to Paysecure Gateway -> pick bank -> log in & authorise at the bank
Payment confirmation	Real-time (webhook + status polling)
Transaction limits	Set per merchant profile - contact your Account Manager
Settlement	Set per merchant profile - contact your Account Manager

","auth":{"type":"noauth","isInherited":false},"event":[{"listen":"prerequest","script":{"type":"text/javascript","packages":{},"exec":[""],"id":"f6d58b0a-04e4-47e5-9159-2dff5e55c61f"}},{"listen":"test","script":{"type":"text/javascript","packages":{},"exec":[""],"id":"65d58fd4-c627-47df-acde-e935be2027e5"}}],"_postman_id":"cf02344f-abdf-468a-825b-0b804bc7464b"},{"name":"🌎 Google Pay (Seamless)","item":[{"name":"Concepts","item":[],"id":"e24a175b-0c2c-4495-aa29-d9cbf4b9a29d","description":"

Get started

Paysecure’s Server-to-Server (S2S) integration for Google Pay allows merchants to process Google Pay transactions securely from their backend systems. In this model, merchants are responsible for generating the Google Pay payment token on their client application and sending it to their server, which then communicates with Paysecure APIs.

This integration uses DIRECT tokenization, where payment data is securely generated by Google Pay and passed to Paysecure for processing.

This integration is recommended for merchants who require:

Integration with Google Pay wallets
\n
Secure handling of tokenized payment data
\n
Flexibility in choosing PCI scope (encrypted vs decrypted flow)
\n

How it works

The Google Pay S2S payment flow follows a two-step process:

1. Generate Google Pay Token (Client-side)

The merchant integrates Google Pay SDK (Web/Android) to generate a payment token using DIRECT flow.

2. Submit Token via S2S

The merchant server sends the Google Pay token (encrypted or decrypted) to Paysecure via the /purchase API.

Supported Tokenization Type

Paysecure supports DIRECT flow only.

PAYMENT_GATEWAY flow is not supported yet.

Google Pay Processing Overview

Google Pay transactions are processed as card-not-present payments using tokenized card data (PAN/DPAN) along with a cryptogram provided by Google Pay.

These transactions go through:

Card network (Visa, Mastercard, etc.)
\n
Issuing bank authorization
\n
Risk and fraud checks
\n

Integration Options

Paysecure supports two integration modes:

1. Encrypted Token Flow (Recommended)

In this flow, the merchant sends the encrypted Google Pay token to Paysecure. Paysecure decrypts and processes the payment.

Key Characteristics

Merchant does not handle PAN
\n
Reduced PCI scope
\n
Recommended for most merchants
\n

PCI Impact

Merchants can significantly reduce PCI DSS scope since sensitive card data is handled by Paysecure.

2. Decrypted Token Flow

In this flow, the merchant decrypts the Google Pay token and sends decrypted token details to Paysecure.

Key Characteristics

PAN is available at merchant side
\n
Faster processing
\n
Full control over payment data
\n

PCI Impact

Merchants must be PCI DSS compliant (SAQ D) as they handle raw card data.

Before you begin

Ensure the following prerequisites are met:

You have received your API credentials from Paysecure.
\n
You have a valid Google Merchant ID
\n
You have integrated Google Pay SDK to generate tokens
\n
You have configured DIRECT tokenization in Google Pay
\n
Your server can make secure HTTPS requests
\n
You have a valid brand_id provided by Paysecure
\n

Additional Requirements (Encrypted Flow)

Generate EC key pair (P-256 / secp256r1)
\n
Register public key in Google Pay Console
\n
Share private key securely with Paysecure
\n

Additional Requirements (Decrypted Flow)

Implement token decryption using Google Tink library
\n
Ensure full PCI DSS compliance
\n

To process a Google Pay transaction, a Purchase must first be created using the /purchases API. The Google Pay token must be included in the request under extraParam.googlepay_param.

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.

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

Parameter	Notes
client.full_name	Conditional. But Recommended to pass the complete name of the client. Atleast 2 words recommended.
client.email	Conditional. But Recommended to pass a correct email id.
paymentMethod	Conditional. Mandatory if you are not using Paysecure Cashier. Else Non Mandatory. Value: GOOGLEPAY
purchase.currency	Mandatory. ISO 4217 code for currency you want to send the transaction in. This should be 'BRL' for PIX.
purchase.products.name	Mandatory.
purchase.products.price	Mandatory. Price in decimal format upto 2 decimals. 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	Mandatory. Obtain from Dashboard section of your merchant account login.
success_redirect	Mandatory. URL to send the user if the transactions is successful.
pending_redirect	Mandatory. URL to send the user if the transactions is in progress state.
failure_redirect	Mandatory URL to send the user if the transactions has failed.

Optional Parameters

expireInMin

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.

paymentMethod

Flow Diagram:

","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"3ee541d8-3ca8-46db-adc8-e620df3c4aa0","id":"3ee541d8-3ca8-46db-adc8-e620df3c4aa0","name":"APIs","type":"folder"}},"urlObject":{"path":["purchases",""],"host":["https://api.paysecure.net/api/v1"],"query":[],"variable":[]}},"response":[{"id":"296484e4-dbbe-4f72-b63c-c4227971ea63","name":"Purchase - success","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer {{APIKey}}"}],"body":{"mode":"raw","raw":"{\r\n \"client\": {\r\n \"customerId\": \"NA\",\r\n \"email\": \"user9831@example.com\",\r\n \"full_name\": \"Casey Novak\",\r\n \"date_of_birth\": \"1800-01-01\",\r\n \"street_address\": \"58 Testing Lane\",\r\n \"country\": \"BR\",\r\n \"city\": \"Westbury\",\r\n \"zip_code\": \"110001\",\r\n \"cc\": [],\r\n \"bcc\": [],\r\n \"stateCode\": \"DL\"\r\n },\r\n \"purchase\": {\r\n \"currency\": \"EUR\",\r\n \"products\": [\r\n {\r\n \"name\": \"e-commerce\",\r\n \"price\": \"10\"\r\n }\r\n ]\r\n },\r\n \"paymentMethod\": \"GOOGLEPAY\",\r\n \"brand_id\": \"your-brand-id\",\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 \"googlepay_param\": {\r\n \"google_merchant_id\": \"merchant:1234567890\",\r\n \"googlepay_encrypted_payload\": \"{\\\"signature\\\":\\\"MEUCIQC...\\\",\\\"intermediateSigningKey\\\":{...},\\\"protocolVersion\\\":\\\"ECv2\\\",\\\"signedMessage\\\":\\\"{...}\\\"}\" \r\n }\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.paysecure.net/api/v1/purchases"},"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":"{\r\n \"purchaseId\": \"69cce01f5bae56fd5547a993\",\r\n \"client\": {\r\n \"customerId\": \"NA\",\r\n \"email\": \"user9831@example.com\",\r\n \"full_name\": \"Casey Novak\",\r\n \"date_of_birth\": \"1800-01-01\",\r\n \"street_address\": \"58 Testing Lane\",\r\n \"country\": \"BR\",\r\n \"city\": \"Westbury\",\r\n \"zip_code\": \"110001\",\r\n \"cc\": [],\r\n \"bcc\": [],\r\n \"stateCode\": \"DL\"\r\n },\r\n \"updated_on\": 1775034399,\r\n \"type\": \"purchase\",\r\n \"paymentMethod\": \"GOOGLEPAY\",\r\n \"amountUnit\": \"MAJOR\",\r\n \"errorMsg\": \"\",\r\n \"errorCode\": \"NA\",\r\n \"force_recurring\": false,\r\n \"created_on\": 1775034399,\r\n \"merchantRef\": \"69cce01f5bae56fd5547a993\",\r\n \"purchase\": {\r\n \"currency\": \"USD\",\r\n \"products\": [\r\n {\r\n \"name\": \"e-commerce\",\r\n \"quantity\": 1.0,\r\n \"price\": 10.0,\r\n \"discount\": 0,\r\n \"tax_percent\": \"0.00\"\r\n }\r\n ],\r\n \"total\": 10.0,\r\n \"requestAmount\": 10.0,\r\n \"language\": \"en\",\r\n \"notes\": \"\",\r\n \"debt\": 0,\r\n \"total_formatted\": 1.0,\r\n \"taxAmount\": 0.0,\r\n \"taxPercent\": 0.0,\r\n \"request_client_details\": [],\r\n \"email_message\": \"\"\r\n },\r\n \"issuer_details\": {\r\n \"website\": \"\",\r\n \"legal_street_address\": \"\",\r\n \"legal_country\": \"\",\r\n \"legal_city\": \"\",\r\n \"legal_zip_code\": \"\",\r\n \"bank_accounts\": [\r\n {}\r\n ],\r\n \"legal_name\": \"Omega Pixel\",\r\n \"brand_name\": \"Omega Pixel\",\r\n \"registration_number\": \"\",\r\n \"tax_number\": \"\"\r\n },\r\n \"transaction_data\": {\r\n \"payment_method\": \"\",\r\n \"flow\": \"payform\",\r\n \"extra\": {},\r\n \"country\": \"\",\r\n \"attempts\": []\r\n },\r\n \"status\": \"CREATED\",\r\n \"status_history\": [\r\n {\r\n \"status\": \"created\",\r\n \"timestamp\": 1775034399\r\n }\r\n ],\r\n \"is_test\": false,\r\n \"brand_id\": \"your-brand-id\",\r\n \"send_receipt\": false,\r\n \"is_recurring_token\": false,\r\n \"skip_capture\": false,\r\n \"reference_generated\": \"PS1032\",\r\n \"issued\": \"2026-04-01\",\r\n \"due\": 1775034399,\r\n \"refund_upto\": 0,\r\n \"cc_descriptor\": \"\",\r\n \"fraudScore\": \"NA\",\r\n \"trustScore\": \"NA\",\r\n \"extraFee\": \"0\",\r\n \"paidOn\": 0,\r\n \"receivedAmt\": 0.0,\r\n \"taxAmount\": 0.0,\r\n \"surcharge\": 0.0,\r\n \"surchargeType\": \"\",\r\n \"sessionId\": \"\",\r\n \"refund_availability\": \"NONE\",\r\n \"refundable_amount\": 0.0,\r\n \"success_redirect\": \"https://your.success.redirect.com\",\r\n \"failure_redirect\": \"https://your.failure.redirect.com\",\r\n \"pending_redirect\": \"https://your.pending.redirect.com\",\r\n \"cancel_redirect\": \"\",\r\n \"success_callback\": \"https://your.success.callback.com\",\r\n \"failure_callback\": \"https://your.failure.callback.com\",\r\n \"platform\": \"API\",\r\n \"created_from_ip\": \"203.0.113.232\",\r\n \"checkout_url\": \"https://api.paysecure.net/payments/6b5a5977ac8e022facb31f3346f61ed0/\",\r\n \"direct_post_url\": \"https://api.paysecure.net/api/v1/p/69cce01f5bae56fd5547a993/\",\r\n \"payoutProcess\": false\r\n}"},{"id":"21ee352b-e90a-40a7-aa4f-98704f67b280","name":"Purchase - failure","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer {{APIKey}}"}],"body":{"mode":"raw","raw":"{\r\n \"client\": {\r\n \"customerId\": \"NA\",\r\n \"email\": \"user9831@example.com\",\r\n \"full_name\": \"Casey Novak\",\r\n \"date_of_birth\": \"1800-01-01\",\r\n \"street_address\": \"58 Testing Lane\",\r\n \"country\": \"BR\",\r\n \"city\": \"Westbury\",\r\n \"zip_code\": \"110001\",\r\n \"cc\": [],\r\n \"bcc\": [],\r\n \"stateCode\": \"DL\"\r\n },\r\n \"purchase\": {\r\n \"currency\": \"EUR\",\r\n \"products\": [\r\n {\r\n \"name\": \"e-commerce\",\r\n \"price\": \"10\"\r\n }\r\n ]\r\n },\r\n \"paymentMethod\": \"GOOGLEPAY\",\r\n \"brand_id\": \"your-brand-id\",\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 \"googlepay_param\": {\r\n \"google_merchant_id\": \"merchant:1234567890\",\r\n \"googlepay_encrypted_payload\": \"{\\\"signature\\\":\\\"MEUCIQC...\\\",\\\"intermediateSigningKey\\\":{...},\\\"protocolVersion\\\":\\\"ECv2\\\",\\\"signedMessage\\\":\\\"{...}\\\"}\"\r\n }\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.paysecure.net/api/v1/purchases"},"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":"{\r\n \"message\": \"Error Message\",\r\n \"code\": \"error_code\"\r\n}"}],"_postman_id":"80462835-d8c7-496c-9ed6-04ee77fb55c7"},{"name":"Purchases (Decrypted Flow)","id":"8e3c36ee-8de2-46dd-a37f-8bf9188afa71","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer {{APIKey}}"}],"body":{"mode":"raw","raw":"{\r\n \"client\": {\r\n \"customerId\": \"NA\",\r\n \"email\": \"user9831@example.com\",\r\n \"full_name\": \"Casey Novak\",\r\n \"date_of_birth\": \"1800-01-01\",\r\n \"street_address\": \"58 Testing Lane\",\r\n \"country\": \"BR\",\r\n \"city\": \"Westbury\",\r\n \"zip_code\": \"110001\",\r\n \"cc\": [],\r\n \"bcc\": [],\r\n \"stateCode\": \"DL\"\r\n },\r\n \"purchase\": {\r\n \"currency\": \"EUR\",\r\n \"products\": [\r\n {\r\n \"name\": \"e-commerce\",\r\n \"price\": \"10\"\r\n }\r\n ]\r\n },\r\n \"paymentMethod\": \"GOOGLEPAY\",\r\n \"brand_id\": \"your-brand-id\",\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 \"googlepay_param\": {\r\n \"google_merchant_id\": \"merchant:1234567890\",\r\n \"googlepay_decrypted_payload\": {\r\n \"messageExpiration\": \"1735689600000\",\r\n \"messageId\": \"AH2EjtfkYz...\",\r\n \"paymentMethod\": \"CARD\",\r\n \"paymentMethodDetails\": {\r\n \"pan\": \"4111111111111111\",\r\n \"expirationMonth\": 12,\r\n \"expirationYear\": 2027,\r\n \"authMethod\": \"CRYPTOGRAM_3DS\",\r\n \"cryptogram\": \"AgAAAAAABk4D...\",\r\n \"eciIndicator\": \"05\"\r\n },\r\n \"gatewayMerchantId\": \"your_gateway_merchant_id\"\r\n }\r\n }\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.paysecure.net/api/v1/purchases/","description":"

To process a Google Pay transaction, a Purchase must first be created using the /purchases API. The Google Pay token must be included in the request under extraParam.googlepay_param.

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.

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

Parameter	Notes
client.full_name	Conditional. But Recommended to pass the complete name of the client. Atleast 2 words recommended.
client.email	Conditional. But Recommended to pass a correct email id.
paymentMethod	Conditional. Mandatory if you are not using Paysecure Cashier. Else Non Mandatory. Value: GOOGLEPAY
purchase.currency	Mandatory. ISO 4217 code for currency you want to send the transaction in. This should be 'BRL' for PIX.
purchase.products.name	Mandatory.
purchase.products.price	Mandatory. Price in decimal format upto 2 decimals. 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	Mandatory. Obtain from Dashboard section of your merchant account login.
success_redirect	Mandatory. URL to send the user if the transactions is successful.
pending_redirect	Mandatory. URL to send the user if the transactions is in progress state.
failure_redirect	Mandatory URL to send the user if the transactions has failed.

Optional Parameters

expireInMin

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.

paymentMethod

Flow Diagram:

","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"3ee541d8-3ca8-46db-adc8-e620df3c4aa0","id":"3ee541d8-3ca8-46db-adc8-e620df3c4aa0","name":"APIs","type":"folder"}},"urlObject":{"path":["purchases",""],"host":["https://api.paysecure.net/api/v1"],"query":[],"variable":[]}},"response":[{"id":"4c308dae-1b69-4ff4-bc1b-c39f915b26d6","name":"Purchase - success","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer {{APIKey}}"}],"body":{"mode":"raw","raw":"{\r\n \"client\": {\r\n \"customerId\": \"NA\",\r\n \"email\": \"user9831@example.com\",\r\n \"full_name\": \"Casey Novak\",\r\n \"date_of_birth\": \"1800-01-01\",\r\n \"street_address\": \"58 Testing Lane\",\r\n \"country\": \"BR\",\r\n \"city\": \"Westbury\",\r\n \"zip_code\": \"110001\",\r\n \"cc\": [],\r\n \"bcc\": [],\r\n \"stateCode\": \"DL\"\r\n },\r\n \"purchase\": {\r\n \"currency\": \"EUR\",\r\n \"products\": [\r\n {\r\n \"name\": \"e-commerce\",\r\n \"price\": \"10\"\r\n }\r\n ]\r\n },\r\n \"paymentMethod\": \"GOOGLEPAY\",\r\n \"brand_id\": \"your-brand-id\",\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 \"googlepay_param\": {\r\n \"google_merchant_id\": \"merchant:1234567890\",\r\n \"googlepay_decrypted_payload\": {\r\n \"messageExpiration\": \"1735689600000\",\r\n \"messageId\": \"AH2EjtfkYz...\",\r\n \"paymentMethod\": \"CARD\",\r\n \"paymentMethodDetails\": {\r\n \"pan\": \"4111111111111111\",\r\n \"expirationMonth\": 12,\r\n \"expirationYear\": 2027,\r\n \"authMethod\": \"CRYPTOGRAM_3DS\",\r\n \"cryptogram\": \"AgAAAAAABk4D...\",\r\n \"eciIndicator\": \"05\"\r\n },\r\n \"gatewayMerchantId\": \"your_gateway_merchant_id\"\r\n }\r\n }\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.paysecure.net/api/v1/purchases"},"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":"{\r\n \"purchaseId\": \"69cce01f5bae56fd5547a993\",\r\n \"client\": {\r\n \"customerId\": \"NA\",\r\n \"email\": \"user9831@example.com\",\r\n \"full_name\": \"Casey Novak\",\r\n \"date_of_birth\": \"1800-01-01\",\r\n \"street_address\": \"58 Testing Lane\",\r\n \"country\": \"BR\",\r\n \"city\": \"Westbury\",\r\n \"zip_code\": \"110001\",\r\n \"cc\": [],\r\n \"bcc\": [],\r\n \"stateCode\": \"DL\"\r\n },\r\n \"updated_on\": 1775034399,\r\n \"type\": \"purchase\",\r\n \"paymentMethod\": \"GOOGLEPAY\",\r\n \"amountUnit\": \"MAJOR\",\r\n \"errorMsg\": \"\",\r\n \"errorCode\": \"NA\",\r\n \"force_recurring\": false,\r\n \"created_on\": 1775034399,\r\n \"merchantRef\": \"69cce01f5bae56fd5547a993\",\r\n \"purchase\": {\r\n \"currency\": \"USD\",\r\n \"products\": [\r\n {\r\n \"name\": \"e-commerce\",\r\n \"quantity\": 1.0,\r\n \"price\": 10.0,\r\n \"discount\": 0,\r\n \"tax_percent\": \"0.00\"\r\n }\r\n ],\r\n \"total\": 10.0,\r\n \"requestAmount\": 10.0,\r\n \"language\": \"en\",\r\n \"notes\": \"\",\r\n \"debt\": 0,\r\n \"total_formatted\": 1.0,\r\n \"taxAmount\": 0.0,\r\n \"taxPercent\": 0.0,\r\n \"request_client_details\": [],\r\n \"email_message\": \"\"\r\n },\r\n \"issuer_details\": {\r\n \"website\": \"\",\r\n \"legal_street_address\": \"\",\r\n \"legal_country\": \"\",\r\n \"legal_city\": \"\",\r\n \"legal_zip_code\": \"\",\r\n \"bank_accounts\": [\r\n {}\r\n ],\r\n \"legal_name\": \"Omega Pixel\",\r\n \"brand_name\": \"Omega Pixel\",\r\n \"registration_number\": \"\",\r\n \"tax_number\": \"\"\r\n },\r\n \"transaction_data\": {\r\n \"payment_method\": \"\",\r\n \"flow\": \"payform\",\r\n \"extra\": {},\r\n \"country\": \"\",\r\n \"attempts\": []\r\n },\r\n \"status\": \"CREATED\",\r\n \"status_history\": [\r\n {\r\n \"status\": \"created\",\r\n \"timestamp\": 1775034399\r\n }\r\n ],\r\n \"is_test\": false,\r\n \"brand_id\": \"your-brand-id\",\r\n \"send_receipt\": false,\r\n \"is_recurring_token\": false,\r\n \"skip_capture\": false,\r\n \"reference_generated\": \"PS1032\",\r\n \"issued\": \"2026-04-01\",\r\n \"due\": 1775034399,\r\n \"refund_upto\": 0,\r\n \"cc_descriptor\": \"\",\r\n \"fraudScore\": \"NA\",\r\n \"trustScore\": \"NA\",\r\n \"extraFee\": \"0\",\r\n \"paidOn\": 0,\r\n \"receivedAmt\": 0.0,\r\n \"taxAmount\": 0.0,\r\n \"surcharge\": 0.0,\r\n \"surchargeType\": \"\",\r\n \"sessionId\": \"\",\r\n \"refund_availability\": \"NONE\",\r\n \"refundable_amount\": 0.0,\r\n \"success_redirect\": \"https://your.success.redirect.com\",\r\n \"failure_redirect\": \"https://your.failure.redirect.com\",\r\n \"pending_redirect\": \"https://your.pending.redirect.com\",\r\n \"cancel_redirect\": \"\",\r\n \"success_callback\": \"https://your.success.callback.com\",\r\n \"failure_callback\": \"https://your.failure.callback.com\",\r\n \"platform\": \"API\",\r\n \"created_from_ip\": \"203.0.113.232\",\r\n \"checkout_url\": \"https://api.paysecure.net/payments/6b5a5977ac8e022facb31f3346f61ed0/\",\r\n \"direct_post_url\": \"https://api.paysecure.net/api/v1/p/69cce01f5bae56fd5547a993/\",\r\n \"payoutProcess\": false\r\n}"},{"id":"152fceca-cd77-4add-8acd-c75fbc6dce53","name":"Purchase - failure","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer {{APIKey}}"}],"body":{"mode":"raw","raw":"{\r\n \"client\": {\r\n \"customerId\": \"NA\",\r\n \"email\": \"user9831@example.com\",\r\n \"full_name\": \"Casey Novak\",\r\n \"date_of_birth\": \"1800-01-01\",\r\n \"street_address\": \"58 Testing Lane\",\r\n \"country\": \"BR\",\r\n \"city\": \"Westbury\",\r\n \"zip_code\": \"110001\",\r\n \"cc\": [],\r\n \"bcc\": [],\r\n \"stateCode\": \"DL\"\r\n },\r\n \"purchase\": {\r\n \"currency\": \"EUR\",\r\n \"products\": [\r\n {\r\n \"name\": \"e-commerce\",\r\n \"price\": \"10\"\r\n }\r\n ]\r\n },\r\n \"paymentMethod\": \"GOOGLEPAY\",\r\n \"brand_id\": \"your-brand-id\",\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 \"googlepay_param\": {\r\n \"google_merchant_id\": \"merchant:1234567890\",\r\n \"googlepay_decrypted_payload\": {\r\n \"messageExpiration\": \"1735689600000\",\r\n \"messageId\": \"AH2EjtfkYz...\",\r\n \"paymentMethod\": \"CARD\",\r\n \"paymentMethodDetails\": {\r\n \"pan\": \"4111111111111111\",\r\n \"expirationMonth\": 12,\r\n \"expirationYear\": 2027,\r\n \"authMethod\": \"CRYPTOGRAM_3DS\",\r\n \"cryptogram\": \"AgAAAAAABk4D...\",\r\n \"eciIndicator\": \"05\"\r\n },\r\n \"gatewayMerchantId\": \"your_gateway_merchant_id\"\r\n }\r\n }\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.paysecure.net/api/v1/purchases"},"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":"{\r\n \"message\": \"Error Message\",\r\n \"code\": \"error_code\"\r\n}"}],"_postman_id":"8e3c36ee-8de2-46dd-a37f-8bf9188afa71"},{"name":"Get Status","id":"fc3f6831-89f1-4cbf-a34c-1707d3f620a0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer {{APIKey}}","type":"text"}],"url":"https://api.paysecure.net/api/v1/purchases/{purchaseId}/","description":"

This API tells you about all the details of a purchase (PayIn), 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

Status	Notes
paid	Transaction Successful
payment_in_process	Payment is under Processing
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":"3ee541d8-3ca8-46db-adc8-e620df3c4aa0","id":"3ee541d8-3ca8-46db-adc8-e620df3c4aa0","name":"APIs","type":"folder"}},"urlObject":{"path":["purchases","{purchaseId}",""],"host":["https://api.paysecure.net/api/v1"],"query":[],"variable":[]}},"response":[{"id":"24fa118c-ee2e-470c-93a4-2622f63083c1","name":"Purchase - success","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer {{APIKey}}"}],"url":"https://api.paysecure.net/api/v1/purchases/{purchaseId}/"},"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":"{\r\n \"purchaseId\": \"69cce01f5bae56fd5547a993\",\r\n \"client\": {\r\n \"customerId\": \"NA\",\r\n \"email\": \"user9831@example.com\",\r\n \"full_name\": \"Casey Novak\",\r\n \"date_of_birth\": \"1800-01-01\",\r\n \"street_address\": \"58 Testing Lane\",\r\n \"country\": \"BR\",\r\n \"city\": \"Westbury\",\r\n \"zip_code\": \"110001\",\r\n \"cc\": [],\r\n \"bcc\": [],\r\n \"stateCode\": \"DL\"\r\n },\r\n \"updated_on\": 1775034399,\r\n \"type\": \"purchase\",\r\n \"paymentMethod\": \"GOOGLEPAY\",\r\n \"amountUnit\": \"MAJOR\",\r\n \"errorMsg\": \"\",\r\n \"errorCode\": \"NA\",\r\n \"force_recurring\": false,\r\n \"created_on\": 1775034399,\r\n \"merchantRef\": \"69cce01f5bae56fd5547a993\",\r\n \"purchase\": {\r\n \"currency\": \"USD\",\r\n \"products\": [\r\n {\r\n \"name\": \"e-commerce\",\r\n \"quantity\": 1.0,\r\n \"price\": 10.0,\r\n \"discount\": 0,\r\n \"tax_percent\": \"0.00\"\r\n }\r\n ],\r\n \"total\": 10.0,\r\n \"requestAmount\": 10.0,\r\n \"language\": \"en\",\r\n \"notes\": \"\",\r\n \"debt\": 0,\r\n \"total_formatted\": 1.0,\r\n \"taxAmount\": 0.0,\r\n \"taxPercent\": 0.0,\r\n \"request_client_details\": [],\r\n \"email_message\": \"\"\r\n },\r\n \"issuer_details\": {\r\n \"website\": \"\",\r\n \"legal_street_address\": \"\",\r\n \"legal_country\": \"\",\r\n \"legal_city\": \"\",\r\n \"legal_zip_code\": \"\",\r\n \"bank_accounts\": [\r\n {}\r\n ],\r\n \"legal_name\": \"Omega Pixel\",\r\n \"brand_name\": \"Omega Pixel\",\r\n \"registration_number\": \"\",\r\n \"tax_number\": \"\"\r\n },\r\n \"transaction_data\": {\r\n \"payment_method\": \"\",\r\n \"flow\": \"payform\",\r\n \"extra\": {},\r\n \"country\": \"\",\r\n \"attempts\": []\r\n },\r\n \"status\": \"CREATED\",\r\n \"status_history\": [\r\n {\r\n \"status\": \"created\",\r\n \"timestamp\": 1775034399\r\n }\r\n ],\r\n \"is_test\": false,\r\n \"brand_id\": \"your-brand-id\",\r\n \"send_receipt\": false,\r\n \"is_recurring_token\": false,\r\n \"skip_capture\": false,\r\n \"reference_generated\": \"PS1032\",\r\n \"issued\": \"2026-04-01\",\r\n \"due\": 1775034399,\r\n \"refund_upto\": 0,\r\n \"cc_descriptor\": \"\",\r\n \"fraudScore\": \"NA\",\r\n \"trustScore\": \"NA\",\r\n \"extraFee\": \"0\",\r\n \"paidOn\": 0,\r\n \"receivedAmt\": 0.0,\r\n \"taxAmount\": 0.0,\r\n \"surcharge\": 0.0,\r\n \"surchargeType\": \"\",\r\n \"sessionId\": \"\",\r\n \"refund_availability\": \"NONE\",\r\n \"refundable_amount\": 0.0,\r\n \"success_redirect\": \"https://your.success.redirect.com\",\r\n \"failure_redirect\": \"https://your.failure.redirect.com\",\r\n \"pending_redirect\": \"https://your.pending.redirect.com\",\r\n \"cancel_redirect\": \"\",\r\n \"success_callback\": \"https://your.success.callback.com\",\r\n \"failure_callback\": \"https://your.failure.callback.com\",\r\n \"platform\": \"API\",\r\n \"created_from_ip\": \"203.0.113.232\",\r\n \"checkout_url\": \"https://api.paysecure.net/payments/6b5a5977ac8e022facb31f3346f61ed0/\",\r\n \"direct_post_url\": \"https://api.paysecure.net/api/v1/p/69cce01f5bae56fd5547a993/\",\r\n \"payoutProcess\": false\r\n}"},{"id":"5266cfcf-5674-41f3-a9a6-9e5ed33d0b6c","name":"Purchase - failure","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer {{APIKey}}","type":"text"}],"url":"https://api.paysecure.net/api/v1/purchases/{purchaseId}/"},"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":"{\r\n \"message\": \"Error Message\",\r\n \"code\": \"error_code\"\r\n}"}],"_postman_id":"fc3f6831-89f1-4cbf-a34c-1707d3f620a0"}],"id":"3ee541d8-3ca8-46db-adc8-e620df3c4aa0","auth":{"type":"noauth","isInherited":false},"event":[{"listen":"prerequest","script":{"type":"text/javascript","packages":{},"requests":{},"exec":[""],"id":"14d4d065-5c47-47d7-bcc1-014f72c86148"}},{"listen":"test","script":{"type":"text/javascript","packages":{},"requests":{},"exec":[""],"id":"1bc42005-d530-4255-9523-76d404ec82bd"}}],"_postman_id":"3ee541d8-3ca8-46db-adc8-e620df3c4aa0","description":""}],"id":"242ef7f1-3658-4603-b3e9-df34ac0641c3","auth":{"type":"noauth","isInherited":false},"event":[{"listen":"prerequest","script":{"type":"text/javascript","packages":{},"requests":{},"exec":[""],"id":"32b1ba58-ae91-4a9d-b1a5-1dba7b18d180"}},{"listen":"test","script":{"type":"text/javascript","packages":{},"requests":{},"exec":[""],"id":"d7ed1461-9d52-4db3-abc8-33dc48f717ea"}}],"_postman_id":"242ef7f1-3658-4603-b3e9-df34ac0641c3","description":""},{"name":"🌎 Apple Pay (Seamless)","item":[{"name":"Concepts","item":[],"id":"72f5d2e6-f37c-4ee6-a7e1-b5edf900c732","description":"

Get started

Paysecure’s Server-to-Server (S2S) integration for Apple Pay allows merchants to process Apple Pay transactions securely from their backend systems. In this model, merchants are responsible for generating the Apple Pay payment token on their client application and sending it to their server, which then communicates with Paysecure APIs.

This integration uses DIRECT tokenization, where payment data is securely generated by Apple Pay and passed to Paysecure for processing.

This integration is recommended for merchants who require:

Integration with Apple Pay wallets
\n
Secure handling of tokenized payment data
\n
Flexibility in choosing PCI scope (encrypted vs decrypted flow)
\n

How it works

The Apple Pay S2S payment flow follows a two-step process:

1. Generate Apple Pay Token (Client-side)

The merchant integrates Apple Pay SDK (Web/Android) to generate a payment token using DIRECT flow.

2. Submit Token via S2S

The merchant server sends the Apple Pay token (encrypted or decrypted) to Paysecure via the /purchase API.

Apple Pay Processing Overview

Apple Pay transactions are processed as card-not-present payments using:

Tokenized card data (DPAN)
\n
Cryptogram generated by Apple
\n
Device-based authentication (Face ID / Touch ID / Passcode)
\n

These transactions go through:

Card network (Visa, Mastercard, Amex, etc.)
\n
Issuing bank authorization
\n
Risk and fraud checks
\n

Integration Options

Paysecure supports two integration modes:

1. Encrypted Token Flow (Recommended)

In this flow, the merchant sends the encrypted Apple Pay token to Paysecure. Paysecure decrypts and processes the payment.

Key Characteristics

Merchant does not handle PAN
\n
Reduced PCI scope
\n
Recommended for most merchants
\n

PCI Impact

Merchants can significantly reduce PCI DSS scope since sensitive card data is handled by Paysecure.

2. Decrypted Token Flow

In this flow, the merchant decrypts the Apple Pay token and sends card details to Paysecure.

Key Characteristics

PAN/DPAN available at merchant side
\n
Full control over payment data
\n

PCI Impact

Merchants must be PCI DSS compliant (SAQ D) as they handle raw card data.

Before you begin

Ensure the following prerequisites are met:

You have received your API credentials from Paysecure
\n
You have an Apple Merchant ID
\n
You have configured Apple Pay on your domain/app
\n
Your server can make secure HTTPS requests
\n
You have a valid brand_id provided by Paysecure
\n

Additional Requirements (Encrypted Flow)

Configure Apple Pay certificates (Payment Processing Certificate)
\n
Share certificate details securely with Paysecure (if required)
\n

Additional Requirements (Decrypted Flow)

Implement Apple Pay token decryption
\n
Use Apple’s Payment Processing certificate and private key
\n
Ensure full PCI DSS compliance
\n

To process an Apple Pay transaction, a Purchase must be created using the /purchases API. The Apple Pay token must be included under extraParam.applepay_param.

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.

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

Parameter	Notes
client.full_name	Conditional. But Recommended to pass the complete name of the client. Atleast 2 words recommended.
client.email	Conditional. But Recommended to pass a correct email id.
paymentMethod	Conditional. Mandatory if you are not using Paysecure Cashier. Else Non Mandatory. Value: APPLEPAY
purchase.currency	Mandatory. ISO 4217 code for currency you want to send the transaction in. This should be 'BRL' for PIX.
purchase.products.name	Mandatory.
purchase.products.price	Mandatory. Price in decimal format upto 2 decimals. 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	Mandatory. Obtain from Dashboard section of your merchant account login.
success_redirect	Mandatory. URL to send the user if the transactions is successful.
pending_redirect	Mandatory. URL to send the user if the transactions is in progress state.
failure_redirect	Mandatory URL to send the user if the transactions has failed.

Optional Parameters

expireInMin

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.

paymentMethod

\n","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"33631ab6-2b6e-440f-891d-7f371cc272c6","id":"33631ab6-2b6e-440f-891d-7f371cc272c6","name":"APIs","type":"folder"}},"urlObject":{"path":["purchases",""],"host":["https://api.paysecure.net/api/v1"],"query":[],"variable":[]}},"response":[{"id":"749d5f62-6c02-443c-bc38-bf48122e964d","name":"Purchase - success","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer {{APIKey}}"}],"body":{"mode":"raw","raw":"{\r\n \"client\": {\r\n \"email\": \"user6597@example.com\"\r\n },\r\n \"purchase\": {\r\n \"currency\": \"USD\",\r\n \"products\": [\r\n {\r\n \"name\": \"Product\",\r\n \"price\": \"10.00\"\r\n }\r\n ]\r\n },\r\n \"paymentMethod\": \"APPLEPAY\",\r\n \"brand_id\": \"your-brand-id\",\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 \"extraParam\": {\r\n \"applepay_param\": {\r\n \"applepay_token\": {\r\n \"version\": \"EC_v1\",\r\n \"data\": \"...\",\r\n \"signature\": \"...\",\r\n \"header\": {\r\n \"ephemeralPublicKey\": \"...\",\r\n \"publicKeyHash\": \"...\",\r\n \"transactionId\": \"...\"\r\n }\r\n }\r\n }\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.paysecure.net/api/v1/purchases"},"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":"{\r\n \"purchaseId\": \"69cce01f5bae56fd5547a993\",\r\n \"client\": {\r\n \"customerId\": \"NA\",\r\n \"email\": \"user9831@example.com\",\r\n \"full_name\": \"Casey Novak\",\r\n \"date_of_birth\": \"1800-01-01\",\r\n \"street_address\": \"58 Testing Lane\",\r\n \"country\": \"BR\",\r\n \"city\": \"Westbury\",\r\n \"zip_code\": \"110001\",\r\n \"cc\": [],\r\n \"bcc\": [],\r\n \"stateCode\": \"DL\"\r\n },\r\n \"updated_on\": 1775034399,\r\n \"type\": \"purchase\",\r\n \"paymentMethod\": \"APPLEPAY\",\r\n \"amountUnit\": \"MAJOR\",\r\n \"errorMsg\": \"\",\r\n \"errorCode\": \"NA\",\r\n \"force_recurring\": false,\r\n \"created_on\": 1775034399,\r\n \"merchantRef\": \"69cce01f5bae56fd5547a993\",\r\n \"purchase\": {\r\n \"currency\": \"USD\",\r\n \"products\": [\r\n {\r\n \"name\": \"e-commerce\",\r\n \"quantity\": 1.0,\r\n \"price\": 10.0,\r\n \"discount\": 0,\r\n \"tax_percent\": \"0.00\"\r\n }\r\n ],\r\n \"total\": 10.0,\r\n \"requestAmount\": 10.0,\r\n \"language\": \"en\",\r\n \"notes\": \"\",\r\n \"debt\": 0,\r\n \"total_formatted\": 1.0,\r\n \"taxAmount\": 0.0,\r\n \"taxPercent\": 0.0,\r\n \"request_client_details\": [],\r\n \"email_message\": \"\"\r\n },\r\n \"issuer_details\": {\r\n \"website\": \"\",\r\n \"legal_street_address\": \"\",\r\n \"legal_country\": \"\",\r\n \"legal_city\": \"\",\r\n \"legal_zip_code\": \"\",\r\n \"bank_accounts\": [\r\n {}\r\n ],\r\n \"legal_name\": \"Omega Pixel\",\r\n \"brand_name\": \"Omega Pixel\",\r\n \"registration_number\": \"\",\r\n \"tax_number\": \"\"\r\n },\r\n \"transaction_data\": {\r\n \"payment_method\": \"\",\r\n \"flow\": \"payform\",\r\n \"extra\": {},\r\n \"country\": \"\",\r\n \"attempts\": []\r\n },\r\n \"status\": \"CREATED\",\r\n \"status_history\": [\r\n {\r\n \"status\": \"created\",\r\n \"timestamp\": 1775034399\r\n }\r\n ],\r\n \"is_test\": false,\r\n \"brand_id\": \"your-brand-id\",\r\n \"send_receipt\": false,\r\n \"is_recurring_token\": false,\r\n \"skip_capture\": false,\r\n \"reference_generated\": \"PS1032\",\r\n \"issued\": \"2026-04-01\",\r\n \"due\": 1775034399,\r\n \"refund_upto\": 0,\r\n \"cc_descriptor\": \"\",\r\n \"fraudScore\": \"NA\",\r\n \"trustScore\": \"NA\",\r\n \"extraFee\": \"0\",\r\n \"paidOn\": 0,\r\n \"receivedAmt\": 0.0,\r\n \"taxAmount\": 0.0,\r\n \"surcharge\": 0.0,\r\n \"surchargeType\": \"\",\r\n \"sessionId\": \"\",\r\n \"refund_availability\": \"NONE\",\r\n \"refundable_amount\": 0.0,\r\n \"success_redirect\": \"https://your.success.redirect.com\",\r\n \"failure_redirect\": \"https://your.failure.redirect.com\",\r\n \"pending_redirect\": \"https://your.pending.redirect.com\",\r\n \"cancel_redirect\": \"\",\r\n \"success_callback\": \"https://your.success.callback.com\",\r\n \"failure_callback\": \"https://your.failure.callback.com\",\r\n \"platform\": \"API\",\r\n \"created_from_ip\": \"203.0.113.232\",\r\n \"checkout_url\": \"https://api.paysecure.net/payments/6b5a5977ac8e022facb31f3346f61ed0/\",\r\n \"direct_post_url\": \"https://api.paysecure.net/api/v1/p/69cce01f5bae56fd5547a993/\",\r\n \"payoutProcess\": false\r\n}"},{"id":"ee2f92f9-1c88-4e49-b401-fe2518b0d6e1","name":"Purchase - failure","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer {{APIKey}}"}],"body":{"mode":"raw","raw":"{\r\n \"client\": {\r\n \"email\": \"user6597@example.com\"\r\n },\r\n \"purchase\": {\r\n \"currency\": \"USD\",\r\n \"products\": [\r\n {\r\n \"name\": \"Product\",\r\n \"price\": \"10.00\"\r\n }\r\n ]\r\n },\r\n \"paymentMethod\": \"APPLEPAY\",\r\n \"brand_id\": \"your-brand-id\",\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 \"extraParam\": {\r\n \"applepay_param\": {\r\n \"applepay_token\": {\r\n \"version\": \"EC_v1\",\r\n \"data\": \"...\",\r\n \"signature\": \"...\",\r\n \"header\": {\r\n \"ephemeralPublicKey\": \"...\",\r\n \"publicKeyHash\": \"...\",\r\n \"transactionId\": \"...\"\r\n }\r\n }\r\n }\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.paysecure.net/api/v1/purchases"},"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":"{\r\n \"message\": \"Error Message\",\r\n \"code\": \"error_code\"\r\n}"}],"_postman_id":"3dedf7ff-9a22-406f-942e-0c378a4cee32"},{"name":"Purchases (Decrypted Flow)","id":"54b2022c-8003-4c1e-87cc-9ff4ad29b659","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer {{APIKey}}"}],"body":{"mode":"raw","raw":"{\r\n \"client\": {\r\n \"email\": \"user6597@example.com\"\r\n },\r\n \"purchase\": {\r\n \"currency\": \"USD\",\r\n \"products\": [\r\n {\r\n \"name\": \"Product\",\r\n \"price\": \"10.00\"\r\n }\r\n ]\r\n },\r\n \"paymentMethod\": \"APPLEPAY\",\r\n \"brand_id\": \"your-brand-id\",\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 \"extraParam\": {\r\n \"applepay_param\": {\r\n \"applepay_decrypted_payload\": {\r\n \"applicationPrimaryAccountNumber\": \"4111111111111111\",\r\n \"applicationExpirationDate\": \"2712\",\r\n \"currencyCode\": \"840\",\r\n \"transactionAmount\": 1000,\r\n \"deviceManufacturerIdentifier\": \"040010030273\",\r\n \"paymentDataType\": \"3DSecure\",\r\n \"paymentData\": {\r\n \"onlinePaymentCryptogram\": \"AgAAAAAABk4D...\",\r\n \"eciIndicator\": \"05\"\r\n }\r\n }\r\n }\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.paysecure.net/api/v1/purchases/","description":"

To process an Apple Pay transaction, a Purchase must be created using the /purchases API. The Apple Pay token must be included under extraParam.applepay_param.

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.

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

Parameter	Notes
client.full_name	Conditional. But Recommended to pass the complete name of the client. Atleast 2 words recommended.
client.email	Conditional. But Recommended to pass a correct email id.
paymentMethod	Conditional. Mandatory if you are not using Paysecure Cashier. Else Non Mandatory. Value: APPLEPAY
purchase.currency	Mandatory. ISO 4217 code for currency you want to send the transaction in. This should be 'BRL' for PIX.
purchase.products.name	Mandatory.
purchase.products.price	Mandatory. Price in decimal format upto 2 decimals. 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	Mandatory. Obtain from Dashboard section of your merchant account login.
success_redirect	Mandatory. URL to send the user if the transactions is successful.
pending_redirect	Mandatory. URL to send the user if the transactions is in progress state.
failure_redirect	Mandatory URL to send the user if the transactions has failed.

Optional Parameters

expireInMin

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.

paymentMethod

\n","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"33631ab6-2b6e-440f-891d-7f371cc272c6","id":"33631ab6-2b6e-440f-891d-7f371cc272c6","name":"APIs","type":"folder"}},"urlObject":{"path":["purchases",""],"host":["https://api.paysecure.net/api/v1"],"query":[],"variable":[]}},"response":[{"id":"dd30c94b-7491-47e6-b6f1-1e3467cd54d1","name":"Purchase - success","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer {{APIKey}}"}],"body":{"mode":"raw","raw":"{\r\n \"client\": {\r\n \"email\": \"user6597@example.com\"\r\n },\r\n \"purchase\": {\r\n \"currency\": \"USD\",\r\n \"products\": [\r\n {\r\n \"name\": \"Product\",\r\n \"price\": \"10.00\"\r\n }\r\n ]\r\n },\r\n \"paymentMethod\": \"APPLEPAY\",\r\n \"brand_id\": \"your-brand-id\",\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 \"extraParam\": {\r\n \"applepay_param\": {\r\n \"applepay_decrypted_payload\": {\r\n \"applicationPrimaryAccountNumber\": \"4111111111111111\",\r\n \"applicationExpirationDate\": \"2712\",\r\n \"currencyCode\": \"840\",\r\n \"transactionAmount\": 1000,\r\n \"deviceManufacturerIdentifier\": \"040010030273\",\r\n \"paymentDataType\": \"3DSecure\",\r\n \"paymentData\": {\r\n \"onlinePaymentCryptogram\": \"AgAAAAAABk4D...\",\r\n \"eciIndicator\": \"05\"\r\n }\r\n }\r\n }\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.paysecure.net/api/v1/purchases"},"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":"{\r\n \"purchaseId\": \"69cce01f5bae56fd5547a993\",\r\n \"client\": {\r\n \"customerId\": \"NA\",\r\n \"email\": \"user9831@example.com\",\r\n \"full_name\": \"Casey Novak\",\r\n \"date_of_birth\": \"1800-01-01\",\r\n \"street_address\": \"58 Testing Lane\",\r\n \"country\": \"BR\",\r\n \"city\": \"Westbury\",\r\n \"zip_code\": \"110001\",\r\n \"cc\": [],\r\n \"bcc\": [],\r\n \"stateCode\": \"DL\"\r\n },\r\n \"updated_on\": 1775034399,\r\n \"type\": \"purchase\",\r\n \"paymentMethod\": \"APPLEPAY\",\r\n \"amountUnit\": \"MAJOR\",\r\n \"errorMsg\": \"\",\r\n \"errorCode\": \"NA\",\r\n \"force_recurring\": false,\r\n \"created_on\": 1775034399,\r\n \"merchantRef\": \"69cce01f5bae56fd5547a993\",\r\n \"purchase\": {\r\n \"currency\": \"USD\",\r\n \"products\": [\r\n {\r\n \"name\": \"e-commerce\",\r\n \"quantity\": 1.0,\r\n \"price\": 10.0,\r\n \"discount\": 0,\r\n \"tax_percent\": \"0.00\"\r\n }\r\n ],\r\n \"total\": 10.0,\r\n \"requestAmount\": 10.0,\r\n \"language\": \"en\",\r\n \"notes\": \"\",\r\n \"debt\": 0,\r\n \"total_formatted\": 1.0,\r\n \"taxAmount\": 0.0,\r\n \"taxPercent\": 0.0,\r\n \"request_client_details\": [],\r\n \"email_message\": \"\"\r\n },\r\n \"issuer_details\": {\r\n \"website\": \"\",\r\n \"legal_street_address\": \"\",\r\n \"legal_country\": \"\",\r\n \"legal_city\": \"\",\r\n \"legal_zip_code\": \"\",\r\n \"bank_accounts\": [\r\n {}\r\n ],\r\n \"legal_name\": \"Omega Pixel\",\r\n \"brand_name\": \"Omega Pixel\",\r\n \"registration_number\": \"\",\r\n \"tax_number\": \"\"\r\n },\r\n \"transaction_data\": {\r\n \"payment_method\": \"\",\r\n \"flow\": \"payform\",\r\n \"extra\": {},\r\n \"country\": \"\",\r\n \"attempts\": []\r\n },\r\n \"status\": \"CREATED\",\r\n \"status_history\": [\r\n {\r\n \"status\": \"created\",\r\n \"timestamp\": 1775034399\r\n }\r\n ],\r\n \"is_test\": false,\r\n \"brand_id\": \"your-brand-id\",\r\n \"send_receipt\": false,\r\n \"is_recurring_token\": false,\r\n \"skip_capture\": false,\r\n \"reference_generated\": \"PS1032\",\r\n \"issued\": \"2026-04-01\",\r\n \"due\": 1775034399,\r\n \"refund_upto\": 0,\r\n \"cc_descriptor\": \"\",\r\n \"fraudScore\": \"NA\",\r\n \"trustScore\": \"NA\",\r\n \"extraFee\": \"0\",\r\n \"paidOn\": 0,\r\n \"receivedAmt\": 0.0,\r\n \"taxAmount\": 0.0,\r\n \"surcharge\": 0.0,\r\n \"surchargeType\": \"\",\r\n \"sessionId\": \"\",\r\n \"refund_availability\": \"NONE\",\r\n \"refundable_amount\": 0.0,\r\n \"success_redirect\": \"https://your.success.redirect.com\",\r\n \"failure_redirect\": \"https://your.failure.redirect.com\",\r\n \"pending_redirect\": \"https://your.pending.redirect.com\",\r\n \"cancel_redirect\": \"\",\r\n \"success_callback\": \"https://your.success.callback.com\",\r\n \"failure_callback\": \"https://your.failure.callback.com\",\r\n \"platform\": \"API\",\r\n \"created_from_ip\": \"203.0.113.232\",\r\n \"checkout_url\": \"https://api.paysecure.net/payments/6b5a5977ac8e022facb31f3346f61ed0/\",\r\n \"direct_post_url\": \"https://api.paysecure.net/api/v1/p/69cce01f5bae56fd5547a993/\",\r\n \"payoutProcess\": false\r\n}"},{"id":"7e18c112-98ed-432f-871d-00d6a2c551b4","name":"Purchase - failure","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer {{APIKey}}"}],"body":{"mode":"raw","raw":"{\r\n \"client\": {\r\n \"email\": \"user6597@example.com\"\r\n },\r\n \"purchase\": {\r\n \"currency\": \"USD\",\r\n \"products\": [\r\n {\r\n \"name\": \"Product\",\r\n \"price\": \"10.00\"\r\n }\r\n ]\r\n },\r\n \"paymentMethod\": \"APPLEPAY\",\r\n \"brand_id\": \"your-brand-id\",\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 \"extraParam\": {\r\n \"applepay_param\": {\r\n \"applepay_decrypted_payload\": {\r\n \"applicationPrimaryAccountNumber\": \"4111111111111111\",\r\n \"applicationExpirationDate\": \"2712\",\r\n \"currencyCode\": \"840\",\r\n \"transactionAmount\": 1000,\r\n \"deviceManufacturerIdentifier\": \"040010030273\",\r\n \"paymentDataType\": \"3DSecure\",\r\n \"paymentData\": {\r\n \"onlinePaymentCryptogram\": \"AgAAAAAABk4D...\",\r\n \"eciIndicator\": \"05\"\r\n }\r\n }\r\n }\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.paysecure.net/api/v1/purchases"},"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":"{\r\n \"message\": \"Error Message\",\r\n \"code\": \"error_code\"\r\n}"}],"_postman_id":"54b2022c-8003-4c1e-87cc-9ff4ad29b659"},{"name":"Get Status","id":"36eb4863-5aed-4cf5-ae4f-755eed28fc58","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer {{APIKey}}","type":"text"}],"url":"https://api.paysecure.net/api/v1/purchases/{purchaseId}/","description":"

This API tells you about all the details of a purchase (PayIn), 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

Status	Notes
paid	Transaction Successful
payment_in_process	Payment is under Processing
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":"33631ab6-2b6e-440f-891d-7f371cc272c6","id":"33631ab6-2b6e-440f-891d-7f371cc272c6","name":"APIs","type":"folder"}},"urlObject":{"path":["purchases","{purchaseId}",""],"host":["https://api.paysecure.net/api/v1"],"query":[],"variable":[]}},"response":[{"id":"0ba70843-82be-442f-a33e-693c941b4039","name":"Purchase - success","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer {{APIKey}}"}],"url":"https://api.paysecure.net/api/v1/purchases/{purchaseId}/"},"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":"{\r\n \"purchaseId\": \"69cce01f5bae56fd5547a993\",\r\n \"client\": {\r\n \"customerId\": \"NA\",\r\n \"email\": \"user9831@example.com\",\r\n \"full_name\": \"Casey Novak\",\r\n \"date_of_birth\": \"1800-01-01\",\r\n \"street_address\": \"58 Testing Lane\",\r\n \"country\": \"BR\",\r\n \"city\": \"Westbury\",\r\n \"zip_code\": \"110001\",\r\n \"cc\": [],\r\n \"bcc\": [],\r\n \"stateCode\": \"DL\"\r\n },\r\n \"updated_on\": 1775034399,\r\n \"type\": \"purchase\",\r\n \"paymentMethod\": \"GOOGLEPAY\",\r\n \"amountUnit\": \"MAJOR\",\r\n \"errorMsg\": \"\",\r\n \"errorCode\": \"NA\",\r\n \"force_recurring\": false,\r\n \"created_on\": 1775034399,\r\n \"merchantRef\": \"69cce01f5bae56fd5547a993\",\r\n \"purchase\": {\r\n \"currency\": \"USD\",\r\n \"products\": [\r\n {\r\n \"name\": \"e-commerce\",\r\n \"quantity\": 1.0,\r\n \"price\": 10.0,\r\n \"discount\": 0,\r\n \"tax_percent\": \"0.00\"\r\n }\r\n ],\r\n \"total\": 10.0,\r\n \"requestAmount\": 10.0,\r\n \"language\": \"en\",\r\n \"notes\": \"\",\r\n \"debt\": 0,\r\n \"total_formatted\": 1.0,\r\n \"taxAmount\": 0.0,\r\n \"taxPercent\": 0.0,\r\n \"request_client_details\": [],\r\n \"email_message\": \"\"\r\n },\r\n \"issuer_details\": {\r\n \"website\": \"\",\r\n \"legal_street_address\": \"\",\r\n \"legal_country\": \"\",\r\n \"legal_city\": \"\",\r\n \"legal_zip_code\": \"\",\r\n \"bank_accounts\": [\r\n {}\r\n ],\r\n \"legal_name\": \"Omega Pixel\",\r\n \"brand_name\": \"Omega Pixel\",\r\n \"registration_number\": \"\",\r\n \"tax_number\": \"\"\r\n },\r\n \"transaction_data\": {\r\n \"payment_method\": \"\",\r\n \"flow\": \"payform\",\r\n \"extra\": {},\r\n \"country\": \"\",\r\n \"attempts\": []\r\n },\r\n \"status\": \"CREATED\",\r\n \"status_history\": [\r\n {\r\n \"status\": \"created\",\r\n \"timestamp\": 1775034399\r\n }\r\n ],\r\n \"is_test\": false,\r\n \"brand_id\": \"your-brand-id\",\r\n \"send_receipt\": false,\r\n \"is_recurring_token\": false,\r\n \"skip_capture\": false,\r\n \"reference_generated\": \"PS1032\",\r\n \"issued\": \"2026-04-01\",\r\n \"due\": 1775034399,\r\n \"refund_upto\": 0,\r\n \"cc_descriptor\": \"\",\r\n \"fraudScore\": \"NA\",\r\n \"trustScore\": \"NA\",\r\n \"extraFee\": \"0\",\r\n \"paidOn\": 0,\r\n \"receivedAmt\": 0.0,\r\n \"taxAmount\": 0.0,\r\n \"surcharge\": 0.0,\r\n \"surchargeType\": \"\",\r\n \"sessionId\": \"\",\r\n \"refund_availability\": \"NONE\",\r\n \"refundable_amount\": 0.0,\r\n \"success_redirect\": \"https://your.success.redirect.com\",\r\n \"failure_redirect\": \"https://your.failure.redirect.com\",\r\n \"pending_redirect\": \"https://your.pending.redirect.com\",\r\n \"cancel_redirect\": \"\",\r\n \"success_callback\": \"https://your.success.callback.com\",\r\n \"failure_callback\": \"https://your.failure.callback.com\",\r\n \"platform\": \"API\",\r\n \"created_from_ip\": \"203.0.113.232\",\r\n \"checkout_url\": \"https://api.paysecure.net/payments/6b5a5977ac8e022facb31f3346f61ed0/\",\r\n \"direct_post_url\": \"https://api.paysecure.net/api/v1/p/69cce01f5bae56fd5547a993/\",\r\n \"payoutProcess\": false\r\n}"},{"id":"88b597a1-f760-44b7-ab90-12a1ae7daeca","name":"Purchase - failure","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer {{APIKey}}","type":"text"}],"url":"https://api.paysecure.net/api/v1/purchases/{purchaseId}/"},"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":"{\r\n \"message\": \"Error Message\",\r\n \"code\": \"error_code\"\r\n}"}],"_postman_id":"36eb4863-5aed-4cf5-ae4f-755eed28fc58"}],"id":"33631ab6-2b6e-440f-891d-7f371cc272c6","auth":{"type":"noauth","isInherited":false},"event":[{"listen":"prerequest","script":{"type":"text/javascript","packages":{},"requests":{},"exec":[""],"id":"4796d7b4-9656-4b0e-bfc6-b8f7428abf49"}},{"listen":"test","script":{"type":"text/javascript","packages":{},"requests":{},"exec":[""],"id":"290b3337-cf22-4b39-a464-5be73f1ad572"}}],"_postman_id":"33631ab6-2b6e-440f-891d-7f371cc272c6","description":""}],"id":"496249c8-1136-4636-9937-506390f1df34","auth":{"type":"noauth","isInherited":false},"event":[{"listen":"prerequest","script":{"type":"text/javascript","packages":{},"requests":{},"exec":[""],"id":"cdc13b8e-9519-4edf-8b41-a4ad5374354d"}},{"listen":"test","script":{"type":"text/javascript","packages":{},"requests":{},"exec":[""],"id":"82526045-b1d6-4267-a4c0-e7ed6cc6577d"}}],"_postman_id":"496249c8-1136-4636-9937-506390f1df34","description":""},{"name":"🌐 Crypto Payments","item":[{"name":"Concepts","item":[],"id":"09530667-ea3f-4e87-ae1b-c84b6b11ef68","description":"

Overview

Pay with Crypto allows merchants to accept cryptocurrency payments while creating the purchase request in a fiat currency. The merchant initiates the payment using the Purchase API with the PAY-WITH-CRYPTO payment method. The customer is presented with the payment details required to complete the transaction using the selected cryptocurrency.

Customers select their preferred cryptocurrency token and supported network. The checkout page then generates a unique wallet address and QR code. The customer completes the payment by either scanning the QR code or sending the exact crypto amount to the provided address.

Once the blockchain transaction is confirmed, Paysecure updates the payment status and sends a webhook notification to the merchant.

\n\n

This is an asynchronous payment method. Do not treat the Purchase API response as a payment result — the final status arrives later via webhook (or by polling the Get Status API) once the blockchain confirms the transfer. Because the customer sends funds manually from their own wallet, the amount received can differ from the amount requested — see Underpayment & Overpayment below.

Coverage & Limits

\n\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	Value
Minimum transaction amount	10.00 EUR
Maximum transaction amount	As configured for the merchant account
Request currency	Fiat (e.g. `EUR`) — converted to the selected crypto at checkout
Amount validity	The exact crypto amount is quoted with an expiry shown on the checkout page — the customer must pay within it

Note: transactions below 10.00 EUR are not accepted and will be declined:

{\n  \"code\": \"107\",\n  \"message\": \"Amount is less than the minimum we can process, action can not be completed. Minimum amount should be: 10.00 EUR\",\n  \"status\": \"DECLINED\",\n  \"traceId\": \"517488249054850e\"\n}\n\n

Prerequisites

Valid Paysecure API credentials (API key and Brand ID from the Dashboard section of your merchant account login).
\n
Use PAY-WITH-CRYPTO as the payment method.
\n
Configure Success, Pending and Failure redirect URLs.
\n
Configure webhook callback URLs to receive payment status updates — mandatory in practice for this method, since the final status is delivered asynchronously.
\n
The customer must have a crypto wallet containing sufficient funds.
\n

PayIn Flow

How it works

The merchant creates a purchase using the Purchase API with paymentMethod set to PAY-WITH-CRYPTO.
\n
The Purchase API returns a checkout_url.
\n
The merchant redirects the customer to the returned checkout_url.
\n
On the checkout page, the customer selects the preferred cryptocurrency token and supported network.
\n
The checkout displays the payment details required to complete the transaction: wallet address, QR code, exact crypto amount, and selected network.
\n
The customer completes the payment by scanning the QR code with a supported cryptocurrency wallet, or sending the displayed crypto amount to the provided wallet address.
\n
Once the blockchain transaction is confirmed, Paysecure updates the payment status and sends a webhook notification to the merchant's configured callback URL.
\n

Integration notes

Always redirect the customer using the checkout_url returned by the Purchase API.
\n
Do not consider the payment successful immediately after receiving the Purchase API response — use the webhook to determine the final status.
\n
Store the purchaseId from the Purchase API response; it identifies the transaction in all subsequent operations.
\n
Pass merchantRef to prevent duplicate purchases and to retrieve the transaction if the response times out.
\n

Checkout Experience

Step 1 – Select Token & Network

The customer is redirected to the hosted checkout page where they select a token and a network. The checkout automatically converts the purchase amount into the selected cryptocurrency.

\n\n

Step 2 – Complete Crypto Payment

After token selection, the checkout page displays the exact crypto amount, address, QR code, selected token and selected network.

Important: the customer must send the exact crypto amount using the selected network. Sending a different amount changes the final status (see below); sending a different token or network may result in payment failure or permanent loss of funds.

\n\n

Underpayment & Overpayment

Because the customer transfers funds manually, the received amount can differ from the requested amount. Paysecure reports these cases with two dedicated terminal statuses, visible in the merchant dashboard, the webhook, and the Get Status API:

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

Status	Meaning	Terminal?
`over_paid`	The customer paid more than the requested amount	✅
`partial_paid`	The customer paid less than the requested amount	✅

In the webhook and Get Status response, the top-level status is uppercase (OVER_PAID / PARTIAL_PAID) while status_history entries are lowercase (over_paid / partial_paid). The outer webhook status field is lowercase.

Handling guidance

Treat paid as the only status that confirms the exact requested amount was received.
\n
On partial_paid, do not fulfil the full order automatically — reconcile the received amount in the merchant dashboard first.
\n
On over_paid, the order amount is covered; reconcile the excess in the dashboard and agree the resolution path (e.g. refund of the excess) with your Account Manager.
\n

Webhook

When the transaction reaches a terminal state, Paysecure sends a server-to-server POST to your configured callback URL with the full purchase object. Events for this method:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\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	Status	When it fires	Terminal?
purchase created	`created`	Purchase registered, awaiting customer	❌
pending execute	`pending_execute`	Customer redirected to the checkout page	❌
payment in process	`payment_in_process`	Crypto payment submitted, awaiting blockchain confirmation	❌
purchase paid	`paid`	Exact requested amount received and confirmed	✅
purchase over paid	`over_paid`	More than the requested amount received	✅
purchase partial paid	`partial_paid`	Less than the requested amount received	✅
purchase expired	`expired`	The payment request expired before completion	✅
purchase error	`error`	Payment failed or was not completed	✅

Verify the webhook signature using your Public Key as described in the 🔌 Webhooks section.

Webhook sample — over paid

{\n  \"message\": {\n    \"purchaseId\": \"6a50f3430c177fa609c7aa9a\",\n    \"client\": {\n      \"customerId\": \"NA\",\n      \"email\": \"user5772@example.com\",\n      \"phone\": \"+44 07000000000\",\n      \"full_name\": \"test test\",\n      \"date_of_birth\": \"1994-07-10\",\n      \"street_address\": \"1 Example Street\",\n      \"country\": \"GB\",\n      \"city\": \"Milford\",\n      \"zip_code\": \"234567\",\n      \"cc\": [],\n      \"bcc\": [],\n      \"stateCode\": \"LO\"\n    },\n    \"updated_on\": 1783690281,\n    \"type\": \"purchase\",\n    \"paymentMethod\": \"OPEN-BANKING,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,MAYA,GCASH,INTERAC-EXPRESS,QRPH,APPLEPAY-REDIRECT,GOOGLEPAY-REDIRECT,KLARNA,QBPAY,RUPAY,UPI,UZCARD,PAY_WITH_INSTAXCHANGE,UPI-INTENT,PayByBank,GOOGLEPAY,APPLEPAY,PAYPLAY,UUWALLET,SKRILL,PAYPAL-ONRAMP,PAYPAL,INTERAC-ETRANSFER,INTERAC,PAY-WITH-CRYPTO,ACH,QR\",\n    \"amountUnit\": \"MAJOR\",\n    \"errorMsg\": \"Transaction succeeded-APPROVED\",\n    \"errorCode\": \"NA\",\n    \"force_recurring\": false,\n    \"created_on\": 1783690051,\n    \"merchantRef\": \"6a50f3430c177fa609c7aa9a\",\n    \"purchase\": {\n      \"currency\": \"EUR\",\n      \"products\": [\n        {\n          \"name\": \"e-commerce\",\n          \"quantity\": 1,\n          \"price\": 11.5,\n          \"discount\": 0,\n          \"tax_percent\": \"0.00\"\n        }\n      ],\n      \"total\": 11.5,\n      \"requestAmount\": 11.5,\n      \"language\": \"en\",\n      \"notes\": \"\",\n      \"debt\": 0,\n      \"total_formatted\": 1,\n      \"taxAmount\": 0,\n      \"taxPercent\": 0,\n      \"request_client_details\": [],\n      \"email_message\": \"\"\n    },\n    \"payment\": {\n      \"is_outgoing\": false,\n      \"payment_type\": \"PURCHASE\",\n      \"amount\": 11.5,\n      \"currency\": \"EUR\",\n      \"net_amount\": 11.5,\n      \"fee_amount\": 0,\n      \"pending_amount\": 0,\n      \"pending_unfreeze_on\": null,\n      \"description\": \"\",\n      \"paid_on\": 1783690060,\n      \"remote_paid_on\": 1783690060\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        \"amount\": 11.5,\n        \"masked_pan\": \"PAY-WITH-CRYPTO\"\n      },\n      \"country\": \"\",\n      \"attempts\": [\n        {\n          \"client_ip\": \"203.0.113.81\",\n          \"type\": \"execute\",\n          \"payment_method\": \"PAY-WITH-CRYPTO\",\n          \"flow\": \"payform\",\n          \"successful\": true,\n          \"country\": \"PAY-WITH-CRYPTO\",\n          \"processing_time\": 1783690060,\n          \"extra\": {\n            \"amount\": 11.5,\n            \"masked_pan\": \"PAY-WITH-CRYPTO\"\n          }\n        }\n      ]\n    },\n    \"status\": \"OVER_PAID\",\n    \"status_history\": [\n      {\n        \"status\": \"created\",\n        \"timestamp\": 1783690051\n      },\n      {\n        \"status\": \"pending_execute\",\n        \"timestamp\": 1783690060\n      },\n      {\n        \"status\": \"payment_in_process\",\n        \"timestamp\": 1783690063\n      },\n      {\n        \"status\": \"over_paid\",\n        \"timestamp\": 1783690281\n      },\n      {\n        \"status\": \"viewed\",\n        \"timestamp\": 1783690280\n      }\n    ],\n    \"viewedOn\": 1783690280,\n    \"is_test\": false,\n    \"brand_id\": \"your-brand-id\",\n    \"send_receipt\": false,\n    \"is_recurring_token\": false,\n    \"skip_capture\": false,\n    \"reference_generated\": \"PS1903\",\n    \"issued\": \"2026-07-10\",\n    \"due\": 1783690051,\n    \"refund_upto\": 1794054463,\n    \"cc_descriptor\": \"\",\n    \"fraudScore\": \"0\",\n    \"trustScore\": \"1\",\n    \"extraFee\": \"0\",\n    \"totalRefunded\": 0,\n    \"pix_payload\": {},\n    \"payInDetails\": {},\n    \"paidOn\": 0,\n    \"receivedAmt\": 0,\n    \"taxAmount\": 0,\n    \"surcharge\": 0,\n    \"surchargeType\": \"\",\n    \"sessionId\": \"\",\n    \"refund_availability\": \"NONE\",\n    \"refundable_amount\": 11.5,\n    \"success_redirect\": \"https://your.success.redirect.com\",\n    \"failure_redirect\": \"https://your.failure.redirect.com\",\n    \"pending_redirect\": \"https://your.pending.redirect.com\",\n    \"cancel_redirect\": \"\",\n    \"success_callback\": \"https://your.success.callback.com\",\n    \"failure_callback\": \"https://your.failure.callback.com\",\n    \"platform\": \"API\",\n    \"created_from_ip\": \"203.0.113.81\",\n    \"checkout_url\": \"https://api.paysecure.net/payments/6a50f3430c177fa609c7aa9a/\",\n    \"direct_post_url\": \"https://api.paysecure.net/api/v1/p/6a50f3430c177fa609c7aa9a/\",\n    \"payoutProcess\": false\n  },\n  \"status\": \"over_paid\"\n}\n\n

Webhook sample — partial paid

{\n  \"message\": {\n    \"purchaseId\": \"6a50f24533779459985eb258\",\n    \"client\": {\n      \"customerId\": \"NA\",\n      \"email\": \"user5772@example.com\",\n      \"phone\": \"+44 07000000000\",\n      \"full_name\": \"test test\",\n      \"date_of_birth\": \"1994-07-10\",\n      \"street_address\": \"1 Example Street\",\n      \"country\": \"GB\",\n      \"city\": \"Milford\",\n      \"zip_code\": \"234567\",\n      \"cc\": [],\n      \"bcc\": [],\n      \"stateCode\": \"LO\"\n    },\n    \"updated_on\": 1783690015,\n    \"type\": \"purchase\",\n    \"paymentMethod\": \"OPEN-BANKING,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,MAYA,GCASH,INTERAC-EXPRESS,QRPH,APPLEPAY-REDIRECT,GOOGLEPAY-REDIRECT,KLARNA,QBPAY,RUPAY,UPI,UZCARD,PAY_WITH_INSTAXCHANGE,UPI-INTENT,PayByBank,GOOGLEPAY,APPLEPAY,PAYPLAY,UUWALLET,SKRILL,PAYPAL-ONRAMP,PAYPAL,INTERAC-ETRANSFER,INTERAC,PAY-WITH-CRYPTO,ACH,QR\",\n    \"amountUnit\": \"MAJOR\",\n    \"errorMsg\": \"Transaction succeeded-APPROVED\",\n    \"errorCode\": \"NA\",\n    \"force_recurring\": false,\n    \"created_on\": 1783690051,\n    \"merchantRef\": \"6a50f24533779459985eb258\",\n    \"purchase\": {\n      \"currency\": \"EUR\",\n      \"products\": [\n        {\n          \"name\": \"e-commerce\",\n          \"quantity\": 1,\n          \"price\": 11.5,\n          \"discount\": 0,\n          \"tax_percent\": \"0.00\"\n        }\n      ],\n      \"total\": 11.5,\n      \"requestAmount\": 11.5,\n      \"language\": \"en\",\n      \"notes\": \"\",\n      \"debt\": 0,\n      \"total_formatted\": 1,\n      \"taxAmount\": 0,\n      \"taxPercent\": 0,\n      \"request_client_details\": [],\n      \"email_message\": \"\"\n    },\n    \"payment\": {\n      \"is_outgoing\": false,\n      \"payment_type\": \"PURCHASE\",\n      \"amount\": 11.5,\n      \"currency\": \"EUR\",\n      \"net_amount\": 11.5,\n      \"fee_amount\": 0,\n      \"pending_amount\": 0,\n      \"pending_unfreeze_on\": null,\n      \"description\": \"\",\n      \"paid_on\": 1783689803,\n      \"remote_paid_on\": 1783689803\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        \"amount\": 11.5,\n        \"masked_pan\": \"PAY-WITH-CRYPTO\"\n      },\n      \"country\": \"\",\n      \"attempts\": [\n        {\n          \"client_ip\": \"203.0.113.81\",\n          \"type\": \"execute\",\n          \"payment_method\": \"PAY-WITH-CRYPTO\",\n          \"flow\": \"payform\",\n          \"successful\": true,\n          \"country\": \"PAY-WITH-CRYPTO\",\n          \"processing_time\": 1783690060,\n          \"extra\": {\n            \"amount\": 11.5,\n            \"masked_pan\": \"PAY-WITH-CRYPTO\"\n          }\n        }\n      ]\n    },\n    \"status\": \"PARTIAL_PAID\",\n    \"status_history\": [\n      {\n        \"status\": \"created\",\n        \"timestamp\": 1783689797\n      },\n      {\n        \"status\": \"pending_execute\",\n        \"timestamp\": 1783689803\n      },\n      {\n        \"status\": \"payment_in_process\",\n        \"timestamp\": 1783689807\n      },\n      {\n        \"status\": \"partial_paid\",\n        \"timestamp\": 1783690015\n      },\n      {\n        \"status\": \"viewed\",\n        \"timestamp\": 1783690014\n      }\n    ],\n    \"viewedOn\": 1783690014,\n    \"is_test\": false,\n    \"brand_id\": \"your-brand-id\",\n    \"send_receipt\": false,\n    \"is_recurring_token\": false,\n    \"skip_capture\": false,\n    \"reference_generated\": \"PS1902\",\n    \"issued\": \"2026-07-10\",\n    \"due\": 1783690051,\n    \"refund_upto\": 1794054463,\n    \"cc_descriptor\": \"\",\n    \"fraudScore\": \"0\",\n    \"trustScore\": \"1\",\n    \"extraFee\": \"0\",\n    \"totalRefunded\": 0,\n    \"pix_payload\": {},\n    \"payInDetails\": {},\n    \"paidOn\": 1783690015,\n    \"receivedAmt\": 0,\n    \"taxAmount\": 0,\n    \"surcharge\": 0,\n    \"surchargeType\": \"\",\n    \"sessionId\": \"\",\n    \"refund_availability\": \"NONE\",\n    \"refundable_amount\": 11.5,\n    \"success_redirect\": \"https://your.success.redirect.com\",\n    \"failure_redirect\": \"https://your.failure.redirect.com\",\n    \"pending_redirect\": \"https://your.pending.redirect.com\",\n    \"cancel_redirect\": \"\",\n    \"success_callback\": \"https://your.success.callback.com\",\n    \"failure_callback\": \"https://your.failure.callback.com\",\n    \"platform\": \"API\",\n    \"created_from_ip\": \"203.0.113.81\",\n    \"checkout_url\": \"https://api.paysecure.net/payments/6a50f24533779459985eb258/\",\n    \"direct_post_url\": \"https://api.paysecure.net/api/v1/p/6a50f24533779459985eb258/\",\n    \"payoutProcess\": false\n  },\n  \"status\": \"partial_paid\"\n}\n\n

A paid webhook carries the same envelope with status = PAID and a paid entry in status_history.

FAQs

Which tokens and networks are supported?
The checkout page shows the tokens and networks enabled for your merchant account. Contact your Account Manager to enable additional ones.

What happens if the customer sends the wrong token or uses the wrong network?
The payment may fail or the funds may be permanently lost. The checkout page warns the customer to send the exact amount using the selected token and network.

What happens if the quote expires before the customer pays?
The purchase moves to expired. Create a new purchase to retry — the crypto amount is re-quoted at current rates.

Can I refund a Pay with Crypto transaction via API?
No — refund_availability is NONE for this method. Contact your Account Manager to arrange refunds (including excess amounts on over_paid transactions).

To initiate a Pay with Crypto 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 response returns a checkout_url — redirect your customer there to complete the crypto payment. The response does not confirm payment; the final status arrives asynchronously via webhook (paid, over_paid, partial_paid, expired, or error) or by polling Get Status.

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

Parameter	Notes
client.email	Mandatory. Customer email address (forwarded to the crypto processor).
client.full_name	Optional. But recommended — full name of the customer, at least 2 words.
client.phone	Optional. Customer's contact phone number.
client.street_address	Optional. Customer's street address.
client.city	Optional. Customer's city.
client.stateCode	Optional. State or province code of the customer.
client.zip_code	Optional. Postal or ZIP code of the customer.
client.country	Optional. ISO 3166-1 alpha-2 country code (for example `IN`, `US`, `GB`).
client.date_of_birth	Optional. Customer's date of birth in YYYY-MM-DD format.
purchase.currency	Mandatory. ISO 4217 fiat currency for the purchase (e.g. `EUR`). The customer pays the crypto equivalent. Minimum transaction amount: 10.00 EUR.
purchase.products.name	Mandatory. Name of the product or service being purchased.
purchase.products.price	Mandatory. Price in decimal format up to 2 decimals. Example: EUR 10 → `10.00`, EUR 11 and 50 cents → `11.50`.
paymentMethod	Conditional. Mandatory if you are not using Paysecure Cashier. Value: `PAY-WITH-CRYPTO`.
brand_id	Mandatory. Obtain from the Dashboard section of your merchant account login.
merchantRef	Optional. Strongly recommended — see Essential Optional Parameters below.
success_redirect	Mandatory. URL to send the customer to if the transaction is successful.
pending_redirect	Mandatory. URL to send the customer to while the payment is awaiting confirmation.
failure_redirect	Mandatory. URL to send the customer to if the transaction has failed.
success_callback	Optional. Merchant webhook endpoint that receives successful payment notifications.
failure_callback	Optional. Merchant webhook endpoint that receives failed payment notifications.

Parameters forwarded to the crypto processor: Paysecure forwards the order amount (from purchase.products), the customer's IP address, a unique reference identifier, and client.email to the underlying crypto processor. You do not need to send these separately — they are derived from the purchase request.

Essential Optional Parameters

merchantRef

The merchantRef parameter, although not mandatory, is strongly advised. Its inclusion offers two significant advantages:

Prevention of Duplicate Requests: if a second purchase request is made using the same merchantRef, the system recognises it and prevents duplicate transactions.
Facilitation of Transaction Retrieval: if the response times out or the purchaseId isn't received, the merchantRef allows you to retrieve the transaction details.

Response

Poll the current state of a purchase using the purchaseId returned by the Purchase API. For Pay with Crypto this is the fallback to webhooks — the status changes asynchronously as the blockchain confirms the transfer.

Possible Payment Statuses

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\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	Terminal?
`created`	Purchase created successfully, awaiting customer	❌
`pending_execute`	Customer has been redirected to the checkout page	❌
`payment_in_process`	Crypto payment submitted, awaiting blockchain confirmation	❌
`paid`	Exact requested amount received and confirmed	✅
`over_paid`	The customer paid more than the requested amount	✅
`partial_paid`	The customer paid less than the requested amount	✅
`expired`	The payment request expired before the customer completed the payment	✅
`error`	Payment failed or was not completed	✅

The top-level status in the response is uppercase (e.g. PAID, OVER_PAID, PARTIAL_PAID); entries in status_history are lowercase. On partial_paid and over_paid, reconcile the actually received amount in the merchant dashboard before fulfilling or refunding.

\n","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"f3d98605-94b2-4aa3-acb6-012cf6b5084a","id":"f3d98605-94b2-4aa3-acb6-012cf6b5084a","name":"PayIn API","type":"folder"}},"urlObject":{"path":["purchases","{purchaseId}"],"host":["https://api.paysecure.net/api/v1"],"query":[],"variable":[]}},"response":[{"id":"bdbb21ab-e3d2-45e3-878b-0bb376e05893","name":"Get Status - Paid","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{APIKey}}","type":"text"}],"url":"https://api.paysecure.net/api/v1/purchases/{purchaseId}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"purchaseId\": \"6a3390aea36f57e04bb8a11b\",\n \"client\": {\n \"customerId\": \"NA\",\n \"email\": \"user5772@example.com\",\n \"phone\": \"+44 07000000000\",\n \"full_name\": \"test test\",\n \"date_of_birth\": \"1994-07-10\",\n \"street_address\": \"1 Example Street\",\n \"country\": \"GB\",\n \"city\": \"Milford\",\n \"zip_code\": \"234567\",\n \"cc\": [],\n \"bcc\": [],\n \"stateCode\": \"LO\"\n },\n \"updated_on\": 1783690281,\n \"type\": \"purchase\",\n \"paymentMethod\": \"OPEN-BANKING,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,MAYA,GCASH,INTERAC-EXPRESS,QRPH,APPLEPAY-REDIRECT,GOOGLEPAY-REDIRECT,KLARNA,QBPAY,RUPAY,UPI,UZCARD,PAY_WITH_INSTAXCHANGE,UPI-INTENT,PayByBank,GOOGLEPAY,APPLEPAY,PAYPLAY,UUWALLET,SKRILL,PAYPAL-ONRAMP,PAYPAL,INTERAC-ETRANSFER,INTERAC,PAY-WITH-CRYPTO,ACH,QR\",\n \"amountUnit\": \"MAJOR\",\n \"errorMsg\": \"Transaction succeeded-APPROVED\",\n \"errorCode\": \"NA\",\n \"force_recurring\": false,\n \"created_on\": 1783690051,\n \"merchantRef\": \"6a3390aea36f57e04bb8a11b\",\n \"purchase\": {\n \"currency\": \"EUR\",\n \"products\": [\n {\n \"name\": \"e-commerce\",\n \"quantity\": 1,\n \"price\": 11.5,\n \"discount\": 0,\n \"tax_percent\": \"0.00\"\n }\n ],\n \"total\": 11.5,\n \"requestAmount\": 11.5,\n \"language\": \"en\",\n \"notes\": \"\",\n \"debt\": 0,\n \"total_formatted\": 1,\n \"taxAmount\": 0,\n \"taxPercent\": 0,\n \"request_client_details\": [],\n \"email_message\": \"\"\n },\n \"payment\": {\n \"is_outgoing\": false,\n \"payment_type\": \"PURCHASE\",\n \"amount\": 11.5,\n \"currency\": \"EUR\",\n \"net_amount\": 11.5,\n \"fee_amount\": 0,\n \"pending_amount\": 0,\n \"pending_unfreeze_on\": null,\n \"description\": \"\",\n \"paid_on\": 1783690060,\n \"remote_paid_on\": 1783690060\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 \"amount\": 11.5,\n \"masked_pan\": \"PAY-WITH-CRYPTO\"\n },\n \"country\": \"\",\n \"attempts\": [\n {\n \"client_ip\": \"203.0.113.81\",\n \"type\": \"execute\",\n \"payment_method\": \"PAY-WITH-CRYPTO\",\n \"flow\": \"payform\",\n \"successful\": true,\n \"country\": \"PAY-WITH-CRYPTO\",\n \"processing_time\": 1783690060,\n \"extra\": {\n \"amount\": 11.5,\n \"masked_pan\": \"PAY-WITH-CRYPTO\"\n }\n }\n ]\n },\n \"status\": \"PAID\",\n \"status_history\": [\n {\n \"status\": \"created\",\n \"timestamp\": 1783690051\n },\n {\n \"status\": \"pending_execute\",\n \"timestamp\": 1783690060\n },\n {\n \"status\": \"payment_in_process\",\n \"timestamp\": 1783690063\n },\n {\n \"status\": \"paid\",\n \"timestamp\": 1783690281\n },\n {\n \"status\": \"viewed\",\n \"timestamp\": 1783690280\n }\n ],\n \"viewedOn\": 1783690280,\n \"is_test\": false,\n \"brand_id\": \"your-brand-id\",\n \"send_receipt\": false,\n \"is_recurring_token\": false,\n \"skip_capture\": false,\n \"reference_generated\": \"PS1874\",\n \"issued\": \"2026-07-10\",\n \"due\": 1783690051,\n \"refund_upto\": 1794054463,\n \"cc_descriptor\": \"\",\n \"fraudScore\": \"0\",\n \"trustScore\": \"1\",\n \"extraFee\": \"0\",\n \"totalRefunded\": 0,\n \"pix_payload\": {},\n \"payInDetails\": {},\n \"paidOn\": 1783690281,\n \"receivedAmt\": 11.5,\n \"taxAmount\": 0,\n \"surcharge\": 0,\n \"surchargeType\": \"\",\n \"sessionId\": \"\",\n \"refund_availability\": \"NONE\",\n \"refundable_amount\": 11.5,\n \"success_redirect\": \"https://your.success.redirect.com\",\n \"failure_redirect\": \"https://your.failure.redirect.com\",\n \"pending_redirect\": \"https://your.pending.redirect.com\",\n \"cancel_redirect\": \"\",\n \"success_callback\": \"https://your.success.callback.com\",\n \"failure_callback\": \"https://your.failure.callback.com\",\n \"platform\": \"API\",\n \"created_from_ip\": \"203.0.113.81\",\n \"checkout_url\": \"https://api.paysecure.net/payments/6a3390aea36f57e04bb8a11b/\",\n \"direct_post_url\": \"https://api.paysecure.net/api/v1/p/6a3390aea36f57e04bb8a11b/\",\n \"payoutProcess\": false\n}"},{"id":"5c211926-97bd-4649-97b8-f977b8c1a0ba","name":"Get Status - Over Paid","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{APIKey}}","type":"text"}],"url":"https://api.paysecure.net/api/v1/purchases/{purchaseId}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"purchaseId\": \"6a50f3430c177fa609c7aa9a\",\n \"client\": {\n \"customerId\": \"NA\",\n \"email\": \"user5772@example.com\",\n \"phone\": \"+44 07000000000\",\n \"full_name\": \"test test\",\n \"date_of_birth\": \"1994-07-10\",\n \"street_address\": \"1 Example Street\",\n \"country\": \"GB\",\n \"city\": \"Milford\",\n \"zip_code\": \"234567\",\n \"cc\": [],\n \"bcc\": [],\n \"stateCode\": \"LO\"\n },\n \"updated_on\": 1783690281,\n \"type\": \"purchase\",\n \"paymentMethod\": \"OPEN-BANKING,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,MAYA,GCASH,INTERAC-EXPRESS,QRPH,APPLEPAY-REDIRECT,GOOGLEPAY-REDIRECT,KLARNA,QBPAY,RUPAY,UPI,UZCARD,PAY_WITH_INSTAXCHANGE,UPI-INTENT,PayByBank,GOOGLEPAY,APPLEPAY,PAYPLAY,UUWALLET,SKRILL,PAYPAL-ONRAMP,PAYPAL,INTERAC-ETRANSFER,INTERAC,PAY-WITH-CRYPTO,ACH,QR\",\n \"amountUnit\": \"MAJOR\",\n \"errorMsg\": \"Transaction succeeded-APPROVED\",\n \"errorCode\": \"NA\",\n \"force_recurring\": false,\n \"created_on\": 1783690051,\n \"merchantRef\": \"6a50f3430c177fa609c7aa9a\",\n \"purchase\": {\n \"currency\": \"EUR\",\n \"products\": [\n {\n \"name\": \"e-commerce\",\n \"quantity\": 1,\n \"price\": 11.5,\n \"discount\": 0,\n \"tax_percent\": \"0.00\"\n }\n ],\n \"total\": 11.5,\n \"requestAmount\": 11.5,\n \"language\": \"en\",\n \"notes\": \"\",\n \"debt\": 0,\n \"total_formatted\": 1,\n \"taxAmount\": 0,\n \"taxPercent\": 0,\n \"request_client_details\": [],\n \"email_message\": \"\"\n },\n \"payment\": {\n \"is_outgoing\": false,\n \"payment_type\": \"PURCHASE\",\n \"amount\": 11.5,\n \"currency\": \"EUR\",\n \"net_amount\": 11.5,\n \"fee_amount\": 0,\n \"pending_amount\": 0,\n \"pending_unfreeze_on\": null,\n \"description\": \"\",\n \"paid_on\": 1783690060,\n \"remote_paid_on\": 1783690060\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 \"amount\": 11.5,\n \"masked_pan\": \"PAY-WITH-CRYPTO\"\n },\n \"country\": \"\",\n \"attempts\": [\n {\n \"client_ip\": \"203.0.113.81\",\n \"type\": \"execute\",\n \"payment_method\": \"PAY-WITH-CRYPTO\",\n \"flow\": \"payform\",\n \"successful\": true,\n \"country\": \"PAY-WITH-CRYPTO\",\n \"processing_time\": 1783690060,\n \"extra\": {\n \"amount\": 11.5,\n \"masked_pan\": \"PAY-WITH-CRYPTO\"\n }\n }\n ]\n },\n \"status\": \"OVER_PAID\",\n \"status_history\": [\n {\n \"status\": \"created\",\n \"timestamp\": 1783690051\n },\n {\n \"status\": \"pending_execute\",\n \"timestamp\": 1783690060\n },\n {\n \"status\": \"payment_in_process\",\n \"timestamp\": 1783690063\n },\n {\n \"status\": \"over_paid\",\n \"timestamp\": 1783690281\n },\n {\n \"status\": \"viewed\",\n \"timestamp\": 1783690280\n }\n ],\n \"viewedOn\": 1783690280,\n \"is_test\": false,\n \"brand_id\": \"your-brand-id\",\n \"send_receipt\": false,\n \"is_recurring_token\": false,\n \"skip_capture\": false,\n \"reference_generated\": \"PS1903\",\n \"issued\": \"2026-07-10\",\n \"due\": 1783690051,\n \"refund_upto\": 1794054463,\n \"cc_descriptor\": \"\",\n \"fraudScore\": \"0\",\n \"trustScore\": \"1\",\n \"extraFee\": \"0\",\n \"totalRefunded\": 0,\n \"pix_payload\": {},\n \"payInDetails\": {},\n \"paidOn\": 0,\n \"receivedAmt\": 0,\n \"taxAmount\": 0,\n \"surcharge\": 0,\n \"surchargeType\": \"\",\n \"sessionId\": \"\",\n \"refund_availability\": \"NONE\",\n \"refundable_amount\": 11.5,\n \"success_redirect\": \"https://your.success.redirect.com\",\n \"failure_redirect\": \"https://your.failure.redirect.com\",\n \"pending_redirect\": \"https://your.pending.redirect.com\",\n \"cancel_redirect\": \"\",\n \"success_callback\": \"https://your.success.callback.com\",\n \"failure_callback\": \"https://your.failure.callback.com\",\n \"platform\": \"API\",\n \"created_from_ip\": \"203.0.113.81\",\n \"checkout_url\": \"https://api.paysecure.net/payments/6a50f3430c177fa609c7aa9a/\",\n \"direct_post_url\": \"https://api.paysecure.net/api/v1/p/6a50f3430c177fa609c7aa9a/\",\n \"payoutProcess\": false\n}"},{"id":"b44b1311-38c8-42ea-b9a3-864efbb2a874","name":"Get Status - Partial Paid","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{APIKey}}","type":"text"}],"url":"https://api.paysecure.net/api/v1/purchases/{purchaseId}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"purchaseId\": \"6a50f24533779459985eb258\",\n \"client\": {\n \"customerId\": \"NA\",\n \"email\": \"user5772@example.com\",\n \"phone\": \"+44 07000000000\",\n \"full_name\": \"test test\",\n \"date_of_birth\": \"1994-07-10\",\n \"street_address\": \"1 Example Street\",\n \"country\": \"GB\",\n \"city\": \"Milford\",\n \"zip_code\": \"234567\",\n \"cc\": [],\n \"bcc\": [],\n \"stateCode\": \"LO\"\n },\n \"updated_on\": 1783690015,\n \"type\": \"purchase\",\n \"paymentMethod\": \"OPEN-BANKING,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,MAYA,GCASH,INTERAC-EXPRESS,QRPH,APPLEPAY-REDIRECT,GOOGLEPAY-REDIRECT,KLARNA,QBPAY,RUPAY,UPI,UZCARD,PAY_WITH_INSTAXCHANGE,UPI-INTENT,PayByBank,GOOGLEPAY,APPLEPAY,PAYPLAY,UUWALLET,SKRILL,PAYPAL-ONRAMP,PAYPAL,INTERAC-ETRANSFER,INTERAC,PAY-WITH-CRYPTO,ACH,QR\",\n \"amountUnit\": \"MAJOR\",\n \"errorMsg\": \"Transaction succeeded-APPROVED\",\n \"errorCode\": \"NA\",\n \"force_recurring\": false,\n \"created_on\": 1783690051,\n \"merchantRef\": \"6a50f24533779459985eb258\",\n \"purchase\": {\n \"currency\": \"EUR\",\n \"products\": [\n {\n \"name\": \"e-commerce\",\n \"quantity\": 1,\n \"price\": 11.5,\n \"discount\": 0,\n \"tax_percent\": \"0.00\"\n }\n ],\n \"total\": 11.5,\n \"requestAmount\": 11.5,\n \"language\": \"en\",\n \"notes\": \"\",\n \"debt\": 0,\n \"total_formatted\": 1,\n \"taxAmount\": 0,\n \"taxPercent\": 0,\n \"request_client_details\": [],\n \"email_message\": \"\"\n },\n \"payment\": {\n \"is_outgoing\": false,\n \"payment_type\": \"PURCHASE\",\n \"amount\": 11.5,\n \"currency\": \"EUR\",\n \"net_amount\": 11.5,\n \"fee_amount\": 0,\n \"pending_amount\": 0,\n \"pending_unfreeze_on\": null,\n \"description\": \"\",\n \"paid_on\": 1783689803,\n \"remote_paid_on\": 1783689803\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 \"amount\": 11.5,\n \"masked_pan\": \"PAY-WITH-CRYPTO\"\n },\n \"country\": \"\",\n \"attempts\": [\n {\n \"client_ip\": \"203.0.113.81\",\n \"type\": \"execute\",\n \"payment_method\": \"PAY-WITH-CRYPTO\",\n \"flow\": \"payform\",\n \"successful\": true,\n \"country\": \"PAY-WITH-CRYPTO\",\n \"processing_time\": 1783690060,\n \"extra\": {\n \"amount\": 11.5,\n \"masked_pan\": \"PAY-WITH-CRYPTO\"\n }\n }\n ]\n },\n \"status\": \"PARTIAL_PAID\",\n \"status_history\": [\n {\n \"status\": \"created\",\n \"timestamp\": 1783689797\n },\n {\n \"status\": \"pending_execute\",\n \"timestamp\": 1783689803\n },\n {\n \"status\": \"payment_in_process\",\n \"timestamp\": 1783689807\n },\n {\n \"status\": \"partial_paid\",\n \"timestamp\": 1783690015\n },\n {\n \"status\": \"viewed\",\n \"timestamp\": 1783690014\n }\n ],\n \"viewedOn\": 1783690014,\n \"is_test\": false,\n \"brand_id\": \"your-brand-id\",\n \"send_receipt\": false,\n \"is_recurring_token\": false,\n \"skip_capture\": false,\n \"reference_generated\": \"PS1902\",\n \"issued\": \"2026-07-10\",\n \"due\": 1783690051,\n \"refund_upto\": 1794054463,\n \"cc_descriptor\": \"\",\n \"fraudScore\": \"0\",\n \"trustScore\": \"1\",\n \"extraFee\": \"0\",\n \"totalRefunded\": 0,\n \"pix_payload\": {},\n \"payInDetails\": {},\n \"paidOn\": 1783690015,\n \"receivedAmt\": 0,\n \"taxAmount\": 0,\n \"surcharge\": 0,\n \"surchargeType\": \"\",\n \"sessionId\": \"\",\n \"refund_availability\": \"NONE\",\n \"refundable_amount\": 11.5,\n \"success_redirect\": \"https://your.success.redirect.com\",\n \"failure_redirect\": \"https://your.failure.redirect.com\",\n \"pending_redirect\": \"https://your.pending.redirect.com\",\n \"cancel_redirect\": \"\",\n \"success_callback\": \"https://your.success.callback.com\",\n \"failure_callback\": \"https://your.failure.callback.com\",\n \"platform\": \"API\",\n \"created_from_ip\": \"203.0.113.81\",\n \"checkout_url\": \"https://api.paysecure.net/payments/6a50f24533779459985eb258/\",\n \"direct_post_url\": \"https://api.paysecure.net/api/v1/p/6a50f24533779459985eb258/\",\n \"payoutProcess\": false\n}"},{"id":"d4cc7d67-4159-4312-8502-83731801de6e","name":"Get Status - Error (Purchase not found)","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{APIKey}}","type":"text"}],"url":"https://api.paysecure.net/api/v1/purchases/{purchaseId}"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Purchase not found!\",\n \"code\": \"transaction_error\"\n}"}],"_postman_id":"05683929-a7ce-4ff9-9951-030ee9ee69c2"}],"id":"f3d98605-94b2-4aa3-acb6-012cf6b5084a","description":"

Create a Pay with Crypto purchase and track it to a terminal status. Both calls use the standard Paysecure purchase contract.

Pay with Crypto lets you accept cryptocurrency payments while creating the purchase in a fiat currency. You create a standard purchase with paymentMethod = PAY-WITH-CRYPTO; the customer picks a token and network on the Paysecure-hosted checkout, pays to a unique wallet address (or scans a QR code), and you receive the final status by webhook once the blockchain confirms the transfer.

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

Property	Details
Payment type	Cryptocurrency (hosted checkout, on-chain transfer)
Countries	Global (subject to merchant compliance configuration)
Processing currency	Fiat (ISO 4217, e.g. `EUR`) — converted to crypto at checkout
PayIn	✅
PayOut	❌
Refunds	❌ Not available via API (`refund_availability` = `NONE`) — contact your Account Manager
Recurring / MIT	❌
Chargebacks	❌ Not applicable — crypto transfers are push payments
Customer flow	Redirect to hosted checkout → QR scan or wallet transfer
Payment confirmation	Asynchronous — final status arrives by webhook after blockchain confirmation
Underpayment / Overpayment	Possible — terminal statuses `partial_paid` / `over_paid` (see Concepts)
Transaction limits	Min 10.00 EUR; max as configured for your merchant account

","_postman_id":"08d3d362-7b1f-4e97-9c60-e6466362ebff"},{"name":"🪙 On Ramp","item":[],"id":"b5b5b2bf-7a44-406f-8379-37c93266b76e","description":"

Overview

Paysecure provides a user-friendly, direct integration with Quickbit wallet where users can purchase and manage their crypto funds easily. Integrating this interface into your payment process is a straightforward process, requiring just a few simple steps.

We continuously work on improving the integration flow, and as we roll out updates, both customers and merchants can look forward to an enhanced and improved payment experience.

Integration Flow

Step 1

The first call to the PaySecure API is POST /purchases initiated by the merchant's backend when they receive a request from the user to make a QuickBit purchase.

It's essential to ensure that the request body includes:

success_redirect - URL where the user will be redirected from Quickbit after completing the purchase
\n
failure_redirect - URL where the user will be redirected from Quickbit if the purchase fails
\n
paymentMethod - Payment method requested. It must specify QBPAYFTOPUP.
\n

\n
It is important to note that paymentMethod is not a mandatory parameter. If it is not provided, the redirect URL will point to Paysecure Cashier. It must be provided for direct payment with Quickbit.
\n

Here's a sample body of the request:

{\n    \"client\": {\n        \"email\": \"user7068@example.com\",\n        \"country\":\"GB\",\n        \"city\":\"Milford\",\n        \"stateCode\":\"Marleybone\",\n        \"street_address\":\"221B Baker Street\",\n        \"zip_code\":\"NW1 6XE\",\n        \"phone\":\"9999999999\"\n    },\n    \"purchase\": {\n        \"products\": [\n            {\n                \"name\": \"QBit Payment\",\n                \"price\": \"10\"\n            }\n        ]\n    },\n    \"status\": \"created\",\n    \"brand_id\": \"your-brand-id\",\n    \"paymentMethod\":\"QBPAYFTOPUP\",\n    \"success_redirect\": \"https://your.success.redirect.com\",\n    \"failure_redirect\": \"https://your.failure.redirect.com\"\n}```\nIf the request is successful the response will include a parameter called CheckOutURL. That is the QBit payment URL that should be loaded to the customer to proceed with the payment. Here is an example of what a successful response looks like:\n```{\n    \"purchaseId\": \"657a10b3c0daf365fa98cdf9\",\n    \"client\": {\n        \"bank_account\": \"\",\n        \"bank_code\": \"\",\n        \"email\": \"user7068@example.com\",\n        \"phone\": \"9999999999\",\n        \"full_name\": \"\",\n        \"date_of_birth\": \"\",\n        \"personal_code\": \"\",\n        \"street_address\": \"221B Baker Street\",\n        \"country\": \"GB\",\n        \"city\": \"Milford\",\n        \"zip_code\": \"NW1 6XE\",\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\": \"Marleybone\"\n    },\n    \"updated_on\": 1702498483,\n    \"type\": \"purchase\",\n    \"paymentMethod\": \"QBPAYFTOPUP\",\n    \"amountUnit\": \"MINOR\",\n    \"errorMsg\": \"\",\n    \"redirectType\": \"POST\",\n    \"force_recurring\": false,\n    \"created_on\": 1702498483,\n    \"merchantRef\": \"657a10b3c0daf365fa98cdf9\",\n    \"merchantName\": \"merchant002\",\n    \"purchase\": {\n        \"currency\": \"USD\",\n        \"products\": [\n            {\n                \"name\": \"QBit Payment\",\n                \"quantity\": 1.0,\n                \"price\": 1000.0,\n                \"discount\": 0,\n                \"tax_percent\": \"0.00\"\n            }\n        ],\n        \"total\": 10.0,\n        \"language\": \"en\",\n        \"notes\": \"\",\n        \"debt\": 0,\n        \"total_formatted\": 1.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                \"bank_account\": \"\",\n                \"bank_code\": \"\"\n            }\n        ],\n        \"legal_name\": \"brand1\",\n        \"brand_name\": \"brand1\",\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\": 1702498483\n        }\n    ],\n    \"is_test\": false,\n    \"brand_id\": \"your-brand-id\",\n    \"send_receipt\": false,\n    \"is_recurring_token\": false,\n    \"skip_capture\": false,\n    \"reference_generated\": \"PS185\",\n    \"issued\": \"2023-12-13\",\n    \"due\": 1702498483,\n    \"refund_upto\": 0,\n    \"cc_descriptor\": \"\",\n    \"refund_availability\": \"NONE\",\n    \"refundable_amount\": 0.0,\n    \"success_redirect\": \"https://your.success.redirect.com\",\n    \"failure_redirect\": \"https://your.failure.redirect.com\",\n    \"cancel_redirect\": \"\",\n    \"success_callback\": \"https://your.success.callback.com\",\n    \"platform\": \"API\",\n    \"created_from_ip\": \"203.0.113.208\",\n    \"checkout_url\": \"https://api.paysecure.net/payments/657a10b3casd23123122/\",\n    \"merchantIp\": \"203.0.113.183\"\n}\n\n

Step 2

Once the customer is redirected to the CheckOutURL page they will see will depend on the user's country. For the users in Sweden, the page will look like this:

\n\n

For user's in other countries, the page will look following:

\n\n

On this page, new users will have to verify their identity and existing users will be prompted to log in.

Step 3

In the Quickbit app, the user will be requested to provide their payment details:

\n\n

Once the payment goes through, the user has to confirm sending the transaction to complete the process:

\n\n

Step 4

Depending on the outcome of the payment at Quickbit, the customer will be directed to the:

If the payment is successful - the URL specified in success_redirect that was provided in the initial POST /purchases request
\n
If the payment is unsuccessful - the URL specified in failure_redirect that was provided in the initial POST /purchases request
\n

\n","_postman_id":"b5b5b2bf-7a44-406f-8379-37c93266b76e"},{"name":"3rd Party Cashiers","item":[{"name":"ThirdParty UPI","item":[{"name":"Concepts","item":[],"id":"95eafe78-c951-41b0-ab37-1b825614e344","description":"

Concepts

APM Integration: Merchants integrate with set of Paysecure APIs to manage both incoming (pay-ins) and outgoing (payouts) funds.
\n
Asynchronous Communication: Both payin and payout flows use callback URLs and webhooks to confirm transaction statuses, ensuring the merchant system stays updated.
\n
Secure Redirection: Customers are securely redirected from the merchant site to the 3rd-party's cashier page for payments and back to the merchant site upon completion.
\n
UPI Payment Options: The integration supports UPI-based payments, presenting customers with choices, like UPI Dynamic QR and UPI intevent via VPA, during the checkout process.
\n
Beneficiary Details: For payouts, essential beneficiary details, including the Virtual Payment Address (VPA), must be provided to correctly route funds.
\n

Key Steps in the Integration Process

PayIn Flow

Customer Selection:
The customer selects UPI as the payment method on the merchant’s website.
\n
API Call to Create Purchase:
The merchant system calls the Paysecure createPurchase API to initiate the transaction.
\n
Redirection to Third-Party Cashier Page:
The customer is redirected to 3rd-party's cashier page using the provided checkout URL.
\n
Payment Options Display:
On the cashier page, the customer is presented with multiple UPI payment options, such as:
\n
- UPI Dynamic QR
  \n
- UPI Intent (via VPA)
  \n
\n
Transaction Execution:
The customer completes the payment using their UPI app.
\n
Callback & Confirmation:
Upon a successful payment, success callback is sent to the merchant’s designated URL. The customer is then redirected back to the merchant’s checkout page, where they see confirmation of a successful payment and an updated balance.
\n

Payout Flow

Payout Request Initiation:
The customer initiates a payout request directly on the merchant’s website.
\n
Beneficiary Details Entry:
The customer enters the Virtual Payment Address (VPA) where they wish to receive the payout.
\n
API Call to Process Payout:
The merchant calls the payout API to process the request.
\n
- Input: Payout amount, beneficiary details (including VPA), and other required parameters.
  \n
- Callback: A callback URL is set up to receive asynchronous updates.
  \n
\n
Payout Execution:
Payout is processed to the customer’s specified VPA.
\n
Webhook Notification:
A success webhook is triggered upon the successful completion of the payout.
\n
Balance Update:
Both the customer’s and merchant’s account balances are updated to reflect the transaction.
\n

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

Parameter	Notes
client.email	An Identifier for a user
client.city
client.country	ISO-3166 Country Code. It must be upper case. This should be \"IN\" for India
client.stateCode	Example “AL”, “XZ”.. Must be in upper case.
client.street_address
client.zip_code
client.full_name
purchase.currency	ISO 4217 code for currency you want to send the transaction in.
purchase.products.name
purchase.products.price	Price in decimal format. example 1: INR 5 , should be sent as 10.00
brand_id	Obtain from Dashboard section of your merchant account login.
success_redirect	URL to send the user if the transactions is successful
failure_redirect	URL to send the user if the transactions is UNSUCCESSFUL

Optional Parameters

expireInMin

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.

paymentMethod

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\n\n\n\n\n\n\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	Description
Invalid format of Date_of_Birth[allowed format: yyyy-mm-dd]
Enter Valid Email
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
Minimum amount is not set for this merchant
success_redirect/failure_redirect/brand_id is missing
brand_id cannot be null
success_redirect cannot be null
failure_redirect cannot be null
Invalid failure_redirect: minimum 10 characters
purchase.products.price cannot be null
purchase.products[0].name/purchase.products[0].price are missing
Your charges setting is incomplete .Plese Contact to Administrator.
Currency \"{curr_name}\" is Not Allowed
Transaction amount must be equal or greater to minimum trans amount
Allowed Limit for this card for particular time period has been consumed

Note: For certain use cases, in addition to long format purchase Id, Paysecure also provides a 7 digit unique code for each purchase starting with digit 4, eg 4000001

“purchaseIdShortCode”: “4000013\"

\n","urlObject":{"path":["purchases",""],"host":["https://api.paysecure.net/api/v1"],"query":[],"variable":[]}},"response":[],"_postman_id":"215764fa-9120-49c2-9db7-7ba846dafca9"},{"name":"Get Status","id":"6954f483-74c6-4fb2-820a-4e53f417918c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer {{APIKey}}","type":"text"}],"url":"https://api.paysecure.net/api/v1/purchases/{purchaseId}/","description":"

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

Note: With respect to bank transfers, the purchase request is synonymous with the PayIn request.

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

Status	Notes
paid	Transaction Successful
payment_in_process	Payment is under Processing
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","urlObject":{"path":["purchases","{purchaseId}",""],"host":["https://api.paysecure.net/api/v1"],"query":[],"variable":[]}},"response":[{"id":"c69bd26c-7afb-46c1-aa7b-2560a29dd219","name":"Purchases-success","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer {{APIKey}}"}],"url":"https://api.paysecure.net/api/v1/purchases/{purchaseId}/"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"purchaseId\": \"66c4667bb993c970367c288a\",\n \"client\": {\n \"email\": \"user1571@example.com\",\n \"date_of_birth\": \"1970-07-10\",\n \"street_address\": \"13 Documentation Way\",\n \"country\": \"IN\",\n \"city\": \"Milford\",\n \"zip_code\": \"68403\",\n \"cc\": [],\n \"bcc\": [],\n \"stateCode\": \"QLD\"\n },\n \"updated_on\": 1724147324,\n \"type\": \"purchase\",\n \"paymentMethod\": \"UPI\",\n \"amountUnit\": \"MAJOR\",\n \"errorMsg\": \"\",\n \"redirectType\": \"POST\",\n \"force_recurring\": false,\n \"created_on\": 1724147324,\n \"merchantRef\": \"66c4667bb993c970367c288a\",\n \"merchantName\": \"merchant002\",\n \"purchase\": {\n \"currency\": \"INR\",\n \"products\": [\n {\n \"name\": \"test\",\n \"quantity\": 1,\n \"price\": 10,\n \"discount\": 0,\n \"tax_percent\": \"0.00\"\n }\n ],\n \"total\": 10,\n \"language\": \"en\",\n \"notes\": \"\",\n \"debt\": 0,\n \"total_formatted\": 1,\n \"expireInMin\": \"35\",\n \"request_client_details\": [],\n \"timezone\": \"MIT\",\n \"email_message\": \"\"\n },\n \"payment\": {\n \"is_outgoing\": false,\n \"payment_type\": \"PURCHASE\",\n \"amount\": 10,\n \"currency\": \"INR\",\n \"net_amount\": 10,\n \"fee_amount\": 0,\n \"pending_amount\": 0,\n \"pending_unfreeze_on\": null,\n \"description\": \"\",\n \"paid_on\": 1724147324,\n \"remote_paid_on\": 1724147324\n },\n \"issuer_details\": {\n \"website\": \"\",\n \"legal_street_address\": \"\",\n \"legal_country\": \"\",\n \"legal_city\": \"\",\n \"legal_zip_code\": \"\",\n \"bank_accounts\": [\n {}\n ],\n \"legal_name\": \"test6\",\n \"brand_name\": \"test6\",\n \"registration_number\": \"\",\n \"tax_number\": \"\"\n },\n \"transaction_data\": {\n \"payment_method\": \"\",\n \"flow\": \"payform\",\n \"extra\": {\n \"amount\": 10,\n \"masked_pan\": \"UPI\"\n },\n \"country\": \"\",\n \"attempts\": [\n {\n \"client_ip\": \"203.0.113.192\",\n \"type\": \"execute\",\n \"payment_method\": \"UPI\",\n \"flow\": \"payform\",\n \"successful\": true,\n \"country\": \"UPI\",\n \"processing_time\": 1724147324,\n \"extra\": {\n \"amount\": 10,\n \"masked_pan\": \"UPI\"\n }\n }\n ]\n },\n \"status\": \"PAYMENT_IN_PROCESS\",\n \"status_history\": [\n {\n \"status\": \"created\",\n \"timestamp\": 1724147324\n },\n {\n \"status\": \"pending_execute\",\n \"timestamp\": 1724147324\n },\n {\n \"status\": \"payment_in_process\",\n \"timestamp\": 1724147324\n }\n ],\n \"is_test\": false,\n \"brand_id\": \"your-brand-id\",\n \"send_receipt\": false,\n \"is_recurring_token\": false,\n \"skip_capture\": false,\n \"reference_generated\": \"PS10907\",\n \"issued\": \"2024-08-20\",\n \"due\": 1724147324,\n \"refund_upto\": 1725871728,\n \"cc_descriptor\": \"test1\",\n \"fraudScore\": \"NA\",\n \"trustScore\": \"NA\",\n \"payInDetails\": {\n \"qrCode\": \"iVBORw0KGgoAAAANSUhEUgAAAb0AAAG9AQAAAACpVZXpAAAH7UlEQVR4nO1cQY7qSgw0yiJLjpCbJBdDIhIXg5vkCCyzQPi7qtwkM2/zNcsYpIfeQFcvTNtdLtsx/9trtS/wC/wCv8A/AZ9mdnpevb9bt6zj+TWso3Uen17i33nGkgverotN/orP7FoHeHV/AG1nfnoZ+kfYrcdKv8ei/gEMvljxRkQZ4MVi5Ww2nm9LbBF/xnLYd7YVVu3dZ262hPUvA3+CUsCnDesJ39/PHhidtlg5cRFek9+WtSgwPO595ldGI4dTAohX/8ZpG2Hp8MdiQPnjEL7XIWJdEae6BfvgC0SxCGCx2Q2fvf5x5GMDGckRov7X2+8r4NhAvW6O82QrHBBeuGBHHjSHK7rDtDxtv8jD0YERv8PPwAHcRjogbv43/BF/wuZwytgHO9r4serxgbIg7vvzPNALY1GHzXDrwYJji2JgTsvOkY8PxGnDDYeVsPHcYjWoUtx6jF04cjPsa8PmjxWAroMWUbtbdPPHPuGZsOqdX8SfOJXGu26zagVgLILHraTWvOUDjRuuU4jq4a2xj8y9hLd6HaArFcMtD997gVoHJYCRwa8H2HzgWVxBDkoBxR5lraVHxIpgdWXEcjJKHrmw+S2Z071F8gLA+JSGCkwEbISoOFnJHiNtvSAhgc0RpyKmw/BeBqgUFUcJGIPWAZnjY1VXis+bUMdw93McHph0kXedfA/pBfMx5CKLlJCJ9n3+FEkOD1QSiuUyrSWaQfyuc0eS3UElm+m8ZYDNqrCbkQMgMMGWEcCQhdEB6a1Jsps/VgCGybASWTtOFu1Lz8SlD/lsgheepBXFupaUFQEiC4MXzozaRjYQrnhRAksioORDbx8doAAQkfwM3qzrP4MVI3lwRqeEOEgTgc37eyVg5zxFZNAuboR0HlkY5VZdbszbELtk6SpAk/DV44yBB2H5zFSWgR3KPAkSKIHZT3nt6EA4INgPmKJRim/1L1MljKI8zS0NbSwElG5qrX6DwsQkDQh5Kr91prI3V4jfqHUBYKfKH9jPQPbDCpchTkmop/xzgiYi9dULASm2863TQeuxGYuDYVUzmtFOm3tuxaDjA+Fi0AehAZFB0zOpfxikD4Uo7YOw9SFIBYAqkN4UyRnY4ZnNFWnfVlpX7WeTEI8PBGWepDvLZCDPopBZOQVVgj+CCNwaaaoBxP8p/zDloN5jZI/sQABGeYe7ctftyBUAPpmmozqBpAyZ/ArxmXmqfJTqIZVWbLGJJBWAtCXqN8rCqIN1rqh9N0qIs84dGzU2raMAkPEbJjMWt85atJg1fZXZhm7CURyqDvCpWpejnUci4QrxmWSSVQwqRGwT47qdEFQBOPCWpxeCPBulsl55KiyIOM96hiLWw+sAndSQB+1KqQxnjEBmIC+xb2NNjFnJp95RASjimEViKtAiTWoEM1bf1YHK2vKOPR4fiJuLyrIZuk0hNOP6Z9McsxJk8gsJEm44sYEqQHaghvF4fQk9ch+9MXR3aOdRJA9KsJVKDw9k1FbDE1WyiOkUghiwSQlQycmyz5mCRyWgZxAyFU2dJJvxm59RsgerlmS/XXMFgOzfYU3H1OFuSlaRnq288JyuyL5dhLJPB0IBIBa9mbCrOYxaqkqlqPwhlcU1B89Ud/wnklcABjdCmi4dEcoyo1Nrt2yVsDGrGGpqrgNUqY8siQblQXMeOcZv6Ijr1LpYdjWd4wM9h2yYcanE02gRxY3WmSHSxBKP1wFK4NFVz0i0jZUwO2Viz3PHA7nrfD4+8MlRLCRl4NITs42WxPdZxKGQdpXSah/aWQDo5IcJVB2ZhBrHi0UcmjY7eH/8HAWAraaTxMfSAU1ah9E9L8pAVD6tBGQnt/h1bMFGg3fLMdjUwvaMNfMOzCJtR+7wQPWucKBmZjjnV61DjJtxXkJpiO1qOhWAOV/TYhKcUpM2F91rxqGJVrHYdXcXAPIA5dDsIPXwnUZWOxRpgrMjEzORW8GrAnDO4tbE8QnORrCfBeeOMvSk3h/LLR6FgNtIIyui1OglaTAhYXNYamicufGdIx8eqFz9ZTkMYWy8dA1vqRp4Ir/2WcLINlBQAPgkIWQQz0c8OFvlkl8zA5lzGAeHz9+FgO6ii+y9QCRSowHdTtH9xOZTjWBn6asKUK2VvtBaUuFH+R62oAZkObLfKzM71wHCqhyVaFPpIs/emndV+mLfBmtivv85Dg9kAwajE+K3kg8lpq3YA0dlY48GAM+FgDklq7wDoVtUaVT/e/YdJDdiUcPrAHmeFJhemkBKMunZ/y6nZDeYGMKmzB8eCBshHW1T6VhuqdabzmI+P2Tpm1OWAWoei88uSBV+o9G7eimfN4O0f9e/enyg9PgL5Xk9tqDP9OKmKilbCNU0dxL6Wgr4aOlo/yGOagQ7yeZqwYRnXndlxArAnNHfRvbzXlML5ktJmWdij2rgsxAQVlVJMF2xaUCcGuUH6n9SpX3f9XR8IF7qQIiTlUWcznXf5/CRZfflqIGuaxkgDEVqaOyX4+VmnNvic2SyTCi5VRWfdgVUAF5dUVtj6KrpwL545dMX7TNg/LMaeHygnr7YxNM2JcEvVOLJrISKolk9oPpxW7ep+JJodLJqnkpN9Vs1IFxsarqzpLKHsrUXGaW1+vrFfj3w8+BA+iOHA1omrxbCJ9F67IP2oUK04+QFgC2Sq8U7x5CGTyVsaL3LLjIp9ywC/NPrC/wCv8Av8C/A/wCpreUSrYyOqQAAAABJRU5ErkJggg==\",\n \"gpayUri\": \"gpay://upi/pay?ver=01&mode=15&am=5.00&mam=1.00&cu=INR&pa=npstpay@timecosmos&pn=NPST%20PAY&mc=6012&tr=NPST040120220010&tn=QR%20SIT%20testing&mid=NPSTPAY001&msid=NPSTPAY001-001&mtid=NPSTPAY001-001&category=02&url=http://google.com\",\n \"phonepeUri\": \"phonepe://pay?ver=01&mode=15&am=5.00&mam=1.00&cu=INR&pa=npstpay@timecosmos&pn=NPST%20PAY&mc=6012&tr=NPST040120220010&tn=QR%20SIT%20testing&mid=NPSTPAY001&msid=NPSTPAY001-001&mtid=NPSTPAY001-001&category=02&url=http://google.com\",\n \"paytmUri\": \"paytmmp://pay?ver=01&mode=15&am=5.00&mam=1.00&cu=INR&pa=npstpay@timecosmos&pn=NPST%20PAY&mc=6012&tr=NPST040120220010&tn=QR%20SIT%20testing&mid=NPSTPAY001&msid=NPSTPAY001-001&mtid=NPSTPAY001-001&category=02&url=http://google.com\",\n \"generatedLink\": \"https://api.paysecure.net/pay/514o5z3m9z\"\n },\n \"refund_availability\": \"NONE\",\n \"refundable_amount\": 10,\n \"success_redirect\": \"https://your.success.redirect.com\",\n \"failure_redirect\": \"https://your.failure.redirect.com\",\n \"cancel_redirect\": \"\",\n \"success_callback\": \"https://your.success.callback.com\",\n \"failure_callback\": \"https://your.failure.callback.com\",\n \"platform\": \"API\",\n \"created_from_ip\": \"203.0.113.192\",\n \"checkout_url\": \"https://api.paysecure.net/payments/66c4667bb993c970367c288a/\",\n \"payoutProcess\": false\n}"},{"id":"50a97a0c-0184-4f0f-b27a-ecd81772511f","name":"Purchases","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer {{APIKey}}","type":"text"}],"url":"https://api.paysecure.net/api/v1/purchases/{purchaseId}/"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Error Message\",\n \"code\": \"error_code\"\n}"}],"_postman_id":"6954f483-74c6-4fb2-820a-4e53f417918c"}],"id":"0943cbe2-b8f2-47c5-9441-822c609f1b5f","description":"

PayIn API Flow

Initiation:
\n
1. Merchant system calls paysecure Purchases API.
  \n
2. Response: Returns a checkout URL and initiates a callback URL.
  \n
\n
Redirection:
\n
1. Customer is redirected to the cashier page.
\n
Payment Method Selection:
\n
1. The cashier page displays options such as UPI Dynamic QR and UPI ID.
\n
Transaction Processing:
\n
1. Customer completes the payment using a UPI app.
\n
Success Callback:
\n
1. On successful payment, a scuccess wehook is triggered
\n
Finalization:
\n
1. Customer is redirected back to the merchant site where the transaction status is displayed and the balance is updated.
\n

\n","_postman_id":"0943cbe2-b8f2-47c5-9441-822c609f1b5f","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"0a720e0e-9b08-4b29-946a-bff6ff991297","id":"0a720e0e-9b08-4b29-946a-bff6ff991297","name":"ThirdParty UPI","type":"folder"}}},{"name":"Payout","item":[{"name":"Create PayOut","id":"bea9d71b-e544-485d-8051-b4ad564e8db6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer {{APIKey}}"}],"body":{"mode":"raw","raw":"{\r\n \"client\": {\r\n \"email\": \"user3808@example.com\",\r\n \"country\": \"CA\",\r\n \"phone\": \"766225230591\",\r\n \"full_name\": \"Avery Larsen\"\r\n },\r\n \"beneficiaryDetail\": {\r\n \"upi\": \"alpha@bravo\"\r\n },\r\n \"purpose\": \"test payout\",\r\n \"currency\": \"INR\",\r\n \"payoutMethod\": \"PAYOUT-THIRDPARTY-UPI\",\r\n \"amount\": 10,\r\n \"success_callback\": \"https://your.success.callback.com\",\r\n \"failure_callback\": \"https://your.failure.callback.com\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.paysecure.net/api/v1/payout/","description":"

To Initiate a payment, the very first call to make is /payout/ with the required data in the request body.

To generate a Payout, you are required to provide the API key (in the header) can be located in the Dashboard section of your merchant account login.

The request body structure is shown on the request body of the example request shown here.

The following (see table below) are the mandatory parameters that are required to create a Payout 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

Parameter	Notes
client.email	An Identifier for a user
client.phone	An Identifier for a user
client.full_name	An Identifier for a user
client.country
payoutMethod	PAYOUT-THIRDPARTY-UPI
beneficiaryDetail.upi	VPA (UPI ID)
Currency	Note this is currency account for which you have balance
Amount	Amount in Currency
Purpose	Purpose of the payment

","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"0a720e0e-9b08-4b29-946a-bff6ff991297","id":"0a720e0e-9b08-4b29-946a-bff6ff991297","name":"ThirdParty UPI","type":"folder"}},"urlObject":{"path":["payout",""],"host":["https://api.paysecure.net/api/v1"],"query":[{"disabled":true,"key":"","value":null},{"disabled":true,"key":null,"value":""}],"variable":[]}},"response":[],"_postman_id":"bea9d71b-e544-485d-8051-b4ad564e8db6"},{"name":"Get Status","id":"e585a59a-033e-45e4-ac4e-d2fe2d2f1a13","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.paysecure.net/api/v1/getpayout/{payoutId}/","description":"

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

Mandatory

you need to pass the payoutId 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
payout_in_process	payout is under Processing.
error	Transaction has Failed.

The webhook will only be triggered for paid transactions or errors.

Paid: \"success_callback\": \"https://your.success.callback.com\",

Error: \"failure_callback\": “https://failure.com”

\n","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"0a720e0e-9b08-4b29-946a-bff6ff991297","id":"0a720e0e-9b08-4b29-946a-bff6ff991297","name":"ThirdParty UPI","type":"folder"}},"urlObject":{"path":["getpayout","{payoutId}",""],"host":["https://api.paysecure.net/api/v1"],"query":[],"variable":[]}},"response":[{"id":"d038641e-177e-4dbb-a2cf-c81d74f3043d","name":"Get success Status","originalRequest":{"method":"GET","header":[],"url":"https://api.paysecure.net/api/v1/getpayout/{payoutId}/"},"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":"{\r\n \"payoutId\": \"66838ae86d41e41c10a8656d\",\r\n \"client\": {\r\n \"email\": \"user4063@example.com\",\r\n \"phone\": \"766533230591\",\r\n \"full_name\": \"Avery Larsen\",\r\n \"country\": \"CA\"\r\n },\r\n \"updated_on\": 1719896808,\r\n \"payoutMethod\": \"PAYOUT-UPI\",\r\n \"beneficiaryDetail\": {\r\n \"upi\": \"charles.babbage@okhdfc\",\r\n \"transferType\": \"UPI\"\r\n },\r\n \"amountUnit\": \"MAJOR\",\r\n \"amount\": 10.0,\r\n \"errorMsg\": \"\",\r\n \"purpose\": \"test payout\",\r\n \"created_on\": 1719896808,\r\n \"merchantRef\": \"66838ae86d41e41c10a8656d\",\r\n \"merchantName\": \"newMerchant777\",\r\n \"status\": \"PAYOUT_IN_PROCESS\",\r\n \"status_history\": [\r\n {\r\n \"status\": \"created\",\r\n \"timestamp\": 1719896808\r\n },\r\n {\r\n \"status\": \"payout_in_process\",\r\n \"timestamp\": 1719896810\r\n },\r\n {\r\n \"status\": \"viewed\",\r\n \"timestamp\": 1719900796\r\n }\r\n ],\r\n \"viewedOn\": 1719900796,\r\n \"currency\": \"INR\",\r\n \"paymentOn\": 0,\r\n \"success_callback\": \"https://your.success.callback.com\",\r\n \"failure_callback\": \"https://your.failure.callback.com\"\r\n}\r\n"},{"id":"81e68bce-0a5e-4804-93f4-54ff7c9a1dce","name":"Get Error Status","originalRequest":{"method":"GET","header":[],"url":"https://api.paysecure.net/api/v1/getpayout/{payoutId}/"},"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":"{\r\n \"message\": \"Error Message\",\r\n \"code\": \"error_code\"\r\n}"}],"_postman_id":"e585a59a-033e-45e4-ac4e-d2fe2d2f1a13"}],"id":"79f9c9c6-a938-4824-80bf-bd32f7b326dc","description":"

Payout API Flow

Customer Action:
\n
- Customer initiates a payout request on the merchant site and inputs their VPA.
\n
Initiation:
\n
- Merchant system calls its payout API.
  \n
- Input Data: Includes payout amount, beneficiary details (with VPA), and callback URL.
  \n
\n
Processing:
\n
- The payout request is processed.
\n
Webhook Notification:
\n
- Upon successful payout, merchant receives a success webhook.
\n
Finalization:
\n
- Merchant system updates both customer and merchant balances accordingly.
\n

\n","_postman_id":"79f9c9c6-a938-4824-80bf-bd32f7b326dc","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"0a720e0e-9b08-4b29-946a-bff6ff991297","id":"0a720e0e-9b08-4b29-946a-bff6ff991297","name":"ThirdParty UPI","type":"folder"}}}],"id":"0a720e0e-9b08-4b29-946a-bff6ff991297","description":"

This is a versatile payment solution that supports both pay-ins (customer payments) and payouts (customer withdrawals) primarily using UPI-based transactions. This integration enables merchants to provide seamless payment experiences on their platforms, offering multiple UPI payment options such as UPI Dynamic QR and UPI Intent (via VPA) payments. The integration leverages asynchronous callbacks and webhooks to ensure real-time transaction status updates and balance synchronization.

Overview

Paysecure 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 PaySecure 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.

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

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":["https://api.paysecure.net/api/v1"],"query":[],"variable":[]}},"response":[{"id":"7fd18a90-d721-46cf-991c-b37d5b5fd4f2","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\": \"user5772@example.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://api.paysecure.net/api/v1/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":"f2726567-a184-44d8-92ce-7a3e46f9a1a9","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\": \"user5772@example.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://api.paysecure.net/api/v1/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":"d1f89783-7b21-43ac-8dad-1f523021cdb5"},{"name":"checkTransactionAllowed","id":"5712ae38-0783-4dc6-900e-9be07134fe08","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"requiredinput\": {\r\n \"ip\": \"203.0.113.106\",\r\n \"email\": \"user5772@example.com\",\r\n \"url\": \"https://www.asos.com/\"\r\n },\r\n \"optionalInput\": {\r\n \"last_bets\": null,\r\n \"last_wins\": \"\",\r\n \"total_bonuses\": \"\",\r\n \"last_real_bets\": \"\",\r\n \"last_real_wins\": \"\",\r\n \"total_deposits\": \"\",\r\n \"last_bonus_bets\": \"\",\r\n \"last_bonus_wins\": \"\",\r\n \"average_real_bet\": \"\",\r\n \"last_bets_amount\": \"\",\r\n \"last_wins_amount\": \"\",\r\n \"average_bonus_bet\": \"\",\r\n \"bonus_to_deposits\": \"\",\r\n \"last_deposit_date\": \"\",\r\n \"total_withdrawals\": \"\",\r\n \"is_phone_confirmed\": \"\",\r\n \"money_in_money_out\": \"\",\r\n \"last_deposit_amount\": \"\",\r\n \"last_freespins_date\": \"\",\r\n \"last_freespins_name\": \"\",\r\n \"last_free_bonus_date\": \"\",\r\n \"last_free_bonus_name\": \"\",\r\n \"total_bonuses_amount\": \"\",\r\n \"last_freespins_amount\": \"\",\r\n \"last_freespins_status\": \"\",\r\n \"last_real_bets_amount\": \"\",\r\n \"last_real_wins_amount\": \"\",\r\n \"total_deposits_amount\": \"\",\r\n \"last_bonus_bets_amount\": \"\",\r\n \"last_bonus_wins_amount\": \"\",\r\n \"last_free_bonus_amount\": \"\",\r\n \"last_free_bonus_status\": \"\",\r\n \"last_deposit_bonus_date\": \"\",\r\n \"last_deposit_bonus_name\": \"\",\r\n \"last_freespins_currency\": \"\",\r\n \"last_freespins_wagering\": \"\",\r\n \"withdrawals_to_deposits\": \"\",\r\n \"last_free_bonus_currency\": \"\",\r\n \"last_free_bonus_wagering\": \"\",\r\n \"total_withdrawals_amount\": \"\",\r\n \"withdrawal_ewallet_email\": \"\",\r\n \"last_deposit_bonus_amount\": \"\",\r\n \"last_deposit_bonus_status\": \"\",\r\n \"last_deposit_bonus_currency\": \"\",\r\n \"last_deposit_bonus_wagering\": \"\",\r\n \"session\": \"\",\r\n \"payment_mode\": \"\",\r\n \"card_fullname\": \"\",\r\n \"card_bin\": \"\",\r\n \"card_hash\": \"\",\r\n \"card_last\": \"\",\r\n \"card_expire\": \"\",\r\n \"avs_result\": \"\",\r\n \"cvv_result\": \"\",\r\n \"sca_method\": \"\",\r\n \"user_bank_account\": \"\",\r\n \"user_bank_name\": \"\",\r\n \"user_balance\": \"\",\r\n \"user_verification_level\": \"\",\r\n \"status_3d\": \"\",\r\n \"regulation\": \"\",\r\n \"payment_provider\": \"\",\r\n \"phone_number\": \"\",\r\n \"transaction_type\": \"\",\r\n \"transaction_amount\": \"\",\r\n \"transaction_currency\": \"\",\r\n \"merchant_id\": \"\",\r\n \"details_url\": \"\",\r\n \"name\": \"\",\r\n \"person_type\": \"\",\r\n \"gender\": \"\"\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.paysecure.net/api/v1/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

Access to this API has to be given to you by the admin. So please contact your sales representative at Paysecure 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

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":["https://api.paysecure.net/api/v1"],"query":[],"variable":[]}},"response":[{"id":"9e309f3e-9981-42b4-9aaf-d76111087b74","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\": \"user5772@example.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://api.paysecure.net/api/v1/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":"e75496e7-60f7-4221-a1d7-1136b7df93bc","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\": \"user5772@example.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://api.paysecure.net/api/v1/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":"5712ae38-0783-4dc6-900e-9be07134fe08"}],"id":"053bbe78-b35d-46bb-af21-eb040389edda","_postman_id":"053bbe78-b35d-46bb-af21-eb040389edda","description":""},{"name":"Cashier APIs","item":[{"name":"Customer","id":"57dcd018-b449-4805-9a63-cf8ec49ef57c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{APIKey}}","type":"text"},{"key":"BrandId","value":"your-brand-id","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"fullName\": \"Reese Nakamura\",\r\n \"emailId\": \"user7734@example.com\",\r\n \"dateOfBirth\": \"1994-06-03\",\r\n \"phoneNo\": \"+91 797639082\",\r\n \"city\": \"Riverton\",\r\n \"stateCode\": \"RJ\",\r\n \"zipCode\": \"302018\",\r\n \"address\": \"24 Sample Avenue\",\r\n \"country\": \"IN\",\r\n \"merchantCustomerId\": \"user8912@example.com\",\r\n \"CustRegDate\": \"2023-12-27\", //non-mandatory - customer registration date on merchant site\r\n \"SuccessTxn\": \"32\", //non-mandatory - total successful customer orders on merchant site\r\n \"extraParam\": {\r\n \"param1\": \"value1\",\r\n \"param2\": \"value2\",\r\n \"param3\": \"value3\",\r\n \"param4\": \"value4\"\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.paysecure.net/api/v1/customer","description":"

OVERIEW

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\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	user8912@example.com
fullName	String	Yes	Full name of the customer.	Reese Nakamura
emailId	String	Yes	Email address of the customer.	user3456@example.com
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.	Riverton
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.	24 Sample Avenue
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 Paysecure API with the customer's details.
\n
Customer ID generation: Paysecure 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 Paysecure 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":"7256158c-b175-41fb-b416-ea6b113c2fce"}}],"id":"166d9399-feec-4bf3-a3bf-e331b1d12bfd","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"PATCH","header":[{"key":"Authorization","value":"Bearer {{APIKey}}","type":"text"},{"key":"BrandId","value":"your-brand-id","type":"text"},{"key":"Accept","value":"*/*","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"fullName\": \"Reese Rivera\",\n \"emailId\": \"user5989@example.com\",\n \"dateOfBirth\": \"1990-11-27\",\n \"phoneNo\": \"+91 9413666514\",\n \"city\": \"Kingsport\",\n \"stateCode\": \"Raj\",\n \"zipCode\": \"202021\",\n \"address\": \"58 Testing Lane\",\n \"country\": \"IN\",\n \"CustRegDate\": \"2023-12-28\",\n \"SuccessTxn\": \"33\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.paysecure.net/api/v1/{PaysecureCustomerId}/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 Paysecure.

This API endpoint allows you to update the customer details using an HTTP PATCH request. The request should be sent to https://api.paysecure.net/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":{"path":["{PaysecureCustomerId}","patchCustomer"],"host":["https://api.paysecure.net/api/v1"],"query":[],"variable":[]}},"response":[{"id":"c0592ddc-d084-4015-9362-2853dc9d996e","name":"Success","originalRequest":{"method":"PATCH","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"*/*","type":"text"},{"key":"BrandId","value":"your-brand-id","type":"text"},{"key":"Authorisation","value":"Bearer Token","type":"text"}],"body":{"mode":"raw","raw":"{\n \"fullName\": \"Reese Rivera\",\n \"emailId\": \"user5989@example.com\",\n \"dateOfBirth\": \"1990-11-27\",\n \"phoneNo\": \"+91 9413666514\",\n \"city\": \"Kingsport\",\n \"stateCode\": \"Raj\",\n \"zipCode\": \"202021\",\n \"address\": \"58 Testing Lane\",\n \"country\": \"IN\",\n \"CustRegDate\": \"2023-12-28\",\n \"SuccessTxn\": \"33\",\n \"extraParam\": {\n \"param1\": \"value1\",\n \"param2\": \"value2\",\n \"param3\": \"value3\",\n \"param4\": \"value4\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://api.paysecure.net/api/v1/{PaysecureCustomerId}/patchCustomer"},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":"{\n \"customerId\": \"691afbc6fd96d34a8113a34d\",\n \"merchantCustomerId\": \"user5489@example.com\",\n \"fullName\": \"Reese Rivera\",\n \"emailId\": \"user5989@example.com\",\n \"dateOfBirth\": \"1990-11-27\",\n \"phoneNo\": \"+91 9413666514\",\n \"brandID\": \"your-brand-id\",\n \"city\": \"Kingsport\",\n \"zipCode\": \"202021\",\n \"address\": \"58 Testing Lane\",\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":"166d9399-feec-4bf3-a3bf-e331b1d12bfd"},{"name":"Purchase Session","id":"2b150d84-25a3-41e1-a2a5-9e09caf994c5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{APIKey}}","type":"text"},{"key":"BrandId","value":"your-brand-id","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\": \"user5489@example.com\", // optional\r\n \"currency\": \"EUR\",\r\n \"products\": [\r\n {\r\n \"name\": \"Product1\",\r\n \"price\": \"10\"\r\n },\r\n {\r\n \"name\": \"Product2\",\r\n \"price\": \"12\"\r\n }\r\n ],\r\n \"totalAmount\": \"22\", // optional, but if present have precedence over sum of prices mentioned above.\r\n \"paymentMethod\": \"VISA\", //optional\r\n \"success_redirect\": \"https://your.success.redirect.com\",\r\n \"failure_redirect\": \"https://your.failure.redirect.com\",\r\n \"pending_redirect\": \"https://your.pending.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 \"param1\": \"value1\",\r\n \"showCryptoConversion\": \"yes\",\r\n \"cryptoCurrencies\": \"[\\\"BTC\\\",\\\"ETH\\\",\\\"USDT\\\",\\\"XRP\\\",\\\"LTC\\\",\\\"DOGE\\\",\\\"ETC\\\",\\\"BNB\\\",\\\"USDC\\\",\\\"SOL\\\",\\\"ADA\\\",\\\"BCH\\\",\\\"DASH\\\",\\\"BTG\\\",\\\"ZEC\\\",\\\"DGB\\\",\\\"EOS\\\",\\\"XLM\\\",\\\"TRX\\\",\\\"QTUM\\\",\\\"POL\\\",\\\"SHIB\\\",\\\"LINK\\\",\\\"DAI\\\",\\\"TON\\\",\\\"AVAX\\\",\\\"FDUSD\\\",\\\"ARB\\\",\\\"OP\\\"]\",\r\n \"param3\": \"value3\",\r\n \"param4\": \"value4\"\r\n }\r\n }","options":{"raw":{"language":"json"}}},"url":"https://api.paysecure.net/api/v1/createSession","description":"

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

Show Crypto Conversion

Additionally, there are some default extra parameters that you can pass for allowing Crypto Conversion on Paysecure'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: PaySecure 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 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://api.paysecure.net/payoutSession/68341ad35f895955355d5452/\",\n    \"brandId\": \"your-brand-id\",\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":"53a4ccc8-3f67-4e7d-a38c-069f1f6eae81","id":"53a4ccc8-3f67-4e7d-a38c-069f1f6eae81","name":"Cashier APIs","type":"folder"}},"urlObject":{"path":["purchases","{Session ID}",""],"host":["https://api.paysecure.net/api/v1"],"query":[],"variable":[]}},"response":[{"id":"fe9b5e73-8513-4aa6-842f-739ed2d10bf9","name":"202 Success","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{APIKey}}"}],"url":"https://api.paysecure.net/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\": \"user8399@example.com\",\n \"phone\": \"+919634088561\",\n \"full_name\": \"Reese Nakamura\",\n \"street_address\": \"90 Fixture Close\",\n \"country\": \"NA\",\n \"city\": \"Ashford\",\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\": \"Morgan Costa_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\": \"Morgan Costa\",\n \"expiry_year\": \"30\"\n },\n \"country\": \"\",\n \"attempts\": [\n {\n \"client_ip\": \"203.0.113.4\",\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\": \"Morgan Costa\",\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\": \"your-brand-id\",\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://your.success.redirect.com\",\n \"failure_redirect\": \"https://your.failure.redirect.com\",\n \"pending_redirect\": \"https://your.pending.redirect.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.paysecure.net/payments/adb6e07f74ec6197ef764909736d478e/\",\n \"direct_post_url\": \"https://api.paysecure.net/api/v1/p/6950e4e3e4a1b008c2fae5c3/\",\n \"payoutProcess\": false\n}"},{"id":"1163f16e-9758-4c6e-b67e-692ad3468179","name":"400 Bad Request","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{APIKey}}"}],"url":"https://api.paysecure.net/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":"3050ed7e-acb7-41f5-a168-f6a4cdf4f72a","name":"401 Unauthorized","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{APIKey}}"}],"url":"https://api.paysecure.net/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":"95060b62-8db9-4949-976a-be2171c8ac91"},{"name":"Check Status - Payout","id":"f9d9c58a-c561-4285-b179-3ab76594f93b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{APIKey}}","type":"text"}],"url":"https://api.paysecure.net/api/v1/getpayout/{Session ID}/","description":"

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

Mandatory

you need to pass the payoutId or session id 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
payout_in_process	payout is under Processing.
error	Transaction has Failed.

","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"53a4ccc8-3f67-4e7d-a38c-069f1f6eae81","id":"53a4ccc8-3f67-4e7d-a38c-069f1f6eae81","name":"Cashier APIs","type":"folder"}},"urlObject":{"path":["getpayout","{Session ID}",""],"host":["https://api.paysecure.net/api/v1"],"query":[],"variable":[]}},"response":[{"id":"7e6d743c-3385-4c2f-9ca0-31465ce27b91","name":"Success","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{APIKey}}","type":"text"}],"url":"https://api.paysecure.net/api/v1/getpayout/{Session ID}/"},"status":"Accepted","code":202,"_postman_previewlanguage":"Text","header":[{"key":"Date","value":"Mon, 27 Apr 2026 07:03:52 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":"9be65213-e200-4ef2-831c-683022389e8b"},{"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 ea9784182c7536f5ce15ec71cf0089d6.cloudfront.net (CloudFront)"},{"key":"X-Amz-Cf-Pop","value":"IAD61-P10"},{"key":"X-Amz-Cf-Id","value":"SQqBgIYJCqc_HzF2NrYyoiCCGUdxGyPFZ3OzmUrrL-XBe56tKWTifA=="},{"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=dRx0V9WF8UC%2FPmYeyh%2Fl2YI7rIhT15NcQDiRVHdKuzF4jjsVyYmbl2imFi%2FSpP4VpmIHsFmO0xzXUjyO1%2BwKeupdremHVjRNwtqENY%2FZxgVpN7KFFzAhSQDhOMdd62Anr2zN\"}]}"},{"key":"CF-RAY","value":"9f2bf84969fa9c85-IAD"}],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\n \"payoutId\": \"65ffadb4c1c83822903a9205\",\n \"client\": {\n \"email\": \"user5424@example.com\",\n \"full_name\": \"Avery Larsen\",\n \"street_address\": \"13 Documentation Way\",\n \"country\": \"SG\",\n \"city\": \"Oakdale\",\n \"zip_code\": \"123456\",\n \"stateCode\": \"test\"\n },\n \"updated_on\": 1711254964,\n \"payoutMethod\": \"Payout-BANKTRANSFER\",\n \"beneficiaryDetail\":{\n \"bankName\": \"DBS Bank\", \n \"bankAccountName\": \"test test\",\n \"bankAccountCurrency\": \"SGD\",\n \"bankAccountNumber\": \"12345640\",\n \"bankCountryCode\" : \"SG\",\n \"swiftCode\": \"DBSSSGSG\",\n \"routing_param\" :\n {\n \"bankCode\": \"897678\",\n \"bankBranchCode\" : \"888\"\n \n }\n },\n \"amountUnit\": \"MAJOR\",\n \"amount\": 1000.0,\n \"errorMsg\": \"Currency Account has insufficient balance.\",\n \"purpose\": \"test payout\",\n \"created_on\": 1711254972,\n \"merchantRef\": \"65ffadb4c1c83822903a9205\",\n \"status\": \"ERROR\",\n \"status_history\": [\n {\n \"status\": \"created\",\n \"timestamp\": 1711254964\n },\n {\n \"status\": \"error\",\n \"timestamp\": 1711254972\n }\n ],\n \"currency\": \"USD\",\n \"success_callback\": \"https://your.success.callback.com\",\n \"failure_callback\": \"https://your.failure.callback.com\"\n}"}],"_postman_id":"f9d9c58a-c561-4285-b179-3ab76594f93b"}],"id":"53a4ccc8-3f67-4e7d-a38c-069f1f6eae81","description":"

Paysecure 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 Paysecure'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

For cases where Paysecure handles the scheduling:

","auth":{"type":"noauth","isInherited":false},"event":[{"listen":"prerequest","script":{"type":"text/javascript","packages":{},"requests":{},"exec":[""],"id":"93087ee5-d290-4cb9-ac0c-43162f46477c"}},{"listen":"test","script":{"type":"text/javascript","packages":{},"requests":{},"exec":[""],"id":"5d9f46bc-cd00-4983-a880-654107a05f6b"}}],"_postman_id":"72bda194-fa9e-4196-9425-b2926dda82f3"},{"name":"APIs","item":[{"name":"Create Customer","id":"8bd44644-dd9d-4101-afaa-ed44a4252787","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{APIKey}}","type":"text"},{"key":"BrandId","value":"your-brand-id","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"fullName\": \"Reese Nakamura\",\n \"emailId\": \"user7734@example.com\",\n \"dateOfBirth\": \"1994-06-03\",\n \"phoneNo\": \"+91 797639082\",\n \"city\": \"Riverton\",\n \"stateCode\": \"RJ\",\n \"zipCode\": \"302018\",\n \"address\": \"24 Sample Avenue\",\n \"country\": \"IN\",\n \"merchantCustomerId\": \"user8912@example.com\",\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":"https://api.paysecure.net/api/v1/customer","description":"

OVERIEW

The createCustomer API allows merchants to create a customer profile on Paysecure when a user visits their website, facilitating a seamless payment experience by pre-filling the customer's details, on the Paysecure 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	user8912@example.com
fullName	String	Yes	Full name of the customer.	Reese Nakamura
emailId	String	Yes	Email address of the customer.	user3456@example.com
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.	Riverton
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.	24 Sample Avenue
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 Paysecure API with the customer's details.
\n
Customer ID generation: Paysecure 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 Paysecure 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: PaySecure 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

OVERIEW

The create Purchase API is designed to initiate a payment for a merchant who doesn't want to use Paysecure's cashier and wants to keep everything S2S.

The merchant doesn't need to create a customer in this case and directly needs to call the purchase API and then call the S2S API after that.

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

Parameter	Notes
payment_type	Mandatory. To be passed as \"mandate\".
paymentMethod	Mandatory. Example: MASTER, VISA
brand_id	Mandatory. Your brand id.
mandate	Mandatory. This object is mandatory for mandate flow
mandate.mandate_max_amount	Conditional. Mandatory when amount_variability is \"Variable\". 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	Optional Specifies the time when the mandate will start.
mandate.end_date	Optional Specifies the time when the mandate will end. (If not passed then indefinite)
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.

","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"09aaa678-42b8-46d4-ab7e-18743a94fac9","id":"09aaa678-42b8-46d4-ab7e-18743a94fac9","name":"Recurring Payments","type":"folder"}},"urlObject":{"path":["purchases"],"host":["https://api.paysecure.net/api/v1"],"query":[],"variable":[]}},"response":[{"id":"33523e92-37f5-4548-85cb-83f6963f0236","name":"Success","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{APIKey}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"client\": {\n \"email\": \"user3069@example.com\",\n \"country\": \"GB\",\n \"city\": \"Milford\",\n \"stateCode\": \"LO\",\n \"street_address\": \"90 Fixture Close\",\n \"zip_code\": \"234567\",\n \"full_name\": \"Reese Nakamura\",\n \"phone\": \"+44 07932665877\" // optional\n },\n \"purchase\": {\n \"currency\": \"USD\",\n \"products\": [\n {\n \"name\": \"product name\",\n \"price\": \"1\"\n }\n ]\n },\n \"merchantRef\": \"your-merchant-ref\", // optional\n \"paymentMethod\": \"MASTER\",\n \"brand_id\": \"your-brand-id\",\n \"payment_type\": \"mandate\",\n \"mandate\": {\n \"mandate_max_amount\": \"5000\", // Conditional\n \"amount_variability\": \"Fixed\", // optional\n \"start_date\": \"1598965200\", // optional\n \"end_date\": \"1914141600\", // optional\n \"frequency\": \"MONTHLY\", // mandatory\n \"rule\": \"on\", // optional\n \"value\": 1 // conditional\n },\n \"success_redirect\": \"https://your.success.redirect.com\", // mandatory\n \"pending_redirect\": \"https://your.pending.redirect.com\", // mandatory\n \"failure_redirect\": \"https://your.failure.redirect.com\", // mandatory\n \"success_callback\": \"https://your.success.callback.com\", // mandatory\n \"failure_callback\": \"https://your.failure.callback.com\" // mandatory\n}","options":{"raw":{"language":"json"}}},"url":"https://api.paysecure.net/api/v1/purchases"},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[{"key":"Date","value":"Mon, 30 Mar 2026 12:23:05 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":"668295f8-5770-4492-8318-01e2d1c09664"},{"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 b4011ac432e4f034161d5cccc8a4ac80.cloudfront.net (CloudFront)"},{"key":"X-Amz-Cf-Pop","value":"IAD61-P10"},{"key":"X-Amz-Cf-Id","value":"46KSjvCpG3Uv-3pzVOVedkJkacP2LZAI0m9ByboJ-rzLxQkfNNycJA=="},{"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=1p%2FF34n2kiKpiE2WnCntzJPGKU28mcMx4pIFZ9F6UFZqmnoSxQEqZQ44WCu6SsOg5eYfqPqYGdhXxgBbuVLNwP5Xyc2OqoL1lTauqUylCkCPuOXJ1VRrvygGOmX9Yslw6BqJ\"}]}"},{"key":"CF-RAY","value":"9e471560fd16d6d5-IAD"}],"cookie":[],"responseTime":null,"body":"{\n \"purchaseId\": \"69f8d167db7ca561ab27c484\",\n \"client\": {\n \"customerId\": \"NA\",\n \"email\": \"user5797@example.com\",\n \"street_address\": \"90 Fixture Close\",\n \"country\": \"GB\",\n \"city\": \"Milford\",\n \"zip_code\": \"234567\",\n \"cc\": [],\n \"bcc\": [],\n \"stateCode\": \"LO\"\n },\n \"updated_on\": 1777914215,\n \"type\": \"purchase\",\n \"paymentMethod\": \"VISA\",\n \"amountUnit\": \"MAJOR\",\n \"errorMsg\": \"\",\n \"errorCode\": \"NA\",\n \"force_recurring\": false,\n \"created_on\": 1777914215,\n \"merchantRef\": \"69f8d167db7ca561ab27c484\",\n \"purchase\": {\n \"currency\": \"USD\",\n \"products\": [\n {\n \"name\": \"product name\",\n \"quantity\": 1.0,\n \"price\": 5.0,\n \"discount\": 0,\n \"tax_percent\": \"0.00\"\n }\n ],\n \"total\": 5.0,\n \"requestAmount\": 5.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\": \"CREATED\",\n \"status_history\": [\n {\n \"status\": \"created\",\n \"timestamp\": 1777914215\n }\n ],\n \"is_test\": false,\n \"brand_id\": \"your-brand-id\",\n \"send_receipt\": false,\n \"is_recurring_token\": false,\n \"skip_capture\": false,\n \"reference_generated\": \"PS1736\",\n \"issued\": \"2026-05-04\",\n \"due\": 1777914215,\n \"refund_upto\": 0,\n \"cc_descriptor\": \"\",\n \"fraudScore\": \"NA\",\n \"trustScore\": \"NA\",\n \"extraFee\": \"0\",\n \"totalRefunded\": 0.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://your.success.redirect.com\",\n \"failure_redirect\": \"https://your.failure.redirect.com\",\n \"pending_redirect\": \"https://your.pending.redirect.com\",\n \"cancel_redirect\": \"\",\n \"success_callback\": \"https://your.success.callback.com\",\n \"failure_callback\": \"https://your.failure.callback.com\",\n \"platform\": \"API\",\n \"created_from_ip\": \"2406:b400:75:22bd:b48e:a33e:4e26:a542\",\n \"checkout_url\": \"https://api.paysecure.net/payments/16550278d7e374e53048b72dcf253a3a/\",\n \"direct_post_url\": \"https://api.paysecure.net/api/v1/p/69f8d167db7ca561ab27c484/\",\n \"payoutProcess\": false,\n \"payment_type\": \"mandate\",\n \"mandate\": {\n \"frequency\": \"ASPRESENTED\",\n \"rule\": \"on\",\n \"value\": null,\n \"mandate_max_amount\": null,\n \"amount_variability\": \"Variable\",\n \"end_date\": null,\n \"mandate_status\": \"CREATED\",\n \"mandate_id\": \"69f8d167db7ca561ab27c484\"\n }\n}"}],"_postman_id":"68ace5f7-edbb-4d91-b4fb-7ae9fc882443"},{"name":"S2S API","id":"420d35db-9107-4522-a12e-a69bb8fac430","protocolProfileBehavior":{"disableUrlEncoding":false,"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer {{APIKey}}","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\": \"203.0.113.121\",\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":"https://api.paysecure.net/api/v1/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- 203.0.113.42
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://api.paysecure.net/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

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 Paysecure 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 Paysecure handles the scheduling for the merchant on their behalf, then this API is not for them. The MIT transactions will be handled by Paysecure 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":"09aaa678-42b8-46d4-ab7e-18743a94fac9","id":"09aaa678-42b8-46d4-ab7e-18743a94fac9","name":"Recurring Payments","type":"folder"}},"urlObject":{"path":["purchases"],"host":["https://api.paysecure.net/api/v1"],"query":[],"variable":[]}},"response":[{"id":"1ff9aa13-d353-40b5-ad0e-a76f28fc0c1e","name":"Success","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{APIKey}}","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\", // optional\r\n \"email\": \"user4895@example.com\", // mandatory\r\n \"phone\": \"+44 07932665877\", // optional\r\n \"full_name\": \"Navya Alex\", // optional\r\n \"street_address\": \"90 Fixture Close\", // mandatory\r\n \"country\": \"GB\", // mandatory\r\n \"city\": \"Milford\", // mandatory\r\n \"zip_code\": \"234567\", // mandatory\r\n \"stateCode\": \"LO\" // mandatory\r\n },\r\n \"purchase\": {\r\n \"currency\": \"USD\",\r\n \"products\": [\r\n {\r\n \"name\": \"test\",\r\n \"price\": 1\r\n }\r\n ]\r\n },\r\n \"merchantRef\": \"{{your-merchant-ref}}\", // optional\r\n \"brand_id\": \"your-brand-id\", // mandatory\r\n \"payment_type\": \"recurring\", // mandatory\r\n \"mandate_id\": \"{{mandate-id}}\", // mandatory\r\n \"success_redirect\": \"https://your.success.redirect.com\", // mandatory\r\n \"pending_redirect\": \"https://your.pending.redirect.com\", // optional\r\n \"failure_redirect\": \"https://your.failure.redirect.com\", // mandatory\r\n \"success_callback\": \"https://your.success.callback.com\", // optional\r\n \"failure_callback\": \"https://your.failure.callback.com\" // optional\r\n}"},"url":"https://api.paysecure.net/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\": \"69f8d407ea26ad15715ebb85\",\n \"client\": {\n \"customerId\": \"NA\",\n \"email\": \"user5293@example.com\",\n \"date_of_birth\": \"1800-01-01\",\n \"street_address\": \"58 Testing Lane\",\n \"country\": \"CA\",\n \"city\": \"Milford\",\n \"zip_code\": \"68403\",\n \"cc\": [],\n \"bcc\": [],\n \"stateCode\": \"QLD\"\n },\n \"updated_on\": 1777914890,\n \"type\": \"purchase\",\n \"paymentMethod\": \"VISA\",\n \"amountUnit\": \"MAJOR\",\n \"errorMsg\": \"\",\n \"errorCode\": \"NA\",\n \"force_recurring\": false,\n \"created_on\": 1777914887,\n \"merchantRef\": \"69f8d407ea26ad15715ebb85\",\n \"purchase\": {\n \"currency\": \"USD\",\n \"products\": [\n {\n \"name\": \"gaming cards\",\n \"quantity\": 1.0,\n \"price\": 1.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 \"payment\": {\n \"is_outgoing\": false,\n \"payment_type\": \"PURCHASE\",\n \"amount\": 1.0,\n \"currency\": \"USD\",\n \"net_amount\": 1.0,\n \"fee_amount\": 0.0,\n \"pending_amount\": 0.0,\n \"pending_unfreeze_on\": null,\n \"description\": \"\",\n \"paid_on\": 1777914887,\n \"remote_paid_on\": 1777914887\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\": \"04\",\n \"amount\": 1.0,\n \"card_issuer\": \"REVOLUT BANK UAB\",\n \"masked_pan\": \"41659827****0724\",\n \"card_brand\": \"VISA\",\n \"card_issuer_country\": \"CH\",\n \"card_type\": \"DEBIT\",\n \"cardholder_name\": \"Casey Novak\",\n \"expiry_year\": \"31\"\n },\n \"country\": \"\",\n \"attempts\": [\n {\n \"client_ip\": \"203.0.113.57\",\n \"type\": \"execute\",\n \"payment_method\": \"VISA\",\n \"flow\": \"payform\",\n \"successful\": true,\n \"country\": \"CH\",\n \"processing_time\": 1777914887,\n \"extra\": {\n \"expiry_month\": \"04\",\n \"amount\": 1.0,\n \"card_issuer\": \"REVOLUT BANK UAB\",\n \"masked_pan\": \"41659827****0724\",\n \"card_brand\": \"VISA\",\n \"card_issuer_country\": \"CH\",\n \"card_type\": \"DEBIT\",\n \"cardholder_name\": \"Casey Novak\",\n \"expiry_year\": \"31\"\n }\n }\n ]\n },\n \"status\": \"PAID\",\n \"status_history\": [\n {\n \"status\": \"created\",\n \"timestamp\": 1777914887\n },\n {\n \"status\": \"pending_execute\",\n \"timestamp\": 1777914887\n },\n {\n \"status\": \"paid\",\n \"timestamp\": 1777914890\n }\n ],\n \"is_test\": false,\n \"brand_id\": \"your-brand-id\",\n \"send_receipt\": false,\n \"is_recurring_token\": false,\n \"skip_capture\": false,\n \"reference_generated\": \"PS1738\",\n \"issued\": \"2026-05-04\",\n \"due\": 1777914887,\n \"refund_upto\": 1780503290,\n \"cc_descriptor\": \"multitasklist\",\n \"fraudScore\": \"0\",\n \"trustScore\": \"0\",\n \"extraFee\": \"0\",\n \"totalRefunded\": 0.0,\n \"paidOn\": 1777914890,\n \"receivedAmt\": 0.0,\n \"taxAmount\": 0.0,\n \"surcharge\": 0.0,\n \"surchargeType\": \"\",\n \"sessionId\": \"\",\n \"refund_availability\": \"NONE\",\n \"refundable_amount\": 1.0,\n \"success_redirect\": \"https://your.success.redirect.com\",\n \"failure_redirect\": \"https://your.failure.redirect.com\",\n \"cancel_redirect\": \"\",\n \"success_callback\": \"https://your.success.callback.com\",\n \"failure_callback\": \"https://your.failure.callback.com\",\n \"platform\": \"API\",\n \"created_from_ip\": \"2406:b400:75:22bd:b48e:a33e:4e26:a542\",\n \"checkout_url\": \"https://api.paysecure.net/payments/0bc9c18600980b03a08fb030726428f8/\",\n \"direct_post_url\": \"https://api.paysecure.net/api/v1/p/69f8d407ea26ad15715ebb85/\",\n \"payoutProcess\": false,\n \"payment_type\": \"recurring\",\n \"mandate_id\": \"69f8cfa1db7ca561ab23fed2\"\n}"}],"_postman_id":"7da59c4b-c281-4c0b-9be5-5e5c5d98051c"},{"name":"Revoke Mandate","id":"51231dee-3bfa-421f-9a3a-b4e509cb87d4","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 {{APIKey}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"mandate_id\": \"685cc8515e3af922dd0e8c31\",\n \"command\": \"revoke\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.paysecure.net/api/v1/mandate","description":"

Required for cases where the Paysecure 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 Paysecure 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

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":"09aaa678-42b8-46d4-ab7e-18743a94fac9","id":"09aaa678-42b8-46d4-ab7e-18743a94fac9","name":"Recurring Payments","type":"folder"}},"urlObject":{"path":["purchases","{purchaseId}",""],"host":["https://api.paysecure.net/api/v1"],"query":[],"variable":[]}},"response":[{"id":"86f9a0f4-9934-47b9-bce7-b332b304dc9e","name":"Success","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer {{APIKey}}","type":"text"}],"url":"https://api.paysecure.net/api/v1/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\": \"user7402@example.com\",\n \"phone\": \"0557719399\",\n \"full_name\": \"Test user\",\n \"date_of_birth\": \"2004-07-12\",\n \"street_address\": \"90 Fixture Close\",\n \"country\": \"CA\",\n \"city\": \"Milford\",\n \"zip_code\": \"68403\",\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\": \"Rowan Sharma\",\n \"expiry_year\": \"29\"\n },\n \"country\": \"\",\n \"attempts\": [\n {\n \"client_ip\": \"203.0.113.100\",\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\": \"Rowan Sharma\",\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\": \"your-brand-id\",\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://your.success.redirect.com\",\n \"failure_redirect\": \"https://your.failure.redirect.com\",\n \"pending_redirect\": \"https://your.pending.redirect.com\",\n \"cancel_redirect\": \"\",\n \"success_callback\": \"https://your.success.callback.com\",\n \"failure_callback\": \"https://your.failure.callback.com\",\n \"platform\": \"API\",\n \"created_from_ip\": \"203.0.113.100\",\n \"checkout_url\": \"https://api.paysecure.net/payments/a28ed9974a22a4cbd5f2f49cc26cc334/\",\n \"direct_post_url\": \"https://api.paysecure.net/api/v1/p/6973ad04fa54ee2cf14f438c/\",\n \"payoutProcess\": false,\n \"payment_type\": \"internal recurring\",\n \"mandate_id\": \"696bc39a7bc779fac5201357\"\n}"}],"_postman_id":"b07092fe-992d-4ec3-a6c9-77aab34545c2"}],"id":"6e56d17a-6580-4378-9a86-ffcea4a544cd","_postman_id":"6e56d17a-6580-4378-9a86-ffcea4a544cd","description":"","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"09aaa678-42b8-46d4-ab7e-18743a94fac9","id":"09aaa678-42b8-46d4-ab7e-18743a94fac9","name":"Recurring Payments","type":"folder"}}}],"id":"09aaa678-42b8-46d4-ab7e-18743a94fac9","description":"

Overview

Recurring Payments allow merchants to automatically charge customers at predefined or flexible intervals without requiring the customer to re-enter payment details each time.

A Mandate represents the customer’s authorization that links their payment method to the merchant for future recurring charges. Once created, this mandate is used as a secure reference for all upcoming payments.

Instead of processing every transaction as a one-time payment, merchants rely on mandates to execute recurring debits in a frictionless and compliant manner.

The recurring payments may be initiated using Paysecure APIs as fixed/ non-fixed intervals based on your business use case.

The Paysecure 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) represents the initial setup of the recurring payment mandate, during which the customer is actively present on the merchant’s website or application (in-session flow).

In this flow, the merchant collects and submits the customer’s basic details along with the mandate configuration, including registration information, payment amount (fixed or variable, as applicable), and the scheduling frequency for recurring debits.

As part of the setup process, the customer must explicitly provide consent for the mandate. To authenticate and activate the mandate, the customer also completes a one-time payment using the selected payment method. Once this payment is successful, the mandate is registered and becomes eligible for future automated recurring transactions as per the defined schedule.

Purpose:

Capture customer payment details
\n
Authenticate the transaction (typically via 3D Secure)
\n
Collect customer consent for recurring billing
\n

Outcome:

A unique mandate_id is generated
\n
This mandate acts as a secure token for all future charges
\n

Use Case:

The customer signs up for a subscription and completes the first payment

2. Recurring Payments (MIT)

The Merchant Initiated Transaction (MIT) represents the execution phase of the recurring payment lifecycle. In this stage, payments are automatically triggered by the merchant’s system or through Paysecure’s built-in scheduler without requiring the customer to be actively present (off-session flow).

Once a mandate is successfully registered, merchants can initiate recurring debits as per the defined schedule and payment terms. These transactions are processed seamlessly using the customer’s authorized payment method.

The Paysecure Mandate module provides the following benefits:

Prebuilt support for a complete mandate registration experience using cards as the payment method
\n
Flexible mandate setup to match different business models and customer requirements
\n
Simplified execution of recurring payments through the Paysecure Dashboard with minimal operational effort
\n
Built-in analytics and reporting tools to monitor mandate sign-ups, payment performance, and renewals
\n

Purpose:

Debit the customer according to the defined schedule or usage

Mechanism:

Merchant (or Paysecure scheduler) sends payment requests using the mandate_id
\n
No card details are required again
\n
Usually bypasses 3D Secure
\n

Use Case:

Monthly subscription renewal payment.

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
- Paysecure Managed: You define the rules (start date, end date, frequency), and Paysecure 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 Paysecure’s end:

Merchant Managed Scheduling

After successfully registering the mandate, the merchant creates a subscription linked to the customer’s mandate. Based on the defined billing cycle and business logic, the merchant then triggers the Recurring Payments API according to their own payment schedule to execute automated debits.

This approach allows merchants to maintain full control over when and how recurring charges are initiated.

Merchant tracks payment due dates
\n
Merchant triggers recurring API calls manually
\n

Best for:

Custom billing logic or internal scheduling systems.

Paysecure Managed Scheduling

In this model, the merchant creates a subscription within the Paysecure system and submits the recurring payment schedule, including billing frequency and timing. Based on the provided configuration, Paysecure automatically manages the execution of recurring transactions as per the defined schedule.

This removes the need for merchants to manually trigger each payment, ensuring consistent and timely debits while maintaining a fully automated recurring billing process

Merchant defines payment rules (start date, frequency, end date)
\n
Paysecure automatically executes recurring charges
\n

Best for:

Standard subscription models with minimal operational overhead.

Prerequisites

Before starting the mandate integration, merchants must ensure that the required configurations are enabled both at the PSP level and within the Paysecure system.

Mandate Enablement at PSP Level

Merchants must enable mandate-related features on their respective PSP (Payment Service Provider) dashboard. This ensures that the PSP supports recurring and mandate-based transactions.

Configuration on the Paysecure Dashboard

For whitelabel merchants or those using Paysecure’s whitelabel solution, the mandate support toggle must be enabled within the MID settings of the PSP configuration. This allows Paysecure to recognize and route mandate transactions correctly.
\n
For merchants directly onboarded with Paysecure, this configuration is managed by the Paysecure team. Merchants should coordinate with their account manager to ensure mandate enablement is completed.
\n

Fetches a paginated list of transactions. This endpoint is optimized for high-volume retrieval and returns a summary view of each transaction (ID and Status).

Important Path Params to consider:

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

Fields	Description
page_no	The index number of the page to retrieve. Zero-based indexing: The first page is 0, the second is 1, etc. Example: To get the third page of results, send page_no=2
page_size	The number of records to return per page. Minimum: 1 Maximum: 100 (or whatever your API limit is). Usage: A larger page_size reduces the number of API calls but increases payload size.
transaction_id	If you want to filter with a specific transaction id. Multiple ids are not supported. If a transaction id is passed, it has the highest priority. All the below mentioned filters are ommitted.
start_date	If you want to filter between 2 dates. Format: 2026-01-07 16:12:00 +05:30 Base timezone is in UTC.
end_date	If you want to filter between 2 dates Format: 2026-01-07 16:12:00 +05:30 Base timezone is in UTC.
last_updated_start	If you want to filter with the last updated date of a transaction. Format: 2026-01-07 16:12:00 +05:30 Base timezone is in UTC.
last_updated_end	If you want to filter with the last updated date of a transaction. Format: 2026-01-07 16:12:00 +05:30 Base timezone is in UTC.
customer_id	If you want to filter with a specific customer id. Multiple ids are not supported.
status	If you want to filter with the status.
currency	If you want to filter with the currency.

","urlObject":{"path":["external","transactions","list"],"host":["https://api.paysecure.net/api/v1"],"query":[{"key":"page_no","value":"1"},{"key":"page_size","value":"10"},{"key":"transaction_id","value":"69d4ba22465443878a0045ba"},{"key":"start_date","value":"2025-10-29%2000%3A00%3A00%20+05%3A30"},{"key":"end_date","value":"2026-04-23%2000%3A00%3A00%20+05%3A30"},{"key":"last_updated_start","value":"2026-01-07%2016%3A12%3A00%20+05%3A30"},{"key":"last_updated_end","value":"2026-12-07%2016%3A12%3A00%20+05%3A30"},{"key":"customer_id","value":"NA"},{"key":"status","value":"paid"},{"key":"currency","value":"USD"},{"key":"is_sandbox","value":"true"}],"variable":[]}},"response":[{"id":"0910f5b1-32ff-445e-957c-dac0bd9ad8b6","name":"Success","originalRequest":{"method":"GET","header":[{"key":"BrandId","value":"your-brand-id"},{"key":"Authorization","value":"Bearer {{APIKey}}"}],"url":{"raw":"https://api.paysecure.net/api/v1/external/transactions/list?page_no=1&page_size=10&start_date=2025-10-29%2000%3A00%3A00%20+05%3A30&end_date=2026-04-23%2000%3A00%3A00%20+05%3A30&last_updated_start=2026-01-07%2016%3A12%3A00%20+05%3A30&last_updated_end=2026-12-07%2016%3A12%3A00%20+05%3A30&customer_id=NA&status=paid¤cy=USD&is_sandbox=true","host":["https://api.paysecure.net/api/v1"],"path":["external","transactions","list"],"query":[{"key":"page_no","value":"1"},{"key":"page_size","value":"10"},{"key":"transaction_id","value":"69d4ba22465443878a0045ba","disabled":true},{"key":"start_date","value":"2025-10-29%2000%3A00%3A00%20+05%3A30"},{"key":"end_date","value":"2026-04-23%2000%3A00%3A00%20+05%3A30"},{"key":"last_updated_start","value":"2026-01-07%2016%3A12%3A00%20+05%3A30"},{"key":"last_updated_end","value":"2026-12-07%2016%3A12%3A00%20+05%3A30"},{"key":"customer_id","value":"NA"},{"key":"status","value":"paid"},{"key":"currency","value":"USD"},{"key":"is_sandbox","value":"true"}]}},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[{"key":"Date","value":"Sun, 19 Apr 2026 14:11: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":"c2111eb2-6314-4f0b-b546-4ae3ee123a44"},{"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 6a91ddfdf36644f1344da228258d9082.cloudfront.net (CloudFront)"},{"key":"X-Amz-Cf-Pop","value":"IAD61-P10"},{"key":"X-Amz-Cf-Id","value":"lKDk7cJHKNy2cOdf_AWXk3GlUJdWC5slaGWaVfgUf1Fn0XXm7T7D7Q=="},{"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=YLhXcnCfKpMy2KQEcmek7bxnkI2lT3%2F5IQ8opo9ZpZ4E852qZoWIFsjJ%2BcmGZfTO7S1rWYnB3uzuGwMYwevQ%2F47w%2Bm6u51jrIfjuG3TDh08KGeWKRbR92ItXRYPoh1CgVmja\"}]}"},{"key":"CF-RAY","value":"9eec7f31f973c9b7-IAD"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"content\": [\n {\n \"transaction_id\": \"69e2146828bea6ca2e31bc85\",\n \"status\": \"paid\"\n },\n {\n \"transaction_id\": \"69e20fd928bea6ca2e31b17c\",\n \"status\": \"paid\"\n }\n ],\n \"currentPage\": 1,\n \"pageSize\": 2,\n \"totalElements\": 95,\n \"totalPages\": 48,\n \"first\": true,\n \"last\": false,\n \"hasNext\": true,\n \"hasPrevious\": false\n }\n}"}],"_postman_id":"3b993501-7ca3-4988-b3d8-ccca454d07b1"},{"name":"Get Detailed Transaction Details","id":"539b29f9-d784-4ad4-81cb-e8934e7cad55","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"BrandId","value":"your-brand-id"},{"key":"Authorization","value":"Bearer {{APIKey}}"}],"url":"https://api.paysecure.net/api/v1/external/transactions/data/69e20fd928bea6ca2e31b17c?page_no=1&page_size=10&include_subtransactions=true","description":"

Retrieves the complete details for a specific transaction. This includes customer info, payment method details, bank response codes, and hierarchy metadata (parent/child transactions).

Additional query parameters for this usecase:

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

Parameter	Notes
include_subtransactions	Mandatory. Possible Values: true/false If true, includes child transactions (e.g., recurring payments).

","urlObject":{"path":["external","transactions","data","69e20fd928bea6ca2e31b17c"],"host":["https://api.paysecure.net/api/v1"],"query":[{"key":"page_no","value":"1"},{"key":"page_size","value":"10"},{"key":"include_subtransactions","value":"true"}],"variable":[]}},"response":[{"id":"caf45845-f808-4f2a-9dc5-d0564d6555d2","name":"Success","originalRequest":{"method":"GET","header":[{"key":"BrandId","value":"your-brand-id"},{"key":"Authorization","value":"Bearer {{APIKey}}"}],"url":{"raw":"https://api.paysecure.net/api/v1/external/transactions/data/69e20fd928bea6ca2e31b17c?page_no=1&page_size=10&include_subtransactions=true","host":["https://api.paysecure.net/api/v1"],"path":["external","transactions","data","69e20fd928bea6ca2e31b17c"],"query":[{"key":"page_no","value":"1"},{"key":"page_size","value":"10"},{"key":"include_subtransactions","value":"true"}]}},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[{"key":"Date","value":"Sun, 19 Apr 2026 14:13:09 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Nel","value":"{\"report_to\":\"cf-nel\",\"success_fraction\":0.0,\"max_age\":604800}"},{"key":"X-Frame-Options","value":"ALLOW-FROM *"},{"key":"Referrer-Policy","value":"no-referrer"},{"key":"x-session-id","value":"3d9fb1d1-b30f-4c3e-a76f-6956e3731ad3"},{"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 64d4305f6a0418824e90908ac490184e.cloudfront.net (CloudFront)"},{"key":"X-Amz-Cf-Pop","value":"IAD61-P10"},{"key":"X-Amz-Cf-Id","value":"COt7k0tEcVGSOSy8pTkHoOqGoG1lSgC9qz8baoKbgmPkAh5dq0GNjQ=="},{"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=hn0q1Q9Cqa9onXwzy%2F1Qeq8u4RTGt3q%2BZNFW29weO%2BOmtABh6y8XLnAH9%2FytCQEEOmNzdnvM0oPcQruiJvYqQQShCKOndiMKUnEksUPM9I9UMph4qP7s1ognTK%2BBhheXvIwO\"}]}"},{"key":"CF-RAY","value":"9eec821e0f4b172c-IAD"}],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\n \"data\": {\n \"transaction_id\": \"69e20fd928bea6ca2e31b17c\",\n \"merchant_reference\": \"69e20fd928bea6ca2e31b17c\",\n \"customer_id\": \"NA\",\n \"amount\": 1.0,\n \"currency\": \"USD\",\n \"status\": \"paid\",\n \"session_id\": \"\",\n \"email\": \"user1661@example.com\",\n \"merchant_name\": \"globex12merch\",\n \"payment_method\": \"MASTER\",\n \"payment_flow\": \"payform\",\n \"issuing_bank\": \"PUBLIC BANK BERHAD\",\n \"created_at\": \"2026-04-17T10:47:53Z\",\n \"error_reason\": \"Transaction succeeded-APPROVED\",\n \"last_updated_at\": \"2026-04-17T10:49:14Z\",\n \"transaction_type\": \"parent\",\n \"fees\": [\n {\n \"type\": \"mdr\",\n \"amount\": 0.00,\n \"currency\": \"USD\"\n },\n {\n \"type\": \"decline_fee\",\n \"amount\": 0,\n \"currency\": \"USD\"\n },\n {\n \"type\": \"transaction_fee\",\n \"amount\": 0.1,\n \"currency\": \"USD\"\n },\n {\n \"type\": \"fraud_refund_fee\",\n \"amount\": 0,\n \"currency\": \"USD\"\n },\n {\n \"type\": \"refund_fee\",\n \"amount\": 0,\n \"currency\": \"USD\"\n },\n {\n \"type\": \"chargeback_fee\",\n \"amount\": 0,\n \"currency\": \"USD\"\n },\n {\n \"type\": \"extra_fee\",\n \"amount\": 0,\n \"currency\": \"USD\"\n }\n ],\n \"metadata\": {\n \"has_subtransactions\": false,\n \"total_subtransactions\": 0,\n \"transaction_hierarchy_level\": \"parent\"\n }\n }\n}"}],"_postman_id":"539b29f9-d784-4ad4-81cb-e8934e7cad55"}],"id":"2749a63c-474d-41bb-875c-f92b6683d345","description":"

Overview

The Transaction Reporting APIs allow merchants to retrieve detailed logs of their payment activity programmatically. This is useful for:

Reconciliation: Matching Paysecure records with your internal order system.
\n
Audit Trails: Tracking the status history of specific transactions.
\n
Data Export: Pulling transaction data into your own analytics tools.
\n

There are two primary endpoints:

List Transactions: Retrieves a paginated list of all transactions for a specific Brand ID.
\n
Get Transaction Details: Retrieves the full data payload for a single transaction ID, including metadata and sub-transaction details.
\n

\n","_postman_id":"2749a63c-474d-41bb-875c-f92b6683d345"},{"name":"Network Tokenisation","item":[{"name":"Merchant Configuration","item":[],"id":"0e79c7a0-501a-4fcb-9766-4a3db87f1dd2","description":"

Before you can use network tokenisation in your payment flow, the feature must be enabled and configured on your merchant account. This section walks through the setup steps in the Paysecure Dashboard.

Enabling Network Tokenisation

Network tokenisation requires activation at the merchant level. Follow these steps in the Paysecure Dashboard:

Log in to your Paysecure merchant account.
\n
Navigate to Merchant Details → Allowed Services.
\n
Enable “Allow Network Token” to activate tokenisation for your account.
\n

Admin Activation Required
Network tokenisation must first be enabled at the platform level by your Paysecure account administrator. If you do not see the “Allow Network Token” option in your dashboard, contact your Paysecure account manager to request activation.

\n\n

Paysecure Token Service Setup

After enabling network tokenisation, configure the Paysecure Token Service with your merchant details:

In the Paysecure Dashboard, navigate to Global Settings → Paysecure Token Service.
\n
Fill in all the required fields accurately.
\n
Enter your Category Code — this represents your merchant business type code (MCC).
\n
Click Save.
\n
After saving, verify that the status shows as Pending (visible in the top-right corner of the page).
\n
The status will automatically update to Active or Error once your token profile is created.
\n

\n\n

Status Update Timing: The status update from Pending to Active may take up to 1 hour. Do not attempt to use tokenisation APIs until the status shows Active. If the status changes to Error, contact your Paysecure account manager for resolution.

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

Status	Meaning	Action Required
Pending	Your token service profile has been submitted and is being provisioned.	Wait for the status to update. This may take up to 1 hour.
Active	Token service is live and ready to use. You can now process tokenised transactions.	None — you are ready to integrate.
Error	There was a problem creating your token profile.	Contact your Paysecure account manager to resolve the issue.

List Saved Cards

Retrieve all saved card tokens for a given customer. Returns the last 4 digits of each card and its associated token_reference.

Use this API to display saved cards to the customer for selection before initiating a payment via the S2S API.

Query Parameters

\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
`customerId`	string	Yes	Unique identifier for the customer. Must be URL-encoded if it contains special characters. Email addresses are case-sensitive.
`brandId`	string	Yes	Brand id of the merchant

Response Fields

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

Field	Type	Description
`card_last_four`	string	Last 4 digits of the stored card. Display to the customer for card selection.
`token_reference`	string	Unique reference for this saved card. Pass this in the S2S payment request or Delete Token request. Do not display to the customer.

Notes

The token_reference does not expire. It remains valid as long as the saved card has not been deleted.
\n
Show saved cards to the customer using card_last_four alongside a card brand icon (Visa / Mastercard).
\n
The token_reference should only be stored and used server-side.
\n

Display Tip

Show saved cards using cardlast4 alongside a card brand icon (Visa / Mastercard).
The token_reference should only be stored and used server-side.

\n","urlObject":{"protocol":"https","path":["listSavedCards"],"host":["api","paysecure","net"],"query":[],"variable":[]}},"response":[{"id":"c5d47652-5f6d-44fc-a310-ad2d53e5fad0","name":"Success","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer {{APIKey}}","type":"text"}],"url":{"raw":"https://api.paysecure.net/listSavedCards?customerId=user7556@example.com&brandId=fceb4dea-163c-492c-a9e6-beedd8539da8","protocol":"https","host":["api","paysecure","net"],"path":["listSavedCards"],"query":[{"key":"customerId","value":"user7556@example.com"},{"key":"brandId","value":"fceb4dea-163c-492c-a9e6-beedd8539da8"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"card_last_four\": \"1003\",\n \"token_reference\": \"token_2bcf691f0f0347d6bcb38118d1bb31d5\"\n },\n {\n \"card_last_four\": \"6006\",\n \"token_reference\": \"token_e17dd98c66c14b37afaa62bd4770f915\"\n },\n {\n \"card_last_four\": \"6916\",\n \"token_reference\": \"token_7178bb7208614544a285656da38ae5ac\"\n }\n]"}],"_postman_id":"3ee86fb5-136a-4140-bb02-4c15ff3a56c0"},{"name":"Purchase","id":"edcecdb0-fea9-4559-93ce-6678e3809ad8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer {{APIKey}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"client\": {\n \"email\": \"user6597@example.com\",\n \"country\": \"IN\",\n \"city\": \"Riverton\",\n \"stateCode\": \"RJ\",\n \"street_address\": \"1 Example Street\",\n \"zip_code\": \"302001\",\n \"phone\": \"9999999999\"\n },\n \"purchase\": {\n \"currency\": \"USD\",\n \"products\": [\n {\n \"name\": \"Product Name\",\n \"price\": \"10.00\"\n }\n ]\n },\n \"brand_id\": \"your-brand-id\",\n \"success_redirect\": \"https://your.success.redirect.com\",\n \"failure_redirect\": \"https://your.failure.redirect.com\",\n \"pending_redirect\": \"https://your.pending.redirect.com\",\n \"success_callback\": \"https://your.success.callback.com\",\n \"failure_callback\": \"https://your.failure.callback.com\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.paysecure.net/api/v1/api/v1/purchases","description":"

Purchase

Initiate a payment transaction. This is the standard Paysecure Purchase API.

When a customer completes the purchase on the Paysecure checkout page and opts to save their card, Paysecure provisions a network token in the background and generates a token_reference linked to the customer.

Mandatory 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

Parameter	Type	Description
`client.email`	string	Customer's email address. Please send it in smallcase
`client.city`	string	Customer's city.
`client.country`	string	ISO-3166 Alpha-2 country code, uppercase (e.g., IN, US, SG).
`client.stateCode`	string	State code, uppercase (e.g., RJ, CA, AL).
`client.street_address`	string	Customer's street address.
`client.zip_code`	string	Postal / ZIP code. US format: NNNNN or NNNNN-NNNN.
`purchase.currency`	string	ISO 4217 currency code (e.g., USD, EUR). Must be enabled on your account.
`purchase.products`	array	Array of product objects with `name` and `price`.
`brand_id`	string	Your Paysecure Brand ID from Dashboard.
`success_redirect`	string	URL to redirect customer after successful payment.
`failure_redirect`	string	URL to redirect customer after failed payment.

Optional 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

Parameter	Type	Description
`pending_redirect`	string	URL to redirect when payment is pending.
`success_callback`	string	Server-to-server webhook URL for success.
`failure_callback`	string	Server-to-server webhook URL for failure.
`merchantRef`	string	Your internal reference for this transaction.
`paymentMethod`	string	Pre-select payment method (e.g., VISA).
`client.phone`	string	Customer's phone number.

Key Response Fields

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

Field	Description
`id`	Unique purchase ID.
`checkout_url`	Redirect customer here to complete payment. Card saving happens during this step.
`direct_post_url`	URL for S2S payment submission.
`status`	Purchase status. Initially \"created\".

Network Tokenisation & Card Saving

When the customer completes payment via checkout_url and opts to save their card, Paysecure provisions a network token. The token_reference is then available via the List Saved Cards API.

\n","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"06073ed3-ffd7-4e56-a80c-f7d47269716d","id":"06073ed3-ffd7-4e56-a80c-f7d47269716d","name":"APIs","type":"folder"}},"urlObject":{"path":["api","v1","purchases"],"host":["https://api.paysecure.net/api/v1"],"query":[],"variable":[]}},"response":[{"id":"8978edc0-1b5e-4ef5-b1b8-cc9d03100332","name":"Success","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer {{APIKey}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"client\": {\n \"email\": \"user6597@example.com\",\n \"country\": \"IN\",\n \"city\": \"Riverton\",\n \"stateCode\": \"RJ\",\n \"street_address\": \"1 Example Street\",\n \"zip_code\": \"302001\",\n \"phone\": \"9999999999\"\n },\n \"purchase\": {\n \"currency\": \"USD\",\n \"products\": [\n {\n \"name\": \"Product Name\",\n \"price\": \"10.00\"\n }\n ]\n },\n \"brand_id\": \"your-brand-id\",\n \"success_redirect\": \"https://your.success.redirect.com\",\n \"failure_redirect\": \"https://your.failure.redirect.com\",\n \"pending_redirect\": \"https://your.pending.redirect.com\",\n \"success_callback\": \"https://your.success.callback.com\",\n \"failure_callback\": \"https://your.failure.callback.com\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.paysecure.net/api/v1/api/v1/purchases"},"status":"Accepted","code":202,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"purchaseId\": \"69b32e42250ac73495aefd50\",\n \"client\": {\n \"customerId\": \"NA\",\n \"email\": \"user9831@example.com\",\n \"full_name\": \"Casey Novak\",\n \"date_of_birth\": \"1800-01-01\",\n \"street_address\": \"58 Testing Lane\",\n \"country\": \"BR\",\n \"city\": \"Westbury\",\n \"zip_code\": \"110001\",\n \"cc\": [],\n \"bcc\": [],\n \"stateCode\": \"DL\"\n },\n \"updated_on\": 1773350466,\n \"type\": \"purchase\",\n \"paymentMethod\": \"MASTER\",\n \"amountUnit\": \"MAJOR\",\n \"errorMsg\": \"\",\n \"errorCode\": \"NA\",\n \"force_recurring\": false,\n \"created_on\": 1773350466,\n \"merchantRef\": \"69b32e42250ac73495aefd50\",\n \"purchase\": {\n \"currency\": \"USD\",\n \"products\": [\n {\n \"name\": \"e-commerce\",\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\": \"brand\",\n \"brand_name\": \"brand\",\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\": 1773350466\n }\n ],\n \"is_test\": false,\n \"brand_id\": \"your-brand-id\",\n \"send_receipt\": false,\n \"is_recurring_token\": false,\n \"skip_capture\": false,\n \"reference_generated\": \"PS1060\",\n \"issued\": \"2026-03-12\",\n \"due\": 1773350466,\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://your.success.redirect.com\",\n \"failure_redirect\": \"https://your.failure.redirect.com\",\n \"pending_redirect\": \"https://your.pending.redirect.com\",\n \"cancel_redirect\": \"\",\n \"success_callback\": \"https://your.success.callback.com\",\n \"failure_callback\": \"https://your.failure.callback.com\",\n \"platform\": \"API\",\n \"created_from_ip\": \"203.0.113.33\",\n \"checkout_url\": \"https://api.paysecure.net/payments/1b73d31d178113798afa0157c8805ef0/\",\n \"direct_post_url\": \"https://api.paysecure.net/api/v1/p/69b32e42250ac73495aefd50/\",\n \"payoutProcess\": false\n}"}],"_postman_id":"edcecdb0-fea9-4559-93ce-6678e3809ad8"},{"name":"S2S Payment","id":"e1cbdabe-6a03-4069-a53f-dcfb80b0eb78","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer {{APIKey}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"Token_reference\": \"token_7178aa7208614544a285656da38ae5ac\",\n \"cvc\": \"791\",\n \"remember_card\": \"off\",\n \"remote_ip\": \"203.0.113.121\",\n \"user_agent\": \"Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/51.0.2704.103 Safari/537.36\",\n \"accept_header\": \"text/html\",\n \"language\": \"en-US\",\n \"java_enabled\": false,\n \"javascript_enabled\": true,\n \"color_depth\": 24,\n \"utc_offset\": 0,\n \"screen_width\": 1920,\n \"screen_height\": 1080\n}","options":{"raw":{"language":"json"}}},"url":"https://api.paysecure.net/api/v1/api/v1/p/{{brandId}}/?s2s=true","description":"

S2S Payment

Process a payment using a saved card's token_reference. Paysecure resolves the token reference to the underlying network token and processes the payment securely. If the selected MID does not accept tokens, Paysecure automatically falls back to the card number.

S2S Input Scenarios

The S2S API accepts different input types depending on the scenario:

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

Scenario	What to Send	What Paysecure Does
New card (first-time customer)	Full card details	Paysecure tokenises the card. If the MID supports tokens, the transaction uses the token; otherwise, the card number is used.
Returning customer (tokenised with Paysecure)	`token_reference` from List Saved Cards	Paysecure uses the stored token and generates a new cryptogram. Falls back to card number if MID doesn't accept tokens.

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

Field	Type	Required	Description
`token_reference`	string	Conditional	Token reference from List Saved Cards. Required when paying with a Paysecure-tokenised card.
`cvc`	string	Yes	Card CVC/CVV. Required even when `token_reference` is provided, for 3DS authentication.
`remember_card`	string	No	`\"on\"` to save card, `\"off\"` to skip. Use `\"off\"` with saved tokens.
`remote_ip`	string	Yes	Cardholder's IP address.
`user_agent`	string	Yes	Browser User-Agent string.
`accept_header`	string	Yes	Browser Accept header.
`language`	string	Yes	Browser language (e.g., `\"en-US\"`).
`java_enabled`	boolean	Yes	Java enabled in browser.
`javascript_enabled`	boolean	Yes	JavaScript enabled in browser.
`color_depth`	integer	Yes	Screen colour depth.
`utc_offset`	integer	Yes	UTC timezone offset (minutes).
`screen_width`	integer	Yes	Screen width (px).
`screen_height`	integer	Yes	Screen height (px).

Token Reference in Response

Scenario 1 (New card via S2S): token_reference returned in Check Status and Webhook.
\n
Scenario 2 (Existing token_reference): token_reference returned in response and Webhook.
\n

Important Notes

CVC is required even when using a token_reference.
\n
All browser fields are required for 3D Secure authentication.
\n
Response follows the standard Paysecure payment response format.
\n

Must be \"true\" for server-to-server requests.

\n","type":"text/plain"},"key":"s2s","value":"true"}],"variable":[]}},"response":[{"id":"67dad0c8-33c3-450b-aa65-f64b09e0c2ae","name":"Success","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer {{APIKey}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"Token_reference\": \"token_7178aa7208614544a285656da38ae5ac\",\n \"cvc\": \"791\",\n \"remember_card\": \"off\",\n \"remote_ip\": \"203.0.113.121\",\n \"user_agent\": \"Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/51.0.2704.103 Safari/537.36\",\n \"accept_header\": \"text/html\",\n \"language\": \"en-US\",\n \"java_enabled\": false,\n \"javascript_enabled\": true,\n \"color_depth\": 24,\n \"utc_offset\": 0,\n \"screen_width\": 1920,\n \"screen_height\": 1080\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://api.paysecure.net/api/v1/api/v1/p/6980e509b5e99e61f3bd4ccf/?s2s=true","host":["https://api.paysecure.net/api/v1"],"path":["api","v1","p","6980e509b5e99e61f3bd4ccf",""],"query":[{"key":"s2s","value":"true"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"pending\",\n \"callback_url\": \"https://api.paysecure.net/api/v1/payment/64b034ecc6dccf7d329d9eb3/\",\n \"method\": \"GET\"\n}"}],"_postman_id":"e1cbdabe-6a03-4069-a53f-dcfb80b0eb78"},{"name":"Delete Token","id":"e9d0231e-2e17-415b-aa81-8658a29e6318","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"Authorization","value":"Bearer {{APIKey}}","type":"text"}],"url":"https://api.paysecure.net/api/v1/tokens/v1/deleteToken/{{token_reference}}","description":"

Delete Token

Permanently delete a saved card and deactivate the associated network token. This action is irreversible.

Path Parameters

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

Parameter	Type	Required	Description
`token_reference`	string	Yes	The `token_reference` of the saved card to delete. Obtained from the List Saved Cards API.

Important Notes

Deleting a token is permanent. The token_reference can no longer be used for payments.
\n
The associated network token is deactivated with the card network.
\n
If the customer wants to pay with this card again, they will need to re-enter their card details.
\n

When to Delete

Customer explicitly requests removal of their saved card.
\n
GDPR or data retention compliance when a customer closes their account.
\n
Consider implementing a \"Remove Card\" option in your account management UI.
\n

Overview

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

Integration Steps

Enable OCT: Ensure \"Push to Card\" permissions are enabled for your merchant account in the Paysecure Merchant Portal.
\n
Collect Card Details: Use a secure method to collect the recipient's card number and expiry date or can you Paysecure'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:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\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	Required	Notes
client.email	Yes	The customer's email. Please send it in small case.
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.token_reference	Yes	Paysecure Token

Note:

If the merchant is not PCI DSS compliant then they will need to use our cashier and we will show the user all the saved cards for him/her. Based on the card chosen, Paysecure will pick up the token_reference from our Back end.

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

\n","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"06073ed3-ffd7-4e56-a80c-f7d47269716d","id":"06073ed3-ffd7-4e56-a80c-f7d47269716d","name":"APIs","type":"folder"}},"urlObject":{"path":["payout",""],"host":["https://api.paysecure.net/api/v1"],"query":[],"variable":[]}},"response":[{"id":"dee49abe-671d-44f5-a8ac-3c3c48995897","name":"Success","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer {{APIKey}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"client\": {\n \"email\": \"user3069@example.com\",\n \"country\": \"GB\",\n \"city\": \"Milford\",\n \"stateCode\": \"QLD\",\n \"full_name\": \"Reese Moreau\",\n \"street_address\": \"13 Documentation Way\",\n \"zip_code\": \"68403\",\n \"phone\": \"+44 9876543210\",\n \"gender\": \"M\",\n \"date_of_birth\": \"1970-07-10\"\n },\n \"purpose\": \"Testing cards payout\",\n \"currency\": \"GBP\",\n \"merchantRef\": \"YOUR ORDER ID\", // optional\n \"payoutMethod\": \"PAYOUT-CARDS\",\n \"amount\": 100.0,\n \"success_redirect\": \"https://your.success.redirect.com\",\n \"pending_redirect\": \"https://your.pending.redirect.com\",\n \"failure_redirect\": \"https://your.failure.redirect.com\",\n \"success_callback\": \"https://your.success.callback.com\",\n \"failure_callback\": \"https://your.failure.callback.com\",\n \"extraParam\": {\n \"token_reference\": \"token_ref\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://api.paysecure.net/api/v1/payout/"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"Text","header":[{"key":"Date","value":"Fri, 13 Mar 2026 00:01:17 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Nel","value":"{\"report_to\":\"cf-nel\",\"success_fraction\":0.0,\"max_age\":604800}"},{"key":"X-Frame-Options","value":"ALLOW-FROM *"},{"key":"Referrer-Policy","value":"no-referrer"},{"key":"x-session-id","value":"3ef27476-f274-4f6a-bb18-4c37e01d6dc2"},{"key":"Vary","value":"Origin"},{"key":"Vary","value":"Access-Control-Request-Method"},{"key":"Vary","value":"Access-Control-Request-Headers"},{"key":"Server","value":"cloudflare"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"0"},{"key":"Cache-Control","value":"no-cache, no-store, max-age=0, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Expires","value":"0"},{"key":"Strict-Transport-Security","value":"max-age=31536000 ; includeSubDomains"},{"key":"X-Cache","value":"Error from cloudfront"},{"key":"Via","value":"1.1 05a63efd5ebb043211ccf075f3a8aa68.cloudfront.net (CloudFront)"},{"key":"X-Amz-Cf-Pop","value":"IAD61-P10"},{"key":"X-Amz-Cf-Id","value":"Iw6KuTkxZqm0RH8GJOXAh7uLEPJ6wj8OJbaFWdN_qDx31b5TSinnIA=="},{"key":"cf-cache-status","value":"DYNAMIC"},{"key":"Report-To","value":"{\"group\":\"cf-nel\",\"max_age\":604800,\"endpoints\":[{\"url\":\"https://a.nel.cloudflare.com/report/v4?s=g%2FW8jRMDFXKvTeXNugr1sgR4%2FoTXfyEHsscr3hqeIr2aPhFEVlSs%2FGiTjFw09%2BReVDjxT2esg2Wg0fdBf4oD3snlEv4p1JkITe2l7oLC%2Bkg%3D\"}]}"},{"key":"CF-RAY","value":"9db6c366997196a2-IAD"}],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\n \"payoutId\": \"6977137755e0628e3600c562\",\n \"client\": {\n \"email\": \"user3069@example.com\",\n \"country\": \"GB\",\n \"city\": \"Milford\",\n \"stateCode\": \"QLD\",\n \"full_name\": \"Reese Moreau\",\n \"street_address\": \"13 Documentation Way\",\n \"zip_code\": \"68403\",\n \"phone\": \"+44 9876543210\",\n \"gender\": \"M\",\n \"date_of_birth\": \"1970-07-10\"\n },\n \"updated_on\": 1769411447,\n \"extraParam\": {\n \"token_reference\": \"token_ref\"\n },\n \"payoutMethod\": \"PAYOUT-CARDS\",\n \"amountUnit\": \"MAJOR\",\n \"amount\": 100.0,\n \"errorMsg\": \"\",\n \"purpose\": \"Testing cards payout\",\n \"created_on\": 1769411447,\n \"merchantRef\": \"YOUR ORDER ID\",\n \"status\": \"PAID\",\n \"status_history\": [\n {\n \"status\": \"created\",\n \"timestamp\": 1769411447\n },\n {\n \"status\": \"payout_in_process\",\n \"timestamp\": 1769411447\n },\n {\n \"status\": \"paid\",\n \"timestamp\": 1769411447\n },\n\n ],\n \"currency\": \"GBP\",\n \"extraFee\": \"0\",\n \"paymentOn\": 0,\n \"checkout_url\": \"https://api.paysecure.net/payout/092e59f94279a3742fa3715fe9a2112a/\",\n \"taxAmount\": 0.0,\n \"taxPercent\": 0.0,\n \"success_redirect\": \"https://your.success.redirect.com\",\n \"pending_redirect\": \"https://your.pending.redirect.com\",\n \"failure_redirect\": \"https://your.failure.redirect.com\",\n \"success_callback\": \"https://your.success.callback.com\",\n \"failure_callback\": \"https://your.failure.callback.com\"\n \"redirectType\": \"POST\",\n \"sessionId\": \"\",\n \"surcharge\": 0.0,\n \"surchargeType\": \"\",\n \"trxMethod\": \"CARDS\",\n \"success_callback\": \"https://your.success.callback.com\",\n \"failure_callback\": \"https://your.failure.callback.com\"\n}"}],"_postman_id":"25cb9c75-9116-4ca8-86b7-b436cbe2cc69"}],"id":"06073ed3-ffd7-4e56-a80c-f7d47269716d","description":"

Network tokenisation in Paysecure uses four APIs. Together they cover the complete flow: retrieving saved cards, initiating a purchase (with card saving), processing payments with saved tokens, and deleting tokens.

Q1: Do I need to change my existing integration to use network tokenisation?
No. If you already use the Paysecure Purchase API and the S2S API with token_reference, your integration is already compatible. You just need to enable and configure network tokenisation in your Dashboard (see Section 3).

Q2: What is a token_reference?
A token_reference (e.g., token_7178aa7208614544a285656da38aefac) is Paysecure’s internal identifier for a saved card. You use it to charge the saved card or delete it. It is not the card number or the network token — Paysecure manages those internally.

Q3: Does the token_reference expire?
No. The token_reference does not expire. It remains valid as long as the saved card has not been deleted.

Q4: What happens when a customer’s card expires or is replaced?

The card network automatically updates the data linked to the token. Your token_reference stays the same, and payments continue to work without action from you or the customer.

Q5: Is CVC required even when using a token_reference?
Yes. CVC is required even when a token_reference is provided. This is needed for 3D Secure authentication on customer-initiated transactions.

Q6: What if a card doesn’t support network tokenisation?
Paysecure handles this automatically. If a card is not eligible, or if the selected MID does not accept tokens, Paysecure falls back to the card number. The API response and flow remain the same.

Q7: How long does the token service setup take?
After saving your configuration in Dashboard → Global Settings → Paysecure Token Service, the status changes to Pending. It may take up to 1 hour to update to Active. Do not use tokenisation APIs until the status is Active.

Q8: Are email addresses case-sensitive for token lookup?
Yes. Email addresses are case-sensitive. Ensure consistent formatting (always lowercase) when creating and retrieving tokens to avoid duplicate or missing entries.

Q9: How do I delete a saved card?
Use the Delete Token API (DELETE /tokens/v1/deleteToken/{token_reference}). This permanently removes the card and deactivates the network token.

Q10: Is there an additional cost?
Pricing details are communicated by your Paysecure account manager. Some card networks offer reduced interchange fees for tokenised transactions, which may offset service costs.

Overview

Paysecure supports Network Tokenisation to help merchants process card payments with improved security, higher authorisation rates, and seamless card lifecycle management.

Network tokenisation works entirely behind the scenes. When a cardholder saves their card during a purchase, Paysecure securely provisions a network token and returns a token_reference. You use this reference for all future payments — you never handle actual card numbers or network tokens directly.

Benefits

Higher Approval Rates — Payments made with network tokens are recognised as more secure by issuers.
\n
Automatic Card Updates — Card replacements are handled silently by the card network.
\n
Stronger Security — Each token is merchant-specific and protected by a per-transaction cryptogram.
\n
Reduced PCI Burden — Store token_reference instead of card numbers.
\n
Zero Integration Overhead — Your existing API integration works as-is.
\n

API Flow

Network tokenisation is fully managed by Paysecure. The integration follows the standard Paysecure payment APIs:

The Merchant Flow

Call the List Saved Cards API to check if the customer has saved cards
\n
If no saved cards exist, initiate a new payment via the Purchase + S2S API
→ If the merchant opts to save the customer card, Paysecure provisions a network token
→ Customer completes payment
→ A token_reference is generated and linked to the customer and card
\n
For returning customers with saved cards:
→ Display saved cards using cardlast4 from List Saved Cards
→ Customer selects a card and provides CVC
→ Submit token_reference + CVC via the purchase + S2S API
\n
To remove a saved card, call the Delete Token API.
\n

Network tokenisation happens behind the scenes with no additional API calls and no changes to your existing flow.

List Saved Cards — Check if the customer has saved cards
\n
Purchase — Initiate a new payment (customer can save card during checkout)
\n
S2S Payment — Charge a saved card using token_reference
\n
Delete Token — Remove a saved card permanently
\n

Key Takeaway

You never see or handle the actual network token. Paysecure abstracts it entirely behind the token_reference. Your integration stays simple while your customers get the security and reliability benefits of network tokenisation.

Environments

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

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

Before integrating the pre-authorisation flow, ensure you have the following:

2.1 Account Setup

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

Requirement	Details
Paysecure Merchant Account	An active merchant account with API access enabled.
API Key	Your unique API key, available from Dashboard → API Keys.
Brand ID	Your brand identifier, found in Dashboard → Account Settings.
Webhook URL (Recommended)	A publicly accessible HTTPS endpoint to receive transaction status updates.

2.2 Environments

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

Environment	Base URL	Notes
Sandbox	https://api.paysecure.net/api/v1	Set the Sandbox flag to true in your merchant account.
Production	https://api.paysecure.net/api/v1	Live transactions. Ensure KYB verification is complete.

2.3 Authentication

All API requests must include your API key in the request header.
Paysecure uses bearer token authentication.

Authorization: Bearer {your_api_key}

Content-Type: application/json

Important: Never expose your API key in client-side code or public repositories. All API calls must be made server-to-server.

The pre-authorisation and capture flow involves three distinct stages. Below is a high-level summary of each path the transaction can follow after authorisation.

3.1 Flow Summary

Step 1 - The merchant sends a pre-authorisation request to reserve funds on the customer’s card. If successful, the transaction enters an AUTHORISED state.

Step 2a (Capture Path) - The merchant sends a capture request for the full or partial authorised amount. On success, the transaction moves to CAPTURED and funds are settled.

Step 2b (Void Path) - If the merchant no longer needs to collect the payment, they send a void request. The hold is released and the transaction moves to VOIDED.

3.2 State Transition Diagram

The following diagram describes all possible states:

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

From State	Action	To State (Terminal)	Description
CREATED	Pre-Authorise	PREAUTHORIZED	Funds are held on the customer’s card.
PREAUTHORIZED	Capture (Full)	PAID	Full authorised amount is settled.
PREAUTHORIZED	Capture (Partial)	PARTIALLY_CAPTURED	Part of the authorised amount is settled; remainder released.
PREAUTHORIZED	Void	CANCELLED	Hold is released. No funds are collected.
PREAUTHORIZED	(Expiry)	EXPIRED	Authorisation window elapsed without capture. Funds auto-released. 30 days default.
PAID	Refund	REFUNDED	Post-capture return of funds (separate API).
PARTIALLY_CAPTURED	Refund	PARTIALLY_REFUNDED	Post partial capture return of funds (separate API).

ℹ️ Note

Once a transaction is PAID or VOIDED, it cannot be reversed through this flow. Use the Refund API for post-capture reversals.

3.3 Authorisation Validity Periods

Card networks enforce maximum hold periods. If you do not capture within the validity window, the authorisation expires automatically and funds are released.

\n\n\n\n\n\n\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 Scheme	Standard Hold Period	Extended Hold (if available)
Visa	7 days	Up to 30 days (select MCCs)
Mastercard	7 days	Up to 30 days (select MCCs)
American Express	7 days	Up to 30 days
Discover	10 days	N/A

⚠️ Best Practice

Capture as soon as the order is ready to ship or the service is delivered. Delaying capture increases the risk of authorisation expiry and declines.

Use this endpoint to authorise a payment without capturing it. This places a temporary hold on the customer’s funds for the specified amount.

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.

Additional parameters for this usecase:

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

Parameter	Notes
skip_capture	true

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

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.

","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"26fd5c4c-6caf-4650-95b7-005bd6be3de0","id":"26fd5c4c-6caf-4650-95b7-005bd6be3de0","name":"APIs","type":"folder"}},"urlObject":{"path":["purchases"],"host":["https://api.paysecure.net/api/v1"],"query":[],"variable":[]}},"response":[{"id":"628f0671-6d60-434b-8b57-ac352c05d467","name":"Purchase","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"client\": {\r\n \"email\": \"user6085@example.com\",\r\n \"country\": \"IN\",\r\n \"city\": \"123\",\r\n \"stateCode\": \"ca\",\r\n \"street_address\": \"test test\",\r\n \"zip_code\": \"234567\",\r\n \"phone\": \"+91 9999999999\"\r\n },\r\n \"purchase\": {\r\n \"products\": [\r\n {\r\n \"name\": \"dk\",\r\n \"price\": \"10\"\r\n }\r\n ]\r\n },\r\n \"status\": \"created\",\r\n \"brand_id\": \"your-brand-id\",\r\n \"skip_capture\": true,\r\n \"merchantRef\": \"d9db7ec0-f94c-4a9d-8883-54c19c222d81\",\r\n \"success_redirect\": \"https://your.success.redirect.com\",\r\n \"pending_redirect\": \"https://your.pending.redirect.com\",\r\n \"failure_redirect\": \"https://your.failure.redirect.com\",\r\n \"success_callback\": \"https://your.success.callback.com\",\r\n \"failure_callback\": \"https://your.failure.callback.com\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.paysecure.net/api/v1/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\": \"user9283@example.com\",\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\": \"your-brand-id\",\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\": \"https://your.success.callback.com\",\n \"platform\": \"API\",\n \"created_from_ip\": \"203.0.113.133\",\n \"checkout_url\": \"https://api.paysecure.net/payments/64b032c3c6dccf7d329d9e7e/\",\n \"direct_post_url\": \"https://api.paysecure.net/api/v1/p/64b032c3c6dccf7d329d9e7e/\"\n}"}],"_postman_id":"169fad61-d2ef-4328-8e73-c3006fb55e8c"},{"name":"S2S","id":"1878af20-793a-45b9-9958-cf48133cd43a","protocolProfileBehavior":{"disableUrlEncoding":false,"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer {{APIKey}}","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\": \"203.0.113.121\",\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":"https://api.paysecure.net/api/v1/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- 203.0.113.42
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

Note:
If you want to use token_reference for doing a card transaction, please have a look at Network Tokenisation Section.

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://api.paysecure.net/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":"26fd5c4c-6caf-4650-95b7-005bd6be3de0","id":"26fd5c4c-6caf-4650-95b7-005bd6be3de0","name":"APIs","type":"folder"}},"urlObject":{"path":["p","64bff4fff63e36669499e9c8",""],"host":["https://api.paysecure.net/api/v1"],"query":[{"key":"s2s","value":"true"}],"variable":[]}},"response":[{"id":"c7060a40-180d-42c9-be29-78e012ba097f","name":"Success","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer {{APIKey}}","type":"text"}],"body":{"mode":"raw","raw":"{\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\": \"203.0.113.121\",\r\n \"user_agent\": \"Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/51.0.2704.103 Safari/537.36\",\r\n \"accept_header\": \"text/html\",\r\n \"language\": \"en-US\",\r\n \"java_enabled\": false,\r\n \"javascript_enabled\": true,\r\n \"color_depth\": 24,\r\n \"utc_offset\": 0,\r\n \"screen_width\": 1920,\r\n \"screen_height\": 1080\r\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://api.paysecure.net/api/v1/p/64bff4fff63e36669499e9c8/?s2s=true","host":["https://api.paysecure.net/api/v1"],"path":["p","64bff4fff63e36669499e9c8",""],"query":[{"key":"s2s","value":"true"}]}},"status":"Accepted","code":202,"_postman_previewlanguage":"json","header":[{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"Cache-Control","value":"no-cache, no-store, max-age=0, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Expires","value":"0"},{"key":"X-Frame-Options","value":"DENY"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Date","value":"Thu, 13 Jul 2023 17:31:55 GMT"},{"key":"Keep-Alive","value":"timeout=60"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"pending\",\n \"callback_url\": \"https://api.paysecure.net/api/v1/payment/64b034ecc6dccf7d329d9eb3/\",\n \"method\": \"GET\"\n}"},{"id":"8460ab80-d383-4df4-a81f-21463fea2d28","name":"Failure","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer {{APIKey}}","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\": \"203.0.113.121\",\r\n \"user_agent\": \"Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/51.0.2704.103 Safari/537.36\",\r\n \"accept_header\": \"text/html\",\r\n \"language\": \"en-US\",\r\n \"java_enabled\": false,\r\n \"javascript_enabled\": true,\r\n \"color_depth\": 24,\r\n \"utc_offset\": 0,\r\n \"screen_width\": 1920,\r\n \"screen_height\": 1080\r\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://api.paysecure.net/api/v1/p/64bff4fff63e36669499e9c8/?s2s=true","host":["https://api.paysecure.net/api/v1"],"path":["p","64bff4fff63e36669499e9c8",""],"query":[{"key":"s2s","value":"true"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"Text","header":[{"key":"Date","value":"Tue, 06 Jan 2026 05:57:10 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Nel","value":"{\"report_to\":\"cf-nel\",\"success_fraction\":0.0,\"max_age\":604800}"},{"key":"X-Frame-Options","value":"ALLOW-FROM *"},{"key":"Referrer-Policy","value":"no-referrer"},{"key":"x-session-id","value":"cc434220-0bcd-42c7-9078-53503b81a221"},{"key":"Vary","value":"Origin"},{"key":"Vary","value":"Access-Control-Request-Method"},{"key":"Vary","value":"Access-Control-Request-Headers"},{"key":"Server","value":"cloudflare"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"0"},{"key":"Cache-Control","value":"no-cache, no-store, max-age=0, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Expires","value":"0"},{"key":"Strict-Transport-Security","value":"max-age=31536000 ; includeSubDomains"},{"key":"X-Cache","value":"Error from cloudfront"},{"key":"Via","value":"1.1 9bce423254194c16408d5cf7234126e2.cloudfront.net (CloudFront)"},{"key":"X-Amz-Cf-Pop","value":"IAD61-P10"},{"key":"X-Amz-Cf-Id","value":"FgTt6KEGIk0CH79DQDOvB1tYb1pGfaz0ryIVmQ0CCpDShyhsJGuAkA=="},{"key":"cf-cache-status","value":"DYNAMIC"},{"key":"Report-To","value":"{\"group\":\"cf-nel\",\"max_age\":604800,\"endpoints\":[{\"url\":\"https://a.nel.cloudflare.com/report/v4?s=9SnHJOEjnd1y7hArGsRLWmrk8H9ExaiR%2Fc%2BQMWhAvHlNPYCNEjS60wTjIyODXpca0ZD9%2BalkhLJ63boMGg%2B8iI6eFtXfW%2BxwGaBP1p1ZcwpA\"}]}"},{"key":"CF-RAY","value":"9b98f9f4684505e7-IAD"},{"key":"alt-svc","value":"h3=\":443\"; ma=86400"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Authorization header missing\",\n \"code\": \"authentication_failed\"\n}"}],"_postman_id":"1878af20-793a-45b9-9958-cf48133cd43a"},{"name":"Capture","id":"f40840e6-be9b-4c8f-8e81-3249c4430041","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer {{APIKey}}"}],"body":{"mode":"raw","raw":"{\n \"merchant_reference\": \"64534345\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.paysecure.net/api/v1/purchases/69cd26b053d7b783ebf6b6e9/capture","description":"

After a successful pre-authorisation, use this endpoint to capture (settle) the held funds. You may capture the full authorised amount or a partial amount.

\n","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"26fd5c4c-6caf-4650-95b7-005bd6be3de0","id":"26fd5c4c-6caf-4650-95b7-005bd6be3de0","name":"APIs","type":"folder"}},"urlObject":{"path":["purchases","69cd26b053d7b783ebf6b6e9","capture"],"host":["https://api.paysecure.net/api/v1"],"query":[],"variable":[]}},"response":[{"id":"1f744620-b31e-4260-a920-d09f07b47dc6","name":"Capture","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer {{APIKey}}"}],"body":{"mode":"raw","raw":"{\n \"merchant_reference\": \"64534345\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.paysecure.net/api/v1/purchases/69cd26b053d7b783ebf6b6e9/capture"},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[{"key":"Date","value":"Wed, 01 Apr 2026 17:16:51 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Nel","value":"{\"report_to\":\"cf-nel\",\"success_fraction\":0.0,\"max_age\":604800}"},{"key":"X-Frame-Options","value":"ALLOW-FROM *"},{"key":"Referrer-Policy","value":"no-referrer"},{"key":"x-session-id","value":"72818dba-381a-449a-8351-390453ddbf72"},{"key":"Vary","value":"Origin"},{"key":"Vary","value":"Access-Control-Request-Method"},{"key":"Vary","value":"Access-Control-Request-Headers"},{"key":"Server","value":"cloudflare"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"0"},{"key":"Cache-Control","value":"no-cache, no-store, max-age=0, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Expires","value":"0"},{"key":"Strict-Transport-Security","value":"max-age=31536000 ; includeSubDomains"},{"key":"X-Cache","value":"Error from cloudfront"},{"key":"Via","value":"1.1 3578d122de1401ebc52a7afd35dd5d0c.cloudfront.net (CloudFront)"},{"key":"X-Amz-Cf-Pop","value":"IAD61-P10"},{"key":"X-Amz-Cf-Id","value":"zEG99N28vChcugkKEe-mJxhNgum-PAK1lcn_2mKqagcBd5deWquIjw=="},{"key":"cf-cache-status","value":"DYNAMIC"},{"key":"Report-To","value":"{\"group\":\"cf-nel\",\"max_age\":604800,\"endpoints\":[{\"url\":\"https://a.nel.cloudflare.com/report/v4?s=EnQbeJo0VkBTF%2BqefkY%2BZ1OejkL%2BkIkR76eA5%2FtL3qaxYlOL1ehFjmSIpGl5i91OldfFB41NXeRXp3E43WxFSEhlUj7OgOqbI6eYZs%2B%2BcUBdewUDmvk46tJrDA5WO53Bib8q\"}]}"},{"key":"CF-RAY","value":"9e593e77fb953ec9-IAD"}],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\n \"purchaseId\": \"69cd361053d7b783ebf7324d\",\n \"client\": {\n \"customerId\": \"NA\",\n \"email\": \"user7694@example.com\",\n \"full_name\": \"Riley Haddad\",\n \"date_of_birth\": \"1800-01-01\",\n \"street_address\": \"123\",\n \"country\": \"ZM\",\n \"city\": \"Ashford\",\n \"zip_code\": \"234567\",\n \"cc\": [],\n \"bcc\": [],\n \"stateCode\": \"CA\"\n },\n \"updated_on\": 1775056447,\n \"type\": \"purchase\",\n \"paymentMethod\": \"MASTER,VISA,VIRTUAL-IBAN,CRYPTO-WALLET,MAYA,GCASH,QRPH,BANKTRANSFER,NETBANKING,UPI-QR,PAYPLAY,UPI-INTENT,MOBILEMONEY,GOOGLEPAY,APPLEPAY\",\n \"amountUnit\": \"MAJOR\",\n \"errorMsg\": \"\",\n \"errorCode\": \"NA\",\n \"force_recurring\": false,\n \"created_on\": 1775056400,\n \"extraParam\": {\n \"aft\": {\n \"account_owner_address1\": \"test\",\n \"account_owner_address2\": \"test\",\n \"account_owner_street\": \"test\",\n \"account_owner_postal_code\": \"123\",\n \"account_owner_city\": \"test\",\n \"account_owner_country\": \"UK\",\n \"merchant_postal_code\": \"123\",\n \"merchant_state\": \"FRA\",\n \"acceptor_legal_name\": \"test\",\n \"sender_address\": \"test\",\n \"sender_city\": \"test\",\n \"sender_state\": \"RJ\",\n \"sender_country\": \"FRA\",\n \"sender_name\": \"test\",\n \"sender_account_number\": \"test\",\n \"recipient_name\": \"test\",\n \"bai\": \"AA\"\n }\n },\n \"merchantRef\": \"69cd361053d7b783ebf7324d\",\n \"purchase\": {\n \"currency\": \"EUR\",\n \"products\": [\n {\n \"name\": \"gaming cards\",\n \"quantity\": 1.0,\n \"price\": 10.0,\n \"discount\": 0,\n \"tax_percent\": \"0.00\"\n }\n ],\n \"total\": 10.0,\n \"requestAmount\": 10.0,\n \"language\": \"en\",\n \"notes\": \"\",\n \"debt\": 0,\n \"total_formatted\": 1.0,\n \"taxAmount\": 0.0,\n \"taxPercent\": 0.0,\n \"request_client_details\": [],\n \"email_message\": \"\"\n },\n \"payment\": {\n \"is_outgoing\": false,\n \"payment_type\": \"PURCHASE\",\n \"amount\": 10.0,\n \"currency\": \"EUR\",\n \"net_amount\": 10.0,\n \"fee_amount\": 0.0,\n \"pending_amount\": 0.0,\n \"pending_unfreeze_on\": null,\n \"description\": \"\",\n \"paid_on\": 1775056410,\n \"remote_paid_on\": 1775056410\n },\n \"issuer_details\": {\n \"website\": \"\",\n \"legal_street_address\": \"\",\n \"legal_country\": \"\",\n \"legal_city\": \"\",\n \"legal_zip_code\": \"\",\n \"bank_accounts\": [\n {}\n ],\n \"legal_name\": \"ECOMTEST1\",\n \"brand_name\": \"ECOMTEST1\",\n \"registration_number\": \"\",\n \"tax_number\": \"\"\n },\n \"transaction_data\": {\n \"payment_method\": \"\",\n \"flow\": \"payform\",\n \"extra\": {\n \"expiry_month\": \"12\",\n \"amount\": 10.0,\n \"card_issuer\": \"ING BELGIUM, S.A.\",\n \"masked_pan\": \"46401701****6658\",\n \"card_brand\": \"VISA\",\n \"card_issuer_country\": \"BE\",\n \"card_type\": \"CREDIT\",\n \"cardholder_name\": \"Emerson Okafor\",\n \"expiry_year\": \"28\"\n },\n \"country\": \"\",\n \"attempts\": [\n {\n \"client_ip\": \"203.0.113.234\",\n \"type\": \"execute\",\n \"payment_method\": \"VISA\",\n \"flow\": \"payform\",\n \"successful\": true,\n \"country\": \"BE\",\n \"processing_time\": 1775056410,\n \"extra\": {\n \"expiry_month\": \"12\",\n \"amount\": 10.0,\n \"card_issuer\": \"ING BELGIUM, S.A.\",\n \"masked_pan\": \"46401701****6658\",\n \"card_brand\": \"VISA\",\n \"card_issuer_country\": \"BE\",\n \"card_type\": \"CREDIT\",\n \"cardholder_name\": \"Emerson Okafor\",\n \"expiry_year\": \"28\"\n }\n }\n ]\n },\n \"status\": \"PAID\",\n \"status_history\": [\n {\n \"status\": \"created\",\n \"timestamp\": 1775056400\n },\n {\n \"status\": \"pending_execute\",\n \"timestamp\": 1775056410\n },\n {\n \"status\": \"payment_in_process\",\n \"timestamp\": 1775056410\n },\n {\n \"status\": \"3DS success\",\n \"timestamp\": 1775056424\n },\n {\n \"status\": \"preauthorized\",\n \"timestamp\": 1775056428\n },\n {\n \"status\": \"capture_in_process\",\n \"timestamp\": 1775056447\n },\n {\n \"status\": \"paid\",\n \"timestamp\": 1775056447\n }\n ],\n \"is_test\": false,\n \"brand_id\": \"your-brand-id\",\n \"send_receipt\": false,\n \"is_recurring_token\": false,\n \"skip_capture\": true,\n \"reference_generated\": \"PS1673\",\n \"issued\": \"2026-04-01\",\n \"due\": 1775056400,\n \"refund_upto\": 1776089649,\n \"cc_descriptor\": \"\",\n \"fraudScore\": \"NA\",\n \"trustScore\": \"NA\",\n \"extraFee\": \"0\",\n \"pix_payload\": {},\n \"payInDetails\": {},\n \"paidOn\": 1775056449,\n \"receivedAmt\": 0.0,\n \"captureTxns\": [\n {\n \"captureId\": \"41e31f9f-1e98-4f4d-b48c-7d1ed488fc3f\",\n \"purchaseId\": \"69cd361053d7b783ebf7324d\",\n \"amount\": 10.0,\n \"fxAmount\": 10.0,\n \"status\": \"PAID\",\n \"pspReference\": null,\n \"merchantReference\": \"64534345\",\n \"createdAt\": 1775056447,\n \"updatedAt\": 1775056447,\n \"whiteId\": 0,\n \"fxCurrency\": \"EUR\",\n \"bankMid\": \"payneticsexternal3ds\",\n \"isTest\": false,\n \"currency\": \"EUR\",\n \"amountInUsd\": 11.85,\n \"merchantName\": \"KailashMerchant\",\n \"bankName\": \"paynatics-aft_\",\n \"bankId\": \"532\",\n \"trxMethod\": \"CARDS\",\n \"rollingReserve\": 0.0,\n \"transFees\": 0.0,\n \"mdr\": 0.0,\n \"isSettlementPending\": 0,\n \"parentId\": 0,\n \"transSettlementId\": null,\n \"errorSettlementId\": null,\n \"merchantId\": \"589\"\n }\n ],\n \"taxAmount\": 0.0,\n \"surcharge\": 0.0,\n \"surchargeType\": \"\",\n \"sessionId\": \"\",\n \"refund_availability\": \"NONE\",\n \"refundable_amount\": 10.0,\n \"success_redirect\": \"https://your.success.redirect.com\",\n \"failure_redirect\": \"https://your.failure.redirect.com\",\n \"cancel_redirect\": \"\",\n \"success_callback\": \"https://your.success.callback.com\",\n \"failure_callback\": \"https://your.failure.callback.com\",\n \"platform\": \"API\",\n \"created_from_ip\": \"203.0.113.234\",\n \"checkout_url\": \"https://api.paysecure.net/payments/47395a8217d29014a4af6b1c494ac06b/\",\n \"direct_post_url\": \"https://api.paysecure.net/api/v1/p/69cd361053d7b783ebf7324d/\",\n \"payoutProcess\": false\n}"}],"_postman_id":"f40840e6-be9b-4c8f-8e81-3249c4430041"},{"name":"Cancel","id":"c408ba2b-930b-454f-8862-6b5e1ad48753","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{APIKey}}"}],"url":"https://api.paysecure.net/api/v1/purchases/69ca76dbace4fa4413db928c/cancel","description":"

Use this endpoint to cancel an authorised payment before it has been captured. Voiding releases the held funds back to the customer immediately.

\n","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"26fd5c4c-6caf-4650-95b7-005bd6be3de0","id":"26fd5c4c-6caf-4650-95b7-005bd6be3de0","name":"APIs","type":"folder"}},"urlObject":{"path":["purchases","69ca76dbace4fa4413db928c","cancel"],"host":["https://api.paysecure.net/api/v1"],"query":[],"variable":[]}},"response":[{"id":"4d46a0bd-71bd-4adc-a970-4830b688f843","name":"Cancel","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{APIKey}}"}],"url":"https://api.paysecure.net/api/v1/purchases/69ca76dbace4fa4413db928c/cancel"},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[{"key":"Date","value":"Wed, 01 Apr 2026 17:18:25 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Nel","value":"{\"report_to\":\"cf-nel\",\"success_fraction\":0.0,\"max_age\":604800}"},{"key":"X-Frame-Options","value":"ALLOW-FROM *"},{"key":"Referrer-Policy","value":"no-referrer"},{"key":"x-session-id","value":"1c9b7d67-8dec-4e71-b35b-7952f23b67ed"},{"key":"Vary","value":"Origin"},{"key":"Vary","value":"Access-Control-Request-Method"},{"key":"Vary","value":"Access-Control-Request-Headers"},{"key":"Server","value":"cloudflare"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"0"},{"key":"Cache-Control","value":"no-cache, no-store, max-age=0, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Expires","value":"0"},{"key":"Strict-Transport-Security","value":"max-age=31536000 ; includeSubDomains"},{"key":"X-Cache","value":"Error from cloudfront"},{"key":"Via","value":"1.1 8bd3b44b8e417f2b75cd6e631907112a.cloudfront.net (CloudFront)"},{"key":"X-Amz-Cf-Pop","value":"IAD61-P10"},{"key":"X-Amz-Cf-Id","value":"WSuVRaHm9E64itnjsFWAyBSPCR8YOFpZr7jY-NAhT-Ae-3_bc-hNTw=="},{"key":"cf-cache-status","value":"DYNAMIC"},{"key":"Report-To","value":"{\"group\":\"cf-nel\",\"max_age\":604800,\"endpoints\":[{\"url\":\"https://a.nel.cloudflare.com/report/v4?s=%2FOrvZsMz3WoHOQDEvKgGSADamNtnaGrILftqtr5BiqYIlUvgXZT89lPPwyXtpIDJW8BNOXjG%2FgAQmYnOUsUpQZ%2BDIVJsSDsxo4FxOEgIKcxPYcG21xgzcTNpNqbnk%2Fnw%2FEki\"}]}"},{"key":"CF-RAY","value":"9e5940bd580a07ed-IAD"}],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\n \"purchaseId\": \"69cd36c353d7b783ebf743e9\",\n \"client\": {\n \"customerId\": \"NA\",\n \"email\": \"user7694@example.com\",\n \"full_name\": \"Riley Haddad\",\n \"date_of_birth\": \"1800-01-01\",\n \"street_address\": \"123\",\n \"country\": \"ZM\",\n \"city\": \"Ashford\",\n \"zip_code\": \"234567\",\n \"cc\": [],\n \"bcc\": [],\n \"stateCode\": \"CA\"\n },\n \"updated_on\": 1775056649,\n \"type\": \"purchase\",\n \"paymentMethod\": \"MASTER,VISA,VIRTUAL-IBAN,CRYPTO-WALLET,MAYA,GCASH,QRPH,BANKTRANSFER,NETBANKING,UPI-QR,PAYPLAY,UPI-INTENT,MOBILEMONEY,GOOGLEPAY,APPLEPAY\",\n \"amountUnit\": \"MAJOR\",\n \"errorMsg\": \"\",\n \"errorCode\": \"NA\",\n \"force_recurring\": false,\n \"created_on\": 1775056579,\n \"extraParam\": {\n \"aft\": {\n \"account_owner_address1\": \"test\",\n \"account_owner_address2\": \"test\",\n \"account_owner_street\": \"test\",\n \"account_owner_postal_code\": \"123\",\n \"account_owner_city\": \"test\",\n \"account_owner_country\": \"UK\",\n \"merchant_postal_code\": \"123\",\n \"merchant_state\": \"FRA\",\n \"acceptor_legal_name\": \"test\",\n \"sender_address\": \"test\",\n \"sender_city\": \"test\",\n \"sender_state\": \"RJ\",\n \"sender_country\": \"FRA\",\n \"sender_name\": \"test\",\n \"sender_account_number\": \"test\",\n \"recipient_name\": \"test\",\n \"bai\": \"AA\"\n }\n },\n \"merchantRef\": \"69cd36c353d7b783ebf743e9\",\n \"purchase\": {\n \"currency\": \"EUR\",\n \"products\": [\n {\n \"name\": \"gaming cards\",\n \"quantity\": 1.0,\n \"price\": 10.0,\n \"discount\": 0,\n \"tax_percent\": \"0.00\"\n }\n ],\n \"total\": 10.0,\n \"requestAmount\": 10.0,\n \"language\": \"en\",\n \"notes\": \"\",\n \"debt\": 0,\n \"total_formatted\": 1.0,\n \"taxAmount\": 0.0,\n \"taxPercent\": 0.0,\n \"request_client_details\": [],\n \"email_message\": \"\"\n },\n \"payment\": {\n \"is_outgoing\": false,\n \"payment_type\": \"PURCHASE\",\n \"amount\": 10.0,\n \"currency\": \"EUR\",\n \"net_amount\": 10.0,\n \"fee_amount\": 0.0,\n \"pending_amount\": 0.0,\n \"pending_unfreeze_on\": null,\n \"description\": \"\",\n \"paid_on\": 1775056600,\n \"remote_paid_on\": 1775056600\n },\n \"issuer_details\": {\n \"website\": \"\",\n \"legal_street_address\": \"\",\n \"legal_country\": \"\",\n \"legal_city\": \"\",\n \"legal_zip_code\": \"\",\n \"bank_accounts\": [\n {}\n ],\n \"legal_name\": \"ECOMTEST1\",\n \"brand_name\": \"ECOMTEST1\",\n \"registration_number\": \"\",\n \"tax_number\": \"\"\n },\n \"transaction_data\": {\n \"payment_method\": \"\",\n \"flow\": \"payform\",\n \"extra\": {\n \"expiry_month\": \"12\",\n \"amount\": 10.0,\n \"card_issuer\": \"JPMORGAN CHASE BANK, N.A.\",\n \"masked_pan\": \"42000000****0000\",\n \"card_brand\": \"VISA\",\n \"card_issuer_country\": \"US\",\n \"card_type\": \"CREDIT\",\n \"cardholder_name\": \"Emerson Okafor\",\n \"expiry_year\": \"28\"\n },\n \"country\": \"\",\n \"attempts\": [\n {\n \"client_ip\": \"203.0.113.234\",\n \"type\": \"execute\",\n \"payment_method\": \"VISA\",\n \"flow\": \"payform\",\n \"successful\": true,\n \"country\": \"US\",\n \"processing_time\": 1775056600,\n \"extra\": {\n \"expiry_month\": \"12\",\n \"amount\": 10.0,\n \"card_issuer\": \"JPMORGAN CHASE BANK, N.A.\",\n \"masked_pan\": \"42000000****0000\",\n \"card_brand\": \"VISA\",\n \"card_issuer_country\": \"US\",\n \"card_type\": \"CREDIT\",\n \"cardholder_name\": \"Emerson Okafor\",\n \"expiry_year\": \"28\"\n }\n }\n ]\n },\n \"status\": \"CANCELLED\",\n \"status_history\": [\n {\n \"status\": \"created\",\n \"timestamp\": 1775056579\n },\n {\n \"status\": \"pending_execute\",\n \"timestamp\": 1775056600\n },\n {\n \"status\": \"payment_in_process\",\n \"timestamp\": 1775056600\n },\n {\n \"status\": \"3DS success\",\n \"timestamp\": 1775056607\n },\n {\n \"status\": \"preauthorized\",\n \"timestamp\": 1775056611\n },\n {\n \"status\": \"void_in_process\",\n \"timestamp\": 1775056632\n },\n {\n \"status\": \"preauthorized\",\n \"timestamp\": 1775056632\n },\n {\n \"status\": \"void_in_process\",\n \"timestamp\": 1775056647\n },\n {\n \"status\": \"cancelled\",\n \"timestamp\": 1775056649\n }\n ],\n \"is_test\": false,\n \"brand_id\": \"your-brand-id\",\n \"send_receipt\": false,\n \"is_recurring_token\": false,\n \"skip_capture\": true,\n \"reference_generated\": \"PS1675\",\n \"issued\": \"2026-04-01\",\n \"due\": 1775056579,\n \"refund_upto\": 1776089849,\n \"cc_descriptor\": \"\",\n \"fraudScore\": \"NA\",\n \"trustScore\": \"NA\",\n \"extraFee\": \"0\",\n \"pix_payload\": {},\n \"payInDetails\": {},\n \"paidOn\": 0,\n \"receivedAmt\": 0.0,\n \"taxAmount\": 0.0,\n \"surcharge\": 0.0,\n \"surchargeType\": \"\",\n \"sessionId\": \"\",\n \"refund_availability\": \"NONE\",\n \"refundable_amount\": 10.0,\n \"success_redirect\": \"https://your.success.redirect.com\",\n \"failure_redirect\": \"https://your.failure.redirect.com\",\n \"cancel_redirect\": \"\",\n \"success_callback\": \"https://your.success.callback.com\",\n \"failure_callback\": \"https://your.failure.callback.com\",\n \"platform\": \"API\",\n \"created_from_ip\": \"203.0.113.234\",\n \"checkout_url\": \"https://api.paysecure.net/payments/23182fc42998cb02b4a3e6aa5c3e26c8/\",\n \"direct_post_url\": \"https://api.paysecure.net/api/v1/p/69cd36c353d7b783ebf743e9/\",\n \"payoutProcess\": false\n}"}],"_postman_id":"c408ba2b-930b-454f-8862-6b5e1ad48753"}],"id":"26fd5c4c-6caf-4650-95b7-005bd6be3de0","auth":{"type":"noauth","isInherited":false},"event":[{"listen":"prerequest","script":{"type":"text/javascript","packages":{},"requests":{},"exec":[""],"id":"01baf5ad-2b3d-4ff8-9b49-fc3b41b3244d"}},{"listen":"test","script":{"type":"text/javascript","packages":{},"requests":{},"exec":[""],"id":"8ccf337b-64b0-4793-bcc6-8e363d5794bc"}}],"_postman_id":"26fd5c4c-6caf-4650-95b7-005bd6be3de0","description":""},{"name":"Transaction Status Lifecycle","item":[],"id":"22c91d72-b700-449a-b033-f089bb14b65d","description":"

Every payment processed through the pre-authorisation flow passes through a series of statuses. Understanding these statuses is critical for building robust integrations.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\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	Available Actions
CREATED	Transactions are initiated by merchants.	Open checkout url
PENDING_EXECUTE	Transaction is in processing	Wait
PAYMENT_IN_PROCESS	Transaction is being processed by the payment network.	Wait
PREAUTHORIZED	Funds have been successfully held. Ready for capture or void.	Capture, Void
CAPTURE_IN_PROCESS	Capture has been inititated and is in process.	Wait
PAID	Full authorised amount has been settled to the merchant.	Refund, Partial Refund
PARTIALLY_CAPTURED	A portion of the authorised amount was captured. Remainder released.	Refund (on captured amount), Partial Refund
VOID_IN_PROCESS	Authorisation was cancelled before capture and it is in process	None
CANCELLED	Authorisation was cancelled before capture. Funds released.	None
EXPIRED	Authorisation expired without capture. Funds auto-released.	None
ERROR	A processing error occurred during the preauthorisation step	Retry Preauth
REFUNDED	Post-capture return of funds (separate API).	None
PARTIAL_REFUNDED	Post-capture return of partial funds (separate API).	Partial Refund

","_postman_id":"22c91d72-b700-449a-b033-f089bb14b65d"},{"name":"Best Practices","item":[],"id":"3d1e8614-a4ad-48e6-be15-219589386419","description":"

Capture Timing

Capture payments as soon as the goods are shipped or the service is delivered. The longer you wait, the higher the risk of authorisation expiry, customer disputes, and declined captures.

Idempotency

Always include the X-Idempotency-Key header for all write operations (authorise, capture, void). This protects against duplicate transactions caused by network timeouts or retries.

Webhook-Driven Architecture

Do not rely solely on synchronous API responses for business logic. Implement webhook handlers to receive real-time status updates and use them as the source of truth for transaction state in your system.

Error Handling

Implement retry logic with exponential backoff for 5xx errors and 429 (rate limit) responses. For 4xx errors, parse the error response body and handle each error code appropriately in your application logic.

PCI Compliance

If you are handling raw card numbers, you must be PCI DSS Level 1 certified. Paysecure strongly recommends using tokenised payment methods to minimise your PCI scope. Use the Paysecure Cashier or client-side SDK to tokenise card details before they reach your server.

Reconciliation

Use the reference field on authorise, capture, and void requests to associate Paysecure transactions with your internal order system. The balances object in every response provides a real-time breakdown for reconciliation.

3D Secure

Enable 3DS for all pre-authorisation requests where supported. This shifts fraud liability to the card issuer and reduces chargebacks. Paysecure supports 3DS 2.x with frictionless and challenge flows.

Q: Can I capture more than the authorised amount?

A: No. The capture amount must be less than or equal to the authorised amount. If you need to charge more, you must create a new authorisation for the additional amount.

Q: Can I perform multiple partial captures on a single authorisation?

A: Yes. Paysecure supports multiple captures per authorisation. But you will need to contact the support team for enabling the same.

Q: What happens if I do not capture before the authorisation expires?

A: The authorisation automatically expires and the held funds are released back to the customer. You will receive a payment.expired webhook event. You must create a new authorisation to charge the customer.

Q: Can I void a payment after it has been captured?

A: No. Once a payment is captured, you must use the Refund API to return funds. The void endpoint only works for payments in AUTHORISED status.

Q: How long does a void take to reflect on the customer’s statement?

A: Typically, the hold is removed within 1–3 business days, depending on the issuing bank. Some banks may take up to 7 days to release the hold.

Q: Does the customer see the pre-authorisation on their statement?

A: Yes. The customer will see a pending charge for the authorised amount. This pending charge is released upon void or expiry, or replaced by the final charge upon capture.

Q: Can I use pre-authorisation with non-card payment methods?

A: Pre-authorisation is primarily supported for card payments. Support for alternative payment methods varies. Check the Paysecure payment methods documentation for details.

Q: Is 3D Secure required for pre-authorisations?

A: 3DS is not required but is strongly recommended. It reduces fraud liability and chargeback risk. Paysecure supports 3DS on all card pre-authorisation requests.

\n","_postman_id":"66a37eda-b8ee-496b-b9ca-dcc5ce80677c"}],"id":"2b754ad4-d6a4-4a6a-a269-a0214113e3e6","description":"

Overview

Pre-authorisation (also known as \"auth only\") is a two-step payment process where a merchant first reserves (holds) funds on a customer’s payment method without immediately capturing the amount. This allows the merchant to verify fund availability before fulfilling an order, then capture (settle) the payment at a later time — or void (cancel) the hold if the order is not fulfilled.

When to Use Pre-Authorisation

Pre-authorisation is ideal for scenarios where the final transaction amount may change, or where goods/services are not delivered immediately. Common use cases include:

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

Use Case	Description
E-Commerce	Authorise at checkout; capture when the order ships. Void if the item is out of stock.
Hospitality	Pre-authorise the estimated room charge at check-in; adjust and capture at checkout.
Car Rentals	Hold the estimated rental cost; capture the final amount upon vehicle return.
Subscriptions	Verify the card with a pre-auth before activating a trial; capture when billing begins.
Marketplaces	Authorise the buyer’s funds; capture once the seller confirms dispatch.

Key Concepts

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

Term	Definition
Pre-Authorisation	A transaction that reserves funds on the customer’s card without settling them. Also called \"auth only\" or \"manual capture\".
Capture	The action of claiming the previously authorised funds. Can be full or partial.
Partial Capture	Capturing less than the originally authorised amount. The remaining balance is automatically released.
Void	Cancelling a pre-authorised transaction before capture, releasing the held funds back to the customer.
Authorisation Expiry	The time window during which a pre-auth remains valid. Typically 7–30 days depending on card scheme and MCC.

","_postman_id":"2b754ad4-d6a4-4a6a-a269-a0214113e3e6"},{"name":"Get Balance API (V2)","item":[{"name":"Checking Balance","id":"f9d34d0e-464b-4db2-a9ca-dcadb7240b88","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{APIKey}}","type":"text"}],"body":{"mode":"raw","raw":"{ \r\n \"paymentMethod\" : \"PAYOUT-INTERAC-ETRANSFER\"\r\n\r\n}\r\n","options":{"raw":{"language":"json"}}},"url":"https://api.paysecure.net/api/v1/getBalance","description":"

API for checking available balance

URL :- /getBalance/
\n
RequestType: POST
\n
Request Body
\n

\n","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"995609b1-ecff-4d1b-b3c5-5fa6659b9134","id":"995609b1-ecff-4d1b-b3c5-5fa6659b9134","name":"Get Balance API (V2)","type":"folder"}},"urlObject":{"path":["getBalance"],"host":["https://api.paysecure.net/api/v1"],"query":[],"variable":[]}},"response":[{"id":"31b623c8-26ec-47b8-b86b-a1dd3616c438","name":"Checking Balance payout-success","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{ \r\n \"paymentMethod\" : \"PAYOUT-INTERAC-ETRANSFER\"\r\n}\r\n","options":{"raw":{"language":"json"}}},"url":"https://api.paysecure.net/api/v1/getBalance"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"paymentMethod\": \"PAYOUT-INTERAC-ETRANSFER\",\n \"status\": \"success\",\n \"gateways\": [\n {\n \"gatewayName\": \"payhost\",\n \"status\": \"success\",\n \"error\": null,\n \"balances\": [\n {\n \"currency\": \"CAD\",\n \"balance\": 808.380000\n },\n {\n \"currency\": \"USD\",\n \"balance\": 803.380000\n }\n ]\n },\n {\n \"gatewayName\": \"samplepaypg\",\n \"status\": \"success\",\n \"error\": null,\n \"balances\": [\n {\n \"currency\": \"CAD\",\n \"balance\": 808.380000\n },\n {\n \"currency\": \"USD\",\n \"balance\": 808.380000\n }\n ]\n }\n ],\n \"aggregatedBalances\": [\n {\n \"currency\": \"CAD\",\n \"balance\": 1616.760000\n },\n {\n \"currency\": \"USD\",\n \"balance\": 1611.760000\n }\n ]\n}"},{"id":"efe5da59-b52e-4c29-a8f4-e0e9fcb13bd7","name":"Checking Balance partial-success","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{ \r\n \"paymentMethod\" : \"CARDS\"\r\n}\r\n","options":{"raw":{"language":"json"}}},"url":"https://api.paysecure.net/api/v1/getBalance"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"paymentMethod\": \"CARDS\",\n \"status\": \"partial\",\n \"gateways\": [\n {\n \"gatewayName\": \"a55Mandate\",\n \"status\": \"failed\",\n \"error\": {\n \"code\": \"error\",\n \"message\": \"Bank does not provide balance\"\n },\n \"balances\": []\n },\n {\n \"gatewayName\": \"bk_sbx_smilepayz_pix_payin\",\n \"status\": \"success\",\n \"error\": null,\n \"balances\": [\n {\n \"currency\": \"IDR\",\n \"balance\": 250000.000000\n }\n ]\n },\n {\n \"gatewayName\": \"samplepay_pg\",\n \"status\": \"success\",\n \"error\": null,\n \"balances\": [\n {\n \"currency\": \"AED\",\n \"balance\": 0.000000\n },\n {\n \"currency\": \"AUD\",\n \"balance\": 3412.000000\n },\n {\n \"currency\": \"BRL\",\n \"balance\": 100.089996\n },\n {\n \"currency\": \"BTC\",\n \"balance\": 0.000000\n },\n {\n \"currency\": \"BXC\",\n \"balance\": 0.000000\n },\n {\n \"currency\": \"CAD\",\n \"balance\": 1000.000000\n },\n {\n \"currency\": \"CDF\",\n \"balance\": 0.000000\n },\n {\n \"currency\": \"COP\",\n \"balance\": 0.000000\n },\n {\n \"currency\": \"DKK\",\n \"balance\": 0.000000\n },\n {\n \"currency\": \"EGP\",\n \"balance\": 0.000000\n },\n {\n \"currency\": \"ETH\",\n \"balance\": 0.000000\n },\n {\n \"currency\": \"EUR\",\n \"balance\": 0.000000\n },\n {\n \"currency\": \"GBP\",\n \"balance\": -24.327801\n },\n {\n \"currency\": \"GHS\",\n \"balance\": 0.000000\n },\n {\n \"currency\": \"IDR\",\n \"balance\": 1000.000000\n },\n {\n \"currency\": \"INR\",\n \"balance\": 0.000000\n },\n {\n \"currency\": \"JPY\",\n \"balance\": 0.000000\n },\n {\n \"currency\": \"KES\",\n \"balance\": 0.000000\n },\n {\n \"currency\": \"MWK\",\n \"balance\": 0.000000\n },\n {\n \"currency\": \"MXN\",\n \"balance\": -4.770000\n },\n {\n \"currency\": \"NGN\",\n \"balance\": 0.000000\n },\n {\n \"currency\": \"NZD\",\n \"balance\": 0.000000\n },\n {\n \"currency\": \"RWF\",\n \"balance\": 0.000000\n },\n {\n \"currency\": \"THB\",\n \"balance\": 0.000000\n },\n {\n \"currency\": \"TZS\",\n \"balance\": 0.000000\n },\n {\n \"currency\": \"UGX\",\n \"balance\": 0.000000\n },\n {\n \"currency\": \"USD\",\n \"balance\": 167.457992\n },\n {\n \"currency\": \"USDC\",\n \"balance\": 0.000000\n },\n {\n \"currency\": \"USDT\",\n \"balance\": 0.000000\n },\n {\n \"currency\": \"UZS\",\n \"balance\": 0.000000\n },\n {\n \"currency\": \"XAF\",\n \"balance\": 0.000000\n },\n {\n \"currency\": \"XOF\",\n \"balance\": 0.000000\n },\n {\n \"currency\": \"ZAR\",\n \"balance\": 120.000000\n },\n {\n \"currency\": \"ZMW\",\n \"balance\": 0.000000\n }\n ]\n },\n {\n \"gatewayName\": \"payhost\",\n \"status\": \"failed\",\n \"error\": {\n \"code\": \"error\",\n \"message\": \"Bank does not provide balance\"\n },\n \"balances\": []\n }\n ],\n \"aggregatedBalances\": [\n {\n \"currency\": \"AED\",\n \"balance\": 0.000000\n },\n {\n \"currency\": \"AUD\",\n \"balance\": 3412.000000\n },\n {\n \"currency\": \"BRL\",\n \"balance\": 100.089996\n },\n {\n \"currency\": \"BTC\",\n \"balance\": 0.000000\n },\n {\n \"currency\": \"BXC\",\n \"balance\": 0.000000\n },\n {\n \"currency\": \"CAD\",\n \"balance\": 1000.000000\n },\n {\n \"currency\": \"CDF\",\n \"balance\": 0.000000\n },\n {\n \"currency\": \"COP\",\n \"balance\": 0.000000\n },\n {\n \"currency\": \"DKK\",\n \"balance\": 0.000000\n },\n {\n \"currency\": \"EGP\",\n \"balance\": 0.000000\n },\n {\n \"currency\": \"ETH\",\n \"balance\": 0.000000\n },\n {\n \"currency\": \"EUR\",\n \"balance\": 0.000000\n },\n {\n \"currency\": \"GBP\",\n \"balance\": -24.327801\n },\n {\n \"currency\": \"GHS\",\n \"balance\": 0.000000\n },\n {\n \"currency\": \"IDR\",\n \"balance\": 251000.000000\n },\n {\n \"currency\": \"INR\",\n \"balance\": 0.000000\n },\n {\n \"currency\": \"JPY\",\n \"balance\": 0.000000\n },\n {\n \"currency\": \"KES\",\n \"balance\": 0.000000\n },\n {\n \"currency\": \"MWK\",\n \"balance\": 0.000000\n },\n {\n \"currency\": \"MXN\",\n \"balance\": -4.770000\n },\n {\n \"currency\": \"NGN\",\n \"balance\": 0.000000\n },\n {\n \"currency\": \"NZD\",\n \"balance\": 0.000000\n },\n {\n \"currency\": \"RWF\",\n \"balance\": 0.000000\n },\n {\n \"currency\": \"THB\",\n \"balance\": 0.000000\n },\n {\n \"currency\": \"TZS\",\n \"balance\": 0.000000\n },\n {\n \"currency\": \"UGX\",\n \"balance\": 0.000000\n },\n {\n \"currency\": \"USD\",\n \"balance\": 167.457992\n },\n {\n \"currency\": \"USDC\",\n \"balance\": 0.000000\n },\n {\n \"currency\": \"USDT\",\n \"balance\": 0.000000\n },\n {\n \"currency\": \"UZS\",\n \"balance\": 0.000000\n },\n {\n \"currency\": \"XAF\",\n \"balance\": 0.000000\n },\n {\n \"currency\": \"XOF\",\n \"balance\": 0.000000\n },\n {\n \"currency\": \"ZAR\",\n \"balance\": 120.000000\n },\n {\n \"currency\": \"ZMW\",\n \"balance\": 0.000000\n }\n ]\n}"},{"id":"dc62a339-614c-4742-b31a-972550e84198","name":"Checking Balance payout-error","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{ \r\n \"paymentMethod\" : \"PAYOUT-INTERAC\"\r\n}\r\n","options":{"raw":{"language":"json"}}},"url":"https://api.paysecure.net/api/v1/getBalance"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"paymentMethod\": \"PAYOUT-INTERAC\",\n \"status\": \"failed\",\n \"gateways\": [\n {\n \"gatewayName\": \"payhost\",\n \"status\": \"failed\",\n \"error\": {\n \"code\": \"error\",\n \"message\": \"Bank does not provide balance\"\n },\n \"balances\": []\n }\n ],\n \"aggregatedBalances\": []\n}"}],"_postman_id":"f9d34d0e-464b-4db2-a9ca-dcadb7240b88"}],"id":"995609b1-ecff-4d1b-b3c5-5fa6659b9134","description":"

The Get Balance API (V2) provides orchestrator-level visibility into available balances across multiple payment methods and banking partners. This version enhances the existing balance API by aggregating and returning balance details for all supported payment methods associated with all the PSPs for the merchant

Overview

Purpose: Retrieve available balance information across different banks/payment methods.
\n
Scope: Orchestrator-level (not limited to a single merchant or payment method).
\n
Enhancement over previous version:
\n
- Returns balances for all payment methods linked to the orchestrator.
  \n
- Provides both consolidated and MID-level (Merchant ID) breakdowns.
  \n
\n

Request Parameters

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

Parameter	Type	Required	Description
paymentMethod	string	yes	Specifies the payment method to query. Example: \"PAYOUT-INTERAC-ETRANSFER\"

Behavior

When a valid paymentMethod is provided, the API retrieves:
\n
- Balance details across all associated banks/payment methods.
  \n
- MID-level breakdown for each bank.
  \n
- Consolidated balance per payment method.
  \n
\n
The API is designed specifically for orchestrators and returns aggregated data across multiple merchants and banking integrations.
\n

Success Response

On successful retrieval, the API returns:

Payment Method Details
\n
List of Banks / Payment Providers
\n
MID-Level Breakdown
\n
Consolidated Balance
\n

Partial Success Response

A Partial Success response is returned when balance information is retrieved successfully for some payment methods or banks, while one or more fail to return balance data.

This scenario typically occurs when:

A merchant is associated with multiple payment methods or banking partners, and
\n
At least one provider returns a valid balance, while others fail due to unavailability, timeout, or missing data.
\n

Return values-

Status as \"Partial\"
\n
Payment Method Details
\n
List of Banks / Payment Providers
\n
MID-Level Breakdown
\n
Consolidated Balance
\n

Error Handling

If balance details are not found or the request cannot be processed, the API returns:

Appropriate status code
\n
Error message
\n

\n","auth":{"type":"noauth","isInherited":false},"event":[{"listen":"prerequest","script":{"type":"text/javascript","packages":{},"requests":{},"exec":[""],"id":"3566451c-f5ae-459d-8f58-a27ed786d7c3"}},{"listen":"test","script":{"type":"text/javascript","packages":{},"requests":{},"exec":[""],"id":"f2b01223-d419-47f1-b299-61b013f56473"}}],"_postman_id":"995609b1-ecff-4d1b-b3c5-5fa6659b9134"},{"name":"Global Collection","item":[{"name":"Get merchants","id":"936a1979-7369-40bf-9941-c8157e17e1b3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{APIKey}}"}]},"isInherited":false},"method":"GET","header":[{"key":"requestId","value":"12344","type":"text"}],"url":"https://api.paysecure.net/api/v1/external/gc/partner/merchants?page=1&size=30","urlObject":{"path":["external","gc","partner","merchants"],"host":["https://api.paysecure.net/api/v1"],"query":[{"key":"page","value":"1"},{"key":"size","value":"30"},{"disabled":true,"key":null,"value":""}],"variable":[]}},"response":[{"id":"09a87680-4853-4485-929a-9406c246cfc2","name":"Get merchants","originalRequest":{"method":"GET","header":[{"key":"requestId","value":"12344","type":"text"}],"url":{"raw":"https://api.paysecure.net/api/v1/external/gc/partner/merchants?page=1&size=30","host":["https://api.paysecure.net/api/v1"],"path":["external","gc","partner","merchants"],"query":[{"key":"page","value":"1"},{"key":"size","value":"30"},{"key":null,"value":"","type":"text","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[{"key":":status","value":200},{"key":"date","value":"Wed, 06 May 2026 13:30:48 GMT"},{"key":"content-type","value":"application/json"},{"key":"x-session-id","value":"3211e389-98b5-407f-8712-05134fb4c62f"},{"key":"vary","value":"Origin, Access-Control-Request-Method, Access-Control-Request-Headers"},{"key":"server","value":"Hidden"},{"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-frame-options","value":"ALLOW-FROM *"},{"key":"referrer-policy","value":"no-referrer"},{"key":"set-cookie","value":"SESSION=MDkzYWJjNGMtNDA2YS00OTc2LWFlMzUtOTMzM2VlODI5ZmRj; Path=/; Secure; HttpOnly; SameSite=Strict"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"success\",\n \"data\": {\n \"merchant\": [\n {\n \"merchantId\": 4143,\n \"email\": \"user8025@example.com\",\n \"name\": \"Test Emerson Merchants\",\n \"legalName\": \"Test Example Merchants Pvt Ltd\",\n \"regNo\": \"CIN123456789\",\n \"websiteUrl\": \"https://testglobex12.com\",\n \"category\": \"3451\",\n \"iecNo\": \"fdsfkshf\",\n \"tradingStartDate\": \"2022-01-01\",\n \"dateOfIncorporation\": \"2021-06-15\",\n \"tradingAddress\": \"90 Fixture Close\",\n \"tradingCountry\": \"IN\",\n \"tradingState\": \"Maharashtra\",\n \"tradingPostal\": \"400001\",\n \"corporateAddress\": \"456 Corporate Avenue, Ashford\",\n \"corporateCountry\": \"IN\",\n \"corporateState\": \"Maharashtra\",\n \"corporatePostal\": \"400002\",\n \"businessPhone\": \"+912212345678\",\n \"contactPhone\": \"+912212345678\",\n \"contactName\": \"Sam Moreau\",\n \"officerTitle\": \"Director\",\n \"officerName\": \"Sam Moreau\",\n \"defaultCurrency\": \"EUR\",\n \"defaultTimezone\": \"Asia/Kolkata\",\n \"allowGlobalCollection\": false,\n \"isLiveTransactionAllowed\": false,\n \"allowedPaymentMethods\": [\n \"MASTER\",\n \"VISA\",\n \"JCB\"\n ],\n \"allowedCurrencies\": []\n },\n {\n \"merchantId\": 4187,\n \"email\": \"user2672@example.com\",\n \"name\": \"testglobex12merchant10\",\n \"legalName\": \"Test Example Merchants Pvt Ltd\",\n \"regNo\": \"CIN123456789\",\n \"websiteUrl\": \"https://testglobex12.com\",\n \"category\": \"3451\",\n \"iecNo\": \"fdsfkshf\",\n \"tradingStartDate\": \"2022-01-01\",\n \"dateOfIncorporation\": \"2021-06-15\",\n \"tradingAddress\": \"90 Fixture Close\",\n \"tradingCountry\": \"IN\",\n \"tradingState\": \"Maharashtra\",\n \"tradingPostal\": \"400001\",\n \"corporateAddress\": \"456 Corporate Avenue, Ashford\",\n \"corporateCountry\": \"IN\",\n \"corporateState\": \"Maharashtra\",\n \"corporatePostal\": \"400002\",\n \"businessPhone\": \"+912212345678\",\n \"contactPhone\": \"+919876543210\",\n \"contactName\": \"Sam Moreau\",\n \"officerTitle\": \"Director\",\n \"officerName\": \"Sam Moreau\",\n \"defaultCurrency\": \"EUR\",\n \"defaultTimezone\": \"EUR\",\n \"allowGlobalCollection\": false,\n \"isLiveTransactionAllowed\": true,\n \"allowedPaymentMethods\": [\n \"PayByBank\"\n ],\n \"allowedCurrencies\": [\n \"GBP\"\n ]\n },\n {\n \"merchantId\": 4256,\n \"email\": \"user3738@example.com\",\n \"name\": \"testglobex12merchant101\",\n \"legalName\": \"Test Example Merchants Pvt Ltd\",\n \"regNo\": \"CIN123456789\",\n \"websiteUrl\": \"https://testglobex12.com\",\n \"category\": \"3451\",\n \"iecNo\": \"fdsfkshf\",\n \"tradingStartDate\": \"2022-01-01\",\n \"dateOfIncorporation\": \"2021-06-15\",\n \"tradingAddress\": \"90 Fixture Close\",\n \"tradingCountry\": \"IN\",\n \"tradingState\": \"Maharashtra\",\n \"tradingPostal\": \"400001\",\n \"corporateAddress\": \"456 Corporate Avenue, Ashford\",\n \"corporateCountry\": \"IN\",\n \"corporateState\": \"Maharashtra\",\n \"corporatePostal\": \"400002\",\n \"businessPhone\": \"+912212345678\",\n \"contactPhone\": \"+919876543210\",\n \"contactName\": \"Sam Moreau\",\n \"officerTitle\": \"Director\",\n \"officerName\": \"Sam Moreau\",\n \"defaultCurrency\": \"EUR\",\n \"defaultTimezone\": \"EUR\",\n \"allowGlobalCollection\": false,\n \"isLiveTransactionAllowed\": true,\n \"allowedPaymentMethods\": [\n \"PayByBank\"\n ],\n \"allowedCurrencies\": [\n \"GBP\",\n \"USD\"\n ]\n },\n {\n \"merchantId\": 4263,\n \"email\": \"user2203@example.com\",\n \"name\": \"testglobex12merchant1012\",\n \"legalName\": \"Test Example Merchants Pvt Ltd\",\n \"regNo\": \"CIN123456789\",\n \"websiteUrl\": \"https://testglobex12.com\",\n \"category\": \"3451\",\n \"iecNo\": \"fdsfkshf\",\n \"tradingStartDate\": \"2022-01-01\",\n \"dateOfIncorporation\": \"2021-06-15\",\n \"tradingAddress\": \"90 Fixture Close\",\n \"tradingCountry\": \"IN\",\n \"tradingState\": \"Maharashtra\",\n \"tradingPostal\": \"400001\",\n \"corporateAddress\": \"456 Corporate Avenue, Ashford\",\n \"corporateCountry\": \"IN\",\n \"corporateState\": \"Maharashtra\",\n \"corporatePostal\": \"400002\",\n \"businessPhone\": \"+912212345678\",\n \"contactPhone\": \"+919876543210\",\n \"contactName\": \"Sam Moreau\",\n \"officerTitle\": \"Director\",\n \"officerName\": \"Sam Moreau\",\n \"defaultCurrency\": \"EUR\",\n \"defaultTimezone\": \"EUR\",\n \"allowGlobalCollection\": false,\n \"isLiveTransactionAllowed\": true,\n \"allowedPaymentMethods\": [\n \"PayByBank\"\n ],\n \"allowedCurrencies\": [\n \"GBP\",\n \"USD\"\n ]\n },\n {\n \"merchantId\": 4274,\n \"email\": \"user8883@example.com\",\n \"name\": \"testglobex12merchant10d12\",\n \"legalName\": \"Test Example Merchants Pvt Ltd\",\n \"regNo\": \"CIN123456789\",\n \"websiteUrl\": \"https://testglobex12.com\",\n \"category\": \"3453\",\n \"iecNo\": \"fdsfkshf\",\n \"tradingStartDate\": \"2022-01-01\",\n \"dateOfIncorporation\": \"2021-06-15\",\n \"tradingAddress\": \"90 Fixture Close\",\n \"tradingCountry\": \"IN\",\n \"tradingState\": \"Maharashtra\",\n \"tradingPostal\": \"400001\",\n \"corporateAddress\": \"456 Corporate Avenue, Ashford\",\n \"corporateCountry\": \"IN\",\n \"corporateState\": \"Maharashtra\",\n \"corporatePostal\": \"400002\",\n \"businessPhone\": \"+912212345678\",\n \"contactPhone\": \"+919876543210\",\n \"contactName\": \"Sam Moreau\",\n \"officerTitle\": \"Director\",\n \"officerName\": \"Sam Moreau\",\n \"defaultCurrency\": \"EUR\",\n \"defaultTimezone\": \"EUR\",\n \"allowGlobalCollection\": true,\n \"isLiveTransactionAllowed\": true,\n \"allowedPaymentMethods\": [\n \"PayByBank\"\n ],\n \"allowedCurrencies\": [\n \"GBP\",\n \"USD\"\n ]\n },\n {\n \"merchantId\": 4270,\n \"email\": \"user2326@example.com\",\n \"name\": \"testglobex12merchant10s12\",\n \"legalName\": \"Test Example Merchants Pvt Ltd\",\n \"regNo\": \"CIN12345678909\",\n \"websiteUrl\": \"https://testglobex121.com\",\n \"category\": \"3451\",\n \"iecNo\": \"fdsjfk1shf\",\n \"tradingStartDate\": \"2022-01-01\",\n \"dateOfIncorporation\": \"2021-06-15\",\n \"tradingAddress\": \"24 Sample Avenue\",\n \"tradingCountry\": \"IN\",\n \"tradingState\": \"Maharashtra1\",\n \"tradingPostal\": \"400011\",\n \"corporateAddress\": \"456 Corporate Avenue, Ashford1\",\n \"corporateCountry\": \"IN\",\n \"corporateState\": \"Maharashtra\",\n \"corporatePostal\": \"400012\",\n \"businessPhone\": \"+912212345678\",\n \"contactPhone\": \"+919876543210\",\n \"contactName\": \"Finley Rivera\",\n \"officerTitle\": \"Director1\",\n \"officerName\": \"Finley Rivera\",\n \"defaultCurrency\": \"EUR\",\n \"defaultTimezone\": \"UTC\",\n \"allowGlobalCollection\": true,\n \"isLiveTransactionAllowed\": true,\n \"allowedPaymentMethods\": [\n \"PayByBank\"\n ],\n \"allowedCurrencies\": [\n \"GBP\"\n ]\n },\n {\n \"merchantId\": 4189,\n \"email\": \"user3353@example.com\",\n \"name\": \"testglobex12merchant11\",\n \"legalName\": \"Test Example Merchants Pvt Ltd\",\n \"regNo\": \"CIN123456789\",\n \"websiteUrl\": \"https://testglobex12.com\",\n \"category\": \"3451\",\n \"iecNo\": \"fdsfkshf\",\n \"tradingStartDate\": \"2022-01-01\",\n \"dateOfIncorporation\": \"2021-06-15\",\n \"tradingAddress\": \"90 Fixture Close\",\n \"tradingCountry\": \"IN\",\n \"tradingState\": \"Maharashtra\",\n \"tradingPostal\": \"400001\",\n \"corporateAddress\": \"456 Corporate Avenue, Ashford\",\n \"corporateCountry\": \"IN\",\n \"corporateState\": \"Maharashtra\",\n \"corporatePostal\": \"400002\",\n \"businessPhone\": \"+912212345678\",\n \"contactPhone\": \"+919876543210\",\n \"contactName\": \"Sam Moreau\",\n \"officerTitle\": \"Director\",\n \"officerName\": \"Sam Moreau\",\n \"defaultCurrency\": \"EUR\",\n \"defaultTimezone\": \"EUR\",\n \"allowGlobalCollection\": false,\n \"isLiveTransactionAllowed\": true,\n \"allowedPaymentMethods\": [\n \"PayByBank\"\n ],\n \"allowedCurrencies\": [\n \"GBP\"\n ]\n },\n {\n \"merchantId\": 4195,\n \"email\": \"user3883@example.com\",\n \"name\": \"testglobex12merchant12\",\n \"legalName\": \"Test Example Merchants Pvt Ltd\",\n \"regNo\": \"CIN123456789\",\n \"websiteUrl\": \"https://testglobex12.com\",\n \"category\": \"3451\",\n \"iecNo\": \"fdsfkshf\",\n \"tradingStartDate\": \"2022-01-01\",\n \"dateOfIncorporation\": \"2021-06-15\",\n \"tradingAddress\": \"90 Fixture Close\",\n \"tradingCountry\": \"IN\",\n \"tradingState\": \"Maharashtra\",\n \"tradingPostal\": \"400001\",\n \"corporateAddress\": \"456 Corporate Avenue, Ashford\",\n \"corporateCountry\": \"IN\",\n \"corporateState\": \"Maharashtra\",\n \"corporatePostal\": \"400002\",\n \"businessPhone\": \"+912212345678\",\n \"contactPhone\": \"+919876543210\",\n \"contactName\": \"Sam Moreau\",\n \"officerTitle\": \"Director\",\n \"officerName\": \"Sam Moreau\",\n \"defaultCurrency\": \"EUR\",\n \"defaultTimezone\": \"EUR\",\n \"allowGlobalCollection\": false,\n \"isLiveTransactionAllowed\": true,\n \"allowedPaymentMethods\": [\n \"PayByBank\"\n ],\n \"allowedCurrencies\": [\n \"GBP\"\n ]\n },\n {\n \"merchantId\": 4377,\n \"email\": \"user5692@example.com\",\n \"name\": \"testglobex12merchant12349\",\n \"legalName\": \"Test Example Merchants Pvt Ltd\",\n \"regNo\": \"CIN123456789\",\n \"websiteUrl\": \"https://testglobex12.com\",\n \"category\": \"3471\",\n \"iecNo\": \"fdsfkshf\",\n \"tradingStartDate\": \"2022-01-01\",\n \"dateOfIncorporation\": \"2021-06-15\",\n \"tradingAddress\": \"90 Fixture Close\",\n \"tradingCountry\": \"IN\",\n \"tradingState\": \"Maharashtra\",\n \"tradingPostal\": \"400001\",\n \"corporateAddress\": \"456 Corporate Avenue, Ashford\",\n \"corporateCountry\": \"IN\",\n \"corporateState\": \"Maharashtra\",\n \"corporatePostal\": \"400002\",\n \"businessPhone\": \"+912212345678\",\n \"contactPhone\": \"+919876543210\",\n \"contactName\": \"Sam Moreau\",\n \"officerTitle\": \"Director\",\n \"officerName\": \"Sam Moreau\",\n \"defaultCurrency\": \"EUR\",\n \"defaultTimezone\": \"EUR\",\n \"allowGlobalCollection\": false,\n \"isLiveTransactionAllowed\": true,\n \"allowedPaymentMethods\": [\n \"PayByBank\"\n ],\n \"allowedCurrencies\": [\n \"USD\",\n \"INR\"\n ]\n },\n {\n \"merchantId\": 4196,\n \"email\": \"user1551@example.com\",\n \"name\": \"testglobex12merchant13\",\n \"legalName\": \"Test Example Merchants Pvt Ltd\",\n \"regNo\": \"CIN123456789\",\n \"websiteUrl\": \"https://testglobex12.com\",\n \"category\": \"3451\",\n \"iecNo\": \"fdsfkshf\",\n \"tradingStartDate\": \"2022-01-01\",\n \"dateOfIncorporation\": \"2021-06-15\",\n \"tradingAddress\": \"90 Fixture Close\",\n \"tradingCountry\": \"IN\",\n \"tradingState\": \"Maharashtra\",\n \"tradingPostal\": \"400001\",\n \"corporateAddress\": \"456 Corporate Avenue, Ashford\",\n \"corporateCountry\": \"IN\",\n \"corporateState\": \"Maharashtra\",\n \"corporatePostal\": \"400002\",\n \"businessPhone\": \"+912212345678\",\n \"contactPhone\": \"+919876543210\",\n \"contactName\": \"Sam Moreau\",\n \"officerTitle\": \"Director\",\n \"officerName\": \"Sam Moreau\",\n \"defaultCurrency\": \"EUR\",\n \"defaultTimezone\": \"EUR\",\n \"allowGlobalCollection\": false,\n \"isLiveTransactionAllowed\": true,\n \"allowedPaymentMethods\": [\n \"PayByBank\"\n ],\n \"allowedCurrencies\": [\n \"GBP\",\n \"USD\"\n ]\n },\n {\n \"merchantId\": 4376,\n \"email\": \"user1632@example.com\",\n \"name\": \"testglobex12merchant13149\",\n \"legalName\": \"Test Example Merchants Pvt Ltd\",\n \"regNo\": \"CIN123456789\",\n \"websiteUrl\": \"https://testglobex12.com\",\n \"category\": \"3471\",\n \"iecNo\": \"fdsfkshf\",\n \"tradingStartDate\": \"2022-01-01\",\n \"dateOfIncorporation\": \"2021-06-15\",\n \"tradingAddress\": \"90 Fixture Close\",\n \"tradingCountry\": \"IN\",\n \"tradingState\": \"Maharashtra\",\n \"tradingPostal\": \"400001\",\n \"corporateAddress\": \"456 Corporate Avenue, Ashford\",\n \"corporateCountry\": \"IN\",\n \"corporateState\": \"Maharashtra\",\n \"corporatePostal\": \"400002\",\n \"businessPhone\": \"+912212345678\",\n \"contactPhone\": \"+919876543210\",\n \"contactName\": \"Sam Moreau\",\n \"officerTitle\": \"Director\",\n \"officerName\": \"Sam Moreau\",\n \"defaultCurrency\": \"EUR\",\n \"defaultTimezone\": \"EUR\",\n \"allowGlobalCollection\": false,\n \"isLiveTransactionAllowed\": true,\n \"allowedPaymentMethods\": [\n \"PayByBank\"\n ],\n \"allowedCurrencies\": [\n \"USD\",\n \"INR\"\n ]\n },\n {\n \"merchantId\": 4197,\n \"email\": \"user5905@example.com\",\n \"name\": \"testglobex12merchant14\",\n \"legalName\": \"Test Example Merchants Pvt Ltd\",\n \"regNo\": \"CIN123456789\",\n \"websiteUrl\": \"https://testglobex12.com\",\n \"category\": \"3451\",\n \"iecNo\": \"fdsfkshf\",\n \"tradingStartDate\": \"2022-01-01\",\n \"dateOfIncorporation\": \"2021-06-15\",\n \"tradingAddress\": \"90 Fixture Close\",\n \"tradingCountry\": \"IN\",\n \"tradingState\": \"Maharashtra\",\n \"tradingPostal\": \"400001\",\n \"corporateAddress\": \"456 Corporate Avenue, Ashford\",\n \"corporateCountry\": \"IN\",\n \"corporateState\": \"Maharashtra\",\n \"corporatePostal\": \"400002\",\n \"businessPhone\": \"+912212345678\",\n \"contactPhone\": \"+919876543210\",\n \"contactName\": \"Sam Moreau\",\n \"officerTitle\": \"Director\",\n \"officerName\": \"Sam Moreau\",\n \"defaultCurrency\": \"EUR\",\n \"defaultTimezone\": \"EUR\",\n \"allowGlobalCollection\": false,\n \"isLiveTransactionAllowed\": true,\n \"allowedPaymentMethods\": [\n \"PayByBank\"\n ],\n \"allowedCurrencies\": [\n \"GBP\",\n \"USD\"\n ]\n },\n {\n \"merchantId\": 4368,\n \"email\": \"user8534@example.com\",\n \"name\": \"testglobex12merchant14249\",\n \"legalName\": \"Test Example Merchants Pvt Ltd\",\n \"regNo\": \"CIN123456789\",\n \"websiteUrl\": \"https://testglobex12.com\",\n \"category\": \"3471\",\n \"iecNo\": \"fdsfkshf\",\n \"tradingStartDate\": \"2022-01-01\",\n \"dateOfIncorporation\": \"2021-06-15\",\n \"tradingAddress\": \"90 Fixture Close\",\n \"tradingCountry\": \"IN\",\n \"tradingState\": \"Maharashtra\",\n \"tradingPostal\": \"400001\",\n \"corporateAddress\": \"456 Corporate Avenue, Ashford\",\n \"corporateCountry\": \"IN\",\n \"corporateState\": \"Maharashtra\",\n \"corporatePostal\": \"400002\",\n \"businessPhone\": \"+912212345678\",\n \"contactPhone\": \"+919876543210\",\n \"contactName\": \"Sam Moreau\",\n \"officerTitle\": \"Director\",\n \"officerName\": \"Sam Moreau\",\n \"defaultCurrency\": \"EUR\",\n \"defaultTimezone\": \"EUR\",\n \"allowGlobalCollection\": false,\n \"isLiveTransactionAllowed\": false,\n \"allowedPaymentMethods\": [\n \"CREDITCARD\"\n ],\n \"allowedCurrencies\": []\n },\n {\n \"merchantId\": 4212,\n \"email\": \"user2009@example.com\",\n \"name\": \"testglobex12merchant15\",\n \"legalName\": \"Test Example Merchants Pvt Ltd\",\n \"regNo\": \"CIN123456789\",\n \"websiteUrl\": \"https://testglobex12.com\",\n \"category\": \"3451\",\n \"iecNo\": \"fdsfkshf\",\n \"tradingStartDate\": \"2022-01-01\",\n \"dateOfIncorporation\": \"2021-06-15\",\n \"tradingAddress\": \"90 Fixture Close\",\n \"tradingCountry\": \"IN\",\n \"tradingState\": \"Maharashtra\",\n \"tradingPostal\": \"400001\",\n \"corporateAddress\": \"456 Corporate Avenue, Ashford\",\n \"corporateCountry\": \"IN\",\n \"corporateState\": \"Maharashtra\",\n \"corporatePostal\": \"400002\",\n \"businessPhone\": \"+912212345678\",\n \"contactPhone\": \"+919876543210\",\n \"contactName\": \"Sam Moreau\",\n \"officerTitle\": \"Director\",\n \"officerName\": \"Sam Moreau\",\n \"defaultCurrency\": \"EUR\",\n \"defaultTimezone\": \"UTC\",\n \"allowGlobalCollection\": true,\n \"isLiveTransactionAllowed\": true,\n \"allowedPaymentMethods\": [\n \"PayByBank\"\n ],\n \"allowedCurrencies\": [\n \"AED\",\n \"GBP\"\n ]\n },\n {\n \"merchantId\": 4213,\n \"email\": \"user2545@example.com\",\n \"name\": \"testglobex12merchant16\",\n \"legalName\": \"Test Example Merchants Pvt Ltd\",\n \"regNo\": \"CIN123456789\",\n \"websiteUrl\": \"https://testglobex12.com\",\n \"category\": \"3451\",\n \"iecNo\": \"fdsfkshf\",\n \"tradingStartDate\": \"2022-01-01\",\n \"dateOfIncorporation\": \"2021-06-15\",\n \"tradingAddress\": \"90 Fixture Close\",\n \"tradingCountry\": \"IN\",\n \"tradingState\": \"Maharashtra\",\n \"tradingPostal\": \"400001\",\n \"corporateAddress\": \"456 Corporate Avenue, Ashford\",\n \"corporateCountry\": \"IN\",\n \"corporateState\": \"Maharashtra\",\n \"corporatePostal\": \"400002\",\n \"businessPhone\": \"+912212345678\",\n \"contactPhone\": \"+919876543210\",\n \"contactName\": \"Sam Moreau\",\n \"officerTitle\": \"Director\",\n \"officerName\": \"Sam Moreau\",\n \"defaultCurrency\": \"EUR\",\n \"defaultTimezone\": \"EUR\",\n \"allowGlobalCollection\": false,\n \"isLiveTransactionAllowed\": true,\n \"allowedPaymentMethods\": [\n \"PayByBank\"\n ],\n \"allowedCurrencies\": [\n \"GBP\",\n \"USD\"\n ]\n },\n {\n \"merchantId\": 4230,\n \"email\": \"user7830@example.com\",\n \"name\": \"user7704\",\n \"legalName\": \"Test Example Merchants Pvt Ltd\",\n \"regNo\": \"CIN123456789\",\n \"websiteUrl\": \"https://testglobex12.com\",\n \"category\": \"3451\",\n \"iecNo\": \"fdsfkshf\",\n \"tradingStartDate\": \"2022-01-01\",\n \"dateOfIncorporation\": \"2021-06-15\",\n \"tradingAddress\": \"90 Fixture Close\",\n \"tradingCountry\": \"IN\",\n \"tradingState\": \"Maharashtra\",\n \"tradingPostal\": \"400001\",\n \"corporateAddress\": \"456 Corporate Avenue, Ashford\",\n \"corporateCountry\": \"IN\",\n \"corporateState\": \"Maharashtra\",\n \"corporatePostal\": \"400002\",\n \"businessPhone\": \"+912212345678\",\n \"contactPhone\": \"+919876543210\",\n \"contactName\": \"Sam Moreau\",\n \"officerTitle\": \"Director\",\n \"officerName\": \"Sam Moreau\",\n \"defaultCurrency\": \"EUR\",\n \"defaultTimezone\": \"UTC\",\n \"allowGlobalCollection\": true,\n \"isLiveTransactionAllowed\": true,\n \"allowedPaymentMethods\": [\n \"PayByBank\"\n ],\n \"allowedCurrencies\": [\n \"AED\",\n \"GBP\"\n ]\n },\n {\n \"merchantId\": 4288,\n \"email\": \"user6222@example.com\",\n \"name\": \"user77041\",\n \"legalName\": \"Test Example Merchants Pvt Ltd\",\n \"regNo\": \"CIN123456789\",\n \"websiteUrl\": \"https://testglobex12.com\",\n \"category\": \"3451\",\n \"iecNo\": \"fdsfkshf\",\n \"tradingStartDate\": \"2022-01-01\",\n \"dateOfIncorporation\": \"2021-06-15\",\n \"tradingAddress\": \"90 Fixture Close\",\n \"tradingCountry\": \"IN\",\n \"tradingState\": \"Maharashtra\",\n \"tradingPostal\": \"400001\",\n \"corporateAddress\": \"456 Corporate Avenue, Ashford\",\n \"corporateCountry\": \"IN\",\n \"corporateState\": \"Maharashtra\",\n \"corporatePostal\": \"400002\",\n \"businessPhone\": \"+912212345678\",\n \"contactPhone\": \"+919876543210\",\n \"contactName\": \"Sam Moreau\",\n \"officerTitle\": \"Director\",\n \"officerName\": \"Sam Moreau\",\n \"defaultCurrency\": \"EUR\",\n \"defaultTimezone\": \"EUR\",\n \"allowGlobalCollection\": false,\n \"isLiveTransactionAllowed\": true,\n \"allowedPaymentMethods\": [\n \"PayByBank\"\n ],\n \"allowedCurrencies\": [\n \"GBP\",\n \"USD\"\n ]\n },\n {\n \"merchantId\": 4382,\n \"email\": \"user4865@example.com\",\n \"name\": \"testglobex12merchant2141\",\n \"legalName\": \"Test Example Merchants Pvt Ltd\",\n \"regNo\": \"CIN123456789\",\n \"websiteUrl\": \"https://testglobex12.com\",\n \"category\": \"3471\",\n \"iecNo\": \"fdsfkshf\",\n \"tradingStartDate\": \"2022-01-01\",\n \"dateOfIncorporation\": \"2021-06-15\",\n \"tradingAddress\": \"90 Fixture Close\",\n \"tradingCountry\": \"IN\",\n \"tradingState\": \"Maharashtra\",\n \"tradingPostal\": \"400001\",\n \"corporateAddress\": \"456 Corporate Avenue, Ashford\",\n \"corporateCountry\": \"IN\",\n \"corporateState\": \"Maharashtra\",\n \"corporatePostal\": \"400002\",\n \"businessPhone\": \"+912212345678\",\n \"contactPhone\": \"+919876543210\",\n \"contactName\": \"Sam Moreau\",\n \"officerTitle\": \"Director\",\n \"officerName\": \"Sam Moreau\",\n \"defaultCurrency\": \"EUR\",\n \"defaultTimezone\": \"EUR\",\n \"allowGlobalCollection\": false,\n \"isLiveTransactionAllowed\": true,\n \"allowedPaymentMethods\": [\n \"PayByBank\"\n ],\n \"allowedCurrencies\": [\n \"USD\",\n \"INR\"\n ]\n },\n {\n \"merchantId\": 4293,\n \"email\": \"user9996@example.com\",\n \"name\": \"testglobex12merchant217\",\n \"legalName\": \"Test Example Merchants Pvt Ltd\",\n \"regNo\": \"CIN123456789\",\n \"websiteUrl\": \"https://testglobex12.com\",\n \"category\": \"3451\",\n \"iecNo\": \"fdsfkshf\",\n \"tradingStartDate\": \"2022-01-01\",\n \"dateOfIncorporation\": \"2021-06-15\",\n \"tradingAddress\": \"90 Fixture Close\",\n \"tradingCountry\": \"IN\",\n \"tradingState\": \"Maharashtra\",\n \"tradingPostal\": \"400001\",\n \"corporateAddress\": \"456 Corporate Avenue, Ashford\",\n \"corporateCountry\": \"IN\",\n \"corporateState\": \"Maharashtra\",\n \"corporatePostal\": \"400002\",\n \"businessPhone\": \"+912212345678\",\n \"contactPhone\": \"+919876543210\",\n \"contactName\": \"Sam Moreau\",\n \"officerTitle\": \"Director\",\n \"officerName\": \"Sam Moreau\",\n \"defaultCurrency\": \"EUR\",\n \"defaultTimezone\": \"UTC\",\n \"allowGlobalCollection\": false,\n \"isLiveTransactionAllowed\": true,\n \"allowedPaymentMethods\": [\n \"PayByBank\"\n ],\n \"allowedCurrencies\": [\n \"AED\",\n \"GBP\"\n ]\n },\n {\n \"merchantId\": 4296,\n \"email\": \"user2010@example.com\",\n \"name\": \"testglobex12merchant219\",\n \"legalName\": \"Test Example Merchants Pvt Ltd\",\n \"regNo\": \"CIN123456789\",\n \"websiteUrl\": \"https://testglobex12.com\",\n \"category\": \"3451\",\n \"iecNo\": \"fdsfkshf\",\n \"tradingStartDate\": \"2022-01-01\",\n \"dateOfIncorporation\": \"2021-06-15\",\n \"tradingAddress\": \"90 Fixture Close\",\n \"tradingCountry\": \"IN\",\n \"tradingState\": \"Maharashtra\",\n \"tradingPostal\": \"400001\",\n \"corporateAddress\": \"456 Corporate Avenue, Ashford\",\n \"corporateCountry\": \"IN\",\n \"corporateState\": \"Maharashtra\",\n \"corporatePostal\": \"400002\",\n \"businessPhone\": \"+912212345678\",\n \"contactPhone\": \"+919876543210\",\n \"contactName\": \"Sam Moreau\",\n \"officerTitle\": \"Director\",\n \"officerName\": \"Sam Moreau\",\n \"defaultCurrency\": \"EUR\",\n \"defaultTimezone\": \"EUR\",\n \"allowGlobalCollection\": false,\n \"isLiveTransactionAllowed\": true,\n \"allowedPaymentMethods\": [\n \"PayByBank\"\n ],\n \"allowedCurrencies\": [\n \"GBP\",\n \"USD\"\n ]\n },\n {\n \"merchantId\": 4311,\n \"email\": \"user1407@example.com\",\n \"name\": \"testglobex12merchant2198\",\n \"legalName\": \"Test Example Merchants Pvt Ltd\",\n \"regNo\": \"CIN123456789\",\n \"websiteUrl\": \"https://testglobex12.com\",\n \"category\": \"3471\",\n \"iecNo\": \"fdsfkshf\",\n \"tradingStartDate\": \"2022-01-01\",\n \"dateOfIncorporation\": \"2021-06-15\",\n \"tradingAddress\": \"90 Fixture Close\",\n \"tradingCountry\": \"IN\",\n \"tradingState\": \"Maharashtra\",\n \"tradingPostal\": \"400001\",\n \"corporateAddress\": \"456 Corporate Avenue, Ashford\",\n \"corporateCountry\": \"IN\",\n \"corporateState\": \"Maharashtra\",\n \"corporatePostal\": \"400002\",\n \"businessPhone\": \"+912212345678\",\n \"contactPhone\": \"+919876543210\",\n \"contactName\": \"Sam Moreau\",\n \"officerTitle\": \"Director\",\n \"officerName\": \"Sam Moreau\",\n \"defaultCurrency\": \"EUR\",\n \"defaultTimezone\": \"EUR\",\n \"allowGlobalCollection\": false,\n \"isLiveTransactionAllowed\": true,\n \"allowedPaymentMethods\": [\n \"PayByBank\"\n ],\n \"allowedCurrencies\": [\n \"GBP\",\n \"USD\"\n ]\n },\n {\n \"merchantId\": 4313,\n \"email\": \"user5270@example.com\",\n \"name\": \"testglobex12merchant2199\",\n \"legalName\": \"Test Example Merchants Pvt Ltd\",\n \"regNo\": \"CIN123456789\",\n \"websiteUrl\": \"https://testglobex12.com\",\n \"category\": \"3471\",\n \"iecNo\": \"fdsfkshf\",\n \"tradingStartDate\": \"2022-01-01\",\n \"dateOfIncorporation\": \"2021-06-15\",\n \"tradingAddress\": \"90 Fixture Close\",\n \"tradingCountry\": \"IN\",\n \"tradingState\": \"Maharashtra\",\n \"tradingPostal\": \"400001\",\n \"corporateAddress\": \"456 Corporate Avenue, Ashford\",\n \"corporateCountry\": \"IN\",\n \"corporateState\": \"Maharashtra\",\n \"corporatePostal\": \"400002\",\n \"businessPhone\": \"+912212345678\",\n \"contactPhone\": \"+919876543210\",\n \"contactName\": \"Sam Moreau\",\n \"officerTitle\": \"Director\",\n \"officerName\": \"Sam Moreau\",\n \"defaultCurrency\": \"EUR\",\n \"defaultTimezone\": \"EUR\",\n \"allowGlobalCollection\": false,\n \"isLiveTransactionAllowed\": true,\n \"allowedPaymentMethods\": [\n \"PayByBank\"\n ],\n \"allowedCurrencies\": [\n \"GBP\",\n \"USD\"\n ]\n },\n {\n \"merchantId\": 4319,\n \"email\": \"user4108@example.com\",\n \"name\": \"testglobex12merchant2200\",\n \"legalName\": \"Test Example Merchants Pvt Ltd\",\n \"regNo\": \"CIN123456789\",\n \"websiteUrl\": \"https://testglobex12.com\",\n \"category\": \"3471\",\n \"iecNo\": \"fdsfkshf\",\n \"tradingStartDate\": \"2022-01-01\",\n \"dateOfIncorporation\": \"2021-06-15\",\n \"tradingAddress\": \"90 Fixture Close\",\n \"tradingCountry\": \"IN\",\n \"tradingState\": \"Maharashtra\",\n \"tradingPostal\": \"400001\",\n \"corporateAddress\": \"456 Corporate Avenue, Ashford\",\n \"corporateCountry\": \"IN\",\n \"corporateState\": \"Maharashtra\",\n \"corporatePostal\": \"400002\",\n \"businessPhone\": \"+912212345678\",\n \"contactPhone\": \"+919876543210\",\n \"contactName\": \"Sam Moreau\",\n \"officerTitle\": \"Director\",\n \"officerName\": \"Sam Moreau\",\n \"defaultCurrency\": \"EUR\",\n \"defaultTimezone\": \"EUR\",\n \"allowGlobalCollection\": false,\n \"isLiveTransactionAllowed\": true,\n \"allowedPaymentMethods\": [\n \"PayByBank\"\n ],\n \"allowedCurrencies\": [\n \"GBP\",\n \"USD\"\n ]\n },\n {\n \"merchantId\": 4322,\n \"email\": \"user3170@example.com\",\n \"name\": \"testglobex12merchant2201\",\n \"legalName\": \"Test Example Merchants Pvt Ltd\",\n \"regNo\": \"CIN123456789\",\n \"websiteUrl\": \"https://testglobex12.com\",\n \"category\": \"3471\",\n \"iecNo\": \"fdsfkshf\",\n \"tradingStartDate\": \"2022-01-01\",\n \"dateOfIncorporation\": \"2021-06-15\",\n \"tradingAddress\": \"90 Fixture Close\",\n \"tradingCountry\": \"IN\",\n \"tradingState\": \"Maharashtra\",\n \"tradingPostal\": \"400001\",\n \"corporateAddress\": \"456 Corporate Avenue, Ashford\",\n \"corporateCountry\": \"IN\",\n \"corporateState\": \"Maharashtra\",\n \"corporatePostal\": \"400002\",\n \"businessPhone\": \"+912212345678\",\n \"contactPhone\": \"+919876543210\",\n \"contactName\": \"Sam Moreau\",\n \"officerTitle\": \"Director\",\n \"officerName\": \"Sam Moreau\",\n \"defaultCurrency\": \"EUR\",\n \"defaultTimezone\": \"EUR\",\n \"allowGlobalCollection\": false,\n \"isLiveTransactionAllowed\": true,\n \"allowedPaymentMethods\": [\n \"PayByBank\"\n ],\n \"allowedCurrencies\": [\n \"GBP\",\n \"USD\"\n ]\n },\n {\n \"merchantId\": 4324,\n \"email\": \"user3084@example.com\",\n \"name\": \"testglobex12merchant2202\",\n \"legalName\": \"Test Example Merchants Pvt Ltd\",\n \"regNo\": \"CIN123456789\",\n \"websiteUrl\": \"https://testglobex12.com\",\n \"category\": \"3471\",\n \"iecNo\": \"fdsfkshf\",\n \"tradingStartDate\": \"2022-01-01\",\n \"dateOfIncorporation\": \"2021-06-15\",\n \"tradingAddress\": \"90 Fixture Close\",\n \"tradingCountry\": \"IN\",\n \"tradingState\": \"Maharashtra\",\n \"tradingPostal\": \"400001\",\n \"corporateAddress\": \"456 Corporate Avenue, Ashford\",\n \"corporateCountry\": \"IN\",\n \"corporateState\": \"Maharashtra\",\n \"corporatePostal\": \"400002\",\n \"businessPhone\": \"+912212345678\",\n \"contactPhone\": \"+919876543210\",\n \"contactName\": \"Sam Moreau\",\n \"officerTitle\": \"Director\",\n \"officerName\": \"Sam Moreau\",\n \"defaultCurrency\": \"EUR\",\n \"defaultTimezone\": \"EUR\",\n \"allowGlobalCollection\": false,\n \"isLiveTransactionAllowed\": true,\n \"allowedPaymentMethods\": [\n \"PayByBank\"\n ],\n \"allowedCurrencies\": [\n \"GBP\",\n \"USD\"\n ]\n },\n {\n \"merchantId\": 4325,\n \"email\": \"user6835@example.com\",\n \"name\": \"testglobex12merchant2203\",\n \"legalName\": \"Test Example Merchants Pvt Ltd\",\n \"regNo\": \"CIN123456789\",\n \"websiteUrl\": \"https://testglobex12.com\",\n \"category\": \"3471\",\n \"iecNo\": \"fdsfkshf\",\n \"tradingStartDate\": \"2022-01-01\",\n \"dateOfIncorporation\": \"2021-06-15\",\n \"tradingAddress\": \"90 Fixture Close\",\n \"tradingCountry\": \"IN\",\n \"tradingState\": \"Maharashtra\",\n \"tradingPostal\": \"400001\",\n \"corporateAddress\": \"456 Corporate Avenue, Ashford\",\n \"corporateCountry\": \"IN\",\n \"corporateState\": \"Maharashtra\",\n \"corporatePostal\": \"400002\",\n \"businessPhone\": \"+912212345678\",\n \"contactPhone\": \"+919876543210\",\n \"contactName\": \"Sam Moreau\",\n \"officerTitle\": \"Director\",\n \"officerName\": \"Sam Moreau\",\n \"defaultCurrency\": \"EUR\",\n \"defaultTimezone\": \"EUR\",\n \"allowGlobalCollection\": false,\n \"isLiveTransactionAllowed\": true,\n \"allowedPaymentMethods\": [\n \"PayByBank\"\n ],\n \"allowedCurrencies\": [\n \"GBP\",\n \"USD\"\n ]\n },\n {\n \"merchantId\": 4328,\n \"email\": \"user2809@example.com\",\n \"name\": \"testglobex12merchant2204\",\n \"legalName\": \"Test Example Merchants Pvt Ltd\",\n \"regNo\": \"CIN123456789\",\n \"websiteUrl\": \"https://testglobex12.com\",\n \"category\": \"3471\",\n \"iecNo\": \"fdsfkshf\",\n \"tradingStartDate\": \"2022-01-01\",\n \"dateOfIncorporation\": \"2021-06-15\",\n \"tradingAddress\": \"90 Fixture Close\",\n \"tradingCountry\": \"IN\",\n \"tradingState\": \"Maharashtra\",\n \"tradingPostal\": \"400001\",\n \"corporateAddress\": \"456 Corporate Avenue, Ashford\",\n \"corporateCountry\": \"IN\",\n \"corporateState\": \"Maharashtra\",\n \"corporatePostal\": \"400002\",\n \"businessPhone\": \"+912212345678\",\n \"contactPhone\": \"+919876543210\",\n \"contactName\": \"Sam Moreau\",\n \"officerTitle\": \"Director\",\n \"officerName\": \"Sam Moreau\",\n \"defaultCurrency\": \"EUR\",\n \"defaultTimezone\": \"EUR\",\n \"allowGlobalCollection\": false,\n \"isLiveTransactionAllowed\": true,\n \"allowedPaymentMethods\": [\n \"PayByBank\"\n ],\n \"allowedCurrencies\": [\n \"GBP\",\n \"USD\"\n ]\n },\n {\n \"merchantId\": 4335,\n \"email\": \"user6174@example.com\",\n \"name\": \"testglobex12merchant2205\",\n \"legalName\": \"Test Example Merchants Pvt Ltd\",\n \"regNo\": \"CIN123456789\",\n \"websiteUrl\": \"https://testglobex12.com\",\n \"category\": \"3471\",\n \"iecNo\": \"fdsfkshf\",\n \"tradingStartDate\": \"2022-01-01\",\n \"dateOfIncorporation\": \"2021-06-15\",\n \"tradingAddress\": \"90 Fixture Close\",\n \"tradingCountry\": \"IN\",\n \"tradingState\": \"Maharashtra\",\n \"tradingPostal\": \"400001\",\n \"corporateAddress\": \"456 Corporate Avenue, Ashford\",\n \"corporateCountry\": \"IN\",\n \"corporateState\": \"Maharashtra\",\n \"corporatePostal\": \"400002\",\n \"businessPhone\": \"+912212345678\",\n \"contactPhone\": \"+919876543210\",\n \"contactName\": \"Sam Moreau\",\n \"officerTitle\": \"Director\",\n \"officerName\": \"Sam Moreau\",\n \"defaultCurrency\": \"EUR\",\n \"defaultTimezone\": \"UTC\",\n \"allowGlobalCollection\": true,\n \"isLiveTransactionAllowed\": true,\n \"allowedPaymentMethods\": [\n \"PayByBank\"\n ],\n \"allowedCurrencies\": [\n \"AED\",\n \"GBP\"\n ]\n },\n {\n \"merchantId\": 4354,\n \"email\": \"user1405@example.com\",\n \"name\": \"testglobex12merchant2206\",\n \"legalName\": \"Test Example Merchants Pvt Ltd\",\n \"regNo\": \"CIN123456789\",\n \"websiteUrl\": \"https://testglobex12.com\",\n \"category\": \"3471\",\n \"iecNo\": \"fdsfkshf\",\n \"tradingStartDate\": \"2022-01-01\",\n \"dateOfIncorporation\": \"2021-06-15\",\n \"tradingAddress\": \"90 Fixture Close\",\n \"tradingCountry\": \"IN\",\n \"tradingState\": \"Maharashtra\",\n \"tradingPostal\": \"400001\",\n \"corporateAddress\": \"456 Corporate Avenue, Ashford\",\n \"corporateCountry\": \"IN\",\n \"corporateState\": \"Maharashtra\",\n \"corporatePostal\": \"400002\",\n \"businessPhone\": \"+912212345678\",\n \"contactPhone\": \"+919876543210\",\n \"contactName\": \"Sam Moreau\",\n \"officerTitle\": \"Director\",\n \"officerName\": \"Sam Moreau\",\n \"defaultCurrency\": \"EUR\",\n \"defaultTimezone\": \"EUR\",\n \"allowGlobalCollection\": false,\n \"isLiveTransactionAllowed\": false,\n \"allowedPaymentMethods\": [\n \"CREDITCARD\"\n ],\n \"allowedCurrencies\": []\n },\n {\n \"merchantId\": 4355,\n \"email\": \"user1110@example.com\",\n \"name\": \"testglobex12merchant2207\",\n \"legalName\": \"Test Example Merchants Pvt Ltd\",\n \"regNo\": \"CIN123456789\",\n \"websiteUrl\": \"https://testglobex12.com\",\n \"category\": \"3471\",\n \"iecNo\": \"fdsfkshf\",\n \"tradingStartDate\": \"2022-01-01\",\n \"dateOfIncorporation\": \"2021-06-15\",\n \"tradingAddress\": \"90 Fixture Close\",\n \"tradingCountry\": \"IN\",\n \"tradingState\": \"Maharashtra\",\n \"tradingPostal\": \"400001\",\n \"corporateAddress\": \"456 Corporate Avenue, Ashford\",\n \"corporateCountry\": \"IN\",\n \"corporateState\": \"Maharashtra\",\n \"corporatePostal\": \"400002\",\n \"businessPhone\": \"+912212345678\",\n \"contactPhone\": \"+919876543210\",\n \"contactName\": \"Sam Moreau\",\n \"officerTitle\": \"Director\",\n \"officerName\": \"Sam Moreau\",\n \"defaultCurrency\": \"EUR\",\n \"defaultTimezone\": \"EUR\",\n \"allowGlobalCollection\": false,\n \"isLiveTransactionAllowed\": false,\n \"allowedPaymentMethods\": [\n \"CREDITCARD\"\n ],\n \"allowedCurrencies\": []\n }\n ],\n \"pagination\": {\n \"currentPage\": 1,\n \"pageSize\": 30,\n \"totalElements\": 44,\n \"totalPages\": 2,\n \"first\": true,\n \"last\": false,\n \"hasNext\": true,\n \"hasPrevious\": false\n }\n },\n \"message\": \"Merchants fetched successfully\",\n \"reqId\": \"12344\"\n}"}],"_postman_id":"936a1979-7369-40bf-9941-c8157e17e1b3"},{"name":"Delete Merchant API","id":"86f513aa-33bb-4928-b75a-8359c217cc1f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{APIKey}}"}]},"isInherited":false},"method":"DELETE","header":[{"key":"requestId","value":"123","type":"text"}],"url":"https://api.paysecure.net/api/v1/external/gc/partner/merchant?merchantId=4229","urlObject":{"path":["external","gc","partner","merchant"],"host":["https://api.paysecure.net/api/v1"],"query":[{"key":"merchantId","value":"4229"}],"variable":[]}},"response":[{"id":"3a740ab0-3201-4a32-b42f-e9888b0f1e45","name":"Delete Merchant API","originalRequest":{"method":"DELETE","header":[{"key":"requestId","value":"123","type":"text"}],"url":{"raw":"https://api.paysecure.net/api/v1/external/gc/partner/merchant?merchantId=4388","host":["https://api.paysecure.net/api/v1"],"path":["external","gc","partner","merchant"],"query":[{"key":"merchantId","value":"4388"}]}},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[{"key":":status","value":200},{"key":"date","value":"Wed, 06 May 2026 13:34:54 GMT"},{"key":"content-type","value":"application/json"},{"key":"x-session-id","value":"a11db102-9844-43d3-b24c-ae6792bbe319"},{"key":"vary","value":"Origin, Access-Control-Request-Method, Access-Control-Request-Headers"},{"key":"server","value":"Hidden"},{"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-frame-options","value":"ALLOW-FROM *"},{"key":"referrer-policy","value":"no-referrer"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"success\",\n \"data\": {\n \"merchantId\": 4388,\n \"username\": \"user4215\",\n \"email\": \"user8017@example.com\"\n },\n \"message\": \"Merchant deleted successfully\",\n \"reqId\": \"123\"\n}"}],"_postman_id":"86f513aa-33bb-4928-b75a-8359c217cc1f"},{"name":"Create Merchant API","id":"ab1ea978-a97e-40ea-b109-059d1e84f992","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{APIKey}}"}]},"isInherited":false},"method":"POST","header":[{"key":"requestId","value":"abcd","type":"text"}],"body":{"mode":"raw","raw":"{\n \"username\": \"user7704\",\n \"mcc\": 3451,\n \"iecNo\": \"fdsfkshf\",\n \"allowGlobalCollection\": true,\n \"legalName\": \"Test Example Merchants Pvt Ltd\",\n \"name\": \"Test Emerson Merchants 2\",\n \"regNo\": \"CIN123456789\",\n \"emailId\": \"user7830@example.com\",\n \"websiteUrl\": \"https://testglobex12.com\",\n \"tradingStartDate\": \"2022-01-01\",\n \"dateOfIncorporation\": \"2021-06-15\",\n \"tradingAddress\": \"90 Fixture Close\",\n \"tradingCountry\": \"IN\",\n \"tradingState\": \"Maharashtra\",\n \"tradingPostal\": \"400001\",\n \"corporateAddress\": \"456 Corporate Avenue, Ashford\",\n \"corporateCountry\": \"IN\",\n \"corporateState\": \"Maharashtra\",\n \"corporatePostal\": \"400002\",\n \"businessPhone\": \"+912212345678\",\n \"contactPhone\": \"+919876543210\",\n \"contactName\": \"Sam Moreau\",\n \"officerTitle\": \"Director\",\n \"officerName\": \"Sam Moreau\",\n \"defaultCurrency\": \"EUR\",\n \"defaultTimezone\": \"UTC\",\n \"allowedPaymentMethods\": [\n \"PayByBank\"\n ],\n \"allowedCurrencies\": [\"GBP\", \"USD\"],\n \"isLiveTransactionAllowed\": true\n}","options":{"raw":{"language":"json"}}},"url":"https://api.paysecure.net/api/v1/external/gc/partner/merchant","urlObject":{"path":["external","gc","partner","merchant"],"host":["https://api.paysecure.net/api/v1"],"query":[],"variable":[]}},"response":[{"id":"6f6d7e84-9c7d-47bb-a13b-9e0c54449ced","name":"Create Merchant API","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","disabled":true},{"key":"requestId","value":"abcd","type":"text"}],"body":{"mode":"raw","raw":"{\n \"username\": \"user4215\",\n \"mcc\": 3451,\n \"iecNo\": \"fdsfkshf\",\n \"allowGlobalCollection\": true,\n \"legalName\": \"Test Example Merchants Pvt Ltd\",\n \"name\": \"Test Emerson Merchants 2\",\n \"regNo\": \"CIN123456789\",\n \"emailId\": \"user8017@example.com\",\n \"websiteUrl\": \"https://testglobex12.com\",\n \"tradingStartDate\": \"2022-01-01\",\n \"dateOfIncorporation\": \"2021-06-15\",\n \"tradingAddress\": \"90 Fixture Close\",\n \"tradingCountry\": \"IN\",\n \"tradingState\": \"Maharashtra\",\n \"tradingPostal\": \"400001\",\n \"corporateAddress\": \"456 Corporate Avenue, Ashford\",\n \"corporateCountry\": \"IN\",\n \"corporateState\": \"Maharashtra\",\n \"corporatePostal\": \"400002\",\n \"businessPhone\": \"+912212345678\",\n \"contactPhone\": \"+919876543210\",\n \"contactName\": \"Sam Moreau\",\n \"officerTitle\": \"Director\",\n \"officerName\": \"Sam Moreau\",\n \"defaultCurrency\": \"EUR\",\n \"defaultTimezone\": \"UTC\",\n \"allowedPaymentMethods\": [\n \"PayByBank\"\n ],\n \"allowedCurrencies\": [\"GBP\", \"USD\"],\n \"isLiveTransactionAllowed\": true\n}","options":{"raw":{"language":"json"}}},"url":"https://api.paysecure.net/api/v1/external/gc/partner/merchant"},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[{"key":":status","value":200},{"key":"date","value":"Wed, 06 May 2026 13:35:01 GMT"},{"key":"content-type","value":"application/json"},{"key":"x-session-id","value":"eef75515-b968-4e21-9665-ced7a6fe00d7"},{"key":"vary","value":"Origin, Access-Control-Request-Method, Access-Control-Request-Headers"},{"key":"server","value":"Hidden"},{"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-frame-options","value":"ALLOW-FROM *"},{"key":"referrer-policy","value":"no-referrer"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"success\",\n \"data\": {\n \"merchantId\": 4389,\n \"username\": \"user4215\",\n \"email\": \"user8017@example.com\"\n },\n \"message\": \"Merchant created successfully\",\n \"reqId\": \"abcd\"\n}"}],"_postman_id":"ab1ea978-a97e-40ea-b109-059d1e84f992"},{"name":"Update merchant","id":"e4bb07cb-0992-4875-8b69-8890101f7047","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{APIKey}}"}]},"isInherited":false},"method":"PUT","header":[{"key":"requestId","value":"123","type":"text"}],"body":{"mode":"raw","raw":"{\n \"legalName\": \"Test Example Merchants Pvt Ltd\",\n \"regNo\": \"CIN123456789\",\n \"websiteUrl\": \"https://testglobex12.com\",\n \"iecNo\": \"fdsfkshf\",\n \"tradingStartDate\": \"2022-01-01\",\n \"dateOfIncorporation\": \"2021-06-15\",\n \"tradingAddress\": \"90 Fixture Close\",\n \"tradingCountry\": \"IN\",\n \"tradingState\": \"Maharashtra\",\n \"tradingPostal\": \"400001\",\n \"corporateAddress\": \"456 Corporate Avenue, Ashford\",\n \"corporateCountry\": \"IN\",\n \"corporateState\": \"Maharashtra\",\n \"corporatePostal\": \"400002\",\n \"businessPhone\": \"+912212345678\",\n \"contactPhone\": \"+919876543210\",\n \"contactName\": \"Sam Moreau\",\n \"officerTitle\": \"Director\",\n \"officerName\": \"Sam Moreau\",\n \"defaultCurrency\": \"EUR\",\n \"defaultTimezone\": \"UTC\",\n \"allowedPaymentMethods\": [\n \"PayByBank\"\n ],\n \"allowedCurrencies\": [\"GBP\", \"AED\"],\n \"isLiveTransactionAllowed\": true\n}","options":{"raw":{"language":"json"}}},"url":"https://api.paysecure.net/api/v1/external/gc/partner/merchant/4230","urlObject":{"path":["external","gc","partner","merchant","4230"],"host":["https://api.paysecure.net/api/v1"],"query":[],"variable":[]}},"response":[{"id":"cbb51b76-1084-499a-9728-79578c566521","name":"Update merchant","originalRequest":{"method":"PUT","header":[{"key":"requestId","value":"123","type":"text"}],"body":{"mode":"raw","raw":"{\n \"legalName\": \"Test Example Merchants Pvt Ltd\",\n \"regNo\": \"CIN123456789\",\n \"websiteUrl\": \"https://testglobex12.com\",\n \"iecNo\": \"fdsfkshf\",\n \"tradingStartDate\": \"2022-01-01\",\n \"dateOfIncorporation\": \"2021-06-15\",\n \"tradingAddress\": \"90 Fixture Close\",\n \"tradingCountry\": \"IN\",\n \"tradingState\": \"Maharashtra\",\n \"tradingPostal\": \"400001\",\n \"corporateAddress\": \"456 Corporate Avenue, Ashford\",\n \"corporateCountry\": \"IN\",\n \"corporateState\": \"Maharashtra\",\n \"corporatePostal\": \"400002\",\n \"businessPhone\": \"+912212345678\",\n \"contactPhone\": \"+919876543210\",\n \"contactName\": \"Sam Moreau\",\n \"officerTitle\": \"Director\",\n \"officerName\": \"Sam Moreau\",\n \"defaultCurrency\": \"EUR\",\n \"defaultTimezone\": \"UTC\",\n \"allowedPaymentMethods\": [\n \"PayByBank\"\n ],\n \"allowedCurrencies\": [\"GBP\", \"AED\"],\n \"isLiveTransactionAllowed\": true\n}","options":{"raw":{"language":"json"}}},"url":"https://api.paysecure.net/api/v1/external/gc/partner/merchant/4389"},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[{"key":":status","value":200},{"key":"date","value":"Wed, 06 May 2026 13:35:11 GMT"},{"key":"content-type","value":"application/json"},{"key":"x-session-id","value":"0616f484-fb7c-475b-b8b3-53dff2a58fb3"},{"key":"vary","value":"Origin, Access-Control-Request-Method, Access-Control-Request-Headers"},{"key":"server","value":"Hidden"},{"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-frame-options","value":"ALLOW-FROM *"},{"key":"referrer-policy","value":"no-referrer"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"success\",\n \"data\": {\n \"merchantId\": 4389\n },\n \"message\": \"Merchant details updated successfully\",\n \"reqId\": \"123\"\n}"}],"_postman_id":"e4bb07cb-0992-4875-8b69-8890101f7047"},{"name":"Create Merchant API Token","id":"dd7aa06b-7751-48fc-8b54-55081d54c1c6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{APIKey}}"}]},"isInherited":false},"method":"POST","header":[{"key":"requestId","value":"abcd","type":"text"}],"body":{"mode":"raw","raw":"{\n \"apiLabel\": \"testlabel18\",\n \"isSandbox\": false\n}","options":{"raw":{"language":"json"}}},"url":"https://api.paysecure.net/api/v1/external/gc/partner/merchant/4230/api-key","urlObject":{"path":["external","gc","partner","merchant","4230","api-key"],"host":["https://api.paysecure.net/api/v1"],"query":[],"variable":[]}},"response":[{"id":"32f6a300-bf0c-41b6-a587-7863a2e689ff","name":"Create Merchant API Token","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","disabled":true},{"key":"requestId","value":"abcd","type":"text"}],"body":{"mode":"raw","raw":"{\n \"apiLabel\": \"testlabel18\",\n \"isSandbox\": false\n}","options":{"raw":{"language":"json"}}},"url":"https://api.paysecure.net/api/v1/external/gc/partner/merchant/4389/api-key"},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[{"key":":status","value":200},{"key":"date","value":"Wed, 06 May 2026 13:35:28 GMT"},{"key":"content-type","value":"application/json"},{"key":"x-session-id","value":"494f6297-203a-49f0-9fa8-aed7331e7558"},{"key":"vary","value":"Origin, Access-Control-Request-Method, Access-Control-Request-Headers"},{"key":"server","value":"Hidden"},{"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-frame-options","value":"ALLOW-FROM *"},{"key":"referrer-policy","value":"no-referrer"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"success\",\n \"data\": {\n \"merchantId\": 4389,\n \"apiKey\": \"0000000000000000000000000000000000000000000000000000000000000000\",\n \"isSandbox\": false\n },\n \"message\": \"Merchant token generated successfully\",\n \"reqId\": \"abcd\"\n}"}],"_postman_id":"dd7aa06b-7751-48fc-8b54-55081d54c1c6"},{"name":"Get single merchant","id":"f43c7c21-8609-4ba6-9741-a6aab904a776","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{APIKey}}"}]},"isInherited":false},"method":"GET","header":[{"key":"requestId","value":"123456","type":"text"}],"url":"https://api.paysecure.net/api/v1/external/gc/partner/merchant/4230","urlObject":{"path":["external","gc","partner","merchant","4230"],"host":["https://api.paysecure.net/api/v1"],"query":[],"variable":[]}},"response":[{"id":"66012aa6-9ca4-4239-8858-bee7ce379a2a","name":"Get single merchant","originalRequest":{"method":"GET","header":[{"key":"requestId","value":"123456","type":"text"}],"url":"https://api.paysecure.net/api/v1/external/gc/partner/merchant/4230"},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[{"key":":status","value":200},{"key":"date","value":"Wed, 06 May 2026 13:37:16 GMT"},{"key":"content-type","value":"application/json"},{"key":"x-session-id","value":"385e33c8-39d1-4031-9442-eb0f1adfb46d"},{"key":"vary","value":"Origin, Access-Control-Request-Method, Access-Control-Request-Headers"},{"key":"server","value":"Hidden"},{"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-frame-options","value":"ALLOW-FROM *"},{"key":"referrer-policy","value":"no-referrer"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"success\",\n \"data\": {\n \"merchantId\": 4230,\n \"email\": \"user7830@example.com\",\n \"name\": \"user7704\",\n \"legalName\": \"Test Example Merchants Pvt Ltd\",\n \"regNo\": \"CIN123456789\",\n \"websiteUrl\": \"https://testglobex12.com\",\n \"category\": \"3451\",\n \"iecNo\": \"fdsfkshf\",\n \"tradingStartDate\": \"2022-01-01\",\n \"dateOfIncorporation\": \"2021-06-15\",\n \"tradingAddress\": \"90 Fixture Close\",\n \"tradingCountry\": \"IN\",\n \"tradingState\": \"Maharashtra\",\n \"tradingPostal\": \"400001\",\n \"corporateAddress\": \"456 Corporate Avenue, Ashford\",\n \"corporateCountry\": \"IN\",\n \"corporateState\": \"Maharashtra\",\n \"corporatePostal\": \"400002\",\n \"businessPhone\": \"+912212345678\",\n \"contactPhone\": \"+919876543210\",\n \"contactName\": \"Sam Moreau\",\n \"officerTitle\": \"Director\",\n \"officerName\": \"Sam Moreau\",\n \"defaultCurrency\": \"EUR\",\n \"defaultTimezone\": \"UTC\",\n \"allowGlobalCollection\": true,\n \"isLiveTransactionAllowed\": true,\n \"allowedPaymentMethods\": [\n \"PayByBank\"\n ],\n \"allowedCurrencies\": [\n \"AED\",\n \"GBP\"\n ]\n },\n \"message\": \"Merchant details fetched successfully\",\n \"reqId\": \"123456\"\n}"},{"id":"5e1d8994-1c03-48e4-b79b-990f6045e4d4","name":"Get single merchant","originalRequest":{"method":"GET","header":[{"key":"requestId","value":"123456","type":"text"}],"url":"https://api.paysecure.net/api/v1/external/gc/partner/merchant/4230"},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[{"key":":status","value":200},{"key":"date","value":"Wed, 06 May 2026 13:37:16 GMT"},{"key":"content-type","value":"application/json"},{"key":"x-session-id","value":"385e33c8-39d1-4031-9442-eb0f1adfb46d"},{"key":"vary","value":"Origin, Access-Control-Request-Method, Access-Control-Request-Headers"},{"key":"server","value":"Hidden"},{"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-frame-options","value":"ALLOW-FROM *"},{"key":"referrer-policy","value":"no-referrer"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"success\",\n \"data\": {\n \"merchantId\": 4230,\n \"email\": \"user7830@example.com\",\n \"name\": \"user7704\",\n \"legalName\": \"Test Example Merchants Pvt Ltd\",\n \"regNo\": \"CIN123456789\",\n \"websiteUrl\": \"https://testglobex12.com\",\n \"category\": \"3451\",\n \"iecNo\": \"fdsfkshf\",\n \"tradingStartDate\": \"2022-01-01\",\n \"dateOfIncorporation\": \"2021-06-15\",\n \"tradingAddress\": \"90 Fixture Close\",\n \"tradingCountry\": \"IN\",\n \"tradingState\": \"Maharashtra\",\n \"tradingPostal\": \"400001\",\n \"corporateAddress\": \"456 Corporate Avenue, Ashford\",\n \"corporateCountry\": \"IN\",\n \"corporateState\": \"Maharashtra\",\n \"corporatePostal\": \"400002\",\n \"businessPhone\": \"+912212345678\",\n \"contactPhone\": \"+919876543210\",\n \"contactName\": \"Sam Moreau\",\n \"officerTitle\": \"Director\",\n \"officerName\": \"Sam Moreau\",\n \"defaultCurrency\": \"EUR\",\n \"defaultTimezone\": \"UTC\",\n \"allowGlobalCollection\": true,\n \"isLiveTransactionAllowed\": true,\n \"allowedPaymentMethods\": [\n \"PayByBank\"\n ],\n \"allowedCurrencies\": [\n \"AED\",\n \"GBP\"\n ]\n },\n \"message\": \"Merchant details fetched successfully\",\n \"reqId\": \"123456\"\n}"}],"_postman_id":"f43c7c21-8609-4ba6-9741-a6aab904a776"},{"name":"Get Missing invoice transactions","id":"d5fb0496-4ed2-4bc2-a755-8d356d5d2dd7","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{APIKey}}"}]},"isInherited":false},"method":"GET","header":[{"key":"requestId","value":"123456","type":"text"}],"url":"https://api.paysecure.net/api/v1/external/gc/partner/transactions/missing-invoice?page=1&size=4","urlObject":{"path":["external","gc","partner","transactions","missing-invoice"],"host":["https://api.paysecure.net/api/v1"],"query":[{"disabled":true,"key":"merchantId","value":"4151"},{"key":"page","value":"1"},{"key":"size","value":"4"}],"variable":[]}},"response":[{"id":"061d6de5-dc3e-4b88-8e67-76266089344a","name":"Get Missing invoice transactions","originalRequest":{"method":"GET","header":[{"key":"requestId","value":"123456","type":"text"}],"url":{"raw":"https://api.paysecure.net/api/v1/external/gc/partner/transactions/missing-invoice?page=1&size=4","host":["https://api.paysecure.net/api/v1"],"path":["external","gc","partner","transactions","missing-invoice"],"query":[{"key":"merchantId","value":"4151","disabled":true},{"key":"page","value":"1"},{"key":"size","value":"4"}]}},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[{"key":":status","value":200},{"key":"date","value":"Wed, 06 May 2026 13:37:38 GMT"},{"key":"content-type","value":"application/json"},{"key":"x-session-id","value":"c523e046-fdfc-402d-8148-95fd2a1aa935"},{"key":"vary","value":"Origin, Access-Control-Request-Method, Access-Control-Request-Headers"},{"key":"server","value":"Hidden"},{"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-frame-options","value":"ALLOW-FROM *"},{"key":"referrer-policy","value":"no-referrer"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"success\",\n \"data\": {\n \"transactions\": [\n {\n \"transactionId\": \"69d79150aa6d618c9b4e5da1\",\n \"amount\": 1,\n \"currency\": \"GBP\",\n \"createdDate\": 1775735120\n },\n {\n \"transactionId\": \"69d627aafbb9070a716e284b\",\n \"amount\": 1,\n \"currency\": \"GBP\",\n \"createdDate\": 1775642538\n },\n {\n \"transactionId\": \"69d6277afbb9070a716e252b\",\n \"amount\": 1,\n \"currency\": \"GBP\",\n \"createdDate\": 1775642490\n },\n {\n \"transactionId\": \"69cced964235594c815952fc\",\n \"amount\": 1,\n \"currency\": \"GBP\",\n \"createdDate\": 1775037848\n }\n ],\n \"pagination\": {\n \"currentPage\": 1,\n \"pageSize\": 4,\n \"totalElements\": 6,\n \"totalPages\": 2,\n \"first\": true,\n \"last\": false,\n \"hasNext\": true,\n \"hasPrevious\": false\n }\n },\n \"message\": \"Missing invoice transactions fetched successfully\",\n \"reqId\": \"123456\"\n}"}],"_postman_id":"d5fb0496-4ed2-4bc2-a755-8d356d5d2dd7"},{"name":"Get Settlement Data","id":"0d470f83-7416-423f-a2cf-998b2d51feec","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{APIKey}}"}]},"isInherited":false},"method":"GET","header":[{"key":"requestId","value":"123456","type":"text"}],"url":"https://api.paysecure.net/api/v1/external/gc/partner/settlements?fromDate=2025-01-01&toDate=2026-01-01&status=settled&pageNo=1&size=10","urlObject":{"path":["external","gc","partner","settlements"],"host":["https://api.paysecure.net/api/v1"],"query":[{"key":"fromDate","value":"2025-01-01"},{"key":"toDate","value":"2026-01-01"},{"key":"status","value":"settled"},{"key":"pageNo","value":"1"},{"key":"size","value":"10"}],"variable":[]}},"response":[{"id":"b8e63efe-cc96-46b4-b437-b6837a2f9e83","name":"Get Settlement Data","originalRequest":{"method":"GET","header":[{"key":"requestId","value":"123456","type":"text"}],"url":{"raw":"https://api.paysecure.net/api/v1/external/gc/partner/settlements?fromDate=2025-01-01&toDate=2026-01-01&status=settled&pageNo=1&size=10","host":["https://api.paysecure.net/api/v1"],"path":["external","gc","partner","settlements"],"query":[{"key":"fromDate","value":"2025-01-01"},{"key":"toDate","value":"2026-01-01"},{"key":"status","value":"settled"},{"key":"pageNo","value":"1"},{"key":"size","value":"10"}]}},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[{"key":":status","value":200},{"key":"date","value":"Wed, 06 May 2026 13:37:44 GMT"},{"key":"content-type","value":"application/json"},{"key":"x-session-id","value":"8e5c11fd-a1e1-4798-a9a5-9869a1b8195b"},{"key":"vary","value":"Origin, Access-Control-Request-Method, Access-Control-Request-Headers"},{"key":"server","value":"Hidden"},{"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-frame-options","value":"ALLOW-FROM *"},{"key":"referrer-policy","value":"no-referrer"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"success\",\n \"data\": {\n \"settlements\": [\n {\n \"settlementId\": \"1234\",\n \"amount\": 100,\n \"currency\": \"USD\",\n \"status\": \"settled\",\n \"settledOn\": -41795\n },\n {\n \"settlementId\": \"5678\",\n \"amount\": 100,\n \"currency\": \"USD\",\n \"status\": \"settled\",\n \"settledOn\": -41795\n }\n ],\n \"pagination\": {\n \"currentPage\": 1,\n \"pageSize\": 2,\n \"totalElements\": 2,\n \"totalPages\": 1,\n \"first\": true,\n \"last\": true,\n \"hasNext\": false,\n \"hasPrevious\": false\n }\n },\n \"reqId\": \"123456\"\n}"}],"_postman_id":"0d470f83-7416-423f-a2cf-998b2d51feec"},{"name":"Delete merchant token","id":"75b0b5d0-696b-4b39-8b42-88594e410924","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{APIKey}}"}]},"isInherited":false},"method":"DELETE","header":[{"key":"requestId","value":"123","type":"text"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"https://api.paysecure.net/api/v1/external/gc/partner/merchant/4230/api-key?token={{APIKeyToRevoke}}","urlObject":{"path":["external","gc","partner","merchant","4230","api-key"],"host":["https://api.paysecure.net/api/v1"],"query":[{"key":"token","value":"{{APIKeyToRevoke}}"}],"variable":[]}},"response":[{"id":"170e2a24-4bae-436f-9aa1-589a2ee0c41a","name":"Delete merchant token","originalRequest":{"method":"DELETE","header":[{"key":"requestId","value":"123","type":"text"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":{"raw":"https://api.paysecure.net/api/v1/external/gc/partner/merchant/4389/api-key?token={{APIKeyToRevoke}}","host":["https://api.paysecure.net/api/v1"],"path":["external","gc","partner","merchant","4389","api-key"],"query":[{"key":"token","value":"{{APIKeyToRevoke}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[{"key":":status","value":200},{"key":"date","value":"Wed, 06 May 2026 13:36:03 GMT"},{"key":"content-type","value":"application/json"},{"key":"x-session-id","value":"cd421d89-df9a-4817-9538-f8520a966043"},{"key":"vary","value":"Origin, Access-Control-Request-Method, Access-Control-Request-Headers"},{"key":"server","value":"Hidden"},{"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-frame-options","value":"ALLOW-FROM *"},{"key":"referrer-policy","value":"no-referrer"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"success\",\n \"data\": {\n \"merchantId\": 4389,\n \"username\": \"user4215\",\n \"email\": null\n },\n \"message\": \"Merchant token deleted successfully\",\n \"reqId\": \"123\"\n}"}],"_postman_id":"75b0b5d0-696b-4b39-8b42-88594e410924"},{"name":"Create brand ID","id":"e8bc1810-5063-461c-8ae7-8720671bdfb1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{APIKey}}"}]},"isInherited":false},"method":"POST","header":[{"key":"requestId","value":"123","type":"text"}],"body":{"mode":"raw","raw":"{\n \"name\": \"Sample brand name1\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.paysecure.net/api/v1/external/gc/partner/merchant/4230/brand","urlObject":{"path":["external","gc","partner","merchant","4230","brand"],"host":["https://api.paysecure.net/api/v1"],"query":[],"variable":[]}},"response":[{"id":"28881be6-a75b-4f05-a3ab-bbd11b402525","name":"Create brand ID","originalRequest":{"method":"POST","header":[{"key":"requestId","value":"123","type":"text"}],"body":{"mode":"raw","raw":"{\n \"name\": \"Sample brand name2\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.paysecure.net/api/v1/external/gc/partner/merchant/4230/brand"},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[{"key":":status","value":200},{"key":"date","value":"Wed, 06 May 2026 13:36:21 GMT"},{"key":"content-type","value":"application/json"},{"key":"x-session-id","value":"b9369e86-cbe6-4946-9c17-1570ce137562"},{"key":"vary","value":"Origin, Access-Control-Request-Method, Access-Control-Request-Headers"},{"key":"server","value":"Hidden"},{"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-frame-options","value":"ALLOW-FROM *"},{"key":"referrer-policy","value":"no-referrer"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"success\",\n \"data\": {\n \"id\": 1000077,\n \"name\": \"Sample brand name2\",\n \"brandId\": \"your-brand-id\",\n \"merchantId\": 4230\n },\n \"message\": \"Brand created successfully\",\n \"reqId\": \"123\"\n}"}],"_postman_id":"e8bc1810-5063-461c-8ae7-8720671bdfb1"},{"name":"Delete brand ID","id":"25989995-bbe9-4391-976f-7ad8ece5e9fd","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{APIKey}}"}]},"isInherited":false},"method":"DELETE","header":[{"key":"requestId","value":"123","type":"text"}],"url":"https://api.paysecure.net/api/v1/external/gc/partner/merchant/4230/brand?brandId=your-brand-id","urlObject":{"path":["external","gc","partner","merchant","4230","brand"],"host":["https://api.paysecure.net/api/v1"],"query":[{"key":"brandId","value":"your-brand-id"}],"variable":[]}},"response":[{"id":"472b7df1-b95a-4382-9d6b-297db44f8a23","name":"Delete brand ID","originalRequest":{"method":"DELETE","header":[{"key":"requestId","value":"123","type":"text"}],"url":{"raw":"https://api.paysecure.net/api/v1/external/gc/partner/merchant/4230/brand?brandId=1d01b37c-bd35-4727-85f9-f0b1448dad67","host":["https://api.paysecure.net/api/v1"],"path":["external","gc","partner","merchant","4230","brand"],"query":[{"key":"brandId","value":"1d01b37c-bd35-4727-85f9-f0b1448dad67"}]}},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[{"key":":status","value":200},{"key":"date","value":"Wed, 06 May 2026 13:36:32 GMT"},{"key":"content-type","value":"application/json"},{"key":"x-session-id","value":"3757deab-5fa7-4a78-a097-e887cd1b3b04"},{"key":"vary","value":"Origin, Access-Control-Request-Method, Access-Control-Request-Headers"},{"key":"server","value":"Hidden"},{"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-frame-options","value":"ALLOW-FROM *"},{"key":"referrer-policy","value":"no-referrer"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"success\",\n \"data\": {\n \"id\": 1000077,\n \"name\": \"Sample brand name2\",\n \"brandId\": \"your-brand-id\",\n \"merchantId\": 4230\n },\n \"message\": \"Brand deleted successfully\",\n \"reqId\": \"123\"\n}"}],"_postman_id":"25989995-bbe9-4391-976f-7ad8ece5e9fd"},{"name":"Request global account","id":"ec8af01e-aae8-4c45-ab60-0f6faec716a5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{APIKey}}"}]},"isInherited":false},"method":"POST","header":[{"key":"requestId","value":"12331","type":"text"}],"body":{"mode":"raw","raw":"{\n \"country\": \"AE\",\n \"currency\": \"AED\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.paysecure.net/api/v1/external/gc/partner/merchant/4230/global-account","urlObject":{"path":["external","gc","partner","merchant","4230","global-account"],"host":["https://api.paysecure.net/api/v1"],"query":[],"variable":[]}},"response":[{"id":"25b4e5db-1563-4f11-8c23-6af18e06a663","name":"Request global account","originalRequest":{"method":"POST","header":[{"key":"requestId","value":"12331","type":"text"}],"body":{"mode":"raw","raw":"{\n \"country\": \"AE\",\n \"currency\": \"GBP\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.paysecure.net/api/v1/external/gc/partner/merchant/4212/global-account"},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[{"key":":status","value":200},{"key":"date","value":"Wed, 06 May 2026 13:37:03 GMT"},{"key":"content-type","value":"application/json"},{"key":"x-session-id","value":"4327d3bb-c09d-4a23-aca8-2bcefbf6e8e9"},{"key":"vary","value":"Origin, Access-Control-Request-Method, Access-Control-Request-Headers"},{"key":"server","value":"Hidden"},{"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-frame-options","value":"ALLOW-FROM *"},{"key":"referrer-policy","value":"no-referrer"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"success\",\n \"data\": {\n \"country\": \"AE\",\n \"currency\": \"GBP\",\n \"status\": \"pending\",\n \"accountNo\": \"GC-AE-GBP-20260506-980-CED9D5\",\n \"createdOn\": 1778074623\n },\n \"message\": \"Global account request submitted\"\n}"}],"_postman_id":"ec8af01e-aae8-4c45-ab60-0f6faec716a5"},{"name":"Get global accounts","id":"4f3e0875-e940-41b9-a180-95a08f8afbe9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{APIKey}}"}]},"isInherited":false},"method":"GET","header":[{"key":"requestId","value":"12331","type":"text"}],"url":"https://api.paysecure.net/api/v1/external/gc/partner/merchant/4212/global-account","urlObject":{"path":["external","gc","partner","merchant","4212","global-account"],"host":["https://api.paysecure.net/api/v1"],"query":[],"variable":[]}},"response":[{"id":"277eabd2-39dd-4818-bf4c-5895539cc8d4","name":"Get global accounts","originalRequest":{"method":"GET","header":[{"key":"requestId","value":"12331","type":"text"}],"url":"https://api.paysecure.net/api/v1/external/gc/partner/merchant/4212/global-account"},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[{"key":":status","value":200},{"key":"date","value":"Wed, 06 May 2026 13:37:08 GMT"},{"key":"content-type","value":"application/json"},{"key":"x-session-id","value":"a04fb141-c63f-4ec2-9bf1-51f7a12e456a"},{"key":"vary","value":"Origin, Access-Control-Request-Method, Access-Control-Request-Headers"},{"key":"server","value":"Hidden"},{"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-frame-options","value":"ALLOW-FROM *"},{"key":"referrer-policy","value":"no-referrer"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"success\",\n \"data\": [\n {\n \"country\": \"FR\",\n \"currency\": \"GBP\",\n \"status\": \"pending\",\n \"accountNo\": \"GC-FR-GBP-20260409-980-FE2004\",\n \"createdOn\": 1775732111\n },\n {\n \"country\": \"AE\",\n \"currency\": \"AED\",\n \"status\": \"active\",\n \"accountNo\": \"GC-AE-AED-20260504-980-54FA8D\",\n \"createdOn\": 1777887002\n },\n {\n \"country\": \"AE\",\n \"currency\": \"GBP\",\n \"status\": \"pending\",\n \"accountNo\": \"GC-AE-GBP-20260506-980-CED9D5\",\n \"createdOn\": 1778074623\n }\n ],\n \"message\": \"Global collection fetched successfully\",\n \"reqId\": \"12331\"\n}"}],"_postman_id":"4f3e0875-e940-41b9-a180-95a08f8afbe9"},{"name":"bulk update invoice no","id":"01cd5987-231c-49f3-8cdb-b0e0c3628c86","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{APIKey}}"}]},"isInherited":false},"method":"PATCH","header":[{"key":"requestId","value":"abcd","type":"text"}],"body":{"mode":"raw","raw":"[\n {\n \"transactionId\": \"69cceeba4235594c8159559f\",\n \"invoiceNo\": \"inv123\"\n },\n {\n \"transactionId\": \"temp\",\n \"invoiceNo\": \"inv123\"\n }\n]","options":{"raw":{"language":"json"}}},"url":"https://api.paysecure.net/api/v1/external/gc/partner/transactions/invoice","urlObject":{"path":["external","gc","partner","transactions","invoice"],"host":["https://api.paysecure.net/api/v1"],"query":[],"variable":[]}},"response":[{"id":"0623a3ee-ca7a-4d41-872d-c21ff07e022c","name":"bulk update invoice no","originalRequest":{"method":"PATCH","header":[{"key":"Content-Type","value":"application/json","disabled":true},{"key":"requestId","value":"abcd","type":"text"}],"body":{"mode":"raw","raw":"[\n {\n \"transactionId\": \"69cceeba4235594c8159559f\",\n \"invoiceNo\": \"inv123\"\n },\n {\n \"transactionId\": \"temp\",\n \"invoiceNo\": \"inv123\"\n }\n]","options":{"raw":{"language":"json"}}},"url":"https://api.paysecure.net/api/v1/external/gc/partner/transactions/invoice"},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[{"key":":status","value":200},{"key":"date","value":"Wed, 06 May 2026 13:37:12 GMT"},{"key":"content-type","value":"application/json"},{"key":"x-session-id","value":"e19be498-d831-4f02-861b-62da1907e1b4"},{"key":"vary","value":"Origin, Access-Control-Request-Method, Access-Control-Request-Headers"},{"key":"server","value":"Hidden"},{"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-frame-options","value":"ALLOW-FROM *"},{"key":"referrer-policy","value":"no-referrer"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"success\",\n \"data\": {\n \"updatedCount\": 1,\n \"skippedTransactionIds\": [\n \"temp\"\n ]\n },\n \"message\": \"Bulk invoice update completed\",\n \"reqId\": \"abcd\"\n}"}],"_postman_id":"01cd5987-231c-49f3-8cdb-b0e0c3628c86"}],"id":"d0600644-3dc0-4b4d-a007-13fa49ac4515","_postman_id":"d0600644-3dc0-4b4d-a007-13fa49ac4515","description":""},{"name":"Payout Manual Review","item":[{"name":"Concepts","item":[],"id":"7522ed19-a307-4ec0-bc63-aba3bbae1de9","description":"

Overview

Manual review is a control step for payouts (money going out to your customers or beneficiaries). When a payout is created it may be held in the pending_review status instead of being sent straight to the payout processor. This happens when the payout is flagged — for example by a risk rule, an amount threshold, or a merchant-profile setting.

While a payout is in pending_review, no funds move. It stays parked until someone with a valid API key approves it (release the funds) or rejects it (cancel it). The Payout Action API is how you perform that decision from your own systems.

When a payout is in manual review

A payout can only be actioned while its status is pending_review. You can check a payout's current status with the Get Status call in the PayOut API section. If the status is anything other than pending_review, the action call is blocked (see Idempotency below).

The action call

Both approve and reject use the same endpoint; the decision is set by the action query parameter:

POST https://api.paysecure.net/api/v1/payouts/{payout_id}/action?action=approve
POST https://api.paysecure.net/api/v1/payouts/{payout_id}/action?action=reject

On approve, Paysecure releases the payout and its status moves to paid. On reject, the payout is cancelled, its status moves to error, and the rejection reason is stored against the payout.

Idempotency — a payout can only be actioned once

A payout can be approved or rejected exactly once. If you call the action endpoint on a payout that is no longer in pending_review (because it was already actioned, or was never in review), the call is rejected and the payout is left unchanged:

{\n  \"status\": \"error\",\n  \"data\": {\n    \"payout_id\": \"69d4a15b7c7e1d98769872eb\",\n    \"current_status\": \"paid\",\n    \"message\": \"Payout already processed\"\n  }\n}\n

Use data.current_status to see where the payout actually is, and do not retry — the outcome will not change.

Status transitions

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

Previous status	Action	Resulting status	Notes
`pending_review`	`approve`	`paid`	Normal approval — funds released
`pending_review`	`reject`	`error`	Normal rejection — payout cancelled
`paid`	approve / reject	`paid` (unchanged)	❌ Blocked — already processed
`error`	approve / reject	`error` (unchanged)	❌ Blocked — already processed
`payout_in_process`	approve / reject	`payout_in_process` (unchanged)	❌ Blocked — already processing
`dispatched`	approve / reject	`dispatched` (unchanged)	❌ Blocked — already sent
`created`	approve / reject	`created` (unchanged)	❌ Blocked — not in review

Payout 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

Status	Meaning
`pending_review`	Payout is awaiting manual approval or rejection
`paid`	Payout was approved and successfully processed
`error`	Payout was rejected or failed
`payout_in_process`	Payout is being processed by the provider
`dispatched`	Payout has been sent to the provider
`created`	Payout created but not yet in review

Who is recorded as the reviewer (`reviewed_by`)

Every successful action records who made the decision. Paysecure sets reviewed_by using this priority:

If you send a non-empty reviewed_by in the request body, that value is used.
Otherwise, Paysecure falls back to the username tied to the API key you authenticated with.

Use the override when the human decision-maker is different from the API service account (for example finance_manager_john or risk_team_admin), so your audit trail stays accurate.

How `remarks` behaves

On approve — remarks is optional. If you send it, it is echoed back in the response; if you omit it, no remarks field appears in the response and nothing is stored.

On reject — remarks is optional but strongly recommended. It is stored as the payout's error message for your audit trail. If you omit it (or send an empty string) it defaults to \"Rejected\". Always send a clear, specific reason.

Authentication & authorisation

Authenticate with your merchant API key as a Bearer token:

Authorization: Bearer {{APIKey}}

For an action to succeed:

The API key must be valid and live (not a test key).
The payout must belong to the merchant that owns the API key. A payout belonging to another merchant is treated as not found.
Your account must have live transactions enabled.
The payout must be in pending_review status.

Your API key can be located in the Dashboard section of your merchant account login.

A note on HTTP status codes

This endpoint always returns HTTP 200 OK. The real outcome is carried in the JSON body, not the HTTP status line:

Success responses have \"status\": \"success\" and a data object with the action result.
Business / validation failures (e.g. already processed, insufficient balance) have \"status\": \"error\" and a data.message.
Authentication, malformed-JSON, and not-found errors use a simpler legacy shape: {\"message\": \"...\"}.

Always branch on the JSON body (the status field, then data.message) rather than the HTTP status code.

Testing in Sandbox

The sandbox base URL is https://test2.paymentsclub.net/api/v1 (production is https://api.paysecure.net/api/v1 = https://api.paysecure.net/api/v1). To test the flow end to end you need a payout sitting in pending_review. If your sandbox does not let you force a payout into manual review, contact your Account Manager for test payouts and credentials.

\n","_postman_id":"7522ed19-a307-4ec0-bc63-aba3bbae1de9"},{"name":"Approve Payout","id":"acec71f4-43ef-4058-958d-1de80db487d4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer {{APIKey}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"remarks\": \"Verified against invoice #4821\",\n \"reviewed_by\": \"compliance_team_lead\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.paysecure.net/api/v1/payouts/{payout_id}/action?action=approve","description":"

Approves a payout that is currently in pending_review. On success, Paysecure releases the payout to the processor and the status moves to paid.

Call this endpoint once you have verified the payout should be paid. It is idempotent — a payout that has already been actioned cannot be approved again (see Concepts → Idempotency).

Path & Query Parameters

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

Parameter	Notes
payout_id	Mandatory. Path parameter. The unique identifier of the payout to approve.
action	Mandatory. Query parameter. Must be `approve` for this call.

Request Body Parameters

The body is optional for approve — send {} to approve with no notes.

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

Parameter	Notes
remarks	Optional. Free-text reason / notes for the approval. If sent, it is echoed back in the response; if omitted, no `remarks` field is returned.
reviewed_by	Optional. Overrides the reviewer identifier recorded against the action. Defaults to the username tied to your API key. Use it to record the actual human approver for audit purposes.

Response

A successful approval returns status: \"success\" and a data object containing the payout id, the status before and after the action (previous_status = pending_review, current_status = paid), the action performed, the reviewer, and a UTC ISO-8601 reviewed_at timestamp. remarks is included only if you supplied it.

See Concepts → A note on HTTP status codes for how errors are represented (this endpoint always returns HTTP 200).

\n","urlObject":{"path":["payouts","{payout_id}","action"],"host":["https://api.paysecure.net/api/v1"],"query":[{"key":"action","value":"approve"}],"variable":[]}},"response":[{"id":"9e597d59-d1c0-48c7-8a53-364df3274e8d","name":"Success","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer {{APIKey}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"remarks\": \"Verified against invoice #4821\",\n \"reviewed_by\": \"compliance_team_lead\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://api.paysecure.net/api/v1/payouts/{payout_id}/action?action=approve","host":["https://api.paysecure.net/api/v1"],"path":["payouts","{payout_id}","action"],"query":[{"key":"action","value":"approve"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"success\",\n \"data\": {\n \"payout_id\": \"69d4a15b7c7e1d98769872eb\",\n \"previous_status\": \"pending_review\",\n \"current_status\": \"paid\",\n \"action_performed\": \"approve\",\n \"reviewed_by\": \"compliance_team_lead\",\n \"reviewed_at\": \"2026-04-16T10:30:45Z\",\n \"remarks\": \"Verified against invoice #4821\"\n }\n}"},{"id":"d79c2012-3e3b-4d8b-b8b4-f5e2394da38f","name":"Error (Already processed)","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer {{APIKey}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"remarks\": \"Verified against invoice #4821\",\n \"reviewed_by\": \"compliance_team_lead\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://api.paysecure.net/api/v1/payouts/{payout_id}/action?action=approve","host":["https://api.paysecure.net/api/v1"],"path":["payouts","{payout_id}","action"],"query":[{"key":"action","value":"approve"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"error\",\n \"data\": {\n \"payout_id\": \"69d4a15b7c7e1d98769872eb\",\n \"current_status\": \"paid\",\n \"message\": \"Payout already processed\"\n }\n}"},{"id":"3e06576f-cbec-4e64-981b-c953999206ca","name":"Error (Insufficient balance)","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer {{APIKey}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"remarks\": \"Verified against invoice #4821\",\n \"reviewed_by\": \"compliance_team_lead\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://api.paysecure.net/api/v1/payouts/{payout_id}/action?action=approve","host":["https://api.paysecure.net/api/v1"],"path":["payouts","{payout_id}","action"],"query":[{"key":"action","value":"approve"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"error\",\n \"data\": {\n \"payout_id\": \"69d4a15b7c7e1d98769872eb\",\n \"message\": \"Insufficient Balance [250.00]\"\n }\n}"},{"id":"082209fc-a4c6-4c7b-8e46-6cdc13d260ef","name":"Approve - Error (Payout not found)","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer {{APIKey}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"remarks\": \"Verified against invoice #4821\",\n \"reviewed_by\": \"compliance_team_lead\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://api.paysecure.net/api/v1/payouts/{payout_id}/action?action=approve","host":["https://api.paysecure.net/api/v1"],"path":["payouts","{payout_id}","action"],"query":[{"key":"action","value":"approve"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Payout Id Not Found :- 69d4a15b7c7e1d98769872eb\"\n}"},{"id":"c4bf9686-500f-45f5-98cd-09b629acf3ff","name":"Approve - Error (Unauthorized)","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer {{APIKey}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"remarks\": \"Verified against invoice #4821\",\n \"reviewed_by\": \"compliance_team_lead\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://api.paysecure.net/api/v1/payouts/{payout_id}/action?action=approve","host":["https://api.paysecure.net/api/v1"],"path":["payouts","{payout_id}","action"],"query":[{"key":"action","value":"approve"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Unauthorized\"\n}"}],"_postman_id":"acec71f4-43ef-4058-958d-1de80db487d4"},{"name":"Reject Payout","id":"463665d2-fc18-4f7b-b4c7-da48c5585a75","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer {{APIKey}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"remarks\": \"Failed KYC verification\",\n \"reviewed_by\": \"risk_team_admin\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.paysecure.net/api/v1/payouts/{payout_id}/action?action=reject","description":"

Rejects a payout that is currently in pending_review. On success, the payout is cancelled and its status moves to error; the rejection reason is stored against the payout as its error message.

It is idempotent — a payout that has already been actioned cannot be rejected again (see Concepts → Idempotency).

Path & Query Parameters

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

Parameter	Notes
payout_id	Mandatory. Path parameter. The unique identifier of the payout to reject.
action	Mandatory. Query parameter. Must be `reject` for this call.

Request Body Parameters

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

Parameter	Notes
remarks	Optional (recommended). Reason for the rejection. Stored as the payout's error message. If omitted or empty, it defaults to `\"Rejected\"`. Always provide a clear, specific reason for your audit trail.
reviewed_by	Optional. Overrides the reviewer identifier recorded against the action. Defaults to the username tied to your API key.

Response

A successful rejection returns status: \"success\" with previous_status = pending_review and current_status = error. remarks is always included in the response for reject (defaulting to \"Rejected\" if you did not send one).

See Concepts → A note on HTTP status codes for how errors are represented (this endpoint always returns HTTP 200).

\n","urlObject":{"path":["payouts","{payout_id}","action"],"host":["https://api.paysecure.net/api/v1"],"query":[{"key":"action","value":"reject"}],"variable":[]}},"response":[{"id":"acd193c3-22a8-4285-8dac-c8cf58cfa0fd","name":"Success","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer {{APIKey}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"remarks\": \"Failed KYC verification\",\n \"reviewed_by\": \"risk_team_admin\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://api.paysecure.net/api/v1/payouts/{payout_id}/action?action=reject","host":["https://api.paysecure.net/api/v1"],"path":["payouts","{payout_id}","action"],"query":[{"key":"action","value":"reject"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"success\",\n \"data\": {\n \"payout_id\": \"69ce44f1b2dd73d0d148c7d5\",\n \"previous_status\": \"pending_review\",\n \"current_status\": \"error\",\n \"action_performed\": \"reject\",\n \"reviewed_by\": \"risk_team_admin\",\n \"reviewed_at\": \"2026-04-16T10:31:20Z\",\n \"remarks\": \"Failed KYC verification\"\n }\n}"},{"id":"905d050e-109d-46c8-8c5c-15a018f87b44","name":"Success (Default remarks)","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer {{APIKey}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"remarks\": \"Failed KYC verification\",\n \"reviewed_by\": \"risk_team_admin\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://api.paysecure.net/api/v1/payouts/{payout_id}/action?action=reject","host":["https://api.paysecure.net/api/v1"],"path":["payouts","{payout_id}","action"],"query":[{"key":"action","value":"reject"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"success\",\n \"data\": {\n \"payout_id\": \"69ce44f1b2dd73d0d148c7d5\",\n \"previous_status\": \"pending_review\",\n \"current_status\": \"error\",\n \"action_performed\": \"reject\",\n \"reviewed_by\": \"merchant_user_123\",\n \"reviewed_at\": \"2026-04-16T10:31:20Z\",\n \"remarks\": \"Rejected\"\n }\n}"},{"id":"1feb657b-cea2-4e83-ad83-5ef5366f8a57","name":"Error (Already processed)","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer {{APIKey}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"remarks\": \"Failed KYC verification\",\n \"reviewed_by\": \"risk_team_admin\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://api.paysecure.net/api/v1/payouts/{payout_id}/action?action=reject","host":["https://api.paysecure.net/api/v1"],"path":["payouts","{payout_id}","action"],"query":[{"key":"action","value":"reject"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"error\",\n \"data\": {\n \"payout_id\": \"69ce44f1b2dd73d0d148c7d5\",\n \"current_status\": \"error\",\n \"message\": \"Payout already processed\"\n }\n}"},{"id":"e9d817b1-ed99-455a-abfd-48b29750f273","name":"Error (Unauthorized)","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer {{APIKey}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"remarks\": \"Failed KYC verification\",\n \"reviewed_by\": \"risk_team_admin\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://api.paysecure.net/api/v1/payouts/{payout_id}/action?action=reject","host":["https://api.paysecure.net/api/v1"],"path":["payouts","{payout_id}","action"],"query":[{"key":"action","value":"reject"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Unauthorized\"\n}"}],"_postman_id":"463665d2-fc18-4f7b-b4c7-da48c5585a75"}],"id":"5cc2402e-fb16-4c77-82d3-68c8218535b7","description":"

Some payouts are held for manual review before Paysecure releases the funds — typically when a payout is flagged by a risk rule or exceeds an auto-approval threshold. These payouts sit in the pending_review status until an authorised reviewer approves or rejects them.

The Payout Action API lets you approve or reject a payout in manual review programmatically, so you can build the review step into your own back-office, risk, or compliance tooling instead of relying on the Paysecure dashboard.

\n\n

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

Property	Details
Endpoint	`POST https://api.paysecure.net/api/v1/payouts/{payout_id}/action`
Purpose	Approve or reject a payout that is in manual review
Applies to	Payouts in `pending_review` status only
Action	`approve` or `reject` (passed as the `action` query parameter)
Authentication	Bearer API key — stateless, no session required
Idempotent	✅ Yes — a payout can be actioned only once
Approve result	Status moves `pending_review` → `paid`
Reject result	Status moves `pending_review` → `error`
HTTP status	Always `200 OK` — the real outcome is in the JSON body (see Concepts)
Audit fields	`reviewed_by` and `reviewed_at` returned on success

","_postman_id":"5cc2402e-fb16-4c77-82d3-68c8218535b7"},{"name":"Partial Refunds","item":[{"name":"Concepts","item":[],"id":"8a82d915-4f91-49cd-b863-658e05a8745e","description":"

A partial refund allows merchants to refund a portion of a successfully paid purchase.
Multiple partial refunds can be performed until the total refunded amount equals the original purchase amount.

Prerequisites

The purchase must be in paid status.
\n
The refund amount must be greater than 0.
\n
The refund amount must not exceed the remaining refundable amount.
\n
Refunds are processed in the same currency as the original purchase.
\n

Refund Scenarios

Partial Refund

Purchase Amount: 10

Refund Amount: 8

Result:

Refunded Amount: 8
\n
Remaining Refundable Amount: 2
\n
Transaction Status: PARTIALLY_REFUNDED
\n

Full Refund Using Partial Refund API

Purchase Amount: 10

Refund Amount: 10

Result:

Refunded Amount: 10
\n
Remaining Refundable Amount: 0
\n
Transaction Status: PARTIAL REFUNDED
\n

Multiple Partial Refunds

Purchase Amount: 10

Refund #1: 3
\n
Refund #2: 2
\n
Refund #3: 5
\n

Result:

Total Refunded Amount: 10
\n
Remaining Refundable Amount: 0
\n

Final Transaction Status: PARTIAL REFUNDED

\n","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"96f1ece1-7986-4e38-bb3d-4edf235b4782","id":"96f1ece1-7986-4e38-bb3d-4edf235b4782","name":"API","type":"folder"}},"urlObject":{"path":["purchases","purchaseid","refund"],"host":["https://api.paysecure.net/api/v1"],"query":[],"variable":[]}},"response":[{"id":"9068b176-c7ad-437d-ad4a-251d6d9b638e","name":"Success","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{APIKey}}"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"*/*"}],"body":{"mode":"raw","raw":"{\n \"amount\": \"5.12\",\n \"reason\": \"Partial Refunds Testing\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.paysecure.net/api/v1/purchases/purchaseid/refund"},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[{"key":"Date","value":"Fri, 05 Jun 2026 08:59:38 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Nel","value":"{\"report_to\":\"cf-nel\",\"success_fraction\":0.0,\"max_age\":604800}"},{"key":"X-Frame-Options","value":"ALLOW-FROM *"},{"key":"Referrer-Policy","value":"no-referrer"},{"key":"x-session-id","value":"7aec019b-8a08-4e3d-a158-b092f8c8f998"},{"key":"Vary","value":"Origin"},{"key":"Vary","value":"Access-Control-Request-Method"},{"key":"Vary","value":"Access-Control-Request-Headers"},{"key":"Server","value":"cloudflare"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"0"},{"key":"Cache-Control","value":"no-cache, no-store, max-age=0, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Expires","value":"0"},{"key":"Strict-Transport-Security","value":"max-age=31536000 ; includeSubDomains"},{"key":"X-Cache","value":"Error from cloudfront"},{"key":"Via","value":"1.1 2af44885a7fc4faf5a3444e606d6c02c.cloudfront.net (CloudFront)"},{"key":"X-Amz-Cf-Pop","value":"IAD61-P10"},{"key":"X-Amz-Cf-Id","value":"rWo0eMrwpvBts9xS0P4ftqKaridLKfm2xH9Y5H2CF3k6R1LxgTFMZQ=="},{"key":"cf-cache-status","value":"DYNAMIC"},{"key":"Report-To","value":"{\"group\":\"cf-nel\",\"max_age\":604800,\"endpoints\":[{\"url\":\"https://a.nel.cloudflare.com/report/v4?s=IFwED2Y1XrzWhlXDeYjRi0o%2BPWMlBxaVhLXiHVdLbjLb1oaWhC9H%2BdjTxbu3jV8o0RDcmxT%2BvN3omG1bscFcmMeqERUAG%2BooUZMEJ%2BrFdLVe7yaObwbg963WTVC8cyx7dfvT\"}]}"},{"key":"CF-RAY","value":"a06dfb7c4ed3c995-IAD"}],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\n \"refundId\": \"refundid\",\n \"purchaseId\": \"purchaseid\",\n \"amount\": 5.12,\n \"createdOn\": 1780637310,\n \"refundOn\": 0,\n \"status\": \"REFUND_IN_PROCESS\",\n \"reason\": \"Partial Refunds Testing\",\n \"currency\": \"USD\"\n}"},{"id":"c5f65be6-a9d1-4b8f-9c2e-4a2434102ccb","name":"Refund Amt Exceeds Purchase Amt","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{APIKey}}"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"*/*"}],"body":{"mode":"raw","raw":"{\n \"amount\": \"11\", // Purchase Amount: 10\n \"reason\": \"Partial Refunds Testing\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.paysecure.net/api/v1/purchases/purchaseid/refund"},"status":"Bad Request","code":400,"_postman_previewlanguage":"Text","header":[{"key":"Date","value":"Fri, 05 Jun 2026 09:03:16 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Nel","value":"{\"report_to\":\"cf-nel\",\"success_fraction\":0.0,\"max_age\":604800}"},{"key":"X-Frame-Options","value":"ALLOW-FROM *"},{"key":"Referrer-Policy","value":"no-referrer"},{"key":"x-session-id","value":"9f888ccb-1238-4e02-b6dc-764560604b14"},{"key":"Vary","value":"Origin"},{"key":"Vary","value":"Access-Control-Request-Method"},{"key":"Vary","value":"Access-Control-Request-Headers"},{"key":"Server","value":"cloudflare"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"0"},{"key":"Cache-Control","value":"no-cache, no-store, max-age=0, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Expires","value":"0"},{"key":"Strict-Transport-Security","value":"max-age=31536000 ; includeSubDomains"},{"key":"X-Cache","value":"Error from cloudfront"},{"key":"Via","value":"1.1 acbc1e922360be31edf0371abdc7a3a4.cloudfront.net (CloudFront)"},{"key":"X-Amz-Cf-Pop","value":"EWR53-P1"},{"key":"X-Amz-Cf-Id","value":"u0f10ZilZAVELaSZM0QkCGivhENfvhb491tRfbtZBfNmilJhavDeeA=="},{"key":"cf-cache-status","value":"DYNAMIC"},{"key":"Report-To","value":"{\"group\":\"cf-nel\",\"max_age\":604800,\"endpoints\":[{\"url\":\"https://a.nel.cloudflare.com/report/v4?s=G0WYUY8ZL0X6%2BdnZTxN8KgKkvqqBezW18wEdyF5wktbOdTwbgtdIp9wsRiNbSp250CnbNX1q74X0cENF8dT3V5P8gbQ2kw%2BW1%2FWf9LNh1aVj8tHeCAfooAi0il9zhZGaj7z4\"}]}"},{"key":"CF-RAY","value":"a06e00cefac89c79-IAD"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Refund amount exceeds refundable amount\",\n \"code\": \"validation_error\"\n}"},{"id":"5afec450-5f66-40b3-b994-52baef09ffc4","name":"Refund Amt Is 0 or -ve","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{APIKey}}"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"*/*"}],"body":{"mode":"raw","raw":"{\n \"amount\": \"-5.12\",\n \"reason\": \"Partial Refunds Testing\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.paysecure.net/api/v1/purchases/purchaseid/refund"},"status":"Bad Request","code":400,"_postman_previewlanguage":"Text","header":[{"key":"Date","value":"Fri, 05 Jun 2026 09:04:29 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Nel","value":"{\"report_to\":\"cf-nel\",\"success_fraction\":0.0,\"max_age\":604800}"},{"key":"X-Frame-Options","value":"ALLOW-FROM *"},{"key":"Referrer-Policy","value":"no-referrer"},{"key":"x-session-id","value":"2e380b48-7668-448d-af95-980482c35c8f"},{"key":"Vary","value":"Origin"},{"key":"Vary","value":"Access-Control-Request-Method"},{"key":"Vary","value":"Access-Control-Request-Headers"},{"key":"Server","value":"cloudflare"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"0"},{"key":"Cache-Control","value":"no-cache, no-store, max-age=0, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Expires","value":"0"},{"key":"Strict-Transport-Security","value":"max-age=31536000 ; includeSubDomains"},{"key":"X-Cache","value":"Error from cloudfront"},{"key":"Via","value":"1.1 3578d122de1401ebc52a7afd35dd5d0c.cloudfront.net (CloudFront)"},{"key":"X-Amz-Cf-Pop","value":"IAD61-P10"},{"key":"X-Amz-Cf-Id","value":"B705OGUJpsFVyyUtTS_xidVoz9_kniiAFlHKn0_sL6R6oOQ9BMHZFA=="},{"key":"cf-cache-status","value":"DYNAMIC"},{"key":"Report-To","value":"{\"group\":\"cf-nel\",\"max_age\":604800,\"endpoints\":[{\"url\":\"https://a.nel.cloudflare.com/report/v4?s=Wd5pKM%2B%2BBY35cSdYdYOJesaPTVX3KJ1M%2Bd68og7dF7hMaOL00aU4Xm3A7Ab%2BKitUSfwtu5owy8TVmxjQ%2BRNaOp1w2WiatUO7z%2Bayx4TPFfNzLk2eAlmERpeO%2F5Dy18l6%2F4H1\"}]}"},{"key":"CF-RAY","value":"a06e02977d392431-IAD"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Refund amount must be greater than 0\",\n \"code\": \"validation_error\"\n}"},{"id":"b84f15dd-f668-434c-8027-69d5a150170f","name":"Empty Refund Amt","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{APIKey}}"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"*/*"}],"body":{"mode":"raw","raw":"{\n \"reason\": \"Partial Refunds Testing\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.paysecure.net/api/v1/purchases/purchaseid/refund"},"status":"Bad Request","code":400,"_postman_previewlanguage":"Text","header":[{"key":"Date","value":"Fri, 05 Jun 2026 09:05:38 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Nel","value":"{\"report_to\":\"cf-nel\",\"success_fraction\":0.0,\"max_age\":604800}"},{"key":"X-Frame-Options","value":"ALLOW-FROM *"},{"key":"Referrer-Policy","value":"no-referrer"},{"key":"x-session-id","value":"5573f74e-1147-4a84-ad79-08260f6c229d"},{"key":"Vary","value":"Origin"},{"key":"Vary","value":"Access-Control-Request-Method"},{"key":"Vary","value":"Access-Control-Request-Headers"},{"key":"Server","value":"cloudflare"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"0"},{"key":"Cache-Control","value":"no-cache, no-store, max-age=0, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Expires","value":"0"},{"key":"Strict-Transport-Security","value":"max-age=31536000 ; includeSubDomains"},{"key":"X-Cache","value":"Error from cloudfront"},{"key":"Via","value":"1.1 70e9f6c79b570a07593d98d3c3eb2fc6.cloudfront.net (CloudFront)"},{"key":"X-Amz-Cf-Pop","value":"IAD61-P10"},{"key":"X-Amz-Cf-Id","value":"XhGSCeKH6brQ_0b2TQ7RfvwMzYyCp3-qSQ4N2rErhuolIMcxqQB3tw=="},{"key":"cf-cache-status","value":"DYNAMIC"},{"key":"Report-To","value":"{\"group\":\"cf-nel\",\"max_age\":604800,\"endpoints\":[{\"url\":\"https://a.nel.cloudflare.com/report/v4?s=X2YEtc%2F6jCxDP78BlzJBFZfi11NZuirslkboc3hUZCfp1XYpHRAdPv8X3hzhFfHJHJPCjCOZrphGL%2FkrohE%2FC6yvIPVC8Tn7G1%2B0Km7nQ16umqQe%2BdDFT%2BkMIkIKPRqdaErn\"}]}"},{"key":"CF-RAY","value":"a06e0449a9f91de9-IAD"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Amount is required\",\n \"code\": \"validation_error\"\n}"},{"id":"f694b36c-4a79-4cbf-bb3e-738130e8cd1e","name":"Invalid Purchase ID","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{APIKey}}"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"*/*"}],"body":{"mode":"raw","raw":"{\n \"amount\": \"5.12\",\n \"reason\": \"Partial Refunds Testing\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.paysecure.net/api/v1/purchases/purchaseid/refund"},"status":"Bad Request","code":400,"_postman_previewlanguage":"Text","header":[{"key":"Date","value":"Fri, 05 Jun 2026 09:06:14 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Nel","value":"{\"report_to\":\"cf-nel\",\"success_fraction\":0.0,\"max_age\":604800}"},{"key":"X-Frame-Options","value":"ALLOW-FROM *"},{"key":"Referrer-Policy","value":"no-referrer"},{"key":"x-session-id","value":"193bc177-e65b-4f27-8e3d-a1c3242b44c0"},{"key":"Vary","value":"Origin"},{"key":"Vary","value":"Access-Control-Request-Method"},{"key":"Vary","value":"Access-Control-Request-Headers"},{"key":"Server","value":"cloudflare"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"0"},{"key":"Cache-Control","value":"no-cache, no-store, max-age=0, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Expires","value":"0"},{"key":"Strict-Transport-Security","value":"max-age=31536000 ; includeSubDomains"},{"key":"X-Cache","value":"Error from cloudfront"},{"key":"Via","value":"1.1 347540535e60ba585992da68b62d1ae8.cloudfront.net (CloudFront)"},{"key":"X-Amz-Cf-Pop","value":"SIN2-P6"},{"key":"X-Amz-Cf-Id","value":"nQfeXU4EOHhf5w662MDpgndsZOJ2Lv5MJudzq5Ks9OK3S8zPhDXpRw=="},{"key":"cf-cache-status","value":"DYNAMIC"},{"key":"Report-To","value":"{\"group\":\"cf-nel\",\"max_age\":604800,\"endpoints\":[{\"url\":\"https://a.nel.cloudflare.com/report/v4?s=kzHplT3Ggl%2Fu0lxeqmQOcBQxukHE9gO%2F7R0wyfqoD4IiGWSbD1mmaIha7sf9GSp8o%2FJHy9NV8RMdynlScuqpoZI%2FuKo1OF%2F5j96iBu7iEdqO%2Fx9nKqKfAPDFaka%2FR7kfDqRQ\"}]}"},{"key":"CF-RAY","value":"a06e05207bbe52d6-IAD"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Transaction not found\",\n \"code\": \"transaction_error\"\n}"},{"id":"bede6cdc-7d86-4c00-aa98-da1fb6c103a5","name":"Refund on Failed or Pending Transactions","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{APIKey}}"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"*/*"}],"body":{"mode":"raw","raw":"{\n \"amount\": \"5.12\",\n \"reason\": \"Partial Refunds Testing\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.paysecure.net/api/v1/purchases/purchaseid/refund"},"status":"Bad Request","code":400,"_postman_previewlanguage":"Text","header":[{"key":"Date","value":"Fri, 05 Jun 2026 09:06:38 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Nel","value":"{\"report_to\":\"cf-nel\",\"success_fraction\":0.0,\"max_age\":604800}"},{"key":"X-Frame-Options","value":"ALLOW-FROM *"},{"key":"Referrer-Policy","value":"no-referrer"},{"key":"x-session-id","value":"6a7e4072-0cb1-41a9-9669-afc26d71050d"},{"key":"Vary","value":"Origin"},{"key":"Vary","value":"Access-Control-Request-Method"},{"key":"Vary","value":"Access-Control-Request-Headers"},{"key":"Server","value":"cloudflare"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"0"},{"key":"Cache-Control","value":"no-cache, no-store, max-age=0, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Expires","value":"0"},{"key":"Strict-Transport-Security","value":"max-age=31536000 ; includeSubDomains"},{"key":"X-Cache","value":"Error from cloudfront"},{"key":"Via","value":"1.1 a863373015dd073e91a52d99d8ad6bfc.cloudfront.net (CloudFront)"},{"key":"X-Amz-Cf-Pop","value":"IAD61-P10"},{"key":"X-Amz-Cf-Id","value":"KIIfqqaMKmLQqAQbuawRHDuPpcu4EnErL0aeEgFHGYY-FdmMISHmgg=="},{"key":"cf-cache-status","value":"DYNAMIC"},{"key":"Report-To","value":"{\"group\":\"cf-nel\",\"max_age\":604800,\"endpoints\":[{\"url\":\"https://a.nel.cloudflare.com/report/v4?s=8hGQxlHaR2s3QJOa7YijWckCFTcGSeOoU555kG9iM743FjcOdN2Q8IUlKe1015LzlbfPT0b6ZJT0eiE2mmp09iUU%2F%2BCQPt8qnEeD6PJkMkWpn45xqNeHO20Wl8PjbJuI0XZV\"}]}"},{"key":"CF-RAY","value":"a06e05ba9e43c975-IAD"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Only Purchases with `status == (paid)` can be refunded.\",\n \"code\": \"transaction_error\"\n}"},{"id":"b334608c-dfdb-4f39-bbe2-3cbd0f6d52b6","name":"Refund on an Already Refunded Purchase","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{APIKey}}"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"*/*"}],"body":{"mode":"raw","raw":"{\n \"amount\": \"5.12\",\n \"reason\": \"Partial Refunds Testing\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.paysecure.net/api/v1/purchases/purchaseid/refund"},"status":"Bad Request","code":400,"_postman_previewlanguage":"Text","header":[{"key":"Date","value":"Fri, 05 Jun 2026 09:07:09 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Nel","value":"{\"report_to\":\"cf-nel\",\"success_fraction\":0.0,\"max_age\":604800}"},{"key":"X-Frame-Options","value":"ALLOW-FROM *"},{"key":"Referrer-Policy","value":"no-referrer"},{"key":"x-session-id","value":"560fb162-4210-4496-8249-26bf3393409e"},{"key":"Vary","value":"Origin"},{"key":"Vary","value":"Access-Control-Request-Method"},{"key":"Vary","value":"Access-Control-Request-Headers"},{"key":"Server","value":"cloudflare"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"0"},{"key":"Cache-Control","value":"no-cache, no-store, max-age=0, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Expires","value":"0"},{"key":"Strict-Transport-Security","value":"max-age=31536000 ; includeSubDomains"},{"key":"X-Cache","value":"Error from cloudfront"},{"key":"Via","value":"1.1 1a12f863197f986ec10d35ed76e104f0.cloudfront.net (CloudFront)"},{"key":"X-Amz-Cf-Pop","value":"IAD61-P10"},{"key":"X-Amz-Cf-Id","value":"tYQhkaUXrvj3OWc-rQiJp_FnzIBB3mubhjv7yn0w0TaAb6YzKH1Tww=="},{"key":"cf-cache-status","value":"DYNAMIC"},{"key":"Report-To","value":"{\"group\":\"cf-nel\",\"max_age\":604800,\"endpoints\":[{\"url\":\"https://a.nel.cloudflare.com/report/v4?s=SWrtdoBSkmhyNXsahHAdETrqPoOxh89DlcFUaF8D4DOftFPt0BtSVkjBR%2B7G8VbZfModmKZEwe1drtHOkeYMq9oz2PqsnSgYghGs%2Bi%2BqNA%2B4GZ6Z8mYI5BNCiuOJ5k%2FxY9HN\"}]}"},{"key":"CF-RAY","value":"a06e0680dc6724ad-IAD"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Purchase has already been fully refunded\",\n \"code\": \"transaction_error\"\n}"},{"id":"e1b92869-6255-4211-9eeb-a35d3f785520","name":"Refund Exceeds Remaining Balance After a Partial Refund","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{APIKey}}"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"*/*"}],"body":{"mode":"raw","raw":"{\n \"amount\": \"5.12\", // Remaining Refundable Amount is 2.0\n \"reason\": \"Partial Refunds Testing\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.paysecure.net/api/v1/purchases/purchaseid/refund"},"status":"Bad Request","code":400,"_postman_previewlanguage":"Text","header":[{"key":"Date","value":"Fri, 05 Jun 2026 09:09:03 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Nel","value":"{\"report_to\":\"cf-nel\",\"success_fraction\":0.0,\"max_age\":604800}"},{"key":"X-Frame-Options","value":"ALLOW-FROM *"},{"key":"Referrer-Policy","value":"no-referrer"},{"key":"x-session-id","value":"aced1038-4a60-45fb-a14b-f4cdc9ca63b4"},{"key":"Vary","value":"Origin"},{"key":"Vary","value":"Access-Control-Request-Method"},{"key":"Vary","value":"Access-Control-Request-Headers"},{"key":"Server","value":"cloudflare"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"0"},{"key":"Cache-Control","value":"no-cache, no-store, max-age=0, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Expires","value":"0"},{"key":"Strict-Transport-Security","value":"max-age=31536000 ; includeSubDomains"},{"key":"X-Cache","value":"Error from cloudfront"},{"key":"Via","value":"1.1 1a12f863197f986ec10d35ed76e104f0.cloudfront.net (CloudFront)"},{"key":"X-Amz-Cf-Pop","value":"IAD61-P10"},{"key":"X-Amz-Cf-Id","value":"ALmfTGjt9X7OliM6NeGzmkWzns9dzm9J5TnVUAV3egqzFolwOcidoA=="},{"key":"cf-cache-status","value":"DYNAMIC"},{"key":"Report-To","value":"{\"group\":\"cf-nel\",\"max_age\":604800,\"endpoints\":[{\"url\":\"https://a.nel.cloudflare.com/report/v4?s=UtL7zsQvnJ1BIIU8L%2FUyyQd4LiG%2BxMTEzuq%2B0zEM8dhVVZByPP5HkJW7urlk62Rzg%2BFG2Af9VAyMi4REGU5EPnIty%2BthzF4%2FojIE8%2FiFA0flLX5zu%2B4Kb3vJ4AoTU5mEyWf2\"}]}"},{"key":"CF-RAY","value":"a06e094ab9763210-IAD"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Refund amount exceeds refundable amount: 2.0\",\n \"code\": \"validation_error\"\n}"}],"_postman_id":"21892302-5fe4-4b75-8ff5-079f2eeeaeb6"},{"name":"Partial Refund Status API","id":"03973846-2279-410b-9fd7-e7a830a8faca","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{APIKey}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"refundId\": \"refundid\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.paysecure.net/api/v1/refundStatus/purchaseid/","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"96f1ece1-7986-4e38-bb3d-4edf235b4782","id":"96f1ece1-7986-4e38-bb3d-4edf235b4782","name":"API","type":"folder"}},"urlObject":{"path":["refundStatus","purchaseid",""],"host":["https://api.paysecure.net/api/v1"],"query":[],"variable":[]}},"response":[{"id":"24b49654-2bf9-408e-ae5f-c2de2347b029","name":"Success","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{APIKey}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"refundId\": \"refundid\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.paysecure.net/api/v1/refundStatus/purchaseid/"},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[{"key":"Date","value":"Wed, 10 Jun 2026 15:09:28 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Nel","value":"{\"report_to\":\"cf-nel\",\"success_fraction\":0.0,\"max_age\":604800}"},{"key":"X-Frame-Options","value":"ALLOW-FROM *"},{"key":"Referrer-Policy","value":"no-referrer"},{"key":"x-session-id","value":"5be6468d-a804-478e-8e27-8fd83f43359b"},{"key":"Vary","value":"Origin"},{"key":"Vary","value":"Access-Control-Request-Method"},{"key":"Vary","value":"Access-Control-Request-Headers"},{"key":"Server","value":"cloudflare"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"0"},{"key":"Cache-Control","value":"no-cache, no-store, max-age=0, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Expires","value":"0"},{"key":"Strict-Transport-Security","value":"max-age=31536000 ; includeSubDomains"},{"key":"X-Cache","value":"Error from cloudfront"},{"key":"Via","value":"1.1 9d35ce6897d7f02042955443076a54de.cloudfront.net (CloudFront)"},{"key":"X-Amz-Cf-Pop","value":"EWR53-P1"},{"key":"X-Amz-Cf-Id","value":"Z2XLcFaGFRDj2ZuwTFJHQEaWWHB-I3MUtw5N2nMV7CNy55ImAEtfow=="},{"key":"cf-cache-status","value":"DYNAMIC"},{"key":"Report-To","value":"{\"group\":\"cf-nel\",\"max_age\":604800,\"endpoints\":[{\"url\":\"https://a.nel.cloudflare.com/report/v4?s=WE1Q25t02u566zmtnXqm%2F%2FBAsilvCpOzlMzs3i%2F3Py3%2BJO%2FnNNBSHDCXlW4OtMYjNBc6jOpCsAMj0plUVemEWy8KMy8TLLPi0Vrte%2BET6ZNPsDzZXkEqXiFkpjTFGyTde9HC\"}]}"},{"key":"CF-RAY","value":"a0994c1f8a41311a-IAD"}],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\n \"refundId\": \"refundid\",\n \"purchaseId\": \"purchaseid\",\n \"amount\": 3.0,\n \"createdOn\": 1780982811,\n \"refundOn\": 1780982814,\n \"status\": \"REFUNDED\",\n \"reason\": \"test\",\n \"currency\": \"USD\"\n}\n"}],"_postman_id":"03973846-2279-410b-9fd7-e7a830a8faca"}],"id":"96f1ece1-7986-4e38-bb3d-4edf235b4782","auth":{"type":"noauth","isInherited":false},"event":[{"listen":"prerequest","script":{"type":"text/javascript","packages":{},"requests":{},"exec":[""],"id":"b5867463-b4db-4122-8a68-c0c754a9531e"}},{"listen":"test","script":{"type":"text/javascript","packages":{},"requests":{},"exec":[""],"id":"40e61ee4-b54f-4b6b-b6d7-d5a25c7318cc"}}],"_postman_id":"96f1ece1-7986-4e38-bb3d-4edf235b4782","description":""}],"id":"804dfe63-f658-4581-9ecf-68d385a872cd","auth":{"type":"noauth","isInherited":false},"event":[{"listen":"prerequest","script":{"type":"text/javascript","packages":{},"requests":{},"exec":[""],"id":"301d7d9b-341f-441e-9c42-1ea3b6cff739"}},{"listen":"test","script":{"type":"text/javascript","packages":{},"requests":{},"exec":[""],"id":"4e700909-7af0-41d5-82a0-b5ab0454a0da"}}],"_postman_id":"804dfe63-f658-4581-9ecf-68d385a872cd","description":""},{"name":"Test Cards","item":[{"name":"Concepts","item":[],"id":"68bd1193-1e6f-4763-ae86-1333e9e9c161","description":"

What these are

Paysecure's sandbox accepts a fixed set of card numbers, each mapped to a predetermined outcome. Submitting one through the normal card flow produces that outcome every time, which lets you prove your integration handles success, decline, timeout, and pending paths without depending on a live issuer.

The current set was introduced on 18 December 2025 and replaced an earlier, smaller set. The earlier cards no longer work.

Enabling sandbox

In your merchant dashboard, toggle Is Sandbox on, in the top right under your merchant profile.
Generate a sandbox API Key, Brand ID, and Public Key.
Configure your webhook callback URL.

The API key is what selects the environment. The base URL does not change. See ⚙️ Integration Steps for the full onboarding sequence.

\n
⚠️ Because the base URL is identical, a production key will send a real transaction to a real acquirer. Make sure a test suite cannot resolve a production key.
\n

Universal rules

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

Field	Rule
`card_number`	Must be one of the 44 cards documented here. Any other number will not produce a defined outcome
`expires`	`MM/YY`. Any value at or after the current month and year
`cvc`	Any 3 or 4 digits. The value does not affect the outcome. To test a CVV failure, use the Incorrect cvv card with any CVV
3DS OTP	`123456` on the challenge screen. Applies to 3D Secure cards only
Amount	Does not affect the outcome. There are no magic amounts

The outcome is determined entirely by the card number. Nothing else in the request changes it, which means the request you validate in sandbox is the request you send in production.

The card flow

Card payments are a three-step flow, unchanged between sandbox and production:

Step 1, create the purchase. POST https://api.paysecure.net/api/v1/purchases/ registers the transaction and returns a purchaseId. Status is CREATED.
Step 2, submit the card. POST https://api.paysecure.net/api/v1/p/{purchaseId}/?s2s=true sends the card and device details from your server. A 202 response returns a callback_url.
Step 3, invoke the callback from the customer's browser. For a 3D Secure card the customer is taken to the issuer challenge; enter OTP 123456. For a 2D card the outcome is applied directly. The customer then lands on success_redirect, pending_redirect, or failure_redirect.

Poll GET https://api.paysecure.net/api/v1/purchases/{purchaseId}/ at any point, and expect a signed webhook on each status change. See 💳 Card Payments → Concepts for the full flow and 🔌 Webhooks for signature verification.

What a sandbox card result does and does not prove

It proves:

Your request is well formed and accepted by the /purchases and S2S contracts.
Your code handles the 202 plus callback_url handshake correctly.
Your code handles each terminal status and its status_history transitions.
Your 3DS redirect and return handling works, including the challenge screen.
Your webhook listener is reachable and your RSA signature verification is correct.
Your redirect handling is correct for all three outcome URLs.

It does not prove:

That your acquirer or MID is live, configured, or correctly routed. The sandbox does not contact an acquirer.
That real issuer behaviour matches. A real decline carries the issuer's own reason code, which may not match the sandbox message.
That your 3DS configuration is production-ready. The sandbox challenge is not a real ACS.
That real-world latency is handled. Sandbox outcomes are returned immediately.
That settlement, reconciliation, or fee handling works. Nothing settles.

Coverage

Every one of the eleven outcomes exists in four variants: Visa 2D, Visa 3DS, Mastercard 2D, and Mastercard 3DS. There are no gaps in that grid, so any outcome can be tested against either scheme in either authentication mode.

\n","_postman_id":"68bd1193-1e6f-4763-ae86-1333e9e9c161"},{"name":"2D (Non-3DS) Test Cards","item":[],"id":"6622d2ae-c5f2-4501-b2d8-6f311e5423c7","description":"

These cards complete without a 3D Secure challenge. The customer is not redirected to an issuer page; the outcome is applied and the customer goes straight to the final redirect URL.

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

Behaviour	Visa	Mastercard
Authentication successful	`4079 7225 8931 8630`	`5116 2131 1342 9327`
Authentication failed	`4125 4854 4552 7190`	`5112 8571 2490 9935`
Issuer decline	`4401 2799 8573 9470`	`5198 1348 9228 4199`
Insufficient funds	`4662 9222 9343 1520`	`5143 3126 0627 1514`
Incorrect cvv	`4935 6487 0739 0280`	`5110 3398 3298 5475`
Incorrect card expiry	`4460 6520 5283 2634`	`5146 6694 8773 5546`
Risk check failed	`4588 3817 1151 7694`	`5192 4883 4399 0234`
Processor timeout	`4568 7301 1436 1775`	`5136 5284 8649 4418`
Pending execution	`4710 7930 9735 8785`	`5199 8054 0948 2512`
Transaction expired	`4945 2083 3559 6614`	`5140 3783 5864 2890`
Refund failed	`4405 9359 5695 4713`	`5149 4461 0436 9687`

Use any expiry at or after the current month, and any CVV.

\n","_postman_id":"6622d2ae-c5f2-4501-b2d8-6f311e5423c7"},{"name":"3D Secure Test Cards","item":[],"id":"3e87e2e4-24fc-4790-a941-06436a055658","description":"

These cards trigger a 3D Secure challenge. The customer is redirected to a simulated issuer authentication page after the callback_url is invoked.

OTP for every 3D Secure card is **123456****.
**

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

Behaviour	Visa	Mastercard
Authentication successful	`4878 3979 5329 0146`	`5141 9226 3586 6282`
Authentication failed	`4195 2587 2491 3240`	`5169 8116 3632 4572`
Issuer decline	`4618 8895 9831 9798`	`5115 4385 6083 4809`
Insufficient funds	`4984 8235 9957 3265`	`5156 2161 5219 3051`
Incorrect cvv	`4383 0252 2566 5997`	`5151 7359 3086 5446`
Incorrect card expiry	`4500 6828 1154 0204`	`5559 1619 2354 1480`
Risk check failed	`4342 3463 1819 5134`	`5159 9716 0053 0380`
Processor timeout	`4163 3401 2206 8617`	`5185 1518 8503 2695`
Pending execution	`4994 4550 6063 2359`	`5170 3615 6899 3009`
Transaction expired	`4566 3299 0194 4380`	`5127 1606 8372 2580`
Refund failed	`4241 2148 1352 4459`	`5162 1646 3047 1008`

Use any expiry at or after the current month, and any CVV.

Note that the outcome is fixed by the card, not by the OTP. Entering the correct OTP on an Authentication failed card still produces a failure, which is the point: it lets you test a failed authentication without needing to enter a wrong OTP.

\n","_postman_id":"3e87e2e4-24fc-4790-a941-06436a055658"},{"name":"Brand Coverage","item":[],"id":"3c62eb6d-810a-4b71-a2b4-d2c021242bdd","description":"

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

Scheme	Testable in sandbox	Cards	2D	3DS
Visa	✅	22	✅ All 11 outcomes	✅ All 11 outcomes
Mastercard	✅	22	✅ All 11 outcomes	✅ All 11 outcomes
JCB	❌	0	❌	❌
American Express	❌	0	❌	❌
Diners Club / Discover	❌	0	❌	❌
UnionPay	❌	0	❌	❌

What this means for you

If you accept only Visa and Mastercard, the sandbox covers your full outcome matrix.

If you accept any other scheme, that part of your integration cannot be tested in sandbox and must be validated with low-value live transactions. Scheme-specific behaviour worth planning live tests for includes different PAN lengths, four-digit CID handling on American Express, and scheme-specific decline codes.

\n","_postman_id":"3c62eb6d-810a-4b71-a2b4-d2c021242bdd"},{"name":"APIs","item":[{"name":"Purchase","id":"2d067469-8232-4f28-b558-0d3d35265ec4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer {{APIKey}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"client\": {\n \"email\": \"user3782@example.com\",\n \"full_name\": \"Test Customer\",\n \"country\": \"IN\",\n \"city\": \"Ashford\",\n \"street_address\": \"90 Fixture Close\",\n \"zip_code\": \"400001\",\n \"phone\": \"+910000000000\"\n },\n \"purchase\": {\n \"currency\": \"USD\",\n \"products\": [\n {\n \"name\": \"Card test item\",\n \"price\": 10.0\n }\n ]\n },\n \"brand_id\": \"your-brand-id\",\n \"merchantRef\": \"CARD-TEST-0001\",\n \"success_redirect\": \"https://your.success.redirect.com\",\n \"pending_redirect\": \"https://your.pending.redirect.com\",\n \"failure_redirect\": \"https://your.failure.redirect.com\",\n \"success_callback\": \"https://your.success.callback.com\",\n \"failure_callback\": \"https://your.failure.callback.com\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.paysecure.net/api/v1/purchases","description":"

Step 1 of the card flow. Registers the transaction and returns the purchaseId used by every later call. This call is identical for 2D and 3D Secure; the card, and therefore the authentication mode, is not supplied until Step 2.

Authenticate with your sandbox API key and send your sandbox brand_id.

Request Body 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

Parameter	Notes
client.email	Conditional. Recommended. Any syntactically valid address; no mail reaches a real customer in sandbox.
client.full_name	Optional. Customer name. Does not need to match `cardholder_name`.
client.country	Conditional. ISO 3166-1 alpha-2.
client.city	Optional. Customer city.
client.street_address	Optional. Customer street address.
client.zip_code	Optional. Customer postal code.
client.phone	Optional. E.164 format.
purchase.currency	Mandatory. ISO 4217 code.
purchase.products.name	Mandatory. Line-item description.
purchase.products.price	Mandatory. Decimal with 2 places, for example `10.00`. The amount does not affect the outcome; the card does.
brand_id	Mandatory. Your sandbox Brand ID, from the Dashboard section of your merchant account login.
merchantRef	Optional. Your own reference. See Essential Optional Parameters below.
success_redirect	Mandatory. Where the customer lands after a successful outcome.
pending_redirect	Conditional. Where the customer lands after a pending outcome. Mandatory if you intend to test the Pending execution cards.
failure_redirect	Mandatory. Where the customer lands after a failed outcome.
success_callback	Conditional. Webhook URL for successful outcomes, if not configured account-wide.
failure_callback	Conditional. Webhook URL for failed outcomes, if not configured account-wide.

Essential Optional Parameters

merchantRef is your own reference for the transaction and carries two advantages. It prevents duplicates: resending a request with a merchantRef you have already used lets you detect and reject the repeat rather than creating a second purchase. It also makes retrieval straightforward, because you can find the transaction by your own identifier instead of storing Paysecure's purchaseId. When running a card test matrix, use a scheme-based value such as CARD-TEST-0001 so a run is easy to find in Transaction Reporting, and change it for every attempt.

Response

The full purchase envelope. status is CREATED, status_history holds a single created entry, and transaction_data.attempts is empty until the card is submitted in Step 2. Take purchaseId and use it in the S2S call.

\n
Values in the saved examples are illustrative; the structure is authoritative. Timestamps, references, and identifiers are made up.
\n

\n","urlObject":{"path":["purchases"],"host":["https://api.paysecure.net/api/v1"],"query":[],"variable":[]}},"response":[{"id":"3c2a6267-af67-428e-a738-874c1baad6a3","name":"Purchase - Success (created)","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer {{APIKey}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"client\": {\n \"email\": \"user3782@example.com\",\n \"full_name\": \"Test Customer\",\n \"country\": \"IN\",\n \"city\": \"Ashford\",\n \"street_address\": \"90 Fixture Close\",\n \"zip_code\": \"400001\",\n \"phone\": \"+910000000000\"\n },\n \"purchase\": {\n \"currency\": \"USD\",\n \"products\": [\n {\n \"name\": \"Card test item\",\n \"price\": 10.0\n }\n ]\n },\n \"brand_id\": \"your-brand-id\",\n \"merchantRef\": \"CARD-TEST-0001\",\n \"success_redirect\": \"https://your.success.redirect.com\",\n \"pending_redirect\": \"https://your.pending.redirect.com\",\n \"failure_redirect\": \"https://your.failure.redirect.com\",\n \"success_callback\": \"https://your.success.callback.com\",\n \"failure_callback\": \"https://your.failure.callback.com\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.paysecure.net/api/v1/purchases"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"purchaseId\": \"6a6db590b1c2d3e4f5a6b701\",\n \"client\": {\n \"bank_account\": \"\",\n \"bank_code\": \"\",\n \"email\": \"user3782@example.com\",\n \"phone\": \"+910000000000\",\n \"full_name\": \"Test Customer\",\n \"date_of_birth\": \"\",\n \"personal_code\": \"\",\n \"street_address\": \"90 Fixture Close\",\n \"country\": \"IN\",\n \"city\": \"Ashford\",\n \"zip_code\": \"400001\",\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\": \"\"\n },\n \"updated_on\": 1785574800,\n \"type\": \"purchase\",\n \"force_recurring\": false,\n \"created_on\": 1785574800,\n \"purchase\": {\n \"currency\": \"USD\",\n \"products\": [\n {\n \"name\": \"Card test item\",\n \"quantity\": 1,\n \"price\": 10.0,\n \"discount\": 0,\n \"tax_percent\": \"0.00\"\n }\n ],\n \"total\": 10.0,\n \"language\": \"en\",\n \"notes\": \"\",\n \"debt\": 0,\n \"total_formatted\": 10.0,\n \"request_client_details\": [],\n \"timezone\": \"Asia/Kolkata\",\n \"email_message\": \"\"\n },\n \"payment\": {\n \"is_outgoing\": false,\n \"payment_type\": \"PURCHASE\",\n \"amount\": 10.0,\n \"currency\": \"USD\",\n \"net_amount\": 10.0,\n \"fee_amount\": 0,\n \"pending_amount\": 0,\n \"pending_unfreeze_on\": null,\n \"description\": \"\",\n \"paid_on\": null,\n \"remote_paid_on\": null\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\": \"Example Merchant\",\n \"brand_name\": \"Example Merchant\",\n \"registration_number\": \"\",\n \"tax_number\": \"\"\n },\n \"transaction_data\": {\n \"payment_method\": \"VISA\",\n \"flow\": \"payform\",\n \"extra\": {\n \"expiry_month\": \"12\",\n \"expiry_year\": \"30\",\n \"amount\": 10.0,\n \"card_issuer\": \"\",\n \"masked_pan\": \"407972XXXXXX8630\",\n \"card_brand\": \"VISA\",\n \"card_issuer_country\": \"\",\n \"cardholder_name\": \"Test Customer\"\n },\n \"country\": \"\",\n \"attempts\": [\n {\n \"client_ip\": \"203.0.113.138\",\n \"type\": \"execute\",\n \"payment_method\": \"VISA\",\n \"flow\": \"payform\",\n \"successful\": false,\n \"country\": \"\",\n \"processing_time\": 1785574819,\n \"extra\": {\n \"expiry_month\": \"12\",\n \"expiry_year\": \"30\",\n \"amount\": 10.0,\n \"card_issuer\": \"\",\n \"masked_pan\": \"407972XXXXXX8630\",\n \"card_brand\": \"VISA\",\n \"card_issuer_country\": \"\",\n \"cardholder_name\": \"Test Customer\"\n }\n }\n ]\n },\n \"status\": \"CREATED\",\n \"status_history\": [\n {\n \"status\": \"created\",\n \"timestamp\": 1785574800\n }\n ],\n \"viewedOn\": null,\n \"is_test\": true,\n \"brand_id\": \"your-brand-id\",\n \"merchantRef\": \"CARD-TEST-0001\",\n \"send_receipt\": false,\n \"is_recurring_token\": false,\n \"skip_capture\": false,\n \"reference_generated\": \"\",\n \"issued\": \"2026-08-01\",\n \"due\": 1785574800,\n \"refund_upto\": 1785574800,\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\": \"https://your.success.callback.com\",\n \"platform\": \"API\",\n \"created_from_ip\": \"203.0.113.138\",\n \"checkout_url\": \"https://api.paysecure.net/payments/6a6db590b1c2d3e4f5a6b701/\",\n \"direct_post_url\": \"https://api.paysecure.net/api/v1/p/6a6db590b1c2d3e4f5a6b701/\",\n \"pending_redirect\": \"https://your.pending.redirect.com\",\n \"failure_callback\": \"https://your.failure.callback.com\"\n}"},{"id":"8dd45604-4397-4daa-be41-82d896a0b162","name":"Purchase - Error (Brand not found)","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer {{APIKey}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"client\": {\n \"email\": \"user3782@example.com\",\n \"full_name\": \"Test Customer\",\n \"country\": \"IN\",\n \"city\": \"Ashford\",\n \"street_address\": \"90 Fixture Close\",\n \"zip_code\": \"400001\",\n \"phone\": \"+910000000000\"\n },\n \"purchase\": {\n \"currency\": \"USD\",\n \"products\": [\n {\n \"name\": \"Card test item\",\n \"price\": 10.0\n }\n ]\n },\n \"brand_id\": \"your-brand-id\",\n \"merchantRef\": \"CARD-TEST-0003\",\n \"success_redirect\": \"https://your.success.redirect.com\",\n \"pending_redirect\": \"https://your.pending.redirect.com\",\n \"failure_redirect\": \"https://your.failure.redirect.com\",\n \"success_callback\": \"https://your.success.callback.com\",\n \"failure_callback\": \"https://your.failure.callback.com\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.paysecure.net/api/v1/purchases"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Brand not found!\",\n \"code\": \"transaction_error\"\n}"}],"_postman_id":"2d067469-8232-4f28-b558-0d3d35265ec4"},{"name":"S2S","id":"39c85520-3e9b-4549-8cc9-2c7a6cdff1db","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer {{APIKey}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"cardholder_name\": \"Test Customer\",\n \"card_number\": \"4111111111111111\",\n \"expires\": \"12/30\",\n \"cvc\": \"123\",\n \"remember_card\": \"off\",\n \"remote_ip\": \"203.0.113.68\",\n \"user_agent\": \"Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/120.0.0.0 Safari/537.36\",\n \"accept_header\": \"text/html\",\n \"language\": \"en-US\",\n \"java_enabled\": false,\n \"javascript_enabled\": true,\n \"color_depth\": 24,\n \"utc_offset\": 0,\n \"screen_width\": 1920,\n \"screen_height\": 1080\n}","options":{"raw":{"language":"json"}}},"url":"https://api.paysecure.net/api/v1/p/{purchaseId}/?s2s=true","description":"

Step 2 of the card flow. Submits the card and device details from your server. This is the call that determines the outcome, because the outcome is fixed by the card number.

A successful submission returns 202 with a callback_url. Direct the customer's browser to that URL to complete Step 3.

Path and Query Parameters

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

Parameter	Notes
purchaseId	Mandatory. Path parameter. The `purchaseId` returned by `POST https://api.paysecure.net/api/v1/purchases/`.
s2s	Mandatory. Query parameter. Must be `true`.

Request Body 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

Parameter	Notes
cardholder_name	Mandatory. Name of the cardholder. Any value in sandbox.
card_number	Mandatory. One of the 44 documented test cards. This field alone determines the outcome. Any other number will not produce a defined result.
expires	Mandatory. `MM/YY`. Any month and year at or after the current one. To test an expiry failure use the Incorrect card expiry card with a valid future date, not a past date.
cvc	Mandatory. Any 3 or 4 digits. To test a CVV failure use the Incorrect cvv card.
remember_card	Mandatory. `\"on\"` or `\"off\"`. Whether Paysecure stores the card.
remote_ip	Mandatory. IP address of the customer's device. Used for fraud checks and risk scoring.
user_agent	Mandatory. Full browser and OS string from the HTTP header.
accept_header	Mandatory. The browser's `Accept` header value.
language	Optional. Browser language, for example `en-US`.
java_enabled	Optional. `true` or `false`. Used in device profiling.
javascript_enabled	Optional. `true` or `false`. Used for 3DS and risk-based checks.
color_depth	Optional. Display bit depth, for example `24`.
utc_offset	Optional. Minutes between local time and UTC.
screen_width	Optional. Device screen width in pixels.
screen_height	Optional. Device screen height in pixels.

The device and browser fields feed 3DS risk assessment. Send realistic values when testing 3D Secure cards.

Swapping the outcome

To test a different outcome, change only card_number. Create a fresh purchase first, with a new merchantRef, because a purchaseId that has already been submitted cannot be reused and will return Allowed Attempt for this Transaction has been consumed.

Response

202 Accepted with a callback_url. Invoke it from the customer's browser to complete the flow. For a 3D Secure card this leads to the challenge screen, where the OTP is 123456.

Errors follow the standard {\"message\", \"code\"} shape. See 🖥️ Status Code.

\n","urlObject":{"path":["p","{purchaseId}",""],"host":["https://api.paysecure.net/api/v1"],"query":[{"key":"s2s","value":"true"}],"variable":[]}},"response":[{"id":"dd217bf7-7f74-436a-af1e-c902358400ac","name":"S2S - Accepted (callback_url returned)","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer {{APIKey}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"cardholder_name\": \"Test Customer\",\n \"card_number\": \"4111111111111111\",\n \"expires\": \"12/30\",\n \"cvc\": \"123\",\n \"remember_card\": \"off\",\n \"remote_ip\": \"203.0.113.68\",\n \"user_agent\": \"Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/120.0.0.0 Safari/537.36\",\n \"accept_header\": \"text/html\",\n \"language\": \"en-US\",\n \"java_enabled\": false,\n \"javascript_enabled\": true,\n \"color_depth\": 24,\n \"utc_offset\": 0,\n \"screen_width\": 1920,\n \"screen_height\": 1080\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://api.paysecure.net/api/v1/p/{purchaseId}/?s2s=true","host":["https://api.paysecure.net/api/v1"],"path":["p","{purchaseId}",""],"query":[{"key":"s2s","value":"true"}]}},"status":"Accepted","code":202,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"pending\",\n \"callback_url\": \"https://api.paysecure.net/api/v1/payment/6a6db590b1c2d3e4f5a6b701/\",\n \"method\": \"GET\"\n}"},{"id":"7fad98b7-17c2-4a23-b4f1-eb221f5f96f3","name":"S2S - Error (attempts consumed)","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer {{APIKey}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"cardholder_name\": \"Test Customer\",\n \"card_number\": \"4111111111111111\",\n \"expires\": \"12/30\",\n \"cvc\": \"123\",\n \"remember_card\": \"off\",\n \"remote_ip\": \"203.0.113.68\",\n \"user_agent\": \"Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/120.0.0.0 Safari/537.36\",\n \"accept_header\": \"text/html\",\n \"language\": \"en-US\",\n \"java_enabled\": false,\n \"javascript_enabled\": true,\n \"color_depth\": 24,\n \"utc_offset\": 0,\n \"screen_width\": 1920,\n \"screen_height\": 1080\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://api.paysecure.net/api/v1/p/{purchaseId}/?s2s=true","host":["https://api.paysecure.net/api/v1"],"path":["p","{purchaseId}",""],"query":[{"key":"s2s","value":"true"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Allowed Attempt for this Transaction has been consumed\",\n \"code\": \"transaction_error\"\n}"}],"_postman_id":"39c85520-3e9b-4549-8cc9-2c7a6cdff1db"},{"name":"Get Status","id":"fbc39445-5f83-4742-a4f4-0be9017faf02","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{APIKey}}","type":"text"}],"url":"https://api.paysecure.net/api/v1/purchases/{purchaseId}","description":"

Step 3 verification. Returns the current state of the purchase as the full envelope, with status and status_history reflecting the outcome the test card produced.

Path Parameters

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

Parameter	Notes
purchaseId	Mandatory. The `purchaseId` returned by `POST https://api.paysecure.net/api/v1/purchases/`.

Statuses you will see

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\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`	Produced by	Terminal?
`CREATED`	Purchase created, card not yet submitted	❌
`PENDING EXECUTE`	S2S called, `callback_url` not yet invoked	❌
`PAYMENT IN PROCESS`	Customer action pending, including 3DS challenge	❌
`PAID`	An Authentication successful card	✅
`ERROR`	Any decline, timeout, or authentication failure card	✅
`EXPIRED`	A Transaction expired card	✅

status_history uses lowercase names with Unix timestamps; the top-level status is uppercase. For a declined transaction, read errorMsg for the reason rather than inferring it from status.

[VERIFY] Which status the Pending execution cards settle at, and whether they later move on.

\n","urlObject":{"path":["purchases","{purchaseId}"],"host":["https://api.paysecure.net/api/v1"],"query":[],"variable":[]}},"response":[{"id":"37d4b172-d8c6-43dd-a18f-05302ccdda41","name":"Get Status - PAID (Authentication successful card)","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{APIKey}}","type":"text"}],"url":"https://api.paysecure.net/api/v1/purchases/{purchaseId}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"purchaseId\": \"6a6db590b1c2d3e4f5a6b701\",\n \"client\": {\n \"bank_account\": \"\",\n \"bank_code\": \"\",\n \"email\": \"user3782@example.com\",\n \"phone\": \"+910000000000\",\n \"full_name\": \"Test Customer\",\n \"date_of_birth\": \"\",\n \"personal_code\": \"\",\n \"street_address\": \"90 Fixture Close\",\n \"country\": \"IN\",\n \"city\": \"Ashford\",\n \"zip_code\": \"400001\",\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\": \"\"\n },\n \"updated_on\": 1785574819,\n \"type\": \"purchase\",\n \"force_recurring\": false,\n \"created_on\": 1785574800,\n \"purchase\": {\n \"currency\": \"USD\",\n \"products\": [\n {\n \"name\": \"Card test item\",\n \"quantity\": 1,\n \"price\": 10.0,\n \"discount\": 0,\n \"tax_percent\": \"0.00\"\n }\n ],\n \"total\": 10.0,\n \"language\": \"en\",\n \"notes\": \"\",\n \"debt\": 0,\n \"total_formatted\": 10.0,\n \"request_client_details\": [],\n \"timezone\": \"Asia/Kolkata\",\n \"email_message\": \"\"\n },\n \"payment\": {\n \"is_outgoing\": false,\n \"payment_type\": \"PURCHASE\",\n \"amount\": 10.0,\n \"currency\": \"USD\",\n \"net_amount\": 10.0,\n \"fee_amount\": 0,\n \"pending_amount\": 0,\n \"pending_unfreeze_on\": null,\n \"description\": \"\",\n \"paid_on\": 1785574819,\n \"remote_paid_on\": 1785574819\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\": \"Example Merchant\",\n \"brand_name\": \"Example Merchant\",\n \"registration_number\": \"\",\n \"tax_number\": \"\"\n },\n \"transaction_data\": {\n \"payment_method\": \"VISA\",\n \"flow\": \"payform\",\n \"extra\": {\n \"expiry_month\": \"12\",\n \"expiry_year\": \"30\",\n \"amount\": 10.0,\n \"card_issuer\": \"\",\n \"masked_pan\": \"407972XXXXXX8630\",\n \"card_brand\": \"VISA\",\n \"card_issuer_country\": \"\",\n \"cardholder_name\": \"Test Customer\"\n },\n \"country\": \"\",\n \"attempts\": [\n {\n \"client_ip\": \"203.0.113.138\",\n \"type\": \"execute\",\n \"payment_method\": \"VISA\",\n \"flow\": \"payform\",\n \"successful\": true,\n \"country\": \"\",\n \"processing_time\": 1785574819,\n \"extra\": {\n \"expiry_month\": \"12\",\n \"expiry_year\": \"30\",\n \"amount\": 10.0,\n \"card_issuer\": \"\",\n \"masked_pan\": \"407972XXXXXX8630\",\n \"card_brand\": \"VISA\",\n \"card_issuer_country\": \"\",\n \"cardholder_name\": \"Test Customer\"\n }\n }\n ]\n },\n \"status\": \"PAID\",\n \"status_history\": [\n {\n \"status\": \"created\",\n \"timestamp\": 1785574800\n },\n {\n \"status\": \"pending_execute\",\n \"timestamp\": 1785574808\n },\n {\n \"status\": \"payment_in_process\",\n \"timestamp\": 1785574815\n },\n {\n \"status\": \"paid\",\n \"timestamp\": 1785574819\n }\n ],\n \"viewedOn\": 1785574806,\n \"is_test\": true,\n \"brand_id\": \"your-brand-id\",\n \"merchantRef\": \"CARD-TEST-0001\",\n \"send_receipt\": false,\n \"is_recurring_token\": false,\n \"skip_capture\": false,\n \"reference_generated\": \"\",\n \"issued\": \"2026-08-01\",\n \"due\": 1785574800,\n \"refund_upto\": 1785574800,\n \"cc_descriptor\": \"\",\n \"refund_availability\": \"ALL\",\n \"refundable_amount\": 10.0,\n \"success_redirect\": \"https://your.success.redirect.com\",\n \"failure_redirect\": \"https://your.failure.redirect.com\",\n \"cancel_redirect\": \"\",\n \"success_callback\": \"https://your.success.callback.com\",\n \"platform\": \"API\",\n \"created_from_ip\": \"203.0.113.138\",\n \"checkout_url\": \"https://api.paysecure.net/payments/6a6db590b1c2d3e4f5a6b701/\",\n \"direct_post_url\": \"https://api.paysecure.net/api/v1/p/6a6db590b1c2d3e4f5a6b701/\",\n \"pending_redirect\": \"https://your.pending.redirect.com\",\n \"failure_callback\": \"https://your.failure.callback.com\"\n}"},{"id":"51588c37-4e3e-4de9-bdbc-3e48cb815305","name":"Get Status - ERROR (Issuer decline card)","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{APIKey}}","type":"text"}],"url":"https://api.paysecure.net/api/v1/purchases/{purchaseId}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"purchaseId\": \"6a6db590b1c2d3e4f5a6b701\",\n \"client\": {\n \"bank_account\": \"\",\n \"bank_code\": \"\",\n \"email\": \"user3782@example.com\",\n \"phone\": \"+910000000000\",\n \"full_name\": \"Test Customer\",\n \"date_of_birth\": \"\",\n \"personal_code\": \"\",\n \"street_address\": \"90 Fixture Close\",\n \"country\": \"IN\",\n \"city\": \"Ashford\",\n \"zip_code\": \"400001\",\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\": \"\"\n },\n \"updated_on\": 1785574819,\n \"type\": \"purchase\",\n \"force_recurring\": false,\n \"created_on\": 1785574800,\n \"purchase\": {\n \"currency\": \"USD\",\n \"products\": [\n {\n \"name\": \"Card test item\",\n \"quantity\": 1,\n \"price\": 10.0,\n \"discount\": 0,\n \"tax_percent\": \"0.00\"\n }\n ],\n \"total\": 10.0,\n \"language\": \"en\",\n \"notes\": \"\",\n \"debt\": 0,\n \"total_formatted\": 10.0,\n \"request_client_details\": [],\n \"timezone\": \"Asia/Kolkata\",\n \"email_message\": \"\"\n },\n \"payment\": {\n \"is_outgoing\": false,\n \"payment_type\": \"PURCHASE\",\n \"amount\": 10.0,\n \"currency\": \"USD\",\n \"net_amount\": 10.0,\n \"fee_amount\": 0,\n \"pending_amount\": 0,\n \"pending_unfreeze_on\": null,\n \"description\": \"\",\n \"paid_on\": null,\n \"remote_paid_on\": null\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\": \"Example Merchant\",\n \"brand_name\": \"Example Merchant\",\n \"registration_number\": \"\",\n \"tax_number\": \"\"\n },\n \"transaction_data\": {\n \"payment_method\": \"VISA\",\n \"flow\": \"payform\",\n \"extra\": {\n \"expiry_month\": \"12\",\n \"expiry_year\": \"30\",\n \"amount\": 10.0,\n \"card_issuer\": \"\",\n \"masked_pan\": \"440127XXXXXX9470\",\n \"card_brand\": \"VISA\",\n \"card_issuer_country\": \"\",\n \"cardholder_name\": \"Test Customer\"\n },\n \"country\": \"\",\n \"attempts\": [\n {\n \"client_ip\": \"203.0.113.138\",\n \"type\": \"execute\",\n \"payment_method\": \"VISA\",\n \"flow\": \"payform\",\n \"successful\": false,\n \"country\": \"\",\n \"processing_time\": 1785574819,\n \"extra\": {\n \"expiry_month\": \"12\",\n \"expiry_year\": \"30\",\n \"amount\": 10.0,\n \"card_issuer\": \"\",\n \"masked_pan\": \"440127XXXXXX9470\",\n \"card_brand\": \"VISA\",\n \"card_issuer_country\": \"\",\n \"cardholder_name\": \"Test Customer\"\n }\n }\n ]\n },\n \"status\": \"ERROR\",\n \"status_history\": [\n {\n \"status\": \"created\",\n \"timestamp\": 1785574800\n },\n {\n \"status\": \"pending_execute\",\n \"timestamp\": 1785574808\n },\n {\n \"status\": \"payment_in_process\",\n \"timestamp\": 1785574815\n },\n {\n \"status\": \"error\",\n \"timestamp\": 1785574819\n }\n ],\n \"viewedOn\": 1785574806,\n \"is_test\": true,\n \"brand_id\": \"your-brand-id\",\n \"merchantRef\": \"CARD-TEST-0002\",\n \"send_receipt\": false,\n \"is_recurring_token\": false,\n \"skip_capture\": false,\n \"reference_generated\": \"\",\n \"issued\": \"2026-08-01\",\n \"due\": 1785574800,\n \"refund_upto\": 1785574800,\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\": \"https://your.success.callback.com\",\n \"platform\": \"API\",\n \"created_from_ip\": \"203.0.113.138\",\n \"checkout_url\": \"https://api.paysecure.net/payments/6a6db590b1c2d3e4f5a6b701/\",\n \"direct_post_url\": \"https://api.paysecure.net/api/v1/p/6a6db590b1c2d3e4f5a6b701/\",\n \"pending_redirect\": \"https://your.pending.redirect.com\",\n \"failure_callback\": \"https://your.failure.callback.com\"\n}"},{"id":"3d8ab712-6478-4599-8936-18c382e59600","name":"Get Status - Error (Purchase not found)","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{APIKey}}","type":"text"}],"url":"https://api.paysecure.net/api/v1/purchases/{purchaseId}"},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"PurchaseId Not found.\",\n \"code\": \"transaction_error\"\n}"}],"_postman_id":"fbc39445-5f83-4742-a4f4-0be9017faf02"}],"id":"e13b3504-d3e7-4729-8297-c74b9052852f","description":"

The three-step card flow, unchanged between sandbox and production. Create the purchase, submit the card, then invoke the callback from the customer's browser and read the result.

\n","_postman_id":"e13b3504-d3e7-4729-8297-c74b9052852f"},{"name":"Troubleshooting","item":[],"id":"20656c7a-1ab5-4aef-93fa-76054324383b","description":"

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

Symptom	Likely cause	Fix
A test card was declined as an ordinary card, and a real transaction may have been attempted	A production API key was used. These cards only behave as documented in Sandbox mode	Check which key your environment resolved. Keep sandbox and production keys in separate configuration so a test suite cannot reach production
Outcome does not match the table	The card number was altered, or a card outside the documented set was used	Re-check the number digit by digit. Only the 44 documented cards produce defined outcomes
`Invalid Card Expiry(Valid Format:MM/YY) must be greater than current month/year`	A past expiry date was sent	Use any date at or after the current month. To test an expiry failure use the Incorrect card expiry card with a valid future date
`Allowed Attempt for this Transaction has been consumed`	S2S was called more than the permitted number of times on one `purchaseId`	Create a new purchase for each attempt, with a new `merchantRef`. `[VERIFY]` the exact attempt limit
3DS challenge screen rejects the OTP	Wrong OTP	The OTP is `123456` for every 3D Secure test card
Correct OTP entered but the transaction still failed	Expected, if an Authentication failed card was used	The outcome is fixed by the card, not the OTP
No webhook received	Callback URL not configured or not reachable	Confirm `success_callback` and `failure_callback`, or the account-wide setting, and that the endpoint is publicly reachable
Webhook signature verification fails	Verifying against the wrong public key, or a canonicalisation bug	Verify against the sandbox account's public key, per 🔌 Webhooks. This is a real finding, not a sandbox artefact
Cannot test American Express or JCB	No test cards exist for those schemes	See Brand Coverage. Validate with low-value live transactions
Refund test does not behave as expected	Refunds depend on the purchase first reaching `PAID`	Use the Refund failed card to test the failure path. `[VERIFY]` the exact sequence and message

Error response shape

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

For a detailed reason, read errorMsg in the purchase envelope or webhook payload rather than relying on status alone.

Reporting a mismatch

If a card does not produce its documented outcome, report it rather than working around it. These tables are only useful if they are exact. Raise it through your usual technical support channel. [TBD: confirm the support address.]

\n","_postman_id":"20656c7a-1ab5-4aef-93fa-76054324383b"}],"id":"a483ee09-d904-448d-be5e-393e8fae4748","description":"

Test cards for validating a card integration in Sandbox mode. Forty-four cards cover eleven outcomes across Visa and Mastercard, in both 2D (non-3DS) and 3D Secure variants, so every branch of your integration can be exercised deterministically before you process a live transaction.

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

Property	Details
Applies to	Card payments only
Environment	Sandbox mode. Toggle Is Sandbox in the top right of your merchant dashboard
Base URL	`https://api.paysecure.net/api/v1` (same as production)
Cards available	44
Schemes	Visa, Mastercard
Auth types	2D (non-3DS) and 3D Secure, for every outcome
Outcomes	11
Expiry date	Any month and year at or after the current month
CVV	Any 3 or 4 digits
3DS OTP	`123456`
Cost	None. No funds move

\n
These cards work only in Sandbox mode. In Live mode they will be treated as ordinary card numbers and declined. Confirm which environment your API key belongs to before running a test suite.
\n

\n","_postman_id":"a483ee09-d904-448d-be5e-393e8fae4748"},{"name":"APM Simulator","item":[{"name":"Concepts","item":[],"id":"aab8fc74-9f0b-4fa2-a143-da922e46a0f2","description":"

What the APM Simulator is

The APM Simulator is a simulated counterparty for alternative payment methods. When you send a POST https://api.paysecure.net/api/v1/purchases/ request authenticated with sandbox credentials and a supported paymentMethod, Paysecure routes the purchase to the simulator rather than to a live PSP. You receive a normal purchase response including a checkout_url, which resolves to a hosted simulator cashier page. On that page the outcome is selected explicitly, and the purchase then behaves as it would if a real APM had returned that outcome: statuses advance, a webhook fires, and the customer is redirected to the matching \\*_redirect URL from your request.

\n\n

When to use it

Building a new APM integration before the PSP contract is signed or credentials are issued.
\n
Exercising the decline and pending branches of your code deterministically, rather than hoping to observe them in production.
\n
Verifying that your webhook listener receives, parses, and RSA-verifies a Paysecure callback.
\n
Confirming that all three redirect URLs are handled correctly.
\n
Running APM regression tests in CI, so an integration proven last release is proven again this release.
\n

What a simulated result does and does not prove

Read this section before you rely on a simulated pass as evidence of readiness.

A simulated result proves:

Your request is well formed and accepted by the /purchases contract.
\n
Your code correctly handles the purchase response, including checkout_url and purchaseId.
\n
Your code correctly handles the status you forced, and the status_history transitions leading to it.
\n
Your webhook endpoint is reachable, and your RSA signature verification is correct.
\n
Your redirect handling is correct for success, pending, and failure.
\n

A simulated result does not prove:

That the PSP has onboarded, underwritten, or certified you. The simulator never contacts a PSP.
\n
That the live rail is enabled on your account, or that your MID is active.
\n
That the real APM will return the same field values. Method-specific payload data such as a real Pix payload, a real CLABE, or a real Fawry reference is not issued by the simulator.
\n
That your timeout and retry logic is correctly tuned. Simulated outcomes resolve instantly.
\n
That you handle every PSP-specific error condition. The simulator exposes three outcomes, not the full error surface of a live rail.
\n

How a simulated transaction differs from a live APM transaction

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

Aspect	Simulated	Live APM
Credentials	Sandbox API key and Brand ID	Production API key and Brand ID
Endpoint and contract	Identical	Identical
Counterparty	Paysecure simulator	PSP and the underlying rail
Customer experience	Hosted simulator cashier page with outcome buttons	The real APM app, bank page, QR, or voucher
Outcome	Selected on the cashier page	Determined by the customer and the rail
Timing	Instant, not configurable	Seconds to hours, method-dependent
Money movement	None	Real funds, real settlement
Webhook signature	RSA signed, as in production	RSA signed
Webhook payload	Reduced field set `[TBD: confirm omitted fields with engineering]`	Full field set
Method-specific payload	Not issued	Real payload, CLABE, reference, or QR
Refunds and disputes	Not available	Available where the method supports them

PayIn lifecycle

How it works. You create the purchase, send the customer to the simulator cashier page, the outcome is selected there, and Paysecure then advances the purchase and notifies you. Nothing in the request body controls the outcome, which is deliberate: the request you validate against the simulator has the same shape and the same fields as the request you will send in production. The only values that change at go-live are your API key and your brand_id.

Flow

Merchant creates the purchase: POST https://api.paysecure.net/api/v1/purchases/ with sandbox credentials, a supported paymentMethod, and all three of success_redirect, pending_redirect, and failure_redirect populated.
\n
Paysecure responds: the full purchase envelope, with status = CREATED and a checkout_url.
\n
Merchant redirects the customer: to the checkout_url. This is the simulator cashier page, not a real APM page.
\n
Outcome is selected: Success, Failure, or Pending, on the cashier page.
\n
Paysecure applies the outcome: status and status_history advance to reflect it, immediately.
\n
Paysecure fires the webhook: RSA signed, to your configured callback URL.
\n
Customer is redirected: to success_redirect, pending_redirect, or failure_redirect as appropriate.
\n
Pending expires: a purchase left in the pending state later moves to EXPIRED, and an expiry webhook is fired. The window is not a single fixed value: each method uses the same expiry window as the real APM it stands in for.
\n

Note that the simulator has no \"pending then paid\" path. Selecting Pending leads to expiry, not to a later success. If your integration must handle a pending-to-paid transition, that transition has to be validated against a live PSP connection.

Webhook events

\n\n\n\n\n\n\n\n\n\n\n\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	`status`	When it fires	Terminal?
Payment in process	`PENDING`	Pending selected on the cashier page	❌
Purchase paid	`PAID`	Success selected on the cashier page	✅
Purchase error	`ERROR`	Failure selected on the cashier page	✅
Purchase expired	`EXPIRED`	Pending window elapsed without resolution	✅

[VERIFY] The status values above follow Paysecure's documented purchase lifecycle rather than anything confirmed about the simulator. Before publishing, confirm with engineering: (a) the exact uppercase status the simulator writes for each cashier-page selection, (b) the exact webhook event name emitted for each, (c) which lowercase status_history entries the simulator actually writes, since the saved examples assume created, pending_execute, payment_in_process, paid, error, and expired, and (d) whether a webhook fires on creation. No creation webhook is documented here because none was confirmed.

Coverage and limits

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

APM	`paymentMethod`	Market	Currency
UPI Collect	`UPI-COLLECT`	🇮🇳 India	INR
UPI QR	`UPI-QR`	🇮🇳 India	INR
Netbanking	`NETBANKING`	🇮🇳 India	INR
Interac e-Transfer	`INTERAC`	🇨🇦 Canada	CAD
Interac Express	`INTERAC-EXPRESS`	🇨🇦 Canada	CAD
Interac Request Money	`INTERAC-REQUEST-MONEY`	🇨🇦 Canada	CAD
Pix	`PIX`	🇧🇷 Brazil	BRL
SPEI	`SPEI`	🇲🇽 Mexico	MXN
Fawry	`FawryPay`	🇪🇬 Egypt	EGP

[VERIFY] Market and currency mappings are the standard rail defaults for each method and have not been confirmed against the simulator connector configuration.

Standard sandbox limits and data retention apply. There are no simulator-specific limits and no cost.

\n","_postman_id":"aab8fc74-9f0b-4fa2-a143-da922e46a0f2"},{"name":"Enabling the Simulator","item":[],"id":"fe766c04-8705-40c3-9497-a6c65326edeb","description":"

Credentials

The simulator is enabled on every existing Paysecure sandbox account. There is nothing to request, no new credential to provision, and no key rotation required.

You need two values, both of which are in the Dashboard section of your merchant account login:

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

Value	Where it goes	Notes
Sandbox API key	`Authorization: Bearer {{APIKey}}` header	Must be the sandbox key. A production key routes to a live PSP
Sandbox Brand ID	`brand_id` in the request body	Must be the Brand ID belonging to the sandbox account

Endpoint

POST https://api.paysecure.net/api/v1/purchases/

https://api.paysecure.net/api/v1 is https://api.paysecure.net/api/v1, the same base URL as production. There is no separate simulator host.

The trigger

The credentials are the trigger. Send your normal purchase request with a supported paymentMethod value and sandbox credentials, and the transaction is routed to the simulator. There is:

no simulator-specific paymentMethod or psp_code,
no header to add,
no extraParam to set,
no magic amount,
no test email address or MSISDN,
no dashboard toggle.

This is intentional. Because no simulator-specific field exists, the request you validate against the simulator has the same shape and the same fields as the one you send in production. Two values change at go-live, your API key and your brand_id, and both are configuration rather than logic. Promoting an integration from simulator to live is a configuration change, not a code change.

\n
⚠️ The corollary is that a production API key sends a real transaction to a real PSP. Confirm which key your environment is loading before you run a test suite.
\n

Prerequisites

A webhook endpoint reachable from Paysecure, with RSA signature verification implemented. See the 🔌 Webhooks section of these docs for the signature scheme.
Values for success_redirect, pending_redirect, and failure_redirect. All three are needed to exercise all three outcomes.

\n","_postman_id":"fe766c04-8705-40c3-9497-a6c65326edeb"},{"name":"Supported APMs","item":[],"id":"26f88e3a-c299-488b-b4e3-e5d03029f920","description":"

The following methods simulate. Any paymentMethod value not in this table will not simulate, and the request will be handled as it is today for an unsupported or unconfigured method.

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

APM	`paymentMethod`	Market	Currency	Notes and quirks
UPI Collect	`UPI-COLLECT`	🇮🇳 India	INR	Collect request pushed to the customer's UPI app.
UPI QR	`UPI-QR`	🇮🇳 India	INR	QR-presented flow in production. The simulator substitutes its own cashier page.
Netbanking	`NETBANKING`	🇮🇳 India	INR	Bank-selection redirect in production.
Interac e-Transfer	`INTERAC`	🇨🇦 Canada	CAD	Standard Interac online banking redirect.
Interac Express	`INTERAC-EXPRESS`	🇨🇦 Canada	CAD	Express variant. Confirm it is enabled on your production account before go-live.
Interac Request Money	`INTERAC-REQUEST-MONEY`	🇨🇦 Canada	CAD	Request-money variant, customer-initiated approval in production.
Pix	`PIX`	🇧🇷 Brazil	BRL	QR/copy-paste payload in production. The simulator does not issue a real Pix payload.
SPEI	`SPEI`	🇲🇽 Mexico	MXN	CLABE-based bank transfer in production. No real CLABE is issued by the simulator.
Fawry	`FawryPay`	🇪🇬 Egypt	EGP	Voucher/reference flow in production. No real Fawry reference is issued.

[VERIFY] Market and currency mappings above are the standard rail defaults for each method. Confirm them against the simulator connector configuration.

[VERIFY] FawryPay is mixed case while every other enum in the list is uppercase, and the documented convention for paymentMethod is an uppercase value. Confirm whether the correct enum is FawryPay or FAWRYPAY before publishing.

Not covered

PayOut. The simulator is PayIn only.
Refunds, partial refunds, chargebacks, disputes, and reversals. No post-transaction flow is simulated.
Every other payment method, including cards, bank transfers, and open banking. More APMs will be added over time. No schedule is published.

Method-specific caveat

For methods whose production flow depends on a payload the rail issues, such as a Pix payload, a SPEI CLABE, or a Fawry reference, the simulator does not issue that value. The simulator substitutes its own cashier page. If your integration parses or renders such a payload, that parsing must be validated against a live PSP connection. See Migrating from Simulator to Live.

\n","_postman_id":"26f88e3a-c299-488b-b4e3-e5d03029f920"},{"name":"Forcing Outcomes","item":[],"id":"c4ddfef6-7842-41a4-b442-235ff8918aaa","description":"

Scenario matrix

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

Outcome	How to trigger	Resulting `status`	Webhook	Customer returns to
Success	Select Success on the simulator cashier page	`PAID`	Fired, terminal	`success_redirect`
Failure	Select Failure on the simulator cashier page	`ERROR`	Fired, terminal	`failure_redirect`
Pending	Select Pending on the simulator cashier page	`PENDING`	Fired, non-terminal	`pending_redirect`
Expired	Leave a Pending purchase unresolved until its expiry window elapses	`EXPIRED`	Fired, terminal	Not applicable, no further customer interaction

[VERIFY] Exact status values and webhook event names per selection, per the note in Concepts.

The request is the same for every outcome

There is no test_scenario parameter, no magic amount, and no flag. The request body is identical for all three outcomes. The outcome is selected downstream, on the cashier page.

This means the \"request example for each outcome\" is one example, and the divergence happens after it:

POST https://api.paysecure.net/api/v1/purchases/\nAuthorization: Bearer {{APIKey}}\nContent-Type: application/json\n<the body shown in PayIn API → Purchases>\n\n

To test a success, open the returned checkout_url and select Success. To test a decline, send the request again with a new merchantRef and select Failure. To test pending and expiry, send it again with another new merchantRef, select Pending, and wait out the method's expiry window. Reuse the same merchantRef across runs and your own duplicate-prevention logic should reject the repeat, which is a useful test in itself but not the one you are trying to run here.

Recommended test matrix

Run this sequence per method you intend to go live with:

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

#	Test	What you are proving
1	Success	Purchase creation, `checkout_url` handling, paid webhook, `success_redirect`
2	Failure	Your failure branch, error webhook, `failure_redirect`, and that you do not mark the order paid
3	Pending	Your pending branch, that the order is held rather than failed or paid, and `pending_redirect`
4	Pending to expiry	That the expiry webhook releases or cancels the held order correctly
5	Duplicate `merchantRef`	Your duplicate-prevention behaviour
6	Webhook signature tamper	That your verification rejects an altered payload

Tests 5 and 6 are not simulator features, they are tests the simulator makes cheap to run repeatedly.

Tests 1 to 3, 5, and 6 resolve instantly and are suitable for a normal CI job. Test 4 is not: it waits out the method's real expiry window, which can be long. Run it in a scheduled or long-running job rather than in a per-commit pipeline.

Expiry windows

The pending-to-expired window is not a single fixed value. Each method expires on the same window as the real APM it stands in for, so the timing you observe in the simulator is the timing to design for. [TBD: engineering to supply the per-method expiry windows so they can be tabulated here.]

\n","_postman_id":"c4ddfef6-7842-41a4-b442-235ff8918aaa"},{"name":"PayIn API","item":[{"name":"Purchases","id":"57cda182-a223-4994-b7ee-ada75f4253ba","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer {{APIKey}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"client\": {\n \"email\": \"user3782@example.com\",\n \"full_name\": \"Test Customer\",\n \"country\": \"IN\",\n \"city\": \"Ashford\",\n \"street_address\": \"90 Fixture Close\",\n \"zip_code\": \"400001\",\n \"phone\": \"+910000000000\"\n },\n \"purchase\": {\n \"currency\": \"INR\",\n \"products\": [\n {\n \"name\": \"Simulator test item\",\n \"price\": 100.0\n }\n ]\n },\n \"paymentMethod\": \"UPI-COLLECT\",\n \"brand_id\": \"your-brand-id\",\n \"merchantRef\": \"SIM-UPI-0001\",\n \"success_redirect\": \"https://your.success.redirect.com\",\n \"pending_redirect\": \"https://your.pending.redirect.com\",\n \"failure_redirect\": \"https://your.failure.redirect.com\",\n \"success_callback\": \"https://your.success.callback.com\",\n \"failure_callback\": \"https://your.failure.callback.com\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.paysecure.net/api/v1/purchases","description":"

To initiate a simulated APM payment, the first call to make is /purchases. It is the same call, the same URL, and the same body you use in production. Authenticating with sandbox credentials is what routes the purchase to the simulator.

The response is the full purchase envelope. The field you need next is checkout_url, which is the simulator cashier page. Send the customer there and select the outcome you want to test.

Request Body 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

Parameter	Notes
client.email	Conditional. Recommended. Any syntactically valid address works in the simulator; no mail is delivered to a real customer.
client.full_name	Optional. Customer name.
client.country	Conditional. ISO 3166-1 alpha-2. Should match the market of the `paymentMethod` you are simulating, for example `IN` for `UPI-COLLECT`.
client.city	Optional. Customer city.
client.street_address	Optional. Customer street address.
client.zip_code	Optional. Customer postal code.
client.phone	Optional. E.164 format. No message is sent by the simulator.
purchase.currency	Mandatory. ISO 4217 code. Should be the currency configured for the `paymentMethod` being simulated, for example `INR` for `UPI-COLLECT`. See Supported APMs. `[VERIFY]` whether a currency and method mismatch is rejected outright or simply fails downstream.
purchase.products.name	Mandatory. Line-item description.
purchase.products.price	Mandatory. Decimal with 2 places, for example `100.00`. The amount does not influence the outcome; there are no magic amounts in the simulator.
paymentMethod	Mandatory. One of the supported simulator enums. See Supported APMs. A value outside that list will not simulate.
brand_id	Mandatory. Your sandbox Brand ID, from the Dashboard section of your merchant account login.
merchantRef	Optional. Your own reference. See Essential Optional Parameters below.
success_redirect	Mandatory. Where the customer is returned after selecting Success.
pending_redirect	Conditional. Mandatory if you want to exercise the Pending outcome, because that is where the customer is returned after selecting Pending. Populate it even if you do not expect pending in production, or you cannot test the pending branch at all.
failure_redirect	Mandatory. Where the customer is returned after selecting Failure.
success_callback	Conditional. Webhook URL for successful outcomes, if not configured account-wide.
failure_callback	Conditional. Webhook URL for failed outcomes, if not configured account-wide.

Essential Optional Parameters

merchantRef is your own reference for the transaction and carries two advantages. It prevents duplicates: if you resend a request with a merchantRef you have already used, you can detect and reject the repeat rather than creating a second purchase. It also makes retrieval straightforward, because you can locate the transaction by your own identifier instead of storing and matching Paysecure's purchaseId. In the simulator it is worth setting a predictable, scheme-based value such as SIM-UPI-0001, so a CI run's transactions are easy to find in Transaction Reporting.

Response

The response is the complete purchase envelope, not a trimmed object. At creation:

status is CREATED and status_history holds a single created entry.
checkout_url is the simulator cashier page. Send the customer here.
transaction_data.attempts is empty until an outcome is selected.
refund_availability is NONE, because refunds are not simulated.
payment.paid_on is null until Success is selected.

\n
Values in the saved examples are illustrative; the structure is authoritative. Timestamps, references, and identifiers are made up. Do not treat any specific value as a contract.
\n

[VERIFY] Three things in the saved examples are inference, not confirmed simulator behaviour, and must be checked before publishing:

is_test is shown as false because that is the documented envelope default. If the simulator sets is_test: true, that is the field merchants and support should filter reporting on, and every example here must be corrected.
status_history entries. The examples assume pending_execute and payment_in_process are written. Confirm which intermediate states the simulator actually produces.
transaction_data.attempts semantics, including whether an attempt is recorded for a pending purchase and what successful holds while the purchase is unresolved.

\n","urlObject":{"path":["purchases"],"host":["https://api.paysecure.net/api/v1"],"query":[],"variable":[]}},"response":[{"id":"2a2e04e1-f598-4414-8103-e84ed06dce2d","name":"Purchase - Success (created, awaiting outcome selection)","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer {{APIKey}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"client\": {\n \"email\": \"user3782@example.com\",\n \"full_name\": \"Test Customer\",\n \"country\": \"IN\",\n \"city\": \"Ashford\",\n \"street_address\": \"90 Fixture Close\",\n \"zip_code\": \"400001\",\n \"phone\": \"+910000000000\"\n },\n \"purchase\": {\n \"currency\": \"INR\",\n \"products\": [\n {\n \"name\": \"Simulator test item\",\n \"price\": 100.0\n }\n ]\n },\n \"paymentMethod\": \"UPI-COLLECT\",\n \"brand_id\": \"your-brand-id\",\n \"merchantRef\": \"SIM-UPI-0001\",\n \"success_redirect\": \"https://your.success.redirect.com\",\n \"pending_redirect\": \"https://your.pending.redirect.com\",\n \"failure_redirect\": \"https://your.failure.redirect.com\",\n \"success_callback\": \"https://your.success.callback.com\",\n \"failure_callback\": \"https://your.failure.callback.com\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.paysecure.net/api/v1/purchases"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"purchaseId\": \"6a6db590a1b2c3d4e5f6a701\",\n \"client\": {\n \"bank_account\": \"\",\n \"bank_code\": \"\",\n \"email\": \"user3782@example.com\",\n \"phone\": \"+910000000000\",\n \"full_name\": \"Test Customer\",\n \"date_of_birth\": \"\",\n \"personal_code\": \"\",\n \"street_address\": \"90 Fixture Close\",\n \"country\": \"IN\",\n \"city\": \"Ashford\",\n \"zip_code\": \"400001\",\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\": \"\"\n },\n \"updated_on\": 1785574800,\n \"type\": \"purchase\",\n \"force_recurring\": false,\n \"created_on\": 1785574800,\n \"purchase\": {\n \"currency\": \"INR\",\n \"products\": [\n {\n \"name\": \"Simulator test item\",\n \"quantity\": 1,\n \"price\": 100.0,\n \"discount\": 0,\n \"tax_percent\": \"0.00\"\n }\n ],\n \"total\": 100.0,\n \"language\": \"en\",\n \"notes\": \"\",\n \"debt\": 0,\n \"total_formatted\": 100.0,\n \"request_client_details\": [],\n \"timezone\": \"Asia/Kolkata\",\n \"email_message\": \"\"\n },\n \"payment\": {\n \"is_outgoing\": false,\n \"payment_type\": \"PURCHASE\",\n \"amount\": 100.0,\n \"currency\": \"INR\",\n \"net_amount\": 100.0,\n \"fee_amount\": 0,\n \"pending_amount\": 0,\n \"pending_unfreeze_on\": null,\n \"description\": \"\",\n \"paid_on\": null,\n \"remote_paid_on\": null\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\": \"Example Merchant\",\n \"brand_name\": \"Example Merchant\",\n \"registration_number\": \"\",\n \"tax_number\": \"\"\n },\n \"transaction_data\": {\n \"payment_method\": \"UPI-COLLECT\",\n \"flow\": \"\",\n \"extra\": {},\n \"country\": \"IN\",\n \"attempts\": []\n },\n \"status\": \"CREATED\",\n \"status_history\": [\n {\n \"status\": \"created\",\n \"timestamp\": 1785574800\n }\n ],\n \"viewedOn\": null,\n \"is_test\": false,\n \"brand_id\": \"your-brand-id\",\n \"merchantRef\": \"SIM-UPI-0001\",\n \"send_receipt\": false,\n \"is_recurring_token\": false,\n \"skip_capture\": false,\n \"reference_generated\": \"\",\n \"issued\": \"2026-08-01\",\n \"due\": 1785574800,\n \"refund_upto\": 1785574800,\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\": \"https://your.success.callback.com\",\n \"platform\": \"API\",\n \"created_from_ip\": \"203.0.113.138\",\n \"checkout_url\": \"https://api.paysecure.net/payments/6a6db590a1b2c3d4e5f6a701/\",\n \"direct_post_url\": \"https://api.paysecure.net/api/v1/p/6a6db590a1b2c3d4e5f6a701/\",\n \"pending_redirect\": \"https://your.pending.redirect.com\",\n \"failure_callback\": \"https://your.failure.callback.com\"\n}"},{"id":"d4a885e8-3817-4d77-947a-3b44b7ee2f76","name":"Purchase - Error (Brand not found)","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer {{APIKey}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"client\": {\n \"email\": \"user3782@example.com\",\n \"full_name\": \"Test Customer\",\n \"country\": \"IN\",\n \"city\": \"Ashford\",\n \"street_address\": \"90 Fixture Close\",\n \"zip_code\": \"400001\",\n \"phone\": \"+910000000000\"\n },\n \"purchase\": {\n \"currency\": \"INR\",\n \"products\": [\n {\n \"name\": \"Simulator test item\",\n \"price\": 100.0\n }\n ]\n },\n \"paymentMethod\": \"UPI-COLLECT\",\n \"brand_id\": \"your-brand-id\",\n \"merchantRef\": \"SIM-UPI-0006\",\n \"success_redirect\": \"https://your.success.redirect.com\",\n \"pending_redirect\": \"https://your.pending.redirect.com\",\n \"failure_redirect\": \"https://your.failure.redirect.com\",\n \"success_callback\": \"https://your.success.callback.com\",\n \"failure_callback\": \"https://your.failure.callback.com\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.paysecure.net/api/v1/purchases"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Brand not found\",\n \"code\": \"transaction_error\"\n}"}],"_postman_id":"57cda182-a223-4994-b7ee-ada75f4253ba"},{"name":"Get Status","id":"03cc8134-ff8e-4069-baaf-07b625e16d34","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{APIKey}}","type":"text"}],"url":"https://api.paysecure.net/api/v1/purchases/{purchaseId}","description":"

Retrieve the current state of a simulated purchase. Use this to observe the outcome you selected on the cashier page, and to watch a pending purchase move to expired.

The response is the same full purchase envelope returned by /purchases, with status and status_history reflecting the current state.

Path Parameters

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

Parameter	Notes
purchaseId	Mandatory. The `purchaseId` returned by `POST https://api.paysecure.net/api/v1/purchases/`.

Status values you will see in the simulator

\n\n\n\n\n\n\n\n\n\n\n\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`	Meaning	Terminal?
`CREATED`	Purchase registered, no outcome selected yet	❌
`PENDING`	Pending was selected on the cashier page	❌
`PAID`	Success was selected	✅
`ERROR`	Failure was selected	✅
`EXPIRED`	A pending purchase passed its expiry window	✅

The saved examples below cover all four outcomes. Note that status_history uses lowercase status names and Unix timestamps, while the top-level status is uppercase.

[VERIFY] Exact status values per cashier-page selection, per Concepts.

\n","urlObject":{"path":["purchases","{purchaseId}"],"host":["https://api.paysecure.net/api/v1"],"query":[],"variable":[]}},"response":[{"id":"d2ec5598-bd2b-48f2-8ee9-d7dab12d55d6","name":"Get Status - PAID (Success selected)","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{APIKey}}","type":"text"}],"url":"https://api.paysecure.net/api/v1/purchases/{purchaseId}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"purchaseId\": \"6a6db590a1b2c3d4e5f6a702\",\n \"client\": {\n \"bank_account\": \"\",\n \"bank_code\": \"\",\n \"email\": \"user3782@example.com\",\n \"phone\": \"+910000000000\",\n \"full_name\": \"Test Customer\",\n \"date_of_birth\": \"\",\n \"personal_code\": \"\",\n \"street_address\": \"90 Fixture Close\",\n \"country\": \"IN\",\n \"city\": \"Ashford\",\n \"zip_code\": \"400001\",\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\": \"\"\n },\n \"updated_on\": 1785574819,\n \"type\": \"purchase\",\n \"force_recurring\": false,\n \"created_on\": 1785574800,\n \"purchase\": {\n \"currency\": \"INR\",\n \"products\": [\n {\n \"name\": \"Simulator test item\",\n \"quantity\": 1,\n \"price\": 100.0,\n \"discount\": 0,\n \"tax_percent\": \"0.00\"\n }\n ],\n \"total\": 100.0,\n \"language\": \"en\",\n \"notes\": \"\",\n \"debt\": 0,\n \"total_formatted\": 100.0,\n \"request_client_details\": [],\n \"timezone\": \"Asia/Kolkata\",\n \"email_message\": \"\"\n },\n \"payment\": {\n \"is_outgoing\": false,\n \"payment_type\": \"PURCHASE\",\n \"amount\": 100.0,\n \"currency\": \"INR\",\n \"net_amount\": 100.0,\n \"fee_amount\": 0,\n \"pending_amount\": 0,\n \"pending_unfreeze_on\": null,\n \"description\": \"\",\n \"paid_on\": 1785574819,\n \"remote_paid_on\": 1785574819\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\": \"Example Merchant\",\n \"brand_name\": \"Example Merchant\",\n \"registration_number\": \"\",\n \"tax_number\": \"\"\n },\n \"transaction_data\": {\n \"payment_method\": \"UPI-COLLECT\",\n \"flow\": \"\",\n \"extra\": {},\n \"country\": \"IN\",\n \"attempts\": [\n {\n \"client_ip\": \"203.0.113.138\",\n \"type\": \"execute\",\n \"payment_method\": \"UPI-COLLECT\",\n \"flow\": \"\",\n \"successful\": true,\n \"country\": \"IN\",\n \"processing_time\": 1785574819,\n \"extra\": {}\n }\n ]\n },\n \"status\": \"PAID\",\n \"status_history\": [\n {\n \"status\": \"created\",\n \"timestamp\": 1785574800\n },\n {\n \"status\": \"pending_execute\",\n \"timestamp\": 1785574808\n },\n {\n \"status\": \"paid\",\n \"timestamp\": 1785574819\n }\n ],\n \"viewedOn\": 1785574806,\n \"is_test\": false,\n \"brand_id\": \"your-brand-id\",\n \"merchantRef\": \"SIM-UPI-0002\",\n \"send_receipt\": false,\n \"is_recurring_token\": false,\n \"skip_capture\": false,\n \"reference_generated\": \"\",\n \"issued\": \"2026-08-01\",\n \"due\": 1785574800,\n \"refund_upto\": 1785574800,\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\": \"https://your.success.callback.com\",\n \"platform\": \"API\",\n \"created_from_ip\": \"203.0.113.138\",\n \"checkout_url\": \"https://api.paysecure.net/payments/6a6db590a1b2c3d4e5f6a702/\",\n \"direct_post_url\": \"https://api.paysecure.net/api/v1/p/6a6db590a1b2c3d4e5f6a702/\",\n \"pending_redirect\": \"https://your.pending.redirect.com\",\n \"failure_callback\": \"https://your.failure.callback.com\"\n}"},{"id":"5341a0be-fda5-41d1-b8fb-8197b3cdb379","name":"Get Status - ERROR (Failure selected)","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{APIKey}}","type":"text"}],"url":"https://api.paysecure.net/api/v1/purchases/{purchaseId}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"purchaseId\": \"6a6db590a1b2c3d4e5f6a703\",\n \"client\": {\n \"bank_account\": \"\",\n \"bank_code\": \"\",\n \"email\": \"user3782@example.com\",\n \"phone\": \"+910000000000\",\n \"full_name\": \"Test Customer\",\n \"date_of_birth\": \"\",\n \"personal_code\": \"\",\n \"street_address\": \"90 Fixture Close\",\n \"country\": \"IN\",\n \"city\": \"Ashford\",\n \"zip_code\": \"400001\",\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\": \"\"\n },\n \"updated_on\": 1785574819,\n \"type\": \"purchase\",\n \"force_recurring\": false,\n \"created_on\": 1785574800,\n \"purchase\": {\n \"currency\": \"INR\",\n \"products\": [\n {\n \"name\": \"Simulator test item\",\n \"quantity\": 1,\n \"price\": 100.0,\n \"discount\": 0,\n \"tax_percent\": \"0.00\"\n }\n ],\n \"total\": 100.0,\n \"language\": \"en\",\n \"notes\": \"\",\n \"debt\": 0,\n \"total_formatted\": 100.0,\n \"request_client_details\": [],\n \"timezone\": \"Asia/Kolkata\",\n \"email_message\": \"\"\n },\n \"payment\": {\n \"is_outgoing\": false,\n \"payment_type\": \"PURCHASE\",\n \"amount\": 100.0,\n \"currency\": \"INR\",\n \"net_amount\": 100.0,\n \"fee_amount\": 0,\n \"pending_amount\": 0,\n \"pending_unfreeze_on\": null,\n \"description\": \"\",\n \"paid_on\": null,\n \"remote_paid_on\": null\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\": \"Example Merchant\",\n \"brand_name\": \"Example Merchant\",\n \"registration_number\": \"\",\n \"tax_number\": \"\"\n },\n \"transaction_data\": {\n \"payment_method\": \"UPI-COLLECT\",\n \"flow\": \"\",\n \"extra\": {},\n \"country\": \"IN\",\n \"attempts\": [\n {\n \"client_ip\": \"203.0.113.138\",\n \"type\": \"execute\",\n \"payment_method\": \"UPI-COLLECT\",\n \"flow\": \"\",\n \"successful\": false,\n \"country\": \"IN\",\n \"processing_time\": 1785574819,\n \"extra\": {}\n }\n ]\n },\n \"status\": \"ERROR\",\n \"status_history\": [\n {\n \"status\": \"created\",\n \"timestamp\": 1785574800\n },\n {\n \"status\": \"pending_execute\",\n \"timestamp\": 1785574808\n },\n {\n \"status\": \"error\",\n \"timestamp\": 1785574819\n }\n ],\n \"viewedOn\": 1785574806,\n \"is_test\": false,\n \"brand_id\": \"your-brand-id\",\n \"merchantRef\": \"SIM-UPI-0003\",\n \"send_receipt\": false,\n \"is_recurring_token\": false,\n \"skip_capture\": false,\n \"reference_generated\": \"\",\n \"issued\": \"2026-08-01\",\n \"due\": 1785574800,\n \"refund_upto\": 1785574800,\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\": \"https://your.success.callback.com\",\n \"platform\": \"API\",\n \"created_from_ip\": \"203.0.113.138\",\n \"checkout_url\": \"https://api.paysecure.net/payments/6a6db590a1b2c3d4e5f6a703/\",\n \"direct_post_url\": \"https://api.paysecure.net/api/v1/p/6a6db590a1b2c3d4e5f6a703/\",\n \"pending_redirect\": \"https://your.pending.redirect.com\",\n \"failure_callback\": \"https://your.failure.callback.com\"\n}"},{"id":"293b8d74-54ec-401f-8dd0-42bb26e05bc0","name":"Get Status - PENDING (Pending selected)","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{APIKey}}","type":"text"}],"url":"https://api.paysecure.net/api/v1/purchases/{purchaseId}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"purchaseId\": \"6a6db590a1b2c3d4e5f6a704\",\n \"client\": {\n \"bank_account\": \"\",\n \"bank_code\": \"\",\n \"email\": \"user3782@example.com\",\n \"phone\": \"+910000000000\",\n \"full_name\": \"Test Customer\",\n \"date_of_birth\": \"\",\n \"personal_code\": \"\",\n \"street_address\": \"90 Fixture Close\",\n \"country\": \"IN\",\n \"city\": \"Ashford\",\n \"zip_code\": \"400001\",\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\": \"\"\n },\n \"updated_on\": 1785574819,\n \"type\": \"purchase\",\n \"force_recurring\": false,\n \"created_on\": 1785574800,\n \"purchase\": {\n \"currency\": \"INR\",\n \"products\": [\n {\n \"name\": \"Simulator test item\",\n \"quantity\": 1,\n \"price\": 100.0,\n \"discount\": 0,\n \"tax_percent\": \"0.00\"\n }\n ],\n \"total\": 100.0,\n \"language\": \"en\",\n \"notes\": \"\",\n \"debt\": 0,\n \"total_formatted\": 100.0,\n \"request_client_details\": [],\n \"timezone\": \"Asia/Kolkata\",\n \"email_message\": \"\"\n },\n \"payment\": {\n \"is_outgoing\": false,\n \"payment_type\": \"PURCHASE\",\n \"amount\": 100.0,\n \"currency\": \"INR\",\n \"net_amount\": 100.0,\n \"fee_amount\": 0,\n \"pending_amount\": 0,\n \"pending_unfreeze_on\": null,\n \"description\": \"\",\n \"paid_on\": null,\n \"remote_paid_on\": null\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\": \"Example Merchant\",\n \"brand_name\": \"Example Merchant\",\n \"registration_number\": \"\",\n \"tax_number\": \"\"\n },\n \"transaction_data\": {\n \"payment_method\": \"UPI-COLLECT\",\n \"flow\": \"\",\n \"extra\": {},\n \"country\": \"IN\",\n \"attempts\": [\n {\n \"client_ip\": \"203.0.113.138\",\n \"type\": \"execute\",\n \"payment_method\": \"UPI-COLLECT\",\n \"flow\": \"\",\n \"successful\": false,\n \"country\": \"IN\",\n \"processing_time\": 1785574819,\n \"extra\": {}\n }\n ]\n },\n \"status\": \"PENDING\",\n \"status_history\": [\n {\n \"status\": \"created\",\n \"timestamp\": 1785574800\n },\n {\n \"status\": \"pending_execute\",\n \"timestamp\": 1785574808\n },\n {\n \"status\": \"payment_in_process\",\n \"timestamp\": 1785574819\n }\n ],\n \"viewedOn\": 1785574806,\n \"is_test\": false,\n \"brand_id\": \"your-brand-id\",\n \"merchantRef\": \"SIM-UPI-0004\",\n \"send_receipt\": false,\n \"is_recurring_token\": false,\n \"skip_capture\": false,\n \"reference_generated\": \"\",\n \"issued\": \"2026-08-01\",\n \"due\": 1785574800,\n \"refund_upto\": 1785574800,\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\": \"https://your.success.callback.com\",\n \"platform\": \"API\",\n \"created_from_ip\": \"203.0.113.138\",\n \"checkout_url\": \"https://api.paysecure.net/payments/6a6db590a1b2c3d4e5f6a704/\",\n \"direct_post_url\": \"https://api.paysecure.net/api/v1/p/6a6db590a1b2c3d4e5f6a704/\",\n \"pending_redirect\": \"https://your.pending.redirect.com\",\n \"failure_callback\": \"https://your.failure.callback.com\"\n}"},{"id":"ed0ae084-e622-4e74-820a-f4c6c7edfcb7","name":"Get Status - EXPIRED (pending window elapsed)","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{APIKey}}","type":"text"}],"url":"https://api.paysecure.net/api/v1/purchases/{purchaseId}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"purchaseId\": \"6a6db590a1b2c3d4e5f6a705\",\n \"client\": {\n \"bank_account\": \"\",\n \"bank_code\": \"\",\n \"email\": \"user3782@example.com\",\n \"phone\": \"+910000000000\",\n \"full_name\": \"Test Customer\",\n \"date_of_birth\": \"\",\n \"personal_code\": \"\",\n \"street_address\": \"90 Fixture Close\",\n \"country\": \"IN\",\n \"city\": \"Ashford\",\n \"zip_code\": \"400001\",\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\": \"\"\n },\n \"updated_on\": 1785579719,\n \"type\": \"purchase\",\n \"force_recurring\": false,\n \"created_on\": 1785574800,\n \"purchase\": {\n \"currency\": \"INR\",\n \"products\": [\n {\n \"name\": \"Simulator test item\",\n \"quantity\": 1,\n \"price\": 100.0,\n \"discount\": 0,\n \"tax_percent\": \"0.00\"\n }\n ],\n \"total\": 100.0,\n \"language\": \"en\",\n \"notes\": \"\",\n \"debt\": 0,\n \"total_formatted\": 100.0,\n \"request_client_details\": [],\n \"timezone\": \"Asia/Kolkata\",\n \"email_message\": \"\"\n },\n \"payment\": {\n \"is_outgoing\": false,\n \"payment_type\": \"PURCHASE\",\n \"amount\": 100.0,\n \"currency\": \"INR\",\n \"net_amount\": 100.0,\n \"fee_amount\": 0,\n \"pending_amount\": 0,\n \"pending_unfreeze_on\": null,\n \"description\": \"\",\n \"paid_on\": null,\n \"remote_paid_on\": null\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\": \"Example Merchant\",\n \"brand_name\": \"Example Merchant\",\n \"registration_number\": \"\",\n \"tax_number\": \"\"\n },\n \"transaction_data\": {\n \"payment_method\": \"UPI-COLLECT\",\n \"flow\": \"\",\n \"extra\": {},\n \"country\": \"IN\",\n \"attempts\": [\n {\n \"client_ip\": \"203.0.113.138\",\n \"type\": \"execute\",\n \"payment_method\": \"UPI-COLLECT\",\n \"flow\": \"\",\n \"successful\": false,\n \"country\": \"IN\",\n \"processing_time\": 1785574819,\n \"extra\": {}\n }\n ]\n },\n \"status\": \"EXPIRED\",\n \"status_history\": [\n {\n \"status\": \"created\",\n \"timestamp\": 1785574800\n },\n {\n \"status\": \"pending_execute\",\n \"timestamp\": 1785574808\n },\n {\n \"status\": \"payment_in_process\",\n \"timestamp\": 1785574819\n },\n {\n \"status\": \"expired\",\n \"timestamp\": 1785579719\n }\n ],\n \"viewedOn\": 1785574806,\n \"is_test\": false,\n \"brand_id\": \"your-brand-id\",\n \"merchantRef\": \"SIM-UPI-0005\",\n \"send_receipt\": false,\n \"is_recurring_token\": false,\n \"skip_capture\": false,\n \"reference_generated\": \"\",\n \"issued\": \"2026-08-01\",\n \"due\": 1785574800,\n \"refund_upto\": 1785574800,\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\": \"https://your.success.callback.com\",\n \"platform\": \"API\",\n \"created_from_ip\": \"203.0.113.138\",\n \"checkout_url\": \"https://api.paysecure.net/payments/6a6db590a1b2c3d4e5f6a705/\",\n \"direct_post_url\": \"https://api.paysecure.net/api/v1/p/6a6db590a1b2c3d4e5f6a705/\",\n \"pending_redirect\": \"https://your.pending.redirect.com\",\n \"failure_callback\": \"https://your.failure.callback.com\"\n}"},{"id":"0a511f09-f415-4832-b489-965c20cd6f26","name":"Get Status - Error (Purchase not found)","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{APIKey}}","type":"text"}],"url":"https://api.paysecure.net/api/v1/purchases/{purchaseId}"},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Purchase not found\",\n \"code\": \"transaction_error\"\n}"}],"_postman_id":"03cc8134-ff8e-4069-baaf-07b625e16d34"}],"id":"395f5534-41cb-4b9c-a22d-7bb55f70a4b6","description":"

Simulated PayIn uses the standard /purchases contract. Create the purchase, send the customer to the returned checkout_url, select the outcome, then read the result with Get Status.

\n","_postman_id":"395f5534-41cb-4b9c-a22d-7bb55f70a4b6"},{"name":"Webhooks","item":[],"id":"2a9721f8-aa43-40e0-ae3f-f41df6cc4549","description":"

Simulated transactions fire webhooks to your configured callback URL. They are signed with RSA exactly as production webhooks are, so your signature verification is genuinely exercised. The payload carries fewer fields than a live APM webhook.

Signature verification

The signature scheme is identical to production. Verify simulated webhooks the same way you verify live ones, per the 🔌 Webhooks section of these docs. [VERIFY] whether the sandbox account uses a different public key from production, which determines whether anything has to change at go-live. Do not special-case simulated callbacks in your verification path: doing so defeats most of the value of testing against the simulator, and it is a change you would then have to unwind before go-live.

A verification failure on a simulated webhook is a real finding. In practice it is almost always a key-configuration or canonicalisation bug on the merchant side, which is exactly the class of defect the simulator is meant to surface before production.

Events per outcome

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

Selection on cashier page	`status` in payload	Terminal?	Then what
Success	`PAID`	✅	Nothing further
Failure	`ERROR`	✅	Nothing further
Pending	`PENDING`	❌	A second webhook with `EXPIRED` follows once the window elapses
None, window elapsed	`EXPIRED`	✅	Nothing further

Practical guidance

Key off purchaseId and merchantRef, and treat the webhook as a signal to fetch state rather than as the state itself. Call GET https://api.paysecure.net/api/v1/purchases/{purchaseId}/ to read the authoritative envelope. This pattern is robust against the reduced simulated payload and is good practice in production regardless.
\n
Make your listener idempotent. Handle the same purchaseId arriving more than once.
\n
Expect two webhooks for the pending path, PENDING then EXPIRED, and make sure the second one does not overwrite a state you have already resolved by other means.
\n

\n","_postman_id":"2a9721f8-aa43-40e0-ae3f-f41df6cc4549"},{"name":"Migrating from Simulator to Live","item":[],"id":"4f347e34-5153-49db-9621-856a5e880732","description":"

Moving from the simulator to a live PSP connection is a credential change, not a code change. That is the point of the design. This checklist covers what changes, and what the simulator could not have proved.

What changes

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

Item	Simulator	Live
API key	Sandbox key	Production key
`brand_id`	Sandbox Brand ID	Production Brand ID
Base URL	`https://api.paysecure.net/api/v1`	`https://api.paysecure.net/api/v1`, unchanged
Endpoint and body	`POST /purchases/`	Unchanged
`paymentMethod`	Supported simulator enum	Same enum, assuming the method is enabled on your production account
Webhook public key	Sandbox key	Production key. `[VERIFY]` whether these actually differ
Redirect URLs	Test URLs	Production URLs
Customer page	Simulator cashier page	The real APM page, app, QR, or voucher

Before you switch

Confirm the method is contracted and enabled on your production account. A working simulator integration is not evidence that it is.
Confirm your production webhook endpoint is reachable and verifying against the production public key.
Confirm your environment configuration cannot load a sandbox key in production, or a production key in a test suite. This is the most common cause of a surprise live transaction.
Replace test redirect URLs with production URLs, and confirm all three resolve.
Confirm you are not special-casing anything about simulated transactions in your production code path.

What you must still test live

The simulator cannot establish any of the following. Plan live test transactions for each that applies:

PSP UAT. Whatever certification or UAT your PSP requires still applies, in full.
Method-specific payload handling. A real Pix payload, SPEI CLABE, Fawry reference, or UPI collect request. The simulator does not issue these, so any code that parses, renders, or displays them is untested.
Real-world timing. Simulated outcomes are instant. Your timeout, polling interval, and retry behaviour must be validated against real APM latency, which for some methods is minutes or hours.
Pending to paid. The simulator's pending path ends in expiry. A pending purchase that later succeeds is a transition the simulator cannot produce.
Full webhook payloads. Simulated payloads are reduced. Confirm your listener handles the complete live payload.
Refunds, partial refunds, chargebacks, disputes, and reversals, where the method supports them. None are simulated.
The real error surface. The simulator exposes one generic failure. A live rail returns method-specific decline and error conditions.
Settlement and reconciliation. No simulated transaction settles, so your reconciliation against settlement files is untested.

Suggested go-live sequence

Full simulator pass on all four outcomes. Outcomes 1 to 3 in CI; the pending-to-expiry case in a longer-running job, since it waits out the real expiry window.
PSP UAT, per your PSP's requirements.
A small number of low-value live transactions per method, covering at minimum one success and one customer-abandoned attempt.
Reconcile those live transactions against your settlement report.
Ramp.

\n","_postman_id":"4f347e34-5153-49db-9621-856a5e880732"},{"name":"Troubleshooting","item":[],"id":"2bf40a0b-2c45-4438-b86f-df325bebd3e6","description":"

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

Symptom	Likely cause	Fix
Transaction went to a real PSP and real money moved	A production API key was loaded instead of the sandbox key	Check which key your environment resolved. Separate the two so a test suite cannot reach a production key
Method does not simulate	`paymentMethod` is not one of the supported simulator enums	Check the value against Supported APMs. Watch casing, and see the open question on `FawryPay`. `[VERIFY]` the exact error or behaviour returned for an unsupported method
`checkout_url` does not show a simulator cashier page	Production credentials were used, so a real APM page was returned	Confirm you authenticated with the sandbox key and sent the sandbox `brand_id`
Rejected on creation	`purchase.currency` is not the currency configured for the method, or `brand_id` is not the sandbox Brand ID	Match the currency to the method per Supported APMs, and confirm the Brand ID. `[VERIFY]` the exact error returned in each case
No webhook received	Callback URL not configured or not reachable from Paysecure	Confirm `success_callback` and `failure_callback`, or the account-wide configuration, and confirm the endpoint is publicly reachable
Webhook signature verification fails	Verifying against the wrong public key, or a canonicalisation bug	Verify against the sandbox account's public key. This is a real finding, not a simulator artefact. See Webhooks
A field present in a live webhook is missing	Simulated payloads are reduced	Treat fields as optional and fetch state with `GET https://api.paysecure.net/api/v1/purchases/{purchaseId}/`. See Webhooks
Pending purchase never becomes paid	By design. The simulator's pending path ends in expiry	Test the pending-to-paid transition against a live PSP connection. See Migrating from Simulator to Live
Purchase expired sooner or later than expected	Expiry follows the real APM's own window, which differs per method	See the expiry note in Forcing Outcomes
Cannot find simulated transactions	Looking at production reporting	Simulated transactions appear under the sandbox account in the Transaction Reporting section
Refund not possible on a simulated purchase	Refunds are not simulated	Test refunds against a live PSP connection. `[VERIFY]` what a refund call against a simulated purchase actually returns

Error response shape

Errors follow the standard shape:

{\n    \"message\": \"Brand not found\",\n    \"code\": \"transaction_error\"\n}\n

Getting help

If simulator behaviour does not match this documentation, report it rather than working around it. The simulator is only useful to the extent it is faithful, so a divergence is a documentation or product defect worth fixing. Raise it through your usual technical support channel. [TBD: confirm the support address and whether a response-time commitment is published.]

\n","_postman_id":"2bf40a0b-2c45-4438-b86f-df325bebd3e6"}],"id":"d06b79e3-fefe-42ef-8b6a-a1bb71a02d9d","description":"

The APM Simulator lets you run simulated alternative-payment-method PayIn transactions in sandbox. It exists because APMs previously could not be tested in sandbox at all: validating an APM integration meant pushing real, low-value transactions through a live PSP connection.

Simulated transactions use the same endpoint and the same /purchases contract as production. Your existing sandbox API key and Brand ID are the only switch. There is no separate base URL, no flag, no header, no magic amount, and nothing to request.

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

Property	Details
What it is	Simulated PayIn against the live `/purchases` contract, routed to a simulator instead of a PSP
Trigger	Sandbox API key + Brand ID. No other change to the request
Base URL	`https://api.paysecure.net/api/v1` (same as production)
Countries	🇮🇳 India, 🇨🇦 Canada, 🇧🇷 Brazil, 🇲🇽 Mexico, 🇪🇬 Egypt
Processing currencies	INR, CAD, BRL, MXN, EGP
PayIn	✅
PayOut	❌ Not simulated
Refunds	❌ Not simulated
Partial refunds	❌ Not simulated
Chargebacks / disputes	❌ Not simulated
Reversals	❌ Not simulated
Customer flow	Redirect to a hosted simulator cashier page with outcome buttons
Forceable outcomes	Success, Failure, Pending (Pending later becomes Expired)
Payment confirmation	Instant. Not configurable
Webhooks	✅ RSA signed as in production, reduced payload
Transaction limits	Standard sandbox limits apply. Nothing simulator-specific
Cost	None
Visible in Dashboard	✅ Transaction Reporting section

\n
The simulator proves that your integration handles every state correctly. It does not prove that a PSP has certified you, and it does not replace UAT against a live PSP connection. See Concepts for exactly what a simulated result does and does not establish.
\n

\n","_postman_id":"d06b79e3-fefe-42ef-8b6a-a1bb71a02d9d"}],"event":[{"listen":"prerequest","script":{"id":"e61e8a79-22d0-45e9-9dcf-fa0d3369dd83","type":"text/javascript","requests":{},"exec":[""]}},{"listen":"test","script":{"id":"841f81a2-2f7c-48a5-80e7-dd6a1e7c39c2","type":"text/javascript","requests":{},"exec":[""]}}],"variable":[{"key":"BaseURL","value":"https://api.paysecure.net/api/v1"},{"key":"AppBaseURL","value":""}]}