LogoLogo
HomeBlogLoginSignup
  • Get started
  • Guides
  • Reference
  • Banking API
    • Entities
    • Counterparties
    • Institutions
    • Bank accounts
    • Virtual accounts
    • Collecting
      • Dynamic QR codes
      • Static QR codes
      • Refund
    • Payment
      • Pix Key
      • Pix Brcode
    • Transfer
    • Documents
      • Collecting
      • Collecting - Refund
      • Payment
      • Payment - Refund
      • Transfer
    • Checkout
    • Developers
      • Webhooks
Powered by GitBook
On this page

Was this helpful?

  1. Banking API
  2. Payment

Pix Brcode

PreviousPix KeyNextTransfer

Last updated 4 months ago

Was this helpful?

  • POSTCheck a brcode hash
  • POSTGenerate a pix payment

Check a brcode hash

post

Checks a brcode hash

Body

Payload to check a brcode

entity_idstringRequired

Entity ID

hashstringRequired

Hash of the brcode

Responses
200
Check
application/json
401
Unauthorized
application/json
404
Unprocessable Entity
application/json
500
Internal server error
application/json
post
POST /banking/cashout/pix/brcodes/check HTTP/1.1
Host: api.sandbox.trio.com.br
Content-Type: application/json
Accept: */*
Content-Length: 65

{
  "entity_id": "41234d60-f6a9-4c9c-8cc3-5769ce9bbea2",
  "hash": "123"
}
{
  "data": {
    "counterparty": {
      "bank_account": {
        "branch": "0001",
        "digit": "1",
        "id": "41234d60-f6a9-4c9c-8cc3-5769ce9bbea2",
        "ispb": "12345678",
        "number": "123456",
        "type": "checking"
      },
      "id": "41234d60-f6a9-4c9c-8cc3-5769ce9bbea2",
      "name": "John Doe",
      "tax_number": "14633666800"
    },
    "hash": "2941H29481H827GGY2G873GR1H893RG1793GFYI71G7",
    "id": "41234d60-f6a9-4c9c-8cc3-5769ce9bbea2",
    "inserted_at": "2020-01-10T10:00:00",
    "key": "32165998093",
    "key_type": "tax_number",
    "updated_at": "2024-01-10T10:00:00"
  }
}

Generate a pix payment

post

Generates a pix payment

Body

Body params to generate a pix

amountintegerRequired

Amount

descriptionstringOptional

Pix description

external_idstringOptional

External ID

pix_ref_idstringOptional

Pix unique identifier from DICT. Must be informed with pix ref type is key or brcode

pix_ref_typestring · enumRequired

Pix reference type

Possible values:
virtual_account_idstring · uuidRequired

Unique identifier

Responses
200
GeneratePix
application/json
401
Unauthorized
application/json
404
Unprocessable Entity
application/json
500
Internal server error
application/json
post
POST /banking/cashout/pix HTTP/1.1
Host: api.sandbox.trio.com.br
Content-Type: application/json
Accept: */*
Content-Length: 358

{
  "amount": 100,
  "description": "description",
  "external_id": "external_id 1",
  "pix_ref_bank_account": {
    "branch": "0001",
    "digit": "1",
    "ispb": "12345678",
    "name": "Name Test",
    "number": "123456",
    "tax_number": "06811334061",
    "type": "checking"
  },
  "pix_ref_id": "1a760495-cb95-4023-96e8-0cff5776b010",
  "pix_ref_type": "key",
  "virtual_account_id": "1a760495-cb95-4023-96e8-0cff5776b010"
}
{
  "data": {
    "payment_document_id": "41234d60-f6a9-4c9c-8cc3-5769ce9bbea2"
  }
}