Skip to main content
POST
Simulate an outcome

Authorizations

x-api-key
string
header
required

Your secret key. fpay_test_… keys use the sandbox; fpay_live_… keys move real money.

Body

application/json
outcome
enum<string>
required

Whether it succeeds or fails.

Available options:
success,
failed
Example:

"success"

reference
string
required

The sandbox payment to settle: a deposit, withdrawal or ramp order's reference, or a checkout's txRef.

Example:

"inv_2201"

amount
number

Deposits only: how much the customer paid, to test under- and over-payment. Defaults to the expected amount.

Example:

100

Response

Outcome applied.

message
string
Example:

"Successful"

status
string
Example:

"success"

statusCode
number
Example:

200

data
object