Liquidation Address

Where a payment's final destination will ultimately land for funds received into your local virtual account.

A “Liquidation Address” is a permanent payment route which ties an alfred Virtual account to a blockchain address. When a customer receives a FIAT deposit to an alfred generated Virtual Account, alfred automatically converts that deposit to USDC or USDT. The digital currency (USDC/T) is confirmed at the time of creation.


1. Create a New Liquidation Address

curl --request POST \  
  \--url https://penny-api-restricted-dev.alfredpay.io/api/v1/third-party-service/penny/liquidation-addresses/d4c64bf5-f373-4d8a-afe9-98a66f084787 \
  \--header 'Content-Type: application/json' \
  \--header 'accept: */*' \
  \--header 'api-key: alfredpay.3kievYX/8Np29gkoTt~9NhhwhksoaoDt' \
  \--header 'api-secret: Fk/Dlo48b6nP4~Ez-+20T_xc8+9GIhu+' \
  \--data '{
   "chain": "XLM",
   "currency": "USDC",
   "address": "GBLJYDV5E2DRB5X4JG3DVOG3I2BUJ2UPVFBPNLYVDNVGYEER2ZWIPRNE",
   "default": true,
   "memo": "TRANSACTION_001"
}'

Sample Response

{  
  "id": "f4991dbf-2a58-4246-9576-aa49c99d435b",
  "chain": "XLM",
  "currency": "USDC",
  "address": "GBLJYDV5E2DRB5X4JG3DVOG3I2BUJ2UPVFBPNLYVDNVGYEER2ZWIPRNE",
  "default": true,
  "memo": "TRANSACTION_001",
  "createdAt": "2025-07-29T16:21:03.210Z"
}

2. Get All Liquidation Addresses for a Customer

curl --request GET \\\
\--url [https://penny-api-restricted-dev.alfredpay.io/api/v1/third-party-service/penny/liquidation-addresses/d4c64bf5-f373-4d8a-afe9-98a66f084787](https://penny-api-restricted-dev.alfredpay.io/api/v1/third-party-service/penny/liquidation-addresses/d4c64bf5-f373-4d8a-afe9-98a66f084787) \
\--header 'accept: */*' \
\--header 'api-key: alfredpay.3kievYX/8Np29gkoTt~~9NhhwhksoaoDt' \
\--header 'api-secret: Fk/Dlo48b6nP4~~Ez-+20T\_xc8+9GIhu+'

Sample Response

{
    "id": "f4991dbf-2a58-4246-9576-aa49c99d435b",
    "chain": "XLM",
    "currency": "USDC",
    "address": "GBLJYDV5E2DRB5X4JG3DVOG3I2BUJ2UPVFBPNLYVDNVGYEER2ZWIPRNE",
    "default": true,
    "memo": "TRANSACTION_001",
    "createdAt": "2025-07-29T16:21:03.210Z"
  }

3. Get Specific Liquidation Address by ID

curl --request GET \\\
\--url [https://penny-api-restricted-dev.alfredpay.io/api/v1/third-party-service/penny/liquidation-addresses/d4c64bf5-f373-4d8a-afe9-98a66f084787/f4991dbf-2a58-4246-9576-aa49c99d435b](https://penny-api-restricted-dev.alfredpay.io/api/v1/third-party-service/penny/liquidation-addresses/d4c64bf5-f373-4d8a-afe9-98a66f084787/f4991dbf-2a58-4246-9576-aa49c99d435b) \
\--header 'accept: */*' \
\--header 'api-key: alfredpay.3kievYX/8Np29gkoTt~~9NhhwhksoaoDt' \
\--header 'api-secret: Fk/Dlo48b6nP4~~Ez-+20T\_xc8+9GIhu+'

Sample Response

{  
  "id": "f4991dbf-2a58-4246-9576-aa49c99d435b",
  "chain": "XLM",
  "currency": "USDC",
  "address": "GBLJYDV5E2DRB5X4JG3DVOG3I2BUJ2UPVFBPNLYVDNVGYEER2ZWIPRNE",
  "default": true,
  "memo": "TRANSACTION_001",
  "createdAt": "2025-07-29T16:21:03.210Z"
}

4. Update an Existing Liquidation Address

curl --request PUT \  
  \--url https://penny-api-restricted-dev.alfredpay.io/api/v1/third-party-service/penny/liquidation-addresses/d4c64bf5-f373-4d8a-afe9-98a66f084787/baf99f74-6bcd-4746-9121-b54928e80a3b \
  \--header 'Content-Type: application/json' \
  \--header 'accept: */*' \
  \--header 'api-key: alfredpay.3kievYX/8Np29gkoTt~9NhhwhksoaoDt' \
  \--header 'api-secret: Fk/Dlo48b6nP4~Ez-+20T_xc8+9GIhu+' \
  \--data '{
    "default": true
}'

Sample Response

\{  
  "id": "baf99f74-6bcd-4746-9121-b54928e80a3b",
  "default": true,
  "updatedAt": "2025-07-29T16:35:15.001Z"
}

5. Get Default Address for a Customer

curl --request GET \\\
\--url [https://penny-api-restricted-dev.alfredpay.io/api/v1/third-party-service/penny/liquidation-addresses/d4c64bf5-f373-4d8a-afe9-98a66f084787/default](https://penny-api-restricted-dev.alfredpay.io/api/v1/third-party-service/penny/liquidation-addresses/d4c64bf5-f373-4d8a-afe9-98a66f084787/default) \
\--header 'accept: */*' \
\--header 'api-key: alfredpay.3kievYX/8Np29gkoTt~~9NhhwhksoaoDt' \
\--header 'api-secret: Fk/Dlo48b6nP4~~Ez-+20T\_xc8+9GIhu+'

Sample Response

\{  
  "id": "baf99f74-6bcd-4746-9121-b54928e80a3b",
  "chain": "XLM",
  "currency": "USDC",
  "address": "GBLJYDV5E2DRB5X4JG3DVOG3I2BUJ2UPVFBPNLYVDNVGYEER2ZWIPRNE",
  "default": true,
  "memo": "TRANSACTION_001",
  "createdAt": "2025-07-29T16:21:03.210Z"
}

6. Get Address History by Customer

curl --request GET \\\
\--url '[https://penny-api-restricted-dev.alfredpay.io/api/v1/third-party-service/penny/liquidation-addresses/d4c64bf5-f373-4d8a-afe9-98a66f084787/history?page=1\&limit=10\&order=ASC\&startDate=2025-01-01T00%3A00%3A00.000Z\&endDate=2025-12-31T23%3A59%3A59.999Z](https://penny-api-restricted-dev.alfredpay.io/api/v1/third-party-service/penny/liquidation-addresses/d4c64bf5-f373-4d8a-afe9-98a66f084787/history?page=1\&limit=10\&order=ASC\&startDate=2025-01-01T00%3A00%3A00.000Z\&endDate=2025-12-31T23%3A59%3A59.999Z)' \
\--header 'accept: */*' \
\--header 'api-key: alfredpay.3kievYX/8Np29gkoTt~~9NhhwhksoaoDt' \
\--header 'api-secret: Fk/Dlo48b6nP4~~Ez-+20T\_xc8+9GIhu+'

Sample Response

{
      "id": "f4991dbf-2a58-4246-9576-aa49c99d435b",
      "chain": "XLM",
      "currency": "USDC",
      "action": "CREATE",
      "timestamp": "2025-07-29T16:21:03.210Z"
    }
  ]
}

7. Get All Liquidation Address Activity

curl --request GET \\\
\--url '[https://penny-api-restricted-dev.alfredpay.io/api/v1/third-party-service/penny/liquidation-addresses/activity?page=3\&limit=2\&order=DESC\&startDate=2025-01-01T00%3A00%3A00.000Z\&endDate=2025-12-31T23%3A59%3A59.999Z](https://penny-api-restricted-dev.alfredpay.io/api/v1/third-party-service/penny/liquidation-addresses/activity?page=3\&limit=2\&order=DESC\&startDate=2025-01-01T00%3A00%3A00.000Z\&endDate=2025-12-31T23%3A59%3A59.999Z)' \
\--header 'accept: */*' \
\--header 'api-key: alfredpay.3kievYX/8Np29gkoTt~~9NhhwhksoaoDt' \
\--header 'api-secret: Fk/Dlo48b6nP4~~Ez-+20T\_xc8+9GIhu+'

Sample Response

{
	"data": [
		{
			"customerId": "d4c64bf5-f373-4d8a-afe9-98a66f084787",
			"customerEmail": "[email protected]",
			"action": "CREATE",
			"chain": "TRX",
			"currency": "USDT",
			"address": "TK94FEQcDBmG1Hy27fTH1v5fuk6P5MqjZP",
			"default": false
		},
		{
			"customerId": "d4c64bf5-f373-4d8a-afe9-98a66f084787",
			"customerEmail": "[email protected]",
			"action": "CREATE",
			"chain": "TRX",
			"currency": "USDT",
			"address": "TCyhPXvog7oiC18zZkxaJAjHjPSbj5gu1W",
			"default": true
		}
	],
	"meta": {
		"page": 3,
		"limit": 2,
		"total": 6,
		"totalPages": 3,
		"hasNextPage": false,
		"hasPreviousPage": true
	}
}