v1

latestOpenAPI 3.0.42026-07-24150552428.5 KB

Link de pagamento

Atualizar link de pagamento

API responsável por editar um link de pagamento

put/{companyId}/banking/payment-link/{paymentLinkId}

Path parameters

paymentLinkIdstring required

Identificador do Link de Pagamento

Example:97c8ac0a-89cb-4bbe-842b-d4e79a685c39

companyIdstring required

CNPJ da empresa

Request body

namestring

Nome do link de pagamento

amountnumber

Valor

descriptionstring

Descrição do link de pagamento

paymentMethodsstring[]

Métodos de pagamento permitidos

Example request

{
  "name": "Nome do link de pagamento",
  "amount": 10.23,
  "description": "Descrição do link de pagamento",
  "paymentMethods": [
    "BANKSLIP",
    "IMMEDIATE_QRCODE",
    "CREDIT_CARD"
  ],
  "notifications": {
    "deliveryMediums": [
      "Email",
      "Push"
    ],
    "email": "exemplo@btgpactual.com",
    "phone": "55112312312321"
  },
  "schedule": {
    "startAt": "2024-01-01 12:00:00",
    "endAt": "2024-12-31 17:00:00"
  },
  "payer": {
    "name": "John Due",
    "email": "user@gmail.com",
    "personType": "J",
    "phoneNumber": "123123121231",
    "taxId": "37297902000141",
    "address": {
      "type": "COMERCIAL",
      "zipCode": "00000001",
      "country": "BR",
      "state": "SP",
      "city": "SAO PAULO",
      "street": "RUA SANDBOX",
      "number": "369",
      "neighborhood": "BAIRRO SANDBOX"
    },
    "deliveryMediums": [
      "Email",
      "Push"
    ]
  },
  "details": {
    "limits": {
      "maxInstallments": 3
    }
  }
}

Response

Link de pagamento editado com sucesso.

paymentLinkIdstring

Identificador do Link de Pagamento

namestring

Nome do link de pagamento

amountnumber

Valor

paymentMethodsstring[]

Métodos de pagamento permitidos

status'ACTIVE' | 'INACTIVE' | 'EXPIRED' | 'CANCELED' | 'PAID'

Status do link de pagamento

createdAtstring

Data

updatedAtstring

Data

linkUrlstring

URL do link de pagamento

descriptionstring

Descrição do link de pagamento

type'SINGLE' | 'MULTIPLE'

Tipo do link de pagamento

Example response

{
  "paymentLinkId": "97c8ac0a-89cb-4bbe-842b-d4e79a685c39",
  "name": "Nome do link de pagamento",
  "amount": 10.23,
  "notifications": {
    "deliveryMediums": [
      "Email",
      "Push"
    ],
    "email": "exemplo@btgpactual.com",
    "phone": "55112312312321"
  },
  "paymentMethods": [
    "BANKSLIP",
    "IMMEDIATE_QRCODE",
    "CREDIT_CARD"
  ],
  "status": "ACTIVE",
  "createdAt": "2024-06-18T00:00:00.000Z",
  "updatedAt": "2024-06-18T00:00:00.000Z",
  "schedule": {
    "startAt": "2024-01-01 12:00:00",
    "endAt": "2024-12-31 17:00:00"
  },
  "linkUrl": "link-uat.btgpactual.com/JK9GbsH49HEi69S",
  "description": "Descrição do link de pagamento",
  "payer": {
    "name": "John Due",
    "email": "user@gmail.com",
    "personType": "J",
    "phoneNumber": "123123121231",
    "taxId": "37297902000141",
    "address": {
      "type": "COMERCIAL",
      "zipCode": "00000001",
      "country": "BR",
      "state": "SP",
      "city": "SAO PAULO",
      "street": "RUA SANDBOX",
      "number": "369",
      "neighborhood": "BAIRRO SANDBOX"
    },
    "deliveryMediums": [
      "Email",
      "Push"
    ]
  },
  "payee": {
    "name": "VECHI CONSULTORIA E PROJETOS LTDA",
    "email": "exemplo@btgpactual.com",
    "personType": "J",
    "phoneNumber": "11912345678",
    "taxId": "00000000000125"
  },
  "type": "SINGLE",
  "details": {
    "limits": {
      "maxInstallments": 3
    }
  }
}