Skip to main content
GET
/
api
/
rest
/
bill-payments
List bill payments
curl --request GET \
  --url https://api.upwell.com/api/rest/bill-payments
{
  "billPayments": [
    {
      "amount": 123,
      "billPaymentLineItems": [
        {
          "amount": 123,
          "billId": "<string>",
          "billingAccountNumber": "<string>",
          "billingName": "<string>",
          "carrierId": "<string>",
          "checkOrAchNumber": "<string>",
          "createdAt": "2023-11-07T05:31:56Z",
          "id": "<string>",
          "notes": "<string>",
          "referenceNumber": 123,
          "sourceSystem": "<string>",
          "sourceSystemId": "<string>",
          "status": "<string>",
          "transactionDate": "<string>",
          "updatedAt": "2023-11-07T05:31:56Z"
        }
      ],
      "carrierId": "<string>",
      "checkOrAchNumber": "<string>",
      "createdAt": "2023-11-07T05:31:56Z",
      "id": "<string>",
      "sourceSystem": "<string>",
      "sourceSystemId": "<string>",
      "status": "<string>",
      "transactionDate": "<string>",
      "updatedAt": "2023-11-07T05:31:56Z"
    }
  ]
}

Headers

​
authorization
string

Your API key will be used for authentication of the request. Authorization: YOUR_API_KEY

Query Parameters

​
limit
integer
default:10
​
offset
integer
default:0

Response

200 - application/json

Responses for GET /api/rest/bill-payments

​
billPayments
BillPayments · object[]