ConvesioPay

## 🚀 Theneo

Theneo is the quickest, simplest way to generate high-quality, interactive API docs. Just import your API collection and we'll take care of the rest.

**⚠️ Note:** All of the stated endpoints and sections are for demonstration purposes only. Theneo does not manage payments API. Get sales data, itemize payments, push orders to POS, and more.The Orders API provides a one-stop shop for integrating advanced payment functionality. You can itemize payments with custom line items or catalog objects, send orders to real Point of Sale devices to be fulfilled, and more.In addition, the Orders API allows you to look through all of a seller's previous sales and returns itemization data, customer references, and other information from POS or online transactions.

<img src="https://assets.website-files.com/61f7e03934c23c1dcc9c3cd4/6306089ecc13c15fe0a7e006_Main page_2 (with visual studoi code logo) 2.svg" alt="" height="237" width="322">

### Generate API Documentation

- Build interactive API docs
- Tailor you documentation
- Create and launch quickly
- Update easily within seconds
- Built for everyone
    

# Integrations

Import your collections manually or use our integrations to automatically migrate your work from:

- Swagger
- Postman
- Github
    

[  
](https://www.theneo.io/#)

[  
](https://app.theneo.io/signup)

Introduction

Connect Integration

Enable integration

🚀 Theneo is the quickest, simplest way to generate high-quality, interactive API docs. Just import your API collection and we'll take care of the rest.

⚠️ Note**:** All of the stated endpoints and sections are for demonstration purposes only. Theneo does not manage payments API. Get sales data, itemize payments, push orders to POS, and more.The Orders API provides a one-stop shop for integrating advanced payment functionality. You can itemize payments with custom line items or catalog objects, send orders to real Point of Sale devices to be fulfilled, and more.In addition, the Orders API allows you to look through all of a seller's previous sales and returns itemization data, customer references, and other information from POS or online transactions.

<img src="https://assets.website-files.com/61f7e03934c23c1dcc9c3cd4/6306089ecc13c15fe0a7e006_Main page_2 (with visual studoi code logo) 2.svg" alt="" height="168" width="200">

### Generate API Documentation

- Build interactive API docs
- Tailor you documentation
- Create and launch quickly
- Update easily within seconds
- Built for everyone
    

# Integrations

Import your collections manually or use our integrations to automatically migrate your work from:

- Swagger
- Postman
- Github

Integration Events

Creates a new customer for a business.

You must provide at least one of the following values in your request to this endpoint:

 *   `given_name`
 *   `family_name`
 *   `company_name`
 *   `email_address`
 *   `phone_number`

Payment link created

Connection status updated

Customer updated

Invoice updated (optional)

Exception notification (optional)

ConvesioPay Events

Payment link status updated

Integration disconnect requested

Theneo Demo TechCrunch

ConvesioPay Payment Links Integration API

Live

Test

<p class="slate-p " ></p><h2 class="slate-h2 " >🚀 ConvesioPay</h2><p class="slate-p " >ConvesioPay is the ultimate enterprise payments platform, designed to reduce risk and increase revenue – all with white-glove support by Convesio&apos;s expert support team. ConvesioPay integrates seamlessly with our comprehensive commerce platform, providing advanced engagement marketing, scalable infrastructure, and essential growth features for businesses of all sizes.</p><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative">Enterprise scale for businesses of all sizes</div></li><li class="slate-li " ><div style="position:relative">Transact on the web and via invoice</div></li><li class="slate-li " ><div style="position:relative">Robust reporting and administrative tools for managing payment operations</div></li><li class="slate-li " ><div style="position:relative">Full-stack support from website to payout, via Slack and email</div></li></ul><div style="width:100%;
	min-width:100%;" class="callout-widget" data-type=warning ><div class="callout-icon"><svg width="18" height="16" viewBox="0 0 18 16" fill="none" xmlns="http://www.w3.org/2000/svg"><path d="M0.916637 15.5009C0.791637 15.5009 0.683998 15.4732 0.59372 15.4176C0.503443 15.362 0.430526 15.2857 0.37497 15.1884C0.319415 15.0912 0.288165 14.9905 0.28122 14.8864C0.274276 14.7822 0.305526 14.6745 0.37497 14.5634L8.4583 0.605103C8.52775 0.493991 8.60761 0.41413 8.69789 0.365519C8.78816 0.316908 8.88886 0.292603 8.99997 0.292603C9.11108 0.292603 9.21178 0.316908 9.30205 0.365519C9.39233 0.41413 9.47219 0.493991 9.54164 0.605103L17.625 14.5634C17.6944 14.6745 17.7257 14.7822 17.7187 14.8864C17.7118 14.9905 17.6805 15.0912 17.625 15.1884C17.5694 15.2857 17.4965 15.362 17.4062 15.4176C17.3159 15.4732 17.2083 15.5009 17.0833 15.5009H0.916637ZM1.99997 14.2509H16L8.99997 2.1676L1.99997 14.2509ZM9.0833 13.0634C9.26386 13.0634 9.41316 13.0044 9.53122 12.8864C9.64928 12.7683 9.7083 12.619 9.7083 12.4384C9.7083 12.2579 9.64928 12.1086 9.53122 11.9905C9.41316 11.8725 9.26386 11.8134 9.0833 11.8134C8.90275 11.8134 8.75344 11.8725 8.63539 11.9905C8.51733 12.1086 8.4583 12.2579 8.4583 12.4384C8.4583 12.619 8.51733 12.7683 8.63539 12.8864C8.75344 13.0044 8.90275 13.0634 9.0833 13.0634ZM9.0833 10.7509C9.26386 10.7509 9.41316 10.6919 9.53122 10.5739C9.64928 10.4558 9.7083 10.3065 9.7083 10.1259V6.70927C9.7083 6.52871 9.64928 6.37941 9.53122 6.26135C9.41316 6.1433 9.26386 6.08427 9.0833 6.08427C8.90275 6.08427 8.75344 6.1433 8.63539 6.26135C8.51733 6.37941 8.4583 6.52871 8.4583 6.70927V10.1259C8.4583 10.3065 8.51733 10.4558 8.63539 10.5739C8.75344 10.6919 8.90275 10.7509 9.0833 10.7509Z" fill="#F1C21B"></path></svg></div><div ><p class="slate-p " ><strong class="slate-bold">Note:</strong> The ConvesioPay Payment Links Integration API is in a closed beta right now.  Please reach out to pay@convesio.com if you need any assistance with your integration.</p></div></div><p class="slate-p " ></p><p class="slate-p " ></p><p class="slate-p " ></p><div style="text-align:left"><img src="https://theneo-prod-public.s3.us-east-1.amazonaws.com/a3d5c64f-534f-49d8-94c1-f9d6321ef410.png" style="
              width:655px;
	            height:442px;
	            aspect-ratio:655 / 442"
         /></div><p class="slate-p " ></p><p class="slate-p " ></p>

ConvesioPay is the ultimate enterprise payments platform, designed to reduce risk and increase revenue – all with white-glove support by Convesio's expert support team. ConvesioPay integrates seamlessly with our comprehensive commerce platform, providing advanced engagement marketing, scalable infrastructure, and essential growth features for businesses of all sizes.

<p class="slate-p " >ConvesioPay can be flexible with regard to the method for connecting a merchant to the integration. Here are a few methods that we can support to connect ConvesioPay merchants to connect to an integration:</p><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative">Link to a third-party URL hosted by the integration partner from the ConvesioPay dashboard settings screen</div></li><li class="slate-li " ><div style="position:relative">Call an endpoint provided by the integration partner, programmatically, from the ConvesioPay dashboard settings screen</div></li></ul><p class="slate-p " >In either case, ConvesioPay will pass the following parameters to the integration connection method via query parameters or request body in order to create the merchant association with the connection:</p><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative"><code class="slate-code">merchantId</code></div></li></ul><p class="slate-p " >As described later in the <a href="https://app.theneo.io/2f1ae6f7-c37b-41f3-b427-fbe41b8df518/convesiopay-accounting-integration-api/integration-events/connection-status-updated" target="_self">Integration Events</a> section, ConvesioPay will be notified when the integration connection was successfully accomplished.</p><p class="slate-p " ></p><p class="slate-p " ></p><p class="slate-p " ></p><p class="slate-p " ></p>

ConvesioPay can be flexible with regard to the method for connecting a merchant to the integration. Here are a few methods that we can support to connect ConvesioPay merchants to connect to an integration:

In either case, ConvesioPay will pass the following parameters to the integration connection method via query parameters or request body in order to create the merchant association with the connection:

 section, ConvesioPay will be notified when the integration connection was successfully accomplished.

<p class="slate-p " >Creates a new payment link for one of your merchant&apos;s customers.  A typical integration for example might be that you have accounting software and upon creating an invoice or a quote, you would hit this endpoint to generate a payment link for that invoice or quote.</p><p class="slate-p " >This endpoint will do a a few things, depending on your integration, it will at at least create a payment link so that your integration can attach that link to an email, PDF, or web page.  For some integrations, we may also create the following on your behalf:</p><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative">PDF with a summary of the integration event details (invoice/quote) and a link for the customer to pay the amount due online</div></li><li class="slate-li " ><div style="position:relative">Email to the customer with the payment link and PDF link</div></li></ul><p class="slate-p " >The following properties are required to use this endpoint:</p><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative"><code class="slate-code">integrationType</code></div></li><li class="slate-li " ><div style="position:relative"><code class="slate-code">merchantId</code></div></li><li class="slate-li " ><div style="position:relative"><code class="slate-code">invoiceId</code></div></li><li class="slate-li " ><div style="position:relative"><code class="slate-code">totalAmount</code></div></li><li class="slate-li " ><div style="position:relative"><code class="slate-code">currency</code></div></li><li class="slate-li " ><div style="position:relative"><code class="slate-code">date</code></div></li><li class="slate-li " ><div style="position:relative"><code class="slate-code">customerId</code></div></li><li class="slate-li " ><div style="position:relative"><code class="slate-code">customerName</code></div></li><li class="slate-li " ><div style="position:relative"><code class="slate-code">email</code></div></li></ul><div style="width:100%;
	min-width:100%;" class="callout-widget" data-type=warning ><div class="callout-icon"><svg width="18" height="16" viewBox="0 0 18 16" fill="none" xmlns="http://www.w3.org/2000/svg"><path d="M0.916637 15.5009C0.791637 15.5009 0.683998 15.4732 0.59372 15.4176C0.503443 15.362 0.430526 15.2857 0.37497 15.1884C0.319415 15.0912 0.288165 14.9905 0.28122 14.8864C0.274276 14.7822 0.305526 14.6745 0.37497 14.5634L8.4583 0.605103C8.52775 0.493991 8.60761 0.41413 8.69789 0.365519C8.78816 0.316908 8.88886 0.292603 8.99997 0.292603C9.11108 0.292603 9.21178 0.316908 9.30205 0.365519C9.39233 0.41413 9.47219 0.493991 9.54164 0.605103L17.625 14.5634C17.6944 14.6745 17.7257 14.7822 17.7187 14.8864C17.7118 14.9905 17.6805 15.0912 17.625 15.1884C17.5694 15.2857 17.4965 15.362 17.4062 15.4176C17.3159 15.4732 17.2083 15.5009 17.0833 15.5009H0.916637ZM1.99997 14.2509H16L8.99997 2.1676L1.99997 14.2509ZM9.0833 13.0634C9.26386 13.0634 9.41316 13.0044 9.53122 12.8864C9.64928 12.7683 9.7083 12.619 9.7083 12.4384C9.7083 12.2579 9.64928 12.1086 9.53122 11.9905C9.41316 11.8725 9.26386 11.8134 9.0833 11.8134C8.90275 11.8134 8.75344 11.8725 8.63539 11.9905C8.51733 12.1086 8.4583 12.2579 8.4583 12.4384C8.4583 12.619 8.51733 12.7683 8.63539 12.8864C8.75344 13.0044 8.90275 13.0634 9.0833 13.0634ZM9.0833 10.7509C9.26386 10.7509 9.41316 10.6919 9.53122 10.5739C9.64928 10.4558 9.7083 10.3065 9.7083 10.1259V6.70927C9.7083 6.52871 9.64928 6.37941 9.53122 6.26135C9.41316 6.1433 9.26386 6.08427 9.0833 6.08427C8.90275 6.08427 8.75344 6.1433 8.63539 6.26135C8.51733 6.37941 8.4583 6.52871 8.4583 6.70927V10.1259C8.4583 10.3065 8.51733 10.4558 8.63539 10.5739C8.75344 10.6919 8.90275 10.7509 9.0833 10.7509Z" fill="#F1C21B"></path></svg></div><div ><p class="slate-p " ><strong class="slate-bold">Note:</strong> Please note that all currency amount fields are in minor units (ie <code class="slate-code">$9.49</code> would be expressed as <code class="slate-code">949</code>). Also be aware that the minimum processable amount is 50 cents (ie <code class="slate-code">50</code> in minor units).</p></div></div><p class="slate-p " ></p>

Creates a new payment link for one of your merchant's customers.  A typical integration for example might be that you have accounting software and upon creating an invoice or a quote, you would hit this endpoint to generate a payment link for that invoice or quote.

This endpoint will do a a few things, depending on your integration, it will at at least create a payment link so that your integration can attach that link to an email, PDF, or web page.  For some integrations, we may also create the following on your behalf:

The following properties are required to use this endpoint:

integrationType

merchantId

invoiceId

A human recognizable name or number for the invoice (ie INV-1001))

invoiceNumber

Original total amount to be paid in minor units

totalAmount

currency

Amount remaining to be paid in minor units

outstandingBalance

The ISO date string the invoice was created

date

The ID of the customer in your integration records

customerId

The ISO date string that the invoice is due

dueDate

customerName

billingAddress

shippingAddress

email

terms

lineItems

You can opt to pass us your own URL for an invoice generated by your integration

invoiceLink

X-Api-Key

Content-Type

message

linkId

link

error

<p class="slate-p " >Updates a merchant&apos;s connection status for your integration in ConvesioPay.  For instance, if your system should ever lose connection with the ConvesioPay merchant, ConvesioPay should be informed.</p><p class="slate-p " >The following properties are required to use this endpoint:</p><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative"><code class="slate-code">integrationType</code></div></li><li class="slate-li " ><div style="position:relative"><code class="slate-code">merchantId</code></div></li><li class="slate-li " ><div style="position:relative"><code class="slate-code">operation</code></div></li><li class="slate-li " ><div style="position:relative"><code class="slate-code">lastUpdated</code></div></li><li class="slate-li " ><div style="position:relative"><code class="slate-code">event</code></div></li></ul><p class="slate-p " ></p><p class="slate-p " ></p>

Updates a merchant's connection status for your integration in ConvesioPay.  For instance, if your system should ever lose connection with the ConvesioPay merchant, ConvesioPay should be informed.

operation

lastUpdated

event

<p class="slate-p " >Updates a merchant&apos;s customer&apos;s details in ConvesioPay.  For instance, when the integration partner handles an update of the merchant&apos;s customer details (ie email, name, billingAddress, etc) in the system, ConvesioPay should be informed.</p><p class="slate-p " >The following properties are required to use this endpoint:</p><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative"><code class="slate-code">integrationType</code></div></li><li class="slate-li " ><div style="position:relative"><code class="slate-code">merchantId</code></div></li><li class="slate-li " ><div style="position:relative"><code class="slate-code">customerId</code></div></li><li class="slate-li " ><div style="position:relative"><code class="slate-code">operation</code></div></li><li class="slate-li " ><div style="position:relative"><code class="slate-code">lastUpdated</code></div></li><li class="slate-li " ><div style="position:relative"><code class="slate-code">event</code></div></li></ul><div style="width:100%;
	min-width:100%;" class="callout-widget" data-type=warning ><div class="callout-icon"><svg width="18" height="16" viewBox="0 0 18 16" fill="none" xmlns="http://www.w3.org/2000/svg"><path d="M0.916637 15.5009C0.791637 15.5009 0.683998 15.4732 0.59372 15.4176C0.503443 15.362 0.430526 15.2857 0.37497 15.1884C0.319415 15.0912 0.288165 14.9905 0.28122 14.8864C0.274276 14.7822 0.305526 14.6745 0.37497 14.5634L8.4583 0.605103C8.52775 0.493991 8.60761 0.41413 8.69789 0.365519C8.78816 0.316908 8.88886 0.292603 8.99997 0.292603C9.11108 0.292603 9.21178 0.316908 9.30205 0.365519C9.39233 0.41413 9.47219 0.493991 9.54164 0.605103L17.625 14.5634C17.6944 14.6745 17.7257 14.7822 17.7187 14.8864C17.7118 14.9905 17.6805 15.0912 17.625 15.1884C17.5694 15.2857 17.4965 15.362 17.4062 15.4176C17.3159 15.4732 17.2083 15.5009 17.0833 15.5009H0.916637ZM1.99997 14.2509H16L8.99997 2.1676L1.99997 14.2509ZM9.0833 13.0634C9.26386 13.0634 9.41316 13.0044 9.53122 12.8864C9.64928 12.7683 9.7083 12.619 9.7083 12.4384C9.7083 12.2579 9.64928 12.1086 9.53122 11.9905C9.41316 11.8725 9.26386 11.8134 9.0833 11.8134C8.90275 11.8134 8.75344 11.8725 8.63539 11.9905C8.51733 12.1086 8.4583 12.2579 8.4583 12.4384C8.4583 12.619 8.51733 12.7683 8.63539 12.8864C8.75344 13.0044 8.90275 13.0634 9.0833 13.0634ZM9.0833 10.7509C9.26386 10.7509 9.41316 10.6919 9.53122 10.5739C9.64928 10.4558 9.7083 10.3065 9.7083 10.1259V6.70927C9.7083 6.52871 9.64928 6.37941 9.53122 6.26135C9.41316 6.1433 9.26386 6.08427 9.0833 6.08427C8.90275 6.08427 8.75344 6.1433 8.63539 6.26135C8.51733 6.37941 8.4583 6.52871 8.4583 6.70927V10.1259C8.4583 10.3065 8.51733 10.4558 8.63539 10.5739C8.75344 10.6919 8.90275 10.7509 9.0833 10.7509Z" fill="#F1C21B"></path></svg></div><div ><p class="slate-p " ><strong class="slate-bold">Note:</strong> Only include the specific properties that need to be updated.</p></div></div><p class="slate-p " ></p>

Updates a merchant's customer's details in ConvesioPay.  For instance, when the integration partner handles an update of the merchant's customer details (ie email, name, billingAddress, etc) in the system, ConvesioPay should be informed.

<p class="slate-p " >Updates the status of the integration&apos;s connection to ConvesioPay.  For instance, when the merchant initiates the connection, ConvesioPay should be informed. Likewise, if the connection is broken for any reason, ConvesioPay should be informed also.</p><p class="slate-p " >The following properties are required to use this endpoint:</p><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative"><code class="slate-code">integrationType</code></div></li><li class="slate-li " ><div style="position:relative"><code class="slate-code">merchantId</code></div></li><li class="slate-li " ><div style="position:relative"><code class="slate-code">lastUpdated</code></div></li><li class="slate-li " ><div style="position:relative"><code class="slate-code">linkId</code></div></li><li class="slate-li " ><div style="position:relative"><code class="slate-code">invoiceLink</code></div></li></ul><div class="slate-div"></div><p class="slate-p " ></p>

Updates the status of the integration's connection to ConvesioPay.  For instance, when the merchant initiates the connection, ConvesioPay should be informed. Likewise, if the connection is broken for any reason, ConvesioPay should be informed also.

<p class="slate-p " >Updates ConvesioPay in the event of an exception.  For instance, when the merchant requests a new payment link via an integration event but the integration decides that it cannot proceed for any reason (ie a malformed customer email or billing address), ConvesioPay can be informed by using this endpoint. Depending on your integration, ConvesioPay can optionally send an email on behalf of the integration partner to let the merchant know of the exception.</p><p class="slate-p " >The following properties are required to use this endpoint:</p><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative"><code class="slate-code">integrationType</code></div></li><li class="slate-li " ><div style="position:relative"><code class="slate-code">merchantId</code></div></li><li class="slate-li " ><div style="position:relative"><code class="slate-code">operation</code></div></li><li class="slate-li " ><div style="position:relative"><code class="slate-code">lastUpdated</code></div></li><li class="slate-li " ><div style="position:relative"><code class="slate-code">event</code></div></li></ul><p class="slate-p " ></p><div class="slate-div"></div><p class="slate-p " ></p><div class="slate-div"></div><p class="slate-p " ></p>

Updates ConvesioPay in the event of an exception.  For instance, when the merchant requests a new payment link via an integration event but the integration decides that it cannot proceed for any reason (ie a malformed customer email or billing address), ConvesioPay can be informed by using this endpoint. Depending on your integration, ConvesioPay can optionally send an email on behalf of the integration partner to let the merchant know of the exception.

<p class="slate-p " >Updates the status/balance outstanding for a payment link requested by your integration.  For instance, when a customer pays via generated payment-link, ConvesioPay will make a request to the <code class="slate-code">URL</code> you provided to inform you that the payment status has changed (see status types below).</p><div style="width:100%;
	min-width:100%;" class="callout-widget" data-type=info ><div class="callout-icon"><svg width="20" height="20" viewBox="0 0 20 20" fill="none" xmlns="http://www.w3.org/2000/svg"><path d="M10.0628 14.1676C10.2434 14.1676 10.3927 14.1086 10.5107 13.9905C10.6288 13.8725 10.6878 13.7232 10.6878 13.5426V9.77177C10.6878 9.6051 10.6253 9.46274 10.5003 9.34469C10.3753 9.22663 10.2295 9.1676 10.0628 9.1676C9.88227 9.1676 9.73296 9.22663 9.61491 9.34469C9.49685 9.46274 9.43783 9.61205 9.43783 9.7926V13.5634C9.43783 13.7301 9.50033 13.8725 9.62533 13.9905C9.75033 14.1086 9.89616 14.1676 10.0628 14.1676ZM10.0003 7.62594C10.1948 7.62594 10.358 7.56344 10.4899 7.43844C10.6219 7.31344 10.6878 7.15371 10.6878 6.95927C10.6878 6.76482 10.6219 6.59816 10.4899 6.45927C10.358 6.32038 10.1948 6.25094 10.0003 6.25094C9.80588 6.25094 9.64269 6.32038 9.51074 6.45927C9.3788 6.59816 9.31283 6.76482 9.31283 6.95927C9.31283 7.15371 9.3788 7.31344 9.51074 7.43844C9.64269 7.56344 9.80588 7.62594 10.0003 7.62594ZM10.0003 18.3343C8.81977 18.3343 7.72255 18.1225 6.70866 17.6989C5.69477 17.2752 4.81283 16.6884 4.06283 15.9384C3.31283 15.1884 2.72602 14.3065 2.30241 13.2926C1.8788 12.2787 1.66699 11.1815 1.66699 10.0009C1.66699 8.83427 1.8788 7.74399 2.30241 6.7301C2.72602 5.71621 3.31283 4.83427 4.06283 4.08427C4.81283 3.33427 5.69477 2.74399 6.70866 2.31344C7.72255 1.88288 8.81977 1.6676 10.0003 1.6676C11.167 1.6676 12.2573 1.88288 13.2712 2.31344C14.285 2.74399 15.167 3.33427 15.917 4.08427C16.667 4.83427 17.2573 5.71621 17.6878 6.7301C18.1184 7.74399 18.3337 8.83427 18.3337 10.0009C18.3337 11.1815 18.1184 12.2787 17.6878 13.2926C17.2573 14.3065 16.667 15.1884 15.917 15.9384C15.167 16.6884 14.285 17.2752 13.2712 17.6989C12.2573 18.1225 11.167 18.3343 10.0003 18.3343ZM10.0003 17.0843C11.9448 17.0843 13.6114 16.3898 15.0003 15.0009C16.3892 13.612 17.0837 11.9454 17.0837 10.0009C17.0837 8.05649 16.3892 6.38982 15.0003 5.00094C13.6114 3.61205 11.9448 2.9176 10.0003 2.9176C8.05588 2.9176 6.38921 3.61205 5.00033 5.00094C3.61144 6.38982 2.91699 8.05649 2.91699 10.0009C2.91699 11.9454 3.61144 13.612 5.00033 15.0009C6.38921 16.3898 8.05588 17.0843 10.0003 17.0843Z" fill="#3960B4"></path></svg></div><div ><p class="slate-p " ><strong class="slate-bold">Note</strong>: Partial payments are supported.</p></div></div><p class="slate-p " >The API endpoint, headers/API key, HTTP method, request parameters structure, and response body structure can be flexible based on the integration partner&apos;s preference. At least the following properties will be sent as (integration partners may require additional properties):</p><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative"><code class="slate-code">merchantId</code></div></li><li class="slate-li " ><div style="position:relative"><code class="slate-code">invoiceId</code></div></li><li class="slate-li " ><div style="position:relative"><code class="slate-code">amount</code></div></li><li class="slate-li " ><div style="position:relative"><code class="slate-code">status</code> (Possible status values are as follows)</div><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative">Succeeded</div></li><li class="slate-li " ><div style="position:relative">Blocked</div></li><li class="slate-li " ><div style="position:relative">Failed</div></li><li class="slate-li " ><div style="position:relative">Cancelled</div></li><li class="slate-li " ><div style="position:relative">Refunded</div></li><li class="slate-li " ><div style="position:relative">Disputed</div></li></ul></li></ul><p class="slate-p " >In general, a <code class="slate-code">200</code> HTTP status from the integration subscribed endpoint will be taken as an accepted webhook, anything else will be regarded as a failure and ConvesioPay will retry sending the webhook until it&apos;s accepted or until the retry policy is exhausted.</p><div style="width:100%;
	min-width:100%;" class="callout-widget" data-type=warning ><div class="callout-icon"><svg width="18" height="16" viewBox="0 0 18 16" fill="none" xmlns="http://www.w3.org/2000/svg"><path d="M0.916637 15.5009C0.791637 15.5009 0.683998 15.4732 0.59372 15.4176C0.503443 15.362 0.430526 15.2857 0.37497 15.1884C0.319415 15.0912 0.288165 14.9905 0.28122 14.8864C0.274276 14.7822 0.305526 14.6745 0.37497 14.5634L8.4583 0.605103C8.52775 0.493991 8.60761 0.41413 8.69789 0.365519C8.78816 0.316908 8.88886 0.292603 8.99997 0.292603C9.11108 0.292603 9.21178 0.316908 9.30205 0.365519C9.39233 0.41413 9.47219 0.493991 9.54164 0.605103L17.625 14.5634C17.6944 14.6745 17.7257 14.7822 17.7187 14.8864C17.7118 14.9905 17.6805 15.0912 17.625 15.1884C17.5694 15.2857 17.4965 15.362 17.4062 15.4176C17.3159 15.4732 17.2083 15.5009 17.0833 15.5009H0.916637ZM1.99997 14.2509H16L8.99997 2.1676L1.99997 14.2509ZM9.0833 13.0634C9.26386 13.0634 9.41316 13.0044 9.53122 12.8864C9.64928 12.7683 9.7083 12.619 9.7083 12.4384C9.7083 12.2579 9.64928 12.1086 9.53122 11.9905C9.41316 11.8725 9.26386 11.8134 9.0833 11.8134C8.90275 11.8134 8.75344 11.8725 8.63539 11.9905C8.51733 12.1086 8.4583 12.2579 8.4583 12.4384C8.4583 12.619 8.51733 12.7683 8.63539 12.8864C8.75344 13.0044 8.90275 13.0634 9.0833 13.0634ZM9.0833 10.7509C9.26386 10.7509 9.41316 10.6919 9.53122 10.5739C9.64928 10.4558 9.7083 10.3065 9.7083 10.1259V6.70927C9.7083 6.52871 9.64928 6.37941 9.53122 6.26135C9.41316 6.1433 9.26386 6.08427 9.0833 6.08427C8.90275 6.08427 8.75344 6.1433 8.63539 6.26135C8.51733 6.37941 8.4583 6.52871 8.4583 6.70927V10.1259C8.4583 10.3065 8.51733 10.4558 8.63539 10.5739C8.75344 10.6919 8.90275 10.7509 9.0833 10.7509Z" fill="#F1C21B"></path></svg></div><div ><p class="slate-p " ><strong class="slate-bold">Note:</strong> Please note that all currency amount fields are in minor units (ie <code class="slate-code">$9.49</code> would be expressed as <code class="slate-code">949</code>).</p></div></div><p class="slate-p " ></p>

Updates the status/balance outstanding for a payment link requested by your integration.  For instance, when a customer pays via generated payment-link, ConvesioPay will make a request to the 

 you provided to inform you that the payment status has changed (see status types below).

The API endpoint, headers/API key, HTTP method, request parameters structure, and response body structure can be flexible based on the integration partner's preference. At least the following properties will be sent as (integration partners may require additional properties):

 HTTP status from the integration subscribed endpoint will be taken as an accepted webhook, anything else will be regarded as a failure and ConvesioPay will retry sending the webhook until it's accepted or until the retry policy is exhausted.

<p class="slate-p " >Communicates that the merchant has requested that your integration be disconnected.</p><p class="slate-p " >The API endpoint, headers/API key, HTTP method, request parameters structure, and response body structure can be flexible based on the integration partner&apos;s preference. At least the following properties will be sent as (integration partners may require additional properties):</p><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative"><code class="slate-code">apiKey</code></div></li><li class="slate-li " ><div style="position:relative"><code class="slate-code">merchantId</code></div></li></ul><p class="slate-p " >In general, a <code class="slate-code">200</code> HTTP status from the integration subscribed endpoint will be taken as an accepted webhook, anything else will be regarded as a failure and ConvesioPay will retry sending the webhook until it&apos;s accepted or until the retry policy is exhausted.</p>

Communicates that the merchant has requested that your integration be disconnected.

Sections