REST API Specifications


Introduction

We created a complete and detailed description of the Platform API. Here you can find all parameter descriptions.


Hosts

  • Test:
  • Live:

Request Parameters

This reference lists all the standard flow parameters to be send in request.

Parameter Description Format Required
walletOwnerId Provided by Paymentz Unique id. N20
[0-9]
Yes
token Provided by Paymentz Unique token. String Yes
country_code User country code eg: 91. A3
[0-9]
Yes
cust_contact User contact number. N10
[0-9]{10}
Yes
cust_email User email id. AN255
[a-zA-Z0-9] {255}
Yes
cust_password Set user password. AN8
[A-Za-z0-9] {1,8}
Yes
account_type Sign up as Customer/Merchant. A255
[a-zA-z] {255}
Yes
secKey Generated secret key for per user. String Yes
deviceId User's Mobile device id. String Yes
platformId App platform Id Android-1 and iOS-2. AN2048
[0-9]
Yes

custCurrency Set currency for user. AN2048
[0-9]
Yes

custFirstName Set user's first name. A Yes

custLastName Set user's last name. A Yes

custDOB Set user's date of birth. N
[0-9]
Yes

custCountry Set user's country. A
[0-9]
Yes

isTosOfTWAccepted Terms and conditions accepted (true or false). A255 Yes

termsConsent Terms of consents. A255 Yes

cust_id Generated unique customer id on per user sign up. A255 Yes

verificationHash Verification Hash has collected combination of parameters. String Yes

amount Amount of the transaction.. N
[0-9]
Yes

toMobile Receiver's mobile number (with country code eg.91) N
[0-9]
Yes

fromCurrency Sender's currency N
[0-9]
Yes

from_cust_id Sender's customer_id N
[0-9]
Yes

fromMobile Sender's mobile number (with country code eg.91) N
[0-9]
Yes

from_cust_name Sender's name A255 Yes

comment Description of the transaction AN
[0-9]
Conditional

fromCurrencyCode Sender's currency AN
[0-9]
Yes

isMoneyFromRequest Amount sent from pending list (set true) or directly from send money (set false) A255 Yes

requestId Amount sent from pending list pass request Id or pass 0 N
[0-9]
Yes

vendorName Amount sent to merchant (Merchant name) A255 Yes

vendorUserId Amount sent to merchant (Merchant user id) AN255
[a-zA-Z0-9] {255}
Yes

vendorUserPassword Amount sent to merchant (Merchant password) AN255
[a-zA-Z0-9] {255}
Yes

requestAmount Request amount to recipient N
[0-9]
Yes

requestComment Description of the requested amount AN255
[a-zA-Z0-9] {255}
Yes

fromCustid Sender's customer_id AN255
[0-9]
Yes

fromCustomerName Sender's name AN255
[a-zA-Z0-9] {255}
Yes

lastActivityId Activity List last id (If no id keep 0) N
[0-9]
Yes

lastTransactionId Transaction List last id (If no id keep 0) N
[0-9]
Yes

custId Generated unique customer id on per user sign up N
[0-9]
Yes

custEmail User's email id AN
[a-zA-Z0-9]
Yes

custEmail User's email id AN
[a-zA-Z0-9]
Yes

custName User's name A255 Yes

custMobile User's mobile number (with country code eg.91) N
[0-9]
Yes

currency User's currency A3
[0-9]{3}
Yes

paymentMode Payment method for paying amount. For ex: CC for Credit Cards AN32
[a-zA-Z0-9] {1,32}
Yes

paymentBrand Type of Card while placing the transaction.For ex: VISA, MC AN32
[a-zA-Z0-9] {1,32}
Yes

merchantTransactionId This reference number is provided by the merchant, should be unique for the transactions and is visible on the end customer’s statement. [.\\p[0-9a-zA-Z\\p{Space}\\-]{0,1024} Yes

descriptor Description of the transaction. AN255 Yes

customerEmail User's email id. AN255
[a-zA-Z0-9] {1,255}
Yes

customerId Generated unique customer id on per user sign up. N
[0-9]
Yes

customerContact User's mobile number (with country code eg.91). N
[0-9]
Yes

customerContact User's mobile number (with country code eg.91). N
[0-9]
Yes

transactionType Pass transaction type as LOAD/PURCHASE. A255 Yes

customerName User's name. A255 Yes

mobilePlatform Mobile device platform android/iOS. A255 Yes

customerFirstName User's first name. A255 Yes

customerLastName User's last name. A255 Yes

cardNumber User's Card number. N19
((4[0-9]{12}([0-9]{3}))|(5[1-5][0-9]{14}))
Yes

cardExpiryMonth Expiry month of the card. N2
([0-9])|(0[0-9])|(1[0-2])
Yes

cardExpiryYear Expiry year of the card. N4
((200[0-9])|(201[0-9])|(202[0-9]))
Yes

cardCvv 3 or 4 digits number on card to verify card details.. N4
[0-9]{3,4}
Yes

country Country of the user's A255
[A-Za-z]
Yes

city City of the user's AN50
[a-zA-Z0-9\\\\#&\\p{Space}\\p{L}\\p{M}\\-;.,~`/%$#@ ]{0,1000}
Yes

state State or region of the user's AN50
[\\ra-zA-Z0-9\\\\!@#$*%^&{}\\[\\]()_+\\p{L}\\p{M}\\-=,.~'` ]{0,1000}
Yes

postcode Postal code/ Zip code of the customer's shipping address. AN10
[A-Za-z0-9]{1,10}
Yes

street1 Building name, and/ or street name of the customer's shipping address. AN1000
[a-zA-Z0-9\\p{Space}\\,]+
Yes

loyaltyPoints Points to redeem. N
[0-9]
Yes

email User's email address. AN255
[a-zA-Z0-9]
Yes

title User's gender suffix (Mr or Mrs). A255
[a-zA-Z]
Yes

zip Postal code/ Zip code of the customer's shipping address. AN10
[A-Za-z0-9]{1,10}
Yes

ssn Social security number (US citizens). N9
[0-9{9}]
Yes

idProofType ID Proof type number (provided table). N9
[0-9{9}]
Yes

idDocumentNumber ID Document number of the user. AN255
[a-zA-Z0-9]
Yes

idIssuer ID Document issuer name or provider. AN255
[a-zA-Z0-9]
Yes

idIssuer ID Document issuer name or provider. AN255
[a-zA-Z0-9]
Yes

idIssueDate ID Document issue date. AN255
[A-Z0-9]
Yes

idExpriryDate ID Document expiry date AN255
[A-Z0-9]
Yes

countryCode ISO country code (provided table) N255
[0-9]
Yes

citizenshipCode ISO citizenship code N255
[0-9]
Yes

addressLine Building name, and/ or street name of the customer's shipping address. AN1000 [A-Za-z0-9]{1,1000} Yes

dateOfBirth User's date of birth N255 [0-9] Yes

mobileNumber User's mobile number (with country code eg.0091) N255 [0-9] Yes

cardType Card Type assigned to user for prepaid card (Personalized or Non-personalized) A Yes


Response Parameters

This reference list lists all the standard flow parameters to be received in response.

Parameter Description Format Required
isMerchant Create account for merchant if flag is enable(eg: 0 or 1). N20
[0-9]
Yes
currencyList Get list of currencies available for signup A3
[A-Z]{3}
Yes
status Response status (SUCCESS/FAILED). A
[A-Z]
Conditional
cust_id Generated unique customer id on per user sign up. N50
[0-9]{50}
Yes
secKey Generated secret key for per user. String Yes
amount Amount of the transaction. N50
[0-9] {1,50}
Yes
trackingId Unique Paymentz transaction Id for Load money operation. N50
[0-9] {50}
Yes
id Unique transaction id for each transaction. N50
[0-9] {50}
Yes
toCustName Receiver's Name of the verify user and currency. A255 [a-zA-Z] Yes
exchangeCurrency Sending amount to different currency will get the exchange currency amount. N50
[0-9]
Conditaional

toCurrencyCode Displays for different currency user's only. N50
[0-9]
Conditaional

to_cust_name Receiver's Name of the sent amount. A255
[a-zA-Z]
Yes

customerName Receiver's Name of the requested amount. A255 Yes

fromCustName Requested Pending list names. A255 Yes

narration Requested amount description from pending list. AN255
[0-9]
Conditaional

requestId Get request id from pending list for requested amount N255
[0-9]
Yes

activityType Gets the activity type for activities or operations performed in Activity logs. A255 Yes

toMobile Receiver's mobile number (with country code eg.91). N10
[0-9]
Yes

registeredTime Transactions or activities performed time. N50 Yes

statusDescription Transaction status description. A255 Conditaional

billingDescriptor Transaction descriptor A
[0-9]
Conditional

cardFirstSix User's Card number First six digits N6
[0-9]{6}
Yes

cardLastFour User's Card number Last four digits N4
0-9{4}
Yes

paymentMode Payment method for paying amount.
For ex: CC for Credit Cards
AN32
[a-zA-Z0-9] {1,32}
Yes

voucherNumber Will get voucher number on withdraw with voucher. N50
[0-9]
Conditional

PaymentModeResponse Payment modes list for withdraw A255 Yes

loyaltyPoints Points to redeem N50
[0-9]
Yes

loyaltyAmount Points redeemed converted to amount N50
[0-9]
Yes

cardToken Card token for prepaid card N100
[0-9]
Yes

nameOnCard Name on Prepaid Card A255
[a-zA-Z]
Yes

maskedCardNumber Prepaid Card number N50
[0-9]
Yes

expirationDate Prepaid card expiry date datetime Yes

expiration Prepaid card expiry month and year N50
[0-9]
Yes

cardStatus Prepaid Card status A255
[a-zA-Z]
Yes

cardProductType Prepaid Card product type (Virtual or physical) A255
[a-zA-Z]
Yes

cardType Prepaid Card card type (Personalized or non-personalized) A255
[a-zA-Z]
Yes

isPhysicalCardApplied Applied for physical prepaid card flag(eg. 0 or 1) N50
[0-9]
Yes

blockedAmount Amount blocked for prepaid card N50
[0-9]
Yes

transactionDetails Prepaid Card Transaction Details N
[0-9]
Yes

Transactions Prepaid card transactions list AN
[a-zA-Z0-9]
Yes

cardHolderDetails Prepaid card holder details AN
[a-zA-Z0-9]
Yes

Copyright © . All Rights Reserved