Retrieve a Session

GET 
/checkout/sessions/:session_id

Returns a Session.

Request

Path Parameters

session_id uuidrequired

Possible values: <= 36 characters, Value must match regular expression ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$

Session's ID

Responses

200

Session retrieved

application/json

Schema

Schema

status string

Possible values: [success]

data

object

Session

id uuid

Possible values: <= 36 characters, Value must match regular expression ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$

UUID v4

merchant_id uuid

Possible values: <= 36 characters, Value must match regular expression ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$

UUID v4

customer_id uuidnullable

Possible values: <= 36 characters, Value must match regular expression ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$

UUID v4

payment_method_id uuidnullable

Possible values: <= 36 characters, Value must match regular expression ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$

UUID v4

checkout_url uri

The URL to where the customer should be redirected to complete the payment.

status string

Possible values: [open, complete, expired]

payment_status string

Possible values: [in_progress, requires_extra_action, failed, paid, unpaid, no_payment_required]

total_amount

object

Money representation

value MoneyAmount (integer)required

Possible values: <= 9999999999

Amount expressed in cents. 1 USD should be submitted as 100 cents

currency /[A-Z]{3}/required

ISO 4217 representation of the currency

client_reference_id stringnullable

ID provided by merchant to associate the session with merchants' own system.

success_url urinullable

The URL the customer will be redirected to when the payment succeeds.

cancel_url urinullable

The URL the customer will be redirected to when the payment is cancelled by the customer.

expires_at Unix timestampnullable

Unix timestamp representing the date

description stringnullable

Description of the session.

metadata

object

A metadata object containing key-value pairs. Keys must be strings, and values are strings. The object can also be empty.

property name* string

created_on Unix timestamp

Unix timestamp representing the date

code integer

Possible values: [200]

message string

Possible values: [Successful request]

Example (from schema)

{
  "status": "success",
  "data": {
    "id": "ec7e1848-dc80-4ab0-8827-dd7fc0737b43",
    "merchant_id": "ec7e1848-dc80-4ab0-8827-dd7fc0737b43",
    "customer_id": "ec7e1848-dc80-4ab0-8827-dd7fc0737b43",
    "payment_method_id": "ec7e1848-dc80-4ab0-8827-dd7fc0737b43",
    "checkout_url": "string",
    "status": "open",
    "payment_status": "in_progress",
    "total_amount": {
      "value": 99,
      "currency": "USD"
    },
    "client_reference_id": "string",
    "success_url": "string",
    "cancel_url": "string",
    "expires_at": 1656656767,
    "description": "string",
    "metadata": {},
    "created_on": 1656656767
  },
  "code": 200,
  "message": "Successful request"
}

401

Access token is missing or invalid

403

Access denied

404

Session not found

application/json

Schema

Schema

status string

Possible values: [not found]

code integer

Possible values: [404]

message string

Failure reason

Example (from schema)

{
  "status": "not found",
  "code": 404,
  "message": "Entity not found"
}

409

Failure due to a conflict in the provided entity

application/json

Schema

Schema

status string

Possible values: [fail]

code integer

Possible values: [409]

message string

Failure reason

Example (from schema)

{
  "status": "fail",
  "code": 409,
  "message": "Entity with Id already exists"
}

500

Server error

Loading...