Citi Payment Acceptance APIs

Collections and payment acceptance: online payment acceptance, direct debit and e-mandates, PayerID management, Brazil PIX dynamic and due-date collections, and instant direct debit. Citi publishes 10 machine-readable specifications for this family covering 44 operations, served from developer.citi.com.

Documentation Provider Profile APIs.io OpenAPI GitHub

This API exposes 17 operations across 11 paths, organized into 7 resource areas, and defines 76 schemas. It is described by OpenAPI 3.0.0, at version 2.8.1.

Requests are made against 3 base URLs: https://tts.apib2b.citi.com/citiconnect/prod, https://tts.sandbox.apib2b.citi.com/citiconnect/sb, https://tts.sit.apib2b.citi.com/citiconnect/uat.

17 operations 11 paths 76 schemas 5 GET3 PATCH4 POST5 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification

OpenAPI 3.0.0

API Version

2.8.1

Base URL

https://tts.apib2b.citi.com/citiconnect/prod

Authentication

OAuth 2.0

Resource Areas

Authentication & Security 1

Citi Payment Acceptance APIs declares 1 security scheme for authenticating requests. It supports OAuth 2.0 (OAuth2) using the authorizationCode flow, exposing 1 scope.

Paths & Operations 17

Across 11 paths, the API surfaces 17 operations — 5 GET, 3 PATCH, 4 POST, 5 PUT. They span 7 resource areas: Rec, SolicRec, CobR, Pix, Webhook, WebhookRec, WebhookCobR. Each is listed below with its method, path, parameters, and response codes.

Rec 4

Reúne endpoints destinados a lidar com gerenciamento de recorrências.

GET

/digitalpayments/br/v1/rec/{idRec}

Consultar recorrência.

3 params → 200403404503

PATCH

/digitalpayments/br/v1/rec/{idRec}

Revisar recorrência.

2 params body → 200400403404503

GET

/digitalpayments/br/v1/rec

Consultar lista de recorrências.

10 params → 200403503

POST

/digitalpayments/br/v1/rec

Criar recorrência.

1 param body → 201400403503

SolicRec 3

Reúne endpoints destinados a lidar com gerenciamento de solicitações de recorrências.

POST

/digitalpayments/br/v1/solicrec

Criar solicitação de confirmação de recorrência.

1 param body → 201400403404503

GET

/digitalpayments/br/v1/solicrec/{idSolicRec}

Consultar solicitação de confirmação de recorrência.

2 params → 200403404503

PATCH

/digitalpayments/br/v1/solicrec/{idSolicRec}

Revisar solicitação de confirmação de recorrência.

2 params body → 201400403404503

CobR 6

Reúne endpoints destinados a lidar com gerenciamento de cobranças associadas a uma recorrência.

PUT

/digitalpayments/br/v1/cobr/{txid}

Criar cobrança recorrente.

2 params body → 201400403404503

PATCH

/digitalpayments/br/v1/cobr/{txid}

Revisar cobrança recorrente.

2 params body → 200400403404503

GET

/digitalpayments/br/v1/cobr/{txid}

Consultar cobrança recorrente.

2 params → 200403404503

POST

/digitalpayments/br/v1/cobr

Criar cobrança recorrente.

1 param body → 201400403503

GET

/digitalpayments/br/v1/cobr

Consultar lista de cobranças recorrentes.

10 params → 200403503

POST

/digitalpayments/br/v1/cobr/{txid}/retentativa/{data}

Solicitar retentativa de cobrança.

3 params → 201400403404503

Pix 1

reúne endpoints destinados a lidar com gerenciamento de Pix recebidos.

PUT

/digitalpayments/br/v1/pix/{e2eid}/devolucao/{id}

Solicitar devolução.

2 params body → 201400403404503

Webhook 1

Reúne endpoints para gerenciamento de notificações por parte do PSP recebedor ao usuário recebedor.

PUT

/webhook/{chave}

Configurar o Webhook Pix.

1 param body → 200400403404503

WebhookRec 1

Reúne endpoints para gerenciamento de notificações de recorrências por parte do PSP recebedor ao usuário recebedor.

PUT

/webhookrec

Configurar Webhook.

body → 200400403404503

WebhookCobR 1

Reúne endpoints para gerenciamento de notificações de cobranças recorrentes por parte do PSP recebedor ao usuário recebedor.

PUT

/webhookcobr

Configurar Webhook.

body → 200400403404503

Schemas 76

The contract defines 76 schemas that model the data the API accepts and returns. The most detailed are ParametrosConsultaCobR (8 properties), DevolucaoPixAutomatico (8 properties), Pix (8 properties), Devolucao (8 properties). Each schema is shown below with its type and property counts.

TxId

string

Identificador da transação O campo txid determina o identificador da transação. O objetivo desse campo é ser um elemento que possibilite ao PSP do recebedor ap…

EndToEndId

string

EndToEndIdentification que transita na PACS002, PACS004 e PACS008

DevolucaoId

string

Id gerado pelo cliente para representar unicamente uma devolução.

DevolucaoSolicitadaNatureza

string

Indica qual é a natureza da devolução solicitada. Uma solicitação de devolução pelo usuário recebedor pode ser relacionada a um Pix comum (com código: MD06 da…

DevolucaoNaturezaPixAutomatico

string

Indica qual é a natureza da devolução. Uma devolução pode ser relacionada a um Pix comum (com códigos possíveis: MD06 e FR01 da pacs.004 e REFU da pacs.008). N…

PayloadLocationRecId

integer

Identificador da location a ser informada na criação de uma recorrência .

PessoaFisicaRecorrencia

object

2 properties 2 required

PessoaJuridicaRecorrencia

object

2 properties 2 required

CPF

object

1 property 1 required

CNPJ

object

1 property 1 required

DadosComplementaresPessoa

object

4 properties

DadosDevedorRecorrencia

object

1 property

DadosBancarios

object

3 properties 2 required

DadosBancariosRecebedor

object

3 properties 2 required

DadosPagadorRec

object

1 property 1 required

WebhookSolicitado

object

1 property 1 required

WebhookRecBase

object

1 property 1 required

WebhookRecSolicitado

object

WebhookCobRSolicitado

object

1 property 1 required

RecCompleta

object

Atributos de Configuração de Recorrência

2 required

RecCompletaPesquisada

object

Atributos de Configuração de Recorrência

2 required

RecGerada

object

Atributos de Configuração de Recorrência

1 required

RecSolicitada

object

Atributos de Configuração de Recorrência

RecPayload

object

Atributos de Configuração de Recorrência

3 required

RecRevisada

object

Atributos de Revisão da Configuração de Recorrência

RecNotification

object

Atributos de Notificação de Recorrência

3 required

RecAtivacao

object

1 property

RecAtivacaoSolicitada

object

1 property

RecStatus

object

1 property 1 required

RecConfiguracao

object

1 property 1 required

RecAtualizacao

object

1 property 1 required

RecEncerramento

object

1 property

RecId

string

Identificador da Recorrência Regra de formação: - RAxxxxxxxxyyyyMMddkkkkkkkkkkk (29 caracteres; "case sensitive", isso é, diferencia letras maiúsculas e minúsc…

RecBase

object

Atributos de Configuração de Recorrência

3 properties 4 required

SolicRecId

object

Dados criados ou alterados da cobrança recorrente via API Pix

1 property 1 required

SolicRecBase

object

Dados criados ou alterados da cobrança recorrente via API Pix

3 properties 4 required

SolicRecStatus

object

1 property 1 required

SolicRecAtualizacao

object

1 property 1 required

SolicRecSolicitada

object

Dados criados ou alterados da solicitação da recorrência

SolicRecRevisada

object

Dados alterados da solicitação da recorrência

1 property 1 required

SolicRecCompleta

object

Dados criados ou alterados da solicitação da recorrência

1 required

CobRGerada

object

Dados criados ou alterados da cobrança recorrente via API Pix

6 required

CobRCompleta

object

Dados completos da cobrança recorrente via API Pix

6 required

CobRAtualizacao

object

2 properties 1 required

CobRTentativas

object

1 property

CobRRevisada

object

Dados enviados para revisão da cobrança recorrente via API Pix

CobRSolicitada

object

Dados enviados para criação da cobrança recorrente via API Pix

4 required

CobRNotification

object

Dados enviados para criação da cobrança recorrente via API Pix

4 required

CobRConfiguracao

object

1 property 1 required

CobRStatus

object

1 property

CobRStatusRevisada

object

1 property

CobRBase

object

Atributos de cobrança recorrente

5 properties 1 required

ParametrosConsultaCobR

object

Parâmetros utilizados para a realização de uma consulta de cobranças.

8 properties 3 required

CobsRConsultadas

object

2 properties 2 required

PixAutomatico

object

6 properties 4 required

PixValorOriginal

object

1 property

PixValorSaque

object

1 property

PixValorTroco

object

1 property

PixValorJuros

object

1 property

PixValorMulta

object

1 property

PixValorDesconto

object

1 property

PixValorAbatimento

object

1 property

Devolucao

object

8 properties 5 required

DevolucaoNatureza

string

Indica qual é a natureza da devolução. Uma devolução pode ser relacionada a um Pix comum (com códigos possíveis: MD06, BE08 e FR01 da pacs.004 e REFU da pacs.0…

DevolucaoPixAutomatico

object

8 properties 5 required

DevolucaoSolicitada

object

3 properties 1 required

PayloadLocationRecGerada

object

Identificador da localização do payload completo.

3 properties 4 required

PayloadLocationRecCompleta

object

Identificador da localização do payload completo.

ParametrosConsultaRec

object

Parâmetros utilizados para a realização de uma consulta de recorrências.

8 properties 3 required

RecsConsultadas

object

2 properties 2 required

Pix

object

8 properties 3 required

Paginacao

object

4 properties 4 required

Violacao

object

3 properties

Problema

object

6 properties 3 required

Inicio

string

Filtra os registros cuja data de criação seja maior ou igual que a data de início. Respeita RFC 3339.

Fim

string

Filtra os registros cuja data de criação seja menor ou igual que a data de fim. Respeita RFC 3339.

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

#Payments#Collections#Direct Debit

← Back to C APIs

Call it yourself

curl for this page

Search the network for this

curl "https://api.apievangelist.com/v1/search?q=citi-citi-payment-acceptance-apis&limit=10"

Everything under a tag

curl "https://api.apievangelist.com/v1/tags/citi-citi-payment-acceptance-apis"

Discovery needs no key. Full bodies and the synthesis endpoints are Pro.

Where this information came from

This is an independent, third-party profile of Citi Payment Acceptance APIs, 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.

Discovery

Learnings

Guidance

Toolbox

Alignment

API Evangelist LLC

Citi Payment Acceptance APIs

Metadata

Authentication & Security 1

Paths & Operations 17

Schemas 76

Specification

Source

API Details

Provider

Explore more

Work with this as data

MCP tools for apis

Call it yourself

Get an API key