Capture Operation#
Requisição HTTP POST server-to-server usada pelo merchant para capturar pagamentos realizados com cartão de crédito quando o parâmetro auto_capture for false.
Endpoints#
| Endpoints | HTTP Method | Response |
|---|---|---|
https://api.ebanx.com.br/ws/capture https://staging.ebanx.com.br/ws/capture | POST | application/json |
Parâmetros de Requisição#
| Campo | Tipo | Descrição |
|---|---|---|
integration_key Mandatório | String max 100 | Sua chave de integração única e secreta |
hash Condicional | String max 48 | O hash do pagamento (identificador único EBANX). Mandatório se merchant_payment_code não for fornecido. |
merchant_payment_code Condicional | String max 40 | ID do pagamento gerado pelo merchant. Mandatório se hash não for fornecido |
merchant_capture_code Opcional | String max 200 | ID da captura do pagamento gerado pelo merchant. |
amount Opcional | Float | O valor parcial da captura. Apenas uma captura parcial por pagamento autorizado poderá ser realizada. Caso queira habilitar este recurso, entre em contato com nossa Equipe de Integração. |
A requisição retornará um objeto JSON com os seguintes dados do pagamento:
Parametros de Resposta#
| Campo | Tipo | Descrição |
|---|---|---|
status | String | O status da solicitação (SUCCESS ou ERROR). |
payment | JSON | Um objeto JSON com as informações do pagamento. |
payment.hash | String max 48, único | O hash de pagamento (identificador único EBANX). |
payment.bin | String max 41, único | O BIN de pagamento (identificador único do cliente EBANX). |
payment.country | String fixo 2, único | Código do país do pagamento. |
payment.merchant_payment_code | String max 40 | ID do pagamento gerado pelo merchant. |
payment.order_number | String max 40 | O número identificador do pedido definido pelo merchant. Você pode ter vários pagamentos com o mesmo número de pedido. |
payment.status | String fixo 2 | O status do pagamento. Os seguintes status estão disponíveis: OP: o cliente ainda não preencheu os detalhes de pagamento no Checkout EBANX. Poderá ser alterado para CA ou PE.PE: o pagamento está pendente de confirmação. Poderá ser alterado para CA ou CO. CO: o pagamento está confirmado (pago). CA: o pagamento está cancelado. |
payment.status_date | String fixo 19, UTC | A data e hora da última mudança de status. |
payment.open_date | String fixo 19, UTC | A data e hora da criação do pagamento. |
payment.confirm_date | String fixo 19, UTC | A data e hora da confirmação do pagamento. |
payment.transfer_date | String fixo 19, UTC | A data e hora da liquidação do pagamento. |
payment.amount_br | Float | O valor na moeda local. |
payment.amount_iof | Float | O valor do imposto na moeda local. |
payment.amount_ext | Float | O valor na moeda original. |
payment.currency_rate | Float | A taxa de câmbio usada no pagamento. |
payment.currency_ext | String fixo 3, ISO 4217 | Código de três letras da moeda original. |
payment.due_date | String fixo 10, dd/mm/aaaa | Data de expiração do pagamento (aplicável apenas para alguns métodos). |
payment.instalments | Int 1-12 | Quantidade de parcelas do pagamento, o valor padrão é 1. |
payment.payment_type_code | String max 32 | O código do método de pagamento. Os códigos suportados são: - creditcard - debitcard - boleto |
payment.details | JSON | Objeto JSON com os detalhes do pagamento. |
payment.details.billing_descriptor | String | Mensagem que será exibida no descritivo da fatura do cliente. |
payment.transaction_status | JSON | Um objeto JSON com dos dados da transação do pagamento com cartão de crédito. |
payment.transaction_status.acquirer | String max 16 | O adquirente que processou a transação. |
payment.transaction_status.code | String max 7 | O código de status da transação: OK: o valor da transação foi aprovado. NOK: O adquirente não aprovou a transação. O cliente deve entrar em contato com o emissor para verificar se há algum problema com seu cartão de crédito. RETRY: Algo deu errado com o processo. Você pode tentar novamente usando os mesmos dados. Recomendamos que sejam feitas mais 3 tentativas em diferentes momentos (a segunda tentativa 2 horas após a primeira, etc). Você pode ver sobre esses status aqui |
payment.transaction_status.description | String max 500 | A descrição do código de status que é retornado do adquirente. |
payment.transaction_status.authcode | String max 40 | Código de autenticação da transação no adquirente. |
payment.pre_approved | Boolean | Flag que mostra se um pagamento foi pré-aprovado pelo adquirente do cartão de crédito. |
payment.capture_available | Boolean | Flag que mostra se um pagamento está pronto para ser capturado. Aplica-se apenas a cartões de crédito quando auto_capture está definido como false. Algumas observações sobre este atributo: Um pagamento só pode ser capturado se o valor do pre_approved for true, o que significa que o pagamento foi pré-aprovado pelo adquirente do cartão de crédito. Antes da captura, um pagamento autorizado tem o status PE (pendente). Após a captura, o status muda para CO (confirmado).Um pagamento só pode ser capturado se o status for PE (pendente)* Os pagamentos devem ser capturados em 4 (quatro) dias, caso contrário, são cancelados automaticamente. NOTA: Pode ser alterado em até 5 (cinco) dias. |
payment.redirect_url | String variável | A URL para onde o cliente deve ser redirecionado. Aplica-se a alguns métodos de pagamento usando a API Direta. |
payment.boleto_url | String variável | A URL do boleto. |
payment.boleto_barcode | String max 47 | O número do código de barras do boleto. |
payment.refunds | JSON | Um Array contendo objetos que representam um reembolso vinculado a este pagamento. Este objeto só estará presente se for emitido um reembolso. |
payment.refunds.id | Int | O ID do reembolso no EBANX. |
payment.refunds.merchant_refund_code Opcional | String max 20 | ID do reembolso gerado pelo merchant. |
payment.refunds.status | String fixo 2 | O status do reembolso: RE (Solicitado): O reembolso foi solicitado e está aguardando ser processado. Poderá ser cancelado enquanto tiver esse status. PE (Pendente): O reembolso está sendo processado. Não poderá ser cancelado. CO (confirmado): o reembolso foi processado e o dinheiro devolvido ao cliente. CA (cancelado): o reembolso foi cancelado. |
payment.refunds.request_date | String fixo 19, data UTC | A data e hora da solicitação do reembolso. |
payment.refunds.pending_date | String fixo 19, data UTC | A data e hora que os dados do cliente foram recebidos |
payment.refunds.confirm_date | String fixo 19, data UTC | A data e a hora que o dinheiro foi transferido para o cliente. |
payment.refunds.amount_ext | Float | O valor reembolsado na moeda original. |
payment.refunds.description | String max 1500 | Descrição do motivo do reembolso. |
payment.chargeback | JSON | Objeto JSON com as informações do chargeback vinculado ao pagamento. Este objeto só estará presente se um chargeback for emitido. |
payment.chargeback.create_date | String fixo 19, data UTC | A data e hora que o chargeback foi importado para o sistema. |
payment.chargeback.chargeback_date | String fixo 19, data UTC | A data e hora que o chargeback foi criado pelo adquirente em nome do cliente. |
payment.chargeback.description | String max 1500 | Descrição do chargeback. |
payment.chargeback_credit | Boolean | Flag que indica se um estorno de chargeback foi gerado. |