PayIn | Mobile top-up

The payer tops up a mobile subscriber account by phone number.

To get requisites for the Mobile top-up method, send a request (curl example):

curl -X POST https://api.bopay.io/v1/payments \
  -H "Content-Type: application/json" \
  -H "X-Identity: <API-key>" \
  -H "X-Signature: <Signature>" \
  -d '{
  "ext_id": "order_12345",
  "amount": 5000,
  "currency": "RUB",
  "method": "SIM",
  "notify_url": "https://merchant.example/webhook"
}'

POST /v1/payments — headers and signature: Authorization.

Parameters

Field	Type	Required	Description
ext_id	string	yes	Your order ID, unique
amount	number	yes	Amount in RUB
currency	string	yes	RUB. The terminal must work in RUB
method	string	yes	SIM
client_id	string	no	Payer ID on your side
notify_url	string	no	URL for webhooks
notification_token	string	no	Returned in the X-Notification-Token webhook header

The response contains the requisites:

{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "ext_id": "order_12345",
  "amount": 5000,
  "currency": "RUB",
  "status": "PENDING",
  "method": "SIM",
  "requisites": {
    "type": "sim",
    "value": "+79001234567",
    "bank": "МТС",
    "bank_code": "mts"
  },
  "payment_url": "https://pay.bopay.io/invoice?id=550e8400-e29b-41d4-a716-446655440000",
  "valid_until": "2026-01-30T12:30:00Z",
  "created_at": "2026-01-30T12:15:00Z"
}

Response fields

Field	Description
id	Payment ID
requisites.value	Where to pay: subscriber phone number
requisites.bank	Bank
payment_url	Payment page
valid_until	Payment deadline

Show requisites to the payer or redirect them to payment_url. The payer transfers exactly amount.

Other fields and errors — see Create Payment. Status — webhook or GET /v1/payments/{id}.