PATCH /v1/payment-settings
PATCH
/v1/payment-settings
const url = 'https://seu-endereco-da-api/v1/payment-settings';const options = { method: 'PATCH', headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'}, body: '{"defaultProvider":"asaas","pixKey":"example","pixKeyType":"CPF","pixMerchantName":"example","allowedLinkHosts":["example"],"confirmationEnabled":true,"confirmationText":"example","confirmationTemplateId":"2489E9AD-2EE2-8E00-8EC9-32D5F69181C0","confirmationTemplateVariables":["example"],"confirmationHeaderMediaKey":"example","confirmationHeaderMediaMime":"example"}'};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request PATCH \ --url https://seu-endereco-da-api/v1/payment-settings \ --header 'Authorization: Bearer <token>' \ --header 'Content-Type: application/json' \ --data '{ "defaultProvider": "asaas", "pixKey": "example", "pixKeyType": "CPF", "pixMerchantName": "example", "allowedLinkHosts": [ "example" ], "confirmationEnabled": true, "confirmationText": "example", "confirmationTemplateId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "confirmationTemplateVariables": [ "example" ], "confirmationHeaderMediaKey": "example", "confirmationHeaderMediaMime": "example" }'Permissão que a Chave de acesso precisa: Gerenciar a Central de apps (integrations:manage).
Authorizations
Seção intitulada “Authorizations”Request Bodyrequired
Seção intitulada “Request Bodyrequired”Media typeapplication/json
object
defaultProvider
string
pixKey
string
pixKeyType
string
pixMerchantName
string
allowedLinkHosts
Array<string>
confirmationEnabled
boolean
confirmationText
string
confirmationTemplateId
string format: uuid
confirmationTemplateVariables
Array<string>
confirmationHeaderMediaKey
string
confirmationHeaderMediaMime
string
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"}Invalid Pix key for its type, or a payment template chosen as confirmation
Confirmation template not found