Payee Payments

Get a Payee Payment

Retrieve a payee payment, including its fees and ACH legs.

get/payables/payer_accounts/{payer_id}/payee_payments/{id}

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.

idstring required

the id of the resource

Headers

Authorizationstring required

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

Response

Successfully retrieved the payee payment

idstring required

the object id, also found in the data object

typestring required

the object type

page_infounknown required

Example response

{
  "id": "prefix_xyz (same as id of data object)",
  "type": "payee_payment",
  "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"
  }
}

Changes

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