Update payment order

Updates an existing payment order with new information or status.

This endpoint can be used to modify payment order details or progress a payment order through
its lifecycle by updating its status. Status changes are restricted to valid
transitions:

  • pending → approved or archived
  • approved → paid or archived
  • paid → archived
  • archived → (no further transitions allowed)

When updating a payment order's status, the system enforces these valid state transitions
to ensure the integrity of the payment order workflow.

If you provide a bank_account_id, the system will update the payment order to use that
bank account and automatically set the appropriate counterparty type based on the profile
associated with the bank account.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

Payment order unique identifier

Body Params
integer

Payment amount in cents (alternative to amount)

string
enum

Payment status

Allowed:
string
enum

Type of order

Allowed:
date

When the payment should be processed

string

ID of the bank account receiving the payment

Responses

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json