{"info":{"_postman_id":"5bc0355e-5313-422f-843a-a0687da7e05b","name":"Paysecure API Documentation - Whitelabel Merchant","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 by on email us 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":"50038237","collectionId":"5bc0355e-5313-422f-843a-a0687da7e05b","publishedId":"2sB3dHWYnT","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"publishDate":"2025-11-24T08:14:01.000Z"},"item":[{"name":"⚙️ Integration Steps","item":[],"id":"817ecfed-2641-43a5-bdea-007b024b076c","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 client support executive.

Start with sandbox mode (see top right-hand corner on your merchant portal to toggle between modes) and generate API Key, Brand ID and Public Key and also set up the callback URLs for subscribing to webhooks.

API Key - necessary to send transactions via API
\n
Brand ID - needed to send transaction. Use different brand IDs for different shops or brands.
\n
Public Key - needed to signature verification received in headers of the webhook
\n
Webhook - recommended to get notifications from our server to your server to inform you of transaction status changes and notifications about transactions. You can check all the details of how our webhooks work on the Webhooks page.
\n

2. Test the integration in Sandbox Mode

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

Testing Credentials (only on Sandbox mode)

You have the opportunity to test the APIs by performing test Purchases. To facilitate testing payments, you may utilize the following card details:

Visa (2D)

Card number: 4444 3333 2222 1111
\n
Name: any cardholder name
\n
Expiry Date: any expiry larger or equal to the current month/year
\n
CVC: 345
\n

Mastercard (3DS)

Card number: 5555 5555 5555 4444
\n
Name: any cardholder name
\n
Expiry Date: any expiry larger or equal to the current month/year
\n
CVC: 345
\n

for 3DS, OTP will be received on the email as provided in the purchases payloads.

Note: Currently, only card payment testing is supported in the sandbox environment. Testing Alternative Payment Methods (APMs) is not available in the sandbox at this time.

3. Create and test credentials on the Live Mode

After finishing your integration in sandbox mode, set up your production environment by truning off the sandbox mode from merchant dashboard and follwing 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 staerted with processing live traffic.

\n","_postman_id":"817ecfed-2641-43a5-bdea-007b024b076c"},{"name":"🔌 Webhooks","item":[{"name":"PayIn","item":[],"id":"35d57dae-885d-4155-8148-9b3a09f56c92","description":"

Overview

When a transaction status changes to a terminal state (e.g., paid, refunded, expired), our payment gateway sends a server-to-server POST callback to the merchant's configured Webhook URL.

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

Webhook Events for Payins

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

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

Webhook Payload Specification

Fields Description

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

\n","_postman_id":"35d57dae-885d-4155-8148-9b3a09f56c92"},{"name":"Payout","item":[],"id":"c2a8928c-d0c9-4a9b-952d-e842f17abac0","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<strong class=&#x27;preserveHtml&#x27; class=&#x27;preserveHtml&#x27; class=&#x27;preserveHtml&#x27; class=&#x27;preserveHtml&#x27; class=&#x27;preserveHtml&#x27; class=&#x27;preserveHtml&#x27; >\n</b>\n\n

2. Signing Algorithm

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

✅ How to Verify the Signature

Rebuild the Message

From the webhook JSON body, extract:

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

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

2. Verification Steps

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

public static boolean verifySignature(String message, String signatureBase64, PublicKey publicKey) throws Exception {\n    Signature signature = Signature.getInstance(\"SHA256withRSA\");\n    signature.initVerify(publicKey);\n    signature.update(message.getBytes());\n    byte[] signatureBytes = Base64.getDecoder().decode(signatureBase64);\n    return signature.verify(signatureBytes);\n}\n\n

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

\n","_postman_id":"c2a8928c-d0c9-4a9b-952d-e842f17abac0"}],"id":"3b3af6de-6658-41be-9b1f-75c7ba431b49","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. Alternatevely 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 if 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":"3b3af6de-6658-41be-9b1f-75c7ba431b49"},{"name":"🖥️ Status Code","item":[{"name":"Transaction Status and Their Meaning","item":[],"id":"f1afc75c-9ba4-4f05-9b30-e8df29a0df12","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

","auth":{"type":"noauth","isInherited":false},"event":[{"listen":"prerequest","script":{"id":"c18652d6-0b63-4997-ac16-ed0655c4d1ce","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"67fa5379-1145-4c79-b212-a91a973540d8","type":"text/javascript","exec":[""]}}],"_postman_id":"f1afc75c-9ba4-4f05-9b30-e8df29a0df12"}],"id":"6dfea973-035d-4fa6-8da1-e6197caf2a27","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":{"id":"c18652d6-0b63-4997-ac16-ed0655c4d1ce","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"67fa5379-1145-4c79-b212-a91a973540d8","type":"text/javascript","exec":[""]}}],"_postman_id":"6dfea973-035d-4fa6-8da1-e6197caf2a27"},{"name":"Payment Methods","item":[{"name":"💰 APMs (Alternative Payment Methods)","item":[{"name":"🇨🇦 Interac e-Transfer","item":[{"name":"Concepts","item":[],"id":"adfc1dbb-7525-4581-875a-40c566338d54","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":"adfc1dbb-7525-4581-875a-40c566338d54"},{"name":"PayIn API","item":[{"name":"Purchases","id":"e45ca8ad-5cdc-4303-8734-3361de947e2b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer Token"}],"body":{"mode":"raw","raw":"{\r\n \"client\": {\r\n \"email\": \"seo2009@test.com\",\r\n \"street_address\": \"10 New Burlington Street Apt. 214\",\r\n \"city\": \"London\",\r\n \"full_name\": \"Test test\",\r\n \"zip_code\": \"W1S 3BE\",\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\": \"f6aff7d7-bb40-4857-bc84-9b4c8310b043\",\r\n \"success_redirect\": \"https://your.redirect.url/getResponse.jsp?success=true\",\r\n \"pending_redirect\": \"https://your.redirect.url/getResponse.jsp?success=pending\",\r\n \"failure_redirect\": \"https://your.redirect.url/getResponse.jsp?success=false\",\r\n \"success_callback\": \"https://your.success.callback.url\",\r\n \"failure_callback\": \"https://your.success.failure.url\"\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

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

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.

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":"943e717b-26c7-4fec-bd8d-d18649d597fb","name":"Purchase- success","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer Token"}],"body":{"mode":"raw","raw":"{\r\n \"client\": {\r\n \"email\": \"seo2009@test.com\",\r\n \"street_address\": \"10 New Burlington Street Apt. 214\",\r\n \"city\": \"London\",\r\n \"full_name\": \"Test test\",\r\n \"zip_code\": \"W1S 3BE\",\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\": \"f6aff7d7-bb40-4857-bc84-9b4c8310b043\",\r\n \"success_redirect\": \"https://your.redirect.url/getResponse.jsp?success=true\",\r\n \"pending_redirect\": \"https://your.redirect.url/getResponse.jsp?success=pending\",\r\n \"failure_redirect\": \"https://your.redirect.url/getResponse.jsp?success=false\",\r\n \"success_callback\": \"https://your.success.callback.url\",\r\n \"failure_callback\": \"https://your.success.failure.url\"\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\":\"ashishm.21190@gmail.com\",\"phone\":\"+447755564318\",\"full_name\":\"Test test\",\"date_of_birth\":\"1970-07-10\",\"street_address\":\"10 New Burlington Street Apt. 214\",\"country\":\"CA\",\"city\":\"London\",\"zip_code\":\"W1S 3BE\",\"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\":\"arunsinghal\",\"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\":\"103.59.75.41, 162.158.88.44, 130.176.93.146\",\"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\":\"30f7ce6e-3b7e-46a2-9b50-484fc55be689\",\"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\":\"transfer@ieft.ca\",\"secretQA\":\"66a8c78af1fc2f768304bce4\",\"secretAnswer\":\"ps8766a8af\"},\"paidOn\":0,\"receivedAmt\":0.0,\"refund_availability\":\"NONE\",\"refundable_amount\":0.0,\"success_redirect\":\"https://your.redirect.url/getResponse.jsp?success=true\",\"failure_redirect\":\"https://your.redirect.url/getResponse.jsp?success=false\",\"cancel_redirect\":\"\",\"success_callback\":\"https://your.success.callback.url\",\"failure_callback\":\"https://your.success.failure.url\",\"platform\":\"API\",\"created_from_ip\":\"103.59.75.41, 162.158.88.44, 130.176.93.146\",\"checkout_url\":\"https://api.choicepay.ca/payments/67efd0ff97be603f97a3a697/\",\"payoutProcess\":false}"}],"_postman_id":"e45ca8ad-5cdc-4303-8734-3361de947e2b"},{"name":"Get Status","id":"29baf744-b4c2-418c-a9d4-170bf32f69a1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer Token","type":"text"}],"url":"https://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":"d85d2c54-d1e9-4269-b0e7-732c0cccc822","name":"Purchases-success","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer Token"}],"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\": \"ashishm.21190@gmail.com\",\n \"phone\": \"+14377717874\",\n \"full_name\": \"Test test\",\n \"date_of_birth\": \"1970-07-10\",\n \"street_address\": \"10 New Burlington Street Apt. 214\",\n \"country\": \"CA\",\n \"city\": \"London\",\n \"zip_code\": \"W1S 3BE\",\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\": \"arunsinghal\",\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\": \"103.59.75.42, 172.71.186.102, 130.176.183.14\",\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\": \"30f7ce6e-3b7e-46a2-9b50-484fc55be689\",\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\": \"deposit@ieft.ca\",\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.redirect.url/getResponse.jsp?success=true\",\n \"failure_redirect\": \"https://your.redirect.url/getResponse.jsp?success=false\",\n \"cancel_redirect\": \"\",\n \"success_callback\": \"https://webhook.site/83df9776-3590-4e25-9222-870e931ac868\",\n \"failure_callback\": \"https://webhook.site/83df9776-3590-4e25-9222-870e931ac868\",\n \"platform\": \"API\",\n \"created_from_ip\": \"103.59.75.42, 172.71.186.102, 130.176.183.14\",\n \"checkout_url\": \"https://api.choicepay.ca/payments/6790e75fa46a5a5bb0b00e55/\",\n \"payoutProcess\": false\n}"},{"id":"744fb728-ab23-4bd9-ac18-afa8436257de","name":"Purchases Error","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer Token","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":"29baf744-b4c2-418c-a9d4-170bf32f69a1"}],"id":"85609870-fee5-4c82-8474-592bcd7b1b4c","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\": \"deposit@ieft.ca\",\n        \"secretQA\": \"6789df35bbefe612e3cb4641\",\n        \"secretAnswer\": \"PS7466835\"\n   }\n\n

\n","_postman_id":"85609870-fee5-4c82-8474-592bcd7b1b4c"},{"name":"PayOut API","item":[{"name":"Create PayOut","id":"35dc0a28-0cd4-412e-a416-cbe7a7c0078a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer Token"}],"body":{"mode":"raw","raw":"{\r\n \"client\": {\r\n \"email\": \"ashishm.21190@gmail.com\",\r\n \"country\" : \"CA\",\r\n \"phone\" : \"+14377717874\",\r\n \"full_name\": \"Test Person-uk\"\r\n \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://success.com\",\r\n \"failure_callback\": \"https://failure.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-ETRANSFER
Currency	CAD
Amount	Payout Amount
Purpose	Transfer Reversed

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://success.com\",

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

\n","urlObject":{"path":["getpayout","{payoutId}",""],"host":["https://api.paysecure.net/api/v1"],"query":[],"variable":[]}},"response":[{"id":"0c5effe8-506c-41a7-a073-dc2a4ced9ab9","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\": \"ashishm.21190@gmail.com\",\n \"phone\": \"+14377717874\",\n \"full_name\": \"Ashish Mistry\",\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\": \"arunsinghal\",\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\": \"ashishm.21190@gmail.com\",\n \"secretQA\": \"q66276336575481202\",\n \"secretAnswer\": \"a66276336575481202\"\n },\n \"success_callback\": \"https://webhook.site/d7660184-d724-480c-bad0-cf0480f5518e\",\n \"failure_callback\": \"https://webhook.site/d7660184-d724-480c-bad0-cf0480f5518e\"\n}"},{"id":"4e79ace1-40df-4e5d-a6c4-84dbf1b5d12e","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":"7a012c24-02df-40d4-a769-631db72ffc38"}],"id":"bb6c68f1-425e-48b8-a022-e76cf7e13206","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":"bb6c68f1-425e-48b8-a022-e76cf7e13206"},{"name":"Get Balance API","item":[{"name":"Checking Balance","id":"7947a19d-46b9-408b-9abb-5d126517c486","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"Bearer Token","type":"text"}],"body":{"mode":"raw","raw":"{ \r\n \"paymentMethod\" : \"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

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":"69f06125-fb83-4c90-939c-91cd8dde8086","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":"c61ec6d0-8321-48e4-9df4-5c9515f4057d","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":"7947a19d-46b9-408b-9abb-5d126517c486"}],"id":"bc435b03-d04c-4483-9649-df9a4a83ba70","_postman_id":"bc435b03-d04c-4483-9649-df9a4a83ba70","description":""}],"id":"5c81dd80-f93b-4933-b356-419a3dc86557","_postman_id":"5c81dd80-f93b-4933-b356-419a3dc86557","description":""},{"name":"🇨🇦 Interac Express","item":[{"name":"Concepts","item":[],"id":"5f56e3b9-1909-4636-b5e4-00e4789a5eaf","description":"

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":"5f56e3b9-1909-4636-b5e4-00e4789a5eaf"},{"name":"Payin API","item":[{"name":"Purchases","id":"bc634370-fd90-4f60-84b5-fc081c1dacf5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer Token"}],"body":{"mode":"raw","raw":"{\r\n \"client\": {\r\n \"email\": \"seo2009@test.com\",\r\n \"street_address\": \"10 New Burlington Street Apt. 214\",\r\n \"city\": \"London\",\r\n \"full_name\": \"Test Customer\",\r\n \"zip_code\": \"W1S 3BE\",\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\": \"f6aff7d7-bb40-4857-bc84-9b4c8310b043\",\r\n \"success_redirect\": \"https://your.redirect.url/getResponse.jsp?success=true\",\r\n \"pending_redirect\": \"https://tyour.redirect.url/getResponse.jsp?success=pending\",\r\n \"failure_redirect\": \"https://your.redirect.url/getResponse.jsp?success=false\",\r\n \"success_callback\": \"https://your.success.callback.url\",\r\n \"failure_callback\": \"https://your.success.failure.url\"\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":"cb4e1a33-95e3-4271-bbe9-255abfe39a9a","name":"Purchase- success","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer Token"}],"body":{"mode":"raw","raw":"{\r\n \"client\": {\r\n \"email\": \"seo2009@test.com\",\r\n \"street_address\": \"10 New Burlington Street Apt. 214\",\r\n \"city\": \"London\",\r\n \"full_name\": \"Test test\",\r\n \"zip_code\": \"W1S 3BE\",\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\": \"f6aff7d7-bb40-4857-bc84-9b4c8310b043\",\r\n \"success_redirect\": \"https://your.redirect.url/getResponse.jsp?success=true\",\r\n \"pending_redirect\": \"https://your.redirect.url/getResponse.jsp?success=pending\",\r\n \"failure_redirect\": \"https://your.redirect.url/getResponse.jsp?success=false\",\r\n \"success_callback\": \"https://your.success.callback.url\",\r\n \"failure_callback\": \"https://your.success.failure.url\"\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\": \"seo2009@test.com\",\n \"phone\": \"+447755564318\",\n \"full_name\": \"Test test\",\n \"date_of_birth\": \"1970-07-10\",\n \"street_address\": \"10 New Burlington Street Apt. 214\",\n \"country\": \"CA\",\n \"city\": \"London\",\n \"zip_code\": \"W1S 3BE\",\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\": \"arunsinghal\",\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\": \"103.59.75.176, 104.23.216.90, 18.68.12.74\",\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\": \"30f7ce6e-3b7e-46a2-9b50-484fc55be689\",\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\": \"fund@ieft.ca\",\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\": \"103.59.75.176, 104.23.216.90, 18.68.12.74\",\n \"checkout_url\": \"https://api.choicepay.ca/payments/6890aba7faa4173bbbbb76c6/\",\n \"payoutProcess\": false\n}"}],"_postman_id":"bc634370-fd90-4f60-84b5-fc081c1dacf5"}],"id":"a1b76271-45d4-4e9a-88bf-99bf3187c349","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":"a1b76271-45d4-4e9a-88bf-99bf3187c349"},{"name":"Payout API","item":[{"name":"Create Payout","id":"6a4c46f8-42b0-4cee-bc95-bf7c120a851e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer Token"}],"body":{"mode":"raw","raw":"{\r\n \"client\": {\r\n \"email\": \"ashishm.21190@gmail.com\",\r\n \"country\" : \"CA\",\r\n \"phone\" : \"+14377717874\",\r\n \"full_name\": \"Test Person-uk\"\r\n \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://success.com\",\r\n \"failure_callback\": \"https://failure.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

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":"9d79299c-2708-4e0a-8c6c-9e8495146414"}],"id":"3888c25d-efd4-42d9-972e-88e1dae19338","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":"3888c25d-efd4-42d9-972e-88e1dae19338"},{"name":"🇧🇷 PIX","item":[{"name":"Concepts","item":[],"id":"eae25d0c-ed91-41f2-8843-c13407e6d3ef","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

\n","_postman_id":"eae25d0c-ed91-41f2-8843-c13407e6d3ef"},{"name":"PayIn API","item":[{"name":"Purchases","id":"376fce32-c531-457b-804c-f40606a7cd5b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer Token"}],"body":{"mode":"raw","raw":"{\r\n \"client\": {\r\n \"email\": \"test@gmail.com\",\r\n \"full_name\": \"test test\",\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\": \"90ed108b-6753-465d-8a21-e2cc604ff814 \",\r\n \"success_redirect\": \"https://test.com/getResponse.jsp?success=true\",\r\n \"pending_redirect\": \"https://test.com/getResponse.jsp?success=pending\",\r\n \"failure_redirect\": \"https://test.com/getResponse.jsp?success=false\",\r\n \"success_callback\": \"https://test1.com\",\r\n \"failure_callback\": \"https://test2.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

Parameter	Notes
client.full_name
client.email
client.tax_number	CPF (Brazilian tax identification number of customer), must contain 11 digits
paymentMethod	PIX
purchase.products.name
purchase.currency	ISO 4217 code for currency you want to send the transaction in. This should be 'BRL' for PIX
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

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.

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.

","urlObject":{"path":["purchases",""],"host":["https://api.paysecure.net/api/v1"],"query":[],"variable":[]}},"response":[{"id":"6a257103-966c-458d-8181-1d81fa14881e","name":"Purchase- success","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer Token","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"client\": {\r\n \"email\": \"test@gmail.com\",\r\n \"full_name\": \"test test\",\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\": \"90ed108b-6753-465d-8a21-e2cc604ff814 \",\r\n \"success_redirect\": \"https://test.com/getResponse.jsp?success=true\",\r\n \"pending_redirect\": \"https://test.com/getResponse.jsp?success=pending\",\r\n \"failure_redirect\": \"https://test.com/getResponse.jsp?success=false\",\r\n \"success_callback\": \"https://test1.com\",\r\n \"failure_callback\": \"https://test2.com\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.paysecure.net/api/v1/purchases"},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\r\n \"purchaseId\": \"65f9368cb905381ba207b3c4\",\r\n \"client\": {\r\n \"email\": \"test@gmail.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 \"pix_payload\": {\r\n \"payload\": \"00020101021226800014br.gov.bcb.pix2558pix.asaas.com/qr/cobv/e3eb36eb-7e9b-404d-9bd3-b486a42da3445204000053039865802BR5925A55 CONSULTORIA EM CREDIT6009Sao Paulo61080455202062070503***630451CA\",\r\n \"qr_code\": \"iVBORw0KGgoAAAANSUhEUgAAAZ8AAAGfCAIAAAAPgEjDAAAP4UlEQVR42u3bUY7cSA4EUN … ..\",\r\n \"expiration_date\": \"2025-03-27 23:59:59\"\r\n },\r\n \"is_test\": false,\r\n \"brand_id\": \"90ed108b-6753-465d-8a21-e2cc604ff814\",\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://test.com/getResponse.jsp?success=true\",\r\n \"pending_redirect\": \"https://test.com/getResponse.jsp?success=pending\",\r\n \"failure_redirect\": \"https://test.com/getResponse.jsp?success=false\",\r\n \"cancel_redirect\": \"\",\r\n \"success_callback\": \"https://test1.com\",\r\n \"failure_callback\": \"https://test2.com\",\r\n \"platform\": \"API\",\r\n \"created_from_ip\": \"223.182.100.34\",\r\n \"checkout_url\": \"https://api.paysecure.net/payments/65f9368cb905381ba207b3c4/\"\r\n}\r\n"},{"id":"c5b0b4b9-53fa-4743-9c13-45bd90d0a814","name":"Purchase-error","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer Token","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"client\": {\r\n \"email\": \"test@gmail.com\",\r\n \"street_address\": \"10 New Burlington Street Apt. 214\",\r\n \"city\": \"London\",\r\n \"full_name\": \"Test test\",\r\n \"zip_code\": \"W1S 3BE\",\r\n \"country\": \"GB\",\r\n \"date_of_birth\": \"1970-07-10\",\r\n \"stateCode\": \"QLD\",\r\n \"phone\": \"+447755564318\"\r\n },\r\n \"purchase\": {\r\n \"currency\": \"USD\",\r\n \"products\": [\r\n {\r\n \"name\": \"test \",\r\n \"price\": 10\r\n }\r\n ]\r\n },\r\n \"paymentMethod\": \"BANKTRANSFER\",\r\n \"brand_id\": \"{{SriTrustScoreTestBrandID}}\",\r\n \"success_redirect\": \"https://test.com/getResponse.jsp?success=true\",\r\n \"pending_redirect\": \"https://test.com/getResponse.jsp?success=pending\",\r\n \"failure_redirect\": \"https://test.com/getResponse.jsp?success=false\",\r\n \"success_callback\": \"https://test1.com\",\r\n \"failure_callback\": \"https://test2.com\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.paysecure.net/api/v1/purchases"},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":null}],"_postman_id":"376fce32-c531-457b-804c-f40606a7cd5b"},{"name":"Purchases","id":"f4ff3096-4e08-45df-a423-71f4bec15fdb","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer Token","type":"text"}],"url":"https://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":"93ac84af-46ef-4611-9fc6-99529c4b2e9f","name":"Purchases-success","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer Token","type":"text"}],"url":"https://api.paysecure.net/api/v1/purchases/{purchaseId}/"},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\r\n \"purchaseId\": \"65f9368cb905381ba207b3c4\",\r\n \"client\": {\r\n \"email\": \"test@gmail.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\": \"90ed108b-6753-465d-8a21-e2cc604ff814\",\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://test.com/getResponse.jsp?success=true\",\r\n \"pending_redirect\": \"https://test.com/getResponse.jsp?success=pending\",\r\n \"failure_redirect\": \"https://test.com/getResponse.jsp?success=false\",\r\n \"cancel_redirect\": \"\",\r\n \"success_callback\": \"https://test1.com\",\r\n \"failure_callback\": \"https://test2.com\",\r\n \"platform\": \"API\",\r\n \"created_from_ip\": \"223.182.100.34\",\r\n \"checkout_url\": \"https://api.paysecure.net/payments/65f9368cb905381ba207b3c4/\"\r\n}\r\n"},{"id":"2303436f-4a3c-41dc-aa4b-688d323dcd7e","name":"Purchases-failure","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer Token","type":"text"}],"url":"https://api.paysecure.net/api/v1/purchases/{purchaseId}/"},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\r\n \"message\": \"Error Message\",\r\n \"code\": \"error_code\"\r\n}\r\n"}],"_postman_id":"f4ff3096-4e08-45df-a423-71f4bec15fdb"}],"id":"8c6160a0-b4ee-4363-ac80-3e44aa4a588d","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

\n","_postman_id":"8c6160a0-b4ee-4363-ac80-3e44aa4a588d"},{"name":"PayOut API","item":[{"name":"Create PayOut","id":"b81145a6-d582-4ae4-b3b6-8ac82c26dc79","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer Token"}],"body":{"mode":"raw","raw":"{\r\n \"client\": {\r\n \"email\": \"test@gmail.com\",\r\n \"full_name\": \"Test test\",\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 \"amount\": 10,\r\n \"currency\": \"BRL\",\r\n \"success_callback\": \"https://success.com\",\r\n \"failure_callback\": \"https://failure.com\"\r\n}\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/

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
client.documentId	Document Type Supported
cpf='tax_id Brazil',
cnpj='tax_id Brazil company',
evp='random key generated by the bank',
email='email as key to receive pix',
phone='phone as key to receive pix' )
client.documentType
payoutMethod
Amount
Currency	Note this is currency account for which you have balance
success_redirect	URL to send the user if the transactions is successful
failure_redirect	URL to send the user if the transactions is UNSUCCESSFUL
Purpose

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://success.com\",

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

\n","urlObject":{"path":["getpayout","{payoutId}",""],"host":["https://api.paysecure.net/api/v1"],"query":[],"variable":[]}},"response":[{"id":"e7fc47a3-c9e2-4a88-91db-bbe08f2ff81d","name":"Get Status","originalRequest":{"method":"GET","header":[],"url":"https://api.paysecure.net/api/v1/getpayout/{payoutId}/"},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\r\n \"payoutId\": \"65f93895c96bae142f7b1765\",\r\n \"client\": {\r\n \"email\": \"customer141@email.uk\",\r\n \"full_name\": \"Test Person-uk\",\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\": \"EUR\",\r\n \"success_callback\": https: //Success.com\r\n \"failure_callback\": \"https://failure.com\"\r\n}\r\n"},{"id":"e7a24ca2-d30f-4dc8-882c-6b03b3befef1","name":"Get Status-error","originalRequest":{"method":"GET","header":[],"url":"https://api.paysecure.net/api/v1/getpayout/{payoutId}/"},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":null}],"_postman_id":"38ac9e25-85e2-4d3d-934b-fb89a0c3f103"}],"id":"909a0b46-2cce-426e-9baa-a35168c41973","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

\n","_postman_id":"909a0b46-2cce-426e-9baa-a35168c41973"},{"name":"Get Balance API","item":[{"name":"Checking Balance","id":"e9bd6586-5bfa-463a-9b48-8a27b43ecdcd","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"Bearer Token","type":"text"}],"body":{"mode":"raw","raw":"{ \r\n \"paymentMethod\" : \"\"\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":"4dafb601-e4cf-4e47-b97b-302e28e75f8e","name":"Checking Balance payout-success","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{ \r\n \"paymentMethod\" : \"PIX\"\r\n\r\n}\r\n","options":{"raw":{"language":"json"}}},"url":"https://api.paysecure.net/api/v1/getBalance"},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\r\n \"paymentMethod\": \"PIX\",\r\n \"status\": \"success\",\r\n \"data\": [\r\n {\r\n \"currency\": \"BRL\",\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\": \"JPY\",\r\n \"balance\": \"0.00\"\r\n }\r\n ]\r\n}\r\n"},{"id":"71885d48-81c9-4d1e-91c4-4f40616a515a","name":"Checking Balance payout-error","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{ \r\n \"paymentMethod\" : \"PIX\"\r\n\r\n}\r\n","options":{"raw":{"language":"json"}}},"url":"https://api.paysecure.net/api/v1/getBalance"},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\r\n \"message\": \"Error Message\",\r\n \"code\": \"No currency account found\"\r\n}\r\n"}],"_postman_id":"e9bd6586-5bfa-463a-9b48-8a27b43ecdcd"}],"id":"e85660b5-0b46-4d89-87df-24b4abaa57ff","_postman_id":"e85660b5-0b46-4d89-87df-24b4abaa57ff","description":""}],"id":"17f71af3-a2c1-45c8-8f08-9afbb66acfea","_postman_id":"17f71af3-a2c1-45c8-8f08-9afbb66acfea","description":""},{"name":"🇪🇬 FawryPay","item":[{"name":"Concepts","item":[],"id":"4fde9306-7354-4a0d-b632-9085750aa3fc","description":"

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":"4fde9306-7354-4a0d-b632-9085750aa3fc"},{"name":"PayIn API","item":[{"name":"Purchases","id":"fde59306-2f88-44ac-8c67-72458ddb53e9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer Token"}],"body":{"mode":"raw","raw":"{\r\n \"client\": {\r\n \"email\": \"DEEPAKDEEPAKSINGHAL@gmail.com\",\r\n \"street_address\": \"10 New Burlington Street Apt. 214\",\r\n \"city\": \"London\",\r\n \"full_name\": \"Test test\",\r\n \"zip_code\": \"W1S 3BE\",\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\": \"{{brand_id}}\",\r\n \"success_redirect\": \"https://your.success.redirect.com/getResponse.jsp?success=true\",\r\n \"pending_redirect\": \"https://staging.paysecure.net/getResponse.jsp?success=true\",\r\n \"failure_redirect\": \"https://your.failure.redirect.com/getResponse.jsp?success=false\",\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":"42262395-ca92-4bee-9f67-8a310cf8ded1","name":"Purchase- success","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer Token"}],"body":{"mode":"raw","raw":"{\r\n \"client\": {\r\n \"email\": \"DEEPAKDEEPAKSINGHAL@gmail.com\",\r\n \"street_address\": \"10 New Burlington Street Apt. 214\",\r\n \"city\": \"London\",\r\n \"full_name\": \"Test test\",\r\n \"zip_code\": \"W1S 3BE\",\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\": \"{{brand_id}}\",\r\n \"success_redirect\": \"https://your.success.redirect.com/getResponse.jsp?success=true\",\r\n \"pending_redirect\": \"https://staging.paysecure.net/getResponse.jsp?success=true\",\r\n \"failure_redirect\": \"https://your.failure.redirect.com/getResponse.jsp?success=false\",\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\": \"deepakdeepaksinghal@gmail.com\",\r\n \"phone\": \"+447755564318\",\r\n \"full_name\": \"Test test\",\r\n \"date_of_birth\": \"1970-07-10\",\r\n \"street_address\": \"10 New Burlington Street Apt. 214\",\r\n \"country\": \"EG\",\r\n \"city\": \"London\",\r\n \"zip_code\": \"W1S 3BE\",\r\n \"cc\": [],\r\n \"bcc\": [],\r\n \"stateCode\": \"QLD\"\r\n },\r\n \"updated_on\": 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\": \"110.235.229.106\",\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\": \"c4003b2c-22d4-4dc1-ad0c-c6b54f8c9636\",\r\n \"send_receipt\": false,\r\n \"is_recurring_token\": false,\r\n \"skip_capture\": false,\r\n \"reference_generated\": \"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/getResponse.jsp?success=true\",\r\n \"failure_redirect\": \"https://your.failure.redirect.com/getResponse.jsp?success=false\",\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\": \"110.235.229.106\",\r\n \"checkout_url\": \"https://api.paysecure.net/payments/667cfb2cf0bd8d672c8fc562/\"\r\n}"},{"id":"9463508c-20a8-4915-b686-278efaf5f01d","name":"Create Purchase","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer Token"}],"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":"fde59306-2f88-44ac-8c67-72458ddb53e9"},{"name":"Get Status","id":"7813f67c-c8f7-4c61-9365-deb7d38b85de","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer Token","type":"text"}],"url":"https://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":"9ccc01cc-3769-493a-88f0-950da0dd3136","name":"Purchases-success","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer Token"}],"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\": \"deepakdeepaksinghal@gmail.com\",\r\n \"phone\": \"+447755564318\",\r\n \"full_name\": \"Test test\",\r\n \"date_of_birth\": \"1970-07-10\",\r\n \"street_address\": \"10 New Burlington Street Apt. 214\",\r\n \"country\": \"EG\",\r\n \"city\": \"London\",\r\n \"zip_code\": \"W1S 3BE\",\r\n \"cc\": [],\r\n \"bcc\": [],\r\n \"stateCode\": \"QLD\"\r\n },\r\n \"updated_on\": 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\": \"110.235.229.106\",\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\": \"c4003b2c-22d4-4dc1-ad0c-c6b54f8c9636\",\r\n \"send_receipt\": false,\r\n \"is_recurring_token\": false,\r\n \"skip_capture\": false,\r\n \"reference_generated\": \"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/getResponse.jsp?success=true\",\r\n \"failure_redirect\": \"https://your.failure.redirect.com/getResponse.jsp?success=false\",\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\": \"110.235.229.106\",\r\n \"checkout_url\": \"https://api.paysecure.net/payments/667cfb2cf0bd8d672c8fc562/\"\r\n}"},{"id":"b88ae92e-153b-4a8f-8543-5257331520bd","name":"Purchases","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer Token","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":"7813f67c-c8f7-4c61-9365-deb7d38b85de"}],"id":"398dfd40-dc31-4698-b387-805aa36a5052","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":"398dfd40-dc31-4698-b387-805aa36a5052"},{"name":"PayOut API","item":[{"name":"Create PayOut","id":"24b541fa-e414-4c11-aaf2-6740da869328","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer Token"}],"body":{"mode":"raw","raw":"{\r\n \"client\": {\r\n \"email\": \"test@gmail.com\",\r\n \"country\" : \"EG\",\r\n \"phone\" : \"9586445444\",\r\n\"full_name\": \"Test Person-uk\",\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://success.com\",\r\n \"failure_callback\": \"https://failure.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

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://success.com\",

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

\n","urlObject":{"path":["getpayout","{payoutId}",""],"host":["https://api.paysecure.net/api/v1"],"query":[],"variable":[]}},"response":[{"id":"64ab6f5d-81c7-489a-8844-00b4a6f270bb","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\": \"test@gmail.com\",\r\n \"phone\": \"9586445444\",\r\n \"full_name\": \"Test Person-uk\",\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\": \"deepak singhal\"\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://success.com\",\r\n \"failure_callback\": \"https://failure.com\"\r\n}"},{"id":"67516ea4-fb21-44df-8e7a-717cfb312e88","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":"eb554a81-9f88-4a58-ae47-1e3805f9245a"}],"id":"3ee1c39e-4622-4ecb-a673-2926048185d2","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":"3ee1c39e-4622-4ecb-a673-2926048185d2"},{"name":"Get Balance API","item":[{"name":"Checking Balance","id":"3682a7b1-7fa1-49db-b402-c81f989e601d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"Bearer Token","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":"d0bed0a9-82c3-487a-bebf-83be5ca7b3a7","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":"b6291b20-1f2a-466f-80f3-2306a7e79185","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":"3682a7b1-7fa1-49db-b402-c81f989e601d"}],"id":"6a6ee910-1233-453d-abde-b9411e106e62","_postman_id":"6a6ee910-1233-453d-abde-b9411e106e62","description":""}],"id":"ca9be25a-a710-41d7-97e6-f0b2dce9ff63","_postman_id":"ca9be25a-a710-41d7-97e6-f0b2dce9ff63","description":""},{"name":"🇮🇳 UPI","item":[{"name":"Concepts","item":[],"id":"a93e2de9-8466-43c4-af4b-bca1ec234622","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 UPI payouts through various channels, including IMPS, UPI, RTGS, and NEFT, to both bank accounts and UPI IDs (VPAs).

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 accoiunt before doing payouts.
\n
Ensure that enough balance is there in your merchant account do the payout. This can be ascertained by calling the \"GetBalance\" API.
\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 transferType (IMPS, RTGS, NEFT, UPI)
  \n
- Beneficiary's ifscCode (if transferType is either of IMPS, RTGS, or NEFT)
  \n
- Beneficiary's payeeName (if transferType is either of IMPS, RTGS, or NEFT)
  \n
- Beneficiary's bankAccountNumber (if transferType is either of IMPS, RTGS, or NEFT)
  \n
- Beneficiary's UPIId (if transferType is UPI)
  \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

Transaction Limits:

Pay Ins:

\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 INR	100,000 INR Note: 1. this is dependent on respective bank's limit. Diffferent banks will have different limits 2. If the user saves the QR code image and scans the code using the camera then the limit would be INR 2,000
Per Day	100 INR	100,000 INR Note: 1. this is dependent on respective bank's limit. Diffferent banks will have different limits 2. If the user saves the QR code image and scans the code using the camera then the limit would be INR 2,000

Pay Outs:

\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	1000 INR	100,000 INR
Per Day	3000 INR	100,000 INR

","_postman_id":"a93e2de9-8466-43c4-af4b-bca1ec234622"},{"name":"PayIn API","item":[{"name":"Purchases","id":"423cae13-9678-44b7-a076-f5d3e0597e80","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer Token"}],"body":{"mode":"raw","raw":"{\r\n \"client\": {\r\n \"email\": \"yogesh@gmail.com\",\r\n \"street_address\": \"10 New Burlington Street Apt. 214\",\r\n \"city\": \"London\",\r\n \"zip_code\": \"W1S 3BE\",\r\n \"country\": \"EG\",\r\n \"stateCode\": \"QLD\"\r\n },\r\n \"purchase\": {\r\n \"currency\": \"INR\",\r\n \"products\": [\r\n {\r\n \"name\": \"test \",\r\n \"price\": 10\r\n }\r\n ]\r\n },\r\n \"paymentMethod\": \"\",\r\n \"brand_id\": \"{{merchant_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://api.paysecure.net\",\r\n \"failure_callback\": \"https://api.paysecure.net\"\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.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
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

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":"323aa155-be0d-4996-98d8-a305e2c02f63","name":"Purchase- success","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer Token"}],"body":{"mode":"raw","raw":"{\r\n \"client\": {\r\n \"email\": \"DEEPAKDEEPAKSINGHAL@gmail.com\",\r\n \"street_address\": \"10 New Burlington Street Apt. 214\",\r\n \"city\": \"London\",\r\n \"zip_code\": \"W1S 3BE\",\r\n \"country\": \"IN\",\r\n \"stateCode\": \"QLD\"\r\n },\r\n \"purchase\": {\r\n \"currency\": \"INR\",\r\n \"products\": [\r\n {\r\n \"name\": \"test \",\r\n \"price\": 10\r\n }\r\n ]\r\n },\r\n \"paymentMethod\": \"UPI\",\r\n \"brand_id\": \"c4003b2c-22d4-4dc1-ad0c-c6b54f8c9636\",\r\n \"success_redirect\": \"https://staging.paysecure.net/getResponse.jsp?success=true\",\r\n \"pending_redirect\": \"https://staging.paysecure.net/getResponse.jsp?success=pending\",\r\n \"failure_redirect\": \"https://staging.paysecure.net/getResponse.jsp?success=false\",\r\n \"success_callback\": \"https://staging.paysecure.net\",\r\n \"failure_callback\": \"https://staging.paysecure.net\"\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\": \"deepakdeepaksinghal@gmail.com\",\r\n \"date_of_birth\": \"1970-07-10\",\r\n \"street_address\": \"10 New Burlington Street Apt. 214\",\r\n \"country\": \"EG\",\r\n \"city\": \"London\",\r\n \"zip_code\": \"W1S 3BE\",\r\n \"cc\": [],\r\n \"bcc\": [],\r\n \"stateCode\": \"QLD\"\r\n },\r\n \"updated_on\": 1719833645,\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\": 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\": \"110.235.229.42\",\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\": 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\": \"c4003b2c-22d4-4dc1-ad0c-c6b54f8c9636\",\r\n \"send_receipt\": false,\r\n \"is_recurring_token\": false,\r\n \"skip_capture\": false,\r\n \"reference_generated\": \"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 \"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 \"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\",\r\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\",\r\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\",\r\n \"generatedLink\": \"https://api.decf.in/pay/ndaszpvy7j\"\r\n },\r\n \"refund_availability\": \"NONE\",\r\n \"refundable_amount\": 0.0,\r\n \"success_redirect\": \"https://api.paysecure.net/getResponse.jsp?success=true\",\r\n \"failure_redirect\": \"https://api.paysecure.net/getResponse.jsp?success=false\",\r\n \"cancel_redirect\": \"\",\r\n \"success_callback\": \"https://api.paysecure.net\",\r\n \"failure_callback\": \"https://api.paysecure.net\",\r\n \"platform\": \"API\",\r\n \"created_from_ip\": \"110.235.229.42\",\r\n \"checkout_url\": \"https://api.paysecure.net/payments/6682942d5273633e7b8d30c8/\"\r\n}\r\n"},{"id":"a47dd9d8-ebcb-436e-919d-a076e1d77c78","name":"Create Purchase","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer Token"}],"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":"423cae13-9678-44b7-a076-f5d3e0597e80"},{"name":"Get Status","id":"4689f84d-5102-4efc-a428-60d15713576c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer Token","type":"text"}],"url":"https://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":"628b2925-6c65-4735-b6b8-3f784078b0a1","name":"Purchases-success","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer Token"}],"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\": \"deepakdeepaksinghal@gmail.com\",\r\n \"date_of_birth\": \"1970-07-10\",\r\n \"street_address\": \"10 New Burlington Street Apt. 214\",\r\n \"country\": \"IN\",\r\n \"city\": \"London\",\r\n \"zip_code\": \"W1S 3BE\",\r\n \"cc\": [],\r\n \"bcc\": [],\r\n \"stateCode\": \"QLD\"\r\n },\r\n \"updated_on\": 1724147324,\r\n \"type\": \"purchase\",\r\n \"paymentMethod\": \"UPI\",\r\n \"amountUnit\": \"MAJOR\",\r\n \"errorMsg\": \"\",\r\n \"redirectType\": \"POST\",\r\n \"force_recurring\": false,\r\n \"created_on\": 1724147324,\r\n \"merchantRef\": \"66c4667bb993c970367c288a\",\r\n \"merchantName\": \"merchant002\",\r\n \"purchase\": {\r\n \"currency\": \"INR\",\r\n \"products\": [\r\n {\r\n \"name\": \"test\",\r\n \"quantity\": 1.0,\r\n \"price\": 10.0,\r\n \"discount\": 0,\r\n \"tax_percent\": \"0.00\"\r\n }\r\n ],\r\n \"total\": 10.0,\r\n \"language\": \"en\",\r\n \"notes\": \"\",\r\n \"debt\": 0,\r\n \"total_formatted\": 1.0,\r\n \"expireInMin\": \"35\",\r\n \"request_client_details\": [],\r\n \"timezone\": \"MIT\",\r\n \"email_message\": \"\"\r\n },\r\n \"payment\": {\r\n \"is_outgoing\": false,\r\n \"payment_type\": \"PURCHASE\",\r\n \"amount\": 10.0,\r\n \"currency\": \"INR\",\r\n \"net_amount\": 10.0,\r\n \"fee_amount\": 0.0,\r\n \"pending_amount\": 0.0,\r\n \"pending_unfreeze_on\": null,\r\n \"description\": \"\",\r\n \"paid_on\": 1724147324,\r\n \"remote_paid_on\": 1724147324\r\n },\r\n \"issuer_details\": {\r\n \"website\": \"\",\r\n \"legal_street_address\": \"\",\r\n \"legal_country\": \"\",\r\n \"legal_city\": \"\",\r\n \"legal_zip_code\": \"\",\r\n \"bank_accounts\": [\r\n {}\r\n ],\r\n \"legal_name\": \"test6\",\r\n \"brand_name\": \"test6\",\r\n \"registration_number\": \"\",\r\n \"tax_number\": \"\"\r\n },\r\n \"transaction_data\": {\r\n \"payment_method\": \"\",\r\n \"flow\": \"payform\",\r\n \"extra\": {\r\n \"amount\": 10.0,\r\n \"masked_pan\": \"UPI\"\r\n },\r\n \"country\": \"\",\r\n \"attempts\": [\r\n {\r\n \"client_ip\": \"103.59.75.113\",\r\n \"type\": \"execute\",\r\n \"payment_method\": \"UPI\",\r\n \"flow\": \"payform\",\r\n \"successful\": true,\r\n \"country\": \"UPI\",\r\n \"processing_time\": 1724147324,\r\n \"extra\": {\r\n \"amount\": 10.0,\r\n \"masked_pan\": \"UPI\"\r\n }\r\n }\r\n ]\r\n },\r\n \"status\": \"PAYMENT_IN_PROCESS\",\r\n \"status_history\": [\r\n {\r\n \"status\": \"created\",\r\n \"timestamp\": 1724147324\r\n },\r\n {\r\n \"status\": \"pending_execute\",\r\n \"timestamp\": 1724147324\r\n },\r\n {\r\n \"status\": \"payment_in_process\",\r\n \"timestamp\": 1724147324\r\n }\r\n ],\r\n \"is_test\": false,\r\n \"brand_id\": \"c4003b2c-22d4-4dc1-ad0c-c6b54f8c9636\",\r\n \"send_receipt\": false,\r\n \"is_recurring_token\": false,\r\n \"skip_capture\": false,\r\n \"reference_generated\": \"PS10907\",\r\n \"issued\": \"2024-08-20\",\r\n \"due\": 1724147324,\r\n \"refund_upto\": 1725871728,\r\n \"cc_descriptor\": \"test1\",\r\n \"fraudScore\": \"NA\",\r\n \"trustScore\": \"NA\",\r\n \"payInDetails\": {\r\n \"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 \"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\",\r\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\",\r\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\",\r\n \"generatedLink\": \"https://staging.decf.in/pay/514o5z3m9z\"\r\n },\r\n \"refund_availability\": \"NONE\",\r\n \"refundable_amount\": 10.0,\r\n \"success_redirect\": \"https://staging.paysecure.net/getResponse.jsp?success=true\",\r\n \"failure_redirect\": \"https://staging.paysecure.net/getResponse.jsp?success=false\",\r\n \"cancel_redirect\": \"\",\r\n \"success_callback\": \"https://staging.paysecure.net\",\r\n \"failure_callback\": \"https://staging.paysecure.net\",\r\n \"platform\": \"API\",\r\n \"created_from_ip\": \"103.59.75.113\",\r\n \"checkout_url\": \"https://staging.paysecure.net/payments/66c4667bb993c970367c288a/\",\r\n \"payoutProcess\": false\r\n}"},{"id":"2d4ebf5b-e39c-40db-a0c4-82d06880b0da","name":"Purchases","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer Token","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":"4689f84d-5102-4efc-a428-60d15713576c"}],"id":"0e7db449-3693-4cdc-b6dd-ae756c9192a5","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. Retrieve the PayIn details in the response JSON (as shown below).
  Although json contains numerous payInDetails links, users can utilize this to be redirected to a specific link.
  \n
2. Upon utilizing the checkout URL, the user will be presented with several payment choices from which to choose in order to complete the payment.
  \n
  1. Paytm
    \n
  2. Googlepay
    \n
  3. Phonepay
    \n
  4. QRCode
    \n
  \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":"0e7db449-3693-4cdc-b6dd-ae756c9192a5"},{"name":"PayOut API","item":[{"name":"Create PayOut","id":"aa8b3464-a052-4d7f-8416-daab8f5a25f4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer Token"}],"body":{"mode":"raw","raw":"{\r\n \"client\": {\r\n \"email\": \"yogesh@gmail.com\",\r\n \"country\" : \"CA\",\r\n \"phone\" : \"766225230591\",\r\n \"full_name\": \"Test Person-uk\"\r\n },\r\n \"beneficiaryDetail\":{\r\n \"transferType\" : \"IMPS\",\r\n \"ifscCode\":\"SBIN0001077\",\r\n \"payeeName\":\"YOgesh\",\r\n \"bankAccountNumber\": \"123456789011\"\r\n },\r\n \"purpose\" : \"test payout\",\r\n \"currency\" : \"INR\",\r\n \"payoutMethod\" : \"Payout-UPI\",\r\n \"amount\" : 10,\r\n \"success_callback\": \"https://success.com\",\r\n \"failure_callback\": \"https://failure.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\n\n\n\n\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
client.full_name
client.country
payoutMethod
beneficiaryDetail
beneficiaryDetail.transferType	One of the following values IMPS, UPI, RTGS, or NEFT,
beneficiaryDetail.ifscCode	if transferType is either of IMPS, RTGS, or NEFT
beneficiaryDetail.payeeName	if transferType is either of IMPS, RTGS, or NEFT
beneficiaryDetail.bankAccountNumber	if transferType is either of IMPS, RTGS, or NEFT
beneficiaryDetail.UPIid	if transferType is UPI
Currency	Note this is currency account for which you have balance
Amount
Purpose

**

Transfer Type:**

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

TYPE	REQUIRED
UPI	UPI id
IMPS	IFSC code payeeName bankAccountNumber
NEFT	IFSC code payeeName bankAccountNumber
RTGS	IFSC code payeeName bankAccountNumber

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://success.com\",

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

\n","urlObject":{"path":["getpayout","{payoutId}",""],"host":["https://api.paysecure.net/api/v1"],"query":[],"variable":[]}},"response":[{"id":"24be9d65-e3a6-4d49-8702-12b470d1bc14","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\": \"Yogesh@gmail.com\",\r\n \"phone\": \"766533230591\",\r\n \"full_name\": \"Test Person-uk\",\r\n \"country\": \"CA\"\r\n },\r\n \"updated_on\": 1719896808,\r\n \"payoutMethod\": \"PAYOUT-UPI\",\r\n \"beneficiaryDetail\": {\r\n \"upi\": \"charles.babbage@okhdfc\",\r\n \"transferType\": \"UPI\"\r\n },\r\n \"amountUnit\": \"MAJOR\",\r\n \"amount\": 10.0,\r\n \"errorMsg\": \"\",\r\n \"purpose\": \"test payout\",\r\n \"created_on\": 1719896808,\r\n \"merchantRef\": \"66838ae86d41e41c10a8656d\",\r\n \"merchantName\": \"newMerchant777\",\r\n \"status\": \"PAYOUT_IN_PROCESS\",\r\n \"status_history\": [\r\n {\r\n \"status\": \"created\",\r\n \"timestamp\": 1719896808\r\n },\r\n {\r\n \"status\": \"payout_in_process\",\r\n \"timestamp\": 1719896810\r\n },\r\n {\r\n \"status\": \"viewed\",\r\n \"timestamp\": 1719900796\r\n }\r\n ],\r\n \"viewedOn\": 1719900796,\r\n \"currency\": \"INR\",\r\n \"paymentOn\": 0,\r\n \"success_callback\": \"https://success.com\",\r\n \"failure_callback\": \"https://failure.com\"\r\n}\r\n"},{"id":"cae6e133-0978-493a-a435-5b099ebb4724","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":"8bbbf42c-c33b-4612-94dd-eb7ef00fbee1"}],"id":"de5e5ba8-33a6-4d8b-8620-d9b3c0e9c5f8","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":"de5e5ba8-33a6-4d8b-8620-d9b3c0e9c5f8"},{"name":"Get Balance API","item":[{"name":"Checking Balance","id":"31573f1a-d800-4650-94ac-e1760ec8bdca","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"Bearer Token","type":"text"}],"body":{"mode":"raw","raw":"{ \r\n \"paymentMethod\" : \"PAYOUT-UPI\"\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":"742ab566-6313-4be6-bc61-052d12b90a99","name":"Checking Balance payout-success","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{ \r\n \"paymentMethod\" : \"PAYOUT-UPI\"\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\": \"PAYOUT-UPI\",\r\n \"status\": \"success\",\r\n \"data\": [\r\n {\r\n \"currency\": \"INR\",\r\n \"balance\": \"11.25\"\r\n },\r\n {\r\n \"currency\": \"USD\",\r\n \"balance\": \"0.00\"\r\n }\r\n ]\r\n}\r\n"},{"id":"a39f095e-f1b2-4570-b1ce-23b312260a02","name":"Checking Balance payout-error","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"\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":"31573f1a-d800-4650-94ac-e1760ec8bdca"}],"id":"d15fdd17-3e6b-4020-9cec-36c407db4ad2","_postman_id":"d15fdd17-3e6b-4020-9cec-36c407db4ad2","description":""}],"id":"a22793ee-e652-49ac-9246-301020ad979b","_postman_id":"a22793ee-e652-49ac-9246-301020ad979b","description":""},{"name":"🇲🇽 SPEI Payments","item":[{"name":"Concepts","item":[],"id":"29c195b0-27ac-407c-9d02-bbbbf4da714c","description":"

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

\n","_postman_id":"29c195b0-27ac-407c-9d02-bbbbf4da714c"},{"name":"Payin API","item":[{"name":"Payin API","id":"4d2e2e28-57a1-4b5a-a03b-d510dd80c86a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer {{your_API_Key}}"}],"body":{"mode":"raw","raw":"{\n \"client\": {\n \"email\": \"ashishm.21190@gmail.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 \"extraParam\": {},\n \"status\": \"created\",\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":"

1. Endpoint & Authentication

http POST <https://api.paysecure.net/api/v1/purchases>\nHeaders:\n  Authorization: Bearer {LIVE_API_KEY}\n  Content-Type: application/json\n\n

– Use your live or sandbox API key in the Authorization header.

– All requests must be sent as application/json.

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

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

4. 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","urlObject":{"protocol":"https","path":["api","v1","purchases"],"host":["api","paysecure","net"],"query":[],"variable":[]}},"response":[{"id":"c994ad6f-a195-4c5e-8731-3aba0ce5b4f6","name":"Success","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer {{your_API_Key}}"}],"body":{"mode":"raw","raw":"{\n \"client\": {\n \"email\": \"ashishm.21190@gmail.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 \"extraParam\": {},\n \"status\": \"created\",\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\": \"683d768a22ae19559d740836\",\n \"client\": {\n \"customerId\": \"NA\",\n \"email\": \"ashishm.21190@gmail.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\": \"arunsinghal\",\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\": \"103.59.75.242, 162.158.22.197, 130.176.183.5\",\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\": \"CHOICEPAY 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\": \"103.59.75.242, 162.158.22.197, 130.176.183.5\",\n \"checkout_url\": \"https://api.choicepay.ca/payments/683d768a22ae19559d740836/\",\n \"payoutProcess\": false\n}"}],"_postman_id":"4d2e2e28-57a1-4b5a-a03b-d510dd80c86a"}],"id":"813fc796-3c79-455b-a659-26f4458b1064","_postman_id":"813fc796-3c79-455b-a659-26f4458b1064","description":""},{"name":"Payout API","item":[{"name":"Payout API","id":"b38b1cf4-e1af-4390-8844-1929c221c984","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer {{your_API_Key}}"}],"body":{"mode":"raw","raw":"{\n \"client\": {\n \"email\": \"ashishm.21190@gmail.com\",\n \"country\": \"MX\",\n \"phone\": \"+14377717874\",\n \"full_name\": \"MARCO ANTONIO FERNANDEZ RAMIREZ\",\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://test.com/getResponse.jsp?success=true\",\n \"failure_redirect\": \"https://test.com/getResponse.jsp?success=false\",\n \"success_callback\": \"https://test1.com\",\n \"failure_callback\": \"https://test2.com\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.paysecure.net/api/v1/payout/","description":"

Payout API Integration (SPEI)

1. Endpoint & Authentication

http POST https://api.paysecure.net/api/v1/payout/\nHeaders:\n  Authorization: Bearer {LIVE_API_KEY}\n  Content-Type: application/json\n\n

Use your live or sandbox API key in the Authorization header.
\n
All requests must be sent as application/json.
\n

2. 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\": \"ashishm.21190@gmail.com\",\n    \"country\": \"MX\",\n    \"phone\": \"+14377717874\",\n    \"full_name\": \"MARCO ANTONIO FERNANDEZ RAMIREZ\",\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://test.com/getResponse.jsp?success=true\",\n  \"failure_redirect\": \"https://test.com/getResponse.jsp?success=false\",\n  \"success_callback\": \"https://test1.com\",\n  \"failure_callback\": \"https://test2.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

3. Sample Response & Key Fields

jsonCopy{\n  \"payoutId\": \"683d778dc74d23074a56ea94\",\n  \"client\": {\n    \"customerId\": \"NA\",\n    \"email\": \"ashishm.21190@gmail.com\",\n    \"phone\": \"+14377717874\",\n    \"full_name\": \"MARCO ANTONIO FERNANDEZ RAMIREZ\",\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://test.com/getResponse.jsp?success=true\",\n  \"failure_redirect\": \"https://test.com/getResponse.jsp?success=false\",\n  \"redirectType\": \"GET\",\n  \"success_callback\": \"https://test1.com\",\n  \"failure_callback\": \"https://test2.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.

5. 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","urlObject":{"protocol":"https","path":["api","v1","payout",""],"host":["api","paysecure","net"],"query":[],"variable":[]}},"response":[{"id":"4dab5d98-0256-4010-b792-0fdae91bc97f","name":"Success","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer {{your_API_Key}}"}],"body":{"mode":"raw","raw":"{\n \"client\": {\n \"email\": \"ashishm.21190@gmail.com\",\n \"country\": \"MX\",\n \"phone\": \"+14377717874\",\n \"full_name\": \"MARCO ANTONIO FERNANDEZ RAMIREZ\",\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://test.com/getResponse.jsp?success=true\",\n \"failure_redirect\": \"https://test.com/getResponse.jsp?success=false\",\n \"success_callback\": \"https://test1.com\",\n \"failure_callback\": \"https://test2.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\": \"ashishm.21190@gmail.com\",\n \"phone\": \"+14377717874\",\n \"full_name\": \"MARCO ANTONIO FERNANDEZ RAMIREZ\",\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://test.com/getResponse.jsp?success=true\",\n \"failure_redirect\": \"https://test.com/getResponse.jsp?success=false\",\n \"redirectType\": \"GET\",\n \"success_callback\": \"https://test1.com\",\n \"failure_callback\": \"https://test2.com\"\n}"}],"_postman_id":"b38b1cf4-e1af-4390-8844-1929c221c984"}],"id":"ae26816c-452d-489c-9da8-dba5ccfd4fdf","_postman_id":"ae26816c-452d-489c-9da8-dba5ccfd4fdf","description":""}],"id":"48c75ca6-f257-4774-883a-44f039e746cc","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

\n","_postman_id":"48c75ca6-f257-4774-883a-44f039e746cc"},{"name":"🌍 MobileMoney (Africa)","item":[{"name":"Concepts","item":[],"id":"87c5273e-8347-4f94-afe7-73c52e068b4d","description":"

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

\n","_postman_id":"87c5273e-8347-4f94-afe7-73c52e068b4d"},{"name":"Coverage","item":[],"id":"14fee8a0-b087-41a7-ba27-c4a5b56439df","description":"

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

\n","_postman_id":"14fee8a0-b087-41a7-ba27-c4a5b56439df"},{"name":"PayIn API","item":[{"name":"Purchases","id":"9516942e-d693-478b-b1af-014ee281ac59","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"client\": {\n \"full_name\": \"akshaya singhal\",\n \"email\": \"akshaya@gmail.com\",\n \"country\": \"ZA\",\n \"city\": \"sdf\",\n \"stateCode\": \"CA\",\n \"street_address\": \"test test\",\n \"zip_code\": \"234567\",\n \"phone\": \"9999999999\",\n \"tax_number\": \"34946395822\"\n },\n \"purchase\": {\n \"currency\": \"ZAR\",\n \"expireInMin\": \"40\",\n \"products\": [\n {\n \"name\": \"he2938h\",\n \"price\": \"100\"\n }\n ]\n },\n \"paymentMethod\": \"MOBILEWALLET\",\n \"brand_id\": \"c4003b2c-22d4-4dc1-ad0c-c6b54f8c9636\",\n \"merchantRef\": \"\",\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":"

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
client.country	ISO-3166 Country Code. It must be upper case.
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. eg. This should be 'TZS' for Tanzania
purchase.products.name
purchase.products.price
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":{"protocol":"https","path":["api","v1","purchases",""],"host":["api","paysecure","net"],"query":[],"variable":[]}},"response":[{"id":"01e22647-afb2-4e8b-9bb1-7e7e761b0f06","name":"Collection","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"client\": {\n \"full_name\": \"akshaya singhal\",\n \"email\": \"akshaya@gmail.com\",\n \"country\": \"ZA\",\n \"city\": \"sdf\",\n \"stateCode\": \"ca\",\n \"street_address\": \"test test\",\n \"zip_code\": \"234567\",\n \"phone\": \"9999999999\",\n \"tax_number\": \"34946395822\"\n },\n \"purchase\": {\n \"currency\": \"ZAR\",\n \"expireInMin\": \"40\",\n \"products\": [\n {\n \"name\": \"he2938h\",\n \"price\": \"200\"\n }\n ]\n },\n \"paymentMethod\": \"MOBILEMONEY\",\n \"brand_id\": \"c4003b2c-22d4-4dc1-ad0c-c6b54f8c9636\",\n \"merchantRef\": \"\",\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/"},"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\": \"67531141002e65664c0ef342\",\n \"client\": {\n \"customerId\": \"NA\",\n \"email\": \"akshaya@gmail.com\",\n \"phone\": \"9999999999\",\n \"full_name\": \"akshaya singhal\",\n \"street_address\": \"test test\",\n \"country\": \"ZA\",\n \"city\": \"sdf\",\n \"zip_code\": \"234567\",\n \"cc\": [],\n \"bcc\": [],\n \"tax_number\": \"34946395822\",\n \"stateCode\": \"ca\"\n },\n \"updated_on\": 1733497153,\n \"type\": \"purchase\",\n \"paymentMethod\": \"MOBILEWALLET\",\n \"amountUnit\": \"MAJOR\",\n \"errorMsg\": \"This customer can not be processed !\",\n \"redirectType\": \"POST\",\n \"force_recurring\": false,\n \"created_on\": 1733497153,\n \"merchantRef\": \"67531141002e65664c0ef342\",\n \"merchantName\": \"merchant002\",\n \"purchase\": {\n \"currency\": \"ZAR\",\n \"products\": [\n {\n \"name\": \"he2938h\",\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\": \"40\",\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\": \"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\": \"MOBILEWALLET\"\n },\n \"country\": \"\",\n \"attempts\": [\n {\n \"client_ip\": \"49.36.232.165\",\n \"type\": \"execute\",\n \"payment_method\": \"MOBILEWALLET\",\n \"flow\": \"payform\",\n \"successful\": false,\n \"country\": \"MOBILEWALLET\",\n \"processing_time\": 1733497153,\n \"extra\": {\n \"amount\": 100,\n \"masked_pan\": \"MOBILEWALLET\"\n },\n \"error\": {\n \"message\": \"This customer can not be processed !\",\n \"code\": \"transaction_error\"\n }\n }\n ]\n },\n \"status\": \"ERROR\",\n \"status_history\": [\n {\n \"status\": \"created\",\n \"timestamp\": 1733497153\n },\n {\n \"status\": \"pending_execute\",\n \"timestamp\": 1733497153\n },\n {\n \"status\": \"error\",\n \"timestamp\": 1733497153\n }\n ],\n \"is_test\": false,\n \"brand_id\": \"c4003b2c-22d4-4dc1-ad0c-c6b54f8c9636\",\n \"is_recurring_token\": false,\n \"reference_generated\": \"PS12859\",\n \"issued\": \"2024-12-06\",\n \"due\": 1733497153,\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 \"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\": \"49.36.232.165\",\n \"checkout_url\": \"https://staging.paysecure.net/payments/67531141002e65664c0ef342/\",\n \"reconciled\": false,\n \"payoutProcess\": false\n}"}],"_postman_id":"9516942e-d693-478b-b1af-014ee281ac59"}],"id":"714a0010-1d16-44ad-bf36-7636f1f7b9e5","_postman_id":"714a0010-1d16-44ad-bf36-7636f1f7b9e5","description":""},{"name":"Payout API","item":[{"name":"Payout","id":"6f88c7c7-0f09-4167-866c-0ba1cd1c49b2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"client\": {\n \"email\": \"akshayas@gmail.com\",\n \"full_name\": \"Akshaya Signal\",\n },\n \"purpose\": \"withdraw\",\n \"payoutMethod\": \"Payout-MOBILEMONEY\",\n \"amount\": 100,\n \"currency\": \"TZS\",\n \"success_callback\": \"https://Success.com\",\n \"failure_callback\": \"https://failure.com\"\n}\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/

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

Parameter	Notes
client.full_name	Receiver Full Name
payoutMethod	Payout-MOBILEMONEY
Amount	Amount in currency
Currency	Note this is currency account for which you have balance
success_redirect	URL to send the user if the transactions is successful
failure_redirect	URL to send the user if the transactions is UNSUCCESSFUL
Purpose	Purpose of Payout

","urlObject":{"path":["payout",""],"host":["https://api.paysecure.net/api/v1"],"query":[],"variable":[]}},"response":[{"id":"b7c88f76-1a7b-4d68-9bde-fd63f697245d","name":"Payout","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"client\": {\n \"email\": \"akshayas@gmail.com\",\n \"full_name\": \"Akshaya Signal\"\n },\n \"purpose\": \"withdraw\",\n \"payoutMethod\": \"Payout-MOBILEMONEY\",\n \"amount\": 100,\n \"currency\": \"TZS\",\n \"success_callback\": \"https://Success.com\",\n \"failure_callback\": \"https://failure.com\"\n}\n","options":{"raw":{"language":"json"}}},"url":"https://api.paysecure.net/api/v1/payout/"},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\"payoutId\":\"67c93735a055ad58b6c154f0\",\"client\":{\"customerId\":\"NA\",\"email\":\"test@gmail.com\",\"phone\":\"+260762220028\",\"full_name\":\"Michael Nawa\",\"country\":\"ZZ\"},\"updated_on\":1741240117,\"payoutMethod\":\"PAYOUT-MOBILEMONEY\",\"amountUnit\":\"MAJOR\",\"amount\":500.0,\"errorMsg\":\"\",\"purpose\":\"payout to test\",\"created_on\":1741240117,\"merchantRef\":\"67c93735a055ad58b6c154f0\",\"status\":\"PAYOUT_IN_PROCESS\",\"status_history\":[{\"status\":\"created\",\"timestamp\":1741240117},{\"status\":\"payout_in_process\",\"timestamp\":1741240125}],\"currency\":\"UGX\",\"paymentOn\":0,\"success_callback\":\"\",\"failure_callback\":\"\"}"}],"_postman_id":"6f88c7c7-0f09-4167-866c-0ba1cd1c49b2"}],"id":"c4fa2ea8-323f-4d2d-9dd9-c4e8a23dfcaf","_postman_id":"c4fa2ea8-323f-4d2d-9dd9-c4e8a23dfcaf","description":""}],"id":"b7ffa088-6e76-4c7c-84e0-b809ecdd154a","_postman_id":"b7ffa088-6e76-4c7c-84e0-b809ecdd154a","description":""},{"name":"🌐 Paymint - Crypto Wallet","item":[{"name":"Concepts","item":[],"id":"7802c0e3-8fb1-4eaa-a95e-e299b7067df0","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":"7802c0e3-8fb1-4eaa-a95e-e299b7067df0"},{"name":"Payin API","item":[{"name":"Purchases","id":"86cb029d-470c-4891-9efc-6d72c8a407a1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer Token"}],"body":{"mode":"raw","raw":"{\r\n \"client\": {\r\n \"email\": \"seo2009@test.com\",\r\n \"street_address\": \"10 New Burlington Street Apt. 214\",\r\n \"city\": \"London\",\r\n \"full_name\": \"Test test\",\r\n \"zip_code\": \"W1S 3BE\",\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\": \"f6aff7d7-bb40-4857-bc84-9b4c8310b043\",\r\n \"success_redirect\": \"https://your.redirect.url/getResponse.jsp?success=true\",\r\n \"pending_redirect\": \"https://your.redirect.url/getResponse.jsp?success=true\",\r\n \"failure_redirect\": \"https://your.redirect.url/getResponse.jsp?success=false\",\r\n \"success_callback\": \"https://your.success.callback.url\",\r\n \"failure_callback\": \"https://your.success.failure.url\"\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":"381c2db4-77ac-4c10-a2a4-8562c89572a7","name":"Purchase- success","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer Token"}],"body":{"mode":"raw","raw":"{\r\n \"client\": {\r\n \"email\": \"seo2009@test.com\",\r\n \"street_address\": \"10 New Burlington Street Apt. 214\",\r\n \"city\": \"London\",\r\n \"full_name\": \"Test test\",\r\n \"zip_code\": \"W1S 3BE\",\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\": \"f6aff7d7-bb40-4857-bc84-9b4c8310b043\",\r\n \"success_redirect\": \"https://your.redirect.url/getResponse.jsp?success=true\",\r\n \"pending_redirect\": \"https://your.redirect.url/getResponse.jsp?success=true\",\r\n \"failure_redirect\": \"https://your.redirect.url/getResponse.jsp?success=false\",\r\n \"success_callback\": \"https://your.success.callback.url\",\r\n \"failure_callback\": \"https://your.success.failure.url\"\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\":\"ashishm.21190@gmail.com\",\"phone\":\"+447755564318\",\"full_name\":\"Test test\",\"date_of_birth\":\"1970-07-10\",\"street_address\":\"10 New Burlington Street Apt. 214\",\"country\":\"CA\",\"city\":\"London\",\"zip_code\":\"W1S 3BE\",\"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\":\"arunsinghal\",\"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\":\"103.59.75.41, 162.158.88.44, 130.176.93.146\",\"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\":\"30f7ce6e-3b7e-46a2-9b50-484fc55be689\",\"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\":\"transfer@ieft.ca\",\"secretQA\":\"66a8c78af1fc2f768304bce4\",\"secretAnswer\":\"ps8766a8af\"},\"paidOn\":0,\"receivedAmt\":0.0,\"refund_availability\":\"NONE\",\"refundable_amount\":0.0,\"success_redirect\":\"https://your.redirect.url/getResponse.jsp?success=true\",\"failure_redirect\":\"https://your.redirect.url/getResponse.jsp?success=false\",\"cancel_redirect\":\"\",\"success_callback\":\"https://your.success.callback.url\",\"failure_callback\":\"https://your.success.failure.url\",\"platform\":\"API\",\"created_from_ip\":\"103.59.75.41, 162.158.88.44, 130.176.93.146\",\"checkout_url\":\"https://api.choicepay.ca/payments/67efd0ff97be603f97a3a697/\",\"payoutProcess\":false}"}],"_postman_id":"86cb029d-470c-4891-9efc-6d72c8a407a1"},{"name":"Get Status","id":"bb340f9c-f2fb-42a1-931d-2646f4a9439c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer Token","type":"text"}],"url":"https://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":"5ffec083-1ed9-4735-9705-0cf3c02630e4","name":"Purchases-success","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer Token"}],"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\": \"ashishm.21190@gmail.com\",\n \"phone\": \"+14377717874\",\n \"full_name\": \"Test test\",\n \"date_of_birth\": \"1970-07-10\",\n \"street_address\": \"10 New Burlington Street Apt. 214\",\n \"country\": \"CA\",\n \"city\": \"London\",\n \"zip_code\": \"W1S 3BE\",\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\": \"arunsinghal\",\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\": \"103.59.75.42, 172.71.186.102, 130.176.183.14\",\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\": \"30f7ce6e-3b7e-46a2-9b50-484fc55be689\",\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\": \"deposit@ieft.ca\",\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.redirect.url/getResponse.jsp?success=true\",\n \"failure_redirect\": \"https://your.redirect.url/getResponse.jsp?success=false\",\n \"cancel_redirect\": \"\",\n \"success_callback\": \"https://webhook.site/83df9776-3590-4e25-9222-870e931ac868\",\n \"failure_callback\": \"https://webhook.site/83df9776-3590-4e25-9222-870e931ac868\",\n \"platform\": \"API\",\n \"created_from_ip\": \"103.59.75.42, 172.71.186.102, 130.176.183.14\",\n \"checkout_url\": \"https://api.choicepay.ca/payments/6790e75fa46a5a5bb0b00e55/\",\n \"payoutProcess\": false\n}"},{"id":"9c57967a-ed25-4652-8467-42d40b69f033","name":"Purchases Error","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer Token","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":"bb340f9c-f2fb-42a1-931d-2646f4a9439c"}],"id":"0fd2e4e3-958b-46af-a087-3a5653e435ba","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":"0fd2e4e3-958b-46af-a087-3a5653e435ba"}],"id":"8276ec47-9545-464a-a524-94994d9d9a10","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":"8276ec47-9545-464a-a524-94994d9d9a10"},{"name":"🌎 Neosurf - Voucher Payments","item":[{"name":"Concepts","item":[],"id":"3e56dd73-6c16-4665-a27c-67e1b96e1d64","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: Singapore, 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":"3e56dd73-6c16-4665-a27c-67e1b96e1d64"},{"name":"Payin API","item":[{"name":"Purchases","id":"ad98ebbd-074d-4f08-b8dc-7db9439c7763","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer {{your_API_Key}}"}],"body":{"mode":"raw","raw":"{\n \"client\": {\n \"email\": \"example22@paysecure.net\",\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 staging API key).
Content-Type	string	Must be `application/json`.
client.email	string	Customer’s email (e.g., `example22@paysecure.net`).
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 staging 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":{"protocol":"https","path":["api","v1","purchases"],"host":["api","paysecure","net"],"query":[],"variable":[]}},"response":[{"id":"3d4d2138-0924-491d-9956-dac80cc5224f","name":"Success","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer {{your_API_Key}}"}],"body":{"mode":"raw","raw":"{\n \"client\": {\n \"email\": \"example22@paysecure.net\",\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\": \"example22@paysecure.net\",\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\": \"arunsinghal\",\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\": \"103.59.75.242, 162.158.23.126, 130.176.183.12\",\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\": \"30f7ce6e-3b7e-46a2-9b50-484fc55be689\",\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\": \"103.59.75.242, 162.158.23.126, 130.176.183.12\",\n \"checkout_url\": \"https://api.choicepay.ca/payments/683d6bab12b471481d4f66cf/\",\n \"payoutProcess\": false\n}"}],"_postman_id":"ad98ebbd-074d-4f08-b8dc-7db9439c7763"}],"id":"1126cb88-7adb-4cb4-a297-7fd0376b988b","_postman_id":"1126cb88-7adb-4cb4-a297-7fd0376b988b","description":""},{"name":"Payout API","item":[{"name":"Payout API","id":"5033366d-74dc-4ec2-897a-2e27c5183977","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer {{your_API_Key}}"}],"body":{"mode":"raw","raw":"{\n \"client\": {\n \"email\": \"akshayadeepsinghal@gmail.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://success.com\",\n \"failure_callback\": \"https://failure.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":{"protocol":"https","path":["api","v1","payout",""],"host":["api","paysecure","net"],"query":[],"variable":[]}},"response":[{"id":"8f9a2a04-c490-4da1-a9d7-3ef5b9a3fb65","name":"New Request","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer {{your_API_Key}}"}],"body":{"mode":"raw","raw":"{\n \"client\": {\n \"email\": \"akshayadeepsinghal@gmail.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://success.com\",\n \"failure_callback\": \"https://failure.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\": \"akshayadeepsinghal@gmail.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://success.com\",\n \"failure_callback\": \"https://failure.com\"\n}"}],"_postman_id":"5033366d-74dc-4ec2-897a-2e27c5183977"}],"id":"58e50607-07f1-4ce8-8909-1e2b6c7944f7","_postman_id":"58e50607-07f1-4ce8-8909-1e2b6c7944f7","description":""}],"id":"e567cab4-2c8e-47d3-a1f6-91bbe67aa62e","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":"e567cab4-2c8e-47d3-a1f6-91bbe67aa62e"},{"name":"🇦🇺 PayID","item":[{"name":"Concepts","item":[],"id":"b9b80b73-855f-498e-a7e9-2e83fa274f07","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":"b9b80b73-855f-498e-a7e9-2e83fa274f07"},{"name":"Payin API","item":[{"name":"Purchases","id":"5ebbed07-4d64-4d52-95ef-de9ecc78a4ec","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"client\": {\n \"email\": \"seo2009@test.com\",\n \"street_address\": \"10 New Burlington Street Apt. 214\",\n \"city\": \"Sydney\",\n \"full_name\": \"Test test\",\n \"zip_code\": \"W1S 3BE\",\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\": \"f6aff7d7-bb40-4857-bc84-9b4c8310b043\",\n \"success_redirect\": \"\",\n \"pending_redirect\": \"\",\n \"failure_redirect\": \"\",\n \"success_callback\": \"\",\n \"failure_callback\": \"..failure.callback.url\"\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":{"protocol":"https","path":["api","v1","purchases"],"host":["api","paysecure","net"],"query":[],"variable":[]}},"response":[{"id":"5e1b4229-d0e8-4764-87b2-abce4159ac61","name":"Success","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"client\": {\n \"email\": \"seo2009@test.com\",\n \"street_address\": \"10 New Burlington Street Apt. 214\",\n \"city\": \"Sydney\",\n \"full_name\": \"Test test\",\n \"zip_code\": \"W1S 3BE\",\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\": \"f6aff7d7-bb40-4857-bc84-9b4c8310b043\",\n \"success_redirect\": \"\",\n \"pending_redirect\": \"\",\n \"failure_redirect\": \"\",\n \"success_callback\": \"\",\n \"failure_callback\": \"..failure.callback.url\"\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\": \"arun44@gmail.com\",\n \"phone\": \"+237679544810\",\n \"full_name\": \"Olive Tsafack\",\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\": \"c4003b2c-22d4-4dc1-ad0c-c6b54f8c9636\",\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\": \"\",\n \"failure_redirect\": \"\",\n \"cancel_redirect\": \"\",\n \"success_callback\": \"\",\n \"failure_callback\": \"\",\n \"platform\": \"API\",\n \"created_from_ip\": \"183.83.54.51\",\n \"checkout_url\": \"\",\n \"payoutProcess\": false\n}"}],"_postman_id":"5ebbed07-4d64-4d52-95ef-de9ecc78a4ec"}],"id":"81376dd5-f0dc-4ccf-9f11-438d640eaa41","_postman_id":"81376dd5-f0dc-4ccf-9f11-438d640eaa41","description":""},{"name":"Payout API","item":[{"name":"New Request","id":"d49481ba-c0ab-46b9-ad6a-9c10937b1a0d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer Token"}],"body":{"mode":"raw","raw":"{\n \"client\": {\n \"email\": \"ashishm.21190@gmail.com\",\n \"country\": \"CA\",\n \"phone\": \"7665230591\",\n \"full_name\": \"Test Person-uk\"\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\": \"arun\"\n },\n \"success_callback\": \"\",\n \"failure_callback\": \"\"\n}","options":{"raw":{"language":"json"}}},"url":"","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":{"protocol":""],"host":["staging","paysecure","net"],"query":[],"variable":[]}},"response":[{"id":"5277c7e7-5395-4c46-8bc8-a9e93046b164","name":"Success","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer Token"}],"body":{"mode":"raw","raw":"{\n \"client\": {\n \"email\": \"ashishm.21190@gmail.com\",\n \"country\": \"CA\",\n \"phone\": \"7665230591\",\n \"full_name\": \"Test Person-uk\"\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\": \"arun\"\n },\n \"success_callback\": \"\",\n \"failure_callback\": \"\"\n}","options":{"raw":{"language":"json"}}},"url":""},"_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\": \"akshayadeepsinghal@gmail.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\": \"\",\n \"failure_callback\": \"\"\n}"},{"id":"d6632b66-55a6-4a62-8381-dafac8be87d0","name":"Error","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer Token"}],"body":{"mode":"raw","raw":"{\n \"client\": {\n \"email\": \"ashishm.21190@gmail.com\",\n \"country\": \"CA\",\n \"phone\": \"7665230591\",\n \"full_name\": \"Test Person-uk\"\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\": \"arun\"\n },\n \"success_callback\": \"\",\n \"failure_callback\": \"\"\n}","options":{"raw":{"language":"json"}}},"url":""},"_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\": \"akshayadeepsinghal@gmail.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\": \"\",\n \"failure_callback\": \"\"\n}"}],"_postman_id":"d49481ba-c0ab-46b9-ad6a-9c10937b1a0d"}],"id":"c6b9dd27-e6fd-46c5-bc06-a158c0924015","_postman_id":"c6b9dd27-e6fd-46c5-bc06-a158c0924015","description":""}],"id":"d3daf44f-6b6d-414c-b034-7b2fe2a98a9d","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":"d3daf44f-6b6d-414c-b034-7b2fe2a98a9d"},{"name":"🌐 CryptoBridge","item":[{"name":"Concepts","item":[],"id":"ffef1044-5ad9-481b-885d-c5b95ae5ab33","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

\n","_postman_id":"ffef1044-5ad9-481b-885d-c5b95ae5ab33"},{"name":"Payin API","item":[{"name":"Purchases","id":"22b46753-0841-4092-a73a-87d124a24f78","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"{your_API_Key}"}],"body":{"mode":"raw","raw":"{\n \"client\": {\n \"email\": \"gaurav@gmail.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 \"tax_number\": \"39933551809\"\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\": \"cec67fe3-a01d-4d0d-b100-9fafb200fe15\",\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 }\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.

💡 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

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
`clientFee`	Optional: A custom fee you (the merchant) want to charge — shown to the user at checkout
`success_redirect` / `failure_redirect`	Where the user should land after completing or canceling the payment
`success_callback` / `failure_callback`	Your backend URL to receive transaction status via webhook
`client`	Customer billing info

","urlObject":{"protocol":"https","path":["api","v1","purchases"],"host":["api","paysecure","net"],"query":[],"variable":[]}},"response":[{"id":"12053351-e3b3-4c86-b9a1-572dfe9d8913","name":"Purchases","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"{your_API_Key}"}],"body":{"mode":"raw","raw":"{\n \"client\": {\n \"email\": \"gaurav@gmail.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 \"tax_number\": \"39933551809\"\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\": \"cec67fe3-a01d-4d0d-b100-9fafb200fe15\",\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 }\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\": \"gaurav@gmail.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 },\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\": \"103.59.75.157, 172.69.203.75, 18.68.12.102\",\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\": \"cec67fe3-a01d-4d0d-b100-9fafb200fe15\",\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\": \"103.59.75.157, 172.69.203.75, 18.68.12.102\",\n \"checkout_url\": \"https://api.choicepay.ca/payments/6874ce9402f0f25ed8fc66a7/\",\n \"payoutProcess\": false\n}"}],"_postman_id":"22b46753-0841-4092-a73a-87d124a24f78"}],"id":"a8b41a0b-a25b-472f-931e-8817a600b250","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

\n","_postman_id":"a8b41a0b-a25b-472f-931e-8817a600b250"}],"id":"d0f349bb-efa4-4bd2-b4ee-941a4ecdb3d4","description":"

📖 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

\n","_postman_id":"d0f349bb-efa4-4bd2-b4ee-941a4ecdb3d4"},{"name":"Virtual Accounts (South Korea)","item":[{"name":"Concepts","item":[],"id":"7991ca13-7aac-4a1e-9c0d-4d255fc97c5d","description":"

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":"7991ca13-7aac-4a1e-9c0d-4d255fc97c5d"},{"name":"Payin","item":[{"name":"Create Purchase","id":"ef0b7b8b-3587-42c7-a11f-2342b94a967a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer Token"}],"body":{"mode":"raw","raw":"{\n \"client\": {\n \"email\": \"seo2009@test.com\",\n \"street_address\": \"10 New Burlington Street Apt. 214\",\n \"city\": \"Sydney\",\n \"full_name\": \"Test test\",\n \"zip_code\": \"W1S 3BE\",\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\": \"f6aff7d7-bb40-4857-bc84-9b4c8310b043\",\n \"success_redirect\": \"https://your.success.redirect.url\",\n \"pending_redirect\": \"https://your.pending.redirect.url\",\n \"failure_redirect\": \"https://your.failure.redirect.url\",\n \"success_callback\": \"https://your.success.callback.url\",\n \"failure_callback\": \"https://your.failure.callback.url\"\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":{"protocol":"https","path":["api","v1","purchases"],"host":["api","paysecure","net"],"query":[],"variable":[]}},"response":[{"id":"960ab212-7095-403a-8120-f102a4a1888e","name":"purchase-sucess","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer Token"}],"body":{"mode":"raw","raw":"{\n \"client\": {\n \"email\": \"seo2009@test.com\",\n \"street_address\": \"10 New Burlington Street Apt. 214\",\n \"city\": \"Sydney\",\n \"full_name\": \"Test test\",\n \"zip_code\": \"W1S 3BE\",\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\": \"f6aff7d7-bb40-4857-bc84-9b4c8310b043\",\n \"success_redirect\": \"https://your.success.redirect.url\",\n \"pending_redirect\": \"https://your.pending.redirect.url\",\n \"failure_redirect\": \"https://your.failure.redirect.url\",\n \"success_callback\": \"https://your.success.callback.url\",\n \"failure_callback\": \"https://your.failure.callback.url\"\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\": \"arun44@gmail.com\",\n \"phone\": \"+237679544810\",\n \"full_name\": \"Olive Tsafack\",\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\": \"c4003b2c-22d4-4dc1-ad0c-c6b54f8c9636\",\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.url\",\n \"pending_redirect\": \"https://your.pending.redirect.url\",\n \"failure_redirect\": \"https://your.failure.redirect.url\",\n \"cancel_redirect\": \"\",\n \"success_callback\": \"https://your.success.callback.url\",\n \"failure_callback\": \"https://your.failure.callback.url\",\n \"platform\": \"API\",\n \"created_from_ip\": \"183.83.54.51\",\n \"checkout_url\": \"https://staging.paysecure.net/payments/68441c2a7559cf659fd7e835/\",\n \"payoutProcess\": false\n}"}],"_postman_id":"ef0b7b8b-3587-42c7-a11f-2342b94a967a"},{"name":"Get Status","id":"daf96390-c01f-4be4-ac3b-31bde951772f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer Token","type":"text"}],"url":"https://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":"f703ebaa-a3d7-497d-b3ab-14d05de91d2e","name":"Purchases-success","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer Token","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\": \"90ed108b-6753-465d-8a21-e2cc604ff814\",\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\": \"90ed108b-6753-465d-8a21-e2cc604ff814 \",\r\n \"success_redirect\": \"https://test.com/getResponse.jsp?success=true\",\r\n \"failure_redirect\": \"https://test.com/getResponse.jsp?success=false\",\r\n \"success_callback\": \"https://test1.com\",\r\n \"failure_callback\": \"https://test2.com\"\r\n \"cancel_redirect\": \"\",\r\n \"platform\": \"API\",\r\n \"created_from_ip\": \"110.235.229.223\",\r\n \"checkout_url\": \"https://app.paysecure.net/payments/65f95faa70fe897720c40a15/\"\r\n}\r\n"},{"id":"092b4ebf-8119-4b89-b157-4104fc0cb01e","name":"Purchases","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer Token","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":"daf96390-c01f-4be4-ac3b-31bde951772f"}],"id":"7a315c6b-531a-4e0b-9af2-eb1efde81914","_postman_id":"7a315c6b-531a-4e0b-9af2-eb1efde81914","description":""}],"id":"9e1414b5-864a-4a67-a8f8-6aed4f517411","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":"9e1414b5-864a-4a67-a8f8-6aed4f517411"}],"id":"774850b4-dfb4-4d16-9255-4dbff8ad87d6","_postman_id":"774850b4-dfb4-4d16-9255-4dbff8ad87d6","description":""},{"name":"🏦 Bank Transfers","item":[{"name":"Concepts","item":[],"id":"f7ee921a-c78d-4b70-a064-982747ab9b95","description":"

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

\n","_postman_id":"f7ee921a-c78d-4b70-a064-982747ab9b95"},{"name":"Status Code","item":[],"id":"3ffa848b-5388-4173-8b3b-244df495b457","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 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":"5af90fb4-8ae2-4850-abb1-358ff7401f8e"}},{"listen":"test","script":{"type":"text/javascript","exec":[""],"id":"299ca791-48ad-4b21-a1d5-5b52f87a3690"}}],"_postman_id":"3ffa848b-5388-4173-8b3b-244df495b457"},{"name":"PayIn API","item":[{"name":"Create Purchase","id":"0385cff7-be68-4b2f-a095-682c0c4978d9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer Token"}],"body":{"mode":"raw","raw":"{\r\n \"client\": {\r\n \"email\": \"test@gmail.com\",\r\n \"street_address\": \"10 New Burlington Street Apt. 214\",\r\n \"city\": \"London\",\r\n \"full_name\": \"Test test\",\r\n \"zip_code\": \"W1S 3BE\",\r\n \"country\": \"GB\",\r\n \"date_of_birth\": \"1970-07-10\",\r\n \"stateCode\": \"QLD\",\r\n \"phone\": \"+447755564318\"\r\n },\r\n \"purchase\": {\r\n \"currency\": \"USD\",\r\n \"products\": [\r\n {\r\n \"name\": \"test \",\r\n \"price\": 10\r\n }\r\n ]\r\n },\r\n \"paymentMethod\": \"BANKTRANSFER\",\r\n \"brand_id\": \"90ed108b-6753-465d-8a21-e2cc604ff814 \",\r\n \"success_redirect\": \"https://your.success.redirect.com/getResponse.jsp?success=true\",\r\n \"pending_redirect\": \"https://your.pending.redirect.com/getResponse.jsp?success=true\",\r\n \"failure_redirect\": \"https://your.failure.redirect.com/getResponse.jsp?success=false\",\r\n \"success_callback\": \"https://your.success.callback.com\",\r\n \"failure_callback\": \"https://your.failure.callback.com\",\r\n \"signature\": \"RShYJXst+wi8yPMAi/PSqV4JkJpTrXrl9yRYPUiagrSqBNMXEPndEQD6gnKQYq1syKW7B/s7XmRmnzWnB2QDCBHjtv/ZAg4o5lDmOIPDjVdIgHpZ8EMOvF/O/64D9JaLRViIrjSM/kPiAKbxWsoQtmKumfcly7hwL50iZNUovp3jnzoGtOTWLkbUTDk4xPH1OrAwVUeqkmYFgD9bkQZ/MgSB+p/0ahRskx6jjNlKlG1vujk1dWckgw35CwLJwThx/ZW52kpAp+3GwDaANic0vV3dJOhsqpW8+3G0tIiL4+8FBFAFb31jM6K7CpjuI1lwFZoa4+mQEw+/xLBMiDjPyQ==\"\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

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

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","urlObject":{"path":["purchases",""],"host":["https://api.paysecure.net/api/v1"],"query":[],"variable":[]}},"response":[{"id":"2def4773-73f7-4385-a7a7-5316e950b1ea","name":"Purchase- success","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer Token"}],"body":{"mode":"raw","raw":"{\r\n \"client\": {\r\n \"email\": \"test@gmail.com\",\r\n \"street_address\": \"10 New Burlington Street Apt. 214\",\r\n \"city\": \"London\",\r\n \"full_name\": \"Test test\",\r\n \"zip_code\": \"W1S 3BE\",\r\n \"country\": \"GB\",\r\n \"date_of_birth\": \"1970-07-10\",\r\n \"stateCode\": \"QLD\",\r\n \"phone\": \"+447755564318\"\r\n },\r\n \"purchase\": {\r\n \"currency\": \"USD\",\r\n \"products\": [\r\n {\r\n \"name\": \"test \",\r\n \"price\": 10\r\n }\r\n ]\r\n },\r\n \"paymentMethod\": \"BANKTRANSFER\",\r\n \"brand_id\": \"{{SriTrustScoreTestBrandID}}\",\r\n \"success_redirect\": \"https://test.com/getResponse.jsp?success=true\",\r\n \"pending_redirect\": \"https://test.com/getResponse.jsp?success=pending\",\r\n \"failure_redirect\": \"https://test.com/getResponse.jsp?success=false\",\r\n \"success_callback\": \"https://test1.com\",\r\n \"failure_callback\": \"https://test2.com\",\r\n \"signature\": \"RShYJXst+wi8yPMAi/PSqV4JkJpTrXrl9yRYPUiagrSqBNMXEPndEQD6gnKQYq1syKW7B/s7XmRmnzWnB2QDCBHjtv/ZAg4o5lDmOIPDjVdIgHpZ8EMOvF/O/64D9JaLRViIrjSM/kPiAKbxWsoQtmKumfcly7hwL50iZNUovp3jnzoGtOTWLkbUTDk4xPH1OrAwVUeqkmYFgD9bkQZ/MgSB+p/0ahRskx6jjNlKlG1vujk1dWckgw35CwLJwThx/ZW52kpAp+3GwDaANic0vV3dJOhsqpW8+3G0tIiL4+8FBFAFb31jM6K7CpjuI1lwFZoa4+mQEw+/xLBMiDjPyQ==\"\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\": \"test3@gmail.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\": \"W1S 3BE\",\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\": \"103.59.75.41\",\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\": \"76fad4ea-2ba2-4511-8989-3bed04e7d5bb\",\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://test.com/getResponse.jsp?success=true\",\r\n \"failure_redirect\": \"https://test.com/getResponse.jsp?success=false\",\r\n \"cancel_redirect\": \"\",\r\n \"success_callback\": \"https://test1.com\",\r\n \"failure_callback\": \"https://test2.com\",\r\n \"platform\": \"API\",\r\n \"created_from_ip\": \"103.59.75.41\",\r\n \"checkout_url\": \"https://staging.paysecure.net/payments/66334635a2cf2a7da7b192ab/\"\r\n}"},{"id":"83bc22fc-a420-45ab-be9f-a71d3c268196","name":"Create Purchase","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer Token","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"client\": {\r\n \"email\": \"test@gmail.com\",\r\n \"street_address\": \"10 New Burlington Street Apt. 214\",\r\n \"city\": \"London\",\r\n \"full_name\": \"Test test\",\r\n \"zip_code\": \"W1S 3BE\",\r\n \"country\": \"GB\",\r\n \"date_of_birth\": \"1970-07-10\",\r\n \"stateCode\": \"QLD\",\r\n \"phone\": \"+447755564318\"\r\n },\r\n \"purchase\": {\r\n \"currency\": \"USD\",\r\n \"products\": [\r\n {\r\n \"name\": \"test \",\r\n \"price\": 10\r\n }\r\n ]\r\n },\r\n \"paymentMethod\": \"BANKTRANSFER\",\r\n \"brand_id\": \"{{SriTrustScoreTestBrandID}}\",\r\n \"success_redirect\": \"https://test.com/getResponse.jsp?success=true\",\r\n \"pending_redirect\": \"https://test.com/getResponse.jsp?success=pending\",\r\n \"failure_redirect\": \"https://test.com/getResponse.jsp?success=false\",\r\n \"success_callback\": \"https://test1.com\",\r\n \"failure_callback\": \"https://test2.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":"0385cff7-be68-4b2f-a095-682c0c4978d9"},{"name":"Get Status","id":"46b18c70-c88e-44fe-b0d6-677317783fa4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer Token","type":"text"}],"url":"https://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":"119a92a4-d940-48f5-be4b-543cf6795aa4","name":"Purchases-success","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer Token","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\": \"90ed108b-6753-465d-8a21-e2cc604ff814\",\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\": \"90ed108b-6753-465d-8a21-e2cc604ff814 \",\r\n \"success_redirect\": \"https://test.com/getResponse.jsp?success=true\",\r\n \"failure_redirect\": \"https://test.com/getResponse.jsp?success=false\",\r\n \"success_callback\": \"https://test1.com\",\r\n \"failure_callback\": \"https://test2.com\"\r\n \"cancel_redirect\": \"\",\r\n \"platform\": \"API\",\r\n \"created_from_ip\": \"110.235.229.223\",\r\n \"checkout_url\": \"https://app.paysecure.net/payments/65f95faa70fe897720c40a15/\"\r\n}\r\n"},{"id":"40e1c142-a111-40be-8cf1-2fa1137ef5ce","name":"Purchases","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer Token","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":"46b18c70-c88e-44fe-b0d6-677317783fa4"}],"id":"f611fa06-58bd-4b95-9e51-048afc607cc3","description":"

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

\n","_postman_id":"f611fa06-58bd-4b95-9e51-048afc607cc3"},{"name":"PayOut API","item":[{"name":"Create PayOut","id":"189e3df6-748d-40af-a68c-b1b57b30dc6d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer Token"}],"body":{"mode":"raw","raw":"{\r\n \"client\":\r\n {\r\n \"email\": \"customer141@email.uk\",\r\n \"phone\": \"1234567890\",\r\n \"country\" : \"SG\",\r\n \"zip_code\" : \"123456\",\r\n \"city\" : \"Singapore\",\r\n \"street_address\": \"Random city address\",\r\n \"full_name\": \"Test Person-uk\",\r\n \"stateCode\": \"test\"\r\n },\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\"payoutMethod\" : \"Payout-BANKTRANSFER\",\r\n\"amount\" : 10,\r\n\"currency\" : \"USD\",\r\n\"purpose\" : \"payout to test\",\r\n\"success_callback\": \"https://success.com\",\r\n\"failure_callback\": \"https://failure.com\",\r\n\"signature\": \"iAiYKHaHSt+vH5GwQse3cuaZqW/NReuDJa0jzSM9YKIXjKVdbvOQMzOozwyEGZt85E+NJeLwE9Wn0BeKKYkHnMC3Aq75R9KZPM1gLtyc/pQSQi+x55KRexYS/d2Sw/2XNLZgkIUd47NxJY1niszcs29wrwC6EqJAngijMYkKWmU8w9naDLJzvTBoVhGMQhNBboRu5iIoaDMqiKNZgigkfLln6PEw4Q1CzVrxzdy89GTPuZHyEYsNrTSZSIzZM1LhOC+fyipUp/9R3HnOblRb2rDVWXLYi6X0rIrTe1G3Y79J9jGGOLA9UJGHSF9ln+GLmlOcZb47rhsXYNVYROBL8Q==\"\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\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\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.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
client.zip_code
beneficiaryDetail.bankName
beneficiaryDetail.bankAccountName
beneficiaryDetail.bankAccountCurrency
beneficiaryDetail.bankAccountNumber
beneficiaryDetail.bankCountryCode
beneficiaryDetail.swiftCode	Note: Generally speaking if the merchant currency account and beneficiary’s bank account are in different currencies then SWIFT code is needed. It also depends on the beneficiary currency. For example, it’s mandatory for SDG (even if the merchant’s currency account is SGD) but not for JPY.
beneficiaryDetail.routing_param	See the table below
payoutMethod
Currency	Note this is currency account for which you have balance
Amount
success_redirect	URL to send the user if the transactions is successful
failure_redirect	URL to send the user if the transactions is UNSUCCESSFUL
Purpose

Digital Signature (Optional Parameter) :

To ensure authenticity and non-repudiation of the the pay out request, there is an option to digitally sign the pay out 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 payout request:
Plain text for encryption is the combination of following.
Plaintext= amount+currency+beneficiaryDetail.bankAccountCurrency+beneficiaryDetail.bankAccountNumber+beneficiaryDetail.bankAccountName+ beneficiaryDetail.bankCountryCode

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

Routing 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

Currency code	Routing code 1	Routing Code 2
SGD	bankCode	bankBranchCode
USD	ach	fedwire
AUD	BSB
CAD	transit_number	institution_number
GBP	sort_code
HKD	bankCode	bankBranchCode
JPY	bankCode (Zengin Bank Code)	bankBranchCode (Zengin Branch Code)
NZD	bankCode	bankBranchCode

","urlObject":{"path":["payout",""],"host":["https://api.paysecure.net/api/v1"],"query":[{"disabled":true,"key":"","value":null},{"disabled":true,"key":null,"value":""}],"variable":[]}},"response":[{"id":"ffcfc5cf-996a-4fdb-ae27-9f0f3c67acb9","name":"create payout-success","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"warning":"This is a duplicate header and will be overridden by the Authorization header generated by Postman.","key":"Authorization","value":"Bearer Token","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"client\":\r\n {\r\n \"email\": \"customer141@email.uk\",\r\n \"phone\": \"1234567890\",\r\n \"country\" : \"SG\",\r\n \"zip_code\" : \"123456\",\r\n \"city\" : \"Singapore\",\r\n \"street_address\": \"Random city address\",\r\n \"full_name\": \"Test Person-uk\",\r\n \"stateCode\": \"test\"\r\n },\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\"payoutMethod\" : \"Payout-BANKTRANSFER\",\r\n\"amount\" : 10,\r\n\"currency\" : \"USD\",\r\n\"purpose\" : \"payout to test\",\r\n \"success_callback\": \"https://success.com\",\r\n \"failure_callback\": \"https://failure.com\",\r\n \"signature\": \"iAiYKHaHSt+vH5GwQse3cuaZqW/NReuDJa0jzSM9YKIXjKVdbvOQMzOozwyEGZt85E+NJeLwE9Wn0BeKKYkHnMC3Aq75R9KZPM1gLtyc/pQSQi+x55KRexYS/d2Sw/2XNLZgkIUd47NxJY1niszcs29wrwC6EqJAngijMYkKWmU8w9naDLJzvTBoVhGMQhNBboRu5iIoaDMqiKNZgigkfLln6PEw4Q1CzVrxzdy89GTPuZHyEYsNrTSZSIzZM1LhOC+fyipUp/9R3HnOblRb2rDVWXLYi6X0rIrTe1G3Y79J9jGGOLA9UJGHSF9ln+GLmlOcZb47rhsXYNVYROBL8Q==\"\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\": \"65ffadb4c1c83822903a9205\",\r\n \"client\": {\r\n \"email\": \"customer141@email.uk\",\r\n \"full_name\": \"Test Person-uk\",\r\n \"street_address\": \"Random city address\",\r\n \"country\": \"SG\",\r\n \"city\": \"Singapore\",\r\n \"zip_code\": \"123456\",\r\n \"stateCode\": \"test\"\r\n },\r\n \"updated_on\": 1711254964,\r\n \"payoutMethod\": \"Payout-BANKTRANSFER\",\r\n\t\"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\t\"success_callback\": \"https://success.com\",\r\n \"failure_callback\": \"https://failure.com\"\r\n}\r\n"},{"id":"dfbb9154-4e7e-49a2-97ff-ce5b6af6bc24","name":"create payout-error","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"warning":"This is a duplicate header and will be overridden by the Authorization header generated by Postman.","key":"Authorization","value":"Bearer Token","type":"text"}],"body":{"mode":"raw","raw":"{\r\n\"client\":\r\n {\r\n \"email\": \"customer141@email.uk\",\r\n \t \"phone\": \"1234567890\",\r\n \"country\" : \"SG\",\r\n \"zip_code\" : \"123456\",\r\n \"city\" : \"Singapore\",\r\n \"street_address\": \"Random city address\",\r\n \"full_name\": \"Test Person-uk\",\r\n \"stateCode\": \"test\"\r\n },\r\n \t\t \"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 \t},\r\n \r\n\"payoutMethod\" : \"Payout-BANKTRANSFER\",\r\n\"amount\" : 10,\r\n\"currency\" : \"USD\",\r\n\"purpose\" : \"payout to test\",\r\n\"success_callback\": \"https://success.com\",\r\n\"failure_callback\": \"https://failure.com\"\r\n \r\n\t}\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":"189e3df6-748d-40af-a68c-b1b57b30dc6d"},{"name":"Get Status","id":"1fa9a71a-01ac-4483-b2e0-252d411f2eb3","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://success.com\",

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

\n","urlObject":{"path":["getpayout","{payoutId}",""],"host":["https://api.paysecure.net/api/v1"],"query":[],"variable":[]}},"response":[{"id":"f9ce8348-d6cb-41f4-811f-217123b200d1","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\": \"customer141@email.uk\",\r\n \"full_name\": \"Test Person-uk\",\r\n \"street_address\": \"Random city address\",\r\n \"country\": \"SG\",\r\n \"city\": \"Singapore\",\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://success.com\",\r\n \"failure_callback\": \"https://failure.com\"\r\n}\r\n"},{"id":"fef5a41d-c52a-4fd5-b4de-e37ea47e0529","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":"1fa9a71a-01ac-4483-b2e0-252d411f2eb3"}],"id":"3b791926-3aad-4a17-be19-0606096df926","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.

\n","_postman_id":"3b791926-3aad-4a17-be19-0606096df926"},{"name":"Get Balance API","item":[{"name":"Checking Balance","id":"d6c7086f-656f-434a-9d57-6ff7705c5e3d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"warning":"This is a duplicate header and will be overridden by the Authorization header generated by Postman.","key":"Authorization","value":"Bearer Token","type":"text"}],"body":{"mode":"raw","raw":"{ \r\n \"paymentMethod\" : \"BANKTRANSFER\"\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":"e07a8931-94f1-4cec-947f-cf3075ee1f09","name":"Checking Balance payout-success","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{ \r\n \"paymentMethod\" : \"BANKTRANSFER\"\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\": \"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":"b97a5fb3-784e-401e-817b-0a1940cf73df","name":"Checking Balance payout-error","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{ \r\n \"paymentMethod\" : \"BANKTRANSFER\"\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":"d6c7086f-656f-434a-9d57-6ff7705c5e3d"}],"id":"f4e9f099-d7de-4c40-a96c-a67b3b39e46b","_postman_id":"f4e9f099-d7de-4c40-a96c-a67b3b39e46b","description":""}],"id":"b21d1130-177c-4a80-a359-78d382e0e787","_postman_id":"b21d1130-177c-4a80-a359-78d382e0e787","description":""},{"name":"💳 Card Payments","item":[{"name":"Concepts","item":[],"id":"fffc1aed-985e-4932-8c78-4efb1732e19b","description":"

Custom Payment Flow - Server-to-Server

Paysecure offers Server-to-Server (\"S2S\") integration that enables processing payments on the server level, eliminating direct interaction between the client's browser or application and the API.

This integration allows you to build a setup that restricts payers from directly accessing platform resources.

To enable payment acceptance in your application or website using Server-to-Server (S2S) integration follow the following 3-step routine.

Step 1:

Create a purchase using POST /purchase/ API to create a Purchase in the system. make sure to meet all the required criteria, which includes defining success_redirect and failure_redirect fields for the Purchase and setting them to valid URLs

Step 2:

Send the payment method to the payment URL by making a POST request to /p/{purchaseId}/?s2s=true .

The body of the reques to contain the card details:

{\n    \"cardholder_name\": \"dk\",\n    \"card_number\": \"4444333322221111\",\n    \"expires\": \"10/23\",\n    \"cvc\": \"345\",\n    \"remember_card\": \"on\",\n    \"remote_ip\": \"157.38.242.7\",\n    \"user_agent\": \"Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/51.0.2704.103 Safari/537.36\",\n    \"accept_header\": \"text/html\",\n    \"language\": \"en-US\",\n    \"java_enabled\": false,\n    \"javascript_enabled\": true,\n    \"color_depth\": 24,\n    \"utc_offset\": 0,\n    \"screen_width\": 1920,\n    \"screen_height\": 1080\n}\n\n

see /p/{purchaseId}/?s2s=true API for more details.

Step 3 (for merchants configured for 3D transactions):

Once the response is received, if the purchase is successful (indicated by a response status code of 202), you will be given the \"status\": \"pending\".

{\n    \"status\": \"pending\",\n    \"callback_url\": \"http://18.214.100.20/api/v1/payment/64bfc2a4f63e36669499e5cc/\",\n    \"method\": \"GET\"\n}\n\n

Otherwise you'll get an error as shown below (response status code could be 400,404,401,415,405) :

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

Please see the Status Code section for further details.

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

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

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

\n","_postman_id":"fffc1aed-985e-4932-8c78-4efb1732e19b","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"9ddf6af3-e138-46a9-afcd-894f736f77f3","id":"9ddf6af3-e138-46a9-afcd-894f736f77f3","name":"💳 Card Payments","type":"folder"}}},{"name":"APIs","item":[{"name":"Purchase","id":"48571a78-30fb-4d7a-a80a-d757626168ac","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"client\": {\r\n \"email\": \"example@paysecure.net\",\r\n \"country\": \"IN\",\r\n \"city\": \"123\",\r\n \"stateCode\": \"ca\",\r\n \"street_address\": \"test test\",\r\n \"zip_code\": \"234567\",\r\n \"phone\": \"9999999999\",\r\n \"tax_number\": \"12345678901\"\r\n },\r\n \"purchase\": {\r\n \"products\": [\r\n {\r\n \"name\": \"dk\",\r\n \"price\": \"10\"\r\n }\r\n ]\r\n },\r\n \"status\": \"created\",\r\n \"brand_id\": \"bd69e8a5-adcf-40de-9e43-2b87cb129a5e \",\r\n \"merchantRef\": \"d9db7ec0-f94c-4a9d-8883-54c19c222d81\",\r\n \"send_receipt\": \"\",\r\n \"skip_capture\": \"\",\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

Parameter	Notes
client.email
client.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
client.zip_code
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
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\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.

","urlObject":{"path":["purchases"],"host":["https://api.paysecure.net/api/v1"],"query":[],"variable":[]}},"response":[{"id":"996fbf68-19b7-44d0-a51f-920b29b048f7","name":"Purchase","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text","disabled":true}],"body":{"mode":"raw","raw":"{\r\n \"client\": {\r\n \"email\": \"example@paysecure.net\",\r\n \"country\": \"IN\",\r\n \"city\": \"123\",\r\n \"stateCode\": \"ca\",\r\n \"street_address\": \"test test\",\r\n \"zip_code\": \"234567\",\r\n \"phone\": \"9999999999\"\r\n },\r\n \"purchase\": {\r\n \"currency\": \"USD\",\r\n \"products\": [\r\n {\r\n \"name\": \"product name\",\r\n \"price\": \"10\"\r\n }\r\n ]\r\n },\r\n \"merchantRef\": \"d9db7ec0-f94c-4a9d-8883-54c19c222d81\",\r\n \"status\": \"created\",\r\n \"brand_id\": \"bd69e8a5-adcf-40de-9e43-2b87cb129a5e \",\r\n \"success_redirect\": \"https://your.success.redirect.com\",\r\n \"pending_redirect\": \"https://your.pending.redirect.com\",\r\n \"failure_redirect\": \"https://your.failure.redirect.com\",\r\n \"success_callback\": \"https://your.success.callback.com\",\r\n \"failure_callback\": \"https://your.failure.callback.com\"\r\n}","options":{"raw":{"language":"json"}}},"url":"http://18.214.100.20/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\": \"dev@paysecure.net\",\n \"phone\": \"\",\n \"full_name\": \"\",\n \"date_of_birth\": \"\",\n \"personal_code\": \"\",\n \"street_address\": \"test test\",\n \"country\": \"IN\",\n \"city\": \"123\",\n \"zip_code\": \"234567\",\n \"shipping_street_address\": \"\",\n \"shipping_country\": \"\",\n \"shipping_city\": \"\",\n \"shipping_zip_code\": \"\",\n \"cc\": [],\n \"bcc\": [],\n \"legal_name\": \"\",\n \"brand_name\": \"\",\n \"registration_number\": \"\",\n \"tax_number\": \"\",\n \"stateCode\": \"ca\"\n },\n \"updated_on\": 1689268934,\n \"type\": \"purchase\",\n \"force_recurring\": false,\n \"created_on\": 1689268934,\n \"purchase\": {\n \"currency\": \"USD\",\n \"products\": [\n {\n \"name\": \"dk\",\n \"quantity\": 1,\n \"price\": 10,\n \"discount\": 0,\n \"tax_percent\": \"0.00\"\n }\n ],\n \"total\": 10,\n \"language\": \"en\",\n \"notes\": \"\",\n \"debt\": 0,\n \"total_formatted\": 1,\n \"request_client_details\": [],\n \"timezone\": \"America/Edmonton\",\n \"email_message\": \"\"\n },\n \"issuer_details\": {\n \"website\": \"\",\n \"legal_street_address\": \"\",\n \"legal_country\": \"\",\n \"legal_city\": \"\",\n \"legal_zip_code\": \"\",\n \"bank_accounts\": [\n {\n \"bank_account\": \"\",\n \"bank_code\": \"\"\n }\n ],\n \"legal_name\": \"shoes\",\n \"brand_name\": \"shoes\",\n \"registration_number\": \"\",\n \"tax_number\": \"\"\n },\n \"transaction_data\": {\n \"payment_method\": \"\",\n \"flow\": \"payform\",\n \"extra\": {},\n \"country\": \"\",\n \"attempts\": []\n },\n \"status\": \"CREATED\",\n \"status_history\": [\n {\n \"status\": \"created\",\n \"timestamp\": 1689268934\n }\n ],\n \"is_test\": false,\n \"brand_id\": \"bd69e8a5-adcf-40de-9e43-2b87cb129a5e\",\n \"is_recurring_token\": false,\n \"reference_generated\": \"PS161\",\n \"merchantRef\":\"d9db7ec0-f94c-4a9d-8883-54c19c222d81\",\n \"issued\": \"2023-07-13\",\n \"due\": 1689268934,\n \"refund_upto\": 0,\n \"cc_descriptor\": \"\",\n \"refund_availability\": \"NONE\",\n \"refundable_amount\": 0,\n \"success_redirect\": \"https://your.success.redirect.com\",\n \"failure_redirect\": \"https://your.failure.redirect.com\",\n \"cancel_redirect\": \"\",\n \"success_callback\": \"\",\n \"platform\": \"API\",\n \"created_from_ip\": \"149.86.53.48\",\n \"checkout_url\": \"http://18.214.100.20/payments/64b032c3c6dccf7d329d9e7e/\",\n \"direct_post_url\": \"http://18.214.100.20/api/v1/p/64b032c3c6dccf7d329d9e7e/\"\n}"}],"_postman_id":"48571a78-30fb-4d7a-a80a-d757626168ac"},{"name":"S2S","id":"a7c713a4-66c1-4001-a817-4af0a84f9e1c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"cardholder_name\": \"dk\",\r\n \"card_number\": \"4111111111111111\",\r\n \"expires\": \"10/23\",\r\n \"cvc\": \"345\",\r\n \"remember_card\": \"on\",\r\n \"remote_ip\": \"157.38.242.7\",\r\n \"user_agent\": \"Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/51.0.2704.103 Safari/537.36\",\r\n \"accept_header\": \"text/html\",\r\n \"language\": \"en-US\",\r\n \"java_enabled\": false,\r\n \"javascript_enabled\": true,\r\n \"color_depth\": 24,\r\n \"utc_offset\": 0,\r\n \"screen_width\": 1920,\r\n \"screen_height\": 1080\r\n}","options":{"raw":{"language":"json"}}},"url":"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- 157.38.242.7
user_agent	Full browser and operating system details captured from HTTP header. EX- Chrome/5.0 (X11; Linux x86_64)
accept_header	Browser’s accepted content types (from HTTP header). Used for validating request origin and device info. EX- text/html

Essential parameters in request body:

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

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

Other optional parameters in request body:

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

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

Successful Response

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

{\n    \"status\": \"pending\",\n    \"callback_url\": \"https://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":"9ddf6af3-e138-46a9-afcd-894f736f77f3","id":"9ddf6af3-e138-46a9-afcd-894f736f77f3","name":"💳 Card Payments","type":"folder"}},"urlObject":{"path":["p","64bff4fff63e36669499e9c8",""],"host":["https://api.paysecure.net/api/v1"],"query":[{"key":"s2s","value":"true"}],"variable":[]}},"response":[{"id":"c9cf55f3-80c1-49ba-8b14-aede6699860c","name":"S2S","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"cardholder_name\": \"dk\",\r\n \"card_number\": \"4111111111111111\",\r\n \"expires\": \"10/23\",\r\n \"cvc\": \"345\",\r\n \"remember_card\": \"on\",\r\n \"remote_ip\": \"157.38.242.7\",\r\n \"user_agent\": \"Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/51.0.2704.103 Safari/537.36\",\r\n \"accept_header\": \"text/html\",\r\n \"language\": \"en-US\",\r\n \"java_enabled\": false,\r\n \"javascript_enabled\": true,\r\n \"color_depth\": 24,\r\n \"utc_offset\": 0,\r\n \"screen_width\": 1920,\r\n \"screen_height\": 1080\r\n}\r\n","options":{"raw":{"language":"json"}}},"url":{"raw":"{{StagingBaseURL}}/p/64b034ecc6dccf7d329d9eb3/?s2s=true","host":["{{StagingBaseURL}}"],"path":["p","64b034ecc6dccf7d329d9eb3",""],"query":[{"key":"s2s","value":"true"}]}},"status":"Accepted","code":202,"_postman_previewlanguage":"json","header":[{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"Cache-Control","value":"no-cache, no-store, max-age=0, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Expires","value":"0"},{"key":"X-Frame-Options","value":"DENY"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Date","value":"Thu, 13 Jul 2023 17:31:55 GMT"},{"key":"Keep-Alive","value":"timeout=60"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"pending\",\n \"callback_url\": \"http://18.214.100.20/api/v1/payment/64b034ecc6dccf7d329d9eb3/\",\n \"method\": \"GET\"\n}"}],"_postman_id":"a7c713a4-66c1-4001-a817-4af0a84f9e1c"},{"name":"Payment (To be initiated From client browser)","id":"bf8c8909-71b8-4bc2-938d-74a2752493c4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{Production}}/payment/64bff12bf63e36669499e97d/","description":"

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

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

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

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

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

Mandatory

you need to pass the PurchaseID in the API URL

Possible Value of Status

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

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

Response Examples

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

Error Details

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

Errors

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

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

Please see the Status Code section for further details.

\n","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"9ddf6af3-e138-46a9-afcd-894f736f77f3","id":"9ddf6af3-e138-46a9-afcd-894f736f77f3","name":"💳 Card Payments","type":"folder"}},"urlObject":{"path":["purchases","64bff12bf63e36669499e97d",""],"host":["https://api.paysecure.net/api/v1"],"query":[],"variable":[]}},"response":[{"id":"a0129aa6-54a0-411b-a3ca-aa18095cde4c","name":"Purchases-error","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"url":"http://18.214.100.20/api/v1/purchases/64bfd7c9f63e36669499e779/"},"status":"Accepted","code":202,"_postman_previewlanguage":"json","header":[{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"Cache-Control","value":"no-cache, no-store, max-age=0, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Expires","value":"0"},{"key":"X-Frame-Options","value":"DENY"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Date","value":"Tue, 25 Jul 2023 15:44:06 GMT"},{"key":"Keep-Alive","value":"timeout=60"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\n \"purchaseId\": \"64bfd7c9f63e36669499e779\",\n \"client\": {\n \"bank_account\": \"\",\n \"bank_code\": \"\",\n \"email\": \"example@paysecure.net\",\n \"phone\": \"\",\n \"full_name\": \"\",\n \"date_of_birth\": \"\",\n \"personal_code\": \"\",\n \"street_address\": \"test test\",\n \"country\": \"IN\",\n \"city\": \"123\",\n \"zip_code\": \"234567\",\n \"shipping_street_address\": \"\",\n \"shipping_country\": \"\",\n \"shipping_city\": \"\",\n \"shipping_zip_code\": \"\",\n \"cc\": [],\n \"bcc\": [],\n \"legal_name\": \"\",\n \"brand_name\": \"\",\n \"registration_number\": \"\",\n \"tax_number\": \"\",\n \"stateCode\": \"ca\"\n },\n \"updated_on\": 1690294251,\n \"type\": \"purchase\",\n \"force_recurring\": false,\n \"created_on\": 1690294220,\n \"purchase\": {\n \"currency\": \"USD\",\n \"products\": [\n {\n \"name\": \"dk\",\n \"quantity\": 1,\n \"price\": 100,\n \"discount\": 0,\n \"tax_percent\": \"0.00\"\n }\n ],\n \"total\": 100,\n \"language\": \"en\",\n \"notes\": \"\",\n \"debt\": 0,\n \"total_formatted\": 1,\n \"request_client_details\": [],\n \"timezone\": \"America/Edmonton\",\n \"email_message\": \"\"\n },\n \"issuer_details\": {\n \"website\": \"\",\n \"legal_street_address\": \"\",\n \"legal_country\": \"\",\n \"legal_city\": \"\",\n \"legal_zip_code\": \"\",\n \"bank_accounts\": [\n {\n \"bank_account\": \"\",\n \"bank_code\": \"\"\n }\n ],\n \"legal_name\": \"shoes\",\n \"brand_name\": \"shoes\",\n \"registration_number\": \"\",\n \"tax_number\": \"\"\n },\n \"transaction_data\": {\n \"payment_method\": \"\",\n \"flow\": \"payform\",\n \"extra\": {\n \"expiry_month\": \"10\",\n \"amount\": 100,\n \"card_issuer\": \"1-800-432-3117\",\n \"masked_pan\": \"411111XXXXXX1111\",\n \"card_brand\": \"VISA\",\n \"card_issuer_country\": \"US\",\n \"cardholder_name\": \"dk\",\n \"expiry_year\": \"23\"\n },\n \"country\": \"\",\n \"attempts\": [\n {\n \"client_ip\": \"149.86.53.48\",\n \"type\": \"execute\",\n \"payment_method\": \"VISA\",\n \"flow\": \"payform\",\n \"successful\": false,\n \"country\": \"US\",\n \"processing_time\": 1690294279,\n \"extra\": {\n \"expiry_month\": \"10\",\n \"amount\": 100,\n \"card_issuer\": \"1-800-432-3117\",\n \"masked_pan\": \"411111XXXXXX1111\",\n \"card_brand\": \"VISA\",\n \"card_issuer_country\": \"US\",\n \"cardholder_name\": \"dk\",\n \"expiry_year\": \"23\"\n },\n \"error\": {\n \"message\": \"Transaction Failed\",\n \"code\": \"transaction_error\"\n }\n }\n ]\n },\n \"status\": \"ERROR\",\n \"status_history\": [\n {\n \"status\": \"created\",\n \"timestamp\": 1690294220\n },\n {\n \"status\": \"pending_execute\",\n \"timestamp\": 1690294251\n },\n {\n \"status\": \"error\",\n \"timestamp\": 1690294299\n },\n {\n \"status\": \"viewed\",\n \"timestamp\": 1690294382\n }\n ],\n \"viewedOn\": 1690299845,\n \"is_test\": false,\n \"brand_id\": \"bd69e8a5-adcf-40de-9e43-2b87cb129a5e\",\n \"send_receipt\": false,\n \"is_recurring_token\": false,\n \"skip_capture\": false,\n \"reference_generated\": \"PS188\",\n \"issued\": \"2023-07-25\",\n \"due\": 1690294220,\n \"refund_upto\": 0,\n \"cc_descriptor\": \"\",\n \"refund_availability\": \"NONE\",\n \"refundable_amount\": 0,\n \"success_redirect\": \"https://google.com\",\n \"failure_redirect\": \"https://yahoo.com\",\n \"cancel_redirect\": \"\",\n \"success_callback\": \"\",\n \"platform\": \"API\",\n \"created_from_ip\": \"149.86.53.48\",\n \"checkout_url\": \"http://18.214.100.20/payments/64bfd7c9f63e36669499e779/\",\n \"direct_post_url\": \"http://18.214.100.20/api/v1/p/64bfd7c9f63e36669499e779/\"\n}"},{"id":"1c9a820a-cd64-44f3-afb2-6213c14d9153","name":"Purchases - success","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"url":"http://18.214.100.20/api/v1/purchases/64bfdb7df63e36669499e82f/"},"status":"Accepted","code":202,"_postman_previewlanguage":"json","header":[{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"Cache-Control","value":"no-cache, no-store, max-age=0, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Expires","value":"0"},{"key":"X-Frame-Options","value":"DENY"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Date","value":"Tue, 25 Jul 2023 15:45:29 GMT"},{"key":"Keep-Alive","value":"timeout=60"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\n \"purchaseId\": \"64bfdb7df63e36669499e82f\",\n \"client\": {\n \"bank_account\": \"\",\n \"bank_code\": \"\",\n \"email\": \"example@paysecure.net\",\n \"phone\": \"\",\n \"full_name\": \"\",\n \"date_of_birth\": \"\",\n \"personal_code\": \"\",\n \"street_address\": \"test test\",\n \"country\": \"IN\",\n \"city\": \"123\",\n \"zip_code\": \"234567\",\n \"shipping_street_address\": \"\",\n \"shipping_country\": \"\",\n \"shipping_city\": \"\",\n \"shipping_zip_code\": \"\",\n \"cc\": [],\n \"bcc\": [],\n \"legal_name\": \"\",\n \"brand_name\": \"\",\n \"registration_number\": \"\",\n \"tax_number\": \"\",\n \"stateCode\": \"ca\"\n },\n \"updated_on\": 1690296521,\n \"type\": \"purchase\",\n \"force_recurring\": false,\n \"created_on\": 1690295168,\n \"purchase\": {\n \"currency\": \"USD\",\n \"products\": [\n {\n \"name\": \"dk\",\n \"quantity\": 1,\n \"price\": 9,\n \"discount\": 0,\n \"tax_percent\": \"0.00\"\n }\n ],\n \"total\": 9,\n \"language\": \"en\",\n \"notes\": \"\",\n \"debt\": 0,\n \"total_formatted\": 1,\n \"request_client_details\": [],\n \"timezone\": \"America/Edmonton\",\n \"email_message\": \"\"\n },\n \"payment\": {\n \"is_outgoing\": false,\n \"payment_type\": \"PURCHASE\",\n \"amount\": 9,\n \"currency\": \"USD\",\n \"net_amount\": 9,\n \"fee_amount\": 10.2591,\n \"pending_amount\": 0,\n \"pending_unfreeze_on\": null,\n \"description\": \"\",\n \"paid_on\": 1690295205,\n \"remote_paid_on\": 1690295205\n },\n \"issuer_details\": {\n \"website\": \"\",\n \"legal_street_address\": \"\",\n \"legal_country\": \"\",\n \"legal_city\": \"\",\n \"legal_zip_code\": \"\",\n \"bank_accounts\": [\n {\n \"bank_account\": \"\",\n \"bank_code\": \"\"\n }\n ],\n \"legal_name\": \"shoes\",\n \"brand_name\": \"shoes\",\n \"registration_number\": \"\",\n \"tax_number\": \"\"\n },\n \"transaction_data\": {\n \"payment_method\": \"\",\n \"flow\": \"payform\",\n \"extra\": {\n \"expiry_month\": \"10\",\n \"amount\": 9,\n \"card_issuer\": \"1-800-432-3117\",\n \"masked_pan\": \"411111XXXXXX1111\",\n \"card_brand\": \"VISA\",\n \"card_issuer_country\": \"US\",\n \"cardholder_name\": \"dk\",\n \"expiry_year\": \"23\"\n },\n \"country\": \"\",\n \"attempts\": [\n {\n \"client_ip\": \"149.86.53.48\",\n \"type\": \"execute\",\n \"payment_method\": \"VISA\",\n \"flow\": \"payform\",\n \"successful\": true,\n \"country\": \"US\",\n \"processing_time\": 1690295205,\n \"extra\": {\n \"expiry_month\": \"10\",\n \"amount\": 9,\n \"card_issuer\": \"1-800-432-3117\",\n \"masked_pan\": \"411111XXXXXX1111\",\n \"card_brand\": \"VISA\",\n \"card_issuer_country\": \"US\",\n \"cardholder_name\": \"dk\",\n \"expiry_year\": \"23\"\n }\n }\n ]\n },\n \"status\": \"PAID\",\n \"status_history\": [\n {\n \"status\": \"created\",\n \"timestamp\": 1690295168\n },\n {\n \"status\": \"pending_execute\",\n \"timestamp\": 1690295193\n },\n {\n \"status\": \"payment_in_process\",\n \"timestamp\": 1690295205\n },\n {\n \"status\": \"paid\",\n \"timestamp\": 1690296521\n },\n {\n \"status\": \"viewed\",\n \"timestamp\": 1690299929\n }\n ],\n \"viewedOn\": 1690299929,\n \"is_test\": false,\n \"brand_id\": \"bd69e8a5-adcf-40de-9e43-2b87cb129a5e\",\n \"merchantRef\":\"d9db7ec0-f94c-4a9d-8883-54c19c222d81\",\n \"send_receipt\": false,\n \"is_recurring_token\": false,\n \"skip_capture\": false,\n \"reference_generated\": \"PS192\",\n \"issued\": \"2023-07-25\",\n \"due\": 1690295168,\n \"refund_upto\": 1705843623,\n \"cc_descriptor\": \"test-cardeye\",\n \"refund_availability\": \"NONE\",\n \"refundable_amount\": 9,\n \"success_redirect\": \"https://google.com\",\n \"failure_redirect\": \"https://yahoo.com\",\n \"cancel_redirect\": \"\",\n \"success_callback\": \"\",\n \"platform\": \"API\",\n \"created_from_ip\": \"149.86.53.48\",\n \"checkout_url\": \"http://18.214.100.20/payments/64bfdb7df63e36669499e82f/\",\n \"direct_post_url\": \"http://18.214.100.20/api/v1/p/64bfdb7df63e36669499e82f/\"\n}"}],"_postman_id":"1db93e94-588d-4e2d-a632-6eea9c46ce1b"},{"name":"cancel","id":"9100dffc-f490-43b2-b585-5783f3151a70","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"url":"https://api.paysecure.net/api/v1/purchases/64bff556f63e36669499e9d3/cancel","description":"

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

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

Purchase ID is mandatory for this API.

Response Examples

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

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

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

Purchase ID is mandatory for this API.

Response Examples

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

\n","urlObject":{"path":["purchases","657af976c3fceb7beb30eeb4","refund"],"host":["https://api.paysecure.net/api/v1"],"query":[],"variable":[]}},"response":[{"id":"de474adf-8842-418e-ad44-d234dc6e02ea","name":"Refund - Error","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"url":"{{StagingBaseURL}}/purchases/64b034ecc6dccf7d329d9eb3/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}"},{"id":"5a012aa4-737d-41dd-867f-10799db0b64a","name":"Refund - Success","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"url":"{{StagingBaseURL}}/purchases/64bfdb7df63e36669499e82f/refund"},"status":"Accepted","code":202,"_postman_previewlanguage":"json","header":[{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"Cache-Control","value":"no-cache, no-store, max-age=0, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Expires","value":"0"},{"key":"X-Frame-Options","value":"DENY"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Date","value":"Tue, 25 Jul 2023 16:33:43 GMT"},{"key":"Keep-Alive","value":"timeout=60"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\n \"purchaseId\": \"64bfdb7df63e36669499e82f\",\n \"client\": {\n \"bank_account\": \"\",\n \"bank_code\": \"\",\n \"email\": \"example@paysecure.net\",\n \"phone\": \"\",\n \"full_name\": \"\",\n \"date_of_birth\": \"\",\n \"personal_code\": \"\",\n \"street_address\": \"test test\",\n \"country\": \"IN\",\n \"city\": \"123\",\n \"zip_code\": \"234567\",\n \"shipping_street_address\": \"\",\n \"shipping_country\": \"\",\n \"shipping_city\": \"\",\n \"shipping_zip_code\": \"\",\n \"cc\": [],\n \"bcc\": [],\n \"legal_name\": \"\",\n \"brand_name\": \"\",\n \"registration_number\": \"\",\n \"tax_number\": \"\",\n \"stateCode\": \"ca\"\n },\n \"updated_on\": 1690302819,\n \"type\": \"purchase\",\n \"force_recurring\": false,\n \"created_on\": 1690295168,\n \"purchase\": {\n \"currency\": \"USD\",\n \"products\": [\n {\n \"name\": \"dk\",\n \"quantity\": 1,\n \"price\": 9,\n \"discount\": 0,\n \"tax_percent\": \"0.00\"\n }\n ],\n \"total\": 9,\n \"language\": \"en\",\n \"notes\": \"\",\n \"debt\": 0,\n \"total_formatted\": 1,\n \"request_client_details\": [],\n \"timezone\": \"America/Edmonton\",\n \"email_message\": \"\"\n },\n \"payment\": {\n \"is_outgoing\": false,\n \"payment_type\": \"PURCHASE\",\n \"amount\": 9,\n \"currency\": \"USD\",\n \"net_amount\": 9,\n \"fee_amount\": 10.2591,\n \"pending_amount\": 0,\n \"pending_unfreeze_on\": null,\n \"description\": \"\",\n \"paid_on\": 1690295205,\n \"remote_paid_on\": 1690295205\n },\n \"issuer_details\": {\n \"website\": \"\",\n \"legal_street_address\": \"\",\n \"legal_country\": \"\",\n \"legal_city\": \"\",\n \"legal_zip_code\": \"\",\n \"bank_accounts\": [\n {\n \"bank_account\": \"\",\n \"bank_code\": \"\"\n }\n ],\n \"legal_name\": \"shoes\",\n \"brand_name\": \"shoes\",\n \"registration_number\": \"\",\n \"tax_number\": \"\"\n },\n \"transaction_data\": {\n \"payment_method\": \"\",\n \"flow\": \"payform\",\n \"extra\": {\n \"expiry_month\": \"10\",\n \"amount\": 9,\n \"card_issuer\": \"1-800-432-3117\",\n \"masked_pan\": \"411111XXXXXX1111\",\n \"card_brand\": \"VISA\",\n \"card_issuer_country\": \"US\",\n \"cardholder_name\": \"dk\",\n \"expiry_year\": \"23\"\n },\n \"country\": \"\",\n \"attempts\": [\n {\n \"client_ip\": \"149.86.53.48\",\n \"type\": \"execute\",\n \"payment_method\": \"VISA\",\n \"flow\": \"payform\",\n \"successful\": true,\n \"country\": \"US\",\n \"processing_time\": 1690295205,\n \"extra\": {\n \"expiry_month\": \"10\",\n \"amount\": 9,\n \"card_issuer\": \"1-800-432-3117\",\n \"masked_pan\": \"411111XXXXXX1111\",\n \"card_brand\": \"VISA\",\n \"card_issuer_country\": \"US\",\n \"cardholder_name\": \"dk\",\n \"expiry_year\": \"23\"\n }\n },\n {\n \"client_ip\": \"149.86.53.48\",\n \"type\": \"refund\",\n \"successful\": true,\n \"processing_time\": 1690302819,\n \"extra\": {\n \"amount\": 9\n }\n }\n ]\n },\n \"status\": \"REFUND_IN_PROCESS\",\n \"status_history\": [\n {\n \"status\": \"created\",\n \"timestamp\": 1690295168\n },\n {\n \"status\": \"pending_execute\",\n \"timestamp\": 1690295193\n },\n {\n \"status\": \"payment_in_process\",\n \"timestamp\": 1690295205\n },\n {\n \"status\": \"paid\",\n \"timestamp\": 1690296521\n },\n {\n \"status\": \"viewed\",\n \"timestamp\": 1690299929\n },\n {\n \"status\": \"refund_in_process\",\n \"timestamp\": 1690302819\n }\n ],\n \"viewedOn\": 1690299929,\n \"is_test\": false,\n \"brand_id\": \"bd69e8a5-adcf-40de-9e43-2b87cb129a5e\",\n \"send_receipt\": false,\n \"is_recurring_token\": false,\n \"skip_capture\": false,\n \"reference_generated\": \"PS192\",\n \"issued\": \"2023-07-25\",\n \"due\": 1690295168,\n \"refund_upto\": 1705843623,\n \"cc_descriptor\": \"test-cardeye\",\n \"refund_availability\": \"NONE\",\n \"refundable_amount\": 0,\n \"success_redirect\": \"https://google.com\",\n \"failure_redirect\": \"https://yahoo.com\",\n \"cancel_redirect\": \"\",\n \"success_callback\": \"\",\n \"platform\": \"API\",\n \"created_from_ip\": \"149.86.53.48\",\n \"checkout_url\": \"http://18.214.100.20/payments/64bfdb7df63e36669499e82f/\",\n \"direct_post_url\": \"http://18.214.100.20/api/v1/p/64bfdb7df63e36669499e82f/\"\n}"}],"_postman_id":"2dbf92d5-d4e7-45a2-9087-77380c5fa832"},{"name":"Payment Methods","id":"91c8eadc-fa2e-4f05-9890-dd23ad505b51","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"url":"https://api.paysecure.net/api/v1/payment_methods","description":"

This API gives back the list of Payment methods available .

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

\n","urlObject":{"protocol":"https","path":["api","v1","whitelist","upload",""],"host":["api","paysecure","net"],"query":[],"variable":[]}},"response":[{"id":"4d943f43-c152-4442-b77f-4b1a3c210019","name":"Whitelist Upload success","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"multipart/form-data; boundary=","disabled":true}],"body":{"mode":"formdata","formdata":[{"key":"csvFile","type":"file","fileNotInWorkingDirectoryWarning":"This file isn't in your working directory. Teammates you share this request with won't be able to use this file. To make collaboration easier you can setup your working directory in Settings.","filesNotInWorkingDirectory":["/C:/Users/HP/Desktop/Important/upladingfile/merchantwhitlist.csv"],"value":null}]},"url":"https://api.paysecure.net/api/v1/whitelist/upload/"},"status":"Accepted","code":202,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Fri, 14 Jun 2024 09:10:47 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"Cache-Control","value":"no-cache, no-store, max-age=0, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Expires","value":"0"},{"key":"Strict-Transport-Security","value":"max-age=31536000 ; includeSubDomains"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"Referrer-Policy","value":"no-referrer"},{"key":"CF-Cache-Status","value":"DYNAMIC"},{"key":"Report-To","value":"{\"endpoints\":[{\"url\":\"https:\\/\\/a.nel.cloudflare.com\\/report\\/v4?s=bIgUFhs3TU2505qZe4IpSLiaJtI2gsplNDvsVWdKl76AWQdcisezEHOW6t%2BxTCj%2Bxs%2B23gnSeMCWrqwG0CYQONFHXhXb9ZHNtIYMuHWzvjLhVEChIX%2BYpODoLqzs9OP4r5q%2F9ABSXBs%3D\"}],\"group\":\"cf-nel\",\"max_age\":604800}"},{"key":"NEL","value":"{\"success_fraction\":0,\"report_to\":\"cf-nel\",\"max_age\":604800}"},{"key":"Server","value":"cloudflare"},{"key":"CF-RAY","value":"893930730b8b0c3f-MRS"},{"key":"alt-svc","value":"h3=\":443\"; ma=86400"}],"cookie":[],"responseTime":null,"body":"{\n \"totalRecords\": 3,\n \"totalApproved\": 3,\n \"status\": \"success\"\n}"},{"id":"14a08b58-7d8c-4d86-8a1b-7ebb447f0e86","name":"Whitelist Upload failure","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"multipart/form-data; boundary=","disabled":true}],"body":{"mode":"formdata","formdata":[{"key":"csvFile","type":"file","fileNotInWorkingDirectoryWarning":"This file isn't in your working directory. Teammates you share this request with won't be able to use this file. To make collaboration easier you can setup your working directory in Settings.","filesNotInWorkingDirectory":["/C:/Users/HP/Desktop/Important/upladingfile/merchantwhitlist.csv"],"value":null}]},"url":"https://api.paysecure.net/api/v1/whitelist/upload/"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Fri, 14 Jun 2024 09:11:50 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"Cache-Control","value":"no-cache, no-store, max-age=0, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Expires","value":"0"},{"key":"Strict-Transport-Security","value":"max-age=31536000 ; includeSubDomains"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"Referrer-Policy","value":"no-referrer"},{"key":"CF-Cache-Status","value":"DYNAMIC"},{"key":"Report-To","value":"{\"endpoints\":[{\"url\":\"https:\\/\\/a.nel.cloudflare.com\\/report\\/v4?s=9tel4sXa6ymyhRDTyNC%2B%2Bg2Msz1MivhgHbawlLF7JvTAgfonvRaas8MQeMtVVK95cziZLoZUKaThXJOAAeZW6iZ6fqlK5flpZjGxKwInEyKzZJr9JLDSQbNt5Um%2BK4zdbMZfkHV2seg%3D\"}],\"group\":\"cf-nel\",\"max_age\":604800}"},{"key":"NEL","value":"{\"success_fraction\":0,\"report_to\":\"cf-nel\",\"max_age\":604800}"},{"key":"Server","value":"cloudflare"},{"key":"CF-RAY","value":"893931f998280c3f-MRS"},{"key":"alt-svc","value":"h3=\":443\"; ma=86400"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Authorization header missing\",\n \"code\": \"authentication_failed\",\n \"status\": \"fail\"\n}"}],"_postman_id":"b9c04f19-6885-48c3-8ff4-ceb630b8eec7"}],"id":"2f41be5f-e55e-4e37-8fa7-d762b88b573d","_postman_id":"2f41be5f-e55e-4e37-8fa7-d762b88b573d","description":"","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"9ddf6af3-e138-46a9-afcd-894f736f77f3","id":"9ddf6af3-e138-46a9-afcd-894f736f77f3","name":"💳 Card Payments","type":"folder"}}}],"id":"9ddf6af3-e138-46a9-afcd-894f736f77f3","auth":{"type":"noauth","isInherited":false},"event":[{"listen":"prerequest","script":{"type":"text/javascript","packages":{},"exec":[""],"id":"e8a74862-a410-4357-bcf9-5b53a60615f9"}},{"listen":"test","script":{"type":"text/javascript","packages":{},"exec":[""],"id":"69a2cb71-17fd-494c-a773-449c5d656c88"}}],"_postman_id":"9ddf6af3-e138-46a9-afcd-894f736f77f3","description":""},{"name":"🌐 Open Banking","item":[{"name":"Concepts","item":[],"id":"b512f884-2ad4-4c5a-abbf-d694ce44548b","description":"

Step 1:

Create a purchase using POST /purchase/ API to create a Purchase in the system. make sure to meet all the required criteria, which include defining success_redirect, pending_redirect and failure_redirect fields for the Purchase and setting them to valid URLs.

Step 2:

The customer is redirected to the checkout_url page, configured to point to their net banking system.

Step 3:

Once the payment is initiated from the net banking site, the user will be redirected to the appropriate redirect URL.

\n","_postman_id":"b512f884-2ad4-4c5a-abbf-d694ce44548b","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"d6b7f281-5d52-4c2f-87c1-e39cd8e5b1cf","id":"d6b7f281-5d52-4c2f-87c1-e39cd8e5b1cf","name":"🌐 Open Banking","type":"folder"}}},{"name":"Secure EFT - South Africa 🇿🇦","item":[],"id":"c5bee11a-c809-412b-9fe9-d3be7a01e7a6","description":"

Overview

EFT (Electronic Funds Transfer) is a secure and efficient method of processing online payments in South Africa. It allows customers to make instant payments directly from their bank accounts without using a credit card. EFT leverages the existing online banking infrastructure to facilitate quick and secure transactions, making it a popular choice for consumers and merchants.

Key Features of EFT

Instant Payment Confirmation: Transactions are processed and confirmed immediately, allowing for real-time payment updates.
\n
Secure Transactions: Uses bank-level security measures to ensure the safety of customer data.
\n
Broad Bank Support: It supports many South African banks, ensuring broad accessibility.
\n
User-Friendly: The payment process is simple and intuitive, providing a seamless experience for users.
\n

Payment Processing Steps Through EFT

Step 1: Initiating the Payment

Customer Selects 'NETBANKING' Payment Option: At the checkout page, the customer selects 'NETBANKING' as their preferred payment method.
\n
Merchant Redirects to EFT Gateway: The merchant's website or application redirects the customer to the EFT payment gateway.
\n

Step 2: Redirect to Bank Login

Customer Selects Their Bank: The customer selects their bank from the list of supported banks on the EFT gateway.
\n
Customer is Redirected to Bank Login Page: Platform securely redirects customers to their bank’s online banking login page.
\n

Step 3: Logging into Online Banking

Customer Logs In The customer logs into their online banking account using their credentials.
\n
Secure Session: The login session is safe, and the customer’s banking credentials are not shared with the EFT gateway or the merchant.
\n

Step 4: Confirming the Payment

Payment Details: The customer reviews the pre-filled payment details, including the amount and beneficiary information.
\n
Authorise Payment: The customer authorises the payment using their bank’s authentication method (e.g., OTP, password).
\n

Step 5: Payment Processing and Confirmation

Bank Processes Payment: The customer’s bank processes the payment and debits the amount from the customer’s account.
\n
Instant Confirmation to the EFT gateway: Once the payment is processed, the bank sends an instant confirmation to the EFT gateway.
\n

Step 6: Notification to Merchant

EFT Gateway Confirms Payment to Merchant: EFT gateway immediately notifies the merchant of the successful payment.
\n
Order Completion: The merchant completes and confirms the order to the customer.
\n

Step 7: Customer Redirect

Redirect to Merchant’s Site: After confirming the payment, the customer is redirected back to the merchant’s website.
\n
Payment Confirmation Page: The merchant’s website displays a payment confirmation page to the customer.
\n

\n","_postman_id":"c5bee11a-c809-412b-9fe9-d3be7a01e7a6","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"d6b7f281-5d52-4c2f-87c1-e39cd8e5b1cf","id":"d6b7f281-5d52-4c2f-87c1-e39cd8e5b1cf","name":"🌐 Open Banking","type":"folder"}}},{"name":"OpenBanking - EUR 🇪🇺 & UK 🇬🇧","item":[],"id":"a2da2cf8-70bd-4394-90bc-9afa8118cf5d","description":"

Paysecure leverages its OpenBanking network across Europe and UK to make secure and fast payments, making top choice for customers in respective regions. It allows customers to pay in EUR or GBP via Paysecure Gateway, directly through their bank account.

Paysecure Gateway is a web page that handles all the user interaction during a payment initiation process:

user credentials input
\n
interactive confirmation
\n
progress reporting
\n
error reporting
\n

After your application has received an URL for executing a payment using Paysecure, you can redirect your end-user to it. There, they will see a screen that lets them pick a provider to execute a payment.

Your user will also be asked to input credentials and, if needed, any of the interactive credentials. After the process is done, the user will be redirected back to your application URL

PayIn User Flow

Step 1: Initiating the Payment

Customer Selects 'NETBANKING' Payment Option: At the checkout page, the customer selects 'NETBANKING' as their preferred payment method.

Step 2: Redirect to Bank Login

Customer Selects Their Bank: The customer selects the provider/bank from the list of supported providers/banks on the Paysecure Gateway.
\n
Customer is Redirected to Bank Login Page: Platform securely redirects customers to their bank’s online banking login page.
\n

Step 3: Logging into Online Banking

Customer Logs In The customer logs into their online banking account using their credentials.
\n
Secure Session: The login session is safe, and the customer’s banking credentials are not shared with any third party or any merchant.
\n

Step 4: Confirming the Payment

Payment Details: The customer reviews the pre-filled payment details, including the amount and beneficiary information.
\n
Authorise Payment: The customer authorises the payment using their bank’s authentication method (e.g., OTP, password).
\n

Step 5: Payment Processing and Confirmation

Bank Processes Payment: The customer’s bank processes the payment and debits the amount from the customer’s account.
\n
Instant Confirmation to the Paysecure gateway: Once the payment is processed, payment confirmation is received through a webhook url.
\n

Step 6: Notification to Merchant

Paysecure Confirms Payment to Merchant: Paysecure gateway immediately notifies the merchant of the successful payment.
\n
Order Completion: The merchant completes and confirms the order to the customer.
\n

Step 7: Customer Redirect

Redirect to Merchant’s Site: After confirming the payment, the customer is redirected back to the merchant’s website.
\n
Payment Confirmation Page: The merchant’s website displays a payment confirmation page to the customer.
\n

\n","_postman_id":"a2da2cf8-70bd-4394-90bc-9afa8118cf5d","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"d6b7f281-5d52-4c2f-87c1-e39cd8e5b1cf","id":"d6b7f281-5d52-4c2f-87c1-e39cd8e5b1cf","name":"🌐 Open Banking","type":"folder"}}},{"name":"APIs","item":[{"name":"Purchase","id":"87e5fc15-8f86-4015-b4e5-7458814e729d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"client\": {\r\n \"email\": \"example@paysecure.net\",\r\n \"country\":\"IN\",\r\n \"city\":\"123\",\r\n \"stateCode\":\"ca\",\r\n \"street_address\":\"test test\",\r\n \"zip_code\":\"234567\",\r\n \"phone\":\"9999999999\"\r\n \r\n },\r\n \"purchase\": {\r\n \"currency\" : \"EUR\",\r\n \"products\": [\r\n {\r\n \"name\": \"dk\",\r\n \"price\": \"10\"\r\n }\r\n ]\r\n },\r\n \"paymentMethod\": \"NETBANKING\",\r\n \"brand_id\": \"{{Your.brandID}}\",\r\n \"merchantRef\": \"d9db7ec0-f94c-4a9d-8883-54c19c222d81\",\r\n \"send_receipt\": \"\" ,\r\n \"skip_capture\": \"\" ,\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

Parameter	Notes
client.email
client.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
client.zip_code
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
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\" .

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

","urlObject":{"path":["purchases"],"host":["https://api.paysecure.net/api/v1"],"query":[],"variable":[]}},"response":[{"id":"05f235ca-ae71-4de7-8d71-3d79d4a5d9b0","name":"Open Banking EU & UK","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer Token","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"client\": {\r\n \"email\": \"alpha7.bravo@bravapay.com\",\r\n \"country\": \"GB\",\r\n \"city\": \"London\",\r\n \"stateCode\": \"LND\",\r\n \"street_address\": \"10 New Burlington StreetApt. 214\",\r\n \"zip_code\": \"SW1A0AA\",\r\n \"full_name\": \"shiba sharma\",\r\n \"date_of_birth\": \"2004-04-31\",\r\n \"phone\": \"+447755564318\",\r\n \"gender\": \"male\"\r\n },\r\n \"purchase\": {\r\n \"currency\": \"GBP\",\r\n \"products\": [\r\n {\r\n \"name\": \"e-commerce\",\r\n \"price\": \"10\"\r\n },\r\n {\r\n \"name\": \"retail\",\r\n \"price\": \"11\"\r\n }\r\n ],\r\n \"total\": 21\r\n },\r\n \"paymentMethod\": \"NETBANKING\",\r\n \"brand_id\": \"{{Your.brandID}}\",\r\n \"merchantRef\": \"\",\r\n \"send_receipt\": \"\" ,\r\n \"skip_capture\": \"\" ,\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\": \"68c3a4a031ee334ef2c02b2a\",\n \"client\": {\n \"customerId\": \"NA\",\n \"email\": \"alpha7.bravo@bravapay.com\",\n \"date_of_birth\": \"2004-04-31\",\n \"street_address\": \"10 New Burlington StreetApt. 214\",\n \"country\": \"GB\",\n \"city\": \"London\",\n \"zip_code\": \"SW1A0AA\",\n \"full_name\": \"shiba sharma\",\n \"phone\": \"+447755564318\",\n \"gender\": \"male\",\n \"stateCode\": \"LND\"\n },\n \"updated_on\": 1757652134,\n \"type\": \"purchase\",\n \"paymentMethod\": \"NETBANKING\",\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.0,\n \"price\": 10.0,\n \"discount\": 0,\n \"tax_percent\": \"0.00\"\n },\n {\n \"name\": \"retail\",\n \"quantity\": 1.0,\n \"price\": 11.0,\n \"discount\": 0,\n \"tax_percent\": \"0.00\"\n }\n ],\n \"total\": 21.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\": 21.0,\n \"currency\": \"INR\",\n \"net_amount\": 21.0,\n \"fee_amount\": 0.0,\n \"pending_amount\": 0.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\": \"\",\n \"flow\": \"payform\",\n \"extra\": {\n \"amount\": 100.0,\n \"masked_pan\": \"NETBANKING\"\n },\n \"country\": \"\",\n \"attempts\": [\n {\n \"client_ip\": \"183.83.55.235, 162.158.91.128, 18.68.47.183\",\n \"type\": \"execute\",\n \"payment_method\": \"NETBANKING\",\n \"flow\": \"payform\",\n \"successful\": true,\n \"country\": \"NETBANKING\",\n \"processing_time\": 1757652129,\n \"extra\": {\n \"amount\": 100.0,\n \"masked_pan\": \"NETBANKING\"\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\": \"59c5ed48-caf9-464a-ba54-26e1e02bc1bc\",\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.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 \"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\": \"183.83.55.235, 162.158.91.128, 18.68.47.183\",\n \"checkout_url\": \"https://api.choicepay.ca/payments/63cddfa1a4948aba8e8ee9f319e3428f/\",\n \"payoutProcess\": false\n}"},{"id":"7a039a16-ec58-436f-a2aa-b896887391dd","name":"Open Banking SA","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer Token","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"client\": {\r\n \"email\": \"alpha7.bravo@bravapay.com\",\r\n \"country\": \"GB\",\r\n \"city\": \"London\",\r\n \"stateCode\": \"LND\",\r\n \"street_address\": \"10 New Burlington StreetApt. 214\",\r\n \"zip_code\": \"SW1A0AA\",\r\n \"full_name\": \"shiba sharma\",\r\n \"date_of_birth\": \"2004-04-31\",\r\n \"phone\": \"+447755564318\",\r\n \"gender\": \"male\"\r\n },\r\n \"purchase\": {\r\n \"currency\": \"ZAR\",\r\n \"products\": [\r\n {\r\n \"name\": \"e-commerce\",\r\n \"price\": \"10\"\r\n },\r\n {\r\n \"name\": \"retail\",\r\n \"price\": \"11\"\r\n }\r\n ],\r\n \"total\": 21\r\n },\r\n \"paymentMethod\": \"NETBANKING\",\r\n \"brand_id\": \"{{Your.brandID}}\",\r\n \"merchantRef\": \"\",\r\n \"send_receipt\": \"\" ,\r\n \"skip_capture\": \"\" ,\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":null,"header":null,"cookie":[],"responseTime":null,"body":"{\n \"purchaseId\": \"68c3a4a031ee334ef2c02b2a\",\n \"client\": {\n \"customerId\": \"NA\",\n \"email\": \"alpha7.bravo@bravapay.com\",\n \"date_of_birth\": \"2004-04-31\",\n \"street_address\": \"10 New Burlington StreetApt. 214\",\n \"country\": \"GB\",\n \"city\": \"London\",\n \"zip_code\": \"SW1A0AA\",\n \"full_name\": \"shiba sharma\",\n \"phone\": \"+447755564318\",\n \"gender\": \"male\",\n \"stateCode\": \"LND\"\n },\n \"updated_on\": 1757652134,\n \"type\": \"purchase\",\n \"paymentMethod\": \"NETBANKING\",\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\": \"ZAR\",\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 \"name\": \"retail\",\n \"quantity\": 1.0,\n \"price\": 11.0,\n \"discount\": 0,\n \"tax_percent\": \"0.00\"\n }\n ],\n \"total\": 21.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\": 21.0,\n \"currency\": \"INR\",\n \"net_amount\": 21.0,\n \"fee_amount\": 0.0,\n \"pending_amount\": 0.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\": \"\",\n \"flow\": \"payform\",\n \"extra\": {\n \"amount\": 100.0,\n \"masked_pan\": \"NETBANKING\"\n },\n \"country\": \"\",\n \"attempts\": [\n {\n \"client_ip\": \"183.83.55.235, 162.158.91.128, 18.68.47.183\",\n \"type\": \"execute\",\n \"payment_method\": \"NETBANKING\",\n \"flow\": \"payform\",\n \"successful\": true,\n \"country\": \"NETBANKING\",\n \"processing_time\": 1757652129,\n \"extra\": {\n \"amount\": 100.0,\n \"masked_pan\": \"NETBANKING\"\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\": \"59c5ed48-caf9-464a-ba54-26e1e02bc1bc\",\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.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 \"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\": \"183.83.55.235, 162.158.91.128, 18.68.47.183\",\n \"checkout_url\": \"https://api.choicepay.ca/payments/63cddfa1a4948aba8e8ee9f319e3428f/\",\n \"payoutProcess\": false\n}"}],"_postman_id":"87e5fc15-8f86-4015-b4e5-7458814e729d"},{"name":"Get Status","id":"6b336c51-3582-4ba5-9da9-466d7e1dcf9a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer Token","type":"text"}],"url":"https://api.paysecure.net/api/v1/purchases/64bff12bf63e36669499e97d/","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\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":"d6b7f281-5d52-4c2f-87c1-e39cd8e5b1cf","id":"d6b7f281-5d52-4c2f-87c1-e39cd8e5b1cf","name":"🌐 Open Banking","type":"folder"}},"urlObject":{"path":["purchases","64bff12bf63e36669499e97d",""],"host":["https://api.paysecure.net/api/v1"],"query":[],"variable":[]}},"response":[{"id":"f0481a44-d598-4158-a0b1-508efee8218c","name":"Purchases-error","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"url":"https://api.paysecure.net/api/v1/purchases/64bfd7c9f63e36669499e779/"},"status":"Accepted","code":202,"_postman_previewlanguage":"json","header":[{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"Cache-Control","value":"no-cache, no-store, max-age=0, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Expires","value":"0"},{"key":"X-Frame-Options","value":"DENY"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Date","value":"Tue, 25 Jul 2023 15:44:06 GMT"},{"key":"Keep-Alive","value":"timeout=60"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\n \"purchaseId\": \"64bfd7c9f63e36669499e779\",\n \"client\": {\n \"bank_account\": \"\",\n \"bank_code\": \"\",\n \"email\": \"example@paysecure.net\",\n \"phone\": \"\",\n \"full_name\": \"\",\n \"date_of_birth\": \"\",\n \"personal_code\": \"\",\n \"street_address\": \"test test\",\n \"country\": \"IN\",\n \"city\": \"123\",\n \"zip_code\": \"234567\",\n \"shipping_street_address\": \"\",\n \"shipping_country\": \"\",\n \"shipping_city\": \"\",\n \"shipping_zip_code\": \"\",\n \"cc\": [],\n \"bcc\": [],\n \"legal_name\": \"\",\n \"brand_name\": \"\",\n \"registration_number\": \"\",\n \"tax_number\": \"\",\n \"stateCode\": \"ca\"\n },\n \"updated_on\": 1690294251,\n \"type\": \"purchase\",\n \"force_recurring\": false,\n \"created_on\": 1690294220,\n \"purchase\": {\n \"currency\": \"USD\",\n \"products\": [\n {\n \"name\": \"dk\",\n \"quantity\": 1,\n \"price\": 100,\n \"discount\": 0,\n \"tax_percent\": \"0.00\"\n }\n ],\n \"total\": 100,\n \"language\": \"en\",\n \"notes\": \"\",\n \"debt\": 0,\n \"total_formatted\": 1,\n \"request_client_details\": [],\n \"timezone\": \"America/Edmonton\",\n \"email_message\": \"\"\n },\n \"issuer_details\": {\n \"website\": \"\",\n \"legal_street_address\": \"\",\n \"legal_country\": \"\",\n \"legal_city\": \"\",\n \"legal_zip_code\": \"\",\n \"bank_accounts\": [\n {\n \"bank_account\": \"\",\n \"bank_code\": \"\"\n }\n ],\n \"legal_name\": \"shoes\",\n \"brand_name\": \"shoes\",\n \"registration_number\": \"\",\n \"tax_number\": \"\"\n },\n \"transaction_data\": {\n \"payment_method\": \"\",\n \"flow\": \"payform\",\n \"extra\": {\n \"expiry_month\": \"10\",\n \"amount\": 100,\n \"card_issuer\": \"1-800-432-3117\",\n \"masked_pan\": \"411111XXXXXX1111\",\n \"card_brand\": \"VISA\",\n \"card_issuer_country\": \"US\",\n \"cardholder_name\": \"dk\",\n \"expiry_year\": \"23\"\n },\n \"country\": \"\",\n \"attempts\": [\n {\n \"client_ip\": \"149.86.53.48\",\n \"type\": \"execute\",\n \"payment_method\": \"VISA\",\n \"flow\": \"payform\",\n \"successful\": false,\n \"country\": \"US\",\n \"processing_time\": 1690294279,\n \"extra\": {\n \"expiry_month\": \"10\",\n \"amount\": 100,\n \"card_issuer\": \"1-800-432-3117\",\n \"masked_pan\": \"411111XXXXXX1111\",\n \"card_brand\": \"VISA\",\n \"card_issuer_country\": \"US\",\n \"cardholder_name\": \"dk\",\n \"expiry_year\": \"23\"\n },\n \"error\": {\n \"message\": \"Transaction Failed\",\n \"code\": \"transaction_error\"\n }\n }\n ]\n },\n \"status\": \"ERROR\",\n \"status_history\": [\n {\n \"status\": \"created\",\n \"timestamp\": 1690294220\n },\n {\n \"status\": \"pending_execute\",\n \"timestamp\": 1690294251\n },\n {\n \"status\": \"error\",\n \"timestamp\": 1690294299\n },\n {\n \"status\": \"viewed\",\n \"timestamp\": 1690294382\n }\n ],\n \"viewedOn\": 1690299845,\n \"is_test\": false,\n \"brand_id\": \"bd69e8a5-adcf-40de-9e43-2b87cb129a5e\",\n \"send_receipt\": false,\n \"is_recurring_token\": false,\n \"skip_capture\": false,\n \"reference_generated\": \"PS188\",\n \"issued\": \"2023-07-25\",\n \"due\": 1690294220,\n \"refund_upto\": 0,\n \"cc_descriptor\": \"\",\n \"refund_availability\": \"NONE\",\n \"refundable_amount\": 0,\n \"success_redirect\": \"https://google.com\",\n \"failure_redirect\": \"https://yahoo.com\",\n \"cancel_redirect\": \"\",\n \"success_callback\": \"\",\n \"platform\": \"API\",\n \"created_from_ip\": \"149.86.53.48\",\n \"checkout_url\": \"http://18.214.100.20/payments/64bfd7c9f63e36669499e779/\",\n \"direct_post_url\": \"http://18.214.100.20/api/v1/p/64bfd7c9f63e36669499e779/\"\n}"},{"id":"e178ac08-e80d-4ce8-b780-981f86e0c8af","name":"Purchases - success","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"url":"https://api.paysecure.net/api/v1/purchases/64bfdb7df63e36669499e82f/"},"status":"Accepted","code":202,"_postman_previewlanguage":"json","header":[{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"Cache-Control","value":"no-cache, no-store, max-age=0, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Expires","value":"0"},{"key":"X-Frame-Options","value":"DENY"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Date","value":"Tue, 25 Jul 2023 15:45:29 GMT"},{"key":"Keep-Alive","value":"timeout=60"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\n \"purchaseId\": \"64bfdb7df63e36669499e82f\",\n \"client\": {\n \"bank_account\": \"\",\n \"bank_code\": \"\",\n \"email\": \"example@paysecure.net\",\n \"phone\": \"\",\n \"full_name\": \"\",\n \"date_of_birth\": \"\",\n \"personal_code\": \"\",\n \"street_address\": \"test test\",\n \"country\": \"IN\",\n \"city\": \"123\",\n \"zip_code\": \"234567\",\n \"shipping_street_address\": \"\",\n \"shipping_country\": \"\",\n \"shipping_city\": \"\",\n \"shipping_zip_code\": \"\",\n \"cc\": [],\n \"bcc\": [],\n \"legal_name\": \"\",\n \"brand_name\": \"\",\n \"registration_number\": \"\",\n \"tax_number\": \"\",\n \"stateCode\": \"ca\"\n },\n \"updated_on\": 1690296521,\n \"type\": \"purchase\",\n \"force_recurring\": false,\n \"created_on\": 1690295168,\n \"purchase\": {\n \"currency\": \"USD\",\n \"products\": [\n {\n \"name\": \"dk\",\n \"quantity\": 1,\n \"price\": 9,\n \"discount\": 0,\n \"tax_percent\": \"0.00\"\n }\n ],\n \"total\": 9,\n \"language\": \"en\",\n \"notes\": \"\",\n \"debt\": 0,\n \"total_formatted\": 1,\n \"request_client_details\": [],\n \"timezone\": \"America/Edmonton\",\n \"email_message\": \"\"\n },\n \"payment\": {\n \"is_outgoing\": false,\n \"payment_type\": \"PURCHASE\",\n \"amount\": 9,\n \"currency\": \"USD\",\n \"net_amount\": 9,\n \"fee_amount\": 10.2591,\n \"pending_amount\": 0,\n \"pending_unfreeze_on\": null,\n \"description\": \"\",\n \"paid_on\": 1690295205,\n \"remote_paid_on\": 1690295205\n },\n \"issuer_details\": {\n \"website\": \"\",\n \"legal_street_address\": \"\",\n \"legal_country\": \"\",\n \"legal_city\": \"\",\n \"legal_zip_code\": \"\",\n \"bank_accounts\": [\n {\n \"bank_account\": \"\",\n \"bank_code\": \"\"\n }\n ],\n \"legal_name\": \"shoes\",\n \"brand_name\": \"shoes\",\n \"registration_number\": \"\",\n \"tax_number\": \"\"\n },\n \"transaction_data\": {\n \"payment_method\": \"\",\n \"flow\": \"payform\",\n \"extra\": {\n \"expiry_month\": \"10\",\n \"amount\": 9,\n \"card_issuer\": \"1-800-432-3117\",\n \"masked_pan\": \"411111XXXXXX1111\",\n \"card_brand\": \"VISA\",\n \"card_issuer_country\": \"US\",\n \"cardholder_name\": \"dk\",\n \"expiry_year\": \"23\"\n },\n \"country\": \"\",\n \"attempts\": [\n {\n \"client_ip\": \"149.86.53.48\",\n \"type\": \"execute\",\n \"payment_method\": \"VISA\",\n \"flow\": \"payform\",\n \"successful\": true,\n \"country\": \"US\",\n \"processing_time\": 1690295205,\n \"extra\": {\n \"expiry_month\": \"10\",\n \"amount\": 9,\n \"card_issuer\": \"1-800-432-3117\",\n \"masked_pan\": \"411111XXXXXX1111\",\n \"card_brand\": \"VISA\",\n \"card_issuer_country\": \"US\",\n \"cardholder_name\": \"dk\",\n \"expiry_year\": \"23\"\n }\n }\n ]\n },\n \"status\": \"PAID\",\n \"status_history\": [\n {\n \"status\": \"created\",\n \"timestamp\": 1690295168\n },\n {\n \"status\": \"pending_execute\",\n \"timestamp\": 1690295193\n },\n {\n \"status\": \"payment_in_process\",\n \"timestamp\": 1690295205\n },\n {\n \"status\": \"paid\",\n \"timestamp\": 1690296521\n },\n {\n \"status\": \"viewed\",\n \"timestamp\": 1690299929\n }\n ],\n \"viewedOn\": 1690299929,\n \"is_test\": false,\n \"brand_id\": \"bd69e8a5-adcf-40de-9e43-2b87cb129a5e\",\n \"merchantRef\":\"d9db7ec0-f94c-4a9d-8883-54c19c222d81\",\n \"send_receipt\": false,\n \"is_recurring_token\": false,\n \"skip_capture\": false,\n \"reference_generated\": \"PS192\",\n \"issued\": \"2023-07-25\",\n \"due\": 1690295168,\n \"refund_upto\": 1705843623,\n \"cc_descriptor\": \"test-cardeye\",\n \"refund_availability\": \"NONE\",\n \"refundable_amount\": 9,\n \"success_redirect\": \"https://google.com\",\n \"failure_redirect\": \"https://yahoo.com\",\n \"cancel_redirect\": \"\",\n \"success_callback\": \"\",\n \"platform\": \"API\",\n \"created_from_ip\": \"149.86.53.48\",\n \"checkout_url\": \"http://18.214.100.20/payments/64bfdb7df63e36669499e82f/\",\n \"direct_post_url\": \"http://18.214.100.20/api/v1/p/64bfdb7df63e36669499e82f/\"\n}"}],"_postman_id":"6b336c51-3582-4ba5-9da9-466d7e1dcf9a"},{"name":"cancel","id":"3189d586-9c25-4ed8-9e8c-98ae1c39d11c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer Token","type":"text"}],"url":"https://api.paysecure.net/api/v1/purchases/6894862fc8e02c74640f56aa/cancel","description":"

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

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

Purchase ID is mandatory for this API.

Response Examples

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

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

\n","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"d6b7f281-5d52-4c2f-87c1-e39cd8e5b1cf","id":"d6b7f281-5d52-4c2f-87c1-e39cd8e5b1cf","name":"🌐 Open Banking","type":"folder"}},"urlObject":{"path":["payment_methods"],"host":["https://api.paysecure.net/api/v1"],"query":[{"disabled":true,"key":"currency","value":"inr"},{"disabled":true,"key":"country","value":"india"},{"key":"brand_id","value":"aff0471b-e37d-4e76-9dee-d235063bf276"}],"variable":[]}},"response":[{"id":"59dc8755-ee9c-4686-aad2-c6abfc751b5e","name":"Payment Methods - Error","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer Token","type":"text"}],"url":{"raw":"https://api.paysecure.net/api/v1/payment_methods?brand_id=aff0471b-e37d-4e76-9dee-d235063bf276","host":["https://api.paysecure.net/api/v1"],"path":["payment_methods"],"query":[{"key":"currency","value":"inr","disabled":true},{"key":"country","value":"india","disabled":true},{"key":"brand_id","value":"aff0471b-e37d-4e76-9dee-d235063bf276"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":null,"header":[{"key":"Date","value":"Thu, 07 Aug 2025 10:48:58 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":"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":"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-Cache","value":"Error from cloudfront"},{"key":"Via","value":"1.1 1e5d213252e38a8aa2e2a927fd3c3754.cloudfront.net (CloudFront)"},{"key":"X-Amz-Cf-Pop","value":"IAD55-P8"},{"key":"X-Amz-Cf-Id","value":"Uv3p02pbXBomVNE_FH3o2ezRXrqvTAr9etg7HAKsVUuUi_8Gvf-ecg=="},{"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=%2BlRerjanFZR0Fh4fFP1DM51iCxavbwesIYz%2FiBfbqbOF5YopeuJBxoMy5kdhHS3%2B%2FyNAacKQzKUv%2FzyXT4gfSV78ugg1iMBiIlmatHtRFg%3D%3D\"}]}"},{"key":"CF-RAY","value":"96b63463da73093a-IAD"},{"key":"alt-svc","value":"h3=\":443\"; ma=86400"}],"cookie":[],"responseTime":null,"body":"{\n \"_all_\": [\n {\n \"message\": \"Authorization header missing\",\n \"code\": \"authentication_failed\"\n }\n ]\n}"},{"id":"c2198c10-26ed-4c54-bd37-6330dab8f9fa","name":"Payment Method- Success","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer Token","type":"text"}],"url":{"raw":"https://api.paysecure.net/api/v1/payment_methods?brand_id=555c458b-e737-4905-adb2-2451d37cbb","host":["https://api.paysecure.net/api/v1"],"path":["payment_methods"],"query":[{"key":"currency","value":"inr","disabled":true},{"key":"country","value":"india","disabled":true},{"key":"brand_id","value":"555c458b-e737-4905-adb2-2451d37cbb"}]}},"status":"Accepted","code":202,"_postman_previewlanguage":null,"header":[{"key":"Date","value":"Tue, 09 Sep 2025 08:04:28 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":"Server","value":"cloudflare"},{"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":"ALLOW-FROM *"},{"key":"Referrer-Policy","value":"no-referrer"},{"key":"Nel","value":"{\"report_to\":\"cf-nel\",\"success_fraction\":0.0,\"max_age\":604800}"},{"key":"Report-To","value":"{\"group\":\"cf-nel\",\"max_age\":604800,\"endpoints\":[{\"url\":\"https://a.nel.cloudflare.com/report/v4?s=PoGnHzy1YxgyVIthM1PXA54R6F7GXZydfD3kEWXJ%2BfS8vqK1BSV2kQ7%2FcLQCX%2FyIPxxfOymqmqTum2vAWfB9UeDg9tjww39Rt9OJVyQrrwNtZZaWMA%3D%3D\"}]}"},{"key":"cf-cache-status","value":"DYNAMIC"},{"key":"CF-RAY","value":"97c52ccb09290668-IAD"},{"key":"alt-svc","value":"h3=\":443\"; ma=86400"}],"cookie":[],"responseTime":null,"body":"{\n \"available_payment_methods\": [\n \"MASTER\",\n \"visa\",\n \"jcb\",\n \"amex\",\n \"CRYPTO-BRIDGE\",\n \"FawryPay\",\n \"INTERAC-E-TRANSFER\",\n \"INTERAC-REQUEST-MONEY\",\n \"MOBILEMONEY\",\n \"NEOSURF\",\n \"PAYID\",\n \"PIX\",\n \"SPEI\",\n \"THIRDPARTY-UPI\",\n \"discover\",\n \"BANKTRANSFER\",\n \"VIRTUAL-IBAN\",\n \"UPI-COLLECT\",\n \"UPI-QR\",\n \"VIRTUAL-ACCOUNT\",\n \"DINERS\",\n \"NETBANKING\"\n ],\n \"by_country\": {\n \"any\": [\n \"MASTER\",\n \"VISA\",\n \"JCB\",\n \"AMEX\",\n \"CRYPTO-BRIDGE\",\n \"FawryPay\",\n \"INTERAC-E-TRANSFER\",\n \"INTERAC-REQUEST-MONEY\",\n \"MOBILEMONEY\",\n \"NEOSURF\",\n \"PAYID\",\n \"PIX\",\n \"SPEI\",\n \"THIRDPARTY-UPI\",\n \"DISCOVER\",\n \"BANKTRANSFER\",\n \"VIRTUAL-IBAN\",\n \"UPI-COLLECT\",\n \"UPI-QR\",\n \"VIRTUAL-ACCOUNT\",\n \"DINERS\",\n \"NETBANKING\"\n ]\n },\n \"country_names\": {\n \"any\": \"Other\"\n },\n \"names\": {\n \"NETBANKING\": \"NETBANKING\",\n \"AMEX\": \"AMEX\",\n \"MASTER\": \"Mastercard\",\n \"CRYPTO-BRIDGE\": \"CRYPTO-BRIDGE\",\n \"PAYID\": \"PAYID\",\n \"SPEI\": \"SPEI\",\n \"DISCOVER\": \"DISCOVER\",\n \"JCB\": \"JCB\",\n \"VISA\": \"Visa\",\n \"NEOSURF\": \"NEOSURF\",\n \"INTERAC-E-TRANSFER\": \"INTERAC-E-TRANSFER\",\n \"THIRDPARTY-UPI\": \"THIRDPARTY-UPI\",\n \"VIRTUAL-IBAN\": \"VIRTUAL-IBAN\",\n \"BANKTRANSFER\": \"BANKTRANSFER\",\n \"DINERS\": \"DINERS\",\n \"INTERAC-REQUEST-MONEY\": \"INTERAC-REQUEST-MONEY\",\n \"UPI-COLLECT\": \"UPI-COLLECT\",\n \"UPI-QR\": \"UPI-QR\",\n \"MOBILEMONEY\": \"MOBILEMONEY\",\n \"FawryPay\": \"FawryPay\",\n \"VIRTUAL-ACCOUNT\": \"VIRTUAL-ACCOUNT\",\n \"PIX\": \"PIX\"\n },\n \"card_methods\": [\n \"MASTER\",\n \"VISA\",\n \"JCB\",\n \"AMEX\",\n \"DISCOVER\"\n ]\n}"}],"_postman_id":"501d83c2-bcab-43d8-b3e7-4cbc3551edf5"}],"id":"16320954-1f95-4587-b7b5-86a15e3d5f85","_postman_id":"16320954-1f95-4587-b7b5-86a15e3d5f85","description":"","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"d6b7f281-5d52-4c2f-87c1-e39cd8e5b1cf","id":"d6b7f281-5d52-4c2f-87c1-e39cd8e5b1cf","name":"🌐 Open Banking","type":"folder"}}}],"id":"d6b7f281-5d52-4c2f-87c1-e39cd8e5b1cf","description":"

Overview

Open Banking refers to the integration with local bank transfer systems in specific countries, enabling users to make payments directly from their bank accounts through a secure and trusted interface. This is particularly useful for regions where direct bank transfers are a preferred payment method over cards or other APMs.

Paysecure leverages Open Banking to facilitate transactions for different regions, enabling businesses to access localized payment options without the complexity of managing individual bank integrations. Each third-party service is tailored to the specific financial infrastructure of the country or region, ensuring compliance, security, and ease of use.

Key Benefits of Open Banking:

Localized Payment Options: Supports region-specific payment methods, giving customers familiar and trusted ways to pay.
\n
Secure Transactions: Payments are processed directly through the customer’s bank, enhancing trust and security.
\n
Real-Time Verification: Enables real-time confirmation of payments, reducing risks and improving cash flow.
\n
Compliance: Adheres to local and international regulatory standards like PSD2 for Europe, ensuring that payments are secure and compliant.
\n

This setup allows Paysecure to offer a diverse range of bank transfer options to its global clientele, catering to the specific needs of different regions while maintaining a consistent and secure payment experience.

\n","auth":{"type":"noauth","isInherited":false},"event":[{"listen":"prerequest","script":{"type":"text/javascript","packages":{},"exec":[""],"id":"e8a74862-a410-4357-bcf9-5b53a60615f9"}},{"listen":"test","script":{"type":"text/javascript","packages":{},"exec":[""],"id":"69a2cb71-17fd-494c-a773-449c5d656c88"}}],"_postman_id":"d6b7f281-5d52-4c2f-87c1-e39cd8e5b1cf"},{"name":"🪙 On Ramp","item":[],"id":"2d849bc8-ec62-4fd0-bc09-cda68073b10e","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\": \"john.doe@paysecure.net\",\n        \"country\":\"GB\",\n        \"city\":\"London\",\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\": \"brand_id_from_the_portal\",\n    \"paymentMethod\":\"QBPAYFTOPUP\",\n    \"success_redirect\": \"https://google.com\",\n    \"failure_redirect\": \"https://yahoo.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\": \"john.doe@paysecure.net\",\n        \"phone\": \"9999999999\",\n        \"full_name\": \"\",\n        \"date_of_birth\": \"\",\n        \"personal_code\": \"\",\n        \"street_address\": \"221B Baker Street\",\n        \"country\": \"GB\",\n        \"city\": \"London\",\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\": \"brand_id_from_the_portal\",\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://google.com\",\n    \"failure_redirect\": \"https://yahoo.com\",\n    \"cancel_redirect\": \"\",\n    \"success_callback\": \"\",\n    \"platform\": \"API\",\n    \"created_from_ip\": \"135.129.121.137\",\n    \"checkout_url\": \"https://staging.paysecure.net/payments/657a10b3casd23123122/\",\n    \"merchantIp\": \"10.10.10.10\"\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":"2d849bc8-ec62-4fd0-bc09-cda68073b10e"},{"name":"3rd Party Cashiers","item":[{"name":"ThirdParty UPI","item":[{"name":"Concepts","item":[],"id":"09b67d25-8892-4147-a573-29cdb4e6d7e8","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

\n","_postman_id":"09b67d25-8892-4147-a573-29cdb4e6d7e8"},{"name":"Payin","item":[{"name":"Create Purchase","id":"99e3a7ec-cfe9-4944-aefc-337c25d404f6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer Token"}],"body":{"mode":"raw","raw":"{\r\n \"client\": {\r\n \"email\": \"ziangani@outlook.com\",\r\n \"street_address\": \"Mansarovar, Jaipur\",\r\n \"city\": \"Jaipur\",\r\n \"full_name\": \"Adarsh Saini\",\r\n \"zip_code\": \"101100\",\r\n \"country\": \"IN\",\r\n \"date_of_birth\": \"1977-05-10\",\r\n \"stateCode\": \"NA\",\r\n \"phone\": \"0964926646\"\r\n },\r\n \"purchase\": {\r\n \"currency\": \"INR\",\r\n \"products\": [\r\n {\r\n \"name\": \"test\",\r\n \"price\": 1\r\n }\r\n ]\r\n },\r\n \"paymentMethod\": \"THIRDPARTY-UPI\",\r\n \"brand_id\": \"{brand_id}\",\r\n \"success_redirect\": \"https://staging.paysecure.net/getResponse.jsp?success=true\",\r\n \"pending_redirect\": \"https://staging.paysecure.net/getResponse.jsp?success=pending\",\r\n \"failure_redirect\": \"https://staging.paysecure.net/getResponse.jsp?success=false\",\r\n \"success_callback\": \"https://staging.paysecure.net\",\r\n \"failure_callback\": \"https://staging.paysecure.net\"\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

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":"99e3a7ec-cfe9-4944-aefc-337c25d404f6"},{"name":"Get Status","id":"02013d25-668b-40e1-ac09-f3c4fbc8f5cc","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer Token","type":"text"}],"url":"https://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":"eddd8aeb-c6be-465e-98cc-2b3c90dc4fa0","name":"Purchases-success","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer Token"}],"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\": \"deepakdeepaksinghal@gmail.com\",\n \"date_of_birth\": \"1970-07-10\",\n \"street_address\": \"10 New Burlington Street Apt. 214\",\n \"country\": \"IN\",\n \"city\": \"London\",\n \"zip_code\": \"W1S 3BE\",\n \"cc\": [],\n \"bcc\": [],\n \"stateCode\": \"QLD\"\n },\n \"updated_on\": 1724147324,\n \"type\": \"purchase\",\n \"paymentMethod\": \"UPI\",\n \"amountUnit\": \"MAJOR\",\n \"errorMsg\": \"\",\n \"redirectType\": \"POST\",\n \"force_recurring\": false,\n \"created_on\": 1724147324,\n \"merchantRef\": \"66c4667bb993c970367c288a\",\n \"merchantName\": \"merchant002\",\n \"purchase\": {\n \"currency\": \"INR\",\n \"products\": [\n {\n \"name\": \"test\",\n \"quantity\": 1,\n \"price\": 10,\n \"discount\": 0,\n \"tax_percent\": \"0.00\"\n }\n ],\n \"total\": 10,\n \"language\": \"en\",\n \"notes\": \"\",\n \"debt\": 0,\n \"total_formatted\": 1,\n \"expireInMin\": \"35\",\n \"request_client_details\": [],\n \"timezone\": \"MIT\",\n \"email_message\": \"\"\n },\n \"payment\": {\n \"is_outgoing\": false,\n \"payment_type\": \"PURCHASE\",\n \"amount\": 10,\n \"currency\": \"INR\",\n \"net_amount\": 10,\n \"fee_amount\": 0,\n \"pending_amount\": 0,\n \"pending_unfreeze_on\": null,\n \"description\": \"\",\n \"paid_on\": 1724147324,\n \"remote_paid_on\": 1724147324\n },\n \"issuer_details\": {\n \"website\": \"\",\n \"legal_street_address\": \"\",\n \"legal_country\": \"\",\n \"legal_city\": \"\",\n \"legal_zip_code\": \"\",\n \"bank_accounts\": [\n {}\n ],\n \"legal_name\": \"test6\",\n \"brand_name\": \"test6\",\n \"registration_number\": \"\",\n \"tax_number\": \"\"\n },\n \"transaction_data\": {\n \"payment_method\": \"\",\n \"flow\": \"payform\",\n \"extra\": {\n \"amount\": 10,\n \"masked_pan\": \"UPI\"\n },\n \"country\": \"\",\n \"attempts\": [\n {\n \"client_ip\": \"103.59.75.113\",\n \"type\": \"execute\",\n \"payment_method\": \"UPI\",\n \"flow\": \"payform\",\n \"successful\": true,\n \"country\": \"UPI\",\n \"processing_time\": 1724147324,\n \"extra\": {\n \"amount\": 10,\n \"masked_pan\": \"UPI\"\n }\n }\n ]\n },\n \"status\": \"PAYMENT_IN_PROCESS\",\n \"status_history\": [\n {\n \"status\": \"created\",\n \"timestamp\": 1724147324\n },\n {\n \"status\": \"pending_execute\",\n \"timestamp\": 1724147324\n },\n {\n \"status\": \"payment_in_process\",\n \"timestamp\": 1724147324\n }\n ],\n \"is_test\": false,\n \"brand_id\": \"c4003b2c-22d4-4dc1-ad0c-c6b54f8c9636\",\n \"send_receipt\": false,\n \"is_recurring_token\": false,\n \"skip_capture\": false,\n \"reference_generated\": \"PS10907\",\n \"issued\": \"2024-08-20\",\n \"due\": 1724147324,\n \"refund_upto\": 1725871728,\n \"cc_descriptor\": \"test1\",\n \"fraudScore\": \"NA\",\n \"trustScore\": \"NA\",\n \"payInDetails\": {\n \"qrCode\": \"iVBORw0KGgoAAAANSUhEUgAAAb0AAAG9AQAAAACpVZXpAAAH7UlEQVR4nO1cQY7qSgw0yiJLjpCbJBdDIhIXg5vkCCyzQPi7qtwkM2/zNcsYpIfeQFcvTNtdLtsx/9trtS/wC/wCv8A/AZ9mdnpevb9bt6zj+TWso3Uen17i33nGkgverotN/orP7FoHeHV/AG1nfnoZ+kfYrcdKv8ei/gEMvljxRkQZ4MVi5Ww2nm9LbBF/xnLYd7YVVu3dZ262hPUvA3+CUsCnDesJ39/PHhidtlg5cRFek9+WtSgwPO595ldGI4dTAohX/8ZpG2Hp8MdiQPnjEL7XIWJdEae6BfvgC0SxCGCx2Q2fvf5x5GMDGckRov7X2+8r4NhAvW6O82QrHBBeuGBHHjSHK7rDtDxtv8jD0YERv8PPwAHcRjogbv43/BF/wuZwytgHO9r4serxgbIg7vvzPNALY1GHzXDrwYJji2JgTsvOkY8PxGnDDYeVsPHcYjWoUtx6jF04cjPsa8PmjxWAroMWUbtbdPPHPuGZsOqdX8SfOJXGu26zagVgLILHraTWvOUDjRuuU4jq4a2xj8y9hLd6HaArFcMtD997gVoHJYCRwa8H2HzgWVxBDkoBxR5lraVHxIpgdWXEcjJKHrmw+S2Z071F8gLA+JSGCkwEbISoOFnJHiNtvSAhgc0RpyKmw/BeBqgUFUcJGIPWAZnjY1VXis+bUMdw93McHph0kXedfA/pBfMx5CKLlJCJ9n3+FEkOD1QSiuUyrSWaQfyuc0eS3UElm+m8ZYDNqrCbkQMgMMGWEcCQhdEB6a1Jsps/VgCGybASWTtOFu1Lz8SlD/lsgheepBXFupaUFQEiC4MXzozaRjYQrnhRAksioORDbx8doAAQkfwM3qzrP4MVI3lwRqeEOEgTgc37eyVg5zxFZNAuboR0HlkY5VZdbszbELtk6SpAk/DV44yBB2H5zFSWgR3KPAkSKIHZT3nt6EA4INgPmKJRim/1L1MljKI8zS0NbSwElG5qrX6DwsQkDQh5Kr91prI3V4jfqHUBYKfKH9jPQPbDCpchTkmop/xzgiYi9dULASm2863TQeuxGYuDYVUzmtFOm3tuxaDjA+Fi0AehAZFB0zOpfxikD4Uo7YOw9SFIBYAqkN4UyRnY4ZnNFWnfVlpX7WeTEI8PBGWepDvLZCDPopBZOQVVgj+CCNwaaaoBxP8p/zDloN5jZI/sQABGeYe7ctftyBUAPpmmozqBpAyZ/ArxmXmqfJTqIZVWbLGJJBWAtCXqN8rCqIN1rqh9N0qIs84dGzU2raMAkPEbJjMWt85atJg1fZXZhm7CURyqDvCpWpejnUci4QrxmWSSVQwqRGwT47qdEFQBOPCWpxeCPBulsl55KiyIOM96hiLWw+sAndSQB+1KqQxnjEBmIC+xb2NNjFnJp95RASjimEViKtAiTWoEM1bf1YHK2vKOPR4fiJuLyrIZuk0hNOP6Z9McsxJk8gsJEm44sYEqQHaghvF4fQk9ch+9MXR3aOdRJA9KsJVKDw9k1FbDE1WyiOkUghiwSQlQycmyz5mCRyWgZxAyFU2dJJvxm59RsgerlmS/XXMFgOzfYU3H1OFuSlaRnq288JyuyL5dhLJPB0IBIBa9mbCrOYxaqkqlqPwhlcU1B89Ud/wnklcABjdCmi4dEcoyo1Nrt2yVsDGrGGpqrgNUqY8siQblQXMeOcZv6Ijr1LpYdjWd4wM9h2yYcanE02gRxY3WmSHSxBKP1wFK4NFVz0i0jZUwO2Viz3PHA7nrfD4+8MlRLCRl4NITs42WxPdZxKGQdpXSah/aWQDo5IcJVB2ZhBrHi0UcmjY7eH/8HAWAraaTxMfSAU1ah9E9L8pAVD6tBGQnt/h1bMFGg3fLMdjUwvaMNfMOzCJtR+7wQPWucKBmZjjnV61DjJtxXkJpiO1qOhWAOV/TYhKcUpM2F91rxqGJVrHYdXcXAPIA5dDsIPXwnUZWOxRpgrMjEzORW8GrAnDO4tbE8QnORrCfBeeOMvSk3h/LLR6FgNtIIyui1OglaTAhYXNYamicufGdIx8eqFz9ZTkMYWy8dA1vqRp4Ir/2WcLINlBQAPgkIWQQz0c8OFvlkl8zA5lzGAeHz9+FgO6ii+y9QCRSowHdTtH9xOZTjWBn6asKUK2VvtBaUuFH+R62oAZkObLfKzM71wHCqhyVaFPpIs/emndV+mLfBmtivv85Dg9kAwajE+K3kg8lpq3YA0dlY48GAM+FgDklq7wDoVtUaVT/e/YdJDdiUcPrAHmeFJhemkBKMunZ/y6nZDeYGMKmzB8eCBshHW1T6VhuqdabzmI+P2Tpm1OWAWoei88uSBV+o9G7eimfN4O0f9e/enyg9PgL5Xk9tqDP9OKmKilbCNU0dxL6Wgr4aOlo/yGOagQ7yeZqwYRnXndlxArAnNHfRvbzXlML5ktJmWdij2rgsxAQVlVJMF2xaUCcGuUH6n9SpX3f9XR8IF7qQIiTlUWcznXf5/CRZfflqIGuaxkgDEVqaOyX4+VmnNvic2SyTCi5VRWfdgVUAF5dUVtj6KrpwL545dMX7TNg/LMaeHygnr7YxNM2JcEvVOLJrISKolk9oPpxW7ep+JJodLJqnkpN9Vs1IFxsarqzpLKHsrUXGaW1+vrFfj3w8+BA+iOHA1omrxbCJ9F67IP2oUK04+QFgC2Sq8U7x5CGTyVsaL3LLjIp9ywC/NPrC/wCv8Av8C/A/wCpreUSrYyOqQAAAABJRU5ErkJggg==\",\n \"gpayUri\": \"gpay://upi/pay?ver=01&mode=15&am=5.00&mam=1.00&cu=INR&pa=npstpay@timecosmos&pn=NPST%20PAY&mc=6012&tr=NPST040120220010&tn=QR%20SIT%20testing&mid=NPSTPAY001&msid=NPSTPAY001-001&mtid=NPSTPAY001-001&category=02&url=http://google.com\",\n \"phonepeUri\": \"phonepe://pay?ver=01&mode=15&am=5.00&mam=1.00&cu=INR&pa=npstpay@timecosmos&pn=NPST%20PAY&mc=6012&tr=NPST040120220010&tn=QR%20SIT%20testing&mid=NPSTPAY001&msid=NPSTPAY001-001&mtid=NPSTPAY001-001&category=02&url=http://google.com\",\n \"paytmUri\": \"paytmmp://pay?ver=01&mode=15&am=5.00&mam=1.00&cu=INR&pa=npstpay@timecosmos&pn=NPST%20PAY&mc=6012&tr=NPST040120220010&tn=QR%20SIT%20testing&mid=NPSTPAY001&msid=NPSTPAY001-001&mtid=NPSTPAY001-001&category=02&url=http://google.com\",\n \"generatedLink\": \"https://staging.decf.in/pay/514o5z3m9z\"\n },\n \"refund_availability\": \"NONE\",\n \"refundable_amount\": 10,\n \"success_redirect\": \"https://staging.paysecure.net/getResponse.jsp?success=true\",\n \"failure_redirect\": \"https://staging.paysecure.net/getResponse.jsp?success=false\",\n \"cancel_redirect\": \"\",\n \"success_callback\": \"https://staging.paysecure.net\",\n \"failure_callback\": \"https://staging.paysecure.net\",\n \"platform\": \"API\",\n \"created_from_ip\": \"103.59.75.113\",\n \"checkout_url\": \"https://staging.paysecure.net/payments/66c4667bb993c970367c288a/\",\n \"payoutProcess\": false\n}"},{"id":"afcb1378-58ad-4c90-8dff-e641d34183ab","name":"Purchases","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer Token","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":"02013d25-668b-40e1-ac09-f3c4fbc8f5cc"}],"id":"c413dfec-c70a-4180-a31f-93b5a1b9e7c7","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":"c413dfec-c70a-4180-a31f-93b5a1b9e7c7"},{"name":"Payout","item":[{"name":"Create PayOut","id":"46023168-b018-433b-a253-b602d5f3207b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer Token"}],"body":{"mode":"raw","raw":"{\r\n \"client\": {\r\n \"email\": \"yogesh@gmail.com\",\r\n \"country\": \"CA\",\r\n \"phone\": \"766225230591\",\r\n \"full_name\": \"Test Person-uk\"\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://success.com\",\r\n \"failure_callback\": \"https://failure.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

","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":"46023168-b018-433b-a253-b602d5f3207b"},{"name":"Get Status","id":"85fc96ca-9457-481b-ba6d-0b197c6ddc79","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://success.com\",

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

\n","urlObject":{"path":["getpayout","{payoutId}",""],"host":["https://api.paysecure.net/api/v1"],"query":[],"variable":[]}},"response":[{"id":"78aba544-b85e-41b2-950f-72fa01240c02","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\": \"Yogesh@gmail.com\",\r\n \"phone\": \"766533230591\",\r\n \"full_name\": \"Test Person-uk\",\r\n \"country\": \"CA\"\r\n },\r\n \"updated_on\": 1719896808,\r\n \"payoutMethod\": \"PAYOUT-UPI\",\r\n \"beneficiaryDetail\": {\r\n \"upi\": \"charles.babbage@okhdfc\",\r\n \"transferType\": \"UPI\"\r\n },\r\n \"amountUnit\": \"MAJOR\",\r\n \"amount\": 10.0,\r\n \"errorMsg\": \"\",\r\n \"purpose\": \"test payout\",\r\n \"created_on\": 1719896808,\r\n \"merchantRef\": \"66838ae86d41e41c10a8656d\",\r\n \"merchantName\": \"newMerchant777\",\r\n \"status\": \"PAYOUT_IN_PROCESS\",\r\n \"status_history\": [\r\n {\r\n \"status\": \"created\",\r\n \"timestamp\": 1719896808\r\n },\r\n {\r\n \"status\": \"payout_in_process\",\r\n \"timestamp\": 1719896810\r\n },\r\n {\r\n \"status\": \"viewed\",\r\n \"timestamp\": 1719900796\r\n }\r\n ],\r\n \"viewedOn\": 1719900796,\r\n \"currency\": \"INR\",\r\n \"paymentOn\": 0,\r\n \"success_callback\": \"https://success.com\",\r\n \"failure_callback\": \"https://failure.com\"\r\n}\r\n"},{"id":"88651014-3c4c-4444-8466-094d5ae245ef","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":"85fc96ca-9457-481b-ba6d-0b197c6ddc79"}],"id":"50d39c91-642d-4cac-81e4-a1372399eeed","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":"50d39c91-642d-4cac-81e4-a1372399eeed"}],"id":"9c81f465-e855-4513-9a53-4a6c294a1559","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.

\n","_postman_id":"9c81f465-e855-4513-9a53-4a6c294a1559"}],"id":"d472ff4b-ea42-4c40-b12e-acfc5764c702","_postman_id":"d472ff4b-ea42-4c40-b12e-acfc5764c702","description":""}],"id":"311752c9-c406-41e3-a5a7-4dae13aa69f6","_postman_id":"311752c9-c406-41e3-a5a7-4dae13aa69f6","description":""},{"name":"Trust Score","item":[{"name":"TrustScore Detailed","id":"2cf673ad-478b-4829-8c21-d631d68f70fd","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"requiredinput\": {\r\n \"ip\": \"111.11.11.11\",\r\n \"email\": \"test@gmail.com\",\r\n \"url\": \"https://www.asos.com/\"\r\n },\r\n \"optionalInput\": {\r\n \"last_bets\": null,\r\n \"last_wins\": \"\",\r\n \"total_bonuses\": \"\",\r\n \"last_real_bets\": \"\",\r\n \"last_real_wins\": \"\",\r\n \"total_deposits\": \"\",\r\n \"last_bonus_bets\": \"\",\r\n \"last_bonus_wins\": \"\",\r\n \"average_real_bet\": \"\",\r\n \"last_bets_amount\": \"\",\r\n \"last_wins_amount\": \"\",\r\n \"average_bonus_bet\": \"\",\r\n \"bonus_to_deposits\": \"\",\r\n \"last_deposit_date\": \"\",\r\n \"total_withdrawals\": \"\",\r\n \"is_phone_confirmed\": \"\",\r\n \"money_in_money_out\": \"\",\r\n \"last_deposit_amount\": \"\",\r\n \"last_freespins_date\": \"\",\r\n \"last_freespins_name\": \"\",\r\n \"last_free_bonus_date\": \"\",\r\n \"last_free_bonus_name\": \"\",\r\n \"total_bonuses_amount\": \"\",\r\n \"last_freespins_amount\": \"\",\r\n \"last_freespins_status\": \"\",\r\n \"last_real_bets_amount\": \"\",\r\n \"last_real_wins_amount\": \"\",\r\n \"total_deposits_amount\": \"\",\r\n \"last_bonus_bets_amount\": \"\",\r\n \"last_bonus_wins_amount\": \"\",\r\n \"last_free_bonus_amount\": \"\",\r\n \"last_free_bonus_status\": \"\",\r\n \"last_deposit_bonus_date\": \"\",\r\n \"last_deposit_bonus_name\": \"\",\r\n \"last_freespins_currency\": \"\",\r\n \"last_freespins_wagering\": \"\",\r\n \"withdrawals_to_deposits\": \"\",\r\n \"last_free_bonus_currency\": \"\",\r\n \"last_free_bonus_wagering\": \"\",\r\n \"total_withdrawals_amount\": \"\",\r\n \"withdrawal_ewallet_email\": \"\",\r\n \"last_deposit_bonus_amount\": \"\",\r\n \"last_deposit_bonus_status\": \"\",\r\n \"last_deposit_bonus_currency\": \"\",\r\n \"last_deposit_bonus_wagering\": \"\",\r\n \"session\": \"\",\r\n \"payment_mode\": \"\",\r\n \"card_fullname\": \"\",\r\n \"card_bin\": \"\",\r\n \"card_hash\": \"\",\r\n \"card_last\": \"\",\r\n \"card_expire\": \"\",\r\n \"avs_result\": \"\",\r\n \"cvv_result\": \"\",\r\n \"sca_method\": \"\",\r\n \"user_bank_account\": \"\",\r\n \"user_bank_name\": \"\",\r\n \"user_balance\": \"\",\r\n \"user_verification_level\": \"\",\r\n \"status_3d\": \"\",\r\n \"regulation\": \"\",\r\n \"payment_provider\": \"\",\r\n \"phone_number\": \"\",\r\n \"transaction_type\": \"\",\r\n \"transaction_amount\": \"\",\r\n \"transaction_currency\": \"\",\r\n \"merchant_id\": \"\",\r\n \"details_url\": \"\",\r\n \"name\": \"\",\r\n \"person_type\": \"\",\r\n \"gender\": \"\"\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.paysecure.net/api/v1/trustScore","description":"

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":"29aed91e-4b38-4296-8c46-af68beb7e382","name":"TrustScoreExists","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"requiredinput\": {\r\n \"ip\": \"2001:8004:cc2:fadb:9958:4523:6c42:e3f2\",\r\n \"email\": \"test@gmail.com\",\r\n \"url\": \"http://test.com\"\r\n },\r\n \"optionalInput\": {\r\n \"last_bets\": null,\r\n \"last_wins\": \"\",\r\n \"total_bonuses\": \"\",\r\n \"last_real_bets\": \"\",\r\n \"last_real_wins\": \"\",\r\n \"total_deposits\": \"\",\r\n \"last_bonus_bets\": \"\",\r\n \"last_bonus_wins\": \"\",\r\n \"average_real_bet\": \"\",\r\n \"last_bets_amount\": \"\",\r\n \"last_wins_amount\": \"\",\r\n \"average_bonus_bet\": \"\",\r\n \"bonus_to_deposits\": \"\",\r\n \"last_deposit_date\": \"\",\r\n \"total_withdrawals\": \"\",\r\n \"is_phone_confirmed\": \"\",\r\n \"money_in_money_out\": \"\",\r\n \"last_deposit_amount\": \"\",\r\n \"last_freespins_date\": \"\",\r\n \"last_freespins_name\": \"\",\r\n \"last_free_bonus_date\": \"\",\r\n \"last_free_bonus_name\": \"\",\r\n \"total_bonuses_amount\": \"\",\r\n \"last_freespins_amount\": \"\",\r\n \"last_freespins_status\": \"\",\r\n \"last_real_bets_amount\": \"\",\r\n \"last_real_wins_amount\": \"\",\r\n \"total_deposits_amount\": \"\",\r\n \"last_bonus_bets_amount\": \"\",\r\n \"last_bonus_wins_amount\": \"\",\r\n \"last_free_bonus_amount\": \"\",\r\n \"last_free_bonus_status\": \"\",\r\n \"last_deposit_bonus_date\": \"\",\r\n \"last_deposit_bonus_name\": \"\",\r\n \"last_freespins_currency\": \"\",\r\n \"last_freespins_wagering\": \"\",\r\n \"withdrawals_to_deposits\": \"\",\r\n \"last_free_bonus_currency\": \"\",\r\n \"last_free_bonus_wagering\": \"\",\r\n \"total_withdrawals_amount\": \"\",\r\n \"withdrawal_ewallet_email\": \"\",\r\n \"last_deposit_bonus_amount\": \"\",\r\n \"last_deposit_bonus_status\": \"\",\r\n \"last_deposit_bonus_currency\": \"\",\r\n \"last_deposit_bonus_wagering\": \"\",\r\n \"session\": \"\",\r\n \"payment_mode\": \"\",\r\n \"card_fullname\": \"\",\r\n \"card_bin\": \"\",\r\n \"card_hash\": \"\",\r\n \"card_last\": \"\",\r\n \"card_expire\": \"\",\r\n \"avs_result\": \"\",\r\n \"cvv_result\": \"\",\r\n \"sca_method\": \"\",\r\n \"user_bank_account\": \"\",\r\n \"user_bank_name\": \"\",\r\n \"user_balance\": \"\",\r\n \"user_verification_level\": \"\",\r\n \"status_3d\": \"\",\r\n \"regulation\": \"\",\r\n \"payment_provider\": \"\",\r\n \"phone_number\": \"\",\r\n \"transaction_type\": \"\",\r\n \"transaction_amount\": \"\",\r\n \"transaction_currency\": \"\",\r\n \"merchant_id\": \"\",\r\n \"details_url\": \"\",\r\n \"name\": \"\",\r\n \"person_type\": \"\",\r\n \"gender\": \"\"\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"{{StagingBaseURL}}/trustScore"},"status":"Accepted","code":202,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Sun, 29 Oct 2023 09:21:22 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"Cache-Control","value":"no-cache, no-store, max-age=0, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Expires","value":"0"},{"key":"X-Frame-Options","value":"DENY"},{"key":"CF-Cache-Status","value":"DYNAMIC"},{"key":"Report-To","value":"{\"endpoints\":[{\"url\":\"https:\\/\\/a.nel.cloudflare.com\\/report\\/v3?s=r2%2FuLwSilxdD1lpiI1VqpgF0Tu9etiNhupySeBHl0zcU8XV1z8kwR%2FJ00ti4xpMdrTXW%2BkqZkLGrkkaUnMWFsaYlg%2FfA9UC4wIKwmc9LHUwna491EmnC3b3vlabzhUJ11CMpnVmicUE%3D\"}],\"group\":\"cf-nel\",\"max_age\":604800}"},{"key":"NEL","value":"{\"success_fraction\":0,\"report_to\":\"cf-nel\",\"max_age\":604800}"},{"key":"Server","value":"cloudflare"},{"key":"CF-RAY","value":"81da590e8d4345a0-LHR"},{"key":"alt-svc","value":"h3=\":443\"; ma=86400"}],"cookie":[],"responseTime":null,"body":"{\n \"trustScore\": 0,\n \"deliverable\": \"false\",\n \"proxy\": \"false\",\n \"vpn\": \"false\",\n \"tor\": \"false\",\n \"active_vpn\": \"false\",\n \"active_tor\": \"false\",\n \"recent_abuse\": \"false\",\n \"bot_status\": \"false\"\n}"},{"id":"06c3e4d3-fa9f-4f66-b506-f01fe6481272","name":"TrustScoreError","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"requiredinput\": {\r\n \"ip\": \"2001:8004:cc2:fadb:9958:4523:6c42:e3f2\",\r\n \"email\": \"test@gmail.com\",\r\n \"url\": \"http://test.com\"\r\n },\r\n \"optionalInput\": {\r\n \"last_bets\": null,\r\n \"last_wins\": \"\",\r\n \"total_bonuses\": \"\",\r\n \"last_real_bets\": \"\",\r\n \"last_real_wins\": \"\",\r\n \"total_deposits\": \"\",\r\n \"last_bonus_bets\": \"\",\r\n \"last_bonus_wins\": \"\",\r\n \"average_real_bet\": \"\",\r\n \"last_bets_amount\": \"\",\r\n \"last_wins_amount\": \"\",\r\n \"average_bonus_bet\": \"\",\r\n \"bonus_to_deposits\": \"\",\r\n \"last_deposit_date\": \"\",\r\n \"total_withdrawals\": \"\",\r\n \"is_phone_confirmed\": \"\",\r\n \"money_in_money_out\": \"\",\r\n \"last_deposit_amount\": \"\",\r\n \"last_freespins_date\": \"\",\r\n \"last_freespins_name\": \"\",\r\n \"last_free_bonus_date\": \"\",\r\n \"last_free_bonus_name\": \"\",\r\n \"total_bonuses_amount\": \"\",\r\n \"last_freespins_amount\": \"\",\r\n \"last_freespins_status\": \"\",\r\n \"last_real_bets_amount\": \"\",\r\n \"last_real_wins_amount\": \"\",\r\n \"total_deposits_amount\": \"\",\r\n \"last_bonus_bets_amount\": \"\",\r\n \"last_bonus_wins_amount\": \"\",\r\n \"last_free_bonus_amount\": \"\",\r\n \"last_free_bonus_status\": \"\",\r\n \"last_deposit_bonus_date\": \"\",\r\n \"last_deposit_bonus_name\": \"\",\r\n \"last_freespins_currency\": \"\",\r\n \"last_freespins_wagering\": \"\",\r\n \"withdrawals_to_deposits\": \"\",\r\n \"last_free_bonus_currency\": \"\",\r\n \"last_free_bonus_wagering\": \"\",\r\n \"total_withdrawals_amount\": \"\",\r\n \"withdrawal_ewallet_email\": \"\",\r\n \"last_deposit_bonus_amount\": \"\",\r\n \"last_deposit_bonus_status\": \"\",\r\n \"last_deposit_bonus_currency\": \"\",\r\n \"last_deposit_bonus_wagering\": \"\",\r\n \"session\": \"\",\r\n \"payment_mode\": \"\",\r\n \"card_fullname\": \"\",\r\n \"card_bin\": \"\",\r\n \"card_hash\": \"\",\r\n \"card_last\": \"\",\r\n \"card_expire\": \"\",\r\n \"avs_result\": \"\",\r\n \"cvv_result\": \"\",\r\n \"sca_method\": \"\",\r\n \"user_bank_account\": \"\",\r\n \"user_bank_name\": \"\",\r\n \"user_balance\": \"\",\r\n \"user_verification_level\": \"\",\r\n \"status_3d\": \"\",\r\n \"regulation\": \"\",\r\n \"payment_provider\": \"\",\r\n \"phone_number\": \"\",\r\n \"transaction_type\": \"\",\r\n \"transaction_amount\": \"\",\r\n \"transaction_currency\": \"\",\r\n \"merchant_id\": \"\",\r\n \"details_url\": \"\",\r\n \"name\": \"\",\r\n \"person_type\": \"\",\r\n \"gender\": \"\"\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"{{StagingBaseURL}}/trustScore"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Sun, 29 Oct 2023 09:28:33 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"Cache-Control","value":"no-cache, no-store, max-age=0, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Expires","value":"0"},{"key":"X-Frame-Options","value":"DENY"},{"key":"CF-Cache-Status","value":"DYNAMIC"},{"key":"Report-To","value":"{\"endpoints\":[{\"url\":\"https:\\/\\/a.nel.cloudflare.com\\/report\\/v3?s=herXY1o%2BFZa%2F3qNFjvh4ANgP%2FD0DdAVVFm0vUZDAst2rFkieItm%2Fu0VN24DYrdp7MHMHFKWLvrsBYVIxjDPDaLgJjeGBvlTP2iZoB5EnG1hPPHUVXRNP%2FGMmOTh%2Fp7gsyj0vihW1kMk%3D\"}],\"group\":\"cf-nel\",\"max_age\":604800}"},{"key":"NEL","value":"{\"success_fraction\":0,\"report_to\":\"cf-nel\",\"max_age\":604800}"},{"key":"Server","value":"cloudflare"},{"key":"CF-RAY","value":"81da6398ab144913-LHR"},{"key":"alt-svc","value":"h3=\":443\"; ma=86400"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Incorrect secret_key\",\n \"code\": \"authentication_failed\"\n}"}],"_postman_id":"2cf673ad-478b-4829-8c21-d631d68f70fd"},{"name":"checkTransactionAllowed","id":"70af9b19-5d76-4a1f-8397-dcc605f4ccb9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"requiredinput\": {\r\n \"ip\": \"111.11.11.11\",\r\n \"email\": \"test@gmail.com\",\r\n \"url\": \"https://www.asos.com/\"\r\n },\r\n \"optionalInput\": {\r\n \"last_bets\": null,\r\n \"last_wins\": \"\",\r\n \"total_bonuses\": \"\",\r\n \"last_real_bets\": \"\",\r\n \"last_real_wins\": \"\",\r\n \"total_deposits\": \"\",\r\n \"last_bonus_bets\": \"\",\r\n \"last_bonus_wins\": \"\",\r\n \"average_real_bet\": \"\",\r\n \"last_bets_amount\": \"\",\r\n \"last_wins_amount\": \"\",\r\n \"average_bonus_bet\": \"\",\r\n \"bonus_to_deposits\": \"\",\r\n \"last_deposit_date\": \"\",\r\n \"total_withdrawals\": \"\",\r\n \"is_phone_confirmed\": \"\",\r\n \"money_in_money_out\": \"\",\r\n \"last_deposit_amount\": \"\",\r\n \"last_freespins_date\": \"\",\r\n \"last_freespins_name\": \"\",\r\n \"last_free_bonus_date\": \"\",\r\n \"last_free_bonus_name\": \"\",\r\n \"total_bonuses_amount\": \"\",\r\n \"last_freespins_amount\": \"\",\r\n \"last_freespins_status\": \"\",\r\n \"last_real_bets_amount\": \"\",\r\n \"last_real_wins_amount\": \"\",\r\n \"total_deposits_amount\": \"\",\r\n \"last_bonus_bets_amount\": \"\",\r\n \"last_bonus_wins_amount\": \"\",\r\n \"last_free_bonus_amount\": \"\",\r\n \"last_free_bonus_status\": \"\",\r\n \"last_deposit_bonus_date\": \"\",\r\n \"last_deposit_bonus_name\": \"\",\r\n \"last_freespins_currency\": \"\",\r\n \"last_freespins_wagering\": \"\",\r\n \"withdrawals_to_deposits\": \"\",\r\n \"last_free_bonus_currency\": \"\",\r\n \"last_free_bonus_wagering\": \"\",\r\n \"total_withdrawals_amount\": \"\",\r\n \"withdrawal_ewallet_email\": \"\",\r\n \"last_deposit_bonus_amount\": \"\",\r\n \"last_deposit_bonus_status\": \"\",\r\n \"last_deposit_bonus_currency\": \"\",\r\n \"last_deposit_bonus_wagering\": \"\",\r\n \"session\": \"\",\r\n \"payment_mode\": \"\",\r\n \"card_fullname\": \"\",\r\n \"card_bin\": \"\",\r\n \"card_hash\": \"\",\r\n \"card_last\": \"\",\r\n \"card_expire\": \"\",\r\n \"avs_result\": \"\",\r\n \"cvv_result\": \"\",\r\n \"sca_method\": \"\",\r\n \"user_bank_account\": \"\",\r\n \"user_bank_name\": \"\",\r\n \"user_balance\": \"\",\r\n \"user_verification_level\": \"\",\r\n \"status_3d\": \"\",\r\n \"regulation\": \"\",\r\n \"payment_provider\": \"\",\r\n \"phone_number\": \"\",\r\n \"transaction_type\": \"\",\r\n \"transaction_amount\": \"\",\r\n \"transaction_currency\": \"\",\r\n \"merchant_id\": \"\",\r\n \"details_url\": \"\",\r\n \"name\": \"\",\r\n \"person_type\": \"\",\r\n \"gender\": \"\"\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"https://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":"6c6da9c3-8258-4240-aa11-a9dde6966fdc","name":"TrustScoreExists","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"requiredinput\": {\r\n \"ip\": \"2001:8004:cc2:fadb:9958:4523:6c42:e3f2\",\r\n \"email\": \"test@gmail.com\",\r\n \"url\": \"http://test.com\"\r\n },\r\n \"optionalInput\": {\r\n \"last_bets\": null,\r\n \"last_wins\": \"\",\r\n \"total_bonuses\": \"\",\r\n \"last_real_bets\": \"\",\r\n \"last_real_wins\": \"\",\r\n \"total_deposits\": \"\",\r\n \"last_bonus_bets\": \"\",\r\n \"last_bonus_wins\": \"\",\r\n \"average_real_bet\": \"\",\r\n \"last_bets_amount\": \"\",\r\n \"last_wins_amount\": \"\",\r\n \"average_bonus_bet\": \"\",\r\n \"bonus_to_deposits\": \"\",\r\n \"last_deposit_date\": \"\",\r\n \"total_withdrawals\": \"\",\r\n \"is_phone_confirmed\": \"\",\r\n \"money_in_money_out\": \"\",\r\n \"last_deposit_amount\": \"\",\r\n \"last_freespins_date\": \"\",\r\n \"last_freespins_name\": \"\",\r\n \"last_free_bonus_date\": \"\",\r\n \"last_free_bonus_name\": \"\",\r\n \"total_bonuses_amount\": \"\",\r\n \"last_freespins_amount\": \"\",\r\n \"last_freespins_status\": \"\",\r\n \"last_real_bets_amount\": \"\",\r\n \"last_real_wins_amount\": \"\",\r\n \"total_deposits_amount\": \"\",\r\n \"last_bonus_bets_amount\": \"\",\r\n \"last_bonus_wins_amount\": \"\",\r\n \"last_free_bonus_amount\": \"\",\r\n \"last_free_bonus_status\": \"\",\r\n \"last_deposit_bonus_date\": \"\",\r\n \"last_deposit_bonus_name\": \"\",\r\n \"last_freespins_currency\": \"\",\r\n \"last_freespins_wagering\": \"\",\r\n \"withdrawals_to_deposits\": \"\",\r\n \"last_free_bonus_currency\": \"\",\r\n \"last_free_bonus_wagering\": \"\",\r\n \"total_withdrawals_amount\": \"\",\r\n \"withdrawal_ewallet_email\": \"\",\r\n \"last_deposit_bonus_amount\": \"\",\r\n \"last_deposit_bonus_status\": \"\",\r\n \"last_deposit_bonus_currency\": \"\",\r\n \"last_deposit_bonus_wagering\": \"\",\r\n \"session\": \"\",\r\n \"payment_mode\": \"\",\r\n \"card_fullname\": \"\",\r\n \"card_bin\": \"\",\r\n \"card_hash\": \"\",\r\n \"card_last\": \"\",\r\n \"card_expire\": \"\",\r\n \"avs_result\": \"\",\r\n \"cvv_result\": \"\",\r\n \"sca_method\": \"\",\r\n \"user_bank_account\": \"\",\r\n \"user_bank_name\": \"\",\r\n \"user_balance\": \"\",\r\n \"user_verification_level\": \"\",\r\n \"status_3d\": \"\",\r\n \"regulation\": \"\",\r\n \"payment_provider\": \"\",\r\n \"phone_number\": \"\",\r\n \"transaction_type\": \"\",\r\n \"transaction_amount\": \"\",\r\n \"transaction_currency\": \"\",\r\n \"merchant_id\": \"\",\r\n \"details_url\": \"\",\r\n \"name\": \"\",\r\n \"person_type\": \"\",\r\n \"gender\": \"\"\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"{{StagingBaseURL}}/checkTransAllowed"},"status":"Accepted","code":202,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Sun, 29 Oct 2023 09:21:22 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"Cache-Control","value":"no-cache, no-store, max-age=0, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Expires","value":"0"},{"key":"X-Frame-Options","value":"DENY"},{"key":"CF-Cache-Status","value":"DYNAMIC"},{"key":"Report-To","value":"{\"endpoints\":[{\"url\":\"https:\\/\\/a.nel.cloudflare.com\\/report\\/v3?s=r2%2FuLwSilxdD1lpiI1VqpgF0Tu9etiNhupySeBHl0zcU8XV1z8kwR%2FJ00ti4xpMdrTXW%2BkqZkLGrkkaUnMWFsaYlg%2FfA9UC4wIKwmc9LHUwna491EmnC3b3vlabzhUJ11CMpnVmicUE%3D\"}],\"group\":\"cf-nel\",\"max_age\":604800}"},{"key":"NEL","value":"{\"success_fraction\":0,\"report_to\":\"cf-nel\",\"max_age\":604800}"},{"key":"Server","value":"cloudflare"},{"key":"CF-RAY","value":"81da590e8d4345a0-LHR"},{"key":"alt-svc","value":"h3=\":443\"; ma=86400"}],"cookie":[],"responseTime":null,"body":"{\n \"transactionAllowed\": \"YES\"\n}"},{"id":"ccd0a2af-a5fb-4d02-9fef-78c57e818ce9","name":"TrustScoreError","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"requiredinput\": {\r\n \"ip\": \"2001:8004:cc2:fadb:9958:4523:6c42:e3f2\",\r\n \"email\": \"test@gmail.com\",\r\n \"url\": \"http://test.com\"\r\n },\r\n \"optionalInput\": {\r\n \"last_bets\": null,\r\n \"last_wins\": \"\",\r\n \"total_bonuses\": \"\",\r\n \"last_real_bets\": \"\",\r\n \"last_real_wins\": \"\",\r\n \"total_deposits\": \"\",\r\n \"last_bonus_bets\": \"\",\r\n \"last_bonus_wins\": \"\",\r\n \"average_real_bet\": \"\",\r\n \"last_bets_amount\": \"\",\r\n \"last_wins_amount\": \"\",\r\n \"average_bonus_bet\": \"\",\r\n \"bonus_to_deposits\": \"\",\r\n \"last_deposit_date\": \"\",\r\n \"total_withdrawals\": \"\",\r\n \"is_phone_confirmed\": \"\",\r\n \"money_in_money_out\": \"\",\r\n \"last_deposit_amount\": \"\",\r\n \"last_freespins_date\": \"\",\r\n \"last_freespins_name\": \"\",\r\n \"last_free_bonus_date\": \"\",\r\n \"last_free_bonus_name\": \"\",\r\n \"total_bonuses_amount\": \"\",\r\n \"last_freespins_amount\": \"\",\r\n \"last_freespins_status\": \"\",\r\n \"last_real_bets_amount\": \"\",\r\n \"last_real_wins_amount\": \"\",\r\n \"total_deposits_amount\": \"\",\r\n \"last_bonus_bets_amount\": \"\",\r\n \"last_bonus_wins_amount\": \"\",\r\n \"last_free_bonus_amount\": \"\",\r\n \"last_free_bonus_status\": \"\",\r\n \"last_deposit_bonus_date\": \"\",\r\n \"last_deposit_bonus_name\": \"\",\r\n \"last_freespins_currency\": \"\",\r\n \"last_freespins_wagering\": \"\",\r\n \"withdrawals_to_deposits\": \"\",\r\n \"last_free_bonus_currency\": \"\",\r\n \"last_free_bonus_wagering\": \"\",\r\n \"total_withdrawals_amount\": \"\",\r\n \"withdrawal_ewallet_email\": \"\",\r\n \"last_deposit_bonus_amount\": \"\",\r\n \"last_deposit_bonus_status\": \"\",\r\n \"last_deposit_bonus_currency\": \"\",\r\n \"last_deposit_bonus_wagering\": \"\",\r\n \"session\": \"\",\r\n \"payment_mode\": \"\",\r\n \"card_fullname\": \"\",\r\n \"card_bin\": \"\",\r\n \"card_hash\": \"\",\r\n \"card_last\": \"\",\r\n \"card_expire\": \"\",\r\n \"avs_result\": \"\",\r\n \"cvv_result\": \"\",\r\n \"sca_method\": \"\",\r\n \"user_bank_account\": \"\",\r\n \"user_bank_name\": \"\",\r\n \"user_balance\": \"\",\r\n \"user_verification_level\": \"\",\r\n \"status_3d\": \"\",\r\n \"regulation\": \"\",\r\n \"payment_provider\": \"\",\r\n \"phone_number\": \"\",\r\n \"transaction_type\": \"\",\r\n \"transaction_amount\": \"\",\r\n \"transaction_currency\": \"\",\r\n \"merchant_id\": \"\",\r\n \"details_url\": \"\",\r\n \"name\": \"\",\r\n \"person_type\": \"\",\r\n \"gender\": \"\"\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"{{StagingBaseURL}}/checkTransAllowed"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Sun, 29 Oct 2023 09:28:33 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"Cache-Control","value":"no-cache, no-store, max-age=0, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Expires","value":"0"},{"key":"X-Frame-Options","value":"DENY"},{"key":"CF-Cache-Status","value":"DYNAMIC"},{"key":"Report-To","value":"{\"endpoints\":[{\"url\":\"https:\\/\\/a.nel.cloudflare.com\\/report\\/v3?s=herXY1o%2BFZa%2F3qNFjvh4ANgP%2FD0DdAVVFm0vUZDAst2rFkieItm%2Fu0VN24DYrdp7MHMHFKWLvrsBYVIxjDPDaLgJjeGBvlTP2iZoB5EnG1hPPHUVXRNP%2FGMmOTh%2Fp7gsyj0vihW1kMk%3D\"}],\"group\":\"cf-nel\",\"max_age\":604800}"},{"key":"NEL","value":"{\"success_fraction\":0,\"report_to\":\"cf-nel\",\"max_age\":604800}"},{"key":"Server","value":"cloudflare"},{"key":"CF-RAY","value":"81da6398ab144913-LHR"},{"key":"alt-svc","value":"h3=\":443\"; ma=86400"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Incorrect secret_key\",\n \"code\": \"authentication_failed\"\n}"}],"_postman_id":"70af9b19-5d76-4a1f-8397-dcc605f4ccb9"}],"id":"6bd659e2-2e4c-470f-94c2-4c67d6e2ea89","_postman_id":"6bd659e2-2e4c-470f-94c2-4c67d6e2ea89","description":""},{"name":"Cashier APIs","item":[{"name":"Customer","id":"be050c68-c4f6-4e79-a337-4bd449f8116b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"Bearer Token","type":"text"},{"key":"BrandId","value":"brand_id_value","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"fullName\": \"Rahul Agarwal\",\r\n \"emailId\": \"rahul+26@paysecure.net\",\r\n \"dateOfBirth\": \"1994-06-03\",\r\n \"phoneNo\": \"+91 797639082\",\r\n \"city\": \"Jaipur\",\r\n \"stateCode\": \"RJ\",\r\n \"zipCode\": \"302018\",\r\n \"address\": \"House Number 53, Vaishali Nagar, Jaipur\",\r\n \"country\": \"IN\",\r\n \"merchantCustomerId\": \"rahultestcustomer@paysecure.net\",\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

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

Parameter	Type	Description	Example
merchantCustomerId	String	unique customer ID provided by merchant. This can be email, mobile or an alphanumeric string	rahultestcustomer@paysecure.net
fullName	String	Full name of the customer.	Rahul Agarwal
emailId	String	Email address of the customer.	test@paysecure.net
dateOfBirth	String	Customer's date of birth in YYYY-MM-DD format.	1995-38-27
phoneNo	String	Customer's phone number. Preferred with the country code	+91 797639082
city	String	City of the customer.	Jaipur
stateCode	String	State code of the customer.	RJ
zipCode	String	Postal code of the customer's location.	302018
address	String	Full address of the customer.	House Number 53, Vaishali Nagar, Jaipur
country	String	Country code (ISO 3166-1 alpha-2).	IN
custRegDate	Sting	Customer registration date on merchant site in YYYY-MM-DD format.	2023-12-27
successTxn	String	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":"39385696-c1f8-4c25-9138-83ebab949b90","id":"39385696-c1f8-4c25-9138-83ebab949b90","name":"Cashier APIs","type":"folder"}},"urlObject":{"protocol":"https","path":["api","v1","customer"],"host":["api","paysecure","net"],"query":[],"variable":[]}},"response":[{"id":"12c54dec-3229-4bd6-93cb-82aa57eef674","name":"Success","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"*/*","type":"text"},{"key":"BrandId","value":"brand_id_value","description":"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 Token","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"fullName\": \"Rahul Agarwal\",\r\n \"emailId\": \"rahul+26@paysecure.net\",\r\n \"dateOfBirth\": \"1994-06-03\",\r\n \"phoneNo\": \"+91 797639082\",\r\n \"city\": \"Jaipur\",\r\n \"stateCode\": \"RJ\",\r\n \"zipCode\": \"302018\",\r\n \"address\": \"House Number 53, Vaishali Nagar, Jaipur\",\r\n \"country\": \"IN\",\r\n \"merchantCustomerId\": \"rahultestcustomer@paysecure.net\",\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":null,"header":null,"cookie":[],"responseTime":null,"body":"{\r\n \"customerId\": \"691afbc6fd96d34a8113a34d\",\r\n \"merchantCustomerId\": \"rahultestcustomer@paysecure.net\",\r\n \"fullName\": \"Rahul Agarwal\",\r\n \"emailId\": \"rahul+26@paysecure.net\",\r\n \"dateOfBirth\": \"1994-06-03\",\r\n \"phoneNo\": \"+91 797639082\",\r\n \"brandID\": \"1d666074-39be-4b90-aec9-e9de78fbdcb9\",\r\n \"city\": \"Jaipur\",\r\n \"zipCode\": \"302018\",\r\n \"address\": \"House Number 53, Vaishali Nagar, Jaipur\",\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":"a1a035e9-ce0d-48bb-81b7-49891e24ae4e","name":"Failure","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"*/*","type":"text"},{"key":"BrandId","value":"brand_id_value","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 Token","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"fullName\": \"Rahul Agarwal\",\r\n \"emailId\": \"rahul+26@paysecure.net\",\r\n \"dateOfBirth\": \"1994-06-03\",\r\n \"phoneNo\": \"+91 797639082\",\r\n \"city\": \"Jaipur\",\r\n \"stateCode\": \"RJ\",\r\n \"zipCode\": \"302018\",\r\n \"address\": \"House Number 53, Vaishali Nagar, Jaipur\",\r\n \"country\": \"IN\",\r\n \"merchantCustomerId\": \"rahultestcustomer@paysecure.net\",\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":null,"header":null,"cookie":[],"responseTime":null,"body":"{\r\n \"message\": \"Invalid Email Format\",\r\n \"code\": \"invalid_email\"\r\n}"},{"id":"66d30d24-5638-4eb0-bd9b-8d2248c13a63","name":"Existing Customer","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"*/*","type":"text"},{"key":"BrandId","value":"brand_id_value","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 Token","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"fullName\": \"Rahul Agarwal\",\r\n \"emailId\": \"rahul+26@paysecure.net\",\r\n \"dateOfBirth\": \"1994-06-03\",\r\n \"phoneNo\": \"+91 797639082\",\r\n \"city\": \"Jaipur\",\r\n \"stateCode\": \"RJ\",\r\n \"zipCode\": \"302018\",\r\n \"address\": \"House Number 53, Vaishali Nagar, Jaipur\",\r\n \"country\": \"IN\",\r\n \"merchantCustomerId\": \"rahultestcustomer@paysecure.net\",\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":null,"header":null,"cookie":[],"responseTime":null,"body":"{\r\n \"message\": \"Customer already exists with this information\",\r\n \"code\": \"customer_already_exists\"\r\n}"}],"_postman_id":"be050c68-c4f6-4e79-a337-4bd449f8116b"},{"name":"Customer","id":"5e2280ab-a513-4bf2-a151-602aeeb06668","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer Token","type":"text"},{"key":"BrandId","value":"brand_id_value","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"*/*","type":"text"}],"body":{"mode":"raw","raw":"{\n \"merchantCustomerId\": \"rahultestcustomer1@paysecure.net\"\n}","options":{"raw":{"language":"json"}}},"url":"https://app.paysecure.net/api/v1/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.

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":"f3da594a-96db-4ae7-8d2d-ae9624170fdb","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"PATCH","header":[{"key":"Authorization","value":"Bearer Token","type":"text"},{"key":"BrandId","value":"brand_id_value","type":"text"},{"key":"Accept","value":"*/*","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"fullName\": \"Gouri Shankar3\",\n \"emailId\": \"gouri@paysecure.com\",\n \"dateOfBirth\": \"1990-11-27\",\n \"phoneNo\": \"+91 9413666514\",\n \"city\": \"Dausa\",\n \"stateCode\": \"Raj\",\n \"zipCode\": \"202021\",\n \"address\": \"Somnath Nagar\",\n \"country\": \"IN\",\n \"CustRegDate\": \"2023-12-28\",\n \"SuccessTxn\": \"33\"\n}","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":{"protocol":"https","path":["api","v1","{PaysecureCustomerId}","patchCustomer"],"host":["api","paysecure","net"],"query":[],"variable":[]}},"response":[{"id":"184c81b5-e8e4-4419-b2b0-e493acd691bc","name":"Success","originalRequest":{"method":"PATCH","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"*/*","type":"text"},{"key":"BrandId","value":"brand_id_value","type":"text"},{"key":"Authorisation","value":"Bearer Token","type":"text"}],"body":{"mode":"raw","raw":"{\n \"fullName\": \"Gouri Shankar3\",\n \"emailId\": \"gouri@paysecure.com\",\n \"dateOfBirth\": \"1990-11-27\",\n \"phoneNo\": \"+91 9413666514\",\n \"city\": \"Dausa\",\n \"stateCode\": \"Raj\",\n \"zipCode\": \"202021\",\n \"address\": \"Somnath Nagar\",\n \"country\": \"IN\",\n \"CustRegDate\": \"2023-12-28\",\n \"SuccessTxn\": \"33\",\n \"extraParam\": {\n \"param1\": \"value1\",\n \"param2\": \"value2\",\n \"param3\": \"value3\",\n \"param4\": \"value4\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://api.paysecure.net/api/v1/{PaysecureCustomerId}/patchCustomer"},"status":"OK","code":200,"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\n \"customerId\": \"691afbc6fd96d34a8113a34d\",\n \"merchantCustomerId\": \"rahultestcustomer1@paysecure.net\",\n \"fullName\": \"Gouri Shankar3\",\n \"emailId\": \"gouri@paysecure.com\",\n \"dateOfBirth\": \"1990-11-27\",\n \"phoneNo\": \"+91 9413666514\",\n \"brandID\": \"brandID\",\n \"city\": \"Dausa\",\n \"zipCode\": \"202021\",\n \"address\": \"Somnath Nagar\",\n \"country\": \"IN\",\n \"stateCode\": \"Raj\",\n \"custRegDate\": \"2023-12-28\",\n \"successTrans\": 0,\n \"createdOn\": 1763376070,\n \"lastUpdated\": 1763377024,\n \"lastActivity\": 1763377024,\n \"extraParam\": {\n \"param1\": \"value1\",\n \"param2\": \"value2\",\n \"param3\": \"value3\",\n \"param4\": \"value4\"\n }\n}"}],"_postman_id":"f3da594a-96db-4ae7-8d2d-ae9624170fdb"},{"name":"Purchase Session","id":"ea6df254-ce23-43bd-a5bf-73bb504db037","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"Bearer Token","type":"text"},{"key":"BrandId","value":"30f7ce6e-3b7e-46a2-9b50-484fc55be689","type":"text"},{"key":"Accept","value":"*/*","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"customerId\": \"68fed1855ebbe829416b08c6\",\r\n \"merchantRef\": \"rahultestcustomer1@paysecure.net\", // optional\r\n \"currency\": \"EUR\",\r\n \"products\": [\r\n {\r\n \"name\": \"Product1\",\r\n \"price\": \"10\"\r\n },\r\n {\r\n \"name\": \"Product2\",\r\n \"price\": \"12\"\r\n }\r\n ],\r\n \"totalAmount\": \"22\", // optional, but if present have precedence over sum of prices mentioned above.\r\n \"paymentMethod\": \"VISA\", //optional\r\n \"success_redirect\": \"https://merchant-success-page.com/\",\r\n \"failure_redirect\": \"https://merchant-failure-page.com/\",\r\n \"pending_redirect\": \"https://merchant-pending-page.com/\",\r\n \"success_callback\": \"https://your.success.callback.com\",\r\n \"failure_callback\": \"https://your.failure.callback.com\",\r\n \"extraParam\": {\r\n \"param1\": \"value1\",\r\n \"showCryptoConversion\": \"yes\",\r\n \"cryptoCurrencies\": \"[\\\"BTC\\\",\\\"ETH\\\",\\\"USDT\\\",\\\"XRP\\\",\\\"LTC\\\",\\\"DOGE\\\",\\\"ETC\\\",\\\"BNB\\\",\\\"USDC\\\",\\\"SOL\\\",\\\"ADA\\\",\\\"BCH\\\",\\\"DASH\\\",\\\"BTG\\\",\\\"ZEC\\\",\\\"DGB\\\",\\\"EOS\\\",\\\"XLM\\\",\\\"TRX\\\",\\\"QTUM\\\",\\\"POL\\\",\\\"SHIB\\\",\\\"LINK\\\",\\\"DAI\\\",\\\"TON\\\",\\\"AVAX\\\",\\\"FDUSD\\\",\\\"ARB\\\",\\\"OP\\\"]\",\r\n \"param3\": \"value3\",\r\n \"param4\": \"value4\"\r\n }\r\n }","options":{"raw":{"language":"json"}}},"url":"https://api.paysecure.net/api/v1/createSession","description":"

OVERIEW

The createSession API is designed to initiate a payment session for a customer after their profile has been created via the createCustomer API. The session is automatically generated at the backend on the merchant’s checkout URL. This session allows the customer to continue with their transaction without having to manually interact with the session URL, and ensures the session remains active until the payment is completed or the session expires.

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

Mandatory Parameters

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

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

Show Crypto Conversion

Additionally, there are some default extra parameters that you can pass for allowing Crypto Conversion on 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

\n","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"39385696-c1f8-4c25-9138-83ebab949b90","id":"39385696-c1f8-4c25-9138-83ebab949b90","name":"Cashier APIs","type":"folder"}},"urlObject":{"protocol":"https","path":["api","v1","createSession"],"host":["api","paysecure","net"],"query":[],"variable":[]}},"response":[{"id":"d7d93987-9b58-4a37-af08-e00d7a97eb3f","name":"Success","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"*/*","type":"text"},{"key":"BrandId","value":"brand_id_value","description":"it is mandatory to pass the BrandId in header for each createSession request. ","type":"text"},{"key":"Authorization","value":"Bearer Token","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"customerId\": \"68fed1855ebbe829416b08c6\",\r\n \"merchantRef\": \"rahultestcustomer1@paysecure.net\", // optional\r\n \"currency\": \"EUR\",\r\n \"products\": [\r\n {\r\n \"name\": \"Product1\",\r\n \"price\": \"10\"\r\n },\r\n {\r\n \"name\": \"Product2\",\r\n \"price\": \"12\"\r\n }\r\n ],\r\n \"totalAmount\": \"22\", // optional, but if present have precedence over sum of prices mentioned above.\r\n \"paymentMethod\": \"VISA\", //optional\r\n \"success_redirect\": \"https://merchant-success-page.com/\",\r\n \"failure_redirect\": \"https://merchant-failure-page.com/\",\r\n \"pending_redirect\": \"https://merchant-pending-page.com/\",\r\n \"success_callback\": \"https://your.success.callback.com\",\r\n \"failure_callback\": \"https://your.failure.callback.com\",\r\n \"extraParam\": {\r\n \"param1\": \"value1\",\r\n \"param3\": \"value3\",\r\n \"param4\": \"value4\"\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.paysecure.net/api/v1/createSession"},"status":"OK","code":200,"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\r\n \"sessionUrl\": \"https://api.paysecure.net/payment-session/691b02b48c73dd76eedaa379/\",\r\n \"brandId\": \"brand_id_value\",\r\n \"customerId\": \"68fed1855ebbe829416b08c6\",\r\n \"sessionId\": \"691b02b48c73dd76eedaa379\",\r\n \"expiryOn\": 1763378744,\r\n \"createdOn\": 1763377844\r\n}"},{"id":"fb5a008e-b58c-44d1-a249-e8ca6a879bb1","name":"Session with CryptoConversion","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"*/*","type":"text"},{"key":"BrandId","value":"brand_id_value","description":"it is mandatory to pass the BrandId in header for each createSession request. ","type":"text"},{"key":"Authorization","value":"Bearer Token","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"customerId\": \"68fed1855ebbe829416b08c6\",\r\n \"merchantRef\": \"rahultestcustomer1@paysecure.net\", // optional\r\n \"currency\": \"EUR\",\r\n \"products\": [\r\n {\r\n \"name\": \"Product1\",\r\n \"price\": \"10\"\r\n },\r\n {\r\n \"name\": \"Product2\",\r\n \"price\": \"12\"\r\n }\r\n ],\r\n \"totalAmount\": \"22\", // optional, but if present have precedence over sum of prices mentioned above.\r\n \"paymentMethod\": \"VISA\", //optional\r\n \"success_redirect\": \"https://merchant-success-page.com/\",\r\n \"failure_redirect\": \"https://merchant-failure-page.com/\",\r\n \"pending_redirect\": \"https://merchant-pending-page.com/\",\r\n \"success_callback\": \"https://your.success.callback.com\",\r\n \"failure_callback\": \"https://your.failure.callback.com\",\r\n \"extraParam\": {\r\n \"param1\": \"value1\",\r\n \"showCryptoConversion\": \"yes\",\r\n \"cryptoCurrencies\": \"[\\\"BTC\\\",\\\"ETH\\\",\\\"USDT\\\",\\\"XRP\\\",\\\"LTC\\\",\\\"DOGE\\\",\\\"ETC\\\",\\\"BNB\\\",\\\"USDC\\\",\\\"SOL\\\",\\\"ADA\\\",\\\"BCH\\\",\\\"DASH\\\",\\\"BTG\\\",\\\"ZEC\\\",\\\"DGB\\\",\\\"EOS\\\",\\\"XLM\\\",\\\"TRX\\\",\\\"QTUM\\\",\\\"POL\\\",\\\"SHIB\\\",\\\"LINK\\\",\\\"DAI\\\",\\\"TON\\\",\\\"AVAX\\\",\\\"FDUSD\\\",\\\"ARB\\\",\\\"OP\\\"]\",\r\n \"param3\": \"value3\",\r\n \"param4\": \"value4\"\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.paysecure.net/api/v1/createSession"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"sessionUrl\": \"https://api.paysecure.net/payment-session/691b02b48c73dd76eedaa379/\",\n \"brandId\": \"brand_id_value\",\n \"customerId\": \"68fed1855ebbe829416b08c6\",\n \"sessionId\": \"691b02b48c73dd76eedaa379\",\n \"expiryOn\": 1763378744,\n \"createdOn\": 1763377844\n}"},{"id":"7b3a6d7e-5e11-4ff4-8e89-4d62fa7d007a","name":"Invalid Session","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"*/*","type":"text"},{"key":"BrandId","value":"brand_id_value","description":"it is mandatory to pass the BrandId in header for each createSession request. ","type":"text"},{"key":"Authorization","value":"Bearer Token","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"customerId\": \"68fed1855ebbe829416b08c6\",\r\n \"merchantRef\": \"rahultestcustomer1@paysecure.net\", // optional\r\n \"currency\": \"EUR\",\r\n \"products\": [\r\n {\r\n \"name\": \"Product1\",\r\n \"price\": \"10\"\r\n },\r\n {\r\n \"name\": \"Product2\",\r\n \"price\": \"12\"\r\n }\r\n ],\r\n \"totalAmount\": \"22\", // optional, but if present have precedence over sum of prices mentioned above.\r\n \"paymentMethod\": \"VISA\", //optional\r\n \"success_redirect\": \"https://merchant-success-page.com/\",\r\n \"failure_redirect\": \"https://merchant-failure-page.com/\",\r\n \"pending_redirect\": \"https://merchant-pending-page.com/\",\r\n \"success_callback\": \"https://your.success.callback.com\",\r\n \"failure_callback\": \"https://your.failure.callback.com\",\r\n \"extraParam\": {\r\n \"param1\": \"value1\",\r\n \"param3\": \"value3\",\r\n \"param4\": \"value4\"\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.paysecure.net/api/v1/createSession"},"status":"Bad Request","code":400,"_postman_previewlanguage":null,"header":null,"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":"ea6df254-ce23-43bd-a5bf-73bb504db037"},{"name":"Payout Session","id":"ce4f0a35-d3d8-4faa-afd8-0a65a83611dd","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"Bearer Token","type":"text"},{"key":"BrandId","value":"brand_id_value","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"*/*","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"customerId\": \"67c9983fba18400ab6cceb8f\",\r\n \"currency\": \"USD\",\r\n \"products\": [\r\n {\r\n \"name\": \"Product1\",\r\n \"price\": \"2\"\r\n }\r\n ],\r\n \"totalAmount\": \"2\",\r\n \"tax_amount\": \"\", // optional\r\n \"tax_percent\": \"\", // optional\r\n \"type\": \"payout\",\r\n \"success_redirect\": \"https://your.success.redirect.com\",\r\n \"pending_redirect\": \"https://your.pending.redirect.com\",\r\n \"failure_redirect\": \"https://your.failure.redirect.com\",\r\n \"success_callback\": \"https://your.success.callback.com\",\r\n \"failure_callback\": \"https://your.failure.callback.com\",\r\n \"extraParam\": {\r\n \"showCryptoConversion\": \"yes\",\r\n \"cryptoCurrencies\": \"[\\\"BTC\\\",\\\"ETH\\\",\\\"USDT\\\",\\\"XRP\\\",\\\"LTC\\\",\\\"DOGE\\\",\\\"ETC\\\",\\\"BNB\\\",\\\"USDC\\\",\\\"SOL\\\",\\\"ADA\\\",\\\"BCH\\\",\\\"DASH\\\",\\\"BTG\\\",\\\"ZEC\\\",\\\"DGB\\\",\\\"EOS\\\",\\\"XLM\\\",\\\"TRX\\\",\\\"QTUM\\\",\\\"POL\\\",\\\"SHIB\\\",\\\"LINK\\\",\\\"DAI\\\",\\\"TON\\\",\\\"AVAX\\\",\\\"FDUSD\\\",\\\"ARB\\\",\\\"OP\\\"]\"\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.paysecure.net/api/v1/createSession","description":"

This API is used to initiate a payout session for a customer. By passing the customerId (generated via the createCustomer API) and specifying \"type\": \"payout\", a payout session is started.
A sessionURL is returned in the response, which can be used to redirect the customer to the payout cashier. The customer can then select the payment 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\": \"brand_id_value\",\n    \"customerId\": \"67c9983fba18400ab6cceb8f\",\n    \"sessionId\": \"68341ad35f895955355d5452\",\n    \"expiryOn\": 1748246103,\n    \"createdOn\": 1748245203\n}\n\n

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

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

\n","urlObject":{"protocol":"https","path":["api","v1","purchases","{Session ID}",""],"host":["api","paysecure","net"],"query":[],"variable":[]}},"response":[],"_postman_id":"25948f09-5487-44f9-9e96-6797baca0f2b"}],"id":"39385696-c1f8-4c25-9138-83ebab949b90","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.

\n","auth":{"type":"noauth","isInherited":false},"event":[{"listen":"prerequest","script":{"id":"d418f8e5-428a-4ab3-9e85-19843b35c14a","type":"text/javascript","packages":{},"requests":{},"exec":[""]}},{"listen":"test","script":{"id":"d030bfe6-8611-4e65-9e84-089e4613094c","type":"text/javascript","packages":{},"requests":{},"exec":[""]}}],"_postman_id":"39385696-c1f8-4c25-9138-83ebab949b90"},{"name":"User Defined Fields (UDF)","item":[],"id":"d0fdda4d-2c44-4877-b817-60c69805c257","description":"

User Defined Fields (also referred to as Merchant Defined Parameters) allow you to attach custom identifiers to transactions. These identifiers can help you map transactions to your internal systems and configure advanced routing rules.

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

\n","_postman_id":"d0fdda4d-2c44-4877-b817-60c69805c257"}],"event":[{"listen":"prerequest","script":{"id":"03b37bdd-4750-4820-b059-4379ad64772f","type":"text/javascript","requests":{},"exec":[""]}},{"listen":"test","script":{"id":"895136c1-845d-4047-9eee-1ad37e74a2d5","type":"text/javascript","requests":{},"exec":[""]}}],"variable":[{"key":"BaseURL","value":"https://api.paysecure.net/api/v1"},{"key":"StagingAPIKey","value":""}]}