Maintenance & Status APIs

Update Customer

This API updates a P2P customer profile.

Syntax / URL

PUT /programs/{programCode}/customers/{customerToken}

Get Customer

This API retrieves customer information.

Syntax / URL

GET /programs/{programCode}/customers/{customerToken}

Response

Sample Response Body

{
  "customer": {
    "customerToken": "string",
    "firstName": "string",
    "lastName": "string",
    "middleName": "string",
    "email": "string",
    "phoneNumber": "string",
    "dateOfBirth": "string",
    "programCode": "string",
    "status": "string",
    "address": {
      "addressLine1": "Mercaderes",
      "addressLine2": "first floor 2B",
      "city": "San Antonio",
      "state": "TX",
      "zipCode": "12345"
    },
    "responseDetails": [
    {
      "code": 0,
      "subCode": 0,
      "description": "string",
      "responseMessage": "string"
    }
    ]
}
}

Encrypted Response Body

{
  "encryptedData": {
    "version": "EC_v1",
    "ephemeralPublicKey": "MFkwEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAEsymPELC7uheHYIQpCEXJSIAr3Myum8hNuuKEoo2QMoQcfCIQtYNbfEE4S7NBZW3Mpqul66OkNZppoCP+pLpd4A==",
    "publicKeyHash": "I30JEzKX3lvkTAUbdsDbQii0qZY3i8aWtZKtrCHMjuk=",
    "data": "bw/aA1kT+dRN0/2jiHiK5DFRt526GiZhTMnH0SxPLEXSHrn9JFUgjAqJimf5eTgaPjrmfdV28K9f9rw2yoFkkwYeljN1TN26Q1QUwMJotTEHoQR5M4jAjMwGaL2ZTiILOPuH1PIjyu1Tg9GGTdngTk6Pg6WCwVNHlj37FeowyVpmgjo0aa7w9ycW90CLi56VPs9upgSkeZA4fw8bvA0M9d8TuHZwvc5VFHVr5UXofJ81oqqnYwT/IdHEy3UUiDjM0SvId4BNBfVctLPf921noEVIfj0+qZmWcmZvyZvb66izCabfKbHdG/Ux8Gq6H3sLFQpKdgBoxPauaenYoms0+Awa5TEMgcpWa25RSgxHSLvqHZIio8PKmkHhDvQv165A3PuExtbGEhvUBEC6h26O02AyGDrmZQgMaiHFKl0b1BIKbcL06SDvArU="
  },
  "responseDetails": [
    {
      "code": 0,
      "subCode": 0,
      "description": "Success"
    }
  ]
}

Delete Customer

This API is used to delete customer information.

DELETE /programs/{programCode}/customers/{customerToken}

Response

Sample Response Body

{
    "responseDetails": [
    {
      "code": 0,
      "subCode": 0,
      "description": "string",
      "responseMessage": "string"
    }
    ]
  "customerToken": "eb6c967d-765a-4b18-9a6e-d4eb4df69efa",
  "status": "Closed"
}

Update PaymentInstrument

This API updates a customer profile.

PUT /programs/{programCode}/customers/{customerToken}/paymentInstruments/{paymentInstrumentId}

Delete PaymentInstrument

This API delinks a Payment Instrument from the Customer.

Syntax / URL

DELETE programs/{programCode}/customers/{customerToken}/paymentInstruments/{paymentInstrumentId}

Note: X-GD-RequestId is a guid that must be passed as header

Response

Response Body

{
  "responseDetails": [
    {
      "code": 0,
      "subCode": 0,
      "description": "string",
      "responseMessage": "string"
    }
  ],
  "link": {
    "linkId": "string",
    "status": "string"
  }
}

Get PaymentInstrument

This API retrieves payment instrument details using the link customer profile.

GET /programs/{programCode}/customers/{customerToken}/paymentInstruments

Request

{
  "linkageType":"source"
}

LinkageType	Description
Source	Return linked payment Instrument as source, eg. debit card in wallet
Target	Return linked payment Instrument as targe, eg. External Card detailed linked to customer profile

Response

{
  "paymentInstruments": [
    {
      "bank": "string",
      "firstName": "string",
      "lastName": "string",
      "nickName": "string",
      "zipCode": "string",
      "linkDate": "2024-08-06T22:27:24.369Z",
      "status": "string",
      "customerToken": "string",
      "linkId": "string",
      "expirationYear": "string",
      "expirationMonth": "string",
      "last4PAN": "string",
      "bin": "string",
      "association": "string"
    }
  ],
  "responseDetails": [
    {
      "code": 0,
      "subCode": 0,
      "description": "string"
    }
  ]
}

Get Transfer Status

Get status of an already initiated Transfer.

Syntax / URL

GET /programs/{programCode}/accounts/{accountIdentifier}/disbursements/transfer/{transferIdentifier}

Request

curl --request GET \
     --url https://example.com/programs/programCode/accounts/accountIdentifier/disbursements/transfer/transferIdentifier \
     --header 'accept: application/json'

Response

{
  "transaction": {
    "transferIdentifier": "string",
    "status": "string",
    "statusReason": "string",
    "claimCode": "string",
    "claimCodeExpirationDate": "string",
    "originalTransactionCode": 0,
    "originalTransactionCodeDescription": "string",
    "originalTransactionSubCode": 0,
    "source": {
      "name": "string",
      "id": "string",
      "details": [
        {
          "key": "string",
          "value": "string"
        }
      ]
    },
    "destination": {
      "name": "string",
      "id": "string",
      "details": [
        {
          "key": "string",
          "value": "string"
        }
      ]
    },
    "options": [
      {
        "key": "string",
        "value": "string"
      }
    ],
    "amount": 0,
    "currency": "string",
    "description": "string",
    "transactionDate": "string",
    "externalReferenceId": "string"
  },
  "responseDetails": [
    {
      "code": 0,
      "subCode": 0,
      "description": "string",
      "url": "string"
    }
  ]
}

Get Transfers History

API that creates a transfer history request.

Syntax / URL

GET /programs/{programCode}/customers/{customerToken}/transfers?startDate={startEnd}&endDate={endDate}&status={status}&offset={numbers}&limit={limits}
zxcvvxvxv

Refer to status under the table heading TransferStatus for available status.

Pass status=‘all’ to get all transactions irrespective of the status.
offset is a zero based index where 0 represents the most recent transaction.
limits is the number of transactions API returns in a call.
For example, offset=0 and limit=10 will return the most recent 10 transactions.

Response

{
  "transfer": {
    "transferId": "string",
    "transferType": "string",
    "transferStatus": "string",
    "transferStatusReason": "string",
    "transactionDate": "2024-04-24T06:51:46.937Z",
    "currency": "string",    
    "transactionAmount": 0,
    "transactionFeeAmount": 0,
    "transactionNetAmount": 0,
    "feeDetails": [
      {
        "feeType": "string",
        "feeAmount": 0
      }
    ],
    "processor": "string",
    "network": "string"
  }
   "sender":{
      "identifier":"GUID",
      "linkId":"GUID",
      "last4PAN":"string",
      "bank":"string",
      "association":"string",
  },
 "receiver": {
      "last4PAN":"string",
      "bank":"string",
      "association":"string",
      "payName":"string",
      "program": string,
      "identifier":"PPID GUID" -- customer token
      "linkId":"GUID"
  },
  "transferNetworkResponse": {
    "processorCode": "0", 
    "networkStatusCode": "000", 
     "networkStatusDescription": "Accepted" 
   },
    "responseDetails": [
        {
            "code": 0,
            "subCode": 0,
            "description": "Success"
        }
    ]
}

Create Customer Contact Verification

Create customer contact verification information to verify customer contact such as mobile phone or email.

Syntax / URL

POST /gft/v1/programs/{programCode}/customers/{customerToken}/contactVerification

HTTP Codes

Success Http code:

Request

Request Parameters

Field Name	DataType	Description	Format	Values Allowed	Required
contactType	string	contact type	email, or phone	a-z, A-Z	yes
contact	string	contact value for example: phone number email	phone: 10 digit email: email format	phone: 0-9 email: a-z, A-Z	yes
firstName	string	contact first name	Min 2 characters Max 35 characters	a-z, A-Z	no
lastName	string	contact last name	Min 2 characters Max 35 characters	a-z, A-Z	no

Request Body

{
   "contact":"6521716782",
   "contactType":"Phone",
   "firstName":"",
   "lastName":""
}

Response

Response Parameters

Field Name	DataType	Description	Format	Values Allowed	Required
verificationIdentifier	GUID	contact verification information ID	GUID		yes

Response Body

{   
  "verificationIdentifier": "5428d6fd-4a5b-4fec-bb35-8ca51ef4ec74",
  "responseDetails": [
    {
      "code": 0,
      "subCode": 0,
      "description": "string"
    }
  ]
}

Update Customer Contact Verification

Create customer contact verification information to verify customer contact such as mobile phone or email.

Syntax / URL

PUT /gft/v1/programs/{programCode}/customers/{customerToken}/contactVerification

HTTP Code

Success Http code:

Request

Request Parameters

Field Name	DataType	Description	Format	Values Allowed	Required
verificationCode	string	the code to be verified	6 digits	0-9	yes
verificationIdentifier	GUID	contact verification information ID	GUID		yes

Request Body

{
   "verificationCode": "767350",
   "verificationIdentifier": "17c44e56-01b0-4bf5-97f7-5b39b4c7af28"
}

Response

Response Parameters

Field Name	DataType	Description	Format	Values Allowed	Required
verificationIdentifier	GUID	contact verification information ID	GUID		yes
isVerified	bool	status of contact verification	true or false	boolean	yes

Response Body

{   
  "verificationIdentifier": "5428d6fd-4a5b-4fec-bb35-8ca51ef4ec74",
  "isVerified": true,   
  "responseDetails": [
    {
      "code": 0,
      "subCode": 0,
      "description": "success"
    }
  ]
}