POST /v1/pix

Através da nossa API, desenvolvedores podem integrar o PIX nas soluções de suas empresas de forma simplificada, com acesso a recursos avançados de segurança e eficiência. Com este endpoint, sua empresa pode realizar transferências de forma instantânea, sem a necessidade de digitar informações como agência, conta e CPF. Basta informar a chave PIX do destinatário para que a transação seja realizada em tempo real.

Body

  • accountFrom string
  • keyType string

    Values are PHONE, EMAIL, RANDOM, CNPJ, or CPF.

  • pixKey string
  • value number
  • date string
  • description string
  • message string

Responses

  • 200

    OK

    Hide response attributes Show response attributes object
    • code integer
    • data object
      Hide data attributes Show data attributes object
      • id string
      • date number
      • bank string
      • account string
      • digit string
      • branch string
      • accountType integer
      • document string
      • name string
      • type string

        Values are PHONE, EMAIL, RANDOM, CNPJ, or CPF.

      • key string
      • value number
      • message string
POST /v1/pix 
curl \
 -X POST https://sandbox.agavos.com.br/v1/pix \
 -H "Authorization: Bearer $ACCESS_TOKEN" \
 -H "Content-Type: application/json" \
 -d '{"accountFrom":"abs8cjsdb123asd13124qsd","keyType":"PHONE","pixKey":"10987654321","value":89.9,"date":"11/04/2023","description":"Pix para o telefone","message":"Sua mensagem personalizada no pix"}'
Request example 
{
  "accountFrom": "abs8cjsdb123asd13124qsd",
  "keyType": "PHONE",
  "pixKey": "10987654321",
  "value": 89.9,
  "date": "11/04/2023",
  "description": "Pix para o telefone",
  "message": "Sua mensagem personalizada no pix"
}
Request examples 
89.9
Response examples (200) 
{
  "code": 0,
  "data": {
    "id": "19281023901203901029",
    "date": 1681182000000,
    "bank": "123",
    "account": "33333333",
    "digit": "1",
    "branch": "0001",
    "accountType": 1,
    "document": "***.123.123-**",
    "name": "Alice Smith",
    "type": "PHONE",
    "key": "10987654321",
    "value": 89.9,
    "message": "Sua mensagem"
  }
}
Response examples (200) 
{
  "code": 0,
  "data": {
    "id": "12312312j1231283123123123",
    "key": "1198765431",
    "bank": "123",
    "date": 1681182000000,
    "name": "Alice Smith",
    "type": "PHONE",
    "digit": "1",
    "value": 2.19,
    "branch": "2",
    "account": "33333333",
    "message": "Sua mensagem",
    "document": "***.123.123-**",
    "accountType": 1
  }
}