Void

post
Authorizations
Path parameters
idstring · uuidRequired

A UUID string identifying this transaction.

Body
idstring · uuidRead-onlyRequired
amountstring · decimalRequiredPattern: ^-?\d{0,18}(?:\.\d{0,2})?$
payment_idstring · max: 255Required
statusstring · enumOptional
  • PENDING - Pending
  • PROCESSING - Processing
  • COMPLETED - Completed
  • FAILED - Failed
  • VOIDED - Voided
Possible values:
sourcestringRead-onlyRequired
last4stringRead-onlyRequired
datestringRead-onlyRequired
viastring | nullableOptional
contribution_typestringRead-onlyRequired
contribution_type_idstringRead-onlyRequired
contribution_idstringRead-onlyRequired
recurringbooleanRequired
memostringRead-onlyRequired
subscriptionstringRead-onlyRequired
card_numberstringRead-onlyRequired
card_brandstringRead-onlyRequired
card_expiration_monthstringRead-onlyRequired
card_expiration_yearstringRead-onlyRequired
card_holder_namestringRead-onlyRequired
userstringRead-onlyRequired
gueststringRead-onlyRequired
created_atstring · date-time | nullableOptional
Responses
200Success
application/json
post
POST /api/give/transactions/{id}/void HTTP/1.1
Host: prosper-api-test.churchpad.com
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 126

{
  "amount": "text",
  "payment_id": "text",
  "status": "PENDING",
  "via": "text",
  "recurring": true,
  "created_at": "2025-07-23T12:16:19.865Z"
}
200Success
{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "amount": "text",
  "payment_id": "text",
  "status": "PENDING",
  "source": "text",
  "last4": "text",
  "date": "text",
  "via": "text",
  "contribution_type": "text",
  "contribution_type_id": "text",
  "contribution_id": "text",
  "recurring": true,
  "memo": "text",
  "subscription": "text",
  "card_number": "text",
  "card_brand": "text",
  "card_expiration_month": "text",
  "card_expiration_year": "text",
  "card_holder_name": "text",
  "user": "text",
  "guest": "text",
  "created_at": "2025-07-23T12:16:19.865Z"
}