Funds deposit held - Payward Developer Documentation

{ "type": "funds.deposit_held", "transaction_id": "FRABCDEF123456", "user_id": "AA55 N84G QOIR A67A", "account_id": "WCQY T95Y CUL2 A7NX", "amount": { "asset": "USD", "value": "100.00" }, "fee": { "asset": "USD", "value": "0" } }

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.

Body

application/json

Payload shared by deposit lifecycle events. Amount and fee availability follows the source data and is not tied to the lifecycle event type.

transaction_id

string

required

Public deposit transaction id.

user_id

string

required

Public id of the user whose deposit changed.

account_id

string

required

Public account id associated with the deposit.

type

enum<string>

required

Event type discriminator.

Available options:

funds.deposit_held

amount

FundsDepositAssetAmount · object

Total deposit amount, inclusive of the fee. Present when PWS can resolve both the source value and its asset.

Show child attributes

fee

FundsDepositAssetAmount · object

Fee charged for the deposit. Present only when the source provides both the fee value and its asset and PWS can resolve the asset. An explicitly provided zero fee is included; PWS does not infer a missing fee or its asset.

Show child attributes

observed_at

string<date-time>

RFC3339 UTC time the transition was observed. Omitted when unavailable.

Response

200

Return any 2xx status to acknowledge receipt.