How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Citizens Payments API

The Citizens Payments API initiates RTP and ACH payment instructions, retrieves payment status, and checks whether a counterparty routing number is reachable on The Clearing House RTP network before a payment is sent. Reject codes are ISO 20022 external status reason codes; ACH details carry Nacha standard entry class codes. No cancel, void or reversal operation is published on this surface.

Citizens Payments API is one of 11 APIs that Citizens Financial Group publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include ACH, Banking, ISO 20022, Payments, and Real Time Payments. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

This API exposes 3 operations across 3 paths, and defines 19 schemas. It is described by OpenAPI 3.0.0, at version 3.1.11.

Requests are made against a single base URL, https://apis.citizensbank.com/v3/payments.

3 operations 3 paths 19 schemas 3 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.0
API Version
3.1.11
Base URL
https://apis.citizensbank.com/v3/payments
Authentication
API Key, OAuth 2.0
Resource Areas
1

Authentication & Security 2

Citizens Payments API declares 2 security schemes for authenticating requests. An API key is passed in the header as X-IBM-Client-Id (client-id). It supports OAuth 2.0 (OAuth2) using the clientCredentials flow, exposing 1 scope. By default, every request must be authenticated.

Paths & Operations 3

Across 3 paths, the API surfaces 3 operations — 3 POST. Each is listed below with its method, path, parameters, and response codes.

Operations 3
POST
/participant-status/query
Allows you to retrieve status and basic information of the financial institution based on the routing number and payment type.
checkParticipantStatus 3 params body → 200204400401404500
POST
/initiate-payment
Initiates a payment instruction.
initiatePayment 3 params body → 200400401404500
POST
/payment-status/query
The Payment Status resource retrieves the status of a transaction initiated by the consumer.
retrievePaymentStatus 3 params body → 200204400401404500

Schemas 19

The contract defines 19 schemas that model the data the API accepts and returns. The most detailed are AchDetails (12 properties), PaymentStatusResponse (9 properties), PaymentInitiationRequest (8 properties), ParticipantStatusSummary (7 properties). Each schema is shown below with its type and property counts.

ParticipantStatusQuery
object
2 properties 2 required
ParticipantStatusSummary
object
7 properties 4 required
PaymentInitiationRequest
object
8 properties 5 required
PaymentAccountInformation
object
The client party's account details
2 properties 2 required
CounterpartyAccountInformation
object
Counterparty is the crediting bank for RTP and ACH Credit; or debiting bank for ACH Debit.
2 properties 2 required
Debtor
object
2 properties
UltimateDebtor
object
Ultimate debtor (3rd party) details
3 properties 1 required
UltimateCreditor
object
Ultimate debtor (3rd party) details
3 properties 1 required
CounterpartyAddressInformation
object
Counter Party Details. The address information becomes mandatory for RTP transactions with payment amount greater than or equal to $3000.
3 properties 1 required
CounterpartyInformation
object
Counterparty is the crediting bank for RTP and ACH Credit; or debiting bank for ACH Debit.
2 properties 2 required
RtpDetails
object
This object provides the list of request fields needed to originate a RTP credit transfer. This section is driven by the paymentType. This object becomes manda…
4 properties 1 required
AchDetails
object
This object provides the list of request fields needed to originate an ACH credit/debit transfer. This section is driven by the paymentType. This object become…
12 properties 6 required
PaymentInitiationResponse
object
Response fields of the ACH Credit transfer initiated.
3 properties 3 required
PaymentStatusRequest
object
Request fields of the Payments Response.
2 properties 2 required
PaymentStatusResponse
object
Response fields of the Payments Response.
9 properties 5 required
Address
object
6 properties 3 required
Error
object
3 properties 3 required
Error_errorDetails
object
3 properties 2 required
AuthorizationHeader
string

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

citizens-financial-group-payments-openapi.yml Raw ↑

Other APIs Citizens Financial Group publishes across the network.

Citizens Open Banking API
Citizens Accounts API
Citizens Statements API
Citizens Account Validation API
Citizens Account Transfer API
Citizens Information Reporting API
Citizens Authorize API
Citizens ATM Locator API
Citizens Branch Locator API
Citizens Pay API
Where this information came from

This is an independent, third-party profile of Citizens Payments API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.