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
GET /creditor--payments- Lista alla payments (pagerad)GET /creditor--payments/{id}- Hämta en specifik paymentPOST /creditor--payments- Skapa en payment record
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/jsonRequest 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
| Property | Typ | Obligatorisk | Beskrivning |
|---|---|---|---|
account | string | Ja | Account ID |
creditor | string | Ja | Creditor ID |
case | string | Ja | Case ID att registrera betalning för |
currency | string | Ja | Valutakod (för närvarande endast "SEK" stöds) |
amount | number | Ja | Betalningsbelopp |
bank_transaction_date | string | Ja | Datum för banktransaktionen |
creditor_payment_reference | string | Nej | Referens för betalningsspårning |
origin | string | Ja | Ursprung för request (måste vara "creditor_system")* |
Response Properties
| Property | Typ | Obligatorisk | Beskrivning |
|---|---|---|---|
_id | string | Ja | Unik identifierare för payment |
_created | string | Ja | Skapandetidsstämpel |
_updated | string | Ja | Senaste uppdateringstidsstämpel |
_etag | string | Ja | Entity tag för samtidighetskontroll |
_status | string | Ja | Request-status (t.ex. "OK")* |
_payment_status | string | Ja | Payment-processstatus (t.ex. "completed")* |
*) För komplett lista över värden och detaljer, se Creditor Payment
