Payment Options

A payment option is the type of payment method chosen by the shopper to purchase a product, such as a credit card. The Payment Options API provides access to a shopper's payment options and payment option data. Use the Payment Options API to get a specific payment option or get all payment options.

Resource URIs

All methods in this resource require a full access token.

Methods


					Host: api.digitalriver.com
User-Agent: API Client/1.0
Accept: */*
Authorization: bearer your_access_token
			
					The request body should be empty.
			
					HTTP/1.1 200 OK
			
					<paymentOptions uri="https://api.digitalriver.com/v1/shoppers/me/payment-options">
   <paymentOption uri="https://api.digitalriver.com/v1/shoppers/me/payment-option/9999999999">
      <id>payment_option_ID</id>
      <type>visa</type>
      <nickName>My Visa</nickName>
   </paymentOption>
   <paymentOption uri="https://api.digitalriver.com/v1/shoppers/me/payment-option/1111111111">
      <id>payment_option_ID</id>
      <type>masterCard</type>
      <nickName>My Master Card</nickName>
   </paymentOption>
</paymentOptions>
			
					Host: api.digitalriver.com
User-Agent: API Client/1.0
Accept: */*
Authorization: bearer your_access_token
			
					The request body should be empty.
			
					HTTP/1.1 200 OK
			
					<paymentOption relation="https://api.digitalriver.com/v1/shoppers/PaymentOptionsResource" uri="https://api.digitalriver.com/v1/shoppers/me/payment-options/10461291389">
   <id>10461291389</id>
   <nickName>PayPalExpress Checkout</nickName>
   <isDefault>false</isDefault>
   <type>CreditCardMethod</type>
   <creditCard>
      <expirationMonth>5</expirationMonth>
      <expirationYear>2017</expirationYear>
      <displayableNumber>************1111</displayableNumber>
      <type>visa</type>
      <displayName>Visa</displayName>
   </creditCard>
</paymentOption>
			

Response Body Parameters

Field
Data Type
Visibility
Descriptions
creditCard
structured
default
The credit card payment type for the payment option.
creditCard.expirationMonth
string
default
 A 2-digit value that represents the month when a credit card expires. Possible values: 1 = January, .... 12 = December.
creditCard.expirationYear
string
default
A 4-digit credit card expiration year (for example, 2017).
creditCard.name string default The name associated with the shopper's credit card.
creditCard.type
string default The type of credit card. Possible values are as follows:
MasterCard, Visa, Discover, AmericanExpress, DinersClub, SwitchSolo, JCB
id string default The payment option ID. The ID is assigned automatically when the payment option is created.
isDefault
Boolean default When true the payment option is the shopper's default payment option.
nickName string default The nickname associated with the payment option (for example, personal, joint, or business).
paymentOption link default A specific payment option.
paymentOptions link default The shopper's payment options. For more information, see the Payment Options API. Only available for authenticated shopper sessions. Expandable.