Sign in
Configurable Payment Retry

Submit a payment to retry cycle

This API request submits a failed payment to the Configurable Payment Retry retry cycle. The request adds the failed payment to the existing CPR retry cycle. If no CPR retry cycle exists, this request creates a new one and adds the failed payment.

post/api/v1/payments/submit_failed_payment

Request body

payment_idstring

ID of a failed payment.

Example request

{
  "payment_id": "2c92c0867849d42301784bc9ce806c31"
}

Response

successboolean

Indicates whether the operation is successful.

messagestring

The response message.

Example response

{
  "success": true,
  "message": "Payment entered into retry process"
}

Changes

No recorded changes to this endpoint across all 4 revisions of this API.