A API V3 JÁ ESTÁ DISPONÍVEL
As integrações API v2 que já estão configuradas, seguirão funcionando temporariamente. |
Insere uma forma de pagamento
Insere uma forma de pagamento no sistema.
cURL |
curl -X POST "https://bling.com.br/Api/v2/formapagamento/json/" |
PHP |
$url = 'https://bling.com.br/Api/v2/formapagamento/json/'; |
C# |
public static void ExecuteSendPayment() { |
Parâmetro | Descrição | Tipo |
apikey |
apikey gerada no sistema | string |
xml |
xml contendo as informações da forma de pagamento | string |
Para o parâmetro xml
, é necessário seguir um padrão.
Tabela de campos do XML
Grupo | Campo | Informação | Tipo | Padrão | Opcional | Nota |
---|---|---|---|---|---|---|
raiz | formapagamento | Dados da forma de pagamento | Obrigatório | |||
formapagamento | descricao | Descrição da forma de pagamento | String(100) | Obrigatório | ||
formapagamento | codigofiscal | Código fiscal | Decimal(4) | 1 | Opcional | 1 |
formapagamento | condicao | Condição de pagamento | String(45) | Opcional | 2 | |
formapagamento | destino | Destino da parcela | Decimal(1) | 0 | Opcional | 3 |
formapagamento | padrao | Define a forma de pagamento como padrão | Decimal(1) - (0 ou 1) | 0 | Opcional | |
formapagamento | situacao | Define a situação da forma de pagamento | Decimal(1) - (0 ou 1) | 1 | Opcional | |
formapagamento | dadoscartao | Informações do cartão | Opcional | |||
dadoscartao | bandeira | Bandeira do cartão | Decimal(2) | 0 | Opcional | 4 |
dadoscartao | tipointegracao | Tipo da integração | Decimal(4) | 0 | Opcional | 5 |
dadoscartao | cnpjcredenciadora | CNPJ da credenciadora | String(14) | Opcional | ||
dadoscartao | autoliquidacao | Auto liquidação | Decimal(1) - (0 ou 1) | 0 | Opcional | |
formapagamento | dadostaxas | Dados das taxas | Opcional | |||
dadostaxas | valoraliquota | Valor da alíquota | Decimal(11,2) | 0.00 | Opcional | |
dadostaxas | valorfixo | Valor fixo | Decimal(11,2) | 0.00 | Opcional | |
dadostaxas | prazo | Prazo em dias, para o recebimento | Decimal(4) | 0 | Opcional |
Notas:
- Código fiscal, conforme tabela abaixo.
- Especificado em dias ou em vezes. Ex: 30 60 ou 3x.
- Possíveis destinos, conforme tabela abaixo.
- Código da bandeira do cartão, conforme tabela abaixo.
- Tipo da integração, conforme tabela abaixo.
Possíveis códigos fiscais
Código | Mensagem |
---|---|
1 | Dinheiro |
2 | Cheque |
3 | Cartão de Crédito |
4 | Cartão de Débito |
5 | Crédito Loja |
10 | Vale Alimentação |
11 | Vale Refeição |
12 | Vale Presente |
13 | Vale Combustível |
14 | Duplicata Mercantil |
15 | Boleto Bancário |
90 | Sem pagamento |
99 | Outros |
Possíveis destinos
Código | Mensagem |
---|---|
1 | Conta a receber/pagar |
2 | Ficha financeira |
3 | Caixa e bancos |
Possíveis bandeiras dos cartões
Código | Mensagem |
---|---|
1 | Visa |
2 | Mastercard |
3 | American Express |
4 | Sorocred |
5 | Diners Club |
6 | Elo |
7 | Hipercard |
8 | Aura |
9 | Cabal |
99 | Outros |
Possíveis tipos de integração
Código | Mensagem |
---|---|
1 | TEF |
2 | POS |
Mensagens de erros específicos
Código | Mensagem |
---|---|
125 | Forma de pagamento nao encontrada |
126 | Campo descricao nao preenchido |
127 | A forma de pagamento esta vinculada a uma duplicada ou parcela |
128 | Deve haver pelo menos uma forma padrao |
129 | O CNPJ da credenciadora esta invalido |
130 | O valor de aliquota nao pode ser menor que 0 |
131 | O valor de taxa nao pode ser menor que 0 |
132 | O prazo de recebimento nao pode ser menor que 0 |
133 | Forma de pagamento inativa não pode ser forma padrão |