This guide provides instructions for updating the payment information saved to a profile in the Payee Vault. Because each payee profile is limited to one ACH account, this replaces any account information previously saved to the profile. See Update a Payee Account in API Reference for field definitions.

To update a payee's name or other personal information, send an Update a Payee request.

Please note: This API resource is intended for a specific use case and requires integration through the Maast product team. To use this resource, please contact Maast Customer Support.

Prerequisites

1. Contact Maast Customer Support to configure your account for this resource.
2. Follow the Get Started guide to open your sandbox and get your test credentials.
3. See Authentication to format the credentials and generate your API token. (Alternatively, use the credentials as-is to test this endpoint with our 'Try It!' feature.)

Implement

1. Write a POST request. For the request endpoint, append your payee_id value to the end of /platform/vault/payee/account/. The resulting endpoint is /platform/vault/payee/account/payee_id, where the value replaces payee_id. See the url in the sample code below.

2. Add payment information to the body of the request using fields in the sample code below. tr_number and dda_number fields are required.

3. If you are making this request on behalf of another merchant, add their merchant ID.

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

curl --request POST \
     --url https://api-test.maast.com/platform/vault/payee/account/999678 \
     --header 'accept: application/json' \
     --header 'authorization: Basic OjllZGVjMjFhMzFjMHh5ejc4OWUzMGEzNDE2YWJjMTIz' \
     --header 'content-type: application/json' \
     --data '
{
     "type_id": "S",
     "tr_number": "028000082",
     "dda_number": "3456776866",
     "accountholder_name": "John Doe",
     "merchant_id": 210000000289
}
'

Integrate

Send the configured request to your customized endpoint.

Maast will return a success response with the updated account information, like the code below:

{
  "type_id": "S",
  "tr_number": "028000082",
  "dda_number": "3456776866",
  "accountholder_name": "John Doe",
  "verified_date": "2022-02-01T10:28:55.000015-08:00"
}

See Update a Payee Account in API Reference for response field definitions.

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.