Update payment
๐ง Beta This is a Beta endpoint. Feedback from the community is welcome. We may make breaking changes to this endpoint.
Update a payment. Currently only supports cancelling a pending payment (one not yet executed, e.g. scheduled for a future effective_date) by setting the status to SKIPPED.
Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
Payment ID
Body
Request to update a payment. Currently only supports cancelling a pending payment (one not yet executed, e.g. scheduled for a future effective_date) by setting status to SKIPPED.
Status of the autopay:
- PENDING: Autopay is scheduled and waiting to be executed
- EXECUTED: Autopay was successfully executed
- SKIPPED: Autopay was skipped (e.g., no balance due)
- FAILED: Autopay failed to execute
EXECUTED, FAILED, PENDING, SKIPPED Response
Updated payment
A one-time payment made against a lending account.
Timestamp when the payment was created
"2024-01-15T10:30:00Z"
Description for the payment
"Payment"
Date the payment was (or will be) made
"2024-01-25"
Unique identifier for the payment
"2d0f7601-ecc6-48b4-b82f-5d64fa84628b"
Timestamp when the payment was last updated
"2024-01-15T10:30:00Z"
The lending account this payment was made against
"7d943c51-e4ff-4e57-9558-08cab6b963c7"
Payment method-specific configurations
Status of the autopay:
- PENDING: Autopay is scheduled and waiting to be executed
- EXECUTED: Autopay was successfully executed
- SKIPPED: Autopay was skipped (e.g., no balance due)
- FAILED: Autopay failed to execute
EXECUTED, FAILED, PENDING, SKIPPED History of execution attempts for an autopay
The amount in cents associated with this payment. For PENDING payments this is the originally requested amount (payments are not capped at the current balance -- an intentional overpayment is honored). For EXECUTED payments this mirrors executed_amount.
5000
The amount in cents actually paid, once executed.
5000
Identifiers for the payment created by an autopay execution. Only one field will be populated depending on the payment method used.

