Payment Source

The payment source definition. To be eligible to create subscription using debit or credit card, you will need to sign up here (https://www.paypal.com/bizsignup/entry/product/ppcp). Please note, its available only for non-3DS cards and for merchants in US and AU regions.

Schema Information

Type:object

Properties

card

Type: object

The payment card to use to fund a payment. Can be a credit or debit card.

name

Type: string

Pattern: ^.{1,300}$

Min length: 1

Max length: 300

The card holder's name as it appears on the card.

number

Type: string

Pattern: ^[0-9]{13,19}$

Min length: 13

Max length: 19

The primary account number (PAN) for the payment card.

expiry

Type: string

Pattern: ^[0-9]{4}-(0[1-9]|1[0-2])$

Min length: 7

Max length: 7

The card expiration year and month, in Internet date format For example: 2028-04

security_code

Type: string

Pattern: ^[0-9]{3,4}$

Min length: 3

Max length: 4

The three- or four-digit security code of the card. Also known as the CVV, CVC, CVN, CVE, or CID. This parameter cannot be present in the request when payment_initiator=MERCHANT.

type

Type: string

Enum: "CREDIT", "DEBIT", "PREPAID", "STORE", "UNKNOWN"

Pattern: ^[A-Z_]+$

Min length: 1

Max length: 255

The payment card type.

brand

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", "UNKNOWN"

Pattern: ^[A-Z_]+$

Min length: 1

Max length: 255

The card brand or network. Typically used in the response.

billing_address

Type: object

The portable international postal address. Maps to AddressValidationMetadata and HTML 5.1 Autofilling form controls: the autocomplete attribute.

address_line_1

Type: string

Max length: 300

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.

address_line_2

Type: string

Max length: 300

The second line of the address, for example, a suite or apartment number.

admin_area_2

Type: string

Max length: 120

A city, town, or village. Smaller than admin_area_level_1.

admin_area_1

Type: string

Max length: 300

The highest-level sub-division in a country, which is usually a province, state, or ISO-3166-2 subdivision. This data is formatted for postal delivery, for example, CA and not California. Value, by country, is:

UK. A county.
US. A state.
Canada. A province.
Japan. A prefecture.
Switzerland. A kanton.

postal_code

Type: string

Max length: 60

The postal code, which is the ZIP code or equivalent. Typically required for countries with a postal code or an equivalent. See postal code.

country_coderequired

Type: string

Format: ppaas_common_country_code_v2

Pattern: ^([A-Z]{2}|C2)$

Min length: 2

Max length: 2

The 2-character ISO 3166-1 code 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.

attributes

Type: object

Additional attributes associated with the use of this card.

customer

Type: object

The details about a customer in PayPal's system of record.

id

Type: string

Pattern: ^[0-9a-zA-Z_-]+$

Min length: 1

Max length: 22

The unique ID for a customer generated by PayPal.

email_address

Type: string

Format: merchant_common_email_address_v2

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])+)\])

Min length: 3

Max length: 254

Email address of the buyer 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. For all other use cases we do not expect partners/merchant to send email_address of their customer.

phone

Type: object

The phone number of the buyer as provided to the merchant or on file with the merchant. The phone.phone_number supports only national_number.

phone_type

Type: string

Enum: "FAX", "HOME", "MOBILE", "OTHER", "PAGER"

The phone type.

phone_numberrequired

Type: object

The phone number, in its canonical international E.164 numbering plan format.

national_numberrequired

Type: string

Pattern: ^[0-9]{1,14}?$

Min length: 1

Max length: 14

The national number, in its canonical international E.164 numbering plan format. 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).

merchant_customer_id

Type: string

Pattern: ^[0-9a-zA-Z-_.^*$@#]+$

Min length: 1

Max length: 64

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.

vault

Type: object

Instruction to vault the card based on the specified strategy.

store_in_vault

Type: string

Enum: "ON_SUCCESS"

Pattern: ^[0-9A-Z_]+$

Min length: 1

Max length: 255

Defines how and when the payment source gets vaulted.

verification

Type: object

Instruction to optionally verify the card based on the specified strategy.

method

Type: string

Enum: "SCA_ALWAYS", "SCA_WHEN_REQUIRED", "3D_SECURE", "AVS_CVV"

Pattern: ^[0-9A-Z_]+$

Min length: 1

Max length: 255

Default: "SCA_WHEN_REQUIRED"

The method used for card verification.

Properties

card

Type: object

The payment card to use to fund a payment. Can be a credit or debit card.

name

Type: string

Pattern: ^.{1,300}$

Min length: 1

Max length: 300

The card holder's name as it appears on the card.

number

Type: string

Pattern: ^[0-9]{13,19}$

Min length: 13

Max length: 19

The primary account number (PAN) for the payment card.

expiry

Type: string

Pattern: ^[0-9]{4}-(0[1-9]|1[0-2])$

Min length: 7

Max length: 7

The card expiration year and month, in Internet date format For example: 2028-04

security_code

Type: string

Pattern: ^[0-9]{3,4}$

Min length: 3

Max length: 4

The three- or four-digit security code of the card. Also known as the CVV, CVC, CVN, CVE, or CID. This parameter cannot be present in the request when payment_initiator=MERCHANT.

type

Type: string

Enum: "CREDIT", "DEBIT", "PREPAID", "STORE", "UNKNOWN"

Pattern: ^[A-Z_]+$

Min length: 1

Max length: 255

The payment card type.

brand

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", "UNKNOWN"

Pattern: ^[A-Z_]+$

Min length: 1

Max length: 255

The card brand or network. Typically used in the response.

billing_address

Type: object

The portable international postal address. Maps to AddressValidationMetadata and HTML 5.1 Autofilling form controls: the autocomplete attribute.

address_line_1

Type: string

Max length: 300

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.

address_line_2

Type: string

Max length: 300

The second line of the address, for example, a suite or apartment number.

admin_area_2

Type: string

Max length: 120

A city, town, or village. Smaller than admin_area_level_1.

admin_area_1

Type: string

Max length: 300

UK. A county.
US. A state.
Canada. A province.
Japan. A prefecture.
Switzerland. A kanton.

postal_code

Type: string

Max length: 60

The postal code, which is the ZIP code or equivalent. Typically required for countries with a postal code or an equivalent. See postal code.

country_coderequired

Type: string

Format: ppaas_common_country_code_v2

Pattern: ^([A-Z]{2}|C2)$

Min length: 2

Max length: 2

The 2-character ISO 3166-1 code 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.

attributes

Type: object

Additional attributes associated with the use of this card.

customer

Type: object

The details about a customer in PayPal's system of record.

id

Type: string

Pattern: ^[0-9a-zA-Z_-]+$

Min length: 1

Max length: 22

The unique ID for a customer generated by PayPal.

email_address

Type: string

Format: merchant_common_email_address_v2

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])+)\])

Min length: 3

Max length: 254

phone

Type: object

The phone number of the buyer as provided to the merchant or on file with the merchant. The phone.phone_number supports only national_number.

phone_type

Type: string

Enum: "FAX", "HOME", "MOBILE", "OTHER", "PAGER"

The phone type.

phone_numberrequired

Type: object

The phone number, in its canonical international E.164 numbering plan format.

national_numberrequired

Type: string

Pattern: ^[0-9]{1,14}?$

Min length: 1

Max length: 14

merchant_customer_id

Type: string

Pattern: ^[0-9a-zA-Z-_.^*$@#]+$

Min length: 1

Max length: 64

vault

Type: object

Instruction to vault the card based on the specified strategy.

store_in_vault

Type: string

Enum: "ON_SUCCESS"

Pattern: ^[0-9A-Z_]+$

Min length: 1

Max length: 255

Defines how and when the payment source gets vaulted.

verification

Type: object

Instruction to optionally verify the card based on the specified strategy.

method

Type: string

Enum: "SCA_ALWAYS", "SCA_WHEN_REQUIRED", "3D_SECURE", "AVS_CVV"

Pattern: ^[0-9A-Z_]+$

Min length: 1

Max length: 255

Default: "SCA_WHEN_REQUIRED"

The method used for card verification.

Payment Source

Schema Information

Properties

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

Payment Source

Schema Information

Properties