Payment.Get

Returns the current state of a payment and its latest cancellation or refund operation.

Input parameters

Name Data type Required Description
payment_id string Conditionally required Local REGOS: VCR payment id from the Payment.Create or Payment.Start response
external_id string Conditionally required External client identifier supplied in Payment.Start

Supply payment_id or external_id. If both are supplied, payment_id is used.

Request example using payment_id

{
    "jsonrpc": "2.0",
    "method": "Payment.Get",
    "params": {
        "payment_id": "58847e73-b40b-4746-8a07-44582991bd6b"
    },
    "auth": "a2Fzc2E6a2FzMTIzNDU2",
    "id": 1
}

Request example using external_id

{
    "jsonrpc": "2.0",
    "method": "Payment.Get",
    "params": {
        "external_id": "ORDER-2026-000123"
    },
    "auth": "a2Fzc2E6a2FzMTIzNDU2",
    "id": 1
}

Output parameters

Name Data type Description
id string Local payment ID in REGOS: VCR
datetime string Payment creation date and time
payment_system_id int32 Payment system ID
payment_id string Payment ID in the external payment system
status int32 Payment status
amount int64 Payment amount in tiyin
receipt_id string Linked REGOS: VCR receipt ID; empty until the receipt is closed
phone string Payer phone number, if available
rrn string Card payment identifier, if available
slip string Terminal SLIP, if available
card_type_id int32 Card type: 0 — not specified, 1 — corporate, 2 — personal, 3 — social
card_number string Masked card number, if available
external_id string For Payment.Start, the external client identifier; in legacy Payment.Create scenarios, retains its original role as a correlation key
invoice_id string QR invoice ID, if applicable
qr_text string QR code text or link, if applicable
provider_status int32 Payment system status, if applicable
fiscal_module string Fiscal module factory number supplied to the payment system, if applicable
receipt_send_status int32 Status of sending the fiscal receipt to the payment system
receipt_send_error string Fiscal receipt transmission error, if any
receipt_sent_at string Fiscal receipt transmission date and time
refund object Latest cancellation or refund operation; omitted if there have been no operations
confirmation object Permitted operator action; omitted if no confirmation is required or the payment is completed
poll_after int32 Recommended delay before the next Payment.Get, in seconds

The confirmation object contains the action type and a required flag. For type = "token", use Payment.Confirm.

Fields of the refund object:

Name Data type Description
refund_id string REGOS: VCR cancellation or refund operation ID
payment_id string Local ID of the original payment
payment_system_id string Machine-readable payment system name
amount int64 Operation amount in tiyin
status int32 1 — created, 2 — in progress, 4 — confirmed by the provider, 5 — awaiting fiscalization, 6 — completed, 8 — error, 9 — result unknown
mode int32 Operation execution mode
provider_refund_id string External payment system operation ID, if available
refund_receipt_id string Refund receipt ID if the operation is linked to a receipt
error string Error description, if any
resolution int32 Outcome of manually resolving an uncertain operation, if applicable
resolved_by string User who resolved the uncertain operation
resolved_at string Manual resolution date and time
created_at string Operation creation date and time
updated_at string Last operation modification date and time

Response example

{
    "jsonrpc": "2.0",
    "result": {
        "id": "58847e73-b40b-4746-8a07-44582991bd6b",
        "datetime": "2026-09-24 15:30:00",
        "payment_system_id": 6,
        "payment_id": "1234567890",
        "status": 3,
        "amount": 90000,
        "receipt_id": "",
        "phone": "998901234567",
        "rrn": "",
        "slip": "",
        "card_type_id": 2,
        "card_number": "8600******8331",
        "external_id": "ORDER-2026-000123"
    },
    "ok": true,
    "id": 1
}