Starlite API

<back to all web services

CancelTransferFunds

The following routes are available for this service:
POST/CoreBanking/CancelTransfer
import Foundation
import ServiceStack

// @DataContract
public class CancelTransferFunds : ServiceRequestBase
{
    /**
    * The transaction ID associated with the memo post that was returned in the initial response to create the memo post
    */
    // @DataMember
    // @ApiMember(Description="The transaction ID associated with the memo post that was returned in the initial response to create the memo post")
    public var transferTransactionId:String?

    /**
    * The ID of the memo post that was returned in the initial response to create the memo post
    */
    // @DataMember
    // @ApiMember(Description="The ID of the memo post that was returned in the initial response to create the memo post")
    public var memoPostId:Int?

    /**
    * The reason for the cancellation
    */
    // @DataMember
    // @ApiMember(Description="The reason for the cancellation", IsRequired=true)
    public var reason:String?

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

    private enum CodingKeys : String, CodingKey {
        case transferTransactionId
        case memoPostId
        case reason
    }

    required public init(from decoder: Decoder) throws {
        try super.init(from: decoder)
        let container = try decoder.container(keyedBy: CodingKeys.self)
        transferTransactionId = try container.decodeIfPresent(String.self, forKey: .transferTransactionId)
        memoPostId = try container.decodeIfPresent(Int.self, forKey: .memoPostId)
        reason = try container.decodeIfPresent(String.self, forKey: .reason)
    }

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

// @DataContract
public class ServiceRequestBase : IHasVersion, Codable
{
    required public init(){}
}

// @DataContract
public class ServiceResponseBase : Codable
{
    /**
    * Identifies whether the request executed successfully, however does not indicated requested data was found
    */
    // @DataMember
    // @ApiMember(Description="Identifies whether the request executed successfully, however does not indicated requested data was found")
    public var isSuccessful:Bool?

    /**
    * The status code returned by the service
    */
    // @DataMember
    // @ApiMember(Description="The status code returned by the service")
    public var statusCode:Int?

    /**
    * The status message returned by the service
    */
    // @DataMember
    // @ApiMember(Description="The status message returned by the service")
    public var statusMessage:String?

    // @DataMember
    // @ApiMember(ExcludeInSchema=true)
    public var serviceDebugFields:[String:String] = [:]

    required public init(){}
}


Swift CancelTransferFunds 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 /CoreBanking/CancelTransfer HTTP/1.1 
Host: services.allianceassociationbank.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<CancelTransferFunds xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Babel.Framework.ApiPlugins.Starlite.TransferFunds">
  <MemoPostId>0</MemoPostId>
  <Reason>String</Reason>
  <TransferTransactionId>String</TransferTransactionId>
</CancelTransferFunds>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<ServiceResponseBase xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Babel.Framework.ApiContext">
  <IsSuccessful>false</IsSuccessful>
  <ServiceDebugFields xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:KeyValueOfstringstring>
      <d2p1:Key>ApiServiceHost</d2p1:Key>
      <d2p1:Value>AZW-AABWPW03</d2p1:Value>
    </d2p1:KeyValueOfstringstring>
    <d2p1:KeyValueOfstringstring>
      <d2p1:Key>ApiServiceHostVersion</d2p1:Key>
      <d2p1:Value>2016.1.18.3</d2p1:Value>
    </d2p1:KeyValueOfstringstring>
  </ServiceDebugFields>
  <StatusCode>0</StatusCode>
  <StatusMessage>String</StatusMessage>
</ServiceResponseBase>