openapi-directory/api/adyen.com/PayoutService.json

Building & bundling https://github.com/APIs-guru/openapi-directory for easy use from JS

{"openapi":"3.1.0","servers":[{"url":"https://pal-test.adyen.com/pal/servlet/Payout/v68"}],"info":{"contact":{"name":"Adyen Developer Experience team","url":"https://github.com/Adyen/adyen-openapi","x-twitter":"Adyen"},"description":"A set of API endpoints that allow you to store payout details, confirm, or decline a payout.\n\nFor more information, refer to [Online payouts](https://docs.adyen.com/online-payments/online-payouts).\n## Authentication\nTo use the Payout API, you need to have [two API credentials](https://docs.adyen.com/online-payments/online-payouts#payouts-to-bank-accounts-and-wallets): one for storing payout details and submitting payouts, and another one for confirming or declining payouts. If you don't have the required API credentials, contact our [Support Team](https://www.adyen.help/hc/en-us/requests/new).\n\nIf using an API key, add an `X-API-Key` header with the API key as the value, for example:\n\n ```\ncurl\n-H \"Content-Type: application/json\" \\\n-H \"X-API-Key: YOUR_API_KEY\" \\\n...\n```\n\nAlternatively, you can use the username and password to connect to the API using [basic authentication](https://docs.adyen.com/development-resources/api-credentials#basic-authentication).\n\nThe following example shows how to authenticate your request with basic authentication when submitting a payout:\n\n```\ncurl\n-U \"storePayout@Company.YOUR_COMPANY_ACCOUNT\":\"YOUR_BASIC_AUTHENTICATION_PASSWORD\" \\\n-H \"Content-Type: application/json\" \\\n...\n```\n\n## Versioning\nPayments API supports [versioning](https://docs.adyen.com/development-resources/versioning) using a version suffix in the endpoint URL. This suffix has the following format: \"vXX\", where XX is the version number.\n\nFor example:\n```\nhttps://pal-test.adyen.com/pal/servlet/Payout/v68/payout\n```\n\n## Going live\n\nTo authenticate to the live endpoints, you need [API credentials](https://docs.adyen.com/development-resources/api-credentials) from your live Customer Area.\n\nThe live endpoint URLs contain a prefix which is unique to your company account:\n```\n\nhttps://{PREFIX}-pal-live.adyenpayments.com/pal/servlet/Payout/v68/payout\n```\n\nGet your `{PREFIX}` from your live Customer Area under **Developers** > **API URLs** > **Prefix**.","termsOfService":"https://www.adyen.com/legal/terms-and-conditions","title":"Adyen Payout API","version":"68","x-apisguru-categories":["payment"],"x-logo":{"url":"https://twitter.com/Adyen/profile_image?size=original"},"x-origin":[{"format":"openapi","url":"https://raw.githubusercontent.com/Adyen/adyen-openapi/main/json/PayoutService-v68.json","version":"3.1"}],"x-preferred":true,"x-providerName":"adyen.com","x-publicVersion":true,"x-serviceName":"PayoutService"},"tags":[{"name":"Initialization"},{"name":"Reviewing"},{"name":"Instant payouts"}],"paths":{"/confirmThirdParty":{"post":{"description":"Confirms a previously submitted payout.\n\nTo cancel a payout, use the `/declineThirdParty` endpoint.","operationId":"post-confirmThirdParty","requestBody":{"content":{"application/json":{"examples":{"confirmThirdParty":{"$ref":"#/components/examples/post-confirmThirdParty-confirmThirdParty"}},"schema":{"$ref":"#/components/schemas/ModifyRequest"}}}},"responses":{"200":{"content":{"application/json":{"examples":{"confirmThirdParty":{"$ref":"#/components/examples/post-confirmThirdParty-confirmThirdParty-200"}},"schema":{"$ref":"#/components/schemas/ModifyResponse"}}},"description":"OK - the request has succeeded."},"400":{"content":{"application/json":{"examples":{"generic":{"$ref":"#/components/examples/generic-400"}},"schema":{"$ref":"#/components/schemas/ServiceError"}}},"description":"Bad Request - a problem reading or understanding the request."},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceError"}}},"description":"Unauthorized - authentication required."},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceError"}}},"description":"Forbidden - insufficient permissions to process the request."},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceError"}}},"description":"Unprocessable Entity - a request validation error."},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceError"}}},"description":"Internal Server Error - the server could not process the request."}},"security":[{"BasicAuth":[]},{"ApiKeyAuth":[]}],"summary":"Confirm a payout","tags":["Reviewing"],"x-addedInVersion":"10","x-methodName":"confirmThirdParty","x-sortIndex":1}},"/declineThirdParty":{"post":{"description":"Cancels a previously submitted payout.\n\nTo confirm and send a payout, use the `/confirmThirdParty` endpoint.","operationId":"post-declineThirdParty","requestBody":{"content":{"application/json":{"examples":{"declineThirdParty":{"$ref":"#/components/examples/post-declineThirdParty-declineThirdParty"}},"schema":{"$ref":"#/components/schemas/ModifyRequest"}}}},"responses":{"200":{"content":{"application/json":{"examples":{"declineThirdParty":{"$ref":"#/components/examples/post-declineThirdParty-declineThirdParty-200"}},"schema":{"$ref":"#/components/schemas/ModifyResponse"}}},"description":"OK - the request has succeeded."},"400":{"content":{"application/json":{"examples":{"generic":{"$ref":"#/components/examples/generic-400"}},"schema":{"$ref":"#/components/schemas/ServiceError"}}},"description":"Bad Request - a problem reading or understanding the request."},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceError"}}},"description":"Unauthorized - authentication required."},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceError"}}},"description":"Forbidden - insufficient permissions to process the request."},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceError"}}},"description":"Unprocessable Entity - a request validation error."},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceError"}}},"description":"Internal Server Error - the server could not process the request."}},"security":[{"BasicAuth":[]},{"ApiKeyAuth":[]}],"summary":"Cancel a payout","tags":["Reviewing"],"x-addedInVersion":"10","x-methodName":"declineThirdParty","x-sortIndex":2}},"/payout":{"post":{"description":"With this call, you can pay out to your customers, and funds will be made available within 30 minutes on the cardholder's bank account (this is dependent on whether the issuer supports this functionality). Instant card payouts are only supported for Visa and Mastercard cards.","operationId":"post-payout","requestBody":{"content":{"application/json":{"examples":{"payout-b2c":{"$ref":"#/components/examples/post-payout-payout-b2c"},"payout-p2p":{"$ref":"#/components/examples/post-payout-payout-p2p"}},"schema":{"$ref":"#/components/schemas/PayoutRequest"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PayoutResponse"}}},"description":"OK - the request has succeeded."},"400":{"content":{"application/json":{"examples":{"generic":{"$ref":"#/components/examples/generic-400"}},"schema":{"$ref":"#/components/schemas/ServiceError"}}},"description":"Bad Request - a problem reading or understanding the request."},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceError"}}},"description":"Unauthorized - authentication required."},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceError"}}},"description":"Forbidden - insufficient permissions to process the request."},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceError"}}},"description":"Unprocessable Entity - a request validation error."},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceError"}}},"description":"Internal Server Error - the server could not process the request."}},"security":[{"BasicAuth":[]},{"ApiKeyAuth":[]}],"summary":"Make an instant card payout","tags":["Instant payouts"],"x-addedInVersion":"11","x-methodName":"payout","x-sortIndex":1}},"/storeDetail":{"post":{"description":"Stores payment details under the `PAYOUT` recurring contract. These payment details can be used later to submit a payout via the `/submitThirdParty` call.","operationId":"post-storeDetail","requestBody":{"content":{"application/json":{"examples":{"storeDetail":{"$ref":"#/components/examples/post-storeDetail-storeDetail"}},"schema":{"$ref":"#/components/schemas/StoreDetailRequest"}}}},"responses":{"200":{"content":{"application/json":{"examples":{"storeDetail":{"$ref":"#/components/examples/post-storeDetail-storeDetail-200"}},"schema":{"$ref":"#/components/schemas/StoreDetailResponse"}}},"description":"OK - the request has succeeded."},"400":{"content":{"application/json":{"examples":{"generic":{"$ref":"#/components/examples/generic-400"}},"schema":{"$ref":"#/components/schemas/ServiceError"}}},"description":"Bad Request - a problem reading or understanding the request."},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceError"}}},"description":"Unauthorized - authentication required."},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceError"}}},"description":"Forbidden - insufficient permissions to process the request."},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceError"}}},"description":"Unprocessable Entity - a request validation error."},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceError"}}},"description":"Internal Server Error - the server could not process the request."}},"security":[{"BasicAuth":[]},{"ApiKeyAuth":[]}],"summary":"Store payout details","tags":["Initialization"],"x-methodName":"storeDetail","x-sortIndex":2}},"/storeDetailAndSubmitThirdParty":{"post":{"description":"Submits a payout and stores its details for subsequent payouts.\n\nThe submitted payout must be confirmed or declined either by a reviewer or via `/confirmThirdParty` or `/declineThirdParty` calls.","operationId":"post-storeDetailAndSubmitThirdParty","requestBody":{"content":{"application/json":{"examples":{"storeDetailAndSubmitThirdParty":{"$ref":"#/components/examples/post-storeDetailAndSubmitThirdParty-storeDetailAndSubmitThirdParty"},"storeDetailAndSubmitThirdParty-Neteller":{"$ref":"#/components/examples/post-storeDetailAndSubmitThirdParty-storeDetailAndSubmitThirdParty-Neteller"},"storeDetailAndSubmitThirdParty-PayPal":{"$ref":"#/components/examples/post-storeDetailAndSubmitThirdParty-storeDetailAndSubmitThirdParty-PayPal"},"storeDetailAndSubmitThirdParty-Paysafecard":{"$ref":"#/components/examples/post-storeDetailAndSubmitThirdParty-storeDetailAndSubmitThirdParty-Paysafecard"},"storeDetailAndSubmitThirdParty-Skrill":{"$ref":"#/components/examples/post-storeDetailAndSubmitThirdParty-storeDetailAndSubmitThirdParty-Skrill"}},"schema":{"$ref":"#/components/schemas/StoreDetailAndSubmitRequest"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StoreDetailAndSubmitResponse"}}},"description":"OK - the request has succeeded."},"400":{"content":{"application/json":{"examples":{"generic":{"$ref":"#/components/examples/generic-400"}},"schema":{"$ref":"#/components/schemas/ServiceError"}}},"description":"Bad Request - a problem reading or understanding the request."},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceError"}}},"description":"Unauthorized - authentication required."},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceError"}}},"description":"Forbidden - insufficient permissions to process the request."},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceError"}}},"description":"Unprocessable Entity - a request validation error."},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceError"}}},"description":"Internal Server Error - the server could not process the request."}},"security":[{"BasicAuth":[]},{"ApiKeyAuth":[]}],"summary":"Store details and submit a payout","tags":["Initialization"],"x-addedInVersion":"10","x-methodName":"storeDetailAndSubmitThirdParty","x-sortIndex":1}},"/submitThirdParty":{"post":{"description":"Submits a payout using the previously stored payment details. To store payment details, use the `/storeDetail` API call.\n\nThe submitted payout must be confirmed or declined either by a reviewer or via `/confirmThirdParty` or `/declineThirdParty` calls.","operationId":"post-submitThirdParty","requestBody":{"content":{"application/json":{"examples":{"submitThirdParty":{"$ref":"#/components/examples/post-submitThirdParty-submitThirdParty"}},"schema":{"$ref":"#/components/schemas/SubmitRequest"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SubmitResponse"}}},"description":"OK - the request has succeeded."},"400":{"content":{"application/json":{"examples":{"generic":{"$ref":"#/components/examples/generic-400"}},"schema":{"$ref":"#/components/schemas/ServiceError"}}},"description":"Bad Request - a problem reading or understanding the request."},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceError"}}},"description":"Unauthorized - authentication required."},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceError"}}},"description":"Forbidden - insufficient permissions to process the request."},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceError"}}},"description":"Unprocessable Entity - a request validation error."},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceError"}}},"description":"Internal Server Error - the server could not process the request."}},"security":[{"BasicAuth":[]},{"ApiKeyAuth":[]}],"summary":"Submit a payout","tags":["Initialization"],"x-addedInVersion":"10","x-methodName":"submitThirdParty","x-sortIndex":3}}},"components":{"examples":{"generic-400":{"summary":"Response code 400. Bad Request.","value":{"errorCode":"702","errorType":"validation","message":"Unexpected input: I","status":400}},"post-confirmThirdParty-confirmThirdParty":{"description":"Confirm a previously submitted payout","summary":"Confirm a payout","value":{"merchantAccount":"YOUR_MERCHANT_ACCOUNT","originalReference":"9913140798220028"}},"post-confirmThirdParty-confirmThirdParty-200":{"summary":"Example response for request 'confirmThirdParty'","value":{"pspReference":"991617894325358C","response":"[payout-confirm-received]"}},"post-declineThirdParty-declineThirdParty":{"description":"Cancel a previously submitted payout","summary":"Cancel a payout","value":{"merchantAccount":"YOUR_MERCHANT_ACCOUNT","originalReference":"9913140798220028"}},"post-declineThirdParty-declineThirdParty-200":{"summary":"Example response for request 'declineThirdParty'","value":{"pspReference":"991617894325360J","response":"[payout-decline-received]"}},"post-payout-payout-b2c":{"description":"Pay out to your sellers, customers, freelancers, etc","summary":"Instant card payout (B2C)","value":{"amount":{"currency":"USD","value":2500},"billingAddress":{"city":"Beverly Hills","country":"US","houseNumberOrName":"121","postalCode":"90210","stateOrProvince":"CA","street":"Brannan Street"},"card":{"expiryMonth":"03","expiryYear":"2030","holderName":"John Smith","number":"4111111111111111"},"merchantAccount":"YOUR_MERCHANT_ACCOUNT","nationality":"NL","reference":"P9999999999999999","shopperName":{"firstName":"John","lastName":"Smith"}}},"post-payout-payout-p2p":{"description":"Facilitate the transfer of money between two individuals","summary":"Instant card payout (P2P)","value":{"amount":{"currency":"USD","value":2500},"billingAddress":{"city":"Beverly Hills","country":"US","houseNumberOrName":"121","postalCode":"90210","stateOrProvince":"CA","street":"Brannan Street"},"card":{"expiryMonth":"03","expiryYear":"2030","holderName":"John Smith","number":"4111111111111111"},"dateOfBirth":"2025-04-15T13:51:00.138Z","fundSource":{"additionalData":{"fundingSource":"DEBIT"},"billingAddress":{"city":"Beverly Hills","country":"US","houseNumberOrName":"121","postalCode":"90210","stateOrProvince":"CA","street":"Brannan Street"},"card":{"expiryMonth":"03","expiryYear":"2030","holderName":"Payer Name","number":"4400000000000008"},"shopperName":{"firstName":"Payer","lastName":"Name"}},"merchantAccount":"YOUR_MERCHANT_ACCOUNT","nationality":"NL","reference":"P9999999999999999","shopperName":{"firstName":"John","lastName":"Smith"}}},"post-storeDetail-storeDetail":{"description":"Store payment details under the PAYOUT recurring contract","summary":"Store payout details","value":{"bank":{"bankCity":"Amsterdam","bankName":"AbnAmro","bic":"ABNANL2A","countryCode":"NL","iban":"NL32ABNA0515071439","ownerName":"Adyen","taxId":"bankTaxId"},"billingAddress":{"city":"Amsterdam","country":"US","houseNumberOrName":"17","postalCode":"12345","stateOrProvince":"NY","street":"Teststreet 1"},"dateOfBirth":"2025-04-15T13:51:00.138Z","entityType":"Company","merchantAccount":"YOUR_MERCHANT_ACCOUNT","nationality":"NL","recurring":{"contract":"PAYOUT"},"shopperEmail":"shopper@email.com","shopperName":{"firstName":"Adyen","lastName":"Test"},"shopperReference":"YOUR_UNIQUE_SHOPPER_ID"}},"post-storeDetail-storeDetail-200":{"summary":"Example response for request 'storeDetail'","value":{"pspReference":"991617894326362D","recurringDetailReference":"9916178936754752","resultCode":"Success"}},"post-storeDetailAndSubmitThirdParty-storeDetailAndSubmitThirdParty":{"description":"Submit a payout and stores its details for subsequent payouts","summary":"Submit a payout and stores details","value":{"amount":{"currency":"EUR","value":2000},"bank":{"bankName":"Commerzbank","countryCode":"DE","iban":"DE87123456781234567890","ownerName":"Simon Hopper"},"dateOfBirth":"2025-04-15T13:51:00.138Z","entityType":"Company","merchantAccount":"YOUR_MERCHANT_ACCOUNT","nationality":"NL","recurring":{"contract":"PAYOUT"},"reference":"Your Reference","shopperEmail":"s.hopper@test.com","shopperName":{"firstName":"Adyen","lastName":"Test"},"shopperReference":"YOUR_SHOPPER_REFERENCE"}},"post-storeDetailAndSubmitThirdParty-storeDetailAndSubmitThirdParty-Neteller":{"description":"Submit a payout to Neteller and stores its details for subsequent payouts","summary":"Submit a payout to Neteller","value":{"additionalData":{"account":"myNetellerAccount","tokenDataType":"Neteller"},"amount":{"currency":"EUR","value":100},"dateOfBirth":"2025-04-15T13:51:00.138Z","entityType":"NaturalPerson","merchantAccount":"YOUR_MERCHANT_ACCOUNT","nationality":"NL","recurring":{"contract":"PAYOUT"},"reference":"Test Payout","selectedBrand":"neteller","shopperEmail":"test@company.com","shopperName":{"firstName":"Test","lastName":"Test2"},"shopperReference":"YOUR_SHOPPER_REFERENCE"}},"post-storeDetailAndSubmitThirdParty-storeDetailAndSubmitThirdParty-PayPal":{"description":"Submit a payout to PayPal and stores its details for subsequent payouts","summary":"Submit a payout to PayPal","value":{"additionalData":{"emailId":"EmailUsedForPayPalAccount@example.com","paypal.payerId":"AK5HCWWRUV2KL","tokenDataType":"PayPal"},"amount":{"currency":"EUR","value":1750},"dateOfBirth":"2025-04-15T13:51:00.138Z","entityType":"NaturalPerson","merchantAccount":"YOUR_MERCHANT_ACCOUNT","nationality":"NL","recurring":{"contract":"PAYOUT"},"reference":"Test Payout","selectedBrand":"paypal","shopperEmail":"test@company.com","shopperName":{"firstName":"Test","lastName":"Test2"},"shopperReference":"YOUR_UNIQUE_SHOPPER_ID"}},"post-storeDetailAndSubmitThirdParty-storeDetailAndSubmitThirdParty-Paysafecard":{"description":"Submit a payout to Paysafecard and stores its details for subsequent payouts","summary":"Submit a payout to Paysafecard","value":{"additionalData":{"emailId":"EmailUsedForPaysafecardAccount@example.com"},"amount":{"currency":"EUR","value":1000},"dateOfBirth":"2025-04-15T13:51:00.138Z","entityType":"NaturalPerson","merchantAccount":"YOUR_MERCHANT_ACCOUNT","nationality":"NL","recurring":{"contract":"PAYOUT"},"reference":"Test Payout","selectedBrand":"paysafecard","shopperEmail":"test@company.com","shopperName":{"firstName":"Test","lastName":"Test2"},"shopperReference":"YOUR_UNIQUE_SHOPPER_ID"}},"post-storeDetailAndSubmitThirdParty-storeDetailAndSubmitThirdParty-Skrill":{"description":"Submit a payout to Skrill and stores its details for subsequent payouts","summary":"Submit a payout to Skrill","value":{"additionalData":{"email":"name@adyen.com","tokenDataType":"MoneyBookers"},"amount":{"currency":"EUR","value":100},"dateOfBirth":"2025-04-15T13:51:00.138Z","entityType":"NaturalPerson","merchantAccount":"YOUR_MERCHANT_ACCOUNT","nationality":"NL","recurring":{"contract":"PAYOUT"},"reference":"Test Payout","selectedBrand":"moneybookers","shopperEmail":"test@company.com","shopperName":{"firstName":"Test","lastName":"Test2"},"shopperReference":"YOUR_UNIQUE_SHOPPER_ID"}},"post-submitThirdParty-submitThirdParty":{"description":"Submit a payout using the previously stored payment details","summary":"Submit a payout","value":{"amount":{"currency":"EUR","value":1000},"dateOfBirth":"2025-04-15T13:51:00.138Z","entityType":"Company","merchantAccount":"YOUR_MERCHANT_ACCOUNT","nationality":"NL","recurring":{"contract":"PAYOUT"},"reference":"PayoutPayment-0001","selectedRecurringDetailReference":"LATEST","shopperEmail":"shopper@email.com","shopperName":{"firstName":"Adyen","lastName":"Test"},"shopperReference":"YOUR_UNIQUE_SHOPPER_ID"}}},"schemas":{"Address":{"properties":{"city":{"description":"The name of the city. Maximum length: 3000 characters.","maxLength":3000,"type":"string"},"country":{"description":"The two-character ISO-3166-1 alpha-2 country code. For example, **US**.\n> If you don't know the country or are not collecting the country from the shopper, provide `country` as `ZZ`.","type":"string"},"houseNumberOrName":{"description":"The number or name of the house. Maximum length: 3000 characters.","maxLength":3000,"type":"string"},"postalCode":{"description":"A maximum of five digits for an address in the US, or a maximum of ten characters for an address in all other countries.","type":"string"},"stateOrProvince":{"description":"The two-character ISO 3166-2 state or province code. For example, **CA** in the US or **ON** in Canada.\n> Required for the US and Canada.","type":"string"},"street":{"description":"The name of the street. Maximum length: 3000 characters.\n> The house number should not be included in this field; it should be separately provided via `houseNumberOrName`.","maxLength":3000,"type":"string"}},"required":["street","houseNumberOrName","city","postalCode","country"],"type":"object"},"Amount":{"properties":{"currency":{"description":"The three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes).","maxLength":3,"minLength":3,"type":"string"},"value":{"description":"The amount of the transaction, in [minor units](https://docs.adyen.com/development-resources/currency-codes).","format":"int64","type":"integer"}},"required":["value","currency"],"type":"object"},"BankAccount":{"properties":{"bankAccountNumber":{"description":"The bank account number (without separators).","type":"string"},"bankCity":{"description":"The bank city.","type":"string","x-addedInVersion":"18"},"bankLocationId":{"description":"The location id of the bank. The field value is `nil` in most cases.","type":"string"},"bankName":{"description":"The name of the bank.","type":"string"},"bic":{"description":"The [Business Identifier Code](https://en.wikipedia.org/wiki/ISO_9362) (BIC) is the SWIFT address assigned to a bank. The field value is `nil` in most cases.","type":"string"},"countryCode":{"description":"Country code where the bank is located.\n\nA valid value is an ISO two-character country code (e.g. 'NL').","type":"string"},"iban":{"description":"The [International Bank Account Number](https://en.wikipedia.org/wiki/International_Bank_Account_Number) (IBAN).","type":"string"},"ownerName":{"description":"The name of the bank account holder.\nIf 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:\n* χ12 is converted to ch12.\n* üA is converted to euA.\n* Peter Møller is converted to Peter Mller, because banks don't accept 'ø'.\nAfter 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:\n* John17 - allowed.\n* J17 - allowed.\n* 171 - not allowed.\n* John-7 - allowed.\n> If provided details don't match the required format, the response returns the error message: 203 'Invalid bank account holder name'.","type":"string"},"taxId":{"description":"The bank account holder's tax ID.","type":"string","x-addedInVersion":"18"}},"type":"object"},"Card":{"properties":{"cvc":{"description":"The [card verification code](https://docs.adyen.com/payments-fundamentals/payment-glossary#card-security-code-cvc-cvv-cid) (1-20 characters). Depending on the card brand, it is known also as:\n* CVV2/CVC2 – length: 3 digits\n* CID – length: 4 digits\n> If you are using [Client-Side Encryption](https://docs.adyen.com/classic-integration/cse-integration-ecommerce), the CVC code is present in the encrypted data. You must never post the card details to the server.\n> This field must be always present in a [one-click payment request](https://docs.adyen.com/classic-integration/recurring-payments).\n> When this value is returned in a response, it is always empty because it is not stored.","maxLength":20,"minLength":1,"type":"string"},"expiryMonth":{"description":"The card expiry month.\nFormat: 2 digits, zero-padded for single digits. For example:\n* 03 = March\n* 11 = November","maxLength":2,"minLength":1,"type":"string"},"expiryYear":{"description":"The card expiry year.\nFormat: 4 digits. For example: 2020","maxLength":4,"minLength":4,"type":"string"},"holderName":{"description":"The name of the cardholder, as printed on the card.","maxLength":50,"minLength":1,"type":"string"},"issueNumber":{"description":"The issue number of the card (for some UK debit cards only).","maxLength":2,"minLength":1,"type":"string"},"number":{"description":"The card number (4-19 characters). Do not use any separators.\nWhen this value is returned in a response, only the last 4 digits of the card number are returned.","maxLength":19,"minLength":4,"type":"string"},"startMonth":{"description":"The month component of the start date (for some UK debit cards only).","maxLength":2,"minLength":1,"type":"string"},"startYear":{"description":"The year component of the start date (for some UK debit cards only).","maxLength":4,"minLength":4,"type":"string"}},"type":"object"},"FraudCheckResult":{"properties":{"accountScore":{"description":"The fraud score generated by the risk check.","format":"int32","type":"integer"},"checkId":{"description":"The ID of the risk check.","format":"int32","type":"integer"},"name":{"description":"The name of the risk check.","type":"string"}},"required":["checkId","name","accountScore"],"type":"object"},"FraudCheckResultWrapper":{"properties":{"FraudCheckResult":{"$ref":"#/components/schemas/FraudCheckResult"}}},"FraudResult":{"properties":{"accountScore":{"description":"The total fraud score generated by the risk checks.","format":"int32","type":"integer"},"results":{"description":"The result of the individual risk checks.","items":{"$ref":"#/components/schemas/FraudCheckResultWrapper"},"type":"array"}},"required":["accountScore"],"type":"object"},"FundSource":{"properties":{"additionalData":{"additionalProperties":{"type":"string"},"description":"A map of name-value pairs for passing additional or industry-specific data.","type":"object"},"billingAddress":{"$ref":"#/components/schemas/Address","description":"The address where to send the invoice."},"card":{"$ref":"#/components/schemas/Card","description":"Credit card data.\n\nOptional if `shopperReference` and `selectedRecurringDetailReference` are provided."},"shopperEmail":{"description":"Email address of the person.","type":"string"},"shopperName":{"$ref":"#/components/schemas/Name","description":"Name of the person."},"telephoneNumber":{"description":"Phone number of the person","type":"string"}},"type":"object"},"ModifyRequest":{"properties":{"additionalData":{"additionalProperties":{"type":"string"},"description":"This field contains additional data, which may be required for a particular payout request.","type":"object"},"merchantAccount":{"description":"The merchant account identifier, with which you want to process the transaction.","type":"string"},"originalReference":{"description":"The PSP reference received in the `/submitThirdParty` response.","type":"string"}},"required":["merchantAccount","originalReference"],"type":"object"},"ModifyResponse":{"properties":{"additionalData":{"additionalProperties":{"type":"string"},"description":"This field contains additional data, which may be returned in a particular response.","type":"object"},"pspReference":{"description":"Adyen's 16-character string reference associated with the transaction. This value is globally unique; quote it when communicating with us about this response.","type":"string"},"response":{"description":"The response:\n* In case of success, it is either `payout-confirm-received` or `payout-decline-received`.\n* In case of an error, an informational message is returned.","type":"string"}},"required":["pspReference","response"],"type":"object"},"Name":{"properties":{"firstName":{"description":"The first name.","type":"string"},"lastName":{"description":"The last name.","type":"string"}},"required":["firstName","lastName"],"type":"object"},"PayoutRequest":{"properties":{"amount":{"$ref":"#/components/schemas/Amount","description":"The amount information for the transaction (in [minor units](https://docs.adyen.com/development-resources/currency-codes)). For [BIN or card verification](https://docs.adyen.com/payment-methods/cards/bin-data-and-card-verification) requests, set amount to 0 (zero)."},"billingAddress":{"$ref":"#/components/schemas/Address","description":"The address where to send the invoice.\n> The `billingAddress` object is required in the following scenarios. Include all of the fields within this object.\n>* For 3D Secure 2 transactions in all browser-based and mobile implementations.\n>* For cross-border payouts to and from Canada.","x-addedInVersion":"4"},"card":{"$ref":"#/components/schemas/Card","description":"A container for card data.\n> Either `bankAccount` or `card` field must be provided in a payment request."},"fraudOffset":{"description":"An integer value that is added to the normal fraud score. The value can be either positive or negative.","format":"int32","type":"integer"},"fundSource":{"$ref":"#/components/schemas/FundSource","description":"The person or entity funding the money.","x-addedInVersion":"64"},"merchantAccount":{"description":"The merchant account identifier, with which you want to process the transaction.","type":"string"},"recurring":{"$ref":"#/components/schemas/Recurring","description":"The recurring settings for the payment. Use this property when you want to enable [recurring payments](https://docs.adyen.com/classic-integration/recurring-payments)."},"reference":{"description":"The reference to uniquely identify a payment. This reference is used in all communication with you about the payment status. We recommend using a unique value per payment; however, it is not a requirement.\nIf you need to provide multiple references for a transaction, separate them with hyphens (\"-\").\nMaximum length: 80 characters.","type":"string"},"selectedRecurringDetailReference":{"description":"The `recurringDetailReference` you want to use for this payment. The value `LATEST` can be used to select the most recently stored recurring detail.","type":"string"},"shopperEmail":{"description":"The shopper's email address. We recommend that you provide this data, as it is used in velocity fraud checks.\n> For 3D Secure 2 transactions, schemes require `shopperEmail` for all browser-based and mobile implementations.","type":"string"},"shopperInteraction":{"description":"Specifies the sales channel, through which the shopper gives their card details, and whether the shopper is a returning customer.\nFor the web service API, Adyen assumes Ecommerce shopper interaction by default.\n\nThis field has the following possible values:\n* `Ecommerce` - Online transactions where the cardholder is present (online). For better authorisation rates, we recommend sending the card security code (CSC) along with the request.\n* `ContAuth` - Card on file and/or subscription transactions, where the cardholder is known to the merchant (returning customer). If the shopper is present (online), you can supply also the CSC to improve authorisation (one-click payment).\n* `Moto` - Mail-order and telephone-order transactions where the shopper is in contact with the merchant via email or telephone.\n* `POS` - Point-of-sale transactions where the shopper is physically present to make a payment using a secure payment terminal.","enum":["Ecommerce","ContAuth","Moto","POS"],"type":"string"},"shopperName":{"$ref":"#/components/schemas/Name","description":"The shopper's full name.","x-addedInVersion":"7"},"shopperReference":{"description":"Required for recurring payments. \nYour reference to uniquely identify this shopper, for example user ID or account ID. Minimum length: 3 characters.\n> Your reference must not include personally identifiable information (PII), for example name or email address.","type":"string"},"telephoneNumber":{"description":"The shopper's telephone number.","type":"string","x-addedInVersion":"7"}},"required":["merchantAccount","reference","amount"],"type":"object"},"PayoutResponse":{"properties":{"additionalData":{"additionalProperties":{"type":"string"},"anyOf":[{"$ref":"#/components/schemas/ResponseAdditionalData3DSecure"},{"$ref":"#/components/schemas/ResponseAdditionalDataBillingAddress"},{"$ref":"#/components/schemas/ResponseAdditionalDataCard"},{"$ref":"#/components/schemas/ResponseAdditionalDataCommon"},{"$ref":"#/components/schemas/ResponseAdditionalDataDomesticError"},{"$ref":"#/components/schemas/ResponseAdditionalDataInstallments"},{"$ref":"#/components/schemas/ResponseAdditionalDataNetworkTokens"},{"$ref":"#/components/schemas/ResponseAdditionalDataOpi"},{"$ref":"#/components/schemas/ResponseAdditionalDataSepa"}],"description":"Contains additional information about the payment. Some data fields are included only if you select them first: Go to **Customer Area** > **Developers** > **Additional data**.","type":"object"},"authCode":{"description":"Authorisation code:\n* When the payment is authorised successfully, this field holds the authorisation code for the payment.\n* When the payment is not authorised, this field is empty.","type":"string"},"dccAmount":{"$ref":"#/components/schemas/Amount","description":"Includes the currency of the conversion and the value of the transaction.\n> This value only applies if you have implemented Dynamic Currency Conversion. For more information, [contact Support](https://www.adyen.help/hc/en-us/requests/new)."},"dccSignature":{"description":"Cryptographic signature used to verify `dccQuote`.\n> This value only applies if you have implemented Dynamic Currency Conversion. For more information, [contact Support](https://www.adyen.help/hc/en-us/requests/new).","type":"string"},"fraudResult":{"$ref":"#/components/schemas/FraudResult","description":"The fraud result properties of the payment."},"issuerUrl":{"description":"The URL to direct the shopper to.\n> In case of SecurePlus, do not redirect a shopper to this URL.","type":"string"},"md":{"description":"The payment session.","maxLength":20000,"type":"string"},"paRequest":{"description":"The 3D request data for the issuer.\n\nIf the value is **CUPSecurePlus-CollectSMSVerificationCode**, collect an SMS code from the shopper and pass it in the `/authorise3D` request. For more information, see [3D Secure](https://docs.adyen.com/classic-integration/3d-secure).","type":"string"},"pspReference":{"description":"Adyen's 16-character reference associated with the transaction/request. This value is globally unique; quote it when communicating with us about this request.","type":"string"},"refusalReason":{"description":"If the payment's authorisation is refused or an error occurs during authorisation, this field holds Adyen's mapped reason for the refusal or a description of the error. When a transaction fails, the authorisation response includes `resultCode` and `refusalReason` values.\n\nFor more information, see [Refusal reasons](https://docs.adyen.com/development-resources/refusal-reasons).","type":"string"},"resultCode":{"description":"The result of the payment. For more information, see [Result codes](https://docs.adyen.com/online-payments/payment-result-codes).\n\nPossible values:\n\n* **AuthenticationFinished** – The payment has been successfully authenticated with 3D Secure 2. Returned for 3D Secure 2 authentication-only transactions.\n* **AuthenticationNotRequired** – The transaction does not require 3D Secure authentication. Returned for [standalone authentication-only integrations](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only).\n* **Authorised** – The payment was successfully authorised. This state serves as an indicator to proceed with the delivery of goods and services. This is a final state.\n* **Cancelled** – Indicates the payment has been cancelled (either by the shopper or the merchant) before processing was completed. This is a final state.\n* **ChallengeShopper** – The issuer requires further shopper interaction before the payment can be authenticated. Returned for 3D Secure 2 transactions.\n* **Error** – There was an error when the payment was being processed. The reason is given in the `refusalReason` field. This is a final state.\n* **IdentifyShopper** – The issuer requires the shopper's device fingerprint before the payment can be authenticated. Returned for 3D Secure 2 transactions.\n* **PartiallyAuthorised** – The payment has been authorised for a partial amount.\nThis happens for card payments when the merchant supports Partial Authorisations and the cardholder has insufficient funds.\n* **Pending** – Indicates that it is not possible to obtain the final status of the payment. This can happen if the systems providing final status information for the payment are unavailable, or if the shopper needs to take further action to complete the payment.\n* **PresentToShopper** – Indicates that the response contains additional information that you need to present to a shopper, so that they can use it to complete a payment.\n* **Received** – Indicates the payment has successfully been received by Adyen, and will be processed. This is the initial state for all payments.\n* **RedirectShopper** – Indicates the shopper should be redirected to an external web page or app to complete the authorisation.\n* **Refused** – Indicates the payment was refused. The reason is given in the `refusalReason` field. This is a final state.","enum":["AuthenticationFinished","AuthenticationNotRequired","Authorised","Cancelled","ChallengeShopper","Error","IdentifyShopper","PartiallyAuthorised","Pending","PresentToShopper","Received","RedirectShopper","Refused","Success"],"type":"string"}},"type":"object"},"Recurring":{"properties":{"contract":{"description":"The type of recurring contract to be used.\nPossible values:\n* `ONECLICK` – Payment details can be used to initiate a one-click payment, where the shopper enters the [card security code (CVC/CVV)](https://docs.adyen.com/payments-fundamentals/payment-glossary#card-security-code-cvc-cvv-cid).\n* `RECURRING` – Payment details can be used without the card security code to initiate [card-not-present transactions](https://docs.adyen.com/payments-fundamentals/payment-glossary#card-not-present-cnp).\n* `ONECLICK,RECURRING` – Payment details can be used regardless of whether the shopper is on your site or not.\n* `PAYOUT` – Payment details can be used to [make a payout](https://docs.adyen.com/online-payments/online-payouts).","enum":["ONECLICK","RECURRING","PAYOUT"],"type":"string"},"recurringDetailName":{"description":"A descriptive name for this detail.","type":"string"},"recurringExpiry":{"description":"Date after which no further authorisations shall be performed. Only for 3D Secure 2.","format":"date-time","type":"string","x-addedInVersion":"40"},"recurringFrequency":{"description":"Minimum number of days between authorisations. Only for 3D Secure 2.","type":"string","x-addedInVersion":"40"},"tokenService":{"description":"The name of the token service.","enum":["VISATOKENSERVICE","MCTOKENSERVICE","AMEXTOKENSERVICE","TOKEN_SHARING"],"type":"string","x-addedInVersion":"25"}},"type":"object"},"ResponseAdditionalData3DSecure":{"properties":{"cardHolderInfo":{"description":"Information provided by the issuer to the cardholder. If this field is present, you need to display this information to the cardholder. ","type":"string"},"cavv":{"description":"The Cardholder Authentication Verification Value (CAVV) for the 3D Secure authentication session, as a Base64-encoded 20-byte array.","type":"string"},"cavvAlgorithm":{"description":"The CAVV algorithm used.","type":"string"},"scaExemptionRequested":{"description":"Shows the [exemption type](https://docs.adyen.com/payments-fundamentals/psd2-sca-compliance-and-implementation-guide#specifypreferenceinyourapirequest) that Adyen requested for the payment.\n\n Possible values:\n* **lowValue** \n* **secureCorporate** \n* **trustedBeneficiary** \n* **transactionRiskAnalysis** ","type":"string"},"threeds2.cardEnrolled":{"description":"Indicates whether a card is enrolled for 3D Secure 2.","type":"boolean"}},"type":"object"},"ResponseAdditionalDataBillingAddress":{"properties":{"billingAddress.city":{"description":"The billing address city passed in the payment request.","type":"string"},"billingAddress.country":{"description":"The billing address country passed in the payment request.\n\nExample: NL","type":"string"},"billingAddress.houseNumberOrName":{"description":"The billing address house number or name passed in the payment request.","type":"string"},"billingAddress.postalCode":{"description":"The billing address postal code passed in the payment request.\n\nExample: 1011 DJ","type":"string"},"billingAddress.stateOrProvince":{"description":"The billing address state or province passed in the payment request.\n\nExample: NH","type":"string"},"billingAddress.street":{"description":"The billing address street passed in the payment request.","type":"string"}},"type":"object"},"ResponseAdditionalDataCard":{"properties":{"cardBin":{"description":"The first six digits of the card number.\n\nThis is the [Bank Identification Number (BIN)](https://docs.adyen.com/get-started-with-adyen/payment-glossary#bank-identification-number-bin) for card numbers with a six-digit BIN.\n\nExample: 521234","type":"string"},"cardHolderName":{"description":"The cardholder name passed in the payment request.","type":"string"},"cardIssuingBank":{"description":"The bank or the financial institution granting lines of credit through card association branded payment cards. This information can be included when available.","type":"string"},"cardIssuingCountry":{"description":"The country where the card was issued.\n\nExample: US","type":"string"},"cardIssuingCurrency":{"description":"The currency in which the card is issued, if this information is available. Provided as the currency code or currency number from the ISO-4217 standard. \n\nExample: USD","type":"string"},"cardPaymentMethod":{"description":"The card payment method used for the transaction.\n\nExample: amex","type":"string"},"cardSummary":{"description":"The last four digits of a card number.\n\n> Returned only in case of a card payment.","type":"string"},"issuerBin":{"description":"The first eight digits of the card number. Only returned if the card number is 16 digits or more.\n\nThis is the [Bank Identification Number (BIN)](https://docs.adyen.com/get-started-with-adyen/payment-glossary#bank-identification-number-bin) for card numbers with an eight-digit BIN.\n\nExample: 52123423","type":"string"}},"type":"object"},"ResponseAdditionalDataCommon":{"properties":{"acquirerAccountCode":{"description":"The name of the Adyen acquirer account.\n\nExample: PayPalSandbox_TestAcquirer\n\n> Only relevant for PayPal transactions.","type":"string"},"acquirerCode":{"description":"The name of the acquirer processing the payment request.\n\nExample: TestPmmAcquirer","type":"string"},"acquirerReference":{"description":"The reference number that can be used for reconciliation in case a non-Adyen acquirer is used for settlement.\n\nExample: 7C9N3FNBKT9","type":"string"},"alias":{"description":"The Adyen alias of the card.\n\nExample: H167852639363479","type":"string"},"aliasType":{"description":"The type of the card alias.\n\nExample: Default","type":"string"},"authCode":{"description":"Authorisation code:\n* When the payment is authorised successfully, this field holds the authorisation code for the payment.\n* When the payment is not authorised, this field is empty.\n\nExample: 58747","type":"string"},"authorisationMid":{"description":"Merchant ID known by the acquirer.","type":"string"},"authorisedAmountCurrency":{"description":"The currency of the authorised amount, as a three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes).","type":"string"},"authorisedAmountValue":{"description":"Value of the amount authorised.\n\nThis amount is represented in minor units according to the [following table](https://docs.adyen.com/development-resources/currency-codes).","type":"string"},"avsResult":{"description":"The AVS result code of the payment, which provides information about the outcome of the AVS check.\n\nFor possible values, see [AVS](https://docs.adyen.com/risk-management/configure-standard-risk-rules/consistency-rules#billing-address-does-not-match-cardholder-address-avs).","type":"string"},"avsResultRaw":{"description":"Raw AVS result received from the acquirer, where available.\n\nExample: D","type":"string"},"bic":{"description":"BIC of a bank account.\n\nExample: TESTNL01\n\n> Only relevant for SEPA Direct Debit transactions.","type":"string"},"coBrandedWith":{"description":"Includes the co-branded card information.","type":"string"},"cvcResult":{"description":"The result of CVC verification.","examples":["1 Matches"],"type":"string"},"cvcResultRaw":{"description":"The raw result of CVC verification.","examples":["M"],"type":"string"},"dsTransID":{"description":"Supported for 3D Secure 2. The unique transaction identifier assigned by the DS to identify a single transaction.","type":"string"},"eci":{"description":"The Electronic Commerce Indicator returned from the schemes for the 3DS payment session.\n\nExample: 02","type":"string"},"expiryDate":{"description":"The expiry date on the card.\n\nExample: 6/2016\n\n> Returned only in case of a card payment.","type":"string"},"extraCostsCurrency":{"description":"The currency of the extra amount charged due to additional amounts set in the skin used in the HPP payment request.\n\nExample: EUR","type":"string"},"extraCostsValue":{"description":"The value of the extra amount charged due to additional amounts set in the skin used in the HPP payment request. The amount is in minor units.","type":"string"},"fraudCheck-[itemNr]-[FraudCheckname]":{"description":"The fraud score due to a particular fraud check. The fraud check name is found in the key of the key-value pair.","type":"string"},"fraudManualReview":{"description":"Indicates if the payment is sent to manual review.","type":"string"},"fraudResultType":{"description":"The fraud result properties of the payment.","enum":["GREEN","FRAUD"],"type":"string"},"fundingSource":{"description":"Information regarding the funding type of the card. The possible return values are:\n* CHARGE\n* CREDIT\n* DEBIT\n* PREPAID\n* PREPAID_RELOADABLE\n\n* PREPAID_NONRELOADABLE\n* DEFFERED_DEBIT\n\n> This functionality requires additional configuration on Adyen's end. To enable it, contact the Support Team.\n\nFor receiving this field in the notification, enable **Include Funding Source** in **Notifications** > **Additional settings**.","type":"string"},"fundsAvailability":{"description":"Indicates availability of funds.\n\nVisa:\n* \"I\" (fast funds are supported)\n* \"N\" (otherwise)\n\nMastercard:\n* \"I\" (product type is Prepaid or Debit, or issuing country is in CEE/HGEM list)\n* \"N\" (otherwise)\n\n> Returned when you verify a card BIN or estimate costs, and only if payoutEligible is \"Y\" or \"D\".","type":"string"},"inferredRefusalReason":{"description":"Provides the more granular indication of why a transaction was refused. When a transaction fails with either \"Refused\", \"Restricted Card\", \"Transaction Not Permitted\", \"Not supported\" or \"DeclinedNon Generic\" refusalReason from the issuer, Adyen cross references its PSP-wide data for extra insight into the refusal reason. If an inferred refusal reason is available, the `inferredRefusalReason`, field is populated and the `refusalReason`, is set to \"Not Supported\".\n\nPossible values:\n\n* 3D Secure Mandated\n* Closed Account\n* ContAuth Not Supported\n* CVC Mandated\n* Ecommerce Not Allowed\n* Crossborder Not Supported\n* Card Updated\n\n* Low Authrate Bin\n* Non-reloadable prepaid card",