Cost+Docs

Hostitud makseleht (HPP)

Võtke makseid vastu Cost+ hostitud makselehe abil

Hostitud makseleht (HPP) on Cost+ PCI DSS-iga ühilduv maksevorm. See võimaldab teil makseid vastu võtta ilma tundlike kaardiandmetega oma serverites tegelemata. Te loote tellimuse API kaudu, suunate kliendi hostitud lehele ja nad naasevad pärast maksmist teie saidile.

Kuidas see töötab

  1. Teie server loob tellimuse, kutsudes POST /v1/orders/.
  2. API tagastab URL-i, mis viitab hostitud makselehele.
  3. Te suunate kliendi makselehele.
  4. Klient teostab makse Cost+ hostitud lehel.
  5. Klient suunatakse tagasi teie return_url-ile (või failure_url-ile ebaõnnestunud maksete korral).
  6. Cost+ saadab teie webhook_url-ile veebihaagi teavituse tellimuse olekuga.

Hostitud makseleht on täielikult PCI DSS-iga ühilduv. Te ei pea kunagi käsitlema töötlemata kaardinumbreid ega tundlikke makseandmeid oma serverites.

Tellimuse loomine

HPP kasutamiseks on kaks lähenemist:

Lähenemine 1: Kõigi makseviisidekuvamine (lihtsaim)

Looge tellimus ilma transactions määramata. Vastus sisaldab order_url-i — klient suunatakse sinna ja näeb kõiki teie kontol lubatud makseviise:

Päring
{
  "currency": "EUR",
  "amount": 1295,
  "merchant_order_id": "my-order-id-1",
  "description": "My amazing order",
  "return_url": "https://www.example.com",
  "webhook_url": "https://www.example.com/webhook"
}
Vastus
{
  "id": "43114fde-da30-4115-8004-b7f808f9b25c",
  "status": "new",
  "currency": "EUR",
  "amount": 1295,
  "order_url": "https://pay.costplus.online/43114fde.../select-payment-method/",
  "return_url": "https://www.example.com",
  "webhook_url": "https://www.example.com/webhook"
}

Suunake klient order_url-ile. Hostitud lehel kuvatakse kõik lubatud makseviisid.

Lähenemine 2: Makseviisideeelvalimine

Looge tellimus koos transactions massiiviga, et kontrollida, millised makseviisid kuvatakse ja millises järjekorras. Iga tehing sisaldab payment_method-it ja vastus tagastab tehinguobjektis payment_url-i:

Päring
{
  "currency": "EUR",
  "amount": 1295,
  "merchant_order_id": "my-order-id-1",
  "description": "My amazing order",
  "return_url": "https://www.example.com",
  "webhook_url": "https://www.example.com/webhook",
  "transactions": [
    { "payment_method": "credit-card" }
  ]
}
Vastus
{
  "id": "4851e31c-4137-4e91-95ef-1df945ee76a2",
  "status": "new",
  "currency": "EUR",
  "amount": 1295,
  "transactions": [
    {
      "id": "d291f03f-a406-428a-967a-4895a46e03fd",
      "payment_method": "credit-card",
      "status": "new",
      "payment_url": "https://pay.costplus.online/4851e31c.../credit-card/d291f03f.../"
    }
  ]
}

Suunake klient tehingust saadud payment_url-ile.

Kui lisate transactions massiivi ainult ühe kirje, suunatakse klient otse sellele makseviisile ilma valikuekraani nägemata. flags massiiv sisaldab "is-test", kui kasutate liivakasti API võtit.

Päringu väljad

VäliKohustuslikKirjeldus
currencyJahISO 4217 valuutakood (nt EUR, GBP, SEK)
amountJahSumma sentides. Näiteks 12,95 EUR on esitatud kui 1295
merchant_order_idEiTeie enda tellimuse viide-ID
return_urlEiURL, kuhu klient pärast maksmist suunatakse (vaikimisi kõigi olekute jaoks)
failure_urlEiURL, kuhu klient suunatakse olekute cancelled, expired või error korral (vt Tagastus-URL-id allpool)
localeEiMakselehe keel. Toetatud: en-GB, de-DE, nl-NL, nl-BE, fr-BE, sv-SE, no-NO, da-DK
descriptionEiTellimuse kirjeldus, mis kuvatakse kliendile
payment_methodsEiFilter to a single payment method (e.g. ["credit-card"]). Omit to show all enabled methods. For multiple specific methods, use the transactions array instead
webhook_urlEiURL olekumuutuste teavituste saamiseks
expiration_periodEiISO 8601 kestvus tellimuse aegumiseks. Vaikimisi on PT30M (30 minutit)

Väli amount on alati väikseimas valuutaühikus (sendid). 1295 edastamine tähendab 12,95 antud valuutas. 1295.00 või 12.95 edastamine põhjustab vea või vale summa.

Mitu makseviisi

Mitme konkreetse makseviisi pakkumiseks lisage transactions massiivi mitu kirjet. Järjekord hostitud lehel vastab massiivi järjekorrale:

"transactions": [
  { "payment_method": "credit-card" },
  { "payment_method": "apple-pay" }
]

The payment_methods field on orders accepts at most one value. To offer multiple specific methods, always use the transactions array. If you need a reusable link with multiple payment methods, consider Payment Links instead, which support a true payment_methods array.

Tagastus-URL-id

Pärast maksmist suunatakse klient vastavalt tellimuse olekule ja teie esitatud URL-idele:

  • Kui nii return_url kui ka failure_url on määratud:

    • cancelled, expired või error → klient suunatakse failure_url-ile
    • Kõigi muude olekute korral → klient suunatakse return_url-ile
  • Kui ainult return_url on määratud:

    • Kõigi olekute korral → klient suunatakse return_url-ile

Kasutage failure_url-i, et kuvada ebaõnnestunud maksete korral uuesti proovimise või toe lehte, samal ajal kui return_url kuvab tellimuse kinnituse. Kui vajate ainult ühte sihtpunkti, piisab ainult return_url-ist.

Tühistamisnupu käitumine

Hostitud makselehel on tühistamisnupp. Kui klient sellel klõpsab, suunatakse ta failure_url-ile (kui on olemas) või return_url-ile. Tellimuse olek muutub olekusse cancelled. Kontrollige alati tellimuse olekut API või veebihaakide kaudu, mitte ainult ümbersuunamise alusel.

Seotud lõpp-punktid

On this page