Get my Informations

Get My Informations

GET {{Environment_URL}}/vendors/v1/vendors/me

This endpoint returns the profile and operational information of the authenticated vendor. It allows you to retrieve all data related to your own account, including:

• Company or individual identification

• Business type and classification

• Contact and address information

• Compliance and business nature data

• Default currency and operational settings

• Vendor status and payout configuration

• Linked account information

You must send a valid authentication token in the Authorization header to access this endpoint. This endpoint is commonly used to:

• Validate that authentication is working correctly

• Display account information in your dashboard

• Retrieve business “nature” data required to create new transactions

• Check whether charges and payouts are enabled for the account

Use this as a first step after authentication to understand the current state and configuration of your vendor account

Headers

Name	Value
Authorization	Bearer <token>

Response

200 - OK

{
    "id": "vnd_01hdzbztjh3ctgjbnw8xtb5dxa",
    "businessType": "COMPANY",
    "businessClass": [
        "OTHER_SERVICES"
    ],
    "name": "Simple Pay S.A",
    "vendorResponsiblePhone": "[phone]",
    "commercialPhone": "[phone]",
    "fullNameResponsible": "",
    "address": {
        "city": "Sao Paulo",
        "state": "Sao Paulo",
        "street": "Rua Fernandes Pinheiro 10",
        "country": "BR",
        "latitude": "234234",
        "longitude": "234234",
        "neighborhood": "A",
        "openingHours": "23:42 - 34:00"
    },
    "email": "[email protected]",
    "metadata": {
        "additionalInformation[0].field": "chave",
        "additionalInformation[0].value": "",
        "additionalInformation[1].field": "valor",
        "additionalInformation[1].value": "chave"
    },
    "controller": {},
    "defaultCurrency": "USD",
    "natures": [
        "CASH_REMITTANCE",
        "SERVICES_AND_OTHERS"
    ],
    "vendorResponsible": {},
    "notificationsEmail": "[email protected]",
    "commercialEmail": "[email protected]",
    "externalAccounts": [],
    "status": "PENDING",
    "payoutsEnabled": true,
    "settings": {},
    "createdAt": "2023-10-30T04:03:08.333Z",
    "updatedAt": "2023-11-14T11:14:21.241Z",
    "financialDate": {
        "bankPath": [
            {
                "bankPath": "SIMPLE PAY"
            }
        ],
        "metaData": [
            {
                "field": "",
                "value": ""
            }
        ],
        "vendorBankDetails": {
            "country": "br",
            "currency": "USD",
            "accountName": "PEDRO"
        }
    },
    "account": {
        "createdAt": "2023-10-30T04:05:09.057Z",
        "updatedAt": "2023-10-30T23:34:26.303Z",
        "deletedAt": null,
        "internalComment": null,
        "id": "acc_01hdzc3gf2efhzvyjppwyzmy61",
        "chargesEnable": true,
        "controller": {
            "controller1": "teste"
        },
        "payoutsEnabled": true,
        "provider": null,
        "providerId": null,
        "accountNumber": null,
        "bankNumber": null,
        "agencyNumber": null,
        "defaultPix": null,
        "externalId": null,
        "status": "WAITING_ACCOUNT_CREATION",
        "userId": "2",
        "externalAccounts": []
    }
}