> ## Documentation Index > Fetch the complete documentation index at: https://docs.paypal.ai/llms.txt > Use this file to discover all available pages before exploring further. # Add tracking information for an Order. > Adds tracking information for an Order. ## OpenAPI ````yaml /api-reference/openapi-orders.json post /v2/checkout/orders/{id}/track openapi: 3.0.4 info: title: Orders description: >- An order represents a payment between two or more parties. Use the Orders API to create, update, retrieve, authorize, and capture orders. version: '2.32' servers: - url: https://api-m.paypal.com description: Server for https scheme. security: [] tags: - name: externalcallback description: >- PayPal will use the callback url defined in the create order request to send merchants shipping address and shipping options data while the buyer is in the PayPal checkout. - name: orders description: >- Use the `/orders` resource to create, update, retrieve, authorize, capture and track orders. - name: trackers description: >- Use the `/trackers` resource to update and retrieve tracking information for PayPal orders. externalDocs: url: ../doc/USERGUIDE.md paths: /v2/checkout/orders/{id}/track: post: tags: - orders summary: Add tracking information for an Order. description: Adds tracking information for an Order. operationId: orders.track.create parameters: - name: id description: >- The ID of the order that the tracking information is associated with. in: path required: true schema: type: string minLength: 1 maxLength: 36 pattern: ^[A-Z0-9]+$ examples: orders_track_create_complete_request: summary: Add Tracking to Order - Carrier Information and Items Breakdown description: Adds tracking information for a PayPal order. value: 5O190127TN364715T orders_track_create_idempotent_complete_request: summary: Add Tracking to Order - Idempotent Response description: >- Adds tracking information for a PayPal Order with the same capture id & tracking number. Idempotency for trackers is based on the capture_id and tracking_number combination sent in the request body. value: 5O190127TN364715T track_create_422_unprocessable_entity_invalid_capture_status: summary: >- Add Tracking to Order - 422 Unprocessable Entity Error - Invalid Capture Status. description: >- This code sample attempts to add tracking information for a PayPal order but the request fails as capture status is invalid. value: 5O190127TN364715T - $ref: '#/components/parameters/authorization' - $ref: '#/components/parameters/paypal_auth_assertion' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/order_tracker_request' examples: orders_track_create_complete_request: summary: >- Add Tracking to Order - Carrier Information and Items Breakdown description: Adds tracking information for a PayPal order. value: capture_id: 8MC585209K746392H tracking_number: '443844607820' notify_payer: false items: - name: T-Shirt sku: sku02 quantity: '1' upc: type: UPC-A code: '012345678901' image_url: https://www.example.com/example.jpg url: https://www.example.com/example orders_track_create_idempotent_complete_request: summary: Add Tracking to Order - Idempotent Response description: >- Adds tracking information for a PayPal Order with the same capture id & tracking number. Idempotency for trackers is based on the capture_id and tracking_number combination sent in the request body. value: capture_id: 8MC585209K746392H tracking_number: '443844607820' notify_payer: false items: - name: T-Shirt sku: sku01 quantity: '1' upc: type: UPC-A code: '012345678901' image_url: https://www.example.com/example.jpg url: https://www.example.com/example track_create_422_unprocessable_entity_invalid_capture_status: summary: >- Add Tracking to Order - 422 Unprocessable Entity Error - Invalid Capture Status. description: >- This code sample attempts to add tracking information for a PayPal order but the request fails as capture status is invalid. value: capture_id: 8MC585209K746392H tracking_number: '443844607820' responses: '200': description: >- A successful response to an idempotent request returns the HTTP `200 OK` status code with a JSON response body that shows tracker details. content: application/json: schema: $ref: '#/components/schemas/order' examples: orders_track_create_idempotent_complete_request: summary: Add Tracking to Order - Idempotent Response description: >- Adds tracking information for a PayPal Order with the same capture id & tracking number. Idempotency for trackers is based on the capture_id and tracking_number combination sent in the request body. value: id: 5O190127TN364715T purchase_units: - reference_id: d9f80740-38f0-11e8-b467-0ed5f89f718b items: - name: Air Jordan Shoe sku: sku01 quantity: '1' unit_amount: currency_code: USD value: '50.00' - name: T-Shirt sku: sku02 quantity: '1' unit_amount: currency_code: USD value: '50.00' shipping: trackers: - id: 8MC585209K746392H-443844607820 links: - href: >- https://api-m.paypal.com/v2/checkout/orders/5O190127TN364715T rel: up method: GET - href: >- https://api-m.paypal.com/v2/checkout/orders/5O190127TN364715T/trackers/8MC585209K746392H-443844607820 rel: edit method: PATCH create_time: '2022-08-12T21:20:49Z' update_time: '2022-08-12T21:20:49Z' payments: captures: - id: 8MC585209K746392H status: COMPLETED amount: currency_code: USD value: '100.00' seller_protection: status: NOT_ELIGIBLE final_capture: true seller_receivable_breakdown: gross_amount: currency_code: USD value: '100.00' paypal_fee: currency_code: USD value: '3.00' net_amount: currency_code: USD value: '97.00' create_time: '2018-04-01T21:20:49Z' update_time: '2018-04-01T21:20:49Z' links: - href: >- https://api-m.paypal.com/v2/payments/captures/8MC585209K746392H rel: self method: GET - href: >- https://api-m.paypal.com/v2/payments/captures/8MC585209K746392H/refund rel: refund method: POST links: - href: >- https://api-m.paypal.com/v2/checkout/orders/5O190127TN364715T rel: self method: GET '201': description: >- A successful response to a non-idempotent request returns the HTTP `201 Created` status code with a JSON response body that shows tracker details. If a duplicate response is retried, returns the HTTP `200 OK` status code. content: application/json: schema: $ref: '#/components/schemas/order' examples: orders_track_create_complete_request: summary: >- Add Tracking to Order - Carrier Information and Items Breakdown description: Adds tracking information for a PayPal order. value: id: 5O190127TN364715T purchase_units: - reference_id: d9f80740-38f0-11e8-b467-0ed5f89f718b items: - name: Air Jordan Shoe sku: sku01 quantity: '1' unit_amount: currency_code: USD value: '50.00' - name: T-Shirt sku: sku02 quantity: '1' unit_amount: currency_code: USD value: '50.00' shipping: trackers: - id: 8MC585209K746392H-443844607820 links: - href: >- https://api-m.paypal.com/v2/checkout/orders/5O190127TN364715T rel: up method: GET - href: >- https://api-m.paypal.com/v2/checkout/orders/5O190127TN364715T/trackers/8MC585209K746392H-443844607820 rel: edit method: PATCH create_time: '2022-08-12T21:20:49Z' update_time: '2022-08-12T21:20:49Z' payments: captures: - id: 8MC585209K746392H status: COMPLETED amount: currency_code: USD value: '100.00' seller_protection: status: NOT_ELIGIBLE final_capture: true seller_receivable_breakdown: gross_amount: currency_code: USD value: '100.00' paypal_fee: currency_code: USD value: '3.00' net_amount: currency_code: USD value: '97.00' create_time: '2018-04-01T21:20:49Z' update_time: '2018-04-01T21:20:49Z' links: - href: >- https://api-m.paypal.com/v2/payments/captures/8MC585209K746392H rel: self method: GET - href: >- https://api-m.paypal.com/v2/payments/captures/8MC585209K746392H/refund rel: refund method: POST links: - href: >- https://api-m.paypal.com/v2/checkout/orders/5O190127TN364715T rel: self method: GET '400': description: >- Request is not well-formed, syntactically incorrect, or violates schema. content: application/json: schema: $ref: '#/components/schemas/error' examples: track_create_400_missing_parameter: summary: >- Add Tracking to Order - 400 Bad Request - Missing Required Parameter description: >- This code sample attempts to add tracking information for a PayPal order but required parameter capture id is not passed. value: name: INVALID_REQUEST message: >- Request is not well-formed, syntactically incorrect, or violates schema. debug_id: 360ee42996992 details: - field: /capture_id issue: MISSING_REQUIRED_PARAMETER description: A required field / parameter is missing. location: body links: - href: >- https://developer.paypal.com/api/orders/v2/#error-MISSING_REQUIRED_PARAMETER rel: information_link '401': $ref: '#/components/responses/401_error_response' '403': $ref: '#/components/responses/403_error_response' '404': $ref: '#/components/responses/404_error_response' '422': description: >- The requested action could not be performed, semantically incorrect, or failed business validation. content: application/json: schema: $ref: '#/components/schemas/error' examples: track_create_422_unprocessable_entity_invalid_capture_status: summary: >- Add Tracking to Order - 422 Unprocessable Entity Error - Invalid Capture Status. description: >- This code sample attempts to add tracking information for a PayPal order but the request fails as capture status is invalid. value: name: UNPROCESSABLE_ENTITY message: >- The requested action could not be performed, semantically incorrect, or failed business validation. debug_id: 360ee42996992 details: - issue: CAPTURE_STATUS_NOT_VALID description: >- Invalid capture status. Tracker information can only be added to captures in `COMPLETED` state. links: - href: >- https://developer.paypal.com/docs/api/orders/v2/#error-CAPTURE_STATUS_NOT_VALID rel: information_link method: GET '500': $ref: '#/components/responses/500_error_response' default: $ref: '#/components/responses/default_response' security: - Oauth2: - https://uri.paypal.com/services/payments/payment components: parameters: authorization: name: Authorization in: header description: Holds authorization information for external API calls. required: false schema: $ref: '#/components/schemas/standard_header_schema' examples: bearer: summary: Bearer authorization. description: >- An authorization header with information for the Bearer authorization scheme. The authorization parameter value is randomized for this example. value: >- Bearer A21AAGHr9qtiRRXH4oYcQokQgV99rGqEIfgrr8xHCclP0OzmD9KVgg5ppIIg1jzJgQkV4wd02svIvBJyg6cLFJjFow_SjBhxQ paypal_auth_assertion: name: PayPal-Auth-Assertion in: header description: >- Header for an API client-provided JWT assertion that identifies the merchant. Establishing the consent to act-on-behalf of a merchant is a prerequisite for using this header. required: false schema: description: >- Header for an API client-provided JWT assertion that identifies the merchant. Establishing the consent to act-on-behalf of a merchant is a prerequisite for using this header. type: string minLength: 1 maxLength: 10000 pattern: ^.*$ examples: auth_assertion: summary: An auth assertion. description: A paypal-auth-assertion header with a randomized value. value: eyJhbGciOiJub25lIn0.eyJlbWFpbCI6Im15QGVtYWlsLmNvbSJ9 schemas: order_tracker_request: title: tracker_request description: The tracking details of an order. type: object allOf: - $ref: '#/components/schemas/shipment_tracker' - type: object title: tracker_request description: The tracking details of an order. required: - capture_id properties: capture_id: description: The PayPal capture ID. type: string minLength: 1 maxLength: 50 pattern: ^[a-zA-Z0-9]*$ notify_payer: description: >- If true, PayPal will send an email notification to the payer of the PayPal transaction. The email contains the tracking details provided through the Orders tracking API request. Independent of any value passed for `notify_payer`, the payer may receive tracking notifications within the PayPal app, based on the user's notification preferences. type: boolean default: false items: description: An array of details of items in the shipment. type: array minItems: 0 maxItems: 32767 items: allOf: - $ref: '#/components/schemas/tracker_item' - title: tracker_item description: Items in a shipment. order: title: Order description: The order details. type: object allOf: - allOf: - $ref: '#/components/schemas/activity_timestamps' - title: activity_timestamps - type: object title: Order description: The order details. properties: id: description: The ID of the order. type: string minLength: 0 maxLength: 2147483647 pattern: ^[\S\s]*$ readOnly: true payment_source: allOf: - $ref: '#/components/schemas/payment_source_response' intent: allOf: - $ref: '#/components/schemas/checkout_payment_intent' payer: allOf: - $ref: '#/components/schemas/payer' - description: >- 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`. DEPRECATED
SeeSince Version
payment_source.paypal2.9
deprecated: true purchase_units: description: >- 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. type: array minItems: 1 maxItems: 10 items: allOf: - $ref: '#/components/schemas/purchase_unit' - title: purchase_unit description: >- A purchase unit. Establishes a contract between a customer and merchant. status: allOf: - $ref: '#/components/schemas/order_status' - readOnly: true links: description: >- 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. type: array minItems: 0 maxItems: 32767 readOnly: true items: allOf: - $ref: '#/components/schemas/link_description-2' - title: link_description description: >- A request-related [HATEOAS link](/api/rest/responses/#hateoas-links). To complete payer approval, use the `approve` link with the `GET` method. error: title: Error description: The error details. type: object required: - debug_id - message - name properties: name: description: The human-readable, unique name of the error. type: string minLength: 0 maxLength: 2147483647 pattern: ^[\S\s]*$ message: description: The message that describes the error. type: string minLength: 0 maxLength: 2147483647 pattern: ^[\S\s]*$ debug_id: description: The PayPal internal ID. Used for correlation purposes. type: string minLength: 0 maxLength: 2147483647 pattern: ^[\S\s]*$ details: description: An array of additional details about the error. type: array minItems: 0 maxItems: 32767 items: allOf: - $ref: '#/components/schemas/error_details' - title: error_details links: description: >- An array of request-related [HATEOAS links](/api/rest/responses/#hateoas-links). type: array minItems: 0 maxItems: 32767 readOnly: true items: allOf: - $ref: '#/components/schemas/link_description' - title: link_description readOnly: true standard_header_schema: title: Schema Object for standard headers description: >- Standard headers are generally less restrictive in structure due to historical precedent across browsers, etc. This is a common schema for use in defining most standard headers. type: string minLength: 1 maxLength: 16000 pattern: ^.*$ shipment_tracker: title: tracker description: The tracking information for a shipment. type: object required: - tracking_number - carrier properties: tracking_number: description: >- The tracking number for the shipment. This property supports Unicode. type: string minLength: 1 maxLength: 64 pattern: ^[\S\s]*$ carrier: $ref: '#/components/schemas/shipment_carrier' carrier_name_other: description: >- The name of the carrier for the shipment. Provide this value only if the carrier parameter is OTHER. This property supports Unicode. type: string minLength: 1 maxLength: 64 pattern: ^[\S\s]*$ tracker_item: title: tracker_item description: The details of the items in the shipment. type: object properties: name: description: The item name or title. type: string minLength: 1 maxLength: 127 pattern: ^[\S\s]*$ quantity: description: The item quantity. Must be a whole number. type: string minLength: 1 maxLength: 10 pattern: ^[1-9][0-9]{0,9}$ sku: description: >- The stock keeping unit (SKU) for the item. This can contain unicode characters. type: string minLength: 1 maxLength: 127 pattern: ^[\S\s]*$ url: description: >- The URL to the item being purchased. Visible to buyer and used in buyer experiences. type: string minLength: 1 maxLength: 2048 format: uri image_url: description: >- The URL of the item's image. File type and size restrictions apply. An image that violates these restrictions will not be honored. type: string minLength: 1 maxLength: 2048 format: uri upc: allOf: - $ref: '#/components/schemas/universal_product_code' - description: The Universal Product Code of the item. activity_timestamps: title: activity_timestamps description: >- The date and time stamps that are common to authorized payment, captured payment, and refund transactions. type: object properties: create_time: allOf: - $ref: '#/components/schemas/date_time' - description: >- The date and time when the transaction occurred, in [Internet date and time format](https://tools.ietf.org/html/rfc3339#section-5.6). readOnly: true update_time: allOf: - $ref: '#/components/schemas/date_time' - description: >- The date and time when the transaction was last updated, in [Internet date and time format](https://tools.ietf.org/html/rfc3339#section-5.6). readOnly: true payment_source_response: title: payment_source_response description: The payment source used to fund the payment. type: object properties: card: $ref: '#/components/schemas/card_response' paypal: $ref: '#/components/schemas/paypal_wallet_response' bancontact: $ref: '#/components/schemas/bancontact' blik: $ref: '#/components/schemas/blik' eps: $ref: '#/components/schemas/eps' giropay: $ref: '#/components/schemas/giropay' ideal: $ref: '#/components/schemas/ideal' mybank: $ref: '#/components/schemas/mybank' p24: $ref: '#/components/schemas/p24' sofort: $ref: '#/components/schemas/sofort' trustly: $ref: '#/components/schemas/trustly' apple_pay: $ref: '#/components/schemas/apple_pay' google_pay: $ref: '#/components/schemas/google_pay' venmo: $ref: '#/components/schemas/venmo_wallet_response' crypto: $ref: '#/components/schemas/crypto' checkout_payment_intent: title: checkout_payment_intent description: >- The intent to either capture payment immediately or authorize a payment for an order after order creation. type: string enum: - CAPTURE - AUTHORIZE payer: title: payer description: >- The customer who approves and pays for the order. The customer is also known as the payer. type: object allOf: - $ref: '#/components/schemas/payer_base' - type: object properties: name: allOf: - $ref: '#/components/schemas/name' - description: >- The name of the payer. Supports only the `given_name` and `surname` properties. not: anyOf: - required: - prefix - required: - middle_name - required: - suffix - required: - alternate_full_name - required: - full_name phone: allOf: - $ref: '#/components/schemas/phone_with_type' - description: >- The phone number of the customer. Available only when you enable the **Contact Telephone Number** option in the **Profile & Settings** for the merchant's PayPal account. The `phone.phone_number` supports only `national_number`. birth_date: allOf: - $ref: '#/components/schemas/date_no_time' - description: The birth date of the payer in `YYYY-MM-DD` format. tax_info: allOf: - $ref: '#/components/schemas/tax_info' - description: >- The tax information of the payer. Required only for Brazilian payer's. Both `tax_id` and `tax_id_type` are required. address: allOf: - $ref: '#/components/schemas/address_portable' - description: >- The address of the payer. Supports only the `address_line_1`, `address_line_2`, `admin_area_1`, `admin_area_2`, `postal_code`, and `country_code` properties. Also referred to as the billing address of the customer. not: anyOf: - required: - address_line_3 - required: - admin_area_3 - required: - admin_area_4 - required: - address_details purchase_unit: title: Purchase Unit description: >- The purchase unit details. Used to capture required information for the payment contract. type: object properties: reference_id: description: >- The API caller-provided external ID for the purchase unit. Required for multiple purchase units when you must update the order through `PATCH`. If you omit this value and the order contains only one purchase unit, PayPal sets this value to `default`.
Note: If there are multiple purchase units, reference_id is required for each purchase unit.
type: string minLength: 1 maxLength: 256 pattern: ^[\S\s]*$ amount: $ref: '#/components/schemas/amount_with_breakdown' payee: allOf: - $ref: '#/components/schemas/payee' - description: The merchant who receives payment for this transaction. payment_instruction: $ref: '#/components/schemas/payment_instruction' description: description: The purchase description. type: string minLength: 1 maxLength: 127 pattern: ^[\S\s]*$ custom_id: description: >- The API caller-provided external ID. Used to reconcile API caller-initiated transactions with PayPal transactions. Appears in transaction and settlement reports. type: string minLength: 1 maxLength: 255 pattern: ^[\S\s]*$ invoice_id: description: The API caller-provided external invoice ID for this order. type: string minLength: 1 maxLength: 127 pattern: ^[\S\s]*$ id: description: >- The PayPal-generated ID for the purchase unit. This ID appears in both the payer's transaction history and the emails that the payer receives. In addition, this ID is available in transaction and settlement reports that merchants and API callers can use to reconcile transactions. This ID is only available when an order is saved by calling v2/checkout/orders/id/save. type: string minLength: 1 maxLength: 19 pattern: ^[\S\s]*$ soft_descriptor: description: >- The payment descriptor on account transactions on the customer's credit card statement, that PayPal sends to processors. The maximum length of the soft descriptor information that you can pass in the API field is 22 characters, in the following format:22 - len(PAYPAL * (8)) - len(Descriptor in Payment Receiving Preferences of Merchant account + 1)The PAYPAL prefix uses 8 characters.

The soft descriptor supports the following ASCII characters:For Wallet payments marketplace integrations:
For unbranded payments (Direct Card) marketplace integrations, use a combination of the seller name and phone number. type: string minLength: 1 maxLength: 22 pattern: ^[\S\s]*$ items: description: An array of items that the customer purchases from the merchant. type: array minItems: 0 maxItems: 32767 items: allOf: - $ref: '#/components/schemas/item' - title: item description: An item. shipping: allOf: - $ref: '#/components/schemas/shipping_with_tracking_details' - description: The shipping address and method. supplementary_data: allOf: - $ref: '#/components/schemas/supplementary_data' - description: >- Supplementary data about this payment. Merchants and partners can add Level 2 and 3 data to payments to reduce risk and payment processing costs. For more information about processing payments, see checkout or multiparty checkout. payments: allOf: - $ref: '#/components/schemas/payment_collection' - description: The comprehensive history of payments for the purchase unit. readOnly: true order_status: title: Order Status description: The order status. type: string enum: - CREATED - SAVED - APPROVED - VOIDED - COMPLETED - PAYER_ACTION_REQUIRED link_description-2: title: Link Description description: >- The request-related [HATEOAS link](/api/rest/responses/#hateoas-links) information. type: object required: - href - rel properties: href: description: >- The complete target URL. To make the related call, combine the method with this [URI Template-formatted](https://tools.ietf.org/html/rfc6570) link. For pre-processing, include the `$`, `(`, and `)` characters. The `href` is the key HATEOAS component that links a completed call with a subsequent call. type: string minLength: 0 maxLength: 2147483647 pattern: ^[\S\s]*$ rel: description: >- The [link relation type](https://tools.ietf.org/html/rfc5988#section-4), which serves as an ID for a link that unambiguously describes the semantics of the link. See [Link Relations](https://www.iana.org/assignments/link-relations/link-relations.xhtml). type: string minLength: 0 maxLength: 2147483647 pattern: ^[\S\s]*$ method: description: The HTTP method required to make the related call. type: string enum: - GET - POST - PUT - DELETE - HEAD - CONNECT - OPTIONS - PATCH title: description: The link title. type: string minLength: 0 maxLength: 2147483647 pattern: ^[\S\s]*$ mediaType: title: media_type description: >- The media type, as defined by [RFC 2046](https://www.ietf.org/rfc/rfc2046.txt). Describes the link target. type: string minLength: 0 maxLength: 2147483647 pattern: ^[\S\s]*$ encType: title: enc_type description: The media type in which to submit the request data. type: string minLength: 0 maxLength: 2147483647 pattern: ^[\S\s]*$ default: application/json schema: allOf: - $ref: '#/components/schemas/link_schema-2' - description: The schema that describes the request data. targetSchema: allOf: - $ref: '#/components/schemas/link_schema-2' - title: target_schema description: The schema that describes the link target. error_details: title: Error Details description: The error details. Required for client-side `4XX` errors. type: object required: - issue properties: field: description: >- 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. type: string minLength: 0 maxLength: 2147483647 pattern: ^[\S\s]*$ value: description: The value of the field that caused the error. type: string minLength: 0 maxLength: 2147483647 pattern: ^[\S\s]*$ location: description: >- The location of the field that caused the error. Value is `body`, `path`, or `query`. type: string minLength: 0 maxLength: 2147483647 pattern: ^[\S\s]*$ default: body issue: description: The unique, fine-grained application-level error code. type: string minLength: 0 maxLength: 2147483647 pattern: ^[\S\s]*$ links: description: >- 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. type: array minItems: 1 maxItems: 4 readOnly: true items: allOf: - $ref: '#/components/schemas/link_description' - title: link_description readOnly: true description: description: >- The human-readable description for an issue. The description can change over the lifetime of an API, so clients must not depend on this value. type: string minLength: 0 maxLength: 2147483647 pattern: ^[\S\s]*$ link_description: title: Link Description description: >- The request-related [HATEOAS link](/api/rest/responses/#hateoas-links) information. type: object required: - href - rel properties: href: description: >- The complete target URL. To make the related call, combine the method with this [URI Template-formatted](https://tools.ietf.org/html/rfc6570) link. For pre-processing, include the `$`, `(`, and `)` characters. The `href` is the key HATEOAS component that links a completed call with a subsequent call. type: string minLength: 0 maxLength: 2147483647 pattern: ^[\S\s]*$ rel: description: >- The [link relation type](https://tools.ietf.org/html/rfc5988#section-4), which serves as an ID for a link that unambiguously describes the semantics of the link. See [Link Relations](https://www.iana.org/assignments/link-relations/link-relations.xhtml). type: string minLength: 0 maxLength: 2147483647 pattern: ^[\S\s]*$ method: description: The HTTP method required to make the related call. type: string enum: - GET - POST - PUT - DELETE - HEAD - CONNECT - OPTIONS - PATCH title: description: The link title. type: string minLength: 0 maxLength: 2147483647 pattern: ^[\S\s]*$ mediaType: title: media_type description: >- The media type, as defined by [RFC 2046](https://www.ietf.org/rfc/rfc2046.txt). Describes the link target. type: string minLength: 0 maxLength: 2147483647 pattern: ^[\S\s]*$ encType: title: enc_type description: The media type in which to submit the request data. type: string minLength: 0 maxLength: 2147483647 pattern: ^[\S\s]*$ default: application/json schema: allOf: - $ref: '#/components/schemas/link_schema' - description: The schema that describes the request data. targetSchema: allOf: - $ref: '#/components/schemas/link_schema' - title: target_schema description: The schema that describes the link target. shipment_carrier: title: carrier description: >- The carrier for the shipment. Some carriers have a global version as well as local subsidiaries. The subsidiaries are repeated over many countries and might also have an entry in the global list. Choose the carrier for your country. If the carrier is not available for your country, choose the global version of the carrier. If your carrier name is not in the list, set `carrier` to `OTHER` and set carrier name in `carrier_name_other`. For allowed values, see Carriers. type: string enum: - DPD_RU - BG_BULGARIAN_POST - KR_KOREA_POST - ZA_COURIERIT - FR_EXAPAQ - ARE_EMIRATES_POST - GAC - GEIS - SF_EX - PAGO - MYHERMES - DIAMOND_EUROGISTICS - CORPORATECOURIERS_WEBHOOK - BOND - OMNIPARCEL - SK_POSTA - PUROLATOR - FETCHR_WEBHOOK - THEDELIVERYGROUP - CELLO_SQUARE - TARRIVE - COLLIVERY - MAINFREIGHT - IND_FIRSTFLIGHT - ACSWORLDWIDE - AMSTAN - OKAYPARCEL - ENVIALIA_REFERENCE - SEUR_ES - CONTINENTAL - FDSEXPRESS - AMAZON_FBA_SWISHIP - WYNGS - DHL_ACTIVE_TRACING - ZYLLEM - RUSTON - XPOST - CORREOS_ES - DHL_FR - PAN_ASIA - BRT_IT - SRE_KOREA - SPEEDEE - TNT_UK - VENIPAK - SHREENANDANCOURIER - CROSHOT - NIPOST_NG - EPST_GLBL - NEWGISTICS - POST_SLOVENIA - JERSEY_POST - BOMBINOEXP - WMG - XQ_EXPRESS - FURDECO - LHT_EXPRESS - SOUTH_AFRICAN_POST_OFFICE - SPOTON - DIMERCO - CYPRUS_POST_CYP - ABCUSTOM - IND_DELIVREE - CN_BESTEXPRESS - DX_SFTP - PICKUPP_MYS - FMX - HELLMANN - SHIP_IT_ASIA - KERRY_ECOMMERCE - FRETERAPIDO - PITNEY_BOWES - XPRESSEN_DK - SEUR_SP_API - DELIVERYONTIME - JINSUNG - TRANS_KARGO - SWISHIP_DE - IVOY_WEBHOOK - AIRMEE_WEBHOOK - DHL_BENELUX - FIRSTMILE - FASTWAY_IR - HH_EXP - MYS_MYPOST_ONLINE - TNT_NL - TIPSA - TAQBIN_MY - KGMHUB - INTEXPRESS - OVERSE_EXP - ONECLICK - ROADRUNNER_FREIGHT - GLS_CROTIA - MRW_FTP - BLUEX - DYLT - DPD_IR - SIN_GLBL - TUFFNELLS_REFERENCE - CJPACKET - MILKMAN - ASIGNA - ONEWORLDEXPRESS - ROYAL_MAIL - VIA_EXPRESS - TIGFREIGHT - ZTO_EXPRESS - TWO_GO - IML - INTEL_VALLEY - EFS - UK_UK_MAIL - RAM - ALLIEDEXPRESS - APC_OVERNIGHT - SHIPPIT - TFM - M_XPRESS - HDB_BOX - CLEVY_LINKS - IBEONE - FIEGE_NL - KWE_GLOBAL - CTC_EXPRESS - AMAZON - MORE_LINK - JX - EASY_MAIL - ADUIEPYLE - GB_PANTHER - EXPRESSSALE - SG_DETRACK - TRUNKRS_WEBHOOK - MATDESPATCH - DICOM - MBW - KHM_CAMBODIA_POST - SINOTRANS - BRT_IT_PARCELID - DHL_SUPPLY_CHAIN - DHL_PL - TOPYOU - PALEXPRESS - DHL_SG - CN_WEDO - FULFILLME - DPD_DELISTRACK - UPS_REFERENCE - CARIBOU - LOCUS_WEBHOOK - DSV - P2P_TRC - DIRECTPARCELS - NOVA_POSHTA_INT - FEDEX_POLAND - CN_JCEX - FAR_INTERNATIONAL - IDEXPRESS - GANGBAO - NEWAY - POSTNL_INT_3_S - RPX_ID - DESIGNERTRANSPORT_WEBHOOK - GLS_SLOVEN - PARCELLED_IN - GSI_EXPRESS - CON_WAY - BROUWER_TRANSPORT - CPEX - ISRAEL_POST - DTDC_IN - PTT_POST - XDE_WEBHOOK - TOLOS - GIAO_HANG - GEODIS_ESPACE - MAGYAR_HU - DOORDASH_WEBHOOK - TIKI_ID - CJ_HK_INTERNATIONAL - STAR_TRACK_EXPRESS - HELTHJEM - SFB2C - FREIGHTQUOTE - LANDMARK_GLOBAL_REFERENCE - PARCEL2GO - DELNEXT - RCL - CGS_EXPRESS - HK_POST - SAP_EXPRESS - PARCELPOST_SG - HERMES - IND_SAFEEXPRESS - TOPHATTEREXPRESS - MGLOBAL - AVERITT - LEADER - _2EBOX - SG_SPEEDPOST - DBSCHENKER_SE - ISR_POST_DOMESTIC - BESTWAYPARCEL - ASENDIA_DE - NIGHTLINE_UK - TAQBIN_SG - TCK_EXPRESS - ENDEAVOUR_DELIVERY - NANJINGWOYUAN - HEPPNER_FR - EMPS_CN - FONSEN - PICKRR - APC_OVERNIGHT_CONNUM - STAR_TRACK_NEXT_FLIGHT - DAJIN - UPS_FREIGHT - POSTA_PLUS - CEVA - ANSERX - JS_EXPRESS - PADTF - UPS_MAIL_INNOVATIONS - SYPOST - AMAZON_SHIP_MCF - YUSEN - BRING - SDA_IT - GBA - NEWEGGEXPRESS - SPEEDCOURIERS_GR - FORRUN - PICKUP - ECMS - INTELIPOST - FLASHEXPRESS - CN_STO - SEKO_SFTP - HOME_DELIVERY_SOLUTIONS - DPD_HGRY - KERRYTTC_VN - JOYING_BOX - TOTAL_EXPRESS - ZJS_EXPRESS - STARKEN - DEMANDSHIP - CN_DPEX - AUPOST_CN - LOGISTERS - GOGLOBALPOST - GLS_CZ - PAACK_WEBHOOK - GRAB_WEBHOOK - PARCELPOINT - ICUMULUS - DAIGLOBALTRACK - GLOBAL_IPARCEL - YURTICI_KARGO - CN_PAYPAL_PACKAGE - PARCEL_2_POST - GLS_IT - PIL_LOGISTICS - HEPPNER - GENERAL_OVERNIGHT - HAPPY2POINT - CHITCHATS - SMOOTH - CLE_LOGISTICS - FIEGE - MX_CARGO - ZIINGFINALMILE - DAYTON_FREIGHT - TCS - AEX - HERMES_DE - ROUTIFIC_WEBHOOK - GLOBAVEND - CJ_LOGISTICS - PALLET_NETWORK - RAF_PH - UK_XDP - PAPER_EXPRESS - LA_POSTE_SUIVI - PAQUETEXPRESS - LIEFERY - STRECK_TRANSPORT - PONY_EXPRESS - ALWAYS_EXPRESS - GBS_BROKER - CITYLINK_MY - ALLJOY - YODEL - YODEL_DIR - STONE3PL - PARCELPAL_WEBHOOK - DHL_ECOMERCE_ASA - SIMPLYPOST - KY_EXPRESS - SHENZHEN - US_LASERSHIP - UC_EXPRE - DIDADI - CJ_KR - DBSCHENKER_B2B - MXE - CAE_DELIVERS - PFCEXPRESS - WHISTL - WEPOST - DHL_PARCEL_ES - DDEXPRESS - ARAMEX_AU - BNEED - HK_TGX - LATVIJAS_PASTS - VIAEUROPE - CORREO_UY - CHRONOPOST_FR - J_NET - _6LS - BLR_BELPOST - BIRDSYSTEM - DOBROPOST - WAHANA_ID - WEASHIP - SONICTL - KWT - AFLLOG_FTP - SKYNET_WORLDWIDE - NOVA_POSHTA - SEINO - SZENDEX - BPOST_INT - DBSCHENKER_SV - AO_DEUTSCHLAND - EU_FLEET_SOLUTIONS - PCFCORP - LINKBRIDGE - PRIMAMULTICIPTA - COUREX - ZAJIL_EXPRESS - COLLECTCO - JTEXPRESS - FEDEX_UK - USHIP - PIXSELL - SHIPTOR - CDEK - VNM_VIETTELPOST - CJ_CENTURY - GSO - VIWO - SKYBOX - KERRYTJ - NTLOGISTICS_VN - SDH_SCM - ZINC - DPE_SOUTH_AFRC - CESKA_CZ - ACS_GR - DEALERSEND - JOCOM - CSE - TFORCE_FINALMILE - SHIP_GATE - SHIPTER - NATIONAL_SAMEDAY - YUNEXPRESS - CAINIAO - DMS_MATRIX - DIRECTLOG - ASENDIA_US - _3JMSLOGISTICS - LICCARDI_EXPRESS - SKY_POSTAL - CNWANGTONG - POSTNORD_LOGISTICS_DK - LOGISTIKA - CELERITAS - PRESSIODE - SHREE_MARUTI - LOGISTICSWORLDWIDE_HK - EFEX - LOTTE - LONESTAR - APRISAEXPRESS - BEL_RS - OSM_WORLDWIDE - WESTGATE_GL - FASTRACK - DTD_EXPR - ALFATREX - PROMEDDELIVERY - THABIT_LOGISTICS - HCT_LOGISTICS - CARRY_FLAP - US_OLD_DOMINION - ANICAM_BOX - WANBEXPRESS - AN_POST - DPD_LOCAL - STALLIONEXPRESS - RAIDEREX - SHOPFANS - KYUNGDONG_PARCEL - CHAMPION_LOGISTICS - PICKUPP_SGP - MORNING_EXPRESS - NACEX - THENILE_WEBHOOK - HOLISOL - LBCEXPRESS_FTP - KURASI - USF_REDDAWAY - APG - CN_BOXC - ECOSCOOTING - MAINWAY - PAPERFLY - HOUNDEXPRESS - BOX_BERRY - EP_BOX - PLUS_LOG_UK - FULFILLA - ASE - MAIL_PLUS - XPO_LOGISTICS - WNDIRECT - CLOUDWISH_ASIA - ZELERIS - GIO_EXPRESS - OCS_WORLDWIDE - ARK_LOGISTICS - AQUILINE - PILOT_FREIGHT - QWINTRY - DANSKE_FRAGT - CARRIERS - AIR_CANADA_GLOBAL - PRESIDENT_TRANS - STEPFORWARDFS - SKYNET_UK - PITTOHIO - CORREOS_EXPRESS - RL_US - DESTINY - UK_YODEL - COMET_TECH - DHL_PARCEL_RU - TNT_REFR - SHREE_ANJANI_COURIER - MIKROPAKKET_BE - ETS_EXPRESS - COLIS_PRIVE - CN_YUNDA - AAA_COOPER - ROCKET_PARCEL - _360LION - PANDU - PROFESSIONAL_COURIERS - FLYTEXPRESS - LOGISTICSWORLDWIDE_MY - CORREOS_DE_ESPANA - IMX - FOUR_PX_EXPRESS - XPRESSBEES - PICKUPP_VNM - STARTRACK_EXPRESS - FR_COLISSIMO - NACEX_SPAIN_REFERENCE - DHL_SUPPLY_CHAIN_AU - ESHIPPING - SHREETIRUPATI - HX_EXPRESS - INDOPAKET - CN_17POST - K1_EXPRESS - CJ_GLS - MYS_GDEX - NATIONEX - ANJUN - FARGOOD - SMG_EXPRESS - RZYEXPRESS - SEFL - TNT_CLICK_IT - HDB - HIPSHIPPER - RPXLOGISTICS - KUEHNE - IT_NEXIVE - PTS - SWISS_POST_FTP - FASTRK_SERV - _4_72 - US_YRC - POSTNL_INTL_3S - ELIAN_POST - CUBYN - SAU_SAUDI_POST - ABXEXPRESS_MY - HUAHAN_EXPRESS - ZES_EXPRESS - ZEPTO_EXPRESS - SKYNET_ZA - ZEEK_2_DOOR - BLINKLASTMILE - POSTA_UKR - CHROBINSON - CN_POST56 - COURANT_PLUS - SCUDEX_EXPRESS - SHIPENTEGRA - B_TWO_C_EUROPE - COPE - IND_GATI - CN_WISHPOST - NACEX_ES - TAQBIN_HK - GLOBALTRANZ - HKD - BJSHOMEDELIVERY - OMNIVA - SUTTON - PANTHER_REFERENCE - SFCSERVICE - LTL - PARKNPARCEL - SPRING_GDS - ECEXPRESS - INTERPARCEL_AU - AGILITY - XL_EXPRESS - ADERONLINE - DIRECTCOURIERS - PLANZER - SENDING - NINJAVAN_WB - NATIONWIDE_MY - SENDIT - GB_ARROW - IND_GOJAVAS - KPOST - DHL_FREIGHT - BLUECARE - JINDOUYUN - TRACKON - GB_TUFFNELLS - TRUMPCARD - ETOTAL - SFPLUS_WEBHOOK - SEKOLOGISTICS - HERMES_2MANN_HANDLING - DPD_LOCAL_REF - UDS - ZA_SPECIALISED_FREIGHT - THA_KERRY - PRT_INT_SEUR - BRA_CORREIOS - NZ_NZ_POST - CN_EQUICK - MYS_EMS - GB_NORSK - ESP_MRW - ESP_PACKLINK - KANGAROO_MY - RPX - XDP_UK_REFERENCE - NINJAVAN_MY - ADICIONAL - ROADBULL - YAKIT - MAILAMERICAS - MIKROPAKKET - DYNALOGIC - DHL_ES - DHL_PARCEL_NL - DHL_GLOBAL_MAIL_ASIA - DAWN_WING - GENIKI_GR - HERMESWORLD_UK - ALPHAFAST - BUYLOGIC - EKART - MEX_SENDA - SFC_LOGISTICS - POST_SERBIA - IND_DELHIVERY - DE_DPD_DELISTRACK - RPD2MAN - CN_SF_EXPRESS - YANWEN - MYS_SKYNET - CORREOS_DE_MEXICO - CBL_LOGISTICA - MEX_ESTAFETA - AU_AUSTRIAN_POST - RINCOS - NLD_DHL - RUSSIAN_POST - COURIERS_PLEASE - POSTNORD_LOGISTICS - FEDEX - DPE_EXPRESS - DPD - ADSONE - IDN_JNE - THECOURIERGUY - CNEXPS - PRT_CHRONOPOST - LANDMARK_GLOBAL - IT_DHL_ECOMMERCE - ESP_NACEX - PRT_CTT - BE_KIALA - ASENDIA_UK - GLOBAL_TNT - POSTUR_IS - EPARCEL_KR - INPOST_PACZKOMATY - IT_POSTE_ITALIA - BE_BPOST - PL_POCZTA_POLSKA - MYS_MYS_POST - SG_SG_POST - THA_THAILAND_POST - LEXSHIP - FASTWAY_NZ - DHL_AU - COSTMETICSNOW - PFLOGISTICS - LOOMIS_EXPRESS - GLS_ITALY - LINE - GEL_EXPRESS - HUODULL - NINJAVAN_SG - JANIO - AO_COURIER - BRT_IT_SENDER_REF - SAILPOST - LALAMOVE - NEWZEALAND_COURIERS - ETOMARS - VIRTRANSPORT - WIZMO - PALLETWAYS - I_DIKA - CFL_LOGISTICS - GEMWORLDWIDE - GLOBAL_EXPRESS - LOGISTYX_TRANSGROUP - WESTBANK_COURIER - ARCO_SPEDIZIONI - YDH_EXPRESS - PARCELINKLOGISTICS - CNDEXPRESS - NOX_NIGHT_TIME_EXPRESS - AERONET - LTIANEXP - INTEGRA2_FTP - PARCELONE - NOX_NACHTEXPRESS - CN_CHINA_POST_EMS - CHUKOU1 - GLS_SLOV - ORANGE_DS - JOOM_LOGIS - AUS_STARTRACK - DHL - GB_APC - BONDSCOURIERS - JPN_JAPAN_POST - USPS - WINIT - ARG_OCA - TW_TAIWAN_POST - DMM_NETWORK - TNT - BH_POSTA - SWE_POSTNORD - CA_CANADA_POST - WISELOADS - ASENDIA_HK - NLD_GLS - MEX_REDPACK - JET_SHIP - DE_DHL_EXPRESS - NINJAVAN_THAI - RABEN_GROUP - ESP_ASM - HRV_HRVATSKA - GLOBAL_ESTES - LTU_LIETUVOS - BEL_DHL - AU_AU_POST - SPEEDEXCOURIER - FR_COLIS - ARAMEX - DPEX - MYS_AIRPAK - CUCKOOEXPRESS - DPD_POLAND - NLD_POSTNL - NIM_EXPRESS - QUANTIUM - SENDLE - ESP_REDUR - MATKAHUOLTO - CPACKET - POSTI - HUNTER_EXPRESS - CHOIR_EXP - LEGION_EXPRESS - AUSTRIAN_POST_EXPRESS - GRUPO - POSTA_RO - INTERPARCEL_UK - GLOBAL_ABF - POSTEN_NORGE - XPERT_DELIVERY - DHL_REFR - DHL_HK - SKYNET_UAE - GOJEK - YODEL_INTNL - JANCO - YTO - WISE_EXPRESS - JTEXPRESS_VN - FEDEX_INTL_MLSERV - VAMOX - AMS_GRP - DHL_JP - HRPARCEL - GESWL - BLUESTAR - CDEK_TR - DESCARTES - DELTEC_UK - DTDC_EXPRESS - TOURLINE - BH_WORLDWIDE - OCS - YINGNUO_LOGISTICS - UPS - TOLL - PRT_SEUR - DTDC_AU - THA_DYNAMIC_LOGISTICS - UBI_LOGISTICS - FEDEX_CROSSBORDER - A1POST - TAZMANIAN_FREIGHT - CJ_INT_MY - SAIA_FREIGHT - SG_QXPRESS - NHANS_SOLUTIONS - DPD_FR - COORDINADORA - ANDREANI - DOORA - INTERPARCEL_NZ - PHL_JAMEXPRESS - BEL_BELGIUM_POST - US_APC - IDN_POS - FR_MONDIAL - DE_DHL - HK_RPX - DHL_PIECEID - VNPOST_EMS - RRDONNELLEY - DPD_DE - DELCART_IN - IMEXGLOBALSOLUTIONS - ACOMMERCE - EURODIS - CANPAR - GLS - IND_ECOM - ESP_ENVIALIA - DHL_UK - SMSA_EXPRESS - TNT_FR - DEX_I - BUDBEE_WEBHOOK - COPA_COURIER - VNM_VIETNAM_POST - DPD_HK - TOLL_NZ - ECHO - FEDEX_FR - BORDEREXPRESS - MAILPLUS_JPN - TNT_UK_REFR - KEC - DPD_RO - TNT_JP - TH_CJ - EC_CN - FASTWAY_UK - FASTWAY_US - GLS_DE - GLS_ES - GLS_FR - MONDIAL_BE - SGT_IT - TNT_CN - TNT_DE - TNT_ES - TNT_PL - PARCELFORCE - SWISS_POST - TOLL_IPEC - AIR_21 - AIRSPEED - BERT - BLUEDART - COLLECTPLUS - COURIERPLUS - COURIER_POST - DHL_GLOBAL_MAIL - DPD_UK - DELTEC_DE - DEUTSCHE_DE - DOTZOT - ELTA_GR - EMS_CN - ECARGO - ENSENDA - FERCAM_IT - FASTWAY_ZA - FASTWAY_AU - FIRST_LOGISITCS - GEODIS - GLOBEGISTICS - GREYHOUND - JETSHIP_MY - LION_PARCEL - AEROFLASH - ONTRAC - SAGAWA - SIODEMKA - STARTRACK - TNT_AU - TNT_IT - TRANSMISSION - YAMATO - DHL_IT - DHL_AT - LOGISTICSWORLDWIDE_KR - GLS_SPAIN - AMAZON_UK_API - DPD_FR_REFERENCE - DHLPARCEL_UK - MEGASAVE - QUALITYPOST - IDS_LOGISTICS - JOYINGBOX - PANTHER_ORDER_NUMBER - WATKINS_SHEPARD - FASTTRACK - UP_EXPRESS - ELOGISTICA - ECOURIER - CJ_PHILIPPINES - SPEEDEX - ORANGECONNEX - TECOR - SAEE - GLS_ITALY_FTP - DELIVERE - YYCOM - ADICIONAL_PT - DKSH - NIPPON_EXPRESS_FTP - GOLS - FUJEXP - QTRACK - OMLOGISTICS_API - GDPHARM - MISUMI_CN - AIR_CANADA - CITY56_WEBHOOK - SAGAWA_API - KEDAEX - PGEON_API - WEWORLDEXPRESS - JT_LOGISTICS - TRUSK - VIAXPRESS - DHL_SUPPLYCHAIN_ID - ZUELLIGPHARMA_SFTP - MEEST - TOLL_PRIORITY - MOTHERSHIP_API - CAPITAL - EUROPAKET_API - HFD - TOURLINE_REFERENCE - GIO_ECOURIER - CN_LOGISTICS - PANDION - BPOST_API - PASSPORTSHIPPING - PAKAJO - DACHSER - YUSEN_SFTP - SHYPLITE - XYY - MWD - FAXECARGO - MAZET - FIRST_LOGISTICS_API - SPRINT_PACK - HERMES_DE_FTP - CONCISE - KERRY_EXPRESS_TW_API - EWE - FASTDESPATCH - ABCUSTOM_SFTP - CHAZKI - SHIPPIE - GEODIS_API - NAQEL_EXPRESS - PAPA_WEBHOOK - FORWARDAIR - DIALOGO_LOGISTICA_API - LALAMOVE_API - TOMYDOOR - KRONOS_WEBHOOK - JTCARGO - T_CAT - CONCISE_WEBHOOK - TELEPORT_WEBHOOK - CUSTOMCO_API - SPX_TH - BOLLORE_LOGISTICS - CLICKLINK_SFTP - M3LOGISTICS - VNPOST_API - AXLEHIRE_FTP - SHADOWFAX - MYHERMES_UK_API - DAIICHI - MENSAJEROSURBANOS_API - POLARSPEED - IDEXPRESS_ID - PAYO - WHISTL_SFTP - INTEX_DE - TRANS2U - PRODUCTCAREGROUP_SFTP - BIGSMART - EXPEDITORS_API_REF - AITWORLDWIDE_API - WORLDCOURIER - QUIQUP - AGEDISS_SFTP - ANDREANI_API - CRLEXPRESS - SMARTCAT - CROSSFLIGHT - PROCARRIER - DHL_REFERENCE_API - SEINO_API - WSPEXPRESS - KRONOS - TOTAL_EXPRESS_API - PARCLL - XPEDIGO - STAR_TRACK_WEBHOOK - GPOST - UCS - DMFGROUP - COORDINADORA_API - MARKEN - NTL - REDJEPAKKETJE - ALLIED_EXPRESS_FTP - MONDIALRELAY_ES - NAEKO_FTP - MHI - SHIPPIFY - MALCA_AMIT_API - JTEXPRESS_SG_API - DACHSER_WEB - FLIGHTLG - CAGO - COM1EXPRESS - TONAMI_FTP - PACKFLEET - PUROLATOR_INTERNATIONAL - WINESHIPPING_WEBHOOK - DHL_ES_SFTP - PCHOME_API - CESKAPOSTA_API - GORUSH - HOMERUNNER - AMAZON_ORDER - EFWNOW_API - CBL_LOGISTICA_API - NIMBUSPOST - LOGWIN_LOGISTICS - NOWLOG_API - DPD_NL - GODEPENDABLE - ESDEX - LOGISYSTEMS_SFTP - EXPEDITORS - SNTGLOBAL_API - SHIPX - QINTL_API - PACKS - POSTNL_INTERNATIONAL - AMAZON_EMAIL_PUSH - DHL_API - SPX - AXLEHIRE - ICSCOURIER - DIALOGO_LOGISTICA - SHUNBANG_EXPRESS - TCS_API - SF_EXPRESS_CN - PACKETA - SIC_TELIWAY - MONDIALRELAY_FR - INTIME_FTP - JD_EXPRESS - FASTBOX - PATHEON - INDIA_POST - TIPSA_REF - ECOFREIGHT - VOX - DIRECTFREIGHT_AU_REF - BESTTRANSPORT_SFTP - AUSTRALIA_POST_API - FRAGILEPAK_SFTP - FLIPXP - VALUE_WEBHOOK - DAESHIN - SHERPA - MWD_API - SMARTKARGO - DNJ_EXPRESS - GOPEOPLE - MYSENDLE_API - ARAMEX_API - PIDGE - THAIPARCELS - PANTHER_REFERENCE_API - POSTAPLUS - BUFFALO - U_ENVIOS - ELITE_CO - ROCHE_INTERNAL_SFTP - DBSCHENKER_ICELAND - TNT_FR_REFERENCE - NEWGISTICSAPI - GLOVO - GWLOGIS_API - SPREETAIL_API - MOOVA - PLYCONGROUP - USPS_WEBHOOK - REIMAGINEDELIVERY - EDF_FTP - DAO365 - BIOCAIR_FTP - RANSA_WEBHOOK - SHIPXPRES - COURANT_PLUS_API - SHIPA - HOMELOGISTICS - DX - POSTE_ITALIANE_PACCOCELERE - TOLL_WEBHOOK - LCTBR_API - DX_FREIGHT - DHL_SFTP - SHIPROCKET - UBER_WEBHOOK - STATOVERNIGHT - BURD - FASTSHIP - IBVENTURE_WEBHOOK - GATI_KWE_API - CRYOPDP_FTP - HUBBED - TIPSA_API - ARASKARGO - THIJS_NL - ATSHEALTHCARE_REFERENCE - 99MINUTOS - HELLENIC_POST - HSM_GLOBAL - MNX - NMTRANSFER - LOGYSTO - INDIA_POST_INT - AMAZON_FBA_SWISHIP_IN - SRT_TRANSPORT - BOMI - DELIVERR_SFTP - HSDEXPRESS - SIMPLETIRE_WEBHOOK - HUNTER_EXPRESS_SFTP - UPS_API - WOOYOUNG_LOGISTICS_SFTP - PHSE_API - WISH_EMAIL_PUSH - NORTHLINE - MEDAFRICA - DPD_AT_SFTP - ANTERAJA - DHL_GLOBAL_FORWARDING_API - LBCEXPRESS_API - SIMSGLOBAL - CDLDELIVERS - TYP - TESTING_COURIER_WEBHOOK - PANDAGO_API - ROYAL_MAIL_FTP - THUNDEREXPRESS - SECRETLAB_WEBHOOK - SETEL - JD_WORLDWIDE - DPD_RU_API - ARGENTS_WEBHOOK - POSTONE - TUSKLOGISTICS - RHENUS_UK_API - TAQBIN_SG_API - INNTRALOG_SFTP - DAYROSS - CORREOSEXPRESS_API - INTERNATIONAL_SEUR_API - YODEL_API - HEROEXPRESS - DHL_SUPPLYCHAIN_IN - URGENT_CARGUS - FRONTDOORCORP - JTEXPRESS_PH - PARCELSTARS_WEBHOOK - DPD_SK_SFTP - MOVIANTO - OZEPARTS_SHIPPING - KARGOMKOLAY - TRUNKRS - OMNIRPS_WEBHOOK - CHILEXPRESS - TESTING_COURIER - JNE_API - BJSHOMEDELIVERY_FTP - DEXPRESS_WEBHOOK - USPS_API - TRANSVIRTUAL - SOLISTICA_API - CHIENVENTURE_WEBHOOK - DPD_UK_SFTP - INPOST_UK - JAVIT - ZTO_DOMESTIC - DHL_GT_API - CEVA_TRACKING - KOMON_EXPRESS - EASTWESTCOURIER_FTP - DANNIAO - SPECTRAN - DELIVER_IT - RELAISCOLIS - GLS_SPAIN_API - POSTPLUS - AIRTERRA - GIO_ECOURIER_API - DPD_CH_SFTP - FEDEX_API - INTERSMARTTRANS - HERMES_UK_SFTP - EXELOT_FTP - DHL_PA_API - VIRTRANSPORT_SFTP - WORLDNET - INSTABOX_WEBHOOK - KNG - FLASHEXPRESS_WEBHOOK - MAGYAR_POSTA_API - WESHIP_API - OHI_WEBHOOK - MUDITA - BLUEDART_API - T_CAT_API - ADS - HERMES_IT - FITZMARK_API - POSTI_API - SMSA_EXPRESS_WEBHOOK - TAMERGROUP_WEBHOOK - LIVRAPIDE - NIPPON_EXPRESS - BETTERTRUCKS - FAN - PB_USPSFLATS_FTP - PARCELRIGHT - ITHINKLOGISTICS - KERRY_EXPRESS_TH_WEBHOOK - ECOUTIER - SHOWL - BRT_IT_API - RIXONHK_API - DBSCHENKER_API - ILYANGLOGIS - MAIL_BOX_ETC - WESHIP - DHL_GLOBAL_MAIL_API - ACTIVOS24_API - ATSHEALTHCARE - LUWJISTIK - GW_WORLD - FAIRSENDEN_API - SERVIP_WEBHOOK - SWISHIP - TANET - HOTSIN_CARGO - DIREX - HUANTONG - IMILE_API - AUEXPRESS - NYTLOGISTICS - DSV_REFERENCE - NOVOFARMA_WEBHOOK - AITWORLDWIDE_SFTP - SHOPOLIVE - FNF_ZA - DHL_ECOMMERCE_GC - FETCHR - STARLINKS_API - YYEXPRESS - SERVIENTREGA - HANJIN - SPANISH_SEUR_FTP - DX_B2B_CONNUM - HELTHJEM_API - INEXPOST - A2B_BA - RHENUS_GROUP - SBERLOGISTICS_RU - MALCA_AMIT - PPL - OSM_WORLDWIDE_SFTP - ACILOGISTIX - OPTIMACOURIER - NOVA_POSHTA_API - LOGGI - YIFAN - MYDYNALOGIC - MORNINGLOBAL - CONCISE_API - FXTRAN - DELIVERYOURPARCEL_ZA - UPARCEL - MOBI_BR - LOGINEXT_WEBHOOK - EMS - SPEEDY - ZOOM_RED - NAVLUNGO - CASTLEPARCELS - WEEE - PACKALY - YUNHUIPOST - YOUPARCEL - LEMAN - MOOVIN - URB_IT - MULTIENTREGAPANAMA - JUSDASR - DISCOUNTPOST - RHENUS_UK - SWISHIP_JP - GLS_US - SMTL - EMEGA - EXPRESSONE_SV - HEPSIJET - WELIVERY - BRINGER - EASYROUTES - MRW - RPM - DPD_PRT - GLS_ROMANIA - LMPARCEL - GTAGSM - DOMINO - ESHIPPER - TRANSPAK - XINDUS - AOYUE - EASYPARCEL - EXPRESSONE - SENDEO_KARGO - SPEEDAF - ETOWER - GCX - NINJAVAN_VN - ALLEGRO - JUMPPOINT - SHIPGLOBAL_US - KINISI - OAKH - AWEST - BARSAN - ENERGOLOGISTIC - MADROOEX - GOBOLT - SWISS_UNIVERSAL_EXPRESS - IORDIRECT - XMSZM - GLS_HUN - SENDY - BRAUNSEXPRESS - GRANDSLAMEXPRESS - XGS - OTSCHILE - PACK_UP - PARCELSTARS - TEAMEXPRESSLLC - ASYADEXPRESS - TDN - EARLYBIRD - CACESA - PARCELJET - MNG_KARGO - SUPERPACKLINE - SPEEDX - VESYL - SKYKING - DIRMENSAJERIA - NETLOGIXGROUP - ZYOU - JAWAR - AGSYSTEMS - GPS - PTT_KARGO - MAERGO - ARIHANTCOURIER - VTFE - YUNANT - URBIFY - PACK_MAN - LIEFERGRUN - OBIBOX - PAIKEDA - SCOTTY - INTELCOM_CA - SWE - ASENDIA - DPD_AT - RELAY - ATA - SKYEXPRESS_INTERNATIONAL - SURAT_KARGO - SGLINK - FLEETOPTICSINC - SHOPLINE - PIGGYSHIP - LOGOIX - KOLAY_GELSIN - ASSOCIATED_COURIERS - UPS_CHECKER - WINESHIPPING - SPEDISCI - FOURKITES - ETONAS - FINMILE - UNIUNI - RODONAVES - INPOST_IT - TFORCE_FREIGHT - RICHMOM - FRANCO - ECPARCEL - FEDEX_CHINA - GOFO_EXPRESS - SHIPBOB - JERSEYPOST_ATLAS - CORETRAILS - RHENUS_ITALY - JADLOG - JITSU - YANWEN_EXPRESS - DASHLINK - SEINO_SUPER_EXPRESS - FLOSHIP - METROSCG - SENDPARCEL - P2P - CN_EXPRESS - CIRROTRACK - LAND_LOGISTICS - VEHO - MEDLINE - VDTRACK - SINO_SCM - 3PE_EXPRESS - SWIFTX - SFYDEXPRESS - TOPTRANS - OTHER universal_product_code: title: universal_product_code description: The Universal Product Code of the item. type: object required: - code - type properties: type: title: Universal Product Code Type description: The Universal Product Code type. type: string enum: - UPC-A - UPC-B - UPC-C - UPC-D - UPC-E - UPC-2 - UPC-5 code: description: The UPC product code of the item. type: string minLength: 6 maxLength: 17 pattern: ^[0-9]{0,17}$ date_time: description: >- 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.
type: string minLength: 20 maxLength: 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})$ card_response: title: card_response description: >- The payment card to use to fund a payment. Card can be a credit or debit card. type: object properties: name: description: The card holder's name as it appears on the card. type: string minLength: 2 maxLength: 300 pattern: ^[\S\s]*$ last_digits: description: The last digits of the payment card. type: string minLength: 0 maxLength: 2147483647 pattern: ^.*[0-9]{2,}.*$ readOnly: true brand: allOf: - $ref: '#/components/schemas/card_brand' - description: The card brand or network. Typically used in the response. readOnly: true available_networks: description: Array of brands or networks associated with the card. type: array minItems: 1 maxItems: 256 readOnly: true items: allOf: - $ref: '#/components/schemas/card_brand' - title: card_brand type: allOf: - $ref: '#/components/schemas/card_type' - description: The payment card type. authentication_result: $ref: '#/components/schemas/authentication_response' attributes: $ref: '#/components/schemas/card_attributes_response' from_request: $ref: '#/components/schemas/card_from_request' expiry: allOf: - $ref: '#/components/schemas/date_year_month' - description: >- The card expiration year and month, in [Internet date format](https://tools.ietf.org/html/rfc3339#section-5.6). bin_details: allOf: - $ref: '#/components/schemas/bin_details' - description: Bank Identification Number (BIN) details used to fund a payment. stored_credential: $ref: '#/components/schemas/card_stored_credential' paypal_wallet_response: title: paypal_wallet_response description: The PayPal Wallet response. type: object properties: email_address: allOf: - $ref: '#/components/schemas/email' - description: The email address of the PayPal account holder. account_id: allOf: - $ref: '#/components/schemas/account_id-2' - description: The PayPal-assigned ID for the PayPal account holder. readOnly: true account_status: description: >- The account status indicates whether the buyer has verified the financial details associated with their PayPal account. type: string enum: - VERIFIED - UNVERIFIED readOnly: true name: allOf: - $ref: '#/components/schemas/name' - description: >- The name of the PayPal account holder. Supports only the `given_name` and `surname` properties. not: anyOf: - required: - prefix - required: - middle_name - required: - suffix - required: - alternate_full_name - required: - full_name phone_type: $ref: '#/components/schemas/phone_type' phone_number: allOf: - $ref: '#/components/schemas/phone-3' - description: >- The phone number, in its canonical international [E.164 numbering plan format](https://www.itu.int/rec/T-REC-E.164/en). Available only when you enable the **Contact Telephone Number** option in the **Profile & Settings** for the merchant's PayPal account. Supports only the `national_number` property. birth_date: allOf: - $ref: '#/components/schemas/date_no_time' - description: >- The birth date of the PayPal account holder in `YYYY-MM-DD` format. business_name: description: >- The business name of the PayPal account holder (populated for business accounts only) type: string minLength: 0 maxLength: 300 pattern: ^.*$ tax_info: allOf: - $ref: '#/components/schemas/tax_info' - description: >- The tax information of the PayPal account holder. Required only for Brazilian PayPal account holder's. Both `tax_id` and `tax_id_type` are required. address: allOf: - $ref: '#/components/schemas/address_portable' - description: >- The address of the PayPal account holder. Supports only the `address_line_1`, `address_line_2`, `admin_area_1`, `admin_area_2`, `postal_code`, and `country_code` properties. Also referred to as the billing address of the customer. not: anyOf: - required: - address_line_3 - required: - admin_area_3 - required: - admin_area_4 - required: - address_details attributes: $ref: '#/components/schemas/paypal_wallet_attributes_response' stored_credential: $ref: '#/components/schemas/paypal_wallet_stored_credential' experience_status: description: >- This field indicates the status of PayPal's Checkout experience throughout the order lifecycle. The values reflect the current stage of the checkout process. type: string enum: - NOT_STARTED - IN_PROGRESS - CANCELED - APPROVED readOnly: true bancontact: title: bancontact description: Information used to pay Bancontact. type: object properties: name: allOf: - $ref: '#/components/schemas/full_name' - title: name description: >- The name of the account holder associated with this payment method. country_code: allOf: - $ref: '#/components/schemas/country_code-2' - description: The two-character ISO 3166-1 country code. bic: allOf: - $ref: '#/components/schemas/bic' - description: The bank identification code (BIC). iban_last_chars: $ref: '#/components/schemas/iban_last_chars' card_last_digits: description: The last digits of the card used to fund the Bancontact payment. type: string minLength: 4 maxLength: 4 pattern: ^[0-9]{4}$ blik: title: blik description: Information used to pay using BLIK. type: object properties: name: allOf: - $ref: '#/components/schemas/full_name' - title: name description: >- The name of the account holder associated with this payment method. country_code: allOf: - $ref: '#/components/schemas/country_code-2' - description: The two-character ISO 3166-1 country code. email: allOf: - $ref: '#/components/schemas/email_address' - description: >- The email address of the account holder associated with this payment method. one_click: allOf: - $ref: '#/components/schemas/blik_one_click_response' - description: The one-click integration flow object. eps: title: eps description: Information used to pay using eps. type: object properties: name: allOf: - $ref: '#/components/schemas/full_name' - title: name description: >- The name of the account holder associated with this payment method. country_code: allOf: - $ref: '#/components/schemas/country_code-2' - description: The two-character ISO 3166-1 country code. bic: allOf: - $ref: '#/components/schemas/bic' - description: The bank identification code (BIC). giropay: title: giropay description: Information needed to pay using giropay. type: object properties: name: allOf: - $ref: '#/components/schemas/full_name' - title: name description: >- The name of the account holder associated with this payment method. country_code: allOf: - $ref: '#/components/schemas/country_code-2' - description: The two-character ISO 3166-1 country code. bic: allOf: - $ref: '#/components/schemas/bic' - description: The bank identification code (BIC). ideal: title: ideal description: Information used to pay using iDEAL. type: object properties: name: allOf: - $ref: '#/components/schemas/full_name' - title: name description: >- The name of the account holder associated with this payment method. country_code: allOf: - $ref: '#/components/schemas/country_code-2' - description: The two-character ISO 3166-1 country code. bic: allOf: - $ref: '#/components/schemas/bic' - description: The bank identification code (BIC). iban_last_chars: $ref: '#/components/schemas/iban_last_chars' mybank: title: mybank description: Information used to pay using MyBank. type: object properties: name: allOf: - $ref: '#/components/schemas/full_name' - title: name description: >- The name of the account holder associated with this payment method. country_code: allOf: - $ref: '#/components/schemas/country_code-2' - description: The two-character ISO 3166-1 country code. bic: allOf: - $ref: '#/components/schemas/bic' - description: The bank identification code (BIC). iban_last_chars: $ref: '#/components/schemas/iban_last_chars' p24: title: p24 description: Information used to pay using P24(Przelewy24). type: object properties: name: allOf: - $ref: '#/components/schemas/full_name' - title: name description: >- The name of the account holder associated with this payment method. email: allOf: - $ref: '#/components/schemas/email_address' - description: >- The email address of the account holder associated with this payment method. country_code: allOf: - $ref: '#/components/schemas/country_code-2' - title: name description: The two-character ISO 3166-1 country code. payment_descriptor: description: P24 generated payment description. type: string minLength: 1 maxLength: 2000 pattern: ^[\S\s]*$ method_id: description: >- Numeric identifier of the payment scheme or bank used for the payment. type: string minLength: 1 maxLength: 300 pattern: ^[\S\s]*$ method_description: description: Friendly name of the payment scheme or bank used for the payment. type: string minLength: 1 maxLength: 2000 pattern: ^[\S\s]*$ sofort: title: sofort description: Information used to pay using Sofort. type: object properties: name: allOf: - $ref: '#/components/schemas/full_name' - title: name description: >- The name of the account holder associated with this payment method. country_code: allOf: - $ref: '#/components/schemas/country_code-2' - description: The two-character ISO 3166-1 country code. bic: allOf: - $ref: '#/components/schemas/bic' - description: The bank identification code (BIC). iban_last_chars: $ref: '#/components/schemas/iban_last_chars' trustly: title: trustly description: Information needed to pay using Trustly. type: object properties: name: allOf: - $ref: '#/components/schemas/full_name' - title: name description: >- The name of the account holder associated with this payment method. country_code: allOf: - $ref: '#/components/schemas/country_code-2' - description: The two-character ISO 3166-1 country code. email: allOf: - $ref: '#/components/schemas/email_address' - description: >- The email address of the account holder associated with this payment method. bic: allOf: - $ref: '#/components/schemas/bic' - description: The bank identification code (BIC). iban_last_chars: $ref: '#/components/schemas/iban_last_chars' apple_pay: title: apple_pay description: Information needed to pay using ApplePay. type: object properties: id: description: >- ApplePay transaction identifier, this will be the unique identifier for this transaction provided by Apple. The pattern is defined by an external party and supports Unicode. type: string minLength: 1 maxLength: 250 pattern: ^.*$ token: description: >- Encrypted ApplePay token, containing card information. This token would be base64encoded. The pattern is defined by an external party and supports Unicode. type: string minLength: 1 maxLength: 10000 pattern: ^.*$ name: allOf: - $ref: '#/components/schemas/full_name' - description: Name on the wallet. email_address: allOf: - $ref: '#/components/schemas/email_address' - description: >- The email address of the account holder associated with this payment method. phone_number: allOf: - $ref: '#/components/schemas/phone' - description: >- The phone number, in its canonical international [E.164 numbering plan format](https://www.itu.int/rec/T-REC-E.164/en). Supports only the `national_number` property. not: anyOf: - required: - country_code - required: - extension_number card: allOf: - $ref: '#/components/schemas/apple_pay_card_response' - description: The payment card information. attributes: allOf: - $ref: '#/components/schemas/apple_pay_attributes_response' - description: Additional attributes associated with apple pay. stored_credential: $ref: '#/components/schemas/card_stored_credential' google_pay: title: google_pay description: Google Pay Wallet payment data. type: object properties: name: allOf: - $ref: '#/components/schemas/full_name' - description: Name on the account holder associated with Google Pay. email_address: allOf: - $ref: '#/components/schemas/email_address' - description: >- The email address of the account holder associated with Google Pay. phone_number: allOf: - $ref: >- #/components/schemas/phone_with_national_required_and_country_code - description: >- The phone number of account holder, in its canonical international [E.164 numbering plan format](https://www.itu.int/rec/T-REC-E.164/en). Supports only the `national_number` property. card: allOf: - $ref: '#/components/schemas/google_pay_card_response' - description: The Card from Google Pay Wallet used to fund the payment. venmo_wallet_response: title: venmo_wallet_response description: Venmo wallet response. type: object properties: email_address: allOf: - $ref: '#/components/schemas/email' - description: The email address of the payer. account_id: allOf: - $ref: '#/components/schemas/account_id-2' - description: >- This is an immutable system-generated id for a user's Venmo account. readOnly: true user_name: description: The Venmo user name chosen by the user, also know as a Venmo handle. type: string minLength: 1 maxLength: 50 pattern: ^[-a-zA-Z0-9_]*$ name: allOf: - $ref: '#/components/schemas/name' - description: >- The name associated with the Venmo account. Supports only the `given_name` and `surname` properties. not: anyOf: - required: - prefix - required: - middle_name - required: - suffix - required: - alternate_full_name - required: - full_name phone_number: allOf: - $ref: '#/components/schemas/phone-3' - description: >- The phone number associated with the Venmo account, in its canonical international [E.164 numbering plan format](https://www.itu.int/rec/T-REC-E.164/en). Supports only the `national_number` property. address: allOf: - $ref: '#/components/schemas/address_portable' - description: >- The address of the payer. Supports only the `address_line_1`, `address_line_2`, `admin_area_1`, `admin_area_2`, `postal_code`, and `country_code` properties. Also referred to as the billing address of the customer. not: anyOf: - required: - address_line_3 - required: - admin_area_3 - required: - admin_area_4 - required: - address_details return_flow: description: >- Merchant preference on how the buyer can navigate back to merchant website post approving the transaction on the Venmo App. type: string enum: - AUTO - MANUAL default: AUTO readOnly: true attributes: $ref: '#/components/schemas/venmo_wallet_attributes_response' crypto: title: crypto description: Pay With Crypto details response object. type: object properties: country_code: allOf: - $ref: '#/components/schemas/country_code' - description: The two-character ISO 3166-1 purchase country code. name: allOf: - $ref: '#/components/schemas/crypto_account_holder_name' - description: The name of the account holder associated with Crypto wallet. experience_context: allOf: - $ref: '#/components/schemas/experience_context_base' - description: >- Customizes the payer experience during the approval process for the payment. not: anyOf: - required: - brand_name - required: - shipping_preference payer_base: title: payer_base description: >- The customer who approves and pays for the order. The customer is also known as the payer. type: object properties: email_address: allOf: - $ref: '#/components/schemas/email' - description: The email address of the payer. payer_id: allOf: - $ref: '#/components/schemas/account_id' - description: The PayPal-assigned ID for the payer. readOnly: true name: title: Name description: The name of the party. type: object properties: prefix: description: The prefix, or title, to the party's name. type: string minLength: 0 maxLength: 140 pattern: ^[\S\s]*$ given_name: description: When the party is a person, the party's given, or first, name. type: string minLength: 0 maxLength: 140 pattern: ^[\S\s]*$ surname: description: >- 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. type: string minLength: 0 maxLength: 140 pattern: ^[\S\s]*$ middle_name: description: >- 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. type: string minLength: 0 maxLength: 140 pattern: ^[\S\s]*$ suffix: description: The suffix for the party's name. type: string minLength: 0 maxLength: 140 pattern: ^[\S\s]*$ full_name: description: When the party is a person, the party's full name. type: string minLength: 0 maxLength: 300 pattern: ^[\S\s]*$ phone_with_type: title: phone_with_type description: The phone information. type: object required: - phone_number properties: phone_type: $ref: '#/components/schemas/phone_type' phone_number: allOf: - $ref: '#/components/schemas/phone_number_without_country_code' - description: >- The phone number, in its canonical international [E.164 numbering plan format](https://www.itu.int/rec/T-REC-E.164/en). Supports only the `national_number` property. date_no_time: description: >- 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. type: string minLength: 10 maxLength: 10 pattern: ^[0-9]{4}-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|3[0-1])$ tax_info: title: tax_info description: >- The tax ID of the customer. The customer is also known as the payer. Both `tax_id` and `tax_id_type` are required. type: object required: - tax_id - tax_id_type properties: tax_id: description: The customer's tax ID value. type: string minLength: 1 maxLength: 14 pattern: ^.*([a-zA-Z0-9]).*$ tax_id_type: description: The customer's tax ID type. type: string enum: - BR_CPF - BR_CNPJ address_portable: title: Portable Postal Address (Medium-Grained) description: >- 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). type: object required: - country_code properties: address_line_1: description: >- The first line of the address, such as number and street, for example, `173 Drury Lane`. Needed for data entry, and Compliance and Risk checks. This field needs to pass the full address. type: string minLength: 0 maxLength: 300 pattern: ^[\S\s]*$ address_line_2: description: >- The second line of the address, for example, a suite or apartment number. type: string minLength: 0 maxLength: 300 pattern: ^[\S\s]*$ address_line_3: description: >- The third line of the address, if needed. Examples include a street complement for Brazil, direction text, such as `next to Walmart`, or a landmark in an Indian address. type: string minLength: 0 maxLength: 100 pattern: ^[\S\s]*$ admin_area_4: description: >- The neighborhood, ward, or district. This is smaller than `admin_area_level_3` or `sub_locality`. Value is: type: string minLength: 0 maxLength: 100 pattern: ^[\S\s]*$ admin_area_3: description: >- The sub-locality, suburb, neighborhood, or district. This is smaller than `admin_area_level_2`. Value is: type: string minLength: 0 maxLength: 100 pattern: ^[\S\s]*$ admin_area_2: description: A city, town, or village. Smaller than `admin_area_level_1`. type: string minLength: 0 maxLength: 120 pattern: ^[\S\s]*$ admin_area_1: description: >- 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: type: string minLength: 0 maxLength: 300 pattern: ^[\S\s]*$ postal_code: description: >- 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). type: string minLength: 0 maxLength: 60 pattern: ^[\S\s]*$ country_code: $ref: '#/components/schemas/country_code' address_details: title: Address Details description: >- The non-portable additional address details include fine-grain address information for Compliance, Risk, and other scenarios. This isn't portable with common third-party and open source applications. This can include data that is redundant with core fields. For example, `address_portable.address_line_1` is usually a combination of `address_details.street_number`, `street_name`, and `street_type`. type: object properties: street_number: description: The street number. type: string minLength: 0 maxLength: 100 pattern: ^[\S\s]*$ street_name: description: The street name. Just `Drury` in `Drury Lane`. type: string minLength: 0 maxLength: 100 pattern: ^[\S\s]*$ street_type: description: >- The street type. For example, avenue, boulevard, road, or expressway. type: string minLength: 0 maxLength: 100 pattern: ^[\S\s]*$ delivery_service: description: >- The delivery service. Post office box, bag number, or post office name. type: string minLength: 0 maxLength: 100 pattern: ^[\S\s]*$ building_name: description: >- A named locations that represents the premise. Usually a building name or number or collection of buildings with a common name or number. For example, Craven House. type: string minLength: 0 maxLength: 100 pattern: ^[\S\s]*$ sub_building: description: >- The first-order entity below a named building or location that represents the sub-premise. Usually a single building within a collection of buildings with a common name. Can be a flat, story, floor, room, or apartment. type: string minLength: 0 maxLength: 100 pattern: ^[\S\s]*$ amount_with_breakdown: title: amount_with_breakdown description: >- The total order amount with an optional breakdown that provides details, such as the total item amount, total tax amount, shipping, handling, insurance, and discounts, if any.
If you specify `amount.breakdown`, the amount equals `item_total` plus `tax_total` plus `shipping` plus `handling` plus `insurance` minus `shipping_discount` minus discount.
The amount must be a positive number. For listed of supported currencies and decimal precision, see the PayPal REST APIs Currency Codes. type: object allOf: - $ref: '#/components/schemas/money' - type: object properties: breakdown: $ref: '#/components/schemas/amount_breakdown' payee: title: payee description: >- The merchant who receives the funds and fulfills the order. The merchant is also known as the payee. type: object allOf: - $ref: '#/components/schemas/payee_base' - type: object payment_instruction: title: payment_instruction description: >- Any additional payment instructions to be consider during payment processing. This processing instruction is applicable for Capturing an order or Authorizing an Order. type: object properties: platform_fees: description: >- An array of various fees, commissions, tips, or donations. This field is only applicable to merchants that been enabled for PayPal Complete Payments Platform for Marketplaces and Platforms capability. type: array minItems: 0 maxItems: 1 items: allOf: - $ref: '#/components/schemas/platform_fee' - title: platform_fee disbursement_mode: allOf: - $ref: '#/components/schemas/disbursement_mode' - description: >- The funds that are held payee by the marketplace/platform. This field is only applicable to merchants that been enabled for PayPal Complete Payments Platform for Marketplaces and Platforms capability. payee_pricing_tier_id: description: >- This field is only enabled for selected merchants/partners to use and provides the ability to trigger a specific pricing rate/plan for a payment transaction. The list of eligible 'payee_pricing_tier_id' would be provided to you by your Account Manager. Specifying values other than the one provided to you by your account manager would result in an error. type: string minLength: 1 maxLength: 20 pattern: ^.*$ payee_receivable_fx_rate_id: description: >- FX identifier generated returned by PayPal to be used for payment processing in order to honor FX rate (for eligible integrations) to be used when amount is settled/received into the payee account. type: string minLength: 1 maxLength: 4000 pattern: ^.*$ item: title: item description: The details for the items to be purchased. type: object required: - name - quantity - unit_amount properties: name: description: The item name or title. type: string minLength: 1 maxLength: 127 pattern: ^[\S\s]*$ unit_amount: allOf: - $ref: '#/components/schemas/money' - description: >- The item price or rate per unit. If you specify unit_amount, purchase_units[].amount.breakdown.item_total is required. Must equal unit_amount * quantity for all items. unit_amount.value can not be a negative number. tax: allOf: - $ref: '#/components/schemas/money' - description: >- The item tax for each unit. If tax is specified, purchase_units[].amount.breakdown.tax_total is required. Must equal tax * quantity for all items. tax.value can not be a negative number. quantity: description: The item quantity. Must be a whole number. type: string minLength: 0 maxLength: 10 pattern: ^[1-9][0-9]{0,9}$ description: description: The detailed item description. type: string minLength: 0 maxLength: 2048 pattern: ^[\S\s]*$ sku: description: The stock keeping unit (SKU) for the item. type: string minLength: 0 maxLength: 127 pattern: ^[\S\s]*$ url: description: >- The URL to the item being purchased. Visible to buyer and used in buyer experiences. type: string minLength: 1 maxLength: 2048 format: uri category: description: The item category type. type: string enum: - DIGITAL_GOODS - PHYSICAL_GOODS - DONATION image_url: description: >- The URL of the item's image. File type and size restrictions apply. An image that violates these restrictions will not be honored. type: string minLength: 1 maxLength: 2048 format: uri upc: allOf: - $ref: '#/components/schemas/universal_product_code' - description: The Universal Product Code of the item. billing_plan: $ref: '#/components/schemas/order_billing_plan' shipping_with_tracking_details: title: shipping_with_tracking_details description: The order shipping details. type: object allOf: - $ref: '#/components/schemas/shipping_detail' - type: object properties: phone_number: allOf: - $ref: >- #/components/schemas/phone_with_national_required_and_country_code - description: >- The phone number of the recipient of the shipped items, which may belong to either the payer, or an alternate contact, for delivery. trackers: description: An array of trackers for a transaction. type: array minItems: 0 maxItems: 32767 items: $ref: '#/components/schemas/tracker' supplementary_data: title: supplementary_data description: >- Supplementary data about a payment. This object passes information that can be used to improve risk assessments and processing costs, for example, by providing Level 2 and Level 3 payment data. type: object properties: card: allOf: - $ref: '#/components/schemas/card_supplementary_data' - description: >- Merchants and partners can add Level 2 and 3 data to payments to reduce risk and payment processing costs. For more information about processing payments, see checkout or multiparty checkout. risk: allOf: - $ref: '#/components/schemas/risk_supplementary_data' - description: >- Merchants and partners can add additional customer parameters that can help with better fraud protection and reduced risk for unbranded card payments. payment_collection: title: Payment Collection description: >- The collection of payments, or transactions, for a purchase unit in an order. For example, authorized payments, captured payments, and refunds. type: object properties: authorizations: description: >- An array of authorized payments for a purchase unit. A purchase unit can have zero or more authorized payments. type: array minItems: 0 maxItems: 32767 items: allOf: - $ref: '#/components/schemas/authorization_with_additional_data' - title: authorizations description: The authorized payment for a purchase unit. captures: description: >- An array of captured payments for a purchase unit. A purchase unit can have zero or more captured payments. type: array minItems: 0 maxItems: 32767 items: allOf: - $ref: '#/components/schemas/capture' - title: capture description: The captured payment for a purchase unit. refunds: description: >- An array of refunds for a purchase unit. A purchase unit can have zero or more refunds. type: array minItems: 0 maxItems: 32767 items: allOf: - $ref: '#/components/schemas/refund' - title: refund description: A refund for a purchase unit. link_schema-2: title: Link Schema description: The request data or link target. type: object properties: additionalItems: title: additional_items description: Any additional items. type: object dependencies: title: Dependencies description: Any Dependencies. type: object items: title: Items description: An item. type: object definitions: title: Definitions description: Definitions. type: object patternProperties: title: pattern_properties description: The pattern properties. type: object properties: title: Properties description: Properties. type: object allOf: title: all_of description: >- An array of sub-schemas. The data must validate against all sub-schemas. type: array minItems: 0 maxItems: 32767 items: title: all_of_item description: A sub-schema against which the data must validate. type: object anyOf: title: any_of description: >- An array of sub-schemas. The data must validate against one or more sub-schemas. type: array minItems: 0 maxItems: 32767 items: title: any_of_item description: A sub-schema against which the data must validate. type: object oneOf: title: one_of description: >- An array of sub-schemas. The data must validate against one sub-schema. type: array minItems: 0 maxItems: 32767 items: title: one_of_item description: A sub-schema against which the data must validate. type: object not: title: Not description: Not. type: object links: description: An array of links. type: array minItems: 0 maxItems: 32767 readOnly: true items: title: link description: A link. type: object readOnly: true fragmentResolution: title: fragment_resolution description: The fragment resolution. type: string minLength: 0 maxLength: 2147483647 pattern: ^[\S\s]*$ media: title: Media description: The media type and context-encoding scheme. type: object properties: type: description: >- The media type. See [Multipurpose Internet Mail Extensions (MIME) Part Two: Media Types](https://tools.ietf.org/html/rfc2046). type: string minLength: 0 maxLength: 2147483647 pattern: ^[\S\s]*$ binaryEncoding: title: binary_encoding description: >- The content-encoding scheme. See [Multipurpose Internet Mail Extensions (MIME) Part One: Format of Internet Message Bodies](https://tools.ietf.org/html/rfc2045). type: string minLength: 0 maxLength: 2147483647 pattern: ^[\S\s]*$ pathStart: title: path_start description: >- To apply this schema to the instances' URIs, start the URIs with this value. type: string minLength: 0 maxLength: 2147483647 format: uri link_schema: title: Link Schema description: The request data or link target. type: object properties: additionalItems: title: additional_items description: Any additional items. type: object dependencies: title: Dependencies description: The dependencies. type: object items: title: Items description: An item. type: object definitions: title: Definitions description: Definitions. type: object patternProperties: title: pattern_properties description: The pattern properties. type: object properties: title: Properties description: The properties. type: object allOf: title: all_of description: >- An array of sub-schemas. The data must validate against all sub-schemas. type: array minItems: 0 maxItems: 32767 items: title: all_of_item description: A sub-schema against which the data must validate. type: object anyOf: title: any_of description: >- An array of sub-schemas. The data must validate against one or more sub-schemas. type: array minItems: 0 maxItems: 32767 items: title: any_of_item description: A sub-schema against which the data must validate. type: object oneOf: title: one_of description: >- An array of sub-schemas. The data must validate against one sub-schema. type: array minItems: 0 maxItems: 32767 items: title: one_of_item description: A sub-schema against which the data must validate. type: object not: title: Not description: Not. type: object links: description: An array of links. type: array minItems: 0 maxItems: 32767 readOnly: true items: title: link description: A link. type: object readOnly: true fragmentResolution: title: fragment_resolution description: The fragment resolution. type: string minLength: 0 maxLength: 2147483647 pattern: ^[\S\s]*$ media: title: Media description: The media type and context-encoding scheme. type: object properties: type: description: >- The media type. See [Multipurpose Internet Mail Extensions (MIME) Part Two: Media Types](https://tools.ietf.org/html/rfc2046). type: string minLength: 0 maxLength: 2147483647 pattern: ^[\S\s]*$ binaryEncoding: title: binary_encoding description: >- The content-encoding scheme. See [Multipurpose Internet Mail Extensions (MIME) Part One: Format of Internet Message Bodies](https://tools.ietf.org/html/rfc2045). type: string minLength: 0 maxLength: 2147483647 pattern: ^[\S\s]*$ pathStart: title: path_start description: >- To apply this schema to the instances' URIs, start the URIs with this value. type: string minLength: 0 maxLength: 2147483647 format: uri card_brand: title: card_brand description: >- The card network or brand. Applies to credit, debit, gift, and payment cards. type: string enum: - VISA - MASTERCARD - DISCOVER - AMEX - SOLO - JCB - STAR - DELTA - SWITCH - MAESTRO - CB_NATIONALE - CONFIGOGA - CONFIDIS - ELECTRON - CETELEM - CHINA_UNION_PAY - DINERS - ELO - HIPER - HIPERCARD - RUPAY - GE - SYNCHRONY - EFTPOS - CARTE_BANCAIRE - STAR_ACCESS - PULSE - NYCE - ACCEL - UNKNOWN card_type: title: card_type description: Type of card. i.e Credit, Debit and so on. type: string enum: - CREDIT - DEBIT - PREPAID - STORE - UNKNOWN authentication_response: title: authentication_response description: Results of Authentication such as 3D Secure. type: object properties: liability_shift: $ref: '#/components/schemas/liability_shift' three_d_secure: $ref: '#/components/schemas/three_d_secure_authentication_response' card_attributes_response: title: card_attributes_response description: Additional attributes associated with the use of this card. type: object properties: vault: $ref: '#/components/schemas/card_vault_response' card_from_request: title: card_from_request description: Representation of card details as received in the request. type: object properties: expiry: allOf: - $ref: '#/components/schemas/date_year_month' - description: >- The card expiration year and month, in [Internet date format](https://tools.ietf.org/html/rfc3339#section-5.6). last_digits: description: The last digits of the payment card. type: string minLength: 2 maxLength: 4 pattern: ^.*[0-9]{2,}.*$ readOnly: true date_year_month: description: >- 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). type: string minLength: 7 maxLength: 7 pattern: ^[0-9]{4}-(0[1-9]|1[0-2])$ bin_details: title: bin_details description: Bank Identification Number (BIN) details used to fund a payment. type: object properties: bin: description: >- The Bank Identification Number (BIN) signifies the number that is being used to identify the granular level details (except the PII information) of the card. type: string minLength: 1 maxLength: 25 pattern: ^[0-9]+$ issuing_bank: description: The issuer of the card instrument. type: string minLength: 1 maxLength: 64 pattern: ^[\S\s]*$ bin_country_code: allOf: - $ref: '#/components/schemas/country_code-2' - description: >- The [two-character ISO-3166-1 country code](/docs/integration/direct/rest/country-codes/) of the bank. products: description: >- The type of card product assigned to the BIN by the issuer. These values are defined by the issuer and may change over time. Some examples include: PREPAID_GIFT, CONSUMER, CORPORATE. type: array minItems: 1 maxItems: 256 items: title: products description: This value provides the category of the BIN. type: string minLength: 1 maxLength: 255 pattern: ^[\S\s]*$ card_stored_credential: title: card_stored_credential description: >- Provides additional details to process a payment using a `card` that has been stored or is intended to be stored (also referred to as stored_credential or card-on-file).
Parameter compatibility:
type: object required: - payment_initiator - payment_type properties: payment_initiator: $ref: '#/components/schemas/payment_initiator' payment_type: $ref: '#/components/schemas/stored_payment_source_payment_type' usage: $ref: '#/components/schemas/stored_payment_source_usage_type' previous_network_transaction_reference: $ref: '#/components/schemas/network_transaction_reference' email: title: email description: >- 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.
type: string minLength: 3 maxLength: 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])+)\]).*$ account_id-2: description: >- 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. type: string minLength: 13 maxLength: 13 pattern: ^[2-9A-HJ-NP-Z]{13}$ phone_type: title: Phone Type description: The phone type. type: string enum: - FAX - HOME - MOBILE - OTHER - PAGER phone-3: title: Phone Number description: >- The phone number in its canonical international [E.164 numbering plan format](https://www.itu.int/rec/T-REC-E.164/en). type: object required: - national_number properties: national_number: description: >- The national number, in its canonical international [E.164 numbering plan format](https://www.itu.int/rec/T-REC-E.164/en). The combined length of the country calling code (CC) and the national number must not be greater than 15 digits. The national number consists of a national destination code (NDC) and subscriber number (SN). type: string minLength: 1 maxLength: 14 pattern: ^[0-9]{1,14}?$ paypal_wallet_attributes_response: title: paypal_wallet_attributes_response description: Additional attributes associated with the use of a PayPal Wallet. type: object properties: vault: $ref: '#/components/schemas/paypal_wallet_vault_response' cobranded_cards: description: >- An array of merchant cobranded cards used by buyer to complete an order. This array will be present if a merchant has onboarded their cobranded card with PayPal and provided corresponding label(s). type: array minItems: 0 maxItems: 25 items: allOf: - $ref: '#/components/schemas/cobranded_card' - title: cobranded_card paypal_wallet_stored_credential: title: paypal_wallet_stored_credential description: >- Provides additional details to process a payment using the PayPal wallet billing agreement or a vaulted payment method that has been stored or is intended to be stored. type: object required: - payment_initiator properties: payment_initiator: $ref: '#/components/schemas/payment_initiator' charge_pattern: allOf: - $ref: '#/components/schemas/charge_pattern' - description: >- DEPRECATED. Expected business/pricing model for the billing agreement, Please use usage_pattern instead. DEPRECATED
See
usage_pattern
deprecated: true usage_pattern: $ref: '#/components/schemas/charge_pattern' usage: $ref: '#/components/schemas/stored_payment_source_usage_type' full_name: title: name description: The full name representation like Mr J Smith. type: string minLength: 3 maxLength: 300 pattern: ^[\S\s]*$ country_code-2: description: >- The [two-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.
type: string minLength: 2 maxLength: 2 pattern: ^([A-Z]{2}|C2)$ bic: title: BIC description: >- The business identification code (BIC). In payments systems, a BIC is used to identify a specific business, most commonly a bank. type: string minLength: 8 maxLength: 11 pattern: ^[A-Z-a-z0-9]{4}[A-Z-a-z]{2}[A-Z-a-z0-9]{2}([A-Z-a-z0-9]{3})?$ iban_last_chars: title: iban_last_chars description: The last characters of the IBAN used to pay. type: string minLength: 4 maxLength: 34 pattern: ^.*[a-zA-Z0-9]{4}.*$ email_address: description: >- 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.
type: string minLength: 3 maxLength: 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])?|\[(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-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])+)\])$ blik_one_click_response: title: blik_one_click_response description: Information used to pay using BLIK one-click flow. type: object properties: consumer_reference: description: >- The merchant generated, unique reference serving as a primary identifier for accounts connected between Blik and a merchant. type: string minLength: 3 maxLength: 64 pattern: ^[ -~]{3,64}$ phone: title: Phone description: >- The phone number, in its canonical international [E.164 numbering plan format](https://www.itu.int/rec/T-REC-E.164/en). type: object required: - country_code - national_number properties: country_code: title: country_calling_code description: >- The country calling code (CC), in its canonical international [E.164 numbering plan format](https://www.itu.int/rec/T-REC-E.164/en). The combined length of the CC and the national number must not be greater than 15 digits. The national number consists of a national destination code (NDC) and subscriber number (SN). type: string minLength: 1 maxLength: 3 pattern: ^[0-9]{1,3}?$ national_number: description: >- The national number, in its canonical international [E.164 numbering plan format](https://www.itu.int/rec/T-REC-E.164/en). The combined length of the country calling code (CC) and the national number must not be greater than 15 digits. The national number consists of a national destination code (NDC) and subscriber number (SN). type: string minLength: 1 maxLength: 14 pattern: ^[0-9]{1,14}?$ extension_number: description: The extension number. type: string minLength: 1 maxLength: 15 pattern: ^[0-9]{1,15}?$ apple_pay_card_response: title: apple_pay_card_response description: The Card from Apple Pay Wallet used to fund the payment. type: object allOf: - allOf: - $ref: '#/components/schemas/card_response' - not: anyOf: - required: - id - required: - last_n_chars - required: - issuer - type: object properties: name: description: The card holder's name as it appears on the card. type: string minLength: 0 maxLength: 300 pattern: ^[\S\s]*$ billing_address: allOf: - $ref: '#/components/schemas/address_portable' - description: >- The billing address for this card. Supports only the `address_line_1`, `address_line_2`, `admin_area_1`, `admin_area_2`, `postal_code`, and `country_code` properties. not: anyOf: - required: - address_line_3 - required: - admin_area_3 - required: - admin_area_4 - required: - address_details country_code: allOf: - $ref: '#/components/schemas/country_code-2' - description: The country where the card is issued. apple_pay_attributes_response: title: apple_pay_attributes_response description: Additional attributes associated with the use of Apple Pay. type: object properties: vault: $ref: '#/components/schemas/vault_response' phone_with_national_required_and_country_code: title: >- Phone Number Schema with Required National Number and Optional Country Code description: >- A structured representation of a phone number conforming to the international [E.164 numbering plan format](https://www.itu.int/rec/T-REC-E.164/en),requiring the national_number field and optionally supporting the country_code. type: object required: - national_number properties: country_code: title: country_calling_code description: >- The country calling code (CC), in its canonical international [E.164 numbering plan format](https://www.itu.int/rec/T-REC-E.164/en). The combined length of the CC and the national number must not be greater than 15 digits. The national number consists of a national destination code (NDC) and subscriber number (SN). type: string minLength: 1 maxLength: 3 pattern: ^[0-9]{1,3}?$ national_number: description: >- The national number, in its canonical international [E.164 numbering plan format](https://www.itu.int/rec/T-REC-E.164/en). The combined length of the country calling code (CC) and the national number must not be greater than 15 digits. The national number consists of a national destination code (NDC) and subscriber number (SN). type: string minLength: 1 maxLength: 14 pattern: ^[0-9]{1,14}?$ google_pay_card_response: title: google_pay_card_response description: >- The payment card to use to fund a Google Pay payment response. Can be a credit or debit card. type: object properties: name: description: The card holder's name as it appears on the card. type: string minLength: 1 maxLength: 300 pattern: ^.{1,300}$ last_digits: description: The last digits of the payment card. type: string minLength: 2 maxLength: 4 pattern: ^[0-9]{2,4}$ readOnly: true type: allOf: - $ref: '#/components/schemas/card_type' - description: The payment card type. brand: allOf: - $ref: '#/components/schemas/card_brand' - description: The card brand or network. Typically used in the response. billing_address: allOf: - $ref: '#/components/schemas/address_portable' - description: >- The billing address for this card. Supports only the `address_line_1`, `address_line_2`, `admin_area_1`, `admin_area_2`, `postal_code`, and `country_code` properties. not: anyOf: - required: - address_line_3 - required: - admin_area_3 - required: - admin_area_4 - required: - address_details authentication_result: $ref: '#/components/schemas/authentication_response' venmo_wallet_attributes_response: title: venmo_wallet_attributes_response description: Additional attributes associated with the use of a Venmo Wallet. type: object properties: vault: $ref: '#/components/schemas/venmo_vault_response' country_code: description: >- 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.
type: string minLength: 2 maxLength: 2 pattern: ^([A-Z]{2}|C2)$ crypto_account_holder_name: title: crypto_account_holder_name description: Crypto account holder name. type: object required: - given_name - surname properties: prefix: description: The prefix, or title, to the account holder's name. type: string minLength: 1 maxLength: 140 pattern: ^[\S\s]*$ given_name: description: >- When the account holder is a person, the account holder's given, or first, name. type: string minLength: 1 maxLength: 140 pattern: ^[\S\s]*$ surname: description: >- When the account holder is a person, the account holder's surname or family name. Also known as the last name. Required when the account holder is a person. Use also to store multiple surnames including the matronymic, or mother's, surname. type: string minLength: 1 maxLength: 140 pattern: ^[\S\s]*$ middle_name: description: >- When the account holder is a person, the account holder's middle name. Use also to store multiple middle names including the patronymic, or father's, middle name. type: string minLength: 1 maxLength: 140 pattern: ^[\S\s]*$ experience_context_base: title: experience_context_base description: >- Customizes the payer experience during the approval process for the payment. type: object properties: brand_name: description: >- 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. type: string minLength: 1 maxLength: 127 pattern: ^.*$ locale: allOf: - $ref: '#/components/schemas/language' - description: >- 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`. shipping_preference: description: The location from which the shipping address is derived. type: string enum: - GET_FROM_FILE - NO_SHIPPING - SET_PROVIDED_ADDRESS default: GET_FROM_FILE return_url: allOf: - $ref: '#/components/schemas/url' - description: >- The URL where the customer is redirected after the customer approves the payment. format: uri cancel_url: allOf: - $ref: '#/components/schemas/url' - description: >- The URL where the customer is redirected after the customer cancels the payment. format: uri account_id: title: PayPal Account Identifier description: The account identifier for a PayPal account. type: string minLength: 13 maxLength: 13 pattern: ^[2-9A-HJ-NP-Z]{13}$ phone_number_without_country_code: title: Phone Number Format Requiring National Number Excluding Country Code description: >- A structured representation of a phone number conforming to the international [E.164 numbering plan format](https://www.itu.int/rec/T-REC-E.164/en),requiring only the national_number field. type: object required: - national_number properties: national_number: description: >- The national number, in its canonical international [E.164 numbering plan format](https://www.itu.int/rec/T-REC-E.164/en). The combined length of the country calling code (CC) and the national number must not be greater than 15 digits. The national number consists of a national destination code (NDC) and subscriber number (SN). type: string minLength: 1 maxLength: 14 pattern: ^[0-9]{1,14}?$ money: title: Money description: >- The currency and amount for a financial transaction, such as a balance or payment due. type: object required: - currency_code - value properties: currency_code: $ref: '#/components/schemas/currency_code' value: description: >- The value, which might be:For the required number of decimal places for a currency code, see [Currency Codes](/api/rest/reference/currency-codes/). type: string minLength: 0 maxLength: 32 pattern: ^((-?[0-9]+)|(-?([0-9]+)?[.][0-9]+))$ amount_breakdown: title: amount_breakdown description: >- The breakdown of the amount. Breakdown provides details such as total item amount, total tax amount, shipping, handling, insurance, and discounts, if any. type: object properties: item_total: allOf: - $ref: '#/components/schemas/money' - description: >- The subtotal for all items. Required if the request includes `purchase_units[].items[].unit_amount`. Must equal the sum of `(items[].unit_amount * items[].quantity)` for all items. item_total.value can not be a negative number. shipping: allOf: - $ref: '#/components/schemas/money' - description: >- The shipping fee for all items within a given `purchase_unit`. shipping.value can not be a negative number. handling: allOf: - $ref: '#/components/schemas/money' - description: >- The handling fee for all items within a given `purchase_unit`. handling.value can not be a negative number. tax_total: allOf: - $ref: '#/components/schemas/money' - description: >- The total tax for all items. Required if the request includes `purchase_units.items.tax`. Must equal the sum of `(items[].tax * items[].quantity)` for all items. tax_total.value can not be a negative number. insurance: allOf: - $ref: '#/components/schemas/money' - description: >- The insurance fee for all items within a given `purchase_unit`. insurance.value can not be a negative number. shipping_discount: allOf: - $ref: '#/components/schemas/money' - description: >- The shipping discount for all items within a given `purchase_unit`. shipping_discount.value can not be a negative number. discount: allOf: - $ref: '#/components/schemas/discount_with_breakdown' - description: >- The discount for all items within a given `purchase_unit`. discount.value can not be a negative number. payee_base: title: payee_base description: >- The details for the merchant who receives the funds and fulfills the order. The merchant is also known as the payee. type: object properties: email_address: allOf: - $ref: '#/components/schemas/email' - description: The email address of merchant. merchant_id: allOf: - $ref: '#/components/schemas/account_id' - description: The encrypted PayPal account ID of the merchant. platform_fee: title: platform_fee description: >- The platform or partner fee, commission, or brokerage fee that is associated with the transaction. Not a separate or isolated transaction leg from the external perspective. The platform fee is limited in scope and is always associated with the original payment for the purchase unit. type: object required: - amount properties: amount: allOf: - $ref: '#/components/schemas/money' - title: amount description: The fee for this transaction. payee: allOf: - $ref: '#/components/schemas/payee_base' - title: payee description: The recipient of the fee for this transaction. disbursement_mode: title: disbursement_mode description: The funds that are held on behalf of the merchant. type: string enum: - INSTANT - DELAYED default: INSTANT order_billing_plan: title: order_billing_plan description: >- Metadata for merchant-managed recurring billing plans. Valid only during the saved payment method token or billing agreement creation. type: object required: - billing_cycles properties: billing_cycles: description: >- 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. type: array minItems: 1 maxItems: 3 items: $ref: '#/components/schemas/billing_cycle' setup_fee: allOf: - $ref: '#/components/schemas/money' - description: >- The setup fee for the recurring plan. Ensure its part of the item amount. name: description: Name of the recurring plan. type: string minLength: 1 maxLength: 127 pattern: ^[A-Za-z0-9() +',.:-]+$ shipping_detail: title: shipping_detail description: The shipping details. type: object properties: name: allOf: - $ref: '#/components/schemas/name' - description: >- The name of the person to whom to ship the items. Supports only the `full_name` property. not: anyOf: - required: - prefix - required: - given_name - required: - surname - required: - middle_name - required: - suffix - required: - alternate_full_name email_address: allOf: - $ref: '#/components/schemas/email_address' - description: >- The email address of the recipient of the shipped items, which may belong to either the payer, or an alternate contact, for delivery. phone_number: allOf: - $ref: '#/components/schemas/phone' - description: >- The phone number of the recipient of the shipped items, which may belong to either the payer, or an alternate contact, for delivery. [Format - canonical international [E.164 numbering plan](https://www.itu.int/rec/T-REC-E.164/en)] not: required: - extension_number type: title: Fulfillment Type description: >- A classification for the method of purchase fulfillment (e.g shipping, in-store pickup, etc). Either `type` or `options` may be present, but not both. type: string enum: - SHIPPING - PICKUP_IN_PERSON - PICKUP_IN_STORE - PICKUP_FROM_PERSON default: SHIPPING options: description: >- An array of shipping options that the payee or merchant offers to the payer to ship or pick up their items. type: array minItems: 0 maxItems: 30 items: allOf: - $ref: '#/components/schemas/shipping_option' - title: shipping_option description: >- The option that the payee or merchant offers to the payer to ship or pick up their items. address: allOf: - $ref: '#/components/schemas/address_portable' - description: >- The address of the person to whom to ship the items. Supports only the `address_line_1`, `address_line_2`, `admin_area_1`, `admin_area_2`, `postal_code`, and `country_code` properties. `admin_area_1` is required for addresses located in Argentina, Brazil, China, Canada, India, Indonesia, Japan, Mexico, Thailand, and the United States. not: anyOf: - required: - address_line_3 - required: - admin_area_3 - required: - admin_area_4 - required: - address_details tracker: title: tracker description: The tracking response on creation of tracker. type: object allOf: - type: object properties: id: description: The tracker id. type: string minLength: 0 maxLength: 2147483647 pattern: ^[\S\s]*$ readOnly: true status: $ref: '#/components/schemas/tracker_status' items: description: An array of details of items in the shipment. type: array minItems: 0 maxItems: 32767 items: allOf: - $ref: '#/components/schemas/tracker_item' - title: tracker_item description: Items in a shipment. links: description: An array of request-related HATEOAS links. type: array minItems: 0 maxItems: 32767 readOnly: true items: allOf: - $ref: '#/components/schemas/link_description-2' - title: link_description description: >- A request-related [HATEOAS link](/api/rest/responses/#hateoas-links). - $ref: '#/components/schemas/activity_timestamps' card_supplementary_data: title: card_supplementary_data description: >- Merchants and partners can add Level 2 and 3 data to payments to reduce risk and payment processing costs. For more information about processing payments, see checkout or multiparty checkout. type: object properties: level_2: $ref: '#/components/schemas/level_2_card_processing_data' level_3: $ref: '#/components/schemas/level_3_card_processing_data' risk_supplementary_data: title: risk_supplementary_data description: >- Additional information necessary to evaluate the risk profile of a transaction. type: object properties: customer: $ref: '#/components/schemas/participant_metadata' authorization_with_additional_data: title: authorization_with_additional_data description: >- The authorization with additional payment details, such as risk assessment and processor response. These details are populated only for certain payment methods. type: object allOf: - $ref: '#/components/schemas/authorization' - type: object properties: processor_response: allOf: - $ref: '#/components/schemas/processor_response' - description: The processor response for card transactions. readOnly: true capture: title: capture description: A captured payment. type: object allOf: - $ref: '#/components/schemas/capture_status' - type: object properties: id: description: The PayPal-generated ID for the captured payment. type: string minLength: 0 maxLength: 2147483647 pattern: ^[\S\s]*$ readOnly: true amount: allOf: - $ref: '#/components/schemas/amount_with_breakdown' - description: The amount for this captured payment. readOnly: true invoice_id: description: >- 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. type: string minLength: 0 maxLength: 2147483647 pattern: ^[\S\s]*$ readOnly: true custom_id: description: >- The API caller-provided external ID. Used to reconcile API caller-initiated transactions with PayPal transactions. Appears in transaction and settlement reports. type: string minLength: 0 maxLength: 255 pattern: ^[\S\s]*$ network_transaction_reference: allOf: - $ref: '#/components/schemas/network_transaction' seller_protection: allOf: - $ref: '#/components/schemas/seller_protection' - readOnly: true final_capture: description: >- 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. type: boolean default: false readOnly: true seller_receivable_breakdown: allOf: - $ref: '#/components/schemas/seller_receivable_breakdown' - readOnly: true disbursement_mode: allOf: - $ref: '#/components/schemas/disbursement_mode' links: description: >- An array of related [HATEOAS links](/docs/api/reference/api-responses/#hateoas-links). type: array minItems: 0 maxItems: 32767 readOnly: true items: allOf: - $ref: '#/components/schemas/link_description-2' - title: link_description processor_response: allOf: - $ref: '#/components/schemas/processor_response' - description: >- An object that provides additional processor information for a direct credit card transaction. - allOf: - $ref: '#/components/schemas/activity_timestamps' refund: title: refund description: The refund information. type: object allOf: - allOf: - $ref: '#/components/schemas/refund_status' - title: Refund Properties description: >- The detailed properties of the refund transaction, including identifiers, amounts, breakdowns, and associated metadata. type: object properties: id: description: The PayPal-generated ID for the refund. type: string minLength: 0 maxLength: 2147483647 pattern: ^[\S\s]*$ readOnly: true amount: allOf: - $ref: '#/components/schemas/money' - description: The amount that the payee refunded to the payer. readOnly: true invoice_id: description: >- 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. type: string minLength: 0 maxLength: 2147483647 pattern: ^[\S\s]*$ readOnly: true custom_id: description: >- The API caller-provided external ID. Used to reconcile API caller-initiated transactions with PayPal transactions. Appears in transaction and settlement reports. type: string minLength: 1 maxLength: 255 pattern: ^[A-Za-z0-9-_.,]*$ acquirer_reference_number: description: >- Reference ID issued for the card transaction. This ID can be used to track the transaction across processors, card brands and issuing banks. type: string minLength: 1 maxLength: 36 pattern: ^[a-zA-Z0-9]+$ note_to_payer: description: >- The reason for the refund. Appears in both the payer's transaction history and the emails that the payer receives. type: string minLength: 0 maxLength: 2147483647 pattern: ^[\S\s]*$ readOnly: true seller_payable_breakdown: title: Seller Payable Breakdown description: The breakdown of the refund. type: object readOnly: true properties: gross_amount: allOf: - $ref: '#/components/schemas/money' - description: The amount that the payee refunded to the payer. readOnly: true paypal_fee: allOf: - $ref: '#/components/schemas/money' - description: >- The PayPal fee that was refunded to the payer in the currency of the transaction. This fee might not match the PayPal fee that the payee paid when the payment was captured. readOnly: true paypal_fee_in_receivable_currency: allOf: - $ref: '#/components/schemas/money' - description: >- The PayPal fee that was refunded to the payer in the receivable currency. Returned only in cases when the receivable currency is different from transaction currency. Example 'CNY'. readOnly: true net_amount: allOf: - $ref: '#/components/schemas/money' - description: >- The net amount that the payee's account is debited in the transaction currency. The net amount is calculated as gross_amount minus paypal_fee minus platform_fees. readOnly: true net_amount_in_receivable_currency: allOf: - $ref: '#/components/schemas/money' - description: >- The net amount that the payee's account is debited in the receivable currency. Returned only in cases when the receivable currency is different from transaction currency. Example 'CNY'. readOnly: true platform_fees: description: >- An array of platform or partner fees, commissions, or brokerage fees for the refund. type: array minItems: 0 maxItems: 1 items: allOf: - $ref: '#/components/schemas/platform_fee' - title: platform_fee net_amount_breakdown: description: >- An array of breakdown values for the net amount. Returned when the currency of the refund is different from the currency of the PayPal account where the payee holds their funds. type: array minItems: 0 maxItems: 32767 readOnly: true items: allOf: - $ref: '#/components/schemas/net_amount_breakdown_item' - title: net_amount_breakdown_item total_refunded_amount: allOf: - $ref: '#/components/schemas/money' - description: >- The total amount refunded from the original capture to date. For example, if a payer makes a $100 purchase and was refunded $20 a week ago and was refunded $30 in this refund, the `gross_amount` is $30 for this refund and the `total_refunded_amount` is $50. payer: allOf: - $ref: '#/components/schemas/payee_base' - description: >- The details associated with the merchant for this transaction. readOnly: true links: description: >- An array of related [HATEOAS links](/docs/api/reference/api-responses/#hateoas-links). type: array minItems: 0 maxItems: 32767 readOnly: true items: allOf: - $ref: '#/components/schemas/link_description-2' - title: link_description - allOf: - $ref: '#/components/schemas/activity_timestamps' liability_shift: title: liability_shift description: Liability shift indicator. The outcome of the issuer's authentication. type: string enum: - 'NO' - POSSIBLE - UNKNOWN three_d_secure_authentication_response: title: three_d_secure_authentication_response description: Results of 3D Secure Authentication. type: object properties: authentication_status: allOf: - $ref: '#/components/schemas/pares_status' - description: The outcome of the issuer's authentication. enrollment_status: allOf: - $ref: '#/components/schemas/enrolled' - description: Status of authentication eligibility. card_vault_response: title: card_vault_response description: The details about a saved Card payment source. type: object allOf: - allOf: - $ref: '#/components/schemas/vault_response' - not: required: - customer - type: object properties: customer: allOf: - $ref: '#/components/schemas/card_customer' payment_initiator: title: payment_initiator description: The person or party who initiated or triggered the payment. type: string enum: - CUSTOMER - MERCHANT stored_payment_source_payment_type: title: stored_payment_source_payment_type description: Indicates the type of the stored payment_source payment. type: string enum: - ONE_TIME - RECURRING - UNSCHEDULED stored_payment_source_usage_type: title: stored_payment_source_usage_type description: >- Indicates if this is a `first` or `subsequent` payment using a stored payment source (also referred to as stored credential or card on file). type: string enum: - FIRST - SUBSEQUENT - DERIVED default: DERIVED network_transaction_reference: title: network_transaction_reference description: Reference values used by the card network to identify a transaction. type: object required: - id allOf: - $ref: '#/components/schemas/network_transaction' paypal_wallet_vault_response: title: paypal_wallet_vault_response description: The details about a saved PayPal Wallet payment source. type: object allOf: - allOf: - $ref: '#/components/schemas/vault_response' - not: required: - customer - type: object properties: customer: $ref: '#/components/schemas/paypal_wallet_customer' cobranded_card: title: cobranded_card description: Details about the merchant cobranded card used for order purchase. type: object properties: labels: description: Array of labels for the cobranded card. type: array minItems: 1 maxItems: 25 items: title: label description: Label for the cobranded card. type: string minLength: 1 maxLength: 256 pattern: ^[\S\s]*$ payee: allOf: - $ref: '#/components/schemas/payee_base' - title: payee description: Merchant associated with the purchase. not: required: - client_id amount: allOf: - $ref: '#/components/schemas/money' - description: Amount that was charged to the cobranded card. charge_pattern: description: Expected business/pricing model for the billing agreement. type: string enum: - IMMEDIATE - DEFERRED - RECURRING_PREPAID - RECURRING_POSTPAID - THRESHOLD_PREPAID - THRESHOLD_POSTPAID - SUBSCRIPTION_PREPAID - SUBSCRIPTION_POSTPAID - UNSCHEDULED_PREPAID - UNSCHEDULED_POSTPAID - INSTALLMENT_PREPAID - INSTALLMENT_POSTPAID vault_response: title: vault_response description: The details about a saved payment source. type: object properties: id: description: The PayPal-generated ID for the saved payment source. type: string minLength: 1 maxLength: 255 pattern: ^[\S\s]*$ status: title: Vault Status description: The vault status. type: string enum: - VAULTED - CREATED - APPROVED customer: allOf: - $ref: '#/components/schemas/customer' - not: anyOf: - required: - email_address - required: - phone links: description: An array of request-related HATEOAS links. type: array minItems: 1 maxItems: 10 readOnly: true items: allOf: - $ref: '#/components/schemas/link_description' - title: link_description description: >- A request-related [HATEOAS link](/docs/api/reference/api-responses/#hateoas-links). venmo_vault_response: title: venmo_vault_response description: The details about a saved venmo payment source. type: object allOf: - allOf: - $ref: '#/components/schemas/vault_response' - not: required: - customer - type: object properties: customer: allOf: - $ref: '#/components/schemas/venmo_wallet_customer' language: description: >- 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/). type: string minLength: 2 maxLength: 10 pattern: ^[a-z]{2}(?:-[A-Z][a-z]{3})?(?:-(?:[A-Z]{2}|[0-9]{3}))?$ url: description: Describes the URL. type: string minLength: 0 maxLength: 2147483647 format: uri currency_code: description: >- The [three-character ISO-4217 currency code](/api/rest/reference/currency-codes/) that identifies the currency. type: string minLength: 3 maxLength: 3 pattern: ^[\S\s]*$ discount_with_breakdown: title: discount_with_breakdown description: >- The discount amount and currency code. For list of supported currencies and decimal precision, see the PayPal REST APIs Currency Codes. type: object allOf: - $ref: '#/components/schemas/money' - type: object billing_cycle: title: billing_cycle description: >- The billing cycle providing details of the billing frequency, amount, duration and if the billing cycle is a free, discounted or regular billing cycle. The sequence of the billing cycle will be in the following order - free trial billing cycle(s), discounted trial billing cycle(s), regular billing cycle(s). type: object required: - tenure_type properties: tenure_type: description: >- The tenure type of the billing cycle identifies if the billing cycle is a trial(free or discounted) or regular billing cycle. type: string enum: - REGULAR - TRIAL pricing_scheme: allOf: - $ref: '#/components/schemas/pricing_scheme' - description: >- The active pricing scheme for this billing cycle. A free trial billing cycle does not require a pricing scheme. total_cycles: description: >- 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). type: integer minimum: 0 maximum: 999 default: 1 sequence: description: >- 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. type: integer minimum: 1 maximum: 3 default: 1 start_date: allOf: - $ref: '#/components/schemas/date_no_time' - description: >- The start date for the billing cycle, in YYYY-MM-DD. This field should be not be provided if the billing cycle starts at the time of checkout. When this field is not provided, the billing cycle amount will be included in any data validations confirming that the total provided by the merchant match the sum of individual items due at the time of checkout. Only one billing cycle (with sequence equal to 1) can have a no start date. shipping_option: title: shipping_option description: >- The options that the payee or merchant offers to the payer to ship or pick up their items. type: object required: - id - label - selected properties: id: description: A unique ID that identifies a payer-selected shipping option. type: string minLength: 0 maxLength: 127 pattern: ^[\S\s]*$ label: description: >- 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. type: string minLength: 0 maxLength: 127 pattern: ^[\S\s]*$ type: allOf: - $ref: '#/components/schemas/shipping_type' - description: A classification for the method of purchase fulfillment. amount: allOf: - $ref: '#/components/schemas/money' - description: The shipping cost for the selected option. selected: description: >- If the API request sets `selected = true`, it represents the shipping option that the payee or merchant expects to be pre-selected for the payer when they first view the `shipping.options` in the PayPal Checkout experience. As part of the response if a `shipping.option` contains `selected=true`, it represents the shipping option that the payer selected during the course of checkout with PayPal. Only one `shipping.option` can be set to `selected=true`. type: boolean tracker_status: title: Tracker Status description: The status of the item shipment. type: string enum: - CANCELLED - SHIPPED level_2_card_processing_data: title: level_2 description: >- The level 2 card processing data collections. If your merchant account has been configured for Level 2 processing this field will be passed to the processor on your behalf. Please contact your PayPal Technical Account Manager to define level 2 data for your business. type: object properties: invoice_id: description: >- Use this field to pass a purchase identification value of up to 127 ASCII characters. The length of this field will be adjusted to meet network specifications (25chars for Visa and Mastercard, 17chars for Amex), and the original invoice ID will still be displayed in your existing reports. type: string minLength: 1 maxLength: 127 pattern: ^[\w‘\-.,":;\!?]*$ tax_total: allOf: - $ref: '#/components/schemas/money' - description: > Use this field to break down the amount of tax included in the total purchase amount. The value provided here will not add to the total purchase amount. The value can't be negative, and in most cases, it must be greater than zero in order to qualify for lower interchange rates. Value, by country, is: UK. A county. US. A state. Canada. A province. Japan. A prefecture. Switzerland. A kanton. level_3_card_processing_data: title: level_3 description: >- The level 3 card processing data collections, If your merchant account has been configured for Level 3 processing this field will be passed to the processor on your behalf. Please contact your PayPal Technical Account Manager to define level 3 data for your business. type: object properties: shipping_amount: allOf: - $ref: '#/components/schemas/money' - description: >- Use this field to break down the shipping cost included in the total purchase amount. The value provided here will not add to the total purchase amount. The value cannot be negative. duty_amount: allOf: - $ref: '#/components/schemas/money' - description: >- Use this field to break down the duty amount included in the total purchase amount. The value provided here will not add to the total purchase amount. The value cannot be negative. discount_amount: allOf: - $ref: '#/components/schemas/money' - description: >- Use this field to break down the discount amount included in the total purchase amount. The value provided here will not add to the total purchase amount. The value cannot be negative. shipping_address: allOf: - $ref: '#/components/schemas/address_portable' - description: >- The address of the person to whom to ship the items. Supports only the `address_line_1`, `address_line_2`, `admin_area_1`, `admin_area_2`, `postal_code`, and `country_code` properties. not: anyOf: - required: - address_line_3 - required: - admin_area_3 - required: - admin_area_4 - required: - address_details ships_from_postal_code: description: Use this field to specify the postal code of the shipping location. type: string minLength: 1 maxLength: 60 pattern: ^[a-zA-Z0-9_'.-]*$ line_items: description: >- A list of the items that were purchased with this payment. If your merchant account has been configured for Level 3 processing this field will be passed to the processor on your behalf. type: array minItems: 1 maxItems: 100 items: allOf: - $ref: '#/components/schemas/line_item' - title: line_item participant_metadata: title: participant_metadata description: Profile information of the sender or receiver. type: object properties: ip_address: allOf: - $ref: '#/components/schemas/ip_address' - description: >- The consumer's IP address, which can be represented in either IPv4 or IPv6 format. authorization: title: authorization description: The authorized payment transaction. type: object allOf: - $ref: '#/components/schemas/authorization_status' - type: object properties: id: description: The PayPal-generated ID for the authorized payment. type: string minLength: 0 maxLength: 2147483647 pattern: ^[\S\s]*$ readOnly: true amount: allOf: - $ref: '#/components/schemas/amount_with_breakdown' - description: The amount for this authorized payment. readOnly: true invoice_id: description: >- 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. type: string minLength: 0 maxLength: 2147483647 pattern: ^[\S\s]*$ readOnly: true custom_id: description: >- The API caller-provided external ID. Used to reconcile API caller-initiated transactions with PayPal transactions. Appears in transaction and settlement reports. type: string minLength: 0 maxLength: 255 pattern: ^[\S\s]*$ network_transaction_reference: allOf: - $ref: '#/components/schemas/network_transaction' seller_protection: allOf: - $ref: '#/components/schemas/seller_protection' - readOnly: true expiration_time: allOf: - $ref: '#/components/schemas/date_time' - description: >- The date and time when the authorized payment expires, in [Internet date and time format](https://tools.ietf.org/html/rfc3339#section-5.6). readOnly: true links: description: >- An array of related [HATEOAS links](/docs/api/reference/api-responses/#hateoas-links). type: array minItems: 0 maxItems: 32767 readOnly: true items: allOf: - $ref: '#/components/schemas/link_description-2' - title: link_description - $ref: '#/components/schemas/activity_timestamps' processor_response: title: processor_response description: >- The processor response information for payment requests, such as direct credit card transactions. type: object properties: avs_code: description: >- The address verification code for Visa, Discover, Mastercard, or American Express transactions. type: string enum: - A - B - C - D - E - F - G - I - M - 'N' - P - R - S - U - W - X - 'Y' - Z - 'Null' - '0' - '1' - '2' - '3' - '4' readOnly: true cvv_code: description: >- The card verification value code for for Visa, Discover, Mastercard, or American Express. type: string enum: - E - I - M - 'N' - P - S - U - X - All others - '0' - '1' - '2' - '3' - '4' readOnly: true response_code: description: Processor response code for the non-PayPal payment processor errors. type: string enum: - '0000' - 00N7 - '0100' - '0390' - '0500' - '0580' - '0800' - '0880' - '0890' - '0960' - 0R00 - '1000' - 10BR - '1300' - '1310' - '1312' - '1317' - '1320' - '1330' - '1335' - '1340' - '1350' - '1352' - '1360' - '1370' - '1380' - '1382' - '1384' - '1390' - '1393' - '5100' - '5110' - '5120' - '5130' - '5135' - '5140' - '5150' - '5160' - '5170' - '5180' - '5190' - '5200' - '5210' - '5400' - '5500' - '5650' - '5700' - '5710' - '5800' - '5900' - '5910' - '5920' - '5930' - '5950' - '6300' - '7600' - '7700' - '7710' - '7800' - '7900' - '8000' - '8010' - '8020' - '8030' - '8100' - '8110' - '8220' - '9100' - '9500' - '9510' - '9520' - '9530' - '9540' - '9600' - PCNR - PCVV - PP06 - PPRN - PPAD - PPAB - PPAE - PPAG - PPAI - PPAR - PPAU - PPAV - PPAX - PPBG - PPC2 - PPCE - PPCO - PPCR - PPCT - PPCU - PPD3 - PPDC - PPDI - PPDV - PPDT - PPEF - PPEL - PPER - PPEX - PPFE - PPFI - PPFR - PPFV - PPGR - PPH1 - PPIF - PPII - PPIM - PPIT - PPLR - PPLS - PPMB - PPMC - PPMD - PPNC - PPNL - PPNM - PPNT - PPPH - PPPI - PPPM - PPQC - PPRE - PPRF - PPRR - PPS0 - PPS1 - PPS2 - PPS3 - PPS4 - PPS5 - PPS6 - PPSC - PPSD - PPSE - PPTE - PPTF - PPTI - PPTR - PPTT - PPTV - PPUA - PPUC - PPUE - PPUI - PPUP - PPUR - PPVC - PPVE - PPVT readOnly: true payment_advice_code: description: >- The declined payment transactions might have payment advice codes. The card networks, like Visa and Mastercard, return payment advice codes. type: string enum: - '01' - '02' - '03' - '04' - '21' - '22' - '24' - '25' - '26' - '27' - '28' - '29' - '30' - '40' - '43' readOnly: true capture_status: title: capture_status description: The status and status details of a captured payment. type: object properties: status: title: Capture Status description: The status of the captured payment. type: string enum: - COMPLETED - DECLINED - PARTIALLY_REFUNDED - PENDING - REFUNDED - FAILED readOnly: true status_details: allOf: - $ref: '#/components/schemas/capture_status_details' - description: The details of the captured payment status. readOnly: true network_transaction: title: network_transaction description: Reference values used by the card network to identify a transaction. type: object properties: id: description: >- 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 -. type: string minLength: 9 maxLength: 36 pattern: ^[a-zA-Z0-9-_@.:&+=*^'~#!$%()]+$ date: description: >- 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. type: string minLength: 4 maxLength: 4 pattern: ^[0-9]+$ network: allOf: - $ref: '#/components/schemas/card_brand' - description: >- Name of the card network through which the transaction was routed. acquirer_reference_number: description: >- Reference ID issued for the card transaction. This ID can be used to track the transaction across processors, card brands and issuing banks. type: string minLength: 1 maxLength: 36 pattern: ^[a-zA-Z0-9]+$ seller_protection: title: seller_protection description: >- The level of protection offered as defined by [PayPal Seller Protection for Merchants](https://www.paypal.com/us/webapps/mpp/security/seller-protection). type: object properties: status: title: Seller Protection Status description: >- Indicates whether the transaction is eligible for seller protection. For information, see [PayPal Seller Protection for Merchants](https://www.paypal.com/us/webapps/mpp/security/seller-protection). type: string enum: - ELIGIBLE - PARTIALLY_ELIGIBLE - NOT_ELIGIBLE readOnly: true dispute_categories: description: An array of conditions that are covered for the transaction. type: array minItems: 0 maxItems: 32767 readOnly: true items: title: dispute_category description: The condition that is covered for the transaction. type: string enum: - ITEM_NOT_RECEIVED - UNAUTHORIZED_TRANSACTION seller_receivable_breakdown: title: Seller Receivable Breakdown description: >- The detailed breakdown of the capture activity. This is not available for transactions that are in pending state. type: object required: - gross_amount properties: gross_amount: allOf: - $ref: '#/components/schemas/money' - description: >- The amount for this captured payment in the currency of the transaction. paypal_fee: allOf: - $ref: '#/components/schemas/money' - description: >- The applicable fee for this captured payment in the currency of the transaction. paypal_fee_in_receivable_currency: allOf: - $ref: '#/components/schemas/money' - description: >- The applicable fee for this captured payment in the receivable currency. Returned only in cases the fee is charged in the receivable currency. Example 'CNY'. net_amount: allOf: - $ref: '#/components/schemas/money' - description: >- The net amount that the payee receives for this captured payment in their PayPal account. The net amount is computed as gross_amount minus the paypal_fee minus the platform_fees. receivable_amount: allOf: - $ref: '#/components/schemas/money' - description: >- The net amount that is credited to the payee's PayPal account. Returned only when the currency of the captured payment is different from the currency of the PayPal account where the payee wants to credit the funds. The amount is computed as net_amount times exchange_rate. exchange_rate: allOf: - $ref: '#/components/schemas/exchange_rate' - description: >- The exchange rate that determines the amount that is credited to the payee's PayPal account. Returned when the currency of the captured payment is different from the currency of the PayPal account where the payee wants to credit the funds. platform_fees: description: >- An array of platform or partner fees, commissions, or brokerage fees that associated with the captured payment. type: array minItems: 0 maxItems: 1 items: allOf: - $ref: '#/components/schemas/platform_fee' - title: platform_fee refund_status: title: refund_status description: The refund status with details. type: object properties: status: title: Refund Status With Details description: The status of the refund. type: string enum: - CANCELLED - FAILED - PENDING - COMPLETED readOnly: true status_details: allOf: - $ref: '#/components/schemas/refund_status_details' - description: The details of the refund status. readOnly: true net_amount_breakdown_item: title: net_amount_breakdown description: >- The net amount. Returned when the currency of the refund is different from the currency of the PayPal account where the merchant holds their funds. type: object properties: payable_amount: allOf: - $ref: '#/components/schemas/money' - description: The net amount debited from the merchant's PayPal account. readOnly: true converted_amount: allOf: - $ref: '#/components/schemas/money' - description: The converted payable amount. readOnly: true exchange_rate: allOf: - $ref: '#/components/schemas/exchange_rate' - description: >- The exchange rate that determines the amount that was debited from the merchant's PayPal account. readOnly: true pares_status: description: >- Transactions status result identifier. The outcome of the issuer's authentication. type: string enum: - 'Y' - 'N' - U - A - C - R - D - I enrolled: description: Status of Authentication eligibility. type: string enum: - 'Y' - 'N' - U - B card_customer: title: card_customer description: The details about a customer in PayPal's system of record. type: object allOf: - $ref: '#/components/schemas/customer' - type: object properties: merchant_customer_id: description: >- 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. type: string minLength: 1 maxLength: 64 pattern: ^[0-9a-zA-Z-_.^*$@#]+$ paypal_wallet_customer: title: paypal_wallet_customer description: The details about a customer in PayPal's system of record. type: object allOf: - $ref: '#/components/schemas/customer' - type: object properties: merchant_customer_id: description: >- 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. type: string minLength: 1 maxLength: 64 pattern: ^[0-9a-zA-Z-_.^*$@#]+$ customer: title: customer description: >- This object represents a merchant’s customer, allowing them to store contact details, and track all payments associated with the same customer. type: object properties: id: $ref: '#/components/schemas/merchant_partner_customer_id' email_address: allOf: - $ref: '#/components/schemas/email' - description: >- Email address of the customer as provided to the merchant or on file with the merchant. Email Address is required if you are processing the transaction using PayPal Guest Processing which is offered to select partners and merchants. phone: allOf: - $ref: '#/components/schemas/phone_with_type' - description: >- The phone number of the customer as provided to the merchant or on file with the merchant. The `phone.phone_number` supports only `national_number`. name: allOf: - $ref: '#/components/schemas/name' - description: >- The full name of the customer as provided to the merchant or on file with the merchant. not: anyOf: - required: - prefix - required: - middle_name - required: - suffix - required: - alternate_full_name - required: - full_name venmo_wallet_customer: title: venmo_wallet_customer description: >- This object represents a merchant’s customer, allowing them to store contact details, and track all payments associated with the same customer. type: object allOf: - $ref: '#/components/schemas/customer' - type: object pricing_scheme: title: pricing_scheme description: The pricing scheme details. type: object required: - pricing_model properties: price: allOf: - $ref: '#/components/schemas/money' - description: >- The price the customer will be charged based on the pricing model pricing_model: description: The pricing model for the billing cycle. type: string enum: - FIXED - VARIABLE - AUTO_RELOAD reload_threshold_amount: allOf: - $ref: '#/components/schemas/money' - description: >- The threshold amount on which the reload charge would be triggered. This will be associated with the account-balance where if the account-balance goes below this amount then customer would incur reload charge. shipping_type: title: shipping_type description: A classification for the method of purchase fulfillment. type: string enum: - SHIPPING - PICKUP - PICKUP_IN_STORE - PICKUP_FROM_PERSON default: SHIPPING line_item: title: line_item description: >- The line items for this purchase. If your merchant account has been configured for Level 3 processing this field will be passed to the processor on your behalf. type: object allOf: - $ref: '#/components/schemas/item_without_category_tax_or_amount' - type: object properties: unit_amount: allOf: - $ref: '#/components/schemas/money' - description: >- The item price or rate per unit. Must equal unit_amount * quantity for all items. unit_amount.value can not be a negative number. tax: allOf: - $ref: '#/components/schemas/money' - description: >- The item tax for each unit. Must equal tax * quantity for all items. tax.value can not be a negative number. commodity_code: description: >- Code used to classify items purchased and track the total amount spent across various categories of products and services. Different corporate purchasing organizations may use different standards, but the United Nations Standard Products and Services Code (UNSPSC) is frequently used. type: string minLength: 1 maxLength: 12 pattern: ^[a-zA-Z0-9_'.-]*$ discount_amount: allOf: - $ref: '#/components/schemas/money' - description: >- Use this field to break down the discount amount included in the total purchase amount. The value provided here will not add to the total purchase amount. The value cannot be negative. total_amount: allOf: - $ref: '#/components/schemas/money' - description: >- The subtotal for all items. Must equal the sum of (items[].unit_amount * items[].quantity) for all items. item_total.value can not be a negative number. unit_of_measure: description: >- Unit of measure is a standard used to express the magnitude of a quantity in international trade. Most commonly used (but not limited to) examples are: Acre (ACR), Ampere (AMP), Centigram (CGM), Centimetre (CMT), Cubic inch (INQ), Cubic metre (MTQ), Fluid ounce (OZA), Foot (FOT), Hour (HUR), Item (ITM), Kilogram (KGM), Kilometre (KMT), Kilowatt (KWT), Liquid gallon (GLL), Liter (LTR), Pounds (LBS), Square foot (FTK). type: string minLength: 1 maxLength: 12 pattern: ^[a-zA-Z0-9_'.-]*$ ip_address: title: IP Address description: >- 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. type: string minLength: 7 maxLength: 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*$ authorization_status: title: authorization_status description: The status fields and status details for an authorized payment. type: object properties: status: title: Authorization Status description: The status for the authorized payment. type: string enum: - CREATED - CAPTURED - DENIED - PARTIALLY_CAPTURED - VOIDED - PENDING readOnly: true status_details: allOf: - $ref: '#/components/schemas/authorization_status_details' - description: The details of the authorized order pending status. readOnly: true capture_status_details: title: capture_status_details description: The details of the captured payment status. type: object properties: reason: title: Capture Incomplete Reason description: The reason why the captured payment status is `PENDING` or `DENIED`. type: string enum: - BUYER_COMPLAINT - CHARGEBACK - ECHECK - INTERNATIONAL_WITHDRAWAL - OTHER - PENDING_REVIEW - RECEIVING_PREFERENCE_MANDATES_MANUAL_ACTION - REFUNDED - TRANSACTION_APPROVED_AWAITING_FUNDING - UNILATERAL - VERIFICATION_REQUIRED - DECLINED_BY_RISK_FRAUD_FILTERS exchange_rate: title: exchange_rate description: >- The exchange rate that determines the amount to convert from one currency to another currency. type: object readOnly: true properties: source_currency: allOf: - $ref: '#/components/schemas/currency_code' - description: The source currency from which to convert an amount. target_currency: allOf: - $ref: '#/components/schemas/currency_code' - description: The target currency to which to convert an amount. value: description: >- The target currency amount. Equivalent to one unit of the source currency. Formatted as integer or decimal value with one to 15 digits to the right of the decimal point. type: string minLength: 0 maxLength: 2147483647 pattern: ^[\S\s]*$ refund_status_details: title: refund_status_details description: The details of the refund status. type: object properties: reason: title: Refund Incomplete Reason description: The reason why the refund has the `PENDING` or `FAILED` status. type: string enum: - ECHECK merchant_partner_customer_id: title: merchant_partner_customer_id description: The unique ID for a customer generated by PayPal. type: string minLength: 1 maxLength: 22 pattern: ^[0-9a-zA-Z_-]+$ item_without_category_tax_or_amount: title: item description: The details for the items to be purchased. type: object required: - name - quantity properties: name: description: The item name or title. type: string minLength: 1 maxLength: 127 pattern: ^[\S\s]*$ quantity: description: The item quantity. Must be a whole number. type: string minLength: 0 maxLength: 10 pattern: ^[1-9][0-9]{0,9}$ description: description: The detailed item description. type: string minLength: 0 maxLength: 2048 pattern: ^[\S\s]*$ sku: description: The stock keeping unit (SKU) for the item. type: string minLength: 0 maxLength: 127 pattern: ^[\S\s]*$ url: description: >- The URL to the item being purchased. Visible to buyer and used in buyer experiences. type: string minLength: 1 maxLength: 2048 format: uri image_url: description: >- The URL of the item's image. File type and size restrictions apply. An image that violates these restrictions will not be honored. type: string minLength: 1 maxLength: 2048 format: uri upc: allOf: - $ref: '#/components/schemas/universal_product_code' - description: The Universal Product Code of the item. billing_plan: $ref: '#/components/schemas/order_billing_plan' authorization_status_details: title: authorization_status_details description: The details of the authorized payment status. type: object properties: reason: title: Authorization Incomplete Reason description: The reason why the authorized status is `PENDING`. type: string enum: - PENDING_REVIEW - DECLINED_BY_RISK_FRAUD_FILTERS responses: 401_error_response: description: Unauthorized. content: application/json: schema: $ref: '#/components/schemas/error' examples: generic: summary: Generic 'Unauthorized' error. description: Example response for unauthorized request. value: name: AUTHENTICATION_FAILURE debug_id: b1d1f06c7246c message: >- Authentication failed due to missing Authorization header, or invalid authentication credentials. 403_error_response: description: Forbidden. content: application/json: schema: $ref: '#/components/schemas/error' examples: generic: summary: Generic 'Forbidden' error. description: Example response for a forbidden request. value: name: NOT_AUTHORIZED debug_id: b1d1f06c7246c message: Authorization failed due to insufficient permissions. 404_error_response: description: Not Found. content: application/json: schema: $ref: '#/components/schemas/error' examples: generic: summary: Generic 'Not Found' error. description: >- Example response for a request to a resource that does not exist. value: name: RESOURCE_NOT_FOUND debug_id: b1d1f06c7246c message: The specified resource does not exist. 500_error_response: description: Internal Server Error. content: application/json: schema: $ref: '#/components/schemas/error' examples: generic: summary: Generic internal server error. description: >- Example response for a request that fails for reasons internal to the server. value: name: INTERNAL_SERVER_ERROR debug_id: b1d1f06c7246c message: An internal server error has occurred. default_response: description: Default response. content: application/json: schema: $ref: '#/components/schemas/error' examples: generic: summary: Default response. description: >- Example catch all response, should not be encountered in practice. value: name: INTERNAL_SERVER_ERROR debug_id: b1d1f06c7246c message: An internal server error has occurred. securitySchemes: Oauth2: type: oauth2 description: Oauth 2.0 authentication flows: clientCredentials: tokenUrl: https://api-m.paypal.com/v1/oauth2/token scopes: https://uri.paypal.com/services/payments/payment: Manage payments and checkout workflow. https://uri.paypal.com/services/payments/payment/reference-transaction: Permission to initiate reference transaction https://uri.paypal.com/services/payments/initiatepayment: Initiates payments and checkout workflows. https://uri.paypal.com/services/payments/orders/deprecating-jssdk-migration-for-limited-merchants: >- Allows client-side integration on Create, Get, Patch, Authorize & Capture Order endpoints. https://uri.paypal.com/services/payments/orders/client_sdk_orders_api: >- Enables secure client-side integration on confirm payment source endpoint https://uri.paypal.com/services/payments/orders/provision-card: Manage card provisioning merchants. ````