public static final class MandateService.MandateCancelRequest extends PostRequest<Mandate>
Request class for MandateService.cancel(java.lang.String).
Immediately cancels a mandate and all associated cancellable payments. Any metadata supplied to this endpoint will be stored on the mandate cancellation event it causes.
This will fail with a cancellation_failed error if the mandate is already cancelled.
| Modifier and Type | Method and Description |
|---|---|
MandateService.MandateCancelRequest |
withHeader(java.lang.String headerName,
java.lang.String headerValue) |
MandateService.MandateCancelRequest |
withMetadata(java.util.Map<java.lang.String,java.lang.String> metadata)
Key-value store of custom data.
|
MandateService.MandateCancelRequest |
withMetadata(java.lang.String key,
java.lang.String value)
Key-value store of custom data.
|
execute, executeWrappedpublic MandateService.MandateCancelRequest 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 MandateService.MandateCancelRequest 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 MandateService.MandateCancelRequest withHeader(java.lang.String headerName, java.lang.String headerValue)