Portability

Simular o crédito antes da operação usando configurações do convênio.

Cancelamento de uma portabilidade out a partir de um pedido existente

post/portabilities/{portabilityId}/cancel

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

Path parameters

portabilityIdstring required

Identificador da portabilidade

Example:75dc01b7-6b7d-439d-85bb-7ed0038a9b21

Id da portabilidade

Request body

datetimestring date required

Data e hora da requisição

Example request

{
  "datetime": "2023-08-03T00:00:00"
}

Response

Sucesso

portability_idstring

Identificador de excecução da portabilidade

Example response

{
  "portability_id": "b2eaa18b-985e-473f-92bf-8cf9a407aee1"
}

Changes

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