Quick Start

Wyre provides a robust suite of functionalities. This is a quick guide to introduce to our powerful APIs, so you can get to building.

Dive In

At Wyre, we provide all of the tools necessary for you to get your crypto app up and running within a few minutes.

For a deep overview of all of Wyre's endpoints see our API Methods here.

Once you have a good idea of what our endpoints are capable of, it is time to build the next big thing. The Wyre team has built a full scale exchange style app, theWyre Experience, featuring our most prominent endpoints, to help you get started building something really cool instantly.

Obtain a TestWyre Account

If you want to get acquainted, you can start your experimentation with our APIs by creating a TestWyre account. TestWyre is our test environment.

Authentication / Environment Variables & Headers

After you have made a testnet account, you have the option of creating other various keys that can be utilized as well.

For authenticating your calls, you can either set up environments or send the Key-Value pairs using the method of your choice. Check out how to set up environments in various languages/frameworks such as Python, Angular , React and Postman.

In the table below are the environment variable names you'll need to have to be able to utilize our APIs. The variable names are case sensitive.

Key

Value

WYRE_APIKEY

Your API Key

WYRE_TOKEN

Your Secret Token

ACCOUNT_ID

Your Account ID

publicToken

Your public token (Insert an Empty String)

Creating Users

The first request after completing the auth token submission will typically be creating a new user. Make sure you supply the submitted bearer token when you hit this endpoint. After the user is created, the bearer token will now be associated with it. The rest of the API will now be available to it (and attempting user creation again with it will fail).

Once you have created a user, you will need to submit the documents related to the user in order to verify and start using all of Wyre's features if you have not done so during the creating a new user step.

Create Payment Method

Once you have users set up, you need to link payment methods to those accounts to start transacting. You also need to upload bank documents in order for your linked payment method to get validated.

Wallets

Once you have gotten to this point, you are ready to create new wallets and start creating transactions and transfers between wallets. You can spin up multiple wallets at a time and update the information specified for your given wallets.

We also offer Wyre+ Rewards Wallets which allows your users to earn yields on their assets.

Hosted Checkout

The Wyre Checkout widget is a turnkey solution that makes it easy for your end-users to use fiat to purchase cryptocurrency with the world’s most popular payment methods (ACH, Credit/Debit Cards, Apple Pay). Through our hosted checkout, you can offer your customers a fast and secure way to purchase cryptocurrency eliminating the need to build your own KYC process or checkout UI.

Our Checkout flow starts with creating a Wallet Order Reservation which sends users to the checkout widget flow.

We provide you with the ability to Check User Limits, GET Wallet Orders, and Track Wallet Orders, that allows you to keep track of what is going on throughout your enterprise.

White-Label Card Processing

If you want to simply use the function of our Card Processing API to process debit and credit cards & Apple Pay, you will need to generate a Wallet Order Reservation first, after which you can Create an Order. Our APIs are robust enough to Refund Orders and provide you with powerful awareness of the status of all orders.

Note: partners must fulfill certain requirements before implementing self-hosted card processing such as this.

Transfers and Exchanges

The Transfers API is Wyre's engineered solution for moving funds across different platforms ranging from accounts, payments methods, wallets or blockchain addresses. With the ability to GET limits, exchange rates, and understand the status of all transfers, you can rest assured that you are covered from all angles.

Swaps

The Swaps API is used to generate a funding address for the Crypto to Crypto swap without specifying the source amount and the rate locking limitation of a transfer. Normally, transfers have their totals and rates locked upfront; however, the Swaps API can allow you to defer calculating the total amount until the funds arrive.