ClubManager.Api

<back to all web services

PaymentGatewayService.GetPaymentGatewayByIdRequest

Requires Authentication
The following routes are available for this service:
POST,GET/api/PaymentGateway/GetPaymentGatewayById
using System;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using ClubManager.Interfaces.Models.PaymentGateway;

namespace ClubManager.Interfaces.Models.PaymentGateway
{
    public partial class Configuration
    {
        public virtual bool ShowConfirmation { get; set; }
        public virtual bool ShowBillingDetails { get; set; }
        public virtual string GatewayKey { get; set; }
        public virtual bool HideCvv { get; set; }
        public virtual DateTime MinimumAdultDateOfBirth { get; set; }
    }

    public partial class Creditor
    {
        public Creditor()
        {
            Schemes = new Scheme[]{};
            Countries = new string[]{};
        }

        public virtual string Id { get; set; }
        public virtual Scheme[] Schemes { get; set; }
        public virtual string Name { get; set; }
        public virtual string AddressLine1 { get; set; }
        public virtual string AddressLine2 { get; set; }
        public virtual string AddressLine3 { get; set; }
        public virtual string City { get; set; }
        public virtual string CountryCode { get; set; }
        public virtual string PostalCode { get; set; }
        public virtual string Region { get; set; }
        public virtual string TermsAndConditionsUrl { get; set; }
        public virtual string[] Countries { get; set; }
    }

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

    public partial class PaymentGateway
    {
        public virtual int PaymentGatewayId { get; set; }
        public virtual string Name { get; set; }
        public virtual string Currency { get; set; }
        public virtual string TypeName { get; set; }
        public virtual GatewayType GatewayType { get; set; }
        public virtual DateTime Created { get; set; }
        public virtual DateTime AccountingStartDate { get; set; }
        public virtual bool IsDefault { get; set; }
        public virtual bool IsPublic { get; set; }
        public virtual bool Disabled { get; set; }
        public virtual string DisabledReason { get; set; }
        public virtual Configuration Configuration { get; set; }
        public virtual Creditor Creditor { get; set; }
        public virtual bool IsCreditCard { get; set; }
        public virtual bool IsClubManagerCreditCard { get; set; }
        public virtual bool IsDirectDebit { get; set; }
        public virtual bool HasSignUpLink { get; set; }
        public virtual bool CanProvidePaymentToken { get; set; }
        public virtual bool CanProvidePaymentRedirect { get; set; }
        public virtual bool CanImport { get; set; }
        public virtual bool CanSupplyRawData { get; set; }
        public virtual bool CanImportPaymentMethod { get; set; }
        public virtual string PublicTranslation { get; set; }
        public virtual string BankAccount { get; set; }
    }

    public partial class Scheme
    {
        public virtual string Id { get; set; }
        public virtual string Reference { get; set; }
        public virtual string Email { get; set; }
        public virtual string PhoneNumber { get; set; }
    }

}

C# 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>