diff --git a/json/BalancePlatformTransferNotification-v3.json b/json/BalancePlatformTransferNotification-v3.json index 3df15880..535d54f7 100644 --- a/json/BalancePlatformTransferNotification-v3.json +++ b/json/BalancePlatformTransferNotification-v3.json @@ -483,13 +483,13 @@ "additionalProperties" : false, "properties" : { "expiryMonth" : { - "description" : "The expiry month of the card.\nFormat: 2 digits, zero-padded for single digits. For example:\n* 03 = March\n* 11 = November", + "description" : "The expiry month of the card.\n\nFormat: two digits. Add a leading zero for single-digit months. For example:\n* 03 = March\n* 11 = November", "maxLength" : 2, "minLength" : 2, "type" : "string" }, "expiryYear" : { - "description" : "The expiry year of the card.\nFormat: 4 digits. For example: 2020", + "description" : "The expiry year of the card.\n\nFormat: four digits. For example: 2020", "maxLength" : 4, "minLength" : 4, "type" : "string" @@ -501,19 +501,19 @@ "type" : "string" }, "number" : { - "description" : "The card number without any separators.\n\nWhen this value is returned in a response, it only includes the last 4 digits of the card number.", + "description" : "The card number without any separators.\n\nFor security, the response only includes the last four digits of the card number.", "maxLength" : 19, "minLength" : 4, "type" : "string" }, "startMonth" : { - "description" : "The month when the card was issued. Applies only to some UK debit cards.\n\nFormat: 2 digits, zero-padded for single digits. For example:\n* 03 = March\n* 11 = November", + "description" : "The month when the card was issued. Applies only to some UK debit cards.\n\nFormat: two digits. Add a leading zero for single-digit months. For example:\n* 03 = March\n* 11 = November", "maxLength" : 2, "minLength" : 2, "type" : "string" }, "startYear" : { - "description" : "The year when the card was issued. Applies only to some UK debit cards.\n\nFormat: 4 digits. For example: 2020", + "description" : "The year when the card was issued. Applies only to some UK debit cards.\n\nFormat: four digits. For example: 2020", "maxLength" : 4, "minLength" : 4, "type" : "string" @@ -554,7 +554,7 @@ "additionalProperties" : false, "properties" : { "balanceAccountId" : { - "description" : "The unique identifier of the counterparty [balance account](https://docs.adyen.com/api-explorer/balanceplatform/2/post/balanceAccounts#responses-200-id).", + "description" : "The unique identifier of the counterparty [balance account](https://docs.adyen.com/api-explorer/balanceplatform/latest/post/balanceAccounts#responses-200-id).", "type" : "string" }, "bankAccount" : { @@ -570,7 +570,7 @@ "$ref" : "#/components/schemas/MerchantData" }, "transferInstrumentId" : { - "description" : "The unique identifier of the counterparty [transfer instrument](https://docs.adyen.com/api-explorer/legalentity/3/post/transferInstruments#responses-200-id).", + "description" : "The unique identifier of the counterparty [transfer instrument](https://docs.adyen.com/api-explorer/legalentity/latest/post/transferInstruments#responses-200-id).", "type" : "string" } }, @@ -1027,20 +1027,20 @@ "$ref" : "#/components/schemas/Address" }, "dateOfBirth" : { - "description" : "The date of birth of the individual in [ISO-8601](https://www.w3.org/TR/NOTE-datetime) format. For example, **YYYY-MM-DD**.\n\nThe date must be later than January 1, 1900.\n\nAllowed only when `type` is **individual**.", + "description" : "The date of birth of the individual in [ISO-8601](https://www.w3.org/TR/NOTE-datetime) format. For example, **YYYY-MM-DD**.\n\nAllowed only when `type` is **individual**.", "format" : "date", "type" : "string" }, "firstName" : { - "description" : "The first name of the individual.\n\nSupported characters: [a-z] [A-Z] - . / — and Space.\n\nThis parameter is:\n- Allowed only when `type` is **individual**.\n- Required when `category` is **card**.", + "description" : "The first name of the individual.\n\nSupported characters: [a-z] [A-Z] - . / — and space.\n\nThis parameter is:\n- Allowed only when `type` is **individual**.\n- Required when `category` is **card**.", "type" : "string" }, "fullName" : { - "description" : "The full name of the entity that owns the bank account or card.\n\nSupported characters: [a-z] [A-Z] [0-9] , . ; : - — / \\ + & ! ? @ ( ) \" ' and Space.\n\nRequired when `category` is **bank**.", + "description" : "The full name of the entity that owns the bank account or card.\n\nSupported characters: [a-z] [A-Z] [0-9] , . ; : - — / \\ + & ! ? @ ( ) \" ' and space.\n\nRequired when `category` is **bank**.", "type" : "string" }, "lastName" : { - "description" : "The last name of the individual.\n\nSupported characters: [a-z] [A-Z] - . / — and Space.\n\nThis parameter is:\n- Allowed only when `type` is **individual**.\n- Required when `category` is **card**.", + "description" : "The last name of the individual.\n\nSupported characters: [a-z] [A-Z] - . / — and space.\n\nThis parameter is:\n- Allowed only when `type` is **individual**.\n- Required when `category` is **card**.", "type" : "string" }, "reference" : { @@ -1909,7 +1909,7 @@ "additionalProperties" : false, "properties" : { "balanceAccountId" : { - "description" : "The unique identifier of the counterparty [balance account](https://docs.adyen.com/api-explorer/balanceplatform/2/post/balanceAccounts#responses-200-id).", + "description" : "The unique identifier of the counterparty [balance account](https://docs.adyen.com/api-explorer/balanceplatform/latest/post/balanceAccounts#responses-200-id).", "type" : "string" }, "bankAccount" : { @@ -1925,7 +1925,7 @@ "$ref" : "#/components/schemas/TransferNotificationMerchantData" }, "transferInstrumentId" : { - "description" : "The unique identifier of the counterparty [transfer instrument](https://docs.adyen.com/api-explorer/legalentity/3/post/transferInstruments#responses-200-id).", + "description" : "The unique identifier of the counterparty [transfer instrument](https://docs.adyen.com/api-explorer/legalentity/latest/post/transferInstruments#responses-200-id).", "type" : "string" } }, diff --git a/json/BalancePlatformTransferNotification-v4.json b/json/BalancePlatformTransferNotification-v4.json index 316489cf..a5fec31e 100644 --- a/json/BalancePlatformTransferNotification-v4.json +++ b/json/BalancePlatformTransferNotification-v4.json @@ -37,6 +37,14 @@ "requestBody" : { "content" : { "application/json" : { + "examples" : { + "balancePlatform-transfer-created-incoming-internal" : { + "$ref" : "#/components/examples/post-balancePlatform.transfer.created-balancePlatform-transfer-created-incoming-internal" + }, + "balancePlatform-transfer-created-outgoing-external" : { + "$ref" : "#/components/examples/post-balancePlatform.transfer.created-balancePlatform-transfer-created-outgoing-external" + } + }, "schema" : { "$ref" : "#/components/schemas/TransferNotificationRequest" } @@ -77,6 +85,20 @@ "requestBody" : { "content" : { "application/json" : { + "examples" : { + "balancePlatform-transfer-updated-authorised-incoming-internal" : { + "$ref" : "#/components/examples/post-balancePlatform.transfer.updated-balancePlatform-transfer-updated-authorised-incoming-internal" + }, + "balancePlatform-transfer-updated-authorised-outgoing-external" : { + "$ref" : "#/components/examples/post-balancePlatform.transfer.updated-balancePlatform-transfer-updated-authorised-outgoing-external" + }, + "balancePlatform-transfer-updated-booked-incoming-internal" : { + "$ref" : "#/components/examples/post-balancePlatform.transfer.updated-balancePlatform-transfer-updated-booked-incoming-internal" + }, + "balancePlatform-transfer-updated-booked-outgoing-external" : { + "$ref" : "#/components/examples/post-balancePlatform.transfer.updated-balancePlatform-transfer-updated-booked-outgoing-external" + } + }, "schema" : { "$ref" : "#/components/schemas/TransferNotificationRequest" } @@ -510,13 +532,13 @@ "additionalProperties" : false, "properties" : { "expiryMonth" : { - "description" : "The expiry month of the card.\nFormat: 2 digits, zero-padded for single digits. For example:\n* 03 = March\n* 11 = November", + "description" : "The expiry month of the card.\n\nFormat: two digits. Add a leading zero for single-digit months. For example:\n* 03 = March\n* 11 = November", "maxLength" : 2, "minLength" : 2, "type" : "string" }, "expiryYear" : { - "description" : "The expiry year of the card.\nFormat: 4 digits. For example: 2020", + "description" : "The expiry year of the card.\n\nFormat: four digits. For example: 2020", "maxLength" : 4, "minLength" : 4, "type" : "string" @@ -528,19 +550,19 @@ "type" : "string" }, "number" : { - "description" : "The card number without any separators.\n\nWhen this value is returned in a response, it only includes the last 4 digits of the card number.", + "description" : "The card number without any separators.\n\nFor security, the response only includes the last four digits of the card number.", "maxLength" : 19, "minLength" : 4, "type" : "string" }, "startMonth" : { - "description" : "The month when the card was issued. Applies only to some UK debit cards.\n\nFormat: 2 digits, zero-padded for single digits. For example:\n* 03 = March\n* 11 = November", + "description" : "The month when the card was issued. Applies only to some UK debit cards.\n\nFormat: two digits. Add a leading zero for single-digit months. For example:\n* 03 = March\n* 11 = November", "maxLength" : 2, "minLength" : 2, "type" : "string" }, "startYear" : { - "description" : "The year when the card was issued. Applies only to some UK debit cards.\n\nFormat: 4 digits. For example: 2020", + "description" : "The year when the card was issued. Applies only to some UK debit cards.\n\nFormat: four digits. For example: 2020", "maxLength" : 4, "minLength" : 4, "type" : "string" @@ -581,7 +603,7 @@ "additionalProperties" : false, "properties" : { "balanceAccountId" : { - "description" : "The unique identifier of the counterparty [balance account](https://docs.adyen.com/api-explorer/balanceplatform/2/post/balanceAccounts#responses-200-id).", + "description" : "The unique identifier of the counterparty [balance account](https://docs.adyen.com/api-explorer/balanceplatform/latest/post/balanceAccounts#responses-200-id).", "type" : "string" }, "bankAccount" : { @@ -597,7 +619,7 @@ "$ref" : "#/components/schemas/MerchantData" }, "transferInstrumentId" : { - "description" : "The unique identifier of the counterparty [transfer instrument](https://docs.adyen.com/api-explorer/legalentity/3/post/transferInstruments#responses-200-id).", + "description" : "The unique identifier of the counterparty [transfer instrument](https://docs.adyen.com/api-explorer/legalentity/latest/post/transferInstruments#responses-200-id).", "type" : "string" } }, @@ -1149,20 +1171,20 @@ "$ref" : "#/components/schemas/Address" }, "dateOfBirth" : { - "description" : "The date of birth of the individual in [ISO-8601](https://www.w3.org/TR/NOTE-datetime) format. For example, **YYYY-MM-DD**.\n\nThe date must be later than January 1, 1900.\n\nAllowed only when `type` is **individual**.", + "description" : "The date of birth of the individual in [ISO-8601](https://www.w3.org/TR/NOTE-datetime) format. For example, **YYYY-MM-DD**.\n\nAllowed only when `type` is **individual**.", "format" : "date", "type" : "string" }, "firstName" : { - "description" : "The first name of the individual.\n\nSupported characters: [a-z] [A-Z] - . / — and Space.\n\nThis parameter is:\n- Allowed only when `type` is **individual**.\n- Required when `category` is **card**.", + "description" : "The first name of the individual.\n\nSupported characters: [a-z] [A-Z] - . / — and space.\n\nThis parameter is:\n- Allowed only when `type` is **individual**.\n- Required when `category` is **card**.", "type" : "string" }, "fullName" : { - "description" : "The full name of the entity that owns the bank account or card.\n\nSupported characters: [a-z] [A-Z] [0-9] , . ; : - — / \\ + & ! ? @ ( ) \" ' and Space.\n\nRequired when `category` is **bank**.", + "description" : "The full name of the entity that owns the bank account or card.\n\nSupported characters: [a-z] [A-Z] [0-9] , . ; : - — / \\ + & ! ? @ ( ) \" ' and space.\n\nRequired when `category` is **bank**.", "type" : "string" }, "lastName" : { - "description" : "The last name of the individual.\n\nSupported characters: [a-z] [A-Z] - . / — and Space.\n\nThis parameter is:\n- Allowed only when `type` is **individual**.\n- Required when `category` is **card**.", + "description" : "The last name of the individual.\n\nSupported characters: [a-z] [A-Z] - . / — and space.\n\nThis parameter is:\n- Allowed only when `type` is **individual**.\n- Required when `category` is **card**.", "type" : "string" }, "reference" : { @@ -1965,7 +1987,7 @@ "additionalProperties" : false, "properties" : { "balanceAccountId" : { - "description" : "The unique identifier of the counterparty [balance account](https://docs.adyen.com/api-explorer/balanceplatform/2/post/balanceAccounts#responses-200-id).", + "description" : "The unique identifier of the counterparty [balance account](https://docs.adyen.com/api-explorer/balanceplatform/latest/post/balanceAccounts#responses-200-id).", "type" : "string" }, "bankAccount" : { @@ -1981,7 +2003,7 @@ "$ref" : "#/components/schemas/TransferNotificationMerchantData" }, "transferInstrumentId" : { - "description" : "The unique identifier of the counterparty [transfer instrument](https://docs.adyen.com/api-explorer/legalentity/3/post/transferInstruments#responses-200-id).", + "description" : "The unique identifier of the counterparty [transfer instrument](https://docs.adyen.com/api-explorer/legalentity/latest/post/transferInstruments#responses-200-id).", "type" : "string" } }, @@ -2140,7 +2162,456 @@ } }, "examples" : { - + "post-balancePlatform.transfer.created-balancePlatform-transfer-created-incoming-internal" : { + "summary" : "Initiated incoming internal transfer", + "description" : "Example webhook for an initiated incoming transfer", + "value" : { + "data" : { + "id" : "2WT1N05XXY7P9XH9", + "type" : "internalTransfer", + "accountHolder" : { + "description" : "Your description of the account holder of the target balance account", + "id" : "AH00000000000000000000002", + "reference" : "Your reference of the account holder" + }, + "amount" : { + "currency" : "EUR", + "value" : 1000 + }, + "balanceAccount" : { + "description" : "Your description of the target balance account", + "id" : "BA00000000000000000000002" + }, + "balancePlatform" : "YOUR_BALANCE_PLATFORM", + "balances" : [ + { + "currency" : "EUR", + "received" : 1000 + } + ], + "category" : "internal", + "creationDate" : "2023-02-28T13:30:05+02:00", + "description" : "Your description of the transfer", + "direction" : "incoming", + "events" : [ + { + "bookingDate" : "2023-02-28T13:30:18+02:00", + "id" : "JDRF00000000000000000000000001", + "mutations" : [ + { + "currency" : "EUR", + "received" : 1000 + } + ], + "status" : "received", + "type" : "accounting" + } + ], + "reason" : "approved", + "reference" : "Your reference of the transfer", + "referenceForBeneficiary" : "Your-reference-for-the-recipient-of-the-transfer-request", + "sequenceNumber" : 1, + "status" : "received" + }, + "environment" : "test", + "type" : "balancePlatform.transfer.created" + } + }, + "post-balancePlatform.transfer.created-balancePlatform-transfer-created-outgoing-external" : { + "summary" : "Initiated payout to a transfer instrument", + "description" : "Example webhook for an initiated outgoing bank transfer", + "value" : { + "data" : { + "accountHolder" : { + "description" : "Your description of the account holder", + "id" : "AH00000000000000000000001", + "reference" : "Your reference for the account holder" + }, + "amount" : { + "currency" : "EUR", + "value" : 10000 + }, + "balanceAccount" : { + "description" : "Your description of the balance account from where the amount is debited", + "id" : "BA00000000000000000000001", + "reference" : "Your reference for the balance account" + }, + "balancePlatform" : "YOUR_BALANCE_PLATFORM", + "balances" : [ + { + "currency" : "EUR", + "received" : -10000 + } + ], + "category" : "bank", + "categoryData" : { + "priority" : "regular", + "type" : "bank" + }, + "creationDate" : "2023-02-28T13:30:05+02:00", + "description" : "Your user description of the transfer", + "direction" : "outgoing", + "events" : [ + { + "bookingDate" : "2023-02-28T13:30:18+02:00", + "id" : "EVJN00000000000000000000000001", + "mutations" : [ + { + "currency" : "EUR", + "received" : -10000 + } + ], + "status" : "received", + "type" : "accounting" + } + ], + "id" : "6JKRLZ8LOT47J7RY", + "reason" : "approved", + "reference" : "Your user reference for the transfer", + "referenceForBeneficiary" : "Your user reference for the beneficiary", + "sequenceNumber" : 1, + "transactionRulesResult" : { + "allHardBlockRulesPassed" : true + }, + "status" : "received", + "type" : "bankTransfer" + }, + "environment" : "test", + "type" : "balancePlatform.transfer.created" + } + }, + "post-balancePlatform.transfer.updated-balancePlatform-transfer-updated-authorised-incoming-internal" : { + "summary" : "Authorized incoming internal transfer", + "description" : "Example webhook of an authorised incoming transfer", + "value" : { + "data" : { + "id" : "2WT1N05XXY7P9XH9", + "type" : "internalTransfer", + "accountHolder" : { + "description" : "Your description of the account holder of the target balance account", + "id" : "AH00000000000000000000002", + "reference" : "Your reference for the account holder" + }, + "amount" : { + "currency" : "EUR", + "value" : 1000 + }, + "balanceAccount" : { + "description" : "Your description of the target balance account", + "id" : "BA00000000000000000000002" + }, + "balancePlatform" : "YOUR_BALANCE_PLATFORM", + "balances" : [ + { + "currency" : "EUR", + "received" : 0, + "reserved" : 1000 + } + ], + "category" : "internal", + "creationDate" : "2023-02-28T13:30:05+02:00", + "description" : "Your description of the transfer", + "direction" : "incoming", + "events" : [ + { + "bookingDate" : "2023-02-28T13:30:18+02:00", + "id" : "JDRF00000000000000000000000001", + "mutations" : [ + { + "currency" : "EUR", + "received" : 1000 + } + ], + "status" : "received", + "type" : "accounting" + }, + { + "bookingDate" : "2023-02-28T13:30:18+02:00", + "id" : "JDRF00000000000000000000000002", + "mutations" : [ + { + "currency" : "EUR", + "received" : -1000, + "reserved" : 1000 + } + ], + "status" : "authorised", + "type" : "accounting" + } + ], + "reason" : "approved", + "reference" : "Your reference for the transfer", + "referenceForBeneficiary" : "Your-reference-for-the-recipient-of-the-transfer-request", + "sequenceNumber" : 2, + "status" : "authorised" + }, + "environment" : "test", + "type" : "balancePlatform.transfer.updated" + } + }, + "post-balancePlatform.transfer.updated-balancePlatform-transfer-updated-authorised-outgoing-external" : { + "summary" : "Authorized payout to a transfer instrument", + "description" : "Example webhook of an authorised outgoing bank transfer", + "value" : { + "data" : { + "accountHolder" : { + "description" : "Your description of the account holder", + "id" : "AH00000000000000000000001", + "reference" : "Your reference for the account holder" + }, + "amount" : { + "currency" : "EUR", + "value" : 10000 + }, + "balanceAccount" : { + "description" : "Your description of the balance account from where the amount is debited", + "id" : "BA00000000000000000000001", + "reference" : "Your reference for the balance account" + }, + "balancePlatform" : "YOUR_BALANCE_PLATFORM", + "balances" : [ + { + "currency" : "EUR", + "received" : 0, + "reserved" : -10000 + } + ], + "category" : "bank", + "categoryData" : { + "priority" : "regular", + "type" : "bank" + }, + "creationDate" : "2023-02-28T13:30:05+02:00", + "description" : "Your user description of the transfer", + "direction" : "outgoing", + "events" : [ + { + "bookingDate" : "2023-02-28T13:30:18+02:00", + "id" : "EVJN00000000000000000000000001", + "mutations" : [ + { + "currency" : "EUR", + "received" : -10000 + } + ], + "status" : "received", + "type" : "accounting" + }, + { + "bookingDate" : "2023-02-28T13:30:18+02:00", + "id" : "EVJN00000000000000000000000002", + "mutations" : [ + { + "currency" : "EUR", + "received" : 10000, + "reserved" : -10000 + } + ], + "status" : "authorised", + "type" : "accounting" + } + ], + "id" : "6JKRLZ8LOT47J7RY", + "reason" : "approved", + "reference" : "Your user reference for the transfer", + "referenceForBeneficiary" : "Your user reference for the beneficiary", + "sequenceNumber" : 2, + "transactionRulesResult" : { + "allHardBlockRulesPassed" : true + }, + "status" : "authorised", + "type" : "bankTransfer" + }, + "environment" : "test", + "type" : "balancePlatform.transfer.updated" + } + }, + "post-balancePlatform.transfer.updated-balancePlatform-transfer-updated-booked-incoming-internal" : { + "summary" : "Booked incoming internal transfer", + "description" : "Example webhook of a booked incoming transfer", + "value" : { + "data" : { + "id" : "2WT1N05XXY7P9XH9", + "type" : "internalTransfer", + "accountHolder" : { + "description" : "Your description of the account holder of the target balance account", + "id" : "AH00000000000000000000002", + "reference" : "Your reference for the account holder" + }, + "amount" : { + "currency" : "EUR", + "value" : 1000 + }, + "balanceAccount" : { + "description" : "Your description of the target balance account", + "id" : "BA00000000000000000000002" + }, + "balancePlatform" : "YOUR_BALANCE_PLATFORM", + "balances" : [ + { + "balance" : 1000, + "currency" : "EUR", + "received" : 0, + "reserved" : 0 + } + ], + "category" : "internal", + "counterparty" : { + "balanceAccountId" : "BA00000000000000000000001" + }, + "creationDate" : "2023-02-28T13:30:05+02:00", + "description" : "Your description of the transfer", + "direction" : "incoming", + "events" : [ + { + "bookingDate" : "2023-02-28T13:30:18+02:00", + "id" : "JDRF00000000000000000000000001", + "mutations" : [ + { + "currency" : "EUR", + "received" : 1000 + } + ], + "status" : "received", + "type" : "accounting" + }, + { + "bookingDate" : "2023-02-28T13:30:18+02:00", + "id" : "JDRF00000000000000000000000002", + "mutations" : [ + { + "currency" : "EUR", + "received" : -1000, + "reserved" : 1000 + } + ], + "status" : "authorised", + "type" : "accounting" + }, + { + "bookingDate" : "2023-02-28T13:30:18+02:00", + "id" : "JDRF00000000000000000000000003", + "mutations" : [ + { + "balance" : 1000, + "currency" : "EUR", + "received" : 0, + "reserved" : -1000 + } + ], + "status" : "booked", + "transactionId" : "FWKP42CL8224223D5KKJWD6FXS3VQCEUR", + "type" : "accounting", + "valueDate" : "2023-02-28T13:30:18+02:00" + } + ], + "reason" : "approved", + "reference" : "Your reference for the transfer", + "referenceForBeneficiary" : "Your-reference-for-the-recipient-of-the-transfer-request", + "sequenceNumber" : 3, + "status" : "booked" + }, + "environment" : "test", + "type" : "balancePlatform.transfer.updated" + } + }, + "post-balancePlatform.transfer.updated-balancePlatform-transfer-updated-booked-outgoing-external" : { + "summary" : "Booked payout to a transfer instrument", + "description" : "Example webhook of a booked outgoing bank transfer", + "value" : { + "data" : { + "accountHolder" : { + "description" : "Your description of the account holder", + "id" : "AH00000000000000000000001", + "reference" : "Your reference for the account holder" + }, + "amount" : { + "currency" : "EUR", + "value" : 10000 + }, + "balanceAccount" : { + "description" : "Your description of the balance account from where the amount is debited", + "id" : "BA00000000000000000000001", + "reference" : "Your reference for the balance account" + }, + "balancePlatform" : "YOUR_BALANCE_PLATFORM", + "balances" : [ + { + "balance" : -10000, + "currency" : "EUR", + "received" : 0, + "reserved" : 0 + } + ], + "category" : "bank", + "categoryData" : { + "priority" : "regular", + "type" : "bank" + }, + "counterparty" : { + "transferInstrumentId" : "SE00000000000000000000001" + }, + "creationDate" : "2023-02-28T13:30:05+02:00", + "description" : "Your user description of the transfer", + "direction" : "outgoing", + "events" : [ + { + "bookingDate" : "2023-02-28T13:30:18+02:00", + "id" : "EVJN00000000000000000000000001", + "mutations" : [ + { + "currency" : "EUR", + "received" : -10000 + } + ], + "status" : "received", + "type" : "accounting" + }, + { + "bookingDate" : "2023-02-28T13:30:18+02:00", + "id" : "EVJN00000000000000000000000002", + "mutations" : [ + { + "currency" : "EUR", + "received" : 10000, + "reserved" : -10000 + } + ], + "status" : "authorised", + "type" : "accounting" + }, + { + "bookingDate" : "2023-02-28T13:30:18+02:00", + "id" : "EVJN00000000000000000000000003", + "mutations" : [ + { + "balance" : -10000, + "currency" : "EUR", + "received" : 0, + "reserved" : 10000 + } + ], + "status" : "booked", + "transactionId" : "EVJN00000000000000000000000003EUR", + "type" : "accounting", + "valueDate" : "2023-03-01T12:58:25+01:00" + } + ], + "id" : "6JKRLZ8LOT47J7RY", + "reason" : "approved", + "reference" : "Your user reference for the transfer", + "referenceForBeneficiary" : "Your user reference for the beneficiary", + "sequenceNumber" : 3, + "transactionRulesResult" : { + "allHardBlockRulesPassed" : true + }, + "status" : "booked", + "type" : "bankTransfer" + }, + "environment" : "test", + "type" : "balancePlatform.transfer.updated" + } + } } } } \ No newline at end of file diff --git a/json/TransferService-v3.json b/json/TransferService-v3.json index 7b2dcd4a..0631e4b1 100644 --- a/json/TransferService-v3.json +++ b/json/TransferService-v3.json @@ -1299,13 +1299,13 @@ "additionalProperties" : false, "properties" : { "expiryMonth" : { - "description" : "The expiry month of the card.\nFormat: 2 digits, zero-padded for single digits. For example:\n* 03 = March\n* 11 = November", + "description" : "The expiry month of the card.\n\nFormat: two digits. Add a leading zero for single-digit months. For example:\n* 03 = March\n* 11 = November", "maxLength" : 2, "minLength" : 2, "type" : "string" }, "expiryYear" : { - "description" : "The expiry year of the card.\nFormat: 4 digits. For example: 2020", + "description" : "The expiry year of the card.\n\nFormat: four digits. For example: 2020", "maxLength" : 4, "minLength" : 4, "type" : "string" @@ -1317,19 +1317,19 @@ "type" : "string" }, "number" : { - "description" : "The card number without any separators.\n\nWhen this value is returned in a response, it only includes the last 4 digits of the card number.", + "description" : "The card number without any separators.\n\nFor security, the response only includes the last four digits of the card number.", "maxLength" : 19, "minLength" : 4, "type" : "string" }, "startMonth" : { - "description" : "The month when the card was issued. Applies only to some UK debit cards.\n\nFormat: 2 digits, zero-padded for single digits. For example:\n* 03 = March\n* 11 = November", + "description" : "The month when the card was issued. Applies only to some UK debit cards.\n\nFormat: two digits. Add a leading zero for single-digit months. For example:\n* 03 = March\n* 11 = November", "maxLength" : 2, "minLength" : 2, "type" : "string" }, "startYear" : { - "description" : "The year when the card was issued. Applies only to some UK debit cards.\n\nFormat: 4 digits. For example: 2020", + "description" : "The year when the card was issued. Applies only to some UK debit cards.\n\nFormat: four digits. For example: 2020", "maxLength" : 4, "minLength" : 4, "type" : "string" @@ -1363,7 +1363,7 @@ "additionalProperties" : false, "properties" : { "balanceAccountId" : { - "description" : "The unique identifier of the counterparty [balance account](https://docs.adyen.com/api-explorer/balanceplatform/2/post/balanceAccounts#responses-200-id).", + "description" : "The unique identifier of the counterparty [balance account](https://docs.adyen.com/api-explorer/balanceplatform/latest/post/balanceAccounts#responses-200-id).", "type" : "string" }, "bankAccount" : { @@ -1375,7 +1375,7 @@ "$ref" : "#/components/schemas/Card" }, "transferInstrumentId" : { - "description" : "The unique identifier of the counterparty [transfer instrument](https://docs.adyen.com/api-explorer/legalentity/3/post/transferInstruments#responses-200-id).", + "description" : "The unique identifier of the counterparty [transfer instrument](https://docs.adyen.com/api-explorer/legalentity/latest/post/transferInstruments#responses-200-id).", "type" : "string" } }, @@ -1385,7 +1385,7 @@ "additionalProperties" : false, "properties" : { "balanceAccountId" : { - "description" : "The unique identifier of the counterparty [balance account](https://docs.adyen.com/api-explorer/balanceplatform/2/post/balanceAccounts#responses-200-id).", + "description" : "The unique identifier of the counterparty [balance account](https://docs.adyen.com/api-explorer/balanceplatform/latest/post/balanceAccounts#responses-200-id).", "type" : "string" }, "bankAccount" : { @@ -1401,7 +1401,7 @@ "$ref" : "#/components/schemas/MerchantData" }, "transferInstrumentId" : { - "description" : "The unique identifier of the counterparty [transfer instrument](https://docs.adyen.com/api-explorer/legalentity/3/post/transferInstruments#responses-200-id).", + "description" : "The unique identifier of the counterparty [transfer instrument](https://docs.adyen.com/api-explorer/legalentity/latest/post/transferInstruments#responses-200-id).", "type" : "string" } }, @@ -1748,20 +1748,20 @@ "$ref" : "#/components/schemas/Address" }, "dateOfBirth" : { - "description" : "The date of birth of the individual in [ISO-8601](https://www.w3.org/TR/NOTE-datetime) format. For example, **YYYY-MM-DD**.\n\nThe date must be later than January 1, 1900.\n\nAllowed only when `type` is **individual**.", + "description" : "The date of birth of the individual in [ISO-8601](https://www.w3.org/TR/NOTE-datetime) format. For example, **YYYY-MM-DD**.\n\nAllowed only when `type` is **individual**.", "format" : "date", "type" : "string" }, "firstName" : { - "description" : "The first name of the individual.\n\nSupported characters: [a-z] [A-Z] - . / — and Space.\n\nThis parameter is:\n- Allowed only when `type` is **individual**.\n- Required when `category` is **card**.", + "description" : "The first name of the individual.\n\nSupported characters: [a-z] [A-Z] - . / — and space.\n\nThis parameter is:\n- Allowed only when `type` is **individual**.\n- Required when `category` is **card**.", "type" : "string" }, "fullName" : { - "description" : "The full name of the entity that owns the bank account or card.\n\nSupported characters: [a-z] [A-Z] [0-9] , . ; : - — / \\ + & ! ? @ ( ) \" ' and Space.\n\nRequired when `category` is **bank**.", + "description" : "The full name of the entity that owns the bank account or card.\n\nSupported characters: [a-z] [A-Z] [0-9] , . ; : - — / \\ + & ! ? @ ( ) \" ' and space.\n\nRequired when `category` is **bank**.", "type" : "string" }, "lastName" : { - "description" : "The last name of the individual.\n\nSupported characters: [a-z] [A-Z] - . / — and Space.\n\nThis parameter is:\n- Allowed only when `type` is **individual**.\n- Required when `category` is **card**.", + "description" : "The last name of the individual.\n\nSupported characters: [a-z] [A-Z] - . / — and space.\n\nThis parameter is:\n- Allowed only when `type` is **individual**.\n- Required when `category` is **card**.", "type" : "string" }, "reference" : { @@ -2567,8 +2567,7 @@ "card", "internal", "issuedCard", - "platformPayment", - "card" + "platformPayment" ], "type" : "string" }, @@ -2773,20 +2772,20 @@ "$ref" : "#/components/schemas/Address" }, "dateOfBirth" : { - "description" : "The date of birth of the individual in [ISO-8601](https://www.w3.org/TR/NOTE-datetime) format. For example, **YYYY-MM-DD**.\n\nThe date must be later than January 1, 1900.\n\nAllowed only when `type` is **individual**.", + "description" : "The date of birth of the individual in [ISO-8601](https://www.w3.org/TR/NOTE-datetime) format. For example, **YYYY-MM-DD**.\n\nAllowed only when `type` is **individual**.", "format" : "date", "type" : "string" }, "firstName" : { - "description" : "The first name of the individual.\n\nSupported characters: [a-z] [A-Z] - . / — and Space.\n\nThis parameter is:\n- Allowed only when `type` is **individual**.\n- Required when `category` is **card**.", + "description" : "The first name of the individual.\n\nSupported characters: [a-z] [A-Z] - . / — and space.\n\nThis parameter is:\n- Allowed only when `type` is **individual**.\n- Required when `category` is **card**.", "type" : "string" }, "fullName" : { - "description" : "The full name of the entity that owns the bank account or card.\n\nSupported characters: [a-z] [A-Z] [0-9] , . ; : - — / \\ + & ! ? @ ( ) \" ' and Space.\n\nRequired when `category` is **bank**.", + "description" : "The full name of the entity that owns the bank account or card.\n\nSupported characters: [a-z] [A-Z] [0-9] , . ; : - — / \\ + & ! ? @ ( ) \" ' and space.\n\nRequired when `category` is **bank**.", "type" : "string" }, "lastName" : { - "description" : "The last name of the individual.\n\nSupported characters: [a-z] [A-Z] - . / — and Space.\n\nThis parameter is:\n- Allowed only when `type` is **individual**.\n- Required when `category` is **card**.", + "description" : "The last name of the individual.\n\nSupported characters: [a-z] [A-Z] - . / — and space.\n\nThis parameter is:\n- Allowed only when `type` is **individual**.\n- Required when `category` is **card**.", "type" : "string" }, "reference" : { diff --git a/json/TransferService-v4.json b/json/TransferService-v4.json index 775197e7..06234a09 100644 --- a/json/TransferService-v4.json +++ b/json/TransferService-v4.json @@ -1705,13 +1705,13 @@ "additionalProperties" : false, "properties" : { "expiryMonth" : { - "description" : "The expiry month of the card.\nFormat: 2 digits, zero-padded for single digits. For example:\n* 03 = March\n* 11 = November", + "description" : "The expiry month of the card.\n\nFormat: two digits. Add a leading zero for single-digit months. For example:\n* 03 = March\n* 11 = November", "maxLength" : 2, "minLength" : 2, "type" : "string" }, "expiryYear" : { - "description" : "The expiry year of the card.\nFormat: 4 digits. For example: 2020", + "description" : "The expiry year of the card.\n\nFormat: four digits. For example: 2020", "maxLength" : 4, "minLength" : 4, "type" : "string" @@ -1723,19 +1723,19 @@ "type" : "string" }, "number" : { - "description" : "The card number without any separators.\n\nWhen this value is returned in a response, it only includes the last 4 digits of the card number.", + "description" : "The card number without any separators.\n\nFor security, the response only includes the last four digits of the card number.", "maxLength" : 19, "minLength" : 4, "type" : "string" }, "startMonth" : { - "description" : "The month when the card was issued. Applies only to some UK debit cards.\n\nFormat: 2 digits, zero-padded for single digits. For example:\n* 03 = March\n* 11 = November", + "description" : "The month when the card was issued. Applies only to some UK debit cards.\n\nFormat: two digits. Add a leading zero for single-digit months. For example:\n* 03 = March\n* 11 = November", "maxLength" : 2, "minLength" : 2, "type" : "string" }, "startYear" : { - "description" : "The year when the card was issued. Applies only to some UK debit cards.\n\nFormat: 4 digits. For example: 2020", + "description" : "The year when the card was issued. Applies only to some UK debit cards.\n\nFormat: four digits. For example: 2020", "maxLength" : 4, "minLength" : 4, "type" : "string" @@ -1794,7 +1794,7 @@ "additionalProperties" : false, "properties" : { "balanceAccountId" : { - "description" : "The unique identifier of the counterparty [balance account](https://docs.adyen.com/api-explorer/balanceplatform/2/post/balanceAccounts#responses-200-id).", + "description" : "The unique identifier of the counterparty [balance account](https://docs.adyen.com/api-explorer/balanceplatform/latest/post/balanceAccounts#responses-200-id).", "type" : "string" }, "bankAccount" : { @@ -1806,7 +1806,7 @@ "$ref" : "#/components/schemas/Card" }, "transferInstrumentId" : { - "description" : "The unique identifier of the counterparty [transfer instrument](https://docs.adyen.com/api-explorer/legalentity/3/post/transferInstruments#responses-200-id).", + "description" : "The unique identifier of the counterparty [transfer instrument](https://docs.adyen.com/api-explorer/legalentity/latest/post/transferInstruments#responses-200-id).", "type" : "string" } }, @@ -1816,7 +1816,7 @@ "additionalProperties" : false, "properties" : { "balanceAccountId" : { - "description" : "The unique identifier of the counterparty [balance account](https://docs.adyen.com/api-explorer/balanceplatform/2/post/balanceAccounts#responses-200-id).", + "description" : "The unique identifier of the counterparty [balance account](https://docs.adyen.com/api-explorer/balanceplatform/latest/post/balanceAccounts#responses-200-id).", "type" : "string" }, "bankAccount" : { @@ -1832,7 +1832,7 @@ "$ref" : "#/components/schemas/MerchantData" }, "transferInstrumentId" : { - "description" : "The unique identifier of the counterparty [transfer instrument](https://docs.adyen.com/api-explorer/legalentity/3/post/transferInstruments#responses-200-id).", + "description" : "The unique identifier of the counterparty [transfer instrument](https://docs.adyen.com/api-explorer/legalentity/latest/post/transferInstruments#responses-200-id).", "type" : "string" } }, @@ -2464,20 +2464,20 @@ "$ref" : "#/components/schemas/Address" }, "dateOfBirth" : { - "description" : "The date of birth of the individual in [ISO-8601](https://www.w3.org/TR/NOTE-datetime) format. For example, **YYYY-MM-DD**.\n\nThe date must be later than January 1, 1900.\n\nAllowed only when `type` is **individual**.", + "description" : "The date of birth of the individual in [ISO-8601](https://www.w3.org/TR/NOTE-datetime) format. For example, **YYYY-MM-DD**.\n\nAllowed only when `type` is **individual**.", "format" : "date", "type" : "string" }, "firstName" : { - "description" : "The first name of the individual.\n\nSupported characters: [a-z] [A-Z] - . / — and Space.\n\nThis parameter is:\n- Allowed only when `type` is **individual**.\n- Required when `category` is **card**.", + "description" : "The first name of the individual.\n\nSupported characters: [a-z] [A-Z] - . / — and space.\n\nThis parameter is:\n- Allowed only when `type` is **individual**.\n- Required when `category` is **card**.", "type" : "string" }, "fullName" : { - "description" : "The full name of the entity that owns the bank account or card.\n\nSupported characters: [a-z] [A-Z] [0-9] , . ; : - — / \\ + & ! ? @ ( ) \" ' and Space.\n\nRequired when `category` is **bank**.", + "description" : "The full name of the entity that owns the bank account or card.\n\nSupported characters: [a-z] [A-Z] [0-9] , . ; : - — / \\ + & ! ? @ ( ) \" ' and space.\n\nRequired when `category` is **bank**.", "type" : "string" }, "lastName" : { - "description" : "The last name of the individual.\n\nSupported characters: [a-z] [A-Z] - . / — and Space.\n\nThis parameter is:\n- Allowed only when `type` is **individual**.\n- Required when `category` is **card**.", + "description" : "The last name of the individual.\n\nSupported characters: [a-z] [A-Z] - . / — and space.\n\nThis parameter is:\n- Allowed only when `type` is **individual**.\n- Required when `category` is **card**.", "type" : "string" }, "reference" : { @@ -3834,8 +3834,7 @@ "card", "internal", "issuedCard", - "platformPayment", - "card" + "platformPayment" ], "type" : "string" }, @@ -3921,7 +3920,7 @@ "additionalProperties" : false, "properties" : { "balanceAccountId" : { - "description" : "The unique identifier of the counterparty [balance account](https://docs.adyen.com/api-explorer/balanceplatform/2/post/balanceAccounts#responses-200-id).", + "description" : "The unique identifier of the counterparty [balance account](https://docs.adyen.com/api-explorer/balanceplatform/latest/post/balanceAccounts#responses-200-id).", "type" : "string" }, "bankAccount" : { @@ -3937,7 +3936,7 @@ "$ref" : "#/components/schemas/TransferNotificationMerchantData" }, "transferInstrumentId" : { - "description" : "The unique identifier of the counterparty [transfer instrument](https://docs.adyen.com/api-explorer/legalentity/3/post/transferInstruments#responses-200-id).", + "description" : "The unique identifier of the counterparty [transfer instrument](https://docs.adyen.com/api-explorer/legalentity/latest/post/transferInstruments#responses-200-id).", "type" : "string" } }, @@ -4166,20 +4165,20 @@ "$ref" : "#/components/schemas/Address" }, "dateOfBirth" : { - "description" : "The date of birth of the individual in [ISO-8601](https://www.w3.org/TR/NOTE-datetime) format. For example, **YYYY-MM-DD**.\n\nThe date must be later than January 1, 1900.\n\nAllowed only when `type` is **individual**.", + "description" : "The date of birth of the individual in [ISO-8601](https://www.w3.org/TR/NOTE-datetime) format. For example, **YYYY-MM-DD**.\n\nAllowed only when `type` is **individual**.", "format" : "date", "type" : "string" }, "firstName" : { - "description" : "The first name of the individual.\n\nSupported characters: [a-z] [A-Z] - . / — and Space.\n\nThis parameter is:\n- Allowed only when `type` is **individual**.\n- Required when `category` is **card**.", + "description" : "The first name of the individual.\n\nSupported characters: [a-z] [A-Z] - . / — and space.\n\nThis parameter is:\n- Allowed only when `type` is **individual**.\n- Required when `category` is **card**.", "type" : "string" }, "fullName" : { - "description" : "The full name of the entity that owns the bank account or card.\n\nSupported characters: [a-z] [A-Z] [0-9] , . ; : - — / \\ + & ! ? @ ( ) \" ' and Space.\n\nRequired when `category` is **bank**.", + "description" : "The full name of the entity that owns the bank account or card.\n\nSupported characters: [a-z] [A-Z] [0-9] , . ; : - — / \\ + & ! ? @ ( ) \" ' and space.\n\nRequired when `category` is **bank**.", "type" : "string" }, "lastName" : { - "description" : "The last name of the individual.\n\nSupported characters: [a-z] [A-Z] - . / — and Space.\n\nThis parameter is:\n- Allowed only when `type` is **individual**.\n- Required when `category` is **card**.", + "description" : "The last name of the individual.\n\nSupported characters: [a-z] [A-Z] - . / — and space.\n\nThis parameter is:\n- Allowed only when `type` is **individual**.\n- Required when `category` is **card**.", "type" : "string" }, "reference" : { diff --git a/yaml/BalancePlatformTransferNotification-v3.yaml b/yaml/BalancePlatformTransferNotification-v3.yaml index 88ddd002..a4f9ad49 100644 --- a/yaml/BalancePlatformTransferNotification-v3.yaml +++ b/yaml/BalancePlatformTransferNotification-v3.yaml @@ -389,7 +389,8 @@ components: expiryMonth: description: 'The expiry month of the card. - Format: 2 digits, zero-padded for single digits. For example: + + Format: two digits. Add a leading zero for single-digit months. For example: * 03 = March @@ -400,7 +401,8 @@ components: expiryYear: description: 'The expiry year of the card. - Format: 4 digits. For example: 2020' + + Format: four digits. For example: 2020' maxLength: 4 minLength: 4 type: string @@ -414,8 +416,8 @@ components: description: 'The card number without any separators. - When this value is returned in a response, it only includes the last 4 - digits of the card number.' + For security, the response only includes the last four digits of the card + number.' maxLength: 19 minLength: 4 type: string @@ -424,7 +426,7 @@ components: debit cards. - Format: 2 digits, zero-padded for single digits. For example: + Format: two digits. Add a leading zero for single-digit months. For example: * 03 = March @@ -437,7 +439,7 @@ components: debit cards. - Format: 4 digits. For example: 2020' + Format: four digits. For example: 2020' maxLength: 4 minLength: 4 type: string @@ -473,7 +475,7 @@ components: additionalProperties: false properties: balanceAccountId: - description: The unique identifier of the counterparty [balance account](https://docs.adyen.com/api-explorer/balanceplatform/2/post/balanceAccounts#responses-200-id). + description: The unique identifier of the counterparty [balance account](https://docs.adyen.com/api-explorer/balanceplatform/latest/post/balanceAccounts#responses-200-id). type: string bankAccount: description: Contains information about the counterparty bank account. @@ -485,7 +487,7 @@ components: description: Contains information about the merchant. $ref: '#/components/schemas/MerchantData' transferInstrumentId: - description: The unique identifier of the counterparty [transfer instrument](https://docs.adyen.com/api-explorer/legalentity/3/post/transferInstruments#responses-200-id). + description: The unique identifier of the counterparty [transfer instrument](https://docs.adyen.com/api-explorer/legalentity/latest/post/transferInstruments#responses-200-id). type: string type: object DKLocalAccountIdentification: @@ -869,25 +871,22 @@ components: format. For example, **YYYY-MM-DD**. - The date must be later than January 1, 1900. - - Allowed only when `type` is **individual**.' format: date type: string firstName: description: "The first name of the individual.\n\nSupported characters:\ - \ [a-z] [A-Z] - . / \u2014 and Space.\n\nThis parameter is:\n- Allowed\ + \ [a-z] [A-Z] - . / \u2014 and space.\n\nThis parameter is:\n- Allowed\ \ only when `type` is **individual**.\n- Required when `category` is **card**." type: string fullName: description: "The full name of the entity that owns the bank account or\ \ card.\n\nSupported characters: [a-z] [A-Z] [0-9] , . ; : - \u2014 /\ - \ \\ + & ! ? @ ( ) \" ' and Space.\n\nRequired when `category` is **bank**." + \ \\ + & ! ? @ ( ) \" ' and space.\n\nRequired when `category` is **bank**." type: string lastName: description: "The last name of the individual.\n\nSupported characters:\ - \ [a-z] [A-Z] - . / \u2014 and Space.\n\nThis parameter is:\n- Allowed\ + \ [a-z] [A-Z] - . / \u2014 and space.\n\nThis parameter is:\n- Allowed\ \ only when `type` is **individual**.\n- Required when `category` is **card**." type: string reference: @@ -1737,7 +1736,7 @@ components: additionalProperties: false properties: balanceAccountId: - description: The unique identifier of the counterparty [balance account](https://docs.adyen.com/api-explorer/balanceplatform/2/post/balanceAccounts#responses-200-id). + description: The unique identifier of the counterparty [balance account](https://docs.adyen.com/api-explorer/balanceplatform/latest/post/balanceAccounts#responses-200-id). type: string bankAccount: description: Contains information about the counterparty bank account. @@ -1749,7 +1748,7 @@ components: description: Contains information about the merchant. $ref: '#/components/schemas/TransferNotificationMerchantData' transferInstrumentId: - description: The unique identifier of the counterparty [transfer instrument](https://docs.adyen.com/api-explorer/legalentity/3/post/transferInstruments#responses-200-id). + description: The unique identifier of the counterparty [transfer instrument](https://docs.adyen.com/api-explorer/legalentity/latest/post/transferInstruments#responses-200-id). type: string type: object TransferNotificationMerchantData: diff --git a/yaml/BalancePlatformTransferNotification-v4.yaml b/yaml/BalancePlatformTransferNotification-v4.yaml index 2431bbde..307afe15 100644 --- a/yaml/BalancePlatformTransferNotification-v4.yaml +++ b/yaml/BalancePlatformTransferNotification-v4.yaml @@ -33,6 +33,11 @@ webhooks: requestBody: content: application/json: + examples: + balancePlatform-transfer-created-incoming-internal: + $ref: '#/components/examples/post-balancePlatform.transfer.created-balancePlatform-transfer-created-incoming-internal' + balancePlatform-transfer-created-outgoing-external: + $ref: '#/components/examples/post-balancePlatform.transfer.created-balancePlatform-transfer-created-outgoing-external' schema: $ref: '#/components/schemas/TransferNotificationRequest' responses: @@ -60,6 +65,15 @@ webhooks: requestBody: content: application/json: + examples: + balancePlatform-transfer-updated-authorised-incoming-internal: + $ref: '#/components/examples/post-balancePlatform.transfer.updated-balancePlatform-transfer-updated-authorised-incoming-internal' + balancePlatform-transfer-updated-authorised-outgoing-external: + $ref: '#/components/examples/post-balancePlatform.transfer.updated-balancePlatform-transfer-updated-authorised-outgoing-external' + balancePlatform-transfer-updated-booked-incoming-internal: + $ref: '#/components/examples/post-balancePlatform.transfer.updated-balancePlatform-transfer-updated-booked-incoming-internal' + balancePlatform-transfer-updated-booked-outgoing-external: + $ref: '#/components/examples/post-balancePlatform.transfer.updated-balancePlatform-transfer-updated-booked-outgoing-external' schema: $ref: '#/components/schemas/TransferNotificationRequest' responses: @@ -437,7 +451,8 @@ components: expiryMonth: description: 'The expiry month of the card. - Format: 2 digits, zero-padded for single digits. For example: + + Format: two digits. Add a leading zero for single-digit months. For example: * 03 = March @@ -448,7 +463,8 @@ components: expiryYear: description: 'The expiry year of the card. - Format: 4 digits. For example: 2020' + + Format: four digits. For example: 2020' maxLength: 4 minLength: 4 type: string @@ -462,8 +478,8 @@ components: description: 'The card number without any separators. - When this value is returned in a response, it only includes the last 4 - digits of the card number.' + For security, the response only includes the last four digits of the card + number.' maxLength: 19 minLength: 4 type: string @@ -472,7 +488,7 @@ components: debit cards. - Format: 2 digits, zero-padded for single digits. For example: + Format: two digits. Add a leading zero for single-digit months. For example: * 03 = March @@ -485,7 +501,7 @@ components: debit cards. - Format: 4 digits. For example: 2020' + Format: four digits. For example: 2020' maxLength: 4 minLength: 4 type: string @@ -521,7 +537,7 @@ components: additionalProperties: false properties: balanceAccountId: - description: The unique identifier of the counterparty [balance account](https://docs.adyen.com/api-explorer/balanceplatform/2/post/balanceAccounts#responses-200-id). + description: The unique identifier of the counterparty [balance account](https://docs.adyen.com/api-explorer/balanceplatform/latest/post/balanceAccounts#responses-200-id). type: string bankAccount: description: Contains information about the counterparty bank account. @@ -533,7 +549,7 @@ components: description: Contains information about the merchant. $ref: '#/components/schemas/MerchantData' transferInstrumentId: - description: The unique identifier of the counterparty [transfer instrument](https://docs.adyen.com/api-explorer/legalentity/3/post/transferInstruments#responses-200-id). + description: The unique identifier of the counterparty [transfer instrument](https://docs.adyen.com/api-explorer/legalentity/latest/post/transferInstruments#responses-200-id). type: string type: object DKLocalAccountIdentification: @@ -1007,25 +1023,22 @@ components: format. For example, **YYYY-MM-DD**. - The date must be later than January 1, 1900. - - Allowed only when `type` is **individual**.' format: date type: string firstName: description: "The first name of the individual.\n\nSupported characters:\ - \ [a-z] [A-Z] - . / \u2014 and Space.\n\nThis parameter is:\n- Allowed\ + \ [a-z] [A-Z] - . / \u2014 and space.\n\nThis parameter is:\n- Allowed\ \ only when `type` is **individual**.\n- Required when `category` is **card**." type: string fullName: description: "The full name of the entity that owns the bank account or\ \ card.\n\nSupported characters: [a-z] [A-Z] [0-9] , . ; : - \u2014 /\ - \ \\ + & ! ? @ ( ) \" ' and Space.\n\nRequired when `category` is **bank**." + \ \\ + & ! ? @ ( ) \" ' and space.\n\nRequired when `category` is **bank**." type: string lastName: description: "The last name of the individual.\n\nSupported characters:\ - \ [a-z] [A-Z] - . / \u2014 and Space.\n\nThis parameter is:\n- Allowed\ + \ [a-z] [A-Z] - . / \u2014 and space.\n\nThis parameter is:\n- Allowed\ \ only when `type` is **individual**.\n- Required when `category` is **card**." type: string reference: @@ -1741,7 +1754,7 @@ components: additionalProperties: false properties: balanceAccountId: - description: The unique identifier of the counterparty [balance account](https://docs.adyen.com/api-explorer/balanceplatform/2/post/balanceAccounts#responses-200-id). + description: The unique identifier of the counterparty [balance account](https://docs.adyen.com/api-explorer/balanceplatform/latest/post/balanceAccounts#responses-200-id). type: string bankAccount: description: Contains information about the counterparty bank account. @@ -1753,7 +1766,7 @@ components: description: Contains information about the merchant. $ref: '#/components/schemas/TransferNotificationMerchantData' transferInstrumentId: - description: The unique identifier of the counterparty [transfer instrument](https://docs.adyen.com/api-explorer/legalentity/3/post/transferInstruments#responses-200-id). + description: The unique identifier of the counterparty [transfer instrument](https://docs.adyen.com/api-explorer/legalentity/latest/post/transferInstruments#responses-200-id). type: string type: object TransferNotificationMerchantData: @@ -1877,4 +1890,332 @@ components: BasicAuth: scheme: basic type: http - examples: {} + examples: + post-balancePlatform.transfer.created-balancePlatform-transfer-created-incoming-internal: + summary: Initiated incoming internal transfer + description: Example webhook for an initiated incoming transfer + value: + data: + id: 2WT1N05XXY7P9XH9 + type: internalTransfer + accountHolder: + description: Your description of the account holder of the target balance + account + id: AH00000000000000000000002 + reference: Your reference of the account holder + amount: + currency: EUR + value: 1000 + balanceAccount: + description: Your description of the target balance account + id: BA00000000000000000000002 + balancePlatform: YOUR_BALANCE_PLATFORM + balances: + - currency: EUR + received: 1000 + category: internal + creationDate: '2023-02-28T13:30:05+02:00' + description: Your description of the transfer + direction: incoming + events: + - bookingDate: '2023-02-28T13:30:18+02:00' + id: JDRF00000000000000000000000001 + mutations: + - currency: EUR + received: 1000 + status: received + type: accounting + reason: approved + reference: Your reference of the transfer + referenceForBeneficiary: Your-reference-for-the-recipient-of-the-transfer-request + sequenceNumber: 1 + status: received + environment: test + type: balancePlatform.transfer.created + post-balancePlatform.transfer.created-balancePlatform-transfer-created-outgoing-external: + summary: Initiated payout to a transfer instrument + description: Example webhook for an initiated outgoing bank transfer + value: + data: + accountHolder: + description: Your description of the account holder + id: AH00000000000000000000001 + reference: Your reference for the account holder + amount: + currency: EUR + value: 10000 + balanceAccount: + description: Your description of the balance account from where the amount + is debited + id: BA00000000000000000000001 + reference: Your reference for the balance account + balancePlatform: YOUR_BALANCE_PLATFORM + balances: + - currency: EUR + received: -10000 + category: bank + categoryData: + priority: regular + type: bank + creationDate: '2023-02-28T13:30:05+02:00' + description: Your user description of the transfer + direction: outgoing + events: + - bookingDate: '2023-02-28T13:30:18+02:00' + id: EVJN00000000000000000000000001 + mutations: + - currency: EUR + received: -10000 + status: received + type: accounting + id: 6JKRLZ8LOT47J7RY + reason: approved + reference: Your user reference for the transfer + referenceForBeneficiary: Your user reference for the beneficiary + sequenceNumber: 1 + transactionRulesResult: + allHardBlockRulesPassed: true + status: received + type: bankTransfer + environment: test + type: balancePlatform.transfer.created + post-balancePlatform.transfer.updated-balancePlatform-transfer-updated-authorised-incoming-internal: + summary: Authorized incoming internal transfer + description: Example webhook of an authorised incoming transfer + value: + data: + id: 2WT1N05XXY7P9XH9 + type: internalTransfer + accountHolder: + description: Your description of the account holder of the target balance + account + id: AH00000000000000000000002 + reference: Your reference for the account holder + amount: + currency: EUR + value: 1000 + balanceAccount: + description: Your description of the target balance account + id: BA00000000000000000000002 + balancePlatform: YOUR_BALANCE_PLATFORM + balances: + - currency: EUR + received: 0 + reserved: 1000 + category: internal + creationDate: '2023-02-28T13:30:05+02:00' + description: Your description of the transfer + direction: incoming + events: + - bookingDate: '2023-02-28T13:30:18+02:00' + id: JDRF00000000000000000000000001 + mutations: + - currency: EUR + received: 1000 + status: received + type: accounting + - bookingDate: '2023-02-28T13:30:18+02:00' + id: JDRF00000000000000000000000002 + mutations: + - currency: EUR + received: -1000 + reserved: 1000 + status: authorised + type: accounting + reason: approved + reference: Your reference for the transfer + referenceForBeneficiary: Your-reference-for-the-recipient-of-the-transfer-request + sequenceNumber: 2 + status: authorised + environment: test + type: balancePlatform.transfer.updated + post-balancePlatform.transfer.updated-balancePlatform-transfer-updated-authorised-outgoing-external: + summary: Authorized payout to a transfer instrument + description: Example webhook of an authorised outgoing bank transfer + value: + data: + accountHolder: + description: Your description of the account holder + id: AH00000000000000000000001 + reference: Your reference for the account holder + amount: + currency: EUR + value: 10000 + balanceAccount: + description: Your description of the balance account from where the amount + is debited + id: BA00000000000000000000001 + reference: Your reference for the balance account + balancePlatform: YOUR_BALANCE_PLATFORM + balances: + - currency: EUR + received: 0 + reserved: -10000 + category: bank + categoryData: + priority: regular + type: bank + creationDate: '2023-02-28T13:30:05+02:00' + description: Your user description of the transfer + direction: outgoing + events: + - bookingDate: '2023-02-28T13:30:18+02:00' + id: EVJN00000000000000000000000001 + mutations: + - currency: EUR + received: -10000 + status: received + type: accounting + - bookingDate: '2023-02-28T13:30:18+02:00' + id: EVJN00000000000000000000000002 + mutations: + - currency: EUR + received: 10000 + reserved: -10000 + status: authorised + type: accounting + id: 6JKRLZ8LOT47J7RY + reason: approved + reference: Your user reference for the transfer + referenceForBeneficiary: Your user reference for the beneficiary + sequenceNumber: 2 + transactionRulesResult: + allHardBlockRulesPassed: true + status: authorised + type: bankTransfer + environment: test + type: balancePlatform.transfer.updated + post-balancePlatform.transfer.updated-balancePlatform-transfer-updated-booked-incoming-internal: + summary: Booked incoming internal transfer + description: Example webhook of a booked incoming transfer + value: + data: + id: 2WT1N05XXY7P9XH9 + type: internalTransfer + accountHolder: + description: Your description of the account holder of the target balance + account + id: AH00000000000000000000002 + reference: Your reference for the account holder + amount: + currency: EUR + value: 1000 + balanceAccount: + description: Your description of the target balance account + id: BA00000000000000000000002 + balancePlatform: YOUR_BALANCE_PLATFORM + balances: + - balance: 1000 + currency: EUR + received: 0 + reserved: 0 + category: internal + counterparty: + balanceAccountId: BA00000000000000000000001 + creationDate: '2023-02-28T13:30:05+02:00' + description: Your description of the transfer + direction: incoming + events: + - bookingDate: '2023-02-28T13:30:18+02:00' + id: JDRF00000000000000000000000001 + mutations: + - currency: EUR + received: 1000 + status: received + type: accounting + - bookingDate: '2023-02-28T13:30:18+02:00' + id: JDRF00000000000000000000000002 + mutations: + - currency: EUR + received: -1000 + reserved: 1000 + status: authorised + type: accounting + - bookingDate: '2023-02-28T13:30:18+02:00' + id: JDRF00000000000000000000000003 + mutations: + - balance: 1000 + currency: EUR + received: 0 + reserved: -1000 + status: booked + transactionId: FWKP42CL8224223D5KKJWD6FXS3VQCEUR + type: accounting + valueDate: '2023-02-28T13:30:18+02:00' + reason: approved + reference: Your reference for the transfer + referenceForBeneficiary: Your-reference-for-the-recipient-of-the-transfer-request + sequenceNumber: 3 + status: booked + environment: test + type: balancePlatform.transfer.updated + post-balancePlatform.transfer.updated-balancePlatform-transfer-updated-booked-outgoing-external: + summary: Booked payout to a transfer instrument + description: Example webhook of a booked outgoing bank transfer + value: + data: + accountHolder: + description: Your description of the account holder + id: AH00000000000000000000001 + reference: Your reference for the account holder + amount: + currency: EUR + value: 10000 + balanceAccount: + description: Your description of the balance account from where the amount + is debited + id: BA00000000000000000000001 + reference: Your reference for the balance account + balancePlatform: YOUR_BALANCE_PLATFORM + balances: + - balance: -10000 + currency: EUR + received: 0 + reserved: 0 + category: bank + categoryData: + priority: regular + type: bank + counterparty: + transferInstrumentId: SE00000000000000000000001 + creationDate: '2023-02-28T13:30:05+02:00' + description: Your user description of the transfer + direction: outgoing + events: + - bookingDate: '2023-02-28T13:30:18+02:00' + id: EVJN00000000000000000000000001 + mutations: + - currency: EUR + received: -10000 + status: received + type: accounting + - bookingDate: '2023-02-28T13:30:18+02:00' + id: EVJN00000000000000000000000002 + mutations: + - currency: EUR + received: 10000 + reserved: -10000 + status: authorised + type: accounting + - bookingDate: '2023-02-28T13:30:18+02:00' + id: EVJN00000000000000000000000003 + mutations: + - balance: -10000 + currency: EUR + received: 0 + reserved: 10000 + status: booked + transactionId: EVJN00000000000000000000000003EUR + type: accounting + valueDate: '2023-03-01T12:58:25+01:00' + id: 6JKRLZ8LOT47J7RY + reason: approved + reference: Your user reference for the transfer + referenceForBeneficiary: Your user reference for the beneficiary + sequenceNumber: 3 + transactionRulesResult: + allHardBlockRulesPassed: true + status: booked + type: bankTransfer + environment: test + type: balancePlatform.transfer.updated diff --git a/yaml/TransferService-v3.yaml b/yaml/TransferService-v3.yaml index e1bd66ad..37fd969e 100644 --- a/yaml/TransferService-v3.yaml +++ b/yaml/TransferService-v3.yaml @@ -959,7 +959,8 @@ components: expiryMonth: description: 'The expiry month of the card. - Format: 2 digits, zero-padded for single digits. For example: + + Format: two digits. Add a leading zero for single-digit months. For example: * 03 = March @@ -970,7 +971,8 @@ components: expiryYear: description: 'The expiry year of the card. - Format: 4 digits. For example: 2020' + + Format: four digits. For example: 2020' maxLength: 4 minLength: 4 type: string @@ -984,8 +986,8 @@ components: description: 'The card number without any separators. - When this value is returned in a response, it only includes the last 4 - digits of the card number.' + For security, the response only includes the last four digits of the card + number.' maxLength: 19 minLength: 4 type: string @@ -994,7 +996,7 @@ components: debit cards. - Format: 2 digits, zero-padded for single digits. For example: + Format: two digits. Add a leading zero for single-digit months. For example: * 03 = March @@ -1007,7 +1009,7 @@ components: debit cards. - Format: 4 digits. For example: 2020' + Format: four digits. For example: 2020' maxLength: 4 minLength: 4 type: string @@ -1040,7 +1042,7 @@ components: additionalProperties: false properties: balanceAccountId: - description: The unique identifier of the counterparty [balance account](https://docs.adyen.com/api-explorer/balanceplatform/2/post/balanceAccounts#responses-200-id). + description: The unique identifier of the counterparty [balance account](https://docs.adyen.com/api-explorer/balanceplatform/latest/post/balanceAccounts#responses-200-id). type: string bankAccount: description: Contains information about the counterparty bank account. @@ -1049,14 +1051,14 @@ components: description: Contains information about the counterparty card. $ref: '#/components/schemas/Card' transferInstrumentId: - description: The unique identifier of the counterparty [transfer instrument](https://docs.adyen.com/api-explorer/legalentity/3/post/transferInstruments#responses-200-id). + description: The unique identifier of the counterparty [transfer instrument](https://docs.adyen.com/api-explorer/legalentity/latest/post/transferInstruments#responses-200-id). type: string type: object CounterpartyV3: additionalProperties: false properties: balanceAccountId: - description: The unique identifier of the counterparty [balance account](https://docs.adyen.com/api-explorer/balanceplatform/2/post/balanceAccounts#responses-200-id). + description: The unique identifier of the counterparty [balance account](https://docs.adyen.com/api-explorer/balanceplatform/latest/post/balanceAccounts#responses-200-id). type: string bankAccount: description: Contains information about the counterparty bank account. @@ -1068,7 +1070,7 @@ components: description: Contains information about the merchant. $ref: '#/components/schemas/MerchantData' transferInstrumentId: - description: The unique identifier of the counterparty [transfer instrument](https://docs.adyen.com/api-explorer/legalentity/3/post/transferInstruments#responses-200-id). + description: The unique identifier of the counterparty [transfer instrument](https://docs.adyen.com/api-explorer/legalentity/latest/post/transferInstruments#responses-200-id). type: string type: object DKLocalAccountIdentification: @@ -1341,25 +1343,22 @@ components: format. For example, **YYYY-MM-DD**. - The date must be later than January 1, 1900. - - Allowed only when `type` is **individual**.' format: date type: string firstName: description: "The first name of the individual.\n\nSupported characters:\ - \ [a-z] [A-Z] - . / \u2014 and Space.\n\nThis parameter is:\n- Allowed\ + \ [a-z] [A-Z] - . / \u2014 and space.\n\nThis parameter is:\n- Allowed\ \ only when `type` is **individual**.\n- Required when `category` is **card**." type: string fullName: description: "The full name of the entity that owns the bank account or\ \ card.\n\nSupported characters: [a-z] [A-Z] [0-9] , . ; : - \u2014 /\ - \ \\ + & ! ? @ ( ) \" ' and Space.\n\nRequired when `category` is **bank**." + \ \\ + & ! ? @ ( ) \" ' and space.\n\nRequired when `category` is **bank**." type: string lastName: description: "The last name of the individual.\n\nSupported characters:\ - \ [a-z] [A-Z] - . / \u2014 and Space.\n\nThis parameter is:\n- Allowed\ + \ [a-z] [A-Z] - . / \u2014 and space.\n\nThis parameter is:\n- Allowed\ \ only when `type` is **individual**.\n- Required when `category` is **card**." type: string reference: @@ -2182,7 +2181,6 @@ components: - internal - issuedCard - platformPayment - - card type: string counterparty: x-addedInVersion: '3' @@ -2410,25 +2408,22 @@ components: format. For example, **YYYY-MM-DD**. - The date must be later than January 1, 1900. - - Allowed only when `type` is **individual**.' format: date type: string firstName: description: "The first name of the individual.\n\nSupported characters:\ - \ [a-z] [A-Z] - . / \u2014 and Space.\n\nThis parameter is:\n- Allowed\ + \ [a-z] [A-Z] - . / \u2014 and space.\n\nThis parameter is:\n- Allowed\ \ only when `type` is **individual**.\n- Required when `category` is **card**." type: string fullName: description: "The full name of the entity that owns the bank account or\ \ card.\n\nSupported characters: [a-z] [A-Z] [0-9] , . ; : - \u2014 /\ - \ \\ + & ! ? @ ( ) \" ' and Space.\n\nRequired when `category` is **bank**." + \ \\ + & ! ? @ ( ) \" ' and space.\n\nRequired when `category` is **bank**." type: string lastName: description: "The last name of the individual.\n\nSupported characters:\ - \ [a-z] [A-Z] - . / \u2014 and Space.\n\nThis parameter is:\n- Allowed\ + \ [a-z] [A-Z] - . / \u2014 and space.\n\nThis parameter is:\n- Allowed\ \ only when `type` is **individual**.\n- Required when `category` is **card**." type: string reference: diff --git a/yaml/TransferService-v4.yaml b/yaml/TransferService-v4.yaml index fd1f1b99..ce8a26c1 100644 --- a/yaml/TransferService-v4.yaml +++ b/yaml/TransferService-v4.yaml @@ -1302,7 +1302,8 @@ components: expiryMonth: description: 'The expiry month of the card. - Format: 2 digits, zero-padded for single digits. For example: + + Format: two digits. Add a leading zero for single-digit months. For example: * 03 = March @@ -1313,7 +1314,8 @@ components: expiryYear: description: 'The expiry year of the card. - Format: 4 digits. For example: 2020' + + Format: four digits. For example: 2020' maxLength: 4 minLength: 4 type: string @@ -1327,8 +1329,8 @@ components: description: 'The card number without any separators. - When this value is returned in a response, it only includes the last 4 - digits of the card number.' + For security, the response only includes the last four digits of the card + number.' maxLength: 19 minLength: 4 type: string @@ -1337,7 +1339,7 @@ components: debit cards. - Format: 2 digits, zero-padded for single digits. For example: + Format: two digits. Add a leading zero for single-digit months. For example: * 03 = March @@ -1350,7 +1352,7 @@ components: debit cards. - Format: 4 digits. For example: 2020' + Format: four digits. For example: 2020' maxLength: 4 minLength: 4 type: string @@ -1403,7 +1405,7 @@ components: additionalProperties: false properties: balanceAccountId: - description: The unique identifier of the counterparty [balance account](https://docs.adyen.com/api-explorer/balanceplatform/2/post/balanceAccounts#responses-200-id). + description: The unique identifier of the counterparty [balance account](https://docs.adyen.com/api-explorer/balanceplatform/latest/post/balanceAccounts#responses-200-id). type: string bankAccount: description: Contains information about the counterparty bank account. @@ -1412,14 +1414,14 @@ components: description: Contains information about the counterparty card. $ref: '#/components/schemas/Card' transferInstrumentId: - description: The unique identifier of the counterparty [transfer instrument](https://docs.adyen.com/api-explorer/legalentity/3/post/transferInstruments#responses-200-id). + description: The unique identifier of the counterparty [transfer instrument](https://docs.adyen.com/api-explorer/legalentity/latest/post/transferInstruments#responses-200-id). type: string type: object CounterpartyV3: additionalProperties: false properties: balanceAccountId: - description: The unique identifier of the counterparty [balance account](https://docs.adyen.com/api-explorer/balanceplatform/2/post/balanceAccounts#responses-200-id). + description: The unique identifier of the counterparty [balance account](https://docs.adyen.com/api-explorer/balanceplatform/latest/post/balanceAccounts#responses-200-id). type: string bankAccount: description: Contains information about the counterparty bank account. @@ -1431,7 +1433,7 @@ components: description: Contains information about the merchant. $ref: '#/components/schemas/MerchantData' transferInstrumentId: - description: The unique identifier of the counterparty [transfer instrument](https://docs.adyen.com/api-explorer/legalentity/3/post/transferInstruments#responses-200-id). + description: The unique identifier of the counterparty [transfer instrument](https://docs.adyen.com/api-explorer/legalentity/latest/post/transferInstruments#responses-200-id). type: string type: object DKLocalAccountIdentification: @@ -1962,25 +1964,22 @@ components: format. For example, **YYYY-MM-DD**. - The date must be later than January 1, 1900. - - Allowed only when `type` is **individual**.' format: date type: string firstName: description: "The first name of the individual.\n\nSupported characters:\ - \ [a-z] [A-Z] - . / \u2014 and Space.\n\nThis parameter is:\n- Allowed\ + \ [a-z] [A-Z] - . / \u2014 and space.\n\nThis parameter is:\n- Allowed\ \ only when `type` is **individual**.\n- Required when `category` is **card**." type: string fullName: description: "The full name of the entity that owns the bank account or\ \ card.\n\nSupported characters: [a-z] [A-Z] [0-9] , . ; : - \u2014 /\ - \ \\ + & ! ? @ ( ) \" ' and Space.\n\nRequired when `category` is **bank**." + \ \\ + & ! ? @ ( ) \" ' and space.\n\nRequired when `category` is **bank**." type: string lastName: description: "The last name of the individual.\n\nSupported characters:\ - \ [a-z] [A-Z] - . / \u2014 and Space.\n\nThis parameter is:\n- Allowed\ + \ [a-z] [A-Z] - . / \u2014 and space.\n\nThis parameter is:\n- Allowed\ \ only when `type` is **individual**.\n- Required when `category` is **card**." type: string reference: @@ -3246,7 +3245,6 @@ components: - internal - issuedCard - platformPayment - - card type: string counterparty: x-addedInVersion: '3' @@ -3384,7 +3382,7 @@ components: additionalProperties: false properties: balanceAccountId: - description: The unique identifier of the counterparty [balance account](https://docs.adyen.com/api-explorer/balanceplatform/2/post/balanceAccounts#responses-200-id). + description: The unique identifier of the counterparty [balance account](https://docs.adyen.com/api-explorer/balanceplatform/latest/post/balanceAccounts#responses-200-id). type: string bankAccount: description: Contains information about the counterparty bank account. @@ -3396,7 +3394,7 @@ components: description: Contains information about the merchant. $ref: '#/components/schemas/TransferNotificationMerchantData' transferInstrumentId: - description: The unique identifier of the counterparty [transfer instrument](https://docs.adyen.com/api-explorer/legalentity/3/post/transferInstruments#responses-200-id). + description: The unique identifier of the counterparty [transfer instrument](https://docs.adyen.com/api-explorer/legalentity/latest/post/transferInstruments#responses-200-id). type: string type: object TransferNotificationMerchantData: @@ -3578,25 +3576,22 @@ components: format. For example, **YYYY-MM-DD**. - The date must be later than January 1, 1900. - - Allowed only when `type` is **individual**.' format: date type: string firstName: description: "The first name of the individual.\n\nSupported characters:\ - \ [a-z] [A-Z] - . / \u2014 and Space.\n\nThis parameter is:\n- Allowed\ + \ [a-z] [A-Z] - . / \u2014 and space.\n\nThis parameter is:\n- Allowed\ \ only when `type` is **individual**.\n- Required when `category` is **card**." type: string fullName: description: "The full name of the entity that owns the bank account or\ \ card.\n\nSupported characters: [a-z] [A-Z] [0-9] , . ; : - \u2014 /\ - \ \\ + & ! ? @ ( ) \" ' and Space.\n\nRequired when `category` is **bank**." + \ \\ + & ! ? @ ( ) \" ' and space.\n\nRequired when `category` is **bank**." type: string lastName: description: "The last name of the individual.\n\nSupported characters:\ - \ [a-z] [A-Z] - . / \u2014 and Space.\n\nThis parameter is:\n- Allowed\ + \ [a-z] [A-Z] - . / \u2014 and space.\n\nThis parameter is:\n- Allowed\ \ only when `type` is **individual**.\n- Required when `category` is **card**." type: string reference: