Class PaymentsClient

Payments client. Thread-safe.

Inheritance

object

ApiResource

PaymentsClient

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

Assembly: Worldline.Connect.Sdk.dll

Syntax

public class PaymentsClient : ApiResource

Constructors

PaymentsClient(ApiResource, IDictionary<string, string>)

Declaration

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

Parameters

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

Methods

Approve(string, ApprovePaymentRequest, CallContext)

Resource /{merchantId}/payments/{paymentId}/approve

• Approve payment

Declaration

public Task<PaymentApprovalResponse> Approve(string paymentId, ApprovePaymentRequest body, CallContext context = null)

Parameters

Type	Name	Description
string	paymentId	string
ApprovePaymentRequest	body	ApprovePaymentRequest
CallContext	context	CallContext

Returns

Type	Description
Task<PaymentApprovalResponse>	PaymentApprovalResponse

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

Cancel(string, CallContext)

Resource /{merchantId}/payments/{paymentId}/cancel

• Cancel payment

Declaration

public Task<CancelPaymentResponse> Cancel(string paymentId, CallContext context = null)

Parameters

Type	Name	Description
string	paymentId	string
CallContext	context	CallContext

Returns

Type	Description
Task<CancelPaymentResponse>	CancelPaymentResponse

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

Cancelapproval(string, CallContext)

Resource /{merchantId}/payments/{paymentId}/cancelapproval

• Undo capture payment

Declaration

public Task<CancelApprovalPaymentResponse> Cancelapproval(string paymentId, CallContext context = null)

Parameters

Type	Name	Description
string	paymentId	string
CallContext	context	CallContext

Returns

Type	Description
Task<CancelApprovalPaymentResponse>	CancelApprovalPaymentResponse

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

Capture(string, CapturePaymentRequest, CallContext)

Resource /{merchantId}/payments/{paymentId}/capture

• Capture payment

Declaration

public Task<CaptureResponse> Capture(string paymentId, CapturePaymentRequest body, CallContext context = null)

Parameters

Type	Name	Description
string	paymentId	string
CapturePaymentRequest	body	CapturePaymentRequest
CallContext	context	CallContext

Returns

Type	Description
Task<CaptureResponse>	CaptureResponse

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

Captures(string, CallContext)

Resource /{merchantId}/payments/{paymentId}/captures

• Get captures of payment

Declaration

public Task<CapturesResponse> Captures(string paymentId, CallContext context = null)

Parameters

Type	Name	Description
string	paymentId	string
CallContext	context	CallContext

Returns

Type	Description
Task<CapturesResponse>	CapturesResponse

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

Complete(string, CompletePaymentRequest, CallContext)

Resource /{merchantId}/payments/{paymentId}/complete

• Complete payment

Declaration

public Task<CompletePaymentResponse> Complete(string paymentId, CompletePaymentRequest body, CallContext context = null)

Parameters

Type	Name	Description
string	paymentId	string
CompletePaymentRequest	body	CompletePaymentRequest
CallContext	context	CallContext

Returns

Type	Description
Task<CompletePaymentResponse>	CompletePaymentResponse

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(CreatePaymentRequest, CallContext)

Resource /{merchantId}/payments

• Create payment

Declaration

public Task<CreatePaymentResponse> Create(CreatePaymentRequest body, CallContext context = null)

Parameters

Type	Name	Description
CreatePaymentRequest	body	CreatePaymentRequest
CallContext	context	CallContext

Returns

Type	Description
Task<CreatePaymentResponse>	CreatePaymentResponse

Exceptions

Type	Condition
DeclinedPaymentException	if the Worldline Global Collect platform declined / rejected the payment. The payment result will be available from the exception.
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

Devicefingerprint(string, CallContext)

Resource /{merchantId}/payments/{paymentId}/devicefingerprint

• Get Device Fingerprint details

Declaration

public Task<DeviceFingerprintDetails> Devicefingerprint(string paymentId, CallContext context = null)

Parameters

Type	Name	Description
string	paymentId	string
CallContext	context	CallContext

Returns

Type	Description
Task<DeviceFingerprintDetails>	DeviceFingerprintDetails

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

Dispute(string, CreateDisputeRequest, CallContext)

Resource /{merchantId}/payments/{paymentId}/dispute

• Create dispute

Declaration

public Task<DisputeResponse> Dispute(string paymentId, CreateDisputeRequest body, CallContext context = null)

Parameters

Type	Name	Description
string	paymentId	string
CreateDisputeRequest	body	CreateDisputeRequest
CallContext	context	CallContext

Returns

Type	Description
Task<DisputeResponse>	DisputeResponse

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

Disputes(string, CallContext)

Resource /{merchantId}/payments/{paymentId}/disputes

• Get disputes

Declaration

public Task<DisputesResponse> Disputes(string paymentId, CallContext context = null)

Parameters

Type	Name	Description
string	paymentId	string
CallContext	context	CallContext

Returns

Type	Description
Task<DisputesResponse>	DisputesResponse

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

Find(FindPaymentsParams, CallContext)

Resource /{merchantId}/payments

• Find payments

Declaration

public Task<FindPaymentsResponse> Find(FindPaymentsParams query, CallContext context = null)

Parameters

Type	Name	Description
FindPaymentsParams	query	FindPaymentsParams
CallContext	context	CallContext

Returns

Type	Description
Task<FindPaymentsResponse>	FindPaymentsResponse

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, GetPaymentParams, CallContext)

Resource /{merchantId}/payments/{paymentId}

• Get payment

Declaration

public Task<PaymentResponse> Get(string paymentId, GetPaymentParams query, CallContext context = null)

Parameters

Type	Name	Description
string	paymentId	string
GetPaymentParams	query	GetPaymentParams
CallContext	context	CallContext

Returns

Type	Description
Task<PaymentResponse>	PaymentResponse

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

Processchallenged(string, CallContext)

Resource /{merchantId}/payments/{paymentId}/processchallenged

• Approves challenged payment

Declaration

public Task<PaymentResponse> Processchallenged(string paymentId, CallContext context = null)

Parameters

Type	Name	Description
string	paymentId	string
CallContext	context	CallContext

Returns

Type	Description
Task<PaymentResponse>	PaymentResponse

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

Refund(string, RefundRequest, CallContext)

Resource /{merchantId}/payments/{paymentId}/refund

• Create refund

Declaration

public Task<RefundResponse> Refund(string paymentId, RefundRequest body, CallContext context = null)

Parameters

Type	Name	Description
string	paymentId	string
RefundRequest	body	RefundRequest
CallContext	context	CallContext

Returns

Type	Description
Task<RefundResponse>	RefundResponse

Exceptions

Type	Condition
DeclinedRefundException	if the Worldline Global Collect platform declined / rejected the refund. The refund result will be available from the exception.
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

Refunds(string, CallContext)

Resource /{merchantId}/payments/{paymentId}/refunds

• Get refunds of payment

Declaration

public Task<RefundsResponse> Refunds(string paymentId, CallContext context = null)

Parameters

Type	Name	Description
string	paymentId	string
CallContext	context	CallContext

Returns

Type	Description
Task<RefundsResponse>	RefundsResponse

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

ThirdPartyStatus(string, CallContext)

Resource /{merchantId}/payments/{paymentId}/thirdpartystatus

• Third party status poll

Declaration

public Task<ThirdPartyStatusResponse> ThirdPartyStatus(string paymentId, CallContext context = null)

Parameters

Type	Name	Description
string	paymentId	string
CallContext	context	CallContext

Returns

Type	Description
Task<ThirdPartyStatusResponse>	ThirdPartyStatusResponse

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

Tokenize(string, TokenizePaymentRequest, CallContext)

Resource /{merchantId}/payments/{paymentId}/tokenize

• Create a token from payment

Declaration

public Task<CreateTokenResponse> Tokenize(string paymentId, TokenizePaymentRequest body, CallContext context = null)

Parameters

Type	Name	Description
string	paymentId	string
TokenizePaymentRequest	body	TokenizePaymentRequest
CallContext	context	CallContext

Returns

Type	Description
Task<CreateTokenResponse>	CreateTokenResponse

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