Pix

Check brcode emv

Check brcode emv

POST/mobile-bff/v1/pix/brcode/emv/

Header parameters

Body

application/json

body

emv*string

Response

200

Success

Body

application/json

additional_infosarray of baas.AdditionalInfo (object)

allow_value_changeboolean

beneficiarybaas.QrcodeBeneficiary (object)

deductionstring

discountstring

due_datestring

expirationstring

final_amountstring

finestring

intereststring

messagestring

original_amountstring

payerbaas.Payer (object)

qrcode_typestring

revisioninteger

statusstring

tx_idstring

urlstring

Request

JavaScriptCurl

const response = await fetch('/mobile-bff/v1/pix/brcode/emv/', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "emv": "text"
    }),
});
const data = await response.json();

Response

{
  "additional_infos": [
    {
      "name": "text",
      "value": "text"
    }
  ],
  "allow_value_change": false,
  "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",
  "status": "text",
  "tx_id": "text",
  "url": "text"
}

Check pix key

Check pix key

POST/mobile-bff/v1/pix/dict/check/

Header parameters

Body

application/json

body

dict_key*string

Response

200

OK

Body

application/json

account_numberstring

account_typestring

branchstring

dict_keystring

dict_key_typestring

idstring

initiation_idstring

ispbstring

owner_documentstring

owner_namestring

owner_trade_namestring

owner_typestring

Request

JavaScriptCurl

const response = await fetch('/mobile-bff/v1/pix/dict/check/', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "dict_key": "text"
    }),
});
const data = await response.json();

Response

{
  "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

Create pix out

POST/mobile-bff/v1/pix/out/

Header parameters

Body

application/json

body

amount*string

beneficiarybaas.CreatePixOutBeneficiary (object)

descriptionstring

dict_keystring

emvstring

initiation_idstring

payment_datestring

type*string

Response

201

Created

Body

application/json

databaas.PixOut (object)

idstring

statusstring

Request

JavaScriptCurl

const response = await fetch('/mobile-bff/v1/pix/out/', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "amount": "text",
      "type": "text"
    }),
});
const data = await response.json();

Response

{
  "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"
}

List account DueDate qrcode

List account DueDate qrcode

GET/mobile-bff/v1/pix/qrcode/dynamic/due-date

Query parameters

Header parameters

Response

200

OK

Request

JavaScriptCurl

const response = await fetch('/mobile-bff/v1/pix/qrcode/dynamic/due-date', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Create due date qrcode

Create due date qrcode

POST/mobile-bff/v1/pix/qrcode/dynamic/due-date

Path parameters

id*string

id

Header parameters

Body

application/json

body

additional_infosarray of baas.AdditionalInfos (object)

amount*baas.DueDateDynamicAmount (object)

calendar*baas.DueDateDynamicQrcodeCalendar (object)

dict_key*string

messagestring

payer*baas.DueDateDynamicQrcodeDebtor (object)

tx_id*string

Response

200

OK

Request

JavaScriptCurl

const response = await fetch('/mobile-bff/v1/pix/qrcode/dynamic/due-date', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "amount": {
        "original": "text"
      },
      "calendar": {
        "due_date": "text"
      },
      "dict_key": "text",
      "payer": {
        "name": "text",
        "tax_id": "text"
      },
      "tx_id": "text"
    }),
});
const data = await response.json();

Cancel due date qrcode

Cancel due date qrcode

DELETE/mobile-bff/v1/pix/qrcode/dynamic/due-date/:id

Path parameters

id*string

id

Header parameters

Response

200

OK

Request

JavaScriptCurl

const response = await fetch('/mobile-bff/v1/pix/qrcode/dynamic/due-date/:id', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

List account immediate qrcode

List account immediate qrcode

GET/mobile-bff/v1/pix/qrcode/dynamic/immediate

Path parameters

id*string

id

Query parameters

Header parameters

Response

200

OK

Request

JavaScriptCurl

const response = await fetch('/mobile-bff/v1/pix/qrcode/dynamic/immediate', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Create immediate qrcode

Create immediate qrcode

POST/mobile-bff/v1/pix/qrcode/dynamic/immediate

Path parameters

id*string

id

Header parameters

Body

application/json

body

additional_infosarray of baas.AdditionalInfos (object)

amount*object

calendar*object

dict_key*string

messagestring

payerobject

tx_id*string

Response

200

OK

Request

JavaScriptCurl

const response = await fetch('/mobile-bff/v1/pix/qrcode/dynamic/immediate', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "amount": {
        "original": "text"
      },
      "calendar": {},
      "dict_key": "text",
      "tx_id": "text"
    }),
});
const data = await response.json();

Cancel immediate qrcode

Cancel immediate qrcode

DELETE/mobile-bff/v1/pix/qrcode/dynamic/immediate/:id

Path parameters

id*string

id

Header parameters

Response

200

OK

Request

JavaScriptCurl

const response = await fetch('/mobile-bff/v1/pix/qrcode/dynamic/immediate/:id', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

Generate static qrcode

Generate static qrcode

POST/mobile-bff/v1/pix/qrcode/static/

Header parameters

Body

application/json

body

amount*string

dict_key*string

messagestring

Response

200

OK

Body

application/json

amountstring

created_atstring

dict_keystring

emvstring

idstring

messagestring

qrcode_imagestring

tx_idstring

Request

JavaScriptCurl

const response = await fetch('/mobile-bff/v1/pix/qrcode/static/', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "amount": "text",
      "dict_key": "text"
    }),
});
const data = await response.json();

Response

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