POST
/
v1
/
businesses
/
{businessId}
/
bills
/
bill-payments
curl --request POST \
  --url https://sandbox.layerfi.com/v1/businesses/{businessId}/bills/bill-payments \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "external_id": "<string>",
  "paid_at": "2023-11-07T05:31:56Z",
  "method": "CASH",
  "amount": 123,
  "processor": "<string>",
  "bill_payment_allocations": [
    {
      "bill_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "bill_external_id": "<string>",
      "amount": 123
    }
  ]
}'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "external_id": "<string>",
  "at": "2023-11-07T05:31:56Z",
  "method": "CASH",
  "amount": 123,
  "processor": "<string>",
  "imported_at": "2023-11-07T05:31:56Z",
  "allocations": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "bill_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": [
    {
      "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"
    }
  ]
}

Authorizations

​
Authorization
string
header
required

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

Path Parameters

​
businessId
string
required

The UUID of the business to create the payment for

Body

application/json
​
paid_at
string
required

When the payment was made

​
method
enum<string>
required

Method used for payment

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

Payment amount in cents

​
bill_payment_allocations
object[]
required

How the payment is allocated across bills

​
external_id
string | null

External ID for the payment

​
processor
string | null

Payment processor used

Response

201 - application/json
Payment created successfully
​
id
string

Unique identifier for the payment

​
external_id
string | null

External ID for the payment

​
at
string

When the payment was made

​
method
enum<string>

Method used for payment

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

Payment amount in cents

​
processor
string | null

Payment processor used

​
imported_at
string

When the payment was imported

​
allocations
object[]

How the payment is allocated across bills

​
transaction_tags
object[]

Tags associated with the payment

List bill paymentsUpdate bill payment