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
PENDING, EXECUTED, SKIPPED, FAILED Response
Updated payment
Executed payment
User provided description for the payment schedule
Payment error details. It will be included only when status is ERROR
Payment ID
User provided JSON format data for the payment schedule
- Option 1
- Option 2
ID of the payment schedule that executed this payment
Payment request status
COMPLETED, ERROR Transaction ID. It will be included only when status is COMPLETED

