# General information

{% docHero lede="Welcome to the 1Payment API documentation." endpoint="https://api.1payment.com" /%}

Before integration, obtain your project **API key** in the merchant dashboard and review the [API request format](/pages/init-request): HTTP method, parameters, `sign` signature, and callback handling.

## Reference

{% docCards %}
{% docCard href="./pages/init-request.md" title="API request format" description="GET, POST, JSON, sign signature, and callback verification." /%}
{% docCard href="./pages/error-codes-api.md" title="Error codes (API)" description="error_code in API responses, including signature errors." /%}
{% docCard href="./pages/decline-error-codes.md" title="Error codes (declines)" description="status_code when the bank or payment system declines." /%}
{% docCard href="./pages/payment-types.md" title="Payment types" description="payment_type values: card, sbp, sberpay, and others." /%}
{% docCard href="./pages/payout-types.md" title="Payout types" description="Payout channels and the payout_type parameter." /%}
{% docCard href="./pages/transaction-statuses.md" title="Transaction statuses" description="SUCCESS, PENDING, FAILURE, and refund codes." /%}
{% docCard href="./pages/balance.md" title="Balance request" description="get_balance method for partner projects." /%}
{% docCard href="./pages/get-rate.md" title="Exchange rate" description="get_rate — conversion rate between project currencies." /%}
{% docCard href="./pages/init-invoice.md" title="Create invoice" description="init_invoice — payment invoice and form link." /%}
{% /docCards %}

## Accepting payments

Choose a channel enabled on your project. Each method in the documentation includes parameters, signature, code examples, and a `sign` verification widget.

### Cards

{% docCards %}
{% docCard href="./pages/card/init-form.md" title="Form payment" description="init_form — redirect the payer to the payment form." /%}
{% docCard href="./pages/card/host2host.md" title="Host2host (GATE)" description="init_payment — card charge without redirect." /%}
{% docCard href="./pages/card/recurring.md" title="Subscriptions" description="Recurring charges by token." /%}
{% docCard href="./pages/card/refund.md" title="Refunds" description="init_refund — full or partial refund." /%}
{% docCard href="./pages/card/status.md" title="Payment status" description="status_payment by order_id or user_data." /%}
{% /docCards %}

### SBP

{% docCards %}
{% docCard href="./pages/sbp/init-form.md" title="Form payment" description="QR code and payment via the bank app." /%}
{% docCard href="./pages/sbp/host2host.md" title="Host2host (GATE)" description="Direct SBP payment initiation." /%}
{% docCard href="./pages/sbp/recurring.md" title="Subscriptions" description="SBP recurring payments." /%}
{% docCard href="./pages/sbp/refund.md" title="Refunds" description="SBP refund processing." /%}
{% docCard href="./pages/sbp/status.md" title="Payment status" description="SBP operation status polling." /%}
{% /docCards %}

### Link payments

{% docCards %}
{% docCard href="./pages/link/init-form.md" title="Form payment" description="Redirect to the payment page via link." /%}
{% docCard href="./pages/link/host2host.md" title="Host2host (GATE)" description="Direct payment initiation (payment_type=link)." /%}
{% docCard href="./pages/link/recurring.md" title="Subscriptions" description="Recurring link payments." /%}
{% docCard href="./pages/link/refund.md" title="Refunds" description="Refund via the link channel." /%}
{% docCard href="./pages/link/status.md" title="Payment status" description="Operation status polling (payment_type=link)." /%}
{% /docCards %}

### ERIP

{% docCards %}
{% docCard href="./pages/erip/init-form.md" title="Form payment" description="QR code and payment via ERIP." /%}
{% docCard href="./pages/erip/host2host.md" title="Host2host (GATE)" description="Direct ERIP payment initiation." /%}
{% docCard href="./pages/erip/recurring.md" title="Subscriptions" description="ERIP recurring payments." /%}
{% docCard href="./pages/erip/refund.md" title="Refunds" description="ERIP refund processing." /%}
{% docCard href="./pages/erip/status.md" title="Payment status" description="ERIP operation status polling." /%}
{% /docCards %}

### SberPay

{% docCards %}
{% docCard href="./pages/sberpay/init-form.md" title="Form payment" description="Redirect to the SberPay flow." /%}
{% docCard href="./pages/sberpay/host2host.md" title="Host2host (GATE)" description="App2App and other flows without a form." /%}
{% docCard href="./pages/sberpay/recurring.md" title="Subscriptions" description="SberPay recurring charges." /%}
{% docCard href="./pages/sberpay/refund.md" title="Refunds" description="SberPay payment refund." /%}
{% docCard href="./pages/sberpay/status.md" title="Payment status" description="Status check via API." /%}
{% /docCards %}

## Payouts

{% docCards %}
{% docCard href="./pages/payouts/card.md" title="Card payout" description="init_payout with payout_type=card." /%}
{% docCard href="./pages/payouts/pix.md" title="PIX" description="init_payout with payout_type=pix, Tax ID / CPF." /%}
{% docCard href="./pages/payouts/sepa.md" title="SEPA" description="init_payout with payout_type=sepa, IBAN and recipient details." /%}
{% docCard href="./pages/payouts/fps.md" title="FPS" description="init_payout with payout_type=fps, account and sort code." /%}
{% docCard href="./pages/payouts/sbp.md" title="SBP" description="init_payout with payout_type=sbp, phone and bank_id." /%}
{% docCard href="./pages/payouts/status.md" title="Payout status" description="status_payout by payout order_id." /%}
{% /docCards %}

## How the documentation is organized

| Section on the method page | Contents |
| --- | --- |
| **How it works** | Business and user scenario |
| **Technical details** | URL, HTTP method, body format |
| **Request parameters** | Required and optional fields |
| **Signature generation** | MD5 formula and verification widget |
| **Request examples** | Node.js, Python, PHP, cURL |
| **Notifications (callbacks)** | POST JSON to your `notify_url` |

Request and callback signatures are described in [API request format](/pages/init-request). Each operation page includes an interactive `sign` verification tool.