Iniciar pagamento Pix

post https://sandbox.openfinance.celcoin.dev/pix/v1/payment

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

time	status	user agent
Retrieving recent requests…

Loading…

📘
Criamos um artigo que explica, detalhadamente, como usar essa API.

Regras de preenchimento e validação conforme o 'TransactionType':

TRANSFER:
• 'vlcpAmount', 'vldnAmount', 'withdrawalAgentMode' e 'withdrawalServiceProvider' não devem ser preenchidos.

WITHDRAWAL:
• 'vlcpAmount' não deve ser preenchido, 'vldnAmount', 'withdrawalAgentMode' e 'withdrawalServiceProvider' devem ser preenchidos.

CHANGE:
• 'vlcpAmount', 'vldnAmount', 'withdrawalAgentMode' e 'withdrawalServiceProvider' devem ser preenchidos.

Regras de preenchimento e validação conforme o 'InitiationType':

MANUAL:
• 'transactionIdentification' deve ser nulo
• 'creditParty.key' deve ser nulo
• 'endToEndId' NÃO deve ser preenchido, o identificador é gerado automaticamente .

DICT:
• 'transactionIdentification' deve ser nulo
• 'creditParty.key' deve ser preenchido
• 'endToEndId' deve ser preenchido com o mesmo endToEndId da consulta ao DICT.

STATIC_QRCODE:
• 'transactionIdentification' deve ser preenchido com o identificador do QR Code contendo até 25 caracteres
• 'creditParty.key' deve ser preenchido
• 'endToEndId' deve ser preenchido com o mesmo endToEndId da consulta ao DICT.

DYNAMIC_QRCODE:
• 'transactionIdentification' deve ser preenchido com o identificador do QR Code contendo de 26 até 35 caracteres
• 'creditParty.key' deve ser preenchido
• 'endToEndId' deve ser preenchido com o mesmo endToEndId da consulta ao DICT.

PAYMENT_INITIATOR:
• 'transactionIdentification' deve ser preenchido de acordo com a regra de pagamento de STATIC_QRCODE
• 'creditParty.key' deve ser preenchido caso exista uma consulta DICT pré-pagamento
• 'taxIdPaymentInitiator' deve ser preenchido com um CNPJ (14 caracteres)
• 'endToEndId' deve ser preenchido com o mesmo endToEndId da consulta ao DICT.

Regras de preenchimento e validação conforme o 'PaymentType':

IMMEDIATE: pagamentos que deverão ser efetuados imediatamente, no ato da solicitação pelo usuário pagador
• 'urgency' deve ser preenchido com HIGH.

FRAUD: usado para pagamento por suspeita de fraude
• 'urgency' deve ser preenchido com NORMAL.

SCHEDULED: transações que não serão realizadas imediatamente, como no caso de pagamentos agendados.
• 'urgency' deve ser preenchido com NORMAL.

Body Params

amount

double

required

O valor da transação

vlcpAmount

double

O valor da compra (Pix Troco)

vldnAmount

double

O valor em dinheiro disponibilizado (Pix Troco)

withdrawalServiceProvider

string

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

withdrawalAgentMode

string

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

creditParty

object

Dados bancários da conta do recebedor.

initiationType

string

required

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

taxIdPaymentInitiator

string

CNPJ do iniciador de pagamentos. Utilizado apenas se o campo 'initiationType' for igual a '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

string

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

string

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

string

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;

Responses

Language

Credentials

OAuth2


xxxxxxxxxx
1
curl --request POST \
2
     --url https://sandbox.openfinance.celcoin.dev/pix/v1/payment \
3
     --header 'accept: application/json' \
4
     --header 'content-type: application/json' \
5
     --data '
6
{
7
  "initiationType": "DICT"
8
}
9
'

Click Try It! to start a request and see the response here! Or choose an example:

application/json

text/plain

📘

200200

400400

401401

500500

504504