Skip to content

Creditor Payment

Registrera betalningar i Amili-systemet. Används när en kund gör en betalning direkt till en Creditor, vilket gör att betalningen kan registreras mot ett Case.

Creditor Payment endpoints

Se Case för att få åtkomst till Cases som kan ta emot betalningar.

Exempel Request

Nedan är ett exempel på att registrera en betalning för ett befintligt Case.

URL: POST /creditor--payments

Headers:

x-api-key: {your_access_token}
Content-Type: application/json

Request Body:

json
{
  "account": "674dbeaf08847b9501cc9132",
  "creditor": "674dbeb208847b9501cc9138",
  "case": "68678eda88b9226bb78d7169",
  "currency": "SEK",
  "amount": 100.0,
  "bank_transaction_date": "Fri, 04 Jul 2025 16:20:41 GMT",
  "creditor_payment_reference": "PAY-REF-001",
  "origin": "creditor_system"
}

Response Code: 201 Created

Response Body:

json
{
  "_updated": "Fri, 04 Jul 2025 14:35:29 GMT",
  "_created": "Fri, 04 Jul 2025 14:35:29 GMT",
  "_etag": "16b58e9a107c62827a5f239b5da8554553133814",
  "_id": "6867e6b174dfc89e006084d1",
  "_status": "OK",
  "_payment_status": "completed"
}

Parametrar

Request Body Properties

PropertyTypObligatoriskBeskrivning
accountstringJaAccount ID
creditorstringJaCreditor ID
casestringJaCase ID att registrera betalning för
currencystringJaValutakod (för närvarande endast "SEK" stöds)
amountnumberJaBetalningsbelopp
bank_transaction_datestringJaDatum för banktransaktionen
creditor_payment_referencestringNejReferens för betalningsspårning
originstringJaUrsprung för request (måste vara "creditor_system")*

Response Properties

PropertyTypObligatoriskBeskrivning
_idstringJaUnik identifierare för payment
_createdstringJaSkapandetidsstämpel
_updatedstringJaSenaste uppdateringstidsstämpel
_etagstringJaEntity tag för samtidighetskontroll
_statusstringJaRequest-status (t.ex. "OK")*
_payment_statusstringJaPayment-processstatus (t.ex. "completed")*

*) För komplett lista över värden och detaljer, se Creditor Payment