Create payout

POST https://{domainname}/v1/{merchantId}/payouts

Payouts

Our payout service allows you to easily transfer money directly, either to a card or into a bank account of your choice.

Before we can process your payout request you will need to pre-fund the total amount of money you want to payout.

For more information about card payouts please click here or for more information about bank payouts please click here.

Request

This REST service creates a new payout. A payoutID is returned in the response along with payout details.

Create payout supports idempotent requests

PayloadCreatePayoutRequest

Property	Type	Required	Details
Properties Expand all properties Hide deprecated properties
amount	integer (12)	yes	read close
close Deprecated Description Amount in cents and always having 2 decimals
currencyCode	string (3)	yes	read close
close Deprecated Description Three-letter ISO currency code representing the currency for the amount
Group 1 bankAccountBban	object	no	read close
close Deprecated: Use bankTransferPayoutMethodSpecificInput.bankAccountBban instead Description Object containing account holder name and bank account information. This property can only be used for payouts in the UK. SDK Object type BankAccountBban 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 Deprecated Description Name of the account holder Depends on: Required for Create and Update token calls for ACH (730).
accountNumber	string	depends	read close
close Deprecated Description Bank account number Depends on: Required for Direct Debit UK (705) and ACH (730) payments, except when a token has been included in the request that includes this value. Required for Create and Update token calls.
bankCode	string	depends	read close
close Deprecated Description Bank code Depends on: Required for Direct Debit UK (705) and ACH (730) payments, except when a token has been included in the request that includes this value. Required for Create and Update token calls for ACH (730).
bankName	string (40)	no	read close
close Deprecated Description Name of the bank
branchCode	string	no	read close
close Deprecated Description Branch code
checkDigit	string	no	read close
close Deprecated Description Bank check digit
countryCode	string (2)	no	read close
close Deprecated Description ISO 3166-1 alpha-2 country code of the country where the bank account is held For UK payouts this value is automatically set to GB as only payouts to UK accounts are supported.
Group 1 bankAccountIban	object	no	read close
close Deprecated: Use bankTransferPayoutMethodSpecificInput.bankAccountIban instead Description Object containing account holder and IBAN information. 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 Deprecated 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 Deprecated 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
Group 2 bankTransferPayoutMethodSpecificInput	object	no depends no yes no	read close
close Description Object containing the specific input details for bank transfer payouts. If option chosen, depends on: Required by the GlobalCollect platform. SDK Object type BankTransferPayoutMethodSpecificInput 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.
Group bankAccountBban	object	one of the group	read close
close Description Object containing account holder name and bank account information. This property can only be used for payouts in the UK. SDK Object type BankAccountBban 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 of the account holder Depends on: Required for Create and Update token calls for ACH (730).
accountNumber	string	depends	read close
close Description Bank account number Depends on: Required for Direct Debit UK (705) and ACH (730) payments, except when a token has been included in the request that includes this value. Required for Create and Update token calls.
bankCode	string	depends	read close
close Description Bank code Depends on: Required for Direct Debit UK (705) and ACH (730) payments, except when a token has been included in the request that includes this value. Required for Create and Update token calls for ACH (730).
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 For UK payouts this value is automatically set to GB as only payouts to UK accounts are supported.
Group bankAccountIban	object	one of the group	read close
close Description Object containing account holder and IBAN information. 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
customer	object	no	read close
close Deprecated: Use payoutDetails.customer instead Description Object containing the details of the customer. SDK Object type PayoutCustomer
address	object	yes	read close
close Deprecated Description Object containing address details SDK Object type Address
additionalInfo	string (50)	no	read close
close Deprecated Description Additional address information. The additionalInfo is truncated after 10 characters for payments, refunds or payouts that are processed by the WL Online Payment Acceptance platform
city	string	depends depends no depends depends	read close
close Deprecated Description City Note: For payments with product 1503 the maximum length is not 40 but 20. Depends on: Required for payments with product 6101 (Banco do Brasil), 6102 (Itaú), 6103 (Banrisul), 6104 (Bradesco), 6105 (Pix) or 6107 (PicPay). 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 GlobalCollect platform for payments with product 9000 (AfterPay Installments) or 9001 (AfterPay Invoice). Required by the WOPA platform for payments with product 6101 (Banco do Brasil), 6102 (Itaú), 6103 (Banrisul), 6104 (Bradesco), 6105 (Pix) or 6107 (PicPay). Required by the TechProcess platform for cross-border merchants. Required by the GlobalCollect platform when address is included in Seller. Required by the GlobalCollect platform for the creation of a Payout. 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 Required for payments with product 9000 (AfterPay Installments) or 9001 (AfterPay Invoice). Required when address is included in Seller. Required for the creation of a Payout. Depends on: Required for cross-border merchants.
countryCode	string (2)	no depends no yes yes	read close
close Deprecated Description ISO 3166-1 alpha-2 country code Depends on: Required by the GlobalCollect platform. Required by the TechProcess platform.
houseNumber	string (15)	depends	read close
close Deprecated Description House number. The houseNumber is truncated after 10 characters for payments, refunds or payouts that are processed by the WL Online Payment Acceptance platform Depends on: Required when address is included in Seller. Required for 6101 (Banco do Brasil), 6102 (Itaú), 6103 (Banrisul), 6104 (Bradesco), 6105 (Pix) and 6107 (PicPay).
state	string (35)	no depends no no depends	read close
close Deprecated 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 Deprecated 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), 6101 (Banco do Brasil), 6102 (Itaú), 6103 (Banrisul), 6104 (Bradesco), 6105 (Pix) or 6107 (PicPay).
street	string (50)	depends depends no depends depends	read close
close Deprecated Description Streetname Depends on: Required for payments with product 6101 (Banco do Brasil), 6102 (Itaú), 6103 (Banrisul), 6104 (Bradesco), 6105 (Pix) or 6107 (PicPay). 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 GlobalCollect platform for payments with product 9000 (AfterPay Installments) or 9001 (AfterPay Invoice). Required by the WOPA platform for payments with product 6101 (Banco do Brasil), 6102 (Itaú), 6103 (Banrisul), 6104 (Bradesco), 6105 (Pix) or 6107 (PicPay). Required by the TechProcess platform for cross-border merchants. Required by the GlobalCollect platform when address is included in Seller. Required by the GlobalCollect platform for the creation of a Payout. 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. Required for payments with product 9000 (AfterPay Installments) or 9001 (AfterPay Invoice). Required when address is included in Seller. Required for the creation of a Payout. Depends on: Required for cross-border merchants.
zip	string	depends depends no depends depends	read close
close Deprecated Description Zip code Note: For payments with product 1503 the maximum length is not 10 but 8. Depends on: Required for payments with product 6101 (Banco do Brazil), 6102 (Itaú), 6103 (Banrisul), 6104 (Bradesco), 6105 (Pix) or 6107 (PicPay). Depends on: 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 GlobalCollect platform for payments with product 9000 (AfterPay Installments) or 9001 (AfterPay Invoice). Required by the WOPA platform for payments with product 6101 (Banco do Brazil), 6102 (Itaú), 6103 (Banrisul), 6104 (Bradesco), 6105 (Pix) or 6107 (PicPay). Required by the TechProcess platform for cross-border merchants. Depends on: Required for Direct Debit UK (705) except when a token has been included in the request that includes this value. Required for payments with product 9000 (AfterPay Installments) or 9001 (AfterPay Invoice). Depends on: Required for cross-border merchants.
companyInformation	object	no	read close
close Deprecated Description Object containing company information SDK Object type CompanyInformation
dateOfIncorporation	string (8)	no depends no no depends	read close
close Deprecated 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 Deprecated 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 Deprecated 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 Deprecated Description Object containing contact details like email address and phone number SDK Object type ContactDetailsBase
emailAddress	string (70)	no	read close
close Deprecated Description Email address of the customer
emailMessageType	string	no	read close
close Deprecated Description Preference for the type of email message markup plain-text html
merchantCustomerId	string (15)	no	read close
close Deprecated Description Your identifier for the customer. It can be used as a search criteria in the GlobalCollect Payment Console and is also included in the GlobalCollect report files. It is used in the fraud-screening process for payments on the Ogone Payment Platform.
name	object	yes	read close
close Deprecated Description Object containing PersonalName object SDK Object type PersonalName
firstName	string (15)	depends depends no depends depends	read close
close Deprecated 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 Deprecated 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 Deprecated 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 Deprecated 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).
payoutDate	string (8)	no	read close
close Description Date of the payout sent to the bank by us. Format: YYYYMMDD
payoutText	string (50)	yes	read close
close Description Text to be printed on the bank account statement of the beneficiary. The maximum allowed length might differ per country. The data will be automatically truncated to the maximum allowed length.
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 2 cardPayoutMethodSpecificInput	object	yes depends no yes no	read close
close Description Object containing the specific input details for card payouts. If option chosen, depends on: Required by the GlobalCollect platform. Required by the WOPA platform. SDK Object type CardPayoutMethodSpecificInput 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.
Group card	object	one of the group	read close
close Description Object containing the card details. SDK Object type Card 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.
cardNumber	string (19)	depends	read close
close Description The complete credit/debit card number (also know as the PAN). The minimum input length is 12 digits. The card number is always obfuscated in any of our responses Depends on: Required, except when a token or encryptedCustomerInput that includes this data is provided.
cardholderName	string (51)	no depends depends no yes	read close
close Description The card holder's name on the card. Minimum length of 2, maximum length of 51 characters. The '+' character is not allowed in this property for transactions that are processed by TechProcess Payment Platform. Depends on: Required by the Ogone platform, except when a token or encryptedCustomerInput that includes this data is provided Required by the TechProcess platform. Depends on: Required, except when a token or encryptedCustomerInput that includes this data is provided
cvv	string (4)	depends	read close
close Description Card Verification Value, a 3 or 4 digit code used as an additional security feature for card not present transactions. Depends on: Required for one-off payments. For recurring payments: CVV is required for the first recurring transaction (customer-initiated transactions), CVV is not required for subsequent transactions (merchant-initiated transactions).
expiryDate	string (4)	depends	read close
close Description Expiry date of the card Format: MMYY Depends on: Required, except when a token or encryptedCustomerInput that includes this data is provided.
issueNumber	string (2)	no	read close
close Description Issue number on the card (if applicable)
partialPin	string (2)	no	read close
close Description The first 2 digits of the card's PIN code. May be optionally submitted for the following payment products: BC Card (paymentProductId 180) Hana Card (paymentProductId 181) Hyundai Card (paymentProductId 182) KB Card (paymentProductId 183) Lotte Card (paymentProductId 184) NH Card (paymentProductId 185) Samsung Card (paymentProductId 186) Shinhan Card (paymentProductId 187) Submitting this property may improve your authorization rate.
Group token	string	one of the group	read close
close Description ID of the token that holds previously stored card data. If both the token and card are provided, then the card takes precedence over the token. 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.
paymentProductId	integer (5)	yes	read close
close Description Payment product identifier Please see payment products for a full overview of possible values.
recipient	object	no depends no yes no	read close
close Description Object containing the details of the recipient of the payout Depends on: Required by the GlobalCollect platform. SDK Object type PayoutRecipient
firstName	string (15)	yes	read close
close Description Given name(s) or first name(s) of the customer
surname	string (70)	yes	read close
close Description Surname(s) or last name(s) of the customer
surnamePrefix	string (15)	no	read close
close Description Middle name - In between first name and surname - of the customer
customer	object	no	read close
close Deprecated: Use payoutDetails.customer instead Description Object containing the details of the customer. SDK Object type PayoutCustomer
address	object	yes	read close
close Deprecated Description Object containing address details SDK Object type Address
additionalInfo	string (50)	no	read close
close Deprecated Description Additional address information. The additionalInfo is truncated after 10 characters for payments, refunds or payouts that are processed by the WL Online Payment Acceptance platform
city	string	depends depends no depends depends	read close
close Deprecated Description City Note: For payments with product 1503 the maximum length is not 40 but 20. Depends on: Required for payments with product 6101 (Banco do Brasil), 6102 (Itaú), 6103 (Banrisul), 6104 (Bradesco), 6105 (Pix) or 6107 (PicPay). 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 GlobalCollect platform for payments with product 9000 (AfterPay Installments) or 9001 (AfterPay Invoice). Required by the WOPA platform for payments with product 6101 (Banco do Brasil), 6102 (Itaú), 6103 (Banrisul), 6104 (Bradesco), 6105 (Pix) or 6107 (PicPay). Required by the TechProcess platform for cross-border merchants. Required by the GlobalCollect platform when address is included in Seller. Required by the GlobalCollect platform for the creation of a Payout. 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 Required for payments with product 9000 (AfterPay Installments) or 9001 (AfterPay Invoice). Required when address is included in Seller. Required for the creation of a Payout. Depends on: Required for cross-border merchants.
countryCode	string (2)	no depends no yes yes	read close
close Deprecated Description ISO 3166-1 alpha-2 country code Depends on: Required by the GlobalCollect platform. Required by the TechProcess platform.
houseNumber	string (15)	depends	read close
close Deprecated Description House number. The houseNumber is truncated after 10 characters for payments, refunds or payouts that are processed by the WL Online Payment Acceptance platform Depends on: Required when address is included in Seller. Required for 6101 (Banco do Brasil), 6102 (Itaú), 6103 (Banrisul), 6104 (Bradesco), 6105 (Pix) and 6107 (PicPay).
state	string (35)	no depends no no depends	read close
close Deprecated 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 Deprecated 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), 6101 (Banco do Brasil), 6102 (Itaú), 6103 (Banrisul), 6104 (Bradesco), 6105 (Pix) or 6107 (PicPay).
street	string (50)	depends depends no depends depends	read close
close Deprecated Description Streetname Depends on: Required for payments with product 6101 (Banco do Brasil), 6102 (Itaú), 6103 (Banrisul), 6104 (Bradesco), 6105 (Pix) or 6107 (PicPay). 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 GlobalCollect platform for payments with product 9000 (AfterPay Installments) or 9001 (AfterPay Invoice). Required by the WOPA platform for payments with product 6101 (Banco do Brasil), 6102 (Itaú), 6103 (Banrisul), 6104 (Bradesco), 6105 (Pix) or 6107 (PicPay). Required by the TechProcess platform for cross-border merchants. Required by the GlobalCollect platform when address is included in Seller. Required by the GlobalCollect platform for the creation of a Payout. 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. Required for payments with product 9000 (AfterPay Installments) or 9001 (AfterPay Invoice). Required when address is included in Seller. Required for the creation of a Payout. Depends on: Required for cross-border merchants.
zip	string	depends depends no depends depends	read close
close Deprecated Description Zip code Note: For payments with product 1503 the maximum length is not 10 but 8. Depends on: Required for payments with product 6101 (Banco do Brazil), 6102 (Itaú), 6103 (Banrisul), 6104 (Bradesco), 6105 (Pix) or 6107 (PicPay). Depends on: 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 GlobalCollect platform for payments with product 9000 (AfterPay Installments) or 9001 (AfterPay Invoice). Required by the WOPA platform for payments with product 6101 (Banco do Brazil), 6102 (Itaú), 6103 (Banrisul), 6104 (Bradesco), 6105 (Pix) or 6107 (PicPay). Required by the TechProcess platform for cross-border merchants. Depends on: Required for Direct Debit UK (705) except when a token has been included in the request that includes this value. Required for payments with product 9000 (AfterPay Installments) or 9001 (AfterPay Invoice). Depends on: Required for cross-border merchants.
companyInformation	object	no	read close
close Deprecated Description Object containing company information SDK Object type CompanyInformation
dateOfIncorporation	string (8)	no depends no no depends	read close
close Deprecated 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 Deprecated 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 Deprecated 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 Deprecated Description Object containing contact details like email address and phone number SDK Object type ContactDetailsBase
emailAddress	string (70)	no	read close
close Deprecated Description Email address of the customer
emailMessageType	string	no	read close
close Deprecated Description Preference for the type of email message markup plain-text html
merchantCustomerId	string (15)	no	read close
close Deprecated Description Your identifier for the customer. It can be used as a search criteria in the GlobalCollect Payment Console and is also included in the GlobalCollect report files. It is used in the fraud-screening process for payments on the Ogone Payment Platform.
name	object	yes	read close
close Deprecated Description Object containing PersonalName object SDK Object type PersonalName
firstName	string (15)	depends depends no depends depends	read close
close Deprecated 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 Deprecated 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 Deprecated 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 Deprecated 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).
merchant	object	no	read close
close Description Object containing information on you, the merchant SDK Object type PayoutMerchant
configurationId	string	no	read close
close Description In case your account has been setup with multiple configurations you can use this property to identify the one you would like to use for the transaction. Note that you can only submit preconfigured values in combination with the Worldline Online Payments Acceptance platform. In case no value is supplied a default value of 0 will be submitted to the Worldline Online Payments Acceptance platform. The Worldline Online Payments Acceptance platform internally refers to this as a PosId.
payoutDate	string (8)	no	read close
close Deprecated: Use bankTransferPayoutMethodSpecificInput.payoutDate instead Description Date of the payout sent to the bank by us Format: YYYYMMDD
payoutDetails	object	yes	read close
close Description Object containing the details for Create Payout Request SDK Object type PayoutDetails
amountOfMoney	object	yes	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
customer	object	no depends no yes no	read close
close Description Object containing the details of the customer. Depends on: Required by the GlobalCollect platform. SDK Object type PayoutCustomer
address	object	yes	read close
close Description Object containing address details SDK Object type Address
additionalInfo	string (50)	no	read close
close Description Additional address information. The additionalInfo is truncated after 10 characters for payments, refunds or payouts that are processed by the WL Online Payment Acceptance platform
city	string	depends depends no depends depends	read close
close Description City Note: For payments with product 1503 the maximum length is not 40 but 20. Depends on: Required for payments with product 6101 (Banco do Brasil), 6102 (Itaú), 6103 (Banrisul), 6104 (Bradesco), 6105 (Pix) or 6107 (PicPay). 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 GlobalCollect platform for payments with product 9000 (AfterPay Installments) or 9001 (AfterPay Invoice). Required by the WOPA platform for payments with product 6101 (Banco do Brasil), 6102 (Itaú), 6103 (Banrisul), 6104 (Bradesco), 6105 (Pix) or 6107 (PicPay). Required by the TechProcess platform for cross-border merchants. Required by the GlobalCollect platform when address is included in Seller. Required by the GlobalCollect platform for the creation of a Payout. 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 Required for payments with product 9000 (AfterPay Installments) or 9001 (AfterPay Invoice). Required when address is included in Seller. Required for the creation of a Payout. Depends on: Required for cross-border merchants.
countryCode	string (2)	no depends no yes yes	read close
close Description ISO 3166-1 alpha-2 country code Depends on: Required by the GlobalCollect platform. Required by the TechProcess platform.
houseNumber	string (15)	depends	read close
close Description House number. The houseNumber is truncated after 10 characters for payments, refunds or payouts that are processed by the WL Online Payment Acceptance platform Depends on: Required when address is included in Seller. Required for 6101 (Banco do Brasil), 6102 (Itaú), 6103 (Banrisul), 6104 (Bradesco), 6105 (Pix) and 6107 (PicPay).
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), 6101 (Banco do Brasil), 6102 (Itaú), 6103 (Banrisul), 6104 (Bradesco), 6105 (Pix) or 6107 (PicPay).
street	string (50)	depends depends no depends depends	read close
close Description Streetname Depends on: Required for payments with product 6101 (Banco do Brasil), 6102 (Itaú), 6103 (Banrisul), 6104 (Bradesco), 6105 (Pix) or 6107 (PicPay). 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 GlobalCollect platform for payments with product 9000 (AfterPay Installments) or 9001 (AfterPay Invoice). Required by the WOPA platform for payments with product 6101 (Banco do Brasil), 6102 (Itaú), 6103 (Banrisul), 6104 (Bradesco), 6105 (Pix) or 6107 (PicPay). Required by the TechProcess platform for cross-border merchants. Required by the GlobalCollect platform when address is included in Seller. Required by the GlobalCollect platform for the creation of a Payout. 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. Required for payments with product 9000 (AfterPay Installments) or 9001 (AfterPay Invoice). Required when address is included in Seller. Required for the creation of a Payout. Depends on: Required for cross-border merchants.
zip	string	depends depends no depends depends	read close
close Description Zip code Note: For payments with product 1503 the maximum length is not 10 but 8. Depends on: Required for payments with product 6101 (Banco do Brazil), 6102 (Itaú), 6103 (Banrisul), 6104 (Bradesco), 6105 (Pix) or 6107 (PicPay). Depends on: 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 GlobalCollect platform for payments with product 9000 (AfterPay Installments) or 9001 (AfterPay Invoice). Required by the WOPA platform for payments with product 6101 (Banco do Brazil), 6102 (Itaú), 6103 (Banrisul), 6104 (Bradesco), 6105 (Pix) or 6107 (PicPay). Required by the TechProcess platform for cross-border merchants. Depends on: Required for Direct Debit UK (705) except when a token has been included in the request that includes this value. Required for payments with product 9000 (AfterPay Installments) or 9001 (AfterPay Invoice). 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
merchantCustomerId	string (15)	no	read close
close Description Your identifier for the customer. It can be used as a search criteria in the GlobalCollect Payment Console and is also included in the GlobalCollect report files. It is used in the fraud-screening process for payments on the Ogone Payment Platform.
name	object	yes	read close
close Description Object containing PersonalName object 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).
references	object	yes	read close
close Description Object that holds all reference properties that are linked to this transaction SDK Object type PayoutReferences
invoiceNumber	string (20)	no	read close
close Description Your invoice number (on printed invoice) that is also returned in our report files
merchantOrderId	integer (10)	no	read close
close Description Order Identifier generated by the merchant Note: This does not need to have a unique value for each transaction
merchantReference	string (40)	yes	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.
payoutText	string (50)	no	read close
close Deprecated: Use bankTransferPayoutMethodSpecificInput.payoutText instead Description Text to be printed on the bank account statement of the beneficiary. The maximum allowed length might differ per country. The data will be automatically truncated to the maximum allowed length.
invoiceNumber	string (20)	no	read close
close Deprecated Description Your invoice number (on printed invoice) that is also returned in our report files
merchantOrderId	integer (10)	no	read close
close Deprecated Description Order Identifier generated by the merchant Note: This does not need to have a unique value for each transaction
merchantReference	string (40)	yes	read close
close Deprecated 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.
swiftCode	string (11)	no	read close
close Deprecated: Use bankTransferPayoutMethodSpecificInput.swiftCode instead 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.

Request example

SDK: JSON

This scenario you will probably use the most

{
    "bankTransferPayoutMethodSpecificInput" : {
        "payoutText" : "Payout Acme",
        "payoutDate" : "20150102",
        "swiftCode" : "swift",
        "bankAccountIban" : {
            "iban" : "IT60X0542811101000000123456",
            "accountHolderName" : "Wile E. Coyote"
        }
    },
    "payoutDetails" : {
        "customer" : {
            "contactDetails" : {
                "emailAddress" : "wile.e.coyote@acmelabs.com"
            },
            "companyInformation" : {
                "name" : "Acme Labs"
            },
            "address" : {
                "countryCode" : "US",
                "street" : "N Hollywood Way",
                "houseNumber" : "411",
                "zip" : "91505",
                "city" : "Burbank",
                "state" : "California"
            },
            "name" : {
                "title" : "Mr.",
                "firstName" : "Wile",
                "surnamePrefix" : "E.",
                "surname" : "Coyote"
            }
        },
        "amountOfMoney" : {
            "currencyCode" : "EUR",
            "amount" : 2345
        },
        "references" : {
            "merchantReference" : "AcmeOrder001"
        }
    }
}

{
    "bankTransferPayoutMethodSpecificInput" : {
        "payoutText" : "Payout Acme",
        "bankAccountIban" : {
            "iban" : "***************************",
            "accountHolderName" : "Wile E. Coyote"
        }
    },
    "payoutDetails" : {
        "amountOfMoney" : {
            "currencyCode" : "EUR",
            "amount" : 2345
        },
        "references" : {
            "merchantReference" : "AcmeOrder001"
        },
        "customer" : {
            "address" : {
                "countryCode" : "US",
                "street" : "N Hollywood Way",
                "city" : "Burbank"
            },
            "name" : {
                "surname" : "Coyote"
            }
        }
    }
}

Responses

Please find below an overview of the possible responses.

Response 201 - CreatedPayoutResponse

For every successfully created payout a HTTP 201 response is returned.

Property	Type	Required	Details
Properties Expand all properties Hide deprecated properties
id	string	no	read close
close Description Our unique payout transaction identifier.
payoutOutput	object	no	read close
close Description Object containing payout details SDK Object type OrderOutput
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
references	object	no	read close
close Description Object that holds all reference properties that are linked to this transaction SDK Object type PaymentReferences
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 payouts in a human-readable form. Possible values are : CREATED - The transaction has been created. This is the initial state once a new payout is created. PENDING_APPROVAL - The transaction is awaiting approval from you to proceed with the paying out of the funds REJECTED - The transaction has been rejected PAYOUT_REQUESTED - The transaction is in the queue to be payed out to the customer ACCOUNT_CREDITED - We have successfully credited the customer REJECTED_CREDIT - The credit to the account of the customer was rejected by the bank CANCELLED - You have cancelled the transaction REVERSED - The payout has been reversed and the money is returned to your balance 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 payout status, timestamp of last status change and performable action on the current payout resource. In case of a rejected payout, 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: JSON

This scenario you will probably use the most

{
    "id" : "00000088970012412217000-100001",
    "payoutOutput" : {
        "amountOfMoney" : {
            "amount" : 2345,
            "currencyCode" : "EUR"
        },
        "references" : {
            "paymentReference" : "0",
            "merchantReference" : "2006101135"
        }
    },
    "status" : "PENDING_APPROVAL",
    "statusOutput" : {
        "isCancellable" : false,
        "statusCode" : 600,
        "statusCodeChangeDateTime" : "20130605110207"
    }
}

Response 400 - Bad requestPayoutErrorResponse

In case your request was not correct, like when you did not provide all the required properties, you will get a 400 response.

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
payoutResult	object	no	read close
close Description Object that contains details on the created payout in case one has been created SDK Object type PayoutResult
id	string	no	read close
close Description Our unique payout transaction identifier
payoutOutput	object	no	read close
close Description Object containing payout details SDK Object type OrderOutput
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
references	object	no	read close
close Description Object that holds all reference properties that are linked to this transaction SDK Object type PaymentReferences
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 payouts in a human-readable form. Possible values are : CREATED - The transaction has been created. This is the initial state once a new payout is created. PENDING_APPROVAL - The transaction is awaiting approval from you to proceed with the paying out of the funds REJECTED - The transaction has been rejected PAYOUT_REQUESTED - The transaction is in the queue to be payed out to the customer ACCOUNT_CREDITED - We have successfully credited the customer REJECTED_CREDIT - The credit to the account of the customer was rejected by the bank CANCELLED - You have cancelled the transaction REVERSED - The payout has been reversed and the money is returned to your balance 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 payout status, timestamp of last status change and performable action on the current payout resource. In case of a rejected payout, 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: JSON

This scenario you will probably use the most

{
    "errorId" : "15eabcd5-30b3-479b-ae03-67bb351c07e6-00000092",
    "errors" : [
        {
            "code" : "20000000",
            "propertyName" : "bankAccountIban.accountHolderName",
            "message" : "PARAMETER_NOT_FOUND_IN_REQUEST"
        }
    ],
    "payoutResult" : {
        "id" : "00000088970012412217000-100001",
        "payoutOutput" : {
            "amountOfMoney" : {
                "amount" : 2345,
                "currencyCode" : "EUR"
            },
            "references" : {
                "paymentReference" : "0",
                "merchantReference" : "AcmeOrder0001"
            }
        },
        "status" : "REJECTED",
        "statusOutput" : {
            "errors" : [
                {
                    "code" : "20000000",
                    "message" : "PARAMETER_NOT_FOUND_IN_REQUEST"
                }
            ],
            "isCancellable" : false,
            "statusCode" : 600,
            "statusCodeChangeDateTime" : "20130605110207"
        }
    }
}

Create payout

Payouts

Request

PayloadCreatePayoutRequest

Description

Description

Description

Description

Depends on:

Description

Depends on:

Description

Depends on:

Description

Description

Description

Description

Description

Description

Depends on:

Description

Depends on:

Description

If option chosen, depends on:

Description

Description

Depends on:

Description

Depends on:

Description

Depends on:

Description

Description

Description

Description

Description

Description

Depends on:

Description

Depends on:

Description

Description

Description

Description

Depends on:

Depends on:

Depends on:

Depends on:

Description

Depends on:

Description

Depends on:

Description

Depends on:

Depends on:

Description

Depends on:

Description

Depends on:

Depends on:

Depends on:

Depends on:

Description

Depends on:

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