Sign in

v1

latestOpenAPI 3.0.32026-07-24113102327.9 KB
charges

Retorna uma cobrança específica através do ID.

Cobranças representam o valor cobrado do cliente, o método de pagamento utilizado e o número de tentativas restantes.

Impressão de boleto

Utilize o atributo print_url para visualizar a url do boleto bancário.

É possível definir a data de visualização do boleto informando o parâmetro seen_at via query string, seguindo o formato ISO 8601. Por exemplo seen_at=2017-06-30. Esta opção permite antecipar a impressão de uma cobrança usando uma data no futuro, pré-calculando a multa e os juros caso seja necessário.

get/v1/charges/{id}

Path parameters

idinteger required

ID da cobrança que deverá ser retornada.

Response

Ok. Cobrança encontrada.

idinteger required

ID da cobrança

amountnumber required

Valor da cobrança

status'pending' | 'paid' | 'canceled' | 'processing' | 'fraud_review' required

Status da cobrança

due_atstring required

Data do vencimento da cobrança

paid_atstring

Data do pagamento da cobrança, apenas se a cobrança já foi paga

installmentsinteger required

Número de parcelas da cobrança. Valores acima de 1 são usados apenas para parcelamento através da administradora do cartão de crédito

attempt_countinteger

Número de tentativas automáticas de cobrança já realizadas

next_attemptinteger

Data da próxima tentativa automática de cobrança

print_urlstring

URL para impressão da cobrança. Usado apenas para boletos

created_atstring required

Data e hora da geração da cobrança

updated_atstring required

Data e hora da última atualização da cobrança