Method: reserveFunds

{
  "userIpAddress": string,
  "shippingAddress": {
    object (Address)
  }
}

string

OPTIONAL: This is the IP address of the user's device if the purchase was made by a user in session. If the user was not in session this will empty. If the particular contract doesn't stipulate the need for this field it will always be empty.

object (Address)

OPTIONAL: This is the shipping address for a physical goods order. If the particular contract doesn't stipulate the need for this field it will always be empty.

{
  "name": string,
  "addressLine": [
    string
  ],
  "localityName": string,
  "administrativeAreaName": string,
  "postalCodeNumber": string,
  "countryCode": string
}

string

OPTIONAL: Customer's full name.

string

OPTIONAL: This holds unstructured Address text.

string

OPTIONAL: This is something of a fuzzy term, but it generally refers to the city/town portion of an address. In regions of the world where localities are not well defined or do not fit into this structure well (for example, Japan and China), leave localityName empty and use addressLine.

Examples: US city, IT comune, UK post town.

string

OPTIONAL: Top-level administrative subdivision of this country" Examples: US state, IT region, CN province, JP prefecture."

string

OPTIONAL: Despite the name, postalCodeNumber values are frequently alphanumeric. Examples: "94043", "SW1W", "SW1W 9TQ".

string

OPTIONAL: Customer address country code, expected to be ISO-3166-1 Alpha-2.

{
  "responseHeader": {
    object (ResponseHeader)
  },
  "paymentIntegratorTransactionId": string,
  "result": enum (ReserveFundsResultCode),
  "rawResult": {
    object (RawResult)
  },
  "transactionLimit": string,
  "expirationTimestamp": string,
  "installmentPlan": {
    object (InstallmentPlan)
  }
}

object (ResponseHeader)

REQUIRED: Common header for all responses.

string

REQUIRED: This identifier is specific to the integrator and is generated by the integrator. This is the identifier that the integrator knows this transaction by.

enum (ReserveFundsResultCode)

REQUIRED: Result of this funds reservation.

object (RawResult)

OPTIONAL: Raw result of this reservation. Used to help inform Google's risk engine and analytics. In decline code–mapping situations, data is sometimes lost. The integrator can choose to give Google a raw code. For example, a credit card gateway (the integrator) may use this field to communicate to Google the exact decline code that was received from the VISA network. In that case, the scope would be "visa" and the rawCode would be whatever the VISA network returned.

This value is required if the result is not SUCCESS.

string (Int64Value format)

OPTIONAL: If Result is CHARGE_EXCEEDS_TRANSACTION_LIMIT, then this is the maximum amount the user could spend on a transaction (in micros). This is used for structured, user facing messaging and decline rate analysis.

This must be a limit relative to the currencyCode on the request.

string (int64 format)

REQUIRED: The expiration timestamp for this funds reservation represented as milliseconds since epoch.

object (InstallmentPlan)

OPTIONAL: Information about the installment plan that this funds reservation is associated with.

This field is required if the funds reservation is associated with an installment or financing plan. This information may be used to calculate processor fees.

{
  "installmentPlanType": enum (InstallmentPlanType)
}

enum (InstallmentPlanType)

REQUIRED: The installment plan type.