Overview

What the Alfred API does and how money moves through it.


Alfred lets you collect local currency and hold balances on behalf of customers you onboard yourself. You can also convert between currencies and assets, then pay out.

You are the partner. The customers you create sit underneath you, and every call you make is scoped by your API key. You never pass your own identifier anywhere.

You also have an account of your own. It holds your own balance and the recipients you pay from it, and calls on it take no customerId. See Balances and Payout destinations.

What you can do

* Collection: Issue a virtual account to a customer and receive local currency into it. Every deposit that lands on it is attributed to that customer.
* Holding: A customer's funds sit as balances. They can be held in stablecoin, or as a local stablecoin where one exists.
* Conversion: Price a currency pair, then execute against that price. This works for fiat to fiat, fiat to stablecoin, and stablecoin to stablecoin.
* Payout: Send to a registered bank account or wallet. A cross-currency payout converts as part of execution, so it's one transaction rather than two. You can pay out from a customer's balance, or from your own balance to recipients registered on your own account.

The shape of it

These are the five objects you will work with, in the order you'll meet them.

* Customers: You create one, fill in its profile, and submit it for verification. Until it's ACTIVE, it can't do anything.
* Endorsements: Each thing a customer is allowed to do is gated by an endorsement. You request one, wait for it to be approved, and only then call the endpoint it unlocks.
* Instruments: A virtual account receives fiat and a deposit address receives stablecoin. Both belong to a customer, and neither holds a balance.
* Balances: Money lives on the customer rather than on the instrument that received it. Your own account holds a balance too, and that is what funds payouts from your own account.
* Movements: Deposits, conversions and payouts are separate transactions that relate to each other. A deposit completing doesn't complete the conversion it funds, and that conversion doesn't complete the payout after it.

Two rules to build around

Routes decide what's possible. A combination of country, currency, destination type and rail is either supported or it isn't. GET /v1/countries/{country} is the authoritative answer. Anything not listed as LIVE is refused before anything is locked, so you find out at request time rather than at settlement.

Events drive the sequence. Nearly every flow has a step that's only correct after something has happened on our side. You don't poll for it. See Webhooks and events.


Did this page help you?