JUjustifi
Payee Payments

List Payee Payments

List payee payments under this payer account. Supports cursor pagination and filtering.

get/payables/payer_accounts/{payer_id}/payee_payments

Request

Path parameters

payer_idstring required

the payer account this request is scoped to. Every payee, bank account, and payment lives under one payer account, so it is part of the path on all operate (Tier 1) routes.

Query parameters

after_cursorstring

token to fetch the next page of a list (the end_cursor from a previous response's page_info)

before_cursorstring

token to fetch the previous page of a list (the start_cursor from a previous response's page_info)

limitinteger

the number of resources to retrieve per page (default 25, max 100)

created_afterstring date-time

filter records created strictly after the date and time (UTC) specified. Dates without a time default to 00:00:00. ISO 8601 only — a value that is not one is a 400, never a filter that silently does nothing

created_beforestring date-time

filter records created strictly before the date and time (UTC) specified. Dates without a time default to 00:00:00. ISO 8601 only — a value that is not one is a 400, never a filter that silently does nothing

status'initiated' | 'inbound_submitted' | 'holding' | 'outbound_submitted' | 'succeeded' | 'failed' | 'refunding_payer' | 'refunded' | 'failed_late_return'

filter payments by lifecycle status

payee_idstring

filter payments to a single payee, by its pe_ id

Headers

Authorizationstring required

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

Response

Successfully listed payee payments

idunknown required
typestring required

the object type

Example response

{
  "type": "array",
  "data": [
    {
      "id": "pp_123xyz",
      "type": "payee_payment",
      "payer_account_id": "payer_123xyz",
      "amount": 91000,
      "currency": "usd",
      "status": "succeeded",
      "payment_type": "ach",
      "payee_id": "pe_abc123",
      "funding_bank_account_id": "ba_fund456",
      "receiving_bank_account_id": "ba_recv123",
      "debits_at": "2026-01-01T12:00:00Z",
      "deposits_at": "2026-01-04T12:00:00Z",
      "description": "Invoice 4021",
      "fees": [
        {
          "type": "processing_fee",
          "amount": 1000
        }
      ],
      "transfers": [
        {
          "id": "ptr_123",
          "direction": "inbound",
          "purpose": "principal",
          "transfer_type": "ach",
          "amount": 50000,
          "status": "settled",
          "error_code": "insufficient_funds",
          "error_description": "Insufficient funds in the account"
        }
      ],
      "metadata": {
        "invoice_id": "inv_4021"
      },
      "created_at": "2026-01-01T12:00:00Z",
      "updated_at": "2026-01-05T12:00:00Z"
    }
  ],
  "page_info": {
    "start_cursor": "WyIyMDIyLTAyLTA4IDIwOjAxOjU4LjEyMDIzMjAwMCIsIjU5ZTFjNGI1LWFlOWQtNDIyZC04MTVkLWNjNzQ5NzdlYmFjYSJd",
    "end_cursor": "WyIyMDIyLTAyLTA4IDE5OjUyOjM3LjEwNDE3MzAwMCIsIjY4MDliYTU5LTYxYjctNDg3MS05YWFiLWE2Y2MyNmY3M2M1ZCJd"
  }
}

Changes

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