Source management

Get a source by identifier

Retrieve the details of a source with a specific ID by including the ID in the {id} URI path parameter.

GEThttps://api.digitalriver.com/sources/{id}

Authorization

bearerAuth

Path parameters

id*string

The source's ID.

Response

200400401403404405406408429500502503504

OK.

Body

application/json

idstring

Unique identifier for the source.

Example: "a6809a63-e6a9-4016-abbc-f33d19fccb5b"

clientSecretstring

Used for client-side retrieval using a public key.

Example: "52199c06-b261-4786-8609-d0a84185a0d2_2b72614b-77f6-4801-bd48-8982e314fdd5"

createdTimestring (date-time)

Time when the source was created.

typeenum

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.

Example: "creditCard"

creditCarddirectDebitgooglePayapplePaypayPalpayPalBillingpayPalCreditwireTransfercustomerCreditalipaybPayonlineBankingcodJapanklarnaCreditklarnaCreditRecurringkonbinibankTransfermstsbancontactgiftCardidealamazonPayafterPayccAvenue

currencystring

Three-letter ISO currency code.

Example: "USD"

amountnumber (double)

Amount associated with the source. Once ready, the source will be charged this amount. Required for single_use sources.

Example: 1180.26

reusableboolean

If true, you can reuse this source, if false, only once.

Example: true

ownerOwner

The owner of the payment source.

creditCardCreditCard

googlePayGooglePay

payPalPayPal

payPalBillingPayPal

payPalCreditPayPal

directDebitDirectDebit

wireTransferWireTransfer

payCoPaycoResponse

alipayAlipay

applePayApplePay

bPaybPay

onlineBankingInternetBankPayment

codJapanJapanCOD

klarnaCreditKlarna

klarnaCreditRecurringKlarnaRecurring

konbiniKonbini

bankTransferBankTransfer

mstsMSTS

bancontactBancontact

idealIdeal

giftCardGiftCard

amazonPayAmazonPay

afterPayAfterPay

ccAvenueCCAvenue

flowenum

The authentication flow of the source.

Example: "standard"

standardredirectreceiver

stateenum

The status of the source, one of pending_funds, pending_redirect, requires_action, cancelled, chargeable, consumed or failed. You can only use chargeable sources to create a charge.

Example: "chargeable"

pending_fundspending_redirectrequires_actionchargeableconsumedcancelledfailed

metadataMetadata

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

customerIdstring

Unique identifier of a customer.

Example: "5823594809"

paymentSessionIdstring

Tracks the process of collecting a payment.

Example: "8cecaa32-f692-44cc-b103-4cf24dc93913"

liveModeboolean

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

Example: false

Request

JavaScriptCurlPython

const response = await fetch('https://api.digitalriver.com/sources/{id}', {
    method: 'GET',
    headers: {
      "Authorization": "Bearer <token>"
    },
});
const data = await response.json();

Response

200400401403404405406408429500502503504

{
  "id": "a6809a63-e6a9-4016-abbc-f33d19fccb5b",
  "clientSecret": "52199c06-b261-4786-8609-d0a84185a0d2_2b72614b-77f6-4801-bd48-8982e314fdd5",
  "createdTime": {
    "offset": {
      "totalSeconds": 0,
      "id": "Z",
      "rules": {
        "transitions": [],
        "transitionRules": [],
        "fixedOffset": true
      }
    },
    "nano": 0,
    "year": 2018,
    "monthValue": 4,
    "dayOfMonth": 25,
    "hour": 20,
    "minute": 36,
    "second": 0,
    "month": "APRIL",
    "dayOfWeek": "WEDNESDAY",
    "dayOfYear": 115
  },
  "type": "creditCard",
  "currency": "USD",
  "amount": 1180.26,
  "reusable": true,
  "owner": {
    "firstName": "John",
    "lastName": "Smith",
    "email": "[e-mail]",
    "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"
  },
  "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": "[e-mail]"
    },
    "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",
  "liveMode": false
}

Create a secondary source

Create a secondary source. A secondary payment source in the Commerce API is typically a supplement to a primary one.

POSThttps://api.digitalriver.com/sources

Authorization

bearerAuth

Body

application/json

paymentSessionIdstring

Unique identifier of the session

Example: "{{checkout_session-id}}"

amountnumber (double)

The amount associated to the order

Example: 20

type*enum

The type of source

Example: "customerCredit"

customerCredit

upstreamIdstring

Unique identifier associated to an upstream system

Example: "custCredit_orderId_16008796"

customerCreditCustomerCredit

ownerOwner

The owner of the payment source.

Response

201400401403404405406408429500502503504

OK.

Body

application/json

idstring

Unique identifier for the source.

Example: "a6809a63-e6a9-4016-abbc-f33d19fccb5b"

clientSecretstring

Used for client-side retrieval using a public key.

Example: "52199c06-b261-4786-8609-d0a84185a0d2_2b72614b-77f6-4801-bd48-8982e314fdd5"

createdTimestring (date-time)

Time when the source was created.

typeenum

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.

Example: "creditCard"

creditCarddirectDebitgooglePayapplePaypayPalpayPalBillingpayPalCreditwireTransfercustomerCreditalipaybPayonlineBankingcodJapanklarnaCreditklarnaCreditRecurringkonbinibankTransfermstsbancontactgiftCardidealamazonPayafterPayccAvenue

currencystring

Three-letter ISO currency code.

Example: "USD"

amountnumber (double)

Amount associated with the source. Once ready, the source will be charged this amount. Required for single_use sources.

Example: 1180.26

reusableboolean

If true, you can reuse this source, if false, only once.

Example: true

ownerOwner

The owner of the payment source.

creditCardCreditCard

googlePayGooglePay

payPalPayPal

payPalBillingPayPal

payPalCreditPayPal

directDebitDirectDebit

wireTransferWireTransfer

payCoPaycoResponse

alipayAlipay

applePayApplePay

bPaybPay

onlineBankingInternetBankPayment

codJapanJapanCOD

klarnaCreditKlarna

klarnaCreditRecurringKlarnaRecurring

konbiniKonbini

bankTransferBankTransfer

mstsMSTS

bancontactBancontact

idealIdeal

giftCardGiftCard

amazonPayAmazonPay

afterPayAfterPay

ccAvenueCCAvenue

flowenum

The authentication flow of the source.

Example: "standard"

standardredirectreceiver

stateenum

The status of the source, one of pending_funds, pending_redirect, requires_action, cancelled, chargeable, consumed or failed. You can only use chargeable sources to create a charge.

Example: "chargeable"

pending_fundspending_redirectrequires_actionchargeableconsumedcancelledfailed

metadataMetadata

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

customerIdstring

Unique identifier of a customer.

Example: "5823594809"

paymentSessionIdstring

Tracks the process of collecting a payment.

Example: "8cecaa32-f692-44cc-b103-4cf24dc93913"

liveModeboolean

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

Example: false

Request

JavaScriptCurlPython

const response = await fetch('https://api.digitalriver.com/sources', {
    method: 'POST',
    headers: {
      "Authorization": "Bearer <token>",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "type": "customerCredit"
    }),
});
const data = await response.json();

Response

201400401403404405406408429500502503504

{
  "id": "a6809a63-e6a9-4016-abbc-f33d19fccb5b",
  "clientSecret": "52199c06-b261-4786-8609-d0a84185a0d2_2b72614b-77f6-4801-bd48-8982e314fdd5",
  "createdTime": {
    "offset": {
      "totalSeconds": 0,
      "id": "Z",
      "rules": {
        "transitions": [],
        "transitionRules": [],
        "fixedOffset": true
      }
    },
    "nano": 0,
    "year": 2018,
    "monthValue": 4,
    "dayOfMonth": 25,
    "hour": 20,
    "minute": 36,
    "second": 0,
    "month": "APRIL",
    "dayOfWeek": "WEDNESDAY",
    "dayOfYear": 115
  },
  "type": "creditCard",
  "currency": "USD",
  "amount": 1180.26,
  "reusable": true,
  "owner": {
    "firstName": "John",
    "lastName": "Smith",
    "email": "[e-mail]",
    "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"
  },
  "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": "[e-mail]"
    },
    "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",
  "liveMode": false
}