v1

latestOpenAPI 3.0.02026-07-2636111249.2 KB
Purchase API

Retry Payment

Initiates a retry attempt after the initial customer's payment failed. To retry a failed payment, submit the <code>PurchaseId</code> that you received in the response payload from the Get Purchase API function or the OnlinePaymentDeclinedNotification.<br /><b>Note:</b>To activate this option, contact your Client Experience Manager. <br /><b>Important:</b> Using this endpoint to collect failed payments deactivates the Cleverbridge retry schedule.

post/purchase/retrypayment

Headers

Accept'application/json' | 'application/xml'

Expected response format.

Content-Type'application/json' | 'application/xml'

Format of the HTTP post body.

Request body

PurchaseIdstring required

Unique ID of an existing purchase.

RetryDatestring date-time

Retry date and time according to RFC3339. If no value is passed, the retry is executed as soon as possible. You must specify the time in UTC.

Response

OK

ResultMessagestring

Optional result or error message.