--- updatedAt: 2026-09-14T20:17:34.000Z --- # Create Transaction # OpenAPI definition ```json { "openapi": "3.0.0", "info": { "title": "Evolve's Card Acquiring", "contact": { "name": "" }, "version": "1.02", "description": "" }, "servers": [ { "url": "https://apitest.getevolved.com/v1", "variables": {} } ], "paths": { "/transactions/card": { "post": { "tags": [ "Transactions" ], "summary": "Create Transaction", "description": "", "operationId": "CreateTransaction", "parameters": [ { "name": "Ocp-Apim-Subscription-Key", "in": "header", "description": "Provided by Evolve", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "x-Client-ID", "in": "header", "description": "Provided by Evolve", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "x-Merchant-ID", "in": "header", "description": "Provided by Evolve", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateTransactionRequest" }, "examples": { "default": { "value": { "accounts": { "sourceAccount": { "card": { "accountNumber": "string", "expirationDate": "string", "securityCode": "string", "keyID": "string", "data": "string", "token": "string", "device": { "id": "string", "blob": "string" }, "processor": { "name": "string", "token": "string", "customerID": "string" }, "mobilePay": { "accountNumber": "string", "expirationDate": "string", "cryptogram": "string", "transactionID": "string", "eciIndicator": "string", "network": "string", "type": "string" } }, "owner": { "name": { "company": "string", "first": "string", "middle": "string", "last": "string", "suffix": "string" }, "address": { "line1": "string", "line2": "string", "city": "string", "state": "string", "zipcode": "string", "country": "string" }, "phone": { "countryCode": "string", "number": "string" } } }, "destinationAccount": { "card": { "accountNumber": "string", "expirationDate": "string", "securityCode": "string", "keyID": "string", "data": "string", "token": "string", "device": { "id": "string", "blob": "string" }, "processor": { "name": "string", "token": "string", "customerID": "string" } }, "owner": { "name": { "company": "string", "first": "string", "middle": "string", "last": "string", "suffix": "string" }, "address": { "line1": "string", "line2": "string", "city": "string", "state": "string", "zipcode": "string", "country": "string" }, "phone": { "countryCode": "string", "number": "string" } } }, "sourceAccountID": "string", "destinationAccountID": "string" }, "referenceID": "string", "correspondingID": "string", "corresponding": { "name": { "first": "string", "last": "string" }, "address": { "line": "string", "city": "string", "state": "string", "zipcode": "string", "country": "string" }, "ofacValue": "string", "accountNumber": "string", "sourceOfFunds": "string" }, "type": "string", "amount": "string", "ofacValue": "string", "memo": "string", "pullOptions": { "3DSecure": { "version": "string", "ECI": "string", "UCAF": "string", "XID": "string", "dsTransactionID": "string" }, "securityCode": "string", "recurring": true, "level2TaxExempt": true, "level2TaxAmount": "string", "level3": { "amountTax": "string", "tax": "string", "taxRate": "string", "amountDiscount": "string", "amountShipping": "string", "amountDuty": "string", "itemCommodityCode": "string", "itemDescription": "string", "productCode": "string", "quantity": "string", "unitOfMeasure": "string", "amountUnitCost": "string", "amountItemDiscount": "string", "amountTotal": "string", "poNumber": "string" } }, "softDescriptor": { "name": "string", "address": { "line": "string", "city": "string", "county": "string", "state": "string", "zipcode": "string", "country": "string" }, "phone": { "countryCode": "string", "number": "string" }, "email": "string" }, "location": { "name": "string", "address": { "line1": "string", "line2": "string", "city": "string", "state": "string", "zipcode": "string", "country": "string" } }, "currency": "string" } } } } }, "required": true }, "responses": { "200": { "description": "OK", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateTransactionResponse" }, "examples": { "default": { "value": { "SC": 0, "EC": "0", "transactionID": "string", "network": "string", "networkRC": "string", "status": "string", "approvalCode": "string", "AVS": { "codeAVS": "string", "codeSecurityCode": "string" }, "fees": { "interchange": "string", "network": "string", "getevolved": "string" }, "card": { "last4": "string", "expirationDate": "string", "nameFI": "string" } } } } } } }, "422": { "description": "Destination Disabled", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorMessage" }, "examples": { "default": { "value": { "SC": 0, "EC": "0", "EM": "string" } } } } } } } } } }, "components": { "schemas": { "CreateTransactionRequest": { "title": "CreateTransactionRequest", "type": "object", "required": [ "referenceID", "type", "amount", "accounts" ], "properties": { "accounts": { "type": "object", "description": "Pass either 'sourceAccountID' or 'sourceAccount' object OR pass 'destinationAccountID' or 'destinationAccount' object\n\nFor 'push' transactions. 'sourceAccountID' must be your Merchant's Settlement Account ID\n\nFor 'pull' transaction. 'destinationAccountID' must be your Merchant's Settlement Account ID\n", "properties": { "sourceAccount": { "type": "object", "description": "Pass either\n * accountNumber\n * expirationDate\n * securityCode\n\nOR\n * keyID\n * data\n\nOR\n * token\n\nOR\n * 'device' object\n\nOR\n * 'mobilePay' object\n\nOR\n * 'processor' object\n", "required": [ "owner" ], "properties": { "card": { "allOf": [ { "$ref": "#/components/schemas/Card" }, { "type": "object", "properties": { "device": { "$ref": "#/components/schemas/Device" }, "processor": { "$ref": "#/components/schemas/Processor" }, "mobilePay": { "$ref": "#/components/schemas/MobilePay" } } } ] }, "owner": { "type": "object", "description": "Cardholder", "required": [ "name" ], "properties": { "name": { "$ref": "#/components/schemas/Name" }, "address": { "$ref": "#/components/schemas/Address" }, "phone": { "$ref": "#/components/schemas/Phone" } } } } }, "destinationAccount": { "type": "object", "description": "Pass either\n * accountNumber\n * expirationDate\n * securityCode\n\nOR\n * keyID\n * data\n\nOR\n * token\n\nOR\n * 'device' object\n\nOR\n * 'processor' object\n", "properties": { "card": { "allOf": [ { "$ref": "#/components/schemas/Card" }, { "type": "object", "required": [ "name", "token" ], "properties": { "device": { "$ref": "#/components/schemas/Device" }, "processor": { "$ref": "#/components/schemas/Processor" } } } ] }, "owner": { "type": "object", "description": "Cardholder", "properties": { "name": { "$ref": "#/components/schemas/Name" }, "address": { "$ref": "#/components/schemas/Address" }, "phone": { "$ref": "#/components/schemas/Phone" } } } } }, "sourceAccountID": { "type": "string", "description": "Merchant's Settlement Account ID" }, "destinationAccountID": { "type": "string", "description": "Merchant's Settlement Account ID" } } }, "referenceID": { "type": "string", "description": "User defined unique identifier", "pattern": "^[a-zA-Z0-9_-]{1,15}$" }, "correspondingID": { "type": "string", "description": "The transactionID of the corresponding transaction. For a *pull*, the corresponding *push* transactionID. For a *push*, the corresponding *pull* transactionID" }, "corresponding": { "$ref": "#/components/schemas/Corresponding" }, "type": { "type": "string", "description": "Transaction Type\nThis is used to verify that your Source and Destination Accounts are valid", "enum": [ "pull", "push" ] }, "amount": { "type": "string", "description": "Transaction amount", "pattern": "^[0-9]*.?[0-9]{0,4}$" }, "ofacValue": { "type": "string", "description": "Sender OFAC Value from 'Query OFAC'", "pattern": "^[a-zA-Z0-9_-]+$" }, "memo": { "type": "string", "description": "User defined memo", "pattern": "^[a-zA-Z0-9_ -]{1,32}$", "maxLength": 32 }, "pullOptions": { "$ref": "#/components/schemas/PullOptions" }, "softDescriptor": { "$ref": "#/components/schemas/SoftDescriptor" }, "location": { "allOf": [ { "$ref": "#/components/schemas/Location" }, { "type": "object", "properties": { "address": { "$ref": "#/components/schemas/Address" } } } ] }, "currency": { "type": "string", "description": "ISO 4217 Currency Codes", "pattern": "^[0-9]{3}$" } } }, "CreateTransactionResponse": { "title": "CreateTransactionResponse", "type": "object", "properties": { "SC": { "type": "integer", "format": "int32", "description": "Internal Status Code" }, "EC": { "type": "string", "description": "Internal Error Code" }, "transactionID": { "type": "string" }, "network": { "type": "string", "description": "Card Network (e.g. STAR, PULSE, NYCE, VISA, MasterCard, Discover, American Express" }, "networkRC": { "type": "string", "description": "Network Response Code" }, "status": { "type": "string", "description": "Status of transaction" }, "approvalCode": { "type": "string", "description": "Network approval code" }, "AVS": { "$ref": "#/components/schemas/AVS" }, "fees": { "$ref": "#/components/schemas/Fees" }, "card": { "type": "object", "properties": { "last4": { "type": "string", "description": "Last four of the Card Number" }, "expirationDate": { "type": "string", "pattern": "^[0-9]{6}$", "description": "Card Number's Expiration Date" }, "nameFI": { "type": "string", "description": "Issuer Name Not present if no issuer name found" } } } } }, "ErrorMessage": { "title": "Destination Disabled", "type": "object", "properties": { "SC": { "type": "integer", "format": "int32", "description": "Internal Status Code" }, "EC": { "type": "string", "description": "Internal Error Code" }, "EM": { "type": "string", "description": "Error Message" } } }, "Name": { "title": "name", "type": "object", "description": "Pass either 'company' or 'first, middle, last & suffix'", "oneOf": [ { "required": [ "company" ] }, { "required": [ "first", "last" ] } ], "properties": { "company": { "type": "string", "description": "Name of the business of the bank or card account", "pattern": "^[ a-zA-Z0-9_-]+$" }, "first": { "type": "string", "description": "Card or Bank account holder's first name", "pattern": "^[ a-zA-Z0-9_-]+$" }, "middle": { "type": "string", "description": "Card or Bank account holder's middle name or initial", "pattern": "^[ a-zA-Z0-9_-]+$" }, "last": { "type": "string", "description": "Card or Bank account holder's last name", "pattern": "^[ a-zA-Z0-9_-]+$" }, "suffix": { "type": "string", "description": "Card or Bank account holder's suffix", "pattern": "^[ a-zA-Z0-9_-]+$" } } }, "Address": { "title": "address", "type": "object", "properties": { "line1": { "type": "string", "description": "Address Line 1", "pattern": "^[ a-zA-Z0-9._-]+$" }, "line2": { "type": "string", "description": "Address Line 2", "pattern": "^[ a-zA-Z0-9._-]+$" }, "city": { "type": "string", "description": "City", "pattern": "^[ a-zA-Z0-9_-]+$" }, "state": { "type": "string", "description": "2 Character U.S. State Code", "minLength": 2, "maxLength": 2, "pattern": "^[ a-zA-Z0-9_-]+$" }, "zipcode": { "type": "string", "description": "Zip Code is only validated if 'country' is '840' or '124'. If country=840 zipcode is 5 to 9 digits. If country=124 zipcode is 'A1A 1A1", "pattern": "^[ a-zA-Z0-9_-]+$" }, "country": { "type": "string", "description": "ISO 3166-1 numeric", "pattern": "^[0-9]{3}$", "default": 840 } } }, "Phone": { "title": "phone", "type": "object", "required": [ "number" ], "description": "E.164 numbering", "properties": { "countryCode": { "type": "string", "description": "1 to 3 digits", "pattern": "^[0-9]{3}$" }, "number": { "type": "string", "description": "Primary phone number", "minLength": 4, "maxLength": 14, "pattern": "^[0-9]{4,14}$" } } }, "Card": { "title": "card", "type": "object", "required": [ "accountNumber", "expirationDate", "securityCode", "keyID", "data", "token" ], "description": "Pass either\n * accountNumber\n * expirationDate\n * securityCode\n\nOR\n * keyID\n * data\n\nOR\n * token\n\nOR\n * 'device' object\n", "properties": { "accountNumber": { "type": "string", "description": "Payment card number", "pattern": "^[0-9]{13,19}$" }, "expirationDate": { "type": "string", "pattern": "^[0-9]{6}$", "description": "Card Number's Expiration Date" }, "securityCode": { "type": "string", "description": "Allowed only if using\n\nCVV2, CVC2 or CID. It is the 3 or 4 digit verification identifier that is typically found on the back of credit cards\n", "pattern": "^[0-9]{3,4}$" }, "keyID": { "type": "string", "description": "22 character KeyID. Ensure the RSA key you're using to encrypt the card data is consistent with this keyID", "pattern": "^[a-zA-Z0-9_-]{22}$" }, "data": { "type": "string", "description": "RSA-encrypted card data using RSA key with KeyID\n\n* No spaces\n* Pipe symbol (|) separated\n* Expiration Date, Security Code optional\n\nUnencrypted Card Data Format:\nCardNumber|Expiration Date| Security Code\n", "pattern": "^[A-Za-z0-9_+=-]{344}$" }, "token": { "type": "string", "description": "Card Token" } } }, "MobilePay": { "title": "mobilePay", "type": "object", "required": [ "accountNumber", "expirationDate", "cryptogram", "transactionID", "network", "type" ], "properties": { "accountNumber": { "type": "string", "description": "Pseudo Payment Card Account Number", "pattern": "^[0-9]{13,19}$" }, "expirationDate": { "type": "string", "pattern": "^[0-9]{6}$", "description": "Card Number's Expiration Date" }, "cryptogram": { "type": "string", "description": "Payment Data Cryptogram", "pattern": "^[A-Za-z0-9_+=/-]{28}$" }, "transactionID": { "type": "string", "description": "Transaction Identifier in Hex", "pattern": "^[A-Za-z0-9]{64}$" }, "eciIndicator": { "type": "string", "description": "ECI Indicator\n\nUsually only present when network is 'Visa'\n", "pattern": "^[A-Za-z]+" }, "network": { "type": "string", "description": "Card Network", "pattern": "^[A-Za-z]+" }, "type": { "type": "string", "description": "Card Type", "pattern": "^[A-Za-z]+" } } }, "Processor": { "title": "processor", "type": "object", "required": [ "name", "token" ], "properties": { "name": { "type": "string", "description": "Processor Name\nCurrently supported names are:\n* Galileo\n* Q2\n", "pattern": "^[0-9A-Za-z]+$" }, "token": { "type": "string", "description": "Token from issuing processor", "pattern": "^[0-9]+$" }, "customerID": { "type": "string", "description": "Customer Identifier\n\nRequired if 'processor.name' is 'Q2'. omit otherwise\n", "pattern": "^[0-9]+$" } } }, "Device": { "title": "device", "type": "object", "required": [ "id", "blob" ], "description": "Card Data from a secure device", "properties": { "id": { "type": "string", "description": "Device ID" }, "blob": { "type": "string", "description": "Base64 encoded card data", "pattern": "^[A-Za-z0-9_+=-]{1500}$" } } }, "Level3": { "title": "level3", "type": "object", "required": [ "amountTax", "tax", "taxRate", "amountDiscount", "amountShipping", "amountDuty", "itemCommodityCode", "itemDescription", "productCode", "quantity", "unitOfMeasure", "amountUnitCost", "amountItemDiscount", "amountTotal", "poNumber" ], "properties": { "amountTax": { "type": "string", "description": "Tax Amount\n* Must be the same currency as the unit price.\n* Must equal the amountUnitCost multiplied by taxRate\n* Use 0.00 if tax is 2 (Tax Exempt)\n", "pattern": "^[0-9]+.{d}{d}$" }, "tax": { "type": "string", "description": "* 0 Sales Tax Not Included\n* 1 Sales Tax Included\n* 2 Tax Exempt\n", "pattern": "^[012]$" }, "taxRate": { "type": "string", "description": "Tax Rate", "pattern": "^[0-9]{0,2}.[0-9]{2}$" }, "amountDiscount": { "type": "string", "description": "Discount Amount", "pattern": "^[0-9]{0,10}.[0-9]{2}$" }, "amountShipping": { "type": "string", "description": "Shipping Amount", "pattern": "^[0-9]{0,10}.[0-9]{2}$" }, "amountDuty": { "type": "string", "description": "Duty Amount", "pattern": "^[0-9]{0,10}.[0-9]{2}$" }, "itemCommodityCode": { "type": "string", "description": "itemCommodityCode", "pattern": "^[0-9A-Za-z]{1,12}$" }, "itemDescription": { "type": "string", "description": "Item Description", "pattern": "^[0-9A-Za-z]{1,26}$" }, "productCode": { "type": "string", "description": "Product Code\n\nExamples:\n\n* Electronic\n* Physical\n* Service\n* Subscription\n* Shipping\n* Handling\n", "pattern": "^[A-Za-z0-9]{1,12}$" }, "quantity": { "type": "string", "description": "Quantity", "pattern": "^{d}{d}.{d}{d}$" }, "unitOfMeasure": { "type": "string", "description": "Unit of Measure\n[www.google.com](test hyperlink)\nExamples:\n\n* ITM: Item\n* LBS: Pounds\n* HRS: Hours\n* KWH: Kilowatt Hours\n", "pattern": "^[A-Z]{3}$" }, "amountUnitCost": { "type": "string", "description": "Unit Cost", "pattern": "^[0-9]{0,10}.[0-9]{2}$" }, "amountItemDiscount": { "type": "string", "description": "Discount Per Line Item", "pattern": "^[0-9]{0,10}.[0-9]{2}$" }, "amountTotal": { "type": "string", "description": "Total Amount", "pattern": "^[0-9]{15}[.,]?[0-9]{4}?$" }, "poNumber": { "type": "string", "description": "Purchase Order Number. Do NOT populate the field with all 0s or all 9s", "pattern": "^[A-Za-z0-9]{1,17}$" } } }, "PullOptions": { "title": "pullOptions", "type": "object", "description": "Additional Pull Options", "properties": { "3DSecure": { "type": "object", "required": [ "ECI", "UCAF" ], "properties": { "version": { "type": "string", "description": "Required if card network is MasterCard. Otherwise, optional" }, "ECI": { "type": "string", "description": "Electronic Commerce Indicator (ECI)", "pattern": "^(?:0|1|2|4|5|6|7)$" }, "UCAF": { "type": "string", "description": "Universal Cardholder Authentication Field (UCAF)" }, "XID": { "type": "string", "description": "Transaction ID" }, "dsTransactionID": { "type": "string", "description": "Directory Server TransactionID\nRequired if card network is MasterCard. Otherwise, optional\n" } } }, "securityCode": { "type": "string", "description": "Allowed only if using\n\nCVV2, CVC2 or CID. It is the 3 or 4 digit verification identifier that is typically found on the back of credit cards\n", "pattern": "^[0-9]{3,4}$" }, "recurring": { "type": "boolean", "description": "Can only be set to 'true' if request only has sourceAccountID and destinationAccountID (no destinationAccount or sourceAccount)" }, "level2TaxExempt": { "type": "boolean", "description": "Level 2 Tax Exempt" }, "level2TaxAmount": { "type": "string", "description": "Level 2 Tax Amount (Currency is same as the Transaction Amount)", "pattern": "^[0-9]*.?[0-9]{0,4}$" }, "level3": { "$ref": "#/components/schemas/Level3" } } }, "Corresponding": { "title": "corresponding", "type": "object", "description": "Corresponding Transaction Information.\nFor a push transaction, this would be the corresponding pull transaction\nFor a pull transaction, this would be the corresponding push transaction\n", "properties": { "name": { "type": "object", "properties": { "first": { "type": "string", "description": "First Name", "pattern": "^[ a-zA-Z0-9_-]+$" }, "last": { "type": "string", "description": "Last name", "pattern": "^[ a-zA-Z0-9_-]+$" } } }, "address": { "type": "object", "properties": { "line": { "type": "string", "description": "Address Line 1", "pattern": "^[ a-zA-Z0-9._-]+$" }, "city": { "type": "string", "description": "City", "pattern": "^[ a-zA-Z0-9_-]+$" }, "state": { "type": "string", "description": "2 Character U.S. State Code", "minLength": 2, "maxLength": 2, "pattern": "^[ a-zA-Z0-9_-]+$" }, "zipcode": { "type": "string", "description": "Zip Code is only validated if 'country' is '840' or '124'. If country=840 zipcode is 5 to 9 digits. If country=124 zipcode is 'A1A 1A1", "pattern": "^[ a-zA-Z0-9_-]+$" }, "country": { "type": "string", "description": "ISO 3166-1 numeric", "pattern": "^[0-9]{3}$", "default": 840 } } }, "ofacValue": { "type": "string", "description": "Sender OFAC value from Query OFAC. Use example: 7nGfHHedKNelaw" }, "accountNumber": { "type": "string", "description": "Sender Account Number", "pattern": "^[0-9]{4,17}$" }, "sourceOfFunds": { "type": "string", "description": "Sender Source of Funds", "pattern": "^[A-Za-z]{1,25}$" } } }, "SoftDescriptor": { "title": "softDescriptor", "type": "object", "required": [ "name", "city", "county", "state", "zipcode", "country", "number" ], "properties": { "name": { "type": "string", "description": "Name", "pattern": "^[ a-zA-Z0-9_-]+$" }, "email": { "type": "string", "description": "For American Express Bill Pay Provider program:\n\nSeller Email Address (max of 40 characters)\n" }, "address": { "type": "object", "properties": { "line": { "type": "string", "description": "Address Line", "pattern": "^[ a-zA-Z0-9_-]+$" }, "city": { "type": "string", "description": "City", "pattern": "^[ a-zA-Z0-9_-]+$" }, "county": { "type": "string", "description": "3-character County Code", "pattern": "^[ a-zA-Z0-9_-]{3}$" }, "state": { "type": "string", "description": "2 Character U.S. State Code", "minLength": 2, "maxLength": 2, "pattern": "^[ a-zA-Z0-9_-]+$" }, "zipcode": { "type": "string", "description": "Zip Code is only validated if 'country' is '840' or '124'. If country=840 zipcode is 5 to 9 digits. If country=124 zipcode is 'A1A 1A1", "pattern": "^[ a-zA-Z0-9_-]+$" }, "country": { "type": "string", "description": "ISO 3166-1 numeric", "pattern": "^[0,9]{3}$" } } }, "phone": { "$ref": "#/components/schemas/Phone" } } }, "Location": { "title": "location", "type": "object", "description": "Location of Origination of Transaction", "required": [ "name" ], "properties": { "name": { "type": "string", "description": "Location Name", "pattern": "^[ a-zA-Z0-9_-]+$" } } }, "AVS": { "type": "object", "properties": { "codeAVS": { "type": "string", "description": "AVS Codes" }, "codeSecurityCode": { "type": "string", "description": "Security Code Response Code" } } }, "Fees": { "type": "object", "properties": { "interchange": { "type": "string", "description": "Interchange Fees" }, "network": { "type": "string", "description": "Network Fees" }, "getevolved": { "type": "string", "description": "Evolve Fees" } } } } }, "tags": [ { "name": "Transactions", "description": "" } ] } ```