MoneyHash Reconciliations API

openapi: 3.2.0
info:
  title: MoneyHash Reconciliations API
  version: 1.1.0
  description: MoneyHash Public APIs documentation
servers:
- url: https://web.moneyhash.io
tags:
- name: Reconciliations
paths:
  /api/v1.4/reconciliations/settlement-files/:
    post:
      operationId: v1.4_reconciliations_settlement_files_create
      description: Creates a new settlement file and returns a presigned URL for uploading. After uploading the file to the presigned URL, the client must call the confirm upload endpoint to confirm that the file has been uploaded and is ready to be processed.
      summary: Create a settlement file
      tags:
      - Reconciliations
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SettlementFileInit'
            examples:
              CreateSettlementFile-Request:
                value:
                  template_type: CHECKOUTCOM
                  file_name: settlement_report.csv
                summary: Create Settlement File - Request
                description: Usage example for POST /reconciliations/settlement-files/
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/SettlementFileInit'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/SettlementFileInit'
        required: true
      security:
      - ApiKeyAuth: []
      - AccessTokenAuth: []
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SettlementFileInit'
              examples:
                CreateSettlementFile-Response:
                  value:
                    status:
                      code: 201
                      message: success
                      errors: []
                    data:
                      id: A1b2C3d
                      template_type: CHECKOUTCOM
                      file_name: settlement_report.csv
                      upload_url: https://s3.amazonaws.com/example-presigned-upload-url
                    count: 1
                    next: null
                    previous: null
                  summary: Create Settlement File - Response
                  description: The response includes an id and upload_url used to upload the file content.
          description: ''
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DocsErrorResponse400'
              examples:
                CreateSettlementFile-InvalidExtension:
                  value:
                    status:
                      code: 400
                      message: ''
                      errors:
                      - file: 'File extension not supported for template type CHECKOUTCOM. Supported extensions are: [''.csv'']'
                    data: {}
                    count: null
                    next: null
                    previous: null
                  summary: Create Settlement File - Invalid Extension
                  description: Validation error when file extension is not supported for the selected template.
          description: ''
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DocsErrorResponse401'
          description: ''
  /api/v1.4/reconciliations/settlement-files/{settlement_file_id}/confirm_upload/:
    post:
      operationId: v1.4_reconciliations_settlement_files_confirm_upload_create
      description: Confirm that the settlement file was uploaded to the presigned URL and queue it for processing.
      summary: Confirm settlement file upload
      parameters:
      - in: path
        name: settlement_file_id
        schema:
          type: string
        required: true
      tags:
      - Reconciliations
      security:
      - ApiKeyAuth: []
      - AccessTokenAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SettlementFile'
              examples:
                ConfirmUpload-Success:
                  value:
                    status:
                      code: 200
                      message: success
                      errors: []
                    data:
                      template_type: CHECKOUTCOM
                      file_name: reconciliation_report_CHECKOUTCOM_20251118_142104.csv
                      status: PENDING_PARSING
                    count: 1
                    next: null
                    previous: null
                  summary: Confirm Upload - Success
          description: ''
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DocsErrorResponse400'
              examples:
                ConfirmUpload-NotInPendingState:
                  value:
                    status:
                      code: 400
                      message: ''
                      errors:
                      - error: File is not in pending state
                    data: {}
                    count: null
                    next: null
                    previous: null
                  summary: Confirm Upload - Not in Pending State
                ConfirmUpload-UploadVerificationFailed:
                  value:
                    status:
                      code: 400
                      message: ''
                      errors:
                      - error: Upload verification failed
                    data: {}
                    count: null
                    next: null
                    previous: null
                  summary: Confirm Upload - Upload Verification Failed
          description: ''
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DocsErrorResponse401'
              examples:
                UnauthorizedAPIKey:
                  value:
                    status:
                      code: 401
                      message: ''
                      errors:
                      - detail: Authentication credentials were not provided.
                    data: {}
                    count: null
                    next: null
                    previous: null
                  summary: Unauthorized API key
          description: ''
        '409':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DocsErrorResponse400'
              examples:
                ConfirmUpload-DuplicateFile:
                  value:
                    status:
                      code: 409
                      message: ''
                      errors:
                      - error: Duplicate file
                    data: {}
                    count: null
                    next: null
                    previous: null
                  summary: Confirm Upload - Duplicate File
          description: ''
  /api/v1.4/reconciliations/settlement-operations/:
    get:
      operationId: v1.4_reconciliations_settlement_operations_list
      description: List settlement operations for the authenticated account.
      summary: List settlement operations
      parameters:
      - in: query
        name: account_id
        schema:
          type: string
        description: Filter operations by account id.
      - in: query
        name: end_date
        schema:
          type: string
          format: date-time
        description: 'Filter operations created on or before this date. Accepted format: ISO 8601 (e.g., 2025-11-18T23:59:59Z).'
      - in: query
        name: intent_id
        schema:
          type: string
        description: Filter operations by payment intent id.
      - in: query
        name: is_live
        schema:
          type: boolean
        description: Filter by live or test mode.
      - name: limit
        required: false
        in: query
        description: Number of results to return per page.
        schema:
          type: integer
      - name: offset
        required: false
        in: query
        description: The initial index from which to return the results.
        schema:
          type: integer
      - in: query
        name: operation_source
        schema:
          type: string
        description: 'Source of operations. Supported values: MONEYHASH, EXTERNAL.'
      - in: query
        name: provider_id
        schema:
          type: string
        description: Filter operations by provider id.
      - in: query
        name: reconciliation_status
        schema:
          type: string
        description: 'Filter by reconciliation status. Supported values: MATCHED, MIS_MATCHED.'
      - in: query
        name: settlement_currency
        schema:
          type: string
        description: Filter by settlement currency code (e.g., USD, EUR). Supports multiple values.
      - in: query
        name: settlement_status
        schema:
          type: string
        description: 'Filter by settlement status. Supported values: SETTLED, UNSETTLED.'
      - in: query
        name: start_date
        schema:
          type: string
          format: date-time
        description: 'Filter operations created on or after this date. Accepted format: ISO 8601 (e.g., 2025-11-18T00:00:00Z).'
      tags:
      - Reconciliations
      security:
      - ApiKeyAuth: []
      - AccessTokenAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaginatedSettlementList'
              examples:
                ListSettlementOperations-Success:
                  value:
                    count: 123
                    next: http://api.example.org/accounts/?offset=400&limit=100
                    previous: http://api.example.org/accounts/?offset=200&limit=100
                    results:
                    - status:
                        code: 200
                        message: success
                        errors: []
                      data:
                      - merchant_reference: order_123
                        transaction_uuid: trx_123
                        provider_transaction_id: pay_123
                        arn: null
                        rrn: null
                        operation_type: AUTHORIZE
                        settlement_status: SETTLED
                        reconciliation_status: null
                        operation_amount: '50.00'
                        operation_currency: USD
                        provider_gross_amount: '50.00'
                        provider_fees: '1.00'
                        provider_tax: '0.05'
                        provider_settled_amount_net: '48.95'
                        settlement_currency: USD
                        transaction_date: '2025-11-18T14:21:04Z'
                        settlement_date: '2025-11-19'
                        payment_method: CARD
                        provider: Checkout.com
                        organization_id: org_123
                        organization_name: test_org
                        card_brand: VISA
                        issuer: Bank Name
                        bin: '411111'
                        authorization_code: '123456'
                        provider_connection:
                          id: provider_connection_id
                          name: test_checkout
                      count: 1
                      next: null
                      previous: null
                  summary: List Settlement Operations - Success
                  description: Usage example for GET /reconciliations/settlement-operations/?operation_source=MONEYHASH
          description: ''
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DocsErrorResponse401'
              examples:
                UnauthorizedAPIKey:
                  value:
                    status:
                      code: 401
                      message: ''
                      errors:
                      - detail: Authentication credentials were not provided.
                    data: {}
                    count: null
                    next: null
                    previous: null
                  summary: Unauthorized API key
          description: ''
components:
  schemas:
    DocsErrorResponse400:
      type: object
      properties:
        status:
          $ref: '#/components/schemas/DocsStatus'
        data:
          type: object
          additionalProperties: {}
        count:
          type:
          - integer
          - 'null'
          description: Total number of items.
        next:
          type:
          - string
          - 'null'
          description: Next page url if exists
        previous:
          type:
          - string
          - 'null'
          description: Previous page url if exists
      required:
      - count
      - data
      - next
      - previous
      - status
    Settlement:
      type: object
      properties:
        merchant_reference:
          type: string
          description: Merchant reference for the transaction, if available.
        transaction_uuid:
          type: string
          description: UUID of the transaction.
        provider_transaction_id:
          type: string
          description: Payment ID assigned by the provider for this settlement operation.
        arn:
          type: string
          description: Acquirer Reference Number (ARN). Used to track transactions between banks and card networks.
        rrn:
          type: string
          description: Retrieval Reference Number (RRN). A key to uniquely identify a card transaction based on the ISO 8583 standard.
        operation_type:
          type: string
          description: 'Type of the operation. Possible values: PURCHASE, AUTHORIZE, CAPTURE, REFUND, VOID, etc.'
        settlement_status:
          type: string
          readOnly: true
          description: Settlement status of the operation, e.g., SETTLED or UNSETTLED.
        reconciliation_status:
          type: string
          description: Reconciliation status of the operation.
        operation_amount:
          type: string
          description: Amount of the operation.
        operation_currency:
          type: string
          description: Currency of the operation amount.
        provider_gross_amount:
          type: string
          description: Gross amount reported by the provider.
        provider_fees:
          type: string
          description: Fees charged by the provider.
        provider_tax:
          type: string
          description: Taxes charged by the provider.
        provider_settled_amount_net:
          type: string
          description: Net settled amount after fees and taxes.
        settlement_currency:
          type: string
          description: Currency of the settlement.
        transaction_date:
          type: string
          description: Date and time of the transaction.
        settlement_date:
          type: string
          description: Date of the settlement.
        payment_method:
          type: string
          description: Payment method used for the transaction, e.g., CARD.
        provider:
          type: string
          readOnly: true
          description: Display name of the payment provider.
        organization_id:
          type: string
          description: ID of the organization.
        organization_name:
          type: string
          description: Name of the organization.
        card_brand:
          type: string
          readOnly: true
          description: Card brand, e.g., VISA, MASTERCARD.
        issuer:
          type: string
          readOnly: true
          description: Card issuer bank name.
        bin:
          type: string
          readOnly: true
          description: Bank Identification Number (first 6 digits of the card).
        authorization_code:
          type: string
          readOnly: true
          description: Authorization code returned by the provider.
        provider_connection:
          type: string
          readOnly: true
          description: Provider connection details including ID and name.
      required:
      - arn
      - authorization_code
      - bin
      - card_brand
      - issuer
      - merchant_reference
      - operation_amount
      - operation_currency
      - operation_type
      - organization_id
      - organization_name
      - payment_method
      - provider
      - provider_connection
      - provider_fees
      - provider_gross_amount
      - provider_settled_amount_net
      - provider_tax
      - provider_transaction_id
      - reconciliation_status
      - rrn
      - settlement_currency
      - settlement_date
      - settlement_status
      - transaction_date
      - transaction_uuid
    PaginatedSettlementList:
      type: object
      properties:
        count:
          type: integer
          example: 123
        next:
          type:
          - string
          - 'null'
          format: uri
          example: http://api.example.org/accounts/?offset=400&limit=100
        previous:
          type:
          - string
          - 'null'
          format: uri
          example: http://api.example.org/accounts/?offset=200&limit=100
        results:
          type: array
          items:
            $ref: '#/components/schemas/Settlement'
    DocsErrorResponse401:
      type: object
      properties:
        status:
          $ref: '#/components/schemas/DocsStatus'
        data:
          type: object
          additionalProperties: {}
        count:
          type:
          - integer
          - 'null'
          description: Total number of items.
        next:
          type:
          - string
          - 'null'
          description: Next page url if exists
        previous:
          type:
          - string
          - 'null'
          description: Previous page url if exists
      required:
      - count
      - data
      - next
      - previous
      - status
    SettlementFileInit:
      type: object
      properties:
        id:
          type: string
          description: File id - Returned after creating the settlement file instance, used for confirming the upload
        template_type:
          enum:
          - CHECKOUTCOM
          - PAYFORT_MAGNATI
          - TAP_CHARGE
          - TAP_REFUND
          - PEACH_PAYMENTS
          type: string
          x-spec-enum-id: 4cefd7f21e36d489
          description: 'Type of the settlement file being uploaded. This determines the expected format of the file and how it will be processed. Supported types are: CHECKOUTCOM, PAYFORT_MAGNATI, TAP_CHARGE, TAP_REFUND, PEACH_PAYMENTS


            * `CHECKOUTCOM` - CHECKOUTCOM

            * `PAYFORT_MAGNATI` - PAYFORT_MAGNATI

            * `TAP_CHARGE` - TAP_CHARGE

            * `TAP_REFUND` - TAP_REFUND

            * `PEACH_PAYMENTS` - PEACH_PAYMENTS'
        file_name:
          type: string
          description: Name of the settlement file being uploaded, including extension.
        upload_url:
          type: string
          readOnly: true
          description: Presigned URL to which the settlement file should be uploaded. This is returned after creating the settlement file instance.
      required:
      - file_name
      - template_type
      - upload_url
    SettlementFile:
      type: object
      properties:
        template_type:
          enum:
          - CHECKOUTCOM
          - PAYFORT_MAGNATI
          - TAP_CHARGE
          - TAP_REFUND
          - PEACH_PAYMENTS
          type: string
          description: '* `CHECKOUTCOM` - CHECKOUTCOM

            * `PAYFORT_MAGNATI` - PAYFORT_MAGNATI

            * `TAP_CHARGE` - TAP_CHARGE

            * `TAP_REFUND` - TAP_REFUND

            * `PEACH_PAYMENTS` - PEACH_PAYMENTS'
          x-spec-enum-id: 4cefd7f21e36d489
        file_name:
          type: string
          maxLength: 255
        status:
          enum:
          - PENDING_UPLOAD
          - PENDING_PARSING
          - PARSING
          - PARSING_FAILED
          - PENDING_MATCHING
          - MATCHING
          - MATCHING_FAILED
          - PENDING_SETTLING
          - SETTLING
          - SETTLING_FAILED
          - COMPLETED
          type: string
          description: '* `PENDING_UPLOAD` - PENDING_UPLOAD

            * `PENDING_PARSING` - PENDING_PARSING

            * `PARSING` - PARSING

            * `PARSING_FAILED` - PARSING_FAILED

            * `PENDING_MATCHING` - PENDING_MATCHING

            * `MATCHING` - MATCHING

            * `MATCHING_FAILED` - MATCHING_FAILED

            * `PENDING_SETTLING` - PENDING_SETTLING

            * `SETTLING` - SETTLING

            * `SETTLING_FAILED` - SETTLING_FAILED

            * `COMPLETED` - COMPLETED'
          x-spec-enum-id: 7df02a961faa80d7
      required:
      - file_name
      - template_type
    DocsStatus:
      type: object
      properties:
        data:
          description: Response message
      required:
      - data
  securitySchemes:
    AccessTokenAuth:
      type: apiKey
      in: query
      name: access_token
    ApiKeyAuth:
      type: apiKey
      in: header
      name: X-Api-Key
x-provenance:
  method: searched
  source: https://docs.moneyhash.io/reference
  harvested: '2026-10-26'
  tool: harvest-readme-openapi.py
  note: Assembled verbatim from the OpenAPI definition ReadMe embeds in each operation page of the provider's developer portal; paths and components merged by API title, nothing authored.
  assembled_from:
  - https://docs.moneyhash.io/reference/v11_accounts_create.md
  - https://docs.moneyhash.io/reference/v11_accounts_get_from_access_token_retrieve.md
  - https://docs.moneyhash.io/reference/v11_accounts_list.md
  - https://docs.moneyhash.io/reference/v11_accounts_payment_methods_create.md
  - https://docs.moneyhash.io/reference/v11_accounts_reset_access_token_create.md
  - https://docs.moneyhash.io/reference/v11_accounts_transactions_list.md
  - https://docs.moneyhash.io/reference/v11_customers_cards_destroy.md
  - https://docs.moneyhash.io/reference/v11_customers_cards_list.md
  - https://docs.moneyhash.io/reference/v11_customers_create.md
  - https://docs.moneyhash.io/reference/v11_customers_destroy.md
  - https://docs.moneyhash.io/reference/v11_customers_list.md
  - https://docs.moneyhash.io/reference/v11_customers_partial_update.md
  - https://docs.moneyhash.io/reference/v11_customers_retrieve.md
  - https://docs.moneyhash.io/reference/v11_customers_subscriptions_retrieve.md
  - https://docs.moneyhash.io/reference/v11_customers_transactions_list.md
  - https://docs.moneyhash.io/reference/v11_customers_wallets_debit_create.md
  - https://docs.moneyhash.io/reference/v11_customers_wallets_top_up_create.md
  - https://docs.moneyhash.io/reference/v11_direct_payments_intent_create.md
  - https://docs.moneyhash.io/reference/v11_direct_payments_intents_card_token_create.md
  - https://docs.moneyhash.io/reference/v11_direct_payments_intents_create.md
  - https://docs.moneyhash.io/reference/v11_direct_payments_intents_receipt_create.md
  - https://docs.moneyhash.io/reference/v11_direct_payments_intents_retrieve.md
  - https://docs.moneyhash.io/reference/v11_direct_payments_intents_update_method_create.md
  - https://docs.moneyhash.io/reference/v11_external_payments_intent_create.md
  - https://docs.moneyhash.io/reference/v11_external_payments_intents_card_token_create.md
  - https://docs.moneyhash.io/reference/v11_external_payments_intents_receipt_create.md
  - https://docs.moneyhash.io/reference/v11_external_payments_intents_retrieve.md
  - https://docs.moneyhash.io/reference/v11_external_payments_intents_update_method_create.md
  - https://docs.moneyhash.io/reference/v11_loyalty_earn_create.md
  - https://docs.moneyhash.io/reference/v11_loyalty_earn_retrieve.md
  - https://docs.moneyhash.io/reference/v11_loyalty_earn_reverse_create.md
  - https://docs.moneyhash.io/reference/v11_loyalty_eligibility_create.md
  - https://docs.moneyhash.io/reference/v11_payment_links_create.md
  - https://docs.moneyhash.io/reference/v11_payment_links_status_retrieve.md
  - https://docs.moneyhash.io/reference/v11_payment_links_update_quantities_create.md
  - https://docs.moneyhash.io/reference/v11_payments_charge_card_token_create.md
  - https://docs.moneyhash.io/reference/v11_payments_intent_close_create.md
  - https://docs.moneyhash.io/reference/v11_payments_intent_create.md
  - https://docs.moneyhash.io/reference/v11_payments_intent_retrieve.md
  - https://docs.moneyhash.io/reference/v11_payments_intents_transactions_list.md
  - https://docs.moneyhash.io/reference/v11_payments_transactions_anomalies_resolve_create.md
  - https://docs.moneyhash.io/reference/v11_payments_transactions_capture_create.md
  - https://docs.moneyhash.io/reference/v11_payments_transactions_increase_authorization_create.md
  - https://docs.moneyhash.io/reference/v11_payments_transactions_pull_status_create.md
  - https://docs.moneyhash.io/reference/v11_payments_transactions_refund_create.md
  - https://docs.moneyhash.io/reference/v11_payments_transactions_retrieve.md
  - https://docs.moneyhash.io/reference/v11_payments_transactions_void_create.md
  - https://docs.moneyhash.io/reference/v11_payout_bulk_requests_cancel_create.md
  - https://docs.moneyhash.io/reference/v11_payout_bulk_requests_create.md
  - https://docs.moneyhash.io/reference/v11_payout_bulk_requests_items_cancel_create.md
  - https://docs.moneyhash.io/reference/v11_payout_bulk_requests_items_list.md
  - https://docs.moneyhash.io/reference/v11_payout_bulk_requests_items_retrieve.md
  - https://docs.moneyhash.io/reference/v11_payout_bulk_requests_list.md
  - https://docs.moneyhash.io/reference/v11_payout_bulk_requests_retrieve.md
  - https://docs.moneyhash.io/reference/v11_payout_intent_close_create.md
  - https://docs.moneyhash.io/reference/v11_payout_intent_create.md
  - https://docs.moneyhash.io/reference/v11_payout_transactions_pull_status_create.md
  - https://docs.moneyhash.io/reference/v11_payout_transactions_void_create.md
  - https://docs.moneyhash.io/reference/v11_subscriptions_card_token_create.md
  - https://docs.moneyhash.io/reference/v11_subscriptions_create.md
  - https://docs.moneyhash.io/reference/v11_subscriptions_list.md
  - https://docs.moneyhash.io/reference/v11_subscriptions_plan_groups_list.md
  - https://docs.moneyhash.io/reference/v11_subscriptions_plan_groups_retrieve.md
  - https://docs.moneyhash.io/reference/v11_subscriptions_plans_create.md
  - https://docs.moneyhash.io/reference/v11_subscriptions_plans_list.md
  - https://docs.moneyhash.io/reference/v11_subscriptions_retrieve.md
  - https://docs.moneyhash.io/reference/v11_subscriptions_retry_payment_create.md
  - https://docs.moneyhash.io/reference/v11_subscriptions_update_amount_create.md
  - https://docs.moneyhash.io/reference/v11_subscriptions_update_discount_create.md
  - https://docs.moneyhash.io/reference/v11_subscriptions_update_plan_create.md
  - https://docs.moneyhash.io/reference/v11_subscriptions_update_remaining_recurring_cycles_create.md
  - https://docs.moneyhash.io/reference/v11_tokens_cards_create.md
  - https://docs.moneyhash.io/reference/v11_tokens_cards_retrieve.md
  - https://docs.moneyhash.io/reference/v11_tokens_intent_details_retrieve.md
  - https://docs.moneyhash.io/reference/v11_transactions_transition_create.md
  - https://docs.moneyhash.io/reference/v12_external_payments_intents_get_current_state_create.md
  - https://docs.moneyhash.io/reference/v14_reconciliations_settlement_files_confirm_upload_create.md
  - https://docs.moneyhash.io/reference/v14_reconciliations_settlement_files_create.md
  - https://docs.moneyhash.io/reference/v14_reconciliations_settlement_operations_list.md
  - https://docs.moneyhash.io/reference/v1_providers_available_list.md
  - https://docs.moneyhash.io/reference/v1_providers_connected_list.md
  - https://docs.moneyhash.io/reference/v1_providers_countries_retrieve.md
  - https://docs.moneyhash.io/reference/v1_providers_sync_available_create.md
  - https://docs.moneyhash.io/reference/v1_providers_sync_available_list.md
  - https://docs.moneyhash.io/reference/v1_providers_sync_connected_list.md
  merge:
    pages: 85
    deduped: 568
    conflicts_kept_first: 0