ClubManager.Api

<back to all web services

PaymentGatewayService.GetPaymentGatewayByIdRequest

Requires Authentication
The following routes are available for this service:
POST,GET/api/PaymentGateway/GetPaymentGatewayById
Imports System
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports ClubManager.Interfaces.Models.PaymentGateway

Namespace Global

    Namespace ClubManager.Interfaces.Models.PaymentGateway

        Public Partial Class Configuration
            Public Overridable Property ShowConfirmation As Boolean
            Public Overridable Property ShowBillingDetails As Boolean
            Public Overridable Property GatewayKey As String
            Public Overridable Property HideCvv As Boolean
            Public Overridable Property MinimumAdultDateOfBirth As Date
        End Class

        Public Partial Class Creditor
            Public Sub New()
                Schemes = New Scheme(){}
                Countries = New String(){}
            End Sub

            Public Overridable Property Id As String
            Public Overridable Property Schemes As Scheme()
            Public Overridable Property Name As String
            Public Overridable Property AddressLine1 As String
            Public Overridable Property AddressLine2 As String
            Public Overridable Property AddressLine3 As String
            Public Overridable Property City As String
            Public Overridable Property CountryCode As String
            Public Overridable Property PostalCode As String
            Public Overridable Property Region As String
            Public Overridable Property TermsAndConditionsUrl As String
            Public Overridable Property Countries As String()
        End Class

        Public 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
        End Enum

        Public Partial Class PaymentGateway
            Public Overridable Property PaymentGatewayId As Integer
            Public Overridable Property Name As String
            Public Overridable Property Currency As String
            Public Overridable Property TypeName As String
            Public Overridable Property GatewayType As GatewayType
            Public Overridable Property Created As Date
            Public Overridable Property AccountingStartDate As Date
            Public Overridable Property IsDefault As Boolean
            Public Overridable Property IsPublic As Boolean
            Public Overridable Property Disabled As Boolean
            Public Overridable Property DisabledReason As String
            Public Overridable Property Configuration As Configuration
            Public Overridable Property Creditor As Creditor
            Public Overridable Property IsCreditCard As Boolean
            Public Overridable Property IsClubManagerCreditCard As Boolean
            Public Overridable Property IsDirectDebit As Boolean
            Public Overridable Property HasSignUpLink As Boolean
            Public Overridable Property CanProvidePaymentToken As Boolean
            Public Overridable Property CanProvidePaymentRedirect As Boolean
            Public Overridable Property CanImport As Boolean
            Public Overridable Property CanSupplyRawData As Boolean
            Public Overridable Property CanImportPaymentMethod As Boolean
            Public Overridable Property PublicTranslation As String
            Public Overridable Property BankAccount As String
        End Class

        Public Partial Class Scheme
            Public Overridable Property Id As String
            Public Overridable Property Reference As String
            Public Overridable Property Email As String
            Public Overridable Property PhoneNumber As String
        End Class
    End Namespace
End Namespace

VB.NET PaymentGatewayService.GetPaymentGatewayByIdRequest DTOs

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>