Creditor Payment

Register payments in the Amili system. Used when a customer makes a payment directly to a creditor, allowing the payment to be recorded against a case.

Creditor Payment endpoints

• GET /creditor--payments - List all payments (paginated)
• GET /creditor--payments/{id} - Get a specific payment
• POST /creditor--payments - Create a payment record

See Case for accessing the cases that can receive payments.

Example Request

Below is an example of registering a payment for an existing case.

URL: POST /creditor--payments

Headers:

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

Request Body:

{
  "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:

{
  "_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"
}

Parameters

Request Body Properties

Property	Type	Required	Description
account	string	Yes	Account ID
creditor	string	Yes	Creditor ID
case	string	Yes	Case ID to register payment for
currency	string	Yes	Currency code (currently only "SEK" supported)
amount	number	Yes	Payment amount
bank_transaction_date	string	Yes	Date of the bank transaction
creditor_payment_reference	string	No	Reference for payment tracking
origin	string	Yes	Origin of request (must be "creditor_system")*

Response Properties

Property	Type	Required	Description
_id	string	Yes	Unique identifier for the payment
_created	string	Yes	Creation timestamp
_updated	string	Yes	Last update timestamp
_etag	string	Yes	Entity tag for concurrency control
_status	string	Yes	Request status (e.g. "OK")*
_payment_status	string	Yes	Payment process status (e.g. "completed")*

*) For complete list of values and details, please see Creditor Payment