Monite Batch payments API
The Batch payments API from Monite — 2 operation(s) for batch payments.
The Batch payments API from Monite — 2 operation(s) for batch payments.
Every API here is available over the APIs.io API and to AI agents over MCP.
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.curl "https://apis.io/api/v1/apis/monite:monite-batch-payments-api"
curl "https://apis.io/api/v1/apis?limit=25"
Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
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 2 of this provider''s published API definitions: monite-openapi-2023-09-01.json, monite-openapi-2024-05-25.json. 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:
PaymentsBatchPaymentStatus:
type: string
enum:
- created
- processing
- partially_successful
- succeeded
- failed
- expired
PaymentIntentPayoutMethod:
type: string
enum:
- bank_account
- paper_check
- us_ach
- wire
HTTPValidationError:
properties:
detail:
items:
$ref: '#/components/schemas/ValidationError'
type: array
type: object
PaymentObjectPayable:
properties:
id:
type: string
format: uuid
type:
type: string
enum:
- payable
additionalProperties: false
type: object
required:
- id
- type
ValidationError:
properties:
loc:
items:
anyOf:
- type: string
- type: integer
type: array
msg:
type: string
type:
type: string
type: object
required:
- loc
- msg
- type
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
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
ErrorSchemaResponse:
properties:
error:
$ref: '#/components/schemas/ErrorSchema'
type: object
required:
- error
ErrorSchema:
properties:
message:
type: string
type: object
required:
- message
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
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
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
securitySchemes:
HTTPBearer:
type: http
scheme: bearer
x-refined-from:
- monite-openapi-2023-09-01.json
- monite-openapi-2024-05-25.json
x-provenance:
method: harvested
publisher: Monite
source: https://docs.monite.com/_fern-files/docs.monite.com/9686796bddc2d6efcf41e03253cf6e254160c84d38eba4e3711f47d24e80402d/apis/v2024-05-25/openapi/2024-05-25.yaml
note: split by refine-openapis from the provider's own published document, verified by fetch (openapi/_original/*.fetch.json);
stamped by stamp-openapi-provenance.py (roadmap#793)