Standing Instruction API

This is the Standing Instruction API that provides programmatic access to various resources and services. The API supports the following areas: Manage Standing Instuctions. All endpoints require authentication using a Bearer token.

The mandates model

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

Properties

Name
mandates
Type
array
Description
List of mandates items
Name
pagination
Type
object
Description
Object containing pagination data

List Standing Instructions

Fetches all recurring payment or transaction mandates for a specific user.

Request

GET

/v1/mandates

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

{
"mandates": [
    {
        "mandateId": "MAND_001_20241201_001",
        "mandateName": "Monthly Rent Payment",
        "mandateType": "PAYMENT",
        "amount": 500000,
        "currency": "NGN",
        "frequency": "MONTHLY",
        "startDate": "2024-12-01T00:00:00Z",
        "endDate": "2025-12-01T00:00:00Z",
        "nextExecutionDate": "2025-01-01T00:00:00Z",
        "status": "ACTIVE",
        "beneficiaryAccount": "1234567890",
        "beneficiaryName": "Landlord Properties Ltd",
        "description": "Monthly rent payment for apartment"
    },
    {
        "mandateId": "MAND_002_20241201_001",
        "mandateName": "Weekly Savings",
        "mandateType": "SAVINGS",
        "amount": 25000,
        "currency": "NGN",
        "frequency": "WEEKLY",
        "startDate": "2024-12-01T00:00:00Z",
        "endDate": null,
        "nextExecutionDate": "2024-12-08T00:00:00Z",
        "status": "ACTIVE",
        "beneficiaryAccount": "SAV_001",
        "beneficiaryName": "Savings Account",
        "description": "Weekly savings contribution"
    }
],
"pagination": {
    "page": 1,
    "size": 10,
    "total": 2,
    "hasNext": false,
    "hasPrevious": false
}
}

Create Standing Instruction

Establishes a new automated recurring payment or transaction mandate.

Request

POST

/v1/mandates

curl -X POST https://api.adiba.app/v1/mandates \
  -H "Authorization: Bearer {token}" \
  -d '{
"mandateName": "Monthly Rent Payment",
"mandateType": "PAYMENT",
"amount": 500000,
"currency": "NGN",
"frequency": "MONTHLY",
"startDate": "2024-12-01T00:00:00Z",
"endDate": "2025-12-01T00:00:00Z",
"beneficiaryAccount": "1234567890",
"beneficiaryName": "Landlord Properties Ltd",
"description": "Monthly rent payment for apartment",
"sourceAccount": "ACC_001",
"executionDay": 1,
"isActive": true
}'

{
"status": "ACTIVE",
"mandateId": "MAND_001_20241201_001",
"mandateName": "Monthly Rent Payment",
"mandateType": "PAYMENT",
"amount": 500000,
"currency": "NGN",
"frequency": "MONTHLY",
"startDate": "2024-12-01T00:00:00Z",
"endDate": "2025-12-01T00:00:00Z",
"nextExecutionDate": "2025-01-01T00:00:00Z",
"beneficiaryAccount": "1234567890",
"beneficiaryName": "Landlord Properties Ltd",
"createdAt": "2024-12-01T10:30:00Z",
"message": "Standing instruction created successfully"
}

Read Standing Instruction Details

Retrieves detailed information of a specific standing instruction mandate.

Required attributes

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

Request

GET

/v1/mandates/{mandateId}

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

{
"mandateId": "MAND_001_20241201_001",
"mandateName": "Monthly Rent Payment",
"mandateType": "PAYMENT",
"amount": 500000,
"currency": "NGN",
"frequency": "MONTHLY",
"startDate": "2024-12-01T00:00:00Z",
"endDate": "2025-12-01T00:00:00Z",
"nextExecutionDate": "2025-01-01T00:00:00Z",
"status": "ACTIVE",
"beneficiaryAccount": "1234567890",
"beneficiaryName": "Landlord Properties Ltd",
"description": "Monthly rent payment for apartment",
"createdAt": "2024-12-01T10:30:00Z",
"lastExecutedAt": "2024-12-01T00:00:00Z",
"executionCount": 1,
"totalAmountExecuted": 500000,
"executionHistory": [
    {
        "executionId": "EXEC_001",
        "executionDate": "2024-12-01T00:00:00Z",
        "amount": 500000,
        "status": "SUCCESS",
        "reference": "TXN_001_20241201_001"
    }
]
}

Modify existing mandate

Updates parameters like amount or frequency of a standing instruction.

Required attributes

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

Request

PUT

/v1/mandates/{mandateId}

curl -X PUT https://api.adiba.app/v1/mandates/{mandateId} \
  -H "Authorization: Bearer {token}" \
  -d '{
"mandateName": "Monthly Rent Payment Updated",
"amount": 550000,
"frequency": "MONTHLY",
"endDate": "2025-12-01T00:00:00Z",
"description": "Updated monthly rent payment for apartment",
"executionDay": 1,
"isActive": true
}'

{
"status": "SUCCESS",
"mandateId": "MAND_001_20241201_001",
"mandateName": "Monthly Rent Payment Updated",
"amount": 550000,
"frequency": "MONTHLY",
"endDate": "2025-12-01T00:00:00Z",
"nextExecutionDate": "2025-01-01T00:00:00Z",
"updatedAt": "2024-12-01T11:00:00Z",
"message": "Standing instruction updated successfully"
}

Deactivate mandate

Temporarily or permanently stops an automated standing instruction.

Required attributes

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

Request

DELETE

/v1/mandates/{mandateId}

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

{
"status": "SUCCESS",
"mandateId": "MAND_001_20241201_001",
"mandateName": "Monthly Rent Payment Updated",
"deactivatedAt": "2024-12-01T11:30:00Z",
"message": "Standing instruction deactivated successfully",
"cancellationReason": "User requested cancellation"
}