ClubManager.Api

<back to all web services

PaymentGatewayService.GetPaymentGatewayByIdRequest

Requires Authentication
The following routes are available for this service:
POST,GET/api/PaymentGateway/GetPaymentGatewayById
namespace ClubManager.Interfaces.Models.PaymentGateway

open System
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations

    type 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

    [<AllowNullLiteral>]
    type Configuration() = 
        member val ShowConfirmation:Boolean = new Boolean() with get,set
        member val ShowBillingDetails:Boolean = new Boolean() with get,set
        member val GatewayKey:String = null with get,set
        member val HideCvv:Boolean = new Boolean() with get,set
        member val MinimumAdultDateOfBirth:DateTime = new DateTime() with get,set

    [<AllowNullLiteral>]
    type Creditor() = 
        member val Id:String = null with get,set
        member val Schemes:Scheme[] = [||] with get,set
        member val Name:String = null with get,set
        member val AddressLine1:String = null with get,set
        member val AddressLine2:String = null with get,set
        member val AddressLine3:String = null with get,set
        member val City:String = null with get,set
        member val CountryCode:String = null with get,set
        member val PostalCode:String = null with get,set
        member val Region:String = null with get,set
        member val TermsAndConditionsUrl:String = null with get,set
        member val Countries:String[] = [||] with get,set

    [<AllowNullLiteral>]
    type PaymentGateway() = 
        member val PaymentGatewayId:Int32 = new Int32() with get,set
        member val Name:String = null with get,set
        member val Currency:String = null with get,set
        member val TypeName:String = null with get,set
        member val GatewayType:GatewayType = new GatewayType() with get,set
        member val Created:DateTime = new DateTime() with get,set
        member val AccountingStartDate:DateTime = new DateTime() with get,set
        member val IsDefault:Boolean = new Boolean() with get,set
        member val IsPublic:Boolean = new Boolean() with get,set
        member val Disabled:Boolean = new Boolean() with get,set
        member val DisabledReason:String = null with get,set
        member val Configuration:Configuration = null with get,set
        member val Creditor:Creditor = null with get,set
        member val IsCreditCard:Boolean = new Boolean() with get,set
        member val IsClubManagerCreditCard:Boolean = new Boolean() with get,set
        member val IsDirectDebit:Boolean = new Boolean() with get,set
        member val HasSignUpLink:Boolean = new Boolean() with get,set
        member val CanProvidePaymentToken:Boolean = new Boolean() with get,set
        member val CanProvidePaymentRedirect:Boolean = new Boolean() with get,set
        member val CanImport:Boolean = new Boolean() with get,set
        member val CanSupplyRawData:Boolean = new Boolean() with get,set
        member val CanImportPaymentMethod:Boolean = new Boolean() with get,set
        member val PublicTranslation:String = null with get,set
        member val BankAccount:String = null with get,set

    [<AllowNullLiteral>]
    type Scheme() = 
        member val Id:String = null with get,set
        member val Reference:String = null with get,set
        member val Email:String = null with get,set
        member val PhoneNumber:String = null with get,set

F# 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>