# 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<br>required | object<br>Acquirer institution details for payment processing |
| |     |     |
| --- | --- |
| acquirer_bin | string 6 characters ^[0-9]{6}$<br>Acquirer BIN - Bank Identification Number for file routing (exactly 6 digits)<br>Example: "123456" |
| destination_id | string <= 11 characters ^[0-9]{1,11}$<br>Destination ID - Unique institution identifier (numeric string, 1-11 digits)<br>Example: "12345678912" | |
| acquirer_processor<br>required | object<br>Acquirer Processor information for the supplier |
| |     |     |
| --- | --- |
| processor_id | string <= 10 characters <br>Unique identifier for the Acquirer Processor<br>Example: "8126" |
| processor_name | string<br>Name of the Acquirer Processor<br>Enum:"Vantiv CNP""TSYS""Chase Paymentech Salem""Chase Paymentech Tampa""FDI Global""SMARTFDC Nashville""Elavon""Woodforest National Bank""etc..."<br>Example: "Woodforest National Bank" |
| retrieval_reference | string <= 50 characters <br>Retrieval Reference value to identify the Processor for Transcard<br>Example: "600XXX0X1XXX" |
| transaction_date | string <date-time> <br>Transaction Date to identify the Processor for Transcard - Format MM/DD/YYYY HH:MM:SS | |
| currencies<br>required | Array of strings<br>Supported currency codes in ISO 4217 format (e.g., USD, EUR, GBP)<br>Example: ["USD"] |
| mcc<br>required | string 4 characters ^[0-9]{4}$<br>Merchant Category Code - 4-digit classification code<br>Example: "5411" |
| payment_types_supported<br>required | Array of strings<br>List of accepted payment card types. Valid value: VISA<br>Items Value:"VISA"<br>Example: ["VISA"] |
| supplier_id<br>required | object<br>Supplier identification details. At least one of originator_supp_id or primary_email_address must be present. |
| |     |     |
| --- | --- |
| primary_email_address<br>required | string <email>  <= 100 characters <br>AR manager email of the supplier (1-100 chars, valid email format, active email)<br>Example: "supplier1@armanager.com" |
| originator_supp_id | string <= 100 characters <br>Alphanumeric identifier for the supplier originator<br>Example: "SUPP001" | |
| bank_number | string <= 6 characters ^[0-9]{6}$<br>Bank identification number (6 digits)<br>Example: "123456" |
| chain_number | string <= 6 characters ^[0-9]{6}$<br>Chain store identifier for multi-location merchants (6 digits)<br>Example: "123456" |
| cpip_division | string <= 7 characters ^[0-9]{7}$<br>CPIP (Credit Payment Infrastructure Platform) division code (7 digits)<br>Example: "1234567" |
| cpip_sid | string <= 6 characters ^[0-9]{6}$<br>CPIP system identifier / Presenter ID (6 digits)<br>Example: "123456" |
| industry_code | string<br>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)<br>Enum:"0""A""B""D""F""G""H""L""O""P""R"<br>Example: "R (Retail)" |
| merchant_bin_number | string <= 6 characters ^[0-9]{6}$<br>Merchant Bank Identification Number (6 digits)<br>Example: "123456" |
| merchant_id | string <= 15 characters <br>Unique merchant identifier (up to 15 alphanumeric characters)<br>Example: "123456789123456" |
| merchant_location_number | string <= 5 characters ^[0-9]{5}$<br>Specific location identifier for the merchant (5 digits, often with leading zeros)<br>Example: "00001" |
| store_id | string <= 10 characters <br>Store identifier for the merchant location (up to 10 alphanumeric characters)<br>Example: "1234" |
| terminal_id | string <= 8 characters <br>Terminal identifier for the merchant (up to 8 alphanumeric characters)<br>Example: "123456" |
| vital_number | string <= 8 characters ^7[0-9]{7}$<br>VITAL (Visa Integrated Transaction Accounting and Liability) processing number (8 digits with leading digit 7)<br>Example: "71234567" |

#### Responses

**200**
Request accepted and processed

##### Response Schema: application/json

|     |     |
| --- | --- |
| message<br>required | string<br>Human-readable message describing the status |
| status_code<br>required | string<br>Status code indicating the processing state<br>Enum:"1000""1002""1003""5000" |
| request_id | integer<br>Numeric identifier for the request (present for successful submissions) |

**400**
Validation error

##### Response Schema: application/json

|     |     |
| --- | --- |
| message<br>required | string<br>Error message describing what went wrong |
| status_code<br>required | string<br>Error code<br>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"
}`