Portfolio transaction transfer - Payward Developer Documentation

{ "type": "transaction.transfer", "transaction_id": "TXEXAMPLE1234567", "user_id": "AA55 N84G QOIR A67A", "account_id": "WCQY T95Y CUL2 A7NX", "timestamp": "2025-01-01T00:00:01+00:00", "status": "in_progress", "transfer_id": "TFEXAMPLE1234567" }

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

A Portfolio transfer transaction was created or updated.

transaction_id

string

required

Public Portfolio transaction id. Matches the id returned by the Portfolio Transactions endpoint.

user_id

string

required

Public id of the user whose Portfolio transaction changed.

account_id

string

required

Public id of the account that owns the Portfolio transaction.

timestamp

string<date-time>

required

RFC3339 UTC timestamp of the Portfolio transaction.

type

enum<string>

required

Event type discriminator.

Available options:

transaction.transfer

status

enum<string>

Current Portfolio transaction status, when available.

Available options:

uncategorized,

in_progress,

successful,

failed

transfer_id

string

Public transfer id returned by the Transfers API, when available.

Response

200

Return any 2xx status to acknowledge receipt.