{"items":[{"type":"link","label":"Fincore API","link":"/products/fincore/fincore-openapi","routeSlug":"/products/fincore/fincore-openapi","content":{"contentType":"overview","meta":{"name":"Fincore API"},"children":[{"nodeType":"container","panels":[{"title":"Download OpenAPI description","titleTranslationKey":"download.description.title","children":[{"kind":"download","label":"fincore-openapi.json","url":"/_bundle/products/fincore/fincore-openapi.json?download"},{"kind":"download","label":"fincore-openapi.yaml","url":"/_bundle/products/fincore/fincore-openapi.yaml?download"}]},{"title":"Overview","titleTranslationKey":"info.title","children":[]},{"title":"Languages","titleTranslationKey":"languages.title","children":[{"kind":"languages","options":[{"key":"curl","title":"curl","lang":"curl"},{"key":"javascript","title":"JavaScript","lang":"JavaScript"},{"key":"node","title":"Node.js","lang":"Node.js"},{"key":"python","title":"Python","lang":"Python"},{"key":"java","title":"Java","lang":"Java"},{"key":"csharp","title":"C#","lang":"C#"},{"key":"php","title":"PHP","lang":"PHP"},{"key":"go","title":"Go","lang":"Go"},{"key":"ruby","title":"Ruby","lang":"Ruby"},{"key":"r","title":"R","lang":"R"},{"key":"payload","title":"Payload","lang":"Payload"}]}]},{"title":"Servers","titleTranslationKey":"servers.title","children":[{"kind":"servers","servers":[{"url":"https://apicore.stg.finch.lat"}],"mode":"default"}]}],"children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"header","level":1,"label":"Fincore API (1.0.0)","showPageActions":true},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":"Monato is a financial technology company specializing in SPEI transfer services in Mexico. We provide secure, fast, and reliable payment solutions for businesses, enabling seamless bank transfers through our API and platform"}],"sectionId":"/products/fincore/fincore-openapi"}],"sectionId":"/products/fincore/fincore-openapi"}]}]}},{"label":"Retrieve client credentials","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/fincore/fincore-openapi/other/getclientcredentials","routeSlug":"/products/fincore/fincore-openapi/other/getclientcredentials","metadata":{"seo":{"title":"Retrieve client credentials","description":"Returns a list of credentials associated with a specific client."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getClientCredentials","name":"Retrieve client credentials","isWebhook":false,"pointer":"/paths/~1v1~1clients~1{clientId}~1credentials/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve client credentials","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns a list of credentials associated with a specific client."},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKeyAuth","scopes":[],"type":"apiKey","in":"header","paramName":"x-api-key","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API Key authentication using the \"x-api-key\" header. Contact us at support@monato.com so we can provide you an API Key."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"clientId","in":"path","schemaId":"schema_103","description":"The unique identifier of the client.","required":true}],"pointer":"/paths/~1v1~1clients~1{clientId}~1credentials/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/clients/{clientId}/credentials","servers":[{"url":"https://apicore.stg.finch.lat"}],"parameters":{"path":[{"name":"clientId","in":"path","required":true,"example":"c2d1d1e3-3340-4170-980e-e9269bbbc551","schemaId":"schema_103"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKeyAuth","type":"apiKey","name":"x-api-key","in":"header"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/v1/clients/{clientId}/credentials","href":"other/getclientcredentials","openApiOperationId":"getClientCredentials","summary":"Retrieve client credentials"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://apicore.stg.finch.lat"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"A list of client credentials.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CredentialsResponse"}},"schemaId":"components/schemas/CredentialsResponse"}],"pointer":"/paths/~1v1~1clients~1{clientId}~1credentials/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/CredentialsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CredentialsResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/other/getclientcredentials"}],"panels":[]}]},"httpPath":"/v1/clients/{clientId}/credentials"},{"label":"Create authentication token","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/fincore/fincore-openapi/other/createcredentialtoken","routeSlug":"/products/fincore/fincore-openapi/other/createcredentialtoken","metadata":{"seo":{"title":"Create authentication token","description":"Generates an authentication credential token for a private account."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createCredentialToken","name":"Create authentication token","isWebhook":false,"pointer":"/paths/~1v1~1clients~1{clientId}~1auth~1credential-tokens/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create authentication token","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Generates an authentication credential token for a private account."},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKeyAuth","scopes":[],"type":"apiKey","in":"header","paramName":"x-api-key","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API Key authentication using the \"x-api-key\" header. Contact us at support@monato.com so we can provide you an API Key."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"clientId","in":"path","schemaId":"schema_104","description":"Unique identifier for the client.","required":true}],"pointer":"/paths/~1v1~1clients~1{clientId}~1auth~1credential-tokens/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/AuthCredentialRequest"}},"schemaId":"components/schemas/AuthCredentialRequest","pointer":"/paths/~1v1~1clients~1{clientId}~1auth~1credential-tokens/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/clients/{clientId}/auth/credential-tokens","servers":[{"url":"https://apicore.stg.finch.lat"}],"parameters":{"path":[{"name":"clientId","in":"path","required":true,"schemaId":"schema_104"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKeyAuth","type":"apiKey","name":"x-api-key","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/AuthCredentialRequest"}},"responseCodes":["200"],"pointer":"/v1/clients/{clientId}/auth/credential-tokens","href":"other/createcredentialtoken","openApiOperationId":"createCredentialToken","summary":"Create authentication token"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://apicore.stg.finch.lat"}],"schemaId":"components/schemas/AuthCredentialRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/AuthCredentialRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successfully created credential token.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AuthCredentialResponse"}},"schemaId":"components/schemas/AuthCredentialResponse"}],"pointer":"/paths/~1v1~1clients~1{clientId}~1auth~1credential-tokens/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/AuthCredentialResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AuthCredentialResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/other/createcredentialtoken"}],"panels":[]}]},"httpPath":"/v1/clients/{clientId}/auth/credential-tokens"},{"label":"Retrieve catalog of SPEI participants","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/fincore/fincore-openapi/other/retrievebankscatalog","routeSlug":"/products/fincore/fincore-openapi/other/retrievebankscatalog","metadata":{"seo":{"title":"Retrieve catalog of SPEI participants","description":"Returns a paginated list of bank and institutions that are part of the SPEI Network."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"retrieveBanksCatalog","name":"Retrieve catalog of SPEI participants","isWebhook":false,"pointer":"/paths/~1v1~1banks/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve catalog of SPEI participants","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns a paginated list of bank and institutions that are part of the SPEI Network."},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/banks","servers":[{"url":"https://apicore.stg.finch.lat"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/v1/banks","href":"other/retrievebankscatalog","openApiOperationId":"retrieveBanksCatalog","summary":"Retrieve catalog of SPEI participants"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://apicore.stg.finch.lat"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"A list of institutions","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BanksResponse","exampleIds":["paths/~1v1~1banks/get/responses/200/content/application~1json/examples/example"]}},"schemaId":"components/schemas/BanksResponse","exampleIds":["paths/~1v1~1banks/get/responses/200/content/application~1json/examples/example"]}],"pointer":"/paths/~1v1~1banks/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/BanksResponse","exampleIds":["paths/~1v1~1banks/get/responses/200/content/application~1json/examples/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BanksResponse","exampleIds":["paths/~1v1~1banks/get/responses/200/content/application~1json/examples/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/other/retrievebankscatalog"}],"panels":[]}]},"httpPath":"/v1/banks"},{"label":"Retrieve accounts for a client","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/fincore/fincore-openapi/other/getaccounts","routeSlug":"/products/fincore/fincore-openapi/other/getaccounts","metadata":{"seo":{"title":"Retrieve accounts for a client","description":"Returns a paginated list of accounts for the specified client."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getAccounts","name":"Retrieve accounts for a client","isWebhook":false,"pointer":"/paths/~1v1~1clients~1{clientId}~1accounts/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve accounts for a client","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns a paginated list of accounts for the specified client."},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"clientId","in":"path","schemaId":"schema_104","description":"Unique identifier of the client","required":true}],"pointer":"/paths/~1v1~1clients~1{clientId}~1accounts/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/clients/{clientId}/accounts","servers":[{"url":"https://apicore.stg.finch.lat"}],"parameters":{"path":[{"name":"clientId","in":"path","required":true,"schemaId":"schema_104"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/v1/clients/{clientId}/accounts","href":"other/getaccounts","openApiOperationId":"getAccounts","summary":"Retrieve accounts for a client"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://apicore.stg.finch.lat"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful response with account details","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AccountsResponse"}},"schemaId":"components/schemas/AccountsResponse"}],"pointer":"/paths/~1v1~1clients~1{clientId}~1accounts/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/AccountsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AccountsResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/other/getaccounts"}],"panels":[]}]},"httpPath":"/v1/clients/{clientId}/accounts"},{"label":"Create a private account","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/fincore/fincore-openapi/other/postcreateprivateaccount","routeSlug":"/products/fincore/fincore-openapi/other/postcreateprivateaccount","metadata":{"seo":{"title":"Create a private account","description":"Endpoint to create a private account for a client."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"postCreatePrivateAccount","name":"Create a private account","isWebhook":false,"pointer":"/paths/~1v1~1clients~1{clientId}~1private_accounts/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a private account","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Endpoint to create a private account for a client."},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"clientId","in":"path","schemaId":"schema_103","description":"Unique identifier of the client.","required":true}],"pointer":"/paths/~1v1~1clients~1{clientId}~1private_accounts/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CreatePrivateAccountRequest"}},"schemaId":"components/schemas/CreatePrivateAccountRequest","pointer":"/paths/~1v1~1clients~1{clientId}~1private_accounts/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/clients/{clientId}/private_accounts","servers":[{"url":"https://apicore.stg.finch.lat"}],"parameters":{"path":[{"name":"clientId","in":"path","required":true,"example":"c2d1d1e3-3340-4170-980e-e9269bbbc551","schemaId":"schema_103"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/CreatePrivateAccountRequest"}},"responseCodes":["200"],"pointer":"/v1/clients/{clientId}/private_accounts","href":"other/postcreateprivateaccount","openApiOperationId":"postCreatePrivateAccount","summary":"Create a private account"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://apicore.stg.finch.lat"}],"schemaId":"components/schemas/CreatePrivateAccountRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CreatePrivateAccountRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Private account created successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PrivateAccountResponse"}},"schemaId":"components/schemas/PrivateAccountResponse"}],"pointer":"/paths/~1v1~1clients~1{clientId}~1private_accounts/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/PrivateAccountResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PrivateAccountResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/other/postcreateprivateaccount"}],"panels":[]}]},"httpPath":"/v1/clients/{clientId}/private_accounts"},{"label":"Retrieve a single instrument","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/fincore/fincore-openapi/other/getinstrumentbyid","routeSlug":"/products/fincore/fincore-openapi/other/getinstrumentbyid","metadata":{"seo":{"title":"Retrieve a single instrument","description":"Retrieves an instrument for the specified client. The instrument must belong to the client or to one of its customers; otherwise an error is returned."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getInstrumentById","name":"Retrieve a single instrument","isWebhook":false,"pointer":"/paths/~1v1~1clients~1{clientId}~1instruments~1{instrumentId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve a single instrument","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieves an instrument for the specified client. The instrument must belong to the client or to one of its customers; otherwise an error is returned.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"clientId","in":"path","schemaId":"schema_105","description":"Client identifier (UUID).","required":true},{"name":"instrumentId","in":"path","schemaId":"schema_105","description":"Instrument identifier (UUID).","required":true}],"pointer":"/paths/~1v1~1clients~1{clientId}~1instruments~1{instrumentId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/clients/{clientId}/instruments/{instrumentId}","servers":[{"url":"https://apicore.stg.finch.lat"}],"parameters":{"path":[{"name":"clientId","in":"path","required":true,"schemaId":"schema_105"},{"name":"instrumentId","in":"path","required":true,"schemaId":"schema_105"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","404"],"pointer":"/v1/clients/{clientId}/instruments/{instrumentId}","href":"other/getinstrumentbyid","openApiOperationId":"getInstrumentById","summary":"Retrieve a single instrument"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://apicore.stg.finch.lat"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Instrument details.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/InstrumentResponse"}},"schemaId":"components/schemas/InstrumentResponse"},{"code":"404","description":"Instrument not found for this client."}],"pointer":"/paths/~1v1~1clients~1{clientId}~1instruments~1{instrumentId}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/InstrumentResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/InstrumentResponse"}}},{"code":"404"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/other/getinstrumentbyid"}],"panels":[]}]},"httpPath":"/v1/clients/{clientId}/instruments/{instrumentId}"},{"label":"List instruments for a client","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/fincore/fincore-openapi/other/listinstruments","routeSlug":"/products/fincore/fincore-openapi/other/listinstruments","metadata":{"seo":{"title":"List instruments for a client","description":"Returns a paginated list of instruments belonging to the specified client and its customers."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listInstruments","name":"List instruments for a client","isWebhook":false,"pointer":"/paths/~1v1~1clients~1{clientId}~1instruments/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List instruments for a client","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns a paginated list of instruments belonging to the specified client and its customers."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Without "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"customer_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", it returns instruments for the client and all associated customers."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"With "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"customer_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", it returns only instruments for that customer."},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"clientId","in":"path","schemaId":"schema_105","description":"Client identifier (UUID).","required":true}],"pointer":"/paths/~1v1~1clients~1{clientId}~1instruments/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"customer_id","in":"query","schemaId":"schema_105","description":"Optional customer UUID. When provided, filters instruments for this customer only."},{"name":"page","in":"query","schemaId":"schema_106","description":"Page number (1-based)."},{"name":"per_page","in":"query","schemaId":"schema_106","description":"Number of items per page."}],"pointer":"/paths/~1v1~1clients~1{clientId}~1instruments/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/clients/{clientId}/instruments","servers":[{"url":"https://apicore.stg.finch.lat"}],"parameters":{"path":[{"name":"clientId","in":"path","required":true,"schemaId":"schema_105"}],"query":[{"name":"customer_id","in":"query","required":false,"schemaId":"schema_105"},{"name":"page","in":"query","required":false,"schemaId":"schema_106"},{"name":"per_page","in":"query","required":false,"schemaId":"schema_106"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","404"],"pointer":"/v1/clients/{clientId}/instruments","href":"other/listinstruments","openApiOperationId":"listInstruments","summary":"List instruments for a client"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://apicore.stg.finch.lat"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"List of instruments for the client (and optionally a specific customer).","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/InstrumentsResponse"}},"schemaId":"components/schemas/InstrumentsResponse"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Client not found (DATA_ERROR - \"No client found for id: ...\")."},"children":[]}]}]}]},{"code":"404","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer not found or not associated to this client (RESOURCE_NOT_FOUND - \"Customer not found\")."},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1clients~1{clientId}~1instruments/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/InstrumentsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/InstrumentsResponse"}}},{"code":"400"},{"code":"404"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/other/listinstruments"}],"panels":[]}]},"httpPath":"/v1/clients/{clientId}/instruments"},{"label":"Register an instrument for a client","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/fincore/fincore-openapi/other/registerinstrument","routeSlug":"/products/fincore/fincore-openapi/other/registerinstrument","metadata":{"seo":{"title":"Register an instrument for a client","description":"Registers an instrument owned by the specified client or by one of its customers.The request body must include either debit_card or virtual_clabe.."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"registerInstrument","name":"Register an instrument for a client","isWebhook":false,"pointer":"/paths/~1v1~1clients~1{clientId}~1instruments/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Register an instrument for a client","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Registers an instrument owned by the specified client or by one of its customers."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request body must include either "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"debit_card"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"virtual_clabe"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":".."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"clientId","in":"path","schemaId":"schema_104","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Client identifier (UUID) under which the instrument is being registered. The actual owner will be: - The client itself, if "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"customer_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is omitted in the request body. - The customer specified in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"customer_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", if provided."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1v1~1clients~1{clientId}~1instruments/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_107","exampleIds":["paths/~1v1~1clients~1{clientId}~1instruments/post/requestBody/content/application~1json/examples/addDebitCard","paths/~1v1~1clients~1{clientId}~1instruments/post/requestBody/content/application~1json/examples/addClabe"]}},"schemaId":"schema_107","exampleIds":["paths/~1v1~1clients~1{clientId}~1instruments/post/requestBody/content/application~1json/examples/addDebitCard","paths/~1v1~1clients~1{clientId}~1instruments/post/requestBody/content/application~1json/examples/addClabe"],"pointer":"/paths/~1v1~1clients~1{clientId}~1instruments/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/clients/{clientId}/instruments","servers":[{"url":"https://apicore.stg.finch.lat"}],"parameters":{"path":[{"name":"clientId","in":"path","required":true,"schemaId":"schema_104"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_107","exampleIds":["paths/~1v1~1clients~1{clientId}~1instruments/post/requestBody/content/application~1json/examples/addDebitCard","paths/~1v1~1clients~1{clientId}~1instruments/post/requestBody/content/application~1json/examples/addClabe"]}},"responseCodes":["200"],"pointer":"/v1/clients/{clientId}/instruments","href":"other/registerinstrument","openApiOperationId":"registerInstrument","summary":"Register an instrument for a client"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://apicore.stg.finch.lat"}],"schemaId":"schema_107","exampleIds":["paths/~1v1~1clients~1{clientId}~1instruments/post/requestBody/content/application~1json/examples/addDebitCard","paths/~1v1~1clients~1{clientId}~1instruments/post/requestBody/content/application~1json/examples/addClabe"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_107","exampleIds":["paths/~1v1~1clients~1{clientId}~1instruments/post/requestBody/content/application~1json/examples/addDebitCard","paths/~1v1~1clients~1{clientId}~1instruments/post/requestBody/content/application~1json/examples/addClabe"]}},"examples":[{},{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Instrument created","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/InstrumentResponse","exampleIds":["paths/~1v1~1clients~1{clientId}~1instruments/post/responses/200/content/application~1json/examples/createdCard","paths/~1v1~1clients~1{clientId}~1instruments/post/responses/200/content/application~1json/examples/createdClabe"]}},"schemaId":"components/schemas/InstrumentResponse","exampleIds":["paths/~1v1~1clients~1{clientId}~1instruments/post/responses/200/content/application~1json/examples/createdCard","paths/~1v1~1clients~1{clientId}~1instruments/post/responses/200/content/application~1json/examples/createdClabe"]}],"pointer":"/paths/~1v1~1clients~1{clientId}~1instruments/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/InstrumentResponse","exampleIds":["paths/~1v1~1clients~1{clientId}~1instruments/post/responses/200/content/application~1json/examples/createdCard","paths/~1v1~1clients~1{clientId}~1instruments/post/responses/200/content/application~1json/examples/createdClabe"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/InstrumentResponse","exampleIds":["paths/~1v1~1clients~1{clientId}~1instruments/post/responses/200/content/application~1json/examples/createdCard","paths/~1v1~1clients~1{clientId}~1instruments/post/responses/200/content/application~1json/examples/createdClabe"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/other/registerinstrument"}],"panels":[]}]},"httpPath":"/v1/clients/{clientId}/instruments"},{"label":"Create a money out transaction","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/fincore/fincore-openapi/other/createmoneyouttransaction","routeSlug":"/products/fincore/fincore-openapi/other/createmoneyouttransaction","metadata":{"seo":{"title":"Create a money out transaction","description":"Initiate an outbound transfer. If the destination instrument belongs to a Finco Pay (Monato) account, the system automatically routes the transaction as an internal book-to-book transfer — no SPEI, near-real-time settlement. Routing is handled transparently; no changes to the request body are required.This endpoint supports Idempotency via the Idempotency-Key header (TTL: 24h). Reuse the same key with the exact same body for safe retries. See the Idempotency guide for details."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createMoneyOutTransaction","name":"Create a money out transaction","isWebhook":false,"pointer":"/paths/~1v1~1transactions~1money_out/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a money out transaction","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Initiate an outbound transfer. If the destination instrument belongs to a Finco Pay (Monato) account, the system automatically routes the transaction as an internal book-to-book transfer — no SPEI, near-real-time settlement. Routing is handled transparently; no changes to the request body are required."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint supports Idempotency via the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Idempotency-Key"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header (TTL: 24h). Reuse the same key with the exact same body for safe retries. See the Idempotency guide for details."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Idempotency-Key","in":"header","schemaId":"schema_108","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Client-generated deterministic UUID v5 derived from (client_id + method + body_hash) within an environment-specific namespace. When present, the first response (success or error) is cached for 24h; identical retries (same key + same body) return the same cached response. If the body changes with the same key, the server returns 409 Conflict."},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1transactions~1money_out/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/MoneyOutRequest","exampleIds":["paths/~1v1~1transactions~1money_out/post/requestBody/content/application~1json/example"]}},"schemaId":"components/schemas/MoneyOutRequest","exampleIds":["paths/~1v1~1transactions~1money_out/post/requestBody/content/application~1json/example"],"pointer":"/paths/~1v1~1transactions~1money_out/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/transactions/money_out","servers":[{"url":"https://apicore.stg.finch.lat"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"Idempotency-Key","in":"header","required":false,"schemaId":"schema_108"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/MoneyOutRequest","exampleIds":["paths/~1v1~1transactions~1money_out/post/requestBody/content/application~1json/example"]}},"responseCodes":["200"],"pointer":"/v1/transactions/money_out","href":"other/createmoneyouttransaction","openApiOperationId":"createMoneyOutTransaction","summary":"Create a money out transaction"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://apicore.stg.finch.lat"}],"schemaId":"components/schemas/MoneyOutRequest","exampleIds":["paths/~1v1~1transactions~1money_out/post/requestBody/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/MoneyOutRequest","exampleIds":["paths/~1v1~1transactions~1money_out/post/requestBody/content/application~1json/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successfully created transaction","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/MoneyOutResponse","exampleIds":["paths/~1v1~1transactions~1money_out/post/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/MoneyOutResponse","exampleIds":["paths/~1v1~1transactions~1money_out/post/responses/200/content/application~1json/example"]}],"pointer":"/paths/~1v1~1transactions~1money_out/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/MoneyOutResponse","exampleIds":["paths/~1v1~1transactions~1money_out/post/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/MoneyOutResponse","exampleIds":["paths/~1v1~1transactions~1money_out/post/responses/200/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/other/createmoneyouttransaction"}],"panels":[]}]},"httpPath":"/v1/transactions/money_out"},{"label":"Refund a transaction","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/fincore/fincore-openapi/other/createrefund","routeSlug":"/products/fincore/fincore-openapi/other/createrefund","metadata":{"seo":{"title":"Refund a transaction","description":"Creates a refund for a transaction. Partial refunds are not allowed. The amount must equal the original transaction amount received."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createRefund","name":"Refund a transaction","isWebhook":false,"pointer":"/paths/~1v1~1clients~1{clientId}~1transactions~1{transactionId}~1refund/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Refund a transaction","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Creates a refund for a transaction. Partial refunds are not allowed. The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"amount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" must equal the original transaction amount received."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"clientId","in":"path","schemaId":"schema_105","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Client UUID (must match the client_id embedded in the Authorization token)."},"children":[]}]}]}],"required":true},{"name":"transactionId","in":"path","schemaId":"schema_105","description":"Transaction UUID to be refunded.","required":true}],"pointer":"/paths/~1v1~1clients~1{clientId}~1transactions~1{transactionId}~1refund/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/RefundRequest","exampleIds":["paths/~1v1~1clients~1{clientId}~1transactions~1{transactionId}~1refund/post/requestBody/content/application~1json/example"]}},"schemaId":"components/schemas/RefundRequest","exampleIds":["paths/~1v1~1clients~1{clientId}~1transactions~1{transactionId}~1refund/post/requestBody/content/application~1json/example"],"pointer":"/paths/~1v1~1clients~1{clientId}~1transactions~1{transactionId}~1refund/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/clients/{clientId}/transactions/{transactionId}/refund","servers":[{"url":"https://apicore.stg.finch.lat"}],"parameters":{"path":[{"name":"clientId","in":"path","required":true,"schemaId":"schema_105"},{"name":"transactionId","in":"path","required":true,"schemaId":"schema_105"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/RefundRequest","exampleIds":["paths/~1v1~1clients~1{clientId}~1transactions~1{transactionId}~1refund/post/requestBody/content/application~1json/example"]}},"responseCodes":["200"],"pointer":"/v1/clients/{clientId}/transactions/{transactionId}/refund","href":"other/createrefund","openApiOperationId":"createRefund","summary":"Refund a transaction"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://apicore.stg.finch.lat"}],"schemaId":"components/schemas/RefundRequest","exampleIds":["paths/~1v1~1clients~1{clientId}~1transactions~1{transactionId}~1refund/post/requestBody/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/RefundRequest","exampleIds":["paths/~1v1~1clients~1{clientId}~1transactions~1{transactionId}~1refund/post/requestBody/content/application~1json/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Refund successfully created","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RefundResponse","exampleIds":["paths/~1v1~1clients~1{clientId}~1transactions~1{transactionId}~1refund/post/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/RefundResponse","exampleIds":["paths/~1v1~1clients~1{clientId}~1transactions~1{transactionId}~1refund/post/responses/200/content/application~1json/example"]}],"pointer":"/paths/~1v1~1clients~1{clientId}~1transactions~1{transactionId}~1refund/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/RefundResponse","exampleIds":["paths/~1v1~1clients~1{clientId}~1transactions~1{transactionId}~1refund/post/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RefundResponse","exampleIds":["paths/~1v1~1clients~1{clientId}~1transactions~1{transactionId}~1refund/post/responses/200/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/other/createrefund"}],"panels":[]}]},"httpPath":"/v1/clients/{clientId}/transactions/{transactionId}/refund"},{"label":"List client webhooks","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/fincore/fincore-openapi/other/listclientwebhooks","routeSlug":"/products/fincore/fincore-openapi/other/listclientwebhooks","metadata":{"seo":{"title":"List client webhooks","description":"Returns a paginated list of webhooks configured for the specified client."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listClientWebhooks","name":"List client webhooks","isWebhook":false,"pointer":"/paths/~1v1~1clients~1{clientId}~1webhooks/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List client webhooks","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns a paginated list of webhooks configured for the specified client."},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"clientId","in":"path","schemaId":"schema_105","description":"Client UUID that owns the webhooks.","required":true}],"pointer":"/paths/~1v1~1clients~1{clientId}~1webhooks/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/clients/{clientId}/webhooks","servers":[{"url":"https://apicore.stg.finch.lat"}],"parameters":{"path":[{"name":"clientId","in":"path","required":true,"schemaId":"schema_105"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/v1/clients/{clientId}/webhooks","href":"other/listclientwebhooks","openApiOperationId":"listClientWebhooks","summary":"List client webhooks"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://apicore.stg.finch.lat"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"List of client webhooks","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookListResponse"}},"schemaId":"components/schemas/WebhookListResponse"}],"pointer":"/paths/~1v1~1clients~1{clientId}~1webhooks/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/WebhookListResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookListResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/other/listclientwebhooks"}],"panels":[]}]},"httpPath":"/v1/clients/{clientId}/webhooks"},{"label":"Register a webhook for a client","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/fincore/fincore-openapi/other/createclientwebhook","routeSlug":"/products/fincore/fincore-openapi/other/createclientwebhook","metadata":{"seo":{"title":"Register a webhook for a client","description":"Endpoint to register a new URL where the specified client will receive webhooks. Requires Authorization: Bearer <token> headers."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createClientWebhook","name":"Register a webhook for a client","isWebhook":false,"pointer":"/paths/~1v1~1clients~1{clientId}~1webhooks/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Register a webhook for a client","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Endpoint to register a new URL where the specified client will receive webhooks. Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" headers."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"clientId","in":"path","schemaId":"schema_105","description":"Client UUID for which the webhook is being registered.","required":true}],"pointer":"/paths/~1v1~1clients~1{clientId}~1webhooks/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CreateWebhookRequest","exampleIds":["paths/~1v1~1clients~1{clientId}~1webhooks/post/requestBody/content/application~1json/example"]}},"schemaId":"components/schemas/CreateWebhookRequest","exampleIds":["paths/~1v1~1clients~1{clientId}~1webhooks/post/requestBody/content/application~1json/example"],"pointer":"/paths/~1v1~1clients~1{clientId}~1webhooks/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/clients/{clientId}/webhooks","servers":[{"url":"https://apicore.stg.finch.lat"}],"parameters":{"path":[{"name":"clientId","in":"path","required":true,"schemaId":"schema_105"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/CreateWebhookRequest","exampleIds":["paths/~1v1~1clients~1{clientId}~1webhooks/post/requestBody/content/application~1json/example"]}},"responseCodes":["200"],"pointer":"/v1/clients/{clientId}/webhooks","href":"other/createclientwebhook","openApiOperationId":"createClientWebhook","summary":"Register a webhook for a client"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://apicore.stg.finch.lat"}],"schemaId":"components/schemas/CreateWebhookRequest","exampleIds":["paths/~1v1~1clients~1{clientId}~1webhooks/post/requestBody/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CreateWebhookRequest","exampleIds":["paths/~1v1~1clients~1{clientId}~1webhooks/post/requestBody/content/application~1json/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Webhook successfully created","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookResponse"}},"schemaId":"components/schemas/WebhookResponse"}],"pointer":"/paths/~1v1~1clients~1{clientId}~1webhooks/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/WebhookResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/other/createclientwebhook"}],"panels":[]}]},"httpPath":"/v1/clients/{clientId}/webhooks"},{"label":"Download a report file","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/fincore/fincore-openapi/other/downloadreport","routeSlug":"/products/fincore/fincore-openapi/other/downloadreport","metadata":{"seo":{"title":"Download a report file","description":"Returns a download URL for a generated report file (transactions or account statement). If no matching file is found, response fields are returned empty."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"downloadReport","name":"Download a report file","isWebhook":false,"pointer":"/paths/~1v1~1reports~1clients~1{client_id}~1report~1download/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Download a report file","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns a download URL for a generated report file (transactions or account statement). If no matching file is found, response fields are returned empty.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"client_id","in":"path","schemaId":"schema_103","description":"Unique identifier of the client (UUID).","required":true}],"pointer":"/paths/~1v1~1reports~1clients~1{client_id}~1report~1download/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ReportDownloadRequest","exampleIds":["paths/~1v1~1reports~1clients~1{client_id}~1report~1download/post/requestBody/content/application~1json/examples/dailyAccountStatement","paths/~1v1~1reports~1clients~1{client_id}~1report~1download/post/requestBody/content/application~1json/examples/dailyTransactions"]}},"schemaId":"components/schemas/ReportDownloadRequest","exampleIds":["paths/~1v1~1reports~1clients~1{client_id}~1report~1download/post/requestBody/content/application~1json/examples/dailyAccountStatement","paths/~1v1~1reports~1clients~1{client_id}~1report~1download/post/requestBody/content/application~1json/examples/dailyTransactions"],"pointer":"/paths/~1v1~1reports~1clients~1{client_id}~1report~1download/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/reports/clients/{client_id}/report/download","servers":[{"url":"https://apicore.stg.finch.lat"}],"parameters":{"path":[{"name":"client_id","in":"path","required":true,"example":"c2d1d1e3-3340-4170-980e-e9269bbbc551","schemaId":"schema_103"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/ReportDownloadRequest","exampleIds":["paths/~1v1~1reports~1clients~1{client_id}~1report~1download/post/requestBody/content/application~1json/examples/dailyAccountStatement","paths/~1v1~1reports~1clients~1{client_id}~1report~1download/post/requestBody/content/application~1json/examples/dailyTransactions"]}},"responseCodes":["200","400"],"pointer":"/v1/reports/clients/{client_id}/report/download","href":"other/downloadreport","openApiOperationId":"downloadReport","summary":"Download a report file"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://apicore.stg.finch.lat"}],"schemaId":"components/schemas/ReportDownloadRequest","exampleIds":["paths/~1v1~1reports~1clients~1{client_id}~1report~1download/post/requestBody/content/application~1json/examples/dailyAccountStatement","paths/~1v1~1reports~1clients~1{client_id}~1report~1download/post/requestBody/content/application~1json/examples/dailyTransactions"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ReportDownloadRequest","exampleIds":["paths/~1v1~1reports~1clients~1{client_id}~1report~1download/post/requestBody/content/application~1json/examples/dailyAccountStatement","paths/~1v1~1reports~1clients~1{client_id}~1report~1download/post/requestBody/content/application~1json/examples/dailyTransactions"]}},"examples":[{},{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Report file found. Returns file name and download URL. Fields are empty if no matching file exists.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ReportDownloadResponse","exampleIds":["paths/~1v1~1reports~1clients~1{client_id}~1report~1download/post/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/ReportDownloadResponse","exampleIds":["paths/~1v1~1reports~1clients~1{client_id}~1report~1download/post/responses/200/content/application~1json/example"]},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Validation error. Possible messages:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Invalid UUID format for client_id"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Invalid report_type: <value>"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"clabe_number is required for account statement reports"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Invalid clabe number"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"operation_date must use format YYYY-MM-DD"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"operation_date must be a valid date with format YYYY-MM-DD"},"children":[]}]}]}]}]}],"pointer":"/paths/~1v1~1reports~1clients~1{client_id}~1report~1download/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ReportDownloadResponse","exampleIds":["paths/~1v1~1reports~1clients~1{client_id}~1report~1download/post/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ReportDownloadResponse","exampleIds":["paths/~1v1~1reports~1clients~1{client_id}~1report~1download/post/responses/200/content/application~1json/example"]}}},{"code":"400"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/other/downloadreport"}],"panels":[]}]},"httpPath":"/v1/reports/clients/{client_id}/report/download"},{"label":"Retrieve a client webhook","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/fincore/fincore-openapi/other/getclientwebhook","routeSlug":"/products/fincore/fincore-openapi/other/getclientwebhook","metadata":{"seo":{"title":"Retrieve a client webhook","description":"Returns details for a specific webhook owned by the client."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getClientWebhook","name":"Retrieve a client webhook","isWebhook":false,"pointer":"/paths/~1v1~1clients~1{clientId}~1webhooks~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve a client webhook","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns details for a specific webhook owned by the client."},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"clientId","in":"path","schemaId":"schema_105","description":"Client UUID that owns the webhook.","required":true},{"name":"id","in":"path","schemaId":"schema_105","description":"Webhook UUID.","required":true}],"pointer":"/paths/~1v1~1clients~1{clientId}~1webhooks~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/clients/{clientId}/webhooks/{id}","servers":[{"url":"https://apicore.stg.finch.lat"}],"parameters":{"path":[{"name":"clientId","in":"path","required":true,"schemaId":"schema_105"},{"name":"id","in":"path","required":true,"schemaId":"schema_105"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","404"],"pointer":"/v1/clients/{clientId}/webhooks/{id}","href":"other/getclientwebhook","openApiOperationId":"getClientWebhook","summary":"Retrieve a client webhook"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://apicore.stg.finch.lat"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Webhook found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookResponse"}},"schemaId":"components/schemas/WebhookResponse"},{"code":"404","description":"Webhook not found for this client."}],"pointer":"/paths/~1v1~1clients~1{clientId}~1webhooks~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/WebhookResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookResponse"}}},{"code":"404"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/other/getclientwebhook"}],"panels":[]}]},"httpPath":"/v1/clients/{clientId}/webhooks/{id}"},{"label":"Update a client webhook","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/fincore/fincore-openapi/other/updateclientwebhook","routeSlug":"/products/fincore/fincore-openapi/other/updateclientwebhook","metadata":{"seo":{"title":"Update a client webhook","description":"Updates one or more fields of a webhook owned by the client. All fields in the request body are optional, but at least one must be provided."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateClientWebhook","name":"Update a client webhook","isWebhook":false,"pointer":"/paths/~1v1~1clients~1{clientId}~1webhooks~1{id}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update a client webhook","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Updates one or more fields of a webhook owned by the client. All fields in the request body are optional, but at least one must be provided.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"clientId","in":"path","schemaId":"schema_105","description":"Client UUID that owns the webhook.","required":true},{"name":"id","in":"path","schemaId":"schema_105","description":"Webhook UUID.","required":true}],"pointer":"/paths/~1v1~1clients~1{clientId}~1webhooks~1{id}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/WebhookUpdateRequest","exampleIds":["paths/~1v1~1clients~1{clientId}~1webhooks~1{id}/patch/requestBody/content/application~1json/examples/updateUrlAndStatus"]}},"schemaId":"components/schemas/WebhookUpdateRequest","exampleIds":["paths/~1v1~1clients~1{clientId}~1webhooks~1{id}/patch/requestBody/content/application~1json/examples/updateUrlAndStatus"],"pointer":"/paths/~1v1~1clients~1{clientId}~1webhooks~1{id}/patch/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/v1/clients/{clientId}/webhooks/{id}","servers":[{"url":"https://apicore.stg.finch.lat"}],"parameters":{"path":[{"name":"clientId","in":"path","required":true,"schemaId":"schema_105"},{"name":"id","in":"path","required":true,"schemaId":"schema_105"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/WebhookUpdateRequest","exampleIds":["paths/~1v1~1clients~1{clientId}~1webhooks~1{id}/patch/requestBody/content/application~1json/examples/updateUrlAndStatus"]}},"responseCodes":["200","400","404"],"pointer":"/v1/clients/{clientId}/webhooks/{id}","href":"other/updateclientwebhook","openApiOperationId":"updateClientWebhook","summary":"Update a client webhook"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://apicore.stg.finch.lat"}],"schemaId":"components/schemas/WebhookUpdateRequest","exampleIds":["paths/~1v1~1clients~1{clientId}~1webhooks~1{id}/patch/requestBody/content/application~1json/examples/updateUrlAndStatus"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/WebhookUpdateRequest","exampleIds":["paths/~1v1~1clients~1{clientId}~1webhooks~1{id}/patch/requestBody/content/application~1json/examples/updateUrlAndStatus"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Webhook successfully updated","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookResponse"}},"schemaId":"components/schemas/WebhookResponse"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"No fields provided to update (DATA_ERROR - \"There is no information provided to update the Webhook.\")"},"children":[]}]}]}]},{"code":"404","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Webhook not found for this client (RESOURCE_NOT_FOUND)."},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1clients~1{clientId}~1webhooks~1{id}/patch/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/WebhookResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookResponse"}}},{"code":"400"},{"code":"404"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/other/updateclientwebhook"}],"panels":[]}]},"httpPath":"/v1/clients/{clientId}/webhooks/{id}"},{"label":"Delete a client webhook","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/fincore/fincore-openapi/other/deleteclientwebhook","routeSlug":"/products/fincore/fincore-openapi/other/deleteclientwebhook","metadata":{"seo":{"title":"Delete a client webhook","description":"Deletes (or soft-deletes) a webhook owned by the client."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteClientWebhook","name":"Delete a client webhook","isWebhook":false,"pointer":"/paths/~1v1~1clients~1{clientId}~1webhooks~1{id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete a client webhook","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Deletes (or soft-deletes) a webhook owned by the client."},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"clientId","in":"path","schemaId":"schema_105","description":"Client UUID that owns the webhook.","required":true},{"name":"id","in":"path","schemaId":"schema_105","description":"Webhook UUID.","required":true}],"pointer":"/paths/~1v1~1clients~1{clientId}~1webhooks~1{id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/v1/clients/{clientId}/webhooks/{id}","servers":[{"url":"https://apicore.stg.finch.lat"}],"parameters":{"path":[{"name":"clientId","in":"path","required":true,"schemaId":"schema_105"},{"name":"id","in":"path","required":true,"schemaId":"schema_105"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","404"],"pointer":"/v1/clients/{clientId}/webhooks/{id}","href":"other/deleteclientwebhook","openApiOperationId":"deleteClientWebhook","summary":"Delete a client webhook"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://apicore.stg.finch.lat"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Webhook successfully deleted","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookResponse"}},"schemaId":"components/schemas/WebhookResponse"},{"code":"404","description":"Webhook not found or already deleted."}],"pointer":"/paths/~1v1~1clients~1{clientId}~1webhooks~1{id}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/WebhookResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookResponse"}}},{"code":"404"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/other/deleteclientwebhook"}],"panels":[]}]},"httpPath":"/v1/clients/{clientId}/webhooks/{id}"},{"label":"Register a webhook (deprecated)","deprecated":true,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/fincore/fincore-openapi/other/createwebhook","routeSlug":"/products/fincore/fincore-openapi/other/createwebhook","metadata":{"seo":{"title":"Register a webhook (deprecated)","description":"Deprecated. Use Register a webhook for a client instead (POST /v1/clients/{clientId}/webhooks). Requires both x-api-key and Authorization: Bearer <token> headers."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createWebhook","name":"Register a webhook (deprecated)","deprecated":true,"isWebhook":false,"pointer":"/paths/~1v1~1webhooks/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Register a webhook (deprecated)","isWebhook":false,"deprecated":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Deprecated."},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Use "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.monato.com/products/fincore/fincore-openapi/other/createclientwebhook"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Register a webhook for a client"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" instead ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"POST /v1/clients/{clientId}/webhooks"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"). Requires both "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"x-api-key"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" headers."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CreateWebhookRequest","exampleIds":["paths/~1v1~1webhooks/post/requestBody/content/application~1json/example"]}},"schemaId":"components/schemas/CreateWebhookRequest","exampleIds":["paths/~1v1~1webhooks/post/requestBody/content/application~1json/example"],"pointer":"/paths/~1v1~1webhooks/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/webhooks","servers":[{"url":"https://apicore.stg.finch.lat"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/CreateWebhookRequest","exampleIds":["paths/~1v1~1webhooks/post/requestBody/content/application~1json/example"]}},"responseCodes":["200"],"pointer":"/v1/webhooks","href":"other/createwebhook","openApiOperationId":"createWebhook","summary":"Register a webhook (deprecated)"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://apicore.stg.finch.lat"}],"schemaId":"components/schemas/CreateWebhookRequest","exampleIds":["paths/~1v1~1webhooks/post/requestBody/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CreateWebhookRequest","exampleIds":["paths/~1v1~1webhooks/post/requestBody/content/application~1json/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Webhook successfully created","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookResponse","exampleIds":["paths/~1v1~1webhooks/post/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/WebhookResponse","exampleIds":["paths/~1v1~1webhooks/post/responses/200/content/application~1json/example"]}],"pointer":"/paths/~1v1~1webhooks/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/WebhookResponse","exampleIds":["paths/~1v1~1webhooks/post/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookResponse","exampleIds":["paths/~1v1~1webhooks/post/responses/200/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/other/createwebhook"}],"panels":[]}]},"httpPath":"/v1/webhooks"},{"type":"group","label":"webhooks","link":"/products/fincore/fincore-openapi/webhooks","routeSlug":"/products/fincore/fincore-openapi/webhooks","items":[{"label":"MONEY_IN webhook event.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/products/fincore/fincore-openapi/webhooks/webhookmoneyinpost","routeSlug":"/products/fincore/fincore-openapi/webhooks/webhookmoneyinpost","metadata":{"seo":{"title":"MONEY_IN webhook event.","description":"Monato sends this webhook to notify you about new Money In events into your accounts. The payload covers both external SPEI credits and internal credits (book-to-book). Use fields such as sub_category and payer_institution to distinguish between them."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"webhookMoneyInPost","name":"MONEY_IN webhook event.","isWebhook":true,"pointer":"/paths/money-in/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"MONEY_IN webhook event.","isWebhook":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Monato sends this webhook to notify you about new Money In events into your accounts. The payload covers both external SPEI credits and internal credits (book-to-book). Use fields such as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sub_category"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"payer_institution"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to distinguish between them."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Internal credits note: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"INT_CREDIT"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" webhooks are emitted only when the credit is inbound for a different owner than the initiator (e.g., different "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"owner_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", even under the same "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"client_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"). Self-transfers under the same "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"client_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" + "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"owner_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" do not generate a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"MONEY_IN"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" webhook event."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/WebhookMoneyInEvent"}},"schemaId":"components/schemas/WebhookMoneyInEvent","pointer":"/paths/money-in/post/requestBody","description":"Information about a new Money IN event."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"webhook","method":"POST","path":"money-in","servers":[{"url":"https://apicore.stg.finch.lat"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/WebhookMoneyInEvent"}},"responseCodes":["200","201","202","422"],"pointer":"money-in","href":"webhooks/webhookmoneyinpost","openApiOperationId":"webhookMoneyInPost","summary":"MONEY_IN webhook event."},"isWebhook":true,"hideReplay":false,"servers":[{"url":"https://apicore.stg.finch.lat"}],"schemaId":"components/schemas/WebhookMoneyInEvent","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/WebhookMoneyInEvent"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Money In notification received successfully. Treated as a technical acknowledgement (equivalent to 201).\n"},{"code":"201","description":"Money In notification received and accepted. Recommended status code when you accept the Money In (SPEI credits).\n"},{"code":"202","description":"Money In notification received successfully; extra validations will be done asynchronously on your side.\n"},{"code":"422","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Money In notification received, but not accepted. For external SPEI credits, Monato will automatically refund the transaction to the original source. Not applicable to internal Money In ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"INT_CREDIT"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/MoneyInRejectionResponse","exampleIds":["paths/money-in/post/responses/422/content/application~1json/example"]}},"schemaId":"components/schemas/MoneyInRejectionResponse","exampleIds":["paths/money-in/post/responses/422/content/application~1json/example"]}],"pointer":"/paths/money-in/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200"},{"code":"201"},{"code":"202"},{"code":"422","schemaId":"components/schemas/MoneyInRejectionResponse","exampleIds":["paths/money-in/post/responses/422/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/MoneyInRejectionResponse","exampleIds":["paths/money-in/post/responses/422/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/webhooks/webhookmoneyinpost"}],"panels":[]}]},"httpPath":"money-in"},{"label":"Get notified about Status updates.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/products/fincore/fincore-openapi/webhooks/webhookstatusupdatepost","routeSlug":"/products/fincore/fincore-openapi/webhooks/webhookstatusupdatepost","metadata":{"seo":{"title":"Get notified about Status updates.","description":"Send Status updates for Money Outs"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"webhookStatusUpdatePost","name":"Get notified about Status updates.","isWebhook":true,"pointer":"/paths/status-update/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get notified about Status updates.","isWebhook":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Send Status updates for Money Outs"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/StatusUpdateMessage"}},"schemaId":"components/schemas/StatusUpdateMessage","pointer":"/paths/status-update/post/requestBody","description":"Information about new status"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"webhook","method":"POST","path":"status-update","servers":[{"url":"https://apicore.stg.finch.lat"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/StatusUpdateMessage"}},"pointer":"status-update","href":"webhooks/webhookstatusupdatepost","openApiOperationId":"webhookStatusUpdatePost","summary":"Get notified about Status updates."},"isWebhook":true,"hideReplay":false,"servers":[{"url":"https://apicore.stg.finch.lat"}],"schemaId":"components/schemas/StatusUpdateMessage","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/StatusUpdateMessage"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/webhooks/webhookstatusupdatepost"}],"panels":[]}]},"httpPath":"status-update"},{"label":"Get notified about CEP updates (Penny Validation)","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/products/fincore/fincore-openapi/webhooks/webhookceppost","routeSlug":"/products/fincore/fincore-openapi/webhooks/webhookceppost","metadata":{"seo":{"title":"Get notified about CEP updates (Penny Validation)","description":"Sends CEP status updates for Penny Validation: PENDING, DELAYED, COMPLETED, or FAILED. This CEP webhook is only triggered for Penny Validation transactions (amount = 0.01 MXN). Note: INITIALIZED is never emitted by the webhook (it may appear on API reads only and should be treated as PENDING)."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"webhookCepPost","name":"Get notified about CEP updates (Penny Validation)","isWebhook":true,"pointer":"/paths/cep/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get notified about CEP updates (Penny Validation)","isWebhook":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sends CEP status updates for Penny Validation: PENDING, DELAYED, COMPLETED, or FAILED. This CEP webhook is only triggered for Penny Validation transactions (amount = 0.01 MXN). Note: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"INITIALIZED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is never emitted by the webhook (it may appear on API reads only and should be treated as PENDING)."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/WebhookCepEvent"}},"schemaId":"components/schemas/WebhookCepEvent","pointer":"/paths/cep/post/requestBody","description":"CEP status notification payload."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"webhook","method":"POST","path":"cep","servers":[{"url":"https://apicore.stg.finch.lat"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/WebhookCepEvent"}},"responseCodes":["200","202","422"],"pointer":"cep","href":"webhooks/webhookceppost","openApiOperationId":"webhookCepPost","summary":"Get notified about CEP updates (Penny Validation)"},"isWebhook":true,"hideReplay":false,"servers":[{"url":"https://apicore.stg.finch.lat"}],"schemaId":"components/schemas/WebhookCepEvent","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/WebhookCepEvent"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"CEP notification received and accepted"},{"code":"202","description":"CEP notification received; additional validations will be done asynchronously"},{"code":"422","description":"CEP notification received, but not accepted"}],"pointer":"/paths/cep/post/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/webhooks/webhookceppost"}],"panels":[]}]},"httpPath":"cep"},{"label":"Report file available for download.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/products/fincore/fincore-openapi/webhooks/webhookreportpost","routeSlug":"/products/fincore/fincore-openapi/webhooks/webhookreportpost","metadata":{"seo":{"title":"Report file available for download.","description":"Monato sends this webhook when a generated file is available for download. It can correspond to transaction reports or account statements in daily or monthly periods."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"webhookReportPost","name":"Report file available for download.","isWebhook":true,"pointer":"/paths/report/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Report file available for download.","isWebhook":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Monato sends this webhook when a generated file is available for download. It can correspond to transaction reports or account statements in daily or monthly periods.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ReportWebhookEvent","exampleIds":["paths/report/post/requestBody/content/application~1json/examples/transactionsReport","paths/report/post/requestBody/content/application~1json/examples/accountStatement"]}},"schemaId":"components/schemas/ReportWebhookEvent","exampleIds":["paths/report/post/requestBody/content/application~1json/examples/transactionsReport","paths/report/post/requestBody/content/application~1json/examples/accountStatement"],"pointer":"/paths/report/post/requestBody","description":"Information about the generated report file."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"webhook","method":"POST","path":"report","servers":[{"url":"https://apicore.stg.finch.lat"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/ReportWebhookEvent","exampleIds":["paths/report/post/requestBody/content/application~1json/examples/transactionsReport","paths/report/post/requestBody/content/application~1json/examples/accountStatement"]}},"responseCodes":["200","202"],"pointer":"report","href":"webhooks/webhookreportpost","openApiOperationId":"webhookReportPost","summary":"Report file available for download."},"isWebhook":true,"hideReplay":false,"servers":[{"url":"https://apicore.stg.finch.lat"}],"schemaId":"components/schemas/ReportWebhookEvent","exampleIds":["paths/report/post/requestBody/content/application~1json/examples/transactionsReport","paths/report/post/requestBody/content/application~1json/examples/accountStatement"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ReportWebhookEvent","exampleIds":["paths/report/post/requestBody/content/application~1json/examples/transactionsReport","paths/report/post/requestBody/content/application~1json/examples/accountStatement"]}},"examples":[{},{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Report notification received successfully."},{"code":"202","description":"Report notification received; additional processing will be done asynchronously."}],"pointer":"/paths/report/post/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/webhooks/webhookreportpost"}],"panels":[]}]},"httpPath":"report"}],"content":{"contentType":"group","meta":{"name":"webhooks"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"webhooks","showPageActions":true}],"panels":[{"children":[{"kind":"group-items","title":"Webhooks","titleTranslationKey":"webhooks","items":[{"title":"money-in","summary":"MONEY_IN webhook event.","prefix":{"name":"post","color":"post"},"badges":[],"link":"/webhooks/webhookmoneyinpost","deprecated":false},{"title":"status-update","summary":"Get notified about Status updates.","prefix":{"name":"post","color":"post"},"badges":[],"link":"/webhooks/webhookstatusupdatepost","deprecated":false},{"title":"cep","summary":"Get notified about CEP updates (Penny Validation)","prefix":{"name":"post","color":"post"},"badges":[],"link":"/webhooks/webhookceppost","deprecated":false},{"title":"report","summary":"Report file available for download.","prefix":{"name":"post","color":"post"},"badges":[],"link":"/webhooks/webhookreportpost","deprecated":false}]}]}]}]}}],"store":{"schemaStore":{"components/schemas/AuthCredentialRequest":{"id":"components/schemas/AuthCredentialRequest","kind":"json-schema","title":"AuthCredentialRequest","data":{"type":"object","required":["client_id","client_secret"],"properties":{"client_id":{"type":"string","example":"c2d1d1e3-3340-4170-980e-e9269bbbc551"},"client_secret":{"type":"string","example":"your_client_secret_here"}}}},"components/schemas/CreatePrivateAccountRequest":{"id":"components/schemas/CreatePrivateAccountRequest","kind":"json-schema","title":"CreatePrivateAccountRequest","data":{"type":"object","required":["bank_id","owner_id","client_bank_adapter_id","client_id","account_id"],"properties":{"bank_id":{"type":"string","format":"uuid","example":"9d84b03a-28d1-4898-a69c-38824239e2b1"},"owner_id":{"type":"string","format":"uuid","example":"c2d1d1e3-3340-4170-980e-e9269bbbc551"},"client_bank_adapter_id":{"type":"string","format":"uuid","example":"5b3a1b67-ab59-4cc1-8fc6-1d558b32b237"},"client_id":{"type":"string","format":"uuid","example":"c2d1d1e3-3340-4170-980e-e9269bbbc551"},"account_id":{"type":"string","format":"uuid","example":"24a726ac-180d-48df-82bc-711f2788a46f"}}}},"components/schemas/MoneyOutRequest":{"id":"components/schemas/MoneyOutRequest","kind":"json-schema","title":"MoneyOutRequest","data":{"type":"object","properties":{"client_id":{"type":"string","format":"uuid","example":"c2d1d1e3-3340-4170-980e-e9269bbbc551"},"source_instrument_id":{"type":"string","format":"uuid","example":"709448c3-7cbf-454d-a87e-feb23801269a"},"destination_instrument_id":{"type":"string","format":"uuid","example":"d3fdb481-2058-46c8-807d-4eaf866ae1ec"},"transaction_request":{"type":"object","properties":{"external_reference":{"type":"string","example":"1234567"},"description":{"type":"string","example":"lorem ipsum dolor sit amet"},"amount":{"type":"string","example":"1.95"},"currency":{"type":"string","example":"MXN"}}}}}},"components/schemas/CreateWebhookRequest":{"id":"components/schemas/CreateWebhookRequest","kind":"json-schema","title":"CreateWebhookRequest","data":{"type":"object","required":["client_id","url","token","webhook_type"],"properties":{"client_id":{"type":"string","example":"{{clientId}}"},"url":{"type":"string","format":"uri","example":"https://example.com/webhook"},"token":{"type":"string","example":"secretToken0123"},"webhook_type":{"type":"string","enum":["MONEY_IN","STATUS_UPDATE","CEP","REPORT"],"example":"CEP"}}}},"components/schemas/RefundRequest":{"id":"components/schemas/RefundRequest","kind":"json-schema","title":"RefundRequest","data":{"type":"object","properties":{"amount":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Refund amount (full refund only) — must be exactly equal to the original transaction amount received. Use two decimal places."},"children":[]}]}]}],"example":"10.00"},"description":{"type":"string","description":"Text with the refund reason","example":"Invalid amount"}}}},"components/schemas/RefundResponse":{"id":"components/schemas/RefundResponse","kind":"json-schema","title":"RefundResponse","data":{"type":"object","properties":{"id":{"type":"string","format":"uuid","example":"957459ce-d4e3-40b5-b759-373e844ba1e8"},"bankId":{"type":"string","format":"uuid","example":"9d84b03a-28d1-4898-a69c-38824239e2b1"},"clientId":{"type":"string","format":"uuid","example":"c2d1d1e3-3340-4170-980e-e9269bbbc551"},"externalReference":{"type":"string","example":"2505091"},"trackingId":{"type":"string","example":"20250510FINCHFL2SFGP9KT"},"description":{"type":"string","example":"lorem ipsum dolor sit amet"},"amount":{"type":"string","format":"decimal","example":"100.00"},"currency":{"type":"string","example":"MXN"},"category":{"type":"string","example":"DEBIT_TRANS"},"subCategory":{"type":"string","example":"SPEI_DEBIT"},"transactionStatus":{"type":"string","example":"INITIALIZED"},"audit":{"type":"object","properties":{"createdAt":{"type":"string","format":"date-time","example":"2025-05-09 18:02:31.979746-06:00"},"updatedAt":{"type":"string","format":"date-time","example":"2025-05-09 18:02:31.979746-06:00"},"deletedAt":{"type":["null","string"],"format":"date-time","example":null},"blockedAt":{"type":["null","string"],"format":"date-time","example":null}}}}}},"components/schemas/MoneyInRejectionResponse":{"id":"components/schemas/MoneyInRejectionResponse","kind":"json-schema","title":"MoneyInRejectionResponse","data":{"type":"object","properties":{"refundReason":{"type":"string","description":"Text with the reason why you reject the Money In. Used to populate the SPEI refund concept.","example":"Invalid amount"}},"required":["refundReason"]}},"components/schemas/CredentialsResponse":{"id":"components/schemas/CredentialsResponse","kind":"json-schema","title":"CredentialsResponse","data":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/Credential"}}}}},"components/schemas/Credential":{"id":"components/schemas/Credential","kind":"json-schema","title":"Credential","data":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"The unique identifier of the credential.","example":"e981c6d8-4d49-45f2-a7ee-f956dca15500"},"client_id":{"type":"string","format":"uuid","description":"The unique identifier of the client.","example":"c2d1d1e3-3340-4170-980e-e9269bbbc551"},"client_secret":{"type":"string","description":"The secret key for the client.","example":"Ui9gx7AXIpRqSkwSMQ35Ag1N5NXvm_7e4OEZESNMLQ29SbsvsXI1KKfIsGlZ70h_DfIPX2EWlysRlEKz8bXMsA"},"environment":{"type":"string","enum":["staging","production"],"description":"The environment in which the credentials are valid.","example":"staging"},"status":{"type":"string","enum":["ACTIVE","INACTIVE"],"description":"The status of the credentials.","example":"ACTIVE"},"created_at":{"type":"string","format":"date-time","description":"Timestamp when the credentials were created.","example":"2025-03-05T10:27:36.888241-06:00"},"updated_at":{"type":"string","format":"date-time","description":"Timestamp when the credentials were last updated.","example":"2025-03-05T10:27:36.888241-06:00"},"deleted_at":{"type":["null","string"],"description":"Timestamp when the credentials were deleted, or null if still active.","example":"None"}}}},"components/schemas/AuthCredentialResponse":{"id":"components/schemas/AuthCredentialResponse","kind":"json-schema","title":"AuthCredentialResponse","data":{"type":"object","properties":{"id":{"type":"string","format":"uuid","example":"1307f4e3-3960-4b98-9a14-0b6839245cc9"},"client_id":{"type":"string","format":"uuid","example":"c2d1d1e3-3340-4170-980e-e9269bbbc551"},"client_credential_id":{"type":"string","format":"uuid","example":"e981c6d8-4d49-45f2-a7ee-f956dca15500"},"token":{"type":"string","description":"JWT authentication token","example":"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJjbGllbnRfaWQiOiJjMmQxZDFlMy0zMzQwLTQxNzAtOTgwZS1lOTI2OWJiYmM1NTEiLCJleHAiOjE3NDEyODE0MTl9.ziSqMClLqwUVfyM15bqUF_7-PINY0ZiWkH01s8pO3gA"},"status":{"type":"string","enum":["ACTIVE","INACTIVE"],"example":"ACTIVE"},"expires_at":{"type":"string","format":"date-time","example":"2025-03-06T11:16:59.491631-06:00"},"created_at":{"type":"string","format":"date-time","example":"2025-03-05 11:16:59.488685-06:00"},"updated_at":{"type":"string","format":"date-time","example":"2025-03-05 11:16:59.488685-06:00"},"deleted_at":{"type":["null","string"],"example":"None"}}}},"components/schemas/BanksResponse":{"id":"components/schemas/BanksResponse","kind":"json-schema","title":"BanksResponse","data":{"type":"object","properties":{"total_banks":{"type":"integer","example":2},"page":{"type":"integer","example":1},"page_size":{"type":"integer","example":50},"banks":{"type":"array","items":{"$ref":"#/components/schemas/Bank"}}}}},"components/schemas/Bank":{"id":"components/schemas/Bank","kind":"json-schema","title":"Bank","data":{"type":"object","properties":{"id":{"type":"string","format":"uuid","example":"9d84b03a-28d1-4898-a69c-38824239e2b1"},"name":{"type":"string","example":"FINCO_PAY"},"token":{"type":"string","example":"734"},"BIM":{"type":"string","example":"734"},"code":{"type":"string","example":"90734"},"bank_status":{"type":"string","enum":["ACTIVE","INACTIVE"],"example":"ACTIVE"}}}},"components/schemas/InstrumentsResponse":{"id":"components/schemas/InstrumentsResponse","kind":"json-schema","title":"InstrumentsResponse","data":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/InstrumentResponse"}},"currentPage":{"type":"integer","example":1},"perPage":{"type":"integer","example":50},"totalItems":{"type":"integer","example":17}},"required":["data","currentPage","perPage","totalItems"]}},"components/schemas/AccountsResponse":{"id":"components/schemas/AccountsResponse","kind":"json-schema","title":"AccountsResponse","data":{"type":"object","properties":{"currentPage":{"type":"integer","example":1},"perPage":{"type":"integer","example":50},"totalItem":{"type":"integer","example":1},"data":{"type":"array","items":{"$ref":"#/components/schemas/Account"}}}}},"components/schemas/Account":{"id":"components/schemas/Account","kind":"json-schema","title":"Account","data":{"type":"object","properties":{"id":{"type":"string","format":"uuid","example":"24a726ac-180d-48df-82bc-711f2788a46f"},"bankId":{"type":"string","format":"uuid","example":"9d84b03a-28d1-4898-a69c-38824239e2b1"},"clientId":{"type":"string","format":"uuid","example":"c2d1d1e3-3340-4170-980e-e9269bbbc551"},"clientBankAdapterId":{"type":"string","format":"uuid","example":"5b3a1b67-ab59-4cc1-8fc6-1d558b32b237"},"accountId":{"type":"string","format":"uuid","example":"00000000-0000-0000-0000-000000000000"},"instrumentId":{"type":"string","format":"uuid","example":"709448c3-7cbf-454d-a87e-feb23801269a"},"ownerId":{"type":"string","format":"uuid","example":"c2d1d1e3-3340-4170-980e-e9269bbbc551"},"ownerType":{"type":"string","enum":["CLIENT","BUSINESS"],"example":"CLIENT"},"accountNumber":{"type":"string","example":"000001000004"},"clabeNumber":{"type":"string","example":"734180000001000004"},"availableBalance":{"type":"string","example":"0.00"},"accountType":{"type":"string","enum":["CENTRALIZING_ACCOUNT","OTHER"],"example":"CENTRALIZING_ACCOUNT"},"accountStatus":{"type":"string","enum":["ACTIVE","INACTIVE","SUSPENDED"],"example":"ACTIVE"},"audit":{"$ref":"#/components/schemas/Audit"},"bankAdapter":{"type":"string","example":"SIES"}}}},"components/schemas/PrivateAccountResponse":{"id":"components/schemas/PrivateAccountResponse","kind":"json-schema","title":"PrivateAccountResponse","data":{"type":"object","properties":{"id":{"type":"string","format":"uuid","example":"750ab428-b401-4b58-8a95-502bcb7b1bf8"},"bankId":{"type":"string","format":"uuid","example":"9d84b03a-28d1-4898-a69c-38824239e2b1"},"clientId":{"type":"string","format":"uuid","example":"c2d1d1e3-3340-4170-980e-e9269bbbc551"},"clientBankAdapterId":{"type":"string","format":"uuid","example":"5b3a1b67-ab59-4cc1-8fc6-1d558b32b237"},"accountId":{"type":"string","format":"uuid","example":"24a726ac-180d-48df-82bc-711f2788a46f"},"instrumentId":{"type":"string","format":"uuid","example":"ab502fce-1162-42f3-99d6-972989a06049"},"ownerId":{"type":"string","format":"uuid","example":"c2d1d1e3-3340-4170-980e-e9269bbbc551"},"ownerType":{"type":"string","example":"CLIENT"},"accountNumber":{"type":"string","example":"000001233635"},"clabeNumber":{"type":"string","example":"734180000001233635"},"availableBalance":{"type":"string","example":"0.00"},"accountType":{"type":"string","example":"PRIVATE_ACCOUNT"},"accountStatus":{"type":"string","example":"ACTIVE"},"audit":{"type":"object","properties":{"createdAt":{"type":"string","format":"date-time","example":"2025-04-12 11:00:56.264527-06:00"},"updatedAt":{"type":"string","format":"date-time","example":"2025-04-12 11:00:56.264527-06:00"},"deletedAt":{"type":["null","string"],"example":"None"},"blockedAt":{"type":["null","string"],"example":"None"},"activatedAt":{"type":["null","string"],"example":"None"},"suspendedAt":{"type":["null","string"],"example":"None"}}},"bankAdapter":{"type":"string","example":"SIES"}}}},"components/schemas/Audit":{"id":"components/schemas/Audit","kind":"json-schema","title":"Audit","data":{"type":"object","properties":{"createdAt":{"type":"string","format":"date-time","example":"2025-03-05 11:00:56.264527-06:00"},"updatedAt":{"type":"string","format":"date-time","example":"2025-03-05 11:00:56.264527-06:00"},"deletedAt":{"type":["null","string"],"example":"None"},"blockedAt":{"type":["null","string"],"example":"None"},"activatedAt":{"type":["null","string"],"example":"None"},"suspendedAt":{"type":["null","string"],"example":"None"}}}},"components/schemas/MoneyOutResponse":{"id":"components/schemas/MoneyOutResponse","kind":"json-schema","title":"MoneyOutResponse","data":{"type":"object","properties":{"id":{"type":"string","format":"uuid","example":"16811ee8-1ef9-4dd4-8d84-9c2df89cf302"},"bankId":{"type":"string","format":"uuid","example":"9d84b03a-28d1-4898-a69c-38824239e2b1"},"clientId":{"type":"string","format":"uuid","example":"c2d1d1e3-3340-4170-980e-e9269bbbc551"},"externalReference":{"type":"string","example":"1234567"},"trackingId":{"type":"string","example":"20250306FINCHVLIKQ5SKUM"},"description":{"type":"string","example":"lorem ipsum dolor sit amet"},"amount":{"type":"string","example":"1.95"},"currency":{"type":"string","example":"MXN"},"category":{"type":"string","example":"DEBIT_TRANS"},"subCategory":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Transaction sub-type based on the destination:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SPEI_DEBIT – external transfer to a non-Finco Pay bank account."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"INT_DEBIT – internal transfer routed to a Finco Pay account."},"children":[]}]}]}]}],"example":"SPEI_DEBIT"},"transactionStatus":{"type":"string","example":"INITIALIZED"},"audit":{"type":"object","properties":{"createdAt":{"type":"string","format":"date-time","example":"2025-03-06 11:57:55.408000-06:00"},"updatedAt":{"type":"string","format":"date-time","example":"2025-03-06 11:57:55.408000-06:00"},"deletedAt":{"type":["null","string"],"example":"None"},"blockedAt":{"type":["null","string"],"example":"None"}}}}}},"components/schemas/WebhookListResponse":{"id":"components/schemas/WebhookListResponse","kind":"json-schema","title":"WebhookListResponse","data":{"type":"object","properties":{"currentPage":{"type":"integer","example":0},"perPage":{"type":"integer","example":50},"totalItem":{"type":"integer","example":2},"data":{"type":"array","items":{"$ref":"#/components/schemas/WebhookResponse"}}},"required":["currentPage","perPage","totalItem","data"]}},"components/schemas/WebhookUpdateRequest":{"id":"components/schemas/WebhookUpdateRequest","kind":"json-schema","title":"WebhookUpdateRequest","data":{"type":"object","description":"Fields available to update for an existing webhook. All fields are optional, but at least one must be provided.\n","properties":{"url":{"type":"string","format":"uri","example":"https://example.com/new-webhook"},"token":{"type":"string","example":"newTokenValue"},"webhook_status":{"type":"string","enum":["ACTIVE","INACTIVE"],"example":"ACTIVE"},"auth_client_id":{"type":"string","example":"oauth-client-id"},"auth_client_secret":{"type":"string","example":"oauth-client-secret"},"auth_url":{"type":"string","format":"uri","example":"https://auth.example.com/oauth2/token"},"auth_scope":{"type":"string","example":"scope1 scope2"},"auth_audience":{"type":"string","example":"https://api.example.com"}}}},"components/schemas/WebhookResponse":{"id":"components/schemas/WebhookResponse","kind":"json-schema","title":"WebhookResponse","data":{"type":"object","properties":{"id":{"type":"string","example":"29806117-2b15-4682-87f0-350e6695fe91"},"clientId":{"type":"string","example":"c2d1d1e3-3340-4170-980e-e9269bbbc551"},"url":{"type":"string","example":"https://example.com/webhook"},"token":{"type":"string","example":"secretToken0123"},"webhookType":{"type":"string","example":"MONEY_IN"},"webhookStatus":{"type":"string","example":"ACTIVE"},"createdAt":{"type":"string","format":"date-time","example":"2025-04-03 13:40:54.056794-06:00"},"updatedAt":{"type":"string","format":"date-time","example":"2025-04-03 13:40:54.056794-06:00"},"deletedAt":{"type":["null","string"],"example":"None"},"blockedAt":{"type":["null","string"],"example":"None"},"deletedBy":{"type":["null","string"],"example":"None"},"blockedBy":{"type":["null","string"],"example":"None"}}}},"components/schemas/WebhookMoneyInEvent":{"id":"components/schemas/WebhookMoneyInEvent","kind":"json-schema","title":"WebhookMoneyInEvent","data":{"type":"object","properties":{"id_msg":{"type":"string","format":"uuid","description":"Unique message identifier (use for idempotency/deduplication).","example":"a7a126e8-fa74-411c-ad2b-b000f277bb0d"},"msg_name":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Event name. For Money In notifications it is always \"MONEY_IN\"."},"children":[]}]}]}],"example":"MONEY_IN"},"msg_date":{"type":"string","format":"date","description":"Event date (YYYY-MM-DD).","example":"2025-04-02"},"body":{"type":"object","properties":{"id":{"type":"string","format":"uuid","example":"0196da9a-8947-703e-9a3b-bf8c7d9f6059"},"beneficiary_account":{"type":"string","example":"734180123045603216"},"beneficiary_name":{"type":"string","example":"John Smith"},"beneficiary_rfc":{"type":"string","example":"XYZ123456789"},"payer_account":{"type":"string","example":"137180210044008609"},"payer_name":{"type":"string","example":"Juan Perez"},"payer_rfc":{"type":"string","example":"XYZ987654321"},"payer_institution":{"type":"string","description":"SPEI: Banxico institution code of the originating bank (e.g. 40002). Internal: Monato internal institution code (e.g. 90734).\n","example":"40002"},"amount":{"type":"string","description":"Amount credited, with two decimal places.","example":"123.00"},"transaction_date":{"type":"string","description":"Date and time when the transaction was registered in the rail. Format: YYYY-MM-DD HH:MM:SS.\n","example":"2025-04-02 10:14:05"},"tracking_key":{"type":"string","example":"50118609TBRNZ00I07219647"},"payment_concept":{"type":"string","example":"Payment for invoice 4567"},"numeric_reference":{"type":"string","example":"2504021"},"sub_category":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Internal classification of the credit. Possible values:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SPEI_CREDIT – external SPEI credit from a non-Finco Pay institution."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"INT_CREDIT – internal credit (book-to-book). Can originate from"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"POST /v1/transactions/internal_transaction"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or from"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"POST /v1/transactions/money_out"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" when the destination instrument"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"belongs to a Finco Pay account."},"children":[]}]}]}]}],"example":"SPEI_CREDIT"},"registered_at":{"type":"string","format":"date-time","description":"Timestamp in Monato when the transaction was created / persisted (ISO-8601 with timezone).","example":"2025-04-02T10:14:05.915184-06:00"},"owner_id":{"type":"string","format":"uuid","description":"Identifier of the owner of the destination instrument (e.g. the customer that owns the receiving account).","example":"24f1e5d5-4045-4b1a-a0c4-5e6c6b1d44ef"}}}},"required":["id_msg","msg_name","msg_date","body"]}},"components/schemas/WebhookCepEvent":{"id":"components/schemas/WebhookCepEvent","kind":"json-schema","title":"WebhookCepEvent","data":{"type":"object","properties":{"id_msg":{"type":"string","format":"uuid","description":"Unique message identifier (use for idempotency/deduplication)","example":"aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee"},"msg_name":{"type":"string","description":"Event name","enum":["CEP"],"example":"CEP"},"msg_date":{"type":"string","format":"date","description":"Event date (YYYY-MM-DD)","example":"2025-08-15"},"body":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Transaction ID for the penny validation","example":"11111111-2222-3333-4444-555555555555"},"tracking_key":{"type":"string","example":"20250815XXXXXX123456789"},"beneficiary_account":{"type":"string","description":"CLABE of the beneficiary","example":"000000000000000000"},"beneficiary_name":{"type":"string","example":"Daniela Paola Santelices Chavez"},"beneficiary_rfc":{"type":["string","null"],"example":"XXXX000000XXX"},"status":{"type":"string","description":"CEP processing status","enum":["PENDING","DELAYED","COMPLETED","FAILED"],"example":"DELAYED"},"processed_at":{"type":["string","null"],"format":"date-time","description":"Timestamp when CEP was finalized (COMPLETED/FAILED)","example":"2025-08-15T22:42:39.327Z"}}}},"required":["id_msg","msg_name","msg_date","body"]}},"components/schemas/StatusUpdateMessage":{"id":"components/schemas/StatusUpdateMessage","kind":"json-schema","title":"StatusUpdateMessage","data":{"type":"object","properties":{"id_msg":{"type":"string","format":"uuid","example":"35066b9c-e1e3-4d1b-89e6-35c036a70b00"},"msg_name":{"type":"string","example":"STATUS_UPDATE"},"msg_date":{"type":"string","format":"date","example":"2025-08-27"},"body":{"type":"object","properties":{"id":{"type":"string","format":"uuid","example":"6fd78718-106c-485d-824d-f6c3e8133571"},"tracking_key":{"type":"string","example":"20250827FINCH5CJS56XDFE"},"message_type":{"type":"string","example":"SPEI"},"reason":{"type":"string","example":"CANCELLED_ACCOUNT"},"reason_description":{"type":"string","example":"Cuenta cancelada"},"status":{"type":"string","enum":["INITIALIZED","LIQUIDATED","REFUNDED","REJECTED"],"example":"REJECTED"},"update_at":{"type":"string","format":"date-time","example":"2025-08-27T15:40:44.413078-06:00"}}}}}},"components/schemas/RegisterInstrumentBase":{"id":"components/schemas/RegisterInstrumentBase","kind":"json-schema","title":"RegisterInstrumentBase","data":{"type":"object","properties":{"source_bank_id":{"type":"string","description":"Issuer/processing bank ID at Finco/Finch.","example":"9d84b03a-28d1-4898-a69c-38824239e2b1"},"client_id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Client UUID under which the instrument is being registered. The actual owner will be the client itself (if "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"customer_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is omitted) or the customer specified in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"customer_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (if provided)."},"children":[]}]}]}],"example":"c2d1d1e3-3340-4170-980e-e9269bbbc551"},"customer_id":{"type":"string","description":"Optional customer UUID that will own the instrument. When provided, the instrument belongs to this customer.\n","example":"bb1e8fde-e68e-48e9-a483-d32153c752c2"},"type":{"type":"string","enum":["RECEIVER"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Instrument usage type. Currently only "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"RECEIVER"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is accepted."},"children":[]}]}]}],"example":"RECEIVER"},"rfc":{"type":"string","description":"RFC tax identifier of the account or card holder. If you don't have it, you can send \"ND\".\n","example":"XAXX010101000"},"alias":{"type":"string","description":"Human-friendly label for the instrument.","example":"lorem-ipsum"}},"required":["source_bank_id","client_id","type","rfc","alias"],"additionalProperties":false}},"components/schemas/RegisterDebitCardRequest":{"id":"components/schemas/RegisterDebitCardRequest","kind":"json-schema","title":"RegisterDebitCardRequest","data":{"allOf":[{"$ref":"#/components/schemas/RegisterInstrumentBase"},{"type":"object","properties":{"debit_card":{"$ref":"#/components/schemas/DebitCardPayload"}},"required":["debit_card"],"additionalProperties":false}]}},"components/schemas/RegisterClabeRequest":{"id":"components/schemas/RegisterClabeRequest","kind":"json-schema","title":"RegisterClabeRequest","data":{"allOf":[{"$ref":"#/components/schemas/RegisterInstrumentBase"},{"type":"object","properties":{"virtual_clabe":{"$ref":"#/components/schemas/VirtualClabePayload"}},"required":["virtual_clabe"],"additionalProperties":false}]}},"components/schemas/DebitCardPayload":{"id":"components/schemas/DebitCardPayload","kind":"json-schema","title":"DebitCardPayload","data":{"type":"object","properties":{"destination_bank_id":{"type":"string","example":"3054ff18-32a0-478d-b9fe-b5261f9a6e1f"},"card_number":{"type":"string","example":"5579072268574100"},"holder_name":{"type":"string","example":"John Smith"}},"required":["destination_bank_id","card_number","holder_name"],"additionalProperties":false}},"components/schemas/VirtualClabePayload":{"id":"components/schemas/VirtualClabePayload","kind":"json-schema","title":"VirtualClabePayload","data":{"type":"object","properties":{"destination_bank_id":{"type":"string","example":"3054ff18-32a0-478d-b9fe-b5261f9a6e1f"},"account_number":{"type":"string","example":"006487113111"},"clabe_number":{"type":"string","example":"002118006487113111"},"holder_name":{"type":"string","example":"John Smith"}},"required":["destination_bank_id","account_number","clabe_number","holder_name"],"additionalProperties":false}},"components/schemas/InstrumentResponse":{"id":"components/schemas/InstrumentResponse","kind":"json-schema","title":"InstrumentResponse","data":{"allOf":[{"$ref":"#/components/schemas/InstrumentBaseResponse"},{"type":"object","properties":{"instrumentDetail":{"oneOf":[{"$ref":"#/components/schemas/CardInstrumentDetail"},{"$ref":"#/components/schemas/ClabeInstrumentDetail"}]}},"required":["instrumentDetail"]}]}},"components/schemas/InstrumentBaseResponse":{"id":"components/schemas/InstrumentBaseResponse","kind":"json-schema","title":"InstrumentBaseResponse","data":{"type":"object","properties":{"id":{"type":"string","example":"dd7f8d89-94dd-43ca-871b-720fde378b52"},"bankId":{"type":"string","example":"d3435bd9-998d-4e8a-9067-6b71d5fd3ac7"},"clientId":{"type":"string","example":"c2d1d1e3-3340-4170-980e-e9269bbbc551"},"ownerId":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Identifier of the entity that owns this instrument (client or customer). When the instrument belongs to a customer, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ownerId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"customerId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" will be the same."},"children":[]}]}]}],"example":"c2d1d1e3-3340-4170-980e-e9269bbbc551"},"alias":{"type":"string","example":"Instrumento base"},"type":{"type":"string","enum":["RECEIVER"],"example":"RECEIVER"},"audit":{"type":"object","properties":{"createdAt":{"type":"string","example":"2025-05-19 19:03:51.084659-06:00"},"updatedAt":{"type":"string","example":"2025-05-19 19:03:51.084668-06:00"},"deletedAt":{"type":["string","null"],"example":null},"blockedAt":{"type":["string","null"],"example":null}},"required":["createdAt","updatedAt","deletedAt","blockedAt"]},"rfc":{"type":"string","example":"XAXX010101000"},"customerId":{"type":"string","description":"Customer who owns the instrument when applicable. Present when the instrument belongs to a customer; omitted for client-level instruments.\n","example":"bb1e8fde-e68e-48e9-a483-d32153c752c2"}},"required":["id","bankId","clientId","ownerId","alias","type","audit","rfc"]}},"components/schemas/CardInstrumentDetail":{"id":"components/schemas/CardInstrumentDetail","kind":"json-schema","title":"CardInstrumentDetail","data":{"type":"object","properties":{"cardNumber":{"type":"string","example":"5579072268574100"},"expirationDate":{"type":["string","null"],"description":"May be the string \"None\" or null when not available.","example":"None"},"holderName":{"type":"string","example":"John Smith"}},"required":["cardNumber","holderName"]}},"components/schemas/ClabeInstrumentDetail":{"id":"components/schemas/ClabeInstrumentDetail","kind":"json-schema","title":"ClabeInstrumentDetail","data":{"type":"object","properties":{"accountNumber":{"type":"string","example":"006487113111"},"clabeNumber":{"type":"string","example":"002118006487113111"},"holderName":{"type":"string","example":"John Smith"}},"required":["accountNumber","clabeNumber","holderName"]}},"components/schemas/ReportWebhookEvent":{"id":"components/schemas/ReportWebhookEvent","kind":"json-schema","title":"ReportWebhookEvent","data":{"type":"object","required":["client_id","file_type","period","file_name","created_at"],"properties":{"client_id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Identificador único del cliente."},"children":[]}]}]}],"example":"9c6f6c8a-7c91-4b12-9a45-5cfdc78c22b1"},"file_type":{"type":"string","enum":["TRANSACTIONS","ACCOUNT_STATEMENT"],"description":"Tipo de archivo generado.","example":"TRANSACTIONS"},"period":{"type":"string","enum":["DAILY","MONTHLY"],"description":"Periodicidad del archivo generado.","example":"DAILY"},"file_name":{"type":"string","description":"Nombre del archivo generado.","example":"transactions_daily_20260224.csv"},"created_at":{"type":"string","format":"date-time","description":"Fecha y hora en la que el archivo fue generado (ISO 8601).","example":"2026-02-24T10:30:15Z"},"account_id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Identificador de la cuenta asociada. Solo presente cuando file_type = ACCOUNT_STATEMENT."},"children":[]}]}]}],"example":"1234567890"}}}},"components/schemas/ReportDownloadRequest":{"id":"components/schemas/ReportDownloadRequest","kind":"json-schema","title":"ReportDownloadRequest","data":{"type":"object","required":["client_id","report_type","operation_date"],"properties":{"client_id":{"type":"string","format":"uuid","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Identificador único del cliente."},"children":[]}]}]}],"example":"c2d1d1e3-3340-4170-980e-e9269bbbc551"},"clabe_number":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Número CLABE de la cuenta asociada. Requerido cuando report_type es DAILY_ACCOUNT_STATEMENT o MONTHLY_ACCOUNT_STATEMENT. Debe pertenecer al cliente."},"children":[]}]}]}],"example":"123456789012345678"},"report_type":{"type":"string","enum":["MONTHLY","DAILY","DAILY_ACCOUNT_STATEMENT","MONTHLY_ACCOUNT_STATEMENT"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Tipo de reporte a descargar. Para MONTHLY y MONTHLY_ACCOUNT_STATEMENT, operation_date se normaliza al último día del mes."},"children":[]}]}]}],"example":"DAILY_ACCOUNT_STATEMENT"},"operation_date":{"type":"string","format":"date","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Fecha de operación en formato YYYY-MM-DD. Para tipos MONTHLY y MONTHLY_ACCOUNT_STATEMENT se normaliza al último día del mes (ejemplo: 2025-08-25 → 2025-08-31)."},"children":[]}]}]}],"example":"2025-08-25"}}}},"components/schemas/ReportDownloadResponse":{"id":"components/schemas/ReportDownloadResponse","kind":"json-schema","title":"ReportDownloadResponse","data":{"type":"object","properties":{"file_name":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Nombre del archivo generado. Vacío si no se encontró ningún archivo."},"children":[]}]}]}],"example":"daily_account_statement_123456789012345678_20260224.csv"},"download_url":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"URL de descarga del archivo. Vacía si no se encontró ningún archivo."},"children":[]}]}]}],"example":"https://..."}}}},"schema_103":{"kind":"json-schema","data":{"type":"string","format":"uuid","example":"c2d1d1e3-3340-4170-980e-e9269bbbc551"},"id":"schema_103"},"schema_104":{"kind":"json-schema","data":{"type":"string"},"id":"schema_104"},"schema_105":{"kind":"json-schema","data":{"type":"string","format":"uuid"},"id":"schema_105"},"schema_106":{"kind":"json-schema","data":{"type":"integer","minimum":1},"id":"schema_106"},"schema_107":{"kind":"json-schema","data":{"oneOf":[{"$ref":"#/components/schemas/RegisterDebitCardRequest"},{"$ref":"#/components/schemas/RegisterClabeRequest"}],"discriminator":{"propertyName":"instrumentKind","mapping":{"debit_card":"#/components/schemas/RegisterDebitCardRequest","virtual_clabe":"#/components/schemas/RegisterClabeRequest"}}},"id":"schema_107"},"schema_108":{"kind":"json-schema","data":{"type":"string","pattern":"^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-5[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"},"id":"schema_108"}},"exampleStore":{"paths/~1v1~1banks/get/responses/200/content/application~1json/examples/example":{"value":{"total_banks":1,"page":1,"page_size":50,"banks":[{"id":"9d84b03a-28d1-4898-a69c-38824239e2b1","name":"FINCO_PAY","token":"734","BIM":"734","code":"90734","bank_status":"ACTIVE"}]},"key":"example","summary":"example","id":"paths/~1v1~1banks/get/responses/200/content/application~1json/examples/example"},"paths/~1v1~1clients~1{clientId}~1instruments/post/requestBody/content/application~1json/examples/addDebitCard":{"value":{"instrumentKind":"debit_card","source_bank_id":"9d84b03a-28d1-4898-a69c-38824239e2b1","client_id":"c2d1d1e3-3340-4170-980e-e9269bbbc551","customer_id":"bb1e8fde-e68e-48e9-a483-d32153c752c2","type":"RECEIVER","rfc":"XAXX010101000","alias":"Tarjeta ABC123","debit_card":{"destination_bank_id":"3054ff18-32a0-478d-b9fe-b5261f9a6e1f","card_number":"5579072268574100","holder_name":"Pedro Navajas Dos"}},"key":"addDebitCard","summary":"Add debit card","id":"paths/~1v1~1clients~1{clientId}~1instruments/post/requestBody/content/application~1json/examples/addDebitCard"},"paths/~1v1~1clients~1{clientId}~1instruments/post/requestBody/content/application~1json/examples/addClabe":{"value":{"instrumentKind":"virtual_clabe","source_bank_id":"9d84b03a-28d1-4898-a69c-38824239e2b1","client_id":"c2d1d1e3-3340-4170-980e-e9269bbbc551","type":"RECEIVER","rfc":"XAXX010101000","alias":"CLABE XYZ123","virtual_clabe":{"destination_bank_id":"3054ff18-32a0-478d-b9fe-b5261f9a6e1f","account_number":"006487113111","clabe_number":"002118006487113111","holder_name":"Pedro Navajas Perez"}},"key":"addClabe","summary":"Add CLABE","id":"paths/~1v1~1clients~1{clientId}~1instruments/post/requestBody/content/application~1json/examples/addClabe"},"paths/~1v1~1clients~1{clientId}~1instruments/post/responses/200/content/application~1json/examples/createdCard":{"value":{"id":"dd7f8d89-94dd-43ca-871b-720fde378b52","bankId":"d3435bd9-998d-4e8a-9067-6b71d5fd3ac7","clientId":"c2d1d1e3-3340-4170-980e-e9269bbbc551","ownerId":"c2d1d1e3-3340-4170-980e-e9269bbbc551","alias":"Tarjeta con expiracion","type":"RECEIVER","instrumentDetail":{"cardNumber":"5579072268574100","expirationDate":"None","holderName":"Pedro Navajas Dos"},"audit":{"createdAt":"2025-05-19 19:03:51.084659-06:00","updatedAt":"2025-05-19 19:03:51.084659-06:00","deletedAt":"None","blockedAt":"None"},"rfc":"XAXX010101000","customerId":"bb1e8fde-e68e-48e9-a483-d32153c752c2"},"key":"createdCard","summary":"Created debit card instrument","id":"paths/~1v1~1clients~1{clientId}~1instruments/post/responses/200/content/application~1json/examples/createdCard"},"paths/~1v1~1clients~1{clientId}~1instruments/post/responses/200/content/application~1json/examples/createdClabe":{"value":{"id":"2e7e36f8-d3ba-48a0-872e-f093379d6a4f","bankId":"3054ff18-32a0-478d-b9fe-b5261f9a6e1f","clientId":"c2d1d1e3-3340-4170-980e-e9269bbbc551","ownerId":"c2d1d1e3-3340-4170-980e-e9269bbbc551","alias":"CLABE XYZ123","type":"RECEIVER","instrumentDetail":{"accountNumber":"006487113111","clabeNumber":"002118006487113111","holderName":"Pedro Navajas Perez"},"audit":{"createdAt":"2025-08-11 13:52:21.702839-06:00","updatedAt":"2025-08-11 13:52:21.702839-06:00","deletedAt":"None","blockedAt":"None"},"rfc":"XAXX010101000"},"key":"createdClabe","summary":"Created CLABE instrument","id":"paths/~1v1~1clients~1{clientId}~1instruments/post/responses/200/content/application~1json/examples/createdClabe"},"paths/~1v1~1transactions~1money_out/post/requestBody/content/application~1json/example":{"value":{"client_id":"c2d1d1e3-3340-4170-980e-e9269bbbc551","source_instrument_id":"709448c3-7cbf-454d-a87e-feb23801269a","destination_instrument_id":"d3fdb481-2058-46c8-807d-4eaf866ae1ec","transaction_request":{"external_reference":"1234567","description":"lorem ipsum dolor sit amet","amount":"1.95","currency":"MXN"}},"id":"paths/~1v1~1transactions~1money_out/post/requestBody/content/application~1json/example"},"paths/~1v1~1transactions~1money_out/post/responses/200/content/application~1json/example":{"value":{"id":"16811ee8-1ef9-4dd4-8d84-9c2df89cf302","bankId":"9d84b03a-28d1-4898-a69c-38824239e2b1","clientId":"c2d1d1e3-3340-4170-980e-e9269bbbc551","externalReference":"1234567","trackingId":"20250306FINCHVLIKQ5SKUM","description":"lorem ipsum dolor sit amet","amount":"1.95","currency":"MXN","category":"DEBIT_TRANS","subCategory":"SPEI_DEBIT","transactionStatus":"INITIALIZED","audit":{"createdAt":"2025-03-06 11:57:55.408000-06:00","updatedAt":"2025-03-06 11:57:55.408000-06:00","deletedAt":"None","blockedAt":"None"}},"id":"paths/~1v1~1transactions~1money_out/post/responses/200/content/application~1json/example"},"paths/~1v1~1clients~1{clientId}~1transactions~1{transactionId}~1refund/post/requestBody/content/application~1json/example":{"value":{"amount":"5.00","description":"Invalid Amount"},"id":"paths/~1v1~1clients~1{clientId}~1transactions~1{transactionId}~1refund/post/requestBody/content/application~1json/example"},"paths/~1v1~1clients~1{clientId}~1transactions~1{transactionId}~1refund/post/responses/200/content/application~1json/example":{"value":{"id":"957459ce-d4e3-40b5-b759-373e844ba1e8","bankId":"9d84b03a-28d1-4898-a69c-38824239e2b1","clientId":"c2d1d1e3-3340-4170-980e-e9269bbbc551","externalReference":"2505091","trackingId":"20250510FINCHFL2SFGP9KT","description":"lorem ipsum dolor sit amet","amount":"100.00","currency":"MXN","category":"DEBIT_TRANS","subCategory":"SPEI_DEBIT","transactionStatus":"INITIALIZED","audit":{"createdAt":"2025-05-09 18:02:31.979746-06:00","updatedAt":"2025-05-09 18:02:31.979746-06:00","deletedAt":null,"blockedAt":null}},"id":"paths/~1v1~1clients~1{clientId}~1transactions~1{transactionId}~1refund/post/responses/200/content/application~1json/example"},"paths/~1v1~1clients~1{clientId}~1webhooks/post/requestBody/content/application~1json/example":{"value":{"client_id":"{{clientId}}","url":"https://example.com/webhook","token":"secretToken0123","webhook_type":"MONEY_IN","auth_type":"AUTH"},"id":"paths/~1v1~1clients~1{clientId}~1webhooks/post/requestBody/content/application~1json/example"},"paths/~1v1~1reports~1clients~1{client_id}~1report~1download/post/requestBody/content/application~1json/examples/dailyAccountStatement":{"value":{"clabe_number":"123456789012345678","report_type":"DAILY_ACCOUNT_STATEMENT","operation_date":"2025-08-25"},"key":"dailyAccountStatement","summary":"Daily account statement","id":"paths/~1v1~1reports~1clients~1{client_id}~1report~1download/post/requestBody/content/application~1json/examples/dailyAccountStatement"},"paths/~1v1~1reports~1clients~1{client_id}~1report~1download/post/requestBody/content/application~1json/examples/dailyTransactions":{"value":{"report_type":"DAILY","operation_date":"2025-08-25"},"key":"dailyTransactions","summary":"Daily transactions report","id":"paths/~1v1~1reports~1clients~1{client_id}~1report~1download/post/requestBody/content/application~1json/examples/dailyTransactions"},"paths/~1v1~1reports~1clients~1{client_id}~1report~1download/post/responses/200/content/application~1json/example":{"value":{"file_name":"daily_account_statement_123456789012345678_20260224.csv","download_url":"https://..."},"id":"paths/~1v1~1reports~1clients~1{client_id}~1report~1download/post/responses/200/content/application~1json/example"},"paths/~1v1~1clients~1{clientId}~1webhooks~1{id}/patch/requestBody/content/application~1json/examples/updateUrlAndStatus":{"value":{"url":"https://example.com/new-webhook","webhook_status":"ACTIVE"},"key":"updateUrlAndStatus","summary":"Update URL and status","id":"paths/~1v1~1clients~1{clientId}~1webhooks~1{id}/patch/requestBody/content/application~1json/examples/updateUrlAndStatus"},"paths/~1v1~1webhooks/post/requestBody/content/application~1json/example":{"value":{"client_id":"{{clientId}}","url":"https://example.com/webhook","token":"secretToken0123","webhook_type":"MONEY_IN","auth_type":"AUTH"},"id":"paths/~1v1~1webhooks/post/requestBody/content/application~1json/example"},"paths/~1v1~1webhooks/post/responses/200/content/application~1json/example":{"value":{"id":"29806117-2b15-4682-87f0-350e6695fe91","clientId":"c2d1d1e3-3340-4170-980e-e9269bbbc551","url":"https://example.com/webhook","token":"secretToken0123","webhookType":"MONEY_IN","webhookStatus":"ACTIVE","createdAt":"2025-04-03 13:40:54.056794-06:00","updatedAt":"2025-04-03 13:40:54.056794-06:00","deletedAt":"None","blockedAt":"None","deletedBy":"None","blockedBy":"None"},"id":"paths/~1v1~1webhooks/post/responses/200/content/application~1json/example"},"paths/money-in/post/responses/422/content/application~1json/example":{"value":{"refundReason":"Invalid amount"},"id":"paths/money-in/post/responses/422/content/application~1json/example"},"paths/report/post/requestBody/content/application~1json/examples/transactionsReport":{"value":{"client_id":"9c6f6c8a-7c91-4b12-9a45-5cfdc78c22b1","file_type":"TRANSACTIONS","period":"DAILY","file_name":"transactions_daily_20260224.csv","created_at":"2026-02-24T10:30:15Z"},"key":"transactionsReport","summary":"Transactions report - daily","id":"paths/report/post/requestBody/content/application~1json/examples/transactionsReport"},"paths/report/post/requestBody/content/application~1json/examples/accountStatement":{"value":{"client_id":"9c6f6c8a-7c91-4b12-9a45-5cfdc78c22b1","file_type":"ACCOUNT_STATEMENT","period":"MONTHLY","file_name":"account_statement_1234567890_202602.csv","created_at":"2026-03-01T02:10:00Z","account_id":"1234567890"},"key":"accountStatement","summary":"Account statement - monthly","id":"paths/report/post/requestBody/content/application~1json/examples/accountStatement"}},"securitySchemeStore":{"ApiKeyAuth":{"id":"ApiKeyAuth","type":"apiKey","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API Key authentication using the \"x-api-key\" header. Contact us at support@monato.com so we can provide you an API Key."},"children":[]}]}]}],"in":"header","paramName":"x-api-key"},"bearerAuth":{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}},"servers":[{"url":"https://apicore.stg.finch.lat"}]},"options":{"hideSidebar":true,"mockServer":{"url":"/_mock/products/fincore/fincore-openapi","position":"off","description":"Mock server"},"disableRouter":true,"downloadUrls":[{"url":"/_bundle/products/fincore/fincore-openapi.json?download"},{"url":"/_bundle/products/fincore/fincore-openapi.yaml?download"}],"excludeFromSearch":false,"specType":"openapi","markdocOptions":{"tags":{},"nodes":{},"components":{}},"metadata":{"title":"Fincore API","description":"Monato is a financial technology company specializing in SPEI transfer services in Mexico. We provide secure, fast, and reliable payment solutions for businesses, enabling seamless bank transfers through our API and platform"}},"baseSlug":"/products/fincore/fincore-openapi","routesMapping":{}}