Payments - Session token

Creates a session object or a session token for wallets like Apple Pay, Google Pay, etc. These tokens are used by Hyperswitch’s SDK to initiate these wallets’ SDK.

Authorizations

api-key

string

header

required

Publishable keys are a type of keys that can be public and have limited scope of usage.

Body

application/json

client_secret

string

required

This is a token which expires after 15 minutes, used from the client to authenticate and create sessions from the SDK

payment_id

string

required

The identifier for the payment

wallets

enum<string>[]

required

The list of the supported wallets

Available options:

ach,

affirm,

afterpay_clearpay,

alfamart,

ali_pay,

ali_pay_hk,

alma,

apple_pay,

atome,

bacs,

bancontact_card,

becs,

benefit,

bizum,

blik,

boleto,

bca_bank_transfer,

bni_va,

bri_va,

card_redirect,

cimb_va,

classic,

credit,

crypto_currency,

cashapp,

dana,

danamon_va,

debit,

duit_now,

efecty,

eps,

fps,

evoucher,

giropay,

givex,

google_pay,

go_pay,

gcash,

ideal,

interac,

indomaret,

klarna,

kakao_pay,

local_bank_redirect,

mandiri_va,

knet,

mb_way,

mobile_pay,

momo,

momo_atm,

multibanco,

online_banking_thailand,

online_banking_czech_republic,

online_banking_finland,

online_banking_fpx,

online_banking_poland,

online_banking_slovakia,

oxxo,

pago_efectivo,

permata_bank_transfer,

open_banking_uk,

pay_bright,

paypal,

paze,

pix,

pay_safe_card,

przelewy24,

prompt_pay,

pse,

red_compra,

red_pagos,

samsung_pay,

sepa,

sofort,

swish,

touch_n_go,

trustly,

twint,

upi_collect,

upi_intent,

vipps,

viet_qr,

venmo,

walley,

we_chat_pay,

seven_eleven,

lawson,

mini_stop,

family_mart,

seicomart,

pay_easy,

local_bank_transfer,

mifinity,

open_banking_pis,

direct_carrier_billing

merchant_connector_details

object

Merchant connector details used to make payments.

Show child attributes

merchant_connector_details.creds_identifier

string

required

Creds Identifier is to uniquely identify the credentials. Do not send any sensitive info, like encoded_data in this field. And do not send the string "null".

merchant_connector_details.encoded_data

object

Show child attributes

merchant_connector_details.encoded_data.connector_account_details

object | null

Account details of the Connector. You can specify up to 50 keys, with key names up to 40 characters long and values up to 500 characters long. Useful for storing additional, structured information on an object.

merchant_connector_details.encoded_data.metadata

object | null

Metadata is useful for storing additional, unstructured information on an object.

Response

200 - application/json

client_secret

string

required

This is a token which expires after 15 minutes, used from the client to authenticate and create sessions from the SDK

payment_id

string

required

The identifier for the payment

session_token

object[]

required

The list of session token object

• Option 1
• Option 2
• Option 3
• Option 4
• Option 5
• Option 6
• Option 7
• Option 8
• Option 9
• Option 10

Show child attributes

session_token.connector

string

required

The name of the connector

session_token.delayed_session_token

boolean

required

Identifier for the delayed session response

session_token.sdk_next_action

object

required

Show child attributes

session_token.sdk_next_action.next_action

enum<string>

required

Available options:

post_session_tokens,

confirm,

sync,

complete_authorize

session_token.wallet_name

enum<string>

required

Available options:

google_pay