Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: Documents bin/last4 in Android SDK #21

Merged
merged 1 commit into from
Jan 5, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/sdks/mobile/android/events.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ callbacks within your application.

## ChangeEvent

Raised whenever the element's value is changed.
Raised whenever the element's value is changed, upon each keypress and after pasting multiple characters into the element.

### Schema

Expand Down
2 changes: 1 addition & 1 deletion docs/sdks/mobile/android/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -74,7 +74,7 @@ Add this dependency to your project's build file:
}

dependencies {
implementation 'com.github.basis-theory.basistheory-android:lib:<version>'
implementation 'com.github.basis-theory:basistheory-android:<version>'
}
```

Expand Down
32 changes: 16 additions & 16 deletions docs/sdks/mobile/android/types.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -128,22 +128,14 @@ to your application via the property:

#### CardMetadata

| Name | Type | Description |
|------------|-----------|-------------------------------------------------------|
| brand | `String` | The card [brand identifier](#brand-identifiers) |
| cardMask | `String` | The card number mask corresponding to this card brand |
| cvcMask | `String` | The CVC mask corresponding to this card brand |
| isComplete | `Boolean` | Whether this card number is complete for this brand |

#### ChangeEvent

The card brand is also included within [ChangeEvents](./events#changeevent) published by the `CardNumberElement`
within an [EventDetails](./events#eventdetails) record of the form:

| Property | Type | Value |
|----------|----------|----------------------|
| type | `String` | `cardBrand` |
| message | `String` | The brand identifier |
| Name | Type | Description |
|------------|-----------|-------------------------------------------------------------------|
| brand | `String` | The card [brand identifier](#brand-identifiers) |
| cardMask | `String` | The card number mask corresponding to this card brand |
| cvcMask | `String` | The CVC mask corresponding to this card brand |
| isComplete | `Boolean` | Whether this card number is complete for this brand |
| bin | `String` | The first 6 digits of the card number if complete, otherwise null |
| last4 | `String` | The last 4 digits of the card number if complete, otherwise null |

#### Brand Identifiers

Expand All @@ -160,6 +152,14 @@ within an [EventDetails](./events#eventdetails) record of the form:
- `hiper`
- `hipercard`

### ChangeEvent Details

The `CardNumberElement` emits [ChangeEvents](./events#changeevent) that may contain several types of [EventDetail](./events#eventdetails) records.

- `cardBrand`: Contains the [brand identifier](#brand-identifiers) for the card brand. Only included once enough digits are entered to determine a card brand.
- `bin`: Contains the first 6 digits of the card number. Only included for complete card numbers satisfying the brand-specific mask.
- `last4`: Contains the last 4 digits of the card number. Only included for complete card numbers satisfying the brand-specific mask.

## CardExpirationDateElement

The `CardExpirationDateElement` can be used to securely collect credit card expiration dates within
Expand Down