Create refund
Payments
The payments REST services allow you to initiate a payment, retrieve the payment details or perform specific actions like refunding or requesting capture of a payment. A payment is identified by its paymentId. Some payment products allow a two step approach allowing you to control when the authorization takes place separate from when the funds are actually captured.
Request
You can refund any transaction by just calling this API. The system will automatically select the most appropriate means to refund the transaction based on the payment product that was used for the payment and the currency and the country of the refund request.
Depending on the payment product of the payment you will need to supply refund specific details on where the money should be refunded to or not. You always have the option to refund just a portion of the payment amount. It is also possible to submit multiple refund requests on one payment as long as the total amount to be refunded does not exceed the total amount that was paid.
PayloadRefundRequest
Properties
|
|||
Property | Type | Required | Details |
---|---|---|---|
object | no | read close | |
close
DescriptionObject containing amount and ISO currency code attributes
|
|||
amount | integer (12) | yes | read close |
close
DescriptionAmount in cents and always having 2 decimals
|
|||
currencyCode | string (3) | yes | read close |
close
DescriptionThree-letter ISO currency code representing the currency for the amount
|
|||
object | no | read close | |
close
DescriptionObject containing the specific input details for a bank refund
|
|||
object | no | read close | |
close
DescriptionObject that holds the Basic Bank Account Number (BBAN) data
|
|||
accountHolderName | string (30) | no | read close |
close
DescriptionName of the account holder
|
|||
accountNumber | string | no | read close |
close
DescriptionBank account number
|
|||
bankCity | string (40) | no | read close |
close
DescriptionCity of the bank to refund to
|
|||
bankCode | string | no | read close |
close
DescriptionBank code
|
|||
bankName | string (40) | no | read close |
close
DescriptionName of the bank
|
|||
branchCode | string | no | read close |
close
DescriptionBranch code
|
|||
checkDigit | string | no | read close |
close
DescriptionBank check digit
|
|||
countryCode | string (2) | no | read close |
close
DescriptionISO 3166-1 alpha-2 country code of the country where the bank account is held
|
|||
patronymicName | string (50) | no | read close |
close
DescriptionEvery Russian has three names: a first name, a patronymic, and a surname. The second name is a patronymic. Russian patronymic is a name derived from the father's first name by adding -ович/-евич (son of) for male, or -овна/-евна (daughter of) for females.
|
|||
swiftCode | string (11) | no | read close |
close
DescriptionThe BIC is the Business Identifier Code, also known as SWIFT or Bank Identifier code. It is a code with an internationally agreed format to Identify a specific bank. The BIC contains 8 or 11 positions: the first 4 contain the bank code, followed by the country code and location code.
|
|||
object | no | read close | |
close
DescriptionObject that holds the International Bank Account Number (IBAN) data
|
|||
accountHolderName | string (30) | depends | read close |
close
DescriptionName in which the account is held.
|
|||
iban | string (50) | depends | read close |
close
DescriptionThe IBAN is the International Bank Account Number. It is an internationally agreed format for the BBAN and includes the ISO country code and two check digits.
|
|||
countryCode | string (2) | no | read close |
close
DescriptionISO 3166-1 alpha-2 country code of the country where money will be refunded to
|
|||
object | no | read close | |
object | no | read close | |
additionalInfo | string (50) | no | read close |
close
DescriptionAdditional address information
|
|||
city | string | no | read close |
close
DescriptionCity
|
|||
countryCode | string (2) | no | read close |
close
DescriptionISO 3166-1 alpha-2 country code
|
|||
houseNumber | string (15) | no | read close |
close
DescriptionHouse number
|
|||
object | no | read close | |
firstName | string (15) | depends depends no depends depends | read close |
close
DescriptionGiven name(s) or first name(s) of the customer. The '+' character is not allowed in this property for transactions that are processed by TechProcess Payment Platform.
|
|||
surname | string (70) | depends depends depends depends depends | read close |
close
DescriptionSurname(s) or last name(s) of the customer. The surname is truncated after 25 characters, with the limit being applied after surnamePrefix is prepended, for payments, refunds or payouts that are processed by the WL Online Payment Acceptance platform The '+' character is not allowed in this property for transactions that are processed by TechProcess Payment Platform.
|
|||
surnamePrefix | string (15) | no | read close |
close
DescriptionMiddle name - In between first name and surname - of the customer. The '+' character is not allowed in this property for transactions that are processed by TechProcess Payment Platform.
|
|||
title | string (35) | depends | read close |
close
DescriptionTitle of customer
|
|||
state | string (35) | no | read close |
close
DescriptionFull name of the state or province
|
|||
stateCode | string | depends | read close |
close
DescriptionISO 3166-2 alpha-3 state code
Notes:
|
|||
street | string (50) | depends | read close |
close
DescriptionStreetname
|
|||
zip | string | depends | read close |
close
DescriptionZip code
|
|||
object | no | read close | |
name | string (40) | depends depends no no no | read close |
close
DescriptionName of company, as a customer
|
|||
vatNumber | string (17) | depends | read close |
close
DescriptionLocal VAT number of the company
|
|||
object | no | read close | |
close
DescriptionObject containing contact details like email address and phone number
|
|||
emailAddress | string (70) | no | read close |
close
DescriptionEmail address of the customer
|
|||
emailMessageType | string | no | read close |
close
DescriptionPreference for the type of email message markup
|
|||
fiscalNumber | string (14) | no | read close |
close
DescriptionThe fiscal registration number of the customer or the tax registration number of the company in case of a business customer. Please find below specifics per country:
|
|||
refundDate | string (8) | no | read close |
close
DescriptionRefund date
Format: YYYYMMDD |
|||
object | no | read close | |
close
DescriptionObject that holds all reference properties that are linked to this refund
|
|||
merchantReference | string (40) | no | read close |
close
DescriptionNote that the maximum length of this field for transactions processed on the GlobalCollect platform is 30. 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. |
Request example
This scenario you will probably use the most
-
amount_of_money = AmountOfMoney() amount_of_money.amount = 1 amount_of_money.currency_code = 'EUR' bank_account_iban = BankAccountIban() bank_account_iban.iban = 'NL53INGB0000000036' bank_refund_method_specific_input = BankRefundMethodSpecificInput() bank_refund_method_specific_input.bank_account_iban = bank_account_iban name = PersonalName() name.surname = 'Coyote' address = AddressPersonal() address.country_code = 'US' address.name = name contact_details = ContactDetailsBase() contact_details.email_address = 'wile.e.coyote@acmelabs.com' contact_details.email_message_type = 'html' customer = RefundCustomer() customer.address = address customer.contact_details = contact_details refund_references = RefundReferences() refund_references.merchant_reference = 'AcmeOrder0001' body = RefundRequest() body.amount_of_money = amount_of_money body.bank_refund_method_specific_input = bank_refund_method_specific_input body.customer = customer body.refund_date = '20140306' body.refund_references = refund_references try: response = client.v1().merchant('merchantId').payments().refund('paymentId', body) except DeclinedRefundException as e: self.handle_declined_refund(e.refund_result) except ApiException as e: self.handle_error_response(e.error_id, e.errors)
Responses
Please find below an overview of the possible responses.
Response 201 - CreatedRefundResponse
The refund was successfully created.
In the HTTP header the location is provided of the created refund object so you can easily query its status, by simply performing a GET on the URI provided in this header.
Properties
|
|||
Property | Type | Required | Details |
---|---|---|---|
id | string | no | read close |
close
DescriptionOur unique refund transaction identifier
|
|||
object | no | read close | |
close
DescriptionInformation of the refund resource such as amount, currency, nature of the refund.
|
|||
object | no | read close | |
close
DescriptionObject containing amount and ISO currency code attributes
|
|||
amount | integer (12) | yes | read close |
close
DescriptionAmount in cents and always having 2 decimals
|
|||
currencyCode | string (3) | yes | read close |
close
DescriptionThree-letter ISO currency code representing the currency for the amount
|
|||
amountPaid | integer | no | read close |
close
DescriptionAmount paid
|
|||
object | one of the group | read close | |
close
DescriptionObject containing specific bank refund details
|
|||
refundProductId | integer | no | read close |
close
DescriptionRefund product identifier
Please see refund products for a full overview of possible values. |
|||
totalAmountPaid | integer | no | read close |
close
DescriptionTotal paid amount (in cents and always with 2 decimals)
|
|||
totalAmountRefunded | integer | no | read close |
close
DescriptionTotal refunded amount (in cents and always with 2 decimals)
|
|||
object | one of the group | read close | |
close
DescriptionObject containing specific card refund details
|
|||
authorisationCode | string | no | read close |
close
DescriptionCard Authorization code as returned by the acquirer
|
|||
object | no | read close | |
cardNumber | string (19) | no | read close |
close
DescriptionThe complete credit/debit card number
|
|||
cardholderName | string | no | read close |
close
DescriptionThe card holder's name on the card.
|
|||
expiryDate | string (4) | no | read close |
close
DescriptionExpiry date of the card
Format: MMYY |
|||
refundProductId | integer | no | read close |
close
DescriptionRefund product identifier
Please see refund products for a full overview of possible values. |
|||
totalAmountPaid | integer | no | read close |
close
DescriptionTotal paid amount (in cents and always with 2 decimals)
|
|||
totalAmountRefunded | integer | no | read close |
close
DescriptionTotal refunded amount (in cents and always with 2 decimals)
|
|||
object | one of the group | read close | |
close
DescriptionObject containing specific cash refund details
|
|||
refundProductId | integer | no | read close |
close
DescriptionRefund product identifier
Please see refund products for a full overview of possible values. |
|||
totalAmountPaid | integer | no | read close |
close
DescriptionTotal paid amount (in cents and always with 2 decimals)
|
|||
totalAmountRefunded | integer | no | read close |
close
DescriptionTotal refunded amount (in cents and always with 2 decimals)
|
|||
object | one of the group | read close | |
close
DescriptionObject containing specific e-invoice refund details
|
|||
refundProductId | integer | no | read close |
close
DescriptionRefund product identifier
Please see refund products for a full overview of possible values. |
|||
totalAmountPaid | integer | no | read close |
close
DescriptionTotal paid amount (in cents and always with 2 decimals)
|
|||
totalAmountRefunded | integer | no | read close |
close
DescriptionTotal refunded amount (in cents and always with 2 decimals)
|
|||
object | one of the group | read close | |
close
DescriptionObject containing specific eWallet refund details
|
|||
object | yes | read close | |
close
DescriptionPayPal (payment product 840) specific details
|
|||
object | no | read close | |
close
DescriptionObject containing the PayPal account details
|
|||
customerAccountStatus | string | no | read close |
close
DescriptionStatus of the PayPal account.
Possible values are:
|
|||
customerAddressStatus | string | no | read close |
close
DescriptionStatus of the customer's shipping address as registered by PayPal
Possible values are:
|
|||
payerId | string | no | read close |
close
DescriptionThe unique identifier of a PayPal account and will never change in the life cycle of a PayPal account
|
|||
refundProductId | integer | no | read close |
close
DescriptionRefund product identifier
Please see refund products for a full overview of possible values. |
|||
totalAmountPaid | integer | no | read close |
close
DescriptionTotal paid amount (in cents and always with 2 decimals)
|
|||
totalAmountRefunded | integer | no | read close |
close
DescriptionTotal refunded amount (in cents and always with 2 decimals)
|
|||
object | one of the group | read close | |
close
DescriptionObject containing specific mobile refund details
|
|||
network | string | no | read close |
close
DescriptionThe 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.
|
|||
refundProductId | integer | no | read close |
close
DescriptionRefund product identifier
Please see refund products for a full overview of possible values. |
|||
totalAmountPaid | integer | no | read close |
close
DescriptionTotal paid amount (in cents and always with 2 decimals)
|
|||
totalAmountRefunded | integer | no | read close |
close
DescriptionTotal refunded amount (in cents and always with 2 decimals)
|
|||
paymentMethod | string | no | read close |
close
DescriptionPayment method identifier used by the our payment engine with the following possible values:
|
|||
object | no | read close | |
close
DescriptionObject that holds all reference properties that are linked to this refund
|
|||
merchantOrderId | integer | no | read close |
close
DescriptionYour order ID for this transaction that is also returned in our report files
|
|||
merchantReference | string | no | read close |
close
DescriptionYour 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.
|
|||
paymentReference | string | no | read close |
close
DescriptionPayment Reference generated by WebCollect
|
|||
providerId | string | no | read close |
close
DescriptionProvides an additional means of reconciliation for Gateway merchants
|
|||
providerMerchantId | string | no | read close |
close
DescriptionProvides an additional means of reconciliation, this is the MerchantId used at the provider
|
|||
providerReference | string | no | read close |
close
DescriptionProvides an additional means of reconciliation for Gateway merchants
|
|||
referenceOrigPayment | string | no | read close |
close
DescriptionWhen 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
|
|||
status | enum | no | read close |
close
DescriptionCurrent high-level status of the refund in a human-readable form. Possible values are:
Please see Statuses for a full overview of possible values. |
|||
object | no | read close | |
close
DescriptionThis 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.
|
|||
array of object | no | read close | |
close
DescriptionCustom object contains the set of errors
|
|||
object | no | read close | |
category | string | no | read close |
close
DescriptionCategory the error belongs to. The category should give an indication of the type of error you are dealing with.
Possible values:
|
|||
code | string | yes | read close |
close
DescriptionError code
|
|||
httpStatusCode | integer | no | read close |
close
DescriptionHTTP status code for this error that can be used to determine the type of error
|
|||
id | string | no | read close |
close
DescriptionID of the error. This is a short human-readable message that briefly describes the error.
|
|||
message | string | no | read close |
close
DescriptionHuman-readable error message that is not meant to be relayed to customer as it might tip off people who are trying to commit fraud
|
|||
propertyName | string | no | read close |
close
DescriptionReturned 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:
|
|||
requestId | string | no | read close |
close
DescriptionID of the request that can be used for debugging purposes
|
|||
isCancellable | boolean | no | read close |
close
DescriptionFlag indicating if the payment can be cancelled
|
|||
isRetriable | boolean | no | read close |
close
DescriptionFlag indicating whether a rejected payment may be retried by the merchant without incurring a fee
|
|||
array of object | no | read close | |
close
DescriptionThis 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.
|
|||
object | no | read close | |
key | string | no | read close |
close
DescriptionName of the key or property
|
|||
value | string | no | read close |
close
DescriptionValue of the key or property
|
|||
statusCategory | enum | no | read close |
close
DescriptionHighlevel status of the payment, payout or refund with the following possible values:
Please see Statuses for a full overview of possible values. |
|||
statusCode | integer | no | read close |
close
DescriptionNumeric 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.
|
|||
statusCodeChangeDateTime | string | no | read close |
close
DescriptionDate and time of payment
Format: YYYYMMDDHH24MISS |
Response example
This scenario you will probably use the most
-
{ "id" : "00000085001000006995000-300001", "refundOutput" : { "amountOfMoney" : { "amount" : 1, "currencyCode" : "EUR" }, "references" : { "merchantReference" : "AcmeOrder0001", "paymentReference" : "0" }, "paymentMethod" : "card", "cardRefundMethodSpecificOutput" : { "totalAmountPaid" : 2890, "totalAmountRefunded" : 0 } }, "status" : "PENDING_APPROVAL", "statusOutput" : { "isCancellable" : true, "statusCode" : 800, "statusCodeChangeDateTime" : "20140625154922" } }
Response 400 - Bad requestRefundErrorResponse
Properties
|
|||
Property | Type | Required | Details |
---|---|---|---|
errorId | string | yes | read close |
close
DescriptionUnique reference, for debugging purposes, of this error response
|
|||
array of object | yes | read close | |
close
DescriptionList of one or more errors
|
|||
object | no | read close | |
category | string | no | read close |
close
DescriptionCategory the error belongs to. The category should give an indication of the type of error you are dealing with.
Possible values:
|
|||
code | string | yes | read close |
close
DescriptionError code
|
|||
httpStatusCode | integer | no | read close |
close
DescriptionHTTP status code for this error that can be used to determine the type of error
|
|||
id | string | no | read close |
close
DescriptionID of the error. This is a short human-readable message that briefly describes the error.
|
|||
message | string | no | read close |
close
DescriptionHuman-readable error message that is not meant to be relayed to customer as it might tip off people who are trying to commit fraud
|
|||
propertyName | string | no | read close |
close
DescriptionReturned 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:
|
|||
requestId | string | no | read close |
close
DescriptionID of the request that can be used for debugging purposes
|
|||
object | no | read close | |
close
DescriptionObject that contains details on the created refund in case one has been created
|
|||
id | string | no | read close |
close
DescriptionOur unique refund transaction identifier
|
|||
object | no | read close | |
object | no | read close | |
close
DescriptionObject containing amount and ISO currency code attributes
|
|||
amount | integer (12) | yes | read close |
close
DescriptionAmount in cents and always having 2 decimals
|
|||
currencyCode | string (3) | yes | read close |
close
DescriptionThree-letter ISO currency code representing the currency for the amount
|
|||
amountPaid | integer | no | read close |
close
DescriptionAmount paid
|
|||
object | one of the group | read close | |
close
DescriptionObject containing specific bank refund details
|
|||
refundProductId | integer | no | read close |
close
DescriptionRefund product identifier
Please see refund products for a full overview of possible values. |
|||
totalAmountPaid | integer | no | read close |
close
DescriptionTotal paid amount (in cents and always with 2 decimals)
|
|||
totalAmountRefunded | integer | no | read close |
close
DescriptionTotal refunded amount (in cents and always with 2 decimals)
|
|||
object | one of the group | read close | |
close
DescriptionObject containing specific card refund details
|
|||
authorisationCode | string | no | read close |
close
DescriptionCard Authorization code as returned by the acquirer
|
|||
object | no | read close | |
cardNumber | string (19) | no | read close |
close
DescriptionThe complete credit/debit card number
|
|||
cardholderName | string | no | read close |
close
DescriptionThe card holder's name on the card.
|
|||
expiryDate | string (4) | no | read close |
close
DescriptionExpiry date of the card
Format: MMYY |
|||
refundProductId | integer | no | read close |
close
DescriptionRefund product identifier
Please see refund products for a full overview of possible values. |
|||
totalAmountPaid | integer | no | read close |
close
DescriptionTotal paid amount (in cents and always with 2 decimals)
|
|||
totalAmountRefunded | integer | no | read close |
close
DescriptionTotal refunded amount (in cents and always with 2 decimals)
|
|||
object | one of the group | read close | |
close
DescriptionObject containing specific cash refund details
|
|||
refundProductId | integer | no | read close |
close
DescriptionRefund product identifier
Please see refund products for a full overview of possible values. |
|||
totalAmountPaid | integer | no | read close |
close
DescriptionTotal paid amount (in cents and always with 2 decimals)
|
|||
totalAmountRefunded | integer | no | read close |
close
DescriptionTotal refunded amount (in cents and always with 2 decimals)
|
|||
object | one of the group | read close | |
close
DescriptionObject containing specific e-invoice refund details
|
|||
refundProductId | integer | no | read close |
close
DescriptionRefund product identifier
Please see refund products for a full overview of possible values. |
|||
totalAmountPaid | integer | no | read close |
close
DescriptionTotal paid amount (in cents and always with 2 decimals)
|
|||
totalAmountRefunded | integer | no | read close |
close
DescriptionTotal refunded amount (in cents and always with 2 decimals)
|
|||
object | one of the group | read close | |
close
DescriptionObject containing specific eWallet refund details
|
|||
object | yes | read close | |
close
DescriptionPayPal (payment product 840) specific details
|
|||
object | no | read close | |
close
DescriptionObject containing the PayPal account details
|
|||
customerAccountStatus | string | no | read close |
close
DescriptionStatus of the PayPal account.
Possible values are:
|
|||
customerAddressStatus | string | no | read close |
close
DescriptionStatus of the customer's shipping address as registered by PayPal
Possible values are:
|
|||
payerId | string | no | read close |
close
DescriptionThe unique identifier of a PayPal account and will never change in the life cycle of a PayPal account
|
|||
refundProductId | integer | no | read close |
close
DescriptionRefund product identifier
Please see refund products for a full overview of possible values. |
|||
totalAmountPaid | integer | no | read close |
close
DescriptionTotal paid amount (in cents and always with 2 decimals)
|
|||
totalAmountRefunded | integer | no | read close |
close
DescriptionTotal refunded amount (in cents and always with 2 decimals)
|
|||
object | one of the group | read close | |
close
DescriptionObject containing specific mobile refund details
|
|||
network | string | no | read close |
close
DescriptionThe 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.
|
|||
refundProductId | integer | no | read close |
close
DescriptionRefund product identifier
Please see refund products for a full overview of possible values. |
|||
totalAmountPaid | integer | no | read close |
close
DescriptionTotal paid amount (in cents and always with 2 decimals)
|
|||
totalAmountRefunded | integer | no | read close |
close
DescriptionTotal refunded amount (in cents and always with 2 decimals)
|
|||
paymentMethod | string | no | read close |
close
DescriptionPayment method identifier used by the our payment engine with the following possible values:
|
|||
object | no | read close | |
close
DescriptionObject that holds all reference properties that are linked to this refund
|
|||
merchantOrderId | integer | no | read close |
close
DescriptionYour order ID for this transaction that is also returned in our report files
|
|||
merchantReference | string | no | read close |
close
DescriptionYour 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.
|
|||
paymentReference | string | no | read close |
close
DescriptionPayment Reference generated by WebCollect
|
|||
providerId | string | no | read close |
close
DescriptionProvides an additional means of reconciliation for Gateway merchants
|
|||
providerMerchantId | string | no | read close |
close
DescriptionProvides an additional means of reconciliation, this is the MerchantId used at the provider
|
|||
providerReference | string | no | read close |
close
DescriptionProvides an additional means of reconciliation for Gateway merchants
|
|||
referenceOrigPayment | string | no | read close |
close
DescriptionWhen 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
|
|||
status | enum | no | read close |
close
DescriptionCurrent high-level status of the refund in a human-readable form. Possible values are:
Please see Statuses for a full overview of possible values. |
|||
object | no | read close | |
close
DescriptionThis 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.
|
|||
array of object | no | read close | |
close
DescriptionCustom object contains the set of errors
|
|||
object | no | read close | |
category | string | no | read close |
close
DescriptionCategory the error belongs to. The category should give an indication of the type of error you are dealing with.
Possible values:
|
|||
code | string | yes | read close |
close
DescriptionError code
|
|||
httpStatusCode | integer | no | read close |
close
DescriptionHTTP status code for this error that can be used to determine the type of error
|
|||
id | string | no | read close |
close
DescriptionID of the error. This is a short human-readable message that briefly describes the error.
|
|||
message | string | no | read close |
close
DescriptionHuman-readable error message that is not meant to be relayed to customer as it might tip off people who are trying to commit fraud
|
|||
propertyName | string | no | read close |
close
DescriptionReturned 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:
|
|||
requestId | string | no | read close |
close
DescriptionID of the request that can be used for debugging purposes
|
|||
isCancellable | boolean | no | read close |
close
DescriptionFlag indicating if the payment can be cancelled
|
|||
isRetriable | boolean | no | read close |
close
DescriptionFlag indicating whether a rejected payment may be retried by the merchant without incurring a fee
|
|||
array of object | no | read close | |
close
DescriptionThis 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.
|
|||
object | no | read close | |
key | string | no | read close |
close
DescriptionName of the key or property
|
|||
value | string | no | read close |
close
DescriptionValue of the key or property
|
|||
statusCategory | enum | no | read close |
close
DescriptionHighlevel status of the payment, payout or refund with the following possible values:
Please see Statuses for a full overview of possible values. |
|||
statusCode | integer | no | read close |
close
DescriptionNumeric 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.
|
|||
statusCodeChangeDateTime | string | no | read close |
close
DescriptionDate and time of payment
Format: YYYYMMDDHH24MISS |
Response example
This scenario you will probably use the most
-
{ "errorId" : "15eabcd5-30b3-479b-ae03-67bb351c07e6-00000092", "errors" : [ { "code" : "20000000", "propertyName" : "bankRefundMethodSpecificInput.bankAccountBban.accountNumber", "message" : "PARAMETER_NOT_FOUND_IN_REQUEST" } ] }
Response 404 - Not foundRefundErrorResponse
The most common cause for this response id that the payment was not in a cancelable state.
Properties
|
|||
Property | Type | Required | Details |
---|---|---|---|
errorId | string | yes | read close |
close
DescriptionUnique reference, for debugging purposes, of this error response
|
|||
array of object | yes | read close | |
close
DescriptionList of one or more errors
|
|||
object | no | read close | |
category | string | no | read close |
close
DescriptionCategory the error belongs to. The category should give an indication of the type of error you are dealing with.
Possible values:
|
|||
code | string | yes | read close |
close
DescriptionError code
|
|||
httpStatusCode | integer | no | read close |
close
DescriptionHTTP status code for this error that can be used to determine the type of error
|
|||
id | string | no | read close |
close
DescriptionID of the error. This is a short human-readable message that briefly describes the error.
|
|||
message | string | no | read close |
close
DescriptionHuman-readable error message that is not meant to be relayed to customer as it might tip off people who are trying to commit fraud
|
|||
propertyName | string | no | read close |
close
DescriptionReturned 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:
|
|||
requestId | string | no | read close |
close
DescriptionID of the request that can be used for debugging purposes
|
|||
object | no | read close | |
close
DescriptionObject that contains details on the created refund in case one has been created
|
|||
id | string | no | read close |
close
DescriptionOur unique refund transaction identifier
|
|||
object | no | read close | |
object | no | read close | |
close
DescriptionObject containing amount and ISO currency code attributes
|
|||
amount | integer (12) | yes | read close |
close
DescriptionAmount in cents and always having 2 decimals
|
|||
currencyCode | string (3) | yes | read close |
close
DescriptionThree-letter ISO currency code representing the currency for the amount
|
|||
amountPaid | integer | no | read close |
close
DescriptionAmount paid
|
|||
object | one of the group | read close | |
close
DescriptionObject containing specific bank refund details
|
|||
refundProductId | integer | no | read close |
close
DescriptionRefund product identifier
Please see refund products for a full overview of possible values. |
|||
totalAmountPaid | integer | no | read close |
close
DescriptionTotal paid amount (in cents and always with 2 decimals)
|
|||
totalAmountRefunded | integer | no | read close |
close
DescriptionTotal refunded amount (in cents and always with 2 decimals)
|
|||
object | one of the group | read close | |
close
DescriptionObject containing specific card refund details
|
|||
authorisationCode | string | no | read close |
close
DescriptionCard Authorization code as returned by the acquirer
|
|||
object | no | read close | |
cardNumber | string (19) | no | read close |
close
DescriptionThe complete credit/debit card number
|
|||
cardholderName | string | no | read close |
close
DescriptionThe card holder's name on the card.
|
|||
expiryDate | string (4) | no | read close |
close
DescriptionExpiry date of the card
Format: MMYY |
|||
refundProductId | integer | no | read close |
close
DescriptionRefund product identifier
Please see refund products for a full overview of possible values. |
|||
totalAmountPaid | integer | no | read close |
close
DescriptionTotal paid amount (in cents and always with 2 decimals)
|
|||
totalAmountRefunded | integer | no | read close |
close
DescriptionTotal refunded amount (in cents and always with 2 decimals)
|
|||
object | one of the group | read close | |
close
DescriptionObject containing specific cash refund details
|
|||
refundProductId | integer | no | read close |
close
DescriptionRefund product identifier
Please see refund products for a full overview of possible values. |
|||
totalAmountPaid | integer | no | read close |
close
DescriptionTotal paid amount (in cents and always with 2 decimals)
|
|||
totalAmountRefunded | integer | no | read close |
close
DescriptionTotal refunded amount (in cents and always with 2 decimals)
|
|||
object | one of the group | read close | |
close
DescriptionObject containing specific e-invoice refund details
|
|||
refundProductId | integer | no | read close |
close
DescriptionRefund product identifier
Please see refund products for a full overview of possible values. |
|||
totalAmountPaid | integer | no | read close |
close
DescriptionTotal paid amount (in cents and always with 2 decimals)
|
|||
totalAmountRefunded | integer | no | read close |
close
DescriptionTotal refunded amount (in cents and always with 2 decimals)
|
|||
object | one of the group | read close | |
close
DescriptionObject containing specific eWallet refund details
|
|||
object | yes | read close | |
close
DescriptionPayPal (payment product 840) specific details
|
|||
object | no | read close | |
close
DescriptionObject containing the PayPal account details
|
|||
customerAccountStatus | string | no | read close |
close
DescriptionStatus of the PayPal account.
Possible values are:
|
|||
customerAddressStatus | string | no | read close |
close
DescriptionStatus of the customer's shipping address as registered by PayPal
Possible values are:
|
|||
payerId | string | no | read close |
close
DescriptionThe unique identifier of a PayPal account and will never change in the life cycle of a PayPal account
|
|||
refundProductId | integer | no | read close |
close
DescriptionRefund product identifier
Please see refund products for a full overview of possible values. |
|||
totalAmountPaid | integer | no | read close |
close
DescriptionTotal paid amount (in cents and always with 2 decimals)
|
|||
totalAmountRefunded | integer | no | read close |
close
DescriptionTotal refunded amount (in cents and always with 2 decimals)
|
|||
object | one of the group | read close | |
close
DescriptionObject containing specific mobile refund details
|
|||
network | string | no | read close |
close
DescriptionThe 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.
|
|||
refundProductId | integer | no | read close |
close
DescriptionRefund product identifier
Please see refund products for a full overview of possible values. |
|||
totalAmountPaid | integer | no | read close |
close
DescriptionTotal paid amount (in cents and always with 2 decimals)
|
|||
totalAmountRefunded | integer | no | read close |
close
DescriptionTotal refunded amount (in cents and always with 2 decimals)
|
|||
paymentMethod | string | no | read close |
close
DescriptionPayment method identifier used by the our payment engine with the following possible values:
|
|||
object | no | read close | |
close
DescriptionObject that holds all reference properties that are linked to this refund
|
|||
merchantOrderId | integer | no | read close |
close
DescriptionYour order ID for this transaction that is also returned in our report files
|
|||
merchantReference | string | no | read close |
close
DescriptionYour 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.
|
|||
paymentReference | string | no | read close |
close
DescriptionPayment Reference generated by WebCollect
|
|||
providerId | string | no | read close |
close
DescriptionProvides an additional means of reconciliation for Gateway merchants
|
|||
providerMerchantId | string | no | read close |
close
DescriptionProvides an additional means of reconciliation, this is the MerchantId used at the provider
|
|||
providerReference | string | no | read close |
close
DescriptionProvides an additional means of reconciliation for Gateway merchants
|
|||
referenceOrigPayment | string | no | read close |
close
DescriptionWhen 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
|
|||
status | enum | no | read close |
close
DescriptionCurrent high-level status of the refund in a human-readable form. Possible values are:
Please see Statuses for a full overview of possible values. |
|||
object | no | read close | |
close
DescriptionThis 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.
|
|||
array of object | no | read close | |
close
DescriptionCustom object contains the set of errors
|
|||
object | no | read close | |
category | string | no | read close |
close
DescriptionCategory the error belongs to. The category should give an indication of the type of error you are dealing with.
Possible values:
|
|||
code | string | yes | read close |
close
DescriptionError code
|
|||
httpStatusCode | integer | no | read close |
close
DescriptionHTTP status code for this error that can be used to determine the type of error
|
|||
id | string | no | read close |
close
DescriptionID of the error. This is a short human-readable message that briefly describes the error.
|
|||
message | string | no | read close |
close
DescriptionHuman-readable error message that is not meant to be relayed to customer as it might tip off people who are trying to commit fraud
|
|||
propertyName | string | no | read close |
close
DescriptionReturned 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:
|
|||
requestId | string | no | read close |
close
DescriptionID of the request that can be used for debugging purposes
|
|||
isCancellable | boolean | no | read close |
close
DescriptionFlag indicating if the payment can be cancelled
|
|||
isRetriable | boolean | no | read close |
close
DescriptionFlag indicating whether a rejected payment may be retried by the merchant without incurring a fee
|
|||
array of object | no | read close | |
close
DescriptionThis 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.
|
|||
object | no | read close | |
key | string | no | read close |
close
DescriptionName of the key or property
|
|||
value | string | no | read close |
close
DescriptionValue of the key or property
|
|||
statusCategory | enum | no | read close |
close
DescriptionHighlevel status of the payment, payout or refund with the following possible values:
Please see Statuses for a full overview of possible values. |
|||
statusCode | integer | no | read close |
close
DescriptionNumeric 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.
|
|||
statusCodeChangeDateTime | string | no | read close |
close
DescriptionDate and time of payment
Format: YYYYMMDDHH24MISS |
Response example
This scenario you will probably use the most
-
{ "errorId" : "27ba5f42-e750-4cba-a3ed-9ab90067c849-0000917a", "errors" : [ { "code" : "300240", "requestId" : "142727", "message" : "GET_ORDERSTATUS ORDER NOT FOUND" } ] }