digitaluapi

InitialisePaymentRequest


export class ResponseBase
{
    public Status: boolean;
    public Message: string;
    public Errors: { [index:string]: string[]; };

    public constructor(init?: Partial<ResponseBase>) { (Object as any).assign(this, init); }
}

export class InitialisePaymentResponse extends ResponseBase
{
    public TransactionId: string;
    public Signature: string;
    public Url: string;

    public constructor(init?: Partial<InitialisePaymentResponse>) { super(init); (Object as any).assign(this, init); }
}

export enum PaymentTypeEnum
{
    OneTime = 1,
    Recurring = 2,
}

export enum FrequencyEnum
{
    Daily = 1,
    Weekly = 2,
    Monthly = 3,
    Quarterly = 4,
    Biannually = 5,
    Annually = 6,
}

export class InitialisePaymentRequest
{
    public PaymentType: PaymentTypeEnum;
    public Uuid: string;
    public ReferenceNumber: string;
    public Amount: number;
    public Currency: string;
    public ItemName: string;
    public ItemDescription: string;
    public BillingDate: string;
    public Frequency: FrequencyEnum;
    public Cycles: number;

    public constructor(init?: Partial<InitialisePaymentRequest>) { (Object as any).assign(this, init); }
}

TypeScript InitialisePaymentRequest DTOs

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

HTTP + XML

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

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

<InitialisePaymentRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/digitaluapi.ServiceModel">
  <Amount>0</Amount>
  <BillingDate>0001-01-01T00:00:00</BillingDate>
  <CampaignActionsRequestsId>0</CampaignActionsRequestsId>
  <Currency>String</Currency>
  <Cycles>0</Cycles>
  <Frequency>Daily</Frequency>
  <ItemDescription>String</ItemDescription>
  <ItemName>String</ItemName>
  <PaymentType>OneTime</PaymentType>
  <ReferenceNumber>String</ReferenceNumber>
  <Uuid>00000000-0000-0000-0000-000000000000</Uuid>
</InitialisePaymentRequest>

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<InitialisePaymentResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/digitaluapi.ServiceModel">
  <Errors xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:KeyValueOfstringArrayOfstringty7Ep6D1>
      <d2p1:Key>String</d2p1:Key>
      <d2p1:Value>
        <d2p1:string>String</d2p1:string>
      </d2p1:Value>
    </d2p1:KeyValueOfstringArrayOfstringty7Ep6D1>
  </Errors>
  <Message>String</Message>
  <Status>false</Status>
  <Signature>String</Signature>
  <TransactionId>String</TransactionId>
  <Url>String</Url>
</InitialisePaymentResponse>