openapi: 3.2.0
info:
  title: Monite Batch payment links 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 payment links 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 payment links
paths:
  /batch_payment_links:
    post:
      tags:
      - Batch payment links
      summary: Create a batch payment link
      operationId: post_batch_payment_links
      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/BatchPaymentLinkRequest'
        required: true
      responses:
        '201':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BatchPaymentLinkResponse'
        '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_payment_links/{batch_payment_link_id}:
    get:
      tags:
      - Batch payment links
      summary: Get a batch payment link by ID
      operationId: get_batch_payment_links_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_link_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/BatchPaymentLinkWithPaymentIntents'
        '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_payment_links/{batch_payment_link_id}/expire:
    post:
      tags:
      - Batch payment links
      summary: Expire a batch payment link
      operationId: post_batch_payment_links_id_expire
      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_link_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/BatchPaymentLinkWithPaymentIntents'
        '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:
    InvoiceFile:
      properties:
        mimetype:
          type: string
          minLength: 1
        name:
          type: string
          minLength: 1
        url:
          type: string
          maxLength: 2083
          minLength: 1
          format: uri
      additionalProperties: false
      type: object
      required:
      - mimetype
      - name
      - url
    MoniteAllPaymentMethodsTypes:
      type: string
      enum:
      - sepa_credit
      - us_ach
      - blik
      - card
      - bacs_direct_debit
      - bancontact
      - eps
      - giropay
      - ideal
      - p24
      - sepa_debit
      - sofort
      - applepay
      - googlepay
      - affirm
      - klarna
    PaymentIntentResponse:
      properties:
        id:
          type: string
          format: uuid
        updated_at:
          type: string
          format: date-time
        amount:
          type: integer
        application_fee_amount:
          type: integer
        batch_payment_id:
          type: string
          format: uuid
        currency:
          type: string
        invoice:
          $ref: '#/components/schemas/Invoice'
        object:
          $ref: '#/components/schemas/PaymentObject'
        payer:
          $ref: '#/components/schemas/PayerAccountResponse'
        payment_link_id:
          type: string
          format: uuid
        payment_methods:
          items:
            $ref: '#/components/schemas/MoniteAllPaymentMethodsTypes'
          type: array
        payment_reference:
          type: string
        provider:
          type: string
        recipient:
          $ref: '#/components/schemas/RecipientAccountResponse'
        selected_payment_method:
          $ref: '#/components/schemas/MoniteAllPaymentMethodsTypes'
        status:
          type: string
      type: object
      required:
      - id
      - updated_at
      - amount
      - currency
      - payment_methods
      - recipient
      - status
    BatchPaymentIntentsRecipient:
      properties:
        id:
          type: string
          format: uuid
        bank_account_id:
          type: string
          format: uuid
        type:
          type: string
          enum:
          - counterpart
      additionalProperties: false
      type: object
      required:
      - id
      - type
      description: 'Recipient schema specific for batch payment links.

        Supports ''us_ach'' and ''wire'' payout methods in the schema, but only ''us_ach'' is currently used.

        Validation is done at the scenario level.'
    BatchPaymentLinkWithPaymentIntents:
      properties:
        id:
          type: string
          format: uuid
        created_at:
          type: string
          format: date-time
        error:
          type: object
        expires_at:
          type: string
          format: date-time
        payment_intents:
          items:
            $ref: '#/components/schemas/PaymentIntentResponse'
          type: array
        payment_page_url:
          type: string
          maxLength: 2083
          minLength: 1
          format: uri
        status:
          $ref: '#/components/schemas/PaymentsBatchPaymentStatus'
        total_amount:
          type: integer
      type: object
      required:
      - id
      - created_at
      - expires_at
      - payment_intents
      - payment_page_url
      - status
      description: 'Response schema for a batch payment link with payment intents.

        Used for GET /batch_payment_links/{link_id} endpoint.'
    PayerAccountResponse:
      properties:
        id:
          type: string
          format: uuid
          description: ID of a payment account
        bank_accounts:
          items:
            $ref: '#/components/schemas/BankAccount'
          type: array
          description: List of bank accounts
        name:
          type: string
          description: Display name of a payment account
        type:
          allOf:
          - $ref: '#/components/schemas/PaymentAccountType'
          description: Type of a payment account. Can be `entity` or `counterpart`
      type: object
      required:
      - id
      - type
    BankAccount:
      properties:
        id:
          type: string
          format: uuid
          description: The ID of the bank account.
        account_holder_name:
          type: string
          description: The name of the person or business that owns this bank account.
          examples:
          - Bob Jones
        account_number:
          type: string
          description: The bank account number. Typically used for UK and US bank accounts. US account numbers contain 9 to 12 digits. UK account numbers typically contain 8 digits.
          examples:
          - '12345678'
        bic:
          type: string
          maxLength: 11
          description: The BIC/SWIFT code of the bank.
          examples:
          - DEUTDEFFXXX
        country:
          allOf:
          - $ref: '#/components/schemas/AllowedCountries'
          description: The country in which the bank account is registered, repsesented as a two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
          examples:
          - DE
        currency:
          allOf:
          - $ref: '#/components/schemas/CurrencyEnum'
          description: The currency of the bank account, represented as a three-letter ISO [currency code](https://docs.monite.com/references/currencies).
          examples:
          - EUR
        display_name:
          type: string
          maxLength: 200
          description: User-defined name of this bank account, such as 'Primary account' or 'Savings account'. Used only for entity bank accounts.
          examples:
          - Primary account
        iban:
          type: string
          maxLength: 34
          description: The IBAN of the bank account.
          examples:
          - DE74500700100100000900
        is_default:
          type: boolean
          description: Indicates whether this bank account is the default one for its currency.
          default: false
        name:
          type: string
          maxLength: 200
          description: User-defined name of this bank account, such as 'Primary account' or 'Savings account'. Used only for counterpart bank accounts.
          examples:
          - Primary account
        routing_number:
          type: string
          description: The bank's routing transit number (RTN). Typically used for US banks. US routing numbers consist of 9 digits.
        sort_code:
          type: string
          description: The bank's sort code. Typically used for UK banks.
          examples:
          - '123456'
        was_created_by_user_id:
          type: string
          format: uuid
          description: ID of the entity user who added this bank account, or `null` if it was added using a partner access token. Used only for entity bank accounts.
      type: object
      required:
      - id
    PaymentObject:
      properties:
        id:
          type: string
          format: uuid
        type:
          $ref: '#/components/schemas/PaymentObjectType'
      additionalProperties: false
      type: object
      required:
      - id
      - type
    PaymentAccountType:
      type: string
      enum:
      - entity
      - counterpart
    PaymentObjectPayable:
      properties:
        id:
          type: string
          format: uuid
        type:
          type: string
          enum:
          - payable
      additionalProperties: false
      type: object
      required:
      - id
      - type
    PaymentObjectType:
      type: string
      enum:
      - payable
      - receivable
    BatchPaymentLinkResponse:
      properties:
        id:
          type: string
          format: uuid
        created_at:
          type: string
          format: date-time
        error:
          type: object
        expires_at:
          type: string
          format: date-time
        payment_page_url:
          type: string
          maxLength: 2083
          minLength: 1
          format: uri
        status:
          $ref: '#/components/schemas/PaymentsBatchPaymentStatus'
        total_amount:
          type: integer
      type: object
      required:
      - id
      - created_at
      - expires_at
      - payment_page_url
      - status
      description: Response schema for a batch payment link.
    Invoice:
      properties:
        due_date:
          type: string
          format: date
        file:
          $ref: '#/components/schemas/InvoiceFile'
        issue_date:
          type: string
          format: date
      additionalProperties: false
      type: object
    ErrorSchema:
      properties:
        message:
          type: string
      type: object
      required:
      - message
    BatchSinglePaymentIntent:
      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/BatchPaymentIntentsRecipient'
      additionalProperties: false
      type: object
      required:
      - object
      - recipient
      description: 'Single payment intent schema specific for batch payment links.

        Uses BatchPaymentIntentsRecipient instead of PaymentIntentsRecipient.'
    PaymentsBatchPaymentStatus:
      type: string
      enum:
      - created
      - processing
      - partially_successful
      - succeeded
      - failed
      - expired
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
      type: object
    RecipientAccountResponse:
      properties:
        id:
          type: string
          format: uuid
          description: ID of a payment account
        bank_accounts:
          items:
            $ref: '#/components/schemas/BankAccount'
          type: array
          description: List of bank accounts
        name:
          type: string
          description: Display name of a payment account
        type:
          allOf:
          - $ref: '#/components/schemas/PaymentAccountType'
          description: Type of a payment account. Can be `entity` or `counterpart`
      type: object
      required:
      - id
      - type
    AllowedCountries:
      type: string
      enum:
      - AF
      - AX
      - AL
      - DZ
      - AS
      - AD
      - AO
      - AI
      - AQ
      - AG
      - AR
      - AM
      - AW
      - AU
      - AT
      - AZ
      - BS
      - BH
      - BD
      - BB
      - BY
      - BE
      - BZ
      - BJ
      - BM
      - BT
      - BO
      - BA
      - BW
      - BV
      - BR
      - IO
      - BN
      - BG
      - BF
      - BI
      - KH
      - CM
      - CA
      - IC
      - CV
      - KY
      - CF
      - EA
      - TD
      - CL
      - CN
      - CX
      - CC
      - CO
      - KM
      - CG
      - CD
      - CK
      - CR
      - CI
      - HR
      - CU
      - CY
      - CZ
      - DK
      - DJ
      - DM
      - DO
      - EC
      - EG
      - SV
      - GQ
      - ER
      - EE
      - SZ
      - ET
      - FK
      - FO
      - FJ
      - FI
      - FR
      - GF
      - PF
      - TF
      - GA
      - GM
      - GE
      - DE
      - GH
      - GI
      - GR
      - GL
      - GD
      - GP
      - GU
      - GT
      - GG
      - GN
      - GW
      - GY
      - HT
      - HM
      - VA
      - HN
      - HK
      - HU
      - IS
      - IN
      - ID
      - IR
      - IQ
      - IE
      - IM
      - IL
      - IT
      - JM
      - JP
      - JE
      - JO
      - KZ
      - KE
      - KI
      - KP
      - KR
      - KW
      - KG
      - LA
      - LV
      - LB
      - LS
      - LR
      - LY
      - LI
      - LT
      - LU
      - MO
      - MG
      - MW
      - MY
      - MV
      - ML
      - MT
      - MH
      - MQ
      - MR
      - MU
      - YT
      - MX
      - FM
      - MD
      - MC
      - MN
      - ME
      - MS
      - MA
      - MZ
      - MM
      - NA
      - NR
      - NP
      - NL
      - AN
      - NC
      - NZ
      - NI
      - NE
      - NG
      - NU
      - NF
      - MP
      - MK
      - 'NO'
      - OM
      - PK
      - PW
      - PS
      - PA
      - PG
      - PY
      - PE
      - PH
      - PN
      - PL
      - PT
      - PR
      - QA
      - RE
      - RO
      - RU
      - RW
      - SH
      - KN
      - LC
      - PM
      - VC
      - WS
      - SM
      - ST
      - SA
      - SN
      - RS
      - SC
      - SL
      - SG
      - SK
      - SI
      - SB
      - SO
      - ZA
      - SS
      - GS
      - ES
      - LK
      - SD
      - SR
      - SJ
      - SE
      - CH
      - SY
      - TW
      - TJ
      - TZ
      - TH
      - TL
      - TG
      - TK
      - TO
      - TT
      - TN
      - TR
      - TM
      - TC
      - TV
      - UG
      - UA
      - AE
      - GB
      - US
      - UM
      - UY
      - UZ
      - VU
      - VE
      - VN
      - VG
      - VI
      - WF
      - EH
      - YE
      - ZM
      - ZW
      - BL
      - BQ
      - CW
      - MF
      - SX
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
            - type: string
            - type: integer
          type: array
        msg:
          type: string
        type:
          type: string
      type: object
      required:
      - loc
      - msg
      - type
    BatchPaymentLinkRequest:
      properties:
        expires_at:
          type: string
          format: date-time
        funding_payment_method:
          type: string
          enum:
          - us_ach
          default: us_ach
        payment_intents:
          items:
            $ref: '#/components/schemas/BatchSinglePaymentIntent'
          type: array
          minItems: 1
        payout_payment_methods:
          items:
            $ref: '#/components/schemas/MoniteAllPaymentMethodsTypes'
          type: array
          minItems: 1
          uniqueItems: true
          default:
          - us_ach
        return_url:
          type: string
          maxLength: 2083
          minLength: 1
          format: uri
          description: The URL where to redirect the payer after the payment. If `return_url` is specified, then after the payment is completed the payment page will display the "Return to platform" link that navigates to this URL.
          example: https://pay.example.com/complete
      additionalProperties: false
      type: object
      required:
      - payment_intents
      description: 'Request schema for creating a batch payment link.

        Based on PaymentsBatchPaymentRequest but excluding payer_bank_account_id.'
    ErrorSchemaResponse:
      properties:
        error:
          $ref: '#/components/schemas/ErrorSchema'
      type: object
      required:
      - error
    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
  securitySchemes:
    HTTPBearer:
      type: http
      scheme: bearer
x-refined-from:
- monite-openapi-2023-09-01.json
- monite-openapi-2024-05-25.json
- monite-openapi.yml