Get payment for this organization

get

https://api.pushpay.com/v1/organization/{organizationKey}/payments

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

⚠️ Note: The GET /payment endpoints do NOT return imported transactions by default.

If payment source is not explicitly set then all payments except for TransactionImport payments will be returned.

"query": [
  {
		"key": "source",
    "value": "TransactionImport"  
	},

Path Params

organizationKey

string

required

Query Params

from

date-time

Only include payments after a date/time (UTC)

date-time

Only include payments before a date/time (UTC)

createdFrom

date-time

Only include payments after a date/time (UTC)

createdTo

date-time

Only include payments before a date/time (UTC)

updatedFrom

date-time

Only include payments changed after a date/time (UTC)

updatedTo

date-time

Only include payments changed before a date/time (UTC)

orderby

string

Order data by a particular property in ascending or descending order. Uses format 'PropertyName ASC' or 'PropertyName DESC'

type

string

enum

Only include payments made with the specified type of payment method (ACH, CreditCard, DepositedCheck, or NzBankAccount). If payment type is not explicitly set then all payments except for non cash gifts will be returned. To get all types of payments use All value.

status

string

enum

Only include payments with the specified status (Success, Failed, or Processing)

Allowed:

source

string

enum

Only include payment sources of (Mobile, Web, Recurring, Kiosk, VirtualTerminal, TextGiving, CheckDeposit, TransactionImport or BatchEntry). If payment source is not explicitly set then all payments except for TransactionImport payments will be returned.

page

int32

required

The page parameter (Note: page numbering starts at 0)

pageSize

int32

required

The page size parameter (Note: default page size is 25)

Responses

400

The server will not process the request due to a client error

401

Request failed because the client was not authorized to perform this action

404

Could not find resource

429

Request was throttled due to too many requests from this client or IP address

Language

Credentials

OAuth2

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/hal+json

200success