application/json

Body Required

New pledge date parameters

  • pledge_id integer

    Required. Must link to a Pledge that the user can see

    Minimum value is 1.

  • status string

    Required. The status of this specific pledge date P = Planned SC = Scheduled PR = For payment methods that do not require infoodle to take payments e.g. Bank transfers, this has been Processed PD = Paid X = Deleted

    Values are P, X, SC, PD, or PR.

  • The local date that this pledge is to be processed

  • amount number

    The amount of this specific pledge. This can be different to other dates in this pledge

  • Matches the other form_entry_id values in this pledge. Optional and links to an form entry

  • user_id integer

    CORE user_id that this pledge is for

  • If this specific pledge date is paid (status PD) then this is the date it was paid

  • If this is paid then the transaction that has the payment information

  • Whether this has been matched up with a transaction

  • If this is paid with a payment gateway that has fees identified, this is the amount of fees applicable to this transaction

  • If this is paid by a method that infoodle processes e.g. stripe, and the payment for this failed. This is the message

Responses

  • 200 application/json

    Item has been saved successfully

    Hide response attribute Show response attribute object
  • 401 application/json

    Authentication unauthorised

    Hide response attribute Show response attribute object
  • 403 application/json

    Invalid permission

    Hide response attribute Show response attribute object
POST /pledgedate
curl \
 -X POST https://YOURSITE.infoodle.com/apiv2/pledgedate \
 -H "Authorization: Bearer $ACCESS_TOKEN" \
 -H "Content-Type: application/json" \
 -d '{"pledge_id":544,"status":"P","payment_date_local":"2017-07-18","amount":30,"form_entry_id":76,"user_id":569,"paid_date_local":"2024-12-31","transaction_id":435123,"matched_status":"M","gateway_fees":3.45,"bank_response":"Card declined"}'
Request examples
{
  "pledge_id": 544,
  "status": "P",
  "payment_date_local": "2017-07-18",
  "amount": 30,
  "form_entry_id": 76,
  "user_id": 569,
  "paid_date_local": "2024-12-31",
  "transaction_id": 435123,
  "matched_status": "M",
  "gateway_fees": 3.45,
  "bank_response": "Card declined"
}
Response examples (200)
{
  "id": 4325342
}
Response examples (401)
{
  "error": "Unauthorised"
}
Response examples (403)
{
  "error": "Invalid Permission"
}