Pular para o conteúdo

POST /v1/integrations/asaas

POST
/v1/integrations/asaas
curl --request POST \
--url https://seu-endereco-da-api/v1/integrations/asaas \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{ "apiKey": "example", "environment": "sandbox" }'

Permissão que a Chave de acesso precisa: Gerenciar a Central de apps (integrations:manage).

Media typeapplication/json
object
apiKey
required
string
>= 1 characters <= 512 characters
environment
string
Allowed values: sandbox production
Media typeapplication/json
object
connected
required
boolean
id
string
environment

Sandbox keys create test charges only

string
Allowed values: sandbox production
apiKeyLast4

Last characters of the stored key; the key itself never leaves the server

string
chargesEnabled
boolean
cancelEnabled
boolean
notifyOnPayment
boolean
winDealOnPayment
boolean
defaultDueDays
number
connectedAt
string format: date-time
connectedByName
string
nullable
openChargesCount

Open charges whose payment stops being tracked on disconnect

number
accountName

Name of the Asaas account the key belongs to

string
nullable
origin

Created: the account was opened from inside the system

string
Allowed values: key created
accountStatus

Null for an account connected by key; charging is blocked until approved

string
nullable
Allowed values: analysis documents approved rejected
onboardingUrl

Where the account holder sends the pending documents

string
nullable
accountCreationAvailable

Only when disconnected: whether an Asaas account can be opened from here

boolean
externalCharges

Tracking of charges created straight in Asaas

object
enabled
required
boolean
channelId
required

Official WhatsApp number that messages the customers of these charges

string
nullable
dealMode
required
string
Allowed values: none create link_open
pipelineId
required
string
nullable
stageId
required
string
nullable
customerGroup
required
string
nullable
minValueCents
required
number
nullable
methods
required
Array<string>
Allowed values: pix boleto card
ignoreSubscriptions
required
boolean

Example

{
"environment": "sandbox",
"origin": "key",
"accountStatus": "analysis",
"externalCharges": {
"dealMode": "none",
"methods": [
"pix"
]
}
}

Not an Asaas key, a key of the other environment, or Asaas refused it

Asaas is already connected

Asaas did not answer