Payment options

Get the shopper payment options

Retrieve all of the payment options configured for a shopper.

get

/v1/shoppers/me/payment-options

Query parameters

tokenstring

Provide the authorized token for a shopper.

expandstring

Use the expand query parameter when you want additional fields to appear in the response. The expand query parameter provides more fields in the response. Expanding resources reduces the number of API calls required to accomplish a task.

fieldsstring

Specify the fields that you want to appear in the response. Filtering the fields returned in the response can conserve bandwidth and accelerate response time.

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://api.digitalriver.com/v1/shoppers/me/payment-options'

200

401

200

{
  "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"
      }
    ]
  }
}

Successful response.

Create the shopper payment options

Create a payment options for a shopper.

post

/v1/shoppers/me/payment-options

Query parameters

tokenstring

Provide the authorized token for a shopper.

expandstring

Use the expand query parameter when you want additional fields to appear in the response. The expand query parameter provides more fields in the response. Expanding resources reduces the number of API calls required to accomplish a task.

fieldsstring

Specify the fields that you want to appear in the response. Filtering the fields returned in the response can conserve bandwidth and accelerate response time.

Body

one of

Responses

application/json

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://api.digitalriver.com/v1/shoppers/me/payment-options' \
  --header 'Content-Type: application/json' \
  --data '{"paymentOption":{"nickName":"DRBank","isDefault":"true","sourceId":"c25fcccc-6e57-4d93-bafb-a6765510a422"},"shopper":{"ipAddress":"192.168.100.102"}}'

201

204

400

401

409

201

{
  "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"
  }
}

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

Get the shopper payment option

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

get

/v1/shoppers/me/payment-options/{paymentOptionId}

Path parameters

paymentOptionIdstringrequired

Payment Option ID.

Query parameters

tokenstring

Provide the authorized token for a shopper.

expandstring

Use the expand query parameter when you want additional fields to appear in the response. The expand query parameter provides more fields in the response. Expanding resources reduces the number of API calls required to accomplish a task.

fieldsstring

Specify the fields that you want to appear in the response. Filtering the fields returned in the response can conserve bandwidth and accelerate response time.

Responses

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://api.digitalriver.com/v1/shoppers/me/payment-options/{paymentOptionId}'

200

401

404

200

{
  "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"
    }
  }
}

Successful response.

Update the shopper payment options

Update a payment options for a shopper.

post

/v1/shoppers/me/payment-options/{paymentOptionId}

Path parameters

paymentOptionIdstringrequired

Payment Option ID.

Query parameters

tokenstring

Provide the authorized token for a shopper.

expandstring

Gives additional details about resources.

Body

one of

Responses

application/json

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://api.digitalriver.com/v1/shoppers/me/payment-options/{paymentOptionId}' \
  --header 'Content-Type: application/json' \
  --data '{"paymentOption":{"nickName":"DRBank","isDefault":"true","sourceId":"c25fcccc-6e57-4d93-bafb-a6765510a422"},"shopper":{"ipAddress":"192.168.100.102"}}'

201

204

400

401

409

201

{
  "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"
  }
}

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