Validate Your API Credentials

Before you begin API testing, please validate your sandbox credentials to ensure that your API user is properly set up and ready to go.

When your credentials are created, Finexio will auto-generate 3 counterparties: 2 buyers, and 1 supplier for you to get started. To validate your credentials, you can call the "List Counterparties" endpoint (https://stage.api.finexio.com/v2/counterparties/). Simply enter your credentials under the ‘Authentication’ section and click on the ‘Try it’ button.

If everything is working properly, you should get an API response with 3 records. The 2 auto-generated buyer counterparties have a name consisting of your first name followed by either a 1 or 2. The supplier is named “Acme Co.”

All API requests must be made over HTTPS. Calls made over plain HTTP will fail.

Example Response:

"count": 3,
    "next": null,
    "previous": null,
    "results": [
        {
            "id": "0b575520-d4fc-47a5-a27a-7b2c062e075f",
            "name": "FinexioTest1",
            "type": "Buyer",
            "created": "2023-03-14T13:52:12.929815",
            "updated": "2023-03-14T13:52:13.267218",
            "address_1": null,
            "address_2": null,
            "city": null,
            "state": null,
            "zipcode": null,
            "country": "USA",
            "primary_contact_email": null,
            "remit_email": null,
            "primary_contact_name": null,
            "primary_contact_phone": null,
            "bank_account_number": null,
            "bank_routing_number": null,
            "payment_method": "",
            "internal_id": "Example1",
            "payment_terms": null,
            "tax_id": null,
            "notes": null
        },
        {
            "id": "66449894-e0f4-4193-8d23-88c3526920bb",
            "name": "FinexioTest2",
            "type": "Buyer",
            "created": "2023-03-14T13:52:12.929815",
            "updated": "2023-03-14T13:52:13.279669",
            "address_1": null,
            "address_2": null,
            "city": null,
            "state": null,
            "zipcode": null,
            "country": "USA",
            "primary_contact_email": null,
            "remit_email": null,
            "primary_contact_name": null,
            "primary_contact_phone": null,
            "bank_account_number": null,
            "bank_routing_number": null,
            "payment_method": "",
            "internal_id": "Example2",
            "payment_terms": null,
            "tax_id": null,
            "notes": null
        },
        {
            "id": "2c87f559-a0c7-4526-8dbc-77e06f2bc8d6",
            "name": "Acme Co.",
            "type": "Supplier",
            "created": "2023-03-14T13:52:12.929815",
            "updated": "2023-03-15T21:12:12.776580",
            "address_1": "4000 Warner Boulevard",
            "address_2": null,
            "city": "Burbank",
						"state": "CA",
            "zipcode": "91505",
            "country": "USA",
            "primary_contact_email": "[email protected]",
            "remit_email": null,
            "primary_contact_name": null,
            "primary_contact_phone": null,
            "bank_account_number": null,
            "bank_routing_number": null,
            "payment_method": "PrintedCheck",
            "internal_id": "ACME",
            "twelve_month_spend": null,
            "twelve_month_payment_count": null,
            "payment_terms": null,
            "tax_id": "123-12-1238",
            "ineligible_for_conversion": false,
            "business_type": null,
            "notes": null
        }
    ]
}