Finix Payments Authorizations API

{'$ref': 'api-descriptions/tags/authorizations.md'}

OpenAPI Specification

finix-payments-authorizations-api-openapi.yml Raw ↑
openapi: 3.0.2
info:
  title: Finix Authorizations API
  description:
    $ref: api-descriptions/main.md
  contact:
    name: Finix
    url: https://finix.com
    email: support@finixpayments.com
  version: '2022-02-01'
servers:
- description: Sandbox server to be used for testing and development
  url: https://finix.sandbox-payments-api.com
security:
- BasicAuth: []
tags:
- name: Authorizations
  description:
    $ref: api-descriptions/tags/authorizations.md
paths:
  /authorizations:
    post:
      tags:
      - Authorizations
      description: 'Create an `Authorization` to process a transaction.


        Related Guides: [Creating and Capturing an Authorization](/guides/payments/making-a-payment/creating-and-capturing-an-authorization/), [Level 2 and 3 Processing](/guides/payments/making-a-payment/level-2-and-level-3-processing/), [In-Person Cloud Payments](/guides/payments/in-person-payments/cloud/in-person-cloud-payments/), [Buyer Charges](/guides/payments/making-a-payment/buyer-charges/)'
      summary: Create an Authorization
      operationId: createAuthorization
      requestBody:
        $ref: '#/components/requestBodies/CreateAuthorizationRequest'
      responses:
        '201':
          $ref: '#/components/responses/Authorization'
        '400':
          $ref: '#/components/responses/ErrorUnprocessableEntity'
        '401':
          $ref: '#/components/responses/ErrorUnauthorized'
        '402':
          $ref: '#/components/responses/ErrorPaymentRequired'
        '403':
          $ref: '#/components/responses/ErrorForbidden403'
        '404':
          $ref: '#/components/responses/ErrorNotFound'
        '406':
          $ref: '#/components/responses/Error406NotAcceptable'
        '422':
          $ref: '#/components/responses/Error422InvalidField'
      x-java-method-name: create
      parameters:
      - schema:
          type: string
          default: '2018-01-01'
          example: '2022-02-01'
        in: header
        name: Finix-Version
        description: Specify the API version of your request. For more details, see [Versioning.](/guides/developers/versioning/)
      x-python-method-name: create
    get:
      tags:
      - Authorizations
      description: 'Retrieve a list of `Authorizations`. '
      summary: List Authorizations
      operationId: listAuthorizations
      parameters:
      - $ref: '#/components/parameters/QueryAmountFilter'
      - $ref: '#/components/parameters/QueryAmountGtFilter'
      - $ref: '#/components/parameters/QueryAmountGteFilter'
      - $ref: '#/components/parameters/QueryAmountLtFilter'
      - $ref: '#/components/parameters/QueryAmountLteFilter'
      - $ref: '#/components/parameters/QueryBeforeCursor'
      - $ref: '#/components/parameters/QueryAfterCursor'
      - $ref: '#/components/parameters/QueryCreatedAtGteFilter'
      - $ref: '#/components/parameters/QueryCreatedAtLteFilter'
      - $ref: '#/components/parameters/QueryIdempotencyIdFilter'
      - $ref: '#/components/parameters/QueryLimit'
      - $ref: '#/components/parameters/TagsKey'
      - $ref: '#/components/parameters/TagsValue'
      - in: query
        name: state
        description: Filter by Transaction state.
        schema:
          enum:
          - SUCCEEDED
          - FAILED
          - PENDING
          - CANCELED
      - $ref: '#/components/parameters/QueryUpdatedAtGteFilter'
      - $ref: '#/components/parameters/QueryUpdatedAtLteFilter'
      - $ref: '#/components/parameters/QueryTraceIdFilter'
      - $ref: '#/components/parameters/QueryVoidFilter'
      - in: query
        name: instrument_bin
        description: Filter by Bank Identification Number (BIN). The BIN is the first 6 digits of the masked number.
        schema:
          type: string
      - schema:
          type: string
        in: query
        name: instrument_account_last4
        description: "Filter Transactions by the last 4 digits of the bank account. The bank account last 4 are the last 4 digits of the masked number\tinstrument_account_last4=9444 BIN."
      - schema:
          type: string
        in: query
        name: instrument_brand_type
        description: Filter by card brand. Available card brand types can be found in the drop-down.
      - schema:
          type: string
        in: query
        name: merchant_identity_id
        description: Filter by `Identity` ID.
      - schema:
          type: string
        in: query
        name: merchant_identity_name
        description: Filter Transactions by `Identity` name. The name is not case-sensitive.
      - schema:
          type: string
        in: query
        name: instrument_name
        description: Filter Transactions by `Payment Instrument` name.
      - schema:
          type: string
        in: query
        name: instrument_type
        description: 'Filter Transactions by `Payment Instrument` type. Available instrument types include: Bank Account or Payment Card.'
      - schema:
          type: string
        in: query
        name: merchant_id
        description: Filter by `Merchant` ID.
      - schema:
          type: string
        in: query
        name: merchant_mid
        description: Filter by Merchant Identification Number (MID).
      - schema:
          type: string
        in: query
        name: instrument_card_last4
        description: Filter by the payment card last 4 digits.
      - schema:
          type: string
        in: query
        name: merchant_processor_id
        description: Filter by `Processor` ID.
      - schema:
          type: string
        in: query
        name: type
        description: Type of the `Authorization`.
      - schema:
          type: string
          default: '2018-01-01'
          example: '2022-02-01'
        in: header
        name: Finix-Version
        description: Specify the API version of your request. For more details, see [Versioning.](/guides/developers/versioning/)
      responses:
        '200':
          $ref: '#/components/responses/AuthorizationsList'
        '401':
          $ref: '#/components/responses/ErrorUnauthorized'
        '403':
          $ref: '#/components/responses/ErrorForbidden403'
        '404':
          $ref: '#/components/responses/ErrorNotFound'
        '406':
          $ref: '#/components/responses/Error406NotAcceptable'
      x-java-method-name: list
      x-group-parameters: true
      x-codeSamples:
      - lang: cURL
        label: curl
        source: "curl \"https://finix.sandbox-payments-api.com/authorizations\" \\\n  -H \"Finix-Version: 2022-02-01\" \\\n  -u USsRhsHYZGBPnQw8CByJyEQW:8a14c2f9-d94b-4c72-8f5c-a62908e5b30e\n"
      x-python-method-name: list
      x-returns-list: true
  /authorizations/{authorization_id}:
    parameters:
    - $ref: '#/components/parameters/AuthorizationId'
    get:
      tags:
      - Authorizations
      description: Retrieve the details of a previously created `Authorization`.
      summary: Fetch an Authorization
      operationId: getAuthorization
      responses:
        '200':
          $ref: '#/components/responses/Authorization'
        '401':
          $ref: '#/components/responses/ErrorUnauthorized'
        '403':
          $ref: '#/components/responses/ErrorForbidden403'
        '404':
          $ref: '#/components/responses/ErrorNotFound'
        '406':
          $ref: '#/components/responses/Error406NotAcceptable'
      x-java-method-name: get
      x-codeSamples:
      - lang: cURL
        label: curl
        source: "curl \"https://finix.sandbox-payments-api.com/authorizations/AUsCN6f7qTLzxUD3Bp6iXQMQ\" \\\n  -H \"Finix-Version: 2022-02-01\" \\\n  -u USsRhsHYZGBPnQw8CByJyEQW:8a14c2f9-d94b-4c72-8f5c-a62908e5b30e\n"
      x-python-method-name: get
    put:
      tags:
      - Authorizations
      description: 'Use a PUT request to capture an `Authorization`. If captured successfully, the `transfer` field of the `Authorization` will contain the ID of the `Transfer` resource that moves funds.


        Related Guides: [Creating and Capturing an Authorization](/guides/payments/making-a-payment/creating-and-capturing-an-authorization/), [Level 2 and 3 Processing](/guides/payments/making-a-payment/level-2-and-level-3-processing/), [In-Person Cloud Payments](/guides/payments/in-person-payments/cloud/in-person-cloud-payments/), [Buyer Charges](/guides/payments/making-a-payment/buyer-charges/)'
      summary: Capture an Authorization
      operationId: captureAuthorization
      requestBody:
        $ref: '#/components/requestBodies/UpdateAuthorizationRequest'
      responses:
        '200':
          $ref: '#/components/responses/AuthorizationUpdated'
        '401':
          $ref: '#/components/responses/ErrorUnauthorized'
        '403':
          $ref: '#/components/responses/ErrorForbidden403'
        '406':
          $ref: '#/components/responses/Error406NotAcceptable'
        '422':
          $ref: '#/components/responses/Error422InvalidField'
      x-internal: false
      x-java-method-name: update
      parameters:
      - schema:
          type: string
          default: '2018-01-01'
          example: '2022-02-01'
        in: header
        name: Finix-Version
        description: Specify the API version of your request. For more details, see [Versioning.](/guides/developers/versioning/)
      x-python-method-name: update
  /authorizations/{authorization_id_void_to}:
    parameters:
    - schema:
        type: string
      name: authorization_id_void_to
      in: path
      required: true
    put:
      tags:
      - Authorizations
      description: 'Use a PUT request to void an `Authorization`. If voided successfully, funds get released and the transaction stops from completing. Additionally, voided `Authorization` can no longer be captured.


        Related Guides: [Creating and Capturing an Authorization](/guides/payments/making-a-payment/creating-and-capturing-an-authorization/), [Level 2 and 3 Processing](/guides/payments/making-a-payment/level-2-and-level-3-processing/), [In-Person Cloud Payments](/guides/payments/in-person-payments/cloud/in-person-cloud-payments/), [Buyer Charges](/guides/payments/making-a-payment/buyer-charges/)'
      summary: Void an Authorization
      operationId: voidAuthorization
      requestBody:
        $ref: '#/components/requestBodies/VoidAuthorizationRequest'
      responses:
        '200':
          $ref: '#/components/responses/AuthorizationUpdated'
        '401':
          $ref: '#/components/responses/ErrorUnauthorized'
        '403':
          $ref: '#/components/responses/ErrorForbidden403'
        '406':
          $ref: '#/components/responses/Error406NotAcceptable'
        '422':
          $ref: '#/components/responses/Error422InvalidField'
      x-internal: false
      x-java-method-name: update_authorization_void
      parameters:
      - schema:
          type: string
          default: '2018-01-01'
          example: '2022-02-01'
        in: header
        name: Finix-Version
        description: Specify the API version of your request. For more details, see [Versioning.](/guides/developers/versioning/)
      x-python-method-name: update_authorization_void
components:
  responses:
    Error422InvalidField:
      description: Invalid field
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error422InvalidFieldList'
    Error406NotAcceptable:
      description: Not Acceptable
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error406NotAcceptable'
          examples: {}
    ErrorUnprocessableEntity:
      description: Error
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorGeneric'
    ErrorNotFound:
      description: Object does not exist
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error404NotFoundList'
    Authorization:
      description: Single Authorization object
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Authorization'
          examples:
            Authorization:
              value:
                id: AUvZbBaTJkFCbiAMrGtc66ko
                created_at: '2022-10-11T02:27:39.10Z'
                updated_at: '2022-10-11T02:27:39.48Z'
                3ds_redirect_url: null
                additional_buyer_charges: null
                additional_healthcare_data: null
                address_verification: POSTAL_CODE_AND_STREET_MATCH
                amount: 100
                amount_requested: 100
                application: APgPDQrLD52TYvqazjHJJchM
                currency: USD
                expires_at: '2022-10-18T02:27:39.10Z'
                failure_code: null
                failure_message: null
                idempotency_id: null
                is_void: false
                merchant: MUeDVrf2ahuKc9Eg5TeZugvs
                merchant_identity: IDuqZpDw28f2KK6YuDk4jNLg
                messages: []
                raw: null
                security_code_verification: MATCHED
                source: PIe2YvpcjvoVJ6PzoRPBK137
                state: SUCCEEDED
                tags:
                  order_number: 21DFASJSAKAS
                trace_id: e1a10287-4909-4aa7-9cb7-abd069a3b833
                transfer: null
                void_state: UNATTEMPTED
                _links:
                  self:
                    href: https://finix.sandbox-payments-api.com/authorizations/AUvZbBaTJkFCbiAMrGtc66ko
                  application:
                    href: https://finix.sandbox-payments-api.com/applications/APgPDQrLD52TYvqazjHJJchM
                  merchant_identity:
                    href: https://finix.sandbox-payments-api.com/identities/IDuqZpDw28f2KK6YuDk4jNLg
            Authorization - 3D Secure:
              value:
                id: AUtmuV1dapVdEe16ivUEUhSE
                created_at: '2022-10-11T02:28:28.50Z'
                updated_at: '2022-10-11T02:28:28.66Z'
                3ds_redirect_url: null
                additional_buyer_charges: null
                additional_healthcare_data: null
                address_verification: POSTAL_CODE_AND_STREET_MATCH
                amount: 100
                amount_requested: 100
                application: APgPDQrLD52TYvqazjHJJchM
                currency: USD
                expires_at: '2022-10-18T02:28:28.50Z'
                failure_code: null
                failure_message: null
                idempotency_id: null
                is_void: false
                merchant: MUeDVrf2ahuKc9Eg5TeZugvs
                merchant_identity: IDuqZpDw28f2KK6YuDk4jNLg
                messages: []
                raw: null
                security_code_verification: MATCHED
                source: PIe2YvpcjvoVJ6PzoRPBK137
                state: SUCCEEDED
                tags:
                  order_number: 21DFASJSAKAS
                trace_id: 20374045-2f90-48f4-80e0-7edf32b9e626
                transfer: null
                void_state: UNATTEMPTED
                _links:
                  self:
                    href: https://finix.sandbox-payments-api.com/authorizations/AUtmuV1dapVdEe16ivUEUhSE
                  application:
                    href: https://finix.sandbox-payments-api.com/applications/APgPDQrLD52TYvqazjHJJchM
                  merchant_identity:
                    href: https://finix.sandbox-payments-api.com/identities/IDuqZpDw28f2KK6YuDk4jNLg
            Authorization - Level 2 Processing:
              value:
                id: AUpkH5f8YoLe2DBNKgqCua4N
                created_at: '2022-10-11T02:28:59.99Z'
                updated_at: '2022-10-11T02:29:00.47Z'
                3ds_redirect_url: null
                additional_buyer_charges: null
                additional_healthcare_data: null
                address_verification: POSTAL_CODE_AND_STREET_MATCH
                amount: 1000
                amount_requested: 1000
                application: APgPDQrLD52TYvqazjHJJchM
                currency: USD
                expires_at: '2022-10-18T02:28:59.99Z'
                failure_code: null
                failure_message: null
                idempotency_id: null
                is_void: false
                merchant: MUeDVrf2ahuKc9Eg5TeZugvs
                merchant_identity: IDuqZpDw28f2KK6YuDk4jNLg
                messages: []
                raw: null
                security_code_verification: MATCHED
                source: PIe2YvpcjvoVJ6PzoRPBK137
                state: SUCCEEDED
                tags:
                  order_number: 21DFASJSAKAS
                trace_id: 595ef280-35b9-4566-8884-7333739245f9
                transfer: null
                void_state: UNATTEMPTED
                _links:
                  self:
                    href: https://finix.sandbox-payments-api.com/authorizations/AUpkH5f8YoLe2DBNKgqCua4N
                  application:
                    href: https://finix.sandbox-payments-api.com/applications/APgPDQrLD52TYvqazjHJJchM
                  merchant_identity:
                    href: https://finix.sandbox-payments-api.com/identities/IDuqZpDw28f2KK6YuDk4jNLg
            Authorization - Level 3 Processing:
              value:
                id: AUeNCQ37HbQgVQtToJiUtxpd
                created_at: '2022-10-11T02:29:36.07Z'
                updated_at: '2022-10-11T02:29:36.24Z'
                3ds_redirect_url: null
                additional_buyer_charges: null
                additional_healthcare_data: null
                address_verification: POSTAL_CODE_AND_STREET_MATCH
                amount: 1000
                amount_requested: 1000
                application: APgPDQrLD52TYvqazjHJJchM
                currency: USD
                expires_at: '2022-10-18T02:29:36.07Z'
                failure_code: null
                failure_message: null
                idempotency_id: null
                is_void: false
                merchant: MUeDVrf2ahuKc9Eg5TeZugvs
                merchant_identity: IDuqZpDw28f2KK6YuDk4jNLg
                messages: []
                raw: null
                security_code_verification: MATCHED
                source: PIe2YvpcjvoVJ6PzoRPBK137
                state: SUCCEEDED
                tags:
                  order_number: 21DFASJSAKAS
                trace_id: 3ce1a866-6a38-4a3b-b993-6ac9529afa53
                transfer: null
                void_state: UNATTEMPTED
                _links:
                  self:
                    href: https://finix.sandbox-payments-api.com/authorizations/AUeNCQ37HbQgVQtToJiUtxpd
                  application:
                    href: https://finix.sandbox-payments-api.com/applications/APgPDQrLD52TYvqazjHJJchM
                  merchant_identity:
                    href: https://finix.sandbox-payments-api.com/identities/IDuqZpDw28f2KK6YuDk4jNLg
            Voided Authorization:
              value:
                id: AUeYYckKJTrBVu1j8FYLzJ3W
                created_at: '2022-10-07T18:25:23.30Z'
                updated_at: '2022-10-07T18:29:59.38Z'
                3ds_redirect_url: null
                additional_buyer_charges: null
                additional_healthcare_data: null
                address_verification: POSTAL_CODE_AND_STREET_MATCH
                amount: 100
                amount_requested: 100
                application: APgPDQrLD52TYvqazjHJJchM
                currency: USD
                expires_at: '2022-10-14T18:25:23.30Z'
                failure_code: null
                failure_message: null
                idempotency_id: null
                is_void: true
                merchant: MUeDVrf2ahuKc9Eg5TeZugvs
                merchant_identity: IDuqZpDw28f2KK6YuDk4jNLg
                messages: []
                raw: null
                security_code_verification: MATCHED
                source: PIe2YvpcjvoVJ6PzoRPBK137
                state: SUCCEEDED
                tags:
                  order_number: 21DFASJSAKAS
                trace_id: 560e44af-5d22-4af2-801e-03d2dad69dc7
                transfer: null
                void_state: SUCCEEDED
                _links:
                  self:
                    href: https://finix.sandbox-payments-api.com/authorizations/AUeYYckKJTrBVu1j8FYLzJ3W
                  application:
                    href: https://finix.sandbox-payments-api.com/applications/APgPDQrLD52TYvqazjHJJchM
                  merchant_identity:
                    href: https://finix.sandbox-payments-api.com/identities/IDuqZpDw28f2KK6YuDk4jNLg
            Card Present Authorization - EMV Card:
              value:
                id: AUarp7Pz21Low4u2Urw5Ub4W
                created_at: '2019-04-29T20:44:00.13Z'
                updated_at: '2022-10-10T05:59:17.59Z'
                3ds_redirect_url: null
                additional_buyer_charges: null
                additional_healthcare_data: null
                address_verification: null
                amount: 3138
                amount_requested: 3138
                application: APeUbTUjvYb1CdPXvNcwW1wP
                card_present_details:
                  emv_data:
                    application_identifier: A0000001523010
                    application_label: DISCOVER
                    application_preferred_name: null
                    application_transaction_counter: '0005'
                    cryptogram: ARCQ F666F8891F870D33
                    issuer_code_table_index: null
                    pin_verified: false
                    tags: null
                  masked_account_number: '************0059'
                  name: Test Card 05
                  brand: DISCOVER
                  entry_mode: CHIP_ENTRY
                  payment_type: CREDIT
                  approval_code: 004839
                currency: USD
                device: DVfKLD9GZtsjcJxLtc2yCcfd
                expires_at: '2019-05-06T20:44:00.13Z'
                failure_code: null
                failure_message: null
                idempotency_id: null
                is_void: false
                merchant: MU4LYrniAvqVKUBqcATb7Y7p
                merchant_identity: IDsbTBawhnLBAVeinRb84vFR
                messages: []
                raw: null
                security_code_verification: null
                source: PImTHaz7XVPx4M7mhu9x8gkU
                state: SUCCEEDED
                tags:
                  TicketNumber: '45878'
                trace_id: FNX35FSuraeKKJr65wkGVFJni
                transfer: TRqQCAX7nYHUnkE5YPFTknqd
                void_state: UNATTEMPTED
                _links:
                  self:
                    href: https://finix.sandbox-payments-api.com/authorizations/AUarp7Pz21Low4u2Urw5Ub4W
                  application:
                    href: https://finix.sandbox-payments-api.com/applications/APeUbTUjvYb1CdPXvNcwW1wP
                  transfer:
                    href: https://finix.sandbox-payments-api.com/transfers/TRqQCAX7nYHUnkE5YPFTknqd
                  device:
                    href: https://finix.sandbox-payments-api.com/devices/DVfKLD9GZtsjcJxLtc2yCcfd
                  merchant_identity:
                    href: https://finix.sandbox-payments-api.com/identities/IDsbTBawhnLBAVeinRb84vFR
            Card Present Authorization - Non-EMV Card:
              value:
                id: AUarp7Pz21Low4u2Urw5Ub4W
                created_at: '2019-04-29T20:44:00.13Z'
                updated_at: '2022-10-10T05:59:17.59Z'
                3ds_redirect_url: null
                additional_buyer_charges: null
                additional_healthcare_data: null
                address_verification: null
                amount: 3138
                amount_requested: 3138
                application: APeUbTUjvYb1CdPXvNcwW1wP
                card_present_details:
                  emv_data:
                    application_identifier: A0000001523010
                    application_label: DISCOVER
                    application_preferred_name: null
                    application_transaction_counter: '0005'
                    cryptogram: ARCQ F666F8891F870D33
                    issuer_code_table_index: null
                    pin_verified: false
                    tags: null
                  masked_account_number: '************0059'
                  name: Test Card 05
                  brand: DISCOVER
                  entry_mode: CHIP_ENTRY
                  payment_type: CREDIT
                  approval_code: 004839
                currency: USD
                device: DVfKLD9GZtsjcJxLtc2yCcfd
                expires_at: '2019-05-06T20:44:00.13Z'
                failure_code: null
                failure_message: null
                idempotency_id: null
                is_void: false
                merchant: MU4LYrniAvqVKUBqcATb7Y7p
                merchant_identity: IDsbTBawhnLBAVeinRb84vFR
                messages: []
                raw: null
                security_code_verification: null
                source: PImTHaz7XVPx4M7mhu9x8gkU
                state: SUCCEEDED
                tags:
                  TicketNumber: '45878'
                trace_id: FNX35FSuraeKKJr65wkGVFJni
                transfer: TRqQCAX7nYHUnkE5YPFTknqd
                void_state: UNATTEMPTED
                _links:
                  self:
                    href: https://finix.sandbox-payments-api.com/authorizations/AUarp7Pz21Low4u2Urw5Ub4W
                  application:
                    href: https://finix.sandbox-payments-api.com/applications/APeUbTUjvYb1CdPXvNcwW1wP
                  transfer:
                    href: https://finix.sandbox-payments-api.com/transfers/TRqQCAX7nYHUnkE5YPFTknqd
                  device:
                    href: https://finix.sandbox-payments-api.com/devices/DVfKLD9GZtsjcJxLtc2yCcfd
                  merchant_identity:
                    href: https://finix.sandbox-payments-api.com/identities/IDsbTBawhnLBAVeinRb84vFR
            Authorization - Buyer Charges:
              value:
                id: AUmoNHYYU26opc8gEqAYEaGj
                created_at: '2022-10-11T02:31:28.42Z'
                updated_at: '2022-10-11T02:31:28.81Z'
                3ds_redirect_url: null
                additional_buyer_charges:
                  convenience_amount: 0
                  rent_surcharge_amount: 200
                additional_healthcare_data: null
                address_verification: POSTAL_CODE_AND_STREET_MATCH
                amount: 5000
                amount_requested: 5000
                application: APgPDQrLD52TYvqazjHJJchM
                currency: USD
                expires_at: '2022-10-18T02:31:28.42Z'
                failure_code: null
                failure_message: null
                idempotency_id: null
                is_void: false
                merchant: MUeDVrf2ahuKc9Eg5TeZugvs
                merchant_identity: IDuqZpDw28f2KK6YuDk4jNLg
                messages: []
                raw: null
                security_code_verification: MATCHED
                source: PIe2YvpcjvoVJ6PzoRPBK137
                state: SUCCEEDED
                tags:
                  test: sale
                trace_id: a885a132-bf11-48fd-9eed-10d29909c068
                transfer: null
                void_state: UNATTEMPTED
                _links:
                  self:
                    href: https://finix.sandbox-payments-api.com/authorizations/AUmoNHYYU26opc8gEqAYEaGj
                  application:
                    href: https://finix.sandbox-payments-api.com/applications/APgPDQrLD52TYvqazjHJJchM
                  merchant_identity:
                    href: https://finix.sandbox-payments-api.com/identities/IDuqZpDw28f2KK6YuDk4jNLg
            Authorization - HSA or FSA Card:
              value:
                id: AUo8BiLgvzZzT41KBB7C8GQo
                created_at: '2022-10-10T06:32:17.04Z'
                updated_at: '2022-10-10T06:32:17.30Z'
                3ds_redirect_url: null
                additional_buyer_charges: null
                additional_healthcare_data: null
                address_verification: POSTAL_CODE_AND_STREET_MATCH
                amount: 950
                amount_requested: 950
                application: APgPDQrLD52TYvqazjHJJchM
                currency: USD
                expires_at: '2022-10-17T06:32:17.04Z'
                failure_code: null
                failure_message: null
                idempotency_id: null
                is_void: false
                merchant: MUeDVrf2ahuKc9Eg5TeZugvs
                merchant_identity: IDuqZpDw28f2KK6YuDk4jNLg
                messages: []
                raw: null
                security_code_verification: MATCHED
                source: PIe2YvpcjvoVJ6PzoRPBK137
                state: SUCCEEDED
                tags:
                  order_number: 21DFASJSAKAS
                trace_id: f702ed93-d38d-430d-8924-a09d946e037c
                transfer: null
                void_state: UNATTEMPTED
                _links:
                  self:
                    href: https://finix.sandbox-payments-api.com/authorizations/AUo8BiLgvzZzT41KBB7C8GQo
                  application:
                    href: https://finix.sandbox-payments-api.com/applications/APgPDQrLD52TYvqazjHJJchM
                  merchant_identity:
                    href: https://finix.sandbox-payments-api.com/identities/IDuqZpDw28f2KK6YuDk4jNLg
            Authorization - Authorization with CVV:
              value:
                id: AUg5fBP1vDXcFtSdiL3e4vzp
                created_at: '2022-10-11T02:32:54.64Z'
                updated_at: '2022-10-11T02:32:55.05Z'
                3ds_redirect_url: null
                additional_buyer_charges: null
                additional_healthcare_data: null
                address_verification: POSTAL_CODE_AND_STREET_MATCH
                amount: 100
                amount_requested: 100
                application: APgPDQrLD52TYvqazjHJJchM
                currency: USD
                expires_at: '2022-10-18T02:32:54.64Z'
                failure_code: null
                failure_message: null
                idempotency_id: null
                is_void: false
                merchant: MUeDVrf2ahuKc9Eg5TeZugvs
                merchant_identity: IDuqZpDw28f2KK6YuDk4jNLg
                messages: []
                raw: null
                security_code_verification: MATCHED
                source: PI6QyMT6W6c62u5bY8Y17TBj
                state: SUCCEEDED
                tags: {}
                trace_id: 526f28d0-73eb-46d6-b78c-aad6ab891dba
                transfer: null
                void_state: UNATTEMPTED
                _links:
                  self:
                    href: https://finix.sandbox-payments-api.com/authorizations/AUg5fBP1vDXcFtSdiL3e4vzp
                  application:
                    href: https://finix.sandbox-payments-api.com/applications/APgPDQrLD52TYvqazjHJJchM
                  merchant_identity:
                    href: https://finix.sandbox-payments-api.com/identities/IDuqZpDw28f2KK6YuDk4jNLg
      headers:
        finix-apiuser-role:
          $ref: '#/components/headers/finix-apiuser-role'
        date:
          $ref: '#/components/headers/date'
        x-request-id:
          $ref: '#/components/headers/x-request-id'
    ErrorPaymentRequired:
      description: Payment Required
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorGeneric'
    AuthorizationsList:
      description: List of Authorization objects
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/AuthorizationsList'
          examples:
            List of Authorizations:
              value:
                _embedded:
                  authorizations:
                  - id: AUoCse3evsJWctBbh6hSEsZj
                    created_at: '2022-10-10T06:14:57.84Z'
                    updated_at: '2022-10-10T06:14:58.28Z'
                    3ds_redirect_url: null
                    additional_buyer_charges: null
                    additional_healthcare_data: null
                    address_verification: null
                    amount: 150
                    amount_requested: 150
                    application: APeUbTUjvYb1CdPXvNcwW1wP
                    card_present_details:
                      emv_data: null
                      masked_account_number: null
                      name: null
                      brand: null
                      entry_mode: null
                      payment_type: NONE
                      approval_code: null
                    currency: USD
                    device: DVsEanpBtsAVvCHbNXkFaH6f
                    expires_at: '2022-10-17T06:14:57.84Z'
                    failure_code: null

# --- truncated at 32 KB (101 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/finix-payments/refs/heads/main/openapi/finix-payments-authorizations-api-openapi.yml