POST
/
companies
/
{company_id}
/
payments
/
transactions
/
find
Find Payment Transactions
curl --request POST \
  --url https://api.maplebilling.com/api/v1/companies/{company_id}/payments/transactions/find \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "include_meta": true,
  "pagination": {
    "from_key": null,
    "limit": 20
  },
  "query": {
    "currency": null,
    "customer_id": null,
    "invoice_number": null,
    "invoice_uuid": null,
    "provider_type": null,
    "search": null,
    "show_connected_account": null,
    "status": null,
    "total_amount": {
      "eq": null,
      "gte": null,
      "lte": null
    },
    "transaction_type": null
  },
  "sort_key": "createdAtDesc"
}'
{
  "pagination": {
    "from_key": null,
    "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": {},
        "parent_customer_id": null
      },
      "customer_id": "<string>",
      "deleted_at": null,
      "disallow_partial_refund": null,
      "id": "<string>",
      "invoice_number": "<string>",
      "invoice_uuid": "<string>",
      "is_refundable": true,
      "is_voidable": true,
      "net_amount": {
        "currency": "<string>",
        "value_in_cents": 123
      },
      "note": null,
      "payment_method": {
        "brand": "<string>",
        "last_4": "<string>",
        "name": "<string>",
        "type": "<string>"
      },
      "proposal_id": null,
      "provider_transaction_id": "<string>",
      "provider_type": "<string>",
      "refundable_amount": {
        "currency": "<string>",
        "value_in_cents": 123
      },
      "status": "<string>",
      "status_message": null,
      "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"
    }
  ]
}

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

Response

200 - application/json

OK

The response is of type object.