Sections

Business Platforms and marketplaces Enterprise

Help

FAQs Account help Technical support API Status

APIs & SDKs

JavaScript SDK React SDK REST API Server SDKs Codes Webhook events iOS Android

Bank Request

A Resource representing a request to vault a Bank used for ACH Debit.

ach_debitobject<ach_debit_request>Optional

ACH Debit Instrument Details to be vaulted as the payment method.

ach_debit_request properties

2 properties

verification_intentach_verification_intentOptional

The API caller can specify the verification intent when vaulting ACH.

verificationach_debit_verificationOptional

The API caller can specify the verification method when vaulting ACH.

sepa_debitobject<sepa_debit_request>Optional

SEPA Debit Instrument Details to be vaulted as the payment method.

sepa_debit_request properties

2 properties

mandate_intentsepa_mandate_intentOptional

experience_contextobject<sepa_debit_experience_context>Optional

Customizes the payer experience during the approval process for the payment.

sepa_debit_experience_context properties

3 properties

localestring<language>Optional

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`.

Match^[a-z]{2}(?:-[A-Z][a-z]{3})?(?:-(?:[A-Z]{2}|[0-9]{3}))?$Formatppaas_common_language_v3Length2 <= length <= 10

return_urlstring<url>Required

The URL where the customer is redirected after the customer approves the payment.

Formaturi

cancel_urlstring<url>Required

The URL where the customer is redirected after the customer cancels the payment.

Formaturi

Back to top

Bank Request

A Resource representing a request to vault a Bank used for ACH Debit.

ach_debitobject<ach_debit_request>Optional

ACH Debit Instrument Details to be vaulted as the payment method.

ach_debit_request properties

2 properties

verification_intentach_verification_intentOptional

The API caller can specify the verification intent when vaulting ACH.

verificationach_debit_verificationOptional

The API caller can specify the verification method when vaulting ACH.

sepa_debitobject<sepa_debit_request>Optional

SEPA Debit Instrument Details to be vaulted as the payment method.

sepa_debit_request properties

2 properties

mandate_intentsepa_mandate_intentOptional

experience_contextobject<sepa_debit_experience_context>Optional

Customizes the payer experience during the approval process for the payment.

sepa_debit_experience_context properties

3 properties

localestring<language>Optional

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`.

Match^[a-z]{2}(?:-[A-Z][a-z]{3})?(?:-(?:[A-Z]{2}|[0-9]{3}))?$Formatppaas_common_language_v3Length2 <= length <= 10

return_urlstring<url>Required

The URL where the customer is redirected after the customer approves the payment.

Formaturi

cancel_urlstring<url>Required

The URL where the customer is redirected after the customer cancels the payment.

Formaturi

Bank Request

ach_debit_request properties

sepa_debit_request properties

sepa_debit_experience_context properties

Back to top

On this page

On this page

Bank Request

ach_debit_request properties

sepa_debit_request properties

sepa_debit_experience_context properties

Back to top

On this page

Bank Request

ach_debit_request properties

sepa_debit_request properties

sepa_debit_experience_context properties

Back to top

On this page

On this page

If you accept cookies, we’ll use them to improve and customize your experience and enable our partners to show you personalized PayPal ads when you visit other sites. Manage cookies and learn more

Bank Request

ach_debit_request properties

sepa_debit_request properties

sepa_debit_experience_context properties

Back to top

On this page