ClubManager.Api

<back to all web services

PaymentGatewayService.GetPaymentGatewayByIdRequest

Requires Authentication
The following routes are available for this service:
POST,GET/api/PaymentGateway/GetPaymentGatewayById
import java.math.*
import java.util.*
import net.servicestack.client.*


open class PaymentGateway
{
    var PaymentGatewayId:Int? = null
    var Name:String? = null
    var Currency:String? = null
    var TypeName:String? = null
    var GatewayType:GatewayType? = null
    var Created:Date? = null
    var AccountingStartDate:Date? = null
    var IsDefault:Boolean? = null
    var IsPublic:Boolean? = null
    var Disabled:Boolean? = null
    var DisabledReason:String? = null
    var Configuration:Configuration? = null
    var Creditor:Creditor? = null
    var IsCreditCard:Boolean? = null
    var IsClubManagerCreditCard:Boolean? = null
    var IsDirectDebit:Boolean? = null
    var HasSignUpLink:Boolean? = null
    var CanProvidePaymentToken:Boolean? = null
    var CanProvidePaymentRedirect:Boolean? = null
    var CanImport:Boolean? = null
    var CanSupplyRawData:Boolean? = null
    var CanImportPaymentMethod:Boolean? = null
    var PublicTranslation:String? = null
    var BankAccount:String? = null
}

enum class GatewayType(val value:Int)
{
    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),
}

open class Configuration
{
    var ShowConfirmation:Boolean? = null
    var ShowBillingDetails:Boolean? = null
    var GatewayKey:String? = null
    var HideCvv:Boolean? = null
    var MinimumAdultDateOfBirth:Date? = null
}

open class Creditor
{
    var Id:String? = null
    var Schemes:ArrayList<Scheme>? = null
    var Name:String? = null
    var AddressLine1:String? = null
    var AddressLine2:String? = null
    var AddressLine3:String? = null
    var City:String? = null
    var CountryCode:String? = null
    var PostalCode:String? = null
    var Region:String? = null
    var TermsAndConditionsUrl:String? = null
    var Countries:ArrayList<String>? = null
}

open class Scheme
{
    var Id:String? = null
    var Reference:String? = null
    var Email:String? = null
    var PhoneNumber:String? = null
}

Kotlin PaymentGatewayService.GetPaymentGatewayByIdRequest DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv

HTTP + JSV

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: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	PaymentGatewayId: 0
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	PaymentGatewayId: 0,
	Name: String,
	Currency: String,
	TypeName: String,
	GatewayType: Stripe,
	Created: 0001-01-01,
	AccountingStartDate: 0001-01-01,
	IsDefault: False,
	IsPublic: False,
	Disabled: False,
	DisabledReason: String,
	Configuration: 
	{
		ShowConfirmation: False,
		ShowBillingDetails: False,
		GatewayKey: String,
		HideCvv: False,
		MinimumAdultDateOfBirth: 0001-01-01
	},
	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
}