Skip to content

Get payment by ID

Request

Retrieve a single payment for the location.

Security
PartnerApiKey and PartnerOAuth
Path
paymentIdinteger, (int64)required

Payment ID

Example:42
accountIdinteger, (int64)required

Account identifier

locationIdinteger, (int64)required

Location identifier

curl -i -X GET \
  'https://api-docs.lobbie.com/_mock/openapi/partner/v2/account/{accountId}/location/{locationId}/payment/42' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'x-api-key: YOUR_API_KEY_HERE'

Responses

Payment found

Bodyapplication/json
amountobject(Money)

Monetary amount

idinteger, (int64)

Payment ID

Example:1234
invoiceIdinteger, (int64)

Invoice ID this payment is associated with, if any. May be null for V1 recurring/subscription payments not tied to a single invoice — in that case it is backfilled from the recurring payment's originating invoice when one exists, and subscriptionId provides the correlation key otherwise.

Example:1234
locationIdinteger, (int64)

Location ID for invoice lookups. Resolved from the associated invoice when present, otherwise from the recurring payment (subscription) this payment belongs to. May be null only for legacy V1 payments with neither association.

Example:55
patientIdinteger, (int64)

Patient ID. May be null for legacy payments where a patient association is not resolvable.

Example:1234
paymentAttemptIdinteger, (int64)

Payment attempt ID linked to this payment

Example:1234
postedOnstring, (date-time)

Payment posted timestamp (UTC)

Example:"2025-01-15T14:00:00Z"
purchaseOrderIdinteger, (int64)

Purchase order ID from the invoice, if any

Example:1234
subscriptionIdinteger, (int64)

Recurring payment (subscription) ID this payment belongs to, if any. For V2 this is the invoice's subscription ID; for V1 this is the recurring payment ID. Populated when the payment is part of a recurring schedule.

Example:555
surchargeAmountobject(Money)

Monetary amount

surchargeRatenumber

Surcharge rate (decimal), if any

Example:0.025
Response
{
  "amount": {
    "amount": 50,
    "currency": "USD"
  },
  "id": 1234,
  "invoiceId": 1234,
  "locationId": 55,
  "patientId": 1234,
  "paymentAttemptId": 1234,
  "postedOn": "2025-01-15T14:00:00Z",
  "purchaseOrderId": 1234,
  "subscriptionId": 555,
  "surchargeAmount": {
    "amount": 50,
    "currency": "USD"
  },
  "surchargeRate": 0.025
}