openapi: 3.2.0
info:
  title: Gr4vy Payment methods - Network tokens API
  description: The Gr4vy API.
  version: 1.0.0
tags:
- name: Payment methods - Network tokens
  description: Manage network tokens for stored payment methods.
paths:
  /payment-methods/{payment_method_id}/network-tokens:
    get:
      tags:
      - Payment methods - Network tokens
      summary: List network tokens
      description: List all network tokens stored for a payment method.
      operationId: list_payment_method_network_tokens
      security:
      - OAuth2PasswordBearer:
        - payment-methods.read
      parameters:
      - name: payment_method_id
        in: path
        required: true
        schema:
          type: string
          format: uuid
          description: The ID of the payment method
          examples:
          - ef9496d8-53a5-4aad-8ca2-00eb68334389
          title: Payment Method Id
        description: The ID of the payment method
      - name: x-gr4vy-merchant-account-id
        in: header
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          description: The ID of the merchant account to use for this request.
          examples:
          - default
          title: X-Gr4Vy-Merchant-Account-Id
        description: The ID of the merchant account to use for this request.
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NetworkTokens'
        '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: payment-methods.network-tokens
    post:
      tags:
      - Payment methods - Network tokens
      summary: Provision network token
      description: Provision a network token for a payment method.
      operationId: create_payment_method_network_token
      security:
      - OAuth2PasswordBearer:
        - payment-methods.write
      parameters:
      - name: payment_method_id
        in: path
        required: true
        schema:
          type: string
          format: uuid
          description: The ID of the payment method
          examples:
          - ef9496d8-53a5-4aad-8ca2-00eb68334389
          title: Payment Method Id
        description: The ID of the payment method
      - name: x-gr4vy-merchant-account-id
        in: header
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          description: The ID of the merchant account to use for this request.
          examples:
          - default
          title: X-Gr4Vy-Merchant-Account-Id
        description: The ID of the merchant account to use for this request.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/NetworkTokenCreate'
      responses:
        '201':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NetworkToken'
        '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: payment-methods.network-tokens
  /payment-methods/{payment_method_id}/network-tokens/{network_token_id}/cryptogram:
    post:
      tags:
      - Payment methods - Network tokens
      summary: Provision network token cryptogram
      description: Provision a cryptogram for a network token.
      operationId: create_payment_method_network_token_cryptogram
      security:
      - OAuth2PasswordBearer:
        - payment-methods.read
      parameters:
      - name: payment_method_id
        in: path
        required: true
        schema:
          type: string
          format: uuid
          description: The ID of the payment method
          examples:
          - ef9496d8-53a5-4aad-8ca2-00eb68334389
          title: Payment Method Id
        description: The ID of the payment method
      - name: network_token_id
        in: path
        required: true
        schema:
          type: string
          format: uuid
          description: The ID of the network token
          examples:
          - f8dd5cfc-7834-4847-95dc-f75a360e2298
          title: Network Token Id
        description: The ID of the network token
      - name: x-gr4vy-merchant-account-id
        in: header
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          description: The ID of the merchant account to use for this request.
          examples:
          - default
          title: X-Gr4Vy-Merchant-Account-Id
        description: The ID of the merchant account to use for this request.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CryptogramCreate'
      responses:
        '201':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Cryptogram'
        '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: payment-methods.network-tokens.cryptogram
  /payment-methods/{payment_method_id}/network-tokens/{network_token_id}/suspend:
    post:
      tags:
      - Payment methods - Network tokens
      summary: Suspend network token
      description: Suspend a network token for a payment method.
      operationId: suspend_payment_method_network_token
      security:
      - OAuth2PasswordBearer:
        - payment-methods.write
      parameters:
      - name: payment_method_id
        in: path
        required: true
        schema:
          type: string
          format: uuid
          description: The ID of the payment method
          examples:
          - ef9496d8-53a5-4aad-8ca2-00eb68334389
          title: Payment Method Id
        description: The ID of the payment method
      - name: network_token_id
        in: path
        required: true
        schema:
          type: string
          format: uuid
          description: The ID of the network token
          examples:
          - f8dd5cfc-7834-4847-95dc-f75a360e2298
          title: Network Token Id
        description: The ID of the network token
      - name: x-gr4vy-merchant-account-id
        in: header
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          description: The ID of the merchant account to use for this request.
          examples:
          - default
          title: X-Gr4Vy-Merchant-Account-Id
        description: The ID of the merchant account to use for this request.
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NetworkToken'
        '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: suspend
      x-speakeasy-group: payment-methods.network-tokens
  /payment-methods/{payment_method_id}/network-tokens/{network_token_id}/resume:
    post:
      tags:
      - Payment methods - Network tokens
      summary: Resume network token
      description: Resume a suspended network token for a payment method.
      operationId: resume_payment_method_network_token
      security:
      - OAuth2PasswordBearer:
        - payment-methods.write
      parameters:
      - name: payment_method_id
        in: path
        required: true
        schema:
          type: string
          format: uuid
          description: The ID of the payment method
          examples:
          - ef9496d8-53a5-4aad-8ca2-00eb68334389
          title: Payment Method Id
        description: The ID of the payment method
      - name: network_token_id
        in: path
        required: true
        schema:
          type: string
          format: uuid
          description: The ID of the network token
          examples:
          - f8dd5cfc-7834-4847-95dc-f75a360e2298
          title: Network Token Id
        description: The ID of the network token
      - name: x-gr4vy-merchant-account-id
        in: header
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          description: The ID of the merchant account to use for this request.
          examples:
          - default
          title: X-Gr4Vy-Merchant-Account-Id
        description: The ID of the merchant account to use for this request.
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NetworkToken'
        '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: resume
      x-speakeasy-group: payment-methods.network-tokens
  /payment-methods/{payment_method_id}/network-tokens/{network_token_id}:
    delete:
      tags:
      - Payment methods - Network tokens
      summary: Delete network token
      description: Delete a network token for a payment method.
      operationId: delete_payment_method_network_token
      security:
      - OAuth2PasswordBearer:
        - payment-methods.write
      parameters:
      - name: payment_method_id
        in: path
        required: true
        schema:
          type: string
          format: uuid
          description: The ID of the payment method
          examples:
          - ef9496d8-53a5-4aad-8ca2-00eb68334389
          title: Payment Method Id
        description: The ID of the payment method
      - name: network_token_id
        in: path
        required: true
        schema:
          type: string
          format: uuid
          description: The ID of the network token
          examples:
          - f8dd5cfc-7834-4847-95dc-f75a360e2298
          title: Network Token Id
        description: The ID of the network token
      - name: x-gr4vy-merchant-account-id
        in: header
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          description: The ID of the merchant account to use for this request.
          examples:
          - default
          title: X-Gr4Vy-Merchant-Account-Id
        description: The ID of the merchant account to use for this request.
      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: payment-methods.network-tokens
components:
  schemas:
    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
    NetworkTokenCreate:
      properties:
        security_code:
          anyOf:
          - type: string
            maxLength: 4
            minLength: 3
            pattern: ^\d+$
          - type: 'null'
          title: Security Code
          description: The 3 or 4 digit security code often found on the card. This often referred to as the CVV or CVD.
          examples:
          - '123'
        merchant_initiated:
          type: boolean
          title: Merchant Initiated
          description: Defines if the request is merchant initiated or not.
          examples:
          - false
        is_subsequent_payment:
          type: boolean
          title: Is Subsequent Payment
          description: Defines if the request is a subsequent of another request or not.
          examples:
          - false
      additionalProperties: false
      type: object
      required:
      - merchant_initiated
      - is_subsequent_payment
      title: NetworkTokenCreate
    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
    CryptogramCreate:
      properties:
        merchant_initiated:
          type: boolean
          title: Merchant Initiated
          description: Defines if the request is merchant initiated or not.
          examples:
          - false
      additionalProperties: false
      type: object
      required:
      - merchant_initiated
      title: CryptogramCreate
    NetworkTokens:
      properties:
        items:
          items:
            $ref: '#/components/schemas/NetworkToken'
          type: array
          title: Items
          description: A list of items returned for this request.
      type: object
      required:
      - items
      title: NetworkTokens
    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
    NetworkToken:
      properties:
        type:
          type: string
          const: network-token
          title: Type
          description: Always `network-token`.
          default: network-token
          examples:
          - network-token
        id:
          type: string
          format: uuid
          title: Id
          description: The ID for the network token.
          examples:
          - 918f6c9b-5d11-4897-98dc-23fda6fe0055
        expiration_date:
          type: string
          maxLength: 5
          minLength: 5
          pattern: ^\d{2}/\d{2}$
          title: Expiration Date
          description: The expiration date for the network token.
          examples:
          - 12/30
        payment_method_id:
          type: string
          format: uuid
          title: Payment Method Id
          description: The ID of the payment method used to generate this token
          examples:
          - ef9496d8-53a5-4aad-8ca2-00eb68334389
        status:
          $ref: '#/components/schemas/NetworkTokenStatus'
          description: The state of the network token.
          examples:
          - active
        token:
          type: string
          maxLength: 300
          minLength: 1
          title: Token
          description: The token value. Will be present if succeeded.
          examples:
          - '4111123456789012'
        created_at:
          type: string
          format: date-time
          title: Created At
          description: The date and time when this network token 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 network token was last updated in our system.
          examples:
          - '2013-07-16T19:23:00.000+00:00'
      additionalProperties: false
      type: object
      required:
      - id
      - expiration_date
      - payment_method_id
      - status
      - token
      - created_at
      - updated_at
      title: NetworkToken
    NetworkTokenStatus:
      type: string
      enum:
      - active
      - inactive
      - suspended
      - deleted
      title: NetworkTokenStatus
    Cryptogram:
      properties:
        type:
          type: string
          const: network-token-cryptogram
          title: Type
          description: Always `network-token-cryptogram`.
          default: network-token-cryptogram
          examples:
          - network-token-cryptogram
        cryptogram:
          type: string
          title: Cryptogram
          description: The cryptogram of the network token.
          examples:
          - A3F9C2D47E1B56A9
      additionalProperties: false
      type: object
      required:
      - cryptogram
      title: Cryptogram
  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