Last updated 13 minutes ago

Glossary of Fields (alphabetical)

acquirerName: Info representing the acquiring bank for the Gateway Account used in the transaction.

amount: The amount of the transaction represented in major units.

baseAmount: The amount of the original transaction represented in major units (prior to any currency conversions).

baseCurrency: The amount of the original transaction's currency, prior to any currency conversion.

billingAddress/address: The billing street address.

billingAddress/address2: The second-line of the billing street address.

billingAddress/city: The city of the billing address.

billingAddress/country: The country of the billing address.

billingAddress/email: The email address of the customer (may be anonymized).

billingAddress/firstName: The first name of the customer.

billingAddress/lastName: The last name of the customer.

billingAddress/organization: The organization, if any, of the customer (for example, customer's are sometimes businesses, or other entities).

billingAddress/phoneNumber: The phone number of the customer.

billingAddress/postalCode: The billing postal code.

billingAddress/region: The billing region, sometimes known as state, province, territory, parish, etc...

bin: The first 6 digits of the payment card, if a payment card was used.

createdTime: The time the transaction was created in our system.

currency: The ISO-4127 currency code (eg USD).

customerId: The identifier of the Customer.

dccUsdMarkup: The dynamic currency conversion markup converted to USD.

description: A description of the transaction, as supplied upon the order.

gatewayAccountId: The identifier representing the GatewayAccount.

gatewayName: The name of the gateway associated with the gatewayAccountId (eg, Payvision).

gatewayResponseCode: The response code from Rebilly (likely to change based on the Visa action codes, eg 05).

gatewayResponseMessage: The response message from Rebilly (eg. Do not honor).

gatewayResponseOriginalMessage: The response message from the gateway, not mapped or translated by Rebilly (eg. Do not honour).

gatewayTransactionId: The id given to the transaction by the gateway. Many times they assign their own id. It may be useful for reference.

hadDiscrepancy: Indicates if the transaction had a discrepancy (true in that case).

has3ds: Indicates if the transaction was a 3D Secure transaction.

hasDcc: Indicates if a DCC offer was made on the transaction.

id: The identifier of the transaction.

invoiceIds: An array of invoice id's related to the transaction, if any.

isDisputed: True, if the transaction has been subsequently disputed (aka charged back). (Note: only when the data is collected by Rebilly.)

isRebill: Indicates if the transaction is a recurring type.

isReconciled: True if we've been able to confirm the result by subsequent queries against the gateway's reporting data.

isRetry: True if this is a retry of another "original" transaction.

method: Value depends on the payment method used, and may be payment-card, or other values as can be seen in the method dropdown in the Rebilly Gateway Accounts forms.

organizationId: The id of the organization associated with the gateway account used for the transaction.

parentTransactionId: The id of the parent transaction, if any (eg, the parent of a void is an auth, the parent of a refund is a sale...).

paymentCardId: Rebilly's id of the payment card used for the transaction.

processedTime: The time the transaction finished processing. In the case of an offsite transaction, or a scheduled transaction, may be significantly later than the createdTime. Otherwise, typically quite close to the createdTime.

rebillNumber: The cycle number of the recurring "rebill" transaction.

result: One of approved, declined, unknown, canceled, abandoned.

retriedTransactionId: If this transaction was a retry, this is the transaction it retried.

retriesResult: If there are more retries, the current or eventual conclusion of the retry sequence.

retryNumber: The number within the retry sequence.

riskMetadata/accuracyRadius: The accuracy of the lat/lon location from the geo-ip data.

riskMetadata/city: The city based on geo-ip data.

riskMetadata/country: The country based on the geo-ip data.

riskMetadata/distance: The distance between the billing address and the geo ip location, in kilometers.

riskMetadata/fingerprint: The device fingerprint, if any.

riskMetadata/ipAddress: The ip address associated with the transaction.

riskMetadata/isHosting: If the ip address is associated with a hosting company.

riskMetadata/isp: The ISP associated with the ip address.

riskMetadata/isProxy: If the customer used a proxy (requires extra risk metadata subscription).

riskMetadata/isTor: If the customer used TOR (requires extra risk metadata subscription).

riskMetadata/isVpn: If the customer used a VPN (requires extra risk metadata subscription).

riskMetadata/latitude: The associated geo-ip latitude.

riskMetadata/longitude: The associated geo-ip longitude.

riskMetadata/postalCode: The associated geo-ip postal code.

riskMetadata/score: The calculated risk score, as calculated according to rules configurations.

riskMetadata/timeZone: The timezone for the ip address.

riskMetadata/vpnServiceName: The name of the VPN service used, if any.

riskScore: The risk score, as calculated according to the rules configurations.

scheduledTime: The time the transaction was scheduled for, if any.

status: The status of the transaction, likely completed.

subscriptionId: The id of an associated subscription, which resulted in this transaction.

type: The type of transaction: auth, void, capture, sale, refund, credit.

updatedTime: The time the transaction data was most recently updated, including when it was reconciled.

velocity: How many transactions this customer placed within the past 24 hours.

websiteId: The website id associated to the transaction.

websiteName: The name of the website associated to the transaction.