mirror of
https://github.com/gcatanese/adyen-openapi.git
synced 2026-03-10 08:01:24 +00:00
spec release
This commit is contained in:
@@ -9,8 +9,8 @@
|
||||
"version" : "1",
|
||||
"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-04-17T15:23:17Z",
|
||||
"description" : "The payment webhooks are deprecated. Use the [accounting webhooks](https://docs.adyen.com/api-explorer/transfer-webhooks/latest/overview) instead.\n\nAdyen sends 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-05-10T13:27:05Z",
|
||||
"termsOfService" : "https://www.adyen.com/legal/terms-and-conditions",
|
||||
"contact" : {
|
||||
"name" : "Adyen Developer Experience team",
|
||||
@@ -577,7 +577,7 @@
|
||||
"type" : "string"
|
||||
},
|
||||
"type" : {
|
||||
"description" : "Type of notification.",
|
||||
"description" : "Type of webhook.",
|
||||
"enum" : [
|
||||
"balancePlatform.incomingTransfer.updated",
|
||||
"balancePlatform.incomingTransfer.created"
|
||||
@@ -798,7 +798,7 @@
|
||||
"type" : "string"
|
||||
},
|
||||
"type" : {
|
||||
"description" : "Type of notification.",
|
||||
"description" : "Type of webhook.",
|
||||
"enum" : [
|
||||
"balancePlatform.outgoingTransfer.created",
|
||||
"balancePlatform.outgoingTransfer.updated"
|
||||
@@ -926,7 +926,7 @@
|
||||
"type" : "string"
|
||||
},
|
||||
"type" : {
|
||||
"description" : "Type of notification.",
|
||||
"description" : "Type of webhook.",
|
||||
"enum" : [
|
||||
"balancePlatform.payment.created",
|
||||
"balancePlatform.payment.updated"
|
||||
|
||||
@@ -9,8 +9,8 @@
|
||||
"version" : "3",
|
||||
"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-04-26T16:27:04Z",
|
||||
"description" : "Adyen sends 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-05-15T18:27:47Z",
|
||||
"termsOfService" : "https://www.adyen.com/legal/terms-and-conditions",
|
||||
"contact" : {
|
||||
"name" : "Adyen Developer Experience team",
|
||||
@@ -1181,7 +1181,7 @@
|
||||
"x-addedInVersion" : "3",
|
||||
"deprecated" : true,
|
||||
"x-deprecatedInVersion" : "3",
|
||||
"x-deprecatedMessage" : "Use the [modificationMerchantReference](https://docs.adyen.com/api-explorer/accounting-webhooks/latest/post/balancePlatform.transfer.created#request-data-categoryData-platformPayment-modificationMerchantReference) in the `categoryData` object instead.",
|
||||
"x-deprecatedMessage" : "This will be removed in v4 and replaced with a new field.",
|
||||
"description" : "The capture's merchant reference included in the transfer.",
|
||||
"type" : "string"
|
||||
},
|
||||
@@ -1189,7 +1189,7 @@
|
||||
"x-addedInVersion" : "3",
|
||||
"deprecated" : true,
|
||||
"x-deprecatedInVersion" : "3",
|
||||
"x-deprecatedMessage" : "Use the [modificationPspReference](https://docs.adyen.com/api-explorer/accounting-webhooks/latest/post/balancePlatform.transfer.created#request-data-categoryData-platformPayment-modificationPspReference) in the `categoryData` object instead.",
|
||||
"x-deprecatedMessage" : "This will be removed in v4 and replaced with a new field.",
|
||||
"description" : "The capture reference included in the transfer.",
|
||||
"type" : "string"
|
||||
},
|
||||
@@ -1197,7 +1197,7 @@
|
||||
"x-addedInVersion" : "3",
|
||||
"deprecated" : true,
|
||||
"x-deprecatedInVersion" : "3",
|
||||
"x-deprecatedMessage" : "Use the [panEntryMode](https://docs.adyen.com/api-explorer/accounting-webhooks/latest/post/balancePlatform.transfer.created#request-data-categoryData-issuedCard-panEntryMode) in the `categoryData` object instead.",
|
||||
"x-deprecatedMessage" : "This will be removed in v4 and replaced with a new field.",
|
||||
"description" : "Indicates the method used for entering the PAN to initiate a transaction.\n\nPossible values: **manual**, **chip**, **magstripe**, **contactless**, **cof**, **ecommerce**, **token**.",
|
||||
"enum" : [
|
||||
"chip",
|
||||
@@ -1227,7 +1227,7 @@
|
||||
"x-addedInVersion" : "3",
|
||||
"deprecated" : true,
|
||||
"x-deprecatedInVersion" : "3",
|
||||
"x-deprecatedMessage" : "Use the [paymentMerchantReference](https://docs.adyen.com/api-explorer/accounting-webhooks/latest/post/balancePlatform.transfer.created#request-data-categoryData-platformPayment-paymentMerchantReference) in the `categoryData` object instead.",
|
||||
"x-deprecatedMessage" : "This will be removed in v4 and replaced with a new field.",
|
||||
"description" : "The payment's merchant reference included in the transfer.",
|
||||
"type" : "string"
|
||||
},
|
||||
@@ -1249,7 +1249,7 @@
|
||||
"x-addedInVersion" : "3",
|
||||
"deprecated" : true,
|
||||
"x-deprecatedInVersion" : "3",
|
||||
"x-deprecatedMessage" : "Use the [processingType](https://docs.adyen.com/api-explorer/accounting-webhooks/latest/post/balancePlatform.transfer.created#request-data-categoryData-issuedCard-processingType) in the `categoryData` object instead.",
|
||||
"x-deprecatedMessage" : "This will be removed in v4 and replaced with a new field.",
|
||||
"description" : "Contains information about how the payment was processed. For example, **ecommerce** for online or **pos** for in-person payments.",
|
||||
"enum" : [
|
||||
"atmWithdraw",
|
||||
@@ -1267,7 +1267,7 @@
|
||||
"x-addedInVersion" : "3",
|
||||
"deprecated" : true,
|
||||
"x-deprecatedInVersion" : "3",
|
||||
"x-deprecatedMessage" : "Use the [pspPaymentReference](https://docs.adyen.com/api-explorer/accounting-webhooks/latest/post/balancePlatform.transfer.created#request-data-categoryData-platformPayment-pspPaymentReference) in the `categoryData` object instead.",
|
||||
"x-deprecatedMessage" : "This will be removed in v4 and replaced with a new field.",
|
||||
"description" : "The payment reference included in the transfer.",
|
||||
"type" : "string"
|
||||
},
|
||||
@@ -1299,12 +1299,15 @@
|
||||
},
|
||||
"referenceForBeneficiary" : {
|
||||
"x-addedInVersion" : "2",
|
||||
"description" : " A reference that is sent to the recipient. This reference is also sent in all notification webhooks related to the transfer, so you can use it to track statuses for both the source and recipient of funds.\n\n Supported characters: **a-z**, **A-Z**, **0-9**. The maximum length depends on the `category`.\n\n- **internal**: 80 characters\n\n- **bank**: 35 characters when transferring to an IBAN, 15 characters for others.",
|
||||
"description" : " A reference that is sent to the recipient. This reference is also sent in all webhooks related to the transfer, so you can use it to track statuses for both the source and recipient of funds.\n\n Supported characters: **a-z**, **A-Z**, **0-9**. The maximum length depends on the `category`.\n\n- **internal**: 80 characters\n\n- **bank**: 35 characters when transferring to an IBAN, 15 characters for others.",
|
||||
"maxLength" : 80,
|
||||
"type" : "string"
|
||||
},
|
||||
"relayedAuthorisationData" : {
|
||||
"x-addedInVersion" : "3",
|
||||
"deprecated" : true,
|
||||
"x-deprecatedInVersion" : "3",
|
||||
"x-deprecatedMessage" : "This will be removed in v4 and replaced with a new field.",
|
||||
"description" : "If you are using relayed authorisation, this object contains information from the relayed authorisation response from your server.",
|
||||
"$ref" : "#/components/schemas/RelayedAuthorisationData"
|
||||
},
|
||||
@@ -1399,7 +1402,7 @@
|
||||
"x-addedInVersion" : "3",
|
||||
"deprecated" : true,
|
||||
"x-deprecatedInVersion" : "3",
|
||||
"x-deprecatedMessage" : "Use the [transactionRulesResult](https://docs.adyen.com/api-explorer/accounting-webhooks/latest/post/balancePlatform.transfer.created#request-data-categoryData-issuedCard-transactionRulesResult) in the `categoryData` object instead.",
|
||||
"x-deprecatedMessage" : "This will be removed in v4 and replaced with a new field.",
|
||||
"description" : "Contains the results of the evaluation of the transaction rules.",
|
||||
"$ref" : "#/components/schemas/TransactionRulesResult"
|
||||
},
|
||||
@@ -1440,7 +1443,7 @@
|
||||
"x-addedInVersion" : "3",
|
||||
"deprecated" : true,
|
||||
"x-deprecatedInVersion" : "3",
|
||||
"x-deprecatedMessage" : "Use the [validationFacts](https://docs.adyen.com/api-explorer/accounting-webhooks/latest/post/balancePlatform.transfer.created#request-data-categoryData-issuedCard-validationFacts) in the `categoryData` object instead.",
|
||||
"x-deprecatedMessage" : "This will be removed in v4 and replaced with a new field.",
|
||||
"description" : "The evaluation of the validation facts. See [validation checks](https://docs.adyen.com/issuing/validation-checks) for more information.",
|
||||
"items" : {
|
||||
"$ref" : "#/components/schemas/TransferNotificationValidationFact"
|
||||
@@ -1466,7 +1469,7 @@
|
||||
"type" : "string"
|
||||
},
|
||||
"type" : {
|
||||
"description" : "The type of the notification.",
|
||||
"description" : "The type of webhook.",
|
||||
"enum" : [
|
||||
"balancePlatform.transfer.created",
|
||||
"balancePlatform.transfer.updated"
|
||||
|
||||
@@ -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-04-18T17:29:01Z",
|
||||
"x-timestamp" : "2023-05-10T13:27:06Z",
|
||||
"termsOfService" : "https://www.adyen.com/legal/terms-and-conditions",
|
||||
"contact" : {
|
||||
"name" : "Adyen Developer Experience team",
|
||||
@@ -951,7 +951,7 @@
|
||||
},
|
||||
"referenceForBeneficiary" : {
|
||||
"x-addedInVersion" : "2",
|
||||
"description" : " A reference that is sent to the recipient. This reference is also sent in all notification webhooks related to the transfer, so you can use it to track statuses for both the source and recipient of funds.\n\n Supported characters: **a-z**, **A-Z**, **0-9**. Maximum length: 80 characters.",
|
||||
"description" : " A reference that is sent to the recipient. This reference is also sent in all webhooks related to the transfer, so you can use it to track statuses for both the source and recipient of funds.\n\n Supported characters: **a-z**, **A-Z**, **0-9**. Maximum length: 80 characters.",
|
||||
"maxLength" : 80,
|
||||
"type" : "string"
|
||||
},
|
||||
@@ -1072,7 +1072,7 @@
|
||||
},
|
||||
"referenceForBeneficiary" : {
|
||||
"x-addedInVersion" : "2",
|
||||
"description" : " A reference that is sent to the recipient. This reference is also sent in all notification webhooks related to the transfer, so you can use it to track statuses for both the source and recipient of funds.\n\n Supported characters: **a-z**, **A-Z**, **0-9**. Maximum length: 80 characters.",
|
||||
"description" : " A reference that is sent to the recipient. This reference is also sent in all webhooks related to the transfer, so you can use it to track statuses for both the source and recipient of funds.\n\n Supported characters: **a-z**, **A-Z**, **0-9**. Maximum length: 80 characters.",
|
||||
"maxLength" : 80,
|
||||
"type" : "string"
|
||||
}
|
||||
|
||||
@@ -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-04-26T16:27:03Z",
|
||||
"x-timestamp" : "2023-05-10T13:27:06Z",
|
||||
"termsOfService" : "https://www.adyen.com/legal/terms-and-conditions",
|
||||
"contact" : {
|
||||
"name" : "Adyen Developer Experience team",
|
||||
@@ -1467,7 +1467,7 @@
|
||||
},
|
||||
"referenceForBeneficiary" : {
|
||||
"x-addedInVersion" : "2",
|
||||
"description" : " A reference that is sent to the recipient. This reference is also sent in all notification webhooks related to the transfer, so you can use it to track statuses for both the source and recipient of funds.\n\n Supported characters: **a-z**, **A-Z**, **0-9**. The maximum length depends on the `category`.\n\n- **internal**: 80 characters\n\n- **bank**: 35 characters when transferring to an IBAN, 15 characters for others.",
|
||||
"description" : " A reference that is sent to the recipient. This reference is also sent in all webhooks related to the transfer, so you can use it to track statuses for both the source and recipient of funds.\n\n Supported characters: **a-z**, **A-Z**, **0-9**. The maximum length depends on the `category`.\n\n- **internal**: 80 characters\n\n- **bank**: 35 characters when transferring to an IBAN, 15 characters for others.",
|
||||
"maxLength" : 80,
|
||||
"type" : "string"
|
||||
},
|
||||
@@ -1610,7 +1610,7 @@
|
||||
},
|
||||
"referenceForBeneficiary" : {
|
||||
"x-addedInVersion" : "2",
|
||||
"description" : " A reference that is sent to the recipient. This reference is also sent in all notification webhooks related to the transfer, so you can use it to track statuses for both the source and recipient of funds.\n\n Supported characters: **a-z**, **A-Z**, **0-9**. The maximum length depends on the `category`.\n\n- **internal**: 80 characters\n\n- **bank**: 35 characters when transferring to an IBAN, 15 characters for others.",
|
||||
"description" : " A reference that is sent to the recipient. This reference is also sent in all webhooks related to the transfer, so you can use it to track statuses for both the source and recipient of funds.\n\n Supported characters: **a-z**, **A-Z**, **0-9**. The maximum length depends on the `category`.\n\n- **internal**: 80 characters\n\n- **bank**: 35 characters when transferring to an IBAN, 15 characters for others.",
|
||||
"maxLength" : 80,
|
||||
"type" : "string"
|
||||
},
|
||||
|
||||
@@ -9,14 +9,14 @@ info:
|
||||
instead.
|
||||
|
||||
|
||||
Adyen sends notifications through webhooks to inform your system about the creation
|
||||
of payment resources and money movements in your platform.
|
||||
Adyen sends webhooks to inform your system about the creation of payment resources
|
||||
and money movements in your platform.
|
||||
|
||||
|
||||
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-04-17T15:23:17Z'
|
||||
x-timestamp: '2023-05-10T13:27:05Z'
|
||||
termsOfService: https://www.adyen.com/legal/terms-and-conditions
|
||||
contact:
|
||||
name: Adyen Developer Experience team
|
||||
@@ -484,7 +484,7 @@ components:
|
||||
Possible values: **test**, **live**.'
|
||||
type: string
|
||||
type:
|
||||
description: Type of notification.
|
||||
description: Type of webhook.
|
||||
enum:
|
||||
- balancePlatform.incomingTransfer.updated
|
||||
- balancePlatform.incomingTransfer.created
|
||||
@@ -699,7 +699,7 @@ components:
|
||||
Possible values: **test**, **live**.'
|
||||
type: string
|
||||
type:
|
||||
description: Type of notification.
|
||||
description: Type of webhook.
|
||||
enum:
|
||||
- balancePlatform.outgoingTransfer.created
|
||||
- balancePlatform.outgoingTransfer.updated
|
||||
@@ -829,7 +829,7 @@ components:
|
||||
Possible values: **test**, **live**.'
|
||||
type: string
|
||||
type:
|
||||
description: Type of notification.
|
||||
description: Type of webhook.
|
||||
enum:
|
||||
- balancePlatform.payment.created
|
||||
- balancePlatform.payment.updated
|
||||
|
||||
@@ -5,14 +5,14 @@ info:
|
||||
version: '3'
|
||||
x-publicVersion: true
|
||||
title: Transfer webhooks
|
||||
description: 'Adyen sends notifications through webhooks to inform your system about
|
||||
incoming and outgoing transfers in your platform.
|
||||
description: 'Adyen sends webhooks to inform your system about incoming and outgoing
|
||||
transfers in your platform.
|
||||
|
||||
|
||||
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-04-26T16:27:04Z'
|
||||
x-timestamp: '2023-05-15T18:27:47Z'
|
||||
termsOfService: https://www.adyen.com/legal/terms-and-conditions
|
||||
contact:
|
||||
name: Adyen Developer Experience team
|
||||
@@ -981,24 +981,24 @@ components:
|
||||
x-addedInVersion: '3'
|
||||
deprecated: true
|
||||
x-deprecatedInVersion: '3'
|
||||
x-deprecatedMessage: Use the [modificationMerchantReference](https://docs.adyen.com/api-explorer/accounting-webhooks/latest/post/balancePlatform.transfer.created#request-data-categoryData-platformPayment-modificationMerchantReference)
|
||||
in the `categoryData` object instead.
|
||||
x-deprecatedMessage: This will be removed in v4 and replaced with a new
|
||||
field.
|
||||
description: The capture's merchant reference included in the transfer.
|
||||
type: string
|
||||
modificationPspReference:
|
||||
x-addedInVersion: '3'
|
||||
deprecated: true
|
||||
x-deprecatedInVersion: '3'
|
||||
x-deprecatedMessage: Use the [modificationPspReference](https://docs.adyen.com/api-explorer/accounting-webhooks/latest/post/balancePlatform.transfer.created#request-data-categoryData-platformPayment-modificationPspReference)
|
||||
in the `categoryData` object instead.
|
||||
x-deprecatedMessage: This will be removed in v4 and replaced with a new
|
||||
field.
|
||||
description: The capture reference included in the transfer.
|
||||
type: string
|
||||
panEntryMode:
|
||||
x-addedInVersion: '3'
|
||||
deprecated: true
|
||||
x-deprecatedInVersion: '3'
|
||||
x-deprecatedMessage: Use the [panEntryMode](https://docs.adyen.com/api-explorer/accounting-webhooks/latest/post/balancePlatform.transfer.created#request-data-categoryData-issuedCard-panEntryMode)
|
||||
in the `categoryData` object instead.
|
||||
x-deprecatedMessage: This will be removed in v4 and replaced with a new
|
||||
field.
|
||||
description: 'Indicates the method used for entering the PAN to initiate
|
||||
a transaction.
|
||||
|
||||
@@ -1032,8 +1032,8 @@ components:
|
||||
x-addedInVersion: '3'
|
||||
deprecated: true
|
||||
x-deprecatedInVersion: '3'
|
||||
x-deprecatedMessage: Use the [paymentMerchantReference](https://docs.adyen.com/api-explorer/accounting-webhooks/latest/post/balancePlatform.transfer.created#request-data-categoryData-platformPayment-paymentMerchantReference)
|
||||
in the `categoryData` object instead.
|
||||
x-deprecatedMessage: This will be removed in v4 and replaced with a new
|
||||
field.
|
||||
description: The payment's merchant reference included in the transfer.
|
||||
type: string
|
||||
priority:
|
||||
@@ -1078,8 +1078,8 @@ components:
|
||||
x-addedInVersion: '3'
|
||||
deprecated: true
|
||||
x-deprecatedInVersion: '3'
|
||||
x-deprecatedMessage: Use the [processingType](https://docs.adyen.com/api-explorer/accounting-webhooks/latest/post/balancePlatform.transfer.created#request-data-categoryData-issuedCard-processingType)
|
||||
in the `categoryData` object instead.
|
||||
x-deprecatedMessage: This will be removed in v4 and replaced with a new
|
||||
field.
|
||||
description: Contains information about how the payment was processed. For
|
||||
example, **ecommerce** for online or **pos** for in-person payments.
|
||||
enum:
|
||||
@@ -1096,8 +1096,8 @@ components:
|
||||
x-addedInVersion: '3'
|
||||
deprecated: true
|
||||
x-deprecatedInVersion: '3'
|
||||
x-deprecatedMessage: Use the [pspPaymentReference](https://docs.adyen.com/api-explorer/accounting-webhooks/latest/post/balancePlatform.transfer.created#request-data-categoryData-platformPayment-pspPaymentReference)
|
||||
in the `categoryData` object instead.
|
||||
x-deprecatedMessage: This will be removed in v4 and replaced with a new
|
||||
field.
|
||||
description: The payment reference included in the transfer.
|
||||
type: string
|
||||
reason:
|
||||
@@ -1128,16 +1128,19 @@ components:
|
||||
referenceForBeneficiary:
|
||||
x-addedInVersion: '2'
|
||||
description: " A reference that is sent to the recipient. This reference\
|
||||
\ is also sent in all notification webhooks related to the transfer, so\
|
||||
\ you can use it to track statuses for both the source and recipient of\
|
||||
\ funds.\n\n Supported characters: **a-z**, **A-Z**, **0-9**. The maximum\
|
||||
\ length depends on the `category`.\n\n- **internal**: 80 characters\n\
|
||||
\n- **bank**: 35 characters when transferring to an IBAN, 15 characters\
|
||||
\ for others."
|
||||
\ is also sent in all webhooks related to the transfer, so you can use\
|
||||
\ it to track statuses for both the source and recipient of funds.\n\n\
|
||||
\ Supported characters: **a-z**, **A-Z**, **0-9**. The maximum length\
|
||||
\ depends on the `category`.\n\n- **internal**: 80 characters\n\n- **bank**:\
|
||||
\ 35 characters when transferring to an IBAN, 15 characters for others."
|
||||
maxLength: 80
|
||||
type: string
|
||||
relayedAuthorisationData:
|
||||
x-addedInVersion: '3'
|
||||
deprecated: true
|
||||
x-deprecatedInVersion: '3'
|
||||
x-deprecatedMessage: This will be removed in v4 and replaced with a new
|
||||
field.
|
||||
description: If you are using relayed authorisation, this object contains
|
||||
information from the relayed authorisation response from your server.
|
||||
$ref: '#/components/schemas/RelayedAuthorisationData'
|
||||
@@ -1234,8 +1237,8 @@ components:
|
||||
x-addedInVersion: '3'
|
||||
deprecated: true
|
||||
x-deprecatedInVersion: '3'
|
||||
x-deprecatedMessage: Use the [transactionRulesResult](https://docs.adyen.com/api-explorer/accounting-webhooks/latest/post/balancePlatform.transfer.created#request-data-categoryData-issuedCard-transactionRulesResult)
|
||||
in the `categoryData` object instead.
|
||||
x-deprecatedMessage: This will be removed in v4 and replaced with a new
|
||||
field.
|
||||
description: Contains the results of the evaluation of the transaction rules.
|
||||
$ref: '#/components/schemas/TransactionRulesResult'
|
||||
type:
|
||||
@@ -1274,8 +1277,8 @@ components:
|
||||
x-addedInVersion: '3'
|
||||
deprecated: true
|
||||
x-deprecatedInVersion: '3'
|
||||
x-deprecatedMessage: Use the [validationFacts](https://docs.adyen.com/api-explorer/accounting-webhooks/latest/post/balancePlatform.transfer.created#request-data-categoryData-issuedCard-validationFacts)
|
||||
in the `categoryData` object instead.
|
||||
x-deprecatedMessage: This will be removed in v4 and replaced with a new
|
||||
field.
|
||||
description: The evaluation of the validation facts. See [validation checks](https://docs.adyen.com/issuing/validation-checks)
|
||||
for more information.
|
||||
items:
|
||||
@@ -1298,7 +1301,7 @@ components:
|
||||
Possible values: **test**, **live**.'
|
||||
type: string
|
||||
type:
|
||||
description: The type of the notification.
|
||||
description: The type of webhook.
|
||||
enum:
|
||||
- balancePlatform.transfer.created
|
||||
- balancePlatform.transfer.updated
|
||||
|
||||
@@ -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-04-18T17:29:01Z'
|
||||
x-timestamp: '2023-05-10T13:27:06Z'
|
||||
termsOfService: https://www.adyen.com/legal/terms-and-conditions
|
||||
contact:
|
||||
name: Adyen Developer Experience team
|
||||
@@ -795,10 +795,10 @@ components:
|
||||
referenceForBeneficiary:
|
||||
x-addedInVersion: '2'
|
||||
description: " A reference that is sent to the recipient. This reference\
|
||||
\ is also sent in all notification webhooks related to the transfer, so\
|
||||
\ you can use it to track statuses for both the source and recipient of\
|
||||
\ funds.\n\n Supported characters: **a-z**, **A-Z**, **0-9**. Maximum\
|
||||
\ length: 80 characters."
|
||||
\ is also sent in all webhooks related to the transfer, so you can use\
|
||||
\ it to track statuses for both the source and recipient of funds.\n\n\
|
||||
\ Supported characters: **a-z**, **A-Z**, **0-9**. Maximum length: 80\
|
||||
\ characters."
|
||||
maxLength: 80
|
||||
type: string
|
||||
status:
|
||||
@@ -921,10 +921,10 @@ components:
|
||||
referenceForBeneficiary:
|
||||
x-addedInVersion: '2'
|
||||
description: " A reference that is sent to the recipient. This reference\
|
||||
\ is also sent in all notification webhooks related to the transfer, so\
|
||||
\ you can use it to track statuses for both the source and recipient of\
|
||||
\ funds.\n\n Supported characters: **a-z**, **A-Z**, **0-9**. Maximum\
|
||||
\ length: 80 characters."
|
||||
\ is also sent in all webhooks related to the transfer, so you can use\
|
||||
\ it to track statuses for both the source and recipient of funds.\n\n\
|
||||
\ Supported characters: **a-z**, **A-Z**, **0-9**. Maximum length: 80\
|
||||
\ characters."
|
||||
maxLength: 80
|
||||
type: string
|
||||
required:
|
||||
|
||||
@@ -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-04-26T16:27:03Z'
|
||||
x-timestamp: '2023-05-10T13:27:06Z'
|
||||
termsOfService: https://www.adyen.com/legal/terms-and-conditions
|
||||
contact:
|
||||
name: Adyen Developer Experience team
|
||||
@@ -1216,12 +1216,11 @@ components:
|
||||
referenceForBeneficiary:
|
||||
x-addedInVersion: '2'
|
||||
description: " A reference that is sent to the recipient. This reference\
|
||||
\ is also sent in all notification webhooks related to the transfer, so\
|
||||
\ you can use it to track statuses for both the source and recipient of\
|
||||
\ funds.\n\n Supported characters: **a-z**, **A-Z**, **0-9**. The maximum\
|
||||
\ length depends on the `category`.\n\n- **internal**: 80 characters\n\
|
||||
\n- **bank**: 35 characters when transferring to an IBAN, 15 characters\
|
||||
\ for others."
|
||||
\ is also sent in all webhooks related to the transfer, so you can use\
|
||||
\ it to track statuses for both the source and recipient of funds.\n\n\
|
||||
\ Supported characters: **a-z**, **A-Z**, **0-9**. The maximum length\
|
||||
\ depends on the `category`.\n\n- **internal**: 80 characters\n\n- **bank**:\
|
||||
\ 35 characters when transferring to an IBAN, 15 characters for others."
|
||||
maxLength: 80
|
||||
type: string
|
||||
status:
|
||||
@@ -1392,12 +1391,11 @@ components:
|
||||
referenceForBeneficiary:
|
||||
x-addedInVersion: '2'
|
||||
description: " A reference that is sent to the recipient. This reference\
|
||||
\ is also sent in all notification webhooks related to the transfer, so\
|
||||
\ you can use it to track statuses for both the source and recipient of\
|
||||
\ funds.\n\n Supported characters: **a-z**, **A-Z**, **0-9**. The maximum\
|
||||
\ length depends on the `category`.\n\n- **internal**: 80 characters\n\
|
||||
\n- **bank**: 35 characters when transferring to an IBAN, 15 characters\
|
||||
\ for others."
|
||||
\ is also sent in all webhooks related to the transfer, so you can use\
|
||||
\ it to track statuses for both the source and recipient of funds.\n\n\
|
||||
\ Supported characters: **a-z**, **A-Z**, **0-9**. The maximum length\
|
||||
\ depends on the `category`.\n\n- **internal**: 80 characters\n\n- **bank**:\
|
||||
\ 35 characters when transferring to an IBAN, 15 characters for others."
|
||||
maxLength: 80
|
||||
type: string
|
||||
ultimateParty:
|
||||
|
||||
Reference in New Issue
Block a user