Authorization
header in the following format:
{account_id}
/transactions/enrichment to enrich transactions from one of the data connections you import data into Pagos fromProperty | Variable Type | Description | Example |
---|---|---|---|
transaction_id | string | The unique transaction identifier as provided by your PSP; max 255 characters | ”SQK3T3B6SRZSRYV5” |
order_id | string | The order reference identifier you generated (see note below); max 255 characters | ”5671790218” |
metadata | object | A transaction-level label used to segment transactions into meaningful groups | See Metadata section below |
transaction_id
- The transaction reference your PSP provided to you when processing the transaction. This is the most accurate way to identify a transaction for enrichment, as Pagos also uses this as the key reference for an order. In this case please note the appropriate field to specify this value so that we can find the correct record for a metadata update.order_id
- The transaction identifier generated in your own system. Keep in mind, if multiple transactions are identified with the order_id, all matching transactions will be enriched.metadata
object. This object allows you to add any valid key-value pair or JSON object to provide extra information about the event. The metadata object is a flexible structure that can contain any valid key-value pairs. This can include additional information such as retry attempts, custom keys, and other relevant data.
HTTP Response Code | Description |
---|---|
201 (created) | Enrichment record processed and saved in enrichment queue successfully |
400 (bad request) | No transaction identifier provided; please populate order_id and/or transaction_id |
401 (unauthorized) | Authorization failed. Possible reasons include invalid API key or API key from another environment |