| POST,GET | /api/PaymentGateway/GetPaymentGatewayById |
|---|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| 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 | |
| CanImportPaymentMethod | form | bool | No | |
| PublicTranslation | form | string | No | |
| BankAccount | form | string | No |
| 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 | |
| IntegraPayCreditCard | 20 | |
| IntegraPayBankAccount | 21 | |
| Payfast | 22 |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| ShowConfirmation | form | bool | No | |
| ShowBillingDetails | form | bool | No | |
| GatewayKey | form | string | No | |
| HideCvv | form | bool | No | |
| MinimumAdultDateOfBirth | form | DateTime | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| 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 |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Id | form | string | No | |
| Reference | form | string | No | |
| form | string | No | ||
| PhoneNumber | form | string | No |
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=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
}