ClubManager.Api

<back to all web services

PaymentGatewayService.GetPaymentGatewayByIdRequest

Requires Authentication
The following routes are available for this service:
POST,GET/api/PaymentGateway/GetPaymentGatewayById
import Foundation
import ServiceStack

public class PaymentGateway : Codable
{
    public var paymentGatewayId:Int?
    public var name:String?
    public var currency:String?
    public var typeName:String?
    public var gatewayType:GatewayType?
    public var created:Date?
    public var accountingStartDate:Date?
    public var isDefault:Bool?
    public var isPublic:Bool?
    public var disabled:Bool?
    public var disabledReason:String?
    public var configuration:Configuration?
    public var creditor:Creditor?
    public var isCreditCard:Bool?
    public var isClubManagerCreditCard:Bool?
    public var isDirectDebit:Bool?
    public var hasSignUpLink:Bool?
    public var canProvidePaymentToken:Bool?
    public var canProvidePaymentRedirect:Bool?
    public var canImport:Bool?
    public var canSupplyRawData:Bool?
    public var canImportPaymentMethod:Bool?
    public var publicTranslation:String?
    public var bankAccount:String?

    required public init(){}
}

public enum GatewayType : Int, Codable
{
    case Stripe = 1
    case GoCardlessPro = 2
    case Dfc = 3
    case SmartDebit = 4
    case Harlands = 6
    case SageOne = 7
    case NuPay = 8
    case EFT = 9
    case PesaPal = 10
    case PayPalSms = 12
    case PayChoiceCreditCard = 13
    case PayChoiceBankAccount = 14
    case eDebitCreditCard = 15
    case eDebitBankAccount = 16
    case DoBillingPayFastCreditCard = 17
    case DoBillingNedBankEFTBankAccount = 18
    case HarlandsCloud = 19
    case IntegraPayCreditCard = 20
    case IntegraPayBankAccount = 21
    case Payfast = 22
}

public class Configuration : Codable
{
    public var showConfirmation:Bool?
    public var showBillingDetails:Bool?
    public var gatewayKey:String?
    public var hideCvv:Bool?
    public var minimumAdultDateOfBirth:Date?

    required public init(){}
}

public class Creditor : Codable
{
    public var id:String?
    public var schemes:[Scheme] = []
    public var name:String?
    public var addressLine1:String?
    public var addressLine2:String?
    public var addressLine3:String?
    public var city:String?
    public var countryCode:String?
    public var postalCode:String?
    public var region:String?
    public var termsAndConditionsUrl:String?
    public var countries:[String] = []

    required public init(){}
}

public class Scheme : Codable
{
    public var id:String?
    public var reference:String?
    public var email:String?
    public var phoneNumber:String?

    required public init(){}
}


Swift PaymentGatewayService.GetPaymentGatewayByIdRequest 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 /api/PaymentGateway/GetPaymentGatewayById HTTP/1.1 
Host: api.clubmanagercentral.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<PaymentGatewayService.GetPaymentGatewayByIdRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ClubManager.Api.Services">
  <PaymentGatewayId>0</PaymentGatewayId>
</PaymentGatewayService.GetPaymentGatewayByIdRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<PaymentGateway xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ClubManager.Interfaces.Models.PaymentGateway">
  <AccountingStartDate>0001-01-01T00:00:00</AccountingStartDate>
  <BankAccount>String</BankAccount>
  <BranchId>0</BranchId>
  <Created>0001-01-01T00:00:00</Created>
  <Creditor>
    <AddressLine1>String</AddressLine1>
    <AddressLine2>String</AddressLine2>
    <AddressLine3>String</AddressLine3>
    <City>String</City>
    <Countries xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:string>String</d3p1:string>
    </Countries>
    <CountryCode>String</CountryCode>
    <Id>String</Id>
    <Name>String</Name>
    <PostalCode>String</PostalCode>
    <Region>String</Region>
    <Schemes>
      <Scheme>
        <Email>String</Email>
        <Id>String</Id>
        <PhoneNumber>String</PhoneNumber>
        <Reference>String</Reference>
      </Scheme>
    </Schemes>
    <TermsAndConditionsUrl>String</TermsAndConditionsUrl>
  </Creditor>
  <Currency>String</Currency>
  <Disabled>false</Disabled>
  <DisabledReason>String</DisabledReason>
  <GatewayType>Stripe</GatewayType>
  <IsDefault>false</IsDefault>
  <IsPublic>false</IsPublic>
  <Metadata>String</Metadata>
  <Name>String</Name>
  <PaymentGatewayId>0</PaymentGatewayId>
  <Token>String</Token>
  <TypeName>String</TypeName>
</PaymentGateway>