JUjustifi
Payments

List Payments

List the payments for your account. This endpoint supports pagination.

get/payments

Request

Query parameters

payment_method_idstring

filter records which are associated with a payment method.

void_idstring

filter records which are associated with a void.

created_beforestring date-time

filter records which were created before the date and time (UTC) specified. Dates without time specified will default to 00:00:00

created_afterstring date-time

filter records which were created after the date and time (UTC) specified. Dates without time specified will default to 00:00:00

payment_status'succeeded' | 'failed' | 'pending' | 'authorized' | 'refunded' | 'disputed'

filter to payments which have request payment_status

Headers

Authorizationstring required

the access_token value returned from the JustiFi oauth/token endpoint (be sure to append Bearer before the token)

Sub-Accountstring

the id of the sub account that this request applies to

Response

Successfully list payments

idnumber

the object id

typestring

the object type, or array of objects

Example response

{
  "id": 1,
  "type": "array",
  "page_info": {
    "end_cursor": "WyIyMDIyLTAyLTA4IDE5OjUyOjM3LjEwNDE3MzAwMCIsIjY4MDliYTU5LTYxYjctNDg3MS05YWFiLWE2Y2MyNmY3M2M1ZCJd",
    "start_cursor": "WyIyMDIyLTAyLTA4IDIwOjAxOjU4LjEyMDIzMjAwMCIsIjU5ZTFjNGI1LWFlOWQtNDIyZC04MTVkLWNjNzQ5NzdlYmFjYSJd"
  }
}

Changes

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