Artigos nessa seção

Como consultar um pedido do Split de Pagamento via API Cielo?

Sabrina Cristina Ribeiro da Silva
  • Atualizado
Seguir

Para consultar pedidos do Split de Pagamento via API (no caso de integração com a API Cielo e-commerce), siga o passo a passo a seguir.

Endpoints

API Ambiente URL
Autenticação Sandbox https://authsandbox.braspag.com.br/oauth2/token
Produção https://auth.braspag.com.br/oauth2/token
Consulta Sandbox https://apiquerysandbox.cieloecommerce.cielo.com.br/1/sales/{paymentID}
Produção https://apiquery.cieloecommerce.cielo.com.br/1/sales/{paymentID}

 

1. Gere o token de acesso

  • Concatene o MerchantId e ClientSecret: MerchantId:ClientSecret;
  • Codifique o resultado da concatenação em Base64;
  • Envie esse resultado no header da requisição ao endpoint de autenticação (sandbox ou produção).
Metodo POST
-- header Authorization : Basic NGE3OTMxYWQtNWEyOC00NTdkLTg3YzItYjU3NTg5YmJmNWFlOmY1OTRjZTA2YTM4ZmdzODRzZmcxNGZkZ2RzMThjZjNmYzc1MmQ0MjY2YjI9ZGtmaA==
-- header Content-Type : application/x-www-form-urlencoded

grant_type=client_credentials

Após enviar a requisição, você receberá um retorno similar a este, com o "access_token":

{
    "access_token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsIng1dCI6Ims5SmpxWlJ1cW1xdHdBQzRwV1hub3RLMmxBayJ9.eyJjbGllbnRfbmFtZSI6IkNMSUVOVERBU0lMVkEiLCJjbGllbnRfaWQiOiI2ZGIwMzRmOC0xNzVjLTQ1NjEtOWM3MC02YzA1NzA4NDk0MjUiLCJzY29wZXMiOlsie1wiU2NvcGVcIjpcIlNwbGl0TWFzdGVyXCIsXCJDbGFpbXNcIjpbXX0iLCJ7XCJTY29wZVwiOlwiQ2llbG9BcGlcIixcIkNsYWltc1wiOltdfSJdLCJyb2xlIjpbIlNwbGl0TWFzdGVyIiwiQ2llbG9BcGkiXSwiaXNzIjoiaHR0cHM6Ly9hdXRoc2FuZGJveC5icmFzcGFnLmNvbS5iciIsImF1ZCI6IlVWUXhjVUEyY1NKMWZrUTNJVUVuT2lJM2RtOXRmbWw1ZWxCNUpVVXVRV2c9IiwiZXhwIjoxNjAwNDY2MDgwLCJuYmYiOjE2MDAzNzk2ODB9.lp0gl94cZVQ2WpQCE_ERIN2S-MpMboa_FxUjgeRnRBl6wOKL8rzRyh8VZLwL6Ic_mCP_1OcHrk593pC__N8Lr-V4xk59bcb8YCCNYJ8-dd1iMR8sXVzj2ZTK4wJAq4tKdD407bjqQgsq_wP1R09799pH5Fu9z_6TYKCQAXKiyr9wPAMLO6hvffg_52M_VAosCjOkiy4jGZBgh458dbcQRbgvcKgMFOa5bDo-XVhcZjINkYsldbZ3sqDFI0q89EKjoTzbSJXQpZsg6993jT0bbyxuDcNdHIxf93lYp-rc3JUzYDSlEsrg8W83hNKEKB1331bhBU6xCAYWRi68ZxtAFA",
    "token_type": "bearer",
    "expires_in": 86399
}

 

2. Consulte a transação

Utilizando o endpoint de consulta (sandbox ou produção), encaminhe no header da requisição o "access_token" gerado na etapa anterior.

No Endpoint, em /{paymentID} deve ser encaminhado o PaymentId da transação que deseja consultar, veja um exemplo:

Metodo GET
endpoint exemplo: https://apiquerysandbox.cieloecommerce.cielo.com.br/1/sales/c4f8d221-cd2b-4e72-8084-f2cf6d407861 
--header "Authorization: Bearer {access_token}"

Você receberá uma resposta similar a essa:

Status Code: 200 Ok

{
    "MerchantId": "f43fca07-48ec-46b5-8b93-ce79b75a8f63",
    "MerchantOrderId": "2014111701",
    "IsSplitted": true,
    "Customer": {
        "Name": "Comprador",
        "Address": {}
    },
    "Payment": {
        "ServiceTaxAmount": 0,
        "Installments": 1,
        "Interest": "ByMerchant",
        "Capture": true,
        "Authenticate": false,
        "CreditCard": {
            "CardNumber": "455187******0181",
            "Holder": "Teste Holder",
            "ExpirationDate": "12/2021",
            "Brand": "Visa"
        },
        "ProofOfSale": "20171210061821319",
        "Tid": "1210061821319",
        "AuthorizationCode": "379918",
        "PaymentId": "507821c5-7067-49ff-928f-a3eb1e256148",
        "Type": "SplittedCreditCard",
        "Amount": 10000,
        "ReceivedDate": "2017-12-10 18:18:18",
        "CapturedAmount": 10000,
        "CapturedDate": "2017-12-10 18:18:21",
        "Currency": "BRL",
        "Country": "BRA",
        "Provider": "Simulado",
        "Status": 2,
        "Links": [
            {
                "Method": "GET",
                "Rel": "self",
                "Href": "https://apiquerysandbox.cieloecommerce.cielo.com.br/1/sales/507821c5-7067-49ff-928f-a3eb1e256148"
            },
            {
                "Method": "PUT",
                "Rel": "void",
                "Href": "https://apisandbox.cieloecommerce.cielo.com.br/1/sales/507821c5-7067-49ff-928f-a3eb1e256148/void"
            },
            {
                "Method": "PUT",
                "Rel": "sales.split",
                "Href": "https://splitsandbox.braspag.com.br/api/transactions507821c5-7067-49ff-928f-a3eb1e256148/split"
            }
        ],
        "SplitPayments": [
            {
                "SubordinateMerchantId": "f2d6eb34-2c6b-4948-8fff-51facdd2a28f",
                "Amount": 6000,
                "Fares": {
                    "Mdr": 5,
                    "Fee": 30
                },
                "Splits": [
                    {
                        "MerchantId": "f2d6eb34-2c6b-4948-8fff-51facdd2a28f",
                        "Amount": 5670
                    },
                    {
                        "MerchantId": "f43fca07-48ec-46b5-8b93-ce79b75a8f63",
                        "Amount": 330
                    }
                ]
            },
            {
                "SubordinateMerchantId": "9140ca78-3955-44a5-bd44-793370afef94",
                "Amount": 4000,
                "Fares": {
                    "Mdr": 4,
                    "Fee": 15
                },
                "Splits": [
                    {
                        "MerchantId": "9140ca78-3955-44a5-bd44-793370afef94",
                        "Amount": 3825
                    },
                    {
                        "MerchantId": "f43fca07-48ec-46b5-8b93-ce79b75a8f63",
                        "Amount": 175
                    }
                ]
            }
        ]
    }
}

Para mais informações acesse nossa documentação.

Artigos relacionados

Comentários

0 comentário

Por favor, entre para comentar.