Get a payment

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

Get the payment with the given id

time	status	user agent
Retrieving recent requests…

Loading…

Response

Response body

object

int64

Id of the payment, required when updating an existing payment

invoiceId

int64

required

Id of the invoice to pay

bankTransferId

int64

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

apiName

string

Name of the API that this payment originated from

THIRD_PARTY_PAYMENTS STRIPE USER_ENTRY

apiPaymentId

string

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

apiAccountNo

string

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

apiAccountName

string

Display name for the bank account from which this income originated

apiInstitutionId

string

Name or id of the institution from which this transaction originated

bankAccountId

int64

required

id of the user's bank account

bankDescription

string

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

grossPaymentAmount

number

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

feePaymentAmount

number

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

amountApplied

number

Total amount applied towards the invoice

paymentSource

string

Display name for the payment

date

Date of the payment

status

string

Status of the payment, required for third-party payments

PROCESSED CANCELED REFUNDED PENDING FAILED INACTIVE

reviewStatus

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

receiptUrl

string

Url at which the receipt can be accessed

errorMessage

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

Language

Credentials

OAuth2

URL


xxxxxxxxxx
1
curl --request GET \
2
     --url https://sandbox.hurdlr.com/rest/v5/invoicing/payment \
3
     --header 'accept: application/json'

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

application/json

200Successful operation