Consultar um recebedor pelo ID

GET /v1/sellers/{id}

Consultar um recebedor pelo ID

cURL

curl --request GET \
  --url https://api.malga.io/v1/sellers/{id} \
  --header 'X-Api-Key: <api-key>' \
  --header 'X-Client-Id: <api-key>'

200

SellerResponseBusiness

{
  "id": "19d05a45-0e92-478e-8366-955231bcf3d6",
  "providers": {
    "providerType": "SANDBOX",
    "externalId": "1966811",
    "externalStatus": "active",
    "externalStatusReason": "ok",
    "status": "pending",
    "createdAt": "2022-12-21T23:10:13.498Z",
    "updatedAt": "2022-12-21T20:10:13.951Z"
  },
  "merchantId": "5616b19e-4d99-4bd3-b415-4990e5cab4f4",
  "clientid": "e234eeb3-483d-4df2-87eb-1e2be5cdaccd",
  "metadata": null,
  "owner": {
    "id": "8231ba21-3758-4bd7-b664-5b5fdeda37a0",
    "updatedAt": "2023-07-11T23:02:51.581Z",
    "createdAt": "2023-07-11T23:02:51.581Z",
    "name": "Seller",
    "email": "[e-mail]",
    "phoneNumber": "85988350264",
    "birthdate": "1995-01-27T02:00:00.000Z",
    "address": {
      "country": "BR",
      "id": "883631f0-fea0-4682-ae1a-f4ac6349e0d9",
      "updatedAt": "2023-07-11T23:02:51.585Z",
      "createdAt": "2023-07-11T23:02:51.585Z",
      "street": "Rua Nova Lua",
      "streetNumber": "30",
      "complement": "casa 4",
      "zipCode": "61000-320",
      "state": "CE",
      "city": "Maracanaú",
      "district": "AB"
    },
    "document": {
      "country": "BR",
      "id": "32543bbe-42c1-4000-9b68-d01a2735708e",
      "updatedAt": "2023-07-11T23:02:51.588Z",
      "createdAt": "2023-07-11T23:02:51.588Z",
      "type": "cpf",
      "number": "36243319067"
    }
  },
  "business": {
    "id": "607bb56a-974a-4d1d-9f56-cda865dfafbd",
    "updatedAt": "2023-07-11T23:02:51.571Z",
    "createdAt": "2023-07-11T23:02:51.571Z",
    "name": "Seller business",
    "corporateReason": "Seller company social reason",
    "phoneNumber": "85988350264",
    "email": "[e-mail]",
    "website": "www.sellerbusiness.com.br",
    "description": "Seller business",
    "facebook": "facebook Seller business",
    "twitter": "twitter Seller business",
    "openingDate": "1995-01-27",
    "address": {
      "country": "BR",
      "id": "b681dd2e-ebdb-4fad-8c8b-e703a17825ce",
      "updatedAt": "2023-07-11T23:02:51.574Z",
      "createdAt": "2023-07-11T23:02:51.574Z",
      "street": "Rua Nova Lua",
      "streetNumber": "30",
      "complement": "sala 100",
      "zipCode": "61000-320",
      "state": "CE",
      "city": "Maracanaú",
      "district": "AB"
    },
    "document": {
      "country": "BR",
      "id": "b9380f2c-a657-4f47-a7da-21f3bf08182c",
      "updatedAt": "2023-07-11T23:02:51.578Z",
      "createdAt": "2023-07-11T23:02:51.578Z",
      "type": "cnpj",
      "number": "94938591000196"
    }
  },
  "bankAccount": {
    "id": "f7ac3221-8f69-4276-b88b-34ddbe5ec24a",
    "updatedAt": "2023-07-11T23:02:51.563Z",
    "createdAt": "2023-07-11T23:02:51.563Z",
    "holderName": "Seller name",
    "holderDocument": "36243319067",
    "bank": "077",
    "ispb": "60746948",
    "branchNumber": "492",
    "branchCheckDigit": "1",
    "accountNumber": "4929",
    "accountCheckDigit": "22",
    "type": "conta_corrente"
  },
  "transferPolicy": {
    "id": "a04bca24-f7d1-4cb5-acce-41f12680e5bf",
    "updatedAt": "2023-07-11T23:02:51.567Z",
    "createdAt": "2023-07-11T23:02:51.567Z",
    "transferDay": "5",
    "transferEnabled": true,
    "transferInterval": "weekly",
    "automaticAnticipationEnabled": false,
    "anticipatableVolumePercentage": "",
    "automaticAnticipationType": "",
    "automaticAnticipationDays": "",
    "automaticAnticipation1025Delay": ""
  },
  "mcc": 4040,
  "status": "active",
  "notifyOnPayout": true
}

Authorizations

X-Client-Id · string · header · required

X-Api-Key · string · header · required

Path Parameters

id · string<uuid> · required

Identificador do seller

Response

200 - application/json

id · string

Identificador do seller

providers · object[]

Show child attributes

merchantId · string

Identificador do merchant

clientId · string

Identificador do cliente

metadata · object

Campos adicionais da transação enviados na criação da mesma

owner · object

Show child attributes

business · object

Show child attributes

bankAccount · object

Show child attributes

transferPolicy · object

Show child attributes

mcc · string

Código de segmento do lojista no adquirente

status · enum<string>

Status do seller

Available options: active, partial, inactive, pending, blocked

notifyOnPayout · boolean

Indica se o recebedor é notificado quando ocorre um repasse.

planId · string<uuid> | null

Identificador do plano de venda vinculado ao recebedor (ver Listar planos de venda). Vem null quando o recebedor não tem vínculo próprio e é liquidado pelo plano padrão do cliente. Campo distinto de salesPlanId.