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

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,