Developer API

Overview

Account API

Transfer API

Get Transfer by Transfer ID

GET /transfers/{transferID}

Retrieves information about a transfer based on its Transfer ID.

Request Objects

There are no request objects for this method.

Transfer Status Codes

The response includes a Status field which indicates the status of the transfer.

Code Status Description
1 Pending Transfer request pending. Funds have not yet been deposited to the recipient.
2 Completed Transfer completed. Funds have been deposited to the recipient.
3 Failed Transfer failed. Funds are not deposited to the recipient.
4 Rejected Transfer was rejected. Funds are not deposited to the recipient.
5 Cancelled Transfer was cancelled. Funds are not deposited to the recipient.

Response Objects

Field Description
PartnerProgramIdentifier Unique ID provided by Green Dot for the given partner program
TransferID Transfer ID associated with the request
Status Status of transaction (Completed, Pending, Failed)
StatusCode Code associated with the status
StatusReason Description of status, if failed (eg. Partner Rejected, System Error, etc.)
ClaimCode Claim code associated with transaction, if any
ClaimCodeExpirationDate Expiration date and time for claim code, if any
Source Complex object defining the source for the transaction
Name Name associated with source
ID Customer ID or other ID for transaction source
Target Complex object defining the target (destination) for the transaction
Name Name associated with target
ID Customer ID or other ID for transaction target
Transaction Complex object with transaction details
Amount Amount of transaction
Currency Currency used in transaction
Description Description of transaction
TransactionDate Date and time of transaction
LastModifiedDate Last date/time transaction was updated
Options Array of Key/Value pairs
ResponseCode A response code of 0 indicates success. See Response Codes for other response codes.
ResponseMessage A response message of Success indicates success. See Response Codes for other response messages.
ResponseDate Response date and time.

Response Sample

{

 "partnerprogramidentifier": "TST_TPG_RFTRFND_GOBANKCRD",

 "transferid": "bae21712-eb6b-4b41-812b-ed51a69a14fd",

 "statuscode": 2,

 "status": "Completed",

 "statusreason": "TransferCompleted",

 "claimcode": "a98356f6-458e-46c4-ada6-6a26f9a71ab8",

 "claimcodeexpirationdate": null,

 "source": {

  "name": "Bin Zhang",

  "id": "tst002",

 },

 "destination": {

  "name": "",

  "id": "d74a9606-577e-401f-8b19-1e3e1c7b1f79",

 },

 "transaction": {

  "amount": 40,

  "currency": "USD",

  "description": "TST_TPG_RFTRFND_GOBANKCRD",

  "transactiondate": "2015-10-29T04:13:05.11Z",

  "lastmodifieddate": "2015-10-29T04:13:05.11Z"

 },

 "options":[

 {

  "key":"Sample-Key1",

  "value":"Sample-Value1"

 },

 {

  "key":"Sample-Key2",

  "value":"Sample-Value2"

 }

 ],

 "responsecode": 0,

 "responsemessage": "Success",

 "responsedate": "2015-11-03T20:07:39.670097Z",

 }