ClubManager.Api

<back to all web services

PaymentGatewayService.GetPaymentGatewayByIdRequest

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

export 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,
}

export class Configuration
{
    public ShowConfirmation?: boolean;
    public ShowBillingDetails?: boolean;
    public GatewayKey?: string;
    public HideCvv?: boolean;
    public MinimumAdultDateOfBirth?: string;

    public constructor(init?: Partial<Configuration>) { (Object as any).assign(this, init); }
}

export class Creditor
{
    public Id?: string;
    public Schemes?: Scheme[];
    public Name?: string;
    public AddressLine1?: string;
    public AddressLine2?: string;
    public AddressLine3?: string;
    public City?: string;
    public CountryCode?: string;
    public PostalCode?: string;
    public Region?: string;
    public TermsAndConditionsUrl?: string;
    public Countries?: string[];

    public constructor(init?: Partial<Creditor>) { (Object as any).assign(this, init); }
}

export class PaymentGateway
{
    public PaymentGatewayId?: number;
    public Name?: string;
    public Currency?: string;
    public TypeName?: string;
    public GatewayType?: GatewayType;
    public Created?: string;
    public AccountingStartDate?: string;
    public IsDefault?: boolean;
    public IsPublic?: boolean;
    public Disabled?: boolean;
    public DisabledReason?: string;
    public Configuration?: Configuration;
    public Creditor?: Creditor;
    public IsCreditCard?: boolean;
    public IsClubManagerCreditCard?: boolean;
    public IsDirectDebit?: boolean;
    public HasSignUpLink?: boolean;
    public CanProvidePaymentToken?: boolean;
    public CanProvidePaymentRedirect?: boolean;
    public CanImport?: boolean;
    public CanSupplyRawData?: boolean;
    public CanImportPaymentMethod?: boolean;
    public PublicTranslation?: string;
    public BankAccount?: string;

    public constructor(init?: Partial<PaymentGateway>) { (Object as any).assign(this, init); }
}

export class Scheme
{
    public Id?: string;
    public Reference?: string;
    public Email?: string;
    public PhoneNumber?: string;

    public constructor(init?: Partial<Scheme>) { (Object as any).assign(this, init); }
}

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