On Refund

Estimated reading: 3 minutes 67 views

Summary: A breakdown of the data returned to you through the Zealous API when a a refund is initiated for an entry.

Request

Returns the data of any new submissions made to a specific opportunity belonging to your account.

This includes all works made as part of this submission, as well as payment information for that one entry.

Parameters

api_key (required)

The API key you have generated on Zealous. Keep it safe, since it gives anyone with it access to your data.

opportunity_id (required)

The ID of the opportunity you wish this webhook to listen to.

entry_id (optional)

The ID of the entry you wish to load.

Response

Returns the Submission object belonging to the opportunity_id.

This includes:

Submission (submission_…)

All information relating to the submission, such as key dates, the title, description, unique ids and more. All data linked to the submission object starts with submission_

Candidate (candidate_…)

Data relating to the candidate making the submissions such as name, address, email, phone number and more. All data linked to the submission object starts with candidate_

Added Works (“works”:[…])

A list of objects added to this submission. This could be an upload, embed or text element. Each object contains it’s own data relating to it. Such as the web address of the upload, the name, id, and dimension’s of it (if applicable in your process). All data linked to works can be found in the “works” : […] list.

Payment Details (“payment”:)

If you take a payment, the “payment:” object will also be provided with details such as amount, currency, tax breakdown etc.

{
  "id": "re_3O2bjq2XXXXXXXXXXXXXXXXX",
  "created": "2023-10-23T15:49:23+0000",
  "charge": "ch_3O2bjq2XXXXXXXXXXXXXXXXX",
  "payment_intent": "pi_3O2bjXXXXXXXXXXXXXXXXXXX",
  
  "candidate_id": "549647XXXXXXXXXX",
  "candidate_stripe_id": "cus_JONGXXXXXXXXXX",
  "candidate_email": "[email protected]",
  "candidate_name": "Jane", 
 
  "amount": "10.0",
  "status": "succeeded",
  "currency": "gbp",
  "reason": "requested_by_customer",
  
  "receipt_number": null,
  "source_transfer_reversal": null,
  "transfer_reversal": null
}