Get payment session

curl --request GET \
  --url https://apiv2.example.com/payment-sessions/{paymentSessionId} \
  --header 'X-Api-Key: <api-key>'

const options = {method: 'GET', headers: {'X-Api-Key': '<api-key>'}};

fetch('https://apiv2.example.com/payment-sessions/{paymentSessionId}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://apiv2.example.com/payment-sessions/{paymentSessionId}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "X-Api-Key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://apiv2.example.com/payment-sessions/{paymentSessionId}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("X-Api-Key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://apiv2.example.com/payment-sessions/{paymentSessionId}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["X-Api-Key"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "paymentSessionId": "d2e3f4a5-b6c7-8901-2345-012345678901",
  "orderId": "e3f4a5b6-c7d8-9012-3456-123456789012",
  "paymentProvider": "STRIPE",
  "savePaymentProfile": true,
  "hostedUrl": "https://payments.example.com/checkout/d2e3f4a5-b6c7-8901-2345-012345678901",
  "status": "PENDING",
  "metadata": {
    "source": "mobile_app",
    "campaign": "summer_2024"
  },
  "createdAt": "2024-09-29T10:00:00Z",
  "updatedAt": "2024-09-29T10:30:00Z",
  "paymentProfileId": "f4a5b6c7-d8e9-0123-4567-234567890123",
  "returnUrl": "https://example.com/order/confirmation",
  "cancelUrl": "https://example.com/order/checkout"
}

{
  "message": "<string>",
  "code": "<string>",
  "details": [
    {
      "message": "<string>",
      "code": "<string>",
      "property": "<string>",
      "suggestion": "<string>"
    }
  ],
  "hint": "<string>"
}

{
  "message": "<string>",
  "code": "<string>",
  "details": [
    {
      "message": "<string>",
      "code": "<string>",
      "property": "<string>",
      "suggestion": "<string>"
    }
  ],
  "hint": "<string>"
}

{
  "message": "<string>",
  "code": "<string>",
  "details": [
    {
      "message": "<string>",
      "code": "<string>",
      "property": "<string>",
      "suggestion": "<string>"
    }
  ],
  "hint": "<string>"
}

{
  "message": "<string>",
  "code": "<string>",
  "details": [
    {
      "message": "<string>",
      "code": "<string>",
      "property": "<string>",
      "suggestion": "<string>"
    }
  ],
  "hint": "<string>"
}

{
  "message": "<string>",
  "code": "<string>",
  "details": [
    {
      "message": "<string>",
      "code": "<string>",
      "property": "<string>",
      "suggestion": "<string>"
    }
  ],
  "hint": "<string>"
}

GET

payment-sessions

{paymentSessionId}

Get payment session

curl --request GET \
  --url https://apiv2.example.com/payment-sessions/{paymentSessionId} \
  --header 'X-Api-Key: <api-key>'

const options = {method: 'GET', headers: {'X-Api-Key': '<api-key>'}};

fetch('https://apiv2.example.com/payment-sessions/{paymentSessionId}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://apiv2.example.com/payment-sessions/{paymentSessionId}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "X-Api-Key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://apiv2.example.com/payment-sessions/{paymentSessionId}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("X-Api-Key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://apiv2.example.com/payment-sessions/{paymentSessionId}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["X-Api-Key"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "paymentSessionId": "d2e3f4a5-b6c7-8901-2345-012345678901",
  "orderId": "e3f4a5b6-c7d8-9012-3456-123456789012",
  "paymentProvider": "STRIPE",
  "savePaymentProfile": true,
  "hostedUrl": "https://payments.example.com/checkout/d2e3f4a5-b6c7-8901-2345-012345678901",
  "status": "PENDING",
  "metadata": {
    "source": "mobile_app",
    "campaign": "summer_2024"
  },
  "createdAt": "2024-09-29T10:00:00Z",
  "updatedAt": "2024-09-29T10:30:00Z",
  "paymentProfileId": "f4a5b6c7-d8e9-0123-4567-234567890123",
  "returnUrl": "https://example.com/order/confirmation",
  "cancelUrl": "https://example.com/order/checkout"
}

{
  "message": "<string>",
  "code": "<string>",
  "details": [
    {
      "message": "<string>",
      "code": "<string>",
      "property": "<string>",
      "suggestion": "<string>"
    }
  ],
  "hint": "<string>"
}

{
  "message": "<string>",
  "code": "<string>",
  "details": [
    {
      "message": "<string>",
      "code": "<string>",
      "property": "<string>",
      "suggestion": "<string>"
    }
  ],
  "hint": "<string>"
}

{
  "message": "<string>",
  "code": "<string>",
  "details": [
    {
      "message": "<string>",
      "code": "<string>",
      "property": "<string>",
      "suggestion": "<string>"
    }
  ],
  "hint": "<string>"
}

{
  "message": "<string>",
  "code": "<string>",
  "details": [
    {
      "message": "<string>",
      "code": "<string>",
      "property": "<string>",
      "suggestion": "<string>"
    }
  ],
  "hint": "<string>"
}

{
  "message": "<string>",
  "code": "<string>",
  "details": [
    {
      "message": "<string>",
      "code": "<string>",
      "property": "<string>",
      "suggestion": "<string>"
    }
  ],
  "hint": "<string>"
}

Authorizations

X-Api-Key

string

header

required

An API key that grants access to the Connect API. You can create and manage API keys in the portal.

Path Parameters

paymentSessionId

string

required

The unique identifier of the payment session to retrieve.

Response

Payment session retrieved successfully

A payment session that wraps the payment process and collects payment information from the user for a specific order.

paymentSessionId

string

required

The unique identifier for this payment session.

Example:

"d2e3f4a5-b6c7-8901-2345-012345678901"

orderId

string

required

The unique identifier of the order this payment session is for.

Example:

"e3f4a5b6-c7d8-9012-3456-123456789012"

paymentProvider

enum<string>

required

Payment service provider that processes the transaction.

Available options:

STRIPE,

BILLOGRAM

Example:

"STRIPE"

savePaymentProfile

boolean

required

Whether to save the payment profile for future use. Only applicable if the customer is authenticated or for the initial order. Defaults to false.

Example:

true

hostedUrl

string<uri>

required

The hosted checkout page to redirect the customer to in order to complete payment.

Example:

"https://payments.example.com/checkout/d2e3f4a5-b6c7-8901-2345-012345678901"

status

enum<string>

required

Current status of a payment session lifecycle.

Available options:

PENDING,

REQUIRES_ACTION,

COMPLETED,

FAILED,

CANCELED,

EXPIRED

Example:

"PENDING"

metadata

object

required

Custom key-value pairs for additional payment session information.

Show child attributes

Example:

{
  "source": "mobile_app",
  "campaign": "summer_2024"
}

createdAt

string<date-time>

required

When this payment session was created.

Example:

"2024-09-29T10:00:00Z"

updatedAt

string<date-time>

required

When this payment session was last updated.

Example:

"2024-09-29T10:30:00Z"

paymentProfileId

string

The saved payment method to use for this payment (for returning customers).

Example:

"f4a5b6c7-d8e9-0123-4567-234567890123"

returnUrl

string

The URL the customer is redirected to after payment completion.

Example:

"https://example.com/order/confirmation"

cancelUrl

string

The URL the customer is redirected to if they cancel the payment.

Example:

"https://example.com/order/checkout"

Getting started

Guides

Overview

API reference

Get payment session

Authorizations

Path Parameters

Response