Query Transactions

curl --request GET \
  --url https://api.cartevo.co/api/v1/payment/transactions \
  --header 'Authorization: Bearer <token>'

{
  "success": true,
  "message": "Transactions retrieved successfully",
  "data": [
    {
      "transaction_id": "550e8400-e29b-41d4-a716-446655440000",
      "status": "SUCCESS",
      "amount": 1000,
      "currency": "XAF",
      "phone_number": "237670000000",
      "country": "CM",
      "operator": "mtn",
      "type": "COLLECTION",
      "external_id": "ORD-2024-001",
      "reason": "Invoice payment",
      "description": "Payment collection transaction",
      "created_at": "2025-01-08T12:00:00.000Z",
      "updated_at": "2025-01-08T12:05:00.000Z",
      "error_message": "<string>"
    }
  ],
  "pagination": {
    "page": 1,
    "limit": 20,
    "total": 15,
    "totalPages": 1
  }
}

GET

payment

transactions

Query Transactions

curl --request GET \
  --url https://api.cartevo.co/api/v1/payment/transactions \
  --header 'Authorization: Bearer <token>'

{
  "success": true,
  "message": "Transactions retrieved successfully",
  "data": [
    {
      "transaction_id": "550e8400-e29b-41d4-a716-446655440000",
      "status": "SUCCESS",
      "amount": 1000,
      "currency": "XAF",
      "phone_number": "237670000000",
      "country": "CM",
      "operator": "mtn",
      "type": "COLLECTION",
      "external_id": "ORD-2024-001",
      "reason": "Invoice payment",
      "description": "Payment collection transaction",
      "created_at": "2025-01-08T12:00:00.000Z",
      "updated_at": "2025-01-08T12:05:00.000Z",
      "error_message": "<string>"
    }
  ],
  "pagination": {
    "page": 1,
    "limit": 20,
    "total": 15,
    "totalPages": 1
  }
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

status

enum<string>

Filter by status (PENDING, SUCCESS, FAILED)

Available options:

PENDING,

SUCCESS,

FAILED,

PROCESSING

type

enum<string>

Filter by type (COLLECTION, PAYOUT)

Available options:

COLLECTION,

PAYOUT

external_id

string

Filter by external ID (partial match)

from_date

string<date-time>

Start date (ISO 8601)

to_date

string<date-time>

End date (ISO 8601)

page

integer

Page number

Example:

1

limit

integer

Items per page

Example:

20

Response

200 - application/json

Transactions retrieved successfully

success

boolean

Example:

true

message

string

Example:

"Transactions retrieved successfully"

data

object[]

Show child attributes

data.transaction_id

string<uuid>

Example:

"550e8400-e29b-41d4-a716-446655440000"

data.status

enum<string>

Available options:

PENDING,

SUCCESS,

FAILED,

PROCESSING

Example:

"SUCCESS"

data.amount

number

Example:

1000

data.currency

string

Example:

"XAF"

data.phone_number

string

Example:

"237670000000"

data.country

string

Example:

"CM"

data.operator

string

Example:

"mtn"

data.type

enum<string>

Available options:

COLLECTION,

PAYOUT

Example:

"COLLECTION"

data.external_id

string

Example:

"ORD-2024-001"

data.reason

string

Example:

"Invoice payment"

data.description

string

Example:

"Payment collection transaction"

data.created_at

string<date-time>

Example:

"2025-01-08T12:00:00.000Z"

data.updated_at

string<date-time>

Example:

"2025-01-08T12:05:00.000Z"

data.error_message

string | null

pagination

object

Show child attributes

pagination.page

integer

Example:

1

pagination.limit

integer

Example:

20

pagination.total

integer

Example:

15

pagination.totalPages

integer

Example:

1

Get Transaction Status Get Payment Balance

⌘I

API documentation

Auth

Cards

Customers

Payment Collection

Webhook

Query Transactions

Authorizations

Query Parameters

Response