Skip to main content
GET
/
receivers
Lista receivers do merchant
curl --request GET \
  --url https://api.astronpay.co/api/v1/receivers \
  --header 'x-api-key: <api-key>' \
  --header 'x-api-secret: <api-key>'
{
  "receivers": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "merchantId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "type": "PF",
      "name": "João Silva",
      "document": "12345678901",
      "documentType": "CPF",
      "status": "PENDING",
      "kycStatus": "PENDING",
      "createdAt": "2023-11-07T05:31:56Z",
      "email": "jsmith@example.com",
      "phone": "+5511999999999",
      "limits": {
        "dailyLimitBrl": 50000,
        "dailyTransactionLimit": 20,
        "nightTransactionsEnabled": false
      },
      "walletAddress": "4k5d...Solana",
      "updatedAt": "2023-11-07T05:31:56Z"
    }
  ],
  "pagination": {
    "page": 1,
    "pageSize": 20,
    "total": 147,
    "totalPages": 8
  }
}

Authorizations

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

Query Parameters

page
integer
default:1
limit
integer
default:20
Required range: x <= 100
status
enum<string>
Available options:
PENDING,
ACTIVE,
SUSPENDED,
BLOCKED
kycStatus
enum<string>
Available options:
PENDING,
SUBMITTED,
UNDER_REVIEW,
APPROVED,
REJECTED

Response

200 - application/json

OK

receivers
object[]
pagination
object