Report a collected repayment

​

Report a repayment the partner collected for an agreement — settles it against the agreement. Requires partner-managed collections; never report this money in the transaction feed. Applies to the line-backed agreements of draw-facility and feed credit lines.

Path Parameters

  • id
    Type: stringFormat: uuid
    required

Body

required
application/json
  • amount
    Type: integer
    greater than:  
    0
    min:  
    -9007199254740991
    max:  
    9007199254740991
    required

    Integer numbers.

  • currency
    enum
    required
  • externalId
    Type: string
    min length:  
    1
    max length:  
    255
    required

Responses

  • application/json
  • application/json
  • application/json
  • application/json
  • application/json
  • application/json
  • application/json
  • application/json
Request Example for post/financing-agreements/{id}/payments
curl https://api-sandbox.tryslatehq.com/financing-agreements/123e4567-e89b-12d3-a456-426614174000/payments \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: YOUR_SECRET_TOKEN' \
  --data '{
  "amount": -9007199254740991,
  "currency": "CAD",
  "externalId": ""
}'

{
  "financingAgreementId": "123e4567-e89b-12d3-a456-426614174000",
  "paymentId": "123e4567-e89b-12d3-a456-426614174000",
  "customerId": "123e4567-e89b-12d3-a456-426614174000",
  "amount": 10000,
  "currency": "CAD",
  "executedAt": "2025-01-01T00:00:00Z"
}

OK