ClubManager.Api

<back to all web services

PaymentGatewayService.GetPaymentGatewayByIdRequest

Requires Authentication
The following routes are available for this service:
POST,GET/api/PaymentGateway/GetPaymentGatewayById
PaymentGateway Parameters:
NameParameterData TypeRequiredDescription
PaymentGatewayIdformintNo
NameformstringNo
CurrencyformstringNo
TypeNameformstringNo
GatewayTypeformGatewayTypeNo
CreatedformDateTimeNo
AccountingStartDateformDateTimeNo
IsDefaultformboolNo
IsPublicformboolNo
DisabledformboolNo
DisabledReasonformstringNo
ConfigurationformConfigurationNo
CreditorformCreditorNo
IsCreditCardformboolNo
IsClubManagerCreditCardformboolNo
IsDirectDebitformboolNo
HasSignUpLinkformboolNo
CanProvidePaymentTokenformboolNo
CanProvidePaymentRedirectformboolNo
CanImportformboolNo
CanSupplyRawDataformboolNo
CanImportPaymentMethodformboolNo
PublicTranslationformstringNo
BankAccountformstringNo
Configuration Parameters:
NameParameterData TypeRequiredDescription
ShowConfirmationformboolNo
ShowBillingDetailsformboolNo
GatewayKeyformstringNo
HideCvvformboolNo
MinimumAdultDateOfBirthformDateTimeNo
Creditor Parameters:
NameParameterData TypeRequiredDescription
IdformstringNo
SchemesformScheme[]No
NameformstringNo
AddressLine1formstringNo
AddressLine2formstringNo
AddressLine3formstringNo
CityformstringNo
CountryCodeformstringNo
PostalCodeformstringNo
RegionformstringNo
TermsAndConditionsUrlformstringNo
Countriesformstring[]No
Scheme Parameters:
NameParameterData TypeRequiredDescription
IdformstringNo
ReferenceformstringNo
EmailformstringNo
PhoneNumberformstringNo

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
}