---
title: "Retrieve payment intent (publishable)"
method: GET
path: "/publishable/payment_links/intents/{publishable_key}/"
tags: ["Payments"]
---

# Retrieve payment intent (publishable)

`GET /publishable/payment_links/intents/{publishable_key}/`

## Request

- Base URL: `https://api.piriod.com`
- URL: `https://api.piriod.com/publishable/payment_links/intents/{publishable_key}/`
- Auth: API key in header `Authorization`
- TypeScript: <https://skmtc.dev/piriod/apis/piriod-api/docs/publishable/payment_links/intents/:publishable_key/get.ts> (a function with typed inputs; its response is checked against the schema)

## Response `200`

The intent.

- PaymentIntent: Customer's intent to pay against a `PaymentLink`. Drives the checkout flow (authorize → capture → finalize).
  - `publishable_key` string
  - `amount` number, required
  - `gateway` string, required: Gateway ID.
  - `link` integer, required: Payment-link ID.
  - `customer` object: Free-form customer data captured during checkout.
  - `metadata` object
  - `return_url` string, uri, nullable
  - `authorization_url` string, uri, nullable
  - `status` 'failed' | 'pending' | 'succeeded'
  - `status_description` string, nullable
  - `status_reason` string, nullable
  - `created` string, date-time
  - `updated` string, date-time

## Other responses

- `404`: Resource not found.

---

[API](https://skmtc.dev/piriod/apis/piriod-api.md) - [All operations](https://skmtc.dev/piriod/apis/piriod-api/llms.txt) - [OpenAPI document](https://skmtc.dev/piriod/apis/piriod-api/revisions/70cbc827dc7b?raw)