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
CanExportCustomerDataformboolNo
CanPingformboolNo
CanSupplyPaymentsformboolNo
CanSupplyPayoutsformboolNo
CanSupplySubscriptionsformboolNo
CanImportPaymentMethodformboolNo
PublicTranslationformstringNo
BankAccountformstringNo
GatewayType Enum:
NameValue
Stripe1
GoCardlessPro2
Dfc3
SmartDebit4
Harlands6
SageOne7
NuPay8
EFT9
PesaPal10
PayPalSms12
PayChoiceCreditCard13
PayChoiceBankAccount14
eDebitCreditCard15
eDebitBankAccount16
DoBillingPayFastCreditCard17
DoBillingNedBankEFTBankAccount18
HarlandsCloud19
WorldpayCreditCard20
WorldpayBankAccount21
Payfast22
WorldPayFPUKCreditCard23
WorldPayFPUKDD24
RazorPayEmail25
WorldPayFPNZCreditCard26
WorldPayFPNZDD27
HarlandsDDMS28
Configuration Parameters:
NameParameterData TypeRequiredDescription
ShowConfirmationformboolNo
ShowBillingDetailsformboolNo
GatewayKeyformstringNo
HideCvvformboolNo
MinimumAdultDateOfBirthformDateTimeNo
ShowIbanformboolNo
ShowBankCodeformboolNo
WorldpayApiUrlformstringNo
WorldpayBusinessKeyformstringNo
GooglePayMerchantIdformstringNo
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 .csv suffix or ?format=csv

HTTP + CSV

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

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

{"PaymentGatewayId":0,"Name":"String","Currency":"String","TypeName":"String","GatewayType":"Stripe","Created":"0001-01-01T00:00:00.0000000","AccountingStartDate":"0001-01-01T00:00:00.0000000","IsDefault":false,"IsPublic":false,"Disabled":false,"DisabledReason":"String","Configuration":{"ShowConfirmation":false,"ShowBillingDetails":false,"GatewayKey":"String","HideCvv":false,"MinimumAdultDateOfBirth":"0001-01-01T00:00:00.0000000","ShowIban":false,"ShowBankCode":false,"WorldpayApiUrl":"String","WorldpayBusinessKey":"String","GooglePayMerchantId":"String"},"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,"CanExportCustomerData":false,"CanPing":false,"CanSupplyPayments":false,"CanSupplyPayouts":false,"CanSupplySubscriptions":false,"CanImportPaymentMethod":false,"PublicTranslation":"Direct Debit","BankAccount":"String"}