models

package
v0.0.0-...-7b99a6d Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Jan 29, 2024 License: Apache-2.0 Imports: 7 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type BusinessEntity

type BusinessEntity struct {

	// document
	// Required: true
	Document *Document `json:"document"`
}

BusinessEntity BusinessEntity

Usurio (pessoa jurdica) que encontra-se logado na instituio Iniciadora de Pagamento. [Restrio] Preenchimento obrigatrio se usurio logado na instituio Iniciadora de Pagamento for um CNPJ (pessoa jurdica).

swagger:model BusinessEntity

func (*BusinessEntity) ContextValidate

func (m *BusinessEntity) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this business entity based on the context it is used

func (*BusinessEntity) MarshalBinary

func (m *BusinessEntity) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*BusinessEntity) UnmarshalBinary

func (m *BusinessEntity) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*BusinessEntity) Validate

func (m *BusinessEntity) Validate(formats strfmt.Registry) error

Validate validates this business entity

type CreatePixPaymentData

type CreatePixPaymentData struct {

	// CNPJ do Iniciador de Pagamento devidamente habilitado para a prestao de Servio de Iniciao no Pix.
	// Example: 50685362000135
	// Required: true
	// Max Length: 14
	// Pattern: ^\d{14}$
	CnpjInitiator string `json:"cnpjInitiator"`

	// creditor account
	// Required: true
	CreditorAccount *CreditorAccount `json:"creditorAccount"`

	// Traz o cdigo da cidade segundo o IBGE (Instituto Brasileiro de Geografia e Estatstica).
	// Para o preenchimento deste campo, o Iniciador de Pagamentos deve seguir a orientao do arranjo da forma de pagamento.
	// O preenchimento do campo tanto em pix/payments quanto /consents deve ser igual. Caso haja divergncia dos valores, a instituio deve retornar HTTP 422 com o cdigo de erro PAGAMENTO_DIVERGENTE_DO_CONSENTIMENTO.
	// Este campo faz referncia ao campo CodMun do arranjo Pix.
	// Example: 5300108
	// Max Length: 7
	// Min Length: 7
	// Pattern: ^\d{7}$
	IbgeTownCode string `json:"ibgeTownCode,omitempty"`

	// local instrument
	// Required: true
	LocalInstrument *EnumLocalInstrument `json:"localInstrument"`

	// payment
	// Required: true
	Payment *PaymentPix `json:"payment"`

	// Chave cadastrada no DICT pertencente ao recebedor. Os tipos de chaves podem ser: telefone, e-mail, cpf/cnpj ou chave aleatria.
	// No caso de telefone celular deve ser informado no padro E.1641.
	// Para e-mail deve ter o formato xxxxxxxx@xxxxxxx.xxx(.xx) e no mximo 77 caracteres.
	// No caso de CPF dever ser informado com 11 nmeros, sem pontos ou traos.
	// Para o caso de CNPJ dever ser informado com 14 nmeros, sem pontos ou traos.
	// No caso de chave aleatria 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 validao  opcional caso o localInstrument for igual a INIC.
	// [Restrio] Se localInstrument for igual a MANU, o campo proxy no deve ser preenchido. Se localInstrument for igual INIC, DICT, QRDN ou QRES, o campo proxy deve ser sempre preenchido com a chave Pix.
	// Example: 12345678901
	// Max Length: 77
	// Pattern: [\w\W\s]*
	Proxy string `json:"proxy,omitempty"`

	// Sequncia de caracteres que corresponde ao QR Code disponibilizado para o pagador.
	//
	//  a sequncia de caracteres que seria lida pelo leitor de QR Code, e deve propiciar o retorno dos dados do pagador aps consulta na DICT.
	//
	// Essa funcionalidade  possvel tanto para QR Code esttico quanto para QR Code dinmico.
	// No arranjo do Pix esta  a mesma sequncia gerada e/ou lida pela funcionalidade Pix Copia e Cola.
	// Este campo dever ser no formato UTF-8.
	// [Restrio] Preenchimento obrigatrio para pagamentos por QR Code, observado o tamanho mximo de 512 bytes.
	// Example: 00020104141234567890123426660014BR.GOV.BCB.PIX014466756C616E6F32303139406578616D706C652E636F6D27300012\nBR.COM.OUTRO011001234567895204000053039865406123.455802BR5915NOMEDORECEBEDOR6008BRASILIA61087007490062\n530515RP12345678-201950300017BR.GOV.BCB.BRCODE01051.0.080450014BR.GOV.BCB.PIX0123PADRAO.URL.PIX/0123AB\nCD81390012BR.COM.OUTRO01190123.ABCD.3456.WXYZ6304EB76\n
	// Max Length: 512
	// Pattern: [\w\W\s]*
	QrCode string `json:"qrCode,omitempty"`

	// Deve ser preenchido sempre que o usurio pagador inserir alguma informao adicional em um pagamento, a ser enviada ao recebedor.
	// Example: Pagamento da nota XPTO035-002.
	// Max Length: 140
	// Pattern: [\w\W\s]*
	RemittanceInformation string `json:"remittanceInformation,omitempty"`

	// Trata-se de um identificador de transao que deve ser retransmitido intacto pelo PSP do pagador ao gerar a ordem de pagamento. Essa informao permitir ao recebedor identificar e correlacionar a transferncia, quando recebida, com a apresentao das instrues ao pagador.
	// Os caracteres permitidos no contexto do Pix para o campo txid (EMV 62-05) so:
	// - Letras minsculas, de a a z
	// - Letras maisculas, de A a z
	// - Dgitos decimais, de 0 a 9
	//
	// [Restrio] Se localInstrument for igual a INIC, o campo transactionIdentification deve ser preenchido obrigatoriamente.
	// Se localInstrument for igual a MANU ou DICT, o campo transactionIdentification no deve ser preenchido.
	// A detentora de conta deve validar se a condicionalidade do campo foi atendida pela iniciadora de pagamento.
	// Example: E00038166201907261559y6j6
	// Max Length: 25
	// Pattern: ^[a-zA-Z0-9][a-zA-Z0-9]{0,24}$
	TransactionIdentification string `json:"transactionIdentification,omitempty"`
}

CreatePixPaymentData CreatePixPaymentData

Objeto contendo dados do pagamento e do recebedor (creditor).

swagger:model CreatePixPaymentData

func (*CreatePixPaymentData) ContextValidate

func (m *CreatePixPaymentData) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this create pix payment data based on the context it is used

func (*CreatePixPaymentData) MarshalBinary

func (m *CreatePixPaymentData) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*CreatePixPaymentData) UnmarshalBinary

func (m *CreatePixPaymentData) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*CreatePixPaymentData) Validate

func (m *CreatePixPaymentData) Validate(formats strfmt.Registry) error

Validate validates this create pix payment data

type CreditorAccount

type CreditorAccount struct {

	// account type
	// Required: true
	AccountType *EnumAccountPaymentsType `json:"accountType"`

	// Deve ser preenchido com o ISPB (Identificador do Sistema de Pagamentos Brasileiros) do participante do SPI (Sistema de pagamentos instantneos) somente com nmeros.
	// Example: 12345678
	// Required: true
	// Max Length: 8
	// Min Length: 8
	// Pattern: ^[0-9]{8}$
	Ispb string `json:"ispb"`

	// Cdigo da Agncia emissora da conta sem dgito.
	// (Agncia  a dependncia destinada ao atendimento aos clientes, ao pblico em geral e aos associados de cooperativas de crdito,
	// no exerccio de atividades da instituio, no podendo ser mvel ou transitria).
	// [Restrio] Preenchimento obrigatrio para os seguintes tipos de conta: CACC (CONTA_DEPOSITO_A_VISTA), SVGS (CONTA_POUPANCA) e SLRY (CONTA_SALARIO).
	// Example: 1774
	// Max Length: 4
	// Pattern: ^\d{4}$
	Issuer string `json:"issuer,omitempty"`

	// Deve ser preenchido com o nmero da conta do usurio recebedor, com dgito verificador (se este existir),
	// se houver valor alfanumrico, este deve ser convertido para 0.
	// Example: 1234567890
	// Required: true
	// Max Length: 20
	// Min Length: 3
	// Pattern: ^\d{3,20}$
	Number string `json:"number"`
}

CreditorAccount CreditorAccount

Objeto que contm a identificao da conta de destino do beneficirio/recebedor.

swagger:model CreditorAccount

func (*CreditorAccount) ContextValidate

func (m *CreditorAccount) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this creditor account based on the context it is used

func (*CreditorAccount) MarshalBinary

func (m *CreditorAccount) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*CreditorAccount) UnmarshalBinary

func (m *CreditorAccount) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*CreditorAccount) Validate

func (m *CreditorAccount) Validate(formats strfmt.Registry) error

Validate validates this creditor account

type Data

type Data struct {

	// business entity
	BusinessEntity *BusinessEntity `json:"businessEntity,omitempty"`

	// creditor
	// Required: true
	Creditor *Identification `json:"creditor"`

	// debtor account
	DebtorAccount *DebtorAccount `json:"debtorAccount,omitempty"`

	// logged user
	// Required: true
	LoggedUser *LoggedUser `json:"loggedUser"`

	// payment
	// Required: true
	Payment *PaymentConsent `json:"payment"`
}

Data Data

Objeto contendo as informaes de consentimento para a iniciao de pagamento individual.

swagger:model Data

func (*Data) ContextValidate

func (m *Data) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this data based on the context it is used

func (*Data) MarshalBinary

func (m *Data) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*Data) UnmarshalBinary

func (m *Data) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*Data) Validate

func (m *Data) Validate(formats strfmt.Registry) error

Validate validates this data

type Data1

type Data1 struct {

	// business entity
	BusinessEntity *BusinessEntity `json:"businessEntity,omitempty"`

	// Identificador nico do consentimento criado para a iniciao de pagamento solicitada. Dever ser um URN - Uniform Resource Name.
	// Um URN, conforme definido na [RFC8141](https://tools.ietf.org/html/rfc8141)  um Uniform Resource
	// Identifier - URI - que  atribudo sob o URI scheme "urn" e um namespace URN especfico, com a inteno de que o URN
	// seja um identificador de recurso persistente e independente da localizao.
	// Considerando a string urn:bancoex:C1DD33123 como exemplo para consentId temos:
	// - o namespace(urn)
	// - o identificador associado ao namespace da instituio transnmissora (bancoex)
	// - o identificador especfico dentro do namespace (C1DD33123).
	// Informaes mais detalhadas sobre a construo de namespaces devem ser consultadas na [RFC8141](https://tools.ietf.org/html/rfc8141).
	// Example: urn:bancoex:C1DD33123
	// Required: true
	// Max Length: 256
	// Pattern: ^urn:[a-zA-Z0-9][a-zA-Z0-9-]{0,31}:[a-zA-Z0-9()+,\-.:=@;$_!*'%\/?#]+$
	ConsentID string `json:"consentId"`

	// Data e hora em que o consentimento foi criado. Uma string com data e hora conforme especificao RFC-3339, sempre com a utilizao de timezone UTC(UTC time format).
	// Example: 2021-05-21T08:30:00Z
	// Required: true
	// Format: date-time
	CreationDateTime strfmt.DateTime `json:"creationDateTime"`

	// creditor
	// Required: true
	Creditor *Identification `json:"creditor"`

	// debtor account
	DebtorAccount *DebtorAccount `json:"debtorAccount,omitempty"`

	// Data e hora em que o consentimento da iniciao de pagamento expira, devendo ser sempre o creationDateTime mais 5 minutos. Uma string com data e hora conforme especificao RFC-3339, sempre com a utilizao de timezone UTC (UTC time format).
	// O consentimento  criado com o status AWAITING_AUTHORISATION, e deve assumir o status AUTHORIZED ou REJECTED antes do tempo de expirao - 5 minutos. Caso o tempo seja expirado, o status deve assumir REJECTED.
	// Para o cenrio em que o status assumiu AUTHORISED, o tempo mximo do expirationDateTime do consentimento deve assumir "now + 60 minutos". Este  o tempo para consumir o consentimento autorizado, mudando seu status para CONSUMED. No  possvel prorrogar este tempo e a criao de um novo consentimento ser necessria para os cenrios de insucesso.
	// O tempo do expirationDateTime  garantido com os 15 minutos do access token, sendo possvel utilizar mais trs refresh tokens at totalizar 60 minutos.
	// Example: 2021-05-21T08:30:00Z
	// Required: true
	// Format: date-time
	ExpirationDateTime strfmt.DateTime `json:"expirationDateTime"`

	// Traz o cdigo da cidade segundo o IBGE (Instituto Brasileiro de Geografia e Estatstica).
	// Para o preenchimento deste campo, o Iniciador de Pagamentos deve seguir a orientao do arranjo da forma de pagamento.
	// O preenchimento do campo tanto em pix/payments quanto /consents deve ser igual. Caso haja divergncia dos valores, a instituio deve retornar HTTP 422 com o cdigo de erro PAGAMENTO_DIVERGENTE_DO_CONSENTIMENTO.
	// Este campo faz referncia ao campo CodMun do arranjo Pix.
	// Example: 5300108
	// Max Length: 7
	// Min Length: 7
	// Pattern: ^\d{7}$
	IbgeTownCode string `json:"ibgeTownCode,omitempty"`

	// logged user
	// Required: true
	LoggedUser *LoggedUser `json:"loggedUser"`

	// payment
	// Required: true
	Payment *PaymentConsent `json:"payment"`

	// status
	// Required: true
	Status *EnumAuthorisationStatusType `json:"status"`

	// Data e hora em que o recurso foi atualizado. Uma string com data e hora conforme especificao RFC-3339, sempre com a utilizao de timezone UTC(UTC time format).
	// Example: 2021-05-21T08:30:00Z
	// Required: true
	// Format: date-time
	StatusUpdateDateTime strfmt.DateTime `json:"statusUpdateDateTime"`
}

Data1 Data1

Objeto contendo as informaes de resposta do consentimento para a iniciao de pagamento individual.

swagger:model Data1

func (*Data1) ContextValidate

func (m *Data1) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this data1 based on the context it is used

func (*Data1) MarshalBinary

func (m *Data1) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*Data1) UnmarshalBinary

func (m *Data1) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*Data1) Validate

func (m *Data1) Validate(formats strfmt.Registry) error

Validate validates this data1

type DebtorAccount

type DebtorAccount struct {

	// account type
	// Required: true
	AccountType *EnumAccountPaymentsType `json:"accountType"`

	// Deve ser preenchido com o ISPB (Identificador do Sistema de Pagamentos Brasileiros) do participante do SPI (Sistema de pagamentos instantneos) somente com nmeros.
	// Example: 12345678
	// Required: true
	// Max Length: 8
	// Min Length: 8
	// Pattern: ^[0-9]{8}$
	Ispb string `json:"ispb"`

	// Cdigo da Agncia emissora da conta sem dgito.
	// (Agncia  a dependncia destinada ao atendimento aos clientes, ao pblico em geral e aos associados de cooperativas de crdito,
	// no exerccio de atividades da instituio, no podendo ser mvel ou transitria).
	// [Restrio] Preenchimento obrigatrio para os seguintes tipos de conta: CACC (CONTA_DEPOSITO_A_VISTA), SVGS (CONTA_POUPANCA) e SLRY (CONTA_SALARIO).
	// Example: 1774
	// Max Length: 4
	// Pattern: ^\d{4}$
	Issuer string `json:"issuer,omitempty"`

	// Deve ser preenchido com o nmero da conta transacional do usurio pagador, com dgito verificador (se este existir),
	// se houver valor alfanumrico, este deve ser convertido para 0.
	// Example: 1234567890
	// Required: true
	// Max Length: 20
	// Min Length: 3
	// Pattern: ^\d{3,20}$
	Number string `json:"number"`
}

DebtorAccount DebtorAccount

Objeto que contm a identificao da conta de origem do pagador. As informaes quanto conta de origem do pagador podero ser trazidas no consentimento para a detentora, caso a iniciadora tenha coletado essas informaes do cliente. Do contrrio, ser coletada na detentora e trazida para a iniciadora como resposta criao do pagamento.

swagger:model DebtorAccount

func (*DebtorAccount) ContextValidate

func (m *DebtorAccount) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this debtor account based on the context it is used

func (*DebtorAccount) MarshalBinary

func (m *DebtorAccount) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*DebtorAccount) UnmarshalBinary

func (m *DebtorAccount) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*DebtorAccount) Validate

func (m *DebtorAccount) Validate(formats strfmt.Registry) error

Validate validates this debtor account

type Details

type Details struct {

	// creditor account
	// Required: true
	CreditorAccount *CreditorAccount `json:"creditorAccount"`

	// local instrument
	// Required: true
	LocalInstrument *EnumLocalInstrument `json:"localInstrument"`

	// Chave cadastrada no DICT pertencente ao recebedor. Os tipos de chaves podem ser: telefone, e-mail, cpf/cnpj ou chave aleatria.
	// No caso de telefone celular deve ser informado no padro E.1641.
	// Para e-mail deve ter o formato xxxxxxxx@xxxxxxx.xxx(.xx) e no mximo 77 caracteres.
	// No caso de CPF dever ser informado com 11 nmeros, sem pontos ou traos.
	// Para o caso de CNPJ dever ser informado com 14 nmeros, sem pontos ou traos.
	// No caso de chave aleatria 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 validao  opcional caso o localInstrument for igual a INIC.
	// [Restrio]
	// Se localInstrument for igual a MANU, o campo proxy no deve ser preenchido.
	// Se localInstrument for igual INIC, DICT, QRDN ou QRES, o campo proxy deve ser sempre preenchido com a chave Pix.
	// Example: 12345678901
	// Max Length: 77
	// Pattern: [\w\W\s]*
	Proxy string `json:"proxy,omitempty"`

	// Sequncia de caracteres que corresponde ao QR Code disponibilizado para o pagador.
	//
	//  a sequncia de caracteres que seria lida pelo leitor de QR Code, e deve propiciar o retorno dos dados do pagador aps consulta na DICT.
	//
	// Essa funcionalidade  possvel tanto para QR Code esttico quanto para QR Code dinmico.
	// No arranjo do Pix esta  a mesma sequncia gerada e/ou lida pela funcionalidade Pix Copia e Cola.
	// Este campo dever ser no formato UTF-8.
	// [Restrio] Preenchimento obrigatrio para pagamentos por QR Code, observado o tamanho mximo de 512 bytes.
	// Example: 00020104141234567890123426660014BR.GOV.BCB.PIX014466756C616E6F32303139406578616D706C652E636F6D27300012\nBR.COM.OUTRO011001234567895204000053039865406123.455802BR5915NOMEDORECEBEDOR6008BRASILIA61087007490062\n530515RP12345678-201950300017BR.GOV.BCB.BRCODE01051.0.080450014BR.GOV.BCB.PIX0123PADRAO.URL.PIX/0123AB\nCD81390012BR.COM.OUTRO01190123.ABCD.3456.WXYZ6304EB76\n
	// Max Length: 512
	// Pattern: [\w\W\s]*
	QrCode string `json:"qrCode,omitempty"`
}

Details Details

Objeto contendo os detalhes do pagamento.

swagger:model Details

func (*Details) ContextValidate

func (m *Details) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this details based on the context it is used

func (*Details) MarshalBinary

func (m *Details) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*Details) UnmarshalBinary

func (m *Details) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*Details) Validate

func (m *Details) Validate(formats strfmt.Registry) error

Validate validates this details

type Document

type Document struct {

	// Nmero do documento de identificao oficial do titular pessoa jurdica.
	// Example: 11111111111111
	// Required: true
	// Max Length: 14
	// Pattern: ^\d{14}$
	Identification string `json:"identification"`

	// Tipo do documento de identificao oficial do titular pessoa jurdica.
	// Example: CNPJ
	// Required: true
	// Max Length: 4
	// Pattern: ^[A-Z]{4}$
	Rel string `json:"rel"`
}

Document Document

swagger:model Document

func (*Document) ContextValidate

func (m *Document) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this document based on context it is used

func (*Document) MarshalBinary

func (m *Document) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*Document) UnmarshalBinary

func (m *Document) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*Document) Validate

func (m *Document) Validate(formats strfmt.Registry) error

Validate validates this document

type Document1

type Document1 struct {

	// Nmero do documento de identificao oficial do usurio.
	// Example: 11111111111
	// Required: true
	// Max Length: 11
	// Pattern: ^\d{11}$
	Identification string `json:"identification"`

	// Tipo do documento de identificao oficial do usurio.
	// Example: CPF
	// Required: true
	// Max Length: 3
	// Pattern: ^[A-Z]{3}$
	Rel string `json:"rel"`
}

Document1 Document1

swagger:model Document1

func (*Document1) ContextValidate

func (m *Document1) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this document1 based on context it is used

func (*Document1) MarshalBinary

func (m *Document1) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*Document1) UnmarshalBinary

func (m *Document1) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*Document1) Validate

func (m *Document1) Validate(formats strfmt.Registry) error

Validate validates this document1

type EnumAccountPaymentsType

type EnumAccountPaymentsType string

EnumAccountPaymentsType EnumAccountPaymentsType

Tipos de contas usadas para pagamento via Pix. Modalidades tradicionais previstas pela Resoluo 4.753, no contemplando contas vinculadas, conta de domiciliados no exterior, contas em moedas estrangeiras e conta correspondente moeda eletrnica. Segue descrio de cada valor do ENUM para o escopo do Pix. CACC - Current - Conta Corrente. SLRY - Salary - Conta-Salrio. SVGS - Savings - Conta de Poupana. TRAN - TransactingAccount - Conta de Pagamento pr-paga.

swagger:model EnumAccountPaymentsType

const (

	// EnumAccountPaymentsTypeCACC captures enum value "CACC"
	EnumAccountPaymentsTypeCACC EnumAccountPaymentsType = "CACC"

	// EnumAccountPaymentsTypeSLRY captures enum value "SLRY"
	EnumAccountPaymentsTypeSLRY EnumAccountPaymentsType = "SLRY"

	// EnumAccountPaymentsTypeSVGS captures enum value "SVGS"
	EnumAccountPaymentsTypeSVGS EnumAccountPaymentsType = "SVGS"

	// EnumAccountPaymentsTypeTRAN captures enum value "TRAN"
	EnumAccountPaymentsTypeTRAN EnumAccountPaymentsType = "TRAN"
)

func NewEnumAccountPaymentsType

func NewEnumAccountPaymentsType(value EnumAccountPaymentsType) *EnumAccountPaymentsType

func (EnumAccountPaymentsType) ContextValidate

func (m EnumAccountPaymentsType) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this enum account payments type based on context it is used

func (EnumAccountPaymentsType) Pointer

Pointer returns a pointer to a freshly-allocated EnumAccountPaymentsType.

func (EnumAccountPaymentsType) Validate

func (m EnumAccountPaymentsType) Validate(formats strfmt.Registry) error

Validate validates this enum account payments type

type EnumAuthorisationStatusType

type EnumAuthorisationStatusType string

EnumAuthorisationStatusType EnumAuthorisationStatusType

Retorna o estado do consentimento, o qual no momento de sua criao ser AWAITING_AUTHORISATION. Este estado ser alterado depois da autorizao do consentimento na detentora da conta do pagador (Debtor) para AUTHORISED ou REJECTED. O consentimento fica no estado CONSUMED aps ocorrer a iniciao do pagamento referente ao consentimento. Em caso de consentimento expirado a detentora dever retornar o status REJECTED. Estados possveis: AWAITING_AUTHORISATION - Aguardando autorizao AUTHORISED - Autorizado REJECTED - Rejeitado CONSUMED - Consumido

swagger:model EnumAuthorisationStatusType

const (

	// EnumAuthorisationStatusTypeAWAITINGAUTHORISATION captures enum value "AWAITING_AUTHORISATION"
	EnumAuthorisationStatusTypeAWAITINGAUTHORISATION EnumAuthorisationStatusType = "AWAITING_AUTHORISATION"

	// EnumAuthorisationStatusTypeAUTHORISED captures enum value "AUTHORISED"
	EnumAuthorisationStatusTypeAUTHORISED EnumAuthorisationStatusType = "AUTHORISED"

	// EnumAuthorisationStatusTypeREJECTED captures enum value "REJECTED"
	EnumAuthorisationStatusTypeREJECTED EnumAuthorisationStatusType = "REJECTED"

	// EnumAuthorisationStatusTypeCONSUMED captures enum value "CONSUMED"
	EnumAuthorisationStatusTypeCONSUMED EnumAuthorisationStatusType = "CONSUMED"
)

func (EnumAuthorisationStatusType) ContextValidate

func (m EnumAuthorisationStatusType) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this enum authorisation status type based on context it is used

func (EnumAuthorisationStatusType) Pointer

Pointer returns a pointer to a freshly-allocated EnumAuthorisationStatusType.

func (EnumAuthorisationStatusType) Validate

func (m EnumAuthorisationStatusType) Validate(formats strfmt.Registry) error

Validate validates this enum authorisation status type

type EnumErrorsCreateConsent

type EnumErrorsCreateConsent string

EnumErrorsCreateConsent EnumErrorsCreateConsent

Cdigos de erros previstos na criao de consentimento para a iniciao de pagamentos:

FORMA_PGTO_INVALIDA: Forma de pagamento invlida.
DATA_PGTO_INVALIDA: Data de pagamento invlida.
DETALHE_PGTO_INVALIDO: Detalhe do pagamento invlido.
NAO_INFORMADO: No informado.

swagger:model EnumErrorsCreateConsent

const (

	// EnumErrorsCreateConsentFORMAPGTOINVALIDA captures enum value "FORMA_PGTO_INVALIDA"
	EnumErrorsCreateConsentFORMAPGTOINVALIDA EnumErrorsCreateConsent = "FORMA_PGTO_INVALIDA"

	// EnumErrorsCreateConsentDATAPGTOINVALIDA captures enum value "DATA_PGTO_INVALIDA"
	EnumErrorsCreateConsentDATAPGTOINVALIDA EnumErrorsCreateConsent = "DATA_PGTO_INVALIDA"

	// EnumErrorsCreateConsentDETALHEPGTOINVALIDO captures enum value "DETALHE_PGTO_INVALIDO"
	EnumErrorsCreateConsentDETALHEPGTOINVALIDO EnumErrorsCreateConsent = "DETALHE_PGTO_INVALIDO"

	// EnumErrorsCreateConsentNAOINFORMADO captures enum value "NAO_INFORMADO"
	EnumErrorsCreateConsentNAOINFORMADO EnumErrorsCreateConsent = "NAO_INFORMADO"
)

func NewEnumErrorsCreateConsent

func NewEnumErrorsCreateConsent(value EnumErrorsCreateConsent) *EnumErrorsCreateConsent

func (EnumErrorsCreateConsent) ContextValidate

func (m EnumErrorsCreateConsent) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this enum errors create consent based on context it is used

func (EnumErrorsCreateConsent) Pointer

Pointer returns a pointer to a freshly-allocated EnumErrorsCreateConsent.

func (EnumErrorsCreateConsent) Validate

func (m EnumErrorsCreateConsent) Validate(formats strfmt.Registry) error

Validate validates this enum errors create consent

type EnumErrorsCreatePayment

type EnumErrorsCreatePayment string

EnumErrorsCreatePayment EnumErrorsCreatePayment

Cdigos de erros previstos na criao da iniciao de pagamento:

SALDO_INSUFICIENTE  Esta conta no possui saldo suficiente para realizar o pagamento.

BENEFICIARIO_INCOMPATIVEL  O beneficirio informado no consentimento no  o mesmo do esperado pelo DICT.

VALOR_INCOMPATIVEL  O valor informado no consentimento no  o mesmo valor do informado no payload de pagamento.

VALOR_ACIMA_LIMITE  O valor (ou quantidade de transaes) ultrapassa a faixa de limite parametrizada na detentora para permitir a realizao de transaes pelo cliente.

VALOR_INVALIDO  O valor enviado no  vlido para o QR Code informado.

COBRANCA_INVALIDA  Validao de expirao, validao de vencimento, Status Vlido.

CONSENTIMENTO_INVALIDO  Consentimento invlido (status no  "authorised" ou est expirado).

JANELA_OPER_INVALIDA  Requisio est fora da janela de funcionamento.

NAO_INFORMADO  No informada pela detentora de conta.

PAGAMENTO_DIVERGENTE_DO_CONSENTIMENTO: Dados do pagamento divergentes dos dados do consentimento.

swagger:model EnumErrorsCreatePayment

const (

	// EnumErrorsCreatePaymentSALDOINSUFICIENTE captures enum value "SALDO_INSUFICIENTE"
	EnumErrorsCreatePaymentSALDOINSUFICIENTE EnumErrorsCreatePayment = "SALDO_INSUFICIENTE"

	// EnumErrorsCreatePaymentBENEFICIARIOINCOMPATIVEL captures enum value "BENEFICIARIO_INCOMPATIVEL"
	EnumErrorsCreatePaymentBENEFICIARIOINCOMPATIVEL EnumErrorsCreatePayment = "BENEFICIARIO_INCOMPATIVEL"

	// EnumErrorsCreatePaymentVALORINCOMPATIVEL captures enum value "VALOR_INCOMPATIVEL"
	EnumErrorsCreatePaymentVALORINCOMPATIVEL EnumErrorsCreatePayment = "VALOR_INCOMPATIVEL"

	// EnumErrorsCreatePaymentVALORACIMALIMITE captures enum value "VALOR_ACIMA_LIMITE"
	EnumErrorsCreatePaymentVALORACIMALIMITE EnumErrorsCreatePayment = "VALOR_ACIMA_LIMITE"

	// EnumErrorsCreatePaymentVALORINVALIDO captures enum value "VALOR_INVALIDO"
	EnumErrorsCreatePaymentVALORINVALIDO EnumErrorsCreatePayment = "VALOR_INVALIDO"

	// EnumErrorsCreatePaymentCOBRANCAINVALIDA captures enum value "COBRANCA_INVALIDA"
	EnumErrorsCreatePaymentCOBRANCAINVALIDA EnumErrorsCreatePayment = "COBRANCA_INVALIDA"

	// EnumErrorsCreatePaymentCONSENTIMENTOINVALIDO captures enum value "CONSENTIMENTO_INVALIDO"
	EnumErrorsCreatePaymentCONSENTIMENTOINVALIDO EnumErrorsCreatePayment = "CONSENTIMENTO_INVALIDO"

	// EnumErrorsCreatePaymentJANELAOPERINVALIDA captures enum value "JANELA_OPER_INVALIDA"
	EnumErrorsCreatePaymentJANELAOPERINVALIDA EnumErrorsCreatePayment = "JANELA_OPER_INVALIDA"

	// EnumErrorsCreatePaymentNAOINFORMADO captures enum value "NAO_INFORMADO"
	EnumErrorsCreatePaymentNAOINFORMADO EnumErrorsCreatePayment = "NAO_INFORMADO"

	// EnumErrorsCreatePaymentPAGAMENTODIVERGENTEDOCONSENTIMENTO captures enum value "PAGAMENTO_DIVERGENTE_DO_CONSENTIMENTO"
	EnumErrorsCreatePaymentPAGAMENTODIVERGENTEDOCONSENTIMENTO EnumErrorsCreatePayment = "PAGAMENTO_DIVERGENTE_DO_CONSENTIMENTO"
)

func NewEnumErrorsCreatePayment

func NewEnumErrorsCreatePayment(value EnumErrorsCreatePayment) *EnumErrorsCreatePayment

func (EnumErrorsCreatePayment) ContextValidate

func (m EnumErrorsCreatePayment) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this enum errors create payment based on context it is used

func (EnumErrorsCreatePayment) Pointer

Pointer returns a pointer to a freshly-allocated EnumErrorsCreatePayment.

func (EnumErrorsCreatePayment) Validate

func (m EnumErrorsCreatePayment) Validate(formats strfmt.Registry) error

Validate validates this enum errors create payment

type EnumLocalInstrument

type EnumLocalInstrument string

EnumLocalInstrument 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.

swagger:model EnumLocalInstrument

const (

	// EnumLocalInstrumentMANU captures enum value "MANU"
	EnumLocalInstrumentMANU EnumLocalInstrument = "MANU"

	// EnumLocalInstrumentDICT captures enum value "DICT"
	EnumLocalInstrumentDICT EnumLocalInstrument = "DICT"

	// EnumLocalInstrumentQRDN captures enum value "QRDN"
	EnumLocalInstrumentQRDN EnumLocalInstrument = "QRDN"

	// EnumLocalInstrumentQRES captures enum value "QRES"
	EnumLocalInstrumentQRES EnumLocalInstrument = "QRES"

	// EnumLocalInstrumentINIC captures enum value "INIC"
	EnumLocalInstrumentINIC EnumLocalInstrument = "INIC"
)

func NewEnumLocalInstrument

func NewEnumLocalInstrument(value EnumLocalInstrument) *EnumLocalInstrument

func (EnumLocalInstrument) ContextValidate

func (m EnumLocalInstrument) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this enum local instrument based on context it is used

func (EnumLocalInstrument) Pointer

Pointer returns a pointer to a freshly-allocated EnumLocalInstrument.

func (EnumLocalInstrument) Validate

func (m EnumLocalInstrument) Validate(formats strfmt.Registry) error

Validate validates this enum local instrument

type EnumPaymentPersonType

type EnumPaymentPersonType string

EnumPaymentPersonType EnumPaymentPersonType

Titular, pessoa natural ou juridica a quem se referem os dados de recebedor (creditor).

swagger:model EnumPaymentPersonType

const (

	// EnumPaymentPersonTypePESSOANATURAL captures enum value "PESSOA_NATURAL"
	EnumPaymentPersonTypePESSOANATURAL EnumPaymentPersonType = "PESSOA_NATURAL"

	// EnumPaymentPersonTypePESSOAJURIDICA captures enum value "PESSOA_JURIDICA"
	EnumPaymentPersonTypePESSOAJURIDICA EnumPaymentPersonType = "PESSOA_JURIDICA"
)

func NewEnumPaymentPersonType

func NewEnumPaymentPersonType(value EnumPaymentPersonType) *EnumPaymentPersonType

func (EnumPaymentPersonType) ContextValidate

func (m EnumPaymentPersonType) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this enum payment person type based on context it is used

func (EnumPaymentPersonType) Pointer

Pointer returns a pointer to a freshly-allocated EnumPaymentPersonType.

func (EnumPaymentPersonType) Validate

func (m EnumPaymentPersonType) Validate(formats strfmt.Registry) error

Validate validates this enum payment person type

type EnumPaymentStatusType

type EnumPaymentStatusType string

EnumPaymentStatusType EnumPaymentStatusType

Estado atual da iniciao de pagamento. O estado evolui na seguinte ordem: 1. PDNG (PENDING) - Iniciao de pagamento ou transao de pagamento est pendente. Checagens adicionais em realizao. 2. PART (PARTIALLY ACCEPTED) - Aguardando autorizao mltipla alada. 3. ACSP (ACCEPTED_SETTLEMENT_IN_PROCESS) - Iniciao de pagamento aceita e processamento do pagamento foi iniciado. 4. ACSC (ACCEPTED_SETTLEMENT_COMPLETED_DEBITOR_ACCOUNT) - Dbito realizado na conta do pagador. 5. ACCC (ACCEPTED_SETTLEMENT_COMPLETED) - Crdito realizado na instituio de destino. Em caso insucesso: RJCT (REJECTED) - Instruo de pagamento rejeitada.

swagger:model EnumPaymentStatusType

const (

	// EnumPaymentStatusTypePDNG captures enum value "PDNG"
	EnumPaymentStatusTypePDNG EnumPaymentStatusType = "PDNG"

	// EnumPaymentStatusTypePART captures enum value "PART"
	EnumPaymentStatusTypePART EnumPaymentStatusType = "PART"

	// EnumPaymentStatusTypeACSP captures enum value "ACSP"
	EnumPaymentStatusTypeACSP EnumPaymentStatusType = "ACSP"

	// EnumPaymentStatusTypeACSC captures enum value "ACSC"
	EnumPaymentStatusTypeACSC EnumPaymentStatusType = "ACSC"

	// EnumPaymentStatusTypeACCC captures enum value "ACCC"
	EnumPaymentStatusTypeACCC EnumPaymentStatusType = "ACCC"

	// EnumPaymentStatusTypeRJCT captures enum value "RJCT"
	EnumPaymentStatusTypeRJCT EnumPaymentStatusType = "RJCT"
)

func NewEnumPaymentStatusType

func NewEnumPaymentStatusType(value EnumPaymentStatusType) *EnumPaymentStatusType

func (EnumPaymentStatusType) ContextValidate

func (m EnumPaymentStatusType) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this enum payment status type based on context it is used

func (EnumPaymentStatusType) Pointer

Pointer returns a pointer to a freshly-allocated EnumPaymentStatusType.

func (EnumPaymentStatusType) Validate

func (m EnumPaymentStatusType) Validate(formats strfmt.Registry) error

Validate validates this enum payment status type

type EnumRejectionReasonType

type EnumRejectionReasonType string

EnumRejectionReasonType EnumRejectionReasonType

Motivo da rejeio do pagamento. Informaes complementares sobre o motivo do status. ABORTED_SETTLEMENT_TIMEOUT - Liquidao da transao interrompida devido a timeout no SPI (AB03). ERROR_CREDITOR_AGENT - Transao interrompida devido a erro no participante do usurio recebedor (AB09). TIMEOUT_DEBTOR_AGENT - Timeout do participante emissor da ordem de pagamento (AB11). INVALID_CREDITOR_ACCOUNT_NUMBER - Nmero da conta transacional do usurio recebedor inexistente ou invlido (AC03). BLOCKED_ACCOUNT - Conta transacional do usurio recebedor encontra-se bloqueada (AC06). CLOSED_CREDITOR_ACCOUNT_NUMBER - Nmero da conta transacional do usurio recebedor encerrada (AC07). INVALID_CREDITOR_ACCOUNTTYPE - Tipo incorreto para a conta transacional do usurio recebedor (AC14). TRANSACTION_NOT_SUPPORTED - Tipo de transao no suportado/autorizado na conta transacional do usurio recebedor (AG03). Exemplo: transferncia para conta salrio. NOT_ALLOWED_BOOK_TRANSFER - No permitida ordem de pagamento/devoluo no SPI cujos recursos sejam transferidos de uma conta transacional para outra em uma mesma instituio participante ou entre participantes que utilizem o servio de liquidao de um mesmo participante liquidante no SPI (booktransfer) (AG12). FORBIDDEN_RETURN_PAYMENT - No permitido devolver a devoluo de um pagamento instantneo (AG13). INCORRECT_AGENT - Participante direto no liquidante do participante do usurio pagador / participante do usurio recebedor (AGNT). ZERO_AMOUNT - Ordem de pagamento instantneo com valor zero (AM01). NOT_ALLOWED_AMOUNT - Ordem de pagamento/devoluo em valor que faz superar o limite permitido para o tipo de conta transacional creditada (AM02). INSUFFICIENT_FUNDS - Saldo insuficiente na conta PI do participante do usurio pagador (AM04). WRONG_AMOUNT - Devoluo de pagamento em valor que faz superar o valor da ordem de pagamento instantneo correspondente (AM09). INVALID_AMOUNT - Divergncia entre a somatria dos valores do bloco valorDoDinheiroOuCompra e o campo valor (AM12). INVALID_NUMBER_OF_TRANSACTIONS - Quantidade de transaes invlida (AM18). INCONSISTENT_WITH_END_CUSTOMER - CPF/CNPJ do usurio recebedor no consistente com o titular da conta transacional especificada (BE01). INVALID_IDENTIFICATION_CODE - Cdigo de situao de pagamento ou de erro invlido (BE15). INVALID_CREDITOR_IDENTIFICATION_CODE - QR Code rejeitado pelo participante do usurio recebedor (BE17). CREDITOR_IDENTIFIER_INCORRECT - CPF/CNPJ do usurio recebedor incorreto (CH11). ELEMENT_CONTENT_FORMALLY_INCORRECT - Elemento da mensagem incorreto (CH16). ORDER_REJECTED - Ordem rejeitada pelo participante do usurio recebedor (DS04). NOT_ALLOWED_PAYMENT - Participante que assinou a mensagem no autorizado a realizar a operao na conta PI debitada. No caso em que o participante que assinou a mensagem no o titular da conta PI debitada nem o liquidante no SPI do participante do usurio pagador (DS0G). NOT_ALLOWED_ACCOUNT - ISPB do participante que submeteu a resposta ordem de pagamento/devoluo diferente do ISPB do participante creditado pela ordem (DS0H). USER_NOT_YET_ACTIVATED - Participante no se encontra cadastrado ou ainda no iniciou a operao no SPI (DS27). INVALID_CREATION_DATE - Data e Hora do envio da mensagem invlida (DT02). INVALID_CUT_OFF_DATE - Transao extrapola o prazo mximo para devoluo de pagamento instantneo regulamentado pelo Arranjo PIX (DT05). SETTLEMENT_FAILED - Erro no processamento do pagamento instantneo (ED05). INVALID_PURPOSE - Inconsistncia entre a finalidade da transao e o preenchimento do bloco elementos Structured (FF07). INVALID_END_TO_END_ID - Identificador da operao mal formatado (FF08). INVALID_DEBTOR_CLEARING_SYSTEM_MEMBER_IDENTIFIER - ISPB do participante do usurio pagador invlido ou inexistente (RC09). INVALID_CREDITOR_CLEARING_SYSTEM_MEMBER_IDENTIFIER - ISPB do participante do usurio recebedor invlido ou inexistente (RC10). REGULATORY_REASON - Ordem de pagamento em que o usurio pagador sancionado por resoluo do Conselho de Segurana das Naes Unidas (CSNU). Nos casos em que o usurio recebedor for o sancionado, a ordem de pagamento no deve ser rejeitada (RR4). SPECIFIC_SERVICE_OFFERED_BY_CREDITOR_AGENT - A transao original no est relacionada ao servio de Saque Pix (SL02). INVALID_BILL - Validao de expirao, validao de vencimento, Status Vlido (INDT). OPERATION_WINDOW - Requisio est fora da janela de funcionamento (IDEA). INCOMPATIBLE_DATE - Data do pagamento divergente da data consentida ou divergente da data atual do QR Code (TERM). MISMATCH_AMOUNT - O valor informado no consentimento no o mesmo valor do informado no payload de pagamento (OB01). OVER_LIMIT - O valor (ou quantidade de transaes) ultrapassa a faixa de limite parametrizada na detentora para permitir a realizao de transaes pelo cliente (OB02). INVALID_CONSENT - Consentimento invlido (status no "authorised" ou est expirado) (OB03). DENIED_MULTIPLE_AUTHORISATIONS - Um (ou mais) aprovadores na detentora recusaram a operao (OB04). EXPIRED_MULTIPLE_AUTHORISATIONS - Um (ou mais) aprovadores na detentora no tomaram ao para aprovar a operao (OB05). EXPIRED_BILL - O QR Code no mais vlido (OB06). [Restrio] Esse motivo dever ser enviado quando o campo /data/status for igual a RJCT (REJECTED).

swagger:model EnumRejectionReasonType

const (

	// EnumRejectionReasonTypeABORTEDSETTLEMENTTIMEOUT captures enum value "ABORTED_SETTLEMENT_TIMEOUT"
	EnumRejectionReasonTypeABORTEDSETTLEMENTTIMEOUT EnumRejectionReasonType = "ABORTED_SETTLEMENT_TIMEOUT"

	// EnumRejectionReasonTypeERRORCREDITORAGENT captures enum value "ERROR_CREDITOR_AGENT"
	EnumRejectionReasonTypeERRORCREDITORAGENT EnumRejectionReasonType = "ERROR_CREDITOR_AGENT"

	// EnumRejectionReasonTypeTIMEOUTDEBTORAGENT captures enum value "TIMEOUT_DEBTOR_AGENT"
	EnumRejectionReasonTypeTIMEOUTDEBTORAGENT EnumRejectionReasonType = "TIMEOUT_DEBTOR_AGENT"

	// EnumRejectionReasonTypeINVALIDCREDITORACCOUNTNUMBER captures enum value "INVALID_CREDITOR_ACCOUNT_NUMBER"
	EnumRejectionReasonTypeINVALIDCREDITORACCOUNTNUMBER EnumRejectionReasonType = "INVALID_CREDITOR_ACCOUNT_NUMBER"

	// EnumRejectionReasonTypeBLOCKEDACCOUNT captures enum value "BLOCKED_ACCOUNT"
	EnumRejectionReasonTypeBLOCKEDACCOUNT EnumRejectionReasonType = "BLOCKED_ACCOUNT"

	// EnumRejectionReasonTypeCLOSEDCREDITORACCOUNTNUMBER captures enum value "CLOSED_CREDITOR_ACCOUNT_NUMBER"
	EnumRejectionReasonTypeCLOSEDCREDITORACCOUNTNUMBER EnumRejectionReasonType = "CLOSED_CREDITOR_ACCOUNT_NUMBER"

	// EnumRejectionReasonTypeINVALIDCREDITORACCOUNTTYPE captures enum value "INVALID_CREDITOR_ACCOUNTTYPE"
	EnumRejectionReasonTypeINVALIDCREDITORACCOUNTTYPE EnumRejectionReasonType = "INVALID_CREDITOR_ACCOUNTTYPE"

	// EnumRejectionReasonTypeTRANSACTIONNOTSUPPORTED captures enum value "TRANSACTION_NOT_SUPPORTED"
	EnumRejectionReasonTypeTRANSACTIONNOTSUPPORTED EnumRejectionReasonType = "TRANSACTION_NOT_SUPPORTED"

	// EnumRejectionReasonTypeNOTALLOWEDBOOKTRANSFER captures enum value "NOT_ALLOWED_BOOK_TRANSFER"
	EnumRejectionReasonTypeNOTALLOWEDBOOKTRANSFER EnumRejectionReasonType = "NOT_ALLOWED_BOOK_TRANSFER"

	// EnumRejectionReasonTypeFORBIDDENRETURNPAYMENT captures enum value "FORBIDDEN_RETURN_PAYMENT"
	EnumRejectionReasonTypeFORBIDDENRETURNPAYMENT EnumRejectionReasonType = "FORBIDDEN_RETURN_PAYMENT"

	// EnumRejectionReasonTypeINCORRECTAGENT captures enum value "INCORRECT_AGENT"
	EnumRejectionReasonTypeINCORRECTAGENT EnumRejectionReasonType = "INCORRECT_AGENT"

	// EnumRejectionReasonTypeZEROAMOUNT captures enum value "ZERO_AMOUNT"
	EnumRejectionReasonTypeZEROAMOUNT EnumRejectionReasonType = "ZERO_AMOUNT"

	// EnumRejectionReasonTypeNOTALLOWEDAMOUNT captures enum value "NOT_ALLOWED_AMOUNT"
	EnumRejectionReasonTypeNOTALLOWEDAMOUNT EnumRejectionReasonType = "NOT_ALLOWED_AMOUNT"

	// EnumRejectionReasonTypeINSUFFICIENTFUNDS captures enum value "INSUFFICIENT_FUNDS"
	EnumRejectionReasonTypeINSUFFICIENTFUNDS EnumRejectionReasonType = "INSUFFICIENT_FUNDS"

	// EnumRejectionReasonTypeWRONGAMOUNT captures enum value "WRONG_AMOUNT"
	EnumRejectionReasonTypeWRONGAMOUNT EnumRejectionReasonType = "WRONG_AMOUNT"

	// EnumRejectionReasonTypeINVALIDAMOUNT captures enum value "INVALID_AMOUNT"
	EnumRejectionReasonTypeINVALIDAMOUNT EnumRejectionReasonType = "INVALID_AMOUNT"

	// EnumRejectionReasonTypeINVALIDNUMBEROFTRANSACTIONS captures enum value "INVALID_NUMBER_OF_TRANSACTIONS"
	EnumRejectionReasonTypeINVALIDNUMBEROFTRANSACTIONS EnumRejectionReasonType = "INVALID_NUMBER_OF_TRANSACTIONS"

	// EnumRejectionReasonTypeINCONSISTENTWITHENDCUSTOMER captures enum value "INCONSISTENT_WITH_END_CUSTOMER"
	EnumRejectionReasonTypeINCONSISTENTWITHENDCUSTOMER EnumRejectionReasonType = "INCONSISTENT_WITH_END_CUSTOMER"

	// EnumRejectionReasonTypeINVALIDIDENTIFICATIONCODE captures enum value "INVALID_IDENTIFICATION_CODE"
	EnumRejectionReasonTypeINVALIDIDENTIFICATIONCODE EnumRejectionReasonType = "INVALID_IDENTIFICATION_CODE"

	// EnumRejectionReasonTypeINVALIDCREDITORIDENTIFICATIONCODE captures enum value "INVALID_CREDITOR_IDENTIFICATION_CODE"
	EnumRejectionReasonTypeINVALIDCREDITORIDENTIFICATIONCODE EnumRejectionReasonType = "INVALID_CREDITOR_IDENTIFICATION_CODE"

	// EnumRejectionReasonTypeCREDITORIDENTIFIERINCORRECT captures enum value "CREDITOR_IDENTIFIER_INCORRECT"
	EnumRejectionReasonTypeCREDITORIDENTIFIERINCORRECT EnumRejectionReasonType = "CREDITOR_IDENTIFIER_INCORRECT"

	// EnumRejectionReasonTypeELEMENTCONTENTFORMALLYINCORRECT captures enum value "ELEMENT_CONTENT_FORMALLY_INCORRECT"
	EnumRejectionReasonTypeELEMENTCONTENTFORMALLYINCORRECT EnumRejectionReasonType = "ELEMENT_CONTENT_FORMALLY_INCORRECT"

	// EnumRejectionReasonTypeORDERREJECTED captures enum value "ORDER_REJECTED"
	EnumRejectionReasonTypeORDERREJECTED EnumRejectionReasonType = "ORDER_REJECTED"

	// EnumRejectionReasonTypeNOTALLOWEDPAYMENT captures enum value "NOT_ALLOWED_PAYMENT"
	EnumRejectionReasonTypeNOTALLOWEDPAYMENT EnumRejectionReasonType = "NOT_ALLOWED_PAYMENT"

	// EnumRejectionReasonTypeNOTALLOWEDACCOUNT captures enum value "NOT_ALLOWED_ACCOUNT"
	EnumRejectionReasonTypeNOTALLOWEDACCOUNT EnumRejectionReasonType = "NOT_ALLOWED_ACCOUNT"

	// EnumRejectionReasonTypeUSERNOTYETACTIVATED captures enum value "USER_NOT_YET_ACTIVATED"
	EnumRejectionReasonTypeUSERNOTYETACTIVATED EnumRejectionReasonType = "USER_NOT_YET_ACTIVATED"

	// EnumRejectionReasonTypeINVALIDCREATIONDATE captures enum value "INVALID_CREATION_DATE"
	EnumRejectionReasonTypeINVALIDCREATIONDATE EnumRejectionReasonType = "INVALID_CREATION_DATE"

	// EnumRejectionReasonTypeINVALIDCUTOFFDATE captures enum value "INVALID_CUT_OFF_DATE"
	EnumRejectionReasonTypeINVALIDCUTOFFDATE EnumRejectionReasonType = "INVALID_CUT_OFF_DATE"

	// EnumRejectionReasonTypeSETTLEMENTFAILED captures enum value "SETTLEMENT_FAILED"
	EnumRejectionReasonTypeSETTLEMENTFAILED EnumRejectionReasonType = "SETTLEMENT_FAILED"

	// EnumRejectionReasonTypeINVALIDPURPOSE captures enum value "INVALID_PURPOSE"
	EnumRejectionReasonTypeINVALIDPURPOSE EnumRejectionReasonType = "INVALID_PURPOSE"

	// EnumRejectionReasonTypeINVALIDENDTOENDID captures enum value "INVALID_END_TO_END_ID"
	EnumRejectionReasonTypeINVALIDENDTOENDID EnumRejectionReasonType = "INVALID_END_TO_END_ID"

	// EnumRejectionReasonTypeINVALIDDEBTORCLEARINGSYSTEMMEMBERIDENTIFIER captures enum value "INVALID_DEBTOR_CLEARING_SYSTEM_MEMBER_IDENTIFIER"
	EnumRejectionReasonTypeINVALIDDEBTORCLEARINGSYSTEMMEMBERIDENTIFIER EnumRejectionReasonType = "INVALID_DEBTOR_CLEARING_SYSTEM_MEMBER_IDENTIFIER"

	// EnumRejectionReasonTypeINVALIDCREDITORCLEARINGSYSTEMMEMBERIDENTIFIER captures enum value "INVALID_CREDITOR_CLEARING_SYSTEM_MEMBER_IDENTIFIER"
	EnumRejectionReasonTypeINVALIDCREDITORCLEARINGSYSTEMMEMBERIDENTIFIER EnumRejectionReasonType = "INVALID_CREDITOR_CLEARING_SYSTEM_MEMBER_IDENTIFIER"

	// EnumRejectionReasonTypeREGULATORYREASON captures enum value "REGULATORY_REASON"
	EnumRejectionReasonTypeREGULATORYREASON EnumRejectionReasonType = "REGULATORY_REASON"

	// EnumRejectionReasonTypeSPECIFICSERVICEOFFEREDBYCREDITORAGENT captures enum value "SPECIFIC_SERVICE_OFFERED_BY_CREDITOR_AGENT"
	EnumRejectionReasonTypeSPECIFICSERVICEOFFEREDBYCREDITORAGENT EnumRejectionReasonType = "SPECIFIC_SERVICE_OFFERED_BY_CREDITOR_AGENT"

	// EnumRejectionReasonTypeINVALIDBILL captures enum value "INVALID_BILL"
	EnumRejectionReasonTypeINVALIDBILL EnumRejectionReasonType = "INVALID_BILL"

	// EnumRejectionReasonTypeOPERATIONWINDOW captures enum value "OPERATION_WINDOW"
	EnumRejectionReasonTypeOPERATIONWINDOW EnumRejectionReasonType = "OPERATION_WINDOW"

	// EnumRejectionReasonTypeINCOMPATIBLEDATE captures enum value "INCOMPATIBLE_DATE"
	EnumRejectionReasonTypeINCOMPATIBLEDATE EnumRejectionReasonType = "INCOMPATIBLE_DATE"

	// EnumRejectionReasonTypeMISMATCHAMOUNT captures enum value "MISMATCH_AMOUNT"
	EnumRejectionReasonTypeMISMATCHAMOUNT EnumRejectionReasonType = "MISMATCH_AMOUNT"

	// EnumRejectionReasonTypeOVERLIMIT captures enum value "OVER_LIMIT"
	EnumRejectionReasonTypeOVERLIMIT EnumRejectionReasonType = "OVER_LIMIT"

	// EnumRejectionReasonTypeINVALIDCONSENT captures enum value "INVALID_CONSENT"
	EnumRejectionReasonTypeINVALIDCONSENT EnumRejectionReasonType = "INVALID_CONSENT"

	// EnumRejectionReasonTypeDENIEDMULTIPLEAUTHORISATIONS captures enum value "DENIED_MULTIPLE_AUTHORISATIONS"
	EnumRejectionReasonTypeDENIEDMULTIPLEAUTHORISATIONS EnumRejectionReasonType = "DENIED_MULTIPLE_AUTHORISATIONS"

	// EnumRejectionReasonTypeEXPIREDMULTIPLEAUTHORISATIONS captures enum value "EXPIRED_MULTIPLE_AUTHORISATIONS"
	EnumRejectionReasonTypeEXPIREDMULTIPLEAUTHORISATIONS EnumRejectionReasonType = "EXPIRED_MULTIPLE_AUTHORISATIONS"

	// EnumRejectionReasonTypeEXPIREDBILL captures enum value "EXPIRED_BILL"
	EnumRejectionReasonTypeEXPIREDBILL EnumRejectionReasonType = "EXPIRED_BILL"
)

func NewEnumRejectionReasonType

func NewEnumRejectionReasonType(value EnumRejectionReasonType) *EnumRejectionReasonType

func (EnumRejectionReasonType) ContextValidate

func (m EnumRejectionReasonType) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this enum rejection reason type based on context it is used

func (EnumRejectionReasonType) Pointer

Pointer returns a pointer to a freshly-allocated EnumRejectionReasonType.

func (EnumRejectionReasonType) Validate

func (m EnumRejectionReasonType) Validate(formats strfmt.Registry) error

Validate validates this enum rejection reason type

type Error

type Error struct {

	// code
	// Required: true
	Code *EnumErrorsCreateConsent `json:"code"`

	// Descrio especfica do erro de acordo com o cdigo reportado:
	//  FORMA_PGTO_INVALIDA  Meio de pagamento invlido.
	//  DATA_PGTO_INVALIDA  Data de pagamento invlida no contexto, por exemplo, data no passado. Para pagamentos nicos deve ser informada a data atual, do dia corrente.
	//  DETALHE_PGTO_INVALIDO: O campo [nome_campo] no atende os requisitos de preenchimento.
	//  NAO_INFORMADO  No reportado/identificado pela instituio detentora de conta.
	// Example: Meio de pagamento invlido.
	// Required: true
	// Max Length: 2048
	// Pattern: \w*\W*
	Detail string `json:"detail"`

	// Ttulo especfico do erro reportado, de acordo com o cdigo enviado:
	//  FORMA_PGTO_INVALIDA: Forma de pagamento invlida.
	//  DATA_PGTO_INVALIDA: Data de pagamento invlida.
	//  DETALHE_PGTO_INVALIDO: Detalhe do pagamento invlido.
	//  NAO_INFORMADO: No informado.
	// Example: Forma de pagamento invlida.
	// Required: true
	// Max Length: 255
	// Pattern: \w*\W*
	Title string `json:"title"`
}

Error Error

swagger:model Error

func (*Error) ContextValidate

func (m *Error) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this error based on the context it is used

func (*Error) MarshalBinary

func (m *Error) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*Error) UnmarshalBinary

func (m *Error) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*Error) Validate

func (m *Error) Validate(formats strfmt.Registry) error

Validate validates this error

type Error1

type Error1 struct {

	// code
	// Required: true
	Code *EnumErrorsCreatePayment `json:"code"`

	// Descrio especfica do erro de acordo com o cdigo reportado:
	//
	//  SALDO_INSUFICIENTE: A conta selecionada no possui saldo suficiente para realizar o pagamento.
	//
	//  BENEFICIARIO_INCOMPATIVEL: O beneficirio informado no consentimento no  o mesmo do esperado pelo DICT.
	//
	//  VALOR_INCOMPATIVEL: O valor informado no consentimento no  o mesmo valor do informado no payload de pagamento.
	//
	//  VALOR_ACIMA_LIMITE: O valor (ou quantidade de transaes) ultrapassa a faixa de limite parametrizada na detentora para permitir a realizao de transaes pelo cliente.
	//
	//  VALOR_INVALIDO: O valor enviado no  vlido para o QR Code informado.
	//
	//  COBRANCA_INVALIDA: Validao de expirao, validao de vencimento ou Status Vlido.
	//
	//  CONSENTIMENTO_INVALIDO: Consentimento invlido (status diferente de "AUTHORISED" ou est expirado).
	//
	//  JANELA_OPER_INVALIDA: Requisio est fora da janela de funcionamento.
	//
	//  NAO_INFORMADO: No reportado/identificado pela instituio detentora de conta.
	//
	//  PAGAMENTO_DIVERGENTE_DO_CONSENTIMENTO: Dados do pagamento divergentes dos dados do consentimento.
	// Example: A conta selecionada no possui saldo suficiente para realizar o pagamento.
	// Required: true
	// Max Length: 2048
	// Pattern: \w*\W*
	Detail string `json:"detail"`

	// Ttulo especfico do erro reportado, de acordo com o cdigo enviado:
	//
	//  SALDO_INSUFICIENTE: Saldo insuficiente.
	//
	//  BENEFICIARIO_INCOMPATIVEL: Beneficirio incompatvel.
	//
	//  VALOR_INCOMPATIVEL: Valor da transao incompatvel.
	//
	//  VALOR_ACIMA_LIMITE: Acima do limite estabelecido.
	//
	//  VALOR_INVALIDO: Valor invlido.
	//
	//  COBRANCA_INVALIDA: Cobrana invlida.
	//
	//  CONSENTIMENTO_INVALIDO: Consentimento invlido.
	//
	//  JANELA_OPER_INVALIDA: Janela de operao invlida.
	//
	//  NAO_INFORMADO: No informado.
	//
	//  PAGAMENTO_DIVERGENTE_DO_CONSENTIMENTO: divergncia entre pagamento e consentimento.
	// Example: Saldo insuficiente.
	// Required: true
	// Max Length: 255
	// Pattern: \w*\W*
	Title string `json:"title"`
}

Error1 Error1

swagger:model Error1

func (*Error1) ContextValidate

func (m *Error1) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this error1 based on the context it is used

func (*Error1) MarshalBinary

func (m *Error1) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*Error1) UnmarshalBinary

func (m *Error1) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*Error1) Validate

func (m *Error1) Validate(formats strfmt.Registry) error

Validate validates this error1

type Error2

type Error2 struct {

	// Cdigo de erro especfico do endpoint
	// Required: true
	// Max Length: 255
	// Pattern: [\w\W\s]*
	Code string `json:"code"`

	// Descrio legvel por humanos deste erro especfico
	// Required: true
	// Max Length: 2048
	// Pattern: [\w\W\s]*
	Detail string `json:"detail"`

	// Ttulo legvel por humanos deste erro especfico
	// Required: true
	// Max Length: 255
	// Pattern: [\w\W\s]*
	Title string `json:"title"`
}

Error2 Error2

swagger:model Error2

func (*Error2) ContextValidate

func (m *Error2) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this error2 based on context it is used

func (*Error2) MarshalBinary

func (m *Error2) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*Error2) UnmarshalBinary

func (m *Error2) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*Error2) Validate

func (m *Error2) Validate(formats strfmt.Registry) error

Validate validates this error2

type Identification

type Identification struct {

	// Identificao da pessoa envolvida na transao.
	// Preencher com o CPF ou CNPJ, de acordo com o valor escolhido no campo type.
	// O CPF ser utilizado com 11 nmeros e dever ser informado sem pontos ou traos.
	// O CNPJ ser utilizado com 14 nmeros e dever ser informado sem pontos ou traos.
	// Example: 58764789000137
	// Required: true
	// Max Length: 14
	// Min Length: 11
	// Pattern: ^\d{11}$|^\d{14}$
	CpfCnpj string `json:"cpfCnpj"`

	// Em caso de pessoa natural deve ser informado o nome completo do titular da conta do recebedor.
	// Em caso de pessoa jurdica deve ser informada a razo social ou o nome fantasia da conta do recebedor.
	// Example: Marco Antonio de Brito
	// Required: true
	// Max Length: 140
	// Pattern: [\w\W\s]*
	Name string `json:"name"`

	// person type
	// Required: true
	PersonType *EnumPaymentPersonType `json:"personType"`
}

Identification Identification

Objeto contendo os dados do recebedor (creditor).

swagger:model Identification

func (*Identification) ContextValidate

func (m *Identification) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this identification based on the context it is used

func (*Identification) MarshalBinary

func (m *Identification) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*Identification) UnmarshalBinary

func (m *Identification) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*Identification) Validate

func (m *Identification) Validate(formats strfmt.Registry) error

Validate validates this identification

type Links struct {

	// URI completo que gerou a resposta atual.
	// Example: https://api.banco.com.br/open-banking/api/v1/resource
	// Required: true
	// Max Length: 2000
	// Pattern: ^(https?:\/\/)?(www\.)?[-a-zA-Z0-9@:%._\+~#=]{2,256}\.[a-z]{2,6}\b([-a-zA-Z0-9@:%_\+.~#?&\/\/=]*)$
	Self string `json:"self"`
}

Links Links

Referncias para outros recusos da API requisitada.

swagger:model Links

func (*Links) ContextValidate

func (m *Links) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this links based on context it is used

func (*Links) MarshalBinary

func (m *Links) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*Links) UnmarshalBinary

func (m *Links) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*Links) Validate

func (m *Links) Validate(formats strfmt.Registry) error

Validate validates this links

type LoggedUser

type LoggedUser struct {

	// document
	// Required: true
	Document *Document1 `json:"document"`
}

LoggedUser LoggedUser

Usurio (pessoa natural) que encontra-se logado na instituio Iniciadora de Pagamento.

swagger:model LoggedUser

func (*LoggedUser) ContextValidate

func (m *LoggedUser) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this logged user based on the context it is used

func (*LoggedUser) MarshalBinary

func (m *LoggedUser) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*LoggedUser) UnmarshalBinary

func (m *LoggedUser) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*LoggedUser) Validate

func (m *LoggedUser) Validate(formats strfmt.Registry) error

Validate validates this logged user

type Meta

type Meta struct {

	// Data e hora da consulta, conforme especificao RFC-3339, formato UTC.
	// Example: 2021-05-21T08:30:00Z
	// Required: true
	// Format: date-time
	RequestDateTime strfmt.DateTime `json:"requestDateTime"`

	// Nmero total de pginas no resultado
	// Example: 1
	// Required: true
	TotalPages int32 `json:"totalPages"`

	// Nmero total de registros no resultado
	// Example: 1
	// Required: true
	TotalRecords int32 `json:"totalRecords"`
}

Meta Meta

Meta informaes referente a API requisitada.

swagger:model Meta

func (*Meta) ContextValidate

func (m *Meta) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this meta based on context it is used

func (*Meta) MarshalBinary

func (m *Meta) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*Meta) UnmarshalBinary

func (m *Meta) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*Meta) Validate

func (m *Meta) Validate(formats strfmt.Registry) error

Validate validates this meta

type PaymentConsent

type PaymentConsent struct {

	// Valor da transao com 2 casas decimais.
	// Example: 100000.12
	// Required: true
	// Max Length: 19
	// Min Length: 4
	// Pattern: ^((\d{1,16}\.\d{2}))$
	Amount string `json:"amount"`

	// Cdigo da moeda nacional segundo modelo ISO-4217, ou seja, 'BRL'.
	// Todos os valores monetrios informados esto representados com a moeda vigente do Brasil.
	// Example: BRL
	// Required: true
	// Max Length: 3
	// Pattern: ^([A-Z]{3})$
	Currency string `json:"currency"`

	// Data do pagamento, conforme especificao RFC-3339.
	// Example: 2021-01-01
	// Required: true
	// Format: date
	Date strfmt.Date `json:"date"`

	// details
	// Required: true
	Details *Details `json:"details"`

	// Traz o cdigo da cidade segundo o IBGE (Instituto Brasileiro de Geografia e Estatstica).
	// Para o preenchimento deste campo, o Iniciador de Pagamentos deve seguir a orientao do arranjo da forma de pagamento.
	// O preenchimento do campo tanto em pix/payments quanto /consents deve ser igual. Caso haja divergncia dos valores, a instituio deve retornar HTTP 422 com o cdigo de erro PAGAMENTO_DIVERGENTE_DO_CONSENTIMENTO.
	// Este campo faz referncia ao campo CodMun do arranjo Pix.
	// Example: 5300108
	// Max Length: 7
	// Min Length: 7
	// Pattern: ^\d{7}$
	IbgeTownCode string `json:"ibgeTownCode,omitempty"`

	// Este campo define o tipo de pagamento que ser iniciado aps a autorizao do consentimento.
	// Example: PIX
	// Required: true
	Type string `json:"type"`
}

PaymentConsent PaymentConsent

Objeto contendo dados de pagamento para consentimento.

swagger:model PaymentConsent

func (*PaymentConsent) ContextValidate

func (m *PaymentConsent) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this payment consent based on the context it is used

func (*PaymentConsent) MarshalBinary

func (m *PaymentConsent) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*PaymentConsent) UnmarshalBinary

func (m *PaymentConsent) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*PaymentConsent) Validate

func (m *PaymentConsent) Validate(formats strfmt.Registry) error

Validate validates this payment consent

type PaymentPix

type PaymentPix struct {

	// Valor da transao com 2 casas decimais.
	// Example: 100000.12
	// Required: true
	// Max Length: 19
	// Min Length: 4
	// Pattern: ^((\d{1,16}\.\d{2}))$
	Amount string `json:"amount"`

	// Cdigo da moeda nacional segundo modelo ISO-4217, ou seja, 'BRL'.
	// Todos os valores monetrios informados esto representados com a moeda vigente do Brasil.
	// Example: BRL
	// Required: true
	// Max Length: 3
	// Pattern: ^([A-Z]{3})$
	Currency string `json:"currency"`
}

PaymentPix PaymentPix

Objeto contendo dados do pagameto como moeda e valor.

swagger:model PaymentPix

func (*PaymentPix) ContextValidate

func (m *PaymentPix) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this payment pix based on context it is used

func (*PaymentPix) MarshalBinary

func (m *PaymentPix) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*PaymentPix) UnmarshalBinary

func (m *PaymentPix) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*PaymentPix) Validate

func (m *PaymentPix) Validate(formats strfmt.Registry) error

Validate validates this payment pix

type ResponseError

type ResponseError struct {

	// errors
	// Required: true
	// Max Items: 13
	// Min Items: 1
	Errors []*Error2 `json:"errors"`

	// meta
	Meta *Meta `json:"meta,omitempty"`
}

ResponseError ResponseError

swagger:model ResponseError

func (*ResponseError) ContextValidate

func (m *ResponseError) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this response error based on the context it is used

func (*ResponseError) MarshalBinary

func (m *ResponseError) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*ResponseError) UnmarshalBinary

func (m *ResponseError) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*ResponseError) Validate

func (m *ResponseError) Validate(formats strfmt.Registry) error

Validate validates this response error

type ResponsePixPaymentData

type ResponsePixPaymentData struct {

	// CNPJ do Iniciador de Pagamento devidamente habilitado para a prestao de Servio de Iniciao no Pix.
	// Example: 50685362000135
	// Required: true
	// Max Length: 14
	// Pattern: ^\d{14}$
	CnpjInitiator string `json:"cnpjInitiator"`

	// Identificador nico do consentimento criado para a iniciao de pagamento solicitada. Dever ser um URN - Uniform Resource Name.
	// Um URN, conforme definido na [RFC8141](https://tools.ietf.org/html/rfc8141)  um Uniform Resource
	// Identifier - URI - que  atribudo sob o URI scheme "urn" e um namespace URN especfico, com a inteno de que o URN
	// seja um identificador de recurso persistente e independente da localizao.
	// Considerando a string urn:bancoex:C1DD33123 como exemplo para consentId temos:
	// - o namespace(urn)
	// - o identificador associado ao namespace da instituio transnmissora (bancoex)
	// - o identificador especfico dentro do namespace (C1DD33123).
	// Informaes mais detalhadas sobre a construo de namespaces devem ser consultadas na [RFC8141](https://tools.ietf.org/html/rfc8141).
	// Example: urn:bancoex:C1DD33123
	// Required: true
	// Max Length: 256
	// Pattern: ^urn:[a-zA-Z0-9][a-zA-Z0-9-]{0,31}:[a-zA-Z0-9()+,\-.:=@;$_!*'%\/?#]+$
	ConsentID string `json:"consentId"`

	// Data e hora em que o recurso foi criado.
	// Uma string com data e hora conforme especificao RFC-3339,
	// sempre com a utilizao de timezone UTC(UTC time format).
	// Example: 2020-07-21T08:30:00Z
	// Required: true
	// Format: date-time
	CreationDateTime strfmt.DateTime `json:"creationDateTime"`

	// creditor account
	// Required: true
	CreditorAccount *CreditorAccount `json:"creditorAccount"`

	// Deve ser preenchido no formato padro ExxxxxxxxyyyyMMddHHmmkkkkkkkkkkk (32 caracteres; case sensitive, isso , diferencia letras maisculas e minsculas), sendo:
	//  E  fixo (1 caractere);
	//  xxxxxxxx  identificao do agente que gerou o EndToEndId, podendo ser: o ISPB do participante direto ou o ISPB do participante indireto (8 caracteres numricos [0-9]);
	//  yyyyMMddHHmm  data, hora e minuto (12 caracteres), seguindo o horrio UTC, da submisso da ordem de pagamento, caso a liquidao seja prioritria, ou prevista para o envio da ordem ao sistema de liquidao, caso seja realizado um agendamento. Para ordens prioritrias e no prioritrias, aceita-se o preenchimento, pelo agente que gerou o EndToEndId, com uma tolerncia mxima de 12 horas, para o futuro e para o passado, em relao ao horrio efetivo de processamento da ordem pelo SPI;
	//  kkkkkkkkkkk  sequencial criado pelo agente que gerou o EndToEndId (11 caracteres alfanumricos [a-z/A-Z/0-9]). Deve ser nico dentro de cada yyyyMMddHHmm.
	// Admite-se que o EndToEndId seja gerado pelo participante direto, pelo participante indireto ou pelo iniciador de pagamento.
	// Ele deve ser nico, no podendo ser repetido em qualquer outra operao enviada ao SPI.
	// [Restrio] O EndToEndId deve ser informado obrigatoriamente caso o status do pagamento seja ACCEPTED_SETTLEMENT_COMPLETED.
	// Example: E9040088820210128000800123873170
	// Max Length: 32
	// Min Length: 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})$
	EndToEndID string `json:"endToEndId,omitempty"`

	// Traz o cdigo da cidade segundo o IBGE (Instituto Brasileiro de Geografia e Estatstica).
	// Para o preenchimento deste campo, o Iniciador de Pagamentos deve seguir a orientao do arranjo da forma de pagamento.
	// O preenchimento do campo tanto em pix/payments quanto /consents deve ser igual. Caso haja divergncia dos valores, a instituio deve retornar HTTP 422 com o cdigo de erro PAGAMENTO_DIVERGENTE_DO_CONSENTIMENTO.
	// Este campo faz referncia ao campo CodMun do arranjo Pix.
	// Example: 5300108
	// Max Length: 7
	// Min Length: 7
	// Pattern: ^\d{7}$
	IbgeTownCode string `json:"ibgeTownCode,omitempty"`

	// local instrument
	// Required: true
	LocalInstrument *EnumLocalInstrument `json:"localInstrument"`

	// payment
	// Required: true
	Payment *PaymentPix `json:"payment"`

	// Cdigo ou identificador nico informado pela instituio detentora da conta para representar
	// a iniciao de pagamento individual. O `paymentId` deve ser diferente do `endToEndId`.
	// Este  o identificador que dever ser utilizado na consulta ao status da iniciao de pagamento efetuada.
	// Example: TXpRMU9UQTROMWhZV2xSU1FUazJSMDl
	// Required: true
	// Max Length: 100
	// Min Length: 1
	// Pattern: ^[a-zA-Z0-9][a-zA-Z0-9\-]{0,99}$
	PaymentID string `json:"paymentId"`

	// Chave cadastrada no DICT pertencente ao recebedor. Os tipos de chaves podem ser: telefone, e-mail, cpf/cnpj ou chave aleatria.
	// No caso de telefone celular deve ser informado no padro E.1641.
	// Para e-mail deve ter o formato xxxxxxxx@xxxxxxx.xxx(.xx) e no mximo 77 caracteres.
	// No caso de CPF dever ser informado com 11 nmeros, sem pontos ou traos.
	// Para o caso de CNPJ dever ser informado com 14 nmeros, sem pontos ou traos.
	// No caso de chave aleatria 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 validao  opcional caso o localInstrument for igual a INIC.
	// [Restrio] Se localInstrument for igual a MANU, o campo proxy no deve ser preenchido. Se localInstrument for igual INIC, DICT, QRDN ou QRES, o campo proxy deve ser sempre preenchido com a chave Pix.
	// [Restrio] Se localInstrument for igual a MANU, o campo proxy no deve ser preenchido. Se localInstrument for igual INIC, DICT, QRDN ou QRES, o campo proxy deve ser sempre preenchido com a chave Pix.
	// Example: 12345678901
	// Max Length: 77
	// Pattern: [\w\W\s]*
	Proxy string `json:"proxy,omitempty"`

	// rejection reason
	RejectionReason EnumRejectionReasonType `json:"rejectionReason,omitempty"`

	// Deve ser preenchido sempre que o usurio pagador inserir alguma informao adicional em um pagamento, a ser enviada ao recebedor.
	// Example: Pagamento da nota RSTO035-002.
	// Max Length: 140
	// Pattern: [\w\W\s]*
	RemittanceInformation string `json:"remittanceInformation,omitempty"`

	// status
	// Required: true
	Status *EnumPaymentStatusType `json:"status"`

	// Data e hora da ltima atualizao da iniciao de pagamento.
	// Uma string com data e hora conforme especificao RFC-3339,
	// sempre com a utilizao de timezone UTC(UTC time format).
	// Example: 2020-07-21T08:30:00Z
	// Required: true
	// Format: date-time
	StatusUpdateDateTime strfmt.DateTime `json:"statusUpdateDateTime"`

	// Trata-se de um identificador de transao que deve ser retransmitido intacto pelo PSP do pagador ao gerar a ordem de pagamento. Essa informao permitir ao recebedor identificar e correlacionar a transferncia, quando recebida, com a apresentao das instrues ao pagador.
	// Os caracteres permitidos no contexto do Pix para o campo txid (EMV 62-05) so:
	// - Letras minsculas, de a a z
	// - Letras maisculas, de A a z
	// - Dgitos decimais, de 0 a 9
	//
	// [Restrio] Se localInstrument for igual a INIC, o campo transactionIdentification deve ser preenchido obrigatoriamente.
	// Se localInstrument for igual a MANU ou DICT, o campo transactionIdentification no deve ser preenchido.
	// A detentora de conta deve validar se a condicionalidade do campo foi atendida pela iniciadora de pagamento.
	// Example: E00038166201907261559y6j6
	// Max Length: 25
	// Pattern: ^[a-zA-Z0-9][a-zA-Z0-9]{0,24}$
	TransactionIdentification string `json:"transactionIdentification,omitempty"`
}

ResponsePixPaymentData ResponsePixPaymentData

Objeto contendo dados do pagamento e da conta do recebedor (creditor).

swagger:model ResponsePixPaymentData

func (*ResponsePixPaymentData) ContextValidate

func (m *ResponsePixPaymentData) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this response pix payment data based on the context it is used

func (*ResponsePixPaymentData) MarshalBinary

func (m *ResponsePixPaymentData) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*ResponsePixPaymentData) UnmarshalBinary

func (m *ResponsePixPaymentData) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*ResponsePixPaymentData) Validate

func (m *ResponsePixPaymentData) Validate(formats strfmt.Registry) error

Validate validates this response pix payment data

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL