| 1 |
<?php |
| 2 |
|
| 3 |
// File generated from our OpenAPI spec |
| 4 |
|
| 5 |
namespace Stripe; |
| 6 |
|
| 7 |
/** |
| 8 |
* Tokenization is the process Stripe uses to collect sensitive card or bank |
| 9 |
* account details, or personally identifiable information (PII), directly from |
| 10 |
* your customers in a secure manner. A token representing this information is |
| 11 |
* returned to your server to use. You should use our <a |
| 12 |
* href="https://stripe.com/docs/payments">recommended payments integrations</a> to |
| 13 |
* perform this process client-side. This ensures that no sensitive card data |
| 14 |
* touches your server, and allows your integration to operate in a PCI-compliant |
| 15 |
* way. |
| 16 |
* |
| 17 |
* If you cannot use client-side tokenization, you can also create tokens using the |
| 18 |
* API with either your publishable or secret API key. Keep in mind that if your |
| 19 |
* integration uses this method, you are responsible for any PCI compliance that |
| 20 |
* may be required, and you must keep your secret API key safe. Unlike with |
| 21 |
* client-side tokenization, your customer's information is not sent directly to |
| 22 |
* Stripe, so we cannot determine how it is handled or stored. |
| 23 |
* |
| 24 |
* Tokens cannot be stored or used more than once. To store card or bank account |
| 25 |
* information for later use, you can create <a |
| 26 |
* href="https://stripe.com/docs/api#customers">Customer</a> objects or <a |
| 27 |
* href="https://stripe.com/docs/api#external_accounts">Custom accounts</a>. Note |
| 28 |
* that <a href="https://stripe.com/docs/radar">Radar</a>, our integrated solution |
| 29 |
* for automatic fraud protection, performs best with integrations that use |
| 30 |
* client-side tokenization. |
| 31 |
* |
| 32 |
* Related guide: <a |
| 33 |
* href="https://stripe.com/docs/payments/accept-a-payment-charges#web-create-token">Accept |
| 34 |
* a payment</a> |
| 35 |
* |
| 36 |
* @property string $id Unique identifier for the object. |
| 37 |
* @property string $object String representing the object's type. Objects of the same type share the same value. |
| 38 |
* @property \Stripe\BankAccount $bank_account <p>These bank accounts are payment methods on <code>Customer</code> objects.</p><p>On the other hand <a href="https://stripe.com/docs/api#external_accounts">External Accounts</a> are transfer destinations on <code>Account</code> objects for <a href="https://stripe.com/docs/connect/custom-accounts">Custom accounts</a>. They can be bank accounts or debit cards as well, and are documented in the links above.</p><p>Related guide: <a href="https://stripe.com/docs/payments/bank-debits-transfers">Bank Debits and Transfers</a>.</p> |
| 39 |
* @property \Stripe\Card $card <p>You can store multiple cards on a customer in order to charge the customer later. You can also store multiple debit cards on a recipient in order to transfer to those cards later.</p><p>Related guide: <a href="https://stripe.com/docs/sources/cards">Card Payments with Sources</a>.</p> |
| 40 |
* @property null|string $client_ip IP address of the client that generated the token. |
| 41 |
* @property int $created Time at which the object was created. Measured in seconds since the Unix epoch. |
| 42 |
* @property bool $livemode Has the value <code>true</code> if the object exists in live mode or the value <code>false</code> if the object exists in test mode. |
| 43 |
* @property string $type Type of the token: <code>account</code>, <code>bank_account</code>, <code>card</code>, or <code>pii</code>. |
| 44 |
* @property bool $used Whether this token has already been used (tokens can be used only once). |
| 45 |
*/ |
| 46 |
class Token extends ApiResource |
| 47 |
{ |
| 48 |
const OBJECT_NAME = 'token'; |
| 49 |
|
| 50 |
use ApiOperations\Create; |
| 51 |
use ApiOperations\Retrieve; |
| 52 |
|
| 53 |
const TYPE_ACCOUNT = 'account'; |
| 54 |
const TYPE_BANK_ACCOUNT = 'bank_account'; |
| 55 |
const TYPE_CARD = 'card'; |
| 56 |
const TYPE_PII = 'pii'; |
| 57 |
} |
| 58 |
|
