Amend Payment | Papertracc Docs

{
  "data": {
    "id": "59ad58e5-1571-4ce5-a140-6e7e33beb47c",
    "type": "BILL_PAYMENT",
    "amount": "250000.00",
    "status": "POSTED",
    "vendor": {
      "id": "0cb2d1a5-2f50-43a1-8c3f-df06f998ef51",
      "display_name": "Global Softworks"
    },
    "documents": [],
    "vendor_id": "0cb2d1a5-2f50-43a1-8c3f-df06f998ef51",
    "account_id": "d037d299-3029-4dc7-8e72-172f80f23c4f",
    "created_at": "2026-06-18T10:00:00Z",
    "project_id": "spruce-demo",
    "allocations": [
      {
        "id": "5c998a23-a6fc-4c2e-8e22-7f90ad81ce0a",
        "amount": "250000.00",
        "bill_id": "45c6e26d-e132-4548-8e2e-5bfc467cf94a",
        "payment_id": "59ad58e5-1571-4ce5-a140-6e7e33beb47c",
        "bill_reference": "BILL-0001",
        "wht_tax_id": null,
        "wht_rate": "0.00",
        "wht_base": "0.00",
        "wht_amount": "0.00",
        "discount_amount": "0.00"
      }
    ],
    "payment_date": "2026-06-18T10:00:00Z",
    "currency_code": "NGN",
    "exchange_rate": "1.00",
    "journal_status": "POSTED",
    "payment_method": "BANK_TRANSFER",
    "journal_entry_id": "JE-0003",
    "payment_reference": "PAY-0001",
    "destination_account": {
      "bank": "Spruce Bank",
      "account_number": "1234567890"
    }
  },
  "status": true,
  "message": "Successfully amended payment"
}

Moves a payment into amendment flow.

Requires the can_amend_payment permission on the key owner’s role.

Keys: secret key only.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

identitystring

The identity for the active workspace.

Path parameters

idstringRequired

Request

This endpoint expects an object.

reasonstringOptional

Response

dataobject

statusboolean

messagestring

Errors

401

Unauthorized Error

402

Payment Required Error

403

Forbidden Error