Recipients

Get recipient

Returns information about a specific recipient.

get/recipients/{id}

Request

Base URL: https://apigateway.jpmorgan.com/tsapi/ef/v1
URL: https://apigateway.jpmorgan.com/tsapi/ef/v1/recipients/{id}
Auth: none declared

Path parameters

idstring required

Recipient ID. A unique identifier for a recipient.

Headers

tokenstring

JWT Client token

Response

Ok.

idstring required

partyIdstring

Related Party Identifier for Linked Accounts

type'RECIPIENT' | 'LINKED_ACCOUNT' | 'SETTLEMENT_ACCOUNT'

status'ACTIVE' | 'INACTIVE' | 'MICRODEPOSITS_INITIATED' | 'READY_FOR_VALIDATION' | 'REJECTED'

clientIdstring

Client identifier

createdAtstring date-time

The date and time the recipient was created

updatedAtstring date-time

The date and time the recipient was last updated

Example response

{
  "id": "a8eb71c9-7bbb-41f2-8d9e-b0f52d1ecd71",
  "partyDetails": {
    "address": {
      "addressType": "Principal place of business",
      "addressLine1": "90 Bedford Street",
      "addressLine2": "Apt 2E",
      "city": "New York",
      "state": "NY",
      "postalCode": "10014",
      "countryCode": "US"
    },
    "type": "INDIVIDUAL",
    "firstName": "Monica",
    "lastName": "Gellar",
    "businessName": "Central Park Getaways",
    "contacts": [
      {
        "contactType": "PHONE",
        "countryCode": "+1",
        "value": "6316215110"
      }
    ]
  },
  "account": {
    "number": "021000021",
    "type": "CHECKING",
    "routingInformation": [
      {
        "routingNumber": "021000021",
        "transactionType": "RTP",
        "routingCodeType": "USABA"
      }
    ],
    "countryCode": "US"
  },
  "type": "RECIPIENT",
  "status": "ACTIVE",
  "clientId": "0030000132",
  "createdAt": "2023-02-22T15:05:46.952+0000",
  "updatedAt": "2023-02-22T16:05:46.952+0000",
  "accountValidationResponse": [
    {
      "requestId": "53281d03-dfff-4094-a6d8-b43c29b92bef",
      "responses": [
        {
          "codes": {
            "error": {
              "code": 1002,
              "message": "Open Valid"
            },
            "verification": {
              "code": 1002,
              "message": "Open Valid"
            },
            "authentication": {
              "code": 1002,
              "message": "Open Valid"
            },
            "verificationMicroDeposit": {
              "code": 1002,
              "message": "Open Valid"
            },
            "authenticationMicroDeposit": {
              "code": 1002,
              "message": "Open Valid"
            }
          },
          "provider": "EWS",
          "details": {
            "accountNumber": "XXXXXXXX052",
            "financialInstitutionId": {
              "clearingSystemId": {
                "id": "122199983",
                "idType": "ABA"
              }
            },
            "paymentCheckContributingStatus": "Participant",
            "providerResponse": {
              "retryCount": 2,
              "mdNotification": "Ready for validation"
            }
          }
        }
      ]
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.