openapi: 3.1.0 info: version: '6' x-publicVersion: true title: Adyen Account acceptDispute Instruments API description: "This API is used for the classic integration. If you are just starting your implementation, refer to our [new integration guide](https://docs.adyen.com/marketplaces-and-platforms) instead.\n\nThe Account API provides endpoints for managing account-related entities on your platform. These related entities include account holders, accounts, bank accounts, shareholders, and verification-related documents. The management operations include actions such as creation, retrieval, updating, and deletion of them.\n\nFor more information, refer to our [documentation](https://docs.adyen.com/marketplaces-and-platforms/classic).\n## Authentication\nYour Adyen contact will provide your API credential and an API key. To connect to the API, add an `X-API-Key` header with the API key as the value, for example:\n\n ```\ncurl\n-H \"Content-Type: application/json\" \\\n-H \"X-API-Key: YOUR_API_KEY\" \\\n...\n```\n\nAlternatively, you can use the username and password to connect to the API using basic authentication. For example:\n\n```\ncurl\n-U \"ws@MarketPlace.YOUR_PLATFORM_ACCOUNT\":\"YOUR_WS_PASSWORD\" \\\n-H \"Content-Type: application/json\" \\\n...\n```\nWhen going live, you need to generate new web service user credentials to access the [live endpoints](https://docs.adyen.com/development-resources/live-endpoints).\n\n## Versioning\nThe Account API supports [versioning](https://docs.adyen.com/development-resources/versioning) using a version suffix in the endpoint URL. This suffix has the following format: \"vXX\", where XX is the version number.\n\nFor example:\n```\nhttps://cal-test.adyen.com/cal/services/Account/v6/createAccountHolder\n```" x-timestamp: '2023-05-30T15:27:20Z' termsOfService: https://www.adyen.com/legal/terms-and-conditions contact: name: Adyen Developer Experience team url: https://github.com/Adyen/adyen-openapi servers: - url: https://cal-test.adyen.com/cal/services/Account/v6 tags: - name: Instruments paths: /balanceAccounts/{id}/paymentInstruments: get: tags: - Instruments summary: Adyen 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-sortIndex: 4 x-methodName: getPaymentInstrumentsLinkedToBalanceAccount security: - clientKey: [] - BasicAuth: [] - ApiKeyAuth: [] parameters: - description: The unique identifier of the balance account. name: id in: path required: true schema: type: string - description: The number of items that you want to skip. name: offset in: query required: false schema: format: int32 type: integer - description: The number of items returned per page, maximum 100 items. By default, the response returns 10 items per page. name: limit in: query required: false 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: application/json: examples: success: $ref: '#/components/examples/get-balanceAccounts-id-paymentInstruments-success-200' schema: $ref: '#/components/schemas/PaginatedPaymentInstrumentsResponse' 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. x-microcks-operation: delay: 0 dispatcher: FALLBACK /paymentInstrumentGroups: post: tags: - Instruments summary: Adyen 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. x-microcks-operation: delay: 0 dispatcher: FALLBACK /paymentInstrumentGroups/{id}: get: tags: - Instruments summary: Adyen 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/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. x-microcks-operation: delay: 0 dispatcher: FALLBACK /paymentInstrumentGroups/{id}/transactionRules: get: tags: - Instruments summary: Adyen 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: get-paymentInstrumentGroups-id-transactionRules x-sortIndex: 3 x-methodName: getAllTransactionRulesForPaymentInstrumentGroup 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-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: 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. x-microcks-operation: delay: 0 dispatcher: FALLBACK /paymentInstruments: post: tags: - Instruments summary: Adyen 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-paymentInstruments x-sortIndex: 11 x-methodName: createPaymentInstrument security: - clientKey: [] - BasicAuth: [] - ApiKeyAuth: [] 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' 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' 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. x-microcks-operation: delay: 0 dispatcher: FALLBACK /paymentInstruments/{id}: get: tags: - Instruments summary: Adyen Get a Payment Instrument description: Returns the details of a payment instrument. x-addedInVersion: '1' operationId: get-paymentInstruments-id x-sortIndex: 13 x-methodName: getPaymentInstrument security: - clientKey: [] - BasicAuth: [] - ApiKeyAuth: [] parameters: - description: The unique identifier of the payment instrument. name: id in: path required: true schema: type: string responses: '200': content: application/json: examples: success: $ref: '#/components/examples/get-paymentInstruments-id-success-200' schema: $ref: '#/components/schemas/PaymentInstrument' 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. x-microcks-operation: delay: 0 dispatcher: FALLBACK patch: tags: - Instruments summary: Adyen 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: patch-paymentInstruments-id x-sortIndex: 12 x-methodName: updatePaymentInstrument security: - clientKey: [] - BasicAuth: [] - ApiKeyAuth: [] 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. name: id in: path required: true schema: type: string responses: '200': content: application/json: examples: updatePaymentInstrumentBalanceAccount: $ref: '#/components/examples/patch-paymentInstruments-id-updatePaymentInstrumentBalanceAccount-200' updatePaymentInstrumentStatus: $ref: '#/components/examples/patch-paymentInstruments-id-updatePaymentInstrumentStatus-200' schema: $ref: '#/components/schemas/UpdatePaymentInstrument' 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. x-microcks-operation: delay: 0 dispatcher: FALLBACK /paymentInstruments/{id}/networkTokens: get: tags: - Instruments summary: Adyen List Network Tokens description: List the network tokens connected to a payment instrument. x-addedInVersion: '1' operationId: get-paymentInstruments-id-networkTokens x-sortIndex: 15 x-methodName: listNetworkTokens security: - clientKey: [] - BasicAuth: [] - ApiKeyAuth: [] parameters: - description: The unique identifier of the payment instrument. name: id in: path required: true schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/ListNetworkTokensResponse' examples: get-paymentInstruments-id-networkTokens200Example: summary: Default get-paymentInstruments-id-networkTokens 200 response x-microcks-default: true value: networkTokens: - example_value 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. x-microcks-operation: delay: 0 dispatcher: FALLBACK /paymentInstruments/{id}/reveal: get: tags: - Instruments summary: Adyen Get the PAN of a Payment Instrument description: 'Returns the primary account number (PAN) of a payment instrument. To make this request, your API credential must have the following [role](https://docs.adyen.com/issuing/manage-access/api-credentials-web-service#api-permissions): * Balance Platform BCL PCI role' x-addedInVersion: '1' operationId: get-paymentInstruments-id-reveal x-sortIndex: 14 x-methodName: getPanOfPaymentInstrument security: - clientKey: [] - BasicAuth: [] - ApiKeyAuth: [] parameters: - description: The unique identifier of the payment instrument. name: id in: path required: true schema: type: string responses: '200': content: application/json: examples: success: $ref: '#/components/examples/get-paymentInstruments-id-reveal-success-200' schema: $ref: '#/components/schemas/PaymentInstrumentRevealInfo' 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. x-microcks-operation: delay: 0 dispatcher: FALLBACK /paymentInstruments/{id}/transactionRules: get: tags: - Instruments summary: Adyen Get All Transaction Rules for a Payment Instrument description: Returns a list of transaction rules associated with a payment instrument. x-addedInVersion: '1' operationId: get-paymentInstruments-id-transactionRules x-sortIndex: 14 x-methodName: getAllTransactionRulesForPaymentInstrument security: - clientKey: [] - BasicAuth: [] - ApiKeyAuth: [] parameters: - description: The unique identifier of the payment instrument. name: id in: path required: true schema: type: string responses: '200': content: application/json: examples: success: $ref: '#/components/examples/get-paymentInstruments-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: 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. x-microcks-operation: delay: 0 dispatcher: FALLBACK components: examples: patch-paymentInstruments-id-updatePaymentInstrumentStatus: summary: Update the status of a payment instrument description: Example request for updating the status of a payment instrument value: status: suspended get-paymentInstruments-id-reveal-success-200: summary: Get the card's primary account number (PAN) description: Example response for getting the card PAN value: cvc: '123' expiration: month: '02' year: '2026' pan: '5555444411209883' patch-paymentInstruments-id-updatePaymentInstrumentStatus-200: summary: Payment instrument status updated description: Example response for updating the status of a payment instrument value: balanceAccountId: BA32272223222B59CZ3T52DKZ description: S. Hopper - Main card issuingCountryCode: GB status: suspended type: card card: brand: mc brandVariant: mcdebit cardholderName: Simon Hopper formFactor: virtual bin: '555544' expiration: month: '01' year: '2024' lastFour: '5785' number: '************5785' id: PI3227C223222B5CMD278FKGS generic-400: summary: Response code - 400 Bad request value: type: https://docs.adyen.com/errors/general/bad-request title: Bad request status: 400 detail: Empty input which would have resulted in a null result. errorCode: '00_400' generic-422: summary: Response code - 422 Unprocessable Entity. value: type: https://docs.adyen.com/errors/general/invalid-field-value title: Invalid Payment Instrument information provided status: 422 detail: The balanceAccountId can only be changed when the status is Inactive or Requested requestId: 1W1UI15PLVGC9V8O errorCode: '30_031' patch-paymentInstruments-id-updatePaymentInstrumentBalanceAccount-200: summary: Balance account updated description: Example response for updating the balance account linked to a payment instrument value: balanceAccountId: BA32272223222B5CM82WL892M description: S. Hopper - Main card issuingCountryCode: GB status: inactive type: card card: brand: mc brandVariant: mcdebit cardholderName: Simon Hopper formFactor: virtual bin: '555544' expiration: month: '01' year: '2024' lastFour: '5785' number: '************5785' id: PI3227C223222B5CMD278FKGS post-paymentInstruments-createVirtualCard: summary: Create a virtual card description: Example request for creating a virtual card value: type: card description: My test card balanceAccountId: BA3227C223222B5FG88S28BGN issuingCountryCode: NL card: cardholderName: Simon Hopper brand: mc brandVariant: mcdebit formFactor: virtual generic-500: summary: Response code - 500 Internal Server Error value: type: https://docs.adyen.com/errors/general/internal title: An internal error happened status: 500 detail: Unrecoverable error while trying to create payment instrument requestId: 1WAF555PLWNTLYOQ errorCode: '00_500' post-paymentInstruments-createVirtualCard-200: summary: Virtual card created description: Example response for creating a virtual card value: balanceAccountId: BA3227C223222B5FG88S28BGN description: My test card issuingCountryCode: NL status: active type: card card: brand: mc brandVariant: mcdebit cardholderName: Simon Hopper formFactor: virtual bin: '555544' cvc: '136' expiration: month: '11' year: '2025' lastFour: '3703' number: '5555444411213703' id: PI32272223222C5GXTDWH3TTN patch-paymentInstruments-id-updatePaymentInstrumentBalanceAccount: summary: Update the balance account linked to a payment instrument description: Example request for updating the balance account of a payment instrument value: balanceAccountId: BA32272223222B5CM82WL892M get-paymentInstrumentGroups-id-success-200: summary: Payment instrument group retrieved description: Example response when retrieving a payment instrument group value: balancePlatform: YOUR_BALANCE_PLATFORM txVariant: mc id: PG3227C223222B5CMD3FJFKGZ post-paymentInstruments-createPhysicalCard-200: summary: Physical card created description: Example response for creating a physical card value: balanceAccountId: BA32272223222B59CZ3T52DKZ description: S. Hopper - Main card issuingCountryCode: NL status: inactive type: card card: brand: mc brandVariant: mcdebit cardholderName: Sam Hopper formFactor: physical number: '************5785' bin: '555544' expiration: month: 8 year: '2024' lastFour: '2765' authentication: password: '******' phone: number: '+123456789' type: mobile deliveryContact: address: city: Amsterdam country: NL stateOrProvince: NH line1: Brannan Street line2: '274' postalCode: 1020CD name: firstName: Sam lastName: Hopper configuration: configurationProfileId: CP123AB45678C91ABCD2ABCDE id: PI3227C223222B5BPCMFXD2XG get-paymentInstrumentGroups-id-transactionRules-success-200: summary: Transaction rules for a payment instrument group retrieved description: Example response when retrieving a list of transaction rules applied to a payment instrument group value: transactionRules: - aggregationLevel: paymentInstrument description: Up to 1000 EUR per card for the last 12 hours entityKey: entityReference: PG3227C223222C5GXR3M5592Q entityType: paymentInstrumentGroup interval: duration: unit: hours value: 12 timeZone: UTC type: sliding outcomeType: hardBlock reference: YOUR_REFERENCE_2918A requestType: authorization ruleRestrictions: totalAmount: operation: greaterThan value: currency: EUR value: 100000 status: inactive type: velocity id: TR3227C223222C5GXR3XP596N - aggregationLevel: paymentInstrument description: NL only entityKey: entityReference: PG3227C223222C5GXR3M5592Q entityType: paymentInstrumentGroup interval: duration: unit: hours value: 12 timeZone: UTC type: sliding outcomeType: hardBlock reference: myRule12345 requestType: authorization ruleRestrictions: totalAmount: operation: greaterThan value: currency: EUR value: 100000 status: inactive type: velocity id: TR3227C223222C5GXR3WC595H generic-403: summary: Response code - 403 Forbidden. value: type: https://docs.adyen.com/errors/security/unauthorized title: Forbidden status: 403 detail: Not the right permission to access this service. errorCode: '00_403' post-paymentInstrumentGroups-createPaymentInstrumentGroups: summary: Create a payment instrument group description: Example request for creating a payment instrument group value: balancePlatform: YOUR_BALANCE_PLATFORM txVariant: mc post-paymentInstrumentGroups-createPaymentInstrumentGroups-200: summary: Create a payment instrument group description: Example request for creating a payment instrument group value: balancePlatform: YOUR_BALANCE_PLATFORM txVariant: mc id: PG32272223222H5J4DCRVC9DH post-paymentInstruments-createBusinessAccountNL: summary: Create a business account in NL description: Example request for creating a business account in NL value: type: bankAccount description: YOUR_DESCRIPTION balanceAccountId: BA3227C223222B5CTBLR8BWJB issuingCountryCode: NL post-paymentInstruments-createBusinessAccountUS: summary: Create a business account in the US description: Example request for creating a business account in the US value: type: bankAccount description: YOUR_DESCRIPTION balanceAccountId: BA3227C223222B5CTBLR8BWJB issuingCountryCode: US post-paymentInstruments-createBusinessAccountUS-200: summary: Business account in the US created description: Example response for creating a business account in the US value: balanceAccountId: BA3227C223222B5CTBLR8BWJB issuingCountryCode: US status: active type: bankAccount description: YOUR_DESCRIPTION bankAccount: type: usLocal accountNumber: '333720756' routingNumber: '210000210' accountType: checking id: PI322LJ223222B5DJS7CD9LWL post-paymentInstruments-createPhysicalCard: summary: Create a physical card description: Example request for creating a physical card value: type: card issuingCountryCode: NL balanceAccountId: BA32272223222B59CZ3T52DKZ description: S.Hopper - Main card status: inactive card: formFactor: physical brand: mc brandVariant: mcdebit cardholderName: Sam Hopper deliveryContact: address: city: Amsterdam country: NL stateOrProvince: NH line1: Brannan Street line2: '274' postalCode: 1020CD name: firstName: Sam lastName: Hopper configuration: configurationProfileId: CP123AB45678C91ABCD2ABCDE get-paymentInstruments-id-success-200: summary: Payment instruments retrieved description: Example response for retrieving payment instruments associated with a balance account value: balanceAccountId: BA32272223222B59CZ3T52DKZ description: S. Hopper - Main card issuingCountryCode: GB status: active type: card card: brand: mc brandVariant: mcdebit cardholderName: Simon Hopper formFactor: virtual bin: '555544' expiration: month: '01' year: '2024' lastFour: '3548' number: '************3548' id: PI32272223222B5CMD3MQ3HXX generic-401: summary: Response code - 401 Unauthorized value: type: https://docs.adyen.com/errors/security/unauthorized title: Unauthorized status: 401 detail: Not authorized to access this service. errorCode: '00_401' post-paymentInstruments-createBusinessAccountNL-200: summary: Business account in NL created description: Example response for creating a business account in NL value: balanceAccountId: BA3227C223222B5CTBLR8BWJB issuingCountryCode: NL status: active type: bankAccount description: YOUR_DESCRIPTION bankAccount: type: iban iban: NL20ADYB2017000035 id: PI322LJ223222B5DJS7CD9LWL get-paymentInstruments-id-transactionRules-success-200: summary: Transaction rules for a payment instrument retrieved description: Example response when retrieving a list of transaction rules applied to a payment instrument value: transactionRules: - description: Only allow point-of-sale transactions entityKey: entityReference: PI3227C223222B5FN65FN5NS9 entityType: paymentInstrument interval: timeZone: UTC type: perTransaction outcomeType: hardBlock reference: YOUR_REFERENCE_4F7346 requestType: authorization ruleRestrictions: processingTypes: operation: noneMatch value: - pos startDate: '2022-08-02T16:07:00.851374+02:00' status: active type: blockList id: TR32272223222B5GFSGFLFCHM - description: Set the maximum number of active network tokens to one for this card entityKey: entityReference: PI3227C223222B5FN65FN5NS9 entityType: paymentInstrument interval: timeZone: UTC type: perTransaction outcomeType: hardBlock reference: myRule123 requestType: authorization ruleRestrictions: activeNetworkTokens: operation: greaterThanOrEqualTo value: 1 startDate: '2022-10-03T14:48:28.999314+02:00' status: active type: blockList id: TR32272223222C5GQJ93L7J8Z get-balanceAccounts-id-paymentInstruments-success-200: summary: List of payment instruments retrieved description: Example response when retrieving a list of payment instruments under a balance account value: hasNext: true hasPrevious: false paymentInstruments: - balanceAccountId: BA32272223222B59CZ3T52DKZ issuingCountryCode: GB status: active type: card card: brand: mc brandVariant: mc cardholderName: name formFactor: virtual bin: '555544' expiration: month: '12' year: '2022' lastFour: '2357' number: '************2357' id: PI32272223222B59M5TM658DT - balanceAccountId: BA32272223222B59CZ3T52DKZ issuingCountryCode: GB status: active type: card card: brand: mc brandVariant: mc cardholderName: name formFactor: virtual bin: '555544' expiration: month: '01' year: '2023' lastFour: '8331' number: '************8331' id: PI32272223222B59PXDGQDLSF schemas: CountriesRestriction: properties: operation: description: Defines how the condition must be evaluated. type: string value: description: List of two-character [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) country codes. items: type: string type: array required: - operation type: object UpdatePaymentInstrument: properties: balanceAccountId: 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. Returned when you create a payment instrument with `type` **bankAccount**. oneOf: - $ref: '#/components/schemas/IbanAccountIdentification' - $ref: '#/components/schemas/USLocalAccountIdentification' card: description: Contains information about the card payment instrument. Returned when you create a payment instrument with `type` **card**. $ref: '#/components/schemas/Card' description: description: Your description for the payment instrument, maximum 300 characters. maxLength: 300 type: string id: description: The unique identifier of the payment instrument. type: string issuingCountryCode: description: The two-character [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) country code where the payment instrument is issued. For example, **NL** or **US**. type: string paymentInstrumentGroupId: description: The unique identifier of the [payment instrument group](https://docs.adyen.com/api-explorer/#/balanceplatform/v1/post/paymentInstrumentGroups__resParam_id) to which the payment instrument belongs. type: string reference: description: Your reference for the payment instrument, maximum 150 characters. maxLength: 150 type: string status: description: "The status of the payment instrument. If a status is not specified when creating a payment instrument, it is set to **active** by default. However, there can be exceptions for cards based on the `card.formFactor` and the `issuingCountryCode`. For example, when issuing physical cards in the US, the default status is **inactive**.\n\nPossible values: \n\n * **active**: The payment instrument is active and can be used to make payments. \n\n * **inactive**: The payment instrument is inactive and cannot be used to make payments. \n\n * **suspended**: The payment instrument is suspended, either because it was stolen or lost. \n\n * **closed**: The payment instrument is permanently closed. This action cannot be undone. \n\n" enum: - active - closed - inactive - suspended type: string statusComment: description: 'Comment for the status of the payment instrument. Required if `statusReason` is **other**.' type: string statusReason: x-addedInVersion: '2' description: 'The reason for the status of the payment instrument. Possible values: **accountClosure**, **damaged**, **endOfLife**, **expired**, **lost**, **stolen**, **suspectedFraud**, **transactionRule**, **other**. If the reason is **other**, you must also send the `statusComment` parameter describing the status change.' enum: - accountClosure - damaged - endOfLife - expired - lost - other - stolen - suspectedFraud - transactionRule type: string type: description: 'Type of payment instrument. Possible value: **card**, **bankAccount**. ' enum: - bankAccount - card type: string required: - balanceAccountId - issuingCountryCode - type - id type: object PaymentInstrument: properties: balanceAccountId: 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. Returned when you create a payment instrument with `type` **bankAccount**. oneOf: - $ref: '#/components/schemas/IbanAccountIdentification' - $ref: '#/components/schemas/USLocalAccountIdentification' card: description: Contains information about the card payment instrument. Returned when you create a payment instrument with `type` **card**. $ref: '#/components/schemas/Card' description: description: Your description for the payment instrument, maximum 300 characters. maxLength: 300 type: string id: description: The unique identifier of the payment instrument. type: string issuingCountryCode: description: The two-character [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) country code where the payment instrument is issued. For example, **NL** or **US**. type: string paymentInstrumentGroupId: description: The unique identifier of the [payment instrument group](https://docs.adyen.com/api-explorer/#/balanceplatform/v1/post/paymentInstrumentGroups__resParam_id) to which the payment instrument belongs. type: string reference: description: Your reference for the payment instrument, maximum 150 characters. maxLength: 150 type: string status: description: "The status of the payment instrument. If a status is not specified when creating a payment instrument, it is set to **active** by default. However, there can be exceptions for cards based on the `card.formFactor` and the `issuingCountryCode`. For example, when issuing physical cards in the US, the default status is **inactive**.\n\nPossible values: \n\n * **active**: The payment instrument is active and can be used to make payments. \n\n * **inactive**: The payment instrument is inactive and cannot be used to make payments. \n\n * **suspended**: The payment instrument is suspended, either because it was stolen or lost. \n\n * **closed**: The payment instrument is permanently closed. This action cannot be undone. \n\n" enum: - active - closed - inactive - suspended type: string statusReason: x-addedInVersion: '2' description: 'The reason for the status of the payment instrument. Possible values: **accountClosure**, **damaged**, **endOfLife**, **expired**, **lost**, **stolen**, **suspectedFraud**, **transactionRule**, **other**. If the reason is **other**, you must also send the `statusComment` parameter describing the status change.' enum: - accountClosure - damaged - endOfLife - expired - lost - other - stolen - suspectedFraud - transactionRule type: string type: description: 'Type of payment instrument. Possible value: **card**, **bankAccount**. ' enum: - bankAccount - card type: string required: - balanceAccountId - issuingCountryCode - type - id type: object TimeOfDay: properties: endTime: description: 'The end time in a time-only ISO-8601 extended offset format. For example: **08:00:00+02:00**, **22:30:00-03:00**. ' type: string startTime: description: 'The start time in a time-only ISO-8601 extended offset format. For example: **08:00:00+02:00**, **22:30:00-03:00**. ' type: string type: object DeliveryContact: properties: address: description: The address of the contact. $ref: '#/components/schemas/DeliveryAddress' email: description: The email address of the contact. type: string fullPhoneNumber: description: 'The full phone number of the contact provided as a single string. It will be handled as a landline phone. **Examples:** "0031 6 11 22 33 44", "+316/1122-3344", "(0031) 611223344"' type: string name: description: The name of the contact. $ref: '#/components/schemas/Name' phoneNumber: description: The phone number of the contact. $ref: '#/components/schemas/PhoneNumber' webAddress: description: The URL of the contact's website. type: string required: - name - address type: object CardConfiguration: properties: activation: description: Overrides the activation label design ID defined in the `configurationProfileId`. The activation label is attached to the card and contains the activation instructions. type: string activationUrl: description: "Your app's URL, if you want to activate cards through your app. For example, **my-app://ref1236a7d**. A QR code is created based on this URL, and is included in the carrier. Before you use this field, reach out to your Adyen contact to set up the QR code process. \n\nMaximum length: 255 characters." maxLength: 255 type: string bulkAddress: description: Overrides the shipment bulk address defined in the `configurationProfileId`. $ref: '#/components/schemas/BulkAddress' cardImageId: description: The ID of the card image. This is the image that will be printed on the full front of the card. type: string carrier: description: Overrides the carrier design ID defined in the `configurationProfileId`. The carrier is the letter or packaging to which the card is attached. type: string carrierImageId: description: The ID of the carrier image. This is the image that will printed on the letter to which the card is attached. type: string configurationProfileId: description: 'The ID of the card configuration profile that contains the settings of the card. For example, the envelope and PIN mailer designs or the logistics company handling the shipment. All the settings in the profile are applied to the card, unless you provide other fields to override them. For example, send the `shipmentMethod` to override the logistics company defined in the card configuration profile.' type: string currency: description: The three-letter [ISO-4217](https://en.wikipedia.org/wiki/ISO_4217) currency code of the card. For example, **EUR**. type: string envelope: description: 'Overrides the envelope design ID defined in the `configurationProfileId`. ' type: string insert: description: Overrides the insert design ID defined in the `configurationProfileId`. An insert is any additional material, such as marketing materials, that are shipped together with the card. type: string language: description: The two-letter [ISO-639-1](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) language code of the card. For example, **en**. type: string logoImageId: description: The ID of the logo image. This is the image that will be printed on the partial front of the card, such as a logo on the upper right corner. type: string pinMailer: description: Overrides the PIN mailer design ID defined in the `configurationProfileId`. The PIN mailer is the letter on which the PIN is printed. type: string shipmentMethod: description: Overrides the logistics company defined in the `configurationProfileId`. type: string required: - configurationProfileId type: object PaginatedPaymentInstrumentsResponse: properties: 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 paymentInstruments: description: List of payment instruments associated with the balance account. items: $ref: '#/components/schemas/PaymentInstrument' type: array required: - paymentInstruments - hasPrevious - hasNext type: object StringMatch: properties: operation: description: 'The type of string matching operation. Possible values: **startsWith**, **endsWith**, **isEqualTo**, **contains**,' enum: - contains - endsWith - isEqualTo - startsWith type: string value: description: The string to be matched. type: string type: object ProcessingTypesRestriction: properties: operation: description: Defines how the condition must be evaluated. type: string value: description: 'List of processing types. Possible values: **atmWithdraw**, **balanceInquiry**, **ecommerce**, **moto**, **pos**, **recurring**, **token**. ' items: enum: - atmWithdraw - balanceInquiry - ecommerce - moto - pos - recurring - token - unknown type: string type: array required: - operation type: object PaymentInstrumentRevealInfo: properties: cvc: description: The CVC2 value of the card. type: string expiration: description: The expiration date of the card. $ref: '#/components/schemas/Expiry' pan: description: The primary account number (PAN) of the card. type: string required: - pan - expiration - cvc type: object ListNetworkTokensResponse: properties: networkTokens: description: List of network tokens. items: $ref: '#/components/schemas/NetworkToken' type: array type: object Card: properties: authentication: description: Contains the card user's password and mobile phone number. This is required when you issue cards that can be used to make online payments within the EEA and the UK, or can be added to digital wallets. Refer to [3D Secure and digital wallets](https://docs.adyen.com/issuing/3d-secure-and-wallets) for more information. $ref: '#/components/schemas/Authentication' bin: description: The bank identification number (BIN) of the card number. type: string brand: description: 'The brand of the physical or the virtual card. Possible values: **visa**, **mc**.' type: string brandVariant: description: 'The brand variant of the physical or the virtual card. For example, **visadebit** or **mcprepaid**. >Reach out to your Adyen contact to get the values relevant for your integration.' type: string cardholderName: description: "The name of the cardholder.\n Maximum length: 26 characters." maxLength: 26 type: string configuration: description: "Settings required when creating a physical or a virtual card. \n\nReach out to your Adyen contact to get the values that you can send in this object." $ref: '#/components/schemas/CardConfiguration' cvc: description: 'The CVC2 value of the card. > The CVC2 is not sent by default. This is only returned in the `POST` response for single-use virtual cards.' type: string deliveryContact: x-addedInVersion: '2' description: The delivery contact (name and address) for physical card delivery. $ref: '#/components/schemas/DeliveryContact' expiration: description: The expiration date of the card. $ref: '#/components/schemas/Expiry' formFactor: description: 'The form factor of the card. Possible values: **virtual**, **physical**.' enum: - physical - unknown - virtual type: string lastFour: description: Last last four digits of the card number. type: string number: description: 'The primary account number (PAN) of the card. > The PAN is masked by default and returned only for single-use virtual cards.' readOnly: true type: string threeDSecure: description: 'Allocates a specific product range for either a physical or a virtual card. Possible values: **fullySupported**, **secureCorporate**. >Reach out to your Adyen contact to get the values relevant for your integration.' type: string required: - formFactor - cardholderName - brand - brandVariant - number type: object USLocalAccountIdentification: additionalProperties: false properties: accountNumber: description: The bank account number, without separators or whitespace. maxLength: 18 minLength: 2 type: string accountType: default: checking description: 'The bank account type. Possible values: **checking** or **savings**. Defaults to **checking**.' enum: - checking - savings type: string routingNumber: description: The 9-digit [routing number](https://en.wikipedia.org/wiki/ABA_routing_transit_number), without separators or whitespace. maxLength: 9 minLength: 9 type: string type: default: usLocal description: '**usLocal**' enum: - usLocal type: string required: - type - accountNumber - routingNumber type: object TimeOfDayRestriction: properties: operation: description: Defines how the condition must be evaluated. type: string value: $ref: '#/components/schemas/TimeOfDay' required: - operation type: object DeviceInfo: properties: cardCaptureTechnology: description: The technology used to capture the card details. type: string deviceName: description: The name of the device. type: string formFactor: description: The form factor of the device to be provisioned. type: string imei: description: The IMEI number of the device being provisioned. type: string isoDeviceType: description: The 2-digit device type provided on the ISO messages that the token is being provisioned to. type: string msisdn: description: The MSISDN of the device being provisioned. type: string osName: description: The name of the device operating system. type: string osVersion: description: The version of the device operating system. type: string paymentTypes: description: Different types of payments supported for the network token. items: type: string type: array serialNumber: description: The serial number of the device. type: string storageTechnology: description: The architecture or technology used for network token storage. type: string type: object TotalAmountRestriction: properties: operation: description: Defines how the condition must be evaluated. type: string value: description: The amount value and currency. $ref: '#/components/schemas/Amount' required: - operation type: object InternationalTransactionRestriction: properties: operation: description: Defines how the condition must be evaluated. type: string value: description: 'Boolean indicating whether transaction is an international transaction. Possible values: - **true**: The transaction is an international transaction. - **false**: The transaction is a domestic transaction. ' type: boolean required: - operation type: object Expiry: properties: month: description: The month in which the card will expire. type: string year: description: The year in which the card will expire. type: string type: object BulkAddress: properties: city: description: The name of the city. type: string company: description: The name of the company. type: string country: description: The two-character ISO-3166-1 alpha-2 country code. For example, **US**. type: string email: description: The email address. type: string houseNumberOrName: description: The house number or name. type: string mobile: description: The full telephone number. type: string postalCode: description: 'The postal code. Maximum length: * 5 digits for addresses in the US. * 10 characters for all other countries.' type: string stateOrProvince: description: 'The two-letter ISO 3166-2 state or province code. Maximum length: 2 characters for addresses in the US.' type: string street: description: The streetname of the house. type: string required: - country type: object Duration: properties: unit: description: 'The unit of time. You can only use **minutes** and **hours** if the `interval.type` is **sliding**. Possible values: **minutes**, **hours**, **days**, **weeks**, or **months**' enum: - days - hours - minutes - months - weeks type: string value: description: 'The length of time by the unit. For example, 5 days. The maximum duration is 90 days or an equivalent in other units. For example, 3 months.' format: int32 type: integer type: object MerchantNamesRestriction: properties: operation: description: Defines how the condition must be evaluated. type: string value: items: $ref: '#/components/schemas/StringMatch' type: array required: - operation type: object SameCounterpartyRestriction: properties: operation: description: Defines how the condition must be evaluated. type: string value: type: boolean required: - operation type: object TransactionRulesResponse: properties: transactionRules: description: List of transaction rules. items: $ref: '#/components/schemas/TransactionRule' type: array type: object RestServiceError: properties: detail: description: A human-readable explanation specific to this occurrence of the problem. type: string errorCode: description: A code that identifies the problem type. type: string instance: description: A unique URI that identifies the specific occurrence of the problem. type: string invalidFields: description: Detailed explanation of each validation error, when applicable. items: $ref: '#/components/schemas/InvalidField' type: array requestId: description: A unique reference for the request, essentially the same as `pspReference`. type: string response: description: JSON response payload. $ref: '#/components/schemas/JSONObject' status: description: The HTTP status code. format: int32 type: integer title: description: A short, human-readable summary of the problem type. type: string type: description: A URI that identifies the problem type, pointing to human-readable documentation on this problem type. type: string required: - type - errorCode - title - detail - status type: object BankAccountModel: properties: formFactor: description: Form factor of the bank account - **virtual** or **physical** (default) enum: - physical - unknown - virtual type: string type: object CounterpartyBankRestriction: properties: operation: description: Defines how the condition must be evaluated. type: string value: description: List of counterparty Bank Institutions and the operation. items: $ref: '#/components/schemas/BankIdentification' type: array required: - operation type: object IbanAccountIdentification: additionalProperties: false properties: iban: description: The international bank account number as defined in the [ISO-13616](https://www.iso.org/standard/81090.html) standard. type: string type: default: iban description: '**iban**' enum: - iban type: string required: - type - iban type: object DifferentCurrenciesRestriction: properties: operation: description: Defines how the condition must be evaluated. type: string value: description: 'Checks the currency of the payment against the currency of the payment instrument. Possible values: - **true**: The currency of the payment is different from the currency of the payment instrument. - **false**: The currencies are the same. ' type: boolean required: - operation type: object Authentication: properties: email: description: The email address where the one-time password (OTP) is sent. type: string password: description: 'The password used for 3D Secure password-based authentication. The value must be between 1 to 30 characters and must only contain the following supported characters. * Characters between **a-z**, **A-Z**, and **0-9** * Special characters: **+-*/%()=?!#''",;:$&**' maxLength: 30 minLength: 1 type: string phone: description: 'The phone number where the one-time password (OTP) is sent. This object must have: * A `type` set to **mobile**. * A `number` with a valid country code. * A `number` with more than 4 digits, excluding the country code. >Make sure to verify that the card user owns the phone number.' $ref: '#/components/schemas/Phone' type: object PhoneNumber: properties: phoneCountryCode: description: 'The two-character ISO-3166-1 alpha-2 country code of the phone number. For example, **US** or **NL**.' type: string phoneNumber: description: 'The phone number. The inclusion of the phone number country code is not necessary.' type: string phoneType: description: 'The type of the phone number. Possible values: **Landline**, **Mobile**, **SIP**, **Fax**.' enum: - Fax - Landline - Mobile - SIP type: string type: object DayOfWeekRestriction: properties: operation: description: Defines how the condition must be evaluated. type: string value: description: 'List of days of the week. Possible values: **monday**, **tuesday**, **wednesday**, **thursday**, **friday**, **saturday**, **sunday**. ' items: enum: - friday - monday - saturday - sunday - thursday - tuesday - wednesday type: string type: array required: - operation type: object TransactionRuleRestrictions: properties: activeNetworkTokens: description: 'The total number of tokens that a card can have across different kinds of digital wallets on the user''s phones, watches, or other wearables. Supported operations: **equals**, **notEquals**, **greaterThanOrEqualTo**, **greaterThan**, **lessThanOrEqualTo**, **lessThan**.' $ref: '#/components/schemas/ActiveNetworkTokensRestriction' brandVariants: description: 'List of card brand variants and the operation. Supported operations: **anyMatch**, **noneMatch**.' $ref: '#/components/schemas/BrandVariantsRestriction' counterpartyBank: description: 'List of counterparty Institutions and the operation. Supported operations: **anyMatch**, **noneMatch**.' $ref: '#/components/schemas/CounterpartyBankRestriction' countries: description: 'List of countries and the operation. Supported operations: **anyMatch**, **noneMatch**.' $ref: '#/components/schemas/CountriesRestriction' dayOfWeek: description: 'List of week days and the operation. Supported operations: **anyMatch**, **noneMatch**.' $ref: '#/components/schemas/DayOfWeekRestriction' differentCurrencies: description: 'Compares the currency of the payment against the currency of the payment instrument, and specifies the operation. Supported operations: **equals**, **notEquals**.' $ref: '#/components/schemas/DifferentCurrenciesRestriction' entryModes: description: 'List of point-of-sale entry modes and the operation.. Supported operations: **anyMatch**, **noneMatch**.' $ref: '#/components/schemas/EntryModesRestriction' internationalTransaction: description: 'Indicates whether transaction is an international transaction and specifies the operation. Supported operations: **equals**, **notEquals**.' $ref: '#/components/schemas/InternationalTransactionRestriction' matchingTransactions: description: 'The number of transactions and the operation. Supported operations: **equals**, **notEquals**, **greaterThanOrEqualTo**, **greaterThan**, **lessThanOrEqualTo**, **lessThan**.' $ref: '#/components/schemas/MatchingTransactionsRestriction' mccs: description: 'List of merchant category codes (MCCs) and the operation. Supported operations: **anyMatch**, **noneMatch**.' $ref: '#/components/schemas/MccsRestriction' merchantNames: description: 'List of names that will be compared to the merchant name according to the matching type. Supported operations: **anyMatch**, **noneMatch**.' $ref: '#/components/schemas/MerchantNamesRestriction' merchants: description: 'List of merchant ID and acquirer ID pairs, and the operation. Supported operations: **anyMatch**, **noneMatch**.' $ref: '#/components/schemas/MerchantsRestriction' processingTypes: description: 'List of processing types and the operation. Supported operations: **anyMatch**, **noneMatch**.' $ref: '#/components/schemas/ProcessingTypesRestriction' sameAmountRestriction: description: 'Checks if a user has recently sent the same amount of funds in multiple transfers. To use this restriction, you must: - Set the rule `type` to **velocity**. - Specify a time `interval`. - Specify a number of `matchingTransactions`. Supported operation: **equals**.' $ref: '#/components/schemas/SameAmountRestriction' sameCounterpartyRestriction: description: 'Checks if a user has recently made multiple transfers to the same counterparty. To use this restriction, you must: - Set the rule `type` to **velocity**. - Specify a time `interval`. - Specify a number of `matchingTransactions`. Supported operations: **equals**.' $ref: '#/components/schemas/SameCounterpartyRestriction' timeOfDay: description: 'A start and end time in a time-only ISO-8601 extended offset format. Supported operations: **equals**, **notEquals**.' $ref: '#/components/schemas/TimeOfDayRestriction' totalAmount: description: 'The total amount and the operation. Supported operations: **equals**, **notEquals**, **greaterThanOrEqualTo**, **greaterThan**, **lessThanOrEqualTo**, **lessThan**.' $ref: '#/components/schemas/TotalAmountRestriction' type: object InvalidField: properties: message: description: Description of the validation error. type: string name: description: The field that has an invalid value. type: string value: description: The invalid value. type: string required: - name - value - message type: object JSONObject: type: object DeliveryAddress: properties: city: description: The name of the city. type: string country: description: 'The two-character ISO-3166-1 alpha-2 country code. For example, **US**. >If you don''t know the country or are not collecting the country from the shopper, provide `country` as `ZZ`.' type: string line1: description: The street name. For example, if the address is "Rokin 49", provide "Rokin". type: string line2: description: The house number or name. For example, if the address is "Rokin 49", provide "49". type: string line3: description: Optional information about the address. type: string postalCode: description: 'The postal code. Maximum length: * 5 digits for an address in the US. * 10 characters for an address in all other countries.' type: string stateOrProvince: description: 'The two-letterISO 3166-2 state or province code. For example, **CA** in the US or **ON** in Canada. > Required for the US and Canada.' type: string required: - country type: object PaymentInstrumentInfo: properties: balanceAccountId: 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' description: description: Your description for the payment instrument, maximum 300 characters. maxLength: 300 type: string issuingCountryCode: description: The two-character [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) country code where the payment instrument is issued. For example, **NL** or **US**. type: string paymentInstrumentGroupId: description: The unique identifier of the [payment instrument group](https://docs.adyen.com/api-explorer/#/balanceplatform/v1/post/paymentInstrumentGroups__resParam_id) to which the payment instrument belongs. type: string reference: description: Your reference for the payment instrument, maximum 150 characters. maxLength: 150 type: string status: description: "The status of the payment instrument. If a status is not specified when creating a payment instrument, it is set to **active** by default. However, there can be exceptions for cards based on the `card.formFactor` and the `issuingCountryCode`. For example, when issuing physical cards in the US, the default status is **inactive**.\n\nPossible values: \n\n * **active**: The payment instrument is active and can be used to make payments. \n\n * **inactive**: The payment instrument is inactive and cannot be used to make payments. \n\n * **suspended**: The payment instrument is suspended, either because it was stolen or lost. \n\n * **closed**: The payment instrument is permanently closed. This action cannot be undone. \n\n" enum: - active - closed - inactive - suspended type: string statusReason: x-addedInVersion: '2' description: 'The reason for the status of the payment instrument. Possible values: **accountClosure**, **damaged**, **endOfLife**, **expired**, **lost**, **stolen**, **suspectedFraud**, **transactionRule**, **other**. If the reason is **other**, you must also send the `statusComment` parameter describing the status change.' enum: - accountClosure - damaged - endOfLife - expired - lost - other - stolen - suspectedFraud - transactionRule type: string type: description: 'Type of payment instrument. Possible value: **card**, **bankAccount**. ' enum: - bankAccount - card type: string required: - balanceAccountId - issuingCountryCode - type type: object ActiveNetworkTokensRestriction: properties: operation: description: Defines how the condition must be evaluated. type: string value: description: The number of tokens. format: int32 type: integer required: - operation type: object BrandVariantsRestriction: properties: operation: description: Defines how the condition must be evaluated. type: string value: description: "List of card brand variants.\n\nPossible values: \n\n- **mc**, **mccredit**, **mccommercialcredit_b2b**, **mcdebit**, **mcbusinessdebit**, **mcbusinessworlddebit**, **mcprepaid**, **mcmaestro**\n\n - **visa**, **visacredit**, **visadebit**, **visaprepaid**.\n\nYou can specify a rule for a generic variant. For example, to create a rule for all Mastercard payment instruments, use **mc**. The rule is applied to all payment instruments under **mc**, such as **mcbusinessdebit** and **mcdebit**.\n\n" items: type: string type: array required: - operation type: object Name: properties: firstName: description: The first name. type: string lastName: description: The last name. type: string required: - firstName - lastName type: object MerchantAcquirerPair: properties: acquirerId: description: The acquirer ID. type: string merchantId: description: The merchant identification number (MID). type: string type: object TransactionRule: properties: aggregationLevel: x-addedInVersion: '2' description: 'The level at which data must be accumulated, used in rules with `type` **velocity** or **maxUsage**. The level must be the [same or lower in hierarchy](https://docs.adyen.com/issuing/transaction-rules#accumulate-data) than the `entityKey`. If not provided, by default, the rule will accumulate data at the **paymentInstrument** level. Possible values: **paymentInstrument**, **paymentInstrumentGroup**, **balanceAccount**, **accountHolder**, **balancePlatform**.' type: string description: description: Your description for the transaction rule, maximum 300 characters. maxLength: 300 type: string endDate: description: 'The date when the rule will stop being evaluated, in ISO 8601 extended offset date-time format. For example, **2020-12-18T10:15:30+01:00**. If not provided, the rule will be evaluated until the rule status is set to **inactive**.' type: string entityKey: x-addedInVersion: '2' description: The type and unique identifier of the resource to which the rule applies. $ref: '#/components/schemas/TransactionRuleEntityKey' id: description: The unique identifier of the transaction rule. type: string interval: description: The [time interval](https://docs.adyen.com/issuing/transaction-rules#time-intervals) when the rule conditions apply. $ref: '#/components/schemas/TransactionRuleInterval' outcomeType: x-addedInVersion: '2' description: "The [outcome](https://docs.adyen.com/issuing/transaction-rules#outcome) that will be applied when a transaction meets the conditions of the rule. If not provided, by default, this is set to **hardBlock**.\n\nPossible values:\n\n * **hardBlock**: the transaction is declined.\n\n* **scoreBased**: the transaction is assigned the `score` you specified. Adyen calculates the total score and if it exceeds 100, the transaction is declined." enum: - enforceSCA - hardBlock - scoreBased type: string reference: description: Your reference for the transaction rule, maximum 150 characters. maxLength: 150 type: string requestType: x-addedInVersion: '2' description: 'Indicates the type of request to which the rule applies. If not provided, by default, this is set to **authorization**. Possible values: **authorization**, **authentication**, **tokenization**, **bankTransfer**.' enum: - authentication - authorization - bankTransfer - tokenization type: string ruleRestrictions: x-addedInVersion: '2' description: 'Contains one or more objects that define the [rule conditions](https://docs.adyen.com/issuing/transaction-rules#conditions). Each object must have a value and an operation which determines how the values must be evaluated. For example, a `countries` object can have a list of country codes **["US", "CA"]** in the `value` field and **anyMatch** in the `operation` field.' $ref: '#/components/schemas/TransactionRuleRestrictions' score: x-addedInVersion: '2' description: A positive or negative score applied to the transaction if it meets the conditions of the rule. Required when `outcomeType` is **scoreBased**. The value must be between **-100** and **100**. format: int32 type: integer startDate: description: "The date when the rule will start to be evaluated, in ISO 8601 extended offset date-time format. For example, **2020-12-18T10:15:30+01:00**.\n\nIf not provided when creating a transaction rule, the `startDate` is set to the date when the rule status is set to **active**. \n\n" type: string status: description: "The status of the transaction rule. If you provide a `startDate` in the request, the rule is automatically created \nwith an **active** status. \n\nPossible values: **active**, **inactive**." enum: - active - inactive type: string type: description: "The [type of rule](https://docs.adyen.com/issuing/transaction-rules#rule-types), which defines if a rule blocks transactions based on individual characteristics or accumulates data.\n\nPossible values:\n * **blockList**: decline a transaction when the conditions are met.\n * **maxUsage**: add the amount or number of transactions for the lifetime of a payment instrument, and then decline a transaction when the specified limits are met.\n * **velocity**: add the amount or number of transactions based on a specified time interval, and then decline a transaction when the specified limits are met.\n" enum: - allowList - blockList - maxUsage - velocity type: string required: - type - description - reference - entityKey - interval - ruleRestrictions type: object EntryModesRestriction: properties: operation: description: Defines how the condition must be evaluated. type: string value: description: 'List of point-of-sale entry modes. Possible values: **barcode**, **chip**, **cof**, **contactless**, **magstripe**, **manual**, **ocr**, **server**. ' items: enum: - barcode - chip - cof - contactless - magstripe - manual - ocr - server - unknown type: string type: array required: - operation type: object Amount: properties: currency: description: The three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes). maxLength: 3 minLength: 3 type: string value: description: The amount of the transaction, in [minor units](https://docs.adyen.com/development-resources/currency-codes). format: int64 type: integer required: - value - currency type: object TransactionRuleInterval: properties: dayOfMonth: x-addedInVersion: '2' description: The day of month, used when the `duration.unit` is **months**. If not provided, by default, this is set to **1**, the first day of the month. format: int32 type: integer dayOfWeek: x-addedInVersion: '2' description: 'The day of week, used when the `duration.unit` is **weeks**. If not provided, by default, this is set to **monday**. Possible values: **sunday**, **monday**, **tuesday**, **wednesday**, **thursday**, **friday**.' enum: - friday - monday - saturday - sunday - thursday - tuesday - wednesday type: string duration: x-addedInVersion: '2' description: The duration, which you can specify in hours, days, weeks, or months. The maximum duration is 90 days or an equivalent in other units. Required when the `type` is **rolling** or **sliding**. $ref: '#/components/schemas/Duration' timeOfDay: x-addedInVersion: '2' description: The time of day, in **hh:mm:ss** format, used when the `duration.unit` is **hours**. If not provided, by default, this is set to **00:00:00**. type: string timeZone: x-addedInVersion: '2' description: The [time zone](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones). For example, **Europe/Amsterdam**. By default, this is set to **UTC**. type: string type: description: "The [type of interval](https://docs.adyen.com/issuing/transaction-rules#time-intervals) during which the rule conditions and limits apply, and how often counters are reset.\n\nPossible values:\n * **perTransaction**: conditions are evaluated and the counters are reset for every transaction.\n * **daily**: the counters are reset daily at 00:00:00 UTC.\n * **weekly**: the counters are reset every Monday at 00:00:00 UTC. \n * **monthly**: the counters reset every first day of the month at 00:00:00 UTC. \n * **lifetime**: conditions are applied to the lifetime of the payment instrument.\n * **rolling**: conditions are applied and the counters are reset based on a `duration`. If the reset date and time are not provided, Adyen applies the default reset time similar to fixed intervals.\nFor example, if the duration is every two weeks, the counter resets every third Monday at 00:00:00 UTC.\n * **sliding**: conditions are applied and the counters are reset based on the current time and a `duration` that you specify." enum: - daily - lifetime - monthly - perTransaction - rolling - sliding - weekly type: string required: - type type: object CardInfo: properties: authentication: description: Contains the card user's password and mobile phone number. This is required when you issue cards that can be used to make online payments within the EEA and the UK, or can be added to digital wallets. Refer to [3D Secure and digital wallets](https://docs.adyen.com/issuing/3d-secure-and-wallets) for more information. $ref: '#/components/schemas/Authentication' brand: description: 'The brand of the physical or the virtual card. Possible values: **visa**, **mc**.' type: string brandVariant: description: 'The brand variant of the physical or the virtual card. For example, **visadebit** or **mcprepaid**. >Reach out to your Adyen contact to get the values relevant for your integration.' type: string cardholderName: description: "The name of the cardholder.\n Maximum length: 26 characters." maxLength: 26 type: string configuration: description: "Settings required when creating a physical or a virtual card. \n\nReach out to your Adyen contact to get the values that you can send in this object." $ref: '#/components/schemas/CardConfiguration' deliveryContact: x-addedInVersion: '2' description: The delivery contact (name and address) for physical card delivery. $ref: '#/components/schemas/DeliveryContact' formFactor: description: 'The form factor of the card. Possible values: **virtual**, **physical**.' enum: - physical - unknown - virtual type: string threeDSecure: description: 'Allocates a specific product range for either a physical or a virtual card. Possible values: **fullySupported**, **secureCorporate**. >Reach out to your Adyen contact to get the values relevant for your integration.' type: string required: - formFactor - cardholderName - brand - brandVariant type: object NetworkToken: properties: brandVariant: description: The card brand variant of the payment instrument associated with the network token. For example, **mc_prepaid_mrw**. type: string creationDate: description: Date and time when the network token was created, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) extended format. For example, **2020-12-18T10:15:30+01:00**.. format: date-time type: string device: description: Device details. $ref: '#/components/schemas/DeviceInfo' id: description: The unique identifier of the network token. type: string paymentInstrumentId: description: The unique identifier of the payment instrument to which this network token belongs to. type: string status: description: 'The status of the network token. Possible values: **active**, **inactive**, **suspended**, **closed**.' enum: - active - inactive - suspended - closed type: string tokenLastFour: description: The last four digits of the network token `id`. type: string type: description: The type of wallet the network token is associated with. For example, **applePay**. type: string type: object Phone: properties: number: description: "The full phone number provided as a single string. \nFor example, **\"0031 6 11 22 33 44\"**, **\"+316/1122-3344\"**, \n\n or **\"(0031) 611223344\"**." type: string type: description: "Type of phone number.\nPossible values: \n**Landline**, **Mobile**.\n" enum: - landline - mobile type: string required: - number - type type: object SameAmountRestriction: properties: operation: description: Defines how the condition must be evaluated. type: string value: type: boolean required: - operation type: object MerchantsRestriction: properties: operation: description: Defines how the condition must be evaluated. type: string value: description: List of merchant ID and acquirer ID pairs. items: $ref: '#/components/schemas/MerchantAcquirerPair' type: array required: - operation type: object BankIdentification: properties: country: type: string identification: type: string identificationType: enum: - iban - routingNumber type: string type: object PaymentInstrumentGroup: properties: balancePlatform: description: The unique identifier of the [balance platform](https://docs.adyen.com/api-explorer/#/balanceplatform/latest/get/balancePlatforms/{id}__queryParam_id) to which the payment instrument group belongs. type: string description: description: Your description for the payment instrument group, maximum 300 characters. maxLength: 300 type: string id: description: The unique identifier of the payment instrument group. type: string properties: additionalProperties: type: string description: Properties of the payment instrument group. type: object reference: description: Your reference for the payment instrument group, maximum 150 characters. maxLength: 150 type: string txVariant: description: The tx variant of the payment instrument group. type: string required: - balancePlatform - txVariant type: object TransactionRuleEntityKey: properties: entityReference: description: The unique identifier of the resource. type: string entityType: description: 'The type of resource. Possible values: **balancePlatform**, **paymentInstrumentGroup**, **accountHolder**, **balanceAccount**, or **paymentInstrument**.' type: string type: object PaymentInstrumentUpdateRequest: properties: balanceAccountId: description: 'The unique identifier of the balance account associated with this payment instrument. >You can only change the balance account ID if the payment instrument has **inactive** status.' type: string card: description: Object that contains information about the card payment instrument. $ref: '#/components/schemas/CardInfo' status: description: "The status of the payment instrument. If a status is not specified when creating a payment instrument, it is set to **active** by default. However, there can be exceptions for cards based on the `card.formFactor` and the `issuingCountryCode`. For example, when issuing physical cards in the US, the default status is **inactive**.\n\nPossible values: \n\n * **active**: The payment instrument is active and can be used to make payments. \n\n * **inactive**: The payment instrument is inactive and cannot be used to make payments. \n\n * **suspended**: The payment instrument is suspended, either because it was stolen or lost. \n\n * **closed**: The payment instrument is permanently closed. This action cannot be undone. \n\n" enum: - active - closed - inactive - suspended type: string statusComment: description: 'Comment for the status of the payment instrument. Required if `statusReason` is **other**.' type: string statusReason: x-addedInVersion: '2' description: 'The reason for updating the status of the payment instrument. Possible values: **lost**, **stolen**, **damaged**, **suspectedFraud**, **expired**, **endOfLife**, **accountClosure**, **other**. If the reason is **other**, you must also send the `statusComment` parameter describing the status change.' enum: - accountClosure - damaged - endOfLife - expired - lost - other - stolen - suspectedFraud - transactionRule type: string type: object MatchingTransactionsRestriction: properties: operation: description: Defines how the condition must be evaluated. type: string value: description: The number of transactions. format: int32 type: integer required: - operation type: object MccsRestriction: properties: operation: description: Defines how the condition must be evaluated. type: string value: description: List of merchant category codes (MCCs). items: type: string type: array required: - operation type: object PaymentInstrumentGroupInfo: properties: balancePlatform: description: The unique identifier of the [balance platform](https://docs.adyen.com/api-explorer/#/balanceplatform/latest/get/balancePlatforms/{id}__queryParam_id) to which the payment instrument group belongs. type: string description: description: Your description for the payment instrument group, maximum 300 characters. maxLength: 300 type: string properties: additionalProperties: type: string description: Properties of the payment instrument group. type: object reference: description: Your reference for the payment instrument group, maximum 150 characters. maxLength: 150 type: string txVariant: description: The tx variant of the payment instrument group. type: string required: - balancePlatform - txVariant type: object securitySchemes: ApiKeyAuth: in: header name: X-API-Key type: apiKey BasicAuth: scheme: basic type: http x-groups: - Account holders - Accounts - Verification