HomeBlogLoginSignup

Pix Key

Check a key

post
/banking/cashout/pix/keys/check

Checks a key

Body

Payload to check a key

entity_idstring · uuidRequired

Unique identifier

keystringRequired

Key

Responses
200

CheckKey

application/json
post
/banking/cashout/pix/keys/check
POST /banking/cashout/pix/keys/check HTTP/1.1
Host: api.sandbox.trio.com.br
Content-Type: application/json
Accept: */*
Content-Length: 72

{
  "entity_id": "41234d60-f6a9-4c9c-8cc3-5769ce9bbea2",
  "key": "32165998093"
}
{
  "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
/banking/cashout/pix

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
post
/banking/cashout/pix
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"
  }
}

Generates a pix v2

post
/banking/cashout/pix/v2

Generates a pix v2

Body

Body params to generate a pix v2

amountintegerRequired

Amount

descriptionstringOptional

Pix description

external_idstringOptional

External ID

referencestringRequired

Receiver pix key or receiver brcode

reference_tax_numberstringOptional

Receiver tax number reference

typestring · enumRequired

Pix reference type

Possible values:
virtual_account_idstring · uuidRequired

Unique identifier

Responses
200

GeneratePixV2

application/json
post
/banking/cashout/pix/v2
POST /banking/cashout/pix/v2 HTTP/1.1
Host: api.sandbox.trio.com.br
Content-Type: application/json
Accept: */*
Content-Length: 208

{
  "amount": 100,
  "description": "description",
  "external_id": "external_id 1",
  "reference": "12345678920",
  "reference_tax_number": "12345678920",
  "type": "key",
  "virtual_account_id": "1a760495-cb95-4023-96e8-0cff5776b010"
}
{
  "data": {
    "payment_document_id": "41234d60-f6a9-4c9c-8cc3-5769ce9bbea2"
  }
}

PreviousPaymentNextPix Brcode

Last updated

Was this helpful?