Get Sandbox Keys
API Reference

Simulate Incoming Credit/Debit Transfer

post
https://api.cloud.mbanq.com/v1/transfers/simulation

Use this API to simulate incoming Credit/Debit transactions for ACH, Wire, and Swift payment rails in the sandbox environment. This allows you to test your application's handling of various transfer scenarios, including successful transactions and returns.

Simulation Capabilities:

  • Incoming ACH Simulation: Simulate successfully received ACH Credit and ACH Debit transactions
  • Multi-Rail Support: Mock behavior for ACH, Wire, swift incoming messages

Available in Sandbox Environment Only

Body Params
number
required

The amount to be transferred in the simulation.

string

Currency of the transaction (e.g. USD).

string

Date format used in date fields (if any).

string
required

The payment type for the simulation.

string
required

Transfer type, CREDIT or DEBIT.

debtor
object
required

Debtor details for the simulation.

creditor
object
required

Creditor details for the simulation.

reference
array of strings
required

List of reference notes for the payment.

reference*
string
required

Statement description.

paymentRailMetaData
object

Metadata specific to the payment rail.

correspondent
object

Free-form correspondent bank fields (optional).

traceNumbers
object

Free-form trace number mapping (optional).

Headers
string
required

The ID of your banking instance visible in the MBANQ Console.

string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

Updated about 2 months ago

Did this page help you?
Language
Credentials
Bearer
JWT
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated about 2 months ago

Did this page help you?