diff --git a/json/BalancePlatformService-v1.json b/json/BalancePlatformService-v1.json index 6343498..8ec5aec 100644 --- a/json/BalancePlatformService-v1.json +++ b/json/BalancePlatformService-v1.json @@ -821,6 +821,134 @@ "description" : "Internal Server Error - the server could not process the request." } } + }, + "patch" : { + "tags" : [ + "Balance accounts" + ], + "summary" : "Update a balance account.", + "description" : "Updates a balance account.", + "x-addedInVersion" : "1", + "operationId" : "patch-balanceAccounts-id", + "x-groupName" : "Balance accounts", + "x-sortIndex" : 2, + "security" : [ + { + "BasicAuth" : [ + ] + }, + { + "ApiKeyAuth" : [ + ] + } + ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/BalanceAccountUpdateRequest" + } + } + } + }, + "parameters" : [ + { + "description" : "Unique identifier of the balance account.", + "name" : "id", + "in" : "path", + "required" : true, + "schema" : { + "type" : "string" + } + } + ], + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/BalanceAccount" + } + } + }, + "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." + } + } } }, "/balanceAccounts/{id}/paymentInstruments" : { @@ -4412,6 +4540,39 @@ "accountHolderId" ] }, + "BalanceAccountUpdateRequest" : { + "properties" : { + "accountHolderId" : { + "description" : "Unique identifier of the [account holder](https://docs.adyen.com/api-explorer/#/balanceplatform/latest/get/accountHolders/{id}) associated with the balance account.", + "type" : "string" + }, + "description" : { + "description" : "A human-readable description of the balance account, maximum 300 characters. You can use this parameter to help distinguish between multiple balance accounts under an account holder.", + "maxLength" : 300, + "type" : "string" + }, + "status" : { + "description" : "The status of the balance account. Payment instruments linked to the balance account can only be used if the balance account status is **Active**.\n\nPossible values: **Active**, **Inactive**, **Closed**, **Suspended**.", + "enum" : [ + "Active", + "Closed", + "Inactive", + "Suspended" + ], + "type" : "string" + }, + "sweepConfigurations" : { + "additionalProperties" : { + "$ref" : "#/components/schemas/SweepConfiguration" + }, + "description" : "Contains key-value pairs that specify [balance sweep configuration per currency code](https://docs.adyen.com/api-explorer/#/balanceplatform/latest/post/balanceAccounts__reqParam_sweepConfigurations).\n\nYou can update the balance account to add, update, or delete configurations.\n\n* To add a configuration, send the currency code as a key and the configuration as the object.\n\n * To update a configuration, send the whole configuration with your updates.\n\n* To delete a configuration, set the value to **null**. For example, `\"EUR\": null`.", + "type" : "object" + } + }, + "required" : [ + "accountHolderId" + ] + }, "BalancePlatform" : { "properties" : { "description" : { @@ -5714,6 +5875,18 @@ } } }, + "RemediatingAction" : { + "properties" : { + "code" : { + "description" : "The remediating action code.", + "type" : "string" + }, + "message" : { + "description" : "A description of how you can resolve the verification error.", + "type" : "string" + } + } + }, "RestServiceError" : { "properties" : { "detail" : { diff --git a/yaml/BalancePlatformService-v1.yaml b/yaml/BalancePlatformService-v1.yaml index 98d84d0..f302528 100644 --- a/yaml/BalancePlatformService-v1.yaml +++ b/yaml/BalancePlatformService-v1.yaml @@ -529,6 +529,82 @@ paths: schema: $ref: '#/components/schemas/RestServiceError' description: Internal Server Error - the server could not process the request. + patch: + tags: + - Balance accounts + summary: Update a balance account. + description: Updates a balance account. + x-addedInVersion: '1' + operationId: patch-balanceAccounts-id + x-groupName: Balance accounts + x-sortIndex: 2 + security: + - BasicAuth: [] + - ApiKeyAuth: [] + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/BalanceAccountUpdateRequest' + parameters: + - description: Unique identifier of the balance account. + name: id + in: path + required: true + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/BalanceAccount' + 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. /balanceAccounts/{id}/paymentInstruments: get: tags: @@ -2933,6 +3009,44 @@ components: type: object required: - accountHolderId + BalanceAccountUpdateRequest: + properties: + accountHolderId: + description: Unique identifier of the [account holder](https://docs.adyen.com/api-explorer/#/balanceplatform/latest/get/accountHolders/{id}) + associated with the balance account. + type: string + description: + description: A human-readable description of the balance account, maximum + 300 characters. You can use this parameter to help distinguish between + multiple balance accounts under an account holder. + maxLength: 300 + type: string + status: + description: 'The status of the balance account. Payment instruments linked + to the balance account can only be used if the balance account status + is **Active**. + + + Possible values: **Active**, **Inactive**, **Closed**, **Suspended**.' + enum: + - Active + - Closed + - Inactive + - Suspended + type: string + sweepConfigurations: + additionalProperties: + $ref: '#/components/schemas/SweepConfiguration' + description: "Contains key-value pairs that specify [balance sweep configuration\ + \ per currency code](https://docs.adyen.com/api-explorer/#/balanceplatform/latest/post/balanceAccounts__reqParam_sweepConfigurations).\n\ + \nYou can update the balance account to add, update, or delete configurations.\n\ + \n* To add a configuration, send the currency code as a key and the configuration\ + \ as the object.\n\n * To update a configuration, send the whole configuration\ + \ with your updates.\n\n* To delete a configuration, set the value to\ + \ **null**. For example, `\"EUR\": null`." + type: object + required: + - accountHolderId BalancePlatform: properties: description: @@ -4090,6 +4204,14 @@ components: shopperReference: description: The unique identifier used when the payment details were stored. type: string + RemediatingAction: + properties: + code: + description: The remediating action code. + type: string + message: + description: A description of how you can resolve the verification error. + type: string RestServiceError: properties: detail: