ONVO Documentation

https://docs.onvopay.com/en/
Admin
ONVO is a payment processing platform offering a REST API with test and live modes for integrating...
Tokens:40,997
Snippets:484
Trust Score:7.2
Update:2 months ago
Show doc for...
Tokens:
Raw
### Activate Magento extension

Source: https://docs.onvopay.com/en/llms-full.txt

Execute these commands to upgrade the setup and compile dependency injection after installation.

```bash
bin/magento setup:upgrade
bin/magento setup:di:compile
```

--------------------------------

### Create a coupon with API

Source: https://docs.onvopay.com/en/checkout/one-time-links

Create a coupon via the API for use in one-time links. This example creates a 10% discount for cards starting with a specific BIN. The coupon ID can then be used in the link payload.

```bash
curl https://api.onvopay.com/v1/coupons \
  -X POST \
  -H "Authorization: Bearer $ONVO_SECRET_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Sponsor Bank 10%",
    "type": "percentage",
    "percentOff": 10,
    "scope": "checkout_session",
    "appliesTo": ["one_time_links"],
    "maxRedemptions": 100,
    "redeemBy": "2026-06-30",
    "binRules": [
      {
        "bin": "411111"
      }
    ]
  }'
```

--------------------------------

### Activate and Compile Magento Extension

Source: https://docs.onvopay.com/en/integrations/magento

After installation, run these Magento commands to upgrade the setup and compile dependencies. This is a necessary step before configuring the payment method.

```bash
bin/magento setup:upgrade
bin/magento setup:di:compile
```

--------------------------------

### Start ONVO Signal Session

Source: https://docs.onvopay.com/en/payments/fraud-monitoring

Initialize the ONVO library with your publishable key and start a signal session using the payment intent ID before confirming the payment.

```javascript
const onvo = ONVO("onvo_live_publishable_key_H4PG...");

onvo.startSignalSession({
  paymentIntentId: "clrr934wl001mdpkhw2g82rlt",
});
```

--------------------------------

### Install Magento Extension by Directory

Source: https://docs.onvopay.com/en/integrations/magento

Alternatively, install the extension by downloading the plugin and uploading it to the specified directory within your Magento installation.

```text
/app/code/ONVO/
```

--------------------------------

### Upload directory path

Source: https://docs.onvopay.com/en/llms-full.txt

Target directory for manual plugin installation.

```text
/app/code/ONVO/
```

--------------------------------

### GET /v1/products

Source: https://docs.onvopay.com/en/llms-full.txt

Retrieves a list of all available products.

```APIDOC
## GET /v1/products

### Description
Retrieves a list of all available products.

### Method
GET

### Endpoint
/v1/products
```

--------------------------------

### Install the ONVO SDK

Source: https://docs.onvopay.com/en/integrations/sdk

Include the SDK script in your HTML to access the ONVO payment functionality.

```html
<script src="https://sdk.onvopay.com/sdk.js"></script>
```

--------------------------------

### Define discount types

Source: https://docs.onvopay.com/en/llms-full.txt

Examples for configuring percentage and fixed-amount discount structures.

```json
{
  "type": "percentage",
  "percentOff": 15
}
```

```json
{
  "type": "fixed_amount",
  "amountOff": 250000,
  "currency": "CRC"
}
```

--------------------------------

### Initialize Signal Session

Source: https://docs.onvopay.com/en/llms-full.txt

Initialize the library using your publishable key and start a signal session with the payment intent ID before confirming the payment.

```html
<script>
  const onvo = ONVO("onvo_live_publishable_key_H4PG...");

  onvo.startSignalSession({
    paymentIntentId: "clrr934wl001mdpkhw2g82rlt",
  });
</script>
```

--------------------------------

### GET /v1/prices

Source: https://docs.onvopay.com/en/llms-full.txt

Retrieves a list of all available prices.

```APIDOC
## GET /v1/prices

### Description
Retrieves a list of all available prices.

### Method
GET

### Endpoint
/v1/prices
```

--------------------------------

### GET /v1/payment-intents/account

Source: https://docs.onvopay.com/en/llms-full.txt

Lists all payment intents for the account.

```APIDOC
## GET /v1/payment-intents/account

### Description
Lists all payment intents for the account.

### Method
GET

### Endpoint
/v1/payment-intents/account
```

--------------------------------

### GET /v1/coupons

Source: https://docs.onvopay.com/en/llms-full.txt

Lists coupons created in the API key mode.

```APIDOC
## GET /v1/coupons

### Description
Lists coupons created in the API key mode.

### Method
GET

### Endpoint
/v1/coupons
```

--------------------------------

### Install ONVO Web Library

Source: https://docs.onvopay.com/en/payments/fraud-monitoring

Include the ONVO web library script in the head of your HTML page, ideally before other scripts, to enable signal collection.

```html
<script src="https://js.onvopay.com/v1/"></script>
```

--------------------------------

### GET /v1/products/{id}

Source: https://docs.onvopay.com/en/api/obtener-un-producto

Retrieves the details of a specific product using its unique identifier.

```APIDOC
## GET /v1/products/{id}

### Description
Retrieves the details of a specific product using its unique identifier.

### Method
GET

### Endpoint
/v1/products/{id}

### Parameters
#### Path Parameters
- **id** (string) - Required - The unique identifier of the product to retrieve.
```

--------------------------------

### GET /v1/customers/{id}/payment-methods

Source: https://docs.onvopay.com/en/llms-full.txt

Lists the payment methods associated with a customer.

```APIDOC
## GET /v1/customers/{id}/payment-methods

### Description
Lists the payment methods associated with a customer.

### Method
GET

### Endpoint
/v1/customers/{id}/payment-methods

### Parameters
#### Path Parameters
- **id** (string) - Required - The unique identifier of the customer.
```

--------------------------------

### GET /v1/coupons/{id}

Source: https://docs.onvopay.com/en/llms-full.txt

Retrieves a specific coupon by its unique identifier.

```APIDOC
## GET /v1/coupons/{id}

### Description
Returns a coupon by its identifier.

### Method
GET

### Endpoint
/v1/coupons/{id}

### Parameters
#### Path Parameters
- **id** (string) - Required - The unique identifier of the coupon.
```

--------------------------------

### GET /v1/customers/{id}/subscriptions

Source: https://docs.onvopay.com/en/llms-full.txt

Lists the subscriptions associated with a customer.

```APIDOC
## GET /v1/customers/{id}/subscriptions

### Description
Lists the subscriptions associated with a customer.

### Method
GET

### Endpoint
/v1/customers/{id}/subscriptions

### Parameters
#### Path Parameters
- **id** (string) - Required - The unique identifier of the customer.
```

--------------------------------

### GET /v1/checkout/sessions/one-time-link/{id}

Source: https://docs.onvopay.com/en/llms-full.txt

Retrieves a payment link created from Checkout.

```APIDOC
## GET /v1/checkout/sessions/one-time-link/{id}

### Description
Returns a payment link created from Checkout.

### Method
GET

### Endpoint
/v1/checkout/sessions/one-time-link/{id}

### Parameters
#### Path Parameters
- **id** (string) - Required - The unique identifier of the payment link.
```

--------------------------------

### GET /v1/prices/{id}

Source: https://docs.onvopay.com/en/api/obtener-un-precio

Retrieves the details of a specific price using its ID.

```APIDOC
## GET /v1/prices/{id}

### Description
Retrieves the details of a specific price using its ID.

### Method
GET

### Endpoint
/v1/prices/{id}

### Parameters
#### Path Parameters
- **id** (string) - Required - The unique identifier of the price to retrieve.
```

--------------------------------

### Install Magento Extension with Composer

Source: https://docs.onvopay.com/en/integrations/magento

Use Composer to add the ONVO Magento extension to your project. Run this command from your Magento project root.

```bash
composer require logeek-io/onvo-magento
```

--------------------------------

### GET /v1/customers/{id}/payment-intents

Source: https://docs.onvopay.com/en/llms-full.txt

Lists the payment intents associated with a customer.

```APIDOC
## GET /v1/customers/{id}/payment-intents

### Description
Lists the payment intents associated with a customer.

### Method
GET

### Endpoint
/v1/customers/{id}/payment-intents

### Parameters
#### Path Parameters
- **id** (string) - Required - The unique identifier of the customer.
```

--------------------------------

### GET /v1/checkout/sessions/{id}

Source: https://docs.onvopay.com/en/llms-full.txt

Retrieves a Checkout Session by its unique identifier.

```APIDOC
## GET /v1/checkout/sessions/{id}

### Description
Returns a Checkout Session by its identifier.

### Method
GET

### Endpoint
/v1/checkout/sessions/{id}

### Parameters
#### Path Parameters
- **id** (string) - Required - The unique identifier of the checkout session.
```

--------------------------------

### GET /v1/refunds/{id}

Source: https://docs.onvopay.com/en/llms-full.txt

Retrieves the details of a specific refund object.

```APIDOC
## GET /v1/refunds/{id}

### Description
Retrieves the details of a specific refund object.

### Method
GET

### Endpoint
/v1/refunds/{id}

### Parameters
#### Path Parameters
- **id** (string) - Required - The unique identifier of the refund.
```

--------------------------------

### GET /v1/checkout/sessions/link/{paymentLinkId}

Source: https://docs.onvopay.com/en/llms-full.txt

Creates a checkout session based on an existing payment link identifier.

```APIDOC
## GET /v1/checkout/sessions/link/{paymentLinkId}

### Description
Creates a Checkout Session from an existing payment link.

### Method
GET

### Endpoint
/v1/checkout/sessions/link/{paymentLinkId}

### Parameters
#### Path Parameters
- **paymentLinkId** (string) - Required - The unique identifier of the payment link.
```

--------------------------------

### GET /v1/invoices

Source: https://docs.onvopay.com/en/llms-full.txt

Lists invoices for the account. Invoices represent each billing period for a subscription.

```APIDOC
## GET /v1/invoices

### Description
Lists invoices for the account. Invoices represent each billing period for a subscription. ONVO creates an invoice at the start of the subscription and on each successful renewal.

### Method
GET

### Endpoint
/v1/invoices
```

--------------------------------

### Create a Payment Intent

Source: https://docs.onvopay.com/en

Example of creating a payment intent using curl. Ensure you use the correct test or live secret key in the Authorization header.

```curl
curl https://api.onvopay.com/v1/payment-intents \
  -H "Authorization: Bearer onvo_test_secret_key_..." \
  -H "Content-Type: application/json"  
```

--------------------------------

### GET /v1/customers/{id}

Source: https://docs.onvopay.com/en/api/obtener-un-cliente

Retrieves the details of a specific customer using their unique identifier.

```APIDOC
## GET /v1/customers/{id}

### Description
Retrieves the details of a specific customer using their unique identifier.

### Method
GET

### Endpoint
/v1/customers/{id}

### Parameters
#### Path Parameters
- **id** (string) - Required - The unique identifier of the customer to retrieve.
```

--------------------------------

### GET /v1/payment-methods/{id}

Source: https://docs.onvopay.com/en/llms-full.txt

Retrieves a specific payment method by its unique identifier.

```APIDOC
## GET /v1/payment-methods/{id}

### Description
Retrieves a specific payment method by its unique identifier.

### Method
GET

### Endpoint
/v1/payment-methods/{id}

### Parameters
#### Path Parameters
- **id** (string) - Required - The unique identifier of the payment method.
```

--------------------------------

### GET /v1/connected-accounts

Source: https://docs.onvopay.com/en/api/listar-cuentas-conectadas

Retrieves a paginated list of connected seller accounts owned by the primary account.

```APIDOC
## GET /v1/connected-accounts

### Description
Lists connected seller accounts owned by the primary account in the Secret API Key mode, using cursor pagination.

### Method
GET

### Endpoint
/v1/connected-accounts
```

--------------------------------

### GET /v1/payment-intents/{id}

Source: https://docs.onvopay.com/en/llms-full.txt

Retrieves the details of a specific payment intent by its unique identifier.

```APIDOC
## GET /v1/payment-intents/{id}

### Description
Retrieves the details of a specific payment intent.

### Method
GET

### Endpoint
/v1/payment-intents/{id}

### Parameters
#### Path Parameters
- **id** (string) - Required - The unique identifier of the payment intent.
```

--------------------------------

### Confirm the payment intent

Source: https://docs.onvopay.com/en/payments/credix

Confirm the intent using the payment method ID and the required installment term.

```bash
curl https://api.onvopay.com/v1/payment-intents/$PAYMENT_INTENT_ID/confirm \
  -X POST \
  -H "Authorization: Bearer $ONVO_SECRET_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "paymentMethodId": "cl502zv0d0127ebdp3zt27651",
    "credixInstallmentMonths": 3
  }'
```

--------------------------------

### DELETE /v1/products/{id}

Source: https://docs.onvopay.com/en/api/borrar-un-producto

Deletes a specific product by its ID. Refer to ONVO documentation for integration details and examples.

```APIDOC
## DELETE /v1/products/{id}

### Description
Deletes a specific product using its unique identifier.

### Method
DELETE

### Endpoint
/v1/products/{id}

### Parameters
#### Path Parameters
- **id** (string) - Required - The unique identifier of the product to be deleted.
```

--------------------------------

### Create a subscription with immediate charge

Source: https://docs.onvopay.com/en/llms-full.txt

Include a paymentMethodId to confirm the first charge immediately upon subscription creation.

```bash
curl https://api.onvopay.com/v1/subscriptions \
  -X POST \
  -H "Authorization: Bearer $ONVO_SECRET_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "customerId": "$CUSTOMER_ID",
    "paymentMethodId": "$PAYMENT_METHOD_ID",
    "description": "Monthly Pro Plan",
    "items": [
      {
        "priceId": "$PRICE_ID",
        "quantity": 1
      }
    ],
    "metadata": {
      "accountPlan": "pro",
      "internalSubscriptionId": "sub_123"
    }
  }'
```

--------------------------------

### Create a Product

Source: https://docs.onvopay.com/en/payments/subscriptions

Use this to define a product that will be sold. Store the returned product ID for creating recurring prices.

```bash
curl https://api.onvopay.com/v1/products \
  -X POST \
  -H "Authorization: Bearer $ONVO_SECRET_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Pro Plan",
    "description": "Monthly access to the Pro Plan",
    "isActive": true
  }'
```

--------------------------------

### Handle Card Verification Decline Response

Source: https://docs.onvopay.com/en/payments/overview

Example of a 400 error response when card verification fails, containing structured decline details.

```json
{
  "statusCode": 400,
  "type": "OnvoAPIError",
  "code": "cards.invalid_card_info",
  "message": "There was an error with the card information provided. Please review card number, expiration date and cvv",
  "path": "/v1/payment-methods",
  "details": {
    "card": {
      "reason": "issuer_declined",
      "declineCode": "55",
      "declineMessage": "Incorrect PIN"
    }
  },
  "timestamp": "2026-04-29T17:36:28.477Z"
}
```

--------------------------------

### Execute handleNextAction

Source: https://docs.onvopay.com/en/llms-full.txt

Initialize the library with a publishable key and call handleNextAction to process the required 3DS action.

```html
<script>
  const onvo = ONVO("onvo_live_publishable_key_H4PG...");

  onvo.handleNextAction({
    paymentIntentId: "clrr934wl001mdpkhw2g82rlt",
  }).then(function (result) {
    if (result.error) {
      console.error(result.error);
    } else {
      console.log(result.paymentIntent);
    }
  });
</script>
```

--------------------------------

### POST /v1/payment-intents/{id}/confirm

Source: https://docs.onvopay.com/en/llms-full.txt

Confirms a payment intent with a specific payment method and installment term.

```APIDOC
## POST /v1/payment-intents/{id}/confirm

### Description
Confirms the intent with the paymentMethodId and credixInstallmentMonths.

### Method
POST

### Endpoint
https://api.onvopay.com/v1/payment-intents/$PAYMENT_INTENT_ID/confirm

### Parameters
#### Path Parameters
- **$PAYMENT_INTENT_ID** (string) - Required - The ID of the payment intent to confirm

### Request Body
- **paymentMethodId** (string) - Required - The ID of the payment method
- **credixInstallmentMonths** (integer) - Required - The number of installments

### Request Example
{
  "paymentMethodId": "cl502zv0d0127ebdp3zt27651",
  "credixInstallmentMonths": 3
}
```

--------------------------------

### Create a product via API

Source: https://docs.onvopay.com/en/llms-full.txt

Use this request to define a new product in the system. Ensure the Authorization header includes your secret key.

```bash
curl https://api.onvopay.com/v1/products \
  -X POST \
  -H "Authorization: Bearer $ONVO_SECRET_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Pro Plan",
    "description": "Monthly access to the Pro Plan",
    "isActive": true
  }'
```

--------------------------------

### Create Subscription with Immediate Charge

Source: https://docs.onvopay.com/en/payments/subscriptions

Create a subscription and charge the first period immediately by providing a payment method ID. ONVO handles the payment intent confirmation.

```bash
curl https://api.onvopay.com/v1/subscriptions \
  -X POST \
  -H "Authorization: Bearer $ONVO_SECRET_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "customerId": "$CUSTOMER_ID",
    "paymentMethodId": "$PAYMENT_METHOD_ID",
    "description": "Monthly Pro Plan",
    "items": [
      {
        "priceId": "$PRICE_ID",
        "quantity": 1
      }
    ],
    "metadata": {
      "accountPlan": "pro",
      "internalSubscriptionId": "sub_123"
    }
  }'
```

--------------------------------

### Initialize ONVO Web Library and Handle Next Action

Source: https://docs.onvopay.com/en/payments/three-ds

Use the ONVO web library to handle 3DS authentication within a modal. Initialize the library with your publishable key and call `handleNextAction` when a payment intent requires further action.

```html
<script src="https://js.onvopay.com/v1/"></script>
<script>
  const onvo = ONVO("onvo_live_publishable_key_H4PG...");

  onvo.handleNextAction({
    paymentIntentId: "clrr934wl001mdpkhw2g82rlt",
  }).then(function (result) {
    if (result.error) {
      console.error(result.error);
    } else {
      console.log(result.paymentIntent);
    }
  });
</script>
```

--------------------------------

### Render subscription component

Source: https://docs.onvopay.com/en/integrations/sdk

Initialize the SDK with the subscription ID and payment type set to subscription.

```html
<div id="container"></div>

<script>
  onvo.pay({
    onError: (data) => {
      console.log("error", data);
    },
    onSuccess: (data) => {
      console.log("success", data);
    },
    publicKey: "public-key",
    subscriptionId: "cl4de13uc457301lor2o0q9w1",
    paymentType: "subscription",
    customerId: "cl40wvnby1653akslv93ktgdk",
  }).render("#container");
</script>
```

--------------------------------

### GET /v1/subscriptions/{id}

Source: https://docs.onvopay.com/en/api/obtener-un-cargo-recurrente

Retrieves the details of a specific subscription by its ID.

```APIDOC
## GET /v1/subscriptions/{id}

### Description
Retrieves the details of a specific subscription using its unique identifier.

### Method
GET

### Endpoint
/v1/subscriptions/{id}

### Parameters
#### Path Parameters
- **id** (string) - Required - The unique identifier of the subscription to retrieve.
```

--------------------------------

### Create Subscription with Deferred Confirmation

Source: https://docs.onvopay.com/en/payments/subscriptions

Create a subscription without immediate charge by setting `paymentBehavior` to `allow_incomplete`. The payment method can be omitted initially.

```bash
curl https://api.onvopay.com/v1/subscriptions \
  -X POST \
  -H "Authorization: Bearer $ONVO_SECRET_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "customerId": "$CUSTOMER_ID",
    "paymentBehavior": "allow_incomplete",
    "description": "Monthly Pro Plan",
    "items": [
      {
        "priceId": "$PRICE_ID",
        "quantity": 1
      }
    ],
    "metadata": {
      "accountPlan": "pro",
      "internalSubscriptionId": "sub_123"
    }
  }'
```

--------------------------------

### Fetch AI documentation files via cURL

Source: https://docs.onvopay.com/en/llms-full.txt

Use these commands to retrieve the index, full documentation context, or OpenAPI schema directly from the server.

```bash
curl https://docs.onvopay.com/en/llms.txt
curl https://docs.onvopay.com/en/llms-full.txt
curl https://docs.onvopay.com/openapi.yaml
```

--------------------------------

### GET /v1/checkout/sessions/one-time-link/account

Source: https://docs.onvopay.com/en/api/listar-sesiones-de-checkout

Retrieves a list of one-time checkout sessions associated with the account.

```APIDOC
## GET /v1/checkout/sessions/one-time-link/account

### Description
Retrieves a list of one-time checkout sessions associated with the account.

### Method
GET

### Endpoint
/v1/checkout/sessions/one-time-link/account

### Parameters

### Request Example

### Response
#### Success Response (200)
- **id** (string) - The unique identifier for the checkout session.
- **status** (string) - The current status of the checkout session (e.g., 'completed', 'pending', 'failed').
- **amount** (number) - The total amount for the checkout session.
- **currency** (string) - The currency of the checkout session (e.g., 'USD', 'EUR').
- **createdAt** (string) - The timestamp when the checkout session was created.

#### Response Example
{
  "sessions": [
    {
      "id": "sess_12345abcde",
      "status": "completed",
      "amount": 100.50,
      "currency": "USD",
      "createdAt": "2023-10-27T10:00:00Z"
    },
    {
      "id": "sess_67890fghij",
      "status": "pending",
      "amount": 50.00,
      "currency": "EUR",
      "createdAt": "2023-10-27T09:30:00Z"
    }
  ]
}
```

--------------------------------

### Create a payment intent

Source: https://docs.onvopay.com/en/payments/credix

Initialize a payment intent for the specified amount and currency.

```bash
curl https://api.onvopay.com/v1/payment-intents \
  -X POST \
  -H "Authorization: Bearer $ONVO_SECRET_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "amount": 500000,
    "currency": "CRC",
    "description": "Credix payment #1001"
  }'
```

--------------------------------

### Create a subscription

Source: https://docs.onvopay.com/en/integrations/sdk

Initialize a subscription server-side by sending the customer ID and price items to the subscriptions endpoint.

```javascript
const { data, status } = await axios.post(
  "https://api.onvopay.com/v1/subscriptions",
  {
    customerId: "cl40wvnby1653akslv93ktgdk",
    paymentBehavior: "allow_incomplete",
    items: [
      {
        priceId: "cl4ojmusz299201ldilvdfs8y",
        quantity: 1,
      },
    ],
  },
  {
    headers: {
      Authorization: "Bearer your_secret_key",
    },
  },
);

if (status === 201) {
  console.log(data.id);
}
```

--------------------------------

### Create a Checkout session

Source: https://docs.onvopay.com/en/llms-full.txt

Initiate the payment session by referencing the price ID created previously. Ensure quantity is set to 1.

```bash
curl https://api.onvopay.com/v1/checkout/sessions/one-time-link \
  -X POST \
  -H "Authorization: Bearer $ONVO_SECRET_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "lineItems": [
      {
        "priceId": "price_abc123",
        "quantity": 1
      }
    ],
    "redirectUrl": "https://example.com/thanks",
    "cancelUrl": "https://example.com/canceled",
    "metadata": {
      "campaignId": "donations-2026"
    }
  }'
```

--------------------------------

### Create a payment method

Source: https://docs.onvopay.com/en/llms-full.txt

Register the buyer's mobile number and identification details to associate with the payment intent.

```bash
curl https://api.onvopay.com/v1/payment-methods \
  -X POST \
  -H "Authorization: Bearer $ONVO_SECRET_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "type": "mobile_number",
    "mobileNumber": {
      "identification": "01-1393-1919",
      "identificationType": 0,
      "number": "+50688888888"
    },
    "billing": {
      "name": "Maria Rodriguez",
      "email": "maria@example.com"
    }
  }'
```

--------------------------------

### Create a payment intent

Source: https://docs.onvopay.com/en/getting-started

Initialize a payment intent by sending a POST request to the ONVO API with the order amount and currency.

```bash
curl https://api.onvopay.com/v1/payment-intents \
  -X POST \
  -H "Authorization: Bearer $ONVO_SECRET_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "amount": 250000,
    "currency": "CRC",
    "description": "Order #1001"
  }'
```

--------------------------------

### Fetch Markdown Documentation Files

Source: https://docs.onvopay.com/en/developer-tools/ai-markdown

Use curl to download the AI Markdown versions of ONVO documentation. This includes short indexes, full context files, and the OpenAPI schema.

```bash
curl https://docs.onvopay.com/en/llms.txt
curl https://docs.onvopay.com/en/llms-full.txt
curl https://docs.onvopay.com/openapi.yaml
```

--------------------------------

### Create a Connected Account

Source: https://docs.onvopay.com/en/payments/marketplaces

Create a new connected account via the API by providing the business name and optional marketplace application fee.

```bash
curl https://api.onvopay.com/v1/connected-accounts \
  -X POST \
  -H "Authorization: Bearer <YOUR_SECRET_API_KEY>" \
  -H "Content-Type: application/json" \
  -d '{
    "businessName": "Connected Store",
    "marketplaceAppFee": 5
  }'
```

--------------------------------

### GET /v1/connected-accounts

Source: https://docs.onvopay.com/en/payments/marketplaces

Lists connected accounts in the authenticated mode with support for pagination and status filtering.

```APIDOC
## GET /v1/connected-accounts

### Description
Lists the accounts in the authenticated mode. Supports pagination and filtering by account status.

### Method
GET

### Endpoint
/v1/connected-accounts

### Parameters
#### Query Parameters
- **limit** (integer) - Optional - Number of results to return (1-100, default 10).
- **startingAfter** (string) - Optional - Cursor for pagination.
- **endingBefore** (string) - Optional - Cursor for pagination.
- **status** (string) - Optional - Filter by status: pending_onboarding, awaiting_approval, active, inactive, temporally_suspended, permanently_suspended, or deleted.

### Response
#### Success Response (200)
- **data** (array) - List of connected account objects.
- **meta** (object) - Pagination metadata including total, pages, limit, and cursors.
```

--------------------------------

### POST /v1/connected-accounts

Source: https://docs.onvopay.com/en/api/crear-una-cuenta-conectada

Creates a new connected seller account and returns an ONVO-hosted onboarding URL.

```APIDOC
## POST /v1/connected-accounts

### Description
Creates a connected seller account in the primary account and mode determined by the Secret API Key. The response includes the ONVO-hosted onboarding URL.

### Method
POST

### Endpoint
/v1/connected-accounts
```

--------------------------------

### GET /v1/connected-accounts/{id}

Source: https://docs.onvopay.com/en/api/obtener-una-cuenta-conectada

Retrieves the public connected account object for a given account ID.

```APIDOC
## GET /v1/connected-accounts/{id}

### Description
Returns the public connected account object when it belongs to the authenticated primary account and mode.

### Method
GET

### Endpoint
/v1/connected-accounts/{id}

### Parameters
#### Path Parameters
- **id** (string) - Required - The unique identifier of the connected account.
```

--------------------------------

### Create a Payment Method

Source: https://docs.onvopay.com/en/payments/subscriptions

Create a payment method for a customer, optionally associating it with a new or existing customer. Store the payment method ID and customer ID.

```bash
curl https://api.onvopay.com/v1/payment-methods \
  -X POST \
  -H "Authorization: Bearer $ONVO_PUBLISHABLE_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "type": "card",
    "card": {
      "number": "4242424242424242",
      "expMonth": 12,
      "expYear": 2028,
      "cvv": "123",
      "holderName": "Maria Rodriguez"
    },
    "billing": {
      "name": "Maria Rodriguez",
      "email": "maria@example.com",
      "address": {
        "country": "CR"
      }
    },
    "customer": {
      "name": "Maria Rodriguez",
      "email": "maria@example.com",
      "phone": "+50688880000"
    }
  }'
```

--------------------------------

### Create Checkout Session for One-Time Payment Link

Source: https://docs.onvopay.com/en/checkout/open-amount

Create a Checkout session referencing the price with `customUnitAmount`. Use a single line item with `quantity: 1` and specify redirect and cancel URLs.

```bash
curl https://api.onvopay.com/v1/checkout/sessions/one-time-link \
  -X POST \
  -H "Authorization: Bearer $ONVO_SECRET_KEY" \
  -H "Content-Type: application/json" \
  -d '{ \
    "lineItems": [ \
      { \
        "priceId": "price_abc123", \
        "quantity": 1 \
      } \
    ], \
    "redirectUrl": "https://example.com/thanks", \
    "cancelUrl": "https://example.com/canceled", \
    "metadata": { \
      "campaignId": "donations-2026" \
    } \
  }'
```

--------------------------------

### Create Product for Donation

Source: https://docs.onvopay.com/en/checkout/open-amount

Create a product that will be displayed in Checkout. Include a name, description, and images to help the buyer understand the purpose of the payment.

```bash
curl https://api.onvopay.com/v1/products \
  -X POST \
  -H "Authorization: Bearer $ONVO_SECRET_KEY" \
  -H "Content-Type: application/json" \
  -d '{ \
    "name": "Blue Foundation donation", \
    "description": "Voluntary contribution for the annual campaign", \
    "images": [ \
      "https://example.com/donation.png" \
    ] \
  }'
```

--------------------------------

### Regenerate Onboarding Link

Source: https://docs.onvopay.com/en/payments/marketplaces

Use this request to generate a new onboarding link for a connected account. The previous link will expire upon successful generation.

```bash
curl https://api.onvopay.com/v1/connected-accounts/cl502zv0d0127ebdp3zt27651/onboarding-link \
  -X POST \
  -H "Authorization: Bearer <YOUR_SECRET_API_KEY>"
```

--------------------------------

### GET /v1/invoices/{id}

Source: https://docs.onvopay.com/en/llms-full.txt

Retrieves a specific invoice associated with a billing period or subscription renewal.

```APIDOC
## GET /v1/invoices/{id}

### Description
Returns a specific invoice. Invoices represent each billing period for a subscription and are associated with a payment intent.

### Method
GET

### Endpoint
/v1/invoices/{id}

### Parameters
#### Path Parameters
- **id** (string) - Required - The unique identifier of the invoice.
```

--------------------------------

### Create a product for custom payments

Source: https://docs.onvopay.com/en/llms-full.txt

Register a new product in the ONVO catalog to be used for the donation or custom payment flow.

```bash
curl https://api.onvopay.com/v1/products \
  -X POST \
  -H "Authorization: Bearer $ONVO_SECRET_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Blue Foundation donation",
    "description": "Voluntary contribution for the annual campaign",
    "images": [
      "https://example.com/donation.png"
    ]
  }'
```

--------------------------------

### Domain Error Payload

Source: https://docs.onvopay.com/en/payments/marketplaces

Example of a structured error response returned by the API when a domain-specific error occurs.

```json
{
  "statusCode": 404,
  "type": "OnvoAPIError",
  "code": "marketplaces.connected_account_not_found",
  "message": "The connected account was not found",
  "path": "/v1/connected-accounts/cl502zv0d0127ebdp3zt27651",
  "timestamp": "2026-07-25T17:00:00.000Z"
}
```

--------------------------------

### POST /v1/connected-accounts/{id}/onboarding-link

Source: https://docs.onvopay.com/en/api/regenerar-enlace-de-onboarding

Expires the prior onboarding link and creates a new ONVO-hosted link for a connected account that has not completed onboarding.

```APIDOC
## POST /v1/connected-accounts/{id}/onboarding-link

### Description
Expires the prior onboarding link and creates a new ONVO-hosted link for a connected account that has not completed onboarding.

### Method
POST

### Endpoint
/v1/connected-accounts/{id}/onboarding-link

### Parameters
#### Path Parameters
- **id** (string) - Required - The unique identifier of the connected account.
```

--------------------------------

### Configure API keys

Source: https://docs.onvopay.com/en/getting-started

Set your test secret and publishable keys as environment variables to authenticate requests.

```bash
export ONVO_SECRET_KEY="onvo_test_secret_key_..."
export ONVO_PUBLISHABLE_KEY="onvo_test_publishable_key_..."
```

--------------------------------

### Onboarding Link Response

Source: https://docs.onvopay.com/en/payments/marketplaces

The JSON response returned after successfully requesting a new onboarding link.

```json
{
  "id": "cl502zv0d0127ebdp3zt27651",
  "onboardingUrl": "https://onvopay.com/setup/account_onboarding_test_example"
}
```

--------------------------------

### POST /v1/products

Source: https://docs.onvopay.com/en/llms-full.txt

Creates a new product to be displayed in the Checkout session.

```APIDOC
## POST /v1/products

### Description
Creates a product that Checkout displays to the buyer.

### Method
POST

### Endpoint
https://api.onvopay.com/v1/products

### Request Body
- **name** (string) - Required - The name of the product.
- **description** (string) - Optional - Description of the product.
- **images** (array) - Optional - List of image URLs.
```

--------------------------------

### GET /v1/mobile-transfers/list

Source: https://docs.onvopay.com/en/api/listar-pagos-por-sinpe-movil

Retrieves a paginated list of SINPE Movil transfers. This endpoint is useful for fetching transaction history and details.

```APIDOC
## GET /v1/mobile-transfers/list

### Description
Retrieves a paginated list of SINPE Movil transfers. This endpoint is useful for fetching transaction history and details.

### Method
GET

### Endpoint
/v1/mobile-transfers/list

### Parameters
#### Query Parameters
- **page** (integer) - Optional - The page number to retrieve.
- **limit** (integer) - Optional - The number of records to return per page.

### Response
#### Success Response (200)
- **data** (array) - A list of SINPE Movil payment objects.
  - **id** (string) - The unique identifier of the payment.
  - **amount** (number) - The amount of the transfer.
  - **currency** (string) - The currency of the transfer (e.g., "CRC").
  - **status** (string) - The status of the transfer (e.g., "completed", "pending", "failed").
  - **createdAt** (string) - The timestamp when the transfer was created.
  - **recipient_phone** (string) - The phone number of the recipient.
  - **sender_phone** (string) - The phone number of the sender.
  - **external_id** (string) - An external identifier for the transfer.
- **meta** (object) - Metadata for pagination.
  - **totalItems** (integer) - The total number of items available.
  - **itemCount** (integer) - The number of items returned in this response.
  - **pages** (integer) - The total number of pages available.
  - **limit** (integer) - The limit set for items per page.
  - **page** (integer) - The current page number.
  - **hasNextPage** (boolean) - Indicates if there is a next page.
  - **hasPrevPage** (boolean) - Indicates if there is a previous page.
  - **nextPage** (integer) - The page number of the next page.
  - **prevPage** (integer) - The page number of the previous page.
```

--------------------------------

### Validation Error Response

Source: https://docs.onvopay.com/en/payments/payment-intents

Example of a 400 Bad Request response returned when input fields fail validation rules.

```json
{
  "statusCode": 400,
  "message": ["card.number Card number is invalid"],
  "error": "Bad Request"
}
```

--------------------------------

### Fetch First Page of Customers

Source: https://docs.onvopay.com/en/reference/pagination

Use this snippet to retrieve the initial set of customer records. It sets a limit of 10 customers per page.

```bash
curl "https://api.onvopay.com/v1/customers?limit=10" \
  -H "Authorization: Bearer onvo_test_secret_key_..."
```
Tokens:
Raw