EPayment [ccb by dsb®

This page describes the epayment rest web services.

Notify

URL

POST: /rest/{client}/epayment/notify

Parameter	Description
client	client ID
sp	service provider. (mandatory if the user account can use different service provider values)
so	sales organization. (mandatory if the user account is only allowed to read some sales orgas of the client)

Only Cybersource, Wirecard and PayPal are supported by now.

Corresponing SOAP Service: notifyCardTransactionWithCybersource, notifyTrxPaypal, notifyTrx.

Request Body

The Body of the Post Request contains a JSON document with the notify data.

JSON EPayment Notify

Example

{
    "paymentProvider" : "CYSC",
    "notifyType" : "REGISTER-PAYMENT",
    "merchantId" : "fplgbpweb",
    "merchantReferenceCode" : "e7b716aada75ba45f7020db578e425e5",
    "amount" : 55.00,
    "currency" : "GBP",
    "billTo" : {
        "firstName" : "Paul",
        "lastName"  : "Master",
        "street1"   : "Top Floor",
        "street2"   : "",
        "city"      : "Bath",
        "state"        : "So",
        "postalCode" : "BA1 5DZ",
        "countryCode" : "GB",
        "email"     : "paul@gmail.com",
        "id"        : "ID"
    },
    "cardDetails" : {
        "cardNumber" : "1234********7890",
        "cardType"   : "VISA",
        "cardExpiry" : "2020-05"
    },
    "externalTransactionId" : "4869184370256047504057",
    "requestToken" : "Ahj//wSTB/WB6rQTz/q5AhTRi4cuWrduzZqI3DLxw8AVExaZSuo50Nq+NwcMmkmVdHpKyyhg9kwf1gSgy+xYuhAA+ARR",
    "reconciliationID" : "4189957733",
    "recurringPayID" : "4869184156396326104708",
    "requestTimestamp" : "2017-02-12T16:53:57Z",
    "paymentParts" : [
    {
        "client" : "370",
        "amount" : 45.00
    },
    {
        "client" : "6701",
        "amount" : 10.00
    }
    ]
}

Element Definitions

Field name	Type	Mandatory?	Description
paymentProvider	C	X	The payment provider: List of Payment Provider
notifyType	C	X	notification type: List of notification types
merchantId	C	X	the merchant id
merchantReferenceCode	C	X	reference code of the notified transaction in the system of the merchant (shop).
amount	N		paid amount
currency	C		currency code
billTo			billing business-partner
billTo.id			business-partner id in the system of the payment provider. Paypal: Payer ID; Cybersource: unused)
cardDetails			credit card details
cardDetails.cardNumber	C	X	masked credit card number
cardDetails.cardType	C	X	card type; either the cc-company-code or the code of the service provider. (Cybersource)
cardDetails.cardExpiry	C	X	card expiry (format: yyyy-mm)
externalTransactionId	C	X	reference code of the notified transaction in the system of the payment provider.
requestToken	C		request token in the system of the payment provider. (only Cybersource)
reconciliationID	C	X	id for reconciliation
recurringPayID	C		recurring payment id
subscriptionID	C		subscription id (alias for recurringPayID)
requestTimestamp	TS	X	timestamp
paymentParts			parts of a transaction that is split to more than one client
paymentParts.client	C	X	client id
paymentParts.amount	N	X	amount paied for this client. The amounts of all parts must sum to the amount of the request

The service returns a list of transaction ids, one for each payment part.

Create Fly Payment Widget Link

Path mapping(intern): /net/dsb/commons/FlyPayment/createFlyPaymentLink-1.0.0

This web service can be used for two different scenarios:

1. Creation of a widget link to update the payment method

If sendMessage is selected a letter/ email (depends on the setup) will be send to the customer. It includes the payment widget link. Before usage please check with dsb if the customizing and letters are set up. If sendMessage is not selected the widget link is included in the response.

2. Creation of a widget link to renew an existing renewal subscription

Within SAP no invoices are required. As soon as a customer uses the link to pay a renewal order will be placed. The offer price will be calculated based on the offer and source code provided.

URL

GET: rest/{client}/subscriptions/{orderNumber}/flyPayLink

Parameter	Description	Payment change (1)	Renewal (2)
client	client ID	X	X
orderNumber	order number (mandatory)	X	X
sp	service provider. (mandatory if the user account can use different service provider values)	X	X
sendMessage	(true/false): link will be send in letter / email (default: false)	X
so	sales organization. (mandatory if the user account is only allowed to read some sales organizations of the client)	X	X
offerCode	offer code		X (mandatory)
sourceCode	source code		X (mandatory)
sourceCodeVariant	source code variant		X (obligatory)
externalOrderNumber	external order number which will be used to renew the subscriptio. Optional. Will be automatically generated if not supplied		X
compressBundle	if true bundles will be displayed as one position (default false)		X
amount	amount displayed in payment widget (only used for upgrades)		X
billingAgreement	Should a billing agreement be done or a check checkout? (true/false default false)		X

Response structure:

{
    "status": "OK",
    "code": 0,
    "message": "<URL>"
}

Error code	Description
10*	Incorrect Input data
20*	Link generation failed
30*	Error in letter/email creation
40*	Error renewal link creation