API Reference Overview

Start here to choose between ICREDIT and Rivhit API reference sections and understand test-environment URLs.

Use this page to choose the right API reference group before opening an endpoint.

The API reference is split into two main sections: ICREDIT for payments and payment-page flows, and Rivhit for business-management actions such as documents, receipts, customers, items, and reports.

Important: Test environment URLs

Most methods show the test environment URL

Before going live, check each endpoint URL. For production, remove test from the URL when the endpoint uses a test domain.

Choose a reference section

ICREDIT APIs

Use these endpoints for payment pages, direct payments, token payments, 3DS, recurring sales, pending sales, refunds, and IPN verification.

Rivhit APIs

Use these endpoints for documents, receipts, customers, items, inventory, accounting, reports, projects, and storage actions.

Common starting points

Get a payment page URL

Create a payment page URL with the GetUrl method.

Charge a card directly

Charge a credit card or token with a short payment response.

Create a document

Create invoices, shipping lists, orders, and other business documents.

Create a receipt

Create a new receipt with customer and payment details.

Before you call an endpoint

1. Confirm whether you need an ICREDIT payment endpoint or a Rivhit business-management endpoint.
2. Check whether the reference URL points to the test environment before moving to production.
3. Use the required identifiers for the method, such as API tokens, payment page identifiers, sale identifiers, or customer identifiers.
4. Review the response examples so you know what a successful response and an error response look like.