v1

latestOpenAPI 3.0.02026-07-26376212496.4 KB

Checkout - Configurações de pagamentos

Criar configuração de pagamento

Cria uma nova configuração para um tipo de pagamento específico com base nos dados fornecidos

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

Path parameters

aliasstring required

Alias da loja

paymentIdinteger required

ID da forma de pagamento

Request body

payment_idinteger required

affiliation_idinteger required

activeboolean required

default_displayboolean required

accumulate_discountboolean

ignore_promotionsboolean

percent_discountnumber float

min_installment_valuenumber float

max_installments_without_taxinteger

billet_expire_daysinteger

Example request

{
  "payment_id": 6,
  "affiliation_id": 3,
  "active": true,
  "min_installment_value": 25,
  "max_installments_without_tax": 1,
  "billet_expire_days": 1
}

Response

Configuração de pagamento criada com sucesso

idinteger

payment_idinteger required

affiliation_idinteger required

activeboolean required

default_displayboolean required

spreadboolean

ignore_promotionsboolean

accumulate_discountboolean

percent_discountnumber float

min_installment_valuenumber float

max_installments_without_taxinteger

billet_expire_daysinteger

days_to_cancel_unpaid_billetsinteger

hours_to_cancel_unpaid_pixinteger

hours_to_expire_pix_codenumber

billet_instructionsstring

created_atstring date-time

updated_atstring date-time

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": "Boleto Bancário"
          }
        ]
      }
    }
  }
}