Deactivation of charges via API

POST 
/paymentlink/:payment_link_id/inactive

Deactivation of charges via API

Request

Path Parameters

payment_link_id stringrequired
Example: 17370315546788ff824bb92

Header Parameters

Authorization stringrequired
Authentication token.
Example: Bearer <token>

Responses

200

Success in deactivating payment link.

application/json

Schema

Schema

message stringrequired

Example (from schema)

{
  "message": "Payment link successfully deactivated."
}

Example

{
  "message": "Link de pagamento Inativado com sucesso."
}

404

Charge not found.

application/json

Schema

Schema

error

object

required

message stringrequired

type stringrequired

code stringrequired

Example (from schema)

{
  "error": {
    "message": "Cobrança não encontrada.",
    "type": "pix",
    "code": "B021"
  }
}

Example

{
  "error": {
    "message": "Cobrança não encontrada.",
    "type": "validation",
    "code": "B021"
  }
}

422

Integration errors with other services or validations.

application/json

Schema

Schema

error

object

required

message stringrequired

type stringrequired

code stringrequired

Example (from schema)

{
  "error": {
    "message": "Erro de validação na integração com o pix pj.",
    "type": "pix",
    "code": "B005"
  }
}

erro_integracao

Erro na integração com o Pix

{
  "error": {
    "message": "Erro de validação na integração com o pix pj.",
    "type": "pix",
    "code": "B005"
  }
}

erro_validacao

Link de pagamento inativado

{
  "error": {
    "message": "Link de pagamento foi inativado anteriormente.",
    "type": "validation",
    "code": "B038"
  }
}

500

Error inactivating payment link.

application/json

Schema

Schema

error

object

required

message stringrequired

type stringrequired

code stringrequired

Example (from schema)

{
  "error": {
    "message": "Erro de comunicação.",
    "type": "pix",
    "code": "C003"
  }
}

Example

{
  "error": {
    "message": "Erro de comunicação.",
    "type": "pix",
    "code": "C003"
  }
}

Loading...