Class MandatesClient

Mandates client. Thread-safe.

Inheritance

object

ApiResource

MandatesClient

Inherited Members

ApiResource._communicator

ApiResource._clientMetaInfo

ApiResource.ClientHeaders

ApiResource.InstantiateUri(string, IDictionary<string, string>)

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

Namespace: Worldline.Connect.Sdk.V1.Merchant.Mandates

Assembly: Worldline.Connect.Sdk.dll

Syntax

public class MandatesClient : ApiResource

Constructors

MandatesClient(ApiResource, IDictionary<string, string>)

Declaration

public MandatesClient(ApiResource parent, IDictionary<string, string> pathContext)

Parameters

Type	Name	Description
ApiResource	parent
IDictionary<string, string>	pathContext

Methods

Block(string, CallContext)

Resource /{merchantId}/mandates/{uniqueMandateReference}/block

• Block mandate

Declaration

public Task<GetMandateResponse> Block(string uniqueMandateReference, CallContext context = null)

Parameters

Type	Name	Description
string	uniqueMandateReference	string
CallContext	context	CallContext

Returns

Type	Description
Task<GetMandateResponse>	GetMandateResponse

Exceptions

Type	Condition
IdempotenceException	if an idempotent request caused a conflict (HTTP status code 409)
ValidationException	if the request was not correct and couldn't be processed (HTTP status code 400)
AuthorizationException	if the request was not allowed (HTTP status code 403)
ReferenceException	if an object was attempted to be referenced that doesn't exist or has been removed, or there was a conflict (HTTP status code 404, 409 or 410)
PlatformException	if something went wrong at the Worldline Global Collect platform, the Worldline Global Collect platform was unable to process a message from a downstream partner/acquirer, or the service that you're trying to reach is temporary unavailable (HTTP status code 500, 502 or 503)
ApiException	if the Worldline Global Collect platform returned any other error

Create(CreateMandateRequest, CallContext)

Resource /{merchantId}/mandates

• Create mandate

Declaration

public Task<CreateMandateResponse> Create(CreateMandateRequest body, CallContext context = null)

Parameters

Type	Name	Description
CreateMandateRequest	body	CreateMandateRequest
CallContext	context	CallContext

Returns

Type	Description
Task<CreateMandateResponse>	CreateMandateResponse

Exceptions

Type	Condition
IdempotenceException	if an idempotent request caused a conflict (HTTP status code 409)
ValidationException	if the request was not correct and couldn't be processed (HTTP status code 400)
AuthorizationException	if the request was not allowed (HTTP status code 403)
ReferenceException	if an object was attempted to be referenced that doesn't exist or has been removed, or there was a conflict (HTTP status code 404, 409 or 410)
PlatformException	if something went wrong at the Worldline Global Collect platform, the Worldline Global Collect platform was unable to process a message from a downstream partner/acquirer, or the service that you're trying to reach is temporary unavailable (HTTP status code 500, 502 or 503)
ApiException	if the Worldline Global Collect platform returned any other error

CreateWithMandateReference(string, CreateMandateRequest, CallContext)

Resource /{merchantId}/mandates/{uniqueMandateReference}

• Create mandate with mandatereference

Declaration

public Task<CreateMandateResponse> CreateWithMandateReference(string uniqueMandateReference, CreateMandateRequest body, CallContext context = null)

Parameters

Type	Name	Description
string	uniqueMandateReference	string
CreateMandateRequest	body	CreateMandateRequest
CallContext	context	CallContext

Returns

Type	Description
Task<CreateMandateResponse>	CreateMandateResponse

Exceptions

Type	Condition
IdempotenceException	if an idempotent request caused a conflict (HTTP status code 409)
ValidationException	if the request was not correct and couldn't be processed (HTTP status code 400)
AuthorizationException	if the request was not allowed (HTTP status code 403)
ReferenceException	if an object was attempted to be referenced that doesn't exist or has been removed, or there was a conflict (HTTP status code 404, 409 or 410)
PlatformException	if something went wrong at the Worldline Global Collect platform, the Worldline Global Collect platform was unable to process a message from a downstream partner/acquirer, or the service that you're trying to reach is temporary unavailable (HTTP status code 500, 502 or 503)
ApiException	if the Worldline Global Collect platform returned any other error

Get(string, CallContext)

Resource /{merchantId}/mandates/{uniqueMandateReference}

• Get mandate

Declaration

public Task<GetMandateResponse> Get(string uniqueMandateReference, CallContext context = null)

Parameters

Type	Name	Description
string	uniqueMandateReference	string
CallContext	context	CallContext

Returns

Type	Description
Task<GetMandateResponse>	GetMandateResponse

Exceptions

Type	Condition
IdempotenceException	if an idempotent request caused a conflict (HTTP status code 409)
ValidationException	if the request was not correct and couldn't be processed (HTTP status code 400)
AuthorizationException	if the request was not allowed (HTTP status code 403)
ReferenceException	if an object was attempted to be referenced that doesn't exist or has been removed, or there was a conflict (HTTP status code 404, 409 or 410)
PlatformException	if something went wrong at the Worldline Global Collect platform, the Worldline Global Collect platform was unable to process a message from a downstream partner/acquirer, or the service that you're trying to reach is temporary unavailable (HTTP status code 500, 502 or 503)
ApiException	if the Worldline Global Collect platform returned any other error

Revoke(string, CallContext)

Resource /{merchantId}/mandates/{uniqueMandateReference}/revoke

• Revoke mandate

Declaration

public Task<GetMandateResponse> Revoke(string uniqueMandateReference, CallContext context = null)

Parameters

Type	Name	Description
string	uniqueMandateReference	string
CallContext	context	CallContext

Returns

Type	Description
Task<GetMandateResponse>	GetMandateResponse

Exceptions

Type	Condition
IdempotenceException	if an idempotent request caused a conflict (HTTP status code 409)
ValidationException	if the request was not correct and couldn't be processed (HTTP status code 400)
AuthorizationException	if the request was not allowed (HTTP status code 403)
ReferenceException	if an object was attempted to be referenced that doesn't exist or has been removed, or there was a conflict (HTTP status code 404, 409 or 410)
PlatformException	if something went wrong at the Worldline Global Collect platform, the Worldline Global Collect platform was unable to process a message from a downstream partner/acquirer, or the service that you're trying to reach is temporary unavailable (HTTP status code 500, 502 or 503)
ApiException	if the Worldline Global Collect platform returned any other error

Unblock(string, CallContext)

Resource /{merchantId}/mandates/{uniqueMandateReference}/unblock

• Unblock mandate

Declaration

public Task<GetMandateResponse> Unblock(string uniqueMandateReference, CallContext context = null)

Parameters

Type	Name	Description
string	uniqueMandateReference	string
CallContext	context	CallContext

Returns

Type	Description
Task<GetMandateResponse>	GetMandateResponse

Exceptions

Type	Condition
IdempotenceException	if an idempotent request caused a conflict (HTTP status code 409)
ValidationException	if the request was not correct and couldn't be processed (HTTP status code 400)
AuthorizationException	if the request was not allowed (HTTP status code 403)
ReferenceException	if an object was attempted to be referenced that doesn't exist or has been removed, or there was a conflict (HTTP status code 404, 409 or 410)
PlatformException	if something went wrong at the Worldline Global Collect platform, the Worldline Global Collect platform was unable to process a message from a downstream partner/acquirer, or the service that you're trying to reach is temporary unavailable (HTTP status code 500, 502 or 503)
ApiException	if the Worldline Global Collect platform returned any other error