List Card Events

List Card Events

curl --request GET \
  --url https://api.treasuryprime.com/card_event \
  --header 'Authorization: Basic <encoded-value>'

{
  "data": [
    {
      "amount": "<string>",
      "approved_amount": "<string>",
      "atm": {
        "network": "<string>",
        "network_fee": "<string>"
      },
      "bank_id": "<string>",
      "card_id": "<string>",
      "currency": "<string>",
      "decline_reason": "<string>",
      "id": "<string>",
      "merchant": {
        "address": {
          "city": "<string>",
          "country": "<string>",
          "postal_code": "<string>",
          "state": "<string>"
        },
        "mcc": "<string>",
        "mid": "<string>",
        "name": "<string>"
      },
      "message_type": "<string>",
      "network": "<string>",
      "network_created_at": "<string>",
      "networkdata": {},
      "org_id": "<string>",
      "processor": "<string>",
      "status": "<string>",
      "trace_id": "<string>"
    }
  ]
}

GET

card_event

List Card Events

curl --request GET \
  --url https://api.treasuryprime.com/card_event \
  --header 'Authorization: Basic <encoded-value>'

{
  "data": [
    {
      "amount": "<string>",
      "approved_amount": "<string>",
      "atm": {
        "network": "<string>",
        "network_fee": "<string>"
      },
      "bank_id": "<string>",
      "card_id": "<string>",
      "currency": "<string>",
      "decline_reason": "<string>",
      "id": "<string>",
      "merchant": {
        "address": {
          "city": "<string>",
          "country": "<string>",
          "postal_code": "<string>",
          "state": "<string>"
        },
        "mcc": "<string>",
        "mid": "<string>",
        "name": "<string>"
      },
      "message_type": "<string>",
      "network": "<string>",
      "network_created_at": "<string>",
      "networkdata": {},
      "org_id": "<string>",
      "processor": "<string>",
      "status": "<string>",
      "trace_id": "<string>"
    }
  ]
}

Authorizations

Authorization

string

header

required

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.

Query Parameters

card_id

string

The ID of the card associated with the event. Filterable.

trace_id

string

Identifier used to link card events to transactions. Filterable.

page_cursor

string

Pagination cursor, value is the object ID.

page_size

integer

default:100

Limits the number of objects in the returned list, value must be a number greater than or equal to 1. Defaults to 100.

Required range: x >= 1

from_date

string

Lists the objects created on the date provided and onwards. Date must be in ISO 8601 format (“YYYY-MM-DD”).

to_date

string

Lists the objects created before the date provided. Date must be in ISO 8601 format (“YYYY-MM-DD”).

Response

200 - application/json

A dictionary with a data property that contains a list of up to page_size card_event elements, starting after the card_event described by page_cursor. If no more card_events are available, the resulting list will be empty.

data

object[]

Show child attributes

data.amount

string

Amount of money related to the event, with two decimal precision

data.approved_amount

string

Approved amount of money related to the event, with two decimal precision

data.atm

object

Object representing data related to ATM transactions

Show child attributes

data.atm.network

string

ATM network for event

data.atm.network_fee

string

Fee associated with event

data.bank_id

string

ID of the bank associated with the card event

data.card_id

string

The ID of the card associated with the event. Filterable.

data.currency

string

Three digit currency code

data.decline_reason

string

The reason denied requests were not approved

data.id

string

Unique identifier for object

data.merchant

object

Object representing the merchant where the card event occurred

Show child attributes

data.merchant.address

object

Object containg city, state, postal_code, and country as strings

Show child attributes

data.merchant.address.city

string

Merchant city

data.merchant.address.country

string

Three-digit country abbreviation

data.merchant.address.postal_code

string

Five-digit postal code

data.merchant.address.state

string

Two-digit state abbreviation

data.merchant.mcc

string

Merchant category code

data.merchant.mid

string

Merchant ID

data.merchant.name

string

Name of the merchant

data.message_type

string

Type of message. See Message Types

data.network

string

Card network the event occurred on (e.g., mastercard)

data.network_created_at

string

Timestamp of when the network states the event was created. This should match closely to the standard created_at field on the object. It may differ slightly due to the amount of time it takes Treasury Prime to process the event

data.networkdata

object

Information received from the network. The structure of this information depends on the processor, but may contain information such as amount, fees, or additional information about the transaction

data.org_id

string

ID of the organization associated with the card event

data.processor

string

Processor that issued the card

data.status

string

Status of event. One of pending, error, approved, denied, timeout, or received

data.trace_id

string

Identifier used to link card events to transactions. Filterable.

Overview Fetch a Card Event

⌘I

Introduction

Account

Account Opening

Cards

Payments

Testing

Utilities

Authorizations

Query Parameters

Response