Payment Intents

Payment Intents help you manage the process of collecting payments from your customers. We recommend creating one Payment Intent per order or customer session in your system. This allows you to track the payment history for a specific session.

Throughout its lifecycle, a Payment Intent moves through various statuses as it interacts with Paytree to handle authentication steps and, ultimately, to complete a successful charge, if applicable.

Create Payment Intent

This method creates a new Payment Intent, which initiates the payment process for a customer, allowing you to collect payment details and manage the payment flow.

When creating a new payment intent request, you can pass the following identifiers used in callbacks to correlate our transaction with your local records.

• transaction_ref - Unique transaction reference from your system, for example, an Order ID. Any requests with a previously used transaction_ref will be rejected.

• client_ref - Unique identifier used to reference your client, this can be your customer ID or email address for example.

• callback_url - A callback url where requests will be made every time a status change is triggered.

POST/v1/transaction/payment_intent/

Authorization

tokenAuthjwtAuth

Body

application/jsonapplication/x-www-form-urlencodedmultipart/form-data

transaction_refstring

client_ref*string

amount*string (decimal)

Pattern: ^-?\d{0,8}(?:\.\d{0,2})?$

amount_currency*AmountCurrencyEnum (enum)

• EUR - EUR €
• GBP - GBP £
• USD - USD $

EURGBPUSD

methodall of

customer*Customer (object)

address*Address (object)

session*Session (object)

callback*Callback (object)

Response

201

The created payment intent

Body

application/json

id*integer

client_ref*string

payment_link*string (uri)

Request

JavaScriptCurlPythonHTTP

const response = await fetch('/v1/transaction/payment_intent/', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "address": {
        "country": "AF"
      },
      "amount": "text",
      "amount_currency": "EUR",
      "callback": {},
      "client_ref": "text",
      "customer": {
        "email": "[e-mail]",
        "first_name": "text",
        "last_name": "text"
      },
      "session": {
        "ip_address": "text"
      }
    }),
});
const data = await response.json();

Response

201

{
  "id": 0,
  "client_ref": "text",
  "payment_link": "https://example.com"
}

Get all Payment Intents

This method retrieves a list of all Payment Intents in your account, providing an overview of all payment sessions and their current statuses, useful for tracking multiple payments.

GET/v1/transaction/payment_intent/

Authorization

tokenAuthjwtAuth

Query parameters

Response

200

Body

application/json

count*integer

Example: 123

nextnullable string (uri)

Example: "http://api.example.org/accounts/?page=4"

previousnullable string (uri)

Example: "http://api.example.org/accounts/?page=2"

results*array of PaymentIntent (object)

Request

JavaScriptCurlPythonHTTP

const response = await fetch('/v1/transaction/payment_intent/', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

{
  "count": 123,
  "next": "http://api.example.org/accounts/?page=4",
  "previous": "http://api.example.org/accounts/?page=2",
  "results": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "transaction_ref": "text",
      "client_ref": "text",
      "first_name": "text",
      "last_name": "text",
      "email": "[e-mail]",
      "phone": "text",
      "amount": "text",
      "currency": "text",
      "method": "card",
      "payment_link": "text",
      "payment": [
        {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "amount": "text",
          "refunded": "text",
          "currency": "text",
          "status": "pending",
          "payment_intent": "123e4567-e89b-12d3-a456-426614174000",
          "created": "2025-01-22T19:11:36.330Z"
        }
      ],
      "created": "2025-01-22T19:11:36.330Z"
    }
  ]
}

Get Payment Intent

This method fetches detailed information about a specific Payment Intent by its unique identifier, allowing you to retrieve the latest payment status and related details for a particular payment.

GET/v1/transaction/payment_intent/{id}/

Authorization

tokenAuthjwtAuth

Path parameters

id*string

Response

200

Body

application/json

id*string (uuid)

transaction_ref*string

client_ref*string

first_namenullable string

last_namenullable string

emailnullable string (email)

phonenullable string

amount*string (decimal)

Pattern: ^-?\d{0,6}(?:\.\d{0,2})?$

currency*string

methodMethodEnum (enum)

• card - Card
• crypto - Crypto
• wire - Wire

cardcryptowire

payment_link*string

payment*array of Payment (object)

created*string (date-time)

Request

JavaScriptCurlPythonHTTP

const response = await fetch('/v1/transaction/payment_intent/{id}/', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "transaction_ref": "text",
  "client_ref": "text",
  "first_name": "text",
  "last_name": "text",
  "email": "[e-mail]",
  "phone": "text",
  "amount": "text",
  "currency": "text",
  "method": "card",
  "payment_link": "text",
  "payment": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "amount": "text",
      "refunded": "text",
      "currency": "text",
      "status": "pending",
      "payment_intent": "123e4567-e89b-12d3-a456-426614174000",
      "created": "2025-01-22T19:11:36.330Z"
    }
  ],
  "created": "2025-01-22T19:11:36.330Z"
}