---
title: "Get received payment details"
method: GET
path: "/v3/receivable-payments/{receivedPaymentId}"
tags: ["receivable-payments"]
---

# Get received payment details

`GET /v3/receivable-payments/{receivedPaymentId}`

## Request

- Base URL: `https://gateway.stage.bill.com/connect`
- URL: `https://gateway.stage.bill.com/connect/v3/receivable-payments/{receivedPaymentId}`
- Auth: none declared

Get details about an existing received payment.

## Path parameters

- `receivedPaymentId` string, required: BILL-generated ID of the received payment. The value begins with `0rp`.

## Headers

- `sessionId` string, nullable: API session ID generated with `/v3/login`
- `devKey` string, nullable: Developer key generated with your BILL developer account

## Response `200`

Get received payment details response

- ReceivablePaymentResponseDto: Receivable Payment response.
  - `id` string: BILL-generated ID of the received payment. The value begins with `0rp`.
  - `customerId` string: BILL-generated ID of the customer. The value begins with `0cu`.
  - `invoicePayments` InvoicePay[]: List of invoice payments
    - `invoiceId` string: BILL-generated ID of the invoice to be paid. The value begins with `00e`.
    - `amount` number: Payment amount. For a payment in an international currency (not USD), this value is in the local currency.
    - `paymentDate` string, date: Invoice payment date. The value is in the `yyyy-MM-dd` format.
    - `status` 'PAID' | 'VOID' | 'SCHEDULED' | 'CANCELED' | 'INITIATED' | 'UNDEFINED': Invoice payment status.
    - `receivedPaymentId` string: BILL-generated ID of the received payment. The value begins with `0rp`. Links the invoice payment to its parent received payment.
  - `description` string: Invoice payment description. This value is included in the check memo or in the bank descriptor for electronic payments.
  - `paymentDate` string, date: Received payment date. Funds are withdrawn from the customer bank account on this date.
  - `fundingAccount` object: Customer funding account information
    - `id` string: BILL-generated ID of the customer funding account
    - `type` 'BANK_ACCOUNT' | 'CARD_ACCOUNT': Customer funding account type
    - `bankName` string: Name of the bank for the customer funding account
    - `accountNumber` string: Bank account number (masked, showing only last 4 digits). Full account number is never returned.
  - `receivablesAccount` object: Received payment funding account information
    - `id` string: BILL-generated ID of the received payment funding account
    - `type` 'BANK_ACCOUNT' | 'CARD_ACCOUNT': Received payment funding account type
    - `bankName` string: Name of the bank for the received payment account
    - `accountNumber` string: Bank account number (masked, showing only last 4 digits). Full account number is never returned.
  - `amount` number, required: Received payment amount. For a payment in an international currency (not USD), this value is in the local currency.
  - `unappliedAmount` number: Unapplied received payment amount. This value is available for an overpayment, double payment, or customer payment not currently linked to an invoice.
  - `convenienceFeeAmount` number: Convenience fee charged to the customer
  - `receivablesType` 'CASH' | 'CHECK' | 'CREDIT_CARD' | 'ACH' | 'PAYPAL' | 'OTHER' | 'WALLET' | 'VIRTUAL_CARD' | 'UNDEFINED': Received payment disbursement type.
  - `status` 'PAID' | 'VOID' | 'SCHEDULED' | 'CANCELED' | 'ESCHEATED' | 'UNDEFINED': Received payment status.
  - `referenceNumber` string: Received payment reference number
  - `onlinePayment` boolean: Information about how the received payment is recorded. * `true`: The payment is received with BILL * `false`: The payment is received outside BILL, and then recorded in BILL
  - `createdTime` string, date-time: Received payment created date and time
  - `updatedTime` string, date-time: Received payment updated date and time

## Other responses

- `4XX`: List of errors.
- `5XX`: List of errors.

## Changes

- **2026-11-03** `54edddceb0a5`: 1 breaking, 2 warning, 6 info
  - the `fundingAccount/allOf[#/components/schemas/FundingAccount]/type` response's property type changed from `string` to no type for status `200`
  - removed the optional property `fundingAccount/allOf[#/components/schemas/FundingAccount]/last4` from the response with the `200` status
  - removed the optional property `fundingAccount/allOf[#/components/schemas/FundingAccount]/name` from the response with the `200` status
  - added the optional property `fundingAccount/allOf[#/components/schemas/FundingAccount]/bankName` to the response with the `200` status
  - …5 more

[Operation history](https://skmtc.dev/bill/apis/bill-v3-api/changes/v3/receivable-payments/:receivedPaymentId/get.md)

---

[API](https://skmtc.dev/bill/apis/bill-v3-api.md) - [All operations](https://skmtc.dev/bill/apis/bill-v3-api/llms.txt) - [OpenAPI document](https://skmtc.dev/bill/apis/bill-v3-api/revisions/54edddceb0a5?raw)