Repayments

Create Payment Payload

Endpoint: /accounts/{account_id}/line_items/payments/payment_record

👋

In the Advanced Usage tutorial, you will learn how to set up a Payment Processor Integration, so that payment statuses in Canopy are automatically kept in sync with your payment processor. For now, we’re just focusing on the core workflow of recording payments in the ledger without using an out-of-the-box integration.

json
{
  "line_item_id": "0x1234",
  "original_amount_cents": 50000,
  "line_item_status": "PENDING",
  "effective_at": "2020-07-20T09:11:28+00:00" ---- currently to be used for testing & UAT environment only
}

Update Payment Status

Endpoint: /accounts/{account_id}/line_items/{line_item_id}

json
{ -- note, line_item_id is in the path
  "line_item_status": "VALID" -- or INVALID
}