Pay OUT H2H Integration

(Authorization) Signatures

To authenticate requests securely, Pear2Pay requires signatures included in the pear2pay-signature header. Here's how it works:

1. Generate API Key and Secret:
   • Create an API Key (Terminal) in the Merchant panel.
   • Copy both the API Key and Secret immediately, as they are displayed only once.

2. Signature Verification:
   • A signature is generated by hashing the request body using HMAC with your Secret Key.
   • The client sends the signature in the pear2pay-signature header, and the server verifies it by re-computing and comparing signatures.

How to get signature from secret key:

Signatures

Response:

[
    {
        "id": 20,
        "name": "СБП",
        "icon_url": "",
        "payment_types": [
            "PHONE_NUMBER"
        ],
        "purposes": [
            "SENDER",
            "RECIPIENT"
        ],
        "is_enabled": true,
        "required_fields": {
            "payout_fields": [
                {
                    "label": "Email of the payee",
                    "props": {
                        "type": "email",
                        "required": true
                    },
                    "field_name": "email",
                    "is_required": true
                },
                {
                    "label": "Receiver Name",
                    "props": {
                        "required": false
                    },
                    "field_name": "name",
                    "is_required": false
                },
                {
                    "label": "Payout Card Number",
                    "props": {
                        "required": true
                    },
                    "field_name": "payout_card_number",
                    "is_required": true
                }
            ],
            "invoice_fields": [
                {
                    "label": "Email of the payer",
                    "props": {
                        "type": "email",
                        "required": false # This prop only used for frontend form
                    },
                    "field_name": "email",
                    "is_required": false # If true, this field must be provided when creating an invoice.
                },
                {
                    "label": "Last 4 digits of phone number"
                    "props": {
                        "required": true
                    },
                    "field_name": "last_n_digits",
                    "is_required": true
                }
            ]
        }
    }
]

Response Body Description

Each object in the response represents a bank and contains the following fields:

• id: Unique identifier of the bank.

• name: Name of the bank.

• icon_url: URL of the bank's icon (can be used for displaying on the frontend).

• payment_types: List of supported payment types.

• purposes: List of purposes for which the bank can be used (e.g., SENDER, RECIPIENT).

• is_enabled: Indicates if the bank is currently enabled.

• required_fields: Contains information about additional fields required for payouts and invoices.
  • payout_fields: Fields required for payout operations (not used for invoice creation).
  • invoice_fields: Fields required for invoice creation. Each field includes:
    • label: Field label for display.
    • props: Additional properties (e.g., type, required).
    • field_name: Name of the field to be sent in the request.
    • is_required: If true, this field must be provided when creating an invoice. If false, the field is optional and should not be sent unless filled by the user.

Callback

When the status of invoice is changed, the callback is sent to callback_url

POST callback_url

Payload:

{
  "id": 326,
  "uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "status": "CONFIRMED",
  "amount": 1234.56,
  "currency": "RUB",
  "crypto_amount": 123.4,
  "order_id": "test_order",
  "rate": 100.0000,
  "fee": 0.0600,
  "success_url": "https://example.com/success",
  "fail_url": "https://example.com/fail",
  "is_sum_changed": false,
  "payout_from_crypto": true,
  "card_holder_name": "SOME NAME",
  "payout_card_number": "4174 5566 7788 9911",
  "created_at": "2014-10-16T15:11:52.135372Z",
  "created_by": 58,
  "updated_at": "2015-01-21T06:50:00.025354Z",
  "updated_by": 58,
  "signature": "signature"
}

Possible statuses for invoice:

Payout Possible Statuses

Extra:

Check Payout Status

To check the current status of a payout, use the following API method:

Endpoint:

GET
https://api.pear2pay.com/api/payments/client/get_payout_invoice/:uuid/

URL Parameters:

• uuid: The unique identifier for the payout invoice.

Response:

{
  "created_at": "2025-04-09T08:37:41.828Z",
  "created_by": 0,
  "updated_at": "2025-04-09T08:37:41.828Z",
  "updated_by": 0,
  "id": 0,
  "uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "email": "user@example.com",
  "name": "string",
  "status": "CREATED",
  "payout_card_number": "string",
  "currency": "RUB",
  "amount": "-1234.56",
  "crypto_amount": "-1902811451674344592.906",
  "expires_at": "2025-04-09T08:37:41.828Z",
  "success_url": "string",
  "fail_url": "string",
  "card_holder_name": "string",
  "comment": "string"
}