Handle Failed Payment - PurposeOpen/Platform GitHub Wiki
POST /api/movements/:movement_id/donations/handle_failed_payment(.:format)
Processes the failed payment, sending an error notification email to Administrator and Donor User Email
| Parameters | |
|---|---|
movement_idMandatory |
Movement Identifier related to Donation Payment Error |
action_pageMandatory |
Action Page related to Donation Payment Error |
subscription_idMandatory |
Subscription Identifier (if payment is recurring) related to Donation Payment Error |
error_codeOptional |
Payment Gateway Error Code related to Donation Payment Error |
messageOptional |
Payment Gateway Error Message related to Donation Payment Error |
member_emailOptional |
Donor User Email |
referenceOptional |
Donation External Reference Number |
donation_amount_in_centsOptional |
User Donation amount |
Response
Status Code
200 if Successful
Content
No content is included in response.
Example Request
POST /api/movements/test-movement/donations/handle_failed_payment.json Content-Type: application/x-www-form-urlencoded
action_page=1234&error_code=10780&message=Invalid Credit Card number&member_email=john.doe%40example.com&reference=ef8211e1-9b50-4263-a143-e97c7237a9be&subscription_id=fdfcc2d6-43a0-4946-bd64-c18361ac5cf5&donation_amount_in_cents=10000
Example Response
200 (OK)