List payment requests

GET/v3/payment_requests

Lists your payment requests, newest first, for reconciliation. Paginate with limit + offset; has_more indicates whether another page exists.

Query ParametersExpand Collapse

limit: optional number

Max results to return (default 20, max 100).

minimum1

maximum100

offset: optional number

Number of results to skip.

minimum0

status: optional "requested" or "succeeded" or "canceled" or "expired"

Filter by lifecycle status.

One of the following:

"requested"

"succeeded"

"canceled"

"expired"

ReturnsExpand Collapse

data: array of PaymentRequest { id, amount, checkout_url, 9 more }

id: string

Unique identifier of the payment request.

formatuuid

amount: number

Amount in the currency’s minor units.

formatint64

checkout_url: string

URL the recipient opens to pay: https://zero.linqapp.com/pay/{slug}?session=..., where {slug} is your partner checkout slug.

created_at: string

formatdate-time

currency: string

object: string

status: "requested" or "succeeded" or "canceled" or "expired"

Lifecycle status of the payment request.

One of the following:

"requested"

"succeeded"

"canceled"

"expired"

description: optional string

expires_at: optional string

When an unpaid request auto-expires.

formatdate-time

metadata: optional map[string]

paid_at: optional string

When the request was paid. Absent until it succeeds.

formatdate-time

updated_at: optional string

formatdate-time

has_more: boolean

Whether more results exist beyond this page.

object: "list"

List payment requests

curl https://api.linqapp.com/api/partner/v3/payment_requests \
    -H "Authorization: Bearer $LINQ_API_V3_API_KEY"

{
  "data": [
    {
      "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
      "amount": 497,
      "checkout_url": "https://zero.linqapp.com/pay/tomo?session=tok_abc123",
      "created_at": "2019-12-27T18:11:19.117Z",
      "currency": "usd",
      "object": "payment_request",
      "status": "requested",
      "description": "description",
      "expires_at": "2019-12-27T18:11:19.117Z",
      "metadata": {
        "foo": "string"
      },
      "paid_at": "2019-12-27T18:11:19.117Z",
      "updated_at": "2019-12-27T18:11:19.117Z"
    }
  ],
  "has_more": true,
  "object": "list"
}

{
  "error": {
    "status": 401,
    "code": 2004,
    "message": "Unauthorized - missing or invalid authentication token",
    "doc_url": "https://docs.linqapp.com/error/codes/2xxx/2004/"
  },
  "success": false
}

{
  "error": {
    "status": 403,
    "code": 2005,
    "message": "Access denied - insufficient permissions for this resource",
    "doc_url": "https://docs.linqapp.com/error/codes/2xxx/2005/"
  },
  "success": false
}

{
  "error": {
    "status": 500,
    "code": 3006,
    "message": "Internal server error",
    "doc_url": "https://docs.linqapp.com/error/codes/3xxx/3006/"
  },
  "success": false
}

Returns Examples

{
  "data": [
    {
      "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
      "amount": 497,
      "checkout_url": "https://zero.linqapp.com/pay/tomo?session=tok_abc123",
      "created_at": "2019-12-27T18:11:19.117Z",
      "currency": "usd",
      "object": "payment_request",
      "status": "requested",
      "description": "description",
      "expires_at": "2019-12-27T18:11:19.117Z",
      "metadata": {
        "foo": "string"
      },
      "paid_at": "2019-12-27T18:11:19.117Z",
      "updated_at": "2019-12-27T18:11:19.117Z"
    }
  ],
  "has_more": true,
  "object": "list"
}

{
  "error": {
    "status": 401,
    "code": 2004,
    "message": "Unauthorized - missing or invalid authentication token",
    "doc_url": "https://docs.linqapp.com/error/codes/2xxx/2004/"
  },
  "success": false
}

{
  "error": {
    "status": 403,
    "code": 2005,
    "message": "Access denied - insufficient permissions for this resource",
    "doc_url": "https://docs.linqapp.com/error/codes/2xxx/2005/"
  },
  "success": false
}

{
  "error": {
    "status": 500,
    "code": 3006,
    "message": "Internal server error",
    "doc_url": "https://docs.linqapp.com/error/codes/3xxx/3006/"
  },
  "success": false
}