digitaluapi

<back to all web services

InitialisePaymentRequest

InitialisePaymentRequest Parameters:
NameParameterData TypeRequiredDescription
PaymentTypequeryPaymentTypeEnumNo
UuidqueryGuidNo
ReferenceNumberquerystringNo
AmountquerydecimalNo
CurrencyquerystringNo
ItemNamequerystringNo
ItemDescriptionquerystringNo
BillingDatequeryDateTimeNo
FrequencyqueryFrequencyEnumNo
CyclesqueryintNo
PaymentTypeEnum Enum:
NameValue
OneTime1
Recurring2
FrequencyEnum Enum:
NameValue
Daily1
Weekly2
Monthly3
Quarterly4
Biannually5
Annually6
InitialisePaymentResponse Parameters:
NameParameterData TypeRequiredDescription
TransactionIdformstringNo
SignatureformstringNo
UrlformstringNo
ResponseBase Parameters:
NameParameterData TypeRequiredDescription
StatusformboolNo
MessageformstringNo
ErrorsformDictionary<string, List<String>>No

To override the Content-type in your clients, use the HTTP Accept Header, append the .other suffix or ?format=other

HTTP + OTHER

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /jsonl/reply/InitialisePaymentRequest HTTP/1.1 
Host: duengageapi.uat.scadsoftware.com 
Accept: text/jsonl
Content-Type: text/jsonl
Content-Length: length

{"PaymentType":"OneTime","Uuid":"00000000000000000000000000000000","ReferenceNumber":"String","Amount":0,"Currency":"String","ItemName":"String","ItemDescription":"String","BillingDate":"0001-01-01T00:00:00.0000000","Frequency":"Daily","Cycles":0}
HTTP/1.1 200 OK
Content-Type: text/jsonl
Content-Length: length

{"TransactionId":"String","Signature":"String","Url":"String","Status":false,"Message":"String","Errors":{"String":["String"]}}