curl --request POST \
--url https://api.sandbox.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"
}
}Create transfer
Creates a transfer between accounts in the authenticated caller’s program.
Idempotency-Key is optional. Reuse the same key with an unchanged request to prevent duplicate execution. Without a key, do not retry an unknown outcome until you reconcile the from account’s Portfolio transactions.
Once recorded, a key remains globally reserved beyond 24 hours and cannot be reused for another transfer, including one for a different acting user or account.
curl --request POST \
--url https://api.sandbox.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
Your public API key. Identifies the partner making the request.
HMAC signature over the request, computed with your private key.
Monotonically increasing nonce included in the request signature.
Headers
Client-generated canonical UUIDv4 that uniquely identifies a request for safe retries.
^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"550e8400-e29b-41d4-a716-446655440000"
Body
Request to create an account-funded transfer.
Public account ID to debit.
14 - 42Public account ID to credit.
14 - 42Asset ticker symbol to transfer. Currency assets and tokenized assets such as xStocks are supported when eligible for transfers.
1 - 16Positive amount to transfer, denominated in asset and represented as a string to preserve precision.
1 - 64^[0-9]+(\.[0-9]+)?$Response
Transfer created. Replaying an unchanged request with the same idempotency key returns the transfer's current recorded outcome. It may differ from the first response and does not include an Idempotent-Replayed header.
Response returned after creating a transfer.
Created transfer.
Show child attributes
Show child attributes