YAyampi
Checkout - Links de Pagamento

Atualizar Link de Pagamento

Atualiza um link de pagamento existente e dispara o evento payment-link-updated

put/{alias}/checkout/payment-link/{id}

Request

  • Base URL
    https://api.dooki.com.br/v2
  • URL
    https://api.dooki.com.br/v2/{alias}/checkout/payment-link/{id}
  • Auth
    API key in header User-Token and API key in header User-Secret-Key

Path parameters

aliasstring required

Alias da loja

idinteger required

ID do link de pagamento

Request body

namestring required

Nome do link de pagamento

activeboolean required

Status do link de pagamento

promocode_idinteger nullable

ID do código promocional

customer_idinteger nullable

ID do cliente

customer_address_idinteger nullable

ID do endereço do cliente

Response

Link de pagamento atualizado com sucesso

idinteger

Identificador único do link de pagamento.

link_urlstring url

URL do link de pagamento a ser enviada ao cliente.

namestring

Nome do link de pagamento definido pela loja.

Example response

{
  "name": "Seu Link de Pagamento",
  "whatsapp": {
    "message": "Olá, aqui está o seu link de pagamento: {link}"
  }
}

Changes

No recorded changes to this operation across all 3 revisions of this API.