Pricing Templates
Log in Sign up
Integrations / Adyen Payout / ...

POST /storeDetail

This endpoint is deprecated and no longer supports new integrations. Do one of the following:

With the Transfers API, you can:

For more information about the payout features of the Transfers API, see our Payouts documentation.

Stores payment details under the PAYOUT recurring contract. These payment details can be used later to submit a payout via the /submitThirdParty call.

Servers

Request headers

Name Type Required Description
Content-Type String Yes The media type of the request body.

Default value: "application/json"

Request body fields

Name Type Required Description
shopperReference String Yes

The shopper's reference for the payment transaction.
shopperName Object No

The shopper's name.

When the entityType is Company, the shopperName.lastName must contain the company name.
shopperName.lastName String Yes

The last name.
shopperName.firstName String Yes

The first name.
entityType String Yes

The type of the entity the payout is processed for.

Possible values:

  • "Company"
  • "NaturalPerson"
recurring Object Yes

A container for the type of recurring contract to be retrieved.

The recurring.contract must be set to PAYOUT
recurring.contract String No

The type of recurring contract to be used. Possible values:

  • ONECLICK – Payment details can be used to initiate a one-click payment, where the shopper enters the card security code (CVC/CVV).
  • RECURRING – Payment details can be used without the card security code to initiate card-not-present transactions.
  • ONECLICK,RECURRING – Payment details can be used regardless of whether the shopper is on your site or not.
  • PAYOUT – Payment details can be used to make a payout.

Possible values:

  • "ONECLICK"
  • "PAYOUT"
  • "RECURRING"
recurring.recurringExpiry String No

Date after which no further authorisations shall be performed. Only for 3D Secure 2.
recurring.recurringFrequency String No

Minimum number of days between authorisations. Only for 3D Secure 2.
recurring.tokenService String No

The name of the token service.

Possible values:

  • "MCTOKENSERVICE"
  • "AMEXTOKENSERVICE"
  • "VISATOKENSERVICE"
  • "TOKEN_SHARING"
recurring.recurringDetailName String No

A descriptive name for this detail.
card Object No

A container for card data.

This field is mandatory if bank is not provided.
card.issueNumber String No

The issue number of the card (for some UK debit cards only).
card.startYear String No

The year component of the start date (for some UK debit cards only).
card.cvc String No

The card verification code (1-20 characters). Depending on the card brand, it is known also as:

  • CVV2/CVC2 – length: 3 digits
  • CID – length: 4 digits

If you are using Client-Side Encryption, the CVC code is present in the encrypted data. You must never post the card details to the server. This field must be always present in a one-click payment request. When this value is returned in a response, it is always empty because it is not stored.
card.number String No

The card number (4-19 characters). Do not use any separators. When this value is returned in a response, only the last 4 digits of the card number are returned.
card.expiryMonth String No

The card expiry month. Format: 2 digits, zero-padded for single digits. For example:

  • 03 = March
  • 11 = November
card.startMonth String No

The month component of the start date (for some UK debit cards only).
card.holderName String No

The name of the cardholder, as printed on the card.
card.expiryYear String No

The card expiry year. Format: 4 digits. For example: 2020
merchantAccount String Yes

The merchant account identifier, with which you want to process the transaction.
additionalData Object No

This field contains additional data, which may be required for a particular request.
billingAddress Object No

The billing address.

The billingAddress object is required for cross-border payouts to and from Canada. Include all of the fields within this object.
billingAddress.postalCode String Yes

A maximum of five digits for an address in the US, or a maximum of ten characters for an address in all other countries.
billingAddress.stateOrProvince String No

The two-character ISO 3166-2 state or province code. For example, CA in the US or ON in Canada.

Required for the US and Canada.
billingAddress.country String Yes

The two-character ISO-3166-1 alpha-2 country code. For example, US.

If you don't know the country or are not collecting the country from the shopper, provide country as ZZ.
billingAddress.houseNumberOrName String Yes

The number or name of the house. Maximum length: 3000 characters.
billingAddress.street String Yes

The name of the street. Maximum length: 3000 characters.

The house number should not be included in this field; it should be separately provided via houseNumberOrName.
billingAddress.city String Yes

The name of the city. Maximum length: 3000 characters.
telephoneNumber String No

The shopper's phone number.
shopperEmail String Yes

The shopper's email address.
selectedBrand String No

The name of the brand to make a payout to.

For Paysafecard it must be set to paysafecard.
nationality String Yes

The shopper's nationality.

A valid value is an ISO 2-character country code (e.g. 'NL').
fraudOffset Integer No

An integer value that is added to the normal fraud score. The value can be either positive or negative.
socialSecurityNumber String No

The shopper's social security number.
bank Object No

A container for bank account data.

This field is mandatory if card is not provided.
bank.bic String No

The Business Identifier Code (BIC) is the SWIFT address assigned to a bank. The field value is nil in most cases.
bank.bankLocationId String No

The location id of the bank. The field value is nil in most cases.
bank.bankName String No

The name of the bank.
bank.bankCity String No

The bank city.
bank.ownerName String No

The name of the bank account holder. If you submit a name with non-Latin characters, we automatically replace some of them with corresponding Latin characters to meet the FATF recommendations. For example:

  • χ12 is converted to ch12.
  • üA is converted to euA.
  • Peter Møller is converted to Peter Mller, because banks don't accept 'ø'. After replacement, the ownerName must have at least three alphanumeric characters (A-Z, a-z, 0-9), and at least one of them must be a valid Latin character (A-Z, a-z). For example:
  • John17 - allowed.
  • J17 - allowed.
  • 171 - not allowed.
  • John-7 - allowed.

If provided details don't match the required format, the response returns the error message: 203 'Invalid bank account holder name'.
bank.iban String No

The International Bank Account Number (IBAN).
bank.taxId String No

The bank account holder's tax ID.
bank.countryCode String No

Country code where the bank is located.

A valid value is an ISO two-character country code (e.g. 'NL').
bank.bankAccountNumber String No

The bank account number (without separators).
dateOfBirth String Yes

The date of birth. Format: ISO-8601; example: YYYY-MM-DD For Paysafecard it must be the same as used when registering the Paysafecard account.

This field is mandatory for natural persons.

How to start integrating

  1. Add HTTP Task to your workflow definition.
  2. Search for the API you want to integrate with and click on the name.
    • This loads the API reference documentation and prepares the Http request settings.
  3. Click Test request to test run your request to the API and see the API's response.
All third party trademarks (including logos and icons) are the property of their respective owners, which do not sponsor, authorize, or endorse this website.
Pricing Templates Integrations Blog Contact Us Help
© 2024 SimWorkflow
Terms of Service Privacy Policy