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