Simulate inbound payment (sandbox only)

Drives the same domain command chain a real upstream payment-processor webhook would trigger, so client integrations can exercise inbound-payment flows without a live counterparty. Sandbox-only: the simulator is registered exclusively when the platform runs in Simulated integrations mode, so in Real or Mocked mode this endpoint returns 404 for every request. accountId is the beneficiary account's id, as returned by GET /v1/accounts. amount is expressed in minor units. When remitter is omitted, fixed sandbox defaults are applied (holder name 'Sandbox Remitter Ltd', account number 'SBX0000000001', bank code 'SBXBANK01'). paymentType is one of Fps, Chaps, Swift, Sepa (case-insensitive); Sepa must be in EUR, and any other value is rejected with 400. A reference starting with the documented PAYMENT-rejected-compliance trigger makes screening reject the payment: the id is still returned, but the funds are never allocated to the account.

Body Params
string
required
length ≥ 1
string
required
length ≥ 1
int64
required
> 0

Minor units of the given currency; must be greater than 0

string
required
length ≥ 1
string
enum
required
length ≥ 1
Allowed:
string | null
date | null
remitter
Headers
string
required

Fresh RFC 9449 proof JWT (ES256) signed with the client's DPoP key, binding this request's method and URL to the access token; generate a new proof per request

string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

Language
Credentials
OAuth2
URL
LoadingLoading…
Response
Choose an example:
application/json
application/problem+json