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 .jsv suffix or ?format=jsv

HTTP + JSV

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: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	PaymentGatewayId: 0
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	PaymentGatewayId: 0,
	Name: String,
	Currency: String,
	TypeName: String,
	GatewayType: Stripe,
	Created: 0001-01-01,
	AccountingStartDate: 0001-01-01,
	IsDefault: False,
	IsPublic: False,
	Disabled: False,
	DisabledReason: String,
	Configuration: 
	{
		ShowConfirmation: False,
		ShowBillingDetails: False,
		GatewayKey: String,
		HideCvv: False,
		MinimumAdultDateOfBirth: 0001-01-01
	},
	Creditor: 
	{
		Id: String,
		Schemes: 
		[
			{
				Id: String,
				Reference: String,
				Email: String,
				PhoneNumber: String
			}
		],
		Name: String,
		AddressLine1: String,
		AddressLine2: String,
		AddressLine3: String,
		City: String,
		CountryCode: String,
		PostalCode: String,
		Region: String,
		TermsAndConditionsUrl: String,
		Countries: 
		[
			String
		]
	},
	IsCreditCard: False,
	IsClubManagerCreditCard: False,
	IsDirectDebit: False,
	HasSignUpLink: False,
	CanProvidePaymentToken: False,
	CanProvidePaymentRedirect: False,
	CanImport: False,
	CanSupplyRawData: False,
	CanImportPaymentMethod: False,
	PublicTranslation: Direct Debit,
	BankAccount: String
}