Sign in

v1

latestOpenAPI 3.0.02026-08-06363576.8 KB
Payment

Create a payment

Create a single payment in Áskell. Requires a secret key. A payment is executed asynchronously which means that you will have to rely on checking the status of the payment after creating it, or rely on webhooks. You can check the status of the payment using the uuid supplied when the payment is initially created.

Initially, the payment will have the state 'pending'. If the payment is successful, the state will be 'settled'. If the payment fails, the state will be 'failed'. If you decide to retry the payment, the payment might have the state 'retrying'.

To summarize, the four states are:

  • pending
  • settled
  • failed
  • retrying
post/payments/

Request body

customer_referencestring required
amountstring required
currencystring required
descriptionstring
referencestring

Example request

{
  "customer_reference": "12345",
  "amount": "100.00",
  "currency": "USD",
  "payment_options": {
    "payment_processor": "claim",
    "claimtemplate": 1,
    "claimrule": 1,
    "payment_date": "2025-11-01",
    "payor_id": "1234567890 (must be a valid Icelandic kennitala)"
  }
}

Response

Successful operation

uuidstring uuid
amountstring
currencystring
descriptionstring
referencestring
state'failed' | 'settled' | 'pending' | 'retrying'
created_atstring date-time
updated_atstring date-time

Example response

{
  "amount": "100.00",
  "currency": "USD",
  "state": "pending",
  "transactions": [
    {
      "amount": "6.99",
      "currency": "USD"
    }
  ]
}