Follow this guide to use the Account Updater API service and one or more payment card IDs to create an Account Updater request. In response to this request, account updater programs harvest the specified payment card IDs stored in Customer Vault and ensure their associated card information is up-to-date. Account Updater also generates a unique request_id that you can use to check the status of the request. See Create an Account Updater Request Using Card IDs in API Reference for field definitions.

Please note the following:

• You may harvest up to 100 card IDs in one request.
• You may submit multiple Account Updater requests per day.
• It typically takes 3-4 business days to receive a response from the issuers on card updates.

To check the status of an Account Updater request, you can do any of the following:

• Subscribe to the account_updater_request_created webhook event to be notified when the request creation is complete.
• Subscribe to the account_updater_request_completed webhook event to be notified when the request response is received.
• Use the request_id and the Account Updater API to send a Get summary of an Account Updater Request query to check the status of your request at any time.

Prerequisites

1. Follow the steps in Authentication to create a sandbox account and get a sandbox security key and merchant ID.

2. Follow the steps in the Add a Customer guide to create a Customer Vault profile. As you do so, add information for at least one payment card to the billing_cards object. Save the card_id value in the request response.

Implement

1. Write a POST request to send to the /platform/aus/request/create endpoint.
2. In the request body, add card IDs as an array in the card_id field.

Once configured, your request will resemble the sample code below:

curl --request POST \
     --url https://api-test.maast.com/platform/aus/request/create \
     --header 'accept: application/json' \
     --header 'authorization: Basic OjllZGVjMjFhMzFjMHh5ejc4OWUzMGEzNDE2YWJjMTIz' \
     --header 'content-type: application/json' \
     --data '
{
     "card_id": [
          "86e1b00d9b0811e68df3069d8f743581",
          "86e1b00d9b0811e68df3069d8f743582",
          "86e1b00d9b0811e68df3069d8f743583"
     ]
}
'

Integrate

Send your request. You will receive a response like this from the Maast server:

{
  "code": 0,
  "message": "Account updater request created.",
  "data": {
    "request_id": 1234
  }
}

Check the code field in the request response: 0 confirms that you have successfully sent the request to the Account Updater. If the value is something other than 0, check Platform API Response Codes in Reference. See Create an Account Updater Request Using Card IDs in API Reference for field definitions.

Check and save the request_id value in the data field. You can use this value to check the status of the Account Updater's request at any time.

🚧

Save the Request ID

Be sure to save the request_id value that appears in your request response. You will need it to interact with this request using the Account Updater API.

Test and Go Live

See our Test and Go Live guide to test your API integration and to start transacting with an active production account.