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-09-07 07:57:58 +00:00
parent 2bf529a944
commit 679529708b
6 changed files with 20 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files

3
json/TransferService-v1.json
View File

@@ -10,7 +10,7 @@
"x-publicVersion" : true,
"title" : "Transfers API",
"description" : "The Transfers API provides an endpoint that you can use to move funds within your balance platform, or to 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\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-08-04T16:19:57Z",
"x-timestamp" : "2022-09-05T15:24:41Z",
"termsOfService" : "https://www.adyen.com/legal/terms-and-conditions",
"contact" : {
"name" : "Adyen Developer Experience team",
@@ -761,6 +761,7 @@
"fee",
"grant",
"installment",
"installmentReversal",
"internalTransfer",
"invoiceDeduction",
"leftover",

5
json/TransferService-v2.json
View File

@@ -10,7 +10,7 @@
"x-publicVersion" : true,
"title" : "Transfers API",
"description" : "The Transfers API provides an endpoint that you can use to move funds within your balance platform, or to 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\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-01T13:20:13Z",
"x-timestamp" : "2022-09-05T15:24:41Z",
"termsOfService" : "https://www.adyen.com/legal/terms-and-conditions",
"contact" : {
"name" : "Adyen Developer Experience team",
@@ -794,6 +794,7 @@
"fee",
"grant",
"installment",
"installmentReversal",
"internalTransfer",
"invoiceDeduction",
"leftover",
@@ -949,6 +950,8 @@
"feePending",
"installment",
"installmentPending",
"installmentReversed",
"installmentReversedPending",
"internalTransfer",
"internalTransferPending",
"invoiceDeduction",

5
json/TransferService-v3.json
View File

@@ -10,7 +10,7 @@
"x-publicVersion" : true,
"title" : "Transfers API",
"description" : "The Transfers API provides an endpoint that you can use to move funds within your balance platform, or to 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\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-01T13:20:13Z",
"x-timestamp" : "2022-09-05T15:24:41Z",
"termsOfService" : "https://www.adyen.com/legal/terms-and-conditions",
"contact" : {
"name" : "Adyen Developer Experience team",
@@ -1049,6 +1049,7 @@
"fee",
"grant",
"installment",
"installmentReversal",
"internalTransfer",
"invoiceDeduction",
"leftover",
@@ -1220,6 +1221,8 @@
"feePending",
"installment",
"installmentPending",
"installmentReversed",
"installmentReversedPending",
"internalTransfer",
"internalTransferPending",
"invoiceDeduction",

3
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-08-04T16:19:57Z'
x-timestamp: '2022-09-05T15:24:41Z'
termsOfService: https://www.adyen.com/legal/terms-and-conditions
contact:
name: Adyen Developer Experience team
@@ -592,6 +592,7 @@ components:
- fee
- grant
- installment
- installmentReversal
- internalTransfer
- invoiceDeduction
- leftover

5
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/v1`.\n\n"
x-timestamp: '2022-09-01T13:20:13Z'
x-timestamp: '2022-09-05T15:24:41Z'
termsOfService: https://www.adyen.com/legal/terms-and-conditions
contact:
name: Adyen Developer Experience team
@@ -635,6 +635,7 @@ components:
- fee
- grant
- installment
- installmentReversal
- internalTransfer
- invoiceDeduction
- leftover
@@ -783,6 +784,8 @@ components:
- feePending
- installment
- installmentPending
- installmentReversed
- installmentReversedPending
- internalTransfer
- internalTransferPending
- invoiceDeduction

5
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/v1`.\n\n"
x-timestamp: '2022-09-01T13:20:13Z'
x-timestamp: '2022-09-05T15:24:41Z'
termsOfService: https://www.adyen.com/legal/terms-and-conditions
contact:
name: Adyen Developer Experience team
@@ -811,6 +811,7 @@ components:
- fee
- grant
- installment
- installmentReversal
- internalTransfer
- invoiceDeduction
- leftover
@@ -994,6 +995,8 @@ components:
- feePending
- installment
- installmentPending
- installmentReversed
- installmentReversedPending
- internalTransfer
- internalTransferPending
- invoiceDeduction