digitaluapi

OnceOffPaymentRequests

**Requires Authentication**
Required role:	Client

The following routes are available for this service:
POST	/onceoffpayment	Once of Payments


export class OnceOffPaymentResponse
{
    public PublicAccessGuid: string;
    public InvoiceNumber: string;
    public StatusCodesId: number;
    public ResponseStatus: ResponseStatus;

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

export class OnceOffPaymentRequests
{
    // @DataMember(Order=1)
    // @Validate(Validator="NotNull")
    public Segment: string;

    // @DataMember(Order=2)
    // @Validate(Validator="NotNull")
    public FirstName: string;

    // @DataMember(Order=3)
    // @Validate(Validator="NotNull")
    public LastName: string;

    // @DataMember(Order=4)
    public Address: string;

    // @DataMember(Order=5)
    public City: string;

    // @DataMember(Order=6)
    public Region: string;

    // @DataMember(Order=7)
    public Suburb: string;

    // @DataMember(Order=8)
    public PostalCode: string;

    // @DataMember(Order=9)
    public MobileNumber: string;

    // @DataMember(Order=10)
    public Email: string;

    // @DataMember(Order=11)
    public IdNumber: string;

    // @DataMember(Order=12)
    public PassportNumber: string;

    // @DataMember(Order=13)
    // @Validate(Validator="NotNull")
    public InvoiceNumber: string;

    // @DataMember(Order=14)
    public DebtDate: string;

    // @DataMember(Order=15)
    // @Validate(Validator="NotNull")
    public AmountOutstanding: number;

    // @DataMember(Order=16)
    // @Validate(Validator="NotNull")
    public CurrenciesId: number;

    // @DataMember(Order=17)
    // @Validate(Validator="NotNull")
    public ChannelsId: number;

    // @DataMember(Order=18)
    public DebtMeta: { [index:string]: string; };

    // @DataMember(Order=19)
    public CustomersMeta: { [index:string]: string; };

    // @DataMember(Order=20)
    public UrlToDocument: string;

    // @DataMember(Order=21)
    public CustomerUniqueIdentifier: string;

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

TypeScript OnceOffPaymentRequests DTOs

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

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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

POST /onceoffpayment HTTP/1.1 
Host: duengageapi.uat.scadsoftware.com 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"Segment":"String","FirstName":"String","LastName":"String","Address":"String","City":"String","Region":"String","Suburb":"String","PostalCode":"String","MobileNumber":"String","Email":"String","IdNumber":"String","PassportNumber":"String","InvoiceNumber":"String","DebtDate":"0001-01-01T00:00:00.0000000","AmountOutstanding":0,"CurrenciesId":0,"ChannelsId":0,"DebtMeta":{"String":"String"},"CustomersMeta":{"String":"String"},"UrlToDocument":"String","CustomerUniqueIdentifier":"String"}

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

{"PublicAccessGuid":"00000000000000000000000000000000","InvoiceNumber":"String","StatusCodesId":0,"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}