Apresentação

Bem vindo a documentação para desenvolvedores IM Pay.

Entregamos uma estrutura robusta e completa para que você consiga utilizar ferramentas de pagamento integradas ao seu negócio/software.

Esta documentação tem como principal objetivo apresentar as funcionalidades e principais casos de uso.

Para a utilização de nossos recursos é necessário que você tenha uma conta conosco.

Em caso de suporte ou dúvida entre em contato com nossa equipe na seção Fale com a gente!.

Estrutura

Esta API é do tipo RESTful, utilizando uma URL HTTP e os verbos correspondentes para cada operação (GET, POST, PUT e DELETE).

O formato de dados padrão na solicitação e resposta é do tipo JSON.

A resposta a uma requisição sempre terá o atributo status. O valor 200 indica que a solicitação teve sucesso.

Exemplo de uma resposta com:

{
  "status": 200,
  "message": null,
  "data": {
    (...)
  }
}

Sandbox e Produção

Durante a fase de desenvolvimento, utilize o ambiente sandbox, através da URL base https://api.sandbox.impay.com.br/v1

Quando sua aplicação estiver finalizada, utilize a URL base de produção: https://api.impay.com.br/v1

Autenticação via API Key

Utilizando seu API key numa solicitação:

curl -X GET "https://api.impay.com.br/v1/sellers/{seller_id}/transactions" \
  --header "Accept: application/json" \
  --header "X-Api-Key: {api_key}"

Sua chave de API é obtida através de nosso suporte. Esta chave é uma credencial que dá acesso à sua conta IM Pay de forma programática.

A chave de API é enviada no header HTTP X-Api-Key conforme segue:

X-Api-Key: {seu-api-key}

Busca e Paginação

200 OK - Múltiplos itens

{
  "status": 200,
  "message": null,
  "data": [
    {
      "id": "1",
      "name": "name 1"
    },
    {
      "id": "2",
      "name": "name 2"
    }
  ],
  "count": 2, // Quantidade retornada
  "total_count": 10 // Quantidade total de registros
}

Algumas chamadas retornam dados na forma de listas. Os atributos abaixo permitem a busca e paginação de dados.

Quando os dados retornados estiverem na forma de lista,

• O atributo data conterá um array com registros do tipo solicitado;
• O atributo count traz a quantidade de registros na página atual;
• O atributo total_count, a quantidade total de registros disponíveis.

Parâmetros de URL para busca e paginação

Parâmetro	Descrição
offset	Posição inicial (page * limit)
limit	Quantidade de itens a serem retornados (page). Máximo: 500. Padrão: 100
sort	Attributo para ordenação dos resultados. Ex.: sort=name, sort=-date

Erros

Para o correto funcionamento de sua integração, é importante considerar a possibilidade da solicitação não ser bem sucedida e retornar erros. Por exemplo, poderia haver um erro de validação em um atributo. A mensagem de erro precisaria ser exibida ao usuário, para que ele pudesse corrigir o problema.

Quando a requisição não for bem sucedida, uma reposta JSON será retornada, da seguinte forma:

{
  "status": 400,
  "message": "A validation error was found...",
  "data": null,
  "error": {
    "atributo1": [
      "Mensagem de erro para o atributo1."
    ]
  }
}

A estrutura "validation" poderá conter múltiplas mensagens de erro para cada atributo enviado.

Os códigos de erro são retornados no atributo status.

Código	Descrição
400 Bad Request	A requisição foi invalida ou não atingiu o servidor
401 Unauthorized	As credenciais de autenticação estavam faltando ou foram incorretas
403 Forbidden	A requisição foi ok, mas foi recusado ou o acesso não foi permitido
404 Not Found	A URI solicitada é inválida ou o recurso solicitado não existe
500 Internal Server Error	Algum problema interno IM Pay

Cartões de Teste

Para simular transações em ambiente de teste (sandbox) é disponibilizado os seguintes cartões de crédito.

Número	Descrição
4716588836362104	Transação autorizada - Visa
5577270004286630	Transação autorizada - MasterCard
4710426743216178	Transação negada - Visa

Status de uma Transação

Toda transação tem um status, com o status é possível conhecer o estado atual de uma transação.

Código	Descrição
New	Nova
Pending	Pagamento pendente
Succeeded	Pagamento recebido
Canceled	Cancelada
Failed	Falhou
PreAuthorized	Cobrança pré-autorizada (sem captura de fundos)
Reversed	Revertida por falha da comunicação
Refunded	Estornada
PartiallyRefunded	Estarnada parcialmente
Disputed	Processo de disputa aberto
ChargedBack	Processo de disputa finalizado e charge back efetuado

Transações

Criar Transação de Cartão

curl -X POST "https://api.impay.com.br/v1/sellers/{seller_id}/transactions" \
  --header "Content-Type: application/json" \
  --header "X-Api-Key: {api_key}" \
  --data '{
    "amount": 2599,
    "statement_descriptor": "Minha Loja 1",
    "is_capture_enabled": true,
    "reference_id": "111",
    "metadata": {
      "key1": "value1",
      "key2": "value2"
    },
    "payment": {
      "method": "CreditCard",
      "credit_card": {
        "number": "4539003370725497",
        "holder_name": "John Smith",
        "expiration_month": "01",
        "expiration_year": "12",
        "security_code": "000",
        "installments": {
          "count": 6
        },
        "three_d_secure": {
          "device": {
            "screen_height": 788,
            "screen_width": 481,
            "language": "pt-BR",
            "color_depth": 30,
            "time_zone_offset": 3
          },
          "billing": {
            "postal_code": "99999-999",
            "address": "Rua das Rosas",
            "city": "Piracicaba",
            "state": "SP",
            "phone_number": "(48) 90000-0000",
            "email": "john@mail.com"
          }
        }
      }
    }
  }'

200 OK

{
  "status": 200,
  "message": null,
  "data": {
    "id": "f9e49d821ad7471ba1ab82916aeb084f",
    "status": "Succeeded",
    "amount": 25.99,
    "original_amount": 25.99,
    "currency": "BRL",
    "sales_receipt": "f4d79413b22c4aad80d8b0594debeefa",
    "customer_id": null,
    "statement_descriptor": "MINHA LOJA 1",
    "reference_id": "111 611bf67a77ef4",
    "expected_on": "2021-09-16 00:00:00",
    "created_at": "2021-08-17 14:48:44",
    "updated_at": "2021-08-17 14:48:44",
    "payment": {
      "method": "CreditCard",
      "fees_amount": 1.04,
      "credit_card": {
        "brand": "Visa",
        "first_4_digits": "4539",
        "last_4_digits": "5497",
        "expiration_month": "1",
        "expiration_year": "12",
        "holder_name": "John Smith",
        "customer_id": null,
        "address": null,
        "is_valid": true,
        "is_verified": false,
        "verification_checklist": {
          "postal_code_check": "unchecked",
          "security_code_check": "unchecked",
          "address_line1_check": "unchecked"
        },
        "installments": {
          "count": 6
        }
      },
      "point_of_sale": {
        "entry_mode": "data_only",
        "identification_number": null
      }
    },
    "metadata": {
      "key1": "value1",
      "key2": "value2"
    },
    "history": [
      {
        "id": "7e9b026bca2148299ac0b0eaf161508a",
        "transaction": "f9e49d821ad7471ba1ab82916aeb084f",
        "amount": "25.99",
        "operation_type": "authorization",
        "status": "succeeded",
        "response_code": "00",
        "response_message": "",
        "authorization_code": "133937",
        "authorizer_id": "000260004",
        "authorization_nsu": "20180510122911535",
        "gatewayResponseTime": "10",
        "authorizer": "cielo",
        "created_at": "2021-08-17 14:48:44"
      },
      {
        "id": "af0db268b88c4a65973f66c6d14142f1",
        "transaction": "f9e49d821ad7471ba1ab82916aeb084f",
        "amount": "25.99",
        "operation_type": "created",
        "status": "succeeded",
        "response_code": null,
        "response_message": null,
        "authorization_code": null,
        "authorizer_id": null,
        "authorization_nsu": null,
        "gatewayResponseTime": null,
        "authorizer": null,
        "created_at": "2021-08-17 14:48:44"
      }
    ]
  }
}

Este endpoint permite criar uma transação para pagamento via cartão de crédito.

Requisição HTTP

POST https://api.impay.com.br/v1/sellers/{seller_id}/transactions

Parâmetros de URL

Parâmetro	Obrigatório	Descrição
seller_id	Sim	ID do negócio vinculado à sua conta IM Pay

Parâmetros de Header

Parâmetro	Obrigatório	Descrição
X-Api-Key	Sim	Chave de API

Parâmetros de Body

Parâmetro	Tipo	Obrigatório	Descrição
amount	Integer	Sim	Valor a ser cobrado em centavos (valor x 100)
payment.method	String	Sim	Método de pagamento (CreditCard)
payment.credit_card.number	String	Sim	Número do cartão de crédito
payment.credit_card.holder_name	String	Sim	Nome completo (como no cartão)
payment.credit_card.expiration_month	Integer	Sim	Mês de expiração
payment.credit_card.expiration_year	Integer	Sim	Ano de expiração com 4 dígitos
payment.credit_card.security_code	Integer	Sim	Código de segurança do cartão
payment.credit_card.installments.count	Integer	Não	Cartão de crédito: indica a quantidade de parcelas. Padrão: 1
payment.credit_card.three_d_secure.device.screen_height	Integer	Sim	A altura total da tela do cliente em pixels
payment.credit_card.three_d_secure.device.screen_width	Integer	Sim	A largura total da tela do cliente em pixels
payment.credit_card.three_d_secure.device.language	String	Sim	Idioma configurado no dispositivo formato IETF BCP47
payment.credit_card.three_d_secure.device.color_depth	Integer	Sim	Profundidade de cor da tela
payment.credit_card.three_d_secure.device.time_zone_offset	Integer	Sim	Diferença de horário (horas), entre o UTC e a hora local do navegador
payment.credit_card.three_d_secure.billing.postal_code	String	Sim	CEP do portador do cartão
payment.credit_card.three_d_secure.billing.address	String	Sim	Endereço do portador do cartão
payment.credit_card.three_d_secure.billing.city	String	Sim	Cidade do portador do cartão
payment.credit_card.three_d_secure.billing.state	String	Sim	Estado do portador do cartão
payment.credit_card.three_d_secure.billing.phone_number	String	Sim	Telefone do portador do cartão
payment.credit_card.three_d_secure.billing.email	String	Sim	E-mail do portador do cartão
is_capture_enabled	Boolean	Não	Cartão de crédito: autorizar e capturar. Padrão: true
statement_descriptor	String	Não	Descrição na fatura. Padrão: nome do negócio cadastrado
reference_id	String	Não	Identificação de referência na origem
metadata	Object	Não	Objeto JSON com atributos e valores personalizados
split_rules[].recipient	String	Não	ID do recebedor (seller ID)
split_rules[].charge_processing_fee	Boolean	Não	Habilita cobrança da taxa de processamento proporcional
split_rules[].percentage	Boolean	Não	Percentual do valor da venda destinado ao recebedor

Criar Transação de Boleto

Request (Basic)

curl -X POST "https://api.impay.com.br/v1/sellers/{seller_id}/transactions" \
  --header "Content-Type: application/json" \
  --header "X-Api-Key: {api_key}" \
  --data '{
    "amount": 2599,
    "reference_id": "111",
    "customer": {
      "first_name": "João",
      "last_name": "da Silva",
      "taxpayer_id": "96490332469",
      "address": {
        "line1": "Avenida Guerra",
        "line2": "Street",
        "neighborhood": "Centro",
        "city": "Santa Matias do Norte",
        "state_code": "DF",
        "postal_code": "83192-295",
        "country_code": "BR"
      }
    },
    "payment": {
      "method": "Boleto",
      "boleto": {
        "instructions": "Pague seu boleto em dia."
      }
    },
    "metadata": {
      "key1": "Test value"
    }
  }'

200 OK

{
  "status": 200,
  "message": null,
  "data": {
    "id": "755d3c1ae1cb42c894ed838c42b8852e",
    "status": "Pending",
    "amount": 25.99,
    "original_amount": 25.99,
    "currency": "BRL",
    "customer_id": "f6ee07ed7fa54c888a073f99e7a8e77b",
    "statement_descriptor": "IM PAY PAGAMENTOS",
    "reference_id": "111",
    "expected_on": null,
    "created_at": "2021-09-01 15:14:42",
    "updated_at": "2021-09-01 15:14:42",
    "payment": {
      "method": "Boleto",
      "fees_amount": 0,
      "boleto": {
        "url": "https://api-boleto-production.s3.amazonaws.com/772ababa4bd5465396ce67d70f924c46/90827bfb071d4aa7a6240f07fdf1932f/612f98e29faf3007c3033ca3.html",
        "multiple_url": null,
        "digitable_line": "34191091729615978893231339210002788330000002599",
        "due_date": "2021-09-04 00:00:00",
        "reference_number": "29492"
      }
    },
    "metadata": {
      "key1": "Test value"
    },
    "history": [
      {
        "id": "3dee50fea58b4fbaa3b99098eed6a0b6",
        "transaction": "755d3c1ae1cb42c894ed838c42b8852e",
        "amount": "25.99",
        "operation_type": "created",
        "status": "succeeded",
        "response_code": null,
        "response_message": null,
        "authorization_code": null,
        "authorizer_id": null,
        "authorization_nsu": null,
        "gatewayResponseTime": null,
        "authorizer": null,
        "created_at": "2021-09-01 15:14:42"
      }
    ]
  }
}

Este endpoint permite criar uma transação para pagamento via boleto bancário.

Requisição HTTP

POST https://api.impay.com.br/v1/sellers/{seller_id}/transactions

Parâmetros de URL

Parâmetro	Obrigatório	Descrição
seller_id	Sim	ID do negócio vinculado à sua conta IM Pay

Parâmetros de Header

Parâmetro	Obrigatório	Descrição
X-Api-Key	Sim	Chave de API

Parâmetros de Body

Parâmetro	Tipo	Obrigatório	Descrição
amount	Integer	Sim	Valor a ser cobrado em centavos (valor x 100)
customer.taxpayer_id	String	Sim	CPF ou CNPJ
customer.first_name	String	Sim	Pessoa física: primeiro nome. Pessoa jurídica: razão social
customer.last_name	String	Sim	Pessoa física: Sobrenome. Pessoa jurídica: em branco (null)
customer.address.line1	String	Sim	Endereço
customer.address.line2	String	Não	Complemento do endereço
customer.address.neighborhood	String	Sim	Bairro
customer.address.city	String	Sim	Cidade
customer.address.state_code	String	Sim	Sigla do estado com 2 caracteres
customer.address.postal_code	String	Sim	CEP
customer.address.country_code	String	Não	Código do país com 2 caracteres
payment.method	String	Sim	Método de pagamento (Boleto)
payment.boleto.instructions	String	Não	Texto com instruções para aparecer no boleto
reference_id	String	Não	Identificação de referência na origem
metadata	Object	Não	Objeto JSON com atributos e valores personalizados
payment.boleto.due_date	String	Não	Data de vencimento. Quando não informada, o vencimento será a data atual mais 3 dias
split_rules[].recipient	String	Não	ID do recebedor (seller ID)
split_rules[].charge_processing_fee	Boolean	Não	Habilita cobrança da taxa de processamento proporcional
split_rules[].percentage	Boolean	Não	Percentual do valor da venda destinado ao recebedor

Criar Transação Pix

curl -X POST "https://api.impay.com.br/v1/sellers/{seller_id}/transactions" \
  --header "Content-Type: application/json" \
  --header "X-Api-Key: {api_key}" \
  --data '{
    "amount": 100,
    "description": "Payment Description",
    "statement_descriptor": "My Store",
    "reference_id": "610839cdd3827",
    "metadata": {
      "key1": "value1",
      "key2": "value2"
    },
    "payment": {
      "method": "Pix"
    }
  }'

200 OK

{
  "status": 200,
  "message": null,
  "data": {
    "id": "43b6f41c4fcc468a98b076bf7c04bc3e",
    "status": "Pending",
    "amount": 1,
    "original_amount": 1,
    "currency": "BRL",
    "sales_receipt": "f4d79413b22c4aad80d8b0594debeefa",
    "customer_id": null,
    "statement_descriptor": "Minha Loja",
    "reference_id": null,
    "expected_on": "2021-07-28 00:00:00",
    "created_at": "2021-07-27 18:11:45",
    "updated_at": "2021-07-27 18:11:46",
    "payment": {
      "method": "Pix",
      "fees_amount": 0,
      "pix": {
        "id": "7b5eca3f9a98471e8f9bedb4a0d9166f",
        "provider": "ITAU",
        "version": "1.0.0",
        "type": "DYNAMIC",
        "reusable": false,
        "allow_update": false,
        "key": {
          "type": "EVP",
          "value": "15240aab-3e42-4cb5-b9ee-18b9d901"
        },
        "pix_link": "https://pix.bcb.gov.br/qr/MDAwMjAxMDEwMjEyMjY3NzAwMTRCUi5HT1YuQkNCLlBJWDI1NTVhcGkuaXRhdS9waXgvcXIvdjIvYjM5MDRkMzUtMjQ0OC00NWNmLTg3MmYtOGY5NGNjNTFhZTRlNTIwNDAwMDA1MzAzOTg2NTgwMkJSNTkyNVpvb3AgVGVjbm9sb2dpYSBFIE1laW9zIEQ2MDA5U0FPIFBBVUxPNjIwNzA1MDMqKio2MzA0Q0ZENw==",
        "qr_code": {
          "emv": "00020101021226770014BR.GOV.BCB.PIX2555api.itau/pix/qr/v2/b3904d35-2448-45cf-872f-8f94cc51ae4e5204000053039865802BR5925ImPay Tecnologia E Meios D6009SAO PAULO62070503***6304CFD7"
        },
        "expires_at": "2021-07-27 18:16:45",
        "is_expired": false
      }
    },
    "metadata": {
      "CodigoRecebimento": "158272374"
    },
    "history": [
      {
        "id": "4da06aad70744c0891388adb482a9f90",
        "transaction": "43b6f41c4fcc468a98b076bf7c04bc3e",
        "amount": "1.00",
        "operation_type": "created",
        "status": "succeeded",
        "response_code": null,
        "response_message": null,
        "authorization_code": null,
        "authorizer_id": null,
        "authorization_nsu": null,
        "gatewayResponseTime": null,
        "authorizer": null,
        "created_at": "2021-07-27 18:11:45"
      },
      {
        "id": "4210830188cd4c82bbdc48c84ae94315",
        "transaction": "43b6f41c4fcc468a98b076bf7c04bc3e",
        "amount": "1.00",
        "operation_type": "proposal",
        "status": "succeeded",
        "response_code": null,
        "response_message": null,
        "authorization_code": null,
        "authorizer_id": null,
        "authorization_nsu": null,
        "gatewayResponseTime": null,
        "authorizer": "zoop",
        "created_at": "2021-07-27 18:11:45"
      }
    ]
  }
}

Este endpoint permite criar uma transação para pagamento via Pix.

Requisição HTTP

POST https://api.impay.com.br/v1/sellers/{seller_id}/transactions

Parâmetros de URL

Parâmetro	Obrigatório	Descrição
seller_id	Sim	ID do negócio vinculado à sua conta IM Pay

Parâmetros de Header

Parâmetro	Obrigatório	Descrição
X-Api-Key	Sim	Chave de API

Parâmetros de Body

Parâmetro	Tipo	Obrigatório	Descrição
amount	Integer	Sim	Valor a ser cobrado em centavos (valor x 100)
payment.method	String	Sim	Método de pagamento (Pix)
reference_id	String	Não	Identificação de referência na origem
metadata	Object	Não	Objeto JSON com atributos e valores personalizados
split_rules[].recipient	String	Não	ID do recebedor (seller ID)
split_rules[].charge_processing_fee	Boolean	Não	Habilita cobrança da taxa de processamento proporcional
split_rules[].percentage	Boolean	Não	Percentual do valor da venda destinado ao recebedor

Estornar Transação

curl -X POST "https://api.impay.com.br/v1/sellers/{seller_id}/transactions/{transaction_id}/refund" \
  --header "Accept: application/json" \
  --header "X-Api-Key: {api_key}"
  --data '{
    "amount": 2599
  }'

200 OK

{
  "status": 200,
  "message": null,
  "data": {
    "id": "ec15935a586342d998465d6820781e08",
    "status": "Canceled",
    "amount": 25.99,
    "original_amount": 25.99,
    "currency": "BRL",
    "sales_receipt": "80a990de2a434597b9d10fd3be9e6221",
    "customer_id": null,
    "statement_descriptor": "MINHA LOJA 1",
    "reference_id": "111 60da1a6a4153a",
    "expected_on": "2021-07-28 00:00:00",
    "created_at": "2021-06-28 18:52:29",
    "updated_at": "2021-06-28 21:52:32",
    "payment": {
      "method": "CreditCard",
      "fees_amount": 0,
      "credit_card": {
        "brand": "Visa",
        "first_4_digits": "4539",
        "last_4_digits": "5497",
        "expiration_month": "1",
        "expiration_year": "12",
        "holder_name": "john smith",
        "customer_id": null,
        "address": null,
        "is_valid": true,
        "is_verified": false,
        "verification_checklist": {
          "postal_code_check": "unchecked",
          "security_code_check": "unchecked",
          "address_line1_check": "unchecked"
        },
        "installments": {
          "count": 6
        }
      }
    },
    "metadata": {
      "key1": "value1",
      "key2": "value2"
    },
    "history": [
      {
        "id": "145d4b29fabe49578741e563c692282b",
        "transaction": "ec15935a586342d998465d6820781e08",
        "amount": "25.99",
        "operation_type": "authorization",
        "status": "succeeded",
        "response_code": "00",
        "response_message": "",
        "authorization_code": "133937",
        "authorizer_id": "000260004",
        "authorization_nsu": "20180510122911535",
        "gatewayResponseTime": "3",
        "authorizer": "cielo",
        "created_at": "2021-06-28 18:52:29"
      },
      {
        "id": "cfade3a31d154987b606ee3e81fcc5b2",
        "transaction": "ec15935a586342d998465d6820781e08",
        "amount": "25.99",
        "operation_type": "created",
        "status": "succeeded",
        "response_code": null,
        "response_message": null,
        "authorization_code": null,
        "authorizer_id": null,
        "authorization_nsu": null,
        "gatewayResponseTime": null,
        "authorizer": null,
        "created_at": "2021-06-28 18:52:29"
      },
      {
        "id": "2bd3520b664a4a9785622c0bcea858a5",
        "transaction": "ec15935a586342d998465d6820781e08",
        "amount": "25.99",
        "operation_type": "void",
        "status": "succeeded",
        "response_code": "0",
        "response_message": "Operation Successful",
        "authorization_code": "105016",
        "authorizer_id": "0126105452552",
        "authorization_nsu": "20180510122911537",
        "gatewayResponseTime": "11",
        "authorizer": "cielo",
        "created_at": "2021-06-28 18:52:32"
      }
    ]
  }
}

Este endpoint permite enviar uma solicitação de estorno para uma transação.

Requisição HTTP

POST https://api.impay.com.br/v1/sellers/{seller_id}/transactions/{transaction_id}/refund

Parâmetros de URL

Parâmetro	Obrigatório	Descrição
seller_id	Sim	ID do negócio vinculado à sua conta IM Pay
transaction_id	Sim	ID da transação

Parâmetros de Header

Parâmetro	Obrigatório	Descrição
X-Api-Key	Sim	Chave de API

Parâmetros de Body

Parâmetro	Tipo	Obrigatório	Descrição
amount	Integer	Sim	Valor a ser cobrado em centavos (valor x 100)

Obter Transações

curl -X GET "https://api.impay.com.br/v1/sellers/{seller_id}/transactions" \
  --header "Accept: application/json" \
  --header "X-Api-Key: {api_key}"

200 OK

{
  "status": 200,
  "message": null,
  "data": [
    {
      "id": "60decafcb413490685290f062242efe1",
      "status": "Succeeded",
      "amount": 1000,
      "original_amount": 1000,
      "currency": "BRL",
      "sales_receipt": "c5aa0cdb06e84020b6ccbd50b0448693",
      "customer_id": null,
      "statement_descriptor": "Nossa Loja",
      "reference_id": "123",
      "expected_on": "2020-11-13 00:00:00",
      "created_at": "2020-10-14 14:28:31",
      "updated_at": "2020-10-14 14:28:33",
      "payment": {
        "method": "CreditCard",
        "fees_amount": 39.9,
        "credit_card": {
          "brand": "Visa",
          "first_4_digits": "4539",
          "last_4_digits": "5497",
          "expiration_month": "12",
          "expiration_year": "20",
          "holder_name": "João da Silva",
          "customer_id": null,
          "address": null,
          "is_valid": true,
          "is_verified": false,
          "verification_checklist": {
            "postal_code_check": "unchecked",
            "security_code_check": "unchecked",
            "address_line1_check": "unchecked"
          },
          "installments": {
            "count": 5
          }
        }
      },
      "metadata": {
        "nosso_campo": "11"
      },
      "history": [
        {
          "id": "cb3c8f59a1894076bcf209129f75d8cb",
          "transaction": "60decafcb413490685290f062242efe1",
          "amount": "1000.00",
          "operation_type": "created",
          "status": "succeeded",
          "response_code": null,
          "response_message": null,
          "authorization_code": null,
          "authorizer_id": null,
          "authorization_nsu": null,
          "gatewayResponseTime": null,
          "authorizer": null,
          "created_at": "2020-10-14 14:28:31"
        },
        {
          "id": "de4729fcbc8a4765a1f8a45b20b78572",
          "transaction": "60decafcb413490685290f062242efe1",
          "amount": "1000.00",
          "operation_type": "authorization",
          "status": "succeeded",
          "response_code": "00",
          "response_message": "",
          "authorization_code": "133937",
          "authorizer_id": "000260004",
          "authorization_nsu": "20180510122911535",
          "gatewayResponseTime": "2205",
          "authorizer": "cielo",
          "created_at": "2020-10-14 14:28:33"
        }
      ]
    }
  ],
  "count": 1,
  "total_count": 1438
}

Este endpoint permite obter dados de todas as transações.

Requisição HTTP

GET https://api.impay.com.br/v1/sellers/{seller_id}/transactions

Parâmetros de URL

Parâmetro	Obrigatório	Descrição
seller_id	Sim	ID do negócio vinculado à sua conta IM Pay
date_range_start	Não	Data inicial para filtro
date_range_end	Não	Data final para filtro
amount_range_start	Não	Filtro por faixa de valor (início, inclusive)
amount_range_end	Não	Filtro por faixa de valor (final, inclusive)
payment_method	Não	Filtro pelo método de pagamento. É possível requisitar múltiplos métodos, separados por vírgula, valores possíveis: Boleto CreditCard Pix Debit
status	Não	Filtro pelo status da transação. É possível requisitar múltiplos status, separados vírgula, valores possíveis: New Pending Succeeded Canceled Failed PreAuthorized Reversed Refunded PartiallyRefunded Disputed ChargedBack
sort	Não	Campo para ordenação dos registros
offset	Não	Registro inicial
limit	Não	Limite de registros, até um máximo de 500

Parâmetros de Header

Parâmetro	Obrigatório	Descrição
X-Api-Key	Sim	Chave de API

Obter Transação

curl -X GET "https://api.impay.com.br/v1/sellers/{seller_id}/transactions/{transaction_id}" \
  --header "Accept: application/json" \
  --header "X-Api-Key: {api_key}"

200 OK

{
  "status": 200,
  "message": null,
  "data": {
    "id": "dd45b6210d0c48fc80f555cc9c76a72e",
    "status": "Pending",
    "amount": 25.99,
    "original_amount": 25.99,
    "currency": "BRL",
    "sales_receipt": "f4d79413b22c4aad80d8b0594debeefa",
    "customer_id": "1657c3235e9743938cc84e9b45e1be07",
    "statement_descriptor": "IM PAY PAGAMENTOS",
    "reference_id": "111",
    "expected_on": null,
    "created_at": "2021-06-17 18:52:33",
    "updated_at": "2021-06-17 18:52:34",
    "payment": {
      "method": "Boleto",
      "fees_amount": 0,
      "boleto": {
        "url": "https://api-boleto-production.s3.amazonaws.com/772ababa4bd5465396ce67d70f924c46/90827bfb071d4aa7a6240f07fdf1932f/60cb99f21b0c9d080977daf2.html",
        "digitable_line": "34191091729615978893231339210002788330000002599",
        "reference_number": "29492"
      }
    },
    "metadata": {
      "key1": "Test value"
    },
    "history": [
      {
        "id": "68062dde7a74489e8e5ddeb086e767bb",
        "transaction": "dd45b6210d0c48fc80f555cc9c76a72e",
        "amount": "25.99",
        "operation_type": "created",
        "status": "succeeded",
        "response_code": null,
        "response_message": null,
        "authorization_code": null,
        "authorizer_id": null,
        "authorization_nsu": null,
        "gatewayResponseTime": null,
        "authorizer": null,
        "created_at": "2021-06-17 18:52:33"
      }
    ]
  }
}

Este endpoint permite obter dados de uma transação.

Requisição HTTP

GET https://api.impay.com.br/v1/sellers/{seller_id}/transactions/{transaction_id}

Parâmetros de URL

Parâmetro	Obrigatório	Descrição
seller_id	Sim	ID do negócio vinculado à sua conta IM Pay
transaction_id	Sim	ID da transação

Parâmetros de Header

Parâmetro	Obrigatório	Descrição
X-Api-Key	Sim	Chave de API

Obter Recibo de Transação

curl -X GET "https://api.impay.com.br/v1/sellers/{seller_id}/transactions/{transaction_id}/receipt" \
  --header "Accept: application/json" \
  --header "X-Api-Key: {api_key}"

200 OK

{
  "status": 200,
  "message": null,
  "data": {
    "id": "23537c4d645643d4a7b253d22bb33a71",
    "resource": "receipt",
    "status": "approved",
    "amount": "1000.00",
    "sub_total": "1000.00",
    "currency": "BRL",
    "payment_type": "credit",
    "business_name": "IM PAY PAGAMENTOS",
    "description": null,
    "taxpayer_id": "37244432000158",
    "card": {
      "card_brand": "Visa",
      "first4_digits": "4539",
      "first6_digits": "453900"
    },
    "seller": "90827bfb071d4aa7a6240f07fdf1932f",
    "buyer": null,
    "auth_number": "133937",
    "receipt_number": "000260004",
    "auth_nsu": "20180510122911535",
    "application_identifier": null,
    "application_cryptogram": null,
    "order_number": null,
    "terminal_id": "",
    "merchant_id": "001",
    "terminal": null,
    "poi": null,
    "business_address": {
      "line1": "R. Jerônimo Faria",
      "line2": "Street",
      "state": "SC",
      "country_code": "BR"
    },
    "installment_plan": null,
    "verification_method": null,
    "original_receipt": {
      "sales_receipt_merchant": "@      Visa - Via Estabelecimento@@IM PAY PAGAMENTOS@AV SANTOS DUMONT 1665               SC@CNPJ:37244432000158@CV:000260004IM PAY PAGAMENTOS@AUTO:133937@@VISA@VENDA CREDITO A VISTA@@************5497           14/10 11:28@VALOR APROVADO             R$ 1.000,00@",
      "sales_receipt_cardholder": "@          Visa - Via Cliente@@IM PAY PAGAMENTOS@AV SANTOS DUMONT 1665               SC@CNPJ:37244432000158@CV:000260004IM PAY PAGAMENTOS@AUTO:133937@@VISA@VENDA A CREDITO A VISTA@@************5497           14/10 11:28@VALOR APROVADO             R$ 1.000,00@"
    },
    "signature": null,
    "subscription_track": false,
    "bypass_list_management": false,
    "greeting_message": null,
    "thank_you_message": null,
    "metadata": [],
    "created_at": "2020-10-14 11:28:33",
    "updated_at": "2020-10-14 11:28:33"
  }
}

Este endpoint permite obter os detalhes de um recibo de uma transação aprovada (Crédito, Débito e Pix).

Requisição HTTP

GET https://api.impay.com.br/v1/sellers/{seller_id}/transactions/{transaction_id}/receipt

Parâmetros de URL

Parâmetro	Obrigatório	Descrição
seller_id	Sim	ID do negócio vinculado à sua conta IM Pay
transaction_id	Sim	ID da transação

Parâmetros de Header

Parâmetro	Obrigatório	Descrição
X-Api-Key	Sim	Chave de API

Obter Carta de Cancelamento de Transação

curl -X GET "https://api.impay.com.br/v1/sellers/{seller_id}/transactions/{transaction_id}/cancelled-letter" \
  --header "Accept: application/json" \
  --header "X-Api-Key: {api_key}"

200 OK

{
  "url": "https://zp-production-s3-cancelled-letter.s3.sa-east-1(...)"
}

Este endpoint permite obter carta de cancelamento de uma transação.

Requisição HTTP

GET https://api.impay.com.br/v1/sellers/{seller_id}/transactions/{transaction_id}/cancelled-letter

Parâmetros de URL

Parâmetro	Obrigatório	Descrição
seller_id	Sim	ID do negócio vinculado à sua conta IM Pay
transaction_id	Sim	ID da transação

Parâmetros de Header

Parâmetro	Obrigatório	Descrição
X-Api-Key	Sim	Chave de API

Solicitar Cancelamento de Boleto

Request (Basic)

curl -X POST "https://api.impay.com.br/v1/sellers/{seller_id}/boletos/transactions/{transaction_id}/cancel" \
  --header "Content-Type: application/json" \
  --header "X-Api-Key: {api_key}"

200 OK

{
    "status": 200,
    "message": "Cancellation request created successfully",
    "data": {
        "requested": true,
        "transaction_id": "6d315870dbd5a616e32ffa3a335ce368"
    }
}

Este endpoint permite criar uma solicitação para cancelamento de boleto.

Requisição HTTP

POST https://api.impay.com.br/v1/sellers/{seller_id}/boletos/transactions/{transaction_id}/cancel

Parâmetros de URL

Parâmetro	Obrigatório	Descrição
seller_id	Sim	ID do negócio vinculado à sua conta IM Pay

Parâmetros de Header

Parâmetro	Obrigatório	Descrição
X-Api-Key	Sim	Chave de API

Links de Pagamento

Criar Link de Pagamento

curl -X POST "https://api.impay.com.br/v1/v1/sellers/{seller_id}/bank-transfers" \
  --header "Content-Type: application/json" \
  --header "X-Api-Key: {api_key}" \
  --data '{
    "description": "Order #123",
    "customer_name": "customer 1",
    "items": [
      {
        "description": "description 1",
        "reference_id": "ref id 1",
        "quantity": 2,
        "price": 15,
        "max_installments": 3
      }
    ]
  }'

200 OK

{
  "status": 200,
  "message": null,
  "data": {
    "resource": "checkout",
    "id": "80f38892b6bab6448b9d99c99df48cd7",
    "seller_id": "90827bfb071d4aa7a6240f07fdf1932f",
    "shipping_amount": null,
    "discount_amount": null,
    "created_at": "2022-01-05 17:22:46",
    "updated_at": "2022-01-05 17:22:46",
    "paid_at": null,
    "description": "Order #123",
    "transaction_id": null,
    "customer_name": "customer 1",
    "metadata": null,
    "expires_at": "2022-03-08",
    "due_date": "2022-01-08",
    "on_time_payment_discount_rate": null,
    "late_fee_rate": 0,
    "daily_interest_rate": 0,
    "is_pix_enabled": true,
    "is_credit_enabled": true,
    "is_boleto_enabled": true,
    "is_customer_fee_coverage": false,
    "initial_installment_fee_coverage": null,
    "min_installment_amount": null,
    "fee_coverage_amount": 0,
    "on_pix_payment_discount_rate": null,
    "seller": {
      "id": "90827bfb071d4aa7a6240f07fdf1932f",
      "name": "Esteves-Correia",
      "status": "Pending",
      "type": "Company"
    },
    "items": [
      {
        "description": "description 1",
        "quantity": 2,
        "price": 15,
        "max_installments": 3,
        "reference_id": "ref id 1",
        "on_time_payment_discount_rate": 0,
        "due_date": null,
        "subtotal": 30,
        "total": 30,
        "on_time_payment_discount_amount": 0,
        "is_late_payment": false,
        "days_past_due": 0,
        "late_fee_amount": 0,
        "daily_interest_amount": 0
      }
    ],
    "max_installments": 3,
    "is_expired": false,
    "is_paid": false,
    "transaction": null,
    "late_fee_amount": 0,
    "daily_interest_amount": 0,
    "on_time_payment_discount_amount": 0,
    "items_total": 30,
    "grand_total": 30,
    "url": "http://api.impay.local/checkout/80f38892b6bab6448b9d99c99df48cd7",
    "checkout_id": "80f38892b6bab6448b9d99c99df48cd7"
  }
}

Este endpoint cria um link de pagamento, destinado ao cliente final, permitindo que ele faça o pagamento de um valor previamento configurado.

Requisição HTTP

POST https://api.impay.com.br/v1/sellers/{seller_id}/checkouts

Parâmetros de URL

Parâmetro	Obrigatório	Descrição
seller_id	Sim	ID de seller vinculado à sua conta IM Pay

Parâmetros de Header

Parâmetro	Obrigatório	Descrição
X-Api-Key	Sim	Chave de API

Parâmetros de Body

Parâmetro	Tipo	Obrigatório	Descrição
description	String	Sim	Descrição do pagamento
customer_name	String	Sim	Nome do cliente que vai efetuar o pagamento
expires_at	String	Não	Data limite para acesso ao link de pagamento
late_fee_rate	Float	Não	Percentual de acréscimo para pagamento em atraso (multa)
daily_interest_rate	Float	Não	Percentual de acréscimo diário para pagamento em atraso (juros)
due_date	Date	Não	Data de vencimento. Pode ser uma data retroativa Padrão: data atual mais 3 dias
on_time_payment_discount_rate	Float	Não	Percentual de desconto para pagamento em dia
min_installment_amount	Float	Não	Valor mínimo de parcela
is_pix_enabled	Boolean	Não	Habilitar método de pagamento via Pix
is_credit_enabled	Boolean	Não	Habilitar método de pagamento via Crédito
is_boleto_enabled	Boolean	Não	Habilitar método de pagamento Boleto
is_customer_fee_coverage	Boolean	Não	Habilitar repasse de taxa para o cliente (Default: false)
initial_installment_fee_coverage	Integer	Não	Inicio do repasse de taxas para o cliente (Default: todas as parcelas com juros)
on_pix_payment_discount_rate	Float	Não	Percentual de desconto para pagamentos do tipo pix (Min: 1	Max: 95)
items[]	Array	Sim	Detalhamento dos itens
items[].description	String	Sim	Descrição do item
items[].quantity	Integer	Sim	Quantitidade do item
items[].price	Float	Sim	Preço do item
items[].reference_id	String	Não	ID de referência para o item
items[].max_installments	Integer	Não	Máximo de parcelas para o item
items[].due_date	Date	Não	Data de vencimento. Pode ser uma data retroativa (Default: data atual mais 3 dias)
items[].on_time_payment_discount_rate	Float	Não	Percentual de desconto para pagamento em dia

Obter Link de Pagamento

curl -X GET "https://api.impay.com.br/v1/sellers/{seller_id}/checkouts/{checkout_id}" \
  --header "Content-Type: application/json" \
  --header "X-Api-Key: {api_key}"

200 OK

{
  "status": 200,
  "message": null,
  "data": {
    "resource": "checkout",
    "id": "e74f54ae6fc50a265fb21db090e9677b",
    "seller_id": "90827bfb071d4aa7a6240f07fdf1932f",
    "shipping_amount": null,
    "discount_amount": null,
    "created_at": "2022-01-05 17:31:55",
    "updated_at": "2022-01-05 17:31:55",
    "paid_at": null,
    "description": "Order #123",
    "transaction_id": null,
    "customer_name": "customer 1",
    "metadata": null,
    "expires_at": "2022-03-08",
    "due_date": "2022-01-08",
    "on_time_payment_discount_rate": null,
    "late_fee_rate": 0,
    "daily_interest_rate": 0,
    "is_pix_enabled": true,
    "is_credit_enabled": true,
    "is_boleto_enabled": true,
    "is_customer_fee_coverage": false,
    "initial_installment_fee_coverage": null,
    "min_installment_amount": null,
    "fee_coverage_amount": 0,
    "on_pix_payment_discount_rate": null,
    "seller": {
      "id": "90827bfb071d4aa7a6240f07fdf1932f",
      "name": "Esteves-Correia",
      "status": "Pending",
      "type": "Company"
    },
    "items": [
      {
        "id": "805",
        "checkout_id": "e74f54ae6fc50a265fb21db090e9677b",
        "description": "description 1",
        "quantity": 2,
        "price": 15,
        "max_installments": 3,
        "reference_id": "ref id 1",
        "on_time_payment_discount_rate": 0,
        "due_date": null,
        "subtotal": 30,
        "total": 30,
        "on_time_payment_discount_amount": 0,
        "is_late_payment": false,
        "days_past_due": 0,
        "late_fee_amount": 0,
        "daily_interest_amount": 0
      }
    ],
    "items_total": 30,
    "max_installments": 3,
    "is_expired": false,
    "is_paid": false,
    "transaction": null,
    "late_fee_amount": 0,
    "daily_interest_amount": 0,
    "on_time_payment_discount_amount": 0,
    "grand_total": 30,
    "url": "http://api.impay.local/checkout/e74f54ae6fc50a265fb21db090e9677b"
  }
}

Este endpoint retorna os dados de um link de pagamento.

Requisição HTTP

GET https://api.impay.com.br/v1/sellers/{seller_id}/checkouts/{checkout_id}

Parâmetros de URL

Parâmetro	Obrigatório	Descrição
seller_id	Sim	ID de seller vinculado à conta IM Pay
checkout_id	Sim	ID do link de pagamento

Parâmetros de Header

Parâmetro	Obrigatório	Descrição
X-Api-Key	Sim	Chave de API

Obter Links de Pagamento

curl -X GET "https://api.impay.com.br/v1/sellers/{seller_id}/checkouts?offset=0&limit=2" \
  --header "Content-Type: application/json" \
  --header "X-Api-Key: {api_key}"

200 OK

{
  "status": 200,
  "message": null,
  "data": [
    {
      "id": "000ad1732714dcf493f265742247df36",
      "seller_id": "90827bfb071d4aa7a6240f07fdf1932f",
      "shipping_amount": null,
      "discount_amount": null,
      "created_at": "2021-08-24 09:24:10",
      "updated_at": "2021-08-24 09:24:10",
      "paid_at": null,
      "description": "Order #123",
      "transaction_id": null,
      "customer_name": "customer 1",
      "metadata": null,
      "expires_at": "2021-08-31",
      "due_date": "2021-08-31",
      "on_time_payment_discount_rate": null,
      "late_fee_rate": 0,
      "daily_interest_rate": 0,
      "is_pix_enabled": true,
      "is_credit_enabled": true,
      "is_boleto_enabled": true,
      "is_customer_fee_coverage": false,
      "initial_installment_fee_coverage": null,
      "min_installment_amount": null,
      "fee_coverage_amount": 0,
      "on_pix_payment_discount_rate": null,
      "seller": {
        "id": "90827bfb071d4aa7a6240f07fdf1932f",
        "name": "Esteves-Correia",
        "status": "Pending",
        "type": "Company"
      },
      "items": [
        {
          "id": "437",
          "checkout_id": "000ad1732714dcf493f265742247df36",
          "description": "description 1",
          "quantity": 2,
          "price": 15,
          "max_installments": 3,
          "reference_id": "ref id 1",
          "on_time_payment_discount_rate": 0,
          "due_date": "2021-08-31",
          "subtotal": 30,
          "total": 30,
          "on_time_payment_discount_amount": 0,
          "is_late_payment": true,
          "days_past_due": 127,
          "late_fee_amount": 0,
          "daily_interest_amount": 0
        }
      ],
      "items_total": 30,
      "max_installments": 3,
      "is_expired": true,
      "is_paid": false,
      "transaction": null,
      "late_fee_amount": 0,
      "daily_interest_amount": 0,
      "on_time_payment_discount_amount": 0,
      "grand_total": 30,
      "url": "http://checkout.impay.local/checkout/000ad1732714dcf493f265742247df36"
    },
    {
      "id": "016972a7c8b60900490374d858f7c2e2",
      "seller_id": "90827bfb071d4aa7a6240f07fdf1932f",
      "shipping_amount": null,
      "discount_amount": null,
      "created_at": "2021-10-07 09:27:30",
      "updated_at": "2021-10-07 09:27:30",
      "paid_at": null,
      "description": "Order #123",
      "transaction_id": null,
      "customer_name": "customer 1",
      "metadata": null,
      "expires_at": "2021-10-17",
      "due_date": "2021-10-17",
      "on_time_payment_discount_rate": null,
      "late_fee_rate": 0,
      "daily_interest_rate": 0,
      "is_pix_enabled": true,
      "is_credit_enabled": true,
      "is_boleto_enabled": true,
      "is_customer_fee_coverage": false,
      "initial_installment_fee_coverage": null,
      "min_installment_amount": null,
      "fee_coverage_amount": 0,
      "on_pix_payment_discount_rate": null,
      "seller": {
        "id": "90827bfb071d4aa7a6240f07fdf1932f",
        "name": "Esteves-Correia",
        "status": "Pending",
        "type": "Company"
      },
      "items": [
        {
          "id": "545",
          "checkout_id": "016972a7c8b60900490374d858f7c2e2",
          "description": "description 1",
          "quantity": 2,
          "price": 15,
          "max_installments": 3,
          "reference_id": "ref id 1",
          "on_time_payment_discount_rate": 0,
          "due_date": "2021-10-17",
          "subtotal": 30,
          "total": 30,
          "on_time_payment_discount_amount": 0,
          "is_late_payment": true,
          "days_past_due": 79,
          "late_fee_amount": 0,
          "daily_interest_amount": 0
        }
      ],
      "items_total": 30,
      "max_installments": 3,
      "is_expired": true,
      "is_paid": false,
      "transaction": null,
      "late_fee_amount": 0,
      "daily_interest_amount": 0,
      "on_time_payment_discount_amount": 0,
      "grand_total": 30,
      "url": "http://api.impay.local/checkout/016972a7c8b60900490374d858f7c2e2"
    }
  ],
  "count": 2,
  "total_count": 10
}

Este endpoint permite listar links de pagamento.

Requisição HTTP

GET https://api.impay.com.br/v1/sellers/{seller_id}/checkouts

Parâmetros de URL

Parâmetro	Obrigatório	Descrição
seller_id	Sim	ID de seller vinculado à conta IM Pay
sort	Não	Campo para ordenação dos registros
offset	Não	Registro inicial
limit	Não	Limite de registros, até um máximo de 500

Parâmetros de Header

Parâmetro	Obrigatório	Descrição
X-Api-Key	Sim	Chave de API

Pagar Via Cartão de Crédito

curl -X POST "https://api.impay.com.br/v1/checkouts/{checkout_id}/pay" \
  --header "Content-Type: application/json" \
  --header "X-Api-Key: {api_key}" \
  --data '{
    "payment": {
      "method": "CreditCard",
      "credit_card": {
        "number": "4539003370725497",
        "holder_name": "Teste L Silva",
        "expiration_month": "01",
        "expiration_year": "2024",
        "security_code": "000",
        "installments": {
          "count": 3
        },
        "three_d_secure": {
          "device": {
            "screen_height": 788,
            "screen_width": 481,
            "language": "pt-BR",
            "color_depth": 30,
            "time_zone_offset": 3
          },
          "billing": {
            "postal_code": "99999-999",
            "address": "Rua das Rosas",
            "city": "Piracicaba",
            "state": "SP",
            "phone_number": "(48) 90000-0000",
            "email": "test@mail.com"
          }
        }
      }
    }
  }'

200 OK

{
  "status": 200,
  "message": null,
  "data": {
    "resource": "checkout",
    "id": "c73badc9c5f5153b82497f4bb4d9f552",
    "seller_id": "90827bfb071d4aa7a6240f07fdf1932f",
    "shipping_amount": null,
    "discount_amount": null,
    "created_at": "2022-01-05 17:25:52",
    "updated_at": "2022-01-05 17:25:53",
    "paid_at": "2022-01-05 17:25:53",
    "description": "Order #123",
    "transaction_id": "66a6446db7e54d6fa7e13999f199e06b",
    "customer_name": "customer 1",
    "metadata": null,
    "expires_at": "2022-03-08",
    "due_date": "2022-01-08",
    "on_time_payment_discount_rate": null,
    "late_fee_rate": 0,
    "daily_interest_rate": 0,
    "is_pix_enabled": true,
    "is_credit_enabled": true,
    "is_boleto_enabled": true,
    "is_customer_fee_coverage": false,
    "initial_installment_fee_coverage": null,
    "min_installment_amount": null,
    "fee_coverage_amount": 0,
    "on_pix_payment_discount_rate": null,
    "seller": {
      "id": "90827bfb071d4aa7a6240f07fdf1932f",
      "name": "Esteves-Correia",
      "status": "Pending",
      "type": "Company"
    },
    "items": [
      {
        "id": "803",
        "checkout_id": "c73badc9c5f5153b82497f4bb4d9f552",
        "description": "description 1",
        "quantity": 2,
        "price": 15,
        "max_installments": 3,
        "reference_id": "ref id 1",
        "on_time_payment_discount_rate": 0,
        "due_date": null,
        "subtotal": 30,
        "total": 30,
        "on_time_payment_discount_amount": 0,
        "is_late_payment": false,
        "days_past_due": 0,
        "late_fee_amount": 0,
        "daily_interest_amount": 0
      }
    ],
    "items_total": 0,
    "max_installments": 3,
    "is_expired": false,
    "is_paid": true,
    "transaction": {
      "id": "66a6446db7e54d6fa7e13999f199e06b",
      "status": "Succeeded",
      "amount": 30,
      "original_amount": 30,
      "currency": "BRL",
      "customer_id": null,
      "statement_descriptor": "ESTEVESCORREIA",
      "reference_id": null,
      "expected_on": "2022-02-04 00:00:00",
      "created_at": "2022-01-05 17:25:53",
      "updated_at": "2022-01-05 17:25:53",
      "payment": {
        "method": "CreditCard",
        "fees_amount": 1.2,
        "credit_card": {
          "brand": "Visa",
          "first_4_digits": "4539",
          "last_4_digits": "5497",
          "expiration_month": "1",
          "expiration_year": "2024",
          "holder_name": "Teste L Silva",
          "customer_id": null,
          "address": null,
          "is_valid": true,
          "is_verified": false,
          "verification_checklist": {
            "postal_code_check": "unchecked",
            "security_code_check": "unchecked",
            "address_line1_check": "unchecked"
          },
          "installments": {
            "count": 3
          }
        },
        "point_of_sale": {
          "entry_mode": "data_only",
          "identification_number": null
        }
      },
      "metadata": [],
      "history": [
        {
          "id": "b791bafbace741f186589bf41e2663d1",
          "transaction": "66a6446db7e54d6fa7e13999f199e06b",
          "amount": "30.00",
          "operation_type": "created",
          "status": "succeeded",
          "response_code": null,
          "response_message": null,
          "authorization_code": null,
          "authorizer_id": null,
          "authorization_nsu": null,
          "gatewayResponseTime": null,
          "authorizer": null,
          "created_at": "2022-01-05 17:25:53"
        },
        {
          "id": "d14613998d2a4edfb3fc935b86e0c889",
          "transaction": "66a6446db7e54d6fa7e13999f199e06b",
          "amount": "30.00",
          "operation_type": "authorization",
          "status": "succeeded",
          "response_code": "00",
          "response_message": "",
          "authorization_code": "133937",
          "authorizer_id": "000260004",
          "authorization_nsu": "20180510122911535",
          "gatewayResponseTime": "9",
          "authorizer": "cielo",
          "created_at": "2022-01-05 17:25:53"
        }
      ]
    },
    "late_fee_amount": 0,
    "daily_interest_amount": 0,
    "on_time_payment_discount_amount": 0,
    "grand_total": 0,
    "url": "http://api.impay.local/checkout/c73badc9c5f5153b82497f4bb4d9f552"
  }
}

Este endpoint permite efetuar o pagamento de um checkout existente, via cartão de crédito.

Requisição HTTP

POST https://api.impay.com.br/v1/checkouts/{checkout_id}/pay

Parâmetros de URL

Parâmetro	Obrigatório	Descrição
seller_id	Sim	ID de seller vinculado à sua conta IM Pay
checkout_id	Sim	ID do link de pagamento

Parâmetros de Header

Parâmetro	Obrigatório	Descrição
X-Api-Key	Sim	Chave de API

Parâmetros de Body

Parâmetro	Tipo	Obrigatório	Descrição
payment.method	String	Sim	Método de pagamento (CreditCard)
payment.credit_card.number	String	Sim	Número do cartão de crédito
payment.credit_card.holder_name	String	Sim	Nome completo (como no cartão)
payment.credit_card.expiration_month	Integer	Sim	Mês de expiração
payment.credit_card.expiration_year	Integer	Sim	Ano de expiração com 4 dígitos
payment.credit_card.security_code	Integer	Sim	Código de segurança do cartão
payment.credit_card.installments.count	Integer	Não	Quantidade de parcelas Padrão: 1
payment.credit_card.three_d_secure.device.screen_height	Integer	Sim	A altura total da tela do cliente em pixels
payment.credit_card.three_d_secure.device.screen_width	Integer	Sim	A largura total da tela do cliente em pixels
payment.credit_card.three_d_secure.device.language	String	Sim	Idioma configurado no dispositivo formato IETF BCP47
payment.credit_card.three_d_secure.device.color_depth	Integer	Sim	Profundidade de cor da tela
payment.credit_card.three_d_secure.device.time_zone_offset	Integer	Sim	Diferença de horário (horas), entre o UTC e a hora local do navegador
payment.credit_card.three_d_secure.billing.postal_code	String	Sim	CEP do portador do cartão
payment.credit_card.three_d_secure.billing.address	String	Sim	Endereço do portador do cartão
payment.credit_card.three_d_secure.billing.city	String	Sim	Cidade do portador do cartão
payment.credit_card.three_d_secure.billing.state	String	Sim	Estado do portador do cartão
payment.credit_card.three_d_secure.billing.phone_number	String	Sim	Telefone do portador do cartão
payment.credit_card.three_d_secure.billing.email	String	Sim	E-mail do portador do cartão
is_capture_enabled	Boolean	Não	Autorizar e capturar automaticamente Padrão: true
statement_descriptor	String	Não	Descrição na fatura do cartão de crédito Padrão: nome do negócio

Pagar Via Boleto

curl -X POST "https://api.impay.com.br/v1/checkouts/{checkout_id}/pay" \
  --header "Content-Type: application/json" \
  --header "X-Api-Key: {api_key}" \
  --data '{
    "customer": {
      "first_name": "João",
      "last_name": "da Silva",
      "taxpayer_id": "353.712.068-09",
      "address": {
        "line1": "R. Jerônimo Faria",
        "line2": "Street",
        "neighborhood": "Centro",
        "city": "Porto Ian dOeste",
        "state_code": "DF",
        "postal_code": "86182-790",
        "country_code": "BR"
      }
    },
    "payment": {
      "method": "Boleto",
      "boleto": {
        "instructions": "Pague seu boleto em dia."
      }
    }
  }'

200 OK

{
  "status": 200,
  "message": null,
  "data": {
    "resource": "checkout",
    "id": "6dcd0bb6dae9a52b1d43b74575fd7ea4",
    "seller_id": "90827bfb071d4aa7a6240f07fdf1932f",
    "shipping_amount": null,
    "discount_amount": null,
    "created_at": "2022-01-05 17:27:57",
    "updated_at": "2022-01-05 17:28:00",
    "paid_at": "2022-01-05 17:28:00",
    "description": "Order #123",
    "transaction_id": "237c44157f944f81b32be9c6b8f1b2d8",
    "customer_name": "customer 1",
    "metadata": null,
    "expires_at": "2022-03-08",
    "due_date": "2022-01-08",
    "on_time_payment_discount_rate": null,
    "late_fee_rate": 0,
    "daily_interest_rate": 0,
    "is_pix_enabled": true,
    "is_credit_enabled": true,
    "is_boleto_enabled": true,
    "is_customer_fee_coverage": false,
    "initial_installment_fee_coverage": null,
    "min_installment_amount": null,
    "fee_coverage_amount": 0,
      "on_pix_payment_discount_rate": null,
    "seller": {
      "id": "90827bfb071d4aa7a6240f07fdf1932f",
      "name": "Esteves-Correia",
      "status": "Pending",
      "type": "Company"
    },
    "items": [
      {
        "id": "804",
        "checkout_id": "6dcd0bb6dae9a52b1d43b74575fd7ea4",
        "description": "description 1",
        "quantity": 2,
        "price": 15,
        "max_installments": 3,
        "reference_id": "ref id 1",
        "on_time_payment_discount_rate": 0,
        "due_date": null,
        "subtotal": 30,
        "total": 30,
        "on_time_payment_discount_amount": 0,
        "is_late_payment": false,
        "days_past_due": 0,
        "late_fee_amount": 0,
        "daily_interest_amount": 0
      }
    ],
    "items_total": 30,
    "max_installments": 3,
    "is_expired": false,
    "is_paid": false,
    "transaction": {
      "id": "237c44157f944f81b32be9c6b8f1b2d8",
      "status": "Pending",
      "amount": 30,
      "original_amount": 30,
      "currency": "BRL",
      "customer_id": "3d94c6502cf2493888db24c920589676",
      "statement_descriptor": "IM PAY PAGAMENTOS",
      "reference_id": null,
      "expected_on": null,
      "created_at": "2022-01-05 17:27:59",
      "updated_at": "2022-01-05 17:27:59",
      "payment": {
        "method": "Boleto",
        "fees_amount": 0,
        "boleto": {
          "url": "https://api-boleto-production.s3.amazonaws.com/772ababa4bd5465396ce67d70f924c46/90827bfb071d4aa7a6240f07fdf1932f/61d5f13f64554b082390d1ab.html",
          "digitable_line": "34191091805680016893431339210002689180000003000",
          "due_date": "2022-03-08 00:00:00",
          "reference_number": "18568001"
        },
        "point_of_sale": {
          "entry_mode": "barcode",
          "identification_number": null
        }
      },
      "metadata": [],
      "history": [
        {
          "id": "21aab45470294c628fd886dc457b2aed",
          "transaction": "237c44157f944f81b32be9c6b8f1b2d8",
          "amount": "30.00",
          "operation_type": "created",
          "status": "succeeded",
          "response_code": null,
          "response_message": null,
          "authorization_code": null,
          "authorizer_id": null,
          "authorization_nsu": null,
          "gatewayResponseTime": null,
          "authorizer": null,
          "created_at": "2022-01-05 17:27:59"
        }
      ]
    },
    "late_fee_amount": 0,
    "daily_interest_amount": 0,
    "on_time_payment_discount_amount": 0,
    "grand_total": 30,
    "url": "http://api.impay.local/checkout/6dcd0bb6dae9a52b1d43b74575fd7ea4"
  }
}

Pagamento via boleto.

Requisição HTTP

POST https://api.impay.com.br/v1/checkouts/{checkout_id}/pay

Parâmetros de URL

Parâmetro	Obrigatório	Descrição
seller_id	Sim	ID de seller vinculado à sua conta IM Pay

Parâmetros de Header

Parâmetro	Obrigatório	Descrição
X-Api-Key	Sim	Chave de API

Parâmetros de Body

Parâmetro	Tipo	Obrigatório	Descrição
customer.first_name	String	Sim	Primeiro nome do cliente
customer.last_name	String	Sim	Sobrenome do cliente
customer.taxpayer_id	String	Sim	CPF do cliente
customer.address.line1	String	Sim	Endereço
customer.address.line2	String	Não	Complemento do endereço
customer.address.neighborhood	String	Sim	Bairro
customer.address.city	String	Sim	Cidade
customer.address.state_code	String	Sim	Sigla do estado com 2 caracteres
customer.address.postal_state	String	Sim	CEP
customer.address.country_code	String	Não	Código do país com 2 caracteres
payment.method	String	Sim	Método de pagamento (Boleto)
payment.boleto.instructions	String	Não	Instruções para mostrar no boleto

Pagar Via Pix

curl -X POST "https://api.impay.com.br/v1/checkouts/{checkout_id}/pay" \
  --header "Content-Type: application/json" \
  --header "X-Api-Key: {api_key}" \
  --data '{
    "payment": {
      "method": "Pix",
    }
  }'

200 OK

{
  "status": 200,
  "message": null,
  "data": {
    "resource": "checkout",
    "id": "85769d87ec959fe7a6d4627453adb22b",
    "seller_id": "90827bfb071d4aa7a6240f07fdf1932f",
    "shipping_amount": null,
    "discount_amount": null,
    "created_at": "2021-08-04 17:49:47",
    "updated_at": "2021-08-04 17:49:48",
    "paid_at": "2021-08-04 17:49:48",
    "description": "Product Abc",
    "transaction_id": "43b6f41c4fcc468a98b076bf7c04bc3e",
    "customer_name": "Nome Cliente",
    "metadata": null,
    "expires_at": "2021-08-11 17:49:47",
    "due_date": "2022-01-08",
    "on_time_payment_discount_rate": null,
    "items": [
      {
        "id": "357",
        "checkout_id": "85769d87ec959fe7a6d4627453adb22b",
        "description": "Descrição produto",
        "quantity": 2,
        "price": 15,
        "max_installments": 3,
        "reference_id": "ref id 1",
        "on_time_payment_discount_rate": 0,
        "due_date": null,
        "on_time_payment_discount_amount": 0,
        "is_late_payment": false,
        "days_past_due": 0,
        "late_fee_amount": 0,
        "daily_interest_amount": 0,
        "subtotal": 30
      }
    ],
    "grand_total": 30,
    "late_fee_rate": 0,
    "daily_interest_rate": 0,
    "max_installments": 3,
    "late_fee_amount": 0,
    "daily_interest_amount": 0,
    "on_time_payment_discount_amount": 0,
    "is_pix_enabled": true,
    "is_credit_enabled": true,
    "is_boleto_enabled": true,
    "is_customer_fee_coverage": false,
    "initial_installment_fee_coverage": null,
    "min_installment_amount": null,
    "fee_coverage_amount": 0,
    "on_pix_payment_discount_rate": null,
    "seller": {
      "id": "90827bfb071d4aa7a6240f07fdf1932f",
      "name": "Esteves-Correia",
      "status": "Pending",
      "type": "Company"
    },
    "is_expired": false,
    "url": "http://checkout.sandbox.impay.com.br/checkout/85769d87ec959fe7a6d4627453adb22b",
    "transaction": {
      "id": "43b6f41c4fcc468a98b076bf7c04bc3e",
      "status": "Pending",
      "amount": 1,
      "original_amount": 1,
      "currency": "BRL",
      "customer_id": null,
      "statement_descriptor": "Minha Loja",
      "reference_id": null,
      "expected_on": "2021-07-28 00:00:00",
      "created_at": "2021-07-27 18:11:45",
      "updated_at": "2021-07-27 18:11:46",
      "payment": {
        "method": "Pix",
        "fees_amount": 0,
        "pix": {
          "id": "7b5eca3f9a98471e8f9bedb4a0d9166f",
          "provider": "ITAU",
          "version": "1.0.0",
          "type": "DYNAMIC",
          "reusable": false,
          "allow_update": false,
          "key": {
            "type": "EVP",
            "value": "15240aab-3e42-4cb5-b9ee-18b9d901"
          },
          "pix_link": "https://pix.bcb.gov.br/qr/MDAwMjAxMDEwMjEyMjY3NzAwMTRCUi5HT1YuQkNCLlBJWDI1NTVhcGkuaXRhdS9waXgvcXIvdjIvYjM5MDRkMzUtMjQ0OC00NWNmLTg3MmYtOGY5NGNjNTFhZTRlNTIwNDAwMDA1MzAzOTg2NTgwMkJSNTkyaVpvb3AgVGVjbm9sb2dpYSBFIE1laW9zIEQ2MDA5U0FPIFBBVUxPNjIwNzA1MDMqKio2MzA0Q0ZENw==",
          "qr_code": {
            "emv": "00020101021226770014BR.GOV.BCB.PIX2555api.itau/pix/qr/v2/b3904d35-2448-45cf-872f-8f94cc51ae4e5204000053039865802BR5925XYZZ Tecnologia E Meios D6009SAO PAULO62070503***6304CFD7"
          },
          "expires_at": "2021-07-27 18:16:45",
          "is_expired": false
        }
      },
      "metadata": {
        "CodigoRecebimento": "158272374"
      },
      "history": [
        {
          "id": "4da06aad70744c0891388adb482a9f90",
          "transaction": "43b6f41c4fcc468a98b076bf7c04bc3e",
          "amount": "1.00",
          "operation_type": "created",
          "status": "succeeded",
          "response_code": null,
          "response_message": null,
          "authorization_code": null,
          "authorizer_id": null,
          "authorization_nsu": null,
          "gatewayResponseTime": null,
          "authorizer": null,
          "created_at": "2021-07-27 18:11:45"
        },
        {
          "id": "4210830188cd4c82bbdc48c84ae94315",
          "transaction": "43b6f41c4fcc468a98b076bf7c04bc3e",
          "amount": "1.00",
          "operation_type": "proposal",
          "status": "succeeded",
          "response_code": null,
          "response_message": null,
          "authorization_code": null,
          "authorizer_id": null,
          "authorization_nsu": null,
          "gatewayResponseTime": null,
          "authorizer": "zoop",
          "created_at": "2021-07-27 18:11:45"
        }
      ]
    }
  }
}

Pagamento via Pix.

Requisição HTTP

POST https://api.impay.com.br/v1/checkouts/{checkout_id}/pay

Parâmetros de URL

Parâmetro	Obrigatório	Descrição
seller_id	Sim	ID de seller vinculado à sua conta IM Pay

Parâmetros de Header

Parâmetro	Obrigatório	Descrição
X-Api-Key	Sim	Chave de API

Parâmetros de Body

Parâmetro	Tipo	Obrigatório	Descrição
payment.method	String	Sim	Método de pagamento (Pix)

Histórico de Lançamentos

Obter Histórico

curl -X GET "https://api.impay.com.br/v1/sellers/{seller_id}/reports/account-history" \
  --header "Accept: application/json" \
  --header "X-Api-Key: {api_key}"

200 OK

{
  "status": 200,
  "message": null,
  "data": [
    {
      "id": "60efb639a5844c27963b152a0932deaa",
      "resource": "entry",
      "nsu": "132",
      "amount": -9.6,
      "blocked_amount": 0.0,
      "gross_amount": -9.2,
      "fee": 0.4,
      "date": "2021-07-09 18:17:25",
      "description": "Estorno Venda Crédito MasterCard",
      "current_balance": 0.0,
      "current_blocked_balance": 0.0,
      "type": "charge_refunded",
      "object_id": "03a67eaeefb144889bc37dad3caebfb6",
      "object_type": "receivable",
      "transaction": {
        "id": "db39a0262feb44b69075faa22dc4d7ea",
        "authorization_code": "Z041351-1004210709150802754a"
      }
    },
    {
      "id": "beb7fe6f27624f83befeca83aee72b7a",
      "resource": "entry",
      "nsu": "131",
      "amount": 9.6,
      "blocked_amount": 0.0,
      "gross_amount": 10.0,
      "fee": 0.4,
      "date": "2021-07-09 18:17:25",
      "description": "Venda Crédito MasterCard",
      "current_balance": 9.6,
      "current_blocked_balance": 0.0,
      "type": "charge",
      "object_id": "03a67eaeefb144889bc37dad3caebfba",
      "object_type": "receivable",
      "transaction": {
        "id": "db39a0262feb44b69075faa22dc4d7ea",
        "authorization_code": "Z041351-1004210709150802754a"
      }
    },
    {
      "id": "7b4dbec71726429dae738ed1fec4c5da",
      "resource": "entry",
      "nsu": "130",
      "amount": -270.0,
      "blocked_amount": 0.0,
      "gross_amount": -270.0,
      "fee": 0.0,
      "date": "2021-07-02 12:17:41",
      "description": "Depósito sob Demanda (Saque)",
      "current_balance": 0.0,
      "current_blocked_balance": 0.0,
      "type": "deposit",
      "object_id": "e19a46913ebb4ed4ae26ca5f383afb0a",
      "object_type": "transfer",
      "transfer": {
        "id": "e19a46913ebb4ed4ae26ca5f383afb0a",
        "authorization_code": "CR020720211755186a"
      }
    }
  ],
  "count": 3,
  "total_count": 132
}

Este endpoint retorna o histórico de lançamentos efetuados na conta de um negócio. A ordenação padrão é do mais recente para o mais antigo. Débitos podem ser identificados pelo valor negativo.

Requisição HTTP

GET https://api.impay.com.br/v1/sellers/{seller_id}/reports/account-history

Parâmetros de URL

Parâmetro	Obrigatório	Descrição
seller_id	Sim	ID do negócio vinculado à sua conta IM Pay
date_range_start	Não	Data inicial para filtro
date_range_end	Não	Data final para filtro
offset	Não	Registro inicial
limit	Não	Limite de registros, até um máximo de 500

Parâmetros de Header

Parâmetro	Obrigatório	Descrição
X-Api-Key	Sim	Chave de API

Recebíveis

Obter Recebíveis

curl -X GET "https://api.impay.com.br/v1/sellers/{seller_id}/receivables" \
  --header "Accept: application/json" \
  --header "X-Api-Key: {api_key}"

200 OK

{
  "status": 200,
  "message": null,
  "data": [
    {
      "id": "3c71eb502f504456afd9507ca1ac3624",
      "resource": "receivable",
      "status": "Pending",
      "recipient": "90827bfb071d4aa7a6240f07fdf1932f",
      "transaction": "53e5d80716e14bc59b1d0022d81c0fd7",
      "split_rule": null,
      "installment": "1",
      "liable": true,
      "amount": "12.47",
      "gross_amount": "12.99",
      "anticipation_fee": "0.00",
      "paid_at": null,
      "created_at": "2021-06-23 14:13:26",
      "transaction_created_at": "2021-06-23 14:13:25",
      "canceled_at": null,
      "expected_on": "2021-07-23 00:00:00",
      "authorization_code": "Z133937-000260004",
      "id_original_receivable": null,
      "prepaid": false
    },
    {
      "id": "585ff7e7db6d421189a7eda871f48cfa",
      "resource": "receivable",
      "status": "Pending",
      "recipient": "90827bfb071d4aa7a6240f07fdf1932f",
      "transaction": "53e5d80716e14bc59b1d0022d81c0fd7",
      "split_rule": null,
      "installment": "2",
      "liable": true,
      "amount": "12.48",
      "gross_amount": "13.00",
      "anticipation_fee": "0.00",
      "paid_at": null,
      "created_at": "2021-06-23 14:13:26",
      "transaction_created_at": "2021-06-23 14:13:25",
      "canceled_at": null,
      "expected_on": "2021-08-22 00:00:00",
      "authorization_code": "Z133937-000260004",
      "id_original_receivable": null,
      "prepaid": false
    }
  ],
  "count": 2,
  "total_count": 2
}

Este endpoint permite listar recebíveis.

Importante: para listar somente recebíveis ainda não pagos, o parâmetro status=Pending deve ser informado na URL.

Requisição HTTP

GET https://api.impay.com.br/v1/sellers/{seller_id}/receivables

Parâmetros de URL

Parâmetro	Obrigatório	Descrição
seller_id	Sim	ID do negócio vinculado à conta IM Pay
expected_on_start	Não	Data inicial para filtro
expected_on_end	Não	Data final para filtro
status	Não	Filtro por status
grouped	Não	Permite habilitar o agrupamento e totalização por data _expectedon. Ex.: grouped=1
offset	Não	Posição do primeiro registro
limit	Não	Limite de registros a serem retornados
sort	Não	Ordenação do registros, valores possíveis: expected_on -expected_on

Parâmetros de Header

Parâmetro	Obrigatório	Descrição
X-Api-Key	Sim	Chave de API

Obter Recebíveis Futuros

curl -X GET "https://api.impay.com.br/v1/sellers/{seller_id}/future-receivables" \
  --header "Accept: application/json" \
  --header "X-Api-Key: {api_key}"

200 OK

{
  "status": 200,
  "message": null,
  "data": {
    "total_amount": 211794.84
  }
}

Este endpoint lista o valor total de recebíveis previstos.

Requisição HTTP

GET https://api.impay.com.br/v1/sellers/{seller_id}/future-receivables

Parâmetros de URL

Parâmetro	Obrigatório	Descrição
seller_id	Sim	ID do negócio vinculado à sua conta IM Pay

Parâmetros de Header

Parâmetro	Obrigatório	Descrição
X-Api-Key	Sim	Chave de API

Obter Recebíveis por Transação

curl -X GET "https://api.impay.com.br/v1/sellers/{seller_id}/transactions/{transaction_id}/receivables" \
  --header "Accept: application/json" \
  --header "X-Api-Key: {api_key}"

200 OK

{
  "status": 200,
  "message": null,
  "data": [
    {
      "id": "3c71eb502f504456afd9507ca1ac3624",
      "resource": "receivable",
      "status": "Pending",
      "recipient": "90827bfb071d4aa7a6240f07fdf1932f",
      "transaction": "53e5d80716e14bc59b1d0022d81c0fd7",
      "split_rule": null,
      "installment": "1",
      "liable": true,
      "amount": "12.47",
      "gross_amount": "12.99",
      "anticipation_fee": "0.00",
      "paid_at": null,
      "created_at": "2021-06-23 14:13:26",
      "transaction_created_at": "2021-06-23 14:13:25",
      "canceled_at": null,
      "expected_on": "2021-07-23 00:00:00",
      "authorization_code": "Z133937-000260004",
      "id_original_receivable": null,
      "prepaid": false
    },
    {
      "id": "585ff7e7db6d421189a7eda871f48cfa",
      "resource": "receivable",
      "status": "Pending",
      "recipient": "90827bfb071d4aa7a6240f07fdf1932f",
      "transaction": "53e5d80716e14bc59b1d0022d81c0fd7",
      "split_rule": null,
      "installment": "2",
      "liable": true,
      "amount": "12.48",
      "gross_amount": "13.00",
      "anticipation_fee": "0.00",
      "paid_at": null,
      "created_at": "2021-06-23 14:13:26",
      "transaction_created_at": "2021-06-23 14:13:25",
      "canceled_at": null,
      "expected_on": "2021-08-22 00:00:00",
      "authorization_code": "Z133937-000260004",
      "id_original_receivable": null,
      "prepaid": false
    }
  ],
  "count": 2,
  "total_count": 2
}

Este endpoint lista os recebíveis por transação.

Requisição HTTP

GET https://api.impay.com.br/v1/sellers/{seller_id}/transactions/{transaction_id}/receivables

Parâmetros de URL

Parâmetro	Obrigatório	Descrição
seller_id	Sim	ID do negócio vinculado à sua conta IM Pay
transaction_id	Sim	ID da transação
offset	Não	Posição do primeiro registro
limit	Não	Limite de registros a serem retornados. Máximo: 500
sort	Não	Ordenação do registros, valores possíveis: expected_on -expected_on

Parâmetros de Header

Parâmetro	Obrigatório	Descrição
X-Api-Key	Sim	Chave de API

Clientes

Obter Clientes

curl -X GET "https://api.impay.com.br/v1/sellers/{seller_id}/customers" \
  --header "Accept: application/json" \
  --header "X-Api-Key: {api_key}"

200 OK

{
  "status": 200,
  "message": null,
  "data": [
    {
      "id": "6023b2e66d8649e983e3c88158b6206f",
      "status": "Active",
      "taxpayer_id": "02646367163",
      "first_name": "Fernando",
      "last_name": "Bonilha",
      "phone_number": "8442587337",
      "email": "felipe26@yahoo.com",
      "address": {
        "line1": "R. Jerônimo Faria",
        "line2": "Street",
        "line3": null,
        "neighborhood": "Centro",
        "city": "Manuela do Leste",
        "state_code": "AL",
        "postal_code": "46577861"
      },
      "created_at": "2022-03-25 08:57:02",
      "updated_at": "2022-03-25 08:57:02"
    },
    {
      "id": "85bd72bbffd44b7ab9a747941a0e851f",
      "status": "Active",
      "taxpayer_id": "37227210162",
      "first_name": "Demian",
      "last_name": "Escobar",
      "phone_number": "(48) 55555-5555",
      "email": "teste@emailteste1234.com.br",
      "address": {
        "line1": "R. Jerônimo Faria",
        "line2": "Street",
        "line3": null,
        "neighborhood": "Centro",
        "city": "Porto Valentina do Sul",
        "state_code": "CE",
        "postal_code": "06762501"
      },
      "created_at": "2022-03-25 08:52:43",
      "updated_at": "2022-03-25 08:57:05"
    }
  ],
  "count": 2,
  "total_count": 2
}

Este endpoint permite obter todos os clientes de um seller.

Requisição HTTP

GET https://api.impay.com.br/v1/sellers/{seller_id}/customers

Parâmetros de URL

Parâmetro	Obrigatório	Descrição
seller_id	Sim	ID do negócio vinculado à sua conta IM Pay

Parâmetros de Header

Parâmetro	Obrigatório	Descrição
X-Api-Key	Sim	Chave de API

Criar Cliente

curl -X POST "https://api.impay.com.br/v1/sellers/{seller_id}/customers" \
  --header "Content-Type: application/json" \
  --header "X-Api-Key: {api_key}" \
  --data '{
    "taxpayer_id": "372.272.101-62",
    "first_name": "Demian",
    "last_name": "Escobar",
    "email": "teste@emailteste12345.com.br",
    "phone_number": "(48) 55555-5555",
    "address": {
      "line1": "Av. da Silva, 58. Bloco C",
      "neighborhood": "Centro",
      "city": "Porto Valentina do Sul",
      "state_code": "CE",
      "postal_code": "06762501"
    }
  }'

200 OK

{
  "status": 200,
  "message": null,
  "data": {
    "id": "85bd72bbffd44b7ab9a747941a0e851f",
    "status": "Active",
    "taxpayer_id": "37227210162",
    "first_name": "Demian",
    "last_name": "Escobar",
    "phone_number": "(48) 55555-5555",
    "email": "teste@emailteste12345.com.br",
    "address": {
      "line1": "R. Jerônimo Faria",
      "line2": "Street",
      "line3": null,
      "neighborhood": "Centro",
      "city": "Porto Valentina do Sul",
      "state_code": "CE",
      "postal_code": "06762501"
    },
    "created_at": "2022-03-25 08:52:43",
    "updated_at": "2022-03-25 08:56:04"
  }
}

Este endpoint cria um registro de cliente.

Requisição HTTP

POST https://api.impay.com.br/v1/sellers/{seller_id}/customers

Parâmetros de URL

Parâmetro	Obrigatório	Descrição
seller_id	Sim	ID do negócio vinculado à sua conta IM Pay

Parâmetros de Header

Parâmetro	Obrigatório	Descrição
X-Api-Key	Sim	Chave de API

Parâmetros de Body

Parâmetro	Tipo	Obrigatório	Descrição
taxpayer_id	String	Sim	CPF ou CNPJ
first_name	String	Sim	Primeiro nome (ex.: João). Para pessoa jurídica, informar a razão social
last_name	String	Sim	Sobrenome (ex., Da Silva). Para Pessoa jurídica, deve ficar em branco (null)
email	String	Não	Email do cliente
phone_number	String	Não	Número do telefone
address.line1	String	Sim	Nome da rua/avenida e número da casa
address.line2	String	Não	Complemento
address.line3	String	Não	Complemento adicionla ou referência de endereço
address.neighborhood	String	Sim	Nome do Bairro
address.city	String	Sim	Nome da cidade
address.state_code	String	Sim	Código do estado com duas letras (ex., SP)
address.postal_code	String	Sim	CEP

Atualizar Cliente

curl -X PUT "https://api.impay.com.br/v1/sellers/{seller_id}/customers/{customer_id}" \
  --header "Accept: application/json" \
  --header "X-Api-Key: {api_key}" \
  --data '{
    "email": "teste@emailteste123.com.br"
  }'

200 OK

{
  "status": 200,
  "message": null,
  "data": {
    "id": "4fe534e4588f4cb2adf412c27d1e0813",
    "status": "Active",
    "taxpayer_id": "01145994083",
    "first_name": "Luciana",
    "last_name": "Correia",
    "phone_number": null,
    "email": "teste@emailteste123.com.br",
    "address": {
      "line1": "R. Jerônimo Faria",
      "line2": "Street",
      "line3": null,
      "neighborhood": "Centro",
      "city": "Lucas do Norte",
      "state_code": "RO",
      "postal_code": "44936137",
    },
    "created_at": "2021-11-03 09:56:01",
    "updated_at": "2021-11-03 09:56:01"
  }
}

Este endpoint permite atualizar dados de um cliente.

Requisição HTTP

PUT https://api.impay.com.br/v1/sellers/{seller_id}/customers/{customer_id}

Parâmetros de URL

Parâmetro	Obrigatório	Descrição
seller_id	Sim	ID do negócio vinculado à sua conta IM Pay
customer_id	Sim	ID do cliente

Parâmetros de Header

Parâmetro	Obrigatório	Descrição
X-Api-Key	Sim	Chave de API

Parâmetros de Body

Parâmetro	Tipo	Obrigatório	Descrição
email	String	Não	Email do cliente
phone_number	String	Não	Número do telefone
address.line1	String	Sim	Nome da rua/avenida e número da casa
address.line2	String	Não	Complemento
address.line3	String	Não	Complemento adicionla ou referência de endereço
address.neighborhood	String	Sim	Nome do Bairro
address.city	String	Sim	Nome da cidade
address.state_code	String	Sim	Código do estado com duas letras (ex., SP)
address.postal_code	String	Sim	CEP

Obter Cliente pelo ID

curl -X GET "https://api.impay.com.br/v1/sellers/{seller_id}/customers/{customer_id}" \
  --header "Accept: application/json" \
  --header "X-Api-Key: {api_key}"

200 OK

{
  "status": 200,
  "message": null,
  "data": {
    "id": "6023b2e66d8649e983e3c88158b6206f",
    "status": "Active",
    "taxpayer_id": "02646367163",
    "first_name": "Fernando",
    "last_name": "Bonilha",
    "phone_number": "8442587337",
    "email": "felipe26@yahoo.com",
    "address": {
      "line1": "R. Jerônimo Faria",
      "line2": "Street",
      "line3": null,
      "neighborhood": "Centro",
      "city": "Manuela do Leste",
      "state_code": "AL",
      "postal_code": "46577861"
    },
    "created_at": "2022-03-25 08:57:02",
    "updated_at": "2022-03-25 08:57:02"
  }
}

Este endpoint permite obter dados de um cliente.

Requisição HTTP

GET https://api.impay.com.br/v1/sellers/{seller_id}/customers/{customer_id}

Parâmetros de URL

Parâmetro	Obrigatório	Descrição
seller_id	Sim	ID do negócio vinculado à sua conta IM Pay
customer_id	Sim	ID do cliente

Parâmetros de Header

Parâmetro	Obrigatório	Descrição
X-Api-Key	Sim	Chave de API

Obter Cliente por Pesquisa

curl -X GET "https://api.impay.com.br/v1/sellers/{seller_id}/customers/find?search={query}" \
  --header "Accept: application/json" \
  --header "X-Api-Key: {api_key}"

200 OK

{
  "status": 200,
  "message": null,
  "data": {
    "id": "6023b2e66d8649e983e3c88158b6206f",
    "status": "Active",
    "taxpayer_id": "02646367163",
    "first_name": "Fernando",
    "last_name": "Bonilha",
    "phone_number": "8442587337",
    "email": "felipe26@yahoo.com",
    "address": {
      "line1": "R. Jerônimo Faria",
      "line2": "Street",
      "line3": null,
      "neighborhood": "Centro",
      "city": "Manuela do Leste",
      "state_code": "AL",
      "postal_code": "46577861"
    },
    "created_at": "2022-03-25 08:57:02",
    "updated_at": "2022-03-25 08:57:02"
  }
}

Este endpoint permite obter dados de um cliente por pesquisa (Nome, CPF/CNPJ, Telefone ou E-mail).

Requisição HTTP

GET https://api.impay.com.br/v1/sellers/{seller_id}/customers/find?search={query}

Parâmetros de URL

Parâmetro	Obrigatório	Descrição
seller_id	Sim	ID do negócio vinculado à sua conta IM Pay
search	Sim	Informações do cliente: Nome, CPF/CNPJ, Telefone ou Email

Parâmetros de Header

Parâmetro	Obrigatório	Descrição
X-Api-Key	Sim	Chave de API

Remover Cliente

curl -X DELETE "https://api.impay.com.br/v1/sellers/{seller_id}/customers/{customer_id}" \
  --header "Accept: application/json" \
  --header "X-Api-Key: {api_key}"

200 OK

{
  "status": 200,
  "message": null,
  "data": {
    "id": "f69d9341d5b94c7989091aa128447093",
    "deleted": true
  }
}

Este endpoint permite remover o registro de um cliente.

Requisição HTTP

DELETE https://api.impay.com.br/v1/sellers/{seller_id}/customers/{customer_id}

Parâmetros de URL

Parâmetro	Obrigatório	Descrição
seller_id	Sim	ID do negócio vinculado à sua conta IM Pay
customer_id	Sim	ID do cliente

Parâmetros de Header

Parâmetro	Obrigatório	Descrição
X-Api-Key	Sim	Chave de API

Contas Bancárias

Adicionar Conta Bancária

curl -X POST "https://api.impay.com.br/v1/sellers/{seller_id}/bank-accounts" \
  --header "Content-Type: application/json" \
  --header "X-Api-Key: {api_key}" \
  --data '{
    "bank_code": "341",
    "routing_number": "8607",
    "account_number": "59443-2",
    "seller_type": "Company",
    "holder_name": "Razão Social Ltda. - ME",
    "taxpayer_id": null,
    "ein": "37244432000158",
    "type": "Checking"
  }'

200 OK

{
  "status": 200,
  "message": null,
  "data": {
    "id": "266be93b8fc5421d9f09dee749d8fff7"
  },
}

Este endpoint adiciona uma conta bancária a um negócio.

Requisição HTTP

POST https://api.impay.com.br/v1/sellers/{seller_id}/bank-accounts

Parâmetros de URL

Parâmetro	Obrigatório	Descrição
seller_id	Sim	ID do negócio vinculado à conta IM Pay

Parâmetros de Header

Parâmetro	Obrigatório	Descrição
X-Api-Key	Sim	Chave de API

Parâmetros de Body

Parâmetro	Tipo	Obrigatório	Descrição
bank_code	String	Sim	Código do banco.
routing_number	String	Sim	Número da Agência sem DV.
account_number	String	Sim	Número da agência com DV.
seller_type	String	Sim	Tipo de correntista: Company para empresa Individual para pessoa física
holder_name	String	Sim	Nome do correntista.
taxpayer_id	String	Sim	CPF para pessoa física. Nulo para pessoa jurídica
ein	String	Sim	CNPJ para pessoa jurídica. Nulo para pessoa física
type	String	Sim	Tipo de conta: Checking para conta corrente Savings para poupança

Obter Lista de Contas Bancárias

curl -X GET "https://api.impay.com.br/v1/sellers/{seller_id}/bank-accounts" \
  --header "Accept: application/json" \
  --header "X-Api-Key: {api_key}"

200 OK

{
  "status": 200,
  "message": null,
  "data": [
    {
      "id": "e92a845186404be9a284e8c1fe7652f8",
      "resource": "bank_account",
      "holder_name": "Razão Social Ltda. - ME",
      "taxpayer_id": "37244432000111",
      "description": null,
      "bank_name": "Itaú Unibanco S.A.",
      "bank_code": "341",
      "type": "Savings",
      "last4_digits": "594431",
      "account_number": "594431",
      "country_code": "BR",
      "routing_number": "8607",
      "routing_check_digit": null,
      "phone_number": null,
      "is_active": true,
      "is_verified": false,
      "debitable": false,
      "customer": "90827bfb071d4aa7a6240f07fdf1932f",
      "fingerprint": "6e2fe3ef72d40924a65f3ded6868cf5442b47706e94316a3ad45f78eb6f9f0d3",
      "address": null,
      "verification_checklist": {
        "postal_code_check": "unchecked",
        "address_line1_check": "unchecked",
        "deposit_check": "unchecked"
      },
      "metadata": [],
      "created_at": "2021-07-12T12:12:52+00:00",
      "updated_at": "2021-07-12T12:12:52+00:00"
    }
  ],
  "count": 1,
  "total_count": 1
}

Este endpoint permite obter uma lista das contas bancárias associadas.

Requisição HTTP

GET https://api.impay.com.br/v1/sellers/{seller_id}/bank-accounts

Parâmetros de URL

Parâmetro	Obrigatório	Descrição
seller_id	Sim	ID do negócio vinculado à sua conta IM Pay

Parâmetros de Header

Parâmetro	Obrigatório	Descrição
X-Api-Key	Sim	Chave de API

Obter Conta Bancária

curl -X GET "https://api.impay.com.br/v1/sellers/{seller_id}/bank-accounts/{bank_account_id}" \
  --header "Accept: application/json" \
  --header "X-Api-Key: {api_key}"

200 OK

{
  "status": 200,
  "message": null,
  "data": {
    "id": "e92a845186404be9a284e8c1fe7652f8",
    "resource": "bank_account",
    "holder_name": "Razão Social Ltda. - ME",
    "taxpayer_id": "37244432000111",
    "description": null,
    "bank_name": "Itaú Unibanco S.A.",
    "bank_code": "341",
    "type": "Savings",
    "last4_digits": "594431",
    "account_number": "594431",
    "country_code": "BR",
    "routing_number": "8607",
    "routing_check_digit": null,
    "phone_number": null,
    "is_active": true,
    "is_verified": false,
    "debitable": false,
    "customer": "90827bfb071d4aa7a6240f07fdf1932f",
    "fingerprint": "6e2fe3ef72d40924a65f3ded6868cf5442b47706e94316a3ad45f78eb6f9f0d3",
    "address": null,
    "verification_checklist": {
      "postal_code_check": "unchecked",
      "address_line1_check": "unchecked",
      "deposit_check": "unchecked"
    },
    "metadata": [],
    "created_at": "2021-07-12T12:12:52+00:00",
    "updated_at": "2021-07-12T12:12:52+00:00"
  }
}

Este endpoint permite obter dados de uma conta bancária previamente associada.

Requisição HTTP

GET https://api.impay.com.br/v1/sellers/{seller_id}/bank-accounts/{bank_account_id}

Parâmetros de URL

Parâmetro	Obrigatório	Descrição
seller_id	Sim	ID do negócio vinculado à sua conta IM Pay
bank_account_id	Sim	ID da conta bancária

Parâmetros de Header

Parâmetro	Obrigatório	Descrição
X-Api-Key	Sim	Chave de API

Excluir Conta Bancária

curl -X DELETE "https://api.impay.com.br/v1/sellers/{seller_id}/bank-accounts/{bank_account_id}" \
  --header "Content-Type: application/json" \
  --header "X-Api-Key: {api_key}"

200 OK

{
  "status": 200,
  "message": null,
  "data": {
    "id": "91b5b0ead72a41f99e17ce335f5c5a5b",
    "resource": "bank_account",
    "deleted": true
  },
}

Este endpoint remove uma conta bancária associada.

Requisição HTTP

DELETE https://api.impay.com.br/v1/sellers/{seller_id}/bank-accounts/{bank_account_id}

Parâmetros de URL

Parâmetro	Obrigatório	Descrição
seller_id	Sim	ID do negócio vinculado à sua conta IM Pay
bank_account_id	Sim	ID da conta

Parâmetros de Header

Parâmetro	Obrigatório	Descrição
X-Api-Key	Sim	Chave de API

Bancos

Obter Lista de Bancos

Request

curl -X GET "https://api.impay.com.br/v1/banks" \
  --header "Accept: application/json" \
  --header "X-Api-Key: {api_key}"

200 OK

{
  "status": 200,
  "message": null,
  "data": [
    {
      "code": "001",
      "name": "Banco do Brasil S.A."
    },
    (...)
  ],
  "count": 100,
  "total_count": 192,
}

Este endpoint retorna a lista dos bancos disponíveis.

Requisição HTTP

GET https://api.impay.com.br/v1/banks

Parâmetros de URL

Parâmetro	Obrigatório	Descrição
q	Não	Busca pelo nome do banco (query string)

Parâmetros de Header

Parâmetro	Obrigatório	Descrição
X-Api-Key	Sim	Chave de API

Política de Recebimento

Criar Política de Recebimento

curl -X POST "https://api.impay.com.br/v1/sellers/{seller_id}/receiving-policies" \
  --header "Content-Type: application/json" \
  --header "X-Api-Key: {api_key}" \
  --data '{
    "transfer_enabled": true,
  }'

200 OK

{
  "status": 200,
  "message": null,
  "data": {
    "id": "1181da505f5a40dbad604e91cf2eec0c",
    "transfer_interval": "daily",
    "transfer_day": null,
    "transfer_enabled": true,
    "minimum_transfer_value": 100
  }
}

Este endpoint permite alterar a política de saque.

Requisição HTTP

POST https://api.impay.com.br/v1/sellers/{seller_id}/receiving-policies

Parâmetros de URL

Parâmetro	Obrigatório	Descrição
seller_id	Sim	ID do negócio vinculado à sua conta IM Pay

Parâmetros de Header

Parâmetro	Obrigatório	Descrição
X-Api-Key	Sim	Chave de API

Parâmetros de Body

Parâmetro	Tipo	Obrigatório	Descrição
transfer_enabled	Boolean	Sim	true para automático false para manual

Obter Política de Recebimento

curl -X GET "https://api.impay.com.br/v1/sellers/{seller_id}/receiving-policies" \
  --header "Content-Type: application/json" \
  --header "X-Api-Key: {api_key}" \

200 OK

{
  "status": 200,
  "message": null,
  "data": {
    "id": "1181da505f5a40dbad604e91cf2eec0c",
    "transfer_interval": "daily",
    "transfer_day": null,
    "transfer_enabled": null,
    "minimum_transfer_value": 100
  }
}

Este endpoint permite obter os dados da política de saque.

Requisição HTTP

GET https://api.impay.com.br/v1/sellers/{seller_id}/receiving-policies

Parâmetros de URL

Parâmetro	Obrigatório	Descrição
seller_id	Sim	ID do negócio vinculado à sua conta IM Pay

Parâmetros de Header

Parâmetro	Obrigatório	Descrição
X-Api-Key	Sim	Chave de API

Transferência

Criar Transferência

curl -X POST "https://api.impay.com.br/v1/sellers/{seller_id}/bank-transfers" \
  --header "Content-Type: application/json" \
  --header "X-Api-Key: {api_key}" \
  --data '{
    "bank_account_id": "7dfe7f0716614ebe9d40897566c009be",
    "amount": 1,
    "description": "Withdrawal to bank account"
  }'

200 OK

{
  "status": 200,
  "message": null,
  "data": {
    "id": "0240cdfab0d64acb893da01bc07a1bdb",
    "resource": "transfer",
    "type": "payout_manual",
    "status": "pending",
    "status_detail": null,
    "recipient": "90827bfb071d4aa7a6240f07fdf1932f",
    "sender": "90827bfb071d4aa7a6240f07fdf1932f",
    "amount": "0.01",
    "original_amount": "0.01",
    "currency": "BRL",
    "description": "Withdrawal to bank account",
    "transfer_number": null,
    "statement_descriptor": "IM Pay",
    "bank_account": {
      "id": "7dfe7f0716614ebe9d40897566c009be",
      "resource": "bank_account",
      "holder_name": "IM PAY PAGAMENTOS",
      "taxpayer_id": "37244432000158",
      "description": null,
      "bank_name": "Itaú Unibanco S.A.",
      "bank_code": "341",
      "type": "Savings",
      "account_number": "594432",
      "country_code": "BR",
      "routing_number": "8607",
      "routing_check_digit": null,
      "phone_number": null,
      "is_active": true,
      "is_verified": false,
      "debitable": false,
      "customer": "90827bfb071d4aa7a6240f07fdf1932f",
      "fingerprint": "6e2fe3ef72d40924a65f3ded6868cf5442b47706e94316a3ad45f78eb6f9f0d3",
      "address": null,
      "verification_checklist": {
        "postal_code_check": "unchecked",
        "address_line1_check": "unchecked",
        "deposit_check": "unchecked"
      },
      "metadata": [],
      "created_at": "2021-11-11 13:58:08",
      "updated_at": "2021-11-11 13:58:08"
    },
    "transactions": [],
    "location_latitude": null,
    "location_longitude": null,
    "metadata": [],
    "confirmed": "0",
    "created_at": "2022-02-14 15:04:02",
    "updated_at": "2022-02-14 15:04:02",
    "transfer_date": "2022-02-14 15:04:02"
  }
}

Requisição HTTP

POST https://api.impay.com.br/v1/sellers/{seller_id}/bank-transfers

Parâmetros de URL

Parâmetro	Obrigatório	Descrição
seller_id	Sim	ID de seller vinculado à sua conta IM Pay

Parâmetros de Header

Parâmetro	Obrigatório	Descrição
X-Api-Key	Sim	Chave de API

Parâmetros de Body

Parâmetro	Tipo	Obrigatório	Descrição
bank_account_id	String	Sim	ID da conta bancária
amount	Integer	Sim	Valor da transferência em centavos
description	String	Sim	Descrição da transferência

Obter Lista de Transferências

curl -X GET "https://api.impay.com.br/v1/sellers/{seller_id}/bank-transfers" \
  --header "Content-Type: application/json" \
  --header "X-Api-Key: {api_key}"

200 OK

{
  "status": 200,
  "message": null,
  "data": [
    {
      "id": "0240cdfab0d64acb893da01bc07a1bdb",
      "resource": "transfer",
      "status": "pending",
      "status_detail": null,
      "recipient": "90827bfb071d4aa7a6240f07fdf1932f",
      "sender": "90827bfb071d4aa7a6240f07fdf1932f",
      "amount": "0.01",
      "original_amount": "0.01",
      "currency": "BRL",
      "description": "Withdrawal to bank account",
      "transfer_number": null,
      "statement_descriptor": "IM Pay",
      "bank_account": {
        "id": "7dfe7f0716614ebe9d40897566c009be",
        "resource": "bank_account",
        "holder_name": "IM PAY PAGAMENTOS",
        "taxpayer_id": "37244432000158",
        "description": null,
        "bank_name": "Itaú Unibanco S.A.",
        "bank_code": "341",
        "type": "Savings",
        "account_number": "594432",
        "country_code": "BR",
        "routing_number": "8607",
        "routing_check_digit": null,
        "phone_number": null,
        "is_active": true,
        "is_verified": false,
        "debitable": false,
        "customer": "90827bfb071d4aa7a6240f07fdf1932f",
        "fingerprint": "6e2fe3ef72d40924a65f3ded6868cf5442b47706e94316a3ad45f78eb6f9f0d3",
        "address": null,
        "verification_checklist": {
          "postal_code_check": "unchecked",
          "address_line1_check": "unchecked",
          "deposit_check": "unchecked"
        },
        "metadata": [],
        "created_at": "2021-11-11 13:58:08",
        "updated_at": "2021-11-11 13:58:08"
      },
      "transactions": [],
      "location_latitude": null,
      "location_longitude": null,
      "metadata": [],
      "type": "payout_manual",
      "created_at": "2022-02-14 15:04:02",
      "updated_at": "2022-02-14 15:04:02",
      "transfer_date": "2022-02-14 15:04:02",
      "confirmed": "0"
    },
    {
      "id": "a42e46390da24db1b559bf39daf3d18d",
      "resource": "transfer",
      "status": "pending",
      "status_detail": null,
      "recipient": "90827bfb071d4aa7a6240f07fdf1932f",
      "sender": "90827bfb071d4aa7a6240f07fdf1932f",
      "amount": "0.01",
      "original_amount": "0.01",
      "currency": "BRL",
      "description": "Withdrawal to bank account",
      "transfer_number": null,
      "statement_descriptor": "IM Pay",
      "bank_account": {
        "id": "7dfe7f0716614ebe9d40897566c009be",
        "resource": "bank_account",
        "holder_name": "IM PAY PAGAMENTOS",
        "taxpayer_id": "37244432000158",
        "description": null,
        "bank_name": "Itaú Unibanco S.A.",
        "bank_code": "341",
        "type": "Savings",
        "account_number": "594432",
        "country_code": "BR",
        "routing_number": "8607",
        "routing_check_digit": null,
        "phone_number": null,
        "is_active": true,
        "is_verified": false,
        "debitable": false,
        "customer": "90827bfb071d4aa7a6240f07fdf1932f",
        "fingerprint": "6e2fe3ef72d40924a65f3ded6868cf5442b47706e94316a3ad45f78eb6f9f0d3",
        "address": null,
        "verification_checklist": {
          "postal_code_check": "unchecked",
          "address_line1_check": "unchecked",
          "deposit_check": "unchecked"
        },
        "metadata": [],
        "created_at": "2021-11-11 13:58:08",
        "updated_at": "2021-11-11 13:58:08"
      },
      "transactions": [],
      "location_latitude": null,
      "location_longitude": null,
      "metadata": [],
      "type": "payout_manual",
      "created_at": "2022-02-14 15:02:33",
      "updated_at": "2022-02-14 15:02:33",
      "transfer_date": "2022-02-14 15:02:33",
      "confirmed": "0"
    }
  ],
  "count": 2,
  "total_count": 2
}

Requisição HTTP

GET https://api.impay.com.br/v1/sellers/{seller_id}/bank-transfers

Parâmetros de URL

Parâmetro	Obrigatório	Descrição
seller_id	Sim	ID de seller vinculado à sua conta IM Pay
date_range_start	Não	Data inicial para filtro
date_range_end	Não	Data final para filtro
amount_range_start	Não	Filtro por faixa de valor (início, inclusive)
amount_range_end	Não	Filtro por faixa de valor (final, inclusive)

Parâmetros de Header

Parâmetro	Obrigatório	Descrição
X-Api-Key	Sim	Chave de API

Obter Transferência

curl -X GET "https://api.impay.com.br/v1/sellers/{seller_id}/bank-transfers/{transfer_id}" \
  --header "Content-Type: application/json" \
  --header "X-Api-Key: {api_key}"

200 OK

{
  "status": 200,
  "message": null,
  "data": {
    "id": "59dcded12d904b38af2ac194fd04d467",
    "resource": "transfer",
    "type": "payout_manual",
    "status": "pending",
    "status_detail": null,
    "recipient": "90827bfb071d4aa7a6240f07fdf1932f",
    "sender": "90827bfb071d4aa7a6240f07fdf1932f",
    "amount": "0.01",
    "original_amount": "0.01",
    "currency": "BRL",
    "description": "Withdrawal to bank account",
    "transfer_number": null,
    "statement_descriptor": "IM Pay",
    "bank_account": {
      "id": "7dfe7f0716614ebe9d40897566c009be",
      "resource": "bank_account",
      "holder_name": "IM PAY PAGAMENTOS",
      "taxpayer_id": "37244432000158",
      "description": null,
      "bank_name": "Itaú Unibanco S.A.",
      "bank_code": "341",
      "type": "Savings",
      "account_number": "594432",
      "country_code": "BR",
      "routing_number": "8607",
      "routing_check_digit": null,
      "phone_number": null,
      "is_active": true,
      "is_verified": false,
      "debitable": false,
      "customer": "90827bfb071d4aa7a6240f07fdf1932f",
      "fingerprint": "6e2fe3ef72d40924a65f3ded6868cf5442b47706e94316a3ad45f78eb6f9f0d3",
      "address": null,
      "verification_checklist": {
        "postal_code_check": "unchecked",
        "address_line1_check": "unchecked",
        "deposit_check": "unchecked"
      },
      "metadata": [],
      "created_at": "2021-11-11 13:58:08",
      "updated_at": "2021-11-11 13:58:08"
    },
    "transactions": [],
    "location_latitude": null,
    "location_longitude": null,
    "metadata": [],
    "confirmed": "0",
    "created_at": "2022-02-14 16:46:23",
    "updated_at": "2022-02-14 16:46:23",
    "transfer_date": "2022-02-14 16:46:23"
  }
}

Requisição HTTP

GET https://api.impay.com.br/v1/sellers/{seller_id}/bank-transfers/{transfer_id}

Parâmetros de URL

Parâmetro	Obrigatório	Descrição
seller_id	Sim	ID de seller vinculado à sua conta IM Pay

Parâmetros de Header

Parâmetro	Obrigatório	Descrição
X-Api-Key	Sim	Chave de API