forked from LiveCarta/PayPal-PHP-Server-SDK
2.0.0 Release (#58)
* Automated commit message * Automated commit message * add changelog --------- Co-authored-by: PayPalServerSDKs <server-sdks@paypal.com>
This commit is contained in:
Patrick Powers
23
doc/models/activate-subscription-request.md
Normal file
23
doc/models/activate-subscription-request.md
Normal file
@@ -0,0 +1,23 @@
|
||||
|
||||
# Activate Subscription Request
|
||||
|
||||
The activate subscription request details.
|
||||
|
||||
## Structure
|
||||
|
||||
`ActivateSubscriptionRequest`
|
||||
|
||||
## Fields
|
||||
|
||||
| Name | Type | Tags | Description | Getter | Setter |
|
||||
| --- | --- | --- | --- | --- | --- |
|
||||
| `reason` | `?string` | Optional | The reason for activation of a subscription. Required to reactivate the subscription.<br><br>**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `128`, *Pattern*: `^.*$` | getReason(): ?string | setReason(?string reason): void |
|
||||
|
||||
## Example (as JSON)
|
||||
|
||||
```json
|
||||
{
|
||||
"reason": "reason4"
|
||||
}
|
||||
```
|
||||
|
||||
@@ -17,7 +17,7 @@ The breakdown of the amount. Breakdown provides details such as total item amoun
|
||||
| `taxTotal` | [`?Money`](../../doc/models/money.md) | Optional | The currency and amount for a financial transaction, such as a balance or payment due. | getTaxTotal(): ?Money | setTaxTotal(?Money taxTotal): void |
|
||||
| `insurance` | [`?Money`](../../doc/models/money.md) | Optional | The currency and amount for a financial transaction, such as a balance or payment due. | getInsurance(): ?Money | setInsurance(?Money insurance): void |
|
||||
| `shippingDiscount` | [`?Money`](../../doc/models/money.md) | Optional | The currency and amount for a financial transaction, such as a balance or payment due. | getShippingDiscount(): ?Money | setShippingDiscount(?Money shippingDiscount): void |
|
||||
| `discount` | [`?Money`](../../doc/models/money.md) | Optional | The currency and amount for a financial transaction, such as a balance or payment due. | getDiscount(): ?Money | setDiscount(?Money discount): void |
|
||||
| `discount` | [`?Money`](../../doc/models/money.md) | Optional | The discount amount and currency code. For list of supported currencies and decimal precision, see the PayPal REST APIs Currency Codes. | getDiscount(): ?Money | setDiscount(?Money discount): void |
|
||||
|
||||
## Example (as JSON)
|
||||
|
||||
|
||||
31
doc/models/app-switch-context.md
Normal file
31
doc/models/app-switch-context.md
Normal file
@@ -0,0 +1,31 @@
|
||||
|
||||
# App Switch Context
|
||||
|
||||
Merchant provided details of the native app or mobile web browser to facilitate buyer's app switch to the PayPal consumer app.
|
||||
|
||||
## Structure
|
||||
|
||||
`AppSwitchContext`
|
||||
|
||||
## Fields
|
||||
|
||||
| Name | Type | Tags | Description | Getter | Setter |
|
||||
| --- | --- | --- | --- | --- | --- |
|
||||
| `nativeApp` | [`?NativeAppContext`](../../doc/models/native-app-context.md) | Optional | Merchant provided, buyer's native app preferences to app switch to the PayPal consumer app. | getNativeApp(): ?NativeAppContext | setNativeApp(?NativeAppContext nativeApp): void |
|
||||
| `mobileWeb` | [`?MobileWebContext`](../../doc/models/mobile-web-context.md) | Optional | Buyer's mobile web browser context to app switch to the PayPal consumer app. | getMobileWeb(): ?MobileWebContext | setMobileWeb(?MobileWebContext mobileWeb): void |
|
||||
|
||||
## Example (as JSON)
|
||||
|
||||
```json
|
||||
{
|
||||
"native_app": {
|
||||
"os_type": "IOS",
|
||||
"os_version": "os_version0"
|
||||
},
|
||||
"mobile_web": {
|
||||
"return_flow": "AUTO",
|
||||
"buyer_user_agent": "buyer_user_agent8"
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
@@ -31,9 +31,9 @@ The Card from Apple Pay Wallet used to fund the payment.
|
||||
{
|
||||
"name": "name4",
|
||||
"last_digits": "last_digits8",
|
||||
"brand": "HIPER",
|
||||
"brand": "ACCEL",
|
||||
"available_networks": [
|
||||
"RUPAY"
|
||||
"STAR_ACCESS"
|
||||
],
|
||||
"type": "DEBIT"
|
||||
}
|
||||
|
||||
@@ -24,7 +24,7 @@ The payment card to be used to fund a payment. Can be a credit or debit card.
|
||||
"name": "name4",
|
||||
"last_digits": "last_digits8",
|
||||
"type": "UNKNOWN",
|
||||
"brand": "AMEX",
|
||||
"brand": "SWITCH",
|
||||
"billing_address": {
|
||||
"address_line_1": "address_line_12",
|
||||
"address_line_2": "address_line_28",
|
||||
|
||||
@@ -29,7 +29,7 @@ Information about the Payment data obtained by decrypting Apple Pay token.
|
||||
"name": "name4",
|
||||
"number": "number2",
|
||||
"expiry": "expiry2",
|
||||
"card_type": "CB_NATIONALE",
|
||||
"card_type": "VISA",
|
||||
"type": "UNKNOWN"
|
||||
},
|
||||
"device_manufacturer_id": "device_manufacturer_id2",
|
||||
|
||||
@@ -21,7 +21,7 @@ A resource representing a response for Apple Pay.
|
||||
"name": "name6",
|
||||
"last_digits": "last_digits0",
|
||||
"type": "UNKNOWN",
|
||||
"brand": "RUPAY",
|
||||
"brand": "CB_NATIONALE",
|
||||
"billing_address": {
|
||||
"address_line_1": "address_line_12",
|
||||
"address_line_2": "address_line_28",
|
||||
|
||||
34
doc/models/apple-pay-request-card.md
Normal file
34
doc/models/apple-pay-request-card.md
Normal file
@@ -0,0 +1,34 @@
|
||||
|
||||
# Apple Pay Request Card
|
||||
|
||||
The payment card to be used to fund a payment. Can be a credit or debit card.
|
||||
|
||||
## Structure
|
||||
|
||||
`ApplePayRequestCard`
|
||||
|
||||
## Fields
|
||||
|
||||
| Name | Type | Tags | Description | Getter | Setter |
|
||||
| --- | --- | --- | --- | --- | --- |
|
||||
| `type` | [`?string(CardType)`](../../doc/models/card-type.md) | Optional | Type of card. i.e Credit, Debit and so on.<br><br>**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `255`, *Pattern*: `^[A-Z_]+$` | getType(): ?string | setType(?string type): void |
|
||||
| `brand` | [`?string(CardBrand)`](../../doc/models/card-brand.md) | Optional | The card network or brand. Applies to credit, debit, gift, and payment cards.<br><br>**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `255`, *Pattern*: `^[A-Z_]+$` | getBrand(): ?string | setBrand(?string brand): void |
|
||||
| `billingAddress` | [`?Address`](../../doc/models/address.md) | Optional | The portable international postal address. Maps to [AddressValidationMetadata](https://github.com/googlei18n/libaddressinput/wiki/AddressValidationMetadata) and HTML 5.1 [Autofilling form controls: the autocomplete attribute](https://www.w3.org/TR/html51/sec-forms.html#autofilling-form-controls-the-autocomplete-attribute). | getBillingAddress(): ?Address | setBillingAddress(?Address billingAddress): void |
|
||||
|
||||
## Example (as JSON)
|
||||
|
||||
```json
|
||||
{
|
||||
"type": "PREPAID",
|
||||
"brand": "PULSE",
|
||||
"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"
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
@@ -40,7 +40,7 @@ Information needed to pay using ApplePay.
|
||||
"name": "name4",
|
||||
"number": "number2",
|
||||
"expiry": "expiry2",
|
||||
"card_type": "CB_NATIONALE",
|
||||
"card_type": "VISA",
|
||||
"type": "UNKNOWN"
|
||||
},
|
||||
"device_manufacturer_id": "device_manufacturer_id6",
|
||||
|
||||
@@ -14,7 +14,7 @@ The payment card to use to fund a payment. Can be a credit or debit card.
|
||||
| `name` | `?string` | Optional | The card holder's name as it appears on the card.<br><br>**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `300`, *Pattern*: `^.{1,300}$` | getName(): ?string | setName(?string name): void |
|
||||
| `number` | `?string` | Optional | The primary account number (PAN) for the payment card.<br><br>**Constraints**: *Minimum Length*: `13`, *Maximum Length*: `19`, *Pattern*: `^[0-9]{13,19}$` | getNumber(): ?string | setNumber(?string number): void |
|
||||
| `expiry` | `?string` | Optional | The year and month, in ISO-8601 `YYYY-MM` date format. See [Internet date and time format](https://tools.ietf.org/html/rfc3339#section-5.6).<br><br>**Constraints**: *Minimum Length*: `7`, *Maximum Length*: `7`, *Pattern*: `^[0-9]{4}-(0[1-9]\|1[0-2])$` | getExpiry(): ?string | setExpiry(?string expiry): void |
|
||||
| `cardType` | [`?string(CardBrand)`](../../doc/models/card-brand.md) | Optional | The card network or brand. Applies to credit, debit, gift, and payment cards.<br><br>**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `255`, *Pattern*: `^[A-Z_]+$` | getCardType(): ?string | setCardType(?string cardType): void |
|
||||
| `cardType` | [`?string(CardBrand)`](../../doc/models/card-brand.md) | Optional | The card brand or network. Typically used in the response.<br><br>**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `255`, *Pattern*: `^[A-Z_]+$` | getCardType(): ?string | setCardType(?string cardType): void |
|
||||
| `type` | [`?string(CardType)`](../../doc/models/card-type.md) | Optional | Type of card. i.e Credit, Debit and so on.<br><br>**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `255`, *Pattern*: `^[A-Z_]+$` | getType(): ?string | setType(?string type): void |
|
||||
| `brand` | [`?string(CardBrand)`](../../doc/models/card-brand.md) | Optional | The card network or brand. Applies to credit, debit, gift, and payment cards.<br><br>**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `255`, *Pattern*: `^[A-Z_]+$` | getBrand(): ?string | setBrand(?string brand): void |
|
||||
| `billingAddress` | [`?Address`](../../doc/models/address.md) | Optional | The portable international postal address. Maps to [AddressValidationMetadata](https://github.com/googlei18n/libaddressinput/wiki/AddressValidationMetadata) and HTML 5.1 [Autofilling form controls: the autocomplete attribute](https://www.w3.org/TR/html51/sec-forms.html#autofilling-form-controls-the-autocomplete-attribute). | getBillingAddress(): ?Address | setBillingAddress(?Address billingAddress): void |
|
||||
|
||||
16
doc/models/application-context-user-action.md
Normal file
16
doc/models/application-context-user-action.md
Normal file
@@ -0,0 +1,16 @@
|
||||
|
||||
# Application Context User Action
|
||||
|
||||
Configures the label name to `Continue` or `Subscribe Now` for subscription consent experience.
|
||||
|
||||
## Enumeration
|
||||
|
||||
`ApplicationContextUserAction`
|
||||
|
||||
## Fields
|
||||
|
||||
| Name | Description |
|
||||
| --- | --- |
|
||||
| `CONTINUE_` | After you redirect the customer to the PayPal subscription consent page, a Continue button appears. Use this option when you want to control the activation of the subscription and do not want PayPal to activate the subscription. |
|
||||
| `SUBSCRIBE_NOW` | After you redirect the customer to the PayPal subscription consent page, a Subscribe Now button appears. Use this option when you want PayPal to activate the subscription. |
|
||||
|
||||
29
doc/models/auction-information.md
Normal file
29
doc/models/auction-information.md
Normal file
@@ -0,0 +1,29 @@
|
||||
|
||||
# Auction Information
|
||||
|
||||
The auction information.
|
||||
|
||||
## Structure
|
||||
|
||||
`AuctionInformation`
|
||||
|
||||
## Fields
|
||||
|
||||
| Name | Type | Tags | Description | Getter | Setter |
|
||||
| --- | --- | --- | --- | --- | --- |
|
||||
| `auctionSite` | `?string` | Optional | The name of the auction site.<br><br>**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `200`, *Pattern*: `^[a-zA-Z0-9_'\-., ":;\!?]*$` | getAuctionSite(): ?string | setAuctionSite(?string auctionSite): void |
|
||||
| `auctionItemSite` | `?string` | Optional | The auction site URL.<br><br>**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `4000`, *Pattern*: `^[a-zA-Z0-9_'\-., ":;\!?]*$` | getAuctionItemSite(): ?string | setAuctionItemSite(?string auctionItemSite): void |
|
||||
| `auctionBuyerId` | `?string` | Optional | The ID of the buyer who makes the purchase in the auction. This ID might be different from the payer ID provided for the payment.<br><br>**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `500`, *Pattern*: `^[a-zA-Z0-9_'\-., ":;\!?]*$` | getAuctionBuyerId(): ?string | setAuctionBuyerId(?string auctionBuyerId): void |
|
||||
| `auctionClosingDate` | `?string` | Optional | The date and time, in [Internet date and time format](https://tools.ietf.org/html/rfc3339#section-5.6). Seconds are required while fractional seconds are optional. Note: The regular expression provides guidance but does not reject all invalid dates.<br><br>**Constraints**: *Minimum Length*: `20`, *Maximum Length*: `64`, *Pattern*: `^[0-9]{4}-(0[1-9]\|1[0-2])-(0[1-9]\|[1-2][0-9]\|3[0-1])[T,t]([0-1][0-9]\|2[0-3]):[0-5][0-9]:([0-5][0-9]\|60)([.][0-9]+)?([Zz]\|[+-][0-9]{2}:[0-9]{2})$` | getAuctionClosingDate(): ?string | setAuctionClosingDate(?string auctionClosingDate): void |
|
||||
|
||||
## Example (as JSON)
|
||||
|
||||
```json
|
||||
{
|
||||
"auction_site": "auction_site6",
|
||||
"auction_item_site": "auction_item_site8",
|
||||
"auction_buyer_id": "auction_buyer_id0",
|
||||
"auction_closing_date": "auction_closing_date0"
|
||||
}
|
||||
```
|
||||
|
||||
@@ -17,7 +17,7 @@ The authorization with additional payment details, such as risk assessment and p
|
||||
| `amount` | [`?Money`](../../doc/models/money.md) | Optional | The currency and amount for a financial transaction, such as a balance or payment due. | getAmount(): ?Money | setAmount(?Money amount): void |
|
||||
| `invoiceId` | `?string` | Optional | The API caller-provided external invoice number for this order. Appears in both the payer's transaction history and the emails that the payer receives. | getInvoiceId(): ?string | setInvoiceId(?string invoiceId): void |
|
||||
| `customId` | `?string` | Optional | The API caller-provided external ID. Used to reconcile API caller-initiated transactions with PayPal transactions. Appears in transaction and settlement reports.<br><br>**Constraints**: *Maximum Length*: `255` | getCustomId(): ?string | setCustomId(?string customId): void |
|
||||
| `networkTransactionReference` | [`?NetworkTransactionReference`](../../doc/models/network-transaction-reference.md) | Optional | Reference values used by the card network to identify a transaction. | getNetworkTransactionReference(): ?NetworkTransactionReference | setNetworkTransactionReference(?NetworkTransactionReference networkTransactionReference): void |
|
||||
| `networkTransactionReference` | [`?NetworkTransaction`](../../doc/models/network-transaction.md) | Optional | Reference values used by the card network to identify a transaction. | getNetworkTransactionReference(): ?NetworkTransaction | setNetworkTransactionReference(?NetworkTransaction networkTransactionReference): void |
|
||||
| `sellerProtection` | [`?SellerProtection`](../../doc/models/seller-protection.md) | Optional | The level of protection offered as defined by [PayPal Seller Protection for Merchants](https://www.paypal.com/us/webapps/mpp/security/seller-protection). | getSellerProtection(): ?SellerProtection | setSellerProtection(?SellerProtection sellerProtection): void |
|
||||
| `expirationTime` | `?string` | Optional | The date and time, in [Internet date and time format](https://tools.ietf.org/html/rfc3339#section-5.6). Seconds are required while fractional seconds are optional. Note: The regular expression provides guidance but does not reject all invalid dates.<br><br>**Constraints**: *Minimum Length*: `20`, *Maximum Length*: `64`, *Pattern*: `^[0-9]{4}-(0[1-9]\|1[0-2])-(0[1-9]\|[1-2][0-9]\|3[0-1])[T,t]([0-1][0-9]\|2[0-3]):[0-5][0-9]:([0-5][0-9]\|60)([.][0-9]+)?([Zz]\|[+-][0-9]{2}:[0-9]{2})$` | getExpirationTime(): ?string | setExpirationTime(?string expirationTime): void |
|
||||
| `links` | [`?(LinkDescription[])`](../../doc/models/link-description.md) | Optional | An array of related [HATEOAS links](/docs/api/reference/api-responses/#hateoas-links). | getLinks(): ?array | setLinks(?array links): void |
|
||||
|
||||
@@ -17,7 +17,7 @@ The authorized payment transaction.
|
||||
| `amount` | [`?Money`](../../doc/models/money.md) | Optional | The currency and amount for a financial transaction, such as a balance or payment due. | getAmount(): ?Money | setAmount(?Money amount): void |
|
||||
| `invoiceId` | `?string` | Optional | The API caller-provided external invoice number for this order. Appears in both the payer's transaction history and the emails that the payer receives. | getInvoiceId(): ?string | setInvoiceId(?string invoiceId): void |
|
||||
| `customId` | `?string` | Optional | The API caller-provided external ID. Used to reconcile API caller-initiated transactions with PayPal transactions. Appears in transaction and settlement reports.<br><br>**Constraints**: *Maximum Length*: `255` | getCustomId(): ?string | setCustomId(?string customId): void |
|
||||
| `networkTransactionReference` | [`?NetworkTransactionReference`](../../doc/models/network-transaction-reference.md) | Optional | Reference values used by the card network to identify a transaction. | getNetworkTransactionReference(): ?NetworkTransactionReference | setNetworkTransactionReference(?NetworkTransactionReference networkTransactionReference): void |
|
||||
| `networkTransactionReference` | [`?NetworkTransaction`](../../doc/models/network-transaction.md) | Optional | Reference values used by the card network to identify a transaction. | getNetworkTransactionReference(): ?NetworkTransaction | setNetworkTransactionReference(?NetworkTransaction networkTransactionReference): void |
|
||||
| `sellerProtection` | [`?SellerProtection`](../../doc/models/seller-protection.md) | Optional | The level of protection offered as defined by [PayPal Seller Protection for Merchants](https://www.paypal.com/us/webapps/mpp/security/seller-protection). | getSellerProtection(): ?SellerProtection | setSellerProtection(?SellerProtection sellerProtection): void |
|
||||
| `expirationTime` | `?string` | Optional | The date and time, in [Internet date and time format](https://tools.ietf.org/html/rfc3339#section-5.6). Seconds are required while fractional seconds are optional. Note: The regular expression provides guidance but does not reject all invalid dates.<br><br>**Constraints**: *Minimum Length*: `20`, *Maximum Length*: `64`, *Pattern*: `^[0-9]{4}-(0[1-9]\|1[0-2])-(0[1-9]\|[1-2][0-9]\|3[0-1])[T,t]([0-1][0-9]\|2[0-3]):[0-5][0-9]:([0-5][0-9]\|60)([.][0-9]+)?([Zz]\|[+-][0-9]{2}:[0-9]{2})$` | getExpirationTime(): ?string | setExpirationTime(?string expirationTime): void |
|
||||
| `links` | [`?(LinkDescription[])`](../../doc/models/link-description.md) | Optional | An array of related [HATEOAS links](/docs/api/reference/api-responses/#hateoas-links). | getLinks(): ?array | setLinks(?array links): void |
|
||||
|
||||
40
doc/models/balance-information.md
Normal file
40
doc/models/balance-information.md
Normal file
@@ -0,0 +1,40 @@
|
||||
|
||||
# Balance Information
|
||||
|
||||
The Balance information.
|
||||
|
||||
## Structure
|
||||
|
||||
`BalanceInformation`
|
||||
|
||||
## Fields
|
||||
|
||||
| Name | Type | Tags | Description | Getter | Setter |
|
||||
| --- | --- | --- | --- | --- | --- |
|
||||
| `currency` | `string` | Required | The [three-character ISO-4217 currency code](/docs/integration/direct/rest/currency-codes/) that identifies the currency.<br><br>**Constraints**: *Minimum Length*: `3`, *Maximum Length*: `3` | getCurrency(): string | setCurrency(string currency): void |
|
||||
| `primary` | `?bool` | Optional | Optional field representing if the currency is primary currency or not. | getPrimary(): ?bool | setPrimary(?bool primary): void |
|
||||
| `totalBalance` | [`Money`](../../doc/models/money.md) | Required | The currency and amount for a financial transaction, such as a balance or payment due. | getTotalBalance(): Money | setTotalBalance(Money totalBalance): void |
|
||||
| `availableBalance` | [`?Money`](../../doc/models/money.md) | Optional | The currency and amount for a financial transaction, such as a balance or payment due. | getAvailableBalance(): ?Money | setAvailableBalance(?Money availableBalance): void |
|
||||
| `withheldBalance` | [`?Money`](../../doc/models/money.md) | Optional | The currency and amount for a financial transaction, such as a balance or payment due. | getWithheldBalance(): ?Money | setWithheldBalance(?Money withheldBalance): void |
|
||||
|
||||
## Example (as JSON)
|
||||
|
||||
```json
|
||||
{
|
||||
"currency": "currency4",
|
||||
"primary": false,
|
||||
"total_balance": {
|
||||
"currency_code": "currency_code6",
|
||||
"value": "value2"
|
||||
},
|
||||
"available_balance": {
|
||||
"currency_code": "currency_code8",
|
||||
"value": "value4"
|
||||
},
|
||||
"withheld_balance": {
|
||||
"currency_code": "currency_code2",
|
||||
"value": "value8"
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
78
doc/models/balances-response.md
Normal file
78
doc/models/balances-response.md
Normal file
@@ -0,0 +1,78 @@
|
||||
|
||||
# Balances Response
|
||||
|
||||
The balances response information.
|
||||
|
||||
## Structure
|
||||
|
||||
`BalancesResponse`
|
||||
|
||||
## Fields
|
||||
|
||||
| Name | Type | Tags | Description | Getter | Setter |
|
||||
| --- | --- | --- | --- | --- | --- |
|
||||
| `balances` | [`?(BalanceInformation[])`](../../doc/models/balance-information.md) | Optional | An array of balance detail objects.<br><br>**Constraints**: *Minimum Items*: `0`, *Maximum Items*: `200` | getBalances(): ?array | setBalances(?array balances): void |
|
||||
| `accountId` | `?string` | Optional | The PayPal payer ID, which is a masked version of the PayPal account number intended for use with third parties. The account number is reversibly encrypted and a proprietary variant of Base32 is used to encode the result.<br><br>**Constraints**: *Minimum Length*: `13`, *Maximum Length*: `13`, *Pattern*: `^[2-9A-HJ-NP-Z]{13}$` | getAccountId(): ?string | setAccountId(?string accountId): void |
|
||||
| `asOfTime` | `?string` | Optional | The date and time, in [Internet date and time format](https://tools.ietf.org/html/rfc3339#section-5.6). Seconds are required while fractional seconds are optional. Note: The regular expression provides guidance but does not reject all invalid dates.<br><br>**Constraints**: *Minimum Length*: `20`, *Maximum Length*: `64`, *Pattern*: `^[0-9]{4}-(0[1-9]\|1[0-2])-(0[1-9]\|[1-2][0-9]\|3[0-1])[T,t]([0-1][0-9]\|2[0-3]):[0-5][0-9]:([0-5][0-9]\|60)([.][0-9]+)?([Zz]\|[+-][0-9]{2}:[0-9]{2})$` | getAsOfTime(): ?string | setAsOfTime(?string asOfTime): void |
|
||||
| `lastRefreshTime` | `?string` | Optional | The date and time, in [Internet date and time format](https://tools.ietf.org/html/rfc3339#section-5.6). Seconds are required while fractional seconds are optional. Note: The regular expression provides guidance but does not reject all invalid dates.<br><br>**Constraints**: *Minimum Length*: `20`, *Maximum Length*: `64`, *Pattern*: `^[0-9]{4}-(0[1-9]\|1[0-2])-(0[1-9]\|[1-2][0-9]\|3[0-1])[T,t]([0-1][0-9]\|2[0-3]):[0-5][0-9]:([0-5][0-9]\|60)([.][0-9]+)?([Zz]\|[+-][0-9]{2}:[0-9]{2})$` | getLastRefreshTime(): ?string | setLastRefreshTime(?string lastRefreshTime): void |
|
||||
|
||||
## Example (as JSON)
|
||||
|
||||
```json
|
||||
{
|
||||
"balances": [
|
||||
{
|
||||
"currency": "currency0",
|
||||
"primary": false,
|
||||
"total_balance": {
|
||||
"currency_code": "currency_code6",
|
||||
"value": "value2"
|
||||
},
|
||||
"available_balance": {
|
||||
"currency_code": "currency_code8",
|
||||
"value": "value4"
|
||||
},
|
||||
"withheld_balance": {
|
||||
"currency_code": "currency_code2",
|
||||
"value": "value8"
|
||||
}
|
||||
},
|
||||
{
|
||||
"currency": "currency0",
|
||||
"primary": false,
|
||||
"total_balance": {
|
||||
"currency_code": "currency_code6",
|
||||
"value": "value2"
|
||||
},
|
||||
"available_balance": {
|
||||
"currency_code": "currency_code8",
|
||||
"value": "value4"
|
||||
},
|
||||
"withheld_balance": {
|
||||
"currency_code": "currency_code2",
|
||||
"value": "value8"
|
||||
}
|
||||
},
|
||||
{
|
||||
"currency": "currency0",
|
||||
"primary": false,
|
||||
"total_balance": {
|
||||
"currency_code": "currency_code6",
|
||||
"value": "value2"
|
||||
},
|
||||
"available_balance": {
|
||||
"currency_code": "currency_code8",
|
||||
"value": "value4"
|
||||
},
|
||||
"withheld_balance": {
|
||||
"currency_code": "currency_code2",
|
||||
"value": "value8"
|
||||
}
|
||||
}
|
||||
],
|
||||
"account_id": "account_id0",
|
||||
"as_of_time": "as_of_time2",
|
||||
"last_refresh_time": "last_refresh_time0"
|
||||
}
|
||||
```
|
||||
|
||||
34
doc/models/bank-request.md
Normal file
34
doc/models/bank-request.md
Normal file
@@ -0,0 +1,34 @@
|
||||
|
||||
# Bank Request
|
||||
|
||||
A Resource representing a request to vault a Bank used for ACH Debit.
|
||||
|
||||
## Structure
|
||||
|
||||
`BankRequest`
|
||||
|
||||
## Fields
|
||||
|
||||
| Name | Type | Tags | Description | Getter | Setter |
|
||||
| --- | --- | --- | --- | --- | --- |
|
||||
| `achDebit` | `mixed` | Optional | A Resource representing a request to vault a ACH Debit. | getAchDebit(): | setAchDebit( achDebit): void |
|
||||
| `sepaDebit` | [`?SepaDebitRequest`](../../doc/models/sepa-debit-request.md) | Optional | An API resource denoting a request to securely store a SEPA Debit. | getSepaDebit(): ?SepaDebitRequest | setSepaDebit(?SepaDebitRequest sepaDebit): void |
|
||||
|
||||
## Example (as JSON)
|
||||
|
||||
```json
|
||||
{
|
||||
"ach_debit": {
|
||||
"key1": "val1",
|
||||
"key2": "val2"
|
||||
},
|
||||
"sepa_debit": {
|
||||
"experience_context": {
|
||||
"locale": "locale6",
|
||||
"return_url": "return_url4",
|
||||
"cancel_url": "cancel_url6"
|
||||
}
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
61
doc/models/billing-cycle-override.md
Normal file
61
doc/models/billing-cycle-override.md
Normal file
@@ -0,0 +1,61 @@
|
||||
|
||||
# Billing Cycle Override
|
||||
|
||||
The billing cycle details to override at subscription level. The subscription billing cycle definition has to adhere to the plan billing cycle definition.
|
||||
|
||||
## Structure
|
||||
|
||||
`BillingCycleOverride`
|
||||
|
||||
## Fields
|
||||
|
||||
| Name | Type | Tags | Description | Getter | Setter |
|
||||
| --- | --- | --- | --- | --- | --- |
|
||||
| `pricingScheme` | [`?SubscriptionPricingScheme`](../../doc/models/subscription-pricing-scheme.md) | Optional | The pricing scheme details. | getPricingScheme(): ?SubscriptionPricingScheme | setPricingScheme(?SubscriptionPricingScheme pricingScheme): void |
|
||||
| `sequence` | `int` | Required | The order in which this cycle is to run among other billing cycles. For example, a trial billing cycle has a `sequence` of `1` while a regular billing cycle has a `sequence` of `2`, so that trial cycle runs before the regular cycle.<br><br>**Constraints**: `>= 1`, `<= 99` | getSequence(): int | setSequence(int sequence): void |
|
||||
| `totalCycles` | `?int` | Optional | The number of times this billing cycle gets executed. Trial billing cycles can only be executed a finite number of times (value between 1 and 999 for total_cycles). Regular billing cycles can be executed infinite times (value of 0 for total_cycles) or a finite number of times (value between 1 and 999 for total_cycles).<br><br>**Constraints**: `>= 0`, `<= 999` | getTotalCycles(): ?int | setTotalCycles(?int totalCycles): void |
|
||||
|
||||
## Example (as JSON)
|
||||
|
||||
```json
|
||||
{
|
||||
"pricing_scheme": {
|
||||
"version": 10,
|
||||
"fixed_price": {
|
||||
"currency_code": "currency_code4",
|
||||
"value": "value0"
|
||||
},
|
||||
"pricing_model": "VOLUME",
|
||||
"tiers": [
|
||||
{
|
||||
"starting_quantity": "starting_quantity8",
|
||||
"ending_quantity": "ending_quantity6",
|
||||
"amount": {
|
||||
"currency_code": "currency_code6",
|
||||
"value": "value0"
|
||||
}
|
||||
},
|
||||
{
|
||||
"starting_quantity": "starting_quantity8",
|
||||
"ending_quantity": "ending_quantity6",
|
||||
"amount": {
|
||||
"currency_code": "currency_code6",
|
||||
"value": "value0"
|
||||
}
|
||||
},
|
||||
{
|
||||
"starting_quantity": "starting_quantity8",
|
||||
"ending_quantity": "ending_quantity6",
|
||||
"amount": {
|
||||
"currency_code": "currency_code6",
|
||||
"value": "value0"
|
||||
}
|
||||
}
|
||||
],
|
||||
"create_time": "create_time4"
|
||||
},
|
||||
"sequence": 58,
|
||||
"total_cycles": 248
|
||||
}
|
||||
```
|
||||
|
||||
@@ -13,7 +13,6 @@ The billing cycle providing details of the billing frequency, amount, duration a
|
||||
| --- | --- | --- | --- | --- | --- |
|
||||
| `tenureType` | [`string(TenureType)`](../../doc/models/tenure-type.md) | Required | The tenure type of the billing cycle identifies if the billing cycle is a trial(free or discounted) or regular billing cycle.<br><br>**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `24`, *Pattern*: `^[A-Z_]+$` | getTenureType(): string | setTenureType(string tenureType): void |
|
||||
| `pricingScheme` | [`?PricingScheme`](../../doc/models/pricing-scheme.md) | Optional | The pricing scheme details. | getPricingScheme(): ?PricingScheme | setPricingScheme(?PricingScheme pricingScheme): void |
|
||||
| `frequency` | `mixed` | Optional | The frequency details for this billing cycle. | getFrequency(): | setFrequency( frequency): void |
|
||||
| `totalCycles` | `?int` | Optional | The number of times this billing cycle gets executed. Trial billing cycles can only be executed a finite number of times (value between 1 and 999 for total_cycles). Regular billing cycles can be executed infinite times (value of 0 for total_cycles) or a finite number of times (value between 1 and 999 for total_cycles).<br><br>**Default**: `1`<br><br>**Constraints**: `>= 0`, `<= 999` | getTotalCycles(): ?int | setTotalCycles(?int totalCycles): void |
|
||||
| `sequence` | `?int` | Optional | The order in which this cycle is to run among other billing cycles. For example, a trial billing cycle has a `sequence` of `1` while a regular billing cycle has a `sequence` of `2`, so that trial cycle runs before the regular cycle.<br><br>**Default**: `1`<br><br>**Constraints**: `>= 1`, `<= 3` | getSequence(): ?int | setSequence(?int sequence): void |
|
||||
| `startDate` | `?string` | Optional | The stand-alone date, in [Internet date and time format](https://tools.ietf.org/html/rfc3339#section-5.6). To represent special legal values, such as a date of birth, you should use dates with no associated time or time-zone data. Whenever possible, use the standard `date_time` type. This regular expression does not validate all dates. For example, February 31 is valid and nothing is known about leap years.<br><br>**Constraints**: *Minimum Length*: `10`, *Maximum Length*: `10`, *Pattern*: `^[0-9]{4}-(0[1-9]\|1[0-2])-(0[1-9]\|[1-2][0-9]\|3[0-1])$` | getStartDate(): ?string | setStartDate(?string startDate): void |
|
||||
@@ -36,10 +35,6 @@ The billing cycle providing details of the billing frequency, amount, duration a
|
||||
"value": "value6"
|
||||
}
|
||||
},
|
||||
"frequency": {
|
||||
"key1": "val1",
|
||||
"key2": "val2"
|
||||
},
|
||||
"start_date": "start_date0"
|
||||
}
|
||||
```
|
||||
|
||||
40
doc/models/billing-plan.md
Normal file
40
doc/models/billing-plan.md
Normal file
@@ -0,0 +1,40 @@
|
||||
|
||||
# Billing Plan
|
||||
|
||||
The plan details.
|
||||
|
||||
## Structure
|
||||
|
||||
`BillingPlan`
|
||||
|
||||
## Fields
|
||||
|
||||
| Name | Type | Tags | Description | Getter | Setter |
|
||||
| --- | --- | --- | --- | --- | --- |
|
||||
| `id` | `?string` | Optional | The unique PayPal-generated ID for the plan.<br><br>**Constraints**: *Minimum Length*: `26`, *Maximum Length*: `26`, *Pattern*: `^P-[A-Z0-9]*$` | getId(): ?string | setId(?string id): void |
|
||||
| `productId` | `?string` | Optional | The ID for the product.<br><br>**Constraints**: *Minimum Length*: `22`, *Maximum Length*: `22`, *Pattern*: `^PROD-[A-Z0-9]*$` | getProductId(): ?string | setProductId(?string productId): void |
|
||||
| `name` | `?string` | Optional | The plan name.<br><br>**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `127`, *Pattern*: `^.*$` | getName(): ?string | setName(?string name): void |
|
||||
| `status` | [`?string(SubscriptionPlanStatus)`](../../doc/models/subscription-plan-status.md) | Optional | The plan status.<br><br>**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `24`, *Pattern*: `^[A-Z_]+$` | getStatus(): ?string | setStatus(?string status): void |
|
||||
| `description` | `?string` | Optional | The detailed description of the plan.<br><br>**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `127`, *Pattern*: `^.*$` | getDescription(): ?string | setDescription(?string description): void |
|
||||
| `billingCycles` | [`?(SubscriptionBillingCycle[])`](../../doc/models/subscription-billing-cycle.md) | Optional | An array of billing cycles for trial billing and regular billing. A plan can have at most two trial cycles and only one regular cycle.<br><br>**Constraints**: *Minimum Items*: `1`, *Maximum Items*: `12` | getBillingCycles(): ?array | setBillingCycles(?array billingCycles): void |
|
||||
| `paymentPreferences` | [`?PaymentPreferences`](../../doc/models/payment-preferences.md) | Optional | The payment preferences for a subscription. | getPaymentPreferences(): ?PaymentPreferences | setPaymentPreferences(?PaymentPreferences paymentPreferences): void |
|
||||
| `merchantPreferences` | [`?MerchantPreferences`](../../doc/models/merchant-preferences.md) | Optional | The merchant preferences for a subscription. | getMerchantPreferences(): ?MerchantPreferences | setMerchantPreferences(?MerchantPreferences merchantPreferences): void |
|
||||
| `taxes` | [`?Taxes`](../../doc/models/taxes.md) | Optional | The tax details. | getTaxes(): ?Taxes | setTaxes(?Taxes taxes): void |
|
||||
| `quantitySupported` | `?bool` | Optional | Indicates whether you can subscribe to this plan by providing a quantity for the goods or service.<br><br>**Default**: `false` | getQuantitySupported(): ?bool | setQuantitySupported(?bool quantitySupported): void |
|
||||
| `createTime` | `?string` | Optional | The date and time, in [Internet date and time format](https://tools.ietf.org/html/rfc3339#section-5.6). Seconds are required while fractional seconds are optional. Note: The regular expression provides guidance but does not reject all invalid dates.<br><br>**Constraints**: *Minimum Length*: `20`, *Maximum Length*: `64`, *Pattern*: `^[0-9]{4}-(0[1-9]\|1[0-2])-(0[1-9]\|[1-2][0-9]\|3[0-1])[T,t]([0-1][0-9]\|2[0-3]):[0-5][0-9]:([0-5][0-9]\|60)([.][0-9]+)?([Zz]\|[+-][0-9]{2}:[0-9]{2})$` | getCreateTime(): ?string | setCreateTime(?string createTime): void |
|
||||
| `updateTime` | `?string` | Optional | The date and time, in [Internet date and time format](https://tools.ietf.org/html/rfc3339#section-5.6). Seconds are required while fractional seconds are optional. Note: The regular expression provides guidance but does not reject all invalid dates.<br><br>**Constraints**: *Minimum Length*: `20`, *Maximum Length*: `64`, *Pattern*: `^[0-9]{4}-(0[1-9]\|1[0-2])-(0[1-9]\|[1-2][0-9]\|3[0-1])[T,t]([0-1][0-9]\|2[0-3]):[0-5][0-9]:([0-5][0-9]\|60)([.][0-9]+)?([Zz]\|[+-][0-9]{2}:[0-9]{2})$` | getUpdateTime(): ?string | setUpdateTime(?string updateTime): void |
|
||||
| `links` | [`?(LinkDescription[])`](../../doc/models/link-description.md) | Optional | An array of request-related [HATEOAS links](/docs/api/reference/api-responses/#hateoas-links).<br><br>**Constraints**: *Minimum Items*: `1`, *Maximum Items*: `10` | getLinks(): ?array | setLinks(?array links): void |
|
||||
|
||||
## Example (as JSON)
|
||||
|
||||
```json
|
||||
{
|
||||
"quantity_supported": false,
|
||||
"id": "id0",
|
||||
"product_id": "product_id4",
|
||||
"name": "name0",
|
||||
"status": "CREATED",
|
||||
"description": "description0"
|
||||
}
|
||||
```
|
||||
|
||||
@@ -13,7 +13,7 @@ Customizes the payer experience during the approval process for the BLIK payment
|
||||
| --- | --- | --- | --- | --- | --- |
|
||||
| `brandName` | `?string` | Optional | The label that overrides the business name in the PayPal account on the PayPal site. The pattern is defined by an external party and supports Unicode.<br><br>**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `127`, *Pattern*: `^.*$` | getBrandName(): ?string | setBrandName(?string brandName): void |
|
||||
| `locale` | `?string` | Optional | The [language tag](https://tools.ietf.org/html/bcp47#section-2) for the language in which to localize the error-related strings, such as messages, issues, and suggested actions. The tag is made up of the [ISO 639-2 language code](https://www.loc.gov/standards/iso639-2/php/code_list.php), the optional [ISO-15924 script tag](https://www.unicode.org/iso15924/codelists.html), and the [ISO-3166 alpha-2 country code](/api/rest/reference/country-codes/) or [M49 region code](https://unstats.un.org/unsd/methodology/m49/).<br><br>**Constraints**: *Minimum Length*: `2`, *Maximum Length*: `10`, *Pattern*: `^[a-z]{2}(?:-[A-Z][a-z]{3})?(?:-(?:[A-Z]{2}\|[0-9]{3}))?$` | getLocale(): ?string | setLocale(?string locale): void |
|
||||
| `shippingPreference` | [`?string(ShippingPreference)`](../../doc/models/shipping-preference.md) | Optional | The location from which the shipping address is derived.<br><br>**Default**: `ShippingPreference::GET_FROM_FILE`<br><br>**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `24`, *Pattern*: `^[A-Z_]+$` | getShippingPreference(): ?string | setShippingPreference(?string shippingPreference): void |
|
||||
| `shippingPreference` | [`?string(ExperienceContextShippingPreference)`](../../doc/models/experience-context-shipping-preference.md) | Optional | The location from which the shipping address is derived.<br><br>**Default**: `ExperienceContextShippingPreference::GET_FROM_FILE`<br><br>**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `24`, *Pattern*: `^[A-Z_]+$` | getShippingPreference(): ?string | setShippingPreference(?string shippingPreference): void |
|
||||
| `returnUrl` | `?string` | Optional | Describes the URL. | getReturnUrl(): ?string | setReturnUrl(?string returnUrl): void |
|
||||
| `cancelUrl` | `?string` | Optional | Describes the URL. | getCancelUrl(): ?string | setCancelUrl(?string cancelUrl): void |
|
||||
| `consumerIp` | `?string` | Optional | An Internet Protocol address (IP address). This address assigns a numerical label to each device that is connected to a computer network through the Internet Protocol. Supports IPv4 and IPv6 addresses.<br><br>**Constraints**: *Minimum Length*: `7`, *Maximum Length*: `39`, *Pattern*: `^(([0-9]\|[1-9][0-9]\|1[0-9]{2}\|2[0-4][0-9]\|25[0-5])\.){3}([0-9]\|[1-9][0-9]\|1[0-9]{2}\|2[0-4][0-9]\|25[0-5])$\|^(([a-zA-Z]\|[a-zA-Z][a-zA-Z0-9\-]*[a-zA-Z0-9])\.)*([A-Za-z]\|[A-Za-z][A-Za-z0-9\-]*[A-Za-z0-9])$\|^\s*((([0-9A-Fa-f]{1,4}:){7}([0-9A-Fa-f]{1,4}\|:))\|(([0-9A-Fa-f]{1,4}:){6}(:[0-9A-Fa-f]{1,4}\|((25[0-5]\|2[0-4]\d\|1\d\d\|[1-9]?\d)(\.(25[0-5]\|2[0-4]\d\|1\d\d\|[1-9]?\d)){3})\|:))\|(([0-9A-Fa-f]{1,4}:){5}(((:[0-9A-Fa-f]{1,4}){1,2})\|:((25[0-5]\|2[0-4]\d\|1\d\d\|[1-9]?\d)(\.(25[0-5]\|2[0-4]\d\|1\d\d\|[1-9]?\d)){3})\|:))\|(([0-9A-Fa-f]{1,4}:){4}(((:[0-9A-Fa-f]{1,4}){1,3})\|((:[0-9A-Fa-f]{1,4})?:((25[0-5]\|2[0-4]\d\|1\d\d\|[1-9]?\d)(\.(25[0-5]\|2[0-4]\d\|1\d\d\|[1-9]?\d)){3}))\|:))\|(([0-9A-Fa-f]{1,4}:){3}(((:[0-9A-Fa-f]{1,4}){1,4})\|((:[0-9A-Fa-f]{1,4}){0,2}:((25[0-5]\|2[0-4]\d\|1\d\d\|[1-9]?\d)(\.(25[0-5]\|2[0-4]\d\|1\d\d\|[1-9]?\d)){3}))\|:))\|(([0-9A-Fa-f]{1,4}:){2}(((:[0-9A-Fa-f]{1,4}){1,5})\|((:[0-9A-Fa-f]{1,4}){0,3}:((25[0-5]\|2[0-4]\d\|1\d\d\|[1-9]?\d)(\.(25[0-5]\|2[0-4]\d\|1\d\d\|[1-9]?\d)){3}))\|:))\|(([0-9A-Fa-f]{1,4}:){1}(((:[0-9A-Fa-f]{1,4}){1,6})\|((:[0-9A-Fa-f]{1,4}){0,4}:((25[0-5]\|2[0-4]\d\|1\d\d\|[1-9]?\d)(\.(25[0-5]\|2[0-4]\d\|1\d\d\|[1-9]?\d)){3}))\|:))\|(:(((:[0-9A-Fa-f]{1,4}){1,7})\|((:[0-9A-Fa-f]{1,4}){0,5}:((25[0-5]\|2[0-4]\d\|1\d\d\|[1-9]?\d)(\.(25[0-5]\|2[0-4]\d\|1\d\d\|[1-9]?\d)){3}))\|:)))(%.+)?\s*$` | getConsumerIp(): ?string | setConsumerIp(?string consumerIp): void |
|
||||
|
||||
23
doc/models/cancel-subscription-request.md
Normal file
23
doc/models/cancel-subscription-request.md
Normal file
@@ -0,0 +1,23 @@
|
||||
|
||||
# Cancel Subscription Request
|
||||
|
||||
The cancel subscription request details.
|
||||
|
||||
## Structure
|
||||
|
||||
`CancelSubscriptionRequest`
|
||||
|
||||
## Fields
|
||||
|
||||
| Name | Type | Tags | Description | Getter | Setter |
|
||||
| --- | --- | --- | --- | --- | --- |
|
||||
| `reason` | `string` | Required | The reason for the cancellation of a subscription.<br><br>**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `128`, *Pattern*: `^.*$` | getReason(): string | setReason(string reason): void |
|
||||
|
||||
## Example (as JSON)
|
||||
|
||||
```json
|
||||
{
|
||||
"reason": "reason8"
|
||||
}
|
||||
```
|
||||
|
||||
@@ -1,6 +1,8 @@
|
||||
|
||||
# Capture Request
|
||||
|
||||
Captures either a portion or the full authorized amount of an authorized payment.
|
||||
|
||||
## Structure
|
||||
|
||||
`CaptureRequest`
|
||||
@@ -9,11 +11,11 @@
|
||||
|
||||
| Name | Type | Tags | Description | Getter | Setter |
|
||||
| --- | --- | --- | --- | --- | --- |
|
||||
| `invoiceId` | `?string` | Optional | The API caller-provided external invoice number for this order. Appears in both the payer's transaction history and the emails that the payer receives.<br><br>**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `127`, *Pattern*: `^.{1,127}$` | getInvoiceId(): ?string | setInvoiceId(?string invoiceId): void |
|
||||
| `noteToPayer` | `?string` | Optional | An informational note about this settlement. Appears in both the payer's transaction history and the emails that the payer receives.<br><br>**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `255`, *Pattern*: `^.{1,255}$` | getNoteToPayer(): ?string | setNoteToPayer(?string noteToPayer): void |
|
||||
| `amount` | [`?Money`](../../doc/models/money.md) | Optional | The currency and amount for a financial transaction, such as a balance or payment due. | getAmount(): ?Money | setAmount(?Money amount): void |
|
||||
| `invoiceId` | `?string` | Optional | The API caller-provided external invoice number for this order. Appears in both the payer's transaction history and the emails that the payer receives.<br><br>**Constraints**: *Maximum Length*: `127` | getInvoiceId(): ?string | setInvoiceId(?string invoiceId): void |
|
||||
| `finalCapture` | `?bool` | Optional | Indicates whether you can make additional captures against the authorized payment. Set to `true` if you do not intend to capture additional payments against the authorization. Set to `false` if you intend to capture additional payments against the authorization.<br><br>**Default**: `false` | getFinalCapture(): ?bool | setFinalCapture(?bool finalCapture): void |
|
||||
| `paymentInstruction` | [`?CapturePaymentInstruction`](../../doc/models/capture-payment-instruction.md) | Optional | Any additional payment instructions to be consider during payment processing. This processing instruction is applicable for Capturing an order or Authorizing an Order. | getPaymentInstruction(): ?CapturePaymentInstruction | setPaymentInstruction(?CapturePaymentInstruction paymentInstruction): void |
|
||||
| `noteToPayer` | `?string` | Optional | An informational note about this settlement. Appears in both the payer's transaction history and the emails that the payer receives.<br><br>**Constraints**: *Maximum Length*: `255` | getNoteToPayer(): ?string | setNoteToPayer(?string noteToPayer): void |
|
||||
| `softDescriptor` | `?string` | Optional | The payment descriptor on the payer's account statement.<br><br>**Constraints**: *Maximum Length*: `22` | getSoftDescriptor(): ?string | setSoftDescriptor(?string softDescriptor): void |
|
||||
|
||||
## Example (as JSON)
|
||||
@@ -21,12 +23,11 @@
|
||||
```json
|
||||
{
|
||||
"final_capture": false,
|
||||
"invoice_id": "invoice_id4",
|
||||
"note_to_payer": "note_to_payer6",
|
||||
"amount": {
|
||||
"currency_code": "currency_code6",
|
||||
"value": "value0"
|
||||
},
|
||||
"invoice_id": "invoice_id4",
|
||||
"payment_instruction": {
|
||||
"platform_fees": [
|
||||
{
|
||||
@@ -62,7 +63,8 @@
|
||||
],
|
||||
"disbursement_mode": "INSTANT",
|
||||
"payee_receivable_fx_rate_id": "payee_receivable_fx_rate_id0"
|
||||
}
|
||||
},
|
||||
"note_to_payer": "note_to_payer6"
|
||||
}
|
||||
```
|
||||
|
||||
|
||||
30
doc/models/capture-subscription-request.md
Normal file
30
doc/models/capture-subscription-request.md
Normal file
@@ -0,0 +1,30 @@
|
||||
|
||||
# Capture Subscription Request
|
||||
|
||||
The charge amount from the subscriber.
|
||||
|
||||
## Structure
|
||||
|
||||
`CaptureSubscriptionRequest`
|
||||
|
||||
## Fields
|
||||
|
||||
| Name | Type | Tags | Description | Getter | Setter |
|
||||
| --- | --- | --- | --- | --- | --- |
|
||||
| `note` | `string` | Required | The reason or note for the subscription charge.<br><br>**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `128`, *Pattern*: `^.*$` | getNote(): string | setNote(string note): void |
|
||||
| `captureType` | [`string(CaptureType)`](../../doc/models/capture-type.md) | Required | The type of capture.<br><br>**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `24`, *Pattern*: `^[A-Z_]+$` | getCaptureType(): string | setCaptureType(string captureType): void |
|
||||
| `amount` | [`Money`](../../doc/models/money.md) | Required | The currency and amount for a financial transaction, such as a balance or payment due. | getAmount(): Money | setAmount(Money amount): void |
|
||||
|
||||
## Example (as JSON)
|
||||
|
||||
```json
|
||||
{
|
||||
"note": "note4",
|
||||
"capture_type": "OUTSTANDING_BALANCE",
|
||||
"amount": {
|
||||
"currency_code": "currency_code6",
|
||||
"value": "value0"
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
15
doc/models/capture-type.md
Normal file
15
doc/models/capture-type.md
Normal file
@@ -0,0 +1,15 @@
|
||||
|
||||
# Capture Type
|
||||
|
||||
The type of capture.
|
||||
|
||||
## Enumeration
|
||||
|
||||
`CaptureType`
|
||||
|
||||
## Fields
|
||||
|
||||
| Name | Description |
|
||||
| --- | --- |
|
||||
| `OUTSTANDING_BALANCE` | The outstanding balance that the subscriber must clear. |
|
||||
|
||||
@@ -17,13 +17,13 @@ A captured payment.
|
||||
| `amount` | [`?Money`](../../doc/models/money.md) | Optional | The currency and amount for a financial transaction, such as a balance or payment due. | getAmount(): ?Money | setAmount(?Money amount): void |
|
||||
| `invoiceId` | `?string` | Optional | The API caller-provided external invoice number for this order. Appears in both the payer's transaction history and the emails that the payer receives. | getInvoiceId(): ?string | setInvoiceId(?string invoiceId): void |
|
||||
| `customId` | `?string` | Optional | The API caller-provided external ID. Used to reconcile API caller-initiated transactions with PayPal transactions. Appears in transaction and settlement reports.<br><br>**Constraints**: *Maximum Length*: `255` | getCustomId(): ?string | setCustomId(?string customId): void |
|
||||
| `networkTransactionReference` | [`?NetworkTransactionReference`](../../doc/models/network-transaction-reference.md) | Optional | Reference values used by the card network to identify a transaction. | getNetworkTransactionReference(): ?NetworkTransactionReference | setNetworkTransactionReference(?NetworkTransactionReference networkTransactionReference): void |
|
||||
| `networkTransactionReference` | [`?NetworkTransaction`](../../doc/models/network-transaction.md) | Optional | Reference values used by the card network to identify a transaction. | getNetworkTransactionReference(): ?NetworkTransaction | setNetworkTransactionReference(?NetworkTransaction networkTransactionReference): void |
|
||||
| `sellerProtection` | [`?SellerProtection`](../../doc/models/seller-protection.md) | Optional | The level of protection offered as defined by [PayPal Seller Protection for Merchants](https://www.paypal.com/us/webapps/mpp/security/seller-protection). | getSellerProtection(): ?SellerProtection | setSellerProtection(?SellerProtection sellerProtection): void |
|
||||
| `finalCapture` | `?bool` | Optional | Indicates whether you can make additional captures against the authorized payment. Set to `true` if you do not intend to capture additional payments against the authorization. Set to `false` if you intend to capture additional payments against the authorization.<br><br>**Default**: `false` | getFinalCapture(): ?bool | setFinalCapture(?bool finalCapture): void |
|
||||
| `sellerReceivableBreakdown` | [`?SellerReceivableBreakdown`](../../doc/models/seller-receivable-breakdown.md) | Optional | The detailed breakdown of the capture activity. This is not available for transactions that are in pending state. | getSellerReceivableBreakdown(): ?SellerReceivableBreakdown | setSellerReceivableBreakdown(?SellerReceivableBreakdown sellerReceivableBreakdown): void |
|
||||
| `disbursementMode` | [`?string(DisbursementMode)`](../../doc/models/disbursement-mode.md) | Optional | The funds that are held on behalf of the merchant.<br><br>**Default**: `DisbursementMode::INSTANT`<br><br>**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `16`, *Pattern*: `^[A-Z_]+$` | getDisbursementMode(): ?string | setDisbursementMode(?string disbursementMode): void |
|
||||
| `links` | [`?(LinkDescription[])`](../../doc/models/link-description.md) | Optional | An array of related [HATEOAS links](/docs/api/reference/api-responses/#hateoas-links). | getLinks(): ?array | setLinks(?array links): void |
|
||||
| `processorResponse` | [`?PaymentsProcessorResponse`](../../doc/models/payments-processor-response.md) | Optional | The processor response information for payment requests, such as direct credit card transactions. | getProcessorResponse(): ?PaymentsProcessorResponse | setProcessorResponse(?PaymentsProcessorResponse processorResponse): void |
|
||||
| `processorResponse` | [`?ProcessorResponse`](../../doc/models/processor-response.md) | Optional | The processor response information for payment requests, such as direct credit card transactions. | getProcessorResponse(): ?ProcessorResponse | setProcessorResponse(?ProcessorResponse processorResponse): void |
|
||||
| `createTime` | `?string` | Optional | The date and time, in [Internet date and time format](https://tools.ietf.org/html/rfc3339#section-5.6). Seconds are required while fractional seconds are optional. Note: The regular expression provides guidance but does not reject all invalid dates.<br><br>**Constraints**: *Minimum Length*: `20`, *Maximum Length*: `64`, *Pattern*: `^[0-9]{4}-(0[1-9]\|1[0-2])-(0[1-9]\|[1-2][0-9]\|3[0-1])[T,t]([0-1][0-9]\|2[0-3]):[0-5][0-9]:([0-5][0-9]\|60)([.][0-9]+)?([Zz]\|[+-][0-9]{2}:[0-9]{2})$` | getCreateTime(): ?string | setCreateTime(?string createTime): void |
|
||||
| `updateTime` | `?string` | Optional | The date and time, in [Internet date and time format](https://tools.ietf.org/html/rfc3339#section-5.6). Seconds are required while fractional seconds are optional. Note: The regular expression provides guidance but does not reject all invalid dates.<br><br>**Constraints**: *Minimum Length*: `20`, *Maximum Length*: `64`, *Pattern*: `^[0-9]{4}-(0[1-9]\|1[0-2])-(0[1-9]\|[1-2][0-9]\|3[0-1])[T,t]([0-1][0-9]\|2[0-3]):[0-5][0-9]:([0-5][0-9]\|60)([.][0-9]+)?([Zz]\|[+-][0-9]{2}:[0-9]{2})$` | getUpdateTime(): ?string | setUpdateTime(?string updateTime): void |
|
||||
| `supplementaryData` | [`?PaymentSupplementaryData`](../../doc/models/payment-supplementary-data.md) | Optional | The supplementary data. | getSupplementaryData(): ?PaymentSupplementaryData | setSupplementaryData(?PaymentSupplementaryData supplementaryData): void |
|
||||
|
||||
@@ -35,5 +35,10 @@ The card network or brand. Applies to credit, debit, gift, and payment cards.
|
||||
| `GE` | The GE Credit Union 3Point card payment network. |
|
||||
| `SYNCHRONY` | The Synchrony Financial (SYF) payment network. |
|
||||
| `EFTPOS` | The Electronic Fund Transfer At Point of Sale(EFTPOS) Debit card payment network. |
|
||||
| `CARTE_BANCAIRE` | The Carte Bancaire payment network. |
|
||||
| `STAR_ACCESS` | The Star Access payment network. |
|
||||
| `PULSE` | The Pulse payment network. |
|
||||
| `NYCE` | The NYCE payment network. |
|
||||
| `ACCEL` | The Accel payment network. |
|
||||
| `UNKNOWN` | UNKNOWN payment network. |
|
||||
|
||||
|
||||
34
doc/models/card-customer.md
Normal file
34
doc/models/card-customer.md
Normal file
@@ -0,0 +1,34 @@
|
||||
|
||||
# Card Customer
|
||||
|
||||
The details about a customer in PayPal's system of record.
|
||||
|
||||
## Structure
|
||||
|
||||
`CardCustomer`
|
||||
|
||||
## Fields
|
||||
|
||||
| Name | Type | Tags | Description | Getter | Setter |
|
||||
| --- | --- | --- | --- | --- | --- |
|
||||
| `id` | `?string` | Optional | The unique ID for a customer generated by PayPal.<br><br>**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `22`, *Pattern*: `^[0-9a-zA-Z_-]+$` | getId(): ?string | setId(?string id): void |
|
||||
| `emailAddress` | `?string` | Optional | The internationalized email address. Note: Up to 64 characters are allowed before and 255 characters are allowed after the @ sign. However, the generally accepted maximum length for an email address is 254 characters. The pattern verifies that an unquoted @ sign exists.<br><br>**Constraints**: *Minimum Length*: `3`, *Maximum Length*: `254`, *Pattern*: ``(?:[a-zA-Z0-9!#$%&'*+/=?^_`{\|}~-]+(?:\.[a-zA-Z0-9!#$%&'*+/=?^_`{\|}~-]+)*\|(?:[\x01-\x08\x0b\x0c\x0e-\x1f\x21\x23-\x5b\x5d-\x7f]\|\[\x01-\x09\x0b\x0c\x0e-\x7f])*")@(?:(?:[a-zA-Z0-9](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?\.)+[a-zA-Z0-9](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?\|\[(?:(?:(2(5[0-5]\|[0-4][0-9])\|1[0-9][0-9]\|[1-9]?[0-9]))\.){3}(?:(2(5[0-5]\|[0-4][0-9])\|1[0-9][0-9]\|[1-9]?[0-9])\|[a-zA-Z0-9-]*[a-zA-Z0-9]:(?:[\x01-\x08\x0b\x0c\x0e-\x1f\x21-\x5a\x53-\x7f]\|\[\x01-\x09\x0b\x0c\x0e-\x7f])+)\])`` | getEmailAddress(): ?string | setEmailAddress(?string emailAddress): void |
|
||||
| `phone` | [`?PhoneWithType`](../../doc/models/phone-with-type.md) | Optional | The phone information. | getPhone(): ?PhoneWithType | setPhone(?PhoneWithType phone): void |
|
||||
| `merchantCustomerId` | `?string` | Optional | Merchants and partners may already have a data-store where their customer information is persisted. Use merchant_customer_id to associate the PayPal-generated customer.id to your representation of a customer.<br><br>**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `64`, *Pattern*: `^[0-9a-zA-Z-_.^*$@#]+$` | getMerchantCustomerId(): ?string | setMerchantCustomerId(?string merchantCustomerId): void |
|
||||
|
||||
## Example (as JSON)
|
||||
|
||||
```json
|
||||
{
|
||||
"id": "id2",
|
||||
"email_address": "email_address0",
|
||||
"phone": {
|
||||
"phone_type": "OTHER",
|
||||
"phone_number": {
|
||||
"national_number": "national_number6"
|
||||
}
|
||||
},
|
||||
"merchant_customer_id": "merchant_customer_id4"
|
||||
}
|
||||
```
|
||||
|
||||
36
doc/models/card-response-with-billing-address.md
Normal file
36
doc/models/card-response-with-billing-address.md
Normal file
@@ -0,0 +1,36 @@
|
||||
|
||||
# Card Response With Billing Address
|
||||
|
||||
The payment card used to fund the payment. Card can be a credit or debit card.
|
||||
|
||||
## Structure
|
||||
|
||||
`CardResponseWithBillingAddress`
|
||||
|
||||
## Fields
|
||||
|
||||
| Name | Type | Tags | Description | Getter | Setter |
|
||||
| --- | --- | --- | --- | --- | --- |
|
||||
| `name` | `?string` | Optional | The card holder's name as it appears on the card.<br><br>**Constraints**: *Minimum Length*: `2`, *Maximum Length*: `300` | getName(): ?string | setName(?string name): void |
|
||||
| `billingAddress` | [`?Address`](../../doc/models/address.md) | Optional | The portable international postal address. Maps to [AddressValidationMetadata](https://github.com/googlei18n/libaddressinput/wiki/AddressValidationMetadata) and HTML 5.1 [Autofilling form controls: the autocomplete attribute](https://www.w3.org/TR/html51/sec-forms.html#autofilling-form-controls-the-autocomplete-attribute). | getBillingAddress(): ?Address | setBillingAddress(?Address billingAddress): void |
|
||||
| `expiry` | `?string` | Optional | The year and month, in ISO-8601 `YYYY-MM` date format. See [Internet date and time format](https://tools.ietf.org/html/rfc3339#section-5.6).<br><br>**Constraints**: *Minimum Length*: `7`, *Maximum Length*: `7`, *Pattern*: `^[0-9]{4}-(0[1-9]\|1[0-2])$` | getExpiry(): ?string | setExpiry(?string expiry): void |
|
||||
| `currencyCode` | `?string` | Optional | The [three-character ISO-4217 currency code](/api/rest/reference/currency-codes/) that identifies the currency.<br><br>**Constraints**: *Minimum Length*: `3`, *Maximum Length*: `3` | getCurrencyCode(): ?string | setCurrencyCode(?string currencyCode): void |
|
||||
|
||||
## Example (as JSON)
|
||||
|
||||
```json
|
||||
{
|
||||
"name": "name0",
|
||||
"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"
|
||||
},
|
||||
"expiry": "expiry8",
|
||||
"currency_code": "currency_code4"
|
||||
}
|
||||
```
|
||||
|
||||
@@ -29,11 +29,11 @@ The payment card to use to fund a payment. Card can be a credit or debit card.
|
||||
{
|
||||
"name": "name0",
|
||||
"last_digits": "last_digits4",
|
||||
"brand": "UNKNOWN",
|
||||
"brand": "CARTE_BANCAIRE",
|
||||
"available_networks": [
|
||||
"CONFIDIS",
|
||||
"CONFIGOGA",
|
||||
"CB_NATIONALE"
|
||||
"ELO",
|
||||
"DINERS",
|
||||
"CHINA_UNION_PAY"
|
||||
],
|
||||
"type": "CREDIT"
|
||||
}
|
||||
|
||||
@@ -14,7 +14,7 @@ Provides additional details to process a payment using a `card` that has been st
|
||||
| `paymentInitiator` | [`string(PaymentInitiator)`](../../doc/models/payment-initiator.md) | Required | The person or party who initiated or triggered the payment.<br><br>**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `255`, *Pattern*: `^[0-9A-Z_]+$` | getPaymentInitiator(): string | setPaymentInitiator(string paymentInitiator): void |
|
||||
| `paymentType` | [`string(StoredPaymentSourcePaymentType)`](../../doc/models/stored-payment-source-payment-type.md) | Required | Indicates the type of the stored payment_source payment.<br><br>**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `255`, *Pattern*: `^[0-9A-Z_]+$` | getPaymentType(): string | setPaymentType(string paymentType): void |
|
||||
| `usage` | [`?string(StoredPaymentSourceUsageType)`](../../doc/models/stored-payment-source-usage-type.md) | Optional | Indicates if this is a `first` or `subsequent` payment using a stored payment source (also referred to as stored credential or card on file).<br><br>**Default**: `StoredPaymentSourceUsageType::DERIVED`<br><br>**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `255`, *Pattern*: `^[0-9A-Z_]+$` | getUsage(): ?string | setUsage(?string usage): void |
|
||||
| `previousNetworkTransactionReference` | [`?NetworkTransactionReference`](../../doc/models/network-transaction-reference.md) | Optional | Reference values used by the card network to identify a transaction. | getPreviousNetworkTransactionReference(): ?NetworkTransactionReference | setPreviousNetworkTransactionReference(?NetworkTransactionReference previousNetworkTransactionReference): void |
|
||||
| `previousNetworkTransactionReference` | [`?NetworkTransaction`](../../doc/models/network-transaction.md) | Optional | Reference values used by the card network to identify a transaction. | getPreviousNetworkTransactionReference(): ?NetworkTransaction | setPreviousNetworkTransactionReference(?NetworkTransaction previousNetworkTransactionReference): void |
|
||||
|
||||
## Example (as JSON)
|
||||
|
||||
@@ -26,7 +26,7 @@ Provides additional details to process a payment using a `card` that has been st
|
||||
"previous_network_transaction_reference": {
|
||||
"id": "id6",
|
||||
"date": "date2",
|
||||
"network": "DELTA",
|
||||
"network": "CONFIDIS",
|
||||
"acquirer_reference_number": "acquirer_reference_number8"
|
||||
}
|
||||
}
|
||||
|
||||
@@ -13,8 +13,8 @@ Card Verification details including the authorization details and 3D SECURE deta
|
||||
| --- | --- | --- | --- | --- | --- |
|
||||
| `networkTransactionId` | `?string` | Optional | DEPRECATED. This field is DEPRECATED. Please find the network transaction id data in the 'id' field under the 'network_transaction_reference' object instead of the 'verification' object.<br><br>**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `1024`, *Pattern*: `^[a-zA-Z0-9-_@.:&+=*^'~#!$%()]+$` | getNetworkTransactionId(): ?string | setNetworkTransactionId(?string networkTransactionId): void |
|
||||
| `date` | `?string` | Optional | DEPRECATED. This field is DEPRECATED. Please find the date data in the 'date' field under the 'network_transaction_reference' object instead of the 'verification' object.<br><br>**Constraints**: *Minimum Length*: `4`, *Maximum Length*: `4`, *Pattern*: `^[0-9]+$` | getDate(): ?string | setDate(?string date): void |
|
||||
| `network` | [`?string(CardBrand)`](../../doc/models/card-brand.md) | Optional | The card network or brand. Applies to credit, debit, gift, and payment cards.<br><br>**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `255`, *Pattern*: `^[A-Z_]+$` | getNetwork(): ?string | setNetwork(?string network): void |
|
||||
| `time` | `?string` | Optional | The date and time, in [Internet date and time format](https://tools.ietf.org/html/rfc3339#section-5.6). Seconds are required while fractional seconds are optional. Note: The regular expression provides guidance but does not reject all invalid dates.<br><br>**Constraints**: *Minimum Length*: `20`, *Maximum Length*: `64`, *Pattern*: `^[0-9]{4}-(0[1-9]\|1[0-2])-(0[1-9]\|[1-2][0-9]\|3[0-1])[T,t]([0-1][0-9]\|2[0-3]):[0-5][0-9]:([0-5][0-9]\|60)([.][0-9]+)?([Zz]\|[+-][0-9]{2}:[0-9]{2})$` | getTime(): ?string | setTime(?string time): void |
|
||||
| `network` | [`?string(CardBrand)`](../../doc/models/card-brand.md) | Optional | DEPRECATED. This field is DEPRECATED. Please find the network data in the 'network' field under the 'network_transaction_reference' object instead of the 'verification' object.<br><br>**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `255`, *Pattern*: `^[A-Z_]+$` | getNetwork(): ?string | setNetwork(?string network): void |
|
||||
| `time` | `?string` | Optional | DEPRECATED. This field is DEPRECATED. Please find the time data in the 'time' field under the 'network_transaction_reference' object instead of the 'verification' object.<br><br>**Constraints**: *Minimum Length*: `20`, *Maximum Length*: `64`, *Pattern*: `^[0-9]{4}-(0[1-9]\|1[0-2])-(0[1-9]\|[1-2][0-9]\|3[0-1])[T,t]([0-1][0-9]\|2[0-3]):[0-5][0-9]:([0-5][0-9]\|60)([.][0-9]+)?([Zz]\|[+-][0-9]{2}:[0-9]{2})$` | getTime(): ?string | setTime(?string time): void |
|
||||
| `amount` | [`?Money`](../../doc/models/money.md) | Optional | The currency and amount for a financial transaction, such as a balance or payment due. | getAmount(): ?Money | setAmount(?Money amount): void |
|
||||
| `processorResponse` | [`?CardVerificationProcessorResponse`](../../doc/models/card-verification-processor-response.md) | Optional | The processor response information for payment requests, such as direct credit card transactions. | getProcessorResponse(): ?CardVerificationProcessorResponse | setProcessorResponse(?CardVerificationProcessorResponse processorResponse): void |
|
||||
| `threeDSecure` | `mixed` | Optional | DEPRECATED. This field is DEPRECATED. Please find the 3D secure authentication data in the 'three_d_secure' object under the 'authentication_result' object instead of the 'verification' object. | getThreeDSecure(): | setThreeDSecure( threeDSecure): void |
|
||||
@@ -25,7 +25,7 @@ Card Verification details including the authorization details and 3D SECURE deta
|
||||
{
|
||||
"network_transaction_id": "network_transaction_id4",
|
||||
"date": "date8",
|
||||
"network": "EFTPOS",
|
||||
"network": "ACCEL",
|
||||
"time": "time2",
|
||||
"amount": {
|
||||
"currency_code": "currency_code6",
|
||||
|
||||
35
doc/models/cart-information.md
Normal file
35
doc/models/cart-information.md
Normal file
@@ -0,0 +1,35 @@
|
||||
|
||||
# Cart Information
|
||||
|
||||
The cart information.
|
||||
|
||||
## Structure
|
||||
|
||||
`CartInformation`
|
||||
|
||||
## Fields
|
||||
|
||||
| Name | Type | Tags | Description | Getter | Setter |
|
||||
| --- | --- | --- | --- | --- | --- |
|
||||
| `itemDetails` | [`?(ItemDetails[])`](../../doc/models/item-details.md) | Optional | An array of item details.<br><br>**Constraints**: *Minimum Items*: `1`, *Maximum Items*: `32767` | getItemDetails(): ?array | setItemDetails(?array itemDetails): void |
|
||||
| `taxInclusive` | `?bool` | Optional | Indicates whether the item amount or the shipping amount already includes tax.<br><br>**Default**: `false` | getTaxInclusive(): ?bool | setTaxInclusive(?bool taxInclusive): void |
|
||||
| `paypalInvoiceId` | `?string` | Optional | The ID of the invoice. Appears for only PayPal-generated invoices.<br><br>**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `127`, *Pattern*: `^[a-zA-Z0-9_'\-., ":;\!?]*$` | getPaypalInvoiceId(): ?string | setPaypalInvoiceId(?string paypalInvoiceId): void |
|
||||
|
||||
## Example (as JSON)
|
||||
|
||||
```json
|
||||
{
|
||||
"tax_inclusive": false,
|
||||
"item_details": [
|
||||
{
|
||||
"item_code": "item_code0",
|
||||
"item_name": "item_name8",
|
||||
"item_description": "item_description4",
|
||||
"item_options": "item_options2",
|
||||
"item_quantity": "item_quantity2"
|
||||
}
|
||||
],
|
||||
"paypal_invoice_id": "paypal_invoice_id2"
|
||||
}
|
||||
```
|
||||
|
||||
25
doc/models/checkout-option.md
Normal file
25
doc/models/checkout-option.md
Normal file
@@ -0,0 +1,25 @@
|
||||
|
||||
# Checkout Option
|
||||
|
||||
A checkout option as a name-and-value pair.
|
||||
|
||||
## Structure
|
||||
|
||||
`CheckoutOption`
|
||||
|
||||
## Fields
|
||||
|
||||
| Name | Type | Tags | Description | Getter | Setter |
|
||||
| --- | --- | --- | --- | --- | --- |
|
||||
| `checkoutOptionName` | `?string` | Optional | The checkout option name, such as `color` or `texture`.<br><br>**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `200`, *Pattern*: `^[a-zA-Z0-9_'\-., ":;\!?]*$` | getCheckoutOptionName(): ?string | setCheckoutOptionName(?string checkoutOptionName): void |
|
||||
| `checkoutOptionValue` | `?string` | Optional | The checkout option value. For example, the checkout option `color` might be `blue` or `red` while the checkout option `texture` might be `smooth` or `rippled`.<br><br>**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `200`, *Pattern*: `^[a-zA-Z0-9_'\-., ":;\!?]*$` | getCheckoutOptionValue(): ?string | setCheckoutOptionValue(?string checkoutOptionValue): void |
|
||||
|
||||
## Example (as JSON)
|
||||
|
||||
```json
|
||||
{
|
||||
"checkout_option_name": "checkout_option_name6",
|
||||
"checkout_option_value": "checkout_option_value0"
|
||||
}
|
||||
```
|
||||
|
||||
@@ -97,7 +97,7 @@ Payer confirms the intent to pay for the Order using the provided payment source
|
||||
"previous_network_transaction_reference": {
|
||||
"id": "id6",
|
||||
"date": "date2",
|
||||
"network": "DELTA",
|
||||
"network": "CONFIDIS",
|
||||
"acquirer_reference_number": "acquirer_reference_number8"
|
||||
}
|
||||
}
|
||||
|
||||
82
doc/models/create-subscription-request.md
Normal file
82
doc/models/create-subscription-request.md
Normal file
@@ -0,0 +1,82 @@
|
||||
|
||||
# Create Subscription Request
|
||||
|
||||
The create subscription request details.
|
||||
|
||||
## Structure
|
||||
|
||||
`CreateSubscriptionRequest`
|
||||
|
||||
## Fields
|
||||
|
||||
| Name | Type | Tags | Description | Getter | Setter |
|
||||
| --- | --- | --- | --- | --- | --- |
|
||||
| `planId` | `string` | Required | The ID of the plan.<br><br>**Constraints**: *Minimum Length*: `26`, *Maximum Length*: `26`, *Pattern*: `^P-[A-Z0-9]*$` | getPlanId(): string | setPlanId(string planId): void |
|
||||
| `startTime` | `?string` | Optional | The date and time, in [Internet date and time format](https://tools.ietf.org/html/rfc3339#section-5.6). Seconds are required while fractional seconds are optional. Note: The regular expression provides guidance but does not reject all invalid dates.<br><br>**Constraints**: *Minimum Length*: `20`, *Maximum Length*: `64`, *Pattern*: `^[0-9]{4}-(0[1-9]\|1[0-2])-(0[1-9]\|[1-2][0-9]\|3[0-1])[T,t]([0-1][0-9]\|2[0-3]):[0-5][0-9]:([0-5][0-9]\|60)([.][0-9]+)?([Zz]\|[+-][0-9]{2}:[0-9]{2})$` | getStartTime(): ?string | setStartTime(?string startTime): void |
|
||||
| `quantity` | `?string` | Optional | The quantity of the product in the subscription.<br><br>**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `32`, *Pattern*: `^([0-9]+\|([0-9]+)?[.][0-9]+)$` | getQuantity(): ?string | setQuantity(?string quantity): void |
|
||||
| `shippingAmount` | [`?Money`](../../doc/models/money.md) | Optional | The currency and amount for a financial transaction, such as a balance or payment due. | getShippingAmount(): ?Money | setShippingAmount(?Money shippingAmount): void |
|
||||
| `subscriber` | [`?SubscriberRequest`](../../doc/models/subscriber-request.md) | Optional | The subscriber request information . | getSubscriber(): ?SubscriberRequest | setSubscriber(?SubscriberRequest subscriber): void |
|
||||
| `autoRenewal` | `?bool` | Optional | DEPRECATED. Indicates whether the subscription auto-renews after the billing cycles complete.<br><br>**Default**: `false` | getAutoRenewal(): ?bool | setAutoRenewal(?bool autoRenewal): void |
|
||||
| `applicationContext` | [`?SubscriptionApplicationContext`](../../doc/models/subscription-application-context.md) | Optional | DEPRECATED. The application context, which customizes the payer experience during the subscription approval process with PayPal. | getApplicationContext(): ?SubscriptionApplicationContext | setApplicationContext(?SubscriptionApplicationContext applicationContext): void |
|
||||
| `customId` | `?string` | Optional | The custom id for the subscription. Can be invoice id.<br><br>**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `127`, *Pattern*: `^[\x20-\x7E]+` | getCustomId(): ?string | setCustomId(?string customId): void |
|
||||
| `plan` | [`?PlanOverride`](../../doc/models/plan-override.md) | Optional | An inline plan object to customise the subscription. You can override plan level default attributes by providing customised values for the subscription in this object. | getPlan(): ?PlanOverride | setPlan(?PlanOverride plan): void |
|
||||
|
||||
## Example (as JSON)
|
||||
|
||||
```json
|
||||
{
|
||||
"plan_id": "plan_id8",
|
||||
"auto_renewal": false,
|
||||
"start_time": "start_time0",
|
||||
"quantity": "quantity2",
|
||||
"shipping_amount": {
|
||||
"currency_code": "currency_code0",
|
||||
"value": "value6"
|
||||
},
|
||||
"subscriber": {
|
||||
"name": {
|
||||
"given_name": "given_name2",
|
||||
"surname": "surname8"
|
||||
},
|
||||
"phone": {
|
||||
"phone_type": "OTHER",
|
||||
"phone_number": {
|
||||
"national_number": "national_number6"
|
||||
}
|
||||
},
|
||||
"shipping_address": {
|
||||
"name": {
|
||||
"full_name": "full_name6"
|
||||
},
|
||||
"email_address": "email_address8",
|
||||
"phone_number": {
|
||||
"country_code": "country_code2",
|
||||
"national_number": "national_number6"
|
||||
},
|
||||
"type": "PICKUP_IN_STORE",
|
||||
"options": [
|
||||
{
|
||||
"id": "id2",
|
||||
"label": "label2",
|
||||
"type": "SHIPPING",
|
||||
"amount": {
|
||||
"currency_code": "currency_code6",
|
||||
"value": "value0"
|
||||
},
|
||||
"selected": false
|
||||
}
|
||||
]
|
||||
},
|
||||
"payment_source": {
|
||||
"card": {
|
||||
"name": "name6",
|
||||
"number": "number6",
|
||||
"expiry": "expiry4",
|
||||
"security_code": "security_code8",
|
||||
"type": "UNKNOWN"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
@@ -48,7 +48,7 @@ Collection of payment tokens saved for a given customer.
|
||||
"card": {
|
||||
"name": "name6",
|
||||
"last_digits": "last_digits0",
|
||||
"brand": "RUPAY",
|
||||
"brand": "CB_NATIONALE",
|
||||
"expiry": "expiry4",
|
||||
"billing_address": {
|
||||
"address_line_1": "address_line_12",
|
||||
@@ -66,6 +66,7 @@ Collection of payment tokens saved for a given customer.
|
||||
"name": {
|
||||
"full_name": "full_name6"
|
||||
},
|
||||
"email_address": "email_address2",
|
||||
"phone_number": {
|
||||
"country_code": "country_code2",
|
||||
"national_number": "national_number6"
|
||||
@@ -90,6 +91,7 @@ Collection of payment tokens saved for a given customer.
|
||||
"name": {
|
||||
"full_name": "full_name6"
|
||||
},
|
||||
"email_address": "email_address2",
|
||||
"phone_number": {
|
||||
"country_code": "country_code2",
|
||||
"national_number": "national_number6"
|
||||
@@ -112,7 +114,7 @@ Collection of payment tokens saved for a given customer.
|
||||
"name": "name6",
|
||||
"last_digits": "last_digits0",
|
||||
"type": "UNKNOWN",
|
||||
"brand": "RUPAY",
|
||||
"brand": "CB_NATIONALE",
|
||||
"billing_address": {
|
||||
"address_line_1": "address_line_12",
|
||||
"address_line_2": "address_line_28",
|
||||
@@ -147,7 +149,7 @@ Collection of payment tokens saved for a given customer.
|
||||
"card": {
|
||||
"name": "name6",
|
||||
"last_digits": "last_digits0",
|
||||
"brand": "RUPAY",
|
||||
"brand": "CB_NATIONALE",
|
||||
"expiry": "expiry4",
|
||||
"billing_address": {
|
||||
"address_line_1": "address_line_12",
|
||||
@@ -165,6 +167,7 @@ Collection of payment tokens saved for a given customer.
|
||||
"name": {
|
||||
"full_name": "full_name6"
|
||||
},
|
||||
"email_address": "email_address2",
|
||||
"phone_number": {
|
||||
"country_code": "country_code2",
|
||||
"national_number": "national_number6"
|
||||
@@ -189,6 +192,7 @@ Collection of payment tokens saved for a given customer.
|
||||
"name": {
|
||||
"full_name": "full_name6"
|
||||
},
|
||||
"email_address": "email_address2",
|
||||
"phone_number": {
|
||||
"country_code": "country_code2",
|
||||
"national_number": "national_number6"
|
||||
@@ -211,7 +215,7 @@ Collection of payment tokens saved for a given customer.
|
||||
"name": "name6",
|
||||
"last_digits": "last_digits0",
|
||||
"type": "UNKNOWN",
|
||||
"brand": "RUPAY",
|
||||
"brand": "CB_NATIONALE",
|
||||
"billing_address": {
|
||||
"address_line_1": "address_line_12",
|
||||
"address_line_2": "address_line_28",
|
||||
|
||||
33
doc/models/cycle-execution.md
Normal file
33
doc/models/cycle-execution.md
Normal file
@@ -0,0 +1,33 @@
|
||||
|
||||
# Cycle Execution
|
||||
|
||||
The regular and trial execution details for a billing cycle.
|
||||
|
||||
## Structure
|
||||
|
||||
`CycleExecution`
|
||||
|
||||
## Fields
|
||||
|
||||
| Name | Type | Tags | Description | Getter | Setter |
|
||||
| --- | --- | --- | --- | --- | --- |
|
||||
| `tenureType` | [`string(TenureType)`](../../doc/models/tenure-type.md) | Required | The type of the billing cycle.<br><br>**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `24`, *Pattern*: `^[A-Z_]+$` | getTenureType(): string | setTenureType(string tenureType): void |
|
||||
| `sequence` | `int` | Required | The order in which to run this cycle among other billing cycles.<br><br>**Constraints**: `>= 0`, `<= 99` | getSequence(): int | setSequence(int sequence): void |
|
||||
| `cyclesCompleted` | `int` | Required | The number of billing cycles that have completed.<br><br>**Constraints**: `>= 0`, `<= 9999` | getCyclesCompleted(): int | setCyclesCompleted(int cyclesCompleted): void |
|
||||
| `cyclesRemaining` | `?int` | Optional | For a finite billing cycle, cycles_remaining is the number of remaining cycles. For an infinite billing cycle, cycles_remaining is set as 0.<br><br>**Constraints**: `>= 0`, `<= 9999` | getCyclesRemaining(): ?int | setCyclesRemaining(?int cyclesRemaining): void |
|
||||
| `currentPricingSchemeVersion` | `?int` | Optional | The active pricing scheme version for the billing cycle.<br><br>**Constraints**: `>= 1`, `<= 99` | getCurrentPricingSchemeVersion(): ?int | setCurrentPricingSchemeVersion(?int currentPricingSchemeVersion): void |
|
||||
| `totalCycles` | `?int` | Optional | The number of times this billing cycle gets executed. Trial billing cycles can only be executed a finite number of times (value between 1 and 999 for total_cycles). Regular billing cycles can be executed infinite times (value of 0 for total_cycles) or a finite number of times (value between 1 and 999 for total_cycles).<br><br>**Constraints**: `>= 0`, `<= 999` | getTotalCycles(): ?int | setTotalCycles(?int totalCycles): void |
|
||||
|
||||
## Example (as JSON)
|
||||
|
||||
```json
|
||||
{
|
||||
"tenure_type": "REGULAR",
|
||||
"sequence": 99,
|
||||
"cycles_completed": 172,
|
||||
"cycles_remaining": 208,
|
||||
"current_pricing_scheme_version": 99,
|
||||
"total_cycles": 60
|
||||
}
|
||||
```
|
||||
|
||||
47
doc/models/default-error-exception.md
Normal file
47
doc/models/default-error-exception.md
Normal file
@@ -0,0 +1,47 @@
|
||||
|
||||
# Default Error Exception
|
||||
|
||||
The error details.
|
||||
|
||||
## Structure
|
||||
|
||||
`DefaultErrorException`
|
||||
|
||||
## Fields
|
||||
|
||||
| Name | Type | Tags | Description | Getter | Setter |
|
||||
| --- | --- | --- | --- | --- | --- |
|
||||
| `name` | `string` | Required | The human-readable, unique name of the error. | getName(): string | setName(string name): void |
|
||||
| `message` | `string` | Required | The message that describes the error. | getMessage(): string | setMessage(string message): void |
|
||||
| `debugId` | `string` | Required | The PayPal internal ID. Used for correlation purposes. | getDebugId(): string | setDebugId(string debugId): void |
|
||||
| `informationLink` | `?string` | Optional | The information link, or URI, that shows detailed information about this error for the developer. | getInformationLink(): ?string | setInformationLink(?string informationLink): void |
|
||||
| `details` | [`?(TransactionSearchErrorDetails[])`](../../doc/models/transaction-search-error-details.md) | Optional | An array of additional details about the error. | getDetails(): ?array | setDetails(?array details): void |
|
||||
| `links` | [`?(LinkDescription[])`](../../doc/models/link-description.md) | Optional | An array of request-related [HATEOAS links](/docs/api/reference/api-responses/#hateoas-links). | getLinks(): ?array | setLinks(?array links): void |
|
||||
|
||||
## Example (as JSON)
|
||||
|
||||
```json
|
||||
{
|
||||
"name": "name2",
|
||||
"message": "message2",
|
||||
"debug_id": "debug_id8",
|
||||
"information_link": "information_link4",
|
||||
"details": [
|
||||
{
|
||||
"field": "field4",
|
||||
"value": "value2",
|
||||
"location": "location4",
|
||||
"issue": "issue6",
|
||||
"description": "description0"
|
||||
}
|
||||
],
|
||||
"links": [
|
||||
{
|
||||
"href": "href6",
|
||||
"rel": "rel0",
|
||||
"method": "HEAD"
|
||||
}
|
||||
]
|
||||
}
|
||||
```
|
||||
|
||||
17
doc/models/experience-context-shipping-preference.md
Normal file
17
doc/models/experience-context-shipping-preference.md
Normal file
@@ -0,0 +1,17 @@
|
||||
|
||||
# Experience Context Shipping Preference
|
||||
|
||||
The location from which the shipping address is derived., The shipping preference. This only applies to PayPal payment source., The shipping preference. This only applies to PayPal payment source., The location from which the shipping address is derived.
|
||||
|
||||
## Enumeration
|
||||
|
||||
`ExperienceContextShippingPreference`
|
||||
|
||||
## Fields
|
||||
|
||||
| Name | Description |
|
||||
| --- | --- |
|
||||
| `GET_FROM_FILE` | Get the customer-provided shipping address on the PayPal site. |
|
||||
| `NO_SHIPPING` | Redacts the shipping address from the PayPal site. Recommended for digital goods. |
|
||||
| `SET_PROVIDED_ADDRESS` | Merchant sends the shipping address using purchase_units.shipping.address. The customer cannot change this address on the PayPal site. |
|
||||
|
||||
@@ -13,7 +13,7 @@ Customizes the payer experience during the approval process for the payment.
|
||||
| --- | --- | --- | --- | --- | --- |
|
||||
| `brandName` | `?string` | Optional | The label that overrides the business name in the PayPal account on the PayPal site. The pattern is defined by an external party and supports Unicode.<br><br>**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `127`, *Pattern*: `^.*$` | getBrandName(): ?string | setBrandName(?string brandName): void |
|
||||
| `locale` | `?string` | Optional | The [language tag](https://tools.ietf.org/html/bcp47#section-2) for the language in which to localize the error-related strings, such as messages, issues, and suggested actions. The tag is made up of the [ISO 639-2 language code](https://www.loc.gov/standards/iso639-2/php/code_list.php), the optional [ISO-15924 script tag](https://www.unicode.org/iso15924/codelists.html), and the [ISO-3166 alpha-2 country code](/api/rest/reference/country-codes/) or [M49 region code](https://unstats.un.org/unsd/methodology/m49/).<br><br>**Constraints**: *Minimum Length*: `2`, *Maximum Length*: `10`, *Pattern*: `^[a-z]{2}(?:-[A-Z][a-z]{3})?(?:-(?:[A-Z]{2}\|[0-9]{3}))?$` | getLocale(): ?string | setLocale(?string locale): void |
|
||||
| `shippingPreference` | [`?string(ShippingPreference)`](../../doc/models/shipping-preference.md) | Optional | The location from which the shipping address is derived.<br><br>**Default**: `ShippingPreference::GET_FROM_FILE`<br><br>**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `24`, *Pattern*: `^[A-Z_]+$` | getShippingPreference(): ?string | setShippingPreference(?string shippingPreference): void |
|
||||
| `shippingPreference` | [`?string(ExperienceContextShippingPreference)`](../../doc/models/experience-context-shipping-preference.md) | Optional | The location from which the shipping address is derived.<br><br>**Default**: `ExperienceContextShippingPreference::GET_FROM_FILE`<br><br>**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `24`, *Pattern*: `^[A-Z_]+$` | getShippingPreference(): ?string | setShippingPreference(?string shippingPreference): void |
|
||||
| `returnUrl` | `?string` | Optional | Describes the URL. | getReturnUrl(): ?string | setReturnUrl(?string returnUrl): void |
|
||||
| `cancelUrl` | `?string` | Optional | Describes the URL. | getCancelUrl(): ?string | setCancelUrl(?string cancelUrl): void |
|
||||
|
||||
|
||||
18
doc/models/experience-status.md
Normal file
18
doc/models/experience-status.md
Normal file
@@ -0,0 +1,18 @@
|
||||
|
||||
# Experience Status
|
||||
|
||||
This field indicates the status of PayPal's Checkout experience throughout the order lifecycle. The values reflect the current stage of the checkout process.
|
||||
|
||||
## Enumeration
|
||||
|
||||
`ExperienceStatus`
|
||||
|
||||
## Fields
|
||||
|
||||
| Name | Description |
|
||||
| --- | --- |
|
||||
| `NOT_STARTED` | PayPal checkout process has not yet begun. |
|
||||
| `IN_PROGRESS` | PayPal checkout initiated. User is on the checkout page for order review before approval. |
|
||||
| `CANCELED` | PayPal checkout is canceled (by closing the checkout window or clicking cancel) before the order approval. |
|
||||
| `APPROVED` | Order is approved. User has completed the checkout process. |
|
||||
|
||||
32
doc/models/failed-payment-details.md
Normal file
32
doc/models/failed-payment-details.md
Normal file
@@ -0,0 +1,32 @@
|
||||
|
||||
# Failed Payment Details
|
||||
|
||||
The details for the failed payment of the subscription.
|
||||
|
||||
## Structure
|
||||
|
||||
`FailedPaymentDetails`
|
||||
|
||||
## Fields
|
||||
|
||||
| Name | Type | Tags | Description | Getter | Setter |
|
||||
| --- | --- | --- | --- | --- | --- |
|
||||
| `amount` | [`Money`](../../doc/models/money.md) | Required | The currency and amount for a financial transaction, such as a balance or payment due. | getAmount(): Money | setAmount(Money amount): void |
|
||||
| `time` | `string` | Required | The date and time, in [Internet date and time format](https://tools.ietf.org/html/rfc3339#section-5.6). Seconds are required while fractional seconds are optional. Note: The regular expression provides guidance but does not reject all invalid dates.<br><br>**Constraints**: *Minimum Length*: `20`, *Maximum Length*: `64`, *Pattern*: `^[0-9]{4}-(0[1-9]\|1[0-2])-(0[1-9]\|[1-2][0-9]\|3[0-1])[T,t]([0-1][0-9]\|2[0-3]):[0-5][0-9]:([0-5][0-9]\|60)([.][0-9]+)?([Zz]\|[+-][0-9]{2}:[0-9]{2})$` | getTime(): string | setTime(string time): void |
|
||||
| `reasonCode` | [`?string(ReasonCode)`](../../doc/models/reason-code.md) | Optional | The reason code for the payment failure.<br><br>**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `120`, *Pattern*: `^[A-Z_]+$` | getReasonCode(): ?string | setReasonCode(?string reasonCode): void |
|
||||
| `nextPaymentRetryTime` | `?string` | Optional | The date and time, in [Internet date and time format](https://tools.ietf.org/html/rfc3339#section-5.6). Seconds are required while fractional seconds are optional. Note: The regular expression provides guidance but does not reject all invalid dates.<br><br>**Constraints**: *Minimum Length*: `20`, *Maximum Length*: `64`, *Pattern*: `^[0-9]{4}-(0[1-9]\|1[0-2])-(0[1-9]\|[1-2][0-9]\|3[0-1])[T,t]([0-1][0-9]\|2[0-3]):[0-5][0-9]:([0-5][0-9]\|60)([.][0-9]+)?([Zz]\|[+-][0-9]{2}:[0-9]{2})$` | getNextPaymentRetryTime(): ?string | setNextPaymentRetryTime(?string nextPaymentRetryTime): void |
|
||||
|
||||
## Example (as JSON)
|
||||
|
||||
```json
|
||||
{
|
||||
"amount": {
|
||||
"currency_code": "currency_code6",
|
||||
"value": "value0"
|
||||
},
|
||||
"time": "time6",
|
||||
"reason_code": "TRANSACTION_RECEIVING_LIMIT_EXCEEDED",
|
||||
"next_payment_retry_time": "next_payment_retry_time6"
|
||||
}
|
||||
```
|
||||
|
||||
25
doc/models/frequency.md
Normal file
25
doc/models/frequency.md
Normal file
@@ -0,0 +1,25 @@
|
||||
|
||||
# Frequency
|
||||
|
||||
The frequency of the billing cycle.
|
||||
|
||||
## Structure
|
||||
|
||||
`Frequency`
|
||||
|
||||
## Fields
|
||||
|
||||
| Name | Type | Tags | Description | Getter | Setter |
|
||||
| --- | --- | --- | --- | --- | --- |
|
||||
| `intervalUnit` | [`string(IntervalUnit)`](../../doc/models/interval-unit.md) | Required | The interval at which the subscription is charged or billed.<br><br>**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `24`, *Pattern*: `^[A-Z_]+$` | getIntervalUnit(): string | setIntervalUnit(string intervalUnit): void |
|
||||
| `intervalCount` | `?int` | Optional | The number of intervals after which a subscriber is billed. For example, if the `interval_unit` is `DAY` with an `interval_count` of `2`, the subscription is billed once every two days. The following table lists the maximum allowed values for the `interval_count` for each `interval_unit`: Interval unit Maximum interval count DAY 365 WEEK 52 MONTH 12 YEAR 1<br><br>**Default**: `1`<br><br>**Constraints**: `>= 1`, `<= 365` | getIntervalCount(): ?int | setIntervalCount(?int intervalCount): void |
|
||||
|
||||
## Example (as JSON)
|
||||
|
||||
```json
|
||||
{
|
||||
"interval_unit": "DAY",
|
||||
"interval_count": 1
|
||||
}
|
||||
```
|
||||
|
||||
@@ -25,7 +25,7 @@ The payment card to use to fund a Google Pay payment response. Can be a credit o
|
||||
"name": "name4",
|
||||
"last_digits": "last_digits8",
|
||||
"type": "DEBIT",
|
||||
"brand": "ELECTRON",
|
||||
"brand": "ACCEL",
|
||||
"billing_address": {
|
||||
"address_line_1": "address_line_12",
|
||||
"address_line_2": "address_line_28",
|
||||
|
||||
@@ -22,7 +22,7 @@ The payment card used to fund a Google Pay payment. Can be a credit or debit car
|
||||
{
|
||||
"name": "name8",
|
||||
"type": "STORE",
|
||||
"brand": "DISCOVER",
|
||||
"brand": "CONFIDIS",
|
||||
"billing_address": {
|
||||
"address_line_1": "address_line_12",
|
||||
"address_line_2": "address_line_28",
|
||||
|
||||
@@ -32,7 +32,7 @@ Information needed to pay using Google Pay.
|
||||
"card": {
|
||||
"name": "name6",
|
||||
"type": "UNKNOWN",
|
||||
"brand": "RUPAY",
|
||||
"brand": "CB_NATIONALE",
|
||||
"billing_address": {
|
||||
"address_line_1": "address_line_12",
|
||||
"address_line_2": "address_line_28",
|
||||
|
||||
@@ -30,7 +30,7 @@ Google Pay Wallet payment data.
|
||||
"name": "name6",
|
||||
"last_digits": "last_digits0",
|
||||
"type": "UNKNOWN",
|
||||
"brand": "RUPAY",
|
||||
"brand": "CB_NATIONALE",
|
||||
"billing_address": {
|
||||
"address_line_1": "address_line_12",
|
||||
"address_line_2": "address_line_28",
|
||||
|
||||
32
doc/models/incentive-details.md
Normal file
32
doc/models/incentive-details.md
Normal file
@@ -0,0 +1,32 @@
|
||||
|
||||
# Incentive Details
|
||||
|
||||
The incentive details.
|
||||
|
||||
## Structure
|
||||
|
||||
`IncentiveDetails`
|
||||
|
||||
## Fields
|
||||
|
||||
| Name | Type | Tags | Description | Getter | Setter |
|
||||
| --- | --- | --- | --- | --- | --- |
|
||||
| `incentiveType` | `?string` | Optional | The type of incentive, such as a special offer or coupon.<br><br>**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `500`, *Pattern*: `^[a-zA-Z0-9_'\-., ":;\!?]*$` | getIncentiveType(): ?string | setIncentiveType(?string incentiveType): void |
|
||||
| `incentiveCode` | `?string` | Optional | The code that identifies an incentive, such as a coupon.<br><br>**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `200`, *Pattern*: `^[a-zA-Z0-9_'\-., ":;\!?]*$` | getIncentiveCode(): ?string | setIncentiveCode(?string incentiveCode): void |
|
||||
| `incentiveAmount` | [`?Money`](../../doc/models/money.md) | Optional | The currency and amount for a financial transaction, such as a balance or payment due. | getIncentiveAmount(): ?Money | setIncentiveAmount(?Money incentiveAmount): void |
|
||||
| `incentiveProgramCode` | `?string` | Optional | The incentive program code that identifies a merchant loyalty or incentive program.<br><br>**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `100`, *Pattern*: `^[a-zA-Z0-9_'\-., ":;\!?]*$` | getIncentiveProgramCode(): ?string | setIncentiveProgramCode(?string incentiveProgramCode): void |
|
||||
|
||||
## Example (as JSON)
|
||||
|
||||
```json
|
||||
{
|
||||
"incentive_type": "incentive_type4",
|
||||
"incentive_code": "incentive_code0",
|
||||
"incentive_amount": {
|
||||
"currency_code": "currency_code4",
|
||||
"value": "value0"
|
||||
},
|
||||
"incentive_program_code": "incentive_program_code4"
|
||||
}
|
||||
```
|
||||
|
||||
51
doc/models/incentive-information.md
Normal file
51
doc/models/incentive-information.md
Normal file
@@ -0,0 +1,51 @@
|
||||
|
||||
# Incentive Information
|
||||
|
||||
The incentive details.
|
||||
|
||||
## Structure
|
||||
|
||||
`IncentiveInformation`
|
||||
|
||||
## Fields
|
||||
|
||||
| Name | Type | Tags | Description | Getter | Setter |
|
||||
| --- | --- | --- | --- | --- | --- |
|
||||
| `incentiveDetails` | [`?(IncentiveDetails[])`](../../doc/models/incentive-details.md) | Optional | An array of incentive details.<br><br>**Constraints**: *Minimum Items*: `1`, *Maximum Items*: `32767` | getIncentiveDetails(): ?array | setIncentiveDetails(?array incentiveDetails): void |
|
||||
|
||||
## Example (as JSON)
|
||||
|
||||
```json
|
||||
{
|
||||
"incentive_details": [
|
||||
{
|
||||
"incentive_type": "incentive_type4",
|
||||
"incentive_code": "incentive_code0",
|
||||
"incentive_amount": {
|
||||
"currency_code": "currency_code4",
|
||||
"value": "value0"
|
||||
},
|
||||
"incentive_program_code": "incentive_program_code4"
|
||||
},
|
||||
{
|
||||
"incentive_type": "incentive_type4",
|
||||
"incentive_code": "incentive_code0",
|
||||
"incentive_amount": {
|
||||
"currency_code": "currency_code4",
|
||||
"value": "value0"
|
||||
},
|
||||
"incentive_program_code": "incentive_program_code4"
|
||||
},
|
||||
{
|
||||
"incentive_type": "incentive_type4",
|
||||
"incentive_code": "incentive_code0",
|
||||
"incentive_amount": {
|
||||
"currency_code": "currency_code4",
|
||||
"value": "value0"
|
||||
},
|
||||
"incentive_program_code": "incentive_program_code4"
|
||||
}
|
||||
]
|
||||
}
|
||||
```
|
||||
|
||||
18
doc/models/interval-unit.md
Normal file
18
doc/models/interval-unit.md
Normal file
@@ -0,0 +1,18 @@
|
||||
|
||||
# Interval Unit
|
||||
|
||||
The interval at which the subscription is charged or billed.
|
||||
|
||||
## Enumeration
|
||||
|
||||
`IntervalUnit`
|
||||
|
||||
## Fields
|
||||
|
||||
| Name | Description |
|
||||
| --- | --- |
|
||||
| `DAY` | A daily billing cycle. |
|
||||
| `WEEK` | A weekly billing cycle. |
|
||||
| `MONTH` | A monthly billing cycle. |
|
||||
| `YEAR` | A yearly billing cycle. |
|
||||
|
||||
45
doc/models/item-details.md
Normal file
45
doc/models/item-details.md
Normal file
@@ -0,0 +1,45 @@
|
||||
|
||||
# Item Details
|
||||
|
||||
The item details.
|
||||
|
||||
## Structure
|
||||
|
||||
`ItemDetails`
|
||||
|
||||
## Fields
|
||||
|
||||
| Name | Type | Tags | Description | Getter | Setter |
|
||||
| --- | --- | --- | --- | --- | --- |
|
||||
| `itemCode` | `?string` | Optional | An item code that identifies a merchant's goods or service.<br><br>**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `1000`, *Pattern*: `^[a-zA-Z0-9_'\-., ":;\!?]*$` | getItemCode(): ?string | setItemCode(?string itemCode): void |
|
||||
| `itemName` | `?string` | Optional | The item name.<br><br>**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `200`, *Pattern*: `^[a-zA-Z0-9_'\-., ":;\!?]*$` | getItemName(): ?string | setItemName(?string itemName): void |
|
||||
| `itemDescription` | `?string` | Optional | The item description.<br><br>**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `2000`, *Pattern*: `^[a-zA-Z0-9_'\-., ":;\!?]*$` | getItemDescription(): ?string | setItemDescription(?string itemDescription): void |
|
||||
| `itemOptions` | `?string` | Optional | The item options. Describes option choices on the purchase of the item in some detail.<br><br>**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `4000`, *Pattern*: `^[a-zA-Z0-9_'\-., ":;\!?]*$` | getItemOptions(): ?string | setItemOptions(?string itemOptions): void |
|
||||
| `itemQuantity` | `?string` | Optional | The number of purchased units of goods or a service.<br><br>**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `4000`, *Pattern*: `^[a-zA-Z0-9_'\-., ":;\!?]*$` | getItemQuantity(): ?string | setItemQuantity(?string itemQuantity): void |
|
||||
| `itemUnitPrice` | [`?Money`](../../doc/models/money.md) | Optional | The currency and amount for a financial transaction, such as a balance or payment due. | getItemUnitPrice(): ?Money | setItemUnitPrice(?Money itemUnitPrice): void |
|
||||
| `itemAmount` | [`?Money`](../../doc/models/money.md) | Optional | The currency and amount for a financial transaction, such as a balance or payment due. | getItemAmount(): ?Money | setItemAmount(?Money itemAmount): void |
|
||||
| `discountAmount` | [`?Money`](../../doc/models/money.md) | Optional | The currency and amount for a financial transaction, such as a balance or payment due. | getDiscountAmount(): ?Money | setDiscountAmount(?Money discountAmount): void |
|
||||
| `adjustmentAmount` | [`?Money`](../../doc/models/money.md) | Optional | The currency and amount for a financial transaction, such as a balance or payment due. | getAdjustmentAmount(): ?Money | setAdjustmentAmount(?Money adjustmentAmount): void |
|
||||
| `giftWrapAmount` | [`?Money`](../../doc/models/money.md) | Optional | The currency and amount for a financial transaction, such as a balance or payment due. | getGiftWrapAmount(): ?Money | setGiftWrapAmount(?Money giftWrapAmount): void |
|
||||
| `taxPercentage` | `?string` | Optional | The percentage, as a fixed-point, signed decimal number. For example, define a 19.99% interest rate as `19.99`.<br><br>**Constraints**: *Pattern*: `^((-?[0-9]+)\|(-?([0-9]+)?[.][0-9]+))$` | getTaxPercentage(): ?string | setTaxPercentage(?string taxPercentage): void |
|
||||
| `taxAmounts` | [`?(TaxAmount[])`](../../doc/models/tax-amount.md) | Optional | An array of tax amounts levied by a government on the purchase of goods or services.<br><br>**Constraints**: *Minimum Items*: `1`, *Maximum Items*: `32767` | getTaxAmounts(): ?array | setTaxAmounts(?array taxAmounts): void |
|
||||
| `basicShippingAmount` | [`?Money`](../../doc/models/money.md) | Optional | The currency and amount for a financial transaction, such as a balance or payment due. | getBasicShippingAmount(): ?Money | setBasicShippingAmount(?Money basicShippingAmount): void |
|
||||
| `extraShippingAmount` | [`?Money`](../../doc/models/money.md) | Optional | The currency and amount for a financial transaction, such as a balance or payment due. | getExtraShippingAmount(): ?Money | setExtraShippingAmount(?Money extraShippingAmount): void |
|
||||
| `handlingAmount` | [`?Money`](../../doc/models/money.md) | Optional | The currency and amount for a financial transaction, such as a balance or payment due. | getHandlingAmount(): ?Money | setHandlingAmount(?Money handlingAmount): void |
|
||||
| `insuranceAmount` | [`?Money`](../../doc/models/money.md) | Optional | The currency and amount for a financial transaction, such as a balance or payment due. | getInsuranceAmount(): ?Money | setInsuranceAmount(?Money insuranceAmount): void |
|
||||
| `totalItemAmount` | [`?Money`](../../doc/models/money.md) | Optional | The currency and amount for a financial transaction, such as a balance or payment due. | getTotalItemAmount(): ?Money | setTotalItemAmount(?Money totalItemAmount): void |
|
||||
| `invoiceNumber` | `?string` | Optional | The invoice number. An alphanumeric string that identifies a billing for a merchant.<br><br>**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `200`, *Pattern*: `^[a-zA-Z0-9_'\-., ":;\!?]*$` | getInvoiceNumber(): ?string | setInvoiceNumber(?string invoiceNumber): void |
|
||||
| `checkoutOptions` | [`?(CheckoutOption[])`](../../doc/models/checkout-option.md) | Optional | An array of checkout options. Each option has a name and value.<br><br>**Constraints**: *Minimum Items*: `1`, *Maximum Items*: `32767` | getCheckoutOptions(): ?array | setCheckoutOptions(?array checkoutOptions): void |
|
||||
|
||||
## Example (as JSON)
|
||||
|
||||
```json
|
||||
{
|
||||
"item_code": "item_code4",
|
||||
"item_name": "item_name2",
|
||||
"item_description": "item_description0",
|
||||
"item_options": "item_options4",
|
||||
"item_quantity": "item_quantity4"
|
||||
}
|
||||
```
|
||||
|
||||
46
doc/models/item-request.md
Normal file
46
doc/models/item-request.md
Normal file
@@ -0,0 +1,46 @@
|
||||
|
||||
# Item Request
|
||||
|
||||
The details for the items to be purchased.
|
||||
|
||||
## Structure
|
||||
|
||||
`ItemRequest`
|
||||
|
||||
## Fields
|
||||
|
||||
| Name | Type | Tags | Description | Getter | Setter |
|
||||
| --- | --- | --- | --- | --- | --- |
|
||||
| `name` | `string` | Required | The item name or title.<br><br>**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `127` | getName(): string | setName(string name): void |
|
||||
| `unitAmount` | [`Money`](../../doc/models/money.md) | Required | The currency and amount for a financial transaction, such as a balance or payment due. | getUnitAmount(): Money | setUnitAmount(Money unitAmount): void |
|
||||
| `tax` | [`?Money`](../../doc/models/money.md) | Optional | The currency and amount for a financial transaction, such as a balance or payment due. | getTax(): ?Money | setTax(?Money tax): void |
|
||||
| `quantity` | `string` | Required | The item quantity. Must be a whole number.<br><br>**Constraints**: *Maximum Length*: `10`, *Pattern*: `^[1-9][0-9]{0,9}$` | getQuantity(): string | setQuantity(string quantity): void |
|
||||
| `description` | `?string` | Optional | This field supports up to 4000 characters, but any content beyond 2048 characters (including spaces) will be truncated. The 2048 character limit is reflected in the response representation of this field.<br><br>**Constraints**: *Maximum Length*: `4000` | getDescription(): ?string | setDescription(?string description): void |
|
||||
| `sku` | `?string` | Optional | The stock keeping unit (SKU) for the item.<br><br>**Constraints**: *Maximum Length*: `127` | getSku(): ?string | setSku(?string sku): void |
|
||||
| `url` | `?string` | Optional | The URL to the item being purchased. Visible to buyer and used in buyer experiences.<br><br>**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `2048` | getUrl(): ?string | setUrl(?string url): void |
|
||||
| `category` | [`?string(ItemCategory)`](../../doc/models/item-category.md) | Optional | The item category type.<br><br>**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `20` | getCategory(): ?string | setCategory(?string category): void |
|
||||
| `imageUrl` | `?string` | Optional | The URL of the item's image. File type and size restrictions apply. An image that violates these restrictions will not be honored.<br><br>**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `2048`, *Pattern*: `^(https:)([/\|.\|\w\|\s\|-])*\.(?:jpg\|gif\|png\|jpeg\|JPG\|GIF\|PNG\|JPEG)` | getImageUrl(): ?string | setImageUrl(?string imageUrl): void |
|
||||
| `upc` | [`?UniversalProductCode`](../../doc/models/universal-product-code.md) | Optional | The Universal Product Code of the item. | getUpc(): ?UniversalProductCode | setUpc(?UniversalProductCode upc): void |
|
||||
| `billingPlan` | [`?OrderBillingPlan`](../../doc/models/order-billing-plan.md) | Optional | Metadata for merchant-managed recurring billing plans. Valid only during the saved payment method token or billing agreement creation. | getBillingPlan(): ?OrderBillingPlan | setBillingPlan(?OrderBillingPlan billingPlan): void |
|
||||
|
||||
## Example (as JSON)
|
||||
|
||||
```json
|
||||
{
|
||||
"name": "name0",
|
||||
"unit_amount": {
|
||||
"currency_code": "currency_code2",
|
||||
"value": "value8"
|
||||
},
|
||||
"tax": {
|
||||
"currency_code": "currency_code0",
|
||||
"value": "value6"
|
||||
},
|
||||
"quantity": "quantity6",
|
||||
"description": "description0",
|
||||
"sku": "sku6",
|
||||
"url": "url4",
|
||||
"category": "DIGITAL_GOODS"
|
||||
}
|
||||
```
|
||||
|
||||
@@ -19,7 +19,7 @@ The details for the items to be purchased.
|
||||
| `sku` | `?string` | Optional | The stock keeping unit (SKU) for the item.<br><br>**Constraints**: *Maximum Length*: `127` | getSku(): ?string | setSku(?string sku): void |
|
||||
| `url` | `?string` | Optional | The URL to the item being purchased. Visible to buyer and used in buyer experiences.<br><br>**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `2048` | getUrl(): ?string | setUrl(?string url): void |
|
||||
| `category` | [`?string(ItemCategory)`](../../doc/models/item-category.md) | Optional | The item category type.<br><br>**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `20` | getCategory(): ?string | setCategory(?string category): void |
|
||||
| `imageUrl` | `?string` | Optional | The URL of the item's image. File type and size restrictions apply. An image that violates these restrictions will not be honored.<br><br>**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `2048`, *Pattern*: `^(https:)([/\|.\|\w\|\s\|-])*\.(?:jpg\|gif\|png\|jpeg\|JPG\|GIF\|PNG\|JPEG)` | getImageUrl(): ?string | setImageUrl(?string imageUrl): void |
|
||||
| `imageUrl` | `?string` | Optional | The URL of the item's image. File type and size restrictions apply. An image that violates these restrictions will not be honored.<br><br>**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `2048`, *Pattern*: `^(https:)([/\|.\|\w\|\s\|-])*\.(?:jpg\|gif\|png\|jpeg\|JPG\|GIF\|PNG\|JPEG)(\?.*)?$` | getImageUrl(): ?string | setImageUrl(?string imageUrl): void |
|
||||
| `upc` | [`?UniversalProductCode`](../../doc/models/universal-product-code.md) | Optional | The Universal Product Code of the item. | getUpc(): ?UniversalProductCode | setUpc(?UniversalProductCode upc): void |
|
||||
| `billingPlan` | [`?OrderBillingPlan`](../../doc/models/order-billing-plan.md) | Optional | Metadata for merchant-managed recurring billing plans. Valid only during the saved payment method token or billing agreement creation. | getBillingPlan(): ?OrderBillingPlan | setBillingPlan(?OrderBillingPlan billingPlan): void |
|
||||
|
||||
|
||||
26
doc/models/last-payment-details.md
Normal file
26
doc/models/last-payment-details.md
Normal file
@@ -0,0 +1,26 @@
|
||||
|
||||
# Last Payment Details
|
||||
|
||||
## Structure
|
||||
|
||||
`LastPaymentDetails`
|
||||
|
||||
## Fields
|
||||
|
||||
| Name | Type | Tags | Description | Getter | Setter |
|
||||
| --- | --- | --- | --- | --- | --- |
|
||||
| `amount` | [`?Money`](../../doc/models/money.md) | Optional | The currency and amount for a financial transaction, such as a balance or payment due. | getAmount(): ?Money | setAmount(?Money amount): void |
|
||||
| `time` | `?string` | Optional | The date and time, in [Internet date and time format](https://tools.ietf.org/html/rfc3339#section-5.6). Seconds are required while fractional seconds are optional. Note: The regular expression provides guidance but does not reject all invalid dates.<br><br>**Constraints**: *Minimum Length*: `20`, *Maximum Length*: `64`, *Pattern*: `^[0-9]{4}-(0[1-9]\|1[0-2])-(0[1-9]\|[1-2][0-9]\|3[0-1])[T,t]([0-1][0-9]\|2[0-3]):[0-5][0-9]:([0-5][0-9]\|60)([.][0-9]+)?([Zz]\|[+-][0-9]{2}:[0-9]{2})$` | getTime(): ?string | setTime(?string time): void |
|
||||
|
||||
## Example (as JSON)
|
||||
|
||||
```json
|
||||
{
|
||||
"amount": {
|
||||
"currency_code": "currency_code6",
|
||||
"value": "value0"
|
||||
},
|
||||
"time": "time0"
|
||||
}
|
||||
```
|
||||
|
||||
@@ -16,7 +16,7 @@ The line items for this purchase. If your merchant account has been configured f
|
||||
| `description` | `?string` | Optional | The detailed item description.<br><br>**Constraints**: *Maximum Length*: `2048` | getDescription(): ?string | setDescription(?string description): void |
|
||||
| `sku` | `?string` | Optional | The stock keeping unit (SKU) for the item.<br><br>**Constraints**: *Maximum Length*: `127` | getSku(): ?string | setSku(?string sku): void |
|
||||
| `url` | `?string` | Optional | The URL to the item being purchased. Visible to buyer and used in buyer experiences.<br><br>**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `2048` | getUrl(): ?string | setUrl(?string url): void |
|
||||
| `imageUrl` | `?string` | Optional | The URL of the item's image. File type and size restrictions apply. An image that violates these restrictions will not be honored.<br><br>**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `2048`, *Pattern*: `^(https:)([/\|.\|\w\|\s\|-])*\.(?:jpg\|gif\|png\|jpeg\|JPG\|GIF\|PNG\|JPEG)` | getImageUrl(): ?string | setImageUrl(?string imageUrl): void |
|
||||
| `imageUrl` | `?string` | Optional | The URL of the item's image. File type and size restrictions apply. An image that violates these restrictions will not be honored.<br><br>**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `2048`, *Pattern*: `^(https:)([/\|.\|\w\|\s\|-])*\.(?:jpg\|gif\|png\|jpeg\|JPG\|GIF\|PNG\|JPEG)(\?.*)?$` | getImageUrl(): ?string | setImageUrl(?string imageUrl): void |
|
||||
| `upc` | [`?UniversalProductCode`](../../doc/models/universal-product-code.md) | Optional | The Universal Product Code of the item. | getUpc(): ?UniversalProductCode | setUpc(?UniversalProductCode upc): void |
|
||||
| `billingPlan` | [`?OrderBillingPlan`](../../doc/models/order-billing-plan.md) | Optional | Metadata for merchant-managed recurring billing plans. Valid only during the saved payment method token or billing agreement creation. | getBillingPlan(): ?OrderBillingPlan | setBillingPlan(?OrderBillingPlan billingPlan): void |
|
||||
| `unitAmount` | [`?Money`](../../doc/models/money.md) | Optional | The currency and amount for a financial transaction, such as a balance or payment due. | getUnitAmount(): ?Money | setUnitAmount(?Money unitAmount): void |
|
||||
|
||||
@@ -9,14 +9,14 @@ The HTTP method required to make the related call.
|
||||
|
||||
## Fields
|
||||
|
||||
| Name |
|
||||
| --- |
|
||||
| `GET` |
|
||||
| `POST` |
|
||||
| `PUT` |
|
||||
| `DELETE` |
|
||||
| `HEAD` |
|
||||
| `CONNECT` |
|
||||
| `OPTIONS` |
|
||||
| `PATCH` |
|
||||
| Name | Description |
|
||||
| --- | --- |
|
||||
| `GET` | The HTTP GET method. |
|
||||
| `POST` | The HTTP POST method. |
|
||||
| `PUT` | The HTTP PUT method. |
|
||||
| `DELETE` | The HTTP DELETE method. |
|
||||
| `HEAD` | The HTTP HEAD method. |
|
||||
| `CONNECT` | The HTTP CONNECT method. |
|
||||
| `OPTIONS` | The HTTP OPTIONS method. |
|
||||
| `PATCH` | The HTTP PATCH method. |
|
||||
|
||||
|
||||
25
doc/models/merchant-preferences.md
Normal file
25
doc/models/merchant-preferences.md
Normal file
@@ -0,0 +1,25 @@
|
||||
|
||||
# Merchant Preferences
|
||||
|
||||
The merchant preferences for a subscription.
|
||||
|
||||
## Structure
|
||||
|
||||
`MerchantPreferences`
|
||||
|
||||
## Fields
|
||||
|
||||
| Name | Type | Tags | Description | Getter | Setter |
|
||||
| --- | --- | --- | --- | --- | --- |
|
||||
| `returnUrl` | `?string` | Optional | The URL where the customer is redirected after the customer approves the payment.<br><br>**Constraints**: *Minimum Length*: `10`, *Maximum Length*: `4000` | getReturnUrl(): ?string | setReturnUrl(?string returnUrl): void |
|
||||
| `cancelUrl` | `?string` | Optional | The URL where the customer is redirected after the customer cancels the payment.<br><br>**Constraints**: *Minimum Length*: `10`, *Maximum Length*: `4000` | getCancelUrl(): ?string | setCancelUrl(?string cancelUrl): void |
|
||||
|
||||
## Example (as JSON)
|
||||
|
||||
```json
|
||||
{
|
||||
"return_url": "return_url8",
|
||||
"cancel_url": "cancel_url0"
|
||||
}
|
||||
```
|
||||
|
||||
16
doc/models/mobile-return-flow.md
Normal file
16
doc/models/mobile-return-flow.md
Normal file
@@ -0,0 +1,16 @@
|
||||
|
||||
# Mobile Return Flow
|
||||
|
||||
Merchant preference on how the buyer can navigate back to merchant website post approving the transaction on the PayPal App.
|
||||
|
||||
## Enumeration
|
||||
|
||||
`MobileReturnFlow`
|
||||
|
||||
## Fields
|
||||
|
||||
| Name | Description |
|
||||
| --- | --- |
|
||||
| `AUTO` | After payment approval in the PayPal App, buyer will automatically be redirected to the merchant website. |
|
||||
| `MANUAL` | After payment approval in the PayPal App, buyer will be asked to manually navigate back to the merchant website where they started the transaction from. The buyer is shown a message like 'Return to Merchant' to return to the source where the transaction actually started. |
|
||||
|
||||
25
doc/models/mobile-web-context.md
Normal file
25
doc/models/mobile-web-context.md
Normal file
@@ -0,0 +1,25 @@
|
||||
|
||||
# Mobile Web Context
|
||||
|
||||
Buyer's mobile web browser context to app switch to the PayPal consumer app.
|
||||
|
||||
## Structure
|
||||
|
||||
`MobileWebContext`
|
||||
|
||||
## Fields
|
||||
|
||||
| Name | Type | Tags | Description | Getter | Setter |
|
||||
| --- | --- | --- | --- | --- | --- |
|
||||
| `returnFlow` | [`?string(MobileReturnFlow)`](../../doc/models/mobile-return-flow.md) | Optional | Merchant preference on how the buyer can navigate back to merchant website post approving the transaction on the PayPal App.<br><br>**Default**: `MobileReturnFlow::AUTO`<br><br>**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `6`, *Pattern*: `^[A-Z_]+$` | getReturnFlow(): ?string | setReturnFlow(?string returnFlow): void |
|
||||
| `buyerUserAgent` | `?string` | Optional | User agent from the request originating from the buyer's device. This will be used to identify the buyer's operating system and browser versions. NOTE: Merchants must not alter or modify the buyer's device user agent.<br><br>**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `512`, *Pattern*: `^.*$` | getBuyerUserAgent(): ?string | setBuyerUserAgent(?string buyerUserAgent): void |
|
||||
|
||||
## Example (as JSON)
|
||||
|
||||
```json
|
||||
{
|
||||
"return_flow": "AUTO",
|
||||
"buyer_user_agent": "buyer_user_agent8"
|
||||
}
|
||||
```
|
||||
|
||||
66
doc/models/modify-subscription-request.md
Normal file
66
doc/models/modify-subscription-request.md
Normal file
@@ -0,0 +1,66 @@
|
||||
|
||||
# Modify Subscription Request
|
||||
|
||||
The request to update the quantity of the product or service in a subscription. You can also use this method to switch the plan and update the `shipping_amount` and `shipping_address` values for the subscription. This type of update requires the buyer's consent.
|
||||
|
||||
## Structure
|
||||
|
||||
`ModifySubscriptionRequest`
|
||||
|
||||
## Fields
|
||||
|
||||
| Name | Type | Tags | Description | Getter | Setter |
|
||||
| --- | --- | --- | --- | --- | --- |
|
||||
| `planId` | `?string` | Optional | The unique PayPal-generated ID for the plan.<br><br>**Constraints**: *Minimum Length*: `26`, *Maximum Length*: `26`, *Pattern*: `^P-[A-Z0-9]*$` | getPlanId(): ?string | setPlanId(?string planId): void |
|
||||
| `quantity` | `?string` | Optional | The quantity of the product or service in the subscription.<br><br>**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `32`, *Pattern*: `^([0-9]+\|([0-9]+)?[.][0-9]+)$` | getQuantity(): ?string | setQuantity(?string quantity): void |
|
||||
| `shippingAmount` | [`?Money`](../../doc/models/money.md) | Optional | The currency and amount for a financial transaction, such as a balance or payment due. | getShippingAmount(): ?Money | setShippingAmount(?Money shippingAmount): void |
|
||||
| `shippingAddress` | [`?ShippingDetails`](../../doc/models/shipping-details.md) | Optional | The shipping details. | getShippingAddress(): ?ShippingDetails | setShippingAddress(?ShippingDetails shippingAddress): void |
|
||||
| `applicationContext` | [`?SubscriptionPatchApplicationContext`](../../doc/models/subscription-patch-application-context.md) | Optional | The application context, which customizes the payer experience during the subscription approval process with PayPal. | getApplicationContext(): ?SubscriptionPatchApplicationContext | setApplicationContext(?SubscriptionPatchApplicationContext applicationContext): void |
|
||||
| `plan` | [`?PlanOverride`](../../doc/models/plan-override.md) | Optional | An inline plan object to customise the subscription. You can override plan level default attributes by providing customised values for the subscription in this object. | getPlan(): ?PlanOverride | setPlan(?PlanOverride plan): void |
|
||||
|
||||
## Example (as JSON)
|
||||
|
||||
```json
|
||||
{
|
||||
"plan_id": "plan_id6",
|
||||
"quantity": "quantity0",
|
||||
"shipping_amount": {
|
||||
"currency_code": "currency_code0",
|
||||
"value": "value6"
|
||||
},
|
||||
"shipping_address": {
|
||||
"name": {
|
||||
"full_name": "full_name6"
|
||||
},
|
||||
"email_address": "email_address8",
|
||||
"phone_number": {
|
||||
"country_code": "country_code2",
|
||||
"national_number": "national_number6"
|
||||
},
|
||||
"type": "PICKUP_IN_STORE",
|
||||
"options": [
|
||||
{
|
||||
"id": "id2",
|
||||
"label": "label2",
|
||||
"type": "SHIPPING",
|
||||
"amount": {
|
||||
"currency_code": "currency_code6",
|
||||
"value": "value0"
|
||||
},
|
||||
"selected": false
|
||||
}
|
||||
]
|
||||
},
|
||||
"application_context": {
|
||||
"brand_name": "brand_name8",
|
||||
"locale": "locale2",
|
||||
"shipping_preference": "SET_PROVIDED_ADDRESS",
|
||||
"payment_method": {
|
||||
"payee_preferred": "UNRESTRICTED"
|
||||
},
|
||||
"return_url": "return_url0",
|
||||
"cancel_url": "cancel_url2"
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
152
doc/models/modify-subscription-response.md
Normal file
152
doc/models/modify-subscription-response.md
Normal file
@@ -0,0 +1,152 @@
|
||||
|
||||
# Modify Subscription Response
|
||||
|
||||
The response to a request to update the quantity of the product or service in a subscription. You can also use this method to switch the plan and update the `shipping_amount` and `shipping_address` values for the subscription. This type of update requires the buyer's consent.
|
||||
|
||||
## Structure
|
||||
|
||||
`ModifySubscriptionResponse`
|
||||
|
||||
## Fields
|
||||
|
||||
| Name | Type | Tags | Description | Getter | Setter |
|
||||
| --- | --- | --- | --- | --- | --- |
|
||||
| `planId` | `?string` | Optional | The unique PayPal-generated ID for the plan.<br><br>**Constraints**: *Minimum Length*: `26`, *Maximum Length*: `26`, *Pattern*: `^P-[A-Z0-9]*$` | getPlanId(): ?string | setPlanId(?string planId): void |
|
||||
| `quantity` | `?string` | Optional | The quantity of the product or service in the subscription.<br><br>**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `32`, *Pattern*: `^([0-9]+\|([0-9]+)?[.][0-9]+)$` | getQuantity(): ?string | setQuantity(?string quantity): void |
|
||||
| `shippingAmount` | [`?Money`](../../doc/models/money.md) | Optional | The currency and amount for a financial transaction, such as a balance or payment due. | getShippingAmount(): ?Money | setShippingAmount(?Money shippingAmount): void |
|
||||
| `shippingAddress` | [`?ShippingDetails`](../../doc/models/shipping-details.md) | Optional | The shipping details. | getShippingAddress(): ?ShippingDetails | setShippingAddress(?ShippingDetails shippingAddress): void |
|
||||
| `plan` | [`?PlanOverride`](../../doc/models/plan-override.md) | Optional | An inline plan object to customise the subscription. You can override plan level default attributes by providing customised values for the subscription in this object. | getPlan(): ?PlanOverride | setPlan(?PlanOverride plan): void |
|
||||
| `planOverridden` | `?bool` | Optional | Indicates whether the subscription has overridden any plan attributes. | getPlanOverridden(): ?bool | setPlanOverridden(?bool planOverridden): void |
|
||||
| `links` | [`?(LinkDescription[])`](../../doc/models/link-description.md) | Optional | An array of request-related [HATEOAS links](/docs/api/reference/api-responses/#hateoas-links). | getLinks(): ?array | setLinks(?array links): void |
|
||||
|
||||
## Example (as JSON)
|
||||
|
||||
```json
|
||||
{
|
||||
"plan_id": "plan_id6",
|
||||
"quantity": "quantity0",
|
||||
"shipping_amount": {
|
||||
"currency_code": "currency_code0",
|
||||
"value": "value6"
|
||||
},
|
||||
"shipping_address": {
|
||||
"name": {
|
||||
"full_name": "full_name6"
|
||||
},
|
||||
"email_address": "email_address8",
|
||||
"phone_number": {
|
||||
"country_code": "country_code2",
|
||||
"national_number": "national_number6"
|
||||
},
|
||||
"type": "PICKUP_IN_STORE",
|
||||
"options": [
|
||||
{
|
||||
"id": "id2",
|
||||
"label": "label2",
|
||||
"type": "SHIPPING",
|
||||
"amount": {
|
||||
"currency_code": "currency_code6",
|
||||
"value": "value0"
|
||||
},
|
||||
"selected": false
|
||||
}
|
||||
]
|
||||
},
|
||||
"plan": {
|
||||
"billing_cycles": [
|
||||
{
|
||||
"pricing_scheme": {
|
||||
"version": 10,
|
||||
"fixed_price": {
|
||||
"currency_code": "currency_code4",
|
||||
"value": "value0"
|
||||
},
|
||||
"pricing_model": "VOLUME",
|
||||
"tiers": [
|
||||
{
|
||||
"starting_quantity": "starting_quantity8",
|
||||
"ending_quantity": "ending_quantity6",
|
||||
"amount": {
|
||||
"currency_code": "currency_code6",
|
||||
"value": "value0"
|
||||
}
|
||||
},
|
||||
{
|
||||
"starting_quantity": "starting_quantity8",
|
||||
"ending_quantity": "ending_quantity6",
|
||||
"amount": {
|
||||
"currency_code": "currency_code6",
|
||||
"value": "value0"
|
||||
}
|
||||
},
|
||||
{
|
||||
"starting_quantity": "starting_quantity8",
|
||||
"ending_quantity": "ending_quantity6",
|
||||
"amount": {
|
||||
"currency_code": "currency_code6",
|
||||
"value": "value0"
|
||||
}
|
||||
}
|
||||
],
|
||||
"create_time": "create_time4"
|
||||
},
|
||||
"sequence": 8,
|
||||
"total_cycles": 198
|
||||
},
|
||||
{
|
||||
"pricing_scheme": {
|
||||
"version": 10,
|
||||
"fixed_price": {
|
||||
"currency_code": "currency_code4",
|
||||
"value": "value0"
|
||||
},
|
||||
"pricing_model": "VOLUME",
|
||||
"tiers": [
|
||||
{
|
||||
"starting_quantity": "starting_quantity8",
|
||||
"ending_quantity": "ending_quantity6",
|
||||
"amount": {
|
||||
"currency_code": "currency_code6",
|
||||
"value": "value0"
|
||||
}
|
||||
},
|
||||
{
|
||||
"starting_quantity": "starting_quantity8",
|
||||
"ending_quantity": "ending_quantity6",
|
||||
"amount": {
|
||||
"currency_code": "currency_code6",
|
||||
"value": "value0"
|
||||
}
|
||||
},
|
||||
{
|
||||
"starting_quantity": "starting_quantity8",
|
||||
"ending_quantity": "ending_quantity6",
|
||||
"amount": {
|
||||
"currency_code": "currency_code6",
|
||||
"value": "value0"
|
||||
}
|
||||
}
|
||||
],
|
||||
"create_time": "create_time4"
|
||||
},
|
||||
"sequence": 8,
|
||||
"total_cycles": 198
|
||||
}
|
||||
],
|
||||
"payment_preferences": {
|
||||
"auto_bill_outstanding": false,
|
||||
"setup_fee": {
|
||||
"currency_code": "currency_code8",
|
||||
"value": "value4"
|
||||
},
|
||||
"setup_fee_failure_action": "CONTINUE",
|
||||
"payment_failure_threshold": 104
|
||||
},
|
||||
"taxes": {
|
||||
"percentage": "percentage8",
|
||||
"inclusive": false
|
||||
}
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
25
doc/models/native-app-context.md
Normal file
25
doc/models/native-app-context.md
Normal file
@@ -0,0 +1,25 @@
|
||||
|
||||
# Native App Context
|
||||
|
||||
Merchant provided, buyer's native app preferences to app switch to the PayPal consumer app.
|
||||
|
||||
## Structure
|
||||
|
||||
`NativeAppContext`
|
||||
|
||||
## Fields
|
||||
|
||||
| Name | Type | Tags | Description | Getter | Setter |
|
||||
| --- | --- | --- | --- | --- | --- |
|
||||
| `osType` | [`?string(OsType)`](../../doc/models/os-type.md) | Optional | Operating System type of the device that the buyer is using.<br><br>**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `7`, *Pattern*: `^[A-Z_]+$` | getOsType(): ?string | setOsType(?string osType): void |
|
||||
| `osVersion` | `?string` | Optional | Operating System version of the device that the buyer is using.<br><br>**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `64`, *Pattern*: `^.*$` | getOsVersion(): ?string | setOsVersion(?string osVersion): void |
|
||||
|
||||
## Example (as JSON)
|
||||
|
||||
```json
|
||||
{
|
||||
"os_type": "ANDROID",
|
||||
"os_version": "os_version0"
|
||||
}
|
||||
```
|
||||
|
||||
@@ -22,7 +22,7 @@ Previous network transaction reference including id and network.
|
||||
{
|
||||
"id": "id6",
|
||||
"date": "date2",
|
||||
"network": "SYNCHRONY",
|
||||
"network": "CONFIDIS",
|
||||
"time": "time6"
|
||||
}
|
||||
```
|
||||
|
||||
@@ -1,18 +1,18 @@
|
||||
|
||||
# Network Transaction Reference
|
||||
# Network Transaction
|
||||
|
||||
Reference values used by the card network to identify a transaction.
|
||||
|
||||
## Structure
|
||||
|
||||
`NetworkTransactionReference`
|
||||
`NetworkTransaction`
|
||||
|
||||
## Fields
|
||||
|
||||
| Name | Type | Tags | Description | Getter | Setter |
|
||||
| --- | --- | --- | --- | --- | --- |
|
||||
| `id` | `string` | Required | Transaction reference id returned by the scheme. For Visa and Amex, this is the "Tran id" field in response. For MasterCard, this is the "BankNet reference id" field in response. For Discover, this is the "NRID" field in response. The pattern we expect for this field from Visa/Amex/CB/Discover is numeric, Mastercard/BNPP is alphanumeric and Paysecure is alphanumeric with special character -.<br><br>**Constraints**: *Minimum Length*: `9`, *Maximum Length*: `36`, *Pattern*: `^[a-zA-Z0-9-_@.:&+=*^'~#!$%()]+$` | getId(): string | setId(string id): void |
|
||||
| `date` | `?string` | Optional | The date that the transaction was authorized by the scheme. This field may not be returned for all networks. MasterCard refers to this field as "BankNet reference date.<br><br>**Constraints**: *Minimum Length*: `4`, *Maximum Length*: `4`, *Pattern*: `^[0-9]+$` | getDate(): ?string | setDate(?string date): void |
|
||||
| `id` | `?string` | Optional | Transaction reference id returned by the scheme. For Visa and Amex, this is the "Tran id" field in response. For MasterCard, this is the "BankNet reference id" field in response. For Discover, this is the "NRID" field in response. The pattern we expect for this field from Visa/Amex/CB/Discover is numeric, Mastercard/BNPP is alphanumeric and Paysecure is alphanumeric with special character -.<br><br>**Constraints**: *Minimum Length*: `9`, *Maximum Length*: `36`, *Pattern*: `^[a-zA-Z0-9-_@.:&+=*^'~#!$%()]+$` | getId(): ?string | setId(?string id): void |
|
||||
| `date` | `?string` | Optional | The date that the transaction was authorized by the scheme. This field may not be returned for all networks. MasterCard refers to this field as "BankNet reference date". For some specific networks, such as MasterCard and Discover, this date field is mandatory when the `previous_network_transaction_reference_id` is passed.<br><br>**Constraints**: *Minimum Length*: `4`, *Maximum Length*: `4`, *Pattern*: `^[0-9]+$` | getDate(): ?string | setDate(?string date): void |
|
||||
| `network` | [`?string(CardBrand)`](../../doc/models/card-brand.md) | Optional | The card network or brand. Applies to credit, debit, gift, and payment cards.<br><br>**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `255`, *Pattern*: `^[A-Z_]+$` | getNetwork(): ?string | setNetwork(?string network): void |
|
||||
| `acquirerReferenceNumber` | `?string` | Optional | Reference ID issued for the card transaction. This ID can be used to track the transaction across processors, card brands and issuing banks.<br><br>**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `36`, *Pattern*: `^[a-zA-Z0-9]+$` | getAcquirerReferenceNumber(): ?string | setAcquirerReferenceNumber(?string acquirerReferenceNumber): void |
|
||||
|
||||
@@ -20,10 +20,10 @@ Reference values used by the card network to identify a transaction.
|
||||
|
||||
```json
|
||||
{
|
||||
"id": "id6",
|
||||
"date": "date8",
|
||||
"network": "ELECTRON",
|
||||
"acquirer_reference_number": "acquirer_reference_number2"
|
||||
"id": "id0",
|
||||
"date": "date4",
|
||||
"network": "CETELEM",
|
||||
"acquirer_reference_number": "acquirer_reference_number8"
|
||||
}
|
||||
```
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
|
||||
# Order Application Context Shipping Preference
|
||||
|
||||
DEPRECATED. DEPRECATED. The shipping preference: Displays the shipping address to the customer. Enables the customer to choose an address on the PayPal site. Restricts the customer from changing the address during the payment-approval process. . The fields in `application_context` are now available in the `experience_context` object under the `payment_source` which supports them (eg. `payment_source.paypal.experience_context.shipping_preference`). Please specify this field in the `experience_context` object instead of the `application_context` object., The shipping preference. This only applies to PayPal payment source., The shipping preference. This only applies to PayPal payment source.
|
||||
DEPRECATED. DEPRECATED. The shipping preference: Displays the shipping address to the customer. Enables the customer to choose an address on the PayPal site. Restricts the customer from changing the address during the payment-approval process. . The fields in `application_context` are now available in the `experience_context` object under the `payment_source` which supports them (eg. `payment_source.paypal.experience_context.shipping_preference`). Please specify this field in the `experience_context` object instead of the `application_context` object.
|
||||
|
||||
## Enumeration
|
||||
|
||||
|
||||
@@ -12,14 +12,14 @@ Customizes the payer experience during the approval process for the payment with
|
||||
| Name | Type | Tags | Description | Getter | Setter |
|
||||
| --- | --- | --- | --- | --- | --- |
|
||||
| `brandName` | `?string` | Optional | DEPRECATED. The label that overrides the business name in the PayPal account on the PayPal site. The fields in `application_context` are now available in the `experience_context` object under the `payment_source` which supports them (eg. `payment_source.paypal.experience_context.brand_name`). Please specify this field in the `experience_context` object instead of the `application_context` object.<br><br>**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `127` | getBrandName(): ?string | setBrandName(?string brandName): void |
|
||||
| `locale` | `?string` | Optional | The [language tag](https://tools.ietf.org/html/bcp47#section-2) for the language in which to localize the error-related strings, such as messages, issues, and suggested actions. The tag is made up of the [ISO 639-2 language code](https://www.loc.gov/standards/iso639-2/php/code_list.php), the optional [ISO-15924 script tag](https://www.unicode.org/iso15924/codelists.html), and the [ISO-3166 alpha-2 country code](/api/rest/reference/country-codes/) or [M49 region code](https://unstats.un.org/unsd/methodology/m49/).<br><br>**Constraints**: *Minimum Length*: `2`, *Maximum Length*: `10`, *Pattern*: `^[a-z]{2}(?:-[A-Z][a-z]{3})?(?:-(?:[A-Z]{2}\|[0-9]{3}))?$` | getLocale(): ?string | setLocale(?string locale): void |
|
||||
| `locale` | `?string` | Optional | DEPRECATED. The BCP 47-formatted locale of pages that the PayPal payment experience shows. PayPal supports a five-character code. For example, `da-DK`, `he-IL`, `id-ID`, `ja-JP`, `no-NO`, `pt-BR`, `ru-RU`, `sv-SE`, `th-TH`, `zh-CN`, `zh-HK`, or `zh-TW`. The fields in `application_context` are now available in the `experience_context` object under the `payment_source` which supports them (eg. `payment_source.paypal.experience_context.locale`). Please specify this field in the `experience_context` object instead of the `application_context` object.<br><br>**Constraints**: *Minimum Length*: `2`, *Maximum Length*: `10`, *Pattern*: `^[a-z]{2}(?:-[A-Z][a-z]{3})?(?:-(?:[A-Z]{2}\|[0-9]{3}))?$` | getLocale(): ?string | setLocale(?string locale): void |
|
||||
| `landingPage` | [`?string(OrderApplicationContextLandingPage)`](../../doc/models/order-application-context-landing-page.md) | Optional | DEPRECATED. DEPRECATED. The type of landing page to show on the PayPal site for customer checkout. The fields in `application_context` are now available in the `experience_context` object under the `payment_source` which supports them (eg. `payment_source.paypal.experience_context.landing_page`). Please specify this field in the `experience_context` object instead of the `application_context` object.<br><br>**Default**: `OrderApplicationContextLandingPage::NO_PREFERENCE`<br><br>**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `13`, *Pattern*: `^[0-9A-Z_]+$` | getLandingPage(): ?string | setLandingPage(?string landingPage): void |
|
||||
| `shippingPreference` | [`?string(OrderApplicationContextShippingPreference)`](../../doc/models/order-application-context-shipping-preference.md) | Optional | DEPRECATED. DEPRECATED. The shipping preference: Displays the shipping address to the customer. Enables the customer to choose an address on the PayPal site. Restricts the customer from changing the address during the payment-approval process. . The fields in `application_context` are now available in the `experience_context` object under the `payment_source` which supports them (eg. `payment_source.paypal.experience_context.shipping_preference`). Please specify this field in the `experience_context` object instead of the `application_context` object.<br><br>**Default**: `OrderApplicationContextShippingPreference::GET_FROM_FILE`<br><br>**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `20`, *Pattern*: `^[0-9A-Z_]+$` | getShippingPreference(): ?string | setShippingPreference(?string shippingPreference): void |
|
||||
| `userAction` | [`?string(OrderApplicationContextUserAction)`](../../doc/models/order-application-context-user-action.md) | Optional | DEPRECATED. Configures a Continue or Pay Now checkout flow. The fields in `application_context` are now available in the `experience_context` object under the `payment_source` which supports them (eg. `payment_source.paypal.experience_context.user_action`). Please specify this field in the `experience_context` object instead of the `application_context` object.<br><br>**Default**: `OrderApplicationContextUserAction::CONTINUE_`<br><br>**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `8`, *Pattern*: `^[0-9A-Z_]+$` | getUserAction(): ?string | setUserAction(?string userAction): void |
|
||||
| `paymentMethod` | [`?PaymentMethodPreference`](../../doc/models/payment-method-preference.md) | Optional | The customer and merchant payment preferences. | getPaymentMethod(): ?PaymentMethodPreference | setPaymentMethod(?PaymentMethodPreference paymentMethod): void |
|
||||
| `paymentMethod` | [`?PaymentMethodPreference`](../../doc/models/payment-method-preference.md) | Optional | DEPRECATED. The customer and merchant payment preferences. The fields in `application_context` are now available in the `experience_context` object under the `payment_source` which supports them (eg. `payment_source.paypal.experience_context.payment_method_selected`). Please specify this field in the `experience_context` object instead of the `application_context` object.. | getPaymentMethod(): ?PaymentMethodPreference | setPaymentMethod(?PaymentMethodPreference paymentMethod): void |
|
||||
| `returnUrl` | `?string` | Optional | DEPRECATED. The URL where the customer is redirected after the customer approves the payment. The fields in `application_context` are now available in the `experience_context` object under the `payment_source` which supports them (eg. `payment_source.paypal.experience_context.return_url`). Please specify this field in the `experience_context` object instead of the `application_context` object. | getReturnUrl(): ?string | setReturnUrl(?string returnUrl): void |
|
||||
| `cancelUrl` | `?string` | Optional | DEPRECATED. The URL where the customer is redirected after the customer cancels the payment. The fields in `application_context` are now available in the `experience_context` object under the `payment_source` which supports them (eg. `payment_source.paypal.experience_context.cancel_url`). Please specify this field in the `experience_context` object instead of the `application_context` object. | getCancelUrl(): ?string | setCancelUrl(?string cancelUrl): void |
|
||||
| `storedPaymentSource` | [`?StoredPaymentSource`](../../doc/models/stored-payment-source.md) | Optional | Provides additional details to process a payment using a `payment_source` that has been stored or is intended to be stored (also referred to as stored_credential or card-on-file). Parameter compatibility: `payment_type=ONE_TIME` is compatible only with `payment_initiator=CUSTOMER`. `usage=FIRST` is compatible only with `payment_initiator=CUSTOMER`. `previous_transaction_reference` or `previous_network_transaction_reference` is compatible only with `payment_initiator=MERCHANT`. Only one of the parameters - `previous_transaction_reference` and `previous_network_transaction_reference` - can be present in the request. | getStoredPaymentSource(): ?StoredPaymentSource | setStoredPaymentSource(?StoredPaymentSource storedPaymentSource): void |
|
||||
| `storedPaymentSource` | [`?StoredPaymentSource`](../../doc/models/stored-payment-source.md) | Optional | DEPRECATED. Provides additional details to process a payment using a `payment_source` that has been stored or is intended to be stored (also referred to as stored_credential or card-on-file). Parameter compatibility: `payment_type=ONE_TIME` is compatible only with `payment_initiator=CUSTOMER`. `usage=FIRST` is compatible only with `payment_initiator=CUSTOMER`. `previous_transaction_reference` or `previous_network_transaction_reference` is compatible only with `payment_initiator=MERCHANT`. Only one of the parameters - `previous_transaction_reference` and `previous_network_transaction_reference` - can be present in the request. . The fields in `stored_payment_source` are now available in the `stored_credential` object under the `payment_source` which supports them (eg. `payment_source.card.stored_credential.payment_initiator`). Please specify this field in the `payment_source` object instead of the `application_context` object. | getStoredPaymentSource(): ?StoredPaymentSource | setStoredPaymentSource(?StoredPaymentSource storedPaymentSource): void |
|
||||
|
||||
## Example (as JSON)
|
||||
|
||||
|
||||
@@ -71,7 +71,7 @@ The payment source definition.
|
||||
"name": "name4",
|
||||
"number": "number2",
|
||||
"expiry": "expiry2",
|
||||
"card_type": "CB_NATIONALE",
|
||||
"card_type": "VISA",
|
||||
"type": "UNKNOWN"
|
||||
},
|
||||
"device_manufacturer_id": "device_manufacturer_id6",
|
||||
@@ -94,7 +94,7 @@ The payment source definition.
|
||||
"card": {
|
||||
"name": "name6",
|
||||
"type": "UNKNOWN",
|
||||
"brand": "RUPAY",
|
||||
"brand": "CB_NATIONALE",
|
||||
"billing_address": {
|
||||
"address_line_1": "address_line_12",
|
||||
"address_line_2": "address_line_28",
|
||||
|
||||
@@ -67,7 +67,7 @@ The authorization of an order request.
|
||||
"name": "name4",
|
||||
"number": "number2",
|
||||
"expiry": "expiry2",
|
||||
"card_type": "CB_NATIONALE",
|
||||
"card_type": "VISA",
|
||||
"type": "UNKNOWN"
|
||||
},
|
||||
"device_manufacturer_id": "device_manufacturer_id6",
|
||||
@@ -90,7 +90,7 @@ The authorization of an order request.
|
||||
"card": {
|
||||
"name": "name6",
|
||||
"type": "UNKNOWN",
|
||||
"brand": "RUPAY",
|
||||
"brand": "CB_NATIONALE",
|
||||
"billing_address": {
|
||||
"address_line_1": "address_line_12",
|
||||
"address_line_2": "address_line_28",
|
||||
|
||||
@@ -24,9 +24,9 @@ The payment source used to fund the payment.
|
||||
"card": {
|
||||
"name": "name6",
|
||||
"last_digits": "last_digits0",
|
||||
"brand": "RUPAY",
|
||||
"brand": "CB_NATIONALE",
|
||||
"available_networks": [
|
||||
"SYNCHRONY"
|
||||
"DELTA"
|
||||
],
|
||||
"type": "UNKNOWN"
|
||||
},
|
||||
@@ -60,7 +60,7 @@ The payment source used to fund the payment.
|
||||
"name": "name6",
|
||||
"last_digits": "last_digits0",
|
||||
"type": "UNKNOWN",
|
||||
"brand": "RUPAY",
|
||||
"brand": "CB_NATIONALE",
|
||||
"billing_address": {
|
||||
"address_line_1": "address_line_12",
|
||||
"address_line_2": "address_line_28",
|
||||
|
||||
@@ -1,6 +1,8 @@
|
||||
|
||||
# Order Authorize Response
|
||||
|
||||
The order authorize response.
|
||||
|
||||
## Structure
|
||||
|
||||
`OrderAuthorizeResponse`
|
||||
@@ -14,10 +16,10 @@
|
||||
| `id` | `?string` | Optional | The ID of the order. | getId(): ?string | setId(?string id): void |
|
||||
| `paymentSource` | [`?OrderAuthorizeResponsePaymentSource`](../../doc/models/order-authorize-response-payment-source.md) | Optional | The payment source used to fund the payment. | getPaymentSource(): ?OrderAuthorizeResponsePaymentSource | setPaymentSource(?OrderAuthorizeResponsePaymentSource paymentSource): void |
|
||||
| `intent` | [`?string(CheckoutPaymentIntent)`](../../doc/models/checkout-payment-intent.md) | Optional | The intent to either capture payment immediately or authorize a payment for an order after order creation. | getIntent(): ?string | setIntent(?string intent): void |
|
||||
| `payer` | [`?Payer`](../../doc/models/payer.md) | Optional | - | getPayer(): ?Payer | setPayer(?Payer payer): void |
|
||||
| `payer` | [`?Payer`](../../doc/models/payer.md) | Optional | The customer who approves and pays for the order. The customer is also known as the payer. | getPayer(): ?Payer | setPayer(?Payer payer): void |
|
||||
| `purchaseUnits` | [`?(PurchaseUnit[])`](../../doc/models/purchase-unit.md) | Optional | An array of purchase units. Each purchase unit establishes a contract between a customer and merchant. Each purchase unit represents either a full or partial order that the customer intends to purchase from the merchant.<br><br>**Constraints**: *Minimum Items*: `1`, *Maximum Items*: `10` | getPurchaseUnits(): ?array | setPurchaseUnits(?array purchaseUnits): void |
|
||||
| `status` | [`?string(OrderStatus)`](../../doc/models/order-status.md) | Optional | The order status.<br><br>**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `255`, *Pattern*: `^[0-9A-Z_]+$` | getStatus(): ?string | setStatus(?string status): void |
|
||||
| `links` | [`?(LinkDescription[])`](../../doc/models/link-description.md) | Optional | An array of request-related [HATEOAS links](/api/rest/responses/#hateoas-links) that are either relevant to the issue by providing additional information or offering potential resolutions.<br><br>**Constraints**: *Minimum Items*: `1`, *Maximum Items*: `4` | getLinks(): ?array | setLinks(?array links): void |
|
||||
| `links` | [`?(LinkDescription[])`](../../doc/models/link-description.md) | Optional | An array of request-related HATEOAS links. To complete payer approval, use the `approve` link to redirect the payer. The API caller has 6 hours (default setting, this which can be changed by your account manager to 24/48/72 hours to accommodate your use case) from the time the order is created, to redirect your payer. Once redirected, the API caller has 6 hours for the payer to approve the order and either authorize or capture the order. If you are not using the PayPal JavaScript SDK to initiate PayPal Checkout (in context) ensure that you include `application_context.return_url` is specified or you will get "We're sorry, Things don't appear to be working at the moment" after the payer approves the payment. | getLinks(): ?array | setLinks(?array links): void |
|
||||
|
||||
## Example (as JSON)
|
||||
|
||||
@@ -30,9 +32,9 @@
|
||||
"card": {
|
||||
"name": "name6",
|
||||
"last_digits": "last_digits0",
|
||||
"brand": "RUPAY",
|
||||
"brand": "CB_NATIONALE",
|
||||
"available_networks": [
|
||||
"SYNCHRONY"
|
||||
"DELTA"
|
||||
],
|
||||
"type": "UNKNOWN"
|
||||
},
|
||||
@@ -66,7 +68,7 @@
|
||||
"name": "name6",
|
||||
"last_digits": "last_digits0",
|
||||
"type": "UNKNOWN",
|
||||
"brand": "RUPAY",
|
||||
"brand": "CB_NATIONALE",
|
||||
"billing_address": {
|
||||
"address_line_1": "address_line_12",
|
||||
"address_line_2": "address_line_28",
|
||||
|
||||
@@ -35,10 +35,6 @@ Metadata for merchant-managed recurring billing plans. Valid only during the sav
|
||||
"value": "value6"
|
||||
}
|
||||
},
|
||||
"frequency": {
|
||||
"key1": "val1",
|
||||
"key2": "val2"
|
||||
},
|
||||
"start_date": "start_date6"
|
||||
}
|
||||
],
|
||||
|
||||
@@ -71,7 +71,7 @@ The payment source definition.
|
||||
"name": "name4",
|
||||
"number": "number2",
|
||||
"expiry": "expiry2",
|
||||
"card_type": "CB_NATIONALE",
|
||||
"card_type": "VISA",
|
||||
"type": "UNKNOWN"
|
||||
},
|
||||
"device_manufacturer_id": "device_manufacturer_id6",
|
||||
@@ -94,7 +94,7 @@ The payment source definition.
|
||||
"card": {
|
||||
"name": "name6",
|
||||
"type": "UNKNOWN",
|
||||
"brand": "RUPAY",
|
||||
"brand": "CB_NATIONALE",
|
||||
"billing_address": {
|
||||
"address_line_1": "address_line_12",
|
||||
"address_line_2": "address_line_28",
|
||||
|
||||
@@ -67,7 +67,7 @@ Completes an capture payment for an order.
|
||||
"name": "name4",
|
||||
"number": "number2",
|
||||
"expiry": "expiry2",
|
||||
"card_type": "CB_NATIONALE",
|
||||
"card_type": "VISA",
|
||||
"type": "UNKNOWN"
|
||||
},
|
||||
"device_manufacturer_id": "device_manufacturer_id6",
|
||||
@@ -90,7 +90,7 @@ Completes an capture payment for an order.
|
||||
"card": {
|
||||
"name": "name6",
|
||||
"type": "UNKNOWN",
|
||||
"brand": "RUPAY",
|
||||
"brand": "CB_NATIONALE",
|
||||
"billing_address": {
|
||||
"address_line_1": "address_line_12",
|
||||
"address_line_2": "address_line_28",
|
||||
|
||||
@@ -32,7 +32,7 @@ Customizes the payer confirmation experience.
|
||||
"previous_network_transaction_reference": {
|
||||
"id": "id6",
|
||||
"date": "date2",
|
||||
"network": "DELTA",
|
||||
"network": "CONFIDIS",
|
||||
"acquirer_reference_number": "acquirer_reference_number8"
|
||||
}
|
||||
}
|
||||
|
||||
@@ -12,7 +12,7 @@ The order request details.
|
||||
| Name | Type | Tags | Description | Getter | Setter |
|
||||
| --- | --- | --- | --- | --- | --- |
|
||||
| `intent` | [`string(CheckoutPaymentIntent)`](../../doc/models/checkout-payment-intent.md) | Required | The intent to either capture payment immediately or authorize a payment for an order after order creation. | getIntent(): string | setIntent(string intent): void |
|
||||
| `payer` | [`?Payer`](../../doc/models/payer.md) | Optional | - | getPayer(): ?Payer | setPayer(?Payer payer): void |
|
||||
| `payer` | [`?Payer`](../../doc/models/payer.md) | Optional | DEPRECATED. The customer is also known as the payer. The Payer object was intended to only be used with the `payment_source.paypal` object. In order to make this design more clear, the details in the `payer` object are now available under `payment_source.paypal`. Please use `payment_source.paypal`. | getPayer(): ?Payer | setPayer(?Payer payer): void |
|
||||
| `purchaseUnits` | [`PurchaseUnitRequest[]`](../../doc/models/purchase-unit-request.md) | Required | An array of purchase units. Each purchase unit establishes a contract between a payer and the payee. Each purchase unit represents either a full or partial order that the payer intends to purchase from the payee.<br><br>**Constraints**: *Minimum Items*: `1`, *Maximum Items*: `10` | getPurchaseUnits(): array | setPurchaseUnits(array purchaseUnits): void |
|
||||
| `paymentSource` | [`?PaymentSource`](../../doc/models/payment-source.md) | Optional | The payment source definition. | getPaymentSource(): ?PaymentSource | setPaymentSource(?PaymentSource paymentSource): void |
|
||||
| `applicationContext` | [`?OrderApplicationContext`](../../doc/models/order-application-context.md) | Optional | Customizes the payer experience during the approval process for the payment with PayPal. Note: Partners and Marketplaces might configure brand_name and shipping_preference during partner account setup, which overrides the request values. | getApplicationContext(): ?OrderApplicationContext | setApplicationContext(?OrderApplicationContext applicationContext): void |
|
||||
|
||||
@@ -25,7 +25,7 @@ The tracking details of an order.
|
||||
"capture_id": "capture_id0",
|
||||
"notify_payer": false,
|
||||
"tracking_number": "tracking_number6",
|
||||
"carrier": "LEADER",
|
||||
"carrier": "ZELERIS",
|
||||
"carrier_name_other": "carrier_name_other0",
|
||||
"items": [
|
||||
{
|
||||
|
||||
@@ -1,27 +0,0 @@
|
||||
|
||||
# Order Update Callback Error Response Details
|
||||
|
||||
The error details. Required for client-side `4XX` errors.
|
||||
|
||||
## Structure
|
||||
|
||||
`OrderUpdateCallbackErrorResponseDetails`
|
||||
|
||||
## Fields
|
||||
|
||||
| Name | Type | Tags | Description | Getter | Setter |
|
||||
| --- | --- | --- | --- | --- | --- |
|
||||
| `field` | `?string` | Optional | The field that caused the error. If this field is in the body, set this value to the field's JSON pointer value. Required for client-side errors.<br><br>**Constraints**: *Minimum Length*: `0`, *Maximum Length*: `256`, *Pattern*: `^.*$` | getField(): ?string | setField(?string field): void |
|
||||
| `value` | `?string` | Optional | The value of the field that caused the error.<br><br>**Constraints**: *Minimum Length*: `0`, *Maximum Length*: `1024`, *Pattern*: `^.*$` | getValue(): ?string | setValue(?string value): void |
|
||||
| `issue` | `string` | Required | The unique, fine-grained application-level error code.<br><br>**Constraints**: *Minimum Length*: `0`, *Maximum Length*: `256`, *Pattern*: `^.*$` | getIssue(): string | setIssue(string issue): void |
|
||||
|
||||
## Example (as JSON)
|
||||
|
||||
```json
|
||||
{
|
||||
"field": "field8",
|
||||
"value": "value6",
|
||||
"issue": "issue0"
|
||||
}
|
||||
```
|
||||
|
||||
@@ -1,38 +0,0 @@
|
||||
|
||||
# Order Update Callback Error Response
|
||||
|
||||
The error details.
|
||||
|
||||
## Structure
|
||||
|
||||
`OrderUpdateCallbackErrorResponse`
|
||||
|
||||
## Fields
|
||||
|
||||
| Name | Type | Tags | Description | Getter | Setter |
|
||||
| --- | --- | --- | --- | --- | --- |
|
||||
| `name` | `string` | Required | The human-readable, unique name of the error.<br><br>**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `256`, *Pattern*: `^.*$` | getName(): string | setName(string name): void |
|
||||
| `message` | `?string` | Optional | The message that describes the error.<br><br>**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `2048`, *Pattern*: `^.*$` | getMessage(): ?string | setMessage(?string message): void |
|
||||
| `details` | [`?(OrderUpdateCallbackErrorResponseDetails[])`](../../doc/models/order-update-callback-error-response-details.md) | Optional | An array of additional details about the error.<br><br>**Constraints**: *Minimum Items*: `1`, *Maximum Items*: `100` | getDetails(): ?array | setDetails(?array details): void |
|
||||
|
||||
## Example (as JSON)
|
||||
|
||||
```json
|
||||
{
|
||||
"name": "name2",
|
||||
"message": "message8",
|
||||
"details": [
|
||||
{
|
||||
"field": "field4",
|
||||
"value": "value2",
|
||||
"issue": "issue6"
|
||||
},
|
||||
{
|
||||
"field": "field4",
|
||||
"value": "value2",
|
||||
"issue": "issue6"
|
||||
}
|
||||
]
|
||||
}
|
||||
```
|
||||
|
||||
@@ -1,115 +0,0 @@
|
||||
|
||||
# Order Update Callback Request
|
||||
|
||||
Shipping Options Callback request. This will be implemented by the merchants.
|
||||
|
||||
## Structure
|
||||
|
||||
`OrderUpdateCallbackRequest`
|
||||
|
||||
## Fields
|
||||
|
||||
| Name | Type | Tags | Description | Getter | Setter |
|
||||
| --- | --- | --- | --- | --- | --- |
|
||||
| `id` | `?string` | Optional | The ID of the order.<br><br>**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `36`, *Pattern*: `^[A-Z0-9-]+$` | getId(): ?string | setId(?string id): void |
|
||||
| `shippingAddress` | [`OrderUpdateCallbackShippingAddress`](../../doc/models/order-update-callback-shipping-address.md) | Required | The portable international postal address. Maps to [AddressValidationMetadata](https://github.com/googlei18n/libaddressinput/wiki/AddressValidationMetadata) and HTML 5.1 [Autofilling form controls: the autocomplete attribute](https://www.w3.org/TR/html51/sec-forms.html#autofilling-form-controls-the-autocomplete-attribute). | getShippingAddress(): OrderUpdateCallbackShippingAddress | setShippingAddress(OrderUpdateCallbackShippingAddress shippingAddress): void |
|
||||
| `shippingOption` | [`?OrderUpdateCallbackShippingOption`](../../doc/models/order-update-callback-shipping-option.md) | Optional | The options that the payee or merchant offers to the payer to ship or pick up their items. | getShippingOption(): ?OrderUpdateCallbackShippingOption | setShippingOption(?OrderUpdateCallbackShippingOption shippingOption): void |
|
||||
| `purchaseUnits` | [`PurchaseUnitRequest[]`](../../doc/models/purchase-unit-request.md) | Required | An array of purchase units. At present only 1 purchase_unit is supported. Each purchase unit establishes a contract between a payer and the payee. Each purchase unit represents either a full or partial order that the payer intends to purchase from the payee.<br><br>**Constraints**: *Minimum Items*: `1`, *Maximum Items*: `1` | getPurchaseUnits(): array | setPurchaseUnits(array purchaseUnits): void |
|
||||
|
||||
## Example (as JSON)
|
||||
|
||||
```json
|
||||
{
|
||||
"shipping_address": {
|
||||
"admin_area_2": "admin_area_24",
|
||||
"admin_area_1": "admin_area_16",
|
||||
"postal_code": "postal_code2",
|
||||
"country_code": "country_code0"
|
||||
},
|
||||
"purchase_units": [
|
||||
{
|
||||
"reference_id": "reference_id4",
|
||||
"amount": {
|
||||
"currency_code": "currency_code6",
|
||||
"value": "value0",
|
||||
"breakdown": {
|
||||
"item_total": {
|
||||
"currency_code": "currency_code0",
|
||||
"value": "value6"
|
||||
},
|
||||
"shipping": {
|
||||
"currency_code": "currency_code0",
|
||||
"value": "value6"
|
||||
},
|
||||
"handling": {
|
||||
"currency_code": "currency_code2",
|
||||
"value": "value8"
|
||||
},
|
||||
"tax_total": {
|
||||
"currency_code": "currency_code4",
|
||||
"value": "value0"
|
||||
},
|
||||
"insurance": {
|
||||
"currency_code": "currency_code2",
|
||||
"value": "value8"
|
||||
}
|
||||
}
|
||||
},
|
||||
"payee": {
|
||||
"email_address": "email_address4",
|
||||
"merchant_id": "merchant_id6"
|
||||
},
|
||||
"payment_instruction": {
|
||||
"platform_fees": [
|
||||
{
|
||||
"amount": {
|
||||
"currency_code": "currency_code6",
|
||||
"value": "value0"
|
||||
},
|
||||
"payee": {
|
||||
"email_address": "email_address4",
|
||||
"merchant_id": "merchant_id6"
|
||||
}
|
||||
},
|
||||
{
|
||||
"amount": {
|
||||
"currency_code": "currency_code6",
|
||||
"value": "value0"
|
||||
},
|
||||
"payee": {
|
||||
"email_address": "email_address4",
|
||||
"merchant_id": "merchant_id6"
|
||||
}
|
||||
},
|
||||
{
|
||||
"amount": {
|
||||
"currency_code": "currency_code6",
|
||||
"value": "value0"
|
||||
},
|
||||
"payee": {
|
||||
"email_address": "email_address4",
|
||||
"merchant_id": "merchant_id6"
|
||||
}
|
||||
}
|
||||
],
|
||||
"disbursement_mode": "INSTANT",
|
||||
"payee_pricing_tier_id": "payee_pricing_tier_id2",
|
||||
"payee_receivable_fx_rate_id": "payee_receivable_fx_rate_id0"
|
||||
},
|
||||
"description": "description6",
|
||||
"custom_id": "custom_id4"
|
||||
}
|
||||
],
|
||||
"id": "id2",
|
||||
"shipping_option": {
|
||||
"id": "id4",
|
||||
"label": "label4",
|
||||
"type": "PICKUP_IN_STORE",
|
||||
"amount": {
|
||||
"currency_code": "currency_code6",
|
||||
"value": "value0"
|
||||
}
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
@@ -1,83 +0,0 @@
|
||||
|
||||
# Order Update Callback Response
|
||||
|
||||
Returns the updated shipping options for an order.
|
||||
|
||||
## Structure
|
||||
|
||||
`OrderUpdateCallbackResponse`
|
||||
|
||||
## Fields
|
||||
|
||||
| Name | Type | Tags | Description | Getter | Setter |
|
||||
| --- | --- | --- | --- | --- | --- |
|
||||
| `id` | `?string` | Optional | The ID of the order.<br><br>**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `36`, *Pattern*: `^[A-Z0-9-]+$` | getId(): ?string | setId(?string id): void |
|
||||
| `purchaseUnits` | [`?ShippingOptionsPurchaseUnit`](../../doc/models/shipping-options-purchase-unit.md) | Optional | This would contain shipping option and amount data at purchase unit level. | getPurchaseUnits(): ?ShippingOptionsPurchaseUnit | setPurchaseUnits(?ShippingOptionsPurchaseUnit purchaseUnits): void |
|
||||
|
||||
## Example (as JSON)
|
||||
|
||||
```json
|
||||
{
|
||||
"id": "id2",
|
||||
"purchase_units": {
|
||||
"reference_id": "reference_id4",
|
||||
"amount": {
|
||||
"currency_code": "currency_code6",
|
||||
"value": "value0",
|
||||
"breakdown": {
|
||||
"item_total": {
|
||||
"currency_code": "currency_code0",
|
||||
"value": "value6"
|
||||
},
|
||||
"shipping": {
|
||||
"currency_code": "currency_code0",
|
||||
"value": "value6"
|
||||
},
|
||||
"handling": {
|
||||
"currency_code": "currency_code2",
|
||||
"value": "value8"
|
||||
},
|
||||
"tax_total": {
|
||||
"currency_code": "currency_code4",
|
||||
"value": "value0"
|
||||
},
|
||||
"insurance": {
|
||||
"currency_code": "currency_code2",
|
||||
"value": "value8"
|
||||
}
|
||||
}
|
||||
},
|
||||
"items": [
|
||||
{
|
||||
"name": "name8",
|
||||
"unit_amount": {
|
||||
"currency_code": "currency_code2",
|
||||
"value": "value8"
|
||||
},
|
||||
"tax": {
|
||||
"currency_code": "currency_code0",
|
||||
"value": "value6"
|
||||
},
|
||||
"quantity": "quantity4",
|
||||
"description": "description2",
|
||||
"sku": "sku6",
|
||||
"url": "url2",
|
||||
"category": "DONATION"
|
||||
}
|
||||
],
|
||||
"shipping_options": [
|
||||
{
|
||||
"id": "id8",
|
||||
"label": "label8",
|
||||
"type": "PICKUP_IN_STORE",
|
||||
"amount": {
|
||||
"currency_code": "currency_code6",
|
||||
"value": "value0"
|
||||
},
|
||||
"selected": false
|
||||
}
|
||||
]
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
@@ -1,29 +0,0 @@
|
||||
|
||||
# Order Update Callback Shipping Address
|
||||
|
||||
The portable international postal address. Maps to [AddressValidationMetadata](https://github.com/googlei18n/libaddressinput/wiki/AddressValidationMetadata) and HTML 5.1 [Autofilling form controls: the autocomplete attribute](https://www.w3.org/TR/html51/sec-forms.html#autofilling-form-controls-the-autocomplete-attribute).
|
||||
|
||||
## Structure
|
||||
|
||||
`OrderUpdateCallbackShippingAddress`
|
||||
|
||||
## Fields
|
||||
|
||||
| Name | Type | Tags | Description | Getter | Setter |
|
||||
| --- | --- | --- | --- | --- | --- |
|
||||
| `adminArea2` | `?string` | Optional | A city, town, or village. Smaller than `admin_area_level_1`.<br><br>**Constraints**: *Maximum Length*: `120` | getAdminArea2(): ?string | setAdminArea2(?string adminArea2): void |
|
||||
| `adminArea1` | `?string` | Optional | The highest-level sub-division in a country, which is usually a province, state, or ISO-3166-2 subdivision. This data is formatted for postal delivery, for example, `CA` and not `California`. Value, by country, is: UK. A county. US. A state. Canada. A province. Japan. A prefecture. Switzerland. A *kanton*.<br><br>**Constraints**: *Maximum Length*: `300` | getAdminArea1(): ?string | setAdminArea1(?string adminArea1): void |
|
||||
| `postalCode` | `?string` | Optional | The postal code, which is the ZIP code or equivalent. Typically required for countries with a postal code or an equivalent. See [postal code](https://en.wikipedia.org/wiki/Postal_code).<br><br>**Constraints**: *Maximum Length*: `60` | getPostalCode(): ?string | setPostalCode(?string postalCode): void |
|
||||
| `countryCode` | `string` | Required | The [2-character ISO 3166-1 code](/api/rest/reference/country-codes/) that identifies the country or region. Note: The country code for Great Britain is GB and not UK as used in the top-level domain names for that country. Use the `C2` country code for China worldwide for comparable uncontrolled price (CUP) method, bank card, and cross-border transactions.<br><br>**Constraints**: *Minimum Length*: `2`, *Maximum Length*: `2`, *Pattern*: `^([A-Z]{2}\|C2)$` | getCountryCode(): string | setCountryCode(string countryCode): void |
|
||||
|
||||
## Example (as JSON)
|
||||
|
||||
```json
|
||||
{
|
||||
"admin_area_2": "admin_area_26",
|
||||
"admin_area_1": "admin_area_16",
|
||||
"postal_code": "postal_code2",
|
||||
"country_code": "country_code0"
|
||||
}
|
||||
```
|
||||
|
||||
@@ -1,32 +0,0 @@
|
||||
|
||||
# Order Update Callback Shipping Option
|
||||
|
||||
The options that the payee or merchant offers to the payer to ship or pick up their items.
|
||||
|
||||
## Structure
|
||||
|
||||
`OrderUpdateCallbackShippingOption`
|
||||
|
||||
## Fields
|
||||
|
||||
| Name | Type | Tags | Description | Getter | Setter |
|
||||
| --- | --- | --- | --- | --- | --- |
|
||||
| `id` | `string` | Required | A unique ID that identifies a payer-selected shipping option.<br><br>**Constraints**: *Maximum Length*: `127` | getId(): string | setId(string id): void |
|
||||
| `label` | `string` | Required | A description that the payer sees, which helps them choose an appropriate shipping option. For example, `Free Shipping`, `USPS Priority Shipping`, `Expédition prioritaire USPS`, or `USPS yōuxiān fā huò`. Localize this description to the payer's locale.<br><br>**Constraints**: *Maximum Length*: `127` | getLabel(): string | setLabel(string label): void |
|
||||
| `type` | [`?string(ShippingType)`](../../doc/models/shipping-type.md) | Optional | A classification for the method of purchase fulfillment. | getType(): ?string | setType(?string type): void |
|
||||
| `amount` | [`?Money`](../../doc/models/money.md) | Optional | The currency and amount for a financial transaction, such as a balance or payment due. | getAmount(): ?Money | setAmount(?Money amount): void |
|
||||
|
||||
## Example (as JSON)
|
||||
|
||||
```json
|
||||
{
|
||||
"id": "id8",
|
||||
"label": "label8",
|
||||
"type": "SHIPPING",
|
||||
"amount": {
|
||||
"currency_code": "currency_code6",
|
||||
"value": "value0"
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
@@ -16,7 +16,7 @@ The order details.
|
||||
| `id` | `?string` | Optional | The ID of the order. | getId(): ?string | setId(?string id): void |
|
||||
| `paymentSource` | [`?PaymentSourceResponse`](../../doc/models/payment-source-response.md) | Optional | The payment source used to fund the payment. | getPaymentSource(): ?PaymentSourceResponse | setPaymentSource(?PaymentSourceResponse paymentSource): void |
|
||||
| `intent` | [`?string(CheckoutPaymentIntent)`](../../doc/models/checkout-payment-intent.md) | Optional | The intent to either capture payment immediately or authorize a payment for an order after order creation. | getIntent(): ?string | setIntent(?string intent): void |
|
||||
| `payer` | [`?Payer`](../../doc/models/payer.md) | Optional | - | getPayer(): ?Payer | setPayer(?Payer payer): void |
|
||||
| `payer` | [`?Payer`](../../doc/models/payer.md) | Optional | DEPRECATED. The customer is also known as the payer. The Payer object was intended to only be used with the `payment_source.paypal` object. In order to make this design more clear, the details in the `payer` object are now available under `payment_source.paypal`. Please use `payment_source.paypal`. | getPayer(): ?Payer | setPayer(?Payer payer): void |
|
||||
| `purchaseUnits` | [`?(PurchaseUnit[])`](../../doc/models/purchase-unit.md) | Optional | An array of purchase units. Each purchase unit establishes a contract between a customer and merchant. Each purchase unit represents either a full or partial order that the customer intends to purchase from the merchant.<br><br>**Constraints**: *Minimum Items*: `1`, *Maximum Items*: `10` | getPurchaseUnits(): ?array | setPurchaseUnits(?array purchaseUnits): void |
|
||||
| `status` | [`?string(OrderStatus)`](../../doc/models/order-status.md) | Optional | The order status.<br><br>**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `255`, *Pattern*: `^[0-9A-Z_]+$` | getStatus(): ?string | setStatus(?string status): void |
|
||||
| `links` | [`?(LinkDescription[])`](../../doc/models/link-description.md) | Optional | An array of request-related HATEOAS links. To complete payer approval, use the `approve` link to redirect the payer. The API caller has 6 hours (default setting, this which can be changed by your account manager to 24/48/72 hours to accommodate your use case) from the time the order is created, to redirect your payer. Once redirected, the API caller has 6 hours for the payer to approve the order and either authorize or capture the order. If you are not using the PayPal JavaScript SDK to initiate PayPal Checkout (in context) ensure that you include `application_context.return_url` is specified or you will get "We're sorry, Things don't appear to be working at the moment" after the payer approves the payment. | getLinks(): ?array | setLinks(?array links): void |
|
||||
@@ -32,9 +32,9 @@ The order details.
|
||||
"card": {
|
||||
"name": "name6",
|
||||
"last_digits": "last_digits0",
|
||||
"brand": "RUPAY",
|
||||
"brand": "CB_NATIONALE",
|
||||
"available_networks": [
|
||||
"SYNCHRONY"
|
||||
"DELTA"
|
||||
],
|
||||
"type": "UNKNOWN"
|
||||
},
|
||||
|
||||
@@ -17,7 +17,7 @@ A captured payment.
|
||||
| `amount` | [`?Money`](../../doc/models/money.md) | Optional | The currency and amount for a financial transaction, such as a balance or payment due. | getAmount(): ?Money | setAmount(?Money amount): void |
|
||||
| `invoiceId` | `?string` | Optional | The API caller-provided external invoice number for this order. Appears in both the payer's transaction history and the emails that the payer receives. | getInvoiceId(): ?string | setInvoiceId(?string invoiceId): void |
|
||||
| `customId` | `?string` | Optional | The API caller-provided external ID. Used to reconcile API caller-initiated transactions with PayPal transactions. Appears in transaction and settlement reports.<br><br>**Constraints**: *Maximum Length*: `255` | getCustomId(): ?string | setCustomId(?string customId): void |
|
||||
| `networkTransactionReference` | [`?NetworkTransactionReference`](../../doc/models/network-transaction-reference.md) | Optional | Reference values used by the card network to identify a transaction. | getNetworkTransactionReference(): ?NetworkTransactionReference | setNetworkTransactionReference(?NetworkTransactionReference networkTransactionReference): void |
|
||||
| `networkTransactionReference` | [`?NetworkTransaction`](../../doc/models/network-transaction.md) | Optional | Reference values used by the card network to identify a transaction. | getNetworkTransactionReference(): ?NetworkTransaction | setNetworkTransactionReference(?NetworkTransaction networkTransactionReference): void |
|
||||
| `sellerProtection` | [`?SellerProtection`](../../doc/models/seller-protection.md) | Optional | The level of protection offered as defined by [PayPal Seller Protection for Merchants](https://www.paypal.com/us/webapps/mpp/security/seller-protection). | getSellerProtection(): ?SellerProtection | setSellerProtection(?SellerProtection sellerProtection): void |
|
||||
| `finalCapture` | `?bool` | Optional | Indicates whether you can make additional captures against the authorized payment. Set to `true` if you do not intend to capture additional payments against the authorization. Set to `false` if you intend to capture additional payments against the authorization.<br><br>**Default**: `false` | getFinalCapture(): ?bool | setFinalCapture(?bool finalCapture): void |
|
||||
| `sellerReceivableBreakdown` | [`?SellerReceivableBreakdown`](../../doc/models/seller-receivable-breakdown.md) | Optional | The detailed breakdown of the capture activity. This is not available for transactions that are in pending state. | getSellerReceivableBreakdown(): ?SellerReceivableBreakdown | setSellerReceivableBreakdown(?SellerReceivableBreakdown sellerReceivableBreakdown): void |
|
||||
|
||||
17
doc/models/os-type.md
Normal file
17
doc/models/os-type.md
Normal file
@@ -0,0 +1,17 @@
|
||||
|
||||
# Os Type
|
||||
|
||||
Operating System type of the device that the buyer is using.
|
||||
|
||||
## Enumeration
|
||||
|
||||
`OsType`
|
||||
|
||||
## Fields
|
||||
|
||||
| Name | Description |
|
||||
| --- | --- |
|
||||
| `ANDROID` | Google Android OS. |
|
||||
| `IOS` | Apple OS typically found in Apple mobile devices. |
|
||||
| `OTHER` | Any other OS type. |
|
||||
|
||||
38
doc/models/payer-information.md
Normal file
38
doc/models/payer-information.md
Normal file
@@ -0,0 +1,38 @@
|
||||
|
||||
# Payer Information
|
||||
|
||||
The payer information.
|
||||
|
||||
## Structure
|
||||
|
||||
`PayerInformation`
|
||||
|
||||
## Fields
|
||||
|
||||
| Name | Type | Tags | Description | Getter | Setter |
|
||||
| --- | --- | --- | --- | --- | --- |
|
||||
| `accountId` | `?string` | Optional | The PayPal` customer account ID.<br><br>**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `13`, *Pattern*: `^[a-zA-Z0-9]*$` | getAccountId(): ?string | setAccountId(?string accountId): void |
|
||||
| `emailAddress` | `?string` | Optional | The internationalized email address. Note: Up to 64 characters are allowed before and 255 characters are allowed after the @ sign. However, the generally accepted maximum length for an email address is 254 characters. The pattern verifies that an unquoted @ sign exists.<br><br>**Constraints**: *Minimum Length*: `3`, *Maximum Length*: `254`, *Pattern*: `^.+@[^"\-].+$` | getEmailAddress(): ?string | setEmailAddress(?string emailAddress): void |
|
||||
| `phoneNumber` | [`?Phone`](../../doc/models/phone.md) | Optional | The phone number, in its canonical international [E.164 numbering plan format](https://www.itu.int/rec/T-REC-E.164/en). | getPhoneNumber(): ?Phone | setPhoneNumber(?Phone phoneNumber): void |
|
||||
| `addressStatus` | `?string` | Optional | The address status of the payer. Value is either: Y. Verified. N. Not verified.<br><br>**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `1`, *Pattern*: `^[N\|Y]$` | getAddressStatus(): ?string | setAddressStatus(?string addressStatus): void |
|
||||
| `payerStatus` | `?string` | Optional | The status of the payer. Value is `Y` or `N`.<br><br>**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `1`, *Pattern*: `^[N\|Y]$` | getPayerStatus(): ?string | setPayerStatus(?string payerStatus): void |
|
||||
| `payerName` | [`?PayerName`](../../doc/models/payer-name.md) | Optional | The name of the party. | getPayerName(): ?PayerName | setPayerName(?PayerName payerName): void |
|
||||
| `countryCode` | `?string` | Optional | The [two-character ISO 3166-1 code](/docs/integration/direct/rest/country-codes/) that identifies the country or region. Note: The country code for Great Britain is GB and not UK as used in the top-level domain names for that country. Use the `C2` country code for China worldwide for comparable uncontrolled price (CUP) method, bank card, and cross-border transactions.<br><br>**Constraints**: *Minimum Length*: `2`, *Maximum Length*: `2`, *Pattern*: `^([A-Z]{2}\|C2)$` | getCountryCode(): ?string | setCountryCode(?string countryCode): void |
|
||||
| `address` | [`?SimplePostalAddressCoarseGrained`](../../doc/models/simple-postal-address-coarse-grained.md) | Optional | A simple postal address with coarse-grained fields. Do not use for an international address. Use for backward compatibility only. Does not contain phone. | getAddress(): ?SimplePostalAddressCoarseGrained | setAddress(?SimplePostalAddressCoarseGrained address): void |
|
||||
|
||||
## Example (as JSON)
|
||||
|
||||
```json
|
||||
{
|
||||
"account_id": "account_id6",
|
||||
"email_address": "email_address2",
|
||||
"phone_number": {
|
||||
"country_code": "country_code2",
|
||||
"national_number": "national_number6",
|
||||
"extension_number": "extension_number8"
|
||||
},
|
||||
"address_status": "address_status2",
|
||||
"payer_status": "payer_status8"
|
||||
}
|
||||
```
|
||||
|
||||
33
doc/models/payer-name.md
Normal file
33
doc/models/payer-name.md
Normal file
@@ -0,0 +1,33 @@
|
||||
|
||||
# Payer Name
|
||||
|
||||
The name of the party.
|
||||
|
||||
## Structure
|
||||
|
||||
`PayerName`
|
||||
|
||||
## Fields
|
||||
|
||||
| Name | Type | Tags | Description | Getter | Setter |
|
||||
| --- | --- | --- | --- | --- | --- |
|
||||
| `prefix` | `?string` | Optional | The prefix, or title, to the party's name.<br><br>**Constraints**: *Maximum Length*: `140` | getPrefix(): ?string | setPrefix(?string prefix): void |
|
||||
| `givenName` | `?string` | Optional | When the party is a person, the party's given, or first, name.<br><br>**Constraints**: *Maximum Length*: `140` | getGivenName(): ?string | setGivenName(?string givenName): void |
|
||||
| `surname` | `?string` | Optional | When the party is a person, the party's surname or family name. Also known as the last name. Required when the party is a person. Use also to store multiple surnames including the matronymic, or mother's, surname.<br><br>**Constraints**: *Maximum Length*: `140` | getSurname(): ?string | setSurname(?string surname): void |
|
||||
| `middleName` | `?string` | Optional | When the party is a person, the party's middle name. Use also to store multiple middle names including the patronymic, or father's, middle name.<br><br>**Constraints**: *Maximum Length*: `140` | getMiddleName(): ?string | setMiddleName(?string middleName): void |
|
||||
| `suffix` | `?string` | Optional | The suffix for the party's name.<br><br>**Constraints**: *Maximum Length*: `140` | getSuffix(): ?string | setSuffix(?string suffix): void |
|
||||
| `alternateFullName` | `?string` | Optional | DEPRECATED. The party's alternate name. Can be a business name, nickname, or any other name that cannot be split into first, last name. Required when the party is a business.<br><br>**Constraints**: *Maximum Length*: `300` | getAlternateFullName(): ?string | setAlternateFullName(?string alternateFullName): void |
|
||||
| `fullName` | `?string` | Optional | When the party is a person, the party's full name.<br><br>**Constraints**: *Maximum Length*: `300` | getFullName(): ?string | setFullName(?string fullName): void |
|
||||
|
||||
## Example (as JSON)
|
||||
|
||||
```json
|
||||
{
|
||||
"prefix": "prefix4",
|
||||
"given_name": "given_name8",
|
||||
"surname": "surname8",
|
||||
"middle_name": "middle_name6",
|
||||
"suffix": "suffix6"
|
||||
}
|
||||
```
|
||||
|
||||
@@ -1,6 +1,8 @@
|
||||
|
||||
# Payer
|
||||
|
||||
The customer who approves and pays for the order. The customer is also known as the payer.
|
||||
|
||||
## Structure
|
||||
|
||||
`Payer`
|
||||
|
||||
@@ -17,7 +17,7 @@ The authorized payment transaction.
|
||||
| `amount` | [`?Money`](../../doc/models/money.md) | Optional | The currency and amount for a financial transaction, such as a balance or payment due. | getAmount(): ?Money | setAmount(?Money amount): void |
|
||||
| `invoiceId` | `?string` | Optional | The API caller-provided external invoice number for this order. Appears in both the payer's transaction history and the emails that the payer receives. | getInvoiceId(): ?string | setInvoiceId(?string invoiceId): void |
|
||||
| `customId` | `?string` | Optional | The API caller-provided external ID. Used to reconcile API caller-initiated transactions with PayPal transactions. Appears in transaction and settlement reports.<br><br>**Constraints**: *Maximum Length*: `255` | getCustomId(): ?string | setCustomId(?string customId): void |
|
||||
| `networkTransactionReference` | [`?NetworkTransactionReference`](../../doc/models/network-transaction-reference.md) | Optional | Reference values used by the card network to identify a transaction. | getNetworkTransactionReference(): ?NetworkTransactionReference | setNetworkTransactionReference(?NetworkTransactionReference networkTransactionReference): void |
|
||||
| `networkTransactionReference` | [`?NetworkTransaction`](../../doc/models/network-transaction.md) | Optional | Reference values used by the card network to identify a transaction. | getNetworkTransactionReference(): ?NetworkTransaction | setNetworkTransactionReference(?NetworkTransaction networkTransactionReference): void |
|
||||
| `sellerProtection` | [`?SellerProtection`](../../doc/models/seller-protection.md) | Optional | The level of protection offered as defined by [PayPal Seller Protection for Merchants](https://www.paypal.com/us/webapps/mpp/security/seller-protection). | getSellerProtection(): ?SellerProtection | setSellerProtection(?SellerProtection sellerProtection): void |
|
||||
| `expirationTime` | `?string` | Optional | The date and time, in [Internet date and time format](https://tools.ietf.org/html/rfc3339#section-5.6). Seconds are required while fractional seconds are optional. Note: The regular expression provides guidance but does not reject all invalid dates.<br><br>**Constraints**: *Minimum Length*: `20`, *Maximum Length*: `64`, *Pattern*: `^[0-9]{4}-(0[1-9]\|1[0-2])-(0[1-9]\|[1-2][0-9]\|3[0-1])[T,t]([0-1][0-9]\|2[0-3]):[0-5][0-9]:([0-5][0-9]\|60)([.][0-9]+)?([Zz]\|[+-][0-9]{2}:[0-9]{2})$` | getExpirationTime(): ?string | setExpirationTime(?string expirationTime): void |
|
||||
| `links` | [`?(LinkDescription[])`](../../doc/models/link-description.md) | Optional | An array of related [HATEOAS links](/docs/api/reference/api-responses/#hateoas-links). | getLinks(): ?array | setLinks(?array links): void |
|
||||
|
||||
23
doc/models/payment-method.md
Normal file
23
doc/models/payment-method.md
Normal file
@@ -0,0 +1,23 @@
|
||||
|
||||
# Payment Method
|
||||
|
||||
The customer and merchant payment preferences.
|
||||
|
||||
## Structure
|
||||
|
||||
`PaymentMethod`
|
||||
|
||||
## Fields
|
||||
|
||||
| Name | Type | Tags | Description | Getter | Setter |
|
||||
| --- | --- | --- | --- | --- | --- |
|
||||
| `payeePreferred` | [`?string(PayeePaymentMethodPreference)`](../../doc/models/payee-payment-method-preference.md) | Optional | The merchant-preferred payment methods.<br><br>**Default**: `PayeePaymentMethodPreference::UNRESTRICTED`<br><br>**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `255`, *Pattern*: `^[0-9A-Z_]+$` | getPayeePreferred(): ?string | setPayeePreferred(?string payeePreferred): void |
|
||||
|
||||
## Example (as JSON)
|
||||
|
||||
```json
|
||||
{
|
||||
"payee_preferred": "UNRESTRICTED"
|
||||
}
|
||||
```
|
||||
|
||||
32
doc/models/payment-preferences-override.md
Normal file
32
doc/models/payment-preferences-override.md
Normal file
@@ -0,0 +1,32 @@
|
||||
|
||||
# Payment Preferences Override
|
||||
|
||||
The payment preferences to override at subscription level.
|
||||
|
||||
## Structure
|
||||
|
||||
`PaymentPreferencesOverride`
|
||||
|
||||
## Fields
|
||||
|
||||
| Name | Type | Tags | Description | Getter | Setter |
|
||||
| --- | --- | --- | --- | --- | --- |
|
||||
| `autoBillOutstanding` | `?bool` | Optional | Indicates whether to automatically bill the outstanding amount in the next billing cycle. | getAutoBillOutstanding(): ?bool | setAutoBillOutstanding(?bool autoBillOutstanding): void |
|
||||
| `setupFee` | [`?Money`](../../doc/models/money.md) | Optional | The currency and amount for a financial transaction, such as a balance or payment due. | getSetupFee(): ?Money | setSetupFee(?Money setupFee): void |
|
||||
| `setupFeeFailureAction` | [`?string(SetupFeeFailureAction)`](../../doc/models/setup-fee-failure-action.md) | Optional | The action to take on the subscription if the initial payment for the setup fails.<br><br>**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `24`, *Pattern*: `^[A-Z_]+$` | getSetupFeeFailureAction(): ?string | setSetupFeeFailureAction(?string setupFeeFailureAction): void |
|
||||
| `paymentFailureThreshold` | `?int` | Optional | The maximum number of payment failures before a subscription is suspended. For example, if `payment_failure_threshold` is `2`, the subscription automatically updates to the `SUSPEND` state if two consecutive payments fail.<br><br>**Constraints**: `>= 0`, `<= 999` | getPaymentFailureThreshold(): ?int | setPaymentFailureThreshold(?int paymentFailureThreshold): void |
|
||||
|
||||
## Example (as JSON)
|
||||
|
||||
```json
|
||||
{
|
||||
"auto_bill_outstanding": false,
|
||||
"setup_fee": {
|
||||
"currency_code": "currency_code8",
|
||||
"value": "value4"
|
||||
},
|
||||
"setup_fee_failure_action": "CONTINUE",
|
||||
"payment_failure_threshold": 80
|
||||
}
|
||||
```
|
||||
|
||||
32
doc/models/payment-preferences.md
Normal file
32
doc/models/payment-preferences.md
Normal file
@@ -0,0 +1,32 @@
|
||||
|
||||
# Payment Preferences
|
||||
|
||||
The payment preferences for a subscription.
|
||||
|
||||
## Structure
|
||||
|
||||
`PaymentPreferences`
|
||||
|
||||
## Fields
|
||||
|
||||
| Name | Type | Tags | Description | Getter | Setter |
|
||||
| --- | --- | --- | --- | --- | --- |
|
||||
| `autoBillOutstanding` | `?bool` | Optional | Indicates whether to automatically bill the outstanding amount in the next billing cycle.<br><br>**Default**: `true` | getAutoBillOutstanding(): ?bool | setAutoBillOutstanding(?bool autoBillOutstanding): void |
|
||||
| `setupFee` | [`?Money`](../../doc/models/money.md) | Optional | The currency and amount for a financial transaction, such as a balance or payment due. | getSetupFee(): ?Money | setSetupFee(?Money setupFee): void |
|
||||
| `setupFeeFailureAction` | [`?string(SetupFeeFailureAction)`](../../doc/models/setup-fee-failure-action.md) | Optional | The action to take on the subscription if the initial payment for the setup fails.<br><br>**Default**: `SetupFeeFailureAction::CANCEL`<br><br>**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `24`, *Pattern*: `^[A-Z_]+$` | getSetupFeeFailureAction(): ?string | setSetupFeeFailureAction(?string setupFeeFailureAction): void |
|
||||
| `paymentFailureThreshold` | `?int` | Optional | The maximum number of payment failures before a subscription is suspended. For example, if `payment_failure_threshold` is `2`, the subscription automatically updates to the `SUSPEND` state if two consecutive payments fail.<br><br>**Default**: `0`<br><br>**Constraints**: `>= 0`, `<= 999` | getPaymentFailureThreshold(): ?int | setPaymentFailureThreshold(?int paymentFailureThreshold): void |
|
||||
|
||||
## Example (as JSON)
|
||||
|
||||
```json
|
||||
{
|
||||
"auto_bill_outstanding": true,
|
||||
"setup_fee_failure_action": "CANCEL",
|
||||
"payment_failure_threshold": 0,
|
||||
"setup_fee": {
|
||||
"currency_code": "currency_code8",
|
||||
"value": "value4"
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
@@ -33,9 +33,9 @@ The payment source used to fund the payment.
|
||||
"card": {
|
||||
"name": "name6",
|
||||
"last_digits": "last_digits0",
|
||||
"brand": "RUPAY",
|
||||
"brand": "CB_NATIONALE",
|
||||
"available_networks": [
|
||||
"SYNCHRONY"
|
||||
"DELTA"
|
||||
],
|
||||
"type": "UNKNOWN"
|
||||
},
|
||||
|
||||
@@ -26,7 +26,7 @@ A Resource representing a request to vault a Card.
|
||||
"number": "number8",
|
||||
"expiry": "expiry2",
|
||||
"security_code": "security_code6",
|
||||
"brand": "EFTPOS"
|
||||
"brand": "HIPER"
|
||||
}
|
||||
```
|
||||
|
||||
|
||||
@@ -23,7 +23,7 @@ The payment method to vault with the instrument details.
|
||||
"number": "number6",
|
||||
"expiry": "expiry4",
|
||||
"security_code": "security_code8",
|
||||
"brand": "RUPAY"
|
||||
"brand": "CB_NATIONALE"
|
||||
},
|
||||
"token": {
|
||||
"id": "id6",
|
||||
|
||||
@@ -28,7 +28,7 @@ Payment Token Request where the `source` defines the type of instrument to be st
|
||||
"number": "number6",
|
||||
"expiry": "expiry4",
|
||||
"security_code": "security_code8",
|
||||
"brand": "RUPAY"
|
||||
"brand": "CB_NATIONALE"
|
||||
},
|
||||
"token": {
|
||||
"id": "id6",
|
||||
|
||||
@@ -12,8 +12,8 @@ The vaulted payment method details.
|
||||
| Name | Type | Tags | Description | Getter | Setter |
|
||||
| --- | --- | --- | --- | --- | --- |
|
||||
| `card` | [`?CardPaymentTokenEntity`](../../doc/models/card-payment-token-entity.md) | Optional | Full representation of a Card Payment Token including network token. | getCard(): ?CardPaymentTokenEntity | setCard(?CardPaymentTokenEntity card): void |
|
||||
| `paypal` | [`?PaypalPaymentToken`](../../doc/models/paypal-payment-token.md) | Optional | - | getPaypal(): ?PaypalPaymentToken | setPaypal(?PaypalPaymentToken paypal): void |
|
||||
| `venmo` | [`?VenmoPaymentToken`](../../doc/models/venmo-payment-token.md) | Optional | - | getVenmo(): ?VenmoPaymentToken | setVenmo(?VenmoPaymentToken venmo): void |
|
||||
| `paypal` | [`?PaypalPaymentToken`](../../doc/models/paypal-payment-token.md) | Optional | Full representation of a PayPal Payment Token. | getPaypal(): ?PaypalPaymentToken | setPaypal(?PaypalPaymentToken paypal): void |
|
||||
| `venmo` | [`?VenmoPaymentToken`](../../doc/models/venmo-payment-token.md) | Optional | Full representation of a Venmo Payment Token. | getVenmo(): ?VenmoPaymentToken | setVenmo(?VenmoPaymentToken venmo): void |
|
||||
| `applePay` | [`?ApplePayPaymentToken`](../../doc/models/apple-pay-payment-token.md) | Optional | A resource representing a response for Apple Pay. | getApplePay(): ?ApplePayPaymentToken | setApplePay(?ApplePayPaymentToken applePay): void |
|
||||
|
||||
## Example (as JSON)
|
||||
@@ -23,7 +23,7 @@ The vaulted payment method details.
|
||||
"card": {
|
||||
"name": "name6",
|
||||
"last_digits": "last_digits0",
|
||||
"brand": "RUPAY",
|
||||
"brand": "CB_NATIONALE",
|
||||
"expiry": "expiry4",
|
||||
"billing_address": {
|
||||
"address_line_1": "address_line_12",
|
||||
@@ -41,6 +41,7 @@ The vaulted payment method details.
|
||||
"name": {
|
||||
"full_name": "full_name6"
|
||||
},
|
||||
"email_address": "email_address2",
|
||||
"phone_number": {
|
||||
"country_code": "country_code2",
|
||||
"national_number": "national_number6"
|
||||
@@ -65,6 +66,7 @@ The vaulted payment method details.
|
||||
"name": {
|
||||
"full_name": "full_name6"
|
||||
},
|
||||
"email_address": "email_address2",
|
||||
"phone_number": {
|
||||
"country_code": "country_code2",
|
||||
"national_number": "national_number6"
|
||||
@@ -87,7 +89,7 @@ The vaulted payment method details.
|
||||
"name": "name6",
|
||||
"last_digits": "last_digits0",
|
||||
"type": "UNKNOWN",
|
||||
"brand": "RUPAY",
|
||||
"brand": "CB_NATIONALE",
|
||||
"billing_address": {
|
||||
"address_line_1": "address_line_12",
|
||||
"address_line_2": "address_line_28",
|
||||
|
||||
@@ -11,7 +11,7 @@ Full representation of a saved payment token.
|
||||
|
||||
| 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 |
|
||||
| `id` | `?string` | Optional | The PayPal-generated ID for the vaulted payment source. This ID should be stored on the merchant's server so the saved payment source can be used for future transactions.<br><br>**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `255`, *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 |
|
||||
@@ -29,7 +29,7 @@ Full representation of a saved payment token.
|
||||
"card": {
|
||||
"name": "name6",
|
||||
"last_digits": "last_digits0",
|
||||
"brand": "RUPAY",
|
||||
"brand": "CB_NATIONALE",
|
||||
"expiry": "expiry4",
|
||||
"billing_address": {
|
||||
"address_line_1": "address_line_12",
|
||||
@@ -47,6 +47,7 @@ Full representation of a saved payment token.
|
||||
"name": {
|
||||
"full_name": "full_name6"
|
||||
},
|
||||
"email_address": "email_address2",
|
||||
"phone_number": {
|
||||
"country_code": "country_code2",
|
||||
"national_number": "national_number6"
|
||||
@@ -71,6 +72,7 @@ Full representation of a saved payment token.
|
||||
"name": {
|
||||
"full_name": "full_name6"
|
||||
},
|
||||
"email_address": "email_address2",
|
||||
"phone_number": {
|
||||
"country_code": "country_code2",
|
||||
"national_number": "national_number6"
|
||||
@@ -93,7 +95,7 @@ Full representation of a saved payment token.
|
||||
"name": "name6",
|
||||
"last_digits": "last_digits0",
|
||||
"type": "UNKNOWN",
|
||||
"brand": "RUPAY",
|
||||
"brand": "CB_NATIONALE",
|
||||
"billing_address": {
|
||||
"address_line_1": "address_line_12",
|
||||
"address_line_2": "address_line_28",
|
||||
|
||||
@@ -12,7 +12,7 @@ The status of the payment token.
|
||||
| Name | Description |
|
||||
| --- | --- |
|
||||
| `CREATED` | A setup token is initialized with minimal information, more data must be added to the setup-token to be vaulted |
|
||||
| `PAYER_ACTION_REQUIRED` | A contingecy on payer approval is required before the payment method can be saved. |
|
||||
| `PAYER_ACTION_REQUIRED` | A contingency on payer approval is required before the payment method can be saved. |
|
||||
| `APPROVED` | Setup token is ready to be vaulted. If a buyer approval contigency was returned, it is has been approved. |
|
||||
| `VAULTED` | The payment token has been vaulted. |
|
||||
| `TOKENIZED` | A vaulted payment method token has been tokenized for short term (one time) use. |
|
||||
|
||||
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user