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

Documentation Index

Fetch the complete documentation index at: https://docs.getcarbon.co/llms.txt

Use this file to discover all available pages before exploring further.

​
Overview

This endpoint retrieves the current transfer limits configured for the specified account.

​
Request

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

​
Parameters

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

​
Response

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

​
Example Response

{
  "status": "success",
  "message": "Transfer limits fetched successfully",
  "data": {
    "per_transaction_limit": 500000,
    "daily_transfer_limit": 2000000
  }
}
Note: All limit values are in the smallest currency unit (kobo for NGN).

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

Response

OK

The response is of type object.