This site requires javascript to be enabled.

  • Search AI-powered
    Search results are AI-generated and are not guaranteed to be accurate, complete, or up-to-date. They are not a substitute for legal or professional advice. Refer to our terms of use for more details.
    Search AI-powered

Results for

xxx

Get refund

GET https://{domainname}/v1/{merchantId}/refunds/{refundId}

Refunds

The refund API allows you to manipulate refunds that have been created on a payment. Funds will be refunded to either the card or wallet that was originally charged or to a bank account if a direct refund is not possible

Request

This REST service retrieves the status and additional information of a refund. No payload is required in the request.

Request example

SDK: Ruby

This scenario you will probably use the most

  • response = client.v1.merchant('merchantId').refunds.get('refundId')

Responses

Please find below an overview of the possible responses.

Response 200 - OKRefundResponse

For every successfully fetched refund resource a HTTP 200 response is returned. The response body holds JSON objects detailing the refund resource retrieved.

Properties
Property Type Required Details
close

Description

Our unique refund transaction identifier
close

Description

Information of the refund resource such as amount, currency, nature of the refund.
  • SDK Object type
    RefundOutput
close

Description

Object containing amount and ISO currency code attributes
  • SDK Object type
    AmountOfMoney
close

Description

Amount in cents and always having 2 decimals
close

Description

Three-letter ISO currency code representing the currency for the amount
close

Description

Amount paid
close

Description

Object containing specific bank refund details
  • SDK Object type
    RefundBankMethodSpecificOutput
  • Property is part of a group
    Learn more

    Properties that make up a group are mutually exclusive, which means you can only include one of each group in any given call.

    If there are multiple groups at one level in the object hierarchy we use numbers to distinguish groups from one another.
close

Description

Refund product identifier
Please see refund products for a full overview of possible values.
close

Description

Total paid amount (in cents and always with 2 decimals)
close

Description

Total refunded amount (in cents and always with 2 decimals)
close

Description

Object containing specific card refund details
  • SDK Object type
    RefundCardMethodSpecificOutput
  • Property is part of a group
    Learn more

    Properties that make up a group are mutually exclusive, which means you can only include one of each group in any given call.

    If there are multiple groups at one level in the object hierarchy we use numbers to distinguish groups from one another.
close

Description

Card Authorization code as returned by the acquirer
close

Description

Object containing card details
  • SDK Object type
    CardEssentials
close

Description

The complete credit/debit card number
close

Description

The card holder's name on the card. Minimum length of 2, maximum length of 51 characters.
close

Description

Expiry date of the card
Format: MMYY
close

Description

Refund product identifier
Please see refund products for a full overview of possible values.
close

Description

Total paid amount (in cents and always with 2 decimals)
close

Description

Total refunded amount (in cents and always with 2 decimals)
close

Description

Object containing specific cash refund details
  • SDK Object type
    RefundCashMethodSpecificOutput
  • Property is part of a group
    Learn more

    Properties that make up a group are mutually exclusive, which means you can only include one of each group in any given call.

    If there are multiple groups at one level in the object hierarchy we use numbers to distinguish groups from one another.
close

Description

Refund product identifier
Please see refund products for a full overview of possible values.
close

Description

Total paid amount (in cents and always with 2 decimals)
close

Description

Total refunded amount (in cents and always with 2 decimals)
close

Description

Object containing specific e-invoice refund details
  • SDK Object type
    RefundEInvoiceMethodSpecificOutput
  • Property is part of a group
    Learn more

    Properties that make up a group are mutually exclusive, which means you can only include one of each group in any given call.

    If there are multiple groups at one level in the object hierarchy we use numbers to distinguish groups from one another.
close

Description

Refund product identifier
Please see refund products for a full overview of possible values.
close

Description

Total paid amount (in cents and always with 2 decimals)
close

Description

Total refunded amount (in cents and always with 2 decimals)
close

Description

Object containing specific eWallet refund details
  • SDK Object type
    RefundEWalletMethodSpecificOutput
  • Property is part of a group
    Learn more

    Properties that make up a group are mutually exclusive, which means you can only include one of each group in any given call.

    If there are multiple groups at one level in the object hierarchy we use numbers to distinguish groups from one another.
close

Description

PayPal (payment product 840) specific details
  • SDK Object type
    RefundPaymentProduct840SpecificOutput
close

Description

Object containing the PayPal account details
  • SDK Object type
    RefundPaymentProduct840CustomerAccount
close

Description

Status of the PayPal account.
Possible values are:
  • verified - PayPal has verified the funding means for this account
  • unverified - PayPal has not verified the funding means for this account
close

Description

Status of the customer's shipping address as registered by PayPal
Possible values are:
  • none - Status is unknown at PayPal
  • confirmed - The address has been confirmed
  • unconfirmed - The address has not been confirmed
close

Description

The unique identifier of a PayPal account and will never change in the life cycle of a PayPal account
close

Description

Refund product identifier
Please see refund products for a full overview of possible values.
close

Description

Total paid amount (in cents and always with 2 decimals)
close

Description

Total refunded amount (in cents and always with 2 decimals)
close

Description

Object containing specific mobile refund details
  • SDK Object type
    RefundMobileMethodSpecificOutput
  • Property is part of a group
    Learn more

    Properties that make up a group are mutually exclusive, which means you can only include one of each group in any given call.

    If there are multiple groups at one level in the object hierarchy we use numbers to distinguish groups from one another.
close

Description

The network that was used for the refund. The string that represents the network is identical to the strings that the payment product vendors use in their documentation. For instance: "Visa" for Apple Pay, and "VISA" for Google Pay.
close

Description

Refund product identifier
Please see refund products for a full overview of possible values.
close

Description

Total paid amount (in cents and always with 2 decimals)
close

Description

Total refunded amount (in cents and always with 2 decimals)
close

Description

Payment method identifier used by the our payment engine with the following possible values:
  • bankRefund
  • bankTransfer
  • card
  • cash
  • directDebit
  • eInvoice
  • invoice
  • redirect
close

Description

Object that holds all reference properties that are linked to this refund
  • SDK Object type
    PaymentReferences
close

Description

Your order ID for this transaction that is also returned in our report files
close

Description

Your unique reference of the transaction that is also returned in our report files. This is almost always used for your reconciliation of our report files.
close

Description

Payment Reference generated by WebCollect
close

Description

Provides an additional means of reconciliation for Gateway merchants
close

Description

Provides an additional means of reconciliation, this is the MerchantId used at the provider
close

Description

Provides an additional means of reconciliation for Gateway merchants
close

Description

When you did not supply a merchantReference for your payment, you need to fill this property with the reference of the original payment when you want to refund it
close

Description

Current high-level status of the refund in a human-readable form. Possible values are:
  • CREATED - The transaction has been created. This is the initial state once a new refund is created.
  • PENDING_APPROVAL - The transaction is awaiting approval from you to proceed with the processing of the refund
  • REJECTED - The refund has been rejected
  • REFUND_REQUESTED - The transaction is in the queue to be refunded
  • CAPTURED - We have successfully refunded the customer and has received an online confirmation from the third party
  • REFUNDED - We have successfully refunded the customer
  • CANCELLED - You have cancelled the transaction

Please see Statuses for a full overview of possible values.
close

Description

This object has the numeric representation of the current refund status, timestamp of last status change and performable action on the current refund resource.
In case of a rejected refund, detailed error information is listed.
  • SDK Object type
    OrderStatusOutput
close

Description

Custom object contains the set of errors
close

Description

Contains detailed information on one single error.
  • SDK Object type
    APIError
close

Description

Category the error belongs to. The category should give an indication of the type of error you are dealing with. Possible values:
  • CONNECT_PLATFORM_ERROR - indicating that a functional error has occurred in the Connect platform.
  • PAYMENT_PLATFORM_ERROR - indicating that a functional error has occurred in the Payment platform.
  • IO_ERROR - indicating that a technical error has occurred within the Connect platform or between Connect and any of the payment platforms or third party systems.
close

Description

Error code
close

Description

HTTP status code for this error that can be used to determine the type of error
close

Description

ID of the error. This is a short human-readable message that briefly describes the error.
close

Description

Human-readable error message that is not meant to be relayed to customer as it might tip off people who are trying to commit fraud
close

Description

Returned only if the error relates to a value that was missing or incorrect.
Contains a location path to the value as a JSonata query.
Some common examples:
  • a.b selects the value of property b of root property a,
  • a[1] selects the first element of the array in root property a,
  • a[b='some value'] selects all elements of the array in root property a that have a property b with value 'some value'.
close

Description

ID of the request that can be used for debugging purposes
close

Description

Flag indicating if the payment can be cancelled
  • true
  • false
close

Description

Flag indicating whether a rejected payment may be retried by the merchant without incurring a fee
  • true
  • false
close

Description

This is the raw response returned by the acquirer. This property contains unprocessed data directly returned by the acquirer. It's recommended for data analysis only due to its dynamic nature, which may undergo future changes.
close
  • SDK Object type
    KeyValuePair
close

Description

Name of the key or property
close

Description

Value of the key or property
close

Description

Highlevel status of the payment, payout or refund with the following possible values:
  • CREATED - The transaction has been created. This is the initial state once a new payment, payout or refund is created. This category groups the following statuses:
    • CREATED
  • PENDING_PAYMENT: The payment is waiting on customer action. This category groups the following statuses:
    • PENDING_PAYMENT
    • REDIRECTED
  • ACCOUNT_VERIFIED: The account has been verified. This category groups the following statuses:
    • ACCOUNT_VERIFIED
  • PENDING_MERCHANT: The transaction is awaiting approval to proceed with the payment, payout or refund. This category groups the following statuses:
    • PENDING_APPROVAL
    • PENDING_COMPLETION
    • PENDING_CAPTURE
    • PENDING_FRAUD_APPROVAL
  • PENDING_CONNECT_OR_3RD_PARTY: The transaction is in the queue to be processed. This category groups the following statuses:
    • AUTHORIZATION_REQUESTED
    • CAPTURE_REQUESTED
    • PAYOUT_REQUESTED
    • REFUND_REQUESTED
  • COMPLETED: The transaction has completed. This category groups the following statuses:
    • CAPTURED
    • PAID
    • ACCOUNT_CREDITED
    • CHARGEBACK_NOTIFICATION
  • REVERSED: The transaction has been reversed. This category groups the following statuses:
    • CHARGEBACKED
    • REVERSED
  • REFUNDED: The transaction has been refunded. This category groups the following statuses:
    • REFUNDED
  • UNSUCCESSFUL: The transaction has been rejected or is in such a state that it will never become successful. This category groups the following statuses:
    • CANCELLED
    • REJECTED
    • REJECTED_CAPTURE
    • REJECTED_CREDIT

Please see Statuses for a full overview of possible values.
close

Description

Numeric status code of the legacy API. It is returned to ease the migration from the legacy APIs to Worldline Connect. You should not write new business logic based on this property as it will be deprecated in a future version of the API. The value can also be found in the GlobalCollect Payment Console, in the Ogone BackOffice and in report files.
close

Description

Date and time of payment
Format: YYYYMMDDHH24MISS

Response example

SDK: Ruby

This scenario you will probably use the most

  • {
    "id" : "00000085001000006995000-500001",
    "refundOutput" : {
        "amountOfMoney" : {
            "amount" : 1,
            "currencyCode" : "EUR"
        },
        "references" : {
            "merchantReference" : "AcmeOrder0001",
            "paymentReference" : "0"
        },
        "paymentMethod" : "card",
        "cardRefundMethodSpecificOutput" : {
            "totalAmountPaid" : 100,
            "totalAmountRefunded" : 0
        }
    },
    "status" : "PENDING_APPROVAL",
    "statusOutput" : {
        "isCancellable" : true,
        "statusCode" : 800,
        "statusCodeChangeDateTime" : "20140630132747"
    }
}