{
  "data": {
    "id": "590ed436-c2bd-4e39-8047-f913a852f99c",
    "external_id": "bill-payment-1",
    "at": "2024-06-15T00:00:00Z",
    "method": "ACH",
    "amount": 10000,
    "processor": "BANK_TRANSFER",
    "imported_at": "2024-06-15T18:11:57.339076Z",
    "allocations": [
      {
        "id": "8901-abcd-ef23-4567",
        "bill_id": "b745c116-cd28-41a1-b4ea-84a2768b6e14",
        "payment_id": "590ed436-c2bd-4e39-8047-f913a852f99c",
        "amount": 10000,
        "transaction_tags": []
      }
    ],
    "transaction_tags": [
      {
        "id": "4d01d4dd-1e55-5c61-9999-9ee36847163b",
        "key": "PaymentType",
        "value": "Regular",
        "created_at": "2024-06-15T05:31:56Z",
        "updated_at": "2024-06-15T05:31:56Z",
        "deleted_at": null
      }
    ]
  }
}

Bill payments represent payments made by a business to vendors. Payments may be made at any time and applied to one or more outstanding (received, but not fully paid) bills.

​
Attributes

​
id
string
required

Unique identifier for the payment.

​
external_id
string

Unique ID of the bill payment in your system for linking and idempotency.

​
at
ISO8601 timestamp
required

Timestamp when the payment was completed.

​
method
enum
required

Payment method. Possible values are: CASH, CHECK, CREDIT_CARD, ACH, CREDIT_BALANCE, OTHER

​
amount
integer
required

Payment amount, in cents.

​
processor
string

Processor used to make the payment, if any. Any processor name can be provided and will be tracked.

​
imported_at
ISO8601 timestamp
required

Timestamp when the payment was imported into Layer.

​
allocations
array of BillPaymentAllocation objects
required

Bill allocations allow specifying a payment to be for multiple bills. Most commonly the full payment will be allocated to a single bill, but any number of allocations are allowed. The sum of all allocations must be equal to the payment amount.

​
transaction_tags
Array of Tags
{
  "data": {
    "id": "590ed436-c2bd-4e39-8047-f913a852f99c",
    "external_id": "bill-payment-1",
    "at": "2024-06-15T00:00:00Z",
    "method": "ACH",
    "amount": 10000,
    "processor": "BANK_TRANSFER",
    "imported_at": "2024-06-15T18:11:57.339076Z",
    "allocations": [
      {
        "id": "8901-abcd-ef23-4567",
        "bill_id": "b745c116-cd28-41a1-b4ea-84a2768b6e14",
        "payment_id": "590ed436-c2bd-4e39-8047-f913a852f99c",
        "amount": 10000,
        "transaction_tags": []
      }
    ],
    "transaction_tags": [
      {
        "id": "4d01d4dd-1e55-5c61-9999-9ee36847163b",
        "key": "PaymentType",
        "value": "Regular",
        "created_at": "2024-06-15T05:31:56Z",
        "updated_at": "2024-06-15T05:31:56Z",
        "deleted_at": null
      }
    ]
  }
}