Sign in

v1

latestOpenAPI 3.0.22026-07-24800528.1 KB
Transactions

List all transactions

Returns a list of your transactions. The transactions are returned sorted by creation date, with the most recent transactions appearing first.

get/v2/transactions

Query parameters

min_createdinteger

Applies a minimum epoch timestamp (ms) filter to the response created_at.

max_createdinteger

Applies a maximum epoch timestamp (ms) filter to the response created_at.

order_by'-created_at' | 'created_at'

The field in which the results are ordered by. A - prefix denotes that the results are in descending order.

limitinteger

A limit on the number of items to be returned. Limits can range between 1 and 250, and the default is 10.

starting_afterstring

A cursor for use in pagination, starting_after takes in an item key and the subsequent call will return the following items in the list. This is mutually exclusive with ending_before.

ending_beforestring

A cursor for use in pagination, ending_before takes in an item key and the subsequent call will return the prior items in the list. This is mutually exclusive with starting_after.

Response

Returns a list of your transactions. The transactions are returned sorted by creation date, with the most recent transactions appearing first.

messagestring required
statusinteger required

Example response

{
  "data": {
    "items": [
      {
        "created_at": 1574181282399,
        "key": "co_a80cb515fe",
        "updated_at": 1574181282399,
        "amount": 10000,
        "amount_usd": 10000,
        "company": {
          "key": "co_UD9407hi0jFiFe",
          "name": "Nice Company"
        },
        "currency": "USD",
        "customer": {
          "key": "cus_1h1QBVUg03Ij69",
          "shared_id": "1234567890",
          "sub_ids": [
            "youtube"
          ]
        },
        "partnership_key": "part_1234567"
      }
    ]
  }
}