Skip to main content
GET
/
orders
Lista ordens do merchant
curl --request GET \
  --url https://api.astronpay.co/api/v1/orders \
  --header 'x-api-key: <api-key>' \
  --header 'x-api-secret: <api-key>'
{
  "data": [
    {
      "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>"
        }
      ]
    }
  ],
  "total": 42,
  "page": 1,
  "limit": 20
}

Authorizations

​
x-api-key
string
header
required
​
x-api-secret
string
header
required

Query Parameters

​
page
integer
default:1
​
limit
integer
default:20

Número de registros por página (máx 100).

Required range: x <= 100
​
type
enum<string>
Available options:
PAYIN,
PAYOUT
​
status
enum<string>
Available options:
PENDING,
AWAITING_PAYMENT,
PAYMENT_RECEIVED,
SWAPPING,
TRANSFERRING,
AWAITING_DEPOSIT,
DEPOSIT_RECEIVED,
PIX_SENDING,
PIX_SENT_UNCONFIRMED,
COMPLETED,
FAILED,
EXPIRED,
REFUNDING,
REFUNDED
​
receiverId
string<uuid>

Response

200 - application/json

OK

​
data
object[]
required
​
total
integer
required
Example:

42

​
page
integer
required
Example:

1

​
limit
integer
required
Example:

20