openapi: 3.2.0
info:
  title: Gr4vy Merchant accounts - 3DS configuration API
  description: The Gr4vy API.
  version: 1.0.0
tags:
- name: Merchant accounts - 3DS configuration
  description: Manage 3DS profiles for merchant accounts.
paths:
  /merchant-accounts/{merchant_account_id}/three-ds-configurations:
    post:
      tags:
      - Merchant accounts - 3DS configuration
      summary: Create 3DS configuration for merchant
      description: Create a new 3DS configuration for a merchant account.
      operationId: create_three_ds_configuration
      security:
      - OAuth2PasswordBearer:
        - merchant-accounts.write
      parameters:
      - name: merchant_account_id
        in: path
        required: true
        schema:
          type: string
          description: The ID of the merchant account.
          examples:
          - merchant-12345
          title: Merchant Account Id
        description: The ID of the merchant account.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/MerchantAccountThreeDSConfigurationCreate'
      responses:
        '201':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MerchantAccountThreeDSConfiguration'
        '400':
          description: The request was invalid.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error400'
        '401':
          description: The request was unauthorized.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error401'
        '403':
          description: The credentials were invalid or the caller did not have permission to act on the resource.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error403'
        '404':
          description: The resource was not found.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error404'
        '405':
          description: The request method was not allowed.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error405'
        '409':
          description: A duplicate record was found.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error409'
        '425':
          description: The request was too early.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error425'
        '429':
          description: Too many requests were made.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error429'
        '500':
          description: The server encountered an error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error500'
        '502':
          description: The server encountered an error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error502'
        '504':
          description: The server encountered an error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error504'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      x-speakeasy-name-override: create
      x-speakeasy-group: merchant-accounts.three-ds-configuration
    get:
      tags:
      - Merchant accounts - 3DS configuration
      summary: List 3DS configurations for merchant
      description: List all 3DS configurations for a merchant account.
      operationId: list_three_ds_configurations
      security:
      - OAuth2PasswordBearer:
        - merchant-accounts.read
      parameters:
      - name: merchant_account_id
        in: path
        required: true
        schema:
          type: string
          description: The ID of the merchant account.
          examples:
          - merchant-12345
          title: Merchant Account Id
        description: The ID of the merchant account.
      - name: currency
        in: query
        required: false
        schema:
          anyOf:
          - type: string
            pattern: ^[A-Z]{3}$
            examples:
            - EUR
            - GBP
            - USD
          - type: 'null'
          description: ISO 4217 currency code (3 characters) to filter 3DS configurations.
          examples:
          - USD
          - EUR
          - GBP
          title: Currency
        description: ISO 4217 currency code (3 characters) to filter 3DS configurations.
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MerchantAccountThreeDSConfigurations'
        '400':
          description: The request was invalid.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error400'
        '401':
          description: The request was unauthorized.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error401'
        '403':
          description: The credentials were invalid or the caller did not have permission to act on the resource.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error403'
        '404':
          description: The resource was not found.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error404'
        '405':
          description: The request method was not allowed.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error405'
        '409':
          description: A duplicate record was found.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error409'
        '425':
          description: The request was too early.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error425'
        '429':
          description: Too many requests were made.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error429'
        '500':
          description: The server encountered an error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error500'
        '502':
          description: The server encountered an error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error502'
        '504':
          description: The server encountered an error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error504'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      x-speakeasy-name-override: list
      x-speakeasy-group: merchant-accounts.three-ds-configuration
  /merchant-accounts/{merchant_account_id}/three-ds-configurations/{three_ds_configuration_id}:
    put:
      tags:
      - Merchant accounts - 3DS configuration
      summary: Edit 3DS configuration
      description: Update the 3DS configuration for a merchant account.
      operationId: edit_three_ds_configuration
      security:
      - OAuth2PasswordBearer:
        - merchant-accounts.write
      parameters:
      - name: merchant_account_id
        in: path
        required: true
        schema:
          type: string
          description: The ID of the merchant account.
          examples:
          - merchant-12345
          title: Merchant Account Id
        description: The ID of the merchant account.
      - name: three_ds_configuration_id
        in: path
        required: true
        schema:
          type: string
          format: uuid
          description: The ID of the 3DS configuration for a merchant account.
          examples:
          - 1808f5e6-b49c-4db9-94fa-22371ea352f5
          title: Three Ds Configuration Id
        description: The ID of the 3DS configuration for a merchant account.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/MerchantAccountThreeDSConfigurationUpdate'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MerchantAccountThreeDSConfiguration'
        '400':
          description: The request was invalid.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error400'
        '401':
          description: The request was unauthorized.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error401'
        '403':
          description: The credentials were invalid or the caller did not have permission to act on the resource.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error403'
        '404':
          description: The resource was not found.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error404'
        '405':
          description: The request method was not allowed.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error405'
        '409':
          description: A duplicate record was found.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error409'
        '425':
          description: The request was too early.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error425'
        '429':
          description: Too many requests were made.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error429'
        '500':
          description: The server encountered an error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error500'
        '502':
          description: The server encountered an error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error502'
        '504':
          description: The server encountered an error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error504'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      x-speakeasy-name-override: update
      x-speakeasy-group: merchant-accounts.three-ds-configuration
    delete:
      tags:
      - Merchant accounts - 3DS configuration
      summary: Delete 3DS configuration for a merchant
      description: Delete a 3DS configuration for a merchant account.
      operationId: delete_three_ds_configuration
      security:
      - OAuth2PasswordBearer:
        - merchant-accounts.write
      parameters:
      - name: merchant_account_id
        in: path
        required: true
        schema:
          type: string
          description: The ID of the merchant account.
          examples:
          - merchant-12345
          title: Merchant Account Id
        description: The ID of the merchant account.
      - name: three_ds_configuration_id
        in: path
        required: true
        schema:
          type: string
          format: uuid
          description: The ID of the 3DS configuration for a merchant account.
          examples:
          - 1808f5e6-b49c-4db9-94fa-22371ea352f5
          title: Three Ds Configuration Id
        description: The ID of the 3DS configuration for a merchant account.
      responses:
        '204':
          description: Successful Response
        '400':
          description: The request was invalid.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error400'
        '401':
          description: The request was unauthorized.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error401'
        '403':
          description: The credentials were invalid or the caller did not have permission to act on the resource.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error403'
        '404':
          description: The resource was not found.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error404'
        '405':
          description: The request method was not allowed.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error405'
        '409':
          description: A duplicate record was found.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error409'
        '425':
          description: The request was too early.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error425'
        '429':
          description: Too many requests were made.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error429'
        '500':
          description: The server encountered an error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error500'
        '502':
          description: The server encountered an error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error502'
        '504':
          description: The server encountered an error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error504'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      x-speakeasy-name-override: delete
      x-speakeasy-group: merchant-accounts.three-ds-configuration
components:
  schemas:
    MerchantAccountThreeDSConfiguration:
      properties:
        merchant_acquirer_bin:
          type: string
          maxLength: 11
          title: Merchant Acquirer Bin
          description: Acquirer BIN to use when calling 3DS through this scheme.
          examples:
          - '516327'
        merchant_acquirer_id:
          type: string
          maxLength: 35
          title: Merchant Acquirer Id
          description: Merchant ID to use when calling 3DS through this scheme.
          examples:
          - '123456789012345'
        merchant_name:
          type: string
          maxLength: 40
          title: Merchant Name
          description: ''
          examples:
          - Acme Inc.
        merchant_country_code:
          type: string
          title: Merchant Country Code
          description: The merchant's ISO 3166-1 numeric country code.
          examples:
          - '840'
        merchant_category_code:
          type: string
          maxLength: 4
          minLength: 4
          title: Merchant Category Code
          description: Merchant category code to use when calling 3DS through this scheme.
          examples:
          - '1234'
        merchant_url:
          type: string
          title: Merchant Url
          description: URL to send when calling 3DS through this scheme.
          examples:
          - https://example.com
        type:
          type: string
          const: merchant-account.three-ds-configuration
          title: Type
          description: Always `merchant-account.three-ds-configuration`.
          default: merchant-account.three-ds-configuration
          examples:
          - merchant-account.three-ds-configuration
        id:
          type: string
          format: uuid
          title: Id
          description: Unique identifier for the 3DS configuration
        merchant_account_id:
          type: string
          title: Merchant Account Id
          description: ID of the associated merchant account
        created_at:
          type: string
          format: date-time
          title: Created At
          description: The date and time when this 3DS configuration was first created in our system.
          examples:
          - '2013-07-16T19:23:00.000+00:00'
        updated_at:
          type: string
          format: date-time
          title: Updated At
          description: The date and time when this 3DS configuration was last updated in our system.
          examples:
          - '2013-07-16T19:23:00.000+00:00'
        scheme:
          $ref: '#/components/schemas/CardScheme'
          description: The card scheme for this 3DS configuration
        currency:
          anyOf:
          - type: string
            pattern: ^[A-Z]{3}$
            examples:
            - EUR
            - GBP
            - USD
          - type: 'null'
          title: Currency
          description: ISO 4217 currency code (3 characters). If null, the configuration applies to all currencies.
          examples:
          - USD
          - EUR
          - GBP
        metadata:
          additionalProperties:
            type: string
          type: object
          title: Metadata
          description: Additional information about the 3DS configuration, stored as key-value pairs.
      additionalProperties: false
      type: object
      required:
      - merchant_acquirer_bin
      - merchant_acquirer_id
      - merchant_name
      - merchant_country_code
      - merchant_category_code
      - merchant_url
      - id
      - merchant_account_id
      - created_at
      - updated_at
      - scheme
      - currency
      - metadata
      title: MerchantAccountThreeDSConfiguration
    Error401:
      properties:
        type:
          type: string
          const: error
          title: Type
          description: Always `error`.
          default: error
          examples:
          - error
        code:
          type: string
          title: Code
          description: Always `unauthorized`
          default: unauthorized
          examples:
          - unauthorized
        status:
          type: integer
          title: Status
          description: Always `401`.
          default: 401
          examples:
          - 401
        message:
          type: string
          title: Message
          description: A human readable message that provides more context to the error.
          default: No valid API authentication found
          examples:
          - No valid API authentication found
        details:
          items:
            $ref: '#/components/schemas/ErrorDetail'
          type: array
          title: Details
          description: A list of details that further ellaborate on the error.
          default: []
      additionalProperties: false
      type: object
      title: Error401
    Error404:
      properties:
        type:
          type: string
          const: error
          title: Type
          description: Always `error`.
          default: error
          examples:
          - error
        code:
          type: string
          title: Code
          description: Always `not_found`
          default: not_found
          examples:
          - not_found
        status:
          type: integer
          title: Status
          description: Always `404`.
          default: 404
          examples:
          - 404
        message:
          type: string
          title: Message
          description: A human readable message that provides more context to the error.
          default: The resource could not be found
          examples:
          - The resource could not be found
        details:
          items:
            $ref: '#/components/schemas/ErrorDetail'
          type: array
          title: Details
          description: A list of details that further ellaborate on the error.
          default: []
      additionalProperties: false
      type: object
      title: Error404
    ErrorLocation:
      type: string
      enum:
      - query
      - body
      - path
      - header
      - unknown
      title: ErrorLocation
    Error425:
      properties:
        type:
          type: string
          const: error
          title: Type
          description: Always `error`.
          default: error
          examples:
          - error
        code:
          type: string
          title: Code
          description: Always `too_early`
          default: too_early
          examples:
          - too_early
        status:
          type: integer
          title: Status
          description: Always `425`.
          default: 425
          examples:
          - 425
        message:
          type: string
          title: Message
          description: A human readable message that provides more context to the error.
          default: Generic error
          examples:
          - Request failed validation
        details:
          items:
            $ref: '#/components/schemas/ErrorDetail'
          type: array
          title: Details
          description: A list of details that further ellaborate on the error.
          default: []
      additionalProperties: false
      type: object
      title: Error425
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    ErrorDetail:
      properties:
        location:
          $ref: '#/components/schemas/ErrorLocation'
          description: The part of the request where the property can be found that caused the error.
          examples:
          - body
        pointer:
          anyOf:
          - type: string
            format: json-pointer
          - type: string
          title: Pointer
          description: A JSON pointer for the particular property that caused the error.
          examples:
          - /currency
        message:
          type: string
          title: Message
          description: A human-readdable explanation of the error.
          examples:
          - 'Unknown ISO 4217 currency code: USX'
        type:
          type: string
          title: Type
          description: The type of error that was raised for this property.
          examples:
          - value_error
      additionalProperties: false
      type: object
      required:
      - location
      - pointer
      - message
      - type
      title: ErrorDetail
    Error405:
      properties:
        type:
          type: string
          const: error
          title: Type
          description: Always `error`.
          default: error
          examples:
          - error
        code:
          type: string
          title: Code
          description: Always `method_not_allowed`
          default: method_not_allowed
          examples:
          - method_not_allowed
        status:
          type: integer
          title: Status
          description: Always `405`.
          default: 405
          examples:
          - 405
        message:
          type: string
          title: Message
          description: A human readable message that provides more context to the error.
          default: Method Not Allowed
          examples:
          - Method Not Allowed
        details:
          items:
            $ref: '#/components/schemas/ErrorDetail'
          type: array
          title: Details
          description: A list of details that further ellaborate on the error.
          default: []
      additionalProperties: false
      type: object
      title: Error405
    Error429:
      properties:
        type:
          type: string
          const: error
          title: Type
          description: Always `error`.
          default: error
          examples:
          - error
        code:
          type: string
          title: Code
          description: Always `too_many_requests`
          default: too_many_requests
          examples:
          - too_many_requests
        status:
          type: integer
          title: Status
          description: Always `429`.
          default: 429
          examples:
          - 429
        message:
          type: string
          title: Message
          description: A human readable message that provides more context to the error.
          default: Generic error
          examples:
          - Request failed validation
        details:
          items:
            $ref: '#/components/schemas/ErrorDetail'
          type: array
          title: Details
          description: A list of details that further ellaborate on the error.
          default: []
      additionalProperties: false
      type: object
      title: Error429
    Error500:
      properties:
        type:
          type: string
          const: error
          title: Type
          description: Always `error`.
          default: error
          examples:
          - error
        code:
          type: string
          title: Code
          description: Always `server_error`
          default: server_error
          examples:
          - server_error
        status:
          type: integer
          title: Status
          description: Always `500`.
          default: 500
          examples:
          - 500
        message:
          type: string
          title: Message
          description: A human readable message that provides more context to the error.
          default: Request could not be processed
          examples:
          - Request could not be processed
        details:
          items:
            $ref: '#/components/schemas/ErrorDetail'
          type: array
          title: Details
          description: A list of details that further ellaborate on the error.
          default: []
      additionalProperties: false
      type: object
      title: Error500
    Error504:
      properties:
        type:
          type: string
          const: error
          title: Type
          description: Always `error`.
          default: error
          examples:
          - error
        code:
          type: string
          title: Code
          description: Always `gateway_timeout`
          default: gateway_timeout
          examples:
          - gateway_timeout
        status:
          type: integer
          title: Status
          default: 504
        message:
          type: string
          title: Message
          description: A human readable message that provides more context to the error.
          default: Request could not be processed
          examples:
          - Request could not be processed
        details:
          items:
            $ref: '#/components/schemas/ErrorDetail'
          type: array
          title: Details
          description: A list of details that further ellaborate on the error.
          default: []
      additionalProperties: false
      type: object
      title: Error504
    Error400:
      properties:
        type:
          type: string
          const: error
          title: Type
          description: Always `error`.
          default: error
          examples:
          - error
        code:
          type: string
          title: Code
          description: Always `bad_request`
          default: bad_request
          examples:
          - bad_request
        status:
          type: integer
          title: Status
          description: Always `400`.
          default: 400
          examples:
          - 400
        message:
          type: string
          title: Message
          description: A human readable message that provides more context to the error.
          default: Generic error
          examples:
          - Request failed validation
        details:
          items:
            $ref: '#/components/schemas/ErrorDetail'
          type: array
          title: Details
          description: A list of details that further ellaborate on the error.
          default: []
      additionalProperties: false
      type: object
      title: Error400
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
            - type: string
            - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
        input:
          title: Input
        ctx:
          type: object
          title: Context
      type: object
      required:
      - loc
      - msg
      - type
      title: ValidationError
    Error502:
      properties:
        type:
          type: string
          const: error
          title: Type
          description: Always `error`.
          default: error
          examples:
          - error
        code:
          type: string
          title: Code
          description: Always `bad_gateway`
          default: bad_gateway
          examples:
          - bad_gateway
        status:
          type: integer
          title: Status
          description: Always `502`.
          default: 502
          examples:
          - 502
        message:
          type: string
          title: Message
          description: A human readable message that provides more context to the error.
          default: Request could not be processed
          examples:
          - Request could not be processed
        details:
          items:
            $ref: '#/components/schemas/ErrorDetail'
          type: array
          title: Details
          description: A list of details that further ellaborate on the error.
          default: []
      additionalProperties: false
      type: object
      title: Error502
    Error409:
      properties:
        type:
          type: string
          const: error
          title: Type
          description: Always `error`.
          default: error
          examples:
          - error
        code:
          type: string
          title: Code
          description: Always `duplicate_record`
          default: duplicate_record
          examples:
          - duplicate_record
        status:
          type: integer
          title: Status
          description: Always `409`.
          default: 409
          examples:
          - 409
        message:
          type: string
          title: Message
          description: A human readable message that provides more context to the error.
          default: Generic error
          examples:
          - Request failed validation
        details:
          items:
            $ref: '#/components/schemas/ErrorDetail'
          type: array
          title: Details
          description: A list of details that further ellaborate on the error.
          default: []
        resource_id:
          anyOf:
          - type: string
          - type: 'null'
          title: Resource Id
          description: The ID of the conflicting resource.
          examples:
          - cdc70639-cb9c-4222-a73f-b8ce39f7821b
      additionalProperties: false
      type: object
      title: Error409
    Error403:
      properties:
        type:
          type: string
          const: error
          title: Type
          description: Always `error`.
          default: error
          examples:
          - error
        code:
          type: string
          title: Code
          description: Always `forbidden`
          default: forbidden
          examples:
          - forbidden
        status:
          type: integer
          title: Status
          description: Always `403`.
          default: 403
          examples:
          - 403
        message:
          type: string
          title: Message
          description: A human readable message that provides more context to the error.
          default: Generic error
          examples:
          - Request failed validation
        details:
          items:
            $ref: '#/components/schemas/ErrorDetail'
          type: array
          title: Details
          description: A list of details that further ellaborate on the error.
          default: []
      additionalProperties: false
      type: object
      title: Error403
    CardScheme:
      type: string
      enum:
      - accel
      - amex
      - bancontact
      - carte-bancaire
      - cirrus
      - culiance
      - dankort
      - diners-club
      - discover
      - eftpos-australia
      - elo
      - hipercard
      - jcb
      - maestro
      - mastercard
      - mir
      - nyce
      - other
      - pulse
      - qcard
      - rupay
      - star
      - uatp
      - unionpay
      - visa
      title: CardScheme
    MerchantAccountThreeDSConfigurations:
      properties:
        items:
          items:
            $ref: '#/components/schemas/MerchantAccountThreeDSConfiguration'
          type: array
          title: Items
          description: A list of items returned for this request.
      type: object
      required:
      - items
      title: MerchantAccountThreeDSConfigurations
    MerchantAccountThreeDSConfigurationCreate:
      properties:
        merchant_acquirer_bin:
          type: string
          maxLength: 11
          title: Merchant Acquirer Bin
          description: Acquirer BIN to use when calling 3DS through this scheme.
          examples:
          - '516327'
        merchant_acquirer_id:
          type: string
          maxLength: 35
          title: Merchant Acquirer Id
          description: Merchant ID to use when calling 3DS through this scheme.
          examples:
          - '123456789012345'
        merchant_name:
          type: string
          maxLength: 40
          title: Merchant Name
          description: ''
          examples:
          - Acme Inc.
        merchant_country_code:
          type: string
          title: Merchant Country Code
          description: The merchant's ISO 3166-1 numeric country code.
          examples:
          - '840'
        merchant_category_code:
          type: string
          maxLength: 4
          minLength: 4
          title: Merchant Category Code
          description: Merchant category code to use when calling 3DS through this scheme.
          examples:
          - '1234'
        merchant_url:
          type: string
          title: Merchant Url
          description: URL to send when calling 3DS through this scheme.
          examples:
          - https://example.com
        scheme:
          $ref: '#/components/schemas/CardScheme'
          description: The card scheme for this 3DS configuration
        currency:
          anyOf:
          - type: string
            pattern: ^[A-Z]{3}$
            examples:
            - EUR
            - GBP
            - USD
          - type: 'null'
          title: Currency
          description: ISO 4217 currency code (3 characters). If left null, the configuration will apply to all currencies.
          examples:
          - USD
          - EUR
          - GBP
        metadata:
          additionalProperties:
            type: string
          type: object
          title: Metadata
          description: Any additional information about the 3DS configuration that you would like to store as key-value pairs.
      additionalProperties: false
      type: object
      required:
      - merchant_acquirer_bin
      - merchant_acquirer_id
      - merchant_name
      - merchant_country_code
      - merchant_category_code
      - merchant_url
      - scheme
      - metadata
      title: MerchantAccountThreeDSConfigurationCreate
    MerchantAccountThreeDSConfigurationUpdate:
      properties:
        merchant_acquirer_bin:
          anyOf:
          - type: string
            maxLength: 11
          - type: 'null'
          title: Merchant Acquirer Bin
          description: Acquirer BIN to use when calling 3DS through this scheme.
          examples:
          - '516327'
        merchant_acquirer_id:
          anyOf:
          - type: string
            maxLength: 35
          - type: 'null'
          title: Merchant Acquirer Id
          description: Merchant ID to use when calling 3DS through this scheme.
          examples:
          - '123456789012345'
        merchant_name:
          anyOf:
          - type: string
            maxLength: 40
          - type: 'null'
          title: Merchant Name
          description: ''
          examples:
          - Acme Inc.
        merchant_country_code:
          anyOf:
          - type: string
          - type: 'null'
          title: Merchant Country Code
          description: The merchant's ISO 3166-1 numeric country code.
          examples:
          - '840'
        merchant_category_code:
          anyOf:
          - type: string
            maxLength: 4
            minLength: 4
          - type: 'null'
          title: Merchant Category Code
          description: Merchant category code to use when calling 3DS through this scheme.
          examples:
          - '1234'
        merchant_url:
          anyOf:
          - type: string
          - type: 'null'
          title: Merchant Url
          description: URL to send when calling 3DS through this scheme.
          examples:
          - https://example.com
        scheme:
          anyOf:
          - $ref: '#/components/schemas/CardScheme'
          - type: 'null'
          description: The card scheme for this 3DS configuration
        currency:
          anyOf:
          - type: string
            pattern: ^[A-Z]{3}$
            examples:
            - EUR
            - GBP
            - USD
          - type: 'null'
          title: Currency
          description: ISO 4217 currency code (3 characters). If left null, the configuration will apply to all currencies.
          examples:
          - USD
          - EUR
          - GBP
        metadata:
          anyOf:
          - additionalProperties:
              type: string
            type: object
          - type: 'null'
          title: Metadata
          description: Any additional information about the 3DS configuration that you would like to store as key-value pairs.
      additionalProperties: false
      type: object
      title: MerchantAccountThreeDSConfigurationUpdate
  securitySchemes:
    OAuth2PasswordBearer:
      type: oauth2
      flows:
        password:
          scopes:
            embed: Shorthand for all gr4vy embed related scopes
            sessions.refresh: Refresh access-token
            anti-fraud-service-definitions.read: Read Anti Fraud Service Definitions
            anti-fraud-services.read: Read Anti Fraud Services
            api-key-pairs.read: Read API Key Pairs
            api-logs.read: Read API Logs
            apple-pay-certificates.read: Read Apple Pay Certificates
            audit-logs.read: Read Audit Logs
            bin-checker.read: Read BIN Checker
            buyers.read: Read Buyers
            buyers.billing-details.read: Read Billing Details
            card-scheme-definitions.read: Read Card Scheme Definitions
            checkout-sessions.read: Read Checkout Sessions
            connections.read: Read Connections
            digital-wallets.read: Read Digital Wallets
            flows.read: Read Flows
            gift-card-service-definitions.read: Read Gift Card Service Definitions
            gift-card-services.read: Read Gift Card Services
            gift-cards.read: Read Gift Cards
            merchant-accounts.read: Read Merchant Accounts
            payment-links.read: Read Payment Links
            payment-method-definitions.read: Read Payment Method Definitions
            payment-methods.read: Read Payment Methods
            payment-options.read: Read Payment Options
            payment-service-definitions.read: Read Payment Service Definitions
            payment-services.read: Read Payment Service
            payouts.read: Read Payouts
            reports.read: Read Reports
            roles.read: Read Roles
            three-ds-scenarios.read: Read 3DS Scenarios
            transactions.read: Read Transactions
            users.me.read: Read User Profile
            vault-forward.read: Read Vault Forward
            vault-forward-authentications.read: Read Vault Forward Authentications
            vault-forward-configs.read: Read Vault Forward Configurations
            vault-forward-definitions.read: Read Vault Forward Definitions
            webhook-subscriptions.read: Read Webhook Subscriptions
            business-contexts.read: Read Business Contexts
            health-dashboard.read: Read Health Dashboard
            metrics-explorer.read: Read Metrics Explorer
            monitoring.read: Read Monitoring
            reset.read: Read Reset
            sessions.read: Read Sessions
            users.read: Read Users
            anti-fraud-service-definitions.write: Write Anti Fraud Service Definitions
            anti-fraud-services.write: Write Anti Fraud Services
            api-key-pairs.write: Write API Key Pairs
            api-logs.write: Write API Logs
            apple-pay-certificates.write: Write Apple Pay Certificates
            audit-logs.write: Write Audit Logs
            bin-checker.write: Write BIN Checker
            buyers.write: Write Buyers
            buyers.billing-details.write: Write Billing Details
            card-scheme-definitions.write: Write Card Scheme Definitions
            checkout-sessions.write: Write Checkout Sessions
            connections.write: Write Connections
            digital-wallets.write: Write Digital Wallets
            flows.write: Write Flows
            gift-card-service-definitions.write: Write Gift Card Service Definitions
            gift-card-services.write: Write Gift Card Services
            gift-cards.write: Write Gift Cards
            merchant-accounts.write: Write Merchant Accounts
            payment-links.write: Write Payment Links
            payment-method-definitions.write: Write Payment Method Definitions
            payment-methods.write: Write Payment Methods
            payment-options.write: Write Payment Options
            payment-service-definitions.write: Write Payment Service Definitions
            payment-services.write: Write Payment Service
            payouts.write: Write Payouts
            reports.write: Write Reports
            roles.write: Write Roles
            three-ds-scenarios.write: Write 3DS Scenarios
            transactions.write: Write Transactions
            users.me.write: Write User Profile
            vault-forward.write: Write Vault Forward
            vault-forward-authentications.write: Write Vault Forward Authentications
            vault-forward-configs.write: Write Vault Forward Configurations
            vault-forward-definitions.write: Write Vault Forward Definitions
            webhook-subscriptions.write: Write Webhook Subscriptions
            business-contexts.write: Write Business Contexts
            health-dashboard.write: Write Health Dashboard
            metrics-explorer.write: Write Metrics Explorer
            monitoring.write: Write Monitoring
            reset.write: Write Reset
            sessions.write: Write Sessions
            users.write: Write Users
          tokenUrl: auth/token