Modern Treasury PaymentReference API

openapi: 3.0.1
info:
  title: Modern Treasury AccountCapability PaymentReference API
  version: v1
  contact:
    name: Modern Treasury Engineering Team
    url: https://moderntreasury.com
  description: The Modern Treasury REST API. Please see https://docs.moderntreasury.com for more details.
servers:
- url: http://localhost:3000
- url: https://app.moderntreasury.com
tags:
- name: PaymentReference
paths:
  /api/payment_references:
    get:
      summary: list payment_references
      tags:
      - PaymentReference
      operationId: listPaymentReferences
      security:
      - basic_auth: []
      parameters:
      - name: after_cursor
        in: query
        schema:
          type: string
          nullable: true
        required: false
      - name: per_page
        in: query
        schema:
          type: integer
        required: false
      - name: referenceable_id
        in: query
        schema:
          type: string
        required: false
        description: The id of the referenceable to search for. Must be accompanied by the referenceable_type or will return an error.
      - name: referenceable_type
        in: query
        schema:
          type: string
          enum:
          - payment_order
          - return
          - reversal
        required: false
        description: One of the referenceable types. This must be accompanied by the id of the referenceable or will return an error.
      - name: reference_number
        in: query
        schema:
          type: string
        required: false
        description: The actual reference number assigned by the bank.
      responses:
        '200':
          description: successful
          headers:
            X-After-Cursor:
              schema:
                type: string
                nullable: true
              required: false
              description: The cursor for the next page. Including this in a call as `after_cursor` will return the next page.
            X-Per-Page:
              schema:
                type: integer
                nullable: true
              description: The current `per_page`.
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/payment_reference_object'
        '422':
          description: validation error
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: string
  /api/payment_references/{id}:
    parameters:
    - name: id
      in: path
      schema:
        type: string
      description: id
      required: true
    get:
      summary: get payment_reference
      tags:
      - PaymentReference
      operationId: getPaymentReference
      security:
      - basic_auth: []
      responses:
        '200':
          description: successful
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/payment_reference_object'
components:
  schemas:
    payment_reference_object:
      type: object
      properties:
        id:
          type: string
          format: uuid
        object:
          type: string
        live_mode:
          type: boolean
          description: This field will be true if this object exists in the live environment or false if it exists in the test environment.
        created_at:
          type: string
          format: date-time
        updated_at:
          type: string
          format: date-time
        referenceable_id:
          type: string
          description: The id of the referenceable to search for. Must be accompanied by the referenceable_type or will return an error.
        referenceable_type:
          type: string
          enum:
          - payment_order
          - reversal
          - return
          description: One of the referenceable types. This must be accompanied by the id of the referenceable or will return an error.
        reference_number:
          type: string
          description: The actual reference number assigned by the bank.
        reference_number_type:
          type: string
          enum:
          - ach_original_trace_number
          - ach_trace_number
          - bankprov_payment_activity_date
          - bankprov_payment_id
          - blockchain_transaction_hash
          - blockchain_transaction_index
          - bnk_dev_prenotification_id
          - bnk_dev_transfer_id
          - bny_mellon_transaction_reference_number
          - bofa_end_to_end_id
          - bofa_neft_clearing_reference_number
          - bofa_transaction_id
          - check_number
          - chips_uid
          - citibank_reference_number
          - citibank_worldlink_clearing_system_reference_number
          - column_fx_quote_id
          - column_reversal_pair_transfer_id
          - column_transfer_id
          - cross_river_card_trace_number
          - cross_river_core_transaction_id
          - cross_river_fed_batch_id
          - cross_river_payment_id
          - cross_river_retrieval_reference_id
          - cross_river_service_message
          - cross_river_transaction_id
          - currencycloud_conversion_id
          - currencycloud_payment_id
          - dc_bank_transaction_id
          - eft_trace_number
          - evolve_core_batch
          - evolve_core_file_key
          - evolve_core_seq
          - evolve_transaction_id
          - fake_vendor_payment_id
          - fedwire_imad
          - fedwire_omad
          - first_republic_internal_id
          - goldman_sachs_collection_request_id
          - goldman_sachs_end_to_end_id
          - goldman_sachs_payment_request_id
          - goldman_sachs_request_id
          - goldman_sachs_unique_payment_id
          - interac_message_id
          - jpmc_ccn
          - jpmc_clearing_system_reference
          - jpmc_customer_reference_id
          - jpmc_end_to_end_id
          - jpmc_firm_root_id
          - jpmc_fx_trn_id
          - jpmc_p3_id
          - jpmc_payment_batch_id
          - jpmc_payment_information_id
          - jpmc_payment_returned_datetime
          - jpmc_transaction_reference_number
          - lob_check_id
          - other
          - partial_swift_mir
          - paxos_crypto_withdrawal_id
          - paxos_fiat_withdrawal_id
          - paxos_group_id
          - paxos_orchestration_id
          - paxos_transfer_id
          - pnc_clearing_reference
          - pnc_instruction_id
          - pnc_multipayment_id
          - pnc_payment_trace_id
          - pnc_request_for_payment_id
          - pnc_transaction_reference_number
          - rbc_wire_reference_id
          - rtp_instruction_id
          - signet_api_reference_id
          - signet_confirmation_id
          - signet_request_id
          - silvergate_payment_id
          - svb_end_to_end_id
          - svb_payment_id
          - swift_mir
          - swift_uetr
          - umb_product_partner_account_number
          - usbank_payment_application_reference_id
          - usbank_payment_id
          - usbank_pending_rtp_payment_id
          - usbank_posted_rtp_payment_id
          - wells_fargo_end_to_end_id
          - wells_fargo_payment_id
          - wells_fargo_trace_number
          - wells_fargo_uetr
          - western_alliance_payment_id
          - western_alliance_transaction_id
          - western_alliance_wire_confirmation_number
          description: The type of reference number.
      additionalProperties: false
      minProperties: 9
      required:
      - id
      - object
      - live_mode
      - created_at
      - updated_at
      - referenceable_id
      - referenceable_type
      - reference_number
      - reference_number_type
  securitySchemes:
    basic_auth:
      type: http
      scheme: basic