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 • 116 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 API","version":"1.7.0","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"}],"paths":{"/ardef":{"post":{"description":"Gets Card type information for Visa, Mastercard, and Discover. Useful if you prohibit or allow certain activity based on card type. For example, you may not want to allow a subscription to be created using a prepaid card.","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":"Get Card type Information for Visa, Mastercard, and Discover","tags":["payment-gateway"]}},"/auth":{"post":{"description":"Authorizes a credit card for capture at a later time. An authorized 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,"x-display-fields":["amt_tran","card_number","exp_date"]},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PGApiTransactionResponse"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PGApiBadResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PGApiUnauthResponse"}}}},"402":{"description":"Declined","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PGApiDeclineResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PGApiInternalErrorResponse"}}}},"509":{"description":"Timeout","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PGApiTimeoutResponse"}}}}},"security":[{"basicAuth":[]}],"summary":"Authorize Transaction","tags":["payment-gateway"]}},"/batchClose":{"post":{"description":"Closes a batch. Use this request when the timing of the batch close needs to be controlled rather than relying on the once-daily automatic batch close which is 9 PM Pacific by default, and can be changed in the Qualpay Manager administration settings.","operationId":"Batch Close","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PGApiBatchCloseRequest"}}},"description":"Payment Gateway Batch Close Request","required":true,"x-display-fields":["merchant_id","retry_attempt","retry_id"]},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PGApiBatchCloseResponse"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PGApiBadResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PGApiUnauthResponse"}}}},"402":{"description":"Declined","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PGApiDeclineResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PGApiInternalErrorResponse"}}}},"509":{"description":"Timeout","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PGApiTimeoutResponse"}}}}},"security":[{"basicAuth":[]}],"summary":"Close Batch","tags":["payment-gateway"]}},"/capture/{pgIdOrig}":{"post":{"description":"Captures an authorized transaction for any amount up to the amount originally authorized. An authorized transaction can only be captured once.","operationId":"Capture","parameters":[{"description":"pgIdOrig","in":"path","name":"pgIdOrig","required":true,"x-display-fields":["amt_tran","card_number","exp_date"],"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/PGApiBadResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PGApiUnauthResponse"}}}},"402":{"description":"Declined","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PGApiDeclineResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PGApiInternalErrorResponse"}}}},"509":{"description":"Timeout","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PGApiTimeoutResponse"}}}}},"security":[{"basicAuth":[]}],"summary":"Capture an Authorized Transaction","tags":["payment-gateway"]}},"/credit":{"post":{"description":"Issues an unlinked credit. Credit requests require that the cardholder data is provided in the request. Credits are only available during the first 30 days of account opening unless you contact Qualpay support to make other arrangements. The refund request should generally be used to return money to the cardholder, as it is a reversal of a previously captured transaction. A refund request is linked to the original transaction which is helpful for reconciliation purposes.","operationId":"Credit","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PGApiTransactionRequest"}}},"description":"Payment Gateway Credit Request","required":true,"x-display-fields":["amt_tran","card_number","exp_date","cvv2","avs_zip"]},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PGApiTransactionResponse"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PGApiBadResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PGApiUnauthResponse"}}}},"402":{"description":"Declined","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PGApiDeclineResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PGApiInternalErrorResponse"}}}},"509":{"description":"Timeout","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PGApiTimeoutResponse"}}}}},"security":[{"basicAuth":[]}],"summary":"Issue Credit to Cardholder","tags":["payment-gateway"]}},"/emailReceipt/{pgId}":{"post":{"description":"Sends 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,"x-display-fields":["email_address","logo_url"]},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PGApiEmailReceiptResponse"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PGApiBadResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PGApiUnauthResponse"}}}},"402":{"description":"Declined","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PGApiDeclineResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PGApiInternalErrorResponse"}}}},"509":{"description":"Timeout","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PGApiTimeoutResponse"}}}}},"security":[{"basicAuth":[]}],"summary":"Send Transaction Receipt Email","tags":["payment-gateway"]}},"/expireToken":{"post":{"description":"Once expired, the token (card_id) is no longer valid for use in future transactions.","operationId":"Expire","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PGApiExpireTokenRequest"}}},"description":"Payment Gateway Expire Token Request","required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PGApiExpireTokenResponse"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PGApiBadResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PGApiUnauthResponse"}}}},"402":{"description":"Declined","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PGApiDeclineResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PGApiInternalErrorResponse"}}}},"509":{"description":"Timeout","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PGApiTimeoutResponse"}}}}},"security":[{"basicAuth":[]}],"summary":"Expire Token","tags":["payment-gateway"]}},"/force":{"post":{"description":"Forces an approval, used when an online authorization request received a 'declined' reason code and you have 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,"x-display-fields":["merchant_id","auth_code","amt_tran","card_number"]},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PGApiTransactionResponse"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PGApiBadResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PGApiUnauthResponse"}}}},"402":{"description":"Declined","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PGApiDeclineResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PGApiInternalErrorResponse"}}}},"509":{"description":"Timeout","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PGApiTimeoutResponse"}}}}},"security":[{"basicAuth":[]}],"summary":"Force Transaction Approval","tags":["payment-gateway"]}},"/recharge/{pgIdOrig}":{"post":{"description":"Creates a new sale transaction using the cardholder data from a previous successful transaction.","operationId":"Recharge","parameters":[{"description":"pgIdOrig","in":"path","name":"pgIdOrig","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PGApiRechargeRequest"}}},"description":"Payment Gateway Recharge Request","required":true,"x-display-fields":["amt_tran"]},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PGApiRechargeResponse"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PGApiBadResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PGApiUnauthResponse"}}}},"402":{"description":"Declined","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PGApiDeclineResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PGApiInternalErrorResponse"}}}},"509":{"description":"Timeout","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PGApiTimeoutResponse"}}}}},"security":[{"basicAuth":[]}],"summary":"Recharge Previously Settled Transaction","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 a 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,"x-display-fields":["amt_tran"]},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PGApiRefundResponse"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PGApiBadResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PGApiUnauthResponse"}}}},"402":{"description":"Declined","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PGApiDeclineResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PGApiInternalErrorResponse"}}}},"509":{"description":"Timeout","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PGApiTimeoutResponse"}}}}},"security":[{"basicAuth":[]}],"summary":"Refund Previously Captured Transaction","tags":["payment-gateway"]}},"/sale":{"post":{"description":"Requests authorization, and, if approved, will immediately capture the transaction to be included in the next batch close. This transaction type 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,"x-display-fields":["cardholder_name","amt_tran","card_number","exp_date","avs_zip","moto_ecomm_ind","cvv2","developer_id","client_ip"]},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PGApiTransactionResponse"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PGApiBadResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PGApiUnauthResponse"}}}},"402":{"description":"Declined","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PGApiDeclineResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PGApiInternalErrorResponse"}}}},"509":{"description":"Timeout","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PGApiTimeoutResponse"}}}}},"security":[{"basicAuth":[]}],"summary":"Sale (Auth + Capture)","tags":["payment-gateway"]}},"/tokenize":{"post":{"description":"Once stored, a unique card_id is returned for use in future transactions. Optionally, tokenization can be requested in an authorization, verify, force, credit, or sale request 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,"x-display-fields":["card_number","cvv2","avs_address","exp_date","avs_zip","email_address"]},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PGApiTokenizeResponse"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PGApiBadResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PGApiUnauthResponse"}}}},"402":{"description":"Declined","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PGApiDeclineResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PGApiInternalErrorResponse"}}}},"509":{"description":"Timeout","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PGApiTimeoutResponse"}}}}},"security":[{"basicAuth":[]}],"summary":"Tokenize Card","tags":["payment-gateway"]}},"/verify":{"post":{"description":"A verify request 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. This is useful if you want to determine if you have been presented with a valid card, but are not ready to authorize the card.","operationId":"Verify","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PGApiVerifyRequest"}}},"description":"Payment Gateway Card Verify Request","required":true,"x-display-fields":["card_number","merchant_id","exp_date","avs_zip","cvv2","avs_address","developer_id","client_ip"]},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PGApiVerifyResponse"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PGApiBadResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PGApiUnauthResponse"}}}},"402":{"description":"Declined","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PGApiDeclineResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PGApiInternalErrorResponse"}}}},"509":{"description":"Timeout","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PGApiTimeoutResponse"}}}}},"security":[{"basicAuth":[]}],"summary":"Verify Card","tags":["payment-gateway"]}},"/void/{pgIdOrig}":{"post":{"description":"Authorizations can be voided at any time until Qualpay automatically voids them at 28 days. Captured transactions can be voided until the batch is closed. If your batch closes and you did not void the transaction in time, you may make a refund request.","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,"x-display-fields":["merchant_id"]},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PGApiVoidResponse"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PGApiBadResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PGApiUnauthResponse"}}}},"402":{"description":"Declined","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PGApiDeclineResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PGApiInternalErrorResponse"}}}},"509":{"description":"Timeout","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PGApiTimeoutResponse"}}}}},"security":[{"basicAuth":[]}],"summary":"Void a Previously Authorized Transaction","tags":["payment-gateway"]}}},"servers":[{"url":"//api-test.qualpay.com/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_source":{"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. Conditional Requirement: Either customer first and last name or firm name is required. ","example":"Qualpay","type":"string"},"customer_first_name":{"description":"Format: Variable length, up to 32 AN Description: Customer first name. Conditional Requirement: Either customer first and last name or firm name is required. ","example":"Joe","type":"string"},"customer_last_name":{"description":"Format: Variable length, up to 32 AN Description: Customer last name. Conditional Requirement: Either customer first and last name or firm name is required. ","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"}},"type":"object"},"PGApiBadResponse":{"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":"102","readOnly":true,"type":"string"},"rmsg":{"description":"Format: Variable length Description: Response text from the payment gateway.","example":"Invalid PG Identifier","readOnly":true,"type":"string"}},"type":"object"},"PGApiBatchCloseRequest":{"properties":{"developer_id":{"description":"Format: Variable length, up to 32 AN Description: Use to indicate which company developed the integration to Qualpay or the name of the payment solution that is connected to Qualpay. Suggested usage is softwareABCv1.0 or companyXYZv2.0.\n","example":"QualpayV1.2","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_attempt":{"description":"Format: Variable length, up to 4 N Description: This field contains a number greater than zero (0). When the value is one (1), the payment gateway treats the message as a new message. If the value is greater than one (1), then the payment gateway will return the result of the original message. If the original message did not complete, the payment gateway treats the message as a new message. Conditional Requirement: This field is required when the retry_id is present in the request message.","example":1,"format":"int64","type":"integer"},"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 32 AN Description: Use to indicate which company developed the integration to Qualpay or the name of the payment solution that is connected to Qualpay. Suggested usage is softwareABCv1.0 or companyXYZv2.0.\n","example":"QualpayV1.2","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_attempt":{"description":"Format: Variable length, up to 4 N Description: This field contains a number greater than zero (0). When the value is one (1), the payment gateway treats the message as a new message. If the value is greater than one (1), then the payment gateway will return the result of the original message. If the original message did not complete, the payment gateway treats the message as a new message. Conditional Requirement: This field is required when the retry_id is present in the request message.","example":1,"format":"int64","type":"integer"},"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":"Capture request accepted","readOnly":true,"type":"string"}},"type":"object"},"PGApiDeclineResponse":{"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":"005","readOnly":true,"type":"string"},"rmsg":{"description":"Format: Variable length Description: Response text from the payment gateway.","example":"Decline","readOnly":true,"type":"string"}},"type":"object"},"PGApiEmailReceiptRequest":{"properties":{"developer_id":{"description":"Format: Variable length, up to 32 AN Description: Use to indicate which company developed the integration to Qualpay or the name of the payment solution that is connected to Qualpay. Suggested usage is softwareABCv1.0 or companyXYZv2.0.\n","example":"QualpayV1.2","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":"Transaction Receipt sent","readOnly":true,"type":"string"}},"type":"object"},"PGApiExpireTokenRequest":{"properties":{"card_id":{"description":"Format: Fixed length, 32 AN Description: Card ID received from a tokenization request.","example":"86e1b00d9b0811e68df3069d8f743581","type":"string"},"developer_id":{"description":"Format: Variable length, up to 32 AN Description: Use to indicate which company developed the integration to Qualpay or the name of the payment solution that is connected to Qualpay. Suggested usage is softwareABCv1.0 or companyXYZv2.0.\n","example":"QualpayV1.2","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_attempt":{"description":"Format: Variable length, up to 4 N Description: This field contains a number greater than zero (0). When the value is one (1), the payment gateway treats the message as a new message. If the value is greater than one (1), then the payment gateway will return the result of the original message. If the original message did not complete, the payment gateway treats the message as a new message. Conditional Requirement: This field is required when the retry_id is present in the request message.","example":1,"format":"int64","type":"integer"},"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 expire token request applies.","example":212100026512,"format":"int64","type":"integer"}},"required":["card_id","merchant_id"],"type":"object"},"PGApiExpireTokenResponse":{"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":"Token removed","readOnly":true,"type":"string"}},"type":"object"},"PGApiInternalErrorResponse":{"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":"999","readOnly":true,"type":"string"},"rmsg":{"description":"Format: Variable length Description: Response text from the payment gateway.","example":"Internal Error","readOnly":true,"type":"string"}},"type":"object"},"PGApiRechargeRequest":{"properties":{"amt_tran":{"description":"Format: Variable length, up to 12,2 N Description: Amount to recharge using the payment data from a previous transaction.","example":1139.5,"format":"double","type":"number"},"developer_id":{"description":"Format: Variable length, up to 32 AN Description: Use to indicate which company developed the integration to Qualpay or the name of the payment solution that is connected to Qualpay. Suggested usage is softwareABCv1.0 or companyXYZv2.0.\n","example":"QualpayV1.2","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_attempt":{"description":"Format: Variable length, up to 4 N Description: This field contains a number greater than zero (0). When the value is one (1), the payment gateway treats the message as a new message. If the value is greater than one (1), then the payment gateway will return the result of the original