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

get/payees/{payee_id}/funding-sources

Request samples

curl
JavaScript
Node.js
Python

Response samples

application/json

{"PAPER_CHECK": {"id": 87346,
"name": "Atlanta Brokerage",
"address_line_one": "715 Peachtree St",
"address_line_two": "APT 23",
"address_city": "Atlanta",
"address_state": "GA",
"address_zip": "30306"
},
"ACH": {"id": 87346,
"name": "Atlanta Brokerage",
"account_number": "1234567890",
"routing_number": "610000523",
"bank_account_type": "checking",
"has_rtp": true
}
}

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

post/payees/{payee_id}/funding-sources

Request samples

Payload
curl
JavaScript
Node.js
Python

application/json

{"type": "PAPER_CHECK",
"data": {"name": "Atlanta Brokerage",
"address_line_one": "715 Peachtree St",
"address_line_two": "APT 23",
"address_city": "Atlanta",
"address_state": "GA",
"address_zip": "30306"
}
}

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

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

patch/payees/{payee_id}/funding-sources

Request samples

Payload
curl
JavaScript
Node.js
Python

application/json

{"type": "PAPER_CHECK",
"data": {"name": "Atlanta Brokerage",
"address_line_one": "715 Peachtree St",
"address_line_two": "APT 23",
"address_city": "Atlanta",
"address_state": "GA",
"address_zip": "30306"
}
}

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

Responses

200

get/brokers/{broker_id}/funding-sources

Request samples

curl
JavaScript
Node.js
Python

Response samples

application/json

{"PAPER_CHECK": {"id": 87346,
"name": "Atlanta Brokerage",
"address_line_one": "715 Peachtree St",
"address_line_two": "APT 23",
"address_city": "Atlanta",
"address_state": "GA",
"address_zip": "30306"
},
"ACH": {"id": 87346,
"name": "Atlanta Brokerage",
"bank_account_type": "checking",
"account_number": "1234567890",
"routing_number": "610000523"
},
"WALLET": {"id": 87346,
"name": "Atlanta Brokerage",
"balance": 15953.21
}
}