API Reference

System Resource Names

Referencing objects within Wyre's platform.

System Resource Name (SRN)

System Resource Name is a typed identifier that may reference any object within the Wyre platform. Many of our API calls and data schemas leverage SRNs in order to add flexibility and decouple services. All SRNs follow the same URI-like format:

type:identifier

Some common types you are likely to encounter from our API

TypeDescription
paymentmethod:A payment method such as a bank account, e.g. paymentmethod:PA_XXXXXXXX
email:An email address, e.g. email:[email protected]
cellphone:A cellphone number, e.g. cellphone:+15555555555
bitcoin:Bitcoin blockchain addresses. e.g. bitcoin:1BvBMSEYstWetqTFn5Au4m4GFg7xJaNVN2

NOTE: TestWyre expects a Bitcoin testnet address i.e. bitcoin:n4VQ5YdHf7hLQ2gWQYYrcxoE5B7nWuDFNF.
ethereum:Ethereum blockchain address. e.g.
ethereum:0xBB9bc244D798123fDe783fCc1C72d3Bb8C189413

NOTE:
Transfers of ERC-20 tokens use the "ethereum:" SRN.
avalanche:Avalanche (AVAX) blockchain addresses (X and C chains). e.g.
X Chain:
avalanche:X-fuji159ney792ctzweqfhuc39rkp0h8fsmzjhu4fjk4
C Chain:
avalanche:0x6b53a58cf99b698afe78035e58f1a8f5f8235663
stellar:Stellar (XLM) blockchain address. e.g.
stellar:GD7WXI7AOAK2CIPZVBEFYLS2NQZI2J4WN4HFYQQ4A2OMFVWGWAL3IW7K:LEMNM383ACX

NOTE:
Transfers from an external stellar address will require the User ID in the memo.
algorand:Algorand (ALGO and aUSDC) blockchain address.
matic:Polygon (MATIC) blockchain address.
flow:Flow blockchain address. e.g.
flow:0xead892083b3e2c6c
algorand:Algorand blockchain address.
loopring:Loopring blockchain address.
account:A Wyre account, e.g. account:AC_XXXXXXXX
user:A Wyre user, e.g. user:US_XXXXXXXX
wallet:A single wallet that can hold cryptocurrency, e.g. wallet:WA_XXXXXXXX
transfer:A transfer (possibly including a conversion) of currency
:achThis is attached as a suffix to the payment method when pulling funds into and account via ACH.

Example:
"source": "paymentmethod:PA-W7YN28ABCHT:ach"