Skip to content

Commit

Permalink
docs(): update readme
Browse files Browse the repository at this point in the history
[ci skip]
  • Loading branch information
zmbot committed Jul 3, 2017
1 parent c28d9b6 commit e70e508
Showing 1 changed file with 11 additions and 11 deletions.
22 changes: 11 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -96,7 +96,7 @@ Once you have the token, you can now send it to your backend so you can charge t
### stripe.setPublishableKey(key, [success], [error])
Set publishable key

**Kind**: static method of <code>[stripe](#module_stripe)</code>
**Kind**: static method of [<code>stripe</code>](#module_stripe)

| Param | Type | Description |
| --- | --- | --- |
Expand All @@ -109,11 +109,11 @@ Set publishable key
### stripe.createCardToken(creditCard, success, error)
Create a credit card token

**Kind**: static method of <code>[stripe](#module_stripe)</code>
**Kind**: static method of [<code>stripe</code>](#module_stripe)

| Param | Type | Description |
| --- | --- | --- |
| creditCard | <code>[CreditCardTokenParams](#module_stripe.CreditCardTokenParams)</code> | Credit card information |
| creditCard | [<code>CreditCardTokenParams</code>](#module_stripe.CreditCardTokenParams) | Credit card information |
| success | <code>function</code> | Success callback |
| error | <code>function</code> | Error callback |

Expand All @@ -122,11 +122,11 @@ Create a credit card token
### stripe.createBankAccountToken(bankAccount, success, error)
Create a bank account token

**Kind**: static method of <code>[stripe](#module_stripe)</code>
**Kind**: static method of [<code>stripe</code>](#module_stripe)

| Param | Type | Description |
| --- | --- | --- |
| bankAccount | <code>[BankAccountTokenParams](#module_stripe.BankAccountTokenParams)</code> | Bank account information |
| bankAccount | [<code>BankAccountTokenParams</code>](#module_stripe.BankAccountTokenParams) | Bank account information |
| success | <code>function</code> | Success callback |
| error | <code>function</code> | Error callback |

Expand All @@ -135,7 +135,7 @@ Create a bank account token
### stripe.validateCardNumber(cardNumber, success, error)
Validates card number

**Kind**: static method of <code>[stripe](#module_stripe)</code>
**Kind**: static method of [<code>stripe</code>](#module_stripe)

| Param | Type | Description |
| --- | --- | --- |
Expand All @@ -148,7 +148,7 @@ Validates card number
### stripe.validateExpiryDate(expMonth, expYear, success, error)
Validates the expiry date of a card

**Kind**: static method of <code>[stripe](#module_stripe)</code>
**Kind**: static method of [<code>stripe</code>](#module_stripe)

| Param | Type | Description |
| --- | --- | --- |
Expand All @@ -162,7 +162,7 @@ Validates the expiry date of a card
### stripe.validateCVC(cvc, success, error)
Validates a CVC of a card

**Kind**: static method of <code>[stripe](#module_stripe)</code>
**Kind**: static method of [<code>stripe</code>](#module_stripe)

| Param | Type | Description |
| --- | --- | --- |
Expand All @@ -187,7 +187,7 @@ cordova.plugin.stripe.validateCVC('424', onSuccess, onError);
### stripe.getCardType(cardNumber, success, error)
Gets a card type from a card number

**Kind**: static method of <code>[stripe](#module_stripe)</code>
**Kind**: static method of [<code>stripe</code>](#module_stripe)

| Param | Type | Description |
| --- | --- | --- |
Expand All @@ -206,7 +206,7 @@ cordova.plugins.stripe.getCardType('4242424242424242', function(cardType) {
### stripe.CreditCardTokenParams : <code>Object</code>
Parameters to create a credit card token

**Kind**: static typedef of <code>[stripe](#module_stripe)</code>
**Kind**: static typedef of [<code>stripe</code>](#module_stripe)
**Properties**

| Name | Type | Description |
Expand All @@ -229,7 +229,7 @@ Parameters to create a credit card token
### stripe.BankAccountTokenParams : <code>object</code>
Parameters to create a bank account token

**Kind**: static typedef of <code>[stripe](#module_stripe)</code>
**Kind**: static typedef of [<code>stripe</code>](#module_stripe)
**Properties**

| Name | Type | Description |
Expand Down

0 comments on commit e70e508

Please sign in to comment.