digitaluapi

<back to all web services

InitialisePaymentRequest

import datetime
import decimal
from marshmallow.fields import *
from servicestack import *
from typing import *
from dataclasses import dataclass, field
from dataclasses_json import dataclass_json, LetterCase, Undefined, config
from enum import Enum, IntEnum


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class ResponseBase:
    status: bool = False
    message: Optional[str] = None
    errors: Optional[Dict[str, List[str]]] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class InitialisePaymentResponse(ResponseBase):
    transaction_id: Optional[str] = None
    signature: Optional[str] = None
    url: Optional[str] = None


class PaymentTypeEnum(IntEnum):
    ONE_TIME = 1
    RECURRING = 2


class FrequencyEnum(IntEnum):
    DAILY = 1
    WEEKLY = 2
    MONTHLY = 3
    QUARTERLY = 4
    BIANNUALLY = 5
    ANNUALLY = 6


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class InitialisePaymentRequest:
    payment_type: Optional[PaymentTypeEnum] = None
    uuid: Optional[str] = None
    reference_number: Optional[str] = None
    amount: Decimal = decimal.Decimal(0)
    currency: Optional[str] = None
    item_name: Optional[str] = None
    item_description: Optional[str] = None
    billing_date: datetime.datetime = datetime.datetime(1, 1, 1)
    frequency: Optional[FrequencyEnum] = None
    cycles: int = 0

Python InitialisePaymentRequest DTOs

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"]}}