### Webhook Event Payload Examples Source: https://mw-bank.readme.io/reference/post_apiwebhooks Provides JSON examples for various webhook events. These examples illustrate the structure of data received when specific events occur, such as Pix cash-in completion, cash-out completion and refunds, and infraction registration. The payloads contain details about the transaction, participants, and status. ```json { "end_to_end_id": "E125731152025091819521TD0NXB3ER3", "reference_code": "e8952595-b51d-432b-b30b-c29a46521cc9", "amount": 5, "status": "done", "reason": null, "initialization_type": "QRDN", "txid": "20250918165025nA7sEoZ20U8KetOe", "addressing_key": "b85fb672-5456-4e88-9b10-fe4ed044fd75", "addressing_key_type": "EVP", "created_at": "2025-09-18T19:52:04+00:00", "performed_at": "2025-09-18T19:52:04+00:00", "payer": { "participant_ispb": "12573115", "account_branch": "0001", "account_number": "43", "account_type": "TRAN", "document_number": "08913620960", "name": "Luis Guilherme" }, "recipient": { "participant_ispb": "12573115", "account_branch": "0001", "account_number": "35", "account_type": "TRAN", "document_number": "04870348306", "name": "Edu Souza" }, "pix_refunds": [] } ``` ```json { "end_to_end_id": "E125731152025091823089gFRSgX47vh", "reference_code": "a5e476b5-e867-4698-ac55-b96b3512e351", "amount": 15, "status": "done", "reason": null, "initialization_type": "DICT", "txid": null, "addressing_key": "+5542991514257", "addressing_key_type": "PHONE", "created_at": "2025-09-18T23:08:12+00:00", "performed_at": "2025-09-18T23:08:13+00:00", "payer": { "participant_ispb": "12573115", "account_branch": "0001", "account_number": "35", "account_type": "TRAN", "document_number": "04870348306", "name": "Edu Souza" }, "recipient": { "participant_ispb": "12573115", "account_branch": "0001", "account_number": "43", "account_type": "TRAN", "document_number": "08913620960", "name": "Luis Guilherme" }, "pix_refunds": [] } ``` ```json { "end_to_end_id": "D12573115202509182321I4jrPxWSSi8", "reference_code": "9911e4f0-7e4e-4241-88df-4af0e96e9619", "original_end_to_end_id": "E125731152025091823089gFRSgX47vh", "original_reference_code": "a5e476b5-e867-4698-ac55-b96b3512e351", "amount": 15, "status": "done", "reason": null, "created_at": "2025-09-18T23:21:52+00:00", "performed_at": "2025-09-18T23:21:52+00:00", "pix_payment": null } ``` ```json { "end_to_end_id": "D12573115202509182330Hlpky8bUO5S", "reference_code": "9f50ced9-2cb4-4566-bf20-9755b4d60b7f", "original_end_to_end_id": "E12573115202509182328U6RHNZOBOYM", "original_reference_code": "f5bb7f78-138b-4cc3-a548-efd2018f6008", "amount": 20, "status": "done", "reason": null, "created_at": "2025-09-18T23:30:12+00:00", "performed_at": "2025-09-18T23:30:12+00:00", "pix_payment": null } ``` ```json { "id": "e84971d8-cb83-4fba-8d29-0f75744ff5c5", "end_to_end_id": "E12345678202502051652JSDF1IDCDE2", "type": "REFUND_REQUEST", "situation_type": "SCAM", "report_details": "Report details", "status": "ACKNOWLEDGED", "creation_datetime": "2025-11-06T19:54:34+00:00", "last_modified": "2025-11-06T19:54:34+00:00", "analysis_result": null, "analysis_details": null, "pix_payment": { "end_to_end_id": "E12345678202502051652JSDF1IDCDE2", "reference_code": "d961e7f4-b539-4a53-92ba-dd10b7b1c910", "amount": 50, "status": "done", "reason": null, "initialization_type": "QRES", "txid": null, "addressing_key": "c6759e09-0799-4406-b144-e0ab03698563", "addressing_key_type": "EVP", "scheduling_datetime": null, "created_at": "2025-02-05T16:52:32+00:00", "performed_at": "2025-02-05T16:52:33+00:00", "payer": { "participant_ispb": "12345678", "account_branch": "0001", "account_number": "27", "account_type": "TRAN", "document_number": "08556186980", "name": "Fulano de Tal" }, "recipient": { "participant_ispb": "12345678", "account_branch": "0001", "account_number": "19", "account_type": "TRAN", "document_number": "22805263000100", "name": "Empresa de Teste LTDA" }, "pix_refunds": [] } } ``` -------------------------------- ### OpenAPI Definition for Get Charge by txid Source: https://mw-bank.readme.io/reference/get_apichargestxid This OpenAPI 3.0.0 definition outlines the structure and parameters for the GET /api/charges/{txid} endpoint. It specifies the request parameters, including the required 'txid', and details the structure of a successful 200 OK response, including an example payload. ```json { "openapi": "3.0.0", "info": { "version": "1.0.0", "title": "Sandbox" }, "servers": [ { "url": "https://api-hml.mwbank.com.br" } ], "paths": { "/api/charges/{txid}": { "get": { "description": "", "operationId": "get_apicharges{txid}", "responses": { "200": { "description": "", "content": { "application/json": { "examples": { "newExample": { "summary": "newExample", "value": { "id": "53b8b2b7968542848af6867a81fa599c", "txid": "vWu6iFCxKuKieZyx1o56CDZoLhK5QP", "expiration": 300, "expiration_datetime": "2025-02-17 18:22:30", "validate_after_expiration": false, "debtor_document_number": "08913620960", "debtor_name": "Luis Guilherme", "debtor_address_line": null, "debtor_city": null, "debtor_state": null, "debtor_zip_code": null, "amount": 10, "pix_key": "b85fb672-5456-4e88-9b10-fe4ed044fd75", "status": "active", "type": "COB", "payer_request": null, "additional_information": [], "fine_amount": 0, "fine_type": null, "interest_amount": 0, "interest_type": null, "discount_amount": 0, "discount_date": null, "discount_type": null, "qr_code": "00020101021226890014br.gov.bcb.pix2567pix-h.delbank.com.br/v2/12573115/cob/vWu6iFCxKuKieZyx1o56CDZoLhK5QP5204000053039865802BR5925NEL3 PAY INSTITUICAO DE P6007ARACAJU62070503***6304A366", "settled_at": null, "account_id": 35, "created_at": "2025-02-17 18:17:30", "updated_at": "2025-02-17 18:17:30", "pix_payments": [] } } } } } } }, "parameters": [ { "in": "path", "name": "txid", "schema": { "type": "string" }, "required": true } ], "security": [ { "BearerAuth": [] } ] } } }, "components": { "securitySchemes": { "BearerAuth": { "type": "http", "scheme": "bearer" } } } } ``` -------------------------------- ### GET /api/account/balance Source: https://mw-bank.readme.io/reference/get_apiaccountbalance Retrieves the account balance for a given account. ```APIDOC ## GET /api/account/balance ### Description Retrieves the account balance. ### Method GET ### Endpoint /api/account/balance ### Parameters #### Path Parameters None #### Query Parameters None #### Request Body None ### Request Example None ### Response #### Success Response (200) - **balance** (integer) - The account balance. - **account_id** (integer) - The ID of the account. #### Response Example ```json { "balance": 10000, "account_id": 35 } ``` ``` -------------------------------- ### OpenAPI Definition for Get Refund by Reference Code Source: https://mw-bank.readme.io/reference/get_apipix_refundsreference_codevalue This OpenAPI 3.0.0 definition describes the GET endpoint for retrieving refund details. It requires a `reference_code` as a path parameter and returns a JSON object with refund information, including payment details. ```json { "openapi": "3.0.0", "info": { "version": "1.0.0", "title": "Sandbox" }, "servers": [ { "url": "https://api-hml.mwbank.com.br" } ], "paths": { "/api/pix_refunds/reference_code/{value}": { "get": { "description": "", "operationId": "get_apipix_refundsreference_code{value}", "responses": { "200": { "description": "", "content": { "application/json": { "examples": { "newExample": { "summary": "newExample", "value": { "end_to_end_id": "D1257311520250217183053DJddWp2Kg", "reference_code": "453f3ad3-52fd-4e2b-84db-05a1b3d48c6d", "amount": 10, "performed_at": "2025-02-17 18:30:57", "status": "done", "reason": null, "debtor_participant_ispb": "12573115", "creditor_participant_ispb": "12573115", "devolution_code": "MD06", "original_end_to_end_id": "E12573115202502171811NEDJLQH3FN6", "debtor_account_id": 35, "creditor_account_id": 43, "fee": 0, "created_at": "2025-02-17 18:30:53", "updated_at": "2025-02-17 18:30:57", "pix_payment": { "end_to_end_id": "E12573115202502171811NEDJLQH3FN6", "source": "api", "reference_code": "d8c9c85d-9f3d-4b2c-bfb7-5f57ed97f945", "amount": 10, "notes": null, "performed_at": "2025-02-17 18:11:45", "status": "done", "reason": null, "payer_participant_ispb": "12573115", "payer_account_branch": "0001", "payer_account_number": "43", "payer_account_type": "TRAN", "payer_document_number": "08913620960", "payer_name": "Luis Guilherme", "recipient_participant_ispb": "12573115", "recipient_account_branch": "0001", "recipient_account_number": "35", "recipient_account_type": "TRAN", "recipient_document_number": "04870348306", "recipient_name": "Edu Souza", "initialization_type": "QRDN", "txid": "x3QAEP4hPH6KXjspL79km38LvE5G8K", "addressing_key": "b85fb672-5456-4e88-9b10-fe4ed044fd75", "addressing_key_type": "EVP", "payer_account_id": 43, "recipient_account_id": 35, "fee": 0.035, "created_at": "2025-02-17 18:11:44", "updated_at": "2025-02-17 18:11:45", "transaction_type": "internal" } } } } } } } }, "parameters": [ { "name": "value", "in": "path", "required": true, "description": "Reference code.", "schema": { "type": "string", "default": "" } } ], "security": [ { "BearerAuth": [] } ] } } }, "components": { "securitySchemes": { "BearerAuth": { "type": "http", "scheme": "bearer" } } } } ``` -------------------------------- ### GET /api/pix_out/reference_code/{value} Source: https://mw-bank.readme.io/reference/get_apipix_outreference_codevalue Retrieves payment details using the reference_code, a control code provided by the client. ```APIDOC ## GET /api/pix_out/reference_code/{value} ### Description Retrieves payment details using the reference_code, a control code provided by the client. ### Method GET ### Endpoint /api/pix_out/reference_code/{value} ### Parameters #### Path Parameters - **value** (string) - Required - Reference code. ### Request Example ```json { "example": "" } ``` ### Response #### Success Response (200) - **end_to_end_id** (string) - The end-to-end ID of the payment. - **reference_code** (string) - The reference code used for the payment. - **amount** (number) - The payment amount. - **status** (string) - The status of the payment (e.g., "done"). - **reason** (any) - The reason for the payment status, if applicable. - **initialization_type** (string) - The type of initialization for the payment (e.g., "DICT"). - **txid** (any) - The transaction ID, if available. - **addressing_key** (string) - The recipient's addressing key. - **addressing_key_type** (string) - The type of the recipient's addressing key. - **scheduling_datetime** (any) - The scheduled date and time for the payment, if applicable. - **created_at** (string) - The timestamp when the payment was created. - **performed_at** (string) - The timestamp when the payment was performed. - **payer** (object) - Details about the payer. - **participant_ispb** (string) - Payer's ISPB. - **account_branch** (string) - Payer's account branch. - **account_number** (string) - Payer's account number. - **account_type** (string) - Payer's account type. - **document_number** (string) - Payer's document number. - **name** (string) - Payer's name. - **recipient** (object) - Details about the recipient. - **participant_ispb** (string) - Recipient's ISPB. - **account_branch** (string) - Recipient's account branch. - **account_number** (string) - Recipient's account number. - **account_type** (string) - Recipient's account type. - **document_number** (string) - Recipient's document number. - **name** (string) - Recipient's name. - **pix_refunds** (array) - An array of refund objects, if any. #### Response Example ```json { "end_to_end_id": "E53822116202510281219AHvfQudKVGL", "reference_code": "392bcca2-6911-498e-ac57-51fb844d8dd2", "amount": 10, "status": "done", "reason": null, "initialization_type": "DICT", "txid": null, "addressing_key": "11175765902", "addressing_key_type": "CPF", "scheduling_datetime": null, "created_at": "2025-10-28T12:19:13+00:00", "performed_at": "2025-10-28T12:19:14+00:00", "payer": { "participant_ispb": "53822116", "account_branch": "0001", "account_number": "10022", "account_type": "TRAN", "document_number": "08556186980", "name": "Marcos Kubis" }, "recipient": { "participant_ispb": "53822116", "account_branch": "1", "account_number": "20095", "account_type": "TRAN", "document_number": "11175765902", "name": "Gianfranco Marcucci Neto" }, "pix_refunds": [] } ``` ``` -------------------------------- ### OpenAPI Definition for Payment Retrieval Source: https://mw-bank.readme.io/reference/get_apipix_outreference_codevalue This OpenAPI 3.0.0 definition outlines the structure and parameters for the API endpoint used to retrieve payment details via a reference code. It specifies the request method (GET), path parameters, and the expected JSON response structure for a successful retrieval. ```json { "openapi": "3.0.0", "info": { "version": "1.0.0", "title": "Sandbox" }, "servers": [ { "url": "https://api-hml.mwbank.com.br" } ], "paths": { "/api/pix_out/reference_code/{value}": { "get": { "description": "", "operationId": "get_apipix_outreference_code{value}", "responses": { "200": { "description": "", "content": { "application/json": { "examples": { "OK": { "summary": "OK", "value": { "end_to_end_id": "E53822116202510281219AHvfQudKVGL", "reference_code": "392bcca2-6911-498e-ac57-51fb844d8dd2", "amount": 10, "status": "done", "reason": null, "initialization_type": "DICT", "txid": null, "addressing_key": "11175765902", "addressing_key_type": "CPF", "scheduling_datetime": null, "created_at": "2025-10-28T12:19:13+00:00", "performed_at": "2025-10-28T12:19:14+00:00", "payer": { "participant_ispb": "53822116", "account_branch": "0001", "account_number": "10022", "account_type": "TRAN", "document_number": "08556186980", "name": "Marcos Kubis" }, "recipient": { "participant_ispb": "53822116", "account_branch": "1", "account_number": "20095", "account_type": "TRAN", "document_number": "11175765902", "name": "Gianfranco Marcucci Neto" }, "pix_refunds": [] } } } } } } }, "parameters": [ { "name": "value", "in": "path", "required": true, "description": "Reference code.", "schema": { "type": "string", "default": "" } } ], "security": [ { "BearerAuth": [] } ] } } }, "components": { "securitySchemes": { "BearerAuth": { "type": "http", "scheme": "bearer" } } } } ``` -------------------------------- ### GET /api/pix_refunds/reference_code/{value} Source: https://mw-bank.readme.io/reference/get_apipix_refundsreference_codevalue Retrieves refund details using the reference_code, a control code provided by the client. ```APIDOC ## GET /api/pix_refunds/reference_code/{value} ### Description Retrieves refund details using the reference_code, a control code provided by the client. ### Method GET ### Endpoint /api/pix_refunds/reference_code/{value} ### Parameters #### Path Parameters - **value** (string) - Required - The reference code to retrieve refund details. ### Request Example ```json { "example": "" } ``` ### Response #### Success Response (200) - **end_to_end_id** (string) - The end-to-end ID of the refund transaction. - **reference_code** (string) - The reference code used for the refund. - **amount** (number) - The amount of the refund. - **performed_at** (string) - The timestamp when the refund was performed. - **status** (string) - The status of the refund (e.g., "done"). - **reason** (any) - The reason for the refund, if any. - **debtor_participant_ispb** (string) - The ISPB of the debtor participant. - **creditor_participant_ispb** (string) - The ISPB of the creditor participant. - **devolution_code** (string) - The devolution code associated with the refund. - **original_end_to_end_id** (string) - The end-to-end ID of the original transaction. - **debtor_account_id** (integer) - The ID of the debtor's account. - **creditor_account_id** (integer) - The ID of the creditor's account. - **fee** (number) - The fee associated with the refund. - **created_at** (string) - The timestamp when the refund record was created. - **updated_at** (string) - The timestamp when the refund record was last updated. - **pix_payment** (object) - Details of the associated Pix payment. - **end_to_end_id** (string) - The end-to-end ID of the Pix payment. - **source** (string) - The source of the Pix payment. - **reference_code** (string) - The reference code of the Pix payment. - **amount** (number) - The amount of the Pix payment. - **notes** (any) - Any notes associated with the Pix payment. - **performed_at** (string) - The timestamp when the Pix payment was performed. - **status** (string) - The status of the Pix payment. - **reason** (any) - The reason for the Pix payment, if any. - **payer_participant_ispb** (string) - The ISPB of the Pix payment payer. - **payer_account_branch** (string) - The branch number of the payer's account. - **payer_account_number** (string) - The account number of the payer. - **payer_account_type** (string) - The type of the payer's account. - **payer_document_number** (string) - The document number of the payer. - **payer_name** (string) - The name of the payer. - **recipient_participant_ispb** (string) - The ISPB of the Pix payment recipient. - **recipient_account_branch** (string) - The branch number of the recipient's account. - **recipient_account_number** (string) - The account number of the recipient. - **recipient_account_type** (string) - The type of the recipient's account. - **recipient_document_number** (string) - The document number of the recipient. - **recipient_name** (string) - The name of the recipient. - **initialization_type** (string) - The initialization type of the Pix payment. - **txid** (string) - The transaction ID (txid) of the Pix payment. - **addressing_key** (string) - The addressing key used for the Pix payment. - **addressing_key_type** (string) - The type of the addressing key. - **payer_account_id** (integer) - The ID of the payer's account. - **recipient_account_id** (integer) - The ID of the recipient's account. - **fee** (number) - The fee associated with the Pix payment. - **created_at** (string) - The timestamp when the Pix payment record was created. - **updated_at** (string) - The timestamp when the Pix payment record was last updated. - **transaction_type** (string) - The type of the Pix transaction. #### Response Example ```json { "end_to_end_id": "D1257311520250217183053DJddWp2Kg", "reference_code": "453f3ad3-52fd-4e2b-84db-05a1b3d48c6d", "amount": 10, "performed_at": "2025-02-17 18:30:57", "status": "done", "reason": null, "debtor_participant_ispb": "12573115", "creditor_participant_ispb": "12573115", "devolution_code": "MD06", "original_end_to_end_id": "E12573115202502171811NEDJLQH3FN6", "debtor_account_id": 35, "creditor_account_id": 43, "fee": 0, "created_at": "2025-02-17 18:30:53", "updated_at": "2025-02-17 18:30:57", "pix_payment": { "end_to_end_id": "E12573115202502171811NEDJLQH3FN6", "source": "api", "reference_code": "d8c9c85d-9f3d-4b2c-bfb7-5f57ed97f945", "amount": 10, "notes": null, "performed_at": "2025-02-17 18:11:45", "status": "done", "reason": null, "payer_participant_ispb": "12573115", "payer_account_branch": "0001", "payer_account_number": "43", "payer_account_type": "TRAN", "payer_document_number": "08913620960", "payer_name": "Luis Guilherme", "recipient_participant_ispb": "12573115", "recipient_account_branch": "0001", "recipient_account_number": "35", "recipient_account_type": "TRAN", "recipient_document_number": "04870348306", "recipient_name": "Edu Souza", "initialization_type": "QRDN", "txid": "x3QAEP4hPH6KXjspL79km38LvE5G8K", "addressing_key": "b85fb672-5456-4e88-9b10-fe4ed044fd75", "addressing_key_type": "EVP", "payer_account_id": 43, "recipient_account_id": 35, "fee": 0.035, "created_at": "2025-02-17 18:11:44", "updated_at": "2025-02-17 18:11:45", "transaction_type": "internal" } } ``` ``` -------------------------------- ### GET /api/pix_refunds/end_to_end_id/{value} Source: https://mw-bank.readme.io/reference/get_apipix_refundsend_to_end_idvalue Retrieves refund details using the EndToEndId. This endpoint allows you to fetch specific refund information by providing the unique EndToEndId in the path. ```APIDOC ## GET /api/pix_refunds/end_to_end_id/{value} ### Description Retrieves refund details using the EndToEndId. ### Method GET ### Endpoint /api/pix_refunds/end_to_end_id/{value} ### Parameters #### Path Parameters - **value** (string) - Required - EndToEndId ### Request Example ```json { "example": "" } ``` ### Response #### Success Response (200) - **end_to_end_id** (string) - The unique identifier for the refund transaction. - **reference_code** (string) - A reference code associated with the refund. - **amount** (number) - The amount of the refund. - **performed_at** (string) - The date and time when the refund was performed. - **status** (string) - The status of the refund (e.g., "done"). - **reason** (string) - The reason for the refund, if applicable. - **debtor_participant_ispb** (string) - The ISPB of the debtor participant. - **creditor_participant_ispb** (string) - The ISPB of the creditor participant. - **devolution_code** (string) - The code for the devolution. - **original_end_to_end_id** (string) - The EndToEndId of the original transaction. - **debtor_account_id** (integer) - The ID of the debtor's account. - **creditor_account_id** (integer) - The ID of the creditor's account. - **fee** (number) - Any fees associated with the refund. - **created_at** (string) - The date and time when the refund record was created. - **updated_at** (string) - The date and time when the refund record was last updated. - **pix_payment** (object) - Details of the associated Pix payment. - **end_to_end_id** (string) - The EndToEndId of the Pix payment. - **source** (string) - The source of the Pix payment. - **reference_code** (string) - The reference code for the Pix payment. - **amount** (number) - The amount of the Pix payment. - **notes** (string) - Any notes associated with the Pix payment. - **performed_at** (string) - The date and time when the Pix payment was performed. - **status** (string) - The status of the Pix payment. - **reason** (string) - The reason for the Pix payment, if applicable. - **payer_participant_ispb** (string) - The ISPB of the payer. - **payer_account_branch** (string) - The branch of the payer's account. - **payer_account_number** (string) - The account number of the payer. - **payer_account_type** (string) - The type of the payer's account. - **payer_document_number** (string) - The document number of the payer. - **payer_name** (string) - The name of the payer. - **recipient_participant_ispb** (string) - The ISPB of the recipient. - **recipient_account_branch** (string) - The branch of the recipient's account. - **recipient_account_number** (string) - The account number of the recipient. - **recipient_account_type** (string) - The type of the recipient's account. - **recipient_document_number** (string) - The document number of the recipient. - **recipient_name** (string) - The name of the recipient. - **initialization_type** (string) - The initialization type of the Pix payment. - **txid** (string) - The transaction ID (txid) of the Pix payment. - **addressing_key** (string) - The addressing key used for the Pix payment. - **addressing_key_type** (string) - The type of the addressing key. - **payer_account_id** (integer) - The ID of the payer's account. - **recipient_account_id** (integer) - The ID of the recipient's account. - **fee** (number) - Any fees associated with the Pix payment. - **created_at** (string) - The date and time when the Pix payment record was created. - **updated_at** (string) - The date and time when the Pix payment record was last updated. - **transaction_type** (string) - The type of the Pix transaction. #### Response Example ```json { "end_to_end_id": "D1257311520250217185912YX8mAAJkQ", "reference_code": "b24fcc2f-b3f5-40c3-9d4b-6060b3d065c8", "amount": 10, "performed_at": "2025-02-17 18:59:12", "status": "done", "reason": null, "debtor_participant_ispb": "12573115", "creditor_participant_ispb": "12573115", "devolution_code": "MD06", "original_end_to_end_id": "E12573115202502171857358XD14JNHD", "debtor_account_id": 35, "creditor_account_id": 43, "fee": 0, "created_at": "2025-02-17 18:59:11", "updated_at": "2025-02-17 18:59:12", "pix_payment": { "end_to_end_id": "E12573115202502171857358XD14JNHD", "source": "api", "reference_code": "48b65688-f6e2-4355-8f9e-454112e33afb", "amount": 10, "notes": null, "performed_at": "2025-02-17 18:57:49", "status": "done", "reason": null, "payer_participant_ispb": "12573115", "payer_account_branch": "0001", "payer_account_number": "43", "payer_account_type": "TRAN", "payer_document_number": "08913620960", "payer_name": "Luis Guilherme", "recipient_participant_ispb": "12573115", "recipient_account_branch": "0001", "recipient_account_number": "35", "recipient_account_type": "TRAN", "recipient_document_number": "04870348306", "recipient_name": "Edu Souza", "initialization_type": "QRDN", "txid": "lfGRIUiaAdqouLPlYowER8DZERHA2E", "addressing_key": "b85fb672-5456-4e88-9b10-fe4ed044fd75", "addressing_key_type": "EVP", "payer_account_id": 43, "recipient_account_id": 35, "fee": 0.035, "created_at": "2025-02-17 18:57:48", "updated_at": "2025-02-17 18:57:49", "transaction_type": "internal" } } ``` ``` -------------------------------- ### Environments Source: https://mw-bank.readme.io/reference/index Information about the available API environments for MW Bank. ```APIDOC ## Environments ### Description This section details the available environments for interacting with the MW Bank API. ### Sandbox Environment **Base URL:** `https://api-hml.mwbank.com.br` ### Production Environment **Base URL:** `https://core.mwbank.com.br` ``` -------------------------------- ### OpenAPI Definition for Get Received Payment Source: https://mw-bank.readme.io/reference/get_apipix_inend_to_end_idvalue This OpenAPI 3.0.0 definition outlines the 'GET /api/pix_in/end_to_end_id/{value}' endpoint. It specifies the request parameters, including the required 'value' (EndToEndId), and details the structure of a successful '200 OK' JSON response, including example payment data. ```json { "openapi": "3.0.0", "info": { "version": "1.0.0", "title": "Sandbox" }, "servers": [ { "url": "https://api-hml.mwbank.com.br" } ], "paths": { "/api/pix_in/end_to_end_id/{value}": { "get": { "description": "", "operationId": "get_apipix_inend_to_end_id{value}", "responses": { "200": { "description": "", "content": { "application/json": { "examples": { "newExample": { "summary": "newExample", "value": { "end_to_end_id": "E12573115202502171811NEDJLQH3FN6", "source": "api", "reference_code": "d8c9c85d-9f3d-4b2c-bfb7-5f57ed97f945", "amount": 10, "notes": null, "performed_at": "2025-02-17 18:11:45", "status": "done", "reason": null, "payer_participant_ispb": "12573115", "payer_account_branch": "0001", "payer_account_number": "43", "payer_account_type": "TRAN", "payer_document_number": "08913620960", "payer_name": "Luis Guilherme", "recipient_participant_ispb": "12573115", "recipient_account_branch": "0001", "recipient_account_number": "35", "recipient_account_type": "TRAN", "recipient_document_number": "04870348306", "recipient_name": "Edu Souza", "initialization_type": "QRDN", "txid": "x3QAEP4hPH6KXjspL79km38LvE5G8K", "addressing_key": "b85fb672-5456-4e88-9b10-fe4ed044fd75", "addressing_key_type": "EVP", "payer_account_id": 43, "recipient_account_id": 35, "fee": 0.035, "created_at": "2025-02-17 18:11:44", "updated_at": "2025-02-17 18:11:45", "transaction_type": "internal", "pix_refunds": [] } } } } } } }, "parameters": [ { "name": "value", "in": "path", "required": true, "description": "EndToEndId", "schema": { "type": "string", "default": "" } } ], "security": [ { "BearerAuth": [] } ] } } }, "components": { "securitySchemes": { "BearerAuth": { "type": "http", "scheme": "bearer" } } } } ``` -------------------------------- ### Retrieve Payment Details via txid (OpenAPI) Source: https://mw-bank.readme.io/reference/get_apipix_intxidvalue This OpenAPI definition outlines the GET request to retrieve payment details using a transaction ID (txid). It specifies the endpoint, parameters, and the structure of the JSON response, including example data. ```json { "openapi": "3.0.0", "info": { "version": "1.0.0", "title": "Sandbox" }, "servers": [ { "url": "https://api-hml.mwbank.com.br" } ], "paths": { "/api/pix_in/txid/{value}": { "get": { "description": "", "operationId": "get_apipix_intxid{value}", "responses": { "200": { "description": "", "content": { "application/json": { "examples": { "newExample": { "summary": "newExample", "value": { "end_to_end_id": "E12573115202502171811NEDJLQH3FN6", "source": "api", "reference_code": "d8c9c85d-9f3d-4b2c-bfb7-5f57ed97f945", "amount": 10, "notes": null, "performed_at": "2025-02-17 18:11:45", "status": "done", "reason": null, "payer_participant_ispb": "12573115", "payer_account_branch": "0001", "payer_account_number": "43", "payer_account_type": "TRAN", "payer_document_number": "08913620960", "payer_name": "Luis Guilherme", "recipient_participant_ispb": "12573115", "recipient_account_branch": "0001", "recipient_account_number": "35", "recipient_account_type": "TRAN", "recipient_document_number": "04870348306", "recipient_name": "Edu Souza", "initialization_type": "QRDN", "txid": "x3QAEP4hPH6KXjspL79km38LvE5G8K", "addressing_key": "b85fb672-5456-4e88-9b10-fe4ed044fd75", "addressing_key_type": "EVP", "payer_account_id": 43, "recipient_account_id": 35, "fee": 0.035, "created_at": "2025-02-17 18:11:44", "updated_at": "2025-02-17 18:11:45", "transaction_type": "internal", "pix_refunds": [] } } } } } } }, "parameters": [ { "name": "value", "in": "path", "required": true, "description": "TxId", "schema": { "type": "string", "default": "" } } ], "security": [ { "BearerAuth": [] } ] } } }, "components": { "securitySchemes": { "BearerAuth": { "type": "http", "scheme": "bearer" } } } } ```