Visa Accounts Receivable Manager API Reference
Visa Accounts Receivable Manager
Visa AR Manager Onboarding Suite API
Visa AR Manager APIs for Onboarding Suite operations
Supplier Payment Configuration v1 - Latest
Configures acquiring details and establishes supplier preferences
Request
Request Body schema: application/json
Supplier management configuration request
| acquirer required |
object Acquirer institution details for payment processing |
| --- | --- |
| acquirer_bin | string 6 characters ^[0-9]{6}$ Acquirer BIN - Bank Identification Number for file routing (exactly 6 digits) Example: "123456" |
| destination_id | string <= 11 characters ^[0-9]{1,11}$ Destination ID - Unique institution identifier (numeric string, 1-11 digits) Example: "12345678912" |
| acquirer_processor required |
object Acquirer Processor information for the supplier |
| --- | --- |
| processor_id | string <= 10 characters Unique identifier for the Acquirer Processor Example: "8126" |
| processor_name | string Name of the Acquirer Processor Enum:"Vantiv CNP""TSYS""Chase Paymentech Salem""Chase Paymentech Tampa""FDI Global""SMARTFDC Nashville""Elavon""Woodforest National Bank""etc..." Example: "Woodforest National Bank" |
| retrieval_reference | string <= 50 characters Retrieval Reference value to identify the Processor for Transcard Example: "600XXX0X1XXX" |
| transaction_date | string Transaction Date to identify the Processor for Transcard - Format MM/DD/YYYY HH:MM:SS |
| currencies required |
Array of strings Supported currency codes in ISO 4217 format (e.g., USD, EUR, GBP) Example: ["USD"] |
| mcc required |
string 4 characters ^[0-9]{4}$ Merchant Category Code - 4-digit classification code Example: "5411" |
| payment_types_supported required |
Array of strings List of accepted payment card types. Valid value: VISA Items Value:"VISA" Example: ["VISA"] |
| supplier_id required |
object Supplier identification details. At least one of originator_supp_id or primary_email_address must be present. |
| --- | --- |
| primary_email_address required |
string AR manager email of the supplier (1-100 chars, valid email format, active email) Example: "supplier1@armanager.com" |
| originator_supp_id | string <= 100 characters Alphanumeric identifier for the supplier originator Example: "SUPP001" |
| bank_number | string <= 6 characters ^[0-9]{6}$ Bank identification number (6 digits) Example: "123456" |
| chain_number | string <= 6 characters ^[0-9]{6}$ Chain store identifier for multi-location merchants (6 digits) Example: "123456" |
| cpip_division | string <= 7 characters ^[0-9]{7}$ CPIP (Credit Payment Infrastructure Platform) division code (7 digits) Example: "1234567" |
| cpip_sid | string <= 6 characters ^[0-9]{6}$ CPIP system identifier / Presenter ID (6 digits) Example: "123456" |
| industry_code | string Merchant industry classification code. Valid values: 0 (unknown), A (auto rental), B (bank/financial), D (direct marketing), F (food/restaurant), G (grocery), H (hotel), L (limited amount terminal), O (oil company), P (passenger transport), R (retail) Enum:"0""A""B""D""F""G""H""L""O""P""R" Example: "R (Retail)" |
| merchant_bin_number | string <= 6 characters ^[0-9]{6}$ Merchant Bank Identification Number (6 digits) Example: "123456" |
| merchant_id | string <= 15 characters Unique merchant identifier (up to 15 alphanumeric characters) Example: "123456789123456" |
| merchant_location_number | string <= 5 characters ^[0-9]{5}$ Specific location identifier for the merchant (5 digits, often with leading zeros) Example: "00001" |
| store_id | string <= 10 characters Store identifier for the merchant location (up to 10 alphanumeric characters) Example: "1234" |
| terminal_id | string <= 8 characters Terminal identifier for the merchant (up to 8 alphanumeric characters) Example: "123456" |
| vital_number | string <= 8 characters ^7[0-9]{7}$ VITAL (Visa Integrated Transaction Accounting and Liability) processing number (8 digits with leading digit 7) Example: "71234567" |
Responses
200 Request accepted and processed
Response Schema: application/json
| message required |
string Human-readable message describing the status |
| status_code required |
string Status code indicating the processing state Enum:"1000""1002""1003""5000" |
| request_id | integer Numeric identifier for the request (present for successful submissions) |
400 Validation error
Response Schema: application/json
| message required |
string Error message describing what went wrong |
| status_code required |
string Error code Enum:"4001""4002""4003""4004""5001" |
500 Internal server error
Response Schema: application/json
Request samples
- Payload
`{"mcc": "5411",
"acquirer": {"acquirer_bin": "123456",
"destination_id": "12345678912"
},
"cpip_sid": "123456",
"store_id": "1234",
"currencies": ["USD"],
"bank_number": "123456",
"merchant_id": "123456789123456",
"supplier_id": {"originator_supp_id": "SUPP001",
"primary_email_address": "supplier1@armanager.com"
},
"terminal_id": "123456",
"chain_number": "123456",
"vital_number": "71234567",
"cpip_division": "1234567",
"industry_code": "R (Retail)",
"acquirer_processor": {"processor_id": "8126",
"processor_name": "Woodforest National Bank",
"transaction_date": "2019-08-24T14:15:22Z",
"retrieval_reference": "600XXX0X1XXX"
},
"merchant_bin_number": "123456",
"payment_types_supported": ["VISA"],
"merchant_location_number": "00001" }`
Response samples
- 200
- 400
- 500
`{"message": "Supplier management configuration request is enqueued",
"request_id": 123456789,
"status_code": "1000" }`