Record a loan event

Records one loan event. A key with entries:write posts at once; a person’s request goes to approval. A write-off always goes to approval, and only a person can approve it.

The answer has entry when it posted, or approval when it went to a second person. reason of at least 10 characters is required for a WRITE_OFF.

Scope: entries:write.

POST /v1/loan-events

Record a loan event

cURL

curl --request POST \
  --url https://api.panoqore.example/v1/loan-events \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'Idempotency-Key: <idempotency-key>' \
  --data '
{
  "currency": "NGN"
}
'

200

{
  "entry": {
    "id": "<string>",
    "status": "PENDING",
    "kind": "<string>",
    "description": "<string>",
    "effectiveAt": "2023-11-07T05:31:56Z",
    "businessDate": "<string>",
    "externalRef": "<string>",
    "reversesId": "<string>",
    "reversedById": "<string>",
    "fxRateId": "<string>",
    "holdId": "<string>",
    "postings": [
      {
        "id": "<string>",
        "entryId": "<string>",
        "accountId": "<string>",
        "side": "DEBIT",
        "amount": "<string>",
        "currency": "<string>",
        "seq": 123,
        "accountName": "<string>",
        "accountCode": "<string>",
        "balanceAfter": "<string>",
        "createdAt": "2023-11-07T05:31:56Z"
      }
    ],
    "metadata": {},
    "createdBy": {
      "kind": "PERSON",
      "id": "<string>",
      "displayName": "<string>"
    },
    "approvedBy": {
      "kind": "PERSON",
      "id": "<string>",
      "displayName": "<string>"
    },
    "latePosting": true,
    "postedAt": "2023-11-07T05:31:56Z",
    "createdAt": "2023-11-07T05:31:56Z",
    "statusNote": "<string>"
  },
  "approval": {
    "approvalId": "<string>",
    "applied": true
  }
}

Authorizations

Authorization · string · header · required

An API key, pk_live_… or pk_test_….

Headers

Idempotency-Key · string · required

Your unique key for this write, at most 255 characters. A retry with the same key and body gets the first answer back.

Maximum string length: 255

Body

application/json

kind · enum<string> · required

DISBURSE: loan up, customer's account or disbursement clearing up

ACCRUE_INTEREST: interest receivable up, interest income up

CHARGE_PENALTY: interest receivable up, penalty income up

REPAY: from an account: amount off principal, interest_amount off receivable

RECOVER: money in on a loan already written off

PROVISION: impairment charge, allowance up at stage

RELEASE_PROVISION: allowance down at stage, charge back

MOVE_STAGE: allowance moves from stage to to_stage

WRITE_OFF: everything owed comes off; amount is what the allowance at stage absorbs

Available options: DISBURSE, ACCRUE_INTEREST, CHARGE_PENALTY, REPAY, RECOVER, PROVISION, RELEASE_PROVISION, MOVE_STAGE, WRITE_OFF

currency · string · required

Example:

"NGN"

loanRef · string

every kind but PROVISION, RELEASE_PROVISION and MOVE_STAGE

Example:

"LN-1042"

amount · string

minor units

Pattern: ^[0-9]+$

Example:

"500000"

interestAmount · string

REPAY only Minor units, as a string.

Pattern: ^[0-9]+$

accountId · string

DISBURSE: where the money goes, disbursement clearing if empty. REPAY and RECOVER: where it comes from.

stage · integer<int32>

1 to 3

toStage · integer<int32>

MOVE_STAGE only

externalRef · string

Example:

"order-1042"

reason · string

why; required when the event goes to approval

Example:

"Customer unreachable for 180 days"

effectiveAt · string<date-time>

when posted at once; an approved event posts when approved

Response

200

application/json

OK

entry · object

posted

Show child attributes

approval · object

waiting for a second person

Show child attributes