Referência da API

Criar nova cobrança

post
https://pay-public-api.raims.work/v1/charge

Este endpoint é responsável por criar uma nova cobrança.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string
enum
required
Defaults to PIX

Forma de pagamento
Ex: PIX

Allowed:
string
required
length between 32 and 32

Identificador único do cliente dono da cobrança

Ex: 0e01234567890b01ed0123456fghi1cf0

string
required

Descrição da cobrança (máx. 255 caracteres)

Ex: Venda do carro

float
required
2 to 600000

Valor total da cobrança.

Ex: 58.81
Nota: O valor das parcelas será dividido igualmente. O valor máximo de cada parcela não pode ser superior a R$ 50.000

date | null

Data de vencimento da primeira parcela da cobrança

  • Caso este parâmetro não tenha sido informado, será igual à data atual, mais um dia
Ex: 2034-05-16
number | null
1 to 12
Defaults to 1

Número de parcelas (a quantidade máxima de parcelas para as cobranças é 12)

Ex: 8

string | null
enum
Defaults to percentage

Tipo de taxa a ser cobrada por atraso (tipos: percentage,
fixed)

Ex: percentage

Allowed:
float

Juros mensais (porcentagem)

Ex: 2.5

float

Juros fixos (reais)

Ex: 1.27

float

Multa por atraso (porcentagem)

Ex: 2.5

float

Multa por atraso (reais)

Ex: 1.27

string | null
enum
Defaults to percent

Tipo de desconto (tipos: percent, fixed)

Ex: fixed

Allowed:
float

Valor do desconto (reais)

Ex: 12.25

integer | null

Quantidade de dias com o desconto ativo

Ex: 15

boolean | null

Sinalizador para indicar se a cobrança deve ser enviada
pelo e-mail

Ex: true ou false '

float

Valor do desconto (porcentagem)

Ex: 2.5

Responses

Updated almost 2 years ago

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated almost 2 years ago