GET /v1/execute/pix/{transactionId}

O endpoint de execução de transações PIX é responsável por confirmar a transferência de valores entre contas bancárias, realizadas através dos demais endpoints disponibilizados pela nossa API.

Este endpoint é essencial para garantir a segurança e integridade das transações realizadas pelos nossos clientes, pois é aqui que ocorre a confirmação final da transferência. Para executar uma transação, basta fornecer o código de transação gerado pelo endpoint correspondente.

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
      • key string
      • value number
      • message string
      • status string
      • error string
GET /v1/execute/pix/{transactionId} 
curl \
 -X GET https://sandbox.agavos.com.br/v1/execute/pix/{transactionId} \
 -H "Authorization: Bearer $ACCESS_TOKEN"
Response examples (200) 
{
  "code": 0,
  "data": {
    "id": "12312312j1231283123123123",
    "date": 1681182000000,
    "bank": "123",
    "account": "33333333",
    "digit": "1",
    "branch": "2",
    "accountType": 1,
    "document": "***.123.123-**",
    "name": "Alice Smith",
    "type": "PHONE",
    "key": "1198765431",
    "value": 2.19,
    "message": "Sua mensagem",
    "status": "DONE",
    "error": null
  }
}
Response examples (200) 
{
  "code": 0,
  "data": {
    "id": "12312312j1231283123123123",
    "key": "1198765431",
    "bank": "123",
    "date": 1681182000000,
    "name": "Alice Smith",
    "type": "PHONE",
    "digit": "1",
    "error": null,
    "value": 2.19,
    "branch": "2",
    "status": "DONE",
    "account": "33333333",
    "message": "Sua mensagem",
    "document": "***.123.123-**",
    "accountType": 1
  }
}