Document Object

The Tazapay Document API enables seamless linking of documents to various transaction types, such as checkout, escrow, payin etc using a reference ID. This feature allows for efficient document management and tracking, ensuring that any relevant document, like invoices or contracts, can be associated with the correct transaction, enhancing transparency and operational efficiency across the platform.

Object

{
    "created_at": "2023-09-13T10:22:12.711645400Z",
    "description": "This is a sample document",
    "id": "doc_ck0oql7oclf1aqlh4jdg",
    "metadata": null,
    "name": "Purchase proof",
    "object": "document",
    "reference": "esc_ck0og8noclf1aqlh4icg",
    "type": "tracking_url",
    "url": "https://drive.google.com/file/d/1q5kk5YKcCojdTYir-rONXjN7szuXE16m/view?usp=sharing"
}

Parameters

Document

FieldTypeDescription
idstringThe unique Tazapay identifier for the document.
objectstringThe type of object, which is "document".
namestringThe name of the document in case the type is others.
descriptionstringA description of the document.
urlstringThe URL where the uploaded document can be accessed.
typeenumThe type of the document [Values - goods_delivery_proof, service_delivery_proof, tracking_url, other][Values - goods_delivery_proof, service_delivery_proof, tracking_url, other]
referencestringThe Tazapay reference ID of the related object, such as a customer or transaction.
created_atstring (ISO Timestamp)The date and time when the document was uploaded (in ISO format).
metadatajsonSet of key value pairs associated with the document.