rvvup/rvvup-php-openapi

Rvvup Public API

Maintainers

Details

github.com/rvvup/rvvup-php-openapi

Homepage

Source

Issues

Installs: 6 214

Dependents: 1

Suggesters: 0

Security: 0

Stars: 0

Watchers: 0

Forks: 0

Open Issues: 2

pkg:composer/rvvup/rvvup-php-openapi

0.4.0 2025-10-09 17:08 UTC

Requires

Requires (Dev)

MIT eedcb649f10ca4796860430514d594eaac94ad0f

phprestapisdkopenapiopenapitoolsopenapi-generator

This package is auto-updated.

Last update: 2025-10-09 17:09:33 UTC

README

Rvvup Public API

For more information, please visit https://rvvup.com.

Installation & Usage

Requirements

PHP 7.4 and later. Should also work with PHP 8.0.

Composer

To install the bindings via Composer, add the following to composer.json:

{
  "repositories": [
    {
      "type": "vcs",
      "url": "https://github.com/rvvup/rvvup-php-openapi.git"
    }
  ],
  "require": {
    "rvvup/rvvup-php-openapi": "*@dev"
  }
}

Then run composer install

Manual Installation

Download the files and include autoload.php:

<?php
require_once('/path/to/Rvvup/Api/vendor/autoload.php');

Getting Started

Please follow the installation procedure and then run the following:

<?php
require_once(__DIR__ . '/vendor/autoload.php');



// Configure Bearer (JWT) authorization: apiKey
$config = Rvvup\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new Rvvup\Api\AccountStatementsApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$merchant_id = 'merchant_id_example'; // string | Merchant ID
$account_statement_create_input = new \Rvvup\Api\Model\AccountStatementCreateInput(); // \Rvvup\Api\Model\AccountStatementCreateInput | The account statement to create
$idempotency_key = 'idempotency_key_example'; // string | Idempotency Key

try {
    $result = $apiInstance->createAccountStatement($merchant_id, $account_statement_create_input, $idempotency_key);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AccountStatementsApi->createAccountStatement: ', $e->getMessage(), PHP_EOL;
}

API Endpoints

All URIs are relative to http://localhost

Class Method HTTP request Description
AccountStatementsApi createAccountStatement POST /api/2024-03-01/{merchantId}/accounts/statements Create a new account statement
AccountStatementsApi getAccountStatement GET /api/2024-03-01/{merchantId}/accounts/statements/{accountStatementId} Get an account statement
AccountStatementsApi getCheckoutForAccountStatement GET /api/2024-03-01/{merchantId}/accounts/statements/{accountStatementId}/checkouts/{checkoutId} Get a checkout for an account statement
AccountStatementsApi getThemeForAccountStatement GET /api/2024-03-01/{merchantId}/accounts/statements/{accountStatementId}/theme Get the theme for an account statement
ChaserPlansApi createChaserPlan POST /api/2024-03-01/{merchantId}/chaser-plans Create new chaser plan
ChaserPlansApi getChaserPlan GET /api/2024-03-01/{merchantId}/chaser-plans/{chaserPlanId} Get a chaser plan
ChaserPlansApi listChaserPlans GET /api/2024-03-01/{merchantId}/chaser-plans List Chaser Plans
CheckoutTemplatesApi createCheckoutTemplate POST /api/2024-03-01/{merchantId}/checkout-templates Create new checkout template
CheckoutTemplatesApi getCheckoutTemplate GET /api/2024-03-01/{merchantId}/checkout-templates/{checkoutTemplateId} Get a checkout template
CheckoutTemplatesApi listCheckoutTemplates GET /api/2024-03-01/{merchantId}/checkout-templates List checkout templates
CheckoutTemplatesApi updateCheckoutTemplate PATCH /api/2024-03-01/{merchantId}/checkout-templates/{checkoutTemplateId} Update a checkout template
CheckoutsApi createCheckout POST /api/2024-03-01/{merchantId}/checkouts Create new checkout
CheckoutsApi getCheckout GET /api/2024-03-01/{merchantId}/checkouts/{checkoutId} Get a checkout
CheckoutsApi getThemeForCheckout GET /api/2024-03-01/{merchantId}/checkouts/{checkoutId}/theme Get the theme for a checkout
CheckoutsApi listCheckoutPaymentMethods GET /api/2024-03-01/{merchantId}/checkouts/{checkoutId}/payment-methods Get payment methods for a checkout
CheckoutsApi listCheckouts GET /api/2024-03-01/{merchantId}/checkouts List checkouts
ConnectionsApi createConnection PUT /api/2024-03-01/{merchantId}/connections Create a new connection or updates an existing connection.
ConnectionsApi disconnectConnection DELETE /api/2024-03-01/{merchantId}/connections/{connectionId} Disconnect a connection
ConnectionsApi getConnection GET /api/2024-03-01/{merchantId}/connections/{connectionId} Get a connection
ConnectionsApi listConnections GET /api/2024-03-01/{merchantId}/connections List connections
CreditNotesApi applyCreditNote POST /api/2024-03-01/{merchantId}/credit-notes/{creditNoteId}/apply Apply a credit note to an invoice
CreditNotesApi createCreditNote POST /api/2024-03-01/{merchantId}/credit-notes Create new credit note
CreditNotesApi deleteCreditNote DELETE /api/2024-03-01/{merchantId}/credit-notes/{creditNoteId} Delete a credit note
CreditNotesApi downloadCreditNote POST /api/2024-03-01/{merchantId}/credit-notes/{creditNoteId}/download Get a link to download the credit note
CreditNotesApi finalizeCreditNote POST /api/2024-03-01/{merchantId}/credit-notes/{creditNoteId}/finalize Finalize a credit note
CreditNotesApi getCreditNote GET /api/2024-03-01/{merchantId}/credit-notes/{creditNoteId} Get a credit note
CreditNotesApi listCreditNotes GET /api/2024-03-01/{merchantId}/credit-notes List credit notes
CreditNotesApi updateCreditNote PUT /api/2024-03-01/{merchantId}/credit-notes/{creditNoteId} Update a credit note
CreditNotesApi voidCreditNote POST /api/2024-03-01/{merchantId}/credit-notes/{creditNoteId}/void Void a credit note
CustomerAccountsApi createCustomerAccount POST /api/2024-03-01/{merchantId}/customer-accounts Create a customer account
CustomerAccountsApi getCustomerAccount GET /api/2024-03-01/{merchantId}/customer-accounts/{customerAccountId} Get a customer account
CustomerAccountsApi getCustomerAccounts GET /api/2024-03-01/{merchantId}/customer-accounts Get customer accounts
CustomerAccountsApi listInvoicesForCustomerAccount GET /api/2024-03-01/{merchantId}/customer-accounts/{customerAccountId}/invoices Get list of invoices for customer account
InvoicesApi createInvoice POST /api/2024-03-01/{merchantId}/invoices Create new invoice
InvoicesApi createInvoiceNotification POST /api/2024-03-01/{merchantId}/invoices/{invoiceId}/notifications Notify a customer of an invoice
InvoicesApi deleteInvoice DELETE /api/2024-03-01/{merchantId}/invoices/{invoiceId} Delete a draft invoice
InvoicesApi downloadCreditNoteForInvoice GET /api/2024-03-01/{merchantId}/invoices/{invoiceId}/credit-notes/{creditNoteId}/download Get a link to download the credit note
InvoicesApi downloadInvoice GET /api/2024-03-01/{merchantId}/invoices/{invoiceId}/download Get a link to download the invoice
InvoicesApi finalizeInvoice POST /api/2024-03-01/{merchantId}/invoices/{invoiceId}/finalize Finalize an invoice
InvoicesApi getCheckoutForInvoice GET /api/2024-03-01/{merchantId}/invoices/{invoiceId}/checkouts/{checkoutId} Get a checkout for an invoice
InvoicesApi getInvoice GET /api/2024-03-01/{merchantId}/invoices/{invoiceId} Get a invoice
InvoicesApi listCreditNotesForInvoice GET /api/2024-03-01/{merchantId}/invoices/{invoiceId}/credit-notes List credit notes for an invoice
InvoicesApi listInvoiceNotifications GET /api/2024-03-01/{merchantId}/invoices/{invoiceId}/notifications List invoice notifications
InvoicesApi listInvoices GET /api/2024-03-01/{merchantId}/invoices List invoices
InvoicesApi refreshInvoiceUrl POST /api/2024-03-01/{merchantId}/invoices/{invoiceId}/refresh-url Refresh an invoice url
InvoicesApi updateInvoice PUT /api/2024-03-01/{merchantId}/invoices/{invoiceId} Update an invoice
InvoicesApi voidInvoice POST /api/2024-03-01/{merchantId}/invoices/{invoiceId}/void Void an open invoice
MerchantDomainsApi createMerchantDomains POST /api/2024-03-01/{merchantId}/domains Create new merchant domains
MerchantDomainsApi deleteMerchantDomain DELETE /api/2024-03-01/{merchantId}/domains/{merchantDomainId} Delete a merchant domain
MerchantDomainsApi listMerchantDomains GET /api/2024-03-01/{merchantId}/domains List merchant domains
NotificationsApi createNotificationSubscription POST /api/2024-03-01/{merchantId}/notification-subscriptions Create a new notification subscription.
NotificationsApi getNotificationSubscription GET /api/2024-03-01/{merchantId}/notification-subscriptions/{id} Get a notification subscription
NotificationsApi listNotificationSubscriptions GET /api/2024-03-01/{merchantId}/notification-subscriptions List notification subscriptions.
OrdersApi getOrderById GET /api/2024-03-01/{merchantId}/orders/{id} Get order by ID
OrdersApi getOrders GET /api/2024-03-01/{merchantId}/orders Search orders
PaymentLinksApi createPaymentLink POST /api/2024-03-01/{merchantId}/payment-links Create new payment link
PaymentLinksApi deactivatePaymentLink DELETE /api/2024-03-01/{merchantId}/payment-links/{paymentLinkId} Deactivate a payment link
PaymentLinksApi getPaymentLink GET /api/2024-03-01/{merchantId}/payment-links/{paymentLinkId} Get a payment link
PaymentLinksApi listPaymentLinks GET /api/2024-03-01/{merchantId}/payment-links List payment links
PaymentMethodsApi listPaymentMethods GET /api/2024-03-01/{merchantId}/payment-methods Get payment methods
PaymentSessionsApi createPaymentSession POST /api/2024-03-01/{merchantId}/checkouts/{checkoutId}/payment-sessions Create a payment session
PaymentSessionsApi getPaymentSession GET /api/2024-03-01/{merchantId}/checkouts/{checkoutId}/payment-sessions/{paymentSessionId} Get a payment session
PaymentSettingsApi getPaymentSettings POST /api/2024-03-01/{merchantId}/payment-settings Get payment settings for a merchant
PublicApi applyCreditNote POST /api/2024-03-01/{merchantId}/credit-notes/{creditNoteId}/apply Apply a credit note to an invoice
PublicApi createAccountStatement POST /api/2024-03-01/{merchantId}/accounts/statements Create a new account statement
PublicApi createChaserPlan POST /api/2024-03-01/{merchantId}/chaser-plans Create new chaser plan
PublicApi createCheckout POST /api/2024-03-01/{merchantId}/checkouts Create new checkout
PublicApi createCheckoutTemplate POST /api/2024-03-01/{merchantId}/checkout-templates Create new checkout template
PublicApi createConnection PUT /api/2024-03-01/{merchantId}/connections Create a new connection or updates an existing connection.
PublicApi createCreditNote POST /api/2024-03-01/{merchantId}/credit-notes Create new credit note
PublicApi createCustomerAccount POST /api/2024-03-01/{merchantId}/customer-accounts Create a customer account
PublicApi createInvoice POST /api/2024-03-01/{merchantId}/invoices Create new invoice
PublicApi createInvoiceNotification POST /api/2024-03-01/{merchantId}/invoices/{invoiceId}/notifications Notify a customer of an invoice
PublicApi createMerchantDomains POST /api/2024-03-01/{merchantId}/domains Create new merchant domains
PublicApi createNotificationSubscription POST /api/2024-03-01/{merchantId}/notification-subscriptions Create a new notification subscription.
PublicApi createPaymentLink POST /api/2024-03-01/{merchantId}/payment-links Create new payment link
PublicApi createPaymentSession POST /api/2024-03-01/{merchantId}/checkouts/{checkoutId}/payment-sessions Create a payment session
PublicApi createRefund POST /api/2024-03-01/{merchantId}/checkouts/{checkoutId}/payment-sessions/{paymentSessionId}/refunds Create a refund
PublicApi createShipmentTracking POST /api/2024-03-01/{merchantId}/payment-sessions/{paymentSessionId}/shipment-tracking Create a shipment tracking entry for a payment session
PublicApi createShipmentTrackingWithCheckout POST /api/2024-03-01/{merchantId}/checkouts/{checkoutId}/payment-sessions/{paymentSessionId}/shipment-tracking Create a shipment tracking entry for a payment session
PublicApi createTheme POST /api/2024-03-01/{merchantId}/themes Create a new theme
PublicApi createWebhook POST /api/2024-03-01/{merchantId}/webhooks Create a new webhook
PublicApi deactivatePaymentLink DELETE /api/2024-03-01/{merchantId}/payment-links/{paymentLinkId} Deactivate a payment link
PublicApi deleteCreditNote DELETE /api/2024-03-01/{merchantId}/credit-notes/{creditNoteId} Delete a credit note
PublicApi deleteInvoice DELETE /api/2024-03-01/{merchantId}/invoices/{invoiceId} Delete a draft invoice
PublicApi deleteMerchantDomain DELETE /api/2024-03-01/{merchantId}/domains/{merchantDomainId} Delete a merchant domain
PublicApi disconnectConnection DELETE /api/2024-03-01/{merchantId}/connections/{connectionId} Disconnect a connection
PublicApi downloadCreditNote POST /api/2024-03-01/{merchantId}/credit-notes/{creditNoteId}/download Get a link to download the credit note
PublicApi downloadCreditNoteForInvoice GET /api/2024-03-01/{merchantId}/invoices/{invoiceId}/credit-notes/{creditNoteId}/download Get a link to download the credit note
PublicApi downloadInvoice GET /api/2024-03-01/{merchantId}/invoices/{invoiceId}/download Get a link to download the invoice
PublicApi exportStatement POST /api/2024-03-01/{merchantId}/statements/export Export a statement
PublicApi finalizeCreditNote POST /api/2024-03-01/{merchantId}/credit-notes/{creditNoteId}/finalize Finalize a credit note
PublicApi finalizeInvoice POST /api/2024-03-01/{merchantId}/invoices/{invoiceId}/finalize Finalize an invoice
PublicApi getAccountStatement GET /api/2024-03-01/{merchantId}/accounts/statements/{accountStatementId} Get an account statement
PublicApi getChaserPlan GET /api/2024-03-01/{merchantId}/chaser-plans/{chaserPlanId} Get a chaser plan
PublicApi getCheckout GET /api/2024-03-01/{merchantId}/checkouts/{checkoutId} Get a checkout
PublicApi getCheckoutForAccountStatement GET /api/2024-03-01/{merchantId}/accounts/statements/{accountStatementId}/checkouts/{checkoutId} Get a checkout for an account statement
PublicApi getCheckoutForInvoice GET /api/2024-03-01/{merchantId}/invoices/{invoiceId}/checkouts/{checkoutId} Get a checkout for an invoice
PublicApi getCheckoutTemplate GET /api/2024-03-01/{merchantId}/checkout-templates/{checkoutTemplateId} Get a checkout template
PublicApi getConnection GET /api/2024-03-01/{merchantId}/connections/{connectionId} Get a connection
PublicApi getCreditNote GET /api/2024-03-01/{merchantId}/credit-notes/{creditNoteId} Get a credit note
PublicApi getCustomerAccount GET /api/2024-03-01/{merchantId}/customer-accounts/{customerAccountId} Get a customer account
PublicApi getCustomerAccounts GET /api/2024-03-01/{merchantId}/customer-accounts Get customer accounts
PublicApi getInvoice GET /api/2024-03-01/{merchantId}/invoices/{invoiceId} Get a invoice
PublicApi getNotificationSubscription GET /api/2024-03-01/{merchantId}/notification-subscriptions/{id} Get a notification subscription
PublicApi getOrderById GET /api/2024-03-01/{merchantId}/orders/{id} Get order by ID
PublicApi getOrders GET /api/2024-03-01/{merchantId}/orders Search orders
PublicApi getPaymentLink GET /api/2024-03-01/{merchantId}/payment-links/{paymentLinkId} Get a payment link
PublicApi getPaymentSession GET /api/2024-03-01/{merchantId}/checkouts/{checkoutId}/payment-sessions/{paymentSessionId} Get a payment session
PublicApi getPaymentSettings POST /api/2024-03-01/{merchantId}/payment-settings Get payment settings for a merchant
PublicApi getTheme GET /api/2024-03-01/{merchantId}/themes/{themeId} Get a theme
PublicApi getThemeForAccountStatement GET /api/2024-03-01/{merchantId}/accounts/statements/{accountStatementId}/theme Get the theme for an account statement
PublicApi getThemeForCheckout GET /api/2024-03-01/{merchantId}/checkouts/{checkoutId}/theme Get the theme for a checkout
PublicApi getWebhook GET /api/2024-03-01/{merchantId}/webhooks/{webhookId} Get a webhook by id
PublicApi listChaserPlans GET /api/2024-03-01/{merchantId}/chaser-plans List Chaser Plans
PublicApi listCheckoutPaymentMethods GET /api/2024-03-01/{merchantId}/checkouts/{checkoutId}/payment-methods Get payment methods for a checkout
PublicApi listCheckoutTemplates GET /api/2024-03-01/{merchantId}/checkout-templates List checkout templates
PublicApi listCheckouts GET /api/2024-03-01/{merchantId}/checkouts List checkouts
PublicApi listConnections GET /api/2024-03-01/{merchantId}/connections List connections
PublicApi listCreditNotes GET /api/2024-03-01/{merchantId}/credit-notes List credit notes
PublicApi listCreditNotesForInvoice GET /api/2024-03-01/{merchantId}/invoices/{invoiceId}/credit-notes List credit notes for an invoice
PublicApi listInvoiceNotifications GET /api/2024-03-01/{merchantId}/invoices/{invoiceId}/notifications List invoice notifications
PublicApi listInvoices GET /api/2024-03-01/{merchantId}/invoices List invoices
PublicApi listInvoicesForCustomerAccount GET /api/2024-03-01/{merchantId}/customer-accounts/{customerAccountId}/invoices Get list of invoices for customer account
PublicApi listMerchantDomains GET /api/2024-03-01/{merchantId}/domains List merchant domains
PublicApi listNotificationSubscriptions GET /api/2024-03-01/{merchantId}/notification-subscriptions List notification subscriptions.
PublicApi listPaymentLinks GET /api/2024-03-01/{merchantId}/payment-links List payment links
PublicApi listPaymentMethods GET /api/2024-03-01/{merchantId}/payment-methods Get payment methods
PublicApi listThemes GET /api/2024-03-01/{merchantId}/themes List themes
PublicApi listWebhooks GET /api/2024-03-01/{merchantId}/webhooks Get all webhooks
PublicApi refreshInvoiceUrl POST /api/2024-03-01/{merchantId}/invoices/{invoiceId}/refresh-url Refresh an invoice url
PublicApi updateCheckoutTemplate PATCH /api/2024-03-01/{merchantId}/checkout-templates/{checkoutTemplateId} Update a checkout template
PublicApi updateCreditNote PUT /api/2024-03-01/{merchantId}/credit-notes/{creditNoteId} Update a credit note
PublicApi updateInvoice PUT /api/2024-03-01/{merchantId}/invoices/{invoiceId} Update an invoice
PublicApi updateTheme PATCH /api/2024-03-01/{merchantId}/themes/{themeId} Update a theme
PublicApi updateWebhook PATCH /api/2024-03-01/{merchantId}/webhooks/{webhookId} Update a webhook
PublicApi voidCreditNote POST /api/2024-03-01/{merchantId}/credit-notes/{creditNoteId}/void Void a credit note
PublicApi voidInvoice POST /api/2024-03-01/{merchantId}/invoices/{invoiceId}/void Void an open invoice
RefundsApi createRefund POST /api/2024-03-01/{merchantId}/checkouts/{checkoutId}/payment-sessions/{paymentSessionId}/refunds Create a refund
ShipmentTrackingApi createShipmentTracking POST /api/2024-03-01/{merchantId}/payment-sessions/{paymentSessionId}/shipment-tracking Create a shipment tracking entry for a payment session
ShipmentTrackingApi createShipmentTrackingWithCheckout POST /api/2024-03-01/{merchantId}/checkouts/{checkoutId}/payment-sessions/{paymentSessionId}/shipment-tracking Create a shipment tracking entry for a payment session
StatementExportsApi exportStatement POST /api/2024-03-01/{merchantId}/statements/export Export a statement
ThemesApi createTheme POST /api/2024-03-01/{merchantId}/themes Create a new theme
ThemesApi getTheme GET /api/2024-03-01/{merchantId}/themes/{themeId} Get a theme
ThemesApi listThemes GET /api/2024-03-01/{merchantId}/themes List themes
ThemesApi updateTheme PATCH /api/2024-03-01/{merchantId}/themes/{themeId} Update a theme
WebhooksApi createWebhook POST /api/2024-03-01/{merchantId}/webhooks Create a new webhook
WebhooksApi getWebhook GET /api/2024-03-01/{merchantId}/webhooks/{webhookId} Get a webhook by id
WebhooksApi listWebhooks GET /api/2024-03-01/{merchantId}/webhooks Get all webhooks
WebhooksApi updateWebhook PATCH /api/2024-03-01/{merchantId}/webhooks/{webhookId} Update a webhook

Models

Authorization

Authentication schemes defined for the API:

apiKey

  • Type: Bearer authentication (JWT)

Tests

To run the tests, use:

composer install
vendor/bin/phpunit

Author

info@rvvup.com

About this package

This PHP package is automatically generated by the OpenAPI Generator project:

  • API version: 2024-03-01
    • Generator version: 7.10.0
  • Build package: org.openapitools.codegen.languages.PhpClientCodegen