Skip to main content
Use this endpoint to create a new UPI Number or port a mobile number to a new VPA.

Request

Curl

Response

Response

Parameters

upi_number mandatory : string The UPI number to check for availability (mobile or numeric id). vpa mandatory : string VPA to which the UPI number has to be linked. action optional : string Action to be performed on UPI Number. Possible values:
  • create
  • port
existing_vpa optional : string VPA linked with the UPI number (Only in case of PORT). consent mandatory : boolean Consent of the user to create a new UPI Number or port a mobile number to a new VPA. Possible values:
  • true: The user has given the consent.
  • false: The user has not given the consent.

Parameters

entity : string Collection of entity. Here it is upi_number. upi_transaction_id : string Unique transaction id created by the originator. upi_number : string Unique id mapped to the customer’s VPA. type : string Type of number. For example, mobile or numeric. status : string Status of the UPI number. Possible values:
  • initiated
  • active
vpa : string VPA linked to the UPI number.