mirror of
https://github.com/gcatanese/adyen-openapi.git
synced 2026-03-10 08:01:24 +00:00
spec release
This commit is contained in:
Adyen Automation
@@ -18,7 +18,19 @@
|
||||
"Card order"
|
||||
],
|
||||
"tags" : [
|
||||
],
|
||||
{
|
||||
"name" : "Account holder"
|
||||
},
|
||||
{
|
||||
"name" : "Balance account"
|
||||
},
|
||||
{
|
||||
"name" : "Payment instrument"
|
||||
},
|
||||
{
|
||||
"name" : "Card order"
|
||||
}
|
||||
],
|
||||
"x-staticResponse" : "response.json",
|
||||
"webhooks" : {
|
||||
"balancePlatform.accountHolder.created" : {
|
||||
@@ -675,13 +687,6 @@
|
||||
"description" : "A JSON object containing the settings that were requested for the account holder.",
|
||||
"$ref" : "#/components/schemas/CapabilitySettings"
|
||||
},
|
||||
"transferInstruments" : {
|
||||
"description" : "Contains the status of the transfer instruments associated with this capability. ",
|
||||
"items" : {
|
||||
"$ref" : "#/components/schemas/AccountSupportingEntityCapability"
|
||||
},
|
||||
"type" : "array"
|
||||
},
|
||||
"verificationStatus" : {
|
||||
"description" : "The status of the verification checks for the capability.\n\nPossible values:\n\n* **pending**: Adyen is running the verification.\n\n* **invalid**: The verification failed. Check if the `errors` array contains more information.\n\n* **valid**: The verification has been successfully completed.\n\n* **rejected**: Adyen has verified the information, but found reasons to not allow the capability.\n",
|
||||
"enum" : [
|
||||
@@ -734,57 +739,6 @@
|
||||
],
|
||||
"type" : "object"
|
||||
},
|
||||
"AccountSupportingEntityCapability" : {
|
||||
"properties" : {
|
||||
"allowed" : {
|
||||
"description" : "Indicates whether the supporting entity capability is allowed. Adyen sets this to **true** if the verification is successful and the account holder is permitted to use the capability.",
|
||||
"type" : "boolean"
|
||||
},
|
||||
"allowedLevel" : {
|
||||
"description" : "The capability level that is allowed for the account holder.\n\nPossible values: **notApplicable**, **low**, **medium**, **high**.",
|
||||
"enum" : [
|
||||
"high",
|
||||
"low",
|
||||
"medium",
|
||||
"notApplicable"
|
||||
],
|
||||
"type" : "string"
|
||||
},
|
||||
"enabled" : {
|
||||
"description" : "Indicates whether the capability is enabled. If **false**, the capability is temporarily disabled for the account holder.",
|
||||
"type" : "boolean"
|
||||
},
|
||||
"id" : {
|
||||
"description" : "The ID of the supporting entity.",
|
||||
"type" : "string"
|
||||
},
|
||||
"requested" : {
|
||||
"description" : "Indicates whether the capability is requested. To check whether the account holder is permitted to use the capability, refer to the `allowed` field.",
|
||||
"type" : "boolean"
|
||||
},
|
||||
"requestedLevel" : {
|
||||
"description" : "The requested level of the capability. Some capabilities, such as those used in [card issuing](https://docs.adyen.com/issuing/add-capabilities#capability-levels), have different levels. Levels increase the capability, but also require additional checks and increased monitoring.\n\nPossible values: **notApplicable**, **low**, **medium**, **high**.",
|
||||
"enum" : [
|
||||
"high",
|
||||
"low",
|
||||
"medium",
|
||||
"notApplicable"
|
||||
],
|
||||
"type" : "string"
|
||||
},
|
||||
"verificationStatus" : {
|
||||
"description" : "The status of the verification checks for the supporting entity capability.\n\nPossible values:\n\n* **pending**: Adyen is running the verification.\n\n* **invalid**: The verification failed. Check if the `errors` array contains more information.\n\n* **valid**: The verification has been successfully completed.\n\n* **rejected**: Adyen has verified the information, but found reasons to not allow the capability.\n",
|
||||
"enum" : [
|
||||
"invalid",
|
||||
"pending",
|
||||
"rejected",
|
||||
"valid"
|
||||
],
|
||||
"type" : "string"
|
||||
}
|
||||
},
|
||||
"type" : "object"
|
||||
},
|
||||
"Address" : {
|
||||
"properties" : {
|
||||
"city" : {
|
||||
@@ -912,7 +866,7 @@
|
||||
"type" : "array"
|
||||
},
|
||||
"defaultCurrencyCode" : {
|
||||
"description" : "The default three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes) of the balance account.\nThe default value is **EUR**.",
|
||||
"description" : "The default three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes) of the balance account.\nThe default value is **EUR**.\n> After a balance account is created, you cannot change its default currency.",
|
||||
"type" : "string"
|
||||
},
|
||||
"description" : {
|
||||
@@ -1705,12 +1659,12 @@
|
||||
"PlatformPaymentConfiguration" : {
|
||||
"properties" : {
|
||||
"salesDayClosingTime" : {
|
||||
"description" : "Specifies at what time a [sales day](https://docs.adyen.com/marketplaces-and-platforms/receive-funds/sales-day-settlement#sales-day) ends.\n\nPossible values: Time in **\"HH:MM\"** format. **HH** ranges from **00** to **07**. **MM** must be **00**.\n\nDefault value: **\"00:00\"**.",
|
||||
"description" : "Specifies at what time a [sales day](https://docs.adyen.com/marketplaces-and-platforms/settle-funds/sales-day-settlement#sales-day) ends.\n\nPossible values: Time in **\"HH:MM\"** format. **HH** ranges from **00** to **07**. **MM** must be **00**.\n\nDefault value: **\"00:00\"**.",
|
||||
"format" : "time",
|
||||
"type" : "string"
|
||||
},
|
||||
"settlementDelayDays" : {
|
||||
"description" : "Specifies after how many business days the funds in a [settlement batch](https://docs.adyen.com/marketplaces-and-platforms/receive-funds/sales-day-settlement#settlement-batch) are made available.\n\nPossible values: **0** to **10**, or **null**.\n* Setting this value to an integer enables [Sales day settlement](https://docs.adyen.com/marketplaces-and-platforms/receive-funds/sales-day-settlement).\n* Setting this value to **null** enables [Pass-through settlement](https://docs.adyen.com/marketplaces-and-platforms/receive-funds/pass-through-settlement).\n\nDefault value: **null**.",
|
||||
"description" : "Specifies after how many business days the funds in a [settlement batch](https://docs.adyen.com/marketplaces-and-platforms/settle-funds/sales-day-settlement#settlement-batch) are made available.\n\nPossible values: **0** to **10**, or **null**.\n* Setting this value to an integer enables [Sales day settlement](https://docs.adyen.com/marketplaces-and-platforms/settle-funds/sales-day-settlement).\n* Setting this value to **null** enables [Pass-through settlement](https://docs.adyen.com/marketplaces-and-platforms/settle-funds/pass-through-settlement).\n\nDefault value: **null**.",
|
||||
"format" : "int32",
|
||||
"type" : "integer"
|
||||
}
|
||||
@@ -1815,16 +1769,19 @@
|
||||
"enum" : [
|
||||
"amountLimitExceeded",
|
||||
"approved",
|
||||
"balanceAccountTemporarilyBlockedByTransactionRule",
|
||||
"counterpartyAccountBlocked",
|
||||
"counterpartyAccountClosed",
|
||||
"counterpartyAccountNotFound",
|
||||
"counterpartyAddressRequired",
|
||||
"counterpartyBankTimedOut",
|
||||
"counterpartyBankUnavailable",
|
||||
"declinedByTransactionRule",
|
||||
"error",
|
||||
"notEnoughBalance",
|
||||
"refusedByCounterpartyBank",
|
||||
"routeNotFound",
|
||||
"scaFailed",
|
||||
"unknown"
|
||||
],
|
||||
"type" : "string"
|
||||
@@ -2191,6 +2148,15 @@
|
||||
"enabled" : true,
|
||||
"requested" : true,
|
||||
"allowed" : false,
|
||||
"transferInstruments" : [
|
||||
{
|
||||
"enabled" : true,
|
||||
"requested" : true,
|
||||
"allowed" : false,
|
||||
"id" : "SE576BH223222F5GJVKHH6BDT",
|
||||
"verificationStatus" : "pending"
|
||||
}
|
||||
],
|
||||
"verificationStatus" : "pending"
|
||||
},
|
||||
"sendToBalanceAccount" : {
|
||||
@@ -2232,13 +2198,13 @@
|
||||
"problems" : [
|
||||
{
|
||||
"entity" : {
|
||||
"id" : "LE43319330319C8AYX89L2V59",
|
||||
"type" : "LegalEntity"
|
||||
"id" : "SE3222Z223222Q5J4D58K3DWP",
|
||||
"type" : "BankAccount"
|
||||
},
|
||||
"verificationErrors" : [
|
||||
{
|
||||
"code" : "2_8037",
|
||||
"message" : "No bankStatement available to perform verification.",
|
||||
"message" : "'bankStatement' was missing.",
|
||||
"remediatingActions" : [
|
||||
{
|
||||
"code" : "1_703",
|
||||
@@ -2250,6 +2216,22 @@
|
||||
]
|
||||
}
|
||||
],
|
||||
"transferInstruments" : [
|
||||
{
|
||||
"enabled" : true,
|
||||
"requested" : true,
|
||||
"allowed" : true,
|
||||
"id" : "SE576BH223222F5GJVKHH6BDT",
|
||||
"verificationStatus" : "valid"
|
||||
},
|
||||
{
|
||||
"enabled" : true,
|
||||
"requested" : true,
|
||||
"allowed" : false,
|
||||
"id" : "SE3222Z223222Q5J4D58K3DWP",
|
||||
"verificationStatus" : "invalid"
|
||||
}
|
||||
],
|
||||
"verificationStatus" : "invalid"
|
||||
}
|
||||
},
|
||||
|
||||
@@ -15,7 +15,10 @@
|
||||
"General"
|
||||
],
|
||||
"tags" : [
|
||||
],
|
||||
{
|
||||
"name" : "General"
|
||||
}
|
||||
],
|
||||
"webhooks" : {
|
||||
"balancePlatform.report.created" : {
|
||||
"post" : {
|
||||
|
||||
@@ -33,33 +33,33 @@
|
||||
{
|
||||
"name" : "Platform"
|
||||
},
|
||||
{
|
||||
"name" : "Grant offers"
|
||||
},
|
||||
{
|
||||
"name" : "Payment instrument groups"
|
||||
},
|
||||
{
|
||||
"name" : "Network tokens"
|
||||
},
|
||||
{
|
||||
"name" : "Account holders"
|
||||
},
|
||||
{
|
||||
"name" : "Payment instruments"
|
||||
},
|
||||
{
|
||||
"name" : "Grant accounts"
|
||||
},
|
||||
{
|
||||
"name" : "Bank account validation"
|
||||
},
|
||||
{
|
||||
"name" : "Balance accounts"
|
||||
},
|
||||
{
|
||||
"name" : "Payment instruments"
|
||||
},
|
||||
{
|
||||
"name" : "Payment instrument groups"
|
||||
},
|
||||
{
|
||||
"name" : "Transaction rules"
|
||||
},
|
||||
{
|
||||
"name" : "Bank account validation"
|
||||
},
|
||||
{
|
||||
"name" : "Network tokens"
|
||||
},
|
||||
{
|
||||
"name" : "Grant accounts"
|
||||
},
|
||||
{
|
||||
"name" : "Grant offers"
|
||||
},
|
||||
{
|
||||
"name" : "Transfer routes"
|
||||
}
|
||||
@@ -614,6 +614,164 @@
|
||||
}
|
||||
}
|
||||
},
|
||||
"/accountHolders/{id}/taxForms" : {
|
||||
"get" : {
|
||||
"tags" : [
|
||||
"Account holders"
|
||||
],
|
||||
"summary" : "Get a tax form",
|
||||
"description" : "Generates a tax form for account holders operating in the US. For more information, refer to [Providing tax forms](https://docs.adyen.com/marketplaces-and-platforms/us-tax-forms/).",
|
||||
"x-addedInVersion" : "2",
|
||||
"operationId" : "get-accountHolders-id-taxForms",
|
||||
"x-groupName" : "Account holders",
|
||||
"x-sortIndex" : 5,
|
||||
"x-methodName" : "getTaxForm",
|
||||
"security" : [
|
||||
{
|
||||
"BasicAuth" : [
|
||||
]
|
||||
},
|
||||
{
|
||||
"ApiKeyAuth" : [
|
||||
]
|
||||
}
|
||||
],
|
||||
"parameters" : [
|
||||
{
|
||||
"description" : "The unique identifier of the account holder.",
|
||||
"name" : "id",
|
||||
"in" : "path",
|
||||
"required" : true,
|
||||
"schema" : {
|
||||
"type" : "string"
|
||||
}
|
||||
},
|
||||
{
|
||||
"description" : "The type of tax form you want to retrieve. Accepted values are **us1099k** and **us1099nec**",
|
||||
"name" : "formType",
|
||||
"in" : "query",
|
||||
"required" : true,
|
||||
"schema" : {
|
||||
"x-enum" : [
|
||||
{
|
||||
"value" : "US1099k"
|
||||
},
|
||||
{
|
||||
"value" : "US1099nec"
|
||||
}
|
||||
],
|
||||
"enum" : [
|
||||
"US1099k",
|
||||
"US1099nec"
|
||||
],
|
||||
"type" : "string"
|
||||
}
|
||||
},
|
||||
{
|
||||
"description" : "The tax year in YYYY format for the tax form you want to retrieve",
|
||||
"name" : "year",
|
||||
"in" : "query",
|
||||
"required" : true,
|
||||
"schema" : {
|
||||
"format" : "int32",
|
||||
"type" : "integer"
|
||||
}
|
||||
}
|
||||
],
|
||||
"responses" : {
|
||||
"200" : {
|
||||
"content" : {
|
||||
"application/json" : {
|
||||
"examples" : {
|
||||
"success" : {
|
||||
"$ref" : "#/components/examples/get-accountHolders-id-taxForms-success-200"
|
||||
}
|
||||
},
|
||||
"schema" : {
|
||||
"$ref" : "#/components/schemas/GetTaxFormResponse"
|
||||
}
|
||||
}
|
||||
},
|
||||
"description" : "OK - the request has succeeded."
|
||||
},
|
||||
"400" : {
|
||||
"content" : {
|
||||
"application/json" : {
|
||||
"examples" : {
|
||||
"generic" : {
|
||||
"$ref" : "#/components/examples/generic-400"
|
||||
}
|
||||
},
|
||||
"schema" : {
|
||||
"$ref" : "#/components/schemas/RestServiceError"
|
||||
}
|
||||
}
|
||||
},
|
||||
"description" : "Bad Request - a problem reading or understanding the request."
|
||||
},
|
||||
"401" : {
|
||||
"content" : {
|
||||
"application/json" : {
|
||||
"examples" : {
|
||||
"generic" : {
|
||||
"$ref" : "#/components/examples/generic-401"
|
||||
}
|
||||
},
|
||||
"schema" : {
|
||||
"$ref" : "#/components/schemas/RestServiceError"
|
||||
}
|
||||
}
|
||||
},
|
||||
"description" : "Unauthorized - authentication required."
|
||||
},
|
||||
"403" : {
|
||||
"content" : {
|
||||
"application/json" : {
|
||||
"examples" : {
|
||||
"generic" : {
|
||||
"$ref" : "#/components/examples/generic-403"
|
||||
}
|
||||
},
|
||||
"schema" : {
|
||||
"$ref" : "#/components/schemas/RestServiceError"
|
||||
}
|
||||
}
|
||||
},
|
||||
"description" : "Forbidden - insufficient permissions to process the request."
|
||||
},
|
||||
"422" : {
|
||||
"content" : {
|
||||
"application/json" : {
|
||||
"examples" : {
|
||||
"generic" : {
|
||||
"$ref" : "#/components/examples/generic-422"
|
||||
}
|
||||
},
|
||||
"schema" : {
|
||||
"$ref" : "#/components/schemas/RestServiceError"
|
||||
}
|
||||
}
|
||||
},
|
||||
"description" : "Unprocessable Entity - a request validation error."
|
||||
},
|
||||
"500" : {
|
||||
"content" : {
|
||||
"application/json" : {
|
||||
"examples" : {
|
||||
"generic" : {
|
||||
"$ref" : "#/components/examples/generic-500"
|
||||
}
|
||||
},
|
||||
"schema" : {
|
||||
"$ref" : "#/components/schemas/RestServiceError"
|
||||
}
|
||||
}
|
||||
},
|
||||
"description" : "Internal Server Error - the server could not process the request."
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"/balanceAccounts" : {
|
||||
"post" : {
|
||||
"tags" : [
|
||||
@@ -1086,7 +1244,7 @@
|
||||
],
|
||||
"responses" : {
|
||||
"204" : {
|
||||
"description" : "No Content - look at the actual response code for the status of the request "
|
||||
"description" : "No Content - look at the actual response code for the status of the request. "
|
||||
},
|
||||
"400" : {
|
||||
"content" : {
|
||||
@@ -2650,7 +2808,7 @@
|
||||
],
|
||||
"responses" : {
|
||||
"202" : {
|
||||
"description" : "No Content - look at the actual response code for the status of the request "
|
||||
"description" : "No Content - look at the actual response code for the status of the request. "
|
||||
},
|
||||
"401" : {
|
||||
"content" : {
|
||||
@@ -4590,7 +4748,7 @@
|
||||
},
|
||||
"responses" : {
|
||||
"200" : {
|
||||
"description" : "No Content - look at the actual response code for the status of the request "
|
||||
"description" : "No Content - look at the actual response code for the status of the request. "
|
||||
},
|
||||
"401" : {
|
||||
"content" : {
|
||||
@@ -4833,6 +4991,7 @@
|
||||
"$ref" : "#/components/schemas/CapabilitySettings"
|
||||
},
|
||||
"transferInstruments" : {
|
||||
"x-addedInVersion" : "2",
|
||||
"description" : "Contains the status of the transfer instruments associated with this capability. ",
|
||||
"items" : {
|
||||
"$ref" : "#/components/schemas/AccountSupportingEntityCapability"
|
||||
@@ -5290,7 +5449,7 @@
|
||||
"type" : "array"
|
||||
},
|
||||
"defaultCurrencyCode" : {
|
||||
"description" : "The default three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes) of the balance account.\nThe default value is **EUR**.",
|
||||
"description" : "The default three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes) of the balance account.\nThe default value is **EUR**.\n> After a balance account is created, you cannot change its default currency.",
|
||||
"type" : "string"
|
||||
},
|
||||
"description" : {
|
||||
@@ -5351,7 +5510,7 @@
|
||||
"type" : "string"
|
||||
},
|
||||
"defaultCurrencyCode" : {
|
||||
"description" : "The default three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes) of the balance account.\nThe default value is **EUR**.",
|
||||
"description" : "The default three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes) of the balance account.\nThe default value is **EUR**.\n> After a balance account is created, you cannot change its default currency.",
|
||||
"type" : "string"
|
||||
},
|
||||
"description" : {
|
||||
@@ -5412,7 +5571,7 @@
|
||||
"type" : "string"
|
||||
},
|
||||
"defaultCurrencyCode" : {
|
||||
"description" : "The default three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes) of the balance account.\nThe default value is **EUR**.",
|
||||
"description" : "The default three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes) of the balance account.\nThe default value is **EUR**.\n> After a balance account is created, you cannot change its default currency.",
|
||||
"type" : "string"
|
||||
},
|
||||
"description" : {
|
||||
@@ -5457,10 +5616,6 @@
|
||||
"description" : "The unique identifier of the [account holder](https://docs.adyen.com/api-explorer/#/balanceplatform/latest/post/accountHolders__resParam_id) associated with the balance account.",
|
||||
"type" : "string"
|
||||
},
|
||||
"defaultCurrencyCode" : {
|
||||
"description" : "The default currency code of this balance account, in three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes) format. \nThe default value is **EUR**.",
|
||||
"type" : "string"
|
||||
},
|
||||
"description" : {
|
||||
"description" : "A human-readable description of the balance account, maximum 300 characters. You can use this parameter to distinguish between multiple balance accounts under an account holder.",
|
||||
"maxLength" : 300,
|
||||
@@ -5714,6 +5869,24 @@
|
||||
],
|
||||
"type" : "object"
|
||||
},
|
||||
"BankIdentification" : {
|
||||
"properties" : {
|
||||
"country" : {
|
||||
"type" : "string"
|
||||
},
|
||||
"identification" : {
|
||||
"type" : "string"
|
||||
},
|
||||
"identificationType" : {
|
||||
"enum" : [
|
||||
"iban",
|
||||
"routingNumber"
|
||||
],
|
||||
"type" : "string"
|
||||
}
|
||||
},
|
||||
"type" : "object"
|
||||
},
|
||||
"BrandVariantsRestriction" : {
|
||||
"properties" : {
|
||||
"operation" : {
|
||||
@@ -6251,6 +6424,25 @@
|
||||
},
|
||||
"type" : "object"
|
||||
},
|
||||
"CounterpartyBankRestriction" : {
|
||||
"properties" : {
|
||||
"operation" : {
|
||||
"description" : "Defines how the condition must be evaluated.",
|
||||
"type" : "string"
|
||||
},
|
||||
"value" : {
|
||||
"description" : "List of counterparty Bank Institutions and the operation.",
|
||||
"items" : {
|
||||
"$ref" : "#/components/schemas/BankIdentification"
|
||||
},
|
||||
"type" : "array"
|
||||
}
|
||||
},
|
||||
"required" : [
|
||||
"operation"
|
||||
],
|
||||
"type" : "object"
|
||||
},
|
||||
"CountriesRestriction" : {
|
||||
"properties" : {
|
||||
"operation" : {
|
||||
@@ -6300,7 +6492,6 @@
|
||||
"items" : {
|
||||
"enum" : [
|
||||
"crossBorder",
|
||||
"directDebit",
|
||||
"fast",
|
||||
"instant",
|
||||
"internal",
|
||||
@@ -6316,16 +6507,19 @@
|
||||
"enum" : [
|
||||
"amountLimitExceeded",
|
||||
"approved",
|
||||
"balanceAccountTemporarilyBlockedByTransactionRule",
|
||||
"counterpartyAccountBlocked",
|
||||
"counterpartyAccountClosed",
|
||||
"counterpartyAccountNotFound",
|
||||
"counterpartyAddressRequired",
|
||||
"counterpartyBankTimedOut",
|
||||
"counterpartyBankUnavailable",
|
||||
"declinedByTransactionRule",
|
||||
"error",
|
||||
"notEnoughBalance",
|
||||
"refusedByCounterpartyBank",
|
||||
"routeNotFound",
|
||||
"scaFailed",
|
||||
"unknown"
|
||||
],
|
||||
"readOnly" : true,
|
||||
@@ -6656,6 +6850,26 @@
|
||||
],
|
||||
"type" : "object"
|
||||
},
|
||||
"GetTaxFormResponse" : {
|
||||
"properties" : {
|
||||
"content" : {
|
||||
"description" : "The content of the tax form in Base64 format.",
|
||||
"format" : "byte",
|
||||
"type" : "string"
|
||||
},
|
||||
"contentType" : {
|
||||
"description" : "The content type of the tax form.\n\nPossible values:\n* **application/pdf**\n\n",
|
||||
"enum" : [
|
||||
"application/pdf"
|
||||
],
|
||||
"type" : "string"
|
||||
}
|
||||
},
|
||||
"required" : [
|
||||
"content"
|
||||
],
|
||||
"type" : "object"
|
||||
},
|
||||
"GrantLimit" : {
|
||||
"properties" : {
|
||||
"amount" : {
|
||||
@@ -6728,8 +6942,8 @@
|
||||
"additionalProperties" : false,
|
||||
"properties" : {
|
||||
"accountNumber" : {
|
||||
"description" : "The 9- to 12-character bank account number (alphanumeric), without separators or whitespace. Starts with the 3-digit branch code.",
|
||||
"maxLength" : 12,
|
||||
"description" : "The 9- to 15-character bank account number (alphanumeric), without separators or whitespace. Starts with the 3-digit branch code.",
|
||||
"maxLength" : 15,
|
||||
"minLength" : 9,
|
||||
"type" : "string"
|
||||
},
|
||||
@@ -6993,21 +7207,9 @@
|
||||
"additionalProperties" : false,
|
||||
"properties" : {
|
||||
"accountNumber" : {
|
||||
"description" : "The 7-digit bank account number, without separators or whitespace.",
|
||||
"maxLength" : 7,
|
||||
"minLength" : 7,
|
||||
"type" : "string"
|
||||
},
|
||||
"accountSuffix" : {
|
||||
"description" : "The 2- to 3-digit account suffix, without separators or whitespace.",
|
||||
"maxLength" : 3,
|
||||
"minLength" : 2,
|
||||
"type" : "string"
|
||||
},
|
||||
"bankCode" : {
|
||||
"description" : "The 6-digit bank code including the 2-digit bank code and 4-digit branch code, without separators or whitespace.",
|
||||
"maxLength" : 6,
|
||||
"minLength" : 6,
|
||||
"description" : "The 15-16 digit bank account number. The first 2 digits are the bank number, the next 4 digits are the branch number, the next 7 digits are the account number, and the final 2-3 digits are the suffix.",
|
||||
"maxLength" : 16,
|
||||
"minLength" : 15,
|
||||
"type" : "string"
|
||||
},
|
||||
"type" : {
|
||||
@@ -7021,9 +7223,7 @@
|
||||
},
|
||||
"required" : [
|
||||
"type",
|
||||
"accountNumber",
|
||||
"accountSuffix",
|
||||
"bankCode"
|
||||
"accountNumber"
|
||||
],
|
||||
"type" : "object"
|
||||
},
|
||||
@@ -7460,6 +7660,10 @@
|
||||
"description" : "The two-character ISO-3166-1 alpha-2 country code of the counterparty. For example, **US** or **NL**.",
|
||||
"type" : "string"
|
||||
},
|
||||
"onlyForCrossBalancePlatform" : {
|
||||
"description" : "Specifies if the requirement only applies to transfers to another balance platform.",
|
||||
"type" : "boolean"
|
||||
},
|
||||
"paymentInstrumentType" : {
|
||||
"description" : "The type of the payment instrument. For example, \"BankAccount\" or \"Card\".",
|
||||
"enum" : [
|
||||
@@ -7594,12 +7798,12 @@
|
||||
"PlatformPaymentConfiguration" : {
|
||||
"properties" : {
|
||||
"salesDayClosingTime" : {
|
||||
"description" : "Specifies at what time a [sales day](https://docs.adyen.com/marketplaces-and-platforms/receive-funds/sales-day-settlement#sales-day) ends.\n\nPossible values: Time in **\"HH:MM\"** format. **HH** ranges from **00** to **07**. **MM** must be **00**.\n\nDefault value: **\"00:00\"**.",
|
||||
"description" : "Specifies at what time a [sales day](https://docs.adyen.com/marketplaces-and-platforms/settle-funds/sales-day-settlement#sales-day) ends.\n\nPossible values: Time in **\"HH:MM\"** format. **HH** ranges from **00** to **07**. **MM** must be **00**.\n\nDefault value: **\"00:00\"**.",
|
||||
"format" : "time",
|
||||
"type" : "string"
|
||||
},
|
||||
"settlementDelayDays" : {
|
||||
"description" : "Specifies after how many business days the funds in a [settlement batch](https://docs.adyen.com/marketplaces-and-platforms/receive-funds/sales-day-settlement#settlement-batch) are made available.\n\nPossible values: **0** to **10**, or **null**.\n* Setting this value to an integer enables [Sales day settlement](https://docs.adyen.com/marketplaces-and-platforms/receive-funds/sales-day-settlement).\n* Setting this value to **null** enables [Pass-through settlement](https://docs.adyen.com/marketplaces-and-platforms/receive-funds/pass-through-settlement).\n\nDefault value: **null**.",
|
||||
"description" : "Specifies after how many business days the funds in a [settlement batch](https://docs.adyen.com/marketplaces-and-platforms/settle-funds/sales-day-settlement#settlement-batch) are made available.\n\nPossible values: **0** to **10**, or **null**.\n* Setting this value to an integer enables [Sales day settlement](https://docs.adyen.com/marketplaces-and-platforms/settle-funds/sales-day-settlement).\n* Setting this value to **null** enables [Pass-through settlement](https://docs.adyen.com/marketplaces-and-platforms/settle-funds/pass-through-settlement).\n\nDefault value: **null**.",
|
||||
"format" : "int32",
|
||||
"type" : "integer"
|
||||
}
|
||||
@@ -7854,7 +8058,6 @@
|
||||
"items" : {
|
||||
"enum" : [
|
||||
"crossBorder",
|
||||
"directDebit",
|
||||
"fast",
|
||||
"instant",
|
||||
"internal",
|
||||
@@ -7870,16 +8073,19 @@
|
||||
"enum" : [
|
||||
"amountLimitExceeded",
|
||||
"approved",
|
||||
"balanceAccountTemporarilyBlockedByTransactionRule",
|
||||
"counterpartyAccountBlocked",
|
||||
"counterpartyAccountClosed",
|
||||
"counterpartyAccountNotFound",
|
||||
"counterpartyAddressRequired",
|
||||
"counterpartyBankTimedOut",
|
||||
"counterpartyBankUnavailable",
|
||||
"declinedByTransactionRule",
|
||||
"error",
|
||||
"notEnoughBalance",
|
||||
"refusedByCounterpartyBank",
|
||||
"routeNotFound",
|
||||
"scaFailed",
|
||||
"unknown"
|
||||
],
|
||||
"readOnly" : true,
|
||||
@@ -8305,6 +8511,10 @@
|
||||
"description" : "List of card brand variants and the operation.\n\nSupported operations: **anyMatch**, **noneMatch**.",
|
||||
"$ref" : "#/components/schemas/BrandVariantsRestriction"
|
||||
},
|
||||
"counterpartyBank" : {
|
||||
"description" : "List of counterparty Institutions and the operation. Supported operations: **anyMatch**, **noneMatch**.",
|
||||
"$ref" : "#/components/schemas/CounterpartyBankRestriction"
|
||||
},
|
||||
"countries" : {
|
||||
"description" : "List of countries and the operation.\n\nSupported operations: **anyMatch**, **noneMatch**.",
|
||||
"$ref" : "#/components/schemas/CountriesRestriction"
|
||||
@@ -8370,10 +8580,6 @@
|
||||
},
|
||||
"TransferRoute" : {
|
||||
"properties" : {
|
||||
"balancePlatform" : {
|
||||
"description" : "The unique identifier assigned to the balance platform associated with the account holder.",
|
||||
"type" : "string"
|
||||
},
|
||||
"category" : {
|
||||
"description" : " The type of transfer.\n\n Possible values:\n\n - **bank**: Transfer to a [transfer instrument](https://docs.adyen.com/api-explorer/#/legalentity/latest/post/transferInstruments__resParam_id) or a bank account.\n",
|
||||
"enum" : [
|
||||
@@ -8383,7 +8589,8 @@
|
||||
"internal",
|
||||
"issuedCard",
|
||||
"migration",
|
||||
"platformPayment"
|
||||
"platformPayment",
|
||||
"upgrade"
|
||||
],
|
||||
"type" : "string"
|
||||
},
|
||||
@@ -8701,7 +8908,6 @@
|
||||
"items" : {
|
||||
"enum" : [
|
||||
"crossBorder",
|
||||
"directDebit",
|
||||
"fast",
|
||||
"instant",
|
||||
"internal",
|
||||
@@ -8717,16 +8923,19 @@
|
||||
"enum" : [
|
||||
"amountLimitExceeded",
|
||||
"approved",
|
||||
"balanceAccountTemporarilyBlockedByTransactionRule",
|
||||
"counterpartyAccountBlocked",
|
||||
"counterpartyAccountClosed",
|
||||
"counterpartyAccountNotFound",
|
||||
"counterpartyAddressRequired",
|
||||
"counterpartyBankTimedOut",
|
||||
"counterpartyBankUnavailable",
|
||||
"declinedByTransactionRule",
|
||||
"error",
|
||||
"notEnoughBalance",
|
||||
"refusedByCounterpartyBank",
|
||||
"routeNotFound",
|
||||
"scaFailed",
|
||||
"unknown"
|
||||
],
|
||||
"readOnly" : true,
|
||||
@@ -9227,6 +9436,15 @@
|
||||
"enabled" : true,
|
||||
"requested" : true,
|
||||
"allowed" : false,
|
||||
"transferInstruments" : [
|
||||
{
|
||||
"enabled" : true,
|
||||
"requested" : true,
|
||||
"allowed" : false,
|
||||
"id" : "SE322KH223222F5GXZFNM3BGP",
|
||||
"verificationStatus" : "pending"
|
||||
}
|
||||
],
|
||||
"verificationStatus" : "pending"
|
||||
}
|
||||
},
|
||||
@@ -9234,6 +9452,14 @@
|
||||
"status" : "active"
|
||||
}
|
||||
},
|
||||
"get-accountHolders-id-taxForms-success-200" : {
|
||||
"summary" : "Tax form retrieved for an account holder",
|
||||
"description" : "Example response when retrieving a tax form for an account holder",
|
||||
"value" : {
|
||||
"content" : "JVBERi0xLjcKJcfsj6IKJSVJbnZvY2F0aW9uOiBwYXRoL2dzd2luNjQuZXhlIC1kRGlzcGxh",
|
||||
"contentType" : "application/pdf"
|
||||
}
|
||||
},
|
||||
"get-balanceAccounts-balanceAccountId-sweeps-success-200" : {
|
||||
"summary" : "Sweeps under a balance account retrieved",
|
||||
"description" : "Example response when retrieving sweeps under a balance account",
|
||||
|
||||
@@ -19,7 +19,11 @@ x-groups:
|
||||
- Balance account
|
||||
- Payment instrument
|
||||
- Card order
|
||||
tags: []
|
||||
tags:
|
||||
- name: Account holder
|
||||
- name: Balance account
|
||||
- name: Payment instrument
|
||||
- name: Card order
|
||||
x-staticResponse: response.json
|
||||
webhooks:
|
||||
balancePlatform.accountHolder.created:
|
||||
@@ -490,12 +494,6 @@ components:
|
||||
description: A JSON object containing the settings that were requested for
|
||||
the account holder.
|
||||
$ref: '#/components/schemas/CapabilitySettings'
|
||||
transferInstruments:
|
||||
description: 'Contains the status of the transfer instruments associated
|
||||
with this capability. '
|
||||
items:
|
||||
$ref: '#/components/schemas/AccountSupportingEntityCapability'
|
||||
type: array
|
||||
verificationStatus:
|
||||
description: 'The status of the verification checks for the capability.
|
||||
|
||||
@@ -556,79 +554,6 @@ components:
|
||||
- type
|
||||
- data
|
||||
type: object
|
||||
AccountSupportingEntityCapability:
|
||||
properties:
|
||||
allowed:
|
||||
description: Indicates whether the supporting entity capability is allowed.
|
||||
Adyen sets this to **true** if the verification is successful and the
|
||||
account holder is permitted to use the capability.
|
||||
type: boolean
|
||||
allowedLevel:
|
||||
description: 'The capability level that is allowed for the account holder.
|
||||
|
||||
|
||||
Possible values: **notApplicable**, **low**, **medium**, **high**.'
|
||||
enum:
|
||||
- high
|
||||
- low
|
||||
- medium
|
||||
- notApplicable
|
||||
type: string
|
||||
enabled:
|
||||
description: Indicates whether the capability is enabled. If **false**,
|
||||
the capability is temporarily disabled for the account holder.
|
||||
type: boolean
|
||||
id:
|
||||
description: The ID of the supporting entity.
|
||||
type: string
|
||||
requested:
|
||||
description: Indicates whether the capability is requested. To check whether
|
||||
the account holder is permitted to use the capability, refer to the `allowed`
|
||||
field.
|
||||
type: boolean
|
||||
requestedLevel:
|
||||
description: 'The requested level of the capability. Some capabilities,
|
||||
such as those used in [card issuing](https://docs.adyen.com/issuing/add-capabilities#capability-levels),
|
||||
have different levels. Levels increase the capability, but also require
|
||||
additional checks and increased monitoring.
|
||||
|
||||
|
||||
Possible values: **notApplicable**, **low**, **medium**, **high**.'
|
||||
enum:
|
||||
- high
|
||||
- low
|
||||
- medium
|
||||
- notApplicable
|
||||
type: string
|
||||
verificationStatus:
|
||||
description: 'The status of the verification checks for the supporting entity
|
||||
capability.
|
||||
|
||||
|
||||
Possible values:
|
||||
|
||||
|
||||
* **pending**: Adyen is running the verification.
|
||||
|
||||
|
||||
* **invalid**: The verification failed. Check if the `errors` array contains
|
||||
more information.
|
||||
|
||||
|
||||
* **valid**: The verification has been successfully completed.
|
||||
|
||||
|
||||
* **rejected**: Adyen has verified the information, but found reasons
|
||||
to not allow the capability.
|
||||
|
||||
'
|
||||
enum:
|
||||
- invalid
|
||||
- pending
|
||||
- rejected
|
||||
- valid
|
||||
type: string
|
||||
type: object
|
||||
Address:
|
||||
properties:
|
||||
city:
|
||||
@@ -763,7 +688,9 @@ components:
|
||||
description: 'The default three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes)
|
||||
of the balance account.
|
||||
|
||||
The default value is **EUR**.'
|
||||
The default value is **EUR**.
|
||||
|
||||
> After a balance account is created, you cannot change its default currency.'
|
||||
type: string
|
||||
description:
|
||||
description: A human-readable description of the balance account, maximum
|
||||
@@ -1472,7 +1399,7 @@ components:
|
||||
PlatformPaymentConfiguration:
|
||||
properties:
|
||||
salesDayClosingTime:
|
||||
description: 'Specifies at what time a [sales day](https://docs.adyen.com/marketplaces-and-platforms/receive-funds/sales-day-settlement#sales-day)
|
||||
description: 'Specifies at what time a [sales day](https://docs.adyen.com/marketplaces-and-platforms/settle-funds/sales-day-settlement#sales-day)
|
||||
ends.
|
||||
|
||||
|
||||
@@ -1485,15 +1412,15 @@ components:
|
||||
type: string
|
||||
settlementDelayDays:
|
||||
description: 'Specifies after how many business days the funds in a [settlement
|
||||
batch](https://docs.adyen.com/marketplaces-and-platforms/receive-funds/sales-day-settlement#settlement-batch)
|
||||
batch](https://docs.adyen.com/marketplaces-and-platforms/settle-funds/sales-day-settlement#settlement-batch)
|
||||
are made available.
|
||||
|
||||
|
||||
Possible values: **0** to **10**, or **null**.
|
||||
|
||||
* Setting this value to an integer enables [Sales day settlement](https://docs.adyen.com/marketplaces-and-platforms/receive-funds/sales-day-settlement).
|
||||
* Setting this value to an integer enables [Sales day settlement](https://docs.adyen.com/marketplaces-and-platforms/settle-funds/sales-day-settlement).
|
||||
|
||||
* Setting this value to **null** enables [Pass-through settlement](https://docs.adyen.com/marketplaces-and-platforms/receive-funds/pass-through-settlement).
|
||||
* Setting this value to **null** enables [Pass-through settlement](https://docs.adyen.com/marketplaces-and-platforms/settle-funds/pass-through-settlement).
|
||||
|
||||
|
||||
Default value: **null**.'
|
||||
@@ -1593,16 +1520,19 @@ components:
|
||||
enum:
|
||||
- amountLimitExceeded
|
||||
- approved
|
||||
- balanceAccountTemporarilyBlockedByTransactionRule
|
||||
- counterpartyAccountBlocked
|
||||
- counterpartyAccountClosed
|
||||
- counterpartyAccountNotFound
|
||||
- counterpartyAddressRequired
|
||||
- counterpartyBankTimedOut
|
||||
- counterpartyBankUnavailable
|
||||
- declinedByTransactionRule
|
||||
- error
|
||||
- notEnoughBalance
|
||||
- refusedByCounterpartyBank
|
||||
- routeNotFound
|
||||
- scaFailed
|
||||
- unknown
|
||||
type: string
|
||||
schedule:
|
||||
@@ -1986,6 +1916,12 @@ components:
|
||||
enabled: true
|
||||
requested: true
|
||||
allowed: false
|
||||
transferInstruments:
|
||||
- enabled: true
|
||||
requested: true
|
||||
allowed: false
|
||||
id: SE576BH223222F5GJVKHH6BDT
|
||||
verificationStatus: pending
|
||||
verificationStatus: pending
|
||||
sendToBalanceAccount:
|
||||
enabled: true
|
||||
@@ -2018,15 +1954,26 @@ components:
|
||||
allowed: false
|
||||
problems:
|
||||
- entity:
|
||||
id: LE43319330319C8AYX89L2V59
|
||||
type: LegalEntity
|
||||
id: SE3222Z223222Q5J4D58K3DWP
|
||||
type: BankAccount
|
||||
verificationErrors:
|
||||
- code: '2_8037'
|
||||
message: No bankStatement available to perform verification.
|
||||
message: '''bankStatement'' was missing.'
|
||||
remediatingActions:
|
||||
- code: '1_703'
|
||||
message: Upload a bank statement
|
||||
type: dataMissing
|
||||
transferInstruments:
|
||||
- enabled: true
|
||||
requested: true
|
||||
allowed: true
|
||||
id: SE576BH223222F5GJVKHH6BDT
|
||||
verificationStatus: valid
|
||||
- enabled: true
|
||||
requested: true
|
||||
allowed: false
|
||||
id: SE3222Z223222Q5J4D58K3DWP
|
||||
verificationStatus: invalid
|
||||
verificationStatus: invalid
|
||||
id: AH32272223222B5CZW6QZ2V34
|
||||
status: Active
|
||||
|
||||
@@ -15,7 +15,8 @@ info:
|
||||
url: https://github.com/Adyen/adyen-openapi
|
||||
x-groups:
|
||||
- General
|
||||
tags: []
|
||||
tags:
|
||||
- name: General
|
||||
webhooks:
|
||||
balancePlatform.report.created:
|
||||
post:
|
||||
|
||||
@@ -38,15 +38,15 @@ x-groups:
|
||||
- Transfer routes
|
||||
tags:
|
||||
- name: Platform
|
||||
- name: Grant offers
|
||||
- name: Payment instrument groups
|
||||
- name: Network tokens
|
||||
- name: Account holders
|
||||
- name: Payment instruments
|
||||
- name: Grant accounts
|
||||
- name: Bank account validation
|
||||
- name: Balance accounts
|
||||
- name: Payment instruments
|
||||
- name: Payment instrument groups
|
||||
- name: Transaction rules
|
||||
- name: Bank account validation
|
||||
- name: Network tokens
|
||||
- name: Grant accounts
|
||||
- name: Grant offers
|
||||
- name: Transfer routes
|
||||
paths:
|
||||
/accountHolders:
|
||||
@@ -387,6 +387,103 @@ paths:
|
||||
schema:
|
||||
$ref: '#/components/schemas/RestServiceError'
|
||||
description: Internal Server Error - the server could not process the request.
|
||||
/accountHolders/{id}/taxForms:
|
||||
get:
|
||||
tags:
|
||||
- Account holders
|
||||
summary: Get a tax form
|
||||
description: Generates a tax form for account holders operating in the US. For
|
||||
more information, refer to [Providing tax forms](https://docs.adyen.com/marketplaces-and-platforms/us-tax-forms/).
|
||||
x-addedInVersion: '2'
|
||||
operationId: get-accountHolders-id-taxForms
|
||||
x-groupName: Account holders
|
||||
x-sortIndex: 5
|
||||
x-methodName: getTaxForm
|
||||
security:
|
||||
- BasicAuth: []
|
||||
- ApiKeyAuth: []
|
||||
parameters:
|
||||
- description: The unique identifier of the account holder.
|
||||
name: id
|
||||
in: path
|
||||
required: true
|
||||
schema:
|
||||
type: string
|
||||
- description: The type of tax form you want to retrieve. Accepted values are
|
||||
**us1099k** and **us1099nec**
|
||||
name: formType
|
||||
in: query
|
||||
required: true
|
||||
schema:
|
||||
x-enum:
|
||||
- value: US1099k
|
||||
- value: US1099nec
|
||||
enum:
|
||||
- US1099k
|
||||
- US1099nec
|
||||
type: string
|
||||
- description: The tax year in YYYY format for the tax form you want to retrieve
|
||||
name: year
|
||||
in: query
|
||||
required: true
|
||||
schema:
|
||||
format: int32
|
||||
type: integer
|
||||
responses:
|
||||
'200':
|
||||
content:
|
||||
application/json:
|
||||
examples:
|
||||
success:
|
||||
$ref: '#/components/examples/get-accountHolders-id-taxForms-success-200'
|
||||
schema:
|
||||
$ref: '#/components/schemas/GetTaxFormResponse'
|
||||
description: OK - the request has succeeded.
|
||||
'400':
|
||||
content:
|
||||
application/json:
|
||||
examples:
|
||||
generic:
|
||||
$ref: '#/components/examples/generic-400'
|
||||
schema:
|
||||
$ref: '#/components/schemas/RestServiceError'
|
||||
description: Bad Request - a problem reading or understanding the request.
|
||||
'401':
|
||||
content:
|
||||
application/json:
|
||||
examples:
|
||||
generic:
|
||||
$ref: '#/components/examples/generic-401'
|
||||
schema:
|
||||
$ref: '#/components/schemas/RestServiceError'
|
||||
description: Unauthorized - authentication required.
|
||||
'403':
|
||||
content:
|
||||
application/json:
|
||||
examples:
|
||||
generic:
|
||||
$ref: '#/components/examples/generic-403'
|
||||
schema:
|
||||
$ref: '#/components/schemas/RestServiceError'
|
||||
description: Forbidden - insufficient permissions to process the request.
|
||||
'422':
|
||||
content:
|
||||
application/json:
|
||||
examples:
|
||||
generic:
|
||||
$ref: '#/components/examples/generic-422'
|
||||
schema:
|
||||
$ref: '#/components/schemas/RestServiceError'
|
||||
description: Unprocessable Entity - a request validation error.
|
||||
'500':
|
||||
content:
|
||||
application/json:
|
||||
examples:
|
||||
generic:
|
||||
$ref: '#/components/examples/generic-500'
|
||||
schema:
|
||||
$ref: '#/components/schemas/RestServiceError'
|
||||
description: Internal Server Error - the server could not process the request.
|
||||
/balanceAccounts:
|
||||
post:
|
||||
tags:
|
||||
@@ -686,7 +783,7 @@ paths:
|
||||
responses:
|
||||
'204':
|
||||
description: 'No Content - look at the actual response code for the status
|
||||
of the request '
|
||||
of the request. '
|
||||
'400':
|
||||
content:
|
||||
application/json:
|
||||
@@ -1639,7 +1736,7 @@ paths:
|
||||
responses:
|
||||
'202':
|
||||
description: 'No Content - look at the actual response code for the status
|
||||
of the request '
|
||||
of the request. '
|
||||
'401':
|
||||
content:
|
||||
application/json:
|
||||
@@ -2828,7 +2925,7 @@ paths:
|
||||
responses:
|
||||
'200':
|
||||
description: 'No Content - look at the actual response code for the status
|
||||
of the request '
|
||||
of the request. '
|
||||
'401':
|
||||
content:
|
||||
application/json:
|
||||
@@ -3048,6 +3145,7 @@ components:
|
||||
readOnly: true
|
||||
$ref: '#/components/schemas/CapabilitySettings'
|
||||
transferInstruments:
|
||||
x-addedInVersion: '2'
|
||||
description: 'Contains the status of the transfer instruments associated
|
||||
with this capability. '
|
||||
items:
|
||||
@@ -3531,7 +3629,9 @@ components:
|
||||
description: 'The default three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes)
|
||||
of the balance account.
|
||||
|
||||
The default value is **EUR**.'
|
||||
The default value is **EUR**.
|
||||
|
||||
> After a balance account is created, you cannot change its default currency.'
|
||||
type: string
|
||||
description:
|
||||
description: A human-readable description of the balance account, maximum
|
||||
@@ -3595,7 +3695,9 @@ components:
|
||||
description: 'The default three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes)
|
||||
of the balance account.
|
||||
|
||||
The default value is **EUR**.'
|
||||
The default value is **EUR**.
|
||||
|
||||
> After a balance account is created, you cannot change its default currency.'
|
||||
type: string
|
||||
description:
|
||||
description: A human-readable description of the balance account, maximum
|
||||
@@ -3659,7 +3761,9 @@ components:
|
||||
description: 'The default three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes)
|
||||
of the balance account.
|
||||
|
||||
The default value is **EUR**.'
|
||||
The default value is **EUR**.
|
||||
|
||||
> After a balance account is created, you cannot change its default currency.'
|
||||
type: string
|
||||
description:
|
||||
description: A human-readable description of the balance account, maximum
|
||||
@@ -3706,11 +3810,6 @@ components:
|
||||
description: The unique identifier of the [account holder](https://docs.adyen.com/api-explorer/#/balanceplatform/latest/post/accountHolders__resParam_id)
|
||||
associated with the balance account.
|
||||
type: string
|
||||
defaultCurrencyCode:
|
||||
description: "The default currency code of this balance account, in three-character\
|
||||
\ [ISO currency code](https://docs.adyen.com/development-resources/currency-codes)\
|
||||
\ format. \nThe default value is **EUR**."
|
||||
type: string
|
||||
description:
|
||||
description: A human-readable description of the balance account, maximum
|
||||
300 characters. You can use this parameter to distinguish between multiple
|
||||
@@ -3882,6 +3981,18 @@ components:
|
||||
required:
|
||||
- accountIdentification
|
||||
type: object
|
||||
BankIdentification:
|
||||
properties:
|
||||
country:
|
||||
type: string
|
||||
identification:
|
||||
type: string
|
||||
identificationType:
|
||||
enum:
|
||||
- iban
|
||||
- routingNumber
|
||||
type: string
|
||||
type: object
|
||||
BrandVariantsRestriction:
|
||||
properties:
|
||||
operation:
|
||||
@@ -4378,6 +4489,19 @@ components:
|
||||
description: Unique identifier of the [transfer instrument](https://docs.adyen.com/api-explorer/#/legalentity/latest/post/transferInstruments__resParam_id).
|
||||
type: string
|
||||
type: object
|
||||
CounterpartyBankRestriction:
|
||||
properties:
|
||||
operation:
|
||||
description: Defines how the condition must be evaluated.
|
||||
type: string
|
||||
value:
|
||||
description: List of counterparty Bank Institutions and the operation.
|
||||
items:
|
||||
$ref: '#/components/schemas/BankIdentification'
|
||||
type: array
|
||||
required:
|
||||
- operation
|
||||
type: object
|
||||
CountriesRestriction:
|
||||
properties:
|
||||
operation:
|
||||
@@ -4466,7 +4590,6 @@ components:
|
||||
items:
|
||||
enum:
|
||||
- crossBorder
|
||||
- directDebit
|
||||
- fast
|
||||
- instant
|
||||
- internal
|
||||
@@ -4479,16 +4602,19 @@ components:
|
||||
enum:
|
||||
- amountLimitExceeded
|
||||
- approved
|
||||
- balanceAccountTemporarilyBlockedByTransactionRule
|
||||
- counterpartyAccountBlocked
|
||||
- counterpartyAccountClosed
|
||||
- counterpartyAccountNotFound
|
||||
- counterpartyAddressRequired
|
||||
- counterpartyBankTimedOut
|
||||
- counterpartyBankUnavailable
|
||||
- declinedByTransactionRule
|
||||
- error
|
||||
- notEnoughBalance
|
||||
- refusedByCounterpartyBank
|
||||
- routeNotFound
|
||||
- scaFailed
|
||||
- unknown
|
||||
readOnly: true
|
||||
type: string
|
||||
@@ -4811,6 +4937,28 @@ components:
|
||||
required:
|
||||
- token
|
||||
type: object
|
||||
GetTaxFormResponse:
|
||||
properties:
|
||||
content:
|
||||
description: The content of the tax form in Base64 format.
|
||||
format: byte
|
||||
type: string
|
||||
contentType:
|
||||
description: 'The content type of the tax form.
|
||||
|
||||
|
||||
Possible values:
|
||||
|
||||
* **application/pdf**
|
||||
|
||||
|
||||
'
|
||||
enum:
|
||||
- application/pdf
|
||||
type: string
|
||||
required:
|
||||
- content
|
||||
type: object
|
||||
GrantLimit:
|
||||
properties:
|
||||
amount:
|
||||
@@ -4865,9 +5013,9 @@ components:
|
||||
additionalProperties: false
|
||||
properties:
|
||||
accountNumber:
|
||||
description: The 9- to 12-character bank account number (alphanumeric),
|
||||
description: The 9- to 15-character bank account number (alphanumeric),
|
||||
without separators or whitespace. Starts with the 3-digit branch code.
|
||||
maxLength: 12
|
||||
maxLength: 15
|
||||
minLength: 9
|
||||
type: string
|
||||
clearingCode:
|
||||
@@ -5068,20 +5216,11 @@ components:
|
||||
additionalProperties: false
|
||||
properties:
|
||||
accountNumber:
|
||||
description: The 7-digit bank account number, without separators or whitespace.
|
||||
maxLength: 7
|
||||
minLength: 7
|
||||
type: string
|
||||
accountSuffix:
|
||||
description: The 2- to 3-digit account suffix, without separators or whitespace.
|
||||
maxLength: 3
|
||||
minLength: 2
|
||||
type: string
|
||||
bankCode:
|
||||
description: The 6-digit bank code including the 2-digit bank code and 4-digit
|
||||
branch code, without separators or whitespace.
|
||||
maxLength: 6
|
||||
minLength: 6
|
||||
description: The 15-16 digit bank account number. The first 2 digits are
|
||||
the bank number, the next 4 digits are the branch number, the next 7 digits
|
||||
are the account number, and the final 2-3 digits are the suffix.
|
||||
maxLength: 16
|
||||
minLength: 15
|
||||
type: string
|
||||
type:
|
||||
default: nzLocal
|
||||
@@ -5092,8 +5231,6 @@ components:
|
||||
required:
|
||||
- type
|
||||
- accountNumber
|
||||
- accountSuffix
|
||||
- bankCode
|
||||
type: object
|
||||
Name:
|
||||
properties:
|
||||
@@ -5486,6 +5623,10 @@ components:
|
||||
description: The two-character ISO-3166-1 alpha-2 country code of the counterparty.
|
||||
For example, **US** or **NL**.
|
||||
type: string
|
||||
onlyForCrossBalancePlatform:
|
||||
description: Specifies if the requirement only applies to transfers to another
|
||||
balance platform.
|
||||
type: boolean
|
||||
paymentInstrumentType:
|
||||
description: The type of the payment instrument. For example, "BankAccount"
|
||||
or "Card".
|
||||
@@ -5620,7 +5761,7 @@ components:
|
||||
PlatformPaymentConfiguration:
|
||||
properties:
|
||||
salesDayClosingTime:
|
||||
description: 'Specifies at what time a [sales day](https://docs.adyen.com/marketplaces-and-platforms/receive-funds/sales-day-settlement#sales-day)
|
||||
description: 'Specifies at what time a [sales day](https://docs.adyen.com/marketplaces-and-platforms/settle-funds/sales-day-settlement#sales-day)
|
||||
ends.
|
||||
|
||||
|
||||
@@ -5633,15 +5774,15 @@ components:
|
||||
type: string
|
||||
settlementDelayDays:
|
||||
description: 'Specifies after how many business days the funds in a [settlement
|
||||
batch](https://docs.adyen.com/marketplaces-and-platforms/receive-funds/sales-day-settlement#settlement-batch)
|
||||
batch](https://docs.adyen.com/marketplaces-and-platforms/settle-funds/sales-day-settlement#settlement-batch)
|
||||
are made available.
|
||||
|
||||
|
||||
Possible values: **0** to **10**, or **null**.
|
||||
|
||||
* Setting this value to an integer enables [Sales day settlement](https://docs.adyen.com/marketplaces-and-platforms/receive-funds/sales-day-settlement).
|
||||
* Setting this value to an integer enables [Sales day settlement](https://docs.adyen.com/marketplaces-and-platforms/settle-funds/sales-day-settlement).
|
||||
|
||||
* Setting this value to **null** enables [Pass-through settlement](https://docs.adyen.com/marketplaces-and-platforms/receive-funds/pass-through-settlement).
|
||||
* Setting this value to **null** enables [Pass-through settlement](https://docs.adyen.com/marketplaces-and-platforms/settle-funds/pass-through-settlement).
|
||||
|
||||
|
||||
Default value: **null**.'
|
||||
@@ -5903,7 +6044,6 @@ components:
|
||||
items:
|
||||
enum:
|
||||
- crossBorder
|
||||
- directDebit
|
||||
- fast
|
||||
- instant
|
||||
- internal
|
||||
@@ -5916,16 +6056,19 @@ components:
|
||||
enum:
|
||||
- amountLimitExceeded
|
||||
- approved
|
||||
- balanceAccountTemporarilyBlockedByTransactionRule
|
||||
- counterpartyAccountBlocked
|
||||
- counterpartyAccountClosed
|
||||
- counterpartyAccountNotFound
|
||||
- counterpartyAddressRequired
|
||||
- counterpartyBankTimedOut
|
||||
- counterpartyBankUnavailable
|
||||
- declinedByTransactionRule
|
||||
- error
|
||||
- notEnoughBalance
|
||||
- refusedByCounterpartyBank
|
||||
- routeNotFound
|
||||
- scaFailed
|
||||
- unknown
|
||||
readOnly: true
|
||||
type: string
|
||||
@@ -6467,6 +6610,10 @@ components:
|
||||
|
||||
Supported operations: **anyMatch**, **noneMatch**.'
|
||||
$ref: '#/components/schemas/BrandVariantsRestriction'
|
||||
counterpartyBank:
|
||||
description: 'List of counterparty Institutions and the operation. Supported
|
||||
operations: **anyMatch**, **noneMatch**.'
|
||||
$ref: '#/components/schemas/CounterpartyBankRestriction'
|
||||
countries:
|
||||
description: 'List of countries and the operation.
|
||||
|
||||
@@ -6551,10 +6698,6 @@ components:
|
||||
type: object
|
||||
TransferRoute:
|
||||
properties:
|
||||
balancePlatform:
|
||||
description: The unique identifier assigned to the balance platform associated
|
||||
with the account holder.
|
||||
type: string
|
||||
category:
|
||||
description: " The type of transfer.\n\n Possible values:\n\n - **bank**:\
|
||||
\ Transfer to a [transfer instrument](https://docs.adyen.com/api-explorer/#/legalentity/latest/post/transferInstruments__resParam_id)\
|
||||
@@ -6567,6 +6710,7 @@ components:
|
||||
- issuedCard
|
||||
- migration
|
||||
- platformPayment
|
||||
- upgrade
|
||||
type: string
|
||||
country:
|
||||
description: The two-character ISO-3166-1 alpha-2 country code of the counterparty.
|
||||
@@ -6948,7 +7092,6 @@ components:
|
||||
items:
|
||||
enum:
|
||||
- crossBorder
|
||||
- directDebit
|
||||
- fast
|
||||
- instant
|
||||
- internal
|
||||
@@ -6961,16 +7104,19 @@ components:
|
||||
enum:
|
||||
- amountLimitExceeded
|
||||
- approved
|
||||
- balanceAccountTemporarilyBlockedByTransactionRule
|
||||
- counterpartyAccountBlocked
|
||||
- counterpartyAccountClosed
|
||||
- counterpartyAccountNotFound
|
||||
- counterpartyAddressRequired
|
||||
- counterpartyBankTimedOut
|
||||
- counterpartyBankUnavailable
|
||||
- declinedByTransactionRule
|
||||
- error
|
||||
- notEnoughBalance
|
||||
- refusedByCounterpartyBank
|
||||
- routeNotFound
|
||||
- scaFailed
|
||||
- unknown
|
||||
readOnly: true
|
||||
type: string
|
||||
@@ -7420,9 +7566,21 @@ components:
|
||||
enabled: true
|
||||
requested: true
|
||||
allowed: false
|
||||
transferInstruments:
|
||||
- enabled: true
|
||||
requested: true
|
||||
allowed: false
|
||||
id: SE322KH223222F5GXZFNM3BGP
|
||||
verificationStatus: pending
|
||||
verificationStatus: pending
|
||||
id: AH3227C223222C5GXQXF658WB
|
||||
status: active
|
||||
get-accountHolders-id-taxForms-success-200:
|
||||
summary: Tax form retrieved for an account holder
|
||||
description: Example response when retrieving a tax form for an account holder
|
||||
value:
|
||||
content: JVBERi0xLjcKJcfsj6IKJSVJbnZvY2F0aW9uOiBwYXRoL2dzd2luNjQuZXhlIC1kRGlzcGxh
|
||||
contentType: application/pdf
|
||||
get-balanceAccounts-balanceAccountId-sweeps-success-200:
|
||||
summary: Sweeps under a balance account retrieved
|
||||
description: Example response when retrieving sweeps under a balance account
|
||||
|
||||
Reference in New Issue
Block a user