Class PaymentsClient

Payments client. Thread-safe.

Inheritance

object

ApiResource

PaymentsClient

Inherited Members

ApiResource._communicator

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

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Worldline.Acquiring.Sdk.V1.Acquirer.Merchant.Payments

Assembly: Worldline.Acquiring.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

CreateRefund(string, ApiPaymentRefundRequest, CallContext)

Resource /processing/v1/{acquirerId}/{merchantId}/payments/{paymentId}/refunds

Refund payment

Declaration

public Task<ApiActionResponseForRefund> CreateRefund(string paymentId, ApiPaymentRefundRequest body, CallContext context = null)

Parameters

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

Returns

Type	Description
Task<ApiActionResponseForRefund>	ApiActionResponseForRefund

Exceptions

Type	Condition
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 Acquiring platform, the Worldline Acquiring 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 Acquiring platform returned any other error

GetPaymentStatus(string, GetPaymentStatusParams, CallContext)

Resource /processing/v1/{acquirerId}/{merchantId}/payments/{paymentId}

Retrieve payment

Declaration

public Task<ApiPaymentResource> GetPaymentStatus(string paymentId, GetPaymentStatusParams query, CallContext context = null)

Parameters

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

Returns

Type	Description
Task<ApiPaymentResource>	ApiPaymentResource

Exceptions

Type	Condition
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 Acquiring platform, the Worldline Acquiring 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 Acquiring platform returned any other error

IncrementPayment(string, ApiIncrementRequest, CallContext)

Resource /processing/v1/{acquirerId}/{merchantId}/payments/{paymentId}/increments

Increment authorization

Declaration

public Task<ApiIncrementResponse> IncrementPayment(string paymentId, ApiIncrementRequest body, CallContext context = null)

Parameters

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

Returns

Type	Description
Task<ApiIncrementResponse>	ApiIncrementResponse

Exceptions

Type	Condition
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 Acquiring platform, the Worldline Acquiring 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 Acquiring platform returned any other error

ProcessPayment(ApiPaymentRequest, CallContext)

Resource /processing/v1/{acquirerId}/{merchantId}/payments

Create payment

Declaration

public Task<ApiPaymentResponse> ProcessPayment(ApiPaymentRequest body, CallContext context = null)

Parameters

Type	Name	Description
ApiPaymentRequest	body	ApiPaymentRequest
CallContext	context	CallContext

Returns

Type	Description
Task<ApiPaymentResponse>	ApiPaymentResponse

Exceptions

Type	Condition
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 Acquiring platform, the Worldline Acquiring 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 Acquiring platform returned any other error

ReverseAuthorization(string, ApiPaymentReversalRequest, CallContext)

Resource /processing/v1/{acquirerId}/{merchantId}/payments/{paymentId}/authorization-reversals

Reverse authorization

Declaration

public Task<ApiReversalResponse> ReverseAuthorization(string paymentId, ApiPaymentReversalRequest body, CallContext context = null)

Parameters

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

Returns

Type	Description
Task<ApiReversalResponse>	ApiReversalResponse

Exceptions

Type	Condition
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 Acquiring platform, the Worldline Acquiring 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 Acquiring platform returned any other error

SimpleCaptureOfPayment(string, ApiCaptureRequest, CallContext)

Resource /processing/v1/{acquirerId}/{merchantId}/payments/{paymentId}/captures

Capture payment

Declaration

public Task<ApiActionResponse> SimpleCaptureOfPayment(string paymentId, ApiCaptureRequest body, CallContext context = null)

Parameters

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

Returns

Type	Description
Task<ApiActionResponse>	ApiActionResponse

Exceptions

Type	Condition
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 Acquiring platform, the Worldline Acquiring 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 Acquiring platform returned any other error