For AI agents: visit https://alfredpay.readme.io/llms.txt for an index of all pages formatted in Markdown and endpoints in OpenAPI. Append .md to any documentation page URL to get its markdown version.

Jump to Content

Documentation APIs

APIs

Jump to Content

Documentation APIs

Alfred API

Customers
Onboarding
Endorsements
- List what this customer is allowed to doget
- Request an endorsementpost
Virtual Accounts
Deposits
Balances
Quotes
- Price a currency pairpost
- Retrieve a quoteget
Conversions
- Execute a conversionpost
- Retrieve a conversionget
Linked Accounts
Payouts
Refunds
Transactions
Webhooks
Sandbox
- Simulate a deposit (sandbox only)post
- Activate a destination instantly (sandbox only)post
Events

Powered by

Alfred API
Events

A deposit moved on one of its four state machines

webhook

deposit.updated

Payload

id

string

required

Deduplicate on this.

type

string

required

created

date-time

required

resource_version

integer

required

Monotonic per resource. Apply in this order; ordering of delivery is not guaranteed.

data

object

required

Response

200

Acknowledged

Updated 7 days ago

An unannounced deposit was detected

A deposit settled and the funds are spendable

Did this page help you?

Loading…

Updated 7 days ago

An unannounced deposit was detected

A deposit settled and the funds are spendable

Did this page help you?