digitaluapi

<back to all web services

OnceOffPaymentRequests

Requires Authentication
Required role:Client
The following routes are available for this service:
POST/onceoffpaymentOnce of Payments
using System;
using System.IO;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using digitaluapi.ServiceModel;

namespace digitaluapi.ServiceModel
{
    public partial class OnceOffPaymentRequests
    {
        [DataMember(Order=1)]
        [Validate("NotNull")]
        public virtual string Segment { get; set; }

        [DataMember(Order=2)]
        [Validate("NotNull")]
        public virtual string FirstName { get; set; }

        [DataMember(Order=3)]
        [Validate("NotNull")]
        public virtual string LastName { get; set; }

        [DataMember(Order=4)]
        public virtual string Address { get; set; }

        [DataMember(Order=5)]
        public virtual string City { get; set; }

        [DataMember(Order=6)]
        public virtual string Region { get; set; }

        [DataMember(Order=7)]
        public virtual string Suburb { get; set; }

        [DataMember(Order=8)]
        public virtual string PostalCode { get; set; }

        [DataMember(Order=9)]
        public virtual string MobileNumber { get; set; }

        [DataMember(Order=10)]
        public virtual string Email { get; set; }

        [DataMember(Order=11)]
        public virtual string IdNumber { get; set; }

        [DataMember(Order=12)]
        public virtual string PassportNumber { get; set; }

        [DataMember(Order=13)]
        [Validate("NotNull")]
        public virtual string InvoiceNumber { get; set; }

        [DataMember(Order=14)]
        public virtual DateTime DebtDate { get; set; }

        [DataMember(Order=15)]
        [Validate("NotNull")]
        public virtual double AmountOutstanding { get; set; }

        [DataMember(Order=16)]
        [Validate("NotNull")]
        public virtual int CurrenciesId { get; set; }

        [DataMember(Order=17)]
        [Validate("NotNull")]
        public virtual int ChannelsId { get; set; }

        [DataMember(Order=18)]
        public virtual Dictionary<string, string> DebtMeta { get; set; }

        [DataMember(Order=19)]
        public virtual Dictionary<string, string> CustomersMeta { get; set; }

        [DataMember(Order=20)]
        public virtual string UrlToDocument { get; set; }

        [DataMember(Order=21)]
        public virtual string CustomerUniqueIdentifier { get; set; }
    }

    public partial class OnceOffPaymentResponse
    {
        public virtual Guid PublicAccessGuid { get; set; }
        public virtual string InvoiceNumber { get; set; }
        public virtual long StatusCodesId { get; set; }
        public virtual ResponseStatus ResponseStatus { get; set; }
    }

}

C# OnceOffPaymentRequests DTOs

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

HTTP + CSV

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/csv
Content-Type: text/csv
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: text/csv
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"}}}