Query structured spec data via REST or MCP. Get exactly what your agent needs.
https://sandbox-pgw.2c2p.com
No endpoints found for this provider.
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
}
}
}
BrowserDetails
{
"type": "object",
"properties": {
"os": {
"type": "string",
"nullable": true
},
"name": {
"type": "string",
"nullable": true
},
"version": {
"type": "string",
"nullable": true
},
"deviceType": {
"type": "string",
"nullable": true
}
}
}
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"
}
}
}
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
}
}
}
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
}
}
}
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
}
}
}
CustomerAddress
{
"type": "object",
"properties": {
"billing": {
"$ref": "#/components/schemas/Address"
},
"shipping": {
"$ref": "#/components/schemas/Address"
}
}
}
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"
}
}
}
Locale
{
"type": "object",
"properties": {
"code": {
"type": "string",
"nullable": true
},
"name": {
"type": "string",
"nullable": true
},
"iconUrl": {
"type": "string",
"nullable": true
}
}
}
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
}
}
}
LoyaltyRewards
{
"type": "object",
"properties": {
"id": {
"type": "string",
"nullable": true
},
"Quantity": {
"type": "number",
"format": "double"
}
}
}
MerchantConfiguration
{
"type": "object",
"properties": {
"payment": {
"$ref": "#/components/schemas/MerchantConfigurationPayment"
},
"notification": {
"$ref": "#/components/schemas/MerchantConfigurationNotification"
}
}
}
MerchantConfigurationNotification
{
"type": "object",
"properties": {
"line": {
"type": "boolean"
},
"facebook": {
"type": "boolean"
},
"whatsApp": {
"type": "boolean"
}
}
}
MerchantConfigurationPayment
{
"type": "object",
"properties": {
"fx": {
"$ref": "#/components/schemas/MerchantConfigurationPaymentFx"
},
"tokenize": {
"type": "boolean"
},
"tokenizeOnly": {
"type": "boolean"
},
"cardTokenOnly": {
"type": "boolean"
},
"immediatePayment": {
"type": "boolean"
}
}
}
MerchantConfigurationPaymentFx
{
"type": "object",
"properties": {
"dcc": {
"$ref": "#/components/schemas/MerchantConfigurationPaymentFxRate"
},
"mcp": {
"$ref": "#/components/schemas/MerchantConfigurationPaymentFxRate"
},
"apmMcc": {
"$ref": "#/components/schemas/MerchantConfigurationPaymentFxRate"
}
}
}
MerchantConfigurationPaymentFxRate
{
"type": "object",
"properties": {
"terms": {
"type": "string",
"nullable": true
},
"active": {
"type": "boolean"
}
}
}
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
}
}
}
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"
}
}
}
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
}
}
}
PayloadRequest
{
"type": "object",
"properties": {
"payload": {
"type": "string",
"nullable": true
}
}
}
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
}
}
}
PaymentBaseRequest
{
"type": "object",
"required": [
"paymentToken"
],
"properties": {
"locale": {
"type": "string",
"nullable": true
},
"clientID": {
"type": "string",
"format": "uuid"
},
"paymentToken": {
"type": "string"
},
"browserDetails": {
"$ref": "#/components/schemas/BrowserDetails"
}
}
}
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
}
}
}
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
}
}
}
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
}
}
}
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"
}
}
}
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
}
}
}
PaymentInitialization
{
"type": "object",
"properties": {
"locale": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Locale"
},
"nullable": true
}
}
}
PaymentInitializationResponse
{
"type": "object",
"properties": {
"respCode": {
"type": "string",
"nullable": true
},
"respDesc": {
"type": "string",
"nullable": true
},
"initialization": {
"$ref": "#/components/schemas/PaymentInitialization"
}
}
}
PaymentItem
{
"type": "object",
"properties": {
"code": {
"type": "string",
"nullable": true
},
"name": {
"type": "string",
"nullable": true
},
"price": {
"type": "number",
"format": "double"
},
"quantity": {
"type": "integer",
"format": "int32"
}
}
}
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"
}
}
}
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
}
}
}
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"
}
}
}
PaymentNonRedirectResponse
{
"type": "object",
"properties": {
"respCode": {
"type": "string",
"nullable": true
},
"respDesc": {
"type": "string",
"nullable": true
},
"invoiceNo": {
"type": "string",
"nullable": true
},
"channelCode": {
"type": "string",
"nullable": true
}
}
}
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"
}
}
}
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
}
}
}
PaymentOptionDetailsCustomData
{
"type": "object",
"properties": {
"data": {
"type": "string",
"nullable": true
},
"type": {
"type": "string",
"nullable": true
},
"sequenceNo": {
"type": "integer",
"format": "int32"
}
}
}
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"
}
}
}
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"
}
}
}
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": {}
}
}
}
PaymentOptionDetailsPaymentCode
{
"type": "object",
"properties": {
"agentCode": {
"type": "string",
"nullable": true
},
"channelCode": {
"type": "string",
"nullable": true
},
"agentChannelCode": {
"type": "string",
"nullable": true
}
}
}
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"
}
}
}
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"
}
}
}
PaymentOptionDetailsValidation
{
"type": "object",
"properties": {
"cardNo": {
"$ref": "#/components/schemas/PaymentOptionDetailsValidationCard"
},
"cardTypes": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PaymentOptionDetailsValidationCardType"
},
"nullable": true
}
}
}
PaymentOptionDetailsValidationCard
{
"type": "object",
"properties": {
"regex": {
"type": "string",
"nullable": true
},
"prefixes": {
"type": "array",
"items": {
"type": "string"
},
"nullable": true
}
}
}
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"
}
}
}
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"
}
}
}
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"
}
}
}
PaymentParamsRequestV43
{
"type": "object",
"properties": {
"code": {
"$ref": "#/components/schemas/PaymentOptionDetailsPaymentCode"
},
"data": {
"$ref": "#/components/schemas/PaymentParamsDataRequestV43"
}
}
}
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
}
}
}
PaymentResponse
{
"type": "object",
"properties": {
"respCode": {
"type": "string",
"nullable": true
},
"respDesc": {
"type": "string",
"nullable": true
},
"channelCode": {
"type": "string",
"nullable": true
}
}
}
PaymentResponseBase
{
"type": "object",
"properties": {
"respCode": {
"type": "string",
"nullable": true
},
"respDesc": {
"type": "string",
"nullable": true
}
}
}
PaymentUserPreference
{
"type": "object",
"properties": {
"preference": {
"$ref": "#/components/schemas/UserPreference"
},
"paymentChannels": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PaymentChannelPreference"
},
"nullable": true
}
}
}
PaymentUserPreferenceResponse
{
"type": "object",
"properties": {
"user": {
"$ref": "#/components/schemas/PaymentUserPreference"
},
"respCode": {
"type": "string",
"nullable": true
},
"respDesc": {
"type": "string",
"nullable": true
},
"paymentToken": {
"type": "string",
"nullable": true
}
}
}
PodInfoProviderMerchantDetails
{
"type": "object",
"properties": {
"id": {
"type": "string",
"nullable": true
},
"name": {
"type": "string",
"nullable": true
},
"countryCode": {
"type": "string",
"nullable": true
}
}
}
PodInfoProviderTransactionDetails
{
"type": "object",
"properties": {
"amount": {
"type": "number",
"format": "double"
},
"invoiceNo": {
"type": "string",
"nullable": true
},
"description": {
"type": "string",
"nullable": true
},
"currencyCode": {
"type": "string",
"nullable": true
}
}
}
Recurring
{
"type": "object",
"properties": {
"count": {
"type": "integer",
"format": "int32"
},
"amount": {
"type": "string",
"nullable": true
},
"interval": {
"type": "integer",
"format": "int32"
},
"chargeOnDate": {
"type": "string",
"nullable": true
},
"chargeNextDate": {
"type": "string",
"nullable": true
}
}
}
RedirectBackEndPostPaymentRedirectRequest
{
"type": "object",
"properties": {
"isLeaveApp": {
"type": "string"
},
"paymentResponse": {
"type": "string"
}
}
}
RedirectFrontEndPostPaymentRedirectRequest
{
"type": "object",
"properties": {
"isLeaveApp": {
"type": "string"
},
"payResponse": {
"type": "string"
}
}
}
ResponsePaymentChannel
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"nullable": true
},
"code": {
"type": "string",
"nullable": true
},
"name": {
"type": "string",
"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
}
}
}
TransactionDetails
{
"type": "object",
"properties": {
"amount": {
"type": "string",
"nullable": true
},
"dateTime": {
"type": "string",
"nullable": true
},
"invoiceNo": {
"type": "string",
"nullable": true
},
"recurring": {
"$ref": "#/components/schemas/Recurring"
},
"showFxRate": {
"type": "boolean"
},
"description": {
"type": "string",
"nullable": true
},
"currencyCode": {
"type": "string",
"nullable": true
},
"paymentItems": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PaymentItem"
},
"nullable": true
}
}
}
TransactionStatusAdditionalInfo
{
"type": "object",
"properties": {
"merchantDetails": {
"$ref": "#/components/schemas/TransactionStatusMerchant"
},
"transactionDetails": {
"$ref": "#/components/schemas/TransactionStatusInfo"
},
"paymentResultDetails": {
"$ref": "#/components/schemas/TransactionStatusPayment"
}
}
}
TransactionStatusInfo
{
"type": "object",
"properties": {
"data": {
"type": "string",
"nullable": true
},
"amount": {
"type": "string",
"nullable": true
},
"dateTime": {
"type": "string",
"nullable": true
},
"agentCode": {
"type": "string",
"nullable": true
},
"invoiceNo": {
"type": "string",
"nullable": true
},
"channelCode": {
"type": "string",
"nullable": true
},
"description": {
"type": "string",
"nullable": true
},
"currencyCode": {
"type": "string",
"nullable": true
},
"interestRate": {
"type": "number",
"format": "double",
"nullable": true
},
"interestType": {
"type": "string",
"nullable": true
},
"loyaltyPoints": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TransactionStatusLoyaltyInfo"
},
"nullable": true
},
"monthlyPayment": {
"type": "string",
"nullable": true
},
"payLaterPeriod": {
"type": "integer",
"format": "int32",
"nullable": true
},
"installmentPeriod": {
"type": "integer",
"format": "int32",
"nullable": true
},
"ippAdditionalInfo": {
"type": "string",
"nullable": true
},
"remainderChargeMode": {
"type": "string",
"nullable": true
},
"remainderChargeAmount": {
"type": "number",
"format": "double",
"nullable": true
}
}
}
TransactionStatusLoyaltyInfo
{
"type": "object",
"properties": {
"rewards": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TransactionStatusRewards"
},
"nullable": true
},
"redeemAmount": {
"type": "number",
"format": "double"
},
"paymentScheme": {
"type": "string",
"nullable": true
}
}
}
TransactionStatusMerchant
{
"type": "object",
"properties": {
"name": {
"type": "string",
"nullable": true
},
"email": {
"type": "string",
"nullable": true
},
"address": {
"type": "string",
"nullable": true
},
"logoUrl": {
"type": "string",
"nullable": true
}
}
}
TransactionStatusPayment
{
"type": "object",
"properties": {
"code": {
"type": "string",
"nullable": true
},
"description": {
"type": "string",
"nullable": true
},
"autoRedirect": {
"type": "boolean"
},
"frontendReturnUrl": {
"type": "string",
"nullable": true
},
"frontendReturnData": {
"type": "string",
"nullable": true
},
"redirectImmediately": {
"type": "boolean"
},
"autoRedirectionTimer": {
"type": "integer",
"format": "int32"
}
}
}
TransactionStatusRequest
{
"type": "object",
"required": [
"paymentToken"
],
"properties": {
"locale": {
"type": "string",
"nullable": true
},
"clientID": {
"type": "string",
"format": "uuid"
},
"paymentToken": {
"type": "string"
},
"additionalInfo": {
"type": "boolean"
},
"browserDetails": {
"$ref": "#/components/schemas/BrowserDetails"
}
}
}
TransactionStatusResponse
{
"type": "object",
"properties": {
"locale": {
"type": "string",
"nullable": true
},
"respCode": {
"type": "string",
"nullable": true
},
"respDesc": {
"type": "string",
"nullable": true
},
"invoiceNo": {
"type": "string",
"nullable": true
},
"channelCode": {
"type": "string",
"nullable": true
},
"additionalInfo": {
"$ref": "#/components/schemas/TransactionStatusAdditionalInfo"
}
}
}
TransactionStatusRewards
{
"type": "object",
"properties": {
"name": {
"type": "string",
"nullable": true
},
"type": {
"type": "string",
"nullable": true
},
"price": {
"type": "number",
"format": "double"
},
"amount": {
"type": "number",
"format": "double"
},
"quantity": {
"type": "number",
"format": "double"
},
"totalPrice": {
"type": "number",
"format": "double"
},
"totalAmount": {
"type": "number",
"format": "double"
}
}
}
UserDetails
{
"type": "object",
"properties": {
"address": {
"$ref": "#/components/schemas/CustomerAddress"
}
}
}
UserPreference
{
"type": "object",
"properties": {
"name": {
"type": "string",
"nullable": true
},
"email": {
"type": "string",
"nullable": true
},
"locale": {
"type": "string",
"nullable": true
},
"mobileNo": {
"type": "string",
"nullable": true
},
"countryCode": {
"type": "string",
"nullable": true
},
"currencyCode": {
"type": "string",
"nullable": true
},
"mobileNoPrefix": {
"type": "string",
"nullable": true
}
}
}