openapi: 3.1.0 info: title: purchases-api Issue Card API version: '1.0' servers: - url: https://sandboxpurchasesapi.connexpay.com security: - sec0: [] tags: - name: IssueCard paths: /api/v1/IssueCard: post: summary: Issue Card description: Use this endpoint to issue virtual cards associated with a credit or ACH sale. Do not use this endpoint if you fund your virtual cards from cash and therefore don't have an associated sale. If you aren't sure which Issuance API to use, please contact your client support representative. operationId: issuecard parameters: - name: Content-Type in: header description: '"application/json"' schema: type: string - name: Authorization in: header description: 'Token. Eg: "Bearer eHSN5rTBzqDozgAAlN1UlTMVuIT1zSiAZWCo6E..."' schema: type: string requestBody: content: application/json: schema: type: object required: - MerchantGuid - FirstName - AmountLimit - PurchaseType - LastName properties: MerchantGuid: type: string description: Merchant's Guid. Application-level value that indicates a virtual card is being requested for client's account. Value provided by ConnexPay. FirstName: type: string description: Cardholder's first name. This is the first name placed on the virtual card provided to the supplier. The value is also searchable in the ConnexPay portal. The maximum length is 50 characters. LastName: type: string description: Cardholder's last name. This is the last name placed on the virtual card provided to the supplier. The value is also searchable in the ConnexPay portal. The maximum length is 50 characters. Phone: type: string description: Cardholder's phone number. Phone number up to 20 character string, numbers and plus sign (+) allowed only. Telephone number of the user (including area code), prepended by the + symbol and the 1- to 3-digit country calling code. Do not include hyphens, spaces, or parentheses. Address1: type: string description: Cardholder's address line 1. The street number is used by the supplier when submitting the transaction to perform an AVS check. Alphanumerics and [,.-'] are allowed. Address2: type: string description: Cardholder's address line 2. Alphanumerics and [,.-'] are allowed. City: type: string description: Cardholder's city. State: type: string description: Cardholder's short name state. The ISO 3166-2 CA and US state or province code of a user. Length = 2. If a non U.S. or Canadian value is submitted the virtual card request will not be processed and an error response returned. ZipCode: type: string description: Cardholder's zipcode. The zip code is used by the supplier when submitting the transaction to perform an AVS check. The Zipcode must be between 1 and 10 characters long, only numbers and letters are allowed. Country: type: string description: Cardholder's country. Only alpha-2 digit country code allowed and numbers are not allowed. See ISO-3166 country list of Alpha-2 country codes (https://www.iso.org/obp/ui/) . CurrencyCode: type: string description: Do not use without consulting with your CXP resources for applicable use. Default is your Accounting Currency if left blank/unprovided. Currency of the stored balance of the issued virtual card. Region: type: string description: Do not use without consulting with your CXP resources for applicable use. Default is your Accounting Region if left blank/unprovided. Where (region/bank) the virtual card is issued from. UsageLimit: type: integer description: 'Security Control: Maximum number of times the card may be authorized. The maximum allowed field value is 99, and if you do not provide a value the card will be considered unlimited. The exception to this are UATP cards, which have a maximum allowed value of 9999 and will default to that max if no value is provided. Authorization attempts exceeding the provided value will be declined. Even though a virtual card is often considered a “one-time-use” card, some suppliers may need to authorize a card multiple times (pre-authorizations, a purchase comprised of multiple tickets, etc.) and you may consider a value that is not overly restrictive to avoid unwanted declines.' format: int64 AmountLimit: type: number description: 'Security Control: Maximum dollar amount the card can be authorized and settled, which must be less than or equal to $4,999,999.99 ($1,200,000.00 CAD for Canadian Issuing clients). The value must incorporate any anticipated overages such as currency conversion or taxes that a supplier may associate with the transaction. If a supplier attempts to authorize a card for more than the amount limit it will be declined.' format: float ExpirationDate: type: string description: The ExpirationDate (YYYY-MM-DD) is the date to be provided to the supplier as the actual expiration date for the virtual card. The recommendation is to set the ExpirationDate one or two years in the future and set the TerminateDate just a day or two after the VCC is expected to be processed to avoid acceptance issues. The expiration date cannot be more than 48 months in the future. If an expiration date is not provided, the expiration will default to issue date plus three years. For cards issued outside of the US/Canada, the expiration date will default to issue date plus three years and can not be overwritten - even if this parameter is included in the request. Note, Returns can still be processed on expired or terminated VCCs. format: date TerminateDate: type: string description: The TerminateDate (YYYY-MM-DD format) is the date the Virtual Credit Card will be terminated by ConnexPay. TerminateDate is different than ExpirationDate in that TerminateDate indicates the actual date the card will no longer be active. The recommendation is to set the ExpirationDate one or two years in the future and set the TerminateDate just a day or two after the VCC is expected to be processed. If a terminate date is not indicated, the card will be inactivated as of the expiration date. Note, Returns can still be processed on terminated VCCs and UATP termination dates cannot exceed 12 months. format: date PurchaseType: type: string description: 'Security Control: The industry(s) where a virtual card can be used. For example, if value is set to 01 Airline and the card is attempted to be used at a hotel, it will decline. Allowed purchase types are decided during underwriting. Ask a ConnexPay team member for Purchase Types enabled on your account. Best Practice is to always assign a Purchase Type that is restrictive as possible.' SequenceNumber: type: string description: 'Transaction sequence number within client environment. Note: value is not searchable or reportable in ConnexPay portal. The maximum length is 100 alpha-numeric characters.' OrderNumber: type: string description: 'A value that is commonly used for reporting on and reconciling your PayIns and PayOuts. The Order Number is searchable in the ConnexPay Bridge and referenced in Analytics and reporting, and can be any identifier within your environment to associate with the sale or payment, such as a Record Locator, PNR, or transaction ID. The maximum length is 50 alpha-numeric characters and allows the following special characters: [._ /- ].' default: '' IncomingTransactionCode: type: string description: ITC for short Application level setting to associate the virtual card request with an original sale or sale group. The value is provided in the sale response of the original sale transaction, or in the Group Sale response of the group sale. All virtual card requests must be associated with an original sale or group transaction. PayeeId: type: string description: The PayeeId is used to assist with Intelligent Routing functionality. This field was previously labeled as the Supplier ID and serves the same purpose for Intelligent Routing; however, it also supports additional functionality if a Payee has been created. Creating a Payee allows you complete control over the type of virtual card used to pay your payee and minimizes the data that must be passed in each card request. The field accepts up to 100 alpha-numeric characters, special characters, and spaces. Reference our MerchantPayees APIs for additional details. PayorId: type: string description: An optional field used to tie the PayOut to a created Payor. This may assist with reconciling when using multiple bank accounts for funding your cash balance. NonDomesticSupplier: type: boolean description: We can issue the “Global VCC” if the Supplier accepting that VCC has an overseas merchant account. This is an optional field. Indicating true will result in issuing this Global VCC. Indicating false (or not including this property in your request) will result in receiving a VCC created for domestic use. Transmission: type: object description: URL Links (email) or a text document (fax) to virtual cards can be emailed/faxed by including the VCC Transmission object in the IssueCard API call. Including the transmission object for email also allows you to pull back a URL you can use within your application to direct a user to a visual representation of the virtual card. properties: TransmissionMethods: type: array description: 'Methods of Transmission. Supported methods: Email, Link, Fax. Populate this parameter as ''Email'' if you want to email the virtual card to a customer or supplier. Use the ''Link'' option to have a URL included in the response. Use the "Fax" option to fax the virtual card to a customer or supplier.' items: type: string EmailRecipient: type: string description: Mandatory for email transmission. The email address of the intended recipient. 255 char max. MerchantPhoneNumber: type: string description: This is the phone number that should display on the virtual card and is the number that should be used if the link has expired. Up to 15 characters. Numbers and plus sign (+) allowed only. EmailFrom: type: string description: Mandatory for email transmission. This will be the email address that populates the ‘reply to’ section of the email message. 255 char max. RecipientName: type: string description: Mandatory for email or fax transmission. A descriptive name of the email or fax recipient. 255 char max Subject: type: string description: Mandatory for email (unless using an existing template and the EmailTemplateName is provided) or fax transmission. High-level subject line description of the transmission contents. 255 char max. Message: type: string description: Mandatory for email (unless using an existing template and the EmailTemplateName is provided) or fax transmission. The message body of the email or fax. 2048 char max. DaysToExpire: type: string description: 'Mandatory for email transmission. The number of days after card issuance until link to VC expires. Range: 1-999 days.' EmailTemplateName: type: string description: Use a previously created custom email template by referring to the defined template name. 500 character max. FaxFrom: type: string description: Mandatory for fax transmission. This can be the client name or fax number the fax is coming from that populates the ‘FaxFrom’ section of the fax. 255 char max. FaxRecipient: type: string description: Mandatory for fax transmissions. The fax number of the intended recipient. BookingDetail: type: object properties: ArrivalDate: type: string description: Guest arrival date in YYYY-MM-DD format. format: date PaymentInstruction: type: string description: Instructions for payment processing. System automatically appends "This is a virtual credit card". Maximum length of 4000 characters. ReferenceNumber: type: string description: Booking reference number for tracking. This should match the booking confirmation number in the hotel’s property management system. Maximum length of 100 characters. Traveler: type: object properties: FirstName: type: string description: Traveler's first name. Maximum length of 100 characters. LastName: type: string description: Traveler's last name. Maximum length of 100 characters. description: Traveler information. Company: type: object description: Company information for the company paying for the charges. properties: Name: type: string description: Company Name. Maximum length of 200 characters. Address1: type: string description: Primary company address line. Maximum length of 100 characters. Address2: type: string description: Secondary company address line. Maximum length of 100 characters. City: type: string description: Company city. Maximum length of 100 characters. State: type: string description: Company state/province. Maximum length of 50 characters. Zipcode: type: string description: Company postal/ZIP code. Maximum length of 20 characters. Country: type: string description: Company country. Maximum length of 100 characters. Contact: type: object properties: PhoneNumber: type: string description: The phone number of the company that will be paying for the charges. Maximum of 20 characters. EmailAddress: type: string description: Primary contact email address of the company that will be paying for the charges. Maximum of 255 characters. InvoiceEmailAddress: type: string description: Invoice/billing email address. Maximum of 255 characters. required: - EmailAddress description: Contact information for the company that will be paying for the charges. Property: type: object properties: GDSCode: type: string description: Hotel property GDS (Global Distribution System) code. Maximum of 50 characters Address1: type: string description: Primary property address line. Maximum of 100 characters. Address2: type: string description: Secondary property address line. Maximum of 100 characters. City: type: string description: Property city. Maximum of 100 characters. State: type: string description: Property state/province. Maximum of 50 characters. Zipcode: type: string description: Property postal/ZIP code. Maximum of 20 characters. Country: type: string description: Property country. Maximum of 100 characters. description: Hotel property information. required: - GDSCode description: Optional component that enables automated hotel booking authorization through the Sertifi platform when a virtual card is issued. When provided, the system will attempt to create a booking authorization with the hotel property using the card details. Contact your ConnexPay representative before use as fees will be applied and configuration is required. required: - ArrivalDate - PaymentInstruction - ReferenceNumber ReturnCardData: type: boolean description: Optional field that may be set to true or false. When set to a value of true or if the field is not provided at all, card data is returned in the response. When set to a value of false, the Card Account Number and Security Code (CVV) will be excluded from the response. CustomerID: type: string description: 'Transaction ID within client environment associated with the customer. This value acts as a secondary identifier in conjunction with OrderNumber. The value is searchable and reportable in the ConnexPay portal. This value may be sent in multiple times within the integration for multiple purposes. The maximum length is 100 alphanumeric characters and the following special characters: [@._/-].' AssociationId: type: string description: 'Utilize the Association ID field to tie a virtual card to a sale or sales. For example, if you have several sales and one virtual card payment to a supplier, you can add association ID to the sales and the virtual card for downstream reporting. The maximum length is 100 alpha-numeric characters and the following special characters: [@._/-].' LabelIDs: type: array description: Utilize Label IDs to associate a virtual card to a specific label(s) within ConnexPay Bridge UI for your organization. If a virtual card is tied to an incorrect Label, it will not filter or display correctly in Bridge's Search Grid. Please contact your Customer Care Consultant for a list of valid Label IDs before use. items: type: string UserDefinedParameters: type: array description: You can add User Defined Parameters to your PayOut in the event that you need to associate or display additional information. items: properties: Name: type: string description: Name of the User Defined Parameter. Value: type: string description: 'Value for the named User Defined Parameter, in a format consistent with the defined DataType. If the User Defined Parameter is of Data Type String, the value is constrained by the defined Maximum Length and alphanumerics and special characters are allowed. If the User Defined Parameter is of Data Type DateTime, the formats accepted are ISO 8601 Formats (example: YYYY-MM-DD:HH:mm:ss), MM/DD/YYYY, and DD/MM/YYYY.' type: object EnableExactMatch: type: boolean default: 'false' description: 'Restrict the issued single use virtual card to only allow authorization approvals when the request amount is an exact match to the created amount limit. This functionality is only applicable when the currency is USD and the Region is US. A default value may be configured for your client account that will be used automatically when not provided in the request, however the explicit value provided in a request call will override this. Please reach out to your ConnexPay representative to enable before usage. Note: When the card brand is UATP, Exact Match will be enforced as false by the CXP system.' WhitelistCountries: type: array items: type: integer description: Specify the countries where the card may be successfully authorized. The Country Code ID or IDs must be used, which can be found at https://docs.connexpay.com/docs/country-code-ids. A country that is restricted by ConnexPay cannot be whitelisted, and that list can be found at https://docs.connexpay.com/docs/blacklisted-countries-of-vcc-acceptance. You may only specify a whitelist or blacklist, not both. BlacklistCountries: type: array items: type: integer description: Specify the countries where the card may not be successfully authorized. The Country Code ID or IDs must be used, which can be found at https://docs.connexpay.com/docs/country-code-ids. You may only specify a whitelist or blacklist, not both. avsCheck: type: boolean description: 'Optional field that will default to your client-level setting if not provided. If enabled, Address Line 1 and Zip Code must be provided. ' examples: Issue Card Request Example - Booking Detail: value: MerchantGuid: 2b586234-7f14-432e-b0f4-a2935f783f38 FirstName: M LastName: Smith Phone: '5551234567' Address1: 123 Main Street Address2: Suite 100 City: New York State: NY Zipcode: '10001' Country: US UsageLimit: 10 AmountLimit: 180 ExpirationDate: '2026-12-30' TerminateDate: '2026-12-30' PurchaseType: '01' SequenceNumber: Sample-seq-1 IncomingTransactionCode: 035U9MGQ5KF3XQAZQ00050000 NonDomesticSupplier: false OrderNumber: OrderNumber-1 CustomerID: CustomerID-1 PayeeId: AA Transmission: TransmissionMethods: - Email - Fax EmailRecipient: m.smith@example.com MerchantPhoneNumber: '5551234567' EmailFrom: noreply@example.com RecipientName: Smith Subject: Card Information Message: here is your card information... DaysToExpire: 1 FaxRecipient: '+15551234567' FaxFrom: Example Corporation BookingDetail: ArrivalDate: '2025-12-01' PaymentInstruction: Payment for hotel accommodation - This is a virtual credit card ReferenceNumber: REF123456789 Traveler: FirstName: M LastName: Smith Company: Name: Example Corporation Address1: 123 Main Street Address2: Suite 100 City: New York State: NY Zipcode: '10001' Country: US Contact: PhoneNumber: +1-555-123-4567 EmailAddress: m.smith@example.com InvoiceEmailAddress: billing@example.com Property: GDSCode: HTL001 Address1: 456 Hotel Boulevard Address2: Floor 1 City: Las Vegas State: NV Zipcode: '89101' Country: US summary: Issue Card Request Example - Booking Detail Issue Card Request Example: summary: Issue Card Request Example value: MerchantGuid: 2b586234-7f14-432e-b0f4-a2935f783f38 FirstName: M LastName: Smith Phone: '5551234567' Address1: 123 Main Street Address2: Suite 100 City: New York State: NY Zipcode: '10001' Country: US UsageLimit: 10 AmountLimit: 180 ExpirationDate: '2027-12-30' TerminateDate: '2026-12-30' PurchaseType: '01' SequenceNumber: Sample-seq-1 IncomingTransactionCode: 035U9MGQ5KF3XQAZQ00050000 NonDomesticSupplier: false OrderNumber: OrderNumber-1 CustomerID: CustomerID-1 PayeeId: AA Transmission: TransmissionMethods: - Email - Fax EmailRecipient: m.smith@example.com MerchantPhoneNumber: '5551234567' EmailFrom: noreply@example.com RecipientName: Smith Subject: Card Information Message: here is your card information... DaysToExpire: 1 FaxRecipient: '+15551234567' FaxFrom: Example Corporation responses: '200': description: '200' content: application/json: {} '201': content: application/json: schema: type: object properties: {} examples: Issue Card Response: summary: Issue Card Response value: cardHolder: cardHolderGuid: a2b25172-c863-4325-b3b9-7e33cff2f8d1 firstName: Adam lastName: Smith phone: '7411237489' address1: 345 Main Road address2: '' city: Miami Beach state: MI zipcode: '33109' country: MX createNewCard: false reissuePhysicalCard: false card: cardGuid: ae17f687-8ba7-4502-b627-24fdf5e6f218 accountNumber: '1111118971563394' securityCode: '617' amountLimit: 1 usageLimit: 12 limitWindow: LIFETIME expirationDate: '2026-12-30T18:59:59' expiration: '1219' terminateDate: '2026-12-30T23:59:59' currencyCode: USD firstSix: '111111' lastFour: '3394' nameLine1: Adam nameLine2: Smith status: Card - Active customerServicePhoneNumber: 1-612-601-0914 sequenceNumber: Sample-seq-1 midWhitelist: [] midBlacklist: [] associationId: 'null' gatewayMerchantGuid: 3b47973a-b0c1-4bcd-ba34-1514526d99cd availableBalance: 1 isPhysical: false isLodged: false fingerprint: 941A49226BB191C7B623268B22C94300 customerId: null supplierId: AA issuerId: 3 country: '' cardBin: '44325235' cardClass: CommercialPrepaid toleranceAmount: null isGLobal: false hasBooking: false cardHolder: null outgoingTransactionCode: null createdBy: null isMaestro: false whitelistCountries: null blacklistCountries: null enableExactMatch: false avsCheck: false cardImageKey: null labelIds: - 889 - 992 cardBrand: MasterCard cardClass: Commercial saleGuid: d49e4881-34e5-461f-9d43-0efb0d94039d incomingTransactionCode: '6560027639095375972800239' Issue Card Response (ReturnCardData = false): summary: Issue Card Response (ReturnCardData = false) value: "{\n \"cardHolder\": {\n \"cardHolderGuid\": \"a2b25172-c863-4325-b3b9-7e33cff2f8d1\",\n \"firstName\": \"Adam\",\n \"lastName\": \"Smith\",\n \"phone\": \"7411237489\",\n \"address1\": \"345 Main Road\",\n \"address2\": \"\",\n \"city\": \"Miami Beach\",\n \"state\": \"MI\",\n \"zipcode\": \"33109\",\n \"dateOfBirth\": null,\n \"country\": \"U\",\n \"createNewCard\": false,\n \"reissuePhysicalCard\": false\n },\n \"card\": {\n \"cardGuid\": \"ae17f687-8ba7-4502-b627-24fdf5e6f218\",\n \"amountLimit\": 180,\n \"usageLimit\": 10,\n \"limitWindow\": \"LIFETIME\",\n \"expirationDate\": \"2026-12-30T18:59:59\",\n \"expiration\": \"1224\",\n \"terminateDate\": \"2026-12-30T23:59:59\",\n \"currencyCode\": \"USD\",\n \"firstSix\": \"111111\",\n \"lastFour\": \"3394\",\n \"nameLine1\": \"Adam\",\n \"nameLine2\": \"Smith\",\n \"status\": \"Card - Active\",\n \"customerServicePhoneNumber\": \"1-612-601-0914\",\n \"sequenceNumber\": \"Sample-seq-1\",\n \"midWhitelist\": [],\n \"midBlacklist\": [],\n \"gatewayMerchantGuid\": \"2b586234-7f14-432e-b0f4-a2935f783f38\",\n \"availableBalance\": 180,\n \"isPhysical\": false,\n \"isLodged\": false,\n \"fingerprint\": \"23C69076A2C917DDA5ED1B83A1629626\",\n \"customerId\": null,\n \"payeeId\": null,\n \"issuerId\": 3,\n \"country\": \"\",\n \"cardBin\": \"433451\",\n \"toleranceAmount\": null,\n \"isGLobal\": false,\n \"hasBooking\": false,\n \"cardHolder\": null,\n \"outgoingTransactionCode\": null,\n \"createdBy\": null,\n \"isMaestro\": false,\n \"whitelistCountries\": null,\n \"blacklistCountries\": null,\n \"labelIds\": [\n 889,\n 992\n ],\n \"enableExactMatch\": false,\n \"avsCheck\": false,\n \"cardImageKey\": null\n },\n \"cardBrand\": \"MasterCard\",\n \"cardClass\": \"Commercial\",\n \"orderNumber\": \"OrderNumber-1\",\n \"CustomerID\": \"CustomerID-1\",\n \"saleGuid\": \"d49e4881-34e5-461f-9d43-0efb0d94039d\",\n \"incomingTransactionCode\": \"6676D1C639072191679998310\"\n" Issue Card Response (BookingDetail): summary: Issue Card Response (BookingDetail) value: cardHolder: cardHolderGuid: a2b25172-c863-4325-b3b9-7e33cff2f8d1 firstName: M lastName: Smith phone: '5551234567' address1: 123 Main Street address2: Suite 100 city: New York dateOfBirth: null country: US createNewCard: false reissuePhysicalCard: false card: cardGuid: ae17f687-8ba7-4502-b627-24fdf5e6f218 accountNumber: '1111118971563394' securityCode: '617' amountLimit: 180 usageLimit: 10 limitWindow: LIFETIME expirationDate: '2026-12-30T00:00:00Z' expiration: '1226' terminateDate: '2026-12-30T23:59:59' currencyCode: USD firstSix: '111111' lastFour: '3394' nameLine1: M nameLine2: Smith status: Card - Active customerServicePhoneNumber: 1-612-601-0914 midWhitelist: [] midBlacklist: [] gatewayMerchantGuid: 2b586234-7f14-432e-b0f4-a2935f783f38 availableBalance: 180 isPhysical: false isLodged: true fingerprint: 4F4BB4FE4CCBBE825F012AE7E09DFFC2 customerId: CustomerID-1 supplierId: null payeeId: AA issuerId: 3 country: US cardBin: '499999' cardClass: CommercialCredit toleranceAmount: null isGLobal: false cardHolder: null outgoingTransactionCode: null createdBy: null isMaestro: false whitelistCountries: null blacklistCountries: null enableExactMatch: false cardImageKey: null bookingGuids: - 2c448dba-2040-403b-93a2-6f29715e64ae cardBrand: MasterCard cardClass: Commercial orderNumber: OrderNumber-1 customerID: CustomerID-1 saleGuid: d49e4881-34e5-461f-9d43-0efb0d94039d incomingTransactionCode: 6676D1C639072191679998310 description: Created '400': description: '400' content: application/json: examples: Result: value: '{}' schema: type: object properties: {} tags: - IssueCard /api/v1/IssueCard/IssueLite: post: summary: Issue Lite description: For our lite clients, we provide the ability to issue a VCC (Virtual Credit Card) via API without the requirement to process a sale first. If you aren't sure which Issuance API to use, please contact your client support representative. operationId: issuelite-1 parameters: - name: Content-Type in: header description: '"application/json"' schema: type: string default: application/json - name: Authorization in: header description: 'Token. Eg: "Bearer eHSN5rTBzqDozgAAlN1UlTMVuIT1zSiAZWCo6E..."' schema: type: string default: Bearer eHSN5rTBzqDozgAAlN1UlTMVuIT1zSiAZWCo6E... requestBody: content: application/json: schema: type: object required: - MerchantGuid - FirstName - LastName - AmountLimit - PurchaseType properties: MerchantGuid: type: string description: Merchant's guid. Application level value that indicates a virtual card is being requested for clients account. Value provided by ConnexPay. default: MerchantGuid FirstName: type: string description: Cardholder's first name. This is the first name placed on the virtual card provided to the supplier. The value is also searchable in the ConnexPay portal. The maximum length is 50 characters. default: Jane LastName: type: string description: Cardholder's last name. This is the last name placed on the virtual card provided to the supplier. The value is also searchable in the ConnexPay portal. The maximum length is 50 characters. default: Doe Phone: type: string description: Cardholder's phone number. Phone number up to 20 character string, numbers and plus sign (+) allowed only. Telephone number of the user (including area code), prepended by the + symbol and the 1- to 3-digit country calling code. Do not include hyphens, spaces, or parentheses. default: '1234567890' Address1: type: string description: Cardholder's address line 1. The street number is used by the supplier when submitting the transaction to perform an AVS check. Alphanumerics and [,.-'] are allowed. default: 123 Test Street Address2: type: string description: Cardholder's address line 2. Alphanumerics and [,.-'] are allowed. default: Suite 185 City: type: string description: Cardholder's city. default: Alpharetta State: type: string description: Cardholder's short name state. The ISO 3166-2 CA and US state or province code of a user. Length = 2. If a non U.S. or Canadian value is submitted the virtual card request will not be processed and an error response returned. default: GA ZipCode: type: string description: Cardholder's zipcode. The zip code is used by the supplier when submitting the transaction to perform an AVS check. The Zipcode must be between 1 and 10 characters long, only numbers and letters are allowed. default: '30004' Country: type: string description: Cardholder's country. Only alpha-2 digit country code allowed and numbers are not allowed. See ISO-3166 country list of Alpha-2 country codes (https://www.iso.org/obp/ui/) . default: US CurrencyCode: type: string description: Default is your Accounting Currency and left blank/unprovided. Please consult with your ConnexPay resources for applicable use. Currency of the stored balance of the issued virtual card. Region: type: string description: Default is your Accounting Region and left blank/unprovided. Please consult with your ConnexPay resources for applicable use. Where (region/bank) the virtual card is issued from. UsageLimit: type: integer description: 'Security Control: Maximum number of times the card may be authorized. The maximum allowed field value is 99, and if you do not provide a value the card will be considered unlimited. Authorization attempts exceeding the provided value will be declined. Even though a virtual card is often considered a “one-time-use” card, some suppliers may need to authorize a card multiple times (pre-authorizations, a purchase comprised of multiple tickets, etc.) and you may consider a value that is not overly restrictive to avoid unwanted declines.' format: int64 AmountLimit: type: number description: 'Security Control: Maximum dollar amount the card can be authorized and settled, which must be less than or equal to $4,999,999.99 ($1,200,000.00 CAD for Canadian Issuing clients). The value must incorporate any anticipated overages such as currency conversion or taxes that a supplier may associate with the transaction. If a supplier attempts to authorize a card for more than the amount limit it will be declined.' default: 100 format: float ExpirationDate: type: string description: The ExpirationDate (YYYY-MM-DD) is the date to be provided to the supplier as the actual expiration date for the virtual card. The recommendation is to set the ExpirationDate one or two years in the future and set the TerminateDate just a day or two after the VCC is expected to be processed to avoid acceptance issues. The expiration date cannot be more than 48 months in the future. If an expiration date is not provided, the expiration will default to issue date plus three years. For cards issued outside of the US/Canada, the expiration date will default to issue date plus three years and can not be overwritten - even if this parameter is included in the request. Note, Returns can still be processed on expired or terminated VCCs. format: date TerminateDate: type: string description: The TerminateDate (YYYY-MM-DD format) is the date the Virtual Credit Card will be terminated by ConnexPay. TerminateDate is different than ExpirationDate in that TerminateDate indicates the actual date the card will no longer be active. The recommendation is to set the ExpirationDate one or two years in the future and set the TerminateDate just a day or two after the VCC is expected to be processed. If a terminate date is not indicated, the card will be inactivated as of the expiration date. Note, Returns can still be processed on terminated VCCs. format: date PurchaseType: type: string description: 'Security Control: The industry where the virtual card will be utilized. For example, if value set to airline and the card is used at hotel, it will be declined. Available purchase type values are: ''01'' (Airline), ''02'' (Hotels and Resorts), ''03'' (Car Rental), ''04'' (Cable, Satellite, Television, and Radio Services), ''05'' (Cruise Lines), ''06'' (Travel), ''11'' (Medical Services and Health Practitioners), ''21'' (Advertising Services), ''22'' (Misc Advertising and Business Services), ''23'' (Ticketing), ''31'' (Insurance Sales, Underwriting, and Premiums), ''32'' (Insurance and Real Estate Codes), ''91'' (Restaurants and Food Services), and ''93'' (Tax Payments)..' default: '01' SequenceNumber: type: string description: 'Transaction sequence number within client environment. Provide a unique SequenceNumber for each new request. If a card request is made with all the same parameter information and the same sequence number, within 30 minutes, the request will be considered a duplicate and a new card will not be issued. Note: value is not searchable or reportable in Bridge. The maximum length is 100 alpha-numeric characters.' default: '987654321' PayeeId: type: string description: The PayeeId is used to assist with Intelligent Routing functionality. This field was previously labeled as the Supplier ID and serves the same purpose for Intelligent Routing; however, it also supports additional functionality if a Payee has been created. Creating a Payee allows you complete control over the type of virtual card used to pay your payee and minimizes the data that must be passed in each card request. The field accepts up to 100 alpha-numeric characters, special characters, and spaces. Reference our MerchantPayees APIs for additional details. default: DL PayorId: type: string description: An optional field used to tie the PayOut to a created Payor. This may assist with reconciling when using multiple bank accounts for funding your cash balance. NonDomesticSupplier: type: boolean description: We can issue the “Global VCC” if the Supplier accepting that VCC has an overseas merchant account. This is an optional field. Indicating true will result in issuing this Global VCC. Indicating false (or not including this property in your request) will result in receiving a VCC created for domestic use. OrderNumber: type: string description: 'A value that is commonly used for reporting on and reconciling your PayIns and PayOuts. The Order Number is searchable in the ConnexPay Bridge and referenced in Analytics and reporting, and can be any identifier within your environment to associate with the sale or payment, such as a Record Locator, PNR, or transaction ID. The maximum length is 50 alpha-numeric characters and allows the following special characters: [._ /- ].' default: 1234A CustomerID: type: string description: 'Transaction ID within client environment associated with the customer. This value acts as a secondary identifier in conjunction with OrderNumber. The value is searchable and reportable in the ConnexPay portal. This value may be sent in multiple times within the integration for multiple purposes. The maximum length is 100 alphanumeric characters and the following special characters: [@._/-].' Transmission: type: object description: URL Links (email) or a text document (fax) to virtual cards can be emailed/faxed by including the VCC Transmission object in the IssueLite API call. Including the transmission object for email also allows you to pull back a URL you can use within your application to direct a user to a visual representation of the virtual card. properties: TransmissionMethods: type: array description: 'Methods of Transmission. Supported methods: Email, Link, Fax. Populate this parameter as ''Email'' if you want to email the virtual card to a customer or supplier. Use the ''Link'' option to have a URL included in the response. Use the "Fax" option to fax the virtual card to a customer or supplier.' items: type: string EmailRecipient: type: string description: Mandatory for email transmission. The email address of the intended recipient. 255 char max. MerchantPhoneNumber: type: string description: This is the phone number that should display on the virtual card and is the number that should be used if the link has expired. Up to 15 characters. Numbers and plus sign (+) allowed only. EmailFrom: type: string description: Mandatory for email transmission. This will be the email address that populates the ‘reply to’ section of the email message. 255 char max. RecipientName: type: string description: Mandatory for email or fax transmission. A descriptive name of the email or fax recipient. 255 char max Subject: type: string description: Mandatory for email (unless using an existing template and the EmailTemplateName is provided) or fax transmission. High-level subject line description of the transmission contents. 255 char max. Message: type: string description: Mandatory for email (unless using an existing template and the EmailTemplateName is provided) or fax transmission. The message body of the email or fax. 2048 char max. DaysToExpire: type: string description: 'Mandatory for email transmission. The number of days after card issuance until link to VC expires. Range: 1-999 days.' EmailTemplateName: type: string description: Use a previously created custom email template by referring to the defined template name. 500 character max. FaxFrom: type: string description: Mandatory for fax transmission. This can be the client name or fax number the fax is coming from that populates the ‘FaxFrom’ section of the fax. 255 char max. FaxRecipient: type: string description: Mandatory for fax transmissions. The fax number of the intended recipient. ReturnCardData: type: boolean description: Optional field that may be set to true or false. When set to a value of true or if the field is not provided at all, card data is returned in the response. When set to a value of false, the Card Account Number and Security Code (CVV) will be excluded from the response. ActivationDate: type: string description: Future date that the card should be fully funded, at least one day from creation date and within 36 months. If no activation date is supplied the card will be funded immediately. format: date AssociationId: type: string description: 'Utilize the Association ID field to tie a virtual card to a sale or sales. For example, if you have several sales and one virtual card payment to a supplier, you can add association ID to the sales and the virtual card for downstream reporting. The maximum length is 100 alphanumeric characters and the following special characters: [@._/-].' default: '1234' LabelIDs: type: array description: Utilize Label IDs to associate a virtual card to a specific label(s) within ConnexPay Bridge UI for your organization. If a virtual card is tied to an incorrect Label, it will not filter or display correctly in Bridge's Search Grid. Please contact your Customer Care Consultant for a list of valid Label IDs before use. items: type: string UserDefinedParameters: type: array description: You can add User Defined Parameters to your PayOut in the event that you need to associate or display additional information. items: properties: Name: type: string description: Name of the User Defined Parameter. Value: type: string description: 'Value for the named User Defined Parameter, in a format consistent with the defined DataType. If the User Defined Parameter is of Data Type String, the value is constrained by the defined Maximum Length and alphanumerics and special characters are allowed. If the User Defined Parameter is of Data Type DateTime, the formats accepted are ISO 8601 Formats (example: YYYY-MM-DD:HH:mm:ss), MM/DD/YYYY, and DD/MM/YYYY.' type: object EnableExactMatch: type: boolean description: Restrict the issued single use virtual card to only allow authorization approvals when the request amount is an exact match to the created amount limit. This functionality is only applicable when the currency is USD and the Region is US. A default value may be configured for your client account that will be used automatically when not provided in the request, however the explicit value provided in a request call will override this. Please reach out to your ConnexPay representative to enable before usage. default: 'false' examples: Issue Lite Request Example: value: MerchantGuid: 2b586234-7f14-432e-b0f4-a2935f783f38 Payee: Delta FirstName: Adam LastName: Smith Phone: '7411237489' Address1: 345 Main Road Address2: '' City: Miami Beach State: MI Zipcode: '33109' Country: MX UsageLimit: 10 AmountLimit: 180 ExpirationDate: '2024-12-30' TerminateDate: '2023-12-30' PurchaseType: '01' SequenceNumber: Sample-seq-1 NonDomesticSupplier: true OrderNumber: OrderNumber-1 CustomerID: CustomerID-1 SupplierID: AA Transmission: TransmissionMethods: - Email - Fax EmailRecipient: emailTo@gmail.com MerchantPhoneNumber: '7411237489' EmailFrom: emailFrom@gmail.com RecipientName: Smith Subject: Card Information Message: here is your card information... DaysToExpire: 1 FaxRecipient: '+55555555555' FaxFrom: Merchant Alias responses: '200': description: '200' content: application/json: examples: Issue Lite Response Example: value: cardHolder: cardHolderGuid: a2b25172-c863-4325-b3b9-7e33cff2f8d1 firstName: Adam lastName: Smith phone: '7411237489' address1: 345 Main Road address2: '' city: Miami Beach state: MI zipcode: '33109' country: MX card: cardGuid: ae17f687-8ba7-4502-b627-24fdf5e6f218 accountNumber: '1111118971563394' securityCode: '617' amountLimit: 180 usageLimit: 10 expirationDate: '2024-12-30T18:59:59' expiration: '1219' terminateDate: '2023-12-30T23:59:59' currencyCode: USD firstSix: '111111' lastFour: '3394' nameLine1: Adam nameLine2: Smith status: Card - Active sequenceNumber: Sample-seq-1 labelIds: - 889 - 992 enableExactMatch: false cardBrand: MasterCard cardClass: Commercial orderNumber: OrderNumber-1 customerID: CustomerID-1 saleGuid: d49e4881-34e5-461f-9d43-0efb0d94039d 'Issue Lite (ReturnCardData = false) Response Example ': value: cardHolder: cardHolderGuid: a2b25172-c863-4325-b3b9-7e33cff2f8d1 firstName: Adam lastName: Smith phone: '7411237489' address1: 345 Main Road address2: '' city: Miami Beach state: MI zipcode: '33109' country: MX card: cardGuid: ae17f687-8ba7-4502-b627-24fdf5e6f218 amountLimit: 180 usageLimit: 10 expirationDate: '2024-12-30T18:59:59' expiration: '1219' terminateDate: '2023-12-30T23:59:59' currencyCode: USD firstSix: '111111' lastFour: '3394' nameLine1: Adam nameLine2: Smith status: Card - Active sequenceNumber: Sample-seq-1 labelIds: - 889 - 992 enableExactMatch: false cardBrand: MasterCard cardClass: Commercial orderNumber: OrderNumber-1 customerID: CustomerID-1 saleGuid: d49e4881-34e5-461f-9d43-0efb0d94039d '400': description: '400' content: application/json: examples: Result: value: '{}' schema: type: object properties: {} deprecated: false tags: - IssueCard /api/v1/IssueCard/LodgedCard: post: summary: Issue Lodged Card description: Use this endpoint to create a Lodged Card operationId: issue-lodged-card parameters: - name: Content-Type in: header description: '"application/json"' schema: type: string - name: Authorization in: header description: 'Token. Eg: "Bearer eHSN5rTBzqDozgAAlN1UlTMVuIT1zSiAZWCo6E..."' schema: type: string requestBody: content: application/json: schema: type: object required: - MerchantGuid - FirstName - LastName - AmountLimit - LimitWindow - PurchaseType properties: MerchantGuid: type: string description: Merchant's guid. Application level value that indicates a virtual card is being requested for clients account. Value provided by ConnexPay. FirstName: type: string description: Cardholder's first name. This is the first name placed on the virtual card provided to the supplier. The value is also searchable in the ConnexPay portal. The maximum length is 50 characters. LastName: type: string description: Cardholder's last name. This is the last name placed on the virtual card provided to the supplier. The value is also searchable in the ConnexPay portal. The maximum length is 50 characters. Phone: type: string description: Cardholder's phone number. Phone number up to 20 character string, numbers and plus sign (+) allowed only. Telephone number of the user (including area code), prepended by the + symbol and the 1- to 3-digit country calling code. Do not include hyphens, spaces, or parentheses. Address1: type: string description: Cardholder's address line 1. The street number is used by the supplier when submitting the transaction to perform an AVS check. Alphanumerics and [,.-'] are allowed. Address2: type: string description: Cardholder's address line 2. Alphanumerics and [,.-'] are allowed. City: type: string description: Cardholder's city. State: type: string description: Cardholder's short name state. The ISO 3166-2 CA and US state or province code of a user. Length = 2. If a non U.S. or Canadian value is submitted the virtual card request will not be processed and an error response returned. ZipCode: type: string description: Cardholder's zipcode. The zip code is used by the supplier when submitting the transaction to perform an AVS check. The Zipcode must be between 1 and 10 characters long, only numbers and letters are allowed. Country: type: string description: Cardholder's country. Only alpha-2 digit country code allowed and numbers are not allowed. See ISO-3166 country list of Alpha-2 country codes (https://www.iso.org/obp/ui/) . CurrencyCode: type: string description: Do not use without consulting with your CXP resources for applicable use. Default is your Accounting Currency if left blank/unprovided. Currency of the stored balance of the issued virtual card. Region: type: string description: Do not use without consulting with your CXP resources for applicable use. Default is your Accounting Region if left blank/unprovided. Where (region/bank) the virtual card is issued from. UsageLimit: type: integer description: 'Security Control: Maximum number of times the card may be authorized. This is used in conjunction with the Limit Window: for example, if you specify a Usage Limit of 4 and a Limit Window of Monthly, the card can be authorized up to 4 times per month. The maximum allowed field value is 99, and if you do not provide a value the card will be considered unlimited. Authorization attempts exceeding the provided value will be declined.' format: int64 AmountLimit: type: number description: 'Security Control: Maximum dollar amount the card can be authorized and settled, which must be less than or equal to $4,999,999.99 ($1,200,000.00 CAD for Canadian Issuing clients). The value must incorporate any anticipated overages such as currency conversion or taxes that a supplier may associate with the transaction. If a supplier attempts to authorize a card for more than the amount limit it will be declined.' format: float LimitWindow: type: string description: 'This is the time period that both the UsageLimit and the AmountLimit applies. Options are: Day, Week, Month, Lifetime. For example AmountLimit is $500 and LimitWindow is "Week" then the card can be approved for $500 per week.' ExpirationDate: type: string description: The ExpirationDate (YYYY-MM-DD) is the date to be provided to the supplier as the actual expiration date for the virtual card. The recommendation is to set the ExpirationDate one or two years in the future and set the TerminateDate just a day or two after the VCC is expected to be processed to avoid acceptance issues. The expiration date cannot be more than 48 months in the future. If an expiration date is not provided, the expiration will default to issue date plus three years. For cards issued outside of the US/Canada, the expiration date will default to issue date plus three years and can not be overwritten - even if this parameter is included in the request. Note, Returns can still be processed on expired or terminated VCCs. format: date TerminateDate: type: string description: The TerminateDate (YYYY-MM-DD format) is the date the Virtual Credit Card will be terminated by ConnexPay. TerminateDate is different than ExpirationDate in that TerminateDate indicates the actual date the card will no longer be active. The recommendation is to set the ExpirationDate one or two years in the future and set the TerminateDate just a day or two after the VCC is expected to be processed. If a terminate date is not indicated, the card will be inactivated as of the expiration date. Note, Returns can still be processed on terminated VCCs. format: date PurchaseType: type: string description: 'Security Control: The industry(s) where a virtual card can be used. For example, if value is set to 01 Airline and the card is attempted to be used at a hotel, it will decline. Allowed purchase types are decided during underwriting. Ask a ConnexPay team member for Purchase Types enabled on your account. Best Practice is to always assign a Purchase Type that is restrictive as possible.' SequenceNumber: type: string description: 'Transaction sequence number within client environment. Provide a unique SequenceNumber for each new request. If the same value is sent within 30 minutes it will be considered a duplicate request. Note: value is not searchable or reportable in ConnexPay portal. The maximum length is 100 alpha-numeric characters.' OrderNumber: type: string description: 'A value that is commonly used for reporting on and reconciling your PayIns and PayOuts. The Order Number is searchable in the ConnexPay Bridge and referenced in Analytics and reporting, and can be any identifier within your environment to associate with the sale or payment, such as a Record Locator, PNR, or transaction ID. The maximum length is 50 alpha-numeric characters and allows the following special characters: [._ /- ].' PayeeId: type: string description: The PayeeId is used to assist with Intelligent PayOuts functionality. This field was previously labeled as the Supplier ID and serves the same purpose for Intelligent Routing; however, it also supports additional functionality if a Payee has been created. Creating a Payee allows you complete control over the type of virtual card used to pay your payee and minimizes the data that must be passed in each card request. The field accepts up to 100 alpha-numeric characters. Reference our MerchantPayees APIs for additional details. PayorId: type: string description: An optional field used to tie the PayOut to a created Payor. This may assist with reconciling when using multiple bank accounts for funding your cash balance. NonDomesticSupplier: type: boolean description: We can issue the “Global VCC” if the Supplier accepting that VCC has an overseas merchant account. This is an optional field. Indicating true will result in issuing this Global VCC. Indicating false (or not including this property in your request) will result in receiving a VCC created for domestic use. Transmission: type: object description: URL Links (email) or a text document (fax) to virtual cards can be emailed/faxed by including the VCC Transmission object in the IssueLodgedCard API call. Including the transmission object for email also allows you to pull back a URL you can use within your application to direct a user to a visual representation of the virtual card. properties: TransmissionMethods: type: array description: 'Methods of Transmission. Supported methods: Email, Link, Fax. Populate this parameter as ''Email'' if you want to email the virtual card to a customer or supplier. Use the ''Link'' option to have a URL included in the response. Use the "Fax" option to fax the virtual card to a customer or supplier.' items: type: string EmailRecipient: type: string description: Mandatory for email transmission. The email address of the intended recipient. 255 char max. MerchantPhoneNumber: type: string description: This is the phone number that should display on the virtual card and is the number that should be used if the link has expired. Up to 15 characters. Numbers and plus sign (+) allowed only. EmailFrom: type: string description: Mandatory for email transmission. This will be the email address that populates the ‘reply to’ section of the email message. 255 char max. RecipientName: type: string description: Mandatory for email or fax transmission. A descriptive name of the email or fax recipient. 255 char max Subject: type: string description: Mandatory for email (unless using an existing template and the EmailTemplateName is provided) or fax transmission. High-level subject line description of the transmission contents. 255 char max. Message: type: string description: Mandatory for email (unless using an existing template and the EmailTemplateName is provided) or fax transmission. The message body of the email or fax. 2048 char max. DaysToExpire: type: string description: 'Mandatory for email transmission. The number of days after card issuance until link to VC expires. Range: 1-999 days.' EmailTemplateName: type: string description: Use a previously created custom email template by referring to the defined template name. 500 character max. FaxFrom: type: string description: Mandatory for fax transmission. This can be the client name or fax number the fax is coming from that populates the ‘FaxFrom’ section of the fax. 255 char max. FaxRecipient: type: string description: Mandatory for fax transmissions. The fax number of the intended recipient. ReturnCardData: type: boolean description: Optional field that may be set to true or false. When set to a value of true or if the field is not provided at all, card data is returned in the response. When set to a value of false, the Card Account Number and Security Code (CVV) will be excluded from the response. CustomerID: type: string description: 'Transaction ID within client environment associated with the customer. This value acts as a secondary identifier in conjunction with OrderNumber. The value is searchable and reportable in the ConnexPay portal. This value may be sent in multiple times within the integration for multiple purposes. The maximum length is 100 alphanumeric characters and the following special characters: [@._/-].' AssociationId: type: string description: 'Utilize the Association ID field to tie a virtual card to a sale or sales. For example, if you have several sales and one virtual card payment to a supplier, you can add association ID to the sales and the virtual card for downstream reporting. The maximum length is 100 alphanumeric characters and the following special characters: [@._/-].' LabelIDs: type: array description: Utilize Label IDs to associate a lodged card to a specific label(s) within ConnexPay Bridge UI for your organization. If a lodged card is tied to an incorrect Label, it will not filter or display correctly in Bridge's Search Grid. Please contact your Customer Care Consultant for a list of valid Label IDs before use. items: type: string UserDefinedParameters: type: array description: You can add User Defined Parameters to your PayOut in the event that you need to associate or display additional information. items: properties: Name: type: string description: Name of the User Defined Parameter. Value: type: string description: 'Value for the named User Defined Parameter, in a format consistent with the defined DataType. If the User Defined Parameter is of Data Type String, the value is constrained by the defined Maximum Length and alphanumerics and special characters are allowed. If the User Defined Parameter is of Data Type DateTime, the formats accepted are ISO 8601 Formats (example: YYYY-MM-DD:HH:mm:ss), MM/DD/YYYY, and DD/MM/YYYY.' type: object WhitelistCountries: type: array items: type: integer description: Specify the countries where the card may be successfully authorized. The Country Code ID or IDs must be used, which can be found at https://docs.connexpay.com/docs/country-code-ids. A country that is restricted by ConnexPay cannot be whitelisted, and that list can be found at https://docs.connexpay.com/docs/blacklisted-countries-of-vcc-acceptance. You may only specify a whitelist or blacklist, not both. BlacklistCountries: type: array items: type: integer description: Specify the countries where the card may not be successfully authorized. The Country Code ID or IDs must be used, which can be found at https://docs.connexpay.com/docs/country-code-ids. You may only specify a whitelist or blacklist, not both. avsCheck: type: boolean description: 'Optional field that will default to your client-level setting if not provided. If enabled, Address Line 1 and Zip Code must be provided. ' responses: '200': description: '200' content: application/json: examples: Issue Lodged Card Response Example: value: "{\n \"cardHolder\": {\n \"cardHolderGuid\": \"b6557b9b-d0c5-49fd-a080-2be59a36ddf2\",\n \"firstName\": \"Ping\",\n \"lastName\": \"Test\",\n \"phone\": \"5162532222\",\n \"address1\": \"107 Techlogy Park\",\n \"address2\": \"\",\n \"city\": \"PT Corners\",\n \"state\": \"NY\",\n \"zipcode\": \"30092\",\n \"country\": \"US\"\n },\n \"card\": {\n \"cardGuid\": \"c67514a0-3110-4731-98b0-38858f282ade\",\n \"accountNumber\": \"1111117027148580\",\n \"securityCode\": \"818\",\n \"amountLimit\": 3.22,\n \"usageLimit\": 1,\n \"limitWindow\": \"DAY\", /* Day, Week, Month, Lifetime*/\n \"expirationDate\": \"2024-12-30T23:59:59\",\n \"expiration\": \"0624\",\n \"currencyCode\": \"USD\",\n \"firstSix\": \"111111\",\n \"lastFour\": \"8580\",\n \"nameLine1\": \"Ping\",\n \"nameLine2\": \"Test\",\n \"status\": \"Card - Active\",\n \"midWhitelist\": [\n \"111\",\n \"222\",\n \"333\"\n ],\n \"midBlacklist\": [\n \"777\"\n ]\n },\n \"cardBrand\": \"Visa\",\n \"cardClass\": \"Commercial\",\n \"saleGuid\": \"d49e4881-34e5-461f-9d43-0efb0d94039d\"\n}" Issue Lodged Card (ReturnCardData = False) Response Example: value: "{\n \"cardHolder\": {\n \"cardHolderGuid\": \"b6557b9b-d0c5-49fd-a080-2be59a36ddf2\",\n \"firstName\": \"Ping\",\n \"lastName\": \"Test\",\n \"phone\": \"5162532222\",\n \"address1\": \"107 Techlogy Park\",\n \"address2\": \"\",\n \"city\": \"PT Corners\",\n \"state\": \"NY\",\n \"zipcode\": \"30092\",\n \"country\": \"US\"\n },\n \"card\": {\n \"cardGuid\": \"c67514a0-3110-4731-98b0-38858f282ade\",\n \"amountLimit\": 3.22,\n \"usageLimit\": 1,\n \"limitWindow\": \"DAY\", /* Day, Week, Month, Lifetime*/\n \"expirationDate\": \"2024-12-30T23:59:59\",\n \"expiration\": \"0624\",\n \"currencyCode\": \"USD\",\n \"firstSix\": \"111111\",\n \"lastFour\": \"8580\",\n \"nameLine1\": \"Ping\",\n \"nameLine2\": \"Test\",\n \"status\": \"Card - Active\",\n \"midWhitelist\": [\n \"111\",\n \"222\",\n \"333\"\n ],\n \"midBlacklist\": [\n \"777\"\n ]\n },\n \"cardBrand\": \"Visa\",\n \"cardClass\": \"Commercial\",\n \"saleGuid\": \"d49e4881-34e5-461f-9d43-0efb0d94039d\"\n}" schema: oneOf: - title: Issue Lodged Card Response Example type: object properties: cardHolder: type: object properties: cardHolderGuid: type: string example: b6557b9b-d0c5-49fd-a080-2be59a36ddf2 firstName: type: string example: Ping lastName: type: string example: Test phone: type: string example: '5162532222' address1: type: string example: 107 Techlogy Park address2: type: string example: '' city: type: string example: PT Corners state: type: string example: NY zipcode: type: string example: '30092' country: type: string example: US card: type: object properties: cardGuid: type: string example: c67514a0-3110-4731-98b0-38858f282ade accountNumber: type: string example: '1111117027148580' securityCode: type: string example: '818' amountLimit: type: number example: 3.22 default: 0 usageLimit: type: integer example: 1 default: 0 limitWindow: type: string example: DAY expirationDate: type: string example: '2024-12-30T23:59:59' expiration: type: string example: '0624' currencyCode: type: string example: USD firstSix: type: string example: '111111' lastFour: type: string example: '8580' nameLine1: type: string example: Ping nameLine2: type: string example: Test status: type: string example: Card - Active midWhitelist: type: array items: type: string example: '111' midBlacklist: type: array items: type: string example: '777' cardBrand: type: string example: Visa cardClass: type: string example: Commercial saleGuid: type: string example: d49e4881-34e5-461f-9d43-0efb0d94039d - title: Issue Lodged Card (ReturnCardData = False) Response Example type: object properties: cardHolder: type: object properties: cardHolderGuid: type: string example: b6557b9b-d0c5-49fd-a080-2be59a36ddf2 firstName: type: string example: Ping lastName: type: string example: Test phone: type: string example: '5162532222' address1: type: string example: 107 Techlogy Park address2: type: string example: '' city: type: string example: PT Corners state: type: string example: NY zipcode: type: string example: '30092' country: type: string example: US card: type: object properties: cardGuid: type: string example: c67514a0-3110-4731-98b0-38858f282ade amountLimit: type: number example: 3.22 default: 0 usageLimit: type: integer example: 1 default: 0 limitWindow: type: string example: DAY expirationDate: type: string example: '2024-12-30T23:59:59' expiration: type: string example: '0624' currencyCode: type: string example: USD firstSix: type: string example: '111111' lastFour: type: string example: '8580' nameLine1: type: string example: Ping nameLine2: type: string example: Test status: type: string example: Card - Active midWhitelist: type: array items: type: string example: '111' midBlacklist: type: array items: type: string example: '777' cardBrand: type: string example: Visa cardClass: type: string example: Commercial saleGuid: type: string example: d49e4881-34e5-461f-9d43-0efb0d94039d '400': description: '400' content: application/json: examples: Result: value: '{}' schema: type: object properties: {} tags: - IssueCard /api/v1/IssueCard/{cardGuid}: put: summary: Update Card description: '' operationId: updatecard parameters: - name: Content-Type in: header description: Content-Type Header schema: type: string default: '"application/json"' - name: CardGuid in: path description: Global Unique Identififer for the Card. schema: type: string required: true - name: Authorization in: header description: 'Token. Eg: "Bearer eHSN5rTBzqDozgAAlN1UlTMVuIT1zSiAZWCo6E..."' schema: type: string default: Bearer Token requestBody: content: application/json: schema: type: object properties: PurchaseType: type: string description: 'Security Control: The industry(s) where a virtual card can be used. For example, if value is set to 01 Airline and the card is attempted to be used at a hotel, it will decline. Allowed purchase types are decided during underwriting. Ask a ConnexPay team member for Purchase Types enabled on your account. Best Practice is to always assign a Purchase Type that is restrictive as possible.' UsageLimit: type: integer description: 'Security Control: Maximum number of times the card may be authorized. The maximum allowed field value is 99, and if you do not provide a value the card will be considered unlimited. The exception to this are UATP cards, which have a maximum allowed value of 9999 and will default to that max if no value is provided. Authorization attempts exceeding the provided value will be declined. Even though a virtual card is often considered a “one-time-use” card, some suppliers may need to authorize a card multiple times (pre-authorizations, a purchase comprised of multiple tickets, etc.) and you may consider a value that is not overly restrictive to avoid unwanted declines.' format: int32 Activated: type: boolean description: True activates a card from an inactive state. False suspends a card that is currently active. AssociationId: type: string description: 'Utilize the Association ID field to tie a virtual card to a sale or sales. For example, if you have several sales and one virtual card payment to a supplier, you can add association ID to the sales and the virtual card for downstream reporting. The maximum length is 100 alphanumeric characters and the following special characters: [@._/-].' TerminateDate: type: string description: The TerminateDate (YYYY-MM-DD format) is the date the Virtual Credit Card will be terminated by ConnexPay. TerminateDate is different than ExpirationDate in that TerminateDate indicates the actual date the card will no longer be active. The recommendation is to set the ExpirationDate one or two years in the future and set the TerminateDate just a day or two after the VCC is expected to be processed. If a terminate date is not indicated, the card will be inactivated as of the expiration date. Note, Returns can still be processed on terminated VCCs and UATP termination dates cannot exceed 12 months. format: date AmountLimit: type: number description: 'Security Control: Maximum dollar amount the card can be authorized and settled, which must be less than or equal to $5,000,000.00 (750,000CAD for Canadian Issuing clients). The value must incorporate any anticipated overages such as currency conversion or taxes that a supplier may associate with the transaction. If a supplier attempts to authorize a card for more than the amount limit it will be declined.' format: float UserDefinedParameters: type: array description: You can replace the User Defined Parameters of your PayOut in the event that you need to associate or display additional information. items: properties: Name: type: string description: Name of the User Defined Parameter. Value: type: string description: 'Value for the named User Defined Parameter, in a format consistent with the defined DataType. If the User Defined Parameter is of Data Type String, the value is constrained by the defined Maximum Length and alphanumerics and special characters are allowed. If the User Defined Parameter is of Data Type DateTime, the formats accepted are ISO 8601 Formats (example: YYYY-MM-DD:HH:mm:ss), MM/DD/YYYY, and DD/MM/YYYY.' type: object CustomerId: type: string description: 'Transaction ID within client environment associated with the customer. This value acts as a secondary identifier in conjunction with OrderNumber. The value is searchable and reportable in the ConnexPay portal. This value may be sent in multiple times within the integration for multiple purposes. The maximum length is 100 alphanumeric characters and the following special characters: [@._/-].' avsCheck: type: boolean description: 'Optional field that will default to your client-level setting if not provided. If enabled, Address Line 1 and Zip Code must be provided. ' examples: Update PuchaseType Example Request: value: PurchaseType: '01' UsageLimit: 10 AssociationId: Test 1 TerminateDate: '2027-12-30' summary: Update PuchaseType Example Request responses: '200': description: '200' content: application/json: examples: Update PuchaseType Example Response: value: card: cardGuid: 22724a6c-bf3e-409b-9593-c74648506aa7 amountLimit: 13 usageLimit: 22 limitWindow: LIFETIME expirationDate: '2026-12-19T00:00:00' expiration: '1222' firstSix: '499999' lastFour: '7354' nameLine1: Jim nameLine2: Rayeek status: Card - Active cardType: Visa associationId: Test clientProgram: '31' mccGroupName: Hotels and Resorts summary: Update PuchaseType Example Response schema: type: object properties: card: type: object properties: cardGuid: type: string example: 22724a6c-bf3e-409b-9593-c74648506aa7 amountLimit: type: integer example: 13 default: 0 usageLimit: type: integer example: 22 default: 0 limitWindow: type: string example: LIFETIME expirationDate: type: string example: '2022-12-19T00:00:00' expiration: type: string example: '1222' firstSix: type: string example: '499999' lastFour: type: string example: '7354' nameLine1: type: string example: Jim nameLine2: type: string example: Rayeek status: type: string example: Card - Active cardType: type: string example: Visa associationId: type: string example: Test clientProgram: type: string example: '31' mccGroupName: type: string example: Hotels and Resorts '400': description: '400' content: application/json: examples: Result: value: '{}' schema: type: object properties: {} tags: - IssueCard /api/v1/IssueCard/LodgedCard/{CardGuid}: put: summary: Update Lodged Card description: '' operationId: update-lodged-card parameters: - name: CardGuid in: path description: Global Unique Identifier for the Card. schema: type: string required: true - name: Content-Type in: header description: Content-Type Header schema: type: string default: '"application/json"' requestBody: content: application/json: schema: type: object properties: UsageLimit: type: integer description: 'Security Control: Maximum number of times the card may be authorized. This is used in conjunction with the Limit Window; for example, if you specify a Usage Limit of 4 and a Limit Window of Monthly, the card can be authorized up to 4 times per month. The maximum allowed field value is 99, and if you do not provide a value the card will be considered unlimited. Authorization attempts exceeding the provided value will be declined.' format: int64 AmountLimit: type: number description: 'Security Control: Maximum dollar amount the card can be authorized and settled, which must be less than or equal to $5,000,000.00 (750,000CAD for Canadian Issuing clients). The value must incorporate any anticipated overages such as currency conversion or taxes that a supplier may associate with the transaction. If a supplier attempts to authorize a card for more than the amount limit it will be declined.' format: float LimitWindow: type: string description: 'This is the time period that both the UsageLimit and the AmountLimit applies. Options are: Day, Week, Month, Lifetime. For example AmountLimit is $500 and LimitWindow is "Week" then the card can be approved for $500 per week.' PurchaseType: type: string description: 'Security Control: The industry(s) where a virtual card can be used. For example, if value is set to 01 Airline and the card is attempted to be used at a hotel, it will decline. Allowed purchase types are decided during underwriting. Ask a ConnexPay team member for Purchase Types enabled on your account. Best Practice is to always assign a Purchase Type that is restrictive as possible.' Activated: type: boolean description: True activates a lodged card. False suspends a lodged card. AssociationId: type: string description: 'Utilize the Association ID field to tie a lodged card to a sale or sales. For example, if you have several sales and one lodged card payment to a supplier, you can add association ID to the sales and the lodged card for downstream reporting. The maximum length is 100 alphanumeric characters and the following special characters: [@._/-].' TerminateDate: type: string description: The TerminateDate (YYYY-MM-DD format) is the date the Lodged Card will be terminated by ConnexPay. TerminateDate is different than ExpirationDate in that TerminateDate indicates the actual date the card will no longer be active. The recommendation is to set the ExpirationDate one or two years in the future and set the TerminateDate just a day or two after the Lodged Card is expected to be processed. If a terminate date is not indicated, the card will be inactivated as of the expiration date. Note, Returns can still be processed on terminated Lodged Cards. format: date UserDefinedParameters: type: array description: You can replace the User Defined Parameters of your PayOut in the event that you need to associate or display additional information. items: properties: Name: type: string description: Name of the User Defined Parameter. Value: type: string description: 'Value for the named User Defined Parameter, in a format consistent with the defined DataType. If the User Defined Parameter is of Data Type String, the value is constrained by the defined Maximum Length and alphanumerics and special characters are allowed. If the User Defined Parameter is of Data Type DateTime, the formats accepted are ISO 8601 Formats (example: YYYY-MM-DD:HH:mm:ss), MM/DD/YYYY, and DD/MM/YYYY.' type: object avsCheck: type: string description: 'Optional field that will default to your client-level setting if not provided. If enabled, Address Line 1 and Zip Code must be provided. ' examples: Update Lodged Card Request Example: value: UsageLimit: 100 AmountLimit: 1004 LimitWindow: MONTH PurchaseType: '01' MIDWhiteList: - '1210000163087898' - '1210000163083578' MIDBlackList: - '1210000163083918' Activated: true responses: '200': description: '200' content: application/json: examples: Update Lodged Card Response Example: value: "{\n \"card\": {\n \"cardGuid\": \"0de2e407-5509-40c0-8b59-44e1b2b81f23\",\n \"amountLimit\": 1004.0,\n \"usageLimit\": -1,\n \"limitWindow\": \"MONTH\",\n \"expirationDate\": \"2021-12-30T23:59:59\",\n \"expiration\": \"1221\",\n \"firstSix\": \"111111\",\n \"lastFour\": \"0033\",\n \"nameLine1\": \"Monim\",\n \"nameLine2\": \"Lodged\",\n \"status\": \"Card - Active\",\n \"cardType\": \"Other\",\n \"midWhitelist\": [\n \"1210000163087898\",\n \"1210000163083578\"\n ],\n \"midBlacklist\": [\n \"1210000163083918\"\n ]\n },\n \"mccGroupName\": \"Airline\"\n}" schema: type: object properties: card: type: object properties: cardGuid: type: string example: 0de2e407-5509-40c0-8b59-44e1b2b81f23 amountLimit: type: integer example: 1004 default: 0 usageLimit: type: integer example: -1 default: 0 limitWindow: type: string example: MONTH expirationDate: type: string example: '2021-12-30T23:59:59' expiration: type: string example: '1221' firstSix: type: string example: '111111' lastFour: type: string example: '0033' nameLine1: type: string example: Monim nameLine2: type: string example: Lodged status: type: string example: Card - Active cardType: type: string example: Other midWhitelist: type: array items: type: string example: '1210000163087898' midBlacklist: type: array items: type: string example: '1210000163083918' mccGroupName: type: string example: Airline '400': description: '400' content: application/json: examples: Result: value: '{}' schema: type: object properties: {} deprecated: false tags: - IssueCard /api/v1/IssueCard/UpdateDelayedActivationVc/{cardGuid}: put: summary: Update Delayed Activation VCC (old) description: 'Use this endpoint to update the amount limit on a virtual card associated with a delayed activation sale. If there is not a delayed activation sale, use the "UpdateDelayedCard" endpoint found here: https://docs.connexpay.com/reference/update-delayed-card' operationId: updatedelayedactivationvc parameters: - name: Content-Type in: header description: Content-Type Header schema: type: string default: '"application/json"' - name: Authorization in: header description: 'Token. Eg: "Bearer eHSN5rTBzqDozgAAlN1UlTMVuIT1zSiAZWCo6E..."' schema: type: string default: Bearer Token - name: CardGuid in: path description: Global Unique Identifier for the Card. schema: type: string required: true requestBody: content: application/json: schema: type: object properties: ReloadAmount: type: integer description: 'Security Control: Amount to load on top of the current AmountLimit for the Virtual Card.' format: int64 examples: Update Delated Virtual Card Request Example: value: ReloadAmount: 198 responses: '200': description: '200' content: application/json: examples: Update Delated Virtual Card Response Example: value: "{\n \"card\": {\n \"cardGuid\": \"4fee6de1-ec49-4b4a-8bf5-d1d13b580965\",\n \"amountLimit\": 198.00,\n \"expirationDate\": \"2019-12-30T18:59:59\",\n \"expiration\": \"1219\",\n \"firstSix\": \"111111\",\n \"lastFour\": \"3647\",\n \"nameLine1\": \"Adam\",\n \"nameLine2\": \"Smith\",\n \"status\": \"Card - Active, but delayed Activation Auth Limit of $1.0 applied.\"\n \"activationDate\": \"9/2/2020\", \n },\n \"mccGroupName\": \"Airline\"\n }" '400': description: '400' content: application/json: examples: Result: value: '{}' schema: type: object properties: {} deprecated: false tags: - IssueCard /api/v1/IssueCard/Cancel/{{CardGuid}}: put: summary: Cancel Card description: This endpoint should be called when you want to completely cancel a virtual card you created using the IssueLite endpoint. operationId: cancel-card responses: '200': description: '200' content: application/json: examples: Result: value: "{\n \"cardHolder\": {\n \"cardHolderGuid\": \"2eda6839-4e8a-49eb-9079-18f829585e50\",\n \"firstName\": \"Ping\",\n \"lastName\": \"Lite6\",\n \"phone\": \"1231231234\",\n \"address1\": \"107 Techlogy Park\",\n \"address2\": \"\",\n \"city\": \"PT Corners\",\n \"zipcode\": \"30092\"\n },\n \"card\": {\n \"cardGuid\": \"2cf4bdbf-48c1-4e23-9ae3-4d5236a8b917\",\n \"amountLimit\": 12.07,\n \"usageLimit\": 2,\n \"limitWindow\": \"LIFETIME\",\n \"expirationDate\": \"2021-11-04T00:00:00\",\n \"expiration\": \"1222\",\n \"firstSix\": \"111111\",\n \"lastFour\": \"3349\",\n \"nameLine1\": \"Ping\",\n \"nameLine2\": \"Lite6\",\n \"status\": \"Card - Deactivated\",\n \"cardType\": \"Other\"\n }\n}" schema: type: object properties: cardHolder: type: object properties: cardHolderGuid: type: string example: 2eda6839-4e8a-49eb-9079-18f829585e50 firstName: type: string example: Ping lastName: type: string example: Lite6 phone: type: string example: '1231231234' address1: type: string example: 107 Techlogy Park address2: type: string example: '' city: type: string example: PT Corners zipcode: type: string example: '30092' card: type: object properties: cardGuid: type: string example: 2cf4bdbf-48c1-4e23-9ae3-4d5236a8b917 amountLimit: type: number example: 12.07 default: 0 usageLimit: type: integer example: 2 default: 0 limitWindow: type: string example: LIFETIME expirationDate: type: string example: '2021-11-04T00:00:00' expiration: type: string example: '1222' firstSix: type: string example: '111111' lastFour: type: string example: '3349' nameLine1: type: string example: Ping nameLine2: type: string example: Lite6 status: type: string example: Card - Deactivated cardType: type: string example: Other '400': description: '400' content: application/json: examples: Result: value: '{}' schema: type: object properties: {} deprecated: false tags: - IssueCard /api/v1/IssueCard/SendPaymentInfo/{cardGuid}: put: summary: Resend Transmission description: This endpoint resends payment information to recipient. Or returns a URL you can use within your application to direct a user to a visual representation of the virtual card. operationId: resendtransmission parameters: - name: Content-Type in: header description: Content-Type Header schema: type: string default: '"application/json"' - name: CardGuid in: path description: Global Unique Identififer for the Card. schema: type: string required: true - name: Authorization in: header description: 'Token. Eg: "Bearer eHSN5rTBzqDozgAAlN1UlTMVuIT1zSiAZWCo6E..."' schema: type: string default: Bearer Token requestBody: content: application/json: schema: type: object required: - TransmissionMethods properties: TransmissionMethods: type: array description: 'Methods of Transmission. Supported methods: Email, Link, Fax. Populate this parameter as ''Email'' if you want to email the virtual card to a customer or supplier. Use the ''Link'' option to have a URL included in the response. Use the "Fax" option to fax the virtual card to a customer or supplier.' items: type: string EmailRecipient: type: string description: Mandatory when transmission is Email. Otherwise don't include. This is the email address of the intended recipient. 255 char max. MerchantPhoneNumber: type: string description: This is the phone number that should display on the virtual card and is the number that should be used if the link has expired. Up to 15 characters. Numbers and plus sign (+) allowed only. EmailFrom: type: string description: For email transmissions, this will be the email address that populates the ‘reply to’ section of the email message. Do not include this parameter on other transmission method types. 255 char max. RecipientName: type: string description: A descriptive name of the email or fax recipient. Does not apply to the Link transmission method type. 255 char max Subject: type: string description: High-level subject line description of the transmission contents. Does not apply to the Link transmission method type. 255 char max. Message: type: string description: The message body of the email or fax. Does not apply to the Link transmission method type. 2048 char max. DaysToExpire: type: integer description: 'The number of days after card issuance until the link to the VC expires. Range: 1-999 days.' format: int32 EmailTemplateName: type: string description: Use a previously created custom email template by referring to the defined template name. 500 character max. FaxFrom: type: string description: Mandatory for fax transmission. This can be the client name or fax number the fax is coming from that populates the ‘FaxFrom’ section of the fax. 255 char max. FaxRecipient: type: string description: Mandatory for fax transmissions. The fax number of the intended recipient. examples: Resend Transmission Request Example - email: value: TransmissionMethods: - Email EmailRecipient: emailTo@gmail.com MerchantPhoneNumber: '+7411237489' EmailFrom: emailFrom@gmail.com RecipientName: Smith Subject: Card Information Message: here is your card information... DaysToExpire: 1 responses: '200': description: '200' content: application/json: examples: Resend Transmission Response Example: value: "{\n \"linkToCard\": \"https://sandboxpurchasesapi.connexpay.com//cards?token=eyJhbGciOiJodHRwOi8vd3d3LnczLm9yZy8yMDAxLzA0L3htbGRzaWctbW9yZSNobWFjLXNoYTI1NiIsInR5cCI6IkpXVCJ9.eyJDYXJkR3VpZCI6IjBmZTI4M2MwLTc2MjYtNGVhNS1iMWUwLTc1MTNkMjk3MTY1YiIsIk1lcmNoYW50UGhvbmUiOiI1MTYyNTMyMjIyIiwibmJmIjoxNjE5NjA2NzY0LCJleHAiOjE2MTk2OTMxNjQsImlhdCI6MTYxOTYwNjc2NCwiaXNzIjoiaHR0cHM6Ly9QdXJjaGFzZXMuY29ubmV4cGF5LmNvbS8iLCJhdWQiOiJNZXJjaGFudHMifQ.QKoqNWksbvq4VUzArS0dCeG67rFOPZb8k8Yvj11eF2c\"\n}" schema: type: object properties: linkToCard: type: string example: https://sandboxpurchasesapi.connexpay.com//cards?token=eyJhbGciOiJodHRwOi8vd3d3LnczLm9yZy8yMDAxLzA0L3htbGRzaWctbW9yZSNobWFjLXNoYTI1NiIsInR5cCI6IkpXVCJ9.eyJDYXJkR3VpZCI6IjBmZTI4M2MwLTc2MjYtNGVhNS1iMWUwLTc1MTNkMjk3MTY1YiIsIk1lcmNoYW50UGhvbmUiOiI1MTYyNTMyMjIyIiwibmJmIjoxNjE5NjA2NzY0LCJleHAiOjE2MTk2OTMxNjQsImlhdCI6MTYxOTYwNjc2NCwiaXNzIjoiaHR0cHM6Ly9QdXJjaGFzZXMuY29ubmV4cGF5LmNvbS8iLCJhdWQiOiJNZXJjaGFudHMifQ.QKoqNWksbvq4VUzArS0dCeG67rFOPZb8k8Yvj11eF2c '400': description: '400' content: application/json: examples: Result: value: '{}' schema: type: object properties: {} deprecated: false x-readme: code-samples: - language: text code: "{\n \"TransmissionMethods\": [\"Link\"]\n \n}" name: Resend Transmission Request Example - Link samples-languages: - text tags: - IssueCard /api/v1/IssueCard/UpdateDelayedCard/{{CardGuid}}: put: summary: Update Virtual Card with Delayed Activation description: Request this endpoint to update the activation date or card limit of a virtual card with a future activation date. operationId: update-delayed-card parameters: - name: CardGuid in: path description: Global Unique Identifier for the Card. schema: type: string required: true - name: Content-Type in: header description: Content-Type Header schema: type: string - name: Authorization in: header description: 'Token. Eg: "Bearer eHSN5rTBzqDozgAAlN1UlTMVuIT1zSiAZWCo6E..."' schema: type: string requestBody: content: application/json: schema: type: object required: - MerchantGuid properties: MerchantGuid: type: string description: Merchant's guid. Application level value that indicates a virtual card is being requested for clients account. Value provided by ConnexPay. ActivationDate: type: string description: Provide a future date, up to 36 months, if you wish to update the virtual card's activation date. Otherwise leave blank. format: date AmountLimit: type: number description: Provide a card amount if you wish to update the amount limit for the virtual card, otherwise leave blank. format: float TerminateDate: type: string description: The TerminateDate (YYYY-MM-DD format) is the date the Virtual Credit Card will be terminated by ConnexPay. TerminateDate is different than ExpirationDate in that TerminateDate indicates the actual date the card will no longer be active. ExpirationDate is the month and year that will be applied to the actual VCC. The recommendation is to set the ExpirationDate one or two years in the future and set the TerminateDate just a day or two after the VCC is expected to be processed. Note, Returns can still be processed on terminated VCCs. format: date responses: '200': description: '200' content: application/json: examples: Result: value: "{\n \"cardHolder\": {\n \"cardHolderGuid\": \"f1bcad52-4507-4333-a74e-dbc5367982ab\",\n \"firstName\": \"Ping\",\n \"lastName\": \"Lite\",\n \"phone\": \"1231231234\",\n \"address1\": \"107 Techlogy Park\",\n \"address2\": \"\",\n \"city\": \"PT Corners\",\n \"zipcode\": \"30092\"\n },\n \"card\": {\n \"cardGuid\": \"1c2a5ec3-67fe-4f2d-984b-fa8acb66a2f3\",\n \"amountLimit\": 22,\n \"usageLimit\": 2,\n \"limitWindow\": \"LIFETIME\",\n \"expirationDate\": \"2022-12-24T23:59:59\",\n \"expiration\": \"1222\",\n \"firstSix\": \"111111\",\n \"lastFour\": \"0717\",\n \"nameLine1\": \"Ping\",\n \"nameLine2\": \"Lite\",\n \"status\": \"Card - Active, but delayed Activation Auth Limit of $1.0 applied.\",\n \"activationDate\": \"12/3/2021\",\n \"cardType\": \"Other\"\n }\n}" schema: type: object properties: cardHolder: type: object properties: cardHolderGuid: type: string example: f1bcad52-4507-4333-a74e-dbc5367982ab firstName: type: string example: Ping lastName: type: string example: Lite phone: type: string example: '1231231234' address1: type: string example: 107 Techlogy Park address2: type: string example: '' city: type: string example: PT Corners zipcode: type: string example: '30092' card: type: object properties: cardGuid: type: string example: 1c2a5ec3-67fe-4f2d-984b-fa8acb66a2f3 amountLimit: type: integer example: 22 default: 0 usageLimit: type: integer example: 2 default: 0 limitWindow: type: string example: LIFETIME expirationDate: type: string example: '2022-12-24T23:59:59' expiration: type: string example: '1222' firstSix: type: string example: '111111' lastFour: type: string example: '0717' nameLine1: type: string example: Ping nameLine2: type: string example: Lite status: type: string example: Card - Active, but delayed Activation Auth Limit of $1.0 applied. activationDate: type: string example: 12/3/2021 cardType: type: string example: Other '400': description: '400' content: application/json: examples: Result: value: '{}' schema: type: object properties: {} deprecated: false tags: - IssueCard /api/v1/IssueCard/ActivateDelayedCard/{{CardGuid}}: put: summary: Activate Virtual Card with Delayed Activation description: Use this API to immediately activate a Virtual Card with a delayed activation date operationId: activate-a-virtual-card-with-delayed-activation responses: '200': description: '200' content: application/json: examples: Result: value: "{\n \"cardHolder\": {\n \"cardHolderGuid\": \"f1bcad52-4507-4333-a74e-dbc5367982ab\",\n \"firstName\": \"Ping\",\n \"lastName\": \"Lite\",\n \"phone\": \"1231231234\",\n \"address1\": \"107 Techlogy Park\",\n \"address2\": \"\",\n \"city\": \"PT Corners\",\n \"zipcode\": \"30092\"\n },\n \"card\": {\n \"cardGuid\": \"1c2a5ec3-67fe-4f2d-984b-fa8acb66a2f3\",\n \"amountLimit\": 22,\n \"usageLimit\": 2,\n \"limitWindow\": \"LIFETIME\",\n \"expirationDate\": \"2022-12-24T23:59:59\",\n \"expiration\": \"1222\",\n \"firstSix\": \"111111\",\n \"lastFour\": \"0717\",\n \"nameLine1\": \"Ping\",\n \"nameLine2\": \"Lite\",\n \"status\": \"Card - Active\",\n \"cardType\": \"Other\"\n }\n}\n\n" schema: type: object properties: cardHolder: type: object properties: cardHolderGuid: type: string example: f1bcad52-4507-4333-a74e-dbc5367982ab firstName: type: string example: Ping lastName: type: string example: Lite phone: type: string example: '1231231234' address1: type: string example: 107 Techlogy Park address2: type: string example: '' city: type: string example: PT Corners zipcode: type: string example: '30092' card: type: object properties: cardGuid: type: string example: 1c2a5ec3-67fe-4f2d-984b-fa8acb66a2f3 amountLimit: type: integer example: 22 default: 0 usageLimit: type: integer example: 2 default: 0 limitWindow: type: string example: LIFETIME expirationDate: type: string example: '2022-12-24T23:59:59' expiration: type: string example: '1222' firstSix: type: string example: '111111' lastFour: type: string example: '0717' nameLine1: type: string example: Ping nameLine2: type: string example: Lite status: type: string example: Card - Active cardType: type: string example: Other '400': description: '400' content: application/json: examples: Result: value: '{}' schema: type: object properties: {} deprecated: false tags: - IssueCard /api/v1/IssueCard/GetActiveBins/{MerchantGuid}: get: summary: Return Active BIN List description: This endpoint returns a list of all active BINs. operationId: return-active-bin-list responses: '200': description: '200' content: application/json: examples: Result: value: - bankId: 4 cardBin: '411111' cardClass: Commercial currency: USD maxSpend: 500000 isGlobal: false globalLimitWindow: UNKNOWN c3DSEnabled: true isLodgedCardBin: false isPrepaid: Credit - bankId: 4 cardBin: '554866' cardClass: Commercial currency: CAD maxSpend: 50000 isGlobal: true globalLimitWindow: UNKNOWN c3DSEnabled: true isLodgedCardBin: true isPrepaid: Prepaid - bankId: 4 cardBin: '499999' cardClass: Commercial currency: USD maxSpend: 10000 isGlobal: false globalLimitWindow: UNKNOWN c3DSEnabled: true isLodgedCardBin: true isPrepaid: Credit - bankId: 4 cardBin: '554866' cardClass: Consumer currency: USD maxSpend: 10000 isGlobal: false globalLimitWindow: UNKNOWN c3DSEnabled: true isLodgedCardBin: true isPrepaid: Credit - bankId: 4 cardBin: '554866' cardClass: Commercial currency: CAD maxSpend: 10000 isGlobal: false globalLimitWindow: UNKNOWN c3DSEnabled: true isLodgedCardBin: true isPrepaid: Credit schema: type: array items: type: object properties: bankId: type: integer example: 4 default: 0 cardBin: type: string example: '411111' cardClass: type: string example: Commercial currency: type: string example: USD maxSpend: type: integer example: 500000 default: 0 isGlobal: type: boolean example: false default: true globalLimitWindow: type: string example: UNKNOWN c3DSEnabled: type: boolean example: false default: true isLodgedCardBin: type: boolean example: false default: true isPrepaid: type: string example: Credit '400': description: '400' content: application/json: examples: Result: value: '{}' schema: type: object properties: {} deprecated: false tags: - IssueCard /api/v1/IssueCard/PhysicalCard: post: summary: Issue Physical Card description: Use this endpoint to create a Physical Card. Issuing Physical Cards requires approval and set up. Please contact your Client Success representative if you're interested in learning more. operationId: issue-physical-card parameters: - name: Content-Type in: header description: '"application/json"' schema: type: string - name: Authorization in: header description: 'Token. Eg: "Bearer eHSN5rTBzqDozgAAlN1UlTMVuIT1zSiAZWCo6E..."' schema: type: string requestBody: content: application/json: schema: type: object required: - AmountLimit - PhysicalCardFulfillment - MerchantGuid - Country - FirstName - LastName - Address1 - City - State - ZipCode - DateOfBirth - LimitWindow properties: MerchantGuid: type: string description: Merchant's guid. Application level value that indicates a physical card is being requested for clients account. Value provided by ConnexPay. FirstName: type: string description: Cardholder's first name. This is the first name placed on the physical card. The value is also searchable in the Bridge. The total length of the combined FirstName and LastName fields cannot exceed 25 characters. LastName: type: string description: Cardholder's last name. This is the last name placed on the physical card. The value is also searchable in Bridge. The total length of the combined FirstName and LastName fields cannot exceed 25 characters. Phone: type: integer description: Cardholder's phone number. Phone number up to 20 character string. format: int32 Address1: type: string description: Cardholder's address line 1. Alphanumeric. Address2: type: string description: Cardholder's address line 2. Alphanumeric. City: type: string description: Cardholder's city. State: type: string description: Cardholder's short name state. The ISO 3166-2 CA and US state or province code of a user. Length = 2. If a non U.S. or Canadian value is submitted the card request will not be processed and an error response returned. Country: type: string description: Cardholder's country. Only alpha-2 digit country code allowed and numbers are not allowed. See ISO-3166 country list of Alpha-2 country codes (https://www.iso.org/obp/ui/) . ZipCode: type: string description: Cardholder's zipcode. The Zipcode must be between 1 and 10 characters long, Only numbers and letters are allowed. DateOfBirth: type: string description: Cardholder's date of birth in ISO 8601 format. format: date AmountLimit: type: number description: 'Security Control: Maximum dollar amount the card can be authorized and settled, which must be less than or equal to $4,999,999.99. The value must incorporate any anticipated overages such as currency conversion or taxes that a supplier may associate with the transaction. Once the amount limit has been reached, any future authorizations will be declined.' format: float UsageLimit: type: integer description: 'Security Control: Maximum number of times the card may be authorized. If you do not provide a usage limit, the card will be considered unlimited.' format: int64 LimitWindow: type: string description: 'Time period for the spending limits. Valid values: ''Daily'', ''Weekly'', and ''Monthly''. Defines how the amountLimit and usageLimit are reset.' enum: - Daily - Weekly - Monthly IncomingTransactionCode: type: string description: Internal transaction code for associating the card with a specific sale or transaction. SaleGuid: type: string description: Only applicable when tied to an incoming Sale; globally unique identifier for the linked sale. Null values and field not present are supported. OutcomingTransactionCode: type: string description: '"Outgoing transaction code for tracking purposes.' PurchaseType: type: string description: 'Security Control: The industry where the virtual card will be utilized. For example, if value set to airline and the card is used at hotel, it will be declined. Available purchase type values are: ''01'' (Airline), ''02'' (Hotels and Resorts), ''03'' (Car Rental), ''04'' (Cable, Satellite, Television, and Radio Services), ''05'' (Cruise Lines), ''06'' (Travel), ''11'' (Medical Services and Health Practitioners), ''21'' (Advertising Services), ''22'' (Misc Advertising and Business Services), ''23'' (Ticketing), ''31'' (Insurance Sales, Underwriting, and Premiums), ''32'' (Insurance and Real Estate Codes), ''91'' (Restaurants and Food Services), and ''93'' (Tax Payments). Required if MidWhitelist not provided.' PayeeId: type: string description: The PayeeId is used to assist with Intelligent Routing functionality. This field was previously labeled as the Supplier ID and serves the same purpose for Intelligent Routing; however, it also supports additional functionality if a Payee has been created. Creating a Payee allows you complete control over the type of virtual card used to pay your payee and minimizes the data that must be passed in each card request. The field accepts up to 100 alpha-numeric characters, special characters, and spaces. Reference our MerchantPayees APIs for additional details. Transmission: type: object properties: TransmissionMethods: type: array items: type: string description: 'Supported methods: Link. Use the ''Link'' option to have a URL included in the response.' description: 'Transmission settings for physical cards. Note: Email or fax transmission methods are not valid for physical cards as they must be shipped via mail.' SequenceNumber: type: string description: 'Transaction sequence number within client environment. Provide a unique SequenceNumber for each new request. If a card request is made with all the same parameter information and the same sequence number, within 30 minutes, the request will be considered a duplicate and a new card will not be issued. Note: value is not searchable or reportable in Bridge. The maximum length is 100 alpha-numeric characters.' AvsCheck: type: boolean description: Enable Address Verification System (AVS) check. When enabled, the address must match the billing address for authorization. Defaults to your client-level setting when not provided. TerminateDate: type: string description: 'Date when the card should be automatically terminated. Cannot be set to a date beyond one year from current date. Format: ISO 8601.' format: date-time ActivationDate: type: string description: Date when the card should be automatically activated. For delayed activation scenarios. format: date-time OrderNumber: type: string description: 'A value that is commonly used for reporting on and reconciling your PayIns and PayOuts. The Order Number is searchable in the ConnexPay Bridge and referenced in Analytics and reporting, and can be any identifier within your environment to associate with the sale or payment, such as a Record Locator, PNR, or transaction ID. The maximum length is 50 alpha-numeric characters and allows the following special characters: [._ /- ].' CustomerID: type: string description: 'Transaction ID within client environment associated with the customer. This value acts as a secondary identifier in conjunction with OrderNumber. The value is searchable and reportable in the ConnexPay portal. This value may be sent in multiple times within the integration for multiple purposes. The maximum length is 100 alphanumeric characters and the following special characters: [@._/-]. The maximum length is 50 characters and is alpha-numeric.' MidWhitelist: type: string description: List of Merchant IDs (MIDs) that are allowed. Only transactions at these merchants will be authorized. Required if PurchaseType not provided. MidBlacklist: type: string description: List of Merchant IDs (MIDs) that are blocked. Transactions at these merchants will be declined. LabelIds: type: integer description: Utilize Label IDs to associate a virtual card to a specific label(s) within ConnexPay Bridge UI for your organization. If a virtual card is tied to an incorrect Label, it will not filter or display correctly in Bridge's Search Grid. Please contact your Customer Care Consultant for a list of valid Label IDs before use. CurrencyCode: type: string description: Currency of the stored balance of the issued physical card. If left blank or unprovided, the default is your Accounting Currency. See https://docs.connexpay.com/reference/currency-and-region-codes for valid codes. Region: type: string description: Where (region/bank) the physical card is issued from. If left blank or unprovided, the default is your Accounting Region. See https://docs.connexpay.com/reference/currency-and-region-codes for valid codes. PhysicalCardFulfillment: type: object description: Physical card shipping/fulfillment information. Contains shipping address details for where the physical card should be mailed. properties: PhysicalCardShipping: type: object properties: Address1: type: string description: First line of the address of the business or organization where the physical card is being delivered. Address2: type: string description: Second line of the address of the business or organization where the physical card is being delivered. City: type: string description: City of the address of the business or organization where the physical card is being delivered. State: type: string description: State of the address of the business or organization where the physical card is being delivered. Country: type: string description: Country of the address of the business or organization where the physical card is being delivered. Zipcode: type: string description: Zip Code of the address of the business or organization where the physical card is being delivered. FirstName: type: string description: The first name of the business or organization where the physical card will be delivered. LastName: type: string description: The last name of the business or organization where the physical card will be delivered. Phone: type: string description: The phone number of the business or organization where the physical card will be delivered. description: Shipping address details for where the physical card should be mailed. Only shipping to US addresses is allowed. required: - Zipcode - FirstName - LastName - Country - Address1 - City - State ShippingMethod: type: string enum: - USPS - USPSPri - UPSGround - UPS2Day description: 'Method of shipping the physical card. Allowed methods are USPS First Class, USPS Priority, UPS Ground, and UPS Second Business Day. ' required: - PhysicalCardShipping - ShippingMethod examples: Issue Physical Card Request Example: value: MerchantGuid: '{{Merchant}}' FirstName: Test LastName: User DateOfBirth: 01-01-1990 PurchaseType: '' TerminateDate: '2027-10-26' AmountLimit: 5.03 LimitWindow: DAY UsageLimit: 2 OrderNumber: Test-Physical-Card LabelIds: - 124996 Address1: 1st Street Address2: Unit 29 Country: US State: GA City: Alpharetta Zipcode: '30022' Phone: '3121231234' MIDWhitelist: - '675957401524052' MIDBlacklist: - '670414901524053' PhysicalCardFulfillment: NameLine1: Shawn NameLine2: Test ShippingMethod: USPSPri PhysicalCardShipping: FirstName: Pat LastName: Card Address1: 1st Street Address2: Apt S Country: US State: GA City: Abville Zipcode: '12345' responses: '200': description: '200' content: application/json: examples: Issue Physical Card Response Example: value: cardHolder: cardHolderGuid: fad4b188-75f5-4e9c-9398-4c4ab5798e38 firstName: Test lastName: User phone: '3121231234' address1: 1st Street address2: Unit 29 city: Alpharetta state: GA zipcode: '30022' country: US card: cardGuid: 792e5678-1d2d-4841-b0c4-6a052fc0c012 accountNumber: '44111101122112222' amountLimit: 5.03 usageLimit: 2 limitWindow: DAY expirationDate: '2028-11-30T23:59:59Z' expiration: '1128' terminateDate: '2027-10-26T23:59:59' currencyCode: USD firstSix: '441111' lastFour: '2222' nameLine1: Test nameLine2: User status: Card - Unactivated customerServicePhoneNumber: 1-612-601-0914 midWhitelist: - '675957401524052' midBlacklist: - '670414901524053' labelIds: - 124996 gatewayMerchantGuid: 340fc848-4495-4682-aaee-920c4339526b availableBalance: 5.03 isPhysical: true isLodged: false fingerprint: 0C77AA9C0E1E67E0B1B1A09E2C478F10 customerId: null supplierId: null issuerId: 3 country: '' cardBin: '550000' cardClass: CommercialCredit toleranceAmount: null isGlobal: false physicalCardFulfillment: nameLine1: Shawn nameLine2: Test physicalCardShipping: address1: 1st Street address2: Apt S city: Abville state: GA country: US zipcode: '12345' firstName: Pat lastName: Card shippingMethod: USPSPri cardHolder: null outgoingTransactionCode: null createdBy: null isMaestro: false whitelistCountries: null blacklistCountries: null enableExactMatch: false avsCheck: false cardImageKey: null cardBrand: Visa cardClass: CommercialCredit orderNumber: Test-Physical-Card saleGuid: 00000000-0000-0000-0000-000000000000 incomingTransactionCode: 532FE4B638983186015474907 Issue Physical Card (ReturnCardData = False) Response Example: value: "{\n \"cardHolder\": {\n \"cardHolderGuid\": \"fad4b188-75f5-4e9c-9398-4c4ab5798e38\",\n \"firstName\": \"Ping\",\n \"lastName\": \"VCCPhysical\",\n \"phone\": \"3121231234\",\n \"address1\": \"107 Techlogy Park\",\n \"address2\": \"\",\n \"city\": \"PT Corners\",\n \"state\": \"NY\",\n \"zipcode\": \"30092\",\n \"country\": \"US\"\n },\n \"card\": {\n \"cardGuid\": \"adcc6b1a-72d9-430b-b054-0439ccb4605d\",\n \"amountLimit\": 5.0,\n \"usageLimit\": 1,\n \"limitWindow\": \"LIFETIME\",\n \"expirationDate\": \"2022-12-30T23:59:59\",\n \"expiration\": \"1222\",\n \"currencyCode\": \"USD\",\n \"firstSix\": \"111111\",\n \"lastFour\": \"5358\",\n \"nameLine1\": \"Ping\",\n \"nameLine2\": \"VCCPhysical\",\n \"status\": \"Card - Unactivated\",\n \"availableBalance\": 5.00,\n \"physicalCardFulfillment\": {\n \"nameLine1\": \"Ping R.\",\n \"nameLine2\": \"TEST\",\n \"physicalCardShipping\": {\n \"address1\": \"123 abc test\",\n \"city\": \"plymouth\",\n \"state\": \"MN\",\n \"country\": \"US\",\n \"zipcode\": \"55446\",\n \"firstName\": \"P\",\n \"lastName\": \"R\"\n },\n \"expedite\": false,\n \"shippingMethod\": \"LOCAL_MAIL\"\n }\n },\n \"cardBrand\": \"MasterCard\",\n \"cardClass\": \"Commercial\",\n \"saleGuid\": \"35290674-d24b-42c9-8e05-edbd53e1270f\"\n}" schema: oneOf: - title: Issue Physical Card Response Example type: object properties: cardHolder: type: object properties: cardHolderGuid: type: string example: fad4b188-75f5-4e9c-9398-4c4ab5798e38 firstName: type: string example: Ping lastName: type: string example: VCCPhysical phone: type: string example: '3121231234' address1: type: string example: 107 Techlogy Park address2: type: string example: '' city: type: string example: PT Corners state: type: string example: NY zipcode: type: string example: '30092' country: type: string example: US merchantGuid: type: string email: type: string customerId: type: string dateOfBirth: type: string reissuePhysicalCard: type: string card: type: object properties: cardGuid: type: string example: adcc6b1a-72d9-430b-b054-0439ccb4605d accountNumber: type: string example: '1111113968445358' securityCode: type: string example: '437' amountLimit: type: integer example: 5 default: 0 usageLimit: type: integer example: 1 default: 0 limitWindow: type: string example: LIFETIME expirationDate: type: string example: '2022-12-30T23:59:59' expiration: type: string example: '1222' currencyCode: type: string example: USD firstSix: type: string example: '111111' lastFour: type: string example: '5358' nameLine1: type: string example: Ping nameLine2: type: string example: VCCPhysical status: type: string example: Card - Unactivated availableBalance: type: integer example: 5 default: 0 physicalCardFulfillment: type: object properties: nameLine1: type: string example: Ping R. nameLine2: type: string example: TEST physicalCardShipping: type: object properties: address1: type: string example: 123 abc test city: type: string example: plymouth state: type: string example: MN country: type: string example: US zipcode: type: string example: '55446' firstName: type: string example: P lastName: type: string example: R expedite: type: boolean example: false default: true shippingMethod: type: string example: LOCAL_MAIL cardBrand: type: string example: MasterCard cardClass: type: string example: Commercial saleGuid: type: string example: 35290674-d24b-42c9-8e05-edbd53e1270f - title: Issue Physical Card (ReturnCardData = False) Response Example type: object properties: cardHolder: type: object properties: cardHolderGuid: type: string example: fad4b188-75f5-4e9c-9398-4c4ab5798e38 firstName: type: string example: Ping lastName: type: string example: VCCPhysical phone: type: string example: '3121231234' address1: type: string example: 107 Techlogy Park address2: type: string example: '' city: type: string example: PT Corners state: type: string example: NY zipcode: type: string example: '30092' country: type: string example: US merchantGuid: type: string email: type: string customerId: type: string dateOfBirth: type: string format: date-time card: type: object properties: cardGuid: type: string example: adcc6b1a-72d9-430b-b054-0439ccb4605d amountLimit: type: integer example: 5 default: 0 usageLimit: type: integer example: 1 default: 0 limitWindow: type: string example: LIFETIME expirationDate: type: string example: '2022-12-30T23:59:59' expiration: type: string example: '1222' currencyCode: type: string example: USD firstSix: type: string example: '111111' lastFour: type: string example: '5358' nameLine1: type: string example: Ping nameLine2: type: string example: VCCPhysical status: type: string example: Card - Unactivated availableBalance: type: integer example: 5 default: 0 physicalCardFulfillment: type: object properties: nameLine1: type: string example: Ping R. nameLine2: type: string example: TEST physicalCardShipping: type: object properties: address1: type: string example: 123 abc test city: type: string example: plymouth state: type: string example: MN country: type: string example: US zipcode: type: string example: '55446' firstName: type: string example: P lastName: type: string example: R expedite: type: boolean example: false default: true shippingMethod: type: string example: LOCAL_MAIL cardBrand: type: string example: MasterCard cardClass: type: string example: Commercial saleGuid: type: string example: 35290674-d24b-42c9-8e05-edbd53e1270f '400': description: '400' content: application/json: examples: Result: value: '{}' schema: type: object properties: {} deprecated: false tags: - IssueCard /api/v1/IssueCard/ActivatePhysicalCard/{cardGuid}: put: summary: Copy of Issue Physical Card description: Use this endpoint to create a Physical Card. Issuing Physical Cards requires approval and set up. Please contact your Client Success representative if you're interested in learning more. operationId: post_apiv1IssueCardPhysicalCard-1 parameters: - name: Content-Type in: header description: '"application/json"' schema: type: string - name: Authorization in: header description: 'Token. Eg: "Bearer eHSN5rTBzqDozgAAlN1UlTMVuIT1zSiAZWCo6E..."' schema: type: string - in: path name: cardGuid schema: type: string required: true description: 'Global Unique Identifier of the Physical Card to be activated. ' requestBody: content: application/json: schema: type: object properties: {} examples: {} responses: '200': description: '200' content: application/json: examples: Activate Physical Card Response Example: value: message: Card activated successfully. summary: Activate Physical Card Response Example schema: title: Activate Physical Card Response Example type: object properties: message: type: string '422': description: '422' content: application/json: examples: Result: value: message: Card fb4f44d4-ed7d-4e89-9467-67fb6670f9de is already active. schema: type: object properties: message: type: string deprecated: false tags: - IssueCard /api/v1/IssueCard/PhysicalCard-1: post: summary: Copy of Issue Physical Card description: Use this endpoint to create a Physical Card. Issuing Physical Cards requires approval and set up. Please contact your Client Success representative if you're interested in learning more. operationId: post_apiv1IssueCardPhysicalCard-1 parameters: - name: Content-Type in: header description: '"application/json"' schema: type: string - name: Authorization in: header description: 'Token. Eg: "Bearer eHSN5rTBzqDozgAAlN1UlTMVuIT1zSiAZWCo6E..."' schema: type: string requestBody: content: application/json: schema: type: object required: - AmountLimit - PhysicalCardFulfillment - MerchantGuid - Country - FirstName - LastName - Address1 - City - State - ZipCode - DateOfBirth - LimitWindow properties: MerchantGuid: type: string description: Merchant's guid. Application level value that indicates a physical card is being requested for clients account. Value provided by ConnexPay. FirstName: type: string description: Cardholder's first name. This is the first name placed on the physical card. The value is also searchable in the Bridge. The total length of the combined FirstName and LastName fields cannot exceed 25 characters. LastName: type: string description: Cardholder's last name. This is the last name placed on the physical card. The value is also searchable in Bridge. The total length of the combined FirstName and LastName fields cannot exceed 25 characters. Phone: type: integer description: Cardholder's phone number. Phone number up to 20 character string. format: int32 Address1: type: string description: Cardholder's address line 1. Alphanumeric. Address2: type: string description: Cardholder's address line 2. Alphanumeric. City: type: string description: Cardholder's city. State: type: string description: Cardholder's short name state. The ISO 3166-2 CA and US state or province code of a user. Length = 2. If a non U.S. or Canadian value is submitted the card request will not be processed and an error response returned. Country: type: string description: Cardholder's country. Only alpha-2 digit country code allowed and numbers are not allowed. See ISO-3166 country list of Alpha-2 country codes (https://www.iso.org/obp/ui/) . ZipCode: type: string description: Cardholder's zipcode. The Zipcode must be between 1 and 10 characters long, only numbers and letters are allowed. DateOfBirth: type: string description: Cardholder's date of birth in ISO 8601 format. format: date AmountLimit: type: number description: 'Security Control: Maximum dollar amount the card can be authorized and settled, which must be less than or equal to $4,999,999.99. The value must incorporate any anticipated overages such as currency conversion or taxes that a supplier may associate with the transaction. Once the amount limit has been reached, any future authorizations will be declined.' format: float UsageLimit: type: integer description: 'Security Control: Maximum number of times the card may be authorized. If you do not provide a usage limit, the card will be considered unlimited.' format: int64 LimitWindow: type: string description: 'Time period for the spending limits. Valid values: ''Daily'', ''Weekly'', and ''Monthly''. Defines how the amountLimit and usageLimit are reset.' enum: - Daily - Weekly - Monthly Mcc: type: string description: Merchant Category Code (MCC) restriction. Only transactions at merchants with this MCC will be authorized. IncomingTransactionCode: type: string description: Internal transaction code for associating the card with a specific sale or transaction. SaleGuid: type: string description: Only applicable when tied to an incoming Sale; globally unique identifier for the linked sale. Null values and field not present are supported. OutcomingTransactionCode: type: string description: '"Outgoing transaction code for tracking purposes.' PurchaseType: type: string description: 'Security Control: The industry where the virtual card will be utilized. For example, if value set to airline and the card is used at hotel, it will be declined. Available purchase type values are: ''01'' (Airline), ''02'' (Hotels and Resorts), ''03'' (Car Rental), ''04'' (Cable, Satellite, Television, and Radio Services), ''05'' (Cruise Lines), ''06'' (Travel), ''11'' (Medical Services and Health Practitioners), ''21'' (Advertising Services), ''22'' (Misc Advertising and Business Services), ''23'' (Ticketing), ''31'' (Insurance Sales, Underwriting, and Premiums), ''32'' (Insurance and Real Estate Codes), ''91'' (Restaurants and Food Services), and ''93'' (Tax Payments). Required if MidWhitelist not provided.' PayeeId: type: string description: The PayeeId is used to assist with Intelligent Routing functionality. This field was previously labeled as the Supplier ID and serves the same purpose for Intelligent Routing; however, it also supports additional functionality if a Payee has been created. Creating a Payee allows you complete control over the type of virtual card used to pay your payee and minimizes the data that must be passed in each card request. The field accepts up to 100 alpha-numeric characters, special characters, and spaces. Reference our MerchantPayees APIs for additional details. Transmission: type: object properties: TransmissionMethods: type: array items: type: string description: 'Supported methods: Link. Use the ''Link'' option to have a URL included in the response.' description: 'Transmission settings for physical cards. Note: Email or fax transmission methods are not valid for physical cards as they must be shipped via mail.' SequenceNumber: type: string description: 'Transaction sequence number within client environment. Provide a unique SequenceNumber for each new request. If a card request is made with all the same parameter information and the same sequence number, within 30 minutes, the request will be considered a duplicate and a new card will not be issued. Note: value is not searchable or reportable in Bridge. The maximum length is 100 alpha-numeric characters.' AvsCheck: type: boolean description: Enable Address Verification System (AVS) check. When enabled, the address must match the billing address for authorization. TerminateDate: type: string description: 'Date when the card should be automatically terminated. Cannot be set to a date beyond one year from current date. Format: ISO 8601.' format: date-time ActivationDate: type: string description: Date when the card should be automatically activated. For delayed activation scenarios. format: date-time OrderNumber: type: string description: 'A value that is commonly used for reporting on and reconciling your PayIns and PayOuts. The Order Number is searchable in the ConnexPay Bridge and referenced in Analytics and reporting, and can be any identifier within your environment to associate with the sale or payment, such as a Record Locator, PNR, or transaction ID. The maximum length is 50 alpha-numeric characters and allows the following special characters: [._ /- ].' CustomerID: type: string description: 'Transaction ID within client environment associated with the customer. This value acts as a secondary identifier in conjunction with OrderNumber. The value is searchable and reportable in the ConnexPay portal. This value may be sent in multiple times within the integration for multiple purposes. The maximum length is 100 alphanumeric characters and the following special characters: [@._/-]. The maximum length is 50 characters and is alpha-numeric.' MidWhitelist: type: string description: List of Merchant IDs (MIDs) that are allowed. Only transactions at these merchants will be authorized. Required if PurchaseType not provided. MidBlacklist: type: string description: List of Merchant IDs (MIDs) that are blocked. Transactions at these merchants will be declined. LabelIds: type: integer description: Utilize Label IDs to associate a virtual card to a specific label(s) within ConnexPay Bridge UI for your organization. If a virtual card is tied to an incorrect Label, it will not filter or display correctly in Bridge's Search Grid. Please contact your Customer Care Consultant for a list of valid Label IDs before use. CurrencyCode: type: string description: Currency of the stored balance of the issued physical card. If left blank or unprovided, the default is your Accounting Currency. See https://docs.connexpay.com/reference/currency-and-region-codes for valid codes. Region: type: string description: Where (region/bank) the physical card is issued from. If left blank or unprovided, the default is your Accounting Region. See https://docs.connexpay.com/reference/currency-and-region-codes for valid codes. PhysicalCardFulfillment: type: object description: Physical card shipping/fulfillment information. Contains shipping address details for where the physical card should be mailed. properties: PhysicalCardShipping: type: object properties: Address1: type: string description: First line of the address of the business or organization where the physical card is being delivered. Address2: type: string description: Second line of the address of the business or organization where the physical card is being delivered. City: type: string description: City of the address of the business or organization where the physical card is being delivered. State: type: string description: State of the address of the business or organization where the physical card is being delivered. Country: type: string description: Country of the address of the business or organization where the physical card is being delivered. Zipcode: type: string description: Zip Code of the address of the business or organization where the physical card is being delivered. FirstName: type: string description: The first name of the business or organization where the physical card will be delivered. LastName: type: string description: The last name of the business or organization where the physical card will be delivered. Phone: type: string description: The phone number of the business or organization where the physical card will be delivered. description: Shipping address details for where the physical card should be mailed. Only shipping to US addresses is allowed. required: - Zipcode - FirstName - LastName - Country - Address1 - City - State ShippingMethod: type: string enum: - USPS - USPSPri - UPSGround - UPS2Day description: 'Method of shipping the physical card. Allowed methods are USPS First Class, USPS Priority, UPS Ground, and UPS Second Business Day. ' required: - PhysicalCardShipping - ShippingMethod examples: Issue Physical Card Request Example: value: MerchantGuid: '{{Merchant}}' FirstName: Test LastName: User DateOfBirth: 01-01-1990 PurchaseType: '' TerminateDate: '2027-10-26' AmountLimit: 5.03 LimitWindow: DAY UsageLimit: 2 OrderNumber: Test-Physical-Card LabelIds: - 124996 Address1: 1st Street Address2: Unit 29 Country: US State: GA City: Alpharetta Zipcode: '30022' Phone: '3121231234' MIDWhitelist: - '675957401524052' MIDBlacklist: - '670414901524053' PhysicalCardFulfillment: NameLine1: Shawn NameLine2: Test ShippingMethod: USPSPri PhysicalCardShipping: FirstName: Pat LastName: Card Address1: 1st Street Address2: Apt S Country: US State: GA City: Abville Zipcode: '12345' responses: '200': description: '200' content: application/json: examples: Issue Physical Card Response Example: value: cardHolder: cardHolderGuid: fad4b188-75f5-4e9c-9398-4c4ab5798e38 firstName: Test lastName: User phone: '3121231234' address1: 1st Street address2: Unit 29 city: Alpharetta state: GA zipcode: '30022' country: US card: cardGuid: 792e5678-1d2d-4841-b0c4-6a052fc0c012 accountNumber: '44111101122112222' amountLimit: 5.03 usageLimit: 2 limitWindow: DAY expirationDate: '2028-11-30T23:59:59Z' expiration: '1128' terminateDate: '2027-10-26T23:59:59' currencyCode: USD firstSix: '441111' lastFour: '2222' nameLine1: Test nameLine2: User status: Card - Unactivated customerServicePhoneNumber: 1-612-601-0914 midWhitelist: - '675957401524052' midBlacklist: - '670414901524053' labelIds: - 124996 gatewayMerchantGuid: 340fc848-4495-4682-aaee-920c4339526b availableBalance: 5.03 isPhysical: true isLodged: false fingerprint: 0C77AA9C0E1E67E0B1B1A09E2C478F10 customerId: null supplierId: null issuerId: 3 country: '' cardBin: '550000' cardClass: CommercialCredit toleranceAmount: null isGlobal: false physicalCardFulfillment: nameLine1: Shawn nameLine2: Test physicalCardShipping: address1: 1st Street address2: Apt S city: Abville state: GA country: US zipcode: '12345' firstName: Pat lastName: Card shippingMethod: USPSPri cardHolder: null outgoingTransactionCode: null createdBy: null isMaestro: false whitelistCountries: null blacklistCountries: null enableExactMatch: false avsCheck: false cardImageKey: null cardBrand: Visa cardClass: CommercialCredit orderNumber: Test-Physical-Card saleGuid: 00000000-0000-0000-0000-000000000000 incomingTransactionCode: 532FE4B638983186015474907 Issue Physical Card (ReturnCardData = False) Response Example: value: "{\n \"cardHolder\": {\n \"cardHolderGuid\": \"fad4b188-75f5-4e9c-9398-4c4ab5798e38\",\n \"firstName\": \"Ping\",\n \"lastName\": \"VCCPhysical\",\n \"phone\": \"3121231234\",\n \"address1\": \"107 Techlogy Park\",\n \"address2\": \"\",\n \"city\": \"PT Corners\",\n \"state\": \"NY\",\n \"zipcode\": \"30092\",\n \"country\": \"US\"\n },\n \"card\": {\n \"cardGuid\": \"adcc6b1a-72d9-430b-b054-0439ccb4605d\",\n \"amountLimit\": 5.0,\n \"usageLimit\": 1,\n \"limitWindow\": \"LIFETIME\",\n \"expirationDate\": \"2022-12-30T23:59:59\",\n \"expiration\": \"1222\",\n \"currencyCode\": \"USD\",\n \"firstSix\": \"111111\",\n \"lastFour\": \"5358\",\n \"nameLine1\": \"Ping\",\n \"nameLine2\": \"VCCPhysical\",\n \"status\": \"Card - Unactivated\",\n \"availableBalance\": 5.00,\n \"physicalCardFulfillment\": {\n \"nameLine1\": \"Ping R.\",\n \"nameLine2\": \"TEST\",\n \"physicalCardShipping\": {\n \"address1\": \"123 abc test\",\n \"city\": \"plymouth\",\n \"state\": \"MN\",\n \"country\": \"US\",\n \"zipcode\": \"55446\",\n \"firstName\": \"P\",\n \"lastName\": \"R\"\n },\n \"expedite\": false,\n \"shippingMethod\": \"LOCAL_MAIL\"\n }\n },\n \"cardBrand\": \"MasterCard\",\n \"cardClass\": \"Commercial\",\n \"saleGuid\": \"35290674-d24b-42c9-8e05-edbd53e1270f\"\n}" schema: oneOf: - title: Issue Physical Card Response Example type: object properties: cardHolder: type: object properties: cardHolderGuid: type: string example: fad4b188-75f5-4e9c-9398-4c4ab5798e38 firstName: type: string example: Ping lastName: type: string example: VCCPhysical phone: type: string example: '3121231234' address1: type: string example: 107 Techlogy Park address2: type: string example: '' city: type: string example: PT Corners state: type: string example: NY zipcode: type: string example: '30092' country: type: string example: US merchantGuid: type: string email: type: string customerId: type: string dateOfBirth: type: string reissuePhysicalCard: type: string card: type: object properties: cardGuid: type: string example: adcc6b1a-72d9-430b-b054-0439ccb4605d accountNumber: type: string example: '1111113968445358' securityCode: type: string example: '437' amountLimit: type: integer example: 5 default: 0 usageLimit: type: integer example: 1 default: 0 limitWindow: type: string example: LIFETIME expirationDate: type: string example: '2022-12-30T23:59:59' expiration: type: string example: '1222' currencyCode: type: string example: USD firstSix: type: string example: '111111' lastFour: type: string example: '5358' nameLine1: type: string example: Ping nameLine2: type: string example: VCCPhysical status: type: string example: Card - Unactivated availableBalance: type: integer example: 5 default: 0 physicalCardFulfillment: type: object properties: nameLine1: type: string example: Ping R. nameLine2: type: string example: TEST physicalCardShipping: type: object properties: address1: type: string example: 123 abc test city: type: string example: plymouth state: type: string example: MN country: type: string example: US zipcode: type: string example: '55446' firstName: type: string example: P lastName: type: string example: R expedite: type: boolean example: false default: true shippingMethod: type: string example: LOCAL_MAIL cardBrand: type: string example: MasterCard cardClass: type: string example: Commercial saleGuid: type: string example: 35290674-d24b-42c9-8e05-edbd53e1270f - title: Issue Physical Card (ReturnCardData = False) Response Example type: object properties: cardHolder: type: object properties: cardHolderGuid: type: string example: fad4b188-75f5-4e9c-9398-4c4ab5798e38 firstName: type: string example: Ping lastName: type: string example: VCCPhysical phone: type: string example: '3121231234' address1: type: string example: 107 Techlogy Park address2: type: string example: '' city: type: string example: PT Corners state: type: string example: NY zipcode: type: string example: '30092' country: type: string example: US merchantGuid: type: string email: type: string customerId: type: string dateOfBirth: type: string format: date-time card: type: object properties: cardGuid: type: string example: adcc6b1a-72d9-430b-b054-0439ccb4605d amountLimit: type: integer example: 5 default: 0 usageLimit: type: integer example: 1 default: 0 limitWindow: type: string example: LIFETIME expirationDate: type: string example: '2022-12-30T23:59:59' expiration: type: string example: '1222' currencyCode: type: string example: USD firstSix: type: string example: '111111' lastFour: type: string example: '5358' nameLine1: type: string example: Ping nameLine2: type: string example: VCCPhysical status: type: string example: Card - Unactivated availableBalance: type: integer example: 5 default: 0 physicalCardFulfillment: type: object properties: nameLine1: type: string example: Ping R. nameLine2: type: string example: TEST physicalCardShipping: type: object properties: address1: type: string example: 123 abc test city: type: string example: plymouth state: type: string example: MN country: type: string example: US zipcode: type: string example: '55446' firstName: type: string example: P lastName: type: string example: R expedite: type: boolean example: false default: true shippingMethod: type: string example: LOCAL_MAIL cardBrand: type: string example: MasterCard cardClass: type: string example: Commercial saleGuid: type: string example: 35290674-d24b-42c9-8e05-edbd53e1270f '400': description: '400' content: application/json: examples: Result: value: '{}' schema: type: object properties: {} deprecated: false tags: - IssueCard /api/v1/IssueCard/IssueLite-1: post: summary: Issue Lite description: For our lite clients, we provide the ability to issue a VCC (Virtual Credit Card) via API without the requirement to process a sale first. If you aren't sure which Issuance API to use, please contact your client support representative. operationId: issuelite-1-1 parameters: - name: Content-Type in: header description: '"application/json"' schema: type: string default: application/json - name: Authorization in: header description: 'Token. Eg: "Bearer eHSN5rTBzqDozgAAlN1UlTMVuIT1zSiAZWCo6E..."' schema: type: string default: Bearer eHSN5rTBzqDozgAAlN1UlTMVuIT1zSiAZWCo6E... requestBody: content: application/json: schema: type: object required: - MerchantGuid - FirstName - AmountLimit - PurchaseType - LastName properties: MerchantGuid: type: string description: Merchant's guid. Application level value that indicates a virtual card is being requested for clients account. Value provided by ConnexPay. default: '' FirstName: type: string description: Cardholder's first name. This is the first name placed on the virtual card provided to the supplier. The value is also searchable in the ConnexPay portal. The maximum length is 50 characters. default: '' LastName: type: string description: Cardholder's last name. This is the last name placed on the virtual card provided to the supplier. The value is also searchable in the ConnexPay portal. The maximum length is 50 characters. default: '' Phone: type: string description: Cardholder's phone number. Phone number up to 20 character string, numbers and plus sign (+) allowed only. Telephone number of the user (including area code), prepended by the + symbol and the 1- to 3-digit country calling code. Do not include hyphens, spaces, or parentheses. default: '' Address1: type: string description: Cardholder's address line 1. The street number is used by the supplier when submitting the transaction to perform an AVS check. Alphanumerics and [,.-'] are allowed. default: '' Address2: type: string description: Cardholder's address line 2. Alphanumerics and [,.-'] are allowed. default: '' City: type: string description: Cardholder's city. default: '' State: type: string description: Cardholder's short name state. The ISO 3166-2 CA and US state or province code of a user. Length = 2. If a non U.S. or Canadian value is submitted the virtual card request will not be processed and an error response returned. default: '' ZipCode: type: string description: Cardholder's zipcode. The zip code is used by the supplier when submitting the transaction to perform an AVS check. The Zipcode must be between 1 and 10 characters long, only numbers and letters are allowed. default: '' Country: type: string description: Cardholder's country. Only alpha-2 digit country code allowed and numbers are not allowed. See ISO-3166 country list of Alpha-2 country codes (https://www.iso.org/obp/ui/) . default: '' CurrencyCode: type: string description: Do not use without consulting with your CXP resources for applicable use. Default is your Accounting Currency if left blank/unprovided. Currency of the stored balance of the issued virtual card. Region: type: string description: Do not use without consulting with your CXP resources for applicable use. Default is your Accounting Region if left blank/unprovided. Where (region/bank) the virtual card is issued from. UsageLimit: type: integer description: 'Security Control: Maximum number of times the card may be authorized. The maximum allowed field value is 99, and if you do not provide a value the card will be considered unlimited. The exception to this are UATP cards, which have a maximum allowed value of 9999 and will default to that max if no value is provided. Authorization attempts exceeding the provided value will be declined. Even though a virtual card is often considered a “one-time-use” card, some suppliers may need to authorize a card multiple times (pre-authorizations, a purchase comprised of multiple tickets, etc.) and you may consider a value that is not overly restrictive to avoid unwanted declines.' format: int64 AmountLimit: type: number description: 'Security Control: Maximum dollar amount the card can be authorized and settled, which must be less than or equal to $4,999,999.99 ($1,200,000.00 CAD for Canadian Issuing clients). The value must incorporate any anticipated overages such as currency conversion or taxes that a supplier may associate with the transaction. If a supplier attempts to authorize a card for more than the amount limit it will be declined.' default: '' format: float ExpirationDate: type: string description: The ExpirationDate (YYYY-MM-DD) is the date to be provided to the supplier as the actual expiration date for the virtual card. The recommendation is to set the ExpirationDate one or two years in the future and set the TerminateDate just a day or two after the VCC is expected to be processed to avoid acceptance issues. The expiration date cannot be more than 48 months in the future. If an expiration date is not provided, the expiration will default to issue date plus three years. For cards issued outside of the US/Canada, the expiration date will default to issue date plus three years and can not be overwritten - even if this parameter is included in the request. Note, Returns can still be processed on expired or terminated VCCs. format: date TerminateDate: type: string description: The TerminateDate (YYYY-MM-DD format) is the date the Virtual Credit Card will be terminated by ConnexPay. TerminateDate is different than ExpirationDate in that TerminateDate indicates the actual date the card will no longer be active. The recommendation is to set the ExpirationDate one or two years in the future and set the TerminateDate just a day or two after the VCC is expected to be processed. If a terminate date is not indicated, the card will be inactivated as of the expiration date. Note, Returns can still be processed on terminated VCCs and UATP termination dates cannot exceed 12 months. format: date PurchaseType: type: string description: 'Security Control: The industry(s) where a virtual card can be used. For example, if value is set to 01 Airline and the card is attempted to be used at a hotel, it will decline. Allowed purchase types are decided during underwriting. Ask a ConnexPay team member for Purchase Types enabled on your account. Best Practice is to always assign a Purchase Type that is restrictive as possible.' default: '' SequenceNumber: type: string description: 'Transaction sequence number within client environment. Provide a unique SequenceNumber for each new request. If a card request is made with all the same parameter information and the same sequence number, within 30 minutes, the request will be considered a duplicate and a new card will not be issued. Note: value is not searchable or reportable in Bridge. The maximum length is 100 alpha-numeric characters.' default: '' PayeeId: type: string description: The PayeeId is used to assist with Intelligent Routing functionality. This field was previously labeled as the Supplier ID and serves the same purpose for Intelligent Routing; however, it also supports additional functionality if a Payee has been created. Creating a Payee allows you complete control over the type of virtual card used to pay your payee and minimizes the data that must be passed in each card request. The field accepts up to 100 alpha-numeric characters, special characters, and spaces. Reference our MerchantPayees APIs for additional details. default: '' PayorId: type: string description: An optional field used to tie the PayOut to a created Payor. This may assist with reconciling when using multiple bank accounts for funding your cash balance. NonDomesticSupplier: type: boolean description: We can issue the “Global VCC” if the Supplier accepting that VCC has an overseas merchant account. This is an optional field. Indicating true will result in issuing this Global VCC. Indicating false (or not including this property in your request) will result in receiving a VCC created for domestic use. OrderNumber: type: string description: 'A value that is commonly used for reporting on and reconciling your PayIns and PayOuts. The Order Number is searchable in the ConnexPay Bridge and referenced in Analytics and reporting, and can be any identifier within your environment to associate with the sale or payment, such as a Record Locator, PNR, or transaction ID. The maximum length is 50 alpha-numeric characters and allows the following special characters: [._ /- ].' default: '' CustomerID: type: string description: 'Transaction ID within client environment associated with the customer. This value acts as a secondary identifier in conjunction with OrderNumber. The value is searchable and reportable in the ConnexPay portal. This value may be sent in multiple times within the integration for multiple purposes. The maximum length is 100 alphanumeric characters and the following special characters: [@._/-].' Transmission: type: object description: URL Links (email) or a text document (fax) to virtual cards can be emailed/faxed by including the VCC Transmission object in the IssueLite API call. Including the transmission object for email also allows you to pull back a URL you can use within your application to direct a user to a visual representation of the virtual card. properties: TransmissionMethods: type: array description: 'Methods of Transmission. Supported methods: Email, Link, Fax. Populate this parameter as ''Email'' if you want to email the virtual card to a customer or supplier. Use the ''Link'' option to have a URL included in the response. Use the "Fax" option to fax the virtual card to a customer or supplier.' items: type: string EmailRecipient: type: string description: Mandatory for email transmission. The email address of the intended recipient. 255 char max. MerchantPhoneNumber: type: string description: This is the phone number that should display on the virtual card and is the number that should be used if the link has expired. Up to 15 characters. Numbers and plus sign (+) allowed only. EmailFrom: type: string description: Mandatory for email transmission. This will be the email address that populates the ‘reply to’ section of the email message. 255 char max. RecipientName: type: string description: Mandatory for email or fax transmission. A descriptive name of the email or fax recipient. 255 char max Subject: type: string description: Mandatory for email (unless using an existing template and the EmailTemplateName is provided) or fax transmission. High-level subject line description of the transmission contents. 255 char max. Message: type: string description: Mandatory for email (unless using an existing template and the EmailTemplateName is provided) or fax transmission. The message body of the email or fax. 2048 char max. DaysToExpire: type: string description: 'Mandatory for email transmission. The number of days after card issuance until link to VC expires. Range: 1-999 days.' EmailTemplateName: type: string description: Use a previously created custom email template by referring to the defined template name. 500 character max. FaxFrom: type: string description: Mandatory for fax transmission. This can be the client name or fax number the fax is coming from that populates the ‘FaxFrom’ section of the fax. 255 char max. FaxRecipient: type: string description: Mandatory for fax transmissions. The fax number of the intended recipient. BookingDetail: type: object properties: ArrivalDate: type: string format: date description: Guest arrival date in YYYY-MM-DD format. PaymentInstruction: type: string description: Instructions for payment processing. System automatically appends "This is a virtual credit card". Maximum length of 4000 characters. ReferenceNumber: type: string description: Booking reference number for tracking. This should match the booking confirmation number in the hotel’s property management system. Maximum length of 100 characters. Traveler: type: object properties: FirstName: type: string description: Traveler's first name. Maximum length of 100 characters. LastName: type: string description: Traveler's last name. Maximum length of 100 characters. description: Traveler information. Company: type: object properties: Name: type: string description: Company Name. Maximum length of 200 characters. Address1: type: string description: Primary company address line. Maximum length of 100 characters. Address2: type: string description: Secondary company address line. Maximum length of 100 characters. City: type: string description: Company city. Maximum length of 100 characters. State: type: string description: Company state/province. Maximum length of 50 characters. Zipcode: type: string description: Company postal/ZIP code. Maximum length of 20 characters. Country: type: string description: Company country. Maximum length of 100 characters. description: Company information for the company paying for the charges. Contact: type: object properties: PhoneNumber: type: string description: The phone number of the company that will be paying for the charges. Maximum of 20 characters. EmailAddress: type: string description: Primary contact email address of the company that will be paying for the charges. Maximum of 255 characters. InvoiceEmailAddress: type: string description: Invoice/billing email address. Maximum of 255 characters. description: Contact information for the company that will be paying for the charges. required: - EmailAddress Property: type: object properties: GDSCode: type: string description: Hotel property GDS (Global Distribution System) code. Maximum of 50 characters Address1: type: string description: Primary property address line. Maximum of 100 characters. Address2: type: string description: Secondary property address line. Maximum of 100 characters. City: type: string description: Property city. Maximum of 100 characters. State: type: string description: Property state/province. Maximum of 50 characters. Zipcode: type: string description: Property postal/ZIP code. Maximum of 20 characters. Country: type: string description: Property country. Maximum of 100 characters. description: Hotel property information. required: - GDSCode description: Optional component that enables automated hotel booking authorization through the Sertifi platform when a virtual card is issued. When provided, the system will attempt to create a booking authorization with the hotel property using the card details. Contact your ConnexPay representative before use as fees will be applied and configuration is required. required: - ArrivalDate - PaymentInstruction - ReferenceNumber ReturnCardData: type: boolean description: Optional field that may be set to true or false. When set to a value of true or if the field is not provided at all, card data is returned in the response. When set to a value of false, the Card Account Number and Security Code (CVV) will be excluded from the response. ActivationDate: type: string description: Future date that the card should be fully funded, at least one day from creation date and within 36 months. If no activation date is supplied the card will be funded immediately. format: date AssociationId: type: string description: 'Utilize the Association ID field to tie a virtual card to a sale or sales. For example, if you have several sales and one virtual card payment to a supplier, you can add association ID to the sales and the virtual card for downstream reporting. The maximum length is 100 alphanumeric characters and the following special characters: [@._/-].' default: '' LabelIDs: type: array description: Utilize Label IDs to associate a virtual card to a specific label(s) within ConnexPay Bridge UI for your organization. If a virtual card is tied to an incorrect Label, it will not filter or display correctly in Bridge's Search Grid. Please contact your Customer Care Consultant for a list of valid Label IDs before use. items: type: string UserDefinedParameters: type: array description: You can add User Defined Parameters to your PayOut in the event that you need to associate or display additional information. items: properties: Name: type: string description: Name of the User Defined Parameter. Value: type: string description: 'Value for the named User Defined Parameter, in a format consistent with the defined DataType. If the User Defined Parameter is of Data Type String, the value is constrained by the defined Maximum Length and alphanumerics and special characters are allowed. If the User Defined Parameter is of Data Type DateTime, the formats accepted are ISO 8601 Formats (example: YYYY-MM-DD:HH:mm:ss), MM/DD/YYYY, and DD/MM/YYYY.' type: object EnableExactMatch: type: boolean description: 'Restrict the issued single use virtual card to only allow authorization approvals when the request amount is an exact match to the created amount limit. This functionality is only applicable when the currency is USD and the Region is US. A default value may be configured for your client account that will be used automatically when not provided in the request, however the explicit value provided in a request call will override this. Please reach out to your ConnexPay representative to enable before usage. Note: When the card brand is UATP, Exact Match will be enforced as false by the CXP system.' default: 'false' WhitelistCountries: type: array description: Specify the countries where the card may be successfully authorized. The Country Code ID or IDs must be used, which can be found at https://docs.connexpay.com/docs/country-code-ids. A country that is restricted by ConnexPay cannot be whitelisted, and that list can be found at https://docs.connexpay.com/docs/blacklisted-countries-of-vcc-acceptance. You may only specify a whitelist or blacklist, not both. items: type: integer BlacklistCountries: type: array items: type: integer description: Specify the countries where the card may not be successfully authorized. The Country Code ID or IDs must be used, which can be found at https://docs.connexpay.com/docs/country-code-ids. You may only specify a whitelist or blacklist, not both. avsCheck: type: boolean description: 'Optional field that will default to your client-level setting if not provided. If enabled, Address Line 1 and Zip Code must be provided. ' examples: Issue Lite Request Example: value: MerchantGuid: 2b586234-7f14-432e-b0f4-a2935f783f38 FirstName: Adam LastName: Smith Phone: '7411237489' Address1: 345 Main Road Address2: '' City: Miami Beach State: MI Zipcode: '33109' Country: MX UsageLimit: 10 AmountLimit: 180 ExpirationDate: '2027-12-30' TerminateDate: '2026-12-30' PurchaseType: '01' SequenceNumber: Sample-seq-1 NonDomesticSupplier: true OrderNumber: OrderNumber-1 CustomerID: CustomerID-1 SupplierID: AA Transmission: TransmissionMethods: - Email - Fax EmailRecipient: emailTo@gmail.com MerchantPhoneNumber: '7411237489' EmailFrom: emailFrom@gmail.com RecipientName: Smith Subject: Card Information Message: here is your card information... DaysToExpire: 1 FaxRecipient: '+55555555555' FaxFrom: Merchant Alias Issue Lite Request Example - Booking Detail: summary: Issue Lite Request Example - Booking Detail value: MerchantGuid: 2b586234-7f14-432e-b0f4-a2935f783f38 Payee: Example Corporation FirstName: M LastName: Smith Phone: '5551234567' Address1: 123 Main Street Address2: Suite 100 City: New York State: NY Zipcode: '10001' Country: US UsageLimit: 10 AmountLimit: 180 ExpirationDate: '2026-12-30' TerminateDate: '2026-12-30' PurchaseType: '01' SequenceNumber: Sample-seq-1 NonDomesticSupplier: false OrderNumber: OrderNumber-1 CustomerID: CustomerID-1 PayeeId: AA Transmission: TransmissionMethods: - Email - Fax EmailRecipient: m.smith@example.com MerchantPhoneNumber: '5551234567' EmailFrom: noreply@example.com RecipientName: Smith Subject: Card Information Message: here is your card information... DaysToExpire: 1 FaxRecipient: '+15551234567' FaxFrom: Example Corporation BookingDetail: ArrivalDate: '2025-12-01' PaymentInstruction: Payment for hotel accommodation - This is a virtual credit card ReferenceNumber: REF123456789 Traveler: FirstName: M LastName: Smith Company: Name: Example Corporation Address1: 123 Main Street Address2: Suite 100 City: New York State: NY Zipcode: '10001' Country: US Contact: PhoneNumber: +1-555-123-4567 EmailAddress: m.smith@example.com InvoiceEmailAddress: billing@example.com Property: GDSCode: HTL001 Address1: 456 Hotel Boulevard Address2: Floor 1 City: Las Vegas State: NV Zipcode: '89101' Country: US responses: '200': description: '200' content: application/json: {} '201': content: application/json: schema: type: object properties: {} examples: Issue Lite Response: summary: Issue Lite Response value: cardHolder: cardHolderGuid: a2b25172-c863-4325-b3b9-7e33cff2f8d1 firstName: Adam lastName: Smith phone: '7411237489' address1: 345 Main Road address2: '' city: Miami Beach state: MI zipcode: '33109' dateOfBirth: null country: U createNewCard: false reissuePhysicalCard: false card: cardGuid: ae17f687-8ba7-4502-b627-24fdf5e6f218 accountNumber: '1111118971563394' securityCode: '617' amountLimit: 180 usageLimit: 10 limitWindow: LIFETIME expirationDate: '2026-12-30T18:59:59' expiration: '1224' terminateDate: '2026-12-30T23:59:59' currencyCode: USD firstSix: '111111' lastFour: '3394' nameLine1: Adam nameLine2: Smith status: Card - Active customerServicePhoneNumber: 1-612-601-0914 sequenceNumber: Sample-seq-1 midWhitelist: [] midBlacklist: [] gatewayMerchantGuid: 2b586234-7f14-432e-b0f4-a2935f783f38 availableBalance: 180 isPhysical: false isLodged: false fingerprint: 23C69076A2C917DDA5ED1B83A1629626 customerId: null supplierId: null issuerId: 3 country: '' cardBin: '433451' toleranceAmount: null isGLobal: false hasBooking: false cardHolder: null outgoingTransactionCode: null createdBy: null isMaestro: false whitelistCountries: null blacklistCountries: null labelIds: - 889 - 992 enableExactMatch: false avsCheck: false cardImageKey: null cardBrand: MasterCard cardClass: Commercial orderNumber: OrderNumber-1 CustomerID: CustomerID-1 saleGuid: 00000000-0000-0000-0000-000000000000 incomingTransactionCode: 6676D1C639072191679998310 Issue Lite (ReturnCardData = false) Response: summary: Issue Lite (ReturnCardData = false) Response value: cardHolder: cardHolderGuid: a2b25172-c863-4325-b3b9-7e33cff2f8d1 firstName: Adam lastName: Smith phone: '7411237489' address1: 345 Main Road address2: '' city: Miami Beach state: MI zipcode: '33109' dateOfBirth: null country: U createNewCard: false reissuePhysicalCard: false card: cardGuid: ae17f687-8ba7-4502-b627-24fdf5e6f218 amountLimit: 180 usageLimit: 10 limitWindow: LIFETIME expirationDate: '2026-12-30T18:59:59' expiration: '1224' terminateDate: '2026-12-30T23:59:59' currencyCode: USD firstSix: '111111' lastFour: '3394' nameLine1: Adam nameLine2: Smith status: Card - Active customerServicePhoneNumber: 1-612-601-0914 sequenceNumber: Sample-seq-1 midWhitelist: [] midBlacklist: [] gatewayMerchantGuid: 2b586234-7f14-432e-b0f4-a2935f783f38 availableBalance: 180 isPhysical: false isLodged: false fingerprint: 23C69076A2C917DDA5ED1B83A1629626 customerId: null payeeId: null issuerId: 3 country: '' cardBin: '433451' toleranceAmount: null isGLobal: false hasBooking: false cardHolder: null outgoingTransactionCode: null createdBy: null isMaestro: false whitelistCountries: null blacklistCountries: null labelIds: - 889 - 992 enableExactMatch: false avsCheck: false cardImageKey: null cardBrand: MasterCard cardClass: Commercial orderNumber: OrderNumber-1 CustomerID: CustomerID-1 saleGuid: 00000000-0000-0000-0000-000000000000 incomingTransactionCode: 6676D1C639072191679998310 Issue Lite (Booking Detail) Response: summary: Issue Lite (Booking Detail) Response value: cardHolder: cardHolderGuid: a2b25172-c863-4325-b3b9-7e33cff2f8d1 firstName: M lastName: Smith phone: '5551234567' address1: 123 Main Street address2: Suite 100 city: New York dateOfBirth: null country: US createNewCard: false reissuePhysicalCard: false card: cardGuid: ae17f687-8ba7-4502-b627-24fdf5e6f218 accountNumber: '1111118971563394' securityCode: '617' amountLimit: 180 usageLimit: 10 limitWindow: LIFETIME expirationDate: '2026-12-30T00:00:00Z' expiration: '1226' terminateDate: '2026-12-30T23:59:59' currencyCode: USD firstSix: '111111' lastFour: '3394' nameLine1: M nameLine2: Smith status: Card - Active customerServicePhoneNumber: 1-612-601-0914 midWhitelist: [] midBlacklist: [] gatewayMerchantGuid: 2b586234-7f14-432e-b0f4-a2935f783f38 availableBalance: 180 isPhysical: false isLodged: true fingerprint: 4F4BB4FE4CCBBE825F012AE7E09DFFC2 customerId: CustomerID-1 supplierId: null payeeId: AA issuerId: 3 country: US cardBin: '499999' cardClass: CommercialCredit toleranceAmount: null isGLobal: false cardHolder: null outgoingTransactionCode: null createdBy: null isMaestro: false whitelistCountries: null blacklistCountries: null enableExactMatch: false cardImageKey: null bookingGuids: - 2c448dba-2040-403b-93a2-6f29715e64ae cardBrand: MasterCard cardClass: Commercial orderNumber: OrderNumber-1 customerID: CustomerID-1 saleGuid: 00000000-0000-0000-0000-000000000000 description: Created '400': description: '400' content: application/json: examples: Result: value: '{}' schema: type: object properties: {} tags: - IssueCard components: securitySchemes: sec0: type: http scheme: basic x-readme: headers: - key: Authorization value: Basic explorer-enabled: false proxy-enabled: true x-readme-fauxas: true