Documentação - API Bitcoin com PagSim

Aceite Bitcoin em seu site, ecommerce ou aplicativo mobile de um jeito fácil e seguro!

Seja bem-vindo a documentação do PagSim! Aqui você encontrará guias sobre como usar nossa infraestrutura de pagamentos.

A comunicação é por meio de solicitações POST. Todas as respostas são em JSON.

API em versão BETA.

Receber pagamento

Enviar solicitação POST

Url
https://pagsim.com.br/api/basic_brl

Parâmetros:
api_key
[obrigatório] api_key informada em seu cadastro

valorbrl
[obrigatório] valor do pedido em reais. Formato: 1234.00

vencimento
[obrigatório] data limite para efetuar o pagamento. Formato: dd/mm/aaaa

descricao
[obrigatório] descrição do pagamento. Máximo 75 caracteres

identificador
[obrigatório] exemplo: número da fatura ou pedido. Máximo 75 caracteres. Valor único por transação

url_retornar
[opcional] url para redirecionar o cliente após o pagamento. Máximo 255 caracteres

postback_url
[opcional] url para receber informações POST quando a transação tiver o status alterado. Máximo 255 caracteres

Resposta JSON

Exemplo - Sucesso

{
   "status":"1",
   "urlpagamento":"http://www.pagsim.com.br/invoice/..."
}
Redirecione o cliente para a url "urlpagamento".
Com este método é necessário salvar o "urlpagamento" em seu sistema, pois não será possível processar a mesma transação mais de uma vez.

Exemplo - Erro

{
   "status":"0",
   "mensagem":"Mensagem de erro"
}

Enviar solicitação POST

Url
https://pagsim.com.br/api/basic_btc

Parâmetros:
api_key
[obrigatório] api_key informada em seu cadastro

valorbtc
[obrigatório] valor do pedido em bitcoin. Formato: 0.12345678

vencimento
[obrigatório] data limite para efetuar o pagamento. Formato: dd/mm/aaaa

descricao
[obrigatório] descrição do pagamento. Máximo 75 caracteres

identificador
[obrigatório] exemplo: número da fatura ou pedido. Máximo 75 caracteres. Valor único por transação

url_retornar
[opcional] url para redirecionar o cliente após o pagamento. Máximo 255 caracteres

postback_url
[opcional] url para receber informações POST quando a transação tiver o status alterado. Máximo 255 caracteres

Resposta JSON

Exemplo - Sucesso

{
   "status":"1",
   "urlpagamento":"http://www.pagsim.com.br/invoice/..."
}
Redirecione o cliente para a url "urlpagamento".
Com este método é necessário salvar o "urlpagamento" em seu sistema, pois não será possível processar a mesma transação mais de uma vez.

Exemplo - Erro

{
   "status":"0",
   "mensagem":"Mensagem de erro"
}

Enviar solicitação POST

Url
https://pagsim.com.br/api/advanced_brl

Parâmetros:
api_key
[obrigatório] api_key informada em seu cadastro

valorbrl
[obrigatório] valor do pedido em reais. Formato: 1234.00

descricao
[obrigatório] descrição do pagamento. Máximo 75 caracteres

identificador
[obrigatório] exemplo: número da fatura ou pedido. Máximo 75 caracteres. Valor único por transação

postback_url
[opcional] url para receber informações POST quando a transação tiver o status alterado. Máximo 255 caracteres

Resposta JSON

Exemplo - Sucesso

{
   "status":"1",
   "endereco_bitcoin":"3M9oQTp...",
   "valorbtc":"0.12345678",
   "tempo":"300"
}
Mostre o "endereco_bitcoin" e "valorbtc" para o cliente somente por "tempo" segundos.
Importante:
O "tempo" informa o tempo em segundos que o endereço bitcoin e o valor pode ficar disponível para o cliente enviar o pagamento. Após este tempo, oculte as informações. Para renovar o tempo, envie novamente as mesmas informações da transação (este método permite), como se fosse uma nova transação. O retorno JSON será o mesmo, apenas com um novo tempo limite e valor atualizado.
Cuidado! Siga a dica acima corretamente
Se o pagamento for enviado após o tempo permitido, você não estará recebendo o pagamento.

Exemplo - Erro

{
   "status":"0",
   "mensagem":"Mensagem de erro"
}

Enviar solicitação POST

Url
https://pagsim.com.br/api/advanced_btc

Parâmetros:
api_key
[obrigatório] api_key informada em seu cadastro

valorbtc
[obrigatório] valor do pedido em reais. Formato: 0.12345678

descricao
[obrigatório] descrição do pagamento. Máximo 75 caracteres

identificador
[obrigatório] exemplo: número da fatura ou pedido. Máximo 75 caracteres. Valor único por transação

postback_url
[opcional] url para receber informações POST quando a transação tiver o status alterado. Máximo 255 caracteres

Resposta JSON

Exemplo - Sucesso

{
   "status":"1",
   "endereco_bitcoin":"3M9oQTp...",
   "valorbtc":"0.12345678"
}
Mostre o "endereco_bitcoin" e "valorbtc" para o cliente.
Com este método é necessário salvar o "endereco_bitcoin" e "valorbtc" em seu sistema, pois não será possível processar a mesma transação mais de uma vez.

Exemplo - Erro

{
   "status":"0",
   "mensagem":"Mensagem de erro"
}

Enviar solicitação POST

Url
https://pagsim.com.br/api/check

Parâmetros:
api_key
[obrigatório] api_key informada em seu cadastro

identificador
[obrigatório] identificador informado na transação. Máximo 75 caracteres.

Resposta JSON

Exemplo - Sucesso

{
   "status":"1",
   "transacao_status":"0"
}

Possíveis retornos para "transacao_status"

0
Aguardando pagamento

2
Pendente (recebido e aguardando confirmações da rede Bitcoin. Não enviar o produto!)

1
Concluído (o produto pode ser enviado)

3
Cancelado

4
Bloqueado

Exemplo - Erro

{
   "status":"0",
   "mensagem":"Mensagem de erro"
}

Ao criar uma transação informando o parâmetro "postback_url", todas as vezes que a transação tiver o status atualizado, nosso sistema estará enviando os seguintes dados via POST para a url informado.

Parâmetros:
api_key
api_key do seu cadastro

identificador
identificador informado na transação.

novostatus
novo status da transação

Possíveis informações que seu sistema pode receber no parâmetro "novostatus"
2
Pendente (recebido e aguardando confirmações da rede Bitcoin. Não enviar o produto!)

1
Concluído (o produto pode ser enviado)

3
Cancelado

4
Bloqueado

Enviar pagamento