Manage payment options

Get the shopper payment options

Retrieve all of the payment options configured for a shopper.

GEThttps://api.digitalriver.com/v1/shoppers/me/payment-options

Query parameters

Response

200401

Successful response.

Body

application/json

one of

PaymentOptionsResponsePaymentSource (object)PaymentOptionsResponsePaymentSourceExpand (object)PaymentOptionsResponseLegacy (object)PaymentOptionsResponseLegacyExpand (object)

Request

JavaScriptCurlPython

const response = await fetch('https://api.digitalriver.com/v1/shoppers/me/payment-options', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200401

{
  "paymentOptions": {
    "uri": "https://api.digitalriver.com/v1/shoppers/me/payment-options",
    "paymentOption": [
      {
        "sourceId": "a231f38d-3a07-4a13-96ed-89693ba7d56c",
        "uri": "https://api.digitalriver.com/v1/shoppers/me/payment-options/740865108",
        "id": 15699113789,
        "nickName": "Default",
        "isDefault": "true"
      }
    ]
  }
}

Create the shopper payment options

Create a payment options for a shopper.

POSThttps://api.digitalriver.com/v1/shoppers/me/payment-options

Query parameters

Body

application/json

Payment method for cart.

one of

PaymentOptionsRequestPaymentSource (object)PaymentOptionsRequestLegacy (object)

Response

201204400401409

Created (Payment Source, contact your Digital River team to set up)

Body

application/json

uristring

Example: "https://api.digitalriver.com/v1/shoppers/me/payment-options/740865108"

idnumber

Example: 740865108

nickNamestring

Example: "Default"

isDefaultstring

Example: "true"

typestring

Example: "creditCard"

sourceIdstring

A unique identifier for the payment source.

Example: "a231f38d-3a07-4a13-96ed-89693ba7d56c"

sourceClientSecretstring

The unique client secret for the payment source.

Example: "a231f38d-3a07-4a13-96ed-89693ba7d56c_f6d8c951-59c9-4ef3-ac45-9f33c77d2f46"

creditCardobject

Request

JavaScriptCurlPython

const response = await fetch('https://api.digitalriver.com/v1/shoppers/me/payment-options', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

201400401409

{
  "uri": "https://api.digitalriver.com/v1/shoppers/me/payment-options/740865108",
  "id": 740865108,
  "nickName": "Default",
  "isDefault": "true",
  "type": "creditCard",
  "sourceId": "a231f38d-3a07-4a13-96ed-89693ba7d56c",
  "sourceClientSecret": "a231f38d-3a07-4a13-96ed-89693ba7d56c_f6d8c951-59c9-4ef3-ac45-9f33c77d2f46",
  "creditCard": {
    "expirationYear": "2030",
    "lastFourDigits": "0000",
    "clientSecret": "a231f38d-3a07-4a13-96ed-89693ba7d56c_f6d8c951-59c9-4ef3-ac45-9f33c77d2f46",
    "expirationMonth": "08",
    "fundingSource": "debit",
    "brand": "Visa",
    "reusable": "true"
  }
}

Get the shopper payment option

Get a payment option by the ID specified in the {paymentOptionId} URI path parameter.

GEThttps://api.digitalriver.com/v1/shoppers/me/payment-options/{paymentOptionId}

Path parameters

paymentOptionId*string

Payment Option ID.

Query parameters

Response

200401

Successful response.

Body

application/json

one of

PaymentOptionsIDResponsePaymentSource (object)PaymentOptionsIDResponsePaymentSourceExpand (object)PaymentOptionsIDResponseLegacy (object)PaymentOptionsIDResponseLegacyExpand (object)

Request

JavaScriptCurlPython

const response = await fetch('https://api.digitalriver.com/v1/shoppers/me/payment-options/{paymentOptionId}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200401

{
  "paymentOption": {
    "sourceId": "a231f38d-3a07-4a13-96ed-89693ba7d56c",
    "sourceClientSecret": "a231f38d-3a07-4a13-96ed-89693ba7d56c_f6d8c951-59c9-4ef3-ac45-9f33c77d2f46",
    "uri": "https://api.digitalriver.com/v1/shoppers/me/payment-options/740865108",
    "id": 740865108,
    "nickName": "Default",
    "isDefault": "true",
    "type": "CreditCardMethod",
    "creditCard": {
      "expirationMonth": "1",
      "expirationYear": "2030",
      "brand": "Visa",
      "lastFourDigits": "1234"
    }
  }
}

Update the shopper's payment options

To update a shopper's payment option, provide the payment option identifier in the {paymentOptionId} URI path parameter.

POSThttps://api.digitalriver.com/v1/shoppers/me/payment-options/{paymentOptionId}

Path parameters

paymentOptionId*string

Payment Option ID.

Query parameters

Body

application/json

Payment method for cart.

one of

PaymentOptionsRequestPaymentSource (object)PaymentOptionsRequestLegacy (object)

Response

201204400401409

Created (Payment Source, contact your Digital River team to set up)

Body

application/json

uristring

Example: "https://api.digitalriver.com/v1/shoppers/me/payment-options/740865108"

idnumber

Example: 740865108

nickNamestring

Example: "Default"

isDefaultstring

Example: "true"

typestring

Example: "creditCard"

sourceIdstring

A unique identifier for the payment source.

Example: "a231f38d-3a07-4a13-96ed-89693ba7d56c"

sourceClientSecretstring

The unique client secret for the payment source.

Example: "a231f38d-3a07-4a13-96ed-89693ba7d56c_f6d8c951-59c9-4ef3-ac45-9f33c77d2f46"

creditCardobject

Request

JavaScriptCurlPython

const response = await fetch('https://api.digitalriver.com/v1/shoppers/me/payment-options/{paymentOptionId}', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

201400401409

{
  "uri": "https://api.digitalriver.com/v1/shoppers/me/payment-options/740865108",
  "id": 740865108,
  "nickName": "Default",
  "isDefault": "true",
  "type": "creditCard",
  "sourceId": "a231f38d-3a07-4a13-96ed-89693ba7d56c",
  "sourceClientSecret": "a231f38d-3a07-4a13-96ed-89693ba7d56c_f6d8c951-59c9-4ef3-ac45-9f33c77d2f46",
  "creditCard": {
    "expirationYear": "2030",
    "lastFourDigits": "0000",
    "clientSecret": "a231f38d-3a07-4a13-96ed-89693ba7d56c_f6d8c951-59c9-4ef3-ac45-9f33c77d2f46",
    "expirationMonth": "08",
    "fundingSource": "debit",
    "brand": "Visa",
    "reusable": "true"
  }
}