Pular para o conteúdo

GET /v1/payment-settings

GET
/v1/payment-settings
curl --request GET \
--url https://seu-endereco-da-api/v1/payment-settings \
--header 'Authorization: Bearer <token>'

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

Media typeapplication/json
object
defaultProvider
required

Null picks Asaas when it is connected and charging, else manual

string
nullable
Allowed values: asaas manual
effectiveProvider
required
string
Allowed values: asaas manual
pixKey
required
string
nullable
pixKeyType
required
string
nullable
Allowed values: CPF CNPJ EMAIL PHONE EVP
pixMerchantName
required
string
nullable
allowedLinkHosts
required

Hosts a manual payment link may use; empty allows any public https host

Array<string>
confirmationEnabled
required
boolean
confirmationText
required
string
nullable
confirmationTemplateId
required
string
nullable
confirmationTemplateVariables
required
Array<string>
confirmationHeaderMediaKey
required
string
nullable
confirmationHeaderMediaMime
required
string
nullable

Example

{
"defaultProvider": "asaas",
"effectiveProvider": "asaas",
"pixKeyType": "CPF"
}