Apply Fee

Apply a fee to the source with the proceeds going into the revenue account

Request

Security:

Bearer

path Parameters

version

required

string

Request Body schema: application/json

request_code required	string non-empty The Fee request code.
amount required	number <double> Fee amount to be charged for the source account
currency required	string 3 characters Three letter currency code of the fee
description	string or null [ 0 .. 48 ] characters Optional - API Partner can send the transfer's description for reference
client_reference_id required	string non-empty API Partner can send the transfer's unique id on their system and it can be used to fetch transfer details later
required	object (FeeSourceDetail)
revenue_account_guid	string or null <uuid> Optional - API Partner provided revenue account, must belong to same program
allow_partial	boolean or null Optional - charge only the part of the fee that wll take the balance to zero otherwise it will fail.
txn_guid	string <uuid> If applying a fee to a financial transaction this input is required.
memo_code	string or null <= 64 characters Client driven code used to add more details to the transfer type.

Responses

201

Returns newly created fee details

400

Bad request

401

Unauthorized

404

Card not found

500

Server Error

post/api/{version}/fees/apply

Request samples

Payload
curl
JavaScript
Node.js

application/json

{"request_code": "string",
"amount": 0,
"currency": "str",
"description": "string",
"client_reference_id": "string",
"source": {"account_guid": "d2b7c9d2-85e7-4c51-92d0-3f97a47f8d76",
"wallet_guid": "17eaeda9-c0ab-4ac3-8ef9-27ac9b388a03",
"wallet_id": "string",
"card_proxy": "string"
},
"revenue_account_guid": "be5859f8-2def-455a-a2d1-a8fb86ef9998",
"allow_partial": true,
"txn_guid": "0017d7fb-f072-440d-86fd-a7ae6238e591",
"memo_code": "string"
}

Response samples

application/json

{"txn_guid": "0017d7fb-f072-440d-86fd-a7ae6238e591",
"request_code": "string",
"amount": 0,
"currency": "string",
"description": "string",
"source": {"account_guid": "d2b7c9d2-85e7-4c51-92d0-3f97a47f8d76",
"wallet_guid": "17eaeda9-c0ab-4ac3-8ef9-27ac9b388a03",
"wallet_id": "string",
"card_proxy": "string"
},
"revenue_account_guid": "be5859f8-2def-455a-a2d1-a8fb86ef9998",
"ledger_balance": 0,
"available_balance": 0,
"partial": true,
"client_reference_id": "string"
}