digitaluapi

OnceOffPaymentRequests

**Requires Authentication**
Required role:	Client

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

"use strict";
export class OnceOffPaymentResponse {
    /** @param {{PublicAccessGuid?:string,InvoiceNumber?:string,StatusCodesId?:number,ResponseStatus?:ResponseStatus}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    PublicAccessGuid;
    /** @type {string} */
    InvoiceNumber;
    /** @type {number} */
    StatusCodesId;
    /** @type {ResponseStatus} */
    ResponseStatus;
}
export class OnceOffPaymentRequests {
    /** @param {{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?:string,AmountOutstanding?:number,CurrenciesId?:number,ChannelsId?:number,DebtMeta?:{ [index:string]: string; },CustomersMeta?:{ [index:string]: string; },UrlToDocument?:string,CustomerUniqueIdentifier?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    Segment;
    /** @type {string} */
    FirstName;
    /** @type {string} */
    LastName;
    /** @type {string} */
    Address;
    /** @type {string} */
    City;
    /** @type {string} */
    Region;
    /** @type {string} */
    Suburb;
    /** @type {string} */
    PostalCode;
    /** @type {string} */
    MobileNumber;
    /** @type {string} */
    Email;
    /** @type {string} */
    IdNumber;
    /** @type {string} */
    PassportNumber;
    /** @type {string} */
    InvoiceNumber;
    /** @type {string} */
    DebtDate;
    /** @type {number} */
    AmountOutstanding;
    /** @type {number} */
    CurrenciesId;
    /** @type {number} */
    ChannelsId;
    /** @type {{ [index:string]: string; }} */
    DebtMeta;
    /** @type {{ [index:string]: string; }} */
    CustomersMeta;
    /** @type {string} */
    UrlToDocument;
    /** @type {string} */
    CustomerUniqueIdentifier;
}

JavaScript OnceOffPaymentRequests DTOs

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

HTTP + JSV

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: text/jsv
Content-Type: text/jsv
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-01,
	AmountOutstanding: 0,
	CurrenciesId: 0,
	ChannelsId: 0,
	DebtMeta: 
	{
		String: String
	},
	CustomersMeta: 
	{
		String: String
	},
	UrlToDocument: String,
	CustomerUniqueIdentifier: String
}

HTTP/1.1 200 OK
Content-Type: text/jsv
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
		}
	}
}