Assess Update Transfer

put

https://example.com/programs/{programCode}/transfers/{transferIdentifier}/assessment

Assesses the prerequisites and eligibility for updating an existing transfer. Returns assessment results and any unmet requirements.

Path Params

programCode

string

required

The program code for the partner implementation.

transferIdentifier

string

required

The unique identifier for the transfer to assess.

Body Params

The Gd.Bos.DataTransfer.Request.AssessUpdateTransferRequest containing update details for the transfer.

Represents a request to assess the eligibility, risk, and prerequisites for updating a transfer.
Inherits all properties from Gd.Bos.DataTransfer.Request.UpdateTransferRequest and is used to validate and pre-check a transfer update operation
before execution, including authorization type, transfer endpoint, device information, and debit-to-negative settings.
This assessment helps ensure compliance, risk mitigation, and business rule validation prior to performing the actual update.

transferAuthorizationType

string | null

The type of authorization being requested for the transfer update (e.g., "execute", "hold", "accept", "cancel", "reject", "system", "reverse").
Determines the intended action for the transfer update.

transferEndpoint

object

Represents the endpoint details for updating a transfer, such as the source or target of funds.
Contains information about the endpoint type, unique identifier, and card data (encrypted or unencrypted) used in the transfer update process.
Used to specify or modify the source or destination for a transfer during an update operation.

debitToNegative

boolean | null

Indicates whether the update allows the account to be debited to a negative balance (true if allowed).

device

object

Represents device-specific information used when initiating a transfer or other sensitive operation.
Contains details about the device and network, such as device ID, make, model, operating system, and IP addresses.
Used for device identification, risk assessment, auditing, and fraud prevention.

Headers

X-GD-RequestId

string

required

A unique identifier (GUID) for tracking the request.

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

content-type

string

enum

Defaults to application/json-patch+json

Generated from available request content types

Allowed:

Responses

401

Unauthorized

200OK

403Forbidden

500Internal Server Error

503Service Unavailable