ZELLE RESTful API DOCUMENTATION - IBM

IBM FINANCIAL TRANSACTION MANAGER FOR ACH SERVICES

ZELLE RESTful API DOCUMENTATION

1 ? Copyright IBM Corp. 2017,2018

Before you use this information and the product it supports, read the information in "Notices" on page 170.

Fifth edition (September 2018) ? Copyright International Business Machines Corporation 2017,2018. US Government Users Restricted Rights - Use, duplication or disclosure restricted by GSA ADP Schedule Contract with IBM Corp.

2 ? Copyright IBM Corp. 2017,2018

TABLE OF CONTENTS

Commonly Used Fields............................................................................................................................................................ 7 CXCParticipant......................................................................................................................................................................... 8

Attributes ............................................................................................................................................................................ 8 Key................................................................................................................................................................................... 8 Fields ............................................................................................................................................................................... 8

Web Services..................................................................................................................................................................... 10 Create (POST) ................................................................................................................................................................ 10 Read (GET)..................................................................................................................................................................... 14 Update (PUT)................................................................................................................................................................. 15 Delete (DELETE)............................................................................................................................................................. 16

Error Codes ....................................................................................................................................................................... 21 Possible Error Codes ..................................................................................................................................................... 21

CXCToken .............................................................................................................................................................................. 23 Attributes .......................................................................................................................................................................... 23 Key................................................................................................................................................................................. 23 Fields ............................................................................................................................................................................. 23 Web services ..................................................................................................................................................................... 26 Create (POST) ................................................................................................................................................................ 26 Read (GET)..................................................................................................................................................................... 34 Update (PUT)................................................................................................................................................................. 35 Delete (DELETE)............................................................................................................................................................. 40 Error Codes ....................................................................................................................................................................... 47 Possible Error codes ...................................................................................................................................................... 47

CXCRecipient ......................................................................................................................................................................... 49 Attributes .......................................................................................................................................................................... 49 Key................................................................................................................................................................................. 49 Fields ............................................................................................................................................................................. 49 Web Services..................................................................................................................................................................... 54 Create (POST) ................................................................................................................................................................ 54 Read (GET)..................................................................................................................................................................... 63

3 ? Copyright IBM Corp. 2017,2018

Update (PUT)................................................................................................................................................................. 64 Delete (DELETE)............................................................................................................................................................. 68 Error Codes ....................................................................................................................................................................... 69 Possible Error Codes ..................................................................................................................................................... 69 CXCPayment.......................................................................................................................................................................... 70 Attributes .......................................................................................................................................................................... 70 Key................................................................................................................................................................................. 70 Fields ............................................................................................................................................................................. 70 Web Services..................................................................................................................................................................... 76 Create (POST) ................................................................................................................................................................ 76 Read (GET)................................................................................................................................................................... 104 Update (PUT)............................................................................................................................................................... 105 Error Codes ..................................................................................................................................................................... 106 Possible Error Codes ................................................................................................................................................... 106 Payment Processing Error Codes ................................................................................................................................ 107 CXCPaymentRequest........................................................................................................................................................... 108 Attributes ........................................................................................................................................................................ 108 Key............................................................................................................................................................................... 108 Fields ........................................................................................................................................................................... 108 Web Services................................................................................................................................................................... 111 Create (POST) .............................................................................................................................................................. 111 Read (GET)................................................................................................................................................................... 117 Update (PUT)............................................................................................................................................................... 118 Error Codes ..................................................................................................................................................................... 119 Possible Error Codes ................................................................................................................................................... 119 CXCParticipantView............................................................................................................................................................. 121 Attributes ........................................................................................................................................................................ 121 Fields ........................................................................................................................................................................... 121 Web Services................................................................................................................................................................... 124 Read (GET)................................................................................................................................................................... 124 Error Codes ..................................................................................................................................................................... 127 Possible Error Codes ................................................................................................................................................... 127 CXCTokenView .................................................................................................................................................................... 128 Attributes ........................................................................................................................................................................ 128 Fields ........................................................................................................................................................................... 128

4 ? Copyright IBM Corp. 2017,2018

Web Services................................................................................................................................................................... 129 Read (GET)................................................................................................................................................................... 129

Error Codes ..................................................................................................................................................................... 136 Possible Error Codes ................................................................................................................................................... 136

CXCMultiToken.................................................................................................................................................................... 137 Attributes ........................................................................................................................................................................ 137 Key............................................................................................................................................................................... 137 Fields ........................................................................................................................................................................... 137 Web services ................................................................................................................................................................... 137 Update (PUT)............................................................................................................................................................... 137

CXCMultiRecipient .............................................................................................................................................................. 140 Attributes ........................................................................................................................................................................ 140 Key............................................................................................................................................................................... 140 Fields ........................................................................................................................................................................... 140 Web services ................................................................................................................................................................... 140 Update (PUT)............................................................................................................................................................... 140

CXCPendingPayment........................................................................................................................................................... 144 Attributes ........................................................................................................................................................................ 144 Fields ........................................................................................................................................................................... 144 JSON ................................................................................................................................................................................ 144

CXCPendingPaymentRequest ............................................................................................................................................. 145 Attributes ........................................................................................................................................................................ 145 Fields ........................................................................................................................................................................... 145 JSON ................................................................................................................................................................................ 145

CXCTokenHistory................................................................................................................................................................. 146 Attributes ........................................................................................................................................................................ 146 Fields ........................................................................................................................................................................... 146 JSON ................................................................................................................................................................................ 146

CXCRequestorDetails .......................................................................................................................................................... 147 Attributes ........................................................................................................................................................................ 147 Fields ........................................................................................................................................................................... 147 JSON ................................................................................................................................................................................ 148

CXCTokenData..................................................................................................................................................................... 149 Attributes ........................................................................................................................................................................ 149 Key............................................................................................................................................................................... 149

5 ? Copyright IBM Corp. 2017,2018

Fields ........................................................................................................................................................................... 149 JSON ................................................................................................................................................................................ 152 CXCRecipientData ............................................................................................................................................................... 153 Attributes ........................................................................................................................................................................ 153

Key............................................................................................................................................................................... 153 Fields ........................................................................................................................................................................... 153 JSON ................................................................................................................................................................................ 158 CXCFraudDetectionData ..................................................................................................................................................... 159 Attributes ........................................................................................................................................................................ 159 Fields ........................................................................................................................................................................... 159 JSON ................................................................................................................................................................................ 159 Errors................................................................................................................................................................................... 160 400 Missing Required Field ............................................................................................................................................. 160 400 Invalid Value Specified ............................................................................................................................................. 160 401 Unauthorized ........................................................................................................................................................... 160 403 Forbidden ................................................................................................................................................................. 160 404 Not Found ................................................................................................................................................................ 160 404 Invalid Key ................................................................................................................................................................ 160 500 Internal Server Error ................................................................................................................................................ 161 Custom Errors ................................................................................................................................................................. 161 Query Feature ..................................................................................................................................................................... 168 Parameters...................................................................................................................................................................... 168 _where Parameter .......................................................................................................................................................... 168 Notices ................................................................................................................................................................................ 170 Trademarks ..................................................................................................................................................................... 171 Terms and conditions for product documentation ........................................................................................................ 171 Applicability................................................................................................................................................................. 171 Personal use ................................................................................................................................................................ 171 Commercial use........................................................................................................................................................... 171 Rights........................................................................................................................................................................... 171

6 ? Copyright IBM Corp. 2017,2018

COMMONLY USED FIELDS

Name Description auditSource A 128-byte string that represents the audit source that is logged in the FTM audit log database tables

NOTE: This value is the name of the logged in user or the system component invoking the web service. hostName A 128-byte string that represents the name of the host (or IP address) that is logged in the FTM audit log

database tables NOTE: This value is the IP address or host name from which the request originated. organizationID A 20-byte string used to identify identify an organization participant in the Zelle network. NOTE: While Zelle organization IDs are only 3 characters in length, FTM supports up to 20 characters for organization IDs. participantID A 64-byte string used to uniquely identify a Zelle participant. NOTE: This value corresponds to the ID of the Zelle participant in the Zelle Shared Directory. This value may or may not be the same as the partner ID of the Zelle participant. When possible, it is recommended that the participant ID match the partner ID. partnerID A 20-byte string used to uniquely identify a Zelle participant in FTM. NOTE: This value corresponds to the ID of the Zelle participant in the FTM Shared Directory. This value may or may not be the same as the participant ID of the Zelle participant. When possible, it is recommended that the partner ID match the participant ID. partnerType An integer used to identify the partner type for the Zelle participant in FTM. NOTE: The value "1" represents a CustomerID and is currently the only supported value. paymentID A 12-byte string used to identify Zelle payments. NOTE: When creating a new payment, the paymentID is generated by FTM. paymentProfileID A 255-byte string used to identify a payment profile for a Zelle participant. NOTE: When creating a new token, the paymentProfileID is generated by FTM. token A 255-byte string that is a normalized value containing either the email address or mobile phone number of a Zelle participant. tokenType A single-byte string used to identify the type of token ("E" : "email" or "M" : "mobile").

NOTE: For additional terms, please refer to the Glossary in the most recent version of the Early Warning Services (EWS) Shared Directory specification.

7 ? Copyright IBM Corp. 2017,2018

CXCPARTICIPANT

The CXCParticipant entity represents a Zelle participant. The base URL for this service is ATTRIBUTES

KEY partnerID : partnerType

FIELDS

Name Description

Type

activateIfExists

The activateIfExists attribute is used to re-activate a participant that already exists in the FTM database when invoking the CXCParticipant.Create web service. When set to Y, the CXCParticipant.Create web service does not fail if the participant already exists, but, instead, re-activates the existing participant.

String

NOTE: This attribute only applies to the CXCParticipant.Create web service.

auditSource The auditSource attribute is the name of the logged in user or the system component invoking the web service.

String

NOTE: Any value can be specified by the calling application.

channelType

The channelType attribute is the channel (for example, mobile, web portal, etc.) from which the request originated.

String

NOTE: Any value can be specified by the calling application.

customerType

The customerType attribute represents the system customer type from the FTM CUSTOMER_TYPES table associated with this participant. This attribute may be used in the Risk Global Monitor Limit Change Conditions. The value can be either empty or a valid customer type, and will default blank if not provided.

String

effectiveDate

The effectiveDate attribute represents the date on which the Zelle participant is active. The effective date defaults to immediate. The date should be in ISO 8601 format (for example. 1997-07-

Timestamp

8 ? Copyright IBM Corp. 2017,2018

Filter Sort Len Req

No No 1

No

No No 128 Yes

No No 16

No

No No 1

No

No Yes N/A No

 ................
................

In order to avoid copyright disputes, this page is only a partial summary.

Google Online Preview   Download