Purchase API

Cancel Retry

Cancels a retry attempt that was scheduled after a customer's payment failed. To cancel a scheduled retry, submit the <code>PurchaseId</code> that you received in the response payload from the Process Cart API function. To learn whether a retry has been scheduled, see the <code>IsPaymentRetryScheduled</code> field in the Process Cart response.<br /><b>Important</b>: If you receive a <code>CCA_EXP</code> status in <code>PaymentResult.Code</code> field in the Process Cart response, then an Expiration Date Checker call has been made, and it is not possible to cancel the next scheduled payment retry.

post/purchase/cancelretry

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.

Response

OK

ResultMessagestring

Optional result or error message.

Changes

No recorded changes to this endpoint across all 1 revision of this API.