Zillow BLS Exchange

Banking and lending services API

bls.zillow.com ↗
Version
4.3
OpenAPI
3.0.1
Endpoints
22
Schemas
71
68
Quality
Updated
3 days ago
Finance finance banking lending
Use this API in your AI agent

Query structured spec data via REST or MCP. Get exactly what your agent needs.

Get API Key

Server URLs

https://sandbox-pgw.2c2p.com

Endpoints

Applepay 1 endpoints

POST /payment/4.3/applepay/merchantvalidation
operationId: ApplePay_validateMerchant

Request Body

text/json
schema MerchantValidationApplePay
Property Type Required
locale string optional
clientID string optional
paymentToken string required
validationUrl string optional
browserDetails object optional
os string optional
name string optional
version string optional
deviceType string optional
application/json
schema MerchantValidationApplePay
Property Type Required
locale string optional
clientID string optional
paymentToken string required
validationUrl string optional
browserDetails object optional
os string optional
name string optional
version string optional
deviceType string optional
application/*+json
schema MerchantValidationApplePay
Property Type Required
locale string optional
clientID string optional
paymentToken string required
validationUrl string optional
browserDetails object optional
os string optional
name string optional
version string optional
deviceType string optional
application/json-patch+json
schema MerchantValidationApplePay
Property Type Required
locale string optional
clientID string optional
paymentToken string required
validationUrl string optional
browserDetails object optional
os string optional
name string optional
version string optional
deviceType string optional

Responses

200

Success

POST /payment/4.3/applepay/merchantvalidation

Cache 1 endpoints

POST /payment/4.3/cache/cleancache
operationId: Cache_cleanCache

Responses

200

Success

POST /payment/4.3/cache/cleancache

Canceltransaction 1 endpoints

POST /payment/4.3/canceltransaction
operationId: CancelTransaction_post

Request Body

text/json
schema PaymentBaseRequest
Property Type Required
locale string optional
clientID string optional
paymentToken string required
browserDetails object optional
os string optional
name string optional
version string optional
deviceType string optional
application/json
schema PaymentBaseRequest
Property Type Required
locale string optional
clientID string optional
paymentToken string required
browserDetails object optional
os string optional
name string optional
version string optional
deviceType string optional
application/*+json
schema PaymentBaseRequest
Property Type Required
locale string optional
clientID string optional
paymentToken string required
browserDetails object optional
os string optional
name string optional
version string optional
deviceType string optional
application/json-patch+json
schema PaymentBaseRequest
Property Type Required
locale string optional
clientID string optional
paymentToken string required
browserDetails object optional
os string optional
name string optional
version string optional
deviceType string optional

Responses

200

Success

POST /payment/4.3/canceltransaction

Cardinstallmentplaninfo 1 endpoints

POST /payment/4.3/cardinstallmentplaninfo
operationId: CardInstallmentPlanInfo_create

Request Body

text/json
schema CardInstallmentPlanInfoRequest
Property Type Required
cardNo string optional
locale string optional
bankCode string optional
clientID string optional
paymentToken string required
browserDetails object optional
os string optional
name string optional
version string optional
deviceType string optional
application/json
schema CardInstallmentPlanInfoRequest
Property Type Required
cardNo string optional
locale string optional
bankCode string optional
clientID string optional
paymentToken string required
browserDetails object optional
os string optional
name string optional
version string optional
deviceType string optional
application/*+json
schema CardInstallmentPlanInfoRequest
Property Type Required
cardNo string optional
locale string optional
bankCode string optional
clientID string optional
paymentToken string required
browserDetails object optional
os string optional
name string optional
version string optional
deviceType string optional
application/json-patch+json
schema CardInstallmentPlanInfoRequest
Property Type Required
cardNo string optional
locale string optional
bankCode string optional
clientID string optional
paymentToken string required
browserDetails object optional
os string optional
name string optional
version string optional
deviceType string optional

Responses

200

Success

POST /payment/4.3/cardinstallmentplaninfo

Cardtokeninfo 1 endpoints

POST /payment/4.3/cardtokeninfo
operationId: CardTokenInfo_getCardTokenInfo

Request Body

text/json
schema PaymentBaseRequest
Property Type Required
locale string optional
clientID string optional
paymentToken string required
browserDetails object optional
os string optional
name string optional
version string optional
deviceType string optional
application/json
schema PaymentBaseRequest
Property Type Required
locale string optional
clientID string optional
paymentToken string required
browserDetails object optional
os string optional
name string optional
version string optional
deviceType string optional
application/*+json
schema PaymentBaseRequest
Property Type Required
locale string optional
clientID string optional
paymentToken string required
browserDetails object optional
os string optional
name string optional
version string optional
deviceType string optional
application/json-patch+json
schema PaymentBaseRequest
Property Type Required
locale string optional
clientID string optional
paymentToken string required
browserDetails object optional
os string optional
name string optional
version string optional
deviceType string optional

Responses

200

Success

POST /payment/4.3/cardtokeninfo

Exchangerate 3 endpoints

POST /payment/4.3/exchangerate
operationId: ExchangeRate_getRate

Request Body

text/json
schema PaymentExchangeRateConverterRequest
Property Type Required
bin string optional
locale string optional
clientID string optional
paymentToken string required
browserDetails object optional
os string optional
name string optional
version string optional
deviceType string optional
application/json
schema PaymentExchangeRateConverterRequest
Property Type Required
bin string optional
locale string optional
clientID string optional
paymentToken string required
browserDetails object optional
os string optional
name string optional
version string optional
deviceType string optional
application/*+json
schema PaymentExchangeRateConverterRequest
Property Type Required
bin string optional
locale string optional
clientID string optional
paymentToken string required
browserDetails object optional
os string optional
name string optional
version string optional
deviceType string optional
application/json-patch+json
schema PaymentExchangeRateConverterRequest
Property Type Required
bin string optional
locale string optional
clientID string optional
paymentToken string required
browserDetails object optional
os string optional
name string optional
version string optional
deviceType string optional

Responses

200

Success

POST /payment/4.3/exchangerate
POST /payment/4.3/exchangerate/apmmccexchangerate
operationId: ExchangeRate_apmMcc

Request Body

text/json
schema PaymentBaseRequest
Property Type Required
locale string optional
clientID string optional
paymentToken string required
browserDetails object optional
os string optional
name string optional
version string optional
deviceType string optional
application/json
schema PaymentBaseRequest
Property Type Required
locale string optional
clientID string optional
paymentToken string required
browserDetails object optional
os string optional
name string optional
version string optional
deviceType string optional
application/*+json
schema PaymentBaseRequest
Property Type Required
locale string optional
clientID string optional
paymentToken string required
browserDetails object optional
os string optional
name string optional
version string optional
deviceType string optional
application/json-patch+json
schema PaymentBaseRequest
Property Type Required
locale string optional
clientID string optional
paymentToken string required
browserDetails object optional
os string optional
name string optional
version string optional
deviceType string optional

Responses

200

Success

POST /payment/4.3/exchangerate/apmmccexchangerate
POST /payment/4.3/exchangerate/secure
operationId: ExchangeRate_requestEndpoint

Request Body

text/json
schema PayloadRequest
Property Type Required
payload string optional
application/json
schema PayloadRequest
Property Type Required
payload string optional
application/*+json
schema PayloadRequest
Property Type Required
payload string optional
application/json-patch+json
schema PayloadRequest
Property Type Required
payload string optional

Responses

200

Success

POST /payment/4.3/exchangerate/secure

Initialization 1 endpoints

POST /payment/4.3/initialization
operationId: Initialization_requestCreation

Responses

200

Success

POST /payment/4.3/initialization

Loyaltypointinfo 1 endpoints

POST /payment/4.3/loyaltypointinfo
operationId: LoyaltyPointInfo_postLoyaltyPointInfo

Request Body

text/json
schema PaymentLoyaltyPointInfoRequest
Property Type Required
cardNo string optional
locale string optional
clientID string optional
profileID string optional
expiryYear string optional
providerID string optional
expiryMonth string optional
referenceID string optional
paymentToken string required
browserDetails object optional
os string optional
name string optional
version string optional
deviceType string optional
application/json
schema PaymentLoyaltyPointInfoRequest
Property Type Required
cardNo string optional
locale string optional
clientID string optional
profileID string optional
expiryYear string optional
providerID string optional
expiryMonth string optional
referenceID string optional
paymentToken string required
browserDetails object optional
os string optional
name string optional
version string optional
deviceType string optional
application/*+json
schema PaymentLoyaltyPointInfoRequest
Property Type Required
cardNo string optional
locale string optional
clientID string optional
profileID string optional
expiryYear string optional
providerID string optional
expiryMonth string optional
referenceID string optional
paymentToken string required
browserDetails object optional
os string optional
name string optional
version string optional
deviceType string optional
application/json-patch+json
schema PaymentLoyaltyPointInfoRequest
Property Type Required
cardNo string optional
locale string optional
clientID string optional
profileID string optional
expiryYear string optional
providerID string optional
expiryMonth string optional
referenceID string optional
paymentToken string required
browserDetails object optional
os string optional
name string optional
version string optional
deviceType string optional

Responses

200

Success

POST /payment/4.3/loyaltypointinfo

Payment 1 endpoints

POST /payment/4.3/payment
operationId: Payment_createPayment

Request Body

text/json
schema PaymentRequestV43
Property Type Required
locale string optional
payment object optional
code object optional
agentCode string optional
channelCode string optional
agentChannelCode string optional
data object optional
pin string optional
name string optional
email string optional
cardNo string optional
qrType string optional
cardBank string optional
fxRateID string optional
mobileNo string optional
accountNo string optional
userAgent string optional
expiryYear string optional
billingCity string optional
cardCountry string optional
expiryMonth string optional
billingState string optional
customerNote string optional
interestType string optional
securityCode string optional
customerToken string optional
loyaltyPoints array optional
rewards array optional
accountNo string optional
providerID string optional
redeemAmount number optional
accountAuthData string optional
externalMerchantId string optional
queryReferenceSpecified boolean optional
…10 more object optional
clientID string optional
clientIP string optional
paymentToken string required
browserDetails object optional
os string optional
name string optional
version string optional
deviceType string optional
responseReturnUrl string optional
application/json
schema PaymentRequestV43
Property Type Required
locale string optional
payment object optional
code object optional
agentCode string optional
channelCode string optional
agentChannelCode string optional
data object optional
pin string optional
name string optional
email string optional
cardNo string optional
qrType string optional
cardBank string optional
fxRateID string optional
mobileNo string optional
accountNo string optional
userAgent string optional
expiryYear string optional
billingCity string optional
cardCountry string optional
expiryMonth string optional
billingState string optional
customerNote string optional
interestType string optional
securityCode string optional
customerToken string optional
loyaltyPoints array optional
rewards array optional
accountNo string optional
providerID string optional
redeemAmount number optional
accountAuthData string optional
externalMerchantId string optional
queryReferenceSpecified boolean optional
…10 more object optional
clientID string optional
clientIP string optional
paymentToken string required
browserDetails object optional
os string optional
name string optional
version string optional
deviceType string optional
responseReturnUrl string optional
application/*+json
schema PaymentRequestV43
Property Type Required
locale string optional
payment object optional
code object optional
agentCode string optional
channelCode string optional
agentChannelCode string optional
data object optional
pin string optional
name string optional
email string optional
cardNo string optional
qrType string optional
cardBank string optional
fxRateID string optional
mobileNo string optional
accountNo string optional
userAgent string optional
expiryYear string optional
billingCity string optional
cardCountry string optional
expiryMonth string optional
billingState string optional
customerNote string optional
interestType string optional
securityCode string optional
customerToken string optional
loyaltyPoints array optional
rewards array optional
accountNo string optional
providerID string optional
redeemAmount number optional
accountAuthData string optional
externalMerchantId string optional
queryReferenceSpecified boolean optional
…10 more object optional
clientID string optional
clientIP string optional
paymentToken string required
browserDetails object optional
os string optional
name string optional
version string optional
deviceType string optional
responseReturnUrl string optional
application/json-patch+json
schema PaymentRequestV43
Property Type Required
locale string optional
payment object optional
code object optional
agentCode string optional
channelCode string optional
agentChannelCode string optional
data object optional
pin string optional
name string optional
email string optional
cardNo string optional
qrType string optional
cardBank string optional
fxRateID string optional
mobileNo string optional
accountNo string optional
userAgent string optional
expiryYear string optional
billingCity string optional
cardCountry string optional
expiryMonth string optional
billingState string optional
customerNote string optional
interestType string optional
securityCode string optional
customerToken string optional
loyaltyPoints array optional
rewards array optional
accountNo string optional
providerID string optional
redeemAmount number optional
accountAuthData string optional
externalMerchantId string optional
queryReferenceSpecified boolean optional
…10 more object optional
clientID string optional
clientIP string optional
paymentToken string required
browserDetails object optional
os string optional
name string optional
version string optional
deviceType string optional
responseReturnUrl string optional

Responses

200

Success

POST /payment/4.3/payment

Paymentinquiry 1 endpoints

POST /payment/4.3/paymentinquiry
operationId: PaymentInquiry_postPaymentDetails

Request Body

text/json
schema PayloadRequest
Property Type Required
payload string optional
application/json
schema PayloadRequest
Property Type Required
payload string optional
application/*+json
schema PayloadRequest
Property Type Required
payload string optional
application/json-patch+json
schema PayloadRequest
Property Type Required
payload string optional

Responses

200

Success

POST /payment/4.3/paymentinquiry

Paymentinstruction 1 endpoints

POST /payment/4.3/paymentinstruction
operationId: PaymentInstruction_submitInstruction

Request Body

text/json
schema PayloadRequest
Property Type Required
payload string optional
application/json
schema PayloadRequest
Property Type Required
payload string optional
application/*+json
schema PayloadRequest
Property Type Required
payload string optional
application/json-patch+json
schema PayloadRequest
Property Type Required
payload string optional

Responses

200

Success

POST /payment/4.3/paymentinstruction

Paymentnotification 1 endpoints

POST /payment/4.3/paymentnotification
operationId: PaymentNotification_processNotification

Request Body

text/json
schema PaymentNotificationRequest
Property Type Required
locale string optional
clientID string optional
plateform string optional
recipientID string optional
paymentToken string required
recipientName string optional
browserDetails object optional
os string optional
name string optional
version string optional
deviceType string optional
application/json
schema PaymentNotificationRequest
Property Type Required
locale string optional
clientID string optional
plateform string optional
recipientID string optional
paymentToken string required
recipientName string optional
browserDetails object optional
os string optional
name string optional
version string optional
deviceType string optional
application/*+json
schema PaymentNotificationRequest
Property Type Required
locale string optional
clientID string optional
plateform string optional
recipientID string optional
paymentToken string required
recipientName string optional
browserDetails object optional
os string optional
name string optional
version string optional
deviceType string optional
application/json-patch+json
schema PaymentNotificationRequest
Property Type Required
locale string optional
clientID string optional
plateform string optional
recipientID string optional
paymentToken string required
recipientName string optional
browserDetails object optional
os string optional
name string optional
version string optional
deviceType string optional

Responses

200

Success

POST /payment/4.3/paymentnotification

Paymentoption 1 endpoints

POST /payment/4.3/paymentoption
operationId: PaymentOption_createPaymentOption

Request Body

text/json
schema PaymentBaseRequest
Property Type Required
locale string optional
clientID string optional
paymentToken string required
browserDetails object optional
os string optional
name string optional
version string optional
deviceType string optional
application/json
schema PaymentBaseRequest
Property Type Required
locale string optional
clientID string optional
paymentToken string required
browserDetails object optional
os string optional
name string optional
version string optional
deviceType string optional
application/*+json
schema PaymentBaseRequest
Property Type Required
locale string optional
clientID string optional
paymentToken string required
browserDetails object optional
os string optional
name string optional
version string optional
deviceType string optional
application/json-patch+json
schema PaymentBaseRequest
Property Type Required
locale string optional
clientID string optional
paymentToken string required
browserDetails object optional
os string optional
name string optional
version string optional
deviceType string optional

Responses

200

Success

POST /payment/4.3/paymentoption

Paymentoptiondetails 1 endpoints

POST /payment/4.3/paymentoptiondetails
operationId: PaymentOptionDetails_postOptionDetails

Request Body

text/json
schema PaymentOptionDetailsRequest
Property Type Required
locale string optional
clientID string optional
groupCode string required
categoryCode string required
paymentToken string required
browserDetails object optional
os string optional
name string optional
version string optional
deviceType string optional
application/json
schema PaymentOptionDetailsRequest
Property Type Required
locale string optional
clientID string optional
groupCode string required
categoryCode string required
paymentToken string required
browserDetails object optional
os string optional
name string optional
version string optional
deviceType string optional
application/*+json
schema PaymentOptionDetailsRequest
Property Type Required
locale string optional
clientID string optional
groupCode string required
categoryCode string required
paymentToken string required
browserDetails object optional
os string optional
name string optional
version string optional
deviceType string optional
application/json-patch+json
schema PaymentOptionDetailsRequest
Property Type Required
locale string optional
clientID string optional
groupCode string required
categoryCode string required
paymentToken string required
browserDetails object optional
os string optional
name string optional
version string optional
deviceType string optional

Responses

200

Success

POST /payment/4.3/paymentoptiondetails

Paymentsimulate 1 endpoints

POST /payment/4.3/paymentsimulate
operationId: PaymentSimulate_executePaymentSimulation

Request Body

text/json
schema PayloadRequest
Property Type Required
payload string optional
application/json
schema PayloadRequest
Property Type Required
payload string optional
application/*+json
schema PayloadRequest
Property Type Required
payload string optional
application/json-patch+json
schema PayloadRequest
Property Type Required
payload string optional

Responses

200

Success

POST /payment/4.3/paymentsimulate

Paymenttoken 1 endpoints

POST /payment/4.3/paymenttoken
operationId: PaymentToken_generateToken

Request Body

text/json
schema PayloadRequest
Property Type Required
payload string optional
application/json
schema PayloadRequest
Property Type Required
payload string optional
application/*+json
schema PayloadRequest
Property Type Required
payload string optional
application/json-patch+json
schema PayloadRequest
Property Type Required
payload string optional

Responses

200

Success

POST /payment/4.3/paymenttoken

Redirectbackend 1 endpoints

POST /payment/4.3/redirectbackend
operationId: RedirectBackEnd_postPaymentRedirect

Request Body

multipart/form-data
schema RedirectBackEndPostPaymentRedirectRequest
Property Type Required
isLeaveApp string optional
paymentResponse string optional

Responses

200

Success

POST /payment/4.3/redirectbackend

Redirectfrontend 1 endpoints

POST /payment/4.3/redirectfrontend
operationId: RedirectFrontEnd_postPaymentRedirect

Request Body

multipart/form-data
schema RedirectFrontEndPostPaymentRedirectRequest
Property Type Required
isLeaveApp string optional
payResponse string optional

Responses

200

Success

POST /payment/4.3/redirectfrontend

Transactionstatus 1 endpoints

POST /payment/4.3/transactionstatus
operationId: TransactionStatus_updateTransactionStatus

Request Body

text/json
schema TransactionStatusRequest
Property Type Required
locale string optional
clientID string optional
paymentToken string required
additionalInfo boolean optional
browserDetails object optional
os string optional
name string optional
version string optional
deviceType string optional
application/json
schema TransactionStatusRequest
Property Type Required
locale string optional
clientID string optional
paymentToken string required
additionalInfo boolean optional
browserDetails object optional
os string optional
name string optional
version string optional
deviceType string optional
application/*+json
schema TransactionStatusRequest
Property Type Required
locale string optional
clientID string optional
paymentToken string required
additionalInfo boolean optional
browserDetails object optional
os string optional
name string optional
version string optional
deviceType string optional
application/json-patch+json
schema TransactionStatusRequest
Property Type Required
locale string optional
clientID string optional
paymentToken string required
additionalInfo boolean optional
browserDetails object optional
os string optional
name string optional
version string optional
deviceType string optional

Responses

200

Success

POST /payment/4.3/transactionstatus

Userpreference 1 endpoints

POST /payment/4.3/userpreference
operationId: UserPreference_saveUserPreference

Request Body

text/json
schema PaymentBaseRequest
Property Type Required
locale string optional
clientID string optional
paymentToken string required
browserDetails object optional
os string optional
name string optional
version string optional
deviceType string optional
application/json
schema PaymentBaseRequest
Property Type Required
locale string optional
clientID string optional
paymentToken string required
browserDetails object optional
os string optional
name string optional
version string optional
deviceType string optional
application/*+json
schema PaymentBaseRequest
Property Type Required
locale string optional
clientID string optional
paymentToken string required
browserDetails object optional
os string optional
name string optional
version string optional
deviceType string optional
application/json-patch+json
schema PaymentBaseRequest
Property Type Required
locale string optional
clientID string optional
paymentToken string required
browserDetails object optional
os string optional
name string optional
version string optional
deviceType string optional

Responses

200

Success

POST /payment/4.3/userpreference

Schemas

object Address
{
  "type": "object",
  "properties": {
    "city": {
      "type": "string",
      "nullable": true
    },
    "state": {
      "type": "string",
      "nullable": true
    },
    "address1": {
      "type": "string",
      "nullable": true
    },
    "address2": {
      "type": "string",
      "nullable": true
    },
    "address3": {
      "type": "string",
      "nullable": true
    },
    "postalCode": {
      "type": "string",
      "nullable": true
    },
    "countryCode": {
      "type": "string",
      "nullable": true
    }
  }
}
object BrowserDetails
{
  "type": "object",
  "properties": {
    "os": {
      "type": "string",
      "nullable": true
    },
    "name": {
      "type": "string",
      "nullable": true
    },
    "version": {
      "type": "string",
      "nullable": true
    },
    "deviceType": {
      "type": "string",
      "nullable": true
    }
  }
}
object CardInstallmentPlanInfoRequest
{
  "type": "object",
  "required": [
    "paymentToken"
  ],
  "properties": {
    "cardNo": {
      "type": "string",
      "nullable": true
    },
    "locale": {
      "type": "string",
      "nullable": true
    },
    "bankCode": {
      "type": "string",
      "nullable": true
    },
    "clientID": {
      "type": "string",
      "format": "uuid"
    },
    "paymentToken": {
      "type": "string"
    },
    "browserDetails": {
      "$ref": "#/components/schemas/BrowserDetails"
    }
  }
}
object CreditCardTokenV43
{
  "type": "object",
  "properties": {
    "name": {
      "type": "string",
      "nullable": true
    },
    "email": {
      "type": "string",
      "nullable": true
    },
    "token": {
      "type": "string",
      "nullable": true
    },
    "expiry": {
      "type": "string",
      "nullable": true
    },
    "status": {
      "type": "string",
      "nullable": true
    },
    "iconUrl": {
      "type": "string",
      "nullable": true
    },
    "logoUrl": {
      "type": "string",
      "nullable": true
    },
    "accountNo": {
      "type": "string",
      "nullable": true
    },
    "cardBrand": {
      "type": "string",
      "nullable": true
    },
    "channelCode": {
      "type": "string",
      "nullable": true
    },
    "subChannelCode": {
      "type": "string",
      "nullable": true
    }
  }
}
object CurrencyAPMMCCFxRate
{
  "type": "object",
  "properties": {
    "fx": {
      "type": "number",
      "format": "double"
    },
    "id": {
      "type": "string",
      "nullable": true
    },
    "expire": {
      "type": "integer",
      "format": "int64"
    },
    "sequenceNo": {
      "type": "integer",
      "format": "int32"
    },
    "currencyCode": {
      "type": "string",
      "nullable": true
    }
  }
}
object CurrencyFxRate
{
  "type": "object",
  "properties": {
    "fx": {
      "type": "number",
      "format": "double"
    },
    "id": {
      "type": "string",
      "nullable": true
    },
    "name": {
      "type": "string",
      "nullable": true
    },
    "amount": {
      "type": "string",
      "nullable": true
    },
    "iconUrl": {
      "type": "string",
      "nullable": true
    },
    "sequenceNo": {
      "type": "integer",
      "format": "int32"
    },
    "currencyCode": {
      "type": "string",
      "nullable": true
    }
  }
}
object CustomerAddress
{
  "type": "object",
  "properties": {
    "billing": {
      "$ref": "#/components/schemas/Address"
    },
    "shipping": {
      "$ref": "#/components/schemas/Address"
    }
  }
}
object IppPlan
{
  "type": "object",
  "properties": {
    "label": {
      "type": "string",
      "nullable": true
    },
    "terms": {
      "type": "string",
      "nullable": true
    },
    "period": {
      "type": "integer",
      "format": "int32"
    },
    "sequenceNo": {
      "type": "integer",
      "format": "int32"
    },
    "currencyCode": {
      "type": "string",
      "nullable": true
    },
    "interestRate": {
      "type": "number",
      "format": "double"
    },
    "interestType": {
      "type": "string",
      "nullable": true
    },
    "monthlyAmount": {
      "type": "number",
      "format": "double"
    },
    "payLaterPeriod": {
      "type": "integer",
      "format": "int32",
      "nullable": true
    },
    "monthlyInterest": {
      "type": "number",
      "format": "double"
    }
  }
}
object Locale
{
  "type": "object",
  "properties": {
    "code": {
      "type": "string",
      "nullable": true
    },
    "name": {
      "type": "string",
      "nullable": true
    },
    "iconUrl": {
      "type": "string",
      "nullable": true
    }
  }
}
object LoyaltyDetails
{
  "type": "object",
  "properties": {
    "rewards": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/LoyaltyRewards"
      },
      "nullable": true
    },
    "accountNo": {
      "type": "string",
      "nullable": true
    },
    "providerID": {
      "type": "string",
      "nullable": true
    },
    "redeemAmount": {
      "type": "number",
      "format": "double"
    },
    "accountAuthData": {
      "type": "string",
      "nullable": true
    },
    "externalMerchantId": {
      "type": "string",
      "nullable": true
    },
    "queryReferenceSpecified": {
      "type": "boolean",
      "readOnly": true
    }
  }
}
object LoyaltyRewards
{
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "nullable": true
    },
    "Quantity": {
      "type": "number",
      "format": "double"
    }
  }
}
object MerchantConfiguration
{
  "type": "object",
  "properties": {
    "payment": {
      "$ref": "#/components/schemas/MerchantConfigurationPayment"
    },
    "notification": {
      "$ref": "#/components/schemas/MerchantConfigurationNotification"
    }
  }
}
object MerchantConfigurationNotification
{
  "type": "object",
  "properties": {
    "line": {
      "type": "boolean"
    },
    "facebook": {
      "type": "boolean"
    },
    "whatsApp": {
      "type": "boolean"
    }
  }
}
object MerchantConfigurationPayment
{
  "type": "object",
  "properties": {
    "fx": {
      "$ref": "#/components/schemas/MerchantConfigurationPaymentFx"
    },
    "tokenize": {
      "type": "boolean"
    },
    "tokenizeOnly": {
      "type": "boolean"
    },
    "cardTokenOnly": {
      "type": "boolean"
    },
    "immediatePayment": {
      "type": "boolean"
    }
  }
}
object MerchantConfigurationPaymentFx
{
  "type": "object",
  "properties": {
    "dcc": {
      "$ref": "#/components/schemas/MerchantConfigurationPaymentFxRate"
    },
    "mcp": {
      "$ref": "#/components/schemas/MerchantConfigurationPaymentFxRate"
    },
    "apmMcc": {
      "$ref": "#/components/schemas/MerchantConfigurationPaymentFxRate"
    }
  }
}
object MerchantConfigurationPaymentFxRate
{
  "type": "object",
  "properties": {
    "terms": {
      "type": "string",
      "nullable": true
    },
    "active": {
      "type": "boolean"
    }
  }
}
object MerchantDetails
{
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "nullable": true
    },
    "name": {
      "type": "string",
      "nullable": true
    },
    "email": {
      "type": "string",
      "nullable": true
    },
    "address": {
      "type": "string",
      "nullable": true
    },
    "logoUrl": {
      "type": "string",
      "nullable": true
    },
    "bannerUrl": {
      "type": "string",
      "nullable": true
    }
  }
}
object MerchantValidationApplePay
{
  "type": "object",
  "required": [
    "paymentToken"
  ],
  "properties": {
    "locale": {
      "type": "string",
      "nullable": true
    },
    "clientID": {
      "type": "string",
      "format": "uuid"
    },
    "paymentToken": {
      "type": "string"
    },
    "validationUrl": {
      "type": "string",
      "nullable": true
    },
    "browserDetails": {
      "$ref": "#/components/schemas/BrowserDetails"
    }
  }
}
object MerchantValidationApplePayResponse
{
  "type": "object",
  "properties": {
    "nonce": {
      "type": "string",
      "nullable": true
    },
    "pspId": {
      "type": "string",
      "nullable": true
    },
    "retries": {
      "type": "integer",
      "format": "int32"
    },
    "respCode": {
      "type": "string",
      "nullable": true
    },
    "respDesc": {
      "type": "string",
      "nullable": true
    },
    "expiresAt": {
      "type": "integer",
      "format": "int64"
    },
    "signature": {
      "type": "string",
      "nullable": true
    },
    "domainName": {
      "type": "string",
      "nullable": true
    },
    "displayName": {
      "type": "string",
      "nullable": true
    },
    "epochTimestamp": {
      "type": "integer",
      "format": "int64"
    },
    "merchantIdentifier": {
      "type": "string",
      "nullable": true
    },
    "merchantSessionIdentifier": {
      "type": "string",
      "nullable": true
    },
    "operationalAnalyticsIdentifier": {
      "type": "string",
      "nullable": true
    }
  }
}
object PayloadRequest
{
  "type": "object",
  "properties": {
    "payload": {
      "type": "string",
      "nullable": true
    }
  }
}
object PaymentApmMccExchangeRateResponse
{
  "type": "object",
  "properties": {
    "fxRates": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/CurrencyAPMMCCFxRate"
      },
      "nullable": true
    },
    "respCode": {
      "type": "string",
      "nullable": true
    },
    "respDesc": {
      "type": "string",
      "nullable": true
    },
    "paymentToken": {
      "type": "string",
      "nullable": true
    }
  }
}
object PaymentBaseRequest
{
  "type": "object",
  "required": [
    "paymentToken"
  ],
  "properties": {
    "locale": {
      "type": "string",
      "nullable": true
    },
    "clientID": {
      "type": "string",
      "format": "uuid"
    },
    "paymentToken": {
      "type": "string"
    },
    "browserDetails": {
      "$ref": "#/components/schemas/BrowserDetails"
    }
  }
}
object PaymentCardTokenResponseV43
{
  "type": "object",
  "properties": {
    "respCode": {
      "type": "string",
      "nullable": true
    },
    "respDesc": {
      "type": "string",
      "nullable": true
    },
    "paymentToken": {
      "type": "string",
      "nullable": true
    },
    "customerToken": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/CreditCardTokenV43"
      },
      "nullable": true
    }
  }
}
object PaymentChannelCategory
{
  "type": "object",
  "properties": {
    "id": {
      "type": "integer",
      "format": "int32",
      "nullable": true
    },
    "code": {
      "type": "string",
      "nullable": true
    },
    "name": {
      "type": "string",
      "nullable": true
    },
    "groups": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/ResponsePaymentChannel"
      },
      "nullable": true
    },
    "qrType": {
      "type": "string",
      "nullable": true
    },
    "default": {
      "type": "boolean"
    },
    "iconUrl": {
      "type": "string",
      "nullable": true
    },
    "logoUrl": {
      "type": "string",
      "nullable": true
    },
    "expiration": {
      "type": "boolean"
    },
    "optionName": {
      "type": "string",
      "nullable": true
    },
    "sequenceNo": {
      "type": "integer",
      "format": "int32"
    },
    "channelCode": {
      "type": "string",
      "nullable": true
    },
    "paymentCode": {
      "type": "string",
      "nullable": true
    },
    "expirationTimer": {
      "type": "string",
      "nullable": true
    },
    "agentChannelCode": {
      "type": "string",
      "nullable": true
    },
    "expirationDescription": {
      "type": "string",
      "nullable": true
    }
  }
}
object PaymentChannelPreference
{
  "type": "object",
  "properties": {
    "name": {
      "type": "string",
      "nullable": true
    },
    "iconUrl": {
      "type": "string",
      "nullable": true
    },
    "logoUrl": {
      "type": "string",
      "nullable": true
    },
    "agentCode": {
      "type": "string",
      "nullable": true
    },
    "groupCode": {
      "type": "string",
      "nullable": true
    },
    "sequenceNo": {
      "type": "integer",
      "format": "int32"
    },
    "channelCode": {
      "type": "string",
      "nullable": true
    },
    "categoryCode": {
      "type": "string",
      "nullable": true
    },
    "agentChannelCode": {
      "type": "string",
      "nullable": true
    }
  }
}
object PaymentExchangeRateConverterRequest
{
  "type": "object",
  "required": [
    "paymentToken"
  ],
  "properties": {
    "bin": {
      "type": "string",
      "nullable": true
    },
    "locale": {
      "type": "string",
      "nullable": true
    },
    "clientID": {
      "type": "string",
      "format": "uuid"
    },
    "paymentToken": {
      "type": "string"
    },
    "browserDetails": {
      "$ref": "#/components/schemas/BrowserDetails"
    }
  }
}
object PaymentExchangeRateConverterResponse
{
  "type": "object",
  "properties": {
    "expire": {
      "type": "integer",
      "format": "int64",
      "nullable": true
    },
    "fxRates": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/CurrencyFxRate"
      },
      "nullable": true
    },
    "respCode": {
      "type": "string",
      "nullable": true
    },
    "respDesc": {
      "type": "string",
      "nullable": true
    },
    "paymentToken": {
      "type": "string",
      "nullable": true
    },
    "providerCode": {
      "type": "string",
      "nullable": true
    }
  }
}
object PaymentInitialization
{
  "type": "object",
  "properties": {
    "locale": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/Locale"
      },
      "nullable": true
    }
  }
}
object PaymentInitializationResponse
{
  "type": "object",
  "properties": {
    "respCode": {
      "type": "string",
      "nullable": true
    },
    "respDesc": {
      "type": "string",
      "nullable": true
    },
    "initialization": {
      "$ref": "#/components/schemas/PaymentInitialization"
    }
  }
}
object PaymentItem
{
  "type": "object",
  "properties": {
    "code": {
      "type": "string",
      "nullable": true
    },
    "name": {
      "type": "string",
      "nullable": true
    },
    "price": {
      "type": "number",
      "format": "double"
    },
    "quantity": {
      "type": "integer",
      "format": "int32"
    }
  }
}
object PaymentLoyaltyPointInfoRequest
{
  "type": "object",
  "required": [
    "paymentToken"
  ],
  "properties": {
    "cardNo": {
      "type": "string",
      "nullable": true
    },
    "locale": {
      "type": "string",
      "nullable": true
    },
    "clientID": {
      "type": "string",
      "format": "uuid"
    },
    "profileID": {
      "type": "string",
      "nullable": true
    },
    "expiryYear": {
      "type": "string",
      "nullable": true
    },
    "providerID": {
      "type": "string",
      "nullable": true
    },
    "expiryMonth": {
      "type": "string",
      "nullable": true
    },
    "referenceID": {
      "type": "string",
      "nullable": true
    },
    "paymentToken": {
      "type": "string"
    },
    "browserDetails": {
      "$ref": "#/components/schemas/BrowserDetails"
    }
  }
}
object PaymentLoyaltyPointInfoResponse
{
  "type": "object",
  "properties": {
    "terms": {
      "type": "string",
      "nullable": true
    },
    "rewards": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/PaymentLoyaltyReward"
      },
      "nullable": true
    },
    "respCode": {
      "type": "string",
      "nullable": true
    },
    "respDesc": {
      "type": "string",
      "nullable": true
    },
    "providerID": {
      "type": "string",
      "nullable": true
    },
    "referenceID": {
      "type": "string",
      "nullable": true
    },
    "paymentToken": {
      "type": "string",
      "nullable": true
    },
    "providerName": {
      "type": "string",
      "nullable": true
    },
    "providerType": {
      "type": "string",
      "nullable": true
    }
  }
}
object PaymentLoyaltyReward
{
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "nullable": true
    },
    "name": {
      "type": "string",
      "nullable": true
    },
    "type": {
      "type": "string",
      "nullable": true
    },
    "label": {
      "type": "string",
      "nullable": true
    },
    "point": {
      "type": "number",
      "format": "double"
    },
    "price": {
      "type": "number",
      "format": "double"
    },
    "amount": {
      "type": "number",
      "format": "double"
    },
    "quantity": {
      "type": "number",
      "format": "double"
    },
    "sequenceNo": {
      "type": "integer",
      "format": "int32"
    },
    "totalPoints": {
      "type": "number",
      "format": "double"
    },
    "currencyCode": {
      "type": "string",
      "nullable": true
    },
    "forceToSelectReward": {
      "type": "boolean"
    }
  }
}
object PaymentNonRedirectResponse
{
  "type": "object",
  "properties": {
    "respCode": {
      "type": "string",
      "nullable": true
    },
    "respDesc": {
      "type": "string",
      "nullable": true
    },
    "invoiceNo": {
      "type": "string",
      "nullable": true
    },
    "channelCode": {
      "type": "string",
      "nullable": true
    }
  }
}
object PaymentNotificationRequest
{
  "type": "object",
  "required": [
    "paymentToken"
  ],
  "properties": {
    "locale": {
      "type": "string",
      "nullable": true
    },
    "clientID": {
      "type": "string",
      "format": "uuid"
    },
    "plateform": {
      "type": "string",
      "nullable": true
    },
    "recipientID": {
      "type": "string",
      "nullable": true
    },
    "paymentToken": {
      "type": "string"
    },
    "recipientName": {
      "type": "string",
      "nullable": true
    },
    "browserDetails": {
      "$ref": "#/components/schemas/BrowserDetails"
    }
  }
}
object PaymentOptionDetailsChannel
{
  "type": "object",
  "properties": {
    "name": {
      "type": "string",
      "nullable": true
    },
    "isDown": {
      "type": "boolean"
    },
    "iconUrl": {
      "type": "string",
      "nullable": true
    },
    "logoUrl": {
      "type": "string",
      "nullable": true
    },
    "payment": {
      "$ref": "#/components/schemas/PaymentOptionDetailsPayment"
    },
    "sequenceNo": {
      "type": "integer",
      "format": "int32"
    },
    "bankShortName": {
      "type": "string",
      "nullable": true
    },
    "currencyCodes": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "nullable": true
    },
    "ippProviderCode": {
      "type": "string",
      "nullable": true
    },
    "registrationStatus": {
      "type": "string",
      "nullable": true
    },
    "checkEligibleOption": {
      "type": "boolean"
    },
    "partnerMerchantRefID": {
      "type": "string",
      "nullable": true
    }
  }
}
object PaymentOptionDetailsCustomData
{
  "type": "object",
  "properties": {
    "data": {
      "type": "string",
      "nullable": true
    },
    "type": {
      "type": "string",
      "nullable": true
    },
    "sequenceNo": {
      "type": "integer",
      "format": "int32"
    }
  }
}
object PaymentOptionDetailsInfo
{
  "type": "object",
  "properties": {
    "plans": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/IppPlan"
      },
      "nullable": true
    },
    "terms": {
      "type": "string",
      "nullable": true
    },
    "promoUrl": {
      "type": "string",
      "nullable": true
    },
    "provider": {
      "$ref": "#/components/schemas/PaymentOptionDetailsInfoProvider"
    },
    "customData": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/PaymentOptionDetailsCustomData"
      },
      "nullable": true
    },
    "learnMoreUrl": {
      "type": "string",
      "nullable": true
    },
    "termsConsent": {
      "type": "boolean"
    }
  }
}
object PaymentOptionDetailsInfoProvider
{
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "nullable": true
    },
    "terms": {
      "type": "string",
      "nullable": true
    },
    "channels": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "nullable": true
    },
    "termsConsent": {
      "type": "boolean"
    },
    "merchantDetails": {
      "$ref": "#/components/schemas/PodInfoProviderMerchantDetails"
    },
    "transactionDetails": {
      "$ref": "#/components/schemas/PodInfoProviderTransactionDetails"
    }
  }
}
object PaymentOptionDetailsPayment
{
  "type": "object",
  "properties": {
    "code": {
      "$ref": "#/components/schemas/PaymentOptionDetailsPaymentCode"
    },
    "info": {
      "$ref": "#/components/schemas/PaymentOptionDetailsInfo"
    },
    "input": {
      "type": "object",
      "nullable": true,
      "additionalProperties": {}
    },
    "validation": {
      "type": "object",
      "nullable": true,
      "additionalProperties": {}
    }
  }
}
object PaymentOptionDetailsPaymentCode
{
  "type": "object",
  "properties": {
    "agentCode": {
      "type": "string",
      "nullable": true
    },
    "channelCode": {
      "type": "string",
      "nullable": true
    },
    "agentChannelCode": {
      "type": "string",
      "nullable": true
    }
  }
}
object PaymentOptionDetailsRequest
{
  "type": "object",
  "required": [
    "categoryCode",
    "groupCode",
    "paymentToken"
  ],
  "properties": {
    "locale": {
      "type": "string",
      "nullable": true
    },
    "clientID": {
      "type": "string",
      "format": "uuid"
    },
    "groupCode": {
      "type": "string"
    },
    "categoryCode": {
      "type": "string"
    },
    "paymentToken": {
      "type": "string"
    },
    "browserDetails": {
      "$ref": "#/components/schemas/BrowserDetails"
    }
  }
}
object PaymentOptionDetailsResponse
{
  "type": "object",
  "properties": {
    "name": {
      "type": "string",
      "nullable": true
    },
    "iconUrl": {
      "type": "string",
      "nullable": true
    },
    "channels": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/PaymentOptionDetailsChannel"
      },
      "nullable": true
    },
    "respCode": {
      "type": "string",
      "nullable": true
    },
    "respDesc": {
      "type": "string",
      "nullable": true
    },
    "groupCode": {
      "type": "string",
      "nullable": true
    },
    "validation": {
      "$ref": "#/components/schemas/PaymentOptionDetailsValidation"
    },
    "categoryCode": {
      "type": "string",
      "nullable": true
    },
    "totalChannel": {
      "type": "integer",
      "format": "int32"
    },
    "configuration": {
      "$ref": "#/components/schemas/MerchantConfiguration"
    }
  }
}
object PaymentOptionDetailsValidation
{
  "type": "object",
  "properties": {
    "cardNo": {
      "$ref": "#/components/schemas/PaymentOptionDetailsValidationCard"
    },
    "cardTypes": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/PaymentOptionDetailsValidationCardType"
      },
      "nullable": true
    }
  }
}
object PaymentOptionDetailsValidationCard
{
  "type": "object",
  "properties": {
    "regex": {
      "type": "string",
      "nullable": true
    },
    "prefixes": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "nullable": true
    }
  }
}
object PaymentOptionDetailsValidationCardType
{
  "type": "object",
  "properties": {
    "name": {
      "type": "string",
      "nullable": true
    },
    "regex": {
      "type": "string",
      "nullable": true
    },
    "iconUrl": {
      "type": "string",
      "nullable": true
    },
    "prefixes": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "nullable": true
    },
    "sequenceNo": {
      "type": "integer",
      "format": "int32"
    }
  }
}
object PaymentOptionResponse
{
  "type": "object",
  "properties": {
    "respCode": {
      "type": "string",
      "nullable": true
    },
    "respDesc": {
      "type": "string",
      "nullable": true
    },
    "userDetails": {
      "$ref": "#/components/schemas/UserDetails"
    },
    "paymentToken": {
      "type": "string",
      "nullable": true
    },
    "merchantDetails": {
      "$ref": "#/components/schemas/MerchantDetails"
    },
    "channelCategories": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/PaymentChannelCategory"
      },
      "nullable": true
    },
    "transactionDetails": {
      "$ref": "#/components/schemas/TransactionDetails"
    }
  }
}
object PaymentParamsDataRequestV43
{
  "type": "object",
  "properties": {
    "pin": {
      "type": "string",
      "nullable": true
    },
    "name": {
      "type": "string",
      "nullable": true
    },
    "email": {
      "type": "string",
      "nullable": true
    },
    "cardNo": {
      "type": "string",
      "nullable": true
    },
    "qrType": {
      "type": "string",
      "nullable": true
    },
    "cardBank": {
      "type": "string",
      "nullable": true
    },
    "fxRateID": {
      "type": "string",
      "nullable": true
    },
    "mobileNo": {
      "type": "string",
      "nullable": true
    },
    "accountNo": {
      "type": "string",
      "nullable": true
    },
    "userAgent": {
      "type": "string",
      "nullable": true
    },
    "expiryYear": {
      "type": "string",
      "nullable": true
    },
    "billingCity": {
      "type": "string",
      "nullable": true
    },
    "cardCountry": {
      "type": "string",
      "nullable": true
    },
    "expiryMonth": {
      "type": "string",
      "nullable": true
    },
    "billingState": {
      "type": "string",
      "nullable": true
    },
    "customerNote": {
      "type": "string",
      "nullable": true
    },
    "interestType": {
      "type": "string",
      "nullable": true
    },
    "securityCode": {
      "type": "string",
      "nullable": true
    },
    "customerToken": {
      "type": "string",
      "nullable": true
    },
    "loyaltyPoints": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/LoyaltyDetails"
      },
      "nullable": true
    },
    "paymentExpiry": {
      "type": "string",
      "nullable": true
    },
    "payLaterPeriod": {
      "type": "integer",
      "format": "int32",
      "nullable": true
    },
    "securePayToken": {
      "type": "string",
      "nullable": true
    },
    "billingAddress1": {
      "type": "string",
      "nullable": true
    },
    "billingAddress2": {
      "type": "string",
      "nullable": true
    },
    "billingAddress3": {
      "type": "string",
      "nullable": true
    },
    "billingPostalCode": {
      "type": "string",
      "nullable": true
    },
    "installmentPeriod": {
      "type": "integer",
      "format": "int32"
    },
    "billingCountryCode": {
      "type": "string",
      "nullable": true
    },
    "accountTokenization": {
      "type": "boolean"
    }
  }
}
object PaymentParamsRequestV43
{
  "type": "object",
  "properties": {
    "code": {
      "$ref": "#/components/schemas/PaymentOptionDetailsPaymentCode"
    },
    "data": {
      "$ref": "#/components/schemas/PaymentParamsDataRequestV43"
    }
  }
}
object PaymentRequestV43
{
  "type": "object",
  "required": [
    "paymentToken"
  ],
  "properties": {
    "locale": {
      "type": "string",
      "nullable": true
    },
    "payment": {
      "$ref": "#/components/schemas/PaymentParamsRequestV43"
    },
    "clientID": {
      "type": "string",
      "format": "uuid"
    },
    "clientIP": {
      "type": "string",
      "nullable": true
    },
    "paymentToken": {
      "type": "string"
    },
    "browserDetails": {
      "$ref": "#/components/schemas/BrowserDetails"
    },
    "responseReturnUrl": {
      "type": "string",
      "nullable": true
    }
  }
}