API Reference
API Reference

1. Header

Detalhamento da linha que define o início de um arquivo. Cada arquivo só tem um alinha como essa, sendo obrigatoriamente a última.

🚧

Novos campos

Além dos campos descritos abaixo a MundiPagg poderá incluir novos campos sem aviso prévio ao final da linha do “tipo de registro” Header. A aplicação que irá interpretar o arquivo de movimentação diária deverá estar preparada para receber novos campos além dos especificados abaixo.

CampoTipoDescrição
RegistryTypeStringIdentificador do registro.
01 = Header.
ProcessingTransactionDateDateTime (AAAMMDD)Data em que as transações foram processadas na MundiPagg.
FileGenerationDateDateTime (AAAAMMDD HH:MM:SS)Data e hora em que o arquivo foi gerado.
VersionStringVersão do layout.

2. Registro transações de cartão de crédito

Detalhamento dos campos retornados de uma transação de cartão de crédito. Cada linha do arquivo corresponde a uma transação, o arquivo pode conter 0 ou mais linha nesse formato.

🚧

Novos campos

Além dos campos descritos abaixo a MundiPagg poderá incluir novos campos sem aviso prévio ao final da linha do “tipo de registro” Transação de cartão de crédito. A aplicação que irá interpretar o arquivo de movimentação diária deverá estar preparada para receber novos campos além dos especificados abaixo.

CampoTipoDescrição
RegistryTypeStringIdentificador do registro.
20 = Transação de Cartão de Crédito.
OrderKeyGuidChave do pedido da MundiPagg.
OrderReferenceStringNúmero do pedido enviado pela loja ou gerado pela MundiPagg.
MerchantKeyGuidChave da loja na MundiPagg.
MerchantNameStringNome da loja na MundiPagg.
TransactionKeyGuidChave da transação na MundiPagg.
TransactionKeyToAcquirerStringIdentificação da transação gerada pela MundiPagg e enviada para a adquirente.
TransactionReferenceStringIdentificação da transação enviada pela loja.
CreditCardBrandStringBandeira do cartão de crédito utilizado na transação.
CreditCardNumberStringNúmero do cartão de crédito mascarado, utilizado na transação.
InstallmentCountIntNúmero de parcelas da transação.
AcquirerNameStringAdquirente utilizada para processar a transação.
StatusStringStatus atual da transação na MundiPagg.
AmountInCentsLongValor da transação em centavos.
IataAmountInCentsLongValor de taxa em centavos.
AuthorizationCodeStringCódigo de autorização.
TransactionIdentifierStringTID da transação, identificador da transação gerado pela adquirente.
UniqueSequentialNumberStringNSU da transação, número sequencial da transação gerado pela adquirente.
AuthorizedAmountInCentsLongValor autorizado.
CapturedAmountInCentsLongValor capturado.
VoidedAmountInCentsLongValor cancelado.
RefundedAmountInCentsLongValor estornado.
AcquirerReturnCodeStringCódigo da operação retornado pela adquirente.
AuthorizedDateDateTime (aaa-mm-ddThh:mm:ss)Data de autorização.
CapturedDateDateTime (aaa-mm-ddThh:mm:ss)Data de captura.
VoidedDateDateTime (aaa-mm-ddThh:mm:ss)Data de cancelamento.
LastProbeDateDateTime (aaa-mm-ddThh:mm:ss)Data da última sondagem.
RefundedDateDateTime (aaa-mm-ddThh:mm:ss)Data de estorno.
DueDateDateTime (aaa-mm-ddThh:mm:ss)Data da cobrança agendada da recorrência.
AffiliationCodeStringCódigo de afiliação na adquirente.
ThirdPartyAffiliationCodeStringCódigo de afiliação na SiTef.

📘

Recorrência

No caso de pedidos recorrentes as transações agendadas com o status OpenPedingAuth também aparecerão no arquivo.

3. Registro transações de boleto

Detalhamento dos campos retornados de uma transação de boleto. Cada linha do arquivo corresponde a uma transação, o arquivo pode conter 0 ou mais linha nesse formato.

🚧

Novos campos

Além dos campos descritos abaixo a MundiPagg poderá incluir novos campos sem aviso prévio ao final da linha do “tipo de registro” Transação de boleto. A aplicação que irá interpretar o arquivo de movimentação diária deverá estar preparada para receber novos campos além dos especificados abaixo.

CampoTipoDescrição
RegistryTypeStringIdentificador do registro.
30 = Transação de boleto.
OrderKeyGuidChave do pedido da MundiPagg.
OrderReferenceString
MerchantKeyGuidChave da loja da MundiPagg
MerchantNameStringIdentificação da transação enviada pela loja.
TransactionKeyGuidChave da transação da MundiPagg
TransactionReferenceStringString
StatusStringStatus atual da transação na MundiPagg.
NossoNumeroStringCampo NossoNumero do boleto.
BankNumberStringCódigo do banco emissor do boleto.
AgencyStringAgência bancária vinculada ao boleto.
AccountStringConta do banco vinculada ao boleto.
BarCodeStringCódigo de barras do boleto.
ExpirationDateDateTime (mm/dd/aaaa hh:mm:ss AM/PM)Data de vencimento do boleto.
AmountInCentsLongValor do boleto.
AmountPaidInCentsLongValor pago do boleto.
PaymentDateDateTime (mm/dd/aaaa hh:mm:ss AM/PM)Data em que o boleto foi pago.
CreditDateDateTime (mm/dd/aaaa hh:mm:ss AM/PM)Data de crédito na conta.

4. Registro transações de débito online

Detalhamento dos campos retornados de uma transação de débito online. Cada linha do arquivo corresponde a uma transação, o arquivo pode conter 0 ou mais linha nesse formato.

🚧

Novos campos

Além dos campos descritos abaixo a MundiPagg poderá incluir novos campos sem aviso prévio ao final da linha do “tipo de registro” Transação de débito online. A aplicação que irá interpretar o arquivo de movimentação diária deverá estar preparada para receber novos campos além dos especificados abaixo.

CampoTipoDescrição
RegistryTypeStringIdentificador do registro.
40 = Transação de boleto.
OrderKeyGuidIdentificação do pedido a qual esta transação pertence na MundiPagg.
OrderReferenceStringNúmero do pedido enviado pela loja ou gerado pela MundiPagg.
MerchantKeyGuidChave da loja na MundiPagg.
MerchantNameStringNome da loja na MundiPagg.
TransactionKeyGuidIdentificação da transação na MundiPagg.
TransactionReferenceStringIdentificação da transação enviada pela loja.
BankStringNome do banco que a transação foi efetuada.
StatusStringStatus atual da transação na MundiPagg.
AmountInCentsLongValor da transação.
AmountPaidInCentsLongValor pago da transação.
PaymentDateDateTime (mm/dd/aaaa hh:mm:ss AM/PM)Data do pagamento.
BankReturnCodeStringCódigo de retorno do banco.
BankPaymentDateDateTime (mm/dd/aaaa hh:mm:ss AM/PM)Data de pagamento no banco.
SignatureStringCódigo de afiliação.
TransactionKeyToBankStringIdentificador da transação no banco.

5. Trailler

Detalhamento da linha que define o final do arquivo. Cada arquivo só tem um alinha como essa, sendo obrigatoriamente a última.

🚧

Novos campos

Além dos campos descritos abaixo a MundiPagg poderá incluir novos campos sem aviso prévio ao final da linha do “tipo de registro” Trailer. A aplicação que irá interpretar o arquivo de movimentação diária deverá estar preparada para receber novos campos além dos especificados abaixo.

RegistryTypeStringIdentificador do registro.
99 = Trailler.
OrderCountGuidTotal de pedidos no arquivo.
CreditCardTransactionCountStringTotal de transações de cartão de crédito no arquivo.
BoletoTransactionCountGuidTotal de transações de boleto no arquivo.
OnlineDebitTransactionCountStringTotal de transações de Débito Online no arquivo.
Language
Click Try It! to start a request and see the response here!
Website Localization**/