📘
GET STARTED
To obtain access to our sandbox environment, we kindly request that you contact your designated Sales Owner or Account Manager.

Available Payment Methods in Sandbox

Currently you will be able to test the following payment methods in our sandbox:

PIX Payins, Credit cards, Online payments and Cash payments.
Bank Transfer Payouts

BackOffice and API URLs

BackOffice access: https://shop-sandbox.payretailers.com

Currently available endpoints:

https://api-sandbox.payretailers.com/payments/v2/paymentMethods https://api-sandbox.payretailers.com/payments/v2/transactions https://api-sandbox.payretailers.com/payments/v2/payout https://api-sandbox.payretailers.com/payments/v2/paywalls

📘
SANDBOX ENVIRONMENT AND API CALLS
For all your API Call towards the Sandbox Environment, bear in mind to always use the Ocp-Apim-Subscription-Key mentioned here below:
Ocp-Apim-Subscription-Key
1aa4e605bd5b405fba6061b55e52f4cd

❗️
Transaction rates are limited in this sandbox endpoint
Our sandbox environment is not suitable for stress testing. We enforce transaction rate limiting to maintain the platform stability and performance.

How to create a transaction

For creating a transaction (payin) in our sandbox environment, please review our 'Create Transaction' page and consider the requested body parameters.

https://payretailers.readme.io/reference/create-transaction

For creating a transaction (payout) in our sandbox environment, please review our 'Create Payout' page and consider the requested body parameters.

https://payretailers.readme.io/reference/create-payout

❗️
POST Payout
This POST call does not support payouts created using only the RecipientPixKey for Brazil.

Same for creating a paywall in our sandbox environment, please review 'Create Paywall' and consider the requested body parameters.

https://payretailers.readme.io/reference/create-paywall

How to change transaction status:

Through backoffice: You will able to use the backoffice interface to manually change the status of transactions. You will find a the column "ACTIONS" which will allow you to modify the status. This method provides a straightforward and centralized approach to modify transaction status, offering real-time control and visibility over transaction management.
Using JSON request description field: Include the word for the desired transaction status (APPROVED or FAILED) within the "description" field of the JSON request. By including the word for the desired status directly in the request payload, you can automate and streamline the process of changing transaction status, making it easier to integrate into automated testing workflows.
In the checkout (payin only): Modify the transaction status directly within the checkout interface received after creating the transaction. This approach allows you to interactively change and visualize transaction status within the user interface, providing a hands-on method to test and validate transaction flows.

By offering multiple ways to change transaction status, our sandbox environment empowers you to simulate and test various scenarios and user interactions effectively.

How to change payout status:

Through backoffice: You will able to use the backoffice interface to manually change the status of transactions. You will find a the column "ACTIONS" which will allow you to modify the status. This method provides a straightforward and centralized approach to modify payout status.

Important disclaimer

🚧
User-Generated-Data and PR Responsability
By accessing and using this web application, designed solely for demonstration (DEMO) purposes in a sandbox environment, you agree to and acknowledge the following:

Data Responsibility: You are solely responsible for ensuring the integrity, legality, and appropriateness of the data you enter and process on this platform including, but not limited to, the responsibility to not submit real customer data.

GDPR and Regulation Compliance: adherence to GDPR and other data protection regulations is mandatory. You are responsible for ensuring that any data used within this platform complies with these regulations and protects privacy data as in real-world scenarios.

Waiver: PayRetailers is not responsible for any damages or negative outcomes resulting from the use or interpretation of data on this application. If your actions result in legal action against PayRetailers, you will be held responsible and hold Payretailers harmless from and against any and all claims, damages, liabilities, costs, and expenses.

Legal Compliance and Platform Rights: You commit to adhering to all applicable laws and regulations, including but not limited to GDPR and IP laws. PayRetailers reserves the right to refuse processing data PayRetailers considers to be illegal, unethical, or harmful, and to suspend or terminate your access if our terms of service are violated.

This sandbox environment is a simulation, and as such, no economic transaction or financial reconciliation conducted here will have real effect or economic value. Operations are purely illustrative to demonstrate potential functionalities.
By using this environment, you assume the responsibility for protecting the privacy and security of any data used, in accordance with applicable data protection regulations.