# Functions
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
# Constants
OpenbankingBrasilPaymentCodeDATAPGTOINVALIDA captures enum value "DATA_PGTO_INVALIDA".
OpenbankingBrasilPaymentCodeDETALHEPGTOINVALIDO captures enum value "DETALHE_PGTO_INVALIDO".
OpenbankingBrasilPaymentCodeFORMAPGTOINVALIDA captures enum value "FORMA_PGTO_INVALIDA".
OpenbankingBrasilPaymentCodeNAOINFORMADO captures enum value "NAO_INFORMADO".
OpenbankingBrasilPaymentEnumAccountPaymentsTypeCACC captures enum value "CACC".
OpenbankingBrasilPaymentEnumAccountPaymentsTypeSLRY captures enum value "SLRY".
OpenbankingBrasilPaymentEnumAccountPaymentsTypeSVGS captures enum value "SVGS".
OpenbankingBrasilPaymentEnumAccountPaymentsTypeTRAN captures enum value "TRAN".
OpenbankingBrasilPaymentEnumAuthorisationPatchStatusTypeREVOKED captures enum value "REVOKED".
OpenbankingBrasilPaymentEnumAuthorisationStatusTypeAUTHORISED captures enum value "AUTHORISED".
OpenbankingBrasilPaymentEnumAuthorisationStatusTypeAWAITINGAUTHORISATION captures enum value "AWAITING_AUTHORISATION".
OpenbankingBrasilPaymentEnumAuthorisationStatusTypeCONSUMED captures enum value "CONSUMED".
OpenbankingBrasilPaymentEnumAuthorisationStatusTypeREJECTED captures enum value "REJECTED".
OpenbankingBrasilPaymentEnumAuthorisationStatusTypeREVOKED captures enum value "REVOKED".
OpenbankingBrasilPaymentEnumErrorsCreatePaymentBENEFICIARIOINCOMPATIVEL captures enum value "BENEFICIARIO_INCOMPATIVEL".
OpenbankingBrasilPaymentEnumErrorsCreatePaymentCOBRANCAINVALIDA captures enum value "COBRANCA_INVALIDA".
OpenbankingBrasilPaymentEnumErrorsCreatePaymentCONSENTIMENTOINVALIDO captures enum value "CONSENTIMENTO_INVALIDO".
OpenbankingBrasilPaymentEnumErrorsCreatePaymentJANELAOPERINVALIDA captures enum value "JANELA_OPER_INVALIDA".
OpenbankingBrasilPaymentEnumErrorsCreatePaymentNAOINFORMADO captures enum value "NAO_INFORMADO".
OpenbankingBrasilPaymentEnumErrorsCreatePaymentPAGAMENTODIVERGENTEDOCONSENTIMENTO captures enum value "PAGAMENTO_DIVERGENTE_DO_CONSENTIMENTO".
OpenbankingBrasilPaymentEnumErrorsCreatePaymentSALDOINSUFICIENTE captures enum value "SALDO_INSUFICIENTE".
OpenbankingBrasilPaymentEnumErrorsCreatePaymentVALORACIMALIMITE captures enum value "VALOR_ACIMA_LIMITE".
OpenbankingBrasilPaymentEnumErrorsCreatePaymentVALORINCOMPATIVEL captures enum value "VALOR_INCOMPATIVEL".
OpenbankingBrasilPaymentEnumErrorsCreatePaymentVALORINVALIDO captures enum value "VALOR_INVALIDO".
OpenbankingBrasilPaymentEnumErrorsPatchConsentINFORMACAOADICIONALREVOGACAOREQUERIDA captures enum value "INFORMACAO_ADICIONAL_REVOGACAO_REQUERIDA".
OpenbankingBrasilPaymentEnumErrorsPatchConsentINFORMACAOUSUARIOREQUERIDA captures enum value "INFORMACAO_USUARIO_REQUERIDA".
OpenbankingBrasilPaymentEnumErrorsPatchConsentMOTIVOREVOGACAONAOPERMITIDO captures enum value "MOTIVO_REVOGACAO_NAO_PERMITIDO".
OpenbankingBrasilPaymentEnumErrorsPatchConsentOPERACAONAOPERMITIDASTATUS captures enum value "OPERACAO_NAO_PERMITIDA_STATUS".
OpenbankingBrasilPaymentEnumErrorsPatchConsentOPERACAONAOSUPORTADATIPOCONSENTIMENTO captures enum value "OPERACAO_NAO_SUPORTADA_TIPO_CONSENTIMENTO".
OpenbankingBrasilPaymentEnumErrorsPatchConsentTEMPOLIMITEREVOGACAOEXCEDIDO captures enum value "TEMPO_LIMITE_REVOGACAO_EXCEDIDO".
OpenbankingBrasilPaymentEnumLocalInstrumentDICT captures enum value "DICT".
OpenbankingBrasilPaymentEnumLocalInstrumentINIC captures enum value "INIC".
OpenbankingBrasilPaymentEnumLocalInstrumentMANU captures enum value "MANU".
OpenbankingBrasilPaymentEnumLocalInstrumentQRDN captures enum value "QRDN".
OpenbankingBrasilPaymentEnumLocalInstrumentQRES captures enum value "QRES".
OpenbankingBrasilPaymentEnumPaymentPersonTypePESSOAJURIDICA captures enum value "PESSOA_JURIDICA".
OpenbankingBrasilPaymentEnumPaymentPersonTypePESSOANATURAL captures enum value "PESSOA_NATURAL".
OpenbankingBrasilPaymentEnumPaymentStatusTypeACCC captures enum value "ACCC".
OpenbankingBrasilPaymentEnumPaymentStatusTypeACSC captures enum value "ACSC".
OpenbankingBrasilPaymentEnumPaymentStatusTypeACSP captures enum value "ACSP".
OpenbankingBrasilPaymentEnumPaymentStatusTypePART captures enum value "PART".
OpenbankingBrasilPaymentEnumPaymentStatusTypePDNG captures enum value "PDNG".
OpenbankingBrasilPaymentEnumPaymentStatusTypeRJCT captures enum value "RJCT".
OpenbankingBrasilPaymentEnumPaymentStatusTypeSASC captures enum value "SASC".
OpenbankingBrasilPaymentEnumPaymentStatusTypeSASP captures enum value "SASP".
OpenbankingBrasilPaymentEnumPaymentTypePIX captures enum value "PIX".
OpenbankingBrasilPaymentEnumRejectionReasonTypeABORTEDSETTLEMENTTIMEOUT captures enum value "ABORTED_SETTLEMENT_TIMEOUT".
OpenbankingBrasilPaymentEnumRejectionReasonTypeBLOCKEDACCOUNT captures enum value "BLOCKED_ACCOUNT".
OpenbankingBrasilPaymentEnumRejectionReasonTypeCLOSEDCREDITORACCOUNTNUMBER captures enum value "CLOSED_CREDITOR_ACCOUNT_NUMBER".
OpenbankingBrasilPaymentEnumRejectionReasonTypeCONSENTREVOKED captures enum value "CONSENT_REVOKED".
OpenbankingBrasilPaymentEnumRejectionReasonTypeCREDITORIDENTIFIERINCORRECT captures enum value "CREDITOR_IDENTIFIER_INCORRECT".
OpenbankingBrasilPaymentEnumRejectionReasonTypeDENIEDMULTIPLEAUTHORISATIONS captures enum value "DENIED_MULTIPLE_AUTHORISATIONS".
OpenbankingBrasilPaymentEnumRejectionReasonTypeELEMENTCONTENTFORMALLYINCORRECT captures enum value "ELEMENT_CONTENT_FORMALLY_INCORRECT".
OpenbankingBrasilPaymentEnumRejectionReasonTypeERRORCREDITORAGENT captures enum value "ERROR_CREDITOR_AGENT".
OpenbankingBrasilPaymentEnumRejectionReasonTypeEXPIREDBILL captures enum value "EXPIRED_BILL".
OpenbankingBrasilPaymentEnumRejectionReasonTypeEXPIREDMULTIPLEAUTHORISATIONS captures enum value "EXPIRED_MULTIPLE_AUTHORISATIONS".
OpenbankingBrasilPaymentEnumRejectionReasonTypeFORBIDDENRETURNPAYMENT captures enum value "FORBIDDEN_RETURN_PAYMENT".
OpenbankingBrasilPaymentEnumRejectionReasonTypeINCOMPATIBLEDATE captures enum value "INCOMPATIBLE_DATE".
OpenbankingBrasilPaymentEnumRejectionReasonTypeINCONSISTENTWITHENDCUSTOMER captures enum value "INCONSISTENT_WITH_END_CUSTOMER".
OpenbankingBrasilPaymentEnumRejectionReasonTypeINCORRECTAGENT captures enum value "INCORRECT_AGENT".
OpenbankingBrasilPaymentEnumRejectionReasonTypeINSUFFICIENTFUNDS captures enum value "INSUFFICIENT_FUNDS".
OpenbankingBrasilPaymentEnumRejectionReasonTypeINVALIDAMOUNT captures enum value "INVALID_AMOUNT".
OpenbankingBrasilPaymentEnumRejectionReasonTypeINVALIDBILL captures enum value "INVALID_BILL".
OpenbankingBrasilPaymentEnumRejectionReasonTypeINVALIDCONSENT captures enum value "INVALID_CONSENT".
OpenbankingBrasilPaymentEnumRejectionReasonTypeINVALIDCREATIONDATE captures enum value "INVALID_CREATION_DATE".
OpenbankingBrasilPaymentEnumRejectionReasonTypeINVALIDCREDITORACCOUNTNUMBER captures enum value "INVALID_CREDITOR_ACCOUNT_NUMBER".
OpenbankingBrasilPaymentEnumRejectionReasonTypeINVALIDCREDITORACCOUNTTYPE captures enum value "INVALID_CREDITOR_ACCOUNTTYPE".
OpenbankingBrasilPaymentEnumRejectionReasonTypeINVALIDCREDITORCLEARINGSYSTEMMEMBERIDENTIFIER captures enum value "INVALID_CREDITOR_CLEARING_SYSTEM_MEMBER_IDENTIFIER".
OpenbankingBrasilPaymentEnumRejectionReasonTypeINVALIDCREDITORIDENTIFICATIONCODE captures enum value "INVALID_CREDITOR_IDENTIFICATION_CODE".
OpenbankingBrasilPaymentEnumRejectionReasonTypeINVALIDCUTOFFDATE captures enum value "INVALID_CUT_OFF_DATE".
OpenbankingBrasilPaymentEnumRejectionReasonTypeINVALIDDEBTORCLEARINGSYSTEMMEMBERIDENTIFIER captures enum value "INVALID_DEBTOR_CLEARING_SYSTEM_MEMBER_IDENTIFIER".
OpenbankingBrasilPaymentEnumRejectionReasonTypeINVALIDENDTOENDID captures enum value "INVALID_END_TO_END_ID".
OpenbankingBrasilPaymentEnumRejectionReasonTypeINVALIDIDENTIFICATIONCODE captures enum value "INVALID_IDENTIFICATION_CODE".
OpenbankingBrasilPaymentEnumRejectionReasonTypeINVALIDNUMBEROFTRANSACTIONS captures enum value "INVALID_NUMBER_OF_TRANSACTIONS".
OpenbankingBrasilPaymentEnumRejectionReasonTypeINVALIDPURPOSE captures enum value "INVALID_PURPOSE".
OpenbankingBrasilPaymentEnumRejectionReasonTypeMISMATCHAMOUNT captures enum value "MISMATCH_AMOUNT".
OpenbankingBrasilPaymentEnumRejectionReasonTypeNOTALLOWEDACCOUNT captures enum value "NOT_ALLOWED_ACCOUNT".
OpenbankingBrasilPaymentEnumRejectionReasonTypeNOTALLOWEDAMOUNT captures enum value "NOT_ALLOWED_AMOUNT".
OpenbankingBrasilPaymentEnumRejectionReasonTypeNOTALLOWEDBOOKTRANSFER captures enum value "NOT_ALLOWED_BOOK_TRANSFER".
OpenbankingBrasilPaymentEnumRejectionReasonTypeNOTALLOWEDPAYMENT captures enum value "NOT_ALLOWED_PAYMENT".
OpenbankingBrasilPaymentEnumRejectionReasonTypeOPERATIONWINDOW captures enum value "OPERATION_WINDOW".
OpenbankingBrasilPaymentEnumRejectionReasonTypeORDERREJECTED captures enum value "ORDER_REJECTED".
OpenbankingBrasilPaymentEnumRejectionReasonTypeOVERLIMIT captures enum value "OVER_LIMIT".
OpenbankingBrasilPaymentEnumRejectionReasonTypeREGULATORYREASON captures enum value "REGULATORY_REASON".
OpenbankingBrasilPaymentEnumRejectionReasonTypeSETTLEMENTFAILED captures enum value "SETTLEMENT_FAILED".
OpenbankingBrasilPaymentEnumRejectionReasonTypeSPECIFICSERVICEOFFEREDBYCREDITORAGENT captures enum value "SPECIFIC_SERVICE_OFFERED_BY_CREDITOR_AGENT".
OpenbankingBrasilPaymentEnumRejectionReasonTypeTIMEOUTDEBTORAGENT captures enum value "TIMEOUT_DEBTOR_AGENT".
OpenbankingBrasilPaymentEnumRejectionReasonTypeTRANSACTIONNOTSUPPORTED captures enum value "TRANSACTION_NOT_SUPPORTED".
OpenbankingBrasilPaymentEnumRejectionReasonTypeUSERNOTYETACTIVATED captures enum value "USER_NOT_YET_ACTIVATED".
OpenbankingBrasilPaymentEnumRejectionReasonTypeWRONGAMOUNT captures enum value "WRONG_AMOUNT".
OpenbankingBrasilPaymentEnumRejectionReasonTypeZEROAMOUNT captures enum value "ZERO_AMOUNT".
OpenbankingBrasilPaymentEnumRevocationReasonACCOUNTCLOSURE captures enum value "ACCOUNT_CLOSURE".
OpenbankingBrasilPaymentEnumRevocationReasonFRAUD captures enum value "FRAUD".
OpenbankingBrasilPaymentEnumRevocationReasonOTHER captures enum value "OTHER".
OpenbankingBrasilPaymentEnumRevokedByASPSP captures enum value "ASPSP".
OpenbankingBrasilPaymentEnumRevokedByTPP captures enum value "TPP".
OpenbankingBrasilPaymentEnumRevokedByUSER captures enum value "USER".
# Structs
OpenbankingBrasilPayment422ResponseErrorCreateConsent 422ResponseErrorCreateConsent
swagger:model OpenbankingBrasilPayment422ResponseErrorCreateConsent.
OpenbankingBrasilPayment422ResponseErrorCreatePixPayment 422ResponseErrorCreatePixPayment
swagger:model OpenbankingBrasilPayment422ResponseErrorCreatePixPayment.
OpenbankingBrasilPayment422ResponseErrorPatchConsent 422ResponseErrorPatchConsent
swagger:model OpenbankingBrasilPayment422ResponseErrorPatchConsent.
OpenbankingBrasilPaymentBusinessEntity BusinessEntity
Usurio (pessoa jurdica) que encontra-se logado na instituio Iniciadora de Pagamento.
OpenbankingBrasilPaymentCreatePaymentConsent CreatePaymentConsent
swagger:model OpenbankingBrasilPaymentCreatePaymentConsent.
OpenbankingBrasilPaymentCreatePixPayment CreatePixPayment
swagger:model OpenbankingBrasilPaymentCreatePixPayment.
OpenbankingBrasilPaymentCreatePixPaymentData CreatePixPaymentData
Objeto contendo dados do pagamento e do recebedor (creditor).
OpenbankingBrasilPaymentCreditorAccount CreditorAccount
Objeto que contm a identificao da conta de destino do beneficirio/recebedor.
OpenbankingBrasilPaymentData Data
Objeto contendo as informaes de consentimento para a iniciao de pagamento individual.
OpenbankingBrasilPaymentData1 Data1
Objeto contendo as informaes de resposta do consentimento para a iniciao de pagamento individual.
OpenbankingBrasilPaymentDebtorAccount DebtorAccount
Objeto que contm a identificao da conta de origem do pagador.
OpenbankingBrasilPaymentDetails Details
Objeto contendo os detalhes do pagamento.
OpenbankingBrasilPaymentDocument Document
swagger:model OpenbankingBrasilPaymentDocument.
OpenbankingBrasilPaymentDocument1 Document1
Objeto que contm os dados de identificao do usurio.
OpenbankingBrasilPaymentError Error
swagger:model OpenbankingBrasilPaymentError.
OpenbankingBrasilPaymentError1 Error1
swagger:model OpenbankingBrasilPaymentError1.
OpenbankingBrasilPaymentError2 Error2
swagger:model OpenbankingBrasilPaymentError2.
OpenbankingBrasilPaymentError3 Error3
swagger:model OpenbankingBrasilPaymentError3.
OpenbankingBrasilPaymentIdentification Identification
Objeto contendo os dados do recebedor (creditor).
OpenbankingBrasilPaymentLinks Links
Referncias para outros recusos da API requisitada.
OpenbankingBrasilPaymentLoggedUser LoggedUser
Usurio (pessoa natural) que encontra-se logado na instituio Iniciadora de Pagamento.
OpenbankingBrasilPaymentMeta Meta
Meta informaes referente API requisitada.
OpenbankingBrasilPaymentPatchPaymentsConsent PatchPaymentsConsent
swagger:model OpenbankingBrasilPaymentPatchPaymentsConsent.
OpenbankingBrasilPaymentPatchPaymentsConsentData PatchPaymentsConsentData
Objeto contendo dados do pagamento e do recebedor (creditor).
OpenbankingBrasilPaymentPaymentConsent PaymentConsent
Objeto contendo dados de pagamento para consentimento.
OpenbankingBrasilPaymentPaymentPix PaymentPix
Objeto contendo dados do pagameto como moeda e valor.
OpenbankingBrasilPaymentReason Reason
Define a razo pela qual o consentimento foi revogado.
OpenbankingBrasilPaymentResponseError ResponseError
swagger:model OpenbankingBrasilPaymentResponseError.
OpenbankingBrasilPaymentResponsePaymentConsent ResponsePaymentConsent
swagger:model OpenbankingBrasilPaymentResponsePaymentConsent.
OpenbankingBrasilPaymentResponsePixPayment ResponsePixPayment
swagger:model OpenbankingBrasilPaymentResponsePixPayment.
OpenbankingBrasilPaymentResponsePixPaymentData ResponsePixPaymentData
Objeto contendo dados do pagamento e da conta do recebedor (creditor).
OpenbankingBrasilPaymentRevocation Revocation
Objeto que contm as informaes das circunstncia da revogao.
OpenbankingBrasilPaymentSchedule Schedule
Mutuamente exclusivo com o campo date.
OpenbankingBrasilPaymentSingle Single
Define a poltica de agendamento nico.
# Type aliases
OpenbankingBrasilPaymentCode Code
Cdigos de erros previstos na criao de consentimento para a iniciao de pagamentos: FORMA_PGTO_INVALIDA: Forma de pagamento invlida.
OpenbankingBrasilPaymentEnumAccountPaymentsType EnumAccountPaymentsType
Tipos de contas usadas para pagamento via Pix.
OpenbankingBrasilPaymentEnumAuthorisationPatchStatusType EnumAuthorisationPatchStatusType
Estado para o qual deve ir.
OpenbankingBrasilPaymentEnumAuthorisationStatusType EnumAuthorisationStatusType
Retorna o estado do consentimento, o qual no momento de sua criao ser AWAITING_AUTHORISATION.
OpenbankingBrasilPaymentEnumErrorsCreatePayment EnumErrorsCreatePayment
Cdigos de erros previstos na criao da iniciao de pagamento:
SALDO_INSUFICIENTE Esta conta no possui saldo suficiente para realizar o pagamento.
OpenbankingBrasilPaymentEnumErrorsPatchConsent EnumErrorsPatchConsent
Cdigos de erros previstos na revogao do consentimento de pagamento: INFORMACAO_USUARIO_REQUERIDA - O campo data.revocation.loggedUser deve ser preenchido quando a revogao for feita pelo usurio final, ou seja, se o campo data.revocation.revokedBy estiver com o valor USER.
OpenbankingBrasilPaymentEnumLocalInstrument EnumLocalInstrument
Especifica a forma de iniciao do pagamento: - MANU - Insero manual de dados da conta transacional - DICT - Insero manual de chave Pix - QRDN - QR code dinmico - QRES - QR code esttico - INIC - Indica que o recebedor (creditor) contratou o Iniciador de Pagamentos especificamente para realizar iniciaes de pagamento em que o beneficirio previamente conhecido.
OpenbankingBrasilPaymentEnumPaymentPersonType EnumPaymentPersonType
Titular, pessoa natural ou juridica a quem se referem os dados de recebedor (creditor).
OpenbankingBrasilPaymentEnumPaymentStatusType EnumPaymentStatusType
Estado atual da iniciao de pagamento.
OpenbankingBrasilPaymentEnumPaymentType EnumPaymentType
Este campo define o tipo de pagamento que ser iniciado aps a autorizao do consentimento.
OpenbankingBrasilPaymentEnumRejectionReasonType EnumRejectionReasonType
Motivo da rejeio do pagamento.
OpenbankingBrasilPaymentEnumRevocationReason EnumRevocationReason
Define o cdigo da razo pela qual o consentimento foi revogado.
OpenbankingBrasilPaymentEnumRevokedBy EnumRevokedBy
Define qual das partes envolvidas na transao est realizando a revogao.