{"swagger":"2.0","info":{"description":"API da Unicred para inicia\u00e7\u00e3o de pagamentos (PISP) voltada a parceiros e produtos.","version":"1.0.0-RC1","title":"Unicred Init - Open Finance - PISP","contact":[]},"host":"api.e-unicred.com.br","basePath":"\/homolog\/unicred\/openfinance\/payments\/v1","tags":[],"schemes":["https"],"consumes":["application\/json"],"produces":["application\/json"],"paths":{"\/payments\/consents\/{consentId}":{"patch":{"summary":"M\u00e9todo para cancelar pagamentos em lote por ID do consentimento.","description":"M\u00e9todo para cancelar pagamentos em lote por ID do consentimento.","operationId":"patchPaymentConsentById","produces":["application\/json","application\/json; charset=utf-8"],"parameters":[{"name":"consentId","in":"path","description":"Identificador \u00fanico do consentimento.","required":true,"type":"string","maxLength":100,"pattern":"^[a-zA-Z0-9][a-zA-Z0-9\\-]{0,99}$"},{"in":"body","name":"cancellationBody","required":true,"schema":{"$ref":"#\/definitions\/RequestCancellation"}}],"responses":{"200":{"description":"Dados dos pagamentos cancelados com sucesso.","headers":[],"schema":{"$ref":"#\/definitions\/ResponsePayments"}},"400":{"description":"A requisi\u00e7\u00e3o foi malformada, omitindo atributos obrigat\u00f3rios, seja no payload ou atrav\u00e9s de atributos na URL.","headers":[],"schema":{"$ref":"#\/definitions\/ResponseError"}},"401":{"description":"Cabe\u00e7alho de autentica\u00e7\u00e3o ausente\/inv\u00e1lido ou token inv\u00e1lido","headers":[],"schema":{"$ref":"#\/definitions\/ResponseError"}},"403":{"description":"O token tem escopo incorreto ou uma pol\u00edtica de seguran\u00e7a foi violada","headers":[],"schema":{"$ref":"#\/definitions\/ResponseError"}},"404":{"description":"O recurso solicitado n\u00e3o existe ou n\u00e3o foi implementado","headers":[],"schema":{"$ref":"#\/definitions\/ResponseError"}},"405":{"description":"O consumidor tentou acessar o recurso com um m\u00e9todo n\u00e3o suportado","headers":[],"schema":{"$ref":"#\/definitions\/ResponseError"}},"406":{"description":"A solicita\u00e7\u00e3o continha um cabe\u00e7alho Accept diferente dos tipos de m\u00eddia permitidos ou um conjunto de caracteres diferente de UTF-8","headers":[],"schema":{"$ref":"#\/definitions\/ResponseError"}},"429":{"description":"A opera\u00e7\u00e3o foi recusada, pois muitas solicita\u00e7\u00f5es foram feitas dentro de um determinado per\u00edodo ou o limite global de requisi\u00e7\u00f5es concorrentes foi atingido","headers":[],"schema":{"$ref":"#\/definitions\/ResponseError"}},"500":{"description":"Ocorreu um erro no gateway da API ou no servi\u00e7o","headers":[],"schema":{"$ref":"#\/definitions\/ResponseError"}},"default":{"description":"Dados dos pagamentos cancelados com sucesso.","headers":[],"schema":{"$ref":"#\/definitions\/ResponsePayments"}}},"security":[{"OAuth2":["write:payments"]}],"deprecated":false},"parameters":[]},"\/consents":{"post":{"summary":"M\u00e9todo para criar os consentimentos para pagamentos PISP.","description":"M\u00e9todo para criar os consentimentos para pagamentos PISP.","operationId":"postconsents","produces":["application\/json","application\/json; charset=utf-8"],"parameters":[{"name":"x-idempotency-key","in":"header","required":true,"type":"string"},{"in":"body","name":"consent","required":true,"schema":{"$ref":"#\/definitions\/RequestConsent"}}],"responses":{"302":{"description":"Dados relativos ao consentimento criado com sucesso.","headers":{"location":{"type":"string","description":"URL para redirecionamento para a IF transmissora."}},"schema":{"$ref":"#\/definitions\/ResponseConsent"}},"400":{"description":"A requisi\u00e7\u00e3o foi malformada, omitindo atributos obrigat\u00f3rios, seja no payload ou atrav\u00e9s de atributos na URL.","headers":[],"schema":{"$ref":"#\/definitions\/ResponseError"}},"401":{"description":"Cabe\u00e7alho de autentica\u00e7\u00e3o ausente\/inv\u00e1lido ou token inv\u00e1lido","headers":[],"schema":{"$ref":"#\/definitions\/ResponseError"}},"403":{"description":"O token tem escopo incorreto ou uma pol\u00edtica de seguran\u00e7a foi violada","headers":[],"schema":{"$ref":"#\/definitions\/ResponseError"}},"404":{"description":"O recurso solicitado n\u00e3o existe ou n\u00e3o foi implementado","headers":[],"schema":{"$ref":"#\/definitions\/ResponseError"}},"405":{"description":"O consumidor tentou acessar o recurso com um m\u00e9todo n\u00e3o suportado","headers":[],"schema":{"$ref":"#\/definitions\/ResponseError"}},"406":{"description":"A solicita\u00e7\u00e3o continha um cabe\u00e7alho Accept diferente dos tipos de m\u00eddia permitidos ou um conjunto de caracteres diferente de UTF-8","headers":[],"schema":{"$ref":"#\/definitions\/ResponseError"}},"429":{"description":"A opera\u00e7\u00e3o foi recusada, pois muitas solicita\u00e7\u00f5es foram feitas dentro de um determinado per\u00edodo ou o limite global de requisi\u00e7\u00f5es concorrentes foi atingido","headers":[],"schema":{"$ref":"#\/definitions\/ResponseError"}},"500":{"description":"Ocorreu um erro no gateway da API ou no servi\u00e7o","headers":[],"schema":{"$ref":"#\/definitions\/ResponseError"}},"default":{"description":"Dados relativos ao consentimento criado com sucesso.","headers":[],"schema":{"$ref":"#\/definitions\/ResponseConsent"}}},"security":[{"OAuth2":["write:consents"]}],"deprecated":false},"parameters":[]},"\/consents\/{consentId}":{"get":{"summary":"M\u00e9todo para buscar por id um consentimento criado anteriormente pela plataforma.","description":"M\u00e9todo para buscar por id um consentimento criado anteriormente pela plataforma.","operationId":"getConsentsById","produces":["application\/json","application\/json; charset=utf-8"],"parameters":[{"name":"consentId","in":"path","description":"Identificador \u00fanico do consentimento.","required":true,"type":"string","maxLength":100,"pattern":"^[a-zA-Z0-9][a-zA-Z0-9\\-]{0,99}$"}],"responses":{"200":{"description":"Dados relativos ao consentimento criado com sucesso.","headers":[],"schema":{"$ref":"#\/definitions\/ResponseConsent"}},"400":{"description":"A requisi\u00e7\u00e3o foi malformada, omitindo atributos obrigat\u00f3rios, seja no payload ou atrav\u00e9s de atributos na URL.","headers":[],"schema":{"$ref":"#\/definitions\/ResponseError"}},"401":{"description":"Cabe\u00e7alho de autentica\u00e7\u00e3o ausente\/inv\u00e1lido ou token inv\u00e1lido","headers":[],"schema":{"$ref":"#\/definitions\/ResponseError"}},"403":{"description":"O token tem escopo incorreto ou uma pol\u00edtica de seguran\u00e7a foi violada","headers":[],"schema":{"$ref":"#\/definitions\/ResponseError"}},"404":{"description":"O recurso solicitado n\u00e3o existe ou n\u00e3o foi implementado","headers":[],"schema":{"$ref":"#\/definitions\/ResponseError"}},"405":{"description":"O consumidor tentou acessar o recurso com um m\u00e9todo n\u00e3o suportado","headers":[],"schema":{"$ref":"#\/definitions\/ResponseError"}},"406":{"description":"A solicita\u00e7\u00e3o continha um cabe\u00e7alho Accept diferente dos tipos de m\u00eddia permitidos ou um conjunto de caracteres diferente de UTF-8","headers":[],"schema":{"$ref":"#\/definitions\/ResponseError"}},"429":{"description":"A opera\u00e7\u00e3o foi recusada, pois muitas solicita\u00e7\u00f5es foram feitas dentro de um determinado per\u00edodo ou o limite global de requisi\u00e7\u00f5es concorrentes foi atingido","headers":[],"schema":{"$ref":"#\/definitions\/ResponseError"}},"500":{"description":"Ocorreu um erro no gateway da API ou no servi\u00e7o","headers":[],"schema":{"$ref":"#\/definitions\/ResponseError"}},"default":{"description":"Dados relativos ao consentimento criado com sucesso.","headers":[],"schema":{"$ref":"#\/definitions\/ResponseConsent"}}},"security":[{"OAuth2":["read:consents"]}],"deprecated":false},"parameters":[]},"\/payments\/{paymentId}":{"get":{"summary":"M\u00e9todo para obter os dados do pagamento PISP por ID.","description":"M\u00e9todo para obter os dados do pagamento PISP por ID.","operationId":"getPaymentById","produces":["application\/json","application\/json; charset=utf-8"],"parameters":[{"name":"paymentId","in":"path","description":"Identificador \u00fanico do pagamento.","required":true,"type":"string","maxLength":100,"pattern":"^[a-zA-Z0-9][a-zA-Z0-9\\-]{0,99}$"}],"responses":{"200":{"description":"Dados da pagamento identificada pelo ID obtidos com sucesso.","headers":[],"schema":{"$ref":"#\/definitions\/ResponsePayment"}},"400":{"description":"A requisi\u00e7\u00e3o foi malformada, omitindo atributos obrigat\u00f3rios, seja no payload ou atrav\u00e9s de atributos na URL.","headers":[],"schema":{"$ref":"#\/definitions\/ResponseError"}},"401":{"description":"Cabe\u00e7alho de autentica\u00e7\u00e3o ausente\/inv\u00e1lido ou token inv\u00e1lido","headers":[],"schema":{"$ref":"#\/definitions\/ResponseError"}},"403":{"description":"O token tem escopo incorreto ou uma pol\u00edtica de seguran\u00e7a foi violada","headers":[],"schema":{"$ref":"#\/definitions\/ResponseError"}},"404":{"description":"O recurso solicitado n\u00e3o existe ou n\u00e3o foi implementado","headers":[],"schema":{"$ref":"#\/definitions\/ResponseError"}},"405":{"description":"O consumidor tentou acessar o recurso com um m\u00e9todo n\u00e3o suportado","headers":[],"schema":{"$ref":"#\/definitions\/ResponseError"}},"406":{"description":"A solicita\u00e7\u00e3o continha um cabe\u00e7alho Accept diferente dos tipos de m\u00eddia permitidos ou um conjunto de caracteres diferente de UTF-8","headers":[],"schema":{"$ref":"#\/definitions\/ResponseError"}},"429":{"description":"A opera\u00e7\u00e3o foi recusada, pois muitas solicita\u00e7\u00f5es foram feitas dentro de um determinado per\u00edodo ou o limite global de requisi\u00e7\u00f5es concorrentes foi atingido","headers":[],"schema":{"$ref":"#\/definitions\/ResponseError"}},"500":{"description":"Ocorreu um erro no gateway da API ou no servi\u00e7o","headers":[],"schema":{"$ref":"#\/definitions\/ResponseError"}},"default":{"description":"Dados da pagamento identificada pelo ID obtidos com sucesso.","headers":[],"schema":{"$ref":"#\/definitions\/ResponsePayment"}}},"security":[{"OAuth2":["read:payments"]}],"deprecated":false},"patch":{"summary":"M\u00e9todo para cancelar um pagamento \u00fanico por ID.","description":"M\u00e9todo para cancelar um pagamento \u00fanico por ID.","operationId":"patchPaymentById","produces":["application\/json","application\/json; charset=utf-8"],"parameters":[{"name":"paymentId","in":"path","description":"Identificador \u00fanico do pagamento.","required":true,"type":"string","maxLength":100,"pattern":"^[a-zA-Z0-9][a-zA-Z0-9\\-]{0,99}$"},{"in":"body","name":"cancellationBody","required":true,"schema":{"$ref":"#\/definitions\/RequestCancellation"}}],"responses":{"200":{"description":"Dados do pagamento alterado com sucesso.","headers":[],"schema":{"$ref":"#\/definitions\/ResponsePayment"}},"400":{"description":"A requisi\u00e7\u00e3o foi malformada, omitindo atributos obrigat\u00f3rios, seja no payload ou atrav\u00e9s de atributos na URL.","headers":[],"schema":{"$ref":"#\/definitions\/ResponseError"}},"401":{"description":"Cabe\u00e7alho de autentica\u00e7\u00e3o ausente\/inv\u00e1lido ou token inv\u00e1lido","headers":[],"schema":{"$ref":"#\/definitions\/ResponseError"}},"403":{"description":"O token tem escopo incorreto ou uma pol\u00edtica de seguran\u00e7a foi violada","headers":[],"schema":{"$ref":"#\/definitions\/ResponseError"}},"404":{"description":"O recurso solicitado n\u00e3o existe ou n\u00e3o foi implementado","headers":[],"schema":{"$ref":"#\/definitions\/ResponseError"}},"405":{"description":"O consumidor tentou acessar o recurso com um m\u00e9todo n\u00e3o suportado","headers":[],"schema":{"$ref":"#\/definitions\/ResponseError"}},"406":{"description":"A solicita\u00e7\u00e3o continha um cabe\u00e7alho Accept diferente dos tipos de m\u00eddia permitidos ou um conjunto de caracteres diferente de UTF-8","headers":[],"schema":{"$ref":"#\/definitions\/ResponseError"}},"429":{"description":"A opera\u00e7\u00e3o foi recusada, pois muitas solicita\u00e7\u00f5es foram feitas dentro de um determinado per\u00edodo ou o limite global de requisi\u00e7\u00f5es concorrentes foi atingido","headers":[],"schema":{"$ref":"#\/definitions\/ResponseError"}},"500":{"description":"Ocorreu um erro no gateway da API ou no servi\u00e7o","headers":[],"schema":{"$ref":"#\/definitions\/ResponseError"}},"default":{"description":"Dados do pagamento alterado com sucesso.","headers":[],"schema":{"$ref":"#\/definitions\/ResponsePayment"}}},"security":[{"OAuth2":["write:payments"]}],"deprecated":false},"parameters":[]}},"securityDefinitions":{"OAuth2":{"type":"oauth2","tokenUrl":"https:\/\/api.e-unicred.com.br\/oauth\/v1\/access-token","flow":"application","scopes":{"write:consents":"cria consentimentos","read:consents":"l\u00ea consentimentos","write:payments":"cancela pagamentos","read:payments":"l\u00ea pagamentos"}}},"definitions":{"PostConsentData":{"type":"object","required":["authorisationServer","creditor","loggedUser","payment"],"properties":{"authorisationServer":{"$ref":"#\/definitions\/AuthorisationServerSimple"},"loggedUser":{"$ref":"#\/definitions\/LoggedUser"},"businessEntity":{"$ref":"#\/definitions\/BusinessEntity"},"creditor":{"$ref":"#\/definitions\/CreditorData"},"payment":{"$ref":"#\/definitions\/PaymentTemplateData"},"debtorAccount":{"$ref":"#\/definitions\/DebtorAccount"},"remittanceInformation":{"type":"string","example":"Pagamento da nota XPTO035-002.","description":"Deve ser preenchido sempre que o usu\u00e1rio pagador inserir alguma informa\u00e7\u00e3o adicional em um pagamento, a ser enviada ao recebedor.","maxLength":140,"pattern":"[\\w\\W\\s]*"},"transactionIdentification":{"type":"string","example":"E00038166201907261559y6j6","description":"Trata-se de um identificador de transa\u00e7\u00e3o que deve ser retransmitido intacto pelo PSP do pagador ao gerar a ordem de pagamento. Essa informa\u00e7\u00e3o permitir\u00e1 ao recebedor identificar e correlacionar a transfer\u00eancia, quando recebida, com a apresenta\u00e7\u00e3o das instru\u00e7\u00f5es ao pagador.\n\n[Restri\u00e7\u00e3o] Preenchimento condicional de acordo com o conte\u00fado do campo localInstument:\n\n\n- MANU - O campo transactionIdentification n\u00e3o deve ser preenchido.\n- DICT - O campo transactionIdentification n\u00e3o deve ser preenchido.\n- INIC - O campo transactionIdentification deve ser preenchido obrigatoriamente e deve conter at\u00e9 25 caracteres alfanum\u00e9ricos ([a-z|A-Z|0-9]).\n- QRES - Caso o QR Code est\u00e1tico possua o dado preenchido, o campo transactionIdentification dever\u00e1 ser preenchido com este valor, caso o QR Code n\u00e3o possua o o campo transactionIdentification n\u00e3o dever\u00e1 ser preenchido. O deve conter at\u00e9 25 caracteres alfanum\u00e9ricos ([a-z|A-Z|0-9]).\n- QRDN - Ser\u00e1 obrigat\u00f3rio seu preenchimento com o do payload JSON do QR Code din\u00e2mico. O deve conter entre 26 e 35 caracteres alfanum\u00e9ricos ([a-z|A-Z|0-9]).\n\nA detentora de conta deve validar se a condicionalidade e o formato do campo foram atendidas pela iniciadora de pagamento.","maxLength":35,"pattern":"^[a-zA-Z0-9]{1,35}$"}},"title":"PostConsentData"},"ConsentData":{"type":"object","required":["authorisationServer","consentId","creationDateTime","creditor","loggedUser","payment","status"],"properties":{"consentId":{"type":"string","example":"urn:bancoex:C1DD33123","description":"Identificador \u00fanico do consentimento criado para a inicia\u00e7\u00e3o de pagamento solicitada. Dever\u00e1 ser um URN - Uniform Resource Name. Um URN, conforme definido na RFC8141 \u00e9 um Uniform Resource Identifier - URI - que \u00e9 atribu\u00eddo sob o URI scheme \"urn\" e um namespace URN espec\u00edfico, com a inten\u00e7\u00e3o de que o URN seja um identificador de recurso persistente e independente da localiza\u00e7\u00e3o.","maxLength":256,"pattern":"^urn:[a-zA-Z0-9][a-zA-Z0-9\\-]{0,31}:[a-zA-Z0-9()+,\\-.:=@;$_!*'%\\\/?#]+$"},"authorisationServer":{"$ref":"#\/definitions\/AuthorisationServer"},"loggedUser":{"$ref":"#\/definitions\/LoggedUser"},"businessEntity":{"$ref":"#\/definitions\/BusinessEntity"},"creationDateTime":{"type":"string","format":"date-time","example":"2021-05-21T08:30:00.000Z","description":"Data e hora da cra\u00e7\u00e3o do cliente no ecossistema do OPB, conforme especifica\u00e7\u00e3o RFC-3339, formato UTC."},"payment":{"$ref":"#\/definitions\/PaymentTemplateData"},"debtorAccount":{"$ref":"#\/definitions\/DebtorAccount"},"expirationDateTime":{"type":"string","format":"date-time","example":"2021-05-21T08:30:00.000Z","description":"Data e hora em que o consentimento da inicia\u00e7\u00e3o de pagamento expira. Para consentimentos em status AWAITING_AUTHORISATION, deve ser sempre \u201ccreationDateTime + 5 minutos\u201d. Ap\u00f3s esse tempo, n\u00e3o sendo aprovado (seja a aprova\u00e7\u00e3o \u00fanica ou primeiro aprovador), o consentimento deve ir para REJECTED. Para consentimentos em status PARTIALLY_ACCEPTED, deve assumir o valor da pol\u00edtica de aprova\u00e7\u00e3o de cada institui\u00e7\u00e3o. Para consentimentos em status AUTHORISED, devem assumir o valor de \u201cstatusUpdateDateTime + 60 minutos\u201d, sendo esse o tempo m\u00e1ximo permitido para o consumo do consentimento. Caso n\u00e3o seja consumido, deve ser movido para o status REJECTED."},"status":{"type":"string","example":"AWAITING_AUTHORISATION","description":"Retorna o estado do consentimento, o qual no momento de sua cria\u00e7\u00e3o ser\u00e1 AWAITING_AUTHORISATION. Na situa\u00e7\u00e3o de m\u00faltiplas al\u00e7adas PARTIALLY_ACCEPTED, indica que consentimento precisa da confirma\u00e7\u00e3o de mais autorizadores. Este estado ser\u00e1 alterado depois da(s) autoriza\u00e7\u00e3o(\u00f5es) do(s) consentimento(s) na detentora da conta do pagador (Debtor) para AUTHORISED ou REJECTED. O consentimento fica no estado CONSUMED ap\u00f3s ocorrer a inicia\u00e7\u00e3o do pagamento referente ao consentimento. Em caso de consentimento expirado a detentora dever\u00e1 retornar o status REJECTED.","enum":["AWAITING_AUTHORISATION","AUTHORISED","REJECTED","CONSUMED","PARTIALLY_ACCEPTED"]},"creditor":{"$ref":"#\/definitions\/CreditorData"},"statusUpdateDateTime":{"type":"string","format":"date-time","example":"2021-05-21T08:30:00.000Z","description":"Data e hora em que o recurso foi atualizado. Uma string com data e hora conforme especifica\u00e7\u00e3o RFC-3339, sempre com a utiliza\u00e7\u00e3o de timezone UTC(UTC time format)."},"remittanceInformation":{"type":"string","example":"Pagamento da nota XPTO035-002.","description":"Deve ser preenchido sempre que o usu\u00e1rio pagador inserir alguma informa\u00e7\u00e3o adicional em um pagamento, a ser enviada ao recebedor.","maxLength":140,"pattern":"[\\w\\W\\s]*"},"transactionIdentification":{"type":"string","example":"E00038166201907261559y6j6","description":"Trata-se de um identificador de transa\u00e7\u00e3o que deve ser retransmitido intacto pelo PSP do pagador ao gerar a ordem de pagamento. Essa informa\u00e7\u00e3o permitir\u00e1 ao recebedor identificar e correlacionar a transfer\u00eancia, quando recebida, com a apresenta\u00e7\u00e3o das instru\u00e7\u00f5es ao pagador.\n\n[Restri\u00e7\u00e3o] Preenchimento condicional de acordo com o conte\u00fado do campo localInstument:\n\n\n- MANU - O campo transactionIdentification n\u00e3o deve ser preenchido.\n- DICT - O campo transactionIdentification n\u00e3o deve ser preenchido.\n- INIC - O campo transactionIdentification deve ser preenchido obrigatoriamente e deve conter at\u00e9 25 caracteres alfanum\u00e9ricos ([a-z|A-Z|0-9]).\n- QRES - Caso o QR Code est\u00e1tico possua o dado preenchido, o campo transactionIdentification dever\u00e1 ser preenchido com este valor, caso o QR Code n\u00e3o possua o o campo transactionIdentification n\u00e3o dever\u00e1 ser preenchido. O deve conter at\u00e9 25 caracteres alfanum\u00e9ricos ([a-z|A-Z|0-9]).\n- QRDN - Ser\u00e1 obrigat\u00f3rio seu preenchimento com o do payload JSON do QR Code din\u00e2mico. O deve conter entre 26 e 35 caracteres alfanum\u00e9ricos ([a-z|A-Z|0-9]).\n\nA detentora de conta deve validar se a condicionalidade e o formato do campo foram atendidas pela iniciadora de pagamento.","maxLength":35,"pattern":"^[a-zA-Z0-9]{1,35}$"},"redirectUri":{"type":"string","example":"https:\/\/unicred.com\/auth","description":"URL para redirecionamento da detentora de contas.","maxLength":2000,"pattern":"^(https?:\\\/\\\/)?(www\\.)?[-a-zA-Z0-9@:%._\\+~#=]{2,256}\\.[a-z]{2,6}\\b([-a-zA-Z0-9@:%_\\+.~#?&\\\/\\\/=]*)$"},"pixPaymentDetails":{"type":"array","items":{"$ref":"#\/definitions\/MinPaymentData"},"minItems":0},"rejectionReason":{"$ref":"#\/definitions\/RejectionReasonConsent"}},"title":"ConsentData"},"AuthorisationServerSimple":{"type":"object","required":["authorisationServerId","organisationId"],"properties":{"organisationId":{"type":"string","description":"Identifica de forma \u00fanica o participante principal da detentora da conta.","maxLength":36,"pattern":"^[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-4[0-9A-Fa-f]{3}-[89AB][0-9A-Fa-f]{3}-[0-9A-Fa-f]{12}$"},"authorisationServerId":{"type":"string","description":"Identifica de forma \u00fanica da marca o Authorisation Server da detentora da conta.","maxLength":36,"pattern":"^[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-4[0-9A-Fa-f]{3}-[89AB][0-9A-Fa-f]{3}-[0-9A-Fa-f]{12}$"}},"title":"AuthorisationServerSimple","description":"Dados do servidor de autoriza\u00e7\u00e3o da datentora de contas."},"AuthorisationServer":{"type":"object","required":["authorisationServerId","organisationId"],"properties":{"organisationId":{"type":"string","description":"Identifica de forma \u00fanica o participante principal da detentora da conta.","maxLength":36,"pattern":"^[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-4[0-9A-Fa-f]{3}-[89AB][0-9A-Fa-f]{3}-[0-9A-Fa-f]{12}$"},"authorisationServerId":{"type":"string","description":"Identifica de forma \u00fanica da marca o Authorisation Server da detentora da conta.","maxLength":36,"pattern":"^[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-4[0-9A-Fa-f]{3}-[89AB][0-9A-Fa-f]{3}-[0-9A-Fa-f]{12}$"},"customerFriendlyName":{"type":"string","description":"Nome da detentora da conta.","maxLength":200,"pattern":"[\\w\\W\\s]*"},"customerFriendlyDescription":{"type":"string","description":"Descri\u00e7\u00e3o da detentora da conta.","maxLength":200,"pattern":"[\\w\\W\\s]*"},"customerFriendlyLogoUri":{"type":"string","example":"https:\/\/unicred.com\/logo.svg","description":"URI do logo da detentora da conta.","maxLength":2000,"pattern":"^(https?:\\\/\\\/)?(www\\.)?[-a-zA-Z0-9@:%._\\+~#=]{2,256}\\.[a-z]{2,6}\\b([-a-zA-Z0-9@:%_\\+.~#?&\\\/\\\/=]*)$"},"termsOfServiceUri":{"type":"string","example":"https:\/\/unicred.com\/terms","description":"Link para os termos e condi\u00e7\u00f5es da detentora da conta.","maxLength":2000,"pattern":"^(https?:\\\/\\\/)?(www\\.)?[-a-zA-Z0-9@:%._\\+~#=]{2,256}\\.[a-z]{2,6}\\b([-a-zA-Z0-9@:%_\\+.~#?&\\\/\\\/=]*)$"}},"title":"AuthorisationServer","description":"Dados do servidor de autoriza\u00e7\u00e3o da datentora de contas."},"LoggedUser":{"type":"object","required":["document"],"properties":{"document":{"type":"object","properties":{"identification":{"type":"string","example":"11111111111","description":"N\u00famero do documento de identifica\u00e7\u00e3o oficial do usu\u00e1rio.","maxLength":11,"pattern":"^\\d{11}$"},"rel":{"type":"string","example":"CPF","description":"Tipo do documento de identifica\u00e7\u00e3o oficial do usu\u00e1rio.","maxLength":3,"pattern":"^[A-Z]{3}$"}},"required":["identification","rel"]}},"title":"LoggedUser","description":"Usu\u00e1rio (pessoa natural) que encontra-se logado na institui\u00e7\u00e3o Iniciadora de Pagamento."},"BusinessEntity":{"type":"object","required":["document"],"properties":{"document":{"type":"object","properties":{"identification":{"type":"string","example":"11111111111111","description":"N\u00famero do documento de identifica\u00e7\u00e3o oficial do titular pessoa jur\u00eddica.","maxLength":14,"pattern":"^\\d{14}$"},"rel":{"type":"string","example":"CNPJ","description":"Tipo do documento de identifica\u00e7\u00e3o oficial do titular pessoa jur\u00eddica.","maxLength":4,"pattern":"^[A-Z]{4}$"}},"required":["identification","rel"]}},"title":"BusinessEntity","description":"Usu\u00e1rio (pessoa jur\u00eddica) que encontra-se logado na institui\u00e7\u00e3o Iniciadora de Pagamento. [Restri\u00e7\u00e3o] Preenchimento obrigat\u00f3rio se usu\u00e1rio logado na institui\u00e7\u00e3o Iniciadora de Pagamento for um CNPJ (pessoa jur\u00eddica)."},"PaymentTemplateData":{"type":"object","required":["amount","currency","details","type"],"properties":{"type":{"type":"string","example":"PIX","description":"Este campo define o tipo de pagamento que ser\u00e1 iniciado ap\u00f3s a autoriza\u00e7\u00e3o do consentimento.","enum":["PIX"]},"schedule":{"type":"object","description":"[Restri\u00e7\u00e3o] Mutuamente excludente com o campo date. Este campo \u00e9 obrigat\u00f3rio no caso de agendamento. Neste caso, o campo date n\u00e3o dever\u00e1 ser informado. O prazo m\u00e1ximo para o consentimento dever\u00e1 ser de dois anos, contando a partir da data de cria\u00e7\u00e3o do consentimento retornada na cria\u00e7\u00e3o do mesmo (campo \/data\/creationDateTime). Agendamento de pagamento \u00fanico deve utilizar exclusivamente o objeto \"single\".","properties":{"single":{"$ref":"#\/definitions\/ScheduleSingle"},"daily":{"$ref":"#\/definitions\/ScheduleDaily"},"weekly":{"$ref":"#\/definitions\/ScheduleWeekly"},"monthly":{"$ref":"#\/definitions\/ScheduleMonthly"},"custom":{"$ref":"#\/definitions\/ScheduleCustom"}}},"date":{"type":"string","format":"date","example":"2021-01-01T00:00:00.000Z","description":"[Restri\u00e7\u00e3o] Mutuamente excludente com o objeto schedule.\nEste campo \u00e9 obrigat\u00f3rio no caso de pagamento \u00fanico.\nNeste caso, o objeto schedule n\u00e3o deve ser informado."},"currency":{"type":"string","example":"BRL","description":"C\u00f3digo da moeda nacional segundo modelo ISO-4217, ou seja, 'BRL'. Todos os valores monet\u00e1rios informados est\u00e3o representados com a moeda vigente do Brasil.","maxLength":3,"pattern":"^([A-Z]{3})$"},"amount":{"type":"string","example":"100000.12","description":"Valor da transa\u00e7\u00e3o com 2 casas decimais. O valor deve ser o mesmo enviado no consentimento.\nPara QR Code est\u00e1tico com valor pr\u00e9-determinado no QR Code ou para QR Code din\u00e2mico com indica\u00e7\u00e3o de que o valor n\u00e3o pode ser alterado: O campo amount deve ser preenchido com o valor estabelecido no QR Code. Caso seja preenchido com valor divergente do QR Code, deve ser retornado um erro HTTP Status 422.","minLength":4,"maxLength":19,"pattern":"^((\\d{1,16}\\.\\d{2}))$"},"ibgeTownCode":{"type":"string","example":"5300108","description":"O campo ibgetowncode no arranjo PIX, tem o mesmo comportamento que o campo codMun descrito no item 1.6.6 do manual do PIX, conforme segue:\nCaso a informa\u00e7\u00e3o referente ao munic\u00edpio n\u00e3o seja enviada; o PSP do recebedor assumir\u00e1 que n\u00e3o existem feriados estaduais e municipais no per\u00edodo em quest\u00e3o;","minLength":7,"maxLength":7,"pattern":"^\\d{7}$"},"details":{"$ref":"#\/definitions\/PaymentDetailsData"}},"title":"PaymentTemplateData","description":"Informa\u00e7\u00f5es sobre a transa\u00e7\u00e3o no contexto deste consentimento."},"PaymentDetailsData":{"type":"object","required":["creditorAccount","localInstrument"],"properties":{"localInstrument":{"type":"string","example":"DICT","description":"Especifica a forma de inicia\u00e7\u00e3o do pagamento:\n\n\nMANU - Inser\u00e7\u00e3o manual de dados da conta transacional\nDICT - Inser\u00e7\u00e3o manual de chave Pix\nQRDN - QR code din\u00e2mico\nQRES - QR code est\u00e1tico\nINIC - Indica que o recebedor (creditor) contratou o Iniciador de Pagamentos especificamente para realizar inicia\u00e7\u00f5es de pagamento em que o benefici\u00e1rio \u00e9 previamente conhecido.\n\n\n[Restri\u00e7\u00e3o] Se \/data\/payment\/schedule enviado com valor diferente de single durante a cria\u00e7\u00e3o do consentimento, apenas os m\u00e9todos MANU, DICT ou QRES s\u00e3o permitidos.","enum":["MANU","DICT","QRDN","QRES","INIC"]},"qrCode":{"type":"string","example":"00020104141234567890123426660014BR.GOV.BCB.PIX014466756C616E6F32303139406578616D706C652E636F6D27300012 BR.COM.OUTRO011001234567895204000053039865406123.455802BR5915NOMEDORECEBEDOR6008BRASILIA61087007490062 530515RP12345678-201950300017BR.GOV.BCB.BRCODE01051.0.080450014BR.GOV.BCB.PIX0123PADRAO.URL.PIX\/0123AB CD81390012BR.COM.OUTRO01190123.ABCD.3456.WXYZ6304EB76","description":"Sequ\u00eancia de caracteres que corresponde ao QR Code disponibilizado para o pagador. \u00c9 a sequ\u00eancia de caracteres que seria lida pelo leitor de QR Code, e deve propiciar o retorno dos dados do pagador ap\u00f3s consulta na DICT. Essa funcionalidade \u00e9 poss\u00edvel tanto para QR Code est\u00e1tico quanto para QR Code din\u00e2mico. No arranjo do Pix esta \u00e9 a mesma sequ\u00eancia gerada e\/ou lida pela funcionalidade Pix Copia e Cola. Este campo dever\u00e1 ser no formato UTF-8. [Restri\u00e7\u00e3o] Preenchimento obrigat\u00f3rio para pagamentos por QR Code, observado o tamanho m\u00e1ximo de 512 bytes.","maxLength":512,"pattern":"[\\w\\W\\s]*"},"proxy":{"type":"string","example":"12345678901","description":"Chave cadastrada no DICT pertencente ao recebedor. Os tipos de chaves podem ser: telefone, e-mail, cpf\/cnpj ou chave aleat\u00f3ria. No caso de telefone celular deve ser informado no padr\u00e3o E.1641. Para e-mail deve ter o formato xxxxxxxx@xxxxxxx.xxx(.xx) e no m\u00e1ximo 77 caracteres. No caso de CPF dever\u00e1 ser informado com 11 n\u00fameros, sem pontos ou tra\u00e7os. Para o caso de CNPJ dever\u00e1 ser informado com 14 n\u00fameros, sem pontos ou tra\u00e7os. No caso de chave aleat\u00f3ria deve ser informado o UUID gerado pelo DICT, conforme formato especificado na RFC41223. Se informado, a detentora da conta deve validar o proxy no DICT quando localInstrument for igual a DICT, QRDN ou QRES e validar o campo creditorAccount. Esta valida\u00e7\u00e3o \u00e9 opcional caso o localInstrument for igual a INIC. [Restri\u00e7\u00e3o] Se localInstrument for igual a MANU, o campo proxy n\u00e3o deve ser preenchido. Se localInstrument for igual INIC, DICT, QRDN ou QRES, o campo proxy deve ser sempre preenchido com a chave Pix.","maxLength":77,"pattern":"[\\w\\W\\s]*"},"creditorAccount":{"$ref":"#\/definitions\/CreditorAccount"}},"title":"PaymentDetailsData","description":"Objeto contendo os detalhes do pagamento."},"CreditorAccount":{"type":"object","required":["accountType","ispb","number"],"properties":{"ispb":{"type":"string","example":"12345678","description":"Deve ser preenchido com o ISPB (Identificador do Sistema de Pagamentos Brasileiros) do participante do SPI (Sistema de pagamentos instant\u00e2neos) somente com n\u00fameros.","minLength":8,"maxLength":8,"pattern":"^[0-9]{8}$"},"issuer":{"type":"string","example":"1774","description":"C\u00f3digo da Ag\u00eancia emissora da conta sem d\u00edgito. (Ag\u00eancia \u00e9 a depend\u00eancia destinada ao atendimento aos clientes, ao p\u00fablico em geral e aos associados de cooperativas de cr\u00e9dito, no exerc\u00edcio de atividades da institui\u00e7\u00e3o, n\u00e3o podendo ser m\u00f3vel ou transit\u00f3ria).\n\n[Restri\u00e7\u00e3o] Preenchimento obrigat\u00f3rio para os seguintes tipos de conta: CACC (CONTA_DEPOSITO_A_VISTA) e SVGS (CONTA_POUPANCA).","minLength":1,"maxLength":4,"pattern":"^[0-9]{1,4}$"},"number":{"type":"string","example":"1234567890","description":"Deve ser preenchido com o n\u00famero da conta do usu\u00e1rio recebedor, com d\u00edgito verificador (se este existir), se houver valor alfanum\u00e9rico, este deve ser convertido para 0.","minLength":1,"maxLength":20,"pattern":"^[0-9]{1,20}$"},"accountType":{"type":"string","example":"CACC","description":"Tipos de contas usadas para pagamento. Modalidades tradicionais previstas pela Resolu\u00e7\u00e3o 4.753, n\u00e3o contemplando contas vinculadas, conta de domiciliados no exterior, contas em moedas estrangeiras e conta correspondente moeda eletr\u00f4nica. Segue descri\u00e7\u00e3o de cada valor do ENUM.\n\n\nCACC - Current - Conta Corrente.\nSVGS - Savings - Conta de Poupan\u00e7a.\nTRAN - TransactingAccount - Conta de Pagamento pr\u00e9-paga.","enum":["CACC","SVGS","TRAN"]}},"title":"CreditorAccount","description":"Objeto que cont\u00e9m a identifica\u00e7\u00e3o da conta de destino do benefici\u00e1rio\/recebedor."},"ScheduleSingle":{"type":"object","properties":{"date":{"type":"string","format":"date","example":"2023-08-23T00:00:00.000Z","description":"Define a data alvo da liquida\u00e7\u00e3o do pagamento. O fuso hor\u00e1rio de Bras\u00edlia deve ser utilizado para cria\u00e7\u00e3o e racionaliza\u00e7\u00e3o sobre os dados deste campo.\n\n[Restri\u00e7\u00e3o] Esse campo dever\u00e1 sempre ser no m\u00ednimo D+1 corrido, ou seja, a data imediatamente posterior em rela\u00e7\u00e3o a data do consentimento considerando o fuso hor\u00e1rio de Bras\u00edlia e dever\u00e1 ser no m\u00e1ximo D+730 corridos a partir da data do consentimento, tamb\u00e9m considerando o fuso hor\u00e1rio de Bras\u00edlia."}},"title":"ScheduleSingle","description":"Define a pol\u00edtica de agendamento \u00fanico."},"ScheduleDaily":{"type":"object","required":["quantity","startDate"],"properties":{"startDate":{"type":"string","format":"date","example":"2023-08-23T00:00:00.000Z","description":"Define o in\u00edcio da vig\u00eancia da recorr\u00eancia."},"quantity":{"type":"integer","format":"int32","example":3,"description":"Define a quantidade de pagamentos que ser\u00e3o enviados para liquida\u00e7\u00e3o.","minimum":2,"maximum":60}},"title":"ScheduleDaily"},"ScheduleWeekly":{"type":"object","required":["dayOfWeek","quantity","startDate"],"properties":{"dayOfWeek":{"type":"string","example":"QUINTA_FEIRA","description":"Define o dia da semana planejado para a ocorr\u00eancia das liquida\u00e7\u00f5es.","enum":["SEGUNDA_FEIRA","TERCA_FEIRA","QUARTA_FEIRA","QUINTA_FEIRA","SEXTA_FEIRA","SABADO","DOMINGO"]},"startDate":{"type":"string","format":"date","example":"2023-08-23T00:00:00.000Z","description":"Define o in\u00edcio da vig\u00eancia da recorr\u00eancia."},"quantity":{"type":"integer","format":"int32","example":10,"description":"Define a quantidade de pagamentos que ser\u00e3o enviados para liquida\u00e7\u00e3o.","minimum":2,"maximum":60}},"title":"ScheduleWeekly"},"ScheduleMonthly":{"type":"object","required":["dayOfMonth","quantity","startDate"],"properties":{"dayOfMonth":{"type":"integer","format":"int32","example":10,"description":"Define o dia do m\u00eas planejado para a ocorr\u00eancia das liquida\u00e7\u00f5es.","minimum":1,"maximum":31},"startDate":{"type":"string","format":"date","example":"2023-08-23T00:00:00.000Z","description":"Define o in\u00edcio da vig\u00eancia da recorr\u00eancia."},"quantity":{"type":"integer","format":"int32","example":24,"description":"Define a quantidade de pagamentos que ser\u00e3o enviados para liquida\u00e7\u00e3o.","minimum":2,"maximum":24}},"title":"ScheduleMonthly"},"ScheduleCustom":{"type":"object","required":["additionalInformation","dates"],"properties":{"dates":{"type":"array","example":["2023-08-23","2023-09-26"],"description":"Define os dias em que est\u00e3o planejadas as ocorr\u00eancias das liquida\u00e7\u00f5es.","items":{"type":"string","format":"date"},"maxItems":60,"minItems":2},"additionalInformation":{"type":"string","example":"Todas quintas e domingos por 6 meses","description":"Texto livre para Iniciador preencher de forma compreens\u00edvel pelo usu\u00e1rio aprovador\/pagador. O texto pode ser utilizado pelo detentor para exibi\u00e7\u00e3o do resumo da transa\u00e7\u00e3o durante aprova\u00e7\u00e3o do usu\u00e1rio aprovador\/pagador.","maxLength":255,"pattern":"[\\w\\W\\s]*"}},"title":"ScheduleCustom","description":"[Restri\u00e7\u00e3o] As datas enviadas na lista de datas (array \u201cdates\u201d) n\u00e3o podem ser repetidas. Caso datas repetidas sejam enviadas, o detentor deve rejeitar a cria\u00e7\u00e3o do consentimento, informando o erro PARAMETRO_INVALIDO."},"DebtorAccount":{"type":"object","required":["accountType","ispb","number"],"properties":{"ispb":{"type":"string","example":"12345678","description":"Deve ser preenchido com o ISPB (Identificador do Sistema de Pagamentos Brasileiros) do participante do SPI (Sistema de pagamentos instant\u00e2neos) somente com n\u00fameros.","minLength":8,"maxLength":8,"pattern":"^[0-9]{8}$"},"issuer":{"type":"string","example":"1774","description":"C\u00f3digo da Ag\u00eancia emissora da conta sem d\u00edgito. (Ag\u00eancia \u00e9 a depend\u00eancia destinada ao atendimento aos clientes, ao p\u00fablico em geral e aos associados de cooperativas de cr\u00e9dito, no exerc\u00edcio de atividades da institui\u00e7\u00e3o, n\u00e3o podendo ser m\u00f3vel ou transit\u00f3ria).\n\n[Restri\u00e7\u00e3o] Preenchimento obrigat\u00f3rio para os seguintes tipos de conta: CACC (CONTA_DEPOSITO_A_VISTA) e SVGS (CONTA_POUPANCA).","minLength":1,"maxLength":4,"pattern":"^[0-9]{1,4}$"},"number":{"type":"string","example":"1234567890","description":"Deve ser preenchido com o n\u00famero da conta transacional do usu\u00e1rio pagador, com d\u00edgito verificador (se este existir), se houver valor alfanum\u00e9rico, este deve ser convertido para 0.","minLength":1,"maxLength":20,"pattern":"^[0-9]{1,20}$"},"accountType":{"type":"string","example":"CACC","description":"Tipos de contas usadas para pagamento. Modalidades tradicionais previstas pela Resolu\u00e7\u00e3o 4.753, n\u00e3o contemplando contas vinculadas, conta de domiciliados no exterior, contas em moedas estrangeiras e conta correspondente moeda eletr\u00f4nica. Segue descri\u00e7\u00e3o de cada valor do ENUM.\n\n\nCACC - Current - Conta Corrente.\nSVGS - Savings - Conta de Poupan\u00e7a.\nTRAN - TransactingAccount - Conta de Pagamento pr\u00e9-paga.","enum":["CACC","SVGS","TRAN"]}},"title":"DebtorAccount","description":"Objeto que cont\u00e9m a identifica\u00e7\u00e3o da conta de origem do pagador. As informa\u00e7\u00f5es quanto \u00e0 conta de origem do pagador poder\u00e3o ser trazidas no consentimento para a detentora, caso a iniciadora tenha coletado essas informa\u00e7\u00f5es do cliente. No caso em que o cliente n\u00e3o preenche os dados na iniciadora, a detentora dever\u00e1 persistir as informa\u00e7\u00f5es da conta selecionada seguindo as condi\u00e7\u00f5es abaixo."},"CreditorData":{"type":"object","required":["cpfCnpj","name","personType"],"properties":{"personType":{"type":"string","description":"Titular, pessoa natural ou juridica a quem se referem os dados de recebedor (creditor).","enum":["PESSOA_NATURAL","PESSOA_JURIDICA"]},"cpfCnpj":{"type":"string","example":"58764789000137","description":"Identifica\u00e7\u00e3o da pessoa envolvida na transa\u00e7\u00e3o.\nPreencher com o CPF ou CNPJ, de acordo com o valor escolhido no campo type.\nO CPF ser\u00e1 utilizado com 11 n\u00fameros e dever\u00e1 ser informado sem pontos ou tra\u00e7os.\nO CNPJ ser\u00e1 utilizado com 14 n\u00fameros e dever\u00e1 ser informado sem pontos ou tra\u00e7os.","minLength":11,"maxLength":14,"pattern":"^\\d{11}$|^\\d{14}$"},"name":{"type":"string","example":"Marco Antonio de Brito","description":"Em caso de pessoa natural deve ser informado o nome completo do titular da conta do recebedor.\nEm caso de pessoa jur\u00eddica deve ser informada a raz\u00e3o social ou o nome fantasia da conta do recebedor.","maxLength":120,"pattern":"^([A-Za-z\u00c0-\u00d6\u00d8-\u00f6\u00f8-\u00ff,.@:&*+_<>()!?\/\\\\$%\\d'\\w\\s-]+)$"}},"title":"CreditorData","description":"Objeto contendo os dados do recebedor (creditor)."},"PaymentData":{"type":"object","required":["cnpjInitiator","consentId","creationDateTime","creditorAccount","debtorAccount","endToEndId","localInstrument","payment","paymentId","status","statusUpdateDateTime"],"properties":{"consentId":{"type":"string","example":"urn:bancoex:C1DD33123","description":"Identificador \u00fanico do consentimento criado para a inicia\u00e7\u00e3o de pagamento solicitada. Dever\u00e1 ser um URN - Uniform Resource Name. Um URN, conforme definido na RFC8141 \u00e9 um Uniform Resource Identifier - URI - que \u00e9 atribu\u00eddo sob o URI scheme \"urn\" e um namespace URN espec\u00edfico, com a inten\u00e7\u00e3o de que o URN seja um identificador de recurso persistente e independente da localiza\u00e7\u00e3o.","maxLength":256,"pattern":"^urn:[a-zA-Z0-9][a-zA-Z0-9\\-]{0,31}:[a-zA-Z0-9()+,\\-.:=@;$_!*'%\\\/?#]+$"},"paymentId":{"type":"string","example":"TXpRMU9UQTROMWhZV2xSU1FUazJSMDl","description":"C\u00f3digo ou identificador \u00fanico informado pela institui\u00e7\u00e3o detentora da conta para representar a inicia\u00e7\u00e3o de pagamento individual. O paymentId deve ser diferente do endToEndId. Este \u00e9 o identificador que dever\u00e1 ser utilizado na consulta ao status da inicia\u00e7\u00e3o de pagamento efetuada.","minLength":1,"maxLength":100,"pattern":"^[a-zA-Z0-9][a-zA-Z0-9\\-]{0,99}$"},"endToEndId":{"type":"string","example":"E9040088820210128000800123873170","description":"Trata-se de um identificador \u00fanico, gerado na institui\u00e7\u00e3o iniciadora de pagamento e recebido na institui\u00e7\u00e3o detentora de conta, permeando toda a jornada do pagamento Pix.\n\n[Restri\u00e7\u00e3o] A detentora deve obrigatoriamente retornar o campo Com o mesmo valor recebido da iniciadora.","minLength":32,"maxLength":32,"pattern":"^([E])([0-9]{8})([0-9]{4})(0[1-9]|1[0-2])(0[1-9]|[1-2][0-9]|3[0-1])(2[0-3]|[01][0-9])([0-5][0-9])([a-zA-Z0-9]{11})$"},"creationDateTime":{"type":"string","format":"date-time","example":"2021-05-21T08:30:00.000Z","description":"Data e hora da cra\u00e7\u00e3o do cliente no ecossistema do OPB, conforme especifica\u00e7\u00e3o RFC-3339, formato UTC."},"statusUpdateDateTime":{"type":"string","format":"date-time","example":"2021-05-21T08:30:00.000Z","description":"Data e hora em que o recurso foi atualizado. Uma string com data e hora conforme especifica\u00e7\u00e3o RFC-3339, sempre com a utiliza\u00e7\u00e3o de timezone UTC(UTC time format)."},"payment":{"type":"object","description":"Objeto contendo dados do pagameto como moeda e valor.","properties":{"currency":{"type":"string","example":"BRL","description":"C\u00f3digo da moeda nacional segundo modelo ISO-4217, ou seja, 'BRL'. Todos os valores monet\u00e1rios informados est\u00e3o representados com a moeda vigente do Brasil.","maxLength":3,"pattern":"^([A-Z]{3})$"},"amount":{"type":"string","example":"100000.12","description":"Valor da transa\u00e7\u00e3o com 2 casas decimais. O valor deve ser o mesmo enviado no consentimento.\nPara QR Code est\u00e1tico com valor pr\u00e9-determinado no QR Code ou para QR Code din\u00e2mico com indica\u00e7\u00e3o de que o valor n\u00e3o pode ser alterado: O campo amount deve ser preenchido com o valor estabelecido no QR Code. Caso seja preenchido com valor divergente do QR Code, deve ser retornado um erro HTTP Status 422.","minLength":4,"maxLength":19,"pattern":"^((\\d{1,16}\\.\\d{2}))$"}},"required":["amount","currency"]},"status":{"type":"string","example":"PDNG","description":"Estado atual da inicia\u00e7\u00e3o de pagamento. O estado evolui na seguinte ordem:\n\n\nRCVD (Received) - Indica que a requisi\u00e7\u00e3o de pagamento foi recebida com sucesso pela detentora, mas ainda h\u00e1 valida\u00e7\u00f5es a serem feitas antes de ser submetida para liquida\u00e7\u00e3o.\nCANC (Cancelled) - Indica que a transa\u00e7\u00e3o Pix pendente foi cancelada com sucesso pelo usu\u00e1rio antes que fosse confirmada (ACCP) ou rejeitada (RJCT) pela detentora.\nACCP( Accepted Customer Profile) - Indica que todas as verifica\u00e7\u00f5es necess\u00e1rias j\u00e1 foram realizadas pela detentora e que a transa\u00e7\u00e3o est\u00e1 pronta para ser enviada para liquida\u00e7\u00e3o (no SPI se for Pix para outra institui\u00e7\u00e3o ou internamente se for para outra conta na mesma institui\u00e7\u00e3o).\nACPD (Accepted Clearing Processed) - Indica que a detentora j\u00e1 submeteu a transa\u00e7\u00e3o para liquida\u00e7\u00e3o, mas ainda n\u00e3o tem a confirma\u00e7\u00e3o se foi liquidada ou rejeitada.\nRJCT (Rejected) Indica que a transa\u00e7\u00e3o foi rejeitada pela detentora ou pelo SPI.\nACSC (Accepted Settlement Completed Debitor Account) - Indica que a transa\u00e7\u00e3o foi efetivada pela detentora ou pelo SPI.\nPDNG (Pending) - Indica que a detentora reteve temporariamente a transa\u00e7\u00e3o Pix para an\u00e1lise.\nSCHD (Scheduled) - Indica que a transa\u00e7\u00e3o Pix foi agendada com sucesso na detentora.\n\n\nEm caso insucesso:\nRJCT (REJECTED) - Instru\u00e7\u00e3o de pagamento rejeitada.","enum":["RCVD","CANC","ACCP","ACPD","RJCT","ACSC","PDNG","SCHD"]},"debtorAccount":{"$ref":"#\/definitions\/DebtorAccount"},"creditorAccount":{"$ref":"#\/definitions\/CreditorAccount"},"cancellation":{"$ref":"#\/definitions\/CancellationData"},"localInstrument":{"type":"string","example":"DICT","description":"Especifica a forma de inicia\u00e7\u00e3o do pagamento:\n\n\nMANU - Inser\u00e7\u00e3o manual de dados da conta transacional\nDICT - Inser\u00e7\u00e3o manual de chave Pix\nQRDN - QR code din\u00e2mico\nQRES - QR code est\u00e1tico\nINIC - Indica que o recebedor (creditor) contratou o Iniciador de Pagamentos especificamente para realizar inicia\u00e7\u00f5es de pagamento em que o benefici\u00e1rio \u00e9 previamente conhecido.\n\n\n[Restri\u00e7\u00e3o] Se \/data\/payment\/schedule enviado com valor diferente de single durante a cria\u00e7\u00e3o do consentimento, apenas os m\u00e9todos MANU, DICT ou QRES s\u00e3o permitidos.","enum":["MANU","DICT","QRDN","QRES","INIC"]},"proxy":{"type":"string","example":"12345678901","description":"Chave cadastrada no DICT pertencente ao recebedor. Os tipos de chaves podem ser: telefone, e-mail, cpf\/cnpj ou chave aleat\u00f3ria. No caso de telefone celular deve ser informado no padr\u00e3o E.1641. Para e-mail deve ter o formato xxxxxxxx@xxxxxxx.xxx(.xx) e no m\u00e1ximo 77 caracteres. No caso de CPF dever\u00e1 ser informado com 11 n\u00fameros, sem pontos ou tra\u00e7os. Para o caso de CNPJ dever\u00e1 ser informado com 14 n\u00fameros, sem pontos ou tra\u00e7os. No caso de chave aleat\u00f3ria deve ser informado o UUID gerado pelo DICT, conforme formato especificado na RFC41223. Se informado, a detentora da conta deve validar o proxy no DICT quando localInstrument for igual a DICT, QRDN ou QRES e validar o campo creditorAccount. Esta valida\u00e7\u00e3o \u00e9 opcional caso o localInstrument for igual a INIC. [Restri\u00e7\u00e3o] Se localInstrument for igual a MANU, o campo proxy n\u00e3o deve ser preenchido. Se localInstrument for igual INIC, DICT, QRDN ou QRES, o campo proxy deve ser sempre preenchido com a chave Pix.","maxLength":77,"pattern":"[\\w\\W\\s]*"},"remittanceInformation":{"type":"string","example":"Pagamento da nota XPTO035-002.","description":"Deve ser preenchido sempre que o usu\u00e1rio pagador inserir alguma informa\u00e7\u00e3o adicional em um pagamento, a ser enviada ao recebedor.","maxLength":140,"pattern":"[\\w\\W\\s]*"},"rejectionReason":{"$ref":"#\/definitions\/RejectionReasonPayment"},"ibgeTownCode":{"type":"string","example":"5300108","description":"O campo ibgetowncode no arranjo PIX, tem o mesmo comportamento que o campo codMun descrito no item 1.6.6 do manual do PIX, conforme segue:\nCaso a informa\u00e7\u00e3o referente ao munic\u00edpio n\u00e3o seja enviada; o PSP do recebedor assumir\u00e1 que n\u00e3o existem feriados estaduais e municipais no per\u00edodo em quest\u00e3o;","minLength":7,"maxLength":7,"pattern":"^\\d{7}$"},"cnpjInitiator":{"type":"string","example":"50685362000135","description":"CNPJ do Iniciador de Pagamento devidamente habilitado para a presta\u00e7\u00e3o de Servi\u00e7o de Inicia\u00e7\u00e3o no Pix.","maxLength":14,"pattern":"^\\d{14}$"},"transactionIdentification":{"type":"string","example":"E00038166201907261559y6j6","description":"Trata-se de um identificador de transa\u00e7\u00e3o que deve ser retransmitido intacto pelo PSP do pagador ao gerar a ordem de pagamento. Essa informa\u00e7\u00e3o permitir\u00e1 ao recebedor identificar e correlacionar a transfer\u00eancia, quando recebida, com a apresenta\u00e7\u00e3o das instru\u00e7\u00f5es ao pagador.\n\n[Restri\u00e7\u00e3o] Preenchimento condicional de acordo com o conte\u00fado do campo localInstument:\n\n\n- MANU - O campo transactionIdentification n\u00e3o deve ser preenchido.\n- DICT - O campo transactionIdentification n\u00e3o deve ser preenchido.\n- INIC - O campo transactionIdentification deve ser preenchido obrigatoriamente e deve conter at\u00e9 25 caracteres alfanum\u00e9ricos ([a-z|A-Z|0-9]).\n- QRES - Caso o QR Code est\u00e1tico possua o dado preenchido, o campo transactionIdentification dever\u00e1 ser preenchido com este valor, caso o QR Code n\u00e3o possua o o campo transactionIdentification n\u00e3o dever\u00e1 ser preenchido. O deve conter at\u00e9 25 caracteres alfanum\u00e9ricos ([a-z|A-Z|0-9]).\n- QRDN - Ser\u00e1 obrigat\u00f3rio seu preenchimento com o do payload JSON do QR Code din\u00e2mico. O deve conter entre 26 e 35 caracteres alfanum\u00e9ricos ([a-z|A-Z|0-9]).\n\nA detentora de conta deve validar se a condicionalidade e o formato do campo foram atendidas pela iniciadora de pagamento.","maxLength":35,"pattern":"^[a-zA-Z0-9]{1,35}$"}},"title":"PaymentData","description":"Objeto contendo dados do pagamento e da conta do recebedor (creditor)."},"CancellationData":{"type":"object","required":["cancelledAt","cancelledBy","cancelledFrom","reason"],"properties":{"reason":{"type":"string","example":"CANCELADO_PENDENCIA","description":"O preenchimento desse campo para retorno, deve ocorrer pela detentora de contas a partir do status em que o pagamento estiver no momento da solicita\u00e7\u00e3o do cancelamento (ex. Status de pagamento = PDNG, campo deve ser preenchido com enum CANCELADO_PENDENCIA)\n\nValores poss\u00edveis:\nCANCELADO_PENDENCIA - Pagamento cancelado enquanto estava na situa\u00e7\u00e3o PDNG\nCANCELADO_AGENDAMENTO - Pagamento cancelado enquanto estava na situa\u00e7\u00e3o SCHD\nCANCELADO_MULTIPLAS_ALCADAS - Pagamento cancelado enquanto estava na situa\u00e7\u00e3o PATC","enum":["CANCELADO_PENDENCIA","CANCELADO_AGENDAMENTO","CANCELADO_MULTIPLAS_ALCADAS"]},"cancelledFrom":{"type":"string","example":"INICIADORA","description":"Campo utilizado para informar o meio pelo qual foi realizado o cancelamento.\n\nValores poss\u00edveis:\nINICIADORA - Pagamento cancelado pelo usu\u00e1rio pagador nos canais da iniciadora\nDETENTORA - Pagamento cancelado pelo usu\u00e1rio pagador nos canais da detentora","enum":["INICIADORA","DETENTORA"]},"cancelledAt":{"type":"string","format":"date-time","example":"2021-05-21T08:30:00.000Z","description":"Data e hora que foi realizado o cancelamento, conforme especifica\u00e7\u00e3o RFC-3339, formato UTC."},"cancelledBy":{"$ref":"#\/definitions\/CancelledBy"}},"title":"CancellationData","description":"Objeto que cont\u00e9m os dados referentes ao usu\u00e1rio pagador que solicitou o cancelamento, o canal utilizado por ele e o motivo.\n[Restri\u00e7\u00e3o] O objeto cancellation ser\u00e1 obrigat\u00f3rio apenas quando o valor do campo status for igual a CANC."},"CancelledBy":{"type":"object","required":["document"],"properties":{"document":{"type":"object","description":"Objeto que consolida os dados do documento do usu\u00e1rio que solicitou o cancelamento.","properties":{"identification":{"type":"string","example":"11111111111","description":"N\u00famero do documento do usu\u00e1rio pagador respons\u00e1vel pelo cancelamento do pagamento.","maxLength":11,"pattern":"^\\d{11}$"},"rel":{"type":"string","example":"CPF","description":"Tipo do documento do usu\u00e1rio pagador respons\u00e1vel pelo cancelamento do pagamento.","maxLength":3,"pattern":"^[A-Z]{3}$"}},"required":["identification","rel"]}},"title":"CancelledBy","description":"Informa\u00e7\u00e3o relacionada ao usu\u00e1rio pagador que solicitou o cancelamento do pagamento."},"RejectionReasonPayment":{"type":"object","required":["code","detail"],"properties":{"code":{"type":"string","example":"SALDO_INSUFICIENTE","description":"Define o c\u00f3digo da raz\u00e3o pela qual o pagamento foi rejeitado\n\n- SALDO_INSUFICIENTE - A conta selecionada n\u00e3o possui saldo suficiente para realizar o pagamento.\n- VALOR_ACIMA_LIMITE - O valor ultrapassa o limite estabelecido [na institui\u00e7\u00e3o\/no arranjo\/outro] para permitir a realiza\u00e7\u00e3o de transa\u00e7\u00f5es pelo cliente.\n- VALOR_INVALIDO - O valor enviado n\u00e3o \u00e9 v\u00e1lido para o QR Code informado.\n- COBRANCA_INVALIDA - Valida\u00e7\u00e3o de expira\u00e7\u00e3o, valida\u00e7\u00e3o de vencimento ou Status V\u00e1lido.\n- NAO_INFORMADO - N\u00e3o reportado\/identificado pela institui\u00e7\u00e3o detentora de conta.\n- PAGAMENTO_DIVERGENTE_CONSENTIMENTO - Dados do pagamento divergentes dos dados do consentimento.\n- DETALHE_PAGAMENTO_INVALIDO - Par\u00e2metro [nome_campo] n\u00e3o obedecer \u00e0s regras de neg\u00f3cio.\n- PAGAMENTO_RECUSADO_DETENTORA - [Descri\u00e7\u00e3o do motivo de recusa].\n- PAGAMENTO_RECUSADO_SPI - [C\u00f3digo de erro conforme tabela de dom\u00ednios reason PACS.002].\n- FALHA_INFRAESTRUTURA - [Descri\u00e7\u00e3o de qual falha na infraestrutura inviabilizou o processamento].\n- FALHA_INFRAESTRUTURA_SPI - Indica uma falha no Sistema de Pagamentos Instant\u00e2neos (SPI).\n- FALHA_INFRAESTRUTURA_DICT - Indica uma falha no Diret\u00f3rio de Identificadores de Contas Transacionais (DICT).\n- FALHA_INFRAESTRUTURA_ICP - Indica uma falha na Infraestrutura de Chaves P\u00fablicas (ICP).\n- FALHA_INFRAESTRUTURA_PSP_RECEBEDOR - Indica uma falha na infraestrutura do Prestador de Servi\u00e7o de Pagamento (PSP) que recebe o pagamento.\n- FALHA_INFRAESTRUTURA_DETENTORA - indica uma falha na infraestrutura da institui\u00e7\u00e3o detentora das informa\u00e7\u00f5es ou recursos.\n- CONTAS_ORIGEM_DESTINO_IGUAIS - Indica uma tentativa de pagamento onde a conta origem e a conta de destino s\u00e3o iguais.\n- FALHA_AGENDAMENTO_PAGAMENTOS - Falha ao agendar pagamentos.\n\nO rejectionReason FALHA_INFRAESTRUTURA n\u00e3o ser\u00e1 exclu\u00eddo, apenas deixar\u00e1 de ser utilizado, permitindo assim, retrocompatibilidade e integridade entre os participantes.","enum":["SALDO_INSUFICIENTE","VALOR_ACIMA_LIMITE","VALOR_INVALIDO","COBRANCA_INVALIDA","NAO_INFORMADO","PAGAMENTO_DIVERGENTE_CONSENTIMENTO","DETALHE_PAGAMENTO_INVALIDO","PAGAMENTO_RECUSADO_DETENTORA","PAGAMENTO_RECUSADO_SPI","FALHA_INFRAESTRUTURA","FALHA_INFRAESTRUTURA_SPI","FALHA_INFRAESTRUTURA_DICT","FALHA_INFRAESTRUTURA_ICP","FALHA_INFRAESTRUTURA_PSP_RECEBEDOR","FALHA_INFRAESTRUTURA_DETENTORA","CONTAS_ORIGEM_DESTINO_IGUAIS","FALHA_AGENDAMENTO_PAGAMENTOS"]},"detail":{"type":"string","description":"Cont\u00e9m informa\u00e7\u00f5es adicionais ao pagamento rejeitado","maxLength":2048,"pattern":"[\\w\\W\\s]*"}},"title":"RejectionReasonPayment","description":"Motivo da rejei\u00e7\u00e3o do pagamento. Informa\u00e7\u00f5es complementares sobre o motivo do status [Restri\u00e7\u00e3o] Esse motivo dever\u00e1 ser enviado quando o campo \/data\/status for igual a RJCT (REJECTED)."},"RejectionReasonConsent":{"type":"object","required":["code","detail"],"properties":{"code":{"type":"string","example":"SALDO_INSUFICIENTE","description":"Define o c\u00f3digo da raz\u00e3o pela qual o consentimento foi rejeitado\n\n- VALOR_INVALIDO\n- NAO_INFORMADO\n- FALHA_INFRAESTRUTURA\n- TEMPO_EXPIRADO_AUTORIZACAO\n- TEMPO_EXPIRADO_CONSUMO\n- REJEITADO_USUARIO\n- CONTAS_ORIGEM_DESTINO_IGUAIS\n- CONTA_NAO_PERMITE_PAGAMENTO\n- SALDO_INSUFICIENTE\n- VALOR_ACIMA_LIMITE\n- QRCODE_INVALIDO","enum":["VALOR_INVALIDO","NAO_INFORMADO","FALHA_INFRAESTRUTURA","TEMPO_EXPIRADO_AUTORIZACAO","TEMPO_EXPIRADO_CONSUMO","REJEITADO_USUARIO","CONTAS_ORIGEM_DESTINO_IGUAIS","CONTA_NAO_PERMITE_PAGAMENTO","SALDO_INSUFICIENTE","VALOR_ACIMA_LIMITE","QRCODE_INVALIDO"]},"detail":{"type":"string","example":"O usu\u00e1rio rejeitou a autoriza\u00e7\u00e3o do consentimento","description":"Cont\u00e9m informa\u00e7\u00f5es adicionais ao consentimento rejeitado.\n\n- VALOR_INVALIDO: O valor enviado n\u00e3o \u00e9 v\u00e1lido para o QR Code informado;\n- NAO_INFORMADO: N\u00e3o informada pela detentora de conta;\n- FALHA_INFRAESTRUTURA: [Descri\u00e7\u00e3o de qual falha na infraestrutura inviabilizou o processamento].\n- TEMPO_EXPIRADO_AUTORIZACAO: Consentimento expirou antes que o usu\u00e1rio pudesse confirm\u00e1-lo.\n- TEMPO_EXPIRADO_CONSUMO: O usu\u00e1rio n\u00e3o finalizou o fluxo de pagamento e o consentimento expirou;\n- REJEITADO_USUARIO: O usu\u00e1rio rejeitou a autoriza\u00e7\u00e3o do consentimento\n- CONTAS_ORIGEM_DESTINO_IGUAIS: A conta selecionada \u00e9 igual \u00e0 conta destino e n\u00e3o permite realizar esse pagamento.\n- CONTA_NAO_PERMITE_PAGAMENTO: A conta selecionada \u00e9 do tipo [salario\/investimento\/liquida\u00e7\u00e3o\/outros] e n\u00e3o permite realizar esse pagamento.\n- SALDO_INSUFICIENTE: A conta selecionada n\u00e3o possui saldo suficiente para realizar o pagamento.\n- VALOR_ACIMA_LIMITE: O valor ultrapassa o limite estabelecido [na institui\u00e7\u00e3o\/no arranjo\/outro] para permitir a realiza\u00e7\u00e3o de transa\u00e7\u00f5es pelo cliente.\n- QRCODE_INVALIDO: O QRCode utilizado para a inicia\u00e7\u00e3o de pagamento n\u00e3o \u00e9 v\u00e1lido.\n\n[Restri\u00e7\u00e3o] Caso consentimento rejeitado de vers\u00f5es nas quais n\u00e3o havia o campo rejectionReason retornar o seguinte detail: Motivo de rejei\u00e7\u00e3o inexistente em vers\u00f5es anteriores.","maxLength":2048,"pattern":"[\\w\\W\\s]*"}},"title":"RejectionReasonConsent","description":"Motivo da rejei\u00e7\u00e3o do consentimento. Informa\u00e7\u00f5es complementares sobre o motivo do status.\n[Restri\u00e7\u00e3o] Esse motivo dever\u00e1 ser enviado quando o campo \/data\/status for igual a REJECTED."},"MinPaymentData":{"type":"object","required":["paymentId","statusUpdateDateTime"],"properties":{"paymentId":{"type":"string","example":"TXpRMU9UQTROMWhZV2xSU1FUazJSMDl","description":"C\u00f3digo ou identificador \u00fanico informado pela institui\u00e7\u00e3o detentora da conta para representar a inicia\u00e7\u00e3o de pagamento individual. O paymentId deve ser diferente do endToEndId. Este \u00e9 o identificador que dever\u00e1 ser utilizado na consulta ao status da inicia\u00e7\u00e3o de pagamento efetuada.","minLength":1,"maxLength":100,"pattern":"^[a-zA-Z0-9][a-zA-Z0-9\\-]{0,99}$"},"statusUpdateDateTime":{"type":"string","format":"date-time","example":"2021-05-21T08:30:00.000Z","description":"Data e hora em que o recurso foi atualizado. Uma string com data e hora conforme especifica\u00e7\u00e3o RFC-3339, sempre com a utiliza\u00e7\u00e3o de timezone UTC(UTC time format)."}},"title":"MinPaymentData"},"PaymentsData":{"type":"object","required":["payments"],"properties":{"payments":{"type":"array","items":{"$ref":"#\/definitions\/MinPaymentData"},"minItems":0}},"title":"PaymentsData"},"Links":{"type":"object","required":["self"],"properties":{"self":{"type":"string","example":"https:\/\/api.e-unicred.com.br\/unicred\/open-finance\/v1\/clients","description":"URI completo que gerou a resposta atual.","maxLength":2000,"pattern":"^(https?:\\\/\\\/)?(www\\.)?[-a-zA-Z0-9@:%._\\+~#=]{2,256}\\.[a-z]{2,6}\\b([-a-zA-Z0-9@:%_\\+.~#?&\\\/\\\/=]*)$"},"first":{"type":"string","example":"https:\/\/api.e-unicred.com.br\/unicred\/open-finance\/v1\/clients","description":"URI da primeira p\u00e1gina que originou essa lista de resultados. Restri\u00e7\u00e3o - Obrigat\u00f3rio quando n\u00e3o for a primeira p\u00e1gina da resposta","maxLength":2000,"pattern":"^(https?:\\\/\\\/)?(www\\.)?[-a-zA-Z0-9@:%._\\+~#=]{2,256}\\.[a-z]{2,6}\\b([-a-zA-Z0-9@:%_\\+.~#?&\\\/\\\/=]*)$"},"prev":{"type":"string","example":"https:\/\/api.e-unicred.com.br\/unicred\/open-finance\/v1\/clients","description":"URI da p\u00e1gina anterior dessa lista de resultados. Restri\u00e7\u00e3o - Obrigat\u00f3rio quando n\u00e3o for a primeira p\u00e1gina da resposta","maxLength":2000,"pattern":"^(https?:\\\/\\\/)?(www\\.)?[-a-zA-Z0-9@:%._\\+~#=]{2,256}\\.[a-z]{2,6}\\b([-a-zA-Z0-9@:%_\\+.~#?&\\\/\\\/=]*)$"},"next":{"type":"string","example":"https:\/\/api.e-unicred.com.br\/unicred\/open-finance\/v1\/clients","description":"URI da pr\u00f3xima p\u00e1gina dessa lista de resultados. Restri\u00e7\u00e3o - Obrigat\u00f3rio quando n\u00e3o for a \u00faltima p\u00e1gina da resposta","maxLength":2000,"pattern":"^(https?:\\\/\\\/)?(www\\.)?[-a-zA-Z0-9@:%._\\+~#=]{2,256}\\.[a-z]{2,6}\\b([-a-zA-Z0-9@:%_\\+.~#?&\\\/\\\/=]*)$"},"last":{"type":"string","example":"https:\/\/api.e-unicred.com.br\/unicred\/open-finance\/v1\/clients","description":"URI da \u00faltima p\u00e1gina dessa lista de resultados. Restri\u00e7\u00e3o - Obrigat\u00f3rio quando n\u00e3o for a \u00faltima p\u00e1gina da resposta","maxLength":2000,"pattern":"^(https?:\\\/\\\/)?(www\\.)?[-a-zA-Z0-9@:%._\\+~#=]{2,256}\\.[a-z]{2,6}\\b([-a-zA-Z0-9@:%_\\+.~#?&\\\/\\\/=]*)$"}},"title":"Links","description":"Refer\u00eancias para outros recusos da API requisitada."},"Meta":{"type":"object","required":["requestDateTime"],"properties":{"totalRecords":{"type":"integer","format":"int32","example":1,"description":"N\u00famero total de registros no resultado"},"totalPages":{"type":"integer","format":"int32","example":1,"description":"N\u00famero total de p\u00e1ginas no resultado"},"requestDateTime":{"type":"string","format":"date-time","example":"2021-05-21T08:30:00.000Z","description":"Data e hora da consulta, conforme especifica\u00e7\u00e3o RFC-3339, formato UTC."}},"title":"Meta","description":"Meta informa\u00e7\u00f5es referente \u00e0 API requisitada."},"ResponseConsent":{"type":"object","required":["data","meta"],"properties":{"data":{"$ref":"#\/definitions\/ConsentData"},"meta":{"$ref":"#\/definitions\/Meta"}},"title":"ResponseConsent"},"ResponsePayment":{"type":"object","required":["data","meta"],"properties":{"data":{"$ref":"#\/definitions\/PaymentData"},"meta":{"$ref":"#\/definitions\/Meta"}},"title":"ResponsePayment"},"ResponsePayments":{"type":"object","required":["data","meta"],"properties":{"data":{"$ref":"#\/definitions\/PaymentsData"},"meta":{"$ref":"#\/definitions\/Meta"}},"title":"ResponsePayments"},"RequestCancellation":{"type":"object","required":["cancelledBy"],"properties":{"cancelledBy":{"$ref":"#\/definitions\/CancelledBy"}},"title":"RequestCancellation"},"RequestConsent":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#\/definitions\/PostConsentData"}},"title":"RequestConsent"},"ResponseError":{"type":"object","required":["errors"],"properties":{"errors":{"type":"array","items":{"$ref":"#\/definitions\/Error"},"maxItems":13,"minItems":1},"meta":{"$ref":"#\/definitions\/Meta"}},"title":"ResponseError"},"Error":{"type":"object","required":["code","detail","title"],"properties":{"code":{"type":"string","description":"C\u00f3digo de erro espec\u00edfico do endpoint","maxLength":255,"pattern":"[\\w\\W\\s]*"},"title":{"type":"string","description":"T\u00edtulo leg\u00edvel por humanos deste erro espec\u00edfico","maxLength":255,"pattern":"[\\w\\W\\s]*"},"detail":{"type":"string","description":"Descri\u00e7\u00e3o leg\u00edvel por humanos deste erro espec\u00edfico","maxLength":2048,"pattern":"[\\w\\W\\s]*"}},"title":"Error"}},"x-servers":{"13":"https:\/\/api.e-unicred.com.br\/homolog\/"}}

API Browser

Formulário de busca

Você está aqui

About Sensedia

Menu principal

Like Us On Facebook