Fundings
The fundings object captures the status of funding entries associated with an organization. GET requests to this endpoint can be filtered by the funding ID, effective date, net amount, routing number, location ID, last four digits of the account number, status and funding source. Merchants can also use this endpoint to find the transactions and settlement records related to this funding entry.
Fundings Object
Parameter | Description | Type | Req |
organization_id | The identification number of the associated organization. For example, org_5551236. | string | R |
location_id | The identification number of the associated location. For example, loc_1234568. | string | R |
funding_id | A unique string used to represent a funding entry. For example, fnd_ACH-0226-173C5. [max length = 20] | string | R |
status |
completed - Forte processed the funding entry and added funds to the user's account.
| string | O |
effective_date | The date and time when the net_amount is credited to the merchant's bank account. [max length = 19] | datetime | O |
origination_date | The date the funds of the transaction go to the originating depository financial institution. [max length = 19] | datetime | O |
net_amount | The amount that is being funded. [max length = 10] | decimal | O |
echeck | The eCheck Object | object | R |
echeck.routing_number | The transit routing number of the funding account. [max length = 9] | string | O |
echeck.last_4_account_number | The last four digits of the redacted funding account number. [max length = 4] | string | O |
funding_source | The Funding Source Object | object | R |
funding_source.code | The type of funding used in this funding entry. The following values are supported: GWCC
| string | O |
funding_source.description |
GWCC - Gateway Funding
| string | O |
entry_description | Details pertaining to the funding entry that can be overwritten by the merchant after the funds are in the merchant's bank account. [max length = 50] | string | O |
funding_response_code | Contains the reason code for why a funding attempt failed. [max length = 50] | string | -- |
reserve | The part of the funding amount kept on funding hold based on CSG Forte's Risk department's Policy and Procedures. These funds are used to cover returns, past due invoices, fraud transactions, levies from state or federal governments, and other financial obligations of a merchant. Funds may also be held in reserve until 1099 TIN mismatches are resolved. | decimal | O |
reserve_release | The amount of the reserve released by the CSG Forte Risk department after reviewing the merchant per Risk Department's policy and procedures. | decimal | O |
discount_fee | The amount (fee) paid by a merchant to the merchant acquirer/bank or other contracted party for services related to the processing of the merchant's card transactions. | decimal | O |
GET All Fundings for an Organization
{{baseURI}}/organizations/org_{{organizationID}}/fundings/
This URI returns all the funding entries for an organization. To narrow your search data using specific criteria, use the following parameters to filter your results.
start_effective_date / end_effective_date
start_net_amount / end_net_amount
routing_number
bank_information
location_id
last_4_account_number
code
status
NOTES:
All date filter parameters are time aware.
If both theÂ
start_effective_date andÂend_effective_date filters are not passed in, the query automatically uses a default date range of 90 days. If you do not pass in any date filters, the system automatically uses the current date and the previous 90 days.Multiple filters can be passed to refine the results as required.
Note:Â Please note that sending a request at the partner (org) level may result in a large data set and may cause timeout errors depending on the request. We recommend sending your GET request at the Merchant (Organization) level.
Example Request
curl --location -g 'https://api.forte.net/v3/organizations/org_{{organizationID}}/fundings/' \
--header 'Authorization: {{Authorization}}' \
--header 'Accept: application/json' \
--header 'X-Forte-Auth-Organization-Id: org_{{AuthOrganizationID}}'
Example Response
GET All Fundings within a Specific Date Range
{{baseURI}}/organizations/org_{{organizationID}}/fundings/?filter=start_effective_date+eq+%272023-03-01T00:00:00%27+and+end_effective_date+eq+%272023-03-15T00:00:00 %27+and+last_4_account_number+eq+2312
This URI returns all the funding entries for an Organization within a specified date range.
Note:Â Please note that sending a request at the partner (org) level may result in a large data set and may cause timeout errors depending on the request. We recommend sending your GET request at the Merchant (Organization) level.
Example Request
curl --location -g '{{baseURI}}/organizations/org_{{organizationID}}/fundings/?filter=start_effective_date%2Beq%2B%25272023-03-01T00%3A00%3A00%2527%2Band%2Bend_effective_date%2Beq%2B%25272023-03-15T00%3A00%3A00%2527%2Band%2Blast_4_account_number%2Beq%2B2312' \
--header 'Authorization: {{Authorization}}' \
--header 'Accept: application/json' \
--header 'X-Forte-Auth-Organization-Id: org_{{AuthOrganizationID}}'
Example Response
GET A Specific Funding Entry
{{baseURI}}/organizations/org_{{organizationID}}/fundings/fnd_{{fundingID}}
This URI returns a specific funding entry based on the funding_id included in the route.
Example Request
curl --location -g 'https://api.forte.net/v3/organizations/org_{{organizationID}}/fundings/fnd_{{fundingID}}' \
--header 'Authorization: {{Authorization}}' \
--header 'Accept: application/json' \
--header 'X-Forte-Auth-Organization-Id: org_{{AuthOrganizationID}}'
Example Response
GET Transaction(s) Related to a Funding Entry
{{baseURI}}/organizations/org_{{organizationID}}/fundings/fnd_{{fundingID}}/transactions
This URI returns all the related transactions associated with a specific funding entry.
Example Request
curl --location -g 'https://api.forte.net/v3/organizations/org_{{organizationID}}/fundings/fnd_{{fundingID}}/transactions' \
--header 'Authorization: {{Authorization}}' \
--header 'Accept: application/json' \
--header 'X-Forte-Auth-Organization-Id: org_{{AuthOrganizationID}}' \
--data ''
Example Response
GET Settlement(s) Related to a Funding Entry
{{baseURI}}/organizations/org_{{organizationID}}/fundings/fnd_{{fundingID}}/settlements
This URI returns all the related settlement records associated with a specific funding entry.
Example Request
curl --location -g 'https://api.forte.net/v3/organizations/org_{{organizationID}}/fundings/fnd_{{fundingID}}/settlements' \
--header 'Authorization: {{Authorization}}' \
--header 'Accept: application/json' \
--header 'X-Forte-Auth-Organization-Id: org_{{AuthOrganizationID}}' \
--data ''
Example Response