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
2022-11-28 09:30:02 +00:00
parent 31c72185cf
commit 6eaa140bed
6 changed files with 200 additions and 42 deletions
Download Patch File Download Diff File Expand all files Collapse all files

11
json/TransferService-v1.json
View File

@@ -9,8 +9,8 @@
"version" : "1",
"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/#/balanceplatform/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-09-30T16:25:47Z",
"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",
"termsOfService" : "https://www.adyen.com/legal/terms-and-conditions",
"contact" : {
"name" : "Adyen Developer Experience team",
@@ -42,6 +42,7 @@
"operationId" : "get-transactions",
"x-groupName" : "Transactions",
"x-sortIndex" : 1,
"x-methodName" : "getAllTransactions",
"security" : [
{
"ApiKeyAuth" : [
@@ -181,6 +182,7 @@
"operationId" : "get-transactions-id",
"x-groupName" : "Transactions",
"x-sortIndex" : 2,
"x-methodName" : "getTransaction",
"security" : [
{
"ApiKeyAuth" : [
@@ -258,11 +260,12 @@
"Transfers"
],
"summary" : "Transfer funds",
"description" : "Starts a transfer request to move funds within your balance platform, or send funds to a [transfer instrument](https://docs.adyen.com/api-explorer/#/balanceplatform/v1/post/transferInstruments). Adyen sends the outcome of the transfer request through webhooks.\n\nTo use this endpoint, you need an additional role for your API credential and transfers must be enabled for the source balance account. Your Adyen contact will set these up for you.",
"description" : "Starts a transfer request to move funds within your balance platform, or send funds to a [transfer instrument](https://docs.adyen.com/api-explorer/#/legalentity/v1/post/transferInstruments). Adyen sends the outcome of the transfer request through webhooks.\n\nTo use this endpoint, you need an additional role for your API credential and transfers must be enabled for the source balance account. Your Adyen contact will set these up for you.",
"x-addedInVersion" : "1",
"operationId" : "post-transfers",
"x-groupName" : "Transfers",
"x-sortIndex" : 1,
"x-methodName" : "transferFunds",
"security" : [
{
"ApiKeyAuth" : [
@@ -709,7 +712,6 @@
"id" : {
"x-addedInVersion" : "1",
"description" : "Unique identifier of the transaction.",
"readOnly" : true,
"type" : "string"
},
"instructedAmount" : {
@@ -759,6 +761,7 @@
"chargeback",
"chargebackReversal",
"depositCorrection",
"directDebit",
"fee",
"grant",
"installment",

16
json/TransferService-v2.json
View File

@@ -9,8 +9,8 @@
"version" : "2",
"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/#/balanceplatform/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-10-04T17:25:48Z",
"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",
"termsOfService" : "https://www.adyen.com/legal/terms-and-conditions",
"contact" : {
"name" : "Adyen Developer Experience team",
@@ -42,6 +42,7 @@
"operationId" : "get-transactions",
"x-groupName" : "Transactions",
"x-sortIndex" : 1,
"x-methodName" : "getAllTransactions",
"security" : [
{
"ApiKeyAuth" : [
@@ -186,6 +187,7 @@
"operationId" : "get-transactions-id",
"x-groupName" : "Transactions",
"x-sortIndex" : 2,
"x-methodName" : "getTransaction",
"security" : [
{
"ApiKeyAuth" : [
@@ -273,6 +275,7 @@
"operationId" : "post-transfers",
"x-groupName" : "Transfers",
"x-sortIndex" : 1,
"x-methodName" : "transferFunds",
"security" : [
{
"ApiKeyAuth" : [
@@ -438,7 +441,7 @@
"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",
"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",
@@ -742,7 +745,6 @@
"id" : {
"x-addedInVersion" : "1",
"description" : "Unique identifier of the transaction.",
"readOnly" : true,
"type" : "string"
},
"instructedAmount" : {
@@ -792,6 +794,7 @@
"chargeback",
"chargebackReversal",
"depositCorrection",
"directDebit",
"fee",
"grant",
"installment",
@@ -883,7 +886,6 @@
},
"id" : {
"description" : "The ID of the resource.",
"readOnly" : true,
"type" : "string"
},
"paymentInstrumentId" : {
@@ -920,6 +922,9 @@
"atmWithdrawal",
"atmWithdrawalReversalPending",
"atmWithdrawalReversed",
"authAdjustmentAuthorised",
"authAdjustmentError",
"authAdjustmentRefused",
"authorised",
"bankTransfer",
"bankTransferPending",
@@ -1009,7 +1014,6 @@
},
"id" : {
"description" : "The ID of the resource.",
"readOnly" : true,
"type" : "string"
},
"paymentInstrumentId" : {

102
json/TransferService-v3.json
View File

@@ -9,8 +9,8 @@
"version" : "3",
"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/#/balanceplatform/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-10-06T11:24:30Z",
"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",
"termsOfService" : "https://www.adyen.com/legal/terms-and-conditions",
"contact" : {
"name" : "Adyen Developer Experience team",
@@ -42,6 +42,7 @@
"operationId" : "get-transactions",
"x-groupName" : "Transactions",
"x-sortIndex" : 1,
"x-methodName" : "getAllTransactions",
"security" : [
{
"ApiKeyAuth" : [
@@ -186,6 +187,7 @@
"operationId" : "get-transactions-id",
"x-groupName" : "Transactions",
"x-sortIndex" : 2,
"x-methodName" : "getTransaction",
"security" : [
{
"ApiKeyAuth" : [
@@ -273,6 +275,7 @@
"operationId" : "post-transfers",
"x-groupName" : "Transfers",
"x-sortIndex" : 1,
"x-methodName" : "transferFunds",
"security" : [
{
"ApiKeyAuth" : [
@@ -414,6 +417,7 @@
}
},
"required" : [
"type",
"accountNumber",
"bsbCode"
]
@@ -515,6 +519,7 @@
}
},
"required" : [
"type",
"branchNumber",
"accountNumber",
"bankCode"
@@ -538,6 +543,9 @@
{
"$ref" : "#/components/schemas/CZLocalAccountIdentification"
},
{
"$ref" : "#/components/schemas/DKLocalAccountIdentification"
},
{
"$ref" : "#/components/schemas/HULocalAccountIdentification"
},
@@ -556,6 +564,9 @@
{
"$ref" : "#/components/schemas/SELocalAccountIdentification"
},
{
"$ref" : "#/components/schemas/SGLocalAccountIdentification"
},
{
"$ref" : "#/components/schemas/UKLocalAccountIdentification"
},
@@ -595,6 +606,7 @@
}
},
"required" : [
"type",
"accountNumber",
"bankCode"
]
@@ -635,6 +647,36 @@
}
}
},
"DKLocalAccountIdentification" : {
"additionalProperties" : false,
"properties" : {
"accountNumber" : {
"description" : "The 4-10 digits bank account number (Kontonummer) (without separators or whitespace).",
"maxLength" : 10,
"minLength" : 4,
"type" : "string"
},
"bankCode" : {
"description" : "The 4-digit bank code (Registreringsnummer) (without separators or whitespace).",
"maxLength" : 4,
"minLength" : 4,
"type" : "string"
},
"type" : {
"default" : "dkLocal",
"description" : "**dkLocal**",
"enum" : [
"dkLocal"
],
"type" : "string"
}
},
"required" : [
"type",
"accountNumber",
"bankCode"
]
},
"HULocalAccountIdentification" : {
"additionalProperties" : false,
"properties" : {
@@ -654,6 +696,7 @@
}
},
"required" : [
"type",
"accountNumber"
]
},
@@ -674,6 +717,7 @@
}
},
"required" : [
"type",
"iban"
]
},
@@ -779,6 +823,7 @@
}
},
"required" : [
"type",
"accountNumber"
]
},
@@ -838,6 +883,7 @@
}
},
"required" : [
"type",
"accountNumber",
"bic"
]
@@ -861,6 +907,7 @@
}
},
"required" : [
"type",
"accountNumber"
]
},
@@ -883,7 +930,7 @@
"type" : "string"
},
"type" : {
"default" : "**unknown**",
"default" : "unknown",
"description" : "The type of entity that owns the bank account.\n\n Possible values: **individual**, **organization**, or **unknown**.",
"enum" : [
"individual",
@@ -973,10 +1020,40 @@
}
},
"required" : [
"type",
"accountNumber",
"clearingNumber"
]
},
"SGLocalAccountIdentification" : {
"additionalProperties" : false,
"properties" : {
"accountNumber" : {
"description" : "The 4-19 digit bank account number, separators, or whitespace.",
"maxLength" : 19,
"minLength" : 4,
"type" : "string"
},
"bic" : {
"description" : "The bank's 8 or 11 character BIC or SWIFT code.",
"maxLength" : 11,
"minLength" : 8,
"type" : "string"
},
"type" : {
"default" : "sgLocal",
"description" : "**sgLocal**",
"enum" : [
"sgLocal"
],
"type" : "string"
}
},
"required" : [
"accountNumber",
"bic"
]
},
"Transaction" : {
"properties" : {
"accountHolderId" : {
@@ -1036,7 +1113,6 @@
"id" : {
"x-addedInVersion" : "1",
"description" : "Unique identifier of the transaction.",
"readOnly" : true,
"type" : "string"
},
"instructedAmount" : {
@@ -1086,6 +1162,7 @@
"chargeback",
"chargebackReversal",
"depositCorrection",
"directDebit",
"fee",
"grant",
"installment",
@@ -1182,7 +1259,6 @@
},
"id" : {
"description" : "The ID of the resource.",
"readOnly" : true,
"type" : "string"
},
"paymentInstrumentId" : {
@@ -1191,7 +1267,7 @@
},
"priority" : {
"x-addedInVersion" : "3",
"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. Required for transfers with `category` **bank**.\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",
"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. Required for transfers with `category` **bank**.\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",
@@ -1230,6 +1306,9 @@
"atmWithdrawal",
"atmWithdrawalReversalPending",
"atmWithdrawalReversed",
"authAdjustmentAuthorised",
"authAdjustmentError",
"authAdjustmentRefused",
"authorised",
"bankTransfer",
"bankTransferPending",
@@ -1325,7 +1404,6 @@
},
"id" : {
"description" : "The ID of the resource.",
"readOnly" : true,
"type" : "string"
},
"paymentInstrumentId" : {
@@ -1334,7 +1412,7 @@
},
"priority" : {
"x-addedInVersion" : "3",
"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. Required for transfers with `category` **bank**.\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",
"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. Required for transfers with `category` **bank**.\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",
@@ -1387,6 +1465,7 @@
}
},
"required" : [
"type",
"accountNumber",
"sortCode"
]
@@ -1425,6 +1504,7 @@
}
},
"required" : [
"type",
"accountNumber",
"routingNumber"
]
@@ -1550,8 +1630,8 @@
}
},
"post-transfers-payout-cross-border" : {
"summary" : "Make a SEPA funds transfer",
"description" : "Example request to make a SEPA funds transfer",
"summary" : "Make a cross border transfer",
"description" : "Example request to make a cross border transfer",
"value" : {
"amount" : {
"value" : 110000,
@@ -1623,7 +1703,7 @@
},
"post-transfers-payout-local-transfer-sepa" : {
"summary" : "Make a SEPA funds transfer",
"description" : "Example request to make a US local funds transfer",
"description" : "Example request to make a SEPA funds transfer",
"value" : {
"amount" : {
"value" : 110000,

11
yaml/TransferService-v1.yaml
View File

@@ -7,7 +7,7 @@ info:
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/#/balanceplatform/latest/post/transferInstruments).\n\
\ 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\"\
@@ -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-09-30T16:25:47Z'
x-timestamp: '2022-11-24T10:17:08Z'
termsOfService: https://www.adyen.com/legal/terms-and-conditions
contact:
name: Adyen Developer Experience team
@@ -50,6 +50,7 @@ paths:
operationId: get-transactions
x-groupName: Transactions
x-sortIndex: 1
x-methodName: getAllTransactions
security:
- ApiKeyAuth: []
parameters:
@@ -142,6 +143,7 @@ paths:
operationId: get-transactions-id
x-groupName: Transactions
x-sortIndex: 2
x-methodName: getTransaction
security:
- ApiKeyAuth: []
parameters:
@@ -188,7 +190,7 @@ paths:
- Transfers
summary: Transfer funds
description: 'Starts a transfer request to move funds within your balance platform,
or send funds to a [transfer instrument](https://docs.adyen.com/api-explorer/#/balanceplatform/v1/post/transferInstruments).
or send funds to a [transfer instrument](https://docs.adyen.com/api-explorer/#/legalentity/v1/post/transferInstruments).
Adyen sends the outcome of the transfer request through webhooks.
@@ -199,6 +201,7 @@ paths:
operationId: post-transfers
x-groupName: Transfers
x-sortIndex: 1
x-methodName: transferFunds
security:
- ApiKeyAuth: []
requestBody:
@@ -534,7 +537,6 @@ components:
id:
x-addedInVersion: '1'
description: Unique identifier of the transaction.
readOnly: true
type: string
instructedAmount:
x-addedInVersion: '1'
@@ -590,6 +592,7 @@ components:
- chargeback
- chargebackReversal
- depositCorrection
- directDebit
- fee
- grant
- installment

16
yaml/TransferService-v2.yaml
View File

@@ -7,7 +7,7 @@ info:
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/#/balanceplatform/latest/post/transferInstruments).\n\
\ 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\"\
@@ -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-10-04T17:25:48Z'
x-timestamp: '2022-11-24T11:24:00Z'
termsOfService: https://www.adyen.com/legal/terms-and-conditions
contact:
name: Adyen Developer Experience team
@@ -50,6 +50,7 @@ paths:
operationId: get-transactions
x-groupName: Transactions
x-sortIndex: 1
x-methodName: getAllTransactions
security:
- ApiKeyAuth: []
parameters:
@@ -145,6 +146,7 @@ paths:
operationId: get-transactions-id
x-groupName: Transactions
x-sortIndex: 2
x-methodName: getTransaction
security:
- ApiKeyAuth: []
parameters:
@@ -206,6 +208,7 @@ paths:
operationId: post-transfers
x-groupName: Transfers
x-sortIndex: 1
x-methodName: transferFunds
security:
- ApiKeyAuth: []
requestBody:
@@ -344,7 +347,7 @@ components:
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
@@ -577,7 +580,6 @@ components:
id:
x-addedInVersion: '1'
description: Unique identifier of the transaction.
readOnly: true
type: string
instructedAmount:
x-addedInVersion: '1'
@@ -633,6 +635,7 @@ components:
- chargeback
- chargebackReversal
- depositCorrection
- directDebit
- fee
- grant
- installment
@@ -714,7 +717,6 @@ components:
type: string
id:
description: The ID of the resource.
readOnly: true
type: string
paymentInstrumentId:
description: Unique identifier of the source [payment instrument](https://docs.adyen.com/api-explorer/#/balanceplatform/latest/post/paymentInstruments__resParam_id).
@@ -754,6 +756,9 @@ components:
- atmWithdrawal
- atmWithdrawalReversalPending
- atmWithdrawalReversed
- authAdjustmentAuthorised
- authAdjustmentError
- authAdjustmentRefused
- authorised
- bankTransfer
- bankTransferPending
@@ -838,7 +843,6 @@ components:
type: string
id:
description: The ID of the resource.
readOnly: true
type: string
paymentInstrumentId:
description: Unique identifier of the source [payment instrument](https://docs.adyen.com/api-explorer/#/balanceplatform/latest/post/paymentInstruments__resParam_id).

86
yaml/TransferService-v3.yaml
View File

@@ -7,7 +7,7 @@ info:
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/#/balanceplatform/latest/post/transferInstruments).\n\
\ 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\"\
@@ -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-10-06T11:24:30Z'
x-timestamp: '2022-11-24T11:24:00Z'
termsOfService: https://www.adyen.com/legal/terms-and-conditions
contact:
name: Adyen Developer Experience team
@@ -50,6 +50,7 @@ paths:
operationId: get-transactions
x-groupName: Transactions
x-sortIndex: 1
x-methodName: getAllTransactions
security:
- ApiKeyAuth: []
parameters:
@@ -145,6 +146,7 @@ paths:
operationId: get-transactions-id
x-groupName: Transactions
x-sortIndex: 2
x-methodName: getTransaction
security:
- ApiKeyAuth: []
parameters:
@@ -206,6 +208,7 @@ paths:
operationId: post-transfers
x-groupName: Transfers
x-sortIndex: 1
x-methodName: transferFunds
security:
- ApiKeyAuth: []
requestBody:
@@ -296,6 +299,7 @@ components:
- auLocal
type: string
required:
- type
- accountNumber
- bsbCode
AdditionalBankIdentification:
@@ -387,6 +391,7 @@ components:
- brLocal
type: string
required:
- type
- branchNumber
- accountNumber
- bankCode
@@ -403,12 +408,14 @@ components:
- $ref: '#/components/schemas/AULocalAccountIdentification'
- $ref: '#/components/schemas/BRLocalAccountIdentification'
- $ref: '#/components/schemas/CZLocalAccountIdentification'
- $ref: '#/components/schemas/DKLocalAccountIdentification'
- $ref: '#/components/schemas/HULocalAccountIdentification'
- $ref: '#/components/schemas/IbanAccountIdentification'
- $ref: '#/components/schemas/NOLocalAccountIdentification'
- $ref: '#/components/schemas/NumberAndBicAccountIdentification'
- $ref: '#/components/schemas/PLLocalAccountIdentification'
- $ref: '#/components/schemas/SELocalAccountIdentification'
- $ref: '#/components/schemas/SGLocalAccountIdentification'
- $ref: '#/components/schemas/UKLocalAccountIdentification'
- $ref: '#/components/schemas/USLocalAccountIdentification'
required:
@@ -441,6 +448,7 @@ components:
- czLocal
type: string
required:
- type
- accountNumber
- bankCode
CounterpartyInfoV3:
@@ -468,6 +476,31 @@ components:
transferInstrumentId:
description: Unique identifier of the [transfer instrument](https://docs.adyen.com/api-explorer/#/legalentity/latest/post/transferInstruments__resParam_id).
type: string
DKLocalAccountIdentification:
additionalProperties: false
properties:
accountNumber:
description: The 4-10 digits bank account number (Kontonummer) (without
separators or whitespace).
maxLength: 10
minLength: 4
type: string
bankCode:
description: The 4-digit bank code (Registreringsnummer) (without separators
or whitespace).
maxLength: 4
minLength: 4
type: string
type:
default: dkLocal
description: '**dkLocal**'
enum:
- dkLocal
type: string
required:
- type
- accountNumber
- bankCode
HULocalAccountIdentification:
additionalProperties: false
properties:
@@ -483,6 +516,7 @@ components:
- huLocal
type: string
required:
- type
- accountNumber
IbanAccountIdentification:
additionalProperties: false
@@ -498,6 +532,7 @@ components:
- iban
type: string
required:
- type
- iban
InvalidField:
properties:
@@ -569,6 +604,7 @@ components:
- noLocal
type: string
required:
- type
- accountNumber
NameLocation:
properties:
@@ -616,6 +652,7 @@ components:
- numberAndBic
type: string
required:
- type
- accountNumber
- bic
PLLocalAccountIdentification:
@@ -634,6 +671,7 @@ components:
- plLocal
type: string
required:
- type
- accountNumber
PartyIdentification-2:
properties:
@@ -650,7 +688,7 @@ components:
description: Last name of the individual. Required when `type` is **individual**.
type: string
type:
default: '**unknown**'
default: unknown
description: "The type of entity that owns the bank account.\n\n Possible\
\ values: **individual**, **organization**, or **unknown**."
enum:
@@ -724,8 +762,31 @@ components:
- seLocal
type: string
required:
- type
- accountNumber
- clearingNumber
SGLocalAccountIdentification:
additionalProperties: false
properties:
accountNumber:
description: The 4-19 digit bank account number, separators, or whitespace.
maxLength: 19
minLength: 4
type: string
bic:
description: The bank's 8 or 11 character BIC or SWIFT code.
maxLength: 11
minLength: 8
type: string
type:
default: sgLocal
description: '**sgLocal**'
enum:
- sgLocal
type: string
required:
- accountNumber
- bic
Transaction:
properties:
accountHolderId:
@@ -782,7 +843,6 @@ components:
id:
x-addedInVersion: '1'
description: Unique identifier of the transaction.
readOnly: true
type: string
instructedAmount:
x-addedInVersion: '1'
@@ -838,6 +898,7 @@ components:
- chargeback
- chargebackReversal
- depositCorrection
- directDebit
- fee
- grant
- installment
@@ -924,7 +985,6 @@ components:
type: string
id:
description: The ID of the resource.
readOnly: true
type: string
paymentInstrumentId:
description: Unique identifier of the source [payment instrument](https://docs.adyen.com/api-explorer/#/balanceplatform/latest/post/paymentInstruments__resParam_id).
@@ -950,7 +1010,7 @@ components:
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
@@ -994,6 +1054,9 @@ components:
- atmWithdrawal
- atmWithdrawalReversalPending
- atmWithdrawalReversed
- authAdjustmentAuthorised
- authAdjustmentError
- authAdjustmentRefused
- authorised
- bankTransfer
- bankTransferPending
@@ -1084,7 +1147,6 @@ components:
type: string
id:
description: The ID of the resource.
readOnly: true
type: string
paymentInstrumentId:
description: Unique identifier of the source [payment instrument](https://docs.adyen.com/api-explorer/#/balanceplatform/latest/post/paymentInstruments__resParam_id).
@@ -1110,7 +1172,7 @@ components:
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
@@ -1162,6 +1224,7 @@ components:
- ukLocal
type: string
required:
- type
- accountNumber
- sortCode
USLocalAccountIdentification:
@@ -1195,6 +1258,7 @@ components:
- usLocal
type: string
required:
- type
- accountNumber
- routingNumber
securitySchemes:
@@ -1292,8 +1356,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 SEPA funds transfer
description: Example request to make a SEPA funds transfer
summary: Make a cross border transfer
description: Example request to make a cross border transfer
value:
amount:
value: 110000
@@ -1351,7 +1415,7 @@ components:
status: authorised
post-transfers-payout-local-transfer-sepa:
summary: Make a SEPA funds transfer
description: Example request to make a US local funds transfer
description: Example request to make a SEPA funds transfer
value:
amount:
value: 110000