Guides

🔲 Metadata

We have only the Invoice Resource that can use this attribute to attach key-value data.

❕ Capabilities

  • Up to 50 keys.
  • Keys name up tp 40 characters long.
  • values up to 500 characters.

🔗 Example

You could store your own data ERP system or human-readable description for future read.


POST https://api.bavabank.com/pix/v1/accounts/c38c7fc8-cd85-49ae-a872-0c7ca08e58ee/invoices

Content-Type: application/json
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6ImI4dzJmbWQ0T3ZfUms0YUhqNURDLSJ9.eyJpc3MiOiJodHRwczovL2JhdmEtYXV0aC1kZXZlbG9wbWVudC51cy5hdXRoMC5jb20vIiwic3ViIjoiOXFKclZCQmF0QXo0b2ZkMFpOcm9aWGZRVTJhUTJRUlpAY2xpZW50cyIsImF1ZCI6Imh0dHBzOi8vYXBpLmRldi5iYXZhYmFuay5jb20vcGl4L3YxLyIsImlhdCI6MTYyNDAzNzMxMywiZXhwIjoxNjI0MDQ1OTEzLCJhenAiOiI5cUpyVkJCYXRBejRvZmQwWk5yb1pYZlFVMmFRMlFSWiIsInNjb3BlIjoicmVhZF93cml0ZSIsImd0eSI6ImNsaWVudC1jcmVkZW50aWFscyJ9.kkE9YMhvFnVbFcL5WMDjp9H0QzOusrKRn_wKVyxxG67eC-KuS41x6RN7ZnLzzg43cBM6IJFPicHIbcfDDgmMYBl85krE7VdrF3fCweyFG-ASpdKGu6BAxqiK6E6wUyEv2bI9X0afMakBk7xd1PXjq71N8WA8NYECNDbP_2TnEnLeq19ab-NIR24tyHWPZSLP5ppiY5D4bWkQLwpKS5JoyJSnRDT5If7k6lPgGAdxJBQhcVG7bWyT4E_n_RzuLHrwuesQ_ZKaius_sxOFcyEsX1sdYD864VWVuBomqRHZ92ZjjMaJlha98k5yQT1taLE9LVnEjKcER6np2k1IHQOwfA

Body: 
{
  "expiration_time": 172800,
  "customer_document": "06277206842",
  "customer_name": "Otávio Daniel Luan Drumond",
  "original_amount": "100.50",
  "payment_label": "order payment 55448",
  "meta_data": {
    "erp_invoice_number": "80290201",
    "author": {
      "name": "Jozé Gonzalez",
      "email": "[email protected]"
    },
    "informations": ["If try paid after expires time, have to update or create another invoice."]
  }
}

See the meta_data field with more than one attribute, and object attribute. This datas can be use for your system, for example make Dashboards based on your meta_data.

👀

Rarely used by Liber Capital for application logic.

👀

Be carefull when try to update the meta_data, because will be overwrite with a new value, always.

🔏 Security

Do not storage into meta_data any information like credit number, unnecessary document or password account, any other sensitive data for obvious reasons.

Updated 4 months ago