Consulta dados de conta

Endpoint que permite a verificação dos dados associados a uma conta desejada.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

Corpo de Response

CampoTipoDescrição
accountIdentifierStringidentificador da conta em questão
documentNumberStringNumero de documento do portador da conta
pixKeyStringValor da chave pix
statusStringStatus da conta em si
feesObjectTarifas associadas a conta
└── pixPlanAccountDoubleTaxas dos planos pix
└──└── staticPlanObjectObjeto de taxas associadas ao plano static do pix cash in
└──└──└──typeEnumTipo de modalidade de cobrança de taxa
└──└──└── feeDoubleValor de multa
└──└──└── serviceTaxDoubleTaxa de serviço
└──└──└──minValueDoubleValor minimo de transação
└──└──└──maxValueDoubleValor máximo de transação
└──└── immediateObjectObjeto de taxas associadas ao plano imediato do pix cash in
└──└──└──typeEnumTipo de modalidade de cobrança de taxa
└──└──└── feeDoubleValor de multa
└──└──└── serviceTaxDoubleTaxa de serviço
└──└──└──minValueDoubleValor minimo de transação
└──└──└──maxValueDoubleValor máximo de transação
└──└── dueDateObjectObjeto de taxas associadas ao plano dueDate do pix cash in
└──└──└──typeEnumTipo de modalidade de cobrança de taxa
└──└──└── feeDoubleValor de multa
└──└──└── serviceTaxDoubleTaxa de serviço
└──└──└──minValueDoubleValor minimo de transação
└──└──└──maxValueDoubleValor máximo de transação
└──└── immediateSplitObjectObjeto de taxas associadas ao plano de split imediato do pix cash in
└──└──└──typeEnumTipo de modalidade de cobrança de taxa
└──└──└── feeDoubleValor de multa
└──└──└── serviceTaxDoubleTaxa de serviço
└──└──└──minValueDoubleValor minimo de transação
└──└──└──maxValueDoubleValor máximo de transação
└──└── dueDateSplitObjectObjeto de taxas associadas ao plano split com data de vencimento do pix cash in
└──└──└──typeEnumTipo de modalidade de cobrança de taxa
└──└──└── feeDoubleValor de multa
└──└──└── serviceTaxDoubleTaxa de serviço
└──└──└──minValueDoubleValor minimo de transação
└──└──└──maxValueDoubleValor máximo de transação
└──└── cashoutObjectObjeto de taxas associadas ao plano do pix cash out
└──└──└──typeEnumTipo de modalidade de cobrança de taxa
└──└──└── feeDoubleValor de multa
└──└──└── serviceTaxDoubleTaxa de serviço
└──└──└──minValueDoubleValor minimo de transação
└──└──└──maxValueDoubleValor máximo de transação
└──└── remittanceObjectObjeto de taxas associadas ao plano remittance do pix cash in
└──└──└──typeEnumTipo de modalidade de cobrança de taxa
└──└──└── feeDoubleValor de multa
└──└──└── serviceTaxDoubleTaxa de serviço
└──└──└──minValueDoubleValor minimo de transação
└──└──└──maxValueDoubleValor máximo de transação
└──bankSlipPlanAccountObjectTaxas dos planos de boleto associados a conta
└──└── monetizationPlanObjectObjeto de taxas associadas ao plano monetization do boleto
└──└──└──typeEnumTipo de modalidade de cobrança de taxa
└──└──└── feeDoubleValor de multa
└──└──└── serviceTaxDoubleTaxa de serviço
└──└──└──minValueDoubleValor minimo de transação
└──└──└──maxValueDoubleValor máximo de transação
└──└── monetizationSplitPlanObjectObjeto de taxas associadas ao plano split monetization do boleto
└──└──└──typeEnumTipo de modalidade de cobrança de taxa
└──└──└── feeDoubleValor de multa
└──└──└── serviceTaxDoubleTaxa de serviço
└──└──└──minValueDoubleValor minimo de transação
└──└──└──maxValueDoubleValor máximo de transação
└──hybridBillPlanAccountObjectTaxas dos planos de boleto hibrido
└──└── monetizationObjectObjeto de taxas associadas ao plano monetization do boleto hibrido
└──└──└──typeEnumTipo de modalidade de cobrança de taxa
└──└──└── feeDoubleValor de multa
└──└──└── serviceTaxDoubleTaxa de serviço
└──└──└──minValueDoubleValor minimo de transação
└──└──└──maxValueDoubleValor máximo de transação
└──└── monetizationSplitObjectObjeto de taxas associadas ao plano split monetization do boleto hibrido
└──└──└──typeEnumTipo de modalidade de cobrança de taxa
└──└──└── feeDoubleValor de multa
└──└──└── serviceTaxDoubleTaxa de serviço
└──└──└──minValueDoubleValor minimo de transação
└──└──└──maxValueDoubleValor máximo de transação
└──└── dueDateObjectObjeto de taxas associadas ao plano de data de vencimento do boleto hibrido
└──└──└──typeEnumTipo de modalidade de cobrança de taxa
└──└──└── feeDoubleValor de multa
└──└──└── serviceTaxDoubleTaxa de serviço
└──└──└──minValueDoubleValor minimo de transação
└──└──└──maxValueDoubleValor máximo de transação
└──└── dueDateSplitObjectObjeto de taxas associadas ao plano split com data de vencimento do boleto hibrido
└──└──└──typeEnumTipo de modalidade de cobrança de taxa
└──└──└── feeDoubleValor de multa
└──└──└── serviceTaxDoubleTaxa de serviço
└──└──└──minValueDoubleValor minimo de transação
└──└──└──maxValueDoubleValor máximo de transação
bankAccountObjectDados da conta bancária associada a conta solicitada
└──└── bankStringAgencia bancaria
└──└── branchStringConta da instituição financeira
└──└── operationStringTipo de operação de conta bancaria
└──└── statusStringStatus da conta bancaria
accountErrorsDTOObjectObjeto de erros relacionados a conta solicitada
└──└── identifierStringIdentificador do erro
└──└── fieldStringCampo do erro
└──└── reasonStringRazão do erro
└──└── statusEnumStatus do erro
└──└── suggestionStringSugestão a cerca do erro
└──└── accountIdentifierStringIdentificador da conta

Status possíveis

StatusDescrição
ADJUSTEDErro ajustado
VALIDATINGErro em processo de validação
REJECTEDErro rejeitado

Types possíveis

StatusDescrição
PERCENTAGECobrança por porcentagem
FIXEDCobrança fixa por valor

Json de response

{
  "accountIdentifier": "b35d5e5e-056b-42cf-83fb-491ed5ccc809",
  "documentNumber": "documentNumber_5ed50c0cd879",
  "pixKey": "pixKey_b080bfff71e9",
  "status": "status_bec37b76d363",
  "fees": {
    "pixPlanAccount": {
      "staticPlan": {
        "type": "PERCENTAGE",
        "fee": 0.00,
        "serviceTax": 0.00,
        "minValue": 0.00,
        "maxValue": 0.00
      },
      "immediate": {
        "type": "PERCENTAGE",
        "fee": 0.00,
        "serviceTax": 0.00,
        "minValue": 0.00,
        "maxValue": 0.00
      },
      "dueDate": {
        "type": "PERCENTAGE",
        "fee": 0.00,
        "serviceTax": 0.00,
        "minValue": 0.00,
        "maxValue": 0.00
      },
      "immediateSplit": {
        "type": "PERCENTAGE",
        "fee": 0.00,
        "serviceTax": 0.00,
        "minValue": 0.00,
        "maxValue": 0.00
      },
      "dueDateSplit": {
        "type": "PERCENTAGE",
        "fee": 0.00,
        "serviceTax": 0.00,
        "minValue": 0.00,
        "maxValue": 0.00
      },
      "cashout": {
        "type": "PERCENTAGE",
        "fee": 0.00,
        "serviceTax": 0.00,
        "minValue": 0.00,
        "maxValue": 0.00
      },
      "remittance": {
        "type": "PERCENTAGE",
        "fee": 0.00,
        "serviceTax": 0.00,
        "minValue": 0.00,
        "maxValue": 0.00
      }
    },
    "bankSlipPlanAccount": {
      "monetizationPlan": {
        "type": "PERCENTAGE",
        "fee": 0.00,
        "serviceTax": 0.00,
        "minValue": 0.00,
        "maxValue": 0.00
      },
      "monetizationSplitPlan": {
        "type": "PERCENTAGE",
        "fee": 0.00,
        "serviceTax": 0.00,
        "minValue": 0.00,
        "maxValue": 0.00
      }
    },
    "hybridBillPlanAccount": {
      "monetization": {
        "type": "PERCENTAGE",
        "fee": 0.00,
        "serviceTax": 0.00,
        "minValue": 0.00,
        "maxValue": 0.00
      },
      "monetizationSplit": {
        "type": "PERCENTAGE",
        "fee": 0.00,
        "serviceTax": 0.00,
        "minValue": 0.00,
        "maxValue": 0.00
      },
      "dueDate": {
        "type": "PERCENTAGE",
        "fee": 0.00,
        "serviceTax": 0.00,
        "minValue": 0.00,
        "maxValue": 0.00
      },
      "dueDateSplit": {
        "type": "PERCENTAGE",
        "fee": 0.00,
        "serviceTax": 0.00,
        "minValue": 0.00,
        "maxValue": 0.00
      }
    }
  },
  "bankAccount": {
    "bank": "bank_57ce14f99f59",
    "branch": "branch_6bd6bdaceb16",
    "operation": "operation_4ef81f4f6134",
    "status": "status_dfae63e5d5af"
  },
  "accountErrorsDTO": [
    {
      "identifier": "6d7a3628-a440-4bd7-94e0-e36c98b48282",
      "field": "field_db29d7c02af2",
      "reason": "reason_6c7fbb2d967f",
      "status": "ADJUSTED",
      "suggestion": "suggestion_0e681bbec628",
      "accountIdentifier": "933393ce-0b6c-468a-9999-42b1aa3cac42"
    }
  ]
}
Headers
string

Identificador da conta

Responses

Language
Credentials
OAuth2
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json