public static final class PaymentService.PaymentRetryRequest extends PostRequest<Payment>
Request class for PaymentService.retry(java.lang.String)
.
Retries a failed payment if the underlying mandate is active. You will receive a resubmission_requested
webhook, but after that retrying the payment follows the same process as its initial creation, so you will receive a submitted
webhook, followed by a confirmed
or failed
event. Any metadata supplied to this endpoint will be stored against the payment submission event it causes.
This will return a retry_failed
error if the payment has not failed.
Payments can be retried up to 3 times.
Modifier and Type | Method and Description |
---|---|
PaymentService.PaymentRetryRequest |
withHeader(java.lang.String headerName,
java.lang.String headerValue) |
PaymentService.PaymentRetryRequest |
withMetadata(java.util.Map<java.lang.String,java.lang.String> metadata)
Key-value store of custom data.
|
PaymentService.PaymentRetryRequest |
withMetadata(java.lang.String key,
java.lang.String value)
Key-value store of custom data.
|
execute, executeWrapped
public PaymentService.PaymentRetryRequest withMetadata(java.util.Map<java.lang.String,java.lang.String> metadata)
Key-value store of custom data. Up to 3 keys are permitted, with key names up to 50 characters and values up to 500 characters.
public PaymentService.PaymentRetryRequest withMetadata(java.lang.String key, java.lang.String value)
Key-value store of custom data. Up to 3 keys are permitted, with key names up to 50 characters and values up to 500 characters.
public PaymentService.PaymentRetryRequest withHeader(java.lang.String headerName, java.lang.String headerValue)