Developer API

Overview

Account API

Transfer API

Confirm Transfer

GET /transfers/confirm/{TransferID}

This method confirms a transfer request previously initiated by a transfers call. The Status field indicates whether the transfer was completed, or has failed.

Request Objects

Field Type Format Required Description
Transaction Complex object with transaction details
ClaimCode String Max 100 characters Yes Claim code only
Amount String Max 8 characters 99999.99 Yes Amount to be transferred
Status String Max 50 characters Yes Status indicating the D2C transaction is Completed or Failed, for which the D2C scenario should always be Completed.
StoreNumber String Max 50 characters Yes Retailer store # where transaction was completed (eg. Walmart #23)
InquiryType String Max 25 characters Yes Indicates the inquiry type between store and TPG (eg. Lookup, Validate, Commit). For the D2C scenario, this field should always be Commit.
Recipient Complex object with recipient information
FirstName String Max 25 characters No First name of person who will claim/remit cash at retailer
LastName String Max 25 characters No Last name of person who will claim/remit cash at retailer
SocialSecurityNumber String Max 11 characters: No Social security number of person who will claim/remit cash at retailer
StreetAddress String Max 255 characters No Street address of person who will claim/remit cash at retailer
City String Max 55 characters No City of address of person who will claim/remit cash at retailer
State String Max 2 characters No Zip code of address of person who will claim/remit cash at retailer
ZipCode String Max 10 characters No Street address of person who will claim/remit cash at retailer
DateOfBirth String MM-DD-YYYY No Date of birth of person who will claim/remit cash at retailer
IdentificationID String Max 250 characters No Street address of person who will claim/remit cash at retailer
IdentificationIssuedBy String Max 100 characters No Agency that issued the identification
IdentificationType String Max 50 characters No Type of ID presented by person who will claim/remit cash at the retailer. At this time, valid values are 1 or 2.
1 - Driving License
2 - State ID
IdentificationExpiryDate String MM-DD-YYYY No Date the ID expires

Request Sample

POST /transfers/confirm/36145748-4892-4ba6-b0d6-0efe6de55425

{

 "transaction": {

  "claimcode":"xxx",

  "amount": 40.00,

  "status": "Completed",

  "storenumber":"Wal-xxx",

  "inquirytype":"commit"

 },

 "recipient": {

  "firstname": "jack",

  "lastname": "smith",

  "streetaddress":"123 Main St",

  "city": "Eureka",

  "state": "CA",

  "zipcode":"91010",

  "dateofbirth": "2015-10-29T04:13:05.11",

  "socialsecuritynumber": "555123456",

  "identificationid": "CA093283",

  "identificationtype": "1",

  "identificationissuedby": "CA",

  "identificationexpirationdate": "01-01-2019"

 },

}

Response Objects

Field Description
TransferID TransferID used in request
Status Status of transaction (Completed, Failed, etc.)
ChangeDate Last time transaction was updated
ClaimCode Returned for Cash transactions only. Claim code recipient will use to claim cash at register.
ClaimCodeExpiration Returned for Cash transactions only. Expiration date and time for claim code.
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”,

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

 “ClaimCode”: “”,

 “ClaimExpirationDate”: “”,

 “ResponseCode”: “0”,

 “ResponseMessage”: “Success”,

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

}