Skip to content

Commit 0a6c949

Browse files
Merge pull request #8 from tonderio/DEV-1799
DEV-1799: Add detailed API documentation for getCardSummary method
2 parents f93aa5e + e423add commit 0a6c949

File tree

1 file changed

+43
-0
lines changed

1 file changed

+43
-0
lines changed

README.md

Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1163,6 +1163,49 @@ The ENROLLMENT integration provides methods for handling full enrollment with bu
11631163
- saveCustomerCard: Tokenizes and saves the current card information.
11641164
- getCardSummary: Retrieves detailed information about a saved card using its Skyflow ID.
11651165

1166+
<details>
1167+
<summary>Input Interface</summary>
1168+
1169+
| Parameter | Type | Description |
1170+
|-----------|--------|------------------------------------------------|
1171+
| skyflowId | string | The Skyflow ID of the card to retrieve |
1172+
1173+
</details>
1174+
1175+
<details>
1176+
<summary>Response Interface</summary>
1177+
1178+
**IBaseResponse<ICardsSummaryResponse>**
1179+
1180+
The response follows the base response pattern:
1181+
1182+
```typescript
1183+
export type IBaseResponse<T> =
1184+
| { response: ICardsSummaryResponse; error?: TonderError }
1185+
| { response?: never; error: TonderError };
1186+
```
1187+
1188+
**Success Response (ICardsSummaryResponse)**
1189+
1190+
| Property | Type | Description |
1191+
|----------|--------|------------------------------------------------|
1192+
| user_id | number | The ID of the user who owns the card |
1193+
| card | object | Object containing the card fields |
1194+
1195+
**Card Fields (ICardSkyflowFields)**
1196+
1197+
| Property | Type | Description |
1198+
|-------------------|--------|--------------------------------------------|
1199+
| card_number | string | The masked card number |
1200+
| expiration_month | string | The expiration month of the card |
1201+
| expiration_year | string | The expiration year of the card |
1202+
| skyflow_id | string | The unique Skyflow identifier for the card |
1203+
| card_scheme | string | The card brand (e.g., Visa, Mastercard) |
1204+
| cardholder_name | string | The name of the cardholder |
1205+
1206+
</details>
1207+
1208+
11661209
> **Note:** The saveCustomerCard It is only necessary when you want to control the enrollment button on your own.
11671210
11681211
> **Note:** For card methods, it is necessary to obtain and use your secure token when calling the create function.

0 commit comments

Comments
 (0)