Payment intents

Get payment intents

Returns a list of all payment intents. Monite creates payment intents automatically for each payment link. Payment intents let you track the status of payments made via payment links.

To find a payment intent for a specific payable or receivable invoice, provide the object_id parameter. Alternatively, you can use the object_id__in parameter to find payment intents for all invoices from the list.

If no payment intents matching the search criteria were found, the response contains an empty data array.

get/payment_intents

Request

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

Query parameters

order'asc' | 'desc'

Sort order (ascending by default). Typically used together with the sort parameter.

limitinteger

The number of items (0 .. 100) to return in a single page of the response. The response may contain fewer items if it is the last or only page.

pagination_tokenstring

A pagination token obtained from a previous call to this endpoint. Use it to get the next or previous page of results for your initial query. If pagination_token is specified, all other query parameters are ignored and inferred from the initial query.

If not specified, the first page of results will be returned.

sort'id' | 'created_at'

The field to sort the results by. Typically used together with the order parameter.

object_idstring uuid

ID of a payable or receivable invoice. If provided, returns only payment intents associated with the specified invoice.

object_id__instring uuid

A list of payable IDs and/or receivable IDs. If provided, returns only payment intents associated with the specified payable and receivable invoices. Valid but nonexistent IDs do not raise errors but produce no results.

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.