Class HostedcheckoutsClient

Hostedcheckouts client. Thread-safe.

Inheritance

object

ApiResource

HostedcheckoutsClient

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.Hostedcheckouts

Assembly: Worldline.Connect.Sdk.dll

Syntax

public class HostedcheckoutsClient : ApiResource

Constructors

HostedcheckoutsClient(ApiResource, IDictionary<string, string>)

Declaration

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

Parameters

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

Methods

Create(CreateHostedCheckoutRequest, CallContext)

Resource /{merchantId}/hostedcheckouts

• Create hosted checkout

Declaration

public Task<CreateHostedCheckoutResponse> Create(CreateHostedCheckoutRequest body, CallContext context = null)

Parameters

Type	Name	Description
CreateHostedCheckoutRequest	body	CreateHostedCheckoutRequest
CallContext	context	CallContext

Returns

Type	Description
Task<CreateHostedCheckoutResponse>	CreateHostedCheckoutResponse

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

Delete(string, CallContext)

Resource /{merchantId}/hostedcheckouts/{hostedCheckoutId}

• Delete hosted checkout

Declaration

public Task Delete(string hostedCheckoutId, CallContext context = null)

Parameters

Type	Name	Description
string	hostedCheckoutId	string
CallContext	context	CallContext

Returns

Type	Description
Task

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}/hostedcheckouts/{hostedCheckoutId}

• Get hosted checkout status

Declaration

public Task<GetHostedCheckoutResponse> Get(string hostedCheckoutId, CallContext context = null)

Parameters

Type	Name	Description
string	hostedCheckoutId	string
CallContext	context	CallContext

Returns

Type	Description
Task<GetHostedCheckoutResponse>	GetHostedCheckoutResponse

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