Sign in

a84d4905fdbb

latestOpenAPI 3.1.02026-08-143874115.7 MB
Cards

CardTransaction Created

Sent when a card transaction is created

Required permissions:

  • payout:account:read
  • webhook_receive:card_transactions
postWebhookcard_transaction.created

Headers

webhook-idstring required

A unique identifier for this webhook request

Example:msg_xxxxxxxxxxxxxxxxxxxxxxxx
webhook-signaturestring required

The signature of the webhook request with the webhook version prepended

Example:v1,BASE64ENCODEDSIGNATURE
webhook-timestampstring required

The timestamp in seconds since the Unix epoch that the webhook was sent at on the server

Example:1727606400

Payload

api_version'v1' required

The API version for this webhook

api_version_datestring nullable required

The dated API version (Api-Version-Date) the payload is serialized to

company_idstring nullable

The account ID that this webhook event is associated with

idstring required

A unique ID for every single webhook request

timestampstring date-time required

The timestamp in ISO 8601 format that the webhook was sent at on the server

type'card_transaction.created' required

The webhook event type

Example payload

{
  "api_version": "v1",
  "api_version_date": "2026-07-20",
  "company_id": "biz_xxxxxxxxxxxxxx",
  "data": {
    "card_id": "icrd_xxxxxxxxxxxxxx",
    "cardholder_id": "user_xxxxxxxxxxxxxx",
    "cashback_usd_amount": 0.25,
    "created_at": "2026-01-01T12:00:00.000Z",
    "currency": "EUR",
    "declined_reason": "account_credit_limit_exceeded",
    "id": "citx_xxxxxxxxxxxxxx",
    "international": true,
    "local_amount": 22.5,
    "merchant_category": "Car Care Supplies",
    "merchant_category_code": "5533",
    "merchant_icon_url": "https://shinetime.example/icons/lone-star-detail-supply.png",
    "merchant_name": "Lone Star Detail Supply",
    "posted_at": "2026-01-01T12:00:00.000Z",
    "status": "completed",
    "transaction_type": "spend",
    "usd_amount": 24.99
  },
  "id": "msg_xxxxxxxxxxxxxxxxxxxxxxxx",
  "timestamp": "2025-01-01T00:00:00.000Z",
  "type": "card_transaction.created"
}

Response

Return a 200 status to indicate that the data was received successfully