Payment records

Get payment records

get/payment_records

Request

  • Base URL: https://api.sandbox.monite.com/v1
  • URL: https://api.sandbox.monite.com/v1/payment_records
  • Auth: HTTP bearer

Query parameters

order'asc' | 'desc'

Order by

limitinteger

Max is 100

pagination_tokenstring

A token, obtained from previous page. Prior over other filters

sort'paid_at' | 'amount' | 'overpaid_amount'

Allowed sort fields

is_externalboolean

Identifies whether payment is from our rails or external system

object_idstring uuid

ID of the object, that is connected to payment

object_id__instring uuid

List of IDs of the objects, that are connected to payments

object_type'receivable' | 'payable'

Type of an object, which is connected with payment

created_at__gtstring date-time

Created after this datetime (exclusive)

created_at__ltstring date-time

Created before this datetime (exclusive)

updated_at__gtstring date-time

Updated after this datetime (exclusive)

updated_at__ltstring date-time

Updated before this datetime (exclusive)

paid_at__gtstring date-time

Paid after this datetime (exclusive)

paid_at__ltstring date-time

Paid before this datetime (exclusive)

planned_payment_datestring date

Optional date of the upcoming payment (equality)

planned_payment_date__gtstring date

Planned after this date (exclusive)

planned_payment_date__ltstring date

Planned before this date (exclusive)

planned_payment_date__gtestring date

Planned at or after this date (inclusive)

planned_payment_date__ltestring date

Planned at or before this date (inclusive)

status'created' | 'processing' | 'succeeded' | 'canceled'

One of the payment record statuses

payment_intent_statusstring

Payment intent status as a raw string

payment_methodstring

Payment method used for the transaction

Headers

x-monite-versionstring required
x-monite-entity-idstring required

The ID of the entity that owns the requested resource.

Response

Successful Response

next_pagination_tokenstring

A token that can be sent in the pagination_token query parameter to get the next page of results, or null if there is no next page (i.e. you've reached the last page).

prev_pagination_tokenstring

A token that can be sent in the pagination_token query parameter to get the previous page of results, or null if there is no previous page (i.e. you've reached the first page).

Changes

No recorded changes to this operation across all 1 revision of this API.