1
0
Files
PayPal-PHP-Server-SDK/doc/models/card-response.md
Patrick Powers 504c367386 Release 0.7.0
Beta Release 0.7.0 including:

- Bug fixes
- Updated model/function names
- Updated models to reflect changes in APIs
2025-03-20 13:18:55 -05:00

3.9 KiB

Card Response

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

Structure

CardResponse

Fields

Name Type Tags Description Getter Setter
name ?string Optional The card holder's name as it appears on the card.
Constraints: Minimum Length: 2, Maximum Length: 300
getName(): ?string setName(?string name): void
lastDigits ?string Optional The last digits of the payment card.
Constraints: Pattern: [0-9]{2,}
getLastDigits(): ?string setLastDigits(?string lastDigits): void
brand ?string(CardBrand) 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
availableNetworks ?(string(CardBrand)[]) Optional Array of brands or networks associated with the card.
Constraints: Minimum Items: 1, Maximum Items: 256, Minimum Length: 1, Maximum Length: 255, Pattern: ^[A-Z_]+$
getAvailableNetworks(): ?array setAvailableNetworks(?array availableNetworks): 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
authenticationResult ?AuthenticationResponse Optional Results of Authentication such as 3D Secure. getAuthenticationResult(): ?AuthenticationResponse setAuthenticationResult(?AuthenticationResponse authenticationResult): void
attributes ?CardAttributesResponse Optional Additional attributes associated with the use of this card. getAttributes(): ?CardAttributesResponse setAttributes(?CardAttributesResponse attributes): void
fromRequest ?CardFromRequest Optional Representation of card details as received in the request. getFromRequest(): ?CardFromRequest setFromRequest(?CardFromRequest fromRequest): 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
binDetails ?BinDetails Optional Bank Identification Number (BIN) details used to fund a payment. getBinDetails(): ?BinDetails setBinDetails(?BinDetails binDetails): void
storedCredential ?CardStoredCredential Optional 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: payment_type=ONE_TIME is compatible only with payment_initiator=CUSTOMER. usage=FIRST is compatible only with payment_initiator=CUSTOMER. previous_transaction_reference or previous_network_transaction_reference is compatible only with payment_initiator=MERCHANT. Only one of the parameters - previous_transaction_reference and previous_network_transaction_reference - can be present in the request. getStoredCredential(): ?CardStoredCredential setStoredCredential(?CardStoredCredential storedCredential): void

Example (as JSON)

{
  "name": "name0",
  "last_digits": "last_digits4",
  "brand": "UNKNOWN",
  "available_networks": [
    "CONFIDIS",
    "CONFIGOGA",
    "CB_NATIONALE"
  ],
  "type": "CREDIT"
}