Endpoint Examples
Checkout Transparente
API Documentation
Endpoint Examples
Checkout Transparente
Cria uma nova transação de checkout transparente
POST
/
transaction
curl --request POST \
--url https://gateway.3xpay.co/transaction \
--header 'Content-Type: application/json' \
--header 'api_key: <api-key>' \
--header 'api_secret: <api-key>' \
--data '{
"transaction": {
"customer_infos": {
"name": "<string>",
"email": "<string>",
"document": "<string>",
"phone": "<string>"
},
"address": {
"zipcode": "<string>",
"street": "<string>",
"number": "<string>",
"district": "<string>",
"adjunct": "<string>",
"city": "<string>",
"state": "<string>"
},
"payment_method": "PIX",
"installments": 123,
"card_payment_method_id": "<string>",
"card_number": "<string>",
"expiration_date": "<string>",
"cvv": "<string>",
"holder_name": "<string>",
"callback_url": "<string>",
"products": [
{
"name": "<string>",
"price": 123,
"quantity": 123
}
]
}
}'
{
"status": "success",
"payment": {
"status": "PROCESSING",
"transaction_id": "ScEEPm9jzOgL1FbU2J673JDaNMqMV7S",
"payment_code": "<string>",
"link": "<string>",
"due_date": "2023-11-07T05:31:56Z",
"total": 123
}
}
Body
application/json
CEP
Rua
Número
Bairro
Cidade
Estado
Complemento
Método de pagamento
Available options:
PIX
, CREDIT_CARD
, BILLET
URL para callback
Número de parcelas
Bandeira do cartão
Número do cartão
Data de expiração do cartão
Código de segurança do cartão
Nome do titular do cartão
Response
201 - application/json
Transação criada com sucesso
Status da transação
Example:
"success"
Status do pagamento
Example:
"PROCESSING"
ID da transação
Example:
"ScEEPm9jzOgL1FbU2J673JDaNMqMV7S"
Código de pagamento PIX
Link para pagamento
Data de vencimento
Valor total da transação
curl --request POST \
--url https://gateway.3xpay.co/transaction \
--header 'Content-Type: application/json' \
--header 'api_key: <api-key>' \
--header 'api_secret: <api-key>' \
--data '{
"transaction": {
"customer_infos": {
"name": "<string>",
"email": "<string>",
"document": "<string>",
"phone": "<string>"
},
"address": {
"zipcode": "<string>",
"street": "<string>",
"number": "<string>",
"district": "<string>",
"adjunct": "<string>",
"city": "<string>",
"state": "<string>"
},
"payment_method": "PIX",
"installments": 123,
"card_payment_method_id": "<string>",
"card_number": "<string>",
"expiration_date": "<string>",
"cvv": "<string>",
"holder_name": "<string>",
"callback_url": "<string>",
"products": [
{
"name": "<string>",
"price": 123,
"quantity": 123
}
]
}
}'
{
"status": "success",
"payment": {
"status": "PROCESSING",
"transaction_id": "ScEEPm9jzOgL1FbU2J673JDaNMqMV7S",
"payment_code": "<string>",
"link": "<string>",
"due_date": "2023-11-07T05:31:56Z",
"total": 123
}
}