The Gateway Management API allows you to create, update, list and delete payment gateways in FlexPay. If you have multiple gateways configured on your CRM and want to auto-update FlexPay gateways configuration when you make changes, implementing this API will be beneficial.
Gateway Object Structure
| Key Name | Description |
|---|---|
| id | Unique identifier (token) of the gateway. |
| name | Name of the gateway, this value can only be set at creation time and is not updatable. |
| merchantAccountReferenceId | The merchant account identifier for this gateway. |
| gatewayType | String containing the unique code of the gateway type. See the Supported Gateway Types for more information. |
| currencyCode | The ISO 4217 currency code of the merchant account. |
| status | The status is one of the following values: Available, Disabled or RefundOnly. |
| acceptedCurrencyCodes | The list of accepted ISO 4217 currency codes by the merchant account. |
| acceptedCards | Structure specifying the enabled features for each major credit card companies. See AcceptedCardDictionary object structure below. |
| weight | When using the gateway routing features, the FlexPay system can use a weighted distribution strategy to select the gateway that will handle the transaction request. |
| acceptRetries | Boolean value that specifies if the gateway accept transaction retries. |
| cvvRequired | Boolean value that specifies if the credit card verification value (cvv) is required to process transaction on the gateway. |
| approvedChargeOrCaptureRateFee | The transaction rate fee that is applied on charge and capture transactions by the gateway. |
| approvedChargeOrCaptureFlatFee | The transaction flat fee that is applied on charge and capture transactions by the gateway. |
| otherTransactionFlatFee | The transaction flat fee that is applied by the gateway on other transaction types. |
| settings | Structure of the settings is different for each gateway type. More information can be found in the SupportedGatewayTypes |
Write only Fields
Connection settings for the gateways can contain sensitive information, for this reason these fields are write-only. This means these fields can be sent to the API but never returned by it.
AcceptedCardsDictionary
{
"visa": AcceptedCardFeatures | optional | default: true for all features,
"masterCard": AcceptedCardFeatures | optional | default: true for all features,
"amex": AcceptedCardFeatures | optional | default: true for all features,
"discover": AcceptedCardFeatures | optional | default: true for all features,
"dinersClub": AcceptedCardFeatures | optional | default: true for all features,
"jcb": AcceptedCardFeatures | optional | default: true for all features,
"maestro": AcceptedCardFeatures | optional | default: true for all features
}
Fields extended information
| Key Name | Description |
|---|---|
| visa | Structure that specifies the enabled features for the Visa credit card company. |
| mastercard | Structure that specifies the enabled features for the MasterCard credit card company. |
| amex | Structure that specifies the enabled features for the American Express credit card company. |
| discover | Structure that specifies the enabled features for the Discord credit card company. |
| dinersClub | Structure that specifies the enabled features for the Diners Club credit card company. |
| jcb | Structure that specifies the enabled features for the JCB credit card company. |
| maestro | Structure that specifies the enabled features for the Maestro credit card company. |
AcceptedCardsFeatures
{
"acceptCreditCard": bool | optional | default: false,
"acceptPrepaidCard": bool | optional | default: false,
"acceptDebitCard": bool | optional | default: false
}
Fields extended information
| Key Name | Description |
|---|---|
| acceptCreditCard | Boolean value that specifies if the gateway should accept credit cards for the credit card company. |
| acceptPrepaidCard | Boolean value that specifies if the gateway should accept prepaid credit cards for the credit card company. |
| acceptDebitCard | Boolean value that specifies if the gateway should accept debit cards for the credit card company. |
GatewayStatus enumeration
The gateway status is one of the following values:
| Value | Description |
|---|---|
| Available | The gateway is available for processing. |
| Disabled | The gateway is disabled and will not accept any transactions. |
| RefundOnly | The gateway is disabled but will accept refunds. |