Isipag Documentation
Transcrição
Isipag Documentation
Isipag Documentation Release 1.0.0 Polibrasnet December 14, 2015 Contents 1 Escopos de permissões 1 2 Obtendo um token de acesso 3 3 Gateways disponíveis 5 4 Criando um comerciante 7 5 Configurando um usuário comerciante 11 6 Configurando um gateway do comerciante 13 7 Gerando um token de cartão de crédito 15 8 Solicitando uma pré-autorização 17 9 Capturando um pagamento autorizado 21 10 Estornando um pagamento capturado 25 11 Consultando um pagamento 29 12 Sumário 33 HTTP Routing Table 35 i ii CHAPTER 1 Escopos de permissões • apps: Usuários permitidos a este escopo podem gerenciar aplicações. • merchants: Usuários permitidos a este escopo podem gerenciar comerciantes. • payments: Usuários permitidos a este escopo podem criar pagamentos. • tokenizer: Usuários permitidos a este escopo podem gerar tokens de cartão. 1 Isipag Documentation, Release 1.0.0 2 Chapter 1. Escopos de permissões CHAPTER 2 Obtendo um token de acesso POST /oauth/token Obtem um token de acesso Form Parameters • string grant_type – Tipo de autorização. Deve ser ‘client_credentials’. Obrigatório • string scopes – Escopos a serem solicitados Request Headers • Authorization – Basic Authorization. Basic base64(client_id:client_secret) Requisição exemplo: POST /oauth/token HTTP/1.1 Host: gateway.isilist.com.br Accept: application/json, version=1.0 Authorization: Basic YzJlNTJkMjYtYjhkNi00ODM5LWJlNzctNDczZjRjN2NlMzI5OmMyZTUyZDI2LWI4ZDYtNDgzOS1 Content-Type: plain/text grant_type=client_credentials Resposta exemplo (200): { "access_token": "WXpKbE5USmtNall0WWpoa05pMDBPRE01TFdKbE56Y3RORGN6WmpSak4yTmxNekk1T21NeVpUVXl "token_type": "Bearer", "expires_in": 36000, "scope": "payments" } Status Codes • 200 OK – no error • 401 Unauthorized – invalid OAuth credentials • 403 Forbidden – permission denied given the credentials • 400 Bad Request – invalid input parameters 3 Isipag Documentation, Release 1.0.0 4 Chapter 2. Obtendo um token de acesso CHAPTER 3 Gateways disponíveis • sandbox • cielo (em desenvolvimento) • rede (em desenvolvimento) 5 Isipag Documentation, Release 1.0.0 6 Chapter 3. Gateways disponíveis CHAPTER 4 Criando um comerciante Important: Um comerciante representa uma entidade associada à uma aplicação. POST /merchants/create •Cria um novo comerciante •Escopo OAuth necessário: merchants •É opcional passar as configurações do merchant e as configurações da adquirente Request Headers • Authorization – Bearer Token JSON Parameters • email (string) – E-mail do usuário • name (string) – Nome • password (string) – Senha • password_confirmation (string) – Confirmação da Senha • settings (object) – Configurações do merchant Opcional • settings.main_gateway (string) – Gateway principal obrigtório • settings.production (string) – Indica se o gateway será utilizado no modo produção (true) ou testes(false) obrigatório • settings.return_url (string) – URL de retorno padrão a qual será enviado o resultado das operações obrigatório • gateways (object) – Lista de configurações de adquirentes Opcional • gateway.gateway (string) – Gateway que será configurado - obrigatório • gateway.affiliation (string) – Número de filiação do estabelecimento com a adquirente/gateway obrigatório • gateway.affiliation_key (string) – Chave secreta de filiação do estabelecimento com a adquirente/gateway obrigatório • gateway.accepted_payments (string) – Pagamentos aceitos por este gateway obrigatório • gateway.currency (string) – Moedas aceitas por este gateway obrigatório 7 Isipag Documentation, Release 1.0.0 • gateway.fallback_gateway (string) – Gateway secundário caso este gateway não consiga processar a operação opcional • gateway.query_user (string) – Usuário cadastrado na adquirente utilizado para operações de consultas opcional • gateway.query_pass (string) – Senha do usuário na adquirente utilizado para operações de consultas opcional Requisição exemplo: POST /merchants/create HTTP/1.1 Host: gateway.isilist.com.br Accept: application/json, version=1.0 Authorization: Bearer WXpKbE5USmtNall0WWpoa05pMDBPRE01TFdKbE56Y3RORGN6WmpSak4yTmxNekk1T21NeVpUVX Content-Type: application/json { "email": "[email protected]", "name": "John", "password": "hPbzjd4n", "password_confirmation": "hPbzjd4n" } Resposta exemplo (200): { "id": "6f32d19f-ac65-457e-84d8-08c406ba9545", "email": "[email protected]", "name": "John", "api_key": "3e5d5ac9c9294d1baf309a92b3079520" "created_at: "2015-10-14 14:33:43", "modified_at: "2015-10-14 14:33:43" } Requisição exemplo: POST /merchants/create HTTP/1.1 Host: gateway.isilist.com.br Accept: application/json, version=1.0 Authorization: Bearer WXpKbE5USmtNall0WWpoa05pMDBPRE01TFdKbE56Y3RORGN6WmpSak4yTmxNekk1T21NeVpUVX Content-Type: application/json { "email": "[email protected]", "name": "John", "password": "hPbzjd4n", "password_confirmation": "hPbzjd4n", "settings": { "main_gateway": "cielo", "production": False, "return_url": "https://sandbox.isilist.com.net.br", }, "gateways": [{ "gateway": "cielo", "affiliation": "1231311", "affiliation_key": "25fbb99741c739dd84d7b06ec78c9bac718838630f30b112d033ce2e621b34f3", "accepted_payments": "visa,mastercard", "currency": "BRL", 8 Chapter 4. Criando um comerciante Isipag Documentation, Release 1.0.0 }] } Resposta exemplo (200): { "id": "6f32d19f-ac65-457e-84d8-08c406ba9545", "email": "[email protected]", "name": "John", "api_key": "3e5d5ac9c9294d1baf309a92b3079520" "created_at: "2015-10-14 14:33:43", "modified_at: "2015-10-14 14:33:43" "settings": { "main_gateway": "cielo", "production": False, "return_url": "https://sandbox.isilist.com.net.br", }, "gateways": [{ "gateway": "cielo", "affiliation": "1231311", "affiliation_key": "25fbb99741c739dd84d7b06ec78c9bac718838630f30b112d033ce2e621b34f3", "accepted_payments": "visa,mastercard", "currency": "BRL", }] } Status Codes • 200 OK – no error • 401 Unauthorized – invalid OAuth credentials • 403 Forbidden – permission denied given the credentials • 400 Bad Request – invalid input parameters 9 Isipag Documentation, Release 1.0.0 10 Chapter 4. Criando um comerciante CHAPTER 5 Configurando um usuário comerciante POST /merchants/settings/ •Configura um comerciante •Escopo OAuth necessário: merchants Request Headers • Authorization – Bearer Token • X-Merchant-Key – Merchant API Key JSON Parameters • main_gateway (string) – Gateway principal - obrigatório • production (string) – Indica se o gateway será utilizado no modo produção (true) ou testes(false) obrigatório • return_url (string) – URL de retorno padrão a qual será enviado o resultado das operações obrigatório Requisição exemplo: POST /merchants/settings HTTP/1.1 Host: gateway.isilist.com.br Accept: application/json, version=1.0 Authorization: Bearer WXpKbE5USmtNall0WWpoa05pMDBPRE01TFdKbE56Y3RORGN6WmpSak4yTmxNekk1T21NeVpUVX X-Merchant-Key: 3e5d5ac9c9294d1baf309a92b3079520 Content-Type: application/json { "main_gateway": "sandbox", "production": false, "return_url": "https://sandbox.isilist.com.br/gateway/return", } Resposta exemplo (200): { "success": true } Status Codes • 200 OK – no error 11 Isipag Documentation, Release 1.0.0 • 401 Unauthorized – invalid OAuth credentials • 403 Forbidden – permission denied given the credentials • 400 Bad Request – invalid input parameters 12 Chapter 5. Configurando um usuário comerciante CHAPTER 6 Configurando um gateway do comerciante POST /merchants/gateway/ •Configura um comerciante •Escopo OAuth necessário: merchants Request Headers • Authorization – Bearer Token • X-Merchant-Key – Merchant API KEY JSON Parameters • gateway (string) – Gateway que será configurado - obrigatório • affiliation (string) – Número adquirente/gateway obrigatório de filiação do estabelecimento com a • affiliation_key (string) – Chave secreta de filiação do estabelecimento com a adquirente/gateway obrigatório • accepted_payments (string) – Pagamentos aceitos por este gateway obrigatório • currency (string) – Moedas aceitas por este gateway obrigatório • fallback_gateway (string) – Gateway secundário caso este gateway não consiga processar a operação opcional • query_user (string) – Usuário cadastrado na adquirente utilizado para operações de consultas opcional • query_pass (string) – Senha do usuário na adquirente utilizado para operações de consultas opcional Requisição exemplo: POST /merchants/gateway HTTP/1.1 Host: gateway.isilist.com.br Accept: application/json, version=1.0 Authorization: Bearer WXpKbE5USmtNall0WWpoa05pMDBPRE01TFdKbE56Y3RORGN6WmpSak4yTmxNekk1T21NeVpUVX X-Merchant-Key: 3e5d5ac9c9294d1baf309a92b3079520 Content-Type: application/json { "gateway": "sandbox", "affiliation": "1006993069", 13 Isipag Documentation, Release 1.0.0 "affiliation_key": "25fbb997438630f30b112d033ce2e621b34f3", "accepted_payments": "visa,mastercard", "currency": "BRL,USD", "fallback_gateway": "cielo" } Resposta exemplo (200): { "success": true } Status Codes • 200 OK – no error • 400 Bad Request – invalid input parameters • 400 Bad Request – invalid gateway • 401 Unauthorized – invalid OAuth credentials • 401 Unauthorized – invalid X-Merchant-Key • 403 Forbidden – permission denied given the credentials 14 Chapter 6. Configurando um gateway do comerciante CHAPTER 7 Gerando um token de cartão de crédito Important: Todas as transações ao Isipag são realizadas com um token de cartão POST /tokens/card •Gera um novo identificador de cartão •Escopo OAuth necessário: tokenizer Request Headers • Authorization – Bearer Token Request JSON Object • number (string) – Número do cartão de crédito. obrigatório • type (string) – Bandeira do cartão de crédito. obrigatório • expire_month (number) – Mês de expiração do cartão de crédito. obrigatório • expire_year (number) – Ano de expiração do cartão de crédito. obrigatório • cvv (number) – Código de segurança do cartão de crédito. obrigatório • name_on_card (string) – Nome do portador como escrito no cartão de crédito. obrigatório • billing_address (object) – Endereço de cobrança do cartão de crédito. opcional • billing_address.address (string) – Endereço opcional • billing_address.number (string) – Número opcional • billing_address.borough (string) – Bairro opcional • billing_address.city (string) – Cidade opcional • billing_address.state_code (string) – Código do Estado opcional • billing_address.postal_code (string) – CEP opcional • billing_address.country_code (string) – Código do País opcional Requisição exemplo: 15 Isipag Documentation, Release 1.0.0 POST /tokens/card HTTP/1.1 Host: gateway.isilist.com.br Accept: application/json, version=1.0 Authorization: Bearer WXpKbE5USmtNall0WWpoa05pMDBPRE01TFdKbE56Y3RORGN6WmpSak4yTmxNekk1T21NeVpUVX Content-Type: application/json { "number":"5493022963692972", "type":"mastercard", "expire_month":12, "expire_year":2018, "cvv":874, "name_on_card":"Jõao R Alves", "billing_address":{ "address":"Rua Freitas", "number":"358", "borough":"Centro", "city":"Aquiraz", "state_code":"CE", "postal_code":"60594-343", "country_code":"BR" } } Resposta exemplo (200): { "identifier": "6f32d19f-ac65-457e-84d8-08c406ba9545", "token": "poVBF2Bwv4UOTp9K", "content": "gAAAAABWOOIDLjVZrCAgvXBHLGx868kFpxkpXDMgZ8QrCgdyuUqHmCEzPOrnvV90Hci_5Tl7EuuPwUs0 "mask_number": "**********2972", "mask_brand": "mastercard", "mask_exp": "12/2018", "name_on_card": "Jõao R Alves" } Status Codes • 200 OK – no error • 400 Bad Request – invalid credit card • 401 Unauthorized – invalid OAuth credentials • 403 Forbidden – permission denied given the credentials • 400 Bad Request – invalid input parameters 16 Chapter 7. Gerando um token de cartão de crédito CHAPTER 8 Solicitando uma pré-autorização POST /payments/request Realiza uma pré-autorização de pagamento utilizando a tokenização do cartão. Important: Você deve possuir um token de cartão antes de utilizar esta operação. Request Headers • Authorization – Bearer Token • X-Merchant-Key – Merchant API Key Request JSON Object • merchant_order_number (string) – Identificador da transação do comerciante, será retornada no sucesso ou erro da transação. • name (string) – Nome do cliente. • document (string) – Documento(CPF ou CNPJ) do cliente. • email (string) – E-mail do cliente. • birth_date (string) – Date de nascimento (ISO-8601). • payment_type (string) – Identificador do tipo de pagamento. • card (object) – Informações do cartão de crédito. • card.identifier (string) – Identificador do cartão de crédito. • card.token (string) – Token identificador do cartão de crédito. • card.content (string) – Conteúdo de resultado da tokenização do cartão de crédito. • custom_payload (object) – Informações que poderão ser enviadas para auxiliarem na identificação deste pagamento no retorno da requisição. Utilize um objeto JSON de no máximo de 500 caracteres. • currency (string) – Moeda. • instalments (number) – Número de parcelas. • soft_descriptor (string) – Texto utilizado para ser exibido na fatura do cliente. • auto_capture (boolean) – Indica se a transação poderá ser capturada automaticamente. Response JSON Object • transaction_id (string) – Identificador da transação gerado pelo Isipag. 17 Isipag Documentation, Release 1.0.0 • transaction_status (string) – Identificador da transação gerado pelo Isipag. • merchant_order_number (string) – Identificador da transação informado pelo comerciante. • payment_method (string) – Identificador do tipo de pagamento. • custom_payload (object) – Objeto que poderá ser utilizado com quaisquer informações, será retornado no sucesso da requisição • created_at (date) – Data de criação do pagamento. • modified_at (date) – Data da última modificação do pagamento. • authorized_at (date) – Data de autorização do pagamento. Nula se não estiver autorizado. • captured_at (date) – Data da captura do pagamento. Nula se não estiver capturado. • canceled_at (date) – Data de cancelamento do pagamento. Nula se não estiver cancelado. • refunded_at (date) – Data de estorno do pagamento. Nula se não estiver estornado. • invalidated_at (date) – Data que a transação se tornou inválida. Nula se não estiver inválida. • gateway (string) – Identificador do gateway/adquirente utilizado para processar o pagamento. • authorization_code (string) – Código de autorização da transação. • nsu_code (string) – Código NSU da transação. • fraud_analyzed_at (date) – Data de resposta de uma análise anti-fraude • fraud_analysis_risk (int) – Gráu de risco de uma transação • auto_capture (boolean) – Indica se a transação foi capturada automaticamente após autorização Requisição exemplo: POST /payments/request HTTP/1.1 Host: gateway.isilist.com.br Accept: application/json, version=1.0 Authorization: Bearer WXpKbE5USmtNall0WWpoa05pMDBPRE01TFdKbE56Y3RORGN6WmpSak4yTmxNekk1T21NeVpUVX X-Merchant-Key: 3e5d5ac9c9294d1baf309a92b3079520 Content-Type: application/json { "payment_method": "visa", "merchant_order_number": "b64hja6c9df8567b", "name": "João Alves", "email": "[email protected]", "birth_date": "1980-12-10", "document": "778.835.381-79", "custom_payload": { "key1": "value1", "key2": "value2" }, "card": { "identifier": "6f32d19f-ac65-457e-84d8-08c406ba9545", "token": "poVBF2Bwv4UOTp9K", 18 Chapter 8. Solicitando uma pré-autorização Isipag Documentation, Release 1.0.0 "content": "gAAAAABWOOIDLjVZrCAgvXBHLGx868kFpxkpXDMgZ8QrCgdyuUqHmCEzPOrnvV90Hci_5Tl7EuuP }, "amount": 1330, "currency": "BRL", "instalments": 1, "auto_capture" false } Important: O resultado é dado através das urls de retornos configuradas para o comerciante { "transaction_id": "fed71ee5-7242-46b7-80fc-a2e32fca47fd", "transaction_status": "authorized", "merchant_id": "6f32d19f-ac65-457e-84d8-08c406ba9545", "merchant_order_number": "b64hja6c9df8567b", "payment_method": "visa", "custom_payload": { "key1": "value1", "key2": "value2" }, "created_at": "2015-10-14 14:33:43", "modified_at": "2015-10-14 14:33:43", "authorized_at": "2015-10-14 14:34:01", "captured_at": null, "canceled_at": null, "refunded_at": null, "gateway": "sandbox", "authorization_code": "0340299", "fraud_analyzed_at": "2015-10-14 14:34:01", "fraud_analysis_risk": 0, "nsu_code": "324350", } Status Codes • 200 OK – no error • 401 Unauthorized – invalid OAuth credentials • 403 Forbidden – permission denied given the credentials • 400 Bad Request – invalid input parameters 19 Isipag Documentation, Release 1.0.0 20 Chapter 8. Solicitando uma pré-autorização CHAPTER 9 Capturando um pagamento autorizado POST /payments/capture Realiza a captura de pagamento pré-autorizado. Request Headers • Authorization – Bearer Token • X-Merchant-Key – Merchant API Key Request JSON Object • transaction_id (string) – Identificador da transação. chant_order_number’ não for informado. Obrigatório se ‘mer- • merchant_order_number (string) – Identificador da transação do comerciante. Obrigatório se ‘transaction_id’ não for informado. • amount (decimal) – Valor a ser capturado. Se informado deverá ser igual ou menor ao valor pré autorizado. Response JSON Object • transaction_id (string) – Identificador da transação gerado pelo Isipag. • transaction_status (string) – Identificador da transação gerado pelo Isipag. • merchant_order_number (string) – Identificador da transação informado pelo comerciante. • payment_method (string) – Identificador do tipo de pagamento. • custom_payload (object) – Objeto que poderá ser utilizado com quaisquer informações, será retornado no sucesso da requisição • created_at (date) – Data de criação do pagamento. • modified_at (date) – Data da última modificação do pagamento. • authorized_at (date) – Data de autorização do pagamento. Nula se não estiver autorizado. • captured_at (date) – Data da captura do pagamento. Nula se não estiver capturado. • canceled_at (date) – Data de cancelamento do pagamento. Nula se não estiver cancelado. • refunded_at (date) – Data de estorno do pagamento. Nula se não estiver estornado. 21 Isipag Documentation, Release 1.0.0 • invalidated_at (date) – Data que a transação se tornou inválida. Nula se não estiver inválida. • gateway (string) – Identificador do gateway/adquirente utilizado para processar o pagamento. • authorization_code (string) – Código de autorização da transação. • nsu_code (string) – Código NSU da transação. • fraud_analyzed_at (date) – Data de resposta de uma análise anti-fraude • fraud_analysis_risk (int) – Gráu de risco de uma transação • auto_capture (boolean) – Indica se a transação foi capturada automaticamente após autorização Requisição exemplo: POST /payments/capture HTTP/1.1 Host: gateway.isilist.com.br Accept: application/json, version=1.0 Authorization: Bearer WXpKbE5USmtNall0WWpoa05pMDBPRE01TFdKbE56Y3RORGN6WmpSak4yTmxNekk1T21NeVpUVX X-Merchant-Key: 3e5d5ac9c9294d1baf309a92b3079520 Content-Type: application/json { "merchant_order_number": "b64hja6c9df8567b", "amount": 1330, } Important: O resultado é dado através das urls de retornos configuradas para o comerciante { "transaction_id": "fed71ee5-7242-46b7-80fc-a2e32fca47fd", "transaction_status": "captured", "merchant_id": "6f32d19f-ac65-457e-84d8-08c406ba9545", "merchant_order_number": "b64hja6c9df8567b", "payment_method": "visa", "custom_payload": { "key1": "value1", "key2": "value2" }, "created_at": "2015-10-14 14:33:43", "modified_at": "2015-10-15 14:33:43", "authorized_at": "2015-10-14 14:34:01", "captured_at": "2015-10-15 14:34:01", "canceled_at": null, "refunded_at": null, "gateway": "sandbox", "authorization_code": "4059694030", "fraud_analyzed_at": "2015-10-14 14:34:01", "fraud_analysis_risk": 0, "nsu_code": "324350" } Status Codes • 200 OK – no error • 401 Unauthorized – invalid OAuth credentials 22 Chapter 9. Capturando um pagamento autorizado Isipag Documentation, Release 1.0.0 • 403 Forbidden – permission denied given the credentials • 400 Bad Request – invalid input parameters 23 Isipag Documentation, Release 1.0.0 24 Chapter 9. Capturando um pagamento autorizado CHAPTER 10 Estornando um pagamento capturado POST /payments/cancel Realiza o estorno de pagamento capturado. Request Headers • Authorization – Bearer Token • X-Merchant-Key – Merchant API Key Request JSON Object • transaction_id (string) – Identificador da transação. chant_order_number’ não for informado. Obrigatório se ‘mer- • merchant_order_number (string) – Identificador da transação do comerciante. Obrigatório se ‘transaction_id’ não for informado. • amount (decimal) – Valor a ser capturado. Se informado deverá ser igual ou menor ao valor pré autorizado. Response JSON Object • transaction_id (string) – Identificador da transação gerado pelo Isipag. • transaction_status (string) – Identificador da transação gerado pelo Isipag. • merchant_order_number (string) – Identificador da transação informado pelo comerciante. • payment_method (string) – Identificador do tipo de pagamento. • custom_payload (object) – Objeto que poderá ser utilizado com quaisquer informações, será retornado no sucesso da requisição • created_at (date) – Data de criação do pagamento. • modified_at (date) – Data da última modificação do pagamento. • authorized_at (date) – Data de autorização do pagamento. Nula se não estiver autorizado. • captured_at (date) – Data da captura do pagamento. Nula se não estiver capturado. • canceled_at (date) – Data de cancelamento do pagamento. Nula se não estiver cancelado. • refunded_at (date) – Data de estorno do pagamento. Nula se não estiver estornado. 25 Isipag Documentation, Release 1.0.0 • invalidated_at (date) – Data que a transação se tornou inválida. Nula se não estiver inválida. • gateway (string) – Identificador do gateway/adquirente utilizado para processar o pagamento. • authorization_code (string) – Código de autorização da transação. • nsu_code (string) – Código NSU da transação. • fraud_analyzed_at (date) – Data de resposta de uma análise anti-fraude • fraud_analysis_risk (int) – Gráu de risco de uma transação • auto_capture (boolean) – Indica se a transação foi capturada automaticamente após autorização Requisição exemplo: POST /payments/cancel HTTP/1.1 Host: gateway.isilist.com.br Accept: application/json, version=1.0 Authorization: Bearer WXpKbE5USmtNall0WWpoa05pMDBPRE01TFdKbE56Y3RORGN6WmpSak4yTmxNekk1T21NeVpUVX X-Merchant-Key: 3e5d5ac9c9294d1baf309a92b3079520 Content-Type: application/json { "merchant_order_number": "b64hja6c9df8567b", "amount": 700, } Important: O resultado é dado através das urls de retornos configuradas para o comerciante { "transaction_id": "fed71ee5-7242-46b7-80fc-a2e32fca47fd", "transaction_status": "captured", "merchant_id": "6f32d19f-ac65-457e-84d8-08c406ba9545", "merchant_order_number": "b64hja6c9df8567b", "payment_method": "visa", "custom_payload": { "key1": "value1", "key2": "value2" }, "created_at": "2015-10-14 14:33:43", "modified_at": "2015-10-15 14:33:43", "authorized_at": "2015-10-14 14:34:01", "captured_at": "2015-10-15 14:34:01", "canceled_at": null, "refunded_at": "2015-10-16 14:34:01", "gateway": "sandbox", "authorization_code": "4059694030", "fraud_analyzed_at": "2015-10-14 14:34:01", "fraud_analysis_risk": 0, "nsu_code": "324350" "amount": "700.00", "amount_refunded": "700.00" } Status Codes 26 Chapter 10. Estornando um pagamento capturado Isipag Documentation, Release 1.0.0 • 200 OK – no error • 401 Unauthorized – invalid OAuth credentials • 403 Forbidden – permission denied given the credentials • 400 Bad Request – invalid input parameters 27 Isipag Documentation, Release 1.0.0 28 Chapter 10. Estornando um pagamento capturado CHAPTER 11 Consultando um pagamento POST /payments/query/ Realiza a captura de pagamento pré-autorizado. Request Headers • Authorization – Bearer Token • X-Merchant-Key – Merchant API Key Request JSON Object • transaction_id (string) – Identificador da transação. chant_order_number’ não for informado. Obrigatório se ‘mer- • merchant_order_number (string) – Identificador da transação do comerciante. Obrigatório se ‘transaction_id’ não for informado. • amount (decimal) – Valor a ser capturado. Se informado deverá ser igual ou menor ao valor pré autorizado. Response JSON Object • transaction_id (string) – Identificador da transação gerado pelo Isipag. • transaction_status (string) – Identificador da transação gerado pelo Isipag. • merchant_order_number (string) – Identificador da transação informado pelo comerciante. • payment_method (string) – Identificador do tipo de pagamento. • custom_payload (object) – Objeto que poderá ser utilizado com quaisquer informações, será retornado no sucesso da requisição • created_at (date) – Data de criação do pagamento. • modified_at (date) – Data da última modificação do pagamento. • authorized_at (date) – Data de autorização do pagamento. Nula se não estiver autorizado. • captured_at (date) – Data da captura do pagamento. Nula se não estiver capturado. • canceled_at (date) – Data de cancelamento do pagamento. Nula se não estiver cancelado. • refunded_at (date) – Data de estorno do pagamento. Nula se não estiver estornado. 29 Isipag Documentation, Release 1.0.0 • invalidated_at (date) – Data que a transação se tornou inválida. Nula se não estiver inválida. • gateway (string) – Identificador do gateway/adquirente utilizado para processar o pagamento. • authorization_code (string) – Código de autorização da transação. • nsu_code (string) – Código NSU da transação. • fraud_analyzed_at (date) – Data de resposta de uma análise anti-fraude • fraud_analysis_risk (int) – Gráu de risco de uma transação • auto_capture (boolean) – Indica se a transação foi capturada automaticamente após autorização Requisição exemplo: POST /payments/query/ HTTP/1.1 Host: gateway.isilist.com.br Accept: application/json, version=1.0 Authorization: Bearer WXpKbE5USmtNall0WWpoa05pMDBPRE01TFdKbE56Y3RORGN6WmpSak4yTmxNekk1T21NeVpUVX X-Merchant-Key: 3e5d5ac9c9294d1baf309a92b3079520 Content-Type: application/json { "merchant_order_number": "b64hja6c9df8567b", } Important: O resultado é dado através das urls de retornos configuradas para o comerciante { "transaction_id": "fed71ee5-7242-46b7-80fc-a2e32fca47fd", "transaction_status": "captured", "merchant_id": "6f32d19f-ac65-457e-84d8-08c406ba9545", "merchant_order_number": "b64hja6c9df8567b", "payment_method": "visa", "custom_payload": { "key1": "value1", "key2": "value2" }, "created_at": "2015-10-14 14:33:43", "modified_at": "2015-10-15 14:33:43", "authorized_at": "2015-10-14 14:34:01", "captured_at": "2015-10-15 14:34:01", "canceled_at": null, "refunded_at": null, "gateway": "sandbox", "authorization_code": "4059694030", "fraud_analyzed_at": "2015-10-14 14:34:01", "fraud_analysis_risk": 0, "nsu_code": "324350", "amount": "1003.00", "amount_refunded": null } Status Codes • 200 OK – no error 30 Chapter 11. Consultando um pagamento Isipag Documentation, Release 1.0.0 • 401 Unauthorized – invalid OAuth credentials • 403 Forbidden – permission denied given the credentials • 400 Bad Request – invalid input parameters 31 Isipag Documentation, Release 1.0.0 32 Chapter 11. Consultando um pagamento CHAPTER 12 Sumário • genindex • modindex • search 33 Isipag Documentation, Release 1.0.0 34 Chapter 12. Sumário HTTP Routing Table /apps POST /apps/create, ?? DELETE /apps/(string: app_id), ?? /merchants POST /merchants/create, 7 POST /merchants/gateway/, 13 POST /merchants/settings/, 11 DELETE /merchants/(string: merchant_id), ?? /oauth POST /oauth/token, 3 /payments POST POST POST POST POST /payments/cancel, 25 /payments/capture, 21 /payments/payment, ?? /payments/query/, 29 /payments/request, 17 /tokens POST /tokens/card, 15 35