# Retrieve an outbound payment

Operation ID: `getOutboundPayment`

Group: Accounting › Outbound Payments

[Open in the interactive reference](https://docs.api.lensing.ai/lensing/v1/endpoints/getOutboundPayment)

`GET /accounting/outbound-payments/{id}`

Read-only: Reads and returns; changes nothing.

Retrieves an outbound payment. Use the outbound payment's id, not its outboundPaymentNumber.

An outbound payment has one or more lines. The response includes the lines, which GET accounting/outbound-payments doesn't return.

POST accounting/outbound-payments/search returns the same record for each match.

## Parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `Api-Version` | header | string · v1 | yes | The API version this request targets, named by its public identifier. Required on every request; omitting it, or naming a version this company does not have, is answered with 400. This document describes version `v1`. |
| `id` | path | string | yes | The unique identifier of the outbound payment you want to retrieve. Example: `"3b7d5e9c-1a24-4f80-9c6d-2e8f70b13a45"`. |

## Response

`200` Success

Under `data` (getOutboundPaymentOutput):

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `id` | string | yes | The unique identifier for the outbound payment. |
| `outboundPaymentNumber` | string | no | The outbound payment number. Absent until a number has been assigned. |
| `description` | string | no | A description of the payment. |
| `paymentDate` | date | yes | The date the payment was made. Format YYYY-MM-DD. |
| `paymentCurrency` | string | yes | The currency the payment is denominated in. Format ISO 4217, for example 'USD'. Governs totalPaid, appliedAmount and unappliedAmount. |
| `paymentType` | string | yes | How the money was sent, for example 'ach', 'wire' or 'check'. |
| `status` | string | yes | The processing status of the payment. |
| `approvalStatus` | string | no | Where the payment sits in the approval workflow. |
| `applicationStatus` | string | no | How much of the payment has been applied to bills. Values include 'unapplied', 'partiallyApplied' and 'applied'. |
| `totalPaid` | decimal | no | The total amount paid, in the payment currency. |
| `appliedAmount` | decimal | no | The portion already applied against vendor bills, in the payment currency. |
| `unappliedAmount` | decimal | no | The portion not yet applied to any bill, in the payment currency. |
| `bankCurrency` | string | no | The currency of the bank account the money left, when it differs from the payment currency. Format ISO 4217, for example 'USD'. |
| `paymentId` | string | no | The payment reference assigned by the bank or payment provider. |
| `externalId` | string | no | The identifier this payment has in the upstream system that produced it. It is not unique. |
| `externalUrl` | string | no | A link to the payment in an external system, when one is stored. |
| `origin` | string | no | The source system this payment came from. Recorded when an integration created the payment. |
| `singlePayment` | boolean | no | Whether the payment covers a single bill rather than a batch. |
| `paymentAccountId` | string | no | The bank general ledger account the money left. See id on GET accounting/accounts/:id. |
| `paymentAccountName` | string | no | The name of the bank general ledger account the money left. |
| `entityId` | string | no | The legal entity that made the payment. See id on GET base/entities. |
| `entityName` | string | no | The name of the legal entity that made the payment. |
| `lastModifiedDate` | date-time | yes | The date and time the payment last changed, in UTC. Format YYYY-MM-DDTHH:mm:ss.sssZ. |
| `lines` | array<object> | no | The payment lines, one per payee or bill covered. An empty array when the payment has none. |
| `lines[].id` | string | yes | The unique identifier for the line. |
| `lines[].lineNumber` | string | no | The line number. |
| `lines[].description` | string | yes | A description of the line. |
| `lines[].amount` | decimal | no | The amount paid on this line, in the line currency. |
| `lines[].currency` | string | yes | The currency for the line. Format ISO 4217, for example 'USD'. |
| `lines[].paymentDate` | date | no | The date this line was paid, when it differs from the header. Format YYYY-MM-DD. |
| `lines[].paymentType` | string | no | How this line was sent, for example 'ach', 'wire' or 'check'. |
| `lines[].receiverName` | string | yes | The name of the payee. |
| `lines[].receiverAccount` | string | no | The payee bank account number. It is returned here and on search but never on the collection endpoint and never filterable. |
| `lines[].receiverBankCode` | string | no | The payee sort or routing code. It is returned here and on search but never on the collection endpoint and never filterable. |
| `lines[].customReference` | string | no | A reference you supplied, carried on the line. |

```json
{
  "data": {
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "outboundPaymentNumber": "<outboundPaymentNumber>",
    "description": "<description>",
    "paymentDate": "2026-01-15",
    "paymentCurrency": "<paymentCurrency>",
    "paymentType": "<paymentType>",
    "status": "<status>",
    "approvalStatus": "<approvalStatus>",
    "applicationStatus": "<applicationStatus>",
    "totalPaid": "19.99",
    "appliedAmount": "19.99",
    "unappliedAmount": "19.99",
    "bankCurrency": "<bankCurrency>",
    "paymentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "externalId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "externalUrl": "<externalUrl>",
    "origin": "<origin>",
    "singlePayment": true,
    "paymentAccountId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "paymentAccountName": "<paymentAccountName>",
    "entityId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "entityName": "<entityName>",
    "lastModifiedDate": "2026-01-15T09:30:00.000Z",
    "lines": [
      {
        "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "lineNumber": "<lineNumber>",
        "description": "<description>",
        "amount": "19.99",
        "currency": "<currency>",
        "paymentDate": "2026-01-15",
        "paymentType": "<paymentType>",
        "receiverName": "<receiverName>",
        "receiverAccount": "<receiverAccount>",
        "receiverBankCode": "<receiverBankCode>",
        "customReference": "<customReference>"
      }
    ]
  },
  "diagnostics": [
    {
      "code": "<code>",
      "message": "<message>",
      "severity": "error",
      "path": [
        "<path>"
      ],
      "details": "<details>"
    }
  ]
}
```

## Errors

| Code | Status |
| --- | --- |
| `NOT_FOUND` | 400 |

## Statuses

- `400` — Invalid request or business failure. Codes: NOT_FOUND
- `401` — The request carries no valid access token.
- `403` — Not authorized
- `404` — Not found
- `429` — Too many requests from this client address. The response has no body and no `Retry-After` header.
- `500` — Internal server error