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


The status of the funding entry. The following values are supported for this parameter:


completed - Forte processed the funding entry and added funds to the user's account.
pending - Forte is processing the funding entry and it will post soon.
failed - Forte attempted to process the funding entry, but it was rejected.
not_applicable - The Net Amount is equal to zero and no funds will go into the user's account.




[max length = 14}

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
ACH
ACHD
ACHC
UNFD
UNFC
CC
CCC
CCD
CHBD
CHBC
SFA
SFC
RSRV
RELS




[max length = 4]

string

O

funding_source.description


A short description of the type of funding used in this funding entry. The following values are supported:


GWCC - Gateway Funding
ACH - Net ACH Funding
ACHD - ACH Debits
ACHC - ACH Credits
UNFD - ACH Debit Returns
UNFC - ACH Credit Returns
CC - Payfac Credit Card
CCC - Payfac CC Credits
CCD - Payfac CC Debits
CHBD - Payfac Chargeback Debits
CHBC - Payfac Charegback Credits
SFA - Splitfund ACH
SFC - Splitfund CC
RSRV - Reserve Debit
RELS - Reserve Release




[max length = 25]

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.

AUTHORIZATION Basic Auth
 
Username     {{apiaccessid}}
Password      {{apisecurekey}}
 

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

Edit Content
Edit Content
Headers (13)

cache-control

no-cache

connection

keep-alive

content-type

application/json; charset=utf-8

date

Tue, 24 Oct 2017 18:56:12 GMT

expires

-1

pragma

no-cache

server

Microsoft-IIS/8.5

transfer-encoding

chunked

www-authenticate

Basic realm="sandbox.forte.net"

x-aspnet-version

4.0.30319

x-cdn

Incapsula

x-iinfo

1-3593717-3660544 NNNN CT(48 39 0) RT(1508870937210 435264) q(0 0 1 -1) r(2 2) U6

x-powered-by

ASP.NET

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.

AUTHORIZATION Basic Auth
 
Username     {{apiaccessid}}
Password      {{apisecurekey}}
 
PARAMS
 
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

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

Edit Content
				
					{
  "number_results": 2,
  "search_criteria": {
    "page_size": 50,
    "page_index": 0,
    "home_organization_id": "org_300005",
    "resource_specific": {
      "end_effective_date": "2023-03-15T00:00:00",
      "start_effective_date": "2023-03-01T00:00:00"
    }
  },
  "results": [
    {
      "funding_id": "fnd_ACH-0309-2F776",
      "organization_id": "org_300005",
      "location_id": "loc_216006",
      "status": "completed",
      "effective_date": "2023-03-10T00:00:00",
      "origination_date": "2023-03-09T00:00:00",
      "net_amount": 19.85,
      "routing_number": "211170101",
      "last_4_account_number": "2312",
      "bank_information": "WEBSTER BANK, N.A.",
      "funding_source": {
        "code": "ACH",
        "description": "Net ACH Funding"
      },
      "entry_description": "FUNDING",
      "funding_response_code": "S01",
      "reserve_release": 0,
      "reserve": 0.83,
      "discount_fee": 0,
      "links": {
        "transactions": "https://api.forte.net/v3/fundings/fnd_ACH-0309-2F776/transactions",
        "settlements": "https://api.forte.net/v3/fundings/fnd_ACH-0309-2F776/settlements",
        "self": "https://api.forte.net/v3/fundings/fnd_ACH-0309-2F776/"
      }
    },
    {
      "funding_id": "fnd_ACH-0313-C38E5",
      "organization_id": "org_300005",
      "location_id": "loc_215940",
      "status": "completed",
      "effective_date": "2023-03-14T00:00:00",
      "origination_date": "2023-03-13T00:00:00",
      "net_amount": -1,
      "routing_number": "211170101",
      "last_4_account_number": "2312",
      "bank_information": "WEBSTER BANK, N.A.",
      "funding_source": {
        "code": "ACH",
        "description": "Net ACH Funding"
      },
      "entry_description": "FUNDING",
      "funding_response_code": "S01",
      "reserve_release": 0,
      "reserve": 0,
      "discount_fee": 0,
      "links": {
        "transactions": "https://api.forte.net/v3/fundings/fnd_ACH-0313-C38E5/transactions",
        "settlements": "https://api.forte.net/v3/fundings/fnd_ACH-0313-C38E5/settlements",
        "self": "https://api.forte.net/v3/fundings/fnd_ACH-0313-C38E5/"
      }
    }
  ],
  "response": {
    "environment": "live",
    "response_desc": "Get Successful."
  },
  "links": {
    "self": "https://api.forte.net/v3/fundings/?filter=start_effective_date+eq+%272023-03-01T00%3a00%3a00%27+and+end_effective_date+eq+%272023-03-15T00%3a00%3a00%22"
  }
}
				
			
Edit Content
Headers (13)

cache-control

no-cache

connection

keep-alive

content-type

application/json; charset=utf-8

date

Mon, 23 Oct 2017 16:58:29 GMT

expires

-1

pragma

no-cache

server

Microsoft-IIS/8.5

transfer-encoding

chunked

www-authenticate

Basic realm="sandbox.forte.net"

x-aspnet-version

4.0.30319

x-cdn

Incapsula

x-iinfo

1-3593717-3660544 NNNN CT(48 39 0) RT(1508870937210 435264) q(0 0 1 -1) r(2 2) U6

x-powered-by

ASP.NET

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.

AUTHORIZATION Basic Auth
 
Username     {{apiaccessid}}
Password      {{apisecurekey}}

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

Edit Content
				
					{
  "funding_id": "fnd_CC-0405-1652C",
  "organization_id": "org_381450",
  "location_id": "loc_242417",
  "status": "completed",
  "effective_date": "2023-04-06T00:00:00",
  "origination_date": "2023-04-05T00:00:00",
  "net_amount": 10,
  "routing_number": "211170101",
  "last_4_account_number": "2312",
  "bank_information": "WEBSTER BANK, N.A.",
  "funding_source": {
    "code": "CC",
    "description": "Payfac Credit Card"
  },
  "entry_description": "FUNDING",
  "funding_response_code": "S01",
  "reserve_release": 0,
  "reserve": 0,
  "discount_fee": 0,
  "response": {
    "environment": "live",
    "response_desc": "Get Successful."
  },
  "links": {
    "transactions": "https://api-live-testlan.4ta.com/v3/fundings/fnd_CC-0405-1652C/transactions",
    "settlements": "https://api-live-testlan.4ta.com/v3/fundings/fnd_CC-0405-1652C/settlements",
    "self": "https://api-live-testlan.4ta.com/v3/fundings/fnd_CC-0405-1652C/"
  }
}
				
			
Edit Content
Headers (13)

cache-control

no-cache

connection

keep-alive

content-type

application/json; charset=utf-8

date

Mon, 23 Oct 2017 16:54:49 GMT

expires

-1

pragma

no-cache

server

Microsoft-IIS/8.5

transfer-encoding

chunked

www-authenticate
 

Basic realm="sandbox.forte.net"

 

x-aspnet-version

4.0.30319

x-cdn

Incapsula

x-iinfo

0-39878815-39878822 SNNN RT(1508777666476 22208) q(0 0 0 -1) r(2 2) U16

x-powered-by

ASP.NET

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.

AUTHORIZATION Basic Auth
 
Username     {{apiaccessid}}
Password      {{apisecurekey}}

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

Edit Content
				
					{
  "number_results": 1,
  "search_criteria": {
    "page_size": 50,
    "page_index": 0,
    "home_organization_id": "org_334316",
    "resource_specific": {
      "funding_id": "fnd_D2307112EC"
    }
  },
  "results": [
    {
      "transaction_id": "trn_54641352-f279-4f45-981a-7909f03a97eb",
      "organization_id": "org_300005",
      "location_id": "loc_115161",
      "customer_id": "32215",
      "order_number": "33302547",
      "reference_id": "789654",
      "status": "funded",
      "action": "sale",
      "authorization_amount": 0.23,
      "authorization_code": "86697777",
      "entered_by": "",
      "received_date": "2015-01-02T04:18:33.967",
      "first_name": "Christoper",
      "last_name": "Lloyd",
      "company_name": "MJF Productions",
      "response": {
        "response_code": "A01"
      },
      "links": {
        "self": "https://api.forte.net/v3/organizations/org_300005/locations/loc_115161/transactions/trn_54641352-f279-4f45-981a-7909f03a97eb"
      }
    }
  ],
  "response": {
    "environment": "live",
    "response_desc": "Get Successful."
  },
  "links": {
    "self": "https://api.forte.net/v3/organizations/org_334316/fundings/fnd_D2307112EC/transactions/"
  }
}
				
			
Edit Content
Headers (12)

cache-control

no-cache

connection

keep-alive

content-type

application/json; charset=utf-8

date

Mon, 23 Oct 2017 16:55:03 GMT

expires

-1

pragma

no-cache

server

Microsoft-IIS/8.5

transfer-encoding

chunked

x-aspnet-version

4.0.30319

x-cdn

Incapsula

x-iinfo

0-39878815-39878822 SNNN RT(1508777666476 36928) q(0 0 0 -1) r(1 1) U16

x-powered-by

ASP.NET

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.

AUTHORIZATION Basic Auth
 
Username     {{apiaccessid}}
Password      {{apisecurekey}}

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

Edit Content
Edit Content
Headers (12)

cache-control

no-cache

connection

keep-alive

content-type

application/json; charset=utf-8

date

Mon, 23 Oct 2017 16:49:07 GMT

expires

-1

pragma

no-cache

server

Microsoft-IIS/8.5

transfer-encoding

chunked

x-aspnet-version

4.0.30319

x-cdn

Incapsula

x-iinfo

9-96773803-96773810 NNNN CT(38 87 0) RT(1508777346539 21) q(0 0 1 0) r(4 4) U16

x-powered-by

ASP.NET

On this page