Create Anticipated Payment

POST /v1/anticipatedpayments

When creating a new anticipated payment you must:

Specify a merchant (by setting the 'merchant' property to the ID or handle of the merchant).

All other fields are optional - but recommend setting the 'reference' field to a local identifier for the payment, and populating an fields that are required to be certain values for tracking the payment for the Merchant.

Fields are passed in as an array of objects, each object has 3 properties.

key

value

readOnly

The 'key' is a string and must be either the reference definition's ID, or the keyword 'amount' for setting the amount of this anticipated payment.
The value is the value of the reference field (a string) or the amount (which must also be specified as a string, or using the format:

{ "value": "123.45", "currency": "USD"}

The value readOnly is a boolean field - where if 'true' then field will be made read-only, this works for both reference definitions and the amount field

Create a new anticipated payment, specifying a fulfilmentMethod of 'Manual' which enforces payment by a registered Payer only, allows payments to be retried and allows you to specify an explicit Expiry date and time.

# Example 1
# Get a single payment made to a merchant
set oAuthToken=%1
set merchantKey="MTpZc2M4M3hOM05KMmdxOHpDQklvYkxqQWpfY2M"
set token="HgHeIQ-Ui0yJPHtavtS2uQ"
set url="https://api.pushpay.com/v1/merchant/%merchantKey%/payment/%token%"
curl -i -H "Accept: application/hal+json" -H "Authorization: Bearer %oAuthToken%" %url%

# Example 2
# Get a single payment made to a merchant, which has additional custom data stored against it (which was included in the POST request when the payment was made)
set oAuthToken=%1
set merchantKey="MTpZc2M4M3hOM05KMmdxOHpDQklvYkxqQWpfY2M"
set token="HgHeIQ-Ui0yJPHtavtS2uQ"
set url="https://api.pushpay.com/v1/merchant/%merchantKey%/payment/%token%"
curl -i -H "Accept: application/hal+json" -H "Authorization: Bearer %oAuthToken%" %url%

# Example 3
# Get a single payment made to a merchant, which was made by cash at the virtual terminal
set oAuthToken=%1
set merchantKey="MTpZc2M4M3hOM05KMmdxOHpDQklvYkxqQWpfY2M"
set token="HgHeIQ-Ui0yJPHtavtS2uQ"
set url="https://api.pushpay.com/v1/merchant/%merchantKey%/payment/%token%"
curl -i -H "Accept: application/hal+json" -H "Authorization: Bearer %oAuthToken%" %url%

# Example 7
# Get a single payment which has an integration's fund_id included in the set of externalLinks. The external link is only included when the client has the merchant:view_payments scope
set oAuthToken=%1
set merchantKey="MTpZc2M4M3hOM05KMmdxOHpDQklvYkxqQWpfY2M"
set token="xgJHFPJUQUOlucVDjsJ5Ow"
set url="https://api.pushpay.com/v1/merchant/%merchantKey%/payment/%token%"
curl -i -H "Accept: application/hal+json" -H "Authorization: Bearer %oAuthToken%" %url%

Get Payments for Merchant

Path (URL) Parameters

The unique key of the merchant - a case-sensitive series of characters

Query string (URL) parameters

Name

Type

Description

from

string

Only include payments after a date/time (UTC)

to

string

Only include payments before a date/time (UTC)

createdFrom

string

Only include payments after a date/time (UTC)

createdTo

string

Only include payments before a date/time (UTC)

updatedFrom

string

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

updatedTo

string

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

Only include payments made with the specified type of payment method (ACH, CreditCard, DepositedCheck, or NzBankAccount)

status

string

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

fields

array

Only include payments that contain a specified value within a custom field. Uses format 'fields[FieldNumber]'

source

string

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

Required Scopes

Request

GET /v1/merchant/MTpZc2M4M3hOM05KMmdxOHpDQklvYkxqQWpfY2M/payments?page=0&pageSize=25

Headers

Name

Value

Description

Accept

application/hal+json

Authorization

Bearer XXXXXXXXX

The bearer token being used to authenticate this request

Parameters

Name

Value

Type

Description

merchantKey

MTpZc2M4M3hOM05KMmdxOHpDQklvYkxqQWpfY2M

path

The unique key of the merchant - a case-sensitive series of characters

from

query

Only include payments after a date/time (UTC)

to

query

Only include payments before a date/time (UTC)

createdFrom

query

Only include payments after a date/time (UTC)

createdTo

query

Only include payments before a date/time (UTC)

updatedFrom

query

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

updatedTo

query

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

orderby

query

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

type

query

Only include payments made with the specified type of payment method (ACH, CreditCard, DepositedCheck, or NzBankAccount)

status

query

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

fields

query

Only include payments that contain a specified value within a custom field. Uses format 'fields[FieldNumber]'

source

query

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

Request

GET /v1/merchant/MTpZc2M4M3hOM05KMmdxOHpDQklvYkxqQWpfY2M/payments?page=2&pageSize=25

Headers

Name

Value

Description

Accept

application/hal+json

Authorization

Bearer XXXXXXXXX

The bearer token being used to authenticate this request

Parameters

Name

Value

Type

Description

merchantKey

MTpZc2M4M3hOM05KMmdxOHpDQklvYkxqQWpfY2M

path

The unique key of the merchant - a case-sensitive series of characters

from

query

Only include payments after a date/time (UTC)

to

query

Only include payments before a date/time (UTC)

createdFrom

query

Only include payments after a date/time (UTC)

createdTo

query

Only include payments before a date/time (UTC)

updatedFrom

query

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

updatedTo

query

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

orderby

query

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

type

query

Only include payments made with the specified type of payment method (ACH, CreditCard, DepositedCheck, or NzBankAccount)

status

query

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

fields

query

Only include payments that contain a specified value within a custom field. Uses format 'fields[FieldNumber]'

source

query

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

# Example 2
# Get third page of a list of payments belonging to the merchant
set oAuthToken=%1
set merchantKey="MTpZc2M4M3hOM05KMmdxOHpDQklvYkxqQWpfY2M"
set page=2
set pageSize=25
set url="https://api.pushpay.com/v1/merchant/%merchantKey%/payments?page=%page%&pageSize=%pageSize%"
curl -i -H "Accept: application/hal+json" -H "Authorization: Bearer %oAuthToken%" %url%

Request

GET /v1/merchant/MTpZc2M4M3hOM05KMmdxOHpDQklvYkxqQWpfY2M/payments?createdFrom=2014-08-20T00:00:00Z&createdTo=2014-08-22T00:00:00Z&from=2014-08-20T00:00:00Z&page=0&pageSize=25&to=2014-08-22T00:00:00Z

Headers

Name

Value

Description

Accept

application/hal+json

Authorization

Bearer XXXXXXXXX

The bearer token being used to authenticate this request

Parameters

Name

Value

Type

Description

merchantKey

MTpZc2M4M3hOM05KMmdxOHpDQklvYkxqQWpfY2M

path

The unique key of the merchant - a case-sensitive series of characters

from

2014-08-20T00:00:00Z

query

Only include payments after a date/time (UTC)

to

2014-08-22T00:00:00Z

query

Only include payments before a date/time (UTC)

createdFrom

2014-08-20T00:00:00Z

query

Only include payments after a date/time (UTC)

createdTo

2014-08-22T00:00:00Z

query

Only include payments before a date/time (UTC)

updatedFrom

query

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

updatedTo

query

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

orderby

query

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

type

query

Only include payments made with the specified type of payment method (ACH, CreditCard, DepositedCheck, or NzBankAccount)

status

query

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

fields

query

Only include payments that contain a specified value within a custom field. Uses format 'fields[FieldNumber]'

source

query

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

# Example 3
# Get a list of payments within a date range, using obsolete from & to
set oAuthToken=%1
set merchantKey="MTpZc2M4M3hOM05KMmdxOHpDQklvYkxqQWpfY2M"
set from="2014-08-20T00:00:00Z"
set to="2014-08-22T00:00:00Z"
set createdFrom="2014-08-20T00:00:00Z"
set createdTo="2014-08-22T00:00:00Z"
set page=0
set pageSize=25
set url="https://api.pushpay.com/v1/merchant/%merchantKey%/payments?from=%from%&to=%to%&createdFrom=%createdFrom%&createdTo=%createdTo%&page=%page%&pageSize=%pageSize%"
curl -i -H "Accept: application/hal+json" -H "Authorization: Bearer %oAuthToken%" %url%

Request

GET /v1/merchant/MTpZc2M4M3hOM05KMmdxOHpDQklvYkxqQWpfY2M/payments?createdFrom=2014-08-20T00:00:00Z&createdTo=2014-08-22T00:00:00Z&from=2014-08-20T00:00:00Z&page=0&pageSize=25&to=2014-08-22T00:00:00Z

Headers

Name

Value

Description

Accept

application/hal+json

Authorization

Bearer XXXXXXXXX

The bearer token being used to authenticate this request

Parameters

Name

Value

Type

Description

merchantKey

MTpZc2M4M3hOM05KMmdxOHpDQklvYkxqQWpfY2M

path

The unique key of the merchant - a case-sensitive series of characters

from

2014-08-20T00:00:00Z

query

Only include payments after a date/time (UTC)

to

2014-08-22T00:00:00Z

query

Only include payments before a date/time (UTC)

createdFrom

2014-08-20T00:00:00Z

query

Only include payments after a date/time (UTC)

createdTo

2014-08-22T00:00:00Z

query

Only include payments before a date/time (UTC)

updatedFrom

query

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

updatedTo

query

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

orderby

query

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

type

query

Only include payments made with the specified type of payment method (ACH, CreditCard, DepositedCheck, or NzBankAccount)

status

query

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

fields

query

Only include payments that contain a specified value within a custom field. Uses format 'fields[FieldNumber]'

source

query

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

# Example 4
# Get a list of payments modified within a date range
set oAuthToken=%1
set merchantKey="MTpZc2M4M3hOM05KMmdxOHpDQklvYkxqQWpfY2M"
set from="2014-08-20T00:00:00Z"
set to="2014-08-22T00:00:00Z"
set createdFrom="2014-08-20T00:00:00Z"
set createdTo="2014-08-22T00:00:00Z"
set page=0
set pageSize=25
set url="https://api.pushpay.com/v1/merchant/%merchantKey%/payments?from=%from%&to=%to%&createdFrom=%createdFrom%&createdTo=%createdTo%&page=%page%&pageSize=%pageSize%"
curl -i -H "Accept: application/hal+json" -H "Authorization: Bearer %oAuthToken%" %url%

Get a list of payments within a date range, using the preferred syntax

Request

GET /v1/merchant/MTpZc2M4M3hOM05KMmdxOHpDQklvYkxqQWpfY2M/payments?page=0&pageSize=25&updatedFrom=2014-08-19T00:00:00Z&updatedTo=2014-08-22T00:00:00Z

Headers

Name

Value

Description

Accept

application/hal+json

Authorization

Bearer XXXXXXXXX

The bearer token being used to authenticate this request

Parameters

Name

Value

Type

Description

merchantKey

MTpZc2M4M3hOM05KMmdxOHpDQklvYkxqQWpfY2M

path

The unique key of the merchant - a case-sensitive series of characters

from

query

Only include payments after a date/time (UTC)

to

query

Only include payments before a date/time (UTC)

createdFrom

query

Only include payments after a date/time (UTC)

createdTo

query

Only include payments before a date/time (UTC)

updatedFrom

2014-08-19T00:00:00Z

query

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

updatedTo

2014-08-22T00:00:00Z

query

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

orderby

query

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

type

query

Only include payments made with the specified type of payment method (ACH, CreditCard, DepositedCheck, or NzBankAccount)

status

query

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

fields

query

Only include payments that contain a specified value within a custom field. Uses format 'fields[FieldNumber]'

source

query

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

# Example 5
# Get a list of payments within a date range, using the preferred syntax
set oAuthToken=%1
set merchantKey="MTpZc2M4M3hOM05KMmdxOHpDQklvYkxqQWpfY2M"
set updatedFrom="2014-08-19T00:00:00Z"
set updatedTo="2014-08-22T00:00:00Z"
set page=0
set pageSize=25
set url="https://api.pushpay.com/v1/merchant/%merchantKey%/payments?updatedFrom=%updatedFrom%&updatedTo=%updatedTo%&page=%page%&pageSize=%pageSize%"
curl -i -H "Accept: application/hal+json" -H "Authorization: Bearer %oAuthToken%" %url%

Request

GET /v1/merchant/MTpZc2M4M3hOM05KMmdxOHpDQklvYkxqQWpfY2M/payments?page=0&pageSize=100

Headers

Name

Value

Description

Accept

application/hal+json

Authorization

Bearer XXXXXXXXX

The bearer token being used to authenticate this request

Parameters

Name

Value

Type

Description

merchantKey

MTpZc2M4M3hOM05KMmdxOHpDQklvYkxqQWpfY2M

path

The unique key of the merchant - a case-sensitive series of characters

from

query

Only include payments after a date/time (UTC)

to

query

Only include payments before a date/time (UTC)

createdFrom

query

Only include payments after a date/time (UTC)

createdTo

query

Only include payments before a date/time (UTC)

updatedFrom

query

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

updatedTo

query

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

orderby

query

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

type

query

Only include payments made with the specified type of payment method (ACH, CreditCard, DepositedCheck, or NzBankAccount)

status

query

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

fields

query

Only include payments that contain a specified value within a custom field. Uses format 'fields[FieldNumber]'

source

query

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

Request

GET /v1/merchant/MTpZc2M4M3hOM05KMmdxOHpDQklvYkxqQWpfY2M/payments?page=0&pageSize=25&status=Success

Headers

Name

Value

Description

Accept

application/hal+json

Authorization

Bearer XXXXXXXXX

The bearer token being used to authenticate this request

Parameters

Name

Value

Type

Description

merchantKey

MTpZc2M4M3hOM05KMmdxOHpDQklvYkxqQWpfY2M

path

The unique key of the merchant - a case-sensitive series of characters

from

query

Only include payments after a date/time (UTC)

to

query

Only include payments before a date/time (UTC)

createdFrom

query

Only include payments after a date/time (UTC)

createdTo

query

Only include payments before a date/time (UTC)

updatedFrom

query

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

updatedTo

query

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

orderby

query

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

type

query

Only include payments made with the specified type of payment method (ACH, CreditCard, DepositedCheck, or NzBankAccount)

status

Success

query

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

fields

query

Only include payments that contain a specified value within a custom field. Uses format 'fields[FieldNumber]'

source

query

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

Request

GET /v1/merchant/MTpZc2M4M3hOM05KMmdxOHpDQklvYkxqQWpfY2M/payments?page=0&pageSize=25&type=ACH

Headers

Name

Value

Description

Accept

application/hal+json

Authorization

Bearer XXXXXXXXX

The bearer token being used to authenticate this request

Parameters

Name

Value

Type

Description

merchantKey

MTpZc2M4M3hOM05KMmdxOHpDQklvYkxqQWpfY2M

path

The unique key of the merchant - a case-sensitive series of characters

from

query

Only include payments after a date/time (UTC)

to

query

Only include payments before a date/time (UTC)

createdFrom

query

Only include payments after a date/time (UTC)

createdTo

query

Only include payments before a date/time (UTC)

updatedFrom

query

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

updatedTo

query

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

orderby

query

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

type

ACH

query

Only include payments made with the specified type of payment method (ACH, CreditCard, DepositedCheck, or NzBankAccount)

status

query

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

fields

query

Only include payments that contain a specified value within a custom field. Uses format 'fields[FieldNumber]'

source

query

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

Request

GET /v1/merchant/MTpZc2M4M3hOM05KMmdxOHpDQklvYkxqQWpfY2M/payments?fields[1]=For last week&page=0&pageSize=25

Headers

Name

Value

Description

Accept

application/hal+json

Authorization

Bearer XXXXXXXXX

The bearer token being used to authenticate this request

Parameters

Name

Value

Type

Description

merchantKey

MTpZc2M4M3hOM05KMmdxOHpDQklvYkxqQWpfY2M

path

The unique key of the merchant - a case-sensitive series of characters

from

query

Only include payments after a date/time (UTC)

to

query

Only include payments before a date/time (UTC)

createdFrom

query

Only include payments after a date/time (UTC)

createdTo

query

Only include payments before a date/time (UTC)

updatedFrom

query

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

updatedTo

query

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

orderby

query

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

type

query

Only include payments made with the specified type of payment method (ACH, CreditCard, DepositedCheck, or NzBankAccount)

status

query

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

fields[1]

For last week

query

Only include payments that contain a specified value within a custom field. Uses format 'fields[FieldNumber]'

source

query

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

# Example 9
# Get all payments with certain values by reference field
set oAuthToken=%1
set merchantKey="MTpZc2M4M3hOM05KMmdxOHpDQklvYkxqQWpfY2M"
set fields1=For last week
set page=0
set pageSize=25
set url="https://api.pushpay.com/v1/merchant/%merchantKey%/payments?fields[1]=%fields1%&page=%page%&pageSize=%pageSize%"
curl -i -H "Accept: application/hal+json" -H "Authorization: Bearer %oAuthToken%" %url%

Get Payments for a Recurring Payment

GET /v1/merchant/{merchantKey}/recurringpayment/{paymentToken}/payments

Path (URL) Parameters

Name

Type

Description

merchantKey

string

The unique key of the merchant - a case-sensitive series of characters

paymentToken

string

Query string (URL) parameters

Name

Type

Description

from

string

Only include payments after a date/time (UTC)

to

string

Only include payments before a date/time (UTC)

createdFrom

string

Only include payments after a date/time (UTC)

createdTo

string

Only include payments before a date/time (UTC)

updatedFrom

string

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

updatedTo

string

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

Only include payments made with the specified type of payment method (ACH, CreditCard, DepositedCheck, or NzBankAccount)

status

string

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

fields

array

Only include payments that contain a specified value within a custom field. Uses format 'fields[FieldNumber]'

source

string

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

Request

GET /v1/merchant/MTpZc2M4M3hOM05KMmdxOHpDQklvYkxqQWpfY2M/recurringpayment/VMZqPmcWY0qfsxoE38ja3w/payments?page=0&pageSize=25

Headers

Name

Value

Description

Accept

application/hal+json

Authorization

Bearer XXXXXXXXX

The bearer token being used to authenticate this request

Parameters

Name

Value

Type

Description

merchantKey

MTpZc2M4M3hOM05KMmdxOHpDQklvYkxqQWpfY2M

path

The unique key of the merchant - a case-sensitive series of characters

paymentToken

VMZqPmcWY0qfsxoE38ja3w

path

The unique token of the payment - a case-sensitive series of characters

from

query

Only include payments after a date/time (UTC)

to

query

Only include payments before a date/time (UTC)

createdFrom

query

Only include payments after a date/time (UTC)

createdTo

query

Only include payments before a date/time (UTC)

updatedFrom

query

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

updatedTo

query

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

orderby

query

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

type

query

Only include payments made with the specified type of payment method (ACH, CreditCard, DepositedCheck, or NzBankAccount)

status

query

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

fields

query

Only include payments that contain a specified value within a custom field. Uses format 'fields[FieldNumber]'

source

query

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

# Example 5
# Retrieve a recurring payment schedule, which has additional custom data stored against it (which was included in the POST/PUT request when the recurring payment was made or updated)
set oAuthToken=%1
set merchantKey="MzpMNU9YSTIwSmt4REN5ZWluUlhSbGNvLV9lUk0"
set token="BQM1lWLcM0uKc1y4a8RHUw"
set url="https://api.pushpay.com/v1/merchant/%merchantKey%/recurringpayment/%token%"
curl -i -H "Accept: application/hal+json" -H "Authorization: Bearer %oAuthToken%" %url%

Get a single recurring payment which has an integration's fund_id included in the set of externalLinks. The external link is only included when the client has the merchant:view_recurring_payments scope

Request

GET /v1/merchant/MzpMNU9YSTIwSmt4REN5ZWluUlhSbGNvLV9lUk0/recurringpayment/BQM1lWLcM0uKc1y4a8RHUw

Headers

Name

Value

Description

Accept

application/hal+json

Authorization

Bearer XXXXXXXXX

The bearer token being used to authenticate this request

Parameters

Name

Value

Type

Description

merchantKey

MzpMNU9YSTIwSmt4REN5ZWluUlhSbGNvLV9lUk0

path

The unique key of the merchant - a case-sensitive series of characters

token

BQM1lWLcM0uKc1y4a8RHUw

path

The token is a unique identifier for this resource - a case-sensitive series of characters

# Example 6
# Get a single recurring payment which has an integration's fund_id included in the set of externalLinks. The external link is only included when the client has the merchant:view_recurring_payments scope
set oAuthToken=%1
set merchantKey="MzpMNU9YSTIwSmt4REN5ZWluUlhSbGNvLV9lUk0"
set token="BQM1lWLcM0uKc1y4a8RHUw"
set url="https://api.pushpay.com/v1/merchant/%merchantKey%/recurringpayment/%token%"
curl -i -H "Accept: application/hal+json" -H "Authorization: Bearer %oAuthToken%" %url%

# Example 3
# Retrieve all recurring payments associated with a recipient, with any of the specified statues
set oAuthToken=%1
set merchantKey="MTpZc2M4M3hOM05KMmdxOHpDQklvYkxqQWpfY2M"
set status=Paused
set status=Cancelled
set page=0
set pageSize=25
set url="https://api.pushpay.com/v1/merchant/%merchantKey%/recurringpayments?status=%status%&status=%status%&page=%page%&pageSize=%pageSize%"
curl -i -H "Accept: application/hal+json" -H "Authorization: Bearer %oAuthToken%" %url%

# Example 8
# Retrieve all recurring payments associated with a recipient, ordered by when they were last updated
set oAuthToken=%1
set merchantKey="MTpZc2M4M3hOM05KMmdxOHpDQklvYkxqQWpfY2M"
set orderBy="updatedOn DESC"
set page=0
set pageSize=25
set url="https://api.pushpay.com/v1/merchant/%merchantKey%/recurringpayments?orderBy=%orderBy%&page=%page%&pageSize=%pageSize%"
curl -i -H "Accept: application/hal+json" -H "Authorization: Bearer %oAuthToken%" %url%

Get My Payments

This operation requires that the OAuth2 bearer token include a 'sub' (subject) claim.

Query string (URL) parameters

Name

Type

Description

from

string

Only include payments after a date/time (UTC)

to

string

Only include payments before a date/time (UTC)

createdFrom

string

Only include payments after a date/time (UTC)

createdTo

string

Only include payments before a date/time (UTC)

updatedFrom

string

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

updatedTo

string

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

Only include payments made with the specified type of payment method (ACH, CreditCard, DepositedCheck, or NzBankAccount)

status

string

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

fields

array

Only include payments that contain a specified value within a custom field. Uses format 'fields[FieldNumber]'

source

string

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

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

type

query

Only include payments made with the specified type of payment method (ACH, CreditCard, DepositedCheck, or NzBankAccount)

status

query

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

fields

query

Only include payments that contain a specified value within a custom field. Uses format 'fields[FieldNumber]'

source

query

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

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

type

query

Only include payments made with the specified type of payment method (ACH, CreditCard, DepositedCheck, or NzBankAccount)

status

query

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

fields

query

Only include payments that contain a specified value within a custom field. Uses format 'fields[FieldNumber]'

source

query

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

Request

GET /v1/my/payments?createdFrom=2014-08-20T00:00:00Z&createdTo=2014-08-22T00:00:00Z&from=2014-08-20T00:00:00Z&page=0&pageSize=25&to=2014-08-22T00:00:00Z

Headers

Name

Value

Description

Accept

application/hal+json

Authorization

Bearer XXXXXXXXX

The bearer token being used to authenticate this request

Parameters

Name

Value

Type

Description

from

2014-08-20T00:00:00Z

query

Only include payments after a date/time (UTC)

to

2014-08-22T00:00:00Z

query

Only include payments before a date/time (UTC)

createdFrom

2014-08-20T00:00:00Z

query

Only include payments after a date/time (UTC)

createdTo

2014-08-22T00:00:00Z

query

Only include payments before a date/time (UTC)

updatedFrom

query

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

updatedTo

query

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

orderby

query

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

type

query

Only include payments made with the specified type of payment method (ACH, CreditCard, DepositedCheck, or NzBankAccount)

status

query

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

fields

query

Only include payments that contain a specified value within a custom field. Uses format 'fields[FieldNumber]'

source

query

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

# Example 3
# Get a list of my payments within a date range
set oAuthToken=%1
set from="2014-08-20T00:00:00Z"
set to="2014-08-22T00:00:00Z"
set createdFrom="2014-08-20T00:00:00Z"
set createdTo="2014-08-22T00:00:00Z"
set page=0
set pageSize=25
set url="https://api.pushpay.com/v1/my/payments?from=%from%&to=%to%&createdFrom=%createdFrom%&createdTo=%createdTo%&page=%page%&pageSize=%pageSize%"
curl -i -H "Accept: application/hal+json" -H "Authorization: Bearer %oAuthToken%" %url%

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

type

string

Only include payments made with the specified type of payment method (ACH, CreditCard, DepositedCheck, or NzBankAccount)

status

string

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

fields

array

Only include payments that contain a specified value within a custom field. Uses format 'fields[FieldNumber]'

source

string

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

Required Scopes

Request

GET /v1/organization/MTpZc2M4M3hOM05KMmdxOHpDQklvYkxqQWpfY2M/payments?page=0&pageSize=25

Headers

Name

Value

Description

Accept

application/hal+json

Authorization

Bearer XXXXXXXXX

The bearer token being used to authenticate this request

Parameters

Name

Value

Type

Description

organizationKey

MTpZc2M4M3hOM05KMmdxOHpDQklvYkxqQWpfY2M

path

from

query

Only include payments after a date/time (UTC)

to

query

Only include payments before a date/time (UTC)

createdFrom

query

Only include payments after a date/time (UTC)

createdTo

query

Only include payments before a date/time (UTC)

updatedFrom

query

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

updatedTo

query

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

orderby

query

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

type

query

Only include payments made with the specified type of payment method (ACH, CreditCard, DepositedCheck, or NzBankAccount)

status

query

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

fields

query

Only include payments that contain a specified value within a custom field. Uses format 'fields[FieldNumber]'

source

query

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

Request

GET /v1/organization/MTpZc2M4M3hOM05KMmdxOHpDQklvYkxqQWpfY2M/payments?page=2&pageSize=25

Headers

Name

Value

Description

Accept

application/hal+json

Authorization

Bearer XXXXXXXXX

The bearer token being used to authenticate this request

Parameters

Name

Value

Type

Description

organizationKey

MTpZc2M4M3hOM05KMmdxOHpDQklvYkxqQWpfY2M

path

from

query

Only include payments after a date/time (UTC)

to

query

Only include payments before a date/time (UTC)

createdFrom

query

Only include payments after a date/time (UTC)

createdTo

query

Only include payments before a date/time (UTC)

updatedFrom

query

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

updatedTo

query

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

orderby

query

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

type

query

Only include payments made with the specified type of payment method (ACH, CreditCard, DepositedCheck, or NzBankAccount)

status

query

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

fields

query

Only include payments that contain a specified value within a custom field. Uses format 'fields[FieldNumber]'

source

query

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

# Example 2
# Get third page of a list of payments belonging to the organization
set oAuthToken=%1
set organizationKey="MTpZc2M4M3hOM05KMmdxOHpDQklvYkxqQWpfY2M"
set page=2
set pageSize=25
set url="https://api.pushpay.com/v1/organization/%organizationKey%/payments?page=%page%&pageSize=%pageSize%"
curl -i -H "Accept: application/hal+json" -H "Authorization: Bearer %oAuthToken%" %url%

Request

GET /v1/organization/MTpZc2M4M3hOM05KMmdxOHpDQklvYkxqQWpfY2M/payments?createdFrom=2014-08-20T00:00:00Z&createdTo=2014-08-22T00:00:00Z&from=2014-08-20T00:00:00Z&page=0&pageSize=25&to=2014-08-22T00:00:00Z

Headers

Name

Value

Description

Accept

application/hal+json

Authorization

Bearer XXXXXXXXX

The bearer token being used to authenticate this request

Parameters

Name

Value

Type

Description

organizationKey

MTpZc2M4M3hOM05KMmdxOHpDQklvYkxqQWpfY2M

path

from

2014-08-20T00:00:00Z

query

Only include payments after a date/time (UTC)

to

2014-08-22T00:00:00Z

query

Only include payments before a date/time (UTC)

createdFrom

2014-08-20T00:00:00Z

query

Only include payments after a date/time (UTC)

createdTo

2014-08-22T00:00:00Z

query

Only include payments before a date/time (UTC)

updatedFrom

query

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

updatedTo

query

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

orderby

query

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

type

query

Only include payments made with the specified type of payment method (ACH, CreditCard, DepositedCheck, or NzBankAccount)

status

query

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

fields

query

Only include payments that contain a specified value within a custom field. Uses format 'fields[FieldNumber]'

source

query

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

# Example 3
# Get a list of payments modified within a date range
set oAuthToken=%1
set organizationKey="MTpZc2M4M3hOM05KMmdxOHpDQklvYkxqQWpfY2M"
set from="2014-08-20T00:00:00Z"
set to="2014-08-22T00:00:00Z"
set createdFrom="2014-08-20T00:00:00Z"
set createdTo="2014-08-22T00:00:00Z"
set page=0
set pageSize=25
set url="https://api.pushpay.com/v1/organization/%organizationKey%/payments?from=%from%&to=%to%&createdFrom=%createdFrom%&createdTo=%createdTo%&page=%page%&pageSize=%pageSize%"
curl -i -H "Accept: application/hal+json" -H "Authorization: Bearer %oAuthToken%" %url%

Get a list of payments within a date range, using the preferred syntax

Request

GET /v1/organization/MTpZc2M4M3hOM05KMmdxOHpDQklvYkxqQWpfY2M/payments?page=0&pageSize=25&updatedFrom=2014-08-19T00:00:00Z&updatedTo=2014-08-22T00:00:00Z

Headers

Name

Value

Description

Accept

application/hal+json

Authorization

Bearer XXXXXXXXX

The bearer token being used to authenticate this request

Parameters

Name

Value

Type

Description

organizationKey

MTpZc2M4M3hOM05KMmdxOHpDQklvYkxqQWpfY2M

path

from

query

Only include payments after a date/time (UTC)

to

query

Only include payments before a date/time (UTC)

createdFrom

query

Only include payments after a date/time (UTC)

createdTo

query

Only include payments before a date/time (UTC)

updatedFrom

2014-08-19T00:00:00Z

query

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

updatedTo

2014-08-22T00:00:00Z

query

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

orderby

query

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

type

query

Only include payments made with the specified type of payment method (ACH, CreditCard, DepositedCheck, or NzBankAccount)

status

query

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

fields

query

Only include payments that contain a specified value within a custom field. Uses format 'fields[FieldNumber]'

source

query

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

# Example 4
# Get a list of payments within a date range, using the preferred syntax
set oAuthToken=%1
set organizationKey="MTpZc2M4M3hOM05KMmdxOHpDQklvYkxqQWpfY2M"
set updatedFrom="2014-08-19T00:00:00Z"
set updatedTo="2014-08-22T00:00:00Z"
set page=0
set pageSize=25
set url="https://api.pushpay.com/v1/organization/%organizationKey%/payments?updatedFrom=%updatedFrom%&updatedTo=%updatedTo%&page=%page%&pageSize=%pageSize%"
curl -i -H "Accept: application/hal+json" -H "Authorization: Bearer %oAuthToken%" %url%

Request

GET /v1/organization/MTpZc2M4M3hOM05KMmdxOHpDQklvYkxqQWpfY2M/payments?page=0&pageSize=100

Headers

Name

Value

Description

Accept

application/hal+json

Authorization

Bearer XXXXXXXXX

The bearer token being used to authenticate this request

Parameters

Name

Value

Type

Description

organizationKey

MTpZc2M4M3hOM05KMmdxOHpDQklvYkxqQWpfY2M

path

from

query

Only include payments after a date/time (UTC)

to

query

Only include payments before a date/time (UTC)

createdFrom

query

Only include payments after a date/time (UTC)

createdTo

query

Only include payments before a date/time (UTC)

updatedFrom

query

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

updatedTo

query

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

orderby

query

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

type

query

Only include payments made with the specified type of payment method (ACH, CreditCard, DepositedCheck, or NzBankAccount)

status

query

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

fields

query

Only include payments that contain a specified value within a custom field. Uses format 'fields[FieldNumber]'

source

query

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

Request

GET /v1/organization/MTpZc2M4M3hOM05KMmdxOHpDQklvYkxqQWpfY2M/payments?page=0&pageSize=25&status=Success

Headers

Name

Value

Description

Accept

application/hal+json

Authorization

Bearer XXXXXXXXX

The bearer token being used to authenticate this request

Parameters

Name

Value

Type

Description

organizationKey

MTpZc2M4M3hOM05KMmdxOHpDQklvYkxqQWpfY2M

path

from

query

Only include payments after a date/time (UTC)

to

query

Only include payments before a date/time (UTC)

createdFrom

query

Only include payments after a date/time (UTC)

createdTo

query

Only include payments before a date/time (UTC)

updatedFrom

query

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

updatedTo

query

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

orderby

query

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

type

query

Only include payments made with the specified type of payment method (ACH, CreditCard, DepositedCheck, or NzBankAccount)

status

Success

query

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

fields

query

Only include payments that contain a specified value within a custom field. Uses format 'fields[FieldNumber]'

source

query

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

Request

GET /v1/organization/MTpZc2M4M3hOM05KMmdxOHpDQklvYkxqQWpfY2M/payments?page=0&pageSize=25&type=ACH

Headers

Name

Value

Description

Accept

application/hal+json

Authorization

Bearer XXXXXXXXX

The bearer token being used to authenticate this request

Parameters

Name

Value

Type

Description

organizationKey

MTpZc2M4M3hOM05KMmdxOHpDQklvYkxqQWpfY2M

path

from

query

Only include payments after a date/time (UTC)

to

query

Only include payments before a date/time (UTC)

createdFrom

query

Only include payments after a date/time (UTC)

createdTo

query

Only include payments before a date/time (UTC)

updatedFrom

query

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

updatedTo

query

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

orderby

query

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

type

ACH

query

Only include payments made with the specified type of payment method (ACH, CreditCard, DepositedCheck, or NzBankAccount)

status

query

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

fields

query

Only include payments that contain a specified value within a custom field. Uses format 'fields[FieldNumber]'

source

query

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

# Example 3
# Retrieve all recurring payments associated with a recipient, with any of the specified statues
set oAuthToken=%1
set organizationKey="MTpZc2M4M3hOM05KMmdxOHpDQklvYkxqQWpfY2M"
set status=Paused
set status=Cancelled
set page=0
set pageSize=25
set url="https://api.pushpay.com/v1/organization/%organizationKey%/recurringpayments?status=%status%&status=%status%&page=%page%&pageSize=%pageSize%"
curl -i -H "Accept: application/hal+json" -H "Authorization: Bearer %oAuthToken%" %url%