Create payout
Payouts
Our payout service allows you to easily transfer money directly, either to a card or into a bank account of your choice.
Request
This REST service creates a new payout. A payoutID is returned in the response along with payout details.
PayloadCreatePayoutRequest
Properties
|
|||
Property | Type | Required | Details |
---|---|---|---|
close
Deprecated
DescriptionAmount in cents and always having 2 decimals
|
|||
close
Deprecated
DescriptionThree-letter ISO currency code representing the currency for the amount
|
|||
close
Deprecated:
Use bankTransferPayoutMethodSpecificInput.bankAccountBban instead
DescriptionObject containing account holder name and bank account information. This property can only be used for payouts in the UK.
|
|||
close
Deprecated
DescriptionName of the account holder
Depends on:Required for Create and Update token calls for ACH (730).
|
|||
close
Deprecated
DescriptionBank 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. |
|||
close
Deprecated
DescriptionBank 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). |
|||
close
Deprecated
DescriptionName of the bank
|
|||
close
Deprecated
DescriptionBranch code
|
|||
close
Deprecated
DescriptionBank check digit
|
|||
close
Deprecated
DescriptionISO 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.
|
|||
close
Deprecated:
Use bankTransferPayoutMethodSpecificInput.bankAccountIban instead
DescriptionObject containing account holder and IBAN information.
|
|||
close
Deprecated
DescriptionName in which the account is held.
Depends on:Required for the creation of a Payout
Required for Create and Update token calls. |
|||
close
Deprecated
DescriptionThe IBAN is the International Bank Account Number. It is an internationally agreed format for the BBAN and includes the ISO country code and two check digits.
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 |
|||
object | no depends no yes no | read close | |
close
DescriptionObject containing the specific input details for bank transfer payouts.
If option chosen, depends on:Required by the GlobalCollect platform.
|
|||
close
DescriptionObject containing account holder name and bank account information. This property can only be used for payouts in the UK.
|
|||
close
DescriptionName of the account holder
Depends on:Required for Create and Update token calls for ACH (730).
|
|||
close
DescriptionBank 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. |
|||
close
DescriptionBank 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). |
|||
close
DescriptionName of the bank
|
|||
close
DescriptionBranch code
|
|||
close
DescriptionBank check digit
|
|||
close
DescriptionISO 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.
|
|||
close
DescriptionObject containing account holder and IBAN information.
|
|||
close
DescriptionName in which the account is held.
Depends on:Required for the creation of a Payout
Required for Create and Update token calls. |
|||
close
DescriptionThe IBAN is the International Bank Account Number. It is an internationally agreed format for the BBAN and includes the ISO country code and two check digits.
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 |
|||
close
Deprecated:
Use payoutDetails.customer instead
DescriptionObject containing the details of the customer.
|
|||
close
Deprecated
DescriptionAdditional address information. The additionalInfo is truncated after 10 characters for payments, refunds or payouts that are processed by the WL Online Payment Acceptance platform
|
|||
close
Deprecated
DescriptionCity
Note: For payments with product 1503 the maximum length is not 40 but 20. 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. |
|||
close
Deprecated
DescriptionISO 3166-1 alpha-2 country code
Depends on:Required by the GlobalCollect platform.
Required by the TechProcess platform. |
|||
close
Deprecated
DescriptionHouse 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). |
|||
close
Deprecated
DescriptionFull name of the state or province
Depends on:Required by the TechProcess platform for cross-border merchants.
|
|||
close
Deprecated
DescriptionISO 3166-2 alpha-3 state code
Notes:
Depends on:Required for payments with paymentProductId 1503 (Boleto), 6101 (Banco do Brasil), 6102 (Itaú), 6103 (Banrisul), 6104 (Bradesco), 6105 (Pix) or 6107 (PicPay).
|
|||
close
Deprecated
DescriptionStreetname
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. |
|||
close
Deprecated
DescriptionZip code
Note: For payments with product 1503 the maximum length is not 10 but 8. 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. |
|||
close
Deprecated
DescriptionObject containing company information
|
|||
close
Deprecated
DescriptionThe 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.
|
|||
close
Deprecated
DescriptionName of company, as a customer
Depends on:Required by the GlobalCollect platform for payments when the property order.customer.fiscalNumber is set to:
Required by the WOPA platform for payments when the property order.customer.fiscalNumber is set to:
|
|||
close
Deprecated
DescriptionLocal 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:
|
|||
close
Deprecated
DescriptionObject containing contact details like email address and phone number
|
|||
close
Deprecated
DescriptionEmail address of the customer
|
|||
close
Deprecated
DescriptionPreference for the type of email message markup
|
|||
close
Deprecated
DescriptionYour 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.
|
|||
close
Deprecated
DescriptionGiven name(s) or first name(s) of the customer. The '+' character is not allowed in this property for transactions that are processed by TechProcess Payment Platform.
Depends on:Required by the GlobalCollect platform for payments with:
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. |
|||
close
Deprecated
DescriptionSurname(s) or last name(s) of the customer. The surname is truncated after 25 characters, with the limit being applied after surnamePrefix is prepended, for payments, refunds or payouts that are processed by the WL Online Payment Acceptance platform The '+' character is not allowed in this property for transactions that are processed by TechProcess Payment Platform.
Depends on:Required by the GlobalCollect platform for payments with:
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. |
|||
close
Deprecated
DescriptionMiddle name - In between first name and surname - of the customer. The '+' character is not allowed in this property for transactions that are processed by TechProcess Payment Platform.
|
|||
close
Deprecated
DescriptionTitle 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).
|
|||
close
DescriptionDate of the payout sent to the bank by us.
Format: YYYYMMDD |
|||
close
DescriptionText 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.
|
|||
close
DescriptionThe BIC is the Business Identifier Code, also known as SWIFT or Bank Identifier code. It is a code with an internationally agreed format to Identify a specific bank. The BIC contains 8 or 11 positions: the first 4 contain the bank code, followed by the country code and location code.
|
|||
object | yes depends no yes no | read close | |
close
DescriptionObject containing the specific input details for card payouts.
If option chosen, depends on:Required by the GlobalCollect platform.
Required by the WOPA platform.
|
|||
close
DescriptionObject containing the card details.
|
|||
close
DescriptionThe 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.
|
|||
close
DescriptionThe 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. |
|||
close
DescriptionCard 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).
|
|||
close
DescriptionExpiry date of the card
Format: MMYY Depends on:Required, except when a token or encryptedCustomerInput that includes this data is provided.
|
|||
close
DescriptionIssue number on the card (if applicable)
|
|||
close
DescriptionThe first 2 digits of the card's PIN code. May be optionally submitted for the following payment products:
|
|||
close
DescriptionID 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.
|
|||
close
DescriptionPayment product identifier
Please see payment products for a full overview of possible values. |
|||
close
DescriptionObject containing the details of the recipient of the payout
Depends on:Required by the GlobalCollect platform.
|
|||
close
DescriptionGiven name(s) or first name(s) of the customer
|
|||
close
DescriptionSurname(s) or last name(s) of the customer
|
|||
close
DescriptionMiddle name - In between first name and surname - of the customer
|
|||
close
Deprecated:
Use payoutDetails.customer instead
DescriptionObject containing the details of the customer.
|
|||
close
Deprecated
DescriptionAdditional address information. The additionalInfo is truncated after 10 characters for payments, refunds or payouts that are processed by the WL Online Payment Acceptance platform
|
|||
close
Deprecated
DescriptionCity
Note: For payments with product 1503 the maximum length is not 40 but 20. 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. |
|||
close
Deprecated
DescriptionISO 3166-1 alpha-2 country code
Depends on:Required by the GlobalCollect platform.
Required by the TechProcess platform. |
|||
close
Deprecated
DescriptionHouse 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). |
|||
close
Deprecated
DescriptionFull name of the state or province
Depends on:Required by the TechProcess platform for cross-border merchants.
|
|||
close
Deprecated
DescriptionISO 3166-2 alpha-3 state code
Notes:
Depends on:Required for payments with paymentProductId 1503 (Boleto), 6101 (Banco do Brasil), 6102 (Itaú), 6103 (Banrisul), 6104 (Bradesco), 6105 (Pix) or 6107 (PicPay).
|
|||
close
Deprecated
DescriptionStreetname
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. |
|||
close
Deprecated
DescriptionZip code
Note: For payments with product 1503 the maximum length is not 10 but 8. 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. |
|||
close
Deprecated
DescriptionObject containing company information
|
|||
close
Deprecated
DescriptionThe 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.
|
|||
close
Deprecated
DescriptionName of company, as a customer
Depends on:Required by the GlobalCollect platform for payments when the property order.customer.fiscalNumber is set to:
Required by the WOPA platform for payments when the property order.customer.fiscalNumber is set to:
|
|||
close
Deprecated
DescriptionLocal 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:
|
|||
close
Deprecated
DescriptionObject containing contact details like email address and phone number
|
|||
close
Deprecated
DescriptionEmail address of the customer
|
|||
close
Deprecated
DescriptionPreference for the type of email message markup
|
|||
close
Deprecated
DescriptionYour 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.
|
|||
close
Deprecated
DescriptionGiven name(s) or first name(s) of the customer. The '+' character is not allowed in this property for transactions that are processed by TechProcess Payment Platform.
Depends on:Required by the GlobalCollect platform for payments with:
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. |
|||
close
Deprecated
DescriptionSurname(s) or last name(s) of the customer. The surname is truncated after 25 characters, with the limit being applied after surnamePrefix is prepended, for payments, refunds or payouts that are processed by the WL Online Payment Acceptance platform The '+' character is not allowed in this property for transactions that are processed by TechProcess Payment Platform.
Depends on:Required by the GlobalCollect platform for payments with:
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. |
|||
close
Deprecated
DescriptionMiddle name - In between first name and surname - of the customer. The '+' character is not allowed in this property for transactions that are processed by TechProcess Payment Platform.
|
|||
close
Deprecated
DescriptionTitle 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).
|
|||
object | no | read close | |
close
DescriptionIn 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.
|
|||
close
Deprecated:
Use bankTransferPayoutMethodSpecificInput.payoutDate instead
DescriptionDate of the payout sent to the bank by us
Format: YYYYMMDD |
|||
object | yes | read close | |
close
DescriptionObject containing the details for Create Payout Request
|
|||
close
DescriptionObject containing amount and ISO currency code attributes
|
|||
close
DescriptionAmount in cents and always having 2 decimals
|
|||
close
DescriptionThree-letter ISO currency code representing the currency for the amount
|
|||
close
DescriptionObject containing the details of the customer.
Depends on:Required by the GlobalCollect platform.
|
|||
close
DescriptionAdditional address information. The additionalInfo is truncated after 10 characters for payments, refunds or payouts that are processed by the WL Online Payment Acceptance platform
|
|||
close
DescriptionCity
Note: For payments with product 1503 the maximum length is not 40 but 20. 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. |
|||
close
DescriptionISO 3166-1 alpha-2 country code
Depends on:Required by the GlobalCollect platform.
Required by the TechProcess platform. |
|||
close
DescriptionHouse 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). |
|||
close
DescriptionFull name of the state or province
Depends on:Required by the TechProcess platform for cross-border merchants.
|
|||
close
DescriptionISO 3166-2 alpha-3 state code
Notes:
Depends on:Required for payments with paymentProductId 1503 (Boleto), 6101 (Banco do Brasil), 6102 (Itaú), 6103 (Banrisul), 6104 (Bradesco), 6105 (Pix) or 6107 (PicPay).
|
|||
close
DescriptionStreetname
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. |
|||
close
DescriptionZip code
Note: For payments with product 1503 the maximum length is not 10 but 8. 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. |
|||
close
DescriptionThe 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.
|
|||
close
DescriptionName of company, as a customer
Depends on:Required by the GlobalCollect platform for payments when the property order.customer.fiscalNumber is set to:
Required by the WOPA platform for payments when the property order.customer.fiscalNumber is set to:
|
|||
close
DescriptionLocal 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:
|
|||
close
DescriptionObject containing contact details like email address and phone number
|
|||
close
DescriptionEmail address of the customer
|
|||
close
DescriptionPreference for the type of email message markup
|
|||
close
DescriptionYour 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.
|
|||
close
DescriptionGiven name(s) or first name(s) of the customer. The '+' character is not allowed in this property for transactions that are processed by TechProcess Payment Platform.
Depends on:Required by the GlobalCollect platform for payments with:
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. |
|||
close
DescriptionSurname(s) or last name(s) of the customer. The surname is truncated after 25 characters, with the limit being applied after surnamePrefix is prepended, for payments, refunds or payouts that are processed by the WL Online Payment Acceptance platform The '+' character is not allowed in this property for transactions that are processed by TechProcess Payment Platform.
Depends on:Required by the GlobalCollect platform for payments with:
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. |
|||
close
DescriptionMiddle name - In between first name and surname - of the customer. The '+' character is not allowed in this property for transactions that are processed by TechProcess Payment Platform.
|
|||
close
DescriptionTitle 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).
|
|||
close
DescriptionObject that holds all reference properties that are linked to this transaction
|
|||
close
DescriptionYour invoice number (on printed invoice) that is also returned in our report files
|
|||
close
DescriptionOrder Identifier generated by the merchant
Note: This does not need to have a unique value for each transaction |
|||
close
DescriptionNote that the maximum length of this field for transactions processed on the GlobalCollect platform is 30. Your unique reference of the transaction that is also returned in our report files. This is almost always used for your reconciliation of our report files. |
|||
close
Deprecated:
Use bankTransferPayoutMethodSpecificInput.payoutText instead
DescriptionText 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.
|
|||
close
Deprecated
DescriptionYour invoice number (on printed invoice) that is also returned in our report files
|
|||
close
Deprecated
DescriptionOrder Identifier generated by the merchant
Note: This does not need to have a unique value for each transaction |
|||
close
Deprecated
DescriptionNote that the maximum length of this field for transactions processed on the GlobalCollect platform is 30. Your unique reference of the transaction that is also returned in our report files. This is almost always used for your reconciliation of our report files. |
|||
close
Deprecated:
Use bankTransferPayoutMethodSpecificInput.swiftCode instead
DescriptionThe BIC is the Business Identifier Code, also known as SWIFT or Bank Identifier code. It is a code with an internationally agreed format to Identify a specific bank. The BIC contains 8 or 11 positions: the first 4 contain the bank code, followed by the country code and location code.
|
|||
Property | Type | Required | Details |
Request example
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" } } }
Responses
Please find below an overview of the possible responses.
Response 201 - CreatedPayoutResponse
For every successfully created payout a HTTP 201 response is returned.
Properties
|
|||
Property | Type | Required | Details |
---|---|---|---|
id | string | no | read close |
close
DescriptionOur unique payout transaction identifier.
|
|||
object | no | read close | |
close
DescriptionObject containing amount and ISO currency code attributes
|
|||
close
DescriptionAmount in cents and always having 2 decimals
|
|||
close
DescriptionThree-letter ISO currency code representing the currency for the amount
|
|||
close
DescriptionObject that holds all reference properties that are linked to this transaction
|
|||
close
DescriptionYour order ID for this transaction that is also returned in our report files
|
|||
close
DescriptionYour unique reference of the transaction that is also returned in our report files. This is almost always used for your reconciliation of our report files.
|
|||
close
DescriptionPayment Reference generated by WebCollect
|
|||
close
DescriptionProvides an additional means of reconciliation for Gateway merchants
|
|||
close
DescriptionProvides an additional means of reconciliation, this is the MerchantId used at the provider
|
|||
close
DescriptionProvides an additional means of reconciliation for Gateway merchants
|
|||
close
DescriptionWhen you did not supply a merchantReference for your payment, you need to fill this property with the reference of the original payment when you want to refund it
|
|||
status | enum | no | read close |
close
DescriptionCurrent high-level status of the payouts in a human-readable form. Possible values are :
Please see Statuses for a full overview of possible values. |
|||
object | no | read close | |
close
DescriptionThis object has the numeric representation of the current 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.
|
|||
close
DescriptionCustom object contains the set of errors
|
|||
close
DescriptionCategory the error belongs to. The category should give an indication of the type of error you are dealing with.
Possible values:
|
|||
close
DescriptionError code
|
|||
close
DescriptionHTTP status code for this error that can be used to determine the type of error
|
|||
close
DescriptionID of the error. This is a short human-readable message that briefly describes the error.
|
|||
close
DescriptionHuman-readable error message that is not meant to be relayed to customer as it might tip off people who are trying to commit fraud
|
|||
close
DescriptionReturned only if the error relates to a value that was missing or incorrect.
Contains a location path to the value as a JSonata query. Some common examples:
|
|||
close
DescriptionID of the request that can be used for debugging purposes
|
|||
close
DescriptionFlag indicating if the payment can be cancelled
|
|||
close
DescriptionFlag indicating whether a rejected payment may be retried by the merchant without incurring a fee
|
|||
close
DescriptionThis is the raw response returned by the acquirer. This property contains unprocessed data directly returned by the acquirer. It's recommended for data analysis only due to its dynamic nature, which may undergo future changes.
|
|||
close
DescriptionName of the key or property
|
|||
close
DescriptionValue of the key or property
|
|||
close
DescriptionHighlevel status of the payment, payout or refund with the following possible values:
Please see Statuses for a full overview of possible values. |
|||
close
DescriptionNumeric status code of the legacy API. It is returned to ease the migration from the legacy APIs to Worldline Connect. You should not write new business logic based on this property as it will be deprecated in a future version of the API. The value can also be found in the GlobalCollect Payment Console, in the Ogone BackOffice and in report files.
|
|||
close
DescriptionDate and time of payment
Format: YYYYMMDDHH24MISS |
|||
Property | Type | Required | Details |
Response example
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.
Properties
|
|||
Property | Type | Required | Details |
---|---|---|---|
errorId | string | yes | read close |
close
DescriptionUnique reference, for debugging purposes, of this error response
|
|||
array of object | yes | read close | |
close
DescriptionList of one or more errors
|
|||
close
DescriptionCategory the error belongs to. The category should give an indication of the type of error you are dealing with.
Possible values:
|
|||
close
DescriptionError code
|
|||
close
DescriptionHTTP status code for this error that can be used to determine the type of error
|
|||
close
DescriptionID of the error. This is a short human-readable message that briefly describes the error.
|
|||
close
DescriptionHuman-readable error message that is not meant to be relayed to customer as it might tip off people who are trying to commit fraud
|
|||
close
DescriptionReturned only if the error relates to a value that was missing or incorrect.
Contains a location path to the value as a JSonata query. Some common examples:
|
|||
close
DescriptionID of the request that can be used for debugging purposes
|
|||
object | no | read close | |
close
DescriptionObject that contains details on the created payout in case one has been created
|
|||
close
DescriptionOur unique payout transaction identifier
|
|||
close
DescriptionObject containing amount and ISO currency code attributes
|
|||
close
DescriptionAmount in cents and always having 2 decimals
|
|||
close
DescriptionThree-letter ISO currency code representing the currency for the amount
|
|||
close
DescriptionObject that holds all reference properties that are linked to this transaction
|
|||
close
DescriptionYour order ID for this transaction that is also returned in our report files
|
|||
close
DescriptionYour unique reference of the transaction that is also returned in our report files. This is almost always used for your reconciliation of our report files.
|
|||
close
DescriptionPayment Reference generated by WebCollect
|
|||
close
DescriptionProvides an additional means of reconciliation for Gateway merchants
|
|||
close
DescriptionProvides an additional means of reconciliation, this is the MerchantId used at the provider
|
|||
close
DescriptionProvides an additional means of reconciliation for Gateway merchants
|
|||
close
DescriptionWhen you did not supply a merchantReference for your payment, you need to fill this property with the reference of the original payment when you want to refund it
|
|||
close
DescriptionCurrent high-level status of the payouts in a human-readable form. Possible values are :
Please see Statuses for a full overview of possible values. |
|||
close
DescriptionThis 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.
|
|||
close
DescriptionCustom object contains the set of errors
|
|||
close
DescriptionCategory the error belongs to. The category should give an indication of the type of error you are dealing with.
Possible values:
|
|||
close
DescriptionError code
|
|||
close
DescriptionHTTP status code for this error that can be used to determine the type of error
|
|||
close
DescriptionID of the error. This is a short human-readable message that briefly describes the error.
|
|||
close
DescriptionHuman-readable error message that is not meant to be relayed to customer as it might tip off people who are trying to commit fraud
|
|||
close
DescriptionReturned only if the error relates to a value that was missing or incorrect.
Contains a location path to the value as a JSonata query. Some common examples:
|
|||
close
DescriptionID of the request that can be used for debugging purposes
|
|||
close
DescriptionFlag indicating if the payment can be cancelled
|
|||
close
DescriptionFlag indicating whether a rejected payment may be retried by the merchant without incurring a fee
|
|||
close
DescriptionThis is the raw response returned by the acquirer. This property contains unprocessed data directly returned by the acquirer. It's recommended for data analysis only due to its dynamic nature, which may undergo future changes.
|
|||
close
DescriptionName of the key or property
|
|||
close
DescriptionValue of the key or property
|
|||
close
DescriptionHighlevel status of the payment, payout or refund with the following possible values:
Please see Statuses for a full overview of possible values. |
|||
close
DescriptionNumeric status code of the legacy API. It is returned to ease the migration from the legacy APIs to Worldline Connect. You should not write new business logic based on this property as it will be deprecated in a future version of the API. The value can also be found in the GlobalCollect Payment Console, in the Ogone BackOffice and in report files.
|
|||
close
DescriptionDate and time of payment
Format: YYYYMMDDHH24MISS |
|||
Property | Type | Required | Details |
Response example
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" } } }