Sign in

v1

latestOpenAPI 3.0.12026-07-243407211.3 MB
Transfers

Assess Transfer Prerequisites

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

post/programs/{programCode}/transfers/assessment

Path parameters

programCodestring required

The program code for the partner implementation.

Headers

X-GD-RequestIdstring required

A unique identifier (GUID) for tracking the request.

Request body

transferAuthorizationType'Hold' | 'Execute' | 'Accept' | 'Cancel' | 'Reject' | 'System' | 'Reverse'

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.

transferIdentifierstring nullable

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

transferType'DisbursementIn' | 'DisbursementOut' | 'AchOut' | 'Purse' | 'SwipeReload' | 'Adjustment' | 'AchPull' | 'PeerPayment' | 'MrdcTransfer' | 'ECashLoad' | 'BillPay' | 'ECashSend' | 'EGiftPurchase' | 'IFTSend' | 'IFTLoad' | 'IFTOut' | 'SCCPayment' | 'SCCFunding' | 'CreditLineIncrease' | 'CreditLineDecrease' | 'SccOverCreditLimit' | 'SccWriteOffFullBalance' | 'SccWriteOffPartialBalance' | 'SccWriteOffNegativeBalance' | 'SccPaymentByAchPull' | 'CblPayment' | 'CblRefund' | 'SccWriteOffOverCreditLimit' | 'DisbursementInternal' | 'DisbursementExternal' | 'A2AOut' | 'PartnerA2A' | 'PartnerP2P' | 'PartnerA2AIn' | 'A2AIn' | 'GiftA2AIn' | 'AffiliateTransferOut'

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

initiatorstring nullable

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

Example request

{
  "transferRoute": {
    "transactionDescription": "peerPayment",
    "transactionAmount": 1,
    "sourceTransferEndpoint": {
      "transferEndPointType": "account",
      "identifier": "{{accountIdentifierSource}}",
      "currency": "USD"
    },
    "targetTransferEndpoint": {
      "transferEndPointType": "account",
      "identifier": "{{accountIdentifierSource}}",
      "currency": "USD"
    }
  }
}

Response

OK

availableBalancenumber double nullable

The available balance in the source account at the time of assessment. Used to determine if sufficient funds are present to complete the transfer.

prerequisitesstring[] nullable

A list of prerequisite conditions that must be met before the transfer can proceed. If any prerequisites are returned, the customer must fulfill them to be eligible for the transfer.

netAmountnumber double

The net amount that will be transferred after deducting all applicable fees.