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 java.math.*;
import java.util.*;
import net.servicestack.client.*;

public class dtos
{

    public static class PaymentGateway
    {
        public Integer PaymentGatewayId = null;
        public String Name = null;
        public String Currency = null;
        public String TypeName = null;
        public GatewayType GatewayType = null;
        public Date Created = null;
        public Date AccountingStartDate = null;
        public Boolean IsDefault = null;
        public Boolean IsPublic = null;
        public Boolean Disabled = null;
        public String DisabledReason = null;
        public Configuration Configuration = null;
        public Creditor Creditor = null;
        public Boolean IsCreditCard = null;
        public Boolean IsClubManagerCreditCard = null;
        public Boolean IsDirectDebit = null;
        public Boolean HasSignUpLink = null;
        public Boolean CanProvidePaymentToken = null;
        public Boolean CanProvidePaymentRedirect = null;
        public Boolean CanImport = null;
        public Boolean CanSupplyRawData = null;
        public Boolean CanImportPaymentMethod = null;
        public String PublicTranslation = null;
        public String BankAccount = null;
        
        public Integer getPaymentGatewayId() { return PaymentGatewayId; }
        public PaymentGateway setPaymentGatewayId(Integer value) { this.PaymentGatewayId = value; return this; }
        public String getName() { return Name; }
        public PaymentGateway setName(String value) { this.Name = value; return this; }
        public String getCurrency() { return Currency; }
        public PaymentGateway setCurrency(String value) { this.Currency = value; return this; }
        public String getTypeName() { return TypeName; }
        public PaymentGateway setTypeName(String value) { this.TypeName = value; return this; }
        public GatewayType getGatewayType() { return GatewayType; }
        public PaymentGateway setGatewayType(GatewayType value) { this.GatewayType = value; return this; }
        public Date getCreated() { return Created; }
        public PaymentGateway setCreated(Date value) { this.Created = value; return this; }
        public Date getAccountingStartDate() { return AccountingStartDate; }
        public PaymentGateway setAccountingStartDate(Date value) { this.AccountingStartDate = value; return this; }
        public Boolean getIsDefault() { return IsDefault; }
        public PaymentGateway setIsDefault(Boolean value) { this.IsDefault = value; return this; }
        public Boolean getIsPublic() { return IsPublic; }
        public PaymentGateway setIsPublic(Boolean value) { this.IsPublic = value; return this; }
        public Boolean isDisabled() { return Disabled; }
        public PaymentGateway setDisabled(Boolean value) { this.Disabled = value; return this; }
        public String getDisabledReason() { return DisabledReason; }
        public PaymentGateway setDisabledReason(String value) { this.DisabledReason = value; return this; }
        public Configuration getConfiguration() { return Configuration; }
        public PaymentGateway setConfiguration(Configuration value) { this.Configuration = value; return this; }
        public Creditor getCreditor() { return Creditor; }
        public PaymentGateway setCreditor(Creditor value) { this.Creditor = value; return this; }
        public Boolean getIsCreditCard() { return IsCreditCard; }
        public PaymentGateway setIsCreditCard(Boolean value) { this.IsCreditCard = value; return this; }
        public Boolean getIsClubManagerCreditCard() { return IsClubManagerCreditCard; }
        public PaymentGateway setIsClubManagerCreditCard(Boolean value) { this.IsClubManagerCreditCard = value; return this; }
        public Boolean getIsDirectDebit() { return IsDirectDebit; }
        public PaymentGateway setIsDirectDebit(Boolean value) { this.IsDirectDebit = value; return this; }
        public Boolean isHasSignUpLink() { return HasSignUpLink; }
        public PaymentGateway setHasSignUpLink(Boolean value) { this.HasSignUpLink = value; return this; }
        public Boolean isCanProvidePaymentToken() { return CanProvidePaymentToken; }
        public PaymentGateway setCanProvidePaymentToken(Boolean value) { this.CanProvidePaymentToken = value; return this; }
        public Boolean isCanProvidePaymentRedirect() { return CanProvidePaymentRedirect; }
        public PaymentGateway setCanProvidePaymentRedirect(Boolean value) { this.CanProvidePaymentRedirect = value; return this; }
        public Boolean isCanImport() { return CanImport; }
        public PaymentGateway setCanImport(Boolean value) { this.CanImport = value; return this; }
        public Boolean isCanSupplyRawData() { return CanSupplyRawData; }
        public PaymentGateway setCanSupplyRawData(Boolean value) { this.CanSupplyRawData = value; return this; }
        public Boolean isCanImportPaymentMethod() { return CanImportPaymentMethod; }
        public PaymentGateway setCanImportPaymentMethod(Boolean value) { this.CanImportPaymentMethod = value; return this; }
        public String getPublicTranslation() { return PublicTranslation; }
        public PaymentGateway setPublicTranslation(String value) { this.PublicTranslation = value; return this; }
        public String getBankAccount() { return BankAccount; }
        public PaymentGateway setBankAccount(String value) { this.BankAccount = value; return this; }
    }

    public static enum GatewayType
    {
        Stripe(1),
        GoCardlessPro(2),
        Dfc(3),
        SmartDebit(4),
        Harlands(6),
        SageOne(7),
        NuPay(8),
        Eft(9),
        PesaPal(10),
        PayPalSms(12),
        PayChoiceCreditCard(13),
        PayChoiceBankAccount(14),
        EDebitCreditCard(15),
        EDebitBankAccount(16),
        DoBillingPayFastCreditCard(17),
        DoBillingNedBankEFTBankAccount(18),
        HarlandsCloud(19),
        IntegraPayCreditCard(20),
        IntegraPayBankAccount(21),
        Payfast(22);

        private final int value;
        GatewayType(final int intValue) { value = intValue; }
        public int getValue() { return value; }
    }

    public static class Configuration
    {
        public Boolean ShowConfirmation = null;
        public Boolean ShowBillingDetails = null;
        public String GatewayKey = null;
        public Boolean HideCvv = null;
        public Date MinimumAdultDateOfBirth = null;
        
        public Boolean isShowConfirmation() { return ShowConfirmation; }
        public Configuration setShowConfirmation(Boolean value) { this.ShowConfirmation = value; return this; }
        public Boolean isShowBillingDetails() { return ShowBillingDetails; }
        public Configuration setShowBillingDetails(Boolean value) { this.ShowBillingDetails = value; return this; }
        public String getGatewayKey() { return GatewayKey; }
        public Configuration setGatewayKey(String value) { this.GatewayKey = value; return this; }
        public Boolean isHideCvv() { return HideCvv; }
        public Configuration setHideCvv(Boolean value) { this.HideCvv = value; return this; }
        public Date getMinimumAdultDateOfBirth() { return MinimumAdultDateOfBirth; }
        public Configuration setMinimumAdultDateOfBirth(Date value) { this.MinimumAdultDateOfBirth = value; return this; }
    }

    public static class Creditor
    {
        public String Id = null;
        public ArrayList<Scheme> Schemes = null;
        public String Name = null;
        public String AddressLine1 = null;
        public String AddressLine2 = null;
        public String AddressLine3 = null;
        public String City = null;
        public String CountryCode = null;
        public String PostalCode = null;
        public String Region = null;
        public String TermsAndConditionsUrl = null;
        public ArrayList<String> Countries = null;
        
        public String getId() { return Id; }
        public Creditor setId(String value) { this.Id = value; return this; }
        public ArrayList<Scheme> getSchemes() { return Schemes; }
        public Creditor setSchemes(ArrayList<Scheme> value) { this.Schemes = value; return this; }
        public String getName() { return Name; }
        public Creditor setName(String value) { this.Name = value; return this; }
        public String getAddressLine1() { return AddressLine1; }
        public Creditor setAddressLine1(String value) { this.AddressLine1 = value; return this; }
        public String getAddressLine2() { return AddressLine2; }
        public Creditor setAddressLine2(String value) { this.AddressLine2 = value; return this; }
        public String getAddressLine3() { return AddressLine3; }
        public Creditor setAddressLine3(String value) { this.AddressLine3 = value; return this; }
        public String getCity() { return City; }
        public Creditor setCity(String value) { this.City = value; return this; }
        public String getCountryCode() { return CountryCode; }
        public Creditor setCountryCode(String value) { this.CountryCode = value; return this; }
        public String getPostalCode() { return PostalCode; }
        public Creditor setPostalCode(String value) { this.PostalCode = value; return this; }
        public String getRegion() { return Region; }
        public Creditor setRegion(String value) { this.Region = value; return this; }
        public String getTermsAndConditionsUrl() { return TermsAndConditionsUrl; }
        public Creditor setTermsAndConditionsUrl(String value) { this.TermsAndConditionsUrl = value; return this; }
        public ArrayList<String> getCountries() { return Countries; }
        public Creditor setCountries(ArrayList<String> value) { this.Countries = value; return this; }
    }

    public static class Scheme
    {
        public String Id = null;
        public String Reference = null;
        public String Email = null;
        public String PhoneNumber = null;
        
        public String getId() { return Id; }
        public Scheme setId(String value) { this.Id = value; return this; }
        public String getReference() { return Reference; }
        public Scheme setReference(String value) { this.Reference = value; return this; }
        public String getEmail() { return Email; }
        public Scheme setEmail(String value) { this.Email = value; return this; }
        public String getPhoneNumber() { return PhoneNumber; }
        public Scheme setPhoneNumber(String value) { this.PhoneNumber = value; return this; }
    }

}

Java 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>