curl --request POST \
  --url https://api.services.payward.com/v1/transfers \
  --header 'API-Key: <api-key>' \
  --header 'API-Nonce: <api-key>' \
  --header 'API-Sign: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "from": "WVSD33HRMGSZUBM7",
  "to": "WNPY3PJZYD4L9E7B",
  "asset": "USD",
  "amount": "25.50"
}
'

{
  "data": {
    "transfer_id": "TRYCMN7-WXKJM-F47YIM",
    "status": "pending"
  }
}

Funds

Create transfer

Creates a transfer between accounts in the authenticated caller’s program.

The returned transfer_id is the originating reference for the corresponding Portfolio transaction. Once that transaction is visible, retrieve it with GET /v1/accounts/{account_id}/portfolio/transactions using reference.kind=transfer and reference.id equal to this transfer_id. Use the from account from this request as account_id when retrieving the initiating account’s transaction.

Transfer creation and Portfolio transaction visibility are asynchronous boundaries. A response with status=complete confirms the create operation’s current outcome, but the corresponding Portfolio transaction may not be visible immediately. Discover it by polling Portfolio with the transfer type and an appropriate time range; the Portfolio transaction can first have status=in_progress before reaching successful or failed.

This operation is not idempotent. If a request times out or otherwise has an unknown outcome, do not automatically retry it because the transfer may already have been created. First reconcile the source account’s Portfolio transactions or contact Payward Services support.

POST

/

v1

/

transfers

curl --request POST \
  --url https://api.services.payward.com/v1/transfers \
  --header 'API-Key: <api-key>' \
  --header 'API-Nonce: <api-key>' \
  --header 'API-Sign: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "from": "WVSD33HRMGSZUBM7",
  "to": "WNPY3PJZYD4L9E7B",
  "asset": "USD",
  "amount": "25.50"
}
'

{
  "data": {
    "transfer_id": "TRYCMN7-WXKJM-F47YIM",
    "status": "pending"
  }
}

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

Request to create an account-funded transfer.

from

string

required

Public account ID to debit.

Required string length: 14 - 42

to

string

required

Public account ID to credit.

Required string length: 14 - 42

asset

string

required

Asset ticker symbol to transfer. Currency assets and tokenized assets such as xStocks are supported when eligible for transfers.

Required string length: 1 - 16

amount

string

required

Decimal amount represented as a string to preserve precision.

Required string length: 1 - 64

Pattern: ^[0-9]+(\.[0-9]+)?$

Response

Transfer created.

Response returned after creating a transfer.

data

object

required

Created transfer.

Show child attributes

⌘I