{"openapi":"3.0.0","info":{"title":"zrobank","description":"Documentação da api zrobank","license":{"name":"Apache 2.0","url":"http://www.apache.org/licenses/LICENSE-2.0.html"},"version":"1.0.0"},"paths":{"/api/clients/{document}/bank-accounts":{"get":{"tags":["Client Accounts"],"summary":"List client bank accounts","operationId":"listClientBankAccounts","parameters":[{"name":"document","in":"path","description":"Client document","required":true,"schema":{"type":"string"},"example":"12345678901"}],"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaginationForClientBankAccount"}}}},"401":{"description":"Unauthenticated","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response401"}}}},"404":{"description":"Client Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response404"}}}},"500":{"description":"Error"}},"security":[{"sanctum":[],"paas_token":[]}]},"put":{"tags":["Client Accounts"],"summary":"Update client bank accounts","operationId":"setClientBankAccounts","parameters":[{"name":"document","in":"path","description":"Client document","required":true,"schema":{"type":"string"},"example":"12345678901"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ClientBankAccountSetRequest"}}}},"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ClientBankAccount"}}}}},"401":{"description":"Unauthenticated","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response401"}}}},"404":{"description":"Client Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response404"}}}},"422":{"description":"Unprocessable Entity","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response422"}}}},"500":{"description":"Error"}},"security":[{"sanctum":[],"paas_token":[]}]},"post":{"tags":["Client Accounts"],"summary":"Add a client bank account","operationId":"storeClientBankAccount","parameters":[{"name":"document","in":"path","description":"Client document","required":true,"schema":{"type":"string"},"example":"12345678901"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ClientBankAccountStoreRequest"}}}},"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ClientBankAccount"}}}},"401":{"description":"Unauthenticated","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response401"}}}},"404":{"description":"Client Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response404"}}}},"422":{"description":"Unprocessable Entity","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response422"}}}},"500":{"description":"Error"}},"security":[{"sanctum":[],"paas_token":[]}]}},"/api/clients/{document}/bank-accounts/{bankAccountId}":{"delete":{"tags":["Client Accounts"],"summary":"Delete a client bank account","operationId":"deleteClientBankAccount","parameters":[{"name":"document","in":"path","description":"Client document","required":true,"schema":{"type":"string"},"example":"12345678901"},{"name":"bankAccountId","in":"path","description":"Bank account ID","required":true,"schema":{"type":"integer"},"example":"1"}],"responses":{"204":{"description":"No content"},"401":{"description":"Unauthenticated","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response401"}}}},"404":{"description":"Client or Bank Account Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response404"}}}},"500":{"description":"Error"}},"security":[{"sanctum":[],"paas_token":[]}]}},"/api/pix/keys":{"get":{"tags":["Pix Key"],"summary":"List Pix Keys","operationId":"listPixKey","responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaginationForPixKey"}}}},"401":{"description":"Unauthenticated","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response401"}}}},"500":{"description":"Error"}},"security":[{"sanctum":[],"paas_token":[]}]},"post":{"tags":["Pix Key"],"summary":"Create Pix Key","operationId":"createPixKey","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PixKeyRequest"}}}},"responses":{"201":{"description":"Successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PixKeyCreate"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"properties":{"message":{"title":"message","type":"string","example":"Não foi possível criar chave"}},"type":"object"}}}},"401":{"description":"Unauthenticated","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response401"}}}},"500":{"description":"Error"}},"security":[{"sanctum":[],"paas_token":[]}]}},"/api/pix/keys/{id}":{"get":{"tags":["Pix Key"],"summary":"Show Pix Key","operationId":"showPixKey","parameters":[{"name":"id","in":"path","description":"Pix Key ID","required":true,"schema":{"type":"string"},"example":"7da0c9af-215e-4625-b484-b8cfc87aaa09"}],"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PixKey"}}}},"401":{"description":"Unauthenticated","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response401"}}}},"404":{"description":"Not Found"},"500":{"description":"Error"}},"security":[{"sanctum":[],"paas_token":[]}]},"delete":{"tags":["Pix Key"],"summary":"Delete Pix Key","operationId":"deletePixKey","parameters":[{"name":"id","in":"path","description":"Pix Key ID","required":true,"schema":{"type":"string"},"example":"7da0c9af-215e-4625-b484-b8cfc87aaa09"}],"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request"},"401":{"description":"Unauthenticated","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response401"}}}},"404":{"description":"Not Found"},"500":{"description":"Error"}},"security":[{"sanctum":[],"paas_token":[]}]}},"/api/transaction/generate_refund":{"post":{"tags":["Refunds"],"summary":"Generate new complete refund","description":"Generates a new complete refund when the transaction does not have any orders.","operationId":"generateWithoutOrdersRefund","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefundWithoutOrdersRequest"}}}},"responses":{"201":{"description":"Successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OldRefundResponse"}}}},"400":{"description":"Bad Request"},"401":{"description":"Unauthenticated","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response401"}}}},"403":{"description":"Forbidden"},"408":{"description":"Request timeout"},"500":{"description":"Error"}},"security":[{"sanctum":[],"paas_token":[]}]}},"/api/refunds":{"post":{"tags":["Refunds"],"summary":"Generate a new refund from a deposit transaction","operationId":"generateRefund","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefundRequest"}}}},"responses":{"201":{"description":"Successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefundResponse"}}}},"400":{"description":"Bad Request"},"401":{"description":"Unauthenticated","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response401"}}}},"403":{"description":"Forbidden"},"404":{"description":"Not Found"},"408":{"description":"Request timeout"},"422":{"description":"Unprocessable entity","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response422"}}}},"500":{"description":"Error"}},"security":[{"sanctum":[],"paas_token":[]}]}},"/api/transaction/generate_qr_code_pix":{"post":{"tags":["QR Code"],"summary":"Generates a new dynamic QR Code","description":"Generates a new dynamic QR Code.","operationId":"generateQrCode","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QrCode"}}}},"responses":{"201":{"description":"Successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/QrCode"}}}},"400":{"description":"Bad Request"},"401":{"description":"Unauthenticated","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response401"}}}},"403":{"description":"Forbidden"},"408":{"description":"Request timeout"},"500":{"description":"Error"}},"security":[{"sanctum":[],"paas_token":[]}]}},"/api/transaction/{transactionUuid}/status":{"get":{"tags":["Transactions"],"summary":"Search transaction by its UUID","description":"Returns the found transaction data.","operationId":"trassaction_status","parameters":[{"name":"transactionUuid","in":"path","description":"Transaction UUID","required":true,"schema":{"type":"string"},"example":"7da0c9af-215e-4625-b484-b8cfc87aaa09"}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TransactionResponse"}}}},"400":{"description":"Bad Request"},"401":{"description":"Unauthenticated","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response401"}}}},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}},"security":[{"sanctum":[],"paas_token":[]}]}},"/api/transactions":{"get":{"tags":["Transactions"],"summary":"List all transactions data","description":"List all transactions data. If no parameter is set, it will automatically select today’s date\n     *     as the search parameter.","operationId":"transactionsData","parameters":[{"name":"start_date","in":"query","description":"Filter by created at start date","schema":{"type":"string","example":"2023-05-19 10:00:00"}},{"name":"end_date","in":"query","description":"Filter by created at end date","schema":{"type":"string","example":"2023-05-19 20:00:00"}},{"name":"transaction_type","in":"query","description":"Filter by transaction type.","schema":{"type":"string","enum":["transaction","withdraw","returned","refund"],"example":"transaction"}},{"name":"page","in":"query","description":"Filter by page number","schema":{"type":"string","example":"1"}},{"name":"limit","in":"query","description":"Limit numbers of itens by page","schema":{"type":"string","example":"1"}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Pagination"}}}},"401":{"description":"Unauthenticated","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response401"}}}},"403":{"description":"Forbidden"},"500":{"description":"Error"}},"security":[{"sanctum":[],"paas_token":[]}]},"put":{"tags":["Transactions"],"summary":"Update a transaction status (ONLY AVAILABLE FOR DEVELOPMENT ENVIRONMENT)","description":"This endpoint is only meant for development environment. Update the status of a transaction to\n     *     trigger the receipt of webhooks for testing purposes.","operationId":"update_transaction_status","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateTransactionStatus"}}}},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TransactionResponse"}}}},"400":{"description":"Bad Request"},"401":{"description":"Unauthenticated","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response401"}}}},"403":{"description":"Forbidden"},"404":{"description":"Not found"}},"security":[{"sanctum":[],"paas_token":[]}]}},"/api/v2/transactions":{"get":{"tags":["Transactions"],"summary":"List all transactions data - V2","description":"List all transactions data. If no parameter is set, it will automatically select today’s date\n     *     as the search parameter.","operationId":"transactionsDataV2","parameters":[{"name":"start_date","in":"query","description":"Filter by created at start date","schema":{"type":"string","example":"2023-05-19 10:00:00"}},{"name":"end_date","in":"query","description":"Filter by created at end date","schema":{"type":"string","example":"2023-05-19 20:00:00"}},{"name":"transaction_type","in":"query","description":"Filter by transaction type.","schema":{"type":"string","enum":["transaction","withdraw","returned","refund"],"example":"transaction"}},{"name":"page","in":"query","description":"Filter by page number","schema":{"type":"string","example":"1"}},{"name":"limit","in":"query","description":"Limit numbers of itens by page","schema":{"type":"string","example":"1"}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaginationV2"}}}},"401":{"description":"Unauthenticated","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response401"}}}},"403":{"description":"Forbidden"},"500":{"description":"Error"}},"security":[{"sanctum":[],"paas_token":[]}]}},"/api/withdraws/{merchantId}/status":{"get":{"tags":["Withdrawals"],"summary":"Search withdrawal transaction by merchant ID","description":"Returns the found withdrawal transaction data.","operationId":"withdraw_status","parameters":[{"name":"merchantId","in":"path","description":"Transaction's merchant id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TransactionResponse"}}}},"400":{"description":"Bad Request"},"401":{"description":"Unauthenticated","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response401"}}}},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}},"security":[{"sanctum":[],"paas_token":[]}]}},"/api/withdraws/by_account":{"post":{"tags":["Withdrawals"],"summary":"Create new PIX withdrawal request by account","description":"Creates a new withdrawal request using PIX as the payment method","operationId":"withdrawByBankAccount","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WithdrawByAccountRequest"}}}},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Withdraw"}}}},"400":{"description":"Bad Request"},"401":{"description":"Unauthenticated","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response401"}}}},"422":{"description":"Unprocessable Entity","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response422"}}}}},"security":[{"sanctum":[],"paas_token":[]}]}},"/api/withdraw":{"post":{"tags":["Withdrawals"],"summary":"Creates new PIX withdrawal request by key","description":"Creates a new withdrawal request using PIX as the payment method.","operationId":"withdraw","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WithdrawRequest"}}}},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Withdraw"}}}},"400":{"description":"Bad Request"},"401":{"description":"Unauthenticated","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response401"}}}},"403":{"description":"Forbidden"}},"security":[{"sanctum":[],"paas_token":[]}]}}},"components":{"schemas":{"ClientBankAccount":{"title":"Client Bank Account","description":"Info about the requested client bank account","properties":{"id":{"title":"id","description":"Client Bank Account id","type":"integer","readOnly":true,"example":"1"},"bank_ispb":{"title":"bank_ispb","description":"Bank ISPB","type":"string","readOnly":true,"example":"00001234"},"account_number":{"title":"account_number","description":"Account number","type":"string","readOnly":true,"example":"123456"},"account_branch":{"title":"account_branch","description":"Account branch","type":"string","readOnly":true,"example":"1234"}},"type":"object"},"ClientBankAccountSetRequest":{"title":"Client Bank Account Store Body","description":"Creates a new client bank account","required":["account_number","account_branch","bank_ispb"],"properties":{"client_bank_accounts":{"title":"client_bank_accounts","description":"Client bank accounts","type":"array","items":{"$ref":"#/components/schemas/ClientBankAccountStoreRequest"}}},"type":"object"},"ClientBankAccountStoreRequest":{"title":"Client Bank Account Store Body","description":"Creates a new client bank account","required":["account_number","account_branch","bank_ispb"],"properties":{"bank_ispb":{"title":"bank_ispb","description":"Bank ISPB","type":"string","example":"00001234"},"account_number":{"title":"account_number","description":"Account number","type":"string","example":"123456"},"account_branch":{"title":"account_branch","description":"Account branch","type":"string","example":"1234"}},"type":"object"},"PaginationForClientBankAccount":{"title":"Pagination","description":"Pagination","properties":{"data":{"title":"data","description":"Array of client bank accounts)","type":"array","items":{"anyOf":[{"$ref":"#/components/schemas/ClientBankAccount"}]},"readOnly":true},"links":{"$ref":"#/components/schemas/Links"},"meta":{"$ref":"#/components/schemas/Meta"}},"type":"object"},"Links":{"title":"Links","description":"Links","properties":{"first":{"title":"first","description":"Show first page link","type":"string","readOnly":true,"example":"http://payments-api.zrobank.xyz/api/transactions?page=1"},"last":{"title":"last","description":"Show last page link","type":"string","example":"http://payments-api.zrobank.xyz/api/transactions?page=1"},"prev":{"title":"prev","description":"Show previous page link","type":"string","readOnly":true,"example":null},"next":{"title":"next","description":"Show next page link","type":"string","readOnly":true,"example":null}},"type":"object"},"Meta":{"title":"Meta","description":"Links","properties":{"current_page":{"title":"current_page","description":"Current page number","type":"integer","example":1},"from":{"title":"from","description":"From page number","type":"integer","example":null},"last_page":{"title":"last_page","description":"Last page number","type":"integer","example":1},"links":{"title":"links","description":"Array of links to navigate the pages","type":"array","items":{"anyOf":[{"$ref":"#/components/schemas/MetaLinks1"},{"$ref":"#/components/schemas/MetaLinks2"},{"$ref":"#/components/schemas/MetaLinks3"}]},"readOnly":true},"path":{"title":"path","description":"Pagination path","type":"string","readOnly":true,"example":"http://payments-api.zrobank.xyz/api/transactions"},"per_page":{"title":"per_page","description":"Pagination per_page number of items","type":"integer","readOnly":true,"example":10},"to":{"title":"to","description":"Pagination to page","type":"integer","readOnly":true,"example":null},"total":{"title":"total","description":"Total number of items per page","type":"integer","readOnly":true,"example":1}},"type":"object"},"MetaLinks1":{"title":"MetaLinks","description":"MetaLinks","required":["url","label","active"],"properties":{"url":{"title":"url","description":"url","type":"string","example":"null"},"label":{"title":"label","description":"label","type":"string","example":"Anterior"},"active":{"title":"active","description":"active","type":"boolean","example":false}},"type":"object"},"MetaLinks2":{"title":"MetaLinks","description":"MetaLinks","properties":{"url":{"title":"url","description":"url","type":"string","example":"http://payments-api.zrobank.xyz/api/transactions?page=1"},"label":{"title":"label","description":"label","type":"string","example":"1"},"active":{"title":"active","description":"active","type":"boolean","example":true}},"type":"object"},"MetaLinks3":{"title":"MetaLinks","description":"MetaLinks","required":["url","label","active"],"properties":{"url":{"title":"url","description":"url","type":"string","example":null},"label":{"title":"label","description":"label","type":"string","example":"Próxima"},"active":{"title":"active","description":"active","type":"boolean","example":false}},"type":"object"},"Pagination":{"title":"Pagination","description":"Pagination","properties":{"data":{"title":"data","description":"Array of transactions data)","type":"array","items":{"anyOf":[{"$ref":"#/components/schemas/TransactionsDataResponse"}]},"readOnly":true},"links":{"$ref":"#/components/schemas/Links"},"meta":{"$ref":"#/components/schemas/Meta"}},"type":"object"},"LinksV2":{"title":"LinksV2","description":"Links","properties":{"first":{"title":"first","description":"Show first page link","type":"string","readOnly":true,"example":"http://payments-api.zrobank.xyz/api/transactions?page=1"},"last":{"title":"last","description":"Show last page link","type":"string","example":"http://payments-api.zrobank.xyz/api/transactions?page=1"},"prev":{"title":"prev","description":"Show previous page link","type":"string","readOnly":true,"example":null},"next":{"title":"next","description":"Show next page link","type":"string","readOnly":true,"example":null}},"type":"object"},"MetaLinks1V2":{"title":"MetaLinks","description":"MetaLinks","required":["url","label","active"],"properties":{"url":{"title":"url","description":"url","type":"string","example":"null"},"label":{"title":"label","description":"label","type":"string","example":"Anterior"},"active":{"title":"active","description":"active","type":"boolean","example":false}},"type":"object"},"MetaLinks2V2":{"title":"MetaLinks","description":"MetaLinks","properties":{"url":{"title":"url","description":"url","type":"string","example":"http://payments-api.zrobank.xyz/api/transactions?page=1"},"label":{"title":"label","description":"label","type":"string","example":"1"},"active":{"title":"active","description":"active","type":"boolean","example":true}},"type":"object"},"MetaLinks3V2":{"title":"MetaLinksV2","description":"MetaLinks","required":["url","label","active"],"properties":{"url":{"title":"url","description":"url","type":"string","example":null},"label":{"title":"label","description":"label","type":"string","example":"Próxima"},"active":{"title":"active","description":"active","type":"boolean","example":false}},"type":"object"},"MetaV2":{"title":"MetaV2","description":"Links","properties":{"current_page":{"title":"current_page","description":"Current page number","type":"integer","example":1},"from":{"title":"from","description":"From page number","type":"integer","example":null},"last_page":{"title":"last_page","description":"Last page number","type":"integer","example":1},"links":{"title":"links","description":"Array of links to navigate the pages","type":"array","items":{"anyOf":[{"$ref":"#/components/schemas/MetaLinks1V2"},{"$ref":"#/components/schemas/MetaLinks2V2"},{"$ref":"#/components/schemas/MetaLinks3V2"}]},"readOnly":true},"path":{"title":"path","description":"Pagination path","type":"string","readOnly":true,"example":"http://payments-api.zrobank.xyz/api/transactions"},"per_page":{"title":"per_page","description":"","type":"integer","readOnly":true,"example":10},"to":{"title":"to","description":"Pagination to page","type":"integer","readOnly":true,"example":null},"total":{"title":"total","description":"Total number of items per page","type":"integer","readOnly":true,"example":1}},"type":"object"},"PaginationV2":{"title":"PaginationV2","description":"PaginationV2","properties":{"data":{"title":"data","description":"Array of transactions data)","type":"array","items":{"anyOf":[{"$ref":"#/components/schemas/TransactionResponse"}]},"readOnly":true},"links":{"$ref":"#/components/schemas/LinksV2"},"meta":{"$ref":"#/components/schemas/MetaV2"}},"type":"object"},"PaginationForPixKey":{"title":"Pagination","description":"Pagination","properties":{"data":{"title":"data","description":"Array of transactions data)","type":"array","items":{"anyOf":[{"$ref":"#/components/schemas/PixKey"}]},"readOnly":true},"links":{"$ref":"#/components/schemas/Links"},"meta":{"$ref":"#/components/schemas/Meta"}},"type":"object"},"PixKey":{"title":"Pix Key","description":"Info about the requested pix key","properties":{"id":{"title":"id","description":"Pix Key id","type":"string","readOnly":true,"example":"649604ff-dd72-4c2c-8909-9d49dbbd1bde"},"type":{"title":"type","description":"Pix Key type","type":"string","enum":["CPF","CNPJ","EMAIL","PHONE","EVP"],"readOnly":true,"example":"EVP"},"key":{"title":"key","description":"Pix Key","type":"string","readOnly":true,"example":"32c32de0-50f7-4f4f-96d9-81d716e69864"},"emv":{"title":"emv","description":"EMV related to the key","type":"string","readOnly":true,"example":"00020101021126330014br.gov.bcb.pix0111082853887515204000053039865406100.005802BR5912API DE TESTE6009SAO PAULO620605022163045927"},"created_at":{"title":"created_at","description":"Date when the key was created","type":"string","readOnly":true,"example":"2024-07-12T19:30:35.000000Z"}},"type":"object"},"PixKeyCreate":{"title":"Pix Key","description":"Info about the requested pix key","properties":{"id":{"title":"id","description":"Key id","type":"string","readOnly":true,"example":"649604ff-dd72-4c2c-8909-9d49dbbd1bde"},"type":{"title":"type","description":"Key's type","type":"string","readOnly":true,"example":"EVP"},"key":{"title":"key","description":"Key","type":"string","readOnly":true,"example":"32c32de0-50f7-4f4f-96d9-81d716e69864"},"emv":{"title":"emv","description":"EMV related to the key","type":"string","readOnly":true,"example":"00020101021126330014br.gov.bcb.pix0111082853887515204000053039865406100.005802BR5912API DE TESTE6009SAO PAULO620605022163045927"}},"type":"object"},"PixKeyRequest":{"title":"Create Pix Key","description":"Creates a new pix key","required":["account_number","account_branch"],"properties":{"account_number":{"type":"string","example":"12345"},"account_branch":{"type":"string","example":"0001"}},"type":"object"},"OrderQrCode":{"title":"QrCode request fields","description":"QrCode request fields","required":["value","description","merchant_id","orders"],"properties":{"value":{"title":"value","description":"Value to be paid","type":"number","format":"double","writeOnly":true,"example":"300"},"description":{"title":"description","description":"Description of the transaction","type":"string","writeOnly":true,"example":"Qr code Zro Gateway"},"client_document":{"title":"client_document","description":"Document of the person whose charge is being designed to","type":"string","writeOnly":true,"example":"80064671020"},"code":{"title":"code","description":"Response code","type":"integer","enum":[200,422,404,408,500],"readOnly":true,"example":"200"},"status":{"title":"status","description":"Transaction status","type":"string","enum":["pending","failed"],"readOnly":true,"example":"pending"},"message":{"title":"message","description":"Message about the request","type":"string","readOnly":true,"example":null},"qr_code":{"title":"qr_code","description":"PIX EMV QrCode","type":"string","readOnly":true,"example":"00020101021126330014br.gov.bcb.pix0111082853887515204000053039865406100.005802BR5912API DE TESTE6009SAO PAULO620605022163045927"},"transaction_uuid":{"title":"transaction_uuid","description":"Reference of the QrCode for conciliation","type":"string","readOnly":true,"example":"4807e6e8-b693-4235-aeba-f119b0d32fc0"},"merchant_id":{"title":"merchant_id","description":"Reference of the store that solicitate the QrCode","type":"string","example":"7da0c9af-215e-4625-b484-b8cfc87aaa09"},"orders":{"title":"orders","description":"Array of object that contains fee value and the company_identifier(wallet identifier)","type":"array","items":{"anyOf":[{"$ref":"#/components/schemas/OrderResource"},{"$ref":"#/components/schemas/OrderResource2"},{"$ref":"#/components/schemas/OrderResource3"}]},"writeOnly":true}},"type":"object"},"QrCode":{"title":"QrCode request fields","description":"QrCode request fields","required":["value","description","client_name","client_document","merchant_id"],"properties":{"value":{"title":"value","description":"Value to be paid","type":"number","format":"double","writeOnly":true,"example":"10.00"},"description":{"title":"description","description":"Description of the transaction","type":"string","writeOnly":true,"example":"Cobrança de deposito"},"client_name":{"title":"client_name","description":"Name of the person the charge is being designed to","type":"string","writeOnly":true,"example":"Johnny"},"client_email":{"title":"client_email","description":"Email of the person the charge is being designed to","type":"string","writeOnly":true,"example":"client@email.com"},"client_document":{"title":"client_document","description":"Document of the person the charge is being designed to","type":"string","writeOnly":true,"example":"80064671020"},"code":{"title":"code","description":"Response code","type":"integer","enum":[200,422,404,408,500],"readOnly":true,"example":"200"},"status":{"title":"status","description":"Transaction status","type":"string","enum":["pending","failed"],"readOnly":true,"example":"pending"},"message":{"title":"message","description":"Message about the request","type":"string","readOnly":true,"example":null},"qr_code":{"title":"qr_code","description":"PIX EMV QrCode","type":"string","readOnly":true,"example":"00020101021126330014br.gov.bcb.pix0111082853887515204000053039865406100.005802BR5912API DE TESTE6009SAO PAULO620605022163045927"},"transaction_uuid":{"title":"transaction_uuid","description":"Reference of the QrCode for conciliation","type":"string","readOnly":true,"example":"7da0c9af-215e-4625-b484-b8cfc87aaa09"},"merchant_id":{"title":"merchant_id","description":"Reference of the store that requests the QrCode","type":"string","example":"271e4016-47de-45e0-9340-6f2560ce3a90"},"expiration_date":{"title":"expiration_date","description":"UTC date informing when the QrCode is going to expire","type":"string","writeOnly":true,"example":"2024-01-25T18:25:43.000Z"},"client_bank_accounts":{"title":"client_bank_accounts","description":"Bank accounts of the person the charge is being designed to","type":"array","items":{"required":["bank_ispb","account_number","account_branch"],"properties":{"bank_ispb":{"title":"bank_ispb","description":"Bank ISPB","type":"string","maxLength":8,"minLength":8,"writeOnly":true,"example":"26264220"},"account_number":{"title":"account_number","description":"Account Number","type":"string","writeOnly":true,"example":"1234"},"account_branch":{"title":"account_branch","description":"Account Branch","type":"string","maxLength":4,"minLength":4,"writeOnly":true,"example":"0001"}},"type":"object"},"writeOnly":true}},"type":"object"},"OldRefundResponse":{"title":"A refund information","description":"A refund information","properties":{"code":{"title":"code","description":"Response code","type":"integer","enum":[201,422,404,408,500],"readOnly":true,"example":"201"},"status":{"title":"status","description":"Transaction status","type":"string","enum":["pending","failed"],"readOnly":true,"example":"pending"},"message":{"title":"message","description":"Message about the request","type":"string","readOnly":true,"example":"Refund transaction created successfully"},"transaction_uuid":{"title":"transaction_uuid","description":"Reference of the transaction that should be returned","type":"string","example":"c808c55d-0110-4070-97ef-4459d9e2c595"},"merchant_id":{"title":"merchant_id","description":"Reference of the store that solicitate the return","type":"string","example":"7da0c9af-215e-4625-b484-b8cfc87aaa09"}},"type":"object"},"RefundRequest":{"title":"Create a refund from a deposit transaction","description":"Create a refund from a deposit transaction","required":["value","transaction_uuid","merchant_id"],"properties":{"value":{"title":"value","description":"Value to be refunded","type":"number","format":"float","example":"1.3"},"description":{"title":"description","description":"Description of the return","type":"string","example":"Refund of funds"},"transaction_uuid":{"title":"transaction_uuid","description":"Uuid of the transaction that should be refunded","type":"string","example":"1a3259d0-f3b9-40dd-ab60-f594996a6453"},"merchant_id":{"title":"merchant_id","description":"Field to use as identification purpose","type":"string","example":"refund_001"}},"type":"object"},"RefundResponse":{"title":"Solicitation of the requested refund","description":"Solicitation of the requested refund","required":["status"],"properties":{"status":{"title":"status","description":"Status about the refund","type":"string","enum":["awaiting","failed"],"example":"awaiting"},"message":{"title":"message","description":"Description of the refund","type":"string","example":"Refund of funds"},"transaction_uuid":{"title":"transaction_uuid","description":"Uuid of the transaction that should be refunded","type":"string","example":"1a3259d0-f3b9-40dd-ab60-f594996a6453"},"merchant_id":{"title":"merchant_id","description":"Field to use as identification purpose","type":"string","example":"refund_001"}},"type":"object"},"RefundWithOrdersRequest":{"title":"Generate a refund transaction","description":"Generate a refund transaction","required":["description","merchant_id","transaction_uuid","description","client_document"],"properties":{"description":{"title":"description","description":"Description of the return","type":"string","writeOnly":true,"example":"Return example"},"merchant_id":{"title":"merchant_id","description":"Reference of the store that solicitate the return","type":"string","example":"7da0c9af-215e-4625-b484-b8cfc87aaa09"},"transaction_uuid":{"title":"transaction_uuid","description":"Reference of the transaction that should be returned","type":"string","example":"1a3259d0-f3b9-40dd-ab60-f594996a6453"},"client_document":{"title":"client_document","description":"Client's document (CPF or CNPJ)","type":"string","example":"13813438058"},"orders":{"title":"orders","description":"Only required if return_type is partial, array of object that contains value and the company_identifier that should return the value(wallet identifier)","type":"array","items":{"anyOf":[{"$ref":"#/components/schemas/RefundOrderResource"}]},"writeOnly":true}},"type":"object"},"RefundWithoutOrdersRequest":{"title":"Generate a refund transaction","description":"Generate a refund transaction","required":["description","merchant_id","transaction_uuid","description","client_document"],"properties":{"description":{"title":"description","description":"Description of the return","type":"string","writeOnly":true,"example":"Return example"},"merchant_id":{"title":"merchant_id","description":"Reference of the store that solicitate the return","type":"string","example":"7da0c9af-215e-4625-b484-b8cfc87aaa09"},"transaction_uuid":{"title":"transaction_uuid","description":"Reference of the transaction that should be returned","type":"string","example":"1a3259d0-f3b9-40dd-ab60-f594996a6453"},"client_document":{"title":"client_document","description":"Client's document (CPF or CNPJ)","type":"string","example":"13813438058"}},"type":"object"},"OrderResource":{"title":"Order","description":"Data of and order","required":["fee","value","company_identifier"],"properties":{"fee":{"description":"Percent of fee for the store","type":"number","format":"float","example":"10"},"value":{"description":"Value for the store","type":"number","format":"float","example":"100"},"company_identifier":{"description":"Identifier for the store(wallet identifier)","type":"string","example":"f6e2e084-29b9-4935-a059-5473b13033aa"}},"type":"object"},"OrderResource2":{"title":"Order","description":"Data of and order","required":["fee","value","company_identifier"],"properties":{"fee":{"description":"Percent of fee for the store","type":"number","format":"float","example":"20"},"value":{"description":"Value for the store","type":"number","format":"float","example":"100"},"company_identifier":{"description":"Identifier for the store(wallet identifier)","type":"string","example":"df1a24a0-8f4e-478e-84f9-326f48c1f2f2"}},"type":"object"},"OrderResource3":{"title":"Order","description":"Data of and order","required":["fee","value","company_identifier"],"properties":{"fee":{"description":"Percent of fee for the store","type":"number","format":"float","example":"10"},"value":{"description":"Value for the store","type":"number","format":"float","example":"100"},"company_identifier":{"description":"Identifier for the store(wallet identifier)","type":"string","example":"74b00eb0-9784-421c-b24c-4f08a50f8466"}},"type":"object"},"RefundOrderResource":{"title":"Order","description":"Data of and order","required":["value","company_identifier"],"properties":{"value":{"description":"Value that should be returned to the store","type":"number","format":"float","example":"100"},"company_identifier":{"description":"Identifier for the store that should return the value(wallet identifier)","type":"string","example":"f6e2e084-29b9-4935-a059-5473b13033aa"}},"type":"object"},"Response401":{"title":"Response 401 example","description":"Response 401 example","properties":{"message":{"title":"message","description":"Response 401","type":"integer","readOnly":true,"example":"Invalid x-api-key"}},"type":"object"},"Response404":{"title":"Response 404 example","description":"Response 404 example","properties":{"message":{"title":"message","description":"Response 404","type":"string","readOnly":true,"example":"Resource not found"}},"type":"object"},"Response409":{"title":"Response 409 example","description":"Response 409 example","properties":{"message":{"title":"message","description":"Response 409","type":"string","readOnly":true,"example":"Duplicate request"},"status":{"title":"status","description":"Response 409","type":"string","readOnly":true,"example":"failed"},"transaction_uuid":{"title":"transaction_uuid","description":"Response 409","type":"string","readOnly":true,"example":null}},"type":"object"},"Response422":{"title":"HTTP status 422 response example","description":"HTTP status 422 response example","properties":{"message":{"title":"message","description":"Error message","type":"string","readOnly":true},"errors":{"title":"errors","description":"Errors occurred during data validation request","type":"array","items":{},"readOnly":true}},"type":"object"},"Withdraw":{"title":"Withdraw request response","description":"Withdraw request response","properties":{"status":{"title":"status","description":"Transaction's status","type":"string","enum":["pending","failed"],"example":"pending"},"message":{"title":"message","description":"Payment's description","type":"string","example":"Withdrawal payment done"},"transaction_uuid":{"title":"transaction_uuid","description":"Transaction's UUID","type":"string","example":"7da0c9af-215e-4625-b484-b8cfc87aaa09"}},"type":"object"},"WithdrawByAccountRequest":{"title":"PIX payment by bank account data","description":"PIX payment by bank account data","required":["value","account_number","account_type","branch","ispb","description","client_name","client_document","merchant_id"],"properties":{"value":{"title":"value","description":"Value to be paid","type":"number","format":"float","example":"10.00"},"account_number":{"title":"account_number","description":"Customer account's number","type":"string","example":"98215"},"account_type":{"title":"account_type","description":"Customer account's type. Most commonly used are: CACC (Current Account), SLRY (Salary Account), SVGS (Savings Account) and TRAN (Transacting Account)","type":"string","enum":["CACC","CASH","CHAR","CISH","COMM","CPAC","LLSV","LOAN","MGLD","MOMA","NREX","ODFT","ONDP","OTHR","SACC","SLRY","SVGS","TAXE","TRAN","TRAS"],"example":"CACC"},"branch":{"title":"branch","description":"Customer's bank account branch","type":"string","example":"0001"},"ispb":{"title":"ispb","description":"Customer's bank account ISPB. Unlike the 3-digit bank code, the ISPB is an 8-digit internal code of the brazilian financial system used for transactions between banks and fintechs. [Click here](/api/pix-participants) to check the ISPB of the institutions participating in Pix.","type":"string","example":"26264220"},"description":{"title":"description","description":"Description of the payment","type":"string","example":"Payment to customer"},"client_name":{"title":"client_name","description":"Customer's name","type":"string","example":"John"},"client_document":{"title":"client_document","description":"Customer's document (CPF or CNPJ)","type":"string","example":"13813438058"},"merchant_id":{"title":"merchant_id","description":"Merchant's ID for conciliation","type":"string","example":"123456"}},"type":"object"},"WithdrawRequest":{"title":"PIX payment by key","description":"PIX payment by key","required":["value","type_key_pix","key","description","client_name","client_email","client_document","merchant_id"],"properties":{"value":{"title":"value","description":"Value to be paid","type":"number","format":"double","example":"10.00"},"type_key_pix":{"title":"type_key_pix","description":"PIX key type","type":"string","enum":["cpf","cnpj","email","phone","evp"],"example":"phone"},"key":{"title":"key","description":"PIX key","type":"string","example":"+5533123456789"},"description":{"title":"description","description":"Description of the payment","type":"string","example":"Payment to client"},"client_name":{"title":"client_name","description":"Client's name","type":"string","example":"John"},"client_email":{"title":"client_email","description":"Client's email","type":"string","example":"client@email.com"},"client_document":{"title":"client_document","description":"Client's document (CPF or CNPJ)","type":"string","example":"13813438058"},"merchant_id":{"title":"merchant_id","description":"Merchant's ID for conciliation","type":"string","example":"123456"}},"type":"object"},"TransactionResponse":{"title":"Transaction information","description":"Transaction information","properties":{"transaction_uuid":{"title":"transaction_uuid","description":"Reference of the QrCode for conciliation","type":"string","example":"7da0c9af-215e-4625-b484-b8cfc87aaa09"},"status":{"title":"status","description":"Transaction status","type":"string","enum":["pending","paid","paid_by_third_party","failed","awaiting","payment rejected","paid_without_qrcode","refund_received"],"example":"pending"},"transaction_type":{"title":"transaction_type","description":"Transaction type","type":"string","enum":["transaction","withdraw","refund"],"example":"withdraw"},"value":{"title":"value","description":"Value of the transaction","type":"string","example":"10.00"},"client_document":{"title":"cpf_cnpj","description":"Document of the person who paid or received (CPF or CNPJ)","type":"string","example":"80064671020"},"created_at":{"title":"created_at","description":"Date when the transaction was created","type":"string","example":"2023-06-13T13:42:31.000000Z"},"merchant_id":{"title":"merchant_id","description":"Merchant's ID for conciliation","type":"string","example":"123456"},"costumer_name":{"title":"costumer_name","description":"Costumer's name","type":"string","example":"Johnny Georgios"},"costumer_email":{"title":"costumer_email","description":"Costumer's email","type":"string","example":"johnny@gmail.com"},"end_to_end_id":{"title":"end_to_end_id","description":"Transaction's pix end_to_end_id","type":"string","example":"E0000000020230613111111aaaaa1111"},"updated_at":{"title":"updated_at","description":"Date when the transaction was last updated","type":"string","example":"2023-06-13T13:42:31.000000Z"},"payment_date":{"title":"payment_date","description":"Date when the transaction was confirmed as paid","type":"string","example":"2023-06-13 03:00:00.000"}},"type":"object"},"TransactionsDataResponse":{"title":"Transaction information V1","description":"Transaction information","properties":{"transaction_uuid":{"title":"transaction_uuid","description":"Reference of the QrCode for conciliation","type":"string","example":"7da0c9af-215e-4625-b484-b8cfc87aaa09"},"status":{"title":"status","description":"Transaction status","type":"string","enum":["pending","paid","paid_by_third_party","failed","awaiting","payment rejected","paid_without_qrcode","refund_received"],"example":"pending"},"transaction_type":{"title":"transaction_type","description":"Transaction type","type":"string","enum":["transaction","withdraw","refund"],"example":"withdraw"},"value":{"title":"value","description":"Transaction value","type":"string","example":"10.00"},"client_document":{"title":"cpf_cnpj","description":"Document of the person who paid or received (CPF or CNPJ)","type":"string","example":"80064671020"},"created_at":{"title":"created_at","description":"Date when the transaction was created","type":"string","example":"2023-06-13T13:42:31.000000Z"},"merchant_id":{"title":"merchant_id","description":"Merchant's ID for conciliation","type":"string","example":"123456"}},"type":"object"},"UpdateTransactionStatus":{"title":"Update transaction status request fields","description":"Update transaction status request fields","required":["transaction_uuid","status"],"properties":{"transaction_uuid":{"title":"transaction_uuid","description":"Reference of the Transaction","type":"string","writeOnly":true,"example":"7da0c9af-215e-4625-b484-b8cfc87aaa09"},"status":{"title":"status","description":"Transaction status","type":"string","enum":["pending","paid","awaiting","on_hold","failed"],"writeOnly":true,"example":"pending"}},"type":"object"},"KycWebhook":{"title":"Kyc Webhook payload","description":"Kyc Webhook payload","required":["document"],"properties":{"name":{"title":"name","description":"Name of the client","type":"string","example":"Jhon Doe"},"document":{"title":"document","description":"Document of the client","type":"string","example":"***12345**"},"ofLegalAge":{"title":"ofLegalAge","description":"Client is of legal age","type":"boolean","example":"false"},"age":{"title":"age","description":"Client's age","type":"integer","example":"22"},"suspectedDeath":{"title":"suspectedDeath","description":"Tells if client has died","type":"boolean","example":"false"},"pep":{"title":"pep","description":"Tells if client is politically exposed","type":"boolean","example":"false"}},"type":"object"},"WebhookPixWithoutQrCode":{"title":"Webhook PIX Without QrCode","description":"Webhook payload","required":["status","webhook_type","transaction_uuid","value","end_to_end_id"],"properties":{"status":{"title":"status","description":"Transaction status","type":"string","enum":["paid","failed"],"example":"paid"},"webhook_type":{"title":"webhook_type","description":"Transaction type","type":"string","enum":["transaction"],"example":"transaction"},"transaction_uuid":{"title":"transaction_uuid","description":"Transaction UUID","type":"string","example":"7da0c9af-215e-4625-b484-b8cfc87aaa09"},"description":{"title":"description","description":"Transaction description","type":"string","example":"Client's QrCode"},"value":{"title":"value","description":"Transaction value","type":"string","example":"10.00"},"payment_date":{"title":"payment_date","description":"Payment date","type":"string","example":"2023-01-01T12:11:39.090"},"merchant_id":{"title":"merchant_id","description":"Reference of the store that solicitate the action","type":"string","example":"3f49f95d-6c0e-4d2c-bdd0-40c20f372c42"},"end_to_end_id":{"title":"end_to_end_id","description":"End to end id of the transaction","type":"string","example":"E1234567820232152928tWRD01e2fXX"},"client":{"title":"client","description":"Information about the client","type":"array","items":{"properties":{"name":{"description":"Client's name","type":"string","example":"Jhonny"},"cpf_cnpj":{"description":"Client's document","type":"string","example":"20697282007"}},"type":"object"},"nullable":true},"bank_account_data":{"title":"bank_account_data","description":"Information about the payer's bank account","type":"array","items":{"properties":{"bank_name":{"description":"Bank's name","type":"string","example":"ZRO PAGAMENTOS S.A."},"bank_ispb":{"description":"Bank's ISPB","type":"string","example":"26264220"}},"type":"object"},"nullable":true}},"type":"object"},"WebhookV1Payload":{"title":"Webhook V1 payload","description":"Webhook payload","required":["status","webhook_type","transaction_uuid","value","cpf_cnpj"],"properties":{"status":{"title":"status","description":"Transaction status","type":"string","enum":["paid","failed"],"example":"paid"},"webhook_type":{"title":"webhook_type","description":"Transaction type","type":"string","enum":["transaction","withdraw","refund"],"example":"transaction"},"transaction_uuid":{"title":"transaction_uuid","description":"Transaction UUID","type":"string","example":"7da0c9af-215e-4625-b484-b8cfc87aaa09"},"status_reason":{"title":"status_reason","description":"Transaction description","type":"string","example":"Payment rejected by client's SPI"},"value":{"title":"value","description":"Transaction value","type":"string","example":"10.00"},"payment_date":{"title":"payment_date","description":"Payment date","type":"string","example":"2023-01-01T12:11:39.090"},"cpf_cnpj":{"title":"cpf_cnpj","description":"Document of the person who paid or received (CPF or CNPJ)","type":"string","example":"80064671020"},"end_to_end_id":{"title":"end_to_end_id","description":"End to end id of the transaction","type":"string","example":"E1234567820232152928tWRD01e2fXX"},"merchant_id":{"title":"merchant_id","description":"Reference of the store that solicitate the action","type":"string","example":"3f49f95d-6c0e-4d2c-bdd0-40c20f372c42"}},"type":"object"},"WebhookV2Payload":{"title":"Webhook V2 payload","description":"Webhook payload","required":["status","webhook_type","transaction_uuid","value","cpf_cnpj"],"properties":{"status":{"title":"status","description":"Transaction status","type":"string","enum":["paid","failed"],"example":"paid"},"webhook_type":{"title":"webhook_type","description":"Transaction type","type":"string","enum":["transaction","withdraw","refund"],"example":"transaction"},"transaction_uuid":{"title":"transaction_uuid","description":"Transaction UUID","type":"string","example":"7da0c9af-215e-4625-b484-b8cfc87aaa09"},"status_reason":{"title":"status_reason","description":"Transaction description","type":"string","example":"Payment rejected by client's SPI"},"value":{"title":"value","description":"Transaction value","type":"string","example":"10.00"},"payment_date":{"title":"payment_date","description":"Payment date","type":"string","example":"2023-01-01T12:11:39.090"},"cpf_cnpj":{"title":"cpf_cnpj","description":"Document of the person who paid or received (CPF or CNPJ)","type":"string","example":"80064671020"},"end_to_end_id":{"title":"end_to_end_id","description":"End to end id of the transaction","type":"string","example":"E1234567820232152928tWRD01e2fXX"},"merchant_id":{"title":"merchant_id","description":"Reference of the store that solicitate the action","type":"string","example":"3f49f95d-6c0e-4d2c-bdd0-40c20f372c42"},"refund":{"title":"refund","description":"Information if deposit was refunded","type":"array","items":{"properties":{"transaction_parent_uuid":{"description":"UUID of the main transaction","type":"string","example":"fb81f2f5-a8bc-4416-823a-abe5e213cd00"}},"type":"object"},"nullable":true}},"type":"object"},"WebhookV3Payload":{"title":"Webhook V3 payload","description":"Webhook payload","required":["status","webhook_type","transaction_uuid","value","end_to_end_id"],"properties":{"status":{"title":"status","description":"Transaction status","type":"string","enum":["paid","failed"],"example":"paid"},"webhook_type":{"title":"webhook_type","description":"Transaction type","type":"string","enum":["transaction","withdraw","refund"],"example":"transaction"},"transaction_uuid":{"title":"transaction_uuid","description":"Transaction UUID","type":"string","example":"7da0c9af-215e-4625-b484-b8cfc87aaa09"},"description":{"title":"description","description":"Transaction description","type":"string","example":"Client's QrCode"},"value":{"title":"value","description":"Transaction value","type":"string","example":"10.00"},"payment_date":{"title":"payment_date","description":"Payment date","type":"string","example":"2023-01-01T12:11:39.090"},"merchant_id":{"title":"merchant_id","description":"Reference of the store that solicitate the action","type":"string","example":"3f49f95d-6c0e-4d2c-bdd0-40c20f372c42"},"end_to_end_id":{"title":"end_to_end_id","description":"End to end id of the transaction","type":"string","example":"E1234567820232152928tWRD01e2fXX"},"client":{"title":"client","description":"Information about the client","type":"array","items":{"properties":{"name":{"description":"Client's name","type":"string","example":"Jhonny"},"cpf_cnpj":{"description":"Client's document","type":"string","example":"20697282007"}},"type":"object"},"nullable":true},"payer":{"title":"payer","description":"Information about who paid (exists when transaction_type is transaction)","type":"array","items":{"properties":{"name":{"description":"Payer's name","type":"string","example":"Joseph"},"cpf_cnpj":{"description":"Payer's document","type":"string","example":"***252670**"},"bank_name":{"description":"Payer's bank","type":"string","example":"Zro Pagamento S.A."},"bank_ispb":{"description":"Payer's bank ISPB","type":"string","example":"26264220"},"paid_by_client":{"description":"Tells if the client and the payer are the same person","type":"boolean","example":"false"}},"type":"object"},"nullable":true},"receiver":{"title":"receiver","description":"Information about who received the money (exists when transaction_type is withdraw or refund)","type":"array","items":{"properties":{"name":{"description":"Receiver's name","type":"string","example":"Jonathan"},"cpf_cnpj":{"description":"Receiver's document","type":"string","example":"69878431045"},"bank_name":{"description":"Receiver's bank","type":"string","example":"Zro Pagamento S.A."},"bank_ispb":{"description":"Receiver's bank ISPB","type":"string","example":"26264220"}},"type":"object"},"nullable":true},"refund":{"title":"refund","description":"Information if deposit was refunded (exists when transaction_type is refund)","type":"array","items":{"properties":{"transaction_parent_uuid":{"description":"UUID of the main transaction","type":"string","example":"fb81f2f5-a8bc-4416-823a-abe5e213cd00"}},"type":"object"},"nullable":true}},"type":"object"},"WebhookV4Payload":{"title":"Webhook V4 payload","description":"Webhook payload","required":["status","webhook_type","transaction_uuid","value","end_to_end_id"],"properties":{"status":{"title":"status","description":"Transaction status","type":"string","enum":["paid","failed"],"example":"paid"},"webhook_type":{"title":"webhook_type","description":"Transaction type","type":"string","enum":["transaction","withdraw","refund"],"example":"transaction"},"transaction_uuid":{"title":"transaction_uuid","description":"Transaction UUID","type":"string","example":"7da0c9af-215e-4625-b484-b8cfc87aaa09"},"description":{"title":"description","description":"Transaction description","type":"string","example":"Client's QrCode"},"value":{"title":"value","description":"Transaction value","type":"string","example":"10.00"},"payment_date":{"title":"payment_date","description":"Payment date","type":"string","example":"2023-01-01T12:11:39.090"},"merchant_id":{"title":"merchant_id","description":"Reference of the store that solicitate the action","type":"string","example":"3f49f95d-6c0e-4d2c-bdd0-40c20f372c42"},"end_to_end_id":{"title":"end_to_end_id","description":"End to end id of the transaction","type":"string","example":"E1234567820232152928tWRD01e2fXX"},"client":{"title":"client","description":"Information about the client","type":"array","items":{"properties":{"name":{"description":"Client's name","type":"string","example":"Jhonny"},"cpf_cnpj":{"description":"Client's document","type":"string","example":"20697282007"}},"type":"object"},"nullable":true},"payer":{"title":"payer","description":"Information about who paid (exists when transaction_type is transaction)","type":"array","items":{"properties":{"name":{"description":"Payer's name","type":"string","example":"Joseph"},"cpf_cnpj":{"description":"Payer's document","type":"string","example":"***252670**"},"bank_name":{"description":"Payer's bank","type":"string","example":"Zro Pagamento S.A."},"bank_ispb":{"description":"Payer's bank ISPB","type":"string","example":"26264220"},"paid_by_client":{"description":"Tells if the client and the payer are the same person","type":"boolean","example":"false"}},"type":"object"},"nullable":true},"receiver":{"title":"receiver","description":"Information about who received the money (exists when transaction_type is withdraw or refund)","type":"array","items":{"properties":{"name":{"description":"Receiver's name","type":"string","example":"Jonathan"},"cpf_cnpj":{"description":"Receiver's document","type":"string","example":"69878431045"},"bank_name":{"description":"Receiver's bank","type":"string","example":"Zro Pagamento S.A."},"bank_ispb":{"description":"Receiver's bank ISPB","type":"string","example":"26264220"}},"type":"object"},"nullable":true},"refund":{"title":"refund","description":"Information if deposit was refunded (exists when transaction_type is refund)","type":"array","items":{"properties":{"transaction_parent_uuid":{"description":"UUID of the main transaction","type":"string","example":"fb81f2f5-a8bc-4416-823a-abe5e213cd00"}},"type":"object"},"nullable":true},"bank_account_data":{"title":"bank_account_data","description":"Information about the payer's bank account","type":"array","items":{"properties":{"bank_name":{"description":"Bank's name","type":"string","example":"ZRO PAGAMENTOS S.A."},"bank_ispb":{"description":"Bank's ISPB","type":"string","example":"26264220"},"account_number":{"description":"Payer's account number","type":"string","example":"56841"},"account_branch":{"description":"Payers's account branch","type":"string","example":"0001"},"account_type":{"description":"Payer's account type","type":"string","enum":["CACC","CASH","CHAR","CISH","COMM","CPAC","LLSV","LOAN","MGLD","MOMA","NREX","ODFT","ONDP","OTHR","SACC","SLRY","SVGS","TAXE","TRAN","TRAS"],"example":"CACC"}},"type":"object"},"nullable":true}},"type":"object"}},"securitySchemes":{"paas_token":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Token utilizado para autenticação na Api PaaS"}}},"tags":[{"name":"Client Accounts","description":"Client Accounts"},{"name":"Pix Key","description":"Pix Key"},{"name":"Refunds","description":"Refunds"},{"name":"QR Code","description":"QR Code"},{"name":"Transactions","description":"Transactions"},{"name":"Withdrawals","description":"Withdrawals"}]}