Support

Processors

Processors are a group of variables that are demanded to be configured in order to communicate to the banks and card brand systems. Each processor demands different data to be filled, so the schema on processor creation varies accordingly to which processor your business is going to be using. In order to start using our gateway, you need to have at least one Processor record in place.

List all processors

GET https://gateway-api.paycertify.com/api/processors

This endpoint lists all processors previously entered through the UI. Pagination is available to navigate through record sets. Pagination information can be found on meta response field. The pages always return 50 records at a time. While using reporting capabilities, make sure to monitor rate limits through X-RateLimit-Limit and X-RateLimit-Remaining response headers.

Parameter Type Length Description Default Example
processors.*.id uuid 36 This processor’s ID – 41f00869-d7b3-413e-9476-9ef1a8bc2f28
processors.*.merchant_id uuid 36 The user’s merchant ID – 41f00869-d7b3-413e-9476-9ef1a8bc2f28
processors.*.mode string 4-5 If the processor is live or under test mode test live
processors.*.mid_number string 1-25 Merchant Identification Number – 888000541200
processors.*.alias string 1-50 An alias given to identify this processor – LOS GATOS STORE TERMINAL #1
processors.*.processor_type string 1-20 The processor integrator name – tsys
processors.*.mcc string 4 Merchant Classification Code – 1234
processors.*.industry string 1-20 The industry for this processor ecommerce ecommerce
processors.*.email_required boolean – If the email is required during transaction request false true
processors.*.address_required boolean – If the address fields are required during transaction request false true
processors.*.phone_required boolean – If the phone is required during transaction request false true
processors.*.name_required boolean – If the name is required during transaction request false true
processors.*.currency string 3 The processor supported currency USD USD
processors.*.enabled boolean – If the processor is active true false
processors.*.transaction_duplicates_block_interval integer – The interval in seconds considered in the Velocity Control 1800 3600
processors.*.transaction_duplicates_block_fields string 1-255 Transaction request fields separated by comma (,) to be used on the Velocity Control See [1] zip,country
processors.*.auto_capture boolean – If the Auto Capture for authorizations is enabled false true
meta.last_page number - The last page for this query 1  
meta.current_page number - The current page for this query 1  
meta.total number - The total count of records for this page 1   
curl --request GET \
  --url 'https://gateway-api.paycertify.com/api/processors' \
  --header 'Authorization: Bearer EE9DC8DB823EF153186B9B3F2702DE378ACC2254' \
  --header 'Cache-Control: no-cache'

Responds with:

{
    "processors": [
        {
            "id": "ef7d010c-aeec-4dea-bbea-c89c4452b795",
            "merchant_id": "544ab96b-187a-4103-ac4b-247064856f1b",
            "mode": "live",
            "mid_number": "123123123",
            "alias": "LIVE PROCESSOR",
            "processor_type": "tsys",
            "mcc": "1234",
            "industry": "ecommerce",
            "acquirer_bin": "123123",
            "store_number": "1234",
            "terminal_number": "1234",
            "agent_bank_number": "123123",
            "agent_chain_number": "123123",
            "v_number": "12312312",
            "timezone_differential": "123",
            "merchant_name": "123",
            "merchant_city": "123",
            "merchant_state": "ca",
            "merchant_website": "1sadc.com",
            "merchant_phone": "123-1231234",
            "merchant_zip": "12345",
            "merchant_location_number": "12345",
            "level2_tax_percentage": null,
            "email_required": true,
            "address_required": true,
            "phone_required": true,
            "name_required": true,
            "currency": "USD",
            "enabled": true,
            "transaction_duplicates_block_interval": 1800,
            "transaction_duplicates_block_fields": "first_name,last_name,card_number,card_cvv,cvv,account_number,check_number,amount,street_address_1,street_address_2,city,state,zip,country",
            "auto_capture": false
        },
        {
            "id": "9b10b4b4-7752-40fd-9d9c-cb300c65b713",
            "merchant_id": "544ab96b-187a-4103-ac4b-247064856f1b",
            "mode": "test",
            "mid_number": "888000541200",
            "alias": "SOMETHING ELSE",
            "processor_type": "tsys",
            "mcc": "5999",
            "industry": "ecommerce",
            "acquirer_bin": "999995",
            "store_number": "5999",
            "terminal_number": "1515",
            "agent_bank_number": "000000",
            "agent_chain_number": "111111",
            "v_number": "76248476",
            "timezone_differential": "107",
            "merchant_name": "paycertify",
            "merchant_city": "Los Gatos",
            "merchant_state": "CA",
            "merchant_website": "test.com",
            "merchant_phone": "480-1231234",
            "merchant_zip": "85284",
            "merchant_location_number": "00001",
            "level2_tax_percentage": null,
            "email_required": true,
            "address_required": true,
            "phone_required": true,
            "name_required": true,
            "currency": "USD",
            "enabled": true,
            "transaction_duplicates_block_interval": 1800,
            "transaction_duplicates_block_fields": "first_name,last_name,card_number,card_cvv,cvv,account_number,check_number,amount,street_address_1,street_address_2,city,state,zip,country",
            "auto_capture": false
        }
    ]
}

[1] Default value: first_name,last_name,card_number,card_cvv,cvv,account_number,check_number,amount,street_address_1,street_address_2,city,state,zip,country.