Iniciar pagamento Pix

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

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
double
required

O valor da transação

double

O valor da compra (Pix Troco)

double

O valor em dinheiro disponibilizado (Pix Troco)

string

O Identificador ISPB do serviço de saque (Pix Saque/Troco)

string
enum

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.

Allowed:
string
required

A identificação única da transacção dada pelo lado do cliente. Este valor não pode ser repetido.

string

Identificador do QRCode a ser pago (ver regras de preenchimento)

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

creditParty
object

Dados bancários da conta do recebedor.

string
enum
required

Representa o tipo de pagamento que será iniciado (ver regras de preenchimento)

Allowed:
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

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.

string
enum

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;

Allowed:
string
enum

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;

Allowed:
string
enum

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)

Allowed:
Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

Language
Credentials
OAuth2
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json
text/plain