{"_id":"5b8ec5e884303f0003a11497","category":{"_id":"5b8ec5e884303f0003a1146d","version":"5b8ec5e884303f0003a114fb","project":"57336fd5a6a9c40e00e13a0b","__v":0,"sync":{"url":"","isSync":false},"reference":false,"createdAt":"2015-10-15T16:20:51.519Z","from_sync":false,"order":11,"slug":"resources","title":"JSON Objects"},"project":"57336fd5a6a9c40e00e13a0b","parentDoc":null,"user":"560d5913af97231900938124","version":{"_id":"5b8ec5e884303f0003a114fb","project":"57336fd5a6a9c40e00e13a0b","__v":0,"forked_from":"5b196f345952df0003e8a66c","createdAt":"2018-04-24T15:22:41.561Z","releaseDate":"2018-04-24T15:22:41.561Z","categories":["5b8ec5e884303f0003a11462","5b8ec5e884303f0003a11463","5b8ec5e884303f0003a11464","5b8ec5e884303f0003a11465","5b8ec5e884303f0003a11466","5b8ec5e884303f0003a11467","5b8ec5e884303f0003a11468","5b8ec5e884303f0003a11469","5b8ec5e884303f0003a1146a","5b8ec5e884303f0003a1146b","5b8ec5e884303f0003a1146c","5b8ec5e884303f0003a1146d","5b8ec5e884303f0003a1146e","5b8ec5e884303f0003a1146f","5b8ec5e884303f0003a11470"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":false,"codename":"3.27 Release","version_clean":"8976.0.0-JSON","version":"8976-JSON"},"githubsync":"","__v":0,"updates":[],"next":{"pages":[],"description":""},"createdAt":"2016-01-06T16:08:25.383Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[]},"settings":"","auth":"required","params":[],"url":""},"isReference":false,"order":1,"body":"###Request\n[block:parameters]\n{\n \"data\": {\n \"h-0\": \"Property Name\",\n \"h-1\": \"Type\",\n \"h-2\": \"Required\",\n \"h-3\": \"Description\",\n \"3-0\": \"`merchantTransactionId`\",\n \"3-2\": \"Optional\",\n \"3-3\": \"Merchant's unique ID for a new transaction. Between 1-50 characters.\",\n \"3-1\": \"*string*\",\n \"3-4\": \"A container of card-transaction properties.\\nThis property may appear more than once within the given resource.\",\n \"h-4\": \"Description\",\n \"4-0\": \"`softDescriptor`\",\n \"5-0\": \"`transactionDescription`\",\n \"4-3\": \"Description of the transaction, which appears on the shopper's credit card statement. Maximum 20 characters.\",\n \"4-1\": \"*string*\",\n \"6-0\": \"`currency`\",\n \"5-1\": \"*string*\",\n \"8-0\": \"`transactionFraudInfo`\",\n \"6-1\": \"*string*\",\n \"8-1\": \"*object*\",\n \"5-3\": \"By default, the PayPal page will show the statement descriptor as the description of the product being purchased. If you prefer to show a different description, you can send it in this element. Can be up to 500 characters.\",\n \"4-2\": \"Optional\",\n \"5-2\": \"Optional\",\n \"6-2\": \"**Required**\",\n \"8-2\": \"Optional\",\n \"6-3\": \"Currency code (ISO 4217) of the amount to be charged. See [Currency codes](/docs/currency-codes).\",\n \"8-3\": \"See [transactionFraudInfo](doc:transaction-fraud-info).\",\n \"7-0\": \"`transactionMetaData`\",\n \"7-1\": \"*object*\",\n \"7-2\": \"Optional\",\n \"7-3\": \"See [transactionMetaData](doc:transaction-meta-data).\",\n \"9-0\": \"`paypalTransaction`\",\n \"9-1\": \"*object*\",\n \"9-3\": \"See [paypalTransaction](doc:paypal-transaction).\",\n \"9-2\": \"**Required** for PayPal transactions.\",\n \"0-0\": \"`amount`\",\n \"0-1\": \"*decimal*\",\n \"0-2\": \"**Required**\",\n \"0-3\": \"Amount to be charged in the transaction, including decimal points.\",\n \"1-0\": \"`payerInfo`\",\n \"1-1\": \"*object*\",\n \"1-2\": \"Optional\",\n \"1-3\": \"See [payerInfo](doc:payer-info).\",\n \"2-0\": \"`vaultedShopperId`\",\n \"2-1\": \"*integer*\",\n \"2-2\": \"Optional\",\n \"2-3\": \"ID of an existing vaulted shopper.\",\n \"10-0\": \"`ecpTransaction`\",\n \"10-1\": \"*object*\",\n \"10-2\": \"**Required** for ACH (ECP) transactions.\",\n \"10-3\": \"See [ecpTransaction](doc:ecp-transaction).\",\n \"12-0\": \"`authorizedByShopper`\",\n \"12-1\": \"*boolean*\",\n \"12-2\": \"**Required** for ACH (ECP) and SEPA Direct Debit transactions.\",\n \"12-3\": \"Value must be **true**.\\n\\nPass this parameter to indicate that you have obtained the shopper's permission to debit their account.\\n\\nFor ACH transactions, you must obtain permission from the shopper to debit their account, for example by showing a checkbox with the following wording on your checkout page. *\\\"I authorize this Electronic Check (ACH) transaction and agree to this debit of my account.\\\"*\\n\\nFor SEPA Direct Debit transactions, you must obtain the shopper's acceptance of the [SEPA Direct Debit Mandate](/docs/sepa-direct-debit#section-step-1-collect-a-mandate-acceptance-from-your-shopper).\",\n \"11-0\": \"`sepaDirectDebitTransaction`\",\n \"11-1\": \"*object*\",\n \"11-2\": \"**Required** for SEPA Direct Debit transactions\",\n \"11-3\": \"See [sepaDirectDebitTransaction](doc:sepadirectdebittransaction).\"\n },\n \"cols\": 4,\n \"rows\": 13\n}\n[/block]\n###Response\n[block:parameters]\n{\n \"data\": {\n \"h-0\": \"Property Name\",\n \"h-1\": \"Type\",\n \"h-2\": \"Description\",\n \"3-0\": \"`merchantTransactionId`\",\n \"3-1\": \"*string*\",\n \"h-3\": \"Description\",\n \"3-3\": \"Defines the type of transaction. Values can be:\\nAUTH_ONLY\\nAUTH_CAPTURE\\nCAPTURE\\nAUTH_REVERSAL\\nSee Transaction Types\",\n \"10-0\": \"`transactionId`\",\n \"10-1\": \"*string*\",\n \"10-3\": \"BlueSnap identifier for the transaction.\",\n \"h-4\": \"Description\",\n \"3-2\": \"Merchant's unique ID for a new transaction.\",\n \"10-2\": \"BlueSnap identifier for the transaction.\",\n \"11-0\": \"`paypalTransaction`\",\n \"11-2\": \"See [paypalTransaction](doc:paypal-transaction).\\nRelevant only for PayPal transactions.\",\n \"11-3\": \"Container of card-holder-info properties.\",\n \"11-1\": \"*object*\",\n \"0-0\": \"`amount`\",\n \"0-1\": \"*decimal*\",\n \"0-2\": \"Amount to be charged in the transaction, including decimal points.\",\n \"2-0\": \"`vaultedShopperId`\",\n \"2-1\": \"*integer*\",\n \"2-2\": \"ID of an existing vaulted shopper.\",\n \"1-0\": \"`payerInfo`\",\n \"1-1\": \"*object*\",\n \"1-2\": \"See [payerInfo](doc:payer-info).\",\n \"4-0\": \"`processingInfo`\",\n \"4-1\": \"*object*\",\n \"4-2\": \"See [processingInfo](doc:processing-info).\",\n \"5-0\": \"`softDescriptor`\",\n \"5-1\": \"*string*\",\n \"5-2\": \"Description of the transaction, which appears on the customer's credit card statement.\",\n \"6-0\": \"`currency`\",\n \"6-1\": \"*string*\",\n \"6-2\": \"Currency code (ISO 4217) of the amount to be charged. See [Currency codes](/docs/currency-codes).\",\n \"7-0\": \"`transactionMetaData`\",\n \"7-1\": \"*object*\",\n \"7-2\": \"See [transactionMetaData](doc:transaction-meta-data).\",\n \"8-2\": \"See [fraudResultInfo](doc:fraud-result-info).\",\n \"8-1\": \"*object*\",\n \"8-0\": \"`fraudResultInfo`\",\n \"14-0\": \"`refunds`\",\n \"14-2\": \"See [refunds](doc:refunds).\",\n \"14-1\": \"*object*\",\n \"12-0\": \"`ecpTransaction`\",\n \"12-1\": \"*object*\",\n \"12-2\": \"See [ecpTransaction](doc:ecp-transaction).\",\n \"13-0\": \"`sepaDirectDebitTransaction`\",\n \"13-1\": \"*object*\",\n \"13-2\": \"See [sepaDirectDebitTransaction](doc:sepadirectdebittransaction).\",\n \"9-0\": \"`subscriptionId`\",\n \"9-1\": \"*integer*\",\n \"9-2\": \"BlueSnap identifier for the subscription.\"\n },\n \"cols\": 3,\n \"rows\": 15\n}\n[/block]","excerpt":"Contains the information required to process a transaction with an alternative payment method","slug":"alt-transaction","type":"basic","title":"altTransaction"}altTransaction
Contains the information required to process a transaction with an alternative payment method
Property Name
Type
Required
Description
amount
decimal
Required
Amount to be charged in the transaction, including decimal points.
vaultedShopperId
integer
Optional
ID of an existing vaulted shopper.
merchantTransactionId
string
Optional
Merchant's unique ID for a new transaction. Between 1-50 characters.
softDescriptor
string
Optional
Description of the transaction, which appears on the shopper's credit card statement. Maximum 20 characters.
transactionDescription
string
Optional
By default, the PayPal page will show the statement descriptor as the description of the product being purchased. If you prefer to show a different description, you can send it in this element. Can be up to 500 characters.
sepaDirectDebitTransaction
object
Required for SEPA Direct Debit transactions
authorizedByShopper
boolean
Required for ACH (ECP) and SEPA Direct Debit transactions.
Value must be true.
Pass this parameter to indicate that you have obtained the shopper's permission to debit their account.
For ACH transactions, you must obtain permission from the shopper to debit their account, for example by showing a checkbox with the following wording on your checkout page. "I authorize this Electronic Check (ACH) transaction and agree to this debit of my account."
For SEPA Direct Debit transactions, you must obtain the shopper's acceptance of the SEPA Direct Debit Mandate.
Property Name
Type
Description
amount
decimal
Amount to be charged in the transaction, including decimal points.
vaultedShopperId
integer
ID of an existing vaulted shopper.
merchantTransactionId
string
Merchant's unique ID for a new transaction.
softDescriptor
string
Description of the transaction, which appears on the customer's credit card statement.
subscriptionId
integer
BlueSnap identifier for the subscription.
transactionId
string
BlueSnap identifier for the transaction.