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-10-04 12:53:15 +00:00
parent 0afad49844
commit ff20409ba3
6 changed files with 105 additions and 55 deletions
Download Patch File Download Diff File Expand all files Collapse all files

9
json/TransferService-v1.json
View File

@@ -9,8 +9,8 @@
"version" : "1",
"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-05T15:24:41Z",
"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",
"termsOfService" : "https://www.adyen.com/legal/terms-and-conditions",
"contact" : {
"name" : "Adyen Developer Experience team",
@@ -752,6 +752,7 @@
"enum" : [
"atmWithdrawal",
"atmWithdrawalReversal",
"balanceAdjustment",
"bankTransfer",
"capture",
"captureReversal",
@@ -786,14 +787,10 @@
},
"required" : [
"id",
"transferId",
"accountHolderId",
"balanceAccountId",
"paymentInstrumentId",
"amount",
"referenceForBeneficiary",
"reference",
"instructedAmount",
"status",
"createdAt",
"bookingDate",

13
json/TransferService-v2.json
View File

@@ -9,8 +9,8 @@
"version" : "2",
"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-05T15:24:41Z",
"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-09-30T16:25:48Z",
"termsOfService" : "https://www.adyen.com/legal/terms-and-conditions",
"contact" : {
"name" : "Adyen Developer Experience team",
@@ -785,6 +785,7 @@
"enum" : [
"atmWithdrawal",
"atmWithdrawalReversal",
"balanceAdjustment",
"bankTransfer",
"capture",
"captureReversal",
@@ -819,14 +820,10 @@
},
"required" : [
"id",
"transferId",
"accountHolderId",
"balanceAccountId",
"paymentInstrumentId",
"amount",
"referenceForBeneficiary",
"reference",
"instructedAmount",
"status",
"createdAt",
"bookingDate",
@@ -1265,7 +1262,7 @@
"transferInstrumentId" : "SE1234567890ABC1234567890"
},
"bank" : {
"priority" : "fast"
"priority" : "regular"
},
"referenceForBeneficiary" : "Your reference sent to the beneficiary",
"reference" : "Your internal reference for the transfer",
@@ -1286,7 +1283,7 @@
"transferInstrumentId" : "SE1234567890ABC1234567890"
},
"bank" : {
"priority" : "fast"
"priority" : "regular"
},
"referenceForBeneficiary" : "Your reference sent to the beneficiary",
"reference" : "Your internal reference for the transfer",

52
json/TransferService-v3.json
View File

@@ -9,8 +9,8 @@
"version" : "3",
"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-05T15:24:41Z",
"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-09-30T16:25:48Z",
"termsOfService" : "https://www.adyen.com/legal/terms-and-conditions",
"contact" : {
"name" : "Adyen Developer Experience team",
@@ -484,6 +484,42 @@
"currency"
]
},
"BRLocalAccountIdentification" : {
"additionalProperties" : false,
"properties" : {
"accountNumber" : {
"description" : "The bank account number, without separators or whitespace.",
"maxLength" : 10,
"minLength" : 1,
"type" : "string"
},
"bankCode" : {
"description" : "The 3-digit Brazilian Bank Code (with leading zeros).",
"maxLength" : 3,
"minLength" : 3,
"type" : "string"
},
"branchNumber" : {
"description" : "The bank account branch number, without separators or whitespace.",
"maxLength" : 4,
"minLength" : 1,
"type" : "string"
},
"type" : {
"default" : "brLocal",
"description" : "**brLocal**",
"enum" : [
"brLocal"
],
"type" : "string"
}
},
"required" : [
"branchNumber",
"accountNumber",
"bankCode"
]
},
"BankAccountV3" : {
"properties" : {
"accountHolder" : {
@@ -496,6 +532,9 @@
{
"$ref" : "#/components/schemas/AULocalAccountIdentification"
},
{
"$ref" : "#/components/schemas/BRLocalAccountIdentification"
},
{
"$ref" : "#/components/schemas/CZLocalAccountIdentification"
},
@@ -1040,6 +1079,7 @@
"enum" : [
"atmWithdrawal",
"atmWithdrawalReversal",
"balanceAdjustment",
"bankTransfer",
"capture",
"captureReversal",
@@ -1074,14 +1114,10 @@
},
"required" : [
"id",
"transferId",
"accountHolderId",
"balanceAccountId",
"paymentInstrumentId",
"amount",
"referenceForBeneficiary",
"reference",
"instructedAmount",
"status",
"createdAt",
"bookingDate",
@@ -1760,7 +1796,7 @@
"counterparty" : {
"transferInstrumentId" : "SE1234567890ABC1234567890"
},
"priority" : "fast",
"priority" : "regular",
"referenceForBeneficiary" : "Your reference sent to the beneficiary",
"reference" : "Your internal reference for the transfer",
"description" : "Your description for the transfer"
@@ -1780,7 +1816,7 @@
"counterparty" : {
"transferInstrumentId" : "SE1234567890ABC1234567890"
},
"priority" : "fast",
"priority" : "regular",
"referenceForBeneficiary" : "Your reference sent to the beneficiary",
"reference" : "Your internal reference for the transfer",
"description" : "Your description for the transfer",

15
yaml/TransferService-v1.yaml
View File

@@ -5,9 +5,9 @@ info:
version: '1'
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\
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\"\
@@ -19,11 +19,11 @@ info:
\ 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\
\ \"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-05T15:24:41Z'
x-timestamp: '2022-09-30T16:25:47Z'
termsOfService: https://www.adyen.com/legal/terms-and-conditions
contact:
name: Adyen Developer Experience team
@@ -583,6 +583,7 @@ components:
enum:
- atmWithdrawal
- atmWithdrawalReversal
- balanceAdjustment
- bankTransfer
- capture
- captureReversal
@@ -614,14 +615,10 @@ components:
type: string
required:
- id
- transferId
- accountHolderId
- balanceAccountId
- paymentInstrumentId
- amount
- referenceForBeneficiary
- reference
- instructedAmount
- status
- createdAt
- bookingDate

21
yaml/TransferService-v2.yaml
View File

@@ -5,9 +5,9 @@ info:
version: '2'
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\
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\"\
@@ -19,11 +19,11 @@ info:
\ 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\
\ \"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/v1`.\n\n"
x-timestamp: '2022-09-05T15:24:41Z'
\ to send requests to `https://balanceplatform-api-live.adyen.com/btl/v2`.\n\n"
x-timestamp: '2022-09-30T16:25:48Z'
termsOfService: https://www.adyen.com/legal/terms-and-conditions
contact:
name: Adyen Developer Experience team
@@ -626,6 +626,7 @@ components:
enum:
- atmWithdrawal
- atmWithdrawalReversal
- balanceAdjustment
- bankTransfer
- capture
- captureReversal
@@ -657,14 +658,10 @@ components:
type: string
required:
- id
- transferId
- accountHolderId
- balanceAccountId
- paymentInstrumentId
- amount
- referenceForBeneficiary
- reference
- instructedAmount
- status
- createdAt
- bookingDate
@@ -1045,7 +1042,7 @@ components:
counterparty:
transferInstrumentId: SE1234567890ABC1234567890
bank:
priority: fast
priority: regular
referenceForBeneficiary: Your reference sent to the beneficiary
reference: Your internal reference for the transfer
description: Your description
@@ -1061,7 +1058,7 @@ components:
counterparty:
transferInstrumentId: SE1234567890ABC1234567890
bank:
priority: fast
priority: regular
referenceForBeneficiary: Your reference sent to the beneficiary
reference: Your internal reference for the transfer
description: Your description

50
yaml/TransferService-v3.yaml
View File

@@ -5,9 +5,9 @@ info:
version: '3'
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\
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\"\
@@ -19,11 +19,11 @@ info:
\ 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\
\ \"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/v1`.\n\n"
x-timestamp: '2022-09-05T15:24:41Z'
\ to send requests to `https://balanceplatform-api-live.adyen.com/btl/v3`.\n\n"
x-timestamp: '2022-09-30T16:25:48Z'
termsOfService: https://www.adyen.com/legal/terms-and-conditions
contact:
name: Adyen Developer Experience team
@@ -362,6 +362,34 @@ components:
required:
- value
- currency
BRLocalAccountIdentification:
additionalProperties: false
properties:
accountNumber:
description: The bank account number, without separators or whitespace.
maxLength: 10
minLength: 1
type: string
bankCode:
description: The 3-digit Brazilian Bank Code (with leading zeros).
maxLength: 3
minLength: 3
type: string
branchNumber:
description: The bank account branch number, without separators or whitespace.
maxLength: 4
minLength: 1
type: string
type:
default: brLocal
description: '**brLocal**'
enum:
- brLocal
type: string
required:
- branchNumber
- accountNumber
- bankCode
BankAccountV3:
properties:
accountHolder:
@@ -373,6 +401,7 @@ components:
transfer.
oneOf:
- $ref: '#/components/schemas/AULocalAccountIdentification'
- $ref: '#/components/schemas/BRLocalAccountIdentification'
- $ref: '#/components/schemas/CZLocalAccountIdentification'
- $ref: '#/components/schemas/HULocalAccountIdentification'
- $ref: '#/components/schemas/IbanAccountIdentification'
@@ -802,6 +831,7 @@ components:
enum:
- atmWithdrawal
- atmWithdrawalReversal
- balanceAdjustment
- bankTransfer
- capture
- captureReversal
@@ -833,14 +863,10 @@ components:
type: string
required:
- id
- transferId
- accountHolderId
- balanceAccountId
- paymentInstrumentId
- amount
- referenceForBeneficiary
- reference
- instructedAmount
- status
- createdAt
- bookingDate
@@ -1460,7 +1486,7 @@ components:
category: bank
counterparty:
transferInstrumentId: SE1234567890ABC1234567890
priority: fast
priority: regular
referenceForBeneficiary: Your reference sent to the beneficiary
reference: Your internal reference for the transfer
description: Your description for the transfer
@@ -1476,7 +1502,7 @@ components:
category: bank
counterparty:
transferInstrumentId: SE1234567890ABC1234567890
priority: fast
priority: regular
referenceForBeneficiary: Your reference sent to the beneficiary
reference: Your internal reference for the transfer
description: Your description for the transfer