{"_id":"5632a5ea49e16d0d00122492","category":{"_id":"5632a5e749e16d0d0012244d","__v":1,"pages":["5632a5ea49e16d0d00122481","5632a5ea49e16d0d00122482","5632a5ea49e16d0d00122483","5632a5ea49e16d0d00122484","5632a5ea49e16d0d00122485","5632a5ea49e16d0d00122486","5632a5ea49e16d0d00122487","5632a5ea49e16d0d00122488","5632a5ea49e16d0d00122489","5632a5ea49e16d0d0012248a","5632a5ea49e16d0d0012248b","5632a5ea49e16d0d0012248c","5632a5ea49e16d0d0012248d","5632a5ea49e16d0d0012248e","5632a5ea49e16d0d0012248f","5632a5ea49e16d0d00122490","5632a5ea49e16d0d00122491","5632a5ea49e16d0d00122492","5632a5ea49e16d0d00122493","5632a5ea49e16d0d00122494","5632a5ea49e16d0d00122495","5632a5ea49e16d0d00122496","5632a5ea49e16d0d00122497","5632a5ea49e16d0d00122498","5632a5ea49e16d0d00122499","5632a5ea49e16d0d0012249a","5632a5ea49e16d0d0012249b","5632a5ea49e16d0d0012249c","5632a5ea49e16d0d0012249d","5632a5ea49e16d0d0012249e","5632a5ea49e16d0d0012249f","5632a5ea49e16d0d001224a0","5632a5ea49e16d0d001224a1","5632a5ea49e16d0d001224a2","5632a5ea49e16d0d001224a3","5632a5ea49e16d0d001224a4","5632a5ea49e16d0d001224a5","5632a5ea49e16d0d001224a6","5632a5ea49e16d0d001224a7"],"project":"55b933b3146ef121002158d3","version":"5632a5e549e16d0d00122443","sync":{"url":"","isSync":false},"reference":false,"createdAt":"2015-08-04T17:34:02.800Z","from_sync":false,"order":12,"slug":"objects","title":"Objects"},"project":"55b933b3146ef121002158d3","version":{"_id":"5632a5e549e16d0d00122443","__v":6,"project":"55b933b3146ef121002158d3","createdAt":"2015-10-29T23:04:05.701Z","releaseDate":"2015-10-29T23:04:05.701Z","categories":["5632a5e749e16d0d00122444","5632a5e749e16d0d00122445","5632a5e749e16d0d00122446","5632a5e749e16d0d00122447","5632a5e749e16d0d00122448","5632a5e749e16d0d00122449","5632a5e749e16d0d0012244a","5632a5e749e16d0d0012244b","5632a5e749e16d0d0012244c","5632a5e749e16d0d0012244d","5632a5e749e16d0d0012244e","5632a5e749e16d0d0012244f","5632a5e749e16d0d00122450","5632b179df556c0d00cd095b","564e13053b2b4a19000cd69b","59caa9df65accc001a489c95","59cab50965accc001a489d28","59cadd464ab7b70024378e74"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":true,"codename":"","version_clean":"1.1.0","version":"1.1"},"__v":0,"user":"55b932ba8fd1a02b00f496c8","githubsync":"","parentDoc":null,"updates":[],"next":{"pages":[],"description":""},"createdAt":"2015-08-04T17:56:08.485Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[]},"settings":"","auth":"required","params":[],"url":""},"isReference":false,"order":16,"body":"Describes a customer payment method.\n\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Description\"\n}\n[/block]\nThis object describes a customer payment method. A payment method can be a CreditCard, ACH (Electronic Check), StoredValue (gift certificate, store credit, auto-reloading prepaid card, etc), and Invoice. The payment type is specified by setting MethodType to 'CreditCard', 'ACH', 'StoredValue' or 'Invoice'. If MethodType is left blank and credit card information is provided, the type will default to 'CreditCard'. If MethodType is left blank and electronic check information is provided, the type will default to 'ACH'.\nThe StoredValue method can be as simple as a store credit or as complex as linking to a physical pre-paid card or gift card with a magnetic strip. For a store credit or simple balance on account, the only required field is Balance. To use the StoredValue payment method, the merchant account must have stored value transactions enabled.\nThe Invoice method allows a merchant to collect transactions that will be invoice at a later date. Balance is increased by the system when an Invoice transaction is received. MaxBalance specifies that maximum balance that a customer can incur before Invoice transactions are declined. Setting MaxBalance to 0 will cause the customer to have no limit. To process Invoice transactions, the merchant account must have Invoice processing enabled.\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Properties\"\n}\n[/block]\n\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Type\",\n    \"h-1\": \"Name\",\n    \"h-2\": \"Description\",\n    \"0-0\": \"string\",\n    \"0-1\": \"MethodType\",\n    \"0-2\": \"Type of payment method ('CreditCard', 'ACH', 'StoredValue' or 'Invoice')\",\n    \"1-0\": \"integer\",\n    \"1-1\": \"MethodID\",\n    \"1-2\": \"ID of payment method. This property is ignored when adding a new payment method but required if updating an existing method. (Read Only)\",\n    \"2-0\": \"string\",\n    \"2-1\": \"MethodName\",\n    \"2-2\": \"Label for payment method. For example “Work Visa” or “Personal Checking.”\",\n    \"3-0\": \"integer\",\n    \"3-1\": \"SecondarySort\",\n    \"3-2\": \"If set to value greater than 0, use this method as backup in case default fails. Secondary methods will be run in ascending order.\",\n    \"4-0\": \"datetime\",\n    \"4-1\": \"Created\",\n    \"5-0\": \"datetime\",\n    \"5-1\": \"Modified\"\n  },\n  \"cols\": 3,\n  \"rows\": 6\n}\n[/block]\n\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Credit Card\",\n    \"h-1\": \"Credit Card\",\n    \"h-2\": \"Credit Card\",\n    \"0-0\": \"string\",\n    \"0-1\": \"CardNumber\",\n    \"0-2\": \"Credit card number (required for credit cards). If data is coming from a swiper, base64_encode the entire raw block read from the swiper device and put enc:// at the beginning. Example: enc://AAbbCdEEaa…\",\n    \"1-0\": \"string\",\n    \"1-1\": \"CardExpiration\",\n    \"1-2\": \"Credit card expiration date in YYYY-MM format. It will also accept MMYY format. (required for credit cards)\",\n    \"2-0\": \"string\",\n    \"2-1\": \"AvsStreet\",\n    \"2-2\": \"Street address for AVS (address verification system). (Optional but recommended for credit cards)\",\n    \"3-0\": \"string\",\n    \"3-1\": \"AvsZip\",\n    \"3-2\": \"Zip code for AVS. (Optional but recommended for credit cards)\",\n    \"4-0\": \"string\",\n    \"4-1\": \"CardCode\",\n    \"4-2\": \"CVV2/CID card identification code. This code is not stored and is only used when verifying a new payment method before it is added. (Optional for credit cards)\",\n    \"5-0\": \"string\",\n    \"5-1\": \"CardType\",\n    \"5-2\": \"Type of credit card (Visa, Mastercard, etc). This is a read only parameter and will be ignored if set.\"\n  },\n  \"cols\": 3,\n  \"rows\": 6\n}\n[/block]\n\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Electronic Check (ACH)\",\n    \"h-1\": \"Electronic Check (ACH)\",\n    \"h-2\": \"Electronic Check (ACH)\",\n    \"0-0\": \"string\",\n    \"0-1\": \"Account\",\n    \"0-2\": \"ACH Bank Account Number (required for checks)\",\n    \"1-0\": \"string\",\n    \"1-1\": \"AccountType\",\n    \"1-2\": \"ACH Type of Bank Account (Checking or Savings, defaults to checking)\",\n    \"2-0\": \"string\",\n    \"2-1\": \"Routing\",\n    \"2-2\": \"ACH Bank Routing Number (required for checks)\",\n    \"3-0\": \"string\",\n    \"3-1\": \"DriversLicense\",\n    \"3-2\": \"Drivers license number used for check guarantee (optional)\",\n    \"4-0\": \"string\",\n    \"4-1\": \"DriversLicenseState\",\n    \"4-2\": \"Drivers license state (optional)\",\n    \"5-0\": \"string\",\n    \"5-1\": \"RecordType\",\n    \"5-2\": \"ACH transaction type (optional, should be left blank unless instructed differently by check processor)\"\n  },\n  \"cols\": 3,\n  \"rows\": 6\n}\n[/block]\n\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Invoice\",\n    \"h-1\": \"Invoice\",\n    \"h-2\": \"Invoice\",\n    \"0-0\": \"double\",\n    \"0-1\": \"MaxBalance\",\n    \"0-2\": \"The maximum balance that may be charged on Invoice before transactions are declined\"\n  },\n  \"cols\": 3,\n  \"rows\": 1\n}\n[/block]\n\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Stored Value\",\n    \"h-1\": \"Stored Value\",\n    \"h-2\": \"Stored Value\",\n    \"0-0\": \"double\",\n    \"0-1\": \"Balance\",\n    \"0-2\": \"The funds left on the account. Transactions against this payment method may not exceed this balance\",\n    \"1-0\": \"boolean\",\n    \"1-1\": \"AutoReload\",\n    \"1-2\": \"Set true if StoredValue card should automatically be reloaded\",\n    \"2-0\": \"string\",\n    \"2-1\": \"ReloadSchedule\",\n    \"2-2\": \"Automatic reload schedule\",\n    \"3-0\": \"double\",\n    \"3-1\": \"ReloadThreshold\",\n    \"3-2\": \"Balance that will trigger an automatic reload\",\n    \"4-0\": \"double\",\n    \"4-1\": \"ReloadAmount\",\n    \"4-2\": \"Amount to automatically reload\",\n    \"5-0\": \"integer\",\n    \"5-1\": \"ReloadMethodID\",\n    \"5-2\": \"Payment method to use for reloading card\"\n  },\n  \"cols\": 3,\n  \"rows\": 6\n}\n[/block]\n\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Examples\"\n}\n[/block]\n\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Credit Card\",\n    \"h-1\": \"Credit Card\",\n    \"0-0\": \"MethodType\",\n    \"0-1\": \"CreditCard\",\n    \"1-0\": \"MethodName\",\n    \"1-1\": \"Work Visa\",\n    \"2-0\": \"CardNumber\",\n    \"2-1\": \"4444555566667779\",\n    \"3-0\": \"CardExpiration\",\n    \"3-1\": \"2012-09\",\n    \"4-0\": \"AvsStreet\",\n    \"4-1\": \"490 Maple Ave\",\n    \"5-0\": \"AvsZip\",\n    \"5-1\": \"90010\"\n  },\n  \"cols\": 2,\n  \"rows\": 6\n}\n[/block]\n\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Electronic Check\",\n    \"h-1\": \"Electronic Check\",\n    \"0-0\": \"MethodType\",\n    \"0-1\": \"ACH\",\n    \"1-0\": \"MethodName\",\n    \"1-1\": \"BoA Savings\",\n    \"2-0\": \"RecordType\",\n    \"2-1\": \"PPD\",\n    \"3-0\": \"AccountType\",\n    \"3-1\": \"Savings\",\n    \"4-0\": \"Account\",\n    \"4-1\": \"4920029\",\n    \"5-0\": \"Routing\",\n    \"5-1\": \"123456789\",\n    \"6-0\": \"DriversLicense\",\n    \"6-1\": \"23423422\",\n    \"7-0\": \"DriversLicenseState\",\n    \"7-1\": \"CA\"\n  },\n  \"cols\": 2,\n  \"rows\": 8\n}\n[/block]\n\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"StoredValue\",\n    \"h-1\": \"StoredValue\",\n    \"0-0\": \"MethodType\",\n    \"0-1\": \"Invoice\",\n    \"1-0\": \"MethodName\",\n    \"1-1\": \"Customer Account\",\n    \"2-0\": \"Balance\",\n    \"2-1\": \"250.00\"\n  },\n  \"cols\": 2,\n  \"rows\": 3\n}\n[/block]\n\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Invoice\",\n    \"h-1\": \"Invoice\",\n    \"0-0\": \"MethodType\",\n    \"0-1\": \"Invoice\",\n    \"1-0\": \"MethodName\",\n    \"1-1\": \"On Account\",\n    \"2-0\": \"Balance\",\n    \"2-1\": \"0\",\n    \"3-0\": \"MaxBalance\",\n    \"3-1\": \"5000.00\"\n  },\n  \"cols\": 2,\n  \"rows\": 4\n}\n[/block]\n## Visual Basic (.Net)\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"Dim payMethod As eBizCharge.PaymentMethod = New eBizCharge.PaymentMethod\\n       payMethod.CardExpiration = \\\"1212\\\"\\n       payMethod.CardNumber = \\\"4000100011112224\\\"\\n       payMethod.AvsStreet = \\\"123 Main st.\\\"\\n       payMethod.AvsZip = \\\"90046\\\"\\n       payMethod.MethodName = \\\"My Visa\\\"\",\n      \"language\": \"asp\"\n    }\n  ]\n}\n[/block]\n## C Sharp (.Net)\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"eBizCharge.PaymentMethod payMethod = new eBizCharge.PaymentMethod();\\n           payMethod.CardExpiration = \\\"1212\\\";\\n           payMethod.CardNumber = \\\"4000100011112224\\\";\\n           payMethod.AvsStreet = \\\"123 Main st.\\\";\\n           payMethod.AvsZip = \\\"90046\\\";\\n           payMethod.MethodName = \\\"My Visa\\\";\\n\",\n      \"language\": \"csharp\"\n    }\n  ]\n}\n[/block]","excerpt":"","slug":"paymentmethod","type":"basic","title":"PaymentMethod"}
Describes a customer payment method. [block:api-header] { "type": "basic", "title": "Description" } [/block] This object describes a customer payment method. A payment method can be a CreditCard, ACH (Electronic Check), StoredValue (gift certificate, store credit, auto-reloading prepaid card, etc), and Invoice. The payment type is specified by setting MethodType to 'CreditCard', 'ACH', 'StoredValue' or 'Invoice'. If MethodType is left blank and credit card information is provided, the type will default to 'CreditCard'. If MethodType is left blank and electronic check information is provided, the type will default to 'ACH'. The StoredValue method can be as simple as a store credit or as complex as linking to a physical pre-paid card or gift card with a magnetic strip. For a store credit or simple balance on account, the only required field is Balance. To use the StoredValue payment method, the merchant account must have stored value transactions enabled. The Invoice method allows a merchant to collect transactions that will be invoice at a later date. Balance is increased by the system when an Invoice transaction is received. MaxBalance specifies that maximum balance that a customer can incur before Invoice transactions are declined. Setting MaxBalance to 0 will cause the customer to have no limit. To process Invoice transactions, the merchant account must have Invoice processing enabled. [block:api-header] { "type": "basic", "title": "Properties" } [/block] [block:parameters] { "data": { "h-0": "Type", "h-1": "Name", "h-2": "Description", "0-0": "string", "0-1": "MethodType", "0-2": "Type of payment method ('CreditCard', 'ACH', 'StoredValue' or 'Invoice')", "1-0": "integer", "1-1": "MethodID", "1-2": "ID of payment method. This property is ignored when adding a new payment method but required if updating an existing method. (Read Only)", "2-0": "string", "2-1": "MethodName", "2-2": "Label for payment method. For example “Work Visa” or “Personal Checking.”", "3-0": "integer", "3-1": "SecondarySort", "3-2": "If set to value greater than 0, use this method as backup in case default fails. Secondary methods will be run in ascending order.", "4-0": "datetime", "4-1": "Created", "5-0": "datetime", "5-1": "Modified" }, "cols": 3, "rows": 6 } [/block] [block:parameters] { "data": { "h-0": "Credit Card", "h-1": "Credit Card", "h-2": "Credit Card", "0-0": "string", "0-1": "CardNumber", "0-2": "Credit card number (required for credit cards). If data is coming from a swiper, base64_encode the entire raw block read from the swiper device and put enc:// at the beginning. Example: enc://AAbbCdEEaa…", "1-0": "string", "1-1": "CardExpiration", "1-2": "Credit card expiration date in YYYY-MM format. It will also accept MMYY format. (required for credit cards)", "2-0": "string", "2-1": "AvsStreet", "2-2": "Street address for AVS (address verification system). (Optional but recommended for credit cards)", "3-0": "string", "3-1": "AvsZip", "3-2": "Zip code for AVS. (Optional but recommended for credit cards)", "4-0": "string", "4-1": "CardCode", "4-2": "CVV2/CID card identification code. This code is not stored and is only used when verifying a new payment method before it is added. (Optional for credit cards)", "5-0": "string", "5-1": "CardType", "5-2": "Type of credit card (Visa, Mastercard, etc). This is a read only parameter and will be ignored if set." }, "cols": 3, "rows": 6 } [/block] [block:parameters] { "data": { "h-0": "Electronic Check (ACH)", "h-1": "Electronic Check (ACH)", "h-2": "Electronic Check (ACH)", "0-0": "string", "0-1": "Account", "0-2": "ACH Bank Account Number (required for checks)", "1-0": "string", "1-1": "AccountType", "1-2": "ACH Type of Bank Account (Checking or Savings, defaults to checking)", "2-0": "string", "2-1": "Routing", "2-2": "ACH Bank Routing Number (required for checks)", "3-0": "string", "3-1": "DriversLicense", "3-2": "Drivers license number used for check guarantee (optional)", "4-0": "string", "4-1": "DriversLicenseState", "4-2": "Drivers license state (optional)", "5-0": "string", "5-1": "RecordType", "5-2": "ACH transaction type (optional, should be left blank unless instructed differently by check processor)" }, "cols": 3, "rows": 6 } [/block] [block:parameters] { "data": { "h-0": "Invoice", "h-1": "Invoice", "h-2": "Invoice", "0-0": "double", "0-1": "MaxBalance", "0-2": "The maximum balance that may be charged on Invoice before transactions are declined" }, "cols": 3, "rows": 1 } [/block] [block:parameters] { "data": { "h-0": "Stored Value", "h-1": "Stored Value", "h-2": "Stored Value", "0-0": "double", "0-1": "Balance", "0-2": "The funds left on the account. Transactions against this payment method may not exceed this balance", "1-0": "boolean", "1-1": "AutoReload", "1-2": "Set true if StoredValue card should automatically be reloaded", "2-0": "string", "2-1": "ReloadSchedule", "2-2": "Automatic reload schedule", "3-0": "double", "3-1": "ReloadThreshold", "3-2": "Balance that will trigger an automatic reload", "4-0": "double", "4-1": "ReloadAmount", "4-2": "Amount to automatically reload", "5-0": "integer", "5-1": "ReloadMethodID", "5-2": "Payment method to use for reloading card" }, "cols": 3, "rows": 6 } [/block] [block:api-header] { "type": "basic", "title": "Examples" } [/block] [block:parameters] { "data": { "h-0": "Credit Card", "h-1": "Credit Card", "0-0": "MethodType", "0-1": "CreditCard", "1-0": "MethodName", "1-1": "Work Visa", "2-0": "CardNumber", "2-1": "4444555566667779", "3-0": "CardExpiration", "3-1": "2012-09", "4-0": "AvsStreet", "4-1": "490 Maple Ave", "5-0": "AvsZip", "5-1": "90010" }, "cols": 2, "rows": 6 } [/block] [block:parameters] { "data": { "h-0": "Electronic Check", "h-1": "Electronic Check", "0-0": "MethodType", "0-1": "ACH", "1-0": "MethodName", "1-1": "BoA Savings", "2-0": "RecordType", "2-1": "PPD", "3-0": "AccountType", "3-1": "Savings", "4-0": "Account", "4-1": "4920029", "5-0": "Routing", "5-1": "123456789", "6-0": "DriversLicense", "6-1": "23423422", "7-0": "DriversLicenseState", "7-1": "CA" }, "cols": 2, "rows": 8 } [/block] [block:parameters] { "data": { "h-0": "StoredValue", "h-1": "StoredValue", "0-0": "MethodType", "0-1": "Invoice", "1-0": "MethodName", "1-1": "Customer Account", "2-0": "Balance", "2-1": "250.00" }, "cols": 2, "rows": 3 } [/block] [block:parameters] { "data": { "h-0": "Invoice", "h-1": "Invoice", "0-0": "MethodType", "0-1": "Invoice", "1-0": "MethodName", "1-1": "On Account", "2-0": "Balance", "2-1": "0", "3-0": "MaxBalance", "3-1": "5000.00" }, "cols": 2, "rows": 4 } [/block] ## Visual Basic (.Net) [block:code] { "codes": [ { "code": "Dim payMethod As eBizCharge.PaymentMethod = New eBizCharge.PaymentMethod\n payMethod.CardExpiration = \"1212\"\n payMethod.CardNumber = \"4000100011112224\"\n payMethod.AvsStreet = \"123 Main st.\"\n payMethod.AvsZip = \"90046\"\n payMethod.MethodName = \"My Visa\"", "language": "asp" } ] } [/block] ## C Sharp (.Net) [block:code] { "codes": [ { "code": "eBizCharge.PaymentMethod payMethod = new eBizCharge.PaymentMethod();\n payMethod.CardExpiration = \"1212\";\n payMethod.CardNumber = \"4000100011112224\";\n payMethod.AvsStreet = \"123 Main st.\";\n payMethod.AvsZip = \"90046\";\n payMethod.MethodName = \"My Visa\";\n", "language": "csharp" } ] } [/block]