Pular para o conteúdo

PATCH /v1/payment-settings

PATCH
/v1/payment-settings
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).

Media typeapplication/json
object
defaultProvider
string
nullable
Allowed values: asaas manual
pixKey
string
nullable <= 77 characters
pixKeyType
string
nullable
Allowed values: CPF CNPJ EMAIL PHONE EVP
pixMerchantName
string
nullable <= 25 characters
allowedLinkHosts
Array<string>
<= 20 items
confirmationEnabled
boolean
confirmationText
string
nullable <= 1024 characters
confirmationTemplateId
string format: uuid
nullable
confirmationTemplateVariables
Array<string>
<= 20 items
confirmationHeaderMediaKey
string
nullable
confirmationHeaderMediaMime
string
nullable
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"
}

Invalid Pix key for its type, or a payment template chosen as confirmation

Confirmation template not found