On This Page

REST Example: Pull Funds Transfer

Request with a PAN card

This example shows a Pull Funds Transfer request with a PAN card.

{
  "clientReferenceInformation": {
    "code": "33557799",
    "applicationName": "EXAMPLE API",
    "applicationVersion": "V1",
    "applicationUser": "example_user"
  },
  "orderInformation": {
    "amountDetails": {
      "totalAmount": "53.00",   
      "currency": "USD"
    }
  },
  "processingInformation": {
    "commerceIndicator": "INTERNET",
    "businessApplicationId": "WT",
    "purposeOfPayment": "example"
  },
  "recipientInformation": {
    "administrativeArea": "TX",
    "countryCode": "US",
    "firstName": "Jennifer",
    "middleInitial": "M",
    "lastName": "Doe",
    "identificationNumber": "1234567890",
    "type": "I",
    "descriptor": "Jennifer1234",
        "address1": "123 Main St",
        "address2": "Suite 4000"
  },
  "senderInformation": {
    "postalCode": "94440",
    "firstName": "John",
    "middleInitial": "A",
    "lastName": "Doe",
    "address1": "567 Paseo Padre Boulevard",
        "address2": "Apt 4",
   
    "locality": "Foster City",
    "administrativeArea": "CA",
    "country": "US",
    "paymentInformation": {
      "card": {
        "type": "001",
        "securityCode": "123",
        "number": "4111111111111111",
        "expirationMonth": "12",
        "expirationYear": "2030"
      },
      "accountType": "30"
    },
    "personalIdentification": {
      "issuingCountry": "US",
      "id": "123abc",
      "type": "TXIN",
      "personalIdType": "I"
    },
    "referenceNumber": "123456"
  }
}

Response to a Successful Request

This example shows a Pull Funds Transfer response with a PAN card.

{
  "_links": {
    "refund": {
      "href": "/pts/v1/pull-funds-transfer/7180269028616978704951/refund",
      "method": "POST"
    },
    "reversal": {
      "href": "/pts/v1/pull-funds-transfer/7180269028616978704951/reversal",
      "method": "POST"
    },
    "self": {
      "method": "GET",
      "href": "/pts/v1/pull-funds-transfer/7180269028616978704951"
    }
  },
  "processorInformation": {
    "approvalCode": "98765X",
    "transactionId": "798964527787170",
    "systemTraceAuditNumber": "903083",
    "retrievalReferenceNumber": "416213903083",
    "responseCode": "5"
  },
  "id": "7180269028616978704951",
  "status": "AUTHORIZED",
  "submitTimeUtc": "2027-06-10T13:41:42Z"
}