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-indirect/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. Utilizado apenas se o campo 'initiationType' for igual a '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;

Response

200

vlcpAmountnumber

vldnAmountinteger

withdrawalServiceProviderstring

withdrawalAgentModestring

transactionIdentificationstring

endToEndIdstring

initiationTypestring

taxIdPaymentInitiatorstring

remittanceInformationstring

paymentTypestring

urgencystring

transactionTypestring

clientCodestring

amountnumber

Example response

{
  "vlcpAmount": 15.55,
  "vldnAmount": 10,
  "withdrawalServiceProvider": "13935893",
  "withdrawalAgentMode": "AGTEC",
  "transactionIdentification": "dc8cf02b81b54bd59323453b207e704a",
  "endToEndId": "E3030629420200808185300887639654",
  "debitParty": {
    "account": "3794245",
    "branch": 30,
    "bank": "13935893",
    "taxId": "13935893000109",
    "accountType": "CACC",
    "name": "IS2B - Integrated Solutions to Business S.A"
  },
  "creditParty": {
    "key": "5244f4e-15ff-413d-808d-7837652ebdc2",
    "bank": "30306294",
    "account": "10545584",
    "taxId": "11122233344",
    "accountType": "CACC",
    "name": "Celcoin"
  },
  "initiationType": "DICT",
  "taxIdPaymentInitiator": "01203324000124",
  "remittanceInformation": "Texto de mensagem",
  "paymentType": "IMMEDIATE",
  "urgency": "HIGH",
  "transactionType": "TRANSFER",
  "clientCode": "1458854",
  "amount": 25.55
}