YAyampi
Checkout - Configurações de pagamentos

Listar configurações de pagamento

Lista as configurações de um tipo de pagamento específico

get/{alias}/checkout/payments/{paymentId}/config

Request

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

Path parameters

aliasstring required

Alias da loja

paymentIdinteger required

ID da forma de pagamento

Response

Detalhes das configurações de pagamento

idinteger

Identificador único da configuração de pagamento.

payment_idinteger required

ID do meio de pagamento configurado.

affiliation_idinteger required

ID da afiliação (adquirente/gateway) usada por este meio de pagamento.

activeboolean required

Indica se o meio de pagamento está ativo no checkout.

default_displayboolean required

Indica se o meio de pagamento é exibido por padrão no checkout.

spreadboolean

Indica se os juros do parcelamento são diluídos nos preços dos produtos, fazendo o parcelamento aparecer sem juros ao cliente.

ignore_promotionsboolean

Indica se este meio de pagamento ignora as promoções ativas.

accumulate_discountboolean

Indica se o desconto deste meio de pagamento pode ser acumulado com outros descontos.

percent_discountnumber float

Percentual de desconto aplicado ao usar este meio de pagamento.

min_installment_valuenumber float

Valor mínimo de cada parcela, em reais, permitido no parcelamento deste meio de pagamento.

max_installments_without_taxinteger

Número máximo de parcelas sem juros neste meio de pagamento.

billet_expire_daysinteger

Quantidade de dias até o vencimento do boleto.

days_to_cancel_unpaid_billetsinteger

Quantidade de dias até o cancelamento automático de boletos não pagos.

hours_to_cancel_unpaid_pixinteger

Quantidade de horas até o cancelamento automático de pagamentos Pix não pagos.

hours_to_expire_pix_codenumber

Quantidade de horas até a expiração do código Pix gerado.

billet_instructionsstring

Instruções exibidas no boleto gerado.

created_atstring date-time

Data e hora de criação da configuração de pagamento.

updated_atstring date-time

Data e hora da última atualização da configuração de pagamento.

Example response

{
  "installments": {
    "data": [
      {
        "id": 1,
        "payment_id": 2,
        "installment": 1,
        "tax": 1.5,
        "start_at": {
          "date": "2000-08-17 10:24:24",
          "timezone_type": 3,
          "timezone": "America/Sao_Paulo"
        },
        "end_at": {
          "date": "2000-08-17 10:24:24",
          "timezone_type": 3,
          "timezone": "America/Sao_Paulo"
        },
        "created_at": {
          "date": "2000-08-17 10:24:24",
          "timezone_type": 3,
          "timezone": "America/Sao_Paulo"
        },
        "updated_at": {
          "date": "2000-08-17 10:24:24",
          "timezone_type": 3,
          "timezone": "America/Sao_Paulo"
        }
      }
    ]
  },
  "affiliation": {
    "data": {
      "name": "Cielo Affiliation",
      "gateway": {
        "data": [
          {
            "alias": "billet",
            "name": "Boleto Bancário",
            "auth_type": "api_key"
          }
        ]
      }
    }
  }
}

Changes

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