---
title: "Iniciar pagamento Pix"
method: POST
path: "/pix/v1/payment"
---

# Iniciar pagamento Pix

`POST /pix/v1/payment`

Essa API permite que seja realizada a iniciação de um pagamento Pix a partir das regras populadas em seu payload.

## Request body

- object
  - `amount` number, double, required — O valor da transação
  - `vlcpAmount` number, double — O valor da compra (Pix Troco)
  - `vldnAmount` number, double — O valor em dinheiro disponibilizado (Pix Troco)
  - `withdrawalServiceProvider` string — O Identificador ISPB do serviço de saque (Pix Saque/Troco)
  - `withdrawalAgentMode` 'AGTEC' | 'AGTOT' | 'AGPSS' — Modo do agente de retirada. **AGTEC:** Estabelecimento Comercial, **AGTOT:** Entidade Jurídica cuja atividade é a prestação de serviços auxiliares de serviços financeiros, **AGPSS:** Participante Pix que presta diretamente o serviço de saque.
  - `clientCode` string, required — A identificação única da transacção dada pelo lado do cliente. Este valor não pode ser repetido.
  - `transactionIdentification` string — Identificador do QRCode a ser pago (ver regras de preenchimento)
  - `endToEndId` string — Identificador de ponta a ponta associado a este pedido de iniciação de pagamento. Deve ser o mesmo da consulta ao DICT, quando aplicável.
  - `debitParty` object — Dados bancários da conta do pagador na Celcoin
    - `Account` string
    - `Bank` string
    - `Branch` string
    - `PersonType` string
    - `TaxId` string
    - `AccountType` 'CACC' | 'SLRY' | 'SVGS' | 'TRAN'
    - `Name` string
  - `creditParty` object — Dados bancários da conta do recebedor.
    - `Account` string
    - `Bank` string
    - `Branch` string
    - `PersonType` string
    - `TaxId` string
    - `AccountType` 'CACC' | 'SLRY' | 'SVGS' | 'TRAN'
    - `Name` string
    - `Key` string
  - `initiationType` 'DICT' | 'STATIC_QRCODE' | 'DYNAMIC_QRCODE' | 'MANUAL' | 'PAYMENT_INITIATOR', required — Representa o tipo de pagamento que será iniciado (ver regras de preenchimento)
  - `taxIdPaymentInitiator` string — CNPJ do iniciador de pagamentos. Será aceito independente do "initiationType", mas utilize apenas para transações que forem de iniciador de pagamento. Ou seja, initiationType = Payment_Initiator
  - `remittanceInformation` string — Determina um texto a ser apresentado ao pagador para que este possa introduzir uma informação correlacionada, em formato livre, a ser enviada para o receptor. Se presente no BRCode Dinâmico, deve ser preservado e informado aqui.
  - `paymentType` 'IMMEDIATE' | 'FRAUD' | 'SCHEDULED' — Representa o tipo de pagamento podendo ser: **IMMEDIATE:** Utilizado para operações de pagamento normais (valor padrão se nulo ou vazio); **FRAUD:** Utilizado para pagamento em caso de suspeita de fraude; **SCHEDULED:** Utilizado apenas para operações de pagamento programadas;
  - `urgency` 'HIGH' | 'NORMAL' — Define a urgência do pagamento: **HIGH:** Utilizado para operações de pagamento normais (valor padrão se nulo ou vazio); **NORMAL:** Utilizado apenas para operações de pagamento programadas;
  - `transactionType` 'TRANSFER' | 'CHANGE' | 'WITHDRAWAL' | 'PAYMENT_REFUND' — Representa o tipo de transação que pode ser: **TRANSFER:** Utilizado para uma transação de pagamento normal (valor padrão se nulo ou vazio); **CHANGE:** Utilizado para Pix Troco; **WITHDRAWAL:** Usado para Pix Saque; **PAYMENT_REFUND** Utilizado para casos de devolução de recuperação de valores (quando o motivo da pacs008 precisa ser o IPRT)

## Response `200`

200

- object
  - `transactionId` integer
  - `code` string
  - `slip` string
  - `slipAuth` string
  - `endToEndId` string

## Other responses

- `400` — 400
- `401` — 401
- `500` — 500
- `504` — 504

---

[API](https://skmtc.net/celcoin/apis/api-para-transa-es.md) · [All operations](https://skmtc.net/celcoin/apis/api-para-transa-es/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/celcoin/api-para-transa-es/revisions/85dd6188a37b/schema)