Chapa Developer Documentation

This endpoint allows you to view all the transactions.

How to View All Transactions

Endpoint: https://api.chapa.co/v1/transactions
Method: GET
Authorization: Pass your secret key as a bearer token in the request header to authorize this call.

cURL

JavaScript

PHP

Python

Successful Response

The API returns a paginated list of all transactions with details including transaction references, amounts, status, payment methods, and timestamps.

{
  "message": "Transactions retrieved successfully",
  "status": "success",
  "data": {
    "transactions": [
      {
        "status": "pending",
        "ref_id": "VcEu3Hf55JU",
        "type": "Payment Link",
        "created_at": "2024-07-27T02:22:46.000000Z",
        "currency": "ETB",
        "amount": "12.000",
        "charge": "0.000",
        "trans_id": null,
        "payment_method": "card",
        "customer": {
          "id": 1301688,
          "email": null,
          "first_name": null,
          "last_name": null,
          "mobile": null
        }
      }
    ],
    "pagination": {
      "per_page": 10,
      "current_page": 1,
      "first_page_url": "https://api.chapa.co/v1/transactions?page=1",
      "next_page_url": "https://api.chapa.co/v1/transactions?page=2",
      "prev_page_url": null
    }
  }
}

Response Parameters

Parameter	Type	Description
`message`	string	Response message
`status`	string	Status of the request (success/failed)
`data.transactions`	array	Array of transaction objects
`status`	string	Transaction status (pending, success, failed)
`ref_id`	string	Chapa reference ID for the transaction
`type`	string	Type of transaction (Payment Link, API, etc.)
`created_at`	string	Timestamp when transaction was created
`currency`	string	Currency code (ETB, USD)
`amount`	string	Transaction amount
`charge`	string	Transaction fee
`trans_id`	string\|null	Transaction ID (if available)
`payment_method`	string	Payment method used (card, telebirr, etc.)
`customer`	object	Customer information object
`customer.id`	number	Customer ID
`customer.email`	string\|null	Customer email address
`customer.first_name`	string\|null	Customer first name
`customer.last_name`	string\|null	Customer last name
`customer.mobile`	string\|null	Customer mobile number
`pagination`	object	Pagination information
`pagination.per_page`	number	Number of items per page
`pagination.current_page`	number	Current page number
`pagination.first_page_url`	string	URL to first page
`pagination.next_page_url`	string\|null	URL to next page (if available)
`pagination.prev_page_url`	string\|null	URL to previous page (if available)

Failed Response

{
  "message": "Invalid API Key or the business can't accept payments at the moment. Please verify your API key and ensure the account is active and able to process payments.",
  "status": "failed",
  "data": null
}

Refer to Error Codes for all possible responses.

Pagination

The response includes pagination information to help you navigate through multiple pages of transactions. Use the next_page_url and prev_page_url fields to fetch additional pages.

Next Steps

Verify Payment - Verify individual transaction status
Transaction Logs - View detailed transaction logs
Error Codes - Handle errors gracefully