APICreditItem
Represents one credit record, including participant, study, and payment information. A function may return one record or an array of records.
| Data Field | Data Type | Description |
|---|---|---|
| signup_id | Int32 | the numeric identifier of the sign-up |
| first_name | String | the participant’s first name |
| last_name | String | the participant’s last name |
| student_id_num | String | the participant’s student ID number (if available) |
| credit_id | Int32 | the unique numeric identifier of the credit record |
| user_id | String | the participant’s user ID |
| String | the participant’s email address | |
| person_id | Int32 | the numeric identifier of the participant |
| date_granted | Date | the date when the credit was granted |
| occur_date | Date | the date and time when the study is to occur |
| show_credit | Decimal | the credit value granted to the participant |
| penalty_credit | Decimal | the credit value penalized from the participant |
| credit_type | String | possible values: G = credit granted | W = awaiting action | E = excused no-show | I = unexcused no-show |
| payment_amount | Decimal | the payment amount associated with this credit record |
| payment_status | String | the single-character payment status for this credit record |
| payment_status_last_updated | Date | the date and time when the payment status was last updated. If no date has been recorded, the API returns 0001-01-01T00:00:00. |
| manual_credit_flag | Int32 | possible values: 0 = system-granted | 1 = admin-granted |
| comments | String | comments pertaining to the credit grant |
| experiment_id | Int32 | the numeric identifier of the study |
| grantor_id | Int32 | the numeric identifier of the researcher who granted credit |
| class_id | Int32 | the numeric identifier of the course |
The payment fields are returned for every credit record, including manual credits, credit studies, and unmanaged paid studies.
Payment Status Codes¶
| Code | Status | Description |
|---|---|---|
W |
Waiting | The payment has not yet been earned or is not payable. |
E |
Earned | The payment has been earned and is pending payment. |
C |
Awaiting Payment Confirmation | The payment has been included in a payment batch. |
P |
Paid | The payment has been paid. |
Cancelling a payment batch returns its associated credits to E (Earned). For this field, C means Awaiting Payment Confirmation, not Cancelled.