Get Customer Tokens by Customer ID

GET/api/v1/customer/{customer_id}/tokens

Retrieve all tokens linked to a customer by the customer's unique ID.

View as Markdown Open in ChatGPT Open in Claude Open in Perplexity

Requires Bearer token. Get token →

Path Parameters

Name	Type	Description
`customer_id`	`string`required	Unique identifier of the customer in the Pine Labs Online database.

Response

Name	Type	Description
`customer_id`	`string`	Unique identifier of the customer.
`total_tokens`	`integer`	Total number of tokens linked to the customer.
`tokens`	`CustomerTokenDetail[]`	List of tokens associated with the customer.
`token_id`	`string`	Unique token ID generated by Pine Labs Online.
`merchant_token_reference`	`string`	Merchant's token reference.
`customer_id`	`string`	Unique identifier of the customer.
`status`	`INITIATED \| ACTIVE \| SUSPENDED \| FAILED \| DEACTIVATED`	Current status of the token. INITIATED: Token creation is initiated. ACTIVE: Token is active and can be used for transactions. SUSPENDED: Token is temporarily suspended. FAILED: Token creation failed. DEACTIVATED: Token has been deactivated. `INITIATEDACTIVESUSPENDEDFAILEDDEACTIVATED`
`payment_method`	`CARD \| UPI \| POINTS`	Payment method associated with the token. `CARDUPIPOINTS`
`expired_at`	`string`	ISO 8601 UTC timestamp when the token expires.
`created_at`	`string`	ISO 8601 UTC timestamp when the token was created.
`updated_at`	`string`	ISO 8601 UTC timestamp when the token was last updated.
`status_reason`	`string`	Reason for the current token status.
`merchant_metadata`	`object`	Arbitrary key-value pairs for merchant use. Maximum 10 pairs, 256 characters each.
`card_data`	`object`	Card data associated with a token.
`is_compliant`	`boolean`	Indicates whether the token is compliant with regulatory requirements.
`created_at`	`string`	ISO 8601 UTC timestamp when the customer record was created.
`updated_at`	`string`	ISO 8601 UTC timestamp when the customer record was last updated.

Status Codes

`200`	Customer tokens retrieved successfully.
`400`
`401`
`403`
`404`
`500`

Request

curl --request GET \
  --url https://pluraluat.v2.pinepg.in/api/v1/customer/cust-v1-0811030624-aa-RBDgpR/tokens \
  --header 'Authorization: Bearer YOUR_ACCESS_TOKEN'

Run this request

Bearer token

Path parameters

customer_id

200 OK

{
  "customer_id": "cust-v1-0811030624-aa-RBDgpR",
  "total_tokens": 1,
  "tokens": [
    {
      "token_id": "token-v1-1234567890-aa-ABCDEF",
      "merchant_token_reference": "token-ref-001",
      "customer_id": "cust-v1-0811030624-aa-RBDgpR",
      "status": "ACTIVE",
      "payment_method": "CARD",
      "expired_at": "2025-12-31T23:59:59.000000Z",
      "created_at": "2024-10-04T13:11:29.645591Z",
      "updated_at": "2024-10-04T13:11:29.645657Z",
      "status_reason": "Token activated successfully",
      "merchant_metadata": {
        "clientId": "DD",
        "transactionReferenceNo": "pine-1223",
        "merchantId": "1234",
        "tid": "9000990",
        "acquirerName": "HDFC_FSS",
        "isOfferDisplayRequired": "true",
        "OfferData": "UHJvZHVjdF9Db2RlPSIgIiZQcm9kdWN0X05hbWU9IiImUGF5bWVudF9Nb2RlPUJhbmsgRU1JJkNhcmRfVHlwZT1EZWJpdCBDYXJkJkJhbmtfTmFtZT1IREZDIERlYml0JkVNSV9UZW51cmU9NiZJbnRlcmVzdF9SYXRlPTkuMCZJbnRlcmVzdF9BbW91bnQ9MTM4MTQwJk1vbnRobHlfSW5zdGFsbG1lbnQ9ODk0NjkwJkF1dGhvcml6YXRpb25fQW1vdW50PTEwMCZMb2FuX2Jvb2tpbmdfQW1vdW50PTUyMzAwMDAmSW50ZXJlc3RfQ2FzaGJhY2tfQW1vdW50PTAmSW50ZXJlc3RfQ2FzaGJhY2tfVHlwZT1EZWZlcnJlZCZBZGRpdGlvbmFsX0Nhc2hiYWNrPSIiJkFkZGl0aW9uYWxfQ2FzaGJhY2tfVHlwZT0iIiZEZXNjcmlwdGlvbj1CYW5rIEVNSSZQcm9kdWN0X1ZhbHVlPTUyMzAwMDA",
        "tenant_id": "PGATPOS",
        "is_offer_validation_required": "true"
      },
      "card_data": {
        "last4_digit": "1112",
        "card_type": "CREDIT",
        "network_name": "Visa",
        "issuer_name": "HDFC Bank",
        "card_category": "CONSUMER",
        "country_code": "IN",
        "international": false,
        "emi": true,
        "cvv_required": true
      },
      "is_compliant": true
    }
  ],
  "created_at": "2024-10-04T13:11:29.645591Z",
  "updated_at": "2024-10-04T13:11:29.645657Z"
}