Widget requisites managing
In some cases, there is the possibility to add crypto requisites instead of the customer
Managing Requisites
In some cases, an institution can pre-add saved requisites (crypto-addresses) for its customers. The following endpoints are used to manage these requisites:
1. Add Requisite
- Method:
POST
- Endpoint:
/v2/requisite/add
- Description: Adds a new requisite for the customer.
Request:
{
"type": "Crypto",
"paymentMethodType": "Withdraw",
"walletId": "00000000-0000-0000-0000-000000000000",
"name": "Name of requisite",
"source": "eth",
"asset": "string",
"fields": {}
}
Response:
{
"data": {
"id": "00000000-0000-0000-0000-000000000000",
"type": "Crypto",
"paymentMethodType": "Withdraw",
"asset": "BTC",
"source": "eth",
"name": "eth",
"mask": "eth",
"walletId": "00000000-0000-0000-0000-000000000000",
"createdAt": "2021-10-01T00:00:00.000Z"
}
}
2. Find Requisites
- Method:
POST
- Endpoint:
/v2/requisite/find
- Description: Searches for saved requisites for a specific customer.
Request:
{
"type": "Crypto",
"paymentMethodType": "Deposit",
"source": "trx",
"walletId": "Deposit",
"asset": "ETH"
}
Response:
{
"data": [
{
"id": "00000000-0000-0000-0000-000000000000",
"type": "Crypto",
"paymentMethodType": "Withdraw",
"asset": "BTC",
"source": "eth",
"name": "eth",
"mask": "eth",
"walletId": "00000000-0000-0000-0000-000000000000",
"createdAt": "2021-10-01T00:00:00.000Z"
}
]
}
3. Get Requisite Details
- Method:
POST
- Endpoint:
/v2/requisite/details
- Description: Retrieves details of a specific requisite by its ID.
Request:
{
"id": "b2b4f9c0-5f5c-4e3f-9f4d-5f9d8b1c8d3c",
"walletId": "8f60cb5e-7917-4ea1-9fc1-4a44a6edf98a"
}
Response:
{
"data": {
"id": "00000000-0000-0000-0000-000000000000",
"type": "Crypto",
"paymentMethodType": "Withdraw",
"asset": "BTC",
"source": "eth",
"name": "eth",
"mask": "eth",
"walletId": "00000000-0000-0000-0000-000000000000",
"createdAt": "2021-10-01T00:00:00.000Z"
}
}
4. Update Requisite
- Method:
POST
- Endpoint:
/v2/requisite/update
- Description: Updates the name of an existing requisite.
Request:
{
"id": "b2b4f9c0-5f5c-4e3f-9f4d-5f9d8b1c8d3c",
"walletId": "087cd1b3-a393-44cd-b914-f8fe7b63a635",
"name": "string"
}
Response:
{
"data": {
"success": true
}
}
5. Remove Requisite
- Method:
POST
- Endpoint:
/v2/requisite/remove
- Description: Removes a saved requisite.
Request:
{
"id": "b2b4f9c0-5f5c-4e3f-9f4d-5f9d8b1c8d3c"
}
Response:
{
"data": {
"success": true
}
}
Notes
- Before using the endpoints, make sure you have the necessary access rights.
Updated about 1 month ago