Overview
\nThe 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.
\nMandatory parameters in the request body:
\nPlease note:
\n- \n
CSV file should contain the following headers (both mandatory)
\n- \n
card_number
\n \nemail_id
\n \n
\nCSV file should not be empty
\n \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\nOverview
\nThe Original Credit Transaction (OCT), commonly referred to as Push to Card, enables merchants to facilitate near-instantaneous fund transfers directly to a customer’s eligible Visa or Mastercard debit or credit card. Unlike traditional refund processes that can only return funds from a previous purchase, OCT allows for independent disbursements of funds to a cardholder's account.
\nThis feature is designed for high-velocity industries that require frictionless, real-time payouts, such as:
\n- \n
Gaming & Betting: Real-time withdrawal of player winnings.
\n \nMarketplaces: Payouts to sellers or service providers.
\n \nCorporate Disbursements: Instant insurance claims, rebates, or compensation payments.
\n \nMerchant Settlements: Faster access to processed funds for sub-merchants.
\n \n
By utilizing the Paystream /payout API with the PAYOUT-CARDS method, you benefit from a unified orchestration layer that handles the complexities of card network routing, ensuring high success rates and global reach while maintaining the same security standards as your standard payment integrations.
\n
Integration Steps
\n- \n
Enable OCT: Ensure \"Push to Card\" permissions are enabled for your merchant account in the Paystream Merchant Portal.
\n \nCollect Card Details: Collect the recipient's card details securely, or use Paystream's Cashier to collect the card information on your behalf.
\n \nExecute Payout: Call the
\n/payoutendpoint with the OCT-specific payout method. \nHandle Webhooks: Listen for the
\npaidorfailureevents to update your internal records. \n
Mandatory parameters in the request body:
\nNote:
\nIf the merchant is not PCI DSS compliant then they will need to use our cashier and asking the user to enter the card details there. Check the cashier section for more details. If the merchant is PCI DSS compliant then they can use the payout API and send the card details as shown above.
\nIf the merchant wants to use token_reference for doing a payout, then please have a look at the Network Tokenisation Section.
\n","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"80132c34-3d66-4928-b5d2-c5ae181ebe67","id":"80132c34-3d66-4928-b5d2-c5ae181ebe67","name":"APIs","type":"folder"}},"urlObject":{"path":["payout",""],"host":["https://api.paystreamportal.com/api/v1"],"query":[],"variable":[]}},"response":[{"id":"f59aabc2-bcfc-441d-8709-d960564a6688","name":"Success","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer {{APIKey}}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"client\": {\r\n \"email\": \"user3069@example.com\",\r\n \"country\": \"GB\",\r\n \"city\": \"Milford\",\r\n \"stateCode\": \"QLD\",\r\n \"full_name\": \"Reese Moreau\",\r\n \"street_address\": \"13 Documentation Way\",\r\n \"zip_code\": \"68403\",\r\n \"phone\": \"+44 9876543210\",\r\n \"gender\": \"M\",\r\n \"date_of_birth\": \"1970-07-10\"\r\n },\r\n \"purpose\": \"Testing cards payout\",\r\n \"currency\": \"GBP\",\r\n \"merchantRef\": \"YOUR ORDER ID\", // optional\r\n \"payoutMethod\": \"PAYOUT-CARDS\",\r\n \"amount\": 100.0,\r\n \"success_redirect\": \"https://your.success.redirect.com\",\r\n \"pending_redirect\": \"https://your.pending.redirect.com\",\r\n \"failure_redirect\": \"https://your.failure.redirect.com\",\r\n \"success_callback\": \"https://your.success.callback.com\",\r\n \"failure_callback\": \"https://your.failure.callback.com\",\r\n \"extraParam\": {\r\n \"cardNumber\": \"5431240006334004\",\r\n \"cardHolderName\": \"Reese Nakamura\",\r\n \"expiryYear\": \"2030\",\r\n \"expiryMonth\": \"11\"\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.paystreamportal.com/api/v1/payout/"},"status":"Accepted","code":202,"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":"{\r\n \"payoutId\": \"6977137755e0628e3600c562\",\r\n \"client\": {\r\n \"email\": \"user3069@example.com\",\r\n \"country\": \"GB\",\r\n \"city\": \"Milford\",\r\n \"stateCode\": \"QLD\",\r\n \"full_name\": \"Reese Moreau\",\r\n \"street_address\": \"13 Documentation Way\",\r\n \"zip_code\": \"68403\",\r\n \"phone\": \"+44 9876543210\",\r\n \"gender\": \"M\",\r\n \"date_of_birth\": \"1970-07-10\"\r\n },\r\n \"updated_on\": 1769411447,\r\n \"extraParam\": {\r\n \"cardNumber\": \"5431240006334004\",\r\n \"cardHolderName\": \"Reese Nakamura\",\r\n \"expiryYear\": \"2030\",\r\n \"expiryMonth\": \"11\"\r\n },\r\n \"payoutMethod\": \"PAYOUT-CARDS\",\r\n \"amountUnit\": \"MAJOR\",\r\n \"amount\": 100.0,\r\n \"errorMsg\": \"\",\r\n \"purpose\": \"Testing cards payout\",\r\n \"created_on\": 1769411447,\r\n \"merchantRef\": \"YOUR ORDER ID\",\r\n \"status\": \"PAID\",\r\n \"status_history\": [\r\n {\r\n \"status\": \"created\",\r\n \"timestamp\": 1769411447\r\n },\r\n {\r\n \"status\": \"payout_in_process\",\r\n \"timestamp\": 1769411447\r\n },\r\n {\r\n \"status\": \"paid\",\r\n \"timestamp\": 1769411447\r\n },\r\n\r\n ],\r\n \"currency\": \"GBP\",\r\n \"extraFee\": \"0\",\r\n \"paymentOn\": 0,\r\n \"checkout_url\": \"https://api.paystreamportal.com/payout/092e59f94279a3742fa3715fe9a2112a/\",\r\n \"taxAmount\": 0.0,\r\n \"taxPercent\": 0.0,\r\n \"success_redirect\": \"https://your.success.redirect.com\",\r\n \"pending_redirect\": \"https://your.pending.redirect.com\",\r\n \"failure_redirect\": \"https://your.failure.redirect.com\",\r\n \"success_callback\": \"https://your.success.callback.com\",\r\n \"failure_callback\": \"https://your.failure.callback.com\"\r\n \"redirectType\": \"POST\",\r\n \"sessionId\": \"\",\r\n \"surcharge\": 0.0,\r\n \"surchargeType\": \"\",\r\n \"trxMethod\": \"CARDS\",\r\n \"success_callback\": \"https://your.success.callback.com\",\r\n \"failure_callback\": \"https://your.failure.callback.com\"\r\n}"},{"id":"a75019ef-3030-4fc6-b0a7-8f5667abf249","name":"Error","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer {{APIKey}}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"client\": {\r\n \"email\": \"user3069@example.com\",\r\n \"country\": \"GB\",\r\n \"city\": \"Milford\",\r\n \"stateCode\": \"QLD\",\r\n \"full_name\": \"Reese Moreau\",\r\n \"street_address\": \"13 Documentation Way\",\r\n \"zip_code\": \"68403\",\r\n \"phone\": \"+44 9876543210\",\r\n \"gender\": \"M\",\r\n \"date_of_birth\": \"1970-07-10\"\r\n },\r\n \"purpose\": \"Testing cards payout\",\r\n \"currency\": \"GBP\",\r\n \"merchantRef\": \"YOUR ORDER ID\", // optional\r\n \"payoutMethod\": \"PAYOUT-CARDS\",\r\n \"amount\": 100.0,\r\n \"success_redirect\": \"https://your.success.redirect.com\",\r\n \"pending_redirect\": \"https://your.pending.redirect.com\",\r\n \"failure_redirect\": \"https://your.failure.redirect.com\",\r\n \"success_callback\": \"https://your.success.callback.com\",\r\n \"failure_callback\": \"https://your.failure.callback.com\",\r\n \"extraParam\": {\r\n \"cardNumber\": \"5431240006334004\",\r\n \"cardHolderName\": \"Reese Nakamura\",\r\n \"expiryYear\": \"2030\",\r\n \"expiryMonth\": \"11\"\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.paystreamportal.com/api/v1/payout/"},"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":"{\r\n \"payoutId\": \"6977137755e0628e3600c562\",\r\n \"client\": {\r\n \"email\": \"user3069@example.com\",\r\n \"country\": \"GB\",\r\n \"city\": \"Milford\",\r\n \"stateCode\": \"QLD\",\r\n \"full_name\": \"Reese Moreau\",\r\n \"street_address\": \"13 Documentation Way\",\r\n \"zip_code\": \"68403\",\r\n \"phone\": \"+44 9876543210\",\r\n \"gender\": \"M\",\r\n \"date_of_birth\": \"1970-07-10\"\r\n },\r\n \"updated_on\": 1769411447,\r\n \"extraParam\": {\r\n \"cardNumber\": \"5431240006334004\",\r\n \"cardHolderName\": \"Reese Nakamura\",\r\n \"expiryYear\": \"2030\",\r\n \"expiryMonth\": \"11\"\r\n },\r\n \"payoutMethod\": \"PAYOUT-CARDS\",\r\n \"amountUnit\": \"MAJOR\",\r\n \"amount\": 100.0,\r\n \"errorMsg\": \"\",\r\n \"purpose\": \"Testing cards payout\",\r\n \"created_on\": 1769411447,\r\n \"merchantRef\": \"YOUR ORDER ID\",\r\n \"status\": \"error\",\r\n \"status_history\": [\r\n {\r\n \"status\": \"created\",\r\n \"timestamp\": 1769411447\r\n },\r\n {\r\n \"status\": \"error\",\r\n \"timestamp\": 1769411447\r\n },\r\n\r\n ],\r\n \"currency\": \"GBP\",\r\n \"extraFee\": \"0\",\r\n \"paymentOn\": 0,\r\n \"checkout_url\": \"https://api.paystreamportal.com/payout/092e59f94279a3742fa3715fe9a2112a/\",\r\n \"taxAmount\": 0.0,\r\n \"taxPercent\": 0.0,\r\n \"success_redirect\": \"https://your.success.redirect.com\",\r\n \"pending_redirect\": \"https://your.pending.redirect.com\",\r\n \"failure_redirect\": \"https://your.failure.redirect.com\",\r\n \"success_callback\": \"https://your.success.callback.com\",\r\n \"failure_callback\": \"https://your.failure.callback.com\"\r\n \"redirectType\": \"POST\",\r\n \"sessionId\": \"\",\r\n \"surcharge\": 0.0,\r\n \"surchargeType\": \"\",\r\n \"trxMethod\": \"BANKTRANSFER\",\r\n \"success_callback\": \"https://your.success.callback.com\",\r\n \"failure_callback\": \"https://your.failure.callback.com\"\r\n}"}],"_postman_id":"cbe4a504-09d1-4029-a51a-3200034e7700"}],"id":"80132c34-3d66-4928-b5d2-c5ae181ebe67","auth":{"type":"noauth","isInherited":false},"event":[{"listen":"prerequest","script":{"type":"text/javascript","packages":{},"requests":{},"exec":[""],"id":"bb416f93-b752-4694-abcb-084ac6aed185"}},{"listen":"test","script":{"type":"text/javascript","packages":{},"requests":{},"exec":[""],"id":"4452c58c-86b9-49d2-9649-736516a140a9"}}],"_postman_id":"80132c34-3d66-4928-b5d2-c5ae181ebe67","description":""}],"id":"4f57dd5f-7aa2-470c-a8de-6ea5c2334e33","auth":{"type":"noauth","isInherited":false},"event":[{"listen":"prerequest","script":{"type":"text/javascript","packages":{},"exec":[""],"id":"3c20a5bc-5bf0-469b-94d3-62353610e2f9"}},{"listen":"test","script":{"type":"text/javascript","packages":{},"exec":[""],"id":"ee7042c7-6da5-488a-887a-68247a7a8143"}}],"_postman_id":"4f57dd5f-7aa2-470c-a8de-6ea5c2334e33","description":""},{"name":"🏦 Bank Transfers","item":[{"name":"Concepts","item":[],"id":"47a9c482-83e7-48ce-8e2f-3998df4dc4e7","description":"PayIn Flows
\nHow it works
\nPaystream's A2A paying system, utilizes the powerful Virtual Accounts capabilities, enabling you to support a wide range of scenarios using the following methods.
\nKey Steps
\n![](\"https://lh7-us.googleusercontent.com/XMBcrVkVU_Iak6-k1uzllUV3Lr6e_wVP_25CzedW8zYahgDiRS1KmuGMn8obKpQ8DnSrMuNvE4GvFEcoe3_0oeDNnAsGtfGf9EtQnNZpnoFNt9iAuoWtSjBDwXIAm6a3fdeY61GPtXbJUw0d_bGBRIU\")
\n\nFlow
\n- \n
The merchant platform retrieves the account details (Account number, IBAN, and SWIFT code) for the merchant-assigned currency account intended for the PayIn.
\n \nThese account details are then provided to the payer, who is instructed to make the payment to this account.
\n \nThe payer accesses their banking app and inputs the provided account details along with the transaction amount.
\n \nUpon receiving the money from the payer, Paystream 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 \nThe ICN contains all relevant transaction details. Paystream forwards this notification to the merchant to inform them of the transaction.
\n \n
PayOut flows
\nHow it works
Paystream 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
\nFlow
\n- \n
The merchant platform initiates the creation of a payout by passing beneficiary details, along with payout details.
\n \nBeneficiary details include
\n \nBeneficiary ID (email or phone)
\n \nBeneficiary's address (is mandatory but not validated. So if you have this data we recommend you send it, otherwise, use some random value.)
\n \nBeneficiary's bank details
\n \nBeneficiary's name
\n \nUpon completion of the payout, reaching either a Success or Failure state, Paystream notifies the merchant’s platform via webhook, providing the final status of the transaction and additional details.
\n \n
HTTP Response Code
\nYou will not get Error codes if HTTPS response code is 200 or 202.
\nError Codes and Messages
\nwith http code(400,404,401,415,405)
\nBelow is the list of possible error codes and the corresponding messages from Paystream System
\nFormat
\n{\n \"message\": \"descriptive error message\",\n \"code\": \"error_code\"\n}\n\nTo Initiate a payment, the very first call to make is /purchases with the required data in the request body.
To generate a Purchase, you are required to provide the Brand ID (in the request body) and API key (in the header) Both can be located in the Dashboard section of your merchant account login.
The request body structure is shown on the request body of the example request shown here.
\nThe following (see table below) are the mandatory parameters that are required to create a purchase request.
\nMandatory parameters in the request body:
\nOptional Parameters
\nmerchantRef
\nThe merchantRef parameter, although not mandatory, is strongly advised for merchants to specify. Its inclusion offers two significant advantages for the merchant:
- \n
Prevention of Duplicate Requests: When a
\nmerchantRefis utilized, it acts as a unique identifier. This means that if a second purchase request is made using the samemerchantRef(reference number), the system will recognize it and prevent duplicate transactions from occurring. This prevents unintended or duplicate purchases. \nFacilitation of Transaction Retrieval: In situations where the response from the initial purchase request times out or the 'purchaseId' isn't received, having the
\nmerchantRefallows 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.
\nDigital Signature (Optional Parameter) :
\nTo 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.
\nPublic key generation :-
\nSignature generation :-
\nThis 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:-
\nprivate 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\npaymentMethod
\nThe paymentMethod parameter identifies which payment solution merchant wants to use to perform a transaction. If parameter is provided, than Paystream will perform direct payment with the selected payment method instead of loading Paystream URL.
Possible Error Messages
\nNote: For certain use cases, in addition to long format purchase Id, Paystream also provides a 7 digit unique code for each purchase starting with digit 4, eg 4000001
\n“purchaseIdShortCode”: “4000013\"
\n","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"356ddd57-110a-409d-b928-8aaeba82179a","id":"356ddd57-110a-409d-b928-8aaeba82179a","name":"PayIn API","type":"folder"}},"urlObject":{"path":["purchases",""],"host":["https://api.paystreamportal.com/api/v1"],"query":[],"variable":[]}},"response":[{"id":"fec4d00d-b669-4411-9bb1-95a7b3177afb","name":"Success","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer {{APIKey}}"}],"body":{"mode":"raw","raw":"{\r\n \"client\": {\r\n \"email\": \"user5772@example.com\",\r\n \"street_address\": \"13 Documentation Way\",\r\n \"city\": \"Riverton\",\r\n \"full_name\": \"Test test\",\r\n \"zip_code\": \"68403\",\r\n \"country\": \"DE\",\r\n \"date_of_birth\": \"1970-07-10\",\r\n \"stateCode\": \"QLD\",\r\n \"phone\": \"+447755564318\"\r\n },\r\n \"purchase\": {\r\n \"currency\": \"EUR\",\r\n \"products\": [\r\n {\r\n \"name\": \"product name\",\r\n \"price\": \"16\"\r\n }\r\n ]\r\n },\r\n \"merchantRef\": \"your-order-id\",\r\n \"paymentMethod\": \"BANKTRANSFER\",\r\n \"brand_id\": \"your-brand-id\",\r\n \"success_redirect\": \"https://your.success.redirect.com\",\r\n \"pending_redirect\": \"https://your.pending.redirect.com\",\r\n \"failure_redirect\": \"https://your.failure.redirect.com\",\r\n \"success_callback\": \"https://your.success.callback.com\",\r\n \"failure_callback\": \"https://your.failure.callback.com\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.paystreamportal.com/api/v1/purchases"},"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":"{\r\n \"purchaseId\": \"66334635a2cf2a7da7b192ab\",\r\n \"client\": {\r\n \"bank_account\": \"\",\r\n \"bank_code\": \"\",\r\n \"email\": \"user5590@example.com\",\r\n \"phone\": \"+447755564318\",\r\n \"full_name\": \"\",\r\n \"date_of_birth\": \"1970-07-10\",\r\n \"personal_code\": \"\",\r\n \"street_address\": \"asdfsa\",\r\n \"country\": \"GB\",\r\n \"city\": \"a\",\r\n \"zip_code\": \"68403\",\r\n \"shipping_street_address\": \"\",\r\n \"shipping_country\": \"\",\r\n \"shipping_city\": \"\",\r\n \"shipping_zip_code\": \"\",\r\n \"cc\": [],\r\n \"bcc\": [],\r\n \"legal_name\": \"\",\r\n \"brand_name\": \"\",\r\n \"registration_number\": \"\",\r\n \"tax_number\": \"\",\r\n \"documentId\": \"\",\r\n \"documentType\": \"\",\r\n \"bankAccountNumber\": \"\",\r\n \"bankAccount\": \"\",\r\n \"bankCode\": \"\",\r\n \"description\": \"\",\r\n \"stateCode\": \"QLD\"\r\n },\r\n \"updated_on\": 1714636341,\r\n \"type\": \"purchase\",\r\n \"paymentMethod\": \"BANKTRANSFER\",\r\n \"amountUnit\": \"MAJOR\",\r\n \"errorMsg\": \"\",\r\n \"redirectType\": \"GET\",\r\n \"force_recurring\": false,\r\n \"created_on\": 1714636341,\r\n \"merchantRef\": \"66334635a2cf2a7da7b192ab\",\r\n \"merchantName\": \"merchant002\",\r\n \"feesDeducted\": 0.3,\r\n \"purchaseIdShortCode\": “4000013\",\r\n \"purchase\": {\r\n \"currency\": \"JPY\",\r\n \"products\": [\r\n {\r\n \"name\": \"test\",\r\n \"quantity\": 1.0,\r\n \"price\": 5000.0,\r\n \"discount\": 0,\r\n \"tax_percent\": \"0.00\"\r\n }\r\n ],\r\n \"total\": 5000.0,\r\n \"language\": \"en\",\r\n \"notes\": \"\",\r\n \"debt\": 0,\r\n \"total_formatted\": 1.0,\r\n \"request_client_details\": [],\r\n \"timezone\": \"MIT\",\r\n \"email_message\": \"\"\r\n },\r\n \"payment\": {\r\n \"is_outgoing\": false,\r\n \"payment_type\": \"PURCHASE\",\r\n \"amount\": 5000.0,\r\n \"currency\": \"JPY\",\r\n \"net_amount\": 5000.0,\r\n \"fee_amount\": 0.0,\r\n \"pending_amount\": 0.0,\r\n \"pending_unfreeze_on\": null,\r\n \"description\": \"\",\r\n \"paid_on\": 1714636341,\r\n \"remote_paid_on\": 1714636341\r\n },\r\n \"issuer_details\": {\r\n \"website\": \"\",\r\n \"legal_street_address\": \"\",\r\n \"legal_country\": \"\",\r\n \"legal_city\": \"\",\r\n \"legal_zip_code\": \"\",\r\n \"bank_accounts\": [\r\n {\r\n \"bank_account\": \"\",\r\n \"bank_code\": \"\"\r\n }\r\n ],\r\n \"legal_name\": \"gdhnb\",\r\n \"brand_name\": \"gdhnb\",\r\n \"registration_number\": \"\",\r\n \"tax_number\": \"\"\r\n },\r\n \"transaction_data\": {\r\n \"payment_method\": \"\",\r\n \"flow\": \"payform\",\r\n \"extra\": {\r\n \"amount\": 5000.0,\r\n \"masked_pan\": \"BANKTRANSFER\"\r\n },\r\n \"country\": \"\",\r\n \"attempts\": [\r\n {\r\n \"client_ip\": \"203.0.113.80\",\r\n \"type\": \"execute\",\r\n \"payment_method\": \"BANKTRANSFER\",\r\n \"flow\": \"payform\",\r\n \"successful\": true,\r\n \"country\": \"BANKTRANSFER\",\r\n \"processing_time\": 1714636341,\r\n \"extra\": {\r\n \"amount\": 5000.0,\r\n \"masked_pan\": \"BANKTRANSFER\"\r\n }\r\n }\r\n ]\r\n },\r\n \"status\": \"PAYMENT_IN_PROCESS\",\r\n \"status_history\": [\r\n {\r\n \"status\": \"created\",\r\n \"timestamp\": 1714636341\r\n },\r\n {\r\n \"status\": \"pending_execute\",\r\n \"timestamp\": 1714636341\r\n },\r\n {\r\n \"status\": \"payment_in_process\",\r\n \"timestamp\": 1714636341\r\n }\r\n ],\r\n \"is_test\": false,\r\n \"brand_id\": \"your-brand-id\",\r\n \"send_receipt\": false,\r\n \"is_recurring_token\": false,\r\n \"skip_capture\": false,\r\n \"reference_generated\": \"PS8937\",\r\n \"issued\": \"2024-05-02\",\r\n \"due\": 1714636341,\r\n \"refund_upto\": 0,\r\n \"cc_descriptor\": \"\",\r\n \"fraudScore\": \"NA\",\r\n \"trustScore\": \"NA\",\r\n \"payInBankDetails\": {\r\n \"accountName\": \"ｴｱｰｳｵﾚﾂｸｽｼﾞｬﾊﾟﾝｶﾌﾞｼｷｶｲｼｬ\",\r\n \"accountNumber\": \"3194368\",\r\n \"bankName\": \"MUFG BANK, LTD. 三菱UFJ銀行\",\r\n \"swiftCode\": \"BOTKJPJT\",\r\n \"branchName\": \"ワカタケ\",\r\n \"accountType\": \"CHECKING\",\r\n \"payment_routing_parameters\": {\r\n \"BANK_CODE\": \"0005\",\r\n \"BRANCH_CODE\": \"809\"\r\n }\r\n },\r\n \"refund_availability\": \"NONE\",\r\n \"refundable_amount\": 0.0,\r\n \"success_redirect\": \"https://your.success.redirect.com\",\r\n \"failure_redirect\": \"https://your.failure.redirect.com\",\r\n \"cancel_redirect\": \"\",\r\n \"success_callback\": \"https://your.success.callback.com\",\r\n \"failure_callback\": \"https://your.failure.callback.com\",\r\n \"platform\": \"API\",\r\n \"created_from_ip\": \"203.0.113.80\",\r\n \"checkout_url\": \"https://api.paystreamportal.com/payments/66334635a2cf2a7da7b192ab/\"\r\n}"},{"id":"e2370f09-e171-4a45-89a2-db235cf85804","name":"Failure","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer {{APIKey}}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"client\": {\r\n \"email\": \"user5772@example.com\",\r\n \"street_address\": \"13 Documentation Way\",\r\n \"city\": \"Riverton\",\r\n \"full_name\": \"Test test\",\r\n \"zip_code\": \"68403\",\r\n \"country\": \"DE\",\r\n \"date_of_birth\": \"1970-07-10\",\r\n \"stateCode\": \"QLD\",\r\n \"phone\": \"+447755564318\"\r\n },\r\n \"purchase\": {\r\n \"currency\": \"EUR\",\r\n \"products\": [\r\n {\r\n \"name\": \"product name\",\r\n \"price\": \"16\"\r\n }\r\n ]\r\n },\r\n \"merchantRef\": \"your-order-id\",\r\n \"paymentMethod\": \"BANKTRANSFER\",\r\n \"brand_id\": \"your-brand-id\",\r\n \"success_redirect\": \"https://your.success.redirect.com\",\r\n \"pending_redirect\": \"https://your.pending.redirect.com\",\r\n \"failure_redirect\": \"https://your.failure.redirect.com\",\r\n \"success_callback\": \"https://your.success.callback.com\",\r\n \"failure_callback\": \"https://your.failure.callback.com\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.paystreamportal.com/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":"b9bc724f-fc24-4c5c-83c7-670047b8ff17"},{"name":"Get Status","id":"62995d25-9067-4741-adb3-21cb6a510a12","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer {{APIKey}}","type":"text"}],"url":"https://api.paystreamportal.com/api/v1/purchases/{purchaseId}/","description":"This API tells you about all the details of a purchase (PayIn), including its history
\nNote: With respect to bank transfers, the purchase request is synonymous with the PayIn request.
\nMandatory
\nyou need to pass the PurchaseID in the API URL
Possible Value of Status
\nResponse Examples
\nIn the response examples you can see instances of both Paid and Error Status purchases.
Error Details
\nIf there are any issues on the Purchase you can get more details from the transaction_data.attempts.error attribute of the response object
Errors
\nIf there are any errors then it'll be in the format of :
\n{\n \"message\": \"descriptive error message\",\n \"code\": \"error_code\"\n}\n\nPlease see the Status Code section for further details.
\n","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"356ddd57-110a-409d-b928-8aaeba82179a","id":"356ddd57-110a-409d-b928-8aaeba82179a","name":"PayIn API","type":"folder"}},"urlObject":{"path":["purchases","{purchaseId}",""],"host":["https://api.paystreamportal.com/api/v1"],"query":[],"variable":[]}},"response":[{"id":"29e08097-850d-4bfd-a025-fe52d315eba2","name":"Success","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer {{APIKey}}","type":"text"}],"url":"https://api.paystreamportal.com/api/v1/purchases/{purchaseId}/"},"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":"{\r\n \"purchaseId\": \"66c4667bb993c970367c288a\",\r\n \"client\": {\r\n \"email\": \"user1571@example.com\",\r\n \"date_of_birth\": \"1970-07-10\",\r\n \"street_address\": \"13 Documentation Way\",\r\n \"country\": \"IN\",\r\n \"city\": \"Milford\",\r\n \"zip_code\": \"68403\",\r\n \"cc\": [],\r\n \"bcc\": [],\r\n \"stateCode\": \"QLD\"\r\n },\r\n \"updated_on\": 1724147324,\r\n \"type\": \"purchase\",\r\n \"paymentMethod\": \"BANKTRANSFER\",\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\": \"BANKTRANSFER\"\r\n },\r\n \"country\": \"\",\r\n \"attempts\": [\r\n {\r\n \"client_ip\": \"203.0.113.192\",\r\n \"type\": \"execute\",\r\n \"payment_method\": \"BANKTRANSFER\",\r\n \"flow\": \"payform\",\r\n \"successful\": true,\r\n \"country\": \"BANKTRANSFER\",\r\n \"processing_time\": 1724147324,\r\n \"extra\": {\r\n \"amount\": 10.0,\r\n \"masked_pan\": \"BANKTRANSFER\"\r\n }\r\n }\r\n ]\r\n },\r\n \"status\": \"PAID\",\r\n \"status_history\": [\r\n {\r\n \"status\": \"created\",\r\n \"timestamp\": 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 \"status\": \"paid\",\r\n \"timestamp\": 1724147324\r\n }\r\n ],\r\n \"is_test\": false,\r\n \"brand_id\": \"your-brand-id\",\r\n \"send_receipt\": false,\r\n \"is_recurring_token\": false,\r\n \"skip_capture\": false,\r\n \"reference_generated\": \"PS10907\",\r\n \"issued\": \"2024-08-20\",\r\n \"due\": 1724147324,\r\n \"refund_upto\": 1725871728,\r\n \"cc_descriptor\": \"test1\",\r\n \"fraudScore\": \"NA\",\r\n \"trustScore\": \"NA\",\r\n \"refund_availability\": \"NONE\",\r\n \"refundable_amount\": 10.0,\r\n \"success_redirect\": \"https://your.success.redirect.com\",\r\n \"failure_redirect\": \"https://your.failure.redirect.com\",\r\n \"cancel_redirect\": \"\",\r\n \"success_callback\": \"https://your.success.callback.com\",\r\n \"failure_callback\": \"https://your.failure.callback.com\",\r\n \"platform\": \"API\",\r\n \"created_from_ip\": \"203.0.113.192\",\r\n \"checkout_url\": \"https://api.paystreamportal.com/payments/66c4667bb993c970367c288a/\",\r\n \"payoutProcess\": false\r\n}"},{"id":"115e1b15-a28b-4932-8435-b3ff55b1da8e","name":"Failure","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer {{APIKey}}","type":"text"}],"url":"https://api.paystreamportal.com/api/v1/purchases/{purchaseId}/"},"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":"{\r\n \"message\": \"Error Message\",\r\n \"code\": \"error_code\"\r\n}\r\n"}],"_postman_id":"62995d25-9067-4741-adb3-21cb6a510a12"}],"id":"356ddd57-110a-409d-b928-8aaeba82179a","description":"API Flow
\n![](\"https://lh7-us.googleusercontent.com/cfWw_RYZ9eZVEKzKjeRW4I_VwbBTyqH78LUrJG6ulp7FkE1pXVD6DZr9MnQXB9KH_oLFasJDb156naCsBc2bgotPaVY7LtGOJNifpTOb5uks3fjAKpgVhU4dsXQmQ7hFKNFIVhZEl2p8fCN1YufsRaA\"){kind=spacer}
\n\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 \nThe merchant then has 2 options
\n- \n
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 \nOr direct the end-user to our checkout URL, where the client sees bank details for payment.
\n \n
\nAfter 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
To Initiate a payment, the very first call to make is /payout/ with the required data in the request body.
\nTo generate a Payout, you are required to provide the API key (in the header) can be located in the Dashboard section of your merchant account login.
The request body structure is shown on the request body of the example request shown here.
\nThe following (see table below) are the mandatory parameters that are required to create a Payout request.
\nMandatory parameters in the request body:
\nRequired parameters in the request body for this use case:
\n","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"2174b60b-0593-40ab-952a-60a17cb61f8e","id":"2174b60b-0593-40ab-952a-60a17cb61f8e","name":"PayOut API","type":"folder"}},"urlObject":{"path":["payout",""],"host":["https://api.paystreamportal.com/api/v1"],"query":[],"variable":[]}},"response":[{"id":"cfe680c4-c300-42d4-b60f-c31c7c431248","name":"Success","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer {{APIKey}}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"client\": {\r\n \"email\": \"user3069@example.com\",\r\n \"country\": \"AT\",\r\n \"city\": \"Riverton\",\r\n \"stateCode\": \"QLD\",\r\n \"full_name\": \"Test test\",\r\n \"street_address\": \"13 Documentation Way\",\r\n \"zip_code\": \"68403\",\r\n \"phone\": \"+448839471521\",\r\n \"gender\": \"M\",\r\n \"date_of_birth\": \"1970-07-10\"\r\n },\r\n \"beneficiaryDetail\": {\r\n \"bankAccountName\": \"Reese Nakamura\",\r\n \"bankAccountNumber\": \"645101511808\",\r\n \"bankCountryCode\": \"AT\"\r\n },\r\n \"purpose\": \"Testing payout\",\r\n \"currency\": \"EUR\",\r\n \"payoutMethod\": \"PAYOUT-BANKTRANSFER\",\r\n \"amount\": 10.0,\r\n \"brandId\": \"your-brand-id\",\r\n \"success_redirect\": \"https://your.success.redirect.com\",\r\n \"pending_redirect\": \"https://your.pending.redirect.com\",\r\n \"failure_redirect\": \"https://your.failure.redirect.com\",\r\n \"success_callback\": \"https://your.success.callback.com\",\r\n \"failure_callback\": \"https://your.failure.callback.com\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.paystreamportal.com/api/v1/payout/"},"status":"Accepted","code":202,"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":"{\r\n \"payoutId\": \"65ffadb4c1c83822903a9205\",\r\n \"client\": {\r\n \"email\": \"user3069@example.com\",\r\n \"country\": \"DE\",\r\n \"city\": \"Riverton\",\r\n \"stateCode\": \"QLD\",\r\n \"full_name\": \"Test test\",\r\n \"street_address\": \"13 Documentation Way\",\r\n \"zip_code\": \"68403\",\r\n \"phone\": \"+448839471521\",\r\n \"gender\": \"M\",\r\n \"date_of_birth\": \"1970-07-10\"\r\n },\r\n \"updated_on\": 1711254964,\r\n \"payoutMethod\": \"Payout-BANKTRANSFER\",\r\n\t\"beneficiaryDetail\":{\r\n \"bankAccountName\": \"Reese Nakamura\",\r\n \"bankAccountNumber\": \"645101511808\",\r\n \"bankName\": \"ICICI Bank\"\r\n },\r\n \"amountUnit\": \"MAJOR\",\r\n \"amount\": 10.0,\r\n \"errorMsg\": \"Currency Account has insufficient balance.\",\r\n \"purpose\": \"test payout\",\r\n \"created_on\": 1711254972,\r\n \"merchantRef\": \"65ffadb4c1c83822903a9205\",\r\n \"status\": \"PAID\",\r\n \"status_history\": [\r\n {\r\n \"status\": \"created\",\r\n \"timestamp\": 1711254964\r\n },\r\n {\r\n \"status\": \"paid\",\r\n \"timestamp\": 1711254972\r\n }\r\n ],\r\n \"currency\": \"EUR\",\r\n \"success_redirect\": \"https://your.success.redirect.com\",\r\n \"pending_redirect\": \"https://your.pending.redirect.com\",\r\n \"failure_redirect\": \"https://your.failure.redirect.com\",\r\n \"success_callback\": \"https://your.success.callback.com\",\r\n \"failure_callback\": \"https://your.failure.callback.com\"\r\n}\r\n"},{"id":"bba731a6-57ec-4218-969e-c2a87eea2aa6","name":"Failure","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer {{APIKey}}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"client\": {\r\n \"email\": \"user3069@example.com\",\r\n \"country\": \"DE\",\r\n \"city\": \"Riverton\",\r\n \"stateCode\": \"QLD\",\r\n \"full_name\": \"Test test\",\r\n \"street_address\": \"13 Documentation Way\",\r\n \"zip_code\": \"68403\",\r\n \"phone\": \"+448839471521\",\r\n \"gender\": \"M\",\r\n \"date_of_birth\": \"1970-07-10\"\r\n },\r\n \"beneficiaryDetail\": {\r\n \"bankAccountName\": \"Reese Nakamura\",\r\n \"bankAccountNumber\": \"645101511808\",\r\n \"bankName\": \"ICICI Bank\"\r\n },\r\n \"purpose\": \"Testing payout\",\r\n \"currency\": \"EUR\",\r\n \"payoutMethod\": \"PAYOUT-BANKTRANSFER\",\r\n \"amount\": 10.0,\r\n \"brandId\": \"your-brand-id\",\r\n \"success_redirect\": \"https://your.success.redirect.com\",\r\n \"pending_redirect\": \"https://your.pending.redirect.com\",\r\n \"failure_redirect\": \"https://your.failure.redirect.com\",\r\n \"success_callback\": \"https://your.success.callback.com\",\r\n \"failure_callback\": \"https://your.failure.callback.com\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.paystreamportal.com/api/v1/payout/"},"status":"Bad Request","code":400,"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":" {\r\n \"message\": \"Error Message\",\r\n \"code\": \"error_code\"\r\n}"}],"_postman_id":"71ac7bac-327c-40f6-9538-c17be046c8b4"},{"name":"Get Status","id":"b7dd46ac-2c0f-4c86-9062-295f9ae806be","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.paystreamportal.com/api/v1/getpayout/{payoutId}/","description":"This API tells you about all the details of a Payout, including its history
\nMandatory
\nyou need to pass the payoutId in the API URL
\nPossible Value of Status
\nThe webhook will only be triggered for paid transactions or errors.
\nPaid: \"success_callback\": \"https://your.success.callback.com\",
\nError: \"failure_callback\": “https://failure.com”
\n","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"2174b60b-0593-40ab-952a-60a17cb61f8e","id":"2174b60b-0593-40ab-952a-60a17cb61f8e","name":"PayOut API","type":"folder"}},"urlObject":{"path":["getpayout","{payoutId}",""],"host":["https://api.paystreamportal.com/api/v1"],"query":[],"variable":[]}},"response":[{"id":"cb6f9cec-7886-48a1-8aed-148936329a79","name":"Get Status","originalRequest":{"method":"GET","header":[],"url":"https://api.paystreamportal.com/api/v1/getpayout/{payoutId}/"},"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":"{\r\n \"payoutId\": \"65ffadb4c1c83822903a9205\",\r\n \"client\": {\r\n \"email\": \"user5424@example.com\",\r\n \"full_name\": \"Avery Larsen\",\r\n \"street_address\": \"13 Documentation Way\",\r\n \"country\": \"SG\",\r\n \"city\": \"Oakdale\",\r\n \"zip_code\": \"123456\",\r\n \"stateCode\": \"test\"\r\n },\r\n \"updated_on\": 1711254964,\r\n \"payoutMethod\": \"Payout-BANKTRANSFER\",\r\n \"beneficiaryDetail\":{\r\n \"bankName\": \"DBS Bank\", \r\n \"bankAccountName\": \"test test\",\r\n \"bankAccountCurrency\": \"SGD\",\r\n \"bankAccountNumber\": \"12345640\",\r\n \"bankCountryCode\" : \"SG\",\r\n \"swiftCode\": \"DBSSSGSG\",\r\n \"routing_param\" :\r\n {\r\n \"bankCode\": \"897678\",\r\n \"bankBranchCode\" : \"888\"\r\n \r\n }\r\n },\r\n \"amountUnit\": \"MAJOR\",\r\n \"amount\": 1000.0,\r\n \"errorMsg\": \"Currency Account has insufficient balance.\",\r\n \"purpose\": \"test payout\",\r\n \"created_on\": 1711254972,\r\n \"merchantRef\": \"65ffadb4c1c83822903a9205\",\r\n \"status\": \"ERROR\",\r\n \"status_history\": [\r\n {\r\n \"status\": \"created\",\r\n \"timestamp\": 1711254964\r\n },\r\n {\r\n \"status\": \"error\",\r\n \"timestamp\": 1711254972\r\n }\r\n ],\r\n \"currency\": \"USD\",\r\n \"success_callback\": \"https://your.success.callback.com\",\r\n \"failure_callback\": \"https://your.failure.callback.com\"\r\n}\r\n"},{"id":"617f7d99-e7cb-45c0-8326-9c85db4192bf","name":"Get Status-error","originalRequest":{"method":"GET","header":[],"url":"https://api.paystreamportal.com/api/v1/getpayout/{payoutId}/"},"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":"{\r\n \"message\": \"Error Message\",\r\n \"code\": \"error_code\"\r\n}"}],"_postman_id":"b7dd46ac-2c0f-4c86-9062-295f9ae806be"}],"id":"2174b60b-0593-40ab-952a-60a17cb61f8e","description":"API Flow
\n![](\"https://lh7-us.googleusercontent.com/Uxy8jmp5RP-c360-oIMAZy2As8naqJdARgKsWU0x_BtszfJlwdRVM6-obffbtjTABfI9V0hxH4Ad-Ns96We42lIMdL434tTzLJ6aEQBt0dzX_ZXeM4RtG_kmEeem7WIsN520Zh5PS3xTFYNzOmks0ak\")
\n\nAt 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.
\nOur 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","auth":{"type":"noauth","isInherited":false},"event":[{"listen":"prerequest","script":{"type":"text/javascript","packages":{},"requests":{},"exec":[""],"id":"4b4c889a-301e-4e74-a80e-24c1a94b7745"}},{"listen":"test","script":{"type":"text/javascript","packages":{},"requests":{},"exec":[""],"id":"7a287b74-3dc7-48fb-8a1f-30156b182c24"}}],"_postman_id":"2174b60b-0593-40ab-952a-60a17cb61f8e"},{"name":"Get Balance API","item":[{"name":"Checking Balance","id":"87c8c6e7-0eab-4320-9015-67e02eb8dd2a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{APIKey}}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"paymentMethod\": \"BANKTRANSFER\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.paystreamportal.com/api/v1/getBalance","description":"API for Checking Balance payout
\n- \n
URL :- /getBalance/
\n \nRequestType: POST
\n \nRequest Body
\n \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","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"b6d97cc0-05f6-4a34-82ab-c50e00b51cdd","id":"b6d97cc0-05f6-4a34-82ab-c50e00b51cdd","name":"Get Balance API","type":"folder"}},"urlObject":{"path":["getBalance"],"host":["https://api.paystreamportal.com/api/v1"],"query":[],"variable":[]}},"response":[{"id":"fd44d4a0-265a-4a85-96e5-79f3d821e9a2","name":"Success","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\r\n \"paymentMethod\": \"BANKTRANSFER\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.paystreamportal.com/api/v1/getBalance"},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":"{\r\n \"paymentMethod\": \"BANKTRANSFER\",\r\n \"status\": \"success\",\r\n \"data\": [\r\n {\r\n \"currency\": \"AUD\",\r\n \"balance\": \"0.00\"\r\n },\r\n {\r\n \"currency\": \"USD\",\r\n \"balance\": \"46813.79\"\r\n },\r\n {\r\n \"currency\": \"JPY\",\r\n \"balance\": \"1012.00\"\r\n }\r\n ]\r\n}\r\n"},{"id":"0d33922c-466f-4873-9892-dc8ab08ef8f0","name":"Failure","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\r\n \"paymentMethod\": \"BANKTRANSFER\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.paystreamportal.com/api/v1/getBalance"},"status":"Bad Request","code":400,"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":"{\r\n \"message\": \"Error Message\",\r\n \"code\": \"No currency account found\"\r\n}\r\n"}],"_postman_id":"87c8c6e7-0eab-4320-9015-67e02eb8dd2a"}],"id":"b6d97cc0-05f6-4a34-82ab-c50e00b51cdd","auth":{"type":"noauth","isInherited":false},"event":[{"listen":"prerequest","script":{"type":"text/javascript","packages":{},"requests":{},"exec":[""],"id":"77f6e3f2-2913-437a-9850-647528d5d492"}},{"listen":"test","script":{"type":"text/javascript","packages":{},"requests":{},"exec":[""],"id":"4e4db1f2-31cd-4c5f-94d4-ec6682984daa"}}],"_postman_id":"b6d97cc0-05f6-4a34-82ab-c50e00b51cdd","description":""}],"id":"58964a0d-e3fc-4544-a5d2-0f2ea9953e69","_postman_id":"58964a0d-e3fc-4544-a5d2-0f2ea9953e69","description":""},{"name":"🌎 Google Pay (Seamless)","item":[{"name":"Concepts","item":[],"id":"bae95e94-8f0a-4ead-9893-3c9b6ee90d2b","description":"Get started
\nPaystream’s Server-to-Server (S2S) integration for Google Pay allows merchants to process Google Pay transactions securely from their backend systems. In this model, merchants are responsible for generating the Google Pay payment token on their client application and sending it to their server, which then communicates with Paystream APIs.
\nThis integration uses DIRECT tokenization, where payment data is securely generated by Google Pay and passed to Paystream for processing.
\nThis integration is recommended for merchants who require:
\n- \n
Integration with Google Pay wallets
\n \nSecure handling of tokenized payment data
\n \nFlexibility in choosing PCI scope (encrypted vs decrypted flow)
\n \n
\n
How it works
\nThe Google Pay S2S payment flow follows a two-step process:
\n1. Generate Google Pay Token (Client-side)
\nThe merchant integrates Google Pay SDK (Web/Android) to generate a payment token using DIRECT flow.
\n2. Submit Token via S2S
\nThe merchant server sends the Google Pay token (encrypted or decrypted) to Paystream via the /purchase API.
\n\n
Supported Tokenization Type
\nPaystream supports DIRECT flow only.
\nPAYMENT_GATEWAY flow is not supported yet.
\n\n
Google Pay Processing Overview
\nGoogle Pay transactions are processed as card-not-present payments using tokenized card data (PAN/DPAN) along with a cryptogram provided by Google Pay.
\nThese transactions go through:
\n- \n
Card network (Visa, Mastercard, etc.)
\n \nIssuing bank authorization
\n \nRisk and fraud checks
\n \n
\n
Integration Options
\nPaystream supports two integration modes:
\n\n
1. Encrypted Token Flow (Recommended)
\nIn this flow, the merchant sends the encrypted Google Pay token to Paystream. Paystream decrypts and processes the payment.
\nKey Characteristics
\n- \n
Merchant does not handle PAN
\n \nReduced PCI scope
\n \nRecommended for most merchants
\n \n
PCI Impact
\nMerchants can significantly reduce PCI DSS scope since sensitive card data is handled by Paystream.
\n\n
2. Decrypted Token Flow
\nIn this flow, the merchant decrypts the Google Pay token and sends decrypted token details to Paystream.
\nKey Characteristics
\n- \n
PAN is available at merchant side
\n \nFaster processing
\n \nFull control over payment data
\n \n
PCI Impact
\nMerchants must be PCI DSS compliant (SAQ D) as they handle raw card data.
\n\n
Before you begin
\nEnsure the following prerequisites are met:
\n- \n
You have received your API credentials from Paystream.
\n \nYou have a valid Google Merchant ID
\n \nYou have integrated Google Pay SDK to generate tokens
\n \nYou have configured DIRECT tokenization in Google Pay
\n \nYour server can make secure HTTPS requests
\n \nYou have a valid brand_id provided by Paystream
\n \n
Additional Requirements (Encrypted Flow)
\n- \n
Generate EC key pair (P-256 / secp256r1)
\n \nRegister public key in Google Pay Console
\n \nShare private key securely with Paystream
\n \n
Additional Requirements (Decrypted Flow)
\n- \n
Implement token decryption using Google Tink library
\n \nEnsure full PCI DSS compliance
\n \n
To process a Google Pay transaction, a Purchase must first be created using the /purchases API. The Google Pay token must be included in the request under extraParam.googlepay_param.
\nTo generate a Purchase, you are required to provide the Brand ID (in the request body) and API key (in the header) Both can be located in the Dashboard section of your merchant account login.
The request body structure is shown on the request body of the example request shown here.
\nThe following (see table below) are the mandatory parameters that are required to create a purchase request.
\nParameters in the request body:
\nOptional Parameters
\nexpireInMin
\nThis parameter, when passed in the PayIn request, sets the time window within which a customer should make the Interac payment through their bank's app. If a customer doesn't complete the payment within the configured time window, the status of the payment will be marked as 'EXPIRED' in Paystream.
\nHowever, in certain cases, a payment made outside of this window could still be successful i.e. customer's account may be debited which would result in inconsistencies among Paystream'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 Paystream and at customer's Bank, the merchant and Paystream will reconcile the amounts during the settlement.
\nmerchantRef
\nThe merchantRef parameter, although not mandatory, is strongly advised for merchants to specify. Its inclusion offers two significant advantages for the merchant:
- \n
Prevention of Duplicate Requests: When a
\nmerchantRefis utilized, it acts as a unique identifier. This means that if a second purchase request is made using the samemerchantRef(reference number), the system will recognize it and prevent duplicate transactions from occurring. This prevents unintended or duplicate purchases. \nFacilitation of Transaction Retrieval: In situations where the response from the initial purchase request times out or the 'purchaseId' isn't received, having the
\nmerchantRefallows 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.
\npaymentMethod
\nThe paymentMethod parameter identifies which payment solution merchant wants to use to perform a transaction. If parameter is provided, than Paystream will perform direct payment with the selected payment method instead of loading Paystream URL.
Flow Diagram:
\nTo process a Google Pay transaction, a Purchase must first be created using the /purchases API. The Google Pay token must be included in the request under extraParam.googlepay_param.
\nTo generate a Purchase, you are required to provide the Brand ID (in the request body) and API key (in the header) Both can be located in the Dashboard section of your merchant account login.
The request body structure is shown on the request body of the example request shown here.
\nThe following (see table below) are the mandatory parameters that are required to create a purchase request.
\nParameters in the request body:
\nOptional Parameters
\nexpireInMin
\nThis parameter, when passed in the PayIn request, sets the time window within which a customer should make the Interac payment through their bank's app. If a customer doesn't complete the payment within the configured time window, the status of the payment will be marked as 'EXPIRED' in Paystream.
\nHowever, in certain cases, a payment made outside of this window could still be successful i.e. customer's account may be debited which would result in inconsistencies among Paystream'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 Paystream and at customer's Bank, the merchant and Paystream will reconcile the amounts during the settlement.
\nmerchantRef
\nThe merchantRef parameter, although not mandatory, is strongly advised for merchants to specify. Its inclusion offers two significant advantages for the merchant:
- \n
Prevention of Duplicate Requests: When a
\nmerchantRefis utilized, it acts as a unique identifier. This means that if a second purchase request is made using the samemerchantRef(reference number), the system will recognize it and prevent duplicate transactions from occurring. This prevents unintended or duplicate purchases. \nFacilitation of Transaction Retrieval: In situations where the response from the initial purchase request times out or the 'purchaseId' isn't received, having the
\nmerchantRefallows 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.
\npaymentMethod
\nThe paymentMethod parameter identifies which payment solution merchant wants to use to perform a transaction. If parameter is provided, than Paystream will perform direct payment with the selected payment method instead of loading Paystream URL.
Flow Diagram:
\nThis API tells you about all the details of a purchase (PayIn), including its history
\nMandatory
\nyou need to pass the PurchaseID in the API URL
Possible Value of Status
\nResponse Examples
\nIn the response examples you can see instances of both Paid and Error Status purchases.
Error Details
\nIf there are any issues on the Purchase you can get more details from the transaction_data.attempts.error attribute of the response object
Errors
\nIf there are any errors then it'll be in the format of :
\n{\n \"message\": \"descriptive error message\",\n \"code\": \"error_code\"\n}\n\nPlease see the Status Code section for further details.
\n","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"37012799-a148-4e3b-bec4-cc451faddf7f","id":"37012799-a148-4e3b-bec4-cc451faddf7f","name":"APIs","type":"folder"}},"urlObject":{"path":["purchases","{purchaseId}",""],"host":["https://api.paystreamportal.com/api/v1"],"query":[],"variable":[]}},"response":[{"id":"d349e4b3-750e-4638-80ca-087dd9203280","name":"Purchase - success","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer {{APIKey}}"}],"url":"https://api.paystreamportal.com/api/v1/purchases/{purchaseId}/"},"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":"{\r\n \"purchaseId\": \"69cce01f5bae56fd5547a993\",\r\n \"client\": {\r\n \"customerId\": \"NA\",\r\n \"email\": \"user9831@example.com\",\r\n \"full_name\": \"Casey Novak\",\r\n \"date_of_birth\": \"1800-01-01\",\r\n \"street_address\": \"58 Testing Lane\",\r\n \"country\": \"BR\",\r\n \"city\": \"Westbury\",\r\n \"zip_code\": \"110001\",\r\n \"cc\": [],\r\n \"bcc\": [],\r\n \"stateCode\": \"DL\"\r\n },\r\n \"updated_on\": 1775034399,\r\n \"type\": \"purchase\",\r\n \"paymentMethod\": \"GOOGLEPAY\",\r\n \"amountUnit\": \"MAJOR\",\r\n \"errorMsg\": \"\",\r\n \"errorCode\": \"NA\",\r\n \"force_recurring\": false,\r\n \"created_on\": 1775034399,\r\n \"merchantRef\": \"69cce01f5bae56fd5547a993\",\r\n \"purchase\": {\r\n \"currency\": \"USD\",\r\n \"products\": [\r\n {\r\n \"name\": \"e-commerce\",\r\n \"quantity\": 1.0,\r\n \"price\": 10.0,\r\n \"discount\": 0,\r\n \"tax_percent\": \"0.00\"\r\n }\r\n ],\r\n \"total\": 10.0,\r\n \"requestAmount\": 10.0,\r\n \"language\": \"en\",\r\n \"notes\": \"\",\r\n \"debt\": 0,\r\n \"total_formatted\": 1.0,\r\n \"taxAmount\": 0.0,\r\n \"taxPercent\": 0.0,\r\n \"request_client_details\": [],\r\n \"email_message\": \"\"\r\n },\r\n \"issuer_details\": {\r\n \"website\": \"\",\r\n \"legal_street_address\": \"\",\r\n \"legal_country\": \"\",\r\n \"legal_city\": \"\",\r\n \"legal_zip_code\": \"\",\r\n \"bank_accounts\": [\r\n {}\r\n ],\r\n \"legal_name\": \"Omega Pixel\",\r\n \"brand_name\": \"Omega Pixel\",\r\n \"registration_number\": \"\",\r\n \"tax_number\": \"\"\r\n },\r\n \"transaction_data\": {\r\n \"payment_method\": \"\",\r\n \"flow\": \"payform\",\r\n \"extra\": {},\r\n \"country\": \"\",\r\n \"attempts\": []\r\n },\r\n \"status\": \"CREATED\",\r\n \"status_history\": [\r\n {\r\n \"status\": \"created\",\r\n \"timestamp\": 1775034399\r\n }\r\n ],\r\n \"is_test\": false,\r\n \"brand_id\": \"your-brand-id\",\r\n \"send_receipt\": false,\r\n \"is_recurring_token\": false,\r\n \"skip_capture\": false,\r\n \"reference_generated\": \"PS1032\",\r\n \"issued\": \"2026-04-01\",\r\n \"due\": 1775034399,\r\n \"refund_upto\": 0,\r\n \"cc_descriptor\": \"\",\r\n \"fraudScore\": \"NA\",\r\n \"trustScore\": \"NA\",\r\n \"extraFee\": \"0\",\r\n \"paidOn\": 0,\r\n \"receivedAmt\": 0.0,\r\n \"taxAmount\": 0.0,\r\n \"surcharge\": 0.0,\r\n \"surchargeType\": \"\",\r\n \"sessionId\": \"\",\r\n \"refund_availability\": \"NONE\",\r\n \"refundable_amount\": 0.0,\r\n \"success_redirect\": \"https://your.success.redirect.com\",\r\n \"failure_redirect\": \"https://your.failure.redirect.com\",\r\n \"pending_redirect\": \"https://your.pending.redirect.com\",\r\n \"cancel_redirect\": \"\",\r\n \"success_callback\": \"https://your.success.callback.com\",\r\n \"failure_callback\": \"https://your.failure.callback.com\",\r\n \"platform\": \"API\",\r\n \"created_from_ip\": \"203.0.113.232\",\r\n \"checkout_url\": \"https://api.paystreamportal.com/payments/6b5a5977ac8e022facb31f3346f61ed0/\",\r\n \"direct_post_url\": \"https://api.paystreamportal.com/api/v1/p/69cce01f5bae56fd5547a993/\",\r\n \"payoutProcess\": false\r\n}"},{"id":"750a1d0e-1df3-46ae-871e-4a37884babb7","name":"Purchase - failure","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer {{APIKey}}","type":"text"}],"url":"https://api.paystreamportal.com/api/v1/purchases/{purchaseId}/"},"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":"{\r\n \"message\": \"Error Message\",\r\n \"code\": \"error_code\"\r\n}"}],"_postman_id":"a5bc6161-a5fa-4d38-ae51-820abad09a6d"}],"id":"37012799-a148-4e3b-bec4-cc451faddf7f","auth":{"type":"noauth","isInherited":false},"event":[{"listen":"prerequest","script":{"type":"text/javascript","packages":{},"requests":{},"exec":[""],"id":"6df2b926-fefe-4390-b104-b9e1df38ad1d"}},{"listen":"test","script":{"type":"text/javascript","packages":{},"requests":{},"exec":[""],"id":"6408f23d-2694-40c5-be84-cfb3a0d98571"}}],"_postman_id":"37012799-a148-4e3b-bec4-cc451faddf7f","description":""}],"id":"53262583-0db2-4c5d-9127-166d1fcbb1be","auth":{"type":"noauth","isInherited":false},"event":[{"listen":"prerequest","script":{"type":"text/javascript","packages":{},"requests":{},"exec":[""],"id":"7ea0e2c1-7462-4b77-b85d-7405cd83f297"}},{"listen":"test","script":{"type":"text/javascript","packages":{},"requests":{},"exec":[""],"id":"8ab20de2-7b63-4bd2-8457-9a1c65d381e4"}}],"_postman_id":"53262583-0db2-4c5d-9127-166d1fcbb1be","description":""},{"name":"🌎 Apple Pay (Seamless)","item":[{"name":"Concepts","item":[],"id":"9cfaca54-54f3-495b-a05c-d389d443bb80","description":"Get started
\nPaystream’s Server-to-Server (S2S) integration for Apple Pay allows merchants to process Apple Pay transactions securely from their backend systems. In this model, merchants are responsible for generating the Apple Pay payment token on their client application and sending it to their server, which then communicates with Paystream APIs.
\nThis integration uses DIRECT tokenization, where payment data is securely generated by Apple Pay and passed to Paystream for processing.
\nThis integration is recommended for merchants who require:
\n- \n
Integration with Apple Pay wallets
\n \nSecure handling of tokenized payment data
\n \nFlexibility in choosing PCI scope (encrypted vs decrypted flow)
\n \n
\n
How it works
\nThe Apple Pay S2S payment flow follows a two-step process:
\n1. Generate Apple Pay Token (Client-side)
\nThe merchant integrates Apple Pay SDK (Web/Android) to generate a payment token using DIRECT flow.
\n2. Submit Token via S2S
\nThe merchant server sends the Apple Pay token (encrypted or decrypted) to Paystream via the /purchase API.
\n\n
Apple Pay Processing Overview
\nApple Pay transactions are processed as card-not-present payments using:
\n- \n
Tokenized card data (DPAN)
\n \nCryptogram generated by Apple
\n \nDevice-based authentication (Face ID / Touch ID / Passcode)
\n \n
These transactions go through:
\n- \n
Card network (Visa, Mastercard, Amex, etc.)
\n \nIssuing bank authorization
\n \nRisk and fraud checks
\n \n
\n
Integration Options
\nPaystream supports two integration modes:
\n\n
1. Encrypted Token Flow (Recommended)
\nIn this flow, the merchant sends the encrypted Apple Pay token to Paystream. Paystream decrypts and processes the payment.
\nKey Characteristics
\n- \n
Merchant does not handle PAN
\n \nReduced PCI scope
\n \nRecommended for most merchants
\n \n
PCI Impact
\nMerchants can significantly reduce PCI DSS scope since sensitive card data is handled by Paystream.
\n\n
2. Decrypted Token Flow
\nIn this flow, the merchant decrypts the Apple Pay token and sends card details to Paystream.
\nKey Characteristics
\n- \n
PAN/DPAN available at merchant side
\n \nFull control over payment data
\n \n
PCI Impact
\nMerchants must be PCI DSS compliant (SAQ D) as they handle raw card data.
\n\n
Before you begin
\nEnsure the following prerequisites are met:
\n- \n
You have received your API credentials from Paystream
\n \nYou have an Apple Merchant ID
\n \nYou have configured Apple Pay on your domain/app
\n \nYour server can make secure HTTPS requests
\n \nYou have a valid brand_id provided by Paystream
\n \n
\n
Additional Requirements (Encrypted Flow)
\n- \n
Configure Apple Pay certificates (Payment Processing Certificate)
\n \nShare certificate details securely with Paystream (if required)
\n \n
\n
Additional Requirements (Decrypted Flow)
\n- \n
Implement Apple Pay token decryption
\n \nUse Apple’s Payment Processing certificate and private key
\n \nEnsure full PCI DSS compliance
\n \n
To process an Apple Pay transaction, a Purchase must be created using the /purchases API. The Apple Pay token must be included under extraParam.applepay_param.
\nTo generate a Purchase, you are required to provide the Brand ID (in the request body) and API key (in the header) Both can be located in the Dashboard section of your merchant account login.
The request body structure is shown on the request body of the example request shown here.
\nThe following (see table below) are the mandatory parameters that are required to create a purchase request.
\nParameters in the request body:
\nOptional Parameters
\nexpireInMin
\nThis parameter, when passed in the PayIn request, sets the time window within which a customer should make the Interac payment through their bank's app. If a customer doesn't complete the payment within the configured time window, the status of the payment will be marked as 'EXPIRED' in Paystream.
\nHowever, in certain cases, a payment made outside of this window could still be successful i.e. customer's account may be debited which would result in inconsistencies among Paystream'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 Paystream and at customer's Bank, the merchant and Paystream will reconcile the amounts during the settlement.
\nmerchantRef
\nThe merchantRef parameter, although not mandatory, is strongly advised for merchants to specify. Its inclusion offers two significant advantages for the merchant:
- \n
Prevention of Duplicate Requests: When a
\nmerchantRefis utilized, it acts as a unique identifier. This means that if a second purchase request is made using the samemerchantRef(reference number), the system will recognize it and prevent duplicate transactions from occurring. This prevents unintended or duplicate purchases. \nFacilitation of Transaction Retrieval: In situations where the response from the initial purchase request times out or the 'purchaseId' isn't received, having the
\nmerchantRefallows 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.
\npaymentMethod
\nThe paymentMethod parameter identifies which payment solution merchant wants to use to perform a transaction. If parameter is provided, than Paystream will perform direct payment with the selected payment method instead of loading Paystream URL.
To process an Apple Pay transaction, a Purchase must be created using the /purchases API. The Apple Pay token must be included under extraParam.applepay_param.
\nTo generate a Purchase, you are required to provide the Brand ID (in the request body) and API key (in the header) Both can be located in the Dashboard section of your merchant account login.
The request body structure is shown on the request body of the example request shown here.
\nThe following (see table below) are the mandatory parameters that are required to create a purchase request.
\nParameters in the request body:
\nOptional Parameters
\nexpireInMin
\nThis parameter, when passed in the PayIn request, sets the time window within which a customer should make the Interac payment through their bank's app. If a customer doesn't complete the payment within the configured time window, the status of the payment will be marked as 'EXPIRED' in Paystream.
\nHowever, in certain cases, a payment made outside of this window could still be successful i.e. customer's account may be debited which would result in inconsistencies among Paystream'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 Paystream and at customer's Bank, the merchant and Paystream will reconcile the amounts during the settlement.
\nmerchantRef
\nThe merchantRef parameter, although not mandatory, is strongly advised for merchants to specify. Its inclusion offers two significant advantages for the merchant:
- \n
Prevention of Duplicate Requests: When a
\nmerchantRefis utilized, it acts as a unique identifier. This means that if a second purchase request is made using the samemerchantRef(reference number), the system will recognize it and prevent duplicate transactions from occurring. This prevents unintended or duplicate purchases. \nFacilitation of Transaction Retrieval: In situations where the response from the initial purchase request times out or the 'purchaseId' isn't received, having the
\nmerchantRefallows 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.
\npaymentMethod
\nThe paymentMethod parameter identifies which payment solution merchant wants to use to perform a transaction. If parameter is provided, than Paystream will perform direct payment with the selected payment method instead of loading Paystream URL.
This API tells you about all the details of a purchase (PayIn), including its history
\nMandatory
\nyou need to pass the PurchaseID in the API URL
Possible Value of Status
\nResponse Examples
\nIn the response examples you can see instances of both Paid and Error Status purchases.
Error Details
\nIf there are any issues on the Purchase you can get more details from the transaction_data.attempts.error attribute of the response object
Errors
\nIf there are any errors then it'll be in the format of :
\n{\n \"message\": \"descriptive error message\",\n \"code\": \"error_code\"\n}\n\nPlease see the Status Code section for further details.
\n","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"b21e1367-ce67-4245-9206-6585a3a221ad","id":"b21e1367-ce67-4245-9206-6585a3a221ad","name":"APIs","type":"folder"}},"urlObject":{"path":["purchases","{purchaseId}",""],"host":["https://api.paystreamportal.com/api/v1"],"query":[],"variable":[]}},"response":[{"id":"cdfd3999-d849-433c-b666-5ab987e576d5","name":"Purchase - success","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer {{APIKey}}"}],"url":"https://api.paystreamportal.com/api/v1/purchases/{purchaseId}/"},"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":"{\r\n \"purchaseId\": \"69cce01f5bae56fd5547a993\",\r\n \"client\": {\r\n \"customerId\": \"NA\",\r\n \"email\": \"user9831@example.com\",\r\n \"full_name\": \"Casey Novak\",\r\n \"date_of_birth\": \"1800-01-01\",\r\n \"street_address\": \"58 Testing Lane\",\r\n \"country\": \"BR\",\r\n \"city\": \"Westbury\",\r\n \"zip_code\": \"110001\",\r\n \"cc\": [],\r\n \"bcc\": [],\r\n \"stateCode\": \"DL\"\r\n },\r\n \"updated_on\": 1775034399,\r\n \"type\": \"purchase\",\r\n \"paymentMethod\": \"GOOGLEPAY\",\r\n \"amountUnit\": \"MAJOR\",\r\n \"errorMsg\": \"\",\r\n \"errorCode\": \"NA\",\r\n \"force_recurring\": false,\r\n \"created_on\": 1775034399,\r\n \"merchantRef\": \"69cce01f5bae56fd5547a993\",\r\n \"purchase\": {\r\n \"currency\": \"USD\",\r\n \"products\": [\r\n {\r\n \"name\": \"e-commerce\",\r\n \"quantity\": 1.0,\r\n \"price\": 10.0,\r\n \"discount\": 0,\r\n \"tax_percent\": \"0.00\"\r\n }\r\n ],\r\n \"total\": 10.0,\r\n \"requestAmount\": 10.0,\r\n \"language\": \"en\",\r\n \"notes\": \"\",\r\n \"debt\": 0,\r\n \"total_formatted\": 1.0,\r\n \"taxAmount\": 0.0,\r\n \"taxPercent\": 0.0,\r\n \"request_client_details\": [],\r\n \"email_message\": \"\"\r\n },\r\n \"issuer_details\": {\r\n \"website\": \"\",\r\n \"legal_street_address\": \"\",\r\n \"legal_country\": \"\",\r\n \"legal_city\": \"\",\r\n \"legal_zip_code\": \"\",\r\n \"bank_accounts\": [\r\n {}\r\n ],\r\n \"legal_name\": \"Omega Pixel\",\r\n \"brand_name\": \"Omega Pixel\",\r\n \"registration_number\": \"\",\r\n \"tax_number\": \"\"\r\n },\r\n \"transaction_data\": {\r\n \"payment_method\": \"\",\r\n \"flow\": \"payform\",\r\n \"extra\": {},\r\n \"country\": \"\",\r\n \"attempts\": []\r\n },\r\n \"status\": \"CREATED\",\r\n \"status_history\": [\r\n {\r\n \"status\": \"created\",\r\n \"timestamp\": 1775034399\r\n }\r\n ],\r\n \"is_test\": false,\r\n \"brand_id\": \"your-brand-id\",\r\n \"send_receipt\": false,\r\n \"is_recurring_token\": false,\r\n \"skip_capture\": false,\r\n \"reference_generated\": \"PS1032\",\r\n \"issued\": \"2026-04-01\",\r\n \"due\": 1775034399,\r\n \"refund_upto\": 0,\r\n \"cc_descriptor\": \"\",\r\n \"fraudScore\": \"NA\",\r\n \"trustScore\": \"NA\",\r\n \"extraFee\": \"0\",\r\n \"paidOn\": 0,\r\n \"receivedAmt\": 0.0,\r\n \"taxAmount\": 0.0,\r\n \"surcharge\": 0.0,\r\n \"surchargeType\": \"\",\r\n \"sessionId\": \"\",\r\n \"refund_availability\": \"NONE\",\r\n \"refundable_amount\": 0.0,\r\n \"success_redirect\": \"https://your.success.redirect.com\",\r\n \"failure_redirect\": \"https://your.failure.redirect.com\",\r\n \"pending_redirect\": \"https://your.pending.redirect.com\",\r\n \"cancel_redirect\": \"\",\r\n \"success_callback\": \"https://your.success.callback.com\",\r\n \"failure_callback\": \"https://your.failure.callback.com\",\r\n \"platform\": \"API\",\r\n \"created_from_ip\": \"203.0.113.232\",\r\n \"checkout_url\": \"https://api.paystreamportal.com/payments/6b5a5977ac8e022facb31f3346f61ed0/\",\r\n \"direct_post_url\": \"https://api.paystreamportal.com/api/v1/p/69cce01f5bae56fd5547a993/\",\r\n \"payoutProcess\": false\r\n}"},{"id":"d4f428d9-60e4-4947-b0dc-4bad2561f0d8","name":"Purchase - failure","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer {{APIKey}}","type":"text"}],"url":"https://api.paystreamportal.com/api/v1/purchases/{purchaseId}/"},"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":"{\r\n \"message\": \"Error Message\",\r\n \"code\": \"error_code\"\r\n}"}],"_postman_id":"4769078c-4f49-4bc4-8baf-f170090dfd64"}],"id":"b21e1367-ce67-4245-9206-6585a3a221ad","auth":{"type":"noauth","isInherited":false},"event":[{"listen":"prerequest","script":{"type":"text/javascript","packages":{},"requests":{},"exec":[""],"id":"fc0b57ad-ace9-4bb3-9d00-ea35d522b49c"}},{"listen":"test","script":{"type":"text/javascript","packages":{},"requests":{},"exec":[""],"id":"290a2ae8-6fea-40e0-a0b6-4e2e3be6d06a"}}],"_postman_id":"b21e1367-ce67-4245-9206-6585a3a221ad","description":""}],"id":"a8f03a7b-42b2-4536-b8c1-7a9c219245f0","auth":{"type":"noauth","isInherited":false},"event":[{"listen":"prerequest","script":{"type":"text/javascript","packages":{},"requests":{},"exec":[""],"id":"7277a2f6-95d5-4425-8b3c-337fbe32dbc0"}},{"listen":"test","script":{"type":"text/javascript","packages":{},"requests":{},"exec":[""],"id":"6db9aea7-f601-4398-b14d-453cc57bd475"}}],"_postman_id":"a8f03a7b-42b2-4536-b8c1-7a9c219245f0","description":""}],"id":"784c7180-889e-4878-b9e6-81dd7bedf947","_postman_id":"784c7180-889e-4878-b9e6-81dd7bedf947","description":""},{"name":"Trust Score","item":[{"name":"TrustScore Detailed","id":"cd3a24e7-0c4d-4146-8b5d-63c98ece8f09","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"requiredinput\": {\r\n \"ip\": \"203.0.113.106\",\r\n \"email\": \"user5772@example.com\",\r\n \"url\": \"https://www.asos.com/\"\r\n },\r\n \"optionalInput\": {\r\n \"last_bets\": null,\r\n \"last_wins\": \"\",\r\n \"total_bonuses\": \"\",\r\n \"last_real_bets\": \"\",\r\n \"last_real_wins\": \"\",\r\n \"total_deposits\": \"\",\r\n \"last_bonus_bets\": \"\",\r\n \"last_bonus_wins\": \"\",\r\n \"average_real_bet\": \"\",\r\n \"last_bets_amount\": \"\",\r\n \"last_wins_amount\": \"\",\r\n \"average_bonus_bet\": \"\",\r\n \"bonus_to_deposits\": \"\",\r\n \"last_deposit_date\": \"\",\r\n \"total_withdrawals\": \"\",\r\n \"is_phone_confirmed\": \"\",\r\n \"money_in_money_out\": \"\",\r\n \"last_deposit_amount\": \"\",\r\n \"last_freespins_date\": \"\",\r\n \"last_freespins_name\": \"\",\r\n \"last_free_bonus_date\": \"\",\r\n \"last_free_bonus_name\": \"\",\r\n \"total_bonuses_amount\": \"\",\r\n \"last_freespins_amount\": \"\",\r\n \"last_freespins_status\": \"\",\r\n \"last_real_bets_amount\": \"\",\r\n \"last_real_wins_amount\": \"\",\r\n \"total_deposits_amount\": \"\",\r\n \"last_bonus_bets_amount\": \"\",\r\n \"last_bonus_wins_amount\": \"\",\r\n \"last_free_bonus_amount\": \"\",\r\n \"last_free_bonus_status\": \"\",\r\n \"last_deposit_bonus_date\": \"\",\r\n \"last_deposit_bonus_name\": \"\",\r\n \"last_freespins_currency\": \"\",\r\n \"last_freespins_wagering\": \"\",\r\n \"withdrawals_to_deposits\": \"\",\r\n \"last_free_bonus_currency\": \"\",\r\n \"last_free_bonus_wagering\": \"\",\r\n \"total_withdrawals_amount\": \"\",\r\n \"withdrawal_ewallet_email\": \"\",\r\n \"last_deposit_bonus_amount\": \"\",\r\n \"last_deposit_bonus_status\": \"\",\r\n \"last_deposit_bonus_currency\": \"\",\r\n \"last_deposit_bonus_wagering\": \"\",\r\n \"session\": \"\",\r\n \"payment_mode\": \"\",\r\n \"card_fullname\": \"\",\r\n \"card_bin\": \"\",\r\n \"card_hash\": \"\",\r\n \"card_last\": \"\",\r\n \"card_expire\": \"\",\r\n \"avs_result\": \"\",\r\n \"cvv_result\": \"\",\r\n \"sca_method\": \"\",\r\n \"user_bank_account\": \"\",\r\n \"user_bank_name\": \"\",\r\n \"user_balance\": \"\",\r\n \"user_verification_level\": \"\",\r\n \"status_3d\": \"\",\r\n \"regulation\": \"\",\r\n \"payment_provider\": \"\",\r\n \"phone_number\": \"\",\r\n \"transaction_type\": \"\",\r\n \"transaction_amount\": \"\",\r\n \"transaction_currency\": \"\",\r\n \"merchant_id\": \"\",\r\n \"details_url\": \"\",\r\n \"name\": \"\",\r\n \"person_type\": \"\",\r\n \"gender\": \"\"\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.paystreamportal.com/api/v1/trustScore","description":"Overview
\nPaystream TrustScore's proprietary API combines email, phone number, IP and URL so that you can request and receive a user trust score from our enriched data, rules, and scoring in a single API call.
\nOur take on Trust is different from the usual approach to fraud. This API tells you how much you can trust this user. It’s based on 100+ data points to which we have access. We use complex algorithms based on data sanity and customer behaviour in our partner network.
\nAlso, the additional optional parameter would be used to boost the accuracy of our response. So the more data we get the better we can ascertain the users' trust. So please endeavour to send as much information about the user as possible.
\nTrust Score & Usage
\nTrustScore offers two distinct endpoints: General and Detailed.
The General endpoint provides basic information by indicating whether a transaction is permitted or not. It gives a simple 'yes' or 'no' response regarding whether the transaction can proceed.
\nOn the other hand, the Detailed endpoint offers a more comprehensive evaluation. It furnishes an in-depth analysis of the transaction's authenticity, providing a detailed assessment beyond a simple allowance or denial, offering nuanced insights and information about the transaction's legitimacy.
\nDetailed TrustScore
\nTrust scores range from 0 to 5. A trust score of 0 indicates that we have limited information about the user, and it corresponds to the lowest level of trust. In addition to the TrustScore, we offer eight other flags to help assess the user's overall profile and determine appropriate actions to take. We suggest flagging or blocking users, transactions, or clicks as high risk based on a combination of the following factors: email deliverability, proxy usage, VPN usage, Tor usage, and recent abusive behavior.
\nEvery company has a unique target audience, so you might achieve better results by only flagging or blocking entities with low trust scores and recent instances of abuse. Keep in mind that mobile IP addresses are frequently misused and recycled by mobile carriers. Therefore, for mobile lookups, we advise giving more weight to the trust score, VPN usage, and Tor usage, as opposed to proxy usage.
\nPermission
\nAccess to this API has to be given to you by the admin. So please contact your sales representative at Paystream to get access to this API, if you get a 401 error of \"You are not allowed to call this API service\".
\nMandatory Parameters (in body)
\nOther optional paramters:
\nThe optional parameters are self-explanatory and appropriate values can be given in string format.
\nResponse
\nIn the response examples, you can observe both instances of a successful TrustScore response and an unsuccessful one.
\nPlease note that there are a lot of parameters to determine the trust level and give you some additional details on the email and IP of the user.
\nin a successful trust score call the following data would be provided:
\nErrors
\nIf there are any errors then it'll be in the format of :
\n{\n \"message\": \"descriptive error message\",\n \"code\": \"error_code\"\n}\n\nPossible Error Messages
\nthe possible error codes one can get on calling this APIs are:
\nfor example:
\n","urlObject":{"path":["trustScore"],"host":["https://api.paystreamportal.com/api/v1"],"query":[],"variable":[]}},"response":[{"id":"c6d16084-ee4b-4161-84f8-7ecc8cb1a6e6","name":"TrustScoreExists","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"requiredinput\": {\r\n \"ip\": \"2001:8004:cc2:fadb:9958:4523:6c42:e3f2\",\r\n \"email\": \"user5772@example.com\",\r\n \"url\": \"http://test.com\"\r\n },\r\n \"optionalInput\": {\r\n \"last_bets\": null,\r\n \"last_wins\": \"\",\r\n \"total_bonuses\": \"\",\r\n \"last_real_bets\": \"\",\r\n \"last_real_wins\": \"\",\r\n \"total_deposits\": \"\",\r\n \"last_bonus_bets\": \"\",\r\n \"last_bonus_wins\": \"\",\r\n \"average_real_bet\": \"\",\r\n \"last_bets_amount\": \"\",\r\n \"last_wins_amount\": \"\",\r\n \"average_bonus_bet\": \"\",\r\n \"bonus_to_deposits\": \"\",\r\n \"last_deposit_date\": \"\",\r\n \"total_withdrawals\": \"\",\r\n \"is_phone_confirmed\": \"\",\r\n \"money_in_money_out\": \"\",\r\n \"last_deposit_amount\": \"\",\r\n \"last_freespins_date\": \"\",\r\n \"last_freespins_name\": \"\",\r\n \"last_free_bonus_date\": \"\",\r\n \"last_free_bonus_name\": \"\",\r\n \"total_bonuses_amount\": \"\",\r\n \"last_freespins_amount\": \"\",\r\n \"last_freespins_status\": \"\",\r\n \"last_real_bets_amount\": \"\",\r\n \"last_real_wins_amount\": \"\",\r\n \"total_deposits_amount\": \"\",\r\n \"last_bonus_bets_amount\": \"\",\r\n \"last_bonus_wins_amount\": \"\",\r\n \"last_free_bonus_amount\": \"\",\r\n \"last_free_bonus_status\": \"\",\r\n \"last_deposit_bonus_date\": \"\",\r\n \"last_deposit_bonus_name\": \"\",\r\n \"last_freespins_currency\": \"\",\r\n \"last_freespins_wagering\": \"\",\r\n \"withdrawals_to_deposits\": \"\",\r\n \"last_free_bonus_currency\": \"\",\r\n \"last_free_bonus_wagering\": \"\",\r\n \"total_withdrawals_amount\": \"\",\r\n \"withdrawal_ewallet_email\": \"\",\r\n \"last_deposit_bonus_amount\": \"\",\r\n \"last_deposit_bonus_status\": \"\",\r\n \"last_deposit_bonus_currency\": \"\",\r\n \"last_deposit_bonus_wagering\": \"\",\r\n \"session\": \"\",\r\n \"payment_mode\": \"\",\r\n \"card_fullname\": \"\",\r\n \"card_bin\": \"\",\r\n \"card_hash\": \"\",\r\n \"card_last\": \"\",\r\n \"card_expire\": \"\",\r\n \"avs_result\": \"\",\r\n \"cvv_result\": \"\",\r\n \"sca_method\": \"\",\r\n \"user_bank_account\": \"\",\r\n \"user_bank_name\": \"\",\r\n \"user_balance\": \"\",\r\n \"user_verification_level\": \"\",\r\n \"status_3d\": \"\",\r\n \"regulation\": \"\",\r\n \"payment_provider\": \"\",\r\n \"phone_number\": \"\",\r\n \"transaction_type\": \"\",\r\n \"transaction_amount\": \"\",\r\n \"transaction_currency\": \"\",\r\n \"merchant_id\": \"\",\r\n \"details_url\": \"\",\r\n \"name\": \"\",\r\n \"person_type\": \"\",\r\n \"gender\": \"\"\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.paystreamportal.com/api/v1/trustScore"},"status":"Accepted","code":202,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Sun, 29 Oct 2023 09:21:22 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"Cache-Control","value":"no-cache, no-store, max-age=0, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Expires","value":"0"},{"key":"X-Frame-Options","value":"DENY"},{"key":"CF-Cache-Status","value":"DYNAMIC"},{"key":"Report-To","value":"{\"endpoints\":[{\"url\":\"https:\\/\\/a.nel.cloudflare.com\\/report\\/v3?s=r2%2FuLwSilxdD1lpiI1VqpgF0Tu9etiNhupySeBHl0zcU8XV1z8kwR%2FJ00ti4xpMdrTXW%2BkqZkLGrkkaUnMWFsaYlg%2FfA9UC4wIKwmc9LHUwna491EmnC3b3vlabzhUJ11CMpnVmicUE%3D\"}],\"group\":\"cf-nel\",\"max_age\":604800}"},{"key":"NEL","value":"{\"success_fraction\":0,\"report_to\":\"cf-nel\",\"max_age\":604800}"},{"key":"Server","value":"cloudflare"},{"key":"CF-RAY","value":"81da590e8d4345a0-LHR"},{"key":"alt-svc","value":"h3=\":443\"; ma=86400"}],"cookie":[],"responseTime":null,"body":"{\n \"trustScore\": 0,\n \"deliverable\": \"false\",\n \"proxy\": \"false\",\n \"vpn\": \"false\",\n \"tor\": \"false\",\n \"active_vpn\": \"false\",\n \"active_tor\": \"false\",\n \"recent_abuse\": \"false\",\n \"bot_status\": \"false\"\n}"},{"id":"d2c01391-b376-475b-9625-b46867f3e242","name":"TrustScoreError","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"requiredinput\": {\r\n \"ip\": \"2001:8004:cc2:fadb:9958:4523:6c42:e3f2\",\r\n \"email\": \"user5772@example.com\",\r\n \"url\": \"http://test.com\"\r\n },\r\n \"optionalInput\": {\r\n \"last_bets\": null,\r\n \"last_wins\": \"\",\r\n \"total_bonuses\": \"\",\r\n \"last_real_bets\": \"\",\r\n \"last_real_wins\": \"\",\r\n \"total_deposits\": \"\",\r\n \"last_bonus_bets\": \"\",\r\n \"last_bonus_wins\": \"\",\r\n \"average_real_bet\": \"\",\r\n \"last_bets_amount\": \"\",\r\n \"last_wins_amount\": \"\",\r\n \"average_bonus_bet\": \"\",\r\n \"bonus_to_deposits\": \"\",\r\n \"last_deposit_date\": \"\",\r\n \"total_withdrawals\": \"\",\r\n \"is_phone_confirmed\": \"\",\r\n \"money_in_money_out\": \"\",\r\n \"last_deposit_amount\": \"\",\r\n \"last_freespins_date\": \"\",\r\n \"last_freespins_name\": \"\",\r\n \"last_free_bonus_date\": \"\",\r\n \"last_free_bonus_name\": \"\",\r\n \"total_bonuses_amount\": \"\",\r\n \"last_freespins_amount\": \"\",\r\n \"last_freespins_status\": \"\",\r\n \"last_real_bets_amount\": \"\",\r\n \"last_real_wins_amount\": \"\",\r\n \"total_deposits_amount\": \"\",\r\n \"last_bonus_bets_amount\": \"\",\r\n \"last_bonus_wins_amount\": \"\",\r\n \"last_free_bonus_amount\": \"\",\r\n \"last_free_bonus_status\": \"\",\r\n \"last_deposit_bonus_date\": \"\",\r\n \"last_deposit_bonus_name\": \"\",\r\n \"last_freespins_currency\": \"\",\r\n \"last_freespins_wagering\": \"\",\r\n \"withdrawals_to_deposits\": \"\",\r\n \"last_free_bonus_currency\": \"\",\r\n \"last_free_bonus_wagering\": \"\",\r\n \"total_withdrawals_amount\": \"\",\r\n \"withdrawal_ewallet_email\": \"\",\r\n \"last_deposit_bonus_amount\": \"\",\r\n \"last_deposit_bonus_status\": \"\",\r\n \"last_deposit_bonus_currency\": \"\",\r\n \"last_deposit_bonus_wagering\": \"\",\r\n \"session\": \"\",\r\n \"payment_mode\": \"\",\r\n \"card_fullname\": \"\",\r\n \"card_bin\": \"\",\r\n \"card_hash\": \"\",\r\n \"card_last\": \"\",\r\n \"card_expire\": \"\",\r\n \"avs_result\": \"\",\r\n \"cvv_result\": \"\",\r\n \"sca_method\": \"\",\r\n \"user_bank_account\": \"\",\r\n \"user_bank_name\": \"\",\r\n \"user_balance\": \"\",\r\n \"user_verification_level\": \"\",\r\n \"status_3d\": \"\",\r\n \"regulation\": \"\",\r\n \"payment_provider\": \"\",\r\n \"phone_number\": \"\",\r\n \"transaction_type\": \"\",\r\n \"transaction_amount\": \"\",\r\n \"transaction_currency\": \"\",\r\n \"merchant_id\": \"\",\r\n \"details_url\": \"\",\r\n \"name\": \"\",\r\n \"person_type\": \"\",\r\n \"gender\": \"\"\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.paystreamportal.com/api/v1/trustScore"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Sun, 29 Oct 2023 09:28:33 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"Cache-Control","value":"no-cache, no-store, max-age=0, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Expires","value":"0"},{"key":"X-Frame-Options","value":"DENY"},{"key":"CF-Cache-Status","value":"DYNAMIC"},{"key":"Report-To","value":"{\"endpoints\":[{\"url\":\"https:\\/\\/a.nel.cloudflare.com\\/report\\/v3?s=herXY1o%2BFZa%2F3qNFjvh4ANgP%2FD0DdAVVFm0vUZDAst2rFkieItm%2Fu0VN24DYrdp7MHMHFKWLvrsBYVIxjDPDaLgJjeGBvlTP2iZoB5EnG1hPPHUVXRNP%2FGMmOTh%2Fp7gsyj0vihW1kMk%3D\"}],\"group\":\"cf-nel\",\"max_age\":604800}"},{"key":"NEL","value":"{\"success_fraction\":0,\"report_to\":\"cf-nel\",\"max_age\":604800}"},{"key":"Server","value":"cloudflare"},{"key":"CF-RAY","value":"81da6398ab144913-LHR"},{"key":"alt-svc","value":"h3=\":443\"; ma=86400"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Incorrect secret_key\",\n \"code\": \"authentication_failed\"\n}"}],"_postman_id":"cd3a24e7-0c4d-4146-8b5d-63c98ece8f09"},{"name":"checkTransactionAllowed","id":"5d111794-a354-469b-ba06-f26de4112bce","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"requiredinput\": {\r\n \"ip\": \"203.0.113.106\",\r\n \"email\": \"user5772@example.com\",\r\n \"url\": \"https://www.asos.com/\"\r\n },\r\n \"optionalInput\": {\r\n \"last_bets\": null,\r\n \"last_wins\": \"\",\r\n \"total_bonuses\": \"\",\r\n \"last_real_bets\": \"\",\r\n \"last_real_wins\": \"\",\r\n \"total_deposits\": \"\",\r\n \"last_bonus_bets\": \"\",\r\n \"last_bonus_wins\": \"\",\r\n \"average_real_bet\": \"\",\r\n \"last_bets_amount\": \"\",\r\n \"last_wins_amount\": \"\",\r\n \"average_bonus_bet\": \"\",\r\n \"bonus_to_deposits\": \"\",\r\n \"last_deposit_date\": \"\",\r\n \"total_withdrawals\": \"\",\r\n \"is_phone_confirmed\": \"\",\r\n \"money_in_money_out\": \"\",\r\n \"last_deposit_amount\": \"\",\r\n \"last_freespins_date\": \"\",\r\n \"last_freespins_name\": \"\",\r\n \"last_free_bonus_date\": \"\",\r\n \"last_free_bonus_name\": \"\",\r\n \"total_bonuses_amount\": \"\",\r\n \"last_freespins_amount\": \"\",\r\n \"last_freespins_status\": \"\",\r\n \"last_real_bets_amount\": \"\",\r\n \"last_real_wins_amount\": \"\",\r\n \"total_deposits_amount\": \"\",\r\n \"last_bonus_bets_amount\": \"\",\r\n \"last_bonus_wins_amount\": \"\",\r\n \"last_free_bonus_amount\": \"\",\r\n \"last_free_bonus_status\": \"\",\r\n \"last_deposit_bonus_date\": \"\",\r\n \"last_deposit_bonus_name\": \"\",\r\n \"last_freespins_currency\": \"\",\r\n \"last_freespins_wagering\": \"\",\r\n \"withdrawals_to_deposits\": \"\",\r\n \"last_free_bonus_currency\": \"\",\r\n \"last_free_bonus_wagering\": \"\",\r\n \"total_withdrawals_amount\": \"\",\r\n \"withdrawal_ewallet_email\": \"\",\r\n \"last_deposit_bonus_amount\": \"\",\r\n \"last_deposit_bonus_status\": \"\",\r\n \"last_deposit_bonus_currency\": \"\",\r\n \"last_deposit_bonus_wagering\": \"\",\r\n \"session\": \"\",\r\n \"payment_mode\": \"\",\r\n \"card_fullname\": \"\",\r\n \"card_bin\": \"\",\r\n \"card_hash\": \"\",\r\n \"card_last\": \"\",\r\n \"card_expire\": \"\",\r\n \"avs_result\": \"\",\r\n \"cvv_result\": \"\",\r\n \"sca_method\": \"\",\r\n \"user_bank_account\": \"\",\r\n \"user_bank_name\": \"\",\r\n \"user_balance\": \"\",\r\n \"user_verification_level\": \"\",\r\n \"status_3d\": \"\",\r\n \"regulation\": \"\",\r\n \"payment_provider\": \"\",\r\n \"phone_number\": \"\",\r\n \"transaction_type\": \"\",\r\n \"transaction_amount\": \"\",\r\n \"transaction_currency\": \"\",\r\n \"merchant_id\": \"\",\r\n \"details_url\": \"\",\r\n \"name\": \"\",\r\n \"person_type\": \"\",\r\n \"gender\": \"\"\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.paystreamportal.com/api/v1/checkTransAllowed","description":"General TrustScore
\nRequest 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
\nAccess to this API has to be given to you by the admin. So please contact your sales representative at Paystream to get access to this API, if you get a 401 error of \"You are not allowed to call this API service\".
\nMandatory Parameters (in body)
\nOther optional paramters:
\nThe optional parameters are self-explanatory and appropriate values can be given in string format.
\nResponse
\nResponse contains a single parameter: transactionAllowed which can either be YES or NO .
{\n\"transactionAllowed\" : \"YES\"\n}\n\nIf there are any errors then it'll be in the format of :
\n{\n \"message\": \"descriptive error message\",\n \"code\": \"error_code\"\n}\n\nPossible Error Messages
\nthe possible error codes one can get on calling this APIs are:
\nfor example:
\n","urlObject":{"path":["checkTransAllowed"],"host":["https://api.paystreamportal.com/api/v1"],"query":[],"variable":[]}},"response":[{"id":"600ebd91-72e4-4d6a-bebd-94118738e0bc","name":"TrustScoreExists","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"requiredinput\": {\r\n \"ip\": \"2001:8004:cc2:fadb:9958:4523:6c42:e3f2\",\r\n \"email\": \"user5772@example.com\",\r\n \"url\": \"http://test.com\"\r\n },\r\n \"optionalInput\": {\r\n \"last_bets\": null,\r\n \"last_wins\": \"\",\r\n \"total_bonuses\": \"\",\r\n \"last_real_bets\": \"\",\r\n \"last_real_wins\": \"\",\r\n \"total_deposits\": \"\",\r\n \"last_bonus_bets\": \"\",\r\n \"last_bonus_wins\": \"\",\r\n \"average_real_bet\": \"\",\r\n \"last_bets_amount\": \"\",\r\n \"last_wins_amount\": \"\",\r\n \"average_bonus_bet\": \"\",\r\n \"bonus_to_deposits\": \"\",\r\n \"last_deposit_date\": \"\",\r\n \"total_withdrawals\": \"\",\r\n \"is_phone_confirmed\": \"\",\r\n \"money_in_money_out\": \"\",\r\n \"last_deposit_amount\": \"\",\r\n \"last_freespins_date\": \"\",\r\n \"last_freespins_name\": \"\",\r\n \"last_free_bonus_date\": \"\",\r\n \"last_free_bonus_name\": \"\",\r\n \"total_bonuses_amount\": \"\",\r\n \"last_freespins_amount\": \"\",\r\n \"last_freespins_status\": \"\",\r\n \"last_real_bets_amount\": \"\",\r\n \"last_real_wins_amount\": \"\",\r\n \"total_deposits_amount\": \"\",\r\n \"last_bonus_bets_amount\": \"\",\r\n \"last_bonus_wins_amount\": \"\",\r\n \"last_free_bonus_amount\": \"\",\r\n \"last_free_bonus_status\": \"\",\r\n \"last_deposit_bonus_date\": \"\",\r\n \"last_deposit_bonus_name\": \"\",\r\n \"last_freespins_currency\": \"\",\r\n \"last_freespins_wagering\": \"\",\r\n \"withdrawals_to_deposits\": \"\",\r\n \"last_free_bonus_currency\": \"\",\r\n \"last_free_bonus_wagering\": \"\",\r\n \"total_withdrawals_amount\": \"\",\r\n \"withdrawal_ewallet_email\": \"\",\r\n \"last_deposit_bonus_amount\": \"\",\r\n \"last_deposit_bonus_status\": \"\",\r\n \"last_deposit_bonus_currency\": \"\",\r\n \"last_deposit_bonus_wagering\": \"\",\r\n \"session\": \"\",\r\n \"payment_mode\": \"\",\r\n \"card_fullname\": \"\",\r\n \"card_bin\": \"\",\r\n \"card_hash\": \"\",\r\n \"card_last\": \"\",\r\n \"card_expire\": \"\",\r\n \"avs_result\": \"\",\r\n \"cvv_result\": \"\",\r\n \"sca_method\": \"\",\r\n \"user_bank_account\": \"\",\r\n \"user_bank_name\": \"\",\r\n \"user_balance\": \"\",\r\n \"user_verification_level\": \"\",\r\n \"status_3d\": \"\",\r\n \"regulation\": \"\",\r\n \"payment_provider\": \"\",\r\n \"phone_number\": \"\",\r\n \"transaction_type\": \"\",\r\n \"transaction_amount\": \"\",\r\n \"transaction_currency\": \"\",\r\n \"merchant_id\": \"\",\r\n \"details_url\": \"\",\r\n \"name\": \"\",\r\n \"person_type\": \"\",\r\n \"gender\": \"\"\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.paystreamportal.com/api/v1/checkTransAllowed"},"status":"Accepted","code":202,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Sun, 29 Oct 2023 09:21:22 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"Cache-Control","value":"no-cache, no-store, max-age=0, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Expires","value":"0"},{"key":"X-Frame-Options","value":"DENY"},{"key":"CF-Cache-Status","value":"DYNAMIC"},{"key":"Report-To","value":"{\"endpoints\":[{\"url\":\"https:\\/\\/a.nel.cloudflare.com\\/report\\/v3?s=r2%2FuLwSilxdD1lpiI1VqpgF0Tu9etiNhupySeBHl0zcU8XV1z8kwR%2FJ00ti4xpMdrTXW%2BkqZkLGrkkaUnMWFsaYlg%2FfA9UC4wIKwmc9LHUwna491EmnC3b3vlabzhUJ11CMpnVmicUE%3D\"}],\"group\":\"cf-nel\",\"max_age\":604800}"},{"key":"NEL","value":"{\"success_fraction\":0,\"report_to\":\"cf-nel\",\"max_age\":604800}"},{"key":"Server","value":"cloudflare"},{"key":"CF-RAY","value":"81da590e8d4345a0-LHR"},{"key":"alt-svc","value":"h3=\":443\"; ma=86400"}],"cookie":[],"responseTime":null,"body":"{\n \"transactionAllowed\": \"YES\"\n}"},{"id":"bd9bfe7c-6476-4f35-8628-57664860ae92","name":"TrustScoreError","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"requiredinput\": {\r\n \"ip\": \"2001:8004:cc2:fadb:9958:4523:6c42:e3f2\",\r\n \"email\": \"user5772@example.com\",\r\n \"url\": \"http://test.com\"\r\n },\r\n \"optionalInput\": {\r\n \"last_bets\": null,\r\n \"last_wins\": \"\",\r\n \"total_bonuses\": \"\",\r\n \"last_real_bets\": \"\",\r\n \"last_real_wins\": \"\",\r\n \"total_deposits\": \"\",\r\n \"last_bonus_bets\": \"\",\r\n \"last_bonus_wins\": \"\",\r\n \"average_real_bet\": \"\",\r\n \"last_bets_amount\": \"\",\r\n \"last_wins_amount\": \"\",\r\n \"average_bonus_bet\": \"\",\r\n \"bonus_to_deposits\": \"\",\r\n \"last_deposit_date\": \"\",\r\n \"total_withdrawals\": \"\",\r\n \"is_phone_confirmed\": \"\",\r\n \"money_in_money_out\": \"\",\r\n \"last_deposit_amount\": \"\",\r\n \"last_freespins_date\": \"\",\r\n \"last_freespins_name\": \"\",\r\n \"last_free_bonus_date\": \"\",\r\n \"last_free_bonus_name\": \"\",\r\n \"total_bonuses_amount\": \"\",\r\n \"last_freespins_amount\": \"\",\r\n \"last_freespins_status\": \"\",\r\n \"last_real_bets_amount\": \"\",\r\n \"last_real_wins_amount\": \"\",\r\n \"total_deposits_amount\": \"\",\r\n \"last_bonus_bets_amount\": \"\",\r\n \"last_bonus_wins_amount\": \"\",\r\n \"last_free_bonus_amount\": \"\",\r\n \"last_free_bonus_status\": \"\",\r\n \"last_deposit_bonus_date\": \"\",\r\n \"last_deposit_bonus_name\": \"\",\r\n \"last_freespins_currency\": \"\",\r\n \"last_freespins_wagering\": \"\",\r\n \"withdrawals_to_deposits\": \"\",\r\n \"last_free_bonus_currency\": \"\",\r\n \"last_free_bonus_wagering\": \"\",\r\n \"total_withdrawals_amount\": \"\",\r\n \"withdrawal_ewallet_email\": \"\",\r\n \"last_deposit_bonus_amount\": \"\",\r\n \"last_deposit_bonus_status\": \"\",\r\n \"last_deposit_bonus_currency\": \"\",\r\n \"last_deposit_bonus_wagering\": \"\",\r\n \"session\": \"\",\r\n \"payment_mode\": \"\",\r\n \"card_fullname\": \"\",\r\n \"card_bin\": \"\",\r\n \"card_hash\": \"\",\r\n \"card_last\": \"\",\r\n \"card_expire\": \"\",\r\n \"avs_result\": \"\",\r\n \"cvv_result\": \"\",\r\n \"sca_method\": \"\",\r\n \"user_bank_account\": \"\",\r\n \"user_bank_name\": \"\",\r\n \"user_balance\": \"\",\r\n \"user_verification_level\": \"\",\r\n \"status_3d\": \"\",\r\n \"regulation\": \"\",\r\n \"payment_provider\": \"\",\r\n \"phone_number\": \"\",\r\n \"transaction_type\": \"\",\r\n \"transaction_amount\": \"\",\r\n \"transaction_currency\": \"\",\r\n \"merchant_id\": \"\",\r\n \"details_url\": \"\",\r\n \"name\": \"\",\r\n \"person_type\": \"\",\r\n \"gender\": \"\"\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.paystreamportal.com/api/v1/checkTransAllowed"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Sun, 29 Oct 2023 09:28:33 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"Cache-Control","value":"no-cache, no-store, max-age=0, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Expires","value":"0"},{"key":"X-Frame-Options","value":"DENY"},{"key":"CF-Cache-Status","value":"DYNAMIC"},{"key":"Report-To","value":"{\"endpoints\":[{\"url\":\"https:\\/\\/a.nel.cloudflare.com\\/report\\/v3?s=herXY1o%2BFZa%2F3qNFjvh4ANgP%2FD0DdAVVFm0vUZDAst2rFkieItm%2Fu0VN24DYrdp7MHMHFKWLvrsBYVIxjDPDaLgJjeGBvlTP2iZoB5EnG1hPPHUVXRNP%2FGMmOTh%2Fp7gsyj0vihW1kMk%3D\"}],\"group\":\"cf-nel\",\"max_age\":604800}"},{"key":"NEL","value":"{\"success_fraction\":0,\"report_to\":\"cf-nel\",\"max_age\":604800}"},{"key":"Server","value":"cloudflare"},{"key":"CF-RAY","value":"81da6398ab144913-LHR"},{"key":"alt-svc","value":"h3=\":443\"; ma=86400"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Incorrect secret_key\",\n \"code\": \"authentication_failed\"\n}"}],"_postman_id":"5d111794-a354-469b-ba06-f26de4112bce"}],"id":"1cda2dc1-6bd8-47f6-bc91-7a173a832c21","_postman_id":"1cda2dc1-6bd8-47f6-bc91-7a173a832c21","description":""},{"name":"Cashier APIs","item":[{"name":"Customer","id":"9f91b5b7-d065-4666-bacf-4c29ca6adf38","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{APIKey}}","type":"text"},{"key":"BrandId","value":"your-brand-id","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"fullName\": \"Reese Nakamura\",\r\n \"emailId\": \"user7734@example.com\",\r\n \"dateOfBirth\": \"1994-06-03\",\r\n \"phoneNo\": \"+91 797639082\",\r\n \"city\": \"Riverton\",\r\n \"stateCode\": \"RJ\",\r\n \"zipCode\": \"302018\",\r\n \"address\": \"24 Sample Avenue\",\r\n \"country\": \"IN\",\r\n \"merchantCustomerId\": \"user8912@example.com\",\r\n \"CustRegDate\": \"2023-12-27\", //non-mandatory - customer registration date on merchant site\r\n \"SuccessTxn\": \"32\", //non-mandatory - total successful customer orders on merchant site\r\n \"extraParam\": {\r\n \"param1\": \"value1\",\r\n \"param2\": \"value2\",\r\n \"param3\": \"value3\",\r\n \"param4\": \"value4\"\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.paystreamportal.com/api/v1/customer","description":"OVERIEW
\nThe createCustomer API allows merchants to create a customer profile on Paystream when a user visits their website, facilitating a seamless payment experience by pre-filling the customer's details, on the Paystream 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.
\nUser Flow
\n- \n
Customer visits merchant's website: The customer selects the product or service and proceeds to checkout page.
\n \nMerchant calls the
\ncreateCustomerAPI: The merchant sends aPOSTrequest to the Paystream API with the customer's details. \nCustomer ID generation: Paystream processes the request and generates a unique
\ncustomerIdwhich is returned in the response. \nPayment Process: The merchant uses the
\ncustomerIdfor subsequent session creation, ensuring the customer doesn’t need to re-enter their details for future payments. \n
\n
Benefits
\n- \n
Seamless user experience: The customer does not have to enter their details manually for every purchase.
\n \nFaster Checkout: The merchant can use the
\ncustomerIdfor faster payment processing. \nData Security: Customer details are stored securely and can be reused across transactions, reducing the chances of errors.
\n \n
Implementing createCustomer on merchant site:
\nThe createCustomer can be implemented on merchant site in one of two ways, depending on merchant’s integration flow:
At Checkout:
\nWhen a customer initiates the checkout process, your system should invoke the createCustomer API, before actually starting the session.
- \n
Call
\ncreateCustomer: This API call generates a unique customer ID. \nUse of Customer ID: Pass the returned customer ID in Session API, when creating a payment session.
\n \n
Upon Customer Login:
\nAlternatively, merchants may choose to call createCustomer at the time of customer login on their site.
- \n
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
\ncreateCustomeragain. \nIntegration Flexibility: This is useful for merchants who want to initialize customer data early in the customer journey rather than during checkout.
\n \n
The method you choose depends on your business requirements and how your system is architected. Regardless of when you call it, the resulting customer ID must be passed to the createSession API to initiate a payment session.
This endpoint makes an HTTP GET request to retrieve customer information from the Paystream API.
\nRequest
\nThe request does not include any query parameters, but it uses a raw request body with the following parameter \"merchantCustomerId\", which will be the customer id on the merchant's side.
\nResponse
\nThe response of this request can be documented as a JSON schema.
\n","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"993d95cb-bd68-46e4-8710-cce0d0b8c198","id":"993d95cb-bd68-46e4-8710-cce0d0b8c198","name":"Cashier APIs","type":"folder"}},"urlObject":{"path":["customer"],"host":[""],"query":[],"variable":[]}},"response":[{"id":"95ab4ebc-5680-439b-9189-c5d74e980853","name":"Success","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"*/*","type":"text"},{"key":"BrandId","value":"your-brand-id","type":"text"},{"key":"Authorization","value":"Bearer {{APIKey}}","type":"text"}],"url":"/customer"},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":"{\n \"customerId\": \"691afbc6fd96d34a8113a34d\",\n \"merchantCustomerId\": \"user5489@example.com\",\n \"fullName\": \"Reese Nakamura\",\n \"emailId\": \"user7734@example.com\",\n \"dateOfBirth\": \"1994-06-03\",\n \"phoneNo\": \"+91 797639082\",\n \"brandID\": \"your-brand-id\",\n \"city\": \"Riverton\",\n \"zipCode\": \"302018\",\n \"address\": \"24 Sample Avenue\",\n \"country\": \"IN\",\n \"stateCode\": \"RJ\",\n \"custRegDate\": \"2023-12-27\",\n \"successTrans\": 0,\n \"createdOn\": 1763376070,\n \"lastUpdated\": 0,\n \"lastActivity\": 1763376070,\n \"extraParam\": {\n \"param1\": \"value1\",\n \"param2\": \"value2\",\n \"param3\": \"value3\",\n \"param4\": \"value4\"\n }\n}"},{"id":"ed8c771d-d803-437d-b22a-0a31d0167cea","name":"Invalid Customer","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"*/*","type":"text"},{"key":"BrandId","value":"your-brand-id","type":"text"},{"key":"Authorization","value":"Bearer {{APIKey}}","type":"text"}],"url":"/customer"},"status":"Bad Request","code":400,"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Customer with this information does not exist\",\n \"code\": \"customer_does_not_exist\"\n}"}],"_postman_id":"357f3327-7b8b-409e-b0cf-e68872c730d5"},{"name":"Customer","event":[{"listen":"test","script":{"exec":["var template = `","","","| Customer ID | ","First Name | ","Last Name | ","Phone | ","|
|---|---|---|---|---|
| {{response.customerId}} | ","{{response.firstName}} | ","{{response.lastName}} | ","{{response.email}} | ","{{response.phone}} | ","
Whenever a customer or the merchant updates customer details on the merchant site, a PATCH request must be made to synchronize these changes with Paystream.
\nThis API endpoint allows you to update the customer details using an HTTP PATCH request. The request should be sent to https://api.paystreamportal.com/api/v1/{customerId}/patchCustomer.
\nRequest Body
\nThe request body should be in raw format and include the following parameters:
\n- \n
\nfullName(string): The full name of the customer. \n
\nemailId(string): The email address of the customer. \n
\ndateOfBirth(string): The date of birth of the customer. \n
\nphoneNo(string): The phone number of the customer. \n
\ncity(string): The city of the customer. \n
\nstateCode(string): The state code of the customer. \n
\nzipCode(string): The zip code of the customer. \n
\naddress(string): The address of the customer. \n
\ncountry(string): The country of the customer. \n
\ncreatedOn(string): Time when the customer was created. \n
\ncustRegDate(string): Customer registration date (Non-Mandatory). \n
\nsuccessTxn(string): Success transaction details (Non-Mandatory). \n
\nlastActivity(string): Time of the last activity. \n
\nlastUpdated(string): Time when the last patch was called. \n
\nextraParam(object): Additional parameters includingparam1,param2,param3,param4with their respective values. \n
Response
\nThe response will contain the updated customer details or a success message upon successful update.
\n","urlObject":{"path":["{PaystreamCustomerId}","patchCustomer"],"host":["https://api.paystreamportal.com/api/v1"],"query":[],"variable":[]}},"response":[{"id":"c6846e31-36ed-4c9a-9135-4222fc489e3a","name":"Success","originalRequest":{"method":"PATCH","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"*/*","type":"text"},{"key":"BrandId","value":"your-brand-id","type":"text"},{"key":"Authorisation","value":"Bearer Token","type":"text"}],"body":{"mode":"raw","raw":"{\n \"fullName\": \"Reese Rivera\",\n \"emailId\": \"user5989@example.com\",\n \"dateOfBirth\": \"1990-11-27\",\n \"phoneNo\": \"+91 9413666514\",\n \"city\": \"Kingsport\",\n \"stateCode\": \"Raj\",\n \"zipCode\": \"202021\",\n \"address\": \"58 Testing Lane\",\n \"country\": \"IN\",\n \"CustRegDate\": \"2023-12-28\",\n \"SuccessTxn\": \"33\",\n \"extraParam\": {\n \"param1\": \"value1\",\n \"param2\": \"value2\",\n \"param3\": \"value3\",\n \"param4\": \"value4\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://api.paystreamportal.com/api/v1/{PaystreamCustomerId}/patchCustomer"},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":"{\n \"customerId\": \"691afbc6fd96d34a8113a34d\",\n \"merchantCustomerId\": \"user5489@example.com\",\n \"fullName\": \"Reese Rivera\",\n \"emailId\": \"user5989@example.com\",\n \"dateOfBirth\": \"1990-11-27\",\n \"phoneNo\": \"+91 9413666514\",\n \"brandID\": \"your-brand-id\",\n \"city\": \"Kingsport\",\n \"zipCode\": \"202021\",\n \"address\": \"58 Testing Lane\",\n \"country\": \"IN\",\n \"stateCode\": \"Raj\",\n \"custRegDate\": \"2023-12-28\",\n \"successTrans\": 0,\n \"createdOn\": 1763376070,\n \"lastUpdated\": 1763377024,\n \"lastActivity\": 1763377024,\n \"extraParam\": {\n \"param1\": \"value1\",\n \"param2\": \"value2\",\n \"param3\": \"value3\",\n \"param4\": \"value4\"\n }\n}"}],"_postman_id":"83ffd617-3c98-4cd9-b463-8975515ef876"},{"name":"Purchase Session","id":"4231a4be-3271-41eb-b3df-3e8db4525717","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{APIKey}}","type":"text"},{"key":"BrandId","value":"your-brand-id","type":"text"},{"key":"Accept","value":"*/*","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"customerId\": \"68fed1855ebbe829416b08c6\",\r\n \"merchantRef\": \"user5489@example.com\", // optional\r\n \"currency\": \"EUR\",\r\n \"products\": [\r\n {\r\n \"name\": \"Product1\",\r\n \"price\": \"10\"\r\n },\r\n {\r\n \"name\": \"Product2\",\r\n \"price\": \"12\"\r\n }\r\n ],\r\n \"totalAmount\": \"22\", // optional, but if present have precedence over sum of prices mentioned above.\r\n \"paymentMethod\": \"VISA\", //optional\r\n \"success_redirect\": \"https://your.success.redirect.com\",\r\n \"failure_redirect\": \"https://your.failure.redirect.com\",\r\n \"pending_redirect\": \"https://your.pending.redirect.com\",\r\n \"success_callback\": \"https://your.success.callback.com\",\r\n \"failure_callback\": \"https://your.failure.callback.com\",\r\n \"extraParam\": {\r\n \"param1\": \"value1\",\r\n \"showCryptoConversion\": \"yes\",\r\n \"cryptoCurrencies\": \"[\\\"BTC\\\",\\\"ETH\\\",\\\"USDT\\\",\\\"XRP\\\",\\\"LTC\\\",\\\"DOGE\\\",\\\"ETC\\\",\\\"BNB\\\",\\\"USDC\\\",\\\"SOL\\\",\\\"ADA\\\",\\\"BCH\\\",\\\"DASH\\\",\\\"BTG\\\",\\\"ZEC\\\",\\\"DGB\\\",\\\"EOS\\\",\\\"XLM\\\",\\\"TRX\\\",\\\"QTUM\\\",\\\"POL\\\",\\\"SHIB\\\",\\\"LINK\\\",\\\"DAI\\\",\\\"TON\\\",\\\"AVAX\\\",\\\"FDUSD\\\",\\\"ARB\\\",\\\"OP\\\"]\",\r\n \"param3\": \"value3\",\r\n \"param4\": \"value4\"\r\n }\r\n }","options":{"raw":{"language":"json"}}},"url":"https://api.paystreamportal.com/api/v1/createSession","description":"OVERIEW
\nThe createSession API is designed to initiate a payment session for a customer after their profile has been created via the createCustomer API. The session is automatically generated at the backend on the merchant’s checkout URL. This session allows the customer to continue with their transaction without having to manually interact with the session URL, and ensures the session remains active until the payment is completed or the session expires.
This API improves the user experience by reducing transaction failures and enhancing the overall payment process, thus reducing transaction churn rates.
\nMandatory Parameters
\nShow Crypto Conversion
\nAdditionally, there are some default extra parameters that you can pass for allowing Crypto Conversion on Paystream's cashier itself.
\nUsage Flow
\n- \n
Customer completes the
\ncreateCustomerAPI: Once the customer is created via thecreateCustomerAPI, the merchant proceeds to call thecreateSessionAPI to generate a session. \nMerchant sends
\ncreateSessionrequest: The merchant sends aPOSTrequest to thecreateSessionAPI with the customer’scustomerIdand the merchant’sbrandId. \nSession created automatically on the checkout URL: Paystream 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 \nCustomer proceeds to checkout: The customer is redirected to the checkout page as part of the merchant's payment flow, where the session is automatically validated. The session remains active for a set period, allowing the customer to complete the payment without needing to manually interact with the session URL.
\n \nSession Expiry: The session expires after the set expiration time (
\nexpiryOn), ensuring the payment process is completed within the defined window. Default is 15 mins from the creation time. \n
\n
Benefits
\n- \n
Seamless Checkout: The session URL is automatically generated and active at the backend, ensuring a smoother and uninterrupted customer experience.
\n \nReduced Transaction Failures: By ensuring the session remains active during the payment process, the chances of transaction failures due to session timeouts are minimized.
\n \nImproved User Experience: The customer does not need to click on a session URL or navigate away from the page, leading to faster and more secure payment processing.
\n \n
This API is used to initiate a payout session for a customer. By passing the customerId (generated via the createCustomer API) and specifying \"type\": \"payout\", a payout session is started.
A sessionURL is returned in the response, which can be used to redirect the customer to the payout cashier. The customer can then select the payout method, pass required parameters, and the payout will be processed.
Parameters:
\nRequest Headers:
\n- \n
BrandId: Your unique brand ID (required).
\n \nContent-Type: application/json (required).
\n \n
Response:
\nThe API will return a JSON object containing the sessionURL that can be used to redirect the customer to the payout cashier.
{\n \"sessionUrl\": \"https://api.paystreamportal.com/payoutSession/68341ad35f895955355d5452/\",\n \"brandId\": \"your-brand-id\",\n \"customerId\": \"67c9983fba18400ab6cceb8f\",\n \"sessionId\": \"68341ad35f895955355d5452\",\n \"expiryOn\": 1748246103,\n \"createdOn\": 1748245203\n}\n\nThis endpoint retrieves the details of a session identified by the provided session ID.
\n\n\nNote that this API only respond once the SessionURL, received in the response for session API, is clicked.
\n
\n\n","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"993d95cb-bd68-46e4-8710-cce0d0b8c198","id":"993d95cb-bd68-46e4-8710-cce0d0b8c198","name":"Cashier APIs","type":"folder"}},"urlObject":{"path":["purchases","{Session ID}",""],"host":["https://api.paystreamportal.com/api/v1"],"query":[],"variable":[]}},"response":[{"id":"3b746f76-201d-4323-b573-0b943e41f0fa","name":"202 Success","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{APIKey}}"}],"url":"https://api.paystreamportal.com/api/v1/purchases/6950e4ba5205280b71ac2010/"},"status":"Accepted","code":202,"_postman_previewlanguage":"Text","header":[{"key":"Date","value":"Sun, 28 Dec 2025 08:03:36 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Nel","value":"{\"report_to\":\"cf-nel\",\"success_fraction\":0.0,\"max_age\":604800}"},{"key":"X-Frame-Options","value":"ALLOW-FROM *"},{"key":"Referrer-Policy","value":"no-referrer"},{"key":"x-session-id","value":"d5308b2a-537d-466a-8273-f754ba3491b8"},{"key":"Vary","value":"Origin"},{"key":"Vary","value":"Access-Control-Request-Method"},{"key":"Vary","value":"Access-Control-Request-Headers"},{"key":"Server","value":"cloudflare"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"0"},{"key":"Cache-Control","value":"no-cache, no-store, max-age=0, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Expires","value":"0"},{"key":"Strict-Transport-Security","value":"max-age=31536000 ; includeSubDomains"},{"key":"X-Cache","value":"Error from cloudfront"},{"key":"Via","value":"1.1 f89daa99b6a349030b23247a4977cb5e.cloudfront.net (CloudFront)"},{"key":"X-Amz-Cf-Pop","value":"IAD61-P10"},{"key":"X-Amz-Cf-Id","value":"Ed-N_b__1xPz7yrAt9mMc6JrgiZqMiuPi3uJbZ4AeuUKm-Ziiohlcw=="},{"key":"cf-cache-status","value":"DYNAMIC"},{"key":"Report-To","value":"{\"group\":\"cf-nel\",\"max_age\":604800,\"endpoints\":[{\"url\":\"https://a.nel.cloudflare.com/report/v4?s=V90OEeQkl%2Fh028giW2T2qMbuNADZ5EvKMZG33harMVuXpmo%2BnNQm5JeDtH2802Oa8hw5kJG737sqfdiLVuvIq%2F5E5tHoRdK8Zj6OU6yO255A\"}]}"},{"key":"CF-RAY","value":"9b4f8ac7caf2f4ca-IAD"},{"key":"alt-svc","value":"h3=\":443\"; ma=86400"}],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\n \"purchaseId\": \"6950e4e3e4a1b008c2fae5c3\",\n \"client\": {\n \"customerId\": \"69034a5a61b460084d20c23b\",\n \"email\": \"user8399@example.com\",\n \"phone\": \"+919634088561\",\n \"full_name\": \"Reese Nakamura\",\n \"street_address\": \"90 Fixture Close\",\n \"country\": \"NA\",\n \"city\": \"Ashford\",\n \"zip_code\": \"202020\",\n \"cc\": [],\n \"bcc\": [],\n \"stateCode\": \"RA\"\n },\n \"updated_on\": 1766909180,\n \"type\": \"purchase\",\n \"paymentMethod\": \"MASTER,VISA,JCB,AMEX,CRYPTO-BRIDGE,FawryPay,INTERAC-E-TRANSFER,INTERAC-REQUEST-MONEY,MOBILEMONEY,NEOSURF,PAYID,PIX,SPEI,THIRDPARTY-UPI,DISCOVER,BANKTRANSFER,VIRTUAL-IBAN,UPI-COLLECT,UPI-QR,VIRTUAL-ACCOUNT,DINERS,NETBANKING,THIRDPARTY-NETBANKING,MAYA,GCASH,INTERAC-EXPRESS,QRPH\",\n \"amountUnit\": \"MAJOR\",\n \"errorMsg\": \"This customer can not be processed !\",\n \"errorCode\": \"NA\",\n \"savedCardUsed\": \"NO\",\n \"redirectType\": \"POST\",\n \"force_recurring\": false,\n \"created_on\": 1766909155,\n \"merchantRef\": \"6950e4e3e4a1b008c2fae5c3\",\n \"merchantName\": \"Morgan Costa_test\",\n \"merchantType\": \"MERCHANT\",\n \"purchase\": {\n \"currency\": \"EUR\",\n \"products\": [\n {\n \"name\": \"NA\",\n \"quantity\": 1.0,\n \"price\": 22.0,\n \"discount\": 0,\n \"tax_percent\": \"0.00\"\n }\n ],\n \"total\": 22.0,\n \"requestAmount\": 22.0,\n \"language\": \"en\",\n \"notes\": \"\",\n \"debt\": 0,\n \"total_formatted\": 1.0,\n \"taxAmount\": 0.0,\n \"taxPercent\": 0.0,\n \"request_client_details\": [],\n \"email_message\": \"\"\n },\n \"issuer_details\": {\n \"website\": \"\",\n \"legal_street_address\": \"\",\n \"legal_country\": \"\",\n \"legal_city\": \"\",\n \"legal_zip_code\": \"\",\n \"bank_accounts\": [\n {}\n ],\n \"legal_name\": \"Testing\",\n \"brand_name\": \"Testing\",\n \"registration_number\": \"\",\n \"tax_number\": \"\"\n },\n \"transaction_data\": {\n \"payment_method\": \"\",\n \"flow\": \"payform\",\n \"extra\": {\n \"expiry_month\": \"07\",\n \"amount\": 22.0,\n \"card_issuer\": \"CIAGROUP\",\n \"masked_pan\": \"55555555****4444\",\n \"card_brand\": \"MASTER\",\n \"card_issuer_country\": \"BR\",\n \"card_type\": \"DEBIT\",\n \"cardholder_name\": \"Morgan Costa\",\n \"expiry_year\": \"30\"\n },\n \"country\": \"\",\n \"attempts\": [\n {\n \"client_ip\": \"203.0.113.4\",\n \"type\": \"execute\",\n \"payment_method\": \"MASTER\",\n \"flow\": \"payform\",\n \"successful\": false,\n \"country\": \"BR\",\n \"processing_time\": 1766909179,\n \"extra\": {\n \"expiry_month\": \"07\",\n \"amount\": 22.0,\n \"card_issuer\": \"CIAGROUP\",\n \"masked_pan\": \"55555555****4444\",\n \"card_brand\": \"MASTER\",\n \"card_issuer_country\": \"BR\",\n \"card_type\": \"DEBIT\",\n \"cardholder_name\": \"Morgan Costa\",\n \"expiry_year\": \"30\"\n },\n \"error\": {\n \"message\": \"This customer can not be processed !\",\n \"code\": \"no_mid_found\"\n }\n }\n ]\n },\n \"status\": \"ERROR\",\n \"status_history\": [\n {\n \"status\": \"created\",\n \"timestamp\": 1766909155\n },\n {\n \"status\": \"pending_execute\",\n \"timestamp\": 1766909179\n },\n {\n \"status\": \"error\",\n \"timestamp\": 1766909180\n },\n {\n \"status\": \"viewed\",\n \"timestamp\": 1766909186\n }\n ],\n \"viewedOn\": 1766909186,\n \"is_test\": false,\n \"brand_id\": \"your-brand-id\",\n \"send_receipt\": false,\n \"is_recurring_token\": false,\n \"skip_capture\": false,\n \"reference_generated\": \"PS334\",\n \"issued\": \"2025-12-28\",\n \"due\": 1766909155,\n \"refund_upto\": 0,\n \"cc_descriptor\": \"\",\n \"fraudScore\": \"0\",\n \"trustScore\": \"0\",\n \"extraFee\": \"0\",\n \"paidOn\": 0,\n \"receivedAmt\": 0.0,\n \"taxAmount\": 0.0,\n \"surcharge\": 0.0,\n \"surchargeType\": \"\",\n \"sessionId\": \"6950e4ba5205280b71ac2010\",\n \"refund_availability\": \"NONE\",\n \"refundable_amount\": 0.0,\n \"success_redirect\": \"https://your.success.redirect.com\",\n \"failure_redirect\": \"https://your.failure.redirect.com\",\n \"pending_redirect\": \"https://your.pending.redirect.com\",\n \"cancel_redirect\": \"\",\n \"success_callback\": \"https://your.success.callback.com\",\n \"failure_callback\": \"https://your.failure.callback.com\",\n \"platform\": \"API\",\n \"checkout_url\": \"https://api.paystreamportal.com/payments/adb6e07f74ec6197ef764909736d478e/\",\n \"direct_post_url\": \"https://api.paystreamportal.com/api/v1/p/6950e4e3e4a1b008c2fae5c3/\",\n \"payoutProcess\": false\n}"},{"id":"5e7a87cb-f7a1-4d28-9402-7fffa49498f3","name":"400 Bad Request","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{APIKey}}"}],"url":"https://api.paystreamportal.com/api/v1/purchases/6950e4ba5205280b71ac2010/"},"status":"Bad Request","code":400,"_postman_previewlanguage":"Text","header":[{"key":"Date","value":"Sun, 28 Dec 2025 08:03:36 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Nel","value":"{\"report_to\":\"cf-nel\",\"success_fraction\":0.0,\"max_age\":604800}"},{"key":"X-Frame-Options","value":"ALLOW-FROM *"},{"key":"Referrer-Policy","value":"no-referrer"},{"key":"x-session-id","value":"d5308b2a-537d-466a-8273-f754ba3491b8"},{"key":"Vary","value":"Origin"},{"key":"Vary","value":"Access-Control-Request-Method"},{"key":"Vary","value":"Access-Control-Request-Headers"},{"key":"Server","value":"cloudflare"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"0"},{"key":"Cache-Control","value":"no-cache, no-store, max-age=0, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Expires","value":"0"},{"key":"Strict-Transport-Security","value":"max-age=31536000 ; includeSubDomains"},{"key":"X-Cache","value":"Error from cloudfront"},{"key":"Via","value":"1.1 f89daa99b6a349030b23247a4977cb5e.cloudfront.net (CloudFront)"},{"key":"X-Amz-Cf-Pop","value":"IAD61-P10"},{"key":"X-Amz-Cf-Id","value":"Ed-N_b__1xPz7yrAt9mMc6JrgiZqMiuPi3uJbZ4AeuUKm-Ziiohlcw=="},{"key":"cf-cache-status","value":"DYNAMIC"},{"key":"Report-To","value":"{\"group\":\"cf-nel\",\"max_age\":604800,\"endpoints\":[{\"url\":\"https://a.nel.cloudflare.com/report/v4?s=V90OEeQkl%2Fh028giW2T2qMbuNADZ5EvKMZG33harMVuXpmo%2BnNQm5JeDtH2802Oa8hw5kJG737sqfdiLVuvIq%2F5E5tHoRdK8Zj6OU6yO255A\"}]}"},{"key":"CF-RAY","value":"9b4f8ac7caf2f4ca-IAD"},{"key":"alt-svc","value":"h3=\":443\"; ma=86400"}],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\n \"message\": \"PurchaseId Not found.\",\n \"code\": \"transaction_error\"\n}"},{"id":"c5b747d6-6eea-41b1-9d6b-102b2a59462a","name":"401 Unauthorized","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{APIKey}}"}],"url":"https://api.paystreamportal.com/api/v1/purchases/{Session ID}/"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"Text","header":[{"key":"Date","value":"Sun, 28 Dec 2025 08:03:36 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Nel","value":"{\"report_to\":\"cf-nel\",\"success_fraction\":0.0,\"max_age\":604800}"},{"key":"X-Frame-Options","value":"ALLOW-FROM *"},{"key":"Referrer-Policy","value":"no-referrer"},{"key":"x-session-id","value":"d5308b2a-537d-466a-8273-f754ba3491b8"},{"key":"Vary","value":"Origin"},{"key":"Vary","value":"Access-Control-Request-Method"},{"key":"Vary","value":"Access-Control-Request-Headers"},{"key":"Server","value":"cloudflare"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"0"},{"key":"Cache-Control","value":"no-cache, no-store, max-age=0, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Expires","value":"0"},{"key":"Strict-Transport-Security","value":"max-age=31536000 ; includeSubDomains"},{"key":"X-Cache","value":"Error from cloudfront"},{"key":"Via","value":"1.1 f89daa99b6a349030b23247a4977cb5e.cloudfront.net (CloudFront)"},{"key":"X-Amz-Cf-Pop","value":"IAD61-P10"},{"key":"X-Amz-Cf-Id","value":"Ed-N_b__1xPz7yrAt9mMc6JrgiZqMiuPi3uJbZ4AeuUKm-Ziiohlcw=="},{"key":"cf-cache-status","value":"DYNAMIC"},{"key":"Report-To","value":"{\"group\":\"cf-nel\",\"max_age\":604800,\"endpoints\":[{\"url\":\"https://a.nel.cloudflare.com/report/v4?s=V90OEeQkl%2Fh028giW2T2qMbuNADZ5EvKMZG33harMVuXpmo%2BnNQm5JeDtH2802Oa8hw5kJG737sqfdiLVuvIq%2F5E5tHoRdK8Zj6OU6yO255A\"}]}"},{"key":"CF-RAY","value":"9b4f8ac7caf2f4ca-IAD"},{"key":"alt-svc","value":"h3=\":443\"; ma=86400"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Incorrect secret_key\",\n \"code\": \"authentication_failed\"\n}"}],"_postman_id":"69ea342e-b6c4-4fe3-8c20-35e6ef47407c"},{"name":"Check Status - Payout","id":"4bcb75f2-b9b9-4f05-9fde-1a071b1d3daa","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{APIKey}}","type":"text"}],"url":"https://api.paystreamportal.com/api/v1/getpayout/{Session ID}/","description":"Once the SessionURL is clicked and the user has selected a payment method and click on \"Pay\" button, a purchase is created on our backend. If you call this API before that, you will get an error.
\n
This API tells you about all the details of a Payout, including its history
\nMandatory
\nyou need to pass the payoutId or session id in the API URL
\nPossible Value of Status
\n","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"993d95cb-bd68-46e4-8710-cce0d0b8c198","id":"993d95cb-bd68-46e4-8710-cce0d0b8c198","name":"Cashier APIs","type":"folder"}},"urlObject":{"path":["getpayout","{Session ID}",""],"host":["https://api.paystreamportal.com/api/v1"],"query":[],"variable":[]}},"response":[{"id":"a9cd6508-9f65-4a17-aa7c-c779941300f8","name":"Success","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{APIKey}}","type":"text"}],"url":"https://api.paystreamportal.com/api/v1/getpayout/{Session ID}/"},"status":"Accepted","code":202,"_postman_previewlanguage":"Text","header":[{"key":"Date","value":"Mon, 27 Apr 2026 07:03:52 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Nel","value":"{\"report_to\":\"cf-nel\",\"success_fraction\":0.0,\"max_age\":604800}"},{"key":"X-Frame-Options","value":"ALLOW-FROM *"},{"key":"Referrer-Policy","value":"no-referrer"},{"key":"x-session-id","value":"9be65213-e200-4ef2-831c-683022389e8b"},{"key":"Vary","value":"Origin"},{"key":"Vary","value":"Access-Control-Request-Method"},{"key":"Vary","value":"Access-Control-Request-Headers"},{"key":"Server","value":"cloudflare"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"0"},{"key":"Cache-Control","value":"no-cache, no-store, max-age=0, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Expires","value":"0"},{"key":"Strict-Transport-Security","value":"max-age=31536000 ; includeSubDomains"},{"key":"X-Cache","value":"Error from cloudfront"},{"key":"Via","value":"1.1 ea9784182c7536f5ce15ec71cf0089d6.cloudfront.net (CloudFront)"},{"key":"X-Amz-Cf-Pop","value":"IAD61-P10"},{"key":"X-Amz-Cf-Id","value":"SQqBgIYJCqc_HzF2NrYyoiCCGUdxGyPFZ3OzmUrrL-XBe56tKWTifA=="},{"key":"cf-cache-status","value":"DYNAMIC"},{"key":"Report-To","value":"{\"group\":\"cf-nel\",\"max_age\":604800,\"endpoints\":[{\"url\":\"https://a.nel.cloudflare.com/report/v4?s=dRx0V9WF8UC%2FPmYeyh%2Fl2YI7rIhT15NcQDiRVHdKuzF4jjsVyYmbl2imFi%2FSpP4VpmIHsFmO0xzXUjyO1%2BwKeupdremHVjRNwtqENY%2FZxgVpN7KFFzAhSQDhOMdd62Anr2zN\"}]}"},{"key":"CF-RAY","value":"9f2bf84969fa9c85-IAD"}],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\n \"payoutId\": \"65ffadb4c1c83822903a9205\",\n \"client\": {\n \"email\": \"user5424@example.com\",\n \"full_name\": \"Avery Larsen\",\n \"street_address\": \"13 Documentation Way\",\n \"country\": \"SG\",\n \"city\": \"Oakdale\",\n \"zip_code\": \"123456\",\n \"stateCode\": \"test\"\n },\n \"updated_on\": 1711254964,\n \"payoutMethod\": \"Payout-BANKTRANSFER\",\n \"beneficiaryDetail\":{\n \"bankName\": \"DBS Bank\", \n \"bankAccountName\": \"test test\",\n \"bankAccountCurrency\": \"SGD\",\n \"bankAccountNumber\": \"12345640\",\n \"bankCountryCode\" : \"SG\",\n \"swiftCode\": \"DBSSSGSG\",\n \"routing_param\" :\n {\n \"bankCode\": \"897678\",\n \"bankBranchCode\" : \"888\"\n \n }\n },\n \"amountUnit\": \"MAJOR\",\n \"amount\": 1000.0,\n \"errorMsg\": \"Currency Account has insufficient balance.\",\n \"purpose\": \"test payout\",\n \"created_on\": 1711254972,\n \"merchantRef\": \"65ffadb4c1c83822903a9205\",\n \"status\": \"ERROR\",\n \"status_history\": [\n {\n \"status\": \"created\",\n \"timestamp\": 1711254964\n },\n {\n \"status\": \"error\",\n \"timestamp\": 1711254972\n }\n ],\n \"currency\": \"USD\",\n \"success_callback\": \"https://your.success.callback.com\",\n \"failure_callback\": \"https://your.failure.callback.com\"\n}"}],"_postman_id":"4bcb75f2-b9b9-4f05-9fde-1a071b1d3daa"}],"id":"993d95cb-bd68-46e4-8710-cce0d0b8c198","description":"Paystream Cashier is a unified payment management solution that connects with leading PSP and acquirers, offering merchants one convenient access point to simplify transaction processing and enhance efficiency.
\nTo start the cashier system, a payment session is initiated—a secure, temporary environment generated by our payment gateway. This session encapsulates all transaction details and state information before the cashier loads, overseeing the complete lifecycle of a payment attempt—from initial setup to final completion—ensuring every necessary detail is managed safely and consistently.
\n","auth":{"type":"noauth","isInherited":false},"event":[{"listen":"prerequest","script":{"type":"text/javascript","packages":{},"requests":{},"exec":[""],"id":"0511808f-62a3-44c6-b115-bc8133050abe"}},{"listen":"test","script":{"type":"text/javascript","packages":{},"requests":{},"exec":[""],"id":"533bcf84-aabb-4ab9-8fff-08895c6e7c88"}}],"_postman_id":"993d95cb-bd68-46e4-8710-cce0d0b8c198"},{"name":"User Defined Fields (UDF)","item":[],"id":"264c654d-48da-48b5-b16c-468a6a506ed3","description":"User Defined Fields (also referred to as Merchant Defined Parameters) allow you to attach custom identifiers to transactions. These identifiers can help you map transactions to your internal systems and configure advanced routing rules.
\nOnce created, you can pass the parameter in the purchases or session API using the extraParam object in the payload, to receive the same in the API response and the following webhooks.
Adding a User Defined Field
\n- \n
Click Add Parameters.
\n \nEnter the Parameter Name.
\n \nChoose the Value Type (Numeric, String, or Boolean).
\n \nClick Add to save.
\n \n
Here is how you can define UDFs in Paystream's app.
\nUsing UDF in API Requests
\nOnce created, you can pass the parameter in the purchases or session API using the extraParam object in the payload, to receive the same in the API response and the following webhooks.
\"extraParam\": {\n \"userDefinedParameter\": \"value\"\n}\n\nBest Practices
\n- \n
Use consistent naming conventions for parameters to avoid confusion across integrations.
\n \nKeep the number of UDFs minimal — only add fields that provide clear value (e.g., customer segment, order type, risk score).
\n \nLeverage UDFs in rule-based routing to optimize processing flows (e.g., route high-value transactions to a specific MID).
\n \nDocument your UDFs internally so operations and support teams can easily reference them.
\n \n
Note:
This feature is enabled only for the whitelabel merchant solution. If you are using a merchant solution, please contact your Account Manager for doing these changes.
For cases where the Merchant handles the scheduling:
\nFor cases where Paystream handles the scheduling:
\nOVERIEW
\nThe createCustomer API allows merchants to create a customer profile on Paystream when a user visits their website, facilitating a seamless payment experience by pre-filling the customer's details, on the Paystream Cashier.
\nThe 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.
\nUser Flow
\n- \n
Customer visits merchant's website: The customer selects the product or service and proceeds to checkout page.
\n \nMerchant calls the
\ncreateCustomerAPI: The merchant sends aPOSTrequest to the Paystream API with the customer's details. \nCustomer ID generation: Paystream processes the request and generates a unique
\ncustomerIdwhich is returned in the response. \nPayment Process: The merchant uses the
\ncustomerIdfor subsequent session creation, ensuring the customer doesn’t need to re-enter their details for future payments. \n
\n
Benefits
\n- \n
Seamless user experience: The customer does not have to enter their details manually for every purchase.
\n \nFaster Checkout: The merchant can use the
\ncustomerIdfor faster payment processing. \nData Security: Customer details are stored securely and can be reused across transactions, reducing the chances of errors.
\n \n
Implementing createCustomer on merchant site:
\nThe createCustomer can be implemented on merchant site in one of two ways, depending on merchant’s integration flow:
At Checkout:
\nWhen a customer initiates the checkout process, your system should invoke the createCustomer API, before actually starting the session.
- \n
Call
\ncreateCustomer: This API call generates a unique customer ID. \nUse of Customer ID: Pass the returned customer ID in Session API, when creating a payment session.
\n \n
Upon Customer Login:
\nAlternatively, merchants may choose to call createCustomer at the time of customer login on their site.
- \n
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
\ncreateCustomeragain. \nIntegration Flexibility: This is useful for merchants who want to initialize customer data early in the customer journey rather than during checkout.
\n \n
The method you choose depends on your business requirements and how your system is architected. Regardless of when you call it, the resulting customer ID must be passed to the createSession API to initiate a payment session.
This endpoint makes an HTTP GET request to retrieve customer information from the Paystream API.
\nRequest
\nThe request does not include any query parameters, but it uses a raw request body with the following parameter \"merchantCustomerId\", which will be the customer id on the merchant's side.
\nResponse
\nThe response of this request can be documented as a JSON schema.
\n","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"ffd21edb-563a-4651-9915-a7f8da7c7a43","id":"ffd21edb-563a-4651-9915-a7f8da7c7a43","name":"Recurring Payments","type":"folder"}},"urlObject":{"path":["customer"],"host":[""],"query":[],"variable":[]}},"response":[{"id":"5dccef7c-e2c2-49b1-add8-2822ce149a5a","name":"Success","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{APIKey}}","type":"text"},{"key":"BrandId","value":"your-brand-id","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"*/*","type":"text"}],"url":"/customer"},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[{"key":"Date","value":"Sat, 31 Jan 2026 15:00:13 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-session-id","value":"74520247-3540-48b2-81f9-33fd50e71e01"},{"key":"Vary","value":"Origin"},{"key":"Vary","value":"Access-Control-Request-Method"},{"key":"Vary","value":"Access-Control-Request-Headers"},{"key":"Server","value":"cloudflare"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"0"},{"key":"Cache-Control","value":"no-cache, no-store, max-age=0, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Expires","value":"0"},{"key":"Strict-Transport-Security","value":"max-age=31536000 ; includeSubDomains"},{"key":"X-Frame-Options","value":"ALLOW-FROM *"},{"key":"Referrer-Policy","value":"no-referrer"},{"key":"Set-Cookie","value":"SESSION=NDRjYjEwZGQtNTAyMy00MDA1LWFiNTUtNTBmNmY2YWY1NjZj; Path=/; Secure; HttpOnly; SameSite=Strict"},{"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=gy0s5195rsESyn%2B0cQcmwej6qKnbNzrAcSxW%2F%2FrtkYk52a4Lipz%2FTBcpX5IjTYOHLNsLsPeT9jJFd4rUsIPUJbu4R%2B%2BcaGEmcMT6de1u%2FVA%3D\"}]}"},{"key":"CF-RAY","value":"9c6a13d27f38a3ba-IAD"}],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\n \"customerId\": \"691afbc6fd96d34a8113a34d\",\n \"merchantCustomerId\": \"user5489@example.com\",\n \"fullName\": \"Reese Nakamura\",\n \"emailId\": \"user7734@example.com\",\n \"dateOfBirth\": \"1994-06-03\",\n \"phoneNo\": \"+91 797639082\",\n \"brandID\": \"your-brand-id\",\n \"city\": \"Riverton\",\n \"zipCode\": \"302018\",\n \"address\": \"24 Sample Avenue\",\n \"country\": \"IN\",\n \"stateCode\": \"RJ\",\n \"custRegDate\": \"2023-12-27\",\n \"successTrans\": 0,\n \"createdOn\": 1763376070,\n \"lastUpdated\": 0,\n \"lastActivity\": 1763376070,\n \"extraParam\": {\n \"param1\": \"value1\",\n \"param2\": \"value2\",\n \"param3\": \"value3\",\n \"param4\": \"value4\"\n }\n}"}],"_postman_id":"62217469-8c7b-4a84-9bb9-a4c3dbb02374"},{"name":"Create Session (CIT)","id":"70fd2dd7-c7d3-4fd6-81b9-ba3d7b791f00","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{APIKey}}","type":"text"},{"key":"BrandId","value":"your-brand-id","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"customerId\": \"685f870cf3435a2d5b35ee08\", // mandatory\n \"currency\": \"EUR\",\n \"products\": [\n {\n \"name\": \"Product1\",\n \"price\": \"10\"\n },\n {\n \"name\": \"Product2\",\n \"price\": \"10\"\n }\n ],\n \"totalAmount\": \"21\", // optional, but if present have precedence over sum of prices.\n \"paymentMethod\": \"VISA\", //optional\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 \"payment_type\": \"mandate\",\n \"mandate\": {\n \"mandate_max_amount\": \"5000\", // the mandated amount should be less than or equal to this amount.\n \"amount_variability\": \"Fixed\",\n \"start_date\": \"1598965200\", // epoch timestamp or UNIX timestamp\n \"end_date\": \"1914141600\", // epoch timestamp or UNIX timestamp\n \"frequency\": \"MONTHLY\",\n \"rule\": \"on\",\n \"value\": 1\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://api.paystreamportal.com/api/v1/createSession","description":"OVERIEW
\nThe createSession API is designed to initiate a payment session for a customer after their profile has been created via the createCustomer API. The session is automatically generated at the backend on the merchant’s checkout URL. This session allows the customer to continue with their transaction without having to manually interact with the session URL, and ensures the session remains active until the payment is completed or the session expires.
This API improves the user experience by reducing transaction failures and enhancing the overall payment process, thus reducing transaction churn rates.
\nMandatory Parameters
\nTo register a mandate, pass mandate related parameters in the Create Session API to create a mandate registration purchase. Post transaction completion, use Get Status API and Webhooks to capture mandate registration details.
\nAdditional parameters for this usecase:
\nUsage Flow
\n- \n
Customer completes the
\ncreateCustomerAPI: Once the customer is created via thecreateCustomerAPI, the merchant proceeds to call thecreateSessionAPI to generate a session. \nMerchant sends
\ncreateSessionrequest: The merchant sends aPOSTrequest to thecreateSessionAPI with the customer’scustomerIdand the merchant’sbrandId. \nSession created automatically on the checkout URL: Paystream 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 \nCustomer proceeds to checkout: The customer is redirected to the checkout page as part of the merchant's payment flow, where the session is automatically validated. The session remains active for a set period, allowing the customer to complete the payment without needing to manually interact with the session URL.
\n \nSession Expiry: The session expires after the set expiration time (
\nexpiryOn), ensuring the payment process is completed within the defined window. Default is 15 mins from the creation time. \n
\n
Benefits
\n- \n
Seamless Checkout: The session URL is automatically generated and active at the backend, ensuring a smoother and uninterrupted customer experience.
\n \nReduced Transaction Failures: By ensuring the session remains active during the payment process, the chances of transaction failures due to session timeouts are minimized.
\n \nImproved User Experience: The customer does not need to click on a session URL or navigate away from the page, leading to faster and more secure payment processing.
\n \n
OVERIEW
\nThe create Purchase API is designed to initiate a payment for a merchant who doesn't want to use Paystream's cashier and wants to keep everything S2S.
The merchant doesn't need to create a customer in this case and directly needs to call the purchase API and then call the S2S API after that.
\nAdditional parameters for this usecase:
\n","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"ffd21edb-563a-4651-9915-a7f8da7c7a43","id":"ffd21edb-563a-4651-9915-a7f8da7c7a43","name":"Recurring Payments","type":"folder"}},"urlObject":{"path":["purchases"],"host":["https://api.paystreamportal.com/api/v1"],"query":[],"variable":[]}},"response":[{"id":"9c1bd286-d3dc-42a8-950c-bfaf1b5b0315","name":"Success","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{APIKey}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"client\": {\n \"email\": \"user3069@example.com\",\n \"country\": \"GB\",\n \"city\": \"Milford\",\n \"stateCode\": \"LO\",\n \"street_address\": \"90 Fixture Close\",\n \"zip_code\": \"234567\",\n \"full_name\": \"Reese Nakamura\",\n \"phone\": \"+44 07932665877\" // optional\n },\n \"purchase\": {\n \"currency\": \"USD\",\n \"products\": [\n {\n \"name\": \"product name\",\n \"price\": \"1\"\n }\n ]\n },\n \"merchantRef\": \"your-merchant-ref\", // optional\n \"paymentMethod\": \"MASTER\",\n \"brand_id\": \"your-brand-id\",\n \"payment_type\": \"mandate\",\n \"mandate\": {\n \"mandate_max_amount\": \"5000\", // Conditional\n \"amount_variability\": \"Fixed\", // optional\n \"start_date\": \"1598965200\", // optional\n \"end_date\": \"1914141600\", // optional\n \"frequency\": \"MONTHLY\", // mandatory\n \"rule\": \"on\", // optional\n \"value\": 1 // conditional\n },\n \"success_redirect\": \"https://your.success.redirect.com\", // mandatory\n \"pending_redirect\": \"https://your.pending.redirect.com\", // mandatory\n \"failure_redirect\": \"https://your.failure.redirect.com\", // mandatory\n \"success_callback\": \"https://your.success.callback.com\", // mandatory\n \"failure_callback\": \"https://your.failure.callback.com\" // mandatory\n}","options":{"raw":{"language":"json"}}},"url":"https://api.paystreamportal.com/api/v1/purchases"},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[{"key":"Date","value":"Mon, 30 Mar 2026 12:23:05 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Nel","value":"{\"report_to\":\"cf-nel\",\"success_fraction\":0.0,\"max_age\":604800}"},{"key":"X-Frame-Options","value":"ALLOW-FROM *"},{"key":"Referrer-Policy","value":"no-referrer"},{"key":"x-session-id","value":"668295f8-5770-4492-8318-01e2d1c09664"},{"key":"Vary","value":"Origin"},{"key":"Vary","value":"Access-Control-Request-Method"},{"key":"Vary","value":"Access-Control-Request-Headers"},{"key":"Server","value":"cloudflare"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"0"},{"key":"Cache-Control","value":"no-cache, no-store, max-age=0, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Expires","value":"0"},{"key":"Strict-Transport-Security","value":"max-age=31536000 ; includeSubDomains"},{"key":"X-Cache","value":"Error from cloudfront"},{"key":"Via","value":"1.1 b4011ac432e4f034161d5cccc8a4ac80.cloudfront.net (CloudFront)"},{"key":"X-Amz-Cf-Pop","value":"IAD61-P10"},{"key":"X-Amz-Cf-Id","value":"46KSjvCpG3Uv-3pzVOVedkJkacP2LZAI0m9ByboJ-rzLxQkfNNycJA=="},{"key":"cf-cache-status","value":"DYNAMIC"},{"key":"Report-To","value":"{\"group\":\"cf-nel\",\"max_age\":604800,\"endpoints\":[{\"url\":\"https://a.nel.cloudflare.com/report/v4?s=1p%2FF34n2kiKpiE2WnCntzJPGKU28mcMx4pIFZ9F6UFZqmnoSxQEqZQ44WCu6SsOg5eYfqPqYGdhXxgBbuVLNwP5Xyc2OqoL1lTauqUylCkCPuOXJ1VRrvygGOmX9Yslw6BqJ\"}]}"},{"key":"CF-RAY","value":"9e471560fd16d6d5-IAD"}],"cookie":[],"responseTime":null,"body":"{\n \"purchaseId\": \"69f8d167db7ca561ab27c484\",\n \"client\": {\n \"customerId\": \"NA\",\n \"email\": \"user5797@example.com\",\n \"street_address\": \"90 Fixture Close\",\n \"country\": \"GB\",\n \"city\": \"Milford\",\n \"zip_code\": \"234567\",\n \"cc\": [],\n \"bcc\": [],\n \"stateCode\": \"LO\"\n },\n \"updated_on\": 1777914215,\n \"type\": \"purchase\",\n \"paymentMethod\": \"VISA\",\n \"amountUnit\": \"MAJOR\",\n \"errorMsg\": \"\",\n \"errorCode\": \"NA\",\n \"force_recurring\": false,\n \"created_on\": 1777914215,\n \"merchantRef\": \"69f8d167db7ca561ab27c484\",\n \"purchase\": {\n \"currency\": \"USD\",\n \"products\": [\n {\n \"name\": \"product name\",\n \"quantity\": 1.0,\n \"price\": 5.0,\n \"discount\": 0,\n \"tax_percent\": \"0.00\"\n }\n ],\n \"total\": 5.0,\n \"requestAmount\": 5.0,\n \"language\": \"en\",\n \"notes\": \"\",\n \"debt\": 0,\n \"total_formatted\": 1.0,\n \"taxAmount\": 0.0,\n \"taxPercent\": 0.0,\n \"request_client_details\": [],\n \"email_message\": \"\"\n },\n \"issuer_details\": {\n \"website\": \"\",\n \"legal_street_address\": \"\",\n \"legal_country\": \"\",\n \"legal_city\": \"\",\n \"legal_zip_code\": \"\",\n \"bank_accounts\": [\n {}\n ],\n \"legal_name\": \"Testing\",\n \"brand_name\": \"Testing\",\n \"registration_number\": \"\",\n \"tax_number\": \"\"\n },\n \"transaction_data\": {\n \"payment_method\": \"\",\n \"flow\": \"payform\",\n \"extra\": {},\n \"country\": \"\",\n \"attempts\": []\n },\n \"status\": \"CREATED\",\n \"status_history\": [\n {\n \"status\": \"created\",\n \"timestamp\": 1777914215\n }\n ],\n \"is_test\": false,\n \"brand_id\": \"your-brand-id\",\n \"send_receipt\": false,\n \"is_recurring_token\": false,\n \"skip_capture\": false,\n \"reference_generated\": \"PS1736\",\n \"issued\": \"2026-05-04\",\n \"due\": 1777914215,\n \"refund_upto\": 0,\n \"cc_descriptor\": \"\",\n \"fraudScore\": \"NA\",\n \"trustScore\": \"NA\",\n \"extraFee\": \"0\",\n \"totalRefunded\": 0.0,\n \"paidOn\": 0,\n \"receivedAmt\": 0.0,\n \"taxAmount\": 0.0,\n \"surcharge\": 0.0,\n \"surchargeType\": \"\",\n \"sessionId\": \"\",\n \"refund_availability\": \"NONE\",\n \"refundable_amount\": 0.0,\n \"success_redirect\": \"https://your.success.redirect.com\",\n \"failure_redirect\": \"https://your.failure.redirect.com\",\n \"pending_redirect\": \"https://your.pending.redirect.com\",\n \"cancel_redirect\": \"\",\n \"success_callback\": \"https://your.success.callback.com\",\n \"failure_callback\": \"https://your.failure.callback.com\",\n \"platform\": \"API\",\n \"created_from_ip\": \"2406:b400:75:22bd:b48e:a33e:4e26:a542\",\n \"checkout_url\": \"https://api.paystreamportal.com/payments/16550278d7e374e53048b72dcf253a3a/\",\n \"direct_post_url\": \"https://api.paystreamportal.com/api/v1/p/69f8d167db7ca561ab27c484/\",\n \"payoutProcess\": false,\n \"payment_type\": \"mandate\",\n \"mandate\": {\n \"frequency\": \"ASPRESENTED\",\n \"rule\": \"on\",\n \"value\": null,\n \"mandate_max_amount\": null,\n \"amount_variability\": \"Variable\",\n \"end_date\": null,\n \"mandate_status\": \"CREATED\",\n \"mandate_id\": \"69f8d167db7ca561ab27c484\"\n }\n}"}],"_postman_id":"1430611a-2f53-443e-92a8-adcbe478f239"},{"name":"S2S API","id":"1c37bc6b-d7d2-4685-a148-2b5af8221ae1","protocolProfileBehavior":{"disableUrlEncoding":false,"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer {{APIKey}}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"cardholder_name\": \"dk\",\r\n \"card_number\": \"4111111111111111\",\r\n \"expires\": \"10/23\",\r\n \"cvc\": \"345\",\r\n \"remember_card\": \"on\",\r\n \"remote_ip\": \"203.0.113.121\",\r\n \"user_agent\": \"Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/51.0.2704.103 Safari/537.36\",\r\n \"accept_header\": \"text/html\",\r\n \"language\": \"en-US\",\r\n \"java_enabled\": false,\r\n \"javascript_enabled\": true,\r\n \"color_depth\": 24,\r\n \"utc_offset\": 0,\r\n \"screen_width\": 1920,\r\n \"screen_height\": 1080\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.paystreamportal.com/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.
\nMandatory parameters in request body:
\nEssential parameters in request body:
\n**
Other optional parameters in request body:**
Successful Response
\nIf all the details are correct you'll get a 202 response with staus as Pending
\n{\n \"status\": \"pending\",\n \"callback_url\": \"https://api.paystreamportal.com/payment/63bd0bf80fb42a076e8a4dd1/\",\n \"method\": \"GET\"\n}\n\nIf the response code is 202, after receiving the response body, direct the customer to the callback_url provided in the response.
\nErrors
\nIf there are any errors then it'll be in the format of :
\n{\n \"message\": \"descriptive error message\",\n \"code\": \"error_code\"\n}\n\nPlease see the Status Code section for further details.
\n","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"ffd21edb-563a-4651-9915-a7f8da7c7a43","id":"ffd21edb-563a-4651-9915-a7f8da7c7a43","name":"Recurring Payments","type":"folder"}},"urlObject":{"path":["p","64bff4fff63e36669499e9c8",""],"host":["https://api.paystreamportal.com/api/v1"],"query":[{"key":"s2s","value":"true"}],"variable":[]}},"response":[{"id":"30b20cf1-cb8f-4ce4-8249-f0bed16fc7ce","name":"Success","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer {{APIKey}}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"cardholder_name\": \"dk\",\r\n \"card_number\": \"4111111111111111\",\r\n \"expires\": \"10/23\",\r\n \"cvc\": \"345\",\r\n \"remember_card\": \"on\",\r\n \"remote_ip\": \"203.0.113.121\",\r\n \"user_agent\": \"Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/51.0.2704.103 Safari/537.36\",\r\n \"accept_header\": \"text/html\",\r\n \"language\": \"en-US\",\r\n \"java_enabled\": false,\r\n \"javascript_enabled\": true,\r\n \"color_depth\": 24,\r\n \"utc_offset\": 0,\r\n \"screen_width\": 1920,\r\n \"screen_height\": 1080\r\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://api.paystreamportal.com/api/v1/p/64bff4fff63e36669499e9c8/?s2s=true","host":["https://api.paystreamportal.com/api/v1"],"path":["p","64bff4fff63e36669499e9c8",""],"query":[{"key":"s2s","value":"true"}]}},"status":"Accepted","code":202,"_postman_previewlanguage":"Text","header":[{"key":"Date","value":"Mon, 30 Mar 2026 12:29:20 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Nel","value":"{\"report_to\":\"cf-nel\",\"success_fraction\":0.0,\"max_age\":604800}"},{"key":"X-Frame-Options","value":"ALLOW-FROM *"},{"key":"Referrer-Policy","value":"no-referrer"},{"key":"x-session-id","value":"013dfd43-0689-4d6b-a797-38281465a753"},{"key":"Vary","value":"Origin"},{"key":"Vary","value":"Access-Control-Request-Method"},{"key":"Vary","value":"Access-Control-Request-Headers"},{"key":"Server","value":"cloudflare"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"0"},{"key":"Cache-Control","value":"no-cache, no-store, max-age=0, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Expires","value":"0"},{"key":"Strict-Transport-Security","value":"max-age=31536000 ; includeSubDomains"},{"key":"X-Cache","value":"Error from cloudfront"},{"key":"Via","value":"1.1 3b66cea026f27925ba048cc96a0885ca.cloudfront.net (CloudFront)"},{"key":"X-Amz-Cf-Pop","value":"IAD61-P10"},{"key":"X-Amz-Cf-Id","value":"SWosGrWkPMrZoTyRfLd6N01fBb57k60RtzFzD-r38XQXmfTQEW_SRQ=="},{"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=qC4PItJ0vJPndQ4Ni%2F0rS%2BPlrlTkj9%2F28whoJdWsDG4oYZpOnmcmYgstZyXlRLs5CC6XI1kBR7nuEUQ6t4NoE1tnrhM8iv1IV%2BvSYTxq3AryDLbD0zZlxLVKj9jllGVm3RVN\"}]}"},{"key":"CF-RAY","value":"9e471e8bcf88824e-IAD"}],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\n \"status\": \"pending\",\n \"callback_url\": \"https://api.paystreamportal.com/api/v1/payment/64b034ecc6dccf7d329d9eb3/\",\n \"method\": \"GET\"\n}"}],"_postman_id":"1c37bc6b-d7d2-4685-a148-2b5af8221ae1"},{"name":"Get Mandate","id":"d2ed260a-ed68-41bd-9e39-4776c583292c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer {{APIKey}}","type":"text"},{"key":"BrandId","value":"your-brand-id","type":"text"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"https://api.paystreamportal.com/api/v1/mandate/{mandate_id or session_id}","description":"This endpoint will be used to get all the details of a particular mandate. You can search for a particular mandate id or for a particular session id.
\nResponse parameters:
\n- \n
totalDeductedAmount
\n
This is the total amount which is deducted from the user's account. \nrecurringMandateIds
\n
This object returns a list of all the MIT transactions done for the respective mandate. \nnextMandateDate
\n
This is the date when the next recurring payment will happen. \n
After the successful Mandate registration, Merchant will receive a mandate_id from Paystream that should be stored against a customer at their end.
\nIf the merchant handles their own scheduling, then for the subsequent transactions, the merchant is supposed to pass a combination of customer_id and mandate_id to do a debit. This API will perform a transaction with a PSP based on the mandate_id passed in the request.
\nIf Paystream handles the scheduling for the merchant on their behalf, then this API is not for them. The MIT transactions will be handled by Paystream from our side.
\nNote:
Recurring payments should only be done if the mandate registration has been successful and the mandate is ACTIVE.
Required for cases where the Paystream is handling the scheduling of recurring payments. Use this API to revoke/cancel an ACTIVE mandate.
\nNote:
Revoking a mandate should be done at the same instance this API is called. The mandate status should be updated to “REVOKED” at the same instant.
Required for cases where the Paystream is handling the scheduling of recurring payments. Use this API to pause an ACTIVE mandate.
\nAdditional parameters for this usecase:
\nNote:
For pausing a mandate you need to keep the exact timestamp in mind.
If a recurring payment is scheduled between the pause_start_date and pause_end_date then it will not be executed.
This endpoint will be used to list all the mandates for a particular customer of a merchant.
\nResponse parameters:
\n- \n
totalDeductedAmount
\n
This is the total amount which is deducted from the user's account. \nrecurringMandateIds
\n
This object returns a list of all the MIT transactions done for the respective mandate. \nnextMandateDate
\n
This is the date when the next recurring payment will happen. \n
This API tells you about all the details of a recurring payment which occurred
\nMandatory
\nyou need to pass the PurchaseID in the API URL
Possible Value of Status
\nResponse Examples
\nIn the response examples you can see instances of both Paid and Error Status purchases.
Error Details
\nIf there are any issues on the Purchase you can get more details from the transaction_data.attempts.error attribute of the response object
Errors
\nIf there are any errors then it'll be in the format of :
\n{\n \"message\": \"descriptive error message\",\n \"code\": \"error_code\"\n}\n\nPlease see the Status Code section for further details.
\n","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"ffd21edb-563a-4651-9915-a7f8da7c7a43","id":"ffd21edb-563a-4651-9915-a7f8da7c7a43","name":"Recurring Payments","type":"folder"}},"urlObject":{"path":["purchases","{purchaseId}",""],"host":["https://api.paystreamportal.com/api/v1"],"query":[],"variable":[]}},"response":[{"id":"ef3937bb-5aea-46a5-8834-826f68ef0622","name":"Success","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer {{APIKey}}","type":"text"}],"url":"https://api.paystreamportal.com/api/v1/purchases/{purchaseId}/"},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[{"key":"Date","value":"Sun, 01 Feb 2026 07:59:35 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Nel","value":"{\"report_to\":\"cf-nel\",\"success_fraction\":0.0,\"max_age\":604800}"},{"key":"X-Frame-Options","value":"ALLOW-FROM *"},{"key":"Referrer-Policy","value":"no-referrer"},{"key":"x-session-id","value":"e222737a-b9e9-4562-94de-5b80b056c180"},{"key":"Vary","value":"Origin"},{"key":"Vary","value":"Access-Control-Request-Method"},{"key":"Vary","value":"Access-Control-Request-Headers"},{"key":"Server","value":"cloudflare"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"0"},{"key":"Cache-Control","value":"no-cache, no-store, max-age=0, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Expires","value":"0"},{"key":"Strict-Transport-Security","value":"max-age=31536000 ; includeSubDomains"},{"key":"X-Cache","value":"Error from cloudfront"},{"key":"Via","value":"1.1 f89daa99b6a349030b23247a4977cb5e.cloudfront.net (CloudFront)"},{"key":"X-Amz-Cf-Pop","value":"IAD61-P10"},{"key":"X-Amz-Cf-Id","value":"eUcDXjdNU1qDjwPQst7oM9Kbi8qYyd8sncr30-6kphukYSEGv-qwUg=="},{"key":"cf-cache-status","value":"DYNAMIC"},{"key":"Report-To","value":"{\"group\":\"cf-nel\",\"max_age\":604800,\"endpoints\":[{\"url\":\"https://a.nel.cloudflare.com/report/v4?s=i8qaRQprp0TLqlSo5At%2FjpQANnSZgP8iEeVFnMasIN8xyAN2mdqYXVqP3dXt2AbZRL8fj6SRWa%2BFA1dybSS8ebE5scTH8BsB6Ubx8ppJSxc%3D\"}]}"},{"key":"CF-RAY","value":"9c6fe9092c493ec9-IAD"}],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\n \"purchaseId\": \"6973ad04fa54ee2cf14f438c\",\n \"client\": {\n \"customerId\": \"NA\",\n \"email\": \"user7402@example.com\",\n \"phone\": \"0557719399\",\n \"full_name\": \"Test user\",\n \"date_of_birth\": \"2004-07-12\",\n \"street_address\": \"90 Fixture Close\",\n \"country\": \"CA\",\n \"city\": \"Milford\",\n \"zip_code\": \"68403\",\n \"cc\": [],\n \"bcc\": [],\n \"tax_number\": \"+447755564318\",\n \"bankAccountNumber\": \"1345789678\",\n \"stateCode\": \"QLD\"\n },\n \"updated_on\": 1769188614,\n \"type\": \"purchase\",\n \"paymentMethod\": \"VISA\",\n \"amountUnit\": \"MAJOR\",\n \"errorMsg\": \"ERROR_PARSING_GROUP_ID\",\n \"errorCode\": \"NA\",\n \"force_recurring\": false,\n \"created_on\": 1769188612,\n \"merchantRef\": \"6973ad04fa54ee2cf14f438c\",\n \"purchase\": {\n \"currency\": \"USD\",\n \"products\": [\n {\n \"name\": \"gaming cards\",\n \"quantity\": 1.0,\n \"price\": 10.0,\n \"discount\": 0,\n \"tax_percent\": \"0.00\"\n }\n ],\n \"total\": 10.0,\n \"requestAmount\": 10.0,\n \"language\": \"en\",\n \"notes\": \"\",\n \"debt\": 0,\n \"total_formatted\": 1.0,\n \"taxAmount\": 0.0,\n \"taxPercent\": 0.0,\n \"request_client_details\": [],\n \"email_message\": \"\"\n },\n \"issuer_details\": {\n \"website\": \"\",\n \"legal_street_address\": \"\",\n \"legal_country\": \"\",\n \"legal_city\": \"\",\n \"legal_zip_code\": \"\",\n \"bank_accounts\": [\n {}\n ],\n \"legal_name\": \"zenith\",\n \"brand_name\": \"zenith\",\n \"registration_number\": \"\",\n \"tax_number\": \"\"\n },\n \"transaction_data\": {\n \"payment_method\": \"\",\n \"flow\": \"payform\",\n \"extra\": {\n \"expiry_month\": \"01\",\n \"amount\": 10.0,\n \"card_issuer\": \"VISION BANK\",\n \"masked_pan\": \"42222222*2222\",\n \"card_brand\": \"VISA\",\n \"card_issuer_country\": \"SA\",\n \"card_type\": \"DEBIT\",\n \"cardholder_name\": \"Rowan Sharma\",\n \"expiry_year\": \"29\"\n },\n \"country\": \"\",\n \"attempts\": [\n {\n \"client_ip\": \"203.0.113.100\",\n \"type\": \"execute\",\n \"payment_method\": \"VISA\",\n \"flow\": \"payform\",\n \"successful\": false,\n \"country\": \"VISA\",\n \"processing_time\": 1769188612,\n \"extra\": {\n \"amount\": 10.0,\n \"masked_pan\": \"VISA\",\n \"card_brand\": \"VISA\",\n \"card_issuer_country\": \"VISA\",\n \"cardholder_name\": \"Test user\"\n },\n \"error\": {\n \"message\": \"This customer can not be processed !\",\n \"code\": \"transaction_error\"\n }\n },\n {\n \"client_ip\": \"\",\n \"type\": \"execute\",\n \"payment_method\": \"VISA\",\n \"flow\": \"payform\",\n \"successful\": false,\n \"country\": \"SA\",\n \"processing_time\": 1769188613,\n \"extra\": {\n \"expiry_month\": \"01\",\n \"amount\": 10.0,\n \"card_issuer\": \"VISION BANK\",\n \"masked_pan\": \"42222222*2222\",\n \"card_brand\": \"VISA\",\n \"card_issuer_country\": \"SA\",\n \"card_type\": \"DEBIT\",\n \"cardholder_name\": \"Rowan Sharma\",\n \"expiry_year\": \"29\"\n },\n \"error\": {\n \"message\": \"ERROR_PARSING_GROUP_ID\",\n \"code\": \"transaction_error\"\n }\n }\n ]\n },\n \"status\": \"ERROR\",\n \"status_history\": [\n {\n \"status\": \"created\",\n \"timestamp\": 1769188612\n },\n {\n \"status\": \"pending_execute\",\n \"timestamp\": 1769188612\n },\n {\n \"status\": \"error\",\n \"timestamp\": 1769188613\n },\n {\n \"status\": \"pending_execute\",\n \"timestamp\": 1769188613\n },\n {\n \"status\": \"error\",\n \"timestamp\": 1769188614\n },\n {\n \"status\": \"viewed\",\n \"timestamp\": 1770016552\n }\n ],\n \"viewedOn\": 1770016552,\n \"is_test\": false,\n \"brand_id\": \"your-brand-id\",\n \"send_receipt\": false,\n \"is_recurring_token\": false,\n \"skip_capture\": false,\n \"reference_generated\": \"PS1841\",\n \"issued\": \"2026-01-23\",\n \"due\": 1769188612,\n \"refund_upto\": 0,\n \"cc_descriptor\": \"\",\n \"fraudScore\": \"NA\",\n \"trustScore\": \"NA\",\n \"extraFee\": \"0\",\n \"paidOn\": 0,\n \"receivedAmt\": 0.0,\n \"taxAmount\": 0.0,\n \"surcharge\": 0.0,\n \"surchargeType\": \"\",\n \"sessionId\": \"\",\n \"refund_availability\": \"NONE\",\n \"refundable_amount\": 0.0,\n \"success_redirect\": \"https://your.success.redirect.com\",\n \"failure_redirect\": \"https://your.failure.redirect.com\",\n \"pending_redirect\": \"https://your.pending.redirect.com\",\n \"cancel_redirect\": \"\",\n \"success_callback\": \"https://your.success.callback.com\",\n \"failure_callback\": \"https://your.failure.callback.com\",\n \"platform\": \"API\",\n \"created_from_ip\": \"203.0.113.100\",\n \"checkout_url\": \"https://api.paystreamportal.com/payments/a28ed9974a22a4cbd5f2f49cc26cc334/\",\n \"direct_post_url\": \"https://api.paystreamportal.com/api/v1/p/6973ad04fa54ee2cf14f438c/\",\n \"payoutProcess\": false,\n \"payment_type\": \"internal recurring\",\n \"mandate_id\": \"696bc39a7bc779fac5201357\"\n}"}],"_postman_id":"2ede7ae6-6179-4db8-b378-88d81815a8f1"}],"id":"2155284b-006c-4b59-bb49-90be5914112e","_postman_id":"2155284b-006c-4b59-bb49-90be5914112e","description":"","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"ffd21edb-563a-4651-9915-a7f8da7c7a43","id":"ffd21edb-563a-4651-9915-a7f8da7c7a43","name":"Recurring Payments","type":"folder"}}}],"id":"ffd21edb-563a-4651-9915-a7f8da7c7a43","description":"Overview
\nRecurring Payments allow merchants to automatically charge customers at predefined or flexible intervals without requiring the customer to re-enter payment details each time.
\nA Mandate represents the customer’s authorization that links their payment method to the merchant for future recurring charges. Once created, this mandate is used as a secure reference for all upcoming payments.
\nInstead of processing every transaction as a one-time payment, merchants rely on mandates to execute recurring debits in a frictionless and compliant manner.
\nThe recurring payments may be initiated using Paystream APIs as fixed/ non-fixed intervals based on your business use case.
\nThe Paystream Subscription module (also known as Mandates) enables merchants to automate recurring billing for products and services. Unlike standard one-off transactions, this feature creates a persistent link between the merchant and the customer's payment method, allowing for future charges without requiring the customer to be present or re-enter their details.
\nThis system is built around two fundamental transaction types that define the lifecycle of a subscription:
\n1. Mandate Registration (CIT)
\nThe Customer Initiated Transaction (CIT) represents the initial setup of the recurring payment mandate, during which the customer is actively present on the merchant’s website or application (in-session flow).
\nIn this flow, the merchant collects and submits the customer’s basic details along with the mandate configuration, including registration information, payment amount (fixed or variable, as applicable), and the scheduling frequency for recurring debits.
\nAs part of the setup process, the customer must explicitly provide consent for the mandate. To authenticate and activate the mandate, the customer also completes a one-time payment using the selected payment method. Once this payment is successful, the mandate is registered and becomes eligible for future automated recurring transactions as per the defined schedule.
\nPurpose:
\n- \n
Capture customer payment details
\n \nAuthenticate the transaction (typically via 3D Secure)
\n \nCollect customer consent for recurring billing
\n \n
Outcome:
\n- \n
A unique mandate_id is generated
\n \nThis mandate acts as a secure token for all future charges
\n \n
Use Case:
\nThe customer signs up for a subscription and completes the first payment
\n2. Recurring Payments (MIT)
\nThe Merchant Initiated Transaction (MIT) represents the execution phase of the recurring payment lifecycle. In this stage, payments are automatically triggered by the merchant’s system or through Paystream’s built-in scheduler without requiring the customer to be actively present (off-session flow).
\nOnce a mandate is successfully registered, merchants can initiate recurring debits as per the defined schedule and payment terms. These transactions are processed seamlessly using the customer’s authorized payment method.
\nThe Paystream Mandate module provides the following benefits:
\n- \n
Prebuilt support for a complete mandate registration experience using cards as the payment method
\n \nFlexible mandate setup to match different business models and customer requirements
\n \nSimplified execution of recurring payments through the Paystream Dashboard with minimal operational effort
\n \nBuilt-in analytics and reporting tools to monitor mandate sign-ups, payment performance, and renewals
\n \n
Purpose:
\n- \n
- Debit the customer according to the defined schedule or usage \n
Mechanism:
\n- \n
Merchant (or Paystream scheduler) sends payment requests using the mandate_id
\n \nNo card details are required again
\n \nUsually bypasses 3D Secure
\n \n
Use Case:
\nMonthly subscription renewal payment.
\nKey Capabilities
\n- \n
Flexible Scheduling: Define rigid schedules (Daily, Weekly, Monthly, Yearly) or use \"As Presented\" for irregular billing intervals.
\n \nAmount Variability: Support for Fixed amounts (e.g., $10/month license) or Variable amounts (e.g., utility bills where the cost changes based on usage).
\n \nSmart Management:
\n- \n
Merchant Managed: You track the dates and trigger the API call when payment is due.
\n \nPaystream Managed: You define the rules (start date, end date, frequency), and Paystream handles the execution logic.
\n \n
\nAnalytics & Operations: Includes a dedicated dashboard for monitoring signup performance, renewal success rates, and managing cancellations.
\n \n
There are 2 ways in which subscriptions are handled at Paystream’s end:
\nMerchant Managed Scheduling
\nAfter successfully registering the mandate, the merchant creates a subscription linked to the customer’s mandate. Based on the defined billing cycle and business logic, the merchant then triggers the Recurring Payments API according to their own payment schedule to execute automated debits.
\nThis approach allows merchants to maintain full control over when and how recurring charges are initiated.
\n- \n
Merchant tracks payment due dates
\n \nMerchant triggers recurring API calls manually
\n \n
Best for:
\nCustom billing logic or internal scheduling systems.
\nPaystream Managed Scheduling
\nIn this model, the merchant creates a subscription within the Paystream system and submits the recurring payment schedule, including billing frequency and timing. Based on the provided configuration, Paystream automatically manages the execution of recurring transactions as per the defined schedule.
\nThis removes the need for merchants to manually trigger each payment, ensuring consistent and timely debits while maintaining a fully automated recurring billing process
\n- \n
Merchant defines payment rules (start date, frequency, end date)
\n \nPaystream automatically executes recurring charges
\n \n
Best for:
\nStandard subscription models with minimal operational overhead.
\nPrerequisites
\nBefore starting the mandate integration, merchants must ensure that the required configurations are enabled both at the PSP level and within the Paystream system.
\nMandate Enablement at PSP Level
\nMerchants must enable mandate-related features on their respective PSP (Payment Service Provider) dashboard. This ensures that the PSP supports recurring and mandate-based transactions.
\nConfiguration on the Paystream Dashboard
\n- \n
For whitelabel merchants or those using Paystream’s whitelabel solution, the mandate support toggle must be enabled within the MID settings of the PSP configuration. This allows Paystream to recognize and route mandate transactions correctly.
\n \nFor merchants directly onboarded with Paystream, this configuration is managed by the Paystream team. Merchants should coordinate with their account manager to ensure mandate enablement is completed.
\n \n
Fetches a paginated list of transactions. This endpoint is optimized for high-volume retrieval and returns a summary view of each transaction (ID and Status).
\nImportant Path Params to consider:
\n","urlObject":{"path":["external","transactions","list"],"host":["https://api.paystreamportal.com/api/v1"],"query":[{"key":"page_no","value":"1"},{"key":"page_size","value":"10"},{"key":"transaction_id","value":"69d4ba22465443878a0045ba"},{"key":"start_date","value":"2025-10-29%2000%3A00%3A00%20+05%3A30"},{"key":"end_date","value":"2026-04-23%2000%3A00%3A00%20+05%3A30"},{"key":"last_updated_start","value":"2026-01-07%2016%3A12%3A00%20+05%3A30"},{"key":"last_updated_end","value":"2026-12-07%2016%3A12%3A00%20+05%3A30"},{"key":"customer_id","value":"NA"},{"key":"status","value":"paid"},{"key":"currency","value":"USD"},{"key":"is_sandbox","value":"true"}],"variable":[]}},"response":[{"id":"d5c1ad48-f2ff-446b-ac71-fc8b180e6484","name":"Success","originalRequest":{"method":"GET","header":[{"key":"BrandId","value":"your-brand-id"},{"key":"Authorization","value":"Bearer {{APIKey}}"}],"url":{"raw":"https://api.paystreamportal.com/api/v1/external/transactions/list?page_no=1&page_size=10&start_date=2025-10-29%2000%3A00%3A00%20+05%3A30&end_date=2026-04-23%2000%3A00%3A00%20+05%3A30&last_updated_start=2026-01-07%2016%3A12%3A00%20+05%3A30&last_updated_end=2026-12-07%2016%3A12%3A00%20+05%3A30&customer_id=NA&status=paid¤cy=USD&is_sandbox=true","host":["https://api.paystreamportal.com/api/v1"],"path":["external","transactions","list"],"query":[{"key":"page_no","value":"1"},{"key":"page_size","value":"10"},{"key":"transaction_id","value":"69d4ba22465443878a0045ba","disabled":true},{"key":"start_date","value":"2025-10-29%2000%3A00%3A00%20+05%3A30"},{"key":"end_date","value":"2026-04-23%2000%3A00%3A00%20+05%3A30"},{"key":"last_updated_start","value":"2026-01-07%2016%3A12%3A00%20+05%3A30"},{"key":"last_updated_end","value":"2026-12-07%2016%3A12%3A00%20+05%3A30"},{"key":"customer_id","value":"NA"},{"key":"status","value":"paid"},{"key":"currency","value":"USD"},{"key":"is_sandbox","value":"true"}]}},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[{"key":"Date","value":"Sun, 19 Apr 2026 14:11:10 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Nel","value":"{\"report_to\":\"cf-nel\",\"success_fraction\":0.0,\"max_age\":604800}"},{"key":"X-Frame-Options","value":"ALLOW-FROM *"},{"key":"Referrer-Policy","value":"no-referrer"},{"key":"x-session-id","value":"c2111eb2-6314-4f0b-b546-4ae3ee123a44"},{"key":"Vary","value":"Origin"},{"key":"Vary","value":"Access-Control-Request-Method"},{"key":"Vary","value":"Access-Control-Request-Headers"},{"key":"Server","value":"cloudflare"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"0"},{"key":"Cache-Control","value":"no-cache, no-store, max-age=0, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Expires","value":"0"},{"key":"Strict-Transport-Security","value":"max-age=31536000 ; includeSubDomains"},{"key":"X-Cache","value":"Error from cloudfront"},{"key":"Via","value":"1.1 6a91ddfdf36644f1344da228258d9082.cloudfront.net (CloudFront)"},{"key":"X-Amz-Cf-Pop","value":"IAD61-P10"},{"key":"X-Amz-Cf-Id","value":"lKDk7cJHKNy2cOdf_AWXk3GlUJdWC5slaGWaVfgUf1Fn0XXm7T7D7Q=="},{"key":"cf-cache-status","value":"DYNAMIC"},{"key":"Report-To","value":"{\"group\":\"cf-nel\",\"max_age\":604800,\"endpoints\":[{\"url\":\"https://a.nel.cloudflare.com/report/v4?s=YLhXcnCfKpMy2KQEcmek7bxnkI2lT3%2F5IQ8opo9ZpZ4E852qZoWIFsjJ%2BcmGZfTO7S1rWYnB3uzuGwMYwevQ%2F47w%2Bm6u51jrIfjuG3TDh08KGeWKRbR92ItXRYPoh1CgVmja\"}]}"},{"key":"CF-RAY","value":"9eec7f31f973c9b7-IAD"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"content\": [\n {\n \"transaction_id\": \"69e2146828bea6ca2e31bc85\",\n \"status\": \"paid\"\n },\n {\n \"transaction_id\": \"69e20fd928bea6ca2e31b17c\",\n \"status\": \"paid\"\n }\n ],\n \"currentPage\": 1,\n \"pageSize\": 2,\n \"totalElements\": 95,\n \"totalPages\": 48,\n \"first\": true,\n \"last\": false,\n \"hasNext\": true,\n \"hasPrevious\": false\n }\n}"}],"_postman_id":"ccef1da2-d9c1-427e-b3b7-9a1331685c6f"},{"name":"Get Detailed Transaction Details","id":"4c938dc5-c96c-4eed-af34-abbff7a16c93","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"BrandId","value":"your-brand-id"},{"key":"Authorization","value":"Bearer {{APIKey}}"}],"url":"https://api.paystreamportal.com/api/v1/external/transactions/data/69e20fd928bea6ca2e31b17c?page_no=1&page_size=10&include_subtransactions=true","description":"Retrieves the complete details for a specific transaction. This includes customer info, payment method details, bank response codes, and hierarchy metadata (parent/child transactions).
\nAdditional query parameters for this usecase:
\n","urlObject":{"path":["external","transactions","data","69e20fd928bea6ca2e31b17c"],"host":["https://api.paystreamportal.com/api/v1"],"query":[{"key":"page_no","value":"1"},{"key":"page_size","value":"10"},{"key":"include_subtransactions","value":"true"}],"variable":[]}},"response":[{"id":"edf854b6-1449-4874-89c0-b4d411bb94da","name":"Success","originalRequest":{"method":"GET","header":[{"key":"BrandId","value":"your-brand-id"},{"key":"Authorization","value":"Bearer {{APIKey}}"}],"url":{"raw":"https://api.paystreamportal.com/api/v1/external/transactions/data/69e20fd928bea6ca2e31b17c?page_no=1&page_size=10&include_subtransactions=true","host":["https://api.paystreamportal.com/api/v1"],"path":["external","transactions","data","69e20fd928bea6ca2e31b17c"],"query":[{"key":"page_no","value":"1"},{"key":"page_size","value":"10"},{"key":"include_subtransactions","value":"true"}]}},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[{"key":"Date","value":"Sun, 19 Apr 2026 14:13:09 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Nel","value":"{\"report_to\":\"cf-nel\",\"success_fraction\":0.0,\"max_age\":604800}"},{"key":"X-Frame-Options","value":"ALLOW-FROM *"},{"key":"Referrer-Policy","value":"no-referrer"},{"key":"x-session-id","value":"3d9fb1d1-b30f-4c3e-a76f-6956e3731ad3"},{"key":"Vary","value":"Origin"},{"key":"Vary","value":"Access-Control-Request-Method"},{"key":"Vary","value":"Access-Control-Request-Headers"},{"key":"Server","value":"cloudflare"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"0"},{"key":"Cache-Control","value":"no-cache, no-store, max-age=0, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Expires","value":"0"},{"key":"Strict-Transport-Security","value":"max-age=31536000 ; includeSubDomains"},{"key":"X-Cache","value":"Error from cloudfront"},{"key":"Via","value":"1.1 64d4305f6a0418824e90908ac490184e.cloudfront.net (CloudFront)"},{"key":"X-Amz-Cf-Pop","value":"IAD61-P10"},{"key":"X-Amz-Cf-Id","value":"COt7k0tEcVGSOSy8pTkHoOqGoG1lSgC9qz8baoKbgmPkAh5dq0GNjQ=="},{"key":"cf-cache-status","value":"DYNAMIC"},{"key":"Report-To","value":"{\"group\":\"cf-nel\",\"max_age\":604800,\"endpoints\":[{\"url\":\"https://a.nel.cloudflare.com/report/v4?s=hn0q1Q9Cqa9onXwzy%2F1Qeq8u4RTGt3q%2BZNFW29weO%2BOmtABh6y8XLnAH9%2FytCQEEOmNzdnvM0oPcQruiJvYqQQShCKOndiMKUnEksUPM9I9UMph4qP7s1ognTK%2BBhheXvIwO\"}]}"},{"key":"CF-RAY","value":"9eec821e0f4b172c-IAD"}],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\n \"data\": {\n \"transaction_id\": \"69e20fd928bea6ca2e31b17c\",\n \"merchant_reference\": \"69e20fd928bea6ca2e31b17c\",\n \"customer_id\": \"NA\",\n \"amount\": 1.0,\n \"currency\": \"USD\",\n \"status\": \"paid\",\n \"session_id\": \"\",\n \"email\": \"user1661@example.com\",\n \"merchant_name\": \"globex12merch\",\n \"payment_method\": \"MASTER\",\n \"payment_flow\": \"payform\",\n \"issuing_bank\": \"PUBLIC BANK BERHAD\",\n \"created_at\": \"2026-04-17T10:47:53Z\",\n \"error_reason\": \"Transaction succeeded-APPROVED\",\n \"last_updated_at\": \"2026-04-17T10:49:14Z\",\n \"transaction_type\": \"parent\",\n \"fees\": [\n {\n \"type\": \"mdr\",\n \"amount\": 0.00,\n \"currency\": \"USD\"\n },\n {\n \"type\": \"decline_fee\",\n \"amount\": 0,\n \"currency\": \"USD\"\n },\n {\n \"type\": \"transaction_fee\",\n \"amount\": 0.1,\n \"currency\": \"USD\"\n },\n {\n \"type\": \"fraud_refund_fee\",\n \"amount\": 0,\n \"currency\": \"USD\"\n },\n {\n \"type\": \"refund_fee\",\n \"amount\": 0,\n \"currency\": \"USD\"\n },\n {\n \"type\": \"chargeback_fee\",\n \"amount\": 0,\n \"currency\": \"USD\"\n },\n {\n \"type\": \"extra_fee\",\n \"amount\": 0,\n \"currency\": \"USD\"\n }\n ],\n \"metadata\": {\n \"has_subtransactions\": false,\n \"total_subtransactions\": 0,\n \"transaction_hierarchy_level\": \"parent\"\n }\n }\n}"}],"_postman_id":"4c938dc5-c96c-4eed-af34-abbff7a16c93"}],"id":"848315cc-37e3-49b1-ac42-04f45a4d1a84","description":"Overview
\nThe Transaction Reporting APIs allow merchants to retrieve detailed logs of their payment activity programmatically. This is useful for:
\n- \n
Reconciliation: Matching Paystream records with your internal order system.
\n \nAudit Trails: Tracking the status history of specific transactions.
\n \nData Export: Pulling transaction data into your own analytics tools.
\n \n
There are two primary endpoints:
\n- \n
List Transactions: Retrieves a paginated list of all transactions for a specific Brand ID.
\n \nGet Transaction Details: Retrieves the full data payload for a single transaction ID, including metadata and sub-transaction details.
\n \n
Before you can use network tokenisation in your payment flow, the feature must be enabled and configured on your merchant account. This section walks through the setup steps in the Paystream Dashboard.
\nEnabling Network Tokenisation
\nNetwork tokenisation requires activation at the merchant level. Follow these steps in the Paystream Dashboard:
\n- \n
Log in to your Paystream merchant account.
\n \nNavigate to Merchant Details → Allowed Services.
\n \nEnable “Allow Network Token” to activate tokenisation for your account.
\n \n
Admin Activation Required
Network tokenisation must first be enabled at the platform level by your Paystream account administrator. If you do not see the “Allow Network Token” option in your dashboard, contact your Paystream account manager to request activation.
Paystream Token Service Setup
\nAfter enabling network tokenisation, configure the Paystream Token Service with your merchant details:
\n- \n
In the Paystream Dashboard, navigate to Global Settings → Paystream Token Service.
\n \nFill in all the required fields accurately.
\n \nEnter your Category Code — this represents your merchant business type code (MCC).
\n \nClick Save.
\n \nAfter saving, verify that the status shows as Pending (visible in the top-right corner of the page).
\n \nThe status will automatically update to Active or Error once your token profile is created.
\n \n
Status Update Timing: The status update from Pending to Active may take up to 1 hour. Do not attempt to use tokenisation APIs until the status shows Active. If the status changes to Error, contact your Paystream account manager for resolution.
\nStatus Values
\n","auth":{"type":"noauth","isInherited":false},"event":[{"listen":"prerequest","script":{"type":"text/javascript","packages":{},"requests":{},"exec":[""],"id":"652a7bea-0e87-4fc8-ab9a-bf68fdcef25b"}},{"listen":"test","script":{"type":"text/javascript","packages":{},"requests":{},"exec":[""],"id":"85dc3cae-123a-4558-8fdb-3634cfc52436"}}],"_postman_id":"085d9440-5def-4b4c-9b78-f25227a8b554"},{"name":"APIs","item":[{"name":"List Saved Cards","id":"45bd7475-c5bc-45c7-8ebc-873c720bd0c7","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[],"url":"https://api.paystreamportal.com/listSavedCards","description":"List Saved Cards
\nRetrieve all saved card tokens for a given customer. Returns the last 4 digits of each card and its associated token_reference.
Use this API to display saved cards to the customer for selection before initiating a payment via the S2S API.
\nQuery Parameters
\nResponse Fields
\nNotes
\n- \n
The
\ntoken_referencedoes not expire. It remains valid as long as the saved card has not been deleted. \nShow saved cards to the customer using
\ncard_last_fouralongside a card brand icon (Visa / Mastercard). \nThe
\ntoken_referenceshould only be stored and used server-side. \n
Display Tip
\nShow saved cards using cardlast4 alongside a card brand icon (Visa / Mastercard).
The token_reference should only be stored and used server-side.
Purchase
\nInitiate a payment transaction. This is the standard Paystream Purchase API.
\nWhen a customer completes the purchase on the Paystream checkout page and opts to save their card, Paystream provisions a network token in the background and generates a token_reference linked to the customer.
Mandatory Parameters
\nOptional Parameters
\nKey Response Fields
\nNetwork Tokenisation & Card Saving
\nWhen the customer completes payment via checkout_url and opts to save their card, Paystream provisions a network token. The token_reference is then available via the List Saved Cards API.
S2S Payment
\nProcess a payment using a saved card's token_reference. Paystream resolves the token reference to the underlying network token and processes the payment securely. If the selected MID does not accept tokens, Paystream automatically falls back to the card number.
S2S Input Scenarios
\nThe S2S API accepts different input types depending on the scenario:
\nRequest Body
\nToken Reference in Response
\n- \n
Scenario 1 (New card via S2S):
\ntoken_referencereturned in Check Status and Webhook. \nScenario 2 (Existing
\ntoken_reference):token_referencereturned in response and Webhook. \n
Important Notes
\n- \n
CVC is required even when using a
\ntoken_reference. \nAll browser fields are required for 3D Secure authentication.
\n \nResponse follows the standard Paystream payment response format.
\n \n
Must be \"true\" for server-to-server requests.
\n","type":"text/plain"},"key":"s2s","value":"true"}],"variable":[]}},"response":[{"id":"8638a55d-97aa-46cb-85b0-f74547f18a39","name":"Success","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer {{APIKey}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"Token_reference\": \"token_7178aa7208614544a285656da38ae5ac\",\n \"cvc\": \"791\",\n \"remember_card\": \"off\",\n \"remote_ip\": \"203.0.113.121\",\n \"user_agent\": \"Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/51.0.2704.103 Safari/537.36\",\n \"accept_header\": \"text/html\",\n \"language\": \"en-US\",\n \"java_enabled\": false,\n \"javascript_enabled\": true,\n \"color_depth\": 24,\n \"utc_offset\": 0,\n \"screen_width\": 1920,\n \"screen_height\": 1080\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://api.paystreamportal.com/api/v1/api/v1/p/6980e509b5e99e61f3bd4ccf/?s2s=true","host":["https://api.paystreamportal.com/api/v1"],"path":["api","v1","p","6980e509b5e99e61f3bd4ccf",""],"query":[{"key":"s2s","value":"true"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"pending\",\n \"callback_url\": \"https://api.paystreamportal.com/api/v1/payment/64b034ecc6dccf7d329d9eb3/\",\n \"method\": \"GET\"\n}"}],"_postman_id":"701b2668-7bc0-426d-9b92-e5a00b1883fa"},{"name":"Delete Token","id":"99100138-bd95-4d1c-926e-ceb7919f79e4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"Authorization","value":"Bearer {{APIKey}}","type":"text"}],"url":"https://api.paystreamportal.com/api/v1/tokens/v1/deleteToken/{{token_reference}}","description":"Delete Token
\nPermanently delete a saved card and deactivate the associated network token. This action is irreversible.
\nPath Parameters
\nImportant Notes
\n- \n
Deleting a token is permanent. The
\ntoken_referencecan no longer be used for payments. \nThe associated network token is deactivated with the card network.
\n \nIf the customer wants to pay with this card again, they will need to re-enter their card details.
\n \n
When to Delete
\n- \n
Customer explicitly requests removal of their saved card.
\n \nGDPR or data retention compliance when a customer closes their account.
\n \nConsider implementing a \"Remove Card\" option in your account management UI.
\n \n
Overview
\nThe Original Credit Transaction (OCT), commonly referred to as Push to Card, enables merchants to facilitate near-instantaneous fund transfers directly to a customer’s eligible Visa or Mastercard debit or credit card. Unlike traditional refund processes that can only return funds from a previous purchase, OCT allows for independent disbursements of funds to a cardholder's account.
\nThis feature is designed for high-velocity industries that require frictionless, real-time payouts, such as:
\n- \n
Gaming & Betting: Real-time withdrawal of player winnings.
\n \nMarketplaces: Payouts to sellers or service providers.
\n \nCorporate Disbursements: Instant insurance claims, rebates, or compensation payments.
\n \nMerchant Settlements: Faster access to processed funds for sub-merchants.
\n \n
By utilizing the Paystream /payout API with the PAYOUT-CARDS method, you benefit from a unified orchestration layer that handles the complexities of card network routing, ensuring high success rates and global reach while maintaining the same security standards as your standard payment integrations.
\n
Integration Steps
\n- \n
Enable OCT: Ensure \"Push to Card\" permissions are enabled for your merchant account in the Paystream Merchant Portal.
\n \nCollect Card Details: Use a secure method to collect the recipient's card number and expiry date or can you Paystream's cashier to do that.
\n \nExecute Payout: Call the
\n/payoutendpoint with the OCT-specific payout method. \nHandle Webhooks: Listen for the
\npaidorfailureevents to update your internal records. \n
Mandatory parameters in the request body:
\nNote:
\nIf the merchant is not PCI DSS compliant then they will need to use our cashier and we will show the user all the saved cards for him/her. Based on the card chosen, Paystream will pick up the token_reference from our Back end.
\nIf the merchant is PCI DSS compliant then they can use the payout API and send the token reference as shown above.
\n","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"0b1f6c38-565f-45cd-9ab3-ba41c90cf2c1","id":"0b1f6c38-565f-45cd-9ab3-ba41c90cf2c1","name":"APIs","type":"folder"}},"urlObject":{"path":["payout",""],"host":["https://api.paystreamportal.com/api/v1"],"query":[],"variable":[]}},"response":[{"id":"d24f18ca-5faa-479e-9b7e-b4520ccb757a","name":"Success","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer {{APIKey}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"client\": {\n \"email\": \"user3069@example.com\",\n \"country\": \"GB\",\n \"city\": \"Milford\",\n \"stateCode\": \"QLD\",\n \"full_name\": \"Reese Moreau\",\n \"street_address\": \"13 Documentation Way\",\n \"zip_code\": \"68403\",\n \"phone\": \"+44 9876543210\",\n \"gender\": \"M\",\n \"date_of_birth\": \"1970-07-10\"\n },\n \"purpose\": \"Testing cards payout\",\n \"currency\": \"GBP\",\n \"merchantRef\": \"YOUR ORDER ID\", // optional\n \"payoutMethod\": \"PAYOUT-CARDS\",\n \"amount\": 100.0,\n \"success_redirect\": \"https://your.success.redirect.com\",\n \"pending_redirect\": \"https://your.pending.redirect.com\",\n \"failure_redirect\": \"https://your.failure.redirect.com\",\n \"success_callback\": \"https://your.success.callback.com\",\n \"failure_callback\": \"https://your.failure.callback.com\",\n \"extraParam\": {\n \"token_reference\": \"token_ref\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://api.paystreamportal.com/api/v1/payout/"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"Text","header":[{"key":"Date","value":"Fri, 13 Mar 2026 00:01:17 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Nel","value":"{\"report_to\":\"cf-nel\",\"success_fraction\":0.0,\"max_age\":604800}"},{"key":"X-Frame-Options","value":"ALLOW-FROM *"},{"key":"Referrer-Policy","value":"no-referrer"},{"key":"x-session-id","value":"3ef27476-f274-4f6a-bb18-4c37e01d6dc2"},{"key":"Vary","value":"Origin"},{"key":"Vary","value":"Access-Control-Request-Method"},{"key":"Vary","value":"Access-Control-Request-Headers"},{"key":"Server","value":"cloudflare"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"0"},{"key":"Cache-Control","value":"no-cache, no-store, max-age=0, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Expires","value":"0"},{"key":"Strict-Transport-Security","value":"max-age=31536000 ; includeSubDomains"},{"key":"X-Cache","value":"Error from cloudfront"},{"key":"Via","value":"1.1 05a63efd5ebb043211ccf075f3a8aa68.cloudfront.net (CloudFront)"},{"key":"X-Amz-Cf-Pop","value":"IAD61-P10"},{"key":"X-Amz-Cf-Id","value":"Iw6KuTkxZqm0RH8GJOXAh7uLEPJ6wj8OJbaFWdN_qDx31b5TSinnIA=="},{"key":"cf-cache-status","value":"DYNAMIC"},{"key":"Report-To","value":"{\"group\":\"cf-nel\",\"max_age\":604800,\"endpoints\":[{\"url\":\"https://a.nel.cloudflare.com/report/v4?s=g%2FW8jRMDFXKvTeXNugr1sgR4%2FoTXfyEHsscr3hqeIr2aPhFEVlSs%2FGiTjFw09%2BReVDjxT2esg2Wg0fdBf4oD3snlEv4p1JkITe2l7oLC%2Bkg%3D\"}]}"},{"key":"CF-RAY","value":"9db6c366997196a2-IAD"}],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\n \"payoutId\": \"6977137755e0628e3600c562\",\n \"client\": {\n \"email\": \"user3069@example.com\",\n \"country\": \"GB\",\n \"city\": \"Milford\",\n \"stateCode\": \"QLD\",\n \"full_name\": \"Reese Moreau\",\n \"street_address\": \"13 Documentation Way\",\n \"zip_code\": \"68403\",\n \"phone\": \"+44 9876543210\",\n \"gender\": \"M\",\n \"date_of_birth\": \"1970-07-10\"\n },\n \"updated_on\": 1769411447,\n \"extraParam\": {\n \"token_reference\": \"token_ref\"\n },\n \"payoutMethod\": \"PAYOUT-CARDS\",\n \"amountUnit\": \"MAJOR\",\n \"amount\": 100.0,\n \"errorMsg\": \"\",\n \"purpose\": \"Testing cards payout\",\n \"created_on\": 1769411447,\n \"merchantRef\": \"YOUR ORDER ID\",\n \"status\": \"PAID\",\n \"status_history\": [\n {\n \"status\": \"created\",\n \"timestamp\": 1769411447\n },\n {\n \"status\": \"payout_in_process\",\n \"timestamp\": 1769411447\n },\n {\n \"status\": \"paid\",\n \"timestamp\": 1769411447\n },\n\n ],\n \"currency\": \"GBP\",\n \"extraFee\": \"0\",\n \"paymentOn\": 0,\n \"checkout_url\": \"https://api.paystreamportal.com/payout/092e59f94279a3742fa3715fe9a2112a/\",\n \"taxAmount\": 0.0,\n \"taxPercent\": 0.0,\n \"success_redirect\": \"https://your.success.redirect.com\",\n \"pending_redirect\": \"https://your.pending.redirect.com\",\n \"failure_redirect\": \"https://your.failure.redirect.com\",\n \"success_callback\": \"https://your.success.callback.com\",\n \"failure_callback\": \"https://your.failure.callback.com\"\n \"redirectType\": \"POST\",\n \"sessionId\": \"\",\n \"surcharge\": 0.0,\n \"surchargeType\": \"\",\n \"trxMethod\": \"CARDS\",\n \"success_callback\": \"https://your.success.callback.com\",\n \"failure_callback\": \"https://your.failure.callback.com\"\n}"}],"_postman_id":"8b23da0e-7e0d-46f4-ab1f-caf7a9a33991"}],"id":"0b1f6c38-565f-45cd-9ab3-ba41c90cf2c1","description":"Network tokenisation in Paystream uses four APIs. Together they cover the complete flow: retrieving saved cards, initiating a purchase (with card saving), processing payments with saved tokens, and deleting tokens.
\n","auth":{"type":"noauth","isInherited":false},"event":[{"listen":"prerequest","script":{"type":"text/javascript","packages":{},"requests":{},"exec":[""],"id":"f4f94607-692e-4225-aac8-9ad5a9f15d86"}},{"listen":"test","script":{"type":"text/javascript","packages":{},"requests":{},"exec":[""],"id":"0eca75c3-6f0a-4504-9918-ca4a0c2dddc9"}}],"_postman_id":"0b1f6c38-565f-45cd-9ab3-ba41c90cf2c1"},{"name":"FAQs","item":[],"id":"a19662fe-343f-40fd-aaac-592239b49ccb","description":"Q1: Do I need to change my existing integration to use network tokenisation?
No. If you already use the Paystream Purchase API and the S2S API with token_reference, your integration is already compatible. You just need to enable and configure network tokenisation in your Dashboard (see Section 3).
Q2: What is a token_reference?
A token_reference (e.g., token_7178aa7208614544a285656da38aefac) is Paystream’s internal identifier for a saved card. You use it to charge the saved card or delete it. It is not the card number or the network token — Paystream manages those internally.
Q3: Does the token_reference expire?
No. The token_reference does not expire. It remains valid as long as the saved card has not been deleted.
Q4: What happens when a customer’s card expires or is replaced?
\nThe card network automatically updates the data linked to the token. Your token_reference stays the same, and payments continue to work without action from you or the customer.
\nQ5: Is CVC required even when using a token_reference?
Yes. CVC is required even when a token_reference is provided. This is needed for 3D Secure authentication on customer-initiated transactions.
Q6: What if a card doesn’t support network tokenisation?
Paystream handles this automatically. If a card is not eligible, or if the selected MID does not accept tokens, Paystream falls back to the card number. The API response and flow remain the same.
Q7: How long does the token service setup take?
After saving your configuration in Dashboard → Global Settings → Paystream Token Service, the status changes to Pending. It may take up to 1 hour to update to Active. Do not use tokenisation APIs until the status is Active.
Q8: Are email addresses case-sensitive for token lookup?
Yes. Email addresses are case-sensitive. Ensure consistent formatting (always lowercase) when creating and retrieving tokens to avoid duplicate or missing entries.
Q9: How do I delete a saved card?
Use the Delete Token API (DELETE /tokens/v1/deleteToken/{token_reference}). This permanently removes the card and deactivates the network token.
Q10: Is there an additional cost?
Pricing details are communicated by your Paystream account manager. Some card networks offer reduced interchange fees for tokenised transactions, which may offset service costs.
Overview
\nPaystream supports Network Tokenisation to help merchants process card payments with improved security, higher authorisation rates, and seamless card lifecycle management.
\nNetwork tokenisation works entirely behind the scenes. When a cardholder saves their card during a purchase, Paystream securely provisions a network token and returns a token_reference. You use this reference for all future payments — you never handle actual card numbers or network tokens directly.
Benefits
\n- \n
Higher Approval Rates — Payments made with network tokens are recognised as more secure by issuers.
\n \nAutomatic Card Updates — Card replacements are handled silently by the card network.
\n \nStronger Security — Each token is merchant-specific and protected by a per-transaction cryptogram.
\n \nReduced PCI Burden — Store
\ntoken_referenceinstead of card numbers. \nZero Integration Overhead — Your existing API integration works as-is.
\n \n
API Flow
\nNetwork tokenisation is fully managed by Paystream. The integration follows the standard Paystream payment APIs:
\nThe Merchant Flow
\n- \n
Call the List Saved Cards API to check if the customer has saved cards
\n \nIf no saved cards exist, initiate a new payment via the Purchase + S2S API
\n
→ If the merchant opts to save the customer card, Paystream provisions a network token
→ Customer completes payment
→ A token_reference is generated and linked to the customer and card \nFor returning customers with saved cards:
\n
→ Display saved cards using cardlast4 from List Saved Cards
→ Customer selects a card and provides CVC
→ Submit token_reference + CVC via the purchase + S2S API \nTo remove a saved card, call the Delete Token API.
\n \n
Network tokenisation happens behind the scenes with no additional API calls and no changes to your existing flow.
\n- \n
List Saved Cards — Check if the customer has saved cards
\n \nPurchase — Initiate a new payment (customer can save card during checkout)
\n \nS2S Payment — Charge a saved card using
\ntoken_reference\nDelete Token — Remove a saved card permanently
\n \n
Key Takeaway
\nYou never see or handle the actual network token. Paystream abstracts it entirely behind the token_reference. Your integration stays simple while your customers get the security and reliability benefits of network tokenisation.
\nEnvironments
\n","auth":{"type":"noauth","isInherited":false},"event":[{"listen":"prerequest","script":{"type":"text/javascript","packages":{},"requests":{},"exec":[""],"id":"7540f35b-ab09-4ea9-b55c-ea59111f0c2b"}},{"listen":"test","script":{"type":"text/javascript","packages":{},"requests":{},"exec":[""],"id":"ac7a746f-f76e-4508-ba72-229bc60d065e"}}],"_postman_id":"bfaf1a22-abd2-463d-859d-40d8ea52d9ac"},{"name":"Pre Authorization","item":[{"name":"Prerequisites","item":[],"id":"23243f76-ccc1-4a47-8823-9841ca87c152","description":"Before integrating the pre-authorisation flow, ensure you have the following:
\n2.1 Account Setup
\n2.2 Environments
\n2.3 Authentication
\nAll API requests must include your API key in the request header.
Paystream uses bearer token authentication.
Authorization: Bearer {your_api_key}
\nContent-Type: application/json
\nImportant: Never expose your API key in client-side code or public repositories. All API calls must be made server-to-server.
\n","auth":{"type":"noauth","isInherited":false},"event":[{"listen":"prerequest","script":{"type":"text/javascript","packages":{},"requests":{},"exec":[""],"id":"68bb6f6d-c877-49aa-a4f3-10e5a7ea6303"}},{"listen":"test","script":{"type":"text/javascript","packages":{},"requests":{},"exec":[""],"id":"3ef8e7f4-600d-496a-bb5d-d07e07a95b44"}}],"_postman_id":"23243f76-ccc1-4a47-8823-9841ca87c152"},{"name":"Payment Flow Overview","item":[],"id":"0e143217-4797-45a9-b5e4-ffc6bbb72ec8","description":"The pre-authorisation and capture flow involves three distinct stages. Below is a high-level summary of each path the transaction can follow after authorisation.
\n3.1 Flow Summary
\nStep 1 - The merchant sends a pre-authorisation request to reserve funds on the customer’s card. If successful, the transaction enters an AUTHORISED state.
\nStep 2a (Capture Path) - The merchant sends a capture request for the full or partial authorised amount. On success, the transaction moves to CAPTURED and funds are settled.
\nStep 2b (Void Path) - If the merchant no longer needs to collect the payment, they send a void request. The hold is released and the transaction moves to VOIDED.
\n3.2 State Transition Diagram
\nThe following diagram describes all possible states:
\nℹ️ Note
\nOnce a transaction is PAID or VOIDED, it cannot be reversed through this flow. Use the Refund API for post-capture reversals.
\n3.3 Authorisation Validity Periods
\nCard networks enforce maximum hold periods. If you do not capture within the validity window, the authorisation expires automatically and funds are released.
\n⚠️ Best Practice
\nCapture as soon as the order is ready to ship or the service is delivered. Delaying capture increases the risk of authorisation expiry and declines.
\n","auth":{"type":"noauth","isInherited":false},"event":[{"listen":"prerequest","script":{"type":"text/javascript","packages":{},"requests":{},"exec":[""],"id":"0a3f3125-dd6c-4178-97c2-222d69d8eb88"}},{"listen":"test","script":{"type":"text/javascript","packages":{},"requests":{},"exec":[""],"id":"5bad024d-09b1-418a-a21f-544e105c01dc"}}],"_postman_id":"0e143217-4797-45a9-b5e4-ffc6bbb72ec8"},{"name":"APIs","item":[{"name":"Purchase","id":"023188ea-ba14-4dcd-991d-e815bb02069f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer {{APIKey}}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"client\": {\r\n \"email\": \"user6085@example.com\",\r\n \"country\": \"IN\",\r\n \"city\": \"123\",\r\n \"stateCode\": \"ca\",\r\n \"street_address\": \"test test\",\r\n \"zip_code\": \"234567\",\r\n \"phone\": \"+91 9999999999\"\r\n },\r\n \"purchase\": {\r\n \"products\": [\r\n {\r\n \"name\": \"dk\",\r\n \"price\": \"10\"\r\n }\r\n ]\r\n },\r\n \"status\": \"created\",\r\n \"brand_id\": \"your-brand-id\",\r\n \"skip_capture\": true,\r\n \"merchantRef\": \"d9db7ec0-f94c-4a9d-8883-54c19c222d81\",\r\n \"success_redirect\": \"https://your.success.redirect.com\",\r\n \"pending_redirect\": \"https://your.pending.redirect.com\",\r\n \"failure_redirect\": \"https://your.failure.redirect.com\",\r\n \"success_callback\": \"https://your.success.callback.com\",\r\n \"failure_callback\": \"https://your.failure.callback.com\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.paystreamportal.com/api/v1/purchases","description":"Use this endpoint to authorise a payment without capturing it. This places a temporary hold on the customer’s funds for the specified amount.
\nTo Initiate a payment, the very first call to make is /purchases with the required data in the request body.
To generate a Purchase, you are required to provide the Brand ID (in the request body) and API key (in the header) Both can be located in the Dashboard section of your merchant account login.
The request body structure is shown on the request body of the example request shown here.
\nThe following (see table below) are the mandatory parameters that are required to create a purchase request.
\nMandatory parameters in the request body:
\nAdditional parameters for this usecase:
\nEssential Optional Parameters
\nmerchantRef
\nThe merchantRef parameter, although not mandatory, is strongly advised for merchants to specify. Its inclusion offers two significant advantages for the merchant:
- \n
Prevention of Duplicate Requests: When a
\nmerchantRefis utilized, it acts as a unique identifier. This means that if a second purchase request is made using the samemerchantRef(reference number), the system will recognize it and prevent duplicate transactions from occurring. This prevents unintended or duplicate purchases. \nFacilitation of Transaction Retrieval: In situations where the response from the initial purchase request times out or the 'purchaseId' isn't received, having the
\nmerchantRefallows 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.
\nUpon successul create on a Purchase you'd get a \"purchaseId\" . Use this ID for the next step in Server to server call by calling p/{purchaseId}/?s2s=true .
paymentMethod
\nThe paymentMethod parameter identifies which payment solution merchant wants to use to perform a transaction. If parameter is provided, than Paystream will perform direct payment with the selected payment method instead of loading Paystream URL.
Errors
\nIf there are any errors then it'll be in the format of :
\n{\n \"message\": \"descriptive error message\",\n \"code\": \"error_code\"\n}\n\nPossible Error Messages
\n","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"705e1da1-f74e-4951-99e2-77c545ad8a63","id":"705e1da1-f74e-4951-99e2-77c545ad8a63","name":"APIs","type":"folder"}},"urlObject":{"path":["purchases"],"host":["https://api.paystreamportal.com/api/v1"],"query":[],"variable":[]}},"response":[{"id":"d5ce11b2-e05e-47b7-bd08-86d0a874beaf","name":"Purchase","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"client\": {\r\n \"email\": \"user6085@example.com\",\r\n \"country\": \"IN\",\r\n \"city\": \"123\",\r\n \"stateCode\": \"ca\",\r\n \"street_address\": \"test test\",\r\n \"zip_code\": \"234567\",\r\n \"phone\": \"+91 9999999999\"\r\n },\r\n \"purchase\": {\r\n \"products\": [\r\n {\r\n \"name\": \"dk\",\r\n \"price\": \"10\"\r\n }\r\n ]\r\n },\r\n \"status\": \"created\",\r\n \"brand_id\": \"your-brand-id\",\r\n \"skip_capture\": true,\r\n \"merchantRef\": \"d9db7ec0-f94c-4a9d-8883-54c19c222d81\",\r\n \"success_redirect\": \"https://your.success.redirect.com\",\r\n \"pending_redirect\": \"https://your.pending.redirect.com\",\r\n \"failure_redirect\": \"https://your.failure.redirect.com\",\r\n \"success_callback\": \"https://your.success.callback.com\",\r\n \"failure_callback\": \"https://your.failure.callback.com\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.paystreamportal.com/api/v1/purchases"},"status":"Accepted","code":202,"_postman_previewlanguage":"json","header":[{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"Cache-Control","value":"no-cache, no-store, max-age=0, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Expires","value":"0"},{"key":"X-Frame-Options","value":"DENY"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Date","value":"Thu, 13 Jul 2023 17:22:14 GMT"},{"key":"Keep-Alive","value":"timeout=60"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\n \"purchaseId\": \"64b032c3c6dccf7d329d9e7e\",\n \"client\": {\n \"bank_account\": \"\",\n \"bank_code\": \"\",\n \"email\": \"user9283@example.com\",\n \"phone\": \"\",\n \"full_name\": \"\",\n \"date_of_birth\": \"\",\n \"personal_code\": \"\",\n \"street_address\": \"test test\",\n \"country\": \"IN\",\n \"city\": \"123\",\n \"zip_code\": \"234567\",\n \"shipping_street_address\": \"\",\n \"shipping_country\": \"\",\n \"shipping_city\": \"\",\n \"shipping_zip_code\": \"\",\n \"cc\": [],\n \"bcc\": [],\n \"legal_name\": \"\",\n \"brand_name\": \"\",\n \"registration_number\": \"\",\n \"tax_number\": \"\",\n \"stateCode\": \"ca\"\n },\n \"updated_on\": 1689268934,\n \"type\": \"purchase\",\n \"force_recurring\": false,\n \"created_on\": 1689268934,\n \"purchase\": {\n \"currency\": \"USD\",\n \"products\": [\n {\n \"name\": \"dk\",\n \"quantity\": 1,\n \"price\": 10,\n \"discount\": 0,\n \"tax_percent\": \"0.00\"\n }\n ],\n \"total\": 10,\n \"language\": \"en\",\n \"notes\": \"\",\n \"debt\": 0,\n \"total_formatted\": 1,\n \"request_client_details\": [],\n \"timezone\": \"America/Edmonton\",\n \"email_message\": \"\"\n },\n \"issuer_details\": {\n \"website\": \"\",\n \"legal_street_address\": \"\",\n \"legal_country\": \"\",\n \"legal_city\": \"\",\n \"legal_zip_code\": \"\",\n \"bank_accounts\": [\n {\n \"bank_account\": \"\",\n \"bank_code\": \"\"\n }\n ],\n \"legal_name\": \"shoes\",\n \"brand_name\": \"shoes\",\n \"registration_number\": \"\",\n \"tax_number\": \"\"\n },\n \"transaction_data\": {\n \"payment_method\": \"\",\n \"flow\": \"payform\",\n \"extra\": {},\n \"country\": \"\",\n \"attempts\": []\n },\n \"status\": \"CREATED\",\n \"status_history\": [\n {\n \"status\": \"created\",\n \"timestamp\": 1689268934\n }\n ],\n \"is_test\": false,\n \"brand_id\": \"your-brand-id\",\n \"is_recurring_token\": false,\n \"reference_generated\": \"PS161\",\n \"merchantRef\":\"d9db7ec0-f94c-4a9d-8883-54c19c222d81\",\n \"issued\": \"2023-07-13\",\n \"due\": 1689268934,\n \"refund_upto\": 0,\n \"cc_descriptor\": \"\",\n \"refund_availability\": \"NONE\",\n \"refundable_amount\": 0,\n \"success_redirect\": \"https://your.success.redirect.com\",\n \"failure_redirect\": \"https://your.failure.redirect.com\",\n \"cancel_redirect\": \"\",\n \"success_callback\": \"https://your.success.callback.com\",\n \"platform\": \"API\",\n \"created_from_ip\": \"203.0.113.133\",\n \"checkout_url\": \"https://api.paystreamportal.com/payments/64b032c3c6dccf7d329d9e7e/\",\n \"direct_post_url\": \"https://api.paystreamportal.com/api/v1/p/64b032c3c6dccf7d329d9e7e/\"\n}"}],"_postman_id":"023188ea-ba14-4dcd-991d-e815bb02069f"},{"name":"S2S","id":"185dd3ab-180b-4a7e-b38a-0fcd4a90b666","protocolProfileBehavior":{"disableUrlEncoding":false,"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer {{APIKey}}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"cardholder_name\": \"dk\",\r\n \"card_number\": \"4111111111111111\",\r\n \"expires\": \"10/23\",\r\n \"cvc\": \"345\",\r\n \"remember_card\": \"on\",\r\n \"remote_ip\": \"203.0.113.121\",\r\n \"user_agent\": \"Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/51.0.2704.103 Safari/537.36\",\r\n \"accept_header\": \"text/html\",\r\n \"language\": \"en-US\",\r\n \"java_enabled\": false,\r\n \"javascript_enabled\": true,\r\n \"color_depth\": 24,\r\n \"utc_offset\": 0,\r\n \"screen_width\": 1920,\r\n \"screen_height\": 1080\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.paystreamportal.com/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.
\nMandatory parameters in request body:
\nNote:
If you want to use token_reference for doing a card transaction, please have a look at Network Tokenisation Section.
Essential parameters in request body:
\n**
Other optional parameters in request body:**
Successful Response
\nIf all the details are correct you'll get a 202 response with staus as Pending
\n{\n \"status\": \"pending\",\n \"callback_url\": \"https://api.paystreamportal.com/payment/63bd0bf80fb42a076e8a4dd1/\",\n \"method\": \"GET\"\n}\n\nIf the response code is 202, after receiving the response body, direct the customer to the callback_url provided in the response.
\nErrors
\nIf there are any errors then it'll be in the format of :
\n{\n \"message\": \"descriptive error message\",\n \"code\": \"error_code\"\n}\n\nPlease see the Status Code section for further details.
\n","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"705e1da1-f74e-4951-99e2-77c545ad8a63","id":"705e1da1-f74e-4951-99e2-77c545ad8a63","name":"APIs","type":"folder"}},"urlObject":{"path":["p","64bff4fff63e36669499e9c8",""],"host":["https://api.paystreamportal.com/api/v1"],"query":[{"key":"s2s","value":"true"}],"variable":[]}},"response":[{"id":"474962a2-43d0-4b56-a851-8cc11cc3c195","name":"Success","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer {{APIKey}}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"cardholder_name\": \"dk\",\r\n \"card_number\": \"411111111111111\",\r\n \"expires\": \"10/23\",\r\n \"cvc\": \"345\",\r\n \"remember_card\": \"on\",\r\n \"remote_ip\": \"203.0.113.121\",\r\n \"user_agent\": \"Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/51.0.2704.103 Safari/537.36\",\r\n \"accept_header\": \"text/html\",\r\n \"language\": \"en-US\",\r\n \"java_enabled\": false,\r\n \"javascript_enabled\": true,\r\n \"color_depth\": 24,\r\n \"utc_offset\": 0,\r\n \"screen_width\": 1920,\r\n \"screen_height\": 1080\r\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://api.paystreamportal.com/api/v1/p/64bff4fff63e36669499e9c8/?s2s=true","host":["https://api.paystreamportal.com/api/v1"],"path":["p","64bff4fff63e36669499e9c8",""],"query":[{"key":"s2s","value":"true"}]}},"status":"Accepted","code":202,"_postman_previewlanguage":"json","header":[{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"Cache-Control","value":"no-cache, no-store, max-age=0, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Expires","value":"0"},{"key":"X-Frame-Options","value":"DENY"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Date","value":"Thu, 13 Jul 2023 17:31:55 GMT"},{"key":"Keep-Alive","value":"timeout=60"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"pending\",\n \"callback_url\": \"https://api.paystreamportal.com/api/v1/payment/64b034ecc6dccf7d329d9eb3/\",\n \"method\": \"GET\"\n}"},{"id":"f8ad389f-6ac3-45e1-9543-d321746e630e","name":"Failure","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer {{APIKey}}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"cardholder_name\": \"dk\",\r\n \"card_number\": \"4111111111111111\",\r\n \"expires\": \"10/23\",\r\n \"cvc\": \"345\",\r\n \"remember_card\": \"on\",\r\n \"remote_ip\": \"203.0.113.121\",\r\n \"user_agent\": \"Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/51.0.2704.103 Safari/537.36\",\r\n \"accept_header\": \"text/html\",\r\n \"language\": \"en-US\",\r\n \"java_enabled\": false,\r\n \"javascript_enabled\": true,\r\n \"color_depth\": 24,\r\n \"utc_offset\": 0,\r\n \"screen_width\": 1920,\r\n \"screen_height\": 1080\r\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://api.paystreamportal.com/api/v1/p/64bff4fff63e36669499e9c8/?s2s=true","host":["https://api.paystreamportal.com/api/v1"],"path":["p","64bff4fff63e36669499e9c8",""],"query":[{"key":"s2s","value":"true"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"Text","header":[{"key":"Date","value":"Tue, 06 Jan 2026 05:57:10 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Nel","value":"{\"report_to\":\"cf-nel\",\"success_fraction\":0.0,\"max_age\":604800}"},{"key":"X-Frame-Options","value":"ALLOW-FROM *"},{"key":"Referrer-Policy","value":"no-referrer"},{"key":"x-session-id","value":"cc434220-0bcd-42c7-9078-53503b81a221"},{"key":"Vary","value":"Origin"},{"key":"Vary","value":"Access-Control-Request-Method"},{"key":"Vary","value":"Access-Control-Request-Headers"},{"key":"Server","value":"cloudflare"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"0"},{"key":"Cache-Control","value":"no-cache, no-store, max-age=0, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Expires","value":"0"},{"key":"Strict-Transport-Security","value":"max-age=31536000 ; includeSubDomains"},{"key":"X-Cache","value":"Error from cloudfront"},{"key":"Via","value":"1.1 9bce423254194c16408d5cf7234126e2.cloudfront.net (CloudFront)"},{"key":"X-Amz-Cf-Pop","value":"IAD61-P10"},{"key":"X-Amz-Cf-Id","value":"FgTt6KEGIk0CH79DQDOvB1tYb1pGfaz0ryIVmQ0CCpDShyhsJGuAkA=="},{"key":"cf-cache-status","value":"DYNAMIC"},{"key":"Report-To","value":"{\"group\":\"cf-nel\",\"max_age\":604800,\"endpoints\":[{\"url\":\"https://a.nel.cloudflare.com/report/v4?s=9SnHJOEjnd1y7hArGsRLWmrk8H9ExaiR%2Fc%2BQMWhAvHlNPYCNEjS60wTjIyODXpca0ZD9%2BalkhLJ63boMGg%2B8iI6eFtXfW%2BxwGaBP1p1ZcwpA\"}]}"},{"key":"CF-RAY","value":"9b98f9f4684505e7-IAD"},{"key":"alt-svc","value":"h3=\":443\"; ma=86400"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Authorization header missing\",\n \"code\": \"authentication_failed\"\n}"}],"_postman_id":"185dd3ab-180b-4a7e-b38a-0fcd4a90b666"},{"name":"Capture","id":"83f7f671-cc99-480b-a773-d36eab58a0ab","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer {{APIKey}}"}],"body":{"mode":"raw","raw":"{\n \"merchant_reference\": \"64534345\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.paystreamportal.com/api/v1/purchases/69cd26b053d7b783ebf6b6e9/capture","description":"After a successful pre-authorisation, use this endpoint to capture (settle) the held funds. You may capture the full authorised amount or a partial amount.
\n","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"705e1da1-f74e-4951-99e2-77c545ad8a63","id":"705e1da1-f74e-4951-99e2-77c545ad8a63","name":"APIs","type":"folder"}},"urlObject":{"path":["purchases","69cd26b053d7b783ebf6b6e9","capture"],"host":["https://api.paystreamportal.com/api/v1"],"query":[],"variable":[]}},"response":[{"id":"39f9c933-269a-45ad-82f9-addbaeca52a3","name":"Capture","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer {{APIKey}}"}],"body":{"mode":"raw","raw":"{\n \"merchant_reference\": \"64534345\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.paystreamportal.com/api/v1/purchases/69cd26b053d7b783ebf6b6e9/capture"},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[{"key":"Date","value":"Wed, 01 Apr 2026 17:16:51 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Nel","value":"{\"report_to\":\"cf-nel\",\"success_fraction\":0.0,\"max_age\":604800}"},{"key":"X-Frame-Options","value":"ALLOW-FROM *"},{"key":"Referrer-Policy","value":"no-referrer"},{"key":"x-session-id","value":"72818dba-381a-449a-8351-390453ddbf72"},{"key":"Vary","value":"Origin"},{"key":"Vary","value":"Access-Control-Request-Method"},{"key":"Vary","value":"Access-Control-Request-Headers"},{"key":"Server","value":"cloudflare"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"0"},{"key":"Cache-Control","value":"no-cache, no-store, max-age=0, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Expires","value":"0"},{"key":"Strict-Transport-Security","value":"max-age=31536000 ; includeSubDomains"},{"key":"X-Cache","value":"Error from cloudfront"},{"key":"Via","value":"1.1 3578d122de1401ebc52a7afd35dd5d0c.cloudfront.net (CloudFront)"},{"key":"X-Amz-Cf-Pop","value":"IAD61-P10"},{"key":"X-Amz-Cf-Id","value":"zEG99N28vChcugkKEe-mJxhNgum-PAK1lcn_2mKqagcBd5deWquIjw=="},{"key":"cf-cache-status","value":"DYNAMIC"},{"key":"Report-To","value":"{\"group\":\"cf-nel\",\"max_age\":604800,\"endpoints\":[{\"url\":\"https://a.nel.cloudflare.com/report/v4?s=EnQbeJo0VkBTF%2BqefkY%2BZ1OejkL%2BkIkR76eA5%2FtL3qaxYlOL1ehFjmSIpGl5i91OldfFB41NXeRXp3E43WxFSEhlUj7OgOqbI6eYZs%2B%2BcUBdewUDmvk46tJrDA5WO53Bib8q\"}]}"},{"key":"CF-RAY","value":"9e593e77fb953ec9-IAD"}],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\n \"purchaseId\": \"69cd361053d7b783ebf7324d\",\n \"client\": {\n \"customerId\": \"NA\",\n \"email\": \"user7694@example.com\",\n \"full_name\": \"Riley Haddad\",\n \"date_of_birth\": \"1800-01-01\",\n \"street_address\": \"123\",\n \"country\": \"ZM\",\n \"city\": \"Ashford\",\n \"zip_code\": \"234567\",\n \"cc\": [],\n \"bcc\": [],\n \"stateCode\": \"CA\"\n },\n \"updated_on\": 1775056447,\n \"type\": \"purchase\",\n \"paymentMethod\": \"MASTER,VISA,VIRTUAL-IBAN,CRYPTO-WALLET,MAYA,GCASH,QRPH,BANKTRANSFER,NETBANKING,UPI-QR,PAYPLAY,UPI-INTENT,MOBILEMONEY,GOOGLEPAY,APPLEPAY\",\n \"amountUnit\": \"MAJOR\",\n \"errorMsg\": \"\",\n \"errorCode\": \"NA\",\n \"force_recurring\": false,\n \"created_on\": 1775056400,\n \"extraParam\": {\n \"aft\": {\n \"account_owner_address1\": \"test\",\n \"account_owner_address2\": \"test\",\n \"account_owner_street\": \"test\",\n \"account_owner_postal_code\": \"123\",\n \"account_owner_city\": \"test\",\n \"account_owner_country\": \"UK\",\n \"merchant_postal_code\": \"123\",\n \"merchant_state\": \"FRA\",\n \"acceptor_legal_name\": \"test\",\n \"sender_address\": \"test\",\n \"sender_city\": \"test\",\n \"sender_state\": \"RJ\",\n \"sender_country\": \"FRA\",\n \"sender_name\": \"test\",\n \"sender_account_number\": \"test\",\n \"recipient_name\": \"test\",\n \"bai\": \"AA\"\n }\n },\n \"merchantRef\": \"69cd361053d7b783ebf7324d\",\n \"purchase\": {\n \"currency\": \"EUR\",\n \"products\": [\n {\n \"name\": \"gaming cards\",\n \"quantity\": 1.0,\n \"price\": 10.0,\n \"discount\": 0,\n \"tax_percent\": \"0.00\"\n }\n ],\n \"total\": 10.0,\n \"requestAmount\": 10.0,\n \"language\": \"en\",\n \"notes\": \"\",\n \"debt\": 0,\n \"total_formatted\": 1.0,\n \"taxAmount\": 0.0,\n \"taxPercent\": 0.0,\n \"request_client_details\": [],\n \"email_message\": \"\"\n },\n \"payment\": {\n \"is_outgoing\": false,\n \"payment_type\": \"PURCHASE\",\n \"amount\": 10.0,\n \"currency\": \"EUR\",\n \"net_amount\": 10.0,\n \"fee_amount\": 0.0,\n \"pending_amount\": 0.0,\n \"pending_unfreeze_on\": null,\n \"description\": \"\",\n \"paid_on\": 1775056410,\n \"remote_paid_on\": 1775056410\n },\n \"issuer_details\": {\n \"website\": \"\",\n \"legal_street_address\": \"\",\n \"legal_country\": \"\",\n \"legal_city\": \"\",\n \"legal_zip_code\": \"\",\n \"bank_accounts\": [\n {}\n ],\n \"legal_name\": \"ECOMTEST1\",\n \"brand_name\": \"ECOMTEST1\",\n \"registration_number\": \"\",\n \"tax_number\": \"\"\n },\n \"transaction_data\": {\n \"payment_method\": \"\",\n \"flow\": \"payform\",\n \"extra\": {\n \"expiry_month\": \"12\",\n \"amount\": 10.0,\n \"card_issuer\": \"ING BELGIUM, S.A.\",\n \"masked_pan\": \"46401701****6658\",\n \"card_brand\": \"VISA\",\n \"card_issuer_country\": \"BE\",\n \"card_type\": \"CREDIT\",\n \"cardholder_name\": \"Emerson Okafor\",\n \"expiry_year\": \"28\"\n },\n \"country\": \"\",\n \"attempts\": [\n {\n \"client_ip\": \"203.0.113.234\",\n \"type\": \"execute\",\n \"payment_method\": \"VISA\",\n \"flow\": \"payform\",\n \"successful\": true,\n \"country\": \"BE\",\n \"processing_time\": 1775056410,\n \"extra\": {\n \"expiry_month\": \"12\",\n \"amount\": 10.0,\n \"card_issuer\": \"ING BELGIUM, S.A.\",\n \"masked_pan\": \"46401701****6658\",\n \"card_brand\": \"VISA\",\n \"card_issuer_country\": \"BE\",\n \"card_type\": \"CREDIT\",\n \"cardholder_name\": \"Emerson Okafor\",\n \"expiry_year\": \"28\"\n }\n }\n ]\n },\n \"status\": \"PAID\",\n \"status_history\": [\n {\n \"status\": \"created\",\n \"timestamp\": 1775056400\n },\n {\n \"status\": \"pending_execute\",\n \"timestamp\": 1775056410\n },\n {\n \"status\": \"payment_in_process\",\n \"timestamp\": 1775056410\n },\n {\n \"status\": \"3DS success\",\n \"timestamp\": 1775056424\n },\n {\n \"status\": \"preauthorized\",\n \"timestamp\": 1775056428\n },\n {\n \"status\": \"capture_in_process\",\n \"timestamp\": 1775056447\n },\n {\n \"status\": \"paid\",\n \"timestamp\": 1775056447\n }\n ],\n \"is_test\": false,\n \"brand_id\": \"your-brand-id\",\n \"send_receipt\": false,\n \"is_recurring_token\": false,\n \"skip_capture\": true,\n \"reference_generated\": \"PS1673\",\n \"issued\": \"2026-04-01\",\n \"due\": 1775056400,\n \"refund_upto\": 1776089649,\n \"cc_descriptor\": \"\",\n \"fraudScore\": \"NA\",\n \"trustScore\": \"NA\",\n \"extraFee\": \"0\",\n \"pix_payload\": {},\n \"payInDetails\": {},\n \"paidOn\": 1775056449,\n \"receivedAmt\": 0.0,\n \"captureTxns\": [\n {\n \"captureId\": \"41e31f9f-1e98-4f4d-b48c-7d1ed488fc3f\",\n \"purchaseId\": \"69cd361053d7b783ebf7324d\",\n \"amount\": 10.0,\n \"fxAmount\": 10.0,\n \"status\": \"PAID\",\n \"pspReference\": null,\n \"merchantReference\": \"64534345\",\n \"createdAt\": 1775056447,\n \"updatedAt\": 1775056447,\n \"whiteId\": 0,\n \"fxCurrency\": \"EUR\",\n \"bankMid\": \"payneticsexternal3ds\",\n \"isTest\": false,\n \"currency\": \"EUR\",\n \"amountInUsd\": 11.85,\n \"merchantName\": \"KailashMerchant\",\n \"bankName\": \"paynatics-aft_\",\n \"bankId\": \"532\",\n \"trxMethod\": \"CARDS\",\n \"rollingReserve\": 0.0,\n \"transFees\": 0.0,\n \"mdr\": 0.0,\n \"isSettlementPending\": 0,\n \"parentId\": 0,\n \"transSettlementId\": null,\n \"errorSettlementId\": null,\n \"merchantId\": \"589\"\n }\n ],\n \"taxAmount\": 0.0,\n \"surcharge\": 0.0,\n \"surchargeType\": \"\",\n \"sessionId\": \"\",\n \"refund_availability\": \"NONE\",\n \"refundable_amount\": 10.0,\n \"success_redirect\": \"https://your.success.redirect.com\",\n \"failure_redirect\": \"https://your.failure.redirect.com\",\n \"cancel_redirect\": \"\",\n \"success_callback\": \"https://your.success.callback.com\",\n \"failure_callback\": \"https://your.failure.callback.com\",\n \"platform\": \"API\",\n \"created_from_ip\": \"203.0.113.234\",\n \"checkout_url\": \"https://api.paystreamportal.com/payments/47395a8217d29014a4af6b1c494ac06b/\",\n \"direct_post_url\": \"https://api.paystreamportal.com/api/v1/p/69cd361053d7b783ebf7324d/\",\n \"payoutProcess\": false\n}"}],"_postman_id":"83f7f671-cc99-480b-a773-d36eab58a0ab"},{"name":"Cancel","id":"420d0a8e-8adf-4270-8340-ba2928268a86","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{APIKey}}"}],"url":"https://api.paystreamportal.com/api/v1/purchases/69ca76dbace4fa4413db928c/cancel","description":"Use this endpoint to cancel an authorised payment before it has been captured. Voiding releases the held funds back to the customer immediately.
\n","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"705e1da1-f74e-4951-99e2-77c545ad8a63","id":"705e1da1-f74e-4951-99e2-77c545ad8a63","name":"APIs","type":"folder"}},"urlObject":{"path":["purchases","69ca76dbace4fa4413db928c","cancel"],"host":["https://api.paystreamportal.com/api/v1"],"query":[],"variable":[]}},"response":[{"id":"feba9f8d-3bf0-4879-adf5-45f1d9b08ac0","name":"Cancel","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{APIKey}}"}],"url":"https://api.paystreamportal.com/api/v1/purchases/69ca76dbace4fa4413db928c/cancel"},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[{"key":"Date","value":"Wed, 01 Apr 2026 17:18:25 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Nel","value":"{\"report_to\":\"cf-nel\",\"success_fraction\":0.0,\"max_age\":604800}"},{"key":"X-Frame-Options","value":"ALLOW-FROM *"},{"key":"Referrer-Policy","value":"no-referrer"},{"key":"x-session-id","value":"1c9b7d67-8dec-4e71-b35b-7952f23b67ed"},{"key":"Vary","value":"Origin"},{"key":"Vary","value":"Access-Control-Request-Method"},{"key":"Vary","value":"Access-Control-Request-Headers"},{"key":"Server","value":"cloudflare"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"0"},{"key":"Cache-Control","value":"no-cache, no-store, max-age=0, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Expires","value":"0"},{"key":"Strict-Transport-Security","value":"max-age=31536000 ; includeSubDomains"},{"key":"X-Cache","value":"Error from cloudfront"},{"key":"Via","value":"1.1 8bd3b44b8e417f2b75cd6e631907112a.cloudfront.net (CloudFront)"},{"key":"X-Amz-Cf-Pop","value":"IAD61-P10"},{"key":"X-Amz-Cf-Id","value":"WSuVRaHm9E64itnjsFWAyBSPCR8YOFpZr7jY-NAhT-Ae-3_bc-hNTw=="},{"key":"cf-cache-status","value":"DYNAMIC"},{"key":"Report-To","value":"{\"group\":\"cf-nel\",\"max_age\":604800,\"endpoints\":[{\"url\":\"https://a.nel.cloudflare.com/report/v4?s=%2FOrvZsMz3WoHOQDEvKgGSADamNtnaGrILftqtr5BiqYIlUvgXZT89lPPwyXtpIDJW8BNOXjG%2FgAQmYnOUsUpQZ%2BDIVJsSDsxo4FxOEgIKcxPYcG21xgzcTNpNqbnk%2Fnw%2FEki\"}]}"},{"key":"CF-RAY","value":"9e5940bd580a07ed-IAD"}],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\n \"purchaseId\": \"69cd36c353d7b783ebf743e9\",\n \"client\": {\n \"customerId\": \"NA\",\n \"email\": \"user7694@example.com\",\n \"full_name\": \"Riley Haddad\",\n \"date_of_birth\": \"1800-01-01\",\n \"street_address\": \"123\",\n \"country\": \"ZM\",\n \"city\": \"Ashford\",\n \"zip_code\": \"234567\",\n \"cc\": [],\n \"bcc\": [],\n \"stateCode\": \"CA\"\n },\n \"updated_on\": 1775056649,\n \"type\": \"purchase\",\n \"paymentMethod\": \"MASTER,VISA,VIRTUAL-IBAN,CRYPTO-WALLET,MAYA,GCASH,QRPH,BANKTRANSFER,NETBANKING,UPI-QR,PAYPLAY,UPI-INTENT,MOBILEMONEY,GOOGLEPAY,APPLEPAY\",\n \"amountUnit\": \"MAJOR\",\n \"errorMsg\": \"\",\n \"errorCode\": \"NA\",\n \"force_recurring\": false,\n \"created_on\": 1775056579,\n \"extraParam\": {\n \"aft\": {\n \"account_owner_address1\": \"test\",\n \"account_owner_address2\": \"test\",\n \"account_owner_street\": \"test\",\n \"account_owner_postal_code\": \"123\",\n \"account_owner_city\": \"test\",\n \"account_owner_country\": \"UK\",\n \"merchant_postal_code\": \"123\",\n \"merchant_state\": \"FRA\",\n \"acceptor_legal_name\": \"test\",\n \"sender_address\": \"test\",\n \"sender_city\": \"test\",\n \"sender_state\": \"RJ\",\n \"sender_country\": \"FRA\",\n \"sender_name\": \"test\",\n \"sender_account_number\": \"test\",\n \"recipient_name\": \"test\",\n \"bai\": \"AA\"\n }\n },\n \"merchantRef\": \"69cd36c353d7b783ebf743e9\",\n \"purchase\": {\n \"currency\": \"EUR\",\n \"products\": [\n {\n \"name\": \"gaming cards\",\n \"quantity\": 1.0,\n \"price\": 10.0,\n \"discount\": 0,\n \"tax_percent\": \"0.00\"\n }\n ],\n \"total\": 10.0,\n \"requestAmount\": 10.0,\n \"language\": \"en\",\n \"notes\": \"\",\n \"debt\": 0,\n \"total_formatted\": 1.0,\n \"taxAmount\": 0.0,\n \"taxPercent\": 0.0,\n \"request_client_details\": [],\n \"email_message\": \"\"\n },\n \"payment\": {\n \"is_outgoing\": false,\n \"payment_type\": \"PURCHASE\",\n \"amount\": 10.0,\n \"currency\": \"EUR\",\n \"net_amount\": 10.0,\n \"fee_amount\": 0.0,\n \"pending_amount\": 0.0,\n \"pending_unfreeze_on\": null,\n \"description\": \"\",\n \"paid_on\": 1775056600,\n \"remote_paid_on\": 1775056600\n },\n \"issuer_details\": {\n \"website\": \"\",\n \"legal_street_address\": \"\",\n \"legal_country\": \"\",\n \"legal_city\": \"\",\n \"legal_zip_code\": \"\",\n \"bank_accounts\": [\n {}\n ],\n \"legal_name\": \"ECOMTEST1\",\n \"brand_name\": \"ECOMTEST1\",\n \"registration_number\": \"\",\n \"tax_number\": \"\"\n },\n \"transaction_data\": {\n \"payment_method\": \"\",\n \"flow\": \"payform\",\n \"extra\": {\n \"expiry_month\": \"12\",\n \"amount\": 10.0,\n \"card_issuer\": \"JPMORGAN CHASE BANK, N.A.\",\n \"masked_pan\": \"42000000****0000\",\n \"card_brand\": \"VISA\",\n \"card_issuer_country\": \"US\",\n \"card_type\": \"CREDIT\",\n \"cardholder_name\": \"Emerson Okafor\",\n \"expiry_year\": \"28\"\n },\n \"country\": \"\",\n \"attempts\": [\n {\n \"client_ip\": \"203.0.113.234\",\n \"type\": \"execute\",\n \"payment_method\": \"VISA\",\n \"flow\": \"payform\",\n \"successful\": true,\n \"country\": \"US\",\n \"processing_time\": 1775056600,\n \"extra\": {\n \"expiry_month\": \"12\",\n \"amount\": 10.0,\n \"card_issuer\": \"JPMORGAN CHASE BANK, N.A.\",\n \"masked_pan\": \"42000000****0000\",\n \"card_brand\": \"VISA\",\n \"card_issuer_country\": \"US\",\n \"card_type\": \"CREDIT\",\n \"cardholder_name\": \"Emerson Okafor\",\n \"expiry_year\": \"28\"\n }\n }\n ]\n },\n \"status\": \"CANCELLED\",\n \"status_history\": [\n {\n \"status\": \"created\",\n \"timestamp\": 1775056579\n },\n {\n \"status\": \"pending_execute\",\n \"timestamp\": 1775056600\n },\n {\n \"status\": \"payment_in_process\",\n \"timestamp\": 1775056600\n },\n {\n \"status\": \"3DS success\",\n \"timestamp\": 1775056607\n },\n {\n \"status\": \"preauthorized\",\n \"timestamp\": 1775056611\n },\n {\n \"status\": \"void_in_process\",\n \"timestamp\": 1775056632\n },\n {\n \"status\": \"preauthorized\",\n \"timestamp\": 1775056632\n },\n {\n \"status\": \"void_in_process\",\n \"timestamp\": 1775056647\n },\n {\n \"status\": \"cancelled\",\n \"timestamp\": 1775056649\n }\n ],\n \"is_test\": false,\n \"brand_id\": \"your-brand-id\",\n \"send_receipt\": false,\n \"is_recurring_token\": false,\n \"skip_capture\": true,\n \"reference_generated\": \"PS1675\",\n \"issued\": \"2026-04-01\",\n \"due\": 1775056579,\n \"refund_upto\": 1776089849,\n \"cc_descriptor\": \"\",\n \"fraudScore\": \"NA\",\n \"trustScore\": \"NA\",\n \"extraFee\": \"0\",\n \"pix_payload\": {},\n \"payInDetails\": {},\n \"paidOn\": 0,\n \"receivedAmt\": 0.0,\n \"taxAmount\": 0.0,\n \"surcharge\": 0.0,\n \"surchargeType\": \"\",\n \"sessionId\": \"\",\n \"refund_availability\": \"NONE\",\n \"refundable_amount\": 10.0,\n \"success_redirect\": \"https://your.success.redirect.com\",\n \"failure_redirect\": \"https://your.failure.redirect.com\",\n \"cancel_redirect\": \"\",\n \"success_callback\": \"https://your.success.callback.com\",\n \"failure_callback\": \"https://your.failure.callback.com\",\n \"platform\": \"API\",\n \"created_from_ip\": \"203.0.113.234\",\n \"checkout_url\": \"https://api.paystreamportal.com/payments/23182fc42998cb02b4a3e6aa5c3e26c8/\",\n \"direct_post_url\": \"https://api.paystreamportal.com/api/v1/p/69cd36c353d7b783ebf743e9/\",\n \"payoutProcess\": false\n}"}],"_postman_id":"420d0a8e-8adf-4270-8340-ba2928268a86"}],"id":"705e1da1-f74e-4951-99e2-77c545ad8a63","auth":{"type":"noauth","isInherited":false},"event":[{"listen":"prerequest","script":{"type":"text/javascript","packages":{},"requests":{},"exec":[""],"id":"a73356ff-facb-49bd-a6f6-e55acd35874b"}},{"listen":"test","script":{"type":"text/javascript","packages":{},"requests":{},"exec":[""],"id":"7fc671bd-2a25-4c03-a4c3-c0a2c6f0ca88"}}],"_postman_id":"705e1da1-f74e-4951-99e2-77c545ad8a63","description":""},{"name":"Transaction Status Lifecycle","item":[],"id":"e8850581-db44-4759-937d-8eead910960e","description":"Every payment processed through the pre-authorisation flow passes through a series of statuses. Understanding these statuses is critical for building robust integrations.
\n","_postman_id":"e8850581-db44-4759-937d-8eead910960e"},{"name":"Best Practices","item":[],"id":"ef501540-b8e0-4e60-aeb7-6d14101f32d8","description":"Capture Timing
\nCapture payments as soon as the goods are shipped or the service is delivered. The longer you wait, the higher the risk of authorisation expiry, customer disputes, and declined captures.
\nIdempotency
\nAlways include the X-Idempotency-Key header for all write operations (authorise, capture, void). This protects against duplicate transactions caused by network timeouts or retries.
\nWebhook-Driven Architecture
\nDo not rely solely on synchronous API responses for business logic. Implement webhook handlers to receive real-time status updates and use them as the source of truth for transaction state in your system.
\nError Handling
\nImplement retry logic with exponential backoff for 5xx errors and 429 (rate limit) responses. For 4xx errors, parse the error response body and handle each error code appropriately in your application logic.
\nPCI Compliance
\nIf you are handling raw card numbers, you must be PCI DSS Level 1 certified. Paystream strongly recommends using tokenised payment methods to minimise your PCI scope. Use the Paystream Cashier or client-side SDK to tokenise card details before they reach your server.
\nReconciliation
\nUse the reference field on authorise, capture, and void requests to associate Paystream transactions with your internal order system. The balances object in every response provides a real-time breakdown for reconciliation.
\n3D Secure
\nEnable 3DS for all pre-authorisation requests where supported. This shifts fraud liability to the card issuer and reduces chargebacks. Paystream supports 3DS 2.x with frictionless and challenge flows.
\n","auth":{"type":"noauth","isInherited":false},"event":[{"listen":"prerequest","script":{"type":"text/javascript","packages":{},"requests":{},"exec":[""],"id":"4a23550e-16f6-46c2-8902-f690adfbab5b"}},{"listen":"test","script":{"type":"text/javascript","packages":{},"requests":{},"exec":[""],"id":"b363632e-21a2-48bc-a473-a3a0f7aaddc7"}}],"_postman_id":"ef501540-b8e0-4e60-aeb7-6d14101f32d8"},{"name":"Frequently Asked Questions","item":[],"id":"377d1500-8a78-4f7e-8bdf-3bc3f0aae27e","description":"Q: Can I capture more than the authorised amount?
\nA: No. The capture amount must be less than or equal to the authorised amount. If you need to charge more, you must create a new authorisation for the additional amount.
\nQ: Can I perform multiple partial captures on a single authorisation?
\nA: Yes. Paystream supports multiple captures per authorisation. But you will need to contact the support team for enabling the same.
\nQ: What happens if I do not capture before the authorisation expires?
\nA: The authorisation automatically expires and the held funds are released back to the customer. You will receive a payment.expired webhook event. You must create a new authorisation to charge the customer.
\nQ: Can I void a payment after it has been captured?
\nA: No. Once a payment is captured, you must use the Refund API to return funds. The void endpoint only works for payments in AUTHORISED status.
\nQ: How long does a void take to reflect on the customer’s statement?
\nA: Typically, the hold is removed within 1–3 business days, depending on the issuing bank. Some banks may take up to 7 days to release the hold.
\nQ: Does the customer see the pre-authorisation on their statement?
\nA: Yes. The customer will see a pending charge for the authorised amount. This pending charge is released upon void or expiry, or replaced by the final charge upon capture.
\nQ: Can I use pre-authorisation with non-card payment methods?
\nA: Pre-authorisation is primarily supported for card payments. Support for alternative payment methods varies. Check the Paystream payment methods documentation for details.
\nQ: Is 3D Secure required for pre-authorisations?
\nA: 3DS is not required but is strongly recommended. It reduces fraud liability and chargeback risk. Paystream supports 3DS on all card pre-authorisation requests.
\n","_postman_id":"377d1500-8a78-4f7e-8bdf-3bc3f0aae27e"}],"id":"142fa7bc-2364-47af-99a4-31b32fedbb98","description":"Overview
\nPre-authorisation (also known as \"auth only\") is a two-step payment process where a merchant first reserves (holds) funds on a customer’s payment method without immediately capturing the amount. This allows the merchant to verify fund availability before fulfilling an order, then capture (settle) the payment at a later time — or void (cancel) the hold if the order is not fulfilled.
\nWhen to Use Pre-Authorisation
\nPre-authorisation is ideal for scenarios where the final transaction amount may change, or where goods/services are not delivered immediately. Common use cases include:
\nKey Concepts
\n","_postman_id":"142fa7bc-2364-47af-99a4-31b32fedbb98"},{"name":"Get Balance API (V2)","item":[{"name":"Checking Balance","id":"8ecbd249-d183-4a62-adb5-bf4f7faee0ec","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{APIKey}}","type":"text"}],"body":{"mode":"raw","raw":"{ \r\n \"paymentMethod\" : \"PAYOUT-INTERAC-ETRANSFER\"\r\n\r\n}\r\n","options":{"raw":{"language":"json"}}},"url":"https://api.paystreamportal.com/api/v1/getBalance","description":"API for checking available balance
\n- \n
URL :- /getBalance/
\n \nRequestType: POST
\n \nRequest Body
\n \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","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"0d5fc0bf-1971-4735-8a39-01427810b0a9","id":"0d5fc0bf-1971-4735-8a39-01427810b0a9","name":"Get Balance API (V2)","type":"folder"}},"urlObject":{"path":["getBalance"],"host":["https://api.paystreamportal.com/api/v1"],"query":[],"variable":[]}},"response":[{"id":"74dd1e73-de51-450b-a8e7-0605d57c3754","name":"Checking Balance payout-success","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{ \r\n \"paymentMethod\" : \"PAYOUT-INTERAC-ETRANSFER\"\r\n}\r\n","options":{"raw":{"language":"json"}}},"url":"https://api.paystreamportal.com/api/v1/getBalance"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"paymentMethod\": \"PAYOUT-INTERAC-ETRANSFER\",\n \"status\": \"success\",\n \"gateways\": [\n {\n \"gatewayName\": \"payhost\",\n \"status\": \"success\",\n \"error\": null,\n \"balances\": [\n {\n \"currency\": \"CAD\",\n \"balance\": 808.380000\n },\n {\n \"currency\": \"USD\",\n \"balance\": 803.380000\n }\n ]\n },\n {\n \"gatewayName\": \"samplepaypg\",\n \"status\": \"success\",\n \"error\": null,\n \"balances\": [\n {\n \"currency\": \"CAD\",\n \"balance\": 808.380000\n },\n {\n \"currency\": \"USD\",\n \"balance\": 808.380000\n }\n ]\n }\n ],\n \"aggregatedBalances\": [\n {\n \"currency\": \"CAD\",\n \"balance\": 1616.760000\n },\n {\n \"currency\": \"USD\",\n \"balance\": 1611.760000\n }\n ]\n}"},{"id":"5f7dfa76-28ca-4985-a5b9-120050d296bd","name":"Checking Balance partial-success","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{ \r\n \"paymentMethod\" : \"CARDS\"\r\n}\r\n","options":{"raw":{"language":"json"}}},"url":"https://api.paystreamportal.com/api/v1/getBalance"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"paymentMethod\": \"CARDS\",\n \"status\": \"partial\",\n \"gateways\": [\n {\n \"gatewayName\": \"a55Mandate\",\n \"status\": \"failed\",\n \"error\": {\n \"code\": \"error\",\n \"message\": \"Bank does not provide balance\"\n },\n \"balances\": []\n },\n {\n \"gatewayName\": \"bk_sbx_smilepayz_pix_payin\",\n \"status\": \"success\",\n \"error\": null,\n \"balances\": [\n {\n \"currency\": \"IDR\",\n \"balance\": 250000.000000\n }\n ]\n },\n {\n \"gatewayName\": \"samplepay_pg\",\n \"status\": \"success\",\n \"error\": null,\n \"balances\": [\n {\n \"currency\": \"AED\",\n \"balance\": 0.000000\n },\n {\n \"currency\": \"AUD\",\n \"balance\": 3412.000000\n },\n {\n \"currency\": \"BRL\",\n \"balance\": 100.089996\n },\n {\n \"currency\": \"BTC\",\n \"balance\": 0.000000\n },\n {\n \"currency\": \"BXC\",\n \"balance\": 0.000000\n },\n {\n \"currency\": \"CAD\",\n \"balance\": 1000.000000\n },\n {\n \"currency\": \"CDF\",\n \"balance\": 0.000000\n },\n {\n \"currency\": \"COP\",\n \"balance\": 0.000000\n },\n {\n \"currency\": \"DKK\",\n \"balance\": 0.000000\n },\n {\n \"currency\": \"EGP\",\n \"balance\": 0.000000\n },\n {\n \"currency\": \"ETH\",\n \"balance\": 0.000000\n },\n {\n \"currency\": \"EUR\",\n \"balance\": 0.000000\n },\n {\n \"currency\": \"GBP\",\n \"balance\": -24.327801\n },\n {\n \"currency\": \"GHS\",\n \"balance\": 0.000000\n },\n {\n \"currency\": \"IDR\",\n \"balance\": 1000.000000\n },\n {\n \"currency\": \"INR\",\n \"balance\": 0.000000\n },\n {\n \"currency\": \"JPY\",\n \"balance\": 0.000000\n },\n {\n \"currency\": \"KES\",\n \"balance\": 0.000000\n },\n {\n \"currency\": \"MWK\",\n \"balance\": 0.000000\n },\n {\n \"currency\": \"MXN\",\n \"balance\": -4.770000\n },\n {\n \"currency\": \"NGN\",\n \"balance\": 0.000000\n },\n {\n \"currency\": \"NZD\",\n \"balance\": 0.000000\n },\n {\n \"currency\": \"RWF\",\n \"balance\": 0.000000\n },\n {\n \"currency\": \"THB\",\n \"balance\": 0.000000\n },\n {\n \"currency\": \"TZS\",\n \"balance\": 0.000000\n },\n {\n \"currency\": \"UGX\",\n \"balance\": 0.000000\n },\n {\n \"currency\": \"USD\",\n \"balance\": 167.457992\n },\n {\n \"currency\": \"USDC\",\n \"balance\": 0.000000\n },\n {\n \"currency\": \"USDT\",\n \"balance\": 0.000000\n },\n {\n \"currency\": \"UZS\",\n \"balance\": 0.000000\n },\n {\n \"currency\": \"XAF\",\n \"balance\": 0.000000\n },\n {\n \"currency\": \"XOF\",\n \"balance\": 0.000000\n },\n {\n \"currency\": \"ZAR\",\n \"balance\": 120.000000\n },\n {\n \"currency\": \"ZMW\",\n \"balance\": 0.000000\n }\n ]\n },\n {\n \"gatewayName\": \"payhost\",\n \"status\": \"failed\",\n \"error\": {\n \"code\": \"error\",\n \"message\": \"Bank does not provide balance\"\n },\n \"balances\": []\n }\n ],\n \"aggregatedBalances\": [\n {\n \"currency\": \"AED\",\n \"balance\": 0.000000\n },\n {\n \"currency\": \"AUD\",\n \"balance\": 3412.000000\n },\n {\n \"currency\": \"BRL\",\n \"balance\": 100.089996\n },\n {\n \"currency\": \"BTC\",\n \"balance\": 0.000000\n },\n {\n \"currency\": \"BXC\",\n \"balance\": 0.000000\n },\n {\n \"currency\": \"CAD\",\n \"balance\": 1000.000000\n },\n {\n \"currency\": \"CDF\",\n \"balance\": 0.000000\n },\n {\n \"currency\": \"COP\",\n \"balance\": 0.000000\n },\n {\n \"currency\": \"DKK\",\n \"balance\": 0.000000\n },\n {\n \"currency\": \"EGP\",\n \"balance\": 0.000000\n },\n {\n \"currency\": \"ETH\",\n \"balance\": 0.000000\n },\n {\n \"currency\": \"EUR\",\n \"balance\": 0.000000\n },\n {\n \"currency\": \"GBP\",\n \"balance\": -24.327801\n },\n {\n \"currency\": \"GHS\",\n \"balance\": 0.000000\n },\n {\n \"currency\": \"IDR\",\n \"balance\": 251000.000000\n },\n {\n \"currency\": \"INR\",\n \"balance\": 0.000000\n },\n {\n \"currency\": \"JPY\",\n \"balance\": 0.000000\n },\n {\n \"currency\": \"KES\",\n \"balance\": 0.000000\n },\n {\n \"currency\": \"MWK\",\n \"balance\": 0.000000\n },\n {\n \"currency\": \"MXN\",\n \"balance\": -4.770000\n },\n {\n \"currency\": \"NGN\",\n \"balance\": 0.000000\n },\n {\n \"currency\": \"NZD\",\n \"balance\": 0.000000\n },\n {\n \"currency\": \"RWF\",\n \"balance\": 0.000000\n },\n {\n \"currency\": \"THB\",\n \"balance\": 0.000000\n },\n {\n \"currency\": \"TZS\",\n \"balance\": 0.000000\n },\n {\n \"currency\": \"UGX\",\n \"balance\": 0.000000\n },\n {\n \"currency\": \"USD\",\n \"balance\": 167.457992\n },\n {\n \"currency\": \"USDC\",\n \"balance\": 0.000000\n },\n {\n \"currency\": \"USDT\",\n \"balance\": 0.000000\n },\n {\n \"currency\": \"UZS\",\n \"balance\": 0.000000\n },\n {\n \"currency\": \"XAF\",\n \"balance\": 0.000000\n },\n {\n \"currency\": \"XOF\",\n \"balance\": 0.000000\n },\n {\n \"currency\": \"ZAR\",\n \"balance\": 120.000000\n },\n {\n \"currency\": \"ZMW\",\n \"balance\": 0.000000\n }\n ]\n}"},{"id":"705073bf-3a7d-4965-a8eb-41f0fb5c714b","name":"Checking Balance payout-error","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{ \r\n \"paymentMethod\" : \"PAYOUT-INTERAC\"\r\n}\r\n","options":{"raw":{"language":"json"}}},"url":"https://api.paystreamportal.com/api/v1/getBalance"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"paymentMethod\": \"PAYOUT-INTERAC\",\n \"status\": \"failed\",\n \"gateways\": [\n {\n \"gatewayName\": \"payhost\",\n \"status\": \"failed\",\n \"error\": {\n \"code\": \"error\",\n \"message\": \"Bank does not provide balance\"\n },\n \"balances\": []\n }\n ],\n \"aggregatedBalances\": []\n}"}],"_postman_id":"8ecbd249-d183-4a62-adb5-bf4f7faee0ec"}],"id":"0d5fc0bf-1971-4735-8a39-01427810b0a9","description":"The Get Balance API (V2) provides orchestrator-level visibility into available balances across multiple payment methods and banking partners. This version enhances the existing balance API by aggregating and returning balance details for all supported payment methods associated with all the PSPs for the merchant
\nOverview
\n- \n
Purpose: Retrieve available balance information across different banks/payment methods.
\n \nScope: Orchestrator-level (not limited to a single merchant or payment method).
\n \nEnhancement over previous version:
\n- \n
Returns balances for all payment methods linked to the orchestrator.
\n \nProvides both consolidated and MID-level (Merchant ID) breakdowns.
\n \n
\n
Request Parameters
\nBehavior
\n- \n
When a valid paymentMethod is provided, the API retrieves:
\n- \n
Balance details across all associated banks/payment methods.
\n \nMID-level breakdown for each bank.
\n \nConsolidated balance per payment method.
\n \n
\nThe API is designed specifically for orchestrators and returns aggregated data across multiple merchants and banking integrations.
\n \n
Success Response
\nOn successful retrieval, the API returns:
\n- \n
Payment Method Details
\n \nList of Banks / Payment Providers
\n \nMID-Level Breakdown
\n \nConsolidated Balance
\n \n
Partial Success Response
\nA Partial Success response is returned when balance information is retrieved successfully for some payment methods or banks, while one or more fail to return balance data.
\nThis scenario typically occurs when:
\n- \n
A merchant is associated with multiple payment methods or banking partners, and
\n \nAt least one provider returns a valid balance, while others fail due to unavailability, timeout, or missing data.
\n \n
Return values-
\n- \n
Status as \"Partial\"
\n \nPayment Method Details
\n \nList of Banks / Payment Providers
\n \nMID-Level Breakdown
\n \nConsolidated Balance
\n \n
Error Handling
\nIf balance details are not found or the request cannot be processed, the API returns:
\n- \n
Appropriate status code
\n \nError message
\n \n
Overview
\nManual review is a control step for payouts (money going out to your customers or beneficiaries). When a payout is created it may be held in the pending_review status instead of being sent straight to the payout processor. This happens when the payout is flagged — for example by a risk rule, an amount threshold, or a merchant-profile setting.
While a payout is in pending_review, no funds move. It stays parked until someone with a valid API key approves it (release the funds) or rejects it (cancel it). The Payout Action API is how you perform that decision from your own systems.
When a payout is in manual review
\nA payout can only be actioned while its status is pending_review. You can check a payout's current status with the Get Status call in the PayOut API section. If the status is anything other than pending_review, the action call is blocked (see Idempotency below).
The action call
\nBoth approve and reject use the same endpoint; the decision is set by the action query parameter:
- \n
POST https://api.paystreamportal.com/api/v1/payouts/{payout_id}/action?action=approve\nPOST https://api.paystreamportal.com/api/v1/payouts/{payout_id}/action?action=reject\n
On approve, Paystream releases the payout and its status moves to paid. On reject, the payout is cancelled, its status moves to error, and the rejection reason is stored against the payout.
Idempotency — a payout can only be actioned once
\nA payout can be approved or rejected exactly once. If you call the action endpoint on a payout that is no longer in pending_review (because it was already actioned, or was never in review), the call is rejected and the payout is left unchanged:
{\n \"status\": \"error\",\n \"data\": {\n \"payout_id\": \"69d4a15b7c7e1d98769872eb\",\n \"current_status\": \"paid\",\n \"message\": \"Payout already processed\"\n }\n}\nUse data.current_status to see where the payout actually is, and do not retry — the outcome will not change.
Status transitions
\nPayout status values
\nWho is recorded as the reviewer (reviewed_by)
\nEvery successful action records who made the decision. Paystream sets reviewed_by using this priority:
- \n
- If you send a non-empty
reviewed_byin the request body, that value is used. \n - Otherwise, Paystream falls back to the username tied to the API key you authenticated with. \n
Use the override when the human decision-maker is different from the API service account (for example finance_manager_john or risk_team_admin), so your audit trail stays accurate.
How remarks behaves
\nOn approve — remarks is optional. If you send it, it is echoed back in the response; if you omit it, no remarks field appears in the response and nothing is stored.
On reject — remarks is optional but strongly recommended. It is stored as the payout's error message for your audit trail. If you omit it (or send an empty string) it defaults to \"Rejected\". Always send a clear, specific reason.
Authentication & authorisation
\nAuthenticate with your merchant API key as a Bearer token:
\nAuthorization: Bearer {{APIKey}}
For an action to succeed:
\n- \n
- The API key must be valid and live (not a test key). \n
- The payout must belong to the merchant that owns the API key. A payout belonging to another merchant is treated as not found. \n
- Your account must have live transactions enabled. \n
- The payout must be in
pending_reviewstatus. \n
Your API key can be located in the Dashboard section of your merchant account login.
A note on HTTP status codes
\nThis endpoint always returns HTTP 200 OK. The real outcome is carried in the JSON body, not the HTTP status line:
- \n
- Success responses have
\"status\": \"success\"and adataobject with the action result. \n - Business / validation failures (e.g. already processed, insufficient balance) have
\"status\": \"error\"and adata.message. \n - Authentication, malformed-JSON, and not-found errors use a simpler legacy shape:
{\"message\": \"...\"}. \n
Always branch on the JSON body (the status field, then data.message) rather than the HTTP status code.
Testing in Sandbox
\nThe sandbox base URL is https://test2.paymentsclub.net/api/v1 (production is https://api.paystreamportal.com/api/v1 = https://api.paystreamportal.com/api/v1). To test the flow end to end you need a payout sitting in pending_review. If your sandbox does not let you force a payout into manual review, contact your Account Manager for test payouts and credentials.
Approves a payout that is currently in pending_review. On success, Paystream releases the payout to the processor and the status moves to paid.
Call this endpoint once you have verified the payout should be paid. It is idempotent — a payout that has already been actioned cannot be approved again (see Concepts → Idempotency).
\nPath & Query Parameters
\nRequest Body Parameters
\nThe body is optional for approve — send {} to approve with no notes.
Response
\nA successful approval returns status: \"success\" and a data object containing the payout id, the status before and after the action (previous_status = pending_review, current_status = paid), the action performed, the reviewer, and a UTC ISO-8601 reviewed_at timestamp. remarks is included only if you supplied it.
See Concepts → A note on HTTP status codes for how errors are represented (this endpoint always returns HTTP 200).
\n","urlObject":{"path":["payouts","{payout_id}","action"],"host":["https://api.paystreamportal.com/api/v1"],"query":[{"key":"action","value":"approve"}],"variable":[]}},"response":[{"id":"24a9ab29-1cbf-4177-ba5f-e3ed0b5ec662","name":"Success","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer {{APIKey}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"remarks\": \"Verified against invoice #4821\",\n \"reviewed_by\": \"compliance_team_lead\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://api.paystreamportal.com/api/v1/payouts/{payout_id}/action?action=approve","host":["https://api.paystreamportal.com/api/v1"],"path":["payouts","{payout_id}","action"],"query":[{"key":"action","value":"approve"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"success\",\n \"data\": {\n \"payout_id\": \"69d4a15b7c7e1d98769872eb\",\n \"previous_status\": \"pending_review\",\n \"current_status\": \"paid\",\n \"action_performed\": \"approve\",\n \"reviewed_by\": \"compliance_team_lead\",\n \"reviewed_at\": \"2026-04-16T10:30:45Z\",\n \"remarks\": \"Verified against invoice #4821\"\n }\n}"},{"id":"955359fc-5a0d-433d-9f37-9768cb2c8d92","name":"Error (Already processed)","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer {{APIKey}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"remarks\": \"Verified against invoice #4821\",\n \"reviewed_by\": \"compliance_team_lead\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://api.paystreamportal.com/api/v1/payouts/{payout_id}/action?action=approve","host":["https://api.paystreamportal.com/api/v1"],"path":["payouts","{payout_id}","action"],"query":[{"key":"action","value":"approve"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"error\",\n \"data\": {\n \"payout_id\": \"69d4a15b7c7e1d98769872eb\",\n \"current_status\": \"paid\",\n \"message\": \"Payout already processed\"\n }\n}"},{"id":"af39ae31-cc82-4a64-977f-751aaaee1d1c","name":"Error (Insufficient balance)","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer {{APIKey}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"remarks\": \"Verified against invoice #4821\",\n \"reviewed_by\": \"compliance_team_lead\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://api.paystreamportal.com/api/v1/payouts/{payout_id}/action?action=approve","host":["https://api.paystreamportal.com/api/v1"],"path":["payouts","{payout_id}","action"],"query":[{"key":"action","value":"approve"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"error\",\n \"data\": {\n \"payout_id\": \"69d4a15b7c7e1d98769872eb\",\n \"message\": \"Insufficient Balance [250.00]\"\n }\n}"},{"id":"227531f3-332c-406a-a7bb-db5013b3303c","name":"Approve - Error (Payout not found)","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer {{APIKey}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"remarks\": \"Verified against invoice #4821\",\n \"reviewed_by\": \"compliance_team_lead\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://api.paystreamportal.com/api/v1/payouts/{payout_id}/action?action=approve","host":["https://api.paystreamportal.com/api/v1"],"path":["payouts","{payout_id}","action"],"query":[{"key":"action","value":"approve"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Payout Id Not Found :- 69d4a15b7c7e1d98769872eb\"\n}"},{"id":"61a43ab9-1a89-4eac-b0bf-5d4bed3f49e6","name":"Approve - Error (Unauthorized)","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer {{APIKey}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"remarks\": \"Verified against invoice #4821\",\n \"reviewed_by\": \"compliance_team_lead\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://api.paystreamportal.com/api/v1/payouts/{payout_id}/action?action=approve","host":["https://api.paystreamportal.com/api/v1"],"path":["payouts","{payout_id}","action"],"query":[{"key":"action","value":"approve"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Unauthorized\"\n}"}],"_postman_id":"e7c01f5b-4aae-4353-aeff-e589a6b3c026"},{"name":"Reject Payout","id":"cfa87b3f-0f3f-4bff-9f09-76376ca9703f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer {{APIKey}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"remarks\": \"Failed KYC verification\",\n \"reviewed_by\": \"risk_team_admin\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.paystreamportal.com/api/v1/payouts/{payout_id}/action?action=reject","description":"Rejects a payout that is currently in pending_review. On success, the payout is cancelled and its status moves to error; the rejection reason is stored against the payout as its error message.
It is idempotent — a payout that has already been actioned cannot be rejected again (see Concepts → Idempotency).
\nPath & Query Parameters
\nRequest Body Parameters
\nResponse
\nA successful rejection returns status: \"success\" with previous_status = pending_review and current_status = error. remarks is always included in the response for reject (defaulting to \"Rejected\" if you did not send one).
See Concepts → A note on HTTP status codes for how errors are represented (this endpoint always returns HTTP 200).
\n","urlObject":{"path":["payouts","{payout_id}","action"],"host":["https://api.paystreamportal.com/api/v1"],"query":[{"key":"action","value":"reject"}],"variable":[]}},"response":[{"id":"6e48f0d6-e80f-4027-8fb7-d075eff95c40","name":"Success","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer {{APIKey}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"remarks\": \"Failed KYC verification\",\n \"reviewed_by\": \"risk_team_admin\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://api.paystreamportal.com/api/v1/payouts/{payout_id}/action?action=reject","host":["https://api.paystreamportal.com/api/v1"],"path":["payouts","{payout_id}","action"],"query":[{"key":"action","value":"reject"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"success\",\n \"data\": {\n \"payout_id\": \"69ce44f1b2dd73d0d148c7d5\",\n \"previous_status\": \"pending_review\",\n \"current_status\": \"error\",\n \"action_performed\": \"reject\",\n \"reviewed_by\": \"risk_team_admin\",\n \"reviewed_at\": \"2026-04-16T10:31:20Z\",\n \"remarks\": \"Failed KYC verification\"\n }\n}"},{"id":"78664271-a236-4876-9790-437baf286aad","name":"Success (Default remarks)","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer {{APIKey}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"remarks\": \"Failed KYC verification\",\n \"reviewed_by\": \"risk_team_admin\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://api.paystreamportal.com/api/v1/payouts/{payout_id}/action?action=reject","host":["https://api.paystreamportal.com/api/v1"],"path":["payouts","{payout_id}","action"],"query":[{"key":"action","value":"reject"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"success\",\n \"data\": {\n \"payout_id\": \"69ce44f1b2dd73d0d148c7d5\",\n \"previous_status\": \"pending_review\",\n \"current_status\": \"error\",\n \"action_performed\": \"reject\",\n \"reviewed_by\": \"merchant_user_123\",\n \"reviewed_at\": \"2026-04-16T10:31:20Z\",\n \"remarks\": \"Rejected\"\n }\n}"},{"id":"fe710329-32f5-4905-befe-901ecbe638d3","name":"Error (Already processed)","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer {{APIKey}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"remarks\": \"Failed KYC verification\",\n \"reviewed_by\": \"risk_team_admin\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://api.paystreamportal.com/api/v1/payouts/{payout_id}/action?action=reject","host":["https://api.paystreamportal.com/api/v1"],"path":["payouts","{payout_id}","action"],"query":[{"key":"action","value":"reject"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"error\",\n \"data\": {\n \"payout_id\": \"69ce44f1b2dd73d0d148c7d5\",\n \"current_status\": \"error\",\n \"message\": \"Payout already processed\"\n }\n}"},{"id":"2a4a0656-483d-40f1-9d3b-7d8fb3352267","name":"Error (Unauthorized)","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer {{APIKey}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"remarks\": \"Failed KYC verification\",\n \"reviewed_by\": \"risk_team_admin\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://api.paystreamportal.com/api/v1/payouts/{payout_id}/action?action=reject","host":["https://api.paystreamportal.com/api/v1"],"path":["payouts","{payout_id}","action"],"query":[{"key":"action","value":"reject"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Unauthorized\"\n}"}],"_postman_id":"cfa87b3f-0f3f-4bff-9f09-76376ca9703f"}],"id":"85a22f14-fc1b-4be7-938f-37f493366468","description":"Some payouts are held for manual review before Paystream releases the funds — typically when a payout is flagged by a risk rule or exceeds an auto-approval threshold. These payouts sit in the pending_review status until an authorised reviewer approves or rejects them.
The Payout Action API lets you approve or reject a payout in manual review programmatically, so you can build the review step into your own back-office, risk, or compliance tooling instead of relying on the Paystream dashboard.
\nA partial refund allows merchants to refund a portion of a successfully paid purchase.
Multiple partial refunds can be performed until the total refunded amount equals the original purchase amount.
Prerequisites
\n- \n
The purchase must be in paid status.
\n \nThe refund amount must be greater than 0.
\n \nThe refund amount must not exceed the remaining refundable amount.
\n \nRefunds are processed in the same currency as the original purchase.
\n \n
Refund Scenarios
\nPartial Refund
\nPurchase Amount: 10
\nRefund Amount: 8
\nResult:
\n- \n
Refunded Amount: 8
\n \nRemaining Refundable Amount: 2
\n \nTransaction Status: PARTIALLY_REFUNDED
\n \n
Full Refund Using Partial Refund API
\nPurchase Amount: 10
\nRefund Amount: 10
\nResult:
\n- \n
Refunded Amount: 10
\n \nRemaining Refundable Amount: 0
\n \nTransaction Status: PARTIAL REFUNDED
\n \n
Multiple Partial Refunds
\nPurchase Amount: 10
\n- \n
Refund #1: 3
\n \nRefund #2: 2
\n \nRefund #3: 5
\n \n
Result:
\n- \n
Total Refunded Amount: 10
\n \nRemaining Refundable Amount: 0
\n \n
Final Transaction Status: PARTIAL REFUNDED
\n","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"13bff97c-d055-49e1-ae64-132b53078fbd","id":"13bff97c-d055-49e1-ae64-132b53078fbd","name":"API","type":"folder"}},"urlObject":{"path":["purchases","purchaseid","refund"],"host":["https://api.paystreamportal.com/api/v1"],"query":[],"variable":[]}},"response":[{"id":"2c22f7b6-089e-47d6-8d05-ca9ce5d24a5a","name":"Success","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{APIKey}}"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"*/*"}],"body":{"mode":"raw","raw":"{\n \"amount\": \"5.12\",\n \"reason\": \"Partial Refunds Testing\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.paystreamportal.com/api/v1/purchases/purchaseid/refund"},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[{"key":"Date","value":"Fri, 05 Jun 2026 08:59:38 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Nel","value":"{\"report_to\":\"cf-nel\",\"success_fraction\":0.0,\"max_age\":604800}"},{"key":"X-Frame-Options","value":"ALLOW-FROM *"},{"key":"Referrer-Policy","value":"no-referrer"},{"key":"x-session-id","value":"7aec019b-8a08-4e3d-a158-b092f8c8f998"},{"key":"Vary","value":"Origin"},{"key":"Vary","value":"Access-Control-Request-Method"},{"key":"Vary","value":"Access-Control-Request-Headers"},{"key":"Server","value":"cloudflare"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"0"},{"key":"Cache-Control","value":"no-cache, no-store, max-age=0, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Expires","value":"0"},{"key":"Strict-Transport-Security","value":"max-age=31536000 ; includeSubDomains"},{"key":"X-Cache","value":"Error from cloudfront"},{"key":"Via","value":"1.1 2af44885a7fc4faf5a3444e606d6c02c.cloudfront.net (CloudFront)"},{"key":"X-Amz-Cf-Pop","value":"IAD61-P10"},{"key":"X-Amz-Cf-Id","value":"rWo0eMrwpvBts9xS0P4ftqKaridLKfm2xH9Y5H2CF3k6R1LxgTFMZQ=="},{"key":"cf-cache-status","value":"DYNAMIC"},{"key":"Report-To","value":"{\"group\":\"cf-nel\",\"max_age\":604800,\"endpoints\":[{\"url\":\"https://a.nel.cloudflare.com/report/v4?s=IFwED2Y1XrzWhlXDeYjRi0o%2BPWMlBxaVhLXiHVdLbjLb1oaWhC9H%2BdjTxbu3jV8o0RDcmxT%2BvN3omG1bscFcmMeqERUAG%2BooUZMEJ%2BrFdLVe7yaObwbg963WTVC8cyx7dfvT\"}]}"},{"key":"CF-RAY","value":"a06dfb7c4ed3c995-IAD"}],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\n \"refundId\": \"refundid\",\n \"purchaseId\": \"purchaseid\",\n \"amount\": 5.12,\n \"createdOn\": 1780637310,\n \"refundOn\": 0,\n \"status\": \"REFUND_IN_PROCESS\",\n \"reason\": \"Partial Refunds Testing\",\n \"currency\": \"USD\"\n}"},{"id":"bd1d99f5-2ff2-4be5-8bca-4344d0af0e17","name":"Refund Amt Exceeds Purchase Amt","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{APIKey}}"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"*/*"}],"body":{"mode":"raw","raw":"{\n \"amount\": \"11\", // Purchase Amount: 10\n \"reason\": \"Partial Refunds Testing\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.paystreamportal.com/api/v1/purchases/purchaseid/refund"},"status":"Bad Request","code":400,"_postman_previewlanguage":"Text","header":[{"key":"Date","value":"Fri, 05 Jun 2026 09:03:16 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Nel","value":"{\"report_to\":\"cf-nel\",\"success_fraction\":0.0,\"max_age\":604800}"},{"key":"X-Frame-Options","value":"ALLOW-FROM *"},{"key":"Referrer-Policy","value":"no-referrer"},{"key":"x-session-id","value":"9f888ccb-1238-4e02-b6dc-764560604b14"},{"key":"Vary","value":"Origin"},{"key":"Vary","value":"Access-Control-Request-Method"},{"key":"Vary","value":"Access-Control-Request-Headers"},{"key":"Server","value":"cloudflare"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"0"},{"key":"Cache-Control","value":"no-cache, no-store, max-age=0, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Expires","value":"0"},{"key":"Strict-Transport-Security","value":"max-age=31536000 ; includeSubDomains"},{"key":"X-Cache","value":"Error from cloudfront"},{"key":"Via","value":"1.1 acbc1e922360be31edf0371abdc7a3a4.cloudfront.net (CloudFront)"},{"key":"X-Amz-Cf-Pop","value":"EWR53-P1"},{"key":"X-Amz-Cf-Id","value":"u0f10ZilZAVELaSZM0QkCGivhENfvhb491tRfbtZBfNmilJhavDeeA=="},{"key":"cf-cache-status","value":"DYNAMIC"},{"key":"Report-To","value":"{\"group\":\"cf-nel\",\"max_age\":604800,\"endpoints\":[{\"url\":\"https://a.nel.cloudflare.com/report/v4?s=G0WYUY8ZL0X6%2BdnZTxN8KgKkvqqBezW18wEdyF5wktbOdTwbgtdIp9wsRiNbSp250CnbNX1q74X0cENF8dT3V5P8gbQ2kw%2BW1%2FWf9LNh1aVj8tHeCAfooAi0il9zhZGaj7z4\"}]}"},{"key":"CF-RAY","value":"a06e00cefac89c79-IAD"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Refund amount exceeds refundable amount\",\n \"code\": \"validation_error\"\n}"},{"id":"b50f16f6-d611-4e87-84f2-2bc4204e8cea","name":"Refund Amt Is 0 or -ve","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{APIKey}}"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"*/*"}],"body":{"mode":"raw","raw":"{\n \"amount\": \"-5.12\",\n \"reason\": \"Partial Refunds Testing\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.paystreamportal.com/api/v1/purchases/purchaseid/refund"},"status":"Bad Request","code":400,"_postman_previewlanguage":"Text","header":[{"key":"Date","value":"Fri, 05 Jun 2026 09:04:29 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Nel","value":"{\"report_to\":\"cf-nel\",\"success_fraction\":0.0,\"max_age\":604800}"},{"key":"X-Frame-Options","value":"ALLOW-FROM *"},{"key":"Referrer-Policy","value":"no-referrer"},{"key":"x-session-id","value":"2e380b48-7668-448d-af95-980482c35c8f"},{"key":"Vary","value":"Origin"},{"key":"Vary","value":"Access-Control-Request-Method"},{"key":"Vary","value":"Access-Control-Request-Headers"},{"key":"Server","value":"cloudflare"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"0"},{"key":"Cache-Control","value":"no-cache, no-store, max-age=0, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Expires","value":"0"},{"key":"Strict-Transport-Security","value":"max-age=31536000 ; includeSubDomains"},{"key":"X-Cache","value":"Error from cloudfront"},{"key":"Via","value":"1.1 3578d122de1401ebc52a7afd35dd5d0c.cloudfront.net (CloudFront)"},{"key":"X-Amz-Cf-Pop","value":"IAD61-P10"},{"key":"X-Amz-Cf-Id","value":"B705OGUJpsFVyyUtTS_xidVoz9_kniiAFlHKn0_sL6R6oOQ9BMHZFA=="},{"key":"cf-cache-status","value":"DYNAMIC"},{"key":"Report-To","value":"{\"group\":\"cf-nel\",\"max_age\":604800,\"endpoints\":[{\"url\":\"https://a.nel.cloudflare.com/report/v4?s=Wd5pKM%2B%2BBY35cSdYdYOJesaPTVX3KJ1M%2Bd68og7dF7hMaOL00aU4Xm3A7Ab%2BKitUSfwtu5owy8TVmxjQ%2BRNaOp1w2WiatUO7z%2Bayx4TPFfNzLk2eAlmERpeO%2F5Dy18l6%2F4H1\"}]}"},{"key":"CF-RAY","value":"a06e02977d392431-IAD"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Refund amount must be greater than 0\",\n \"code\": \"validation_error\"\n}"},{"id":"847d79fc-7b71-42e5-be78-9f4f35985cff","name":"Empty Refund Amt","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{APIKey}}"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"*/*"}],"body":{"mode":"raw","raw":"{\n \"reason\": \"Partial Refunds Testing\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.paystreamportal.com/api/v1/purchases/purchaseid/refund"},"status":"Bad Request","code":400,"_postman_previewlanguage":"Text","header":[{"key":"Date","value":"Fri, 05 Jun 2026 09:05:38 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Nel","value":"{\"report_to\":\"cf-nel\",\"success_fraction\":0.0,\"max_age\":604800}"},{"key":"X-Frame-Options","value":"ALLOW-FROM *"},{"key":"Referrer-Policy","value":"no-referrer"},{"key":"x-session-id","value":"5573f74e-1147-4a84-ad79-08260f6c229d"},{"key":"Vary","value":"Origin"},{"key":"Vary","value":"Access-Control-Request-Method"},{"key":"Vary","value":"Access-Control-Request-Headers"},{"key":"Server","value":"cloudflare"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"0"},{"key":"Cache-Control","value":"no-cache, no-store, max-age=0, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Expires","value":"0"},{"key":"Strict-Transport-Security","value":"max-age=31536000 ; includeSubDomains"},{"key":"X-Cache","value":"Error from cloudfront"},{"key":"Via","value":"1.1 70e9f6c79b570a07593d98d3c3eb2fc6.cloudfront.net (CloudFront)"},{"key":"X-Amz-Cf-Pop","value":"IAD61-P10"},{"key":"X-Amz-Cf-Id","value":"XhGSCeKH6brQ_0b2TQ7RfvwMzYyCp3-qSQ4N2rErhuolIMcxqQB3tw=="},{"key":"cf-cache-status","value":"DYNAMIC"},{"key":"Report-To","value":"{\"group\":\"cf-nel\",\"max_age\":604800,\"endpoints\":[{\"url\":\"https://a.nel.cloudflare.com/report/v4?s=X2YEtc%2F6jCxDP78BlzJBFZfi11NZuirslkboc3hUZCfp1XYpHRAdPv8X3hzhFfHJHJPCjCOZrphGL%2FkrohE%2FC6yvIPVC8Tn7G1%2B0Km7nQ16umqQe%2BdDFT%2BkMIkIKPRqdaErn\"}]}"},{"key":"CF-RAY","value":"a06e0449a9f91de9-IAD"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Amount is required\",\n \"code\": \"validation_error\"\n}"},{"id":"348b99d0-a789-4647-82d3-203a5996f85c","name":"Invalid Purchase ID","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{APIKey}}"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"*/*"}],"body":{"mode":"raw","raw":"{\n \"amount\": \"5.12\",\n \"reason\": \"Partial Refunds Testing\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.paystreamportal.com/api/v1/purchases/purchaseid/refund"},"status":"Bad Request","code":400,"_postman_previewlanguage":"Text","header":[{"key":"Date","value":"Fri, 05 Jun 2026 09:06:14 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Nel","value":"{\"report_to\":\"cf-nel\",\"success_fraction\":0.0,\"max_age\":604800}"},{"key":"X-Frame-Options","value":"ALLOW-FROM *"},{"key":"Referrer-Policy","value":"no-referrer"},{"key":"x-session-id","value":"193bc177-e65b-4f27-8e3d-a1c3242b44c0"},{"key":"Vary","value":"Origin"},{"key":"Vary","value":"Access-Control-Request-Method"},{"key":"Vary","value":"Access-Control-Request-Headers"},{"key":"Server","value":"cloudflare"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"0"},{"key":"Cache-Control","value":"no-cache, no-store, max-age=0, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Expires","value":"0"},{"key":"Strict-Transport-Security","value":"max-age=31536000 ; includeSubDomains"},{"key":"X-Cache","value":"Error from cloudfront"},{"key":"Via","value":"1.1 347540535e60ba585992da68b62d1ae8.cloudfront.net (CloudFront)"},{"key":"X-Amz-Cf-Pop","value":"SIN2-P6"},{"key":"X-Amz-Cf-Id","value":"nQfeXU4EOHhf5w662MDpgndsZOJ2Lv5MJudzq5Ks9OK3S8zPhDXpRw=="},{"key":"cf-cache-status","value":"DYNAMIC"},{"key":"Report-To","value":"{\"group\":\"cf-nel\",\"max_age\":604800,\"endpoints\":[{\"url\":\"https://a.nel.cloudflare.com/report/v4?s=kzHplT3Ggl%2Fu0lxeqmQOcBQxukHE9gO%2F7R0wyfqoD4IiGWSbD1mmaIha7sf9GSp8o%2FJHy9NV8RMdynlScuqpoZI%2FuKo1OF%2F5j96iBu7iEdqO%2Fx9nKqKfAPDFaka%2FR7kfDqRQ\"}]}"},{"key":"CF-RAY","value":"a06e05207bbe52d6-IAD"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Transaction not found\",\n \"code\": \"transaction_error\"\n}"},{"id":"0cacde34-d31c-4852-8197-57d7899a465d","name":"Refund on Failed or Pending Transactions","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{APIKey}}"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"*/*"}],"body":{"mode":"raw","raw":"{\n \"amount\": \"5.12\",\n \"reason\": \"Partial Refunds Testing\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.paystreamportal.com/api/v1/purchases/purchaseid/refund"},"status":"Bad Request","code":400,"_postman_previewlanguage":"Text","header":[{"key":"Date","value":"Fri, 05 Jun 2026 09:06:38 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Nel","value":"{\"report_to\":\"cf-nel\",\"success_fraction\":0.0,\"max_age\":604800}"},{"key":"X-Frame-Options","value":"ALLOW-FROM *"},{"key":"Referrer-Policy","value":"no-referrer"},{"key":"x-session-id","value":"6a7e4072-0cb1-41a9-9669-afc26d71050d"},{"key":"Vary","value":"Origin"},{"key":"Vary","value":"Access-Control-Request-Method"},{"key":"Vary","value":"Access-Control-Request-Headers"},{"key":"Server","value":"cloudflare"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"0"},{"key":"Cache-Control","value":"no-cache, no-store, max-age=0, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Expires","value":"0"},{"key":"Strict-Transport-Security","value":"max-age=31536000 ; includeSubDomains"},{"key":"X-Cache","value":"Error from cloudfront"},{"key":"Via","value":"1.1 a863373015dd073e91a52d99d8ad6bfc.cloudfront.net (CloudFront)"},{"key":"X-Amz-Cf-Pop","value":"IAD61-P10"},{"key":"X-Amz-Cf-Id","value":"KIIfqqaMKmLQqAQbuawRHDuPpcu4EnErL0aeEgFHGYY-FdmMISHmgg=="},{"key":"cf-cache-status","value":"DYNAMIC"},{"key":"Report-To","value":"{\"group\":\"cf-nel\",\"max_age\":604800,\"endpoints\":[{\"url\":\"https://a.nel.cloudflare.com/report/v4?s=8hGQxlHaR2s3QJOa7YijWckCFTcGSeOoU555kG9iM743FjcOdN2Q8IUlKe1015LzlbfPT0b6ZJT0eiE2mmp09iUU%2F%2BCQPt8qnEeD6PJkMkWpn45xqNeHO20Wl8PjbJuI0XZV\"}]}"},{"key":"CF-RAY","value":"a06e05ba9e43c975-IAD"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Only Purchases with `status == (paid)` can be refunded.\",\n \"code\": \"transaction_error\"\n}"},{"id":"87fa0c84-f18e-4c47-8c22-e5f15ef3f41b","name":"Refund on an Already Refunded Purchase","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{APIKey}}"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"*/*"}],"body":{"mode":"raw","raw":"{\n \"amount\": \"5.12\",\n \"reason\": \"Partial Refunds Testing\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.paystreamportal.com/api/v1/purchases/purchaseid/refund"},"status":"Bad Request","code":400,"_postman_previewlanguage":"Text","header":[{"key":"Date","value":"Fri, 05 Jun 2026 09:07:09 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Nel","value":"{\"report_to\":\"cf-nel\",\"success_fraction\":0.0,\"max_age\":604800}"},{"key":"X-Frame-Options","value":"ALLOW-FROM *"},{"key":"Referrer-Policy","value":"no-referrer"},{"key":"x-session-id","value":"560fb162-4210-4496-8249-26bf3393409e"},{"key":"Vary","value":"Origin"},{"key":"Vary","value":"Access-Control-Request-Method"},{"key":"Vary","value":"Access-Control-Request-Headers"},{"key":"Server","value":"cloudflare"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"0"},{"key":"Cache-Control","value":"no-cache, no-store, max-age=0, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Expires","value":"0"},{"key":"Strict-Transport-Security","value":"max-age=31536000 ; includeSubDomains"},{"key":"X-Cache","value":"Error from cloudfront"},{"key":"Via","value":"1.1 1a12f863197f986ec10d35ed76e104f0.cloudfront.net (CloudFront)"},{"key":"X-Amz-Cf-Pop","value":"IAD61-P10"},{"key":"X-Amz-Cf-Id","value":"tYQhkaUXrvj3OWc-rQiJp_FnzIBB3mubhjv7yn0w0TaAb6YzKH1Tww=="},{"key":"cf-cache-status","value":"DYNAMIC"},{"key":"Report-To","value":"{\"group\":\"cf-nel\",\"max_age\":604800,\"endpoints\":[{\"url\":\"https://a.nel.cloudflare.com/report/v4?s=SWrtdoBSkmhyNXsahHAdETrqPoOxh89DlcFUaF8D4DOftFPt0BtSVkjBR%2B7G8VbZfModmKZEwe1drtHOkeYMq9oz2PqsnSgYghGs%2Bi%2BqNA%2B4GZ6Z8mYI5BNCiuOJ5k%2FxY9HN\"}]}"},{"key":"CF-RAY","value":"a06e0680dc6724ad-IAD"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Purchase has already been fully refunded\",\n \"code\": \"transaction_error\"\n}"},{"id":"456e7db2-eefb-4787-a0bf-74e5804f85e7","name":"Refund Exceeds Remaining Balance After a Partial Refund","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{APIKey}}"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"*/*"}],"body":{"mode":"raw","raw":"{\n \"amount\": \"5.12\", // Remaining Refundable Amount is 2.0\n \"reason\": \"Partial Refunds Testing\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.paystreamportal.com/api/v1/purchases/purchaseid/refund"},"status":"Bad Request","code":400,"_postman_previewlanguage":"Text","header":[{"key":"Date","value":"Fri, 05 Jun 2026 09:09:03 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Nel","value":"{\"report_to\":\"cf-nel\",\"success_fraction\":0.0,\"max_age\":604800}"},{"key":"X-Frame-Options","value":"ALLOW-FROM *"},{"key":"Referrer-Policy","value":"no-referrer"},{"key":"x-session-id","value":"aced1038-4a60-45fb-a14b-f4cdc9ca63b4"},{"key":"Vary","value":"Origin"},{"key":"Vary","value":"Access-Control-Request-Method"},{"key":"Vary","value":"Access-Control-Request-Headers"},{"key":"Server","value":"cloudflare"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"0"},{"key":"Cache-Control","value":"no-cache, no-store, max-age=0, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Expires","value":"0"},{"key":"Strict-Transport-Security","value":"max-age=31536000 ; includeSubDomains"},{"key":"X-Cache","value":"Error from cloudfront"},{"key":"Via","value":"1.1 1a12f863197f986ec10d35ed76e104f0.cloudfront.net (CloudFront)"},{"key":"X-Amz-Cf-Pop","value":"IAD61-P10"},{"key":"X-Amz-Cf-Id","value":"ALmfTGjt9X7OliM6NeGzmkWzns9dzm9J5TnVUAV3egqzFolwOcidoA=="},{"key":"cf-cache-status","value":"DYNAMIC"},{"key":"Report-To","value":"{\"group\":\"cf-nel\",\"max_age\":604800,\"endpoints\":[{\"url\":\"https://a.nel.cloudflare.com/report/v4?s=UtL7zsQvnJ1BIIU8L%2FUyyQd4LiG%2BxMTEzuq%2B0zEM8dhVVZByPP5HkJW7urlk62Rzg%2BFG2Af9VAyMi4REGU5EPnIty%2BthzF4%2FojIE8%2FiFA0flLX5zu%2B4Kb3vJ4AoTU5mEyWf2\"}]}"},{"key":"CF-RAY","value":"a06e094ab9763210-IAD"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Refund amount exceeds refundable amount: 2.0\",\n \"code\": \"validation_error\"\n}"}],"_postman_id":"a1887cf6-70e0-472f-a510-80f9095a4748"},{"name":"Partial Refund Status API","id":"3a0f5450-2ed5-45ff-812b-4a7e760c18c2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{APIKey}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"refundId\": \"refundid\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.paystreamportal.com/api/v1/refundStatus/purchaseid/","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"13bff97c-d055-49e1-ae64-132b53078fbd","id":"13bff97c-d055-49e1-ae64-132b53078fbd","name":"API","type":"folder"}},"urlObject":{"path":["refundStatus","purchaseid",""],"host":["https://api.paystreamportal.com/api/v1"],"query":[],"variable":[]}},"response":[{"id":"658b1569-a8f2-4735-afb3-4481adf2c545","name":"Success","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{APIKey}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"refundId\": \"refundid\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.paystreamportal.com/api/v1/refundStatus/purchaseid/"},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[{"key":"Date","value":"Wed, 10 Jun 2026 15:09:28 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Nel","value":"{\"report_to\":\"cf-nel\",\"success_fraction\":0.0,\"max_age\":604800}"},{"key":"X-Frame-Options","value":"ALLOW-FROM *"},{"key":"Referrer-Policy","value":"no-referrer"},{"key":"x-session-id","value":"5be6468d-a804-478e-8e27-8fd83f43359b"},{"key":"Vary","value":"Origin"},{"key":"Vary","value":"Access-Control-Request-Method"},{"key":"Vary","value":"Access-Control-Request-Headers"},{"key":"Server","value":"cloudflare"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"0"},{"key":"Cache-Control","value":"no-cache, no-store, max-age=0, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Expires","value":"0"},{"key":"Strict-Transport-Security","value":"max-age=31536000 ; includeSubDomains"},{"key":"X-Cache","value":"Error from cloudfront"},{"key":"Via","value":"1.1 9d35ce6897d7f02042955443076a54de.cloudfront.net (CloudFront)"},{"key":"X-Amz-Cf-Pop","value":"EWR53-P1"},{"key":"X-Amz-Cf-Id","value":"Z2XLcFaGFRDj2ZuwTFJHQEaWWHB-I3MUtw5N2nMV7CNy55ImAEtfow=="},{"key":"cf-cache-status","value":"DYNAMIC"},{"key":"Report-To","value":"{\"group\":\"cf-nel\",\"max_age\":604800,\"endpoints\":[{\"url\":\"https://a.nel.cloudflare.com/report/v4?s=WE1Q25t02u566zmtnXqm%2F%2FBAsilvCpOzlMzs3i%2F3Py3%2BJO%2FnNNBSHDCXlW4OtMYjNBc6jOpCsAMj0plUVemEWy8KMy8TLLPi0Vrte%2BET6ZNPsDzZXkEqXiFkpjTFGyTde9HC\"}]}"},{"key":"CF-RAY","value":"a0994c1f8a41311a-IAD"}],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\n \"refundId\": \"refundid\",\n \"purchaseId\": \"purchaseid\",\n \"amount\": 3.0,\n \"createdOn\": 1780982811,\n \"refundOn\": 1780982814,\n \"status\": \"REFUNDED\",\n \"reason\": \"test\",\n \"currency\": \"USD\"\n}\n"}],"_postman_id":"3a0f5450-2ed5-45ff-812b-4a7e760c18c2"}],"id":"13bff97c-d055-49e1-ae64-132b53078fbd","auth":{"type":"noauth","isInherited":false},"event":[{"listen":"prerequest","script":{"type":"text/javascript","packages":{},"requests":{},"exec":[""],"id":"73c7102a-ab01-4a0f-b8dd-353d516ef54b"}},{"listen":"test","script":{"type":"text/javascript","packages":{},"requests":{},"exec":[""],"id":"dd5b3eaa-f071-4d86-815c-2adb1df1bc37"}}],"_postman_id":"13bff97c-d055-49e1-ae64-132b53078fbd","description":""}],"id":"cceaca49-af57-4507-9aec-dc1ed0ae3458","auth":{"type":"noauth","isInherited":false},"event":[{"listen":"prerequest","script":{"type":"text/javascript","packages":{},"requests":{},"exec":[""],"id":"36aeeadd-6483-46dc-8047-690c7b4515e1"}},{"listen":"test","script":{"type":"text/javascript","packages":{},"requests":{},"exec":[""],"id":"da69611c-c5ef-4dd4-b438-7d01b6c8bf51"}}],"_postman_id":"cceaca49-af57-4507-9aec-dc1ed0ae3458","description":""},{"name":"Test Cards","item":[{"name":"Concepts","item":[],"id":"d80d39f7-f3d4-4ef9-8804-72d72c5fb50a","description":"What these are
\nPaystream's sandbox accepts a fixed set of card numbers, each mapped to a predetermined outcome. Submitting one through the normal card flow produces that outcome every time, which lets you prove your integration handles success, decline, timeout, and pending paths without depending on a live issuer.
\nThe current set was introduced on 18 December 2025 and replaced an earlier, smaller set. The earlier cards no longer work.
\nEnabling sandbox
\n- \n
- In your merchant dashboard, toggle Is Sandbox on, in the top right under your merchant profile. \n
- Generate a sandbox API Key, Brand ID, and Public Key. \n
- Configure your webhook callback URL. \n
The API key is what selects the environment. The base URL does not change. See ⚙️ Integration Steps for the full onboarding sequence.
\n\n\n⚠️ Because the base URL is identical, a production key will send a real transaction to a real acquirer. Make sure a test suite cannot resolve a production key.
\n
Universal rules
\nThe outcome is determined entirely by the card number. Nothing else in the request changes it, which means the request you validate in sandbox is the request you send in production.
\nThe card flow
\nCard payments are a three-step flow, unchanged between sandbox and production:
\n- \n
- Step 1, create the purchase.
POST https://api.paystreamportal.com/api/v1/purchases/registers the transaction and returns apurchaseId. Status isCREATED. \n - Step 2, submit the card.
POST https://api.paystreamportal.com/api/v1/p/{purchaseId}/?s2s=truesends the card and device details from your server. A202response returns acallback_url. \n - Step 3, invoke the callback from the customer's browser. For a 3D Secure card the customer is taken to the issuer challenge; enter OTP
123456. For a 2D card the outcome is applied directly. The customer then lands onsuccess_redirect,pending_redirect, orfailure_redirect. \n
Poll GET https://api.paystreamportal.com/api/v1/purchases/{purchaseId}/ at any point, and expect a signed webhook on each status change. See 💳 Card Payments → Concepts for the full flow and 🔌 Webhooks for signature verification.
What a sandbox card result does and does not prove
\nIt proves:
\n- \n
- Your request is well formed and accepted by the
/purchasesand S2S contracts. \n - Your code handles the
202pluscallback_urlhandshake correctly. \n - Your code handles each terminal status and its
status_historytransitions. \n - Your 3DS redirect and return handling works, including the challenge screen. \n
- Your webhook listener is reachable and your RSA signature verification is correct. \n
- Your redirect handling is correct for all three outcome URLs. \n
It does not prove:
\n- \n
- That your acquirer or MID is live, configured, or correctly routed. The sandbox does not contact an acquirer. \n
- That real issuer behaviour matches. A real decline carries the issuer's own reason code, which may not match the sandbox message. \n
- That your 3DS configuration is production-ready. The sandbox challenge is not a real ACS. \n
- That real-world latency is handled. Sandbox outcomes are returned immediately. \n
- That settlement, reconciliation, or fee handling works. Nothing settles. \n
Coverage
\nEvery one of the eleven outcomes exists in four variants: Visa 2D, Visa 3DS, Mastercard 2D, and Mastercard 3DS. There are no gaps in that grid, so any outcome can be tested against either scheme in either authentication mode.
\n","_postman_id":"d80d39f7-f3d4-4ef9-8804-72d72c5fb50a"},{"name":"2D (Non-3DS) Test Cards","item":[],"id":"b798b117-c481-4f91-b8ea-aabb161680e1","description":"These cards complete without a 3D Secure challenge. The customer is not redirected to an issuer page; the outcome is applied and the customer goes straight to the final redirect URL.
\nUse any expiry at or after the current month, and any CVV.
\n","_postman_id":"b798b117-c481-4f91-b8ea-aabb161680e1"},{"name":"3D Secure Test Cards","item":[],"id":"4bd0f214-30e4-4d02-b4b5-57b2f8562cff","description":"These cards trigger a 3D Secure challenge. The customer is redirected to a simulated issuer authentication page after the callback_url is invoked.
OTP for every 3D Secure card is **123456****.
**
Use any expiry at or after the current month, and any CVV.
\nNote that the outcome is fixed by the card, not by the OTP. Entering the correct OTP on an Authentication failed card still produces a failure, which is the point: it lets you test a failed authentication without needing to enter a wrong OTP.
\n","_postman_id":"4bd0f214-30e4-4d02-b4b5-57b2f8562cff"},{"name":"Brand Coverage","item":[],"id":"c1b2308e-c09a-45d0-89a1-019cf9e81458","description":"What this means for you
\nIf you accept only Visa and Mastercard, the sandbox covers your full outcome matrix.
\nIf you accept any other scheme, that part of your integration cannot be tested in sandbox and must be validated with low-value live transactions. Scheme-specific behaviour worth planning live tests for includes different PAN lengths, four-digit CID handling on American Express, and scheme-specific decline codes.
\n","_postman_id":"c1b2308e-c09a-45d0-89a1-019cf9e81458"},{"name":"APIs","item":[{"name":"Purchase","id":"f568f9d2-9127-473c-bd95-d3d6409efe74","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer {{APIKey}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"client\": {\n \"email\": \"user3782@example.com\",\n \"full_name\": \"Test Customer\",\n \"country\": \"IN\",\n \"city\": \"Ashford\",\n \"street_address\": \"90 Fixture Close\",\n \"zip_code\": \"400001\",\n \"phone\": \"+910000000000\"\n },\n \"purchase\": {\n \"currency\": \"USD\",\n \"products\": [\n {\n \"name\": \"Card test item\",\n \"price\": 10.0\n }\n ]\n },\n \"brand_id\": \"your-brand-id\",\n \"merchantRef\": \"CARD-TEST-0001\",\n \"success_redirect\": \"https://your.success.redirect.com\",\n \"pending_redirect\": \"https://your.pending.redirect.com\",\n \"failure_redirect\": \"https://your.failure.redirect.com\",\n \"success_callback\": \"https://your.success.callback.com\",\n \"failure_callback\": \"https://your.failure.callback.com\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.paystreamportal.com/api/v1/purchases","description":"Step 1 of the card flow. Registers the transaction and returns the purchaseId used by every later call. This call is identical for 2D and 3D Secure; the card, and therefore the authentication mode, is not supplied until Step 2.
Authenticate with your sandbox API key and send your sandbox brand_id.
Request Body Parameters
\nEssential Optional Parameters
\nmerchantRef is your own reference for the transaction and carries two advantages. It prevents duplicates: resending a request with a merchantRef you have already used lets you detect and reject the repeat rather than creating a second purchase. It also makes retrieval straightforward, because you can find the transaction by your own identifier instead of storing Paystream's purchaseId. When running a card test matrix, use a scheme-based value such as CARD-TEST-0001 so a run is easy to find in Transaction Reporting, and change it for every attempt.
Response
\nThe full purchase envelope. status is CREATED, status_history holds a single created entry, and transaction_data.attempts is empty until the card is submitted in Step 2. Take purchaseId and use it in the S2S call.
\n\n","urlObject":{"path":["purchases"],"host":["https://api.paystreamportal.com/api/v1"],"query":[],"variable":[]}},"response":[{"id":"0a4686a3-c22b-4831-924e-492af32197d5","name":"Purchase - Success (created)","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer {{APIKey}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"client\": {\n \"email\": \"user3782@example.com\",\n \"full_name\": \"Test Customer\",\n \"country\": \"IN\",\n \"city\": \"Ashford\",\n \"street_address\": \"90 Fixture Close\",\n \"zip_code\": \"400001\",\n \"phone\": \"+910000000000\"\n },\n \"purchase\": {\n \"currency\": \"USD\",\n \"products\": [\n {\n \"name\": \"Card test item\",\n \"price\": 10.0\n }\n ]\n },\n \"brand_id\": \"your-brand-id\",\n \"merchantRef\": \"CARD-TEST-0001\",\n \"success_redirect\": \"https://your.success.redirect.com\",\n \"pending_redirect\": \"https://your.pending.redirect.com\",\n \"failure_redirect\": \"https://your.failure.redirect.com\",\n \"success_callback\": \"https://your.success.callback.com\",\n \"failure_callback\": \"https://your.failure.callback.com\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.paystreamportal.com/api/v1/purchases"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"purchaseId\": \"6a6db590b1c2d3e4f5a6b701\",\n \"client\": {\n \"bank_account\": \"\",\n \"bank_code\": \"\",\n \"email\": \"user3782@example.com\",\n \"phone\": \"+910000000000\",\n \"full_name\": \"Test Customer\",\n \"date_of_birth\": \"\",\n \"personal_code\": \"\",\n \"street_address\": \"90 Fixture Close\",\n \"country\": \"IN\",\n \"city\": \"Ashford\",\n \"zip_code\": \"400001\",\n \"shipping_street_address\": \"\",\n \"shipping_country\": \"\",\n \"shipping_city\": \"\",\n \"shipping_zip_code\": \"\",\n \"cc\": [],\n \"bcc\": [],\n \"legal_name\": \"\",\n \"brand_name\": \"\",\n \"registration_number\": \"\",\n \"tax_number\": \"\",\n \"stateCode\": \"\"\n },\n \"updated_on\": 1785574800,\n \"type\": \"purchase\",\n \"force_recurring\": false,\n \"created_on\": 1785574800,\n \"purchase\": {\n \"currency\": \"USD\",\n \"products\": [\n {\n \"name\": \"Card test item\",\n \"quantity\": 1,\n \"price\": 10.0,\n \"discount\": 0,\n \"tax_percent\": \"0.00\"\n }\n ],\n \"total\": 10.0,\n \"language\": \"en\",\n \"notes\": \"\",\n \"debt\": 0,\n \"total_formatted\": 10.0,\n \"request_client_details\": [],\n \"timezone\": \"Asia/Kolkata\",\n \"email_message\": \"\"\n },\n \"payment\": {\n \"is_outgoing\": false,\n \"payment_type\": \"PURCHASE\",\n \"amount\": 10.0,\n \"currency\": \"USD\",\n \"net_amount\": 10.0,\n \"fee_amount\": 0,\n \"pending_amount\": 0,\n \"pending_unfreeze_on\": null,\n \"description\": \"\",\n \"paid_on\": null,\n \"remote_paid_on\": null\n },\n \"issuer_details\": {\n \"website\": \"\",\n \"legal_street_address\": \"\",\n \"legal_country\": \"\",\n \"legal_city\": \"\",\n \"legal_zip_code\": \"\",\n \"bank_accounts\": [\n {\n \"bank_account\": \"\",\n \"bank_code\": \"\"\n }\n ],\n \"legal_name\": \"Example Merchant\",\n \"brand_name\": \"Example Merchant\",\n \"registration_number\": \"\",\n \"tax_number\": \"\"\n },\n \"transaction_data\": {\n \"payment_method\": \"VISA\",\n \"flow\": \"payform\",\n \"extra\": {\n \"expiry_month\": \"12\",\n \"expiry_year\": \"30\",\n \"amount\": 10.0,\n \"card_issuer\": \"\",\n \"masked_pan\": \"407972XXXXXX8630\",\n \"card_brand\": \"VISA\",\n \"card_issuer_country\": \"\",\n \"cardholder_name\": \"Test Customer\"\n },\n \"country\": \"\",\n \"attempts\": [\n {\n \"client_ip\": \"203.0.113.138\",\n \"type\": \"execute\",\n \"payment_method\": \"VISA\",\n \"flow\": \"payform\",\n \"successful\": false,\n \"country\": \"\",\n \"processing_time\": 1785574819,\n \"extra\": {\n \"expiry_month\": \"12\",\n \"expiry_year\": \"30\",\n \"amount\": 10.0,\n \"card_issuer\": \"\",\n \"masked_pan\": \"407972XXXXXX8630\",\n \"card_brand\": \"VISA\",\n \"card_issuer_country\": \"\",\n \"cardholder_name\": \"Test Customer\"\n }\n }\n ]\n },\n \"status\": \"CREATED\",\n \"status_history\": [\n {\n \"status\": \"created\",\n \"timestamp\": 1785574800\n }\n ],\n \"viewedOn\": null,\n \"is_test\": true,\n \"brand_id\": \"your-brand-id\",\n \"merchantRef\": \"CARD-TEST-0001\",\n \"send_receipt\": false,\n \"is_recurring_token\": false,\n \"skip_capture\": false,\n \"reference_generated\": \"Values in the saved examples are illustrative; the structure is authoritative. Timestamps, references, and identifiers are made up.
\n
Step 2 of the card flow. Submits the card and device details from your server. This is the call that determines the outcome, because the outcome is fixed by the card number.
\nA successful submission returns 202 with a callback_url. Direct the customer's browser to that URL to complete Step 3.
Path and Query Parameters
\nRequest Body Parameters
\nThe device and browser fields feed 3DS risk assessment. Send realistic values when testing 3D Secure cards.
\nSwapping the outcome
\nTo test a different outcome, change only card_number. Create a fresh purchase first, with a new merchantRef, because a purchaseId that has already been submitted cannot be reused and will return Allowed Attempt for this Transaction has been consumed.
Response
\n202 Accepted with a callback_url. Invoke it from the customer's browser to complete the flow. For a 3D Secure card this leads to the challenge screen, where the OTP is 123456.
Errors follow the standard {\"message\", \"code\"} shape. See 🖥️ Status Code.
Step 3 verification. Returns the current state of the purchase as the full envelope, with status and status_history reflecting the outcome the test card produced.
Path Parameters
\nStatuses you will see
\nstatus_history uses lowercase names with Unix timestamps; the top-level status is uppercase. For a declined transaction, read errorMsg for the reason rather than inferring it from status.
[VERIFY] Which status the Pending execution cards settle at, and whether they later move on.
The three-step card flow, unchanged between sandbox and production. Create the purchase, submit the card, then invoke the callback from the customer's browser and read the result.
\n","_postman_id":"39a122e8-dcd3-413e-bfb9-43c7edd3ddf3"},{"name":"Troubleshooting","item":[],"id":"57f06bbb-541d-4d27-acb1-0d89971b0e01","description":"Error response shape
\n{\n \"message\": \"descriptive error message\",\n \"code\": \"transaction_error\"\n}\nFor a detailed reason, read errorMsg in the purchase envelope or webhook payload rather than relying on status alone.
Reporting a mismatch
\nIf a card does not produce its documented outcome, report it rather than working around it. These tables are only useful if they are exact. Raise it through your usual technical support channel. [TBD: confirm the support address.]
Test cards for validating a card integration in Sandbox mode. Forty-four cards cover eleven outcomes across Visa and Mastercard, in both 2D (non-3DS) and 3D Secure variants, so every branch of your integration can be exercised deterministically before you process a live transaction.
\n\n\n","_postman_id":"a2be37cf-f7cf-4fec-a50c-7a67f1e17291"},{"name":"APM Simulator","item":[{"name":"Concepts","item":[],"id":"f34de767-b959-4b9c-9e2a-c2502b952b79","description":"These cards work only in Sandbox mode. In Live mode they will be treated as ordinary card numbers and declined. Confirm which environment your API key belongs to before running a test suite.
\n
What the APM Simulator is
\nThe APM Simulator is a simulated counterparty for alternative payment methods. When you send a POST https://api.paystreamportal.com/api/v1/purchases/ request authenticated with sandbox credentials and a supported paymentMethod, Paystream routes the purchase to the simulator rather than to a live PSP. You receive a normal purchase response including a checkout_url, which resolves to a hosted simulator cashier page. On that page the outcome is selected explicitly, and the purchase then behaves as it would if a real APM had returned that outcome: statuses advance, a webhook fires, and the customer is redirected to the matching \\*_redirect URL from your request.
When to use it
\n- \n
Building a new APM integration before the PSP contract is signed or credentials are issued.
\n \nExercising the decline and pending branches of your code deterministically, rather than hoping to observe them in production.
\n \nVerifying that your webhook listener receives, parses, and RSA-verifies a Paystream callback.
\n \nConfirming that all three redirect URLs are handled correctly.
\n \nRunning APM regression tests in CI, so an integration proven last release is proven again this release.
\n \n
What a simulated result does and does not prove
\nRead this section before you rely on a simulated pass as evidence of readiness.
\nA simulated result proves:
\n- \n
Your request is well formed and accepted by the
\n/purchasescontract. \nYour code correctly handles the purchase response, including
\ncheckout_urlandpurchaseId. \nYour code correctly handles the status you forced, and the
\nstatus_historytransitions leading to it. \nYour webhook endpoint is reachable, and your RSA signature verification is correct.
\n \nYour redirect handling is correct for success, pending, and failure.
\n \n
A simulated result does not prove:
\n- \n
That the PSP has onboarded, underwritten, or certified you. The simulator never contacts a PSP.
\n \nThat the live rail is enabled on your account, or that your MID is active.
\n \nThat the real APM will return the same field values. Method-specific payload data such as a real Pix payload, a real CLABE, or a real Fawry reference is not issued by the simulator.
\n \nThat your timeout and retry logic is correctly tuned. Simulated outcomes resolve instantly.
\n \nThat you handle every PSP-specific error condition. The simulator exposes three outcomes, not the full error surface of a live rail.
\n \n
How a simulated transaction differs from a live APM transaction
\nPayIn lifecycle
\nHow it works. You create the purchase, send the customer to the simulator cashier page, the outcome is selected there, and Paystream then advances the purchase and notifies you. Nothing in the request body controls the outcome, which is deliberate: the request you validate against the simulator has the same shape and the same fields as the request you will send in production. The only values that change at go-live are your API key and your brand_id.
Flow
\n- \n
Merchant creates the purchase:
\nPOST https://api.paystreamportal.com/api/v1/purchases/with sandbox credentials, a supportedpaymentMethod, and all three ofsuccess_redirect,pending_redirect, andfailure_redirectpopulated. \nPaystream responds: the full purchase envelope, with
\nstatus=CREATEDand acheckout_url. \nMerchant redirects the customer: to the
\ncheckout_url. This is the simulator cashier page, not a real APM page. \nOutcome is selected: Success, Failure, or Pending, on the cashier page.
\n \nPaystream applies the outcome:
\nstatusandstatus_historyadvance to reflect it, immediately. \nPaystream fires the webhook: RSA signed, to your configured callback URL.
\n \nCustomer is redirected: to
\nsuccess_redirect,pending_redirect, orfailure_redirectas appropriate. \nPending expires: a purchase left in the pending state later moves to
\nEXPIRED, and an expiry webhook is fired. The window is not a single fixed value: each method uses the same expiry window as the real APM it stands in for. \n
Note that the simulator has no \"pending then paid\" path. Selecting Pending leads to expiry, not to a later success. If your integration must handle a pending-to-paid transition, that transition has to be validated against a live PSP connection.
\nWebhook events
\n[VERIFY] The status values above follow Paystream's documented purchase lifecycle rather than anything confirmed about the simulator. Before publishing, confirm with engineering: (a) the exact uppercase status the simulator writes for each cashier-page selection, (b) the exact webhook event name emitted for each, (c) which lowercase status_history entries the simulator actually writes, since the saved examples assume created, pending_execute, payment_in_process, paid, error, and expired, and (d) whether a webhook fires on creation. No creation webhook is documented here because none was confirmed.
Coverage and limits
\n[VERIFY] Market and currency mappings are the standard rail defaults for each method and have not been confirmed against the simulator connector configuration.
Standard sandbox limits and data retention apply. There are no simulator-specific limits and no cost.
\n","_postman_id":"f34de767-b959-4b9c-9e2a-c2502b952b79"},{"name":"Enabling the Simulator","item":[],"id":"8369e5db-6ccc-4648-810f-0b47efac38cb","description":"Credentials
\nThe simulator is enabled on every existing Paystream sandbox account. There is nothing to request, no new credential to provision, and no key rotation required.
\nYou need two values, both of which are in the Dashboard section of your merchant account login:
\nEndpoint
\nPOST https://api.paystreamportal.com/api/v1/purchases/
https://api.paystreamportal.com/api/v1 is https://api.paystreamportal.com/api/v1, the same base URL as production. There is no separate simulator host.
The trigger
\nThe credentials are the trigger. Send your normal purchase request with a supported paymentMethod value and sandbox credentials, and the transaction is routed to the simulator. There is:
- \n
- no simulator-specific
paymentMethodorpsp_code, \n - no header to add, \n
- no
extraParamto set, \n - no magic amount, \n
- no test email address or MSISDN, \n
- no dashboard toggle. \n
This is intentional. Because no simulator-specific field exists, the request you validate against the simulator has the same shape and the same fields as the one you send in production. Two values change at go-live, your API key and your brand_id, and both are configuration rather than logic. Promoting an integration from simulator to live is a configuration change, not a code change.
\n\n⚠️ The corollary is that a production API key sends a real transaction to a real PSP. Confirm which key your environment is loading before you run a test suite.
\n
Prerequisites
\n- \n
- A webhook endpoint reachable from Paystream, with RSA signature verification implemented. See the 🔌 Webhooks section of these docs for the signature scheme. \n
- Values for
success_redirect,pending_redirect, andfailure_redirect. All three are needed to exercise all three outcomes. \n
The following methods simulate. Any paymentMethod value not in this table will not simulate, and the request will be handled as it is today for an unsupported or unconfigured method.
[VERIFY] Market and currency mappings above are the standard rail defaults for each method. Confirm them against the simulator connector configuration.
[VERIFY] FawryPay is mixed case while every other enum in the list is uppercase, and the documented convention for paymentMethod is an uppercase value. Confirm whether the correct enum is FawryPay or FAWRYPAY before publishing.
Not covered
\n- \n
- PayOut. The simulator is PayIn only. \n
- Refunds, partial refunds, chargebacks, disputes, and reversals. No post-transaction flow is simulated. \n
- Every other payment method, including cards, bank transfers, and open banking. More APMs will be added over time. No schedule is published. \n
Method-specific caveat
\nFor methods whose production flow depends on a payload the rail issues, such as a Pix payload, a SPEI CLABE, or a Fawry reference, the simulator does not issue that value. The simulator substitutes its own cashier page. If your integration parses or renders such a payload, that parsing must be validated against a live PSP connection. See Migrating from Simulator to Live.
\n","_postman_id":"bdeeed78-1296-4643-8c90-43d2e00064fe"},{"name":"Forcing Outcomes","item":[],"id":"f4556e55-cb2f-4c51-a2be-2e6abe5fb4cc","description":"Scenario matrix
\n[VERIFY] Exact status values and webhook event names per selection, per the note in Concepts.
The request is the same for every outcome
\nThere is no test_scenario parameter, no magic amount, and no flag. The request body is identical for all three outcomes. The outcome is selected downstream, on the cashier page.
This means the \"request example for each outcome\" is one example, and the divergence happens after it:
\nPOST https://api.paystreamportal.com/api/v1/purchases/\nAuthorization: Bearer {{APIKey}}\nContent-Type: application/json\n<the body shown in PayIn API → Purchases>\n\nTo test a success, open the returned checkout_url and select Success. To test a decline, send the request again with a new merchantRef and select Failure. To test pending and expiry, send it again with another new merchantRef, select Pending, and wait out the method's expiry window. Reuse the same merchantRef across runs and your own duplicate-prevention logic should reject the repeat, which is a useful test in itself but not the one you are trying to run here.
Recommended test matrix
\nRun this sequence per method you intend to go live with:
\nTests 5 and 6 are not simulator features, they are tests the simulator makes cheap to run repeatedly.
\nTests 1 to 3, 5, and 6 resolve instantly and are suitable for a normal CI job. Test 4 is not: it waits out the method's real expiry window, which can be long. Run it in a scheduled or long-running job rather than in a per-commit pipeline.
\nExpiry windows
\nThe pending-to-expired window is not a single fixed value. Each method expires on the same window as the real APM it stands in for, so the timing you observe in the simulator is the timing to design for. [TBD: engineering to supply the per-method expiry windows so they can be tabulated here.]
To initiate a simulated APM payment, the first call to make is /purchases. It is the same call, the same URL, and the same body you use in production. Authenticating with sandbox credentials is what routes the purchase to the simulator.
The response is the full purchase envelope. The field you need next is checkout_url, which is the simulator cashier page. Send the customer there and select the outcome you want to test.
Request Body Parameters
\nEssential Optional Parameters
\nmerchantRef is your own reference for the transaction and carries two advantages. It prevents duplicates: if you resend a request with a merchantRef you have already used, you can detect and reject the repeat rather than creating a second purchase. It also makes retrieval straightforward, because you can locate the transaction by your own identifier instead of storing and matching Paystream's purchaseId. In the simulator it is worth setting a predictable, scheme-based value such as SIM-UPI-0001, so a CI run's transactions are easy to find in Transaction Reporting.
Response
\nThe response is the complete purchase envelope, not a trimmed object. At creation:
\n- \n
statusisCREATEDandstatus_historyholds a singlecreatedentry. \ncheckout_urlis the simulator cashier page. Send the customer here. \ntransaction_data.attemptsis empty until an outcome is selected. \nrefund_availabilityisNONE, because refunds are not simulated. \npayment.paid_onisnulluntil Success is selected. \n
\n\nValues in the saved examples are illustrative; the structure is authoritative. Timestamps, references, and identifiers are made up. Do not treat any specific value as a contract.
\n
[VERIFY] Three things in the saved examples are inference, not confirmed simulator behaviour, and must be checked before publishing:
- \n
is_testis shown asfalsebecause that is the documented envelope default. If the simulator setsis_test: true, that is the field merchants and support should filter reporting on, and every example here must be corrected. \nstatus_historyentries. The examples assumepending_executeandpayment_in_processare written. Confirm which intermediate states the simulator actually produces. \ntransaction_data.attemptssemantics, including whether an attempt is recorded for a pending purchase and whatsuccessfulholds while the purchase is unresolved. \n
Retrieve the current state of a simulated purchase. Use this to observe the outcome you selected on the cashier page, and to watch a pending purchase move to expired.
\nThe response is the same full purchase envelope returned by /purchases, with status and status_history reflecting the current state.
Path Parameters
\nStatus values you will see in the simulator
\nThe saved examples below cover all four outcomes. Note that status_history uses lowercase status names and Unix timestamps, while the top-level status is uppercase.
[VERIFY] Exact status values per cashier-page selection, per Concepts.
Simulated PayIn uses the standard /purchases contract. Create the purchase, send the customer to the returned checkout_url, select the outcome, then read the result with Get Status.
Simulated transactions fire webhooks to your configured callback URL. They are signed with RSA exactly as production webhooks are, so your signature verification is genuinely exercised. The payload carries fewer fields than a live APM webhook.
\nSignature verification
\nThe signature scheme is identical to production. Verify simulated webhooks the same way you verify live ones, per the 🔌 Webhooks section of these docs. [VERIFY] whether the sandbox account uses a different public key from production, which determines whether anything has to change at go-live. Do not special-case simulated callbacks in your verification path: doing so defeats most of the value of testing against the simulator, and it is a change you would then have to unwind before go-live.
A verification failure on a simulated webhook is a real finding. In practice it is almost always a key-configuration or canonicalisation bug on the merchant side, which is exactly the class of defect the simulator is meant to surface before production.
\nEvents per outcome
\nPractical guidance
\n- \n
Key off
\npurchaseIdandmerchantRef, and treat the webhook as a signal to fetch state rather than as the state itself. CallGET https://api.paystreamportal.com/api/v1/purchases/{purchaseId}/to read the authoritative envelope. This pattern is robust against the reduced simulated payload and is good practice in production regardless. \nMake your listener idempotent. Handle the same
\npurchaseIdarriving more than once. \nExpect two webhooks for the pending path,
\nPENDINGthenEXPIRED, and make sure the second one does not overwrite a state you have already resolved by other means. \n
Moving from the simulator to a live PSP connection is a credential change, not a code change. That is the point of the design. This checklist covers what changes, and what the simulator could not have proved.
\nWhat changes
\nBefore you switch
\n- \n
- Confirm the method is contracted and enabled on your production account. A working simulator integration is not evidence that it is. \n
- Confirm your production webhook endpoint is reachable and verifying against the production public key. \n
- Confirm your environment configuration cannot load a sandbox key in production, or a production key in a test suite. This is the most common cause of a surprise live transaction. \n
- Replace test redirect URLs with production URLs, and confirm all three resolve. \n
- Confirm you are not special-casing anything about simulated transactions in your production code path. \n
What you must still test live
\nThe simulator cannot establish any of the following. Plan live test transactions for each that applies:
\n- \n
- PSP UAT. Whatever certification or UAT your PSP requires still applies, in full. \n
- Method-specific payload handling. A real Pix payload, SPEI CLABE, Fawry reference, or UPI collect request. The simulator does not issue these, so any code that parses, renders, or displays them is untested. \n
- Real-world timing. Simulated outcomes are instant. Your timeout, polling interval, and retry behaviour must be validated against real APM latency, which for some methods is minutes or hours. \n
- Pending to paid. The simulator's pending path ends in expiry. A pending purchase that later succeeds is a transition the simulator cannot produce. \n
- Full webhook payloads. Simulated payloads are reduced. Confirm your listener handles the complete live payload. \n
- Refunds, partial refunds, chargebacks, disputes, and reversals, where the method supports them. None are simulated. \n
- The real error surface. The simulator exposes one generic failure. A live rail returns method-specific decline and error conditions. \n
- Settlement and reconciliation. No simulated transaction settles, so your reconciliation against settlement files is untested. \n
Suggested go-live sequence
\n- \n
- Full simulator pass on all four outcomes. Outcomes 1 to 3 in CI; the pending-to-expiry case in a longer-running job, since it waits out the real expiry window. \n
- PSP UAT, per your PSP's requirements. \n
- A small number of low-value live transactions per method, covering at minimum one success and one customer-abandoned attempt. \n
- Reconcile those live transactions against your settlement report. \n
- Ramp. \n
Error response shape
\nErrors follow the standard shape:
\n{\n \"message\": \"Brand not found\",\n \"code\": \"transaction_error\"\n}\nGetting help
\nIf simulator behaviour does not match this documentation, report it rather than working around it. The simulator is only useful to the extent it is faithful, so a divergence is a documentation or product defect worth fixing. Raise it through your usual technical support channel. [TBD: confirm the support address and whether a response-time commitment is published.]
The APM Simulator lets you run simulated alternative-payment-method PayIn transactions in sandbox. It exists because APMs previously could not be tested in sandbox at all: validating an APM integration meant pushing real, low-value transactions through a live PSP connection.
\nSimulated transactions use the same endpoint and the same /purchases contract as production. Your existing sandbox API key and Brand ID are the only switch. There is no separate base URL, no flag, no header, no magic amount, and nothing to request.
\n\n","_postman_id":"1da5934a-27cd-4633-a939-8ec8f29fdd5a"}],"event":[{"listen":"prerequest","script":{"type":"text/javascript","requests":{},"exec":[""],"id":"2f40ec81-5042-4099-a707-6c858b081d4c"}},{"listen":"test","script":{"type":"text/javascript","requests":{},"exec":[""],"id":"b351e736-1e44-43c4-ade6-0001af01a86f"}}],"variable":[{"key":"BaseURL","value":"https://api.paystreamportal.com/api/v1"},{"key":"AppBaseURL","value":""}]}The simulator proves that your integration handles every state correctly. It does not prove that a PSP has certified you, and it does not replace UAT against a live PSP connection. See Concepts for exactly what a simulated result does and does not establish.
\n