Maksājuma saites

Maksājuma saites ir atkārtoti lietojami URL, kas ļauj klientiem samaksāt par pasūtījumu. Atšķirībā no standarta pasūtījumiem, kuru derīguma termiņš beidzas pēc viena neveiksmīga mēģinājuma, maksājuma saites atbalsta vairākus atkārtotus mēģinājumus, padarot tās ideālas rēķiniem, e-pasta maksājumiem un scenārijiem, kad klients var nemaksāt uzreiz.

Galvenās funkcijas

Atkārtoti lietojamas: Klienti var mēģināt maksāt līdz 25 reizēm, ja iepriekšējie mēģinājumi neizdodas.
Ilgstoši derīgas: Noklusējuma derīguma termiņš ir 30 dienas (konfigurējams ar expiration_period).
Kopīgojamas: Nosūtiet saiti pa e-pastu, SMS, tērzēšanā vai ieguliet savā tīmekļa vietnē.

Maksājuma saites izveide

Nosūtiet POST pieprasījumu uz /v1/paymentlinks/:

POST /v1/paymentlinks/

curl -X POST https://api.costplus.online/v1/paymentlinks/ \
  -u YOUR_API_KEY: \
  -H "Content-Type: application/json" \
  -d '{
    "merchant_order_id": "invoice-1234",
    "amount": 995,
    "currency": "EUR",
    "description": "Invoice #1234"
  }'

Atbilde ietver payment_url, ko kopīgot ar klientu, un unikālu id izsekošanai:

Response (201 Created)

{
  "id": "e6eecc6a-47c5-4948-bcc0-d8b73f5c55a1",
  "merchant_order_id": "invoice-1234",
  "amount": 995,
  "currency": "EUR",
  "description": "Invoice #1234",
  "expiration_period": "P30D",
  "payment_url": "https://pay.costplus.online/paymentlinks/e6eecc6a.../",
  "status": "new",
  "reason": "Payment Link was created, not yet visited",
  "orders": {},
  "created": "2026-01-15T12:00:00.000000Z"
}

Saglabājiet id — to izmantosiet, lai vēlāk pārbaudītu maksājuma saites statusu.

Obligātie lauki

Lauks	Apraksts
`merchant_order_id`	Jūsu pašu atsauces ID maksājuma saitei
`amount`	Summa centos (piemēram, 9,95 EUR = `995`)
`currency`	ISO 4217 valūtas kods (piemēram, `EUR`, `GBP`)

Neobligātie lauki

Lauks	Apraksts
`description`	Apraksts, kas tiek parādīts klientam
`expiration_period`	ISO 8601 ilgums. Noklusējums ir `P30D` (30 dienas)
`return_url`	URL, uz kuru novirzīt klientu pēc veiksmīga maksājuma
`failure_url`	URL, uz kuru novirzīt klientu atcelšanas, termiņa beigšanās vai kļūdas gadījumā
`webhook_url`	URL statusa izmaiņu paziņojumu saņemšanai
`customer`	Klienta informācijas objekts (vārds, e-pasts utt.)

Ja norādāt gan return_url, gan failure_url, klienti tiek novirzīti uz failure_url, kad pasūtījuma statuss ir cancelled, expired vai error. Pretējā gadījumā visas novirzīšanas iet uz return_url.

Maksājuma saites iegūšana

Nosūtiet GET pieprasījumu uz /v1/paymentlinks/{id}/, izmantojot maksājuma saites id no izveides atbildes:

GET /v1/paymentlinks/{id}/

curl -u YOUR_API_KEY: \
  https://api.costplus.online/v1/paymentlinks/e6eecc6a-47c5-4948-bcc0-d8b73f5c55a1/

Atbilde ietver pašreizējo statusu un atsauces uz visiem pasūtījumiem, kas izveidoti no saites, grupēti pēc to statusa:

Response (completed example)

{
  "id": "e6eecc6a-47c5-4948-bcc0-d8b73f5c55a1",
  "merchant_order_id": "invoice-1234",
  "amount": 995,
  "currency": "EUR",
  "description": "Invoice #1234",
  "expiration_period": "P30D",
  "payment_url": "https://pay.costplus.online/paymentlinks/e6eecc6a.../",
  "status": "completed",
  "reason": "Completed",
  "completed": "2026-01-15T12:05:30.123456+00:00",
  "completed_order_id": "3bb663cc-2a20-400d-8bf6-18d9695d0c66",
  "orders": {
    "error": ["0d79014c-0aaa-4fd6-87c5-c8cfa5f5ac69"],
    "completed": ["3bb663cc-2a20-400d-8bf6-18d9695d0c66"]
  }
}

Šajā piemērā klients veica vienu neveiksmīgu mēģinājumu (pasūtījums 0d79014c... ar statusu error) pirms sekmīga (pasūtījums 3bb663cc... ar statusu completed). Jūs varat iegūt pilnu informāciju par jebkuru pasūtījumu, izmantojot GET /v1/orders/{order_id}/.

Maksājuma saišu statusi

Statuss	Apraksts
`new`	Saite ir izveidota, bet nav veikts neviens maksājuma mēģinājums.
`processing`	Pašlaik notiek maksājuma mēģinājums.
`all_unsuccessful`	Visi līdzšinējie maksājuma mēģinājumi ir neveiksmīgi. Klients joprojām var mēģināt vēlreiz (līdz 25 mēģinājumiem).
`completed`	Maksājums bija veiksmīgs. Saite vairs nav aktīva.
`expired`	Saites derīguma termiņš beidzās pirms veiksmīga maksājuma.

Statuss all_unsuccessful nav galīgs statuss. Klients joprojām var mēģināt maksāt vēlreiz, līdz maksājums izdodas, tiek sasniegts maksimālais mēģinājumu skaits (25) vai saites termiņš beidzas.

Kad maksājuma saite sasniedz statusu completed vai expired, to vairs nevar izmantot. Izveidojiet jaunu maksājuma saiti, ja klientam jāmaksā vēlreiz.

Darbplūsmas piemērs

Izveidojiet maksājuma saiti, izmantojot POST /v1/paymentlinks/.
Kopīgojiet atgriezto payment_url ar savu klientu (piemēram, pa e-pastu, SMS vai rēķinā).
Klients atver saiti un pabeidz maksājumu.
Cost+ nosūta webhook uz jūsu webhook_url, kad mainās statuss.
Verificējiet maksājuma saites statusu, izmantojot GET /v1/paymentlinks/{id}/.
Izpildiet pasūtījumu, kad statuss ir completed.

Saistītie galapunkti

Izveidot maksājuma saiti — izveidot atkārtoti lietojamu maksājuma saiti
Iegūt maksājuma saiti — iegūt pašreizējo maksājuma saites statusu

On this page