Funding Source

The Funding Source API allows you to retrieve information about funding sources associated with your customer account. The API supports two endpoints:

• Search Funding Sources

• Get a Specific Funding Source

Search Funding Sources

Retrieve a paginated list of funding sources available to your account. This is useful for getting an overview of all funding sources tied to your account.

Method: POST

Endpoint: {{env}}/api/fundingsource/filter

Authentication

This endpoint requires authentication.

Payload (Customer)

{
    "FundingSourceStatus":"Approved",
    "BillingAccount": true,
    "ItemsPerPage": 10,
    "PageNumber": 1
}

Payload (Partner)

{
    "CustomerCompanyName":"Your Customer Company Name",
    "CustomerCompanyNameOperator":"contains",
    "CustomerId":"e803b6aa-7c5a-497e-9d1c-8038891107dc",
    "CustomerIdOperator":"contains",
    "FundingSourceStatus":"Approved",
    "BillingAccount": true,
    "ItemsPerPage": 10,
    "PageNumber": 1
}

Response

{
    "statusCode": 200,
    "message": "POST Request successful.",
    "isError": false,
    "result": {
        "CurrentPage": 1,
        "PageSize": 8,
        "TotalCount": 4,
        "Items": [
            {
                "Id": "332b012e-e893-4e9f-b3c7-521578781f88",
                "Customer": {
                    "Id": "e803b6aa-7c5a-497e-9c8c-8038891107dc",
                    "CompanyName": "Your Company Name"
                },
                "Number": "900 10000 54645343",
                "Name": "Jhon Doe",
                "CreatedAt": "2025-04-10T17:15:11.402066Z",
                "AggregationStatus": "Connected",
                "LastTimeRefreshed": "2025-04-10T17:15:12.19788Z",
                "FundingSourceType": "BankAccount",
                "BillingAccount": false,
                "HasBillingAccountSet": true,
                "FundingSourceStatus": "PendingApproval"
            },
            {
                "Id": "57fc9dd5-68c1-46df-abd9-bf767a98d5e9",
                "Customer": {
                    "Id": "e803b6aa-7c5a-497e-9c8c-8038891107dc",
                    "CompanyName": "Your Company Name"
                },
                "Number": "xxxxxxxxxxxx4242 - VISA",
                "Name": "Jhon Doe",
                "CreatedAt": "2025-04-10T17:13:53.586214Z",
                "AggregationStatus": "NotConnected",
                "FundingSourceType": "CreditCard",
                "BillingAccount": false,
                "HasBillingAccountSet": false,
                "FundingSourceStatus": "PendingApproval",
                "BrandName": "VISA"
            },
            {
                "Id": "7d3664a1-580a-4802-b212-e2ef14933319",
                "Customer": {
                    "Id": "e803b6aa-7c5a-497e-9c8c-8038891107dc",
                    "CompanyName": "Your Company Name"
                },
                "Number": "900 10000 2564450",
                "Name": "Jhon Doe",
                "CreatedAt": "2025-03-20T20:01:58.831584Z",
                "AggregationStatus": "Connected",
                "LastTimeRefreshed": "2025-03-20T20:02:01.929062Z",
                "FundingSourceType": "BankAccount",
                "BillingAccount": false,
                "HasBillingAccountSet": true,
                "FundingSourceStatus": "Approved"
            },
            {
                "Id": "04909f25-99ea-438e-a7f1-8639dcd323f9",
                "Customer": {
                    "Id": "e803b6aa-7c5a-497e-9c8c-8038891107dc",
                    "CompanyName": "Your Company Name"
                },
                "Number": "003 69090 4921710685",
                "Name": "Jhon Doe",
                "CreatedAt": "2025-02-04T21:42:31.772218Z",
                "AggregationStatus": "NotConnected",
                "FundingSourceType": "BankAccount",
                "BillingAccount": true,
                "HasBillingAccountSet": true,
                "FundingSourceStatus": "Approved"
            }
        ]
    }
}

Input Parameters

Parameter	Type	Required	Description
fundingSourceStatus	string	No	Filter by the the status of the funding source. Available options: Approved/Pending Approval/ Rejected
BillingAccount	boolean	No	If the response should include or exclude funding source that is used as a billing account
CustomerCompanyName	string	No- available for partner accounts only	Filter by a customer name
CustomerId	guid	No- available for partner accounts only	Filter by a customer id
Pagination
ItemsPerPage	Integer	No	The desired number of funding sources per page
PageNumber	Integer	No	The desired page

Operators

Type	Description
contains	Filter records that contains the value
excludes	Filter records that does not contains the value
exactly matches	Filter records that exactly matches the value

Response

Parameter	Type	Description
Id	guid	Funding Source Id
Number	string	The Bank Account or the Credit Card number
Name	string	Name of the account holder or the name on the card
CreatedAt	datetime	When the funding source was created
AggregationStatus	string	Bank account connection status (used when Bank account funding source was added suing Aggregation)
LastTimeRefreshed	datetime	When a Bank account was reconnected
FundingSourceType	string	Bank Account or Credit Card
BillingAccount	boolean	If this funding source is used as a billing account
HasBillingAccountSet	boolean	If the customer has an existing billing account defined
FundingSourceStatus	string	The status of the funding source. Available options: Approved/Pending Approval/ Rejected
Customer		Basic Customer data
Id	guid	Customer Id
CompanyName	String	Company Name

Get a Specific Funding Source

Retrieve detailed information about a specific funding source by its ID.

Endpoint: Method: POST

Endpoint: {{env}}/api/fundingsource/{fundingSourceId}

Replace {fundingSourceId} with the ID of the funding source you want to retrieve.

Authentication

This endpoint requires authentication using your API credentials.

Response

{
  "statusCode": 200,
  "message": "GET Request successful.",
  "isError": false,
  "result": {
    "Id": "04909f25-99ea-438e-a7f1-8639dcd323f9",
    "Customer": {
      "Enable3DSecureVisa": false,
      "Enable3DSecureCreditCard": false,
      "InteracProvider": "Desjardins",
      "AddressCountry": "Canada",
      "Id": "e803b6aa-7c5a-497e-9c8c-8038891107dc",
      "CompanyName": "Your Company Name",
      "CompanyEmail": "[e-mail]"
    },
    "Institution": "Royal Bank of Canada",
    "InstitutionNumber": "003",
    "TransitNumber": "69090",
    "AccountNumber": "4921710685",
    "AccountType": "Business",
    "RoutingNumber": "",
    "Name": "Jhon Doe",
    "CompanyName": "Your Company Name",
    "Email": "[e-mail]",
    "CreatedAt": "2025-02-04T21:42:31.772218Z",
    "AggregationStatus": "NotConnected",
    "HasMinimumInformationForEft": true,
    "FundingSourceStatus": "Approved",
    "Country": "Canada",
    "UpdatedAt": "2025-02-04T21:42:31.772218Z"
  }
}

Input parameters

Parameter	Type	Mandatory	Description
fundingSourceId	string	Yes	The unique ID of the funding source

Response

Parameter	Type	Description
Id	guid	Funding Source Id
Institution	string	Financial institution name
InstitutionNumber	string	Financial institution number (for Canada)
TransitNumber	string	Financial institution transit number (for Canada)
AccountNumber	string	Bank account number
AccountType	string	Account type (Business or Personal)
RoutingNumber	string	Financial institution routing number (for US)
Name	string	Name of the account or the card holder for personal account
CompanyName	string	Name of the account or the card holder for Business account
Email	string	Email of the account or card holder
CreatedAt	datetime	When the funding source was created
AggregationStatus	string	The status of the bank connection if was added through Aggregation
FundingSourceStatus	string	the status of the funding source
Country	string	The country of the funding source
UpdatedAt	datetime	Last updated date