This site requires javascript to be enabled.

Results for

xxx

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

Properties
Property Type Required Details
close
Deprecated

Description

Amount in cents and always having 2 decimals
close
Deprecated

Description

Three-letter ISO currency code representing the currency for the amount
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.

close
Deprecated

Description

Name of the account holder
close
Deprecated

Description

Bank account number
close
Deprecated

Description

Bank code
close
Deprecated

Description

Name of the bank
close
Deprecated

Description

Branch code
close
Deprecated

Description

Bank check digit
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.
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.

close
Deprecated

Description

Name in which the account is held.
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.
close

Description

Object containing the specific input details for bank transfer payouts.
  • 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.

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.

close

Description

Name of the account holder
close

Description

Bank account number
close

Description

Bank code
close

Description

Name of the bank
close

Description

Branch code
close

Description

Bank check digit
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.
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.

close

Description

Name in which the account is held.
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.
close
Deprecated: Use payoutDetails.customer instead

Description

Object containing the details of the customer.
  • SDK Object type
    PayoutCustomer
close
Deprecated

Description

Object containing address details
  • SDK Object type
    Address
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
close
Deprecated

Description

City
Note: For payments with product 1503 the maximum length is not 40 but 20.
close
Deprecated

Description

ISO 3166-1 alpha-2 country code
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
close
Deprecated

Description

Full name of the state or province
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
close
Deprecated

Description

Streetname
close
Deprecated

Description

Zip code
Note: For payments with product 1503 the maximum length is not 10 but 8.
close
Deprecated

Description

Object containing company information
  • SDK Object type
    CompanyInformation
close
Deprecated

Description

Name of company, as a customer
close
Deprecated

Description

Local VAT number of the company
close
Deprecated

Description

Object containing contact details like email address and phone number
  • SDK Object type
    ContactDetailsBase
close
Deprecated

Description

Email address of the customer
close
Deprecated

Description

Preference for the type of email message markup
  • plain-text
  • html
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.
close
Deprecated

Description

Object containing PersonalName object
  • SDK Object type
    PersonalName
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.
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.
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.
close
Deprecated

Description

Title of customer
close

Description

Date of the payout sent to the bank by us.
Format: YYYYMMDD
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.
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.
close

Description

Object containing the specific input details for card payouts.
  • 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.

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.

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
close

Description

The card holder's name on the card. The '+' character is not allowed in this property for transactions that are processed by TechProcess Payment Platform.
close

Description

Card Verification Value, a 3 or 4 digit code used as an additional security feature for card not present transactions.
close

Description

Expiry date of the card
Format: MMYY
close

Description

Issue number on the card (if applicable)
close

Description

The 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.
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.

close

Description

Payment product identifier
Please see payment products for a full overview of possible values.
close

Description

Object containing the details of the recipient of the payout
  • SDK Object type
    PayoutRecipient
close

Description

Given name(s) or first name(s) of the customer
close

Description

Surname(s) or last name(s) of the customer
close

Description

Middle name - In between first name and surname - of the customer
close
Deprecated: Use payoutDetails.customer instead

Description

Object containing the details of the customer.
  • SDK Object type
    PayoutCustomer
close
Deprecated

Description

Object containing address details
  • SDK Object type
    Address
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
close
Deprecated

Description

City
Note: For payments with product 1503 the maximum length is not 40 but 20.
close
Deprecated

Description

ISO 3166-1 alpha-2 country code
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
close
Deprecated

Description

Full name of the state or province
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
close
Deprecated

Description

Streetname
close
Deprecated

Description

Zip code
Note: For payments with product 1503 the maximum length is not 10 but 8.
close
Deprecated

Description

Object containing company information
  • SDK Object type
    CompanyInformation
close
Deprecated

Description

Name of company, as a customer
close
Deprecated

Description

Local VAT number of the company
close
Deprecated

Description

Object containing contact details like email address and phone number
  • SDK Object type
    ContactDetailsBase
close
Deprecated

Description

Email address of the customer
close
Deprecated

Description

Preference for the type of email message markup
  • plain-text
  • html
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.
close
Deprecated

Description

Object containing PersonalName object
  • SDK Object type
    PersonalName
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.
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.
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.
close
Deprecated

Description

Title of customer
close

Description

Object containing information on you, the merchant
  • SDK Object type
    PayoutMerchant
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.
close
Deprecated: Use bankTransferPayoutMethodSpecificInput.payoutDate instead

Description

Date of the payout sent to the bank by us
Format: YYYYMMDD
close

Description

Object containing the details for Create Payout Request
  • SDK Object type
    PayoutDetails
close

Description

Object containing amount and ISO currency code attributes
  • SDK Object type
    AmountOfMoney
close

Description

Amount in cents and always having 2 decimals
close

Description

Three-letter ISO currency code representing the currency for the amount
close

Description

Object containing the details of the customer.
  • SDK Object type
    PayoutCustomer
close

Description

Object containing address details
  • SDK Object type
    Address
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
close

Description

City
Note: For payments with product 1503 the maximum length is not 40 but 20.
close

Description

ISO 3166-1 alpha-2 country code
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
close

Description

Full name of the state or province
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
close

Description

Streetname
close

Description

Zip code
Note: For payments with product 1503 the maximum length is not 10 but 8.
close

Description

Object containing company information
  • SDK Object type
    CompanyInformation
close

Description

Name of company, as a customer
close

Description

Local VAT number of the company
close

Description

Object containing contact details like email address and phone number
  • SDK Object type
    ContactDetailsBase
close

Description

Email address of the customer
close

Description

Preference for the type of email message markup
  • plain-text
  • html
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.
close

Description

Object containing PersonalName object
  • SDK Object type
    PersonalName
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.
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.
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.
close

Description

Title of customer
close

Description

Object that holds all reference properties that are linked to this transaction
  • SDK Object type
    PayoutReferences
close

Description

Your invoice number (on printed invoice) that is also returned in our report files
close

Description

Order Identifier generated by the merchant
Note: This does not need to have a unique value for each transaction
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.
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.
close
Deprecated

Description

Your invoice number (on printed invoice) that is also returned in our report files
close
Deprecated

Description

Order Identifier generated by the merchant
Note: This does not need to have a unique value for each transaction
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.
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: .NET

This scenario you will probably use the most

  • var bankAccountIban = new BankAccountIban();
    bankAccountIban.AccountHolderName = "Wile E. Coyote";
    bankAccountIban.Iban = "IT60X0542811101000000123456";
    
    var bankTransferPayoutMethodSpecificInput = new BankTransferPayoutMethodSpecificInput();
    bankTransferPayoutMethodSpecificInput.BankAccountIban = bankAccountIban;
    bankTransferPayoutMethodSpecificInput.PayoutDate = "20150102";
    bankTransferPayoutMethodSpecificInput.PayoutText = "Payout Acme";
    bankTransferPayoutMethodSpecificInput.SwiftCode = "swift";
    
    var amountOfMoney = new AmountOfMoney();
    amountOfMoney.Amount = 2345L;
    amountOfMoney.CurrencyCode = "EUR";
    
    var address = new Address();
    address.City = "Burbank";
    address.CountryCode = "US";
    address.HouseNumber = "411";
    address.State = "California";
    address.Street = "N Hollywood Way";
    address.Zip = "91505";
    
    var companyInformation = new CompanyInformation();
    companyInformation.Name = "Acme Labs";
    
    var contactDetails = new ContactDetailsBase();
    contactDetails.EmailAddress = "wile.e.coyote@acmelabs.com";
    
    var name = new PersonalName();
    name.FirstName = "Wile";
    name.Surname = "Coyote";
    name.SurnamePrefix = "E.";
    name.Title = "Mr.";
    
    var customer = new PayoutCustomer();
    customer.Address = address;
    customer.CompanyInformation = companyInformation;
    customer.ContactDetails = contactDetails;
    customer.Name = name;
    
    var references = new PayoutReferences();
    references.MerchantReference = "AcmeOrder001";
    
    var payoutDetails = new PayoutDetails();
    payoutDetails.AmountOfMoney = amountOfMoney;
    payoutDetails.Customer = customer;
    payoutDetails.References = references;
    
    var body = new CreatePayoutRequest();
    body.BankTransferPayoutMethodSpecificInput = bankTransferPayoutMethodSpecificInput;
    body.PayoutDetails = payoutDetails;
    
    try
    {
        var response = await client.V1.WithNewMerchant("merchantId").Payouts.Create(body);
    }
    catch (DeclinedPayoutException e)
    {
        HandleDeclinedPayout(e.PayoutResult);
    }
    catch (ApiException e)
    {
        HandleErrorResponse(e.ErrorId, e.Errors);
    }
    
  • var bankAccountIban = new BankAccountIban();
    bankAccountIban.AccountHolderName = "Wile E. Coyote";
    bankAccountIban.Iban = "***************************";
    
    var bankTransferPayoutMethodSpecificInput = new BankTransferPayoutMethodSpecificInput();
    bankTransferPayoutMethodSpecificInput.BankAccountIban = bankAccountIban;
    bankTransferPayoutMethodSpecificInput.PayoutText = "Payout Acme";
    
    var amountOfMoney = new AmountOfMoney();
    amountOfMoney.Amount = 2345L;
    amountOfMoney.CurrencyCode = "EUR";
    
    var address = new Address();
    address.City = "Burbank";
    address.CountryCode = "US";
    address.Street = "N Hollywood Way";
    
    var name = new PersonalName();
    name.Surname = "Coyote";
    
    var customer = new PayoutCustomer();
    customer.Address = address;
    customer.Name = name;
    
    var references = new PayoutReferences();
    references.MerchantReference = "AcmeOrder001";
    
    var payoutDetails = new PayoutDetails();
    payoutDetails.AmountOfMoney = amountOfMoney;
    payoutDetails.Customer = customer;
    payoutDetails.References = references;
    
    var body = new CreatePayoutRequest();
    body.BankTransferPayoutMethodSpecificInput = bankTransferPayoutMethodSpecificInput;
    body.PayoutDetails = payoutDetails;
    
    try
    {
        var response = await client.V1.WithNewMerchant("merchantId").Payouts.Create(body);
    }
    catch (DeclinedPayoutException e)
    {
        HandleDeclinedPayout(e.PayoutResult);
    }
    catch (ApiException e)
    {
        HandleErrorResponse(e.ErrorId, e.Errors);
    }
    

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
close

Description

Our unique payout transaction identifier.
close

Description

Object containing payout details
  • SDK Object type
    OrderOutput
close

Description

Object containing amount and ISO currency code attributes
  • SDK Object type
    AmountOfMoney
close

Description

Amount in cents and always having 2 decimals
close

Description

Three-letter ISO currency code representing the currency for the amount
close

Description

Object that holds all reference properties that are linked to this transaction
  • SDK Object type
    PaymentReferences
close

Description

Your order ID for this transaction that is also returned in our report files
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.
close

Description

Payment Reference generated by WebCollect
close

Description

Provides an additional means of reconciliation for Gateway merchants
close

Description

Provides an additional means of reconciliation, this is the MerchantId used at the provider
close

Description

Provides an additional means of reconciliation for Gateway merchants
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
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.
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
close

Description

Custom object contains the set of errors
close

Description

Contains detailed information on one single error.
  • SDK Object type
    APIError
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.
close

Description

Error code
close

Description

HTTP status code for this error that can be used to determine the type of error
close

Description

ID of the error. This is a short human-readable message that briefly describes the error.
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
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'.
close

Description

ID of the request that can be used for debugging purposes
close

Description

Flag indicating if the payment can be cancelled
  • true
  • false
close

Description

Flag indicating whether a rejected payment may be retried by the merchant without incurring a fee
  • true
  • false
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.
close
  • SDK Object type
    KeyValuePair
close

Description

Name of the key or property
close

Description

Value of the key or property
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.
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.
close

Description

Date and time of payment
Format: YYYYMMDDHH24MISS

Response example

SDK: .NET

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
close

Description

Unique reference, for debugging purposes, of this error response
close

Description

List of one or more errors
close

Description

Contains detailed information on one single error.
  • SDK Object type
    APIError
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.
close

Description

Error code
close

Description

HTTP status code for this error that can be used to determine the type of error
close

Description

ID of the error. This is a short human-readable message that briefly describes the error.
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
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'.
close

Description

ID of the request that can be used for debugging purposes
close

Description

Object that contains details on the created payout in case one has been created
  • SDK Object type
    PayoutResult
close

Description

Our unique payout transaction identifier
close

Description

Object containing payout details
  • SDK Object type
    OrderOutput
close

Description

Object containing amount and ISO currency code attributes
  • SDK Object type
    AmountOfMoney
close

Description

Amount in cents and always having 2 decimals
close

Description

Three-letter ISO currency code representing the currency for the amount
close

Description

Object that holds all reference properties that are linked to this transaction
  • SDK Object type
    PaymentReferences
close

Description

Your order ID for this transaction that is also returned in our report files
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.
close

Description

Payment Reference generated by WebCollect
close

Description

Provides an additional means of reconciliation for Gateway merchants
close

Description

Provides an additional means of reconciliation, this is the MerchantId used at the provider
close

Description

Provides an additional means of reconciliation for Gateway merchants
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
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.
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
close

Description

Custom object contains the set of errors
close

Description

Contains detailed information on one single error.
  • SDK Object type
    APIError
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.
close

Description

Error code
close

Description

HTTP status code for this error that can be used to determine the type of error
close

Description

ID of the error. This is a short human-readable message that briefly describes the error.
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
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'.
close

Description

ID of the request that can be used for debugging purposes
close

Description

Flag indicating if the payment can be cancelled
  • true
  • false
close

Description

Flag indicating whether a rejected payment may be retried by the merchant without incurring a fee
  • true
  • false
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.
close
  • SDK Object type
    KeyValuePair
close

Description

Name of the key or property
close

Description

Value of the key or property
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.
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.
close

Description

Date and time of payment
Format: YYYYMMDDHH24MISS

Response example

SDK: .NET

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