Remove Auto Submit

Turns off auto-submit for a payment that is waiting for its payee, and returns it to DRAFT (or to RETURNED, if it had been
returned before).

Use it to stop a payment that would otherwise be sent automatically when the payee finishes onboarding. You can submit it again
later.

Requires the Payment Approval permission. If your role has an approval limit, the payment amount must be within it.
The older path /batches/{batchId}/payments/{paymentId}/removeAutoSubmit behaves the same; use this one.

Errors

  • 404 NOT_FOUND: the payment does not exist.
  • 409 STILL_AUTO_SUBMITTING: the payee just became payable and the payment is being sent. It can no longer be stopped this way; cancel it if it fails or comes back.
  • 409 NOT_WAITING_PAYABILITY: the payment is not WAITING_PAYABILITY.
  • 423 NOT_EDITABLE: auto-submit is not on for this payment (isAutoSubmitOn is false).
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
📘

The previous path /batches/{batchId}/payments/{paymentId}/removeAutoSubmit is deprecated but still supported as an alias. Please use /batches/{batchId}/payments/{paymentId}/remove-auto-submit going forward.

Path Params
string
required

ID of the batch, as returned by Create Batch.

string
required

ID of the payment, as returned by Create Payment.

Responses
204

Auto-submit is off. The payment is DRAFT again, or RETURNED if it had been returned.

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