Zahlungen

2 endpoint

Le descrizioni degli endpoint provengono direttamente dall'API e sono in tedesco.

Zahlungen auflisten

get/v1/payments

Spiegel der Zahlungen bei zahls.ch und Freika.

Parametri

Nome	Posizione	Tipo
`limit`facoltativo	Query	integer
`starting_after`facoltativo	Query	string
`status`facoltativo	Query	string
`provider`facoltativo	Query	"zahls" \| "freika" \| "mock"

Risposta 200PaymentList

Nome	Tipo	Descrizione
`object`obbligatorio	"list"
`data`obbligatorio	Payment[]
`has_more`obbligatorio	boolean

Errori possibili

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

Esempio

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

Risposta 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.

Parametri

Nome	Posizione	Tipo
`id`obbligatorio	Percorso	string

Risposta 200Payment

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

Errori possibili

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

Esempio

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

Risposta 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"
}