Simulated Payment Processing Guide (Sandbox)

This guide explains how to set up payments to trigger returns, reversals, and expedite the payment process in our sandbox environment.

Available Actions

The following actions are available to be triggered for payments in order to simulate normal processing scenarios:

• Return

  • The payment will be returned either with the requested return code you provide or a random one chosen from the codes listed in the Acceptable Return Codes table.

• Reverse

  • The payment will be reversed either with the requested return code you provide or a random one chosen from the codes listed in the Acceptable Return Codes table.

• Expedite

  • The payment will be expedited to paid status instead of adhering to normal processing hold times.

How to Trigger Actions

In order to trigger the desired action for a payment, you will need add the following at the beginning of the supplementalData field in a payment:

"supplementalData": "Return R01"

"supplementalData": "Reverse RXX"

"supplementalData": "Expedite"

There are two options to choose the return code you want to use for the returned or reversed payment:

1. If you replace “RXX” in the phrases above with one of the return codes in the Acceptable Return Codes table (as shown in the Return action example), then that specified return code will be used.

2. If you do not have a specific return code you want used, then you can leave “RXX” (as shown in the Reverse action example above) and we will randomly select a return code from the codes in the Acceptable Return Codes table.

🗒️ Note: Return Code is not needed for the Expedite action.

Acceptable Return Codes

The following are the acceptable return codes for returns and reversals in the sandbox environment: