1
0
Files
PayPal-PHP-Server-SDK/doc/models/subscription-card-request.md
Patrick Powers 1fc2cf1e07 2.0.0 Release (#58)
* Automated commit message

* Automated commit message

* add changelog

---------

Co-authored-by: PayPalServerSDKs <server-sdks@paypal.com>
2025-11-13 16:32:53 -06:00

2.9 KiB

Subscription Card Request

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

Structure

SubscriptionCardRequest

Fields

Name Type Tags Description Getter Setter
name ?string Optional The card holder's name as it appears on the card.

Constraints: Minimum Length: 1, Maximum Length: 300, Pattern: ^.{1,300}$
getName(): ?string setName(?string name): void
number ?string Optional The primary account number (PAN) for the payment card.

Constraints: Minimum Length: 13, Maximum Length: 19, Pattern: ^[0-9]{13,19}$
getNumber(): ?string setNumber(?string number): void
expiry ?string Optional The year and month, in ISO-8601 YYYY-MM date format. See Internet date and time format.

Constraints: Minimum Length: 7, Maximum Length: 7, Pattern: ^[0-9]{4}-(0[1-9]|1[0-2])$
getExpiry(): ?string setExpiry(?string expiry): void
securityCode ?string Optional 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.

Constraints: Minimum Length: 3, Maximum Length: 4, Pattern: ^[0-9]{3,4}$
getSecurityCode(): ?string setSecurityCode(?string securityCode): void
type ?string(CardType) Optional Type of card. i.e Credit, Debit and so on.

Constraints: Minimum Length: 1, Maximum Length: 255, Pattern: ^[A-Z_]+$
getType(): ?string setType(?string type): void
brand ?string(SubscriptionsCardBrand) Optional The card network or brand. Applies to credit, debit, gift, and payment cards.

Constraints: Minimum Length: 1, Maximum Length: 255, Pattern: ^[A-Z_]+$
getBrand(): ?string setBrand(?string brand): void
billingAddress ?Address Optional The portable international postal address. Maps to AddressValidationMetadata and HTML 5.1 Autofilling form controls: the autocomplete attribute. getBillingAddress(): ?Address setBillingAddress(?Address billingAddress): void
attributes ?SubscriptionsCardAttributes Optional Additional attributes associated with the use of this card. getAttributes(): ?SubscriptionsCardAttributes setAttributes(?SubscriptionsCardAttributes attributes): void

Example (as JSON)

{
  "name": "name6",
  "number": "number6",
  "expiry": "expiry4",
  "security_code": "security_code8",
  "type": "UNKNOWN"
}