forked from LiveCarta/PayPal-PHP-Server-SDK
6da8b9b5b8
* Automated commit message * add changelog --------- Co-authored-by: PayPalServerSDKs <server-sdks@paypal.com> Co-authored-by: Patrick Powers <patickpowers@hey.com>
123 lines
3.8 KiB
Markdown
123 lines
3.8 KiB
Markdown
|
|
# Payment Token Response
|
|
|
|
Full representation of a saved payment token.
|
|
|
|
## Structure
|
|
|
|
`PaymentTokenResponse`
|
|
|
|
## Fields
|
|
|
|
| Name | Type | Tags | Description | Getter | Setter |
|
|
| --- | --- | --- | --- | --- | --- |
|
|
| `id` | `?string` | Optional | The PayPal-generated ID for the vault token.<br><br>**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `36`, *Pattern*: `^[0-9a-zA-Z_-]+$` | getId(): ?string | setId(?string id): void |
|
|
| `customer` | [`?CustomerResponse`](../../doc/models/customer-response.md) | Optional | Customer in merchant's or partner's system of records. | getCustomer(): ?CustomerResponse | setCustomer(?CustomerResponse customer): void |
|
|
| `paymentSource` | [`?PaymentTokenResponsePaymentSource`](../../doc/models/payment-token-response-payment-source.md) | Optional | The vaulted payment method details. | getPaymentSource(): ?PaymentTokenResponsePaymentSource | setPaymentSource(?PaymentTokenResponsePaymentSource paymentSource): void |
|
|
| `links` | [`?(LinkDescription[])`](../../doc/models/link-description.md) | Optional | An array of related [HATEOAS links](/api/rest/responses/#hateoas).<br><br>**Constraints**: *Minimum Items*: `1`, *Maximum Items*: `32` | getLinks(): ?array | setLinks(?array links): void |
|
|
|
|
## Example (as JSON)
|
|
|
|
```json
|
|
{
|
|
"id": "id0",
|
|
"customer": {
|
|
"id": "id0",
|
|
"merchant_customer_id": "merchant_customer_id2"
|
|
},
|
|
"payment_source": {
|
|
"card": {
|
|
"name": "name6",
|
|
"last_digits": "last_digits0",
|
|
"brand": "RUPAY",
|
|
"expiry": "expiry4",
|
|
"billing_address": {
|
|
"address_line_1": "address_line_12",
|
|
"address_line_2": "address_line_28",
|
|
"admin_area_2": "admin_area_28",
|
|
"admin_area_1": "admin_area_14",
|
|
"postal_code": "postal_code0",
|
|
"country_code": "country_code8"
|
|
}
|
|
},
|
|
"paypal": {
|
|
"description": "description2",
|
|
"usage_pattern": "THRESHOLD_PREPAID",
|
|
"shipping": {
|
|
"name": {
|
|
"full_name": "full_name6"
|
|
},
|
|
"phone_number": {
|
|
"country_code": "country_code2",
|
|
"national_number": "national_number6"
|
|
},
|
|
"type": "SHIPPING",
|
|
"address": {
|
|
"address_line_1": "address_line_16",
|
|
"address_line_2": "address_line_26",
|
|
"admin_area_2": "admin_area_20",
|
|
"admin_area_1": "admin_area_12",
|
|
"postal_code": "postal_code8",
|
|
"country_code": "country_code6"
|
|
}
|
|
},
|
|
"permit_multiple_payment_tokens": false,
|
|
"usage_type": "MERCHANT"
|
|
},
|
|
"venmo": {
|
|
"description": "description6",
|
|
"usage_pattern": "UNSCHEDULED_PREPAID",
|
|
"shipping": {
|
|
"name": {
|
|
"full_name": "full_name6"
|
|
},
|
|
"phone_number": {
|
|
"country_code": "country_code2",
|
|
"national_number": "national_number6"
|
|
},
|
|
"type": "SHIPPING",
|
|
"address": {
|
|
"address_line_1": "address_line_16",
|
|
"address_line_2": "address_line_26",
|
|
"admin_area_2": "admin_area_20",
|
|
"admin_area_1": "admin_area_12",
|
|
"postal_code": "postal_code8",
|
|
"country_code": "country_code6"
|
|
}
|
|
},
|
|
"permit_multiple_payment_tokens": false,
|
|
"usage_type": "MERCHANT"
|
|
},
|
|
"apple_pay": {
|
|
"card": {
|
|
"name": "name6",
|
|
"last_digits": "last_digits0",
|
|
"type": "UNKNOWN",
|
|
"brand": "RUPAY",
|
|
"billing_address": {
|
|
"address_line_1": "address_line_12",
|
|
"address_line_2": "address_line_28",
|
|
"admin_area_2": "admin_area_28",
|
|
"admin_area_1": "admin_area_14",
|
|
"postal_code": "postal_code0",
|
|
"country_code": "country_code8"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"links": [
|
|
{
|
|
"href": "href6",
|
|
"rel": "rel0",
|
|
"method": "HEAD"
|
|
},
|
|
{
|
|
"href": "href6",
|
|
"rel": "rel0",
|
|
"method": "HEAD"
|
|
}
|
|
]
|
|
}
|
|
```
|
|
|