forked from LiveCarta/PayPal-PHP-SDK
513 lines
11 KiB
PHP
513 lines
11 KiB
PHP
<?php
|
|
namespace PayPal\Api;
|
|
|
|
use PayPal\Common\PPModel;
|
|
use PayPal\Rest\ApiContext;
|
|
use PayPal\Rest\IResource;
|
|
use PayPal\Api\CreditCardHistory;
|
|
use PayPal\Transport\PPRestCall;
|
|
|
|
class CreditCard extends PPModel implements IResource {
|
|
|
|
private static $credential;
|
|
|
|
/**
|
|
*
|
|
* @deprecated. Pass ApiContext to create/get methods instead
|
|
*/
|
|
public static function setCredential($credential) {
|
|
self::$credential = $credential;
|
|
}
|
|
|
|
/**
|
|
* ID of the credit card being saved for later use.
|
|
*
|
|
* @param string $id
|
|
*/
|
|
public function setId($id) {
|
|
$this->id = $id;
|
|
return $this;
|
|
}
|
|
|
|
/**
|
|
* ID of the credit card being saved for later use.
|
|
*
|
|
* @return string
|
|
*/
|
|
public function getId() {
|
|
return $this->id;
|
|
}
|
|
|
|
|
|
/**
|
|
* Card number.
|
|
*
|
|
* @param string $number
|
|
*/
|
|
public function setNumber($number) {
|
|
$this->number = $number;
|
|
return $this;
|
|
}
|
|
|
|
/**
|
|
* Card number.
|
|
*
|
|
* @return string
|
|
*/
|
|
public function getNumber() {
|
|
return $this->number;
|
|
}
|
|
|
|
|
|
/**
|
|
* Type of the Card (eg. Visa, Mastercard, etc.).
|
|
*
|
|
* @param string $type
|
|
*/
|
|
public function setType($type) {
|
|
$this->type = $type;
|
|
return $this;
|
|
}
|
|
|
|
/**
|
|
* Type of the Card (eg. Visa, Mastercard, etc.).
|
|
*
|
|
* @return string
|
|
*/
|
|
public function getType() {
|
|
return $this->type;
|
|
}
|
|
|
|
|
|
/**
|
|
* card expiry month with value 1 - 12.
|
|
*
|
|
* @param integer $expire_month
|
|
*/
|
|
public function setExpireMonth($expire_month) {
|
|
$this->expire_month = $expire_month;
|
|
return $this;
|
|
}
|
|
|
|
/**
|
|
* card expiry month with value 1 - 12.
|
|
*
|
|
* @return integer
|
|
*/
|
|
public function getExpireMonth() {
|
|
return $this->expire_month;
|
|
}
|
|
|
|
/**
|
|
* card expiry month with value 1 - 12.
|
|
*
|
|
* @param integer $expire_month
|
|
* @deprecated. Instead use setExpireMonth
|
|
*/
|
|
public function setExpire_month($expire_month) {
|
|
$this->expire_month = $expire_month;
|
|
return $this;
|
|
}
|
|
/**
|
|
* card expiry month with value 1 - 12.
|
|
*
|
|
* @return integer
|
|
* @deprecated. Instead use getExpireMonth
|
|
*/
|
|
public function getExpire_month() {
|
|
return $this->expire_month;
|
|
}
|
|
|
|
/**
|
|
* 4 digit card expiry year
|
|
*
|
|
* @param integer $expire_year
|
|
*/
|
|
public function setExpireYear($expire_year) {
|
|
$this->expire_year = $expire_year;
|
|
return $this;
|
|
}
|
|
|
|
/**
|
|
* 4 digit card expiry year
|
|
*
|
|
* @return integer
|
|
*/
|
|
public function getExpireYear() {
|
|
return $this->expire_year;
|
|
}
|
|
|
|
/**
|
|
* 4 digit card expiry year
|
|
*
|
|
* @param integer $expire_year
|
|
* @deprecated. Instead use setExpireYear
|
|
*/
|
|
public function setExpire_year($expire_year) {
|
|
$this->expire_year = $expire_year;
|
|
return $this;
|
|
}
|
|
/**
|
|
* 4 digit card expiry year
|
|
*
|
|
* @return integer
|
|
* @deprecated. Instead use getExpireYear
|
|
*/
|
|
public function getExpire_year() {
|
|
return $this->expire_year;
|
|
}
|
|
|
|
/**
|
|
* Card validation code. Only supported when making a Payment but not when saving a credit card for future use.
|
|
*
|
|
* @param string $cvv2
|
|
*/
|
|
public function setCvv2($cvv2) {
|
|
$this->cvv2 = $cvv2;
|
|
return $this;
|
|
}
|
|
|
|
/**
|
|
* Card validation code. Only supported when making a Payment but not when saving a credit card for future use.
|
|
*
|
|
* @return string
|
|
*/
|
|
public function getCvv2() {
|
|
return $this->cvv2;
|
|
}
|
|
|
|
|
|
/**
|
|
* Card holder's first name.
|
|
*
|
|
* @param string $first_name
|
|
*/
|
|
public function setFirstName($first_name) {
|
|
$this->first_name = $first_name;
|
|
return $this;
|
|
}
|
|
|
|
/**
|
|
* Card holder's first name.
|
|
*
|
|
* @return string
|
|
*/
|
|
public function getFirstName() {
|
|
return $this->first_name;
|
|
}
|
|
|
|
/**
|
|
* Card holder's first name.
|
|
*
|
|
* @param string $first_name
|
|
* @deprecated. Instead use setFirstName
|
|
*/
|
|
public function setFirst_name($first_name) {
|
|
$this->first_name = $first_name;
|
|
return $this;
|
|
}
|
|
/**
|
|
* Card holder's first name.
|
|
*
|
|
* @return string
|
|
* @deprecated. Instead use getFirstName
|
|
*/
|
|
public function getFirst_name() {
|
|
return $this->first_name;
|
|
}
|
|
|
|
/**
|
|
* Card holder's last name.
|
|
*
|
|
* @param string $last_name
|
|
*/
|
|
public function setLastName($last_name) {
|
|
$this->last_name = $last_name;
|
|
return $this;
|
|
}
|
|
|
|
/**
|
|
* Card holder's last name.
|
|
*
|
|
* @return string
|
|
*/
|
|
public function getLastName() {
|
|
return $this->last_name;
|
|
}
|
|
|
|
/**
|
|
* Card holder's last name.
|
|
*
|
|
* @param string $last_name
|
|
* @deprecated. Instead use setLastName
|
|
*/
|
|
public function setLast_name($last_name) {
|
|
$this->last_name = $last_name;
|
|
return $this;
|
|
}
|
|
/**
|
|
* Card holder's last name.
|
|
*
|
|
* @return string
|
|
* @deprecated. Instead use getLastName
|
|
*/
|
|
public function getLast_name() {
|
|
return $this->last_name;
|
|
}
|
|
|
|
/**
|
|
* Billing Address associated with this card.
|
|
*
|
|
* @param PayPal\Api\Address $billing_address
|
|
*/
|
|
public function setBillingAddress($billing_address) {
|
|
$this->billing_address = $billing_address;
|
|
return $this;
|
|
}
|
|
|
|
/**
|
|
* Billing Address associated with this card.
|
|
*
|
|
* @return PayPal\Api\Address
|
|
*/
|
|
public function getBillingAddress() {
|
|
return $this->billing_address;
|
|
}
|
|
|
|
/**
|
|
* Billing Address associated with this card.
|
|
*
|
|
* @param PayPal\Api\Address $billing_address
|
|
* @deprecated. Instead use setBillingAddress
|
|
*/
|
|
public function setBilling_address($billing_address) {
|
|
$this->billing_address = $billing_address;
|
|
return $this;
|
|
}
|
|
/**
|
|
* Billing Address associated with this card.
|
|
*
|
|
* @return PayPal\Api\Address
|
|
* @deprecated. Instead use getBillingAddress
|
|
*/
|
|
public function getBilling_address() {
|
|
return $this->billing_address;
|
|
}
|
|
|
|
/**
|
|
* A unique identifier of the payer generated and provided by the facilitator. This is required when creating or using a tokenized funding instrument.
|
|
*
|
|
* @param string $payer_id
|
|
*/
|
|
public function setPayerId($payer_id) {
|
|
$this->payer_id = $payer_id;
|
|
return $this;
|
|
}
|
|
|
|
/**
|
|
* A unique identifier of the payer generated and provided by the facilitator. This is required when creating or using a tokenized funding instrument.
|
|
*
|
|
* @return string
|
|
*/
|
|
public function getPayerId() {
|
|
return $this->payer_id;
|
|
}
|
|
|
|
/**
|
|
* A unique identifier of the payer generated and provided by the facilitator. This is required when creating or using a tokenized funding instrument.
|
|
*
|
|
* @param string $payer_id
|
|
* @deprecated. Instead use setPayerId
|
|
*/
|
|
public function setPayer_id($payer_id) {
|
|
$this->payer_id = $payer_id;
|
|
return $this;
|
|
}
|
|
/**
|
|
* A unique identifier of the payer generated and provided by the facilitator. This is required when creating or using a tokenized funding instrument.
|
|
*
|
|
* @return string
|
|
* @deprecated. Instead use getPayerId
|
|
*/
|
|
public function getPayer_id() {
|
|
return $this->payer_id;
|
|
}
|
|
|
|
/**
|
|
* State of the funding instrument.
|
|
*
|
|
* @param string $state
|
|
*/
|
|
public function setState($state) {
|
|
$this->state = $state;
|
|
return $this;
|
|
}
|
|
|
|
/**
|
|
* State of the funding instrument.
|
|
*
|
|
* @return string
|
|
*/
|
|
public function getState() {
|
|
return $this->state;
|
|
}
|
|
|
|
|
|
/**
|
|
* Date/Time until this resource can be used fund a payment.
|
|
*
|
|
* @param string $valid_until
|
|
*/
|
|
public function setValidUntil($valid_until) {
|
|
$this->valid_until = $valid_until;
|
|
return $this;
|
|
}
|
|
|
|
/**
|
|
* Date/Time until this resource can be used fund a payment.
|
|
*
|
|
* @return string
|
|
*/
|
|
public function getValidUntil() {
|
|
return $this->valid_until;
|
|
}
|
|
|
|
/**
|
|
* Date/Time until this resource can be used fund a payment.
|
|
*
|
|
* @param string $valid_until
|
|
* @deprecated. Instead use setValidUntil
|
|
*/
|
|
public function setValid_until($valid_until) {
|
|
$this->valid_until = $valid_until;
|
|
return $this;
|
|
}
|
|
/**
|
|
* Date/Time until this resource can be used fund a payment.
|
|
*
|
|
* @return string
|
|
* @deprecated. Instead use getValidUntil
|
|
*/
|
|
public function getValid_until() {
|
|
return $this->valid_until;
|
|
}
|
|
|
|
/**
|
|
*
|
|
*
|
|
* @array
|
|
* @param PayPal\Api\Links $links
|
|
*/
|
|
public function setLinks($links) {
|
|
$this->links = $links;
|
|
return $this;
|
|
}
|
|
|
|
/**
|
|
*
|
|
*
|
|
* @return PayPal\Api\Links
|
|
*/
|
|
public function getLinks() {
|
|
return $this->links;
|
|
}
|
|
|
|
|
|
|
|
/*
|
|
* Creates a new Credit Card Resource (aka Tokenize).
|
|
*
|
|
* @param PayPal\Rest\ApiContext $apiContext is the APIContext for this call. It can be used to pass dynamic configuration and credentials.
|
|
* @return CreditCard
|
|
*/
|
|
public function create($apiContext = null) {
|
|
$payLoad = $this->toJSON();
|
|
if ($apiContext == null) {
|
|
$apiContext = new ApiContext(self::$credential);
|
|
}
|
|
$call = new PPRestCall($apiContext);
|
|
$json = $call->execute(array('PayPal\Rest\RestHandler'), "/v1/vault/credit-card", "POST", $payLoad);
|
|
$this->fromJson($json);
|
|
return $this;
|
|
}
|
|
|
|
/*
|
|
* Obtain the Credit Card resource for the given identifier.
|
|
*
|
|
* @param string $creditCardId
|
|
* @param PayPal\Rest\ApiContext $apiContext is the APIContext for this call. It can be used to pass dynamic configuration and credentials.
|
|
* @return CreditCard
|
|
*/
|
|
public static function get($creditCardId, $apiContext = null) {
|
|
if (($creditCardId == null) || (strlen($creditCardId) <= 0)) {
|
|
throw new \InvalidArgumentException("creditCardId cannot be null or empty");
|
|
}
|
|
$payLoad = "";
|
|
if ($apiContext == null) {
|
|
$apiContext = new ApiContext(self::$credential);
|
|
}
|
|
$call = new PPRestCall($apiContext);
|
|
$json = $call->execute(array('PayPal\Rest\RestHandler'), "/v1/vault/credit-card/$creditCardId", "GET", $payLoad);
|
|
$ret = new CreditCard();
|
|
$ret->fromJson($json);
|
|
return $ret;
|
|
}
|
|
|
|
/*
|
|
* Delete the Credit Card resource for the given identifier.
|
|
*
|
|
* @param PayPal\Rest\ApiContext $apiContext is the APIContext for this call. It can be used to pass dynamic configuration and credentials.
|
|
* @return void
|
|
*/
|
|
public function delete($apiContext = null) {
|
|
if ($this->getId() == null) {
|
|
throw new \InvalidArgumentException("Id cannot be null");
|
|
}
|
|
$payLoad = "";
|
|
if ($apiContext == null) {
|
|
$apiContext = new ApiContext(self::$credential);
|
|
}
|
|
$call = new PPRestCall($apiContext);
|
|
$json = $call->execute(array('PayPal\Rest\RestHandler'), "/v1/vault/credit-card/{$this->getId()}", "DELETE", $payLoad);
|
|
return;
|
|
}
|
|
|
|
/*
|
|
* Update information in a previously saved card. Only the modified fields need to be passed in the request.
|
|
*
|
|
* @param PayPal\Rest\ApiContext $apiContext is the APIContext for this call. It can be used to pass dynamic configuration and credentials.
|
|
* @return CreditCard
|
|
*/
|
|
public function update($apiContext = null) {
|
|
if ($this->getId() == null) {
|
|
throw new \InvalidArgumentException("Id cannot be null");
|
|
}
|
|
$payLoad = $this->toJSON();
|
|
if ($apiContext == null) {
|
|
$apiContext = new ApiContext(self::$credential);
|
|
}
|
|
$call = new PPRestCall($apiContext);
|
|
$json = $call->execute(array('PayPal\Rest\RestHandler'), "/v1/vault/credit-card/{$this->getId()}", "PATCH", $payLoad);
|
|
$this->fromJson($json);
|
|
return $this;
|
|
}
|
|
|
|
/*
|
|
* Retrieves a list of Credit Card resources.
|
|
*
|
|
* @param PayPal\Rest\ApiContext $apiContext is the APIContext for this call. It can be used to pass dynamic configuration and credentials.
|
|
* @return CreditCardHistory
|
|
*/
|
|
public static function all($apiContext = null) {
|
|
$payLoad = "";
|
|
if ($apiContext == null) {
|
|
$apiContext = new ApiContext(self::$credential);
|
|
}
|
|
$call = new PPRestCall($apiContext);
|
|
$json = $call->execute(array('PayPal\Rest\RestHandler'), "/v1/vault/credit-card", "GET", $payLoad);
|
|
$ret = new CreditCardHistory();
|
|
$ret->fromJson($json);
|
|
return $ret;
|
|
}
|
|
}
|