Visa Pay API Reference

Visa Pay

Search API Reference

Getting Started
Request & Response Codes
API Reference
- Visa Pay
  - patchUpdate Enrollment Data
  - postGet Basic Authentication Access Token
  - patchBlock and Unblock Token
  - getGet Visa Pay Account
  - patchBlock and Unblock Account
  - postReplenish HCE Keys
  - postEnroll Visa Pay Account
  - postRetrieve Cryptogram Data
  - postRequest Additional Tokens
  - postAuthorization Callback - Outbound
  - postGet OpenID Access Token

Visa Pay

Visa Pay API is not hosted in VDP. For sandbox access, you must use the domain: sandbox.visapay.visa.com

Update Enrollment Data v1

Update client wallet enrollment data (phone number, e-mail, etc.)

Request

path Parameters


externalId required	any External ID of the enrollment to be updated (wallet_account_id).

query Parameters


programId required	any Program ID to which the enrollment belongs.

header Parameters


Content-Type required	any Default: application/json Content type of the request/response
x-tenant required	any Tenant ID

Request Body schema: application/json


program_id required	any Program ID Example: 16805
wallet_data required	object Wallet data.

---	---
account_id required	string <= 15 characters Wallet account ID Example: "123456"
customer_id	string <= 100 characters Customer ID
document_number	any Document number Example: "123456789"
email_id	string <= 100 characters Email address Example: "user@example.com"
full_name	string <= 60 characters Full name of the user Example: "John Doe"
phone	object

---	---
country_code	string <= 5 characters Country code (0 to 99999) Example: "1"
phone_number	string <= 15 characters Phone number Example: "11111111"
user_name	string <= 64 characters Username Example: "johndoe"

Responses

200 Enrollment updated successfully

Response Schema: application/json


message	any Example: "success"

400 Bad request error

Response Schema: application/json


code	any Error code. Example: "INVALID_REQUEST"
message	any Error message. Example: "The request payload is invalid"

404 Enrollment not found

Response Schema: application/json


code	any Error code. Example: "NOT_FOUND"
message	any Error message. Example: "The entity with provided key was not found."

500 Internal server error

Response Schema: application/json


code	any Error code. Example: "INTERNAL_ERROR"
message	any Error message. Example: "An internal error occurred."

Sandbox server

https://sandbox.api.visa.com/v1/enrollments/{external-id}

Request samples

Payload

application/json

{"program_id": 16805,
  
"wallet_data": {"phone": {"country_code": "1",
  
"phone_number": "11111111"},

"email_id": "user@example.com",

"full_name": "John Doe",

"user_name": "johndoe",

"account_id": "123456",

"customer_id": "string",

"document_number": "123456789"}}

Response samples

application/json

{"message": "success"}