Endpoint Examples
CashIn
API Documentation
Endpoint Examples
CashIn
Cria uma nova transação de entrada (cash-in)
POST
/
transaction
/
cash-in
curl --request POST \
--url https://gateway.3xpay.co/transaction/cash-in \
--header 'Content-Type: application/json' \
--header 'api_key: <api-key>' \
--header 'api_secret: <api-key>' \
--data '{
"transaction": {
"amount": 123,
"callback_url": "<string>",
"external_id": "<string>",
"expiration": 3600,
"custom_message": "Pix para o pedido 123456",
"debtor": {
"name": "João da Silva",
"document": "12345678901"
}
}
}'
{
"status": "PENDING",
"payment": {
"status": "PENDING",
"transaction_id": "W5qrXoQ6Me5kfw1mEaTsn9lizo",
"payment_code": "<string>",
"link": "<string>",
"total": 123
},
"transaction_id": "756afe09-0471-4124-9f35-6691fa130f5b"
}
Body
application/json
O valor a ser transacionado
A URL para a qual o callback da transação será enviado
O identificador externo para a transação
A data de expiração em segundos do QRCode
Example:
3600
Mensagem customizada para o pagador
Maximum length:
130
Example:
"Pix para o pedido 123456"
Response
201 - application/json
Transação criada com sucesso
Status da transação
Example:
"PENDING"
ID único da transação
Example:
"756afe09-0471-4124-9f35-6691fa130f5b"
curl --request POST \
--url https://gateway.3xpay.co/transaction/cash-in \
--header 'Content-Type: application/json' \
--header 'api_key: <api-key>' \
--header 'api_secret: <api-key>' \
--data '{
"transaction": {
"amount": 123,
"callback_url": "<string>",
"external_id": "<string>",
"expiration": 3600,
"custom_message": "Pix para o pedido 123456",
"debtor": {
"name": "João da Silva",
"document": "12345678901"
}
}
}'
{
"status": "PENDING",
"payment": {
"status": "PENDING",
"transaction_id": "W5qrXoQ6Me5kfw1mEaTsn9lizo",
"payment_code": "<string>",
"link": "<string>",
"total": 123
},
"transaction_id": "756afe09-0471-4124-9f35-6691fa130f5b"
}