Transactions API

This is the Transactions API that provides programmatic access to various resources and services. The API supports the following areas: Transactions Management, Personal Finance Management. All endpoints require authentication using a Bearer token.

The transactions model

The transactions model contains all the information about your transactions entities.

Properties

Name
frequency
Type
string
Description
Value for frequency
Name
startDate
Type
string
Description
Value for startDate
Name
endDate
Type
string
Description
Value for endDate
Name
executionDay
Type
integer
Description
Integer value for executionDay
Name
isActive
Type
boolean
Description
Boolean flag indicating isActive
Name
description
Type
string
Description
Detailed description of description

Set Transaction as Recurring

Configures a one-time transaction to repeat automatically at set intervals.

Required attributes

Name
transactionId
Type
string
Description
Unique identifier specified in the URL path

Request

POST

/v1/transactions/{transactionId}/recurring

curl -X POST https://api.adiba.app/v1/transactions/{transactionId}/recurring \
  -H "Authorization: Bearer {token}" \
  -d '{
"frequency": "MONTHLY",
"startDate": "2024-12-01T00:00:00Z",
"endDate": "2025-12-01T00:00:00Z",
"executionDay": 1,
"isActive": true,
"description": "Monthly rent payment"
}'

{
"status": "SUCCESS",
"recurringId": "REC_001_20241201_001",
"transactionId": "TXN_001_20241201_001",
"frequency": "MONTHLY",
"startDate": "2024-12-01T00:00:00Z",
"endDate": "2025-12-01T00:00:00Z",
"executionDay": 1,
"isActive": true,
"nextExecutionDate": "2025-01-01T00:00:00Z",
"createdAt": "2024-12-01T10:30:00Z",
"message": "Recurring transaction set successfully"
}

List Transaction Tags

Fetches a list of all existing tags for categorizing transactions.

Request

GET

/v1/transactions/tags

curl -G https://api.adiba.app/v1/transactions/tags \
  -H "Authorization: Bearer {token}"

{
"tags": [
    {
        "tagId": "TAG_001",
        "tagName": "Food & Dining",
        "tagColor": "#FF6B6B",
        "tagIcon": "🍽️",
        "description": "Restaurant and food expenses",
        "isDefault": true,
        "isActive": true,
        "transactionCount": 25,
        "createdAt": "2024-01-01T00:00:00Z"
    },
    {
        "tagId": "TAG_002",
        "tagName": "Transportation",
        "tagColor": "#4ECDC4",
        "tagIcon": "🚗",
        "description": "Transport and travel expenses",
        "isDefault": true,
        "isActive": true,
        "transactionCount": 15,
        "createdAt": "2024-01-01T00:00:00Z"
    }
],
"pagination": {
    "page": 1,
    "size": 10,
    "total": 20,
    "hasNext": true,
    "hasPrevious": false
}
}

Create Transaction Tags

Defines a new custom tag for personal transaction classification.

Request

POST

/v1/transactions/tags

curl -X POST https://api.adiba.app/v1/transactions/tags \
  -H "Authorization: Bearer {token}" \
  -d '{
"tagName": "Entertainment",
"tagColor": "#45B7D1",
"tagIcon": "🎬",
"description": "Movies, games, and entertainment expenses",
"isDefault": false
}'

{
"status": "SUCCESS",
"tagId": "TAG_003",
"tagName": "Entertainment",
"tagColor": "#45B7D1",
"tagIcon": "🎬",
"description": "Movies, games, and entertainment expenses",
"isDefault": false,
"isActive": true,
"createdAt": "2024-12-01T10:30:00Z",
"message": "Transaction tag created successfully"
}

Update Transaction Tags

Modifies the name or properties of an existing transaction tag.

Required attributes

Name
tagId
Type
string
Description
Unique identifier specified in the URL path

Request

PUT

/v1/transactions/tags/{tagId}

curl -X PUT https://api.adiba.app/v1/transactions/tags/{tagId} \
  -H "Authorization: Bearer {token}" \
  -d '{
"tagName": "Food & Dining Updated",
"tagColor": "#FF8E53",
"tagIcon": "🍕",
"description": "Updated restaurant and food expenses",
"isActive": true
}'

{
"status": "SUCCESS",
"tagId": "TAG_001",
"tagName": "Food & Dining Updated",
"tagColor": "#FF8E53",
"tagIcon": "🍕",
"description": "Updated restaurant and food expenses",
"isActive": true,
"updatedAt": "2024-12-01T10:35:00Z",
"message": "Transaction tag updated successfully"
}

Delete Transaction Tags

Permanently removes a specific transaction tag from the system.

Required attributes

Name
tagId
Type
string
Description
Unique identifier specified in the URL path

Request

DELETE

/v1/transactions/tags/{tagId}

curl -X DELETE https://api.adiba.app/v1/transactions/tags/{tagId} \
  -H "Authorization: Bearer {token}" \
  -d '{
"example": "data"
}'

{
"status": "SUCCESS",
"tagId": "TAG_003",
"tagName": "Entertainment",
"deletedAt": "2024-12-01T10:40:00Z",
"message": "Transaction tag deleted successfully",
"affectedTransactions": 0
}

Tag Transaction

Applies one or more existing tags to a specific transaction.

Required attributes

Name
transactionId
Type
string
Description
Unique identifier specified in the URL path

Request

POST

/v1/transactions/{transactionId}/tag

curl -X POST https://api.adiba.app/v1/transactions/{transactionId}/tag \
  -H "Authorization: Bearer {token}" \
  -d '{
"tagIds": [
    "TAG_001",
    "TAG_002"
],
"notes": "Lunch with colleagues"
}'

{
"status": "SUCCESS",
"transactionId": "TXN_001_20241201_001",
"tagIds": [
    "TAG_001",
    "TAG_002"
],
"tagNames": [
    "Food & Dining Updated",
    "Transportation"
],
"notes": "Lunch with colleagues",
"taggedAt": "2024-12-01T10:45:00Z",
"message": "Transaction tagged successfully"
}

Undo Transaction

Reverts a completed transaction, returning funds to the source account.

Required attributes

Name
transactionId
Type
string
Description
Unique identifier specified in the URL path

Request

POST

/v1/transactions/{transactionId}/reverse

curl -X POST https://api.adiba.app/v1/transactions/{transactionId}/reverse \
  -H "Authorization: Bearer {token}" \
  -d '{
"reason": "Incorrect amount",
"narration": "Transaction reversal due to incorrect amount",
"acknowledgeTerms": true
}'

{
"status": "SUCCESS",
"transactionId": "REV_001_20241201_001",
"originalTransactionId": "TXN_001_20241201_001",
"reason": "Incorrect amount",
"narration": "Transaction reversal due to incorrect amount",
"reversedAmount": 5000,
"reversedAt": "2024-12-01T10:50:00Z",
"reversalReference": "REV_REF_001",
"message": "Transaction reversed successfully"
}

Dispute Transaction

Initiates a formal claim to challenge an unauthorized or incorrect charge.

Required attributes

Name
transactionId
Type
string
Description
Unique identifier specified in the URL path

Request

POST

/v1/transactions/{transactionId}/dispute

curl -X POST https://api.adiba.app/v1/transactions/{transactionId}/dispute \
  -H "Authorization: Bearer {token}" \
  -d '{
"disputeReason": "UNAUTHORIZED",
"disputeAmount": 15000,
"description": "I did not authorize this transaction",
"supportingDocuments": [
    "receipt.pdf",
    "screenshot.jpg"
],
"contactPhone": "+2348012345678",
"contactEmail": "john.doe@email.com"
}'

{
"status": "SUCCESS",
"disputeId": "DISP_001_20241201_001",
"transactionId": "TXN_001_20241201_001",
"disputeReason": "UNAUTHORIZED",
"disputeAmount": 15000,
"description": "I did not authorize this transaction",
"disputeStatus": "PENDING",
"submittedAt": "2024-12-01T10:55:00Z",
"estimatedResolutionTime": "10-15 business days",
"disputeReference": "DISP_REF_001",
"message": "Dispute submitted successfully"
}