API Reference
Request Access
Start typing to search…

Get payments

get https://sandbox.hurdlr.com/rest/v5/invoicing/payments

Get all payments for the authenticated user

Log in to see full request history
timestatususer agent
Retrieving recent requests…
LoadingLoading…
Query Params
int64

Invoice filter - returns only those payments associated with the given invoice

status
array of strings

Status filter - returns all payments for the specified statuses. Null or empty list will default to PROCESSED, CANCELED, REFUNDED, PENDING, and FAILED.

status
Headers
string

Cursor from the previous paginated response

int32

Page size, i.e. number of items to return per page

string

Date filter (YYYY-MM-DD) - returns all records updated after the specified date. Null returns all data

Response

Response body
object
data
array of objects

The list of entities

data
object
int64

Id of the payment, required when updating an existing payment

int64
required

Id of the invoice to pay

int64

Id of the bank transfer (bank deposit) that this payment was reconciled against

string

Name of the API that this payment originated from

THIRD_PARTY_PAYMENTS STRIPE USER_ENTRY

string

Id of the payment in your DB (or from your payment processor)

string

Mask of the user's bank account, often the last 4 digits of the account number

string

Display name for the bank account from which this income originated

string

Name or id of the institution from which this transaction originated

int64
required

id of the user's bank account

string

Transaction description, similar to what will show on the user's bank statement

number

The total amount to apply to the invoice, required for third-party payments

number

The service fee to process the payment (subtracted out of the grossPaymentAmount)

number

Total amount applied towards the invoice

string

Display name for the payment

date

Date of the payment

string

Status of the payment, required for third-party payments

PROCESSED CANCELED REFUNDED PENDING FAILED INACTIVE

string

Review status of the expense

PARTNER_REVIEW_REQUIRED USER_REVIEW_REQUIRED ACCOUNTANT_REVIEW_REQUIRED RECONCILIATION_STAGED RECONCILED RECONCILIATION_DISCREPANCY ADJUSTMENT_USER_REVIEW_REQUIRED ADJUSTMENT_ACCOUNTANT_REVIEW_REQUIRED ADJUSTMENT_RECONCILIATION_STAGED

string

Url at which the receipt can be accessed

string

Further detail or reasoning describing the status of the payment for FAILED, CANCELLED, REFUNDED, or INACTIVE invoices

customData
object

Custom JSON in which you can store any data with max length of 2000 characters

Has additional fields
date-time

Date filter - to be used in your subsequent request

string

Cursor to be used in your subsequent paginated request. Only populated if there are more pages available.

deletedIds
array of int32s

Ids of entities that no longer match the request's filter criteria since the request's lastUpdatedDate

deletedIds

Updated over 1 year ago

Language
Credentials
OAuth2
URL
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated over 1 year ago