GET
/
v1
/
businesses
/
{businessId}
/
invoices
/
payments
curl --request GET \
  --url https://sandbox.layerfi.com/v1/businesses/{businessId}/invoices/payments \
  --header 'Authorization: Bearer <token>'
[
  {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "external_id": "payment-1",
    "at": "2023-11-07T05:31:56Z",
    "method": "CASH",
    "fee": 123,
    "additional_fees": [
      {
        "fee_amount": 123,
        "description": "<string>",
        "account": {
          "type": "AccountId",
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
        }
      }
    ],
    "amount": 123,
    "processor": "STRIPE",
    "imported_at": "2023-11-07T05:31:56Z",
    "allocations": [
      {
        "invoice_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "payment_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "amount": 123,
        "transaction_tags": [
          {
            "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "key": "ExampleTagKey",
            "value": "ExampleTagValue",
            "created_at": "2023-11-07T05:31:56Z",
            "updated_at": "2023-11-07T05:31:56Z",
            "deleted_at": "2023-11-07T05:31:56Z"
          }
        ],
        "metadata": {
          "custom_field": "value",
          "any valid json": "below 10kb",
          "nested": {
            "meaning of life": 42,
            "array": []
          }
        }
      }
    ],
    "refund_allocations": [],
    "transaction_tags": [],
    "metadata": {
      "custom_field": "value",
      "any valid json": "below 10kb",
      "nested": {
        "meaning of life": 42,
        "array": []
      }
    }
  }
]

Authorizations

​
Authorization
string
header
required

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

Headers

​
Content-Type
string

Content-Type must be set to application/json

Path Parameters

​
businessId
string
required

The UUID of the business to fetch invoice payments for

Query Parameters

​
method
string

Filter payments by status. Supported values are CASH, CHECK, CREDIT_CARD, ACH, REDEEMED_PREPAYMENT, OTHER.

​
paid_at_start
string

Filter payments by payment date. Payments made on or after this date will be included. ISO 8601 date format.

​
paid_at_end
string

Filter payments by payment date. Payments made on or before this date will be included. ISO 8601 date format.

Response

200
application/json

The response is of type object[].