Stakar greiðslur (e. Payments)

Stakar greiðslur er hægt að framkvæma ef viðskiptavinur hefur verið skráður með gildan greiðslumáta. Einnig þarf að vera til staðar sjálfgefinn færsluhirðir fyrir Áskels aðganginn þinn. Hafðu samband við okkur til þess að ganga úr skugga um að það sé í lagi áður en þú byrjar.

Eins og flestar aðrar aðgerðir í vefþjónustu Áskels krefst þessi aðgerð leynilega API lykilsins (e. Private API key).

Stöður á greiðslum

Stakar greiðslur geta haft fjórar stöður.

Auðkenni stöðu	Lýsing
`pending`	Greiðsla hefur verið stofnuð og verður skuldfærð strax
`settled`	Skuldfærsla tókst
`failed`	Skuldfærsla tókst ekki og má reyna aftur allt að 4 sinnum
`retrying`	Skuldfærsla verður reynd aftur eins fljótt og auðið er

Ferlið

Öll köll í vefþjónustur má prófa í Swagger skjölun okkar sem finna má hér

Greiðsla er stofnuð á viðskiptavin með upplýsingar um gjaldmiðil og upphæð. Valkvæmt er að láta fylgja með lýsingu og tilvísun úr þínu viðskiptakerfi.

python

API_KEY = 'your api key here'
headers = {
    "Authorization": f"Api-Key {API_KEY}"
}

data = {
    "customer_reference": "customer-12345",
    "amount": "1",
    "currency": "ISK",
    "description": "My description", # Optional description
    "reference": "customer-12345", # Optional reference
}

response = requests.post("https://askell.is/api/payments/", data=data, headers=headers)

Svarið lítur svona út:

{
    "uuid": "a19ca264-5dd4-4897-bcb8-47d84844a2bc",
    "amount": "1.0000",
    "currency": "ISK",
    "description": "My description",
    "reference": "customer-12345",
    "state": "pending",
    "created_at": "2021-10-15T10:02:25.663806Z",
    "updated_at": "2021-10-15T10:02:25.663824Z",
    "transactions": [
        {
        "external_reference": null,
        "data": {},
        "state": "initial",
        "uuid": "951913b0-3b99-4c6c-a58c-3b8e7c18b488",
        "fail_code": null,
        "refund_code": null,
        "cancel_code": null,
        "amount": "1.00",
        "currency": "ISK"
        }
    ]
}

Það þarf að fylgjast með stöðu greiðslunnar í gegnum vefkróka (e. webhooks). Þegar greiðslan breytir um stöðu sendum við viðburðinn payment.changed. Hér má líta dæmi um færslu sem hefur farið í gegn og má teljast greidd.

Sjá nánar undir Vefkrókar

{
    "event": "payment.changed",
    "sender": "admin",
    "data": {
        "uuid": "a19ca264-5dd4-4897-bcb8-47d84844a2bc",
        "amount": "1.0000",
        "currency": "ISK",
        "description": "My description",
        "reference": "customer-12345",
        "state": "settled",
        "created_at": "2021-10-15T10:02:25.663806Z",
        "updated_at": "2021-10-15T10:02:25.663824Z",
        "transactions": [
            {
                "external_reference": "2286047",
                "data": {
                "id": "2286047",
                "receipt": {
                        "BuidAdOgilda": false,
                        "Bunkanumer": "B0003049",
                        "Dagsetning": "14.10.2021",
                        "F22_1til4": "1005",
                        "Faersluhirdir": "VALITOR, sími: 525 2000",
                        "Faerslunumer": "2286047",
                        "FaerslunumerUpphafleguFaerslu": null,
                        "Heimildarnumer": "277031",
                        "Hugbunadarnumer": "11101040000",
                        "Kortnumer": "****-****-****-2779",
                        "LinaC1": "060",
                        "LinaC2": "1509",
                        "LinaC3": "FÆRSLUNR: 128715286045",
                        "LinaC4": "HEIMILD:277031",
                        "LinaD1": "12",
                        "LinaD2": null,
                        "PinSkilabod": null,
                        "PosiID": "0225",
                        "Soluadilinumer": "S0053128",
                        "StadsetningNumer": "0001",
                        "TegundAdgerd": "SALA",
                        "TegundKorts": "Mastercard",
                        "TegundKortsKodi": "500",
                        "TerminalID": "11100126",
                        "Timi": "15:36",
                        "Upphaed": "1",
                        "UtstodNumer": "0001",
                        "VerslunHeimilisfang": null,
                        "VerslunNafn": "Fyrirtækjagreiðslur TEST",
                        "VerslunStadur": "Reykjavík",
                        "Vidskiptaskilabod": "VIÐSKIPTI ISK: 1"
                    },
                    "status": "settled"
                },
                "state": "settled",
                "uuid": "3c03b82a-951a-4331-b651-550de9da9004",
                "fail_code": null,
                "refund_code": null,
                "cancel_code": null,
                "amount": "1.00",
                "currency": "ISK"
            },
        ]
    }
}

Sú staða getur komið upp að færsla fari ekki í gegn af einhverjum ástæðum og fái því stöðuna failed. Í þeim tilfellum má reyna að skuldfæra sömu greiðslu aftur með retry vefþjónustunni. Það er hægt að reyna aftur allt að fjórum sinnum.

python

API_KEY = 'your api key here'
headers = {
    "Authorization": f"Api-Key {API_KEY}"
}

uuid = "a19ca264-5dd4-4897-bcb8-47d84844a2bc"

response = requests.post(f"https://askell.is/api/payments/{uuid}/retry/", data={}, headers=headers)