Criação de cobranças via API.

POST 
/paymentlink/create

Este endpoint permite a criação de uma nova cobrança via API, utilizando o modelo de payment link.

Request

Header Parameters

Authorization stringrequired
Token de autenticação.
Example: Bearer <token>

application/json

Body

required

charge

object

required

name stringnullable

Nome da cobrança.

description stringnullable

Descrição da cobrança.

order_number stringnullable

Possible values: <= 15 characters

Identificador da ordem de pagamento.

redirect_url string

Possible values: <= 1000 characters

URL de redirecionamento.

payment

required

methods string[]required

Meios de pagamentos que conterá na cobrança.

brcode_arrangements string[]

Obrigatório caso o value 'BRCODE' seja passado no campo payment_methods.

amounts

object

Valores da cobrança. A soma não pode ultrapassar 999999999 (R$9.999.999,99)

product integer

Valor do produto da cobrança. Valor apenas em centavos ex R$100 equivale a R$1.0

delivery integer

Valor do frete da cobrança. Valor apenas em centavos ex R$100 equivale a R$1.0

options

object

required

Opções da cobrança.

allow_create_pix_key boolean

Campo utilizado para informar se o requisitante autoriza a criar uma chave pix para o usuário, caso não exista.

card_max_installment_number number

Campo utilizado para informar a quantidade máxima de parcelas para uma cobrança. Esse campo é obrigatório quando o 'payment_methods' contenha value 'CREDIT_CARD'.

expired_at string

Campo utilizado para informar a data de expiração da cobrança.

Responses

201

Cobrança criada.

application/json

Schema

Schema

brcode stringrequired

Qrcode gerado para pagamento.

name stringrequired

Nome da cobrança.

description stringrequired

Descrição da cobrança.

amount integerrequired

Valor da cobrança em centavos.

link stringrequired

Link da cobrança.

deeplink stringrequired

Deep link da cobrança.

pixKey stringrequired

Chave PIX.

txid stringrequired

Código da trnasação txid.

paymentMethods string[]required

Formas de pagamento.

paymentBrcodeArrangements string[]required

Formas de pagamento.

status stringrequired

Status atual da cobrança.

chargeName stringrequired

Nome da cobrança.

expirationDate stringrequired

Data de expiração.

ppMaxInstallmentNumber numberrequired

Número máximo de parcelas.

cardMaxInstallmentNumber numberrequired

Número máximo de parcelas.

maxPaymentQuantity numberrequired

Quantidade máxima de pagamentos aceito.

details

required

productAmount integer

Valor do produto em centavos.

deliveryAmount integer

Valor do frete em centavos.

orderNumber stringnullable

Número do pedido.

redirectURL stringnullable

URL de redirecionamento

Example (from schema)

{
  "brcode": "00020126580014br.gov.bcb.pix0136123e4567-e12b-12d1-a456-4266554400005204000053039865802BR5913Fulano de Tal6008BRASILIA62070503***63041D3D",
  "name": "Banana Fantasia Pag2",
  "description": "Descrição de teste 1",
  "amount": 3500,
  "link": "https://link.picpay.com/p/1688060808649dc38881cdc",
  "deeplink": "https://cobranca.picpay.com/p/1688060808649dc38881cdc",
  "pixKey": "13d7eaf0-222c-4858-9722-75ba8f81443f",
  "txid": "PPJ-P2B-1fg34glo9-0015-F12345678",
  "paymentMethods": [
    "BRCODE",
    "CREDIT_CARD"
  ],
  "paymentBrcodeArrangements": [
    "PICPAY",
    "PIX"
  ],
  "status": "active",
  "chargeName": "BRCODE charge",
  "expirationDate": "2024-03-27T00:00:00.000000Z",
  "ppMaxInstallmentNumber": null,
  "cardMaxInstallmentNumber": null,
  "maxPaymentQuantity": 10,
  "details": {
    "productAmount": 3000,
    "deliveryAmount": 500,
    "orderNumber": "01234abc",
    "redirectURL": "https://translate.google.com.br/?sl=auto&tl=pt&op=translate"
  }
}

Example

{
  "brcode": "00020126730015COM.PICPAY.LINK0150https://...",
  "name": "Pera ME",
  "description": null,
  "amount": 3500,
  "link": "https://link.ppay.me/p/...",
  "deeplink": "https://cobranca.ppay.me/p/...",
  "pixKey": null,
  "txid": null,
  "paymentMethods": [
    "BRCODE"
  ],
  "paymentBrcodeArrangements": [
    "PICPAY"
  ],
  "status": "active",
  "chargeName": "BRCODE and CREDIT_CARD Payment",
  "expirationDate": null,
  "ppMaxInstallmentNumber": null,
  "cardMaxInstallmentNumber": null,
  "maxPaymentQuantity": null,
  "details": {
    "orderNumber": "XPTO-1234",
    "productAmount": 3000,
    "deliveryAmount": 500,
    "redirectURL": null
  }
}

422

Erro de regras de negócio.

application/json

Schema

Schema

errors

required

message stringrequired

type stringrequired

code stringrequired

Example (from schema)

{
  "errors": {
    "message": "Seller conta liquidação não é elegível para pix.",
    "type": "pix",
    "code": "B001"
  }
}

Example

{
  "error": {
    "message": "Seller conta liquidação não é elegível para pix.",
    "type": "pix",
    "code": "B001"
  }
}

503

Erros de integração com outros serviços.

application/json

Schema

Schema

errors

required

message stringrequired

type stringrequired

code stringrequired

Example (from schema)

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

Example

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

Loading...