Customers

The Customers resource is designed to manage customer data effectively by providing endpoints for various operations. It enables you to create new customer records, retrieve a list of existing customers, update details for specific customers, and remove customer records when necessary. This API is essential for maintaining accurate and up-to-date customer information within your application, ensuring seamless integration and efficient data handling.

Creates a new customer

post

Creates a new customer object

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

idstringOptional

The unique identifier of a customer.

Example: 5823594808

emailstring · emailOptional

The customer email address.

Example: [email protected]

defaultSourceIdstringOptional

The identifier of the default source attached to this customer.

Example: fd74a5c5-0163-469a-ae8e-031f0259b576

localestringOptional

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

Example: en_US

typestring · enumOptional

The type of customer.

Example: individualPossible values:

enabledbooleanOptional

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

Example: true

Responses

201

201 Created

application/json

idstringOptional

The unique identifier for the customer.

Example: 5823594809

createdTimestring · date-timeOptional

The time at which the customer was created.

Example: 2018-04-25T20:36:00Z

emailstring · emailOptional

The customer email address.

Example: [email protected]

defaultSourceIdstring · uuidOptional

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

requestToBeForgottenbooleanOptional

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

Default: falseExample: true

typestring · enumOptional

The type of customer.

Example: individualPossible values:

localestringOptional

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

Example: en_US

enabledboolean · nullableOptional

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

Example: true

liveModebooleanOptional

Has the value true if the object exists in live mode or the value false if the object exists in test mode.

Example: false

updatedTimestring · date-timeOptional

Time at which the customer was last updated.

Example: 2018-04-25T20:36:00Z

400

400 Bad Request

application/json

401

401 Unauthorized

application/json

403

403 Forbidden

application/json

405

405 Method Not Allowed

application/json

406

406 Not Acceptable

application/json

408

408 Request Timeout

application/json

409

409 Conflict

application/json

429

429 Too Many Requests

application/json

500

500 Internal Server Error

application/json

502

502 Bad Gateway Error

application/json

503

503 Service Unavailable Error

application/json

504

504 Gateway Timeout Error

application/json

post

/customers

POST /customers HTTP/1.1
Host: api.digitalriver.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 735

{
  "id": "5823594808",
  "email": "[email protected]",
  "shipping": {
    "address": {
      "line1": "10380 Bren Rd W",
      "line2": "text",
      "city": "Minnetonka",
      "postalCode": "55129",
      "state": "MN",
      "country": "US"
    },
    "name": "John Smith",
    "phone": "952-111-1111",
    "email": "[email protected]",
    "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
}

{
  "id": "5823594809",
  "createdTime": "2018-04-25T20:36:00Z",
  "email": "[email protected]",
  "shipping": {
    "address": {
      "line1": "10380 Bren Rd W",
      "line2": "text",
      "city": "Minnetonka",
      "postalCode": "55129",
      "state": "MN",
      "country": "US"
    },
    "name": "John Smith",
    "phone": "952-111-1111",
    "email": "[email protected]",
    "organization": "Digital River",
    "additionalAddressInfo": {
      "neighborhood": "Centro",
      "division": "営業部",
      "phoneticName": "ヤマダ タロ"
    }
  },
  "defaultSourceId": "123e4567-e89b-12d3-a456-426614174000",
  "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": "[email protected]",
        "organization": "Digital River",
        "upstreamId": "55129-54673",
        "address": {
          "line1": "10380 Bren Rd W",
          "line2": "text",
          "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",
        "payCo": {}
      },
      "alipay": {},
      "applePay": {},
      "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"
      },
      "codJapan": {},
      "klarnaCredit": {
        "shipping": {
          "recipient": "John Doe",
          "phoneNumber": "5559895326",
          "address": {
            "line1": "10380 Bren Road West",
            "city": "Minnetonka",
            "state": "MN",
            "country": "US",
            "postalCode": "55343"
          },
          "email": "[email protected]"
        },
        "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"
      },
      "bankTransfer": {},
      "msts": {},
      "bancontact": {},
      "ideal": {},
      "giftCard": {
        "cardCurrency": "USD",
        "conversionRate": 1,
        "lastFourDigits": 8139
      },
      "amazonPay": {},
      "afterPay": {},
      "ccAvenue": {},
      "flow": "standard",
      "state": "chargeable",
      "metadata": {
        "coupon": "iOS"
      },
      "customerId": "5823594809",
      "paymentSessionId": "8cecaa32-f692-44cc-b103-4cf24dc93913",
      "liveMode": false
    }
  ],
  "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,
  "liveMode": false,
  "updatedTime": "2018-04-25T20:36:00Z"
}

Gets a customer by ID

get

Retrieves the details of a customer by supplying the unique identifier of the customer

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idstringRequired

Customer ID

Responses

200

200 OK

application/json

400

400 Bad Request

application/json

401

401 Unauthorized

application/json

403

403 Forbidden

application/json

404

404 Not Found

application/json

405

405 Method Not Allowed

application/json

406

406 Not Acceptable

application/json

408

408 Request Timeout

application/json

429

429 Too Many Requests

application/json

500

500 Internal Server Error

application/json

502

502 Bad Gateway Error

application/json

503

503 Service Unavailable Error

application/json

504

504 Gateway Timeout Error

application/json

get

/customers/{id}

GET /customers/{id} HTTP/1.1
Host: api.digitalriver.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "id": "5823594809",
  "createdTime": "2018-04-25T20:36:00Z",
  "email": "[email protected]",
  "shipping": {
    "address": {
      "line1": "10380 Bren Rd W",
      "line2": "text",
      "city": "Minnetonka",
      "postalCode": "55129",
      "state": "MN",
      "country": "US"
    },
    "name": "John Smith",
    "phone": "952-111-1111",
    "email": "[email protected]",
    "organization": "Digital River",
    "additionalAddressInfo": {
      "neighborhood": "Centro",
      "division": "営業部",
      "phoneticName": "ヤマダ タロ"
    }
  },
  "defaultSourceId": "123e4567-e89b-12d3-a456-426614174000",
  "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": "[email protected]",
        "organization": "Digital River",
        "upstreamId": "55129-54673",
        "address": {
          "line1": "10380 Bren Rd W",
          "line2": "text",
          "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",
        "payCo": {}
      },
      "alipay": {},
      "applePay": {},
      "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"
      },
      "codJapan": {},
      "klarnaCredit": {
        "shipping": {
          "recipient": "John Doe",
          "phoneNumber": "5559895326",
          "address": {
            "line1": "10380 Bren Road West",
            "city": "Minnetonka",
            "state": "MN",
            "country": "US",
            "postalCode": "55343"
          },
          "email": "[email protected]"
        },
        "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"
      },
      "bankTransfer": {},
      "msts": {},
      "bancontact": {},
      "ideal": {},
      "giftCard": {
        "cardCurrency": "USD",
        "conversionRate": 1,
        "lastFourDigits": 8139
      },
      "amazonPay": {},
      "afterPay": {},
      "ccAvenue": {},
      "flow": "standard",
      "state": "chargeable",
      "metadata": {
        "coupon": "iOS"
      },
      "customerId": "5823594809",
      "paymentSessionId": "8cecaa32-f692-44cc-b103-4cf24dc93913",
      "liveMode": false
    }
  ],
  "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,
  "liveMode": false,
  "updatedTime": "2018-04-25T20:36:00Z"
}

Updates an existing customer

post

Updates an existing customer

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idstringRequired

Customer ID

Body

emailstring · emailOptional

The customer email address.

Example: [email protected]

defaultSourceIdstringOptional

The identifier of the default source attached to this customer.

Example: fd74a5c5-0163-469a-ae8e-031f0259b576

requestToBeForgottenbooleanOptional

If true, indicates this customer has submitted a request to be forgotten.

Example: true

typestring · enumOptional

The type of customer.

Example: individualPossible values:

localestringOptional

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

Example: en_US

enabledbooleanOptional

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

Example: true

Responses

200

200 OK

application/json

400

400 Bad Request

application/json

401

401 Unauthorized

application/json

403

403 Forbidden

application/json

404

401 Not Found

application/json

405

405 Method Not Allowed

application/json

406

406 Not Acceptable

application/json

408

408 Request Timeout

application/json

409

409 Conflict

application/json

429

429 Too Many Requests

application/json

500

500 Internal Server Error

application/json

502

502 Bad Gateway Error

application/json

503

503 Service Unavailable Error

application/json

504

504 Gateway Timeout Error

application/json

post

/customers/{id}

POST /customers/{id} HTTP/1.1
Host: api.digitalriver.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 745

{
  "email": "[email protected]",
  "shipping": {
    "address": {
      "line1": "10380 Bren Rd W",
      "line2": "text",
      "city": "Minnetonka",
      "postalCode": "55129",
      "state": "MN",
      "country": "US"
    },
    "name": "John Smith",
    "phone": "952-111-1111",
    "email": "[email protected]",
    "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"
  },
  "requestToBeForgotten": true,
  "type": "individual",
  "metadata": {
    "coupon": "iOS"
  },
  "locale": "en_US",
  "enabled": true
}

{
  "id": "5823594809",
  "createdTime": "2018-04-25T20:36:00Z",
  "email": "[email protected]",
  "shipping": {
    "address": {
      "line1": "10380 Bren Rd W",
      "line2": "text",
      "city": "Minnetonka",
      "postalCode": "55129",
      "state": "MN",
      "country": "US"
    },
    "name": "John Smith",
    "phone": "952-111-1111",
    "email": "[email protected]",
    "organization": "Digital River",
    "additionalAddressInfo": {
      "neighborhood": "Centro",
      "division": "営業部",
      "phoneticName": "ヤマダ タロ"
    }
  },
  "defaultSourceId": "123e4567-e89b-12d3-a456-426614174000",
  "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": "[email protected]",
        "organization": "Digital River",
        "upstreamId": "55129-54673",
        "address": {
          "line1": "10380 Bren Rd W",
          "line2": "text",
          "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",
        "payCo": {}
      },
      "alipay": {},
      "applePay": {},
      "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"
      },
      "codJapan": {},
      "klarnaCredit": {
        "shipping": {
          "recipient": "John Doe",
          "phoneNumber": "5559895326",
          "address": {
            "line1": "10380 Bren Road West",
            "city": "Minnetonka",
            "state": "MN",
            "country": "US",
            "postalCode": "55343"
          },
          "email": "[email protected]"
        },
        "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"
      },
      "bankTransfer": {},
      "msts": {},
      "bancontact": {},
      "ideal": {},
      "giftCard": {
        "cardCurrency": "USD",
        "conversionRate": 1,
        "lastFourDigits": 8139
      },
      "amazonPay": {},
      "afterPay": {},
      "ccAvenue": {},
      "flow": "standard",
      "state": "chargeable",
      "metadata": {
        "coupon": "iOS"
      },
      "customerId": "5823594809",
      "paymentSessionId": "8cecaa32-f692-44cc-b103-4cf24dc93913",
      "liveMode": false
    }
  ],
  "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,
  "liveMode": false,
  "updatedTime": "2018-04-25T20:36:00Z"
}

Deletes a customer by ID

delete

Permanently deletes a customer by supplying the unique identifier of the customer

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idstringRequired

Customer ID

Responses

204

204 No Content

400

400 Bad Request

application/json

401

401 Unauthorized

application/json

403

403 Forbidden

application/json

404

401 Not Found

application/json

405

405 Method Not Allowed

application/json

406

406 Not Acceptable

application/json

408

408 Request Timeout

application/json

409

409 Conflict

application/json

429

429 Too Many Requests

application/json

500

500 Internal Server Error

application/json

502

502 Bad Gateway Error

application/json

503

503 Service Unavailable Error

application/json

504

504 Gateway Timeout Error

application/json

delete

/customers/{id}

DELETE /customers/{id} HTTP/1.1
Host: api.digitalriver.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

Attaches a source to a customer

post

Attaches a source to a customer

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idstringRequired

Customer ID

sourceIdstring · uuidRequired

Source ID

Responses

200

200 OK

application/json

400

400 Bad Request

application/json

401

401 Unauthorized

application/json

403

403 Forbidden

application/json

404

401 Not Found

application/json

405

405 Method Not Allowed

application/json

406

406 Not Acceptable

application/json

408

408 Request Timeout

application/json

409

409 Conflict

application/json

429

429 Too Many Requests

application/json

500

500 Internal Server Error

application/json

502

502 Bad Gateway Error

application/json

503

503 Service Unavailable Error

application/json

504

504 Gateway Timeout Error

application/json

post

/customers/{id}/sources/{sourceId}

POST /customers/{id}/sources/{sourceId} HTTP/1.1
Host: api.digitalriver.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "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": "[email protected]",
    "organization": "Digital River",
    "upstreamId": "55129-54673",
    "address": {
      "line1": "10380 Bren Rd W",
      "line2": "text",
      "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",
    "payCo": {}
  },
  "alipay": {},
  "applePay": {},
  "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"
  },
  "codJapan": {},
  "klarnaCredit": {
    "shipping": {
      "recipient": "John Doe",
      "phoneNumber": "5559895326",
      "address": {
        "line1": "10380 Bren Road West",
        "city": "Minnetonka",
        "state": "MN",
        "country": "US",
        "postalCode": "55343"
      },
      "email": "[email protected]"
    },
    "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"
  },
  "bankTransfer": {},
  "msts": {},
  "bancontact": {},
  "ideal": {},
  "giftCard": {
    "cardCurrency": "USD",
    "conversionRate": 1,
    "lastFourDigits": 8139
  },
  "amazonPay": {},
  "afterPay": {},
  "ccAvenue": {},
  "flow": "standard",
  "state": "chargeable",
  "metadata": {
    "coupon": "iOS"
  },
  "customerId": "5823594809",
  "paymentSessionId": "8cecaa32-f692-44cc-b103-4cf24dc93913",
  "liveMode": false
}

Detaches a source from a customer

delete

Detaches a source from a customer

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idstringRequired

Customer ID

sourceIdstring · uuidRequired

Source ID

Responses

204

204 No Content

400

400 Bad Request

application/json

401

401 Unauthorized

application/json

403

403 Forbidden

application/json

404

401 Not Found

application/json

405

405 Method Not Allowed

application/json

406

406 Not Acceptable

application/json

408

408 Request Timeout

application/json

409

409 Conflict

application/json

429

429 Too Many Requests

application/json

500

500 Internal Server Error

application/json

502

502 Bad Gateway Error

application/json

503

503 Service Unavailable Error

application/json

504

504 Gateway Timeout Error

application/json

delete

/customers/{id}/sources/{sourceId}

DELETE /customers/{id}/sources/{sourceId} HTTP/1.1
Host: api.digitalriver.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

Attaches a tax identifier to a customer

post

Attaches a tax identifier to a customer

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idstringRequired

Customer ID

taxIdstring · uuidRequired

Tax ID

Responses

200

200 OK

application/json

400

400 Bad Request

application/json

401

401 Unauthorized

application/json

403

403 Forbidden

application/json

404

401 Not Found

application/json

405

405 Method Not Allowed

application/json

406

406 Not Acceptable

application/json

408

408 Request Timeout

application/json

409

409 Conflict

application/json

429

429 Too Many Requests

application/json

500

500 Internal Server Error

application/json

502

502 Bad Gateway Error

application/json

503

503 Service Unavailable Error

application/json

504

504 Gateway Timeout Error

application/json

post

/customers/{id}/tax-identifiers/{taxId}

POST /customers/{id}/tax-identifiers/{taxId} HTTP/1.1
Host: api.digitalriver.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

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

PreviousCountry specifications NextEvents

Last updated 1 year ago

hashtagCreates a new customer

hashtagGets a customer by ID

hashtagUpdates an existing customer

hashtagDeletes a customer by ID

hashtagAttaches a source to a customer

hashtagDetaches a source from a customer

hashtagAttaches a tax identifier to a customer

Creates a new customer

Gets a customer by ID

Updates an existing customer

Deletes a customer by ID

Attaches a source to a customer

Detaches a source from a customer

Attaches a tax identifier to a customer