As bandeiras Mastercard, Visa e Elo possuem um programa de Operadoras de carteiras Digitais Escalonadas (SDWO), consulte aqui Carteiras digitais escalonada (SDWO).
Exemplo de Requisição
POST:
- Ambiente de Testes: https://testapi.maxipago.net/UniversalAPI/postXML
- Ambiente de Produção: https://api.maxipago.net/UniversalAPI/postXML
Exemplo de Requisição – Cash-in
Cash-in
- A carteira é abastecida com fundos através de uma transação financeira utilizando o cartão cadastrado previamente em sua plataforma, para posterior utilização;
- Carteiras de pedágio realizam apenas operações de cash-in, e devem utilizar corretamente os parâmetros indicados na tabela de relação de campos de Cash-in por bandeira.
Atenção: Para Elo, só é permitido realizar cash-in através de cartões de débito, sendo permitido também para cartões pré-pago. Para Hipercard, não é permitido realizar cash-in, por isso as transações submetidas nesse arranjo serão negadas.
<?xml version="1.0" encoding="UTF-8" standalone="yes"?> <transaction-request> <verification> <merchantId>store-id</merchantId> <merchantKey>store-key</merchantKey> </verification> <version>3.1.1.15</version> <order> <sale> <processorID>5</processorID> <referenceNum>0194f0fd-e281-76b6-90d9-247d79183df4-0</referenceNum> <fraudCheck>N</fraudCheck> <ipAddress>45.179.224.184</ipAddress> <billing> <name>Cliente Gateway</name> <address>R. Volkswagen 1</address> <address2>11º Andar</address2> <district>Jabaquara</district> <city>Sao Paulo</city> <state>SP</state> <postalcode>04344902</postalcode> <country>BR</country> <phone>1140044828</phone> <email>clientegateway@clientegateway.com.br</email> <companyName>maxiPago!</companyName> <id>123</id> <birthDate>1989-01-10</birthDate> <phones/> <documents> <document> <documentType>CPF</documentType> <documentValue>52167295340</documentValue> </document> </documents> </billing> <shipping> <name>Cliente Gateway</name> <address>R. Volkswagen 1</address> <address2>11º Andar</address2> <district>Jabaquara</district> <city>Sao Paulo</city> <state>SP</state> <postalcode>04344902</postalcode> <country>BR</country> <phone>1140044828</phone> <email>clientegateway@clientegateway.com.br</email> <id>123</id> <phones> <phone> <phoneCountryCode>0</phoneCountryCode> <phoneType>Mobile</phoneType> <phoneAreaCode>11</phoneAreaCode> <phoneNumber>966665555</phoneNumber> <phoneExtension></phoneExtension> </phone> </phones> <documents> <document> <documentType>CPF</documentType> <documentValue>74664446446</documentValue> </document> </documents> </shipping> <transactionDetail> <payType> <creditCard> <number>5510156038012409</number> <expMonth>12</expMonth> <expYear>2028</expYear> </creditCard> </payType> </transactionDetail> <payment> <chargeTotal>300.00</chargeTotal> <currencyCode>BRL</currencyCode> <softDescriptor>FRANK</softDescriptor> <creditInstallment> <chargeInterest>N</chargeInterest> <numberOfInstallments>1</numberOfInstallments> </creditInstallment> </payment> <itemList itemCount="1"> <item> <itemIndex>1</itemIndex> <sellerMcc>6051</sellerMcc> </item> </itemList> <authentication> <challengePreference>NO_PREFERENCE</challengePreference> <mpiProcessorID>41</mpiProcessorID> <onFailure>decline</onFailure> </authentication> <device> <deviceType3ds>BROWSER</deviceType3ds> <colorDepth>24</colorDepth> <javaEnabled>false</javaEnabled> <language>pt-BR</language> <screenHeight>904</screenHeight> <screenWidth>407</screenWidth> <timeZoneOffset>3</timeZoneOffset> </device> <wallet> <sdwo> <id>1234567890</id> <processingType>Cash-in</processingType> <paymentDestination>04</paymentDestination> <businessApplicationIdentifier>01</businessApplicationIdentifier> <merchantTaxId>11122233344455</merchantTaxId> <receiverData> <firstName>Jose</firstName> <lastName>Silva</lastName> <taxIdNumber>3141231117715</taxIdNumber> <walletAccountIdentification>342432409286406158</walletAccountIdentification> </receiverData> <senderData> <taxIdNumber>3141231117715</taxIdNumber> </senderData> </sdwo> </wallet> </sale> </order> </transaction-request>
Exemplo de Retorno com Sucesso
<?xml version="1.0" encoding="UTF-8"?> <transaction-response> <authCode>123456</authCode> <orderID>0A0104AB:0195235EE500:CE19:718C874D</orderID> <referenceNum>0194f0fd-e281-76b6-90d9-247d79183df4-0</referenceNum> <transactionID>18802414</transactionID> <transactionTimestamp>1740055176</transactionTimestamp> <responseCode>0</responseCode> <responseMessage>CAPTURED</responseMessage> <avsResponseCode>YYY</avsResponseCode> <cvvResponseCode>M</cvvResponseCode> <processorCode>A</processorCode> <processorMessage>APPROVED</processorMessage> <processorName>SIMULATOR</processorName> <creditCardBin>515590</creditCardBin> <creditCardLast4>5017</creditCardLast4> <errorMessage/> <partiallyApprovedAmount>150.0</partiallyApprovedAmount> <processorTransactionID>813189</processorTransactionID> <processorReferenceNumber>1082732</processorReferenceNumber> <creditCardCountry>US</creditCardCountry> <creditCardScheme>Mastercard</creditCardScheme> <authenticated>Y</authenticated> <brandCode>0</brandCode> <brandMessage>BRAND MESSAGE</brandMessage> <brandTransactionID>123456</brandTransactionID> </transaction-response>
Exemplo de Retorno com Falha
<?xml version="1.0" encoding="UTF-8"?> <transaction-response> <authCode/> <orderID/> <referenceNum/> <transactionID/> <transactionTimestamp>1739813504282</transactionTimestamp> <responseCode>1024</responseCode> <responseMessage>INVALID REQUEST</responseMessage> <avsResponseCode/> <cvvResponseCode/> <processorCode/> <processorMessage/> <processorName>SIMULATOR</processorName> <creditCardBin>515590</creditCardBin> <creditCardLast4>5017</creditCardLast4> <errorMessage>Credit Card Number is not a valid credit card number.</errorMessage> <creditCardScheme>Mastercard</creditCardScheme> </transaction-response>
<?xml version="1.0" encoding="UTF-8" standalone="yes"?> <api-error> <errorCode>1</errorCode> <errorMsg> <![CDATA[Schema validation for the vertical SA for the incoming transaction xml failed. Reason Parser Error: URI=null Line=1: cvc-enumeration-valid: Value '1' is not facet-valid with respect to enumeration '[Cash-in, Purchase]'. It must be a value from the enumeration.]]> </errorMsg> </api-error>
Exemplo de Requisição – Purchase
Purchase
- A carteira realiza uma transação financeira a um lojista parceiro ou transfere valores entre carteiras, utilizando o cartão cadastrado previamente em sua plataforma.
<?xml version="1.0" encoding="UTF-8" standalone="yes"?> <transaction-request> <verification> <merchantId>store-id</merchantId> <merchantKey>store-key</merchantKey> </verification> <version>3.1.1.15</version> <order> <sale> <processorID>5</processorID> <referenceNum>0194f0fd-e281-76b6-90d9-247d79183df4-0</referenceNum> <fraudCheck>N</fraudCheck> <ipAddress>45.179.224.184</ipAddress> <billing> <name>Cliente Gateway</name> <address>R. Volkswagen 1</address> <address2>11º Andar</address2> <district>Jabaquara</district> <city>Sao Paulo</city> <state>SP</state> <postalcode>04344902</postalcode> <country>BR</country> <phone>1140044828</phone> <email>clientegateway@clientegateway.com.br</email> <companyName>maxiPago!</companyName> <id>123</id> <birthDate>1989-01-10</birthDate> <phones/> <documents> <document> <documentType>CPF</documentType> <documentValue>52167295340</documentValue> </document> </documents> </billing> <shipping> <name>Cliente Gateway</name> <address>R. Volkswagen 1</address> <address2>11º Andar</address2> <district>Jabaquara</district> <city>Sao Paulo</city> <state>SP</state> <postalcode>04344902</postalcode> <country>BR</country> <phone>1140044828</phone> <email>clientegateway@clientegateway.com.br</email> <id>123</id> <phones> <phone> <phoneCountryCode>0</phoneCountryCode> <phoneType>Mobile</phoneType> <phoneAreaCode>11</phoneAreaCode> <phoneNumber>966665555</phoneNumber> <phoneExtension></phoneExtension> </phone> </phones> <documents> <document> <documentType>CPF</documentType> <documentValue>74664446446</documentValue> </document> </documents> </shipping> <transactionDetail> <payType> <creditCard> <number>5510156038012409</number> <expMonth>12</expMonth> <expYear>2028</expYear> </creditCard> </payType> </transactionDetail> <payment> <chargeTotal>300.00</chargeTotal> <currencyCode>BRL</currencyCode> <softDescriptor>FRANK</softDescriptor> <creditInstallment> <chargeInterest>N</chargeInterest> <numberOfInstallments>1</numberOfInstallments> </creditInstallment> </payment> <itemList itemCount="1"> <item> <itemIndex>1</itemIndex> <sellerMcc>6051</sellerMcc> </item> </itemList> <authentication> <challengePreference>NO_PREFERENCE</challengePreference> <mpiProcessorID>41</mpiProcessorID> <onFailure>decline</onFailure> </authentication> <device> <deviceType3ds>BROWSER</deviceType3ds> <colorDepth>24</colorDepth> <javaEnabled>false</javaEnabled> <language>pt-BR</language> <screenHeight>904</screenHeight> <screenWidth>407</screenWidth> <timeZoneOffset>3</timeZoneOffset> </device> <wallet> <sdwo> <id>1234567890</id> <processingType>Purchase</processingType> </sdwo> </wallet> </sale> </order> </transaction-request>
Exemplo de Retorno com Sucesso
<?xml version="1.0" encoding="UTF-8"?> <transaction-response> <authCode>123456</authCode> <orderID>0A0104AB:019523631A7F:CE30:25A7677F</orderID> <referenceNum>0194f0fd-e281-76b6-90d9-247d79183df4-0</referenceNum> <transactionID>18802418</transactionID> <transactionTimestamp>1740055452</transactionTimestamp> <responseCode>0</responseCode> <responseMessage>CAPTURED</responseMessage> <avsResponseCode>YYY</avsResponseCode> <cvvResponseCode>M</cvvResponseCode> <processorCode>A</processorCode> <processorMessage>APPROVED</processorMessage> <processorName>SIMULATOR</processorName> <creditCardBin>515590</creditCardBin> <creditCardLast4>5017</creditCardLast4> <errorMessage/> <partiallyApprovedAmount>150.0</partiallyApprovedAmount> <processorTransactionID>651853</processorTransactionID> <processorReferenceNumber>803262</processorReferenceNumber> <creditCardCountry>US</creditCardCountry> <creditCardScheme>Mastercard</creditCardScheme> <authenticated>Y</authenticated> <brandCode>0</brandCode> <brandMessage>BRAND MESSAGE</brandMessage> <brandTransactionID>123456</brandTransactionID> </transaction-response>
Exemplo de Retorno com Falha
<?xml version="1.0" encoding="UTF-8"?> <transaction-response> <authCode/> <orderID/> <referenceNum/> <transactionID/> <transactionTimestamp>1740055560910</transactionTimestamp> <responseCode>1024</responseCode> <responseMessage>INVALID REQUEST</responseMessage> <avsResponseCode/> <cvvResponseCode/> <processorCode/> <processorMessage/> <processorName>SIMULATOR</processorName> <creditCardBin>515590</creditCardBin> <creditCardLast4>5018</creditCardLast4> <errorMessage>Credit Card Number is not a valid credit card number.</errorMessage> <creditCardScheme>Mastercard</creditCardScheme> </transaction-response>
Exemplo de Requisição – CBPS
<?xml version="1.0" encoding="UTF-8" standalone="yes"?> <transaction-request> <verification> <merchantId>store-id</merchantId> <merchantKey>store-key</merchantKey> </verification> <version>3.1.1.15</version> <order> <sale> <processorID>5</processorID> <referenceNum>0194f0fd-e281-76b6-90d9-247d79183df4-0</referenceNum> <fraudCheck>N</fraudCheck> <ipAddress>45.179.224.184</ipAddress> <billing> <name>Cliente Gateway</name> <address>R. Volkswagen 1</address> <address2>11º Andar</address2> <district>Jabaquara</district> <city>Sao Paulo</city> <state>SP</state> <postalcode>04344902</postalcode> <country>BR</country> <phone>1140044828</phone> <email>clientegateway@clientegateway.com.br</email> <companyName>maxiPago!</companyName> <id>123</id> <birthDate>1989-01-10</birthDate> <phones/> <documents> <document> <documentType>CPF</documentType> <documentValue>52167295340</documentValue> </document> </documents> </billing> <shipping> <name>Cliente Gateway</name> <address>R. Volkswagen 1</address> <address2>11º Andar</address2> <district>Jabaquara</district> <city>Sao Paulo</city> <state>SP</state> <postalcode>04344902</postalcode> <country>BR</country> <phone>1140044828</phone> <email>clientegateway@clientegateway.com.br</email> <id>123</id> <phones> <phone> <phoneCountryCode>0</phoneCountryCode> <phoneType>Mobile</phoneType> <phoneAreaCode>11</phoneAreaCode> <phoneNumber>966665555</phoneNumber> <phoneExtension></phoneExtension> </phone> </phones> <documents> <document> <documentType>CPF</documentType> <documentValue>74664446446</documentValue> </document> </documents> </shipping> <transactionDetail> <payType> <creditCard> <number>5510156038012409</number> <expMonth>12</expMonth> <expYear>2028</expYear> </creditCard> </payType> </transactionDetail> <payment> <chargeTotal>300.00</chargeTotal> <currencyCode>BRL</currencyCode> <softDescriptor>FRANK</softDescriptor> <creditInstallment> <chargeInterest>N</chargeInterest> <numberOfInstallments>1</numberOfInstallments> </creditInstallment> </payment> <itemList itemCount="1"> <item> <itemIndex>1</itemIndex> <sellerMcc>6051</sellerMcc> </item> </itemList> <authentication> <challengePreference>NO_PREFERENCE</challengePreference> <mpiProcessorID>41</mpiProcessorID> <onFailure>decline</onFailure> </authentication> <device> <deviceType3ds>BROWSER</deviceType3ds> <colorDepth>24</colorDepth> <javaEnabled>false</javaEnabled> <language>pt-BR</language> <screenHeight>904</screenHeight> <screenWidth>407</screenWidth> <timeZoneOffset>3</timeZoneOffset> </device> <wallet> <sdwo> <id>1234567890</id> <processingType>Purchase</processingType> <paymentDestination>04</paymentDestination> <businessApplicationIdentifier>01</businessApplicationIdentifier> <merchantTaxId>11122233344455</merchantTaxId> </sdwo> </wallet> </sale> </order> </transaction-request>