GAgalileo-ft
External Account Links

Validate External Account Link

Use the Validate External Account Link endpoint to submit microdeposit amounts for a pending external account link using microdeposit validation. The request compares the submitted amounts against the stored values and returns the updated link and validation status.

post/validateExternalAccountLink

Request

  • Base URL
    {corename}.payment-hub.{env}.gpsrv.com/payment-hub/1.0
  • URL
    {corename}.payment-hub.{env}.gpsrv.com/payment-hub/1.0/validateExternalAccountLink
  • Auth
    none declared. Required headers: Authorization

Headers

Authorizationstring required
Example:Basic eW91cl9hcGlsb2dpbjp5b3VyX2FwaXRyYW5za2V5

Basic authentication token (base64-encoded {apilogin}:{apitranskey} credentials provided by SoFi Tech Solutions)

Request body

accountNostring required

The <glossary:PRN> to which the external account link belongs. Pattern: PRN Example: "074103447228"

externalAccountLinkIdstring required

Unique identifier for the external account link to validate using microdeposit validation. Use the value returned by createExternalAccountLink. Pattern: 1–40 digits Example: "12345"

amount1string required

First microdeposit amount that the account holder submitted. Example: "0.03" or ".5"

amount2string required

Second microdeposit amount that the account holder submitted. Example: "0.07" or ".07"

Example request

{
  "accountNo": "074103447228",
  "externalAccountLinkId": "12345",
  "amount1": "0.03",
  "amount2": "0.07"
}

Response

Successful Response

linkStatusstring required

External account link status after validation (e.g. PENDING, ACTIVE, FAILED).

validationStatusstring required

Microdeposit validation status after this attempt (e.g. PENDING, PASSED, FAILED).

attemptsRemaininginteger required

Number of microdeposit verification attempts remaining in the current cycle.

isTerminalboolean required

True when the link reached a terminal state (ACTIVE or FAILED) and will not accept further attempts.

statusReasonstring nullable

Reason code when validation failed or the link is terminal.

originationPendingboolean

True when microdeposits have not yet originated, meaning no verification attempt was consumed.

Changes

No recorded changes to this operation across all 1 revision of this API.