funding sources

Get a Payee's Funding Sources

Retrieve a Payee's Funding Source Information.

Securityx-api-key
Request
path Parameters
payee_id
required
integer (id)

The id number of the object being returned.

Example: 87346
header Parameters
broker-id
required
integer (broker_id)

The id of the broker

Example: 66305
Responses
200

OK

get/payees/{payee_id}/funding-sources
Request samples
Response samples
application/json
{
  • "PAPER_CHECK": {
    },
  • "ACH": {
    }
}

Create a Funding Source for a Payee

Create a new funding source for an existing Payee.

Securityx-api-key
Request
path Parameters
payee_id
required
integer (id)

The id number of the object being returned.

Example: 87346
header Parameters
broker-id
required
integer (broker_id)

The id of the broker

Example: 66305
Request Body schema: application/json

Funding source type can be either ach or papercheck

One of:
type
string

The type of the funding source

Value: "PAPER_CHECK"
object
Responses
201

OK

post/payees/{payee_id}/funding-sources
Request samples
application/json
{
  • "type": "PAPER_CHECK",
  • "data": {
    }
}
Response samples
application/json
{
  • "id": 87346
}

Update a Funding Source for a Payee

Update funding source for an existing Payee.

Securityx-api-key
Request
path Parameters
payee_id
required
integer (id)

The id number of the object being returned.

Example: 87346
Request Body schema: application/json

Funding source type can be either ach or papercheck

One of:
type
string

The type of the funding source

Value: "PAPER_CHECK"
object
Responses
201

OK

patch/payees/{payee_id}/funding-sources
Request samples
application/json
{
  • "type": "PAPER_CHECK",
  • "data": {
    }
}
Response samples
application/json
{
  • "id": 87346
}

Get a Broker's Funding Sources

Retrieve a Broker's Funding Source Information.

Securityx-api-key
Request
path Parameters
broker_id
required
integer (id)

The id number of the object being returned.

Example: 87346
header Parameters
broker-id
required
integer (broker_id)

The id of the broker

Example: 66305
Responses
200

OK

get/brokers/{broker_id}/funding-sources
Request samples
Response samples
application/json
{
  • "PAPER_CHECK": {
    },
  • "ACH": {
    },
  • "WALLET": {
    }
}
Copyright © RoadSync 2023. All right reserved.