Skip to main content

Overview

The Transfers API moves an asset from one PWS account to another account in the authenticated caller’s program. Only account-to-account transfers are supported. Email, username-tag, and other recipient types are not supported.

Prerequisites

  • Payward Services API credentials (see the Authentication guide)
  • A source account with a sufficient available balance
  • A destination account in the same program

Create a transfer

Send POST /v1/transfers with the source account, destination account, asset symbol, and decimal amount.

Response

A successful request returns HTTP 201:
transfer_id is an opaque originating reference. It is distinct from the Portfolio transaction ID.

Reconcile through Portfolio

Transfer creation and Portfolio visibility are asynchronous. A create response with status: complete does not guarantee that the Portfolio transaction is visible yet. Poll GET /v1/accounts/{account_id}/portfolio/transactions using:
  • the request’s from account as account_id
  • types=transfer
  • a time range that includes the create request
  • no statuses filter, or a filter that includes in_progress
Portfolio transactions are account-relative. The from account response contains spend, while the to account response contains receive. The example below queries the from account, so it shows only spend. When the transaction appears, its reference links it to the create response:
Use the reference for deterministic later lookups:
Reference entries use OR semantics with each other. They combine with types and other filters using AND semantics. Keep these identifiers distinct:

Error handling

Not yet available. Transfer creation does not support idempotency keys.