Permalink
Switch branches/tags
Nothing to show
Find file Copy path
Fetching contributors…
Cannot retrieve contributors at this time
98 lines (81 sloc) 3.06 KB

Introduction

The authorized caller is able to charge/refund an end user.

URL format

http://{serverRoot}/ericsson/oneapi/payment/1/{endUserId}/transactions/amount

HTTP request

Parameter Description Mandatory or Optional

endUserId

It is the identity of the end user to be charged. tel URI is used as the user identity. Only global number is supported.
"tel:" scheme must be given. For example, tel%3A%2B8613500000000
The endUserId value in URL and payload must be same.

Mandatory

referenceCode

The message content which is going to be sent to the senderAddress, the length of it must be less than 160 characters

Mandatory

transactionOperationStatus

This indicates the desired resource state. Set to ‘Charged’ to deduct money from user’s account, and set to ‘Refunded’ to refund user.

Mandatory

description

It is the human-readable text to appear on the bill. Then user can easily see what they bought.

Mandatory

currency

It is the 3-figure code as per ISO 4217.

Mandatory

amount

It can be a whole number or decimal.

Mandatory

HTTP respnose code

HTTP status code Description Note

200

Successful

500

Internal server error

400

The syntax of the request is not correct.

Example:

Request Post: http://52.28.33.220/ericsson/oneapi/payment/1/tel:+8613580551660/transactions/amount?endUserId=tel:+8613580551660&transactionOperationStatus=Charged&description=&currency=EUR&amount=18&referenceCode=REF-1234