Visa Stop Payment Service API Reference
Visa Stop Payment Service
Visa Stop Payment Service API
Add MCC v1 - Latest
Request
Request Body schema: application/json
| duration required |
integer The number of months the stop instruction will be active for. The end date will be set, to be the startDate + duration and rounded to the end of that month. Example: 13 |
| merchantCategoryCodes required |
Array of strings [ 1 .. 10 ] items unique List of merchant category codes. For each element, a separate stop instruction will be created. Example: ["0799","1001","5555"] |
| pan required |
string [ 16 .. 19 ] characters Account number, should be a valid Visa PAN Example: "4111111111111111" |
| startDate required |
string The date when the stop instruction will become active. Date must be today or up to 13 months from today. Date will be in the format yyyy-mm-dd. |
| additional | object Optional. This is a parent attribute. |
| --- | --- |
| additionalNotes | string [ 0 .. 1024 ] characters Optional field for providing additional notes about the stop instruction. Should not contain any scripting tags Example: "Notes entered by the user" |
| paymentFrequency | string Optional field for providing information about the stop instruction Enum:"One off" "Weekly" "Monthly" "Quarterly" "Biannual" "Annual" "Other" Example: "One off" |
Responses
200
Successful operation
Response Schema: application/json
| responseCode required |
string Required. Valid values - '00', '01', '02' Enum:"00" "01" "02" Example: "01" |
| responseDescription required |
string Required. Valid values - 'Success', 'Partial Success', 'Error' Enum:"Success" "Partial Success" "Error" Example: "Partial Success" |
| stopInstructions required |
Array of objects List of stop instructions processed Example: [{"result":{"resultCode":"00","resultMessage":"Success"},"stopInstructionId":"90","merchantCategoryCode":"0799"},{"result":{"resultCode":"01","resultMessage":"Duplicate"},"merchantCategoryCode":"1111","conflictingStopInstructionId":"456767690"},{"result":{"resultCode":"00","resultMessage":"Success"},"stopInstructionId":"1234568","merchantCategoryCode":"2345"}] |
| Array |
| merchantCategoryCode required |
string 4 characters Example: "0799" |
| result required |
object An object describing if the result was successful, or not |
| --- | --- |
| resultCode required |
string 2 characters A code representing the result. 00 means success Example: "00" |
| resultMessage required |
string A message explaining the result Example: "Success" |
| conflictingStopInstructionId | string [ 1 .. 19 ] characters If creating this stop instruction would have resulted in a conflict, the conflicting stop instruction Id will be returned Example: "12344" |
| stopInstructionId | string [ 1 .. 19 ] characters Generated stop instruction id if the stop instruction was created successfully. No stopInstructionId will be returned if creationg failed Example: "456767690" |
400
Bad request
Response Schema: application/json
| errors | Array of objects Shows a list of errors. |
| Array |
| description | string The reason why it is in error Example: "Pan is not valid" |
| field | string The field in the request which is causing the error Example: "pan" |
| guid | string A unique identifer that can be used to track errors Example: "05eab1ab-ddb5-45a0-b70a-6e52847d1eab" |
| httpStatus | string A description of the http status code Example: "Bad Request" |
403
Forbidden
Request samples
- Payload
{"duration": 60,
"merchantCategoryCodes": ["0799"],
"pan": "4395842407255900",
"startDate": "2022-08-01"}
Response samples
- 200
{"responseDescription": "Success",
"stopInstructions": [{"result": {"resultCode": "00",
"resultMessage": "Success"},
"stopInstructionId": "987654321",
"merchantCategoryCode": "0799"}],
"responseCode": "00"}
- 400