Skip to main content
GET
Payment Method Session - Retrieve

Path Parameters

id
string
required

The unique identifier for the Payment Method Session

Response

The payment method session is retrieved successfully

id
string
required
Example:

"12345_pms_01926c58bc6e77c09e809964e72af8c8"

expires_at
string<date-time>
required

The iso timestamp when the session will expire Trying to retrieve the session or any operations on the session after this time will result in an error

Example:

"2023-01-18T11:04:09.922Z"

client_secret
string
required

Client Secret

Example:

"cs_9wcXDRVkfEtLEsSnYKgQ"

customer_id
string | null

The customer id for which the payment methods session is to be created

Example:

"12345_cus_01926c58bc6e77c09e809964e72af8c8"

billing
object | null
psp_tokenization
object | null

The Payment Service Provider Configuration for payment methods that are created using the payment method session

network_tokenization
object | null

The network tokenization configuration for creating the payment method session

tokenization_data
any | null

Contains data to be passed on to tokenization service ( if present ) to create token_id for given JSON data

return_url
string | null

The return url to which the user should be redirected to

Example:

"https://merchant-website.com/return"

next_action
object

Contains the url for redirection flow

authentication_details
object | null
associated_payment_methods
object[] | null

The payment method that was created using this payment method session

associated_token_id
string | null

The token-id created if there is tokenization_data present

Example:

"12345_tok_01926c58bc6e77c09e809964e72af8c8"

storage_type
enum<string> | null
Available options:
volatile,
persistent
card_cvc_token_storage
object | null