Salvar cartão durante a autorização

Ambiente	Método	Endpoint
Sandbox	post	`https://apisandbox.braspag.com.br/v2/sales/`
Produção	post	`https://api.braspag.com.br/v2/sales/`

ℹ️
Saiba mais sobre essa funcionalidade na documentação.

Para salvar um cartão de crédito utilizado em uma transação, basta enviar o parâmetro Payment.SaveCard como "true" na requisição padrão de autorização.

Em ambiente sandbox, a numeração do cartão precisa ser válida de acordo com o algoritmo de Lhun (mod10).

Abaixo veja a representação do fluxo transacional com a solicitação do token pela API do Pagador:

Requisição

--request POST "https://apisandbox.braspag.com.br/v2/sales/"
--header "Content-Type: application/json"
--header "MerchantId: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
--header "MerchantKey: 0123456789012345678901234567890123456789"
--header "RequestId: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
--data-binary
{  
   "MerchantOrderId":"2017051001",
   "Customer":{  
      "Name":"Nome do Comprador",
      "Identity":"12345678909",
      "IdentityType":"CPF",
      "Email":"[email protected]",
      "Birthdate":"1991-01-02",
      "IpAddress":"127.0.0.1",
      "Address":{  
         "Street":"Alameda Xingu",
         "Number":"512",
         "Complement":"27 andar",
         "ZipCode":"12345987",
         "City":"São Paulo",
         "State":"SP",
         "Country":"BRA",
         "District":"Alphaville"
      },
      "DeliveryAddress":{  
         "Street":"Alameda Xingu",
         "Number":"512",
         "Complement":"27 andar",
         "ZipCode":"12345987",
         "City":"São Paulo",
         "State":"SP",
         "Country":"BRA",
         "District":"Alphaville"
      }
   },
   "Payment":{  
      "Provider":"Simulado",
      "Type":"CreditCard",
      "Amount":10000,
      "Currency":"BRL",
      "Country":"BRA",
      "Installments":1,
      "Interest":"ByMerchant",
      "Capture":true,
      "Authenticate":false,
      "Recurrent":false,
      "SoftDescriptor":"Mensagem",
      "CreditCard":{  
         "CardNumber":"4551870000000181",
         "Holder":"Nome do Portador",
         "ExpirationDate":"12/2021",
         "SecurityCode":"123",
         "Brand":"Visa",
         "SaveCard":true,
         "Alias":"",
       },
      "Credentials":{  
         "Code":"9999999",
         "Key":"D8888888",
         "Password":"LOJA9999999",
         "Username":"#Braspag2018@NOMEDALOJA#",
         "Signature":"001"
      },
      "ExtraDataCollection":[  
         {  
            "Name":"NomeDoCampo",
            "Value":"ValorDoCampo"
         }
      ]
   }
}
--verbose

Requisição

Ambiente	Método	Endpoint
Sandbox	post	`https://apisandbox.braspag.com.br/v2/sales/`
Produção	post	`https://api.braspag.com.br/v2/sales/`

{  
   "MerchantOrderId":"2017051001",
   "Customer":{  
      "Name":"Aline de Souza",
      "Identity":"12345678909",
      "IdentityType":"CPF",
      "Email":"[email protected]",
      "Birthdate":"1991-01-02",
      "IpAddress":"127.0.0.1",
      "Address":{  
         "Street":"Rua das Rosas",
         "Number":"123",
         "Complement":"apartamento 101",
         "ZipCode":"12345987",
         "City":"São Paulo",
         "State":"SP",
         "Country":"BRA",
         "District":"Alphaville"
      },
   },
   "Payment":{  
      "Provider":"Simulado",
      "Type":"CreditCard",
      "Amount":10000,
      "Currency":"BRL",
      "Country":"BRA",
      "Installments":1,
      "Capture":true,
      "Authenticate":false,
      "Recurrent":false,
      "SoftDescriptor":"Mensagem",
      "CreditCard":{  
         "CardNumber":"4091688625337641",
         "Holder":"Nome do Portador",
         "ExpirationDate":"12/2035",
         "SecurityCode":"333",
         "Brand":"Visa",
         "SaveCard":true,
         "Alias":"apelido-do-cartao",
       },
   }
}

Parâmetros no cabeçalho (header)

Propriedade	Descrição	Tipo	Tamanho	Obrigatório
`MerchantId`	Identificador da loja no Gateway de Pagamentos.	Text	36	Sim
`MerchantKey`	Chave pública para autenticação dupla no Gateway de Pagamentos.	Text	40	Sim
`RequestId`	Identificador da requisição, usado quando a loja usa diferentes servidores para cada GET/POST/PUT.	Text	36	Não

Parâmetros no corpo (body)

A tabela abaixo destaca os principais parâmetros da requisição. Para a lista completa, consulte o exemplo da transação de cartão de crédito completa .

Propriedade	Descrição	Tipo	Tamanho	Obrigatório?
`Payment.Provider`	Nome do provedor do meio de pagamento.	texto	15	Sim
`Payment.Type`	Tipo do meio de pagamento.	texto	100	Sim
`Payment.Amount`	Valor do pedido, em centavos.	número	15	Sim
`Payment.Installments`	Número de parcelas.	número	2	Sim
`Payment.CreditCard.CardNumber`	Token no Cartão Protegido que representa os dados do cartão.	GUID	36	xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
`Payment.CreditCard.Holder`	Nome do comprador impresso no cartão. Obs.: Regras de tamanho do campo podem variar de acordo com a adquirente.	texto	25	Sim
`Payment.CreditCard.ExpirationDate`	Data de validade impressa no cartão, no formato MM/AAAA.	texto	7	Sim
`Payment.CreditCard.CardNumber`	Número do cartão do comprador.	número	19	Sim
`Payment.CreditCard.SecurityCode`	Código de segurança impresso no verso do cartão. Para processar vendas sem o CVV, é necessário solicitar liberação na adquirente.	texto	4	Não
`Payment.CreditCard.Brand`	Bandeira do cartão.	texto	10	Sim
`Payment.CreditCard.SaveCard`	"true" - para salvar o cartão. "false" - para não salvar o cartão.	booleano	-	Default: false
`Payment.CreditCard.Alias`	Alias (apelido) do cartão de crédito.	texto	64	Não

Resposta

{  
     "Payment": {
        "Provider": "Simulado",
        "Type": "CreditCard",
        "Amount": 10000,
        "Currency": "BRL",
        "Country": "BRA",
        "Installments": 1,
        "Capture": true,
        "Authenticate": false,
        "Recurrent": false,
        "SoftDescriptor": "Mensagem",
        "CreditCard": {
            "CardToken":"250e7c7c-5501-4a7c-aa42-a33d7ad61167",
            "SecurityCode":"123",
            "Brand":"Visa"
            },
    "ProofOfSale": "124305",
    "AcquirerTransactionId": "0511030124305",
    "AuthorizationCode": "065964",
    "PaymentId": "23cd8bf5-2251-4991-9042-533ff5608788",
    "Type": "CreditCard",
    "Amount": 10000,
    "ReceivedDate": "2017-05-11 15:01:24",
    "Currency": "BRL",
    "Country": "BRA",
    "Provider": "Simulado",
    "ReasonCode": 0,
    "ReasonMessage": "Successful",
    "Status": 1,
    "ProviderReturnCode": "4",
    "ProviderReturnMessage": "Operation Successful"
  }
}

Confira a seguir os principais retornos da API:

Propriedade	Descrição	Tipo	Tamanho	Formato
`AcquirerTransactionId`	Id da transação no provedor de meio de pagamento.	texto	40	texto alfanumérico
`ProofOfSale`	Número do comprovante de venda.	texto	20	texto alfanumérico
`AuthorizationCode`	Código de autorização.	texto	300	texto alfanumérico
`PaymentId`	Campo identificador do pedido.	GUID	36	xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
`ReceivedDate`	Data em que a transação foi recebida.	texto	19	AAAA-MM-DD HH:mm:SS
`ReasonCode`	Código de retorno da API para indicar sucesso ou erro na operação.	texto	32	texto alfanumérico
`ReasonMessage`	Mensagem correspondente ao `ReasonCode`.	texto	512	texto alfanumérico
`Status`	Status da transação. Veja a lista completa de Status da Transação.	byte	2	Ex.: 1
`ProviderReturnCode`	Código retornado pelo provedor do meio de pagamento (adquirente ou emissor).	texto	32	57
`ProviderReturnMessage`	Mensagem retornada pelo provedor do meio de pagamento (adquirente ou emissor).	texto	512	Transação Aprovada