Customer — Get Info

Returns the customer record for a recurring or tokenized customer — including their masked card label, active status, and recurring schedule.

When to Use

▾

Use this endpoint when:

• Displaying a saved-card user's stored payment method in your UI
• Verifying a customer's isActive status before charging
• Inspecting a recurring schedule

note

Only available after the customer has successfully bound their card.

How to Use

▾

Endpoint

GET/v3/recurring-payment/{customer_id}

Step 1: Identify the Customer

▾

Use the customer_id returned by Create Tokenized Customer or Create Recurring Customer.

Step 2: Send the GET Request

▾

GET /v3/recurring-payment/{customer_id}.

Step 3: Read the Response

▾

The item object contains the full customer record.

---

Request Parameters

▾

customer_idSTRINGrequired

Customer ID returned from Create Recurring Customer or Create Tokenized Customer

Response Parameters

▾

itemOBJECT

Response item

idSTRING

Customer ID

merchantIdSTRING

Merchant ID

storeIdSTRING

Store ID

labelSTRING

Customer card: front six and last four digits

emailSTRING

Customer email

countryCodeSTRING

Customer country code

phoneNumberSTRING

Customer phone number

productNameSTRING

Product name

productDescriptionSTRING

Product description

isActiveBOOLEAN

Whether the token is active

createdAtSTRING

Created date time

updatedAtSTRING

Last updated date time

clientKeySTRING

Internal usage only

redirectUrlSTRING

Redirect URL

notifyUrlSTRING

Notify URL

paymentUrlSTRING

Card binding URL

recurringPaymentOBJECT

recurringPayment details

amountINTEGER

Recurring payment amount

currencySTRING

Recurring payment currency

recurringIntervalSTRING

Recurring interval

recurringTargetSTRING

Recurring target rules

recurringRepetitionINTEGER

Number of repetitions

codeSTRING

"SUCCESS" if the request succeeded, otherwise an error code.

errorOBJECT

Error details

codeSTRING

Error code if the request failed.

messageSTRING

Error message if the request failed.

debugSTRING

Debug message (sandbox only).