openapi: 3.0.0 info: title: Recepção - Pagamento Recorrente description: Documentação referente a pagamentos recorrentes (automáticos) version: 2.2.0 servers: - url: https://{domain} description: Preencha seu dominío tpp variables: domain: default: tpp.exemplo.com components: schemas: {} parameters: {} paths: /automatic-payments/v2/recurring-consents: post: description: Cria um consentimento para pagamento recorrente tags: - Pagamento Recorrente parameters: - schema: type: string description: Authorisation server que vai receber a requisição required: true description: Authorisation server que vai receber a requisição name: x-authorisation-server-id in: header - schema: type: string description: Token FCamara required: true description: Token FCamara name: authorization in: header - schema: type: string description: Indica o user-agent que o usuário utiliza required: true description: Indica o user-agent que o usuário utiliza name: x-customer-user-agent in: header requestBody: required: true content: application/json: schema: type: object properties: data: type: object properties: loggedUser: type: object properties: document: type: object properties: identification: type: string maxLength: 11 pattern: ^\d{11}$ rel: type: string maxLength: 3 pattern: ^[A-Z]{3}$ required: - identification - rel required: - document businessEntity: type: object properties: document: type: object properties: identification: type: string maxLength: 14 pattern: ^[0-9A-Z]{12}[0-9]{2}$ rel: type: string maxLength: 4 pattern: ^[A-Z]{4}$ required: - identification - rel required: - document creditors: type: array items: type: object properties: personType: type: string enum: &ref_1 - PESSOA_NATURAL - PESSOA_JURIDICA cpfCnpj: type: string minLength: 11 maxLength: 14 pattern: ^([0-9]{11})$|^([0-9A-Z]{12}[0-9]{2})$ name: type: string maxLength: 120 pattern: ^([A-Za-zÀ-ÖØ-öø-ÿ,.@:&*+_<>()!?/\\$%\d' -]+)$ required: - personType - cpfCnpj - name minItems: 1 expirationDateTime: type: string maxLength: 20 pattern: >- ^(\d{4})-(1[0-2]|0?[1-9])-(3[01]|[12][0-9]|0?[1-9])T(?:[01]\d|2[0123]):(?:[012345]\d):(?:[012345]\d)Z$ additionalInformation: type: string maxLength: 140 pattern: '[\w\W\s]*' debtorAccount: type: object properties: ispb: type: string minLength: 8 maxLength: 8 pattern: ^[0-9A-Z]{8}$ issuer: type: string minLength: 1 maxLength: 4 pattern: ^[0-9]{1,4}$ number: type: string minLength: 1 maxLength: 20 pattern: ^[0-9]{1,20}$ accountType: type: string enum: &ref_0 - CACC - SVGS - TRAN required: - ispb - number - accountType recurringConfiguration: anyOf: - type: object properties: automatic: type: object properties: contractId: type: string minLength: 1 maxLength: 35 pattern: ^[a-zA-Z0-9]{1,35}$ fixedAmount: type: string minLength: 4 maxLength: 19 pattern: ^((\d{1,16}\.\d{2}))$ maximumVariableAmount: type: string minLength: 4 maxLength: 19 pattern: ^((\d{1,16}\.\d{2}))$ interval: type: string enum: &ref_4 - SEMANAL - MENSAL - ANUAL - SEMESTRAL - TRIMESTRAL contractDebtor: type: object properties: name: type: string maxLength: 120 pattern: >- ^([A-Za-zÀ-ÖØ-öø-ÿ,.@:&*+_<>()!?/\\$%\d' -]+)$ document: type: object properties: identification: type: string minLength: 11 maxLength: 14 pattern: ^([0-9]{11})$|^([0-9A-Z]{12}[0-9]{2})$ rel: type: string enum: &ref_5 - CPF - CNPJ required: - identification - rel required: - name - document firstPayment: type: object properties: type: type: string enum: &ref_6 - PIX date: type: string maxLength: 10 pattern: >- ^(\d{4})-(1[0-2]|0?[1-9])-(3[01]|[12][0-9]|0?[1-9])$ currency: type: string maxLength: 3 pattern: ^([A-Z]{3})$ amount: type: string minLength: 4 maxLength: 19 pattern: ^((\d{1,16}\.\d{2}))$ remittanceInformation: type: string maxLength: 140 pattern: '[\w\W\s]*' creditorAccount: type: object properties: ispb: type: string minLength: 8 maxLength: 8 pattern: ^[0-9A-Z]{8}$ issuer: type: string minLength: 1 maxLength: 4 pattern: ^[0-9]{1,4}$ number: type: string minLength: 1 maxLength: 20 pattern: ^[0-9]{1,20}$ accountType: type: string enum: *ref_0 required: - ispb - number - accountType required: - type - date - currency - amount - creditorAccount minimumVariableAmount: type: string minLength: 4 maxLength: 19 pattern: ^((\d{1,16}\.\d{2}))$ isRetryAccepted: type: boolean referenceStartDate: type: string pattern: >- ^(\d{4})-(1[0-2]|0?[1-9])-(3[01]|[12][0-9]|0?[1-9])$ required: - contractId - interval - contractDebtor - isRetryAccepted - referenceStartDate required: - automatic - type: object properties: sweeping: type: object properties: totalAllowedAmount: type: string minLength: 4 maxLength: 19 pattern: ^((\d{1,16}\.\d{2}))$ transactionLimit: type: string minLength: 4 maxLength: 19 pattern: ^((\d{1,16}\.\d{2}))$ periodicLimits: type: object properties: day: type: object properties: quantityLimit: type: integer minimum: 1 transactionLimit: type: string minLength: 4 maxLength: 19 pattern: ^((\d{1,16}\.\d{2}))$ week: type: object properties: quantityLimit: type: integer minimum: 1 transactionLimit: type: string minLength: 4 maxLength: 19 pattern: ^((\d{1,16}\.\d{2}))$ month: type: object properties: quantityLimit: type: integer minimum: 1 transactionLimit: type: string minLength: 4 maxLength: 19 pattern: ^((\d{1,16}\.\d{2}))$ year: type: object properties: quantityLimit: type: integer minimum: 1 transactionLimit: type: string minLength: 4 maxLength: 19 pattern: ^((\d{1,16}\.\d{2}))$ startDateTime: type: string pattern: >- ^(\d{4})-(1[0-2]|0?[1-9])-(3[01]|[12][0-9]|0?[1-9])T(?:[01]\d|2[0123]):(?:[012345]\d):(?:[012345]\d)Z$ required: - sweeping - type: object properties: vrp: type: object properties: transactionLimit: type: string minLength: 4 maxLength: 19 pattern: ^((\d{1,16}\.\d{2}))$ globalLimits: type: object properties: quantityLimit: type: integer transactionLimit: type: string minLength: 4 maxLength: 19 pattern: ^((\d{1,16}\.\d{2}))$ periodicLimits: type: object properties: day: type: object properties: quantityLimit: type: integer minimum: 1 transactionLimit: type: string minLength: 4 maxLength: 19 pattern: ^((\d{1,16}\.\d{2}))$ week: type: object properties: quantityLimit: type: integer minimum: 1 transactionLimit: type: string minLength: 4 maxLength: 19 pattern: ^((\d{1,16}\.\d{2}))$ month: type: object properties: quantityLimit: type: integer minimum: 1 transactionLimit: type: string minLength: 4 maxLength: 19 pattern: ^((\d{1,16}\.\d{2}))$ year: type: object properties: quantityLimit: type: integer minimum: 1 transactionLimit: type: string minLength: 4 maxLength: 19 pattern: ^((\d{1,16}\.\d{2}))$ required: - vrp journey: type: object properties: isLinked: type: boolean linkId: type: string required: - loggedUser - creditors - recurringConfiguration required: - data responses: '201': description: Consentimento de pagamento recorrente criado com sucesso content: application/json: schema: type: object properties: data: type: object properties: recurringConsentId: type: string maxLength: 256 pattern: >- ^urn:[a-zA-Z0-9][a-zA-Z0-9-]{0,31}:[a-zA-Z0-9()+,-.:=@;$_!*'%/?#]+$ statusUpdateDateTime: type: string maxLength: 20 pattern: >- ^(\d{4})-(1[0-2]|0?[1-9])-(3[01]|[12][0-9]|0?[1-9])T(?:[01]\d|2[0123]):(?:[012345]\d):(?:[012345]\d)Z$ loggedUser: type: object properties: document: type: object properties: identification: type: string maxLength: 11 pattern: ^\d{11}$ rel: type: string maxLength: 3 pattern: ^[A-Z]{3}$ required: - identification - rel required: - document businessEntity: type: object properties: document: type: object properties: identification: type: string maxLength: 14 pattern: ^[0-9A-Z]{12}[0-9]{2}$ rel: type: string maxLength: 4 pattern: ^[A-Z]{4}$ required: - identification - rel required: - document status: type: string enum: &ref_7 - AWAITING_AUTHORISATION - AUTHORISED - REJECTED - CONSUMED - PARTIALLY_ACCEPTED creditors: type: array items: type: object properties: personType: type: string enum: *ref_1 cpfCnpj: type: string minLength: 11 maxLength: 14 pattern: ^([0-9]{11})$|^([0-9A-Z]{12}[0-9]{2})$ name: type: string maxLength: 120 pattern: ^([A-Za-zÀ-ÖØ-öø-ÿ,.@:&*+_<>()!?/\\$%\d' -]+)$ required: - personType - cpfCnpj - name minItems: 1 creationDateTime: type: string maxLength: 20 pattern: >- ^(\d{4})-(1[0-2]|0?[1-9])-(3[01]|[12][0-9]|0?[1-9])T(?:[01]\d|2[0123]):(?:[012345]\d):(?:[012345]\d)Z$ expirationDateTime: type: string maxLength: 20 pattern: >- ^(\d{4})-(1[0-2]|0?[1-9])-(3[01]|[12][0-9]|0?[1-9])T(?:[01]\d|2[0123]):(?:[012345]\d):(?:[012345]\d)Z$ additionalInformation: type: string maxLength: 140 pattern: '[\w\W\s]*' debtorAccount: type: object properties: ispb: type: string minLength: 8 maxLength: 8 pattern: ^[0-9A-Z]{8}$ issuer: type: string minLength: 1 maxLength: 4 pattern: ^[0-9]{1,4}$ number: type: string minLength: 1 maxLength: 20 pattern: ^[0-9]{1,20}$ accountType: type: string enum: *ref_0 required: - ispb - number - accountType rejection: type: object properties: rejectedBy: type: string enum: &ref_2 - INICIADORA - USUARIO - DETENTORA rejectedFrom: type: string enum: &ref_3 - INICIADORA - DETENTORA rejectedAt: type: string maxLength: 20 pattern: >- ^(\d{4})-(1[0-2]|0?[1-9])-(3[01]|[12][0-9]|0?[1-9])T(?:[01]\d|2[0123]):(?:[012345]\d):(?:[012345]\d)Z$ reason: type: object properties: code: type: string enum: &ref_8 - NAO_INFORMADO - FALHA_INFRAESTRUTURA - TEMPO_EXPIRADO_AUTORIZACAO - REJEITADO_USUARIO - CONTAS_ORIGEM_DESTINO_IGUAIS - CONTA_NAO_PERMITE_PAGAMENTO - AUTENTICACAO_DIVERGENTE - FLUXO_NAO_SUPORTADO_PRODUTO detail: type: string maxLength: 2048 pattern: '[\w\W\s]*' required: - code - detail required: - rejectedBy - rejectedFrom - rejectedAt - reason revocation: type: object properties: revokedBy: type: string enum: *ref_2 revokedFrom: type: string enum: *ref_3 revokedAt: type: string maxLength: 20 pattern: >- ^(\d{4})-(1[0-2]|0?[1-9])-(3[01]|[12][0-9]|0?[1-9])T(?:[01]\d|2[0123]):(?:[012345]\d):(?:[012345]\d)Z$ reason: type: object properties: code: type: string enum: &ref_9 - REVOGADO_RECEBEDOR - REVOGADO_USUARIO - NAO_INFORMADO detail: type: string maxLength: 2048 pattern: '[\w\W\s]*' required: - code - detail required: - revokedBy - revokedFrom - revokedAt - reason recurringConfiguration: anyOf: - type: object properties: automatic: type: object properties: contractId: type: string minLength: 1 maxLength: 35 pattern: ^[a-zA-Z0-9]{1,35}$ fixedAmount: type: string minLength: 4 maxLength: 19 pattern: ^((\d{1,16}\.\d{2}))$ maximumVariableAmount: type: string minLength: 4 maxLength: 19 pattern: ^((\d{1,16}\.\d{2}))$ interval: type: string enum: *ref_4 contractDebtor: type: object properties: name: type: string maxLength: 120 pattern: >- ^([A-Za-zÀ-ÖØ-öø-ÿ,.@:&*+_<>()!?/\\$%\d' -]+)$ document: type: object properties: identification: type: string minLength: 11 maxLength: 14 pattern: ^([0-9]{11})$|^([0-9A-Z]{12}[0-9]{2})$ rel: type: string enum: *ref_5 required: - identification - rel required: - name - document firstPayment: type: object properties: type: type: string enum: *ref_6 date: type: string maxLength: 10 pattern: >- ^(\d{4})-(1[0-2]|0?[1-9])-(3[01]|[12][0-9]|0?[1-9])$ currency: type: string maxLength: 3 pattern: ^([A-Z]{3})$ amount: type: string minLength: 4 maxLength: 19 pattern: ^((\d{1,16}\.\d{2}))$ remittanceInformation: type: string maxLength: 140 pattern: '[\w\W\s]*' creditorAccount: type: object properties: ispb: type: string minLength: 8 maxLength: 8 pattern: ^[0-9A-Z]{8}$ issuer: type: string minLength: 1 maxLength: 4 pattern: ^[0-9]{1,4}$ number: type: string minLength: 1 maxLength: 20 pattern: ^[0-9]{1,20}$ accountType: type: string enum: *ref_0 required: - ispb - number - accountType required: - type - date - currency - amount - creditorAccount minimumVariableAmount: type: string minLength: 4 maxLength: 19 pattern: ^((\d{1,16}\.\d{2}))$ isRetryAccepted: type: boolean useOverdraftLimit: type: boolean default: true referenceStartDate: type: string pattern: >- ^(\d{4})-(1[0-2]|0?[1-9])-(3[01]|[12][0-9]|0?[1-9])$ required: - interval - contractDebtor - isRetryAccepted - referenceStartDate required: - automatic - type: object properties: sweeping: type: object properties: totalAllowedAmount: type: string minLength: 4 maxLength: 19 pattern: ^((\d{1,16}\.\d{2}))$ transactionLimit: type: string minLength: 4 maxLength: 19 pattern: ^((\d{1,16}\.\d{2}))$ periodicLimits: type: object properties: day: type: object properties: quantityLimit: type: integer minimum: 1 transactionLimit: type: string minLength: 4 maxLength: 19 pattern: ^((\d{1,16}\.\d{2}))$ week: type: object properties: quantityLimit: type: integer minimum: 1 transactionLimit: type: string minLength: 4 maxLength: 19 pattern: ^((\d{1,16}\.\d{2}))$ month: type: object properties: quantityLimit: type: integer minimum: 1 transactionLimit: type: string minLength: 4 maxLength: 19 pattern: ^((\d{1,16}\.\d{2}))$ year: type: object properties: quantityLimit: type: integer minimum: 1 transactionLimit: type: string minLength: 4 maxLength: 19 pattern: ^((\d{1,16}\.\d{2}))$ useOverdraftLimit: type: boolean default: true startDateTime: type: string pattern: >- ^(\d{4})-(1[0-2]|0?[1-9])-(3[01]|[12][0-9]|0?[1-9])T(?:[01]\d|2[0123]):(?:[012345]\d):(?:[012345]\d)Z$ required: - startDateTime required: - sweeping - type: object properties: vrp: type: object properties: transactionLimit: type: string minLength: 4 maxLength: 19 pattern: ^((\d{1,16}\.\d{2}))$ globalLimits: type: object properties: quantityLimit: type: integer transactionLimit: type: string minLength: 4 maxLength: 19 pattern: ^((\d{1,16}\.\d{2}))$ periodicLimits: type: object properties: day: type: object properties: quantityLimit: type: integer minimum: 1 transactionLimit: type: string minLength: 4 maxLength: 19 pattern: ^((\d{1,16}\.\d{2}))$ week: type: object properties: quantityLimit: type: integer minimum: 1 transactionLimit: type: string minLength: 4 maxLength: 19 pattern: ^((\d{1,16}\.\d{2}))$ month: type: object properties: quantityLimit: type: integer minimum: 1 transactionLimit: type: string minLength: 4 maxLength: 19 pattern: ^((\d{1,16}\.\d{2}))$ year: type: object properties: quantityLimit: type: integer minimum: 1 transactionLimit: type: string minLength: 4 maxLength: 19 pattern: ^((\d{1,16}\.\d{2}))$ required: - vrp authorisedAtDateTime: type: string minLength: 20 maxLength: 20 pattern: >- ^(\d{4})-(1[0-2]|0?[1-9])-(3[01]|[12][0-9]|0?[1-9])T(?:[01]\d|2[0123]):(?:[012345]\d):(?:[012345]\d)Z$ updatedAtDateTime: type: string minLength: 20 maxLength: 20 pattern: >- ^(\d{4})-(1[0-2]|0?[1-9])-(3[01]|[12][0-9]|0?[1-9])T(?:[01]\d|2[0123]):(?:[012345]\d):(?:[012345]\d)Z$ journey: type: object properties: isLinked: type: boolean linkId: type: string authorisationUrl: type: string required: - recurringConsentId - statusUpdateDateTime - loggedUser - status - creditors - creationDateTime - recurringConfiguration - authorisationUrl links: type: object properties: self: type: string maxLength: 2000 pattern: >- ^(https:\/\/)?(www\.)?[-a-zA-Z0-9@:%._\+~#=]{2,256}\.[a-z]{2,6}\b([-a-zA-Z0-9@:%_\+.~#?&\/\/=]*)$ required: - self meta: type: object properties: requestDateTime: type: string maxLength: 20 format: date-time required: - requestDateTime required: - data - links - meta /automatic-payments/v2/optimised-journey: post: description: >- Cria a Jornada Otimizada: um consentimento de dados vinculado e um consentimento de pagamento recorrente, com uma única URL de autorização combinada tags: - Pagamento Recorrente parameters: - schema: type: string description: Authorisation server que vai receber a requisição required: true description: Authorisation server que vai receber a requisição name: x-authorisation-server-id in: header - schema: type: string description: Token FCamara required: true description: Token FCamara name: authorization in: header - schema: type: string description: Indica o user-agent que o usuário utiliza required: true description: Indica o user-agent que o usuário utiliza name: x-customer-user-agent in: header requestBody: required: true content: application/json: schema: type: object properties: data: type: object properties: loggedUser: type: object properties: document: type: object properties: identification: type: string maxLength: 11 pattern: ^\d{11}$ rel: type: string maxLength: 3 pattern: ^[A-Z]{3}$ required: - identification - rel required: - document businessEntity: type: object properties: document: type: object properties: identification: type: string maxLength: 14 pattern: ^[0-9A-Z]{12}[0-9]{2}$ rel: type: string maxLength: 4 pattern: ^[A-Z]{4}$ required: - identification - rel required: - document creditors: type: array items: type: object properties: personType: type: string enum: *ref_1 cpfCnpj: type: string minLength: 11 maxLength: 14 pattern: ^([0-9]{11})$|^([0-9A-Z]{12}[0-9]{2})$ name: type: string maxLength: 120 pattern: ^([A-Za-zÀ-ÖØ-öø-ÿ,.@:&*+_<>()!?/\\$%\d' -]+)$ required: - personType - cpfCnpj - name minItems: 1 expirationDateTime: type: string maxLength: 20 pattern: >- ^(\d{4})-(1[0-2]|0?[1-9])-(3[01]|[12][0-9]|0?[1-9])T(?:[01]\d|2[0123]):(?:[012345]\d):(?:[012345]\d)Z$ additionalInformation: type: string maxLength: 140 pattern: '[\w\W\s]*' debtorAccount: type: object properties: ispb: type: string minLength: 8 maxLength: 8 pattern: ^[0-9A-Z]{8}$ issuer: type: string minLength: 1 maxLength: 4 pattern: ^[0-9]{1,4}$ number: type: string minLength: 1 maxLength: 20 pattern: ^[0-9]{1,20}$ accountType: type: string enum: *ref_0 required: - ispb - number - accountType recurringConfiguration: anyOf: - type: object properties: automatic: type: object properties: contractId: type: string minLength: 1 maxLength: 35 pattern: ^[a-zA-Z0-9]{1,35}$ fixedAmount: type: string minLength: 4 maxLength: 19 pattern: ^((\d{1,16}\.\d{2}))$ maximumVariableAmount: type: string minLength: 4 maxLength: 19 pattern: ^((\d{1,16}\.\d{2}))$ interval: type: string enum: *ref_4 contractDebtor: type: object properties: name: type: string maxLength: 120 pattern: >- ^([A-Za-zÀ-ÖØ-öø-ÿ,.@:&*+_<>()!?/\\$%\d' -]+)$ document: type: object properties: identification: type: string minLength: 11 maxLength: 14 pattern: ^([0-9]{11})$|^([0-9A-Z]{12}[0-9]{2})$ rel: type: string enum: *ref_5 required: - identification - rel required: - name - document firstPayment: type: object properties: type: type: string enum: *ref_6 date: type: string maxLength: 10 pattern: >- ^(\d{4})-(1[0-2]|0?[1-9])-(3[01]|[12][0-9]|0?[1-9])$ currency: type: string maxLength: 3 pattern: ^([A-Z]{3})$ amount: type: string minLength: 4 maxLength: 19 pattern: ^((\d{1,16}\.\d{2}))$ remittanceInformation: type: string maxLength: 140 pattern: '[\w\W\s]*' creditorAccount: type: object properties: ispb: type: string minLength: 8 maxLength: 8 pattern: ^[0-9A-Z]{8}$ issuer: type: string minLength: 1 maxLength: 4 pattern: ^[0-9]{1,4}$ number: type: string minLength: 1 maxLength: 20 pattern: ^[0-9]{1,20}$ accountType: type: string enum: *ref_0 required: - ispb - number - accountType required: - type - date - currency - amount - creditorAccount minimumVariableAmount: type: string minLength: 4 maxLength: 19 pattern: ^((\d{1,16}\.\d{2}))$ isRetryAccepted: type: boolean referenceStartDate: type: string pattern: >- ^(\d{4})-(1[0-2]|0?[1-9])-(3[01]|[12][0-9]|0?[1-9])$ required: - contractId - interval - contractDebtor - isRetryAccepted - referenceStartDate required: - automatic - type: object properties: sweeping: type: object properties: totalAllowedAmount: type: string minLength: 4 maxLength: 19 pattern: ^((\d{1,16}\.\d{2}))$ transactionLimit: type: string minLength: 4 maxLength: 19 pattern: ^((\d{1,16}\.\d{2}))$ periodicLimits: type: object properties: day: type: object properties: quantityLimit: type: integer minimum: 1 transactionLimit: type: string minLength: 4 maxLength: 19 pattern: ^((\d{1,16}\.\d{2}))$ week: type: object properties: quantityLimit: type: integer minimum: 1 transactionLimit: type: string minLength: 4 maxLength: 19 pattern: ^((\d{1,16}\.\d{2}))$ month: type: object properties: quantityLimit: type: integer minimum: 1 transactionLimit: type: string minLength: 4 maxLength: 19 pattern: ^((\d{1,16}\.\d{2}))$ year: type: object properties: quantityLimit: type: integer minimum: 1 transactionLimit: type: string minLength: 4 maxLength: 19 pattern: ^((\d{1,16}\.\d{2}))$ startDateTime: type: string pattern: >- ^(\d{4})-(1[0-2]|0?[1-9])-(3[01]|[12][0-9]|0?[1-9])T(?:[01]\d|2[0123]):(?:[012345]\d):(?:[012345]\d)Z$ required: - sweeping - type: object properties: vrp: type: object properties: transactionLimit: type: string minLength: 4 maxLength: 19 pattern: ^((\d{1,16}\.\d{2}))$ globalLimits: type: object properties: quantityLimit: type: integer transactionLimit: type: string minLength: 4 maxLength: 19 pattern: ^((\d{1,16}\.\d{2}))$ periodicLimits: type: object properties: day: type: object properties: quantityLimit: type: integer minimum: 1 transactionLimit: type: string minLength: 4 maxLength: 19 pattern: ^((\d{1,16}\.\d{2}))$ week: type: object properties: quantityLimit: type: integer minimum: 1 transactionLimit: type: string minLength: 4 maxLength: 19 pattern: ^((\d{1,16}\.\d{2}))$ month: type: object properties: quantityLimit: type: integer minimum: 1 transactionLimit: type: string minLength: 4 maxLength: 19 pattern: ^((\d{1,16}\.\d{2}))$ year: type: object properties: quantityLimit: type: integer minimum: 1 transactionLimit: type: string minLength: 4 maxLength: 19 pattern: ^((\d{1,16}\.\d{2}))$ required: - vrp permissions: type: array items: type: string enum: - ACCOUNTS_READ - ACCOUNTS_BALANCES_READ - ACCOUNTS_OVERDRAFT_LIMITS_READ - RESOURCES_READ required: - loggedUser - creditors - recurringConfiguration - permissions required: - data responses: '201': description: Consentimentos da Jornada Otimizada criados com sucesso content: application/json: schema: type: object properties: data: type: object properties: consentId: type: string recurringConsentId: type: string authorisationUrl: type: string required: - consentId - recurringConsentId - authorisationUrl required: - data /automatic-payments/v2/recurring-consents/{recurringConsentId}: get: description: Consultar consentimento de pagamento recorrente tags: - Pagamento Recorrente parameters: - schema: type: string description: ID do consentimento recorrente required: true name: recurringConsentId in: path - schema: type: string description: Authorisation server que vai receber a requisição required: true description: Authorisation server que vai receber a requisição name: x-authorisation-server-id in: header - schema: type: string description: Token FCamara required: true description: Token FCamara name: authorization in: header - schema: type: string description: Indica o user-agent que o usuário utiliza required: true description: Indica o user-agent que o usuário utiliza name: x-customer-user-agent in: header responses: '200': description: Dados do consentimento de pagamento recorrente obtidos com sucesso content: application/json: schema: type: object properties: data: type: object properties: recurringConsentId: type: string maxLength: 256 pattern: >- ^urn:[a-zA-Z0-9][a-zA-Z0-9-]{0,31}:[a-zA-Z0-9()+,-.:=@;$_!*'%/?#]+$ statusUpdateDateTime: type: string maxLength: 20 pattern: >- ^(\d{4})-(1[0-2]|0?[1-9])-(3[01]|[12][0-9]|0?[1-9])T(?:[01]\d|2[0123]):(?:[012345]\d):(?:[012345]\d)Z$ loggedUser: type: object properties: document: type: object properties: identification: type: string maxLength: 11 pattern: ^\d{11}$ rel: type: string maxLength: 3 pattern: ^[A-Z]{3}$ required: - identification - rel required: - document businessEntity: type: object properties: document: type: object properties: identification: type: string maxLength: 14 pattern: ^[0-9A-Z]{12}[0-9]{2}$ rel: type: string maxLength: 4 pattern: ^[A-Z]{4}$ required: - identification - rel required: - document status: type: string enum: *ref_7 creditors: type: array items: type: object properties: personType: type: string enum: *ref_1 cpfCnpj: type: string minLength: 11 maxLength: 14 pattern: ^([0-9]{11})$|^([0-9A-Z]{12}[0-9]{2})$ name: type: string maxLength: 120 pattern: ^([A-Za-zÀ-ÖØ-öø-ÿ,.@:&*+_<>()!?/\\$%\d' -]+)$ required: - personType - cpfCnpj - name minItems: 1 creationDateTime: type: string maxLength: 20 pattern: >- ^(\d{4})-(1[0-2]|0?[1-9])-(3[01]|[12][0-9]|0?[1-9])T(?:[01]\d|2[0123]):(?:[012345]\d):(?:[012345]\d)Z$ expirationDateTime: type: string maxLength: 20 pattern: >- ^(\d{4})-(1[0-2]|0?[1-9])-(3[01]|[12][0-9]|0?[1-9])T(?:[01]\d|2[0123]):(?:[012345]\d):(?:[012345]\d)Z$ additionalInformation: type: string maxLength: 140 pattern: '[\w\W\s]*' debtorAccount: type: object properties: ispb: type: string minLength: 8 maxLength: 8 pattern: ^[0-9A-Z]{8}$ issuer: type: string minLength: 1 maxLength: 4 pattern: ^[0-9]{1,4}$ number: type: string minLength: 1 maxLength: 20 pattern: ^[0-9]{1,20}$ accountType: type: string enum: *ref_0 required: - ispb - number - accountType rejection: type: object properties: rejectedBy: type: string enum: *ref_2 rejectedFrom: type: string enum: *ref_3 rejectedAt: type: string maxLength: 20 pattern: >- ^(\d{4})-(1[0-2]|0?[1-9])-(3[01]|[12][0-9]|0?[1-9])T(?:[01]\d|2[0123]):(?:[012345]\d):(?:[012345]\d)Z$ reason: type: object properties: code: type: string enum: *ref_8 detail: type: string maxLength: 2048 pattern: '[\w\W\s]*' required: - code - detail required: - rejectedBy - rejectedFrom - rejectedAt - reason revocation: type: object properties: revokedBy: type: string enum: *ref_2 revokedFrom: type: string enum: *ref_3 revokedAt: type: string maxLength: 20 pattern: >- ^(\d{4})-(1[0-2]|0?[1-9])-(3[01]|[12][0-9]|0?[1-9])T(?:[01]\d|2[0123]):(?:[012345]\d):(?:[012345]\d)Z$ reason: type: object properties: code: type: string enum: *ref_9 detail: type: string maxLength: 2048 pattern: '[\w\W\s]*' required: - code - detail required: - revokedBy - revokedFrom - revokedAt - reason recurringConfiguration: anyOf: - type: object properties: automatic: type: object properties: contractId: type: string minLength: 1 maxLength: 35 pattern: ^[a-zA-Z0-9]{1,35}$ fixedAmount: type: string minLength: 4 maxLength: 19 pattern: ^((\d{1,16}\.\d{2}))$ maximumVariableAmount: type: string minLength: 4 maxLength: 19 pattern: ^((\d{1,16}\.\d{2}))$ interval: type: string enum: *ref_4 contractDebtor: type: object properties: name: type: string maxLength: 120 pattern: >- ^([A-Za-zÀ-ÖØ-öø-ÿ,.@:&*+_<>()!?/\\$%\d' -]+)$ document: type: object properties: identification: type: string minLength: 11 maxLength: 14 pattern: ^([0-9]{11})$|^([0-9A-Z]{12}[0-9]{2})$ rel: type: string enum: *ref_5 required: - identification - rel required: - name - document firstPayment: type: object properties: type: type: string enum: *ref_6 date: type: string maxLength: 10 pattern: >- ^(\d{4})-(1[0-2]|0?[1-9])-(3[01]|[12][0-9]|0?[1-9])$ currency: type: string maxLength: 3 pattern: ^([A-Z]{3})$ amount: type: string minLength: 4 maxLength: 19 pattern: ^((\d{1,16}\.\d{2}))$ remittanceInformation: type: string maxLength: 140 pattern: '[\w\W\s]*' creditorAccount: type: object properties: ispb: type: string minLength: 8 maxLength: 8 pattern: ^[0-9A-Z]{8}$ issuer: type: string minLength: 1 maxLength: 4 pattern: ^[0-9]{1,4}$ number: type: string minLength: 1 maxLength: 20 pattern: ^[0-9]{1,20}$ accountType: type: string enum: *ref_0 required: - ispb - number - accountType required: - type - date - currency - amount - creditorAccount minimumVariableAmount: type: string minLength: 4 maxLength: 19 pattern: ^((\d{1,16}\.\d{2}))$ isRetryAccepted: type: boolean useOverdraftLimit: type: boolean default: true referenceStartDate: type: string pattern: >- ^(\d{4})-(1[0-2]|0?[1-9])-(3[01]|[12][0-9]|0?[1-9])$ required: - interval - contractDebtor - isRetryAccepted - referenceStartDate required: - automatic - type: object properties: sweeping: type: object properties: totalAllowedAmount: type: string minLength: 4 maxLength: 19 pattern: ^((\d{1,16}\.\d{2}))$ transactionLimit: type: string minLength: 4 maxLength: 19 pattern: ^((\d{1,16}\.\d{2}))$ periodicLimits: type: object properties: day: type: object properties: quantityLimit: type: integer minimum: 1 transactionLimit: type: string minLength: 4 maxLength: 19 pattern: ^((\d{1,16}\.\d{2}))$ week: type: object properties: quantityLimit: type: integer minimum: 1 transactionLimit: type: string minLength: 4 maxLength: 19 pattern: ^((\d{1,16}\.\d{2}))$ month: type: object properties: quantityLimit: type: integer minimum: 1 transactionLimit: type: string minLength: 4 maxLength: 19 pattern: ^((\d{1,16}\.\d{2}))$ year: type: object properties: quantityLimit: type: integer minimum: 1 transactionLimit: type: string minLength: 4 maxLength: 19 pattern: ^((\d{1,16}\.\d{2}))$ useOverdraftLimit: type: boolean default: true startDateTime: type: string pattern: >- ^(\d{4})-(1[0-2]|0?[1-9])-(3[01]|[12][0-9]|0?[1-9])T(?:[01]\d|2[0123]):(?:[012345]\d):(?:[012345]\d)Z$ required: - startDateTime required: - sweeping - type: object properties: vrp: type: object properties: transactionLimit: type: string minLength: 4 maxLength: 19 pattern: ^((\d{1,16}\.\d{2}))$ globalLimits: type: object properties: quantityLimit: type: integer transactionLimit: type: string minLength: 4 maxLength: 19 pattern: ^((\d{1,16}\.\d{2}))$ periodicLimits: type: object properties: day: type: object properties: quantityLimit: type: integer minimum: 1 transactionLimit: type: string minLength: 4 maxLength: 19 pattern: ^((\d{1,16}\.\d{2}))$ week: type: object properties: quantityLimit: type: integer minimum: 1 transactionLimit: type: string minLength: 4 maxLength: 19 pattern: ^((\d{1,16}\.\d{2}))$ month: type: object properties: quantityLimit: type: integer minimum: 1 transactionLimit: type: string minLength: 4 maxLength: 19 pattern: ^((\d{1,16}\.\d{2}))$ year: type: object properties: quantityLimit: type: integer minimum: 1 transactionLimit: type: string minLength: 4 maxLength: 19 pattern: ^((\d{1,16}\.\d{2}))$ required: - vrp authorisedAtDateTime: type: string minLength: 20 maxLength: 20 pattern: >- ^(\d{4})-(1[0-2]|0?[1-9])-(3[01]|[12][0-9]|0?[1-9])T(?:[01]\d|2[0123]):(?:[012345]\d):(?:[012345]\d)Z$ updatedAtDateTime: type: string minLength: 20 maxLength: 20 pattern: >- ^(\d{4})-(1[0-2]|0?[1-9])-(3[01]|[12][0-9]|0?[1-9])T(?:[01]\d|2[0123]):(?:[012345]\d):(?:[012345]\d)Z$ journey: type: object properties: isLinked: type: boolean linkId: type: string approvalDueDate: type: string pattern: ^(\d{4})-(1[0-2]|0?[1-9])-(3[01]|[12][0-9]|0?[1-9])$ required: - recurringConsentId - statusUpdateDateTime - loggedUser - status - creditors - creationDateTime - recurringConfiguration links: type: object properties: self: type: string maxLength: 2000 pattern: >- ^(https:\/\/)?(www\.)?[-a-zA-Z0-9@:%._\+~#=]{2,256}\.[a-z]{2,6}\b([-a-zA-Z0-9@:%_\+.~#?&\/\/=]*)$ required: - self meta: type: object properties: requestDateTime: type: string maxLength: 20 format: date-time required: - requestDateTime required: - data - links - meta patch: description: Rejeita, revoga ou edita um consentimento de pagamento recorrente tags: - Pagamento Recorrente parameters: - schema: type: string description: ID do consentimento recorrente required: true name: recurringConsentId in: path - schema: type: string description: Authorisation server que vai receber a requisição required: true description: Authorisation server que vai receber a requisição name: x-authorisation-server-id in: header - schema: type: string description: Token FCamara required: true description: Token FCamara name: authorization in: header - schema: type: string description: Indica o user-agent que o usuário utiliza required: true description: Indica o user-agent que o usuário utiliza name: x-customer-user-agent in: header requestBody: required: true content: application/json: schema: type: object properties: data: anyOf: - type: object properties: status: type: string enum: - REVOKED revocation: type: object properties: revokedBy: type: string enum: *ref_2 revokedFrom: type: string enum: *ref_3 reason: type: object properties: code: type: string enum: *ref_9 detail: type: string maxLength: 2048 pattern: '[\w\W\s]*' required: - code - detail required: - revokedBy - revokedFrom - reason required: - revocation - type: object properties: status: type: string enum: - REJECTED rejection: type: object properties: rejectedBy: type: string enum: *ref_2 rejectedFrom: type: string enum: *ref_3 reason: type: object properties: code: type: string enum: *ref_8 detail: type: string maxLength: 2048 pattern: '[\w\W\s]*' required: - code - detail required: - rejectedBy - rejectedFrom - reason required: - rejection - type: object properties: riskSignals: type: object properties: deviceId: type: string isRootedDevice: type: boolean screenBrightness: type: number elapsedTimeSinceBoot: type: integer osVersion: type: string userTimeZoneOffset: type: string language: type: string screenDimensions: type: object properties: height: type: integer width: type: integer required: - height - width accountTenure: type: string pattern: >- ^(\d{4})-(1[0-2]|0?[1-9])-(3[01]|[12][0-9]|0?[1-9])$ geolocation: type: object properties: latitude: type: number longitude: type: number type: type: string enum: &ref_10 - COARSE - FINE - INFERRED isCallInProgress: type: boolean isDevModeEnabled: type: boolean isMockGPS: type: boolean isEmulated: type: boolean isMonkeyRunner: type: boolean isCharging: type: boolean antennaInformation: type: string isUsbConnected: type: boolean integrity: type: object properties: appRecognitionVerdict: type: string deviceRecognitionVerdict: type: string required: - deviceId - osVersion - userTimeZoneOffset - language - screenDimensions - accountTenure creditors: type: array items: type: object properties: name: type: string maxLength: 120 pattern: ^([A-Za-zÀ-ÖØ-öø-ÿ,.@:&*+_<>()!?/\\$%\d' -]+)$ minItems: 1 expirationDateTime: type: string maxLength: 20 pattern: >- ^(\d{4})-(1[0-2]|0?[1-9])-(3[01]|[12][0-9]|0?[1-9])T(?:[01]\d|2[0123]):(?:[012345]\d):(?:[012345]\d)Z$ recurringConfiguration: type: object properties: automatic: type: object properties: maximumVariableAmount: type: string minLength: 4 maxLength: 19 pattern: ^((\d{1,16}\.\d{2}))$ loggedUser: type: object properties: document: type: object properties: identification: type: string maxLength: 11 pattern: ^\d{11}$ rel: type: string enum: - CPF required: - identification - rel required: - document businessEntity: type: object properties: document: type: object properties: identification: type: string maxLength: 14 pattern: ^[0-9A-Z]{12}[0-9]{2}$ rel: type: string enum: - CNPJ required: - identification required: - document required: - creditors required: - data responses: '200': description: Consentimento de pagamento recorrente atualizado com sucesso content: application/json: schema: type: object properties: data: type: object properties: recurringConsentId: type: string maxLength: 256 pattern: >- ^urn:[a-zA-Z0-9][a-zA-Z0-9-]{0,31}:[a-zA-Z0-9()+,-.:=@;$_!*'%/?#]+$ statusUpdateDateTime: type: string maxLength: 20 pattern: >- ^(\d{4})-(1[0-2]|0?[1-9])-(3[01]|[12][0-9]|0?[1-9])T(?:[01]\d|2[0123]):(?:[012345]\d):(?:[012345]\d)Z$ loggedUser: type: object properties: document: type: object properties: identification: type: string maxLength: 11 pattern: ^\d{11}$ rel: type: string maxLength: 3 pattern: ^[A-Z]{3}$ required: - identification - rel required: - document businessEntity: type: object properties: document: type: object properties: identification: type: string maxLength: 14 pattern: ^[0-9A-Z]{12}[0-9]{2}$ rel: type: string maxLength: 4 pattern: ^[A-Z]{4}$ required: - identification - rel required: - document status: type: string enum: *ref_7 creditors: type: array items: type: object properties: personType: type: string enum: *ref_1 cpfCnpj: type: string minLength: 11 maxLength: 14 pattern: ^([0-9]{11})$|^([0-9A-Z]{12}[0-9]{2})$ name: type: string maxLength: 120 pattern: ^([A-Za-zÀ-ÖØ-öø-ÿ,.@:&*+_<>()!?/\\$%\d' -]+)$ required: - personType - cpfCnpj - name minItems: 1 creationDateTime: type: string maxLength: 20 pattern: >- ^(\d{4})-(1[0-2]|0?[1-9])-(3[01]|[12][0-9]|0?[1-9])T(?:[01]\d|2[0123]):(?:[012345]\d):(?:[012345]\d)Z$ expirationDateTime: type: string maxLength: 20 pattern: >- ^(\d{4})-(1[0-2]|0?[1-9])-(3[01]|[12][0-9]|0?[1-9])T(?:[01]\d|2[0123]):(?:[012345]\d):(?:[012345]\d)Z$ additionalInformation: type: string maxLength: 140 pattern: '[\w\W\s]*' debtorAccount: type: object properties: ispb: type: string minLength: 8 maxLength: 8 pattern: ^[0-9A-Z]{8}$ issuer: type: string minLength: 1 maxLength: 4 pattern: ^[0-9]{1,4}$ number: type: string minLength: 1 maxLength: 20 pattern: ^[0-9]{1,20}$ accountType: type: string enum: *ref_0 required: - ispb - number - accountType rejection: type: object properties: rejectedBy: type: string enum: *ref_2 rejectedFrom: type: string enum: *ref_3 rejectedAt: type: string maxLength: 20 pattern: >- ^(\d{4})-(1[0-2]|0?[1-9])-(3[01]|[12][0-9]|0?[1-9])T(?:[01]\d|2[0123]):(?:[012345]\d):(?:[012345]\d)Z$ reason: type: object properties: code: type: string enum: *ref_8 detail: type: string maxLength: 2048 pattern: '[\w\W\s]*' required: - code - detail required: - rejectedBy - rejectedFrom - rejectedAt - reason revocation: type: object properties: revokedBy: type: string enum: *ref_2 revokedFrom: type: string enum: *ref_3 revokedAt: type: string maxLength: 20 pattern: >- ^(\d{4})-(1[0-2]|0?[1-9])-(3[01]|[12][0-9]|0?[1-9])T(?:[01]\d|2[0123]):(?:[012345]\d):(?:[012345]\d)Z$ reason: type: object properties: code: type: string enum: *ref_9 detail: type: string maxLength: 2048 pattern: '[\w\W\s]*' required: - code - detail required: - revokedBy - revokedFrom - revokedAt - reason recurringConfiguration: anyOf: - type: object properties: automatic: type: object properties: contractId: type: string minLength: 1 maxLength: 35 pattern: ^[a-zA-Z0-9]{1,35}$ fixedAmount: type: string minLength: 4 maxLength: 19 pattern: ^((\d{1,16}\.\d{2}))$ maximumVariableAmount: type: string minLength: 4 maxLength: 19 pattern: ^((\d{1,16}\.\d{2}))$ interval: type: string enum: *ref_4 contractDebtor: type: object properties: name: type: string maxLength: 120 pattern: >- ^([A-Za-zÀ-ÖØ-öø-ÿ,.@:&*+_<>()!?/\\$%\d' -]+)$ document: type: object properties: identification: type: string minLength: 11 maxLength: 14 pattern: ^([0-9]{11})$|^([0-9A-Z]{12}[0-9]{2})$ rel: type: string enum: *ref_5 required: - identification - rel required: - name - document firstPayment: type: object properties: type: type: string enum: *ref_6 date: type: string maxLength: 10 pattern: >- ^(\d{4})-(1[0-2]|0?[1-9])-(3[01]|[12][0-9]|0?[1-9])$ currency: type: string maxLength: 3 pattern: ^([A-Z]{3})$ amount: type: string minLength: 4 maxLength: 19 pattern: ^((\d{1,16}\.\d{2}))$ remittanceInformation: type: string maxLength: 140 pattern: '[\w\W\s]*' creditorAccount: type: object properties: ispb: type: string minLength: 8 maxLength: 8 pattern: ^[0-9A-Z]{8}$ issuer: type: string minLength: 1 maxLength: 4 pattern: ^[0-9]{1,4}$ number: type: string minLength: 1 maxLength: 20 pattern: ^[0-9]{1,20}$ accountType: type: string enum: *ref_0 required: - ispb - number - accountType required: - type - date - currency - amount - creditorAccount minimumVariableAmount: type: string minLength: 4 maxLength: 19 pattern: ^((\d{1,16}\.\d{2}))$ isRetryAccepted: type: boolean useOverdraftLimit: type: boolean default: true referenceStartDate: type: string pattern: >- ^(\d{4})-(1[0-2]|0?[1-9])-(3[01]|[12][0-9]|0?[1-9])$ required: - interval - contractDebtor - isRetryAccepted - referenceStartDate required: - automatic - type: object properties: sweeping: type: object properties: totalAllowedAmount: type: string minLength: 4 maxLength: 19 pattern: ^((\d{1,16}\.\d{2}))$ transactionLimit: type: string minLength: 4 maxLength: 19 pattern: ^((\d{1,16}\.\d{2}))$ periodicLimits: type: object properties: day: type: object properties: quantityLimit: type: integer minimum: 1 transactionLimit: type: string minLength: 4 maxLength: 19 pattern: ^((\d{1,16}\.\d{2}))$ week: type: object properties: quantityLimit: type: integer minimum: 1 transactionLimit: type: string minLength: 4 maxLength: 19 pattern: ^((\d{1,16}\.\d{2}))$ month: type: object properties: quantityLimit: type: integer minimum: 1 transactionLimit: type: string minLength: 4 maxLength: 19 pattern: ^((\d{1,16}\.\d{2}))$ year: type: object properties: quantityLimit: type: integer minimum: 1 transactionLimit: type: string minLength: 4 maxLength: 19 pattern: ^((\d{1,16}\.\d{2}))$ useOverdraftLimit: type: boolean default: true startDateTime: type: string pattern: >- ^(\d{4})-(1[0-2]|0?[1-9])-(3[01]|[12][0-9]|0?[1-9])T(?:[01]\d|2[0123]):(?:[012345]\d):(?:[012345]\d)Z$ required: - startDateTime required: - sweeping - type: object properties: vrp: type: object properties: transactionLimit: type: string minLength: 4 maxLength: 19 pattern: ^((\d{1,16}\.\d{2}))$ globalLimits: type: object properties: quantityLimit: type: integer transactionLimit: type: string minLength: 4 maxLength: 19 pattern: ^((\d{1,16}\.\d{2}))$ periodicLimits: type: object properties: day: type: object properties: quantityLimit: type: integer minimum: 1 transactionLimit: type: string minLength: 4 maxLength: 19 pattern: ^((\d{1,16}\.\d{2}))$ week: type: object properties: quantityLimit: type: integer minimum: 1 transactionLimit: type: string minLength: 4 maxLength: 19 pattern: ^((\d{1,16}\.\d{2}))$ month: type: object properties: quantityLimit: type: integer minimum: 1 transactionLimit: type: string minLength: 4 maxLength: 19 pattern: ^((\d{1,16}\.\d{2}))$ year: type: object properties: quantityLimit: type: integer minimum: 1 transactionLimit: type: string minLength: 4 maxLength: 19 pattern: ^((\d{1,16}\.\d{2}))$ required: - vrp authorisedAtDateTime: type: string minLength: 20 maxLength: 20 pattern: >- ^(\d{4})-(1[0-2]|0?[1-9])-(3[01]|[12][0-9]|0?[1-9])T(?:[01]\d|2[0123]):(?:[012345]\d):(?:[012345]\d)Z$ updatedAtDateTime: type: string minLength: 20 maxLength: 20 pattern: >- ^(\d{4})-(1[0-2]|0?[1-9])-(3[01]|[12][0-9]|0?[1-9])T(?:[01]\d|2[0123]):(?:[012345]\d):(?:[012345]\d)Z$ journey: type: object properties: isLinked: type: boolean linkId: type: string approvalDueDate: type: string pattern: ^(\d{4})-(1[0-2]|0?[1-9])-(3[01]|[12][0-9]|0?[1-9])$ required: - recurringConsentId - statusUpdateDateTime - loggedUser - status - creditors - creationDateTime - recurringConfiguration links: type: object properties: self: type: string maxLength: 2000 pattern: >- ^(https:\/\/)?(www\.)?[-a-zA-Z0-9@:%._\+~#=]{2,256}\.[a-z]{2,6}\b([-a-zA-Z0-9@:%_\+.~#?&\/\/=]*)$ required: - self meta: type: object properties: requestDateTime: type: string maxLength: 20 format: date-time required: - requestDateTime required: - data - links - meta /automatic-payments/v2/pix/recurring-payments: post: description: Cria iniciação de pagamento recorrente Pix tags: - Pagamento Recorrente parameters: - schema: type: string description: Authorisation server que vai receber a requisição required: true description: Authorisation server que vai receber a requisição name: x-authorisation-server-id in: header - schema: type: string description: Token FCamara required: true description: Token FCamara name: authorization in: header - schema: type: string description: Indica o user-agent que o usuário utiliza required: true description: Indica o user-agent que o usuário utiliza name: x-customer-user-agent in: header requestBody: required: true content: application/json: schema: type: object properties: data: type: object properties: recurringConsentId: type: string maxLength: 256 pattern: >- ^urn:[a-zA-Z0-9][a-zA-Z0-9-]{0,31}:[a-zA-Z0-9()+,-.:=@;$_!*'%/?#]+$ endToEndId: type: string minLength: 32 maxLength: 32 pattern: >- ^([E])([0-9A-Z]{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})$ date: type: string maxLength: 10 pattern: ^(\d{4})-(1[0-2]|0?[1-9])-(3[01]|[12][0-9]|0?[1-9])$ payment: type: object properties: amount: type: string minLength: 4 maxLength: 19 pattern: ^((\d{1,16}\.\d{2}))$ currency: type: string maxLength: 3 pattern: ^([A-Z]{3})$ required: - amount - currency creditorAccount: type: object properties: ispb: type: string minLength: 8 maxLength: 8 pattern: ^[0-9A-Z]{8}$ issuer: type: string minLength: 1 maxLength: 4 pattern: ^[0-9]{1,4}$ number: type: string minLength: 1 maxLength: 20 pattern: ^[0-9]{1,20}$ accountType: type: string enum: &ref_13 - CACC - SVGS - TRAN required: - ispb - number - accountType remittanceInformation: type: string maxLength: 140 pattern: '[\w\W\s]*' cnpjInitiator: type: string maxLength: 14 pattern: ^[0-9A-Z]{12}[0-9]{2}$ ibgeTownCode: type: string minLength: 7 maxLength: 7 pattern: ^\d{7}$ authorisationFlow: type: string enum: &ref_11 - HYBRID_FLOW - CIBA_FLOW - FIDO_FLOW riskSignals: type: object properties: manual: type: object properties: deviceId: type: string isRootedDevice: type: boolean screenBrightness: type: number elapsedTimeSinceBoot: type: integer osVersion: type: string userTimeZoneOffset: type: string language: type: string screenDimensions: type: object properties: height: type: integer width: type: integer required: - height - width accountTenure: type: string pattern: >- ^(\d{4})-(1[0-2]|0?[1-9])-(3[01]|[12][0-9]|0?[1-9])$ geolocation: type: object properties: latitude: type: number longitude: type: number type: type: string enum: *ref_10 isCallInProgress: type: boolean isDevModeEnabled: type: boolean isMockGPS: type: boolean isEmulated: type: boolean isMonkeyRunner: type: boolean isCharging: type: boolean antennaInformation: type: string isUsbConnected: type: boolean integrity: type: object properties: appRecognitionVerdict: type: string deviceRecognitionVerdict: type: string required: - deviceId - osVersion - userTimeZoneOffset - language - screenDimensions - accountTenure automatic: type: object properties: lastLoginDateTime: type: string pattern: >- ^(\d{4})-(1[0-2]|0?[1-9])-(3[01]|[12][0-9]|0?[1-9])T(?:[01]\d|2[0123]):(?:[012345]\d):(?:[012345]\d)Z$ pixKeyRegistrationDateTime: type: string pattern: >- ^(\d{4})-(1[0-2]|0?[1-9])-(3[01]|[12][0-9]|0?[1-9])T(?:[01]\d|2[0123]):(?:[012345]\d):(?:[012345]\d)Z$ required: - lastLoginDateTime localInstrument: type: string enum: &ref_12 - MANU - DICT - INIC - AUTO proxy: type: string pattern: '[\w\W\s]*' transactionIdentification: type: string maxLength: 35 pattern: ^[a-zA-Z0-9]{1,35}$ document: type: object properties: identification: type: string minLength: 11 maxLength: 14 pattern: ^([0-9]{11})$|^([0-9A-Z]{12}[0-9]{2})$ rel: type: string enum: *ref_5 required: - identification - rel paymentReference: type: string required: - endToEndId - date - payment - creditorAccount - cnpjInitiator - localInstrument - document required: - data responses: '201': description: Iniciação de pagamento recorrente Pix criada com sucesso content: application/json: schema: type: object properties: data: type: object properties: recurringPaymentId: type: string minLength: 1 maxLength: 100 pattern: ^[a-zA-Z0-9][a-zA-Z0-9-]{0,99}$ recurringConsentId: type: string maxLength: 256 pattern: >- ^urn:[a-zA-Z0-9][a-zA-Z0-9-]{0,31}:[a-zA-Z0-9()+,-.:=@;$_!*'%/?#]+$ endToEndId: type: string minLength: 32 maxLength: 32 pattern: >- ^([E])([0-9A-Z]{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})$ date: type: string maxLength: 10 pattern: ^(\d{4})-(1[0-2]|0?[1-9])-(3[01]|[12][0-9]|0?[1-9])$ creationDateTime: type: string maxLength: 20 pattern: >- ^(\d{4})-(1[0-2]|0?[1-9])-(3[01]|[12][0-9]|0?[1-9])T(?:[01]\d|2[0123]):(?:[012345]\d):(?:[012345]\d)Z$ statusUpdateDateTime: type: string maxLength: 20 pattern: >- ^(\d{4})-(1[0-2]|0?[1-9])-(3[01]|[12][0-9]|0?[1-9])T(?:[01]\d|2[0123]):(?:[012345]\d):(?:[012345]\d)Z$ status: type: string enum: &ref_14 - RCVD - CANC - ACCP - ACPD - RJCT - ACSC - PDNG - SCHD rejectionReason: type: object properties: code: type: string enum: &ref_15 - SALDO_INSUFICIENTE - VALOR_ACIMA_LIMITE - VALOR_INVALIDO - NAO_INFORMADO - PAGAMENTO_DIVERGENTE_CONSENTIMENTO - PAGAMENTO_RECUSADO_DETENTORA - PAGAMENTO_RECUSADO_SPI - FALHA_INFRAESTRUTURA_SPI - FALHA_INFRAESTRUTURA_ICP - FALHA_INFRAESTRUTURA_PSP_RECEBEDOR - FALHA_INFRAESTRUTURA_DETENTORA - CONSENTIMENTO_INVALIDO - TITULARIDADE_INCONSISTENTE - LIMITE_PERIODO_VALOR_EXCEDIDO - LIMITE_PERIODO_QUANTIDADE_EXCEDIDO - LIMITE_VALOR_TOTAL_CONSENTIMENTO_EXCEDIDO - LIMITE_VALOR_TRANSACAO_CONSENTIMENTO_EXCEDIDO - LIMITE_TENTATIVAS_EXCEDIDO - FORA_PRAZO_PERMITIDO - DETALHE_TENTATIVA_INVALIDO - DETALHE_PAGAMENTO_INVALIDO detail: type: string maxLength: 2048 pattern: '[\w\W\s]*' required: - code - detail cnpjInitiator: type: string maxLength: 14 pattern: ^[0-9A-Z]{12}[0-9]{2}$ payment: type: object properties: amount: type: string minLength: 4 maxLength: 19 pattern: ^((\d{1,16}\.\d{2}))$ currency: type: string maxLength: 3 pattern: ^([A-Z]{3})$ required: - amount - currency remittanceInformation: type: string maxLength: 140 pattern: '[\w\W\s]*' debtorAccount: type: object properties: ispb: type: string minLength: 8 maxLength: 8 pattern: ^[0-9A-Z]{8}$ issuer: type: string minLength: 1 maxLength: 4 pattern: ^[0-9]{1,4}$ number: type: string minLength: 1 maxLength: 20 pattern: ^[0-9]{1,20}$ accountType: type: string enum: *ref_0 required: - ispb - number - accountType authorisationFlow: type: string enum: *ref_11 localInstrument: type: string enum: *ref_12 proxy: type: string pattern: '[\w\W\s]*' transactionIdentification: type: string maxLength: 35 pattern: ^[a-zA-Z0-9]{1,35}$ document: type: object properties: identification: type: string minLength: 11 maxLength: 14 pattern: ^([0-9]{11})$|^([0-9A-Z]{12}[0-9]{2})$ rel: type: string enum: *ref_5 required: - identification - rel paymentReference: type: string creditorAccount: type: object properties: ispb: type: string minLength: 8 maxLength: 8 pattern: ^[0-9A-Z]{8}$ issuer: type: string minLength: 1 maxLength: 4 pattern: ^[0-9]{1,4}$ number: type: string minLength: 1 maxLength: 20 pattern: ^[0-9]{1,20}$ accountType: type: string enum: *ref_13 required: - ispb - number - accountType required: - recurringPaymentId - endToEndId - date - creationDateTime - statusUpdateDateTime - status - cnpjInitiator - payment - localInstrument - document - creditorAccount links: type: object properties: self: type: string maxLength: 2000 pattern: >- ^(https:\/\/)?(www\.)?[-a-zA-Z0-9@:%._\+~#=]{2,256}\.[a-z]{2,6}\b([-a-zA-Z0-9@:%_\+.~#?&\/\/=]*)$ required: - self meta: type: object properties: requestDateTime: type: string maxLength: 20 format: date-time required: - requestDateTime required: - data - links - meta get: description: Consultar pagamentos recorrentes Pix associados a um consentimento tags: - Pagamento Recorrente parameters: - schema: type: string description: ID do consentimento recorrente required: true name: recurringConsentId in: query - schema: type: string description: Data inicial do período de busca required: false name: startDate in: query - schema: type: string description: Data final do período de busca required: false name: endDate in: query - schema: type: string description: ID da tentativa de pagamento original required: false name: originalRecurringPaymentId in: query - schema: type: string description: Authorisation server que vai receber a requisição required: true description: Authorisation server que vai receber a requisição name: x-authorisation-server-id in: header - schema: type: string description: Token FCamara required: true description: Token FCamara name: authorization in: header - schema: type: string description: Indica o user-agent que o usuário utiliza required: true description: Indica o user-agent que o usuário utiliza name: x-customer-user-agent in: header responses: '200': description: Pagamentos recorrentes Pix obtidos com sucesso content: application/json: schema: type: object properties: data: type: array items: type: object properties: recurringPaymentId: type: string minLength: 1 maxLength: 100 pattern: ^[a-zA-Z0-9][a-zA-Z0-9-]{0,99}$ recurringConsentId: type: string maxLength: 256 pattern: >- ^urn:[a-zA-Z0-9][a-zA-Z0-9-]{0,31}:[a-zA-Z0-9()+,-.:=@;$_!*'%/?#]+$ endToEndId: type: string minLength: 32 maxLength: 32 pattern: >- ^([E])([0-9A-Z]{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})$ date: type: string maxLength: 10 pattern: ^(\d{4})-(1[0-2]|0?[1-9])-(3[01]|[12][0-9]|0?[1-9])$ creationDateTime: type: string maxLength: 20 pattern: >- ^(\d{4})-(1[0-2]|0?[1-9])-(3[01]|[12][0-9]|0?[1-9])T(?:[01]\d|2[0123]):(?:[012345]\d):(?:[012345]\d)Z$ statusUpdateDateTime: type: string maxLength: 20 pattern: >- ^(\d{4})-(1[0-2]|0?[1-9])-(3[01]|[12][0-9]|0?[1-9])T(?:[01]\d|2[0123]):(?:[012345]\d):(?:[012345]\d)Z$ status: type: string enum: *ref_14 rejectionReason: type: object properties: code: type: string enum: - SALDO_INSUFICIENTE - VALOR_ACIMA_LIMITE - VALOR_INVALIDO - NAO_INFORMADO - PAGAMENTO_DIVERGENTE_CONSENTIMENTO - PAGAMENTO_RECUSADO_DETENTORA - PAGAMENTO_RECUSADO_SPI - CONSENTIMENTO_INVALIDO - FALHA_INFRAESTRUTURA_SPI - FALHA_INFRAESTRUTURA_ICP - FALHA_INFRAESTRUTURA_PSP_RECEBEDOR - FALHA_INFRAESTRUTURA_DETENTORA - LIMITE_PERIODO_VALOR_EXCEDIDO - LIMITE_PERIODO_QUANTIDADE_EXCEDIDO - TITULARIDADE_INCONSISTENTE - LIMITE_VALOR_TOTAL_CONSENTIMENTO_EXCEDIDO - LIMITE_VALOR_TRANSACAO_CONSENTIMENTO_EXCEDIDO - LIMITE_TENTATIVAS_EXCEDIDO - FORA_PRAZO_PERMITIDO - DETALHE_TENTATIVA_INVALIDO - DETALHE_PAGAMENTO_INVALIDO detail: type: string maxLength: 2048 pattern: '[\w\W\s]*' required: - code - detail payment: type: object properties: amount: type: string minLength: 4 maxLength: 19 pattern: ^((\d{1,16}\.\d{2}))$ currency: type: string maxLength: 3 pattern: ^([A-Z]{3})$ required: - amount - currency remittanceInformation: type: string maxLength: 140 pattern: '[\w\W\s]*' transactionIdentification: type: string maxLength: 35 pattern: ^[a-zA-Z0-9]{1,35}$ document: type: object properties: identification: type: string minLength: 11 maxLength: 14 pattern: ^([0-9]{11})$|^([0-9A-Z]{12}[0-9]{2})$ rel: type: string enum: *ref_5 required: - identification - rel paymentReference: type: string originalRecurringPaymentId: type: string minLength: 1 maxLength: 100 pattern: ^[a-zA-Z0-9][a-zA-Z0-9-]{0,99}$ required: - recurringPaymentId - endToEndId - date - creationDateTime - statusUpdateDateTime - status - payment - document links: type: object properties: self: type: string maxLength: 2000 pattern: >- ^(https:\/\/)?(www\.)?[-a-zA-Z0-9@:%._\+~#=]{2,256}\.[a-z]{2,6}\b([-a-zA-Z0-9@:%_\+.~#?&\/\/=]*)$ required: - self meta: type: object properties: requestDateTime: type: string maxLength: 20 format: date-time required: - requestDateTime required: - data - links - meta /automatic-payments/v2/pix/recurring-payments/{originalRecurringPaymentId}/retry: post: description: >- Cria nova tentativa de pagamento recorrente Pix para uma tentativa original que falhou tags: - Pagamento Recorrente parameters: - schema: type: string description: ID da tentativa de pagamento original required: true name: originalRecurringPaymentId in: path - schema: type: string description: Authorisation server que vai receber a requisição required: true description: Authorisation server que vai receber a requisição name: x-authorisation-server-id in: header - schema: type: string description: Token FCamara required: true description: Token FCamara name: authorization in: header - schema: type: string description: Indica o user-agent que o usuário utiliza required: true description: Indica o user-agent que o usuário utiliza name: x-customer-user-agent in: header requestBody: required: true content: application/json: schema: type: object properties: data: type: object properties: endToEndId: type: string minLength: 32 maxLength: 32 pattern: >- ^([E])([0-9A-Z]{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})$ date: type: string maxLength: 10 pattern: ^(\d{4})-(1[0-2]|0?[1-9])-(3[01]|[12][0-9]|0?[1-9])$ required: - endToEndId - date required: - data responses: '201': description: Nova tentativa de pagamento recorrente Pix criada com sucesso content: application/json: schema: type: object properties: data: type: object properties: recurringPaymentId: type: string minLength: 1 maxLength: 100 pattern: ^[a-zA-Z0-9][a-zA-Z0-9-]{0,99}$ endToEndId: type: string minLength: 32 maxLength: 32 pattern: >- ^([E])([0-9A-Z]{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})$ date: type: string maxLength: 10 pattern: ^(\d{4})-(1[0-2]|0?[1-9])-(3[01]|[12][0-9]|0?[1-9])$ status: type: string enum: *ref_14 originalRecurringPaymentId: type: string minLength: 1 maxLength: 100 pattern: ^[a-zA-Z0-9][a-zA-Z0-9-]{0,99}$ required: - recurringPaymentId - endToEndId - date - status - originalRecurringPaymentId links: type: object properties: self: type: string maxLength: 2000 pattern: >- ^(https:\/\/)?(www\.)?[-a-zA-Z0-9@:%._\+~#=]{2,256}\.[a-z]{2,6}\b([-a-zA-Z0-9@:%_\+.~#?&\/\/=]*)$ required: - self meta: type: object properties: requestDateTime: type: string maxLength: 20 format: date-time required: - requestDateTime required: - data - links - meta /automatic-payments/v2/pix/recurring-payments/{recurringPaymentId}: get: description: Consultar iniciação de pagamento recorrente Pix tags: - Pagamento Recorrente parameters: - schema: type: string description: ID do pagamento recorrente required: true name: recurringPaymentId in: path - schema: type: string description: Authorisation server que vai receber a requisição required: true description: Authorisation server que vai receber a requisição name: x-authorisation-server-id in: header - schema: type: string description: Token FCamara required: true description: Token FCamara name: authorization in: header - schema: type: string description: Indica o user-agent que o usuário utiliza required: true description: Indica o user-agent que o usuário utiliza name: x-customer-user-agent in: header responses: '200': description: Dados de iniciação de pagamento recorrente Pix obtidos com sucesso content: application/json: schema: type: object properties: data: type: object properties: recurringPaymentId: type: string minLength: 1 maxLength: 100 pattern: ^[a-zA-Z0-9][a-zA-Z0-9-]{0,99}$ recurringConsentId: type: string maxLength: 256 pattern: >- ^urn:[a-zA-Z0-9][a-zA-Z0-9-]{0,31}:[a-zA-Z0-9()+,-.:=@;$_!*'%/?#]+$ endToEndId: type: string minLength: 32 maxLength: 32 pattern: >- ^([E])([0-9A-Z]{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})$ date: type: string maxLength: 10 pattern: ^(\d{4})-(1[0-2]|0?[1-9])-(3[01]|[12][0-9]|0?[1-9])$ creationDateTime: type: string maxLength: 20 pattern: >- ^(\d{4})-(1[0-2]|0?[1-9])-(3[01]|[12][0-9]|0?[1-9])T(?:[01]\d|2[0123]):(?:[012345]\d):(?:[012345]\d)Z$ statusUpdateDateTime: type: string maxLength: 20 pattern: >- ^(\d{4})-(1[0-2]|0?[1-9])-(3[01]|[12][0-9]|0?[1-9])T(?:[01]\d|2[0123]):(?:[012345]\d):(?:[012345]\d)Z$ status: type: string enum: *ref_14 rejectionReason: type: object properties: code: type: string enum: *ref_15 detail: type: string maxLength: 2048 pattern: '[\w\W\s]*' required: - code - detail cnpjInitiator: type: string maxLength: 14 pattern: ^[0-9A-Z]{12}[0-9]{2}$ payment: type: object properties: amount: type: string minLength: 4 maxLength: 19 pattern: ^((\d{1,16}\.\d{2}))$ currency: type: string maxLength: 3 pattern: ^([A-Z]{3})$ required: - amount - currency remittanceInformation: type: string maxLength: 140 pattern: '[\w\W\s]*' debtorAccount: type: object properties: ispb: type: string minLength: 8 maxLength: 8 pattern: ^[0-9A-Z]{8}$ issuer: type: string minLength: 1 maxLength: 4 pattern: ^[0-9]{1,4}$ number: type: string minLength: 1 maxLength: 20 pattern: ^[0-9]{1,20}$ accountType: type: string enum: *ref_0 required: - ispb - number - accountType authorisationFlow: type: string enum: *ref_11 localInstrument: type: string enum: *ref_12 proxy: type: string pattern: '[\w\W\s]*' transactionIdentification: type: string maxLength: 35 pattern: ^[a-zA-Z0-9]{1,35}$ document: type: object properties: identification: type: string minLength: 11 maxLength: 14 pattern: ^([0-9]{11})$|^([0-9A-Z]{12}[0-9]{2})$ rel: type: string enum: *ref_5 required: - identification - rel paymentReference: type: string creditorAccount: type: object properties: ispb: type: string minLength: 8 maxLength: 8 pattern: ^[0-9A-Z]{8}$ issuer: type: string minLength: 1 maxLength: 4 pattern: ^[0-9]{1,4}$ number: type: string minLength: 1 maxLength: 20 pattern: ^[0-9]{1,20}$ accountType: type: string enum: *ref_13 required: - ispb - number - accountType cancellation: type: object properties: reason: type: string enum: &ref_16 - CANCELADO_PENDENCIA - CANCELADO_AGENDAMENTO cancelledFrom: type: string enum: &ref_17 - INICIADORA - DETENTORA cancelledAt: type: string maxLength: 20 pattern: >- ^(\d{4})-(1[0-2]|0?[1-9])-(3[01]|[12][0-9]|0?[1-9])T(?:[01]\d|2[0123]):(?:[012345]\d):(?:[012345]\d)Z$ cancelledBy: type: object properties: document: type: object properties: identification: type: string minLength: 11 maxLength: 14 pattern: ^([0-9]{11})$|^([0-9A-Z]{12}[0-9]{2})$ rel: type: string enum: *ref_5 required: - identification - rel required: - document required: - reason - cancelledFrom - cancelledAt - cancelledBy originalRecurringPaymentId: type: string minLength: 1 maxLength: 100 pattern: ^[a-zA-Z0-9][a-zA-Z0-9-]{0,99}$ required: - recurringPaymentId - endToEndId - date - creationDateTime - statusUpdateDateTime - status - cnpjInitiator - payment - localInstrument - document links: type: object properties: self: type: string maxLength: 2000 pattern: >- ^(https:\/\/)?(www\.)?[-a-zA-Z0-9@:%._\+~#=]{2,256}\.[a-z]{2,6}\b([-a-zA-Z0-9@:%_\+.~#?&\/\/=]*)$ required: - self meta: type: object properties: requestDateTime: type: string maxLength: 20 format: date-time required: - requestDateTime required: - data - links - meta patch: description: Cancelar iniciação de pagamento recorrente Pix tags: - Pagamento Recorrente parameters: - schema: type: string description: ID do pagamento recorrente required: true name: recurringPaymentId in: path - schema: type: string description: Authorisation server que vai receber a requisição required: true description: Authorisation server que vai receber a requisição name: x-authorisation-server-id in: header - schema: type: string description: Token FCamara required: true description: Token FCamara name: authorization in: header - schema: type: string description: Indica o user-agent que o usuário utiliza required: true description: Indica o user-agent que o usuário utiliza name: x-customer-user-agent in: header requestBody: required: true content: application/json: schema: type: object properties: data: type: object properties: status: type: string enum: - CANC cancellation: type: object properties: cancelledBy: type: object properties: document: type: object properties: identification: type: string minLength: 11 maxLength: 14 pattern: ^([0-9]{11})$|^([0-9A-Z]{12}[0-9]{2})$ rel: type: string enum: *ref_5 required: - identification - rel required: - document required: - cancelledBy required: - status - cancellation required: - data responses: '200': description: Iniciação de pagamento recorrente Pix cancelada com sucesso content: application/json: schema: type: object properties: data: type: object properties: recurringPaymentId: type: string minLength: 1 maxLength: 100 pattern: ^[a-zA-Z0-9][a-zA-Z0-9-]{0,99}$ recurringConsentId: type: string maxLength: 256 pattern: >- ^urn:[a-zA-Z0-9][a-zA-Z0-9-]{0,31}:[a-zA-Z0-9()+,-.:=@;$_!*'%/?#]+$ endToEndId: type: string minLength: 32 maxLength: 32 pattern: >- ^([E])([0-9A-Z]{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})$ date: type: string maxLength: 10 pattern: ^(\d{4})-(1[0-2]|0?[1-9])-(3[01]|[12][0-9]|0?[1-9])$ creationDateTime: type: string maxLength: 20 pattern: >- ^(\d{4})-(1[0-2]|0?[1-9])-(3[01]|[12][0-9]|0?[1-9])T(?:[01]\d|2[0123]):(?:[012345]\d):(?:[012345]\d)Z$ statusUpdateDateTime: type: string maxLength: 20 pattern: >- ^(\d{4})-(1[0-2]|0?[1-9])-(3[01]|[12][0-9]|0?[1-9])T(?:[01]\d|2[0123]):(?:[012345]\d):(?:[012345]\d)Z$ status: type: string enum: *ref_14 rejectionReason: type: object properties: code: type: string enum: *ref_15 detail: type: string maxLength: 2048 pattern: '[\w\W\s]*' required: - code - detail cnpjInitiator: type: string maxLength: 14 pattern: ^[0-9A-Z]{12}[0-9]{2}$ payment: type: object properties: amount: type: string minLength: 4 maxLength: 19 pattern: ^((\d{1,16}\.\d{2}))$ currency: type: string maxLength: 3 pattern: ^([A-Z]{3})$ required: - amount - currency remittanceInformation: type: string maxLength: 140 pattern: '[\w\W\s]*' debtorAccount: type: object properties: ispb: type: string minLength: 8 maxLength: 8 pattern: ^[0-9A-Z]{8}$ issuer: type: string minLength: 1 maxLength: 4 pattern: ^[0-9]{1,4}$ number: type: string minLength: 1 maxLength: 20 pattern: ^[0-9]{1,20}$ accountType: type: string enum: *ref_0 required: - ispb - number - accountType authorisationFlow: type: string enum: *ref_11 localInstrument: type: string enum: *ref_12 proxy: type: string pattern: '[\w\W\s]*' transactionIdentification: type: string maxLength: 35 pattern: ^[a-zA-Z0-9]{1,35}$ document: type: object properties: identification: type: string minLength: 11 maxLength: 14 pattern: ^([0-9]{11})$|^([0-9A-Z]{12}[0-9]{2})$ rel: type: string enum: *ref_5 required: - identification - rel paymentReference: type: string creditorAccount: type: object properties: ispb: type: string minLength: 8 maxLength: 8 pattern: ^[0-9A-Z]{8}$ issuer: type: string minLength: 1 maxLength: 4 pattern: ^[0-9]{1,4}$ number: type: string minLength: 1 maxLength: 20 pattern: ^[0-9]{1,20}$ accountType: type: string enum: *ref_13 required: - ispb - number - accountType cancellation: type: object properties: reason: type: string enum: *ref_16 cancelledFrom: type: string enum: *ref_17 cancelledAt: type: string maxLength: 20 pattern: >- ^(\d{4})-(1[0-2]|0?[1-9])-(3[01]|[12][0-9]|0?[1-9])T(?:[01]\d|2[0123]):(?:[012345]\d):(?:[012345]\d)Z$ cancelledBy: type: object properties: document: type: object properties: identification: type: string minLength: 11 maxLength: 14 pattern: ^([0-9]{11})$|^([0-9A-Z]{12}[0-9]{2})$ rel: type: string enum: *ref_5 required: - identification - rel required: - document required: - reason - cancelledFrom - cancelledAt - cancelledBy originalRecurringPaymentId: type: string minLength: 1 maxLength: 100 pattern: ^[a-zA-Z0-9][a-zA-Z0-9-]{0,99}$ required: - recurringPaymentId - endToEndId - date - creationDateTime - statusUpdateDateTime - status - cnpjInitiator - payment - localInstrument - document links: type: object properties: self: type: string maxLength: 2000 pattern: >- ^(https:\/\/)?(www\.)?[-a-zA-Z0-9@:%._\+~#=]{2,256}\.[a-z]{2,6}\b([-a-zA-Z0-9@:%_\+.~#?&\/\/=]*)$ required: - self meta: type: object properties: requestDateTime: type: string maxLength: 20 format: date-time required: - requestDateTime required: - data - links - meta