Theme switcher

Criar link de cobrança

Header Parameters

Authorizationstring Required

Bearer Token ex: (Bearer + {access_token})

Content-Typestring

header 'Content-Type: application/json

Body Parameters

valuesUsdobject Required

Valor do link

Show child attributes

invoicestring | null

Invoice

descriptionstring | null

Descrição

urlWebHookstring

Link para notificação de atualizações de status da cobrança

referencestring

referencia externa (Id na sua plataforma)

feeIsForTheMerchantboolean

Merchant vai assumir as taxas de processamento?

installmentFeeIsForTheMerchantinteger

Quantidade de parcelas que o merchant assume as taxas

linkTypeinteger | null

Tipo de link BRL|USD

Enum values:
0
BRL (Reais)
1
USD (Dolar)
urlRedirectstring

Url de redirecionamento após pagamento por parte do cliente (cliente será redirecionado para o link informado após pagamento na plataforma BRAZILPAYS)

showAllCoinsboolean

Mostrar valores em BRL e USD

showExchangeboolean

Mostrar cotação do DOLAR

minimumAmountInstallmentsnumber | null

Valor mínimo para permitir parcelamento no cartão de crédito

fixedboolean Required

Pode ser pago varias vezes (Link fixo)

linkDueDatenumber | null

Data de vencimento em Epoch seconds ex: www.epochconverter.com

isRecurrenceboolean Required

Link de recorrente

profileobject

Dados do cliente vinculado a recorrência (Obrigatório caso isRecurrence= true)

Show child attributes

firstOccurrencenumber | null

Data da primeira ocorrência em epoch seconds (obrigatório caso isRecurrence = true) (Obrigatório caso isRecurrence= true) ex: www.epochconverter.com

frequencynumber

Intervalo de dias que a recorrência deve ocorrer em dias valores validos (7 , 15 e 30) dias - a próxima cobrança dessa recorrências só é gerada após o pagamento da última pendente (Obrigatório caso isRecurrence= true)

Default value
0
Enum values:
7
7 dias
15
15 dias
30
30 dias
qtdRecurrencenumber

Quantidade de cobranças a se geradas valor mínimo 1 a 12 (Obrigatório caso isRecurrence= true)

Minimum
1
Maximum
12
Exclusive minimum
True
Exclusive maximum
True
Default value
0

Response

200
Object

Success

Response Attributes

dataobject | null

Dados do link de cobrança criado

Show child attributes

erroboolean

An error returned in the API response.

errorsstring | null

Errors returned in the API response.

messagestring | null

A message returned in the API response.

messageExstring | null

An extended message returned in the API response.

400
Object

Bad Request

Response Attributes

dataobject
erroboolean
errorsobject
messagestring
messageExstring
401
Object

Unauthorized

Response Attributes

datastring
erroboolean
errorsstring
messagestring
messageExstring
500
Object

Server Error

Response Attributes

dataobject
erroboolean
errorsobject
messagestring
messageExstring
Was this section helpful?

POST

/

Select
1

Response

Was this section helpful?