PaymentCreditCard POST
Cria uma transação recebendo pagamento por cartão de crédito.
A transação pode ser feita utilizando somente o card_id (criado no recurso CreditCardToken) ou incluindo todas as informações do cartão de crédito.
A verificação da situação do pagamento deve ser verificada no campo status, podendo retornar os seguintes valores:
pending_payment : Transação pendente pagamento
in_analysis : Em Análise pelo Antifraude
approved : Pagamento Confirmado
denied : Pagamento não aprovado
denied_risk : Pagamento negado pelo Antifraude
Para testar os modelos de resposta no ambiente Sandbox, basta enviar os valores:
De R$ 100,00 até R$ 200,00 - A transação será aprovada automaticamente pelo antifraude.
De R$ 200,01 até R$ 300,00 - A transação será negada automaticamente pelo antifraude.
De R$ 300,01 até R$ 400,00 - A transação será marcada em análise pelo antifraude.
Para qualquer outro valor, a transação será negada antes de passar pelo antifraude.
/payment-credit-card
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| customer_name | string | Nome do cliente que está fazendo a compra |
YES |
| customer_email | string | Email do cliente que está fazendo a compra |
YES |
| customer_type | string | Tipo de pessoa: Utilize PF para Pessoa Física Utilize PJ para Pessoa Jurídica |
YES |
| customer_taxvat | string | Número do CPF ou CNPJ do cliente |
YES |
| customer_phone | string | Telefone do comprador |
YES |
| customer_address | object | Endereço do comprador |
YES |
| reference_id | string | Identificador do pedido na plataforma do vendedor |
YES |
| order_total | float | Valor total do pedido |
YES |
| order_items | object | Lista de itens/produtos da compra realizada |
YES |
| shipment | object | Informações da entrega do pedido |
NO |
| notification_url | string | URL para envio de notificação (Webhook) |
NO |
| installments | int | Número de parcelas |
YES |
| capture | boolean | Enviar "1" para true, e "0" para false. Caso "1", fará a captura automática. Caso "0", será necessário capturar a transação posterior. Para capturar transação posterior é necessário solicitar liberação com nossa equipe. |
YES |
| card_id | int | ID do cartão de crédito salvo (No recurso CreditCardToken). Caso enviado, não é necessário enviar as informações do cartão de crédito. |
NO |
| card_holder_name | string | Nome do titular do cartão de crédito impresso no cartão |
NO |
| card_expiration_month | string | Mês de expiração do cartão de crédito |
NO |
| card_expiration_year | string | Ano de expiração do cartão de crédito |
NO |
| card_number | string | Número do cartão de crédito |
NO |
| card_security_code | string | Código de segurança do cartão |
YES |
| save_credit_card | boolean | Enviar "1" para true, e "0" para false. Caso 1, salva o cartão de crédito para futuras compras. Valor padrão: 0. |
NO |
| customer_ip | string | IPV4 ou IPV6 do comprador |
YES |
| card_taxvat | string | Número do CPF do titular do cartão |
YES |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/json |
| Content-Type | application/json |
| Authorization | Bearer token |
Request Body
{
"customer_name":"João Silva",
"customer_email":"[email protected]",
"customer_type":"PF",
"customer_taxvat":"12312312344",
"customer_address":{
"postalcode":"17980-202",
"street":"Rua Tocantins",
"number":"3227",
"district":"Quinta das Iaras",
"city":"Panorama",
"uf":"SP",
"country":"BR"
},
"customer_phone":"149888877771",
"customer_ip": "186.208.139.46",
"reference_id":"122212",
"order_total":"4.22",
"order_items":[
{
"id":"1122",
"name":"Consultoria",
"qty":"1",
"unit_price":"4.22",
"total":"4.22"
}
],
"shipment":{
"shipment_price":"0.00",
"shipment_address":{
"postalcode":"17980-202",
"street":"Rua Tocantins",
"number":"3227",
"district":"Quinta das Iaras",
"city":"Panorama",
"uf":"SP",
"country":"BR"
}
},
"installments": "2",
"capture": "1",
"card_id": "14",
"card_security_code": "643",
"card_taxvat": "000.000.000-51",
"notification_url":"www.seusite.com"
}
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 201: Created
- 400: Client Error
- 422: Unprocessable Entity
- 401: Unauthorized
- 403: Forbidden
Headers
| Header | Value |
|---|---|
| Content-Type | application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Response Body
{
"id": "1234",
"customer_phone": "149888877771",
"transaction_type": "cc",
"point_of_sale": "online",
"reference_id": "122212",
"status": "approved",
"transaction_order_total": "4.22",
"transaction_fee": "0.25",
"fraud_fee": "0.99",
"transaction_amount": "2.98",
"address_postal_code": "17980202",
"address_street": "Rua Tocantins",
"address_number": "3227",
"address_complement": null,
"address_district": "Quinta das Iaras",
"address_state": "SP",
"address_city": "Panorama",
"address_country": "BR",
"shipping_postal_code": "17980202",
"shipping_street": "Rua Tocantins",
"shipping_number": "3227",
"shipping_complement": null,
"shipping_district": "Quinta das Iaras",
"shipping_state": "SP",
"shipping_city": "Panorama",
"shipping_country": "BR",
"shipping_amount": "0.00",
"transaction_history": [
{
"date": "2024-12-12 15:11:53",
"message_type": "thistory_default",
"history_message": "Compra efetuada"
},
{
"date": "2024-12-12 15:11:56",
"message_type": "thistory_default",
"history_message": "Transação autorizada"
},
{
"date": "2024-12-12 15:11:56",
"message_type": "thistory_default",
"history_message": "Em análise de fraude"
},
{
"date": "2024-12-12 15:13:27",
"message_type": "thistory_default",
"history_message": "Transação capturada"
},
{
"date": "2024-12-12 15:13:48",
"message_type": "thistory_default",
"history_message": "Pagamento confirmado"
}
],
"payment_data": {
"installments": "2",
"customer_ip": "186.208.139.46",
"card_id": 14,
"card_brand": "mastercard",
"first4_digits": "5162",
"last4_digits": "3971",
"id": "28239d39245242dea8074c21288ceebb",
"transaction_number": "Z313085-11172412121200585737",
"authorizer_id": "11172412121200585737",
"authorization_code": "313085",
"nsu": "376294729",
"capture_id": "28239d39245242dea8074c21288ceebb"
},
"has_split": 0,
"is_splited": 0,
"notification_url": "www.seusite.com",
"created_at": "2024-12-12 15:11:53",
"updated_at": "2024-12-12 15:11:53"
}