HTTPinterface_debitcredit

of 25/25
Generic PPS – PPS 4.3.2 / RTDC - Debit Credit Interface Part HTTP INTERFACE DESCRIPTION 3BL 45121 BAAA NSZZA Ed 04 Validated All rights reserved. Passing on or copying of this document, use and communication of its contents not permitted without written authorization 1/25 INTELLIGENT NETWORK GENERIC PPS PPS 4.3.2 / RTDC - DEBIT CREDIT INTERFACE PART HTTP INTERFACE DESCRIPTION
  • date post

    25-Oct-2014
  • Category

    Documents

  • view

    39
  • download

    0

Embed Size (px)

Transcript of HTTPinterface_debitcredit

INTELLIGENT NETWORK

GENERIC PPS PPS 4.3.2 / RTDC - DEBIT CREDIT INTERFACE PART

HTTP INTERFACE DESCRIPTION

Generic PPS PPS 4.3.2 / RTDC - Debit Credit Interface Part HTTP INTERFACE DESCRIPTION 3BL 45121 BAAA NSZZA Ed 04 Validated All rights reserved. Passing on or copying of this document, use and communication of its contents not permitted without written authorization

1/25

PREFACE

This document describes the HTTP interfaces allowing an external entity to debit/credit a subscriber that is hosted on the SDP/DBRES of the PPS 4.3.2 service. In the PPS 4.3.2 deployment, pure prepaid accounts are held in SDP 1.4 whereas post-paid and regular prepaid accounts are held in DBRES 1.8.

HISTORYEdition(yy-mm-dd)

Date

Comments

Ed 04 Ed 03 Ed 02 Ed 01

05-10-27 05-06-29 05-04-07 04-09-08

Modification Type of the prices Type of the prices was int instead of real Update for FR VELin32219 (DBRES Currency Precision handling) Creation of document

TRADEMARKS

None

Generic PPS PPS 4.3.2 / RTDC - Debit Credit Interface Part HTTP INTERFACE DESCRIPTION 3BL 45121 BAAA NSZZA Ed 04 Validated All rights reserved. Passing on or copying of this document, use and communication of its contents not permitted without written authorization

2/25

CONVENTIONS

The table below shows the typing conventions used in this document. These conventions denote a special type of information. Typing convention bold-face text menu options dialog box fields commands buttons file names italics document titles document references Information type

Generic PPS PPS 4.3.2 / RTDC - Debit Credit Interface Part HTTP INTERFACE DESCRIPTION 3BL 45121 BAAA NSZZA Ed 04 Validated All rights reserved. Passing on or copying of this document, use and communication of its contents not permitted without written authorization

3/25

TABLE OF CONTENTS

1. INTRODUCTION ............................................................................................................ 7

2. NETWORK ENVIRONMENT............................................................................................ 9

3. INFORMATION FLOW.................................................................................................. 10 3.1 3.2 3.3 3.4INTRODUCTION ............................................................................................................. IMMEDIATE DEBIT ........................................................................................................... TWO-STEP DEBIT ............................................................................................................ IMMEDIATE CREDIT .........................................................................................................

10 10 12 14

4. EXTERNAL INTERFACES DESCRIPTION ........................................................................ 15 4.1 CONTENT PROVIDER REQUEST .......................................................................................... 15 4.2 CONTENT PROVIDER REPLY............................................................................................... 20 5. ANNEX A: VALUES FOR THE PARAMETER RESULT..................................................... 22

6. ANNEX B: DTD XML .....................................................................................................23

Generic PPS PPS 4.3.2 / RTDC - Debit Credit Interface Part HTTP INTERFACE DESCRIPTION 3BL 45121 BAAA NSZZA Ed 04 Validated All rights reserved. Passing on or copying of this document, use and communication of its contents not permitted without written authorization

4/25

TABLE OF ILLUSTRATIONS

Figure 1: Immediate Debit Scenario Fee Example when Debiting an Amount of Money................. 11 Figure 2: Immediate Debit Scenario Example of a Debit on a Sub-account / Regular Prepaid or Postpaid Case ............................................................................................................................ 11 Figure 3: Two-step Debit Scenario One Example when Debiting an Amount of Money.................. 12 Figure 4: CP Aborts the Two-step Debit Example of a Debit on a Sub-account / Regular Prepaid or Post-paid Case ..................................................................................................................... 13 Figure 5: Credit Request - Post-paid/Regular Prepaid .................................................................... 14 Figure 6: Credit Request - Prepaid................................................................................................ 14

Generic PPS PPS 4.3.2 / RTDC - Debit Credit Interface Part HTTP INTERFACE DESCRIPTION 3BL 45121 BAAA NSZZA Ed 04 Validated All rights reserved. Passing on or copying of this document, use and communication of its contents not permitted without written authorization

5/25

REFERENCE DOCUMENTS

N1 2 3

Reference3BL 45120 BAAA DTZZA 3BL 45011 EAAA DSZZA 3BL 45180 BAAA DTZZA

Ed01 01 01

TitleGeneric PPS - PPS 4.3.2 / RTDC Functional Specifications Generic PPS - PPS 4.3.2 Pure Prepaid DBRES1.4 General Design Service Description Generic PPS - PPS 4.3.2 / DBRES 1.8 Functional Specifications

Generic PPS PPS 4.3.2 / RTDC - Debit Credit Interface Part HTTP INTERFACE DESCRIPTION 3BL 45121 BAAA NSZZA Ed 04 Validated All rights reserved. Passing on or copying of this document, use and communication of its contents not permitted without written authorization

6/25

1.

INTRODUCTION

The aim of this document is to describe the Debit-Credit HTTP interface that enables an external entity to perform following operations on users accounts identified by their MSISDN: For prepaid users: Debit an amount of money on the main account Credit all the sub-accounts1 of the user and modify the activity and inactivity periods of the main account, the activity period of the promotional sub-account and the validity period of the refill bonus SMS. Each amount is given in the unit of the targeted sub-account. For post-paid and regular prepaid users: Debit an amount associated with a content code. The determination of the targeted sub-account(s)2 follows the following logic: Through RTDC service population, this content code refers to an operator service and, through the commercial offer subscribed by the user, this service is linked to a rating tree that enables the selection of the sub-account(s) to debit. Credit all the sub-accounts of the user. Each amount is given in the unit of the targeted sub-account. Note that if the external entity does not know the type of user (prepaid or not), it can only debit an amount of money (and the RTDC service will use a default value (65535) of content code in case the user is post-paid or regular prepaid). For debit transactions, two different scenarios may take place: Immediate Debit: Charging is done at the reception of the request, Two- Step Transaction: there is a first message to authorise the transaction and book the given amount in case of pure prepaid and regular prepaid accounts and a second message is sent when the transaction has been successfully completed. The subscribers account is charged at the reception of the confirmation request (second message). In case that the second message is not received, the booked amount (pure and regular prepaid) will be credited again to the account after a given timer. In all cases, the external entity has always the possibility to cancel the previous booking by sending an ABORT request.

The sub-account expression includes the main account, the promotional sub-account, the MMS sub-account, the data sub-account, the content sub-account and the refill bonus SMS counter. The sub-account expression includes the balance, the general money sub-accounts (money1 and money2) and the specialised sub-accounts (time/voice, SMS, MMS, data, content).Generic PPS PPS 4.3.2 / RTDC - Debit Credit Interface Part HTTP INTERFACE DESCRIPTION 3BL 45121 BAAA NSZZA Ed 04 Validated All rights reserved. Passing on or copying of this document, use and communication of its contents not permitted without written authorization2

1

7/25

Furthermore, for any transaction Call Detail Records (CDR) will be generated including information such as date and time, subscriber MSISDN, debited amount, identity of the external entity originating the request.

Generic PPS PPS 4.3.2 / RTDC - Debit Credit Interface Part HTTP INTERFACE DESCRIPTION 3BL 45121 BAAA NSZZA Ed 04 Validated All rights reserved. Passing on or copying of this document, use and communication of its contents not permitted without written authorization

8/25

2.

NETWORK ENVIRONMENT

The interface described in this document relies between the External Entity and the OSP where the prepaid, post-paid and regular prepaid accounts are held. This interface may be used within the operator Intranet (between two network-nodes managed by the operator, as well as for a node lying outside in the Internet). For the later, this interface provides a secure transport by using https and digital certificates. However it must be pointed out that this securitylayer will obviously decrease the overall solution performance. Next figure depicts both possible configurations.

Firewall

CP

Internet

HTTP(S) Interface

Debit / credit serviceOSP

MMS-C

Operator IP network

Generic PPS PPS 4.3.2 / RTDC - Debit Credit Interface Part HTTP INTERFACE DESCRIPTION 3BL 45121 BAAA NSZZA Ed 04 Validated All rights reserved. Passing on or copying of this document, use and communication of its contents not permitted without written authorization

9/25

3. 3.1 INTRODUCTION

INFORMATION FLOW

This chapter aims at describing the message exchange for the different scenarios. The involved entities are: CP Content Provider (or any other External Entity) using this HTTP interface Debit/credit application (on OSP) responsible for managing the incoming requests and updating the account. Hereafter you will find the message flow for different kinds of scenarios: Immediate debit Two-step debit Two-step debit-abort, Immediate credit

3.2

IMMEDIATE DEBIT

The CP asks for the immediate debit of an amount before/after (CP dependent) providing the content to the user. Once the OSP receives the CP request, the account will be updated, and the transaction will be acknowledged to the CP. In case any parameter included in the CP request does not correspond to the expected parameters, the transaction will be rejected, and the CP will be informed of the error.

Generic PPS PPS 4.3.2 / RTDC - Debit Credit Interface Part HTTP INTERFACE DESCRIPTION 3BL 45121 BAAA NSZZA Ed 04 Validated All rights reserved. Passing on or copying of this document, use and communication of its contents not permitted without written authorization

10/25

CPHTTP

OSPOSP CP REQUEST

CPHTTP

OSP

CP REQUEST

CP REPLY

CP REPLY

Example 1 Debit an amount of money Available for prepaid and postpaid

Example 2 Debit an amount of money on a DBRES user (reg prepaid or post-paid)

Figure 1: Immediate Debit Scenario Fee Example when Debiting an Amount of Money

CPHTTP OSP CP REQUEST

OSP

CP REPLY

Figure 2: Immediate Debit Scenario Example of a Debit on a Sub-account / Regular Prepaid or Post-paid Case

Generic PPS PPS 4.3.2 / RTDC - Debit Credit Interface Part HTTP INTERFACE DESCRIPTION 3BL 45121 BAAA NSZZA Ed 04 Validated All rights reserved. Passing on or copying of this document, use and communication of its contents not permitted without written authorization

11/25

3.3

TWO-STEP DEBIT

The CP sends a first message that is used to check the user is authorised to pursue the transaction. The CP uses the second message to confirm that the content has been delivered and SDP/DBRES updates the subscribers account. This second message is also acknowledged by the OSP.

CPHTTP

OSP

CP REQUEST CP REPLY CP REQUEST CP REPLY

Figure 3: Two-step Debit Scenario One Example when Debiting an Amount of Money

Hereafter you will find depicted the scenario where the CP aborts the transaction after having booked the credit.

Generic PPS PPS 4.3.2 / RTDC - Debit Credit Interface Part HTTP INTERFACE DESCRIPTION 3BL 45121 BAAA NSZZA Ed 04 Validated All rights reserved. Passing on or copying of this document, use and communication of its contents not permitted without written authorization

12/25

CPHTTP

OSP

CP REQUEST CP REPLY CP REQUEST CP REPLY

Figure 4: CP Aborts the Two-step Debit Example of a Debit on a Sub-account / Regular Prepaid or Post-paid Case

Generic PPS PPS 4.3.2 / RTDC - Debit Credit Interface Part HTTP INTERFACE DESCRIPTION 3BL 45121 BAAA NSZZA Ed 04 Validated All rights reserved. Passing on or copying of this document, use and communication of its contents not permitted without written authorization

13/25

3.4

IMMEDIATE CREDIT

The CP asks for the credit of an account. Once the OSP receives the credit request, the account is updated, and the transaction will be acknowledged to the CP. In case any parameter included in the CP request does not correspond to the expected parameters, the transaction will be rejected, and the CP will be informed of the error.

CPHTTP

OSPOSP CP REQUEST CP REPLY

Figure 5: Credit Request - Post-paid/Regular Prepaid

CPHTTP

OSPOSP CP REQUEST CP REPLY

Figure 6: Credit Request - Prepaid

Generic PPS PPS 4.3.2 / RTDC - Debit Credit Interface Part HTTP INTERFACE DESCRIPTION 3BL 45121 BAAA NSZZA Ed 04 Validated All rights reserved. Passing on or copying of this document, use and communication of its contents not permitted without written authorization

14/25

4. 4.1

EXTERNAL INTERFACES DESCRIPTION

CONTENT PROVIDER REQUEST

The CP sends this message. This message is used in all the scenarios described above. The parameter action is used to tell scenarios apart. HTTP message type: Request Request line: POST http(s)://www.in.fr//Si HTTP/1.1 Body: Next table lists the parameters expected in the form that will be sent in the enclosed entity. Namecp_id

M/O/C3M

FormatChar string

Parameters ValueMax = 10 if credit 30 if debit Max = 30 Max = 200 1= Debit/Credit 0=Immediate debit 1=Immediate credit 2=Two-step debit - book 4=Two-step debit - update 99=Two-step debit - abort Max = 16 digits 065535

CommentsUsed to identify the requesting entity in the CDR. (No checking is performed) CP Internal value.

cp_tansaction_id op_transaction_id application action

M M M M

Char string Char string Unsigned int Unsigned int

Describes the type of operation that the CP is sending to the OSP.

user_id cp_timer

M O

Number Unsigned int

Only the MSISDN is supported in this interface Used by the CP to specify the credit booked duration. Otherwise default CP timer will be taken by the debit/credit service.

transaction_price transaction_currency debit_params

O O C

Real Unsigned int Char string

0...MaxValue4 015 Max=100

Amount to debit or credit on the user account Value is always the default platform currency. Element withholding the debit parameters. The element is conditional, it should be present in case action is a type debit Element withholding the credit parameters. The element is conditional, it should be present in case action is 1

credit_params

C

Char string

Max=100

3 4

Mandatory/Optional/Conditional

MaxValue is 9999999.99 for SDP subscribers (pure prepaid). For DBRES subscribers (regular prepaid and postpaid), MaxValue depends on the Currency Precision (e.g. 99999.9999 if the precision is set to 4 digits.)Generic PPS PPS 4.3.2 / RTDC - Debit Credit Interface Part HTTP INTERFACE DESCRIPTION 3BL 45121 BAAA NSZZA Ed 04 Validated All rights reserved. Passing on or copying of this document, use and communication of its contents not permitted without written authorization

15/25

debit_params element: Prepaid accountRef 1: subscriber_type O Unsigned int 1 = pure prepaid Used to identify the subscriber account type.

Post-paid / regular-prepaidRef 1: subscriber_type Ref 2: content_code Ref 3: requested_unit M C C Unsigned int Unsigned int Unsigned int 0 = post-paid or regular prepaid 165535 >0 0 0 0 0 0 0 Content Provider Request DTD

Generic PPS PPS 4.3.2 / RTDC - Debit Credit Interface Part HTTP INTERFACE DESCRIPTION 3BL 45121 BAAA NSZZA Ed 04 Validated All rights reserved. Passing on or copying of this document, use and communication of its contents not permitted without written authorization

23/25

Example: TOPCPID1 direct_debit 1 0 111111113 0 3 10 //subscriber_type is 0 (postpaid) //content_code is 3 //requested_unit is 10 //immediate debit

Generic PPS PPS 4.3.2 / RTDC - Debit Credit Interface Part HTTP INTERFACE DESCRIPTION 3BL 45121 BAAA NSZZA Ed 04 Validated All rights reserved. Passing on or copying of this document, use and communication of its contents not permitted without written authorization

24/25

Content Provider Reply Prologue Content Provider Reply DTD

END OF DOCUMENT

Generic PPS PPS 4.3.2 / RTDC - Debit Credit Interface Part HTTP INTERFACE DESCRIPTION 3BL 45121 BAAA NSZZA Ed 04 Validated All rights reserved. Passing on or copying of this document, use and communication of its contents not permitted without written authorization

25/25