{"_id":"5b8ec61584303f0003a11512","category":{"_id":"5b8ec61584303f0003a11508","version":"5b8ec61584303f0003a1159b","project":"57336fd5a6a9c40e00e13a0b","__v":0,"sync":{"url":"","isSync":false},"reference":false,"createdAt":"2015-10-15T16:20:51.519Z","from_sync":false,"order":12,"slug":"resources","title":"Resources"},"parentDoc":null,"project":"57336fd5a6a9c40e00e13a0b","user":"560d5913af97231900938124","version":{"_id":"5b8ec61584303f0003a1159b","project":"57336fd5a6a9c40e00e13a0b","__v":0,"forked_from":"5b1973ec0059c20003083ec0","createdAt":"2018-04-24T15:24:22.608Z","releaseDate":"2018-04-24T15:24:22.608Z","categories":["5b8ec61584303f0003a114fc","5b8ec61584303f0003a114fd","5b8ec61584303f0003a114fe","5b8ec61584303f0003a114ff","5b8ec61584303f0003a11500","5b8ec61584303f0003a11501","5b8ec61584303f0003a11502","5b8ec61584303f0003a11503","5b8ec61584303f0003a11504","5b8ec61584303f0003a11505","5b8ec61584303f0003a11506","5b8ec61584303f0003a11507","5b8ec61584303f0003a11508","5b8ec61584303f0003a11509","5b8ec61584303f0003a1150a","5b8ec61584303f0003a1150b"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":false,"codename":"3.27 Release","version_clean":"8976.0.0-XML","version":"8976-XML"},"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 \"0-0\": \"`merchant-transaction-id`\",\n \"0-2\": \"Optional\",\n \"0-3\": \"Merchant's unique ID for a new transaction. Between 1 - 50 characters.\",\n \"0-1\": \"*string*\",\n \"0-4\": \"A container of card-transaction properties.\\nThis property may appear more than once within the given resource.\",\n \"h-4\": \"Description\",\n \"1-0\": \"`soft-descriptor`\",\n \"2-0\": \"`amount`\",\n \"1-3\": \"Description of the transaction, which appears on the shopper's credit card statement. Maximum 20 characters.\",\n \"1-1\": \"*string*\",\n \"3-0\": \"`currency`\",\n \"2-1\": \"*decimal*\",\n \"5-0\": \"`vaulted-shopper-id`\",\n \"3-1\": \"*string*\",\n \"5-1\": \"*integer*\",\n \"12-0\": \"`transaction-fraud-info`\",\n \"2-3\": \"Amount to be charged in the transaction, including decimal points.\",\n \"1-2\": \"Optional\",\n \"2-2\": \"**Required**\",\n \"3-2\": \"**Required**\",\n \"5-2\": \"Optional\",\n \"3-3\": \"Currency code (ISO 4217) of the amount to be charged. See [Currency codes](/docs/currency-codes).\",\n \"5-3\": \"ID of an existing vaulted shopper.\",\n \"12-3\": \"Container of [transaction-fraud-info](doc:transaction-fraud-info) properties.\",\n \"12-2\": \"Optional\",\n \"12-1\": \"container\",\n \"4-0\": \"`payer-info`\",\n \"4-1\": \"container\",\n \"4-2\": \"Optional\",\n \"4-3\": \"Container of [payer-info](doc:payer-info) properties.\",\n \"6-0\": \"`paypal-transaction`\",\n \"6-1\": \"container\",\n \"6-3\": \"Container of [paypal-transaction](doc:paypal-transaction) properties.\",\n \"6-2\": \"**Required** for PayPal transactions.\",\n \"11-0\": \"`transaction-meta-data`\",\n \"11-1\": \"container\",\n \"11-2\": \"Optional\",\n \"11-3\": \"Container of [transaction-meta-data](doc:transaction-meta-data) properties.\",\n \"10-0\": \"`transaction-description`\",\n \"10-1\": \"*string*\",\n \"10-2\": \"Optional\",\n \"10-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 \"7-0\": \"`ecp-transaction`\",\n \"7-1\": \"container\",\n \"7-2\": \"**Required** for ACH (ECP) transactions.\",\n \"7-3\": \"Container of [ecp-transaction](doc:ecp-transaction) properties.\",\n \"9-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 \"9-2\": \"**Required** for ACH (ECP) and SEPA Direct Debit transactions.\",\n \"9-1\": \"*boolean*\",\n \"9-0\": \"`authorized-by-shopper`\",\n \"8-0\": \"`sepa-direct-debit-transaction`\",\n \"8-1\": \"container\",\n \"8-2\": \"**Required** for SEPA Direct Debit transactions\",\n \"8-3\": \"Container of [sepa-direct-debit-transaction](doc:sepa-direct-debit-transaction) properties.\"\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 \"0-0\": \"`merchant-transaction-id`\",\n \"0-1\": \"*string*\",\n \"h-3\": \"Description\",\n \"0-3\": \"Defines the type of transaction. Values can be:\\nAUTH_ONLY\\nAUTH_CAPTURE\\nCAPTURE\\nAUTH_REVERSAL\\nSee Transaction Types\",\n \"2-0\": \"`transaction-id`\",\n \"2-1\": \"*string*\",\n \"2-3\": \"BlueSnap identifier for the transaction.\",\n \"h-4\": \"Description\",\n \"0-2\": \"Merchant's unique ID for a new transaction. Between 1 - 50 characters.\",\n \"2-2\": \"BlueSnap identifier for the transaction.\",\n \"3-0\": \"`soft-descriptor`\",\n \"4-0\": \"`amount`\",\n \"3-3\": \"Description of the transaction, which appears on the customer's credit card statement.\",\n \"3-1\": \"*string*\",\n \"5-0\": \"`currency`\",\n \"4-1\": \"*decimal*\",\n \"7-0\": \"`vaulted-shopper-id`\",\n \"5-1\": \"*string*\",\n \"7-1\": \"*integer*\",\n \"8-0\": \"`paypal-transaction`\",\n \"11-0\": \"`transaction-meta-data`\",\n \"4-3\": \"Amount to be charged in the transaction, including decimal points.\",\n \"3-2\": \"Description of the transaction, which appears on the customer's credit card statement.\",\n \"4-2\": \"Amount to be charged in the transaction, including decimal points.\",\n \"5-2\": \"Currency code (ISO 4217) of the amount to be charged. See [Currency codes](/docs/currency-codes).\",\n \"7-2\": \"ID of an existing vaulted shopper.\",\n \"8-2\": \"Container of [paypal-transaction](doc:paypal-transaction) properties. \\nRelevant only for PayPal transactions.\",\n \"8-3\": \"Container of card-holder-info properties.\",\n \"5-3\": \"Currency of the amount to be charged.\",\n \"7-3\": \"ID of an existing vaulted shopper.\",\n \"11-3\": \"Container of transaction-meta-data properties.\",\n \"11-2\": \"Container of [transaction-meta-data](doc:transaction-meta-data) properties.\",\n \"8-1\": \"container\",\n \"11-1\": \"container\",\n \"12-0\": \"`processing-info`\",\n \"12-1\": \"container\",\n \"12-3\": \"A container of processing-info properties.\",\n \"12-2\": \"Container of [processing-info](doc:processing-info) properties.\",\n \"6-0\": \"`payer-info`\",\n \"6-1\": \"container\",\n \"6-2\": \"Container of [payer-info](doc:payer-info) properties.\",\n \"13-2\": \"Container of [fraud-result-info](doc:fraud-result-info) properties.\",\n \"13-0\": \"`fraud-result-info`\",\n \"13-1\": \"container\",\n \"14-2\": \"Container of [refunds](doc:refunds) properties.\",\n \"14-1\": \"container\",\n \"14-0\": \"`refunds`\",\n \"9-2\": \"Container of [ecp-transaction](doc:ecp-transaction) properties.\",\n \"9-1\": \"container\",\n \"9-0\": \"`ecp-transaction`\",\n \"10-0\": \"`sepa-direct-debit-transaction`\",\n \"10-1\": \"container\",\n \"10-2\": \"Container of [sepa-direct-debit-transaction](doc:sepa-direct-debit-transaction) properties.\",\n \"1-0\": \"`subscription-id`\",\n \"1-1\": \"*integer*\",\n \"1-2\": \"BlueSnap identifier for the subscription.\"\n },\n \"cols\": 3,\n \"rows\": 15\n}\n[/block]","excerpt":"Contains the details required to process a transaction with an alternative payment method","slug":"alt-transaction","type":"basic","title":"alt-transaction"}alt-transaction
merchant-transaction-id
string
Optional
Merchant's unique ID for a new transaction. Between 1 - 50 characters.
soft-descriptor
string
Optional
Description of the transaction, which appears on the shopper's credit card statement. Maximum 20 characters.
amount
decimal
Required
Amount to be charged in the transaction, including decimal points.
vaulted-shopper-id
integer
Optional
ID of an existing vaulted shopper.
paypal-transaction
container
Required for PayPal transactions.
Container of paypal-transaction properties.
ecp-transaction
container
Required for ACH (ECP) transactions.
Container of ecp-transaction properties.
sepa-direct-debit-transaction
container
Required for SEPA Direct Debit transactions
Container of sepa-direct-debit-transaction properties.
authorized-by-shopper
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.
transaction-description
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.
merchant-transaction-id
string
Merchant's unique ID for a new transaction. Between 1 - 50 characters.
subscription-id
integer
BlueSnap identifier for the subscription.
transaction-id
string
BlueSnap identifier for the transaction.
soft-descriptor
string
Description of the transaction, which appears on the customer's credit card statement.
amount
decimal
Amount to be charged in the transaction, including decimal points.
vaulted-shopper-id
integer
ID of an existing vaulted shopper.
paypal-transaction
container
Container of paypal-transaction properties.
Relevant only for PayPal transactions.