Skip to main content
PUT
/
api
/
rest
/
customer_payments
/
{id}
Update One Customer Payment
curl --request PUT \
  --url https://api.upwell.com/api/rest/customer_payments/{id} \
  --header 'Content-Type: application/json' \
  --data '
{
  "id": "<string>",
  "input": {
    "checkDate": "2023-12-25",
    "checkOrAchNumber": "<string>",
    "createdAt": "2023-11-07T05:31:56Z",
    "id": "<string>",
    "sourceSystem": "<string>",
    "sourceSystemId": "<string>",
    "sourceSystemMeta": "<unknown>",
    "tenantId": "<string>",
    "totalAmount": 123,
    "transactionDate": "2023-12-25",
    "updatedAt": "2023-11-07T05:31:56Z"
  }
}
'
{
  "updateCustomerPayment": {
    "checkDate": "2023-12-25",
    "checkOrAchNumber": "<string>",
    "createdAt": "2023-11-07T05:31:56Z",
    "id": "<string>",
    "paymentLineItems": [
      {
        "createdAt": "2023-11-07T05:31:56Z",
        "customerId": "<string>",
        "id": "<string>",
        "invoiceId": "<string>",
        "sourceSystem": "<string>",
        "sourceSystemId": "<string>",
        "status": "<string>",
        "totalAmount": 123,
        "updatedAt": "2023-11-07T05:31:56Z"
      }
    ],
    "sourceSystem": "<string>",
    "sourceSystemId": "<string>",
    "sourceSystemMeta": "<unknown>",
    "totalAmount": 123,
    "transactionDate": "2023-12-25",
    "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)

Body

application/json

Query parameters can also be provided in the request body as a JSON object

​
id
string
​
input
PaymentsSetInput · object

input type for updating data in table "payments"

Response

200 - application/json

Responses for PUT /api/rest/customer_payments/{id}

​
updateCustomerPayment
Payments · object

Payment records