GET
/
v1
/
accounts
/
{account_number}
/
transactions
/
{reference}
curl --request GET \
  --url https://carbonapistagingsecure.getcarbon.co/baas/api/v1/accounts/{account_number}/transactions/{reference} \
  --header 'apikey: <api-key>' \
  --header 'x-carbon-key: <x-carbon-key>'
{
  "status": "success",
  "message": "transaction fetched successfully",
  "data": {
    "success": true,
    "message": "Successful",
    "statusCode": "00",
    "transaction": {
      "wasReversed": false,
      "amount": 20050,
      "description": "Transfer from Gabriel Fuja (TRF/2000/10009/0001) ",
      "category": "Fund Transfer",
      "uniqueRef": "203018641660868",
      "internalRef": "991042",
      "transactionType": "DEBIT",
      "entryDate": "2024-02-20T13:18:40.000+0000",
      "updatedDate": "2024-02-20T13:18:42.000+0000",
      "internal": false,
      "accountId": "6009490194",
      "externalStatus": "PENDING"
    }
  }
}

​
Overview

This endpoint retrieves the transaction details for a specific account and reference.

​
HTTP Request

GET /v1/accounts/{account_number}/transactions/{reference}

​
Parameters

  • Header: x-carbon-key (string, required) - API key for authentication.
  • Path:
    • account_number (integer, required) - The account number.
    • reference (integer, required) - The transaction reference.

​
Example Response

{
  "status": "success",
  "message": "transaction fetched successfully",
  "data": {
    "success": true,
    "message": "Successful",
    "statusCode": "00",
    "transaction": {
      "wasReversed": false,
      "amount": 0,
      "description": "",
      "category": "",
      "uniqueRef": "",
      "internalRef": "",
      "transactionType": "",
      "entryDate": "",
      "updatedDate": "",
      "internal": true,
      "accountId": "",
      "externalStatus": ""
    }
  }
}

Authorizations

​
apikey
string
header
required

Provide your API key in the 'apikey' header.

Headers

​
x-carbon-key
string
required

Path Parameters

​
account_number
integer
required
​
reference
integer
required

Response

200 - application/json

OK

The response is of type object.

GET
/
v1
/
accounts
/
{account_number}
/
transactions
/
{reference}
curl --request GET \
  --url https://carbonapistagingsecure.getcarbon.co/baas/api/v1/accounts/{account_number}/transactions/{reference} \
  --header 'apikey: <api-key>' \
  --header 'x-carbon-key: <x-carbon-key>'
{
  "status": "success",
  "message": "transaction fetched successfully",
  "data": {
    "success": true,
    "message": "Successful",
    "statusCode": "00",
    "transaction": {
      "wasReversed": false,
      "amount": 20050,
      "description": "Transfer from Gabriel Fuja (TRF/2000/10009/0001) ",
      "category": "Fund Transfer",
      "uniqueRef": "203018641660868",
      "internalRef": "991042",
      "transactionType": "DEBIT",
      "entryDate": "2024-02-20T13:18:40.000+0000",
      "updatedDate": "2024-02-20T13:18:42.000+0000",
      "internal": false,
      "accountId": "6009490194",
      "externalStatus": "PENDING"
    }
  }
}

​
Overview

This endpoint retrieves the transaction details for a specific account and reference.

​
HTTP Request

GET /v1/accounts/{account_number}/transactions/{reference}

​
Parameters

  • Header: x-carbon-key (string, required) - API key for authentication.
  • Path:
    • account_number (integer, required) - The account number.
    • reference (integer, required) - The transaction reference.

​
Example Response

{
  "status": "success",
  "message": "transaction fetched successfully",
  "data": {
    "success": true,
    "message": "Successful",
    "statusCode": "00",
    "transaction": {
      "wasReversed": false,
      "amount": 0,
      "description": "",
      "category": "",
      "uniqueRef": "",
      "internalRef": "",
      "transactionType": "",
      "entryDate": "",
      "updatedDate": "",
      "internal": true,
      "accountId": "",
      "externalStatus": ""
    }
  }
}

Authorizations

​
apikey
string
header
required

Provide your API key in the 'apikey' header.

Headers

​
x-carbon-key
string
required

Path Parameters

​
account_number
integer
required
​
reference
integer
required

Response

200 - application/json

OK

The response is of type object.