Skip to main content
GET
/
api
/
rest
/
bill-payments
/
{id}
Get bill payment
curl --request GET \
  --url https://api.upwell.com/api/rest/bill-payments/{id}
{
  "billPayment": {
    "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

Path Parameters

​
id
string
required

"id" is required (enter it either in parameters or request body)

Response

200 - application/json

Responses for GET /api/rest/bill-payments/{id}

​
billPayment
BillPayments · object

columns and relationships of "bill_payments"