--- updatedAt: 2025-12-17T15:17:42.000Z agentTools: projectIndex: https://developers.privacy.com/llms.txt --- # List transactions List transactions. # OpenAPI definition ```json { "openapi": "3.0.0", "info": { "title": "Privacy Developer API", "description": "The Privacy Developer API is designed to provide a predictable programmatic interface for accessing your Privacy account through an API and transaction webhooks.\nNote that your API key is a secret and should be treated as such. Don't share it with anyone, including us. We will never ask you for it.\n", "version": "1.0.0", "termsOfService": "https://privacy.com/legal#terms", "contact": { "email": "support@privacy.com" } }, "servers": [ { "url": "https://api.privacy.com/v1", "description": "Privacy production API server" }, { "url": "https://sandbox.privacy.com/v1", "description": "Sandbox environment that provides all the functionality of production" } ], "paths": { "/transactions": { "get": { "tags": [ "Transaction" ], "summary": "List transactions", "description": "List transactions.", "parameters": [ { "in": "query", "name": "account_token", "schema": { "type": "string", "format": "uuid" }, "description": "Only required for multi-account users. Returns transactions associated with this account. Only applicable if using account enrollment. See [Managing Accounts](https://docs.privacy.com/docs/managing-accounts) for more information.\n" }, { "in": "query", "name": "card_token", "schema": { "type": "string", "format": "uuid" }, "description": "Filters transactions associated with a specific card." }, { "in": "query", "name": "result", "schema": { "type": "string", "enum": [ "APPROVED", "DECLINED" ] }, "description": "List specific transactions. Filters include `APPROVED`, and `DECLINED`." }, { "$ref": "#/components/parameters/beginTime" }, { "$ref": "#/components/parameters/endTime" }, { "$ref": "#/components/parameters/page" }, { "$ref": "#/components/parameters/pageSize" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/Transaction" } }, "page": { "type": "integer", "description": "Page of the result." }, "total_entries": { "type": "integer", "description": "Number of matched rows." }, "total_pages": { "type": "integer", "description": "Total pages of result." } } }, "example": { "data": [ { "amount": -7666, "cardholder_authentication": { "verification_attempted": "NONE", "verification_result": "NOT_ATTEMPTED", "liability_shift": "NONE", "3ds_version": null, "acquirer_exemption": "NONE" }, "card": { "created": "2020-07-15T17:48:48Z", "cvv": "574", "exp_month": "07", "exp_year": "2026", "funding": { "account_name": "Sandbox", "created": "2020-07-08 17:57:36", "last_four": "5263", "nickname": "", "state": "ENABLED", "token": "b0f0d91a-3697-46d8-85f3-20f0a585cbea", "type": "DEPOSITORY_CHECKING" }, "hostname": "", "last_four": "6749", "memo": "card 2", "pan": "4111111171826749", "spend_limit": 0, "spend_limit_duration": "TRANSACTION", "state": "OPEN", "token": "079d1898-65f7-4d66-b0bc-172d2935a5fa", "type": "UNLOCKED" }, "created": "2020-07-15T19:17:22Z", "events": [ { "amount": 7666, "created": "2020-07-15T19:17:22Z", "result": "APPROVED", "token": "6a885bcb-89f6-4fcb-a0ce-7f0233ae20a0", "type": "RETURN" } ], "funding": [ { "amount": -7666, "token": "b0f0d91a-3697-46d8-85f3-20f0a585cbea", "type": "DEPOSITORY_CHECKING" } ], "merchant": { "acceptor_id": "174030075991", "city": "NEW YORK", "country": "USA", "descriptor": "Sample Return", "mcc": "5812", "state": "NY" }, "result": "APPROVED", "settled_amount": -7666, "status": "SETTLING", "token": "9b4c99b1-2e90-4e24-b54b-90dc8af4695b" } ], "page": 1, "total_entries": 1, "total_pages": 1 } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "404": { "$ref": "#/components/responses/NotFound" }, "429": { "$ref": "#/components/responses/TooManyRequests" } } } } }, "components": { "parameters": { "beginTime": { "in": "query", "name": "begin", "description": "Date string in 8601 format. Only entries created after the specified date will be included. UTC time zone.", "schema": { "type": "string", "format": "date-time" } }, "endTime": { "in": "query", "name": "end", "description": "Date string in 8601 format. Only entries created before the specified date will be included. UTC time zone.", "schema": { "type": "string", "format": "date-time" } }, "page": { "in": "query", "name": "page", "description": "Page (for pagination).", "schema": { "type": "integer", "default": 1 } }, "pageSize": { "in": "query", "name": "page_size", "description": "Page size (for pagination).", "schema": { "type": "integer", "default": 50, "minimum": 1, "maximum": 100 } } }, "responses": { "BadRequest": { "description": "A parameter in the query given in the request does not match the valid queries for the endpoint.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "NotFound": { "description": "The specified resource was not found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "TooManyRequests": { "description": "Client has exceeded the number of allowed requests in a given time period.\n\n| | |\n|---|---|\n| Rate limited, too many requests per second | User has exceeded their per second rate limit |\n| Rate limited, reached daily limit | User has exceeded their daily rate limit |\n| Rate limited, too many keys tried | One IP has queried too many different API keys |\n", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "Unauthorized": { "description": "| | |\n|---|---|\n| User has not been authenticated | Invalid or missing API key |\n| API key is not active | The API key used is no longer active |\n| Could not find API key | The API key provided is not associated with any user |\n| Please provide API key in Authorization header | The Authorization header is not in the request |\n| Please provide API key in the form Authorization: api-key [api-key] | The Authorization header is not formatted properly |\n| Insufficient privileges. Issuing API key required | Write access requires an Issuing API key. Please contact [api@privacy.com](mailto:api@privacy.com) |\n| Insufficient privileges to create unlocked cards. | Creating unlocked cards requires an additional privilege | Please contact [api@privacy.com](mailto:api@privacy.com) |\n", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "schemas": { "CardholderAuthentication": { "type": "object", "nullable": true, "properties": { "3ds_version": { "type": "string", "nullable": true, "description": "3-D Secure Protocol version. Possible values:\n* `1`: 3-D Secure Protocol version 1.x applied to the transaction.\n* `2`: 3-D Secure Protocol version 2.x applied to the transaction.\n* `null`: 3-D Secure was not used for the transaction\n" }, "acquirer_exemption": { "type": "string", "enum": [ "AUTHENTICATION_OUTAGE_EXCEPTION", "LOW_VALUE", "MERCHANT_INITIATED_TRANSACTION", "NONE", "RECURRING_PAYMENT", "SECURE_CORPORATE_PAYMENT", "STRONG_CUSTOMER_AUTHENTICATION_DELEGATION", "TRANSACTION_RISK_ANALYSIS" ], "description": "Exemption applied by the ACS to authenticate the transaction without requesting a challenge. Possible values:\n* `AUTHENTICATION_OUTAGE_EXCEPTION`: Authentication Outage Exception exemption.\n* `LOW_VALUE`: Low Value Payment exemption.\n* `MERCHANT_INITIATED_TRANSACTION`: Merchant Initiated Transaction (3RI).\n* `NONE`: No exemption applied.\n* `RECURRING_PAYMENT`: Recurring Payment exemption.\n* `SECURE_CORPORATE_PAYMENT`: Secure Corporate Payment exemption.\n* `STRONG_CUSTOMER_AUTHENTICATION_DELEGATION`: Strong Customer Authentication Delegation exemption.\n* `TRANSACTION_RISK_ANALYSIS`: Acquirer Low-Fraud and Transaction Risk Analysis exemption.\n\nMaps to the 3-D Secure `transChallengeExemption` field.\n" }, "liability_shift": { "type": "string", "enum": [ "3DS_AUTHENTICATED", "ACQUIRER_EXEMPTION", "NONE", "TOKEN_AUTHENTICATED" ], "description": "Indicates whether chargeback liability shift applies to the transaction. Possible values:\n* `3DS_AUTHENTICATED`: The transaction was fully authenticated through a 3-D Secure flow, chargeback liability shift applies.\n* `ACQUIRER_EXEMPTION`: The acquirer utilised an exemption to bypass Strong Customer Authentication (`transStatus = N`, or `transStatus = I`). Liability remains with the acquirer and in this case the `acquirer_exemption` field is expected to be not `NONE`.\n* `NONE`: Chargeback liability shift has not shifted to the issuer, i.e. the merchant is liable.\n* `TOKEN_AUTHENTICATED`: The transaction was a tokenized payment with validated cryptography, possibly recurring. Chargeback liability shift to the issuer applies.\n" }, "verification_attempted": { "type": "string", "enum": [ "APP_LOGIN", "BIOMETRIC", "NONE", "OTHER", "OTP" ], "description": "Verification attempted values:\n* `APP_LOGIN`: Out-of-band login verification was attempted by the ACS.\n* `BIOMETRIC`: Out-of-band biometric verification was attempted by the ACS.\n* `NONE`: No cardholder verification was attempted by the Access Control Server (e.g. frictionless 3-D Secure flow, no 3-D Secure, or stand-in Risk Based Analysis).\n* `OTHER`: Other method was used by the ACS to verify the cardholder (e.g. Mastercard Identity Check Express, recurring transactions, etc.)\n* `OTP`: One-time password verification was attempted by the ACS.\n" }, "verification_result": { "type": "string", "enum": [ "CANCELLED", "FAILED", "FRICTIONLESS", "NOT_ATTEMPTED", "REJECTED", "SUCCESS" ], "description": "This field partially maps to the `transStatus` field in the [EMVCo 3-D Secure specification](https://www.emvco.com/emv-technologies/3d-secure/) and Mastercard SPA2 AAV leading indicators.\n\nVerification result values:\n* `CANCELLED`: Authentication/Account verification could not be performed, `transStatus = U`.\n* `FAILED`: Transaction was not authenticated. `transStatus = N`, note: the utilization of exemptions could also result in `transStatus = N`, inspect the `acquirer_exemption` field for more information.\n* `FRICTIONLESS`: Attempts processing performed, the transaction was not authenticated, but a proof of attempted authentication/verification is provided. `transStatus = A` and the leading AAV indicator was one of {`kE`, `kF`, `kQ`}.\n* `NOT_ATTEMPTED`: A 3-D Secure flow was not applied to this transaction. Leading AAV indicator was one of {`kN`, `kX`} or no AAV was provided for the transaction.\n* `REJECTED`: Authentication/Account Verification rejected; `transStatus = R`. Issuer is rejecting authentication/verification and requests that authorization not be attempted.\n* `SUCCESS`: Authentication verification successful. `transStatus = Y` and leading AAV indicator for the transaction was one of {`kA`, `kB`, `kC`, `kD`, `kO`, `kP`, `kR`, `kS`}.\n\nNote that the following `transStatus` values are not represented by this field:\n* `C`: Challenge Required\n* `D`: Challenge Required; decoupled authentication confirmed\n* `I`: Informational only\n* `S`: Challenge using Secure Payment Confirmation (SPC)\n" } }, "required": [ "3ds_version", "acquirer_exemption", "liability_shift", "verification_attempted", "verification_result" ] }, "Card": { "type": "object", "required": [ "created", "funding", "last_four", "spend_limit", "spend_limit_duration", "state", "token", "type" ], "properties": { "created": { "type": "string", "format": "date-time", "description": "An ISO 8601 timestamp for when the card was created. UTC time zone.", "example": "2021-06-28T22:53:15Z" }, "cvv": { "type": "string", "minLength": 3, "maxLength": 3, "description": "Three digit cvv printed on the back of the card.", "example": "776", "x-privacy-tag": "Enterprise" }, "funding": { "$ref": "#/components/schemas/FundingAccount" }, "exp_month": { "type": "string", "description": "Two digit (MM) expiry month.", "minLength": 2, "maxLength": 2, "example": "06", "x-privacy-tag": "Enterprise" }, "exp_year": { "type": "string", "description": "Four digit (yyyy) expiry year.", "minLength": 4, "maxLength": 4, "example": "2027", "x-privacy-tag": "Enterprise" }, "hostname": { "type": "string", "description": "Hostname of card’s locked merchant (will be empty if not applicable)." }, "last_four": { "type": "string", "description": "Last four digits of the card number.", "minLength": 4, "maxLength": 4 }, "memo": { "type": "string", "description": "Friendly name to identify the card.", "example": "New Card" }, "pan": { "type": "string", "description": "Primary Account Number (PAN) (i.e. the card number). Customers must be PCI compliant to have PAN returned as a field in production. Please contact [support@privacy.com](mailto:support@privacy.com) for questions.\n", "minLength": 16, "maxLength": 16, "example": "4111111289144142", "x-privacy-tag": "Enterprise" }, "spend_limit": { "type": "integer", "description": "Amount (in cents) to limit approved authorizations. Transaction requests above the spend limit will be declined.", "example": 1000 }, "spend_limit_duration": { "type": "string", "enum": [ "ANNUALLY", "FOREVER", "MONTHLY", "TRANSACTION" ], "description": "Spend limit duration values:\n* `ANNUALLY` - Card will authorize transactions up to spend limit in a calendar year.\n* `FOREVER` - Card will authorize only up to spend limit for the entire lifetime of the card.\n* `MONTHLY` - Card will authorize transactions up to spend limit for the trailing month. Month is calculated as this calendar date one month prior.\n* `TRANSACTION` - Card will authorizate multiple transactions if each individual transaction is under the spend limit.\n" }, "state": { "type": "string", "enum": [ "CLOSED", "OPEN", "PAUSED", "PENDING_ACTIVATION", "PENDING_FULFILLMENT" ], "description": "Card state values:\n* `CLOSED` - Card will no longer approve authorizations. Closing a card cannot be undone.\n* `OPEN` - Card will approve authorizations (if they match card and account parameters).\n* `PAUSED` - Card will decline authorizations, but can be resumed at a later time.\n* `PENDING_FULFILLMENT` - The initial state for cards of type `PHYSICAL`. The card is provisioned pending manufacturing and fulfillment. Cards in this state can accept authorizations for e-commerce purchases, but not for \"Card Present\" purchases where the physical card itself is present.\n* `PENDING_ACTIVATION` - Each business day at 2pm Eastern Time Zone (ET), cards of type `PHYSICAL` in state `PENDING_FULFILLMENT` are sent to the card production warehouse and updated to state `PENDING_ACTIVATION` . Similar to `PENDING_FULFILLMENT`, cards in this state can be used for e-commerce transactions. API clients should update the card's state to `OPEN` only after the cardholder confirms receipt of the card.\n\nIn sandbox, the same daily batch fulfillment occurs, but no cards are actually manufactured.\n" }, "auth_rule_tokens": { "type": "array", "items": { "type": "string" }, "description": "List of identifiers for the Auth Rule(s) that are applied on the card.\n", "example": [ "b68b7424-aa69-4cbc-a946-30d90181b621" ] }, "token": { "type": "string", "format": "uuid", "description": "Globally unique identifier.", "example": "7ef7d65c-9023-4da3-b113-3b8583fd7951" }, "type": { "type": "string", "enum": [ "DIGITAL_WALLET", "MERCHANT_LOCKED", "PHYSICAL", "SINGLE_USE", "UNLOCKED" ], "description": "Card types:\n* `DIGITAL_WALLET` - Cards that can be provisioned to a digital wallet like Google Pay or Apple Wallet.\n* `MERCHANT_LOCKED` - Card is locked to first merchant that successfully authorizes the card.\n* `PHYSICAL` - Manufactured and sent to the cardholder. We offer white label branding, credit, ATM, PIN debit, chip/EMV, NFC and magstripe functionality. Contact [api@privacy.com](mailto:api@privacy.com) for more information.\n* `SINGLE_USE` - Card will close shortly after the first transaction.\n* `UNLOCKED` - Card will authorize at any merchant. Creating these cards requires additional privileges.\n" } } }, "Error": { "type": "object", "properties": { "message": { "type": "string", "description": "Explanation of error response." }, "debugging_request_id": { "type": "string", "format": "uuid", "description": "Identifier to help debug an error." } }, "required": [ "message", "debugging_request_id" ] }, "Event": { "type": "object", "description": "A single card transaction may include multiple events that affect the transaction state and lifecycle.", "required": [ "amount", "created", "result", "token", "type" ], "properties": { "amount": { "type": "integer", "description": "Amount (in cents) of the transaction event.", "example": 2795 }, "created": { "type": "string", "format": "date-time", "description": "ISO 8601 date and time this event entered the system. UTC time zone.", "example": "2018-05-29 21:16:05" }, "result": { "type": "string", "enum": [ "ACCOUNT_STATE_TRANSACTION", "APPROVED", "BANK_CONNECTION_ERROR", "BANK_NOT_VERIFIED", "CARD_CLOSED", "CARD_PAUSED", "FRAUD_ADVICE", "GLOBAL_TRANSACTION_LIMIT", "GLOBAL_WEEKLY_LIMIT", "GLOBAL_MONTHLY_LIMIT", "INACTIVE_ACCOUNT", "INCORRECT_PIN", "INVALID_CARD_DETAILS", "INSUFFICIENT_FUNDS", "MERCHANT_BLACKLIST", "SINGLE_USE_RECHARGED", "SWITCH_INOPERATIVE_ADVICE", "UNAUTHORIZED_MERCHANT", "UNKNOWN_HOST_TIMEOUT", "USER_TRANSACTION_LIMIT" ], "description": "`APPROVED` or decline reason.\n\nResult types:\n* `ACCOUNT_STATE_TRANSACTION_FAIL` - Contact [support@privacy.com](mailto:support@privacy.com).\n* `APPROVED` - Transaction is approved.\n* `BANK_CONNECTION_ERROR` - Please reconnect a funding source.\n* `BANK_NOT_VERIFIED` - Please confirm the funding source.\n* `CARD_CLOSED` - Card state was closed at the time of authorization.\n* `CARD_PAUSED` - Card state was paused at the time of authorization.\n* `FRAUD_ADVICE` - Transaction declined due to risk.\n* `GLOBAL_TRANSACTION_LIMIT` - Platform spend limit exceeded, contact [support@privacy.com](mailto:support@privacy.com).\n* `GLOBAL_WEEKLY_LIMIT` - Platform spend limit exceeded, contact [support@privacy.com](mailto:support@privacy.com).\n* `GLOBAL_MONTHLY_LIMIT` - Platform spend limit exceeded, contact [support@privacy.com](mailto:support@privacy.com).\n* `INACTIVE_ACCOUNT` - Account is inactive. Contact [support@privacy.com](mailto:support@privacy.com).\n* `INCORRECT_PIN` - PIN verification failed.\n* `INVALID_CARD_DETAILS` - Incorrect CVV or expiry date.\n* `INSUFFICIENT_FUNDS` - Please ensure the funding source is connected and up to date.\n* `MERCHANT_BLACKLIST` - This merchant is disallowed on the platform.\n* `SINGLE_USE_RECHARGED` - Single use card attempted multiple times.\n* `SWITCH_INOPERATIVE_ADVICE` - Network error, re-attempt the transaction.\n* `UNAUTHORIZED_MERCHANT` - Merchant locked card attempted at different merchant.\n* `UNKNOWN_HOST_TIMEOUT` - Network error, re-attempt the transaction.\n* `USER_TRANSACTION_LIMIT` - User-set spend limit exceeded.\n" }, "token": { "type": "string", "format": "uuid", "description": "Globally unique identifier." }, "type": { "type": "string", "enum": [ "AUTHORIZATION", "AUTHORIZATION_ADVICE", "CLEARING", "RETURN", "VOID", "TRANSACTION_CORRECTION_DEBIT", "TRANSACTION_CORRECTION_CREDIT" ], "description": "Event types:\n* `AUTHORIZATION` - Authorize a transaction.\n* `AUTHORIZATION_ADVICE` - Advice on a transaction.\n* `CLEARING` - Transaction is settled.\n* `RETURN` - A return authorization.\n* `VOID` - Transaction is voided.\n* `TRANSACTION_CORRECTION_DEBIT` - Manual transaction correction (Debit).\n* `TRANSACTION_CORRECTION_CREDIT` - Manual transaction correction (Credit).\n" } } }, "FundingAccount": { "type": "object", "required": [ "created", "last_four", "state", "token", "type" ], "properties": { "account_name": { "type": "string", "description": "Account name identifying the funding source. This may be `null`." }, "created": { "type": "string", "format": "date-time", "description": "An ISO 8601 string representing when this funding source was added to the Privacy account. This may be `null`. UTC time zone." }, "last_four": { "type": "string", "description": "The last 4 digits of the account (e.g. bank account, debit card) associated with this FundingAccount. This may be null.", "minLength": 4, "maxLength": 4 }, "nickname": { "type": "string", "description": "The nickname given to the `FundingAccount` or `null` if it has no nickname.", "minLength": 1, "maxLength": 255 }, "state": { "type": "string", "enum": [ "ENABLED", "PENDING" ], "description": "State of funding source.\n\nFunding source states:\n* `ENABLED` - The funding account is available to use for card creation and transactions.\n* `PENDING` - The funding account is still being verified e.g. bank micro-deposits verification.\n" }, "token": { "type": "string", "format": "uuid", "description": "A globally unique identifier for this FundingAccount." }, "type": { "type": "string", "enum": [ "DEPOSITORY_CHECKING", "DEPOSITORY_SAVINGS" ], "description": "Types of funding source:\n* `DEPOSITORY_CHECKING` - Bank checking account.\n* `DEPOSITORY_SAVINGS` - Bank savings account.\n" } } }, "Merchant": { "type": "object", "properties": { "acceptor_id": { "type": "string", "description": "Unique identifier to identify the payment card acceptor.", "example": "72600003" }, "city": { "type": "string", "description": "City of card acceptor.", "example": "NEW YORK", "minLength": 1, "maxLength": 255 }, "country": { "type": "string", "minLength": 3, "maxLength": 3, "description": "Uppercase country of card acceptor (see ISO 8583 specs).", "example": "USA" }, "descriptor": { "type": "string", "description": "Short description of card acceptor.", "example": "COFFEE SHOP" }, "mcc": { "type": "string", "description": "Merchant category code (MCC). A four-digit number listed in ISO 18245. An MCC is used to classify a business by the types of goods or services it provides.\n", "minLength": 4, "maxLength": 4, "example": "5812" }, "state": { "type": "string", "description": "Geographic state of card acceptor (see ISO 8583 specs).", "minLength": 2, "maxLength": 2, "example": "NY" } } }, "Transaction": { "type": "object", "properties": { "acquirer_reference_number": { "type": "string", "minLength": 23, "maxLength": 23, "nullable": true, "description": "A fixed-width 23-digit numeric identifier for the Transaction that may be set if the transaction originated from the Mastercard network. This number may be used for dispute tracking.\n" }, "amount": { "type": "integer", "description": "Authorization amount (in USD cents) of the transaction. This may change over time, and will represent the settled amount once the transaction is settled." }, "authorization_amount": { "type": "integer", "description": "Authorization amount (in USD cents) of the transaction. This amount always represents the amount authorized for the transaction, unaffected by settlement." }, "cardholder_authentication": { "$ref": "#/components/schemas/CardholderAuthentication" }, "merchant_amount": { "type": "integer", "description": "Analogous to the \"amount\" property, but represents the amount in the local currency at the time of the transaction." }, "merchant_authorization_amount": { "type": "integer", "description": "Analogous to the \"authorization_amount\" property, but represents the amount in the local currency at the time of the transaction." }, "merchant_currency": { "type": "string", "description": "3-digit alphabetic ISO 4217 code for the local currency of the transaction." }, "authorization_code": { "type": "string", "minLength": 6, "maxLength": 6, "description": "A fixed-width 6-digit numeric identifier that can be used to identify a transaction with networks." }, "card": { "$ref": "#/components/schemas/Card" }, "created": { "type": "string", "format": "date-time", "description": "Date and time when the transaction first occurred. UTC time zone." }, "events": { "type": "array", "items": { "$ref": "#/components/schemas/Event" }, "description": "A list of all events that have modified this transaction." }, "funding": { "type": "object", "description": "A list of objects that describe how this transaction was funded, with the `amount` represented in cents. A reference to the funding account for the `card` that made this transaction may appear here and the `token` will match the `token` for the funding account in the `card` field. If any promotional credit was used in paying for this transaction, its `type` will be `PROMO`.\n", "properties": { "amount": { "type": "integer", "description": "Funding amount (in cents)." }, "token": { "type": "string", "description": "Funding account token." }, "type": { "type": "string", "enum": [ "PROMO" ], "description": "Types of funding:\n* `PROMO` - Any promotional credit was used in paying for this transaction.\n" } } }, "merchant": { "$ref": "#/components/schemas/Merchant" }, "network": { "type": "string", "description": "Card network of the authorization. Can be `INTERLINK`, `MAESTRO`, `MASTERCARD`, `VISA`, or `UNKNOWN`. Value is `UNKNOWN` when Privacy cannot determine the network code from the upstream provider.\n", "enum": [ "INTERLINK", "MAESTRO", "MASTERCARD", "VISA", "UNKNOWN", null ] }, "result": { "type": "string", "enum": [ "ACCOUNT_STATE_TRANSACTION", "APPROVED", "BANK_CONNECTION_ERROR", "BANK_NOT_VERIFIED", "CARD_CLOSED", "CARD_PAUSED", "FRAUD_ADVICE", "GLOBAL_TRANSACTION_LIMIT", "GLOBAL_WEEKLY_LIMIT", "GLOBAL_MONTHLY_LIMIT", "INACTIVE_ACCOUNT", "INCORRECT_PIN", "INVALID_CARD_DETAILS", "INSUFFICIENT_FUNDS", "MERCHANT_BLACKLIST", "SINGLE_USE_RECHARGED", "SWITCH_INOPERATIVE_ADVICE", "UNAUTHORIZED_MERCHANT", "UNKNOWN_HOST_TIMEOUT", "USER_TRANSACTION_LIMIT" ], "description": "`APPROVED` or decline reason. See Event result types\n" }, "settled_amount": { "type": "integer", "description": "Amount (in cents) of the transaction that has been settled. This may change over time.", "example": 100 }, "status": { "type": "string", "enum": [ "BOUNCED", "DECLINED", "PENDING", "SETTLED", "SETTLING", "VOIDED" ], "description": "Status types:\n* `BOUNCED` - There was an error settling the transaction against the funding source. Your API account may be disabled.\n* `DECLINED` - The transaction was declined.\n* `PENDING` - Authorization is pending completion from the merchant.\n* `SETTLED` - The transaction is complete.\n* `SETTLING` - The merchant has completed the transaction and the funding source is being debited.\n* `VOIDED` - The merchant has voided the previously pending authorization.\n" }, "token": { "type": "string", "format": "uuid", "description": "Globally unique identifier." } } } }, "securitySchemes": { "BearerAuth": { "type": "apiKey", "in": "header", "description": "Prefix your API key with `api-key`.", "name": "Authorization" } } }, "security": [ { "BearerAuth": [] } ], "x-readme": { "explorer-enabled": true, "proxy-enabled": true } } ```