GET netflix/charges/list

Owned by Former user (Deleted)
Last updated: Dec 05, 2017 by Ekaterini Tzirtzipi
30 min read

Available from CRM.COM R12.0.0

This method returns the netflix charges which were processed by CRM.COM and were not acknowledged by the operator which are applicable for the operator, starting from the oldest charge. Retrieved charges should be acknowledged through the charges/acknowledge Web API in order to be excluded by any subsequent calls . Up to 50 charges can be returned by each call

Resource URL

Parameters

Name

Type

Description

token

String

The token retrieved from the login method

number_of_results

(mandatory)

NumberThe number of results that can be retrieved through each call. The maximum number of results can be 50. The oldest charges are retrieved fist

charge_status

(mandatory)

String

It defines the status of the charges of that will be retrieved through this call. The following options are supported

  • NOT_PROCESSED: If this option is specified then only PENDING charges will be retrieved
  • PROCESSED: If this option is specified then only APPROVED, DECLINED, BAD_REQUEST or REJECTED charges will be retrieved

offset

(mandatory)

NumberIt defines the number of charges that should be skipped from the results. During the first call it should be set to 0 and then it should be increased based on the number of results that were retrieved

fields_set

(optional)

List of Strings, comma separated 

A list of fields that should be included in the results. If not specified then all the available fields will be returned

Restrictions

  • N/A

Response Data

Name

Type

Description

charges_setSet of Charges Objects

The netflix charges related with the operator which are pending acknowledgement

Referred Objects Response Data

 netflix charges response data

Name

Type

Description

number

String

The number of the charge as provided by CRM.COM. This number should be used while acknowledging the charge through the charges/acknowledge Web API

billing_system_customer_identifierStringThe identifier of the customer as defined in the billing system managed by the operator
amountNumberThe amount of the charge
currencyStringThe currency of the charge which is a three letter currency codes, such as USD and EUR, that conform to ISO-4217.
local_currency_amountNumberThe amount of the charge in the local currency of the operator
local_currencyStringThe local currency of the operator, which is a three letter currency codes, such as USD and EUR, that conform to ISO-4217.
paid_through_dateDateThe future date until which Netflix service will be provided if this charge is Approved. Starting the day after this date, the customer will be charged for access to service
charge_statusString

The status of the charge on Netflix which can be one of the following:

  • PENDING: The charge was retrieved by Netflix but was not processed by CRM.COM yet. Those charges should not be billed until they are processed by CRM.COM
  • APPROVED: The charge was approved and the customer should be billed
  • DECLINED: The charge was declined and the customer should not be billed. The netflix subscription will be terminated.
  • BAD_REQUEST: The charge was set as bad request due to erroneous information, therefore the customer should not be billed. The netflix subscription will be terminated.
  • REJECTED: The charge was rejected and the customer should not be billed. The netflix subscription will be terminated.
received_onDateThe date that the charge was received by Netflix
set_as_approved_onDateThe date that the charge was approved
set_as_declined_onDateThe date that the charge was declined
set_as_bad_request_onDateThe date that the charge was set as bad request
set_as_rejected_request_onDateThe date that the charge was rejected

Examples

 Example 1

HTTP Method: GET

 

Request:

Response:

    {
        "data":
        {
            "charges_set":
            [
                {
                    "set_as_rejected_request_on": "2017-02-06T07:22:07",
                    "number": "I00002662",
                    "amount": 5.989999771118164,
                    "charge_status": "PENDING",
                    "billing_system_customer_identifier": "pci150",
                    "set_as_bad_request_on": null,
                    "set_as_approved_on": null,
                    "paid_through_date": "2017-02-04T02:00:00",
                    "currency": "USD",
                    "received_on": "2017-02-06T07:18:47",
                    "set_as_declined_on": null
                },
                {
                    "set_as_rejected_request_on": "2017-02-06T07:22:07",
                    "number": "I00002671",
                    "amount": 5.989999771118164,
                    "charge_status": "PENDING",
                    "billing_system_customer_identifier": "pci150",
                    "set_as_bad_request_on": null,
                    "set_as_approved_on": null,
                    "paid_through_date": "2017-02-04T02:00:00",
                    "currency": "USD",
                    "received_on": "2016-07-06T07:18:47",
                    "set_as_declined_on": null
                },
                {
                    "set_as_rejected_request_on": null,
                    "number": "I00002776",
                    "amount": 5.989999771118164,
                    "charge_status": "PENDING",
                    "billing_system_customer_identifier": "1pci30",
                    "set_as_bad_request_on": null,
                    "set_as_approved_on": "2017-02-21T10:38:58",
                    "paid_through_date": "2017-02-19T02:00:00",
                    "currency": "USD",
                    "received_on": "2017-02-21T10:07:23",
                    "set_as_declined_on": null
                },
                {
                    "set_as_rejected_request_on": null,
                    "number": "I00002778",
                    "amount": 2.990000009536743,
                    "charge_status": "PENDING",
                    "billing_system_customer_identifier": "1pci28",
                    "set_as_bad_request_on": null,
                    "set_as_approved_on": "2017-02-21T10:38:58",
                    "paid_through_date": "2017-02-19T02:00:00",
                    "currency": "USD",
                    "received_on": "2017-02-21T10:07:24",
                    "set_as_declined_on": null
                },
                {
                    "set_as_rejected_request_on": null,
                    "number": "I00002780",
                    "amount": 1.9900000095367432,
                    "charge_status": "PENDING",
                    "billing_system_customer_identifier": "1pci26",
                    "set_as_bad_request_on": null,
                    "set_as_approved_on": "2017-02-21T10:38:58",
                    "paid_through_date": "2017-02-19T02:00:00",
                    "currency": "USD",
                    "received_on": "2017-02-21T10:07:24",
                    "set_as_declined_on": null
                }
            ]
        },
        "status":
        {
            "code": "OK",
            "description": "",
            "message": ""
        }
    } 
 Example 2

HTTP Method: GET

 

Request:

Response:

{
    "data": {
        "charges_set": [
            {
                "amount": 100,
                "billing_system_customer_identifier": null,
                "set_as_bad_request_on": null,
                "set_as_approved_on": null,
                "set_as_declined_on": null,
                "local_currency": "USD",
                "set_as_rejected_request_on": null,
                "number": "I00003470",
                "charge_status": "PENDING",
                "paid_through_date": "2017-11-22T02:00:00",
                "currency": "USD",
                "received_on": "2017-12-05T10:18:47",
                "local_currency_amount": 100
            },
            {
                "amount": 50,
                "billing_system_customer_identifier": null,
                "set_as_bad_request_on": null,
                "set_as_approved_on": null,
                "set_as_declined_on": null,
                "local_currency": "EUR",
                "set_as_rejected_request_on": null,
                "number": "I00003471",
                "charge_status": "PENDING",
                "paid_through_date": "2017-11-22T02:00:00",
                "currency": "USD",
                "received_on": "2017-12-05T10:18:52",
                "local_currency_amount": 60
            },
            {
                "amount": 200,
                "billing_system_customer_identifier": null,
                "set_as_bad_request_on": null,
                "set_as_approved_on": null,
                "set_as_declined_on": null,
                "local_currency": "EUR",
                "set_as_rejected_request_on": null,
                "number": "I00003472",
                "charge_status": "PENDING",
                "paid_through_date": "2017-11-22T02:00:00",
                "currency": "USD",
                "received_on": "2017-12-05T10:19:11",
                "local_currency_amount": 250
            },
            {
                "amount": 213,
                "billing_system_customer_identifier": null,
                "set_as_bad_request_on": null,
                "set_as_approved_on": null,
                "set_as_declined_on": null,
                "local_currency": "USD",
                "set_as_rejected_request_on": null,
                "number": "I00003473",
                "charge_status": "PENDING",
                "paid_through_date": "2017-11-22T02:00:00",
                "currency": "USD",
                "received_on": "2017-12-05T10:19:15",
                "local_currency_amount": 213
            },
            {
                "amount": 200,
                "billing_system_customer_identifier": null,
                "set_as_bad_request_on": null,
                "set_as_approved_on": null,
                "set_as_declined_on": null,
                "local_currency": "EUR",
                "set_as_rejected_request_on": null,
                "number": "I00003474",
                "charge_status": "PENDING",
                "paid_through_date": "2017-11-22T02:00:00",
                "currency": "USD",
                "received_on": "2017-12-05T10:19:16",
                "local_currency_amount": 250
            },
            {
                "amount": 63,
                "billing_system_customer_identifier": null,
                "set_as_bad_request_on": null,
                "set_as_approved_on": null,
                "set_as_declined_on": null,
                "local_currency": "USD",
                "set_as_rejected_request_on": null,
                "number": "I00003475",
                "charge_status": "PENDING",
                "paid_through_date": "2017-11-22T02:00:00",
                "currency": "USD",
                "received_on": "2017-12-05T10:19:21",
                "local_currency_amount": 63
            },
            {
                "amount": 233,
                "billing_system_customer_identifier": null,
                "set_as_bad_request_on": null,
                "set_as_approved_on": null,
                "set_as_declined_on": null,
                "local_currency": "USD",
                "set_as_rejected_request_on": null,
                "number": "I00003476",
                "charge_status": "PENDING",
                "paid_through_date": "2017-11-22T02:00:00",
                "currency": "USD",
                "received_on": "2017-12-05T10:19:21",
                "local_currency_amount": 233
            },
            {
                "amount": 2564,
                "billing_system_customer_identifier": null,
                "set_as_bad_request_on": null,
                "set_as_approved_on": null,
                "set_as_declined_on": null,
                "local_currency": "USD",
                "set_as_rejected_request_on": null,
                "number": "I00003477",
                "charge_status": "PENDING",
                "paid_through_date": "2017-11-22T02:00:00",
                "currency": "USD",
                "received_on": "2017-12-05T10:19:21",
                "local_currency_amount": 2564
            },
            {
                "amount": 20,
                "billing_system_customer_identifier": null,
                "set_as_bad_request_on": null,
                "set_as_approved_on": null,
                "set_as_declined_on": null,
                "local_currency": "USD",
                "set_as_rejected_request_on": null,
                "number": "I00003478",
                "charge_status": "PENDING",
                "paid_through_date": "2017-11-22T02:00:00",
                "currency": "USD",
                "received_on": "2017-12-05T10:19:21",
                "local_currency_amount": 20
            },
            {
                "amount": 695,
                "billing_system_customer_identifier": null,
                "set_as_bad_request_on": null,
                "set_as_approved_on": null,
                "set_as_declined_on": null,
                "local_currency": "USD",
                "set_as_rejected_request_on": null,
                "number": "I00003479",
                "charge_status": "PENDING",
                "paid_through_date": "2017-11-22T02:00:00",
                "currency": "USD",
                "received_on": "2017-12-05T10:19:21",
                "local_currency_amount": 695
            },
            {
                "amount": 254,
                "billing_system_customer_identifier": null,
                "set_as_bad_request_on": null,
                "set_as_approved_on": null,
                "set_as_declined_on": null,
                "local_currency": "USD",
                "set_as_rejected_request_on": null,
                "number": "I00003480",
                "charge_status": "PENDING",
                "paid_through_date": "2017-11-22T02:00:00",
                "currency": "USD",
                "received_on": "2017-12-05T10:19:21",
                "local_currency_amount": 254
            },
            {
                "amount": 789,
                "billing_system_customer_identifier": null,
                "set_as_bad_request_on": null,
                "set_as_approved_on": null,
                "set_as_declined_on": null,
                "local_currency": "USD",
                "set_as_rejected_request_on": null,
                "number": "I00003481",
                "charge_status": "PENDING",
                "paid_through_date": "2017-11-22T02:00:00",
                "currency": "USD",
                "received_on": "2017-12-05T10:19:21",
                "local_currency_amount": 789
            },
            {
                "amount": 2563,
                "billing_system_customer_identifier": null,
                "set_as_bad_request_on": null,
                "set_as_approved_on": null,
                "set_as_declined_on": null,
                "local_currency": "USD",
                "set_as_rejected_request_on": null,
                "number": "I00003482",
                "charge_status": "PENDING",
                "paid_through_date": "2017-11-22T02:00:00",
                "currency": "USD",
                "received_on": "2017-12-05T10:19:21",
                "local_currency_amount": 2563
            },
            {
                "amount": 65,
                "billing_system_customer_identifier": null,
                "set_as_bad_request_on": null,
                "set_as_approved_on": null,
                "set_as_declined_on": null,
                "local_currency": "USD",
                "set_as_rejected_request_on": null,
                "number": "I00003483",
                "charge_status": "PENDING",
                "paid_through_date": "2017-11-22T02:00:00",
                "currency": "USD",
                "received_on": "2017-12-05T10:19:21",
                "local_currency_amount": 65
            },
            {
                "amount": 986,
                "billing_system_customer_identifier": null,
                "set_as_bad_request_on": null,
                "set_as_approved_on": null,
                "set_as_declined_on": null,
                "local_currency": "USD",
                "set_as_rejected_request_on": null,
                "number": "I00003484",
                "charge_status": "PENDING",
                "paid_through_date": "2017-11-22T02:00:00",
                "currency": "USD",
                "received_on": "2017-12-05T10:19:21",
                "local_currency_amount": 986
            },
            {
                "amount": 55,
                "billing_system_customer_identifier": null,
                "set_as_bad_request_on": null,
                "set_as_approved_on": null,
                "set_as_declined_on": null,
                "local_currency": "USD",
                "set_as_rejected_request_on": null,
                "number": "I00003485",
                "charge_status": "PENDING",
                "paid_through_date": "2017-11-22T02:00:00",
                "currency": "USD",
                "received_on": "2017-12-05T10:19:21",
                "local_currency_amount": 55
            },
            {
                "amount": 543,
                "billing_system_customer_identifier": null,
                "set_as_bad_request_on": null,
                "set_as_approved_on": null,
                "set_as_declined_on": null,
                "local_currency": "USD",
                "set_as_rejected_request_on": null,
                "number": "I00003486",
                "charge_status": "PENDING",
                "paid_through_date": "2017-11-22T02:00:00",
                "currency": "USD",
                "received_on": "2017-12-05T10:19:21",
                "local_currency_amount": 543
            },
            {
                "amount": 89,
                "billing_system_customer_identifier": null,
                "set_as_bad_request_on": null,
                "set_as_approved_on": null,
                "set_as_declined_on": null,
                "local_currency": "USD",
                "set_as_rejected_request_on": null,
                "number": "I00003487",
                "charge_status": "PENDING",
                "paid_through_date": "2017-11-22T02:00:00",
                "currency": "USD",
                "received_on": "2017-12-05T10:19:21",
                "local_currency_amount": 89
            },
            {
                "amount": 10,
                "billing_system_customer_identifier": null,
                "set_as_bad_request_on": null,
                "set_as_approved_on": null,
                "set_as_declined_on": null,
                "local_currency": "USD",
                "set_as_rejected_request_on": null,
                "number": "I00003488",
                "charge_status": "PENDING",
                "paid_through_date": "2017-11-22T02:00:00",
                "currency": "USD",
                "received_on": "2017-12-05T10:19:21",
                "local_currency_amount": 10
            },
            {
                "amount": 253,
                "billing_system_customer_identifier": null,
                "set_as_bad_request_on": null,
                "set_as_approved_on": null,
                "set_as_declined_on": null,
                "local_currency": "USD",
                "set_as_rejected_request_on": null,
                "number": "I00003489",
                "charge_status": "PENDING",
                "paid_through_date": "2017-11-22T02:00:00",
                "currency": "USD",
                "received_on": "2017-12-05T10:19:21",
                "local_currency_amount": 253
            },
            {
                "amount": 4786,
                "billing_system_customer_identifier": null,
                "set_as_bad_request_on": null,
                "set_as_approved_on": null,
                "set_as_declined_on": null,
                "local_currency": "USD",
                "set_as_rejected_request_on": null,
                "number": "I00003490",
                "charge_status": "PENDING",
                "paid_through_date": "2017-11-22T02:00:00",
                "currency": "USD",
                "received_on": "2017-12-05T10:19:21",
                "local_currency_amount": 4786
            },
            {
                "amount": 24,
                "billing_system_customer_identifier": null,
                "set_as_bad_request_on": null,
                "set_as_approved_on": null,
                "set_as_declined_on": null,
                "local_currency": "USD",
                "set_as_rejected_request_on": null,
                "number": "I00003491",
                "charge_status": "PENDING",
                "paid_through_date": "2017-11-22T02:00:00",
                "currency": "USD",
                "received_on": "2017-12-05T10:19:21",
                "local_currency_amount": 24
            },
            {
                "amount": 44,
                "billing_system_customer_identifier": null,
                "set_as_bad_request_on": null,
                "set_as_approved_on": null,
                "set_as_declined_on": null,
                "local_currency": "USD",
                "set_as_rejected_request_on": null,
                "number": "I00003492",
                "charge_status": "PENDING",
                "paid_through_date": "2017-11-22T02:00:00",
                "currency": "USD",
                "received_on": "2017-12-05T10:19:22",
                "local_currency_amount": 44
            },
            {
                "amount": 45,
                "billing_system_customer_identifier": null,
                "set_as_bad_request_on": null,
                "set_as_approved_on": null,
                "set_as_declined_on": null,
                "local_currency": "USD",
                "set_as_rejected_request_on": null,
                "number": "I00003493",
                "charge_status": "PENDING",
                "paid_through_date": "2017-11-22T02:00:00",
                "currency": "USD",
                "received_on": "2017-12-05T10:19:22",
                "local_currency_amount": 45
            },
            {
                "amount": 65,
                "billing_system_customer_identifier": null,
                "set_as_bad_request_on": null,
                "set_as_approved_on": null,
                "set_as_declined_on": null,
                "local_currency": "USD",
                "set_as_rejected_request_on": null,
                "number": "I00003494",
                "charge_status": "PENDING",
                "paid_through_date": "2017-11-22T02:00:00",
                "currency": "USD",
                "received_on": "2017-12-05T10:19:22",
                "local_currency_amount": 65
            }
        ]
    },
    "status": {
        "code": "OK",
        "description": "",
        "message": ""
    }
}