Zahlungen

2 Endpunkte

Zahlungen auflisten

get/v1/payments

Spiegel der Zahlungen bei zahls.ch und Freika.

Parameter

Name	Ort	Typ
`limit`optional	Abfrage	integer
`starting_after`optional	Abfrage	string
`status`optional	Abfrage	string
`provider`optional	Abfrage	"zahls" \| "freika" \| "mock"

Antwort 200PaymentList

Name	Typ	Beschreibung
`object`Pflicht	"list"
`data`Pflicht	Payment[]
`has_more`Pflicht	boolean

Mögliche Fehler

400 Anfrage ungültig
401 Nicht angemeldet
403 Berechtigung fehlt
404 Nicht gefunden
409 Zustand passt nicht
429 Zu viele Anfragen

Beispiel

curl -X GET https://api.ladehase.com/v1/payments \n  -H "Authorization: Bearer lh_test_…"

Antwort 200

{
  "object": "list",
  "data": [
    {
      "id": "pay_8f1e2d3c4b5a6978",
      "object": "payment",
      "livemode": true,
      "session_id": "string",
      "provider": "zahls",
      "purpose": "string",
      "status": "string",
      "currency": "string",
      "amount": 1235,
      "captured_amount": 1235,
      "refunded_amount": 1235,
      "payment_method": "string",
      "card_masked": "string",
      "created_at": "string"
    }
  ],
  "has_more": true
}

Zahlung abrufen

get/v1/payments/{id}

Eine Zahlung.

Parameter

Name	Ort	Typ
`id`Pflicht	Pfad	string

Antwort 200Payment

Name	Typ	Beschreibung
`id`Pflicht	string	ID mit Präfix «pay_»
`object`Pflicht	"payment"
`livemode`Pflicht	boolean
`session_id`Pflicht	string \| null
`provider`Pflicht	"zahls" \| "freika" \| "mock"
`purpose`Pflicht	string
`status`Pflicht	string
`currency`Pflicht	string
`amount`Pflicht	integer	Betrag in Rappen
`captured_amount`Pflicht	integer	Belastet in Rappen
`refunded_amount`Pflicht	integer	Zurückerstattet in Rappen
`payment_method`Pflicht	string \| null
`card_masked`Pflicht	string \| null
`created_at`Pflicht	string

Mögliche Fehler

400 Anfrage ungültig
401 Nicht angemeldet
403 Berechtigung fehlt
404 Nicht gefunden
409 Zustand passt nicht
429 Zu viele Anfragen

Beispiel

curl -X GET https://api.ladehase.com/v1/payments/{id} \n  -H "Authorization: Bearer lh_test_…"

Antwort 200

{
  "id": "pay_8f1e2d3c4b5a6978",
  "object": "payment",
  "livemode": true,
  "session_id": "string",
  "provider": "zahls",
  "purpose": "string",
  "status": "string",
  "currency": "string",
  "amount": 1235,
  "captured_amount": 1235,
  "refunded_amount": 1235,
  "payment_method": "string",
  "card_masked": "string",
  "created_at": "string"
}