Customer Transactions

Customer transactions

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

{
  "success": true,
  "statusCode": 200,
  "message": "Data retrieved successfully",
  "data": [
    {
      "id": "7d1cdfa3-9904-4a17-bce5-092554170c0e",
      "category": "CARD",
      "type": "FUND",
      "amount": 50,
      "status": "SUCCESS",
      "description": "Card funding: **** **** **** 5407",
      "created_at": "2023-11-07T05:31:56Z",
      "card": {
        "id": "91b3c6d6-111b-44da-9f81-16f019bebe8c",
        "status": "ACTIVE",
        "balance": 0.45,
        "currency": "USD",
        "number": "tkAlsp_eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ2YWx1ZSI6IjUzNjAyNTI0ODM0NjU0MDciLCJpYXQiOjE3NjExNDg5NzR9.7sNid1b1pxmkpseiCR45E8Xj9hdmenZDovBcjVatBF0",
        "masked_number": "**** **** **** 5407",
        "cvv": "tkAlsp_eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ2YWx1ZSI6Ijg1NyIsImlhdCI6MTc2MTE0ODk3NH0.K7YHl0nzZTsScjUma_G5fyxYZFNnK-2SczstVtdMK1A",
        "expiry_month": 10,
        "expiry_year": 28,
        "is_virtual": true,
        "is_physical": false,
        "created_at": "2023-11-07T05:31:56Z"
      },
      "customer": {
        "id": "4d4dad81-7899-4612-a9f6-133ce56a4507",
        "email": "[email protected]",
        "first_name": "John",
        "last_name": "Doe"
      }
    }
  ],
  "pagination": {
    "page": 1,
    "limit": 20,
    "total": 15,
    "totalPages": 1
  }
}

GET

customers

{id}

transactions

Customer transactions

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

{
  "success": true,
  "statusCode": 200,
  "message": "Data retrieved successfully",
  "data": [
    {
      "id": "7d1cdfa3-9904-4a17-bce5-092554170c0e",
      "category": "CARD",
      "type": "FUND",
      "amount": 50,
      "status": "SUCCESS",
      "description": "Card funding: **** **** **** 5407",
      "created_at": "2023-11-07T05:31:56Z",
      "card": {
        "id": "91b3c6d6-111b-44da-9f81-16f019bebe8c",
        "status": "ACTIVE",
        "balance": 0.45,
        "currency": "USD",
        "number": "tkAlsp_eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ2YWx1ZSI6IjUzNjAyNTI0ODM0NjU0MDciLCJpYXQiOjE3NjExNDg5NzR9.7sNid1b1pxmkpseiCR45E8Xj9hdmenZDovBcjVatBF0",
        "masked_number": "**** **** **** 5407",
        "cvv": "tkAlsp_eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ2YWx1ZSI6Ijg1NyIsImlhdCI6MTc2MTE0ODk3NH0.K7YHl0nzZTsScjUma_G5fyxYZFNnK-2SczstVtdMK1A",
        "expiry_month": 10,
        "expiry_year": 28,
        "is_virtual": true,
        "is_physical": false,
        "created_at": "2023-11-07T05:31:56Z"
      },
      "customer": {
        "id": "4d4dad81-7899-4612-a9f6-133ce56a4507",
        "email": "[email protected]",
        "first_name": "John",
        "last_name": "Doe"
      }
    }
  ],
  "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.

Path Parameters

string<uuid>

required

Query Parameters

page

integer

Example:

1

limit

integer

Example:

20

Response

A list of transactions for the specified customer.

success

boolean

Example:

true

statusCode

integer

Example:

200

message

string

Example:

"Data retrieved successfully"

data

object[]

Show child attributes

data.id

string<uuid>

Example:

"7d1cdfa3-9904-4a17-bce5-092554170c0e"

data.category

string

Example:

"CARD"

data.type

string

Example:

"FUND"

data.amount

number

Example:

50

data.status

string

Example:

"SUCCESS"

data.description

string

Example:

"Card funding: **** **** **** 5407"

data.created_at

string<date-time>

data.card

object

Show child attributes

data.card.id

string<uuid>

Example:

"91b3c6d6-111b-44da-9f81-16f019bebe8c"

data.card.status

string

Example:

"ACTIVE"

data.card.balance

number

Example:

0.45

data.card.currency

string

Example:

"USD"

data.card.number

string

Encrypted card number

Example:

"tkAlsp_eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ2YWx1ZSI6IjUzNjAyNTI0ODM0NjU0MDciLCJpYXQiOjE3NjExNDg5NzR9.7sNid1b1pxmkpseiCR45E8Xj9hdmenZDovBcjVatBF0"

data.card.masked_number

string

Example:

"**** **** **** 5407"

data.card.cvv

string

Encrypted CVV

Example:

"tkAlsp_eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ2YWx1ZSI6Ijg1NyIsImlhdCI6MTc2MTE0ODk3NH0.K7YHl0nzZTsScjUma_G5fyxYZFNnK-2SczstVtdMK1A"

data.card.expiry_month

integer

Example:

10

data.card.expiry_year

integer

Example:

28

data.card.is_virtual

boolean

Example:

true

data.card.is_physical

boolean

Example:

false

data.card.created_at

string<date-time>

data.customer

object

Show child attributes

data.customer.id

string<uuid>

Example:

"4d4dad81-7899-4612-a9f6-133ce56a4507"

data.customer.email

string<email>

Example:

"[email protected]"

data.customer.first_name

string

Example:

"John"

data.customer.last_name

string

Example:

"Doe"

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

Customer by ID Enroll Customer

⌘I

API documentation

Auth

Cards

Customers

Payment Collection

Webhook

Authorizations

Path Parameters

Query Parameters

Response