jlengrand/adyen-openapi
1
0
Fork 0
mirror of https://github.com/gcatanese/adyen-openapi.git synced 2026-03-10 08:01:24 +00:00
Code Issues Packages Projects Releases Wiki Activity

spec release

Browse Source
This commit is contained in:
Adyen Automation
2023-01-10 12:11:49 +00:00
parent 81726ee11f
commit d938ef827e
10 changed files with 1302 additions and 134 deletions
Download Patch File Download Diff File Expand all files Collapse all files

521
json/BalancePlatformAccountingNotification-v1.json Normal file
View File

@@ -0,0 +1,521 @@
{
"openapi" : "3.1.0",
"info" : {
"version" : "1",
"x-publicVersion" : true,
"title" : "Accounting notifications",
"description" : "Adyen sends notifications through webhooks to inform your system about incoming and outgoing transfers in your platform.\n\nYou can use these webhooks to build your implementation. For example, you can use this information to update balances in your own dashboards or to keep track of incoming funds.",
"x-timestamp" : "2022-11-24T11:24:01Z",
"termsOfService" : "https://www.adyen.com/legal/terms-and-conditions",
"contact" : {
"name" : "Adyen Developer Experience team",
"url" : "https://www.adyen.help/hc/en-us/community/topics",
"email" : "developer-experience@adyen.com"
}
},
"x-groups" : [
"General"
],
"tags" : [
],
"x-staticResponse" : "response.json",
"webhooks" : {
"balancePlatform.transfer.created" : {
"post" : {
"tags" : [
"General"
],
"summary" : "Transfer created",
"description" : "Adyen sends this webhook when there are fund movements on your platform.",
"x-addedInVersion" : "1",
"operationId" : "post-balancePlatform.transfer.created",
"x-groupName" : "General",
"x-sortIndex" : 0,
"x-methodName" : "transferCreated",
"security" : [
{
"ApiKeyAuth" : [
]
}
],
"requestBody" : {
"content" : {
"application/json" : {
"examples" : {
"balancePlatform-transfer-created" : {
"$ref" : "#/components/examples/post-balancePlatform.transfer.created-balancePlatform-transfer-created"
}
},
"schema" : {
"$ref" : "#/components/schemas/TransferNotificationRequest"
}
}
}
},
"responses" : {
"200" : {
"content" : {
"application/json" : {
"examples" : {
"balancePlatform-transfer-created" : {
"$ref" : "#/components/examples/WebhookAck"
}
},
"schema" : {
"$ref" : "#/components/schemas/BalancePlatformNotificationResponse"
}
}
},
"description" : "OK - the request has succeeded."
}
}
}
},
"balancePlatform.transfer.updated" : {
"post" : {
"tags" : [
"General"
],
"summary" : "Transfer updated",
"description" : "Adyen sends this webhook when the status of a transfer changes. Use the `data.id` to track the original transfer resource in the [balancePlatform.transfer.created](https://docs.adyen.com/api-explorer/accounting-webhooks/1/post/balancePlatform.transfer.created) webhook.\n\nThe `status` field indicates the event that triggered the webhook. \n\n",
"x-addedInVersion" : "1",
"operationId" : "post-balancePlatform.transfer.updated",
"x-groupName" : "General",
"x-sortIndex" : 0,
"x-methodName" : "transferUpdated",
"security" : [
{
"ApiKeyAuth" : [
]
}
],
"requestBody" : {
"content" : {
"application/json" : {
"examples" : {
"balancePlatform-transfer-updated" : {
"$ref" : "#/components/examples/post-balancePlatform.transfer.updated-balancePlatform-transfer-updated"
}
},
"schema" : {
"$ref" : "#/components/schemas/TransferNotificationRequest"
}
}
}
},
"responses" : {
"200" : {
"content" : {
"application/json" : {
"examples" : {
"balancePlatform-transfer-updated" : {
"$ref" : "#/components/examples/WebhookAck"
}
},
"schema" : {
"$ref" : "#/components/schemas/BalancePlatformNotificationResponse"
}
}
},
"description" : "OK - the request has succeeded."
}
}
}
}
},
"components" : {
"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"
]
},
"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"
]
},
"BalancePlatformNotificationResponse" : {
"properties" : {
"notificationResponse" : {
"description" : "Respond with **HTTP 200 OK** and `[accepted]` in the response body to [accept the webhook](https://docs.adyen.com/development-resources/webhooks#accept-notifications).",
"type" : "string"
}
}
},
"Bank" : {
"properties" : {
"priority" : {
"x-addedInVersion" : "1",
"description" : "The priority for the bank transfer. This sets the speed at which the transfer is sent and the fees that you have to pay. If you don't provide this in the request, Adyen sets the optimal priority.\n\nPossible values:\n\n* **regular**: For normal, low-value transactions.\n\n* **fast**: Faster way to transfer funds but has higher fees. Recommended for high-priority, low-value transactions.\n\n* **wire**: Fastest way to transfer funds but has the highest fees. Recommended for high-priority, high-value transactions.\n\n* **instant**: Instant way to transfer funds in [SEPA countries](https://www.ecb.europa.eu/paym/integration/retail/sepa/html/index.en.html).",
"enum" : [
"fast",
"instant",
"regular",
"wire"
],
"type" : "string"
}
}
},
"BankAccountInfo" : {
"properties" : {
"address" : {
"description" : "The address of the bank account owner.",
"$ref" : "#/components/schemas/Address"
},
"iban" : {
"description" : "The international bank account number as defined in the [ISO-13616](https://www.iso.org/standard/81090.html) standard.",
"type" : "string"
},
"ownerName" : {
"description" : "The name of the bank account owner.",
"$ref" : "#/components/schemas/Name"
}
}
},
"Counterparty" : {
"properties" : {
"balanceAccountId" : {
"description" : "Unique identifier of the [balance account](https://docs.adyen.com/api-explorer/#/balanceplatform/latest/post/balanceAccounts__resParam_id).",
"type" : "string"
},
"bankAccount" : {
"description" : "Contains information about the bank account.",
"$ref" : "#/components/schemas/BankAccountInfo"
},
"merchant" : {
"description" : "Contains information about the merchant.",
"$ref" : "#/components/schemas/MerchantData"
},
"transferInstrumentId" : {
"description" : "Unique identifier of the [transfer instrument](https://docs.adyen.com/api-explorer/#/balanceplatform/latest/post/transferInstruments__resParam_id).",
"type" : "string"
}
}
},
"MerchantData" : {
"properties" : {
"mcc" : {
"description" : "The merchant category code.",
"type" : "string"
},
"merchantId" : {
"description" : "The merchant identifier.",
"type" : "string"
},
"nameLocation" : {
"description" : "Contains the merchant's name and location.",
"$ref" : "#/components/schemas/NameLocation"
},
"postalCode" : {
"description" : "The merchant postal code.",
"type" : "string"
}
}
},
"Name" : {
"properties" : {
"firstName" : {
"description" : "The first name.",
"type" : "string"
},
"fullName" : {
"description" : "The full name.",
"type" : "string"
},
"infix" : {
"description" : "The infix in the name, if any.",
"type" : "string"
},
"lastName" : {
"description" : "The last name.",
"type" : "string"
}
}
},
"NameLocation" : {
"properties" : {
"city" : {
"description" : "The city where the merchant is located.",
"type" : "string"
},
"country" : {
"description" : "The country where the merchant is located in [three-letter country code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3) format.",
"type" : "string"
},
"countryOfOrigin" : {
"description" : "The home country in [three-digit country code](https://en.wikipedia.org/wiki/ISO_3166-1_numeric) format, used for government-controlled merchants such as embassies.",
"type" : "string"
},
"name" : {
"description" : "The name of the merchant's shop or service.",
"type" : "string"
},
"rawData" : {
"description" : "The raw data.",
"type" : "string"
},
"state" : {
"description" : "The state where the merchant is located.",
"type" : "string"
}
}
},
"Resource" : {
"properties" : {
"balancePlatform" : {
"description" : "Unique identifier of the balance platform.",
"type" : "string"
},
"creationDate" : {
"description" : "Date and time when the event was triggered, in ISO 8601 extended format. For example, **2020-12-18T10:15:30+01:00**.",
"format" : "date-time",
"type" : "string"
},
"id" : {
"description" : "The ID of the resource.",
"type" : "string"
}
}
},
"Transfer" : {
"properties" : {
"amount" : {
"x-addedInVersion" : "1",
"description" : "The amount of the transfer.",
"$ref" : "#/components/schemas/Amount"
},
"balanceAccountId" : {
"description" : "Unique identifier of the source [balance account](https://docs.adyen.com/api-explorer/#/balanceplatform/latest/post/balanceAccounts__resParam_id).",
"type" : "string"
},
"bank" : {
"x-addedInVersion" : "1",
"description" : "Contains settings for bank transfers. If you are transferring funds to bank accounts and you don't provide this object, Adyen applies default settings.",
"$ref" : "#/components/schemas/Bank"
},
"counterparty" : {
"description" : "The other party in the transfer.",
"$ref" : "#/components/schemas/Counterparty"
},
"description" : {
"x-addedInVersion" : "1",
"description" : "A human-readable description for the transfer. You can use alphanumeric characters and hyphens. We recommend sending a maximum of 140 characters, otherwise the description may be truncated.",
"type" : "string"
},
"id" : {
"description" : "The ID of the resource.",
"type" : "string"
},
"paymentInstrumentId" : {
"description" : "Unique identifier of the source [payment instrument](https://docs.adyen.com/api-explorer/#/balanceplatform/latest/post/paymentInstruments__resParam_id).",
"type" : "string"
}
},
"required" : [
"amount",
"counterparty"
]
},
"TransferNotificationRequest" : {
"properties" : {
"data" : {
"description" : "Contains details about the event.",
"$ref" : "#/components/schemas/Transfer"
},
"environment" : {
"description" : "The environment from which the webhook originated.\n\nPossible values: **test**, **live**.",
"type" : "string"
},
"type" : {
"description" : "The type of the notification.",
"enum" : [
"balancePlatform.transfer.created",
"balancePlatform.transfer.updated"
],
"type" : "string"
}
},
"required" : [
"environment",
"data"
]
}
},
"securitySchemes" : {
"ApiKeyAuth" : {
"in" : "header",
"name" : "X-API-Key",
"type" : "apiKey"
},
"BasicAuth" : {
"scheme" : "basic",
"type" : "http"
}
},
"examples" : {
"WebhookAck" : {
"summary" : "Acknowledge Webhook",
"value" : {
"notificationResponse" : "[accepted]"
}
},
"post-balancePlatform.transfer.created-balancePlatform-transfer-created" : {
"summary" : "Incoming transfer",
"description" : "Example webhook for an incoming transfer",
"value" : {
"data" : {
"accountHolder" : {
"description" : "AH description",
"id" : "AH00000000000000000000001",
"reference" : "AH reference"
},
"amount" : {
"currency" : "EUR",
"value" : 9999
},
"balanceAccount" : {
"id" : "BA00000000000000000000001"
},
"balanceAccountId" : "BA00000000000000000000001",
"balancePlatform" : "YOUR_BALANCE_PLATFORM",
"category" : "platformPayment",
"creationDate" : "2022-08-15T13:30:05+02:00",
"description" : "this_is_description",
"direction" : "incoming",
"events" : [
{
"bookingDate" : "2022-08-15T13:30:18+02:00",
"mutations" : [
],
"status" : "received"
}
],
"id" : "3JY1Y65VWIRGUETT",
"modificationMerchantReference" : "<auto>",
"modificationPspReference" : "8026605630053940",
"paymentMerchantReference" : "Payment reference",
"pspPaymentReference" : "CWBC43ZX2VTFWR82",
"reason" : "approved",
"reference" : "this_is_reference",
"sequenceNumber" : 1,
"status" : "received",
"type" : "capture"
},
"environment" : "test",
"type" : "balancePlatform.transfer.created"
}
},
"post-balancePlatform.transfer.updated-balancePlatform-transfer-updated" : {
"summary" : "Incoming transfer status changed",
"description" : "Example webhook when an incoming transfer's status changes",
"value" : {
"data" : {
"accountHolder" : {
"description" : "AH description",
"id" : "AH00000000000000000000001",
"reference" : "AH reference"
},
"amount" : {
"currency" : "EUR",
"value" : 9999
},
"balanceAccount" : {
"id" : "BA00000000000000000000001"
},
"balanceAccountId" : "BA00000000000000000000001",
"balancePlatform" : "YOUR_BALANCE_PLATFORM",
"balances" : [
{
"currency" : "EUR",
"reserved" : 9999
}
],
"category" : "platformPayment",
"creationDate" : "2022-08-15T13:30:05+02:00",
"description" : "this_is_description",
"direction" : "incoming",
"events" : [
{
"bookingDate" : "2022-08-15T13:30:18+02:00",
"mutations" : [
],
"status" : "received"
},
{
"bookingDate" : "2022-08-15T13:30:18+02:00",
"mutations" : [
{
"currency" : "EUR",
"reserved" : 9999
}
],
"status" : "authorised"
}
],
"id" : "3JY1Y65VWIRGUETT",
"modificationMerchantReference" : "<auto>",
"modificationPspReference" : "8026605630053940",
"paymentMerchantReference" : "Payment reference",
"pspPaymentReference" : "CWBC43ZX2VTFWR82",
"reason" : "approved",
"reference" : "this_is_reference",
"sequenceNumber" : 2,
"status" : "authorised",
"type" : "capture"
},
"environment" : "test",
"type" : "balancePlatform.incomingTransfer.updated"
}
}
}
}
}

56
json/BalancePlatformPaymentNotification-v1.json
View File

@@ -5,7 +5,7 @@
"x-publicVersion" : true,
"title" : "Payment notifications (deprecated)",
"description" : "Adyen sends notifications through webhooks to inform your system about the creation of payment resources and money movements in your platform.\n\nYou can use these webhooks to build your implementation. For example, you can use this information to update balances in your own dashboards or to keep track of incoming funds.",
"x-timestamp" : "2022-11-14T18:27:45Z",
"x-timestamp" : "2022-12-14T18:29:33Z",
"termsOfService" : "https://www.adyen.com/legal/terms-and-conditions",
"contact" : {
"name" : "Adyen Developer Experience team",
@@ -32,6 +32,7 @@
"operationId" : "post-balancePlatform.incomingTransfer.created",
"x-groupName" : "Fund movements",
"x-sortIndex" : 3,
"x-methodName" : "incomingTransferCreated",
"security" : [
{
"ApiKeyAuth" : [
@@ -82,6 +83,7 @@
"operationId" : "post-balancePlatform.incomingTransfer.updated",
"x-groupName" : "Fund movements",
"x-sortIndex" : 4,
"x-methodName" : "incomingTransferUpdated",
"security" : [
{
"ApiKeyAuth" : [
@@ -132,6 +134,7 @@
"operationId" : "post-balancePlatform.outgoingTransfer.created",
"x-groupName" : "Fund movements",
"x-sortIndex" : 1,
"x-methodName" : "outgoingTransferCreated",
"security" : [
{
"ApiKeyAuth" : [
@@ -182,6 +185,7 @@
"operationId" : "post-balancePlatform.outgoingTransfer.updated",
"x-groupName" : "Fund movements",
"x-sortIndex" : 2,
"x-methodName" : "outgoingTransferUpdated",
"security" : [
{
"ApiKeyAuth" : [
@@ -232,6 +236,7 @@
"operationId" : "post-balancePlatform.payment.created",
"x-groupName" : "Payment authorisation, refund, or funds transfer initiated",
"x-sortIndex" : 1,
"x-methodName" : "paymentAuthorisationRefundOrFundsTransferInitiated",
"security" : [
{
"ApiKeyAuth" : [
@@ -300,6 +305,7 @@
"operationId" : "post-balancePlatform.payment.updated",
"x-groupName" : "Payment authorisation, refund, or funds transfer initiated",
"x-sortIndex" : 2,
"x-methodName" : "paymentAuthorisationExpiredOrCancelled",
"security" : [
{
"ApiKeyAuth" : [
@@ -699,7 +705,18 @@
"$ref" : "#/components/schemas/PlatformPayment"
},
"processingType" : {
"description" : "Contains information about how the payment was processed. For example, **ecommerce** for online or **pos** for point-of-sale payments.",
"description" : "Contains information about how the payment was processed. Possible values: **atmWithdraw**, **balanceInquiry**, **ecommerce**, **moto**, **pos**, **purchaseWithCashback**, **recurring**, **token**, **unknown**.",
"enum" : [
"atmWithdraw",
"balanceInquiry",
"ecommerce",
"moto",
"pos",
"purchaseWithCashback",
"recurring",
"token",
"unknown"
],
"type" : "string"
},
"purposeCode" : {
@@ -819,7 +836,18 @@
"$ref" : "#/components/schemas/PlatformPayment"
},
"processingType" : {
"description" : "Contains information about how the payment was processed. For example, **ecommerce** for online or **pos** for point-of-sale payments.",
"description" : "Contains information about how the payment was processed. Possible values: **atmWithdraw**, **balanceInquiry**, **ecommerce**, **moto**, **pos**, **purchaseWithCashback**, **recurring**, **token**, **unknown**.",
"enum" : [
"atmWithdraw",
"balanceInquiry",
"ecommerce",
"moto",
"pos",
"purchaseWithCashback",
"recurring",
"token",
"unknown"
],
"type" : "string"
},
"reference" : {
@@ -1053,7 +1081,18 @@
"$ref" : "#/components/schemas/PlatformPayment"
},
"processingType" : {
"description" : "Contains information about how the payment was processed. For example, **ecommerce** for online or **pos** for point-of-sale payments.",
"description" : "Contains information about how the payment was processed. Possible values: **atmWithdraw**, **balanceInquiry**, **ecommerce**, **moto**, **pos**, **purchaseWithCashback**, **recurring**, **token**, **unknown**.",
"enum" : [
"atmWithdraw",
"balanceInquiry",
"ecommerce",
"moto",
"pos",
"purchaseWithCashback",
"recurring",
"token",
"unknown"
],
"type" : "string"
},
"purposeCode" : {
@@ -1113,6 +1152,10 @@
},
"TransactionRulesResult" : {
"properties" : {
"advice" : {
"description" : "The advice given by the Risk analysis.",
"type" : "string"
},
"allRulesPassed" : {
"description" : "Indicates whether the transaction passed the evaluation for all transaction rules.",
"type" : "boolean"
@@ -1123,6 +1166,11 @@
"$ref" : "#/components/schemas/TransactionEventViolation"
},
"type" : "array"
},
"score" : {
"description" : "The score of the Risk analysis.",
"format" : "int32",
"type" : "integer"
}
}
},

5
json/TransferService-v1.json
View File

@@ -10,7 +10,7 @@
"x-publicVersion" : true,
"title" : "Transfers API",
"description" : "The Transfers API provides endpoints that you can use to get information about all your transactions, move funds within your balance platform or send funds from your balance platform to a [transfer instrument](https://docs.adyen.com/api-explorer/#/legalentity/latest/post/transferInstruments).\n\n## Authentication\nYour Adyen contact will provide your API credential and an API key. To connect to the API, 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. For example:\n\n```\ncurl\n-H \"Content-Type: application/json\" \\\n-U \"ws@BalancePlatform.YOUR_BALANCE_PLATFORM\":\"YOUR_WS_PASSWORD\" \\\n...\n```\n## Roles and permissions\nTo use the Transfers API, you need an additional role for your API credential. Transfers must also be enabled for the source balance account. Your Adyen contact will set up the roles and permissions for you.\n## Versioning\nThe Transfers 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://balanceplatform-api-test.adyen.com/btl/v1/transfers\n```\n## Going live\nWhen going live, your Adyen contact will provide your API credential for the live environment. You can then use the username and password to send requests to `https://balanceplatform-api-live.adyen.com/btl/v1`.\n\n",
"x-timestamp" : "2022-11-24T10:17:08Z",
"x-timestamp" : "2022-12-20T12:27:11Z",
"termsOfService" : "https://www.adyen.com/legal/terms-and-conditions",
"contact" : {
"name" : "Adyen Developer Experience team",
@@ -37,7 +37,7 @@
"Transactions"
],
"summary" : "Get all transactions",
"description" : "Returns transactions that match the query parameters. This endpoint supports cursor-based pagination. The response returns the first page of results, and returns links to the next page when applicable. You can use the links to page through the results. The response also returns links to the previous page when applicable.",
"description" : "Returns all transactions related to a balance account with a payment instrument of type **bankAccount**.\n\nThis endpoint supports cursor-based pagination. The response returns the first page of results, and returns links to the next page when applicable. You can use the links to page through the results. The response also returns links to the previous page when applicable.",
"x-addedInVersion" : "1",
"operationId" : "get-transactions",
"x-groupName" : "Transactions",
@@ -755,6 +755,7 @@
"atmWithdrawal",
"atmWithdrawalReversal",
"balanceAdjustment",
"balanceRollover",
"bankTransfer",
"capture",
"captureReversal",

16
json/TransferService-v2.json
View File

@@ -10,7 +10,7 @@
"x-publicVersion" : true,
"title" : "Transfers API",
"description" : "The Transfers API provides endpoints that you can use to get information about all your transactions, move funds within your balance platform or send funds from your balance platform to a [transfer instrument](https://docs.adyen.com/api-explorer/#/legalentity/latest/post/transferInstruments).\n\n## Authentication\nYour Adyen contact will provide your API credential and an API key. To connect to the API, 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. For example:\n\n```\ncurl\n-H \"Content-Type: application/json\" \\\n-U \"ws@BalancePlatform.YOUR_BALANCE_PLATFORM\":\"YOUR_WS_PASSWORD\" \\\n...\n```\n## Roles and permissions\nTo use the Transfers API, you need an additional role for your API credential. Transfers must also be enabled for the source balance account. Your Adyen contact will set up the roles and permissions for you.\n## Versioning\nThe Transfers 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://balanceplatform-api-test.adyen.com/btl/v2/transfers\n```\n## Going live\nWhen going live, your Adyen contact will provide your API credential for the live environment. You can then use the username and password to send requests to `https://balanceplatform-api-live.adyen.com/btl/v2`.\n\n",
"x-timestamp" : "2022-11-24T11:24:00Z",
"x-timestamp" : "2022-12-20T12:27:11Z",
"termsOfService" : "https://www.adyen.com/legal/terms-and-conditions",
"contact" : {
"name" : "Adyen Developer Experience team",
@@ -37,7 +37,7 @@
"Transactions"
],
"summary" : "Get all transactions",
"description" : "Returns transactions that match the query parameters. This endpoint supports cursor-based pagination. The response returns the first page of results, and returns links to the next page when applicable. You can use the links to page through the results. The response also returns links to the previous page when applicable.",
"description" : "Returns all transactions related to a balance account with a payment instrument of type **bankAccount**.\n\nThis endpoint supports cursor-based pagination. The response returns the first page of results, and returns links to the next page when applicable. You can use the links to page through the results. The response also returns links to the previous page when applicable.",
"x-addedInVersion" : "1",
"operationId" : "get-transactions",
"x-groupName" : "Transactions",
@@ -788,6 +788,7 @@
"atmWithdrawal",
"atmWithdrawalReversal",
"balanceAdjustment",
"balanceRollover",
"bankTransfer",
"capture",
"captureReversal",
@@ -896,9 +897,19 @@
"x-addedInVersion" : "2",
"description" : "Additional information about the status of the transfer.",
"enum" : [
"amountLimitExceded",
"approved",
"counterpartyAccountBlocked",
"counterpartyAccountClosed",
"counterpartyAccountNotFound",
"counterpartyAddressRequired",
"counterpartyBankTimedOut",
"counterpartyBankUnavailable",
"error",
"notEnoughBalance",
"refusedByCounterpartyBank",
"rejectedByCounterpartyBank",
"routeNotFound",
"unknown"
],
"type" : "string"
@@ -974,6 +985,7 @@
"refused",
"reserveAdjustment",
"reserveAdjustmentPending",
"returned",
"secondChargeback",
"secondChargebackPending",
"undefined"

154
json/TransferService-v3.json
View File

@@ -10,7 +10,7 @@
"x-publicVersion" : true,
"title" : "Transfers API",
"description" : "The Transfers API provides endpoints that you can use to get information about all your transactions, move funds within your balance platform or send funds from your balance platform to a [transfer instrument](https://docs.adyen.com/api-explorer/#/legalentity/latest/post/transferInstruments).\n\n## Authentication\nYour Adyen contact will provide your API credential and an API key. To connect to the API, 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. For example:\n\n```\ncurl\n-H \"Content-Type: application/json\" \\\n-U \"ws@BalancePlatform.YOUR_BALANCE_PLATFORM\":\"YOUR_WS_PASSWORD\" \\\n...\n```\n## Roles and permissions\nTo use the Transfers API, you need an additional role for your API credential. Transfers must also be enabled for the source balance account. Your Adyen contact will set up the roles and permissions for you.\n## Versioning\nThe Transfers 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://balanceplatform-api-test.adyen.com/btl/v3/transfers\n```\n## Going live\nWhen going live, your Adyen contact will provide your API credential for the live environment. You can then use the username and password to send requests to `https://balanceplatform-api-live.adyen.com/btl/v3`.\n\n",
"x-timestamp" : "2022-11-24T11:24:00Z",
"x-timestamp" : "2023-01-10T10:26:12Z",
"termsOfService" : "https://www.adyen.com/legal/terms-and-conditions",
"contact" : {
"name" : "Adyen Developer Experience team",
@@ -37,7 +37,7 @@
"Transactions"
],
"summary" : "Get all transactions",
"description" : "Returns transactions that match the query parameters. This endpoint supports cursor-based pagination. The response returns the first page of results, and returns links to the next page when applicable. You can use the links to page through the results. The response also returns links to the previous page when applicable.",
"description" : "Returns all transactions related to a balance account with a payment instrument of type **bankAccount**.\n\nThis endpoint supports cursor-based pagination. The response returns the first page of results, and returns links to the next page when applicable. You can use the links to page through the results. The response also returns links to the previous page when applicable.",
"x-addedInVersion" : "1",
"operationId" : "get-transactions",
"x-groupName" : "Transactions",
@@ -396,13 +396,13 @@
"additionalProperties" : false,
"properties" : {
"accountNumber" : {
"description" : "The bank account number (without separators or whitespace).",
"description" : "The bank account number, without separators or whitespace.",
"maxLength" : 9,
"minLength" : 5,
"type" : "string"
},
"bsbCode" : {
"description" : "The 6-digit [Bank State Branch (BSB) code](https://en.wikipedia.org/wiki/Bank_state_branch) (without separators or whitespace).",
"description" : "The 6-digit [Bank State Branch (BSB) code](https://en.wikipedia.org/wiki/Bank_state_branch), without separators or whitespace.",
"maxLength" : 6,
"minLength" : 6,
"type" : "string"
@@ -540,6 +540,9 @@
{
"$ref" : "#/components/schemas/BRLocalAccountIdentification"
},
{
"$ref" : "#/components/schemas/CALocalAccountIdentification"
},
{
"$ref" : "#/components/schemas/CZLocalAccountIdentification"
},
@@ -581,6 +584,43 @@
"accountHolder"
]
},
"CALocalAccountIdentification" : {
"additionalProperties" : false,
"properties" : {
"accountNumber" : {
"description" : "The 5- to 12-digit bank account number, without separators or whitespace.",
"maxLength" : 12,
"minLength" : 5,
"type" : "string"
},
"institutionNumber" : {
"description" : "The 3-digit institution number, without separators or whitespace.",
"maxLength" : 3,
"minLength" : 3,
"type" : "string"
},
"transitNumber" : {
"description" : "The 5-digit transit number, without separators or whitespace.",
"maxLength" : 5,
"minLength" : 5,
"type" : "string"
},
"type" : {
"default" : "caLocal",
"description" : "**caLocal**",
"enum" : [
"caLocal"
],
"type" : "string"
}
},
"required" : [
"type",
"accountNumber",
"institutionNumber",
"transitNumber"
]
},
"CZLocalAccountIdentification" : {
"additionalProperties" : false,
"properties" : {
@@ -591,7 +631,7 @@
"type" : "string"
},
"bankCode" : {
"description" : "The 4-digit bank code (Kód banky) (without separators or whitespace).",
"description" : "The 4-digit bank code (Kód banky), without separators or whitespace.",
"maxLength" : 4,
"minLength" : 4,
"type" : "string"
@@ -681,7 +721,7 @@
"additionalProperties" : false,
"properties" : {
"accountNumber" : {
"description" : "The 24-digit bank account number (without separators or whitespace).",
"description" : "The 24-digit bank account number, without separators or whitespace.",
"maxLength" : 24,
"minLength" : 24,
"type" : "string"
@@ -808,7 +848,7 @@
"additionalProperties" : false,
"properties" : {
"accountNumber" : {
"description" : "The 11-digit bank account number (without separators or whitespace).",
"description" : "The 11-digit bank account number, without separators or whitespace.",
"maxLength" : 11,
"minLength" : 11,
"type" : "string"
@@ -868,7 +908,7 @@
"$ref" : "#/components/schemas/AdditionalBankIdentification"
},
"bic" : {
"description" : "The bank's 8 or 11 character BIC or SWIFT code.",
"description" : "The bank's 8- or 11-character BIC or SWIFT code.",
"maxLength" : 11,
"minLength" : 8,
"type" : "string"
@@ -892,7 +932,7 @@
"additionalProperties" : false,
"properties" : {
"accountNumber" : {
"description" : "The 26-digit bank account number ([Numer rachunku](https://pl.wikipedia.org/wiki/Numer_Rachunku_Bankowego)) (without separators or whitespace).",
"description" : "The 26-digit bank account number ([Numer rachunku](https://pl.wikipedia.org/wiki/Numer_Rachunku_Bankowego)), without separators or whitespace.",
"maxLength" : 26,
"minLength" : 26,
"type" : "string"
@@ -999,13 +1039,13 @@
"additionalProperties" : false,
"properties" : {
"accountNumber" : {
"description" : "The 7- to 10-digit bank account number ([Bankkontonummer](https://sv.wikipedia.org/wiki/Bankkonto)) (without the clearing number, separators, or whitespace).",
"description" : "The 7- to 10-digit bank account number ([Bankkontonummer](https://sv.wikipedia.org/wiki/Bankkonto)), without the clearing number, separators, or whitespace.",
"maxLength" : 10,
"minLength" : 7,
"type" : "string"
},
"clearingNumber" : {
"description" : "The 4– to 5-digit clearing number ([Clearingnummer](https://sv.wikipedia.org/wiki/Clearingnummer)) (without separators or whitespace).",
"description" : "The 4- to 5-digit clearing number ([Clearingnummer](https://sv.wikipedia.org/wiki/Clearingnummer)), without separators or whitespace.",
"maxLength" : 5,
"minLength" : 4,
"type" : "string"
@@ -1029,13 +1069,13 @@
"additionalProperties" : false,
"properties" : {
"accountNumber" : {
"description" : "The 4-19 digit bank account number, separators, or whitespace.",
"description" : "The 4- to 19-digit bank account number, without separators or whitespace.",
"maxLength" : 19,
"minLength" : 4,
"type" : "string"
},
"bic" : {
"description" : "The bank's 8 or 11 character BIC or SWIFT code.",
"description" : "The bank's 8- or 11-character BIC or SWIFT code.",
"maxLength" : 11,
"minLength" : 8,
"type" : "string"
@@ -1156,6 +1196,7 @@
"atmWithdrawal",
"atmWithdrawalReversal",
"balanceAdjustment",
"balanceRollover",
"bankTransfer",
"capture",
"captureReversal",
@@ -1280,9 +1321,19 @@
"x-addedInVersion" : "2",
"description" : "Additional information about the status of the transfer.",
"enum" : [
"amountLimitExceded",
"approved",
"counterpartyAccountBlocked",
"counterpartyAccountClosed",
"counterpartyAccountNotFound",
"counterpartyAddressRequired",
"counterpartyBankTimedOut",
"counterpartyBankUnavailable",
"error",
"notEnoughBalance",
"refusedByCounterpartyBank",
"rejectedByCounterpartyBank",
"routeNotFound",
"unknown"
],
"type" : "string"
@@ -1358,6 +1409,7 @@
"refused",
"reserveAdjustment",
"reserveAdjustmentPending",
"returned",
"secondChargeback",
"secondChargebackPending",
"undefined"
@@ -1444,13 +1496,13 @@
"additionalProperties" : false,
"properties" : {
"accountNumber" : {
"description" : "The 8-digit bank account number (without separators or whitespace).",
"description" : "The 8-digit bank account number, without separators or whitespace.",
"maxLength" : 8,
"minLength" : 8,
"type" : "string"
},
"sortCode" : {
"description" : "The 6-digit [sort code](https://en.wikipedia.org/wiki/Sort_code) (without separators or whitespace).",
"description" : "The 6-digit [sort code](https://en.wikipedia.org/wiki/Sort_code), without separators or whitespace.",
"maxLength" : 6,
"minLength" : 6,
"type" : "string"
@@ -1474,7 +1526,7 @@
"additionalProperties" : false,
"properties" : {
"accountNumber" : {
"description" : "The bank account number (without separators or whitespace).",
"description" : "The bank account number, without separators or whitespace.",
"maxLength" : 18,
"minLength" : 2,
"type" : "string"
@@ -1489,7 +1541,7 @@
"type" : "string"
},
"routingNumber" : {
"description" : "The 9-digit [routing number](https://en.wikipedia.org/wiki/ABA_routing_transit_number) (without separators or whitespace).",
"description" : "The 9-digit [routing number](https://en.wikipedia.org/wiki/ABA_routing_transit_number), without separators or whitespace.",
"maxLength" : 9,
"minLength" : 9,
"type" : "string"
@@ -1640,19 +1692,21 @@
"balanceAccountId" : "BAB8B2C3D4E5F6G7H8D9J6GD4",
"category" : "bank",
"counterparty" : {
"accountHolder" : {
"fullName" : "A. Klaassen",
"address" : {
"city" : "San Francisco",
"country" : "US",
"postalCode" : "94678",
"stateOrProvince" : "CA",
"street" : "Brannan Street",
"street2" : "274"
"bankAccount" : {
"accountHolder" : {
"fullName" : "A. Klaassen",
"address" : {
"city" : "San Francisco",
"country" : "US",
"postalCode" : "94678",
"stateOrProvince" : "CA",
"street" : "Brannan Street",
"street2" : "274"
}
}
},
"accountIdentification" : {
"type" : "numberBic",
"type" : "numberAndBic",
"accountNumber" : "123456789",
"bic" : "BOFAUS3NXXX"
}
@@ -1675,30 +1729,32 @@
"balanceAccountId" : "BAB8B2C3D4E5F6G7H8D9J6GD4",
"category" : "bank",
"counterparty" : {
"accountHolder" : {
"fullName" : "A. Klaassen",
"address" : {
"city" : "San Francisco",
"country" : "US",
"postalCode" : "94678",
"stateOrProvince" : "CA",
"street" : "Brannan Street",
"street2" : "274"
"bankAccount" : {
"accountHolder" : {
"fullName" : "A. Klaassen",
"address" : {
"city" : "San Francisco",
"country" : "US",
"postalCode" : "94678",
"stateOrProvince" : "CA",
"street" : "Brannan Street",
"street2" : "274"
}
},
"accountIdentification" : {
"type" : "numberAndBic",
"accountNumber" : "123456789",
"bic" : "BOFAUS3NXXX"
}
},
"accountIdentification" : {
"type" : "numberBic",
"accountNumber" : "123456789",
"bic" : "BOFAUS3NXXX"
}
},
"priority" : "wire",
"referenceForBeneficiary" : "Your reference sent to the beneficiary",
"reference" : "Your internal reference for the transfer",
"description" : "Your description for the transfer",
"direction" : "outgoing",
"reason" : "approved",
"status" : "authorised"
"priority" : "wire",
"referenceForBeneficiary" : "Your reference sent to the beneficiary",
"reference" : "Your internal reference for the transfer",
"description" : "Your description for the transfer",
"direction" : "outgoing",
"reason" : "approved",
"status" : "authorised"
}
}
},
"post-transfers-payout-local-transfer-sepa" : {

416
yaml/BalancePlatformAccountingNotification-v1.yaml Normal file
View File

@@ -0,0 +1,416 @@
openapi: 3.1.0
info:
version: '1'
x-publicVersion: true
title: Accounting notifications
description: 'Adyen sends notifications through webhooks to inform your system about
incoming and outgoing transfers in your platform.
You can use these webhooks to build your implementation. For example, you can
use this information to update balances in your own dashboards or to keep track
of incoming funds.'
x-timestamp: '2022-11-24T11:24:01Z'
termsOfService: https://www.adyen.com/legal/terms-and-conditions
contact:
name: Adyen Developer Experience team
url: https://www.adyen.help/hc/en-us/community/topics
email: developer-experience@adyen.com
x-groups:
- General
tags: []
x-staticResponse: response.json
webhooks:
balancePlatform.transfer.created:
post:
tags:
- General
summary: Transfer created
description: Adyen sends this webhook when there are fund movements on your
platform.
x-addedInVersion: '1'
operationId: post-balancePlatform.transfer.created
x-groupName: General
x-sortIndex: 0
x-methodName: transferCreated
security:
- ApiKeyAuth: []
requestBody:
content:
application/json:
examples:
balancePlatform-transfer-created:
$ref: '#/components/examples/post-balancePlatform.transfer.created-balancePlatform-transfer-created'
schema:
$ref: '#/components/schemas/TransferNotificationRequest'
responses:
'200':
content:
application/json:
examples:
balancePlatform-transfer-created:
$ref: '#/components/examples/WebhookAck'
schema:
$ref: '#/components/schemas/BalancePlatformNotificationResponse'
description: OK - the request has succeeded.
balancePlatform.transfer.updated:
post:
tags:
- General
summary: Transfer updated
description: "Adyen sends this webhook when the status of a transfer changes.\
\ Use the `data.id` to track the original transfer resource in the [balancePlatform.transfer.created](https://docs.adyen.com/api-explorer/accounting-webhooks/1/post/balancePlatform.transfer.created)\
\ webhook.\n\nThe `status` field indicates the event that triggered the webhook.\
\ \n\n"
x-addedInVersion: '1'
operationId: post-balancePlatform.transfer.updated
x-groupName: General
x-sortIndex: 0
x-methodName: transferUpdated
security:
- ApiKeyAuth: []
requestBody:
content:
application/json:
examples:
balancePlatform-transfer-updated:
$ref: '#/components/examples/post-balancePlatform.transfer.updated-balancePlatform-transfer-updated'
schema:
$ref: '#/components/schemas/TransferNotificationRequest'
responses:
'200':
content:
application/json:
examples:
balancePlatform-transfer-updated:
$ref: '#/components/examples/WebhookAck'
schema:
$ref: '#/components/schemas/BalancePlatformNotificationResponse'
description: OK - the request has succeeded.
components:
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**.
> 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.
> Required for the US and Canada.'
type: string
street:
description: 'The name of the street. Maximum length: 3000 characters.
> The house number should not be included in this field; it should be
separately provided via `houseNumberOrName`.'
maxLength: 3000
type: string
required:
- street
- houseNumberOrName
- city
- postalCode
- country
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
BalancePlatformNotificationResponse:
properties:
notificationResponse:
description: Respond with **HTTP 200 OK** and `[accepted]` in the response
body to [accept the webhook](https://docs.adyen.com/development-resources/webhooks#accept-notifications).
type: string
Bank:
properties:
priority:
x-addedInVersion: '1'
description: 'The priority for the bank transfer. This sets the speed at
which the transfer is sent and the fees that you have to pay. If you don''t
provide this in the request, Adyen sets the optimal priority.
Possible values:
* **regular**: For normal, low-value transactions.
* **fast**: Faster way to transfer funds but has higher fees. Recommended
for high-priority, low-value transactions.
* **wire**: Fastest way to transfer funds but has the highest fees. Recommended
for high-priority, high-value transactions.
* **instant**: Instant way to transfer funds in [SEPA countries](https://www.ecb.europa.eu/paym/integration/retail/sepa/html/index.en.html).'
enum:
- fast
- instant
- regular
- wire
type: string
BankAccountInfo:
properties:
address:
description: The address of the bank account owner.
$ref: '#/components/schemas/Address'
iban:
description: The international bank account number as defined in the [ISO-13616](https://www.iso.org/standard/81090.html)
standard.
type: string
ownerName:
description: The name of the bank account owner.
$ref: '#/components/schemas/Name'
Counterparty:
properties:
balanceAccountId:
description: Unique identifier of the [balance account](https://docs.adyen.com/api-explorer/#/balanceplatform/latest/post/balanceAccounts__resParam_id).
type: string
bankAccount:
description: Contains information about the bank account.
$ref: '#/components/schemas/BankAccountInfo'
merchant:
description: Contains information about the merchant.
$ref: '#/components/schemas/MerchantData'
transferInstrumentId:
description: Unique identifier of the [transfer instrument](https://docs.adyen.com/api-explorer/#/balanceplatform/latest/post/transferInstruments__resParam_id).
type: string
MerchantData:
properties:
mcc:
description: The merchant category code.
type: string
merchantId:
description: The merchant identifier.
type: string
nameLocation:
description: Contains the merchant's name and location.
$ref: '#/components/schemas/NameLocation'
postalCode:
description: The merchant postal code.
type: string
Name:
properties:
firstName:
description: The first name.
type: string
fullName:
description: The full name.
type: string
infix:
description: The infix in the name, if any.
type: string
lastName:
description: The last name.
type: string
NameLocation:
properties:
city:
description: The city where the merchant is located.
type: string
country:
description: The country where the merchant is located in [three-letter
country code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3) format.
type: string
countryOfOrigin:
description: The home country in [three-digit country code](https://en.wikipedia.org/wiki/ISO_3166-1_numeric)
format, used for government-controlled merchants such as embassies.
type: string
name:
description: The name of the merchant's shop or service.
type: string
rawData:
description: The raw data.
type: string
state:
description: The state where the merchant is located.
type: string
Resource:
properties:
balancePlatform:
description: Unique identifier of the balance platform.
type: string
creationDate:
description: Date and time when the event was triggered, in ISO 8601 extended
format. For example, **2020-12-18T10:15:30+01:00**.
format: date-time
type: string
id:
description: The ID of the resource.
type: string
Transfer:
properties:
amount:
x-addedInVersion: '1'
description: The amount of the transfer.
$ref: '#/components/schemas/Amount'
balanceAccountId:
description: Unique identifier of the source [balance account](https://docs.adyen.com/api-explorer/#/balanceplatform/latest/post/balanceAccounts__resParam_id).
type: string
bank:
x-addedInVersion: '1'
description: Contains settings for bank transfers. If you are transferring
funds to bank accounts and you don't provide this object, Adyen applies
default settings.
$ref: '#/components/schemas/Bank'
counterparty:
description: The other party in the transfer.
$ref: '#/components/schemas/Counterparty'
description:
x-addedInVersion: '1'
description: A human-readable description for the transfer. You can use
alphanumeric characters and hyphens. We recommend sending a maximum of
140 characters, otherwise the description may be truncated.
type: string
id:
description: The ID of the resource.
type: string
paymentInstrumentId:
description: Unique identifier of the source [payment instrument](https://docs.adyen.com/api-explorer/#/balanceplatform/latest/post/paymentInstruments__resParam_id).
type: string
required:
- amount
- counterparty
TransferNotificationRequest:
properties:
data:
description: Contains details about the event.
$ref: '#/components/schemas/Transfer'
environment:
description: 'The environment from which the webhook originated.
Possible values: **test**, **live**.'
type: string
type:
description: The type of the notification.
enum:
- balancePlatform.transfer.created
- balancePlatform.transfer.updated
type: string
required:
- environment
- data
securitySchemes:
ApiKeyAuth:
in: header
name: X-API-Key
type: apiKey
BasicAuth:
scheme: basic
type: http
examples:
WebhookAck:
summary: Acknowledge Webhook
value:
notificationResponse: '[accepted]'
post-balancePlatform.transfer.created-balancePlatform-transfer-created:
summary: Incoming transfer
description: Example webhook for an incoming transfer
value:
data:
accountHolder:
description: AH description
id: AH00000000000000000000001
reference: AH reference
amount:
currency: EUR
value: 9999
balanceAccount:
id: BA00000000000000000000001
balanceAccountId: BA00000000000000000000001
balancePlatform: YOUR_BALANCE_PLATFORM
category: platformPayment
creationDate: '2022-08-15T13:30:05+02:00'
description: this_is_description
direction: incoming
events:
- bookingDate: '2022-08-15T13:30:18+02:00'
mutations: []
status: received
id: 3JY1Y65VWIRGUETT
modificationMerchantReference: <auto>
modificationPspReference: '8026605630053940'
paymentMerchantReference: Payment reference
pspPaymentReference: CWBC43ZX2VTFWR82
reason: approved
reference: this_is_reference
sequenceNumber: 1
status: received
type: capture
environment: test
type: balancePlatform.transfer.created
post-balancePlatform.transfer.updated-balancePlatform-transfer-updated:
summary: Incoming transfer status changed
description: Example webhook when an incoming transfer's status changes
value:
data:
accountHolder:
description: AH description
id: AH00000000000000000000001
reference: AH reference
amount:
currency: EUR
value: 9999
balanceAccount:
id: BA00000000000000000000001
balanceAccountId: BA00000000000000000000001
balancePlatform: YOUR_BALANCE_PLATFORM
balances:
- currency: EUR
reserved: 9999
category: platformPayment
creationDate: '2022-08-15T13:30:05+02:00'
description: this_is_description
direction: incoming
events:
- bookingDate: '2022-08-15T13:30:18+02:00'
mutations: []
status: received
- bookingDate: '2022-08-15T13:30:18+02:00'
mutations:
- currency: EUR
reserved: 9999
status: authorised
id: 3JY1Y65VWIRGUETT
modificationMerchantReference: <auto>
modificationPspReference: '8026605630053940'
paymentMerchantReference: Payment reference
pspPaymentReference: CWBC43ZX2VTFWR82
reason: approved
reference: this_is_reference
sequenceNumber: 2
status: authorised
type: capture
environment: test
type: balancePlatform.incomingTransfer.updated

60
yaml/BalancePlatformPaymentNotification-v1.yaml
View File

@@ -10,7 +10,7 @@ info:
You can use these webhooks to build your implementation. For example, you can
use this information to update balances in your own dashboards or to keep track
of incoming funds.'
x-timestamp: '2022-11-14T18:27:45Z'
x-timestamp: '2022-12-14T18:29:33Z'
termsOfService: https://www.adyen.com/legal/terms-and-conditions
contact:
name: Adyen Developer Experience team
@@ -43,6 +43,7 @@ webhooks:
operationId: post-balancePlatform.incomingTransfer.created
x-groupName: Fund movements
x-sortIndex: 3
x-methodName: incomingTransferCreated
security:
- ApiKeyAuth: []
requestBody:
@@ -78,6 +79,7 @@ webhooks:
operationId: post-balancePlatform.incomingTransfer.updated
x-groupName: Fund movements
x-sortIndex: 4
x-methodName: incomingTransferUpdated
security:
- ApiKeyAuth: []
requestBody:
@@ -113,6 +115,7 @@ webhooks:
operationId: post-balancePlatform.outgoingTransfer.created
x-groupName: Fund movements
x-sortIndex: 1
x-methodName: outgoingTransferCreated
security:
- ApiKeyAuth: []
requestBody:
@@ -149,6 +152,7 @@ webhooks:
operationId: post-balancePlatform.outgoingTransfer.updated
x-groupName: Fund movements
x-sortIndex: 2
x-methodName: outgoingTransferUpdated
security:
- ApiKeyAuth: []
requestBody:
@@ -189,6 +193,7 @@ webhooks:
operationId: post-balancePlatform.payment.created
x-groupName: Payment authorisation, refund, or funds transfer initiated
x-sortIndex: 1
x-methodName: paymentAuthorisationRefundOrFundsTransferInitiated
security:
- ApiKeyAuth: []
requestBody:
@@ -233,6 +238,7 @@ webhooks:
operationId: post-balancePlatform.payment.updated
x-groupName: Payment authorisation, refund, or funds transfer initiated
x-sortIndex: 2
x-methodName: paymentAuthorisationExpiredOrCancelled
security:
- ApiKeyAuth: []
requestBody:
@@ -580,8 +586,19 @@ components:
description: Contains information about the related platform payment.
$ref: '#/components/schemas/PlatformPayment'
processingType:
description: Contains information about how the payment was processed. For
example, **ecommerce** for online or **pos** for point-of-sale payments.
description: 'Contains information about how the payment was processed.
Possible values: **atmWithdraw**, **balanceInquiry**, **ecommerce**, **moto**,
**pos**, **purchaseWithCashback**, **recurring**, **token**, **unknown**.'
enum:
- atmWithdraw
- balanceInquiry
- ecommerce
- moto
- pos
- purchaseWithCashback
- recurring
- token
- unknown
type: string
purposeCode:
description: "Indicates the purpose of the outgoing transfer. Adyen sets\
@@ -704,8 +721,19 @@ components:
description: Contains information about the related platform payment.
$ref: '#/components/schemas/PlatformPayment'
processingType:
description: Contains information about how the payment was processed. For
example, **ecommerce** for online or **pos** for point-of-sale payments.
description: 'Contains information about how the payment was processed.
Possible values: **atmWithdraw**, **balanceInquiry**, **ecommerce**, **moto**,
**pos**, **purchaseWithCashback**, **recurring**, **token**, **unknown**.'
enum:
- atmWithdraw
- balanceInquiry
- ecommerce
- moto
- pos
- purchaseWithCashback
- recurring
- token
- unknown
type: string
reference:
description: The [`reference`](https://docs.adyen.com/api-explorer/#/transfers/latest/post/transfers__reqParam_reference)
@@ -913,8 +941,19 @@ components:
description: Contains information about the related platform payment.
$ref: '#/components/schemas/PlatformPayment'
processingType:
description: Contains information about how the payment was processed. For
example, **ecommerce** for online or **pos** for point-of-sale payments.
description: 'Contains information about how the payment was processed.
Possible values: **atmWithdraw**, **balanceInquiry**, **ecommerce**, **moto**,
**pos**, **purchaseWithCashback**, **recurring**, **token**, **unknown**.'
enum:
- atmWithdraw
- balanceInquiry
- ecommerce
- moto
- pos
- purchaseWithCashback
- recurring
- token
- unknown
type: string
purposeCode:
description: "Indicates the purpose of the outgoing transfer. Adyen sets\
@@ -981,6 +1020,9 @@ components:
type: string
TransactionRulesResult:
properties:
advice:
description: The advice given by the Risk analysis.
type: string
allRulesPassed:
description: Indicates whether the transaction passed the evaluation for
all transaction rules.
@@ -991,6 +1033,10 @@ components:
items:
$ref: '#/components/schemas/TransactionEventViolation'
type: array
score:
description: The score of the Risk analysis.
format: int32
type: integer
ValidationResult:
properties:
result:

16
yaml/TransferService-v1.yaml
View File

@@ -23,7 +23,7 @@ info:
```\n## Going live\nWhen going live, your Adyen contact will provide your API\
\ credential for the live environment. You can then use the username and password\
\ to send requests to `https://balanceplatform-api-live.adyen.com/btl/v1`.\n\n"
x-timestamp: '2022-11-24T10:17:08Z'
x-timestamp: '2022-12-20T12:27:11Z'
termsOfService: https://www.adyen.com/legal/terms-and-conditions
contact:
name: Adyen Developer Experience team
@@ -41,11 +41,14 @@ paths:
tags:
- Transactions
summary: Get all transactions
description: Returns transactions that match the query parameters. This endpoint
supports cursor-based pagination. The response returns the first page of results,
and returns links to the next page when applicable. You can use the links
to page through the results. The response also returns links to the previous
page when applicable.
description: 'Returns all transactions related to a balance account with a payment
instrument of type **bankAccount**.
This endpoint supports cursor-based pagination. The response returns the first
page of results, and returns links to the next page when applicable. You can
use the links to page through the results. The response also returns links
to the previous page when applicable.'
x-addedInVersion: '1'
operationId: get-transactions
x-groupName: Transactions
@@ -586,6 +589,7 @@ components:
- atmWithdrawal
- atmWithdrawalReversal
- balanceAdjustment
- balanceRollover
- bankTransfer
- capture
- captureReversal

27
yaml/TransferService-v2.yaml
View File

@@ -23,7 +23,7 @@ info:
```\n## Going live\nWhen going live, your Adyen contact will provide your API\
\ credential for the live environment. You can then use the username and password\
\ to send requests to `https://balanceplatform-api-live.adyen.com/btl/v2`.\n\n"
x-timestamp: '2022-11-24T11:24:00Z'
x-timestamp: '2022-12-20T12:27:11Z'
termsOfService: https://www.adyen.com/legal/terms-and-conditions
contact:
name: Adyen Developer Experience team
@@ -41,11 +41,14 @@ paths:
tags:
- Transactions
summary: Get all transactions
description: Returns transactions that match the query parameters. This endpoint
supports cursor-based pagination. The response returns the first page of results,
and returns links to the next page when applicable. You can use the links
to page through the results. The response also returns links to the previous
page when applicable.
description: 'Returns all transactions related to a balance account with a payment
instrument of type **bankAccount**.
This endpoint supports cursor-based pagination. The response returns the first
page of results, and returns links to the next page when applicable. You can
use the links to page through the results. The response also returns links
to the previous page when applicable.'
x-addedInVersion: '1'
operationId: get-transactions
x-groupName: Transactions
@@ -629,6 +632,7 @@ components:
- atmWithdrawal
- atmWithdrawalReversal
- balanceAdjustment
- balanceRollover
- bankTransfer
- capture
- captureReversal
@@ -725,9 +729,19 @@ components:
x-addedInVersion: '2'
description: Additional information about the status of the transfer.
enum:
- amountLimitExceded
- approved
- counterpartyAccountBlocked
- counterpartyAccountClosed
- counterpartyAccountNotFound
- counterpartyAddressRequired
- counterpartyBankTimedOut
- counterpartyBankUnavailable
- error
- notEnoughBalance
- refusedByCounterpartyBank
- rejectedByCounterpartyBank
- routeNotFound
- unknown
type: string
reference:
@@ -808,6 +822,7 @@ components:
- refused
- reserveAdjustment
- reserveAdjustmentPending
- returned
- secondChargeback
- secondChargebackPending
- undefined

165
yaml/TransferService-v3.yaml
View File

@@ -23,7 +23,7 @@ info:
```\n## Going live\nWhen going live, your Adyen contact will provide your API\
\ credential for the live environment. You can then use the username and password\
\ to send requests to `https://balanceplatform-api-live.adyen.com/btl/v3`.\n\n"
x-timestamp: '2022-11-24T11:24:00Z'
x-timestamp: '2023-01-10T10:26:12Z'
termsOfService: https://www.adyen.com/legal/terms-and-conditions
contact:
name: Adyen Developer Experience team
@@ -41,11 +41,14 @@ paths:
tags:
- Transactions
summary: Get all transactions
description: Returns transactions that match the query parameters. This endpoint
supports cursor-based pagination. The response returns the first page of results,
and returns links to the next page when applicable. You can use the links
to page through the results. The response also returns links to the previous
page when applicable.
description: 'Returns all transactions related to a balance account with a payment
instrument of type **bankAccount**.
This endpoint supports cursor-based pagination. The response returns the first
page of results, and returns links to the next page when applicable. You can
use the links to page through the results. The response also returns links
to the previous page when applicable.'
x-addedInVersion: '1'
operationId: get-transactions
x-groupName: Transactions
@@ -282,13 +285,13 @@ components:
additionalProperties: false
properties:
accountNumber:
description: The bank account number (without separators or whitespace).
description: The bank account number, without separators or whitespace.
maxLength: 9
minLength: 5
type: string
bsbCode:
description: The 6-digit [Bank State Branch (BSB) code](https://en.wikipedia.org/wiki/Bank_state_branch)
(without separators or whitespace).
description: The 6-digit [Bank State Branch (BSB) code](https://en.wikipedia.org/wiki/Bank_state_branch),
without separators or whitespace.
maxLength: 6
minLength: 6
type: string
@@ -407,6 +410,7 @@ components:
oneOf:
- $ref: '#/components/schemas/AULocalAccountIdentification'
- $ref: '#/components/schemas/BRLocalAccountIdentification'
- $ref: '#/components/schemas/CALocalAccountIdentification'
- $ref: '#/components/schemas/CZLocalAccountIdentification'
- $ref: '#/components/schemas/DKLocalAccountIdentification'
- $ref: '#/components/schemas/HULocalAccountIdentification'
@@ -421,6 +425,36 @@ components:
required:
- accountIdentification
- accountHolder
CALocalAccountIdentification:
additionalProperties: false
properties:
accountNumber:
description: The 5- to 12-digit bank account number, without separators
or whitespace.
maxLength: 12
minLength: 5
type: string
institutionNumber:
description: The 3-digit institution number, without separators or whitespace.
maxLength: 3
minLength: 3
type: string
transitNumber:
description: The 5-digit transit number, without separators or whitespace.
maxLength: 5
minLength: 5
type: string
type:
default: caLocal
description: '**caLocal**'
enum:
- caLocal
type: string
required:
- type
- accountNumber
- institutionNumber
- transitNumber
CZLocalAccountIdentification:
additionalProperties: false
properties:
@@ -436,8 +470,8 @@ components:
minLength: 2
type: string
bankCode:
description: "The 4-digit bank code (K\xF3d banky) (without separators or\
\ whitespace)."
description: "The 4-digit bank code (K\xF3d banky), without separators or\
\ whitespace."
maxLength: 4
minLength: 4
type: string
@@ -505,7 +539,7 @@ components:
additionalProperties: false
properties:
accountNumber:
description: The 24-digit bank account number (without separators or whitespace).
description: The 24-digit bank account number, without separators or whitespace.
maxLength: 24
minLength: 24
type: string
@@ -593,7 +627,7 @@ components:
additionalProperties: false
properties:
accountNumber:
description: The 11-digit bank account number (without separators or whitespace).
description: The 11-digit bank account number, without separators or whitespace.
maxLength: 11
minLength: 11
type: string
@@ -641,7 +675,7 @@ components:
require these identifiers for cross-border transfers.
$ref: '#/components/schemas/AdditionalBankIdentification'
bic:
description: The bank's 8 or 11 character BIC or SWIFT code.
description: The bank's 8- or 11-character BIC or SWIFT code.
maxLength: 11
minLength: 8
type: string
@@ -659,8 +693,8 @@ components:
additionalProperties: false
properties:
accountNumber:
description: The 26-digit bank account number ([Numer rachunku](https://pl.wikipedia.org/wiki/Numer_Rachunku_Bankowego))
(without separators or whitespace).
description: The 26-digit bank account number ([Numer rachunku](https://pl.wikipedia.org/wiki/Numer_Rachunku_Bankowego)),
without separators or whitespace.
maxLength: 26
minLength: 26
type: string
@@ -744,14 +778,14 @@ components:
additionalProperties: false
properties:
accountNumber:
description: The 7- to 10-digit bank account number ([Bankkontonummer](https://sv.wikipedia.org/wiki/Bankkonto))
(without the clearing number, separators, or whitespace).
description: The 7- to 10-digit bank account number ([Bankkontonummer](https://sv.wikipedia.org/wiki/Bankkonto)),
without the clearing number, separators, or whitespace.
maxLength: 10
minLength: 7
type: string
clearingNumber:
description: "The 4\u2013 to 5-digit clearing number ([Clearingnummer](https://sv.wikipedia.org/wiki/Clearingnummer))\
\ (without separators or whitespace)."
description: The 4- to 5-digit clearing number ([Clearingnummer](https://sv.wikipedia.org/wiki/Clearingnummer)),
without separators or whitespace.
maxLength: 5
minLength: 4
type: string
@@ -769,12 +803,13 @@ components:
additionalProperties: false
properties:
accountNumber:
description: The 4-19 digit bank account number, separators, or whitespace.
description: The 4- to 19-digit bank account number, without separators
or whitespace.
maxLength: 19
minLength: 4
type: string
bic:
description: The bank's 8 or 11 character BIC or SWIFT code.
description: The bank's 8- or 11-character BIC or SWIFT code.
maxLength: 11
minLength: 8
type: string
@@ -892,6 +927,7 @@ components:
- atmWithdrawal
- atmWithdrawalReversal
- balanceAdjustment
- balanceRollover
- bankTransfer
- capture
- captureReversal
@@ -1021,9 +1057,19 @@ components:
x-addedInVersion: '2'
description: Additional information about the status of the transfer.
enum:
- amountLimitExceded
- approved
- counterpartyAccountBlocked
- counterpartyAccountClosed
- counterpartyAccountNotFound
- counterpartyAddressRequired
- counterpartyBankTimedOut
- counterpartyBankUnavailable
- error
- notEnoughBalance
- refusedByCounterpartyBank
- rejectedByCounterpartyBank
- routeNotFound
- unknown
type: string
reference:
@@ -1106,6 +1152,7 @@ components:
- refused
- reserveAdjustment
- reserveAdjustmentPending
- returned
- secondChargeback
- secondChargebackPending
- undefined
@@ -1207,13 +1254,13 @@ components:
additionalProperties: false
properties:
accountNumber:
description: The 8-digit bank account number (without separators or whitespace).
description: The 8-digit bank account number, without separators or whitespace.
maxLength: 8
minLength: 8
type: string
sortCode:
description: The 6-digit [sort code](https://en.wikipedia.org/wiki/Sort_code)
(without separators or whitespace).
description: The 6-digit [sort code](https://en.wikipedia.org/wiki/Sort_code),
without separators or whitespace.
maxLength: 6
minLength: 6
type: string
@@ -1231,7 +1278,7 @@ components:
additionalProperties: false
properties:
accountNumber:
description: The bank account number (without separators or whitespace).
description: The bank account number, without separators or whitespace.
maxLength: 18
minLength: 2
type: string
@@ -1246,8 +1293,8 @@ components:
- savings
type: string
routingNumber:
description: The 9-digit [routing number](https://en.wikipedia.org/wiki/ABA_routing_transit_number)
(without separators or whitespace).
description: The 9-digit [routing number](https://en.wikipedia.org/wiki/ABA_routing_transit_number),
without separators or whitespace.
maxLength: 9
minLength: 9
type: string
@@ -1365,17 +1412,18 @@ components:
balanceAccountId: BAB8B2C3D4E5F6G7H8D9J6GD4
category: bank
counterparty:
accountHolder:
fullName: A. Klaassen
address:
city: San Francisco
country: US
postalCode: '94678'
stateOrProvince: CA
street: Brannan Street
street2: '274'
bankAccount:
accountHolder:
fullName: A. Klaassen
address:
city: San Francisco
country: US
postalCode: '94678'
stateOrProvince: CA
street: Brannan Street
street2: '274'
accountIdentification:
type: numberBic
type: numberAndBic
accountNumber: '123456789'
bic: BOFAUS3NXXX
priority: wire
@@ -1393,26 +1441,27 @@ components:
balanceAccountId: BAB8B2C3D4E5F6G7H8D9J6GD4
category: bank
counterparty:
accountHolder:
fullName: A. Klaassen
address:
city: San Francisco
country: US
postalCode: '94678'
stateOrProvince: CA
street: Brannan Street
street2: '274'
accountIdentification:
type: numberBic
accountNumber: '123456789'
bic: BOFAUS3NXXX
priority: wire
referenceForBeneficiary: Your reference sent to the beneficiary
reference: Your internal reference for the transfer
description: Your description for the transfer
direction: outgoing
reason: approved
status: authorised
bankAccount:
accountHolder:
fullName: A. Klaassen
address:
city: San Francisco
country: US
postalCode: '94678'
stateOrProvince: CA
street: Brannan Street
street2: '274'
accountIdentification:
type: numberAndBic
accountNumber: '123456789'
bic: BOFAUS3NXXX
priority: wire
referenceForBeneficiary: Your reference sent to the beneficiary
reference: Your internal reference for the transfer
description: Your description for the transfer
direction: outgoing
reason: approved
status: authorised
post-transfers-payout-local-transfer-sepa:
summary: Make a SEPA funds transfer
description: Example request to make a SEPA funds transfer