{"_id":"5a7859c739d48800123298ef","category":{"_id":"5a7859c639d48800123298c4","version":"5a7859c639d48800123298c0","project":"57336fd5a6a9c40e00e13a0b","__v":0,"sync":{"url":"","isSync":false},"reference":true,"createdAt":"2016-05-17T12:18:23.126Z","from_sync":false,"order":4,"slug":"account-updater","title":"Account Updater"},"parentDoc":null,"user":"560d5913af97231900938124","project":"57336fd5a6a9c40e00e13a0b","version":{"_id":"5a7859c639d48800123298c0","project":"57336fd5a6a9c40e00e13a0b","__v":2,"createdAt":"2018-02-05T13:19:02.408Z","releaseDate":"2018-02-05T13:19:02.408Z","categories":["5a7859c639d48800123298c1","5a7859c639d48800123298c2","5a7859c639d48800123298c3","5a7859c639d48800123298c4","5a7859c639d48800123298c5","5a7859c639d48800123298c6","5a7859c639d48800123298c7","5a7859c639d48800123298c8","5a7859c639d48800123298c9","5a7859c639d48800123298ca","5a785b7f39d488001232996a"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":false,"codename":"3.24.1 Release","version_clean":"8976.0.0-Tools","version":"8976-Tools"},"__v":0,"updates":[],"next":{"pages":[],"description":""},"createdAt":"2016-05-17T13:12:08.693Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"examples":{"codes":[]},"method":"get","results":{"codes":[{"language":"text","code":""}]},"settings":"","auth":"optional","params":[{"_id":"576abd0f481fa82b00c06e44","ref":"","in":"path","required":true,"desc":"batch ID provided in the Create Account Updater Request","default":"","type":"string","name":"account-update-batch-id"}],"url":""},"isReference":true,"order":2,"body":"##Definition\nhttps<span>://sandbox.bluesnap.com/services/2/account-updater/{account-update-batch-id}</span>\n\n<hr>\n\n##Documentation\nThe Retrieve Account Updater request gets results about a previously submitted [Create Account Updater](doc:create-account-updater) request, including information about the credit card accounts that were updated. The results will be ready 5 - 6 days after the initial Create Account Updater request, and will be available for 45 days. If the process is not complete, you will receive a message saying the file is not yet available (details below).\n[block:callout]\n{\n  \"type\": \"info\",\n  \"body\": \"The Retrieve Account Updater request should be submitted 5 - 6 days after the initial [Create Account Updater](doc:create-account-updater) request. Please note that card updates are not available in sandbox.\"\n}\n[/block]\n###Request Content\nEnter the `account-update-batch-id` into the web service URL, in the format:\n`services/2/account-updater/{account-update-batch-id}`\n\nFor example:\n`services/2/account-updater/my_unique_au_id_003`\n\n###Response Details\nIf successful, the response HTTP status code is 200 OK.\nThe response contains the retrieved `batch-account-update` resource (see [batch-account-update](doc:batch-account-update)) with the request properties, plus these additions for each `account update` resource:\n&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;`update-response-code`\n&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;`update-response-message`\n&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;`updated-card`\n\n**Account Updater Response Codes and Messages**\n  * **500** The account number was changed. Submit the account number returned in the completion response. \n  * **501** The account was closed. Contact the cardholder for updated information. \n  * **502** The expiration date was changed. Submit the expiration date returned in the completion response.\n  * **503** The issuing bank does not participate in the update program. Submit the original card information.\n  * **504** Contact the cardholder for updated information. Contact the cardholder for updated information. \n  * **505** No match found. Submit the original card information .\n  * **506** No changes found. Submit the original card information. \n\n**Response if Account Update processing is not yet complete**\nIf processing is not yet complete, you will receive the following response: \n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"<?xml version=\\\"1.0\\\" encoding=\\\"UTF-8\\\" standalone=\\\"yes\\\"?>\\n<batch-account-update xmlns=\\\"http://ws.plimus.com\\\">\\n  <response-code>20005</response-code>\\n  <response-message>The account update file for batch Id {batchId} is not ready yet. Please try again later.</response-message>\\n</batch-account-update>\",\n      \"language\": \"xml\",\n      \"name\": \"Reponse before processing is complete\"\n    }\n  ]\n}\n[/block]\n\n<hr>\n\n##Examples\n\n###Request Example\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"curl -v -X GET https://sandbox.bluesnap.com/services/2/account-updater/my_unique_au_id_003 \\\\\\n-H 'Content-Type: application/xml' \\\\\\n-H 'Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ='\",\n      \"language\": \"curl\",\n      \"name\": \"Retrieve Account Updater Request\"\n    }\n  ]\n}\n[/block]\n###Response Example\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"HTTP/ 1.1 200 OK\\n\\n<batch-account-update xmlns=\\\"http://ws.plimus.com\\\">\\n    <response-code>0</response-code>\\n    <response-message>Merchant Fiscal Day: 12132004</response-message>\\n    <account-update>\\n        <merchant-updater-id>00001</merchant-updater-id>\\n        <update-response-code>506</update-response-code>\\n        <update-response-message>No changes found</update-response-message>\\n        <original-card>\\n            <credit-card>\\n                <card-number>4012888888881881</card-number>\\n                <card-type>VISA</card-type>\\n                <card-sub-type>CREDIT</card-sub-type>\\n                <expiration-month>03</expiration-month>\\n                <expiration-year>15</expiration-year>\\n            </credit-card>\\n        </original-card>\\n    </account-update>\\n    <account-update>\\n        <merchant-updater-id>00002</merchant-updater-id>\\n        <update-response-code>502</update-response-code>\\n        <update-response-message>The expiration date was changed</update-response-message>\\n        <original-card>\\n            <credit-card>\\n                <card-number>4111111111111111</card-number>\\n                <card-type>VISA</card-type>\\n                <card-sub-type>DEBIT</card-sub-type>\\n                <expiration-month>04</expiration-month>\\n                <expiration-year>16</expiration-year>\\n            </credit-card>\\n        </original-card>\\n        <updated-card>\\n            <credit-card>\\n                <card-number>4111111111111111</card-number>\\n                <card-type>VISA</card-type>\\n                <card-sub-type>CREDIT</card-sub-type>\\n                <expiration-month>08</expiration-month>\\n                <expiration-year>19</expiration-year>\\n            </credit-card>\\n        </updated-card>\\n    </account-update>\\n    <account-update>\\n        <merchant-updater-id>00003</merchant-updater-id>\\n        <update-response-code>500</update-response-code>\\n        <update-response-message>The account number was changed</update-response-message>\\n        <original-card>\\n            <credit-card>\\n                <card-number>5555555555554444</card-number>\\n                <card-type>MASTERCARD</card-type>\\n                <card-sub-type>DEBIT</card-sub-type>\\n                <expiration-month>05</expiration-month>\\n                <expiration-year>17</expiration-year>\\n            </credit-card>\\n        </original-card>\\n        <updated-card>\\n            <credit-card>\\n                <card-number>5156430030000095</card-number>\\n                <card-type>MASTERCARD</card-type>\\n                <card-sub-type>CREDIT</card-sub-type>\\n                <expiration-month>01</expiration-month>\\n                <expiration-year>18</expiration-year>\\n            </credit-card>\\n        </updated-card>\\n    </account-update>\\n</batch-account-update>\",\n      \"language\": \"xml\",\n      \"name\": \"Retrieve Account Updater Response: 200 OK\"\n    }\n  ]\n}\n[/block]\n<hr>\n\n##Example Description\nAbove is an example request. Note that no XML content is required in the request body. You simply need to include the `account-update-batch-id` in the request URL. This the unique ID sent in the the `account-update-batch-id` property in the initial [Create Account Updater](doc:create-account-updater) request.\n<br>\n<a class=\"btn btn-primary\" href=\"#\" role=\"button\">Back to Top</a>","excerpt":"","slug":"retrieve-account-updater","type":"get","title":"Retrieve Account Updater"}

getRetrieve Account Updater


Definition

https://sandbox.bluesnap.com/services/2/account-updater/{account-update-batch-id}


Documentation

The Retrieve Account Updater request gets results about a previously submitted Create Account Updater request, including information about the credit card accounts that were updated. The results will be ready 5 - 6 days after the initial Create Account Updater request, and will be available for 45 days. If the process is not complete, you will receive a message saying the file is not yet available (details below).

The Retrieve Account Updater request should be submitted 5 - 6 days after the initial Create Account Updater request. Please note that card updates are not available in sandbox.

Request Content

Enter the account-update-batch-id into the web service URL, in the format:
services/2/account-updater/{account-update-batch-id}

For example:
services/2/account-updater/my_unique_au_id_003

Response Details

If successful, the response HTTP status code is 200 OK.
The response contains the retrieved batch-account-update resource (see batch-account-update) with the request properties, plus these additions for each account update resource:
      update-response-code
      update-response-message
      updated-card

Account Updater Response Codes and Messages

  • 500 The account number was changed. Submit the account number returned in the completion response.
  • 501 The account was closed. Contact the cardholder for updated information.
  • 502 The expiration date was changed. Submit the expiration date returned in the completion response.
  • 503 The issuing bank does not participate in the update program. Submit the original card information.
  • 504 Contact the cardholder for updated information. Contact the cardholder for updated information.
  • 505 No match found. Submit the original card information .
  • 506 No changes found. Submit the original card information.

Response if Account Update processing is not yet complete
If processing is not yet complete, you will receive the following response:

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<batch-account-update xmlns="http://ws.plimus.com">
  <response-code>20005</response-code>
  <response-message>The account update file for batch Id {batchId} is not ready yet. Please try again later.</response-message>
</batch-account-update>


Examples

Request Example

curl -v -X GET https://sandbox.bluesnap.com/services/2/account-updater/my_unique_au_id_003 \
-H 'Content-Type: application/xml' \
-H 'Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ='

Response Example

HTTP/ 1.1 200 OK

<batch-account-update xmlns="http://ws.plimus.com">
    <response-code>0</response-code>
    <response-message>Merchant Fiscal Day: 12132004</response-message>
    <account-update>
        <merchant-updater-id>00001</merchant-updater-id>
        <update-response-code>506</update-response-code>
        <update-response-message>No changes found</update-response-message>
        <original-card>
            <credit-card>
                <card-number>4012888888881881</card-number>
                <card-type>VISA</card-type>
                <card-sub-type>CREDIT</card-sub-type>
                <expiration-month>03</expiration-month>
                <expiration-year>15</expiration-year>
            </credit-card>
        </original-card>
    </account-update>
    <account-update>
        <merchant-updater-id>00002</merchant-updater-id>
        <update-response-code>502</update-response-code>
        <update-response-message>The expiration date was changed</update-response-message>
        <original-card>
            <credit-card>
                <card-number>4111111111111111</card-number>
                <card-type>VISA</card-type>
                <card-sub-type>DEBIT</card-sub-type>
                <expiration-month>04</expiration-month>
                <expiration-year>16</expiration-year>
            </credit-card>
        </original-card>
        <updated-card>
            <credit-card>
                <card-number>4111111111111111</card-number>
                <card-type>VISA</card-type>
                <card-sub-type>CREDIT</card-sub-type>
                <expiration-month>08</expiration-month>
                <expiration-year>19</expiration-year>
            </credit-card>
        </updated-card>
    </account-update>
    <account-update>
        <merchant-updater-id>00003</merchant-updater-id>
        <update-response-code>500</update-response-code>
        <update-response-message>The account number was changed</update-response-message>
        <original-card>
            <credit-card>
                <card-number>5555555555554444</card-number>
                <card-type>MASTERCARD</card-type>
                <card-sub-type>DEBIT</card-sub-type>
                <expiration-month>05</expiration-month>
                <expiration-year>17</expiration-year>
            </credit-card>
        </original-card>
        <updated-card>
            <credit-card>
                <card-number>5156430030000095</card-number>
                <card-type>MASTERCARD</card-type>
                <card-sub-type>CREDIT</card-sub-type>
                <expiration-month>01</expiration-month>
                <expiration-year>18</expiration-year>
            </credit-card>
        </updated-card>
    </account-update>
</batch-account-update>


Example Description

Above is an example request. Note that no XML content is required in the request body. You simply need to include the account-update-batch-id in the request URL. This the unique ID sent in the the account-update-batch-id property in the initial Create Account Updater request.


Back to Top