Sign in

v1

latestOpenAPI 3.0.02026-07-26168846732.2 KB
Payment Method Session

Payment Method Session - Confirm a payment method session

Confirms a payment method session object with the payment method data

post/v1/payment-method-sessions/{id}/confirm

Path parameters

idstring required

The unique identifier for the Payment Method Session

Headers

X-Profile-Idstring required

Profile ID associated to the payment intent

Request body

payment_method_type'card' | 'card_redirect' | 'pay_later' | 'wallet' | 'bank_redirect' | 'bank_transfer' | 'crypto' | 'bank_debit' | 'reward' | 'real_time_payment' | 'upi' | 'voucher' | 'gift_card' | 'open_banking' | 'mobile_payment' | 'network_token' required

Indicates the type of payment method. Eg: 'card', 'wallet', etc.

payment_method_subtype'ach' | 'affirm' | 'afterpay_clearpay' | 'alfamart' | 'ali_pay' | 'ali_pay_hk' | 'alma' | 'amazon_pay' | 'paysera' | 'apple_pay' | 'atome' | 'bacs' | 'bancontact_card' | 'becs' | 'benefit' | 'bizum' | 'blik' | 'bluecode' | 'boleto' | 'bca_bank_transfer' | 'bni_va' | 'breadpay' | 'bri_va' | 'bhn_card_network' | 'card_redirect' | 'cimb_va' | 'classic' | 'credit' | 'crypto_currency' | 'cashapp' | 'dana' | 'danamon_va' | 'debit' | 'duit_now' | 'efecty' | 'eft' | 'eft_debit_order' | 'eps' | 'flexiti' | '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' | 'payjustnow' | 'paypal' | 'paze' | 'pix' | 'pix_key' | 'pix_emv' | 'pix_qr' | 'pix_automatico_qr' | 'pix_automatico_push' | 'pay_safe_card' | 'przelewy24' | 'prompt_pay' | 'pse' | 'qris' | 'red_compra' | 'red_pagos' | 'samsung_pay' | 'sepa' | 'sepa_bank_transfer' | 'sepa_guarenteed_debit' | 'skrill' | 'sofort' | 'swish' | 'touch_n_go' | 'trustly' | 'twint' | 'upi_collect' | 'upi_intent' | 'upi_qr' | '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' | 'instant_bank_transfer' | 'instant_bank_transfer_finland' | 'instant_bank_transfer_poland' | 'revolut_pay' | 'indonesian_bank_transfer' | 'open_banking' | 'network_token'

Indicates the sub type of payment method. Eg: 'google_pay' & 'apple_pay' for wallets.

return_urlstring nullable

The return url to which the customer should be redirected to after adding the payment method

Example request

{
  "payment_method_data": {
    "card": {
      "card_number": "4242424242424242",
      "card_exp_month": "24",
      "card_exp_year": "24",
      "card_holder_name": "John Test",
      "card_cvc": "242",
      "card_issuer": "chase",
      "card_type": "CREDIT",
      "card_issuing_country": "INDIA",
      "card_issuing_country_code": "IN",
      "bank_code": "JP_AMEX",
      "nick_name": "John Test"
    },
    "billing": {
      "address": {
        "city": "New York",
        "line1": "123, King Street",
        "line2": "Powelson Avenue",
        "line3": "Bridgewater",
        "zip": "08807",
        "state": "New York",
        "first_name": "John",
        "last_name": "Doe",
        "origin_zip": "08807"
      },
      "phone": {
        "number": "9123456789",
        "country_code": "+1"
      }
    }
  },
  "customer_acceptance": {
    "accepted_at": "2022-09-10T10:11:12Z",
    "online": {
      "ip_address": "123.32.25.123"
    }
  }
}

Response

Payment Method created

idstring required
customer_idstring nullable

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

{"stackTrail":"components:schemas:PaymentMethodSessionResponse:properties:tokenization_data","oasType":"schema","type":"unknown","description":"Contains data to be passed on to tokenization service ( if present ) to create token_id for given JSON data","nullable":true}
expires_atstring 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

client_secretstring required

Client Secret

return_urlstring nullable

The return url to which the user should be redirected to

associated_token_idstring nullable

The token-id created if there is tokenization_data present

storage_type'volatile' | 'persistent' required
sdk_authorizationstring nullable

SDK authorization token for client SDK usage Contains encoded authentication details for subsequent API calls

keep_aliveboolean required

Whether the card with new status should be listed in the session

Example response

{
  "id": "0a_pms_01926c58bc6e77c09e809964e72af8c8",
  "customer_id": "0a_cus_01926c58bc6e77c09e809964e72af8c8",
  "billing": {
    "address": {
      "city": "New York",
      "line1": "123, King Street",
      "line2": "Powelson Avenue",
      "line3": "Bridgewater",
      "zip": "08807",
      "state": "New York",
      "first_name": "John",
      "last_name": "Doe",
      "origin_zip": "08807"
    },
    "phone": {
      "number": "9123456789",
      "country_code": "+1"
    }
  },
  "expires_at": "2023-01-18T11:04:09.922Z",
  "client_secret": "cs_9wcXDRVkfEtLEsSnYKgQ",
  "return_url": "https://merchant-website.com/return",
  "next_action": {
    "redirect_to_url": "https://example.com/redirect"
  },
  "authentication_details": {
    "error": {
      "code": "card_declined",
      "message": "The card was declined.",
      "reason": "The card was declined.",
      "unified_code": "card_declined",
      "unified_message": "The card was declined.",
      "network_advice_code": "01",
      "network_decline_code": "05",
      "network_error_message": "Do not retry"
    }
  },
  "associated_payment_methods": [
    {
      "payment_method_token": {
        "data": "token_9wcXDRVkfEtLEsSnYKgQ"
      }
    }
  ],
  "associated_token_id": "0a_tok_01926c58bc6e77c09e809964e72af8c8",
  "card_cvc_token_storage": {
    "is_stored": true,
    "expires_at": "2024-02-24T11:04:09.922Z"
  },
  "payment_method_data": {
    "card": {
      "last4_digits": "4242",
      "expiry_month": "10",
      "expiry_year": "25",
      "card_holder_name": "John Doe",
      "card_fingerprint": "fingerprint_12345",
      "nick_name": "Card",
      "card_isin": "4567890",
      "card_issuer": "Issuer Bank",
      "card_type": "Credit",
      "saved_to_locker": true
    }
  },
  "sdk_authorization": "cHJvZmlsZV9pZD0uLi4=",
  "network_tokenization_data": {
    "payment_method_data": {
      "last4_digits": "4242",
      "network_token_expiry_month": "05",
      "network_token_expiry_year": "27",
      "nick_name": "Card",
      "card_holder_name": "John Doe",
      "card_isin": "16712672",
      "card_issuer": "Bank of America",
      "card_type": "Credit",
      "par": "522134KAVJ1JPZ8L77N0Z2LRYZS7J"
    }
  }
}