openapi: 3.2.0
info:
  title: Monite Batch payments API
  contact:
    name: Monite team
    url: https://monite.com/about/
    email: developers@monite.com
  termsOfService: https://monite.com/terms
  version: '1.0'
  description: 'Operations tagged Batch payments across 3 of this provider''s published API definitions: monite-openapi-2023-09-01.json, monite-openapi-2024-05-25.json, monite-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://api.dev.monite.com/v1
  description: Development environment
- url: https://api.sandbox.monite.com/v1
  description: Sandbox environment
- url: https://api.monite.com/v1
  description: Production environment (Europe)
- url: https://us.api.monite.com/v1
  description: Production environment (North America)
- url: https://api.monite.oaknorth.co.uk/v1
  description: Oak POC environment
tags:
- name: Batch payments
paths:
  /batch_payments:
    post:
      tags:
      - Batch payments
      summary: Create a batch payment
      operationId: post_batch_payments
      parameters:
      - required: true
        schema:
          type: string
          format: date
        example: '2023-09-01'
        name: x-monite-version
        in: header
      - description: The ID of the entity that owns the requested resource.
        required: true
        schema:
          type: string
          format: uuid
          examples:
          - 9d2b4c8f-2087-4738-ba91-7359683c49a4
        name: x-monite-entity-id
        in: header
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PaymentsBatchPaymentRequest'
        required: true
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaymentsBatchPaymentResponse'
        '405':
          description: Method Not Allowed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchemaResponse'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchemaResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
      - HTTPBearer: []
    servers:
    - url: https://api.dev.monite.com/v1
      description: Development environment
    - url: https://api.sandbox.monite.com/v1
      description: Sandbox environment
    - url: https://api.monite.com/v1
      description: Production environment (Europe)
    - url: https://us.api.monite.com/v1
      description: Production environment (North America)
    - url: https://api.monite.oaknorth.co.uk/v1
      description: Oak POC environment
  /batch_payments/{batch_payment_id}:
    get:
      tags:
      - Batch payments
      summary: Get batch payment by ID
      operationId: get_batch_payments_id
      parameters:
      - required: true
        schema:
          type: string
          format: date
        example: '2023-09-01'
        name: x-monite-version
        in: header
      - required: true
        schema:
          type: string
          format: uuid
        name: batch_payment_id
        in: path
      - description: The ID of the entity that owns the requested resource.
        required: true
        schema:
          type: string
          format: uuid
          examples:
          - 9d2b4c8f-2087-4738-ba91-7359683c49a4
        name: x-monite-entity-id
        in: header
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaymentsBatchPaymentResponse'
        '405':
          description: Method Not Allowed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchemaResponse'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchemaResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
      - HTTPBearer: []
    servers:
    - url: https://api.dev.monite.com/v1
      description: Development environment
    - url: https://api.sandbox.monite.com/v1
      description: Sandbox environment
    - url: https://api.monite.com/v1
      description: Production environment (Europe)
    - url: https://us.api.monite.com/v1
      description: Production environment (North America)
    - url: https://api.monite.oaknorth.co.uk/v1
      description: Oak POC environment
components:
  schemas:
    PaymentIntentPayoutMethod:
      type: string
      enum:
      - bank_account
      - paper_check
      - us_ach
      - wire
    SinglePaymentIntentResponse:
      properties:
        id:
          type: string
          format: uuid
        created_at:
          type: string
          format: date-time
        amount:
          type: integer
        currency:
          $ref: '#/components/schemas/CurrencyEnum'
        error:
          type: object
        object:
          $ref: '#/components/schemas/PaymentObjectPayable'
        payment_reference:
          type: string
        recipient:
          $ref: '#/components/schemas/PaymentIntentsRecipient'
        status:
          type: string
      additionalProperties: false
      type: object
      required:
      - id
      - created_at
      - amount
      - currency
      - object
      - payment_reference
      - recipient
      - status
    PaymentsBatchPaymentStatus:
      type: string
      enum:
      - created
      - processing
      - partially_successful
      - succeeded
      - failed
      - expired
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
      type: object
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
            - type: string
            - type: integer
          type: array
        msg:
          type: string
        type:
          type: string
      type: object
      required:
      - loc
      - msg
      - type
    PaymentObjectPayable:
      properties:
        id:
          type: string
          format: uuid
        type:
          type: string
          enum:
          - payable
      additionalProperties: false
      type: object
      required:
      - id
      - type
    ErrorSchema:
      properties:
        message:
          type: string
      type: object
      required:
      - message
    PaymentsBatchPaymentResponse:
      properties:
        id:
          type: string
          format: uuid
        created_at:
          type: string
          format: date-time
        error:
          type: object
        payer_bank_account_id:
          type: string
          format: uuid
        payment_intents:
          items:
            $ref: '#/components/schemas/SinglePaymentIntentResponse'
          type: array
          minItems: 1
        payment_method:
          type: string
          enum:
          - us_ach
        status:
          $ref: '#/components/schemas/PaymentsBatchPaymentStatus'
        total_amount:
          type: integer
      additionalProperties: false
      type: object
      required:
      - id
      - created_at
      - payer_bank_account_id
      - payment_intents
      - payment_method
      - status
    PaymentIntentsRecipient:
      properties:
        id:
          type: string
          format: uuid
        bank_account_id:
          type: string
          format: uuid
        payout_method:
          allOf:
          - $ref: '#/components/schemas/PaymentIntentPayoutMethod'
          default: bank_account
        type:
          type: string
          enum:
          - counterpart
      additionalProperties: false
      type: object
      required:
      - id
      - type
    CurrencyEnum:
      type: string
      enum:
      - AED
      - AFN
      - ALL
      - AMD
      - ANG
      - AOA
      - ARS
      - AUD
      - AWG
      - AZN
      - BAM
      - BBD
      - BDT
      - BGN
      - BHD
      - BIF
      - BMD
      - BND
      - BOB
      - BRL
      - BSD
      - BTN
      - BWP
      - BYN
      - BZD
      - CAD
      - CDF
      - CHF
      - CLP
      - CNY
      - COP
      - CRC
      - CVE
      - CZK
      - DJF
      - DKK
      - DOP
      - DZD
      - EGP
      - ETB
      - EUR
      - FJD
      - FKP
      - GBP
      - GEL
      - GHS
      - GIP
      - GMD
      - GNF
      - GTQ
      - GYD
      - HKD
      - HNL
      - HTG
      - HUF
      - IDR
      - ILS
      - INR
      - IQD
      - ISK
      - JMD
      - JOD
      - JPY
      - KES
      - KGS
      - KHR
      - KMF
      - KRW
      - KWD
      - KYD
      - KZT
      - LAK
      - LBP
      - LKR
      - LRD
      - LSL
      - LYD
      - MAD
      - MDL
      - MGA
      - MKD
      - MMK
      - MNT
      - MOP
      - MUR
      - MVR
      - MWK
      - MXN
      - MYR
      - MZN
      - NAD
      - NGN
      - NIO
      - NOK
      - NPR
      - NZD
      - OMR
      - PAB
      - PEN
      - PGK
      - PHP
      - PKR
      - PLN
      - PYG
      - QAR
      - RON
      - RSD
      - RUB
      - RWF
      - SAR
      - SBD
      - SCR
      - SEK
      - SGD
      - SHP
      - SLE
      - SOS
      - SRD
      - SSP
      - SVC
      - SZL
      - THB
      - TJS
      - TMT
      - TND
      - TOP
      - TRY
      - TTD
      - TWD
      - TZS
      - UAH
      - UGX
      - USD
      - UYU
      - UZS
      - VND
      - VUV
      - WST
      - XAF
      - XCD
      - XOF
      - XPF
      - YER
      - ZAR
      - ZMW
    ErrorSchemaResponse:
      properties:
        error:
          $ref: '#/components/schemas/ErrorSchema'
      type: object
      required:
      - error
    PaymentsBatchPaymentRequest:
      properties:
        payer_bank_account_id:
          type: string
          format: uuid
        payment_intents:
          items:
            $ref: '#/components/schemas/SinglePaymentIntent'
          type: array
          minItems: 1
        payment_method:
          type: string
          enum:
          - us_ach
      additionalProperties: false
      type: object
      required:
      - payer_bank_account_id
      - payment_intents
      - payment_method
    SinglePaymentIntent:
      properties:
        object:
          $ref: '#/components/schemas/PaymentObjectPayable'
        payment_reference:
          type: string
          description: Must be provided if payable's document id is missing.
        recipient:
          $ref: '#/components/schemas/PaymentIntentsRecipient'
      additionalProperties: false
      type: object
      required:
      - object
      - recipient
  securitySchemes:
    HTTPBearer:
      type: http
      scheme: bearer
x-refined-from:
- monite-openapi-2023-09-01.json
- monite-openapi-2024-05-25.json
- monite-openapi.yml