---
title: "Create the shopper payment options"
method: POST
path: "/v1/shoppers/me/payment-options"
tags: ["Payment-Options"]
---

# Create the shopper payment options

`POST /v1/shoppers/me/payment-options`

## Request

- Base URL: `https://api.digitalriver.com`
- URL: `https://api.digitalriver.com/v1/shoppers/me/payment-options`
- Auth: none declared

Create a payment options for a shopper.

## Query parameters

- `token` string
- `expand` string
- `fields` string

## Request body

- union
  - PaymentOptionsRequestPaymentSource
    - `paymentOption` object
      - `nickName` string
      - `isDefault` string
      - `sourceId` string: A unique identifier for the payment source.
    - `shopper` object
      - `ipAddress` string
  - PaymentOptionsRequestLegacy
    - `paymentOption` object
      - `nickName` string
      - `isDefault` string
      - `creditCard` object
        - `expirationMonth` integer: One to two digits representing the expiration month.
        - `expirationYear` integer: Four digits representing the expiration year.
        - `displayableNumber` string: The card number, only display the last four digits. (e.g. ************1111)
        - `cardSecurityCode` string
        - `type` string
    - `shopper` object
      - `ipAddress` string

## Response `201`

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

- PaymentOptionsResponsePaymentSourceForPost
  - `uri` string
  - `id` number
  - `nickName` string
  - `isDefault` string
  - `type` string
  - `sourceId` string: A unique identifier for the payment source.
  - `sourceClientSecret` string: The unique client secret for the payment source.
  - `creditCard` object
    - `expirationYear` string: Four digits representing the expiration year.
    - `lastFourDigits` string: The last four digits of the card number. (e.g. 1111)
    - `clientSecret` string: The unique client secret for the payment source.
    - `expirationMonth` string: One to two digits representing the expiration month.
    - `fundingSource` string: The card type returned from Payments Processor. (e.g. Credit, Debit, PrePaid, Charge, Deferred_debit)
    - `brand` string: The card brand (e.g. Visa, MasterCard, American Express, etc.).
    - `reusable` string: Whether the payment is reusable.

## Other responses

- `204`: * No Content (Legacy Payment) * No Content (Payment Source)
- `400`: * Bad Request
- `401`: * Invalid Token
- `409`: * The Payment Option with a nickname already exists * The PaymentSource is not valid * The PaymentSource with a Source ID already exists * invalid-state-code * invalid-postal-code

---

[API](https://skmtc.dev/digitalriver/apis/commerce-api-suite-shopper-apis.md) - [All operations](https://skmtc.dev/digitalriver/apis/commerce-api-suite-shopper-apis/llms.txt) - [OpenAPI document](https://skmtc.dev/digitalriver/apis/commerce-api-suite-shopper-apis/revisions/4b69392f93b9?raw)