Retrieve a PaymentIntent

Retrieve a PaymentIntent resource by ID.

A PaymentIntent can be retrieved from the client side using a public API key when the client_secret is passed via query string.

---

Endpoint

GET /payment_intents/:id

Sample code

curl

curl --location 'https://api.payrexhq.com/payment_intents/pi_xxx' \
  -u replace_with_secret_api_key:

Node

const client = require('payrex-node')('insert your PayRex Secret API key.');

const paymentIntent = await client.paymentIntents.retrieve('replace with a payment intent ID');

PHP

$client = new \Payrex\PayrexClient('insert your PayRex Secret API key.');

$paymentIntent = $client->paymentIntents->retrieve('replace with a payment intent ID');

Python

from payrex import Client as PayrexClient

client = PayrexClient('insert your PayRex Secret API key.')

payment_intent = client.payment_intents.retrieve('replace with a payment intent ID')

Ruby

client = Payrex::Client.new("insert your PayRex Secret API key.")

payment_intent = client.payment_intents.retrieve("replace with a payment intent ID")

Parameters

client_secret REQUIRED IF YOU USE A PUBLIC KEY.

The client secret of the PaymentIntent. This attribute is required it if you authenticate with the endpoint using your public key. This endpoint is used by PayRexJS using the public key.

Returns

Returns a PaymentIntent resource.