{"metadata":{"image":[],"title":"","description":""},"api":{"url":"","auth":"required","results":{"codes":[]},"settings":"","params":[]},"next":{"description":"","pages":[]},"title":"ordering-shopper","type":"basic","slug":"ordering-shopper","excerpt":"","body":"###Request\n[block:parameters]\n{\n \"data\": {\n \"h-0\": \"Property Name\",\n \"h-1\": \"Type\",\n \"h-2\": \"Required\",\n \"2-0\": \"`credit-card`\",\n \"2-1\": \"container\",\n \"h-3\": \"Description\",\n \"2-3\": \"Container of [credit-card](doc:credit-card) properties.\",\n \"3-0\": \"`invoice-contact-info`\",\n \"3-1\": \"container\",\n \"3-3\": \"Container of [invoice-contact-info](doc:invoice-contact-info) properties.\",\n \"h-4\": \"Description\",\n \"2-2\": \"Optional\",\n \"3-2\": \"Optional\",\n \"4-0\": \"`web-info`\",\n \"4-1\": \"container\",\n \"4-2\": \"**Required**\",\n \"4-3\": \"Container of [web-info](doc:web-info) properties.\",\n \"0-0\": \"`shopper-id`\",\n \"1-0\": \"`seller-shopper-id`\",\n \"0-1\": \"*string*\",\n \"1-1\": \"*string*\",\n \"0-2\": \"Optional\",\n \"1-2\": \"Optional\",\n \"5-0\": \"`fraud-info`\",\n \"6-0\": \"`local-bank-transfer`\",\n \"5-1\": \"container\",\n \"6-1\": \"container\",\n \"5-2\": \"**Required**\",\n \"6-2\": \"Optional\",\n \"5-3\": \"Container of [fraud-info](doc:fraud-info) properties.\",\n \"6-3\": \"Empty field to indicate a Local Bank Transfer charge. Consists only of the tag.\",\n \"0-3\": \"Shopper's BlueSnap ID.\",\n \"1-3\": \"Unique shopper ID assigned by the merchant.\",\n \"7-0\": \"`paypal`\",\n \"7-1\": \"container\",\n \"7-2\": \"Optional\",\n \"7-3\": \"Container of [paypal](doc:paypal) properties.\",\n \"8-0\": \"`authorized-by-shopper`\",\n \"8-1\": \"*boolean* \",\n \"8-2\": \"**Required** for ACH (ECP) and SEPA Direct Debit transactions.\",\n \"8-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-0\": \"`wallet`\",\n \"9-1\": \"container\",\n \"9-2\": \"Optional\",\n \"9-3\": \"Contains wallet details for Apple Pay and Google Pay™. See [wallet](doc:wallet).\",\n \"10-0\": \"`sepa-direct-debit`\",\n \"10-1\": \"container\",\n \"10-2\": \"Optional\",\n \"10-3\": \"Container of [sepa-direct-debit](doc:sepa-direct-debit) properties.\",\n \"11-0\": \"`ecp`\",\n \"11-1\": \"conatiner\",\n \"11-2\": \"Optional\",\n \"11-3\": \"Container of [ecp](doc:ecp) properties.\"\n },\n \"cols\": 4,\n \"rows\": 12\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 \"h-3\": \"Description\",\n \"h-4\": \"Description\",\n \"0-0\": \"`shopper-id`\",\n \"0-1\": \"*string*\",\n \"0-2\": \"Shopper's BlueSnap ID.\"\n },\n \"cols\": 3,\n \"rows\": 1\n}\n[/block]","updates":[],"order":65,"isReference":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"_id":"6040037678d626005641a100","category":{"sync":{"isSync":false,"url":""},"pages":[],"title":"Resources","slug":"resources","order":8,"from_sync":false,"reference":false,"_id":"6040037678d626005641a08c","version":"6040037678d626005641a154","project":"57336fd5a6a9c40e00e13a0b","createdAt":"2015-10-15T16:20:51.519Z","__v":0},"parentDoc":null,"project":"57336fd5a6a9c40e00e13a0b","user":"560d5913af97231900938124","version":{"version":"8976-Extended","version_clean":"8976.0.0-Extended","codename":"3.37 Release","is_stable":false,"is_beta":false,"is_hidden":false,"is_deprecated":false,"categories":["6040037678d626005641a084","6040037678d626005641a085","6040037678d626005641a086","6040037678d626005641a087","6040037678d626005641a088","6040037678d626005641a089","6040037678d626005641a08a","6040037678d626005641a08b","6040037678d626005641a08c","6040037678d626005641a08d","6040037678d626005641a08e"],"_id":"6040037678d626005641a154","project":"57336fd5a6a9c40e00e13a0b","__v":0,"forked_from":"5c742637ad58c70033b9c762","createdAt":"2018-04-24T15:33:45.744Z","releaseDate":"2018-04-24T15:33:45.744Z"},"createdAt":"2016-06-27T17:36:04.271Z","githubsync":"","__v":0}ordering-shopper
Property Name
Type
Required
Description
shopper-id
string
Optional
Shopper's BlueSnap ID.
seller-shopper-id
string
Optional
Unique shopper ID assigned by the merchant.
local-bank-transfer
container
Optional
Empty field to indicate a Local Bank Transfer charge. Consists only of the tag.
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.
Property Name
Type
Description
shopper-id
string
Shopper's BlueSnap ID.
