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
SendPOST /v1/transfers with the source account, destination account, asset symbol, and decimal amount.
Response
A successful request returns HTTP201:
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 withstatus: complete does not
guarantee that the Portfolio transaction is visible yet.
Poll GET /v1/accounts/{account_id}/portfolio/transactions using:
- the request’s
fromaccount asaccount_id types=transfer- a time range that includes the create request
- no
statusesfilter, or a filter that includesin_progress
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:
types and other filters using AND semantics.
Keep these identifiers distinct:
Error handling
Not yet available. Transfer creation does not support idempotency keys.