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 .json suffix or ?format=json

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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/json
Content-Type: application/json
Content-Length: length

{"PaymentGatewayId":0}
HTTP/1.1 200 OK
Content-Type: application/json
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"},"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,"CanImportPaymentMethod":false,"PublicTranslation":"Direct Debit","BankAccount":"String"}