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 |
---|---|---|---|
amount | integer (12) | yes | read close |
close
Deprecated
DescriptionAmount in cents and always having 2 decimals
|
|||
currencyCode | string (3) | yes | read close |
close
Deprecated
DescriptionThree-letter ISO currency code representing the currency for the amount
|
|||
object | no | read close | |
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.
|
|||
accountHolderName | string (30) | depends | read close |
close
Deprecated
DescriptionName of the account holder
|
|||
accountNumber | string | depends | read close |
close
Deprecated
DescriptionBank account number
|
|||
bankCode | string | depends | read close |
close
Deprecated
DescriptionBank code
|
|||
bankName | string (40) | no | read close |
close
Deprecated
DescriptionName of the bank
|
|||
branchCode | string | no | read close |
close
Deprecated
DescriptionBranch code
|
|||
checkDigit | string | no | read close |
close
Deprecated
DescriptionBank check digit
|
|||
countryCode | string (2) | no | read close |
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.
|
|||
object | no | read close | |
close
Deprecated:
Use bankTransferPayoutMethodSpecificInput.bankAccountIban instead
DescriptionObject containing account holder and IBAN information.
|
|||
accountHolderName | string (30) | depends | read close |
close
Deprecated
DescriptionName in which the account is held.
|
|||
iban | string (50) | depends | read close |
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.
|
|||
object | no depends no yes no | read close | |
close
DescriptionObject containing the specific input details for bank transfer payouts.
|
|||
object | one of the group | read close | |
close
DescriptionObject containing account holder name and bank account information. This property can only be used for payouts in the UK.
|
|||
accountHolderName | string (30) | depends | read close |
close
DescriptionName of the account holder
|
|||
accountNumber | string | depends | read close |
close
DescriptionBank account number
|
|||
bankCode | string | depends | read close |
close
DescriptionBank code
|
|||
bankName | string (40) | no | read close |
close
DescriptionName of the bank
|
|||
branchCode | string | no | read close |
close
DescriptionBranch code
|
|||
checkDigit | string | no | read close |
close
DescriptionBank check digit
|
|||
countryCode | string (2) | no | read close |
close
DescriptionISO 3166-1 alpha-2 country code of the country where the bank account is held
For UK payouts this value is automatically set to GB as only payouts to UK accounts are supported.
|
|||
object | one of the group | read close | |
close
DescriptionObject containing account holder and IBAN information.
|
|||
accountHolderName | string (30) | depends | read close |
close
DescriptionName in which the account is held.
|
|||
iban | string (50) | depends | read close |
close
DescriptionThe IBAN is the International Bank Account Number. It is an internationally agreed format for the BBAN and includes the ISO country code and two check digits.
|
|||
object | no | read close | |
close
Deprecated:
Use payoutDetails.customer instead
DescriptionObject containing the details of the customer.
|
|||
object | yes | read close | |
additionalInfo | string (50) | no | read close |
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
|
|||
city | string | depends depends no depends depends | read close |
close
Deprecated
DescriptionCity
Note: For payments with product 1503 the maximum length is not 40 but 20. |
|||
countryCode | string (2) | no depends no yes yes | read close |
close
Deprecated
DescriptionISO 3166-1 alpha-2 country code
|
|||
houseNumber | string (15) | depends | read close |
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
|
|||
state | string (35) | no depends no no depends | read close |
close
Deprecated
DescriptionFull name of the state or province
|
|||
stateCode | string | depends | read close |
close
Deprecated
DescriptionISO 3166-2 alpha-3 state code
Notes:
|
|||
street | string (50) | depends depends no depends depends | read close |
close
Deprecated
DescriptionStreetname
|
|||
zip | string | depends depends no depends depends | read close |
close
Deprecated
DescriptionZip code
Note: For payments with product 1503 the maximum length is not 10 but 8. |
|||
object | no | read close | |
close
Deprecated
DescriptionObject containing company information
|
|||
dateOfIncorporation | string (8) | no depends no no depends | read close |
close
Deprecated
DescriptionThe date of incorporation is the specific date when the company was registered with the relevant authority.
Format: YYYYMMDD |
|||
name | string (40) | depends depends no no no | read close |
close
Deprecated
DescriptionName of company, as a customer
|
|||
vatNumber | string (17) | depends | read close |
close
Deprecated
DescriptionLocal VAT number of the company
|
|||
object | no | read close | |
close
Deprecated
DescriptionObject containing contact details like email address and phone number
|
|||
emailAddress | string (70) | no | read close |
close
Deprecated
DescriptionEmail address of the customer
|
|||
emailMessageType | string | no | read close |
close
Deprecated
DescriptionPreference for the type of email message markup
|
|||
merchantCustomerId | string (15) | no | read close |
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.
|
|||
object | yes | read close | |
firstName | string (15) | depends depends no depends depends | read close |
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.
|
|||
surname | string (70) | depends depends depends depends depends | read close |
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.
|
|||
surnamePrefix | string (15) | no | read close |
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.
|
|||
title | string (35) | depends | read close |
close
Deprecated
DescriptionTitle of customer
|
|||
payoutDate | string (8) | no | read close |
close
DescriptionDate of the payout sent to the bank by us.
Format: YYYYMMDD |
|||
payoutText | string (50) | yes | read close |
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.
|
|||
swiftCode | string (11) | no | read close |
close
DescriptionThe BIC is the Business Identifier Code, also known as SWIFT or Bank Identifier code. It is a code with an internationally agreed format to Identify a specific bank. The BIC contains 8 or 11 positions: the first 4 contain the bank code, followed by the country code and location code.
|
|||
object | yes depends no yes no | read close | |
close
DescriptionObject containing the specific input details for card payouts.
|
|||
object | one of the group | read close | |
close
DescriptionObject containing the card details.
|
|||
cardNumber | string (19) | depends | read close |
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 |
|||
cardholderName | string (51) | no depends depends no yes | read close |
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.
|
|||
cvv | string (4) | depends | read close |
close
DescriptionCard Verification Value, a 3 or 4 digit code used as an additional security feature for card not present transactions.
|
|||
expiryDate | string (4) | depends | read close |
close
DescriptionExpiry date of the card
Format: MMYY |
|||
issueNumber | string (2) | no | read close |
close
DescriptionIssue number on the card (if applicable)
|
|||
partialPin | string (2) | no | read close |
close
DescriptionThe first 2 digits of the card's PIN code. May be optionally submitted for South Korean cards (paymentProductIds 180, 181, 182, 183, 184, 185 and 186). Submitting this property may improve your authorization rate.
|
|||
Group token | string | one of the group | read close |
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.
|
|||
paymentProductId | integer (5) | yes | read close |
close
DescriptionPayment product identifier
Please see payment products for a full overview of possible values. |
|||
object | no depends no yes no | read close | |
close
DescriptionObject containing the details of the recipient of the payout
|
|||
firstName | string (15) | yes | read close |
close
DescriptionGiven name(s) or first name(s) of the customer
|
|||
surname | string (70) | yes | read close |
close
DescriptionSurname(s) or last name(s) of the customer
|
|||
surnamePrefix | string (15) | no | read close |
close
DescriptionMiddle name - In between first name and surname - of the customer
|
|||
object | no | read close | |
close
Deprecated:
Use payoutDetails.customer instead
DescriptionObject containing the details of the customer.
|
|||
object | yes | read close | |
additionalInfo | string (50) | no | read close |
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
|
|||
city | string | depends depends no depends depends | read close |
close
Deprecated
DescriptionCity
Note: For payments with product 1503 the maximum length is not 40 but 20. |
|||
countryCode | string (2) | no depends no yes yes | read close |
close
Deprecated
DescriptionISO 3166-1 alpha-2 country code
|
|||
houseNumber | string (15) | depends | read close |
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
|
|||
state | string (35) | no depends no no depends | read close |
close
Deprecated
DescriptionFull name of the state or province
|
|||
stateCode | string | depends | read close |
close
Deprecated
DescriptionISO 3166-2 alpha-3 state code
Notes:
|
|||
street | string (50) | depends depends no depends depends | read close |
close
Deprecated
DescriptionStreetname
|
|||
zip | string | depends depends no depends depends | read close |
close
Deprecated
DescriptionZip code
Note: For payments with product 1503 the maximum length is not 10 but 8. |
|||
object | no | read close | |
close
Deprecated
DescriptionObject containing company information
|
|||
dateOfIncorporation | string (8) | no depends no no depends | read close |
close
Deprecated
DescriptionThe date of incorporation is the specific date when the company was registered with the relevant authority.
Format: YYYYMMDD |
|||
name | string (40) | depends depends no no no | read close |
close
Deprecated
DescriptionName of company, as a customer
|
|||
vatNumber | string (17) | depends | read close |
close
Deprecated
DescriptionLocal VAT number of the company
|
|||
object | no | read close | |
close
Deprecated
DescriptionObject containing contact details like email address and phone number
|
|||
emailAddress | string (70) | no | read close |
close
Deprecated
DescriptionEmail address of the customer
|
|||
emailMessageType | string | no | read close |
close
Deprecated
DescriptionPreference for the type of email message markup
|
|||
merchantCustomerId | string (15) | no | read close |
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.
|
|||
object | yes | read close | |
firstName | string (15) | depends depends no depends depends | read close |
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.
|
|||
surname | string (70) | depends depends depends depends depends | read close |
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.
|
|||
surnamePrefix | string (15) | no | read close |
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.
|
|||
title | string (35) | depends | read close |
close
Deprecated
DescriptionTitle of customer
|
|||
object | no | read close | |
configurationId | string | 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.
|
|||
payoutDate | string (8) | no | read close |
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
|
|||
object | yes | read close | |
close
DescriptionObject containing amount and ISO currency code attributes
|
|||
amount | integer (12) | yes | read close |
close
DescriptionAmount in cents and always having 2 decimals
|
|||
currencyCode | string (3) | yes | read close |
close
DescriptionThree-letter ISO currency code representing the currency for the amount
|
|||
object | no depends no yes no | read close | |
object | yes | read close | |
additionalInfo | string (50) | no | read close |
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
|
|||
city | string | depends depends no depends depends | read close |
close
DescriptionCity
Note: For payments with product 1503 the maximum length is not 40 but 20. |
|||
countryCode | string (2) | no depends no yes yes | read close |
close
DescriptionISO 3166-1 alpha-2 country code
|
|||
houseNumber | string (15) | depends | read close |
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
|
|||
state | string (35) | no depends no no depends | read close |
close
DescriptionFull name of the state or province
|
|||
stateCode | string | depends | read close |
close
DescriptionISO 3166-2 alpha-3 state code
Notes:
|
|||
street | string (50) | depends depends no depends depends | read close |
close
DescriptionStreetname
|
|||
zip | string | depends depends no depends depends | read close |
close
DescriptionZip code
Note: For payments with product 1503 the maximum length is not 10 but 8. |
|||
object | no | read close | |
dateOfIncorporation | string (8) | no depends no no depends | read close |
close
DescriptionThe date of incorporation is the specific date when the company was registered with the relevant authority.
Format: YYYYMMDD |
|||
name | string (40) | depends depends no no no | read close |
close
DescriptionName of company, as a customer
|
|||
vatNumber | string (17) | depends | read close |
close
DescriptionLocal VAT number of the company
|
|||
object | no | read close | |
close
DescriptionObject containing contact details like email address and phone number
|
|||
emailAddress | string (70) | no | read close |
close
DescriptionEmail address of the customer
|
|||
emailMessageType | string | no | read close |
close
DescriptionPreference for the type of email message markup
|
|||
merchantCustomerId | string (15) | no | read close |
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.
|
|||
object | yes | read close | |
firstName | string (15) | depends depends no depends depends | read close |
close
DescriptionGiven name(s) or first name(s) of the customer. The '+' character is not allowed in this property for transactions that are processed by TechProcess Payment Platform.
|
|||
surname | string (70) | depends depends depends depends depends | read close |
close
DescriptionSurname(s) or last name(s) of the customer. The surname is truncated after 25 characters, with the limit being applied after surnamePrefix is prepended, for payments, refunds or payouts that are processed by the WL Online Payment Acceptance platform The '+' character is not allowed in this property for transactions that are processed by TechProcess Payment Platform.
|
|||
surnamePrefix | string (15) | no | read close |
close
DescriptionMiddle name - In between first name and surname - of the customer. The '+' character is not allowed in this property for transactions that are processed by TechProcess Payment Platform.
|
|||
title | string (35) | depends | read close |
close
DescriptionTitle of customer
|
|||
object | yes | read close | |
close
DescriptionObject that holds all reference properties that are linked to this transaction
|
|||
invoiceNumber | string (20) | no | read close |
close
DescriptionYour invoice number (on printed invoice) that is also returned in our report files
|
|||
merchantOrderId | integer (10) | no | read close |
close
DescriptionOrder 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
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. |
|||
payoutText | string (50) | no | read close |
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.
|
|||
invoiceNumber | string (20) | no | read close |
close
Deprecated
DescriptionYour invoice number (on printed invoice) that is also returned in our report files
|
|||
merchantOrderId | integer (10) | no | read close |
close
Deprecated
DescriptionOrder 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
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. |
|||
swiftCode | string (11) | no | read close |
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.
|
Request example
This scenario you will probably use the most
-
$bankAccountIban = new BankAccountIban(); $bankAccountIban->accountHolderName = 'Wile E. Coyote'; $bankAccountIban->iban = 'IT60X0542811101000000123456'; $bankTransferPayoutMethodSpecificInput = new BankTransferPayoutMethodSpecificInput(); $bankTransferPayoutMethodSpecificInput->bankAccountIban = $bankAccountIban; $bankTransferPayoutMethodSpecificInput->payoutDate = '20150102'; $bankTransferPayoutMethodSpecificInput->payoutText = 'Payout Acme'; $bankTransferPayoutMethodSpecificInput->swiftCode = 'swift'; $amountOfMoney = new AmountOfMoney(); $amountOfMoney->amount = 2345; $amountOfMoney->currencyCode = 'EUR'; $address = new Address(); $address->city = 'Burbank'; $address->countryCode = 'US'; $address->houseNumber = '411'; $address->state = 'California'; $address->street = 'N Hollywood Way'; $address->zip = '91505'; $companyInformation = new CompanyInformation(); $companyInformation->name = 'Acme Labs'; $contactDetails = new ContactDetailsBase(); $contactDetails->emailAddress = 'wile.e.coyote@acmelabs.com'; $name = new PersonalName(); $name->firstName = 'Wile'; $name->surname = 'Coyote'; $name->surnamePrefix = 'E.'; $name->title = 'Mr.'; $customer = new PayoutCustomer(); $customer->address = $address; $customer->companyInformation = $companyInformation; $customer->contactDetails = $contactDetails; $customer->name = $name; $references = new PayoutReferences(); $references->merchantReference = 'AcmeOrder001'; $payoutDetails = new PayoutDetails(); $payoutDetails->amountOfMoney = $amountOfMoney; $payoutDetails->customer = $customer; $payoutDetails->references = $references; $body = new CreatePayoutRequest(); $body->bankTransferPayoutMethodSpecificInput = $bankTransferPayoutMethodSpecificInput; $body->payoutDetails = $payoutDetails; try { $response = $client->v1()->merchant('merchantId')->payouts()->create($body); } catch (DeclinedPayoutException $e) { $this->handleDeclinedPayout($e->getPayoutResult()); } catch (ResponseException $e) { $this->handleErrorResponse($e->getErrorId(), $e->getErrors()); }
-
$bankAccountIban = new BankAccountIban(); $bankAccountIban->accountHolderName = 'Wile E. Coyote'; $bankAccountIban->iban = '***************************'; $bankTransferPayoutMethodSpecificInput = new BankTransferPayoutMethodSpecificInput(); $bankTransferPayoutMethodSpecificInput->bankAccountIban = $bankAccountIban; $bankTransferPayoutMethodSpecificInput->payoutText = 'Payout Acme'; $amountOfMoney = new AmountOfMoney(); $amountOfMoney->amount = 2345; $amountOfMoney->currencyCode = 'EUR'; $address = new Address(); $address->city = 'Burbank'; $address->countryCode = 'US'; $address->street = 'N Hollywood Way'; $name = new PersonalName(); $name->surname = 'Coyote'; $customer = new PayoutCustomer(); $customer->address = $address; $customer->name = $name; $references = new PayoutReferences(); $references->merchantReference = 'AcmeOrder001'; $payoutDetails = new PayoutDetails(); $payoutDetails->amountOfMoney = $amountOfMoney; $payoutDetails->customer = $customer; $payoutDetails->references = $references; $body = new CreatePayoutRequest(); $body->bankTransferPayoutMethodSpecificInput = $bankTransferPayoutMethodSpecificInput; $body->payoutDetails = $payoutDetails; try { $response = $client->v1()->merchant('merchantId')->payouts()->create($body); } catch (DeclinedPayoutException $e) { $this->handleDeclinedPayout($e->getPayoutResult()); } catch (ResponseException $e) { $this->handleErrorResponse($e->getErrorId(), $e->getErrors()); }
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 | |
object | no | read close | |
close
DescriptionObject containing amount and ISO currency code attributes
|
|||
amount | integer (12) | yes | read close |
close
DescriptionAmount in cents and always having 2 decimals
|
|||
currencyCode | string (3) | yes | read close |
close
DescriptionThree-letter ISO currency code representing the currency for the amount
|
|||
object | no | read close | |
close
DescriptionObject that holds all reference properties that are linked to this transaction
|
|||
merchantOrderId | integer | no | read close |
close
DescriptionYour order ID for this transaction that is also returned in our report files
|
|||
merchantReference | string | no | read close |
close
DescriptionYour unique reference of the transaction that is also returned in our report files. This is almost always used for your reconciliation of our report files.
|
|||
paymentReference | string | no | read close |
close
DescriptionPayment Reference generated by WebCollect
|
|||
providerId | string | no | read close |
close
DescriptionProvides an additional means of reconciliation for Gateway merchants
|
|||
providerMerchantId | string | no | read close |
close
DescriptionProvides an additional means of reconciliation, this is the MerchantId used at the provider
|
|||
providerReference | string | no | read close |
close
DescriptionProvides an additional means of reconciliation for Gateway merchants
|
|||
referenceOrigPayment | string | no | read close |
close
DescriptionWhen you did not supply a merchantReference for your payment, you need to fill this property with the reference of the original payment when you want to refund it
|
|||
status | enum | no | read close |
close
DescriptionCurrent high-level status of the 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.
|
|||
array of object | no | read close | |
close
DescriptionCustom object contains the set of errors
|
|||
object | no | read close | |
category | string | no | read close |
close
DescriptionCategory the error belongs to. The category should give an indication of the type of error you are dealing with.
Possible values:
|
|||
code | string | yes | read close |
close
DescriptionError code
|
|||
httpStatusCode | integer | no | read close |
close
DescriptionHTTP status code for this error that can be used to determine the type of error
|
|||
id | string | no | read close |
close
DescriptionID of the error. This is a short human-readable message that briefly describes the error.
|
|||
message | string | no | read close |
close
DescriptionHuman-readable error message that is not meant to be relayed to customer as it might tip off people who are trying to commit fraud
|
|||
propertyName | string | no | read close |
close
DescriptionReturned only if the error relates to a value that was missing or incorrect.
Contains a location path to the value as a JSonata query. Some common examples:
|
|||
requestId | string | no | read close |
close
DescriptionID of the request that can be used for debugging purposes
|
|||
isCancellable | boolean | no | read close |
close
DescriptionFlag indicating if the payment can be cancelled
|
|||
isRetriable | boolean | no | read close |
close
DescriptionFlag indicating whether a rejected payment may be retried by the merchant without incurring a fee
|
|||
array of object | no | read close | |
close
DescriptionThis is the raw response returned by the acquirer. This property contains unprocessed data directly returned by the acquirer. It's recommended for data analysis only due to its dynamic nature, which may undergo future changes.
|
|||
object | no | read close | |
key | string | no | read close |
close
DescriptionName of the key or property
|
|||
value | string | no | read close |
close
DescriptionValue of the key or property
|
|||
statusCategory | enum | no | read close |
close
DescriptionHighlevel status of the payment, payout or refund with the following possible values:
Please see Statuses for a full overview of possible values. |
|||
statusCode | integer | no | read close |
close
DescriptionNumeric status code of the legacy API. It is returned to ease the migration from the legacy APIs to Worldline Connect. You should not write new business logic based on this property as it will be deprecated in a future version of the API. The value can also be found in the GlobalCollect Payment Console, in the Ogone BackOffice and in report files.
|
|||
statusCodeChangeDateTime | string | no | read close |
close
DescriptionDate and time of payment
Format: YYYYMMDDHH24MISS |
Response example
This scenario you will probably use the most
-
{ "id" : "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
|
|||
object | no | read close | |
category | string | no | read close |
close
DescriptionCategory the error belongs to. The category should give an indication of the type of error you are dealing with.
Possible values:
|
|||
code | string | yes | read close |
close
DescriptionError code
|
|||
httpStatusCode | integer | no | read close |
close
DescriptionHTTP status code for this error that can be used to determine the type of error
|
|||
id | string | no | read close |
close
DescriptionID of the error. This is a short human-readable message that briefly describes the error.
|
|||
message | string | no | read close |
close
DescriptionHuman-readable error message that is not meant to be relayed to customer as it might tip off people who are trying to commit fraud
|
|||
propertyName | string | no | read close |
close
DescriptionReturned only if the error relates to a value that was missing or incorrect.
Contains a location path to the value as a JSonata query. Some common examples:
|
|||
requestId | string | no | read close |
close
DescriptionID of the request that can be used for debugging purposes
|
|||
object | no | read close | |
close
DescriptionObject that contains details on the created payout in case one has been created
|
|||
id | string | no | read close |
close
DescriptionOur unique payout transaction identifier
|
|||
object | no | read close | |
object | no | read close | |
close
DescriptionObject containing amount and ISO currency code attributes
|
|||
amount | integer (12) | yes | read close |
close
DescriptionAmount in cents and always having 2 decimals
|
|||
currencyCode | string (3) | yes | read close |
close
DescriptionThree-letter ISO currency code representing the currency for the amount
|
|||
object | no | read close | |
close
DescriptionObject that holds all reference properties that are linked to this transaction
|
|||
merchantOrderId | integer | no | read close |
close
DescriptionYour order ID for this transaction that is also returned in our report files
|
|||
merchantReference | string | no | read close |
close
DescriptionYour unique reference of the transaction that is also returned in our report files. This is almost always used for your reconciliation of our report files.
|
|||
paymentReference | string | no | read close |
close
DescriptionPayment Reference generated by WebCollect
|
|||
providerId | string | no | read close |
close
DescriptionProvides an additional means of reconciliation for Gateway merchants
|
|||
providerMerchantId | string | no | read close |
close
DescriptionProvides an additional means of reconciliation, this is the MerchantId used at the provider
|
|||
providerReference | string | no | read close |
close
DescriptionProvides an additional means of reconciliation for Gateway merchants
|
|||
referenceOrigPayment | string | no | read close |
close
DescriptionWhen you did not supply a merchantReference for your payment, you need to fill this property with the reference of the original payment when you want to refund it
|
|||
status | enum | no | read close |
close
DescriptionCurrent high-level status of the 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.
|
|||
array of object | no | read close | |
close
DescriptionCustom object contains the set of errors
|
|||
object | no | read close | |
category | string | no | read close |
close
DescriptionCategory the error belongs to. The category should give an indication of the type of error you are dealing with.
Possible values:
|
|||
code | string | yes | read close |
close
DescriptionError code
|
|||
httpStatusCode | integer | no | read close |
close
DescriptionHTTP status code for this error that can be used to determine the type of error
|
|||
id | string | no | read close |
close
DescriptionID of the error. This is a short human-readable message that briefly describes the error.
|
|||
message | string | no | read close |
close
DescriptionHuman-readable error message that is not meant to be relayed to customer as it might tip off people who are trying to commit fraud
|
|||
propertyName | string | no | read close |
close
DescriptionReturned only if the error relates to a value that was missing or incorrect.
Contains a location path to the value as a JSonata query. Some common examples:
|
|||
requestId | string | no | read close |
close
DescriptionID of the request that can be used for debugging purposes
|
|||
isCancellable | boolean | no | read close |
close
DescriptionFlag indicating if the payment can be cancelled
|
|||
isRetriable | boolean | no | read close |
close
DescriptionFlag indicating whether a rejected payment may be retried by the merchant without incurring a fee
|
|||
array of object | no | read close | |
close
DescriptionThis is the raw response returned by the acquirer. This property contains unprocessed data directly returned by the acquirer. It's recommended for data analysis only due to its dynamic nature, which may undergo future changes.
|
|||
object | no | read close | |
key | string | no | read close |
close
DescriptionName of the key or property
|
|||
value | string | no | read close |
close
DescriptionValue of the key or property
|
|||
statusCategory | enum | no | read close |
close
DescriptionHighlevel status of the payment, payout or refund with the following possible values:
Please see Statuses for a full overview of possible values. |
|||
statusCode | integer | no | read close |
close
DescriptionNumeric status code of the legacy API. It is returned to ease the migration from the legacy APIs to Worldline Connect. You should not write new business logic based on this property as it will be deprecated in a future version of the API. The value can also be found in the GlobalCollect Payment Console, in the Ogone BackOffice and in report files.
|
|||
statusCodeChangeDateTime | string | no | read close |
close
DescriptionDate and time of payment
Format: YYYYMMDDHH24MISS |
Response example
This scenario you will probably use the most
-
{ "errorId" : "15eabcd5-30b3-479b-ae03-67bb351c07e6-00000092", "errors" : [ { "code" : "20000000", "propertyName" : "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" } } }