{"metadata":{"image":[],"title":"","description":""},"api":{"url":"","auth":"required","results":{"codes":[]},"settings":"","params":[]},"next":{"description":"","pages":[]},"title":"paymentSources","type":"basic","slug":"payment-sources","excerpt":"Contains payment source information for vaulted shoppers","body":"###Request\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Property Name\",\n    \"h-1\": \"Type\",\n    \"h-2\": \"Required\",\n    \"0-0\": \"`creditCardInfo`\",\n    \"0-1\": \"*array* \",\n    \"h-3\": \"Description\",\n    \"0-3\": \"Array containing the following for each payment source (there may be multiple payment sources):\\n\\n* [billingContactInfo](doc:billing-contact-info) *object* optional\\n \\n* [creditCard](doc:credit-card) *object*\\n\\n* `pfToken` *string* - Required if using [Hosted Payment Fields](https://developers.bluesnap.com/v8976-Tools/docs/hosted-payment-fields) or [Embedded Checkout](https://developers.bluesnap.com/v8976-Tools/docs/embedded-checkout). Do not include credit-card resource if using this token. Relevant only for [Create Vaulted Shopper](doc:create-vaulted-shopper) and [Update Vaulted Shopper](doc:update-vaulted-shopper).\\n\\n* `status` *string* Enter **D** to delete the card from the shopper. \\n\\n**Note:** If `status` is included in the request, specify the card to be deleted by including `cardType` and `cardLastFourDigits` within `creditCard`.\",\n    \"0-2\": \"Optional\",\n    \"1-0\": \"`ecpDetails`\",\n    \"1-1\": \"*array*\",\n    \"1-2\": \"Optional\",\n    \"1-3\": \"Array containing the ecp detail properties. See [ecpDetails](doc:ecpdetails).\",\n    \"2-0\": \"`sepaDirectDebitInfo`\",\n    \"2-1\": \"*array*\",\n    \"2-2\": \"Optional\",\n    \"2-3\": \"Array of objects containing [sepaDirectDebitInfo](doc:sepadirectdebitinfo) properties.\",\n    \"3-0\": \"`ecpInfo`\",\n    \"3-1\": \"*object*\",\n    \"3-2\": \"Optional\",\n    \"3-3\": \"Contains information about the ACH/ECP account. See [ecpInfo](doc:ecp-info).\\n\\n**Note: ** This is deprecated as of API v3.0.\"\n  },\n  \"cols\": 4,\n  \"rows\": 4\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\": \"`creditCardInfo`\",\n    \"0-1\": \"*array* \",\n    \"0-2\": \"Array containing the following for each payment source (there may be multiple payment sources):\\n\\n* [billingContactInfo](doc:billing-contact-info) *object* optional\\n\\n* [creditCard](doc:credit-card) *object*\\n \\n* [processingInfo](doc:processing-info) *object*\\n\\n* `dateCreated` *string* The date the payment method was saved to the vaulted shopper. \\n\\n* `timeCreated` *string* The time (PST) the payment method was saved to the vaulted shopper.\",\n    \"1-2\": \"Array containing the ecp detail properties. See [ecpDetails](doc:ecpdetails).\",\n    \"1-1\": \"*array*\",\n    \"1-0\": \"`ecpDetails`\",\n    \"2-0\": \"`sepaDirectDebitInfo`\",\n    \"2-1\": \"*array*\",\n    \"2-2\": \"Array of objects containing [sepaDirectDebitInfo](doc:sepadirectdebitinfo) properties.\",\n    \"3-0\": \"`ecpInfo`\",\n    \"3-1\": \"*object*\",\n    \"3-2\": \"Contains information about the ACH/ECP account. See [ecpInfo](doc:ecp-info).\\n\\n**Note: ** This is deprecated as of API v3.0.\"\n  },\n  \"cols\": 3,\n  \"rows\": 4\n}\n[/block]","updates":[],"order":31,"isReference":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"_id":"60a40b18fa93ca00237af506","category":{"sync":{"isSync":false,"url":""},"pages":[],"title":"JSON Objects","slug":"resources","order":15,"from_sync":false,"reference":false,"_id":"60a40b18fa93ca00237af4c8","version":"60a40b18fa93ca00237af576","project":"57336fd5a6a9c40e00e13a0b","createdAt":"2015-10-15T16:20:51.519Z","__v":0},"user":"560d5913af97231900938124","project":"57336fd5a6a9c40e00e13a0b","parentDoc":null,"version":{"version":"8976-JSON","version_clean":"8976.0.0-JSON","codename":"3.38 Release","is_stable":false,"is_beta":false,"is_hidden":false,"is_deprecated":false,"categories":["60a40b18fa93ca00237af4bd","60a40b18fa93ca00237af4be","60a40b18fa93ca00237af4bf","60a40b18fa93ca00237af4c0","60a40b18fa93ca00237af4c1","60a40b18fa93ca00237af4c2","60a40b18fa93ca00237af4c3","60a40b18fa93ca00237af4c4","60a40b18fa93ca00237af4c5","60a40b18fa93ca00237af4c6","60a40b18fa93ca00237af4c7","60a40b18fa93ca00237af4c8","60a40b18fa93ca00237af4c9","60a40b18fa93ca00237af4ca","60a40b18fa93ca00237af4cb","60a40b18fa93ca00237af4cc","60a40b18fa93ca00237af4cd","60a40b18fa93ca00237af4ce","60a40b18fa93ca00237af4cf"],"_id":"60a40b18fa93ca00237af576","project":"57336fd5a6a9c40e00e13a0b","__v":0,"forked_from":"603d5bd1309e0703644e931e","createdAt":"2018-04-24T15:22:41.561Z","releaseDate":"2018-04-24T15:22:41.561Z"},"createdAt":"2016-01-06T13:15:19.038Z","githubsync":"","__v":0}

paymentSources

Contains payment source information for vaulted shoppers

Request

Property Name
Type
Required
Description

creditCardInfo

array

Optional

Array containing the following for each payment source (there may be multiple payment sources):

Note: If status is included in the request, specify the card to be deleted by including cardType and cardLastFourDigits within creditCard.

ecpDetails

array

Optional

Array containing the ecp detail properties. See ecpDetails.

sepaDirectDebitInfo

array

Optional

Array of objects containing sepaDirectDebitInfo properties.

ecpInfo

object

Optional

Contains information about the ACH/ECP account. See ecpInfo.

Note: This is deprecated as of API v3.0.

Response

Property Name
Type
Description

creditCardInfo

array

Array containing the following for each payment source (there may be multiple payment sources):

  • billingContactInfo object optional

  • creditCard object

  • processingInfo object

  • dateCreated string The date the payment method was saved to the vaulted shopper.

  • timeCreated string The time (PST) the payment method was saved to the vaulted shopper.

ecpDetails

array

Array containing the ecp detail properties. See ecpDetails.

sepaDirectDebitInfo

array

Array of objects containing sepaDirectDebitInfo properties.

ecpInfo

object

Contains information about the ACH/ECP account. See ecpInfo.

Note: This is deprecated as of API v3.0.