### 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/ ``` -------------------------------- ### POST /v1/products Source: https://docs.onvopay.com/en/llms-full.txt Creates a product. Refer to ONVO documentation for integration details and examples. ```APIDOC ## POST /v1/products ### Description Creates a product. Refer to ONVO documentation for integration details and examples. ### Method POST ### Endpoint /v1/products ``` -------------------------------- ### Create a Customer Source: https://docs.onvopay.com/en/llms.txt Creates a new customer. Refer to ONVO documentation for integration details and examples. ```APIDOC ## Create a Customer ### Description Creates a new customer. Refer to ONVO documentation for integration details and examples. ### Method POST (Assumed based on 'Create' action) ### Endpoint /customers (Assumed structure) ### Parameters #### Request Body - **customerDetails** (object) - Required - The details for the new customer. - **name** (string) - Required - The customer's full name. - **email** (string) - Required - The customer's email address. - **phone** (string) - Optional - The customer's phone number. ``` -------------------------------- ### POST /v1/customers Source: https://docs.onvopay.com/en/llms-full.txt Creates a customer. Refer to ONVO documentation for integration details and examples. ```APIDOC ## POST /v1/customers ### Description Creates a customer. Refer to ONVO documentation for integration details and examples. ### Method POST ### Endpoint /v1/customers ``` -------------------------------- ### Create a Price Source: https://docs.onvopay.com/en/llms.txt Creates a new price. Refer to ONVO documentation for integration details and examples. ```APIDOC ## Create a Price ### Description Creates a new price. Refer to ONVO documentation for integration details and examples. ### Method POST (Assumed based on 'Create' action) ### Endpoint /prices (Assumed structure) ### Parameters #### Request Body - **priceDetails** (object) - Required - The details for the new price. - **unitAmount** (integer) - Required - The unit amount for the price. - **currency** (string) - Required - The currency for the price. - **productId** (string) - Required - The ID of the product this price is for. ``` -------------------------------- ### 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. ``` -------------------------------- ### POST /v1/prices Source: https://docs.onvopay.com/en/llms-full.txt Creates a price. Refer to ONVO documentation for integration details and examples. ```APIDOC ## POST /v1/prices ### Description Creates a price. Refer to ONVO documentation for integration details and examples. ### Method POST ### Endpoint /v1/prices ``` -------------------------------- ### POST /v1/subscriptions Source: https://docs.onvopay.com/en/llms-full.txt Creates a subscription. Refer to ONVO documentation for integration details and examples. ```APIDOC ## POST /v1/subscriptions ### Description Creates a subscription. Refer to ONVO documentation for integration details and examples. ### Method POST ### Endpoint /v1/subscriptions ``` -------------------------------- ### 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 ``` -------------------------------- ### POST /v1/payment-methods Source: https://docs.onvopay.com/en/llms-full.txt Creates a payment method. Refer to ONVO documentation for integration details and examples. ```APIDOC ## POST /v1/payment-methods ### Description Creates a payment method. Refer to ONVO documentation for integration details and examples. ### Method POST ### Endpoint /v1/payment-methods ``` -------------------------------- ### POST /v1/refunds Source: https://docs.onvopay.com/en/llms-full.txt Creates a refund. Refer to ONVO documentation for integration details and examples. ```APIDOC ## POST /v1/refunds ### Description Creates a refund. Refer to ONVO documentation for integration details and examples. ### Method POST ### Endpoint /v1/refunds ``` -------------------------------- ### POST /v1/payment-intents Source: https://docs.onvopay.com/en/llms-full.txt Creates a payment intent. Refer to ONVO documentation for integration details and examples. ```APIDOC ## POST /v1/payment-intents ### Description Creates a payment intent. Refer to ONVO documentation for integration details and examples. ### Method POST ### Endpoint /v1/payment-intents ``` -------------------------------- ### Create a Payment Method Source: https://docs.onvopay.com/en/llms.txt Creates a new payment method. Refer to ONVO documentation for integration details and examples. ```APIDOC ## Create a Payment Method ### Description Creates a new payment method. Refer to ONVO documentation for integration details and examples. ### Method POST (Assumed based on 'Create' action) ### Endpoint /payment-methods (Assumed structure) ### Parameters #### Request Body - **paymentMethodDetails** (object) - Required - The details for the new payment method. - **type** (string) - Required - The type of payment method (e.g., 'card', 'bank_account'). - **billingDetails** (object) - Required - The billing details for the payment method. ``` -------------------------------- ### Update a Product Source: https://docs.onvopay.com/en/llms.txt Updates an existing product. Refer to ONVO documentation for integration details and examples. ```APIDOC ## Update a Product ### Description Updates an existing product. Refer to ONVO documentation for integration details and examples. ### Method PUT (Assumed based on 'Update' action) ### Endpoint /products/{productId} (Assumed structure) ### Parameters #### Path Parameters - **productId** (string) - Required - The ID of the product to update. #### Request Body - **productUpdate** (object) - Optional - The fields to update on the product. - **name** (string) - Optional - The new name of the product. - **description** (string) - Optional - The new description of the product. ``` -------------------------------- ### Create a Subscription Source: https://docs.onvopay.com/en/llms.txt Creates a new recurring charge (subscription). Refer to ONVO documentation for integration details and examples. ```APIDOC ## Create a Subscription ### Description Creates a new recurring charge (subscription). Refer to ONVO documentation for integration details and examples. ### Method POST (Assumed based on 'Create' action) ### Endpoint /subscriptions (Assumed structure) ### Parameters #### Request Body - **subscriptionDetails** (object) - Required - The details for the new subscription. - **customerId** (string) - Required - The ID of the customer. - **items** (array) - Required - A list of items to include in the subscription. - **priceId** (string) - Required - The ID of the price for the item. - **quantity** (integer) - Optional - The quantity of the item. ``` -------------------------------- ### 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 ``` -------------------------------- ### POST /v1/checkout/sessions/one-time-link Source: https://docs.onvopay.com/en/llms-full.txt Creates a one-time link Checkout Session. Refer to ONVO documentation for integration details and examples. ```APIDOC ## POST /v1/checkout/sessions/one-time-link ### Description Creates a one-time link Checkout Session. Refer to ONVO documentation for integration details and examples. ### Method POST ### Endpoint /v1/checkout/sessions/one-time-link ``` -------------------------------- ### 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" ``` -------------------------------- ### 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 }' ``` -------------------------------- ### 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 ``` -------------------------------- ### 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. ``` -------------------------------- ### 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. ``` -------------------------------- ### 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 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" } }' ``` -------------------------------- ### 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. ``` -------------------------------- ### 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 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" \ ] \ }' ``` -------------------------------- ### 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_..." ``` -------------------------------- ### Delete a Price Source: https://docs.onvopay.com/en/llms.txt Deletes an existing price. Refer to ONVO documentation for integration details and examples. ```APIDOC ## Delete a Price ### Description Deletes an existing price. Refer to ONVO documentation for integration details and examples. ### Method DELETE (Assumed based on 'Delete' action) ### Endpoint /prices/{priceId} (Assumed structure) ### Parameters #### Path Parameters - **priceId** (string) - Required - The ID of the price to delete. ``` -------------------------------- ### Charge immediately Source: https://docs.onvopay.com/en/llms-full.txt Creates a subscription and charges the first period immediately using the provided payment method. ```APIDOC ## Charge immediately ### Description Creates a subscription and confirms the first charge immediately using a specified payment method. If `paymentBehavior` is omitted, this is the default behavior. ### Method POST ### Endpoint /v1/subscriptions ### Parameters #### Request Body - **customerId** (string) - Required - The ID of the customer. - **paymentMethodId** (string) - Required - The ID of the payment method to use for the charge. - **description** (string) - Optional - A description for the subscription. - **items** (array) - Required - List of items in the subscription. - **priceId** (string) - Required - The ID of the price for the item. - **quantity** (integer) - Required - The quantity of the item. - **metadata** (object) - Optional - Key-value pairs for additional information. ### Request Example ```json { "customerId": "$CUSTOMER_ID", "paymentMethodId": "$PAYMENT_METHOD_ID", "description": "Monthly Pro Plan", "items": [ { "priceId": "$PRICE_ID", "quantity": 1 } ], "metadata": { "accountPlan": "pro", "internalSubscriptionId": "sub_123" } } ``` ### Response (Success response details not provided in source) ``` -------------------------------- ### Delete a Customer Source: https://docs.onvopay.com/en/llms.txt Deletes a customer by their identifier. Refer to ONVO documentation for integration details and examples. ```APIDOC ## Delete a Customer ### Description Deletes a customer by their identifier. Refer to ONVO documentation for integration details and examples. ### Method DELETE (Assumed based on 'Delete' action) ### Endpoint /customers/{customerId} (Assumed structure) ### Parameters #### Path Parameters - **customerId** (string) - Required - The ID of the customer to delete. ``` -------------------------------- ### Create a Card Payment Method Source: https://docs.onvopay.com/en/payments/payment-intents Create a card payment method using a publishable key. The response includes an ID to be used when confirming a payment intent. Includes validation rules for card details. ```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" } } }' ``` -------------------------------- ### Create a Bank Deposit Payment Method Source: https://docs.onvopay.com/en/payments/sinpe-pin Create a payment method of type 'bank_deposit'. The 'bankDeposit.identification' must match the identification of the person or entity making the bank transfer. ```bash curl https://api.onvopay.com/v1/payment-methods \ -X POST \ -H "Authorization: Bearer $ONVO_SECRET_KEY" \ -H "Content-Type: application/json" \ -d '{ "type": "bank_deposit", "bankDeposit": { "identification": "01-1393-1919", "identificationType": 1 }, "billing": { "name": "Maria Rodriguez", "email": "maria@example.com" } }' ``` -------------------------------- ### Update a Price Source: https://docs.onvopay.com/en/llms.txt Updates an existing price. Refer to ONVO documentation for integration details and examples. ```APIDOC ## Update a Price ### Description Updates an existing price. Refer to ONVO documentation for integration details and examples. ### Method PUT (Assumed based on 'Update' action) ### Endpoint /prices/{priceId} (Assumed structure) ### Parameters #### Path Parameters - **priceId** (string) - Required - The ID of the price to update. #### Request Body - **priceUpdate** (object) - Optional - The fields to update on the price. - **unitAmount** (integer) - Optional - The new unit amount for the price. - **currency** (string) - Optional - The new currency for the price. ``` -------------------------------- ### Fetch Next Page of Customers Source: https://docs.onvopay.com/en/reference/pagination Use this snippet to retrieve the subsequent page of customer records. It requires the `startingAfter` cursor from the previous response. ```bash curl "https://api.onvopay.com/v1/customers?limit=10&startingAfter=cl40muorw00493ndp0okzk2g3" \ -H "Authorization: Bearer onvo_test_secret_key_..." ``` -------------------------------- ### Create a one-time link Checkout session Source: https://docs.onvopay.com/en/checkout/one-time-links Use this endpoint to create a Checkout session for a fixed charge. Provide line items with unit amounts and currency. The response includes a URL to redirect the buyer. ```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": [ { "quantity": 1, "unitAmount": 250000, "currency": "CRC", "description": "Order #1001" } ], "customerEmail": "buyer@example.com", "redirectUrl": "https://example.com/success", "cancelUrl": "https://example.com/cancel", "discounts": [ { "coupon": "cpn_abc123" } ], "metadata": { "orderId": "1001" } }' ``` -------------------------------- ### POST /v1/subscriptions/{id}/confirm Source: https://docs.onvopay.com/en/llms-full.txt Confirms a subscription. Refer to ONVO documentation for integration details and examples. ```APIDOC ## POST /v1/subscriptions/{id}/confirm ### Description Confirms a subscription. Refer to ONVO documentation for integration details and examples. ### Method POST ### Endpoint /v1/subscriptions/{id}/confirm ``` -------------------------------- ### Create Subscription Server-Side Source: https://docs.onvopay.com/en/integrations/sdk Use this JavaScript code to create a subscription on your server. Ensure you replace 'your_secret_key' with your actual secret key. ```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); } ``` -------------------------------- ### Handle 3DS Authentication with ONVO Source: https://docs.onvopay.com/en/llms-full.txt Initialize the ONVO library and handle next actions for 3DS authentication. Ensure to validate the final payment intent status even if authentication succeeds. ```javascript 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); } }); ``` -------------------------------- ### Confirm a Payment Intent Source: https://docs.onvopay.com/en/llms.txt Confirms an existing payment intent. Refer to ONVO documentation for integration details and examples. ```APIDOC ## Confirm a Payment Intent ### Description Confirms an existing payment intent. Refer to ONVO documentation for integration details and examples. ### Method POST (Assumed based on 'Confirm' action) ### Endpoint /payment-intents/{paymentIntentId}/confirm (Assumed structure) ### Parameters #### Path Parameters - **paymentIntentId** (string) - Required - The ID of the payment intent to confirm. ``` -------------------------------- ### List all Products Source: https://docs.onvopay.com/en/llms-full.txt Retrieves a list of all products available in the system. This endpoint is key for inventory and sales management. ```APIDOC ## GET /v1/products ### Description Retrieves a list of all products. ### Method GET ### Endpoint /v1/products ``` -------------------------------- ### Create a product Source: https://docs.onvopay.com/en/llms-full.txt Creates a new product in the ONVO Pay system. The product ID can be used later to create recurring prices. ```APIDOC ## Create a product ### Description Creates a new product with a name, description, and active status. ### Method POST ### Endpoint /v1/products ### Request Body - **name** (string) - Required - The name of the product. - **description** (string) - Optional - A description for the product. - **isActive** (boolean) - Optional - Whether the product is active. ### Request Example ```json { "name": "Pro Plan", "description": "Monthly access to the Pro Plan", "isActive": true } ``` ### Response (Success response details not provided in source) ``` -------------------------------- ### Confirm a Subscription Source: https://docs.onvopay.com/en/llms.txt Confirms an existing recurring charge (subscription). Refer to ONVO documentation for integration details and examples. ```APIDOC ## Confirm a Subscription ### Description Confirms an existing recurring charge (subscription). Refer to ONVO documentation for integration details and examples. ### Method POST (Assumed based on 'Confirm' action) ### Endpoint /subscriptions/{subscriptionId}/confirm (Assumed structure) ### Parameters #### Path Parameters - **subscriptionId** (string) - Required - The ID of the subscription to confirm. ``` -------------------------------- ### Capture a Payment Intent Source: https://docs.onvopay.com/en/llms.txt Captures an existing payment intent. Refer to ONVO documentation for integration details and examples. ```APIDOC ## Capture a Payment Intent ### Description Captures an existing payment intent. Refer to ONVO documentation for integration details and examples. ### Method POST (Assumed based on 'Capture' action) ### Endpoint /payment-intents/{paymentIntentId}/capture (Assumed structure) ### Parameters #### Path Parameters - **paymentIntentId** (string) - Required - The ID of the payment intent to capture. ``` -------------------------------- ### Create Test Bank Deposit Payment Method Source: https://docs.onvopay.com/en/llms-full.txt Use 'bank_deposit' as the type and provide identification details to simulate bank deposit payments. This method supports scenarios with successful deposits, failures, delays, and partial payments. ```json { "type": "bank_deposit", "bankDeposit": { "identification": "00-0000-8888", "identificationType": "identification" } } ``` ```json { "type": "bank_deposit", "bankDeposit": { "identification": "00-0000-9521", "identificationType": "identification" } } ``` ```json { "type": "bank_deposit", "bankDeposit": { "identification": "00-0000-4444", "identificationType": "identification" } } ``` ```json { "type": "bank_deposit", "bankDeposit": { "identification": "00-0000-3333", "identificationType": "identification" } } ``` -------------------------------- ### Create a Payment Intent Source: https://docs.onvopay.com/en/payments/payment-intents Create a payment intent with the specified amount and currency. Use a secret key for server-side operations. ```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": "Order #1001" }' ``` -------------------------------- ### Cancel a Payment Intent Source: https://docs.onvopay.com/en/llms.txt Cancels an existing payment intent. Refer to ONVO documentation for integration details and examples. ```APIDOC ## Cancel a Payment Intent ### Description Cancels an existing payment intent. Refer to ONVO documentation for integration details and examples. ### Method POST (Assumed based on 'Cancel' action) ### Endpoint /payment-intents/{paymentIntentId}/cancel (Assumed structure) ### Parameters #### Path Parameters - **paymentIntentId** (string) - Required - The ID of the payment intent to cancel. ``` -------------------------------- ### Cancel a Subscription Source: https://docs.onvopay.com/en/llms.txt Cancels an existing recurring charge (subscription). Refer to ONVO documentation for integration details and examples. ```APIDOC ## Cancel a Subscription ### Description Cancels an existing recurring charge (subscription). Refer to ONVO documentation for integration details and examples. ### Method POST (Assumed based on 'Cancel' action) ### Endpoint /subscriptions/{subscriptionId}/cancel (Assumed structure) ### Parameters #### Path Parameters - **subscriptionId** (string) - Required - The ID of the subscription to cancel. ``` -------------------------------- ### Delete a Shipping Rate Source: https://docs.onvopay.com/en/llms.txt Deletes an existing shipping rate. Refer to ONVO documentation for integration details and examples. ```APIDOC ## Delete a Shipping Rate ### Description Deletes an existing shipping rate. Refer to ONVO documentation for integration details and examples. ### Method DELETE (Assumed based on 'Delete' action) ### Endpoint /shipping-rates/{shippingRateId} (Assumed structure) ### Parameters #### Path Parameters - **shippingRateId** (string) - Required - The ID of the shipping rate to delete. ``` -------------------------------- ### Create a Payment Intent Source: https://docs.onvopay.com/en/payments/sinpe-pin Use this endpoint to create a payment intent for the exact amount to collect. Ensure the currency is set to 'CRC'. ```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": "SINPE PIN payment #1001" }' ``` -------------------------------- ### Update a Shipping Rate Source: https://docs.onvopay.com/en/llms.txt Updates an existing shipping rate. Refer to ONVO documentation for integration details and examples. ```APIDOC ## Update a Shipping Rate ### Description Updates an existing shipping rate. Refer to ONVO documentation for integration details and examples. ### Method PUT (Assumed based on 'Update' action) ### Endpoint /shipping-rates/{shippingRateId} (Assumed structure) ### Parameters #### Path Parameters - **shippingRateId** (string) - Required - The ID of the shipping rate to update. #### Request Body - **shippingRateUpdate** (object) - Optional - The fields to update on the shipping rate. - **name** (string) - Optional - The name of the shipping rate. - **price** (integer) - Optional - The price of the shipping rate. ``` -------------------------------- ### Create an intent Source: https://docs.onvopay.com/en/llms-full.txt Creates a payment intent with a specified amount, currency, and description. ```APIDOC ## Create an intent ### Method POST ### Endpoint https://api.onvopay.com/v1/payment-intents ### Request Body - **amount** (integer) - Required - The amount to charge in the smallest currency unit. - **currency** (string) - Required - The currency code (e.g., "CRC"). - **description** (string) - Optional - A description for the payment intent. ### Request Example ```json { "amount": 500000, "currency": "CRC", "description": "Order #1001" } ``` ``` -------------------------------- ### Update a Payment Intent Source: https://docs.onvopay.com/en/llms.txt Updates an existing payment intent. Refer to ONVO documentation for integration details and examples. ```APIDOC ## Update a Payment Intent ### Description Updates an existing payment intent. Refer to ONVO documentation for integration details and examples. ### Method PUT (Assumed based on 'Update' action) ### Endpoint /payment-intents/{paymentIntentId} (Assumed structure) ### Parameters #### Path Parameters - **paymentIntentId** (string) - Required - The ID of the payment intent to update. #### Request Body - **paymentIntentUpdate** (object) - Optional - The fields to update on the payment intent. - **amount** (integer) - Optional - The new amount for the payment intent. - **currency** (string) - Optional - The new currency for the payment intent. ``` -------------------------------- ### Update a Payment Method Source: https://docs.onvopay.com/en/llms.txt Updates an existing payment method. Refer to ONVO documentation for integration details and examples. ```APIDOC ## Update a Payment Method ### Description Updates an existing payment method. Refer to ONVO documentation for integration details and examples. ### Method PUT (Assumed based on 'Update' action) ### Endpoint /payment-methods/{paymentMethodId} (Assumed structure) ### Parameters #### Path Parameters - **paymentMethodId** (string) - Required - The ID of the payment method to update. #### Request Body - **paymentMethodUpdate** (object) - Optional - The fields to update on the payment method. - **billingDetails** (object) - Optional - Updated billing details. ``` -------------------------------- ### Percentage discount type Source: https://docs.onvopay.com/en/checkout/one-time-links Configure a coupon to apply a percentage discount to the total amount. The `percentOff` value must be between 1 and 100. ```json { "type": "percentage", "percentOff": 15 } ``` -------------------------------- ### Update a Customer Source: https://docs.onvopay.com/en/llms.txt Updates an existing customer's information. Refer to ONVO documentation for integration details and examples. ```APIDOC ## Update a Customer ### Description Updates an existing customer's information. Refer to ONVO documentation for integration details and examples. ### Method PUT (Assumed based on 'Update' action) ### Endpoint /customers/{customerId} (Assumed structure) ### Parameters #### Path Parameters - **customerId** (string) - Required - The ID of the customer to update. #### Request Body - **customerUpdate** (object) - Optional - The fields to update on the customer. - **name** (string) - Optional - The customer's full name. - **email** (string) - Optional - The customer's email address. - **phone** (string) - Optional - The customer's phone number. ``` -------------------------------- ### Create Price with Custom Amount Source: https://docs.onvopay.com/en/checkout/open-amount Create a one-time price that allows the customer to specify the payment amount. Set `customUnitAmount` with `preset`, `minimum`, and `maximum` values in the currency's minor unit. ```bash curl https://api.onvopay.com/v1/prices \ -X POST \ -H "Authorization: Bearer $ONVO_SECRET_KEY" \ -H "Content-Type: application/json" \ -d '{ \ "currency": "CRC", \ "type": "one_time", \ "productId": "prod_abc123", \ "customUnitAmount": { \ "preset": 1000000, \ "minimum": 500000, \ "maximum": 5000000 \ } \ }' ``` -------------------------------- ### Update a Subscription Source: https://docs.onvopay.com/en/llms.txt Updates an existing recurring charge (subscription). Refer to ONVO documentation for integration details and examples. ```APIDOC ## Update a Subscription ### Description Updates an existing recurring charge (subscription). Refer to ONVO documentation for integration details and examples. ### Method PUT (Assumed based on 'Update' action) ### Endpoint /subscriptions/{subscriptionId} (Assumed structure) ### Parameters #### Path Parameters - **subscriptionId** (string) - Required - The ID of the subscription to update. #### Request Body - **subscriptionUpdate** (object) - Optional - The fields to update on the subscription. - **status** (string) - Optional - The new status of the subscription (e.g., 'active', 'canceled'). - **billingCycleAnchor** (string) - Optional - The date when the next billing cycle should start. ``` -------------------------------- ### 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. ``` -------------------------------- ### Defer confirmation Source: https://docs.onvopay.com/en/llms-full.txt Creates a subscription without immediate charge, allowing for confirmation in a separate step. ```APIDOC ## Defer confirmation ### Description Creates a subscription first and allows the charge to be confirmed in a later request by setting `paymentBehavior` to `allow_incomplete`. `paymentMethodId` can be omitted in this case. ### Method POST ### Endpoint /v1/subscriptions ### Parameters #### Request Body - **customerId** (string) - Required - The ID of the customer. - **paymentBehavior** (string) - Required - Set to 'allow_incomplete' to defer confirmation. - **description** (string) - Optional - A description for the subscription. - **items** (array) - Required - List of items in the subscription. - **priceId** (string) - Required - The ID of the price for the item. - **quantity** (integer) - Required - The quantity of the item. - **metadata** (object) - Optional - Key-value pairs for additional information. ### Request Example ```json { "customerId": "$CUSTOMER_ID", "paymentBehavior": "allow_incomplete", "description": "Monthly Pro Plan", "items": [ { "priceId": "$PRICE_ID", "quantity": 1 } ], "metadata": { "accountPlan": "pro", "internalSubscriptionId": "sub_123" } } ``` ### Response (Success response details not provided in source) ``` -------------------------------- ### 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. ``` -------------------------------- ### Delete a Subscription Item Source: https://docs.onvopay.com/en/llms.txt Deletes an item from a recurring charge (subscription). Refer to ONVO documentation for integration details and examples. ```APIDOC ## Delete a Subscription Item ### Description Deletes an item from a recurring charge (subscription). Refer to ONVO documentation for integration details and examples. ### Method DELETE (Assumed based on 'Delete' action) ### Endpoint /subscriptions/{subscriptionId}/items/{itemId} (Assumed structure) ### Parameters #### Path Parameters - **subscriptionId** (string) - Required - The ID of the subscription. - **itemId** (string) - Required - The ID of the item to delete from the subscription. ``` -------------------------------- ### Create Checkout Session for Variable Amount Source: https://docs.onvopay.com/en/llms-full.txt Create a Checkout session referencing the price with 'customUnitAmount'. This session will enable the customer to select their payment amount within the defined preset, minimum, and maximum values. Use a single line item with quantity 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 Payment Intent Source: https://docs.onvopay.com/en/payments/sinpe-mobile Use this endpoint to create a payment intent for a specific amount and currency. Ensure the currency is set to 'CRC' for SINPE Movil. ```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": "SINPE Movil payment #1001" }' ```