openapi-directory

Version:

Building & bundling https://github.com/APIs-guru/openapi-directory for easy use from JS

github.com/httptoolkit/openapi-directory-js

1 lines • 86.1 kB

JSON

{"openapi":"3.0.0","info":{"contact":{"x-twitter":"qualpay"},"description":"This document describes the Qualpay Payment Gateway API.","license":{"name":"Apache 2.0","url":"http://www.apache.org/licenses/LICENSE-2.0.html"},"title":"Qualpay Payment Gateway","version":"1.7","x-apisguru-categories":["ecommerce"],"x-logo":{"url":"https://twitter.com/qualpay/profile_image?size=original"},"x-origin":[{"format":"swagger","url":"https://api-test.qualpay.com/pg/doc","version":"2.0"}],"x-providerName":"qualpay.com"},"tags":[{"description":"Payment Gateway","name":"payment-gateway"},{"description":"PG Emulator","name":"pg-emulator"}],"paths":{"/ardef":{"post":{"description":"Get Card Type Information for Visa, Mastercard and Discover.","operationId":"Get Card Type Information ","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ArdefRequest"}}},"description":"Card Type Request","required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ArdefResponse"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PGApiResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PGApiResponse"}}}},"402":{"description":"Declined","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PGApiResponse"}}}},"409":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PGApiResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PGApiResponse"}}}},"509":{"description":"Timeout","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PGApiResponse"}}}}},"security":[{"basicAuth":[]}],"summary":"Card Type Information","tags":["payment-gateway"]}},"/auth":{"post":{"description":"An approved transaction will continue to be open until it expires or a capture message is received. Authorizations are automatically voided if they are not captured within 28 days, although most issuing banks will release the hold after 24 hours in retail environments or 7 days in card not present environments.","operationId":"Authorization","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PGApiTransactionRequest"}}},"description":"Payment Gateway Authorization Request","required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PGApiTransactionResponse"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PGApiResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PGApiResponse"}}}},"402":{"description":"Declined","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PGApiResponse"}}}},"409":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PGApiResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PGApiResponse"}}}},"509":{"description":"Timeout","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PGApiResponse"}}}}},"security":[{"basicAuth":[]}],"summary":"Authorize transaction","tags":["payment-gateway"]}},"/batchClose":{"post":{"description":"This message is used when the timing of the batch close needs to be controlled by the merchant rather than relying on the daily automatic batch close.","operationId":"Batch Close","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PGApiBatchCloseRequest"}}},"description":"Payment Gateway Batch Close Request","required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PGApiBatchCloseResponse"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PGApiResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PGApiResponse"}}}},"402":{"description":"Declined","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PGApiResponse"}}}},"409":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PGApiResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PGApiResponse"}}}},"509":{"description":"Timeout","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PGApiResponse"}}}}},"security":[{"basicAuth":[]}],"summary":"Close batch","tags":["payment-gateway"]}},"/capture/{pgIdOrig}":{"post":{"description":"A capture message may be completed for any amount up to the originally authorized amount.","operationId":"Capture","parameters":[{"description":"pgIdOrig","in":"path","name":"pgIdOrig","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PGApiCaptureRequest"}}},"description":"Payment Gateway Capture Request","required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PGApiCaptureResponse"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PGApiResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PGApiResponse"}}}},"402":{"description":"Declined","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PGApiResponse"}}}},"409":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PGApiResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PGApiResponse"}}}},"509":{"description":"Timeout","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PGApiResponse"}}}}},"security":[{"basicAuth":[]}],"summary":"Capture authorized transaction","tags":["payment-gateway"]}},"/credit":{"post":{"description":"A non-referenced credit requires that the cardholder data be provided in the message. This message is only available during the first 30 days of account production activity - the refund message should generally be used to return money to the cardholder.","operationId":"Credit","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PGApiTransactionRequest"}}},"description":"Payment Gateway Credit Request","required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PGApiTransactionResponse"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PGApiResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PGApiResponse"}}}},"402":{"description":"Declined","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PGApiResponse"}}}},"409":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PGApiResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PGApiResponse"}}}},"509":{"description":"Timeout","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PGApiResponse"}}}}},"security":[{"basicAuth":[]}],"summary":"Issue credit to cardholder","tags":["payment-gateway"]}},"/emailReceipt/{pgId}":{"post":{"description":"Sent the transaction receipt to multiple email addresses. Receipts can be sent only for successful transactions.","operationId":"Send Receipt","parameters":[{"description":"pgId","in":"path","name":"pgId","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PGApiEmailReceiptRequest"}}},"description":"Payment Gateway Email Receipt Request","required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PGApiEmailReceiptResponse"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PGApiResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PGApiResponse"}}}},"402":{"description":"Declined","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PGApiResponse"}}}},"409":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PGApiResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PGApiResponse"}}}},"509":{"description":"Timeout","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PGApiResponse"}}}}},"security":[{"basicAuth":[]}],"summary":"Send transaction receipt email","tags":["payment-gateway"]}},"/emulator/xml/v1/request.api":{"post":{"operationId":"emulatorHandlerUsingPOST","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"string"}},"*/*":{"schema":{"type":"string"}},"text/xml":{"schema":{"type":"string"}}}}},"security":[{"basicAuth":[]}],"summary":"emulatorHandler","tags":["pg-emulator"]}},"/force":{"post":{"description":"Can be used when an online authorization request received a 'declined' reason code and the merchant received an authorization from a voice or automated response (ARU) system. The required fields are the same as a sale or authorization request, except that the expiration date (exp_date) is not required, and the 6-character authorization code (auth_code) IS required.","operationId":"Force","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PGApiTransactionRequest"}}},"description":"Payment Gateway Force Request","required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PGApiTransactionResponse"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PGApiResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PGApiResponse"}}}},"402":{"description":"Declined","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PGApiResponse"}}}},"409":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PGApiResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PGApiResponse"}}}},"509":{"description":"Timeout","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PGApiResponse"}}}}},"security":[{"basicAuth":[]}],"summary":"Force transaction approval","tags":["payment-gateway"]}},"/refund/{pgIdOrig}":{"post":{"description":"Returns money to the cardholder from a previously captured transaction. Multiple refunds are allowed per captured transaction, provided that the sum of all refunds does not exceed the original captured transaction amount. Authorizations that have not been captured are not eligible for refund.","operationId":"Refund","parameters":[{"description":"pgIdOrig","in":"path","name":"pgIdOrig","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PGApiRefundRequest"}}},"description":"Payment Gateway Refund Request","required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PGApiRefundResponse"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PGApiResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PGApiResponse"}}}},"402":{"description":"Declined","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PGApiResponse"}}}},"409":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PGApiResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PGApiResponse"}}}},"509":{"description":"Timeout","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PGApiResponse"}}}}},"security":[{"basicAuth":[]}],"summary":"Refund previously captured transaction","tags":["payment-gateway"]}},"/sale":{"post":{"description":"This message will perform an authorization of the transaction, and if approved will immediately capture the transaction to be included in the next batch close. It is used in card present environments, and also card not present environments where no physical goods are being shipped.","operationId":"Sale","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PGApiTransactionRequest"}}},"description":"Payment Gateway Sale Request","required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PGApiTransactionResponse"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PGApiResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PGApiResponse"}}}},"402":{"description":"Declined","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PGApiResponse"}}}},"409":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PGApiResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PGApiResponse"}}}},"509":{"description":"Timeout","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PGApiResponse"}}}}},"security":[{"basicAuth":[]}],"summary":"Sale (Auth + Capture)","tags":["payment-gateway"]}},"/tokenize":{"post":{"description":"Once stored, a unique card identifier is returned for use in future transactions. Optionally, tokenization can be requested in an auth, verify, force, credit, or sale message by sending the tokenize field set to true.","operationId":"Tokenize","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PGApiTokenizeRequest"}}},"description":"Payment Gateway Tokenize Request","required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PGApiTokenizeResponse"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PGApiResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PGApiResponse"}}}},"402":{"description":"Declined","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PGApiResponse"}}}},"409":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PGApiResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PGApiResponse"}}}},"509":{"description":"Timeout","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PGApiResponse"}}}}},"security":[{"basicAuth":[]}],"summary":"Tokenize card","tags":["payment-gateway"]}},"/verify":{"post":{"description":"A verify message will return success if the cardholder information was verified by the issuer. If AVS or CVV data is included in the message, then the AVS or CVV result code will be returned in the response message.","operationId":"Verify","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PGApiVerifyRequest"}}},"description":"Payment Gateway Card Verify Request","required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PGApiVerifyResponse"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PGApiResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PGApiResponse"}}}},"402":{"description":"Declined","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PGApiResponse"}}}},"409":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PGApiResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PGApiResponse"}}}},"509":{"description":"Timeout","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PGApiResponse"}}}}},"security":[{"basicAuth":[]}],"summary":"Verify Card","tags":["payment-gateway"]}},"/void/{pgIdOrig}":{"post":{"description":"Authorizations can be voided at any time. Captured transactions can be voided until the batch is closed.","operationId":"Void","parameters":[{"description":"pgIdOrig","in":"path","name":"pgIdOrig","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PGApiVoidRequest"}}},"description":"Payment Gateway Void Request","required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PGApiVoidResponse"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PGApiResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PGApiResponse"}}}},"402":{"description":"Declined","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PGApiResponse"}}}},"409":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PGApiResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PGApiResponse"}}}},"509":{"description":"Timeout","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PGApiResponse"}}}}},"security":[{"basicAuth":[]}],"summary":"Void previously authorized transaction","tags":["payment-gateway"]}}},"servers":[{"url":"https://api-test.qualpay.com:443/pg"}],"components":{"securitySchemes":{"basicAuth":{"type":"http","scheme":"basic"}},"schemas":{"ArdefRequest":{"properties":{"card_number":{"description":"Format: Variable length, up to 19 N Description: Cardholder's card number.","example":"4111111111111111","type":"string"},"merchant_id":{"description":"Format: Variable length, up to 12 N Description: Unique identifier on the Qualpay system.","example":"<Provide merchant id that links to API Key>","format":"int64","type":"integer"}},"required":["card_number","merchant_id"],"type":"object"},"ArdefResponse":{"properties":{"funding":{"description":"Format: Fixed length, 1 AN Description: Funding type for a card type request submitted.<ul><li> C - Credit</li><li> D - Debit</li><li>P - Prepaid</li></ul>","example":"C","readOnly":true,"type":"string"},"ind_comm_level2":{"description":"Format: Fixed length, 1 AN Description: This field will be set to Y for Level 2 purchasing cards.","example":"Y","readOnly":true,"type":"string"},"ind_comm_level3":{"description":"Format: Fixed length, 1 AN Description: This field will be set to Y for Level 3 purchasing cards.","example":"Y","readOnly":true,"type":"string"},"issuer_country":{"description":"Format: Fixed length, 2 AN Description: Issuer Country for a card type request submitted.","example":"US","readOnly":true,"type":"string"},"pg_id":{"description":"Format: Fixed length, 32 AN Description: 32-byte unique identifier generated by the payment gateway, returned in all valid responses.","example":"d24ac6189b0b11e6966ca68d5edbef41","readOnly":true,"type":"string"},"rcode":{"description":"Format: Fixed length, 3 AN Description: Response code from the payment gateway. \"000\" indicates success. Refer to <a href=\"/developer/api/reference#api-response-codes\"target=\"_blank\">Platform API Response Codes</a> for entire list of Payment Gateway Response Codes.","example":"000","readOnly":true,"type":"string"},"rmsg":{"description":"Format: Variable length Description: Response text from the payment gateway.","example":"Approved T37500","readOnly":true,"type":"string"}},"type":"object"},"Customer":{"properties":{"billing_addr1":{"description":"Format: Variable length Description: Customer billing address street.","example":"123 Main Street","type":"string"},"billing_addr2":{"description":"Format: Variable length Description: Customer billing address, line 2.","example":"Suite #1234","type":"string"},"billing_city":{"description":"Format: Variable length Description: Customer billing city.","example":"San Mateo","type":"string"},"billing_country":{"description":"Format: Variable length Description: Customer billing country.","example":"USA","type":"string"},"billing_country_code":{"description":"Format: Fixed length, 3 N Description: ISO numeric country code for the billing address. Refer to <a href=\"/developer/api/reference#country-codes\"target=\"_blank\">Country Codes</a> for a list of country codes.","example":"840","type":"string"},"billing_state":{"description":"Format: Variable length Description: Customer billing state (abbreviated).","example":"CA","type":"string"},"billing_zip":{"description":"Format: Variable length Description: Customer billing zip code.","example":"94402","type":"string"},"billing_zip4":{"description":"Format: Fixed length, 4 N Description: Customer billing zip+4 code if applicable.","example":"1234","type":"string"},"customer_email":{"description":"Format: Variable length, up to 64 AN Description: Customer e-mail address.","example":"jsmith@somewhere.com","type":"string"},"customer_firm_name":{"description":"Format: Variable length, up to 64 AN Description: Customer Business name if applicable.","example":"Qualpay","type":"string"},"customer_first_name":{"description":"Format: Variable length, up to 32 AN Description: Customer first name.","example":"Joe","type":"string"},"customer_last_name":{"description":"Format: Variable length, up to 32 AN Description: Customer last name.","example":"Smith","type":"string"},"customer_phone":{"description":"Format: Variable length, up to 16 N Description: Customer phone number.","example":"6503885200","type":"string"},"shipping_addresses":{"description":"List of shipping addresses for customer.","items":{"$ref":"#/components/schemas/ShippingAddress"},"type":"array"}},"required":["customer_first_name","customer_last_name"],"type":"object"},"PGApiBatchCloseRequest":{"properties":{"developer_id":{"description":"Format: Variable length, up to 16 AN Description: Used to indicate which company developed the integration to the Qualpay Payment Gateway. This may also be used to provide the payment solution name that is connected to the Qualpay Payment Gateway.","example":"MyIntegration","type":"string"},"echo_fields":{"description":"Format: Variable length Description: This field contains a JSON array of field data that will be echoed back in the response message.","example":"[ {\"product\" : \"lawnmower\"},{\"purchase\" : \"1 yr maintenance\"} ]","type":"string"},"loc_id":{"description":"Format: Variable length, up to 4 N Description: When a merchant has more than one location using the same currency, this value is used to specify the specific location for this request.","example":"0001","type":"string"},"merchant_id":{"description":"Format: Variable length, up to 12 N Description: Unique identifier on the Qualpay system.","example":"<Provide merchant id that links to API Key>","format":"int64","type":"integer"},"profile_id":{"description":"Format: Fixed length, 20 N Description: Explicitly identifies which Payment Gateway profile should be used for the request.","example":"21200001000300000978","type":"string"},"report_data":{"description":"Format: Variable length Description: This field contains a JSON array of field data that will be included with the transaction data reported in Qualpay Manager.","example":"[ {\"shipping address\" : \"123 Main St.\"},{\"shipping city, state zip\" : \"San Mateo, CA 94402\"} ]","type":"string"},"retry_id":{"description":"Format: Variable length, up to 15 N Description: This field contains a merchant generated number used to identify the request. This value must be unique within the last 24 hours. When present, the payment gateway will use the retry_attempt to determine whether the message is new or a retry of a previous message.","example":1234,"format":"int64","type":"integer"},"session_id":{"description":"INTERNAL USE ONLY.","type":"string"},"tran_currency":{"description":"Format: Variable length, up to 3 N Default: 840 Description: ISO numeric currency code for the transaction. Refer to <a href=\"/developer/api/reference#country-codes\"target=\"_blank\">Country Codes</a> for a list of currency codes.","example":840,"format":"int32","type":"integer"},"user_id":{"description":"INTERNAL USE ONLY.","format":"int64","type":"integer"}},"required":["merchant_id"],"type":"object"},"PGApiBatchCloseResponse":{"properties":{"batch_info":{"description":"Format: Variable length Description: JSON array of JSON objects containing the batch close results by currency and location.","example":"[{\"profile_id\":\"97100001000300000978\",\"comment\":\"batch close failure; please try again\"},{\"profile_id\":\"97100001000300000124\",\"batch _number\":11, \"cnt_total\":12,\"amt_total\":- 588.15, \"tran_currency\":\"124\"}]","readOnly":true,"type":"string"},"echo_fields":{"description":"Format: Variable length Description: Data that was provided in echo_fields in the request.","example":"[ {\"product\" : \"lawnmower\"},{\"purchase\" : \"1 yr maintenance\"} ]","readOnly":true,"type":"string"},"pg_id":{"description":"Format: Fixed length, 32 AN Description: 32-byte unique identifier generated by the payment gateway, returned in all valid responses.","example":"d24ac6189b0b11e6966ca68d5edbef41","readOnly":true,"type":"string"},"rcode":{"description":"Format: Fixed length, 3 AN Description: Response code from the payment gateway. \"000\" indicates success. Refer to <a href=\"/developer/api/reference#api-response-codes\"target=\"_blank\">Platform API Response Codes</a> for entire list of Payment Gateway Response Codes.","example":"000","readOnly":true,"type":"string"},"rmsg":{"description":"Format: Variable length Description: Response text from the payment gateway.","example":"Approved T37500","readOnly":true,"type":"string"}},"type":"object"},"PGApiCaptureRequest":{"properties":{"amt_tran":{"description":"Format: Variable length, up to 12,2 N Description: Total amount to capture. The amount must be less than or equal to the authorized amount.","example":1193.5,"format":"double","type":"number"},"developer_id":{"description":"Format: Variable length, up to 16 AN Description: Used to indicate which company developed the integration to the Qualpay Payment Gateway. This may also be used to provide the payment solution name that is connected to the Qualpay Payment Gateway.","example":"MyIntegration","type":"string"},"echo_fields":{"description":"Format: Variable length Description: This field contains a JSON array of field data that will be echoed back in the response message.","example":"[ {\"product\" : \"lawnmower\"},{\"purchase\" : \"1 yr maintenance\"} ]","type":"string"},"loc_id":{"description":"Format: Variable length, up to 4 N Description: When a merchant has more than one location using the same currency, this value is used to specify the specific location for this request.","example":"0001","type":"string"},"merchant_id":{"description":"Format: Variable length, up to 12 N Description: Unique identifier on the Qualpay system.","example":"<Provide merchant id that links to API Key>","format":"int64","type":"integer"},"profile_id":{"description":"Format: Fixed length, 20 N Description: Explicitly identifies which Payment Gateway profile should be used for the request.","example":"21200001000300000978","type":"string"},"report_data":{"description":"Format: Variable length Description: This field contains a JSON array of field data that will be included with the transaction data reported in Qualpay Manager.","example":"[ {\"shipping address\" : \"123 Main St.\"},{\"shipping city, state zip\" : \"San Mateo, CA 94402\"} ]","type":"string"},"retry_id":{"description":"Format: Variable length, up to 15 N Description: This field contains a merchant generated number used to identify the request. This value must be unique within the last 24 hours. When present, the payment gateway will use the retry_attempt to determine whether the message is new or a retry of a previous message.","example":1234,"format":"int64","type":"integer"},"session_id":{"description":"INTERNAL USE ONLY.","type":"string"},"user_id":{"description":"INTERNAL USE ONLY.","format":"int64","type":"integer"},"vendor_id":{"description":"Format: Variable length, up to 12 N Description: Identifies the vendor to which this capture request applies.","example":212100026512,"format":"int64","type":"integer"}},"required":["amt_tran","merchant_id"],"type":"object"},"PGApiCaptureResponse":{"properties":{"echo_fields":{"description":"Format: Variable length Description: Data that was provided in echo_fields in the request.","example":"[ {\"product\" : \"lawnmower\"},{\"purchase\" : \"1 yr maintenance\"} ]","readOnly":true,"type":"string"},"pg_id":{"description":"Format: Fixed length, 32 AN Description: 32-byte unique identifier generated by the payment gateway, returned in all valid responses.","example":"d24ac6189b0b11e6966ca68d5edbef41","readOnly":true,"type":"string"},"rcode":{"description":"Format: Fixed length, 3 AN Description: Response code from the payment gateway. \"000\" indicates success. Refer to <a href=\"/developer/api/reference#api-response-codes\"target=\"_blank\">Platform API Response Codes</a> for entire list of Payment Gateway Response Codes.","example":"000","readOnly":true,"type":"string"},"rmsg":{"description":"Format: Variable length Description: Response text from the payment gateway.","example":"Approved T37500","readOnly":true,"type":"string"}},"type":"object"},"PGApiEmailReceiptRequest":{"properties":{"developer_id":{"description":"Format: Variable length, up to 16 AN Description: Used to indicate which company developed the integration to the Qualpay Payment Gateway. This may also be used to provide the payment solution name that is connected to the Qualpay Payment Gateway.","example":"MyIntegration","type":"string"},"email_address":{"description":" AN Description: An array of email addresses to which the transaction receipt should be sent to. ","example":"[\"jdoe@qualpay.com\", \"john.doe@qualpay.com\"]","items":{"type":"string"},"type":"array"},"logo_url":{"description":" AN Description: A link to the logo image that will be included in the transaction receipt. ","example":"https://app.qualpay.com/shared/images/qp-icon.png","type":"string"},"merchant_id":{"description":"Format: Variable length, up to 12 N Description: Unique identifier on the Qualpay system.","example":"<Provide merchant id that links to API Key>","format":"int64","type":"integer"},"vendor_id":{"description":"Format: Variable length, up to 12 N Description: Identifies the vendor to which this email receipt request applies.","example":212100026512,"format":"int64","type":"integer"}},"required":["email_address","merchant_id"],"type":"object"},"PGApiEmailReceiptResponse":{"properties":{"pg_id":{"description":"Format: Fixed length, 32 AN Description: 32-byte unique identifier generated by the payment gateway, returned in all valid responses.","example":"d24ac6189b0b11e6966ca68d5edbef41","readOnly":true,"type":"string"},"rcode":{"description":"Format: Fixed length, 3 AN Description: Response code from the payment gateway. \"000\" indicates success. Refer to <a href=\"/developer/api/reference#api-response-codes\"target=\"_blank\">Platform API Response Codes</a> for entire list of Payment Gateway Response Codes.","example":"000","readOnly":true,"type":"string"},"rmsg":{"description":"Format: Variable length Description: Response text from the payment gateway.","example":"Approved T37500","readOnly":true,"type":"string"}},"type":"object"},"PGApiRefundRequest":{"properties":{"amt_tran":{"description":"Format: Variable length, up to 12,2 N Description: Total amount to refund. Partial refunds are allowed by providing an amount in this field that is less than the total original transaction amount.","example":1193.5,"format":"double","type":"number"},"developer_id":{"description":"Format: Variable length, up to 16 AN Description: Used to indicate which company developed the integration to the Qualpay Payment Gateway. This may also be used to provide the payment solution name that is connected to the Qualpay Payment Gateway.","example":"MyIntegration","type":"string"},"echo_fields":{"description":"Format: Variable length Description: This field contains a JSON array of field data that will be echoed back in the response message.","example":"[ {\"product\" : \"lawnmower\"},{\"purchase\" : \"1 yr maintenance\"} ]","type":"string"},"loc_id":{"description":"Format: Variable length, up to 4 N Description: When a merchant has more than one location using the same currency, this value is used to specify the specific location for this request.","example":"0001","type":"string"},"merchant_id":{"description":"Format: Variable length, up to 12 N Description: Unique identifier on the Qualpay system.","example":"<Provide merchant id that links to API Key>","format":"int64","type":"integer"},"profile_id":{"description":"Format: Fixed length, 20 N Description: Explicitly identifies which Payment Gateway profile should be used for the request.","example":"21200001000300000978","type":"string"},"report_data":{"description":"Format: Variable length Description: This field contains a JSON array of field data that will be included with the transaction data reported in Qualpay Manager.","example":"[ {\"shipping address\" : \"123 Main St.\"},{\"shipping city, state zip\" : \"San Mateo, CA 94402\"} ]","type":"string"},"retry_id":{"description":"Format: Variable length, up to 15 N Description: This field contains a merchant generated number used to identify the request. This value must be unique within the last 24 hours. When present, the payment gateway will use the retry_attempt to determine whether the message is new or a retry of a previous message.","example":1234,"format":"int64","type":"integer"},"session_id":{"description":"INTERNAL USE ONLY.","type":"string"},"user_id":{"description":"INTERNAL USE ONLY.","format":"int64","type":"integer"},"vendor_id":{"description":"Format: Variable length, up to 12 N Description: Identifies the vendor to which this refund request applies.","example":212100026512,"format":"int64","type":"integer"}},"required":["amt_tran","merchant_id"],"type":"object"},"PGApiRefundResponse":{"properties":{"echo_fields":{"description":"Format: Variable length Description: Data that was provided in echo_fields in the request.","example":"[ {\"product\" : \"lawnmower\"},{\"purchase\" : \"1 yr maintenance\"} ]","readOnly":true,"type":"string"},"pg_id":{"description":"Format: Fixed length, 32 AN Description: 32-byte unique identifier generated by the payment gateway, returned in all valid responses.","example":"d24ac6189b0b11e6966ca68d5edbef41","readOnly":true,"type":"string"},"rcode":{"description":"Format: Fixed length, 3 AN Description: Response code from the payment gateway. \"000\" indicates success. Refer to <a href=\"/developer/api/reference#api-response-codes\"target=\"_blank\">Platform API Response Codes</a> for entire list of Payment Gateway Response Codes.","example":"000","readOnly":true,"type":"string"},"rmsg":{"description":"Format: Variable length Description: Response text from the payment gateway.","example":"Approved T37500","readOnly":true,"type":"string"}},"type":"object"},"PGApiResponse":{"properties":{"echo_fields":{"description":"Format: Variable length Description: Data that was provided in echo_fields in the request.","example":"[ {\"product\" : \"lawnmower\"},{\"purchase\" : \"1 yr maintenance\"} ]","readOnly":true,"type":"string"},"pg_id":{"description":"Format: Fixed length, 32 AN Description: 32-byte unique identifier generated by the payment gateway, returned in all valid responses.","example":"d24ac6189b0b11e6966ca68d5edbef41","readOnly":true,"type":"string"},"rcode":{"description":"Format: Fixed length, 3 AN Description: Response code from the payment gateway. \"000\" indicates success. Refer to <a href=\"/developer/api/reference#api-response-codes\"target=\"_blank\">Platform API Response Codes</a> for entire list of Payment Gateway Response Codes.","example":"000","readOnly":true,"type":"string"},"rmsg":{"description":"Format: Variable length Description: Response text from the payment gateway.","example":"Approved T37500","readOnly":true,"type":"string"}},"type":"object"},"PGApiTokenizeRequest":{"properties":{"avs_address":{"description":"Format: Variable length, up to 20 AN Description: Street address of the cardholder. If present, it will be included in the authorization request sent to the issuing bank.","example":"123 Main St","type":"string"},"avs_zip":{"description":"Format: Variable length, up to 9 N Description: Zip code of the cardholder. If present, it will be included in the authorization request sent to the issuing bank. Conditional Requirement: This field is required if avs_address is present.","example":"94402","type":"string"},"card_id":{"description":"Format: Fixed length, 32 AN Description: Card ID received from a tokenization request. The card_id may be used in place of a card number in requests requiring cardholder account data. Conditional Requirement: Refer to <a href=\"/developer/api/reference#card-source-conditional-requirements\"target=\"_blank\">Card or Bank Account Data Sources and Conditional Requirements</a>","example":"86e1b00d9b0811e68df3069d8f743581","type":"string"},"card_number":{"description":"Format: Variable length, up to 19 N Description: Cardholder's card number. Conditional Requirement: Refer to <a href=\"/developer/api/reference#card-source-conditional-requirements\"target=\"_blank\">Card or Bank Account Data Sources and Conditional Requirements</a>","example":"4111111111111111","type":"string"},"card_swipe":{"description":"Format: Variable length, up to 79 Description: Contains either track 1 or track 2 magnetic stripe data. If the magnetic stripe reader provides both track 1 and track 2 data in a single read, it is the responsibility of the implementer to send data for only one of the two tracks. Conditional Requirement: Refer to <a href=\"/developer/api/reference#card-source-conditional-requirements\"target=\"_blank\">Card or Bank Account Data Sources and Conditional Requirements</a>","example":";4111111111111111=08051010912345678901?8","type":"string"},"cardholder_name":{"description":"Format: Variable length, up to 64 AN Description: When provided in a tokenize request, the cardholder name will be stored in the Card Vault along with the cardholder card number and expiration date.","example":"JOHN CUSTOMER","type":"string"},"cvv2":{"description":"Format: Variable length, up to 4 N Description: CVV2 or CID value from the signature panel on the back of the cardholder's card. If present during a request that requires authorization, the value will be sent to the issuer for validation.","example":"152","type":"string"},"developer_id":{"description":"Format: Variable length, up to 16 AN Description: Used to indicate which company developed the integration to the Qualpay Payment Gateway. This may also be used to provide the payment solution name that is connected to the Qualpay Payment Gateway.","example":"MyIntegration","type":"string"},"echo_fields":{"description":"Format: Variable length Description: This field contains a JSON array of field data that will be echoed back in the response message.","example":"[ {\"product\" : \"lawnmower\"},{\"purchase\" : \"1 yr maintenance\"} ]","type":"string"},"exp_date":{"description":"Format: Fixed length, 4 N(MMYY format) Description: Expiration date of cardholder card number. When card_id or customer_id is present in the request this field may also be present; if it is not, then the expiration date from the Card Vault will be used. Conditional Requirement: Refer to <a href=\"/developer/api/reference#card-source-conditional-requirements\"target=\"_blank\">Card or Bank Account Data Sources and Conditional Requirements</a>","example":"0921","type":"string"},"loc_id":{"description":"Format: Variable length, up to 4 N Description: When a merchant has more than one location using the same currency, this value is used to specify the specific location for this request.","example":"0001","type":"string"},"merchant_id":{"description":"Format: Variable length, up to 12 N Description: Unique identifier on the Qualpay system.","example":"<Provide merchant id that links to API Key>","format":"int64","type":"integer"},"profile_id":{"description":"Format: Fixed length, 20 N Description: Explicitly identifies which Payment Gateway profile should be used for the request.","example":"21200001000300000978","type":"string"},"report_data":{"description":"Format: Variable length Description: This field contains a JSON array of field data that will be included with the transaction data reported in Qualpay Manager.","example":"[ {\"shipping address\" : \"123 Main St.\"},{\"shipping city, state zip\" : \"San Mateo, CA 94402\"} ]","type":"string"},"retry_id":{"description":"Format: Variable length, up to 15 N Description: This field contains a merchant generated number used to identify the request. This value must be unique within the last 24 hours. When present, the payment gateway will use the retry_attempt to determine whether the message is new or a retry of a previous message.","example":1234,"format":"int64","type":"integer"},"session_id":{"description":"INTERNAL USE ONLY.","type":"string"},"single_use":{"description":" Default: false Description: In a tokenize request, setting the single_use field to \"true\" will cause a single-use token to be generated. This token will expire in 10 minutes or when first used.","example":true,"type":"boolean"},"user_id":{"description":"INTERNAL USE ONLY.","format":"int64","type":"integer"}},"required":["exp_date","merchant_id"],"type":"object"},"PGApiTokenizeResponse":{"properties":{"card_id":{"description":"Format: Fixed length, 32 AN Description: 32-byte value returned after successful tokenize request or when an authorization or sale transaction requests tokenization of the cardholder data.","example":"86e1b00d9b0811e68df3069d8f743581","readOnly":true,"type":"string"},"card_number":{"description":"Format: Variable length, up to 16 AN Description: Cardholder's card number (truncated).","example":"4111xxxxxx111111","type":"string"},"echo_fields":{"description":"Format: Variable length Description: Data that was provided in echo_fields in the request.","example":"[ {\"product\" : \"lawnmower\"},{\"purchase\" : \"1 yr maintenance\"} ]","readOnly":true,"type":"string"},"pg_id":{"description":"Format: Fixed length, 32 AN Description: 32-byte unique identifier generated by the payment gateway, returned in all valid responses.","example":"d24ac6189b0b11e6966ca68d5edbef41","readOnly":true,"type":"string"},"rcode":{"description":"Format: Fixed length, 3 AN Description: Response code from the payment gateway. \"000\" indicates success. Refer to <a href=\"/developer/api/reference#api-response-codes\"target=\"_blank\">Platform API Response Codes</a> for entire list of Payment Gateway Response Codes.","example":"000","readOnly":true,"type":"string"},"rmsg":{"description":"Format: Variable length Description: Response text from the payment gateway.","example":"Approved T37500","readOnly":true,"type":"string"}},"type":"object"},"PGApiTransactionRequest":{"properties":{"amt_convenience_fee":{"description":"Format: Variable length, up to 8,2 N Description: Amount of convenience fee. A convenience fee is a fee charged to your customer for the \"convenience\" of being able to pay using an alternative payment channel outside your merchant's customary payment channel. Must be a flat/fixed fee amount per transaction. This field tracks the convenience fee amount for display purposes, but the amount of the fee must be included in amt_tran.","example":2,"format":"double","type":"number"},"amt_fbo":{"description":"Format: Variable length, up to 12,2 N Description: Total amount of transaction to be transferred to the \"for benefit of\" (FBO) account.","example":1.5,"format":"double","type":"number"},"amt_tax":{"description":"Format: Variable length, up to 12,2 N Description: Amount of sales tax included in the total transaction amount. This field tracks the tax amount for display and interchange purposes, but the amount of the tax must be included in amt_tran. Conditional Requirement: Required for Level 2 and Level 3 interchange qualification.","example":93.5,"format":"double","type":"number"},"amt_tran":{"description":"Format: Variable length, up to 12,2 N Description: Total amount of transaction including sales tax (amt_tax), convenience fee (amt_convenience_fee), and/or surcharge (amt_tran_fee) if applicable.","example":1193.5,"format":"double","type":"number"},"amt_tran_fee":{"description":"Format: Variable length, up to 8,2 N Description: Amount of transaction surcharge fee. A surcharge is a fee added to the cost of a purchase for the \"privilege\" of using a credit card instead of another form of payment, and can be a percentage of the transaction