Skip to content

List payment attempts

Request

Retrieve payment attempts for the location using cursor pagination. Optional filters: status, invoice ID, purchase order ID, patient ID, and createdOn bounds (startDate, endDate, ISO-8601 inclusive).

Security
PartnerApiKey and PartnerOAuth
Path
accountIdinteger, (int64)required

Account identifier

locationIdinteger, (int64)required

Location identifier

Query
statusstring

Filter by payment attempt status

Enum:"PENDING""SUCCEEDED""FAILED""CANCELED"
Example:status=PENDING
invoiceIdinteger, (int64)

Filter by invoice ID

Example:invoiceId=1001
orderIdinteger, (int64)

Filter by purchase order ID linked to the invoice

Example:orderId=2002
patientIdinteger, (int64)

Filter by patient ID

Example:patientId=3003
startDatestring

Inclusive lower bound on createdAt (ISO-8601 datetime, e.g. UTC)

Example:startDate=2025-01-01T00:00:00Z
endDatestring

Inclusive upper bound on createdAt (ISO-8601 datetime, e.g. UTC)

Example:endDate=2025-12-31T23:59:59Z
sortBystring(?i)(CREATED_DATE|AMOUNT)

Sort by field

Default:"CREATED_DATE"
Enum:"CREATED_DATE""AMOUNT"
sortDirstring(?i)(ASC|DESC)

Sort direction

Default:"DESC"
Enum:"ASC""DESC"
cursorstring, [ 0 .. 2048 ] characters

Pagination cursor from previous response

limitinteger, (int32), [ 1 .. 1000 ]

Number of results per page (max 1000)

Default:20
Example:limit=20
curl -i -X GET \
  'https://api-docs.lobbie.com/_mock/openapi/partner/v2/account/{accountId}/location/{locationId}/payment-attempt?status=PENDING&invoiceId=1001&orderId=2002&patientId=3003&startDate=2025-01-01T00%3A00%3A00Z&endDate=2025-12-31T23%3A59%3A59Z&sortBy=CREATED_DATE&sortDir=ASC&cursor=string&limit=20' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'x-api-key: YOUR_API_KEY_HERE'

Responses

Payment attempts retrieved successfully

Bodyapplication/json
nextCursorstring

Opaque cursor for the next page. Null if no more results.

paymentAttemptsArray of objects(PaymentAttemptDTO)

Payment attempts in this page

Response
{
  "nextCursor": "string",
  "paymentAttempts": [
    { … }
  ]
}