CEcelcoin

Copy of 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-1

Request

  • Base URL
    https://sandbox.openfinance.celcoin.dev
  • URL
    https://sandbox.openfinance.celcoin.dev/pix/v1/payment-1
  • Auth
    OAuth 2

Request body

amountnumber double required

O valor da transação

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, para pagamentos com chave pix utilizar "DICT"

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)

remittanceInformationstring

Descrição dos detalhes do pix

Response

200

keystring
keyTypestring
endtoendidstring
creationDatestring date
keyOwnershipDatestring date
statisticsstring
isSameTaxIdboolean

Example response

{
  "key": "teste@celcoin.com.br",
  "keyType": "EMAIL",
  "account": {
    "accountNumber": "********",
    "accountType": "********",
    "participant": "18236120"
  },
  "owner": {
    "type": "********",
    "taxIdNumber": "***778477**",
    "name": "teste celcoin"
  },
  "endtoendid": "E13935893202603231528o285mxZkw7t",
  "isSameTaxId": true
}

Changes

No recorded changes to this operation across all 1 revision of this API.