Cobrança (ou Pedido)

Nome	Tipo	Valores	Comentário/Exemplo
id	string	-	ID único que identifica a cobrança na Southpayments (gerado automaticamente). Ex: 987heuiwqg8912g
amount	integer	-	Valor total da cobrança, em centavos, somente números, sem pontos nem vírgulas. Ex: 5000 (significa R$50,00)
checkout_url	URL	-	URL da página de pagamento.
status	string	open pending paid expired cancelled	Status da cobrança. OPEN: não houve pagamento, ou um pagamento foi cancelado. PENDING: boleto emitido ou cartão autorizado (não capturado). PAID: cobrança paga. EXPIRED: cobrança expirada por falta de pagamento, ainda poderá ser paga. CANCELLED: cobrança cancelada, não pode mais ser paga.
merchant_key	string	-	Código único que identifica a cobrança em seu sistema (enviado no momento da criação do pedido).
description	string	-	Descrição da cobrança.
sandbox	boolean	true/false	Indica se é uma cobrança de teste ou não.
created_at	string	-	String indicando data e hora de criação da cobrança no formato YYYY-mm-dd HH:MM:SS Ex: 2020-10-20 18:54:30
notify_url	string	URL	URL de seu sistema notificada sempre que o status do pedido for alterado. Será enviado um JSON com um Objeto Cobrança.
payment_failure_url	string	URL	URL de seu sistema notificada quando houver uma tentativa de pagamento com falha. Será enviado um JSON com um Objeto Pagamento.
updated_at	string	-	String indicando data e hora da última atualização da cobrança no formato YYYY-mm-dd HH:MM:SS Ex: 2020-10-20 18:54:30
customer	object	-	Dados do cliente, atributos descritos abaixo.
customer.customer_type	integer	0 / 1	0 - Pessoa Física 1 - Pessoa Jurídica
customer.merchant_key	string	-	Código identificador de seu cliente
customer.name	string	-	Nome do cliente
customer.email	string	-	E-mail do cliente.
customer.phone_country_code	string	-	Código de área do telefone do cliente. Ex: 55
customer.phone_number	string	-	Telefone do cliente com DDD. Apenas números. Ex: 11987654321
customer.legal_number	string	-	CPF (pessoa física) ou CNPJ (pessoa jurídica). Apenas números. Ex: 33333333333
customer.billing_zipcode	string	-	Código postal do endereço do cliente. Ex: 01234567
customer.billing_street	string	-	Logradouro do cliente. Ex: Rua da Luz
customer.billing_number	string	-	Número do endereço. Ex: 1234
customer.billing_additional	string	-	Complemento do endereço (apto, casa, etc). Ex: Casa 3
customer.billing_district	string	-	Bairro do endereço. Ex: Centro
customer.billing_city	string	-	Cidade do endereço. Ex: São Paulo
customer.billing_state	string	-	UF do endereço. Ex: SP
payments	Array	-	Array de objetos com informações do histórico de pagamentos, iniciando com o pagamento mais recente até o mais antigo.
payments.payment_id	string	-	ID único que identifica o pagamento na Southpayments (gerado automaticamente). Ex: 9342fdiwqg8912g
payments.payment_type	string	boleto credit_card pix	Meio de pagamento utilizado neste pagamento.
payments.amount	integer	-	Valor total do pagamento, em centavos, somente números, sem pontos nem vírgulas. Ex: 5000 (significa R$50,00)
payments.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
payments.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
payments.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
payments.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
payments.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
payments.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