Pagos Data Dictionary

Transaction

Data ElementData Field NameDescription
transaction_idTransaction IdentifierA unique value that identifies the transaction and will be used as the key when making updates to transactions.
order_idMerchant Order IdentifierThe merchant order reference.
payment_processor_namePayment Processor NameThe payment processor the transaction was processed through.
merchant_account_idMerchant Account IDThe merchant account used to process the transaction.
intent_categoryStored Credential CategoryThe stored credential category (e.g. CIT/MIT) of the payment method used in the transaction.
tds_version3D Secure VersionThe version of 3D Secure used on the transaction.
payment_method_typePayment Method TypeThe payment method used for the transaction (e.g. card, apple pay, paywithgoogle).
currencyTransaction CurrencyThe currency of the transaction, represented by the 3-letter ISO-4217 currency code.
channelTransaction ChannelIf provided by the processor, this denotes the source of the transaction (e.g. control panel or shopping cart provider).
amountTransaction AmountThe transaction amount, represented as a positive integer in the smallest currency unit.
common_statusTransaction StatusIf provided by processor, this is the last status of the transaction.
disputedDispute IndicatorTrue if the transaction was disputed (false if not).
refundedRefund IndicatorTrue if the transaction was refunded (false if not).
createdTransaction Creation DateThe date/time when the transaction was created.
updatedTransaction Update DateThe date/time when the transaction was updated.
customer_idCustomer IDA unique string that identifies the customer.
transaction_statementTransaction Statement DescriptorA long-form description of the transaction.
metadataTransaction MetadataA transaction-level label used to segment transactions into meaningful groups.
pagos_transaction_status_code_idPagos Transaction Status CodeA Pagos code that corresponds to the transaction status.
verificationVerification FlagA true/false flag identifying if the record is a card verification (i.e. $0 or $1 authorization).
statusTransaction StatusThe status of the transaction (e.g. authorized, cancel_or_refund, canceled, capture, deposit, failed, gateway_rejected, paid, pending, processor_declined).
intentTransaction Stored CredentialTransaction stored credential (e.g. one time, recurring, card-on-file, etc.).
tds_pagos_code3D Secure Result CodeA Pagos code that corresponds to 3D Secure result.
shopper_countryShopper CountryThe country where the customer is located, represented as a two-letter country code.
pm_card_networkCard BrandThe card brand used in the transaction (e.g. visa, mastercard, discover).
pm_card_typeCard TypeThe type of payment card used in the transaction (e.g. debit or credit).
pm_card_issuer_countryIssuing CountryThe country where the card used in the transaction was issued, represented by a two-letter country code.
pm_card_binCard BINThe first 5-8 digits of the payment card used in the transaction.
pm_card_issuer_bankIssuing Bank
Cost
The issuing bank for the payment card used in the transaction.
subcategory_nameSubcategory NameIf a fee, this is the cost subcategory of that fee (e.g. penalties, downgrades, etc.).
category_nameCost Category NameIf a fee, this is the cost category of that fee (e.g. interchange, processor, assessments).
checks_cvc_checkCVV Response CodeThe CVV response code from the processor.
checks_avs_checkAVS Response CodeThe AVS response code from the processor.
pm_issuer_regionIssuing RegionThe region where the card used in the transaction was issued.
payment_account_referencePayment AccountThe SEPA direct debit transit number of the payment method used in the transaction.
network_token_indicatorReference
Network Token Flag
Indicates if the payment method has a network token.
rrnRetrieval Reference NumberThe reference number for a dispute.

Disbursements

Data ElementData Field NameDescription
disbursement_idDisbursement IDA unique value that identifies the disbursement and will be used as the key when making updates to disbursements.
currencyDisbursement CurrencyThe currency of the disbursement.
amountDisbursement AmountThe disbursement amount, represented as a positive integer in the smallest currency unit.
statusDisbursement StatusThe status of the disbursement (e.g. paid, pending, canceled).
payment_processor_namePayment Processor NameThe payment processor the disbursement is processed through.
createdDisbursement Creation DateThe date/time when the disbursement was created.
updatedDisbursement Update DateThe date/time when the disbursement was updated.
metadataMetadataAn object-level label used to segment disbursements into meaningful groups.
merchant_account_idMerchant Account IDA unique value assigned by the acquirer or processor to identify the merchant account. This value could match the merchant account ID associated with a region or country.

Refunds

Data ElementData Field NameDescription
refund_idRefund IdentifierA unique value that identifies the refund and will be used as the key when making updates to transactions.
order_idMerchant Order IdentifierThe merchant order reference.
amountRefund AmountThe refund amount, represented as a positive integer in the smallest currency unit.
payment_processor_namePayment Processor NameThe payment processor the refund is processed through.
currencyRefund CurrencyThe currency of the refund, represented by the 3-letter ISO-4217 currency code.
statusRefund StatusThe status of the refund (e.g. success, pending, rejected).
reasonRefund ReasonThe reason for the refund.
descriptionRefund DescriptionA long-form description of the refund.
processor_response_codeProcessor Response CodeThe processor response for the refund (e.g. invalid amount, expired card, etc).
pagos_refund_statusPagos Refund StatusThe Pagos refund status code that corresponds to the refund response status.
createdRefund Creation DateThe date/time when the refund was created.
updatedRefund Update DateThe date/time when the refund was updated.
transaction_idTransaction IDThe transaction ID of the original transaction associated with the refund.
metadataMetadataAn object-level label used to segment refunds into meaningful groups.
payment_method_typePayment Method TypeThe payment method used for the refunded transaction (e.g. card, apple pay, paywithgoogle).
networkCard BrandThe card brand used in the refund (e.g. visa, mastercard, discover).
merchant_account_idMerchant Account IDA unique value assigned by the acquirer or processor to identify the merchant account. This value could match the merchant account ID associated with a region or country.

Disputes

Data ElementData Field NameDescription
dispute_idDispute IdentifierA unique value that identifies the dispute and will be used as the key when making updates to transactions.
order_idMerchant Order IdentifierThe merchant order reference.
amountDispute AmountThe dispute amount, represented as a positive integer in the smallest currency unit.
payment_processor_namePayment Processor NameThe payment processor the dispute is processed through.
pagos_dispute_statusPagos Dispute Status CodeThe Pagos chargeback status code that corresponds to the dispute response status.
pagos_dispute_reasonPagos Dispute Reason CodeThe Pagos chargeback reason code that corresponds to the dispute reason code.
amount_refundedRefunded AmountThe amount refunded to the customer, represented as a positive integer in the smallest currency unit.
currencyDispute CurrencyThe currency of the refund.
statusDispute StatusThe status of the dispute (e.g. won, lost, pending).
reason_codeDispute Reason CodeThe reason code for the dispute, which maps to a dispute reason (e.g. duplicate processing, fraud, stolen card).
reasonDispute ReasonThe reason given for the dispute (e.g. duplicate processing, fraud, stolen card).
createdDispute Creation DateThe date/time when the dispute was created.
updatedDispute Update DateThe date/time when the dispute was updated.
transaction_idTransaction IDThe transaction ID of the original transaction associated with the dispute.
metadataMetadataAn object-level label used to segment disputes into meaningful groups.
payment_method_typePayment Method TypeThe payment method used for the disputed transaction (e.g. card, apple pay, paywithgoogle).
transaction_reference_id
acquirer_reference_numberAcquirer Reference NumberThe unique value assigned by the acquiring bank and passed through to the card brand and issuer, used to link a transaction to subsequent chargebacks.

Fees and Invoices

Data ElementData Field NameDescription
fee_idFee IdentifierA unique value that identifies the fee.
settlement_currencyFee Settlement CurrencyThe settlement currency of the fee.
payment_processor_namePayment Processor NameThe payment processor the fee is processed through.
merchant_account_idMerchant Account IDA unique value assigned by the acquirer or processor to identify the merchant account. This value could match the merchant account ID associated with a region or country.
pagos_network_codePagos Card Brand CodeA Pagos code that corresponds to card brand of the payment method used.
fee_nameFee NameName of the fee (e.g. VI Misuse of Auth Fee, US Business Tier 1 CPS Product 1 [US BUS TR1 PRD 1], Account Updater).
fee_subcategoryFee SubcategoryThe fee subcategory (e.g. network, value_added_services, penalties).
fee_categoryFee CategoryThe fee category (e.g. interchange, assessment, processor).
interchange_qualificationInterchange Fee Program QualificationThe interchange fee program (e.g. CPS/Retail Debit , CPS/Card Not Present Prepaid).
fee_amountFee AmountThe fee amount, represented as a positive number in the smallest currency unit
fee_amount_typeFee Amount TypeIndicates if the fee amount is paid to the merchant (credit) or deducted from the merchant (debit).
unit_quanityUnit QuantityThe number of units the fee is applied to.
unit_feeUnit Fee PriceThe price per each fee line item, represented as a positive nubmer in the smallest currency unit.
unit_volumeUnit VolumeThe amount (decimal) of the unit.
percent_rateUnit Fee RateThe percentage rate applied to the unit amount for the fee.
pagos_fee_namePagos Fee NameThe Pagos fee name that corresponds to the fee.
pagos_payment_methodPagos Payment MethodThe Pagos payment method code that corresponds to the payment method type.
pagos_networkPagos NetworkThe Pagos code that corresponds to the card brand of the payment method.
createdFee Creation DateThe date when the fee was created