Get payment records

GET

/payment_records

GET

/v1/payment_records

curl https://api.sandbox.monite.com/v1/payment_records \
     -H "x-monite-version: 2024-01-31" \
     -H "x-monite-entity-id: 9d2b4c8f-2087-4738-ba91-7359683c49a4" \
     -H "Authorization: Bearer <token>"

{
  "data": [
    {
      "id": "id",
      "amount": 1,
      "currency": "AED",
      "history": [
        {
          "status": "created",
          "timestamp": "2024-01-15T09:30:00Z",
          "entity_user_id": "entity_user_id"
        }
      ],
      "is_external": true,
      "object": {
        "id": "id",
        "new_status": "new_status",
        "old_status": "old_status",
        "type": "receivable"
      },
      "entity_user_id": "entity_user_id",
      "overpaid_amount": 1,
      "paid_at": "2024-01-15T09:30:00Z",
      "payment_intent_id": "payment_intent_id",
      "payment_intent_status": "payment_intent_status",
      "payment_method": "payment_method",
      "planned_payment_date": "planned_payment_date",
      "status": "status"
    }
  ],
  "next_pagination_token": "next_pagination_token",
  "prev_pagination_token": "prev_pagination_token"
}

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Query parameters

orderenumOptional

Order by

Allowed values:

limitintegerOptional1-100Defaults to 100

Max is 100

pagination_tokenstringOptional

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

sortenumOptional

Allowed sort fields

Allowed values:

is_externalbooleanOptional

Identifies whether payment is from our rails or external system

object_idstringOptionalformat: "uuid"

ID of the object, that is connected to payment

object_id__instringOptionalformat: "uuid"

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

object_typeenumOptional

Type of an object, which is connected with payment

Allowed values:

created_at__gtdatetimeOptional

Created after this datetime (exclusive)

created_at__ltdatetimeOptional

Created before this datetime (exclusive)

updated_at__gtdatetimeOptional

Updated after this datetime (exclusive)

updated_at__ltdatetimeOptional

Updated before this datetime (exclusive)

paid_at__gtdatetimeOptional

Paid after this datetime (exclusive)

paid_at__ltdatetimeOptional

Paid before this datetime (exclusive)

planned_payment_datestringOptionalformat: "date"

Optional date of the upcoming payment (equality)

planned_payment_date__gtstringOptionalformat: "date"

Planned after this date (exclusive)

planned_payment_date__ltstringOptionalformat: "date"

Planned before this date (exclusive)

planned_payment_date__gtestringOptionalformat: "date"

Planned at or after this date (inclusive)

planned_payment_date__ltestringOptionalformat: "date"

Planned at or before this date (inclusive)

statusenumOptional

One of the payment record statuses

Allowed values:

payment_intent_statusstringOptional

Payment intent status as a raw string

payment_methodstringOptional

Payment method used for the transaction

Response

Successful Response

datalist of objects

next_pagination_tokenstringOptional

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_tokenstringOptional

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).

Errors

422

Get Payment Records Request Unprocessable Entity Error

500

Get Payment Records Request Internal Server Error

Authentication

Headers

Query parameters

Response

Errors