diff --git a/json/BalancePlatformConfigurationNotification-v1.json b/json/BalancePlatformConfigurationNotification-v1.json index b054f950..98240797 100644 --- a/json/BalancePlatformConfigurationNotification-v1.json +++ b/json/BalancePlatformConfigurationNotification-v1.json @@ -11,12 +11,6 @@ "url" : "https://github.com/Adyen/adyen-openapi" } }, - "x-groups" : [ - "Account holder", - "Balance account", - "Payment instrument", - "Card order" - ], "tags" : [ { "name" : "Account holder" @@ -41,7 +35,6 @@ "summary" : "Account holder created", "description" : "Adyen sends this webhook when you successfully [create an account holder](https://docs.adyen.com/api-explorer/balanceplatform/latest/post/accountHolders).", "operationId" : "post-balancePlatform.accountHolder.created", - "x-groupName" : "Account holder", "x-sortIndex" : 1, "x-methodName" : "accountHolderCreated", "security" : [ @@ -56,6 +49,9 @@ "examples" : { "balancePlatform-accountHolder-created" : { "$ref" : "#/components/examples/post-balancePlatform.accountHolder.created-balancePlatform-accountHolder-created" + }, + "balancePlatform-accountHolder-created-lem-v3" : { + "$ref" : "#/components/examples/post-balancePlatform.accountHolder.created-balancePlatform-accountHolder-created-lem-v3" } }, "schema" : { @@ -71,6 +67,9 @@ "examples" : { "balancePlatform-accountHolder-created" : { "$ref" : "#/components/examples/WebhookAck" + }, + "balancePlatform-accountHolder-created-lem-v3" : { + "$ref" : "#/components/examples/WebhookAck" } }, "schema" : { @@ -91,7 +90,6 @@ "summary" : "Account holder updated", "description" : "Adyen sends this webhook when you successfully [update an account holder](https://docs.adyen.com/api-explorer/balanceplatform/latest/patch/accountHolders/_id_).", "operationId" : "post-balancePlatform.accountHolder.updated", - "x-groupName" : "Account holder", "x-sortIndex" : 2, "x-methodName" : "accountHolderUpdated", "security" : [ @@ -106,6 +104,9 @@ "examples" : { "balancePlatform-accountHolder-updated" : { "$ref" : "#/components/examples/post-balancePlatform.accountHolder.updated-balancePlatform-accountHolder-updated" + }, + "balancePlatform-accountHolder-updated-lem-v3" : { + "$ref" : "#/components/examples/post-balancePlatform.accountHolder.updated-balancePlatform-accountHolder-updated-lem-v3" } }, "schema" : { @@ -121,6 +122,9 @@ "examples" : { "balancePlatform-accountHolder-updated" : { "$ref" : "#/components/examples/WebhookAck" + }, + "balancePlatform-accountHolder-updated-lem-v3" : { + "$ref" : "#/components/examples/WebhookAck" } }, "schema" : { @@ -141,7 +145,6 @@ "summary" : "Balance account created", "description" : "Adyen sends this webhook when you successfully [create a balance account](https://docs.adyen.com/api-explorer/balanceplatform/latest/post/balanceAccounts).", "operationId" : "post-balancePlatform.balanceAccount.created", - "x-groupName" : "Balance account", "x-sortIndex" : 1, "x-methodName" : "balanceAccountCreated", "security" : [ @@ -191,7 +194,6 @@ "summary" : "Balance account updated", "description" : "Adyen sends this webhook when you successfully [update a balance account](https://docs.adyen.com/api-explorer/balanceplatform/latest/patch/balanceAccounts/_id_).", "operationId" : "post-balancePlatform.balanceAccount.updated", - "x-groupName" : "Balance account", "x-sortIndex" : 2, "x-methodName" : "balanceAccountUpdated", "security" : [ @@ -241,7 +243,6 @@ "summary" : "Sweep created", "description" : "Adyen sends this webhook when you successfully [create a sweep](https://docs.adyen.com/api-explorer/balanceplatform/latest/post/balanceAccounts/_balanceAccountId_/sweeps).", "operationId" : "post-balancePlatform.balanceAccountSweep.created", - "x-groupName" : "Balance account", "x-sortIndex" : 3, "x-methodName" : "sweepCreated", "security" : [ @@ -291,7 +292,6 @@ "summary" : "Sweep deleted", "description" : "Adyen sends this webhook when you successfully [delete a sweep](https://docs.adyen.com/api-explorer/balanceplatform/latest/delete/balanceAccounts/_balanceAccountId_/sweeps/_sweepId_).", "operationId" : "post-balancePlatform.balanceAccountSweep.deleted", - "x-groupName" : "Balance account", "x-sortIndex" : 5, "x-methodName" : "sweepDeleted", "security" : [ @@ -341,7 +341,6 @@ "summary" : "Sweep updated", "description" : "Adyen sends this webhook when you successfully [update a sweep](https://docs.adyen.com/api-explorer/balanceplatform/latest/patch/balanceAccounts/_balanceAccountId_/sweeps/_sweepId_).", "operationId" : "post-balancePlatform.balanceAccountSweep.updated", - "x-groupName" : "Balance account", "x-sortIndex" : 4, "x-methodName" : "sweepUpdated", "security" : [ @@ -391,7 +390,6 @@ "summary" : "Card order created", "description" : "Adyen sends this webhook to indicate a successful creation of a card order after you create a [payment instrument](https://docs.adyen.com/api-explorer/balanceplatform/latest/post/paymentInstruments) of `type` **card** and `formFactor` **physical**.", "operationId" : "post-balancePlatform.cardorder.created", - "x-groupName" : "Card order", "x-sortIndex" : 1, "x-methodName" : "cardOrderCreated", "security" : [ @@ -431,7 +429,6 @@ "summary" : "Card order updated", "description" : "Adyen sends this webhook when there is an update in card order status.", "operationId" : "post-balancePlatform.cardorder.updated", - "x-groupName" : "Card order", "x-sortIndex" : 2, "x-methodName" : "cardOrderUpdated", "security" : [ @@ -471,7 +468,6 @@ "summary" : "Payment instrument created", "description" : "Adyen sends this webhook when you successfully [create a payment instrument](https://docs.adyen.com/api-explorer/balanceplatform/latest/post/paymentInstruments). \n>The webhook does not include the card number when creating virtual cards. You can only get the card number in the response of the POST [/paymentInstruments](https://docs.adyen.com/api-explorer/balanceplatform/latest/post/paymentInstruments#responses-200-card-number) request.", "operationId" : "post-balancePlatform.paymentInstrument.created", - "x-groupName" : "Payment instrument", "x-sortIndex" : 1, "x-methodName" : "paymentInstrumentCreated", "security" : [ @@ -521,7 +517,6 @@ "summary" : "Payment instrument updated", "description" : "Adyen sends this webhook when you successfully [update a payment instrument](https://docs.adyen.com/api-explorer/balanceplatform/latest/patch/paymentInstruments/_id_). ", "operationId" : "post-balancePlatform.paymentInstrument.updated", - "x-groupName" : "Payment instrument", "x-sortIndex" : 2, "x-methodName" : "paymentInstrumentUpdated", "security" : [ @@ -1337,7 +1332,7 @@ "type" : "string" }, "card" : { - "description" : "Card delivery status.", + "description" : "The status of the card delivery.\n\nPossible values: **created**, **rejected**, **processing**, **produced**, **shipped**, **delivered**, **notApplicable**, **unknown**. ", "$ref" : "#/components/schemas/CardOrderItemDeliveryStatus" }, "cardOrderItemId" : { @@ -1358,11 +1353,11 @@ "type" : "string" }, "pin" : { - "description" : "PIN delivery status.", + "description" : "Contains information about the status of the PIN delivery.", "$ref" : "#/components/schemas/CardOrderItemDeliveryStatus" }, "shippingMethod" : { - "description" : "Shipping method used to deliver the card or the PIN.", + "description" : "The shipping method used to deliver the card or the PIN.", "type" : "string" } }, @@ -1371,11 +1366,11 @@ "CardOrderItemDeliveryStatus" : { "properties" : { "errorMessage" : { - "description" : "Error message.", + "description" : "An error message.", "type" : "string" }, "status" : { - "description" : "Status of the delivery.", + "description" : "The status of the PIN delivery.", "enum" : [ "created", "delivered", @@ -1389,7 +1384,7 @@ "type" : "string" }, "trackingNumber" : { - "description" : "Tracking number of the delivery.", + "description" : "The tracking number of the PIN delivery.", "type" : "string" } }, @@ -2325,6 +2320,158 @@ "type" : "balancePlatform.accountHolder.created" } }, + "post-balancePlatform.accountHolder.created-balancePlatform-accountHolder-created-lem-v3" : { + "summary" : "Account holder created with LEM API v3", + "description" : "Example webhook when an account holder was created with LEM API v3", + "value" : { + "data" : { + "balancePlatform" : "YOUR_BALANCE_PLATFORM", + "accountHolder" : { + "legalEntityId" : "LE43319330319C8AYX89L2V59", + "reference" : "YOUR_REFERENCE-2412C", + "capabilities" : { + "sendToTransferInstrument" : { + "enabled" : true, + "requested" : true, + "allowed" : false, + "problems" : [ + { + "entity" : { + "id" : "LE43319330319C8AYX89L2V59", + "type" : "LegalEntity" + }, + "verificationErrors" : [ + { + "code" : "2_902", + "message" : "Terms Of Service forms are not accepted.", + "remediatingActions" : [ + { + "code" : "2_902", + "message" : "Accept TOS" + } + ], + "type" : "invalidInput" + } + ] + }, + { + "entity" : { + "id" : "SE576BH223222F5GJVKHH6BDT", + "type" : "BankAccount" + }, + "verificationErrors" : [ + { + "code" : "2_8037", + "message" : "'bankStatement' was missing.", + "remediatingActions" : [ + { + "code" : "1_703", + "message" : "Upload a bank statement" + } + ], + "type" : "dataMissing" + } + ] + }, + { + "entity" : { + "id" : "SE3222Z223222Q5J4D58K3DWP", + "type" : "BankAccount" + }, + "verificationErrors" : [ + { + "code" : "2_8037", + "message" : "'bankStatement' was missing.", + "remediatingActions" : [ + { + "code" : "1_703", + "message" : "Upload a bank statement" + } + ], + "type" : "dataMissing" + } + ] + }, + { + "entity" : { + "id" : "LE43319330319C8AYX89L2V59", + "type" : "LegalEntity" + }, + "verificationErrors" : [ + { + "code" : "2_8189", + "message" : "'UBO through control' was missing.", + "remediatingActions" : [ + { + "code" : "2_151", + "message" : "Add 'organization.entityAssociations' of type 'uboThroughControl' to legal entity" + } + ], + "type" : "dataMissing" + }, + { + "code" : "1_50", + "message" : "Organization details couldn't be verified", + "subErrors" : [ + { + "code" : "1_5016", + "message" : "The tax ID number couldn't be verified", + "remediatingActions" : [ + { + "code" : "1_500", + "message" : "Update organization details" + }, + { + "code" : "1_501", + "message" : "Upload a registration document" + } + ], + "type" : "invalidInput" + } + ], + "type" : "invalidInput" + }, + { + "code" : "2_8067", + "message" : "'Signatory' was missing.", + "remediatingActions" : [ + { + "code" : "2_124", + "message" : "Add 'organization.entityAssociations' of type 'signatory' to legal entity" + } + ], + "type" : "dataMissing" + } + ] + } + ], + "transferInstruments" : [ + { + "enabled" : true, + "requested" : true, + "allowed" : false, + "id" : "SE576BH223222F5GJVKHH6BDT", + "verificationStatus" : "pending" + }, + { + "enabled" : true, + "requested" : true, + "allowed" : false, + "id" : "SE3222Z223222Q5J4D58K3DWP", + "verificationStatus" : "pending" + } + ], + "verificationStatus" : "pending" + } + }, + "id" : "AH32272223222B5CZW6QZ2V34", + "status" : "Active" + } + }, + "environment" : "live", + "type" : "balancePlatform.accountHolder.created" + } + }, "post-balancePlatform.accountHolder.updated-balancePlatform-accountHolder-updated" : { "summary" : "Account holder updated", "description" : "Example webhook when an account holder was updated", @@ -2388,6 +2535,158 @@ "type" : "balancePlatform.accountHolder.updated" } }, + "post-balancePlatform.accountHolder.updated-balancePlatform-accountHolder-updated-lem-v3" : { + "summary" : "Account holder updated with LEM API v3", + "description" : "Example webhook when an account holder was updated with LEM API v3", + "value" : { + "data" : { + "balancePlatform" : "YOUR_BALANCE_PLATFORM", + "accountHolder" : { + "legalEntityId" : "LE43319330319C8AYX89L2V59", + "reference" : "YOUR_REFERENCE-2412C", + "capabilities" : { + "sendToTransferInstrument" : { + "enabled" : true, + "requested" : true, + "allowed" : false, + "problems" : [ + { + "entity" : { + "id" : "LE43319330319C8AYX89L2V59", + "type" : "LegalEntity" + }, + "verificationErrors" : [ + { + "code" : "2_902", + "message" : "Terms Of Service forms are not accepted.", + "remediatingActions" : [ + { + "code" : "2_902", + "message" : "Accept TOS" + } + ], + "type" : "invalidInput" + } + ] + }, + { + "entity" : { + "id" : "SE576BH223222F5GJVKHH6BDT", + "type" : "BankAccount" + }, + "verificationErrors" : [ + { + "code" : "2_8037", + "message" : "'bankStatement' was missing.", + "remediatingActions" : [ + { + "code" : "1_703", + "message" : "Upload a bank statement" + } + ], + "type" : "dataMissing" + } + ] + }, + { + "entity" : { + "id" : "SE3222Z223222Q5J4D58K3DWP", + "type" : "BankAccount" + }, + "verificationErrors" : [ + { + "code" : "2_8037", + "message" : "'bankStatement' was missing.", + "remediatingActions" : [ + { + "code" : "1_703", + "message" : "Upload a bank statement" + } + ], + "type" : "dataMissing" + } + ] + }, + { + "entity" : { + "id" : "LE43319330319C8AYX89L2V59", + "type" : "LegalEntity" + }, + "verificationErrors" : [ + { + "code" : "2_8189", + "message" : "'UBO through control' was missing.", + "remediatingActions" : [ + { + "code" : "2_151", + "message" : "Add 'organization.entityAssociations' of type 'uboThroughControl' to legal entity" + } + ], + "type" : "dataMissing" + }, + { + "code" : "1_50", + "message" : "Organization details couldn't be verified", + "subErrors" : [ + { + "code" : "1_5016", + "message" : "The tax ID number couldn't be verified", + "remediatingActions" : [ + { + "code" : "1_500", + "message" : "Update organization details" + }, + { + "code" : "1_501", + "message" : "Upload a registration document" + } + ], + "type" : "invalidInput" + } + ], + "type" : "invalidInput" + }, + { + "code" : "2_8067", + "message" : "'Signatory' was missing.", + "remediatingActions" : [ + { + "code" : "2_124", + "message" : "Add 'organization.entityAssociations' of type 'signatory' to legal entity" + } + ], + "type" : "dataMissing" + } + ] + } + ], + "transferInstruments" : [ + { + "enabled" : true, + "requested" : true, + "allowed" : false, + "id" : "SE576BH223222F5GJVKHH6BDT", + "verificationStatus" : "pending" + }, + { + "enabled" : true, + "requested" : true, + "allowed" : false, + "id" : "SE3222Z223222Q5J4D58K3DWP", + "verificationStatus" : "pending" + } + ], + "verificationStatus" : "pending" + } + }, + "id" : "AH32272223222B5CZW6QZ2V34", + "status" : "Active" + } + }, + "environment" : "live", + "type" : "balancePlatform.accountHolder.updated" + } + }, "post-balancePlatform.balanceAccount.created-balancePlatform-balanceAccount-created" : { "summary" : "Balance account created", "description" : "Example webhook when a balance account was created", diff --git a/json/BalancePlatformReportNotification-v1.json b/json/BalancePlatformReportNotification-v1.json index b52da95b..1ab354fc 100644 --- a/json/BalancePlatformReportNotification-v1.json +++ b/json/BalancePlatformReportNotification-v1.json @@ -11,9 +11,6 @@ "url" : "https://github.com/Adyen/adyen-openapi" } }, - "x-groups" : [ - "General" - ], "tags" : [ { "name" : "General" @@ -28,7 +25,6 @@ "summary" : "Report generated", "description" : "Adyen sends this webhook after a report is generated and ready to be downloaded. The webhook contains the URL at which the report can be downloaded.\n\nBefore you download reports, ask your Adyen contact for your report credentials. You must use your the credentials to authenticate your GET request.", "operationId" : "post-balancePlatform.report.created", - "x-groupName" : "General", "x-sortIndex" : 0, "x-methodName" : "reportGenerated", "security" : [ diff --git a/json/BalancePlatformService-v2.json b/json/BalancePlatformService-v2.json index 0ede744b..84729051 100644 --- a/json/BalancePlatformService-v2.json +++ b/json/BalancePlatformService-v2.json @@ -16,19 +16,6 @@ "url" : "https://github.com/Adyen/adyen-openapi" } }, - "x-groups" : [ - "Platform", - "Account holders", - "Balance accounts", - "Payment instruments", - "Payment instrument groups", - "Transaction rules", - "Bank account validation", - "Network tokens", - "Grant accounts", - "Grant offers", - "Transfer routes" - ], "tags" : [ { "name" : "Platform" @@ -60,6 +47,12 @@ { "name" : "Grant offers" }, + { + "name" : "PIN functionality" + }, + { + "name" : "Card orders" + }, { "name" : "Transfer routes" } @@ -74,10 +67,13 @@ "description" : "Creates an account holder linked to a [legal entity](https://docs.adyen.com/api-explorer/#/legalentity/latest/post/legalEntities).\n\n", "x-addedInVersion" : "1", "operationId" : "post-accountHolders", - "x-groupName" : "Account holders", "x-sortIndex" : 1, "x-methodName" : "createAccountHolder", "security" : [ + { + "clientKey" : [ + ] + }, { "BasicAuth" : [ ] @@ -204,10 +200,13 @@ "description" : "Returns an account holder.", "x-addedInVersion" : "1", "operationId" : "get-accountHolders-id", - "x-groupName" : "Account holders", "x-sortIndex" : 3, "x-methodName" : "getAccountHolder", "security" : [ + { + "clientKey" : [ + ] + }, { "BasicAuth" : [ ] @@ -329,10 +328,13 @@ "description" : "Updates an account holder. When updating an account holder resource, if a parameter is not provided in the request, it is left unchanged.", "x-addedInVersion" : "1", "operationId" : "patch-accountHolders-id", - "x-groupName" : "Account holders", "x-sortIndex" : 2, "x-methodName" : "updateAccountHolder", "security" : [ + { + "clientKey" : [ + ] + }, { "BasicAuth" : [ ] @@ -476,10 +478,13 @@ "description" : "Returns a paginated list of the balance accounts associated with an account holder. To fetch multiple pages, use the query parameters. \n\nFor example, to limit the page to 5 balance accounts and skip the first 10, use `/accountHolders/{id}/balanceAccounts?limit=5&offset=10`.", "x-addedInVersion" : "1", "operationId" : "get-accountHolders-id-balanceAccounts", - "x-groupName" : "Account holders", "x-sortIndex" : 4, "x-methodName" : "getAllBalanceAccountsOfAccountHolder", "security" : [ + { + "clientKey" : [ + ] + }, { "BasicAuth" : [ ] @@ -623,10 +628,13 @@ "description" : "Generates a tax form for account holders operating in the US. For more information, refer to [Providing tax forms](https://docs.adyen.com/marketplaces-and-platforms/us-tax-forms/).", "x-addedInVersion" : "2", "operationId" : "get-accountHolders-id-taxForms", - "x-groupName" : "Account holders", "x-sortIndex" : 5, "x-methodName" : "getTaxForm", "security" : [ + { + "clientKey" : [ + ] + }, { "BasicAuth" : [ ] @@ -781,10 +789,13 @@ "description" : "Creates a balance account that holds the funds of the associated account holder.", "x-addedInVersion" : "1", "operationId" : "post-balanceAccounts", - "x-groupName" : "Balance accounts", "x-sortIndex" : 1, "x-methodName" : "createBalanceAccount", "security" : [ + { + "clientKey" : [ + ] + }, { "BasicAuth" : [ ] @@ -911,10 +922,13 @@ "description" : "Returns a list of the sweeps configured for a balance account.\n\nTo fetch multiple pages, use the query parameters. For example, to limit the page to 5 sweeps and to skip the first 10, use `/balanceAccounts/{balanceAccountId}/sweeps?limit=5&offset=10`.", "x-addedInVersion" : "2", "operationId" : "get-balanceAccounts-balanceAccountId-sweeps", - "x-groupName" : "Balance accounts", "x-sortIndex" : 7, "x-methodName" : "getAllSweepsForBalanceAccount", "security" : [ + { + "clientKey" : [ + ] + }, { "BasicAuth" : [ ] @@ -1056,10 +1070,13 @@ "description" : "Creates a sweep that results in moving funds from or to a balance account.\n\nA sweep pulls in or pushes out funds based on a defined schedule, amount, currency, and a source or a destination.", "x-addedInVersion" : "2", "operationId" : "post-balanceAccounts-balanceAccountId-sweeps", - "x-groupName" : "Balance accounts", "x-sortIndex" : 5, "x-methodName" : "createSweep", "security" : [ + { + "clientKey" : [ + ] + }, { "BasicAuth" : [ ] @@ -1209,10 +1226,13 @@ "description" : "Deletes a sweep for a balance account.", "x-addedInVersion" : "2", "operationId" : "delete-balanceAccounts-balanceAccountId-sweeps-sweepId", - "x-groupName" : "Balance accounts", "x-sortIndex" : 9, "x-methodName" : "deleteSweep", "security" : [ + { + "clientKey" : [ + ] + }, { "BasicAuth" : [ ] @@ -1331,10 +1351,13 @@ "description" : "Returns a sweep.", "x-addedInVersion" : "2", "operationId" : "get-balanceAccounts-balanceAccountId-sweeps-sweepId", - "x-groupName" : "Balance accounts", "x-sortIndex" : 8, "x-methodName" : "getSweep", "security" : [ + { + "clientKey" : [ + ] + }, { "BasicAuth" : [ ] @@ -1465,10 +1488,13 @@ "description" : "Updates a sweep. When updating a sweep resource, note that if a request parameter is not provided, the parameter is left unchanged.", "x-addedInVersion" : "2", "operationId" : "patch-balanceAccounts-balanceAccountId-sweeps-sweepId", - "x-groupName" : "Balance accounts", "x-sortIndex" : 6, "x-methodName" : "updateSweep", "security" : [ + { + "clientKey" : [ + ] + }, { "BasicAuth" : [ ] @@ -1615,10 +1641,13 @@ "description" : "Returns a balance account and its balances for the default currency and other currencies with a non-zero balance.", "x-addedInVersion" : "1", "operationId" : "get-balanceAccounts-id", - "x-groupName" : "Balance accounts", "x-sortIndex" : 3, "x-methodName" : "getBalanceAccount", "security" : [ + { + "clientKey" : [ + ] + }, { "BasicAuth" : [ ] @@ -1740,10 +1769,13 @@ "description" : "Updates a balance account.", "x-addedInVersion" : "1", "operationId" : "patch-balanceAccounts-id", - "x-groupName" : "Balance accounts", "x-sortIndex" : 2, "x-methodName" : "updateBalanceAccount", "security" : [ + { + "clientKey" : [ + ] + }, { "BasicAuth" : [ ] @@ -1877,14 +1909,17 @@ "tags" : [ "Balance accounts" ], - "summary" : "Get all payment instruments for a balance account", - "description" : "Returns a paginated list of the payment instruments associated with a balance account. \n\nTo fetch multiple pages, use the query parameters.For example, to limit the page to 3 payment instruments and to skip the first 6, use `/balanceAccounts/{id}/paymentInstruments?limit=3&offset=6`.", + "summary" : "Get payment instruments linked to a balance account", + "description" : "Returns a paginated list of the payment instruments associated with a balance account. \n\nTo fetch multiple pages, use the query parameters.For example, to limit the page to 3 payment instruments which are in active status and to skip the first 6, use `/balanceAccounts/{id}/paymentInstruments?limit=3&offset=6&status=active`.", "x-addedInVersion" : "1", "operationId" : "get-balanceAccounts-id-paymentInstruments", - "x-groupName" : "Balance accounts", "x-sortIndex" : 4, - "x-methodName" : "getAllPaymentInstrumentsForBalanceAccount", + "x-methodName" : "getPaymentInstrumentsLinkedToBalanceAccount", "security" : [ + { + "clientKey" : [ + ] + }, { "BasicAuth" : [ ] @@ -1923,6 +1958,15 @@ "format" : "int32", "type" : "integer" } + }, + { + "description" : "The status of the payment instruments that you want to get. By default, the response includes payment instruments with any status.", + "name" : "status", + "in" : "query", + "required" : false, + "schema" : { + "type" : "string" + } } ], "responses" : { @@ -2028,10 +2072,13 @@ "description" : "Returns a balance platform.", "x-addedInVersion" : "1", "operationId" : "get-balancePlatforms-id", - "x-groupName" : "Platform", "x-sortIndex" : 1, "x-methodName" : "getBalancePlatform", "security" : [ + { + "clientKey" : [ + ] + }, { "BasicAuth" : [ ] @@ -2155,10 +2202,13 @@ "description" : "Returns a paginated list of all the account holders that belong to the balance platform. To fetch multiple pages, use the query parameters. \n\nFor example, to limit the page to 5 account holders and to skip the first 20, use `/balancePlatforms/{id}/accountHolders?limit=5&offset=20`.", "x-addedInVersion" : "1", "operationId" : "get-balancePlatforms-id-accountHolders", - "x-groupName" : "Platform", "x-sortIndex" : 2, "x-methodName" : "getAllAccountHoldersUnderBalancePlatform", "security" : [ + { + "clientKey" : [ + ] + }, { "BasicAuth" : [ ] @@ -2293,19 +2343,22 @@ } } }, - "/grantAccounts/{id}" : { + "/cardorders" : { "get" : { "tags" : [ - "Grant accounts" + "Card orders" ], - "summary" : "Get a grant account", - "description" : "Returns the details of the [grant account](https://docs.adyen.com/marketplaces-and-platforms/capital#grant-account).", + "summary" : "Get a list of card orders", + "description" : "Returns a paginated list of card orders.", "x-addedInVersion" : "1", - "operationId" : "get-grantAccounts-id", - "x-groupName" : "Grant accounts", + "operationId" : "get-cardorders", "x-sortIndex" : 1, - "x-methodName" : "getGrantAccount", + "x-methodName" : "listCardOrders", "security" : [ + { + "clientKey" : [ + ] + }, { "BasicAuth" : [ ] @@ -2317,40 +2370,126 @@ ], "parameters" : [ { - "description" : "The unique identifier of the grant account.", + "description" : "The unique identifier of the card order. ", "name" : "id", - "in" : "path", - "required" : true, + "in" : "query", + "required" : false, + "schema" : { + "type" : "string" + } + }, + { + "description" : "The unique identifier of the card manufacturer profile.", + "name" : "cardManufacturingProfileId", + "in" : "query", + "required" : false, + "schema" : { + "type" : "string" + } + }, + { + "description" : "The status of the card order.", + "name" : "status", + "in" : "query", + "required" : false, + "schema" : { + "type" : "string" + } + }, + { + "description" : "The unique code of the card manufacturer profile.\n\nPossible values: **mcmaestro**, **mc**, **visa**, **mcdebit**. ", + "name" : "txVariantCode", + "in" : "query", + "required" : false, + "schema" : { + "type" : "string" + } + }, + { + "description" : "Only include card orders that have been created on or after this point in time. The value must be in ISO 8601 format. For example, **2021-05-30T15:07:40Z**.", + "name" : "createdSince", + "in" : "query", + "required" : false, + "schema" : { + "format" : "date-time", + "type" : "string" + } + }, + { + "description" : "Only include card orders that have been created on or before this point in time. The value must be in ISO 8601 format. For example, **2021-05-30T15:07:40Z**.", + "name" : "createdUntil", + "in" : "query", + "required" : false, + "schema" : { + "format" : "date-time", + "type" : "string" + } + }, + { + "description" : "Only include card orders that have been locked on or after this point in time. The value must be in ISO 8601 format. For example, **2021-05-30T15:07:40Z**.", + "name" : "lockedSince", + "in" : "query", + "required" : false, + "schema" : { + "format" : "date-time", + "type" : "string" + } + }, + { + "description" : "Only include card orders that have been locked on or before this point in time. The value must be in ISO 8601 format. For example, **2021-05-30T15:07:40Z**.", + "name" : "lockedUntil", + "in" : "query", + "required" : false, + "schema" : { + "format" : "date-time", + "type" : "string" + } + }, + { + "description" : "The service center at which the card is issued. The value is case-sensitive. ", + "name" : "serviceCenter", + "in" : "query", + "required" : false, "schema" : { "type" : "string" } + }, + { + "description" : "Specifies the position of an element in a list of card orders. The response includes a list of card orders that starts at the specified offset.\n\n**Default:** 0, which means that the response contains all the elements in the list of card orders.", + "name" : "offset", + "in" : "query", + "required" : false, + "schema" : { + "format" : "int32", + "type" : "integer" + } + }, + { + "description" : "The number of card orders returned per page. **Default:** 10.", + "name" : "limit", + "in" : "query", + "required" : false, + "schema" : { + "format" : "int32", + "type" : "integer" + } } ], "responses" : { "200" : { - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/CapitalGrantAccount" - } - } - }, - "description" : "OK - the request has succeeded." - }, - "400" : { "content" : { "application/json" : { "examples" : { - "generic" : { - "$ref" : "#/components/examples/generic-400" + "success" : { + "$ref" : "#/components/examples/get-cardorders-success-200" } }, "schema" : { - "$ref" : "#/components/schemas/RestServiceError" + "$ref" : "#/components/schemas/PaginatedGetCardOrderResponse" } } }, - "description" : "Bad Request - a problem reading or understanding the request." + "description" : "OK - the request has succeeded." }, "401" : { "content" : { @@ -2415,19 +2554,22 @@ } } }, - "/grantOffers" : { + "/cardorders/{id}/items" : { "get" : { "tags" : [ - "Grant offers" + "Card orders" ], - "summary" : "Get all available grant offers", - "description" : "Returns a list of all [grant offers](https://docs.adyen.com/marketplaces-and-platforms/capital#grant-offers) available for `accountHolderId` specified as a query parameter.", - "x-addedInVersion" : "2", - "operationId" : "get-grantOffers", - "x-groupName" : "Grant offers", - "x-sortIndex" : 1, - "x-methodName" : "getAllAvailableGrantOffers", + "summary" : "Get card order items", + "description" : "Returns the item list of a specific card order.", + "x-addedInVersion" : "1", + "operationId" : "get-cardorders-id-items", + "x-sortIndex" : 2, + "x-methodName" : "getCardOrderItems", "security" : [ + { + "clientKey" : [ + ] + }, { "BasicAuth" : [ ] @@ -2439,40 +2581,50 @@ ], "parameters" : [ { - "description" : "The unique identifier of the grant account.", - "name" : "accountHolderId", - "in" : "query", + "description" : "The unique identifier of the card order.", + "name" : "id", + "in" : "path", "required" : true, "schema" : { "type" : "string" } + }, + { + "description" : "Specifies the position of an element in a list of card orders. The response includes a list of card order items that starts at the specified offset.\n\n**Default:** 0, which means that the response contains all the elements in the list of card order items.", + "name" : "offset", + "in" : "query", + "required" : false, + "schema" : { + "format" : "int32", + "type" : "integer" + } + }, + { + "description" : "The number of card order items returned per page. **Default:** 10.", + "name" : "limit", + "in" : "query", + "required" : false, + "schema" : { + "format" : "int32", + "type" : "integer" + } } ], "responses" : { "200" : { - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/GrantOffers" - } - } - }, - "description" : "OK - the request has succeeded." - }, - "400" : { "content" : { "application/json" : { "examples" : { - "generic" : { - "$ref" : "#/components/examples/generic-400" + "success" : { + "$ref" : "#/components/examples/get-cardorders-id-items-success-200" } }, "schema" : { - "$ref" : "#/components/schemas/RestServiceError" + "$ref" : "#/components/schemas/PaginatedGetCardOrderItemResponse" } } }, - "description" : "Bad Request - a problem reading or understanding the request." + "description" : "OK - the request has succeeded." }, "401" : { "content" : { @@ -2537,19 +2689,22 @@ } } }, - "/grantOffers/{grantOfferId}" : { + "/grantAccounts/{id}" : { "get" : { "tags" : [ - "Grant offers" + "Grant accounts" ], - "summary" : "Get a grant offer", - "description" : "Returns the details of a single grant offer.", - "x-addedInVersion" : "2", - "operationId" : "get-grantOffers-grantOfferId", - "x-groupName" : "Grant offers", + "summary" : "Get a grant account", + "description" : "Returns the details of the [grant account](https://docs.adyen.com/marketplaces-and-platforms/capital#grant-account).", + "x-addedInVersion" : "1", + "operationId" : "get-grantAccounts-id", "x-sortIndex" : 1, - "x-methodName" : "getGrantOffer", + "x-methodName" : "getGrantAccount", "security" : [ + { + "clientKey" : [ + ] + }, { "BasicAuth" : [ ] @@ -2561,8 +2716,8 @@ ], "parameters" : [ { - "description" : "The unique identifier of the grant offer.", - "name" : "grantOfferId", + "description" : "The unique identifier of the grant account.", + "name" : "id", "in" : "path", "required" : true, "schema" : { @@ -2575,7 +2730,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/GrantOffer" + "$ref" : "#/components/schemas/CapitalGrantAccount" } } }, @@ -2659,19 +2814,22 @@ } } }, - "/networkTokens/{networkTokenId}" : { + "/grantOffers" : { "get" : { "tags" : [ - "Network tokens" + "Grant offers" ], - "summary" : "Get a network token", - "description" : "Returns the details of a network token.", - "x-addedInVersion" : "1", - "operationId" : "get-networkTokens-networkTokenId", - "x-groupName" : "Network tokens", + "summary" : "Get all available grant offers", + "description" : "Returns a list of all [grant offers](https://docs.adyen.com/marketplaces-and-platforms/capital#grant-offers) available for `accountHolderId` specified as a query parameter.", + "x-addedInVersion" : "2", + "operationId" : "get-grantOffers", "x-sortIndex" : 1, - "x-methodName" : "getNetworkToken", + "x-methodName" : "getAllAvailableGrantOffers", "security" : [ + { + "clientKey" : [ + ] + }, { "BasicAuth" : [ ] @@ -2681,6 +2839,373 @@ ] } ], + "parameters" : [ + { + "description" : "The unique identifier of the grant account.", + "name" : "accountHolderId", + "in" : "query", + "required" : true, + "schema" : { + "type" : "string" + } + } + ], + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/GrantOffers" + } + } + }, + "description" : "OK - the request has succeeded." + }, + "400" : { + "content" : { + "application/json" : { + "examples" : { + "generic" : { + "$ref" : "#/components/examples/generic-400" + } + }, + "schema" : { + "$ref" : "#/components/schemas/RestServiceError" + } + } + }, + "description" : "Bad Request - a problem reading or understanding the request." + }, + "401" : { + "content" : { + "application/json" : { + "examples" : { + "generic" : { + "$ref" : "#/components/examples/generic-401" + } + }, + "schema" : { + "$ref" : "#/components/schemas/RestServiceError" + } + } + }, + "description" : "Unauthorized - authentication required." + }, + "403" : { + "content" : { + "application/json" : { + "examples" : { + "generic" : { + "$ref" : "#/components/examples/generic-403" + } + }, + "schema" : { + "$ref" : "#/components/schemas/RestServiceError" + } + } + }, + "description" : "Forbidden - insufficient permissions to process the request." + }, + "422" : { + "content" : { + "application/json" : { + "examples" : { + "generic" : { + "$ref" : "#/components/examples/generic-422" + } + }, + "schema" : { + "$ref" : "#/components/schemas/RestServiceError" + } + } + }, + "description" : "Unprocessable Entity - a request validation error." + }, + "500" : { + "content" : { + "application/json" : { + "examples" : { + "generic" : { + "$ref" : "#/components/examples/generic-500" + } + }, + "schema" : { + "$ref" : "#/components/schemas/RestServiceError" + } + } + }, + "description" : "Internal Server Error - the server could not process the request." + } + } + } + }, + "/grantOffers/{grantOfferId}" : { + "get" : { + "tags" : [ + "Grant offers" + ], + "summary" : "Get a grant offer", + "description" : "Returns the details of a single grant offer.", + "x-addedInVersion" : "2", + "operationId" : "get-grantOffers-grantOfferId", + "x-sortIndex" : 1, + "x-methodName" : "getGrantOffer", + "security" : [ + { + "clientKey" : [ + ] + }, + { + "BasicAuth" : [ + ] + }, + { + "ApiKeyAuth" : [ + ] + } + ], + "parameters" : [ + { + "description" : "The unique identifier of the grant offer.", + "name" : "grantOfferId", + "in" : "path", + "required" : true, + "schema" : { + "type" : "string" + } + } + ], + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/GrantOffer" + } + } + }, + "description" : "OK - the request has succeeded." + }, + "400" : { + "content" : { + "application/json" : { + "examples" : { + "generic" : { + "$ref" : "#/components/examples/generic-400" + } + }, + "schema" : { + "$ref" : "#/components/schemas/RestServiceError" + } + } + }, + "description" : "Bad Request - a problem reading or understanding the request." + }, + "401" : { + "content" : { + "application/json" : { + "examples" : { + "generic" : { + "$ref" : "#/components/examples/generic-401" + } + }, + "schema" : { + "$ref" : "#/components/schemas/RestServiceError" + } + } + }, + "description" : "Unauthorized - authentication required." + }, + "403" : { + "content" : { + "application/json" : { + "examples" : { + "generic" : { + "$ref" : "#/components/examples/generic-403" + } + }, + "schema" : { + "$ref" : "#/components/schemas/RestServiceError" + } + } + }, + "description" : "Forbidden - insufficient permissions to process the request." + }, + "422" : { + "content" : { + "application/json" : { + "examples" : { + "generic" : { + "$ref" : "#/components/examples/generic-422" + } + }, + "schema" : { + "$ref" : "#/components/schemas/RestServiceError" + } + } + }, + "description" : "Unprocessable Entity - a request validation error." + }, + "500" : { + "content" : { + "application/json" : { + "examples" : { + "generic" : { + "$ref" : "#/components/examples/generic-500" + } + }, + "schema" : { + "$ref" : "#/components/schemas/RestServiceError" + } + } + }, + "description" : "Internal Server Error - the server could not process the request." + } + } + } + }, + "/networkTokens/{networkTokenId}" : { + "get" : { + "tags" : [ + "Network tokens" + ], + "summary" : "Get a network token", + "description" : "Returns the details of a network token.", + "x-addedInVersion" : "1", + "operationId" : "get-networkTokens-networkTokenId", + "x-sortIndex" : 1, + "x-methodName" : "getNetworkToken", + "security" : [ + { + "clientKey" : [ + ] + }, + { + "BasicAuth" : [ + ] + }, + { + "ApiKeyAuth" : [ + ] + } + ], + "parameters" : [ + { + "description" : "The unique identifier of the network token.", + "name" : "networkTokenId", + "in" : "path", + "required" : true, + "schema" : { + "type" : "string" + } + } + ], + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/GetNetworkTokenResponse" + } + } + }, + "description" : "OK - the request has succeeded." + }, + "401" : { + "content" : { + "application/json" : { + "examples" : { + "generic" : { + "$ref" : "#/components/examples/generic-401" + } + }, + "schema" : { + "$ref" : "#/components/schemas/RestServiceError" + } + } + }, + "description" : "Unauthorized - authentication required." + }, + "403" : { + "content" : { + "application/json" : { + "examples" : { + "generic" : { + "$ref" : "#/components/examples/generic-403" + } + }, + "schema" : { + "$ref" : "#/components/schemas/RestServiceError" + } + } + }, + "description" : "Forbidden - insufficient permissions to process the request." + }, + "422" : { + "content" : { + "application/json" : { + "examples" : { + "generic" : { + "$ref" : "#/components/examples/generic-422" + } + }, + "schema" : { + "$ref" : "#/components/schemas/RestServiceError" + } + } + }, + "description" : "Unprocessable Entity - a request validation error." + }, + "500" : { + "content" : { + "application/json" : { + "examples" : { + "generic" : { + "$ref" : "#/components/examples/generic-500" + } + }, + "schema" : { + "$ref" : "#/components/schemas/RestServiceError" + } + } + }, + "description" : "Internal Server Error - the server could not process the request." + } + } + }, + "patch" : { + "tags" : [ + "Network tokens" + ], + "summary" : "Update a network token", + "description" : "Updates the status of the network token.", + "x-addedInVersion" : "1", + "operationId" : "patch-networkTokens-networkTokenId", + "x-sortIndex" : 2, + "x-methodName" : "updateNetworkToken", + "security" : [ + { + "clientKey" : [ + ] + }, + { + "BasicAuth" : [ + ] + }, + { + "ApiKeyAuth" : [ + ] + } + ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/UpdateNetworkTokenRequest" + } + } + } + }, "parameters" : [ { "description" : "The unique identifier of the network token.", @@ -2692,17 +3217,273 @@ } } ], + "responses" : { + "202" : { + "description" : "No Content - look at the actual response code for the status of the request. " + }, + "401" : { + "content" : { + "application/json" : { + "examples" : { + "generic" : { + "$ref" : "#/components/examples/generic-401" + } + }, + "schema" : { + "$ref" : "#/components/schemas/RestServiceError" + } + } + }, + "description" : "Unauthorized - authentication required." + }, + "403" : { + "content" : { + "application/json" : { + "examples" : { + "generic" : { + "$ref" : "#/components/examples/generic-403" + } + }, + "schema" : { + "$ref" : "#/components/schemas/RestServiceError" + } + } + }, + "description" : "Forbidden - insufficient permissions to process the request." + }, + "422" : { + "content" : { + "application/json" : { + "examples" : { + "generic" : { + "$ref" : "#/components/examples/generic-422" + } + }, + "schema" : { + "$ref" : "#/components/schemas/RestServiceError" + } + } + }, + "description" : "Unprocessable Entity - a request validation error." + }, + "500" : { + "content" : { + "application/json" : { + "examples" : { + "generic" : { + "$ref" : "#/components/examples/generic-500" + } + }, + "schema" : { + "$ref" : "#/components/schemas/RestServiceError" + } + } + }, + "description" : "Internal Server Error - the server could not process the request." + } + } + } + }, + "/paymentInstrumentGroups" : { + "post" : { + "tags" : [ + "Payment instrument groups" + ], + "summary" : "Create a payment instrument group", + "description" : "Creates a payment instrument group to associate and group payment instrument resources together. You can apply a transaction rule to a payment instrument group.", + "x-addedInVersion" : "1", + "operationId" : "post-paymentInstrumentGroups", + "x-sortIndex" : 1, + "x-methodName" : "createPaymentInstrumentGroup", + "security" : [ + { + "clientKey" : [ + ] + }, + { + "BasicAuth" : [ + ] + }, + { + "ApiKeyAuth" : [ + ] + } + ], + "requestBody" : { + "content" : { + "application/json" : { + "examples" : { + "createPaymentInstrumentGroups" : { + "$ref" : "#/components/examples/post-paymentInstrumentGroups-createPaymentInstrumentGroups" + } + }, + "schema" : { + "$ref" : "#/components/schemas/PaymentInstrumentGroupInfo" + } + } + } + }, + "responses" : { + "200" : { + "content" : { + "application/json" : { + "examples" : { + "createPaymentInstrumentGroups" : { + "$ref" : "#/components/examples/post-paymentInstrumentGroups-createPaymentInstrumentGroups-200" + } + }, + "schema" : { + "$ref" : "#/components/schemas/PaymentInstrumentGroup" + } + } + }, + "description" : "OK - the request has succeeded." + }, + "400" : { + "content" : { + "application/json" : { + "examples" : { + "generic" : { + "$ref" : "#/components/examples/generic-400" + } + }, + "schema" : { + "$ref" : "#/components/schemas/RestServiceError" + } + } + }, + "description" : "Bad Request - a problem reading or understanding the request." + }, + "401" : { + "content" : { + "application/json" : { + "examples" : { + "generic" : { + "$ref" : "#/components/examples/generic-401" + } + }, + "schema" : { + "$ref" : "#/components/schemas/RestServiceError" + } + } + }, + "description" : "Unauthorized - authentication required." + }, + "403" : { + "content" : { + "application/json" : { + "examples" : { + "generic" : { + "$ref" : "#/components/examples/generic-403" + } + }, + "schema" : { + "$ref" : "#/components/schemas/RestServiceError" + } + } + }, + "description" : "Forbidden - insufficient permissions to process the request." + }, + "422" : { + "content" : { + "application/json" : { + "examples" : { + "generic" : { + "$ref" : "#/components/examples/generic-422" + } + }, + "schema" : { + "$ref" : "#/components/schemas/RestServiceError" + } + } + }, + "description" : "Unprocessable Entity - a request validation error." + }, + "500" : { + "content" : { + "application/json" : { + "examples" : { + "generic" : { + "$ref" : "#/components/examples/generic-500" + } + }, + "schema" : { + "$ref" : "#/components/schemas/RestServiceError" + } + } + }, + "description" : "Internal Server Error - the server could not process the request." + } + } + } + }, + "/paymentInstrumentGroups/{id}" : { + "get" : { + "tags" : [ + "Payment instrument groups" + ], + "summary" : "Get a payment instrument group", + "description" : "Returns the details of a payment instrument group.", + "x-addedInVersion" : "1", + "operationId" : "get-paymentInstrumentGroups-id", + "x-sortIndex" : 2, + "x-methodName" : "getPaymentInstrumentGroup", + "security" : [ + { + "clientKey" : [ + ] + }, + { + "BasicAuth" : [ + ] + }, + { + "ApiKeyAuth" : [ + ] + } + ], + "parameters" : [ + { + "description" : "The unique identifier of the payment instrument group.", + "name" : "id", + "in" : "path", + "required" : true, + "schema" : { + "type" : "string" + } + } + ], "responses" : { "200" : { "content" : { "application/json" : { + "examples" : { + "success" : { + "$ref" : "#/components/examples/get-paymentInstrumentGroups-id-success-200" + } + }, "schema" : { - "$ref" : "#/components/schemas/GetNetworkTokenResponse" + "$ref" : "#/components/schemas/PaymentInstrumentGroup" } } }, "description" : "OK - the request has succeeded." }, + "400" : { + "content" : { + "application/json" : { + "examples" : { + "generic" : { + "$ref" : "#/components/examples/generic-400" + } + }, + "schema" : { + "$ref" : "#/components/schemas/RestServiceError" + } + } + }, + "description" : "Bad Request - a problem reading or understanding the request." + }, "401" : { "content" : { "application/json" : { @@ -2764,19 +3545,24 @@ "description" : "Internal Server Error - the server could not process the request." } } - }, - "patch" : { + } + }, + "/paymentInstrumentGroups/{id}/transactionRules" : { + "get" : { "tags" : [ - "Network tokens" + "Payment instrument groups" ], - "summary" : "Update a network token", - "description" : "Updates the status of the network token.", + "summary" : "Get all transaction rules for a payment instrument group", + "description" : "Returns a list of all the transaction rules associated with a payment instrument group.", "x-addedInVersion" : "1", - "operationId" : "patch-networkTokens-networkTokenId", - "x-groupName" : "Network tokens", - "x-sortIndex" : 2, - "x-methodName" : "updateNetworkToken", + "operationId" : "get-paymentInstrumentGroups-id-transactionRules", + "x-sortIndex" : 3, + "x-methodName" : "getAllTransactionRulesForPaymentInstrumentGroup", "security" : [ + { + "clientKey" : [ + ] + }, { "BasicAuth" : [ ] @@ -2786,19 +3572,10 @@ ] } ], - "requestBody" : { - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/UpdateNetworkTokenRequest" - } - } - } - }, "parameters" : [ { - "description" : "The unique identifier of the network token.", - "name" : "networkTokenId", + "description" : "The unique identifier of the payment instrument group.", + "name" : "id", "in" : "path", "required" : true, "schema" : { @@ -2807,8 +3584,35 @@ } ], "responses" : { - "202" : { - "description" : "No Content - look at the actual response code for the status of the request. " + "200" : { + "content" : { + "application/json" : { + "examples" : { + "success" : { + "$ref" : "#/components/examples/get-paymentInstrumentGroups-id-transactionRules-success-200" + } + }, + "schema" : { + "$ref" : "#/components/schemas/TransactionRulesResponse" + } + } + }, + "description" : "OK - the request has succeeded." + }, + "400" : { + "content" : { + "application/json" : { + "examples" : { + "generic" : { + "$ref" : "#/components/examples/generic-400" + } + }, + "schema" : { + "$ref" : "#/components/schemas/RestServiceError" + } + } + }, + "description" : "Bad Request - a problem reading or understanding the request." }, "401" : { "content" : { @@ -2873,19 +3677,22 @@ } } }, - "/paymentInstrumentGroups" : { + "/paymentInstruments" : { "post" : { "tags" : [ - "Payment instrument groups" + "Payment instruments" ], - "summary" : "Create a payment instrument group", - "description" : "Creates a payment instrument group to associate and group payment instrument resources together. You can apply a transaction rule to a payment instrument group.", + "summary" : "Create a payment instrument", + "description" : "Creates a payment instrument to issue a physical card, a virtual card, or a business account to your user.\n\n For more information, refer to [Issue cards](https://docs.adyen.com/issuing/create-cards) or [Issue business accounts](https://docs.adyen.com/marketplaces-and-platforms/business-accounts).", "x-addedInVersion" : "1", - "operationId" : "post-paymentInstrumentGroups", - "x-groupName" : "Payment instrument groups", - "x-sortIndex" : 1, - "x-methodName" : "createPaymentInstrumentGroup", + "operationId" : "post-paymentInstruments", + "x-sortIndex" : 11, + "x-methodName" : "createPaymentInstrument", "security" : [ + { + "clientKey" : [ + ] + }, { "BasicAuth" : [ ] @@ -2899,12 +3706,21 @@ "content" : { "application/json" : { "examples" : { - "createPaymentInstrumentGroups" : { - "$ref" : "#/components/examples/post-paymentInstrumentGroups-createPaymentInstrumentGroups" + "createBusinessAccountNL" : { + "$ref" : "#/components/examples/post-paymentInstruments-createBusinessAccountNL" + }, + "createBusinessAccountUS" : { + "$ref" : "#/components/examples/post-paymentInstruments-createBusinessAccountUS" + }, + "createPhysicalCard" : { + "$ref" : "#/components/examples/post-paymentInstruments-createPhysicalCard" + }, + "createVirtualCard" : { + "$ref" : "#/components/examples/post-paymentInstruments-createVirtualCard" } }, "schema" : { - "$ref" : "#/components/schemas/PaymentInstrumentGroupInfo" + "$ref" : "#/components/schemas/PaymentInstrumentInfo" } } } @@ -2914,12 +3730,21 @@ "content" : { "application/json" : { "examples" : { - "createPaymentInstrumentGroups" : { - "$ref" : "#/components/examples/post-paymentInstrumentGroups-createPaymentInstrumentGroups-200" + "createBusinessAccountNL" : { + "$ref" : "#/components/examples/post-paymentInstruments-createBusinessAccountNL-200" + }, + "createBusinessAccountUS" : { + "$ref" : "#/components/examples/post-paymentInstruments-createBusinessAccountUS-200" + }, + "createPhysicalCard" : { + "$ref" : "#/components/examples/post-paymentInstruments-createPhysicalCard-200" + }, + "createVirtualCard" : { + "$ref" : "#/components/examples/post-paymentInstruments-createVirtualCard-200" } }, "schema" : { - "$ref" : "#/components/schemas/PaymentInstrumentGroup" + "$ref" : "#/components/schemas/PaymentInstrument" } } }, @@ -3003,19 +3828,22 @@ } } }, - "/paymentInstrumentGroups/{id}" : { + "/paymentInstruments/{id}" : { "get" : { "tags" : [ - "Payment instrument groups" + "Payment instruments" ], - "summary" : "Get a payment instrument group", - "description" : "Returns the details of a payment instrument group.", + "summary" : "Get a payment instrument", + "description" : "Returns the details of a payment instrument.", "x-addedInVersion" : "1", - "operationId" : "get-paymentInstrumentGroups-id", - "x-groupName" : "Payment instrument groups", - "x-sortIndex" : 2, - "x-methodName" : "getPaymentInstrumentGroup", + "operationId" : "get-paymentInstruments-id", + "x-sortIndex" : 13, + "x-methodName" : "getPaymentInstrument", "security" : [ + { + "clientKey" : [ + ] + }, { "BasicAuth" : [ ] @@ -3027,7 +3855,7 @@ ], "parameters" : [ { - "description" : "The unique identifier of the payment instrument group.", + "description" : "The unique identifier of the payment instrument.", "name" : "id", "in" : "path", "required" : true, @@ -3042,11 +3870,11 @@ "application/json" : { "examples" : { "success" : { - "$ref" : "#/components/examples/get-paymentInstrumentGroups-id-success-200" + "$ref" : "#/components/examples/get-paymentInstruments-id-success-200" } }, "schema" : { - "$ref" : "#/components/schemas/PaymentInstrumentGroup" + "$ref" : "#/components/schemas/PaymentInstrument" } } }, @@ -3128,21 +3956,22 @@ "description" : "Internal Server Error - the server could not process the request." } } - } - }, - "/paymentInstrumentGroups/{id}/transactionRules" : { - "get" : { + }, + "patch" : { "tags" : [ - "Payment instrument groups" + "Payment instruments" ], - "summary" : "Get all transaction rules for a payment instrument group", - "description" : "Returns a list of all the transaction rules associated with a payment instrument group.", + "summary" : "Update a payment instrument", + "description" : "Updates a payment instrument. Once a payment instrument is already active, you can only update its status. However, for cards created with **inactive** status, you can still update the balance account associated with the card.", "x-addedInVersion" : "1", - "operationId" : "get-paymentInstrumentGroups-id-transactionRules", - "x-groupName" : "Payment instrument groups", - "x-sortIndex" : 3, - "x-methodName" : "getAllTransactionRulesForPaymentInstrumentGroup", + "operationId" : "patch-paymentInstruments-id", + "x-sortIndex" : 12, + "x-methodName" : "updatePaymentInstrument", "security" : [ + { + "clientKey" : [ + ] + }, { "BasicAuth" : [ ] @@ -3152,9 +3981,26 @@ ] } ], + "requestBody" : { + "content" : { + "application/json" : { + "examples" : { + "updatePaymentInstrumentBalanceAccount" : { + "$ref" : "#/components/examples/patch-paymentInstruments-id-updatePaymentInstrumentBalanceAccount" + }, + "updatePaymentInstrumentStatus" : { + "$ref" : "#/components/examples/patch-paymentInstruments-id-updatePaymentInstrumentStatus" + } + }, + "schema" : { + "$ref" : "#/components/schemas/PaymentInstrumentUpdateRequest" + } + } + } + }, "parameters" : [ { - "description" : "The unique identifier of the payment instrument group.", + "description" : "The unique identifier of the payment instrument.", "name" : "id", "in" : "path", "required" : true, @@ -3168,12 +4014,15 @@ "content" : { "application/json" : { "examples" : { - "success" : { - "$ref" : "#/components/examples/get-paymentInstrumentGroups-id-transactionRules-success-200" + "updatePaymentInstrumentBalanceAccount" : { + "$ref" : "#/components/examples/patch-paymentInstruments-id-updatePaymentInstrumentBalanceAccount-200" + }, + "updatePaymentInstrumentStatus" : { + "$ref" : "#/components/examples/patch-paymentInstruments-id-updatePaymentInstrumentStatus-200" } }, "schema" : { - "$ref" : "#/components/schemas/TransactionRulesResponse" + "$ref" : "#/components/schemas/UpdatePaymentInstrument" } } }, @@ -3257,19 +4106,22 @@ } } }, - "/paymentInstruments" : { - "post" : { + "/paymentInstruments/{id}/networkTokens" : { + "get" : { "tags" : [ "Payment instruments" ], - "summary" : "Create a payment instrument", - "description" : "Creates a payment instrument to issue a physical card, a virtual card, or a business account to your user.\n\n For more information, refer to [Issue cards](https://docs.adyen.com/issuing/create-cards) or [Issue business accounts](https://docs.adyen.com/marketplaces-and-platforms/business-accounts).", + "summary" : "List network tokens", + "description" : "List the network tokens connected to a payment instrument.", "x-addedInVersion" : "1", - "operationId" : "post-paymentInstruments", - "x-groupName" : "Payment instruments", - "x-sortIndex" : 11, - "x-methodName" : "createPaymentInstrument", + "operationId" : "get-paymentInstruments-id-networkTokens", + "x-sortIndex" : 15, + "x-methodName" : "listNetworkTokens", "security" : [ + { + "clientKey" : [ + ] + }, { "BasicAuth" : [ ] @@ -3279,49 +4131,23 @@ ] } ], - "requestBody" : { - "content" : { - "application/json" : { - "examples" : { - "createBusinessAccountNL" : { - "$ref" : "#/components/examples/post-paymentInstruments-createBusinessAccountNL" - }, - "createBusinessAccountUS" : { - "$ref" : "#/components/examples/post-paymentInstruments-createBusinessAccountUS" - }, - "createPhysicalCard" : { - "$ref" : "#/components/examples/post-paymentInstruments-createPhysicalCard" - }, - "createVirtualCard" : { - "$ref" : "#/components/examples/post-paymentInstruments-createVirtualCard" - } - }, - "schema" : { - "$ref" : "#/components/schemas/PaymentInstrumentInfo" - } + "parameters" : [ + { + "description" : "The unique identifier of the payment instrument.", + "name" : "id", + "in" : "path", + "required" : true, + "schema" : { + "type" : "string" } } - }, + ], "responses" : { "200" : { "content" : { "application/json" : { - "examples" : { - "createBusinessAccountNL" : { - "$ref" : "#/components/examples/post-paymentInstruments-createBusinessAccountNL-200" - }, - "createBusinessAccountUS" : { - "$ref" : "#/components/examples/post-paymentInstruments-createBusinessAccountUS-200" - }, - "createPhysicalCard" : { - "$ref" : "#/components/examples/post-paymentInstruments-createPhysicalCard-200" - }, - "createVirtualCard" : { - "$ref" : "#/components/examples/post-paymentInstruments-createVirtualCard-200" - } - }, "schema" : { - "$ref" : "#/components/schemas/PaymentInstrument" + "$ref" : "#/components/schemas/ListNetworkTokensResponse" } } }, @@ -3405,19 +4231,22 @@ } } }, - "/paymentInstruments/{id}" : { + "/paymentInstruments/{id}/reveal" : { "get" : { "tags" : [ "Payment instruments" ], - "summary" : "Get a payment instrument", - "description" : "Returns the details of a payment instrument.", + "summary" : "Get the PAN of a payment instrument", + "description" : "Returns the primary account number (PAN) of a payment instrument.\n\nTo make this request, your API credential must have the following [role](https://docs.adyen.com/issuing/manage-access/api-credentials-web-service#api-permissions):\n\n* Balance Platform BCL PCI role", "x-addedInVersion" : "1", - "operationId" : "get-paymentInstruments-id", - "x-groupName" : "Payment instruments", - "x-sortIndex" : 13, - "x-methodName" : "getPaymentInstrument", + "operationId" : "get-paymentInstruments-id-reveal", + "x-sortIndex" : 14, + "x-methodName" : "getPanOfPaymentInstrument", "security" : [ + { + "clientKey" : [ + ] + }, { "BasicAuth" : [ ] @@ -3444,11 +4273,11 @@ "application/json" : { "examples" : { "success" : { - "$ref" : "#/components/examples/get-paymentInstruments-id-success-200" + "$ref" : "#/components/examples/get-paymentInstruments-id-reveal-success-200" } }, "schema" : { - "$ref" : "#/components/schemas/PaymentInstrument" + "$ref" : "#/components/schemas/PaymentInstrumentRevealInfo" } } }, @@ -3530,19 +4359,24 @@ "description" : "Internal Server Error - the server could not process the request." } } - }, - "patch" : { + } + }, + "/paymentInstruments/{id}/transactionRules" : { + "get" : { "tags" : [ "Payment instruments" ], - "summary" : "Update a payment instrument", - "description" : "Updates a payment instrument. Once a payment instrument is already active, you can only update its status. However, for cards created with **inactive** status, you can still update the balance account associated with the card.", + "summary" : "Get all transaction rules for a payment instrument", + "description" : "Returns a list of transaction rules associated with a payment instrument.", "x-addedInVersion" : "1", - "operationId" : "patch-paymentInstruments-id", - "x-groupName" : "Payment instruments", - "x-sortIndex" : 12, - "x-methodName" : "updatePaymentInstrument", + "operationId" : "get-paymentInstruments-id-transactionRules", + "x-sortIndex" : 14, + "x-methodName" : "getAllTransactionRulesForPaymentInstrument", "security" : [ + { + "clientKey" : [ + ] + }, { "BasicAuth" : [ ] @@ -3552,23 +4386,6 @@ ] } ], - "requestBody" : { - "content" : { - "application/json" : { - "examples" : { - "updatePaymentInstrumentBalanceAccount" : { - "$ref" : "#/components/examples/patch-paymentInstruments-id-updatePaymentInstrumentBalanceAccount" - }, - "updatePaymentInstrumentStatus" : { - "$ref" : "#/components/examples/patch-paymentInstruments-id-updatePaymentInstrumentStatus" - } - }, - "schema" : { - "$ref" : "#/components/schemas/PaymentInstrumentUpdateRequest" - } - } - } - }, "parameters" : [ { "description" : "The unique identifier of the payment instrument.", @@ -3585,15 +4402,12 @@ "content" : { "application/json" : { "examples" : { - "updatePaymentInstrumentBalanceAccount" : { - "$ref" : "#/components/examples/patch-paymentInstruments-id-updatePaymentInstrumentBalanceAccount-200" - }, - "updatePaymentInstrumentStatus" : { - "$ref" : "#/components/examples/patch-paymentInstruments-id-updatePaymentInstrumentStatus-200" + "success" : { + "$ref" : "#/components/examples/get-paymentInstruments-id-transactionRules-success-200" } }, "schema" : { - "$ref" : "#/components/schemas/UpdatePaymentInstrument" + "$ref" : "#/components/schemas/TransactionRulesResponse" } } }, @@ -3677,19 +4491,22 @@ } } }, - "/paymentInstruments/{id}/networkTokens" : { - "get" : { + "/pins/change" : { + "post" : { "tags" : [ - "Payment instruments" + "PIN functionality" ], - "summary" : "List network tokens", - "description" : "List the network tokens connected to a payment instrument.", + "summary" : "Change Pin", + "description" : "Change Pin", "x-addedInVersion" : "1", - "operationId" : "get-paymentInstruments-id-networkTokens", - "x-groupName" : "Payment instruments", - "x-sortIndex" : 15, - "x-methodName" : "listNetworkTokens", + "operationId" : "post-pins-change", + "x-sortIndex" : 2, + "x-methodName" : "changePin", "security" : [ + { + "clientKey" : [ + ] + }, { "BasicAuth" : [ ] @@ -3699,43 +4516,26 @@ ] } ], - "parameters" : [ - { - "description" : "The unique identifier of the payment instrument.", - "name" : "id", - "in" : "path", - "required" : true, - "schema" : { - "type" : "string" + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/PinChangeRequest" + } } } - ], + }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/ListNetworkTokensResponse" + "$ref" : "#/components/schemas/PinChangeResponse" } } }, "description" : "OK - the request has succeeded." }, - "400" : { - "content" : { - "application/json" : { - "examples" : { - "generic" : { - "$ref" : "#/components/examples/generic-400" - } - }, - "schema" : { - "$ref" : "#/components/schemas/RestServiceError" - } - } - }, - "description" : "Bad Request - a problem reading or understanding the request." - }, "401" : { "content" : { "application/json" : { @@ -3799,19 +4599,22 @@ } } }, - "/paymentInstruments/{id}/reveal" : { + "/pins/publicKey" : { "get" : { "tags" : [ - "Payment instruments" + "PIN functionality" ], - "summary" : "Get the PAN of a payment instrument", - "description" : "Returns the primary account number (PAN) of a payment instrument.\n\nTo make this request, your API credential must have the following [role](https://docs.adyen.com/issuing/manage-access/api-credentials-web-service#api-permissions):\n\n* Balance Platform BCL PCI role", + "summary" : "Get RSA publicKey", + "description" : "Get RSA publicKey", "x-addedInVersion" : "1", - "operationId" : "get-paymentInstruments-id-reveal", - "x-groupName" : "Payment instruments", - "x-sortIndex" : 14, - "x-methodName" : "getPanOfPaymentInstrument", + "operationId" : "get-pins-publicKey", + "x-sortIndex" : 1, + "x-methodName" : "getRsaPublickey", "security" : [ + { + "clientKey" : [ + ] + }, { "BasicAuth" : [ ] @@ -3823,10 +4626,19 @@ ], "parameters" : [ { - "description" : "The unique identifier of the payment instrument.", - "name" : "id", - "in" : "path", - "required" : true, + "description" : "Purpose of publicKey.", + "name" : "purpose", + "in" : "query", + "required" : false, + "schema" : { + "type" : "string" + } + }, + { + "description" : "Format of publicKey.", + "name" : "format", + "in" : "query", + "required" : false, "schema" : { "type" : "string" } @@ -3836,33 +4648,13 @@ "200" : { "content" : { "application/json" : { - "examples" : { - "success" : { - "$ref" : "#/components/examples/get-paymentInstruments-id-reveal-success-200" - } - }, "schema" : { - "$ref" : "#/components/schemas/PaymentInstrumentRevealInfo" + "$ref" : "#/components/schemas/PublicKeyResponse" } } }, "description" : "OK - the request has succeeded." }, - "400" : { - "content" : { - "application/json" : { - "examples" : { - "generic" : { - "$ref" : "#/components/examples/generic-400" - } - }, - "schema" : { - "$ref" : "#/components/schemas/RestServiceError" - } - } - }, - "description" : "Bad Request - a problem reading or understanding the request." - }, "401" : { "content" : { "application/json" : { @@ -3926,19 +4718,22 @@ } } }, - "/paymentInstruments/{id}/transactionRules" : { - "get" : { + "/pins/reveal" : { + "post" : { "tags" : [ - "Payment instruments" + "PIN functionality" ], - "summary" : "Get all transaction rules for a payment instrument", - "description" : "Returns a list of transaction rules associated with a payment instrument.", + "summary" : "Reveal Pin", + "description" : "Reveal Pin", "x-addedInVersion" : "1", - "operationId" : "get-paymentInstruments-id-transactionRules", - "x-groupName" : "Payment instruments", - "x-sortIndex" : 14, - "x-methodName" : "getAllTransactionRulesForPaymentInstrument", + "operationId" : "post-pins-reveal", + "x-sortIndex" : 2, + "x-methodName" : "revealPin", "security" : [ + { + "clientKey" : [ + ] + }, { "BasicAuth" : [ ] @@ -3948,48 +4743,26 @@ ] } ], - "parameters" : [ - { - "description" : "The unique identifier of the payment instrument.", - "name" : "id", - "in" : "path", - "required" : true, - "schema" : { - "type" : "string" + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/RevealPinRequest" + } } } - ], + }, "responses" : { "200" : { "content" : { "application/json" : { - "examples" : { - "success" : { - "$ref" : "#/components/examples/get-paymentInstruments-id-transactionRules-success-200" - } - }, "schema" : { - "$ref" : "#/components/schemas/TransactionRulesResponse" + "$ref" : "#/components/schemas/RevealPinResponse" } } }, "description" : "OK - the request has succeeded." }, - "400" : { - "content" : { - "application/json" : { - "examples" : { - "generic" : { - "$ref" : "#/components/examples/generic-400" - } - }, - "schema" : { - "$ref" : "#/components/schemas/RestServiceError" - } - } - }, - "description" : "Bad Request - a problem reading or understanding the request." - }, "401" : { "content" : { "application/json" : { @@ -4062,10 +4835,13 @@ "description" : "Creates a [transaction rule](https://docs.adyen.com/issuing/transaction-rules). When your user makes a transaction with their Adyen-issued card, the transaction is allowed or declined based on the conditions and outcome defined in the transaction rule. You can apply the transaction rule to several cards, such as all the cards in your platform, or to a specific card. For use cases, see [examples](https://docs.adyen.com/issuing/transaction-rules/examples).", "x-addedInVersion" : "1", "operationId" : "post-transactionRules", - "x-groupName" : "Transaction rules", "x-sortIndex" : 1, "x-methodName" : "createTransactionRule", "security" : [ + { + "clientKey" : [ + ] + }, { "BasicAuth" : [ ] @@ -4210,10 +4986,13 @@ "description" : "Deletes a transaction rule.", "x-addedInVersion" : "1", "operationId" : "delete-transactionRules-transactionRuleId", - "x-groupName" : "Transaction rules", "x-sortIndex" : 5, "x-methodName" : "deleteTransactionRule", "security" : [ + { + "clientKey" : [ + ] + }, { "BasicAuth" : [ ] @@ -4335,10 +5114,13 @@ "description" : "Returns the details of a transaction rule.", "x-addedInVersion" : "1", "operationId" : "get-transactionRules-transactionRuleId", - "x-groupName" : "Transaction rules", "x-sortIndex" : 2, "x-methodName" : "getTransactionRule", "security" : [ + { + "clientKey" : [ + ] + }, { "BasicAuth" : [ ] @@ -4460,10 +5242,13 @@ "description" : "Updates a transaction rule. \n\n* To update only the status of a transaction rule, send only the `status` parameter. All other parameters not provided in the request are left unchanged.\n\n* When updating any other parameter, you need to send all existing resource parameters. If you omit a parameter in the request, that parameter is removed from the resource.", "x-addedInVersion" : "1", "operationId" : "patch-transactionRules-transactionRuleId", - "x-groupName" : "Transaction rules", "x-sortIndex" : 3, "x-methodName" : "updateTransactionRule", "security" : [ + { + "clientKey" : [ + ] + }, { "BasicAuth" : [ ] @@ -4601,10 +5386,13 @@ "description" : "Returns available transfer routes based on a combination of transfer `country`, `currency`, `counterparty`, and `priorities`. Use this endpoint to find optimal transfer priorities and associated requirements before you [make a transfer](https://docs.adyen.com/api-explorer/transfers/latest/post/transfers).", "x-addedInVersion" : "1", "operationId" : "post-transferRoutes-calculate", - "x-groupName" : "Transfer routes", "x-sortIndex" : 1, "x-methodName" : "calculateTransferRoutes", "security" : [ + { + "clientKey" : [ + ] + }, { "BasicAuth" : [ ] @@ -4716,10 +5504,13 @@ "description" : "Validates bank account identification details. You can use this endpoint to validate bank account details before you [make a transfer](https://docs.adyen.com/api-explorer/transfers/latest/post/transfers) or [create a transfer instrument](https://docs.adyen.com/api-explorer/legalentity/latest/post/transferInstruments).", "x-addedInVersion" : "1", "operationId" : "post-validateBankAccountIdentification", - "x-groupName" : "Bank account validation", "x-sortIndex" : 1, "x-methodName" : "validateBankAccountIdentification", "security" : [ + { + "clientKey" : [ + ] + }, { "BasicAuth" : [ ] @@ -4994,6 +5785,7 @@ "items" : { "$ref" : "#/components/schemas/AccountSupportingEntityCapability" }, + "readOnly" : true, "type" : "array" }, "verificationStatus" : { @@ -5873,6 +6665,20 @@ ], "type" : "object" }, + "BankAccountModel" : { + "properties" : { + "formFactor" : { + "description" : "Form factor of the bank account - **virtual** or **physical** (default)", + "enum" : [ + "physical", + "unknown", + "virtual" + ], + "type" : "string" + } + }, + "type" : "object" + }, "BankIdentification" : { "properties" : { "country" : { @@ -6389,6 +7195,117 @@ ], "type" : "object" }, + "CardOrder" : { + "properties" : { + "beginDate" : { + "description" : "The date when the card order is created.", + "format" : "date-time", + "type" : "string" + }, + "cardManufacturingProfileId" : { + "description" : "The unique identifier of the card manufacturer profile.", + "type" : "string" + }, + "closedDate" : { + "description" : "The date when the card order processing ends.", + "format" : "date-time", + "type" : "string" + }, + "endDate" : { + "description" : "The date when you manually closed the card order.\n\nCard orders are automatically closed by the end of the day it was created. If you manually closed it beforehand, the closing date is shown as the `endDate`.", + "format" : "date-time", + "type" : "string" + }, + "id" : { + "description" : "The unique identifier of the card order.", + "type" : "string" + }, + "lockDate" : { + "description" : "The date when the card order processing begins.", + "format" : "date-time", + "type" : "string" + }, + "serviceCenter" : { + "description" : "The service center.", + "type" : "string" + }, + "status" : { + "description" : "The status of the card order.\n\nPossible values: **Open**, **Closed**.", + "enum" : [ + "closed", + "open" + ], + "type" : "string" + } + }, + "type" : "object" + }, + "CardOrderItem" : { + "properties" : { + "balancePlatform" : { + "description" : "The unique identifier of the balance platform.", + "type" : "string" + }, + "card" : { + "description" : "The status of the card delivery.\n\nPossible values: **created**, **rejected**, **processing**, **produced**, **shipped**, **delivered**, **notApplicable**, **unknown**. ", + "$ref" : "#/components/schemas/CardOrderItemDeliveryStatus" + }, + "cardOrderItemId" : { + "description" : "The unique identifier of the card order item.", + "type" : "string" + }, + "creationDate" : { + "description" : "The date and time when the event was triggered, in ISO 8601 extended format. For example, **2020-12-18T10:15:30+01:00**.", + "format" : "date-time", + "type" : "string" + }, + "id" : { + "description" : "The ID of the resource.", + "readOnly" : true, + "type" : "string" + }, + "paymentInstrumentId" : { + "description" : "The unique identifier of the payment instrument related to the card order item.", + "type" : "string" + }, + "pin" : { + "description" : "Contains information about the status of the PIN delivery.", + "$ref" : "#/components/schemas/CardOrderItemDeliveryStatus" + }, + "shippingMethod" : { + "description" : "The shipping method used to deliver the card or the PIN.", + "type" : "string" + } + }, + "type" : "object" + }, + "CardOrderItemDeliveryStatus" : { + "properties" : { + "errorMessage" : { + "description" : "An error message.", + "type" : "string" + }, + "status" : { + "description" : "The status of the PIN delivery.", + "enum" : [ + "created", + "delivered", + "notApplicable", + "processing", + "produced", + "rejected", + "shipped", + "unknown" + ], + "type" : "string" + }, + "trackingNumber" : { + "description" : "The tracking number of the PIN delivery.", + "type" : "string" + } + }, + "type" : "object" + }, "ContactDetails" : { "properties" : { "address" : { @@ -6903,7 +7820,8 @@ }, "expiresAt" : { "description" : "The end date of the grant offer validity period.", - "$ref" : "#/components/schemas/LocalDateTime" + "format" : "date-time", + "type" : "string" }, "fee" : { "description" : "Details of the fee configuration.", @@ -6919,7 +7837,8 @@ }, "startsAt" : { "description" : "The starting date of the grant offer validity period.", - "$ref" : "#/components/schemas/LocalDateTime" + "format" : "date-time", + "type" : "string" } }, "required" : [ @@ -7072,9 +7991,6 @@ }, "type" : "object" }, - "LocalDateTime" : { - "type" : "object" - }, "MatchingTransactionsRestriction" : { "properties" : { "operation" : { @@ -7378,6 +8294,55 @@ ], "type" : "object" }, + "PaginatedGetCardOrderItemResponse" : { + "properties" : { + "data" : { + "description" : "List of card order items in the card order batch.", + "items" : { + "$ref" : "#/components/schemas/CardOrderItem" + }, + "type" : "array" + }, + "hasNext" : { + "description" : "Indicates whether there are more items on the next page.", + "type" : "boolean" + }, + "hasPrevious" : { + "description" : "Indicates whether there are more items on the previous page.", + "type" : "boolean" + } + }, + "required" : [ + "data", + "hasPrevious", + "hasNext" + ], + "type" : "object" + }, + "PaginatedGetCardOrderResponse" : { + "properties" : { + "cardOrders" : { + "description" : "Contains objects with information about card orders.", + "items" : { + "$ref" : "#/components/schemas/CardOrder" + }, + "type" : "array" + }, + "hasNext" : { + "description" : "Indicates whether there are more items on the next page.", + "type" : "boolean" + }, + "hasPrevious" : { + "description" : "Indicates whether there are more items on the previous page.", + "type" : "boolean" + } + }, + "required" : [ + "hasPrevious", + "hasNext" + ], + "type" : "object" + }, "PaginatedPaymentInstrumentsResponse" : { "properties" : { "hasNext" : { @@ -7567,6 +8532,10 @@ "description" : "The unique identifier of the [balance account](https://docs.adyen.com/api-explorer/#/balanceplatform/v1/post/balanceAccounts__resParam_id) associated with the payment instrument.", "type" : "string" }, + "bankAccount" : { + "description" : "Contains the business account details.", + "$ref" : "#/components/schemas/BankAccountModel" + }, "card" : { "description" : "Contains information about the card. Required when you create a payment instrument of `type` **card**.", "$ref" : "#/components/schemas/CardInfo" @@ -7777,6 +8746,50 @@ }, "type" : "object" }, + "PinChangeRequest" : { + "properties" : { + "encryptedKey" : { + "description" : "Symmetric session key encrypted under the public key.", + "type" : "string" + }, + "encryptedPinBlock" : { + "description" : "The encrypted PIN block", + "type" : "string" + }, + "paymentInstrumentId" : { + "description" : "The unique identifier of the payment instrument.", + "type" : "string" + }, + "token" : { + "description" : "The token which is used to construct the pinblock.", + "type" : "string" + } + }, + "required" : [ + "paymentInstrumentId", + "encryptedKey", + "token", + "encryptedPinBlock" + ], + "type" : "object" + }, + "PinChangeResponse" : { + "properties" : { + "status" : { + "description" : "The pin change status.", + "enum" : [ + "completed", + "pending", + "unavailable" + ], + "type" : "string" + } + }, + "required" : [ + "status" + ], + "type" : "object" + }, "PlatformPaymentConfiguration" : { "properties" : { "salesDayClosingTime" : { @@ -7821,6 +8834,23 @@ ], "type" : "object" }, + "PublicKeyResponse" : { + "properties" : { + "publicKey" : { + "description" : "The public key to be used for encrypting the symmetric session key.", + "type" : "string" + }, + "publicKeyExpiryDate" : { + "description" : "The expiry date of the public key.", + "type" : "string" + } + }, + "required" : [ + "publicKey", + "publicKeyExpiryDate" + ], + "type" : "object" + }, "RemediatingAction" : { "properties" : { "code" : { @@ -7925,6 +8955,40 @@ ], "type" : "object" }, + "RevealPinRequest" : { + "properties" : { + "encryptedKey" : { + "description" : "Symmetric session key encrypted under the public key.", + "type" : "string" + }, + "paymentInstrumentId" : { + "description" : "The unique identifier of the payment instrument.", + "type" : "string" + } + }, + "required" : [ + "paymentInstrumentId", + "encryptedKey" + ], + "type" : "object" + }, + "RevealPinResponse" : { + "properties" : { + "encryptedPinBlock" : { + "description" : "The encrypted PIN block.", + "type" : "string" + }, + "token" : { + "description" : "The encrypted PIN block extraction token.", + "type" : "string" + } + }, + "required" : [ + "encryptedPinBlock", + "token" + ], + "type" : "object" + }, "SELocalAccountIdentification" : { "additionalProperties" : false, "properties" : { @@ -9276,6 +10340,11 @@ "BasicAuth" : { "scheme" : "basic", "type" : "http" + }, + "clientKey" : { + "in" : "query", + "name" : "clientKey", + "type" : "apiKey" } }, "examples" : { @@ -9641,6 +10710,46 @@ "status" : "Active" } }, + "get-cardorders-id-items-success-200" : { + "summary" : "Item list of a specific card order retrieved", + "description" : "Example response for retrieving the item list of a specific card order", + "value" : { + "data" : [ + { + "card" : { + "status" : "shipped" + }, + "cardOrderItemId" : "UNIQUE_CARD_ORDER_ITEM_ID", + "paymentInstrumentId" : "UNIQUE_PAYMENT_INSTRUMENT_ID", + "pin" : { + "status" : "produced" + }, + "shippingMethod" : "Cardholder Post Basic National" + } + ], + "hasNext" : false, + "hasPrevious" : false + } + }, + "get-cardorders-success-200" : { + "summary" : "List of card orders retrieved", + "description" : "Example response for retrieving a paginated list of card orders", + "value" : { + "cardOrders" : [ + { + "beginDate" : "2022-12-05T00:00:00+01:00", + "cardManufacturingProfileId" : "UNIQUE_CARD_MANUFACTURER_PROFILE_ID", + "endDate" : "2022-12-06T00:00:00+01:00", + "id" : "UNIQUE_CARD_ORDER_ID", + "lockDate" : "2023-04-14T16:43:02+02:00", + "serviceCenter" : "IDEMIA Sittard", + "status" : "closed" + } + ], + "hasNext" : true, + "hasPrevious" : false + } + }, "get-paymentInstrumentGroups-id-success-200" : { "summary" : "Payment instrument group retrieved", "description" : "Example response when retrieving a payment instrument group", diff --git a/yaml/BalancePlatformConfigurationNotification-v1.yaml b/yaml/BalancePlatformConfigurationNotification-v1.yaml index 10eb4f3d..c52c29c3 100644 --- a/yaml/BalancePlatformConfigurationNotification-v1.yaml +++ b/yaml/BalancePlatformConfigurationNotification-v1.yaml @@ -14,11 +14,6 @@ info: contact: name: Adyen Developer Experience team url: https://github.com/Adyen/adyen-openapi -x-groups: -- Account holder -- Balance account -- Payment instrument -- Card order tags: - name: Account holder - name: Balance account @@ -34,7 +29,6 @@ webhooks: description: Adyen sends this webhook when you successfully [create an account holder](https://docs.adyen.com/api-explorer/balanceplatform/latest/post/accountHolders). operationId: post-balancePlatform.accountHolder.created - x-groupName: Account holder x-sortIndex: 1 x-methodName: accountHolderCreated security: @@ -45,6 +39,8 @@ webhooks: examples: balancePlatform-accountHolder-created: $ref: '#/components/examples/post-balancePlatform.accountHolder.created-balancePlatform-accountHolder-created' + balancePlatform-accountHolder-created-lem-v3: + $ref: '#/components/examples/post-balancePlatform.accountHolder.created-balancePlatform-accountHolder-created-lem-v3' schema: $ref: '#/components/schemas/AccountHolderNotificationRequest' responses: @@ -54,6 +50,8 @@ webhooks: examples: balancePlatform-accountHolder-created: $ref: '#/components/examples/WebhookAck' + balancePlatform-accountHolder-created-lem-v3: + $ref: '#/components/examples/WebhookAck' schema: $ref: '#/components/schemas/BalancePlatformNotificationResponse' description: OK - the request has succeeded. @@ -65,7 +63,6 @@ webhooks: description: Adyen sends this webhook when you successfully [update an account holder](https://docs.adyen.com/api-explorer/balanceplatform/latest/patch/accountHolders/_id_). operationId: post-balancePlatform.accountHolder.updated - x-groupName: Account holder x-sortIndex: 2 x-methodName: accountHolderUpdated security: @@ -76,6 +73,8 @@ webhooks: examples: balancePlatform-accountHolder-updated: $ref: '#/components/examples/post-balancePlatform.accountHolder.updated-balancePlatform-accountHolder-updated' + balancePlatform-accountHolder-updated-lem-v3: + $ref: '#/components/examples/post-balancePlatform.accountHolder.updated-balancePlatform-accountHolder-updated-lem-v3' schema: $ref: '#/components/schemas/AccountHolderNotificationRequest' responses: @@ -85,6 +84,8 @@ webhooks: examples: balancePlatform-accountHolder-updated: $ref: '#/components/examples/WebhookAck' + balancePlatform-accountHolder-updated-lem-v3: + $ref: '#/components/examples/WebhookAck' schema: $ref: '#/components/schemas/BalancePlatformNotificationResponse' description: OK - the request has succeeded. @@ -96,7 +97,6 @@ webhooks: description: Adyen sends this webhook when you successfully [create a balance account](https://docs.adyen.com/api-explorer/balanceplatform/latest/post/balanceAccounts). operationId: post-balancePlatform.balanceAccount.created - x-groupName: Balance account x-sortIndex: 1 x-methodName: balanceAccountCreated security: @@ -127,7 +127,6 @@ webhooks: description: Adyen sends this webhook when you successfully [update a balance account](https://docs.adyen.com/api-explorer/balanceplatform/latest/patch/balanceAccounts/_id_). operationId: post-balancePlatform.balanceAccount.updated - x-groupName: Balance account x-sortIndex: 2 x-methodName: balanceAccountUpdated security: @@ -157,7 +156,6 @@ webhooks: summary: Sweep created description: Adyen sends this webhook when you successfully [create a sweep](https://docs.adyen.com/api-explorer/balanceplatform/latest/post/balanceAccounts/_balanceAccountId_/sweeps). operationId: post-balancePlatform.balanceAccountSweep.created - x-groupName: Balance account x-sortIndex: 3 x-methodName: sweepCreated security: @@ -187,7 +185,6 @@ webhooks: summary: Sweep deleted description: Adyen sends this webhook when you successfully [delete a sweep](https://docs.adyen.com/api-explorer/balanceplatform/latest/delete/balanceAccounts/_balanceAccountId_/sweeps/_sweepId_). operationId: post-balancePlatform.balanceAccountSweep.deleted - x-groupName: Balance account x-sortIndex: 5 x-methodName: sweepDeleted security: @@ -217,7 +214,6 @@ webhooks: summary: Sweep updated description: Adyen sends this webhook when you successfully [update a sweep](https://docs.adyen.com/api-explorer/balanceplatform/latest/patch/balanceAccounts/_balanceAccountId_/sweeps/_sweepId_). operationId: post-balancePlatform.balanceAccountSweep.updated - x-groupName: Balance account x-sortIndex: 4 x-methodName: sweepUpdated security: @@ -249,7 +245,6 @@ webhooks: card order after you create a [payment instrument](https://docs.adyen.com/api-explorer/balanceplatform/latest/post/paymentInstruments) of `type` **card** and `formFactor` **physical**. operationId: post-balancePlatform.cardorder.created - x-groupName: Card order x-sortIndex: 1 x-methodName: cardOrderCreated security: @@ -274,7 +269,6 @@ webhooks: description: Adyen sends this webhook when there is an update in card order status. operationId: post-balancePlatform.cardorder.updated - x-groupName: Card order x-sortIndex: 2 x-methodName: cardOrderUpdated security: @@ -302,7 +296,6 @@ webhooks: \ You can only get the card number in the response of the POST [/paymentInstruments](https://docs.adyen.com/api-explorer/balanceplatform/latest/post/paymentInstruments#responses-200-card-number)\ \ request." operationId: post-balancePlatform.paymentInstrument.created - x-groupName: Payment instrument x-sortIndex: 1 x-methodName: paymentInstrumentCreated security: @@ -333,7 +326,6 @@ webhooks: description: 'Adyen sends this webhook when you successfully [update a payment instrument](https://docs.adyen.com/api-explorer/balanceplatform/latest/patch/paymentInstruments/_id_). ' operationId: post-balancePlatform.paymentInstrument.updated - x-groupName: Payment instrument x-sortIndex: 2 x-methodName: paymentInstrumentUpdated security: @@ -1154,7 +1146,11 @@ components: description: The unique identifier of the balance platform. type: string card: - description: Card delivery status. + description: 'The status of the card delivery. + + + Possible values: **created**, **rejected**, **processing**, **produced**, + **shipped**, **delivered**, **notApplicable**, **unknown**. ' $ref: '#/components/schemas/CardOrderItemDeliveryStatus' cardOrderItemId: description: The unique identifier of the card order item. @@ -1172,19 +1168,19 @@ components: the card order item. type: string pin: - description: PIN delivery status. + description: Contains information about the status of the PIN delivery. $ref: '#/components/schemas/CardOrderItemDeliveryStatus' shippingMethod: - description: Shipping method used to deliver the card or the PIN. + description: The shipping method used to deliver the card or the PIN. type: string type: object CardOrderItemDeliveryStatus: properties: errorMessage: - description: Error message. + description: An error message. type: string status: - description: Status of the delivery. + description: The status of the PIN delivery. enum: - created - delivered @@ -1196,7 +1192,7 @@ components: - unknown type: string trackingNumber: - description: Tracking number of the delivery. + description: The tracking number of the PIN delivery. type: string type: object CardOrderNotificationRequest: @@ -2095,6 +2091,98 @@ components: status: Active environment: test type: balancePlatform.accountHolder.created + post-balancePlatform.accountHolder.created-balancePlatform-accountHolder-created-lem-v3: + summary: Account holder created with LEM API v3 + description: Example webhook when an account holder was created with LEM API + v3 + value: + data: + balancePlatform: YOUR_BALANCE_PLATFORM + accountHolder: + legalEntityId: LE43319330319C8AYX89L2V59 + reference: YOUR_REFERENCE-2412C + capabilities: + sendToTransferInstrument: + enabled: true + requested: true + allowed: false + problems: + - entity: + id: LE43319330319C8AYX89L2V59 + type: LegalEntity + verificationErrors: + - code: '2_902' + message: Terms Of Service forms are not accepted. + remediatingActions: + - code: '2_902' + message: Accept TOS + type: invalidInput + - entity: + id: SE576BH223222F5GJVKHH6BDT + type: BankAccount + verificationErrors: + - code: '2_8037' + message: '''bankStatement'' was missing.' + remediatingActions: + - code: '1_703' + message: Upload a bank statement + type: dataMissing + - entity: + id: SE3222Z223222Q5J4D58K3DWP + type: BankAccount + verificationErrors: + - code: '2_8037' + message: '''bankStatement'' was missing.' + remediatingActions: + - code: '1_703' + message: Upload a bank statement + type: dataMissing + - entity: + id: LE43319330319C8AYX89L2V59 + type: LegalEntity + verificationErrors: + - code: '2_8189' + message: '''UBO through control'' was missing.' + remediatingActions: + - code: '2_151' + message: Add 'organization.entityAssociations' of type 'uboThroughControl' + to legal entity + type: dataMissing + - code: '1_50' + message: Organization details couldn't be verified + subErrors: + - code: '1_5016' + message: The tax ID number couldn't be verified + remediatingActions: + - code: '1_500' + message: Update organization details + - code: '1_501' + message: Upload a registration document + type: invalidInput + type: invalidInput + - code: '2_8067' + message: '''Signatory'' was missing.' + remediatingActions: + - code: '2_124' + message: Add 'organization.entityAssociations' of type 'signatory' + to legal entity + type: dataMissing + transferInstruments: + - enabled: true + requested: true + allowed: false + id: SE576BH223222F5GJVKHH6BDT + verificationStatus: pending + - enabled: true + requested: true + allowed: false + id: SE3222Z223222Q5J4D58K3DWP + verificationStatus: pending + verificationStatus: pending + id: AH32272223222B5CZW6QZ2V34 + status: Active + environment: live + type: balancePlatform.accountHolder.created post-balancePlatform.accountHolder.updated-balancePlatform-accountHolder-updated: summary: Account holder updated description: Example webhook when an account holder was updated @@ -2137,6 +2225,98 @@ components: status: Active environment: test type: balancePlatform.accountHolder.updated + post-balancePlatform.accountHolder.updated-balancePlatform-accountHolder-updated-lem-v3: + summary: Account holder updated with LEM API v3 + description: Example webhook when an account holder was updated with LEM API + v3 + value: + data: + balancePlatform: YOUR_BALANCE_PLATFORM + accountHolder: + legalEntityId: LE43319330319C8AYX89L2V59 + reference: YOUR_REFERENCE-2412C + capabilities: + sendToTransferInstrument: + enabled: true + requested: true + allowed: false + problems: + - entity: + id: LE43319330319C8AYX89L2V59 + type: LegalEntity + verificationErrors: + - code: '2_902' + message: Terms Of Service forms are not accepted. + remediatingActions: + - code: '2_902' + message: Accept TOS + type: invalidInput + - entity: + id: SE576BH223222F5GJVKHH6BDT + type: BankAccount + verificationErrors: + - code: '2_8037' + message: '''bankStatement'' was missing.' + remediatingActions: + - code: '1_703' + message: Upload a bank statement + type: dataMissing + - entity: + id: SE3222Z223222Q5J4D58K3DWP + type: BankAccount + verificationErrors: + - code: '2_8037' + message: '''bankStatement'' was missing.' + remediatingActions: + - code: '1_703' + message: Upload a bank statement + type: dataMissing + - entity: + id: LE43319330319C8AYX89L2V59 + type: LegalEntity + verificationErrors: + - code: '2_8189' + message: '''UBO through control'' was missing.' + remediatingActions: + - code: '2_151' + message: Add 'organization.entityAssociations' of type 'uboThroughControl' + to legal entity + type: dataMissing + - code: '1_50' + message: Organization details couldn't be verified + subErrors: + - code: '1_5016' + message: The tax ID number couldn't be verified + remediatingActions: + - code: '1_500' + message: Update organization details + - code: '1_501' + message: Upload a registration document + type: invalidInput + type: invalidInput + - code: '2_8067' + message: '''Signatory'' was missing.' + remediatingActions: + - code: '2_124' + message: Add 'organization.entityAssociations' of type 'signatory' + to legal entity + type: dataMissing + transferInstruments: + - enabled: true + requested: true + allowed: false + id: SE576BH223222F5GJVKHH6BDT + verificationStatus: pending + - enabled: true + requested: true + allowed: false + id: SE3222Z223222Q5J4D58K3DWP + verificationStatus: pending + verificationStatus: pending + id: AH32272223222B5CZW6QZ2V34 + status: Active + environment: live + type: balancePlatform.accountHolder.updated post-balancePlatform.balanceAccount.created-balancePlatform-balanceAccount-created: summary: Balance account created description: Example webhook when a balance account was created diff --git a/yaml/BalancePlatformReportNotification-v1.yaml b/yaml/BalancePlatformReportNotification-v1.yaml index 13d65f05..28cecf76 100644 --- a/yaml/BalancePlatformReportNotification-v1.yaml +++ b/yaml/BalancePlatformReportNotification-v1.yaml @@ -13,8 +13,6 @@ info: contact: name: Adyen Developer Experience team url: https://github.com/Adyen/adyen-openapi -x-groups: -- General tags: - name: General webhooks: @@ -31,7 +29,6 @@ webhooks: Before you download reports, ask your Adyen contact for your report credentials. You must use your the credentials to authenticate your GET request.' operationId: post-balancePlatform.report.created - x-groupName: General x-sortIndex: 0 x-methodName: reportGenerated security: diff --git a/yaml/BalancePlatformService-v2.yaml b/yaml/BalancePlatformService-v2.yaml index 883125bf..8edec7f8 100644 --- a/yaml/BalancePlatformService-v2.yaml +++ b/yaml/BalancePlatformService-v2.yaml @@ -24,18 +24,6 @@ info: contact: name: Adyen Developer Experience team url: https://github.com/Adyen/adyen-openapi -x-groups: -- Platform -- Account holders -- Balance accounts -- Payment instruments -- Payment instrument groups -- Transaction rules -- Bank account validation -- Network tokens -- Grant accounts -- Grant offers -- Transfer routes tags: - name: Platform - name: Account holders @@ -47,6 +35,8 @@ tags: - name: Network tokens - name: Grant accounts - name: Grant offers +- name: PIN functionality +- name: Card orders - name: Transfer routes paths: /accountHolders: @@ -60,10 +50,10 @@ paths: ' x-addedInVersion: '1' operationId: post-accountHolders - x-groupName: Account holders x-sortIndex: 1 x-methodName: createAccountHolder security: + - clientKey: [] - BasicAuth: [] - ApiKeyAuth: [] requestBody: @@ -137,10 +127,10 @@ paths: description: Returns an account holder. x-addedInVersion: '1' operationId: get-accountHolders-id - x-groupName: Account holders x-sortIndex: 3 x-methodName: getAccountHolder security: + - clientKey: [] - BasicAuth: [] - ApiKeyAuth: [] parameters: @@ -213,10 +203,10 @@ paths: if a parameter is not provided in the request, it is left unchanged. x-addedInVersion: '1' operationId: patch-accountHolders-id - x-groupName: Account holders x-sortIndex: 2 x-methodName: updateAccountHolder security: + - clientKey: [] - BasicAuth: [] - ApiKeyAuth: [] requestBody: @@ -304,10 +294,10 @@ paths: \ 10, use `/accountHolders/{id}/balanceAccounts?limit=5&offset=10`." x-addedInVersion: '1' operationId: get-accountHolders-id-balanceAccounts - x-groupName: Account holders x-sortIndex: 4 x-methodName: getAllBalanceAccountsOfAccountHolder security: + - clientKey: [] - BasicAuth: [] - ApiKeyAuth: [] parameters: @@ -396,10 +386,10 @@ paths: more information, refer to [Providing tax forms](https://docs.adyen.com/marketplaces-and-platforms/us-tax-forms/). x-addedInVersion: '2' operationId: get-accountHolders-id-taxForms - x-groupName: Account holders x-sortIndex: 5 x-methodName: getTaxForm security: + - clientKey: [] - BasicAuth: [] - ApiKeyAuth: [] parameters: @@ -493,10 +483,10 @@ paths: account holder. x-addedInVersion: '1' operationId: post-balanceAccounts - x-groupName: Balance accounts x-sortIndex: 1 x-methodName: createBalanceAccount security: + - clientKey: [] - BasicAuth: [] - ApiKeyAuth: [] requestBody: @@ -574,10 +564,10 @@ paths: page to 5 sweeps and to skip the first 10, use `/balanceAccounts/{balanceAccountId}/sweeps?limit=5&offset=10`.' x-addedInVersion: '2' operationId: get-balanceAccounts-balanceAccountId-sweeps - x-groupName: Balance accounts x-sortIndex: 7 x-methodName: getAllSweepsForBalanceAccount security: + - clientKey: [] - BasicAuth: [] - ApiKeyAuth: [] parameters: @@ -669,10 +659,10 @@ paths: currency, and a source or a destination.' x-addedInVersion: '2' operationId: post-balanceAccounts-balanceAccountId-sweeps - x-groupName: Balance accounts x-sortIndex: 5 x-methodName: createSweep security: + - clientKey: [] - BasicAuth: [] - ApiKeyAuth: [] requestBody: @@ -761,10 +751,10 @@ paths: description: Deletes a sweep for a balance account. x-addedInVersion: '2' operationId: delete-balanceAccounts-balanceAccountId-sweeps-sweepId - x-groupName: Balance accounts x-sortIndex: 9 x-methodName: deleteSweep security: + - clientKey: [] - BasicAuth: [] - ApiKeyAuth: [] parameters: @@ -836,10 +826,10 @@ paths: description: Returns a sweep. x-addedInVersion: '2' operationId: get-balanceAccounts-balanceAccountId-sweeps-sweepId - x-groupName: Balance accounts x-sortIndex: 8 x-methodName: getSweep security: + - clientKey: [] - BasicAuth: [] - ApiKeyAuth: [] parameters: @@ -918,10 +908,10 @@ paths: request parameter is not provided, the parameter is left unchanged. x-addedInVersion: '2' operationId: patch-balanceAccounts-balanceAccountId-sweeps-sweepId - x-groupName: Balance accounts x-sortIndex: 6 x-methodName: updateSweep security: + - clientKey: [] - BasicAuth: [] - ApiKeyAuth: [] requestBody: @@ -1009,10 +999,10 @@ paths: and other currencies with a non-zero balance. x-addedInVersion: '1' operationId: get-balanceAccounts-id - x-groupName: Balance accounts x-sortIndex: 3 x-methodName: getBalanceAccount security: + - clientKey: [] - BasicAuth: [] - ApiKeyAuth: [] parameters: @@ -1084,10 +1074,10 @@ paths: description: Updates a balance account. x-addedInVersion: '1' operationId: patch-balanceAccounts-id - x-groupName: Balance accounts x-sortIndex: 2 x-methodName: updateBalanceAccount security: + - clientKey: [] - BasicAuth: [] - ApiKeyAuth: [] requestBody: @@ -1164,17 +1154,17 @@ paths: get: tags: - Balance accounts - summary: Get all payment instruments for a balance account + summary: Get payment instruments linked to a balance account description: "Returns a paginated list of the payment instruments associated\ \ with a balance account. \n\nTo fetch multiple pages, use the query parameters.For\ - \ example, to limit the page to 3 payment instruments and to skip the first\ - \ 6, use `/balanceAccounts/{id}/paymentInstruments?limit=3&offset=6`." + \ example, to limit the page to 3 payment instruments which are in active\ + \ status and to skip the first 6, use `/balanceAccounts/{id}/paymentInstruments?limit=3&offset=6&status=active`." x-addedInVersion: '1' operationId: get-balanceAccounts-id-paymentInstruments - x-groupName: Balance accounts x-sortIndex: 4 - x-methodName: getAllPaymentInstrumentsForBalanceAccount + x-methodName: getPaymentInstrumentsLinkedToBalanceAccount security: + - clientKey: [] - BasicAuth: [] - ApiKeyAuth: [] parameters: @@ -1199,6 +1189,13 @@ paths: schema: format: int32 type: integer + - description: The status of the payment instruments that you want to get. By + default, the response includes payment instruments with any status. + name: status + in: query + required: false + schema: + type: string responses: '200': content: @@ -1262,10 +1259,10 @@ paths: description: Returns a balance platform. x-addedInVersion: '1' operationId: get-balancePlatforms-id - x-groupName: Platform x-sortIndex: 1 x-methodName: getBalancePlatform security: + - clientKey: [] - BasicAuth: [] - ApiKeyAuth: [] parameters: @@ -1341,10 +1338,10 @@ paths: \ first 20, use `/balancePlatforms/{id}/accountHolders?limit=5&offset=20`." x-addedInVersion: '1' operationId: get-balancePlatforms-id-accountHolders - x-groupName: Platform x-sortIndex: 2 x-methodName: getAllAccountHoldersUnderBalancePlatform security: + - clientKey: [] - BasicAuth: [] - ApiKeyAuth: [] parameters: @@ -1424,6 +1421,241 @@ paths: schema: $ref: '#/components/schemas/RestServiceError' description: Internal Server Error - the server could not process the request. + /cardorders: + get: + tags: + - Card orders + summary: Get a list of card orders + description: Returns a paginated list of card orders. + x-addedInVersion: '1' + operationId: get-cardorders + x-sortIndex: 1 + x-methodName: listCardOrders + security: + - clientKey: [] + - BasicAuth: [] + - ApiKeyAuth: [] + parameters: + - description: 'The unique identifier of the card order. ' + name: id + in: query + required: false + schema: + type: string + - description: The unique identifier of the card manufacturer profile. + name: cardManufacturingProfileId + in: query + required: false + schema: + type: string + - description: The status of the card order. + name: status + in: query + required: false + schema: + type: string + - description: 'The unique code of the card manufacturer profile. + + + Possible values: **mcmaestro**, **mc**, **visa**, **mcdebit**. ' + name: txVariantCode + in: query + required: false + schema: + type: string + - description: Only include card orders that have been created on or after this + point in time. The value must be in ISO 8601 format. For example, **2021-05-30T15:07:40Z**. + name: createdSince + in: query + required: false + schema: + format: date-time + type: string + - description: Only include card orders that have been created on or before + this point in time. The value must be in ISO 8601 format. For example, **2021-05-30T15:07:40Z**. + name: createdUntil + in: query + required: false + schema: + format: date-time + type: string + - description: Only include card orders that have been locked on or after this + point in time. The value must be in ISO 8601 format. For example, **2021-05-30T15:07:40Z**. + name: lockedSince + in: query + required: false + schema: + format: date-time + type: string + - description: Only include card orders that have been locked on or before this + point in time. The value must be in ISO 8601 format. For example, **2021-05-30T15:07:40Z**. + name: lockedUntil + in: query + required: false + schema: + format: date-time + type: string + - description: 'The service center at which the card is issued. The value is + case-sensitive. ' + name: serviceCenter + in: query + required: false + schema: + type: string + - description: 'Specifies the position of an element in a list of card orders. + The response includes a list of card orders that starts at the specified + offset. + + + **Default:** 0, which means that the response contains all the elements + in the list of card orders.' + name: offset + in: query + required: false + schema: + format: int32 + type: integer + - description: The number of card orders returned per page. **Default:** 10. + name: limit + in: query + required: false + schema: + format: int32 + type: integer + responses: + '200': + content: + application/json: + examples: + success: + $ref: '#/components/examples/get-cardorders-success-200' + schema: + $ref: '#/components/schemas/PaginatedGetCardOrderResponse' + description: OK - the request has succeeded. + '401': + content: + application/json: + examples: + generic: + $ref: '#/components/examples/generic-401' + schema: + $ref: '#/components/schemas/RestServiceError' + description: Unauthorized - authentication required. + '403': + content: + application/json: + examples: + generic: + $ref: '#/components/examples/generic-403' + schema: + $ref: '#/components/schemas/RestServiceError' + description: Forbidden - insufficient permissions to process the request. + '422': + content: + application/json: + examples: + generic: + $ref: '#/components/examples/generic-422' + schema: + $ref: '#/components/schemas/RestServiceError' + description: Unprocessable Entity - a request validation error. + '500': + content: + application/json: + examples: + generic: + $ref: '#/components/examples/generic-500' + schema: + $ref: '#/components/schemas/RestServiceError' + description: Internal Server Error - the server could not process the request. + /cardorders/{id}/items: + get: + tags: + - Card orders + summary: Get card order items + description: Returns the item list of a specific card order. + x-addedInVersion: '1' + operationId: get-cardorders-id-items + x-sortIndex: 2 + x-methodName: getCardOrderItems + security: + - clientKey: [] + - BasicAuth: [] + - ApiKeyAuth: [] + parameters: + - description: The unique identifier of the card order. + name: id + in: path + required: true + schema: + type: string + - description: 'Specifies the position of an element in a list of card orders. + The response includes a list of card order items that starts at the specified + offset. + + + **Default:** 0, which means that the response contains all the elements + in the list of card order items.' + name: offset + in: query + required: false + schema: + format: int32 + type: integer + - description: The number of card order items returned per page. **Default:** + 10. + name: limit + in: query + required: false + schema: + format: int32 + type: integer + responses: + '200': + content: + application/json: + examples: + success: + $ref: '#/components/examples/get-cardorders-id-items-success-200' + schema: + $ref: '#/components/schemas/PaginatedGetCardOrderItemResponse' + description: OK - the request has succeeded. + '401': + content: + application/json: + examples: + generic: + $ref: '#/components/examples/generic-401' + schema: + $ref: '#/components/schemas/RestServiceError' + description: Unauthorized - authentication required. + '403': + content: + application/json: + examples: + generic: + $ref: '#/components/examples/generic-403' + schema: + $ref: '#/components/schemas/RestServiceError' + description: Forbidden - insufficient permissions to process the request. + '422': + content: + application/json: + examples: + generic: + $ref: '#/components/examples/generic-422' + schema: + $ref: '#/components/schemas/RestServiceError' + description: Unprocessable Entity - a request validation error. + '500': + content: + application/json: + examples: + generic: + $ref: '#/components/examples/generic-500' + schema: + $ref: '#/components/schemas/RestServiceError' + description: Internal Server Error - the server could not process the request. /grantAccounts/{id}: get: tags: @@ -1432,10 +1664,10 @@ paths: description: Returns the details of the [grant account](https://docs.adyen.com/marketplaces-and-platforms/capital#grant-account). x-addedInVersion: '1' operationId: get-grantAccounts-id - x-groupName: Grant accounts x-sortIndex: 1 x-methodName: getGrantAccount security: + - clientKey: [] - BasicAuth: [] - ApiKeyAuth: [] parameters: @@ -1506,10 +1738,10 @@ paths: available for `accountHolderId` specified as a query parameter. x-addedInVersion: '2' operationId: get-grantOffers - x-groupName: Grant offers x-sortIndex: 1 x-methodName: getAllAvailableGrantOffers security: + - clientKey: [] - BasicAuth: [] - ApiKeyAuth: [] parameters: @@ -1579,10 +1811,10 @@ paths: description: Returns the details of a single grant offer. x-addedInVersion: '2' operationId: get-grantOffers-grantOfferId - x-groupName: Grant offers x-sortIndex: 1 x-methodName: getGrantOffer security: + - clientKey: [] - BasicAuth: [] - ApiKeyAuth: [] parameters: @@ -1652,10 +1884,10 @@ paths: description: Returns the details of a network token. x-addedInVersion: '1' operationId: get-networkTokens-networkTokenId - x-groupName: Network tokens x-sortIndex: 1 x-methodName: getNetworkToken security: + - clientKey: [] - BasicAuth: [] - ApiKeyAuth: [] parameters: @@ -1715,10 +1947,10 @@ paths: description: Updates the status of the network token. x-addedInVersion: '1' operationId: patch-networkTokens-networkTokenId - x-groupName: Network tokens x-sortIndex: 2 x-methodName: updateNetworkToken security: + - clientKey: [] - BasicAuth: [] - ApiKeyAuth: [] requestBody: @@ -1783,10 +2015,10 @@ paths: instrument group. x-addedInVersion: '1' operationId: post-paymentInstrumentGroups - x-groupName: Payment instrument groups x-sortIndex: 1 x-methodName: createPaymentInstrumentGroup security: + - clientKey: [] - BasicAuth: [] - ApiKeyAuth: [] requestBody: @@ -1860,10 +2092,10 @@ paths: description: Returns the details of a payment instrument group. x-addedInVersion: '1' operationId: get-paymentInstrumentGroups-id - x-groupName: Payment instrument groups x-sortIndex: 2 x-methodName: getPaymentInstrumentGroup security: + - clientKey: [] - BasicAuth: [] - ApiKeyAuth: [] parameters: @@ -1937,10 +2169,10 @@ paths: instrument group. x-addedInVersion: '1' operationId: get-paymentInstrumentGroups-id-transactionRules - x-groupName: Payment instrument groups x-sortIndex: 3 x-methodName: getAllTransactionRulesForPaymentInstrumentGroup security: + - clientKey: [] - BasicAuth: [] - ApiKeyAuth: [] parameters: @@ -2016,10 +2248,10 @@ paths: \ business accounts](https://docs.adyen.com/marketplaces-and-platforms/business-accounts)." x-addedInVersion: '1' operationId: post-paymentInstruments - x-groupName: Payment instruments x-sortIndex: 11 x-methodName: createPaymentInstrument security: + - clientKey: [] - BasicAuth: [] - ApiKeyAuth: [] requestBody: @@ -2105,10 +2337,10 @@ paths: description: Returns the details of a payment instrument. x-addedInVersion: '1' operationId: get-paymentInstruments-id - x-groupName: Payment instruments x-sortIndex: 13 x-methodName: getPaymentInstrument security: + - clientKey: [] - BasicAuth: [] - ApiKeyAuth: [] parameters: @@ -2182,10 +2414,10 @@ paths: status, you can still update the balance account associated with the card. x-addedInVersion: '1' operationId: patch-paymentInstruments-id - x-groupName: Payment instruments x-sortIndex: 12 x-methodName: updatePaymentInstrument security: + - clientKey: [] - BasicAuth: [] - ApiKeyAuth: [] requestBody: @@ -2270,10 +2502,10 @@ paths: description: List the network tokens connected to a payment instrument. x-addedInVersion: '1' operationId: get-paymentInstruments-id-networkTokens - x-groupName: Payment instruments x-sortIndex: 15 x-methodName: listNetworkTokens security: + - clientKey: [] - BasicAuth: [] - ApiKeyAuth: [] parameters: @@ -2349,10 +2581,10 @@ paths: * Balance Platform BCL PCI role' x-addedInVersion: '1' operationId: get-paymentInstruments-id-reveal - x-groupName: Payment instruments x-sortIndex: 14 x-methodName: getPanOfPaymentInstrument security: + - clientKey: [] - BasicAuth: [] - ApiKeyAuth: [] parameters: @@ -2425,10 +2657,10 @@ paths: description: Returns a list of transaction rules associated with a payment instrument. x-addedInVersion: '1' operationId: get-paymentInstruments-id-transactionRules - x-groupName: Payment instruments x-sortIndex: 14 x-methodName: getAllTransactionRulesForPaymentInstrument security: + - clientKey: [] - BasicAuth: [] - ApiKeyAuth: [] parameters: @@ -2493,6 +2725,200 @@ paths: schema: $ref: '#/components/schemas/RestServiceError' description: Internal Server Error - the server could not process the request. + /pins/change: + post: + tags: + - PIN functionality + summary: Change Pin + description: Change Pin + x-addedInVersion: '1' + operationId: post-pins-change + x-sortIndex: 2 + x-methodName: changePin + security: + - clientKey: [] + - BasicAuth: [] + - ApiKeyAuth: [] + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/PinChangeRequest' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/PinChangeResponse' + description: OK - the request has succeeded. + '401': + content: + application/json: + examples: + generic: + $ref: '#/components/examples/generic-401' + schema: + $ref: '#/components/schemas/RestServiceError' + description: Unauthorized - authentication required. + '403': + content: + application/json: + examples: + generic: + $ref: '#/components/examples/generic-403' + schema: + $ref: '#/components/schemas/RestServiceError' + description: Forbidden - insufficient permissions to process the request. + '422': + content: + application/json: + examples: + generic: + $ref: '#/components/examples/generic-422' + schema: + $ref: '#/components/schemas/RestServiceError' + description: Unprocessable Entity - a request validation error. + '500': + content: + application/json: + examples: + generic: + $ref: '#/components/examples/generic-500' + schema: + $ref: '#/components/schemas/RestServiceError' + description: Internal Server Error - the server could not process the request. + /pins/publicKey: + get: + tags: + - PIN functionality + summary: Get RSA publicKey + description: Get RSA publicKey + x-addedInVersion: '1' + operationId: get-pins-publicKey + x-sortIndex: 1 + x-methodName: getRsaPublickey + security: + - clientKey: [] + - BasicAuth: [] + - ApiKeyAuth: [] + parameters: + - description: Purpose of publicKey. + name: purpose + in: query + required: false + schema: + type: string + - description: Format of publicKey. + name: format + in: query + required: false + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/PublicKeyResponse' + description: OK - the request has succeeded. + '401': + content: + application/json: + examples: + generic: + $ref: '#/components/examples/generic-401' + schema: + $ref: '#/components/schemas/RestServiceError' + description: Unauthorized - authentication required. + '403': + content: + application/json: + examples: + generic: + $ref: '#/components/examples/generic-403' + schema: + $ref: '#/components/schemas/RestServiceError' + description: Forbidden - insufficient permissions to process the request. + '422': + content: + application/json: + examples: + generic: + $ref: '#/components/examples/generic-422' + schema: + $ref: '#/components/schemas/RestServiceError' + description: Unprocessable Entity - a request validation error. + '500': + content: + application/json: + examples: + generic: + $ref: '#/components/examples/generic-500' + schema: + $ref: '#/components/schemas/RestServiceError' + description: Internal Server Error - the server could not process the request. + /pins/reveal: + post: + tags: + - PIN functionality + summary: Reveal Pin + description: Reveal Pin + x-addedInVersion: '1' + operationId: post-pins-reveal + x-sortIndex: 2 + x-methodName: revealPin + security: + - clientKey: [] + - BasicAuth: [] + - ApiKeyAuth: [] + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/RevealPinRequest' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/RevealPinResponse' + description: OK - the request has succeeded. + '401': + content: + application/json: + examples: + generic: + $ref: '#/components/examples/generic-401' + schema: + $ref: '#/components/schemas/RestServiceError' + description: Unauthorized - authentication required. + '403': + content: + application/json: + examples: + generic: + $ref: '#/components/examples/generic-403' + schema: + $ref: '#/components/schemas/RestServiceError' + description: Forbidden - insufficient permissions to process the request. + '422': + content: + application/json: + examples: + generic: + $ref: '#/components/examples/generic-422' + schema: + $ref: '#/components/schemas/RestServiceError' + description: Unprocessable Entity - a request validation error. + '500': + content: + application/json: + examples: + generic: + $ref: '#/components/examples/generic-500' + schema: + $ref: '#/components/schemas/RestServiceError' + description: Internal Server Error - the server could not process the request. /transactionRules: post: tags: @@ -2506,10 +2932,10 @@ paths: [examples](https://docs.adyen.com/issuing/transaction-rules/examples). x-addedInVersion: '1' operationId: post-transactionRules - x-groupName: Transaction rules x-sortIndex: 1 x-methodName: createTransactionRule security: + - clientKey: [] - BasicAuth: [] - ApiKeyAuth: [] requestBody: @@ -2595,10 +3021,10 @@ paths: description: Deletes a transaction rule. x-addedInVersion: '1' operationId: delete-transactionRules-transactionRuleId - x-groupName: Transaction rules x-sortIndex: 5 x-methodName: deleteTransactionRule security: + - clientKey: [] - BasicAuth: [] - ApiKeyAuth: [] parameters: @@ -2670,10 +3096,10 @@ paths: description: Returns the details of a transaction rule. x-addedInVersion: '1' operationId: get-transactionRules-transactionRuleId - x-groupName: Transaction rules x-sortIndex: 2 x-methodName: getTransactionRule security: + - clientKey: [] - BasicAuth: [] - ApiKeyAuth: [] parameters: @@ -2749,10 +3175,10 @@ paths: \ a parameter in the request, that parameter is removed from the resource." x-addedInVersion: '1' operationId: patch-transactionRules-transactionRuleId - x-groupName: Transaction rules x-sortIndex: 3 x-methodName: updateTransactionRule security: + - clientKey: [] - BasicAuth: [] - ApiKeyAuth: [] requestBody: @@ -2836,10 +3262,10 @@ paths: [make a transfer](https://docs.adyen.com/api-explorer/transfers/latest/post/transfers). x-addedInVersion: '1' operationId: post-transferRoutes-calculate - x-groupName: Transfer routes x-sortIndex: 1 x-methodName: calculateTransferRoutes security: + - clientKey: [] - BasicAuth: [] - ApiKeyAuth: [] requestBody: @@ -2906,10 +3332,10 @@ paths: or [create a transfer instrument](https://docs.adyen.com/api-explorer/legalentity/latest/post/transferInstruments). x-addedInVersion: '1' operationId: post-validateBankAccountIdentification - x-groupName: Bank account validation x-sortIndex: 1 x-methodName: validateBankAccountIdentification security: + - clientKey: [] - BasicAuth: [] - ApiKeyAuth: [] requestBody: @@ -3148,6 +3574,7 @@ components: with this capability. ' items: $ref: '#/components/schemas/AccountSupportingEntityCapability' + readOnly: true type: array verificationStatus: description: 'The status of the verification checks for the capability. @@ -3984,6 +4411,17 @@ components: required: - accountIdentification type: object + BankAccountModel: + properties: + formFactor: + description: Form factor of the bank account - **virtual** or **physical** + (default) + enum: + - physical + - unknown + - virtual + type: string + type: object BankIdentification: properties: country: @@ -4464,6 +4902,104 @@ components: - brand - brandVariant type: object + CardOrder: + properties: + beginDate: + description: The date when the card order is created. + format: date-time + type: string + cardManufacturingProfileId: + description: The unique identifier of the card manufacturer profile. + type: string + closedDate: + description: The date when the card order processing ends. + format: date-time + type: string + endDate: + description: 'The date when you manually closed the card order. + + + Card orders are automatically closed by the end of the day it was created. + If you manually closed it beforehand, the closing date is shown as the + `endDate`.' + format: date-time + type: string + id: + description: The unique identifier of the card order. + type: string + lockDate: + description: The date when the card order processing begins. + format: date-time + type: string + serviceCenter: + description: The service center. + type: string + status: + description: 'The status of the card order. + + + Possible values: **Open**, **Closed**.' + enum: + - closed + - open + type: string + type: object + CardOrderItem: + properties: + balancePlatform: + description: The unique identifier of the balance platform. + type: string + card: + description: 'The status of the card delivery. + + + Possible values: **created**, **rejected**, **processing**, **produced**, + **shipped**, **delivered**, **notApplicable**, **unknown**. ' + $ref: '#/components/schemas/CardOrderItemDeliveryStatus' + cardOrderItemId: + description: The unique identifier of the card order item. + type: string + creationDate: + description: The date and time when the event was triggered, in ISO 8601 + extended format. For example, **2020-12-18T10:15:30+01:00**. + format: date-time + type: string + id: + description: The ID of the resource. + readOnly: true + type: string + paymentInstrumentId: + description: The unique identifier of the payment instrument related to + the card order item. + type: string + pin: + description: Contains information about the status of the PIN delivery. + $ref: '#/components/schemas/CardOrderItemDeliveryStatus' + shippingMethod: + description: The shipping method used to deliver the card or the PIN. + type: string + type: object + CardOrderItemDeliveryStatus: + properties: + errorMessage: + description: An error message. + type: string + status: + description: The status of the PIN delivery. + enum: + - created + - delivered + - notApplicable + - processing + - produced + - rejected + - shipped + - unknown + type: string + trackingNumber: + description: The tracking number of the PIN delivery. + type: string + type: object ContactDetails: properties: address: @@ -4986,7 +5522,8 @@ components: type: string expiresAt: description: The end date of the grant offer validity period. - $ref: '#/components/schemas/LocalDateTime' + format: date-time + type: string fee: description: Details of the fee configuration. $ref: '#/components/schemas/Fee' @@ -4998,7 +5535,8 @@ components: $ref: '#/components/schemas/Repayment' startsAt: description: The starting date of the grant offer validity period. - $ref: '#/components/schemas/LocalDateTime' + format: date-time + type: string required: - accountHolderId type: object @@ -5122,8 +5660,6 @@ components: $ref: '#/components/schemas/NetworkToken' type: array type: object - LocalDateTime: - type: object MatchingTransactionsRestriction: properties: operation: @@ -5354,6 +5890,41 @@ components: - hasPrevious - hasNext type: object + PaginatedGetCardOrderItemResponse: + properties: + data: + description: List of card order items in the card order batch. + items: + $ref: '#/components/schemas/CardOrderItem' + type: array + hasNext: + description: Indicates whether there are more items on the next page. + type: boolean + hasPrevious: + description: Indicates whether there are more items on the previous page. + type: boolean + required: + - data + - hasPrevious + - hasNext + type: object + PaginatedGetCardOrderResponse: + properties: + cardOrders: + description: Contains objects with information about card orders. + items: + $ref: '#/components/schemas/CardOrder' + type: array + hasNext: + description: Indicates whether there are more items on the next page. + type: boolean + hasPrevious: + description: Indicates whether there are more items on the previous page. + type: boolean + required: + - hasPrevious + - hasNext + type: object PaginatedPaymentInstrumentsResponse: properties: hasNext: @@ -5527,6 +6098,9 @@ components: description: The unique identifier of the [balance account](https://docs.adyen.com/api-explorer/#/balanceplatform/v1/post/balanceAccounts__resParam_id) associated with the payment instrument. type: string + bankAccount: + description: Contains the business account details. + $ref: '#/components/schemas/BankAccountModel' card: description: Contains information about the card. Required when you create a payment instrument of `type` **card**. @@ -5747,6 +6321,38 @@ components: - SIP type: string type: object + PinChangeRequest: + properties: + encryptedKey: + description: Symmetric session key encrypted under the public key. + type: string + encryptedPinBlock: + description: The encrypted PIN block + type: string + paymentInstrumentId: + description: The unique identifier of the payment instrument. + type: string + token: + description: The token which is used to construct the pinblock. + type: string + required: + - paymentInstrumentId + - encryptedKey + - token + - encryptedPinBlock + type: object + PinChangeResponse: + properties: + status: + description: The pin change status. + enum: + - completed + - pending + - unavailable + type: string + required: + - status + type: object PlatformPaymentConfiguration: properties: salesDayClosingTime: @@ -5807,6 +6413,19 @@ components: required: - operation type: object + PublicKeyResponse: + properties: + publicKey: + description: The public key to be used for encrypting the symmetric session + key. + type: string + publicKeyExpiryDate: + description: The expiry date of the public key. + type: string + required: + - publicKey + - publicKeyExpiryDate + type: object RemediatingAction: properties: code: @@ -5890,6 +6509,30 @@ components: - detail - status type: object + RevealPinRequest: + properties: + encryptedKey: + description: Symmetric session key encrypted under the public key. + type: string + paymentInstrumentId: + description: The unique identifier of the payment instrument. + type: string + required: + - paymentInstrumentId + - encryptedKey + type: object + RevealPinResponse: + properties: + encryptedPinBlock: + description: The encrypted PIN block. + type: string + token: + description: The encrypted PIN block extraction token. + type: string + required: + - encryptedPinBlock + - token + type: object SELocalAccountIdentification: additionalProperties: false properties: @@ -7468,6 +8111,10 @@ components: BasicAuth: scheme: basic type: http + clientKey: + in: query + name: clientKey + type: apiKey examples: delete-transactionRules-transactionRuleId-success-200: summary: Transaction rule deleted @@ -7750,6 +8397,35 @@ components: value: id: YOUR_BALANCE_PLATFORM status: Active + get-cardorders-id-items-success-200: + summary: Item list of a specific card order retrieved + description: Example response for retrieving the item list of a specific card + order + value: + data: + - card: + status: shipped + cardOrderItemId: UNIQUE_CARD_ORDER_ITEM_ID + paymentInstrumentId: UNIQUE_PAYMENT_INSTRUMENT_ID + pin: + status: produced + shippingMethod: Cardholder Post Basic National + hasNext: false + hasPrevious: false + get-cardorders-success-200: + summary: List of card orders retrieved + description: Example response for retrieving a paginated list of card orders + value: + cardOrders: + - beginDate: '2022-12-05T00:00:00+01:00' + cardManufacturingProfileId: UNIQUE_CARD_MANUFACTURER_PROFILE_ID + endDate: '2022-12-06T00:00:00+01:00' + id: UNIQUE_CARD_ORDER_ID + lockDate: '2023-04-14T16:43:02+02:00' + serviceCenter: IDEMIA Sittard + status: closed + hasNext: true + hasPrevious: false get-paymentInstrumentGroups-id-success-200: summary: Payment instrument group retrieved description: Example response when retrieving a payment instrument group