SimpliFi
HomeContact Us
HomeContact Us
  1. Fee
  • Introduction
  • SimpliFi Architecture
  • Webhooks
  • Auth
    • Login to generate JWT token
      POST
  • Card Program
    • Create Card Program
      POST
    • Get Card Program
      GET
    • Change Card Program Status
      PATCH
    • Link Funding Source to Card Program
      POST
    • Get Balance of Funding Source
      GET
    • Transfer funds from one Card Program to other
      POST
    • Raise Funding Document Upload
      POST
    • Raise Funding
      POST
    • Funding Source Statement
      GET
  • Funding Source
    • Create Rule Group on Funding Account
      POST
    • Update Rule Group on Funding Account
      PUT
    • Delete Rule Group on Funding Account
      DELETE
    • Get Rule Groups on Funding Account
      GET
    • Appply Rule Group on Funding Account
      POST
    • Remove Rule Group on Funding Account
      DELETE
  • Card
    • List all Cards
      GET
    • Create a Card
      POST
    • Get Card Details
      GET
    • Retrieve Balance on the Card
      GET
    • Activate a Card
      POST
    • Manage Card Status
      POST
    • Load a Card
      POST
    • Unload a Card
      POST
    • Renewal of the Card
      POST
    • Request a Physical Card
      POST
    • Get Card Statement
      GET
    • Apply rule group on card
      POST
    • Remove rule group on card
      DELETE
  • User
    • List all Users
    • Create a User
    • Upload Document
    • Retrieve a User
    • Update a User
    • Delete a User
  • Transaction
    • List All Transactions
  • Fee
    • Add fee configuration
      POST
    • Fetch fee config
      GET
    • Change the status of fee config
      PATCH
    • Add Fee event against card uuid in queue
      POST
    • Apply fee against card uuid present in queue
      POST
  • Webhook
    • Get all events
    • Create a webhook
    • Update a Webhook
    • Delete a Webhook
    • Updates the status of Webhook
  1. Fee

Add fee configuration

POST
https://{{env}}-lb.simplifipay.com/v1/fees
Fee
Configure fee based on transaction types and apply them to a card program template.
Following are the properties of this endpoint.
Request Request Example
Shell
JavaScript
Java
Swift
curl --location -g --request POST 'https://uat-lb.simplifipay.com/v1/fees' \
--header 'requestUuid;' \
--header 'Content-Type: application/json' \
--data-raw '{
    "entityType": "CARD_PROGRAM_TEMPLATE",
    "entityUuid": "6afa4246-9ecd-4dd0-9c7e-240b04ae8929",
    "fees": [
        {
            "feeOperationType": "PRIMARY_VIRTUAL_CARD_ISSUANCE,",
            "feeStatusType": "ACTIVE",
            "feeAmount": "5.10",
            "currency": "USD",
            "description": "ATM Withdrawal Fee",
            "feesDetectType": "FIXED",
            "feesUuid": "e00507d5-f5a0-4951-9037-2b15ab852c88"
        }
    ]
}'
Response Response Example
{
    "entityType": "CARD_PROGRAM_TEMPLATE",
    "entityUuid": "6afa4246-9ecd-4dd0-9c7e-240b04ae8929",
    "fees": [
        {
            "feeOperationType": "PRIMARY_VIRTUAL_CARD_ISSUANCE,",
            "feeStatusType": "ACTIVE",
            "feeAmount": "5.10",
            "currency": "USD",
            "description": "ATM Withdrawal Fee",
            "feesDetectType": "FIXED",
            "feesUuid": "e00507d5-f5a0-4951-9037-2b15ab852c88"
        }
    ]
}

Request

Authorization
JWT
Add the parameter
Authorization
to Headers
Example:
Authorization: ********************
or
Header Params
requestUuid
string 
required
A unique id is required to be passed as part of the header whenever a SimpliFi API is called from your
system. This would help us in debugging in case of a discrepancy in the expected behavior of the API.
Example:
00d366f2-a6e9-4714-b172-02c4e58c29d8
Body Params application/json
Fee setup will have the information on amount to charge client with respect to operation type
entityType
enum<string> 
required
This field contains the entity type for which we want to setup fees
Allowed values:
CARD_PROGRAM_TEMPLATECARD_PROGRAM
Example:
CARD_PROGRAM_TEMPLATE
entityUuid
string 
required
This is the entity uuid for which we want to charge fees for specific operations
Example:
6afa4246-9ecd-4dd0-9c7e-240b04ae8929
fees
array[object (FeeConfigurationModel) {7}] 
required
This array of objects contains fees setup configuration with respect to fee operation type
feeOperationType
enum<string> 
required
This field contains the operation type for which we want to setup fees
Allowed values:
PRIMARY_VIRTUAL_CARD_ISSUANCE,PRIMARY_VIRTUAL_CARD_RENEWAL,SECONDARY_CARD_ISSUANCE,SECONDARY_CARD_RENEWAL,PHYSICAL_CARD_ISSUANCE,PHYSICAL_CARD_RENEWAL,ATM_WITHDRAWAL,SUBSCRIPTION_FEE,DELIVERY_CHARGE
Example:
ATM_WITHDRAWAL
feeStatusType
enum<string> 
optional
This field contains the status of the fee configuration
Allowed values:
ACTIVEINACTIVE
Example:
ACTIVE
feeAmount
number 
required
This field indicates the amount to charge
Example:
5.10
currency
string 
required
This field tells the currency of on which fees will be detected
Example:
USD
description
string 
optional
This field contains the description of the fee
Example:
ATM Withdrawal Fee
feesDetectType
enum<string> 
required
This field contains fees Detect Type
Allowed values:
FIXEDMULTIPLIER
Example:
FIXED
feesUuid
string 
optional
This is a system-generated unique identifier of the fee configuration.
Example:
e00507d5-f5a0-4951-9037-2b15ab852c88
Examples

Responses

🟢200OK
application/json
OK
Body
Fee setup will have the information on amount to charge client with respect to operation type
entityType
enum<string> 
required
This field contains the entity type for which we want to setup fees
Allowed values:
CARD_PROGRAM_TEMPLATECARD_PROGRAM
Example:
CARD_PROGRAM_TEMPLATE
entityUuid
string 
required
This is the entity uuid for which we want to charge fees for specific operations
Example:
6afa4246-9ecd-4dd0-9c7e-240b04ae8929
fees
array[object (FeeConfigurationModel) {7}] 
required
This array of objects contains fees setup configuration with respect to fee operation type
feeOperationType
enum<string> 
required
This field contains the operation type for which we want to setup fees
Allowed values:
PRIMARY_VIRTUAL_CARD_ISSUANCE,PRIMARY_VIRTUAL_CARD_RENEWAL,SECONDARY_CARD_ISSUANCE,SECONDARY_CARD_RENEWAL,PHYSICAL_CARD_ISSUANCE,PHYSICAL_CARD_RENEWAL,ATM_WITHDRAWAL,SUBSCRIPTION_FEE,DELIVERY_CHARGE
Example:
ATM_WITHDRAWAL
feeStatusType
enum<string> 
optional
This field contains the status of the fee configuration
Allowed values:
ACTIVEINACTIVE
Example:
ACTIVE
feeAmount
number 
required
This field indicates the amount to charge
Example:
5.10
currency
string 
required
This field tells the currency of on which fees will be detected
Example:
USD
description
string 
optional
This field contains the description of the fee
Example:
ATM Withdrawal Fee
feesDetectType
enum<string> 
required
This field contains fees Detect Type
Allowed values:
FIXEDMULTIPLIER
Example:
FIXED
feesUuid
string 
optional
This is a system-generated unique identifier of the fee configuration.
Example:
e00507d5-f5a0-4951-9037-2b15ab852c88
🟠401Unauthorized
Modified at 2025-06-27 12:44:57
Previous
Fee
Next
Fetch fee config
Built with