Skip to content

Latest commit

 

History

History
404 lines (362 loc) · 10.2 KB

token.md

File metadata and controls

404 lines (362 loc) · 10.2 KB
Raw

Tokens

Fetch token by payment id

client.payment.fetch(paymentId)

Parameters:

Name Type Description
paymentId* string The id of the payment to be fetched

Response:

{
  "id": "pay_FHfqtkRzWvxky4",
  "entity": "payment",
  "amount": 100,
  "currency": "INR",
  "status": "captured",
  "order_id": "order_FHfnswDdfu96HQ",
  "invoice_id": null,
  "international": false,
  "method": "card",
  "amount_refunded": 0,
  "refund_status": null,
  "captured": true,
  "description": null,
  "card_id": "card_F0zoXUp4IPPGoI",
  "bank": null,
  "wallet": null,
  "vpa": null,
  "email": "[email protected]",
  "contact": "+919876543210",
  "customer_id": "cust_DtHaBuooGHTuyZ",
  "token_id": "token_FHfn3rIiM1Z8nr",
  "notes": {
    "note_key 1": "Beam me up Scotty",
    "note_key 2": "Tea. Earl Gray. Hot."
  },
  "fee": 0,
  "tax": 0,
  "error_code": null,
  "error_description": null,
  "error_source": null,
  "error_step": null,
  "error_reason": null,
  "acquirer_data": {
    "auth_code": "541898"
  },
  "created_at": 1595449871
}

Fetch tokens by customer id

client.token.all(customerId)

Parameters:

Name Type Description
customerId* string The id of the customer to be fetched

Response:

{
  "entity": "collection",
  "count": 1,
  "items": [
    {
      "id": "token_JIskPHR6HnypUV",
      "entity": "token",
      "token": "14LDXyJ1q4MKge",
      "bank": null,
      "wallet": null,
      "method": "card",
      "card": {
        "entity": "card",
        "name": "ankit",
        "last4": "4366",
        "network": "Visa",
        "type": "credit",
        "issuer": "UTIB",
        "international": false,
        "emi": true,
        "sub_type": "consumer",
        "token_iin": null,
        "expiry_month": 12,
        "expiry_year": 2022,
        "flows": {
          "otp": true,
          "recurring": true
        }
      },
      "recurring": true,
      "recurring_details": {
        "status": "confirmed",
        "failure_reason": null
      },
      "auth_type": null,
      "mrn": null,
      "used_at": 1649861969,
      "created_at": 1649861969,
      "expired_at": 1672511399,
      "status": null,
      "notes": [],
      "dcc_enabled": false,
      "compliant_with_tokenisation_guidelines": false
    }
  ]
}

Fetch particular token

client.token.fetch(customerId, tokenId)

Parameters:

Name Type Description
customerId* string The id of the customer to be fetched
tokenId* string The id of the token to be fetched

Response:

{
  "id": "token_JIskPHR6HnypUV",
  "entity": "token",
  "token": "14LDXyJ1q4MKge",
  "bank": null,
  "wallet": null,
  "method": "card",
  "card": {
    "entity": "card",
    "name": "ankit",
    "last4": "4366",
    "network": "Visa",
    "type": "credit",
    "issuer": "UTIB",
    "international": false,
    "emi": true,
    "sub_type": "consumer",
    "token_iin": null,
    "expiry_month": 12,
    "expiry_year": 2022,
    "flows": {
      "otp": true,
      "recurring": true
    }
  },
  "recurring": true,
  "recurring_details": {
    "status": "confirmed",
    "failure_reason": null
  },
  "auth_type": null,
  "mrn": null,
  "used_at": 1649861969,
  "created_at": 1649861969,
  "expired_at": 1672511399,
  "status": null,
  "notes": [],
  "dcc_enabled": false,
  "compliant_with_tokenisation_guidelines": false
}

Delete token

client.token.delete(customerId, tokenId)

Parameters:

Name Type Description
customerId* string The id of the customer to be fetched
tokenId* string The id of the token to be fetched

Response:

{
    "deleted": true
}

Fetch VPA tokens of a customer id

client.token.all(customerId)

Parameters:

Name Type Description
customerId* string The id of the customer to be fetched

please refer this doc

Response:

{
  "entity": "collection",
  "count": 1,
  "items": [
    {
      "id": "token_EeroOjvOvorT5L",
      "entity": "token",
      "token": "4ydxm47GQjrIEx",
      "bank": null,
      "wallet": null,
      "method": "card",
      "card": {
        "entity": "card",
        "name": "Gaurav Kumar",
        "last4": "8430",
        "network": "Visa",
        "type": "credit",
        "issuer": "HDFC",
        "international": false,
        "emi": true,
        "expiry_month": 12,
        "expiry_year": 2022,
        "flows": {
          "otp": true,
          "recurring": true
        }
      },
      "vpa": null,
      "recurring": false,
      "auth_type": null,
      "mrn": null,
      "used_at": 1586976724,
      "created_at": 1586976724,
      "expired_at": 1672511399,
      "dcc_enabled": false
    }
  ]
}

Create a token

client.token.create({
  "customer_id": "cust_1Aa00000000001",
  "method": "card",
  "card": {
    "number": "4111111111111111",
    "cvv": "123",
    "expiry_month": "12",
    "expiry_year": "21",
    "name": "Gaurav Kumar"
  },
  "authentication": {
    "provider": "razorpay",
    "provider_reference_id": "pay_123wkejnsakd",
    "authentication_reference_number": "100222021120200000000742753928"  
  },
  "notes": []
})

Parameters:

Name Type Description
customerId* string The id of the customer to be fetched
method* string The type of object that needs to be tokenised. Currently, card is the only supported value.
card* object All keys listed here are supported

| | authentication | object | All keys listed here are supported |

Response:

{
  "id": "token_IJmat4GwYATMtx",
  "entity": "token",
  "method": "card",
  "card": {
    "last4": "1111",
    "network": "Visa",
    "type": "credit",
    "issuer": "IDFB",
    "international": false,
    "emi": false,
    "sub_type": "consumer"
  },
  "customer": {
    "id": "cust_1Aa00000000001",
    "entity": "customer",
    "name": "Bob",
    "email": "[email protected]",
    "contact": "9000090000",
    "gstin": null,
    "notes": {
      "notes_key_1": "Tea, Earl Grey, Hot",
      "notes_key_2": "Tea, Earl Grey… decaf."
    },
    "created_at": 1658390470
  },
  "expired_at": 1701368999,
  "customer_id": "cust_1Aa00000000001",
  "compliant_with_tokenisation_guidelines": true,
  "status": "active",
  "notes": []
}

Fetch token

client.token.fetch({"id": "token_4lsdksD31GaZ09"})

Parameters:

Name Type Description
id* string The unique identifier of a sub-merchant account generated by Razorpay.

Response:

{
  "id": "token_4lsdksD31GaZ09",
  "entity": "token",
  "customer_id": "cust_1Aa00000000001",
  "method": "card",
  "card": {
    "last4": "3335",
    "network": "Visa",
    "type": "debit",
    "issuer": "HDFC",
    "international": false,
    "emi": true,
    "sub_type": "consumer",
    "token_iin": "453335"
  },
  "compliant_with_tokenisation_guidelines": true,
  "expired_at": 1748716199,
  "status": "active",
  "status_reason": null,
  "notes": []
}

Delete a token

client.token.delete({"id": "token_4lsdksD31GaZ09"})

Parameters:

Name Type Description
id* string The unique identifier of a sub-merchant account generated by Razorpay.

Response:

[]

Process a Payment on another PA/PG with Token

client.token.processPaymentOnAlternatePAorPG({"id":"spt_4lsdksD31GaZ09"})

Parameters:

Name Type Description
id* string The unique identifier of the token whose details are to be fetched.

Response:

{ 
  "card": {
      "number": "4016981500100002",
      "expiry_month" : "12",
      "expiry_year" : 2021
  }
}

PN: * indicates mandatory fields

For reference click here