Create refund

POST https://{domainname}/v1/{merchantId}/payments/{paymentId}/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.

Create refund supports idempotent requests

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

Property	Type	Required	Details
Properties Expand all properties Hide deprecated properties
amountOfMoney	object	no	read close
close Description Object containing amount and ISO currency code attributes SDK Object type AmountOfMoney
amount	integer (12)	yes	read close
close Description Amount in cents and always having 2 decimals
currencyCode	string (3)	yes	read close
close Description Three-letter ISO currency code representing the currency for the amount
bankRefundMethodSpecificInput	object	no	read close
close Description Object containing the specific input details for a bank refund SDK Object type BankRefundMethodSpecificInput
Group bankAccountBban	object	no	read close
close Description Object that holds the Basic Bank Account Number (BBAN) data SDK Object type BankAccountBbanRefund 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.
accountHolderName	string (30)	no	read close
close Description Name of the account holder
accountNumber	string	no	read close
close Description Bank account number
bankCity	string (40)	no	read close
close Description City of the bank to refund to
bankCode	string	no	read close
close Description Bank code
bankName	string (40)	no	read close
close Description Name of the bank
branchCode	string	no	read close
close Description Branch code
checkDigit	string	no	read close
close Description Bank check digit
countryCode	string (2)	no	read close
close Description ISO 3166-1 alpha-2 country code of the country where the bank account is held
patronymicName	string (50)	no	read close
close Description Every 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 Description The 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.
Group bankAccountIban	object	no	read close
close Description Object that holds the International Bank Account Number (IBAN) data SDK Object type BankAccountIban 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.
accountHolderName	string (30)	depends	read close
close Description Name in which the account is held. Depends on: Required for the creation of a Payout Required for Create and Update token calls.
iban	string (50)	depends	read close
close Description The 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. Depends on: Required for the creation of a Payout Required for Create and Update token. Required for payments with product 9000 (AfterPay Installments) in Austria (AT) and Germany (DE). Required for Create mandate and Create payment with mandate calls
countryCode	string (2)	no	read close
close Description ISO 3166-1 alpha-2 country code of the country where money will be refunded to
customer	object	no	read close
close Description Object containing the details of the customer SDK Object type RefundCustomer
address	object	no	read close
close Description Object containing address details SDK Object type AddressPersonal
additionalInfo	string (50)	no	read close
close Description Additional address information
city	string	no depends no no depends	read close
close Description City Depends on: Required by the TechProcess platform for cross-border merchants. Depends on: Required for cross-border merchants.
countryCode	string (2)	no depends no no depends	read close
close Description ISO 3166-1 alpha-2 country code Depends on: Required by the TechProcess platform for cross-border merchants. Depends on: Required for cross-border merchants.
houseNumber	string (15)	no	read close
close Description House number
name	object	no depends no no depends	read close
close Description Object that holds the name elements Depends on: Required by the TechProcess platform for cross-border merchants. Depends on: Required for cross-border merchants. SDK Object type PersonalName
firstName	string (15)	depends depends no depends depends	read close
close Description Given 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. Depends on: Required for payments with product Banco do Brasil (paymentProductId 6101), Itaú (paymentProductId 6102), Banrisul (paymentProductId 6103), Bradesco (paymentProductId 6104), Pix (paymentProductId 6105), PicPay (paymentProductId 6107) or SPEI (paymentProductId 6501). For payments made in Brazil, this property is only required when the property order.customer.fiscalNumber is Personal (CPF) - 11 digits. Depends on: Required by the GlobalCollect platform for payments with: Trustly (paymentProductId 806) Pix (paymentProductId 6105), but only for payments made in Brazil when the property order.customer.fiscalNumber is Personal (CPF) - 11 digits Mercado Pago (paymentProductId 6106), but only for payments made in Brazil when the property order.customer.fiscalNumber is Personal (CPF) - 11 digits PicPay (paymentProductId 6107), but only for payments made in Brazil when the property order.customer.fiscalNumber is Personal (CPF) - 11 digits AfterPay Installments (paymentProductId 9000) AfterPay Invoice (paymentProductId 9001) BC Card (paymentProductId 8590) Hana Card (paymentProductId 8591) Hyundai Card (paymentProductId 8592) KB Card (paymentProductId 8593) Lotte Card (paymentProductId 8594) NH Card (paymentProductId 8595) Samsung Card (paymentProductId 8596) Shinhan Card (paymentProductId 8597) Required for merchants that use Merchant Category Codes (MCC) V4829, V6012, M4829, V6051, M6540, 7995. Required by the WOPA platform for payments with product Banco do Brasil (paymentProductId 6101), Itaú (paymentProductId 6102), Banrisul (paymentProductId 6103), Bradesco (paymentProductId 6104), Pix (paymentProductId 6105), PicPay (paymentProductId 6107) or SPEI (paymentProductId 6501). For payments made in Brazil, this property is only required when the property order.customer.fiscalNumber is Personal (CPF) - 11 digits. Required by the TechProcess platform for payments. Depends on: Required for payments with: Trustly (paymentProductId 806) Pix (paymentProductId 6105), but only for payments made in Brazil when the property order.customer.fiscalNumber is Personal (CPF) - 11 digits Mercado Pago (paymentProductId 6106), but only for payments made in Brazil when the property order.customer.fiscalNumber is Personal (CPF) - 11 digits PicPay (paymentProductId 6107), but only for payments made in Brazil when the property order.customer.fiscalNumber is Personal (CPF) - 11 digits AfterPay Installments (paymentProductId 9000) AfterPay Invoice (paymentProductId 9001) BC Card (paymentProductId 8590) Hana Card (paymentProductId 8591) Hyundai Card (paymentProductId 8592) KB Card (paymentProductId 8593) Lotte Card (paymentProductId 8594) NH Card (paymentProductId 8595) Samsung Card (paymentProductId 8596) Shinhan Card (paymentProductId 8597) Required for merchants that use Merchant Category Codes (MCC) V4829, V6012, M4829, V6051, M6540, 7995. Depends on: Required for payments.
surname	string (70)	depends depends depends depends depends	read close
close Description Surname(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. Depends on: Required for payments with product Banco do Brasil (paymentProductId 6101), Itaú (paymentProductId 6102), Banrisul (paymentProductId 6103), Bradesco (paymentProductId 6104), Pix (paymentProductId 6105), PicPay (paymentProductId 6107) or SPEI (paymentProductId 6501). For payments made in Brazil, this property is only required when the property order.customer.fiscalNumber is Personal (CPF) - 11 digits. Required for the creation of a Payout. Depends on: Required by the GlobalCollect platform for payments with: Trustly (paymentProductId 806) Pix (paymentProductId 6105), but only for payments made in Brazil when the property order.customer.fiscalNumber is Personal (CPF) - 11 digits Mercado Pago (paymentProductId 6106), but only for payments made in Brazil when the property order.customer.fiscalNumber is Personal (CPF) - 11 digits PicPay (paymentProductId 6107), but only for payments made in Brazil when the property order.customer.fiscalNumber is Personal (CPF) - 11 digits AfterPay Installments (paymentProductId 9000) AfterPay Invoice (paymentProductId 9001) BC Card (paymentProductId 8590) Hana Card (paymentProductId 8591) Hyundai Card (paymentProductId 8592) KB Card (paymentProductId 8593) Lotte Card (paymentProductId 8594) NH Card (paymentProductId 8595) Samsung Card (paymentProductId 8596) Shinhan Card (paymentProductId 8597) Required for the creation of a Payout. Required for merchants that use Merchant Category Codes (MCC) V4829, V6012, M4829, V6051, M6540, 7995. Required by the WOPA platform for payments with product Banco do Brasil (paymentProductId 6101), Itaú (paymentProductId 6102), Banrisul (paymentProductId 6103), Bradesco (paymentProductId 6104), Pix (paymentProductId 6105), PicPay (paymentProductId 6107) or SPEI (paymentProductId 6501). For payments made in Brazil, this property is only required when the property order.customer.fiscalNumber is Personal (CPF) - 11 digits. Required for the creation of a Payout. Required by the Ogone platform for the creation of a Payout. Required by the TechProcess platform for the creation of a payment. Depends on: Required for the creation of a Payout. Depends on: Required for payments with: Trustly (paymentProductId 806) Pix (paymentProductId 6105), but only for payments made in Brazil when the property order.customer.fiscalNumber is Personal (CPF) - 11 digits Mercado Pago (paymentProductId 6106), but only for payments made in Brazil when the property order.customer.fiscalNumber is Personal (CPF) - 11 digits PicPay (paymentProductId 6107), but only for payments made in Brazil when the property order.customer.fiscalNumber is Personal (CPF) - 11 digits AfterPay Installments (paymentProductId 9000) AfterPay Invoice (paymentProductId 9001) BC Card (paymentProductId 8590) Hana Card (paymentProductId 8591) Hyundai Card (paymentProductId 8592) KB Card (paymentProductId 8593) Lotte Card (paymentProductId 8594) NH Card (paymentProductId 8595) Samsung Card (paymentProductId 8596) Shinhan Card (paymentProductId 8597) Required for the creation of a Payout. Required for merchants that use Merchant Category Codes (MCC) V4829, V6012, M4829, V6051, M6540, 7995. Depends on: Required for the creation of a payment.
surnamePrefix	string (15)	no	read close
close Description Middle 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 Description Title of customer Depends on: Required for payments with product 9000 (AfterPay Installments) or 9001 (AfterPay Invoice) in Austria (AT), Belgium (BE), Germany (DE), the Netherlands (NL) and Switzerland (CH).
state	string (35)	no depends no no depends	read close
close Description Full name of the state or province Depends on: Required by the TechProcess platform for cross-border merchants. Depends on: Required for cross-border merchants.
stateCode	string	depends	read close
close Description ISO 3166-2 alpha-3 state code Notes: The maximum length for 3-D Secure version 2 is AN3 for payments that are processed by the GlobalCollect platform The maximum length for paymentProductId 1503 (Boleto) is AN2 for payments that are processed by the GlobalCollect platform The maximum length is 3 for payments that are processed by the WL Online Payment Acceptance platform Depends on: Required for payments with paymentProductId 1503 (Boleto)
street	string (50)	no depends no depends depends	read close
close Description Streetname Depends on: Required by the GlobalCollect platform for Invoice payments (201) Required by the GlobalCollect platform for Direct Debit UK (705), except when a token has been included in the request that includes this value. Required by the TechProcess platform for cross-border merchants. Depends on: Required for Invoice payments (201) Required for Direct Debit UK (705), except when a token has been included in the request that includes this value. Depends on: Required for cross-border merchants.
zip	string	no depends no depends depends	read close
close Description Zip code Depends on: Required by the GlobalCollect platform for Required for Direct Debit UK (705), except when a token has been included in the request that includes this value. Required by the TechProcess platform for cross-border merchants. Depends on: Required for Required for Direct Debit UK (705), except when a token has been included in the request that includes this value. Depends on: Required for cross-border merchants.
companyInformation	object	no	read close
close Description Object containing company information SDK Object type CompanyInformation
dateOfIncorporation	string (8)	no depends no no depends	read close
close Description The date of incorporation is the specific date when the company was registered with the relevant authority. Format: YYYYMMDD Depends on: Required by the TechProcess platform for cross-border payments when the property order.customer.isCompany is set to true. Depends on: Required for cross-border payments when the property order.customer.isCompany is set to true.
name	string (40)	depends depends no depends no	read close
close Description Name of company, as a customer Depends on: Required for payments when the property order.customer.fiscalNumber is set to: Argentina: Company (CUIT) - 11 digits. Brazil: Company (CNPJ) - 14 digits. Depends on: Required by the GlobalCollect platform for payments when the property order.customer.fiscalNumber is set to: Brazil: Company (CNPJ) - 14 digits. Required by the WOPA platform for payments when the property order.customer.fiscalNumber is set to: Argentina: Company (CUIT) - 11 digits. Brazil: Company (CNPJ) - 14 digits. Depends on: Required for payments when the property order.customer.fiscalNumber is set to: Brazil: Company (CNPJ) - 14 digits.
vatNumber	string (17)	depends	read close
close Description Local VAT number of the company Depends on: One of the following properties is required for merchants that use Merchant Category Codes (MCC) V4829, V6012, M4829, V6051, M6540, 7995: order.customer.personalInformation.dateOfBirth customer.contactDetails.emailAddress order.customer.contactDetails.mobilePhoneNumber order.customer.contactDetails.phoneNumber order.customer.companyInformation.vatNumber order.customer.personalInformation.identification
contactDetails	object	no	read close
close Description Object containing contact details like email address and phone number SDK Object type ContactDetailsBase
emailAddress	string (70)	no	read close
close Description Email address of the customer
emailMessageType	string	no	read close
close Description Preference for the type of email message markup plain-text html
fiscalNumber	string (14)	no	read close
close Description The 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: Argentina - Consumer (DNI) with a length of 7 or 8 digits Argentina - Company (CUIT) with a length of 11 digits Brazil - Consumer (CPF) with a length of 11 digits Brazil - Company (CNPJ) with a length of 14 digits Chile - Consumer (RUT) with a length of 9 digits Colombia - Consumer (NIT) with a length of 8, 9 or 10 digits Denmark - Consumer (CPR-nummer or personnummer) with a length of 10 digits Dominican Republic - Consumer (RNC) with a length of 11 digits Finland - Consumer (Finnish: henkilötunnus (abbreviated as HETU)) with a length of 11 characters India - Consumer (PAN) with a length of 10 characters Mexico - Consumer (RFC) with a length of 13 digits Mexico - Company (RFC) with a length of 12 digits Norway - Consumer (fødselsnummer) with a length of 11 digits Peru - Consumer (RUC) with a length of 11 digits Sweden - Consumer (personnummer) with a length of 10 or 12 digits Uruguay - Consumer (CI) with a length of 8 digits Uruguay - Consumer (NIE) with a length of 9 digits Uruguay - Company (RUT) with a length of 12 digits
refundDate	string (8)	no	read close
close Description Refund date Format: YYYYMMDD
refundReferences	object	no	read close
close Description Object that holds all reference properties that are linked to this refund SDK Object type RefundReferences
merchantReference	string (40)	no	read close
close Description Note 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

SDK: Java

This scenario you will probably use the most

AmountOfMoney amountOfMoney = new AmountOfMoney();
amountOfMoney.setAmount(1L);
amountOfMoney.setCurrencyCode("EUR");

BankAccountIban bankAccountIban = new BankAccountIban();
bankAccountIban.setIban("NL53INGB0000000036");

BankRefundMethodSpecificInput bankRefundMethodSpecificInput = new BankRefundMethodSpecificInput();
bankRefundMethodSpecificInput.setBankAccountIban(bankAccountIban);

PersonalName name = new PersonalName();
name.setSurname("Coyote");

AddressPersonal address = new AddressPersonal();
address.setCountryCode("US");
address.setName(name);

ContactDetailsBase contactDetails = new ContactDetailsBase();
contactDetails.setEmailAddress("wile.e.coyote@acmelabs.com");
contactDetails.setEmailMessageType("html");

RefundCustomer customer = new RefundCustomer();
customer.setAddress(address);
customer.setContactDetails(contactDetails);

RefundReferences refundReferences = new RefundReferences();
refundReferences.setMerchantReference("AcmeOrder0001");

RefundRequest body = new RefundRequest();
body.setAmountOfMoney(amountOfMoney);
body.setBankRefundMethodSpecificInput(bankRefundMethodSpecificInput);
body.setCustomer(customer);
body.setRefundDate("20140306");
body.setRefundReferences(refundReferences);

try {
    RefundResponse response = client.v1().merchant("merchantId").payments().refund("paymentId", body);
} catch (DeclinedRefundException e) {
    handleDeclinedRefund(e.getRefundResult());
} catch (ApiException e) {
    handleErrorResponse(e.getErrorId(), e.getErrors());
}

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.

Property	Type	Required	Details
Properties Expand all properties Hide deprecated properties
id	string	no	read close
close Description Our unique refund transaction identifier
refundOutput	object	no	read close
close Description Information of the refund resource such as amount, currency, nature of the refund. SDK Object type RefundOutput
amountOfMoney	object	no	read close
close Description Object containing amount and ISO currency code attributes SDK Object type AmountOfMoney
amount	integer (12)	yes	read close
close Description Amount in cents and always having 2 decimals
currencyCode	string (3)	yes	read close
close Description Three-letter ISO currency code representing the currency for the amount
amountPaid	integer	no	read close
close Description Amount paid
Group bankRefundMethodSpecificOutput	object	one of the group	read close
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.
refundProductId	integer	no	read close
close Description Refund product identifier Please see refund products for a full overview of possible values.
totalAmountPaid	integer	no	read close
close Description Total paid amount (in cents and always with 2 decimals)
totalAmountRefunded	integer	no	read close
close Description Total refunded amount (in cents and always with 2 decimals)
Group cardRefundMethodSpecificOutput	object	one of the group	read close
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.
authorisationCode	string	no	read close
close Description Card Authorization code as returned by the acquirer
card	object	no	read close
close Description Object containing card details SDK Object type CardEssentials
cardNumber	string (19)	no	read close
close Description The complete credit/debit card number
cardholderName	string (51)	no	read close
close Description The card holder's name on the card. Minimum length of 2, maximum length of 51 characters.
expiryDate	string (4)	no	read close
close Description Expiry date of the card Format: MMYY
refundProductId	integer	no	read close
close Description Refund product identifier Please see refund products for a full overview of possible values.
totalAmountPaid	integer	no	read close
close Description Total paid amount (in cents and always with 2 decimals)
totalAmountRefunded	integer	no	read close
close Description Total refunded amount (in cents and always with 2 decimals)
Group cashRefundMethodSpecificOutput	object	one of the group	read close
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.
refundProductId	integer	no	read close
close Description Refund product identifier Please see refund products for a full overview of possible values.
totalAmountPaid	integer	no	read close
close Description Total paid amount (in cents and always with 2 decimals)
totalAmountRefunded	integer	no	read close
close Description Total refunded amount (in cents and always with 2 decimals)
Group eInvoiceRefundMethodSpecificOutput	object	one of the group	read close
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.
refundProductId	integer	no	read close
close Description Refund product identifier Please see refund products for a full overview of possible values.
totalAmountPaid	integer	no	read close
close Description Total paid amount (in cents and always with 2 decimals)
totalAmountRefunded	integer	no	read close
close Description Total refunded amount (in cents and always with 2 decimals)
Group eWalletRefundMethodSpecificOutput	object	one of the group	read close
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.
paymentProduct840SpecificOutput	object	yes	read close
close Description PayPal (payment product 840) specific details SDK Object type RefundPaymentProduct840SpecificOutput
customerAccount	object	no	read close
close Description Object containing the PayPal account details SDK Object type RefundPaymentProduct840CustomerAccount
customerAccountStatus	string	no	read close
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
customerAddressStatus	string	no	read close
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
payerId	string	no	read close
close Description The unique identifier of a PayPal account and will never change in the life cycle of a PayPal account
refundProductId	integer	no	read close
close Description Refund product identifier Please see refund products for a full overview of possible values.
totalAmountPaid	integer	no	read close
close Description Total paid amount (in cents and always with 2 decimals)
totalAmountRefunded	integer	no	read close
close Description Total refunded amount (in cents and always with 2 decimals)
Group mobileRefundMethodSpecificOutput	object	one of the group	read close
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.
network	string	no	read close
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.
refundProductId	integer	no	read close
close Description Refund product identifier Please see refund products for a full overview of possible values.
totalAmountPaid	integer	no	read close
close Description Total paid amount (in cents and always with 2 decimals)
totalAmountRefunded	integer	no	read close
close Description Total refunded amount (in cents and always with 2 decimals)
paymentMethod	string	no	read close
close Description Payment method identifier used by the our payment engine with the following possible values: bankRefund bankTransfer card cash directDebit eInvoice invoice redirect
references	object	no	read close
close Description Object that holds all reference properties that are linked to this refund SDK Object type PaymentReferences
merchantCaptureReference	string	no	read close
close Description Your unique reference of the capture that is also returned in our report files. This is almost always used for your reconciliation of our report files.
merchantOrderId	integer	no	read close
close Description Your order ID for this transaction that is also returned in our report files
merchantReference	string	no	read close
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.
paymentReference	string	no	read close
close Description Payment Reference generated by WebCollect
providerId	string	no	read close
close Description Provides an additional means of reconciliation for Gateway merchants
providerMerchantId	string	no	read close
close Description Provides an additional means of reconciliation, this is the MerchantId used at the provider
providerReference	string	no	read close
close Description Provides an additional means of reconciliation for Gateway merchants
referenceOrigPayment	string	no	read close
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
status	enum	no	read close
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.
statusOutput	object	no	read close
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
errors	array of object	no	read close
close Description Custom object contains the set of errors
items	object	no	read close
close Description Contains detailed information on one single error. SDK Object type APIError
category	string	no	read close
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.
code	string	yes	read close
close Description Error code
httpStatusCode	integer	no	read close
close Description HTTP status code for this error that can be used to determine the type of error
id	string	no	read close
close Description ID of the error. This is a short human-readable message that briefly describes the error.
message	string	no	read close
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
propertyName	string	no	read close
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'.
requestId	string	no	read close
close Description ID of the request that can be used for debugging purposes
isCancellable	boolean	no	read close
close Description Flag indicating if the payment can be cancelled true false
isRetriable	boolean	no	read close
close Description Flag indicating whether a rejected payment may be retried by the merchant without incurring a fee true false
providerRawOutput	array of object	no	read close
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.
items	object	no	read close
close SDK Object type KeyValuePair
key	string	no	read close
close Description Name of the key or property
value	string	no	read close
close Description Value of the key or property
statusCategory	enum	no	read close
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.
statusCode	integer	no	read close
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.
statusCodeChangeDateTime	string	no	read close
close Description Date and time of payment Format: YYYYMMDDHH24MISS

Response example

SDK: Java

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

Property	Type	Required	Details
Properties Expand all properties Hide deprecated properties
errorId	string	yes	read close
close Description Unique reference, for debugging purposes, of this error response
errors	array of object	yes	read close
close Description List of one or more errors
items	object	no	read close
close Description Contains detailed information on one single error. SDK Object type APIError
category	string	no	read close
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.
code	string	yes	read close
close Description Error code
httpStatusCode	integer	no	read close
close Description HTTP status code for this error that can be used to determine the type of error
id	string	no	read close
close Description ID of the error. This is a short human-readable message that briefly describes the error.
message	string	no	read close
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
propertyName	string	no	read close
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'.
requestId	string	no	read close
close Description ID of the request that can be used for debugging purposes
refundResult	object	no	read close
close Description Object that contains details on the created refund in case one has been created SDK Object type RefundResult
id	string	no	read close
close Description Our unique refund transaction identifier
refundOutput	object	no	read close
close Description Object containing refund details SDK Object type RefundOutput
amountOfMoney	object	no	read close
close Description Object containing amount and ISO currency code attributes SDK Object type AmountOfMoney
amount	integer (12)	yes	read close
close Description Amount in cents and always having 2 decimals
currencyCode	string (3)	yes	read close
close Description Three-letter ISO currency code representing the currency for the amount
amountPaid	integer	no	read close
close Description Amount paid
Group bankRefundMethodSpecificOutput	object	one of the group	read close
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.
refundProductId	integer	no	read close
close Description Refund product identifier Please see refund products for a full overview of possible values.
totalAmountPaid	integer	no	read close
close Description Total paid amount (in cents and always with 2 decimals)
totalAmountRefunded	integer	no	read close
close Description Total refunded amount (in cents and always with 2 decimals)
Group cardRefundMethodSpecificOutput	object	one of the group	read close
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.
authorisationCode	string	no	read close
close Description Card Authorization code as returned by the acquirer
card	object	no	read close
close Description Object containing card details SDK Object type CardEssentials
cardNumber	string (19)	no	read close
close Description The complete credit/debit card number
cardholderName	string (51)	no	read close
close Description The card holder's name on the card. Minimum length of 2, maximum length of 51 characters.
expiryDate	string (4)	no	read close
close Description Expiry date of the card Format: MMYY
refundProductId	integer	no	read close
close Description Refund product identifier Please see refund products for a full overview of possible values.
totalAmountPaid	integer	no	read close
close Description Total paid amount (in cents and always with 2 decimals)
totalAmountRefunded	integer	no	read close
close Description Total refunded amount (in cents and always with 2 decimals)
Group cashRefundMethodSpecificOutput	object	one of the group	read close
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.
refundProductId	integer	no	read close
close Description Refund product identifier Please see refund products for a full overview of possible values.
totalAmountPaid	integer	no	read close
close Description Total paid amount (in cents and always with 2 decimals)
totalAmountRefunded	integer	no	read close
close Description Total refunded amount (in cents and always with 2 decimals)
Group eInvoiceRefundMethodSpecificOutput	object	one of the group	read close
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.
refundProductId	integer	no	read close
close Description Refund product identifier Please see refund products for a full overview of possible values.
totalAmountPaid	integer	no	read close
close Description Total paid amount (in cents and always with 2 decimals)
totalAmountRefunded	integer	no	read close
close Description Total refunded amount (in cents and always with 2 decimals)
Group eWalletRefundMethodSpecificOutput	object	one of the group	read close
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.
paymentProduct840SpecificOutput	object	yes	read close
close Description PayPal (payment product 840) specific details SDK Object type RefundPaymentProduct840SpecificOutput
customerAccount	object	no	read close
close Description Object containing the PayPal account details SDK Object type RefundPaymentProduct840CustomerAccount
customerAccountStatus	string	no	read close
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
customerAddressStatus	string	no	read close
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
payerId	string	no	read close
close Description The unique identifier of a PayPal account and will never change in the life cycle of a PayPal account
refundProductId	integer	no	read close
close Description Refund product identifier Please see refund products for a full overview of possible values.
totalAmountPaid	integer	no	read close
close Description Total paid amount (in cents and always with 2 decimals)
totalAmountRefunded	integer	no	read close
close Description Total refunded amount (in cents and always with 2 decimals)
Group mobileRefundMethodSpecificOutput	object	one of the group	read close
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.
network	string	no	read close
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.
refundProductId	integer	no	read close
close Description Refund product identifier Please see refund products for a full overview of possible values.
totalAmountPaid	integer	no	read close
close Description Total paid amount (in cents and always with 2 decimals)
totalAmountRefunded	integer	no	read close
close Description Total refunded amount (in cents and always with 2 decimals)
paymentMethod	string	no	read close
close Description Payment method identifier used by the our payment engine with the following possible values: bankRefund bankTransfer card cash directDebit eInvoice invoice redirect
references	object	no	read close
close Description Object that holds all reference properties that are linked to this refund SDK Object type PaymentReferences
merchantCaptureReference	string	no	read close
close Description Your unique reference of the capture that is also returned in our report files. This is almost always used for your reconciliation of our report files.
merchantOrderId	integer	no	read close
close Description Your order ID for this transaction that is also returned in our report files
merchantReference	string	no	read close
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.
paymentReference	string	no	read close
close Description Payment Reference generated by WebCollect
providerId	string	no	read close
close Description Provides an additional means of reconciliation for Gateway merchants
providerMerchantId	string	no	read close
close Description Provides an additional means of reconciliation, this is the MerchantId used at the provider
providerReference	string	no	read close
close Description Provides an additional means of reconciliation for Gateway merchants
referenceOrigPayment	string	no	read close
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
status	enum	no	read close
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 REFUNDED - We have successfully refunded the customer REJECTED_CAPTURE - The refund was rejected by the bank or us during processing CANCELLED - You have cancelled the transaction Please see Statuses for a full overview of possible values.
statusOutput	object	no	read close
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
errors	array of object	no	read close
close Description Custom object contains the set of errors
items	object	no	read close
close Description Contains detailed information on one single error. SDK Object type APIError
category	string	no	read close
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.
code	string	yes	read close
close Description Error code
httpStatusCode	integer	no	read close
close Description HTTP status code for this error that can be used to determine the type of error
id	string	no	read close
close Description ID of the error. This is a short human-readable message that briefly describes the error.
message	string	no	read close
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
propertyName	string	no	read close
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'.
requestId	string	no	read close
close Description ID of the request that can be used for debugging purposes
isCancellable	boolean	no	read close
close Description Flag indicating if the payment can be cancelled true false
isRetriable	boolean	no	read close
close Description Flag indicating whether a rejected payment may be retried by the merchant without incurring a fee true false
providerRawOutput	array of object	no	read close
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.
items	object	no	read close
close SDK Object type KeyValuePair
key	string	no	read close
close Description Name of the key or property
value	string	no	read close
close Description Value of the key or property
statusCategory	enum	no	read close
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.
statusCode	integer	no	read close
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.
statusCodeChangeDateTime	string	no	read close
close Description Date and time of payment Format: YYYYMMDDHH24MISS

Response example

SDK: Java

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.

Property	Type	Required	Details
Properties Expand all properties Hide deprecated properties
errorId	string	yes	read close
close Description Unique reference, for debugging purposes, of this error response
errors	array of object	yes	read close
close Description List of one or more errors
items	object	no	read close
close Description Contains detailed information on one single error. SDK Object type APIError
category	string	no	read close
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.
code	string	yes	read close
close Description Error code
httpStatusCode	integer	no	read close
close Description HTTP status code for this error that can be used to determine the type of error
id	string	no	read close
close Description ID of the error. This is a short human-readable message that briefly describes the error.
message	string	no	read close
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
propertyName	string	no	read close
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'.
requestId	string	no	read close
close Description ID of the request that can be used for debugging purposes
refundResult	object	no	read close
close Description Object that contains details on the created refund in case one has been created SDK Object type RefundResult
id	string	no	read close
close Description Our unique refund transaction identifier
refundOutput	object	no	read close
close Description Object containing refund details SDK Object type RefundOutput
amountOfMoney	object	no	read close
close Description Object containing amount and ISO currency code attributes SDK Object type AmountOfMoney
amount	integer (12)	yes	read close
close Description Amount in cents and always having 2 decimals
currencyCode	string (3)	yes	read close
close Description Three-letter ISO currency code representing the currency for the amount
amountPaid	integer	no	read close
close Description Amount paid
Group bankRefundMethodSpecificOutput	object	one of the group	read close
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.
refundProductId	integer	no	read close
close Description Refund product identifier Please see refund products for a full overview of possible values.
totalAmountPaid	integer	no	read close
close Description Total paid amount (in cents and always with 2 decimals)
totalAmountRefunded	integer	no	read close
close Description Total refunded amount (in cents and always with 2 decimals)
Group cardRefundMethodSpecificOutput	object	one of the group	read close
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.
authorisationCode	string	no	read close
close Description Card Authorization code as returned by the acquirer
card	object	no	read close
close Description Object containing card details SDK Object type CardEssentials
cardNumber	string (19)	no	read close
close Description The complete credit/debit card number
cardholderName	string (51)	no	read close
close Description The card holder's name on the card. Minimum length of 2, maximum length of 51 characters.
expiryDate	string (4)	no	read close
close Description Expiry date of the card Format: MMYY
refundProductId	integer	no	read close
close Description Refund product identifier Please see refund products for a full overview of possible values.
totalAmountPaid	integer	no	read close
close Description Total paid amount (in cents and always with 2 decimals)
totalAmountRefunded	integer	no	read close
close Description Total refunded amount (in cents and always with 2 decimals)
Group cashRefundMethodSpecificOutput	object	one of the group	read close
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.
refundProductId	integer	no	read close
close Description Refund product identifier Please see refund products for a full overview of possible values.
totalAmountPaid	integer	no	read close
close Description Total paid amount (in cents and always with 2 decimals)
totalAmountRefunded	integer	no	read close
close Description Total refunded amount (in cents and always with 2 decimals)
Group eInvoiceRefundMethodSpecificOutput	object	one of the group	read close
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.
refundProductId	integer	no	read close
close Description Refund product identifier Please see refund products for a full overview of possible values.
totalAmountPaid	integer	no	read close
close Description Total paid amount (in cents and always with 2 decimals)
totalAmountRefunded	integer	no	read close
close Description Total refunded amount (in cents and always with 2 decimals)
Group eWalletRefundMethodSpecificOutput	object	one of the group	read close
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.
paymentProduct840SpecificOutput	object	yes	read close
close Description PayPal (payment product 840) specific details SDK Object type RefundPaymentProduct840SpecificOutput
customerAccount	object	no	read close
close Description Object containing the PayPal account details SDK Object type RefundPaymentProduct840CustomerAccount
customerAccountStatus	string	no	read close
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
customerAddressStatus	string	no	read close
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
payerId	string	no	read close
close Description The unique identifier of a PayPal account and will never change in the life cycle of a PayPal account
refundProductId	integer	no	read close
close Description Refund product identifier Please see refund products for a full overview of possible values.
totalAmountPaid	integer	no	read close
close Description Total paid amount (in cents and always with 2 decimals)
totalAmountRefunded	integer	no	read close
close Description Total refunded amount (in cents and always with 2 decimals)
Group mobileRefundMethodSpecificOutput	object	one of the group	read close
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.
network	string	no	read close
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.
refundProductId	integer	no	read close
close Description Refund product identifier Please see refund products for a full overview of possible values.
totalAmountPaid	integer	no	read close
close Description Total paid amount (in cents and always with 2 decimals)
totalAmountRefunded	integer	no	read close
close Description Total refunded amount (in cents and always with 2 decimals)
paymentMethod	string	no	read close
close Description Payment method identifier used by the our payment engine with the following possible values: bankRefund bankTransfer card cash directDebit eInvoice invoice redirect
references	object	no	read close
close Description Object that holds all reference properties that are linked to this refund SDK Object type PaymentReferences
merchantCaptureReference	string	no	read close
close Description Your unique reference of the capture that is also returned in our report files. This is almost always used for your reconciliation of our report files.
merchantOrderId	integer	no	read close
close Description Your order ID for this transaction that is also returned in our report files
merchantReference	string	no	read close
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.
paymentReference	string	no	read close
close Description Payment Reference generated by WebCollect
providerId	string	no	read close
close Description Provides an additional means of reconciliation for Gateway merchants
providerMerchantId	string	no	read close
close Description Provides an additional means of reconciliation, this is the MerchantId used at the provider
providerReference	string	no	read close
close Description Provides an additional means of reconciliation for Gateway merchants
referenceOrigPayment	string	no	read close
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
status	enum	no	read close
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 REFUNDED - We have successfully refunded the customer REJECTED_CAPTURE - The refund was rejected by the bank or us during processing CANCELLED - You have cancelled the transaction Please see Statuses for a full overview of possible values.
statusOutput	object	no	read close
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
errors	array of object	no	read close
close Description Custom object contains the set of errors
items	object	no	read close
close Description Contains detailed information on one single error. SDK Object type APIError
category	string	no	read close
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.
code	string	yes	read close
close Description Error code
httpStatusCode	integer	no	read close
close Description HTTP status code for this error that can be used to determine the type of error
id	string	no	read close
close Description ID of the error. This is a short human-readable message that briefly describes the error.
message	string	no	read close
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
propertyName	string	no	read close
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'.
requestId	string	no	read close
close Description ID of the request that can be used for debugging purposes
isCancellable	boolean	no	read close
close Description Flag indicating if the payment can be cancelled true false
isRetriable	boolean	no	read close
close Description Flag indicating whether a rejected payment may be retried by the merchant without incurring a fee true false
providerRawOutput	array of object	no	read close
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.
items	object	no	read close
close SDK Object type KeyValuePair
key	string	no	read close
close Description Name of the key or property
value	string	no	read close
close Description Value of the key or property
statusCategory	enum	no	read close
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.
statusCode	integer	no	read close
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.
statusCodeChangeDateTime	string	no	read close
close Description Date and time of payment Format: YYYYMMDDHH24MISS

Response example

SDK: Java

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"
        }
    ]
}

Create refund

Payments

Request

PayloadRefundRequest

Description

Description

Description

Description

Description

Description

Description

Description

Description

Description

Description

Description

Description

Description

Description

Description

Description

Depends on:

Description

Depends on:

Description

Description

Description

Description

Description

Depends on:

Depends on:

Description

Depends on:

Depends on:

Description

Description

Depends on:

Depends on:

Description

Depends on:

Depends on:

Depends on:

Depends on:

Description

Depends on:

Depends on:

Depends on:

Depends on:

Depends on:

Description

Description

Depends on:

Description

Depends on:

Depends on:

Description

Depends on:

Description

Depends on:

Depends on:

Depends on:

Description

Depends on:

Depends on:

Depends on:

Description

Description

Depends on:

Depends on:

Description

Depends on:

Depends on:

Depends on:

Description

Depends on:

Description

Description

Description

Description

Description