Developers can use the Alfred API to create customers, complete KYC/KYB onboarding, register payment methods, generate quotes, and initiate onramp or offramp transactions.

1. Create an Alfred Account

To begin, create an account in the Alfred dashboard.

Visit:

https://dashboard.alfredpay.io

Once your account is created, you can generate an API key pair from the dashboard. These credentials allow your application to authenticate with the Alfred API.

Your API credentials include

• api-key
• api-secret

These credentials must be included in the headers of every API request.

For security purposes, API credentials should always be stored securely on your backend and must never be exposed in client-side applications.

2. Environments

Alfred provides multiple environments for development, testing, and production use.

The sandbox environment allows developers to test API integrations without initiating real financial transactions. Transactions created in the sandbox environment do not interact with blockchain networks or banking rails and do not incur fees.

3. Authentication

All API requests must include the following headers:

Example request:

curl -X GET "{URL_BASE}/customers" \
  -H "api-key: YOUR_API_KEY" \
  -H "api-secret: YOUR_API_SECRET"

4. Make Your First API Request

A typical integration begins by creating a customer.

This endpoint creates a customer profile that can later be used for KYC onboarding and financial transactions.

Once a customer is created, your application can proceed with the onboarding and transaction workflows described in the integration guides.

Example Request

curl --request POST \
  --url https://penny-api-restricted-dev.alfredpay.io/api/v1/third-party-service/penny/customers/create \
  --header "accept: application/json" \
  --header "api-key: YOUR_API_KEY" \
  --header "api-secret: YOUR_API_SECRET" \
  --header "content-type: application/json" \
  --data '{
    "type": "INDIVIDUAL",
    "country": "AR",
    "email": "[email protected]"
  }'

Example Response

{
  "customerId": "db9c23d1-793e-4ec6-8c5a-cda5e6b67955",
  "createdAt": "2026-03-12T16:38:20.882Z"
}

5. Using the Postman Collection

To explore the Alfred API interactively, you can import the Alfred Postman collection.

Download the Postman collection here.

After importing the collection:

1. Create a Postman environment
2. Configure the following variables:

The collection includes requests for all available Alfred API endpoints and can be used to quickly test and understand the platform.