Fees
Fees are a way for you to bill your customer for their activity, and can be used for everything from monthly subscriptions to financial activity fees (payments, card issuance etc.)
Some fees exist natively within the Unit platform. The list of native fees is documented in the table below. All fees default to $0, and can be updated by reaching out to your Unit contact. The list of native fees is updated from time to time as new financial products are added to the platform.
The fees will be paid to your Revenue Account and will show up on the customer monthly statements.
Fee Type |
---|
Card issuance fee |
Incoming ACH payment |
Outgoing ACH payment |
Incoming Wire |
Outgoing Wire |
To charge the customer for activities and services that are not covered by the native fees, you may use the fees API.
caution
Any fees charged must be disclosed in any required customer agreements or terms as determined by Unit compliance. Please consult with the Unit Compliance team prior to charging any customer fees.
Create Fee#
Creates a fee for an Account
.
Verb | POST |
Url | https://api.s.unit.sh/fees |
Required Scope | accounts-write |
Data Type | fee |
Timeout (Seconds) | 5 |
#
AttributesName | Type | Description |
---|---|---|
amount | integer | The amount (in cents) to charge the account. |
description | string | Description of the fee (maximum of 50 characters). |
tags | object | Optional. See Tags. |
idempotencyKey | string | Optional, but strongly recommended. See Idempotency. |
#
RelationshipsName | Type | Description |
---|---|---|
account | JSON:API Relationship | The account to charge the fee. |
curl -X POST 'https://api.s.unit.sh/fees'-H 'Content-Type: application/vnd.api+json'-H 'Authorization: Bearer ${TOKEN}'--data-raw '{ "data": { "type": "fee", "attributes": { "amount": 1000, "description": "Monthly Subscription" }, "relationships": { "account": { "data": { "type": "depositAccount", "id": "10097" } } } }}'
#
ResponseResponse is a JSON:API document.
{ "data": { "type": "fee", "id": "1234", "attributes": { "amount": 1000, "description": "Monthly Subscription" }, "relationships": { "account": { "data": { "type": "depositAccount", "id": "10097" } } } }}
Reverse Fee#
Reverse a fee for an Account
.
Verb | POST |
Url | https://api.s.unit.sh/fees/reverse |
Required Scope | accounts-write |
Data Type | feeReversal |
Timeout (Seconds) | 5 |
#
AttributesName | Type | Description |
---|---|---|
description | string | Description of the fee (maximum of 50 characters). |
tags | object | Optional. See Tags. |
idempotencyKey | string | Optional, but strongly recommended. See Idempotency. |
#
RelationshipsName | Type | Description |
---|---|---|
account | JSON:API Relationship | The account to reverse the fee. |
transaction | JSON:API Relationship | The transaction to reverse. |
curl -X POST 'https://api.s.unit.sh/fees/reverse'-H 'Content-Type: application/vnd.api+json'-H 'Authorization: Bearer ${TOKEN}'--data-raw '{ "data": { "type": "feeReversal", "attributes": { "description": "Monthly Subscription - reverse" }, "relationships": { "account": { "data": { "type": "depositAccount", "id": "10097" } }, "transaction": { "data": { "type": "transaction", "id": "1" } } } }}'
#
ResponseResponse is a JSON:API document.
#
201 CreatedField | Type | Description |
---|---|---|
data | FeeReversal | The requested resource after the operation was completed. |
{ "data": { "type": "fee reversal", "id": "2", "attributes": { "amount": 100, "description": "Monthly Subscription - reverse" }, "relationships": { "account": { "data": { "type": "account", "id": "10097" } }, "transaction": { "data": { "type": "transaction", "id": "1" } } } }}