YooMoney's Fundraising API

https://yoomoney.ru/docs/payment-buttons
Admin
YooMoney's Fundraising API allows users to create custom forms for fundraising for personal...
Tokens:3,362
Snippets:36
Trust Score:10
Update:1 month ago
Show doc for...
Tokens:
Raw
### Notification body for wallet transfer

Source: https://yoomoney.ru/docs/payment-buttons/using-api/notifications

Example of the POST body received when a transfer is made from a wallet.

```text
{notification_type=p2p-incoming, operation_id=441361714955017004, amount=98.00, withdraw_amount=100.00, currency=643, datetime=2013-12-26T08:28:34Z, sender=41000000000, codepro=false, label=ML23045, unaccepted=false, sha1_hash=ac13833bd6ba9eff1fa9e4bed76f3d6ebb57f6c0, sign=a452af731650e2c5b39abcdc7c28dd27db7b3b654c2230ad2c386e64afb98605}
```

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

### POST https://yoomoney.ru/quickpay/confirm

Source: https://yoomoney.ru/docs/payment-buttons/using-api/forms

Initiates a transfer order by sending form data to the YooMoney service.

```APIDOC
## POST https://yoomoney.ru/quickpay/confirm

### Description
Sends payment details to YooMoney to initiate a transfer to your wallet. This is typically implemented as an HTML form submission.

### Method
POST

### Endpoint
https://yoomoney.ru/quickpay/confirm

### Parameters
#### Request Body
- **receiver** (string) - Required - Number of the YooMoney wallet to credit.
- **quickpay-form** (string) - Required - Form type, fixed value: "button".
- **paymentType** (string) - Required - Payment method: "PC" (YooMoney wallet) or "AC" (bank card).
- **sum** (CurrencyAmount) - Required - Transfer amount to be debited from the sender.
- **label** (string) - Optional - Identifier for the transfer (up to 64 characters).
- **successURL** (string) - Optional - URL to redirect the user after a successful transfer.

### Request Example
<form method="POST" action="https://yoomoney.ru/quickpay/confirm">
    <input type="hidden" name="receiver" value="41001xxxxxxxxxxxx"/>
    <input type="hidden" name="label" value="$order_id"/>
    <input type="hidden" name="quickpay-form" value="button"/>
    <input type="hidden" name="sum" value="4568.25" data-type="number"/>
    <label><input type="radio" name="paymentType" value="PC"/>YooMoney</label>
    <label><input type="radio" name="paymentType" value="AC"/>Bank card</label>
    <input type="submit" value="Transfer"/>
</form>
```

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

### Prepared string for signature decoding

Source: https://yoomoney.ru/docs/payment-buttons/using-api/notifications

The notification parameters formatted as a URL-encoded string for HMAC-SHA256 calculation.

```text
amount=98.00&codepro=false&currency=643&datetime=2013-12-26T08%3A28%3A34Z&label=ML23045&notification_type=p2p-incoming&operation_id=441361714955017004&sender=41000000000&sha1_hash=ac13833bd6ba9eff1fa9e4bed76f3d6ebb57f6c0&unaccepted=false&withdraw_amount=100.00
```

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

### HTTP Notification Format

Source: https://yoomoney.ru/docs/payment-buttons/using-api/notifications

Details on how the YooMoney service sends notifications to your configured server address.

```APIDOC
## POST [Configured Server Address]

### Description
A notification is sent as an HTTP POST request to the address specified in your wallet settings upon receiving a transfer.

### Method
POST

### Parameters
#### Request Body
- **notification_type** (string) - Required - 'p2p-incoming' for transfers from wallets, 'card-incoming' for transfers from bank cards.
- **operation_id** (string) - Required - Operation identifier in your wallet history.
- **amount** (amount) - Required - Amount to be debited to your wallet.
- **withdraw_amount** (amount) - Required - Amount transferred by the sender.
- **currency** (string) - Required - Currency code (always '643').
- **datetime** (datetime) - Required - Date and time of the transfer.
- **sender** (string) - Optional - Sender’s wallet identifier.
- **codepro** (boolean) - Required - Indicates if protected with a security code (always 'false').
- **label** (string) - Optional - Payment label.
- **unaccepted** (boolean) - Required - Indicates if the transfer was put on hold (always 'false').
- **sign** (string) - Required - Signature for verifying integrity and authenticity.
- **sha1_hash** (string) - Optional - Deprecated hash parameter.
```

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

### HTTP Notification Format

Source: https://yoomoney.ru/docs/payment-buttons/using-api/notifications?lang=en

Details on the structure and parameters of the POST request sent by the YooMoney service to your server.

```APIDOC
## POST [Your Server URL]

### Description
Receives a notification upon a successful transfer from a wallet or bank card. The notification is sent as a POST request with form-urlencoded parameters.

### Method
POST

### Parameters
- **notification_type** (string) - Required - 'p2p-incoming' for wallet transfers, 'card-incoming' for bank card transfers.
- **operation_id** (string) - Required - Unique operation identifier.
- **amount** (amount) - Required - Amount credited to the wallet.
- **withdraw_amount** (amount) - Required - Amount sent by the user.
- **currency** (string) - Required - Currency code (643 for RUB).
- **datetime** (datetime) - Required - Date and time of the transfer.
- **sender** (string) - Optional - Sender's wallet identifier.
- **codepro** (boolean) - Required - Always false.
- **label** (string) - Optional - Payment label.
- **unaccepted** (boolean) - Required - Always false.
- **sign** (string) - Required - Signature for verifying integrity and authenticity.
- **sha1_hash** (string) - Optional - Deprecated hash parameter.
```

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

### Request Address

Source: https://yoomoney.ru/docs/payment-buttons/using-api/forms

The endpoint URL for submitting payment form data via POST.

```text
https://yoomoney.ru/quickpay/confirm
```

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

### HTML Payment Form

Source: https://yoomoney.ru/docs/payment-buttons/using-api/forms

A standard HTML form structure for initiating a transfer to a YooMoney wallet.

```html
<form method="POST" action="https://yoomoney.ru/quickpay/confirm">
    <input type="hidden" name="receiver" value="41001xxxxxxxxxxxx"/>
    <input type="hidden" name="label" value="$order_id"/>
    <input type="hidden" name="quickpay-form" value="button"/>
    <input type="hidden" name="sum" value="4568.25" data-type="number"/>
    <label><input type="radio" name="paymentType" value="PC"/>YooMoney</label>
    <label><input type="radio" name="paymentType" value="AC"/>Bank card</label>
    <input type="submit" value="Transfer"/>
</form>
```

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

### Receiving Notifications

Source: https://yoomoney.ru/docs/payment-buttons/using-api/notifications?lang=en

YooMoney sends notifications to your configured server. Your server must respond with an HTTP 200 OK status code to acknowledge receipt.

```APIDOC
## Receiving Notifications

### Description
Your server receives a POST request containing notification parameters. You must respond with HTTP 200 OK to confirm receipt.

### Response
#### Success Response (200)
- **Status** (integer) - HTTP 200 OK
```

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

### Receiving HTTP Notifications

Source: https://yoomoney.ru/docs/payment-buttons/using-api/notifications

YooMoney sends notifications to your server via HTTP. Your server must respond with an HTTP 200 OK status code to acknowledge receipt.

```APIDOC
## Receiving Notifications

### Description
Your server receives a POST request containing notification parameters. You must respond with HTTP 200 OK to confirm receipt.

### Verification
To verify the notification, calculate the HMAC-SHA256 signature using your secret key and the notification parameters (excluding the `sign` parameter), sorted alphabetically and URL-encoded.
```

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

### Verifying Notification Signature

Source: https://yoomoney.ru/docs/payment-buttons/using-api/notifications?lang=en

Verify the authenticity of a notification by calculating an HMAC-SHA256 signature using the provided secret key and comparing it to the 'sign' parameter.

```APIDOC
## Verifying Notification Signature

### Description
To verify the notification, remove the 'sign' parameter, sort the remaining parameters alphabetically, URL-encode the values, and concatenate them into a string. Calculate the HMAC-SHA256 hash of this string using your secret key and compare it to the 'sign' parameter.

### Verification Steps
1. Extract all notification parameters.
2. Remove the 'sign' parameter.
3. Sort remaining parameters alphabetically (A-Z).
4. Apply URL encoding (UTF-8, RFC 3986) to each value.
5. Combine into a string: key1=value1&key2=value2...
6. Calculate HMAC-SHA256 using the secret key and compare with the 'sign' parameter.
```

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

### Calculated HMAC-SHA256 signature

Source: https://yoomoney.ru/docs/payment-buttons/using-api/notifications

The resulting HEX signature generated from the prepared string using the secret key 'secret123'.

```text
a452af731650e2c5b39abcdc7c28dd27db7b3b654c2230ad2c386e64afb98605
```
Tokens:
Raw