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"
          }
        ]
      }
    ],
    "transaction_tags": []
  }
]

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
​
id
string

Unique identifier for the payment.

​
external_id
string | null

Unique ID of the invoice payment in an external system for linking and idempotency.

Example:

"payment-1"

​
at
string

Timestamp when the payment was completed.

​
method
enum<string>

Payment method.

Available options:
CASH,
CHECK,
CREDIT_CARD,
ACH,
CREDIT_BALANCE,
OTHER
​
fee
integer

Fee paid by business for processing of payment in positive cents.

​
additional_fees
object[]

List of additional fees associated with this payment.

​
amount
integer

Customer payment amount, in cents.

​
processor
string | null

Processor used to make the payment, if any. Any processor name can be provided and will be tracked. Supported processors (STRIPE, SHOPIFY) will have additional asset balance tracking.

Example:

"STRIPE"

​
imported_at
string

Timestamp when the payment was imported into Layer.

​
allocations
object[]

List of payment allocations associated with this payment.

​
transaction_tags
object[]

List of tags associated with this transaction

Example:
[]
Update paymentDelete a Payment