The first account is automatically created for business entities upon successful KYB verification. Additional accounts can be created by calling the entity endpoint again.

Table of Contents

1. Get Account Details
2. Get Statements
3. Get Transactions
4. Get Payment Proof

1. Get Account Details

Retrieves details of a specific account.

Subject: svc.account.<entity_id>.get_details

Request

{
  // No fields required
}

Response

{
  "org_id": "string",
  "account_id": "string",
  "account_number": "string",
  "balance": "string",
  "available_balance": "string",
  "metadata": {
    "short_code": "string"
  }
}

Possible Errors

• 400 Bad Request: Invalid request data
• 404 Not Found: Account not found

2. Get Statements

Retrieves account statements.

Subject: svc.account.<entity_id>.statement

Request

{
  "type": "string",       // Required - pdf or csv
  "filter_by": "string",  // Required - filter transaction by a given user id, can be an empty string to not filter
  "date_start": "string", // Required
  "date_end": "string"    // Required
}

Response

{
  "file_url": "string"
}

The url is a bucket and file name in the format acc_<account_id>/statement_<unix_timestamp> this can be retrieved using the same method located used to upload kyb documents.

Possible Errors

• 400 Bad Request: Invalid request data
• 404 Not Found: Statements not found

3. Get Transactions

Retrieves transactions of a specific account.

Subject: svc.account.<entity_id>.list

Request

{
  // No fields required
}

Response

{
  "account_id": "string",
  "transactions": [
    {
      "tx_id": "string",
      "parent_tx_id": "string",
      "date": "string",
      "amount": "string",
      "ref": "string",
      "status": "string",
      "tx_sha": "string",
      "user_id": "string",
      "added_by": "string",
      "tx_type": "string",
      "tx_payment_type": "string",
      "fee": "string",
      "recipient_name": "string",
      "credit": "string",
      "debit": "string"
    }
  ]
}

Possible Errors

• 400 Bad Request: Invalid request data

4. Get Payment Proof

Retrieves payment proof for a specific transaction.

Subject: svc.account.<entity_id>.get_payment_proof

Request

{
  "tx_id": "string"  // Required
}

Response

{
  "file_url": "string"
}

The url is a bucket and file name in the format acc_<account_id>/payment_proof_<unix_timestamp> this can be retrieved using the same method located used to upload kyb documents.

Possible Errors

• 400 Bad Request: Invalid request data
• 404 Not Found: Payment proof not found