API Reference

Assess Transfer Prerequisites

post
https://example.com/programs//transfers/assessment

Assesses if the required prerequisites are met for various transfer types (P2P, ACH Out, IFT). Verifies user identity and returns any unmet requirements.

Path Params
string
required

The program code for the partner implementation.

Body Params

The Gd.Bos.DataTransfer.Request.AssessTransferRequest containing transfer type and account details.

Represents a request to assess the eligibility, risk, and prerequisites for a funds transfer operation. This request is used to validate and pre-check a transfer before execution, including authorization type, transfer type, routing, and initiator details. It supports a variety of transfer types (ACH, internal, disbursement, MRDC, etc.) and is typically used for fraud/risk assessment, compliance, and business rule validation.

string
enum

The type of authorization being requested for the transfer (e.g., Execute, Hold, Accept, Cancel, Reject, System, Reverse). Determines the intended action for the transfer assessment.

Allowed:
string | null

The unique identifier for the transfer. Used for idempotency, tracking, and reference in assessment and subsequent operations.

string
enum

The type of transfer being assessed (e.g., ACH Out, Internal Transfer, Disbursement, MRDC Transfer). Determines the business rules and validations applied during assessment.

string | null

The identifier of the account or entity initiating the transfer. Typically references the source account or user responsible for the transfer.

transferRoute
object

Represents the routing and endpoint details for a funds transfer operation. Contains information about the transaction amount, description, fee handling, and the source and target endpoints. Used for transfers between accounts, cards, or external endpoints, supporting a variety of transfer types such as A2A, B2C, and partner-initiated transfers.

Headers
string
required

A unique identifier (GUID) for tracking the request.

string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

401

Unauthorized

Updated 3 months ago

Language
Credentials
Header
LoadingLoading…
Response
Choose an example:
application/json
text/json

Updated 3 months ago