Direct Debit Payment API

post

https://example.com/api/v1.0/debit/payment-host-to-host

This API is used to do Direct Debit Payment using an already bound card.
In case of any HTTP response code other than 2XX received in the response, please 'DO NOT FAIL' the transaction.

Service Code: 33

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

partnerReferenceNo

string

required

length between 32 and 32

Unique 32-character string. Transaction identifier on the partner system.

bankCardToken

string

required

length between 32 and 32

Unique card token received after succesful card binding.

merchantId

string

required

length between 6 and 6

This field is a 6 char merchant identifier that is unique per each merchant. The exact value is disclosed to each merchant separately.

amount

object

required

Amount to be charged to the card.

urlParam

array of objects

required

Array of redirection URLs.

urlParam*

additionalInfo

object

required

Additional info required for processing the transaction. The additionalInfo value must:

Have a maximum length of 100 characters.
Have a minimum length of 1 character.
Be alphanumeric, with the following special characters allowed: ` (space)`, `@`, `.`, `-`, `_`, `+`, `*`, `!`, `~`

To display additional values on the dashboard, the values should be strings. Use the keys:

additionalInfo1
additionalInfo2
additionalInfo3

Headers

Content-Type

string

enum

required

length between 16 and 16

Represents the content type of the received data (e.g. application/json)

Allowed:

string

enum

required

length between 16 and 16

Represents the media type that the client is able to accept from the server (e.g. application/json).

Allowed:

Authorization

string

required

Represents the access_token of a request; string starts with the keyword "Bearer " followed by the access_token.

Authorization-Customer

string

required

Represents the customer_access_token of a request; string starts with the keyword "Bearer " followed by the B2B2C Token.

X-TIMESTAMP

string

required

length between 24 and 27

Client's current local time in yyyy-MM-ddTHH:mm:ss.SSSTZD format.

X-CLIENT-KEY

string

length between 32 and 32

Client's client_id (PJP Name). It is provided when the registration process is completed.

X-SIGNATURE

string

required

Represents signature of a request. Symmetric signature: HMAC_SHA512(clientSecret, stringToSign).

stringToSign = HTTPMethod +":"+ URLPath +":"+ AccessToken +":"+ Lowercase(HexEncode(SHA-256(minify(RequestBody))))+":" + X-TIMESTAMP

X-PARTNER-ID

string

required

length between 6 and 6

This field is a 6 char merchant identifier that is unique per each merchant. The exact value is disclosed to each merchant separately.

X-EXTERNAL-ID

string

required

length between 32 and 32

Alphanumeric String. Reference number that should be unique in the same flow.

CHANNEL-ID

string

required

length between 5 and 5

Numeric String. PJP's channel id. Device identification on which the API services is currently being accessed by the end user (customer). Must be the same in one flow.

Responses

Callback

200Successful operation there is two success example response

404Error Card Not Found