GET Api/PaymentAccount/RTPEligibility?routingNumber={routingNumber}
Returns if the routing number is eligible for RTP.
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| routingNumber | string |
Required |
Body Parameters
None.
Response Information
Resource Description
Returns if the routing number is eligible for RTP.
APIPaymentAccountRTPEligibilityResponseModel| Name | Description | Type | Additional information |
|---|---|---|---|
| ErrorCode |
Name of the error condition. See ErrorCode model for details. |
ErrorCode |
None. |
| ErrorCodeDetail |
Detailed error condition code. |
string |
None. |
| ErrorID |
Internal error identification number that uniquely identifies this specific error that occurred. |
string |
None. |
| ErrorNum |
Numeric value of the ErrorCode |
int |
None. |
| Errors |
List of errors that occurred when checking RTP eligibility. |
Collection of string |
None. |
| Result |
On success contains the requested RTP eligibility. See PaymentAccountRTPEligibilityResponseModel for details. |
PaymentAccountRTPEligibilityResponseModel |
None. |
| Success |
Indicates success or failure of the REST request. |
boolean |
None. |
Response Formats
application/json, text/json
Sample:
{
"ErrorCode": "None",
"ErrorCodeDetail": "sample string 1",
"ErrorID": "sample string 2",
"ErrorNum": 0,
"Errors": [
"sample string 1",
"sample string 2"
],
"Result": {
"RTPEligible": true
},
"Success": true
}