Billhighway Cloud API

<back to all web services

ccPaymentByGroup

import Foundation
import ServiceStack

public class ccPaymentByGroup : ccPaymentByGroup, ICanBeRecurring
{
    required public init(){ super.init() }

    required public init(from decoder: Decoder) throws {
        try super.init(from: decoder)
    }

    public override func encode(to encoder: Encoder) throws {
        try super.encode(to: encoder)
    }
}

// @DataContract(Namespace="www.billhighway.com/api")
public class ccPaymentByGroupResponse : LegacyApiResponse
{
    // @DataMember(Name="ccPaymentByGroupResult")
    public var results:SoapArrayList?

    required public init(){ super.init() }

    private enum CodingKeys : String, CodingKey {
        case results
    }

    required public init(from decoder: Decoder) throws {
        try super.init(from: decoder)
        let container = try decoder.container(keyedBy: CodingKeys.self)
        results = try container.decodeIfPresent(SoapArrayList.self, forKey: .results)
    }

    public override func encode(to encoder: Encoder) throws {
        try super.encode(to: encoder)
        var container = encoder.container(keyedBy: CodingKeys.self)
        if results != nil { try container.encode(results, forKey: .results) }
    }
}

// @DataContract(Namespace="www.billhighway.com/api")
public class LegacyApiResponse : IHaveErrorField, Codable
{
    // @DataMember
    public var amount:Double?

    // @DataMember
    public var confirmationNumber:String?

    // @DataMember
    public var responseCode:String?

    // @DataMember
    public var responseDescription:String?

    // @DataMember
    public var resultCode:ResultCode?

    required public init(){}
}

public enum ResultCode : Int, Codable
{
    case Success = 0
    case Duplicate = -7
    case NotAvailable = -6
    case NotFound = -5
    case GeneralError = -4
    case UnexpectedError = -3
    case CreditCardDeclined = -2
    case DataValidationFailure = -1
}

public class SoapArrayList : ArrayList
{
    required public init(){ super.init() }

    required public init(from decoder: Decoder) throws {
        try super.init(from: decoder)
    }

    public override func encode(to encoder: Encoder) throws {
        try super.encode(to: encoder)
    }
}

Swift ccPaymentByGroup DTOs

POST /xml/reply/ccPaymentByGroup HTTP/1.1 
Host: devapi.billhighway.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<ccPaymentByGroup xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BH.CloudAPI.Common4.DTO.SOAP">
  <apiKey xmlns="www.billhighway.com/api">String</apiKey>
  <featureID xmlns="www.billhighway.com/api">0</featureID>
  <clientID xmlns="www.billhighway.com/api">0</clientID>
  <groupID xmlns="www.billhighway.com/api">0</groupID>
  <Amount xmlns="www.billhighway.com/api">0</Amount>
  <nameOnCard xmlns="www.billhighway.com/api">String</nameOnCard>
  <cardType xmlns="www.billhighway.com/api">String</cardType>
  <cardNumber xmlns="www.billhighway.com/api">String</cardNumber>
  <expMonth xmlns="www.billhighway.com/api">String</expMonth>
  <expYear xmlns="www.billhighway.com/api">String</expYear>
  <cvv xmlns="www.billhighway.com/api">String</cvv>
  <address xmlns="www.billhighway.com/api">String</address>
  <city xmlns="www.billhighway.com/api">String</city>
  <state xmlns="www.billhighway.com/api">String</state>
  <postalCode xmlns="www.billhighway.com/api">String</postalCode>
  <email xmlns="www.billhighway.com/api">String</email>
  <memo xmlns="www.billhighway.com/api">String</memo>
  <occurs xmlns="www.billhighway.com/api">String</occurs>
  <numberOfOccurrences xmlns="www.billhighway.com/api">String</numberOfOccurrences>
</ccPaymentByGroup>

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

<ccPaymentByGroupResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="www.billhighway.com/api">
  <amount>0</amount>
  <confirmationNumber>String</confirmationNumber>
  <responseCode>String</responseCode>
  <responseDescription>String</responseDescription>
  <resultCode>Success</resultCode>
  <ccPaymentByGroupResult>
    <anyType xmlns:d3p1="http://www.w3.org/2001/XMLSchema" i:type="d3p1:int">0</anyType>
    <anyType xmlns:d3p1="http://www.w3.org/2001/XMLSchema" i:type="d3p1:int">0</anyType>
    <anyType xmlns:d3p1="http://www.w3.org/2001/XMLSchema" i:type="d3p1:decimal">0</anyType>
    <anyType xmlns:d3p1="http://www.w3.org/2001/XMLSchema" i:type="d3p1:string">String</anyType>
    <anyType xmlns:d3p1="http://www.w3.org/2001/XMLSchema" i:type="d3p1:string">String</anyType>
    <anyType xmlns:d3p1="http://www.w3.org/2001/XMLSchema" i:type="d3p1:string">0</anyType>
  </ccPaymentByGroupResult>
</ccPaymentByGroupResponse>