Portability

Realizar uma portabilidade out

Criação de um pedido de portabilidade out

post/portabilities

Request

  • Base URL
    https://api.sandbox.empresas.btgpactual.com
  • Auth
    OAuth 2
    Client credentials
    Token URLhttps://id.btgpactual.com/oauth2/token
    Scopesempresas.btgpactual.com/portabilities

Request body

contract_numberstring required

Identificador do contrato a ser portado

registration_identificationstring required

Identificador único para a portabilidade

proposer_ispbstring

ISPB do banco propoente da portabilidade

proposer_tax_idstring

CNPJ do banco propoente da portabilidade

portability_datestring date required

Data e hora da requisição

Example request

{
  "contract_number": "670501191v8822",
  "registration_identification": "670501191v8822",
  "proposer_ispb": "60701190",
  "proposer_tax_id": "670501191v8822",
  "portability_date": "2023-08-03T00:00:00"
}

Response

Sucesso

portability_idstring

Identificador de excecução da portabilidade

Example response

{
  "portability_id": "b2eaa18b-985e-473f-92bf-8cf9a407aee1",
  "trade": {
    "contract_number": "PORT182815182381AB",
    "balance": "5100.12"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.