Kā pieslēgties

Lai pieslēgtu bePaid maksājumu sistēmu, jums būs nepieciešams Store ID, secret key un public key. Kad saņemsiet šos datus, dodieties uz maksājumu sistēmas iestatījumiem MaviBot.

Lai iegūtu Store ID, secret key un public key, sazinieties ar bePaid tehnisko atbalstu.

MaviBot atveriet sadaļu Acquiring, izvēlieties bePaid un ievadiet saņemtos datus.

Piezīme: Pēdējais lauks ir slēdzis, kas izvēlas API galapunktu atkarībā no lietošanas valsts: Baltkrievija vai Krievija.

Kā ģenerēt maksājuma saiti

Lai ģenerētu maksājuma saiti, piešķiriet vērtību mainīgajam payment_sum (piemēram: 150 vai 100.55; izmantojiet punktu kā decimālo atdalītāju).

Kad mainīgais payment_sum ir iestatīts, mainīgais bepaid_pay_url tiek izveidots automātiski. Šo mainīgo varat attēlot kā saiti ziņojumā vai izmantot to pogā ar tekstu "Pay".

Funkcijas parametrs	Apraksts	Papildu informācija
currency	Maksājuma valūta ISO 4217 formātā.	Piemēram: USD
language	Maksājuma lapas valoda. Noklusējums: `en`.	Atļautās vērtības: • `en` — angļu • `es` — spāņu • `tr` — turku • `de` — vācu • `it` — itāļu • `ru` — krievu • `zh` — ķīniešu • `fr` — franču • `da` — dāņu • `sv` — zviedru • `no` — norvēģu • `fi` — somu • `pl` — poļu • `ja` — japāņu • `uk` — ukraiņu • `be` — baltkrievu • `ka` — gruzīnu • `ro` — rumāņu
payment_description	Maksājuma apraksts.	—
link_expired	Maksājuma saites derīguma termiņš. Iestatiet derīguma termiņu formātā `dd.mm.yyyy` (piemēram: `25.06.2025`). Pēc noklusējuma maksājums jāveic 24 stundu laikā.	Varat izmantot arī lauku Assign Variables on Redirect: • `link_expired = current_date + 2` — saite būs derīga 2 dienas līdz 00:00. • Varat norādīt precīzu derīguma termiņa datumu un laiku formātā `dd.mm.yyyy hh:mm` (piemēram: `25.06.2025 12:23`). Var izmantot arī standarta mainīgos. Piemērs saitei, kas derīga 30 minūtes: `python\ntime = current_time + 30\nlink_expired = "#{current_date} #{time}"\n`
russian_host	Indikators veikalam, kas reģistrēts Krievijas bePaid resursdatorā. Iestatiet šo parametru uz `1`, ja jūsu veikals ir reģistrēts bepaid.tech.	Lai pārslēgtos uz Baltkrievijas resursdatoru, iestatiet šo parametru uz `""` (tukša vērtība).
test_payments	Iespējo testa maksājumus. Piešķiriet jebkuru vērtību šim mainīgajam pirms maksājuma saites izveides.	—
bepaid_attempts	Norāda maksājuma mēģinājumu skaitu. Pēc noklusējuma ir atļauts 1 mēģinājums.	—
customer_data	JSON objekts, kas satur maksātāja first_name, last_name un email. Šī informācija ir nepieciešama, lai nosūtītu maksājuma čeku, un to var rediģēt maksājuma lapā.	Parametrs jānorāda kā JSON formāta objekts. Piemērs: `python\ncustomer_data = {\n \"first_name\": \"Sam\",\n \"last_name\": \"Smith\",\n \"email\": \"[email protected]\"\n}\n`
bepaid_contract (nosacīti obligāts)	Maksājuma mērķis maksājumiem ar marķieri.	Atļautās vērtības: • `recurring` — atkārtotiem maksājumiem ar fiksētu grafiku. • `card_on_file` — vienreizējiem vai neregulāriem maksājumiem, piemēram, klienta norēķināšanai pēc pakalpojuma sniegšanas.

Maksājuma saites piemērs:

https://checkout.bepaid.by/widget/hpp.html?token=a05eabd3f9368725efbc175614c7d469da08f198cc51916b07fb75e53f9a3e1a

Pirms vērtības piešķiršanas payment_sum, varat definēt papildu izvēles mainīgos, lai pielāgotu maksājumu.

Pēc noklusējuma maksājuma valūta ir Baltkrievijas rublis (BYN). Ja vēlaties izmantot citu valūtu, piešķiriet vērtību mainīgajam currency.

Pēc maksājuma pabeigšanas klientam tiek pievienots mainīgais bepaid_callback_data. Tas satur maksājumu sistēmas atbildi par pabeigto darījumu.

Nepieciešamās vērtības no šīs vārdnīcas varat iegūt, izmantojot funkciju get().

Kā testēt maksājumus

Lai veiktu testa maksājumu, piešķiriet jebkuru vērtību mainīgajam test_payments pirms mainīgā payment_sum iestatīšanas.

Svarīgi: Pirms bota pārslēgšanas uz tiešraides režīmu noņemiet mainīgo test_payments.

Testa kartes

Kartes numurs	Rezultāts
`4200000000000000`	Veiksmīgs maksājums
`4005550000000019`	Neveiksmīgs maksājums

Maksājuma saites ģenerēšanas piemērs

Šis piemērs ģenerē maksājuma saiti par 100 Baltkrievijas rubļiem (noklusējuma valūta).

Piezīme: Vispirms piešķiriet jebkādus papildu konfigurācijas mainīgos, pēc tam piešķiriet vērtību payment_sum. Šos mainīgos var piešķirt arī agrāk jūsu darbplūsmā — tiem nav jāatrodas vienā blokā.

Visbeidzot, attēlojiet mainīgo `bepaid_pay_url tur, kur nepieciešams. Tas satur ģenerēto maksājuma saiti.

Abonementu pārvaldība

bePaid integrācija ļauj izveidot abonementus jūsu klientiem.

Pirms šīs funkcionalitātes izmantošanas MaviBot, izveidojiet abonementa plānu savā bePaid kontā.

Ja sadaļas Plans un Subscriptions nav pieejamas jūsu kontā, sazinieties ar sava konta pārvaldnieku.

Abonementa izveide un maksājuma saites ģenerēšana

Izmantojiet funkciju get_bepaid_subscription_url un nododiet parametru plan_id.

Funkcija izveido abonementu un atgriež maksājuma saiti.

Nosūtiet ģenerēto saiti klientam un gaidiet, kamēr maksājums tiks pabeigts.

Pēc veiksmīga maksājuma:

abonements tiek aktivizēts;
darījumam tiek pievienoti mainīgie:
- bepaid_subscription_id;
- bepaid_subscription_status;
botam tiek nosūtīts atzvans (skatīt Kā apstrādāt rezultātu).

Abonementa informācijas iegūšana

Lai iegūtu pašreizējo abonementa informāciju, izmantojiet funkciju get_bepaid_subscription_info.

Nododiet parametru subscription_id. Tā vērtību var ņemt no mainīgā bepaid_subscription_id.

Abonementa atcelšana

Lai atceltu abonementu, izmantojiet funkciju cancel_bepaid_subscription.

Funkcija pieņem vienu parametru:

subscription_id — vērtību var ņemt no mainīgā bepaid_subscription_id.

Pēc veiksmīgas atcelšanas:

mainīgais bepaid_subscription_status tiek iestatīts uz "canceled";
botam tiek nosūtīts atzvans (skatīt Kā apstrādāt rezultātu).

Abonementa statusi

Statuss	Apraksts
trial	Aktīvs vai atcelts izmēģinājuma perioda abonements.
active	Aktīvs abonements ar savlaicīgi veiktu maksājumu.
failed	Neveiksmīgs abonements. bePaid nevarēja apstrādāt nākamo maksājumu.
error	Radās kļūda, bePaid mēģinot apstrādāt maksājumu.
canceled	Abonements ir atcelts un vairs nav aktīvs.

Atkārtotie maksājumi

Varat arī iestatīt atkārtotos maksājumus, neveidojot abonementa plānu savā bePaid kontā.

Lai to izdarītu, jums ir nepieciešams klienta kartes marķieris.

Kartes marķiera iegūšana

Lai iegūtu klienta kartes marķieri, klientam ir jāveic sākotnējais maksājums, izmantojot maksājuma saiti, kas ģenerēta ar mainīgo payment_sum.

Pirms vērtības piešķiršanas payment_sum, iestatiet mainīgo bepaid_contract, lai definētu nākotnes maksājumu ar marķieri mērķi.

Atbalstītās vērtības:

recurring — atkārtotiem maksājumiem ar iepriekš noteiktu grafiku.
card_on_file — vienreizējiem vai neregulāriem maksājumiem, piemēram, klienta norēķināšanai pēc pakalpojuma sniegšanas.

Piezīme: Opciju card_on_file neatbalsta visas iegūstošās bankas. Sazinieties ar sava konta pārvaldnieku, ja plānojat izmantot šo opciju.

Pēc veiksmīga maksājuma darījumam tiek pievienots mainīgais bepaid_client_card_token. Tas glabā klienta kartes marķieri, ko var izmantot turpmākiem maksājumiem bez klienta iesaistes.

Pēc tam konfigurējiet savu darbplūsmu, definējiet nepieciešamo datumu vai nosacījumu klienta norēķināšanai un izsauciet funkciju make_bepaid_token_payment.

Parametri jānorāda šādā secībā:

amount → currency → description → contract

Parametru apraksti

Parametra contract vērtībai precīzi jāatbilst vērtībai, kas norādīta, ģenerējot sākotnējo maksājuma saiti.

Parametrs	Apraksts
amount (obligāts)	Maksājuma summa. Vērtībai jābūt veselam vai decimālam skaitlim, piemēram: `100` vai `100.5`.
currency (obligāts)	Maksājuma valūta ISO 4217 formātā, piemēram: `USD`.
description (obligāts)	Maksājuma apraksts, piemēram: `"Weekly subscription payment for participation in the hobby club"`.
contract (obligāts)	Maksājuma mērķis pēc marķiera. Atļautās vērtības: `recurring` vai `card_on_file`.

Ja maksājums ir veiksmīgs:

funkcija atgriež ziņojumu "Successful charge via bePaid token";
bots saņem veiksmīga maksājuma atzvanu;
mainīgais bepaid_token_payment_completed tiek iestatīts uz True.

Ja maksājums neizdodas:

funkcija atgriež ziņojumu, kas apraksta neveiksmes iemeslu;
bots saņem atzvanu ar sufiksu _fail;
mainīgais bepaid_token_payment_completed tiek iestatīts uz False.

Ja bankai nepieciešama papildu klienta verifikācija, funkcija atgriež saiti, kurā klients var pabeigt 3-D Secure autentifikāciju.

Kā apstrādāt rezultātu

Reaģējot uz klienta darbībām, bots saņem atzvanus, kas sastāv no pirmajām 20 rakstzīmēm no slepenās atslēgas, kam seko sufikss, kas norāda darbības veidu un rezultātu.

Atzvans sistēmā parādās kā lietotāja ziņojums, bet tas nav redzams klientam.

Maksājuma atzvani

Vienreizējiem maksājumiem bots saņem vienu no šiem atzvanu:

keyNumber_success — veiksmīgs maksājums.
keyNumber_fail — neveiksmīgs maksājums.

Varat arī izsekot maksājuma rezultātam, izmantojot šādus mainīgos:

bepaid_payment_completed — maksājums pabeigts klienta veikts.
bepaid_token_payment_completed — automātisks maksājums pabeigts, izmantojot klienta kartes marķieri.

Abonementa atzvani

Pēc abonementa veiksmīgas aktivizēšanas, vai nu sākotnējā maksājuma, vai atkārtota maksājuma laikā, bots saņem:

keyNumber_success

Ja abonements tiek atcelts, bots saņem:

keyNumber_canceled

Ja abonementa maksājums neizdodas, bots saņem:

keyNumber_fail

Bepaid