GET /v1/payment-settings
GET
/v1/payment-settings
const url = 'https://seu-endereco-da-api/v1/payment-settings';const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}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).
Authorizations
Seção intitulada “Authorizations”Responses
Seção intitulada “Responses”Media typeapplication/json
object
defaultProvider
required
Null picks Asaas when it is connected and charging, else manual
string
effectiveProvider
required
string
pixKey
required
string
pixKeyType
required
string
pixMerchantName
required
string
allowedLinkHosts
required
Hosts a manual payment link may use; empty allows any public https host
Array<string>
confirmationEnabled
required
boolean
confirmationText
required
string
confirmationTemplateId
required
string
confirmationTemplateVariables
required
Array<string>
confirmationHeaderMediaKey
required
string
confirmationHeaderMediaMime
required
string
Example
{ "defaultProvider": "asaas", "effectiveProvider": "asaas", "pixKeyType": "CPF"}