latestOpenAPI 3.0.12026-08-101292701.1 MB
f21981db32be
Invoices
Returns a list of invoices
Gets all invoices.
get/invoices
Query parameters
createdTimeobject
A filter on the list based on the createdTime field. The value can be a string with an ISO-8601 UTC format datetime or it can be a dictionary with the following options:
- eq—return values where the createdTime field equals to this timestamp
- gt—return values where the createdTime field is after this timestamp
- gte—return values where the createdTime field is after or equal to this timestamp
- lt—return values where the createdTime field is before this timestamp
- lte—return values where the createdTime field is before or equal to this timestamp
updatedTimeobject
A filter on the list based on the updatedTime field. The value can be a string with an ISO-8601 UTC format datetime or it can be a dictionary with the following options:
- eq—return values where the updatedTime field equals this timestamp
- gt—return values where the updatedTime field is after this timestamp
- gte—return values where the updatedTime field is after or equal to this timestamp
- lt—return values where the updatedTime field is before this timestamp
- lte—return values where the updatedTime field is before or equal to this timestamp
endingBeforestring
A cursor for use in pagination. The endingBefore parameter is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with xyz your subsequent calls can include endingBefore=xyz in order to fetch the previous page of the list.
startingAfterstring
A cursor for use in pagination. The startingAfter parameter is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with xyz, your subsequent calls can include startingAfter=xyz in order to fetch the next page of the list.
limitinteger
A limit on the number of objects returned. Limit can range between 1 and 100, and the default is 10.
idsstring[]
Only return objects with these IDs.
upstreamIdsstring[]
Only return objects with these upstreamIds.
totalAmountobject
A filter on the list based on the totalAmount field. The value can be a string or it can be a dictionary with the following options: - eq-return values where the amount field equals to this amount - gt-return values where the amount field is greater than this amount - gte-return values where the amount field is greater than or equal to this amount - lt-return values where the amount field is less than this amount - lte-return values where the amount field is less than or equal to this amount
customerIdstring
Only return invoices for this customer
applicationIdstring
Only return checkouts for the given application
currencystring
Only return invoices in this currency
statestring
Only return invoices in this state
skuIdstring
Only return invoices for this sku
priceobject
A filter on the list based on the invoice item price field. The value can be a string or it can be a dictionary with the following options:
- eq - return values where an invoice item price field equals to this amount
- gt - return values where an invoice item price field is greater than this amount
- gte - return values where an invoice item price field is greater than or equal to this amount
- lt - return values where an invoice item price field is less than this amount
- lte - return values where an invoice item price field is less than or equal to this amount
attemptCountobject
A filter on the list based on the invoice attemptCount field. The value can be a string or it can be a dictionary with the following options:
- eq - return values where the attemptCount field equals to this amount
- gt - return values where the attemptCount field is greater than this amount
- gte - return values where the attemptCount field is greater than or equal to this amount
- lt - return values where the attemptCount field is less than this amount
- lte - return values where the attemptCount field is less than or equal to this amount
Response
200 OK
Example response
{
"hasMore": true,
"data": [
{
"id": "co_5823594809",
"createdTime": "2018-04-25T20:36:00Z",
"updatedTime": "2018-04-25T20:36:00Z",
"customerId": "5774321009",
"email": "jsmith@digitalriver.com",
"currency": "USD",
"locale": "en_IE",
"discount": {
"amountOff": 5.95,
"percentOff": 100
},
"customerType": "individual",
"sellingEntity": {
"id": "C5_INC-ENTITY",
"name": "DR globalTech Inc."
},
"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"
}
],
"subtotal": 200,
"totalTax": 14.25,
"totalImporterTax": 82.76,
"importerOfRecordTax": true,
"totalShipping": 5.76,
"totalAmount": 214.25,
"collectionPeriodDays": 30,
"items": [
{
"skuId": "sku_5823594809",
"productDetails": {
"id": "100067660336",
"skuGroupId": "wireless-keyboards",
"name": "Keyboard",
"description": "Top rated keyboard",
"itemBreadcrumb": "Sports & Outdoors > Exercise & Fitness > Wearable Technology > Fitness Trackers",
"url": "https://producturl.com",
"countryOfOrigin": "US",
"image": "https://imageurl.com",
"weight": 20.5,
"weightUnit": "oz",
"partNumber": "SWG1224J10L",
"partnerAccountId": "00g6atnynbl2wFsFG357"
},
"subscriptionInfo": {
"freeTrial": true,
"autoRenewal": true,
"terms": "Please accept these terms.",
"planId": "654321",
"subscriptionId": "665430999",
"billingAgreementId": "cfeba2ac-d532-49e4-99f4-7a433507facf",
"startTime": "2020-05-21T00:00:00Z",
"endTime": "2021-05-20T11:59:59Z"
},
"fees": {
"details": [
{
"type": "battery",
"amount": 3,
"perUnitAmount": 1.5,
"id": "asdkj1h239lkj123j9123"
}
],
"amount": 4.5,
"taxAmount": 1.2
},
"quantity": 2,
"amount": 18.58,
"duties": {
"amount": 12.34
},
"importerTax": {
"amount": 12.34
},
"discount": {
"amountOff": 5.95,
"percentOff": 100
},
"tax": {
"rate": 0.0675,
"amount": 89
},
"metadata": {
"coupon": "iOS"
}
}
],
"shipTo": {
"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": "ヤマダ タロ"
}
},
"billTo": {
"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": "ヤマダ タロ"
}
},
"state": "open",
"payment": {
"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"
}
],
"charges": [
{
"id": "a6809a63-e6a9-4016-abbc-f33d19fccb5b",
"createdTime": "2018-04-25T20:36:00Z",
"currency": "USD",
"amount": 1180.26,
"state": "pending",
"orderId": "9986340012",
"sourceId": "9986340012",
"failureCode": "a failure code",
"failureMessage": "a failure message",
"paymentSessionId": "8cecaa32-f692-44cc-b103-4cf24dc93913",
"cancels": [
{
"id": "a6809a63-e6a9-4016-abbc-f33d19fccb5b",
"createdTime": "2018-04-25T20:36:00Z",
"updatedTime": "2018-04-25T20:36:00Z",
"amount": 1180.26,
"state": "pending"
}
],
"captures": [
{
"id": "a6809a63-e6a9-4016-abbc-f33d19fccb5b",
"createdTime": "2018-04-25T20:36:00Z",
"updatedTime": "2018-04-25T20:36:00Z",
"amount": 1180.26,
"state": "pending"
}
],
"refunds": [
{
"id": "a6809a63-e6a9-4016-abbc-f33d19fccb5b",
"createdTime": "2018-04-25T20:36:00Z",
"updatedTime": "2018-04-25T20:36:00Z",
"amount": 1180.26,
"state": "pending"
}
],
"liveMode": true
}
],
"session": {
"id": "5823594809",
"amountContributed": 10.5,
"amountRemainingToBeContributed": 5.5,
"clientSecret": "f93b4a5a-6971-4a50-b752-58636f9cfa07_35436acd-7d47-41df-8e5",
"state": "requires_confirmation",
"nextAction": {
"action": "redirect",
"data": {
"redirectUrl": "https://api.digitalriver.com:443/payments/redirects/3fab742c-a7e8-4a90-8951-86d071fa070d?apiKey=pk_test_a45b91ba4f984df7a229b2ab5941ce1c",
"sourceId": "9c00d78c-dbad-4303-b366-7e0a49c322e7",
"sourceClientSecret": "9c00d78c-dbad-4303-b366-7e0a49c322e7_246ed54a-0dfc-41f0-9e98-14036adf642e",
"sessionId": "f61e26be-5f38-4f39-9ae9-0b3cbff6a14e",
"fingerprintToken": "fingerprintToken123",
"challengeToken": "challengeToken123",
"originKey": "originKey123"
}
}
}
},
"attemptCount": 5,
"metadata": {
"coupon": "iOS"
},
"chargeType": "merchant_initiated",
"applicationId": "5774321009",
"orderId": "5823594809",
"upstreamId": "7765374748"
}
]
}