digitaluapi

OnceOffPaymentRequests

**Requires Authentication**
Required role:	Client

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

import Foundation
import ServiceStack

public class OnceOffPaymentRequests : Codable
{
    // @DataMember(Order=1)
    // @Validate(Validator="NotNull")
    public var segment:String

    // @DataMember(Order=2)
    // @Validate(Validator="NotNull")
    public var firstName:String

    // @DataMember(Order=3)
    // @Validate(Validator="NotNull")
    public var lastName:String

    // @DataMember(Order=4)
    public var address:String

    // @DataMember(Order=5)
    public var city:String

    // @DataMember(Order=6)
    public var region:String

    // @DataMember(Order=7)
    public var suburb:String

    // @DataMember(Order=8)
    public var postalCode:String

    // @DataMember(Order=9)
    public var mobileNumber:String

    // @DataMember(Order=10)
    public var email:String

    // @DataMember(Order=11)
    public var idNumber:String

    // @DataMember(Order=12)
    public var passportNumber:String

    // @DataMember(Order=13)
    // @Validate(Validator="NotNull")
    public var invoiceNumber:String

    // @DataMember(Order=14)
    public var debtDate:Date

    // @DataMember(Order=15)
    // @Validate(Validator="NotNull")
    public var amountOutstanding:Double

    // @DataMember(Order=16)
    // @Validate(Validator="NotNull")
    public var currenciesId:Int

    // @DataMember(Order=17)
    // @Validate(Validator="NotNull")
    public var channelsId:Int

    // @DataMember(Order=18)
    public var debtMeta:[String:String]

    // @DataMember(Order=19)
    public var customersMeta:[String:String]

    // @DataMember(Order=20)
    public var urlToDocument:String

    // @DataMember(Order=21)
    public var customerUniqueIdentifier:String

    required public init(){}
}

public class OnceOffPaymentResponse : Codable
{
    public var publicAccessGuid:String
    public var invoiceNumber:String
    public var statusCodesId:Int
    public var responseStatus:ResponseStatus

    required public init(){}
}

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