Skip to main content
POST

Authorizations

api-key
string
header
required

Headers

Idempotency-Key
string

Unique key (UUID recommended) that makes a create request safe to retry by replaying the original response; retained 24h per partner.

Maximum string length: 255

Path Parameters

paymentId
string
required

A payment id (pay_).

Body

application/json
action
enum<string>
required

The payment lifecycle transition to simulate.

Available options:
risk-approve,
risk-decline,
collect,
deliver,
fail-collect,
fail-deliver
reason
string

Optional free-text reason recorded on decline/failure actions.

metadata
object

Optional metadata echoed to logs; not persisted on the payment.

Response

Action applied.