Skip to main content
POST
Simulate funding deposit

Authorizations

API-Key
string
header
required

Your public API key. Identifies the partner making the request.

API-Sign
string
header
required

HMAC signature over the request, computed with your private key.

API-Nonce
string
header
required

Monotonically increasing nonce included in the request signature.

Path Parameters

account_id
string
required

Globally unique public identifier for an account.

Required string length: 14 - 42

Body

application/json

Funding method, amount, and optional reconciliation details for a synthetic successful deposit.

method_id
string<uuid>
required

Funding method identifier returned by the deposit-methods endpoint for the selected account.

amount
string
required

Positive decimal amount to deposit, represented as a string to preserve precision.

Required string length: 1 - 64
Pattern: ^[0-9]+(\.[0-9]+)?$
name
string
default:PWS simulated funding deposit

Test payer label copied into the simulated deposit.

Required string length: 1 - 128
reference
string

Optional payment reference copied into the simulated deposit for test reconciliation.

Required string length: 1 - 140

Response

Simulated deposit accepted for processing.

Acknowledgment that the synthetic deposit was accepted.

data
object
required

Result of a funding deposit simulation request.