Skip to main content

Simulating Incoming Payments in Sandbox

This article explains how to the test incoming payments within Zepto's Sandbox environment

Updated this week


When you start integrating with Zepto, you will want to test for as many situations as possible before moving to our live production environment. Our sandbox environment offers you a simple and effective way to test your integrations before going live.

All transactions in our Sandbox environment are simulated and no communication with financial institutions is performed. This article explains how to the test incoming payments within Zepto's Sandbox environment.

Please note that testing incoming payments in Sandbox can only be done via our API.

How to:

Simulating an incoming PayID payment in the Sandbox environment

Simulate receiving a real-time PayID payment from one of your Receivable Contacts.

API documentation here

Endpoint: POST /simulate/incoming_npp_payid_payment

Request Payload:

{
"payid_email": "debtor1234@pay.spaceships.com",
"amount": "1501",
"from_bsb": "654321",
"from_account_number": "12345678",
"debtor_name": "Debtor Name",
"debtor_legal_name": "Name of the debtor",
"payment_description": "For 1 Rocket please",
"payment_reference": "Purchase - Rocket"
}

Response [201]:

{
"data": {
"id": "aebf903f-8e9f-48d5-baf4-ddfde6f4e626",
"payid_email": "jack1234@pay.spaceships.com",
"amount": 1501,
"debtor_name": "Debtor Name",
"debtor_legal_name": "Name of the debtor",
"from_bsb": "654321",
"from_account_number": "12345678",
"payment_description": "For 1 Rocket please",
"payment_reference": "Purchase - Rocket"
}
}

Simulating an incoming real-time payment in the Sandbox environment

Simulate receiving a real-time payment to either a Receivable Contact or one of your float accounts, made using a BSB and account number (i.e. not via PayID).

API documentation here

Endpoint: POST /simulate/incoming_npp_bban_payment

Request Payload:

{
"to_bsb": "802919",
"to_account_number": "1344254",
"amount": "1501",
"from_bsb": "654321",
"from_account_number": "12345678",
"debtor_name": "Debtor Name",
"debtor_legal_name": "Jack Karlson",
"payment_description": "Name of the debtor",
"payment_reference": "Purchase - Rocket"
}

Response [201]:

{
"data": {
"id": "91deafbf-bdba-425a-b5bc-c29f7ed99c5e",
"amount": 1501,
"debtor_name": "Debtor Name",
"debtor_legal_name": "Name of the debtor",
"from_bsb": "654321",
"from_account_number": "12345678",
"to_bsb": "802919",
"to_account_number": "1344254",
"payment_description": "For 1 Rocket please",
"payment_reference": "Purchase - Rocket"
}
}

Simulating an incoming DE payment in the Sandbox environment

Simulate receiving a Direct Entry payment (i.e. not a real-time payment) to either a Receivable Contact or one of your float accounts.

API Documentation: here

Endpoint: POST /simulate/incoming_de_payment

Request Payload:

{
"to_bsb": "802919",
"to_account_number": "1344254",
"amount": "1501",
"from_bsb": "654321",
"from_account_number": "12345678",
"debtor_name": "Debtor Name",
"payment_reference": "Purchase - Rocket"
}

Response [201]:

{
"data": {
"id": "edba2dce-15ee-4e20-ae97-42e2ffbf93a1",
"amount": 1501,
"to_bsb": "802919",
"to_account_number": "1344254",
"debtor_name": "Debtor Name",
"payment_reference": "Purchase - Rocket",
"from_bsb": "654321",
"from_account_number": "12345678"
}
}

Feel free to reach out to us by clicking on the green bubble at the bottom of the screen or email us at support@zepto.com.au


​

Did this answer your question?