Mercoa Custom Payment Method Schema API
The custom-payment-method-schema API from Mercoa — 2 operation(s) for custom-payment-method-schema.
Work with this as data
Every API here is available over the APIs.io API and to AI agents over MCP.
MCP server
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
Tools for apis
7 MCP tools reach this
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.
Call it yourself
curl for this page
This API
curl "https://apis.io/api/v1/apis/mercoa:mercoa-custom-payment-method-schema-api"
All apis
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.
Get an API 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 Specification
openapi: 3.2.0
info:
title: Reference Custom Payment Method Schema API
version: 1.0.0
servers:
- url: https://api.mercoa.com
description: Production
tags:
- name: custom-payment-method-schema
paths:
/paymentMethod/schema:
get:
operationId: customPaymentMethodSchema_getAll
summary: Get All
description: Get all custom payment method schemas
tags:
- custom-payment-method-schema
responses:
'200':
description: Response with status 200
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/paymentMethodTypes_CustomPaymentMethodSchemaResponse'
'400':
description: Error response with status 400
content:
application/json:
schema:
type: object
properties:
errorName:
type: string
enum:
- BadRequest
content:
type: string
required:
- errorName
- content
'401':
description: Error response with status 401
content:
application/json:
schema:
type: object
properties:
errorName:
type: string
enum:
- Unauthorized
content:
type: string
required:
- errorName
- content
'403':
description: Error response with status 403
content:
application/json:
schema:
type: object
properties:
errorName:
type: string
enum:
- Forbidden
content:
type: string
required:
- errorName
- content
'404':
description: Error response with status 404
content:
application/json:
schema:
type: object
properties:
errorName:
type: string
enum:
- NotFound
content:
type: string
required:
- errorName
- content
'409':
description: Error response with status 409
content:
application/json:
schema:
type: object
properties:
errorName:
type: string
enum:
- Conflict
content:
type: string
required:
- errorName
- content
'500':
description: Error response with status 500
content:
application/json:
schema:
type: object
properties:
errorName:
type: string
enum:
- InternalServerError
content:
type: string
required:
- errorName
- content
'501':
description: Error response with status 501
content:
application/json:
schema:
type: object
properties:
errorName:
type: string
enum:
- Unimplemented
content:
type: string
required:
- errorName
- content
security:
- default: []
post:
operationId: customPaymentMethodSchema_create
summary: Create
description: Create custom payment method schema
tags:
- custom-payment-method-schema
responses:
'200':
description: Response with status 200
content:
application/json:
schema:
$ref: '#/components/schemas/paymentMethodTypes_CustomPaymentMethodSchemaResponse'
'400':
description: Error response with status 400
content:
application/json:
schema:
type: object
properties:
errorName:
type: string
enum:
- BadRequest
content:
type: string
required:
- errorName
- content
'401':
description: Error response with status 401
content:
application/json:
schema:
type: object
properties:
errorName:
type: string
enum:
- Unauthorized
content:
type: string
required:
- errorName
- content
'403':
description: Error response with status 403
content:
application/json:
schema:
type: object
properties:
errorName:
type: string
enum:
- Forbidden
content:
type: string
required:
- errorName
- content
'404':
description: Error response with status 404
content:
application/json:
schema:
type: object
properties:
errorName:
type: string
enum:
- NotFound
content:
type: string
required:
- errorName
- content
'409':
description: Error response with status 409
content:
application/json:
schema:
type: object
properties:
errorName:
type: string
enum:
- Conflict
content:
type: string
required:
- errorName
- content
'500':
description: Error response with status 500
content:
application/json:
schema:
type: object
properties:
errorName:
type: string
enum:
- InternalServerError
content:
type: string
required:
- errorName
- content
'501':
description: Error response with status 501
content:
application/json:
schema:
type: object
properties:
errorName:
type: string
enum:
- Unimplemented
content:
type: string
required:
- errorName
- content
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/paymentMethodTypes_CustomPaymentMethodSchemaRequest'
security:
- default: []
/paymentMethod/schema/{schemaId}:
post:
operationId: customPaymentMethodSchema_update
summary: Update
description: Update custom payment method schema
tags:
- custom-payment-method-schema
parameters:
- name: schemaId
in: path
required: true
schema:
$ref: '#/components/schemas/paymentMethodTypes_CustomPaymentMethodSchemaId'
responses:
'200':
description: Response with status 200
content:
application/json:
schema:
$ref: '#/components/schemas/paymentMethodTypes_CustomPaymentMethodSchemaResponse'
'400':
description: Error response with status 400
content:
application/json:
schema:
type: object
properties:
errorName:
type: string
enum:
- BadRequest
content:
type: string
required:
- errorName
- content
'401':
description: Error response with status 401
content:
application/json:
schema:
type: object
properties:
errorName:
type: string
enum:
- Unauthorized
content:
type: string
required:
- errorName
- content
'403':
description: Error response with status 403
content:
application/json:
schema:
type: object
properties:
errorName:
type: string
enum:
- Forbidden
content:
type: string
required:
- errorName
- content
'404':
description: Error response with status 404
content:
application/json:
schema:
type: object
properties:
errorName:
type: string
enum:
- NotFound
content:
type: string
required:
- errorName
- content
'409':
description: Error response with status 409
content:
application/json:
schema:
type: object
properties:
errorName:
type: string
enum:
- Conflict
content:
type: string
required:
- errorName
- content
'500':
description: Error response with status 500
content:
application/json:
schema:
type: object
properties:
errorName:
type: string
enum:
- InternalServerError
content:
type: string
required:
- errorName
- content
'501':
description: Error response with status 501
content:
application/json:
schema:
type: object
properties:
errorName:
type: string
enum:
- Unimplemented
content:
type: string
required:
- errorName
- content
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/paymentMethodTypes_CustomPaymentMethodSchemaRequest'
security:
- default: []
get:
operationId: customPaymentMethodSchema_get
summary: Get
description: Get custom payment method schema
tags:
- custom-payment-method-schema
parameters:
- name: schemaId
in: path
required: true
schema:
$ref: '#/components/schemas/paymentMethodTypes_CustomPaymentMethodSchemaId'
responses:
'200':
description: Response with status 200
content:
application/json:
schema:
$ref: '#/components/schemas/paymentMethodTypes_CustomPaymentMethodSchemaResponse'
'400':
description: Error response with status 400
content:
application/json:
schema:
type: object
properties:
errorName:
type: string
enum:
- BadRequest
content:
type: string
required:
- errorName
- content
'401':
description: Error response with status 401
content:
application/json:
schema:
type: object
properties:
errorName:
type: string
enum:
- Unauthorized
content:
type: string
required:
- errorName
- content
'403':
description: Error response with status 403
content:
application/json:
schema:
type: object
properties:
errorName:
type: string
enum:
- Forbidden
content:
type: string
required:
- errorName
- content
'404':
description: Error response with status 404
content:
application/json:
schema:
type: object
properties:
errorName:
type: string
enum:
- NotFound
content:
type: string
required:
- errorName
- content
'409':
description: Error response with status 409
content:
application/json:
schema:
type: object
properties:
errorName:
type: string
enum:
- Conflict
content:
type: string
required:
- errorName
- content
'500':
description: Error response with status 500
content:
application/json:
schema:
type: object
properties:
errorName:
type: string
enum:
- InternalServerError
content:
type: string
required:
- errorName
- content
'501':
description: Error response with status 501
content:
application/json:
schema:
type: object
properties:
errorName:
type: string
enum:
- Unimplemented
content:
type: string
required:
- errorName
- content
security:
- default: []
delete:
operationId: customPaymentMethodSchema_delete
summary: Delete
description: Delete custom payment method schema. Schema that have been used in an invoice cannot be deleted.
tags:
- custom-payment-method-schema
parameters:
- name: schemaId
in: path
required: true
schema:
$ref: '#/components/schemas/paymentMethodTypes_CustomPaymentMethodSchemaId'
responses:
'200':
description: Successful response
'400':
description: Error response with status 400
content:
application/json:
schema:
type: object
properties:
errorName:
type: string
enum:
- BadRequest
content:
type: string
required:
- errorName
- content
'401':
description: Error response with status 401
content:
application/json:
schema:
type: object
properties:
errorName:
type: string
enum:
- Unauthorized
content:
type: string
required:
- errorName
- content
'403':
description: Error response with status 403
content:
application/json:
schema:
type: object
properties:
errorName:
type: string
enum:
- Forbidden
content:
type: string
required:
- errorName
- content
'404':
description: Error response with status 404
content:
application/json:
schema:
type: object
properties:
errorName:
type: string
enum:
- NotFound
content:
type: string
required:
- errorName
- content
'409':
description: Error response with status 409
content:
application/json:
schema:
type: object
properties:
errorName:
type: string
enum:
- Conflict
content:
type: string
required:
- errorName
- content
'500':
description: Error response with status 500
content:
application/json:
schema:
type: object
properties:
errorName:
type: string
enum:
- InternalServerError
content:
type: string
required:
- errorName
- content
'501':
description: Error response with status 501
content:
application/json:
schema:
type: object
properties:
errorName:
type: string
enum:
- Unimplemented
content:
type: string
required:
- errorName
- content
security:
- default: []
components:
schemas:
paymentMethodTypes_CustomPaymentMethodSchemaFieldType:
type: string
enum:
- text
- number
- select
- date
- phone
- email
- url
- dynamicUrl
- embeddedUrl
- address
- usBankRoutingNumber
- usBankAccountNumber
title: CustomPaymentMethodSchemaFieldType
paymentMethodTypes_CustomPaymentMethodSchemaRequest:
type: object
properties:
name:
type: string
isSource:
type: boolean
description: This payment method can be used as a payment source for an invoice
isDestination:
type: boolean
description: This payment method can be used as a payment destination for an invoice
supportedCurrencies:
type: array
items:
$ref: '#/components/schemas/paymentMethodTypes_CurrencyCode'
description: List of currencies that this payment method supports. If not provided, the payment method will support only USD.
fields:
type: array
items:
$ref: '#/components/schemas/paymentMethodTypes_CustomPaymentMethodSchemaField'
estimatedProcessingTime:
type: integer
description: Estimated time in days for this payment method to process a payments. Set as 0 for same-day payment methods, -1 for unknown processing time.
maxAmount:
type: number
format: double
description: The maximum amount that can be transferred from this payment method in a single transaction.
minAmount:
type: number
format: double
description: The minimum amount that can be transferred from this payment method in a single transaction. Default is 1.
required:
- name
- isSource
- isDestination
- fields
title: CustomPaymentMethodSchemaRequest
paymentMethodTypes_CustomPaymentMethodSchemaId:
type: string
title: CustomPaymentMethodSchemaId
paymentMethodTypes_CustomPaymentMethodSchemaResponse:
type: object
properties:
id:
$ref: '#/components/schemas/paymentMethodTypes_CustomPaymentMethodSchemaId'
name:
type: string
isSource:
type: boolean
description: This payment method can be used as a payment source for an invoice
isDestination:
type: boolean
description: This payment method can be used as a payment destination for an invoice
supportedCurrencies:
type: array
items:
$ref: '#/components/schemas/paymentMethodTypes_CurrencyCode'
description: List of currencies that this payment method supports.
fields:
type: array
items:
$ref: '#/components/schemas/paymentMethodTypes_CustomPaymentMethodSchemaField'
estimatedProcessingTime:
type: integer
description: Estimated time in days for this payment method to process a payments. 0 is an same-day payment methods, -1 is unknown processing time.
maxAmount:
type: number
format: double
description: The maximum amount that can be transferred from this payment method in a single transaction.
minAmount:
type: number
format: double
description: The minimum amount that can be transferred from this payment method in a single transaction. Default is 1.
createdAt:
type: string
format: date-time
updatedAt:
type: string
format: date-time
required:
- id
- name
- isSource
- isDestination
- supportedCurrencies
- fields
- estimatedProcessingTime
- createdAt
- updatedAt
title: CustomPaymentMethodSchemaResponse
paymentMethodTypes_CurrencyCode:
type: string
enum:
- AED
- AFN
- ALL
- AMD
- ANG
- AOA
- ARS
- AUD
- AWG
- AZN
- BAM
- BBD
- BDT
- BGN
- BHD
- BIF
- BMD
- BND
- BOB
- BOV
- BRL
- BSD
- BTN
- BWP
- BYN
- BZD
- CAD
- CDF
- CHE
- CHF
- CHW
- CLF
- CLP
- COP
- COU
- CRC
- CUC
- CUP
- CVE
- CZK
- DJF
- DKK
- DOP
- DZD
- EGP
- ERN
- ETB
- EUR
- FJD
- FKP
- GBP
- GEL
- GHS
- GIP
- GMD
- GNF
- GTQ
- GYD
- HKD
- HNL
- HTG
- HUF
- IDR
- ILS
- INR
- IQD
- IRR
- ISK
- JMD
- JOD
- JPY
- KES
- KGS
- KHR
- KMF
- KPW
- KRW
- KWD
- KYD
- KZT
- LAK
- LBP
- LKR
- LRD
- LSL
- LYD
- MAD
- MDL
- MGA
- MKD
- MMK
- MNT
- MOP
- MRU
- MUR
- MVR
- MWK
- MXN
- MXV
- MYR
- MZN
- NAD
- NGN
- NIO
- NOK
- NPR
- NZD
- OMR
- PAB
- PEN
- PGK
- PHP
- PKR
- PLN
- PYG
- QAR
- RON
- RSD
- CNY
- RUB
- RWF
- SAR
- SBD
- SCR
- SDG
- SEK
- SGD
- SHP
- SLE
- SLL
- SOS
- SRD
- SSP
- STN
- SVC
- SYP
- SZL
- THB
- TJS
- TMT
- TND
- TOP
- TRY
- TTD
- TWD
- TZS
- UAH
- UGX
- USD
- USN
- UYI
- UYU
- UYW
- UZS
- VED
- VES
- VND
- VUV
- WST
- XAF
- XAG
- XAU
- XBA
- XBB
- XBC
- XBD
- XCD
- XDR
- XOF
- XPD
- XPF
- XPT
- XSU
- XTS
- XUA
- XXX
- YER
- ZAR
- ZMW
- ZWL
title: CurrencyCode
paymentMethodTypes_CustomPaymentMethodSchemaField:
type: object
properties:
name:
type: string
displayName:
type: string
type:
$ref: '#/components/schemas/paymentMethodTypes_CustomPaymentMethodSchemaFieldType'
optional:
type: boolean
description: Indicates whether this field is optional
useAsAccountName:
type: boolean
description: Indicates whether this field should be used as the name of the payment method. Only one field can be used as the name. Will set the accountName field of the payment method to the value of this field.
useAsAccountNumber:
type: boolean
description: Indicates whether this field should be used as the account number of the payment method. Only one field can be used as the account number. Will set the accountNumber field of the payment method to the value of this field.
options:
type: array
items:
type: string
description: When type is 'select', provide options that can be selected
required:
- name
- type
- optional
title: CustomPaymentMethodSchemaField
securitySchemes:
default:
type: http
scheme: bearer