post https://apigwws.bizapis.com/v2/documents/ss-payref-tsu
Retrieve payment references for TSU
What's New in bizAPIs 3.0Enhanced Error Responses with bizAPIs Status Codes
bizAPIs 3.0 introduces structured error responses with dedicated bizAPIs status codes, making debugging faster and support interactions more efficient. All error responses now include detailed metadata like
requestId,errorCode, anderrorNameto help you quickly identify and resolve issues.
Availability by Environment
Environment Status 📚 Documentation ⏳ Coming Soon 🧪 QUAL ⏳ Coming Soon 🚀 Production ⏳ Coming Soon
Important NoticeThe option to receive the pdf document associated with the extracted information is only available for licenses that include access to this file.
If you wish to enable this feature in your plan, please contact our sales team for further details and subscription options.
JSON Schema for API Response
{
"type" : "object",
"properties" : {
"message" : {
"type" : "string",
"description" : "A human-readable message providing additional information about the response, such as error details or informative status updates"
},
"data" : {
"type" : "object",
"properties" : {
"requestId" : {
"type" : "string",
"description" : "Unique identifier for the request"
},
"paymentDocs" : {
"type" : "array",
"description" : "List of TSU payment documents",
"items" : {
"type" : "object",
"properties" : {
"documentId" : {
"type" : "string",
"description" : "Unique identifier for the document"
},
"emissionDate" : {
"type" : "string",
"description" : "Document emission date"
},
"validityDate" : {
"type" : "string",
"description" : "Document validity date"
},
"emittedBy" : {
"type" : "string",
"description" : "Name of the entity that emitted the document"
},
"niss" : {
"type" : "string",
"description" : "Emitting entity NISS"
},
"nif" : {
"type" : "string",
"description" : "Emitting entity NIF"
},
"amount" : {
"type" : "number",
"description" : "Amount to Pay"
},
"iban" : {
"type" : "string",
"description" : "IBAN receiving entity"
},
"swift" : {
"type" : "string",
"description" : "SWIFT receiving entity"
},
"entity" : {
"type" : "string",
"description" : "Receiving entity"
},
"paymentReference" : {
"type" : "string",
"description" : "Payment reference associated with the payment document"
}
}
}
}
}
},
"files" : {
"type" : "array",
"description" : "A list of files, each encoded as a Base64 string. Used when multiple files are included in the response.",
"items" : {
"type" : "string"
}
}
}
}
{
"type" : "object",
"properties" : {
"message" : {
"type" : "string",
"description" : "Mensagem legível para humanos que fornece informações adicionais sobre a resposta, como detalhes de erro ou atualizações informativas de estado"
},
"data" : {
"type" : "object",
"properties" : {
"requestId" : {
"type" : "string",
"description" : "Identificador único do pedido"
},
"paymentDocs" : {
"type" : "array",
"description" : "Lista de documentos de pagamento TSU",
"items" : {
"type" : "object",
"properties" : {
"documentId" : {
"type" : "string",
"description" : "Identificador único do documento"
},
"emissionDate" : {
"type" : "string",
"description" : "Data de emissão do documento"
},
"validityDate" : {
"type" : "string",
"description" : "Data de validade do documento"
},
"emittedBy" : {
"type" : "string",
"description" : "Nome da entidade que emitiu o documento"
},
"niss" : {
"type" : "string",
"description" : "NISS da entidade emissora"
},
"nif" : {
"type" : "string",
"description" : "NIF da entidade emissora"
},
"amount" : {
"type" : "number",
"description" : "Montante a pagar"
},
"iban" : {
"type" : "string",
"description" : "IBAN da entidade recebedora"
},
"swift" : {
"type" : "string",
"description" : "SWIFT da entidade recebedora"
},
"entity" : {
"type" : "string",
"description" : "Entidade recebedora"
},
"paymentReference" : {
"type" : "string",
"description" : "Referência de pagamento associada ao documento de pagamento"
}
}
}
}
}
},
"files" : {
"type" : "array",
"description" : "Lista de ficheiros, cada um codificado como uma string Base64. Utilizado quando múltiplos ficheiros estão incluídos na resposta.",
"items" : {
"type" : "string"
}Best Practices
- Always log the
requestId- Include it when contacting support for faster issue resolution - Use
errorCodeorerrorNamefor programmatic error handling in your application - Reference the timestamp for correlating errors with your application logs