Sign in
latestOpenAPI 3.0.12026-08-101292701.1 MB

f21981db32be

Customers

Creates a new customer

Creates a new customer object

post/customers

Request body

idstring

The unique identifier of a customer.

emailstring email

The customer email address.

defaultSourceIdstring

The identifier of the default source attached to this customer.

metadataMetadata

Key-value pairs used to store additional data. Value can be string, boolean or integer types.

localestring

A locale designator that combines the two-letter ISO 639-1 language code with the ISO 3166-1 alpha-2 country code.

type'business' | 'individual'

The type of customer.

enabledboolean

Usually used to disable the customer. The default is <code>true</code>. If <code>false</code>, attempts to create orders for the customer will fail.

Example request

{
  "id": "5823594808",
  "email": "jsmith@digitalriver.com",
  "shipping": {
    "address": {
      "line1": "10380 Bren Rd W",
      "city": "Minnetonka",
      "postalCode": "55129",
      "state": "MN",
      "country": "US"
    },
    "name": "John Smith",
    "phone": "952-111-1111",
    "email": "jsmith@digitalriver.com",
    "organization": "Digital River",
    "additionalAddressInfo": {
      "neighborhood": "Centro",
      "division": "営業部",
      "phoneticName": "ヤマダ タロ"
    }
  },
  "defaultSourceId": "fd74a5c5-0163-469a-ae8e-031f0259b576",
  "taxCertificate": {
    "companyName": "Digital River Inc.",
    "taxAuthority": "MN",
    "startDate": "2019-04-25T20:36:00Z",
    "endDate": "2020-04-25T20:36:00Z",
    "fileId": "file_8fd2f808-bbb4-49bc-aa41-c960a1447331"
  },
  "metadata": {
    "coupon": "iOS"
  },
  "locale": "en_US",
  "type": "individual",
  "enabled": true
}

Response

201 Created

idstring

The unique identifier for the customer.

createdTimestring date-time

The time at which the customer was created.

emailstring email

The customer email address.

defaultSourceIdstring uuid

The identifier of the default payment source attached to this customer.

requestToBeForgottenboolean

If true, indicates this customer has requested to be forgotten.

type'business' | 'individual'

The type of customer.

metadataMetadata

Key-value pairs used to store additional data. Value can be string, boolean or integer types.

localestring

A locale designator that combines the two-letter ISO 639-1 language code with the ISO 3166-1 alpha-2 country code.

enabledboolean nullable

Usually used to disable the customer. The default is <code>true</code>. If <code>false</code>, attempts to create orders for the customer will fail.

liveModeboolean

Has the value <code>true</code> if the object exists in live mode or the value <code>false</code> if the object exists in test mode.

updatedTimestring date-time

Time at which the customer was last updated.

Example response

{
  "id": "5823594809",
  "createdTime": "2018-04-25T20:36:00Z",
  "email": "jsmith@digitalriver.com",
  "shipping": {
    "address": {
      "line1": "10380 Bren Rd W",
      "city": "Minnetonka",
      "postalCode": "55129",
      "state": "MN",
      "country": "US"
    },
    "name": "John Smith",
    "phone": "952-111-1111",
    "email": "jsmith@digitalriver.com",
    "organization": "Digital River",
    "additionalAddressInfo": {
      "neighborhood": "Centro",
      "division": "営業部",
      "phoneticName": "ヤマダ タロ"
    }
  },
  "sources": [
    {
      "id": "a6809a63-e6a9-4016-abbc-f33d19fccb5b",
      "clientSecret": "52199c06-b261-4786-8609-d0a84185a0d2_2b72614b-77f6-4801-bd48-8982e314fdd5",
      "createdTime": "2018-04-25T20:36:00Z",
      "type": "creditCard",
      "currency": "USD",
      "amount": 1180.26,
      "reusable": true,
      "owner": {
        "firstName": "John",
        "lastName": "Smith",
        "email": "jsmith@digitalriver.com",
        "organization": "Digital River",
        "upstreamId": "55129-54673",
        "address": {
          "line1": "10380 Bren Rd W",
          "city": "Minnetonka",
          "postalCode": "55129",
          "state": "MN",
          "country": "US"
        },
        "additionalAddressInfo": {
          "neighborhood": "Centro",
          "division": "営業部",
          "phoneticName": "ヤマダ タロ"
        }
      },
      "creditCard": {
        "lastFourDigits": "3119",
        "expirationMonth": 3,
        "expirationYear": 2023,
        "brand": "Visa"
      },
      "googlePay": {
        "lastFourDigits": "3119",
        "expirationMonth": 2,
        "expirationYear": 2022,
        "brand": "Visa"
      },
      "payPal": {
        "redirect": {
          "redirectUrl": "https://api.digitalriver.com:443/payments/redirects/e626ec65-24d6-46fb-b632-10b90f4c4912?apiKey=pk_test_6cb0fe9ce3124093a9ad906f6c589e2d",
          "returnUrl": "https://mypage.com/success",
          "cancelUrl": "https://mypage.com/cancel"
        },
        "directDebit": {
          "token": "EC-53H39048EL439164J"
        }
      },
      "payPalBilling": {
        "redirect": {
          "redirectUrl": "https://api.digitalriver.com:443/payments/redirects/e626ec65-24d6-46fb-b632-10b90f4c4912?apiKey=pk_test_6cb0fe9ce3124093a9ad906f6c589e2d",
          "returnUrl": "https://mypage.com/success",
          "cancelUrl": "https://mypage.com/cancel"
        },
        "directDebit": {
          "token": "EC-53H39048EL439164J"
        }
      },
      "payPalCredit": {
        "redirect": {
          "redirectUrl": "https://api.digitalriver.com:443/payments/redirects/e626ec65-24d6-46fb-b632-10b90f4c4912?apiKey=pk_test_6cb0fe9ce3124093a9ad906f6c589e2d",
          "returnUrl": "https://mypage.com/success",
          "cancelUrl": "https://mypage.com/cancel"
        },
        "directDebit": {
          "token": "EC-53H39048EL439164J"
        }
      },
      "directDebit": {
        "redirect": {
          "redirectUrl": "https://api.digitalriver.com:443/payments/redirects/75743f60-1023-470e-be48-b761260317af?apiKey=pk_test_6cb0fe9ce3124093a9ad906f6c589e2d",
          "returnUrl": "https://mypage.com/success"
        }
      },
      "wireTransfer": {
        "accountHolder": "Netgiro Payments AB",
        "bankName": "ABN AMRO Bank N.V.",
        "city": "Prague",
        "country": "ES",
        "referenceId": "DR1651067521",
        "accountNumber": "0100037259",
        "additionalBankInformation": "Codigo de oficina: 0001 Codigo de entidad: 0156 Digitos de control: 09",
        "iban": "ES35 0156 0001 0901 0003 7259",
        "swiftCode": "string"
      },
      "payCo": {
        "redirectUrl": "https://api.digitalriver.com:443/payments/redirects/75743f60-1023-470e-be48-b761260317af?apiKey=pk_test_6cb0fe9ce3124093a9ad906f6c589e2d",
        "returnUrl": "https://mypage.com/success"
      },
      "bPay": {
        "accountHolder": "Global Collect BV",
        "bankName": "Commonwealth Bank",
        "city": "Sydney",
        "country": "Australia",
        "referenceId": "12345678",
        "accountNumber": "87654321",
        "billId": "112233",
        "customerPaymentReference": "443322",
        "swiftCode": "CTBAAU2S"
      },
      "onlineBanking": {
        "bankCode": "86"
      },
      "klarnaCredit": {
        "shipping": {
          "recipient": "John Doe",
          "phoneNumber": "5559895326",
          "address": {
            "line1": "10380 Bren Road West",
            "city": "Minnetonka",
            "state": "MN",
            "country": "US",
            "postalCode": "55343"
          },
          "email": "jdoe@yahoo.com"
        },
        "token": "1111222233334444"
      },
      "klarnaCreditRecurring": {
        "returnUrl": "https://example.org/return",
        "cancelUrl": "https://example.org/cancel"
      },
      "konbini": {
        "storeId": "33334444",
        "receiptNumber": "8675309",
        "printableInvoiceUrl": "https://printableinvoice.com",
        "storeName": "Seven Eleven",
        "localizedStoreName": "セブン‐イレブン",
        "storeLogoUrl": "https://storelogo.com"
      },
      "giftCard": {
        "cardCurrency": "USD",
        "conversionRate": 1,
        "lastFourDigits": 8139
      },
      "flow": "standard",
      "state": "chargeable",
      "metadata": {
        "coupon": "iOS"
      },
      "customerId": "5823594809",
      "paymentSessionId": "8cecaa32-f692-44cc-b103-4cf24dc93913"
    }
  ],
  "taxIdentifiers": [
    {
      "id": "5774321009",
      "createdTime": "2018-04-25T20:36:00Z",
      "customerId": "5774321009",
      "type": "de",
      "value": "DE123456789",
      "state": "pending",
      "stateTransitions": {
        "pending": "2018-04-25T20:36:00Z",
        "verified": "2018-04-25T20:36:00Z",
        "not_valid": "2018-04-25T20:36:00Z"
      },
      "verifiedName": ".",
      "verifiedAddress": ".",
      "updatedTime": "2018-04-25T20:36:00Z",
      "applicability": [
        {
          "country": "FR",
          "entity": "DR_Ireland-Entity",
          "customerType": "business"
        }
      ]
    }
  ],
  "taxCertificates": [
    {
      "companyName": "Digital River Inc.",
      "taxAuthority": "MN",
      "startDate": "2019-04-25T20:36:00Z",
      "endDate": "2020-04-25T20:36:00Z",
      "fileId": "file_8fd2f808-bbb4-49bc-aa41-c960a1447331"
    }
  ],
  "requestToBeForgotten": true,
  "type": "individual",
  "metadata": {
    "coupon": "iOS"
  },
  "locale": "en_US",
  "enabled": true,
  "updatedTime": "2018-04-25T20:36:00Z"
}