Sign in

v1

latestOpenAPI 3.1.02026-07-2678221359.6 KB
Pedidos

Criar Pedido de Pagamento

É possível realizar a criação de pagamentos com múltiplos meios de pagamento, dependendo da necessidade do usuário.

❗️ Informações do cliente são necessárias

Se o customer_id for fornecido, a inclusão do objeto customer não é obrigatória. No entanto, é importânte que pelo menos um desses parâmetros seja informado.

post/order/

Request body

discount_codestring nullable

Cupom de desconto à ser aplicado no pedido,

customer_idstring nullable

Id do cliente. Obrigatório caso o customer não seja informado.

closedboolean

Indica se o pedido está aberto ou fechado

ip_addressstring nullable

Endereço IP do dispositivo que solicitou a compra

session_idstring nullable

Código de sessão do usuário

deviceobject nullable

Dados do dispositivo utilizado na compra

metadataobject nullable

Dados adicionais do pedido

antifraud_enabledboolean

Indica se o antifraude está habilitado

external_idstring nullable

Id externo

Example request

{
  "items": [
    {
      "amount": 100,
      "description": "Produto de teste",
      "metadata": {},
      "product_id": "I7OX98ZP_3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "type": "physical"
    }
  ],
  "payments": [
    {
      "credit_card": {
        "card": {
          "billing_address": {
            "city": "Brasília",
            "line_1": "SCN Q 4 Asa Norte",
            "line_2": "Sala 304",
            "state": "DF",
            "zip_code": "70714900"
          },
          "brand": "visa",
          "cvv": 123,
          "exp_month": 12,
          "exp_year": 2025,
          "holder_document": "12345678900",
          "holder_name": "João da Silva",
          "number": "4111111111111111"
        },
        "card_token": "card_token_A0360831-48F4-47E8-AECC-B5021577A3BB",
        "installments": 12,
        "operation_type": "credit",
        "statement_descriptor": "ZAPAY"
      },
      "bank_slip": {
        "document": "12345678900",
        "name": "José Maria"
      },
      "pix": {
        "additional_information": {
          "document": "12345678900",
          "name": "João da Silva"
        },
        "expires_at": "2021-10-10T00:00:00Z",
        "expires_in": "1H"
      },
      "voucher": {
        "card": {
          "billing_address": {
            "city": "Brasília",
            "line_1": "SCN Q 4 Asa Norte",
            "line_2": "Sala 304",
            "state": "DF",
            "zip_code": "70714900"
          },
          "brand": "visa",
          "expiration_month": 12,
          "expiration_year": 2025,
          "holder_name": "João da Silva",
          "number": "4111111111111111",
          "security_code": 123
        },
        "statement_descriptor": "ZAPAY"
      }
    }
  ]
}

Response

Pedido criado com sucesso

OR

Example response

{
  "order_id": "order_38CB8096-6259-42FA-A926-16F85F87079A"
}