Simulate Outgoing Credit Transfer Return

post

https://api.cloud.mbanq.com/v1/transfers/simulation/{externalTransferId}/return

Use this API to simulate return flows for outgoing credit transfers returns by targeting a specific existing transfer.

Simulation Capabilities:

Return Simulation (Outgoing): Trigger return flows for outgoing ACH and Wire transactions by targeting a specific existing transfer
Multi-Rail Support: Mock behavior for ACH, Wire, and Swift incoming messages

Available in Sandbox Environment Only

Path Params

externalTransferId

string

required

The unique identifier of the external transfer to be returned.

Body Params

Details of the transfer return to be simulated

originalTransferId

integer

required

The original transfer ID that is being returned.

errorCode

string

required

ACH return code (e.g., R01, R02, R03, etc.)

errorMessage

string

required

Description of the return reason.

paymentType

string

enum

required

The payment type (ACH, Wire, Swift).

Allowed:

amount

number

required

The amount being returned.

currency

string

required

Currency code (e.g., USD).

paymentRailMetaData

object

required

Payment rail-specific metadata.

Headers

tenantId

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

Language

Credentials

Bearer

JWT

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Return simulated successfully.

400Invalid request parameters.

401Authentication credentials were missing or incorrect.

403The authenticated user does not have permission to simulate transfer returns.

404Transfer not found.