Skip to main content
POST
Simulate bank-transfer settlement (sandbox only)
Some Platform API capabilities must be enabled on your account by MoonPay before you can call them. If this endpoint returns an unexpected 404, see Capability enablement.
This endpoint works only in test mode. Live-mode transactions return 403. In production, bank transfers settle when the customer’s deposit arrives.

Authorizations

Authorization
string
header
required

Bearer authentication header using an access token.

Example: Authorization: Bearer <accessToken>

Path Parameters

id
string
required

The MoonPay ID of the transaction.

Body

application/json

Request body for simulating bank-transfer settlement.

outcome
enum<string>
required

Which settlement outcome to simulate.

Available options:
settled,
timeout
senderBankAccount
object

Optional sender bank account used to create the customer's bank account when settling. Defaults are synthesized per currency when omitted.

Response

The request has succeeded.

data
object
required

Transaction with lifecycle stages showing step-by-step progress.