FictorPay
  • Introdução
  • Setup
    • Login
    • Webhooks
  • Estrutura
    • Conta
    • Saldo
  • Transacional
    • QR Code Estático
    • PIX out
  • Referências de API
    • Account
    • Auth
    • Partner
    • Pix
Powered by GitBook
On this page
  1. Referências de API

Pix

Last updated 1 year ago

List account DueDate qrcode

get

List account DueDate qrcode

Query parameters
cursorstringOptional
limitstringOptional
statusstringOptional
tax_idstringOptional
Header parameters
authorizationstringRequired

authorization

Responses
200
OK
get
GET /mobile-bff/v1/pix/qrcode/dynamic/due-date HTTP/1.1
Host: 
authorization: text
Accept: */*
200

OK

No content

List account immediate qrcode

get

List account immediate qrcode

Path parameters
idstringRequired

id

Query parameters
cursorstringOptional
limitstringOptional
statusstringOptional
tax_idstringOptional
Header parameters
authorizationstringRequired

authorization

Responses
200
OK
get
GET /mobile-bff/v1/pix/qrcode/dynamic/immediate HTTP/1.1
Host: 
authorization: text
Accept: */*
200

OK

No content

Create due date qrcode

post

Create due date qrcode

Path parameters
idstringRequired

id

Header parameters
authorizationstringRequired

authorization

Body
dict_keystringRequired
messagestringOptional
tx_idstringRequired
Responses
200
OK
post
POST /mobile-bff/v1/pix/qrcode/dynamic/due-date HTTP/1.1
Host: 
authorization: text
Content-Type: application/json
Accept: */*
Content-Length: 572

{
  "additional_infos": [
    {
      "name": "text",
      "value": "text"
    }
  ],
  "amount": {
    "deduction": {
      "amount": "text",
      "modality": "text"
    },
    "discount": {
      "amount": "text",
      "fixedDateDiscount": [
        {
          "amount": "text",
          "date": "text"
        }
      ],
      "modality": "text"
    },
    "fine": {
      "amount": "text",
      "modality": "text"
    },
    "interest": {
      "amount": "text",
      "modality": "text"
    },
    "original": "text"
  },
  "calendar": {
    "due_date": "text",
    "expiration_days": 1
  },
  "dict_key": "text",
  "message": "text",
  "payer": {
    "address_line": "text",
    "can_change_document": true,
    "city": "text",
    "email": "text",
    "name": "text",
    "state": "text",
    "tax_id": "text",
    "zipcode": "text"
  },
  "tx_id": "text"
}
200

OK

No content

Create immediate qrcode

post

Create immediate qrcode

Path parameters
idstringRequired

id

Header parameters
authorizationstringRequired

authorization

Body
dict_keystringRequired
messagestringOptional
tx_idstringRequired
Responses
200
OK
post
POST /mobile-bff/v1/pix/qrcode/dynamic/immediate HTTP/1.1
Host: 
authorization: text
Content-Type: application/json
Accept: */*
Content-Length: 227

{
  "additional_infos": [
    {
      "name": "text",
      "value": "text"
    }
  ],
  "amount": {
    "original": "text"
  },
  "calendar": {
    "expiration": 1
  },
  "dict_key": "text",
  "message": "text",
  "payer": {
    "can_change_document": true,
    "name": "text",
    "tax_id": "text"
  },
  "tx_id": "text"
}
200

OK

No content

  • POSTCheck brcode emv
  • POSTCheck pix key
  • POSTCreate pix out
  • GETList account DueDate qrcode
  • POSTCreate due date qrcode
  • DELETECancel due date qrcode
  • GETList account immediate qrcode
  • POSTCreate immediate qrcode
  • DELETECancel immediate qrcode
  • POSTGenerate static qrcode

Cancel due date qrcode

delete

Cancel due date qrcode

Path parameters
idstringRequired

id

Header parameters
authorizationstringRequired

authorization

Responses
200
OK
delete
200

OK

No content

Cancel immediate qrcode

delete

Cancel immediate qrcode

Path parameters
idstringRequired

id

Header parameters
authorizationstringRequired

authorization

Responses
200
OK
delete
200

OK

No content

Check brcode emv

post

Check brcode emv

Header parameters
authorizationstringRequired

authorization

Body
emvstringRequired
Responses
200
Success
application/json
post
POST /mobile-bff/v1/pix/brcode/emv/ HTTP/1.1
Host: 
authorization: text
Content-Type: application/json
Accept: */*
Content-Length: 14

{
  "emv": "text"
}
200

Success

{
  "additional_infos": [
    {
      "name": "text",
      "value": "text"
    }
  ],
  "allow_value_change": true,
  "beneficiary": {
    "account_number": "text",
    "account_type": "text",
    "branch": "text",
    "dict_key": "text",
    "ispb": "text",
    "name": "text",
    "tax_id": "text",
    "trade_name": "text"
  },
  "deduction": "text",
  "discount": "text",
  "due_date": "text",
  "expiration": "text",
  "final_amount": "text",
  "fine": "text",
  "interest": "text",
  "message": "text",
  "original_amount": "text",
  "payer": {
    "name": "text",
    "tax_id": "text"
  },
  "qrcode_type": "text",
  "revision": 1,
  "status": "text",
  "tx_id": "text",
  "url": "text"
}

Check pix key

post

Check pix key

Header parameters
authorizationstringRequired

authorization

Body
dict_keystringRequired
Responses
200
OK
application/json
post
POST /mobile-bff/v1/pix/dict/check/ HTTP/1.1
Host: 
authorization: text
Content-Type: application/json
Accept: */*
Content-Length: 19

{
  "dict_key": "text"
}
200

OK

{
  "account_number": "text",
  "account_type": "text",
  "branch": "text",
  "dict_key": "text",
  "dict_key_type": "text",
  "id": "text",
  "initiation_id": "text",
  "ispb": "text",
  "owner_document": "text",
  "owner_name": "text",
  "owner_trade_name": "text",
  "owner_type": "text"
}

Create pix out

post

Create pix out

Header parameters
authorizationstringRequired

authorization

Body
amountstringRequired
descriptionstringOptional
dict_keystringOptional
emvstringOptional
initiation_idstringOptional
payment_datestringOptional
typestringRequired
Responses
201
Created
application/json
post
POST /mobile-bff/v1/pix/out/ HTTP/1.1
Host: 
authorization: text
Content-Type: application/json
Accept: */*
Content-Length: 250

{
  "amount": "text",
  "beneficiary": {
    "account_number": "text",
    "account_type": "text",
    "branch": "text",
    "ispb": "text",
    "name": "text",
    "tax_id": "text"
  },
  "description": "text",
  "dict_key": "text",
  "emv": "text",
  "initiation_id": "text",
  "payment_date": "text",
  "type": "text"
}
201

Created

{
  "data": {
    "account_id": "text",
    "amount": "text",
    "beneficiary": {
      "account_type": "text",
      "ispb": "text",
      "name": "text",
      "tax_id": "text"
    },
    "description": "text",
    "end_to_end_id": "text",
    "id": "text",
    "initiation_type": "text",
    "payer": {
      "account_type": "text",
      "ispb": "text",
      "name": "text",
      "tax_id": "text"
    },
    "rejection_message": "text",
    "settled_at": "text",
    "status": "text",
    "tx_id": "text"
  },
  "id": "text",
  "status": "text"
}
DELETE /mobile-bff/v1/pix/qrcode/dynamic/due-date/:id HTTP/1.1
Host: 
authorization: text
Accept: */*
DELETE /mobile-bff/v1/pix/qrcode/dynamic/immediate/:id HTTP/1.1
Host: 
authorization: text
Accept: */*

Generate static qrcode

post

Generate static qrcode

Header parameters
authorizationstringRequired

authorization

Body
amountstringRequired
dict_keystringRequired
messagestringOptional
Responses
200
OK
application/json
post
POST /mobile-bff/v1/pix/qrcode/static/ HTTP/1.1
Host: 
authorization: text
Content-Type: application/json
Accept: */*
Content-Length: 52

{
  "amount": "text",
  "dict_key": "text",
  "message": "text"
}
200

OK

{
  "amount": "text",
  "created_at": "text",
  "dict_key": "text",
  "emv": "text",
  "id": "text",
  "message": "text",
  "qrcode_image": "text",
  "tx_id": "text"
}