digitaluapi

OnceOffPaymentRequests

**Requires Authentication**
Required role:	Client

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

import datetime
import decimal
from marshmallow.fields import *
from servicestack import *
from typing import *
from dataclasses import dataclass, field
from dataclasses_json import dataclass_json, LetterCase, Undefined, config
from enum import Enum, IntEnum


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class OnceOffPaymentResponse:
    public_access_guid: Optional[str] = None
    invoice_number: Optional[str] = None
    status_codes_id: int = 0
    response_status: Optional[ResponseStatus] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class OnceOffPaymentRequests:
    # @Validate(Validator="NotNull")
    segment: Optional[str] = None

    # @Validate(Validator="NotNull")
    first_name: Optional[str] = None

    # @Validate(Validator="NotNull")
    last_name: Optional[str] = None

    address: Optional[str] = None
    city: Optional[str] = None
    region: Optional[str] = None
    suburb: Optional[str] = None
    postal_code: Optional[str] = None
    mobile_number: Optional[str] = None
    email: Optional[str] = None
    id_number: Optional[str] = None
    passport_number: Optional[str] = None
    # @Validate(Validator="NotNull")
    invoice_number: Optional[str] = None

    debt_date: datetime.datetime = datetime.datetime(1, 1, 1)
    # @Validate(Validator="NotNull")
    amount_outstanding: float = 0.0

    # @Validate(Validator="NotNull")
    currencies_id: int = 0

    # @Validate(Validator="NotNull")
    channels_id: int = 0

    debt_meta: Optional[Dict[str, str]] = None
    customers_meta: Optional[Dict[str, str]] = None
    url_to_document: Optional[str] = None
    customer_unique_identifier: Optional[str] = None

Python OnceOffPaymentRequests 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 /onceoffpayment HTTP/1.1 
Host: duengageapi.uat.scadsoftware.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<OnceOffPaymentRequests xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/digitaluapi.ServiceModel">
  <Address>String</Address>
  <AmountOutstanding>0</AmountOutstanding>
  <ChannelsId>0</ChannelsId>
  <City>String</City>
  <CurrenciesId>0</CurrenciesId>
  <CustomerUniqueIdentifier>String</CustomerUniqueIdentifier>
  <CustomersMeta xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:KeyValueOfstringstring>
      <d2p1:Key>String</d2p1:Key>
      <d2p1:Value>String</d2p1:Value>
    </d2p1:KeyValueOfstringstring>
  </CustomersMeta>
  <DebtDate>0001-01-01T00:00:00</DebtDate>
  <DebtMeta xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:KeyValueOfstringstring>
      <d2p1:Key>String</d2p1:Key>
      <d2p1:Value>String</d2p1:Value>
    </d2p1:KeyValueOfstringstring>
  </DebtMeta>
  <Email>String</Email>
  <FirstName>String</FirstName>
  <IdNumber>String</IdNumber>
  <InvoiceNumber>String</InvoiceNumber>
  <LastName>String</LastName>
  <MobileNumber>String</MobileNumber>
  <PassportNumber>String</PassportNumber>
  <PostalCode>String</PostalCode>
  <Region>String</Region>
  <Segment>String</Segment>
  <Suburb>String</Suburb>
  <UrlToDocument>String</UrlToDocument>
</OnceOffPaymentRequests>

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

<OnceOffPaymentResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/digitaluapi.ServiceModel">
  <InvoiceNumber>String</InvoiceNumber>
  <PublicAccessGuid>00000000-0000-0000-0000-000000000000</PublicAccessGuid>
  <ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
    <d2p1:ErrorCode>String</d2p1:ErrorCode>
    <d2p1:Message>String</d2p1:Message>
    <d2p1:StackTrace>String</d2p1:StackTrace>
    <d2p1:Errors>
      <d2p1:ResponseError>
        <d2p1:ErrorCode>String</d2p1:ErrorCode>
        <d2p1:FieldName>String</d2p1:FieldName>
        <d2p1:Message>String</d2p1:Message>
        <d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </d2p1:Meta>
      </d2p1:ResponseError>
    </d2p1:Errors>
    <d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value>String</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </d2p1:Meta>
  </ResponseStatus>
  <StatusCodesId>0</StatusCodesId>
</OnceOffPaymentResponse>