Serviço responsável por realizar a solicitação da antecipação dos recebíveis.

https://api.digpay.com.br/AdvancePayment/Require

Exemplos de código

Confira nos exemplos abaixo como esse serviço deve ser consumido em sua aplicação.

string url = "https://api.digpay.com.br/AdvancePayment/Require"

var httpWebRequest = (HttpWebRequest)WebRequest.Create(url);
httpWebRequest.ContentType = "application/json";
httpWebRequest.Method = "GET";
httpWebRequest.Headers.Add("X-API-KEY", "[INFORME_SEU_TOKEN]");

var httpResponse = (HttpWebResponse)httpWebRequest.GetResponse();

using (var streamReader = new StreamReader(httpResponse.GetResponseStream()))
{
    Console.Write(streamReader.ReadToEnd());
}
var request = require("request");

var options = { method: 'GET',
  url: 'https://api.digpay.com.br/AdvancePayment/Require',
  headers: { 'X-API-KEY': '[INFORME_SEU_TOKEN]'}
 };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.digpay.com.br/AdvancePayment/Require")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
http.verify_mode = OpenSSL::SSL::VERIFY_NONE

request = Net::HTTP::Get.new(url)
request["X-API-KEY"] = '[INFORME_SEU_TOKEN]'

response = http.request(request)
puts response.read_body
var data = null;

var xhr = new XMLHttpRequest();

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://api.digpay.com.br/AdvancePayment/Require"); 
xhr.setRequestHeader("x-api-key", "[INFORME_SEU_TOKEN]");

xhr.send(data);
import requests

url = "https://api.digpay.com.br/AdvancePayment/Require"

headers = {
    'X-API-KEY': "[INFORME_SEU_TOKEN]"
    }

response = requests.request("GET", url, headers=headers)

print(response.text)
String url = "https://api.digpay.com.br/AdvancePayment/Require";

URL obj = new URL(url);
HttpURLConnection con = (HttpURLConnection) obj.openConnection();

con.setRequestMethod("GET");
con.setRequestProperty("X-API-KEY", "[INFORME_SEU_TOKEN]");

int responseCode = con.getResponseCode();
var request = URLRequest(url: 'https://api.digpay.com.br/AdvancePayment/Require')
request.setValue("[INFORME_SEU_TOKEN]", forHTTPHeaderField: "X-API-KEY")

URLSession.shared.dataTask(with: request) { data, response, error in }
$opts = array(
  'http'=>array(
    'method'=>"GET",
    'header'=>"X-API-KEY: [INFORME_SEU_TOKEN]"
  )
);

$context = stream_context_create($opts);

$result = file_get_contents('https://api.digpay.com.br/AdvancePayment/Require', false, $context);

if ($result === FALSE) { /* Handle error */ }

var_dump($result);
package main

import (
    "fmt"
    "net/http"
    "io/ioutil"
)

func main() {

    url := "https://api.digpay.com.br/AdvancePayment/Require"

    req, _ := http.NewRequest("GET", url, nil)

    req.Header.Add("X-API-KEY", "INFORME_SEU_TOKEN")

    res, _ := http.DefaultClient.Do(req)

    defer res.Body.Close()
    body, _ := ioutil.ReadAll(res.Body)

    fmt.Println(res)
    fmt.Println(string(body))

}
curl --request GET 
  --url 'https://api.digpay.com.br/AdvancePayment/Require' 
  --header 'X-API-KEY: [INFORME_SEU_TOKEN]' 

Estrutura do conteúdo de resposta

Confira nos exemplos abaixo a estrutura do conteúdo de resposta desse serviço.

AtributoTipoDescrição
HasErrorBooleanIndica se ocorreu erro
ResponseDetail ObjectContém o objeto de retorno da transação
MessageStringMensagem de retorno
Items ArrayContém o objeto de retorno da transação
Items[i].IdIntId da transação
Items[i].DescriptionStringDescrição da transação
Items[i].InstallmentQuantityStringNúmero da parcela

Conteúdo de resposta

Confira nos exemplos abaixo o conteúdo de resposta desse serviço.

{
    "ResponseDetail": {
        "Message": "Antecipação efetuada com sucesso.",
        "Items": [
            {
                "Id": 1052491,
                "Description": "Cliente de Teste (27086283000192)",
                "InstallmentQuantity": 2
            },
            {
                "Id": 1052494,
                "Description": "Cliente de Teste (80776671000188)",
                "InstallmentQuantity": 1
            },
            {
                "Id": 1052925,
                "Description": "Cliente de Teste (93717563000186)",
                "InstallmentQuantity": 1
            },
            {
                "Id": 1052926,
                "Description": "Cliente de Teste (78778586000107)",
                "InstallmentQuantity": 1
            },
            {
                "Id": 1052929,
                "Description": "Cliente de Teste (83966603000170)",
                "InstallmentQuantity": 1
            }
        ]
    },
    "HasError": false
}

Em caso de erro:

{
    "HasError": true,
    "ErrorCode": "243",
    "Error": "Você não possui valor disponível para antecipação."
}