Transfer from Partner to Partner or Purse to Purse

post https://example.com/programs/{programCode}/transfers

This endpoint is used to transfer funds from a program-funding source to a consumer account. The transferType value differentiates the transaction from a B2C, A2A, or P2P.

Note:

For B2C Disbursements, Use transferType as DisbursementExternal
For A2A Transfers use transferType as A2AOut

For B2C transfers, a configured account is required for the organization providing the funds. A static account ID is assigned, which the partner is expected to pass in the transfer request.

For A2A transfers from a Green Dot-issued account, the partner should pass the Green Dot Account ID as the source identifier in the transfer request.

Path Params

programCode

string

required

Program Code by Customer

Body Params

Request Object

transferIdentifier

string | null

Required: If the transaction is initiated through the Transfers API, the transferIdentifier that uniquely identifies the initiating transfer is included.

transferType

string | null

Required:

Use TransferType A2AOut for Debit Card transfers.
Use TransferType DisbursementExternal for B2C Disbursements.
Use TransferType PartnerA2A for partner account to account transfers.
Use TransferType A2A for account to account transfers.

transferAuthorizationType

string | null

Required: This field must be execute. This is the only acceptable value.

initiator

string | null

Required: This field contains the ID of the funding source account.

verificationIdentifier

string | null

Optional : VerificationIdentifier only for achPull

userIdentifier

string | null

Optional : userIdentifier only for achOut

memo

string | null

Optional: Memo

transferDescription

string | null

Optional: Transfer Description

partnerReferenceData

string | null

Optional: When a valid disbursementExternal is processed, the partner can optionally provide information in the partnerReferenceData field which can be matched to the funding transfer request along with the corresponding transaction. Upon request, the partnerReferenceData can be included in the settlement report.

Note: Including the partnerReferenceData field in the request enables the partner to cross reference the report information with internal records.

transferRoute

object

fraudData

object | null

Optional : Expected keys for transfer types IFTSend and ECashSend - (deviceId, customerIP)

Headers

X-GD-RequestId

string

required

Unique identifier to track transaction

Responses

Response body

object

transfer

object

transferIdentifier

string | null

Required : TransferIdentifier

transferStatus

string | null

Required : Transfer status

accounts

array of objects | null

accounts

object

accountIdentifier

string | null

accountReferenceNumber

string | null

productCode

string | null

productTierKey

int32

cipLevel

string | null

productMaterialType

string | null

currency

string | null

status

string | null

instantIssue

boolean

statusReasons

array of strings | null

statusReasons

statusCure

string | null

accountStatusChangedDateTime

string | null

activationDate

string | null

directDepositInformation

object

purses

array of objects | null

purses

object

purseIdentifier

string | null

purseType

string | null

purseDescription

string | null

availableBalance

double

ledgerBalance

double

availableBalanceAsOfDateTime

string | null

ledgerBalanceAsOfDateTime

string | null

isHidden

boolean

status

string | null

goalAmount

double | null

goalDate

string | null

iconName

string | null

createDate

date-time | null

changeDate

date-time | null

purseNumber

string | null

interestRateTierIdentifier

string | null

interestRateTier

string | null

interestYieldStartDate

string | null

interestYieldEndDate

string | null

APY

double | null

purseSubType

string | null

interestRate

double | null

isRoundUp

boolean

additionalPurses

array of objects | null

additionalPurses

object

purseIdentifier

string | null

purseType

string | null

purseDescription

string | null

availableBalance

double

ledgerBalance

double

availableBalanceAsOfDateTime

string | null

ledgerBalanceAsOfDateTime

string | null

isHidden

boolean

status

string | null

goalAmount

double | null

goalDate

string | null

iconName

string | null

createDate

date-time | null

changeDate

date-time | null

purseNumber

string | null

interestRateTierIdentifier

string | null

interestRateTier

string | null

interestYieldStartDate

string | null

interestYieldEndDate

string | null

APY

double | null

purseSubType

string | null

interestRate

double | null

isRoundUp

boolean

accountHolders

array of objects | null

accountHolders

object

paymentInstruments

array of objects | null

paymentInstruments

object

encryptedPrivatePaymentInstrumentData

object

Container for encrypted data

privatePaymentInstrumentData

object

paymentIdentifier

string | null

paymentInstrumentIdentifier

string | null

paymentInstrumentType

string | null

status

string | null

statusReasons

array of strings | null

statusReasons

isPinSet

boolean

last4Pan

string | null

activatedDateTime

string | null

cardPausedDateTime

string | null

issuedDateTime

string | null

isOverIssuedDaysLimit

boolean | null

isPrivateDataViewable

boolean

embossedName

string | null

customCardImageIdentifier

string | null

paymentInstrumentLevel

string

personalized nonpersonalized

productMaterialType

string | null

cardIssueSource

string | null

user

object

Container for user information

accountHolderIdentifier

string | null

termsAcceptances

array of objects | null

termsAcceptances

object

termsIdentifier

string | null

termsAcceptanceDateTime

string | null

termsAcceptanceFlag

boolean | null

fraudData

object | null

Has additional fields

accountType

string | null

language

string | null

accountCycleDay

int32 | null

accountEligibility

object

upgradeKycStateData

object

targetUserType

string | null

partnerAccountId

string | null

productClass

string | null

enrollmentSource

string | null

fraudData

object | null

Has additional fields

responseDetails

array of objects | null

Required : Container for response details

responseDetails

object

code

int32

subCode

int32 | null

description

string | null

url

string | null

401

Unauthorized

Response body

object

transfer

object

transferIdentifier

string | null

Required : TransferIdentifier

transferStatus

string | null

Required : Transfer status

accounts

array of objects | null

accounts

object

accountIdentifier

string | null

accountReferenceNumber

string | null

productCode

string | null

productTierKey

int32

cipLevel

string | null

productMaterialType

string | null

currency

string | null

status

string | null

instantIssue

boolean

statusReasons

array of strings | null

statusReasons

statusCure

string | null

accountStatusChangedDateTime

string | null

activationDate

string | null

directDepositInformation

object

purses

array of objects | null

purses

object

purseIdentifier

string | null

purseType

string | null

purseDescription

string | null

availableBalance

double

ledgerBalance

double

availableBalanceAsOfDateTime

string | null

ledgerBalanceAsOfDateTime

string | null

isHidden

boolean

status

string | null

goalAmount

double | null

goalDate

string | null

iconName

string | null

createDate

date-time | null

changeDate

date-time | null

purseNumber

string | null

interestRateTierIdentifier

string | null

interestRateTier

string | null

interestYieldStartDate

string | null

interestYieldEndDate

string | null

APY

double | null

purseSubType

string | null

interestRate

double | null

isRoundUp

boolean

additionalPurses

array of objects | null

additionalPurses

object

purseIdentifier

string | null

purseType

string | null

purseDescription

string | null

availableBalance

double

ledgerBalance

double

availableBalanceAsOfDateTime

string | null

ledgerBalanceAsOfDateTime

string | null

isHidden

boolean

status

string | null

goalAmount

double | null

goalDate

string | null

iconName

string | null

createDate

date-time | null

changeDate

date-time | null

purseNumber

string | null

interestRateTierIdentifier

string | null

interestRateTier

string | null

interestYieldStartDate

string | null

interestYieldEndDate

string | null

APY

double | null

purseSubType

string | null

interestRate

double | null

isRoundUp

boolean

accountHolders

array of objects | null

accountHolders

object

paymentInstruments

array of objects | null

paymentInstruments

object

encryptedPrivatePaymentInstrumentData

object

Container for encrypted data

privatePaymentInstrumentData

object

paymentIdentifier

string | null

paymentInstrumentIdentifier

string | null

paymentInstrumentType

string | null

status

string | null

statusReasons

array of strings | null

statusReasons

isPinSet

boolean

last4Pan

string | null

activatedDateTime

string | null

cardPausedDateTime

string | null

issuedDateTime

string | null

isOverIssuedDaysLimit

boolean | null

isPrivateDataViewable

boolean

embossedName

string | null

customCardImageIdentifier

string | null

paymentInstrumentLevel

string

personalized nonpersonalized

productMaterialType

string | null

cardIssueSource

string | null

user

object

Container for user information

accountHolderIdentifier

string | null

termsAcceptances

array of objects | null

termsAcceptances

object

termsIdentifier

string | null

termsAcceptanceDateTime

string | null

termsAcceptanceFlag

boolean | null

fraudData

object | null

Has additional fields

accountType

string | null

language

string | null

accountCycleDay

int32 | null

accountEligibility

object

upgradeKycStateData

object

targetUserType

string | null

partnerAccountId

string | null

productClass

string | null

enrollmentSource

string | null

fraudData

object | null

Has additional fields

responseDetails

array of objects | null

Required : Container for response details

responseDetails

object

code

int32

subCode

int32 | null

description

string | null

url

string | null

Response body

object

transfer

object

transferIdentifier

string | null

Required : TransferIdentifier

transferStatus

string | null

Required : Transfer status

accounts

array of objects | null

accounts

object

accountIdentifier

string | null

accountReferenceNumber

string | null

productCode

string | null

productTierKey

int32

cipLevel

string | null

productMaterialType

string | null

currency

string | null

status

string | null

instantIssue

boolean

statusReasons

array of strings | null

statusReasons

statusCure

string | null

accountStatusChangedDateTime

string | null

activationDate

string | null

directDepositInformation

object

purses

array of objects | null

purses

object

purseIdentifier

string | null

purseType

string | null

purseDescription

string | null

availableBalance

double

ledgerBalance

double

availableBalanceAsOfDateTime

string | null

ledgerBalanceAsOfDateTime

string | null

isHidden

boolean

status

string | null

goalAmount

double | null

goalDate

string | null

iconName

string | null

createDate

date-time | null

changeDate

date-time | null

purseNumber

string | null

interestRateTierIdentifier

string | null

interestRateTier

string | null

interestYieldStartDate

string | null

interestYieldEndDate

string | null

APY

double | null

purseSubType

string | null

interestRate

double | null

isRoundUp

boolean

additionalPurses

array of objects | null

additionalPurses

object

purseIdentifier

string | null

purseType

string | null

purseDescription

string | null

availableBalance

double

ledgerBalance

double

availableBalanceAsOfDateTime

string | null

ledgerBalanceAsOfDateTime

string | null

isHidden

boolean

status

string | null

goalAmount

double | null

goalDate

string | null

iconName

string | null

createDate

date-time | null

changeDate

date-time | null

purseNumber

string | null

interestRateTierIdentifier

string | null

interestRateTier

string | null

interestYieldStartDate

string | null

interestYieldEndDate

string | null

APY

double | null

purseSubType

string | null

interestRate

double | null

isRoundUp

boolean

accountHolders

array of objects | null

accountHolders

object

paymentInstruments

array of objects | null

paymentInstruments

object

encryptedPrivatePaymentInstrumentData

object

Container for encrypted data

privatePaymentInstrumentData

object

paymentIdentifier

string | null

paymentInstrumentIdentifier

string | null

paymentInstrumentType

string | null

status

string | null

statusReasons

array of strings | null

statusReasons

isPinSet

boolean

last4Pan

string | null

activatedDateTime

string | null

cardPausedDateTime

string | null

issuedDateTime

string | null

isOverIssuedDaysLimit

boolean | null

isPrivateDataViewable

boolean

embossedName

string | null

customCardImageIdentifier

string | null

paymentInstrumentLevel

string

personalized nonpersonalized

productMaterialType

string | null

cardIssueSource

string | null

user

object

Container for user information

accountHolderIdentifier

string | null

termsAcceptances

array of objects | null

termsAcceptances

object

termsIdentifier

string | null

termsAcceptanceDateTime

string | null

termsAcceptanceFlag

boolean | null

fraudData

object | null

Has additional fields

accountType

string | null

language

string | null

accountCycleDay

int32 | null

accountEligibility

object

upgradeKycStateData

object

targetUserType

string | null

partnerAccountId

string | null

productClass

string | null

enrollmentSource

string | null

fraudData

object | null

Has additional fields

responseDetails

array of objects | null

Required : Container for response details

responseDetails

object

code

int32

subCode

int32 | null

description

string | null

url

string | null

Language

Credentials

Header


xxxxxxxxxx
1
curl --request POST \
2
     --url https://example.com/programs/programCode/transfers \
3
     --header 'accept: application/json' \
4
     --header 'content-type: application/*+json'

Click Try It! to start a request and see the response here! Or choose an example:

application/json

text/json

201If the transfer is successfull

400If some transfer parameter is missing or wrong, see response code reference for all possible response subCodes and descriptions.

403Forbidden

404Not Found

500Server Error

503Server Error