Action a Real-Time Decision

v1.0.0

Input

{
  "type": "object",
  "properties": {
    "card_authorization": {
      "type": "object",
      "description": "If the Real-Time Decision relates to a card authorization attempt, this object contains your response to the authorization.",
      "required": [
        "decision"
      ],
      "properties": {
        "decision": {
          "type": "string",
          "description": "Whether the card authorization should be approved or declined.",
          "enum": [
            "approve",
            "decline"
          ]
        }
      }
    },
    "digital_wallet_authentication": {
      "type": "object",
      "description": "If the Real-Time Decision relates to a digital wallet authentication attempt, this object contains your response to the authentication.",
      "required": [
        "result"
      ],
      "properties": {
        "result": {
          "type": "string",
          "description": "Whether your application was able to deliver the one-time passcode.",
          "enum": [
            "success",
            "failure"
          ]
        }
      }
    },
    "digital_wallet_token": {
      "type": "object",
      "description": "If the Real-Time Decision relates to a digital wallet token provisioning attempt, this object contains your response to the attempt.",
      "properties": {
        "approval": {
          "type": "object",
          "description": "If your application approves the provisioning attempt, this contains metadata about the digital wallet token that will be generated.",
          "required": [
            "card_profile_id"
          ],
          "properties": {
            "card_profile_id": {
              "type": "string",
              "description": "The identifier of the Card Profile to assign to the Digital Wallet token."
            },
            "email": {
              "type": "string",
              "description": "An email address that can be used to verify the cardholder via one-time passcode."
            },
            "phone": {
              "type": "string",
              "description": "A phone number that can be used to verify the cardholder via one-time passcode over SMS."
            }
          }
        },
        "decline": {
          "type": "object",
          "description": "If your application declines the provisioning attempt, this contains details about the decline.",
          "properties": {
            "reason": {
              "type": "string",
              "description": "Why the tokenization attempt was declined. This is for logging purposes only and is not displayed to the end-user."
            }
          }
        }
      }
    },
    "real_time_decision_id": {
      "type": "string",
      "description": "The identifier of the Real-Time Decision."
    }
  },
  "required": [
    "real_time_decision_id"
  ],
  "additionalProperties": false
}

Output

{
  "type": "object",
  "description": "Real Time Decisions are created when your application needs to take action in real-time to some event such as a card authorization. Real time decisions are currently in beta; please contact [email protected] if you're interested in trying them out!",
  "required": [
    "card_authorization",
    "category",
    "created_at",
    "digital_wallet_authentication",
    "digital_wallet_token",
    "id",
    "status",
    "timeout_at",
    "type"
  ],
  "properties": {
    "card_authorization": {
      "type": "object",
      "description": "Fields related to a card authorization.",
      "required": [
        "account_id",
        "card_id",
        "decision",
        "merchant_acceptor_id",
        "merchant_category_code",
        "merchant_city",
        "merchant_country",
        "merchant_descriptor",
        "network",
        "network_details",
        "presentment_amount",
        "presentment_currency",
        "settlement_amount",
        "settlement_currency"
      ],
      "properties": {
        "account_id": {
          "type": "string",
          "description": "The identifier of the Account the authorization will debit."
        },
        "card_id": {
          "type": "string",
          "description": "The identifier of the Card that is being authorized."
        },
        "decision": {
          "type": "string",
          "description": "Whether or not the authorization was approved.",
          "enum": [
            "approve",
            "decline"
          ]
        },
        "merchant_acceptor_id": {
          "type": "string",
          "description": "The merchant identifier (commonly abbreviated as MID) of the merchant the card is transacting with."
        },
        "merchant_category_code": {
          "type": "string",
          "description": "The Merchant Category Code (commonly abbreviated as MCC) of the merchant the card is transacting with."
        },
        "merchant_city": {
          "type": "string",
          "description": "The city the merchant resides in."
        },
        "merchant_country": {
          "type": "string",
          "description": "The country the merchant resides in."
        },
        "merchant_descriptor": {
          "type": "string",
          "description": "The merchant descriptor of the merchant the card is transacting with."
        },
        "network": {
          "type": "string",
          "description": "The payment network used to process this card authorization",
          "enum": [
            "visa"
          ]
        },
        "network_details": {
          "type": "object",
          "description": "Fields specific to the `network`",
          "required": [
            "visa"
          ],
          "properties": {
            "visa": {
              "type": "object",
              "description": "Fields specific to the `visa` network",
              "required": [
                "electronic_commerce_indicator",
                "point_of_service_entry_mode"
              ],
              "properties": {
                "electronic_commerce_indicator": {
                  "type": "string",
                  "description": "For electronic commerce transactions, this identifies the level of security used in obtaining the customer's payment credential. For mail or telephone order transactions, identifies the type of mail or telephone order.",
                  "enum": [
                    "mail_phone_order",
                    "recurring",
                    "installment",
                    "unknown_mail_phone_order",
                    "secure_electronic_commerce",
                    "non_authenticated_security_transaction_at_3ds_capable_merchant",
                    "non_authenticated_security_transaction",
                    "non_secure_transaction"
                  ]
                },
                "point_of_service_entry_mode": {
                  "type": "string",
                  "description": "The method used to enter the cardholder's primary account number and card expiration date",
                  "enum": [
                    "manual",
                    "magnetic_stripe_no_cvv",
                    "optical_code",
                    "integrated_circuit_card",
                    "contactless",
                    "credential_on_file",
                    "magnetic_stripe",
                    "contactless_magnetic_stripe",
                    "integrated_circuit_card_no_cvv"
                  ]
                }
              }
            }
          }
        },
        "presentment_amount": {
          "type": "integer",
          "description": "The amount of the attempted authorization in the currency the card user sees at the time of purchase, in the minor unit of that currency. For dollars, for example, this is cents."
        },
        "presentment_currency": {
          "type": "string",
          "description": "The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the currency the user sees at the time of purchase."
        },
        "settlement_amount": {
          "type": "integer",
          "description": "The amount of the attempted authorization in the currency it will be settled in. This currency is the same as that of the Account the card belongs to."
        },
        "settlement_currency": {
          "type": "string",
          "description": "The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the currency the transaction will be settled in."
        }
      }
    },
    "category": {
      "type": "string",
      "description": "The category of the Real-Time Decision.",
      "enum": [
        "card_authorization_requested",
        "digital_wallet_token_requested",
        "digital_wallet_authentication_requested"
      ]
    },
    "created_at": {
      "type": "string",
      "format": "date-time",
      "description": "The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which the Real-Time Decision was created."
    },
    "digital_wallet_authentication": {
      "type": "object",
      "description": "Fields related to a digital wallet authentication attempt.",
      "required": [
        "card_id",
        "channel",
        "digital_wallet",
        "email",
        "one_time_passcode",
        "phone",
        "result"
      ],
      "properties": {
        "card_id": {
          "type": "string",
          "description": "The identifier of the Card that is being tokenized."
        },
        "channel": {
          "type": "string",
          "description": "The channel to send the card user their one-time passcode.",
          "enum": [
            "sms",
            "email"
          ]
        },
        "digital_wallet": {
          "type": "string",
          "description": "The digital wallet app being used.",
          "enum": [
            "apple_pay",
            "google_pay"
          ]
        },
        "email": {
          "type": "string",
          "description": "The email to send the one-time passcode to if `channel` is equal to `email`."
        },
        "one_time_passcode": {
          "type": "string",
          "description": "The one-time passcode to send the card user."
        },
        "phone": {
          "type": "string",
          "description": "The phone number to send the one-time passcode to if `channel` is equal to `sms`."
        },
        "result": {
          "type": "string",
          "description": "Whether your application successfully delivered the one-time passcode.",
          "enum": [
            "success",
            "failure"
          ]
        }
      }
    },
    "digital_wallet_token": {
      "type": "object",
      "description": "Fields related to a digital wallet token provisioning attempt.",
      "required": [
        "card_id",
        "card_profile_id",
        "decision",
        "digital_wallet"
      ],
      "properties": {
        "card_id": {
          "type": "string",
          "description": "The identifier of the Card that is being tokenized."
        },
        "card_profile_id": {
          "type": "string",
          "description": "The identifier of the Card Profile that was set via the real time decision. This will be null until the real time decision is responded to or if the real time decision did not set a card profile."
        },
        "decision": {
          "type": "string",
          "description": "Whether or not the provisioning request was approved. This will be null until the real time decision is responded to.",
          "enum": [
            "approve",
            "decline"
          ]
        },
        "digital_wallet": {
          "type": "string",
          "description": "The digital wallet app being used.",
          "enum": [
            "apple_pay",
            "google_pay"
          ]
        }
      }
    },
    "id": {
      "type": "string",
      "description": "The Real-Time Decision identifier."
    },
    "status": {
      "type": "string",
      "description": "The status of the Real-Time Decision.",
      "enum": [
        "pending",
        "responded",
        "timed_out"
      ]
    },
    "timeout_at": {
      "type": "string",
      "format": "date-time",
      "description": "The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which your application can no longer respond to the Real-Time Decision."
    },
    "type": {
      "type": "string",
      "description": "A constant representing the object's type. For this resource it will always be `real_time_decision`.",
      "enum": [
        "real_time_decision"
      ]
    }
  }
}