ZeeH Africa

https://zeehdocs.zeeh.africa
Admin
ZeeH Africa provides modern financial infrastructure for developers and internet companies in Africa...
Tokens:272,097
Snippets:541
Trust Score:6.2
Update:8 months ago
Show doc for...
Tokens:
Raw
### Install zeeh-connect-react using npm or yarn

Source: https://zeehdocs.zeeh.africa/endpoints/libraries-and-sdk/react-sdk

This snippet shows how to install the zeeh-connect-react library using either npm or yarn package managers. Ensure you have Node.js and npm/yarn installed.

```bash
npm install zeeh-connect-react
```

```bash
yarn add zeeh-connect-react
```

--------------------------------

### Subscription Payments Success Response Example

Source: https://zeehdocs.zeeh.africa/endpoints/endpoints-desk/direct-debit/subscription-payments

Example of a successful response when retrieving a list of subscription payments. Includes payment details, status, and metadata for pagination.

```javascript
{
  "success": true,
  "statusCode": 200,
  "message": "Subscription payments fetched",
  "response_code": "00",
  "data": {
    "payments": [
      {
        "_id": "68e25fa2d9f8c89121a7f23b",
        "customerFirstName": "Ngozi",
        "customerSurname": "Balogun",
        "customerEmail": "ngozi.balogun@example.com",
        "accountNumber": "0123456789",
        "bankCode": "057",
        "amount": 15000,
        "status": "active",
        "narration": "DSTV Premium Subscription",
        "repeatFrequency": "monthly",
        "repeatStartDate": "2025-10-01T08:00:00Z",
        "repeatEndDate": "2026-09-30T08:00:00Z",
        "createdAt": "2025-09-24T14:20:00.000Z"
      },
      {
        "_id": "68e2605aa7e9bdbd99c0a91f",
        "customerFirstName": "Tunde",
        "customerSurname": "Adeyemi",
        "customerEmail": "tunde.adeyemi@example.com",
        "accountNumber": "0334455667",
        "bankCode": "033",
        "amount": 20000,
        "status": "pending",
        "narration": "Gym Membership",
        "repeatFrequency": "monthly",
        "repeatStartDate": "2025-10-05T07:00:00Z",
        "repeatEndDate": "2026-10-04T07:00:00Z",
        "createdAt": "2025-09-24T14:25:00.000Z"
      }
    ],
    "meta": {
      "page": 1,
      "limit": 10,
      "total": 2,
      "totalPages": 1
    }
  }
}
```

--------------------------------

### Example Statement Response (JSON)

Source: https://zeehdocs.zeeh.africa/endpoints/endpoints-desk/statement/get-a-statement

This is an example of a successful JSON response when retrieving an account statement. It includes success status, status code, a message, response code, and a data object containing metadata and a list of transactions.

```json
{
    "success": true,
    "statusCode": 200,
    "message": "Statement",
    "response_code": "00",
    "data": {
        "meta": {
            "count": 18
        },
        "data": [
            {
                "type": "debit",
                "amount": -5.05,
                "narration": "SMS NOTIFICATION CHARGE FOR 2023 JU NE 1ST-30TH JUNE 2023 - NGN",
                "date": "2023-07-09",
                "closingBalance": 1039.69,
                "tranId": "FT23191Q55W7\IBO"
            },
            {
                "type": "credit",
                "amount": 4.86,
                "narration": "Interest - Capitalise- Credit Interest/  CAPITALISE",
                "date": "2023-07-01",
                "closingBalance": 1044.74,
                "tranId": "AAACT231812VNV7B71"
            }
        ]
    }
}
```

--------------------------------

### Install zeeh-connect-rn using npm or yarn

Source: https://zeehdocs.zeeh.africa/endpoints/libraries-and-sdk/react-native-sdk

Instructions for installing the zeeh-connect-rn package using either npm or yarn package managers.

```bash
npm install zeeh-connect-rn
```

```bash
yarn add zeeh-connect-rn
```

--------------------------------

### Mandates API Success Response Example

Source: https://zeehdocs.zeeh.africa/endpoints/endpoints-desk/direct-debit/mandates

This example shows the structure of a successful response when fetching mandates. It includes details about the mandates themselves, such as customer information, status, and creation date, as well as counts of mandates by status and pagination metadata.

```javascript
{
  "success": true,
  "statusCode": 200,
  "message": "Mandates fetched",
  "response_code": "00",
  "data": {
    "mandates": [
      {
        "_id": "68d2ce498ef59e5641e0b28d",
        "customerFirstName": "Adebayo",
        "customerSurname": "Olawale",
        "customerEmail": "adebayo.olawale@example.com",
        "customerMobileNo": "2348012345678",
        "bankAccountNumber": "0123456789",
        "status": "requested",
        "maxDebitAmountPerTransaction": 5000,
        "createdAt": "2025-09-23T16:43:53.993Z"
      },
      {
        "_id": "68d2787e0ab786c545dbd70c",
        "customerFirstName": "Chioma",
        "customerSurname": "Okafor",
        "customerEmail": "chioma.okafor@example.com",
        "customerMobileNo": "2348098765432",
        "bankAccountNumber": "0223344556",
        "status": "pending",
        "maxDebitAmountPerTransaction": 10000,
        "createdAt": "2025-09-23T10:37:50.621Z"
      },
      {
        "_id": "68d275a9a71143fb5ac5911e",
        "customerFirstName": "Emeka",
        "customerSurname": "Nwankwo",
        "customerEmail": "emeka.nwankwo@example.com",
        "customerMobileNo": "2348076543210",
        "bankAccountNumber": "0334455667",
        "status": "inactive",
        "maxDebitAmountPerTransaction": 7500,
        "createdAt": "2025-09-23T10:25:45.606Z",
        "endDate": "2030-11-08"
      }
    ],
    "counts": {
      "initiated": 0,
      "pending": 1,
      "active": 0,
      "inactive": 1,
      "expired": 0,
      "requested": 1
    },
    "meta": {
      "page": 1,
      "limit": 10,
      "total": 3,
      "totalPages": 1
    }
  }
}
```

--------------------------------

### 200 OK Response Example (JSON)

Source: https://zeehdocs.zeeh.africa/endpoints/endpoints-desk/ghana-kyc/ssnit

This JSON object illustrates a successful API response (HTTP 200 OK) after retrieving SNNIT details. It confirms success, provides a status message, and includes a 'data' object with the retrieved user information.

```json
{
  "success": true,
  "statusCode": 200,
  "message": "SSNIT Details retrieved",
  "response_code": "00",
  "data": {
    "FSSNo": "C987464748983",
    "FullName": "MARK LAWSON",
    "BirthDate": "12/11/1980",
    "Sex": "MALEALE",
    "CardSerial": "00000012447855",
    "Photo": "/9j/4AAQSkZJRgABAQEAYABgAAD/4RDcRXhpZgAATU0AKgAAAAgABAE7AAIAAAAGAAAISodpAAQAAAABAAAIUJydAAEAAAAMAAAQyOocAAcAAAgMAAAAPgAAAAAc6gAAAAgAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAERhdmlkAAAFkAMAAgAAABQAABCekAQAAgAAABQAABCykpEAAgAAAAM5NwAAkpIAAgAAAAM5NwAA6hwABwAACAwAAAiSAAAAABzqAAAACAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA"
  }
}
```

--------------------------------

### Get All Instalment Payments

Source: https://zeehdocs.zeeh.africa/endpoints/endpoints-desk/direct-debit/instalment-payments

Retrieve all instalment-based payments created by your business. This is useful for monitoring customers' progress on their payment plans.

```APIDOC
## GET /v1/direct_debit/payments/instalment

### Description
Retrieve all instalment-based payment created by your business. Useful for monitoring customers’ progress on payment plans.

### Method
GET

### Endpoint
/v1/direct_debit/payments/instalment

### Headers
- **Secret_Key** (string) - Required - Your secret key for authentication.

### Query Parameters
- **page** (integer) - Optional - The page number for pagination. Defaults to 1.
- **limit** (integer) - Optional - The number of results per page. Defaults to 10.

### Request Example
```bash
curl -X GET "{{base_url}}/v1/direct_debit/payments/instalment?page=1&limit=10" \
  -H "Secret_Key: pv_<your_secret>"
```

### Response
#### Success Response (200)
- **payments** (array) - A list of instalment payment objects.
  - Each object contains details such as `paymentId`, `customerId`, `amount`, `downPayment`, `status`, etc.

#### Response Example
```json
{
  "payments": [
    {
      "paymentId": "inst_12345abcde",
      "customerId": "68c332723f481831c21d4131",
      "amount": 400,
      "downPayment": 100,
      "status": "completed",
      "createdAt": "2023-10-26T10:00:00Z"
    },
    {
      "paymentId": "inst_67890fghij",
      "customerId": "a1b2c3d4e5f6789012345678",
      "amount": 200,
      "downPayment": 50,
      "status": "pending",
      "createdAt": "2023-10-25T11:00:00Z"
    }
  ]
}
```
```

--------------------------------

### Get All Instalment Payments using cURL

Source: https://zeehdocs.zeeh.africa/endpoints/endpoints-desk/direct-debit/instalment-payments

Retrieves all instalment-based payments created by your business. This endpoint is useful for monitoring customers’ progress on payment plans. Requires a Secret Key header.

```bash
curl -X GET "{{base_url}}/v1/direct_debit/payments/instalment?page=1&limit=10" \
  -H "Secret_Key: pv_<your_secret>"
```

--------------------------------

### API 200 OK Response Example

Source: https://zeehdocs.zeeh.africa/endpoints/endpoints-desk/nigeria-kyc/cac-advanced

This JSON object details a successful API response (200 OK) for retrieving business registration information. It includes a success flag, status code, a descriptive message, and an array of business data objects, each containing fields like address, status, and registration date.

```json
{
  "success": true,
  "statusCode": 200,
  "message": "Business Registration Details retrieved",
  "response_code": "00",
  "data": [
    {
      "state": null,
      "address": "3 OKUNOWO LANE,AGUDA -ORILE  , IKEJA,LAGOS",
      "status": "ACTIVE",
      "city": null,
      "email": null,
      "companyStatus": "INACTIVE",
      "lga": null,
      "rcNumber": "461918",
      "registrationDate": "1981-12-15T23:00:00.000+00:00",
      "approvedName": "AMO - DOLTEM NIG. ENTS.",
      "directors": []
    },
    {
      "state": null,
      "address": "NO. 11A, SAMUEL EDOSA STREET, MAGODO GRA PHASE 2,",
      "status": "ACTIVE",
      "city": null,
      "email": "",
      "companyStatus": "ACTIVE",
      "lga": null,
      "rcNumber": "461918",
      "registrationDate": "2002-09-16T00:00:00.000+00:00",
      "approvedName": "VAS2NETS TECHNOLOGIES LIMITED",
      "directors": [
        {
          "surname": "STUFFMAN",
          "firstname": "AYO",
          "otherName": "",
          "email": "",
          "phoneNumber": "",
          "gender": "Male",
          "formerNationality": "",
          "city": "MAGODO GRA PHASE 2",
          "occupation": "",
          "formerName": "",
          "corporationName": "",
          "rcNumber": "",
          "state": "LAGOS",
          "accreditationnumber": "",
          "formType": "",
          "numSharesAlloted": null,
          "typeOfShares": "",
          "dateOfBirth": null,
          "dateOfAppointment": null,
          "status": "ACTIVE",
          "formerSurname": "",
          "formerFirstName": "",
          "formerOtherName": "",
          "identityNumber": "null",
          "otherDirectorshipDetails": null,
          "affiliateTypeFk": {
            "name": "DIRECTOR",
            "description": "DIRECTOR"
          },
          "countryFk": {
            "name": "NIGERIA",
            "code": "NIGERIA"
          },
          "lga": null,
          "isCorporate": null,
          "nationality": null,
          "address": "11A, SAMUEL EDOSA STREET",
          "streetNumber": "",
          "isChairman": null,
          "isDesignated": null,
          "postcode": "",
          "formerNameType": "",
          "affiliatesPscInformation": null,
          "isPublicUser": null
        },
        {
          "surname": "STUFFMAN",
          "firstname": "AYO",
          "otherName": "",
          "email": "",
          "phoneNumber": "",
          "gender": "MALE",
          "formerNationality": "",
          "city": "MAGODO GRA PHASE 2",
          "occupation": "SHAREHOLDER",
          "formerName": "",
          "corporationName": "",
          "rcNumber": "",
          "state": "LAGOS",
          "accreditationnumber": "",
          "formType": "",
          "numSharesAlloted": 75000000,
          "typeOfShares": "ORDINARY",
          "dateOfBirth": null,
          "dateOfAppointment": "2020-06-24T11:03:37.000+00:00",
          "status": "ACTIVE",
          "formerSurname": "",
          "formerFirstName": "",
          "formerOtherName": "",
          "identityNumber": "",
          "otherDirectorshipDetails": "",
          "affiliateTypeFk": {
            "name": "SHAREHOLDER",
            "description": "SHAREHOLDER"
          },
          "countryFk": {
            "name": "NIGERIA",
            "code": "NIGERIA"
          },
          "lga": "",
          "isCorporate": false,
          "nationality": null,
          "address": "11A, SAMUEL EDOSA STREET,",
          "streetNumber": "",
          "isChairman": null,
          "isDesignated": null,
          "postcode": "",
          "formerNameType": "",
          "affiliatesPscInformation": null,
          "isPublicUser": null
        },
        {
          "surname": "STUFFMAN",
          "firstname": "SEUN ",
          "otherName": "TENIOLA",
          "email": "",
          "phoneNumber": "",
          "gender": "Female",
          "formerNationality": "",
          "city": "MAGODO GRA PHASE 2",
          "occupation": "SHAREHOLDER",
          "formerName": "",
          "corporationName": "",
          "rcNumber": "",
          "state": "LAGOS",
          "accreditationnumber": "",
          "formType": "",
          "numSharesAlloted": 10000000,
          "typeOfShares": "ORDINARY",
          "dateOfBirth": null,
          "dateOfAppointment": "2020-06-24T11:03:37.000+00:00",
          "status": "ACTIVE",
          "formerSurname": "",
          "formerFirstName": "",
          "formerOtherName": "",
          "identityNumber": "",
          "otherDirectorshipDetails": "",
          "affiliateTypeFk": {
            "name": "SHAREHOLDER",
            "description": "SHAREHOLDER"
          },
          "countryFk": {
            "name": "NIGERIA",
            "code": "NIGERIA"
          },
          "lga": "",

```

--------------------------------

### GET /v1/direct_debit/transactions

Source: https://zeehdocs.zeeh.africa/endpoints/endpoints-desk/direct-debit/transactions

Fetches all transactions associated with your business, including single, subscription, and installment payments. This endpoint is crucial for reconciliation, reporting, and tracking payment lifecycles.

```APIDOC
## GET /v1/direct_debit/transactions

### Description
Fetch all transactions that have occurred under your business, regardless of type (single, subscription, or instalment).

### Method
GET

### Endpoint
`/v1/direct_debit/transactions`

### Query Parameters
- **page** (integer) - Optional - The page number for pagination.
- **limit** (integer) - Optional - The number of transactions to return per page.

### Headers
- **Secret_Key** (string) - Required - Your secret API key.

### Request Example
```bash
curl -X GET "{{base_url}}/v1/direct_debit/transactions?page=1&limit=10" \
  -H "Secret_Key: <your_secret_key>"
```

### Response
#### Success Response (200)
- **success** (boolean) - Indicates if the request was successful.
- **statusCode** (integer) - The HTTP status code.
- **message** (string) - A message describing the result of the request.
- **response_code** (string) - A specific response code from the API.
- **data** (object) - Contains the transaction data and metadata.
  - **transactions** (array) - A list of transaction objects.
    - **_id** (string) - Unique identifier for the transaction.
    - **paymentId** (string) - Identifier for the associated payment.
    - **event** (string) - The type of event that occurred (e.g., 'debit', 'activate_mandate').
    - **amount** (integer) - The transaction amount.
    - **transactionRef** (string) - A reference string for the transaction.
    - **narration** (string) - A descriptive narration for the transaction.
    - **status** (string) - The status of the transaction (e.g., 'successful').
    - **providerSessionId** (string) - The session ID from the provider.
    - **createdAt** (string) - Timestamp when the transaction was created.
    - **updatedAt** (string) - Timestamp when the transaction was last updated.
    - **payment** (object) - Details about the associated payment.
      - **_id** (string) - Unique identifier for the payment.
      - **type** (string) - The type of payment (e.g., 'single').
      - **status** (string) - The status of the payment (e.g., 'completed').
      - **amount** (integer) - The payment amount.
      - **description** (string) - A description of the payment.
    - **customer** (object) - Details about the customer.
      - **firstName** (string) - The customer's first name.
      - **surname** (string) - The customer's surname.
      - **email** (string) - The customer's email address.
      - **mobileNo** (string) - The customer's mobile number.
      - **bankName** (string) - The customer's bank name.
      - **accountNumber** (string) - The customer's account number.
  - **meta** (object) - Metadata for pagination.
    - **page** (integer) - The current page number.
    - **limit** (integer) - The number of items per page.
    - **total** (integer) - The total number of items.
    - **totalPages** (integer) - The total number of pages.

#### Response Example
```json
{
  "success": true,
  "statusCode": 200,
  "message": "Transactions fetched",
  "response_code": "00",
  "data": {
    "transactions": [
      {
        "_id": "78d541dd3352d8171f31d300",
        "paymentId": "78d541cd3352d8171f31d2e1",
        "event": "debit",
        "amount": 250,
        "transactionRef": "txHN34rQWsT9_783aa402_SIM",
        "narration": "txHN34rQWsT9_783aa402_SIM_12782|PWA||ZA - Brightstone Limited",
        "status": "successful",
        "providerSessionId": "5b3d9d7b-7c2f-4d8b-a54b-882605d7edac",
        "createdAt": "2025-09-25T13:21:33.054Z",
        "updatedAt": "2025-09-25T13:21:33.054Z",
        "payment": {
          "_id": "78d541cd3352d8171f31d2e1",
          "type": "single",
          "status": "completed",
          "amount": 250,
          "description": "Brightstone - payment"
        },
        "customer": {
          "firstName": "Chinedu",
          "surname": "Okafor",
          "email": "chinedu.okafor@example.com",
          "mobileNo": "2348102234455",
          "bankName": "CHINEDU OKAFOR",
          "accountNumber": "0138456729"
        }
      }
    ],
    "meta": {
      "page": 1,
      "limit": 10,
      "total": 4,
      "totalPages": 1
    }
  }
}
```
```

--------------------------------

### GET /v1/direct_debit/transactions/{paymentId}

Source: https://zeehdocs.zeeh.africa/endpoints/endpoints-desk/direct-debit/transactions

Fetches all transaction records associated with a given payment ID. This endpoint is useful for monitoring debit attempts and their results for single, subscription, or instalment payments.

```APIDOC
## GET /v1/direct_debit/transactions/{paymentId}

### Description
Fetch all transaction records tied to a specific payment (single, subscription, or instalment). This helps you monitor the debit attempts and outcomes for a given payment.

### Method
GET

### Endpoint
`/v1/direct_debit/transactions/{paymentId}`

### Parameters
#### Path Parameters
- **paymentId** (string) - Required - The ID of the payment you want to inspect.

#### Query Parameters
None

#### Request Body
None

### Headers
- **Secret_Key** (string) - Required - Your secret API key.

### Request Example
```bash
curl -X GET "{{base_url}}/v1/direct_debit/transactions/68e2787e0ab786c545dbd70e" \
  -H "Secret_Key: pv_<your_secret>"
```

### Response
#### Success Response (200)
- **success** (boolean) - Indicates if the request was successful.
- **statusCode** (integer) - The HTTP status code.
- **message** (string) - A message describing the result of the operation.
- **response_code** (string) - A custom response code.
- **data** (object) - Contains the transaction details and metadata.
  - **transactions** (array) - A list of transaction objects.
    - **_id** (string) - The unique identifier for the transaction.
    - **paymentId** (string) - The ID of the associated payment.
    - **event** (string) - The type of event (e.g., 'debit', 'activate_mandate').
    - **amount** (integer) - The transaction amount.
    - **transactionRef** (string) - The reference number for the transaction.
    - **narration** (string) - A description of the transaction.
    - **status** (string) - The status of the transaction (e.g., 'successful').
    - **providerSessionId** (string) - The session ID from the payment provider.
    - **createdAt** (string) - The timestamp when the transaction was created.
    - **updatedAt** (string) - The timestamp when the transaction was last updated.
    - **payment** (object) - Details about the associated payment.
      - **_id** (string) - The unique identifier for the payment.
      - **type** (string) - The type of payment (e.g., 'single', 'subscription').
      - **status** (string) - The status of the payment.
      - **amount** (integer) - The payment amount.
      - **description** (string) - A description of the payment.
    - **customer** (object) - Details about the customer.
      - **firstName** (string) - The customer's first name.
      - **surname** (string) - The customer's surname.
      - **email** (string) - The customer's email address.
      - **mobileNo** (string) - The customer's mobile number.
      - **bankName** (string) - The customer's bank name.
      - **accountNumber** (string) - The customer's bank account number.
  - **meta** (object) - Metadata for pagination.
    - **page** (integer) - The current page number.
    - **limit** (integer) - The number of items per page.
    - **total** (integer) - The total number of transactions.
    - **totalPages** (integer) - The total number of pages.

#### Response Example
```json
{
  "success": true,
  "statusCode": 200,
  "message": "Transactions fetched",
  "response_code": "00",
  "data": {
    "transactions": [
      {
        "_id": "78d541dd3352d8171f31d300",
        "paymentId": "78d541cd3352d8171f31d2e1",
        "event": "debit",
        "amount": 250,
        "transactionRef": "txHN34rQWsT9_783aa402_SIM",
        "narration": "txHN34rQWsT9_783aa402_SIM_12782|PWA||ZA - Brightstone Limited",
        "status": "successful",
        "providerSessionId": "5b3d9d7b-7c2f-4d8b-a54b-882605d7edac",
        "createdAt": "2025-09-25T13:21:33.054Z",
        "updatedAt": "2025-09-25T13:21:33.054Z",
        "payment": {
          "_id": "78d541cd3352d8171f31d2e1",
          "type": "single",
          "status": "completed",
          "amount": 250,
          "description": "Brightstone - payment"
        },
        "customer": {
          "firstName": "Chinedu",
          "surname": "Okafor",
          "email": "chinedu.okafor@example.com",
          "mobileNo": "2348102234455",
          "bankName": "CHINEDU OKAFOR",
          "accountNumber": "0138456729"
        }
      },
      {
        "_id": "78d541d83352d8171f31d2f4",
        "paymentId": "78d541cd3352d8171f31d2e1",
        "event": "activate_mandate",
        "amount": 0,
        "transactionRef": "DD-SUB-QRiPLBtLDXVrYkl_9e18ba61",
        "status": "successful",
        "occurredAt": "2025-09-25 13:21:17",
        "createdAt": "2025-09-25T13:21:28.029Z",
        "updatedAt": "2025-09-25T13:21:28.029Z",
        "payment": {
          "_id": "78d541cd3352d8171f31d2e1",
          "type": "single",
          "status": "completed",
          "amount": 250,
          "description": "Brightstone - payment"
        },
        "customer": {
          "firstName": "Chinedu",
          "surname": "Okafor",
          "email": "chinedu.okafor@example.com",
          "mobileNo": "2348102234455",
          "bankName": "CHINEDU OKAFOR",
          "accountNumber": "0138456729"
        }
      },
      {
        "_id": "78d296740ab786c545dbd80b",
        "paymentId": "78d275a9a71143fb5ac59120",
        "event": "debit",
        "amount": 500,
        "transactionRef": "9GA78nxAOd3b_476df11c_REF",
        "narration": "9GA78nxAOd3b_476df11c_REF_16544|PWA||ZA - Emerald Ventures",
        "status": "successful",
        "providerSessionId": "5b3d9d7b-7c2f-4d8b-a54b-882605d7edac",
        "createdAt": "2025-09-23T12:45:40.710Z",
        "updatedAt": "2025-09-23T12:45:40.710Z",
        "payment": {
          "_id": "78d275a9a71143fb5ac59120",
          "type": "single",
          "status": "completed",
          "amount": 500,
          "description": "Emerald - payment"
        },
        "customer": {
          "firstName": "Aisha",
          "surname": "Bello",
          "email": "aisha.bello@example.com",
          "mobileNo": "2349025567881",
          "bankName": "AISHA BELLO",
          "accountNumber": "0245671890"
        }
      },
      {
        "_id": "78d2966e0ab786c545dbd7fd",
        "paymentId": "78d275a9a71143fb5ac59120",
        "event": "activate_mandate",
        "amount": 0,
        "transactionRef": "DD-SUB-D4TEKD1Rkn4jpsm_11562a22",
        "status": "successful",
        "occurredAt": "2025-09-23 12:45:22",
        "createdAt": "2025-09-23T12:45:34.212Z",
        "updatedAt": "2025-09-23T12:45:34.212Z",
        "payment": {
          "_id": "78d275a9a71143fb5ac59120",
          "type": "single",
          "status": "completed",
          "amount": 500,
          "description": "Emerald - payment"
        },
        "customer": {
          "firstName": "Aisha",
          "surname": "Bello",
          "email": "aisha.bello@example.com",
          "mobileNo": "2349025567881",
          "bankName": "AISHA BELLO",
          "accountNumber": "0245671890"
        }
      }
    ],
    "meta": {
      "page": 1,
      "limit": 10,
      "total": 4,
      "totalPages": 1
    }
  }
}
```
```

--------------------------------

### GET /customers

Source: https://zeehdocs.zeeh.africa/endpoints/endpoints-desk/customers/get-customers

Retrieves a list of user financial data from Zeeh Connect. Supports both sandbox and production environments.

```APIDOC
## GET /customers

### Description
Retrieves a list of user financial data from Zeeh Connect. This endpoint is available in both sandbox and production environments.

### Method
GET

### Endpoint
`{{url}}/customers`

### Parameters
#### Query Parameters
None

#### Request Body
None

### Request Example
None

### Response
#### Success Response (200)
- **success** (boolean) - Indicates if the request was successful.
- **statusCode** (integer) - The HTTP status code.
- **message** (string) - A message describing the response.
- **response_code** (string) - A custom response code.
- **data** (array) - An array containing customer financial data.

#### Response Example
```json
{
  "success": true,
  "statusCode": 200,
  "message": "Customers",
  "response_code": "00",
  "data": [
    [
      {
        "_id": "64c3b15c9bfc5b83427de2ba",
        "accountNumber": "0075037324",
        "bankName": "sterling",
        "bankLogo": "https://res.cloudinary.com/tobiloba98/image/upload/v1685114539/sterling_hdpejd.png",
        "bankCode": "232",
        "publicKey": "pk_mpOzXWstQ9pXpw7rttSUJjRvt",
        "bvn": "22264946102",
        "email": "",
        "phoneNumber": "08034156851",
        "isCompleted": true,
        "fullName": "BIDEMI BAYONLE OLADELE",
        "balance": 1039.69,
        "accountStatus": "Active",
        "isoCurrencyCode": "",
        "currency": "0",
        "accountType": "Savings - Regular",
        "orgId": "67fc5fffb8a5782bc5bfe5b7ae7f03ff734db9000b0ac4b5a6694c546d4edb45",
        "country": "Nigeria",
        "lastLogin": "2023-07-28T12:15:24.957Z",
        "createdAt": "2023-07-28T12:15:24.959Z",
        "updatedAt": "2023-07-28T12:15:27.061Z",
        "accountId": "64c3b15c9bfc5b83427de2ba",
        "statementDate": "2023-07-28T12:15:27.060Z",
        "statementLength": 18
      }
    ],
    [
      {
        "_id": "654509c17a25dc5cb0c64b0f",
        "accountNumber": "0230702415",
        "bankName": "Wema",
        "bankLogo": "https://res.cloudinary.com/tobiloba98/image/upload/v1673359906/wema_y51vpo.png",
        "bankCode": "035",
        "publicKey": "pk_mpOzXWstQ9pXpw7rttSUJjRvt",
        "bvn": "22184421846",
        "email": "ihemjica@gmail.com",
        "phoneNumber": "07080439439",
        "isCompleted": true,
        "fullName": "Adimabua Frank Uwajeh",
        "balance": 23093.63,
        "dob": "0001-01-01T00:00:00.000Z",
        "accountStatus": "",
        "isoCurrencyCode": "",
        "currency": "0",
        "accountType": "Savings Account Salary",
        "orgId": "67fc5fffb8a5782bc5bfe5b7ae7f03ff734db9000b0ac4b5a6694c546d4edb45",
        "country": "Nigeria",
        "lastLogin": "2023-11-13T09:56:33.573Z",
        "createdAt": "2023-11-03T14:54:57.418Z",
        "updatedAt": "2023-11-13T09:56:37.401Z",
        "accountId": "654509c17a25dc5cb0c64b0f",
        "statementDate": "2023-11-13T09:56:37.401Z",
        "statementLength": 185
      }
    ]
  ]
}
```

#### Error Response (400)
- **success** (boolean) - Indicates if the request was successful.
- **statusCode** (integer) - The HTTP status code.
- **message** (string) - A message describing the error.
- **response_code** (string) - A custom response code.

#### Error Response Example
```json
{
  "success": false,
  "statusCode": 400,
  "message": "Customers details could not be retrieved",
  "response_code": "00"
}
```
```

--------------------------------

### Get All Single Payments Response (JavaScript)

Source: https://zeehdocs.zeeh.africa/endpoints/endpoints-desk/direct-debit/single-payments

Example of a successful response when retrieving a list of single direct debit payments. It includes payment details, counts, and pagination metadata.

```javascript
{
  "success": true,
  "statusCode": 200,
  "message": "Payments fetched",
  "response_code": "00",
  "data": {
    "payments": [
      {
        "_id": "68e1787e0ab786c545dbd70e",
        "merchantId": "68e16d80a71143fb5ac590c9",
        "mandateId": {
          "_id": "68e1787e0ab786c545dbd70c",
          "customerFirstName": "Chinedu",
          "customerSurname": "Okeke",
          "customerEmail": "chinedu.okeke@example.com"
        },
        "type": "single",
        "status": "requested",
        "amount": 7500,
        "billerCode": "001340",
        "description": "PHCN - Electricity Bill",
        "progress": {
          "totalDebitsExpected": 7500,
          "totalDebitsCompleted": 0
        },
        "providerPaymentId": "78901",
        "createdAt": "2025-09-23T10:37:50.634Z",
        "updatedAt": "2025-09-23T10:37:50.634Z",
        "__v": 0
      },
      {
        "_id": "68e175a9a71143fb5ac59120",
        "merchantId": "68e16d80a71143fb5ac590c9",
        "mandateId": {
          "_id": "68e175a9a71143fb5ac5911e",
          "customerFirstName": "Aisha",
          "customerSurname": "Bello",
          "customerEmail": "aisha.bello@example.com"
        },
        "type": "single",
        "status": "completed",
        "amount": 15000,
        "billerCode": "001340",
        "description": "School Fees Payment",
        "progress": {
          "totalDebitsExpected": 15000,
          "totalDebitsCompleted": 15000,
          "lastEventAt": "2025-09-23T12:45:40.709Z"
        },
        "providerPaymentId": "78900",
        "createdAt": "2025-09-23T10:25:45.620Z",
        "updatedAt": "2025-09-23T12:45:40.710Z",
        "__v": 0
      }
    ],
    "counts": {
      "requested": 1,
      "pending": 0,
      "active": 0,
      "inactive": 0,
      "expired": 0,
      "completed": 1
    },
    "meta": {
      "page": 1,
      "limit": 10,
      "total": 2,
      "totalPages": 1
    }
  }
}
```
Tokens:
Raw