Bank Transfer Payouts – Sandbox Test Values
In the sandbox environment, you can choose where a bank transfer payout ends up by putting a keyword in the payment's payeeMemo. This lets you test how your integration handles each payout status without waiting on a real bank. These keywords only work in sandbox. In production, the memo never changes how a payout is processed.
Supported payment methods
Keywords apply to bank transfer payouts: bank-transfer-1, bank-transfer-2, bank-transfer-3, bank-transfer-4 and bank-transfer-5, including mobile wallets paid as a bank transfer. Other payment methods (PayPal, Venmo, push to debit card, prepaid cards) ignore the memo and follow their normal sandbox behavior.
Keywords
Add one of the following words anywhere in payeeMemo. Matching is case-insensitive, and the keyword must be a whole word: Invoice 42 FAILED matches failed, but unprocessed does not match processed.
| Keyword | Final status | What happens |
|---|---|---|
processed | PROCESSING | The payout is sent and stays in PROCESSING. It never completes, so you can test in-flight states. |
completed | COMPLETED | The payout is sent and completes within about 15 minutes of reaching PROCESSING. |
failed | RETURNED | The payout is sent, the bank rejects it, and the funds are returned. |
returned | RETURNED | The payout is sent, the bank sends it back, and the funds are returned. |
If the memo has none of these words, the payout follows the normal sandbox workflow.
If the memo contains more than one keyword, the outcome is chosen in this order: returned, failed, completed, processed. For example, completed then returned ends as RETURNED.
What to expect
Each keyword follows the same steps a real bank transfer goes through, so you receive every status change and webhook along the way:
- The payment is submitted and moves to
SUBMITTED. - The transfer is sent and the payment moves to
PROCESSING. - Then, depending on the keyword:
processed: nothing else happens.completed: the payment moves toCOMPLETED.failedorreturned: the payment moves toRETURNED, the full amount is returned to your balance, and the payee's payment method is marked as invalid, just as it is when a real bank rejects a transfer. No return fee is charged in sandbox.
Example:Creating a payment with
"payeeMemo": "Sandbox test returned"and abank-transfer-1payee lets you test your handling of a returned payout from start to finish.
If you do not set
payeeMemo, the batch name is used as the memo, so a batch named, for example,Failed payouts retrytriggers thefailedoutcome for every bank transfer payment in it that has no memo of its own.
Updated 5 days ago
