Search Results for

    Show / Hide Table of Contents

    Class RefundsClient

    Refunds client. Thread-safe.

    Inheritance
    object
    ApiResource
    RefundsClient
    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.Refunds
    Assembly: Worldline.Acquiring.Sdk.dll
    Syntax
    public class RefundsClient : ApiResource

    Constructors

    RefundsClient(ApiResource, IDictionary<string, string>)

    Declaration
    public RefundsClient(ApiResource parent, IDictionary<string, string> pathContext)
    Parameters
    Type Name Description
    ApiResource parent
    IDictionary<string, string> pathContext

    Methods

    CaptureRefund(string, ApiCaptureRequestForRefund, CallContext)

    Resource /processing/v1/{acquirerId}/{merchantId}/refunds/{refundId}/captures

    • Capture refund
    Declaration
    public Task<ApiActionResponseForRefund> CaptureRefund(string refundId, ApiCaptureRequestForRefund body, CallContext context = null)
    Parameters
    Type Name Description
    string refundId

    string

    ApiCaptureRequestForRefund body

    ApiCaptureRequestForRefund

    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

    GetRefund(string, GetRefundParams, CallContext)

    Resource /processing/v1/{acquirerId}/{merchantId}/refunds/{refundId}

    • Retrieve refund
    Declaration
    public Task<ApiRefundResource> GetRefund(string refundId, GetRefundParams query, CallContext context = null)
    Parameters
    Type Name Description
    string refundId

    string

    GetRefundParams query

    GetRefundParams

    CallContext context

    CallContext

    Returns
    Type Description
    Task<ApiRefundResource>

    ApiRefundResource

    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

    ProcessStandaloneRefund(ApiRefundRequest, CallContext)

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

    • Create standalone refund
    Declaration
    public Task<ApiRefundResponse> ProcessStandaloneRefund(ApiRefundRequest body, CallContext context = null)
    Parameters
    Type Name Description
    ApiRefundRequest body

    ApiRefundRequest

    CallContext context

    CallContext

    Returns
    Type Description
    Task<ApiRefundResponse>

    ApiRefundResponse

    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

    ReverseRefundAuthorization(string, ApiRefundReversalRequest, CallContext)

    Resource /processing/v1/{acquirerId}/{merchantId}/refunds/{refundId}/authorization-reversals

    • Reverse refund authorization
    Declaration
    public Task<ApiActionResponseForRefund> ReverseRefundAuthorization(string refundId, ApiRefundReversalRequest body, CallContext context = null)
    Parameters
    Type Name Description
    string refundId

    string

    ApiRefundReversalRequest body

    ApiRefundReversalRequest

    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

    In This Article
    Back to top Copyright (c) 2024 Worldline Financial Services (Europe) SA