Pagamento – Central de Ajuda iPAGARE

Nome	Tipo	Valores	Comentário/Exemplo
id	string	-	ID único que identifica o pagamento na Southpayments (gerado automaticamente). Ex: 1fDhgrEwqg8912g
order_id	string	-	ID único que identifica a cobrança/pedido deste pagamento na Southpayments (gerado automaticamente). Ex: 987heuiwqg8912g
order_merchant_key	string	255	Código único que identifica a cobrança em seu sistema (enviado no momento da criação do pedido).
payment_type	string	boleto credit_card pix	Meio de pagamento utilizado neste pagamento.
amount	integer	-	Valor total do pagamento, em centavos, somente números, sem pontos nem vírgulas. Ex: 5000 (significa R$50,00)
status	string	authorized boleto_issued paid failure cancelled waiting_pix	Status do pagamento. AUTHORIZED: cartão de crédito autorizado (mas não capturado). BOLETO_ISSUED: boleto emitido com sucesso PAID: pagamento confirmado com sucesso. FAILURE: pagamento não foi efetuado com sucesso CANCELLED: pagamento cancelado / estornado WAITING_PIX: aguardando confirmação da transferência via PIX
created_at	string	-	Data e hora de processamento do pagamento no formato yyyy-mm-dd HH:MM:SS Ex: 2020-10-04 16:43:48
installments	integer	-	Número de parcelas deste pagamento. Para Boleto e PIX, sempre 1.
interest	float	-	Apenas para CREDIT_CARD, informa o juro aplicado ao pagamento, quando houver Ex: 1.99
boleto	Object	-	Apenas para BOLETO, Informações sobre a emissão do boleto (quando emitido com sucesso).
boleto.access_url	string	URL	URL para acesso ao PDF do boleto bancário.
boleto.creation_date	string	-	Data de criação do boleto no formato yyyy-mm-dd. Ex: 2020-11-04
boleto.barcode_line	string	-	Código de barras do boleto.
boleto.due_date	string	-	Data de vencimento do boleto no formato yyyy-mm-dd. Ex: 2020-11-04
credit_card*	object	-	Apenas para CREDIT_CARD, Informações sobre o pagamento por cartão de crédito.
credit_card.tid	string		Identificação da transação na operadora. Ex: 826020330762
credit_card.authorization_code**	string		Código de autorização do pagamento na operadora. Ex: 654734
credit_card.amount	integer	-	Valor processado pela operadora, em centavos, somente números, sem pontos nem vírgulas. Ex: 5000 (significa R$50,00)
credit_card.payment_id	string		Identificador do pagamento na operadora. Ex: 34fwr2-32f4-4324-7c4t-5234g42g45
credit_card.proof_of_sale**	string		Comprovante de venda na operadora.
credit_card.masked_number	string		Número do cartão de crédito mascarado utilizado na transação. Ex: 444433XXXXXX1111
credit_card.captured_amount***	integer		Valor capturado pela operadora, em centavos, somente números, sem pontos nem vírgulas. Ex: 5000 (significa R$50,00)
credit_card.capture_date***	string	yyyy-mm-dd HH:MM:SS	Data e hora de captura do pagamento na operadora, no formato YYYY-mm-dd HH:MM:SS Ex: 2020-11-29 15:15:10
credit_card.cancelled_amount****	integer		Valor cancelado na operadora, em centavos, somente números, sem pontos nem vírgulas. Ex: 5000 (significa R$50,00)
credit_card.cancel_date****	string	yyyy-mm-dd HH:MM:SS	Data e hora de cancelamento na operadora, no formato YYYY-mm-dd HH:MM:SS Ex: 2020-11-29 15:15:10
credit_card.brand	String	Visa Mastercard Elo Amex Diners Hipercard	Bandeira do cartão de crédito utilizada no pagamento
pix	Object	-	Apenas para PIX, informações sobre o PIX
pix.alfacode	string	-	Código Pix que se pode utilizar para efetuar o pagamento.
pix.qr_code_image	string	-	QR Code em PNG no formato Base64
failure	Object		Quando o status do pagamento for FAILURE, objeto com informações sobre a falha.
failure.title	string	-	Título da mensagem de falha.
failure.code	string	-	Código da falha do pagamento.
failure.message	string	-	Detalhamento sobre a falha no pagamento

* Quando há uma falha antes de a tentativa de pagamento ser processada, este objeto não estará presente.

** Não está presente quando houve falha no pagamento.

*** Apenas quando o pagamento está capturado.

**** Apenas quando o pagamento está cancelado.

Artigos relacionados