Conversion deposit held - Payward Developer Documentation

{ "type": "conversion.deposit_held", "transaction_id": "87654321-4321-4321-4321-210987654321", "conversion_id": "12345678-1234-1234-1234-123456789012", "user_id": "AA55 N84G QOIR A67A", "status": "held", "observed_at": "2025-01-01T00:00:01+00:00", "chain_references": { "deposit_txid": "deposit-123" } }

Authorizations

API-Key

string

header

required

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

API-Nonce

string

header

required

Monotonically increasing nonce included in the request signature.

API-Sign

string

header

required

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

Body

application/json

Payload shared by all conversion transaction lifecycle events.

transaction_id

string

required

Conversion transaction id.

Stable public conversion transaction id when the source event carries enough conversion context. Falls back to the public quote_id for older ramp events without conversion transaction context.

conversion_id

string

required

Public conversion rule id.

user_id

string

required

Public id of the user whose conversion transaction changed.

status

string

required

Public conversion transaction lifecycle status.

observed_at

string

required

RFC3339 UTC time the transition was observed by the processor.

chain_references

object

required

Funding transaction references observed in the source lifecycle.

Show child attributes

type

enum<string>

required

Event type discriminator.

Available options:

conversion.deposit_held

deposit_reference

string

User payment reference from the inbound funding deposit, when present.

Response

200

Return any 2xx status to acknowledge receipt.