Developer API

Overview

Account API

Transfer API

Initiate Transfer

POST /transfers

This method creates a transfer request to move funds from a source link to a destination link.

Request Objects

Field Type Format Required Description
TransferObjects Complex object to specify source and destination URIs
SourceURI String Max 255 characters Yes Link URI for funding source
DestinationURI String Max 255 characters Yes Link URI for destination source
Transaction Complex object with transaction details
Amount String Max 8 characters 99999.99 Yes Amount to be transferred
Currency String Exactly 3 characters Yes Currency type for transaction. At present, only USD is accepted for this field.
Description String Max 10 characters No Plain-text description of this transaction for reference
TransactionDate String ISO 8601 Yes Date and time of transfer
Options Array Array of key/value pairs No Key value pair that partner can use to pass any special options for the transfer

Request Sample

POST /transfers

{

 "transferobjects":{

  "sourceuri": "https://partners.greendotonline.com/customers/950e4868-9f51-4a08-96a7-fcad96c4458e",

  "destinationuri": "https://partners.greendotonline.com/customers/950e4868-9f51-4a08-96a7-fcad96c4458e/links/0738054c-a715-4c90-af4c-ad99bae91abc"

 },

 "transaction":{

  "amount": "25.00",

  "currency": "USD",

  "description": "Payroll",

  “transactiondate”:“2015-11-16T15:20:000Z”

 },

 "options":[

  {

  "key":"Sample-Key1",

  "value":"Sample-Value1"

  },

  {

  "key":"Sample-Key2",

  "value":"Sample-Value2"

  }

 ]

}

Response Objects

Field Description
TransferID Transfer ID associated with the request
Status Status of transaction. See Transfer Status Codes under Get Transfer by Transfer ID.
ClaimCode Claim code associated with transaction, if any
ClaimCodeExpirationDate Expiration date and time for claim code, if any
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

{

 “TransferID”: “36145748-4892-4ba6-b0d6-0efe6de55425”,

 “Status”: “Completed”,

 “ClaimCode”: “”,

 “ClaimExpirationDate”: “”,

 “ResponseCode”: “0”,

 “ResponseMessage”: “Success”,

 “ResponseDate”: “2015-10-02T09:00:000Z”

}

Validation Failure

{

 "responsecode": "80",

 "responsemessage": "Limits Exceeded",

 "responsedate": "2015-10-03T09:00:000Z"

 "responsedetail": {

  "responsedetailcode": "3020",

  "responsedetaildescription": "Recipient Limit Exceeded"

 }

}