Find bank

bank-lookup

commons

Search all entities with the given filters. If no filters are provided, all entities will be returned.

Search all entities with the given filters. If no filters are provided, all entities will be returned.

Search entities

Create entity

Get entity

Update entity

Delete entity

This endpoint is used to indicate acceptance of Mercoa's terms of service for an entity. Send a request to this endpoint only after the entity has accepted the Mercoa ToS. Entities must accept Mercoa ToS before they can be send or pay invoices using Mercoa's payment rails.

This endpoint is used to indicate acceptance of Mercoa&#39;s terms of service for an entity. Send a request to this endpoint only after the entity has accepted the Mercoa ToS. Entities must accept Mercoa ToS before they can be send or pay invoices using Mercoa&#39;s payment rails.

Accept Terms of Service

This endpoint is used to initiate KYB for an entity. 
Send a request to this endpoint only after the entity has accepted the Mercoa ToS,
all representatives have been added, and all required fields have been filled out.


This endpoint is used to initiate KYB for an entity. 
Send a request to this endpoint only after the entity has accepted the Mercoa ToS,
all representatives have been added, and all required fields have been filled out.

Initiate KYB

Generate a JWT token for an entity with the given options. This token can be used to authenticate the entity in the Mercoa API and iFrame.

Generate a JWT token for an entity with the given options. This token can be used to authenticate the entity in the Mercoa API and iFrame.

Generate JWT Token

Generate an onboarding link for the entity.

Generate an onboarding link for the entity.

Generate Onboarding Link

Send an email with a onboarding link to the entity. The email will be sent to the email address associated with the entity.

Send an email with a onboarding link to the entity. The email will be sent to the email address associated with the entity.

Send Onboarding Email

entity

entity-types

Retrieve all invoice approval policies associated with an entity

Retrieve all invoice approval policies associated with an entity

Get All

Create an invoice approval policy associated with an entity

Create an invoice approval policy associated with an entity

Create

Retrieve an invoice approval policy associated with an entity

Retrieve an invoice approval policy associated with an entity

Update an invoice approval policy associated with an entity

Update an invoice approval policy associated with an entity

Update

Delete an invoice approval policy associated with Entity. BEWARE: Any approval policy deletion will result in all associated downstream policies also being deleted.

Delete an invoice approval policy associated with Entity. BEWARE: Any approval policy deletion will result in all associated downstream policies also being deleted.

Delete

approval-policy

Find payee counterparties. This endpoint lets you find vendors linked to the entity.

Find payee counterparties. This endpoint lets you find vendors linked to the entity.

Find payee counterparties.

Find payor counterparties. This endpoint lets you find customers linked to the entity.

Find payor counterparties. This endpoint lets you find customers linked to the entity.

Find payor counterparties

Create association between Entity and a given list of Payees. If a Payee has previously been archived, unarchive the Payee.

Create association between Entity and a given list of Payees. If a Payee has previously been archived, unarchive the Payee.

Link Payees

Marks Payees as unsearchable by Entity via Counterparty search. Invoices associated with these Payees will still be searchable via Invoice search.

Marks Payees as unsearchable by Entity via Counterparty search. Invoices associated with these Payees will still be searchable via Invoice search.

Hide Payee

Create association between Entity and a given list of Payors. If a Payor has previously been archived, unarchive the Payor.

Create association between Entity and a given list of Payors. If a Payor has previously been archived, unarchive the Payor.

Link Payors

Marks Payors as unsearchable by Entity via Counterparty search. Invoices associated with these Payors will still be searchable via Invoice search.

Marks Payors as unsearchable by Entity via Counterparty search. Invoices associated with these Payors will still be searchable via Invoice search.

Hide Payors

counterparty

Get invoices for an entity with the given filters.

Get invoices for an entity with the given filters.

Get invoice metrics for an entity with the given filters.

Get invoice metrics for an entity with the given filters.

Get Metrics

invoice

Retrieve all metadata options associated with this entity

Retrieve all metadata options associated with this entity

Retrieve metadata associated with a specific key

Retrieve metadata associated with a specific key

Update metadata associated with a specific key

Update metadata associated with a specific key

Delete all metadata associated with a specific key

Delete all metadata associated with a specific key

metadata

Retrieve all notification policies associated with this entity

Retrieve all notification policies associated with this entity

Retrieve notification policy associated with this entity

Retrieve notification policy associated with this entity

Update notification policy associated with this entity

Update notification policy associated with this entity

notification-policy

Only custom payment methods can be updated.

Only custom payment methods can be updated.

Initiate micro deposits for a bank account

Initiate micro deposits for a bank account

Initiate micro deposits

Complete micro deposit verification

Verify micro deposits

payment-method

Get representatives for an entity

representative

Get all entity users

Create entity user

Get entity user

Update entity user

Delete entity user

Generate a JWT token for an entity user with the given options. This token can be used to authenticate the entity and entity user in the Mercoa API and iFrame.

Generate a JWT token for an entity user with the given options. This token can be used to authenticate the entity and entity user in the Mercoa API and iFrame.

user

Retrieve all notification policies associated with this entity user

Retrieve all notification policies associated with this entity user

Retrieve notification policy associated with this entity user

Retrieve notification policy associated with this entity user

Update notification policy associated with this entity user

Update notification policy associated with this entity user

notifications

Search invoices for all entities in the organization

Search invoices for all entities in the organization

Search invoices

Only invoices in the DRAFT and NEW status can be deleted.

Only invoices in the DRAFT and NEW status can be deleted.

Get temporary link for payer to send payment

Get temporary link for payer to send payment

Get payment link

Trigger email to payer inviting them to make payment

Trigger email to payer inviting them to make payment

Send payment email

Get temporary link for vendor to accept payment

Get temporary link for vendor to accept payment

Get disbursement link

Trigger email to vendor inviting them into the vendor portal

Trigger email to vendor inviting them into the vendor portal

Send disbursement email

Generate PDF

invoice-types

Approve

Reject

approval

Get all comments associated with this invoice

Get all comments associated with this invoice

comment

Get documents (scanned/uploaded images) associated with this invoice

Get documents (scanned/uploaded images) associated with this invoice

document

Run OCR on an Base64 encoded image or PDF

Run OCR on an Base64 encoded image or PDF

Run OCR

Cloud Mailin Webhook

Get current organization information

Get log of all emails sent to this organization. Content format subject to change.

Get log of all emails sent to this organization. Content format subject to change.

Email Log

organization

organization-types

Retrieve all notification configurations

Retrieve notification configuration for this notification type

Retrieve notification configuration for this notification type

Update notification configuration for this notification type

Update notification configuration for this notification type

Reset notification configuration for this notification type

Reset notification configuration for this notification type

Reset

notification-configuration

Get all custom payment method schemas

Create custom payment method schema

Update custom payment method schema

Delete custom payment method schema. Schema that have been used in an invoice cannot be deleted.

Delete custom payment method schema. Schema that have been used in an invoice cannot be deleted.

Getting Started with Mercoa