Adyen Balance API

openapi: 3.2.0
info:
  title: Adyen Balance API
  contact:
    name: Adyen Developer Experience team
    url: https://github.com/Adyen/adyen-openapi
  termsOfService: https://www.adyen.com/legal/terms-and-conditions
  x-publicVersion: true
  version: '1.0'
  description: 'Operations tagged Balance across 3 of this provider''s published API definitions: adyen-balance-control-api-openapi.yml, adyen-checkout-api-openapi.yml, adyen-configuration-api-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://pal-test.adyen.com/pal/servlet/BalanceControl/v1
- url: https://checkout-test.adyen.com/v71
- url: https://balanceplatform-api-test.adyen.com/bcl/v2
tags:
- name: Balance
paths:
  /balanceTransfer:
    post:
      tags:
      - Balance
      summary: Adyen Start a Balance Transfer
      description: 'Starts a balance transfer request between merchant accounts. The following conditions must be met before you can successfully transfer balances:


        * The source and destination merchant accounts must be under the same company account and legal entity.


        * The source merchant account must have sufficient funds.


        * The source and destination merchant accounts must have at least one common processing currency.


        When sending multiple API requests with the same source and destination merchant accounts, send the requests sequentially and *not* in parallel. Some requests may not be processed if the requests are sent in parallel.

        '
      operationId: post-balanceTransfer
      x-groupName: General
      x-sortIndex: 0
      x-methodName: balanceTransfer
      security:
      - BasicAuth: []
      - ApiKeyAuth: []
      requestBody:
        content:
          application/json:
            examples:
              post-balance-transfer:
                $ref: '#/components/examples/post-balanceTransfer-post-balance-transfer'
            schema:
              $ref: '#/components/schemas/BalanceTransferRequest'
      responses:
        '200':
          content:
            application/json:
              examples:
                post-balance-transfer:
                  $ref: '#/components/examples/post-balanceTransfer-post-balance-transfer-200'
              schema:
                $ref: '#/components/schemas/BalanceTransferResponse'
          description: OK - the request has succeeded.
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    servers:
    - url: https://pal-test.adyen.com/pal/servlet/BalanceControl/v1
  /paymentMethods/balance:
    post:
      tags:
      - Balance
      summary: Adyen Get the Balance of a Gift Card
      description: Retrieves the balance remaining on a shopper's gift card. To check a gift card's balance, make a POST `/paymentMethods/balance` call and include the gift card's details inside a `paymentMethod` object.
      operationId: post-paymentMethods-balance
      x-sortIndex: 1
      x-methodName: getBalanceOfGiftCard
      security:
      - BasicAuth: []
      - ApiKeyAuth: []
      requestBody:
        content:
          application/json:
            examples:
              basic:
                $ref: '#/components/examples/post-paymentMethods-balance-basic'
              not-enough:
                $ref: '#/components/examples/post-paymentMethods-balance-not-enough'
            schema:
              $ref: '#/components/schemas/BalanceCheckRequest'
      parameters:
      - $ref: '#/components/parameters/Idempotency-Key'
      responses:
        '200':
          content:
            application/json:
              examples:
                basic:
                  $ref: '#/components/examples/post-paymentMethods-balance-basic-200'
                not-enough:
                  $ref: '#/components/examples/post-paymentMethods-balance-not-enough-200'
              schema:
                $ref: '#/components/schemas/BalanceCheckResponse'
          description: OK - the request has succeeded.
          headers:
            Idempotency-Key:
              $ref: '#/components/headers/Idempotency-Key'
        '400':
          content:
            application/json:
              examples:
                generic:
                  $ref: '#/components/examples/generic-400'
              schema:
                $ref: '#/components/schemas/ServiceError'
          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/ServiceError'
          description: Unauthorized - authentication required.
        '403':
          content:
            application/json:
              examples:
                generic:
                  $ref: '#/components/examples/generic-403'
              schema:
                $ref: '#/components/schemas/ServiceError'
          description: Forbidden - insufficient permissions to process the request.
        '422':
          content:
            application/json:
              examples:
                generic:
                  $ref: '#/components/examples/generic-422'
              schema:
                $ref: '#/components/schemas/ServiceError'
          description: Unprocessable Entity - a request validation error.
          headers:
            Idempotency-Key:
              $ref: '#/components/headers/Idempotency-Key'
        '500':
          content:
            application/json:
              examples:
                generic:
                  $ref: '#/components/examples/generic-500'
              schema:
                $ref: '#/components/schemas/ServiceError'
          description: Internal Server Error - the server could not process the request.
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    servers:
    - url: https://checkout-test.adyen.com/v71
  /balancePlatforms/{id}:
    get:
      tags:
      - Balance
      summary: Adyen Get a Balance Platform
      description: Returns a balance platform.
      x-addedInVersion: '1'
      operationId: get-balancePlatforms-id
      x-sortIndex: 1
      x-methodName: getBalancePlatform
      security:
      - clientKey: []
      - BasicAuth: []
      - ApiKeyAuth: []
      parameters:
      - description: The unique identifier of the balance platform.
        name: id
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              examples:
                success:
                  $ref: '#/components/examples/get-balancePlatforms-id-success-200'
              schema:
                $ref: '#/components/schemas/BalancePlatform'
          description: OK - the request has succeeded.
        '400':
          content:
            application/json:
              examples:
                generic:
                  $ref: '#/components/examples/generic-400_2'
              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_2'
              schema:
                $ref: '#/components/schemas/RestServiceError'
          description: Unauthorized - authentication required.
        '403':
          content:
            application/json:
              examples:
                generic:
                  $ref: '#/components/examples/generic-403_2'
              schema:
                $ref: '#/components/schemas/RestServiceError'
          description: Forbidden - insufficient permissions to process the request.
        '422':
          content:
            application/json:
              examples:
                generic:
                  $ref: '#/components/examples/generic-422_2'
              schema:
                $ref: '#/components/schemas/RestServiceError'
          description: Unprocessable Entity - a request validation error.
        '500':
          content:
            application/json:
              examples:
                generic:
                  $ref: '#/components/examples/generic-500_2'
              schema:
                $ref: '#/components/schemas/RestServiceError'
          description: Internal Server Error - the server could not process the request.
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    servers:
    - url: https://balanceplatform-api-test.adyen.com/bcl/v2
components:
  schemas:
    BalanceTransferResponse:
      properties:
        amount:
          description: The amount of the transfer in [minor units](https://docs.adyen.com/development-resources/currency-codes).
          $ref: '#/components/schemas/Amount'
        createdAt:
          description: The date when the balance transfer was requested.
          format: date-time
          type: string
        description:
          description: A human-readable description for the transfer. You can use alphanumeric characters and hyphens. We recommend sending a maximum of 140 characters, otherwise the description may be truncated.
          maxLength: 140
          type: string
        fromMerchant:
          description: The unique identifier of the source merchant account from which funds are deducted.
          type: string
        pspReference:
          description: Adyen's 16-character string reference associated with the balance transfer.
          type: string
        reference:
          description: 'A reference for the balance transfer. If you don''t provide this in the request, Adyen generates a unique reference.

            Maximum length: 80 characters.'
          maxLength: 80
          type: string
        status:
          description: 'The status of the balance transfer. Possible values: **transferred**, **failed**, **error**, and **notEnoughBalance**.'
          enum:
          - error
          - failed
          - notEnoughBalance
          - transferred
          type: string
        toMerchant:
          description: The unique identifier of the destination merchant account from which funds are transferred.
          type: string
        type:
          description: 'The type of balance transfer. Possible values: **tax**, **fee**, **terminalSale**, **credit**, **debit**, and **adjustment**.'
          enum:
          - tax
          - fee
          - terminalSale
          - credit
          - debit
          - adjustment
          type: string
      required:
      - amount
      - fromMerchant
      - toMerchant
      - type
      - pspReference
      - status
      - createdAt
      type: object
    BalanceTransferRequest:
      properties:
        amount:
          description: The amount of the transfer in [minor units](https://docs.adyen.com/development-resources/currency-codes).
          $ref: '#/components/schemas/Amount'
        description:
          description: A human-readable description for the transfer. You can use alphanumeric characters and hyphens. We recommend sending a maximum of 140 characters, otherwise the description may be truncated.
          maxLength: 140
          type: string
        fromMerchant:
          description: The unique identifier of the source merchant account from which funds are deducted.
          type: string
        reference:
          description: 'A reference for the balance transfer. If you don''t provide this in the request, Adyen generates a unique reference.

            Maximum length: 80 characters.'
          maxLength: 80
          type: string
        toMerchant:
          description: The unique identifier of the destination merchant account from which funds are transferred.
          type: string
        type:
          description: 'The type of balance transfer. Possible values: **tax**, **fee**, **terminalSale**, **credit**, **debit**, and **adjustment**.'
          enum:
          - tax
          - fee
          - terminalSale
          - credit
          - debit
          - adjustment
          type: string
      required:
      - amount
      - fromMerchant
      - toMerchant
      - type
      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
    ServiceError:
      properties:
        additionalData:
          x-addedInVersion: '46'
          additionalProperties:
            type: string
          description: Contains additional information about the payment. Some data fields are included only if you select them first. Go to **Customer Area** > **Developers** > **Additional data**.
          type: object
        errorCode:
          description: The error code mapped to the error message.
          type: string
        errorType:
          description: The category of the error.
          type: string
        message:
          description: A short explanation of the issue.
          type: string
        pspReference:
          description: The PSP reference of the payment.
          type: string
        status:
          description: The HTTP response status.
          format: int32
          type: integer
      type: object
    AdditionalData3DSecure:
      properties:
        allow3DS2:
          deprecated: true
          x-deprecatedInVersion: '69'
          x-deprecatedMessage: Use `authenticationData.threeDSRequestData.nativeThreeDS` instead.
          description: "Indicates if you are able to process 3D Secure 2 transactions natively on your payment page. Send this parameter when you are using `/payments` endpoint with any of our [native 3D Secure 2 solutions](https://docs.adyen.com/online-payments/3d-secure/native-3ds2).\n\n > This parameter only indicates readiness to support native 3D Secure 2 authentication. To specify if you _want_ to perform 3D Secure, use [Dynamic 3D Secure](/risk-management/dynamic-3d-secure)\nor send the `executeThreeD` parameter.\nPossible values:\n* **true** - Ready to support native 3D Secure 2 authentication. Setting this to true does not mean always applying 3D Secure 2. Adyen still selects the version of 3D Secure based on configuration to optimize authorisation rates and improve the shopper's experience.\n* **false**  Not ready to support native 3D Secure 2 authentication. Adyen will not offer 3D Secure 2 to your shopper regardless of your configuration.\n"
          type: string
        challengeWindowSize:
          description: "Dimensions of the 3DS2 challenge window to be displayed to the cardholder.\n\nPossible values:\n\n* **01** - size of 250x400 \n* **02** - size of 390x400\n* **03** - size of 500x600\n* **04** - size of 600x400\n* **05** - Fullscreen"
          enum:
          - '01'
          - '02'
          - '03'
          - '04'
          - '05'
          type: string
        executeThreeD:
          deprecated: true
          x-deprecatedInVersion: '69'
          x-deprecatedMessage: Use [`authenticationData.attemptAuthentication`](https://docs.adyen.com/api-explorer/Checkout/latest/post/payments?target=_blank#request-authenticationData-attemptAuthentication) instead
          description: "Indicates if you want to perform 3D Secure authentication on a transaction.\n\n > Alternatively, you can use [Dynamic 3D Secure](/risk-management/dynamic-3d-secure) to configure rules for applying 3D Secure.\n\nPossible values:\n* **true**  Perform 3D Secure authentication.\n* **false**  Don't perform 3D Secure authentication. Note that this setting results in refusals if the issuer mandates 3D Secure because of the PSD2 directive  or other, national regulations. \n"
          type: string
        mpiImplementationType:
          description: In case of Secure+, this field must be set to **CUPSecurePlus**.
          type: string
        scaExemption:
          description: "Indicates the [exemption type](https://docs.adyen.com/payments-fundamentals/psd2-sca-compliance-and-implementation-guide#specifypreferenceinyourapirequest) that you want to request for the transaction.\n\n Possible values:\n* **lowValue** \n* **secureCorporate** \n* **trustedBeneficiary** \n* **transactionRiskAnalysis** "
          type: string
        threeDSVersion:
          description: "Indicates your preference for the 3D Secure version. \n> If you use this parameter, you override the checks from Adyen's Authentication Engine. We recommend to use this field only if you have an extensive knowledge of 3D Secure.\n\nPossible values:\n* **1.0.2**: Apply 3D Secure version 1.0.2. \n* **2.1.0**: Apply 3D Secure version 2.1.0. \n* **2.2.0**: Apply 3D Secure version 2.2.0. If the issuer does not support version 2.2.0, we will fall back to 2.1.0.\n\nThe following rules apply:\n* If you prefer 2.1.0 or 2.2.0 but we receive a negative `transStatus` in the `ARes`, we will apply the fallback policy configured in your account. For example, if the configuration is to fall back to 3D Secure 1, we will apply version 1.0.2.\n* If you prefer 2.1.0 or 2.2.0 but the BIN is not enrolled, you will receive an error.\n\n"
          type: string
      type: object
    MerchantDevice:
      properties:
        os:
          description: Operating system running on the merchant device.
          type: string
        osVersion:
          description: Version of the operating system on the merchant device.
          type: string
        reference:
          description: Merchant device reference.
          type: string
      type: object
    ResponseAdditionalDataSepa:
      properties:
        sepadirectdebit.dateOfSignature:
          description: 'The transaction signature date.


            Format: yyyy-MM-dd'
          type: string
        sepadirectdebit.mandateId:
          description: Its value corresponds to the pspReference value of the transaction.
          type: string
        sepadirectdebit.sequenceType:
          description: 'This field can take one of the following values:

            * OneOff: (OOFF) Direct debit instruction to initiate exactly one direct debit transaction.


            * First: (FRST) Initial/first collection in a series of direct debit instructions.

            * Recurring: (RCUR) Direct debit instruction to carry out regular direct debit transactions initiated by the creditor.

            * Final: (FNAL) Last/final collection in a series of direct debit instructions.


            Example: OOFF'
          type: string
      type: object
    Installments:
      properties:
        plan:
          x-addedInVersion: '64'
          description: 'The installment plan, used for [card installments in Japan](https://docs.adyen.com/payment-methods/cards/credit-card-installments#make-a-payment-japan). By default, this is set to **regular**. Possible values:

            * **regular**

            * **revolving**

            '
          enum:
          - regular
          - revolving
          type: string
        value:
          description: 'Defines the number of installments. Its value needs to be greater than zero.


            Usually, the maximum allowed number of installments is capped. For example, it may not be possible to split a payment in more than 24 installments. The acquirer sets this upper limit, so its value may vary.'
          format: int32
          type: integer
      required:
      - value
      type: object
    AdditionalDataRiskStandalone:
      properties:
        PayPal.CountryCode:
          description: Shopper's country of residence in the form of ISO standard 3166 2-character country codes.
          type: string
        PayPal.EmailId:
          description: Shopper's email.
          type: string
        PayPal.FirstName:
          description: Shopper's first name.
          type: string
        PayPal.LastName:
          description: Shopper's last name.
          type: string
        PayPal.PayerId:
          description: 'Unique PayPal Customer Account identification number. Character length and limitations: 13 single-byte alphanumeric characters.'
          type: string
        PayPal.Phone:
          description: Shopper's phone number.
          type: string
        PayPal.ProtectionEligibility:
          description: 'Allowed values:

            * **Eligible**  Merchant is protected by PayPal''s Seller Protection Policy for Unauthorized Payments and Item Not Received.


            * **PartiallyEligible**  Merchant is protected by PayPal''s Seller Protection Policy for Item Not Received.


            * **Ineligible**  Merchant is not protected under the Seller Protection Policy.'
          type: string
        PayPal.TransactionId:
          description: Unique transaction ID of the payment.
          type: string
        avsResultRaw:
          description: 'Raw AVS result received from the acquirer, where available. Example: D'
          type: string
        bin:
          description: The Bank Identification Number of a credit card, which is the first six digits of a card number. Required for [tokenized card request](https://docs.adyen.com/risk-management/standalone-risk#tokenised-pan-request).
          type: string
        cvcResultRaw:
          description: 'Raw CVC result received from the acquirer, where available. Example: 1'
          type: string
        riskToken:
          description: Unique identifier or token for the shopper's card details.
          type: string
        threeDAuthenticated:
          description: 'A Boolean value indicating whether 3DS authentication was completed on this payment. Example: true'
          type: string
        threeDOffered:
          description: 'A Boolean value indicating whether 3DS was offered for this payment. Example: true'
          type: string
        tokenDataType:
          description: 'Required for PayPal payments only. The only supported value is: **paypal**.'
          type: string
      type: object
    AcctInfo:
      properties:
        chAccAgeInd:
          description: "Length of time that the cardholder has had the account with the 3DS Requestor. \nAllowed values:\n* **01**  No account\n* **02**  Created during this transaction\n* **03**  Less than 30 days\n* **04**  3060 days\n* **05**  More than 60 days"
          enum:
          - '01'
          - '02'
          - '03'
          - '04'
          - '05'
          maxLength: 2
          minLength: 2
          type: string
        chAccChange:
          description: "Date that the cardholders account with the 3DS Requestor was last changed, including Billing or Shipping address, new payment account, or new user(s) added. \nFormat: **YYYYMMDD**"
          type: string
        chAccChangeInd:
          description: "Length of time since the cardholders account information with the 3DS Requestor was last changed, including Billing or Shipping address, new payment account, or new user(s) added. \nAllowed values:\n* **01**  Changed during this transaction\n* **02**  Less than 30 days\n* **03**  3060 days\n* **04**  More than 60 days"
          enum:
          - '01'
          - '02'
          - '03'
          - '04'
          maxLength: 2
          minLength: 2
          type: string
        chAccPwChange:
          description: "Date that cardholders account with the 3DS Requestor had a password change or account reset. \nFormat: **YYYYMMDD**"
          type: string
        chAccPwChangeInd:
          description: "Indicates the length of time since the cardholders account with the 3DS Requestor had a password change or account reset. \nAllowed values:\n* **01**  No change\n* **02**  Changed during this transaction\n* **03**  Less than 30 days\n* **04**  3060 days\n* **05**  More than 60 days"
          enum:
          - '01'
          - '02'
          - '03'
          - '04'
          - '05'
          maxLength: 2
          minLength: 2
          type: string
        chAccString:
          description: "Date that the cardholder opened the account with the 3DS Requestor. \nFormat: **YYYYMMDD**"
          type: string
        nbPurchaseAccount:
          description: 'Number of purchases with this cardholder account during the previous six months. Max length: 4 characters.'
          type: string
        paymentAccAge:
          description: "String that the payment account was enrolled in the cardholders account with the 3DS Requestor. \nFormat: **YYYYMMDD**"
          type: string
        paymentAccInd:
          description: "Indicates the length of time that the payment account was enrolled in the cardholders account with the 3DS Requestor. \nAllowed values:\n* **01**  No account (guest checkout)\n* **02**  During this transaction\n* **03**  Less than 30 days\n* **04**  3060 days\n* **05**  More than 60 days"
          enum:
          - '01'
          - '02'
          - '03'
          - '04'
          - '05'
          maxLength: 2
          minLength: 2
          type: string
        provisionAttemptsDay:
          description: 'Number of Add Card attempts in the last 24 hours. Max length: 3 characters.'
          type: string
        shipAddressUsage:
          description: "String when the shipping address used for this transaction was first used with the 3DS Requestor. \nFormat: **YYYYMMDD**"
          type: string
        shipAddressUsageInd:
          description: "Indicates when the shipping address used for this transaction was first used with the 3DS Requestor. \nAllowed values:\n* **01**  This transaction\n* **02**  Less than 30 days\n* **03**  3060 days\n* **04**  More than 60 days"
          enum:
          - '01'
          - '02'
          - '03'
          - '04'
          maxLength: 2
          minLength: 2
          type: string
        shipNameIndicator:
          description: "Indicates if the Cardholder Name on the account is identical to the shipping Name used for this transaction. \nAllowed values:\n* **01**  Account Name identical to shipping Name\n* **02**  Account Name different to shipping Name"
          enum:
          - '01'
          - '02'
          maxLength: 2
          minLength: 2
          type: string
        suspiciousAccActivity:
          description: "Indicates whether the 3DS Requestor has experienced suspicious activity (including previous fraud) on the cardholder account. \nAllowed values:\n* **01**  No suspicious activity has been observed\n* **02**  Suspicious activity has been observed"
          enum:
          - '01'
          - '02'
          maxLength: 2
          minLength: 2
          type: string
        txnActivityDay:
          description: 'Number of transactions (successful and abandoned) for this cardholder account with the 3DS Requestor across all payment accounts in the previous 24 hours. Max length: 3 characters.'
          maxLength: 3
          type: string
        txnActivityYear:
          description: 'Number of transactions (successful and abandoned) for this cardholder account with the 3DS Requestor across all payment accounts in the previous year. Max length: 3 characters.'
          maxLength: 3
          type: string
      type: object
    ResponseAdditionalDataNetworkTokens:
      properties:
        networkToken.available:
          description: Indicates whether a network token is available for the specified card.
          type: string
        networkToken.bin:
          description: The Bank Identification Number of a tokenized card, which is the first six digits of a card number.
          type: string
        networkToken.tokenSummary:
          description: The last four digits of a network token.
          type: string
      type: object
    AdditionalDataCarRental:
      properties:
        carRental.checkOutDate:
          description: 'The pick-up date.

            * Date format: `yyyyMMdd`'
          type: string
        carRental.customerServiceTollFreeNumber:
          description: 'The customer service phone number of the car rental company.

            * Format: Alphanumeric

            * maxLength: 17

            * For US and CA numbers must be 10 characters in length

            * Must not start with a space

            * Must not contain any special characters such as + or -

            *Must not be all zeros.'
          type: string
        carRental.daysRented:
          description: 'Number of days for which the car is being rented.

            * Format: Numeric

            * maxLength: 4

            * Must not be all spaces'
          type: string
        carRental.fuelCharges:
          description: 'Any fuel charges associated with the rental, in [minor units](https://docs.adyen.com/development-resources/currency-codes).

            * Format: Numeric

            * maxLength: 12'
          type: string
        carRental.insuranceCharges:
          description: 'Any insurance charges associated with the rental, in [minor units](https://docs.adyen.com/development-resources/currency-codes).

            * Format: Numeric

            * maxLength: 12

            * Must not be all spaces

            *Must not be all zeros.'
          type: string
        carRental.locationCity:
          description: 'The city where the car is rented.

            * Format: Alphanumeric

            * maxLength: 18

            * Must not start with a space or be all spaces

            *Must not be all zeros.'
          type: string
        carRental.locationCountry:
          description: 'The country where the car is rented, in [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) format.

            * Format: Alphanumeric

            * maxLength: 2'
          type: string
        carRental.locationStateProvince:
          description: 'The state or province where the car is rented.

            * Format: Alphanumeric

            * maxLength: 2

            * Must not start with a space or be all spaces

            *Must not be all zeros.'
          type: string
        carRental.noShowIndicator:
          description: 'Indicates if the customer didn''t pick up their rental car.

            * Y - Customer did not pick up their car

            * N - Not applicable'
          type: string
        carRental.oneWayDropOffCharges:
          description: 'The charge for not returning a car to the original rental location, in [minor units](https://docs.adyen.com/development-resources/currency-codes).

            * maxLength: 12'
          type: string
        carRental.rate:
          description: 'The daily rental rate, in [minor units](https://docs.adyen.com/development-resources/currency-codes).

            * Format: Alphanumeric

            * maxLength: 12'
          type: string
        carRental.rateIndicator:
          description: 'Specifies whether the given rate is applied daily or weekly.

            * D - Daily rate

            * W - Weekly rate'
          type: string
        carRental.rentalAgreementNumber:
          description: 'The rental agreement number for the car rental.

            * Format: Alphanumeric

            * maxLength: 9

            * Must not start with a space or be all spaces

            *Must not be all zeros.'
          type: string
        carRental.rentalClassId:
          description: 'The classification of the rental car.

            * Format: Alphanumeric

            * maxLength: 4

            * Must not start with a space or be all spaces

            *Must not be all zeros.'
          type: string
        carRental.renterName:
          description: 'The name of the person renting the car.

            * Format: Alphanumeric

            * maxLength: 26

            * If you send more than 26 characters, the name is truncated

            * Must not start with a space or be all spaces

            *Must not be all zeros.'
          type: string
        carRental.returnCity:
          description: 'The city where the car must be returned.

            * Format: Alphanumeric

            * maxLength: 18

            * Must not start with a space or be all spaces

            *Must not be all zeros.'
          type: string
        carRental.returnCountry:
          description: 'The country where the car must be returned, in [ISO 3166-1 alpha-2](https://en.wikipedi

# --- truncated at 32 KB (161 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/adyen/refs/heads/main/openapi/adyen-balance-api-openapi.yml