Skip to main content
GET
/
v1
/
payments
/
{id}
Get payment
curl --request GET \
  --url https://api.quentli.com/v1/payments/{id} \
  --header 'Authorization: Bearer <token>'
{
  "id": "p_1234567890abcdefghij",
  "createdAt": "2025-01-15T18:30:00.000Z",
  "updatedAt": "2025-01-15T18:30:00.000Z",
  "amount": 150000,
  "currency": "MXN",
  "description": "Colegiatura Enero 2025",
  "type": "CARD",
  "status": "COMPLETE",
  "isCompleted": true,
  "paymentTime": "2025-01-15T18:30:00.000Z",
  "customerId": "cus_1234567890abcdefghij",
  "organizationId": "org_1234567890abcdefghij",
  "skipTaxInvoice": false,
  "items": [
    {
      "description": "<string>",
      "amount": 123,
      "currency": "<string>",
      "quantity": 123,
      "conceptId": "<string>",
      "concept": {
        "id": "<string>",
        "displayName": "<string>",
        "description": "<string>",
        "createdAt": "2023-11-07T05:31:56Z",
        "updatedAt": "2023-11-07T05:31:56Z"
      }
    }
  ],
  "paymentMethodId": "pm_1234567890abcdefghij",
  "metadata": null,
  "meta": null
}

Authorizations

​
Authorization
string
header
required

Organization API key using Authorization: Bearer sk_....

Path Parameters

​
id
string
required

Identifier of the payment.

Response

object | null

Payment details

Payment details response. Returns null if the payment does not exist.

​
id
string
required

Unique identifier of the payment.

Example:

"p_1234567890abcdefghij"

​
createdAt
string<date-time>
required

When the payment record was created.

Example:

"2025-01-15T18:30:00.000Z"

​
updatedAt
string<date-time>
required

When the payment was last updated.

Example:

"2025-01-15T18:30:00.000Z"

​
amount
number
required

Payment amount in minor currency units.

Example:

150000

​
currency
string
required

ISO 4217 currency code.

Example:

"MXN"

​
description
string | null
required

Human-readable description of the payment.

Example:

"Colegiatura Enero 2025"

​
type
enum<string> | null
required

Payment type.

Available options:
TRANSFER,
CARD,
OXXO,
OTHER,
CASH,
DIRECT_DEBIT,
null
Example:

"CARD"

​
status
enum<string> | null
required

Current payment status.

Available options:
INCOMPLETE,
COMPLETE,
CANCELED,
INITIATED,
REFUNDED,
DISPUTED,
REVERTED,
null
Example:

"COMPLETE"

​
isCompleted
boolean
required

Whether the payment has been fully settled.

Example:

true

​
paymentTime
string<date-time> | null
required

Date and time when the payment was completed.

Example:

"2025-01-15T18:30:00.000Z"

​
customerId
string
required

Identifier of the customer who made the payment.

Example:

"cus_1234567890abcdefghij"

​
organizationId
string
required

Identifier of the owning organization.

Example:

"org_1234567890abcdefghij"

​
skipTaxInvoice
boolean
required

Whether tax invoice generation is skipped for this payment.

Example:

false

​
items
object[]
required
​
paymentMethodId
string | null

Identifier of the payment method used, if any.

Example:

"pm_1234567890abcdefghij"

​
metadata
object[] | null

Structured metadata entries.

Example:

null

​
meta
object

Flattened metadata key-value map.

Example:

null