Skip to main content
PATCH
/
receivers
/
{id}
Atualiza receiver
curl --request PATCH \
  --url https://api.astronpay.co/api/v1/receivers/{id} \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --header 'x-api-secret: <api-key>' \
  --data '
{
  "name": "<string>",
  "email": "jsmith@example.com",
  "phone": "<string>",
  "addressStreet": "<string>",
  "addressNumber": "<string>",
  "addressComplement": "<string>",
  "addressNeighborhood": "<string>",
  "addressCity": "<string>",
  "addressState": "<string>",
  "addressZipCode": "<string>"
}
'
{
  "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"
}

Authorizations

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

Path Parameters

​
id
string<uuid>
required

Body

application/json
​
name
string
Required string length: 2 - 255
​
email
string<email> | null
​
phone
string | null
Maximum string length: 20
​
addressStreet
string | null
​
addressNumber
string | null
​
addressComplement
string | null
​
addressNeighborhood
string | null
​
addressCity
string | null
​
addressState
string | null
Maximum string length: 2
​
addressZipCode
string | null
Maximum string length: 10

Response

Atualizado

​
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>