Sign in
Configurable Payment Retry

Execute payments

For all active retry cycles associated with the invoice, debit memo, and/or account IDs provided, schedules the next payment retry attempt to occur in the next hourly payment processor run.

post/api/v1/payments/execute_payments

Request body

account_idsstring[]

IDs of accounts.

debit_memo_idsstring[]

IDs of debit memos.

invoice_idsstring[]

IDs of invoices.

Example request

{
  "account_ids": [
    "2c92c0f96bd69165016bdcbf55ad5e62"
  ],
  "invoice_ids": [
    "2c92c0fa7853052701785a38c6622473",
    "2c92c0fa7849b40a01784bc5de0f760f"
  ],
  "debit_memo_ids": [
    "2c92c0fa7853052701785a38f3bb267f"
  ]
}

Response

successboolean

Indicates whether the operation is successful.

messagestring

The response message.

Example response

{
  "success": true,
  "message": "Payments with the following IDs enqueued for processing: [100, 101, 110, 111, 121]"
}

Changes