ClubManager.Api

PaymentGatewayService.GetPaymentGatewayByIdRequest

The following routes are available for this service:
POST,GET	/api/PaymentGateway/GetPaymentGatewayById

**PaymentGateway** Parameters:
Name	Parameter	Data Type	Required
PaymentGatewayId	form	int	No
Name	form	string	No
Currency	form	string	No
TypeName	form	string	No
GatewayType	form	GatewayType	No
Created	form	DateTime	No
AccountingStartDate	form	DateTime	No
IsDefault	form	bool	No
IsPublic	form	bool	No
Disabled	form	bool	No
DisabledReason	form	string	No
Configuration	form	Configuration	No
Creditor	form	Creditor	No
IsCreditCard	form	bool	No
IsClubManagerCreditCard	form	bool	No
IsDirectDebit	form	bool	No
HasSignUpLink	form	bool	No
CanProvidePaymentToken	form	bool	No
CanProvidePaymentRedirect	form	bool	No
CanImport	form	bool	No
CanSupplyRawData	form	bool	No
CanExportCustomerData	form	bool	No
CanImportPaymentMethod	form	bool	No
PublicTranslation	form	string	No
BankAccount	form	string	No

**GatewayType** Enum:
Name	Value
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
WorldpayCreditCard	20
WorldpayBankAccount	21
Payfast	22
WorldPayFPUKCreditCard	23
WorldPayFPUKDD	24
RazorPayEmail	25
WorldPayFPNZCreditCard	26
WorldPayFPNZDD	27

**Configuration** Parameters:
Name	Parameter	Data Type	Required
ShowConfirmation	form	bool	No
ShowBillingDetails	form	bool	No
GatewayKey	form	string	No
HideCvv	form	bool	No
MinimumAdultDateOfBirth	form	DateTime	No
ShowIban	form	bool	No
ShowBankCode	form	bool	No
WorldpayApiUrl	form	string	No
WorldpayBusinessKey	form	string	No
GooglePayMerchantId	form	string	No

**Creditor** Parameters:
Name	Parameter	Data Type	Required
Id	form	string	No
Schemes	form	Scheme[]	No
Name	form	string	No
AddressLine1	form	string	No
AddressLine2	form	string	No
AddressLine3	form	string	No
City	form	string	No
CountryCode	form	string	No
PostalCode	form	string	No
Region	form	string	No
TermsAndConditionsUrl	form	string	No
Countries	form	string[]	No

**Scheme** Parameters:
Name	Parameter	Data Type	Required
Id	form	string	No
Reference	form	string	No
Email	form	string	No
PhoneNumber	form	string	No

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>