debt shifts

Propose a debt shift

Ask someone who owes you money to take over your debt to a third party. Nothing is written until they accept.

post/debt-shifts/proposals

Request

  • Base URL: http://localhost:3001
  • URL: http://localhost:3001/debt-shifts/proposals
  • Auth: HTTP bearer

Request body

debtorIdstring required

User who owes the proposer and would take over the debt

creditorIdstring required

User the proposer owes; their claim moves to the debtor

currencystring required

Currency code (e.g., USD)

amountnumber required

Amount to shift, in the precision of the given currency

Response

Proposal created successfully

successboolean
messagestring

Example response

{
  "data": {
    "proposerDisplayName": "Alice",
    "debtorDisplayName": "Bob",
    "creditorDisplayName": "Carol",
    "currency": "USD",
    "amount": 30,
    "targetGroupNames": [
      "Weekend Squad"
    ],
    "status": "pending"
  },
  "success": true,
  "message": "Success"
}

Changes

No recorded changes to this operation across all 1 revision of this API.