Introduction
This guide will provide you with an overview of the available endpoints and their functionalities. Before you begin, please ensure you have the necessary credentials and access rights to use our API.
Create a Wallet Address
Endpoint: POST /wallet/crypto/address
Description:
This endpoint allows you to create a new wallet address and attach it to a customer
curl --request POST \
--url https://sandbox.vella.finance/api/v1/wallet/crypto/address \
--header 'Authorization: Bearer {}' \
--header 'accept: application/json' \
--header 'content-type: application/json' \
--data '
{
"network": "POLYGON",
"coin": "USDC",
"customer": {
"name": "fuja",
"email": "[email protected]"
}
}
'
Retrieve Wallet Address by ID
Endpoint: GET /wallet/crypto/address/:id
Description:
This endpoint allows you to retrieve a wallet address by its unique ID.
curl --request GET \
--url https://sandbox.vella.finance/api/v1/wallet/crypto/address/:id \
--header 'Authorization: Bearer {}' \
--header 'accept: application/json'
Retrieve All Wallet Addresses
Endpoint: GET /wallet/crypto/address
Description:
This endpoint retrieves all the wallet addresses generated in your account.
curl --request GET \
--url https://sandbox.vella.finance/api/v1/wallet/crypto/address \
--header 'Authorization: Bearer {}' \
--header 'accept: application/json'
Consume Webhook
Description:
Transaction notification.
{
"type": "transaction.incoming.completed",
"data": {
"narration": "Received $100 from Vella Checkout",
"settlement_currency": "USDC",
"amount": 100,
"total": 100,
"hash":"095857565655454o83fd3ee0718cbf64b7190b50a9307a933c2efc2613",
"tnx_ref": "TRSVFV345345365365365",
"account": {
"id": "3425FGDHGHJH5677869890909",
"address": "0x3aebf43cbe34be8195bcdca743200dfafcc54834",
},
"sender":"0x3aebf43cbe34be8195bcdca743200dfafcc0000",
"customer": {
"name": "vella",
"email": "[email protected]",
},
"status": "successful",
"created_at": "2021-11-18T15:23:16.781",
"meta_data":[]
}
}
Response:
HTTP 200 OK (No response body)
Note: Make sure to configure your webhook URL in your account settings.
Verify Transaction
Always verify the transaction
This endpoint allows you to verify a transaction before giving value to the customer.
curl --request GET \
--url https://sandbox.vella.finance/api/v1/checkout/transaction/{reference}/verify \
--header 'Authorization: Bearer {}' \
--header 'accept: application/json'
We hope this API Introduction Guide helps you get started with our wallet service. For more detailed information about each endpoint, please refer to our API reference. If you have any further questions or require assistance, feel free to contact our support team at [email protected].