VPA Fetch

4 min

Introduction

The provided curl command is an example of how to make a POST request to the Signzy API endpoint for fetching information related to a virtual payment address (VPA). This API is designed to be used by patrons who have an account with Signzy, and requires authentication using an access token.

The curl command includes several options to set headers for Accept, Accept-Language, Authorization, and Content-Type, and to send data in JSON format in the request body.

Sample Curl

curl --request POST \
  --url https://signzy.tech/api/v2/patrons/..your-patron-id../upis \
  --header 'Accept: */*' \
  --header 'Accept-Language: en-US,en;q=0.8' \
  --header 'Authorization: <Access-Token>' \
  --header 'content-type: application/json' \
  --data '{"task":"vpaFetch","essentials":{"vpa":"...vpa...","name":"...name...","fuzzy":"...fuzzy..."}}'

Parameter	Description
request	Specifies the HTTP method to use for the request. In this case, it is set to POST.
url	Specifies the URL for the API endpoint. Patrons must replace the ..your-patron-id.. placeholder in the URL with their actual patron ID.
header	Specifies one or more headers to include in the request. In this case, there are four headers: Accept, Accept-Language, Authorization, and Content-Type. Patrons must replace <Access-Token> in the Authorization header with their actual access token.
data	Specifies the data to be included in the request body. The data is provided as a JSON object with a task field set to vpaFetch, and an essentials field containing additional data about the payment address, such as the VPA, name, and fuzzy match string.

Sample Response

{
    "result": {
        "nameAtBank" : "..nameAtBank.."
        "verified":  "true/false";
        "message":  "Verification completed with positive results/Verification completed with negative results"
      }
    }

Parameter	Description
nameAtBank	The name associated with the bank account linked to the virtual payment address (VPA).
verified	Indicates whether the verification of the VPA was successful or not. It can be either true or false.
message	Provides additional information about the verification status of the VPA. The message can be one of two types: "Verification completed with positive results" or "Verification completed with negative results".