Skip to main content
PUT
/
v1
/
accounts
/
{account_number}
/
transfer-limits
Update Transfer Limits
curl --request PUT \
  --url https://carbonapistagingsecure.getcarbon.co/baas/api/v1/accounts/{account_number}/transfer-limits \
  --header 'Content-Type: application/json' \
  --header 'apikey: <api-key>' \
  --header 'x-carbon-key: <x-carbon-key>' \
  --data '
{
  "per_transaction_limit": 500000,
  "daily_transfer_limit": 2000000
}
'
{
  "status": "success",
  "message": "Transfer limits updated successfully",
  "data": {
    "per_transaction_limit": 500000,
    "daily_transfer_limit": 2000000
  }
}

​
Overview

This endpoint updates the transfer limits for the specified account. At least one of the limit fields must be provided.

​
Request

Method: PUT
URL: /v1/accounts/{account_number}/transfer-limits

​
Parameters

NameInTypeRequiredDescription
x-carbon-keyHeaderstringYesAPI key for authentication.
account_numberPathstringYesThe account number to update limits for.

​
Request Body

FieldTypeRequiredDescription
per_transaction_limitintegerNoMaximum amount per single transaction. Must be ≥ 1.
daily_transfer_limitintegerNoMaximum total amount transferable per day. Must be ≥ 1 and cannot be less than per_transaction_limit.
At least one field must be provided. If both are provided, daily_transfer_limit must be ≥ per_transaction_limit. 
{
  "per_transaction_limit": 500000,
  "daily_transfer_limit": 2000000
}

​
Response

Status Code: 200 OK
Content-Type: application/json

​
Example Response

{
  "status": "success",
  "message": "Transfer limits updated successfully",
  "data": {
    "per_transaction_limit": 500000,
    "daily_transfer_limit": 2000000
  }
}
Note: All limit values are in naira. The data shape in successful responses mirrors what the upstream banking service returns and may include additional fields.

Authorizations

​
apikey
string
header
required

Provide your API key in the 'apikey' header.

Headers

​
x-carbon-key
string
required

Path Parameters

​
account_number
string
required

Body

application/json

Provide at least one transfer limit field to update.

​
per_transaction_limit
integer

Maximum amount per single transaction (in kobo).

Required range: x >= 1
​
daily_transfer_limit
integer

Maximum total amount transferable per day (in kobo). Cannot be less than per_transaction_limit.

Required range: x >= 1

Response

OK

The response is of type object.