The Customer object

The Customer object contains the customer's information.

Attributes

Description

id string

Unique identifier of the customer.

createdTime datetime

The time when the customer was created.

email string

The customer email address.

shipping object

Customer shipping information.

shipping.address object

The customer's shipping address.

shipping.address.line1 string

The first line of the shipping address.

shipping.address.line2 string

The second line of the shipping address.

shipping.address.city string

The name of the city.

shipping.address.postalCode string

ZIP or postal code.

shipping.address.state string

State/County/Province/Region.

shipping.address.country string

Two-letter country code.

shipping.name string

The customer's name.

shipping.phone string

The customer's phone number.

shipping.email string

The customer's email address.

shipping.organization string

The organization's name.

shipping.additionalAddressInfo object

Additional address information.

shipping.additionalAddressInfo.neighborhood string

Additional neighborhood information.

defaultSourceId string

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

sources [object]

Contains the source information.

sources[].id string

Unique identifier for the source.

sources[].createdTime datetime

The time when the source was created.

sources[].type string

The payment type of the source. The payment type will correspond to another element in the source response that contains detailed information specific to the type. For example, a type of creditCard indicates that there is an object in the response named creditCard.

sources[].currency string

Three-letter ISO currency code.

sources[].amount number

The amount associated with the source. Once ready, the source will be charged this amount. Required for single-use sources.

sources[].reusable string

The reusable type of the source. Depending on the value, you can use the source only once, or you can reuse it multiple times.

sources[].owner object

Contains information on the owner of the credit card.

sources[].owner.firstName string

The owner's first name.

sources[].owner.lastName string

The owner's last name.

sources[].owner.email string

The owner's email address.

sources[].organization

string

The organization associated with the owner.

sources[].owner.upstreamId string

The customer ID if it is different from the Digital River customer ID (external reference ID).

sources[].owner.address object

The owner's shipping address.

sources[].creditCard object

Contains the credit card information.

sources[].creditCard.lastFourDigits string

The last four digits of the card number.

sources[].creditCard.expirationMonth number

One to two digits representing the expiration month.

sources[].creditCard.expirationYear number

Four digits representing the expiration year.

sources[].creditCard.cvv string

The card verification code.

sources[].creditCard.brand string

The card brand.

sources[].googlePay object

Contains Google Pay information.

sources[].googlePay.lastFourDigits string

The last four digits of the card number.

sources[].googlePay.expirationMonth number

One to two digits representing the expiration month.

sources[].googlePay.expirationYear number

Four digits representing the expiration year.

sources[].googlePay.brand string

The card brand.

sources[].payPal object

Contains the PayPal information.

sources[].payPal.redirect object

Redirect the customer to PayPal to authorize the charge at PayPal.

sources[].payPal.directDebit object

Allow users to authorize transactions directly from their bank account.

sources[].payPalBilling object

Contains the PayPal Billing information.

sources[].payPalBilling.redirect object

Redirect the customer to PayPal to authorize the charge at PayPal.

sources[].payPalBilling.directDebit object

Allow users to authorize transactions directly from their bank account.

sources[].directDebit object

Contains Direct Debit information.

sources[].directDebit.redirect object

Redirect the customer to the payment provider for authorization.

sources[].wireTransfer object

Contains the Wire Transfer information.

sources[].payCo object

Contains the PayCo information.

sources[].flow string

The authentication flow of the source.

sources[].state string

The status of the source. The possible statuses are as follows:

  • canceled

  • chargeable

  • consumed

  • failed

  • pending

You can only use chargeable sources to create a charge.

sources[].customerId string

The unique identifier for the customer.

sources[].paymentSessionId string

The unique identifier for the payment session.

sources[].liveMode boolean

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

taxIdentifiers [object]

Contains the tax identifier information.

taxCertificates [object]

A list of tax certificates for this customer.

taxCertificates[].companyName string

Company name for the tax certificate.

taxCertificates[].taxAuthority string

Tax authority for the tax certificate.

taxCertificates[].startDate string

Tax certificate start date.

taxCertificates[].endDate string

Tax certificate end date.

taxCertificates[].fileId string

Tax certificate file identifier.

invoices [string]

A list of invoices for this customer.

requestToBeForgotten boolean

If true, indicates this customer requested to be forgotten.

locale string

Locale designator combining two-letter ISO 639-1 language code with ISO 3166-1 alpha-2 country code.

enabled boolean

Usually, if present, indicates that the customer has been disabled. If false, attempts to create orders for the customer will fail.

liveMode boolean

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

updatedTime datetime

The time when the customer last updated

The Customer object
The Customer object
{
"id": "cus_5823594809",
"createdTime": "2018-04-25T20:36:00Z",
"email": "jsmith@digitalriver.com",
"shipping": {
"address": {
"line1": "10380 Bren Rd W",
"line2": "string",
"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"
}
},
"defaultSourceId": "src_fd74a5c5-0163-469a-ae8e-031f0259b576",
"sources": [
{
"id": "a6809a63-e6a9-4016-abbc-f33d19fccb5b",
"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",
"line2": "string",
"city": "Minnetonka",
"postalCode": "55129",
"state": "MN",
"country": "US"
},
"additionalAddressInfo": {
"neighborhood": "Centro"
}
},
"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"
}
},
"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"
},
"payCo": {
"redirectUrl": "https://api.digitalriver.com:443/payments/redirects/75743f60-1023-470e-be48-b761260317af?apiKey=pk_test_6cb0fe9ce3124093a9ad906f6c589e2d",
"returnUrl": "https://mypage.com/success",
"payCo": {}
},
"flow": "standard",
"state": "chargeable",
"customerId": 5823594809,
"paymentSessionId": "8cecaa32-f692-44cc-b103-4cf24dc93913",
"liveMode": false
}
],
"taxIdentifiers": [
{
"uk": "GB999 9999 73"
}
],
"taxCertificates": [
{
"companyName": "Digital River Inc.",
"taxAuthority": "Minnesota",
"startDate": "2019-04-25T20:36:00Z",
"endDate": "2020-04-25T20:36:00Z",
"fileId": "file_8fd2f808-bbb4-49bc-aa41-c960a1447331"
}
],
"invoices": [
"file_ca965a63-89d6-4b52-af92-e9a4513e1796"
],
"requestToBeForgotten": true,
"locale": "en_US",
"enabled": true,
"liveMode": false,
"updatedTime": "2018-04-25T20:36:00Z"
}