Skip to main content
POST
/
receivers
Cria um novo receiver
curl --request POST \
  --url https://api.astronpay.co/api/v1/receivers \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --header 'x-api-secret: <api-key>' \
  --data '
{
  "type": "PF",
  "name": "João Silva",
  "email": "joao@example.com",
  "phone": "+5511999999999",
  "document": "12345678901",
  "createPrivyWallet": true
}
'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "merchantId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "João Silva",
  "document": "12345678901",
  "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"
}

Authorizations

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

Body

application/json
​
name
string
required
Required string length: 2 - 255
​
type
enum<string>
default:PF

PF = Pessoa Física, PJ = Pessoa Jurídica.

Available options:
PF,
PJ
​
document
string

CPF (11 dígitos) ou CNPJ (14 dígitos), apenas números.

​
email
string<email>
​
phone
string
Maximum string length: 20
​
addressStreet
string
​
addressNumber
string
​
addressComplement
string
​
addressNeighborhood
string
​
addressCity
string
​
addressState
string
Maximum string length: 2
​
addressZipCode
string
Maximum string length: 10
​
walletAddress
string

Endereço Solana base58 (32–44 chars). Mutuamente exclusivo com createPrivyWallet.

​
createPrivyWallet
boolean

Se true, a plataforma cria e custodia uma wallet gerenciada pelo receiver. O envio das transações é feito via POST /receivers/{id}/wallet/sign-and-send-transaction, com gas patrocinado pela plataforma — não é necessário manter SOL na wallet pra pagar fee. Mutuamente exclusivo com walletAddress.

Response

Criado

​
id
string<uuid>
required
​
merchantId
string<uuid>
required
​
type
enum<string>
required
Available options:
PF,
PJ
​
name
string
required
Example:

"João Silva"

​
document
string
required
Example:

"12345678901"

​
documentType
enum<string>
required
Available options:
CPF,
CNPJ
​
status
enum<string>
required
Available options:
PENDING,
ACTIVE,
SUSPENDED,
BLOCKED
​
kycStatus
enum<string>
required
Available options:
PENDING,
SUBMITTED,
UNDER_REVIEW,
APPROVED,
REJECTED
​
createdAt
string<date-time>
required
​
email
string<email> | null
​
phone
string | null
Example:

"+5511999999999"

​
limits
object
​
walletAddress
string | null
Example:

"4k5d...Solana"

​
updatedAt
string<date-time>