Request
Curl
Response
Response
Parameters
status optional
: enum Indicates the VPA and payment source linking status. Possible values:
activeinactive
skip optional
: integer The number of entities to skip. Default is 0. You can use this parameter for pagination in combination with skip.
count optional
: integer The number of entities to fetch. Default is 10. You can use this for pagination in combination with count.
Parameters
entity
: string This refers to the collection of entity. Here, it is collection.
count
: integer Indicates the number of items in the entity type.
items
: array Indicates a list of objects.
id
: string A unique identifier of the entity.
entity
: string Name of the entity.
mobile
: string The mobile number of customer.
address
: string The address of the customer.
status
: string The status of the VPA linked to the payment source. Possible values:
activeinactive
fundsources
: object Payment source details.
entity
: string The entity type.
count
: integer Indicates number of item in the entity type.
items
: object The items object.
id
: string The unique identifier of the payment source.
customer_name
: string Name of the customer.
masked_account_number
: string The masked account number.
account_reference_number
: string The account reference number.
type
: enum Type of the payment source. Possible values:
savingscurrentnon_resident_ordinarynon_resident_externalsecured_overdraftcreditppi
ifsc
: string IFSC of the payment source.
upi_pin_set
: boolean Indicates if the UPI PIN is set for payment source. Possible values:
true: UPI PIN is set.false: UPI PIN is not set.
upi_pin_length
: integer Indicates the length of the UPI PIN allowed for the payment source.
otp_length
: integer Indicates the length of the OTP allowed for the payment source.
atm_pin_length
: integer Indicates the length of the ATM PIN allowed for the payment source.
fundsource_provider
: object The payment source provider details.
upi_iin
: string The UPI Issuer Identification Numbers (IIN) of the payment source provider issued by NPCI.
name
: string Name of the payment source (bank account) provider.
upi_enabled
: boolean Indicates if the provider has UPI enabled. Possible values:
true: UPI is enabled.false: UPI is not enabled.
mobile_registration_format
: string The format as defined by NPCI - format1, format2 and so on.
logo_url
: string The URL of the bank logo.
primary
: boolean Indicates if the VPA is linked to the payment source marked as primary. Possible values:
true: VPA is linked to the payment source.false: VPA is not linked to the payment source.