v1

latestOpenAPI 3.0.12026-07-243407211.3 MB
CustomerLink

Create a cash pickup link

Creates a link for the customer profile used to generate a Cash Pickup claim code.

post/v1.2/customers/{customerId}/links/type/cash

Path parameters

customerIdstring required

Customer Id created using /Customers api

Headers

requestidstring required

Unique identifier for the request

endusersecurityidstring

End User Security Id

enduseripstring required

Client IP Address

partneridentifierstring

Identifier for a particular partner/program

Authorizationstring required

Basic Authorization Header

apikeystring

ApiKey provided by GD

Request body

firstnamestring
lastnamestring
emailstring
phonestring
addressstring
citystring
statestring
zipcodestring
customeridstring
dateofbirthstring

Date of Birth

identificationidstring

Identification Id of the receipient

identificationtypeinteger

identification type

identificationissuedbystring

identification Issued By

identificationexpirationdatestring

identification Expiration

ssnstring

SSN

Response

OK

linkidstring

DisbursementProfileToken

linkuristring

DisbursementProfileLinkUri

statusstring

Status

responsecodeinteger

Specifies the status of a Disbursement Core Service Service operation

responsemessagestring

Specifies the descriptive text on the status of a Disbursement Core Service operation

responsedatestring date-time

RespnseDate