Update provider

PATCH
/providers/{providerID}

Update your provider record. Currently only shortName is supported. Returns 200 with the updated record.

Auth: API key or bearer token. The providerID in the path must be your account.

Request
cURL
curl -X PATCH https://api.moov.money/providers/{providerID} \
  -u "$MOOV_API_KEY_ID:$MOOV_API_KEY_SECRET" \
  -H "X-Moov-Version: v2026.10.00" \
  -H "Content-Type: application/json" \
  -d '{
  "shortName": "ACME"
}'
Responses
200 400 401 403
The request completed successfully.
{
  "shortName": "ACME"
}
Malformed request: the body or headers failed validation.
Response body application/problem+json
RFC 9457 Problem Details error body, served as application/problem+json. From v2026.10.00, every error response that has a body uses this schema.

type

string required
URI that tells you which problem occurred. Branch on this value; it never changes. Moov problem types look like https://api.moov.money/errors#<code> (for example invalid-request, idempotency-key-reused, or idempotency-request-in-progress). Treat the value as an opaque constant and do not fetch it. about:blank means the HTTP status code says everything there is to know.

title

string required
Short human-readable name of the problem type. Fixed per type; defaults to the HTTP status text.

status

integer<int32> required
The HTTP status code of this response.

detail

string
Human-readable explanation of this specific occurrence.

instance

string
URI reference that identifies this specific occurrence.

errors

array<object>
The request-body fields that failed validation. Present on validation errors only.
Show child attributes

errors[]

pointer

string required
RFC 6901 JSON Pointer to the field, using the public JSON field names. If the field is missing, the pointer shows where it belongs.

detail

string required
What is wrong with the field.
Authentication missing, invalid, or insufficient.
Authentication present but the action is forbidden for this principal/claim.

Headers

X-Moov-Version

string
Set this header to the API version being targeted (e.g. v2026.10.00). When omitted, the server applies its default version.

Path parameters

providerID

string required
Your provider account ID.

Request

application/json
Fields to update on your provider record. Currently only shortName is supported.

shortName

string [2 to 12] characters required
Short, machine-friendly identifier for your provider. Moov Money composes the dynamic descriptor surfaced on the recipient’s card statement on payout settlement (e.g. ACME becomes ACME*JANE S). Must be 2-12 characters and contain only ASCII letters and digits.

Response

Your updated provider record.

shortName

string required
Short, machine-friendly identifier for your provider, used to compose the dynamic descriptor on the recipient’s card statement.