Funding

The Funding API allows you to create and manage sources and transfers for customers and correspondents.

POST/v1/funding/sources

Create Source

Use this endpoint to create a source on behalf of a customer. Sources are used to fund customer accounts.

Request Body

Parameter	Description	Type	Input
`customerId`	Unique ID for the customer	UUID	Required
`routingNumber`	Routing number for the source	String	Required
`accountNumber`	Account number for the source	String	Required
`ownerName`	Name of the account holder	String	Required
`accountType`	Account type ('CHECKING', 'SAVINGS')	String	Required
`bankName`	Name of the bank	String	Required
`fraudCheck`	Fraud check conducted on the source	Boolean	Required

Success Response

JSON

201 Created

{
    "createdAt": "2024-04-27T12:39:56.175Z",
    "updatedAt": "2024-04-27T12:39:56.175Z",
    "sourceId": "57f8c61d-2b8a-46a1-99ef-71d96700adee",
    "customerId": "014f3054-fac3-47cc-a167-1de0cc1deeb6",
    "accountNumber": "87063095765080634",
    "routingNumber": "1234569",
    "accountType": "SAVINGS",
    "active": true,
    "bankName": "WestStar Bank",
    "fraudCheck": true,
    "ownerName": "Robert Davis"
}

GET/v1/funding/sources/{sourceId}

Get Source

Use this endpoint to retrieve a source for a customer.

Path Parameters

Parameter	Description	Type	Input
`sourceId`	Unique ID for the source	UUID	Required

Success Response

JSON

200 OK

{
    "createdAt": "2024-04-27T12:39:56.175Z",
    "updatedAt": "2024-04-27T12:39:56.175Z",
    "sourceId": "57f8c61d-2b8a-46a1-99ef-71d96700adee",
    "customerId": "014f3054-fac3-47cc-a167-1de0cc1deeb6",
    "accountNumber": "87063095765080634",
    "routingNumber": "1234569",
    "accountType": "SAVINGS",
    "active": true,
    "bankName": "WestStar Bank",
    "fraudCheck": true,
    "ownerName": "Robert Davis"
}

GET/v1/funding/sources?customerId={customerId}&page={page}&limit={limit}

Get Sources by Customer

Use this endpoint to retrieve a list of sources for a customer.

Query Parameters

Parameter	Description	Type	Input
`customerId`	Unique ID for the customer	UUID	Required
`page`	Page number for pagination	Integer	Optional
`limit`	Number of items per page	Integer	Optional

Success Response

JSON

200 OK

{
    "sources": [
{
    "createdAt": "2024-04-27T12:39:56.175Z",
    "updatedAt": "2024-04-27T12:39:56.175Z",
    "sourceId": "57f8c61d-2b8a-46a1-99ef-71d96700adee",
    "customerId": "014f3054-fac3-47cc-a167-1de0cc1deeb6",
    "accountNumber": "87063095765080634",
    "routingNumber": "1234569",
    "accountType": "SAVINGS",
    "active": true,
    "bankName": "WestStar Bank",
    "fraudCheck": true,
    "ownerName": "Robert Davis"
}
    ],
    "meta": {
    "page": 1,
    "limit": 50,
    "total": 1,
    "hasMore": false
}
}

GET/v1/funding/sources?correspondentId={correspondentId}&page={page}&limit={limit}

Get Sources by Correspondent

Use this endpoint to retrieve a list of sources for customers of a correspondent.

Query Parameters

Parameter	Description	Type	Input
`correspondentId`	Unique ID for the correspondent	UUID	Required
`page`	Page number for pagination	Integer	Optional
`limit`	Number of items per page	Integer	Optional

Success Response

JSON

200 OK

{
    "sources": [
{
    "createdAt": "2024-04-27T12:39:56.175Z",
    "updatedAt": "2024-04-27T12:39:56.175Z",
    "sourceId": "57f8c61d-2b8a-46a1-99ef-71d96700adee",
    "customerId": "014f3054-fac3-47cc-a167-1de0cc1deeb6",
    "accountNumber": "87063095765080634",
    "routingNumber": "1234569",
    "accountType": "SAVINGS",
    "active": true,
    "bankName": "WestStar Bank",
    "fraudCheck": true,
    "ownerName": "Robert Davis"
}
    ],
    "meta": {
    "page": 1,
    "limit": 50,
    "total": 1,
    "hasMore": false
}
}

PUT/v1/funding/sources/{sourceId}/archive

Archive Source

Use this endpoint to archive a source. Archived sources are no longer active and cannot be used for transfers.

Path Parameters

Parameter	Description	Type	Input
`sourceId`	Unique ID for the source	UUID	Required

Success Response

JSON

200 OK

{
    "createdAt": "2024-04-27T12:39:56.175Z",
    "updatedAt": "2024-04-27T12:39:56.175Z",
    "sourceId": "57f8c61d-2b8a-46a1-99ef-71d96700adee",
    "customerId": "014f3054-fac3-47cc-a167-1de0cc1deeb6",
    "accountNumber": "87063095765080634",
    "routingNumber": "1234569",
    "accountType": "SAVINGS",
    "active": false,
    "bankName": "WestStar Bank",
    "fraudCheck": true,
    "ownerName": "Robert Davis"
}

POST/v1/funding/transfers

Create Transfer

Use this endpoint to create a transfer on behalf of a customer.

Request Body

Parameter	Description	Type	Input
`customerId`	Unique ID for the customer	UUID	Required
`sourceId`	Unique ID for the source	UUID	Required
`portfolioId`	Unique ID for the portfolio	UUID	Required
`transferType`	Transfer type ('DEPOSIT', 'WITHDRAWAL')	String	Required
`amount`	The numerical value of the transfer. Positive for 'DEPOSIT,' and negative for 'WITHDRAWAL'	Float	Required

Success Response

JSON

201 Created

{
    "createdAt": "2024-03-06T03:04:08.046Z",
    "updatedAt": "2024-03-06T03:04:09.616Z",
    "transferId": "00a47b8b-5046-4704-abf4-4f163ca0fa7e",
    "customerId": "014f3054-fac3-47cc-a167-1de0cc1deeb6",
    "sourceId": "57f8c61d-2b8a-46a1-99ef-71d96700adee",
    "amount": 125.75,
    "status": "COMPLETED",
    "type": "DEPOSIT",
    "message": "Transfer completed successfully",
    "clearedAt": null
}

GET/v1/funding/transfers/{transferId}

Get Transfer

Use this endpoint to retrieve a transfer for a customer.

Path Parameters

Parameter	Description	Type	Input
`transferId`	Unique ID for the transfer	UUID	Required

Success Response

JSON

200 OK

{
    "createdAt": "2024-03-06T03:04:08.046Z",
    "updatedAt": "2024-03-06T03:04:09.616Z",
    "transferId": "00a47b8b-5046-4704-abf4-4f163ca0fa7e",
    "customerId": "014f3054-fac3-47cc-a167-1de0cc1deeb6",
    "sourceId": "57f8c61d-2b8a-46a1-99ef-71d96700adee",
    "amount": 125.75,
    "status": "COMPLETED",
    "type": "DEPOSIT",
    "message": "Transfer completed successfully",
    "clearedAt": null
}

GET/v1/funding/transfers?customerId={customerId}&page={page}&limit={limit}

Get Transfers by Customer

Use this endpoint to retrieve a list of transfers for a customer.

Query Parameters

Parameter	Description	Type	Input
`customerId`	Unique ID for the customer	UUID	Required
`page`	Page number for pagination	Integer	Optional
`limit`	Number of items per page	Integer	Optional

Success Response

JSON

200 OK

{
    "transfers": [
{
    "createdAt": "2024-04-27T12:39:56.175Z",
    "updatedAt": "2024-04-27T12:39:56.175Z",
    "transferId": "a3540f35-5d92-49c9-a374-79abe8025a4e",
    "customerId": "014f3054-fac3-47cc-a167-1de0cc1deeb6",
    "sourceId": "57f8c61d-2b8a-46a1-99ef-71d96700adee",
    "amount": 500,
    "status": "COMPLETED",
    "type": "WITHDRAWAL",
    "message": "Funds transferred",
    "clearedAt": null
},
{
    "createdAt": "2024-04-27T12:39:56.175Z",
    "updatedAt": "2024-04-27T12:39:56.175Z",
    "transferId": "b9c7feb6-7d40-48a2-8652-d29ae6aa5929",
    "customerId": "014f3054-fac3-47cc-a167-1de0cc1deeb6",
    "sourceId": "57f8c61d-2b8a-46a1-99ef-71d96700adee",
    "amount": 25,
    "status": "CREATED",
    "type": "WITHDRAWAL",
    "message": "Transfer created",
    "clearedAt": null
}
    ],
    "meta": {
    "page": 1,
    "limit": 50,
    "total": 2,
    "hasMore": false
}
}

GET/v1/funding/transfers?correspondentId={correspondentId}&page={page}&limit={limit}

Get Transfers by Correspondent

Use this endpoint to retrieve a list of transfers for a correspondent.

Query Parameters

Parameter	Description	Type	Input
`correspondentId`	Unique ID for the correspondent	UUID	Required
`page`	Page number for pagination	Integer	Optional
`limit`	Number of items per page	Integer	Optional

Success Response

JSON

200 OK

{
    "transfers": [
{
    "createdAt": "2024-04-27T12:39:56.175Z",
    "updatedAt": "2024-04-27T12:39:56.175Z",
    "transferId": "a3540f35-5d92-49c9-a374-79abe8025a4e",
    "customerId": "014f3054-fac3-47cc-a167-1de0cc1deeb6",
    "sourceId": "57f8c61d-2b8a-46a1-99ef-71d96700adee",
    "amount": 500,
    "status": "COMPLETED",
    "type": "WITHDRAWAL",
    "message": "Funds transferred",
    "clearedAt": null
},
{
    "createdAt": "2024-04-27T12:39:56.175Z",
    "updatedAt": "2024-04-27T12:39:56.175Z",
    "transferId": "b9c7feb6-7d40-48a2-8652-d29ae6aa5929",
    "customerId": "014f3054-fac3-47cc-a167-1de0cc1deeb6",
    "sourceId": "57f8c61d-2b8a-46a1-99ef-71d96700adee",
    "amount": 25,
    "status": "CREATED",
    "type": "WITHDRAWAL",
    "message": "Transfer created",
    "clearedAt": null
}
    ],
    "meta": {
    "page": 1,
    "limit": 50,
    "total": 2,
    "hasMore": false
}
}