Skip to main content
POST
/
companies
/
{company_id}
/
payments
/
transactions
/
find
Find Payment Transactions
curl --request POST \
  --url https://api.getmeasure.com/api/v1/companies/{company_id}/payments/transactions/find \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "pagination": {
    "from_key": "<string>",
    "limit": 20
  },
  "include_meta": true,
  "query": {
    "currency": "<string>",
    "customer_id": "<string>",
    "invoice_number": "<string>",
    "invoice_uuid": "<string>",
    "provider_transaction_ids": [
      "<string>"
    ],
    "provider_type": "<string>",
    "search": "<string>",
    "show_connected_account": true,
    "status": "<string>",
    "total_amount": {
      "eq": 123,
      "gt": 123,
      "gte": 123,
      "lte": 123
    },
    "transaction_type": "<string>"
  },
  "sort_key": "createdAtDesc"
}
'
{
  "pagination": {
    "from_key": "<string>",
    "limit": 123
  },
  "results": [
    {
      "application_fee_amount": {
        "currency": "<string>",
        "value_in_cents": 123
      },
      "company_id": "<string>",
      "connected_account_transaction": true,
      "created_at": "2023-11-07T05:31:56Z",
      "customer": {
        "email": "<string>",
        "id": "<string>",
        "identifier": "<string>",
        "name": "<string>",
        "org_name": "<string>",
        "parent_customer": "<unknown>",
        "parent_customer_id": "<string>"
      },
      "customer_id": "<string>",
      "deleted_at": "2023-11-07T05:31:56Z",
      "disallow_partial_refund": true,
      "id": "<string>",
      "initiated_by": "<string>",
      "initiated_by_type": "<string>",
      "invoice_number": "<string>",
      "invoice_uuid": "<string>",
      "is_refundable": true,
      "is_voidable": true,
      "net_amount": {
        "currency": "<string>",
        "value_in_cents": 123
      },
      "note": "<string>",
      "payment_method": {
        "brand": "<string>",
        "last_4": "<string>",
        "name": "<string>",
        "type": "<string>"
      },
      "proposal_id": "<string>",
      "provider_transaction_id": "<string>",
      "provider_type": "<string>",
      "refundable_amount": {
        "currency": "<string>",
        "value_in_cents": 123
      },
      "status": "<string>",
      "status_message": "<string>",
      "stripe_fee_amount": {
        "currency": "<string>",
        "value_in_cents": 123
      },
      "total_amount": {
        "currency": "<string>",
        "value_in_cents": 123
      },
      "total_amount_default_currency": {
        "currency": "<string>",
        "value_in_cents": 123
      },
      "total_fee_amount": {
        "currency": "<string>",
        "value_in_cents": 123
      },
      "transaction_type": "<string>",
      "updated_at": "2023-11-07T05:31:56Z"
    }
  ]
}

Documentation Index

Fetch the complete documentation index at: https://docs.getmeasure.com/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

​
Idempotency-Key
string

The idempotency key that will be used to ensure the request is only performed once

Path Parameters

​
company_id
string
required

The company ID with the prefix 'cmp_'.

Body

application/json
​
pagination
object
required

The pagination parameters for the request

​
include_meta
boolean | null

Whether to include additional metadata in the pagination response such the number of total results

​
query
object

The query criteria for the request

​
sort_key
null | enum<string>
default:createdAtDesc
Available options:
createdAtDesc,
createdAtAsc,
updatedAtAsc,
updatedAtDesc,
totalAmountAsc,
totalAmountDesc

Response

200 - application/json

OK

​
pagination
object
​
results
object[] | null