Card on File

AmbienteMétodoEndpoint
Sandboxhttps://apisandbox.braspag.com.br/v1/sales/
Produçãohttps://api.braspag.com.br/v1/sales/

ℹ️

Saiba mais sobre essa funcionalidade na documentação.


POST /1/sales/
{  
   "MerchantOrderId":"2014111701",
   "Customer":{  
      "Name":"Comprador crédito completo",
      "Email":"[email protected]",
      "Birthdate":"1991-01-02"
   },
   "Payment":{  
     "Type":"DebitCard",
     "Amount":15700,
     "Currency":"BRL",
     "Country":"BRA",
     "Installments":1,
     "Capture":true,
     "Authenticate":"false",
     "SoftDescriptor":"123456789ABCD",
     "DebitCard":{  
         "CardNumber":"1234123412341231",
         "Holder":"Teste Holder",
         "ExpirationDate":"12/2030",
         "SecurityCode":"123",
         "SaveCard":"false",
         "Brand":"Visa",
         "CardOnFile":{
            "Usage": "First",
            "Reason":"Recurring"
         }
     }
   }
}
PROPRIEDADETIPOTAMANHOOBRIGATÓRIODESCRIÇÃO
MerchantOrderIdTexto50SimNúmero de identificação do pedido. Atenção: Os caracteres permitidos são apenas a-z, A-Z, 0-9. Não são permitidos caracteres especiais e espaços em branco.
Customer.NameTexto255NãoNome do comprador.
Customer.StatusTexto255NãoStatus de cadastro do comprador na loja (NEW / EXISTING)
Customer.EmailTexto255NãoE-mail do comprador.
Customer.BirthdateDate10NãoData de nascimento do comprador (AAAA/MM/DD).
Payment.TypeTexto100SimTipo do meio de pagamento.
Payment.AmountNúmero15SimValor do pedido (ser enviado em centavos).
Payment.CurrencyTexto3NãoMoeda na qual o pagamento será feito (BRL).
Payment.CountryTexto3NãoPaís na qual o pagamento será feito.
Payment.SoftDescriptorTexto13NãoO complemento do nome da loja que aparecerá na fatura do cartão. Não permite caracteres especiais.
Payment.InstallmentsNúmero2SimNúmero de parcelas. Se a transação for uma recorrência, o número de parcelas será 1. Para transações parceladas, o número de parcelas será sempre maior que 1.
Payment.CaptureBooleanoNão (Default false)Booleano que identifica que a autorização deve ser com captura automática (“true”) ou captura posterior (“false”).
DebitCard.CardNumberTexto19SimNúmero do cartão do comprador.
DebitCard.HolderTexto25SimNome do comprador impresso no cartão. Não aceita caracteres especiais ou acentuação.
DebitCard.ExpirationDateTexto7SimData de validade impressa no cartão. Ex. MM/AAAA.
DebitCard.SecurityCodeTexto4NãoCódigo de segurança impresso no verso do cartão.
DebitCard.SaveCardBooleanoNão (Default false)Booleano que identifica se o cartão será salvo para gerar o CardToken. Saiba mais sobre Tokenização.
DebitCard.BrandTexto10SimBandeira do cartão. Valores possíveis: Visa / Master / Amex / Elo / Aura / JCB / Diners / Discover / Hipercard.
DebitCard.CardOnFile.UsageTexto-NãoValores válidos para as adquirentes Cielo, rede Safra e Getnet.
"First" se o cartão foi armazenado e é seu primeiro uso.
"Used" se o cartão foi armazenado e ele já foi utilizado anteriormente em outra transação
DebitCard.CardOnFile.ReasonTexto-CondicionalIndica o propósito de armazenamento de cartões caso o campo CardOnFile.Usage seja “Used”.
Valores válidos para as adquirentes Cielo, Rede e Safra:
Recurring: compra recorrente programada (ex. assinaturas). Se for transação recorrente, usar Payment.Recurrent = true (recorrência própria) ou Recurrent.Payment = true (recorrência programada).
Unscheduled: compra recorrente sem agendamento (ex. aplicativos de serviços).
Installments: parcelamento através da recorrência.

Valores válidos para a adquirente Getnet:
NewAuthorization: nova autorização;
Unscheduled: pagamento não agendado;
DelayedCharge: atrasos de cobrança;
Incremental: pagamento incremental;
Others: outros motivos;
Recurring: recorrente agendado;
Resubmission: reenvio;
NoShow: para uma reserva de hotel.

Resposta

{
    "MerchantOrderId": "2014111701",
    "Customer": {
        "Name": "Comprador crédito completo",
        "Email": "[email protected]",
        "Birthdate": "1991-01-02"
    },
    "Payment": {
        "ServiceTaxAmount": 0,
        "Installments": 1,
        "Capture": true,
        "Authenticate": false,
         "DebitCard": {
            "CardNumber": "123412******1231",
            "Holder": "Teste Holder",
            "ExpirationDate": "12/2030",
            "SaveCard": false,
            "Brand": "Visa",
            "CardOnFile": {
                "Usage": "First",
                "Reason": "Recurring"
            },
            "PaymentAccountReference": "JZHOZJHNZH87KQXM3G60B9I21GVZN"
        },
        "Tid": "0928084922246",
        "ProofOfSale": "652515",
        "AuthorizationCode": "927181",
        "SoftDescriptor": "123456789ABCD",
        "Provider": "Simulado",
        "IsQrCode": false,
        "DynamicCurrencyConversion": false,
        "Amount": 15700,
        "ReceivedDate": "2022-09-28 08:49:22",
        "CapturedAmount": 15700,
        "CapturedDate": "2022-09-28 08:49:22",
        "Status": 2,
        "IsSplitted": false,
        "ReturnMessage": "Operation Successful",
        "ReturnCode": "6",
        "PaymentId": "91bad53a-9198-4738-a280-f51dddc34988",
        "Type": "CreditCard",
        "Currency": "BRL",
        "Country": "BRA",
        "Links": [
            {
                "Method": "GET",
                "Rel": "self",
                "Href": "https://apisandbox.braspag.com.br/1/sales/91bad53a-9198-4738-a280-f51dddc34988"
            },
            {
                "Method": "PUT",
                "Rel": "void",
                "Href": "https://api.braspag.com.br/1/sales/91bad53a-9198-4738-a280-f51dddc34988/void"
            }
        ]
    }
}
PROPRIEDADEDESCRIÇÃOTIPOTAMANHOFORMATO
ProofOfSaleNúmero da autorização, identico ao NSU.Texto6Texto alfanumérico
TidId da transação na adquirente.Texto20Texto alfanumérico
AuthorizationCodeCódigo de autorização.Texto6Texto alfanumérico
SoftDescriptorTexto impresso na fatura bancária do portador. Não permite caracteres especiais.Texto13Texto alfanumérico
PaymentIdNúmero de identificação do pagamento, necessário para futuras operações como Consulta, Captura e Cancelamento.Guid36xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
ECIEletronic Commerce Indicator. Representa o quão segura é uma transação.Texto2Exemplo: 7
StatusStatus da Transação.Byte2
ReturnCodeCódigo de retorno da Adquirência.Texto32Texto alfanumérico
ReturnMessageMensagem de retorno da Adquirência.Texto512Texto alfanumérico
Payment.MerchantAdviceCodeCódigo de retorno da bandeira que define período para retentativa. Válido somente para bandeira Mastercard. Saiba mais em Programa de Retentativa das Bandeiras MastercardTexto2Numérico
DebitCard.PaymentAccountReferenceO PAR (Payment Account Reference) é o número que associa diferentes tokens a um mesmo cartão. Será retornado pelas bandeiras Master e Visa e repassado para os clientes do e-commerce Cielo. Caso a bandeira não envie a informação o campo não será retornado.Se for pra transação de débito, colocar o campo dentro do nó de DebitCard.Alfanumérico29