Preview

Get receiver configuration

GET
/providers/{providerID}/configuration

Read the outbound receiver configuration for your provider. The response includes the latest version and its receiver and endpoint settings. Credential secrets stay off this response.

Returns 200 with the latest version. When no version is stored, returns 200 with version 0. The receiver is your provider account. URLs are empty. Default timeouts and deadlines apply. No credential references are set. Returns 404 when the provider does not exist. Returns 400 when providerID is malformed. Returns 401 when your API key or bearer token is missing or invalid. Returns 403 when you cannot act for the provider in the path. You can call this while your affiliation with the provider is still being set up.

Auth: API key or bearer token. An affiliated integrator needs the moov-money-config.read scope granted by the FI.

Request
cURL
curl -X GET https://api.moov.money/providers/{providerID}/configuration \
  -u "$MOOV_API_KEY_ID:$MOOV_API_KEY_SECRET" \
  -H "X-Moov-Version: v2026.10.00"
Responses
200 400 401 403 404
The request completed successfully.
{
  "authorize": {
    "attemptTimeout": 2000000000,
    "credentialReferenceID": "5f0c3b2a-8d4e-4b7a-9c1f-2e6d7a8b9c0d",
    "deadline": 8000000000,
    "url": "https://fi.example.com/authorize"
  },
  "capture": {
    "attemptTimeout": 2000000000,
    "credentialReferenceID": "5f0c3b2a-8d4e-4b7a-9c1f-2e6d7a8b9c0d",
    "deadline": 8000000000,
    "url": "https://fi.example.com/authorize"
  },
  "credit": {
    "attemptTimeout": 2000000000,
    "credentialReferenceID": "5f0c3b2a-8d4e-4b7a-9c1f-2e6d7a8b9c0d",
    "deadline": 8000000000,
    "url": "https://fi.example.com/authorize"
  },
  "providerID": "acc_01HF5J9ZKQT4RXP8M2VYBN3D",
  "receiver": {
    "accountID": "acc_01HF5J9ZKQT4RXP8M2VYBN3D",
    "type": "fi"
  },
  "receiverDeduplicatesAuthorize": false,
  "release": {
    "attemptTimeout": 2000000000,
    "credentialReferenceID": "5f0c3b2a-8d4e-4b7a-9c1f-2e6d7a8b9c0d",
    "deadline": 8000000000,
    "url": "https://fi.example.com/authorize"
  },
  "version": 0
}
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.
The requested resource was not found.

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.

Response

The latest outbound receiver configuration for your provider.

providerID

string required
Your provider account ID.

version

integer<int64> required
A value of 0 means no configuration version is stored. Send this value as expectedVersion on the next update.

receiver

object required
Account that receives outbound ledger calls.
Show child attributes

receiver

type

string<enum> required
Kind of receiver. fi is your provider account. integrator is the affiliated integrator.
Possible values: fi, integrator

accountID

string required
Account ID of the receiver. For fi, this is your provider account ID.

authorize

object required
Authorize endpoint settings.
Show child attributes

authorize

url

string required
HTTPS URL Moov Money calls for this operation. Empty when no URL is stored. Use port 443 or omit the port. The URL has no user information and no fragment. Maximum length is 2048 characters.

credentialReferenceID

string | null required
Credential reference for this operation. Null when none is set.

attemptTimeout

integer<int64> required
Time Moov Money waits for one attempt, in nanoseconds. The value is greater than zero and no greater than deadline.

deadline

integer<int64> required
Time Moov Money waits for the whole operation, including retries, in nanoseconds. The value is greater than or equal to attemptTimeout.

capture

object required
Capture endpoint settings.
Show child attributes

capture

url

string required
HTTPS URL Moov Money calls for this operation. Empty when no URL is stored. Use port 443 or omit the port. The URL has no user information and no fragment. Maximum length is 2048 characters.

credentialReferenceID

string | null required
Credential reference for this operation. Null when none is set.

attemptTimeout

integer<int64> required
Time Moov Money waits for one attempt, in nanoseconds. The value is greater than zero and no greater than deadline.

deadline

integer<int64> required
Time Moov Money waits for the whole operation, including retries, in nanoseconds. The value is greater than or equal to attemptTimeout.

release

object required
Release endpoint settings.
Show child attributes

release

url

string required
HTTPS URL Moov Money calls for this operation. Empty when no URL is stored. Use port 443 or omit the port. The URL has no user information and no fragment. Maximum length is 2048 characters.

credentialReferenceID

string | null required
Credential reference for this operation. Null when none is set.

attemptTimeout

integer<int64> required
Time Moov Money waits for one attempt, in nanoseconds. The value is greater than zero and no greater than deadline.

deadline

integer<int64> required
Time Moov Money waits for the whole operation, including retries, in nanoseconds. The value is greater than or equal to attemptTimeout.

credit

object required
Credit endpoint settings.
Show child attributes

credit

url

string required
HTTPS URL Moov Money calls for this operation. Empty when no URL is stored. Use port 443 or omit the port. The URL has no user information and no fragment. Maximum length is 2048 characters.

credentialReferenceID

string | null required
Credential reference for this operation. Null when none is set.

attemptTimeout

integer<int64> required
Time Moov Money waits for one attempt, in nanoseconds. The value is greater than zero and no greater than deadline.

deadline

integer<int64> required
Time Moov Money waits for the whole operation, including retries, in nanoseconds. The value is greater than or equal to attemptTimeout.

receiverDeduplicatesAuthorize

boolean required
Whether the receiver treats a repeated authorize for the same payment as the same hold. Moov Money uses this when an authorize response does not arrive.