Criar configuração de pagamento

curl --request POST \
  --url https://api.dooki.com.br/v2/{alias}/checkout/payments/{paymentId}/config \
  --header 'Content-Type: application/json' \
  --header 'User-Secret-Key: <api-key>' \
  --header 'User-Token: <api-key>' \
  --data '
{
  "payment_id": 6,
  "affiliation_id": 3,
  "active": true,
  "default_display": false,
  "accumulate_discount": false,
  "ignore_promotions": false,
  "percent_discount": 0,
  "min_installment_value": 25,
  "max_installments_without_tax": 1,
  "billet_expire_days": 1
}
'

import requests

url = "https://api.dooki.com.br/v2/{alias}/checkout/payments/{paymentId}/config"

payload = {
    "payment_id": 6,
    "affiliation_id": 3,
    "active": True,
    "default_display": False,
    "accumulate_discount": False,
    "ignore_promotions": False,
    "percent_discount": 0,
    "min_installment_value": 25,
    "max_installments_without_tax": 1,
    "billet_expire_days": 1
}
headers = {
    "User-Token": "<api-key>",
    "User-Secret-Key": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {
    'User-Token': '<api-key>',
    'User-Secret-Key': '<api-key>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    payment_id: 6,
    affiliation_id: 3,
    active: true,
    default_display: false,
    accumulate_discount: false,
    ignore_promotions: false,
    percent_discount: 0,
    min_installment_value: 25,
    max_installments_without_tax: 1,
    billet_expire_days: 1
  })
};

fetch('https://api.dooki.com.br/v2/{alias}/checkout/payments/{paymentId}/config', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.dooki.com.br/v2/{alias}/checkout/payments/{paymentId}/config",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'payment_id' => 6,
    'affiliation_id' => 3,
    'active' => true,
    'default_display' => false,
    'accumulate_discount' => false,
    'ignore_promotions' => false,
    'percent_discount' => 0,
    'min_installment_value' => 25,
    'max_installments_without_tax' => 1,
    'billet_expire_days' => 1
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "User-Secret-Key: <api-key>",
    "User-Token: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.dooki.com.br/v2/{alias}/checkout/payments/{paymentId}/config"

	payload := strings.NewReader("{\n  \"payment_id\": 6,\n  \"affiliation_id\": 3,\n  \"active\": true,\n  \"default_display\": false,\n  \"accumulate_discount\": false,\n  \"ignore_promotions\": false,\n  \"percent_discount\": 0,\n  \"min_installment_value\": 25,\n  \"max_installments_without_tax\": 1,\n  \"billet_expire_days\": 1\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("User-Token", "<api-key>")
	req.Header.Add("User-Secret-Key", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.dooki.com.br/v2/{alias}/checkout/payments/{paymentId}/config")
  .header("User-Token", "<api-key>")
  .header("User-Secret-Key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"payment_id\": 6,\n  \"affiliation_id\": 3,\n  \"active\": true,\n  \"default_display\": false,\n  \"accumulate_discount\": false,\n  \"ignore_promotions\": false,\n  \"percent_discount\": 0,\n  \"min_installment_value\": 25,\n  \"max_installments_without_tax\": 1,\n  \"billet_expire_days\": 1\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.dooki.com.br/v2/{alias}/checkout/payments/{paymentId}/config")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["User-Token"] = '<api-key>'
request["User-Secret-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"payment_id\": 6,\n  \"affiliation_id\": 3,\n  \"active\": true,\n  \"default_display\": false,\n  \"accumulate_discount\": false,\n  \"ignore_promotions\": false,\n  \"percent_discount\": 0,\n  \"min_installment_value\": 25,\n  \"max_installments_without_tax\": 1,\n  \"billet_expire_days\": 1\n}"

response = http.request(request)
puts response.read_body

{
  "payment_id": 123,
  "affiliation_id": 123,
  "active": true,
  "default_display": true,
  "id": 123,
  "spread": true,
  "ignore_promotions": true,
  "accumulate_discount": true,
  "percent_discount": 123,
  "min_installment_value": 123,
  "max_installments_without_tax": 123,
  "billet_expire_days": 123,
  "days_to_cancel_unpaid_billets": 123,
  "hours_to_cancel_unpaid_pix": 123,
  "hours_to_expire_pix_code": 123,
  "billet_instructions": "<string>",
  "installments": {
    "data": [
      {
        "id": 1,
        "payment_id": 2,
        "installment": 1,
        "tax": 1.5,
        "percent_discount": 0,
        "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": {
      "id": 123,
      "active": true,
      "backup": true,
      "name": "Cielo Affiliation",
      "statement_descriptor": "<string>",
      "auto_capture": true,
      "has_payment_config": false,
      "capture_hour_delay": 123,
      "force_minimum_tax": true,
      "status": "<string>",
      "auth_type": "<string>",
      "gateway": {
        "data": [
          {
            "alias": "billet",
            "name": "Boleto Bancário",
            "icon_url": "<string>",
            "allow_backup": true,
            "allow_edit_pix_code_expiration_time": true,
            "installments_config": {
              "allow_custom_installments": true,
              "message": "<string>",
              "help_link": "<string>"
            },
            "auth_type": "api_key",
            "gateway_exists": true,
            "params": {
              "data": [
                [
                  "env",
                  "merchant_id",
                  "key"
                ]
              ]
            }
          }
        ]
      }
    }
  },
  "payment": {
    "data": {
      "id": 123,
      "alias": "<string>",
      "name": "<string>",
      "has_config": true,
      "active_config": true,
      "is_credit_card": true,
      "is_deposit": true,
      "is_billet": true,
      "is_pix": true,
      "is_pix_in_installments": true,
      "is_wallet": true,
      "icon_url": "<string>"
    }
  },
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z"
}

POST

{alias}

checkout

payments

{paymentId}

config

Criar configuração de pagamento

curl --request POST \
  --url https://api.dooki.com.br/v2/{alias}/checkout/payments/{paymentId}/config \
  --header 'Content-Type: application/json' \
  --header 'User-Secret-Key: <api-key>' \
  --header 'User-Token: <api-key>' \
  --data '
{
  "payment_id": 6,
  "affiliation_id": 3,
  "active": true,
  "default_display": false,
  "accumulate_discount": false,
  "ignore_promotions": false,
  "percent_discount": 0,
  "min_installment_value": 25,
  "max_installments_without_tax": 1,
  "billet_expire_days": 1
}
'

import requests

url = "https://api.dooki.com.br/v2/{alias}/checkout/payments/{paymentId}/config"

payload = {
    "payment_id": 6,
    "affiliation_id": 3,
    "active": True,
    "default_display": False,
    "accumulate_discount": False,
    "ignore_promotions": False,
    "percent_discount": 0,
    "min_installment_value": 25,
    "max_installments_without_tax": 1,
    "billet_expire_days": 1
}
headers = {
    "User-Token": "<api-key>",
    "User-Secret-Key": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {
    'User-Token': '<api-key>',
    'User-Secret-Key': '<api-key>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    payment_id: 6,
    affiliation_id: 3,
    active: true,
    default_display: false,
    accumulate_discount: false,
    ignore_promotions: false,
    percent_discount: 0,
    min_installment_value: 25,
    max_installments_without_tax: 1,
    billet_expire_days: 1
  })
};

fetch('https://api.dooki.com.br/v2/{alias}/checkout/payments/{paymentId}/config', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.dooki.com.br/v2/{alias}/checkout/payments/{paymentId}/config",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'payment_id' => 6,
    'affiliation_id' => 3,
    'active' => true,
    'default_display' => false,
    'accumulate_discount' => false,
    'ignore_promotions' => false,
    'percent_discount' => 0,
    'min_installment_value' => 25,
    'max_installments_without_tax' => 1,
    'billet_expire_days' => 1
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "User-Secret-Key: <api-key>",
    "User-Token: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.dooki.com.br/v2/{alias}/checkout/payments/{paymentId}/config"

	payload := strings.NewReader("{\n  \"payment_id\": 6,\n  \"affiliation_id\": 3,\n  \"active\": true,\n  \"default_display\": false,\n  \"accumulate_discount\": false,\n  \"ignore_promotions\": false,\n  \"percent_discount\": 0,\n  \"min_installment_value\": 25,\n  \"max_installments_without_tax\": 1,\n  \"billet_expire_days\": 1\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("User-Token", "<api-key>")
	req.Header.Add("User-Secret-Key", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.dooki.com.br/v2/{alias}/checkout/payments/{paymentId}/config")
  .header("User-Token", "<api-key>")
  .header("User-Secret-Key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"payment_id\": 6,\n  \"affiliation_id\": 3,\n  \"active\": true,\n  \"default_display\": false,\n  \"accumulate_discount\": false,\n  \"ignore_promotions\": false,\n  \"percent_discount\": 0,\n  \"min_installment_value\": 25,\n  \"max_installments_without_tax\": 1,\n  \"billet_expire_days\": 1\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.dooki.com.br/v2/{alias}/checkout/payments/{paymentId}/config")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["User-Token"] = '<api-key>'
request["User-Secret-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"payment_id\": 6,\n  \"affiliation_id\": 3,\n  \"active\": true,\n  \"default_display\": false,\n  \"accumulate_discount\": false,\n  \"ignore_promotions\": false,\n  \"percent_discount\": 0,\n  \"min_installment_value\": 25,\n  \"max_installments_without_tax\": 1,\n  \"billet_expire_days\": 1\n}"

response = http.request(request)
puts response.read_body

{
  "payment_id": 123,
  "affiliation_id": 123,
  "active": true,
  "default_display": true,
  "id": 123,
  "spread": true,
  "ignore_promotions": true,
  "accumulate_discount": true,
  "percent_discount": 123,
  "min_installment_value": 123,
  "max_installments_without_tax": 123,
  "billet_expire_days": 123,
  "days_to_cancel_unpaid_billets": 123,
  "hours_to_cancel_unpaid_pix": 123,
  "hours_to_expire_pix_code": 123,
  "billet_instructions": "<string>",
  "installments": {
    "data": [
      {
        "id": 1,
        "payment_id": 2,
        "installment": 1,
        "tax": 1.5,
        "percent_discount": 0,
        "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": {
      "id": 123,
      "active": true,
      "backup": true,
      "name": "Cielo Affiliation",
      "statement_descriptor": "<string>",
      "auto_capture": true,
      "has_payment_config": false,
      "capture_hour_delay": 123,
      "force_minimum_tax": true,
      "status": "<string>",
      "auth_type": "<string>",
      "gateway": {
        "data": [
          {
            "alias": "billet",
            "name": "Boleto Bancário",
            "icon_url": "<string>",
            "allow_backup": true,
            "allow_edit_pix_code_expiration_time": true,
            "installments_config": {
              "allow_custom_installments": true,
              "message": "<string>",
              "help_link": "<string>"
            },
            "auth_type": "api_key",
            "gateway_exists": true,
            "params": {
              "data": [
                [
                  "env",
                  "merchant_id",
                  "key"
                ]
              ]
            }
          }
        ]
      }
    }
  },
  "payment": {
    "data": {
      "id": 123,
      "alias": "<string>",
      "name": "<string>",
      "has_config": true,
      "active_config": true,
      "is_credit_card": true,
      "is_deposit": true,
      "is_billet": true,
      "is_pix": true,
      "is_pix_in_installments": true,
      "is_wallet": true,
      "icon_url": "<string>"
    }
  },
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z"
}

Authorizations

User-Token

string

header

required

User-Secret-Key

string

header

required

Path Parameters

alias

string

required

Alias da loja

paymentId

integer

required

ID da forma de pagamento

Body

application/json

payment_id

integer

required

ID do meio de pagamento configurado.

Example:

6

affiliation_id

integer

required

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

Example:

3

active

boolean

required

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

Example:

true

default_display

boolean

required

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

Example:

false

accumulate_discount

boolean

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

Example:

false

ignore_promotions

boolean

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

Example:

false

percent_discount

number<float>

Percentual de desconto aplicado ao usar este meio de pagamento.

Example:

0

min_installment_value

number<float>

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

Example:

25

max_installments_without_tax

integer

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

Example:

1

billet_expire_days

integer

Quantidade de dias até o vencimento do boleto.

Example:

1

Response

Configuração de pagamento criada com sucesso

Configuração de um meio de pagamento no checkout da loja.

payment_id

integer

required

ID do meio de pagamento configurado.

affiliation_id

integer

required

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

active

boolean

required

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

default_display

boolean

required

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

integer

Identificador único da configuração de pagamento.

spread

boolean

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

ignore_promotions

boolean

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

accumulate_discount

boolean

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

percent_discount

number<float>

Percentual de desconto aplicado ao usar este meio de pagamento.

min_installment_value

number<float>

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

max_installments_without_tax

integer

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

billet_expire_days

integer

Quantidade de dias até o vencimento do boleto.

days_to_cancel_unpaid_billets

integer

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

hours_to_cancel_unpaid_pix

integer

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

hours_to_expire_pix_code

number

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

billet_instructions

string

Instruções exibidas no boleto gerado.

installments

object

Condições de parcelamento configuradas para este meio de pagamento.

Show child attributes

affiliation

object

Afiliação (adquirente/gateway) vinculada a este meio de pagamento.

Show child attributes

payment

object

Meio de pagamento vinculado a esta configuração.

Show child attributes

created_at

string<date-time>

read-only

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

updated_at

string<date-time>

read-only

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

⌘I