Add transactions

POST

transactions

curl --request POST \
  --url https://api.app.slickerhq.com/ingest/v1/transactions \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "transactions": [
    {
      "id": "txn_12345678",
      "paymentGatewayTransactionId": "ch_1a2b3c4d5e",
      "state": "TRANSACTION_STATE_PAID",
      "customerId": "cus_87654321",
      "subscriptionId": "sub_12345678",
      "invoiceId": "inv_12345678",
      "amount": 2500,
      "currency": "USD",
      "createdAt": "2023-01-15T10:15:00Z",
      "updatedAt": "2023-01-15T10:20:00Z",
      "paymentMethodType": "card",
      "paymentGatewayId": "pg_stripe",
      "paymentGatewayName": "Stripe",
      "paymentGatewayType": "credit_card",
      "paymentGatewayStatus": "succeeded",
      "cardBrand": "visa",
      "cardBin": "411111",
      "cardFingerprint": "Xt5EWLLDS7FJjR1c",
      "cardCountry": "US"
    },
    {
      "id": "txn_87654321",
      "paymentGatewayTransactionId": "ch_5e4d3c2b1a",
      "state": "TRANSACTION_STATE_FAILED",
      "customerId": "cus_12345678",
      "subscriptionId": "sub_87654321",
      "invoiceId": "inv_87654321",
      "amount": 5000,
      "currency": "USD",
      "createdAt": "2023-01-20T09:15:00Z",
      "updatedAt": "2023-01-20T09:20:00Z",
      "paymentMethodType": "card",
      "paymentGatewayId": "pg_stripe",
      "paymentGatewayName": "Stripe",
      "paymentGatewayType": "credit_card",
      "paymentGatewayStatus": "failed",
      "paymentGatewayErrorCode": "card_declined",
      "paymentGatewayErrorMessage": "Your card was declined",
      "cardBrand": "mastercard",
      "cardBin": "511111",
      "cardFingerprint": "R7GsJL9FmKj3dN2q",
      "cardCountry": "UK"
    }
  ]
}'

{
  "requestId": "req_2uqkAo1bwllmzrgV2qtGv48DtGI"
}

Authorizations

Authorization

string

header

required

API key authentication using a Bearer token in the Authorization header. Example: Authorization: Bearer YOUR_API_KEY

Body

application/json

Request to ingest transaction data. Maximum of 200 transactions per request.

transactions

object[]

transactions.id

string

required

Unique identifier for the transaction

Example:

"txn_12345678"

transactions.state

enum<string>

default:TRANSACTION_STATE_UNSPECIFIED

required

Current state of the transaction

Available options:

TRANSACTION_STATE_UNSPECIFIED,

TRANSACTION_STATE_PAID,

TRANSACTION_STATE_FAILED,

TRANSACTION_STATE_PENDING,

TRANSACTION_STATE_REFUNDED,

TRANSACTION_STATE_CHARGEBACK,

TRANSACTION_STATE_VOID

transactions.customerId

string

required

Unique identifier for the customer

Example:

"cus_87654321"

transactions.amount

integer

required

Monetary amount in smallest unit (e.g., cents)

Example:

2500

transactions.currency

string

required

Three-letter ISO 4217 currency code

Example:

"USD"

transactions.createdAt

string

required

Timestamp when the transaction was created

Example:

"2023-01-15T10:15:00Z"

transactions.paymentGatewayTransactionId

string

Transaction identifier from the payment gateway

Example:

"ch_1a2b3c4d5e"

transactions.subscriptionId

string

Unique identifier for the associated subscription, if applicable

Example:

"sub_12345678"

transactions.invoiceId

string

Unique identifier for the associated invoice, if applicable

Example:

"inv_12345678"

transactions.updatedAt

string

Timestamp when the transaction was last updated

Example:

"2023-01-15T10:20:00Z"

transactions.paymentMethodType

string

Type of payment method used

Example:

"card"

transactions.paymentGatewayId

string

Identifier for the payment gateway

Example:

"pg_stripe"

transactions.paymentGatewayName

string

Name of the payment gateway

Example:

"Stripe"

transactions.paymentGatewayType

string

Type of the payment gateway

Example:

"credit_card"

transactions.paymentGatewayStatus

string

Status reported by the payment gateway

Example:

"succeeded"

transactions.paymentGatewayErrorCode

string

Error code from the payment gateway, if applicable

Example:

"card_declined"

transactions.paymentGatewayErrorMessage

string

Error message from the payment gateway, if applicable

Example:

"Your card was declined"

transactions.cardBrand

string

Brand of the credit card used for payment

Example:

"visa"

transactions.cardBin

string

Bank Identification Number (first 6 digits of card number)

Example:

"411111"

transactions.cardFingerprint

string

Unique fingerprint for the card

Example:

"Xt5EWLLDS7FJjR1c"

transactions.cardCountry

string

ISO 3166-1 alpha-2 country code of the card

Example:

"US"

Response

200

application/json

A successful response.

requestId

string

Unique identifier for tracking the request through the system

Example:

"req_2uqkAo1bwllmzrgV2qtGv48DtGI"

Add invoices List recovery actions

curl --request POST \
  --url https://api.app.slickerhq.com/ingest/v1/transactions \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "transactions": [
    {
      "id": "txn_12345678",
      "paymentGatewayTransactionId": "ch_1a2b3c4d5e",
      "state": "TRANSACTION_STATE_PAID",
      "customerId": "cus_87654321",
      "subscriptionId": "sub_12345678",
      "invoiceId": "inv_12345678",
      "amount": 2500,
      "currency": "USD",
      "createdAt": "2023-01-15T10:15:00Z",
      "updatedAt": "2023-01-15T10:20:00Z",
      "paymentMethodType": "card",
      "paymentGatewayId": "pg_stripe",
      "paymentGatewayName": "Stripe",
      "paymentGatewayType": "credit_card",
      "paymentGatewayStatus": "succeeded",
      "cardBrand": "visa",
      "cardBin": "411111",
      "cardFingerprint": "Xt5EWLLDS7FJjR1c",
      "cardCountry": "US"
    },
    {
      "id": "txn_87654321",
      "paymentGatewayTransactionId": "ch_5e4d3c2b1a",
      "state": "TRANSACTION_STATE_FAILED",
      "customerId": "cus_12345678",
      "subscriptionId": "sub_87654321",
      "invoiceId": "inv_87654321",
      "amount": 5000,
      "currency": "USD",
      "createdAt": "2023-01-20T09:15:00Z",
      "updatedAt": "2023-01-20T09:20:00Z",
      "paymentMethodType": "card",
      "paymentGatewayId": "pg_stripe",
      "paymentGatewayName": "Stripe",
      "paymentGatewayType": "credit_card",
      "paymentGatewayStatus": "failed",
      "paymentGatewayErrorCode": "card_declined",
      "paymentGatewayErrorMessage": "Your card was declined",
      "cardBrand": "mastercard",
      "cardBin": "511111",
      "cardFingerprint": "R7GsJL9FmKj3dN2q",
      "cardCountry": "UK"
    }
  ]
}'

{
  "requestId": "req_2uqkAo1bwllmzrgV2qtGv48DtGI"
}

Integrations

Billing & Subscriptions

Payment providers

Add transactions

Authorizations

Body

Response