---
title: "/getPayments"
description: "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 ,…"
url: "https://help.aesauctions.com/article/exmtth5cvi-get-payments"
category: "API"
updated_at: "2025-02-14T21:52:00Z"
---

# /getPayments

### 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.

payment\_type

no

string

all

Indicate which payment type(s) you wish to retrieve, if null we will return all.

- Cash
- Check
- Credit Card

#### **Return Values**

\* indicates data will always be returned

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.

- CASH
- CHECK
- CREDIT CARD
- REFUND

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

string

Only for credit card payments. One of the following responses.

- IATS
- FIRST PAY
- APPLE PAY

IATS

status*

string

For Credit Cards

- Approved
- Pending

For Cash or Check

- Recieved

NOTE: we will NOT pass credit card transactins that have been DECLINED

Approved

credit\_card\_type

string

Only for credit card payments. One of the following responses.

- VISA
- MASTERCARD
- DISCOVER
- AMEX

AMEX

#### Sample Call

```
{
  event_id: "2442",
  payment_type: ["check","cash","credit card"]
}
```

#### 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"
},
],
```