{"_id":"5b19742cb3baf90003cab56b","category":{"_id":"5b19742cb3baf90003cab4f0","version":"5b19742cb3baf90003cab5ae","project":"57336fd5a6a9c40e00e13a0b","__v":0,"sync":{"url":"","isSync":false},"reference":false,"createdAt":"2015-10-15T16:20:51.519Z","from_sync":false,"order":8,"slug":"resources","title":"Resources"},"parentDoc":null,"project":"57336fd5a6a9c40e00e13a0b","user":"560d5913af97231900938124","version":{"_id":"5b19742cb3baf90003cab5ae","project":"57336fd5a6a9c40e00e13a0b","__v":0,"forked_from":"5adf4e59ac13b80003d23152","createdAt":"2018-04-24T15:33:45.744Z","releaseDate":"2018-04-24T15:33:45.744Z","categories":["5b19742cb3baf90003cab4e8","5b19742cb3baf90003cab4e9","5b19742cb3baf90003cab4ea","5b19742cb3baf90003cab4eb","5b19742cb3baf90003cab4ec","5b19742cb3baf90003cab4ed","5b19742cb3baf90003cab4ee","5b19742cb3baf90003cab4ef","5b19742cb3baf90003cab4f0","5b19742cb3baf90003cab4f1","5b19742cb3baf90003cab4f2"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":false,"codename":"3.26 Release","version_clean":"8976.0.0-Extended","version":"8976-Extended"},"githubsync":"","__v":0,"updates":[],"next":{"pages":[],"description":""},"createdAt":"2016-06-27T17:36:04.271Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[]},"settings":"","auth":"required","params":[],"url":""},"isReference":false,"order":64,"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. 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]","excerpt":"","slug":"ordering-shopper","type":"basic","title":"ordering-shopper"}

Request

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.

credit-card

container

Optional

Container of credit-card properties.

invoice-contact-info

container

Optional

Container of invoice-contact-info properties.

web-info

container

Required

Container of web-info properties.

fraud-info

container

Required

Container of fraud-info properties.

local-bank-transfer

container

Optional

Empty field to indicate a Local Bank Transfer charge. Consists only of the tag.

paypal

container

Optional

Container of paypal 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.

wallet

container

Optional

Contains wallet details for Apple Pay. See wallet.

sepa-direct-debit

container

Optional

Container of sepa-direct-debit properties.

ecp

conatiner

Optional

Container of ecp properties.

Response

Property Name
Type
Description

shopper-id

string

Shopper's BlueSnap ID.