/getPayments
Updated
by
Jon Doehling
Get Payments API Call
- Returns all approved payments for a particular event
- Does not return pending or declined payments
- Refunds will be returned as a new transaction with the original paymentId, timestamp of the refund, with a negative amount.
Production Endpoint: https://auctionconductor.com/API/getPayments
QA Staging Endpoint: https://actestserver.com/API/getPayments
Accepted Data
Parameter | Required | Format | Default | Description |
event_id | yes | number | (none) | Unique identifier for the event. Organization assigned to the event must match the API key. |
Return Values
Parameter | Format | Description | Example |
event_id | number | Unique identifier for the event. | 2244 |
event_contributor_id | number | Unique identifier for the contributor in relation to the event. | 61637 |
bidder_number | number | Possibly shared, possibly dynamic number assigned to the eventcontributor. Essentially a username in number format. | 100 |
payment_amount | decimal | Currency in U.S. dollars and cents only. | 25.00 |
payment_type | text | One of the following responses.
| CREDIT CARD |
payment_date_time | timestamp | Date and Time | /Date(1521861353627)/ |
check_number | text | Only for check payments. Check number as entered by the cashier. | #1234 |
cashier_name | text | Will either be the logged user (fname lname), or device ID for a community kiosk (AES 1234). | Firstname Lastname |
payment_id | number | Unique identifier for the payment. | 3100 |
cardholder_name | text | Only for credit card payments. Name of the card holder as entered or read from the credit card swipe. | John Smith |
masked_card | text | Only for credit card payments. Masked credit card number with only the last 4 digits visible. | ************2220 |
expiration_date | text | Only for credit card payments. Expiration date of the credit card. MM/YYYY | 01/2019 |
checkout_notes | text | Plain text field containing optional comments by the cashier who entered the payment. | Will call to pay balance due. |
processor | text | Only for credit card payments. One of the following responses.
| IATS |
status | tex | For Credit Cards
For Cash or Check
NOTE: we will NOT pass credit card transactins that have been DECLINED | Approved |
credit_card_type | text | Only for credit card payments. One of the following responses.
| AMEX |
Sample Call
{
event_id: "2442"
}Sample Response
[
{
"event_id": 2442,
"event_contributor_id": 62856,
"bidder_number": 101,
"payment_amount": 100,
"payment_type": "CHECK",
"payment_date_time": "/Date(1539929035673)/",
"check_number": "#1234",
"cashier_name": "Jon Smith",
"payment_id": 4574,
"cardholder_name": "",
"masked_card": "",
"expiration_date": "",
"checkout_notes": null,
"processor": "",
"status": "Accepted",
"credit_card_type": ""
},
{
"event_id": 2442,
"event_contributor_id": 62861,
"bidder_number": 123,
"payment_amount": 100,
"payment_type": "CASH",
"payment_date_time": "/Date(1539994483387)/",
"check_number": "",
"cashier_name": "Michael Smith",
"payment_id": 4575,
"cardholder_name": "",
"masked_card": "",
"expiration_date": "",
"checkout_notes": null,
"processor": "",
"status": "Accepted",
"credit_card_type": ""
},
{
"event_id": 2442,
"event_contributor_id": 63310,
"bidder_number": 102,
"payment_amount": 5,
"payment_type": "CREDIT CARD",
"payment_date_time": "/Date(1555113940430)/",
"check_number": "",
"cashier_name": "",
"payment_id": 4671,
"cardholder_name": "JOHN SMITH",
"masked_card": "************8431",
"expiration_date": "04/2020",
"checkout_notes": null,
"processor": "FIRST PAY",
"status": "Approved",
"credit_card_type": "AMEX"
},
],
