Zahlungen

2 endpoints

Les descriptions des endpoints proviennent directement de l'API et sont en allemand.

Zahlungen auflisten

get/v1/payments

Spiegel der Zahlungen bei zahls.ch und Freika.

Paramètres

Nom	Emplacement	Type
`limit`facultatif	Requête	integer
`starting_after`facultatif	Requête	string
`status`facultatif	Requête	string
`provider`facultatif	Requête	"zahls" \| "freika" \| "mock"

Réponse 200PaymentList

Nom	Type	Description
`object`obligatoire	"list"
`data`obligatoire	Payment[]
`has_more`obligatoire	boolean

Erreurs possibles

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

Exemple

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

Réponse 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.

Paramètres

Nom	Emplacement	Type
`id`obligatoire	Chemin	string

Réponse 200Payment

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

Erreurs possibles

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

Exemple

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

Réponse 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"
}