Powered by Redocly

Transfer Config

This section give's control for transfer rules (transfer config).
Transfer rule must be provided with currency and threshold.
Transfer will be approved automatically in case the transfer amount is below the threshold.
Any transfer amount above the threshold must be approved by admin.
Admin logged in - can create,edit or delete any transfer rule per currency.
User logged in - dont have access to transfer config.

Show Transfer Config

Returns details of a specific transfer configuration.

Request
path Parameters
config_id
required
string

ID of the config

Responses
200

Transfer config details retrieved successfully

get/transfers/config/{config_id}
Response samples
application/json
{
  • "api_message": "TRANSFER_CONFIG_GET_SHOW_SUCCESS",
  • "api_data": {
    }
}

Update Transfer Config

Updates an existing transfer configuration.

Request
path Parameters
config_id
required
string

ID of the config

Request Body schema: application/json
required
currency_id
required
string
threshold
required
number
Responses
200

Transfer config updated successfully

put/transfers/config/{config_id}
Request samples
application/json
{
  • "currency_id": "string",
  • "threshold": 0
}
Response samples
application/json
{
  • "api_message": "TRANSFER_CONFIG_PUT_SUCCESS",
  • "api_data": {
    }
}

Delete Transfer Config

Deletes a transfer configuration.

Request
path Parameters
config_id
required
string

ID of the config

Responses
200

Transfer config deleted successfully

delete/transfers/config/{config_id}
Response samples
application/json
{
  • "api_message": "TRANSFER_CONFIG_DELETE_SUCCESS"
}

List Transfer Configs

Returns a list of transfer configurations.

Responses
200

Transfer configs listed successfully

get/transfers/config
Response samples
application/json
{
  • "api_message": "TRANSFER_CONFIG_GET_LIST_SUCCESS",
  • "api_data": [
    ]
}

Create Transfer Config

Creates a new transfer configuration.

Request
Request Body schema: application/json
required
currency_id
required
string
threshold
required
number
Responses
200

Transfer config created successfully

post/transfers/config
Request samples
application/json
{
  • "currency_id": "string",
  • "threshold": 0
}
Response samples
application/json
{
  • "api_message": "TRANSFER_CONFIG_POST_SUCCESS",
  • "api_data": {
    }
}
➔ Next to Users