Sign in
Payments

List payments

Query a list of payments, which includes payins, refunds, chargebacks, and ACH returns, given optional search criteria.

get/v1/payments

Query parameters

idstring

The unique identifier for a Payin, Refund, or Chargeback.

deposit_idstring

The unique deposit identifier.

Prefix is "dep" in production and "sbx_dep" in sandbox.

statusstring[]

One or more payment statuses to filter by. Provide parameter multiple times to filter by multiple payment status types. Some statuses are only valid for certain payment activity types.

ACH returns: CREATED

chargebacks: INQUIRY_ACTION_REQUIRED INQUIRY_PROCESSING DISPUTE_ACTION_REQUIRED CHARGEBACK_PROCESSING PROVISIONAL_WIN WON LOST PRE_ARBITRATION_PROCESSING ARBITRATION

payins: CANCELED CREATED FAILED IN_REVIEW PRESENTING PROCESSING SUCCEEDED

refunds: CANCELED CREATED FAILED IN_REVIEW PROCESSING SUCCEEDED

[
  "PROCESSING"
]
payment_typestring[]

One or more payment types to filter by. Provide parameter multiples times to filter by multiple payment types.

ACH_RETURN CHARGEBACK PAYIN REFUND

[
  "PAYIN"
]
sourcestring[]

One or more payment sources to filter by. Provide parameter multiple times to filter by multiple payment sources. Some sources are only valid for certain payment activity types.

ACH returns and chargebacks: SYSTEM

payins: API_DIRECT API_STORED_PAYMENT_METHOD COMPONENT DEVICE EXTERNAL IVR TAP_TO_PHONE

refunds: API_DIRECT COMPONENT EXTERNAL

due_date.startstring date-time

Due on or after in UTC RFC 3339 format.

due_date.endstring date-time

Due on or before in UTC RFC 3339 format.

sort_by'amount' | 'billing_contact_name' | 'created_at' | 'expected_deposit_date' | 'merchant_id' | 'method_type' | 'payment_id' | 'payment_type' | 'status' | 'acquirer_ref' | 'due_date'

Optional value by which to sort the result set. Default sort by is created_at.

omit_total_resultsboolean

The total_results field in the response will be set to -1. Allows for faster query results.

Parameters

#/paths/~1v1~1payins/get/parameters/0 — unresolved $ref
#/paths/~1v1~1device_registrations/post/responses/200/content/application~1json/schema/properties/data/properties/merchant_id — unresolved $ref
#/paths/~1v1~1payins/get/parameters/2 — unresolved $ref
#/paths/~1v1~1payins/get/parameters/3 — unresolved $ref
#/paths/~1v1~1payins/get/parameters/4 — unresolved $ref
#/paths/~1v1~1payins/get/parameters/7 — unresolved $ref
#/paths/~1v1~1payins/get/parameters/8 — unresolved $ref
#/paths/~1v1~1payins/get/parameters/9 — unresolved $ref
#/paths/~1v1~1payins/get/parameters/10 — unresolved $ref
#/paths/~1v1~1payins/get/parameters/11 — unresolved $ref
#/paths/~1v1~1payins/get/parameters/13 — unresolved $ref
#/paths/~1v1~1payins/get/parameters/14 — unresolved $ref
#/paths/~1v1~1payins/get/parameters/15 — unresolved $ref
#/paths/~1v1~1payins/get/parameters/16 — unresolved $ref

Response

OK

statusStatus — unresolved $ref
errorsErrors — unresolved $ref

Changes