Skip to content
For the complete documentation index, see llms.txt. This page is also available as Markdown.

The payment setting paypal object

A comprehensive list of the payment setting paypal resource's attributes and relationships

A payment setting paypal object is returned as part of the response body of each successful list, retrieve, create or update API call to the /api/2026-05/payment_setting_paypals endpoint.

Fields

Field
Type
Description

type

string

payment_setting_paypals

id

string

The payment setting paypal unique identifier

links.self

string

The payment setting paypal endpoint URL

attributes.gateway_version

string

The gateway version of the payment setting (external API version).

attributes.idempotency_window_mins

integer

The minutes within which a repeated payment operation is deduplicated by the gateway idempotency key. Later attempts get a fresh key.

attributes.internal_versions

object

The internal versions of the payment setting for payload changes.

attributes.internal_versionable

boolean

Indicates whether this payment setting's gateway supports internal payload versioning (see internal_versions).

attributes.auto_capture

boolean

Send this attribute if you want the payment to be automatically captured when authorized.

attributes.auto_place

boolean

Send this attribute if you want the order to be automatically placed when a payment session using this payment setting is authorized.

attributes.status

string

The payment setting status. It is pending until the gateway webhook is configured, either automatically or by providing its secret.

attributes.name

string

The name of the payment setting.

attributes._disable

boolean

Send this attribute if you want to mark this resource as disabled.

attributes._enable

boolean

Send this attribute if you want to mark this resource as enabled.

attributes.disabled_at

string

Time at which this resource was disabled.

attributes.created_at

string

Time at which the resource was created.

attributes.updated_at

string

Time at which the resource was last updated.

attributes.reference

string

A string that you can use to add any external identifier to the resource. This can be useful for integrating the resource to an external system, like an ERP, a marketing tool, a CRM, or whatever.

attributes.reference_origin

string

Any identifier of the third party system that defines the reference code.

attributes.metadata

object

Set of key-value pairs that you can attach to the resource. This can be useful for storing additional information about the resource in a structured format.

attributes._check

boolean

Send this attribute if you want to validate the payment gateway credentials using the gateway’s own APIs.

attributes._provision_webhook

boolean

Send this attribute if you want to retry the automatic creation of the gateway webhook for a pending payment setting.

attributes.client_id

string

The gateway client ID.

attributes.client_secret

string

The gateway client secret.

attributes.webhook_id

string

The gateway webhook ID, generated automatically.

attributes.webhook_endpoint_url

string

The gateway webhook URL, generated automatically.

relationships.payment_links

array

The associated payment links.

relationships.payment_sessions

array

The associated payment sessions.

relationships.payment_transactions

array

The payment transactions associated to available sessions.

relationships.payment_wallets

array

The associated payment wallets.

relationships.order_subscriptions

array

The associated order subscriptions.

relationships.events

array

The associated events.

relationships.event_stores

array

The associated event stores.

Last updated