Start trusting a beneficiary
Begin trusting (whitelisting) an external account so future sends to it can skip the per-transaction SCA ceremony. Returns the scaChallenge to satisfy (when one is issued). Complete with POST /customers/external-accounts/{externalAccountId}/trust/confirm.
This endpoint is only meaningful for customers in a region where SCA is required (e.g. EU). For customers outside SCA-regulated regions, this returns 409.
Response
Beneficiary trust started; the SCA challenge (if any) is returned.
Example response
{
"scaChallenge": {
"id": "ScaChallenge:019542f5-b3e7-1d02-0000-000000000007",
"expiresAt": "2025-10-03T12:05:00Z",
"availableFactors": [
"SMS_OTP"
],
"purpose": "PAYOUT",
"passkeyAllowedOrigins": [
"https://app.example.com"
]
}
}Changes
Changed in 7 of the 24 revisions of this API.102
- ●
added the new
EXTERNAL_ACCOUNT_VERIFICATION_REQUIREDenum value to thecoderesponse property for the response status400response-property-enum-value-added
This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
- ●
- ●
added the new
TRANSACTION_SIZE_LIMIT_EXCEEDEDenum value to thecoderesponse property for the response status400response-property-enum-value-added
- ●
- ●
added the new
CARDHOLDER_KYC_NOT_APPROVEDenum value to thecoderesponse property for the response status400response-property-enum-value-added
- ●
added the new
CARD_ALREADY_CLOSEDenum value to thecoderesponse property for the response status409response-property-enum-value-added
- ●
added the new
CARD_NOT_MUTABLEenum value to thecoderesponse property for the response status409response-property-enum-value-added
- ●
added the new
INVALID_STATE_TRANSITIONenum value to thecoderesponse property for the response status409response-property-enum-value-added
- ●
- ●
added the new
END_USER_TERMS_VERSION_NOT_FOUNDenum value to thecoderesponse property for the response status400response-property-enum-value-added
- ●
- ●
added the new
BENEFICIARY_TRUSTEDenum value to thecoderesponse property for the response status409response-property-enum-value-added
- ●
added the new
SCA_SESSION_REQUIREDenum value to thecoderesponse property for the response status409response-property-enum-value-added
- ○
added the optional property
details/errorsto the response with the400statusresponse-optional-property-added
- ●
- ●
added the new
TRANSACTION_NOT_CANCELLABLEenum value to thecoderesponse property for the response status409response-property-enum-value-added
This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
- ●
- ○
endpoint added
endpoint-added
This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
- ○