Cria ordem de payout
curl --request POST \
--url https://api.astronpay.co/api/v1/payout \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--header 'x-api-secret: <api-key>' \
--data '
{
"receiverId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"quoteId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"amountCrypto": 10.5,
"pixKey": "<string>",
"recipientName": "<string>",
"recipientDocument": "<string>",
"sourceToken": "USDC",
"externalId": "<string>"
}
'import requests
url = "https://api.astronpay.co/api/v1/payout"
payload = {
"receiverId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"quoteId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"amountCrypto": 10.5,
"pixKey": "<string>",
"recipientName": "<string>",
"recipientDocument": "<string>",
"sourceToken": "USDC",
"externalId": "<string>"
}
headers = {
"x-api-key": "<api-key>",
"x-api-secret": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
'x-api-key': '<api-key>',
'x-api-secret': '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
receiverId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
quoteId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
amountCrypto: 10.5,
pixKey: '<string>',
recipientName: '<string>',
recipientDocument: '<string>',
sourceToken: 'USDC',
externalId: '<string>'
})
};
fetch('https://api.astronpay.co/api/v1/payout', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.astronpay.co/api/v1/payout",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'receiverId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'quoteId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'amountCrypto' => 10.5,
'pixKey' => '<string>',
'recipientName' => '<string>',
'recipientDocument' => '<string>',
'sourceToken' => 'USDC',
'externalId' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-api-key: <api-key>",
"x-api-secret: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.astronpay.co/api/v1/payout"
payload := strings.NewReader("{\n \"receiverId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"quoteId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"amountCrypto\": 10.5,\n \"pixKey\": \"<string>\",\n \"recipientName\": \"<string>\",\n \"recipientDocument\": \"<string>\",\n \"sourceToken\": \"USDC\",\n \"externalId\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-api-key", "<api-key>")
req.Header.Add("x-api-secret", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.astronpay.co/api/v1/payout")
.header("x-api-key", "<api-key>")
.header("x-api-secret", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"receiverId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"quoteId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"amountCrypto\": 10.5,\n \"pixKey\": \"<string>\",\n \"recipientName\": \"<string>\",\n \"recipientDocument\": \"<string>\",\n \"sourceToken\": \"USDC\",\n \"externalId\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.astronpay.co/api/v1/payout")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["x-api-secret"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"receiverId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"quoteId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"amountCrypto\": 10.5,\n \"pixKey\": \"<string>\",\n \"recipientName\": \"<string>\",\n \"recipientDocument\": \"<string>\",\n \"sourceToken\": \"USDC\",\n \"externalId\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"merchantId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"receiverId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"type": "PAYIN",
"status": "PENDING",
"chain": "solana",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"externalId": "<string>",
"receiverName": "<string>",
"merchantName": "<string>",
"amountBrl": 1000,
"amountCrypto": 199.5,
"targetToken": "USDC",
"sourceToken": "USDC",
"destinationWallet": "4k5dSo1EnderecoSolana...",
"depositAddress": "7xMnSo2EnderecoDeposito...",
"paymentReference": "<string>",
"exchangeRate": 5.01,
"feePercentage": 2.5,
"netAmountBrl": 975,
"amountUsdc": 194.61,
"amountToken": 194.61,
"platformFeePercentage": 1.5,
"platformFeeAmountBrl": 15,
"merchantFeePercentage": 1,
"merchantFeeAmountBrl": 10,
"pixPaymentCode": "00020126...",
"pixKey": "<string>",
"pixKeyType": "CPF",
"recipientName": "<string>",
"failureReason": "<string>",
"expiresAt": "2023-11-07T05:31:56Z",
"completedAt": "2023-11-07T05:31:56Z",
"transactions": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"type": "<string>",
"status": "<string>",
"amount": 199.5,
"currency": "USDC",
"createdAt": "2023-11-07T05:31:56Z",
"chain": "solana",
"txHash": "<string>"
}
]
}{
"error": "VALIDATION_ERROR",
"message": "Campo 'amountBrl' é obrigatório",
"details": {},
"requestId": "req_abc123"
}{
"error": "VALIDATION_ERROR",
"message": "Campo 'amountBrl' é obrigatório",
"details": {},
"requestId": "req_abc123"
}Payout
Cria ordem de payout
Cria uma ordem de saída (crypto → BRL). Requer quoteId de /quote/payout não expirado. Após o receiver depositar o crypto no endereço fornecido (campo depositAddress na ordem), a plataforma executa a conversão e envia PIX para a chave configurada.
POST
/
payout
Cria ordem de payout
curl --request POST \
--url https://api.astronpay.co/api/v1/payout \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--header 'x-api-secret: <api-key>' \
--data '
{
"receiverId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"quoteId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"amountCrypto": 10.5,
"pixKey": "<string>",
"recipientName": "<string>",
"recipientDocument": "<string>",
"sourceToken": "USDC",
"externalId": "<string>"
}
'import requests
url = "https://api.astronpay.co/api/v1/payout"
payload = {
"receiverId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"quoteId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"amountCrypto": 10.5,
"pixKey": "<string>",
"recipientName": "<string>",
"recipientDocument": "<string>",
"sourceToken": "USDC",
"externalId": "<string>"
}
headers = {
"x-api-key": "<api-key>",
"x-api-secret": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
'x-api-key': '<api-key>',
'x-api-secret': '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
receiverId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
quoteId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
amountCrypto: 10.5,
pixKey: '<string>',
recipientName: '<string>',
recipientDocument: '<string>',
sourceToken: 'USDC',
externalId: '<string>'
})
};
fetch('https://api.astronpay.co/api/v1/payout', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.astronpay.co/api/v1/payout",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'receiverId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'quoteId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'amountCrypto' => 10.5,
'pixKey' => '<string>',
'recipientName' => '<string>',
'recipientDocument' => '<string>',
'sourceToken' => 'USDC',
'externalId' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-api-key: <api-key>",
"x-api-secret: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.astronpay.co/api/v1/payout"
payload := strings.NewReader("{\n \"receiverId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"quoteId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"amountCrypto\": 10.5,\n \"pixKey\": \"<string>\",\n \"recipientName\": \"<string>\",\n \"recipientDocument\": \"<string>\",\n \"sourceToken\": \"USDC\",\n \"externalId\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-api-key", "<api-key>")
req.Header.Add("x-api-secret", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.astronpay.co/api/v1/payout")
.header("x-api-key", "<api-key>")
.header("x-api-secret", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"receiverId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"quoteId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"amountCrypto\": 10.5,\n \"pixKey\": \"<string>\",\n \"recipientName\": \"<string>\",\n \"recipientDocument\": \"<string>\",\n \"sourceToken\": \"USDC\",\n \"externalId\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.astronpay.co/api/v1/payout")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["x-api-secret"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"receiverId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"quoteId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"amountCrypto\": 10.5,\n \"pixKey\": \"<string>\",\n \"recipientName\": \"<string>\",\n \"recipientDocument\": \"<string>\",\n \"sourceToken\": \"USDC\",\n \"externalId\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"merchantId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"receiverId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"type": "PAYIN",
"status": "PENDING",
"chain": "solana",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"externalId": "<string>",
"receiverName": "<string>",
"merchantName": "<string>",
"amountBrl": 1000,
"amountCrypto": 199.5,
"targetToken": "USDC",
"sourceToken": "USDC",
"destinationWallet": "4k5dSo1EnderecoSolana...",
"depositAddress": "7xMnSo2EnderecoDeposito...",
"paymentReference": "<string>",
"exchangeRate": 5.01,
"feePercentage": 2.5,
"netAmountBrl": 975,
"amountUsdc": 194.61,
"amountToken": 194.61,
"platformFeePercentage": 1.5,
"platformFeeAmountBrl": 15,
"merchantFeePercentage": 1,
"merchantFeeAmountBrl": 10,
"pixPaymentCode": "00020126...",
"pixKey": "<string>",
"pixKeyType": "CPF",
"recipientName": "<string>",
"failureReason": "<string>",
"expiresAt": "2023-11-07T05:31:56Z",
"completedAt": "2023-11-07T05:31:56Z",
"transactions": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"type": "<string>",
"status": "<string>",
"amount": 199.5,
"currency": "USDC",
"createdAt": "2023-11-07T05:31:56Z",
"chain": "solana",
"txHash": "<string>"
}
]
}{
"error": "VALIDATION_ERROR",
"message": "Campo 'amountBrl' é obrigatório",
"details": {},
"requestId": "req_abc123"
}{
"error": "VALIDATION_ERROR",
"message": "Campo 'amountBrl' é obrigatório",
"details": {},
"requestId": "req_abc123"
}Authorizations
apiKey & apiSecretbearerAuth
Body
application/json
Quantidade de crypto a depositar (positivo).
Example:
10.5
Chave PIX do destinatário.
Tipo da chave PIX.
Available options:
CPF, CNPJ, PHONE, EMAIL, RANDOM, QRCODE Nome completo do destinatário.
CPF ou CNPJ do destinatário (11–18 chars).
Token a converter para BRL.
Available options:
USDC, SOL ID opcional do merchant para rastreamento.
Maximum string length:
255Response
Criado — o campo depositAddress na ordem indica o endereço Solana para depósito do crypto.
Available options:
PAYIN, PAYOUT Available options:
PENDING, AWAITING_PAYMENT, PAYMENT_RECEIVED, SWAPPING, TRANSFERRING, AWAITING_DEPOSIT, DEPOSIT_RECEIVED, PIX_SENDING, PIX_SENT_UNCONFIRMED, COMPLETED, FAILED, EXPIRED, REFUNDING, REFUNDED Example:
"solana"
ID do merchant para rastreamento interno.
Example:
1000
Example:
199.5
Payin only. Token que o receiver recebe (ex: USDC).
Example:
"USDC"
Payout only. Token que o receiver envia (ex: USDC).
Example:
"USDC"
Payin only. Endereço Solana onde o crypto é entregue.
Example:
"4k5dSo1EnderecoSolana..."
Payout only. Endereço Solana para onde o receiver deve enviar o crypto.
Example:
"7xMnSo2EnderecoDeposito..."
Payout only. PublicKey Solana não custodial (sem chave privada, sem saldo) usada como reference no padrão Solana Pay para correlacionar o depósito on-chain a esta order. Inclua essa pubkey como account read-only e não-signer na sua transação SPL Transfer — sem isso, a plataforma não consegue identificar que o depósito pertence a este payout e a order expira em AWAITING_DEPOSIT.
Taxa de câmbio utilizada na ordem (BRL/token).
Example:
5.01
Percentual total de taxa aplicado.
Example:
2.5
Valor BRL líquido após taxas.
Example:
975
Example:
194.61
Quantidade final do token entregue.
Example:
194.61
Example:
1.5
Example:
15
Example:
1
Example:
10
Payin only. Código EMV copia-e-cola do PIX.
Example:
"00020126..."
Payout only. Chave PIX do destinatário.
Payout only. Tipo da chave PIX.
Available options:
CPF, CNPJ, PHONE, EMAIL, RANDOM, QRCODE Payout only. Nome do destinatário no PIX.
Motivo da falha, preenchido quando status=FAILED.
Transações associadas à ordem (on-chain e PIX).
Show child attributes
Show child attributes