v1

latestOpenAPI 3.0.12026-07-245303882.5 MB

Iniciar pagamento Pix

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

post/pix/v1/payment

Request body

amountnumber double required

O valor da transação

vlcpAmountnumber double

O valor da compra (Pix Troco)

vldnAmountnumber double

O valor em dinheiro disponibilizado (Pix Troco)

withdrawalServiceProviderstring

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.

clientCodestring required

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

transactionIdentificationstring

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

endToEndIdstring

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.

initiationType'DICT' | 'STATIC_QRCODE' | 'DYNAMIC_QRCODE' | 'MANUAL' | 'PAYMENT_INITIATOR' required

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

taxIdPaymentInitiatorstring

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

remittanceInformationstring

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

transactionIdinteger

codestring

slipstring

slipAuthstring

endToEndIdstring

Example response

{
  "transactionId": 2148063531,
  "code": "SUCCESS",
  "slip": "     COMPROVANTE TRANSFERENCIA PIX      \n          17/09/2024 08:29:11           \n           TERM 11 AGENTE 999           \n                CONTROLE                \n    E13935893202409171128gN5M2PVsoa0    \n----------------------------------------\n                PAGADOR                 \n\n             Teste Celcoin              \n            AG:1 CC:100548396           \n      CPF/CNPJ:13.935.893/0003-70       \n----------------------------------------\n               RECEBEDOR                \n\n             Teste Celcoin              \n        CELCOIN PAGAMENTOS S.A.         \n      13935893 AG:1 CC:100548395      \n        CPF/CNPJ:XXX.538.954-XX         \nCHAVE:fce34206-b9ae-4810-b6e3-a5d22aac8937\n----------------------------------------\n DATA DO PAGAMENTO 17/09/2024 08:29:11  \n\n             VALOR R$ 15,00             \n----------------------------------------\n              AUTENTICACAO              \n        4A.67.CC.08.B4.7F.48.DF         \n        A9.02.B1.A9.E8.15.C8.81         \n",
  "slipAuth": "4A.67.CC.08.B4.7F.48.DF.A9.02.B1.A9.E8.15.C8.81",
  "endToEndId": "E13935893202409171128gN5M2PVsoa0"
}