Get Buyer Detail

get https://api.finexio-stage.com/v2/counterparties/buyers/{id}/

Get Information Of A Single Buyer

Individual Buyers can be retrieved using the Buyers endpoint with a GET operation. Pass the buyer's counterparty id in the id path parameter: /counterparties/buyers/{id}

Example Response

{
    "id": "1bd1142b-67c2-470a-87b8-98547cfb24d2",
    "name": "My Test Buyer",
    "address_1": "456 Main street",
    "address_2": "",
    "city": "Atlanta",
    "state": "GA",
    "zipcode": "30339",
    "country": "USA",
    "corporate_phone_number": "2392349990",
    "external_reference_id": "MY-TEST-BUYER",
    "remit_data": "",
    "tax_id": "123-12-1234",
    "funding_method": "ach_debit",
    "drawdown_bank_account_number": "3443",
    "drawdown_bank_routing_number": "121000358",
    "refund_bank_account_number": "3443",
    "refund_bank_routing_number": "121000358",
    "contacts": [
        {
            "funding_notification": true,
            "refund_notification": true,
            "id": "eac48af2-5635-462f-91ae-4771c1ca09b5",
            "external_reference_id": "john-1234",
            "name": "John Doe",
            "email": "john@abc.com",
            "phone": "1235554444",
            "primary": true
        }
    ],
    "ready_for_use": true,
    "reason_not_usable": null,
    "metadata": null,
    "created": "2023-12-28T23:02:32.096000",
    "updated": "2023-12-29T00:16:46.590000",
    "owners": [
        {
            "controlling_owner": true,
            "first_name": "ww",
            "last_name": "ww",
            "country_code": "USA",
            "address1": "TestAd1T1TestAd1",
            "address2": "TeTestAd2TestAd2",
            "city": "TestCity",
            "state": "CA",
            "postal_code": "12345",
            "date_of_birth": "BSIVaLtJgiPs0X+VeY2aow==.P3wfJ39ealezyxxXzbmcvw==",
            "email": "test@finexio.com",
            "ssn": "*********",
            "passport": null,
            "passport_country": "",
            "drivers_license_number": "*********",
            "drivers_license_state": "NY"
        }
    ]
}

Responses

Response body

object

string

name

string

length ≤ 120

business legal name (max length = 120)

dba_name

string

length ≤ 100

doing business as name (max length = 100)

address_1

string

length ≤ 40

max length = 40

address_2

string

length ≤ 40

max length = 40

city

string

length ≤ 40

max length = 40

state

string

length ≤ 2

accepts one of these values: [ 'AL', 'AK', 'AS', 'AZ', 'AR', 'AA', 'AE', 'AP', 'CA', 'CO', 'CT', 'DE', 'DC', 'FL', 'GA', 'GU', 'HI', 'ID', 'IL', 'IN', 'IA', 'KS', 'KY', 'LA', 'ME', 'MD', 'MA', 'MI', 'MN', 'MS', 'MO', 'MT', 'NE', 'NV', 'NH', 'NJ', 'NM', 'NY', 'NC', 'ND', 'MP', 'OH', 'OK', 'OR', 'PA', 'PR', 'RI', 'SC', 'SD', 'TN', 'TX', 'UT', 'VT', 'VI', 'VA', 'WA', 'WV', 'WI', 'WY', 'AB', 'BC', 'MB', 'NB', 'NL', 'NT', 'NS', 'NU', 'ON', 'PE', 'QC', 'SK', 'YT' ]

AL AK AS AZ AR AA AE AP CA CO CT DE DC FL GA GU HI ID IL IN IA KS KY LA ME MD MA MI MN MS MO MT NE NV NH NJ NM NY NC ND MP OH OK OR PA PR RI SC SD TN TX UT VT VI VA WA WV WI WY AB BC MB NB NL NT NS NU ON PE QC SK YT

zipcode

string

length ≤ 10

max length = 10

country

string

Defaults to USA

accepts one of these values: [ 'CAN', 'UMI', 'USA' ].

CAN UMI USA

corporate_phone_number

string

length ≤ 16

max length = 16

external_reference_id

string

length ≤ 200

max length = 200. Secondary identifier. This value must be unique.

remit_data

string

length ≤ 70

max length = 70

tax_id

string

length ≤ 11

max length = 11

funding_method

string

accepts one of these values: [ 'ach_debit', 'ach_credit', 'wire', 'reverse_wire' ].

ach_debit ach_credit wire reverse_wire

drawdown_bank_account_number

string

length ≤ 17

max length = 17
required only if funding_method is 'ach_debit' or 'reverse_wire'

drawdown_bank_routing_number

string

length ≤ 9

max length = 9
required only if funding_method is 'ach_debit' or 'reverse_wire'

refund_bank_account_number

string

length ≤ 17

max length = 17

refund_bank_routing_number

string

length ≤ 9

max length = 9

contacts

array of objects

contacts

object

string

This will be generated by Finexio.

external_reference_id

string

length ≤ 100

max length = 100
This value must be unique.

name

string

length ≤ 40

max length = 40

string

length ≤ 50

max length = 50

phone

string

length ≤ 17

max length = 17

primary

boolean

required

Indicates whether the contact is the primary contact.

funding_notification

boolean

Defaults to false

Indicates if this contact should receive funding notifications.

refund_notification

boolean

Defaults to false

Indicates if this contact should receive refund notifications.

ready_for_use

boolean

Defaults to false

reason_not_usable

string

length ≤ 40

max length = 40

metadata

object

Array of name/value pairs.The name can be any character string not beginning with _ with a max length of 25 characters, The value can have a max length of 100 chars and can be null.

Has additional fields

created

date-time

updated

date-time

owners

array of objects

owners

object

controlling_owner

boolean

required

must be set to true.

first_name

string

required

Owner's first name.

last_name

string

required

Owner's last name.

country_code

string

required

Owner's country.

USA CAN

address1

string

required

length ≤ 40

Owner's address line 1.
max length = 40

address2

string

length ≤ 40

Owner's address line 2.
max length = 40

city

string

required

length ≤ 40

Owner's city.
max length = 40

state

string

required

State of the owner. 2 letter state abbreviation.

postal_code

string

required

length ≤ 10

Owner's zipcode.
max length = 10

date_of_birth

string

required

Owner's date of birth.
acceptable format: yyyy-mm-dd

string

required

Owner's email address.

ssn

string

Owner's social security number.
required only if owner's country is USA.

passport

string

Owner's passport.

passport_country

string

Owner's passport country.
required only if passport is entered.

drivers_license_number

string

Driver's license of the owner.

drivers_license_state

string

2 alpha State issuing the driver's license.

Language

Credentials

Basic

base64


xxxxxxxxxx
1
curl --request GET \
2
     --url https://api.finexio-stage.com/v2/counterparties/buyers/id/ \
3
     --header 'accept: application/json'

Click Try It! to start a request and see the response here! Or choose an example:

application/json

Example Response

200Success

400Bad Request

404Not Found