Visão Geral
Tokens
Charges
Sessions
Customers
Merchants
Vendors
Sellers
Webhooks
Reports
Consultar um recebedor pelo ID
Identificador do seller
{
"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": "seller@email.com",
"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",
"phoneNumber": "85988350264",
"email": "seller@email.com",
"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",
"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"
}Path Parameters
Identificador do seller
Response
Identificação do merchant
Nome do recebedor
E-mail do recebedor
Telefone de contato do recebedor
Data de nascimento do recebedor em ISO-Date, ex 1996-01-31
Tipo de documento, consultar tabela de tipos suportados
Número do documento formato conforme tipo selecionado
Pais de emissão do documento, Padrão ISO 3166-1 alpha-2, consultar tabela de tipos suportados
AL, AD, AR, AT, AU, BA, BZ, BE, BG, BR, BY, CA, CU, CY, CZ, CH, CL, CN, CO, CR, DE, DK, DO, EC, EE, SV, GT, FI, FR, GB, GR, HR, HK, HU, IS, ID, IE, IN, IL, IT, LI, LT, LU, LV, MK, MC, MD, MT, MU, JP, KR, MX, ME, MY, NL, NZ, NO, PY, PE, PK, PL, PT, RU, RO, SM, RS, SE, SG, TH, TW, TR, SI, SK, ES, UY, UA, US, VE, VN, ZA Nome da rua/avenida/travessa
Número onde se localiza o endereço
Codigo postal CEP
Pais onde se localiza o endereço - Padrão ISO 3166-1 alpha-2
AL, AD, AR, AT, AU, BA, BZ, BE, BG, BR, BY, CA, CU, CY, CZ, CH, CL, CN, CO, CR, DE, DK, DO, EC, EE, SV, GT, FI, FR, GB, GR, HR, HK, HU, IS, ID, IE, IN, IL, IT, LI, LT, LU, LV, MK, MC, MD, MT, MU, JP, KR, MX, ME, MY, NL, NZ, NO, PY, PE, PK, PL, PT, RU, RO, SM, RS, SE, SG, TH, TW, TR, SI, SK, ES, UY, UA, US, VE, VN, ZA Estado onde se localiza o endereço
Cidade onde se localiza o endereço
Bairro onde se localiza o endereço
Complemento onde se localiza o endereço, caso exista
Ponto de referência do endereço
Receita mensal do recebedor
Ocupação profissional do recebedor
Indica se recebedor é representante legal do negócio
Nome do estabelecimento do recebedor
Telefone de contato do estabelecimento do recebedor
E-mail do estabelecimento do recebedor
Descrição do estabelecimento do recebedor
Data de abertura do estabelecimento do recebedor em ISO-Date, ex 2017-01-31
Nome da rua/avenida/travessa
Número onde se localiza o endereço
Codigo postal CEP
Pais onde se localiza o endereço - Padrão ISO 3166-1 alpha-2
AL, AD, AR, AT, AU, BA, BZ, BE, BG, BR, BY, CA, CU, CY, CZ, CH, CL, CN, CO, CR, DE, DK, DO, EC, EE, SV, GT, FI, FR, GB, GR, HR, HK, HU, IS, ID, IE, IN, IL, IT, LI, LT, LU, LV, MK, MC, MD, MT, MU, JP, KR, MX, ME, MY, NL, NZ, NO, PY, PE, PK, PL, PT, RU, RO, SM, RS, SE, SG, TH, TW, TR, SI, SK, ES, UY, UA, US, VE, VN, ZA Estado onde se localiza o endereço
Cidade onde se localiza o endereço
Bairro onde se localiza o endereço
Complemento onde se localiza o endereço, caso exista
Ponto de referência do endereço
Tipo de documento, consultar tabela de tipos suportados
Número do documento formato conforme tipo selecionado
Pais de emissão do documento, Padrão ISO 3166-1 alpha-2, consultar tabela de tipos suportados
AL, AD, AR, AT, AU, BA, BZ, BE, BG, BR, BY, CA, CU, CY, CZ, CH, CL, CN, CO, CR, DE, DK, DO, EC, EE, SV, GT, FI, FR, GB, GR, HR, HK, HU, IS, ID, IE, IN, IL, IT, LI, LT, LU, LV, MK, MC, MD, MT, MU, JP, KR, MX, ME, MY, NL, NZ, NO, PY, PE, PK, PL, PT, RU, RO, SM, RS, SE, SG, TH, TW, TR, SI, SK, ES, UY, UA, US, VE, VN, ZA Site do estabelecimento do recebedor
Facebook do estabelecimento do recebedor
Twitter do estabelecimento do recebedor
Receita anual do negócio
Código de segmento do lojista no adquirente
Nome de identificador do portador da conta bancária
Documento do portador da conta bancária
Código do banco
Número da agência bancária
Número da conta bancária
Tipo de conta
conta_corrente, conta_poupanca, conta_corrente_conjunta, conta_poupanca_conjunta identifica se é pessoa física ou jurídica. aceita os valores 'individual' ou 'company'
individual, company Código verificador da agência bancária
Número verificador da conta bancária
Dia em que o parceiro será pago. Depende do transfer_interval - se for daily, enviar 1. Se for weekly pode ser de 1 (segunda) a 5 (sexta). Se for monthly, pode ser de 1 a 31. Além disso, se for daily e o provedor for Pagarme, o valor é 0.
Determina se as transferências estão autorizadas a acontecer ou não.
Intervalo entre as transferências.
daily, weekly, monthly Indica se o recebedor receberá antecipações automaticamente
Indica a porcentagem do volume passível de ser antecipado para o recebedor
Indica o tipo de antecipação automática que será configurado para a conta do recebedor
Indica a quantidade de dias de antecipação automática
Indica a quantidade de dias que serão desconsiderados na contabilização do valor passível de ser antecipado. A contagem de dias é realizada a partir do dia da antecipação para trás
Was this page helpful?
{
"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": "seller@email.com",
"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",
"phoneNumber": "85988350264",
"email": "seller@email.com",
"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",
"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"
}