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-04-05 10:11:24 +00:00
parent 8895e750bd
commit aaf1a6cfdd
10 changed files with 209 additions and 76 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
json/BalancePlatformPaymentNotification-v1.json
View File

@@ -10,7 +10,7 @@
"x-publicVersion" : true,
"title" : "Payment webhooks (deprecated)",
"description" : "The payment webhooks are deprecated. Use the [accounting webhooks](https://docs.adyen.com/api-explorer/transfer-webhooks/latest/overview) instead.\n\nAdyen 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" : "2023-03-16T17:21:17Z",
"x-timestamp" : "2023-03-30T18:22:09Z",
"termsOfService" : "https://www.adyen.com/legal/terms-and-conditions",
"contact" : {
"name" : "Adyen Developer Experience team",
@@ -1262,9 +1262,7 @@
"examples" : {
"WebhookAck" : {
"summary" : "Acknowledge Webhook",
"value" : {
"notificationResponse" : "[accepted]"
}
"value" : "[accepted]"
},
"post-balancePlatform.incomingTransfer.created-balancePlatform-incomingTransfer-created" : {
"summary" : "Pending incoming transfer",

30
json/BalancePlatformTransferNotification-v3.json
View File

@@ -10,7 +10,7 @@
"x-publicVersion" : true,
"title" : "Transfer webhooks",
"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" : "2023-03-16T15:26:18Z",
"x-timestamp" : "2023-03-28T13:27:37Z",
"termsOfService" : "https://www.adyen.com/legal/terms-and-conditions",
"contact" : {
"name" : "Adyen Developer Experience team",
@@ -158,7 +158,7 @@
},
"type" : "object"
},
"Address-2" : {
"Address" : {
"properties" : {
"city" : {
"description" : "The name of the city.",
@@ -381,6 +381,15 @@
"minLength" : 5,
"type" : "string"
},
"accountType" : {
"default" : "checking",
"description" : "The bank account type.\n\nPossible values: **checking** or **savings**. Defaults to **checking**.",
"enum" : [
"checking",
"savings"
],
"type" : "string"
},
"institutionNumber" : {
"description" : "The 3-digit institution number, without separators or whitespace.",
"maxLength" : 3,
@@ -675,7 +684,7 @@
"properties" : {
"address" : {
"description" : "Address of the bank account owner.",
"$ref" : "#/components/schemas/Address-2"
"$ref" : "#/components/schemas/Address"
},
"dateOfBirth" : {
"description" : "The date of birth of the individual.\nFormat: [ISO-8601](https://www.w3.org/TR/NOTE-datetime); example: YYYY-MM-DD\nAllowed only when `type` is **individual**.",
@@ -732,7 +741,7 @@
},
"type" : "object"
},
"RelayedAuthorisationData-2" : {
"RelayedAuthorisationData" : {
"properties" : {
"metadata" : {
"x-addedInVersion" : "3",
@@ -920,6 +929,11 @@
},
"TransferEvent" : {
"properties" : {
"amount" : {
"x-addedInVersion" : "3",
"description" : "The original journal amount.",
"$ref" : "#/components/schemas/Amount"
},
"amountAdjustments" : {
"x-addedInVersion" : "3",
"description" : "The amount adjustments in this transfer.",
@@ -962,7 +976,7 @@
"x-addedInVersion" : "3",
"description" : "The reason for the transfer status.",
"enum" : [
"amountLimitExceded",
"amountLimitExceeded",
"approved",
"counterpartyAccountBlocked",
"counterpartyAccountClosed",
@@ -982,6 +996,7 @@
"x-addedInVersion" : "3",
"description" : "The status of the transfer event.",
"enum" : [
"approvalPending",
"atmWithdrawal",
"atmWithdrawalReversalPending",
"atmWithdrawalReversed",
@@ -1238,7 +1253,7 @@
"x-addedInVersion" : "2",
"description" : "Additional information about the status of the transfer.",
"enum" : [
"amountLimitExceded",
"amountLimitExceeded",
"approved",
"counterpartyAccountBlocked",
"counterpartyAccountClosed",
@@ -1269,7 +1284,7 @@
"relayedAuthorisationData" : {
"x-addedInVersion" : "3",
"description" : "If you are using relayed authorisation, this object contains information from the relayed authorisation response from your server.",
"$ref" : "#/components/schemas/RelayedAuthorisationData-2"
"$ref" : "#/components/schemas/RelayedAuthorisationData"
},
"sequenceNumber" : {
"x-addedInVersion" : "3",
@@ -1281,6 +1296,7 @@
"x-addedInVersion" : "2",
"description" : "The result of the transfer.\n\n For example, **authorised**, **refused**, or **error**.",
"enum" : [
"approvalPending",
"atmWithdrawal",
"atmWithdrawalReversalPending",
"atmWithdrawalReversed",

22
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" : "2023-02-20T18:21:55Z",
"x-timestamp" : "2023-03-23T20:22:14Z",
"termsOfService" : "https://www.adyen.com/legal/terms-and-conditions",
"contact" : {
"name" : "Adyen Developer Experience team",
@@ -968,6 +968,16 @@
"description" : "Example response for a transfers request",
"value" : {
"id" : "1W1UG35U8A9J5ZLG",
"source" : {
"balanceAccountId" : "BAB8B2C3D4E5F6G7H8D9J6GD4"
},
"destination" : {
"balanceAccountId" : "BAB1234567890ABC123456789"
},
"amount" : {
"value" : 10000,
"currency" : "EUR"
},
"resultCode" : "Authorised"
}
},
@@ -994,6 +1004,16 @@
"description" : "Example response for a transfers request",
"value" : {
"id" : "1W1UG35U8A9J5ZLG",
"source" : {
"balanceAccountId" : "BAB8B2C3D4E5F6G7H8D9J6GD4"
},
"destination" : {
"transferInstrumentId" : "SE1234567890ABC1234567890"
},
"amount" : {
"value" : 10000,
"currency" : "EUR"
},
"resultCode" : "Authorised"
}
}

17
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" : "2023-02-22T12:23:54Z",
"x-timestamp" : "2023-03-23T20:22:15Z",
"termsOfService" : "https://www.adyen.com/legal/terms-and-conditions",
"contact" : {
"name" : "Adyen Developer Experience team",
@@ -925,7 +925,7 @@
"x-addedInVersion" : "2",
"description" : "Additional information about the status of the transfer.",
"enum" : [
"amountLimitExceded",
"amountLimitExceeded",
"approved",
"counterpartyAccountBlocked",
"counterpartyAccountClosed",
@@ -957,6 +957,7 @@
"x-addedInVersion" : "2",
"description" : "The result of the transfer.\n\n For example, **authorised**, **refused**, or **error**.",
"enum" : [
"approvalPending",
"atmWithdrawal",
"atmWithdrawalReversalPending",
"atmWithdrawalReversed",
@@ -1107,7 +1108,7 @@
"bookingDate" : "2022-03-14T12:01:00+01:00",
"category" : "bank",
"counterparty" : {
"balanceAccountId" : "NL29ADYX0000000001"
"balanceAccountId" : "BA00000000000000000000001"
},
"createdAt" : "2022-03-14T12:01:00+01:00",
"description" : "YOUR_DESCRIPTION",
@@ -1139,6 +1140,9 @@
"balancePlatform" : "YOUR_BALANCE_PLATFORM",
"bookingDate" : "2022-03-11T11:21:24+01:00",
"category" : "internal",
"counterparty" : {
"balanceAccountId" : "BA00000000000000000000001"
},
"createdAt" : "2022-03-11T11:21:24+01:00",
"id" : "1VVF0D5U66PIUIVP",
"instructedAmount" : {
@@ -1161,6 +1165,9 @@
"balancePlatform" : "YOUR_BALANCE_PLATFORM",
"bookingDate" : "2022-03-12T14:22:52+01:00",
"category" : "internal",
"counterparty" : {
"balanceAccountId" : "BA00000000000000000000001"
},
"createdAt" : "2022-03-12T14:22:52+01:00",
"id" : "1WEPGD5U6MS1CFK3",
"instructedAmount" : {
@@ -1179,6 +1186,10 @@
"currency" : "EUR",
"value" : -8
},
"counterparty" : {
"balanceAccountId" : "BA00000000000000000000001"
},
"reference" : "REFERENCE_46e8c40e",
"balanceAccountId" : "BAB8B2C3D4E5F6G7H8D9J6GD4",
"balancePlatform" : "YOUR_BALANCE_PLATFORM",
"bookingDate" : "2022-03-14T21:00:48+01:00",

73
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" : "2023-02-22T12:23:54Z",
"x-timestamp" : "2023-03-28T13:27:36Z",
"termsOfService" : "https://www.adyen.com/legal/terms-and-conditions",
"contact" : {
"name" : "Adyen Developer Experience team",
@@ -608,6 +608,15 @@
"minLength" : 5,
"type" : "string"
},
"accountType" : {
"default" : "checking",
"description" : "The bank account type.\n\nPossible values: **checking** or **savings**. Defaults to **checking**.",
"enum" : [
"checking",
"savings"
],
"type" : "string"
},
"institutionNumber" : {
"description" : "The 3-digit institution number, without separators or whitespace.",
"maxLength" : 3,
@@ -989,8 +998,13 @@
"description" : "Address of the bank account owner.",
"$ref" : "#/components/schemas/Address-2"
},
"dateOfBirth" : {
"description" : "The date of birth of the individual.\nFormat: [ISO-8601](https://www.w3.org/TR/NOTE-datetime); example: YYYY-MM-DD\nAllowed only when `type` is **individual**.",
"format" : "date",
"type" : "string"
},
"firstName" : {
"description" : "First name of the individual. Required when `type` is **individual**.",
"description" : "First name of the individual. Allowed only when `type` is **individual**.",
"type" : "string"
},
"fullName" : {
@@ -998,7 +1012,7 @@
"type" : "string"
},
"lastName" : {
"description" : "Last name of the individual. Required when `type` is **individual**.",
"description" : "Last name of the individual. Allowed only when `type` is **individual**.",
"type" : "string"
},
"type" : {
@@ -1363,7 +1377,7 @@
"x-addedInVersion" : "2",
"description" : "Additional information about the status of the transfer.",
"enum" : [
"amountLimitExceded",
"amountLimitExceeded",
"approved",
"counterpartyAccountBlocked",
"counterpartyAccountClosed",
@@ -1395,6 +1409,7 @@
"x-addedInVersion" : "2",
"description" : "The result of the transfer.\n\n For example, **authorised**, **refused**, or **error**.",
"enum" : [
"approvalPending",
"atmWithdrawal",
"atmWithdrawalReversalPending",
"atmWithdrawalReversed",
@@ -1639,7 +1654,7 @@
"bookingDate" : "2022-03-14T12:01:00+01:00",
"category" : "bank",
"counterparty" : {
"balanceAccountId" : "NL29ADYX0000000001"
"balanceAccountId" : "BA00000000000000000000001"
},
"createdAt" : "2022-03-14T12:01:00+01:00",
"description" : "YOUR_DESCRIPTION",
@@ -1671,6 +1686,9 @@
"balancePlatform" : "YOUR_BALANCE_PLATFORM",
"bookingDate" : "2022-03-11T11:21:24+01:00",
"category" : "internal",
"counterparty" : {
"balanceAccountId" : "BA00000000000000000000001"
},
"createdAt" : "2022-03-11T11:21:24+01:00",
"id" : "1VVF0D5U66PIUIVP",
"instructedAmount" : {
@@ -1693,6 +1711,9 @@
"balancePlatform" : "YOUR_BALANCE_PLATFORM",
"bookingDate" : "2022-03-12T14:22:52+01:00",
"category" : "internal",
"counterparty" : {
"balanceAccountId" : "BA00000000000000000000001"
},
"createdAt" : "2022-03-12T14:22:52+01:00",
"id" : "1WEPGD5U6MS1CFK3",
"instructedAmount" : {
@@ -1717,6 +1738,10 @@
"createdAt" : "2022-03-14T15:00:00+01:00",
"description" : "YOUR_DESCRIPTION_2",
"id" : "2QP32A5U7IWC5WKG",
"counterparty" : {
"balanceAccountId" : "BA00000000000000000000001"
},
"reference" : "REFERENCE_46e8c40e",
"instructedAmount" : {
"currency" : "EUR",
"value" : -8
@@ -1733,8 +1758,8 @@
}
},
"post-transfers-payout-cross-border" : {
"summary" : "Make a cross border transfer",
"description" : "Example request to make a cross border transfer",
"summary" : "Make a cross-border transfer",
"description" : "Example request to make a cross-border transfer",
"value" : {
"amount" : {
"value" : 110000,
@@ -1754,16 +1779,16 @@
"street" : "Brannan Street",
"street2" : "274"
}
},
"accountIdentification" : {
"type" : "numberAndBic",
"accountNumber" : "123456789",
"bic" : "BOFAUS3NXXX"
}
},
"accountIdentification" : {
"type" : "numberAndBic",
"accountNumber" : "123456789",
"bic" : "BOFAUS3NXXX"
}
},
"priority" : "wire",
"referenceForBeneficiary" : "Your reference sent to the beneficiary",
"priority" : "crossBorder",
"referenceForBeneficiary" : "Your-reference-sent-to-the-beneficiary",
"reference" : "Your internal reference for the transfer",
"description" : "Your description for the transfer"
}
@@ -1798,8 +1823,8 @@
"bic" : "BOFAUS3NXXX"
}
},
"priority" : "wire",
"referenceForBeneficiary" : "Your reference sent to the beneficiary",
"priority" : "crossBorder",
"referenceForBeneficiary" : "Your-reference-sent-to-the-beneficiary",
"reference" : "Your internal reference for the transfer",
"description" : "Your description for the transfer",
"direction" : "outgoing",
@@ -1830,7 +1855,7 @@
}
},
"priority" : "regular",
"referenceForBeneficiary" : "Your reference sent to the beneficiary",
"referenceForBeneficiary" : "Your-reference-sent-to-the-beneficiary",
"reference" : "Your internal reference for the transfer",
"description" : "Your description for the transfer"
}
@@ -1858,7 +1883,7 @@
}
},
"priority" : "regular",
"referenceForBeneficiary" : "Your reference sent to the beneficiary",
"referenceForBeneficiary" : "Your-reference-sent-to-the-beneficiary",
"reference" : "Your internal reference for the transfer",
"description" : "Your description for the transfer",
"direction" : "outgoing",
@@ -1889,7 +1914,7 @@
}
},
"priority" : "regular",
"referenceForBeneficiary" : "Your reference sent to the beneficiary",
"referenceForBeneficiary" : "Your-reference-sent-to-the-beneficiary",
"reference" : "Your internal reference for the transfer",
"description" : "Your description for the transfer"
}
@@ -1918,7 +1943,7 @@
}
},
"priority" : "regular",
"referenceForBeneficiary" : "Your reference sent to the beneficiary",
"referenceForBeneficiary" : "Your-reference-sent-to-the-beneficiary",
"reference" : "Your internal reference for the transfer",
"description" : "Your description for the transfer",
"direction" : "outgoing",
@@ -1939,7 +1964,7 @@
"counterparty" : {
"balanceAccountId" : "BA32272223222B5LPRFDW7J9G"
},
"referenceForBeneficiary" : "Your reference sent to the beneficiary",
"referenceForBeneficiary" : "Your-reference-sent-to-the-beneficiary",
"reference" : "Your internal reference for the transfer",
"description" : "Your description for the transfer"
}
@@ -1958,7 +1983,7 @@
"counterparty" : {
"balanceAccountId" : "BA32272223222B5LPRFDW7J9G"
},
"referenceForBeneficiary" : "Your reference sent to the beneficiary",
"referenceForBeneficiary" : "Your-reference-sent-to-the-beneficiary",
"reference" : "Your internal reference for the transfer",
"description" : "Your description for the transfer",
"direction" : "outgoing",
@@ -1980,7 +2005,7 @@
"transferInstrumentId" : "SE1234567890ABC1234567890"
},
"priority" : "regular",
"referenceForBeneficiary" : "Your reference sent to the beneficiary",
"referenceForBeneficiary" : "Your-reference-sent-to-the-beneficiary",
"reference" : "Your internal reference for the transfer",
"description" : "Your description for the transfer"
}
@@ -2000,7 +2025,7 @@
"transferInstrumentId" : "SE1234567890ABC1234567890"
},
"priority" : "regular",
"referenceForBeneficiary" : "Your reference sent to the beneficiary",
"referenceForBeneficiary" : "Your-reference-sent-to-the-beneficiary",
"reference" : "Your internal reference for the transfer",
"description" : "Your description for the transfer",
"direction" : "outgoing",

5
yaml/BalancePlatformPaymentNotification-v1.yaml
View File

@@ -16,7 +16,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: '2023-03-16T17:21:17Z'
x-timestamp: '2023-03-30T18:22:09Z'
termsOfService: https://www.adyen.com/legal/terms-and-conditions
contact:
name: Adyen Developer Experience team
@@ -1141,8 +1141,7 @@ components:
examples:
WebhookAck:
summary: Acknowledge Webhook
value:
notificationResponse: '[accepted]'
value: '[accepted]'
post-balancePlatform.incomingTransfer.created-balancePlatform-incomingTransfer-created:
summary: Pending incoming transfer
description: Example webhook when there is an incoming transfer

30
yaml/BalancePlatformTransferNotification-v3.yaml
View File

@@ -12,7 +12,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: '2023-03-16T15:26:18Z'
x-timestamp: '2023-03-28T13:27:37Z'
termsOfService: https://www.adyen.com/legal/terms-and-conditions
contact:
name: Adyen Developer Experience team
@@ -120,7 +120,7 @@ components:
- usRoutingNumber
type: string
type: object
Address-2:
Address:
properties:
city:
description: The name of the city.
@@ -294,6 +294,16 @@ components:
maxLength: 12
minLength: 5
type: string
accountType:
default: checking
description: 'The bank account type.
Possible values: **checking** or **savings**. Defaults to **checking**.'
enum:
- checking
- savings
type: string
institutionNumber:
description: The 3-digit institution number, without separators or whitespace.
maxLength: 3
@@ -530,7 +540,7 @@ components:
properties:
address:
description: Address of the bank account owner.
$ref: '#/components/schemas/Address-2'
$ref: '#/components/schemas/Address'
dateOfBirth:
description: 'The date of birth of the individual.
@@ -576,7 +586,7 @@ components:
description: The type of wallet the network token is associated with.
type: string
type: object
RelayedAuthorisationData-2:
RelayedAuthorisationData:
properties:
metadata:
x-addedInVersion: '3'
@@ -726,6 +736,10 @@ components:
type: object
TransferEvent:
properties:
amount:
x-addedInVersion: '3'
description: The original journal amount.
$ref: '#/components/schemas/Amount'
amountAdjustments:
x-addedInVersion: '3'
description: The amount adjustments in this transfer.
@@ -761,7 +775,7 @@ components:
x-addedInVersion: '3'
description: The reason for the transfer status.
enum:
- amountLimitExceded
- amountLimitExceeded
- approved
- counterpartyAccountBlocked
- counterpartyAccountClosed
@@ -779,6 +793,7 @@ components:
x-addedInVersion: '3'
description: The status of the transfer event.
enum:
- approvalPending
- atmWithdrawal
- atmWithdrawalReversalPending
- atmWithdrawalReversed
@@ -1050,7 +1065,7 @@ components:
x-addedInVersion: '2'
description: Additional information about the status of the transfer.
enum:
- amountLimitExceded
- amountLimitExceeded
- approved
- counterpartyAccountBlocked
- counterpartyAccountClosed
@@ -1086,7 +1101,7 @@ components:
x-addedInVersion: '3'
description: If you are using relayed authorisation, this object contains
information from the relayed authorisation response from your server.
$ref: '#/components/schemas/RelayedAuthorisationData-2'
$ref: '#/components/schemas/RelayedAuthorisationData'
sequenceNumber:
x-addedInVersion: '3'
description: 'The sequence number of the transfer notification. The numbers
@@ -1102,6 +1117,7 @@ components:
description: "The result of the transfer.\n\n For example, **authorised**,\
\ **refused**, or **error**."
enum:
- approvalPending
- atmWithdrawal
- atmWithdrawalReversalPending
- atmWithdrawalReversed

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: '2023-02-20T18:21:55Z'
x-timestamp: '2023-03-23T20:22:14Z'
termsOfService: https://www.adyen.com/legal/terms-and-conditions
contact:
name: Adyen Developer Experience team
@@ -774,6 +774,13 @@ components:
description: Example response for a transfers request
value:
id: 1W1UG35U8A9J5ZLG
source:
balanceAccountId: BAB8B2C3D4E5F6G7H8D9J6GD4
destination:
balanceAccountId: BAB1234567890ABC123456789
amount:
value: 10000
currency: EUR
resultCode: Authorised
post-transfers-payout-to-transfer-instrument:
summary: Pay out to a transfer instrument
@@ -793,4 +800,11 @@ components:
description: Example response for a transfers request
value:
id: 1W1UG35U8A9J5ZLG
source:
balanceAccountId: BAB8B2C3D4E5F6G7H8D9J6GD4
destination:
transferInstrumentId: SE1234567890ABC1234567890
amount:
value: 10000
currency: EUR
resultCode: Authorised

14
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: '2023-02-22T12:23:54Z'
x-timestamp: '2023-03-23T20:22:15Z'
termsOfService: https://www.adyen.com/legal/terms-and-conditions
contact:
name: Adyen Developer Experience team
@@ -761,7 +761,7 @@ components:
x-addedInVersion: '2'
description: Additional information about the status of the transfer.
enum:
- amountLimitExceded
- amountLimitExceeded
- approved
- counterpartyAccountBlocked
- counterpartyAccountClosed
@@ -796,6 +796,7 @@ components:
description: "The result of the transfer.\n\n For example, **authorised**,\
\ **refused**, or **error**."
enum:
- approvalPending
- atmWithdrawal
- atmWithdrawalReversalPending
- atmWithdrawalReversed
@@ -935,7 +936,7 @@ components:
bookingDate: '2022-03-14T12:01:00+01:00'
category: bank
counterparty:
balanceAccountId: NL29ADYX0000000001
balanceAccountId: BA00000000000000000000001
createdAt: '2022-03-14T12:01:00+01:00'
description: YOUR_DESCRIPTION
id: IZK7C25U7DYVX03Y
@@ -961,6 +962,8 @@ components:
balancePlatform: YOUR_BALANCE_PLATFORM
bookingDate: '2022-03-11T11:21:24+01:00'
category: internal
counterparty:
balanceAccountId: BA00000000000000000000001
createdAt: '2022-03-11T11:21:24+01:00'
id: 1VVF0D5U66PIUIVP
instructedAmount:
@@ -979,6 +982,8 @@ components:
balancePlatform: YOUR_BALANCE_PLATFORM
bookingDate: '2022-03-12T14:22:52+01:00'
category: internal
counterparty:
balanceAccountId: BA00000000000000000000001
createdAt: '2022-03-12T14:22:52+01:00'
id: 1WEPGD5U6MS1CFK3
instructedAmount:
@@ -993,6 +998,9 @@ components:
amount:
currency: EUR
value: -8
counterparty:
balanceAccountId: BA00000000000000000000001
reference: REFERENCE_46e8c40e
balanceAccountId: BAB8B2C3D4E5F6G7H8D9J6GD4
balancePlatform: YOUR_BALANCE_PLATFORM
bookingDate: '2022-03-14T21:00:48+01:00'

72
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: '2023-02-22T12:23:54Z'
x-timestamp: '2023-03-28T13:27:36Z'
termsOfService: https://www.adyen.com/legal/terms-and-conditions
contact:
name: Adyen Developer Experience team
@@ -446,6 +446,16 @@ components:
maxLength: 12
minLength: 5
type: string
accountType:
default: checking
description: 'The bank account type.
Possible values: **checking** or **savings**. Defaults to **checking**.'
enum:
- checking
- savings
type: string
institutionNumber:
description: The 3-digit institution number, without separators or whitespace.
maxLength: 3
@@ -741,14 +751,22 @@ components:
address:
description: Address of the bank account owner.
$ref: '#/components/schemas/Address-2'
dateOfBirth:
description: 'The date of birth of the individual.
Format: [ISO-8601](https://www.w3.org/TR/NOTE-datetime); example: YYYY-MM-DD
Allowed only when `type` is **individual**.'
format: date
type: string
firstName:
description: First name of the individual. Required when `type` is **individual**.
description: First name of the individual. Allowed only when `type` is **individual**.
type: string
fullName:
description: The name of the entity.
type: string
lastName:
description: Last name of the individual. Required when `type` is **individual**.
description: Last name of the individual. Allowed only when `type` is **individual**.
type: string
type:
default: unknown
@@ -1105,7 +1123,7 @@ components:
x-addedInVersion: '2'
description: Additional information about the status of the transfer.
enum:
- amountLimitExceded
- amountLimitExceeded
- approved
- counterpartyAccountBlocked
- counterpartyAccountClosed
@@ -1142,6 +1160,7 @@ components:
description: "The result of the transfer.\n\n For example, **authorised**,\
\ **refused**, or **error**."
enum:
- approvalPending
- atmWithdrawal
- atmWithdrawalReversalPending
- atmWithdrawalReversed
@@ -1392,7 +1411,7 @@ components:
bookingDate: '2022-03-14T12:01:00+01:00'
category: bank
counterparty:
balanceAccountId: NL29ADYX0000000001
balanceAccountId: BA00000000000000000000001
createdAt: '2022-03-14T12:01:00+01:00'
description: YOUR_DESCRIPTION
id: IZK7C25U7DYVX03Y
@@ -1418,6 +1437,8 @@ components:
balancePlatform: YOUR_BALANCE_PLATFORM
bookingDate: '2022-03-11T11:21:24+01:00'
category: internal
counterparty:
balanceAccountId: BA00000000000000000000001
createdAt: '2022-03-11T11:21:24+01:00'
id: 1VVF0D5U66PIUIVP
instructedAmount:
@@ -1436,6 +1457,8 @@ components:
balancePlatform: YOUR_BALANCE_PLATFORM
bookingDate: '2022-03-12T14:22:52+01:00'
category: internal
counterparty:
balanceAccountId: BA00000000000000000000001
createdAt: '2022-03-12T14:22:52+01:00'
id: 1WEPGD5U6MS1CFK3
instructedAmount:
@@ -1456,6 +1479,9 @@ components:
createdAt: '2022-03-14T15:00:00+01:00'
description: YOUR_DESCRIPTION_2
id: 2QP32A5U7IWC5WKG
counterparty:
balanceAccountId: BA00000000000000000000001
reference: REFERENCE_46e8c40e
instructedAmount:
currency: EUR
value: -8
@@ -1465,8 +1491,8 @@ components:
next:
href: https://balanceplatform-api-test.adyen.com/btl/v2/transactions?balancePlatform=Bastronaut&createdUntil=2022-03-21T00%3A00%3A00Z&createdSince=2022-03-11T00%3A00%3A00Z&limit=3&cursor=S2B-TSAjOkIrYlIlbjdqe0RreHRyM32lKRSxubXBHRkhHL2E32XitQQz5SfzpucD5HbHwpM1p6NDR1eXVQLFF6MmY33J32sobDxQYT90MHIud1hwLnd6JitcX32xJ
post-transfers-payout-cross-border:
summary: Make a cross border transfer
description: Example request to make a cross border transfer
summary: Make a cross-border transfer
description: Example request to make a cross-border transfer
value:
amount:
value: 110000
@@ -1484,12 +1510,12 @@ components:
stateOrProvince: CA
street: Brannan Street
street2: '274'
accountIdentification:
type: numberAndBic
accountNumber: '123456789'
bic: BOFAUS3NXXX
priority: wire
referenceForBeneficiary: Your reference sent to the beneficiary
accountIdentification:
type: numberAndBic
accountNumber: '123456789'
bic: BOFAUS3NXXX
priority: crossBorder
referenceForBeneficiary: Your-reference-sent-to-the-beneficiary
reference: Your internal reference for the transfer
description: Your description for the transfer
post-transfers-payout-cross-border-200:
@@ -1517,8 +1543,8 @@ components:
type: numberAndBic
accountNumber: '123456789'
bic: BOFAUS3NXXX
priority: wire
referenceForBeneficiary: Your reference sent to the beneficiary
priority: crossBorder
referenceForBeneficiary: Your-reference-sent-to-the-beneficiary
reference: Your internal reference for the transfer
description: Your description for the transfer
direction: outgoing
@@ -1541,7 +1567,7 @@ components:
type: iban
iban: NL91ABNA0417164300
priority: regular
referenceForBeneficiary: Your reference sent to the beneficiary
referenceForBeneficiary: Your-reference-sent-to-the-beneficiary
reference: Your internal reference for the transfer
description: Your description for the transfer
post-transfers-payout-local-transfer-sepa-200:
@@ -1562,7 +1588,7 @@ components:
type: iban
iban: NL91ABNA0417164300
priority: regular
referenceForBeneficiary: Your reference sent to the beneficiary
referenceForBeneficiary: Your-reference-sent-to-the-beneficiary
reference: Your internal reference for the transfer
description: Your description for the transfer
direction: outgoing
@@ -1586,7 +1612,7 @@ components:
accountNumber: '123456789'
routingNumber: 011000138
priority: regular
referenceForBeneficiary: Your reference sent to the beneficiary
referenceForBeneficiary: Your-reference-sent-to-the-beneficiary
reference: Your internal reference for the transfer
description: Your description for the transfer
post-transfers-payout-local-transfer-us-200:
@@ -1608,7 +1634,7 @@ components:
accountNumber: '123456789'
routingNumber: 011000138
priority: regular
referenceForBeneficiary: Your reference sent to the beneficiary
referenceForBeneficiary: Your-reference-sent-to-the-beneficiary
reference: Your internal reference for the transfer
description: Your description for the transfer
direction: outgoing
@@ -1625,7 +1651,7 @@ components:
category: internal
counterparty:
balanceAccountId: BA32272223222B5LPRFDW7J9G
referenceForBeneficiary: Your reference sent to the beneficiary
referenceForBeneficiary: Your-reference-sent-to-the-beneficiary
reference: Your internal reference for the transfer
description: Your description for the transfer
post-transfers-payout-to-balance-account-200:
@@ -1640,7 +1666,7 @@ components:
category: internal
counterparty:
balanceAccountId: BA32272223222B5LPRFDW7J9G
referenceForBeneficiary: Your reference sent to the beneficiary
referenceForBeneficiary: Your-reference-sent-to-the-beneficiary
reference: Your internal reference for the transfer
description: Your description for the transfer
direction: outgoing
@@ -1658,7 +1684,7 @@ components:
counterparty:
transferInstrumentId: SE1234567890ABC1234567890
priority: regular
referenceForBeneficiary: Your reference sent to the beneficiary
referenceForBeneficiary: Your-reference-sent-to-the-beneficiary
reference: Your internal reference for the transfer
description: Your description for the transfer
post-transfers-payout-to-transfer-instrument-200:
@@ -1674,7 +1700,7 @@ components:
counterparty:
transferInstrumentId: SE1234567890ABC1234567890
priority: regular
referenceForBeneficiary: Your reference sent to the beneficiary
referenceForBeneficiary: Your-reference-sent-to-the-beneficiary
reference: Your internal reference for the transfer
description: Your description for the transfer
direction: outgoing