openapi: 3.2.0
info:
title: Payment Acceptance API
description: 'Payment Acceptance API
Update - April 28, 2026'
contact:
name: Standards & Developer Hub
url: https://tts.sandbox.developer.citi.com/citiconnect/
email: developer-support@citi.com
version: 1.0.0
servers:
- url: https://tts.apib2b.citi.com/citiconnect/prod
description: production gateway URL
- url: https://tts.sandbox.apib2b.citi.com/citiconnect/sb
description: sbox URL
- url: https://tts.sit.apib2b.citi.com/citiconnect/uat
description: uat URL
tags:
- name: Payment-Acceptance
description: Payment Acceptance API
paths:
/digitalpayments/v1/payment-acceptance/methods:
get:
tags:
- Payment-Acceptance
summary: Payment Method Details
description: Payment method details, merchant enabled payment method during onboarding details.
operationId: getPayment-Method
parameters:
- $ref: '#/components/parameters/Client-Id'
- $ref: '#/components/parameters/Merchant-Id'
security:
- clientCredentials: []
responses:
'200':
description: Payment method
headers:
apim-guid:
schema:
type: string
description: Citi's unique identification for your request
content:
application/json:
schema:
$ref: '#/components/schemas/Payment-Method-Response'
examples:
Payment-Method:
$ref: '#/components/examples/Payment-Method'
'400':
$ref: '#/components/responses/Bad-Get-Request'
'401':
$ref: '#/components/responses/Unauthorized'
'404':
$ref: '#/components/responses/Not-Found'
'405':
$ref: '#/components/responses/Method-Not-Allowed'
'429':
$ref: '#/components/responses/Rate-Limit-Exceeded'
'500':
$ref: '#/components/responses/Internal-Server-Error'
'504':
$ref: '#/components/responses/Gateway-Timeout'
/digitalpayments/v1/payment-acceptance:
post:
tags:
- Payment-Acceptance
summary: Submit A Payment With Selected Payment Method
description: Create a payment
operationId: Payments
parameters:
- $ref: '#/components/parameters/Client-Id'
- $ref: '#/components/parameters/Idempotency-Id'
- $ref: '#/components/parameters/Merchant-Post-Id'
- $ref: '#/components/parameters/Post-Operation'
- $ref: '#/components/parameters/Post-Country-Code'
security:
- clientCredentials: []
requestBody:
description: Payment Initiation
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/Payment-Request'
examples:
Brazil QR Creation Payment Request:
$ref: '#/components/examples/Qrpix-Payment-Request-Example'
US Alipay Payment Request:
$ref: '#/components/examples/US-Alipay-Payment-Request-Example'
US Trustly Payment Request:
$ref: '#/components/examples/US-Trustly-Payment-Request-Example'
US Card Payment Request With Card Details:
$ref: '#/components/examples/US-Card-Payment-Request-Example'
US Card Payment Request With Token Details:
$ref: '#/components/examples/US-Card-Payment-Request-With-Token-Example'
US Card Payment Request With Session Details:
$ref: '#/components/examples/US-Card-Payment-Request-With-Session-Example'
US Card Authorize Request With Card Details:
$ref: '#/components/examples/US-Card-Authorize-Request-With-Card-Example'
US Card Authorize Request With Token Details:
$ref: '#/components/examples/US-Card-Authorize-Request-With-Token-Example'
US Card Authorize Request With Session Details:
$ref: '#/components/examples/US-Card-Authorize-Request-With-Session-Example'
US Card Verify Request With Card Details:
$ref: '#/components/examples/US-Card-Verify-Request-With-Card-Example'
US Card Verify Request With Token Details:
$ref: '#/components/examples/US-Card-Verify-Request-With-Token-Example'
US Card Verify Request With Session Details:
$ref: '#/components/examples/US-Card-Verify-Request-With-Session-Example'
US Card Capture Request:
$ref: '#/components/examples/US-Card-Capture-Request-Example'
US Google Pay Capture Request:
$ref: '#/components/examples/Us-Google-Pay-Capture-Request-Example'
US Google Pay Verify With Card Request:
$ref: '#/components/examples/Us-Google-Pay-Verify-With-Card-Request-Example'
US Google Pay Verify With Session Request:
$ref: '#/components/examples/Us-Google-Pay-Verify-With-Session-Request-Example'
US Google Pay Verify With Token Request:
$ref: '#/components/examples/Us-Google-Pay-Verify-With-Token-Request-Example'
India Card Payment Request With Card Details:
$ref: '#/components/examples/India-Card-Payment-With-Card-Request-Example'
India Card Capture Payment Request:
$ref: '#/components/examples/India-Card-Capture-Payment-Request-Example'
India Card Payment Request With Token Details:
$ref: '#/components/examples/India-Card-Token-Payment-Request-Example'
India Card Authorize Request:
$ref: '#/components/examples/India-Card-Authorize-Request-Example'
India Token Authorize Request:
$ref: '#/components/examples/India-Token-Authorize-Request-Example'
UK PayByBank Payment Request:
$ref: '#/components/examples/Uk-Payment-Request-Example'
US RFP Payment Request:
$ref: '#/components/examples/Us-Rfp-Request-Example'
US ApplePay Payment With Card Request:
$ref: '#/components/examples/US-Apple-Pay-Payment-With-Card-Request-Example'
US ApplePay Payment With Token Request:
$ref: '#/components/examples/US-Apple-Pay-Payment-With-Token-Request-Example'
US ApplePay Payment With Session Request:
$ref: '#/components/examples/US-Apple-Pay-Payment-With-Session-Request-Example'
US ApplePay Authorize With Card Request:
$ref: '#/components/examples/US-Apple-Pay-Authorize-With-Card-Request-Example'
US ApplePay Authorize With Token Request:
$ref: '#/components/examples/US-Apple-Pay-Authorize-With-Token-Request-Example'
US ApplePay Authorize With Session Request:
$ref: '#/components/examples/US-Apple-Pay-Authorize-With-Session-Request-Example'
US Apple Pay Capture Request:
$ref: '#/components/examples/Us-Apple-Pay-Capture-Request-Example'
US Apple Pay Verify With Card Request:
$ref: '#/components/examples/Us-Apple-Pay-Verify-With-Card-Request-Example'
US Apple Pay Verify With Token Request:
$ref: '#/components/examples/Us-Apple-Pay-Verify-With-Token-Request-Example'
US Apple Pay Verify With Session Request:
$ref: '#/components/examples/Us-Apple-Pay-Verify-With-Session-Request-Example'
US GooglePay Payment Request With Card:
$ref: '#/components/examples/Us-Google-Pay-Payment-Request-With-Card-Example'
US GooglePay Payment Request With Token:
$ref: '#/components/examples/Us-Google-Pay-Payment-Request-With-Token-Example'
US GooglePay Payment Request With Session:
$ref: '#/components/examples/Us-Google-Pay-Payment-Request-With-Session-Example'
US GooglePay Authorize Request With Card:
$ref: '#/components/examples/Us-Google-Pay-Authorize-Request-With-Card-Example'
US GooglePay Authorize Request With Session:
$ref: '#/components/examples/Us-Google-Pay-Authorize-Request-With-Session-Example'
US GooglePay Authorize Request With Token:
$ref: '#/components/examples/Us-Google-Pay-Authorize-Request-With-Token-Example'
US Paypal Payment Request:
$ref: '#/components/examples/US-Paypal-Payment-Request-Example'
US Paypal Authorize Request:
$ref: '#/components/examples/Us-Paypal-Authorize-Request-Example'
US Paypal Capture Request:
$ref: '#/components/examples/Us-Paypal-Capture-Request-Example'
US ACH DirectDebit Payment Request CCD/PPD/WEB:
$ref: '#/components/examples/Us-Ach-Direct-Debit-CCD-PPD-WEB-Request-Example'
US ACH DirectDebit Payment Request IAT:
$ref: '#/components/examples/Us-Ach-Direct-Debit-IAT-Request-Example'
Brazil PIX Initiation Request:
$ref: '#/components/examples/Brazil-PIX-Initiation-Request-Example'
US ACH Payment Request:
$ref: '#/components/examples/US-Ach-Pay-Payment-Request-Example'
callbacks:
payment-qr-created:
$ref: '#/components/callbacks/Payment-Created-Status'
payment-qr-failed:
$ref: '#/components/callbacks/Payment-Failed-Status-Notification'
payment-settled:
$ref: '#/components/callbacks/Payment-Success-Status-Notification'
payment-authorize-success:
$ref: '#/components/callbacks/payment-Authorize-Success'
payment-authorize-failed:
$ref: '#/components/callbacks/payment-Authorize-Failed'
payment-capture-success:
$ref: '#/components/callbacks/Payment-Capture-Success'
payment-capture-failed:
$ref: '#/components/callbacks/Payment-Capture-Failed'
payment-failed:
$ref: '#/components/callbacks/Payment-Failed'
payment-rfp-failed:
$ref: '#/components/callbacks/Payment-Rfp-Failed'
payment-rfp-success:
$ref: '#/components/callbacks/Payment-Rfp-Success'
responses:
'200':
description: OK
headers:
apim-guid:
schema:
type: string
description: Citi's unique identification for your request
Merchant-Id:
schema:
type: string
description: The unique identifier issued to you by your payment provider
content:
application/json:
schema:
$ref: '#/components/schemas/Payment-Notification'
examples:
USCardPaymentResponse:
$ref: '#/components/examples/Card-Payment-Response-Example'
IndiaCardPaymentResponse:
$ref: '#/components/examples/India-Card-Payment-Response-Example'
USGooglepayPaymentResponse:
$ref: '#/components/examples/Googlepay-Payment-Response-Example'
USApplepayPaymentResponse:
$ref: '#/components/examples/Applepay-Payment-Response-Example'
USPaypalPaymentResponse:
$ref: '#/components/examples/Paypal-Payment-Response-Example'
Payment-Uk-Link-Failed-Response:
$ref: '#/components/examples/Payment-Uk-Link-Failed-Notification'
Payment-Uk-Link-Success-Response:
$ref: '#/components/examples/Payment-Uk-Link-Sucess-Notification'
USAlipay-Link-Success-Response:
$ref: '#/components/examples/Alipay-Link-Sucess-Notification'
USTrustly-Link-Success-Response:
$ref: '#/components/examples/Trustly-Link-Sucess-Notification'
'202':
$ref: '#/components/responses/Accepted'
'400':
$ref: '#/components/responses/Bad-Request'
'401':
$ref: '#/components/responses/Unauthorized'
'404':
$ref: '#/components/responses/Not-Found'
'405':
$ref: '#/components/responses/Method-Not-Allowed'
'409':
$ref: '#/components/responses/Conflict'
'415':
$ref: '#/components/responses/Unsupported-Media-Type'
'429':
$ref: '#/components/responses/Rate-Limit-Exceeded'
'500':
$ref: '#/components/responses/Internal-Server-Error'
'504':
$ref: '#/components/responses/Gateway-Timeout'
get:
tags:
- Payment-Acceptance
summary: Get Transaction Details
description: Receive transaction status of the transaction for last 90 days using transaction ID provided during transaction creation or transaction end-to-end-id received in incoming credit notification.
operationId: getpaymentstatus
parameters:
- $ref: '#/components/parameters/Client-Id'
- $ref: '#/components/parameters/Get-Payment-End-To-End-Id'
- $ref: '#/components/parameters/Type'
- $ref: '#/components/parameters/Post-Country-Code'
security:
- clientCredentials: []
responses:
'200':
description: Payment status
headers:
apim-guid:
schema:
type: string
description: Citi's unique identification for your request
result:
schema:
type: integer
minimum: 1
maximum: 1000
default: 100
description: Number of transaction status matching your request
content:
application/json:
schema:
$ref: '#/components/schemas/Payments-Response'
examples:
Brazil-Qr-Created-Status:
$ref: '#/components/examples/Qr-Created-Status'
Brazil-Qr-Pending-Status:
$ref: '#/components/examples/Qr-Pending-Status'
Brazil-Qr-Cancelled-Status:
$ref: '#/components/examples/Qr-Cancelled-Status'
Brazil-Qr-Failed-Status:
$ref: '#/components/examples/Qr-Failed-Status'
Brazil-Qr-Settled-Status:
$ref: '#/components/examples/Qr-Settled-Status'
India-Upi-Settled-Status:
$ref: '#/components/examples/Payment-Success-Upi-Status'
Brazil-Incoming-Credit-Settled-Status:
$ref: '#/components/examples/Payment-Success-Incoming-Brazil-PIX-Credit-Status-Notification'
Brazil-Incoming-Credit-Failed-Status:
$ref: '#/components/examples/Payment-Failed-Incoming-Brazil-PIX-Credit-Status-Notification'
UK-Pending-Status:
$ref: '#/components/examples/Uk-Pending-Status'
UK-Failed-Status:
$ref: '#/components/examples/Uk-Failed-Status'
UK-Settled-Status:
$ref: '#/components/examples/Uk-Settled-Status'
US-RFP-Reject-Status:
$ref: '#/components/examples/Us-Rfp-Reject-Status-Example'
US-RFP-Success-Status:
$ref: '#/components/examples/Us-Rfp-Success-Status-Example'
Payment-Success-US-RFP-Status:
$ref: '#/components/examples/Payment-Success-Us-Rfp-Status'
US-ACH-Direct-Debit-Status:
$ref: '#/components/examples/ACH-Direct-Debit-Status'
US-Wire-Status:
$ref: '#/components/examples/US-Wire-Status'
US-ACH-Status:
$ref: '#/components/examples/US-ACH-Status'
Brazil-PIX-Status:
$ref: '#/components/examples/BR-PIX-Status'
India-Card-Status:
$ref: '#/components/examples/India-Card-Status'
US-Card-Status:
$ref: '#/components/examples/Us-Card-Status'
US-Googlepay-Card-Status:
$ref: '#/components/examples/Us-Googlepay-Status'
US-Applepay-Card-Status:
$ref: '#/components/examples/Us-Applepay-Status'
US-Paypal-Card-Status:
$ref: '#/components/examples/Us-Paypal-Status'
India-IMPS-Status:
$ref: '#/components/examples/India-IMPS-Status'
Thailand-IP-Status:
$ref: '#/components/examples/Thailand-IP-Status'
Australia-IP-Status:
$ref: '#/components/examples/Australia-IP-Status'
'400':
$ref: '#/components/responses/Bad-Get-Request2'
'401':
$ref: '#/components/responses/Unauthorized'
'404':
$ref: '#/components/responses/Not-Found'
'405':
$ref: '#/components/responses/Method-Not-Allowed'
'429':
$ref: '#/components/responses/Rate-Limit-Exceeded'
'500':
$ref: '#/components/responses/Internal-Server-Error'
'504':
$ref: '#/components/responses/Gateway-Timeout'
/digitalpayments/v1/payment-acceptance/{id}:
patch:
tags:
- Payment-Acceptance
summary: Update a payment with selected payment method
description: Update a payment.
operationId: collectionUpdate
parameters:
- $ref: '#/components/parameters/Idempotency-Id'
- $ref: '#/components/parameters/Client-Id'
- $ref: '#/components/parameters/Id'
- $ref: '#/components/parameters/Merchant-Post-Id'
- $ref: '#/components/parameters/Patch-Operation'
requestBody:
description: Update a payment with selected payment method.
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/Payment-Update-Request'
examples:
Brazil QR PIX Update Payment:
$ref: '#/components/examples/Qrpix-Payment-Update-Request-Example'
Brazil QR PIX Cancel Payment:
$ref: '#/components/examples/Qrpix-Payment-Cancel-Request-Example'
US Card Payment Request:
$ref: '#/components/examples/US-Card-Payment-Update-Request-Example'
US Card Update Authorize Request:
$ref: '#/components/examples/US-Card-Authorize-Update-Request-Example'
US Card Cancel Request:
$ref: '#/components/examples/US-Card-Cancel-Request-Example'
India Card Cancel Payment Request:
$ref: '#/components/examples/India-Card-Cancel-Payment-Request-Example'
Brazil PIX Cancellation Request:
$ref: '#/components/examples/Brazil-PIX-Cancellation-Request-Example'
US Paypal Payment Confirm Request:
$ref: '#/components/examples/Paypal-Payment-Confirm-Request-Example'
US Paypal Authorize Confirm Request:
$ref: '#/components/examples/Paypal-Authorize-Confirm-Request-Example'
US Paypal Update Authorize Request:
$ref: '#/components/examples/Us-Paypal-Update-Authorize-Request-Example'
US Paypal Cancel Request:
$ref: '#/components/examples/Us-Paypal-Cancel-Request-Example'
US GooglePay Update Authorize Request:
$ref: '#/components/examples/Us-Google-Pay-Update-Authorize-Request-Example'
US GooglePay Cancel Request:
$ref: '#/components/examples/Us-Google-Pay-Cancel-Request-Example'
US ApplePay Update Authorize Request:
$ref: '#/components/examples/Us-Apple-Pay-Update-Authorize-Request-Example'
US ApplePay Cancel Request:
$ref: '#/components/examples/Us-Apple-Pay-Cancel-Request-Example'
security:
- clientCredentials: []
callbacks:
payment-qr-modified:
$ref: '#/components/callbacks/Payment-Created-Status'
payment-qr-cancelled:
$ref: '#/components/callbacks/Payment-Cancelled-Status'
payment-cancel-success:
$ref: '#/components/callbacks/Payment-Cancel-Success'
payment-cancel-failed:
$ref: '#/components/callbacks/Payment-Cancel-Failed'
responses:
'200':
description: Okay
headers:
apim-guid:
schema:
type: string
description: Citi's unique identification for your request
Merchant-Id:
schema:
type: string
description: The unique identifier issued to you by your payment provider
content:
application/json:
schema:
$ref: '#/components/schemas/Payment-Notification'
'202':
$ref: '#/components/responses/Accepted'
'400':
$ref: '#/components/responses/Bad-Request'
'401':
$ref: '#/components/responses/Unauthorized'
'404':
$ref: '#/components/responses/Not-Found'
'405':
$ref: '#/components/responses/Method-Not-Allowed'
'409':
$ref: '#/components/responses/Conflict'
'415':
$ref: '#/components/responses/Unsupported-Media-Type'
'429':
$ref: '#/components/responses/Rate-Limit-Exceeded'
'500':
$ref: '#/components/responses/Internal-Server-Error'
'504':
$ref: '#/components/responses/Gateway-Timeout'
components:
examples:
Method-Not-Allowed-Example:
value:
ref_id: ec689822-9864-4c4d-9d68-222467627902
error_details:
- issue: HTTP method is not supported
action: Provide valid HTTP method
code: CC00001
US-Apple-Pay-Payment-With-Token-Request-Example:
value:
customer:
id: '11225367999'
method:
type: APPLEPAY
token_id: ' 5613dc38-ba17-446c-8c18-ae89f79de596'
token_type: CITI_TOKEN
card:
cvv: '567'
transaction:
id: card1234567
currency_code: USD
country_code: US
order:
id: order0000001
amount: 323
currency_code: USD
Payment-Success-Upi-Status:
value:
- customer:
account:
proxy_id: raja@citi.com
bank_id: CITIIN77
type: SAVINGS
number: '1122334455'
name:
first_name: PETER
address:
lines:
- '#45, Block 12'
- Federal Street
building_number: '20'
city: Abis Brasil
postal_code: 69935-000
state: san francisco
country_code: IN
merchant:
name: JOHN
account:
proxy_id: vinu@citi.com
bank_id: CITIIN33
number: '8899775544'
address:
lines:
- '#45, Block 12'
- Federal Street
building_number: '20'
city: Abis Brasil
postal_code: 69935-000
state: san francisco
country_code: IN
method:
type: UPI
upi:
initiation_type: UPI QR Code
transaction:
end_to_end_id: r434SKtUcdGQ
reference: NPCI123456789
amount: 100
uetr: 4f09214d-296c-494b-8e9c-810bf1d9fc93
network_id: clr02052023478
batch_id: batch12345
value_date: '2022-09-07'
creation_date_time: '2022-09-13T08:23:49.112Z'
currency_code: INR
status: SETTLED
description: Transaction settled
remittance_info:
- PURCHASED APPLE LAPTOP
- PURCHASED ADDITIONAL SOFTWARE
- customer:
account:
proxy_id: raja@citi.com
bank_id: CITIIN77
type: SAVINGS
number: '1122334455'
name:
first_name: PETER
address:
lines:
- '#45, Block 12'
- Federal Street
building_number: '20'
city: Abis Brasil
postal_code: 69935-000
state: san francisco
country_code: IN
merchant:
name: JOHN
account:
proxy_id: vinu@citi.com
bank_id: CITIIN33
number: '8899775544'
address:
lines:
- '#45, Block 12'
- Federal Street
building_number: '20'
city: Abis Brasil
postal_code: 69935-000
state: san francisco
country_code: IN
method:
type: UPI
upi:
initiation_type: UPI QR Code
transaction:
end_to_end_id: r434SKtUcdGQ
reference: NPCI123456789
amount: 700
uetr: 4f09214d-296c-494b-8e9c-810bf1d9fc93
network_id: clr02052023478
batch_id: batch12345
value_date: '2022-09-07'
creation_date_time: '2022-09-13T08:23:49.112Z'
currency_code: INR
status: SETTLED
description: Transaction settled
remittance_info:
- PURCHASED APPLE LAPTOP
- PURCHASED ADDITIONAL SOFTWARE
ACH-Direct-Debit-Status:
value:
- method:
type: ACH
ach:
sec_code: CCD
transaction:
country_code: US
id: e2e1234567890
value_date: '2024-05-01'
amount: 500
currency_code: USD
remittance_info:
- This is sample
reference: Request Initiated
customer:
account:
number: '89770098'
bank_id: ABC123456
bank_name: CITI
bank_country_code: US
type: SAVINGS
name:
first_name: Karl
address:
street_name: 1212 4th Street
building_number: A6378
city: San Francisco
state: CA
postal_code: '70989'
country_code: US
lines:
- Building number 123* Wall Street\
- Kingston* New York\
- US* 12401\
merchant:
account:
number: '900900981'
bank_id: '123456789'
bank_name: CITI
bank_country_code: US
name: Yokal
organization_id: AS2345
tax_id: 1.020.340/8910-22
address:
street_name: 1212 7th Street
building_number: V7839
postal_code: '50098'
city: New York
state: CA
country_code: US
lines:
- Building number 123* Wall Street\
- Kingston* New York\
- US* 12401\
receiver:
name: Brent
organization_id: AS1234
address:
street_name: 1345 4th Street
building_number: B5829
postal_code: '89934'
city: Las Vegas
state: CA
country_code: US
lines:
- Building number 123* Wall Street\
- Kingston* New York\
- US* 12401\
sender:
name: John
address:
street_name: 5678 7th Street
building_number: A5678
postal_code: 08989
city: Jersey City
state: NJ
country_code: US
lines:
- Building number 123* Wall Street\
- Kingston* New York\
- US* 12401\
Us-Paypal-Update-Authorize-Request-Example:
value:
method:
type: PAYPAL
transaction:
id: REFUNDID12345
country_code: US
amount: 100
currency_code: USD
order:
id: ccapigpaytestmk1771318960
Googlepay-Payment-Response-Example:
value:
order:
amount: 200
currency_code: USD
merchant_amount: 200
merchant_currency: USD
status: AUTHORIZED
total_auth_amount: 100
total_captured_amount: 0
total_disbursed_amount: 0
total_refunded_amount: 0
id: TX0250117002
creation_time: '2025-01-17T13:10:23.973Z'
update_time: '2025-01-17T13:10:24.351Z'
transaction:
authorizationResponse:
posEntryMode: '812'
returnAci: '8'
stan: '144032'
transactionIdentifier: '123456789012345'
commercialCardIndicator: '3'
posData: '1025104006600'
processingCode: '003000'
responseCode: '00'
acquirer:
transaction_id: '123456789012345'
batch: '20250117'
date: '0117'
merchant_id: '120240306011001'
type: AUTHORIZATION
terminal: 0791
response:
acquirer_code: '00'
acquirer_message: Approved
id: ORD_20250117_002
amount: 100
currency_code: USD
status: SUCCESS
description: APPROVED
creation_date_time: '2025-01-17T13:10:24.019Z'
update_time: '2025-01-17T13:10:24.351Z'
receipt: '501713144032'
authorization_code: '144032'
method:
CARD:
number: 401200xxxxxx0026
expiry_month: '1'
expiry_year: '39'
fundingMethod: CREDIT
stored_on_file: NOT_STORED
Us-Google-Pay-Payment-Request-With-Session-Example:
value:
customer:
id: '11225367999'
method:
type: GOOGLEPAY
session_id: ad44b8bb-07ee-4a2c-ae84-3203d2e332af
transaction:
id: card1234567
currency_code: USD
country_code: US
order:
id: order0000001
amount: 323
currency_code: USD
US-Apple-Pay-Payment-With-Card-Request-Example:
value:
customer:
id: '11225367999'
method:
type: APPLEPAY
card:
number: '4320445566778907'
expiry_month: '12'
expiry_year: '24'
cvv: '567'
transaction:
id: card1234567
currency_code: USD
country_code: US
order:
id: order0000001
amount: 323
currency_code: USD
Payment-Success-Brazil-PIX-Credit-Status-Notification:
value:
method:
type: PIX
customer:
account:
number: '97150300543944526009'
bank_id: CITIBRXXX
name: Jack
tax_id: TAX123
name:
first_name: Jack
merchant:
account:
number: '62080300543944526226'
bank_id: '33479023'
name: Kingston
name: Kingston
tax_id: TAX234
transaction:
id: RTP99625446991261440318900
uetr: 4f09214d-296c-494b-8e9c-810bf1d9fc93
creation_date_time: '2024-09-13T08:23:49.114Z'
country_code: BR
currency_code: BRL
value_date: '2025-03-10'
amount: 800.21
status: SETTLED
reason_code: ABCD
description: Transaction Settled
status_date_time: '2024-05-26T08:20:49.114Z'
holiday_flag: true
mandate:
id: RR3347902320251109BRF12345678
Qrpix-Payment-Update-Request-Example:
value:
customer:
type: BUSINESS
method:
type: PIX
transaction:
id: r434SKtUcdGQ12345678901234
country_code: BR
currency_code: BRL
amount: 202
Payment-Success-Uk-Paybybank-Status-Notification:
value:
customer:
name:
first_name: PETER
address:
lines:
- '#45, Block 12'
- Federal Street
country_code: GB
sender:
name: RANJITH
address:
lines:
- '#45, Block 12'
- Federal Street
street_name: JOHN PETER STREET
building_number: '20'
city: Abis Brasil
postal_code: 69935-000
state: san francisco
country_code: GB
organization_id: '23456789'
birth_date: '2022-09-07'
birth_city: UNITED
birth_country: UK
merchant:
name: JOHN
account:
bank_id: '776889'
number: '8899775544'
address:
lines:
- '#45, Block 12'
- Federal Street
country_code: GB
receiver:
name: MADAN
address:
lines:
- '#45, Block 12'
- Federal Street
street_name: JOHN PETER STREET
building_number: '20'
city: Abis Brasil
postal_code: 69935-000
state: san francisco
country_code: GB
organization_id: '23456789'
method:
type: FPS
transaction:
end_to_end_id: r434SKtUcdGQ
id: TYF5678954
amount: 100
country_code: GB
uetr: 4f09214d-296c-494b-8e9c-810bf1d9fc93
network_id: clr02052023478
batch_id: batch12345
value_date: '2022-09-07'
creation_date_time: '2022-09-13T08:23:49.112Z'
currency_code: GBP
additional_info: LOAN REPAYMENT
status: SETTLED
description: Transaction settled
remittance_info:
- PURCHASED APPLE LAPTOP
- PURCHASED ADDITIONAL
Qr-Settled-Status:
value:
- customer:
id: 8415678edrf
type: BUSINESS
name:
first_name: JOHN
last_name: PETER
merchant:
tax_id: 8.020.340/8910-44
method:
type: PIX
pix:
tax_id: 1.020.340/8910-22
transaction:
id: abcedgh8742323
expiry_time: 2500
creation_date_time: '2022-09-13T08:23:49.112Z'
amount: 305
update_flag: Y
update_count: 0
qr_image: Y
status: SETTLED
description: Transaction settled
qr_byte_code: iVBORw0KGgoAAAANSUhEUgAAAMgAAADICAYAAACtWK6eAAAYV0lEQVR4Xu3T26osu3JF0f3/P21jmMKmQa+QKlWbg8kO8TAuEaWci/XPf728vCT/aLy8vPwv73+Ql5cPvP9BXl4+8P4HeXn5wPsf5OXlA+9/kJeXD7z/QV5ePvD+B3l5+cD7H+Tl5QPvf5CXlw+8/0FeXj7w/gd5efnA+x/k5eUD73+Ql5cPvP9BXl4+8P4HeXn5wPsf5OXlA+9/kJeXD1z9D/LPP/98NdP+lNuzX1qme4spX9gr7VQu5lNP7VQu5lNPyhfv785Nrl7zobsz7U+5PfulZbq3mPKFvdJO5WI+9dRO5WI+9aR88f7u3OTqtdMH2p/0RPX1S+ubT1rffBf7dV+/8l2qrz/pwp7vrnyX0/4OV6+dPtD+pCeqr19a33zS+ua72K/7+pXvUn39SRf2fHflu5z2d7h6zQf64ZUXlU/3Jt/ZpfYmX61vLrWnfurXVG+X2vtWO+Y3uXrNB/ohlReVT/cm39ml9iZfrW8utad+6tdUb5fa+1Y75je5es0H+iGVly5frV8zUf3SNcXUM7enlikvas93VO9bvLerHfObXL3mA/2QykuXr9avmah+6Zpi6pnbU8uUF7XnO6r3Ld7b1Y75Ta5e84F+SOVSvnh3d57u1xSVn/oTvmca90qX7z2nmPKFPe9XfpOr13ygH1K5lC/e3Z2n+zVF5af+hO+Zxr3S5XvPKaZ8Yc/7ld/k6rXTB1a//MI/mPulawpz96aZqH7p8ovdvKYwL61vLuUXp/0drl47fWD1yy/8B3C/dE1h7t40E9UvXX6xm9cU5qX1zaX84rS/w9Vr/iF2x/1Xv/r/6tO5ydVrPnR33H/1q/+vPp2b3L32ED/UEf1Jlz/9zsK89krXSOX6lRe1N+WlHfNdTvv/Jv9Rr/IP7oj+pMuffmdhXnula6Ry/cqL2pvy0o75Lqf9f5Orr/JDpz+gI/pqme4t7J2Od3a1vrm+U73yT2e6M+X27J9Se/rT7z/h6jUfWA/XN7dXWqZ7C3un451drW+u71Sv/NOZ7ky5Pfun1J7+9PtPuHvtDx+qFnM/2LEn+qdapnyXulP+YsoX9pbWNy/ct1+++S72T++rb3D32h8+VC3m/mEce6J/qmXKd6k75S+mfGFvaX3zwn375ZvvYv/0vvoGd69BPbg+XC3uOfbUk1+52HeqV37NLrv96f7kVy5Tz3tOUT31TX5z9Y96+Lcf6p5jTz35lYt9p3rl1+yy25/uT37lMvW85xTVU9/k6lU/wIer9Z1d7JeusVe4Z19d7PYmfIcj+qf6W7/wvY6U/0uu/pof6Aep9Z1d7JeusVe4Z19d7PYmfIcj+qf6W7/wvY6U/0uu/pof6Aed6vJ3tX7ljuirpfLyT/GOepfTvW/77u36zsRu74Sr1/wgH3yqy9/V+pU7oq+Wyss/xTvqXU73vu27t+s7E7u9E65eu/1A75XWl+rpO1PvNJfJNy+tby6Tb17aMZddX134+7t7J1y9dvuB3iutL9XTd6beaS6Tb15a31wm37y0Yy67vrrw93f3Trh77Q8fWrqmeqI/6cKevzvNr/F31JO/mHKxrxbzpctXO/8J/OQVfmDpmuqJ/qQLe/7uNL/G31FP/mLKxb5azJcuX+38J3D1FX7gNNNe5aJ/S+uLeWlnyqv3Le6X1hfz3b3F1Ku8fmfSN7h6zQ+ZZtqrXPRvaX0xL+1MefW+xf3S+mK+u7eYepXX70z6Blev1QMnv/KFuXvm9k61fuXVm3C/7uiX1jeXya+xp3ZOcd87p/4Nrl6rB05+5Qtz98ztnWr9yqs34X7d0S+tby6TX2NP7ZzivndO/RtcveZDTx9ce6e++UTd0TefqP63fk1hXtoRc3vlT7m6uN074eo1/xCnD669U998ou7om09U/1u/pjAv7Yi5vfKnXF3c7p1w9druH2K3V0z7+jLlhfcde1J+Ufcn7Ktv+WqZ3l++VE9ffYOr1+oPUrr8iWlfX6a88L5jT8ov6v6EffUtXy3T+8uX6umrb3D12vQHKdyrfX21fs23vV0tleurxby0/pSrxfxb7VSuL6f+E65eqw+dcK/29dX6Nd/2drVUrq8W89L6U64W82+1U7m+nPpPuHsNpg93ptyxL/Z3Z9qvXCbfMZ90+RO7vcL9eo/5hL1JT/4NfnP1j/rD6e/mjn2xvzvTfuUy+Y75pMuf2O0V7td7zCfsTXryb3D1av2hyjdXTyPli73p7sKeI/ql9c2L3dzerm9ePf3Sp75apvwGV69Pfzh9c/U0Ur7Ym+4u7DmiX1rfvNjN7e365tXTL33qq2XKb/DT6/4h/SD90/HOri5/uu9ULuUvzEtPfuW7VF9/0kX1ypfVs1/+De5eAx/uB+ifjnd2dfnTfadyKX9hXnryK9+l+vqTLqpXvqye/fJvcPXa9NDy5fSO/Wncm/Q0U9+8cK/GvlrfXNyrsS/lL8zV+lP+b3D1V2592Okd+9O4N+lppr554V6NfbW+ubhXY1/KX5ir9af83+Dqr/hwP3R33Fc7om/f2e05056Uv9jN7elPI5PvyGl+2judm1y95gN9+O64r3ZE376z23OmPSl/sZvb059GJt+R0/y0dzo3uXrNh/pgtbjnVE9/V+tXvrDnTD2Z/MqLqT/dnXKxN+1XXr7s9m5y9Vf8AD9ELe451dPf1fqVL+w5U08mv/Ji6k93p1zsTfuVly+7vZv8K79SH1a6fPXuuKd2zNX6E/bV5Z/+nr1Jl3/6u4tpr/yF+aQn/wa/uQr1hytdvnp33FM75mr9Cfvq8k9/z96kyz/93cW0V/7CfNKTf4OfXPXB0x9uUfmury7qPWpxb+oX7ql3cU8t5uqJ+m51+bVvXpirf8FPrvvw6Q+zqHzXVxf1HrW4N/UL99S7uKcWc/VEfbe6/No3L8zVv+DqdR/sH2R33FfXVE/MT0d281Pcq9/Rn8Y99a4vU0/f/ulI+U+4es0H+kG74766pnpifjqym5/iXv2O/jTuqXd9mXr69k9Hyn/C1Wu7D6yef4CaYsrFvrr8Xa1vLvpqfXO1VO696i3sTf2F/dqbcjntn3D12u4Dq+eH1hRTLvbV5e9qfXPRV+ubq6Vy71VvYW/qL+zX3pTLaf+Eq9emh+rbd6T8wnvul9Y3F/26U775pPWLqV/5pCd/YT5pfUfMq/eEq9emh+rbd6T8wnvul9Y3F/26U775pPWLqV/5pCd/YT5pfUfMq/eEu9cCHz7p8v1D1ExUXz1Rd05z9a5vLuUv6u6kT/36HfNd7E/3n3D3WuDDJ12+f4iaieqrJ+rOaa7e9c2l/EXdnfSpX79jvov96f4T7l77ox6qr97FvfoD7fqOmDv2Spc/3dM3l9M99YT9+j31LrWn7++a3+DutT/qofrqXdyrP9Cu74i5Y690+dM9fXM53VNP2K/fU+9Se/r+rvkNrl779oH1gZMu33uOPXX5Uv2ieuUX0+/qT1rqvrqofXO1fmF/d+8brl799qH1oZMu33uOPXX5Uv2ieuUX0+/qT1rqvrqofXO1fmF/d+8brl7dfagf5shp7siu7x1H9Kt/6ldur/wp3/UrL8zV+pUvqlf+Da5e232gH+TIae7Iru8dR/Srf+pXbq/8Kd/1Ky/M1fqVL6pX/g2uXvOhuw+eet6zP/ky+TVi7hTV03emnrmUvzBXP/VrxNyRKX/C1Ws+dPfBU8979idfJr9GzJ2ievrO1DOX8hfm6qd+jZg7MuVPuHrNh/rgUy3eta+W2hN7u/1vtb65vmNPrW8up/7C/Kme/MWUP+Hq1fVQx3xXi3ftq6X2xN5u/1utb67v2FPrm8upvzB/qid/MeVPuHrVh6onf2G+9Lf+aX7KtF+/U1pfpnxR98oXc3X5ajGftFRe/hOuXvOB6slfmC/9rX+anzLt1++U1pcpX9S98sVcXb5azCctlZf/hLvXgvVwP6D8onqTv5tPvVO869ibcN8RffUtf3qH7PbN1fqVP+HutaA+oPyiepO/m0+9U7zr2Jtw3xF99S1/eofs9s3V+pU/4e61P3ywD9/VzpQ7E/Zqv3yxZ19/d2TyzXd1jb3S+o65lF/YV9/g7rU//MP48F3tTLkzYa/2yxd79vV3RybffFfX2Cut75hL+YV99Q2uXqsHTn7li9NcLfW75e/mC/NdXWNPTvsL96aRytW/9tU3uXq1Hjr5lS9Oc7XU75a/my/Md3WNPTntL9ybRipX/9pX3+TqVR+6tCP6ky7sqcv3fY6UL9WbfHO1vvmk9R1zdflF5eWfUu+6wdVrPtCHm9vb1YU9dfm+z5HypXqTb67WN5+0vmOuLr+ovPxT6l03uHvtj+nB3+bqXd/5Fu/UvVNfvO/eri5/0s4uu3vm7pkXu70n/OT69KHf5upd3/kW79S9U1+8796uLn/Szi67e+bumRe7vSf89npQH1Z/oNLObm5PXb7ou+/Ym6he3T3NxT1Hyi+8N+1PuZz2d7h7bZP6kPrDlXZ2c3vq8kXffcfeRPXq7mku7jlSfuG9aX/K5bS/w91rf0wP9Q/kVE+/9FOme/Wuwl7tn+ryvW++2yutX0z9b/3Kf8FPfmX6AD/UqZ5+6adM9+pdhb3aP9Xle998t1dav5j63/qV/4Krv1IP15/0LtMfTF+tX/m3eHca9ybcr70pL+yrn/rmpfXNS9/g6rV6oP6kd7n1B5zufIt3p3Fvwv3am/LCvvqpb15a37z0De5e+8OHqvUrL+zXHf3KRb/25TRXl//t76t3/ZrqSfmFfe9XLuU/4e61P3yoWr/ywn7d0a9c9GtfTnN1+d/+vnrXr6melF/Y937lUv4Trl57+kD3T/Uua6/2zaee1N6kC3ver/xb/SvfXC1TvtjtfcPVq08f6v6p3mXt1b751JPam3Rhz/uVf6t/5ZurZcoXu71v+M3VP/zD7I6UX1Rfv/Q0xdTT3+3XiPk0xZQvvOeeesI7NfZ/yU+v+2G7I+UX1dcvPU0x9fR3+zViPk0x5Qvvuaee8E6N/V9y9bofUlOYT7qwN/3+lC8qn/bLL6o/+ZUvpryoPX936k1aX+xN/Rtcve7DawrzSRf2pt+f8kXl0375RfUnv/LFlBe15+9OvUnri72pf4Or1+vB9UGTLrznFNWb/NJirtavqd6EvdL6Yu+0/9Tf1fqVP+HqtXpgfcCkC+85RfUmv7SYq/Vrqjdhr7S+2DvtP/V3tX7lT7h6bXpo+Qv3HXtF7Ym90/5TvOcUlZe/8L4zUb1f+wvfa199g6vX6uHmhfuOvaL2xN5p/ynec4rKy19435mo3q/9he+1r77B3WsDfliN/cK9adwT+7vj/qT1d6k9705TmE97+vbNxd7T+QW/uRr4QTX2C/emcU/s7477k9bfpfa8O01hPu3p2zcXe0/nF/zkaj188kvrm+uby25eY2/St3w57S/cm/qLqb+bq3f9Yrf3DT+5Wh84+aX1zfXNZTevsTfpW76c9hfuTf3F1N/N1bt+sdv7ht9cDfzw3Q+rvrp8980L+84t6p6/5xRTvqiev+MU1Zv0rm+u/gW/vQ5+6O4HVl9dvvvmhX3nFnXP33OKKV9Uz99xiupNetc3V/+Cq9frwX7gac857dec4p76lNovv5i+S189+Qtz9VPfXF1+7d/g6rV6oB9w2nNO+zWnuKc+pfbLL6bv0ldP/sJc/dQ3V5df+ze4ew18uB9QetcXe86EvdJOUb3J38V+3Z1y9S1fPfmLypdf+S/46a/4QX5Y6V1f7DkT9ko7RfUmfxf7dXfK1bd89eQvKl9+5b/g6q/4Aacf8nTvVNeIvv2aidP+hHfqfvkT1Z9880nrT/kvuXrdDzr9gKd7p7pG9O3XTJz2J7xT98ufqP7km09af8p/ydXrPri0s8tpX/zd3Xv23dM3L6Ze5fqld32Z8sK9SZd/qif/CVev+cDSzi6nffF3d+/Zd0/fvJh6leuX3vVlygv3Jl3+qZ78J9y99sd66O6D7ddI5fo13/bdm6g7+k719IvK9et+5U719G/xb/3O/3D32h/1AYX9Gqlcv+bbvnsTdUffqZ5+Ubl+3a/cqZ7+Lf6t3/kfrl7zgWp9x1yt/5S6p3/790/v2SutX3n1xJ5616+ZeuZiv3pPuHrNB6r1HXO1/lPqnv7t3z+9Z6+0fuXVE3vqXb9m6pmL/eo94eo1H+jDzaee/VP/V/h7jpz6RfVPf7/6an1zfad6suurZcq/4eo1H+gfxnzq2T/1f4W/58ipX1T/9Perr9Y313eqJ7u+Wqb8G65e8w/hyORXvqhcv/TkO1NPvvUrl+qX1jffpfr+TvUWleurZff3vuHqNR/qyORXvqhcv/TkO1NPvvUrl+qX1jffpfr+TvUWleurZff3vuHqNR94+vCp5z37+ubV01eXX1T+7b1F7VfuSPmLaX9h7p65vdL6jpT/hKvXfOD0QTL1vGdf37x6+uryi8q/vbeo/codKX8x7S/M3TO3V1rfkfKfcPWaH+CD9R0xt1f+Lu57Ry21Zy7Tnky9yiffXD1Rfe87spury7/J1Ws+3AfrO2Jur/xd3PeOWmrPXKY9mXqVT765eqL63ndkN1eXf5Or13YfPulTv7RjXrp879WIvlq/RspfmJcuX6q/y7RnXrr8X3D16u4HTPrUL+2Yly7fezWir9avkfIX5qXLl+rvMu2Zly7/F1y9uvsBU0/fXHZ9tb55+WKvpjjNvesU5moxr99R65ur9c0nv/QNrl47/ZBd31x2fbW+eflir6Y4zb3rFOZqMa/fUeubq/XNJ7/0De5eAz+sPkC/+pMv9p3qFealJ9+8elK5Wt+Rb/PJl/IXlZe/mPIn/ObqH/4B60P0qz/5Yt+pXmFeevLNqyeVq/Ud+TaffCl/UXn5iyl/wm+u/jE93D+wfbW459hT18ipv6i8fk8t5qWdKbdX/fIdMXfs7eKd0/0d7l6D6cF+mH21uOfYU9fIqb+ovH5PLealnSm3V/3yHTF37O3indP9Ha5emx445Yvq+YeYemr9yu2p9c3V5de+uehPdxb27JdvPlF31PrOKd/ufeLqtemBU76onn/AqafWr9yeWt9cXX7tm4v+dGdhz3755hN1R63vnPLt3ifuXvvDD62H609afzffndov3ylO87pbWr+YenWvtP6Ul3/K0/0TfvIr/iHqg/Qnrb+b707tl+8Up3ndLa1fTL26V1p/yss/5en+CT/5lekDzEs7t/Du7kz7lZdv/m1PTv2i+r/2ZfWcym9y99of00PNSzu38O7uTPuVl2/+bU9O/aL6v/Zl9ZzKb3L32h8+uB4+5XLac8R8dwp7ztSrXCZ/GvvytO9MvSl3ZMqfcPfaHz64Hj7lctpzxHx3CnvO1KtcJn8a+/K070y9KXdkyp9w99pD6kPV+pVL9XbvVF7+bep3Tt9fvcmvmaied6q3MJ/0De5ee0j9odT6lUv1du9UXv5t6ndO31+9ya+ZqJ53qrcwn/QNrl7zQ3en9ifsO7s9x73S+jXVk/IX5t6rXF2+2jnNJ+yd6sm/wdWr/sF2p/Yn7Du7Pce90vo11ZPyF+beq1xdvto5zSfsnerJv8HVq6cPtb+0/inuq4upZ17vLa0/UXvqyV94b+ov7O1q/WK3b76794SrV08fav/WB7uvLqaeeb23tP5E7aknf+G9qb+wt6v1i92++e7eE65e9aF+QOWiX/uVT1PYm0ZO/aL6k7877qlr7E24X3vmu1P7N7l6zQf68MpFv/Yrn6awN42c+kX1J3933FPX2Jtwv/bMd6f2b3L1mg/04ZWr9SemvcpL10j5i9rXd+yJ/d2e/qT1J3b3zNWTX5z2d7h6zQf6B6tcrT8x7VVeukbKX9S+vmNP7O/29CetP7G7Z66e/OK0v8PVaz7QP1jl6qfjvV2tbz7pierrqyfqvbv5wl7N1N9l2tOf9C+4et0H+weoXP10vLer9c0nPVF9ffVEvXc3X9irmfq7THv6k/4FV6+fPnjq+wesvrk9tb65Wp7uqcsvplzsq3dxT73rm09+4d7U/4ar104fOPX98Oqb21Prm6vl6Z66/GLKxb56F/fUu7755BfuTf1vuHrNh+6O+2r9ym/NKbv71St/ovr60/1vfXP909yeWt/8F1y96ofsjvtq/cpvzSm7+9Urf6L6+tP9b31z/dPcnlrf/Bf85urLy/8T3v8gLy8feP+DvLx84P0P8vLygfc/yMvLB97/IC8vH3j/g7y8fOD9D/Ly8oH3P8jLywfe/yAvLx94/4O8vHzg/Q/y8vKB9z/Iy8sH3v8gLy8feP+DvLx84P0P8vLygfc/yMvLB97/IC8vH3j/g7y8fOC/Acp9OPj144RMAAAAAElFTkSuQmCC
qr_string: 00020101021226700014br.gov.bcb.pix.citi.com.br/qr/2/8b3da2f39a4140d1a91abd93113bd44 15204000053039865802BR5913Fulano de Tal6008BRASILIA62070503***630464E4
additional_info:
- name: LAPTOP
value: PURCHASED APPLE LAPTOP
- name: SOFTWARE
value: PURCHASED ADDITIONAL SOFTWARE
- name: transaction_id
value: pay02052023456r
- name: payment_settlement_date_time
value: '2022-09-13T08:23:49.114Z'
- name: payment_details
value: Payment for goods
- customer:
id: 8415678edrf
type: BUSINESS
name:
first_name: JOHN
last_name: PETER
merchant:
tax_id: 8.020.340/8910-44
method:
type: PIX
pix:
tax_id: 1.020.340/8910-22
transaction:
id: abcedgh8742323
expiry_time: 2500
creation_date_time: '2022-09-13T08:23:49.112Z'
amount: 111
update_flag: Y
update_count: 0
qr_image: Y
status: SETTLED
description: Transaction settled
qr_byte_code: iVBORw0KGgoAAAANSUhEUgAAAMgAAADICAYAAACtWK6eAAAYV0lEQVR4Xu3T26osu3JF0f3/P21jmMKmQa+QKlWbg8kO8TAuEaWci/XPf728vCT/aLy8vPwv73+Ql5cPvP9BXl4+8P4HeXn5wPsf5OXlA+9/kJeXD7z/QV5ePvD+B3l5+cD7H+Tl5QPvf5CXlw+8/0FeXj7w/gd5efnA+x/k5eUD73+Ql5cPvP9BXl4+8P4HeXn5wPsf5OXlA+9/kJeXD1z9D/LPP/98NdP+lNuzX1qme4spX9gr7VQu5lNP7VQu5lNPyhfv785Nrl7zobsz7U+5PfulZbq3mPKFvdJO5WI+9dRO5WI+9aR88f7u3OTqtdMH2p/0RPX1S+ubT1rffBf7dV+/8l2qrz/pwp7vrnyX0/4OV6+dPtD+pCeqr19a33zS+ua72K/7+pXvUn39SRf2fHflu5z2d7h6zQf64ZUXlU/3Jt/ZpfYmX61vLrWnfurXVG+X2vtWO+Y3uXrNB/ohlReVT/cm39ml9iZfrW8utad+6tdUb5fa+1Y75je5es0H+iGVly5frV8zUf3SNcXUM7enlikvas93VO9bvLerHfObXL3mA/2QykuXr9avmah+6Zpi6pnbU8uUF7XnO6r3Ld7b1Y75Ta5e84F+SOVSvnh3d57u1xSVn/oTvmca90qX7z2nmPKFPe9XfpOr13ygH1K5lC/e3Z2n+zVF5af+hO+Zxr3S5XvPKaZ8Yc/7ld/k6rXTB1a//MI/mPulawpz96aZqH7p8ovdvKYwL61vLuUXp/0drl47fWD1yy/8B3C/dE1h7t40E9UvXX6xm9cU5qX1zaX84rS/w9Vr/iF2x/1Xv/r/6tO5ydVrPnR33H/1q/+vPp2b3L32ED/UEf1Jlz/9zsK89krXSOX6lRe1N+WlHfNdTvv/Jv9Rr/IP7oj+pMuffmdhXnula6Ry/cqL2pvy0o75Lqf9f5Orr/JDpz+gI/pqme4t7J2Od3a1vrm+U73yT2e6M+X27J9Se/rT7z/h6jUfWA/XN7dXWqZ7C3un451drW+u71Sv/NOZ7ky5Pfun1J7+9PtPuHvtDx+qFnM/2LEn+qdapnyXulP+YsoX9pbWNy/ct1+++S72T++rb3D32h8+VC3m/mEce6J/qmXKd6k75S+mfGFvaX3zwn375ZvvYv/0vvoGd69BPbg+XC3uOfbUk1+52HeqV37NLrv96f7kVy5Tz3tOUT31TX5z9Y96+Lcf6p5jTz35lYt9p3rl1+yy25/uT37lMvW85xTVU9/k6lU/wIer9Z1d7JeusVe4Z19d7PYmfIcj+qf6W7/wvY6U/0uu/pof6Aep9Z1d7JeusVe4Z19d7PYmfIcj+qf6W7/wvY6U/0uu/pof6Aed6vJ3tX7ljuirpfLyT/GOepfTvW/77u36zsRu74Sr1/wgH3yqy9/V+pU7oq+Wyss/xTvqXU73vu27t+s7E7u9E65eu/1A75XWl+rpO1PvNJfJNy+tby6Tb17aMZddX134+7t7J1y9dvuB3iutL9XTd6beaS6Tb15a31wm37y0Yy67vrrw93f3Trh77Q8fWrqmeqI/6cKevzvNr/F31JO/mHKxrxbzpctXO/8J/OQVfmDpmuqJ/qQLe/7uNL/G31FP/mLKxb5azJcuX+38J3D1FX7gNNNe5aJ/S+uLeWlnyqv3Le6X1hfz3b3F1Ku8fmfSN7h6zQ+ZZtqrXPRvaX0xL+1MefW+xf3S+mK+u7eYepXX70z6Blev1QMnv/KFuXvm9k61fuXVm3C/7uiX1jeXya+xp3ZOcd87p/4Nrl6rB05+5Qtz98ztnWr9yqs34X7d0S+tby6TX2NP7ZzivndO/RtcveZDTx9ce6e++UTd0TefqP63fk1hXtoRc3vlT7m6uN074eo1/xCnD669U998ou7om09U/1u/pjAv7Yi5vfKnXF3c7p1w9druH2K3V0z7+jLlhfcde1J+Ufcn7Ktv+WqZ3l++VE9ffYOr1+oPUrr8iWlfX6a88L5jT8ov6v6EffUtXy3T+8uX6umrb3D12vQHKdyrfX21fs23vV0tleurxby0/pSrxfxb7VSuL6f+E65eqw+dcK/29dX6Nd/2drVUrq8W89L6U64W82+1U7m+nPpPuHsNpg93ptyxL/Z3Z9qvXCbfMZ90+RO7vcL9eo/5hL1JT/4NfnP1j/rD6e/mjn2xvzvTfuUy+Y75pMuf2O0V7td7zCfsTXryb3D1av2hyjdXTyPli73p7sKeI/ql9c2L3dzerm9ePf3Sp75apvwGV69Pfzh9c/U0Ur7Ym+4u7DmiX1rfvNjN7e365tXTL33qq2XKb/DT6/4h/SD90/HOri5/uu9ULuUvzEtPfuW7VF9/0kX1ypfVs1/+De5eAx/uB+ifjnd2dfnTfadyKX9hXnryK9+l+vqTLqpXvqye/fJvcPXa9NDy5fSO/Wncm/Q0U9+8cK/GvlrfXNyrsS/lL8zV+lP+b3D1V2592Okd+9O4N+lppr554V6NfbW+ubhXY1/KX5ir9af83+Dqr/hwP3R33Fc7om/f2e05056Uv9jN7elPI5PvyGl+2judm1y95gN9+O64r3ZE376z23OmPSl/sZvb059GJt+R0/y0dzo3uXrNh/pgtbjnVE9/V+tXvrDnTD2Z/MqLqT/dnXKxN+1XXr7s9m5y9Vf8AD9ELe451dPf1fqVL+w5U08mv/Ji6k93p1zsTfuVly+7vZv8K79SH1a6fPXuuKd2zNX6E/bV5Z/+nr1Jl3/6u4tpr/yF+aQn/wa/uQr1hytdvnp33FM75mr9Cfvq8k9/z96kyz/93cW0V/7CfNKTf4OfXPXB0x9uUfmury7qPWpxb+oX7ql3cU8t5uqJ+m51+bVvXpirf8FPrvvw6Q+zqHzXVxf1HrW4N/UL99S7uKcWc/VEfbe6/No3L8zVv+DqdR/sH2R33FfXVE/MT0d281Pcq9/Rn8Y99a4vU0/f/ulI+U+4es0H+kG74766pnpifjqym5/iXv2O/jTuqXd9mXr69k9Hyn/C1Wu7D6yef4CaYsrFvrr8Xa1vLvpqfXO1VO696i3sTf2F/dqbcjntn3D12u4Dq+eH1hRTLvbV5e9qfXPRV+ubq6Vy71VvYW/qL+zX3pTLaf+Eq9emh+rbd6T8wnvul9Y3F/26U775pPWLqV/5pCd/YT5pfUfMq/eEq9emh+rbd6T8wnvul9Y3F/26U775pPWLqV/5pCd/YT5pfUfMq/eEu9cCHz7p8v1D1ExUXz1Rd05z9a5vLuUv6u6kT/36HfNd7E/3n3D3WuDDJ12+f4iaieqrJ+rOaa7e9c2l/EXdnfSpX79jvov96f4T7l77ox6qr97FvfoD7fqOmDv2Spc/3dM3l9M99YT9+j31LrWn7++a3+DutT/qofrqXdyrP9Cu74i5Y690+dM9fXM53VNP2K/fU+9Se/r+rvkNrl779oH1gZMu33uOPXX5Uv2ieuUX0+/qT1rqvrqofXO1fmF/d+8brl799qH1oZMu33uOPXX5Uv2ieuUX0+/qT1rqvrqofXO1fmF/d+8brl7dfagf5shp7siu7x1H9Kt/6ldur/wp3/UrL8zV+pUvqlf+Da5e232gH+TIae7Iru8dR/Srf+pXbq/8Kd/1Ky/M1fqVL6pX/g2uXvOhuw+eet6zP/ky+TVi7hTV03emnrmUvzBXP/VrxNyRKX/C1Ws+dPfBU8979idfJr9GzJ2ievrO1DOX8hfm6qd+jZg7MuVPuHrNh/rgUy3eta+W2hN7u/1vtb65vmNPrW8up/7C/Kme/MWUP+Hq1fVQx3xXi3ftq6X2xN5u/1utb67v2FPrm8upvzB/qid/MeVPuHrVh6onf2G+9Lf+aX7KtF+/U1pfpnxR98oXc3X5ajGftFRe/hOuXvOB6slfmC/9rX+anzLt1++U1pcpX9S98sVcXb5azCctlZf/hLvXgvVwP6D8onqTv5tPvVO869ibcN8RffUtf3qH7PbN1fqVP+HutaA+oPyiepO/m0+9U7zr2Jtw3xF99S1/eofs9s3V+pU/4e61P3ywD9/VzpQ7E/Zqv3yxZ19/d2TyzXd1jb3S+o65lF/YV9/g7rU//MP48F3tTLkzYa/2yxd79vV3RybffFfX2Cut75hL+YV99Q2uXqsHTn7li9NcLfW75e/mC/NdXWNPTvsL96aRytW/9tU3uXq1Hjr5lS9Oc7XU75a/my/Md3WNPTntL9ybRipX/9pX3+TqVR+6tCP6ky7sqcv3fY6UL9WbfHO1vvmk9R1zdflF5eWfUu+6wdVrPtCHm9vb1YU9dfm+z5HypXqTb67WN5+0vmOuLr+ovPxT6l03uHvtj+nB3+bqXd/5Fu/UvVNfvO/eri5/0s4uu3vm7pkXu70n/OT69KHf5upd3/kW79S9U1+8796uLn/Szi67e+bumRe7vSf89npQH1Z/oNLObm5PXb7ou+/Ym6he3T3NxT1Hyi+8N+1PuZz2d7h7bZP6kPrDlXZ2c3vq8kXffcfeRPXq7mku7jlSfuG9aX/K5bS/w91rf0wP9Q/kVE+/9FOme/Wuwl7tn+ryvW++2yutX0z9b/3Kf8FPfmX6AD/UqZ5+6adM9+pdhb3aP9Xle998t1dav5j63/qV/4Krv1IP15/0LtMfTF+tX/m3eHca9ybcr70pL+yrn/rmpfXNS9/g6rV6oP6kd7n1B5zufIt3p3Fvwv3am/LCvvqpb15a37z0De5e+8OHqvUrL+zXHf3KRb/25TRXl//t76t3/ZrqSfmFfe9XLuU/4e61P3yoWr/ywn7d0a9c9GtfTnN1+d/+vnrXr6melF/Y937lUv4Trl57+kD3T/Uua6/2zaee1N6kC3ver/xb/SvfXC1TvtjtfcPVq08f6v6p3mXt1b751JPam3Rhz/uVf6t/5ZurZcoXu71v+M3VP/zD7I6UX1Rfv/Q0xdTT3+3XiPk0xZQvvOeeesI7NfZ/yU+v+2G7I+UX1dcvPU0x9fR3+zViPk0x5Qvvuaee8E6N/V9y9bofUlOYT7qwN/3+lC8qn/bLL6o/+ZUvpryoPX936k1aX+xN/Rtcve7DawrzSRf2pt+f8kXl0375RfUnv/LFlBe15+9OvUnri72pf4Or1+vB9UGTLrznFNWb/NJirtavqd6EvdL6Yu+0/9Tf1fqVP+HqtXpgfcCkC+85RfUmv7SYq/Vrqjdhr7S+2DvtP/V3tX7lT7h6bXpo+Qv3HXtF7Ym90/5TvOcUlZe/8L4zUb1f+wvfa199g6vX6uHmhfuOvaL2xN5p/ynec4rKy19435mo3q/9he+1r77B3WsDfliN/cK9adwT+7vj/qT1d6k9705TmE97+vbNxd7T+QW/uRr4QTX2C/emcU/s7477k9bfpfa8O01hPu3p2zcXe0/nF/zkaj188kvrm+uby25eY2/St3w57S/cm/qLqb+bq3f9Yrf3DT+5Wh84+aX1zfXNZTevsTfpW76c9hfuTf3F1N/N1bt+sdv7ht9cDfzw3Q+rvrp8980L+84t6p6/5xRTvqiev+MU1Zv0rm+u/gW/vQ5+6O4HVl9dvvvmhX3nFnXP33OKKV9Uz99xiupNetc3V/+Cq9frwX7gac857dec4p76lNovv5i+S189+Qtz9VPfXF1+7d/g6rV6oB9w2nNO+zWnuKc+pfbLL6bv0ldP/sJc/dQ3V5df+ze4ew18uB9QetcXe86EvdJOUb3J38V+3Z1y9S1fPfmLypdf+S/46a/4QX5Y6V1f7DkT9ko7RfUmfxf7dXfK1bd89eQvKl9+5b/g6q/4Aacf8nTvVNeIvv2aidP+hHfqfvkT1Z9880nrT/kvuXrdDzr9gKd7p7pG9O3XTJz2J7xT98ufqP7km09af8p/ydXrPri0s8tpX/zd3Xv23dM3L6Ze5fqld32Z8sK9SZd/qif/CVev+cDSzi6nffF3d+/Zd0/fvJh6leuX3vVlygv3Jl3+qZ78J9y99sd66O6D7ddI5fo13/bdm6g7+k719IvK9et+5U719G/xb/3O/3D32h/1AYX9Gqlcv+bbvnsTdUffqZ5+Ubl+3a/cqZ7+Lf6t3/kfrl7zgWp9x1yt/5S6p3/790/v2SutX3n1xJ5616+ZeuZiv3pPuHrNB6r1HXO1/lPqnv7t3z+9Z6+0fuXVE3vqXb9m6pmL/eo94eo1H+jDzaee/VP/V/h7jpz6RfVPf7/6an1zfad6suurZcq/4eo1H+gfxnzq2T/1f4W/58ipX1T/9Perr9Y313eqJ7u+Wqb8G65e8w/hyORXvqhcv/TkO1NPvvUrl+qX1jffpfr+TvUWleurZff3vuHqNR/qyORXvqhcv/TkO1NPvvUrl+qX1jffpfr+TvUWleurZff3vuHqNR94+vCp5z37+ubV01eXX1T+7b1F7VfuSPmLaX9h7p65vdL6jpT/hKvXfOD0QTL1vGdf37x6+uryi8q/vbeo/codKX8x7S/M3TO3V1rfkfKfcPWaH+CD9R0xt1f+Lu57Ry21Zy7Tnky9yiffXD1Rfe87spury7/J1Ws+3AfrO2Jur/xd3PeOWmrPXKY9mXqVT765eqL63ndkN1eXf5Or13YfPulTv7RjXrp879WIvlq/RspfmJcuX6q/y7RnXrr8X3D16u4HTPrUL+2Yly7fezWir9avkfIX5qXLl+rvMu2Zly7/F1y9uvsBU0/fXHZ9tb55+WKvpjjNvesU5moxr99R65ur9c0nv/QNrl47/ZBd31x2fbW+eflir6Y4zb3rFOZqMa/fUeubq/XNJ7/0De5eAz+sPkC/+pMv9p3qFealJ9+8elK5Wt+Rb/PJl/IXlZe/mPIn/ObqH/4B60P0qz/5Yt+pXmFeevLNqyeVq/Ud+TaffCl/UXn5iyl/wm+u/jE93D+wfbW459hT18ipv6i8fk8t5qWdKbdX/fIdMXfs7eKd0/0d7l6D6cF+mH21uOfYU9fIqb+ovH5PLealnSm3V/3yHTF37O3indP9Ha5emx445Yvq+YeYemr9yu2p9c3V5de+uehPdxb27JdvPlF31PrOKd/ufeLqtemBU76onn/AqafWr9yeWt9cXX7tm4v+dGdhz3755hN1R63vnPLt3ifuXvvDD62H609afzffndov3ylO87pbWr+YenWvtP6Ul3/K0/0TfvIr/iHqg/Qnrb+b707tl+8Up3ndLa1fTL26V1p/yss/5en+CT/5lekDzEs7t/Du7kz7lZdv/m1PTv2i+r/2ZfWcym9y99of00PNSzu38O7uTPuVl2/+bU9O/aL6v/Zl9ZzKb3L32h8+uB4+5XLac8R8dwp7ztSrXCZ/GvvytO9MvSl3ZMqfcPfaHz64Hj7lctpzxHx3CnvO1KtcJn8a+/K070y9KXdkyp9w99pD6kPV+pVL9XbvVF7+bep3Tt9fvcmvmaied6q3MJ/0De5ee0j9odT6lUv1du9UXv5t6ndO31+9ya+ZqJ53qrcwn/QNrl7zQ3en9ifsO7s9x73S+jXVk/IX5t6rXF2+2jnNJ+yd6sm/wdWr/sF2p/Yn7Du7Pce90vo11ZPyF+beq1xdvto5zSfsnerJv8HVq6cPtb+0/inuq4upZ17vLa0/UXvqyV94b+ov7O1q/WK3b76794SrV08fav/WB7uvLqaeeb23tP5E7aknf+G9qb+wt6v1i92++e7eE65e9aF+QOWiX/uVT1PYm0ZO/aL6k7877qlr7E24X3vmu1P7N7l6zQf68MpFv/Yrn6awN42c+kX1J3933FPX2Jtwv/bMd6f2b3L1mg/04ZWr9SemvcpL10j5i9rXd+yJ/d2e/qT1J3b3zNWTX5z2d7h6zQf6B6tcrT8x7VVeukbKX9S+vmNP7O/29CetP7G7Z66e/OK0v8PVaz7QP1jl6qfjvV2tbz7pierrqyfqvbv5wl7N1N9l2tOf9C+4et0H+weoXP10vLer9c0nPVF9ffVEvXc3X9irmfq7THv6k/4FV6+fPnjq+wesvrk9tb65Wp7uqcsvplzsq3dxT73rm09+4d7U/4ar104fOPX98Oqb21Prm6vl6Z66/GLKxb56F/fUu7755BfuTf1vuHrNh+6O+2r9ym/NKbv71St/ovr60/1vfXP909yeWt/8F1y96ofsjvtq/cpvzSm7+9Urf6L6+tP9b31z/dPcnlrf/Bf85urLy/8T3v8gLy8feP+DvLx84P0P8vLygfc/yMvLB97/IC8vH3j/g7y8fOD9D/Ly8oH3P8jLywfe/yAvLx94/4O8vHzg/Q/y8vKB9z/Iy8sH3v8gLy8feP+DvLx84P0P8vLygfc/yMvLB97/IC8vH3j/g7y8fOC/Acp9OPj144RMAAAAAElFTkSuQmCC
qr_string: 00020101021226700014br.gov.bcb.pix.citi.com.br/qr/2/8b3da2f39a4140d1a91abd93113bd44 15204000053039865802BR5913Fulano de Tal6008BRASILIA62070503***630464E4
additional_info:
- name: LAPTOP
value: PURCHASED APPLE LAPTOP
- name: SOFTWARE
value: PURCHASED ADDITIONAL SOFTWARE
- name: transaction_id
value: pay02052023456r
- name: payment_settlement_date_time
value: '2022-09-13T08:23:49.114Z'
- name: payment_details
value: Payment for goods
Card-Payment-Response-Example:
value:
order:
amount: 100
currency_code: USD
merchant_amount: 100
merchant_currency: USD
status: AUTHORIZED
total_auth_amount: 100
total_captured_amount: 0
total_disbursed_amount: 0
total_refunded_amount: 0
id: TX0250117002
creation_time: '2025-01-17T13:10:23.973Z'
update_time: '2025-01-17T13:10:24.351Z'
transaction:
authorizationResponse:
posEntryMode: '812'
returnAci: '8'
stan: '144032'
transactionIdentifier: '123456789012345'
commercialCardIndicator: '3'
posData: '1025104006600'
processingCode: '003000'
responseCode: '00'
acquirer:
transaction_id: '123456789012345'
batch: '20250117'
date: '0117'
merchant_id: '120240306011001'
type: AUTHORIZATION
terminal: 0791
response:
acquirer_code: '00'
acquirer_message: Approved
id: ORD_20250117_002
amount: 100
currency_code: USD
status: SUCCESS
description: APPROVED
creation_date_time: '2025-01-17T13:10:24.019Z'
update_time: '2025-01-17T13:10:24.351Z'
receipt: '501713144032'
authorization_code: '144032'
method:
CARD:
number: 401200xxxxxx0026
expiry_month: '1'
expiry_year: '39'
fundingMethod: CREDIT
stored_on_file: NOT_STORED
Us-Rfp-Request-Example:
value:
method:
type: RTP
transaction:
id: e2e123456
uetr: bea176bf-1d5d-48cc-88fb-1d0e06af43e7
value_date: '2024-05-01'
expiry_date: '2024-05-09'
update_flag: Y
amount: '500.00'
currency_code: USD
country_code: US
full_amount: '500.00'
discount_amount: '10.00'
purpose: GDDS
remittance_info: This is sample
reference: 2017111202120020101BSTRF00000000011
customer:
account:
number: '89770098'
bank_id: ABC12345
name: Josh
name:
first_name: Karl
organization_id: GH4657
birth_date: '2023-01-02'
birth_city: New York
birth_country: US
address:
street_name: 1212 4th Street
building_number: A6378
city: San Francisco
state: CA
postal_code: '70989'
country_code: US
type: BUSINESS
merchant:
account:
number: '900900981'
name: Mike
bank_id: '89332'
name: Yokal
organization_id: AS2345
birth_date: '2023-01-03'
birth_city: New Ark
birth_country: US
phone_number: +1-555-123-4567
address:
street_name: 1212 7th Street
building_number: V7839
postal_code: '50098'
city: New York
state: CA
country_code: US
sender:
name: Himan
organization_id: AM2345
birth_date: '2023-01-07'
birth_city: New York
birth_country: US
private_id: PS89090
address:
street_name: 1345 4th Street
building_number: B5829
postal_code: '89934'
city: Vegas
state: CA
country_code: US
receiver:
name: Pista
organization_id: GH6785
birth_date: '2023-07-07'
birth_city: New York
birth_country: US
private_id: PB19090
address:
street_name: 4th Avenue
building_number: G6178
postal_code: '90213'
city: New York
state: CA
country_code: US
US-Card-Capture-Request-Example:
value:
method:
type: CARD
transaction:
id: ccapigpaytestmk021826010
country_code: US
amount: 110
currency_code: USD
order:
id: ccapigpaytestmk1771318960
Payment-Success-Upi-Status-Notification:
value:
customer:
account:
proxy_id: raja@citi.com
bank_id: CITIIN77
type: SAVINGS
number: '1122334455'
name:
first_name: PETER
address:
lines:
- '#45, Block 12'
- Federal Street
building_number: '20'
city: Abis Brasil
postal_code: 69935-000
state: san francisco
country_code: IN
merchant:
name: JOHN
account:
proxy_id: vinu@citi.com
bank_id: CITIIN33
number: '8899775544'
address:
lines:
- '#45, Block 12'
- Federal Street
building_number: '20'
city: Abis Brasil
postal_code: 69935-000
state: san francisco
country_code: IN
method:
type: UPI
upi:
initiation_type: UPI QR Code
transaction:
end_to_end_id: r434SKtUcdGQ
reference: NPCI123456789
amount: 100
uetr: 4f09214d-296c-494b-8e9c-810bf1d9fc93
network_id: clr02052023478
batch_id: batch12345
value_date: '2022-09-07'
creation_date_time: '2022-09-13T08:23:49.112Z'
currency_code: INR
status: SETTLED
description: Transaction settled
remittance_info:
- PURCHASED APPLE LAPTOP
- PURCHASED ADDITIONAL SOFTWARE
order:
id: orSKtUcdGQ
US-Card-Verify-Request-With-Token-Example:
value:
method:
type: CARD
token_id: 5613dc38-ba17-446c-8c18-ae89f79de596
token_type: CITI_TOKEN
card:
cvv: '123'
transaction:
id: ccapicardstestmk0218260012
country_code: US
currency_code: USD
order:
id: ccapicardstestmk0218260013
amount: 2
currency_code: USD
US-Card-Cancel-Request-Example:
value:
method:
type: CARD
transaction:
id: ccapigpaytestmk021826010
target_transaction_id: ccapigpaytestmk1771318161
country_code: US
currency_code: USD
order:
id: ccapigpaytestmk1771318960
Unauthorized-Gateway-Error-Example:
value:
httpCode: '401'
httpMessage: Unauthorized
moreInformation: This server could not verify that you are authorized to access the URL
Payment-Cancelled-Notification:
value:
transaction:
id: r434SKtUcdGQ
status: CANCELLED
description: transaction cancelled by user
Brazil-PIX-Initiation-Request-Example:
value:
transaction:
currency_code: BRL
country_code: BR
id: RFP99625446991261440318900
amount: 1050.55
reason: AGND
remittance_info:
- Request Initiated
holiday_flag: true
customer:
tax_id: 832.016.431-26
account:
bank_id: '33479023'
merchant:
tax_id: '54152690846'
account:
number: '91501003090'
method:
type: PIX
sender:
private_id: '54152690846'
mandate:
id: RR3347902320251109REF12345678
expiry_date: '2025-04-03'
India-Token-Authorize-Request-Example:
value:
customer:
id: '123456789'
method:
type: CARD
holder_name:
first_name: kevin
last_name: bob
token_id: '4000000000001091'
token_type: NETWORK_TOKEN
card:
cvv: '123'
last_4_digits: '1234'
expiry_month: '10'
expiry_year: '39'
cryptogram: /wAAAAAAl9SX1HsAmWKSgqwAAAA=
transaction:
id: INDIA234568
amount: 101
currency_code: INR
country_code: IN
order:
amount: 101
currency_code: INR
Us-Apple-Pay-Capture-Request-Example:
value:
customer:
id: '123456789'
method:
type: APPLEPAY
transaction:
id: ccapigpaytestmk021826010
country_code: US
amount: 110
currency_code: USD
order:
id: ccapigpaytestmk1771318960
Us-Card-Status:
value:
customer:
id: CST123456
name:
first_name: PAUL
last_name: JOHN
merchant:
name:
first_name: THOKLR
last_name: JOHN
method:
type: CARD
transaction:
id: pay02052623456r
amount: 200
currency_code: USD
status: FAILED
description: Transaction failed for invalid payload
creation_date_time: '2022-09-13T08:23:49.114Z'
update_time: '2022-09-13T08:23:49.114Z'
redirect_url: redirected@url
order:
amount: 200
currency_code: USD
merchant_amount: 200
merchant_currency: USD
status: FAILED
total_auth_amount: 200
total_captured_amount: 200
Us-Googlepay-Status:
value:
customer:
id: CST123456
name:
first_name: PAUL
last_name: JOHN
merchant:
name:
first_name: THOKLR
last_name: JOHN
method:
type: GOOGLEPAY
transaction:
id: pay02052623456r
amount: 200
currency_code: USD
status: FAILED
description: Transaction failed for invalid payload
creation_date_time: '2022-09-13T08:23:49.114Z'
update_time: '2022-09-13T08:23:49.114Z'
redirect_url: redirected@url
order:
amount: 200
currency_code: USD
merchant_amount: 200
merchant_currency: USD
status: FAILED
total_auth_amount: 200
total_captured_amount: 200
US-Card-Authorize-Request-With-Card-Example:
value:
method:
type: CARD
card:
number: '4320445566778907'
expiry_month: '12'
expiry_year: '24'
cvv: '567'
transaction:
id: card1234567
currency_code: USD
country_code: US
order:
id: order0000001
amount: 323
currency_code: USD
Payment-Method:
value:
method:
- type: PIX
country_code: BR
currency_code:
- BRL
Us-Google-Pay-Payment-Request-With-Token-Example:
value:
customer:
id: '11225367999'
method:
type: GOOGLEPAY
token_id: 5613dc38-ba17-446c-8c18-ae89f79de596
token_type: CITI_TOKEN
card:
cvv: '567'
transaction:
id: card1234567
currency_code: USD
country_code: US
order:
id: order0000001
amount: 323
currency_code: USD
Un-Supported-Media-Type-Gateway-Error-Example:
value:
httpCode: '415'
httpMessage: Unsupported Media Type
moreInformation: Unsupported Content-Type
Payment-Success-India-IMPS-Credit-Status-Notification:
value:
transaction:
end_to_end_id: r434SKtUcdGQ
reference: NPCI123456789
amount: 100
uetr: 4f09214d-296c-494b-8e9c-810bf1d9fc93
network_id: clr02052023478
batch_id: batch12345
value_date: '2022-09-07'
creation_date_time: '2022-09-13T08:23:49.112Z'
status_date_time: '2022-09-14T08:23:49.112Z'
currency_code: INR
status: SETTLED
description: Transaction settled
unstructured:
remittance_info:
- PURCHASED APPLE LAPTOP
- PURCHASED ADDITIONAL SOFTWARE
method:
type: IMPS
customer:
name:
first_name: Wilston
account:
number: '5564412'
bank_id: SBININBB
address:
street_name: Church street
building_number: '123'
postal_code: '987654'
city: Mumbai
state: Maharashtra
country: IN
merchant:
name: Hood
account:
number: '5564412'
bank_id: SBININBB
address:
street_name: Brigade street
building_number: '123'
postal_code: '996252'
city: Mumbai
state: Maharashtra
country: IN
US-Apple-Pay-Payment-With-Session-Request-Example:
value:
customer:
id: '11225367999'
method:
type: APPLEPAY
session_id: ad44b8bb-07ee-4a2c-ae84-3203d2e332af
transaction:
id: card1234567
currency_code: USD
country_code: US
order:
id: order0000001
amount: 323
currency_code: USD
India-Card-Cancel-Payment-Request-Example:
value:
method:
type: CARD
transaction:
id: INDIA234560
currency_code: INR
country_code: IN
amount: 100
order:
id: ORD12345
US-Ach-Pay-Payment-Request-Example:
value:
customer:
account:
number: '11223344'
type: SAVINGS
bank_id: '23456789'
method:
type: ACH
ach:
sec_code: CCD
holder_name:
first_name: JOHN
last_name: PETER
transaction:
id: card1234567
currency_code: USD
country_code: US
order:
id: order0000001
amount: 323
currency_code: USD
Payment-Success-Us-Rfp-Status:
value:
- method:
type: RTP
transaction:
id: e2e123456
uetr: bea176bf-1d5d-48cc-88fb-1d0e06af43e7
network_id: 2023111202120020101BSRFP00000000013
batch_id: '221084801'
creation_date_time: '2022-09-13T08:23:49.114Z'
value_date: '2024-05-01'
amount: 500
currency_code: USD
country_code: US
original_amount: 500
full_amount: 500
discount_amount: 10
purpose: GDDS
remittance_info:
- This is sample
reference: 2017111202120020101BSTRF00000000011
status: SETTLED
description: Transaction Settled
customer:
account:
number: '89770098'
bank_id: ABC12345
name: Josh
name:
first_name: Karl
organization_id: GH4657
birth_date: '2023-01-02'
birth_city: New York
birth_country: US
address:
lines:
- 678 Address Street
- B block
- Los Angeles
- CA
street_name: 1212 4th Street
building_number: A6378
city: San Francisco
state: CA
postal_code: '70989'
country_code: US
type: BUSINESS
merchant:
account:
number: '900900981'
name: Mike
bank_id: '89332'
name: Yokal
organization_id: AS2345
birth_date: '2023-01-03'
birth_city: New Ark
birth_country: US
address:
lines:
- 322 Address Street
- B block
- San Francisco
- CA
street_name: 1212 7th Street
building_number: V7839
postal_code: '50098'
city: New York
state: CA
country_code: US
sender:
name: Himan
organization_id: AM2345
birth_date: '2023-01-07'
birth_city: New York
birth_country: US
private_id: PS89090
address:
street_name: 1345 4th Street
building_number: B5829
postal_code: '89934'
city: Vegas
state: CA
country_code: US
receiver:
name: Pista
organization_id: GH6785
birth_date: '2023-07-07'
birth_city: New York
birth_country: US
private_id: PB19090
address:
street_name: 4th Avenue
building_number: G6178
postal_code: '90213'
city: New York
state: CA
country_code: US
- method:
type: RTP
transaction:
id: e2e123456
uetr: bea176bf-1d5d-48cc-88fb-1d0e06af43e7
network_id: 2023111202120020101BSRFP00000000013
batch_id: '221084801'
creation_date_time: '2022-09-13T08:23:49.114Z'
value_date: '2024-05-01'
amount: '701.00'
currency_code: USD
country_code: US
original_amount: '701.00'
full_amount: '701.00'
discount_amount: '11.00'
purpose: GDDS
remittance_info: This is sample
reference: 2017111202120020101BSTRF00000000011
status: SETTLED
description: Transaction Settled
customer:
account:
number: '89770098'
bank_id: ABC12345
name: Josh
name:
first_name: Karl
organization_id: GH4657
birth_date: '2023-01-02'
birth_city: New York
birth_country: US
address:
lines: 678 Address Street, B block, Los Angeles, CA
street_name: 1212 4th Street
building_number: A6378
city: San Francisco
state: CA
postal_code: '70989'
country_code: US
type: BUSINESS
merchant:
account:
number: '900900981'
name: Mike
bank_id: '89332'
name: Yokal
organization_id: AS2345
birth_date: '2023-01-03'
birth_city: New Ark
birth_country: US
address:
lines: 322 Address Street, B block, San Francisco, CA
street_name: 1212 7th Street
building_number: V7839
postal_code: '50098'
city: New York
state: CA
country_code: US
sender:
name: Himan
organization_id: AM2345
birth_date: '2023-01-07'
birth_city: New York
birth_country: US
private_id: PS89090
address:
street_name: 1345 4th Street
building_number: B5829
postal_code: '89934'
city: Vegas
state: CA
country_code: US
receiver:
name: Pista
organization_id: GH6785
birth_date: '2023-07-07'
birth_city: New York
birth_country: US
private_id: PB19090
address:
street_name: 4th Avenue
building_number: G6178
postal_code: '90213'
city: New York
state: CA
country_code: US
India-Card-Capture-Payment-Response-Example:
value:
transaction:
id: INDIA234568
amount: 101
status: SUCCESS
description: The operation was successfully processed
currency_code: INR
country_code: IN
creation_time: '2025-01-17T13:10:23.973Z'
update_time: '2025-01-17T13:10:24.351Z'
order:
id: ORD12345
amount: 323
currency_code: INR
creation_time: '2025-01-17T13:10:23.973Z'
update_time: '2025-01-17T13:10:24.351Z'
status: PARTIALLY_CAPTURED
Us-Google-Pay-Cancel-Request-Example:
value:
transaction:
id: ccapicardstestmk021826001
target_transaction_id: ccapigpaytestmk1771319407
currency_code: USD
country_code: US
method:
type": GOOGLEPAY
order:
id: ccapigpaytestmk1771319407
Payment-Failed-Status-Notification:
value:
transaction:
id: r434SKtUcdGQ
status: SYSTEM_ERROR
description: Internal system error occurred processing the transaction
Bad-Request-Get-Example:
value:
ref_id: 444d0f3f-4x55-7g99-8b2c-0cf2a921a5aa
error_details:
- issue: provided value is not within the range for header Merchant-Id
action: please provide valid value for header Merchant-Id, size must be between 1 and 40
code: VC00012
US-Apple-Pay-Authorize-With-Session-Request-Example:
value:
customer:
id: '11225367999'
method:
type: APPLEPAY
session_id: ad44b8bb-07ee-4a2c-ae84-3203d2e332af
transaction:
id: card1234567
currency_code: USD
country_code: US
order:
id: order0000001
amount: 323
currency_code: USD
Not-Found-Gateway-Error-Example:
value:
httpCode: '404'
httpMessage: Not Found
moreInformation: No resources match requested URI
Us-Apple-Pay-Verify-With-Card-Request-Example:
value:
customer:
id: '123456789'
merchant:
name: Wilson
method:
type: APPLEPAY
card:
number: '4012000033330026'
expiry_month: '01'
expiry_year: '39'
cvv: '123'
transaction:
id: ccapigpaytestmk021826010
country_code: US
currency_code: USD
order:
id: ccapigpaytestmk1771318960
amount: 110
currency_code: USD
Us-Google-Pay-Verify-With-Card-Request-Example:
value:
customer:
id: '123456789'
merchant:
name: Wilson
method:
type: GOOGLEPAY
card:
number: '4012000033330026'
expiry_month: '01'
expiry_year: '39'
cvv: '123'
transaction:
id: ccapigpaytestmk021826010
country_code: US
currency_code: USD
order:
id: ccapigpaytestmk1771318960
amount: 110
currency_code: USD
Us-Apple-Pay-Verify-With-Token-Request-Example:
value:
customer:
id: '123456789'
merchant:
name: Wilson
method:
type: APPLEPAY
token_id: 5613dc38-ba17-446c-8c18-ae89f79de596
token_type: CITI_TOKEN
card:
cvv: '123'
transaction:
id: ccapigpaytestmk021826010
country_code: US
currency_code: USD
order:
id: ccapigpaytestmk1771318960
amount: 110
currency_code: USD
Qr-Cancelled-Status:
value:
- customer:
id: 8415678edrf
type: BUSINESS
name:
first_name: JOHN
last_name: PETER
merchant:
tax_id: 8.020.340/8910-44
method:
type: PIX
pix:
tax_id: 1.020.340/8910-22
transaction:
id: abcedgh8742323
expiry_time: 2500
creation_date_time: '2022-09-13T08:23:49.112Z'
amount: 305
update_flag: Y
update_count: 0
qr_image: Y
status: CANCELLED
description: Transaction cancelled
additional_info:
- name: LAPTOP
value: PURCHASED APPLE LAPTOP
- name: SOFTWARE
value: PURCHASED ADDITIONAL SOFTWARE
- customer:
id: 8415678edrf
type: BUSINESS
name:
first_name: JOHN
last_name: PETER
merchant:
tax_id: 8.020.340/8910-44
method:
type: PIX
pix:
tax_id: 1.020.340/8910-22
transaction:
id: abcedgh8742323
expiry_time: 2500
creation_date_time: '2022-09-13T08:23:49.112Z'
amount: 240
update_flag: Y
update_count: 0
qr_image: Y
status: CANCELLED
description: Transaction cancelled
additional_info:
- name: LAPTOP
value: PURCHASED APPLE LAPTOP
- name: SOFTWARE
value: PURCHASED ADDITIONAL SOFTWARE
Brazil-PIX-Reject-Notification-Example:
value:
method:
type: PIX
transaction:
id: RTP99625446991261440318900
uetr: 4f09214d-296c-494b-8e9c-810bf1d9fc93
creation_date_time: '2024-09-13T08:23:49.114Z'
currency_code: BRL
amount: 123.23
status: FAILED
reason_code: AGND
description: Request Initiated
country_code: BR
status_date_time: '2024-05-26T08:20:49.114Z'
merchant:
account:
bank_id: '33479023'
mandate:
id: RR3347902320251109BRF12345678
Bad-Request-Gateway-Error-Example:
value:
httpCode: '400'
httpMessage: Bad Request
moreInformation: please provide valid value for property emailAddress
Trustly-Payment-Capture-Failed-Notification:
value:
method:
type: TRUSTLY
transaction:
id: pay02052623456r
amount: 200
currency_code: USD
status: FAILED
description: Transaction failed for invalid payload
reason_code: SC23456
psp_reference: 23dsdsdsj
order:
id: ORD123456
US-Wire-Status:
value:
- transaction:
uetr: 4f09214d-296c-494b-8e9c-810bf1d9fc93
creation_date_time: '2022-09-13T08:23:49.114Z'
amount: 1015.5
currency_code: USD
status: SETTLED
description: AC01 - Account Dormant
network_id: '209323283934'
value_date: '2025-03-17'
remittance_info:
- This is sample
end_to_end_id: pay02052023456r
customer:
name:
first_name: Smith
account:
number: '89770098'
bank_id: ABC12345
virtual_number: '91908009856'
address:
country_code: US
postal_code: '31503'
state: Georgia
lines:
- Street No 432, Church Street
merchant:
name: Smith
account:
number: '89770098'
bank_id: ABC12345
virtual_number: '91908009856'
address:
country_code: US
postal_code: '31503'
state: Georgia
lines:
- Street No 432, Church Street
Payment-Failed-Australia-IP-Credit-Status-Notification:
value:
transaction:
country_code: AU
currency_code: AUD
creation_date_time: '2022-09-13T08:22:49.112Z'
status_date_time: '2022-09-13T08:23:49.112Z'
end_to_end_id: RMTEST16SEP03
settlement_date: '2022-09-13'
status: FAILED
description: Charge code is Invalid
reason_code: FF01
uetr: 7c6e36c0-8538-4309-afe2-535053df2a42
method:
type: IP
merchant:
account:
number: 0100599074
bank_id: TYEG6758
name: ROLF RICHARDUS
customer:
account:
bank_id: RSBKAU2SXXX
number: '5589089'
name:
first_name: vopak terminals
US-Trustly-Payment-Capture-Success-Notification:
value:
method:
type: TRUSTLY
transaction:
id: pay02052623456r
amount: 200
currency_code: USD
status: SUCCESS
description: Transaction failed for invalid payload
psp_reference: 23dsdsdsj
order:
id: ORD123456
US-Paypal-Payment-Request-Example:
value:
customer:
id: '11225367999'
method:
type: PAYPAL
paypal:
browser_payment_operation: INITIATE
payment_confirmation: CONFIRM_AT_MERCHANT
transaction:
id: card1234567
currency_code: USD
country_code: US
update_flag: Y
url:
browser_payment_return: http://www.mastercard.com
order:
id: order0000001
amount: 323
currency_code: USD
Us-Google-Pay-Payment-Request-With-Card-Example:
value:
customer:
id: '11225367999'
method:
type: GOOGLEPAY
card:
number: '4320445566778907'
expiry_month: '12'
expiry_year: '24'
cvv: '567'
transaction:
id: card1234567
currency_code: USD
country_code: US
order:
id: order0000001
amount: 323
currency_code: USD
Payment-Success-Us-ACH-Status-Notification:
value:
transaction:
uetr: 4f09214d-296c-494b-8e9c-810bf1d9fc93
creation_date_time: '2022-09-13T08:23:49.114Z'
amount: 1015.5
currency_code: USD
status: SETTLED
description: AC01 - Account Dormant
network_id: '209323283934'
value_date: '2025-03-17'
remittance_info:
- This is sample
end_to_end_id: pay02052023456r
clearing_local_code: '26'
additional_info: PAYMENT
status_date_time: '2025-09-13T08:23:49.114Z'
country_code: US
reference: '9962546'
settlement_date: '2025-09-13'
customer:
name:
first_name: Smith
account:
number: '89770098'
bank_id: ABC12345
virtual_number: '91908009856'
address:
country_code: US
postal_code: '31503'
state: Georgia
lines:
- Street No 432, Church Street
merchant:
name: Smith
account:
number: '89770098'
bank_id: ABC12345
virtual_number: '91908009856'
address:
country_code: US
postal_code: '31503'
state: Georgia
lines:
- Street No 432, Church Street
method:
type: ACH
sec_code: CCD
Not-Found-Example:
value:
ref_id: ec689822-9864-4c4d-9d68-222467627702
error_details:
- issue: Resource that you are searching is not found
action: Please use valid resource details
code: CC00006
Paypal-Payment-Response-Example:
value:
order:
amount: 200
currency_code: USD
merchant_amount: 200
merchant_currency: USD
status: AUTHORIZED
total_auth_amount: 100
total_captured_amount: 0
total_disbursed_amount: 0
total_refunded_amount: 0
id: TX0250117002
creation_time: '2025-01-17T13:10:23.973Z'
update_time: '2025-01-17T13:10:24.351Z'
transaction:
authorizationResponse:
posEntryMode: '812'
returnAci: '8'
stan: '144032'
transactionIdentifier: '123456789012345'
commercialCardIndicator: '3'
posData: '1025104006600'
processingCode: '003000'
responseCode: '00'
acquirer:
transaction_id: '123456789012345'
batch: '20250117'
date: '0117'
merchant_id: '120240306011001'
type: AUTHORIZATION
terminal: 0791
response:
acquirer_code: '00'
acquirer_message: Approved
id: ORD_20250117_002
amount: 100
currency_code: USD
status: SUCCESS
description: APPROVED
creation_date_time: '2025-01-17T13:10:24.019Z'
update_time: '2025-01-17T13:10:24.351Z'
receipt: '501713144032'
authorization_code: '144032'
method:
Paypal:
account_email: ID@gmail.com
account_holder: JOHN
US-Trustly-Payment-Failed-Timedout-Notification:
value:
method:
type: TRUSTLY
transaction:
id: pay02052623456r
amount: 200
currency_code: USD
status: FAILED
description: Transaction failed for invalid payload
psp_reference: 23dsdsdsj
order:
id: ORD123456
Payment-Success-Us-Ach-Direct-Debit-Status-Notification:
value:
transaction:
creation_date_time: '2025-09-13T08:23:49.112Z'
id: TRX5678954
status: SETTLED
description: Transaction settled
amount: 500
currency_code: USD
value_date: '2025-02-18'
remittance_info:
- This is sample
method:
type: ACH
customer:
account:
number: '1234567890'
merchant:
name: JOHN
account:
number: '915010031906218'
bank_id: CITIIN33
Payment-Failed-Incoming-Brazil-PIX-Credit-Status-Notification:
value:
method:
type: PIX
customer:
account:
number: '97150300543944526009'
bank_id: CITIBRXXX
name: Jack
tax_id: TAX123
name:
first_name: Jack
merchant:
account:
number: '62080300543944526226'
bank_id: '33479023'
name: Kingston
name: Kingston
tax_id: TAX234
transaction:
end_to_end_id: 12345678dd
uetr: 4f09214d-296c-494b-8e9c-810bf1d9fc93
creation_date_time: '2024-09-13T08:23:49.114Z'
country_code: BR
currency_code: BRL
value_date: '2025-03-10'
amount: 800.21
status: FAILED
reason_code: AM02
description: Transaction Failed
status_date_time: '2024-05-26T08:20:49.114Z'
US-Alipay-Payment-Failed-Timedout-Notification:
value:
method:
type: ALIPAY
transaction:
id: pay02052623456r
amount: 200
currency_code: USD
status: FAILED
description: Transaction failed for invalid payload
psp_reference: 23dsdsdsj
order:
id: ORD123456
Brazil-PIX-Payment-Cancel-Failed-Notification-Example:
value:
method:
type: PIX
merchant:
account:
bank_id: '33479023'
transaction:
id: RTP99625446991261440318900
creation_date_time: '2024-09-13T08:23:49.114Z'
country_code: BR
currency_code: BRL
status: REJECTED
reason_code: ACCT
description: Request Cancelled
status_date_time: '2024-05-26T08:20:49.114Z'
Payment-Success-Thailand-IP-Credit-Status-Notification:
value:
transaction:
id: REF123456
end_to_end_id: ref34SKtUcdGQ
uetr: 4f09214d-296c-494b-8e9c-810bf1d9fc93
network_id: clr02052023478
batch_id: batch12345
value_date: '2022-09-07'
creation_date_time: '2022-09-13T08:23:49.112Z'
status_date_time: '2022-09-14T08:00:00.000Z'
bill_id_1: '77889900'
bill_id_2: '77889901'
bill_id_3: '77889902'
purpose: PAYMENT
processing_code: '58000'
tax_id: '2'
wht_code: A
wht_rate: 10
wht_amount: 1000
income_type: '001'
bill_due_date: '2022-09-07'
vat_rate: 10
vat_amount: 1000
amount: 5000
currency_code: THB
additional_info: Credit Payment
reference: payment for september
status: SETTLED
description: Transaction settled
merchant:
account:
number: '123456'
virtual_account: '998877'
bank_id: CITITHBX
branch_id: '123'
proxy_id: raja@citi.com
proxy_type: BIID
tax_id: tax123
name: Thomas
customer:
account:
number: '987654'
virtual_account: '1122334455'
bank_id: CITITHBX
branch_id: '123'
proxy_id: raja@citi.com
proxy_type: BIID
tax_id: tax123
name:
first_name: Wilson
sender:
name: Gary
address:
city: Phuket
country_code: TH
method:
type: IP
India-Card-Capture-Payment-Request-Example:
value:
method:
type: CARD
transaction:
id: INDIA234568
amount: 101
currency_code: INR
country_code: IN
order:
id: ORD12345
Us-Google-Pay-Verify-With-Session-Request-Example:
value:
customer:
id: '123456789'
merchant:
name: Wilson
method:
type: GOOGLEPAY
session_id: ad44b8bb-07ee-4a2c-ae84-3203d2e332af
transaction:
id: ccapigpaytestmk021826010
country_code: US
currency_code: USD
order:
id: ccapigpaytestmk1771318960
amount: 110
currency_code: USD
Uk-Settled-Status:
value:
- customer:
name: PETER
address:
country_code: UK
sender:
name: RANJITH
address:
street_name: JOHN PETER STREET
building_number: '20'
city: Abis Brasil
postal_code: 69935-000
state: san francisco
country_code: UK
organization_id: '23456789'
birth_date: '2022-09-07'
birth_city: UNITED
birth_country: UK
merchant:
name: JOHN
account:
bank_id: '776889'
number: '8899775544'
address:
country_code: UK
private_id: '78906543'
receiver:
name: MADAN
address:
street_name: JOHN PETER STREET
building_number: '20'
city: Abis Brasil
postal_code: 69935-000
state: san francisco
country_code: UK
organization_id: '23456789'
method:
type: FPS
transaction:
end_to_end_id: r434SKtUcdGQ
id: TYF5678954
amount: 100
uetr: 4f09214d-296c-494b-8e9c-810bf1d9fc93
network_id: clr02052023478
batch_id: batch12345
value_date: '2022-09-07'
creation_date_time: '2022-09-13T08:23:49.112Z'
currency_code: GBP
additional_info: LOAN REPAYMENT
status: SETTLED
description: Transaction settled
remittance_info:
- PURCHASED APPLE LAPTOP
- PURCHASED ADDITIONAL
- customer:
name: PETER
address:
country_code: UK
sender:
name: RANJITH
address:
street_name: JOHN PETER STREET
building_number: '20'
city: Abis Brasil
postal_code: 69935-000
state: san francisco
country_code: UK
organization_id: '23456789'
birth_date: '2022-09-07'
birth_city: UNITED
birth_country: UK
merchant:
name: JOHN
account:
bank_id: '776889'
number: '8899775544'
address:
country_code: UK
private_id: '78906543'
receiver:
name: MADAN
address:
street_name: JOHN PETER STREET
building_number: '20'
city: Abis Brasil
postal_code: 69935-000
state: san francisco
country_code: UK
organization_id: '23456789'
method:
type: FPS
transaction:
end_to_end_id: r434SKtUcdGQ
id: TYF5678954
amount: 999.08
uetr: 4f09214d-296c-494b-8e9c-810bf1d9fc93
network_id: clr02052023478
batch_id: batch12345
value_date: '2022-09-07'
creation_date_time: '2022-09-13T08:23:49.112Z'
currency_code: GBP
additional_info: LOAN REPAYMENT
status: SETTLED
description: Transaction settled
remittance_info:
- PURCHASED APPLE LAPTOP
- PURCHASED ADDITIONAL
Brazil-PIX-Payment-Cancel-Success-Notification-Example:
value:
method:
type: PIX
merchant:
account:
bank_id: '33479023'
transaction:
id: RTP99625446991261440318900
creation_date_time: '2024-09-13T08:23:49.114Z'
country_code: BR
currency_code: BRL
amount: 123.23
status: CANCELLED
reason_code: ACCT
description: Transaction cancelled
status_date_time: '2024-05-26T08:20:49.114Z'
remittance_info:
- Cancellation request
mandate:
id: RR3347902320251109REF12345678
US-Card-Authorize-Request-With-Session-Example:
value:
method:
type: CARD
session_id: ad44b8bb-07ee-4a2c-ae84-3203d2e332af
transaction:
id: card1234567
currency_code: USD
country_code: US
order:
id: order0000001
amount: 323
currency_code: USD
Payment-Created-Notification:
value:
transaction:
id: r434SKtUcdGQ
expiry_time: 1500
update_flag: Y
update_count: 0
status: PENDING
description: Transaction pending action from customer
creation_date_time: '2022-09-13T08:23:49.114Z'
qr_byte_code: iVBORw0KGgoAAAANSUhEUgAAAMgAAADICAYAAACtWK6eAAAYV0lEQVR4Xu3T26osu3JF0f3/P21jmMKmQa+QKlWbg8kO8TAuEaWci/XPf728vCT/aLy8vPwv73+Ql5cPvP9BXl4+8P4HeXn5wPsf5OXlA+9/kJeXD7z/QV5ePvD+B3l5+cD7H+Tl5QPvf5CXlw+8/0FeXj7w/gd5efnA+x/k5eUD73+Ql5cPvP9BXl4+8P4HeXn5wPsf5OXlA+9/kJeXD1z9D/LPP/98NdP+lNuzX1qme4spX9gr7VQu5lNP7VQu5lNPyhfv785Nrl7zobsz7U+5PfulZbq3mPKFvdJO5WI+9dRO5WI+9aR88f7u3OTqtdMH2p/0RPX1S+ubT1rffBf7dV+/8l2qrz/pwp7vrnyX0/4OV6+dPtD+pCeqr19a33zS+ua72K/7+pXvUn39SRf2fHflu5z2d7h6zQf64ZUXlU/3Jt/ZpfYmX61vLrWnfurXVG+X2vtWO+Y3uXrNB/ohlReVT/cm39ml9iZfrW8utad+6tdUb5fa+1Y75je5es0H+iGVly5frV8zUf3SNcXUM7enlikvas93VO9bvLerHfObXL3mA/2QykuXr9avmah+6Zpi6pnbU8uUF7XnO6r3Ld7b1Y75Ta5e84F+SOVSvnh3d57u1xSVn/oTvmca90qX7z2nmPKFPe9XfpOr13ygH1K5lC/e3Z2n+zVF5af+hO+Zxr3S5XvPKaZ8Yc/7ld/k6rXTB1a//MI/mPulawpz96aZqH7p8ovdvKYwL61vLuUXp/0drl47fWD1yy/8B3C/dE1h7t40E9UvXX6xm9cU5qX1zaX84rS/w9Vr/iF2x/1Xv/r/6tO5ydVrPnR33H/1q/+vPp2b3L32ED/UEf1Jlz/9zsK89krXSOX6lRe1N+WlHfNdTvv/Jv9Rr/IP7oj+pMuffmdhXnula6Ry/cqL2pvy0o75Lqf9f5Orr/JDpz+gI/pqme4t7J2Od3a1vrm+U73yT2e6M+X27J9Se/rT7z/h6jUfWA/XN7dXWqZ7C3un451drW+u71Sv/NOZ7ky5Pfun1J7+9PtPuHvtDx+qFnM/2LEn+qdapnyXulP+YsoX9pbWNy/ct1+++S72T++rb3D32h8+VC3m/mEce6J/qmXKd6k75S+mfGFvaX3zwn375ZvvYv/0vvoGd69BPbg+XC3uOfbUk1+52HeqV37NLrv96f7kVy5Tz3tOUT31TX5z9Y96+Lcf6p5jTz35lYt9p3rl1+yy25/uT37lMvW85xTVU9/k6lU/wIer9Z1d7JeusVe4Z19d7PYmfIcj+qf6W7/wvY6U/0uu/pof6Aep9Z1d7JeusVe4Z19d7PYmfIcj+qf6W7/wvY6U/0uu/pof6Aed6vJ3tX7ljuirpfLyT/GOepfTvW/77u36zsRu74Sr1/wgH3yqy9/V+pU7oq+Wyss/xTvqXU73vu27t+s7E7u9E65eu/1A75XWl+rpO1PvNJfJNy+tby6Tb17aMZddX134+7t7J1y9dvuB3iutL9XTd6beaS6Tb15a31wm37y0Yy67vrrw93f3Trh77Q8fWrqmeqI/6cKevzvNr/F31JO/mHKxrxbzpctXO/8J/OQVfmDpmuqJ/qQLe/7uNL/G31FP/mLKxb5azJcuX+38J3D1FX7gNNNe5aJ/S+uLeWlnyqv3Le6X1hfz3b3F1Ku8fmfSN7h6zQ+ZZtqrXPRvaX0xL+1MefW+xf3S+mK+u7eYepXX70z6Blev1QMnv/KFuXvm9k61fuXVm3C/7uiX1jeXya+xp3ZOcd87p/4Nrl6rB05+5Qtz98ztnWr9yqs34X7d0S+tby6TX2NP7ZzivndO/RtcveZDTx9ce6e++UTd0TefqP63fk1hXtoRc3vlT7m6uN074eo1/xCnD669U998ou7om09U/1u/pjAv7Yi5vfKnXF3c7p1w9druH2K3V0z7+jLlhfcde1J+Ufcn7Ktv+WqZ3l++VE9ffYOr1+oPUrr8iWlfX6a88L5jT8ov6v6EffUtXy3T+8uX6umrb3D12vQHKdyrfX21fs23vV0tleurxby0/pSrxfxb7VSuL6f+E65eqw+dcK/29dX6Nd/2drVUrq8W89L6U64W82+1U7m+nPpPuHsNpg93ptyxL/Z3Z9qvXCbfMZ90+RO7vcL9eo/5hL1JT/4NfnP1j/rD6e/mjn2xvzvTfuUy+Y75pMuf2O0V7td7zCfsTXryb3D1av2hyjdXTyPli73p7sKeI/ql9c2L3dzerm9ePf3Sp75apvwGV69Pfzh9c/U0Ur7Ym+4u7DmiX1rfvNjN7e365tXTL33qq2XKb/DT6/4h/SD90/HOri5/uu9ULuUvzEtPfuW7VF9/0kX1ypfVs1/+De5eAx/uB+ifjnd2dfnTfadyKX9hXnryK9+l+vqTLqpXvqye/fJvcPXa9NDy5fSO/Wncm/Q0U9+8cK/GvlrfXNyrsS/lL8zV+lP+b3D1V2592Okd+9O4N+lppr554V6NfbW+ubhXY1/KX5ir9af83+Dqr/hwP3R33Fc7om/f2e05056Uv9jN7elPI5PvyGl+2judm1y95gN9+O64r3ZE376z23OmPSl/sZvb059GJt+R0/y0dzo3uXrNh/pgtbjnVE9/V+tXvrDnTD2Z/MqLqT/dnXKxN+1XXr7s9m5y9Vf8AD9ELe451dPf1fqVL+w5U08mv/Ji6k93p1zsTfuVly+7vZv8K79SH1a6fPXuuKd2zNX6E/bV5Z/+nr1Jl3/6u4tpr/yF+aQn/wa/uQr1hytdvnp33FM75mr9Cfvq8k9/z96kyz/93cW0V/7CfNKTf4OfXPXB0x9uUfmury7qPWpxb+oX7ql3cU8t5uqJ+m51+bVvXpirf8FPrvvw6Q+zqHzXVxf1HrW4N/UL99S7uKcWc/VEfbe6/No3L8zVv+DqdR/sH2R33FfXVE/MT0d281Pcq9/Rn8Y99a4vU0/f/ulI+U+4es0H+kG74766pnpifjqym5/iXv2O/jTuqXd9mXr69k9Hyn/C1Wu7D6yef4CaYsrFvrr8Xa1vLvpqfXO1VO696i3sTf2F/dqbcjntn3D12u4Dq+eH1hRTLvbV5e9qfXPRV+ubq6Vy71VvYW/qL+zX3pTLaf+Eq9emh+rbd6T8wnvul9Y3F/26U775pPWLqV/5pCd/YT5pfUfMq/eEq9emh+rbd6T8wnvul9Y3F/26U775pPWLqV/5pCd/YT5pfUfMq/eEu9cCHz7p8v1D1ExUXz1Rd05z9a5vLuUv6u6kT/36HfNd7E/3n3D3WuDDJ12+f4iaieqrJ+rOaa7e9c2l/EXdnfSpX79jvov96f4T7l77ox6qr97FvfoD7fqOmDv2Spc/3dM3l9M99YT9+j31LrWn7++a3+DutT/qofrqXdyrP9Cu74i5Y690+dM9fXM53VNP2K/fU+9Se/r+rvkNrl779oH1gZMu33uOPXX5Uv2ieuUX0+/qT1rqvrqofXO1fmF/d+8brl799qH1oZMu33uOPXX5Uv2ieuUX0+/qT1rqvrqofXO1fmF/d+8brl7dfagf5shp7siu7x1H9Kt/6ldur/wp3/UrL8zV+pUvqlf+Da5e232gH+TIae7Iru8dR/Srf+pXbq/8Kd/1Ky/M1fqVL6pX/g2uXvOhuw+eet6zP/ky+TVi7hTV03emnrmUvzBXP/VrxNyRKX/C1Ws+dPfBU8979idfJr9GzJ2ievrO1DOX8hfm6qd+jZg7MuVPuHrNh/rgUy3eta+W2hN7u/1vtb65vmNPrW8up/7C/Kme/MWUP+Hq1fVQx3xXi3ftq6X2xN5u/1utb67v2FPrm8upvzB/qid/MeVPuHrVh6onf2G+9Lf+aX7KtF+/U1pfpnxR98oXc3X5ajGftFRe/hOuXvOB6slfmC/9rX+anzLt1++U1pcpX9S98sVcXb5azCctlZf/hLvXgvVwP6D8onqTv5tPvVO869ibcN8RffUtf3qH7PbN1fqVP+HutaA+oPyiepO/m0+9U7zr2Jtw3xF99S1/eofs9s3V+pU/4e61P3ywD9/VzpQ7E/Zqv3yxZ19/d2TyzXd1jb3S+o65lF/YV9/g7rU//MP48F3tTLkzYa/2yxd79vV3RybffFfX2Cut75hL+YV99Q2uXqsHTn7li9NcLfW75e/mC/NdXWNPTvsL96aRytW/9tU3uXq1Hjr5lS9Oc7XU75a/my/Md3WNPTntL9ybRipX/9pX3+TqVR+6tCP6ky7sqcv3fY6UL9WbfHO1vvmk9R1zdflF5eWfUu+6wdVrPtCHm9vb1YU9dfm+z5HypXqTb67WN5+0vmOuLr+ovPxT6l03uHvtj+nB3+bqXd/5Fu/UvVNfvO/eri5/0s4uu3vm7pkXu70n/OT69KHf5upd3/kW79S9U1+8796uLn/Szi67e+bumRe7vSf89npQH1Z/oNLObm5PXb7ou+/Ym6he3T3NxT1Hyi+8N+1PuZz2d7h7bZP6kPrDlXZ2c3vq8kXffcfeRPXq7mku7jlSfuG9aX/K5bS/w91rf0wP9Q/kVE+/9FOme/Wuwl7tn+ryvW++2yutX0z9b/3Kf8FPfmX6AD/UqZ5+6adM9+pdhb3aP9Xle998t1dav5j63/qV/4Krv1IP15/0LtMfTF+tX/m3eHca9ybcr70pL+yrn/rmpfXNS9/g6rV6oP6kd7n1B5zufIt3p3Fvwv3am/LCvvqpb15a37z0De5e+8OHqvUrL+zXHf3KRb/25TRXl//t76t3/ZrqSfmFfe9XLuU/4e61P3yoWr/ywn7d0a9c9GtfTnN1+d/+vnrXr6melF/Y937lUv4Trl57+kD3T/Uua6/2zaee1N6kC3ver/xb/SvfXC1TvtjtfcPVq08f6v6p3mXt1b751JPam3Rhz/uVf6t/5ZurZcoXu71v+M3VP/zD7I6UX1Rfv/Q0xdTT3+3XiPk0xZQvvOeeesI7NfZ/yU+v+2G7I+UX1dcvPU0x9fR3+zViPk0x5Qvvuaee8E6N/V9y9bofUlOYT7qwN/3+lC8qn/bLL6o/+ZUvpryoPX936k1aX+xN/Rtcve7DawrzSRf2pt+f8kXl0375RfUnv/LFlBe15+9OvUnri72pf4Or1+vB9UGTLrznFNWb/NJirtavqd6EvdL6Yu+0/9Tf1fqVP+HqtXpgfcCkC+85RfUmv7SYq/Vrqjdhr7S+2DvtP/V3tX7lT7h6bXpo+Qv3HXtF7Ym90/5TvOcUlZe/8L4zUb1f+wvfa199g6vX6uHmhfuOvaL2xN5p/ynec4rKy19435mo3q/9he+1r77B3WsDfliN/cK9adwT+7vj/qT1d6k9705TmE97+vbNxd7T+QW/uRr4QTX2C/emcU/s7477k9bfpfa8O01hPu3p2zcXe0/nF/zkaj188kvrm+uby25eY2/St3w57S/cm/qLqb+bq3f9Yrf3DT+5Wh84+aX1zfXNZTevsTfpW76c9hfuTf3F1N/N1bt+sdv7ht9cDfzw3Q+rvrp8980L+84t6p6/5xRTvqiev+MU1Zv0rm+u/gW/vQ5+6O4HVl9dvvvmhX3nFnXP33OKKV9Uz99xiupNetc3V/+Cq9frwX7gac857dec4p76lNovv5i+S189+Qtz9VPfXF1+7d/g6rV6oB9w2nNO+zWnuKc+pfbLL6bv0ldP/sJc/dQ3V5df+ze4ew18uB9QetcXe86EvdJOUb3J38V+3Z1y9S1fPfmLypdf+S/46a/4QX5Y6V1f7DkT9ko7RfUmfxf7dXfK1bd89eQvKl9+5b/g6q/4Aacf8nTvVNeIvv2aidP+hHfqfvkT1Z9880nrT/kvuXrdDzr9gKd7p7pG9O3XTJz2J7xT98ufqP7km09af8p/ydXrPri0s8tpX/zd3Xv23dM3L6Ze5fqld32Z8sK9SZd/qif/CVev+cDSzi6nffF3d+/Zd0/fvJh6leuX3vVlygv3Jl3+qZ78J9y99sd66O6D7ddI5fo13/bdm6g7+k719IvK9et+5U719G/xb/3O/3D32h/1AYX9Gqlcv+bbvnsTdUffqZ5+Ubl+3a/cqZ7+Lf6t3/kfrl7zgWp9x1yt/5S6p3/790/v2SutX3n1xJ5616+ZeuZiv3pPuHrNB6r1HXO1/lPqnv7t3z+9Z6+0fuXVE3vqXb9m6pmL/eo94eo1H+jDzaee/VP/V/h7jpz6RfVPf7/6an1zfad6suurZcq/4eo1H+gfxnzq2T/1f4W/58ipX1T/9Perr9Y313eqJ7u+Wqb8G65e8w/hyORXvqhcv/TkO1NPvvUrl+qX1jffpfr+TvUWleurZff3vuHqNR/qyORXvqhcv/TkO1NPvvUrl+qX1jffpfr+TvUWleurZff3vuHqNR94+vCp5z37+ubV01eXX1T+7b1F7VfuSPmLaX9h7p65vdL6jpT/hKvXfOD0QTL1vGdf37x6+uryi8q/vbeo/codKX8x7S/M3TO3V1rfkfKfcPWaH+CD9R0xt1f+Lu57Ry21Zy7Tnky9yiffXD1Rfe87spury7/J1Ws+3AfrO2Jur/xd3PeOWmrPXKY9mXqVT765eqL63ndkN1eXf5Or13YfPulTv7RjXrp879WIvlq/RspfmJcuX6q/y7RnXrr8X3D16u4HTPrUL+2Yly7fezWir9avkfIX5qXLl+rvMu2Zly7/F1y9uvsBU0/fXHZ9tb55+WKvpjjNvesU5moxr99R65ur9c0nv/QNrl47/ZBd31x2fbW+eflir6Y4zb3rFOZqMa/fUeubq/XNJ7/0De5eAz+sPkC/+pMv9p3qFealJ9+8elK5Wt+Rb/PJl/IXlZe/mPIn/ObqH/4B60P0qz/5Yt+pXmFeevLNqyeVq/Ud+TaffCl/UXn5iyl/wm+u/jE93D+wfbW459hT18ipv6i8fk8t5qWdKbdX/fIdMXfs7eKd0/0d7l6D6cF+mH21uOfYU9fIqb+ovH5PLealnSm3V/3yHTF37O3indP9Ha5emx445Yvq+YeYemr9yu2p9c3V5de+uehPdxb27JdvPlF31PrOKd/ufeLqtemBU76onn/AqafWr9yeWt9cXX7tm4v+dGdhz3755hN1R63vnPLt3ifuXvvDD62H609afzffndov3ylO87pbWr+YenWvtP6Ul3/K0/0TfvIr/iHqg/Qnrb+b707tl+8Up3ndLa1fTL26V1p/yss/5en+CT/5lekDzEs7t/Du7kz7lZdv/m1PTv2i+r/2ZfWcym9y99of00PNSzu38O7uTPuVl2/+bU9O/aL6v/Zl9ZzKb3L32h8+uB4+5XLac8R8dwp7ztSrXCZ/GvvytO9MvSl3ZMqfcPfaHz64Hj7lctpzxHx3CnvO1KtcJn8a+/K070y9KXdkyp9w99pD6kPV+pVL9XbvVF7+bep3Tt9fvcmvmaied6q3MJ/0De5ee0j9odT6lUv1du9UXv5t6ndO31+9ya+ZqJ53qrcwn/QNrl7zQ3en9ifsO7s9x73S+jXVk/IX5t6rXF2+2jnNJ+yd6sm/wdWr/sF2p/Yn7Du7Pce90vo11ZPyF+beq1xdvto5zSfsnerJv8HVq6cPtb+0/inuq4upZ17vLa0/UXvqyV94b+ov7O1q/WK3b76794SrV08fav/WB7uvLqaeeb23tP5E7aknf+G9qb+wt6v1i92++e7eE65e9aF+QOWiX/uVT1PYm0ZO/aL6k7877qlr7E24X3vmu1P7N7l6zQf68MpFv/Yrn6awN42c+kX1J3933FPX2Jtwv/bMd6f2b3L1mg/04ZWr9SemvcpL10j5i9rXd+yJ/d2e/qT1J3b3zNWTX5z2d7h6zQf6B6tcrT8x7VVeukbKX9S+vmNP7O/29CetP7G7Z66e/OK0v8PVaz7QP1jl6qfjvV2tbz7pierrqyfqvbv5wl7N1N9l2tOf9C+4et0H+weoXP10vLer9c0nPVF9ffVEvXc3X9irmfq7THv6k/4FV6+fPnjq+wesvrk9tb65Wp7uqcsvplzsq3dxT73rm09+4d7U/4ar104fOPX98Oqb21Prm6vl6Z66/GLKxb56F/fUu7755BfuTf1vuHrNh+6O+2r9ym/NKbv71St/ovr60/1vfXP909yeWt/8F1y96ofsjvtq/cpvzSm7+9Urf6L6+tP9b31z/dPcnlrf/Bf85urLy/8T3v8gLy8feP+DvLx84P0P8vLygfc/yMvLB97/IC8vH3j/g7y8fOD9D/Ly8oH3P8jLywfe/yAvLx94/4O8vHzg/Q/y8vKB9z/Iy8sH3v8gLy8feP+DvLx84P0P8vLygfc/yMvLB97/IC8vH3j/g7y8fOC/Acp9OPj144RMAAAAAElFTkSuQmCC
qr_string: 00020101021226700014br.gov.bcb.pix.citi.com.br/qr/2/8b3da2f39a4140d1a91abd93113bd44 15204000053039865802BR5913Fulano de Tal6008BRASILIA62070503***630464E4
India-Card-Token-Payment-Request-Example:
value:
method:
type: CARD
holder_name:
first_name: kevin
last_name: bob
token_id: '4000000000001091'
token_type: NETWORK_TOKEN
card:
cvv: '123'
last_4_digits: '1234'
expiry_month: '10'
expiry_year: '39'
cryptogram: /wAAAAAAl9SX1HsAmWKSgqwAAAA=
transaction:
id: INDIA234568
amount: 101
currency_code: INR
country_code: IN
order:
amount: 101
currency_code: INR
Alipay-Payment-Capture-Failed-Notification:
value:
method:
type: ALIPAY
transaction:
id: pay02052623456r
amount: 200
currency_code: USD
status: FAILED
description: Transaction failed for invalid payload
reason_code: SC23456
psp_reference: 23dsdsdsj
order:
id: ORD123456
Unauthorized-Example:
value:
ref_id: ec689822-9864-4c4d-9d68-222467627902
error_details:
- issue: User not authorized for this functionality
action: please use valid credentials to access this functionality
code: CC00007
India-Card-Authorize-Request-Example:
value:
method:
type: CARD
holder_name:
first_name: kevin
last_name: bob
card:
cvv: '123'
number: '11223344556677'
expiry_month: '10'
expiry_year: '39'
transaction:
id: INDIA234568
amount: 101
currency_code: INR
country_code: IN
order:
amount: 101
currency_code: INR
Brazil-PIX-Success-Notification-Example:
value:
method:
type: PIX
transaction:
id: RTP99625446991261440318900
uetr: 4f09214d-296c-494b-8e9c-810bf1d9fc93
creation_date_time: '2024-09-13T08:23:49.114Z'
currency_code: BRL
status: PENDING_SETTLEMENT
reason_code: AGND
description: Transaction accepted settlement in process
country_code: BR
status_date_time: '2024-05-26T08:20:49.114Z'
holiday_flag: true
merchant:
account:
bank_id: '33479023'
mandate:
id: RR3347902320251109BRF12345678
Us-Google-Pay-Authorize-Request-With-Session-Example:
value:
customer:
id: '11225367999'
method:
type: GOOGLEPAY
session_id: ad44b8bb-07ee-4a2c-ae84-3203d2e332af
transaction:
id: card1234567
currency_code: USD
country_code: US
order:
id: order0000001
amount: 323
currency_code: USD
US-Card-Verify-Request-With-Session-Example:
value:
method:
type: CARD
session_id: ad44b8bb-07ee-4a2c-ae84-3203d2e332af
transaction:
id: ccapicardstestmk0218260012
country_code: US
currency_code: USD
order:
id: ccapicardstestmk0218260013
amount: 2
currency_code: USD
Us-Paypal-Status:
value:
customer:
id: CST123456
name:
first_name: PAUL
last_name: JOHN
merchant:
name:
first_name: THOKLR
last_name: JOHN
method:
type: PAYPAL
transaction:
id: pay02052623456r
amount: 200
currency_code: USD
status: FAILED
description: Transaction failed for invalid payload
creation_date_time: '2022-09-13T08:23:49.114Z'
update_time: '2022-09-13T08:23:49.114Z'
redirect_url: redirected@url
order:
amount: 200
currency_code: USD
merchant_amount: 200
merchant_currency: USD
status: FAILED
total_auth_amount: 200
total_captured_amount: 200
Qr-Created-Status:
value:
- customer:
id: 8415678edrf
type: BUSINESS
name:
first_name: JOHN
last_name: PETER
merchant:
tax_id: 8.020.340/8910-44
method:
type: PIX
pix:
tax_id: 1.020.340/8910-22
transaction:
id: abcedgh8742323
expiry_time: 2500
creation_date_time: '2022-09-13T08:23:49.112Z'
amount: 305
update_flag: Y
update_count: 0
qr_image: Y
status: CREATED
description: The transaction has successfully been created
additional_info:
- name: LAPTOP
value: PURCHASED APPLE LAPTOP
- name: SOFTWARE
value: PURCHASED ADDITIONAL SOFTWARE
- customer:
id: 8415678edef
type: BUSINESS
name:
first_name: JOHN
last_name: PETER
merchant:
tax_id: 8.020.340/8910-44
method:
type: PIX
pix:
tax_id: 1.020.340/8910-22
transaction:
id: abcedgh8742323
expiry_time: 2501
creation_date_time: '2022-09-13T08:23:49.112Z'
amount: 306
update_flag: Y
update_count: 0
qr_image: Y
status: CREATED
description: The transaction has successfully been created
additional_info:
- name: LAPTOP
value: PURCHASED APPLE LAPTOP
- name: SOFTWARE
value: PURCHASED ADDITIONAL SOFTWARE
US-ACH-Status:
value:
- transaction:
uetr: 4f09214d-296c-494b-8e9c-810bf1d9fc93
creation_date_time: '2022-09-13T08:23:49.114Z'
amount: 1015.5
currency_code: USD
status: SETTLED
description: AC01 - Account Dormant
network_id: '209323283934'
value_date: '2025-03-17'
remittance_info:
- This is sample
end_to_end_id: pay02052023456r
customer:
name:
first_name: Smith
account:
number: '89770098'
bank_id: ABC12345
virtual_number: '91908009856'
address:
country_code: US
postal_code: '31503'
state: Georgia
lines:
- Street No 432, Church Street
merchant:
name: Smith
account:
number: '89770098'
bank_id: ABC12345
virtual_number: '91908009856'
address:
country_code: US
postal_code: '31503'
state: Georgia
lines:
- Street No 432, Church Street
Us-Paypal-Authorize-Request-Example:
value:
customer:
id: '11225367999'
method:
type: PAYPAL
paypal:
browser_payment_operation: INITIATE
payment_confirmation: CONFIRM_AT_MERCHANT
transaction:
id: card1234567
currency_code: USD
country_code: US
update_flag: Y
url:
browser_payment_return: http://www.mastercard.com
order:
id: order0000001
amount: 323
currency_code: USD
Applepay-Payment-Response-Example:
value:
order:
amount: 200
currency_code: USD
merchant_amount: 200
merchant_currency: USD
status: AUTHORIZED
total_auth_amount: 100
total_captured_amount: 0
total_disbursed_amount: 0
total_refunded_amount: 0
id: TX0250117002
creation_time: '2025-01-17T13:10:23.973Z'
update_time: '2025-01-17T13:10:24.351Z'
transaction:
authorizationResponse:
posEntryMode: '812'
returnAci: '8'
stan: '144032'
transactionIdentifier: '123456789012345'
commercialCardIndicator: '3'
posData: '1025104006600'
processingCode: '003000'
responseCode: '00'
acquirer:
transaction_id: '123456789012345'
batch: '20250117'
date: '0117'
merchant_id: '120240306011001'
type: AUTHORIZATION
terminal: 0791
response:
acquirer_code: '00'
acquirer_message: Approved
id: ORD_20250117_002
amount: 100
currency_code: USD
status: SUCCESS
description: APPROVED
creation_date_time: '2025-01-17T13:10:24.019Z'
update_time: '2025-01-17T13:10:24.351Z'
receipt: '501713144032'
authorization_code: '144032'
method:
CARD:
number: 401200xxxxxx0026
expiry_month: '1'
expiry_year: '39'
fundingMethod: CREDIT
stored_on_file: NOT_STORED
Us-Google-Pay-Verify-With-Token-Request-Example:
value:
customer:
id: '123456789'
merchant:
name: Wilson
method:
type: GOOGLEPAY
token_id: 5613dc38-ba17-446c-8c18-ae89f79de596
token_type: CITI_TOKEN
card:
cvv: '123'
transaction:
id: ccapigpaytestmk021826010
country_code: US
currency_code: USD
order:
id: ccapigpaytestmk1771318960
amount: 110
currency_code: USD
Payment-Failed-Thailand-IP-Credit-Status-Notification:
value:
transaction:
id: REF123456
end_to_end_id: ref34SKtUcdGQ
uetr: 4f09214d-296c-494b-8e9c-810bf1d9fc93
network_id: clr02052023478
batch_id: batch12345
value_date: '2022-09-07'
creation_date_time: '2022-09-13T08:23:49.112Z'
status_date_time: '2022-09-14T08:00:00.000Z'
bill_id_1: '77889900'
bill_id_2: '77889901'
bill_id_3: '77889902'
purpose: PAYMENT
processing_code: '58000'
tax_id: '2'
wht_code: A
wht_rate: 10
wht_amount: 1000
income_type: '001'
bill_due_date: '2022-09-07'
vat_rate: 10
vat_amount: 1000
amount: 5000
currency_code: THB
additional_info: Credit Payment
reference: payment for september
status: FAILED
reason_code: CFP009
description: Transaction has been rejected/cancelled after compliance review.
merchant:
account:
number: '123456'
virtual_account: '998877'
bank_id: CITITHBX
branch_id: '123'
proxy_id: raja@citi.com
proxy_type: BIID
tax_id: tax123
name: Thomas
customer:
account:
number: '987654'
virtual_account: '1122334455'
bank_id: CITITHBX
branch_id: '123'
proxy_id: raja@citi.com
proxy_type: BIID
tax_id: tax123
name:
first_name: Wilson
sender:
name: Gary
address:
city: Phuket
country_code: TH
method:
type: IP
Method-Not-Allowed-Gateway-Error-Example:
value:
httpCode: '405'
httpMessage: Method Not Allowed
moreInformation: The method is not allowed for the requested URL
Brazil-PIX-Cancellation-Request-Example:
value:
transaction:
id: RFP99341778674913690215632
reason: ACCT
country_code: BR
Us-Applepay-Status:
value:
customer:
id: CST123456
name:
first_name: PAUL
last_name: JOHN
merchant:
name:
first_name: THOKLR
last_name: JOHN
method:
type: APPLEPAY
transaction:
id: pay02052623456r
amount: 200
currency_code: USD
status: FAILED
description: Transaction failed for invalid payload
creation_date_time: '2022-09-13T08:23:49.114Z'
update_time: '2022-09-13T08:23:49.114Z'
redirect_url: redirected@url
order:
amount: 200
currency_code: USD
merchant_amount: 200
merchant_currency: USD
status: FAILED
total_auth_amount: 200
total_captured_amount: 200
Us-Google-Pay-Capture-Request-Example:
value:
customer:
id: '123456789'
method:
type: GOOGLEPAY
transaction:
id: ccapigpaytestmk021826010
country_code: US
amount: 110
currency_code: USD
order:
id: ccapigpaytestmk1771318960
Unsupported-Media-Type-Example:
value:
ref_id: ec689822-9864-4c4d-9d68-222467627902
error_details:
- issue: Media type not supported
action: please use valid content-type in header
code: CC00002
Us-Paypal-Capture-Request-Example:
value:
customer:
id: '11225367999'
method:
type: PAYPAL
transaction:
id: card1234567
amount: 100
currency_code: USD
country_code: US
order:
id: order0000001
Alipay-Link-Sucess-Notification:
value:
customer:
name:
first_name: john
last_name: peter
email: customer@gmail.com
method:
type: ALIPAY
transaction:
id: pay02052623456r
psp_reference: PYMT123456
amount: 200
currency_code: USD
country_code: US
status: PENDING
description: Pending action from customer.
creation_date_time: '2022-09-13T08:23:49.114Z'
redirect_url: redirect@abc
Internal-Server-Gateway-Error-Example:
value:
httpCode: '500'
httpMessage: Internal Server Error
moreInformation: unable to serve your request at this moment
Qrpix-Payment-Cancel-Request-Example:
value:
transaction:
id: r434SKtUcdGQ12345678901234
US-Alipay-Payment-Capture-Success-Notification:
value:
method:
type: ALIPAY
transaction:
id: pay02052623456r
amount: 200
currency_code: USD
status: SUCCESS
description: Transaction failed for invalid payload
psp_reference: 23dsdsdsj
order:
id: ORD123456
Idempotency-Id-Conflict-Example:
value:
ref_id: ec689822-9864-4c4d-9d68-222467627902
error_details:
- issue: Idempotency-Id provided is currently being used in another request
action: please do not repeat the same request again
code: VC00016
US-Card-Verify-Request-With-Card-Example:
value:
method:
type: CARD
card:
number: '4012000033330026'
expiry_month: '01'
expiry_year: '39'
cvv: '123'
transaction:
id: ccapicardstestmk0218260012
country_code: US
currency_code: USD
order:
id: ccapicardstestmk0218260013
amount: 2
currency_code: USD
US-Card-Payment-Request-With-Session-Example:
value:
method:
type: CARD
session_id: ad44b8bb-07ee-4a2c-ae84-3203d2e332af
transaction:
id: card1234567
currency_code: USD
country_code: US
order:
id: order0000001
amount: 323
currency_code: USD
Qr-Pending-Status:
value:
- customer:
id: 8415678edrf
type: BUSINESS
name:
first_name: JOHN
last_name: PETER
merchant:
tax_id: 8.020.340/8910-44
method:
type: PIX
pix:
tax_id: 1.020.340/8910-22
transaction:
id: abcedgh8742323
expiry_time: 2500
creation_date_time: '2022-09-13T08:23:49.112Z'
amount: 305
update_flag: Y
update_count: 0
qr_image: Y
status: PENDING
description: Pending action from customer
qr_byte_code: iVBORw0KGgoAAAANSUhEUgAAAMgAAADICAYAAACtWK6eAAAYV0lEQVR4Xu3T26osu3JF0f3/P21jmMKmQa+QKlWbg8kO8TAuEaWci/XPf728vCT/aLy8vPwv73+Ql5cPvP9BXl4+8P4HeXn5wPsf5OXlA+9/kJeXD7z/QV5ePvD+B3l5+cD7H+Tl5QPvf5CXlw+8/0FeXj7w/gd5efnA+x/k5eUD73+Ql5cPvP9BXl4+8P4HeXn5wPsf5OXlA+9/kJeXD1z9D/LPP/98NdP+lNuzX1qme4spX9gr7VQu5lNP7VQu5lNPyhfv785Nrl7zobsz7U+5PfulZbq3mPKFvdJO5WI+9dRO5WI+9aR88f7u3OTqtdMH2p/0RPX1S+ubT1rffBf7dV+/8l2qrz/pwp7vrnyX0/4OV6+dPtD+pCeqr19a33zS+ua72K/7+pXvUn39SRf2fHflu5z2d7h6zQf64ZUXlU/3Jt/ZpfYmX61vLrWnfurXVG+X2vtWO+Y3uXrNB/ohlReVT/cm39ml9iZfrW8utad+6tdUb5fa+1Y75je5es0H+iGVly5frV8zUf3SNcXUM7enlikvas93VO9bvLerHfObXL3mA/2QykuXr9avmah+6Zpi6pnbU8uUF7XnO6r3Ld7b1Y75Ta5e84F+SOVSvnh3d57u1xSVn/oTvmca90qX7z2nmPKFPe9XfpOr13ygH1K5lC/e3Z2n+zVF5af+hO+Zxr3S5XvPKaZ8Yc/7ld/k6rXTB1a//MI/mPulawpz96aZqH7p8ovdvKYwL61vLuUXp/0drl47fWD1yy/8B3C/dE1h7t40E9UvXX6xm9cU5qX1zaX84rS/w9Vr/iF2x/1Xv/r/6tO5ydVrPnR33H/1q/+vPp2b3L32ED/UEf1Jlz/9zsK89krXSOX6lRe1N+WlHfNdTvv/Jv9Rr/IP7oj+pMuffmdhXnula6Ry/cqL2pvy0o75Lqf9f5Orr/JDpz+gI/pqme4t7J2Od3a1vrm+U73yT2e6M+X27J9Se/rT7z/h6jUfWA/XN7dXWqZ7C3un451drW+u71Sv/NOZ7ky5Pfun1J7+9PtPuHvtDx+qFnM/2LEn+qdapnyXulP+YsoX9pbWNy/ct1+++S72T++rb3D32h8+VC3m/mEce6J/qmXKd6k75S+mfGFvaX3zwn375ZvvYv/0vvoGd69BPbg+XC3uOfbUk1+52HeqV37NLrv96f7kVy5Tz3tOUT31TX5z9Y96+Lcf6p5jTz35lYt9p3rl1+yy25/uT37lMvW85xTVU9/k6lU/wIer9Z1d7JeusVe4Z19d7PYmfIcj+qf6W7/wvY6U/0uu/pof6Aep9Z1d7JeusVe4Z19d7PYmfIcj+qf6W7/wvY6U/0uu/pof6Aed6vJ3tX7ljuirpfLyT/GOepfTvW/77u36zsRu74Sr1/wgH3yqy9/V+pU7oq+Wyss/xTvqXU73vu27t+s7E7u9E65eu/1A75XWl+rpO1PvNJfJNy+tby6Tb17aMZddX134+7t7J1y9dvuB3iutL9XTd6beaS6Tb15a31wm37y0Yy67vrrw93f3Trh77Q8fWrqmeqI/6cKevzvNr/F31JO/mHKxrxbzpctXO/8J/OQVfmDpmuqJ/qQLe/7uNL/G31FP/mLKxb5azJcuX+38J3D1FX7gNNNe5aJ/S+uLeWlnyqv3Le6X1hfz3b3F1Ku8fmfSN7h6zQ+ZZtqrXPRvaX0xL+1MefW+xf3S+mK+u7eYepXX70z6Blev1QMnv/KFuXvm9k61fuXVm3C/7uiX1jeXya+xp3ZOcd87p/4Nrl6rB05+5Qtz98ztnWr9yqs34X7d0S+tby6TX2NP7ZzivndO/RtcveZDTx9ce6e++UTd0TefqP63fk1hXtoRc3vlT7m6uN074eo1/xCnD669U998ou7om09U/1u/pjAv7Yi5vfKnXF3c7p1w9druH2K3V0z7+jLlhfcde1J+Ufcn7Ktv+WqZ3l++VE9ffYOr1+oPUrr8iWlfX6a88L5jT8ov6v6EffUtXy3T+8uX6umrb3D12vQHKdyrfX21fs23vV0tleurxby0/pSrxfxb7VSuL6f+E65eqw+dcK/29dX6Nd/2drVUrq8W89L6U64W82+1U7m+nPpPuHsNpg93ptyxL/Z3Z9qvXCbfMZ90+RO7vcL9eo/5hL1JT/4NfnP1j/rD6e/mjn2xvzvTfuUy+Y75pMuf2O0V7td7zCfsTXryb3D1av2hyjdXTyPli73p7sKeI/ql9c2L3dzerm9ePf3Sp75apvwGV69Pfzh9c/U0Ur7Ym+4u7DmiX1rfvNjN7e365tXTL33qq2XKb/DT6/4h/SD90/HOri5/uu9ULuUvzEtPfuW7VF9/0kX1ypfVs1/+De5eAx/uB+ifjnd2dfnTfadyKX9hXnryK9+l+vqTLqpXvqye/fJvcPXa9NDy5fSO/Wncm/Q0U9+8cK/GvlrfXNyrsS/lL8zV+lP+b3D1V2592Okd+9O4N+lppr554V6NfbW+ubhXY1/KX5ir9af83+Dqr/hwP3R33Fc7om/f2e05056Uv9jN7elPI5PvyGl+2judm1y95gN9+O64r3ZE376z23OmPSl/sZvb059GJt+R0/y0dzo3uXrNh/pgtbjnVE9/V+tXvrDnTD2Z/MqLqT/dnXKxN+1XXr7s9m5y9Vf8AD9ELe451dPf1fqVL+w5U08mv/Ji6k93p1zsTfuVly+7vZv8K79SH1a6fPXuuKd2zNX6E/bV5Z/+nr1Jl3/6u4tpr/yF+aQn/wa/uQr1hytdvnp33FM75mr9Cfvq8k9/z96kyz/93cW0V/7CfNKTf4OfXPXB0x9uUfmury7qPWpxb+oX7ql3cU8t5uqJ+m51+bVvXpirf8FPrvvw6Q+zqHzXVxf1HrW4N/UL99S7uKcWc/VEfbe6/No3L8zVv+DqdR/sH2R33FfXVE/MT0d281Pcq9/Rn8Y99a4vU0/f/ulI+U+4es0H+kG74766pnpifjqym5/iXv2O/jTuqXd9mXr69k9Hyn/C1Wu7D6yef4CaYsrFvrr8Xa1vLvpqfXO1VO696i3sTf2F/dqbcjntn3D12u4Dq+eH1hRTLvbV5e9qfXPRV+ubq6Vy71VvYW/qL+zX3pTLaf+Eq9emh+rbd6T8wnvul9Y3F/26U775pPWLqV/5pCd/YT5pfUfMq/eEq9emh+rbd6T8wnvul9Y3F/26U775pPWLqV/5pCd/YT5pfUfMq/eEu9cCHz7p8v1D1ExUXz1Rd05z9a5vLuUv6u6kT/36HfNd7E/3n3D3WuDDJ12+f4iaieqrJ+rOaa7e9c2l/EXdnfSpX79jvov96f4T7l77ox6qr97FvfoD7fqOmDv2Spc/3dM3l9M99YT9+j31LrWn7++a3+DutT/qofrqXdyrP9Cu74i5Y690+dM9fXM53VNP2K/fU+9Se/r+rvkNrl779oH1gZMu33uOPXX5Uv2ieuUX0+/qT1rqvrqofXO1fmF/d+8brl799qH1oZMu33uOPXX5Uv2ieuUX0+/qT1rqvrqofXO1fmF/d+8brl7dfagf5shp7siu7x1H9Kt/6ldur/wp3/UrL8zV+pUvqlf+Da5e232gH+TIae7Iru8dR/Srf+pXbq/8Kd/1Ky/M1fqVL6pX/g2uXvOhuw+eet6zP/ky+TVi7hTV03emnrmUvzBXP/VrxNyRKX/C1Ws+dPfBU8979idfJr9GzJ2ievrO1DOX8hfm6qd+jZg7MuVPuHrNh/rgUy3eta+W2hN7u/1vtb65vmNPrW8up/7C/Kme/MWUP+Hq1fVQx3xXi3ftq6X2xN5u/1utb67v2FPrm8upvzB/qid/MeVPuHrVh6onf2G+9Lf+aX7KtF+/U1pfpnxR98oXc3X5ajGftFRe/hOuXvOB6slfmC/9rX+anzLt1++U1pcpX9S98sVcXb5azCctlZf/hLvXgvVwP6D8onqTv5tPvVO869ibcN8RffUtf3qH7PbN1fqVP+HutaA+oPyiepO/m0+9U7zr2Jtw3xF99S1/eofs9s3V+pU/4e61P3ywD9/VzpQ7E/Zqv3yxZ19/d2TyzXd1jb3S+o65lF/YV9/g7rU//MP48F3tTLkzYa/2yxd79vV3RybffFfX2Cut75hL+YV99Q2uXqsHTn7li9NcLfW75e/mC/NdXWNPTvsL96aRytW/9tU3uXq1Hjr5lS9Oc7XU75a/my/Md3WNPTntL9ybRipX/9pX3+TqVR+6tCP6ky7sqcv3fY6UL9WbfHO1vvmk9R1zdflF5eWfUu+6wdVrPtCHm9vb1YU9dfm+z5HypXqTb67WN5+0vmOuLr+ovPxT6l03uHvtj+nB3+bqXd/5Fu/UvVNfvO/eri5/0s4uu3vm7pkXu70n/OT69KHf5upd3/kW79S9U1+8796uLn/Szi67e+bumRe7vSf89npQH1Z/oNLObm5PXb7ou+/Ym6he3T3NxT1Hyi+8N+1PuZz2d7h7bZP6kPrDlXZ2c3vq8kXffcfeRPXq7mku7jlSfuG9aX/K5bS/w91rf0wP9Q/kVE+/9FOme/Wuwl7tn+ryvW++2yutX0z9b/3Kf8FPfmX6AD/UqZ5+6adM9+pdhb3aP9Xle998t1dav5j63/qV/4Krv1IP15/0LtMfTF+tX/m3eHca9ybcr70pL+yrn/rmpfXNS9/g6rV6oP6kd7n1B5zufIt3p3Fvwv3am/LCvvqpb15a37z0De5e+8OHqvUrL+zXHf3KRb/25TRXl//t76t3/ZrqSfmFfe9XLuU/4e61P3yoWr/ywn7d0a9c9GtfTnN1+d/+vnrXr6melF/Y937lUv4Trl57+kD3T/Uua6/2zaee1N6kC3ver/xb/SvfXC1TvtjtfcPVq08f6v6p3mXt1b751JPam3Rhz/uVf6t/5ZurZcoXu71v+M3VP/zD7I6UX1Rfv/Q0xdTT3+3XiPk0xZQvvOeeesI7NfZ/yU+v+2G7I+UX1dcvPU0x9fR3+zViPk0x5Qvvuaee8E6N/V9y9bofUlOYT7qwN/3+lC8qn/bLL6o/+ZUvpryoPX936k1aX+xN/Rtcve7DawrzSRf2pt+f8kXl0375RfUnv/LFlBe15+9OvUnri72pf4Or1+vB9UGTLrznFNWb/NJirtavqd6EvdL6Yu+0/9Tf1fqVP+HqtXpgfcCkC+85RfUmv7SYq/Vrqjdhr7S+2DvtP/V3tX7lT7h6bXpo+Qv3HXtF7Ym90/5TvOcUlZe/8L4zUb1f+wvfa199g6vX6uHmhfuOvaL2xN5p/ynec4rKy19435mo3q/9he+1r77B3WsDfliN/cK9adwT+7vj/qT1d6k9705TmE97+vbNxd7T+QW/uRr4QTX2C/emcU/s7477k9bfpfa8O01hPu3p2zcXe0/nF/zkaj188kvrm+uby25eY2/St3w57S/cm/qLqb+bq3f9Yrf3DT+5Wh84+aX1zfXNZTevsTfpW76c9hfuTf3F1N/N1bt+sdv7ht9cDfzw3Q+rvrp8980L+84t6p6/5xRTvqiev+MU1Zv0rm+u/gW/vQ5+6O4HVl9dvvvmhX3nFnXP33OKKV9Uz99xiupNetc3V/+Cq9frwX7gac857dec4p76lNovv5i+S189+Qtz9VPfXF1+7d/g6rV6oB9w2nNO+zWnuKc+pfbLL6bv0ldP/sJc/dQ3V5df+ze4ew18uB9QetcXe86EvdJOUb3J38V+3Z1y9S1fPfmLypdf+S/46a/4QX5Y6V1f7DkT9ko7RfUmfxf7dXfK1bd89eQvKl9+5b/g6q/4Aacf8nTvVNeIvv2aidP+hHfqfvkT1Z9880nrT/kvuXrdDzr9gKd7p7pG9O3XTJz2J7xT98ufqP7km09af8p/ydXrPri0s8tpX/zd3Xv23dM3L6Ze5fqld32Z8sK9SZd/qif/CVev+cDSzi6nffF3d+/Zd0/fvJh6leuX3vVlygv3Jl3+qZ78J9y99sd66O6D7ddI5fo13/bdm6g7+k719IvK9et+5U719G/xb/3O/3D32h/1AYX9Gqlcv+bbvnsTdUffqZ5+Ubl+3a/cqZ7+Lf6t3/kfrl7zgWp9x1yt/5S6p3/790/v2SutX3n1xJ5616+ZeuZiv3pPuHrNB6r1HXO1/lPqnv7t3z+9Z6+0fuXVE3vqXb9m6pmL/eo94eo1H+jDzaee/VP/V/h7jpz6RfVPf7/6an1zfad6suurZcq/4eo1H+gfxnzq2T/1f4W/58ipX1T/9Perr9Y313eqJ7u+Wqb8G65e8w/hyORXvqhcv/TkO1NPvvUrl+qX1jffpfr+TvUWleurZff3vuHqNR/qyORXvqhcv/TkO1NPvvUrl+qX1jffpfr+TvUWleurZff3vuHqNR94+vCp5z37+ubV01eXX1T+7b1F7VfuSPmLaX9h7p65vdL6jpT/hKvXfOD0QTL1vGdf37x6+uryi8q/vbeo/codKX8x7S/M3TO3V1rfkfKfcPWaH+CD9R0xt1f+Lu57Ry21Zy7Tnky9yiffXD1Rfe87spury7/J1Ws+3AfrO2Jur/xd3PeOWmrPXKY9mXqVT765eqL63ndkN1eXf5Or13YfPulTv7RjXrp879WIvlq/RspfmJcuX6q/y7RnXrr8X3D16u4HTPrUL+2Yly7fezWir9avkfIX5qXLl+rvMu2Zly7/F1y9uvsBU0/fXHZ9tb55+WKvpjjNvesU5moxr99R65ur9c0nv/QNrl47/ZBd31x2fbW+eflir6Y4zb3rFOZqMa/fUeubq/XNJ7/0De5eAz+sPkC/+pMv9p3qFealJ9+8elK5Wt+Rb/PJl/IXlZe/mPIn/ObqH/4B60P0qz/5Yt+pXmFeevLNqyeVq/Ud+TaffCl/UXn5iyl/wm+u/jE93D+wfbW459hT18ipv6i8fk8t5qWdKbdX/fIdMXfs7eKd0/0d7l6D6cF+mH21uOfYU9fIqb+ovH5PLealnSm3V/3yHTF37O3indP9Ha5emx445Yvq+YeYemr9yu2p9c3V5de+uehPdxb27JdvPlF31PrOKd/ufeLqtemBU76onn/AqafWr9yeWt9cXX7tm4v+dGdhz3755hN1R63vnPLt3ifuXvvDD62H609afzffndov3ylO87pbWr+YenWvtP6Ul3/K0/0TfvIr/iHqg/Qnrb+b707tl+8Up3ndLa1fTL26V1p/yss/5en+CT/5lekDzEs7t/Du7kz7lZdv/m1PTv2i+r/2ZfWcym9y99of00PNSzu38O7uTPuVl2/+bU9O/aL6v/Zl9ZzKb3L32h8+uB4+5XLac8R8dwp7ztSrXCZ/GvvytO9MvSl3ZMqfcPfaHz64Hj7lctpzxHx3CnvO1KtcJn8a+/K070y9KXdkyp9w99pD6kPV+pVL9XbvVF7+bep3Tt9fvcmvmaied6q3MJ/0De5ee0j9odT6lUv1du9UXv5t6ndO31+9ya+ZqJ53qrcwn/QNrl7zQ3en9ifsO7s9x73S+jXVk/IX5t6rXF2+2jnNJ+yd6sm/wdWr/sF2p/Yn7Du7Pce90vo11ZPyF+beq1xdvto5zSfsnerJv8HVq6cPtb+0/inuq4upZ17vLa0/UXvqyV94b+ov7O1q/WK3b76794SrV08fav/WB7uvLqaeeb23tP5E7aknf+G9qb+wt6v1i92++e7eE65e9aF+QOWiX/uVT1PYm0ZO/aL6k7877qlr7E24X3vmu1P7N7l6zQf68MpFv/Yrn6awN42c+kX1J3933FPX2Jtwv/bMd6f2b3L1mg/04ZWr9SemvcpL10j5i9rXd+yJ/d2e/qT1J3b3zNWTX5z2d7h6zQf6B6tcrT8x7VVeukbKX9S+vmNP7O/29CetP7G7Z66e/OK0v8PVaz7QP1jl6qfjvV2tbz7pierrqyfqvbv5wl7N1N9l2tOf9C+4et0H+weoXP10vLer9c0nPVF9ffVEvXc3X9irmfq7THv6k/4FV6+fPnjq+wesvrk9tb65Wp7uqcsvplzsq3dxT73rm09+4d7U/4ar104fOPX98Oqb21Prm6vl6Z66/GLKxb56F/fUu7755BfuTf1vuHrNh+6O+2r9ym/NKbv71St/ovr60/1vfXP909yeWt/8F1y96ofsjvtq/cpvzSm7+9Urf6L6+tP9b31z/dPcnlrf/Bf85urLy/8T3v8gLy8feP+DvLx84P0P8vLygfc/yMvLB97/IC8vH3j/g7y8fOD9D/Ly8oH3P8jLywfe/yAvLx94/4O8vHzg/Q/y8vKB9z/Iy8sH3v8gLy8feP+DvLx84P0P8vLygfc/yMvLB97/IC8vH3j/g7y8fOC/Acp9OPj144RMAAAAAElFTkSuQmCC
qr_string: 00020101021226700014br.gov.bcb.pix.citi.com.br/qr/2/8b3da2f39a4140d1a91abd93113bd44 15204000053039865802BR5913Fulano de Tal6008BRASILIA62070503***630464E4
additional_info:
- name: LAPTOP
value: PURCHASED APPLE LAPTOP
- name: SOFTWARE
value: PURCHASED ADDITIONAL SOFTWARE
- customer:
id: 8415678edrf
type: BUSINESS
name:
first_name: JOHN
last_name: PETER
merchant:
tax_id: 8.020.340/8910-44
method:
type: PIX
pix:
tax_id: 1.020.340/8910-22
transaction:
id: abcedgh8742323
expiry_time: 2500
creation_date_time: '2022-09-13T08:23:49.112Z'
amount: 201
update_flag: Y
update_count: 0
qr_image: Y
status: PENDING
description: Transaction pending action from customer
qr_byte_code: iVBORw0KGgoAAAANSUhEUgAAAMgAAADICAYAAACtWK6eAAAYV0lEQVR4Xu3T26osu3JF0f3/P21jmMKmQa+QKlWbg8kO8TAuEaWci/XPf728vCT/aLy8vPwv73+Ql5cPvP9BXl4+8P4HeXn5wPsf5OXlA+9/kJeXD7z/QV5ePvD+B3l5+cD7H+Tl5QPvf5CXlw+8/0FeXj7w/gd5efnA+x/k5eUD73+Ql5cPvP9BXl4+8P4HeXn5wPsf5OXlA+9/kJeXD1z9D/LPP/98NdP+lNuzX1qme4spX9gr7VQu5lNP7VQu5lNPyhfv785Nrl7zobsz7U+5PfulZbq3mPKFvdJO5WI+9dRO5WI+9aR88f7u3OTqtdMH2p/0RPX1S+ubT1rffBf7dV+/8l2qrz/pwp7vrnyX0/4OV6+dPtD+pCeqr19a33zS+ua72K/7+pXvUn39SRf2fHflu5z2d7h6zQf64ZUXlU/3Jt/ZpfYmX61vLrWnfurXVG+X2vtWO+Y3uXrNB/ohlReVT/cm39ml9iZfrW8utad+6tdUb5fa+1Y75je5es0H+iGVly5frV8zUf3SNcXUM7enlikvas93VO9bvLerHfObXL3mA/2QykuXr9avmah+6Zpi6pnbU8uUF7XnO6r3Ld7b1Y75Ta5e84F+SOVSvnh3d57u1xSVn/oTvmca90qX7z2nmPKFPe9XfpOr13ygH1K5lC/e3Z2n+zVF5af+hO+Zxr3S5XvPKaZ8Yc/7ld/k6rXTB1a//MI/mPulawpz96aZqH7p8ovdvKYwL61vLuUXp/0drl47fWD1yy/8B3C/dE1h7t40E9UvXX6xm9cU5qX1zaX84rS/w9Vr/iF2x/1Xv/r/6tO5ydVrPnR33H/1q/+vPp2b3L32ED/UEf1Jlz/9zsK89krXSOX6lRe1N+WlHfNdTvv/Jv9Rr/IP7oj+pMuffmdhXnula6Ry/cqL2pvy0o75Lqf9f5Orr/JDpz+gI/pqme4t7J2Od3a1vrm+U73yT2e6M+X27J9Se/rT7z/h6jUfWA/XN7dXWqZ7C3un451drW+u71Sv/NOZ7ky5Pfun1J7+9PtPuHvtDx+qFnM/2LEn+qdapnyXulP+YsoX9pbWNy/ct1+++S72T++rb3D32h8+VC3m/mEce6J/qmXKd6k75S+mfGFvaX3zwn375ZvvYv/0vvoGd69BPbg+XC3uOfbUk1+52HeqV37NLrv96f7kVy5Tz3tOUT31TX5z9Y96+Lcf6p5jTz35lYt9p3rl1+yy25/uT37lMvW85xTVU9/k6lU/wIer9Z1d7JeusVe4Z19d7PYmfIcj+qf6W7/wvY6U/0uu/pof6Aep9Z1d7JeusVe4Z19d7PYmfIcj+qf6W7/wvY6U/0uu/pof6Aed6vJ3tX7ljuirpfLyT/GOepfTvW/77u36zsRu74Sr1/wgH3yqy9/V+pU7oq+Wyss/xTvqXU73vu27t+s7E7u9E65eu/1A75XWl+rpO1PvNJfJNy+tby6Tb17aMZddX134+7t7J1y9dvuB3iutL9XTd6beaS6Tb15a31wm37y0Yy67vrrw93f3Trh77Q8fWrqmeqI/6cKevzvNr/F31JO/mHKxrxbzpctXO/8J/OQVfmDpmuqJ/qQLe/7uNL/G31FP/mLKxb5azJcuX+38J3D1FX7gNNNe5aJ/S+uLeWlnyqv3Le6X1hfz3b3F1Ku8fmfSN7h6zQ+ZZtqrXPRvaX0xL+1MefW+xf3S+mK+u7eYepXX70z6Blev1QMnv/KFuXvm9k61fuXVm3C/7uiX1jeXya+xp3ZOcd87p/4Nrl6rB05+5Qtz98ztnWr9yqs34X7d0S+tby6TX2NP7ZzivndO/RtcveZDTx9ce6e++UTd0TefqP63fk1hXtoRc3vlT7m6uN074eo1/xCnD669U998ou7om09U/1u/pjAv7Yi5vfKnXF3c7p1w9druH2K3V0z7+jLlhfcde1J+Ufcn7Ktv+WqZ3l++VE9ffYOr1+oPUrr8iWlfX6a88L5jT8ov6v6EffUtXy3T+8uX6umrb3D12vQHKdyrfX21fs23vV0tleurxby0/pSrxfxb7VSuL6f+E65eqw+dcK/29dX6Nd/2drVUrq8W89L6U64W82+1U7m+nPpPuHsNpg93ptyxL/Z3Z9qvXCbfMZ90+RO7vcL9eo/5hL1JT/4NfnP1j/rD6e/mjn2xvzvTfuUy+Y75pMuf2O0V7td7zCfsTXryb3D1av2hyjdXTyPli73p7sKeI/ql9c2L3dzerm9ePf3Sp75apvwGV69Pfzh9c/U0Ur7Ym+4u7DmiX1rfvNjN7e365tXTL33qq2XKb/DT6/4h/SD90/HOri5/uu9ULuUvzEtPfuW7VF9/0kX1ypfVs1/+De5eAx/uB+ifjnd2dfnTfadyKX9hXnryK9+l+vqTLqpXvqye/fJvcPXa9NDy5fSO/Wncm/Q0U9+8cK/GvlrfXNyrsS/lL8zV+lP+b3D1V2592Okd+9O4N+lppr554V6NfbW+ubhXY1/KX5ir9af83+Dqr/hwP3R33Fc7om/f2e05056Uv9jN7elPI5PvyGl+2judm1y95gN9+O64r3ZE376z23OmPSl/sZvb059GJt+R0/y0dzo3uXrNh/pgtbjnVE9/V+tXvrDnTD2Z/MqLqT/dnXKxN+1XXr7s9m5y9Vf8AD9ELe451dPf1fqVL+w5U08mv/Ji6k93p1zsTfuVly+7vZv8K79SH1a6fPXuuKd2zNX6E/bV5Z/+nr1Jl3/6u4tpr/yF+aQn/wa/uQr1hytdvnp33FM75mr9Cfvq8k9/z96kyz/93cW0V/7CfNKTf4OfXPXB0x9uUfmury7qPWpxb+oX7ql3cU8t5uqJ+m51+bVvXpirf8FPrvvw6Q+zqHzXVxf1HrW4N/UL99S7uKcWc/VEfbe6/No3L8zVv+DqdR/sH2R33FfXVE/MT0d281Pcq9/Rn8Y99a4vU0/f/ulI+U+4es0H+kG74766pnpifjqym5/iXv2O/jTuqXd9mXr69k9Hyn/C1Wu7D6yef4CaYsrFvrr8Xa1vLvpqfXO1VO696i3sTf2F/dqbcjntn3D12u4Dq+eH1hRTLvbV5e9qfXPRV+ubq6Vy71VvYW/qL+zX3pTLaf+Eq9emh+rbd6T8wnvul9Y3F/26U775pPWLqV/5pCd/YT5pfUfMq/eEq9emh+rbd6T8wnvul9Y3F/26U775pPWLqV/5pCd/YT5pfUfMq/eEu9cCHz7p8v1D1ExUXz1Rd05z9a5vLuUv6u6kT/36HfNd7E/3n3D3WuDDJ12+f4iaieqrJ+rOaa7e9c2l/EXdnfSpX79jvov96f4T7l77ox6qr97FvfoD7fqOmDv2Spc/3dM3l9M99YT9+j31LrWn7++a3+DutT/qofrqXdyrP9Cu74i5Y690+dM9fXM53VNP2K/fU+9Se/r+rvkNrl779oH1gZMu33uOPXX5Uv2ieuUX0+/qT1rqvrqofXO1fmF/d+8brl799qH1oZMu33uOPXX5Uv2ieuUX0+/qT1rqvrqofXO1fmF/d+8brl7dfagf5shp7siu7x1H9Kt/6ldur/wp3/UrL8zV+pUvqlf+Da5e232gH+TIae7Iru8dR/Srf+pXbq/8Kd/1Ky/M1fqVL6pX/g2uXvOhuw+eet6zP/ky+TVi7hTV03emnrmUvzBXP/VrxNyRKX/C1Ws+dPfBU8979idfJr9GzJ2ievrO1DOX8hfm6qd+jZg7MuVPuHrNh/rgUy3eta+W2hN7u/1vtb65vmNPrW8up/7C/Kme/MWUP+Hq1fVQx3xXi3ftq6X2xN5u/1utb67v2FPrm8upvzB/qid/MeVPuHrVh6onf2G+9Lf+aX7KtF+/U1pfpnxR98oXc3X5ajGftFRe/hOuXvOB6slfmC/9rX+anzLt1++U1pcpX9S98sVcXb5azCctlZf/hLvXgvVwP6D8onqTv5tPvVO869ibcN8RffUtf3qH7PbN1fqVP+HutaA+oPyiepO/m0+9U7zr2Jtw3xF99S1/eofs9s3V+pU/4e61P3ywD9/VzpQ7E/Zqv3yxZ19/d2TyzXd1jb3S+o65lF/YV9/g7rU//MP48F3tTLkzYa/2yxd79vV3RybffFfX2Cut75hL+YV99Q2uXqsHTn7li9NcLfW75e/mC/NdXWNPTvsL96aRytW/9tU3uXq1Hjr5lS9Oc7XU75a/my/Md3WNPTntL9ybRipX/9pX3+TqVR+6tCP6ky7sqcv3fY6UL9WbfHO1vvmk9R1zdflF5eWfUu+6wdVrPtCHm9vb1YU9dfm+z5HypXqTb67WN5+0vmOuLr+ovPxT6l03uHvtj+nB3+bqXd/5Fu/UvVNfvO/eri5/0s4uu3vm7pkXu70n/OT69KHf5upd3/kW79S9U1+8796uLn/Szi67e+bumRe7vSf89npQH1Z/oNLObm5PXb7ou+/Ym6he3T3NxT1Hyi+8N+1PuZz2d7h7bZP6kPrDlXZ2c3vq8kXffcfeRPXq7mku7jlSfuG9aX/K5bS/w91rf0wP9Q/kVE+/9FOme/Wuwl7tn+ryvW++2yutX0z9b/3Kf8FPfmX6AD/UqZ5+6adM9+pdhb3aP9Xle998t1dav5j63/qV/4Krv1IP15/0LtMfTF+tX/m3eHca9ybcr70pL+yrn/rmpfXNS9/g6rV6oP6kd7n1B5zufIt3p3Fvwv3am/LCvvqpb15a37z0De5e+8OHqvUrL+zXHf3KRb/25TRXl//t76t3/ZrqSfmFfe9XLuU/4e61P3yoWr/ywn7d0a9c9GtfTnN1+d/+vnrXr6melF/Y937lUv4Trl57+kD3T/Uua6/2zaee1N6kC3ver/xb/SvfXC1TvtjtfcPVq08f6v6p3mXt1b751JPam3Rhz/uVf6t/5ZurZcoXu71v+M3VP/zD7I6UX1Rfv/Q0xdTT3+3XiPk0xZQvvOeeesI7NfZ/yU+v+2G7I+UX1dcvPU0x9fR3+zViPk0x5Qvvuaee8E6N/V9y9bofUlOYT7qwN/3+lC8qn/bLL6o/+ZUvpryoPX936k1aX+xN/Rtcve7DawrzSRf2pt+f8kXl0375RfUnv/LFlBe15+9OvUnri72pf4Or1+vB9UGTLrznFNWb/NJirtavqd6EvdL6Yu+0/9Tf1fqVP+HqtXpgfcCkC+85RfUmv7SYq/Vrqjdhr7S+2DvtP/V3tX7lT7h6bXpo+Qv3HXtF7Ym90/5TvOcUlZe/8L4zUb1f+wvfa199g6vX6uHmhfuOvaL2xN5p/ynec4rKy19435mo3q/9he+1r77B3WsDfliN/cK9adwT+7vj/qT1d6k9705TmE97+vbNxd7T+QW/uRr4QTX2C/emcU/s7477k9bfpfa8O01hPu3p2zcXe0/nF/zkaj188kvrm+uby25eY2/St3w57S/cm/qLqb+bq3f9Yrf3DT+5Wh84+aX1zfXNZTevsTfpW76c9hfuTf3F1N/N1bt+sdv7ht9cDfzw3Q+rvrp8980L+84t6p6/5xRTvqiev+MU1Zv0rm+u/gW/vQ5+6O4HVl9dvvvmhX3nFnXP33OKKV9Uz99xiupNetc3V/+Cq9frwX7gac857dec4p76lNovv5i+S189+Qtz9VPfXF1+7d/g6rV6oB9w2nNO+zWnuKc+pfbLL6bv0ldP/sJc/dQ3V5df+ze4ew18uB9QetcXe86EvdJOUb3J38V+3Z1y9S1fPfmLypdf+S/46a/4QX5Y6V1f7DkT9ko7RfUmfxf7dXfK1bd89eQvKl9+5b/g6q/4Aacf8nTvVNeIvv2aidP+hHfqfvkT1Z9880nrT/kvuXrdDzr9gKd7p7pG9O3XTJz2J7xT98ufqP7km09af8p/ydXrPri0s8tpX/zd3Xv23dM3L6Ze5fqld32Z8sK9SZd/qif/CVev+cDSzi6nffF3d+/Zd0/fvJh6leuX3vVlygv3Jl3+qZ78J9y99sd66O6D7ddI5fo13/bdm6g7+k719IvK9et+5U719G/xb/3O/3D32h/1AYX9Gqlcv+bbvnsTdUffqZ5+Ubl+3a/cqZ7+Lf6t3/kfrl7zgWp9x1yt/5S6p3/790/v2SutX3n1xJ5616+ZeuZiv3pPuHrNB6r1HXO1/lPqnv7t3z+9Z6+0fuXVE3vqXb9m6pmL/eo94eo1H+jDzaee/VP/V/h7jpz6RfVPf7/6an1zfad6suurZcq/4eo1H+gfxnzq2T/1f4W/58ipX1T/9Perr9Y313eqJ7u+Wqb8G65e8w/hyORXvqhcv/TkO1NPvvUrl+qX1jffpfr+TvUWleurZff3vuHqNR/qyORXvqhcv/TkO1NPvvUrl+qX1jffpfr+TvUWleurZff3vuHqNR94+vCp5z37+ubV01eXX1T+7b1F7VfuSPmLaX9h7p65vdL6jpT/hKvXfOD0QTL1vGdf37x6+uryi8q/vbeo/codKX8x7S/M3TO3V1rfkfKfcPWaH+CD9R0xt1f+Lu57Ry21Zy7Tnky9yiffXD1Rfe87spury7/J1Ws+3AfrO2Jur/xd3PeOWmrPXKY9mXqVT765eqL63ndkN1eXf5Or13YfPulTv7RjXrp879WIvlq/RspfmJcuX6q/y7RnXrr8X3D16u4HTPrUL+2Yly7fezWir9avkfIX5qXLl+rvMu2Zly7/F1y9uvsBU0/fXHZ9tb55+WKvpjjNvesU5moxr99R65ur9c0nv/QNrl47/ZBd31x2fbW+eflir6Y4zb3rFOZqMa/fUeubq/XNJ7/0De5eAz+sPkC/+pMv9p3qFealJ9+8elK5Wt+Rb/PJl/IXlZe/mPIn/ObqH/4B60P0qz/5Yt+pXmFeevLNqyeVq/Ud+TaffCl/UXn5iyl/wm+u/jE93D+wfbW459hT18ipv6i8fk8t5qWdKbdX/fIdMXfs7eKd0/0d7l6D6cF+mH21uOfYU9fIqb+ovH5PLealnSm3V/3yHTF37O3indP9Ha5emx445Yvq+YeYemr9yu2p9c3V5de+uehPdxb27JdvPlF31PrOKd/ufeLqtemBU76onn/AqafWr9yeWt9cXX7tm4v+dGdhz3755hN1R63vnPLt3ifuXvvDD62H609afzffndov3ylO87pbWr+YenWvtP6Ul3/K0/0TfvIr/iHqg/Qnrb+b707tl+8Up3ndLa1fTL26V1p/yss/5en+CT/5lekDzEs7t/Du7kz7lZdv/m1PTv2i+r/2ZfWcym9y99of00PNSzu38O7uTPuVl2/+bU9O/aL6v/Zl9ZzKb3L32h8+uB4+5XLac8R8dwp7ztSrXCZ/GvvytO9MvSl3ZMqfcPfaHz64Hj7lctpzxHx3CnvO1KtcJn8a+/K070y9KXdkyp9w99pD6kPV+pVL9XbvVF7+bep3Tt9fvcmvmaied6q3MJ/0De5ee0j9odT6lUv1du9UXv5t6ndO31+9ya+ZqJ53qrcwn/QNrl7zQ3en9ifsO7s9x73S+jXVk/IX5t6rXF2+2jnNJ+yd6sm/wdWr/sF2p/Yn7Du7Pce90vo11ZPyF+beq1xdvto5zSfsnerJv8HVq6cPtb+0/inuq4upZ17vLa0/UXvqyV94b+ov7O1q/WK3b76794SrV08fav/WB7uvLqaeeb23tP5E7aknf+G9qb+wt6v1i92++e7eE65e9aF+QOWiX/uVT1PYm0ZO/aL6k7877qlr7E24X3vmu1P7N7l6zQf68MpFv/Yrn6awN42c+kX1J3933FPX2Jtwv/bMd6f2b3L1mg/04ZWr9SemvcpL10j5i9rXd+yJ/d2e/qT1J3b3zNWTX5z2d7h6zQf6B6tcrT8x7VVeukbKX9S+vmNP7O/29CetP7G7Z66e/OK0v8PVaz7QP1jl6qfjvV2tbz7pierrqyfqvbv5wl7N1N9l2tOf9C+4et0H+weoXP10vLer9c0nPVF9ffVEvXc3X9irmfq7THv6k/4FV6+fPnjq+wesvrk9tb65Wp7uqcsvplzsq3dxT73rm09+4d7U/4ar104fOPX98Oqb21Prm6vl6Z66/GLKxb56F/fUu7755BfuTf1vuHrNh+6O+2r9ym/NKbv71St/ovr60/1vfXP909yeWt/8F1y96ofsjvtq/cpvzSm7+9Urf6L6+tP9b31z/dPcnlrf/Bf85urLy/8T3v8gLy8feP+DvLx84P0P8vLygfc/yMvLB97/IC8vH3j/g7y8fOD9D/Ly8oH3P8jLywfe/yAvLx94/4O8vHzg/Q/y8vKB9z/Iy8sH3v8gLy8feP+DvLx84P0P8vLygfc/yMvLB97/IC8vH3j/g7y8fOC/Acp9OPj144RMAAAAAElFTkSuQmCC
qr_string: 00020101021226700014br.gov.bcb.pix.citi.com.br/qr/2/8b3da2f39a4140d1a91abd93113bd44 15204000053039865802BR5913Fulano de Tal6008BRASILIA62070503***630464E4
additional_info:
- name: LAPTOP
value: PURCHASED APPLE LAPTOP
- name: SOFTWARE
value: PURCHASED ADDITIONAL SOFTWARE
Us-Google-Pay-Update-Authorize-Request-Example:
value:
method:
type: GOOGLEPAY
transaction:
id: REFUNDID12345
country_code: US
amount: 100
currency_code: USD
order:
id: ccapigpaytestmk1771318960
Uk-Pending-Status:
value:
- customer:
id: '225367001'
name:
first_name: RANJITH
last_name: PETER
email: ranjith.peter@gmail.com
method:
type: FPS
transaction:
id: PAYBY123456
amount: 786.01
currency_code: GBP
country_code: GB
url:
accepted: merchant.accepted.com
declined: merchant.declined.com
reason: Loan Payment
reference: TRY1234567
product_info:
- id: PRDT123456
name: APPLE IPHONE
quantity: 2
amount: 786.01
description: SALES
expiry_type: 10
status: PENDING
description: Pending action from customer
- customer:
id: '225367001'
name:
first_name: RANJITH
last_name: PETER
email: ranjith.peter@gmail.com
method:
type: FPS
transaction:
id: PAYBY123456
amount: 899.04
currency_code: GBP
country_code: UK
url:
accepted: merchant.accepted.com
declined: merchant.declined.com
reason: Loan Payment
reference: TRY1234567
product_info:
- id: PRDT123456
name: APPLE IPHONE
quantity: 2
amount: 786.01
description: SALES
expiry_type: 10
status: PENDING
description: Pending action from customer
India-IMPS-Status:
value:
- transaction:
end_to_end_id: r434SKtUcdGQ
reference: NPCI123456789
amount: 100
uetr: 4f09214d-296c-494b-8e9c-810bf1d9fc93
network_id: clr02052023478
batch_id: batch12345
value_date: '2022-09-07'
creation_date_time: '2022-09-13T08:23:49.112Z'
status_date_time: '2022-09-14T08:23:49.112Z'
currency_code: INR
status: SETTLED
description: Transaction settled
unstructured:
remittance_info:
- PURCHASED APPLE LAPTOP
- PURCHASED ADDITIONAL SOFTWARE
method:
type: IMPS
customer:
name:
first_name: Wilston
account:
number: '5564412'
bank_id: SBININBB
address:
street_name: Church street
building_number: '123'
postal_code: '987654'
city: Mumbai
state: Maharashtra
country: IN
merchant:
name: Hood
account:
number: '5564412'
bank_id: SBININBB
address:
street_name: Brigade street
building_number: '123'
postal_code: '996252'
city: Mumbai
state: Maharashtra
country: IN
Us-Apple-Pay-Verify-With-Session-Request-Example:
value:
customer:
id: '123456789'
merchant:
name: Wilson
method:
type: APPLEPAY
session_id: ad44b8bb-07ee-4a2c-ae84-3203d2e332af
transaction:
id: ccapigpaytestmk021826010
country_code: US
currency_code: USD
order:
id: ccapigpaytestmk1771318960
amount: 110
currency_code: USD
Gateway-Timeout-Gateway-Error-Example:
value:
httpCode: '504'
httpMessage: GATEWAY_TIMEOUT
moreInformation: 'Response took longer than timeout: PT50S'
Us-Ach-Direct-Debit-IAT-Request-Example:
value:
method:
type: ACH
ach:
sec_code: CCD
transaction:
country_code: US
id: DEBIT1744297417
value_date: '2024-05-01'
amount: 0.01
currency_code: USD
reference: '1234567890'
customer:
account:
number: '89770098'
bank_id: 021000089
bank_name: CITI
bank_country_code: US
type: CORPORATE_CHECKING
name:
first_name: Tracie Gallegosa
address:
street_name: brasil
building_number: 12-108
city: london
state: NJ
postal_code: '126644'
country_code: US
merchant:
account:
number: '100000000228'
bank_id: 021000089
bank_name: citi bank us
bank_country_code: US
name: Chris Topher
organization_id: '1234567181'
tax_id: '1234567812'
address:
street_name: brasil
building_number: 12-108
postal_code: '12644'
city: london
state: NJ
country_code: US
receiver:
name: Will Smith
organization_id: '12345678'
address:
street_name: brasil
building_number: 12-108
postal_code: '1234567890123456'
city: london
state: NJ
country_code: US
sender:
organization_id: '10000000000000264'
US-Card-Authorize-Request-With-Token-Example:
value:
method:
type: CARD
token_id: 5613dc38-ba17-446c-8c18-ae89f79de596
token_type: CITI_TOKEN
card:
cvv: '567'
transaction:
id: card1234567
currency_code: USD
country_code: US
order:
id: order0000001
amount: 323
currency_code: USD
Payment-Success-Us-Rfp-Status-Notification:
value:
method:
type: RTP
transaction:
id: e2e123456
uetr: bea176bf-1d5d-48cc-88fb-1d0e06af43e7
country_code: US
network_id: 2023111202120020101BSRFP00000000013
batch_id: '221084801'
creation_date_time: '2022-09-13T08:23:49.114Z'
value_date: '2024-05-01'
amount: '500.00'
currency_code: USD
original_amount: '500.00'
full_amount: '500.00'
discount_amount: '10.00'
purpose: GDDS
remittance_info: This is sample
reference: 2017111202120020101BSTRF00000000011
status: SETTLED
description: Transaction Settled
customer:
account:
number: '89770098'
bank_id: ABC12345
name: Josh
name:
first_name: Karl
organization_id: GH4657
birth_date: '2023-01-02'
birth_city: New York
birth_country: US
address:
lines:
- 678 Address Street
- B block
- Los Angeles
- CA
street_name: 1212 4th Street
building_number: A6378
city: San Francisco
state: CA
postal_code: '70989'
country_code: US
type: BUSINESS
merchant:
account:
number: '900900981'
name: Mike
bank_id: '89332'
name: Yokal
organization_id: AS2345
birth_date: '2023-01-03'
birth_city: New Ark
birth_country: US
address:
lines: 322 Address Street, B block, San Francisco, CA
street_name: 1212 7th Street
building_number: V7839
postal_code: '50098'
city: New York
state: CA
country_code: US
sender:
name: Himan
organization_id: AM2345
birth_date: '2023-01-07'
birth_city: New York
birth_country: US
private_id: PS89090
address:
street_name: 1345 4th Street
building_number: B5829
postal_code: '89934'
city: Vegas
state: CA
country_code: US
receiver:
name: Pista
organization_id: GH6785
birth_date: '2023-07-07'
birth_city: New York
birth_country: US
private_id: PB19090
address:
street_name: 4th Avenue
building_number: G6178
postal_code: '90213'
city: New York
state: CA
country_code: US
Bad-Request-Get2-Example:
value:
ref_id: 444d0f3f-4x55-7g99-8b2c-0cf2b921a5ab
error_details:
- issue: provided value is not within the range for query-param reference
action: please provide valid value for query-param reference, size must be between 1 and 128
code: VC00012
Qrpix-Payment-Request-Example:
value:
customer:
id: '84145367821'
name:
first_name: JOHN
last_name: PETER
merchant:
tax_id: 1.020.340/8910-22
method:
type: PIX
pix:
tax_id: 1.020.340/8910-22
transaction:
id: r434SKtUcdGQ
expiry_time: 1500
amount: 100
currency_code: BRL
country_code: BR
update_flag: Y
qr_image: Y
additional_info:
- name: LAPTOP
value: PURCHASED APPLE LAPTOP
- name: SOFTWARE
value: PURCHASED ADDITIONAL SOFTWARE
US-Alipay-Payment-Request-Example:
value:
customer:
name:
first_name: JOHN
last_name: PETER
address:
country_code: US
email: customer@gmail.com
method:
type: ALIPAY
transaction:
id: r434SKtUcdGQ
amount: 100
currency_code: USD
country_code: US
url:
browser_payment_return: brkljds
Payment-Success-Australia-IP-Credit-Status-Notification:
value:
transaction:
country_code: AU
currency_code: AUD
creation_date_time: '2022-09-13T08:22:49.112Z'
status_date_time: '2022-09-13T08:23:49.112Z'
end_to_end_id: RMTEST16SEP03
settlement_date: '2022-09-13'
status: SETTLED
description: Transaction settled
uetr: 7c6e36c0-8538-4309-afe2-535053df2a42
method:
type: IP
merchant:
account:
number: 0100599074
bank_id: TYEG6758
name: ROLF RICHARDUS
customer:
account:
bank_id: RSBKAU2SXXX
number: '5589089'
name:
first_name: vopak terminals
Paypal-Payment-Confirm-Request-Example:
value:
transaction:
id: RFP99341778674913690215632
currency_code: USD
country_code: US
order:
id: ccapicards1744354454
amount: 1000
currency_code: USD
method:
type: PAYPAL
paypal:
browser_payment_operation: CONFIRM
Payment-Uk-Link-Failed-Notification:
value:
transaction:
id: pay02052623456r
amount: 200
currency_code: GBP
status: FAILED
description: Transaction failed for invalid payload
creation_date_time: '2022-09-13T08:23:49.114Z'
reference: PRDQWETY
reason_code: SC90120
order:
id: ORD12345
Qr-Failed-Status:
value:
- customer:
id: 8415678edrf
type: BUSINESS
name:
first_name: JOHN
last_name: PETER
merchant:
tax_id: 8.020.340/8910-44
method:
type: PIX
pix:
tax_id: 1.020.340/8910-22
transaction:
id: abcedgh8742323
expiry_time: 2500
creation_date_time: '2022-09-13T08:23:49.112Z'
amount: 305
update_flag: Y
update_count: 0
qr_image: Y
status: SYSTEM_ERROR
description: Internal system error occurred processing the transaction
additional_info:
- name: LAPTOP
value: PURCHASED APPLE LAPTOP
- name: SOFTWARE
value: PURCHASED ADDITIONAL SOFTWARE
- customer:
id: 8415678edrf
type: BUSINESS
name:
first_name: JOHN
last_name: PETER
merchant:
tax_id: 8.020.340/8910-44
method:
type: PIX
pix:
tax_id: 1.020.340/8910-22
transaction:
id: abcedgh8742323
expiry_time: 2500
creation_date_time: '2022-09-13T08:23:49.112Z'
amount: 809.76
update_flag: Y
update_count: 0
qr_image: Y
status: SYSTEM_ERROR
description: Internal system error occurred processing the transaction
additional_info:
- name: LAPTOP
value: PURCHASED APPLE LAPTOP
- name: SOFTWARE
value: PURCHASED ADDITIONAL SOFTWARE
India-Card-Payment-With-Card-Request-Example:
value:
method:
type: CARD
holder_name:
first_name: JOHN
last_name: VINU
card:
number: '4320445566778907'
expiry_month: '12'
expiry_year: '24'
cvv: '567'
transaction:
id: INDIA234567
amount: 101
currency_code: INR
country_code: IN
order:
amount: 323
currency_code: INR
Us-Rfp-Success-Notification-Example:
value:
method:
type: RTP
transaction:
id: e2e123456
uetr: bea176bf-1d5d-48cc-88fb-1d0e06af43e7
creation_date_time: '2022-09-13T08:23:49.114Z'
value_date: '2024-05-01'
expiry_date: '2024-05-09'
update_flag: Y
amount: 500
currency_code: USD
country_code: US
full_amount: 500
discount_amount: 10
purpose: GDDS
remittance_info:
- This is sample
reference: 2017111202120020101BSTRF00000000011
network_id: 2023111202120020101BSRFP00000000013
status: PENDING_SETTLEMENT
description: Transaction is pending settlement
customer:
account:
number: '89770098'
bank_id: ABC12345
name: Josh
name:
first_name: Karl
organization_id: GH4657
birth_date: '2023-01-02'
birth_city: New York
birth_country: US
address:
street_name: 1212 4th Street
building_number: A6378
city: San Francisco
state: CA
postal_code: '70989'
country_code: US
type: BUSINESS
merchant:
account:
number: '900900981'
name: Mike
bank_id: '89332'
name: Yokal
organization_id: AS2345
birth_date: '2023-01-03'
birth_city: New Ark
birth_country: US
phone_number: +1-555-123-4567
address:
street_name: 1212 7th Street
building_number: V7839
postal_code: '50098'
city: New York
state: CA
country_code: US
sender:
name: Himan
organization_id: AM2345
birth_date: '2023-01-07'
birth_city: New York
birth_country: US
private_id: PS89090
address:
street_name: 1345 4th Street
building_number: B5829
postal_code: '89934'
city: Vegas
state: CA
country_code: US
receiver:
name: Pista
organization_id: GH6785
birth_date: '2023-07-07'
birth_city: New York
birth_country: US
private_id: PB19090
address:
street_name: 4th Avenue
building_number: G6178
postal_code: '90213'
city: New York
state: CA
country_code: US
India-Card-Payment-Response-Example:
value:
transaction:
id: INDIA234567
amount: 101
psp_reference: PSP123456
redirect_url: https:\url
status: SUCCESS
description: The operation was successfully processed
currency_code: INR
country_code: IN
creation_date_time: '2025-01-17T13:10:23.973Z'
update_time: '2025-01-17T13:10:24.351Z'
order:
id: ORD12345
amount: 323
currency_code: INR
creation_date_time: '2025-01-17T13:10:23.973Z'
update_time: '2025-01-17T13:10:24.351Z'
status: AUTHENTICATION_INITIATED
Rate-Limit-Exceeded-Gateway-Error-Example:
value:
httpCode: '429'
httpMessage: Too Many Requests
moreInformation: Rate Limit exceeded
US-Trustly-Payment-Request-Example:
value:
customer:
name:
first_name: JOHN
last_name: PETER
address:
country_code: US
email: customer@gmail.com
method:
type: TRUSTLY
transaction:
id: r434SKtUcdGQ
amount: 200
currency_code: USD
country_code: US
url:
browser_payment_return: brkljds
Payment-Success-Incoming-Brazil-PIX-Credit-Status-Notification:
value:
method:
type: PIX
customer:
account:
number: '97150300543944526009'
bank_id: CITIBRXXX
name: Jack
tax_id: TAX123
name:
first_name: Jack
merchant:
account:
number: '62080300543944526226'
bank_id: '33479023'
name: Kingston
name: Kingston
tax_id: TAX234
transaction:
end_to_end_id: 12345678dd
uetr: 4f09214d-296c-494b-8e9c-810bf1d9fc93
creation_date_time: '2024-09-13T08:23:49.114Z'
country_code: BR
currency_code: BRL
value_date: '2025-03-10'
amount: 800.21
status: SETTLED
description: Transaction Settled
status_date_time: '2024-05-26T08:20:49.114Z'
US-Apple-Pay-Authorize-With-Card-Request-Example:
value:
customer:
id: '11225367999'
method:
type: APPLEPAY
card:
number: '4320445566778907'
expiry_month: '12'
expiry_year: '24'
cvv: '567'
transaction:
id: card1234567
currency_code: USD
country_code: US
order:
id: order0000001
amount: 323
currency_code: USD
Payment-Uk-Link-Sucess-Notification:
value:
transaction:
id: pay02052623456r
psp_reference: PYMT123456
amount: 200
currency_code: GBP
status: PENDING
description: Pending action from customer.
creation_date_time: '2022-09-13T08:23:49.114Z'
redirect_url: redirect@abc
reference: PRDQWETY
expiry_time: 40
order:
id: ORD12345
US-Card-Payment-Request-With-Token-Example:
value:
method:
type: CARD
token_id: 49be1a9f-a861-48ba-b603-d87248f4d5aa
token_type: CITI_TOKEN
card:
cvv: '123'
transaction:
id: card1234567
currency_code: USD
country_code: US
order:
id: order0000001
amount: 323
currency_code: USD
US-Card-Payment-Request-Example:
value:
method:
type: CARD
card:
number: '4320445566778907'
expiry_month: '12'
expiry_year: '24'
cvv: '567'
transaction:
id: card1234567
currency_code: USD
country_code: US
order:
id: order0000001
amount: 323
currency_code: USD
Paypal-Authorize-Confirm-Request-Example:
value:
transaction:
id: RFP99341778674913690215632
currency_code: USD
country_code: US
order:
id: ccapicards1744354454
amount: 1000
currency_code: USD
method:
type: PAYPAL
paypal:
browser_payment_operation: CONFIRM
Us-Rfp-Reject-Notification-Example:
value:
method:
type: RTP
transaction:
id: e2e123456
uetr: bea176bf-1d5d-48cc-88fb-1d0e06af43e7
creation_date_time: '2022-09-13T08:23:49.114Z'
value_date: '2024-05-01'
expiry_date: '2024-05-09'
update_flag: Y
amount: '500.00'
currency_code: USD
country_code: US
full_amount: '500.00'
discount_amount: '10.00'
purpose: GDDS
remittance_info: This is sample
reference: 2017111202120020101BSTRF00000000011
network_id: 2023111202120020101BSRFP00000000013
status: FAILED
description: AM04 - Insuficient Amount
customer:
account:
number: '89770098'
bank_id: ABC12345
name: Josh
name:
first_name: Karl
organization_id: GH4657
birth_date: '2023-01-02'
birth_city: New York
birth_country: US
address:
street_name: 1212 4th Street
building_number: A6378
city: San Francisco
state: CA
postal_code: '70989'
country_code: US
type: BUSINESS
merchant:
account:
number: '900900981'
name: Mike
bank_id: '89332'
name: Yokal
organization_id: AS2345
birth_date: '2023-01-03'
birth_city: New Ark
birth_country: US
phone_number: +1-555-123-4567
address:
street_name: 1212 7th Street
building_number: V7839
postal_code: '50098'
city: New York
state: CA
country_code: US
sender:
name: Himan
organization_id: AM2345
birth_date: '2023-01-07'
birth_city: New York
birth_country: US
private_id: PS89090
address:
street_name: 1345 4th Street
building_number: B5829
postal_code: '89934'
city: Vegas
state: CA
country_code: US
receiver:
name: Pista
organization_id: GH6785
birth_date: '2023-07-07'
birth_city: New York
birth_country: US
private_id: PB19090
address:
street_name: 4th Avenue
building_number: G6178
postal_code: '90213'
city: New York
state: CA
country_code: US
Payment-Success-Us-Wire-Status-Notification:
value:
transaction:
uetr: 4f09214d-296c-494b-8e9c-810bf1d9fc93
creation_date_time: '2022-09-13T08:23:49.114Z'
amount: 1015.5
currency_code: USD
status: SETTLED
description: AC01 - Account Dormant
network_id: '209323283934'
value_date: '2025-03-17'
remittance_info:
- This is sample
end_to_end_id: pay02052023456r
customer:
name:
first_name: Smith
account:
number: '89770098'
bank_id: ABC12345
virtual_number: '91908009856'
address:
country_code: US
postal_code: '31503'
state: Georgia
lines:
- Street No 432, Church Street
merchant:
name: Smith
account:
number: '89770098'
bank_id: ABC12345
virtual_number: '91908009856'
address:
country_code: US
postal_code: '31503'
state: Georgia
lines:
- Street No 432, Church Street
method:
type: FT
Us-Google-Pay-Authorize-Request-With-Token-Example:
value:
customer:
id: '11225367999'
method:
type: GOOGLEPAY
token_id: 5613dc38-ba17-446c-8c18-ae89f79de596
token_type: CITI_TOKEN
card:
cvv: '567'
transaction:
id: card1234567
currency_code: USD
country_code: US
order:
id: order0000001
amount: 323
currency_code: USD
US-Card-Authorize-Update-Request-Example:
value:
method:
type: CARD
transaction:
id: ccapigpaytestmk021826010
country_code: US
amount: 110
currency_code: USD
order:
id: ccapigpaytestmk1771318960
Us-Ach-Direct-Debit-CCD-PPD-WEB-Request-Example:
value:
method:
type: ACH
ach:
sec_code: CCD
transaction:
country_code: US
id: DEBIT1744297417
value_date: '2024-05-01'
amount: 0.01
currency_code: USD
reference: '1234567890'
customer:
account:
number: '89770098'
bank_id: 021000089
bank_name: CITI
bank_country_code: US
type: CORPORATE_CHECKING
name:
first_name: Tracie Gallegosa
address:
street_name: brasil
building_number: 12-108
city: london
state: NJ
postal_code: '126644'
country_code: US
merchant:
account:
number: '100000000228'
bank_id: 021000089
bank_name: citi bank us
bank_country_code: US
name: Chris Topher
organization_id: '1234567181'
tax_id: '1234567812'
address:
street_name: brasil
building_number: 12-108
postal_code: '12644'
city: london
state: NJ
country_code: US
receiver:
name: Will Smith
organization_id: '12345678'
address:
street_name: brasil
building_number: 12-108
postal_code: '1234567890123456'
city: london
state: NJ
country_code: US
sender:
organization_id: '10000000000000264'
Uk-Failed-Status:
value:
- customer:
id: '225367001'
name:
first_name: RANJITH
last_name: PETER
email: ranjith.peter@gmail.com
method:
type: FPS
transaction:
id: PAYBY123456
amount: 786.01
currency_code: GBP
country_code: GB
url:
accepted: merchant.accepted.com
declined: merchant.declined.com
reason: Loan Payment
reference: TRY1234567
product_info:
- id: PRDT123456
name: APPLE IPHONE
quantity: 2
amount: 786.01
description: SALES
expiry_type: 10
status: FAILED
description: SC90110 - PAYER_ACCOUNT_BLOCKED
- customer:
id: '225367001'
name:
first_name: RANJITH
last_name: PETER
email: ranjith.peter@gmail.com
method:
type: FPS
transaction:
id: PAYBY123456
amount: 235.89
currency_code: GBP
country_code: GB
url:
accepted: merchant.accepted.com
declined: merchant.declined.com
reason: Loan Payment
reference: TRY1234567
product_info:
- id: PRDT123456
name: APPLE IPHONE
quantity: 2
amount: 786.01
description: SALES
expiry_type: 10
status: FAILED
description: SC90110 - PAYER_ACCOUNT_BLOCKED
Australia-IP-Status:
value:
- transaction:
country_code: AU
currency_code: AUD
acceptance_date_time: '2022-09-13T08:23:49.112Z'
creation_date_time: '2022-09-13T08:22:49.112Z'
status_date_time: '2022-09-13T08:23:49.112Z'
purpose: OTHR
charges_paid_by: SHAR
end_to_end_id: RMTEST16SEP03
id: REF123
settlement_date: '2022-09-13'
network_id: RSBKAU2SXXX20250916000015568466557
category_purpose: Salary payment
status: SETTLED
description: Transaction settled
regulatory_reporting:
type: INDV
code: DBTRTP
reference: More details
uetr: 7c6e36c0-8538-4309-afe2-535053df2a42
remittance_info:
- Sample
method:
type: IP
merchant:
account:
number: 0100599074
name: ROLF RICHARDUS
customer:
account:
bank_id: RSBKAU2SXXX
name:
first_name: vopak terminals
Us-Google-Pay-Authorize-Request-With-Card-Example:
value:
customer:
id: '11225367999'
method:
type: GOOGLEPAY
card:
number: '4320445566778907'
expiry_month: '12'
expiry_year: '24'
cvv: '567'
transaction:
id: card1234567
currency_code: USD
country_code: US
order:
id: order0000001
amount: 323
currency_code: USD
Bad-Request-Example:
value:
ref_id: 444d0f3f-4x55-7g99-8b2c-0cf2a921a5ab
error_details:
- issue: property method.type is mandatory and it cannot be empty
action: please provide valid value for property method.type
code: VC00010
Internal-Server-Error-Example:
value:
ref_id: ec689822-9864-4c4d-9d68-222467627902
error_details:
- issue: unable to serve your request at this moment
action: Please refer to documentation provided or contact support team
code: CC00004
US-Card-Payment-Update-Request-Example:
value:
customer:
type: BUSINESS
name:
first_name: JOHN
last_name: PETER
transaction:
id: '1234567'
amount: 202
Us-Apple-Pay-Update-Authorize-Request-Example:
value:
method:
type: APPLEPAY
transaction:
id: REFUNDID12345
country_code: US
amount: 100
currency_code: USD
order:
id: ccapigpaytestmk1771318960
India-Card-Status:
value:
customer:
id: CST123456
name:
first_name: PAUL
last_name: JOHN
merchant:
name:
first_name: THOKLR
last_name: JOHN
method:
type: CARD
transaction:
id: pay02052623456r
amount: 200
currency_code: INR
status: FAILED
description: Transaction failed for invalid payload
creation_date_time: '2022-09-13T08:23:49.114Z'
update_time: '2022-09-13T08:23:49.114Z'
redirect_url: redirected@url
order:
amount: 200
currency_code: INR
merchant_amount: 200
merchant_currency: INR
status: FAILED
total_auth_amount: 200
total_captured_amount: 200
Us-Rfp-Reject-Status-Example:
value:
- method:
type: RTP
transaction:
id: e2e123456
uetr: bea176bf-1d5d-48cc-88fb-1d0e06af43e7
creation_date_time: '2022-09-13T08:23:49.114Z'
value_date: '2024-05-01'
expiry_date: '2024-05-09'
update_flag: Y
amount: 500
currency_code: USD
country_code: US
full_amount: 500
discount_amount: 10
purpose: GDDS
remittance_info:
- This is sample
reference: 2017111202120020101BSTRF00000000011
network_id: 2023111202120020101BSRFP00000000013
status: FAILED
description: AM04 - Insuficient Amount
customer:
account:
number: '89770098'
bank_id: ABC12345
name: Josh
name:
first_name: Karl
organization_id: GH4657
birth_date: '2023-01-02'
birth_city: New York
birth_country: US
address:
street_name: 1212 4th Street
building_number: A6378
city: San Francisco
state: CA
postal_code: '70989'
country_code: US
type: BUSINESS
merchant:
account:
number: '900900981'
name: Mike
bank_id: '89332'
name: Yokal
organization_id: AS2345
birth_date: '2023-01-03'
birth_city: New Ark
birth_country: US
phone_number: +1-555-123-4567
address:
street_name: 1212 7th Street
building_number: V7839
postal_code: '50098'
city: New York
state: CA
country_code: US
sender:
name: Himan
organization_id: AM2345
birth_date: '2023-01-07'
birth_city: New York
birth_country: US
private_id: PS89090
address:
street_name: 1345 4th Street
building_number: B5829
postal_code: '89934'
city: Vegas
state: CA
country_code: US
receiver:
name: Pista
organization_id: GH6785
birth_date: '2023-07-07'
birth_city: New York
birth_country: US
private_id: PB19090
address:
street_name: 4th Avenue
building_number: G6178
postal_code: '90213'
city: New York
state: CA
country_code: US
- method:
type: RTP
transaction:
id: e2e123456
uetr: bea176bf-1d5d-48cc-88fb-1d0e06af43e7
creation_date_time: '2022-09-13T08:23:49.114Z'
value_date: '2024-05-01'
expiry_date: '2024-05-09'
update_flag: Y
amount: '701.00'
currency_code: USD
country_code: US
full_amount: '701.00'
discount_amount: '11.00'
purpose: GDDS
remittance_info: This is sample
reference: 2017111202120020101BSTRF00000000011
network_id: 2023111202120020101BSRFP00000000013
status: FAILED
description: AM04 - Insuficient Amount
customer:
account:
number: '89770098'
bank_id: ABC12345
name: Josh
name:
first_name: Karl
organization_id: GH4657
birth_date: '2023-01-02'
birth_city: New York
birth_country: US
address:
street_name: 1212 4th Street
building_number: A6378
city: San Francisco
state: CA
postal_code: '70989'
country_code: US
type: BUSINESS
merchant:
account:
number: '900900981'
name: Mike
bank_id: '89332'
name: Yokal
organization_id: AS2345
birth_date: '2023-01-03'
birth_city: New Ark
birth_country: US
phone_number: +1-555-123-4567
address:
street_name: 1212 7th Street
building_number: V7839
postal_code: '50098'
city: New York
state: CA
country_code: US
sender:
name: Himan
organization_id: AM2345
birth_date: '2023-01-07'
birth_city: New York
birth_country: US
private_id: PS89090
address:
street_name: 1345 4th Street
building_number: B5829
postal_code: '89934'
city: Vegas
state: CA
country_code: US
receiver:
name: Pista
organization_id: GH6785
birth_date: '2023-07-07'
birth_city: New York
birth_country: US
private_id: PB19090
address:
street_name: 4th Avenue
building_number: G6178
postal_code: '90213'
city: New York
state: CA
country_code: US
Trustly-Link-Sucess-Notification:
value:
customer:
name:
first_name: john
last_name: peter
email: customer@gmail.com
method:
type: ALIPAY
transaction:
id: pay02052623456r
psp_reference: PYMT123456
amount: 200
currency_code: USD
country_code: US
status: PENDING
description: Pending action from customer.
creation_date_time: '2022-09-13T08:23:49.114Z'
redirect_url: redirect@abc
Uk-Payment-Request-Example:
value:
customer:
id: '225367001'
name:
first_name: RANJITH
last_name: PETER
email: ranjith.peter@gmail.com
method:
type: FPS
transaction:
id: PAYBY123456
amount: 786.01
currency_code: GBP
country_code: GB
url:
accepted: merchant.accepted.com
declined: merchant.declined.com
reason: Loan Payment
reference: TRY1234567
product_info:
- id: PRDT123456
name: APPLE IPHONE
quantity: 2
amount: 786.01
description: SALES
expiry_time: 10
India-Card-Cancel-Payment-Response-Example:
value:
transaction:
id: INDIA234560
status: SUCCESS
description: The operation was successfully processed
currency_code: INR
country_code: IN
creation_time: '2025-01-17T13:10:23.973Z'
update_time: '2025-01-17T13:10:24.351Z'
order:
id: ORD12345
amount: 323
currency_code: INR
creation_time: '2025-01-17T13:10:23.973Z'
update_time: '2025-01-17T13:10:24.351Z'
status: PARTIALLY_CAPTURED
US-Apple-Pay-Authorize-With-Token-Request-Example:
value:
customer:
id: '11225367999'
method:
type: APPLEPAY
token_id: ' 5613dc38-ba17-446c-8c18-ae89f79de596'
token_type: CITI_TOKEN
card:
cvv: '567'
transaction:
id: card1234567
currency_code: USD
country_code: US
order:
id: order0000001
amount: 323
currency_code: USD
India-Card-Authorize-Payment-Response-Example:
value:
transaction:
id: INDIA234568
psp_reference: PSP123456
amount: 101
status: SUCCESS
description: The operation was successfully processed
currency_code: INR
country_code: IN
creation__date_time: '2025-01-17T13:10:23.973Z'
update_time: '2025-01-17T13:10:24.351Z'
order:
id: ORD12345
amount: 323
currency_code: INR
creation_date_time: '2025-01-17T13:10:23.973Z'
update_time: '2025-01-17T13:10:24.351Z'
status: AUTHORIZED
Brazil-Payment-Success-Qr-Status-Notification:
value:
merchant:
tax_id: '8020340891044'
transaction:
id: r434SKtUcdGQ
end_to_end_id: pay02052023456r
amount: 500
creation_date_time: '2022-09-13T08:23:49.114Z'
additional_info: Payment for goods
status: SETTLED
description: Transaction settled
Payment-Capture-Failed-Notification:
value:
transaction:
id: pay02052623456r
amount: 200
currency_code: USD
status: FAILED
description: Transaction failed for invalid payload
creation_date_time: '2022-09-13T08:23:49.114Z'
update_time: '2022-09-13T08:23:49.114Z'
redirect_url: redirected@url
order:
amount: 200
currency_code: USD
merchant_amount: 200
merchant_currency: USD
status: FAILED
total_auth_amount: 200
total_captured_amount: 200
Us-Apple-Pay-Cancel-Request-Example:
value:
method:
type: APPLEPAY
transaction:
id: REFUNDID12345
country_code: US
amount: 100
currency_code: USD
order:
id: ccapigpaytestmk1771318960
Thailand-IP-Status:
value:
- transaction:
id: REF123456
end_to_end_id: ref34SKtUcdGQ
uetr: 4f09214d-296c-494b-8e9c-810bf1d9fc93
network_id: clr02052023478
batch_id: batch12345
value_date: '2022-09-07'
creation_date_time: '2022-09-13T08:23:49.112Z'
status_date_time: '2022-09-14T08:00:00.000Z'
bill_id_1: '77889900'
bill_id_2: '77889901'
bill_id_3: '77889902'
purpose: PAYMENT
processing_code: '58000'
tax_id: '2'
wht_code: A
wht_rate: 10
wht_amount: 1000
income_type: '001'
bill_due_date: '2022-09-07'
vat_rate: 10
vat_amount: 1000
amount: 5000
currency_code: THB
additional_info:
- Credit Payment
reference: payment for september
status: SETTLED
description: Transaction settled
merchant:
account:
number: '123456'
virtual_account: '998877'
bank_id: CITITHBX
branch_id: '123'
proxy_id: raja@citi.com
proxy_type: BIID
tax_id: tax123
name: Thomas
customer:
account:
number: '987654'
virtual_account: '1122334455'
bank_id: CITITHBX
branch_id: '123'
proxy_id: raja@citi.com
proxy_type: BIID
tax_id: tax123
name:
first_name: Wilson
sender:
name: Gary
address:
city: Phuket
country_code: TH
method:
type: IP
Us-Paypal-Cancel-Request-Example:
value:
method:
type: PAYPAL
transaction:
id: REFUNDID12345
target_transaction_id: MkPayPAL1771321466
order:
id: ccapigpaytestmk1771318960
BR-PIX-Status:
value:
- transaction:
creation_date_time: '2022-09-13T08:23:49.114Z'
value_date: '2025-04-02'
id: RTP99625446991261440318900
currency_code: BRL
country_code: BR
amount: 200
status: SETTLED
description: Transaction Settled
reason_code: ACSP
uetr: 4f09214d-296c-494b-8e9c-810bf1d9fc93
status_date_time: '2022-09-13T08:23:49.114Z'
holiday_flag: true
method:
type: PIX
customer:
account:
bank_id: '3347902'
number: '602301192802'
name: Jack
name:
first_name: Jack
tax_id: '80062766835'
merchant:
account:
bank_id: '3347902'
number: '91501005632'
name: Kingston
tax_id: '80062766835'
name: Wilson
sender:
private_id: '80062763243'
Us-Rfp-Success-Status-Example:
value:
- method:
type: RTP
transaction:
id: e2e123456
uetr: bea176bf-1d5d-48cc-88fb-1d0e06af43e7
creation_date_time: '2022-09-13T08:23:49.114Z'
value_date: '2024-05-01'
expiry_date: '2024-05-09'
update_flag: Y
amount: 500
currency_code: USD
country_code: US
full_amount: 500
discount_amount: 10
purpose: GDDS
remittance_info:
- This is sample
reference: 2017111202120020101BSTRF00000000011
network_id: 2023111202120020101BSRFP00000000013
status: PENDING_SETTLEMENT
description: Transaction is pending settlement
customer:
account:
number: '89770098'
bank_id: ABC12345
name: Josh
name:
first_name: Karl
organization_id: GH4657
birth_date: '2023-01-02'
birth_city: New York
birth_country: US
address:
street_name: 1212 4th Street
building_number: A6378
city: San Francisco
state: CA
postal_code: '70989'
country_code: US
type: BUSINESS
merchant:
account:
number: '900900981'
name: Mike
bank_id: '89332'
name: Yokal
organization_id: AS2345
birth_date: '2023-01-03'
birth_city: New Ark
birth_country: US
phone_number: +1-555-123-4567
address:
street_name: 1212 7th Street
building_number: V7839
postal_code: '50098'
city: New York
state: CA
country_code: US
sender:
name: Himan
organization_id: AM2345
birth_date: '2023-01-07'
birth_city: New York
birth_country: US
private_id: PS89090
address:
street_name: 1345 4th Street
building_number: B5829
postal_code: '89934'
city: Vegas
state: CA
country_code: US
receiver:
name: Pista
organization_id: GH6785
birth_date: '2023-07-07'
birth_city: New York
birth_country: US
private_id: PB19090
address:
street_name: 4th Avenue
building_number: G6178
postal_code: '90213'
city: New York
state: CA
country_code: US
- method:
type: RTP
transaction:
id: e2e123456
uetr: bea176bf-1d5d-48cc-88fb-1d0e06af43e7
creation_date_time: '2022-09-13T08:23:49.114Z'
value_date: '2024-05-01'
expiry_date: '2024-05-09'
update_flag: Y
amount: '701.00'
currency_code: USD
country_code: US
full_amount: '701.00'
discount_amount: '11.00'
purpose: GDDS
remittance_info: This is sample
reference: 2017111202120020101BSTRF00000000011
network_id: 2023111202120020101BSRFP00000000013
status: PENDING_SETTLEMENT
description: Transaction is pending settlement
customer:
account:
number: '89770098'
bank_id: ABC12345
name: Josh
name:
first_name: Karl
organization_id: GH4657
birth_date: '2023-01-02'
birth_city: New York
birth_country: US
address:
street_name: 1212 4th Street
building_number: A6378
city: San Francisco
state: CA
postal_code: '70989'
country_code: US
type: BUSINESS
merchant:
account:
number: '900900981'
name: Mike
bank_id: '89332'
name: Yokal
organization_id: AS2345
birth_date: '2023-01-03'
birth_city: New Ark
birth_country: US
phone_number: +1-555-123-4567
address:
street_name: 1212 7th Street
building_number: V7839
postal_code: '50098'
city: New York
state: CA
country_code: US
sender:
name: Himan
organization_id: AM2345
birth_date: '2023-01-07'
birth_city: New York
birth_country: US
private_id: PS89090
address:
street_name: 1345 4th Street
building_number: B5829
postal_code: '89934'
city: Vegas
state: CA
country_code: US
receiver:
name: Pista
organization_id: GH6785
birth_date: '2023-07-07'
birth_city: New York
birth_country: US
private_id: PB19090
address:
street_name: 4th Avenue
building_number: G6178
postal_code: '90213'
city: New York
state: CA
country_code: US
schemas:
Transit:
title: transit
type: object
description: Transit
properties:
known_fare:
description: Indicates if this is a transaction for a known fare submitted at the time of travel or after the payer has already gained access to the transit service (deferred Authorization).
enum:
- DEBT_RECOVERY_MERCHANT_INITIATED
- DEBT_RECOVERY_PAYER_INITIATED
- DEBT_RECOVERY_TAP_INITIATED
- FARE_DEFERRED_AUTHORIZATION
- FARE_REAL_TIME_AUTHORIZATION
example: FARE_REAL_TIME_AUTHORIZATION
type: string
title: known_fare
aggregated_fare:
$ref: '#/components/schemas/Aggregated-Fare'
Payment-Recipient:
type: object
title: payment recipient
properties:
account_identifier:
maxLength: 50
minLength: 1
type: string
description: The account identifier for the payment recipient's account.For payments into a card account provide the card number. For payments into other accounts (for example a bank account) provide the account number. The value provided will be returned masked in the response. Applicable for 'Initiate Browser payment' only, as an optional attribute.
title: account_identifier
birth_date:
type: string
format: date
description: "ISO 8601 (YYYY-MM-DD), Sender's birth_date \n - For US RFP trasnaction, this parameter is optional"
title: birth_date
last_name:
description: 'Last name of the primary payment recipient. '
example: PETER
maxLength: 50
minLength: 1
type: string
title: last_name
postal_code:
description: Postcode of the primary payment recipient.
type: string
minLength: 1
maxLength: 10
example: '33610'
title: postal_code
Device-Specific-Response:
title: Device
description: Device Specific Response
properties:
number:
description: The payer's account number associated with a digital payment method.
example: PA123456789
maximum: 19
minimum: 9
type: number
title: number
expiry_month:
description: Two-digit month in which the device specific expires.
example: '01'
type: string
pattern: ^(0?[1-9]|1[0-2])$
title: expiry_month
expiry_year:
description: Year from the expiry date of the device specific account number.
type: string
pattern: ^[0-9]{2,2}$
example: '25'
title: expiry_year
Customer-Get:
title: Customer Status
properties:
account:
title: customer account
description: Account Details
properties:
number:
maxLength: 40
minLength: 1
type: string
description: "Customer's bank account \n- For US RFP this parameter is mandatory with max length 40 \n- For IN UPI and UK FPS this parameter is optional \n- For US ACH Direct Debit, this parameter is mandatory with max length 17 \n- For Brazil PIX, this parameter is mandatory with max length 40"
example: '1122334455'
title: number
phone:
description: Customer phone.
example: '+919962125789'
pattern: \+[0-9]{1,3}[-\ ][0-9()+\-]{1,30}
type: string
title: phone
bank_id:
maxLength: 35
minLength: 1
type: string
description: "Customer bank's network identification \n- For US RFP this parameter is mandatory with max length 16 \n- For ACH, length is equal to 9 \n- For IN UPI and UK FPS this parameter is optional \n- For US ACH Direct Debit, this parameter is mandatory with max length 9 \n- For Brazil PIX, this parameter is mandatory with min & max length 8"
example: CITIIN77
title: bank_id
branch_id:
description: Customer bank's branch id
minLength: 1
maxLength: 35
type: string
example: BR123
title: branch_id
bank_name:
maxLength: 35
minLength: 1
type: string
description: "Customer's bank name \n- For US ACH Direct Debit, this parameter is mandatory with max length 35"
example: CITI
title: bank_name
bank_country_code:
type: string
pattern: ^[A-Z]{2,2}$
description: "Country code of the bank where customer is maintaining the account \n- For US ACH Direct Debit, this parameter is mandatory"
example: US
title: bank_country_code
name:
maxLength: 70
minLength: 1
type: string
description: "Customer's Account Name \n- FOr US RFP transaction this parameter is optional "
title: name
proxy_id:
maxLength: 255
minLength: 1
type: string
description: "Customer's proxy identification (e.g., email address) \n- For IN UPI transaction, this parameter is optional"
example: raja@citi.com
title: proxy_id
proxy_type:
type: string
enum:
- BIID
- EMAL
- EWAL
- MBNO
- NIDN
description: "Customer's proxy type (BIID for bill identification, EMAL for email address, EWAL for electronic wallet identification, MBNO for mobile number and NIDN for national identification) \n- For IN UPI this parameter is optional"
title: proxy_type
type:
description: "Customer Source type of the transaction \n- For IN UPI this parameter is optional \n- For US ACH Direct Debit, this parameter is mandatory"
enum:
- SAVINGS
- CURRENT
- CARD
- OVERDRAFT
- VIRTUAL_ACCOUNT
- CORPORATE_CHECKING
example: SAVINGS
type: string
title: type
virtual_number:
description: Customer's Virtual account number
type: string
maxLength: 140
minLength: 1
example: '123456789'
title: virtual_number
issuer:
description: Entity that assigned account to the party
type: string
maxLength: 35
minLength: 1
example: ABC Ltd
title: issuer
id:
description: Merchant internal customer ID.
example: 1234abcjki
maxLength: 40
minLength: 1
type: string
title: id
tax_id:
description: "Customer's payer identification (e.g., email address) \n- For Brazil PIX, this parameter is mandatory with min length 11 & max length 14"
example: 234.453.678-21
maxLength: 100
minLength: 1
type: string
title: tax_id
name:
$ref: '#/components/schemas/Name'
type:
description: "Customer type \n - For Brazil QR Creation customer.type parameter is mandatory \n- For US RFP, this parameter is optional"
enum:
- INDIVIDUAL
- BUSINESS
example: BUSINESS
type: string
title: type
email:
description: "Customer email \n - For UK PAYBYBANK creation, customer.email parameter is mandatory."
example: customer.raj2024@gmail.com
pattern: '[a-z0-9._%+-]+@[a-z0-9.-]+\.[a-z]{2,4}$'
type: string
title: email
additional_info:
type: array
items:
$ref: '#/components/schemas/Additional-Info'
address:
$ref: '#/components/schemas/Address'
organization_id:
description: 'Customer Organization Id/ Legal Entity as provided at the time of payment request.
- For US RFP max length is 20'
example: ORG123456
maxLength: 35
minLength: 1
type: string
title: organization_id
birth_date:
type: string
format: date
description: "ISO 8601 (YYYY-MM-DD), Customer's birth_date \n- This parameter is optional only for US RFP "
title: birth_date
birth_city:
maxLength: 35
minLength: 1
type: string
description: "Customer's birth_city \n- For US RFP max length is 35"
title: birth_city
birth_country:
type: string
description: "Customer's birth_country \n- This parameter is optional only for US RFP "
pattern: ^[A-Z]{2,2}$
title: birth_country
birth_province:
description: Customer's birth province
type: string
maxLength: 35
minLength: 1
title: birth_province
private_id:
description: Customer private id
type: string
maxLength: 35
minLength: 1
example: '123456789'
title: private_id
Sender:
type: object
title: sender
properties:
name:
maxLength: 140
minLength: 1
type: string
description: "Sender Name \n - For US RFP transaction, this parameter is optional \n- For US ACH Direct Debit, sender.name parameter is optional with max length 35 \n- For Brazil PIX Initiation, this parameter is mandatory with max length 140"
title: name
address:
$ref: '#/components/schemas/Address'
organization_id:
description: 'Sender Organization Id/ Legal Entity as provided at the time of payment request.
- For US RFP max length is 20'
example: ORG123456
maxLength: 35
minLength: 1
type: string
title: organization_id
birth_date:
type: string
format: date
description: "ISO 8601 (YYYY-MM-DD), Sender's birth_date \n- FOr US RFP transaction, this parameter is optional"
title: birth_date
birth_city:
maxLength: 35
minLength: 1
type: string
description: "Sender's birth_city \n- For US RFP max length is 35"
title: birth_city
birth_country:
type: string
description: "Sender's birth_country \n- For US RFP transaction, this parameter is optional"
pattern: ^[A-Z]{2,2}$
title: birth_country
private_id:
maxLength: 35
minLength: 1
type: string
description: "Sender's private ID \n - Applicable for US RFP \n- For Brazil PIX Initiation, this parameter is mandatory, individual person tax identification (CPF) allowed length = 11 or business entity tax identification (CNPJ) allowed length = 14"
title: private_id
Name:
title: name
type: object
properties:
first_name:
description: "The payer's first name. \n - For Brazil QR and UK PAYBYBANK creation, name.first_name parameter is mandatory. \n- For US RFP this parameter is mandatory and full name has to be passed in this parameter \n- For US ACH Direct Debit, cutomer.name.first_name parameter is optional with max length 22"
example: JOHN
maxLength: 140
minLength: 1
type: string
title: first_name
last_name:
description: "The payer's last name. \n - For Brazil QR and UK PAYBYBANK creation, name.last_name parameter is mandatory."
example: PETER
maxLength: 50
minLength: 1
type: string
title: last_name
company_name:
description: The name of the company associated with this address.
example: COMPANY NAME
maxLength: 100
minLength: 1
type: string
title: company_name
Rfp-Customer-Notification:
type: object
title: RFP Customer Notification
properties:
account:
title: customer account
description: Account Details
properties:
number:
maxLength: 40
minLength: 1
type: string
description: "Customer's bank account \n- For US RFP this parameter is mandatory with max length 40"
example: '1122334455'
title: number
bank_id:
maxLength: 35
minLength: 1
type: string
description: "Customer bank's network identification \n- For US RFP this parameter is mandatory with max length 16 \n- For ACH, length is equal to 0"
example: CITIIN77
title: bank_id
name:
maxLength: 70
minLength: 1
type: string
description: "Customer's Account Name \n- For US RFP transaction, this parameter is optional "
title: name
name:
$ref: '#/components/schemas/Name'
organization_id:
description: 'Customer Organization Id/ Legal Entity as provided at the time of payment request.
- For US RFP max length is 20'
example: ORG123456
maxLength: 35
minLength: 1
type: string
title: organization_id
birth_date:
type: string
format: date
description: "ISO 8601 (YYYY-MM-DD), Customer's birth_date \n- For US RFP transaction, this parameter is optional"
title: birth_date
birth_city:
maxLength: 35
minLength: 1
type: string
description: "Customer's birth_city \n- For US RFP max length is 35"
title: birth_city
birth_country:
type: string
description: "Customer's birth_country \n- For US RFP transaction, this parameter is optional"
pattern: ^[A-Z]{2,2}$
title: birth_country
address:
$ref: '#/components/schemas/Address'
type:
type: string
description: "Customer type \n- For US RFP transaction, this parameter is optional"
enum:
- BUSINESS
- INDIVIDUAL
title: type
Receiver-Notification:
type: object
title: Receiver Notification
properties:
name:
description: "Receiver name. \n- For US RFP and UK PAYBYBANK transactions, receiver.name parameter is optional"
example: JOHN
maxLength: 140
minLength: 1
type: string
title: name
organization_id:
description: "Sender's org_id. \n- For US RFP and UK PAYBYBANK transactions, receiver.organization_id parameter is optional \n- For US ACH Direct Debit, this parameter is mandatory with max length 10"
example: ORG123456
maxLength: 35
minLength: 1
type: string
title: organization_id
birth_date:
type: string
format: date
description: "ISO 8601 (YYYY-MM-DD), Receiver's birth_date \n -For US RFP, receiver.birth_date parameter is optional"
title: birth_date
birth_city:
maxLength: 35
minLength: 1
type: string
description: "Receiver's birth_city \n- For US RFP transaction, receiver.birth_city parameter is optional and allowed max length is 35"
title: birth_city
birth_province:
description: Receiver's birth province
type: string
maxLength: 35
minLength: 1
title: birth_province
birth_country:
type: string
description: "Receiver's birth_country \n - For US RFP, receiver.birth_country parameter is optional"
pattern: ^[A-Z]{2,2}$
title: birth_country
private_id:
maxLength: 35
minLength: 1
type: string
description: "Receiver's private ID \n - For US RFP, receiver.private_id parameter is optional"
title: private_id
account:
title: Receiver account
description: Account details
properties:
issuer:
description: Entity that assigned account to the party
type: string
maxLength: 35
minLength: 1
example: ABC Ltd
title: issuer
address:
$ref: '#/components/schemas/Notification-Address'
Order-Notification:
title: Order Notification
properties:
id:
description: "A unique identifier for this order to distinguish it from any other order you create. \n- For CARD Authorize,Capture,Pay and Verify operation order.id parameter is mandatory \n- For ACH Pay and Verify transaction order.id parameter is mandatory"
example: OR123456789
maxLength: 40
minLength: 1
type: string
title: id
Rfp-Method-Notification:
type: object
title: RFP Method Notification
properties:
type:
description: "Method specified by the customer for the transaction \n- Provide RTP for US RFP \n- Provide PIX for Brazil RFP"
type: string
enum:
- RTP
- PIX
example: RTP
title: type
Payment-Request:
type: object
title: Payment Request
required:
- customer
- method
- transaction
properties:
customer:
$ref: '#/components/schemas/Customer'
sender:
$ref: '#/components/schemas/Sender'
merchant:
$ref: '#/components/schemas/Merchant'
receiver:
$ref: '#/components/schemas/Receiver'
method:
$ref: '#/components/schemas/Method'
transaction:
$ref: '#/components/schemas/Transaction'
order:
$ref: '#/components/schemas/Order'
mandate:
$ref: '#/components/schemas/Mandate'
shipping:
$ref: '#/components/schemas/Shipping'
authentication:
$ref: '#/components/schemas/Authentication'
risk:
$ref: '#/components/schemas/Risk'
additionalProperties: false
description: Payment Request
Transaction-Update:
type: object
title: Transaction Update
required:
- id
properties:
id:
description: "Unique Transaction identification provided by the merchant during transaction update \n- For CARD operations transaction.id parameter mandatory and allowed maxmium length is 40. \n- For ACH transaction, transaction.id parameter is mandatory and allowed maxmium length is 40. \n- For Brazil PIX Cancellation, this parameter is mandatory with min length 26 & max length 35 alphanumeric characters and the value should be same as sent during PIX Initiation request \n- For India CARD cancel transaction, transaction.id parameter mandatory and allowed maxmium length is 50."
example: pay02052023456r
maxLength: 128
minLength: 1
type: string
title: id
expiry_time:
type: integer
format: int32
minimum: 10
description: "Expiration time for QR collection, specified in seconds \n- QR Creation request will be rejected, if Expiration time value is less than 10 "
example: 3600
title: expiry_time
amount:
type: number
minimum: 0.01
maximum: 1000000000000000000
description: "Transaction amount \n - For Brazil QR Update decimal values are mandatory for transaction.amount and it must have 2 digits \n - For Brazil QR Update maxmium amount limit is 9999999999.99 \n- For CARD Update Authorization operation transaction.amount parameter is mandatory \n- For CARD Void/Cancel operation transaction.amount parameter is mandatory"
example: 200
title: amount
reference:
description: "Transaction additional information. \n- For Brazil PIX Cancellation, this parameter is mandatory with min length 26 & mmax length 35 and input should be same as unique identifier (transaction.id) given during PIX Initiation"
example: REPAY
maxLength: 250
minLength: 1
type: string
title: reference
currency_code:
type: string
enum:
- BRL
- USD
- INR
- GBP
description: "ISO 4217 Currency Code for instance USD/GBP/EUR. \n- For CARD Update Authorization operation transaction.currency_code parameter is mandatory \n- For CARD Void/Cancel operation transaction.currency_code parameter is mandatory \n- For ACH Void/Cancel transaction, transaction.currency_code parameter is mandatory \n- For India Card Cancel transaction, transaction.currency_code parameter is mandatory"
example: BRL
title: currency_code
country_code:
description: "The order country. n- For CARD Update Authorization operation transaction.country_code parameter is mandatory \n- For CARD Void/Cancel operation transaction.country_code parameter is mandatory \n- For ACH Void/Cancel transaction, transaction.country_code parameter is mandatory \n- For Brazil PIX Cancellation, this parameter is mandatory \n- For India Card Cancel transaction, transaction.country_code parameter is mandatory"
enum:
- US
- BR
- IN
- GB
example: US
type: string
title: country_code
reason:
description: "Cancellation/refund/adjustment reason. \n- For Brazil PIX Cancellation, this parameter is mandatory with max length 4 and allowed values are:
ACCT - Transactional Account Closure
BLCK - Transactional Account Blocking
CCLD - Cancellation of authorization for periodic payments
FAIL - Cancellation of the commitment for periodic payments
OTHR - Cancellation of the commitment for periodic payments
SLBD - Requested by the paying user
SLCR - Requested by the receiving user"
example: REPAY
maxLength: 140
minLength: 1
type: string
title: reason
url:
$ref: '#/components/schemas/Url-Update'
target_transaction_id:
description: "The identifier for the transaction you wish to refund, That is the {transactionId} URL parameter for REST and the transaction.id parameter for NVP. \n- For CARD Void/Cancel operation transaction.target_transaction_id parameter is mandatory \n- For ACH Void/Cancel transaction, transaction.target_transaction_id parameter is mandatory"
example: T123456789
maxLength: 40
minLength: 1
type: string
title: target_transaction_id
acquirer:
$ref: '#/components/schemas/Acquirer'
charge_amount:
description: The amount of the additional fee that you are charging the payer.
example: '20.0'
maxLength: 14
minLength: 1
type: string
title: charge_amount
charge_type:
description: The type of the additional fee that you are charging the payer.
enum:
- SURCHARGE
example: SURCHARGE
type: string
title: charge_type
correlation_id:
description: A transient identifier for the request, that can be used to match the response to the request.
example: TEFG123456
maxLength: 128
minLength: 1
type: string
title: correlation_id
update_flag:
type: string
enum:
- Y
- N
description: For QR Creation (ex. Brazil), during transaction processing if the merchant want to allow his client to change QR Amount then the value should be Y otherwise default value will be N
example: Y
title: update_flag
qr_image:
type: string
enum:
- Y
- N
description: Merchant to confirm QR Image is required or not, If required value should be Y
example: Y
title: qr_image
additional_info:
type: array
items:
$ref: '#/components/schemas/Additional-Info'
Ach:
title: ach
type: object
description: "\n- For ACH Pay operation method.ach parameter is mandatory when method.type parameter is selected as ACH \n- For ACH Verify operation method.ach parameter is is mandatory when method.type parameter is selected as ACH"
properties:
sec_code:
description: "Identifies the Standard Entry Class (SEC) code to be sent to the issuer where WEB = Internet Initiated/Mobile Entry, TEL = Telephone-Initiated Entry, PPD = Prearranged Payment and Deposit, CCD = Corporate Credit or Debit Entry, IAT = International ACH Transaction. \n - For ACH Pay transaction method.ach.sec_code parameter is mandatory \n- For US ACH Direct Debit, method.ach.sec_code parameter is mandatory with the following allowed values - IAT, CCD, PPD, and WEB"
enum:
- WEB
- TEL
- PPD
- CCD
- IAT
example: WEB
type: string
title: sec_code
Acquirer:
title: acquirer
type: object
description: Acquirer
properties:
custom_data:
description: Additional information requested by the acquirer which cannot be passed using other available data parameters.
example: PAYEMNT FOR GOODS
maxLength: 2048
minLength: 1
type: string
title: custom_data
transaction_id:
description: This is the value provided to the acquirer to identify the order.
example: AQ1234567
maxLength: 100
minLength: 1
type: string
title: transaction_id
trace_id:
description: The unique identifier that allows the issuer to link related transactions.
example: AQ1234567
maxLength: 15
minLength: 1
type: string
title: trace_id
Lines:
type: string
maxLength: 100
minLength: 1
description: "Address Lines \n- For US RFP only one(1) line of 70 characters is allowed \n- For US ACH Direct Debit payment, unstructured address_lines is mandatory when structured address parameters are not provided and allowed three instances with each line max length of 35 characters. Address Line 1 should have Building info followed by asterik, Street Address ends with a single backslash. Address Line2 should have City followed by asterik, State ends with a single backslash. Address Line 3 should have Zip Code followed by asterik, Country Code ends with a single backslash. For example Zip code*US\\."
title: lines
Rfp-Merchant-Notification:
type: object
title: RFP Merchant Notification
properties:
account:
title: merchant account
description: Account Details
properties:
number:
maxLength: 40
minLength: 1
type: string
description: "Merchant's bank account \n- For US RFP this parameter is mandatory with max length 40"
example: '1122334455'
title: number
bank_id:
maxLength: 35
minLength: 1
type: string
description: "Merchant bank's network identification \n- For US RFP this parameter is mandatory with max length 16 \n- For Brazil PIX, this parameter is mandatory with max length 8"
example: CITIIN77
title: bank_id
name:
maxLength: 70
minLength: 1
type: string
description: "Merchant's Account Name \n- Mandatory for US RFP "
title: name
name:
maxLength: 140
minLength: 1
type: string
description: "Merchant Name \n- For US RFP this parameter is mandatory with max length 140"
title: name
address:
$ref: '#/components/schemas/Address'
organization_id:
description: 'Merchant Organization Id/ Legal Entity as provided at the time of payment request.
- For US RFP max length is 20'
example: ORG123456
maxLength: 35
minLength: 1
type: string
title: organization_id
birth_date:
type: string
format: date
description: "ISO 8601 (YYYY-MM-DD), Merchant's birth_date \n- For US RFP transaction, this parameter is optional"
title: birth_date
birth_city:
maxLength: 35
minLength: 1
type: string
description: "Merchant's birth_city \n- For US RFP max length is 35"
title: birth_city
birth_country:
type: string
description: "Merchant's birth_country \n- For US RFP transaction, this parameter is optional"
pattern: ^[A-Z]{2,2}$
title: birth_country
phone_number:
type: string
maxLength: 35
description: "Merchant's phone number \n- For US RFP transaction, this parameter is optional"
pattern: \+[0-9]{1,3}-[0-9()+\-]{1,30}
title: phone_number
Payment-Response:
type: object
title: Payment Response
properties:
id:
type: string
maxLength: 128
description: Unique reference number
example: pay02052023456r
title: id
status:
type: string
maxLength: 10
description: The transaction has successfully been created.
enum:
- CREATED
example: CREATED
title: status
description:
type: string
maxLength: 200
description: more information about the status
example: The transaction has successfully been created
title: description
Risk:
type: object
title: Risk
properties:
custom:
maxLength: 4000
minLength: 1
type: string
description: Additional data passed to third-party risk assessment providers.This parameter is only relevant if you use a third-party risk assessment provider, and you have agreed with them the values to provide
title: custom
payment_recipient:
$ref: '#/components/schemas/Payment-Recipient'
Rfp-Receiver-Notification:
type: object
title: RFP Receiver Notification
properties:
name:
maxLength: 140
minLength: 1
type: string
description: "Receiver Name \n- For US RFP transaction, this parameter is optional"
title: name
address:
$ref: '#/components/schemas/Address'
organization_id:
description: 'Receiver Organization Id/ Legal Entity as provided at the time of payment request.
- For US RFP max length is 20'
example: ORG123456
maxLength: 35
minLength: 1
type: string
title: organization_id
birth_date:
type: string
format: date
description: "ISO 8601 (YYYY-MM-DD), Receiver's birth_date \n- For US RFP transaction, this parameter is optional"
title: birth_date
birth_city:
maxLength: 35
minLength: 1
type: string
description: "Receiver's birth_city \n- For US RFP max length is 35"
title: birth_city
birth_country:
type: string
description: "Receiver's birth_country \n- For US RFP transaction, this parameter is optional"
pattern: ^[A-Z]{2,2}$
title: birth_country
private_id:
maxLength: 35
minLength: 1
type: string
description: "Receiver's private ID \n- For US RFP transaction, this parameter is optional"
title: private_id
Authentication:
type: object
title: Authentication initiation request
properties:
acs_eci:
description: Electronic Commerce Indicator (ECI) value provided by the issuer's ACS.
example: '56'
maxLength: 2
minLength: 1
type: string
title: acs_eci
token:
description: The base64 encoded value generated by the issuer (CAVV/AAV/AEVV/Authentication Value).
example: '56'
maxLength: 32
minLength: 28
type: string
title: token
3ds_transaction_id:
description: A unique identifier for the 3-D Secure authentication transaction (XID for v1, DS ID for v2).
example: '56'
maxLength: 50
minLength: 1
type: string
title: 3ds_transaction_id
acs_reference:
description: A unique transaction
example: '56'
maxLength: 32
minLength: 1
type: string
title: acs_reference
acs_transaction_id:
description: A unique transaction identifier assigned by the Access Control Server (ACS).
example: '56'
maxLength: 36
minLength: 36
type: string
title: acs_transaction_id
scheme:
description: The EMV 3DS authentication scheme used (e.g., MADA, MASTERCARD, VISA).
example: '56'
maxLength: 50
minLength: 2
type: string
title: scheme
custom:
description: Additional information returned by the scheme or issuer in the authentication response.
example: '56'
maxLength: 4000
minLength: 1
type: string
title: custom
directory_server_reference:
description: Reference number assigned to the Directory Server (DS) by EMV Co.
example: '56'
maxLength: 32
minLength: 1
type: string
title: directory_server_reference
protocol_version:
description: The version of the EMV 3-D Secure protocol used (e.g., 2.1.0).
example: CART123456
maxLength: 20
minLength: 1
type: string
title: protocol_version
status_reason_code:
description: A code indicating the reason for the transaction status (EMVCo specification).
example: '56'
maxLength: 2
minLength: 2
type: string
status:
description: Indicates the result of payer authentication with the issuer (e.g., Y, N, U, A, R).
example: Y
maxLength: 1
minLength: 1
type: string
title: status
payment_exemption:
description: Indicates why this payment qualifies for an SCA exemption.
enum:
- AUTO
- LOW_RISK
- LOW_VALUE_PAYMENT
- TRUSTED_MERCHANT
- MERCHANT_INITIATED_TRANSACTION
- RECURRING_PAYMENT
- SECURE_CORPORATE_PAYMENT
- TRUSTED_MERCHANT
example: TRUSTED_MERCHANT
type: string
title: payment_exemption
time:
type: string
format: date-time
description: Date and time of the payer authentication being performed (YYYY-MM-DDThh:mm:ss.SSSZ).
example: '2022-09-13T08:23:49.114Z'
title: time
transaction_id:
description: Identifier used by the acquirer to identify the transaction. This identifier may be used by the acquirer in settlement reports.
example: ACQ7894561
maxLength: 40
minLength: 1
type: string
title: transaction_id
amount:
description: "Product amount \n - For UK PAYBYBANK creation, product_info.amount parameter is mandatory, if product_info object is selected"
example: 200
maximum: 1000000000000000000
minimum: 0.01
type: number
title: amount
Response:
title: Response
description: Response
properties:
acquirer_code:
description: Indicates success or failure of the transaction registration. A value of 0 (zero) indicates success, and a value of 99 indicates failure.
example: ACQ7894561
maxLength: 100
minLength: 1
type: string
title: acquirer_code
acquirer_message:
description: An additional message indicating the success or failure of the transaction registration. If the registration was successful, this parameter contains the value Data Received. If the registration failed, this parameter contains the value Data Not Receive.
example: MSG12345
maxLength: 255
minLength: 1
type: string
title: acquirer_message
card_holder_verification:
$ref: '#/components/schemas/avs'
Order-Update:
title: Order Update
properties:
id:
description: "A unique identifier for this order to distinguish it from any other order you create. \n- For CARD Update Authorization operation order.id parameter is mandatory \n- For CARD Void/Cancel operation order.id parameter is mandatory \n- For ACH Void/Cancel transaction, order.id parameter is mandatory \n- For India Card Cancel transaction, order.id parameter is mandatory"
example: OR123456789
maxLength: 50
minLength: 1
type: string
title: id
amount:
description: "The total amount for the order. This is the net amount plus any merchant charge amounts.If you provide any sub-total amounts, then the sum of these amounts (order.itemAmount, order.taxAmount, order.shippingAndHandlingAmount, order.cashbackAmount, order.gratuityAmount, order.merchantCharge.amount and order.dutyAmount), minus the order.discountAmount must equal the net amount.The value of this parameter in the response is zero if payer funds are not transferred. \n- For CARD Update Authorization operation order.amount parameter is mandatory \n- For CARD Void/Cancel operation order.amount parameter is mandatory"
example: 200
maximum: 1000000000000000000
minimum: 0.01
type: number
title: amount
currency_code:
description: The currency of the order expressed as an ISO 4217 alpha code, e.g. USD.
example: USD
type: string
title: currency_code
duty_amount:
description: The duty amount (also known as customs tax, tariff or dues) for the order.
example: 200
maximum: 1000000000000000000
minimum: 0.01
type: number
title: duty_amount
tax_amount:
description: The total tax amount for the order.If you do not provide this value but provide line item data, then this amount is calculated as the sum of the item.quantity times the item.unitTaxAmount for all the line items (total tax amount).If you provide both this value and line item data, then the order.taxAmount MUST equal the total tax amount.
example: INDENTITY1
maxLength: 14
minLength: 1
type: string
title: tax_amount
item_amount:
description: The total item amount for the order.If you do not provide this value but provide line item data, then this amount is calculated as the sum of the item.quantity times the item.unitPrice for all the line items (total item amount).If you provide both this value and line item data, then the order.itemAmount MUST equal the total item amount.
example: '100.00'
maxLength: 14
minLength: 1
type: string
title: item_amount
reference:
description: An optional identifier for the order For example, a shopping cart number, an order number, or an invoice number.
example: CART123456
maxLength: 200
minLength: 1
type: string
title: reference
additional_info:
type: array
items:
$ref: '#/components/schemas/Additional-Info'
type: object
Payment-Method:
type: array
title: Payment Method
items:
type: object
title: Items
properties:
type:
description: "Method specified by the customer for the transaction \n- PIX for brazil QR creation \n- CARD for CARD transactions \n- BOLETO for BOLETO transactions \n- ALIPAY for ALIPAY transactions \n- ACH for ACH transactions \n- FPS for PAYBYBANK transactions \n- RTP for US RFP transactions \n- GOOGLEPAY for Google pay transactions \n- APPLEPAY for Apple pay transactions"
type: string
maxLength: 20
minLength: 1
example: PIX
title: type
country_code:
description: Country where merchant onboarded for the payment method.
type: string
pattern: ^[A-Z]{2,2}$
example: BR
title: country_code
currency_code:
description: Currency code where merchant onboarded for the payment method.
type: array
items:
type: string
pattern: ^[A-Z]{3,3}$
example: BRL
title: currency_code
additionalProperties: false
Payment-Credit-Notification:
type: object
title: Payment Credit Notification
required:
- transaction
properties:
customer:
$ref: '#/components/schemas/Customer-Notification'
sender:
$ref: '#/components/schemas/Sender-Notification'
merchant:
$ref: '#/components/schemas/Merchant-Notification'
receiver:
$ref: '#/components/schemas/Receiver-Notification'
method:
$ref: '#/components/schemas/Method-Notification'
transaction:
$ref: '#/components/schemas/Transaction-Notification'
order:
$ref: '#/components/schemas/Order-Notification'
mandate:
$ref: '#/components/schemas/Mandate-Notification'
additionalProperties: false
description: Payment Notification
Pix:
title: Pix
description: "\n - For Brazil QR creation method.pix parameter is mandatory when method.type parameter is selected as PIX"
properties:
tax_id:
description: "Customer's payer identification (e.g., email address) \n - For Brazil QR Creation, method.pix.tax_id parameter is mandatory, individual person tax identification (CPF) allowed length = 11 or business entity tax identification (CNPJ) allowed length = 14"
example: 1.020.340/8910-22
maxLength: 128
minLength: 1
type: string
title: tax_id
Payment-Cancelled-Notification:
type: object
title: Payment Cancelled Notification
properties:
transaction:
type: object
title: PC_transaction
properties:
id:
maxLength: 128
minLength: 1
type: string
description: "Unique Transaction identification provided by the merchant during transaction creation \n- transaction.id parameter is mandatory for all transaction type creation \n- For Brazil QR Creation transaction.id parameter should be of length between 26 to 35 and allowed datatype is Alphanumeric and should not be filled with spaces or zeroes"
example: pay02052023456r
title: id
status:
type: string
enum:
- CANCELLED
description: "Transaction Status \n- CANCELLED - Transaction cancelled"
title: status
description:
type: string
maxLength: 200
description: "Transaction Status Description \n- CANCELLED - Transaction cancelled "
example: Transaction cancelled
title: description
Error-Response:
type: object
title: Error Response
properties:
ref_id:
type: string
maxLength: 60
description: Unique ID for the Transaction
title: ref_id
error_details:
type: array
uniqueItems: true
items:
$ref: '#/components/schemas/Error-Detail'
Payment-Created-Notification:
type: object
title: Payment Created Notification
properties:
transaction:
type: object
title: Payment Created Notification Transaction
properties:
id:
maxLength: 128
minLength: 1
type: string
description: "Unique Transaction identification provided by the merchant during transaction creation \n- transaction.id parameter is mandatory for all transaction type creation \n- For Brazil QR Creation transaction.id parameter should be of length between 26 to 35 and allowed datatype is Alphanumeric and should not be filled with spaces or zeroes"
example: pay02052023456r
title: Id
expiry_time:
type: integer
format: int32
minimum: 10
description: "Expiration time for QR collection, specified in seconds \n- QR Creation request will be rejected, if Expiration time value is less than 10"
example: 3600
title: expiry_time
status:
type: string
enum:
- PENDING
- CANCELLED
- DECLINED
- SETTLED
description: "Transaction Status \n- PENDING - Transaction pending action from customer \n- CANCELLED - Transaction cancelled \n- DECLINED- Transaction declined by the payment processor \n- SETTLED - Transaction settled"
title: status
description:
type: string
maxLength: 200
description: "Transaction Status \n- PENDING - Transaction pending action from customer \n- CANCELLED - Transaction cancelled \n- DECLINED- Transaction declined by the payment processor \n- SETTLED - Transaction settled"
example: The transaction has successfully been created
title: description
update_count:
type: integer
format: int32
description: Denotes the collection review. It always starts at zero. It always varies in increments of 1, if any updation done on QR creation)
example: 1
title: update_count
qr_string:
type: string
maxLength: 512
description: Dynamic QR Code based on the merchant payload request
example: 00020101021226700014br.gov.bcb.pix.citi.com.br/qr/2/8b3da2f39a4140d1a91abd93113bd44 15204000053039865802BR5913Fulano de Tal6008BRASILIA62070503***630464E4
title: qr_string
creation_date_time:
type: string
format: date-time
description: "GMT (ISO 8601 YYYY-MM-DDTHH:MM:SS.sssZ) \n- Instant Payment (Debit) - Date time, generated by CitiConnect API, when CitiConnect API accepted a payment initiation after validation \n- Instant Payment (Credit) - Date time, either provided by the debtor bank or generated by Citi's transaction processing application, when a transaction was created"
example: '2022-09-13T08:23:49.114Z'
title: creation_date_time
update_flag:
type: string
enum:
- Y
- N
description: For QR Creation (ex. Brazil), during transaction processing if the merchant want to allow his client to change QR Amount then the value should be Y otherwise default value will be N
example: Y
title: update_flag
qr_byte_code:
type: string
format: byte
description: QR Image
example: iVBORw0KGgoAAAANSUhEUgAAAMgAAADICAYAAACtWK6eAAAYV0lEQVR4Xu3T26osu3JF0f3/P21jmMKmQa+QKlWbg8kO8TAuEaWci/XPf728vCT/aLy8vPwv73+Ql5cPvP9BXl4+8P4HeXn5wPsf5OXlA+9/kJeXD7z/QV5ePvD+B3l5+cD7H+Tl5QPvf5CXlw+8/0FeXj7w/gd5efnA+x/k5eUD73+Ql5cPvP9BXl4+8P4HeXn5wPsf5OXlA+9/kJeXD1z9D/LPP/98NdP+lNuzX1qme4spX9gr7VQu5lNP7VQu5lNPyhfv785Nrl7zobsz7U+5PfulZbq3mPKFvdJO5WI+9dRO5WI+9aR88f7u3OTqtdMH2p/0RPX1S+ubT1rffBf7dV+/8l2qrz/pwp7vrnyX0/4OV6+dPtD+pCeqr19a33zS+ua72K/7+pXvUn39SRf2fHflu5z2d7h6zQf64ZUXlU/3Jt/ZpfYmX61vLrWnfurXVG+X2vtWO+Y3uXrNB/ohlReVT/cm39ml9iZfrW8utad+6tdUb5fa+1Y75je5es0H+iGVly5frV8zUf3SNcXUM7enlikvas93VO9bvLerHfObXL3mA/2QykuXr9avmah+6Zpi6pnbU8uUF7XnO6r3Ld7b1Y75Ta5e84F+SOVSvnh3d57u1xSVn/oTvmca90qX7z2nmPKFPe9XfpOr13ygH1K5lC/e3Z2n+zVF5af+hO+Zxr3S5XvPKaZ8Yc/7ld/k6rXTB1a//MI/mPulawpz96aZqH7p8ovdvKYwL61vLuUXp/0drl47fWD1yy/8B3C/dE1h7t40E9UvXX6xm9cU5qX1zaX84rS/w9Vr/iF2x/1Xv/r/6tO5ydVrPnR33H/1q/+vPp2b3L32ED/UEf1Jlz/9zsK89krXSOX6lRe1N+WlHfNdTvv/Jv9Rr/IP7oj+pMuffmdhXnula6Ry/cqL2pvy0o75Lqf9f5Orr/JDpz+gI/pqme4t7J2Od3a1vrm+U73yT2e6M+X27J9Se/rT7z/h6jUfWA/XN7dXWqZ7C3un451drW+u71Sv/NOZ7ky5Pfun1J7+9PtPuHvtDx+qFnM/2LEn+qdapnyXulP+YsoX9pbWNy/ct1+++S72T++rb3D32h8+VC3m/mEce6J/qmXKd6k75S+mfGFvaX3zwn375ZvvYv/0vvoGd69BPbg+XC3uOfbUk1+52HeqV37NLrv96f7kVy5Tz3tOUT31TX5z9Y96+Lcf6p5jTz35lYt9p3rl1+yy25/uT37lMvW85xTVU9/k6lU/wIer9Z1d7JeusVe4Z19d7PYmfIcj+qf6W7/wvY6U/0uu/pof6Aep9Z1d7JeusVe4Z19d7PYmfIcj+qf6W7/wvY6U/0uu/pof6Aed6vJ3tX7ljuirpfLyT/GOepfTvW/77u36zsRu74Sr1/wgH3yqy9/V+pU7oq+Wyss/xTvqXU73vu27t+s7E7u9E65eu/1A75XWl+rpO1PvNJfJNy+tby6Tb17aMZddX134+7t7J1y9dvuB3iutL9XTd6beaS6Tb15a31wm37y0Yy67vrrw93f3Trh77Q8fWrqmeqI/6cKevzvNr/F31JO/mHKxrxbzpctXO/8J/OQVfmDpmuqJ/qQLe/7uNL/G31FP/mLKxb5azJcuX+38J3D1FX7gNNNe5aJ/S+uLeWlnyqv3Le6X1hfz3b3F1Ku8fmfSN7h6zQ+ZZtqrXPRvaX0xL+1MefW+xf3S+mK+u7eYepXX70z6Blev1QMnv/KFuXvm9k61fuXVm3C/7uiX1jeXya+xp3ZOcd87p/4Nrl6rB05+5Qtz98ztnWr9yqs34X7d0S+tby6TX2NP7ZzivndO/RtcveZDTx9ce6e++UTd0TefqP63fk1hXtoRc3vlT7m6uN074eo1/xCnD669U998ou7om09U/1u/pjAv7Yi5vfKnXF3c7p1w9druH2K3V0z7+jLlhfcde1J+Ufcn7Ktv+WqZ3l++VE9ffYOr1+oPUrr8iWlfX6a88L5jT8ov6v6EffUtXy3T+8uX6umrb3D12vQHKdyrfX21fs23vV0tleurxby0/pSrxfxb7VSuL6f+E65eqw+dcK/29dX6Nd/2drVUrq8W89L6U64W82+1U7m+nPpPuHsNpg93ptyxL/Z3Z9qvXCbfMZ90+RO7vcL9eo/5hL1JT/4NfnP1j/rD6e/mjn2xvzvTfuUy+Y75pMuf2O0V7td7zCfsTXryb3D1av2hyjdXTyPli73p7sKeI/ql9c2L3dzerm9ePf3Sp75apvwGV69Pfzh9c/U0Ur7Ym+4u7DmiX1rfvNjN7e365tXTL33qq2XKb/DT6/4h/SD90/HOri5/uu9ULuUvzEtPfuW7VF9/0kX1ypfVs1/+De5eAx/uB+ifjnd2dfnTfadyKX9hXnryK9+l+vqTLqpXvqye/fJvcPXa9NDy5fSO/Wncm/Q0U9+8cK/GvlrfXNyrsS/lL8zV+lP+b3D1V2592Okd+9O4N+lppr554V6NfbW+ubhXY1/KX5ir9af83+Dqr/hwP3R33Fc7om/f2e05056Uv9jN7elPI5PvyGl+2judm1y95gN9+O64r3ZE376z23OmPSl/sZvb059GJt+R0/y0dzo3uXrNh/pgtbjnVE9/V+tXvrDnTD2Z/MqLqT/dnXKxN+1XXr7s9m5y9Vf8AD9ELe451dPf1fqVL+w5U08mv/Ji6k93p1zsTfuVly+7vZv8K79SH1a6fPXuuKd2zNX6E/bV5Z/+nr1Jl3/6u4tpr/yF+aQn/wa/uQr1hytdvnp33FM75mr9Cfvq8k9/z96kyz/93cW0V/7CfNKTf4OfXPXB0x9uUfmury7qPWpxb+oX7ql3cU8t5uqJ+m51+bVvXpirf8FPrvvw6Q+zqHzXVxf1HrW4N/UL99S7uKcWc/VEfbe6/No3L8zVv+DqdR/sH2R33FfXVE/MT0d281Pcq9/Rn8Y99a4vU0/f/ulI+U+4es0H+kG74766pnpifjqym5/iXv2O/jTuqXd9mXr69k9Hyn/C1Wu7D6yef4CaYsrFvrr8Xa1vLvpqfXO1VO696i3sTf2F/dqbcjntn3D12u4Dq+eH1hRTLvbV5e9qfXPRV+ubq6Vy71VvYW/qL+zX3pTLaf+Eq9emh+rbd6T8wnvul9Y3F/26U775pPWLqV/5pCd/YT5pfUfMq/eEq9emh+rbd6T8wnvul9Y3F/26U775pPWLqV/5pCd/YT5pfUfMq/eEu9cCHz7p8v1D1ExUXz1Rd05z9a5vLuUv6u6kT/36HfNd7E/3n3D3WuDDJ12+f4iaieqrJ+rOaa7e9c2l/EXdnfSpX79jvov96f4T7l77ox6qr97FvfoD7fqOmDv2Spc/3dM3l9M99YT9+j31LrWn7++a3+DutT/qofrqXdyrP9Cu74i5Y690+dM9fXM53VNP2K/fU+9Se/r+rvkNrl779oH1gZMu33uOPXX5Uv2ieuUX0+/qT1rqvrqofXO1fmF/d+8brl799qH1oZMu33uOPXX5Uv2ieuUX0+/qT1rqvrqofXO1fmF/d+8brl7dfagf5shp7siu7x1H9Kt/6ldur/wp3/UrL8zV+pUvqlf+Da5e232gH+TIae7Iru8dR/Srf+pXbq/8Kd/1Ky/M1fqVL6pX/g2uXvOhuw+eet6zP/ky+TVi7hTV03emnrmUvzBXP/VrxNyRKX/C1Ws+dPfBU8979idfJr9GzJ2ievrO1DOX8hfm6qd+jZg7MuVPuHrNh/rgUy3eta+W2hN7u/1vtb65vmNPrW8up/7C/Kme/MWUP+Hq1fVQx3xXi3ftq6X2xN5u/1utb67v2FPrm8upvzB/qid/MeVPuHrVh6onf2G+9Lf+aX7KtF+/U1pfpnxR98oXc3X5ajGftFRe/hOuXvOB6slfmC/9rX+anzLt1++U1pcpX9S98sVcXb5azCctlZf/hLvXgvVwP6D8onqTv5tPvVO869ibcN8RffUtf3qH7PbN1fqVP+HutaA+oPyiepO/m0+9U7zr2Jtw3xF99S1/eofs9s3V+pU/4e61P3ywD9/VzpQ7E/Zqv3yxZ19/d2TyzXd1jb3S+o65lF/YV9/g7rU//MP48F3tTLkzYa/2yxd79vV3RybffFfX2Cut75hL+YV99Q2uXqsHTn7li9NcLfW75e/mC/NdXWNPTvsL96aRytW/9tU3uXq1Hjr5lS9Oc7XU75a/my/Md3WNPTntL9ybRipX/9pX3+TqVR+6tCP6ky7sqcv3fY6UL9WbfHO1vvmk9R1zdflF5eWfUu+6wdVrPtCHm9vb1YU9dfm+z5HypXqTb67WN5+0vmOuLr+ovPxT6l03uHvtj+nB3+bqXd/5Fu/UvVNfvO/eri5/0s4uu3vm7pkXu70n/OT69KHf5upd3/kW79S9U1+8796uLn/Szi67e+bumRe7vSf89npQH1Z/oNLObm5PXb7ou+/Ym6he3T3NxT1Hyi+8N+1PuZz2d7h7bZP6kPrDlXZ2c3vq8kXffcfeRPXq7mku7jlSfuG9aX/K5bS/w91rf0wP9Q/kVE+/9FOme/Wuwl7tn+ryvW++2yutX0z9b/3Kf8FPfmX6AD/UqZ5+6adM9+pdhb3aP9Xle998t1dav5j63/qV/4Krv1IP15/0LtMfTF+tX/m3eHca9ybcr70pL+yrn/rmpfXNS9/g6rV6oP6kd7n1B5zufIt3p3Fvwv3am/LCvvqpb15a37z0De5e+8OHqvUrL+zXHf3KRb/25TRXl//t76t3/ZrqSfmFfe9XLuU/4e61P3yoWr/ywn7d0a9c9GtfTnN1+d/+vnrXr6melF/Y937lUv4Trl57+kD3T/Uua6/2zaee1N6kC3ver/xb/SvfXC1TvtjtfcPVq08f6v6p3mXt1b751JPam3Rhz/uVf6t/5ZurZcoXu71v+M3VP/zD7I6UX1Rfv/Q0xdTT3+3XiPk0xZQvvOeeesI7NfZ/yU+v+2G7I+UX1dcvPU0x9fR3+zViPk0x5Qvvuaee8E6N/V9y9bofUlOYT7qwN/3+lC8qn/bLL6o/+ZUvpryoPX936k1aX+xN/Rtcve7DawrzSRf2pt+f8kXl0375RfUnv/LFlBe15+9OvUnri72pf4Or1+vB9UGTLrznFNWb/NJirtavqd6EvdL6Yu+0/9Tf1fqVP+HqtXpgfcCkC+85RfUmv7SYq/Vrqjdhr7S+2DvtP/V3tX7lT7h6bXpo+Qv3HXtF7Ym90/5TvOcUlZe/8L4zUb1f+wvfa199g6vX6uHmhfuOvaL2xN5p/ynec4rKy19435mo3q/9he+1r77B3WsDfliN/cK9adwT+7vj/qT1d6k9705TmE97+vbNxd7T+QW/uRr4QTX2C/emcU/s7477k9bfpfa8O01hPu3p2zcXe0/nF/zkaj188kvrm+uby25eY2/St3w57S/cm/qLqb+bq3f9Yrf3DT+5Wh84+aX1zfXNZTevsTfpW76c9hfuTf3F1N/N1bt+sdv7ht9cDfzw3Q+rvrp8980L+84t6p6/5xRTvqiev+MU1Zv0rm+u/gW/vQ5+6O4HVl9dvvvmhX3nFnXP33OKKV9Uz99xiupNetc3V/+Cq9frwX7gac857dec4p76lNovv5i+S189+Qtz9VPfXF1+7d/g6rV6oB9w2nNO+zWnuKc+pfbLL6bv0ldP/sJc/dQ3V5df+ze4ew18uB9QetcXe86EvdJOUb3J38V+3Z1y9S1fPfmLypdf+S/46a/4QX5Y6V1f7DkT9ko7RfUmfxf7dXfK1bd89eQvKl9+5b/g6q/4Aacf8nTvVNeIvv2aidP+hHfqfvkT1Z9880nrT/kvuXrdDzr9gKd7p7pG9O3XTJz2J7xT98ufqP7km09af8p/ydXrPri0s8tpX/zd3Xv23dM3L6Ze5fqld32Z8sK9SZd/qif/CVev+cDSzi6nffF3d+/Zd0/fvJh6leuX3vVlygv3Jl3+qZ78J9y99sd66O6D7ddI5fo13/bdm6g7+k719IvK9et+5U719G/xb/3O/3D32h/1AYX9Gqlcv+bbvnsTdUffqZ5+Ubl+3a/cqZ7+Lf6t3/kfrl7zgWp9x1yt/5S6p3/790/v2SutX3n1xJ5616+ZeuZiv3pPuHrNB6r1HXO1/lPqnv7t3z+9Z6+0fuXVE3vqXb9m6pmL/eo94eo1H+jDzaee/VP/V/h7jpz6RfVPf7/6an1zfad6suurZcq/4eo1H+gfxnzq2T/1f4W/58ipX1T/9Perr9Y313eqJ7u+Wqb8G65e8w/hyORXvqhcv/TkO1NPvvUrl+qX1jffpfr+TvUWleurZff3vuHqNR/qyORXvqhcv/TkO1NPvvUrl+qX1jffpfr+TvUWleurZff3vuHqNR94+vCp5z37+ubV01eXX1T+7b1F7VfuSPmLaX9h7p65vdL6jpT/hKvXfOD0QTL1vGdf37x6+uryi8q/vbeo/codKX8x7S/M3TO3V1rfkfKfcPWaH+CD9R0xt1f+Lu57Ry21Zy7Tnky9yiffXD1Rfe87spury7/J1Ws+3AfrO2Jur/xd3PeOWmrPXKY9mXqVT765eqL63ndkN1eXf5Or13YfPulTv7RjXrp879WIvlq/RspfmJcuX6q/y7RnXrr8X3D16u4HTPrUL+2Yly7fezWir9avkfIX5qXLl+rvMu2Zly7/F1y9uvsBU0/fXHZ9tb55+WKvpjjNvesU5moxr99R65ur9c0nv/QNrl47/ZBd31x2fbW+eflir6Y4zb3rFOZqMa/fUeubq/XNJ7/0De5eAz+sPkC/+pMv9p3qFealJ9+8elK5Wt+Rb/PJl/IXlZe/mPIn/ObqH/4B60P0qz/5Yt+pXmFeevLNqyeVq/Ud+TaffCl/UXn5iyl/wm+u/jE93D+wfbW459hT18ipv6i8fk8t5qWdKbdX/fIdMXfs7eKd0/0d7l6D6cF+mH21uOfYU9fIqb+ovH5PLealnSm3V/3yHTF37O3indP9Ha5emx445Yvq+YeYemr9yu2p9c3V5de+uehPdxb27JdvPlF31PrOKd/ufeLqtemBU76onn/AqafWr9yeWt9cXX7tm4v+dGdhz3755hN1R63vnPLt3ifuXvvDD62H609afzffndov3ylO87pbWr+YenWvtP6Ul3/K0/0TfvIr/iHqg/Qnrb+b707tl+8Up3ndLa1fTL26V1p/yss/5en+CT/5lekDzEs7t/Du7kz7lZdv/m1PTv2i+r/2ZfWcym9y99of00PNSzu38O7uTPuVl2/+bU9O/aL6v/Zl9ZzKb3L32h8+uB4+5XLac8R8dwp7ztSrXCZ/GvvytO9MvSl3ZMqfcPfaHz64Hj7lctpzxHx3CnvO1KtcJn8a+/K070y9KXdkyp9w99pD6kPV+pVL9XbvVF7+bep3Tt9fvcmvmaied6q3MJ/0De5ee0j9odT6lUv1du9UXv5t6ndO31+9ya+ZqJ53qrcwn/QNrl7zQ3en9ifsO7s9x73S+jXVk/IX5t6rXF2+2jnNJ+yd6sm/wdWr/sF2p/Yn7Du7Pce90vo11ZPyF+beq1xdvto5zSfsnerJv8HVq6cPtb+0/inuq4upZ17vLa0/UXvqyV94b+ov7O1q/WK3b76794SrV08fav/WB7uvLqaeeb23tP5E7aknf+G9qb+wt6v1i92++e7eE65e9aF+QOWiX/uVT1PYm0ZO/aL6k7877qlr7E24X3vmu1P7N7l6zQf68MpFv/Yrn6awN42c+kX1J3933FPX2Jtwv/bMd6f2b3L1mg/04ZWr9SemvcpL10j5i9rXd+yJ/d2e/qT1J3b3zNWTX5z2d7h6zQf6B6tcrT8x7VVeukbKX9S+vmNP7O/29CetP7G7Z66e/OK0v8PVaz7QP1jl6qfjvV2tbz7pierrqyfqvbv5wl7N1N9l2tOf9C+4et0H+weoXP10vLer9c0nPVF9ffVEvXc3X9irmfq7THv6k/4FV6+fPnjq+wesvrk9tb65Wp7uqcsvplzsq3dxT73rm09+4d7U/4ar104fOPX98Oqb21Prm6vl6Z66/GLKxb56F/fUu7755BfuTf1vuHrNh+6O+2r9ym/NKbv71St/ovr60/1vfXP909yeWt/8F1y96ofsjvtq/cpvzSm7+9Urf6L6+tP9b31z/dPcnlrf/Bf85urLy/8T3v8gLy8feP+DvLx84P0P8vLygfc/yMvLB97/IC8vH3j/g7y8fOD9D/Ly8oH3P8jLywfe/yAvLx94/4O8vHzg/Q/y8vKB9z/Iy8sH3v8gLy8feP+DvLx84P0P8vLygfc/yMvLB97/IC8vH3j/g7y8fOC/Acp9OPj144RMAAAAAElFTkSuQmCC
title: qr_byte_code
Order:
title: Order
properties:
id:
description: "A unique identifier for this order to distinguish it from any other order you create. \n- For CARD Authorize,Capture,Pay and Verify operation order.id parameter is mandatory \n- For ACH Pay and Verify transaction order.id parameter is mandatory \n - For India Card Capture transaction, order.id parameter is mandatory"
example: OR123456789
maxLength: 50
minLength: 1
type: string
title: id
amount:
description: "The total amount for the order. This is the net amount plus any merchant charge amounts.If you provide any sub-total amounts, then the sum of these amounts (order.itemAmount, order.taxAmount, order.shippingAndHandlingAmount, order.cashbackAmount, order.gratuityAmount, order.merchantCharge.amount and order.dutyAmount), minus the order.discountAmount must equal the net amount.The value of this parameter in the response is zero if payer funds are not transferred. /n- For CARD Operations post decimal allowed maxmium 3 digits /n- For CARD Authorize, PAY and VERIFY Operations order.amount parameter is mandatory \n- For ACH Pay and Verify transaction order.amount parameter is mandatory /n- For India CARD transaction, order.amount parameter is mandatory, minimum amount is 1 and maxmium amount limit is 1000000 "
example: 200
maximum: 1000000000000000000
minimum: 0.01
type: number
title: amount
currency_code:
description: "The currency of the order expressed as an ISO 4217 alpha code, e.g. USD. \n- For CARD Authorize operation order.currency_code parameter is mandatory \n- For CARD Capture operation order.currency_code parameter is mandatory \n- For CARD Pay operation order.currency_code parameter is mandatory \n- For CARD Verify operation order.currency_code parameter is mandatory \n- For BOLETO Pay operation order.currency_code parameter is mandatory \n- For ALIPAY Pay operation order.currency_code parameter is mandatory \n- For ACH Pay operation order.currency_code parameter is mandatory \n- For ACH Verify operation order.currency_code parameter is mandatory \n- For ACH Pay and Verify transaction order.currency_code parameter is mandatory /n- For India CARD transaction, order.currency_code parameter is mandatory"
enum:
- BRL
- USD
- GBP
- INR
- EUR
- CAD
- HKD
- AUD
- SGD
- DKK
- NOK
- SEK
- PLN
- IDR
- MYR
- THB
- CHF
- PHP
- CZK
example: USD
type: string
title: currency_code
charge_amount:
description: The amount of the additional fee that you are charging the payer.
example: '20.0'
maximum: 1000000000000000000
minimum: 0.01
type: number
title: charge_amount
charge_type:
description: The type of the additional fee that you are charging the payer.
enum:
- SURCHARGE
example: SURCHARGE
type: string
title: charge_type
item_amount:
description: The total item amount for the order.
example: 150
maximum: 1000000000000000000
minimum: 0.01
type: number
title: item_amount
shipping_and_handling_amount:
description: The total shipping and handling amount for the order, including taxes on the shipping and/or handling
example: 20
maximum: 1000000000000000000
minimum: 0.01
type: number
title: shipping_and_handling_amount
shipping_and_handling_tax_amount:
description: The tax amount levied on the shipping and handling amount for the order.
example: 20
maximum: 1000000000000000000
minimum: 0.01
type: number
title: shipping_and_handling_tax_amount
shipping_and_handling_tax_rate:
description: The tax rate applied to the shipping and handling amount for the order to determine the shipping and handling tax amount.
example: 20
maximum: 1000000000000000000
minimum: 0.01
type: number
title: shipping_and_handling_tax_rate
discount_amount:
description: The total amount of the discount you have applied to the order
example: 300
maximum: 1000000000000000000
minimum: 0.01
type: number
title: discount_amount
tax_registration_id:
description: Your tax registration identifier provided by the Federal/National tax authority (for example, federal tax identification number, ABN).If you are a Canadian merchant, use this parameter to provide your Tax Registration ID for paying Harmonized Sales Tax (HST) or Goods and Services Tax (GST) collected by the Canada Revenue Agency.
example: 300
maxLength: 30
minLength: 1
type: string
title: tax_registration_id
mcc:
description: A 4-digit code used to classify your business by the type of goods or services it offers. This is also known as the Merchant Category Code (MCC).You only need to provide the MCC if you want to override the default value configured for your acquirer link. The value you provide must match one of those configured by your payment service provider.
example: '7788'
maxLength: 4
minLength: 4
type: string
title: mcc
certainty:
description: Indicates if you expect to capture the full order amount for which you are requesting authorization.If you do not provide a value for order.certainty the default configured for you by your payment service provider will be used. The value provided in the response shows the value the gateway sent to the acquirer.
enum:
- ESTIMATED
- FINAL
example: FINAL
type: string
title: certainty
date:
description: The date the payer placed the order.
example: '1988-02-15'
format: date
type: string
title: date
description:
description: Short textual description of the contents of the order.
example: LAPTOP PURCHASE
maxLength: 127
minLength: 1
type: string
title: description
discount_code:
description: The code you use to identify the reason for the discount.
example: DISC001
maxLength: 40
minLength: 1
type: string
title: discount_code
discount_description:
description: A description of your reason for the discount.
example: CARD DISCOUNT
maxLength: 127
minLength: 1
type: string
title: discount_description
duty_amount:
description: The duty amount (also known as customs tax, tariff or dues) for the order. /n- For CARD Operations post decimal allowed maxmium 3 digits
example: 150
maximum: 1000000000000000000
minimum: 0.01
type: number
title: duty_amount
entity:
description: Your identifier for the part of your organization that is responsible for the order.You might provide this data when you want to track the accountability for the order. For example, store number, sales region, branch, or profit center.
example: INDENTITY1
maxLength: 40
minLength: 1
type: string
title: entity
purchase_type:
description: 'Indicates the purchase of specific types of goods or services You must provide a value if your Merchant Category Code (MCC) is one of the following: 6051 (Quasi Cash – Merchant or Non-Financial Institutions – Foreign Currency, Non-Fiat Currency) and this transaction is for the purchase of cryptocurrency. Set the value to CRYPTOCURRENCY. 6211 (Securities – Brokers/Dealers) and this transaction is for the purchase of high-risk securities. Set the value to HIGH_RISK_SECURITIES. 6012 (Merchandise and Services—Customer Financial Institutions) or 6051 (Non-Financial Institutions – Foreign Currency, Non-Fiat Currency) and this transaction is for debt repayment. Set the value to DEBT_REPAYMENT. If the transaction pulls money from an account for the purpose of crediting another account you must set purchase type to ACCOUNT_FUNDING. You may set purchase type to OTHER for any other type of payment.'
enum:
- ACCOUNT_FUNDING
- CRYPTOCURRENCY
- DEBT_REPAYMENT
- HIGH_RISK_SECURITIES
- OTHER
example: ACCOUNT_FUNDING
type: string
title: purchase_type
tax_amount:
description: The total tax amount for the order. If you do not provide this value but provide line item data, then this amount is calculated as the sum of the item.quantity times the item.unitTaxAmount for all the line items (total tax amount).If you provide both this value and line item data, then the order.taxAmount MUST equal the total tax amount.
example: '100.00'
maxLength: 14
minLength: 1
type: string
title: tax_amount
number_of_captures:
description: This parameter only applies if you intend to receive the payer's funds in several Capture operations. You must provide this value where you want the gateway to automatically reverse the outstanding Authorization amount you do not intend to capture. Note that this requires your merchant profile to be configured accordingly. Contact your payment service provider if you are unsure about your configuration.
example: 99
maximum: 99
minimum: 1
type: number
title: number_of_captures
retailer_location:
description: Provide information about the location of the retailers for goods or services included in this order. Where a retailer is located in a country different from your country, they are considered a foreign retailer, otherwise they are considered a domestic retailer.
enum:
- DOMESTIC_ONLY
- FOREIGN_AND_DOMESTIC
- FOREIGN_ONLY
example: FOREIGN_ONLY
type: string
title: retailer_location
reward_amount:
description: The amount that the payer has chosen to pay by redeeming reward points earned using a card enrolled in a rewards program for full or part payment for this purchase.
example: '100'
maxLength: 14
minLength: 1
type: string
title: reward_amount
balance_id:
description: An identifier generated by the gateway when you have requested the balance available for a credit or debit card.
example: '100'
maxLength: 100
minLength: 1
type: string
title: balance_id
avs_action:
description: The action to be performed for the Address Verification Service (AVS) Response Code.
enum:
- NO_ACTION
- REJECT
- REVIEW
example: REVIEW
type: string
title: avs_action
avs_response:
description: The Address Verification Service (AVS) Response Code for which you are defining the rule.
enum:
- ADDRESS_MATCH
- ADDRESS_ZIP_MATCH
- NAME_ADDRESS_MATCH
- NAME_MATCH
- NAME_ZIP_MATCH
- NOT_AVAILABLE
- NOT_REQUESTED
- NOT_VERIFIED
- NO_MATCH
- SERVICE_NOT_AVAILABLE_RETRY
- SERVICE_NOT_SUPPORTED
- ZIP_MATCH
example: ADDRESS_MATCH
type: string
title: avs_response
reference:
description: An optional identifier for the order For example, a shopping cart number, an order number, or an invoice number.
example: CART123456
maxLength: 200
minLength: 1
type: string
title: reference
invoice_number:
description: The invoice number you issued for this order
example: INV123456
maxLength: 25
minLength: 1
type: string
title: invoice_number
additional_info:
type: array
items:
$ref: '#/components/schemas/Additional-Info'
type: object
Authorization-Response:
title: Authorization-Response
description: Authorization Response
properties:
stan:
description: The System Trace Audit Number is assigned by a transaction originator to assist in identifying a Card Transaction.The trace number remains unchanged for the life of the Card Transaction.
example: AUD345
maxLength: 6
minLength: 1
type: string
title: stan
merchant_advice_code:
description: This parameter contains data returned by the issuer or card network to clearly communicate to merchants the reason for declining a MasterCard or Visa transaction Merchants can use this information to determine the best action to take.
example: '2'
maxLength: 2
minLength: 1
type: string
title: merchant_advice_code
pos_entry_mode:
description: The POS Entry Mode provided to Discover (JCB (US Domestic only), and Diners) for the authorization
example: '2'
maxLength: 4
minLength: 1
type: string
title: pos_entry_mode
return_aci:
description: The ACI (Authorization Characteristics Indicator) returned by the issuer
example: '1'
maxLength: 1
minLength: 1
type: string
title: return_aci
avscode:
description: The acquirer AVS response code generated by the card issuing institution
example: '1'
maxLength: 100
minLength: 1
type: string
title: avscode
commercial_card_indicator:
description: Indicates the type of commercial card as returned by the card issuer
example: '1'
maxLength: 3
minLength: 1
type: string
title: commercial_card_indicator
date:
type: string
description: "The local date, in MMDD format, on which the transaction occurred. \n- Format MMDD"
title: date
example: '0530'
financial_network_code:
description: Indicates the code of the financial network that was used to process the transaction with the issuer.
example: '1'
maxLength: 3
minLength: 1
type: string
title: financial_network_code
financial_network_date:
type: string
format: date
description: "The date for the Authorization as returned by the scheme. \n- Format YYYY-MM-DD"
example: '2024-05-30'
title: financial_network_date
pos_data:
description: Indicates the specific card information conditions for capture that are available when the card transaction occurs at point of service.
example: '1'
maxLength: 13
minLength: 3
type: string
title: pos_data
processing_code:
description: Identifies the type of Card Transaction sent to Card Acceptor
example: '1'
maxLength: 6
minLength: 1
type: string
title: processing_code
response_code:
description: The response code which indicates the status of the transaction
example: '1'
maxLength: 3
minLength: 1
type: string
title: response_code
time:
type: string
format: date-time
description: "GMT (ISO 8601 YYYY-MM-DDTHH:MM:SS.sssZ) \n- Instant Payment (Credit) - Date time, either provided by the debtor bank or generated by Citi's transaction processing application, when a transaction was created \n- For US RFP this parameter is mandatory"
example: '2022-09-13T08:23:49.114Z'
title: time
transaction_identifier:
description: The unique identifier for the transaction returned by the issuer.
example: '1'
maxLength: 30
minLength: 1
type: string
title: transaction_identifier
Url:
title: url
type: object
description: "URL. \n - For UK PAYBYBANK Creation transaction.url parameter is mandatory."
properties:
accepted:
description: "Acceptance URL. \n - For UK PAYBYBANK Creation transaction.url.accepted parameter is mandatory and maximum allowed length is 200 and URL should start either with http:// or https://"
example: accepted
maxLength: 2083
minLength: 1
type: string
title: accepted_url
declined:
description: "Declined URL. \n - For UK PAYBYBANK Creation transaction.url.declined parameter is mandatory and maximum allowed length is 200 and URL should start either with http:// or https://"
example: declined
maxLength: 2083
minLength: 1
type: string
title: declined_url
browser_payment_return:
description: "The URL of your website to which you want the payer's browser to be redirected on completing the payment interaction at the payment provider's website. \n - For Paypal transaction transaction.url.browser_payment_return field becomes mandatory, when transaction.url.app_payment_return field is not provided by client in the payment initiation request"
example: declined
maxLength: 2048
minLength: 1
type: string
title: browser_payment_return_url
app_payment_return:
description: "The URL of your app to which you want the payer to be redirected on completing the payment interaction at the payment provider's website or in the payment provider's app. \n - For Paypal transaction.url.app_payment_return is mandatory, if client not provided transaction.url.browser_payment_return "
example: declined
maxLength: 2048
minLength: 1
type: string
title: app_payment_return_url
Rfp-Response-Rfp-Notification:
type: object
title: RFP Response Rfp Notification
properties:
accepted_amount:
type: number
minimum: 0.01
maximum: 100000000000000000
description: Amount to be paid from Request for Payment
title: accepted_amount
accepted_currency:
type: string
description: 'ISO 4217 code for the accepted currency '
enum:
- USD
title: accepted_currency
scheduled_exec_date:
type: string
format: date
description: 'Date payment is expected to be made.Format is YYYY-MM-DD '
title: scheduled_exec_date
scheduled_exec_date_time:
type: string
format: date-time
description: Scheduled Execution Date/time of Payment UTC (ISO 8601 YYYY-MM-DDTHH:MM:SS.sssZ)
title: scheduled_exec_date_time
Shipping:
type: object
title: Shipping
properties:
address_same_as_billing:
description: Indicates whether the shipping address provided is the same as the payer's billing address.
enum:
- SAME
- DIFFERENT
- UNKNOWN
example: UNKNOWN
type: string
title: address_same_as_billing
recipient_name:
$ref: '#/components/schemas/Recipient-Name'
phone:
pattern: \+[0-9]{1,3}[-\ ][0-9()+\-]{1,30}
type: string
description: The contact person's phone number in ITU-T E123 format.
example: +1 607 1234 456
title: phone
type:
description: The type of shipping method used.
enum:
- ELECTRONIC
- GROUND
- NOT_SHIPPED
- OVERNIGHT
- PICKUP
- PRIORITY
- SAME_DAY
- VIRTUAL
- TRACKED_DELIVERY
- UNTRACKED_DELIVERY
- IN_STORE_PICKUP
- LOCKER_PICKUP
- HYBRID
example: SAME_DAY
type: string
title: type
email:
pattern: '[a-z0-9._%+-]+@[a-z0-9.-]+\.[a-z]{2,4}$'
type: string
description: The contact person's email address.The parameter format restriction ensures that the email address is longer than 3 characters and adheres to a generous subset of valid RFC 2822 email addresses.
example: xyjfg@gmail.com
title: email
origin:
maxLength: 10
minLength: 1
type: string
description: The post code or zip code of the address the order is shipped from.
example: '120567'
title: origin
source:
description: The type of shipping method used.
enum:
- ADDRESS_ON_FILE
- NEW_ADDRESS
example: NEW_ADDRESS
type: string
title: source
carrier:
maxLength: 200
minLength: 1
type: string
description: Service that shipped a physical product.
example: M455679
title: carrier
tracking_number:
maxLength: 40
minLength: 8
type: string
description: Tracking number.
example: T123456789
title: tracking_number
additional_info:
type: array
items:
$ref: '#/components/schemas/Additional-Info'
address:
$ref: '#/components/schemas/Shipping-Address'
Method-Notification:
type: object
title: Method Notification
required:
- type
properties:
type:
description: Method specified by the customer for the transaction
type: string
enum:
- PIX
- UPI
- RTP
- FPS
- ACH
- WIRE
- IMPS
- IP
- FT
example: PIX
title: type
upi:
$ref: '#/components/schemas/Upi'
sec_code:
description: Identifies the Standard Entry Class (SEC) code to be sent to the issuer.
minLength: 1
maxLength: 3
type: string
example: CCD
title: sec_code
Method:
type: object
title: method
required:
- type
properties:
type:
description: "Method specified by the customer for the transaction \n- Provide PIX for brazil QR creation & RFP \n- Provide CARD for CARD transactions \n- Provide BOLETO for BOLETO transactions \n- Provide ALIPAY for ALIPAY transactions \n- Provide ACH for ACH transactions \n- Provide FPS for UK Pay BY Bank link creation \n- Provide RTP for US RFP \n- Provide GOOGLEPAY for GOOGLE PAY transactions \n- Provide APPLEPAY for APPLE PAY transactions \n- Provide PAYPAL for PAYPAL transactions"
type: string
enum:
- PIX
- CARD
- BOLETO
- ALIPAY
- GOOGLEPAY
- APPLEPAY
- ACH
- FPS
- RTP
- PAYPAL
- AFTERPAY
- AMAZON_PAY
- BITPAY
- BIZUM
- TRUSTLY
- BLIK
- BLIK_BNPL
- CASH_APP
- DOKU_WALLET
- EPS
- ESTONIAN_BANKS
- VERKKOPANKKI
- FLOAPAY
- FPX
- GOPAY
- IDEAL
- INDOMARET
- INDONESIAN_BANKS
- JENIUS_PAY
- KREDIVO
- LATVIAN_BANKS
- LINK_AJA
- LITHUANIAN_BANKS
- MBWAY
- MULTIBANCO
- OVO_WALLET
- PAYSAFECARD
- P24
- SATISPAY
- SCALAPAY
- SKRILL
- SWISH
- THAIBANKS
- TWINT
- WERO
- ZIP
- BANCOMATPAY
- DRAGONPAY
- MYBANK
- ALFAMART
- PAYU
- BANCONTACT
- STABLECOINS
- OXXO_PAY
example: PIX
title: type
alipay:
$ref: '#/components/schemas/Alipay'
boleto:
$ref: '#/components/schemas/Boleto'
paypal:
$ref: '#/components/schemas/Paypal'
card:
$ref: '#/components/schemas/Card'
token_id:
description: "Token_number. \n- For India card transaction, method.card.token_number parameter is mandatory when token number is provided and allowed maximum length is 50."
example: PA123456789
maxLength: 50
minLength: 1
type: string
title: token_number
token_type:
description: Token type.
enum:
- ALT_TOKEN
- NETWORK_TOKEN
- ISSUER_TOKEN
- CITI_TOKEN
example: ISSUER_TOKEN
type: string
title: token_type
session_id:
description: Session identification number
type: string
minLength: 36
maxLength: 37
example: SES1234567890123456789012345678
title: session_id
stored_method:
description: "Flag to indicate if the customer payment method will be stored (Alias creation), \n - NOT_STORED Set this value if you are not storing the card details provided by the payer for this transaction. The gateway sets this value by default, if you are submitting a payer-initiated transaction. You must not use this value when submitting merchant-initiated transactions \n - STORED Set this value if you have previously stored the card details provided by the payer and are now using these stored details. The gateway sets this value by default, if you are submitting a merchant-initiated transaction \n - TO_BE_STORED Set this value if this is the first transaction using these card details and you intend to store the card details if the transaction is successful."
enum:
- NOT_STORED
- STORED
- TO_BE_STORED
example: NOT_STORED
type: string
title: stored_method
value_added_services:
type: array
items:
type: string
description: Value added services like CITI_TOKEN, NETWORK_TOKEN and ACCOUNT_UPDATER
title: value_added_services
holder_name:
$ref: '#/components/schemas/Holder-Name'
pix:
$ref: '#/components/schemas/Pix'
ach:
$ref: '#/components/schemas/Ach'
additional_info:
type: array
items:
$ref: '#/components/schemas/Additional-Info'
Additional-Info:
title: Additional-Info /n- For Brazil and CARD transactions allowed maxmium of 50 lines /n- For India CARD transactions allowed maxmium of 10 lines
properties:
name:
maxLength: 100
minLength: 1
type: string
description: Specifies a character string with a maximum length of 50 characters. If transaction.Additional-Info.name is provided by merchant then transaction.Additional-Info.value is mandatory.
example: request_to_payer
title: name
value:
maxLength: 500
minLength: 1
type: string
description: Specifies a character string with a maximum length of 200 characters. if transaction.Additional-Info.value is provided by merchant then transaction.Additional-Info.name is mandatory.
example: this is for purchase order 4567
title: value
Merchant-Status:
title: Merchant Status
properties:
name:
description: "Merchant internal customer name. \n- This parameter is optional for India UPI , UK PAYBYBANK transaction and US RFP \n- For US ACH Direct Debit, this parameter is mandatory with max length 16 \n- For Brazil PIX, this parameter is mandatory with max length 105"
example: JOHN
maxLength: 140
minLength: 1
type: string
title: name
tax_id:
maxLength: 128
minLength: 1
type: string
description: "Merchant's payee identification (e.g., email address) \n - For Brazil QR creation merchant.tax_id parameter is mandatory, allowed maxlength is 77 \n- For Brazil PIX, this parameter is mandatory with min length 11 & max length 14"
example: 1.020.340/8910-22
title: tax_id
account:
title: merchant account
description: Account Details
properties:
number:
maxLength: 40
minLength: 1
type: string
description: "Merchant's bank account \n- This parameter is optional for India UPI ,UK PAYBYBANK transaction and US RFP \n- For US ACH Direct Debit, this parameter is mandatory with max length 17 \n- For Brazil PIX, this parameter is mandatory with min & max length 10"
example: '1122334455'
title: number
bank_id:
maxLength: 35
minLength: 1
type: string
description: "Merchant bank's network identification \n- This parameter is optional for India UPI, UK PAYBYBANK transaction and US RFP \n- For Brazil PIX, this parameter is mandatory with max length 8"
example: CITIIN77
title: bank_id
branch_id:
description: Merchant bank's branch id
minLength: 1
maxLength: 35
type: string
example: BR123
title: branch_id
bank_name:
maxLength: 35
minLength: 1
type: string
description: "Merchant's bank name \n- For US ACH Direct Debit, this parameter is mandatory for sec code IAT (International ACH Transaction) and optional for sec code CCD (Corporate Credit or Debit Entry),PPD (Prearranged Payment and Deposit) & WEB (Internet Initiated/Mobile Entry) with max length 35"
example: CITI
title: bank_name
bank_country_code:
type: string
pattern: ^[A-Z]{2,2}$
description: "Country code of the bank where merchant is maintaining the account \n- For US ACH Direct Debit, this parameter is mandatory"
example: US
title: bank_country_code
name:
maxLength: 70
minLength: 1
type: string
description: "Merchant's Account Name \n- For US RFP transaction, this parameter is optional "
title: name
proxy_id:
description: "Merchant's proxy identification (e.g., email address) \n - For IN UPI Instant payment debtor.proxy_id is mandatory, the allowed value is VPA ID"
example: vinu@citi.com
maxLength: 320
minLength: 1
type: string
title: proxy_id
proxy_type:
type: string
enum:
- BIID
- EMAL
- EWAL
- MBNO
- NIDN
description: Merchant's proxy type (BIID for bill identification, EMAL for email address, EWAL for electronic wallet identification, MBNO for mobile number and NIDN for national identification)
title: proxy_type
virtual_number:
description: Merchant's Virtual account number
type: string
maxLength: 140
minLength: 1
example: '123456789'
title: virtual_number
issuer:
description: Entity that assigned account to the party
type: string
maxLength: 35
minLength: 1
example: ABC Ltd
title: issuer
organization_id:
description: 'Merchant Organization Id/ Legal Entity as provided at the time of payment request.
- For US RFP max length is 20'
example: ORG123456
maxLength: 35
minLength: 1
type: string
title: organization_id
birth_date:
type: string
format: date
description: "ISO 8601 (YYYY-MM-DD), Merchant's birth_date \n- This parameter is optional for US RFP"
title: birth_date
birth_city:
maxLength: 35
minLength: 1
type: string
description: "Merchant's birth_city \n- For US RFP max length is 35"
title: birth_city
birth_country:
type: string
description: "Merchant's birth_country \n- This parameter is optional for US RFP"
pattern: ^[A-Z]{2,2}$
title: birth_country
private_id:
description: "Merchant's prvt_id \n- This parameter is optional for UK PAYBYBANK transaction"
example: '8899775544'
maxLength: 18
minLength: 1
type: string
title: private_id
additional_info:
type: array
items:
$ref: '#/components/schemas/Additional-Info'
address:
$ref: '#/components/schemas/Address'
phone_number:
type: string
maxLength: 35
description: "Merchant's phone number \n- AFor US RFP transaction, this parameter is optional"
pattern: \+[0-9]{1,3}-[0-9()+\-]{1,30}
title: phone_number
Transaction:
title: Transaction
required:
- id
- currency_code
- country_code
properties:
additional_info:
type: array
items:
$ref: '#/components/schemas/Additional-Info'
url:
$ref: '#/components/schemas/Url'
amount:
description: "Transaction amount \n - For Brazil QR Creation decimal values are mandatory for transaction.amount and it must have 2 digits \n - For Brazil QR Creation maxmium amount limit is 9999999999.99 and transaction.amount parameter is mandatory \n- For CARD Capture operation transaction.amount parameter is mandatory, maxmium amount limit is 50000.00 and allowed max 2 decimal after dot. \n - For UK PAYBYBANK Creation transaction.amount parameter is mandatory, maxmium amount limit is 1000000.00 and allowed max 2 decimal after dot. \n- For US RFP, this parameter is mandatory with maximum amount limit 1000000.00 \n- For ACH verify transaction, transaction.amount parameter is mandatory. \n- For US ACH Direct Debit, transaction.amount parameter is mandatory with max 18 digits and 2 decimals. \n- For Brazil PIX Initiation, this is mandatory parameter with max 18 digits & 2 decimals \n - For India Card Capture transaction, transaction.amount parameter is mandatory, minimum amount is 1 and maxmium amount limit is 1000000"
example: 200
maximum: 1000000000000000000
minimum: 0.01
type: number
title: amount
currency_code:
description: "ISO 4217 Currency Code for instance USD/GBP/EUR \n- transaction.currency_code parameter is mandatory for all transaction type creation"
enum:
- BRL
- USD
- GBP
- INR
- EUR
- CAD
- HKD
- AUD
- SGD
- DKK
- NOK
- SEK
- PLN
- IDR
- MYR
- THB
- CHF
- PHP
- CZK
example: BRL
type: string
title: currency_code
reference:
description: "Value provided by the merchant for internal tracking/referencing. \n - For UK PAYBYBANK Creation reference parameter is optional and allowed maximum length is 128 \n- For US RFP, this parameter will contain the unique reference (instruction) id with max length 35 \n- For US ACH Direct Debit, transaction.reference parameter is mandatory with max length 10 (accepts only numbers) \n- For Brazil PIX Initiation this parameter is optional for retry use case where applicable value will be transaction ID used during initial request"
example: REPAY
maxLength: 250
minLength: 1
type: string
title: reference
network:
type: string
enum:
- RTP
- FDN
description: Financial market infrastructure or clearing system (e.g., RTP Network in the United States)
title: network
source:
description: "Indicates the channel through which you received authorization for the payment for this order from the payer. \n- CALL_CENTRE Transaction conducted via a call centre. \n- CARD_PRESENT Transaction where the card is presented to the merchant. \n- INTERNET Transaction conducted over the Internet. \n- MAIL_ORDER Transaction received by mail. \n- MERCHANT Transaction initiated by you based on an agreement with the payer. For example, a recurring payment, installment payment, or account top-up. \n- MOTO Transaction received by mail or telephone. \n- PAYER_PRESENT Transaction where a non-card payment method is presented to the Merchant. \n- TELEPHONE_ORDER Transaction received by telephone.\n- VOICE_RESPONSE Transaction conducted by a voice/DTMF recognition system."
enum:
- CALL_CENTRE
- CARD_PRESENT
- INTERNET
- MAIL_ORDER
- MERCHANT
- MOTO
- PAYER_PRESENT
- TELEPHONE_ORDER
- VOICE_RESPONSE
example: PAYER_PRESENT
type: string
title: source
country_code:
description: "The order country \n- transaction.country_code parameter is mandatory for all transaction type creation"
enum:
- US
- BR
- GB
- IN
- TH
- AU
- CA
- MX
- DE
- NL
- IE
- IT
- FR
- ES
- HK
- SG
- NZ
- DK
- 'NO'
- SE
- SW
- BE
- FI
- CH
- CZ
- AT
- PT
example: US
type: string
title: country_code
reason:
description: "Cancellation/adjustment reason. \n- For Brazil PIX Initiation, this parameter is mandatory with max length 4 with the following allowed values: 'AGND' (First Attempt of Payment Schedule Request) & 'NTAG' (Scheduling of a new post-due payment attempt)"
example: REPAY
maxLength: 140
minLength: 1
type: string
title: reason
auth_id:
description: The transactionId you used for the Initiate Authentication operation.
example: A123456789
maxLength: 40
minLength: 1
type: string
title: auth_id
target_transaction_id:
description: The identifier for the transaction you wish to refund, That is the {transactionId} URL parameter for REST and the transaction.id parameter for NVP.
example: T123456789
maxLength: 40
minLength: 1
type: string
title: target_transaction_id
correlation_id:
description: A transient identifier for the request, that can be used to match the response to the request.
example: '123456789'
maxLength: 100
minLength: 1
type: string
title: correlation_id
preferred_language:
description: The language that you prefer the payment provider to use for pages displayed to the payer.
example: '123456789'
maxLength: 35
minLength: 2
type: string
title: preferred_language
expiry_time:
description: Expiration time for QR collection, specified in seconds.
example: 3600
format: int32
minimum: 10
type: integer
title: expiry_time
qr_image:
description: Merchant to confirm QR Image is required or not, If required value should be Y.
enum:
- Y
- N
example: Y
type: string
title: qr_image
id:
description: "Unique Transaction identification provided by the merchant during transaction creation \n- For Brazil QR Creation transaction.id parameter should be of length between 26 to 35 and allowed datatype is Alphanumeric and should not be filled with spaces or zeroes \n- For CARD operations transaction.id parameter allowed maxmium length is 40. \n- For UK PAYBYBANK creation transaction.id parameter allowed maxmium length is 18 and allowed characters are alphabets, numbers and space \n- For US RFP this parameter is mandatory with max length 35 \n- For ACH transaction transaction.id parameter is mandatory with allowed maxmium length is 40. \n- For US ACH Direct Debit, this parameter is mandatory with maxLength 16. \n- For Brazil PIX Initiation, this parameter is mandatory with min length 26 & max length 35 of alphanumeric characters \n- For India CARD transaction, transaction.id parameter allowed maxmium length is 50."
example: pay02052023456r
maxLength: 128
minLength: 1
type: string
title: id
value_date:
type: string
format: date
description: "Value Date Format is YYYY-MM-DD. \n- For US RFP this parameter is mandatory \n- For US ACH Direct Debit, this parameter is mandatory"
title: value_date
expiry_date:
type: string
format: date
description: "Expiry Date Format is YYYY-MM-DD \n- For US RFP this parameter is mandatory"
title: expiry_date
update_flag:
description: "Indicator if the exact amount indicated in amount must be paid, or if under/over payment is permitted.\n- For QR Creation (ex. Brazil), during transaction processing if the merchant want to allow his client to change QR Amount then the value should be Y otherwise default value will be N \n- For US RFP, if Y then Amount may be modified by the customer, if N then Amount of payment must equal the Instructed Amount. If no value passed, default behavior is same as Y"
enum:
- Y
- N
example: Y
type: string
title: update_flag
full_amount:
type: number
minimum: 0.01
maximum: 1000000000000000000
description: "Amount that is the gross amount payable by client \n- For US RFP transaction, this parameter is optional"
title: full_amount
discount_amount:
type: number
minimum: 0.01
maximum: 1000000000000000000
description: "Amount that is the discount from the gross amount \n- for US RFP. If populated, message.transaction.full_amount must also be populated."
title: discount_amount
creation_date_time:
type: string
format: date-time
readOnly: true
description: "Date and time at which request was received in UTC timezone \n- This parameter is mandatory for Brazil PIX Initiation."
example: '2022-09-13T08:23:49.114Z'
title: creation_date_time
purpose:
$ref: '#/components/schemas/Purpose'
remittance_info:
type: array
description: "Unstructured remittance information \n - For US RFP, transaction.remittance_info parameter is optional and only one(1) line of 140 characters is allowed \n- For Brazil PIX Initiation this parameter is optional and only one(1) line of 140 characters is allowed"
items:
$ref: '#/components/schemas/Unstructured'
title: remittance_info
constraints:
$ref: '#/components/schemas/Constraints'
acquirer:
$ref: '#/components/schemas/Acquirer'
transit:
$ref: '#/components/schemas/Transit'
product_info:
type: array
items:
$ref: '#/components/schemas/Product-Info'
holiday_flag:
description: Specifies if a request should consider holiday
type: boolean
example: true
title: holiday_flag
type: object
Transaction-Notification:
type: object
title: Transaction Notification
properties:
id:
maxLength: 128
minLength: 1
type: string
description: "Unique Transaction identification provided by the merchant during transaction creation \n- For Brazil QR PIX , UK PAYBYBANK and US RFP transaction transaction.id is optional \n- For Brazil QR Creation - Maximum length is 35. \n- For US RFP max length is 35 \n- For US ACH Direct Debit, this parameter is mandatory with max length 16 \n- For Brazil PIX, this parameter is mandatory with min length 26 & max length 35"
example: pay02052023456r
title: id
uetr:
type: string
pattern: ^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][a-f0-9]{3}-[a-f0-9]{12}$
description: "UUID v4 format unique end-to-end transaction reference \n- For India UPI,UK PAYBYBANK transaction, US RFP & Brazil PIX transaction.uetr is optional"
example: 4f09214d-296c-494b-8e9c-810bf1d9fc93
title: uetr
network_id:
maxLength: 128
minLength: 1
type: string
description: "Transaction identification generated by the network (clearing) \n- For India UPI, UK PAYBYBANK and US RFP transactions transaction.network_id is optional"
example: clr02052023478
title: network_id
network:
type: string
enum:
- RTP
- FDN
description: Financial market infrastructure or clearing system (e.g., RTP Network in the United States)
title: network
batch_id:
maxLength: 35
minLength: 1
type: string
description: "Identification for your Citi account consolidated credit posting including the transaction \n- For India UPI, UK PAYBYBANK and US RFP transactions transaction.batch_id \n- For US RFP max length is 35"
example: batch12345
title: batch_id
country_code:
description: "ISO 3166 Alpha-2 code for the transaction country \n- For Brazil PIX, this parameter is mandatory"
type: string
enum:
- BR
- IN
- GB
- US
- TH
- AU
example: IN
title: country_code
reason_code:
description: "Transaction rejection Code \n- For US ACH Direct Debit transaction.reason_code parameter is optional with max length 4 \n- For Brazil PIX, this parameter is mandatory"
example: SC0020
maxLength: 100
minLength: 1
type: string
title: reason_code
value_date:
type: string
format: date
description: "YYYY-MM-DD Date in local time zone (e.g., EST for a United States RTP network transaction IST for IN IMPS) when Citi's transaction processing application starts processing a transaction \n- For India UPI, UK PAYBYBANK and US RFP transactions transaction.value_date parameter is optional \n- For US RFP this parameter is mandatory \n- For US ACH Direct Debit, this parameter is mandatory \n- For Brazil PIX this parameter is mandatory"
example: '2022-09-07'
title: value_date
currency_code:
type: string
description: "ISO 4217 code for the transaction instructed amount currency \n- For India UPI, UK PAYBYBANK and US RFP transactions transaction.currency_code parameter is optional \n- For US ACH Direct Debit, this parameter is mandatory \n- For Brazil PIX this parameter is mandatory"
enum:
- BRL
- INR
- USD
- GBP
- THB
- AUD
example: INR
title: currency_code
remittance_info:
type: array
description: "Unstructured remittance information \n- For US ACH Direct Debit, this parameter is optional"
items:
$ref: '#/components/schemas/Unstructured'
end_to_end_id:
maxLength: 35
minLength: 1
type: string
description: "Unique identification assigned by the initiating party to unambiguously identify the transaction. This identification is passed on, unchanged, throughout the entire end-to-end chain. \n- For Brazil QR PIX, India UPI and PAYBYBANK transactions transaction.end_to_end_id parameter is optional \n- \n- For US ACH Direct Debit, this parameter is mandatory"
example: pay02052023456r
title: end_to_end_id
amount:
type: number
minimum: 0.01
maximum: 1000000000000000000
description: "Transaction amount \n - For Brazil QR Creation decimal values are mandatory for transaction.amount and it must have 2 digits \n - For Brazil QR Creation maxmium amount limit is 9999999999.99 \n- For US RFP, this parameter is mandatory with maximum amount limit 1000000.00 \n- For US ACH Direct Debit, this parameter is mandatory with 18 digits & 2 decimals \n- For Brazil PIX, this parameter is mandatory with 18 digits including 2 decimals"
example: 200
title: amount
tax_id:
maxLength: 128
minLength: 1
type: string
description: "Merchant's payee identification (e.g., email address) \n - For Brazil QR creation merchant.payee_id parameter is mandatory, allowed maxlength is 77"
example: 1.020.340/8910-22
title: tax_id
creation_date_time:
type: string
format: date-time
description: "GMT (ISO 8601 YYYY-MM-DDTHH:MM:SS.sssZ) \n- Instant Payment (Credit) - Date time, either provided by the debtor bank or generated by Citi's transaction processing application, when a transaction was created \n- For US RFP this parameter is mandatory \n- For US ACH Direct Debit, this parameter is mandatory \n- For Brazil PIX, this parameter is mandatory"
example: '2022-09-13T08:23:49.114Z'
title: creation_date_time
additional_info:
maxLength: 140
minLength: 1
type: string
description: "Additional information provided by payor \n- For Brazil QR PIX and UK PAYBYBANK transactions transaction.additional_info parameter is optional"
example: Payment for Goods
title: additional_info
full_amount:
type: number
minimum: 0.01
maximum: 1000000000000000000
description: "Amount that is the gross amount payable by client \n- For US RFP transactions transaction.full_amount parameter is optional"
title: full_amount
discount_amount:
type: number
minimum: 0.01
maximum: 1000000000000000000
description: "Amount that is the discount from the gross amount \n- For US RFP transactions transaction.discount_amount parameter is optional, If populated, message.transaction.full_amount must also be populated."
title: discount_amount
original_amount:
type: number
minimum: 0.01
maximum: 1000000000000000000
description: "Amount that was originally sent by our client \n- For US RFP transactions transaction.original_amount parameter is optional"
title: original_amount
status:
type: string
enum:
- SETTLED
- FAILED
- PENDING
- POSTING_PENDING
- CANCELLED
description: "Transaction Status \n- Transaction settled"
title: status
description:
type: string
maxLength: 1000
description: "Transaction Status Description \n- SETTLED - Transaction settled"
example: Transaction settled
title: description
reference:
description: "Transaction additional information. \n- For India UPI transactions transaction.reference parameter is optional (NPCI Reference number for UPI). \n- For US RFP, this parameter will contain the unique reference (instruction) id with max length 35"
example: REPAY
maxLength: 250
minLength: 1
type: string
title: reference
status_date_time:
format: date-time
type: string
description: "Date & Time when Payer bank provided their response GMT (ISO 8601 YYYY-MM-DDTHH:MM:SS.sssZ) \n- This parameter is mandatory for Brazil PIX"
example: '2022-09-13T08:23:49.114Z'
title: status_date_time
settlement_date:
type: string
format: date
description: The date on which transaction is settled.
example: '2022-09-07'
title: settlement_date
clearing_local_code:
maxLength: 4
minLength: 1
type: string
description: Local Clearing code
example: 008T
title: clearing_local_code
bill_id_1:
description: Bill identification for a bill payment
maxLength: 128
minLength: 1
pattern: ^[0-9A-Z]{1,128}$
type: string
example: '77889900'
title: bill_id_1
bill_id_2:
description: Bill identification for a bill payment
maxLength: 128
minLength: 1
pattern: ^[0-9A-Z]{1,128}$
type: string
example: '77889901'
title: bill_id_2
bill_id_3:
description: Bill identification for a bill payment
maxLength: 128
minLength: 1
pattern: ^[0-9A-Z]{1,128}$
type: string
example: '77889902'
title: bill_id_3
bill_due_date:
description: ISO 8601 (YYYY-MM-DD) bill due date
type: string
format: date
example: '2025-01-01'
title: bill_due_date
wht_rate:
description: Withholding tax (WHT) rate
type: number
minimum: 0
maximum: 100
example: 10
title: wht_rate
wht_amount:
description: Withholding tax (WHT) amount
type: number
minimum: 0.01
maximum: 1000000000000000
example: 1000
title: wht_amount
wht_code:
description: Withholding tax (WHT) code A for WHT always paid by the seller, S for WHT once paid by the seller and B for WHT paid by the buyer
type: string
enum:
- A
- S
- B
example: A
title: wht_code
processing_code:
description: Code defined by regulator to identify different kind of payments
type: string
minLength: 1
maxLength: 35
example: '550000'
title: processing_code
purpose:
$ref: '#/components/schemas/Purpose'
income_type:
description: Income type
type: string
pattern: ^(00[0-9]|01[0-2])$
example: '001'
title: income_type
vat_rate:
description: Value-added tax (VAT) rate
type: number
minimum: 0
maximum: 100
example: 10
title: wht_rate
vat_amount:
description: Value-added tax (VAT) amount
type: number
minimum: 0.01
maximum: 1000000000000000
example: 100
title: vat_amount
acceptance_date_time:
format: date-time
type: string
description: Date & Time when Payee accepted the payment from clearing in GMT (ISO 8601 YYYY-MM-DDTHH:MM:SS.sssZ)
example: '2022-09-13T08:23:49.114Z'
title: acceptance_date_time
category_purpose:
description: This field contains descriptive purpose of the payment
type: string
maxLength: 128
minLength: 1
example: payment for salary
title: category_purpose
charges_paid_by:
description: Indicates who will bear charges for the payment
type: string
maxLength: 128
minLength: 1
example: SHAR
title: charges_paid_by
regulatory_reporting:
type: object
title: RegulatoryReporting
properties:
type:
description: Regulatory Reporting details type
maxLength: 35
minLength: 1
type: string
example: More details here
title: type
code:
description: Regulatory Reporting details code
maxLength: 35
minLength: 1
type: string
example: NOC
title: code
type:
description: Indicates flow of payment
type: string
maxLength: 35
minLength: 1
example: CR
title: type
holiday_flag:
description: Specifies if a request should consider holiday
type: boolean
example: true
title: holiday_flag
Paypal:
title: paypal
type: object
description: '
- For PAYPAL Pay operation method.paypal parameter is mandatory when method.type parameter is selected as PAYPAL'
properties:
browser_payment_operation:
description: The operation values for browser payments
enum:
- INITIATE
example: INITIATE
type: string
title: browser_payment_operation
display_shipping_address:
description: Indicates whether you want PayPal to display the shipping address to the payer on the PayPal website.
enum:
- 'TRUE'
- 'FALSE'
example: 'TRUE'
type: string
title: display_shipping_address
override_shipping_address:
description: Indicates whether you want to allow the payer to change the shipping address for the payment on the PayPal website
enum:
- 'TRUE'
- 'FALSE'
example: 'TRUE'
type: string
title: override_shipping_address
payment_confirmation:
description: Indicates where in the checkout flow you want the payer to commit to the payment - on the PayPal website or on your website after returning from the PayPal website.
enum:
- CONFIRM_AT_MERCHANT
- CONFIRM_AT_PROVIDER
example: CONFIRM_AT_PROVIDER
type: string
title: payment_confirmation
Gateway-Error-Response:
type: object
title: GatewayErrorResponse
properties:
httpCode:
type: string
maxLength: 3
description: Numeric HTTP Staus code
title: httpCode
httpMessage:
type: string
maxLength: 128
description: HTTP error message
title: httpMessage
moreInformation:
type: string
maxLength: 128
description: HTTP error message
title: httpMessage
avs:
title: avs
description: avs
properties:
acquirer_code:
description: The acquirer AVS response code generated by the card issuing institution.
example: DE1245678945123
maxLength: 100
minLength: 1
type: string
title: acquirer_code
gateway_code:
description: The address verification result generated to indicate whether the address data supplied matches the data held by the cardholder's issuing bank
enum:
- ADDRESS_MATCH
- ADDRESS_ZIP_MATCH
- NAME_ADDRESS_MATCH
- NAME_MATCH
- NAME_ZIP_MATCH
- NOT_AVAILABLE
- NOT_REQUESTED
- NOT_VERIFIED
- NO_MATCH
- SERVICE_NOT_AVAILABLE_RETRY
- SERVICE_NOT_SUPPORTED
- ZIP_MATCH
example: ADDRESS_MATCH
type: string
title: gateway_code
Customer-Notification:
type: object
title: Customer Notification
properties:
account:
title: customer account
description: Account Details
properties:
number:
maxLength: 40
minLength: 1
type: string
description: "Customer's bank account \n- For US RFP this parameter is mandatory with max length 40 \n- For UK PAYBYBANK and IN UPI transactions, customer.account.number parameter is optional \n- For US ACH Direct Debit, this parameter is mandatory with max length 17 \n- For Brazil PIX, this parameter is mandatory with max length 40"
example: '1122334455'
title: number
bank_id:
maxLength: 35
minLength: 1
type: string
description: "Customer bank's network identification \n- For US RFP this parameter is mandatory with max length 16 \n- For ACH, length is equal to 9 \n- For UK PAYBYBANK and IN UPI transactions, customer.account.bank_id parameter is optional"
example: CITIIN77
title: bank_id
branch_id:
description: Customer bank's branch id
minLength: 1
maxLength: 35
type: string
example: BR123
title: branch_id
name:
maxLength: 70
minLength: 1
type: string
description: "Customer's Account Name \n- For US RFP transaction, customer.account.name parameter is optional"
title: name
proxy_id:
maxLength: 255
minLength: 1
type: string
description: "Customer's proxy identification (e.g., email address) \n- For IN UPI, customer.account.proxy_id parameter is optional"
example: raja@citi.com
title: proxy_id
proxy_type:
type: string
enum:
- BIID
- EMAL
- EWAL
- MBNO
- NIDN
description: "Customer's proxy type (BIID for bill identification, EMAL for email address, EWAL for electronic wallet identification, MBNO for mobile number and NIDN for national identification) \n- For IN UPI, customer.account.proxy_type parameter is optional"
title: proxy_type
type:
description: "Customer Source type of the transaction \n- For IN UPI, customer.account.type parameter is optional"
enum:
- SAVINGS
- CURRENT
- CARD
- OVERDRAFT
- VIRTUAL_ACCOUNT
- CORPORATE_CHECKING
example: SAVINGS
type: string
title: type
virtual_number:
description: Customer's Virtual account number
type: string
maxLength: 140
minLength: 1
example: '123456789'
title: virtual_number
issuer:
description: Entity that assigned account to the party
type: string
maxLength: 35
minLength: 1
example: ABC Ltd
title: issuer
tax_id:
description: Customer's tax identification
maxLength: 128
minLength: 1
type: string
example: 1.020.340/8910-22
title: tax_id
name:
$ref: '#/components/schemas/Name'
address:
$ref: '#/components/schemas/Notification-Address'
organization_id:
description: 'Customer Organization Id/ Legal Entity as provided at the time of payment request.
- For US RFP max length is 20'
example: ORG123456
maxLength: 35
minLength: 1
type: string
title: organization_id
birth_date:
type: string
format: date
description: "ISO 8601 (YYYY-MM-DD), Customer's birth_date \n- For US RFP, customer.birth_date parameter is optional"
title: birth_date
birth_city:
maxLength: 35
minLength: 1
type: string
description: "Customer's birth_city \n- For US RFP max length is 35"
title: birth_city
birth_province:
description: Customer's birth province
type: string
maxLength: 35
minLength: 1
title: birth_province
birth_country:
type: string
description: "Customer's birth_country \n- For US RFP, customer.birth_country parameter is optional"
pattern: ^[A-Z]{2,2}$
title: birth_country
type:
type: string
description: "Customer type \n- For US RFP, customer.type parameter is optional"
enum:
- BUSINESS
- INDIVIDUAL
title: type
private_id:
description: Customer private id
type: string
maxLength: 35
minLength: 1
example: '123456789'
title: private_id
Method-Update:
type: object
title: Method Update
properties:
type:
description: "Method specified by the customer for the transaction \n- Provide PIX for brazil QR creation & RFP \n- For CARD Update Authorization operation method.type parameter is mandatory \n- For CARD Void/Cancel operation method.type parameter is mandatory \n- Provide GOOGLEPAY for GOOGLE PAY transactions \n- For ACH Void/Cancel transaction, method.type parameter is mandatory \n- For PAYPAL transaction, method.type parameter is mandatory"
type: string
enum:
- PIX
- CARD
- GOOGLEPAY
- APPLEPAY
- ACH
- PAYPAL
example: PIX
title: type
pix:
$ref: '#/components/schemas/Pix'
paypal:
$ref: '#/components/schemas/Paypal-Update'
additional_info:
type: array
items:
$ref: '#/components/schemas/Additional-Info'
Payment-Update-Request:
type: object
title: Payment update request
required:
- transaction
properties:
customer:
$ref: '#/components/schemas/Customer-Update'
merchant:
$ref: '#/components/schemas/Merchant-Update'
method:
$ref: '#/components/schemas/Method-Update'
transaction:
$ref: '#/components/schemas/Transaction-Update'
order:
$ref: '#/components/schemas/Order-Update'
shipping:
$ref: '#/components/schemas/Shipping'
additionalProperties: false
description: Payment Update Request
Shipping-Address:
title: Shipping-Address
type: object
description: Address
properties:
lines:
type: array
maxItems: 7
items:
$ref: '#/components/schemas/Lines'
title: lines
street_name:
maxLength: 70
minLength: 1
type: string
description: Customer Street Name.
example: Federal Street
title: street_name
city:
maxLength: 100
minLength: 1
type: string
description: Customer city.
example: Abis Brasil
title: city
postal_code:
maxLength: 16
minLength: 1
type: string
description: Customer postal code.
example: 69935-000
title: postal_code
state:
maxLength: 50
minLength: 1
type: string
description: Customer state.
example: san francisco
title: state
country_code:
type: string
pattern: ^[A-Z]{2,2}$
description: Customer country.
example: US
title: country_code
Transaction-Status:
type: object
title: Transaction Status
properties:
id:
maxLength: 128
minLength: 1
type: string
description: "Unique Transaction identification provided by the merchant during transaction creation \n- transaction.id parameter is mandatory for all transaction type creation \n- For Brazil QR Creation transaction.id should be Alphanumeric and length ≥ 23 and ≤ 35 \n- For US RFP this parameter is mandatory with max length 35 \n- For US ACH Direct Debit, this parameter is mandatory with max length 16 \n- For Brazil PIX, this parameter is mandatory with min length 26 & max length 35"
example: pay02052023456r
title: id
end_to_end_id:
maxLength: 35
minLength: 1
type: string
description: "Unique identification assigned by the initiating party to unambiguously identify the transaction. This identification is passed on, unchanged, throughout the entire end-to-end chain. \n- This parameter is optional for Brazil QR PIX transaction"
example: pay02052023456r
title: end_to_end_id
expiry_time:
type: integer
format: int32
minimum: 10
description: "Expiration time for QR collection, specified in seconds \n- QR Creation request will be rejected, if Expiration time value is less than 10"
example: 3600
title: expiry_time
update_time:
type: string
format: date-time
description: "Indicates the date and time the gateway considers the order to have last been updated GMT (ISO 8601 YYYY-MM-DDTHH:MM:SS.sssZ) \n- Instant Payment (Debit) - Date time, generated by CitiConnect API, when CitiConnect API accepted a payment initiation after validation \n- Instant Payment (Credit) - Date time, either provided by the debtor bank or generated by Citi's transaction processing application, when a transaction was created \n- For ACH PAY and Verify transaction, order.update_time parameter is mandatory"
example: '2022-09-13T08:23:49.114Z'
title: update_time
type:
description: Indicates the type of action performed on the order.
enum:
- AUTHENTICATION
- AUTHORIZATION
- AUTHORIZATION_UPDATE
- CAPTURE
- CHARGEBACK
- DISBURSEMENT
- FUNDING
- PAYMENT
- REFUND
- REFUND_REQUEST
- VERIFICATION
- VOID_AUTHORIZATION
- VOID_CAPTURE
- VOID_PAYMENT
- VOID_REFUND
example: VERIFICATION
type: string
title: type
reason_code:
description: "Transaction rejection Code \n- For Brazil PIX, this parameter is mandatory with min & max length 4"
example: SC0020
maxLength: 100
minLength: 1
type: string
title: reason_code
authorization_code:
description: Value generated by the issuing bank in response to a proposal to transfer funds
example: AUTH123456
maxLength: 100
minLength: 1
type: string
title: authorization_code
acquirer:
$ref: '#/components/schemas/Acquirer-Request'
terminal:
description: Identifier used by the acquirer to identify the transaction. This identifier may be used by the acquirer in settlement reports.
example: ACQ7894561
maxLength: 16
minLength: 1
type: string
title: terminal
retrieval_reference_number:
description: When a transaction registration succeeds, the value of this parameter contains the 44-digit number that was used to create the bar code on the Boleto slip. This bar code can then be scanned by the vendor if a payer elects to pay Boleto at a registered location.
example: ACQ7894561
maxLength: 100
minLength: 1
type: string
title: retrieval_reference_number
authorization_response:
$ref: '#/components/schemas/Authorization-Response'
response:
$ref: '#/components/schemas/Response'
receipt:
description: When a transaction registration succeeds, the value of this parameter contains the 44-digit number that was used to create the bar code on the Boleto slip. This bar code can then be scanned by the vendor if a payer elects to pay Boleto at a registered location.
example: MSG12345
maxLength: 100
minLength: 1
type: string
title: receipt
additional_response_data:
description: A 47-digit number the payer can use to make a Boleto payment.When a transaction registration succeeds, the value of this parameter contains the 44-digit number that was used to create the bar code on the Boleto slip. This bar code can then be scanned by the vendor if a payer elects to pay Boleto at a registered location.If the transaction registration fails, this parameter contains an error code and a description in key-value pair format.
example: MSG12345
maxLength: 4000
minLength: 1
type: string
title: additional_response_data
amount:
type: number
minimum: 0.01
maximum: 1000000000000000000
description: "Transaction amount \n - For Brazil QR Creation decimal values are mandatory for transaction.amount and it must have 2 digits \n - For Brazil QR Creation maxmium amount limit is 9999999999.99 \n- For US RFP, this parameter is mandatory with maximum amount limit 1000000.00 \n- For US ACH Direct Debit, this parameter is mandatory with max length 18 digits & 2 decimals \n- For Brazil PIX, this parameter is mandatory with max length 18 digits including 2 decimals"
example: 200
title: amount
currency_code:
type: string
enum:
- BRL
- USD
- GBP
- INR
- EUR
- CAD
- HKD
- AUD
- SGD
- DKK
- NOK
- SEK
- PLN
- IDR
- MYR
- THB
- CHF
- PHP
- CZK
description: "ISO 4217 Currency Code for instance USD/GBP/EUR \n- transaction.currency_code parameter is mandatory for all transaction type creation"
example: BRL
title: currency_code
country_code:
description: "The order country \n- transaction.country_code parameter is mandatory for all transaction type creation"
enum:
- US
- BR
- GB
- IN
- TH
- AU
- CA
- MX
- DE
- NL
- IE
- IT
- FR
- ES
- HK
- SG
- NZ
- DK
- 'NO'
- SE
- BE
- FI
- CH
- CZ
- AT
- PT
example: US
type: string
title: country_code
update_flag:
type: string
enum:
- Y
- N
description: "Indicator if the exact amount indicated in amount must be paid, or if under/over payment is permitted.\n- For QR Creation (ex. Brazil), during transaction processing if the merchant want to allow his client to change QR Amount then the value should be Y otherwise default value will be N \n- For US RFP, if Y then Amount may be modified by the customer, if N then Amount of payment must equal the Instructed Amount.If no value passed, default behavior is same as Y"
example: Y
title: update_flag
qr_image:
type: string
enum:
- Y
- N
description: Merchant to confirm QR Image is required or not, If required value should be Y
example: Y
title: qr_image
additional_info:
type: array
items:
$ref: '#/components/schemas/Additional-Info'
update_count:
type: integer
format: int32
description: Denotes the collection review. It always starts at zero. It always varies in increments of 1, if any updation done on QR creation)
example: 1
title: update_count
qr_string:
type: string
maxLength: 512
description: Dynamic QR Code based on the merchant payload request
example: 00020101021226700014br.gov.bcb.pix.citi.com.br/qr/2/8b3da2f39a4140d1a91abd93113bd44 15204000053039865802BR5913Fulano de Tal6008BRASILIA62070503***630464E4
title: qr_string
qr_byte_code:
type: string
format: byte
description: QR Image
example: iVBORw0KGgoAAAANSUhEUgAAAMgAAADICAYAAACtWK6eAAAYV0lEQVR4Xu3T26osu3JF0f3/P21jmMKmQa+QKlWbg8kO8TAuEaWci/XPf728vCT/aLy8vPwv73+Ql5cPvP9BXl4+8P4HeXn5wPsf5OXlA+9/kJeXD7z/QV5ePvD+B3l5+cD7H+Tl5QPvf5CXlw+8/0FeXj7w/gd5efnA+x/k5eUD73+Ql5cPvP9BXl4+8P4HeXn5wPsf5OXlA+9/kJeXD1z9D/LPP/98NdP+lNuzX1qme4spX9gr7VQu5lNP7VQu5lNPyhfv785Nrl7zobsz7U+5PfulZbq3mPKFvdJO5WI+9dRO5WI+9aR88f7u3OTqtdMH2p/0RPX1S+ubT1rffBf7dV+/8l2qrz/pwp7vrnyX0/4OV6+dPtD+pCeqr19a33zS+ua72K/7+pXvUn39SRf2fHflu5z2d7h6zQf64ZUXlU/3Jt/ZpfYmX61vLrWnfurXVG+X2vtWO+Y3uXrNB/ohlReVT/cm39ml9iZfrW8utad+6tdUb5fa+1Y75je5es0H+iGVly5frV8zUf3SNcXUM7enlikvas93VO9bvLerHfObXL3mA/2QykuXr9avmah+6Zpi6pnbU8uUF7XnO6r3Ld7b1Y75Ta5e84F+SOVSvnh3d57u1xSVn/oTvmca90qX7z2nmPKFPe9XfpOr13ygH1K5lC/e3Z2n+zVF5af+hO+Zxr3S5XvPKaZ8Yc/7ld/k6rXTB1a//MI/mPulawpz96aZqH7p8ovdvKYwL61vLuUXp/0drl47fWD1yy/8B3C/dE1h7t40E9UvXX6xm9cU5qX1zaX84rS/w9Vr/iF2x/1Xv/r/6tO5ydVrPnR33H/1q/+vPp2b3L32ED/UEf1Jlz/9zsK89krXSOX6lRe1N+WlHfNdTvv/Jv9Rr/IP7oj+pMuffmdhXnula6Ry/cqL2pvy0o75Lqf9f5Orr/JDpz+gI/pqme4t7J2Od3a1vrm+U73yT2e6M+X27J9Se/rT7z/h6jUfWA/XN7dXWqZ7C3un451drW+u71Sv/NOZ7ky5Pfun1J7+9PtPuHvtDx+qFnM/2LEn+qdapnyXulP+YsoX9pbWNy/ct1+++S72T++rb3D32h8+VC3m/mEce6J/qmXKd6k75S+mfGFvaX3zwn375ZvvYv/0vvoGd69BPbg+XC3uOfbUk1+52HeqV37NLrv96f7kVy5Tz3tOUT31TX5z9Y96+Lcf6p5jTz35lYt9p3rl1+yy25/uT37lMvW85xTVU9/k6lU/wIer9Z1d7JeusVe4Z19d7PYmfIcj+qf6W7/wvY6U/0uu/pof6Aep9Z1d7JeusVe4Z19d7PYmfIcj+qf6W7/wvY6U/0uu/pof6Aed6vJ3tX7ljuirpfLyT/GOepfTvW/77u36zsRu74Sr1/wgH3yqy9/V+pU7oq+Wyss/xTvqXU73vu27t+s7E7u9E65eu/1A75XWl+rpO1PvNJfJNy+tby6Tb17aMZddX134+7t7J1y9dvuB3iutL9XTd6beaS6Tb15a31wm37y0Yy67vrrw93f3Trh77Q8fWrqmeqI/6cKevzvNr/F31JO/mHKxrxbzpctXO/8J/OQVfmDpmuqJ/qQLe/7uNL/G31FP/mLKxb5azJcuX+38J3D1FX7gNNNe5aJ/S+uLeWlnyqv3Le6X1hfz3b3F1Ku8fmfSN7h6zQ+ZZtqrXPRvaX0xL+1MefW+xf3S+mK+u7eYepXX70z6Blev1QMnv/KFuXvm9k61fuXVm3C/7uiX1jeXya+xp3ZOcd87p/4Nrl6rB05+5Qtz98ztnWr9yqs34X7d0S+tby6TX2NP7ZzivndO/RtcveZDTx9ce6e++UTd0TefqP63fk1hXtoRc3vlT7m6uN074eo1/xCnD669U998ou7om09U/1u/pjAv7Yi5vfKnXF3c7p1w9druH2K3V0z7+jLlhfcde1J+Ufcn7Ktv+WqZ3l++VE9ffYOr1+oPUrr8iWlfX6a88L5jT8ov6v6EffUtXy3T+8uX6umrb3D12vQHKdyrfX21fs23vV0tleurxby0/pSrxfxb7VSuL6f+E65eqw+dcK/29dX6Nd/2drVUrq8W89L6U64W82+1U7m+nPpPuHsNpg93ptyxL/Z3Z9qvXCbfMZ90+RO7vcL9eo/5hL1JT/4NfnP1j/rD6e/mjn2xvzvTfuUy+Y75pMuf2O0V7td7zCfsTXryb3D1av2hyjdXTyPli73p7sKeI/ql9c2L3dzerm9ePf3Sp75apvwGV69Pfzh9c/U0Ur7Ym+4u7DmiX1rfvNjN7e365tXTL33qq2XKb/DT6/4h/SD90/HOri5/uu9ULuUvzEtPfuW7VF9/0kX1ypfVs1/+De5eAx/uB+ifjnd2dfnTfadyKX9hXnryK9+l+vqTLqpXvqye/fJvcPXa9NDy5fSO/Wncm/Q0U9+8cK/GvlrfXNyrsS/lL8zV+lP+b3D1V2592Okd+9O4N+lppr554V6NfbW+ubhXY1/KX5ir9af83+Dqr/hwP3R33Fc7om/f2e05056Uv9jN7elPI5PvyGl+2judm1y95gN9+O64r3ZE376z23OmPSl/sZvb059GJt+R0/y0dzo3uXrNh/pgtbjnVE9/V+tXvrDnTD2Z/MqLqT/dnXKxN+1XXr7s9m5y9Vf8AD9ELe451dPf1fqVL+w5U08mv/Ji6k93p1zsTfuVly+7vZv8K79SH1a6fPXuuKd2zNX6E/bV5Z/+nr1Jl3/6u4tpr/yF+aQn/wa/uQr1hytdvnp33FM75mr9Cfvq8k9/z96kyz/93cW0V/7CfNKTf4OfXPXB0x9uUfmury7qPWpxb+oX7ql3cU8t5uqJ+m51+bVvXpirf8FPrvvw6Q+zqHzXVxf1HrW4N/UL99S7uKcWc/VEfbe6/No3L8zVv+DqdR/sH2R33FfXVE/MT0d281Pcq9/Rn8Y99a4vU0/f/ulI+U+4es0H+kG74766pnpifjqym5/iXv2O/jTuqXd9mXr69k9Hyn/C1Wu7D6yef4CaYsrFvrr8Xa1vLvpqfXO1VO696i3sTf2F/dqbcjntn3D12u4Dq+eH1hRTLvbV5e9qfXPRV+ubq6Vy71VvYW/qL+zX3pTLaf+Eq9emh+rbd6T8wnvul9Y3F/26U775pPWLqV/5pCd/YT5pfUfMq/eEq9emh+rbd6T8wnvul9Y3F/26U775pPWLqV/5pCd/YT5pfUfMq/eEu9cCHz7p8v1D1ExUXz1Rd05z9a5vLuUv6u6kT/36HfNd7E/3n3D3WuDDJ12+f4iaieqrJ+rOaa7e9c2l/EXdnfSpX79jvov96f4T7l77ox6qr97FvfoD7fqOmDv2Spc/3dM3l9M99YT9+j31LrWn7++a3+DutT/qofrqXdyrP9Cu74i5Y690+dM9fXM53VNP2K/fU+9Se/r+rvkNrl779oH1gZMu33uOPXX5Uv2ieuUX0+/qT1rqvrqofXO1fmF/d+8brl799qH1oZMu33uOPXX5Uv2ieuUX0+/qT1rqvrqofXO1fmF/d+8brl7dfagf5shp7siu7x1H9Kt/6ldur/wp3/UrL8zV+pUvqlf+Da5e232gH+TIae7Iru8dR/Srf+pXbq/8Kd/1Ky/M1fqVL6pX/g2uXvOhuw+eet6zP/ky+TVi7hTV03emnrmUvzBXP/VrxNyRKX/C1Ws+dPfBU8979idfJr9GzJ2ievrO1DOX8hfm6qd+jZg7MuVPuHrNh/rgUy3eta+W2hN7u/1vtb65vmNPrW8up/7C/Kme/MWUP+Hq1fVQx3xXi3ftq6X2xN5u/1utb67v2FPrm8upvzB/qid/MeVPuHrVh6onf2G+9Lf+aX7KtF+/U1pfpnxR98oXc3X5ajGftFRe/hOuXvOB6slfmC/9rX+anzLt1++U1pcpX9S98sVcXb5azCctlZf/hLvXgvVwP6D8onqTv5tPvVO869ibcN8RffUtf3qH7PbN1fqVP+HutaA+oPyiepO/m0+9U7zr2Jtw3xF99S1/eofs9s3V+pU/4e61P3ywD9/VzpQ7E/Zqv3yxZ19/d2TyzXd1jb3S+o65lF/YV9/g7rU//MP48F3tTLkzYa/2yxd79vV3RybffFfX2Cut75hL+YV99Q2uXqsHTn7li9NcLfW75e/mC/NdXWNPTvsL96aRytW/9tU3uXq1Hjr5lS9Oc7XU75a/my/Md3WNPTntL9ybRipX/9pX3+TqVR+6tCP6ky7sqcv3fY6UL9WbfHO1vvmk9R1zdflF5eWfUu+6wdVrPtCHm9vb1YU9dfm+z5HypXqTb67WN5+0vmOuLr+ovPxT6l03uHvtj+nB3+bqXd/5Fu/UvVNfvO/eri5/0s4uu3vm7pkXu70n/OT69KHf5upd3/kW79S9U1+8796uLn/Szi67e+bumRe7vSf89npQH1Z/oNLObm5PXb7ou+/Ym6he3T3NxT1Hyi+8N+1PuZz2d7h7bZP6kPrDlXZ2c3vq8kXffcfeRPXq7mku7jlSfuG9aX/K5bS/w91rf0wP9Q/kVE+/9FOme/Wuwl7tn+ryvW++2yutX0z9b/3Kf8FPfmX6AD/UqZ5+6adM9+pdhb3aP9Xle998t1dav5j63/qV/4Krv1IP15/0LtMfTF+tX/m3eHca9ybcr70pL+yrn/rmpfXNS9/g6rV6oP6kd7n1B5zufIt3p3Fvwv3am/LCvvqpb15a37z0De5e+8OHqvUrL+zXHf3KRb/25TRXl//t76t3/ZrqSfmFfe9XLuU/4e61P3yoWr/ywn7d0a9c9GtfTnN1+d/+vnrXr6melF/Y937lUv4Trl57+kD3T/Uua6/2zaee1N6kC3ver/xb/SvfXC1TvtjtfcPVq08f6v6p3mXt1b751JPam3Rhz/uVf6t/5ZurZcoXu71v+M3VP/zD7I6UX1Rfv/Q0xdTT3+3XiPk0xZQvvOeeesI7NfZ/yU+v+2G7I+UX1dcvPU0x9fR3+zViPk0x5Qvvuaee8E6N/V9y9bofUlOYT7qwN/3+lC8qn/bLL6o/+ZUvpryoPX936k1aX+xN/Rtcve7DawrzSRf2pt+f8kXl0375RfUnv/LFlBe15+9OvUnri72pf4Or1+vB9UGTLrznFNWb/NJirtavqd6EvdL6Yu+0/9Tf1fqVP+HqtXpgfcCkC+85RfUmv7SYq/Vrqjdhr7S+2DvtP/V3tX7lT7h6bXpo+Qv3HXtF7Ym90/5TvOcUlZe/8L4zUb1f+wvfa199g6vX6uHmhfuOvaL2xN5p/ynec4rKy19435mo3q/9he+1r77B3WsDfliN/cK9adwT+7vj/qT1d6k9705TmE97+vbNxd7T+QW/uRr4QTX2C/emcU/s7477k9bfpfa8O01hPu3p2zcXe0/nF/zkaj188kvrm+uby25eY2/St3w57S/cm/qLqb+bq3f9Yrf3DT+5Wh84+aX1zfXNZTevsTfpW76c9hfuTf3F1N/N1bt+sdv7ht9cDfzw3Q+rvrp8980L+84t6p6/5xRTvqiev+MU1Zv0rm+u/gW/vQ5+6O4HVl9dvvvmhX3nFnXP33OKKV9Uz99xiupNetc3V/+Cq9frwX7gac857dec4p76lNovv5i+S189+Qtz9VPfXF1+7d/g6rV6oB9w2nNO+zWnuKc+pfbLL6bv0ldP/sJc/dQ3V5df+ze4ew18uB9QetcXe86EvdJOUb3J38V+3Z1y9S1fPfmLypdf+S/46a/4QX5Y6V1f7DkT9ko7RfUmfxf7dXfK1bd89eQvKl9+5b/g6q/4Aacf8nTvVNeIvv2aidP+hHfqfvkT1Z9880nrT/kvuXrdDzr9gKd7p7pG9O3XTJz2J7xT98ufqP7km09af8p/ydXrPri0s8tpX/zd3Xv23dM3L6Ze5fqld32Z8sK9SZd/qif/CVev+cDSzi6nffF3d+/Zd0/fvJh6leuX3vVlygv3Jl3+qZ78J9y99sd66O6D7ddI5fo13/bdm6g7+k719IvK9et+5U719G/xb/3O/3D32h/1AYX9Gqlcv+bbvnsTdUffqZ5+Ubl+3a/cqZ7+Lf6t3/kfrl7zgWp9x1yt/5S6p3/790/v2SutX3n1xJ5616+ZeuZiv3pPuHrNB6r1HXO1/lPqnv7t3z+9Z6+0fuXVE3vqXb9m6pmL/eo94eo1H+jDzaee/VP/V/h7jpz6RfVPf7/6an1zfad6suurZcq/4eo1H+gfxnzq2T/1f4W/58ipX1T/9Perr9Y313eqJ7u+Wqb8G65e8w/hyORXvqhcv/TkO1NPvvUrl+qX1jffpfr+TvUWleurZff3vuHqNR/qyORXvqhcv/TkO1NPvvUrl+qX1jffpfr+TvUWleurZff3vuHqNR94+vCp5z37+ubV01eXX1T+7b1F7VfuSPmLaX9h7p65vdL6jpT/hKvXfOD0QTL1vGdf37x6+uryi8q/vbeo/codKX8x7S/M3TO3V1rfkfKfcPWaH+CD9R0xt1f+Lu57Ry21Zy7Tnky9yiffXD1Rfe87spury7/J1Ws+3AfrO2Jur/xd3PeOWmrPXKY9mXqVT765eqL63ndkN1eXf5Or13YfPulTv7RjXrp879WIvlq/RspfmJcuX6q/y7RnXrr8X3D16u4HTPrUL+2Yly7fezWir9avkfIX5qXLl+rvMu2Zly7/F1y9uvsBU0/fXHZ9tb55+WKvpjjNvesU5moxr99R65ur9c0nv/QNrl47/ZBd31x2fbW+eflir6Y4zb3rFOZqMa/fUeubq/XNJ7/0De5eAz+sPkC/+pMv9p3qFealJ9+8elK5Wt+Rb/PJl/IXlZe/mPIn/ObqH/4B60P0qz/5Yt+pXmFeevLNqyeVq/Ud+TaffCl/UXn5iyl/wm+u/jE93D+wfbW459hT18ipv6i8fk8t5qWdKbdX/fIdMXfs7eKd0/0d7l6D6cF+mH21uOfYU9fIqb+ovH5PLealnSm3V/3yHTF37O3indP9Ha5emx445Yvq+YeYemr9yu2p9c3V5de+uehPdxb27JdvPlF31PrOKd/ufeLqtemBU76onn/AqafWr9yeWt9cXX7tm4v+dGdhz3755hN1R63vnPLt3ifuXvvDD62H609afzffndov3ylO87pbWr+YenWvtP6Ul3/K0/0TfvIr/iHqg/Qnrb+b707tl+8Up3ndLa1fTL26V1p/yss/5en+CT/5lekDzEs7t/Du7kz7lZdv/m1PTv2i+r/2ZfWcym9y99of00PNSzu38O7uTPuVl2/+bU9O/aL6v/Zl9ZzKb3L32h8+uB4+5XLac8R8dwp7ztSrXCZ/GvvytO9MvSl3ZMqfcPfaHz64Hj7lctpzxHx3CnvO1KtcJn8a+/K070y9KXdkyp9w99pD6kPV+pVL9XbvVF7+bep3Tt9fvcmvmaied6q3MJ/0De5ee0j9odT6lUv1du9UXv5t6ndO31+9ya+ZqJ53qrcwn/QNrl7zQ3en9ifsO7s9x73S+jXVk/IX5t6rXF2+2jnNJ+yd6sm/wdWr/sF2p/Yn7Du7Pce90vo11ZPyF+beq1xdvto5zSfsnerJv8HVq6cPtb+0/inuq4upZ17vLa0/UXvqyV94b+ov7O1q/WK3b76794SrV08fav/WB7uvLqaeeb23tP5E7aknf+G9qb+wt6v1i92++e7eE65e9aF+QOWiX/uVT1PYm0ZO/aL6k7877qlr7E24X3vmu1P7N7l6zQf68MpFv/Yrn6awN42c+kX1J3933FPX2Jtwv/bMd6f2b3L1mg/04ZWr9SemvcpL10j5i9rXd+yJ/d2e/qT1J3b3zNWTX5z2d7h6zQf6B6tcrT8x7VVeukbKX9S+vmNP7O/29CetP7G7Z66e/OK0v8PVaz7QP1jl6qfjvV2tbz7pierrqyfqvbv5wl7N1N9l2tOf9C+4et0H+weoXP10vLer9c0nPVF9ffVEvXc3X9irmfq7THv6k/4FV6+fPnjq+wesvrk9tb65Wp7uqcsvplzsq3dxT73rm09+4d7U/4ar104fOPX98Oqb21Prm6vl6Z66/GLKxb56F/fUu7755BfuTf1vuHrNh+6O+2r9ym/NKbv71St/ovr60/1vfXP909yeWt/8F1y96ofsjvtq/cpvzSm7+9Urf6L6+tP9b31z/dPcnlrf/Bf85urLy/8T3v8gLy8feP+DvLx84P0P8vLygfc/yMvLB97/IC8vH3j/g7y8fOD9D/Ly8oH3P8jLywfe/yAvLx94/4O8vHzg/Q/y8vKB9z/Iy8sH3v8gLy8feP+DvLx84P0P8vLygfc/yMvLB97/IC8vH3j/g7y8fOC/Acp9OPj144RMAAAAAElFTkSuQmCC
title: qr_byte_code
status:
type: string
maxLength: 20
description: "Transaction Status, following status you will receive in response \n- CREATED - The transaction has successfully been created \n- PENDING - Transaction pending action from customer \n- AUTHORIZED - Authorization approved \n- CAPTURED - Transaction fully captured \n- CAPTURED_PARTIALLY - Transaction partially captured \n- CANCELLED - Transaction cancelled \n- DECLINED - Transaction declined by the payment processor \n- REJECTED - Requsest rejected after business logic check \n- SYSTEM_ERROR- Internal system error occurred processing the transaction \n- SETTLED - Transaction settled \n- SUCCESS - The operation was successfully processed \n- UNKNOWN - The result of the operation is unknown \n- WAIT_CONFIRMATION - Transaction awaiting confirmation from user \n- PENDING_SETTLEMENT - Transaction accepted settlement in process \n- FAILED - 'rejection code - rejection description' "
title: status
description:
type: string
maxLength: 200
description: "Transaction Status, following status you will receive in response \n- CREATED - The transaction has successfully been created \n- PENDING - Pending action from customer \n- AUTHORIZED - Authorization approved \n- CAPTURED - Transaction fully captured \n- CAPTURED_PARTIALLY - Transaction partially captured \n- CANCELLED - Transaction cancelled \n- DECLINED - Transaction declined by the payment processor \n- REJECTED - Requsest rejected after business logic check \n- SYSTEM_ERROR- Internal system error occurred processing the transaction \n- FAILED - Transaction failed for invalid payload \n- SETTLED - Transaction settled \n- SUCCESS - The operation was successfully processed \n- UNKNOWN - The result of the operation is unknown \n- WAIT_CONFIRMATION - Transaction awaiting confirmation from user \n- PENDING_SETTLEMENT - Transaction accepted settlement in process \n- FAILED - 'rejection code - rejection description' "
example: Transaction declined by the payment processor
title: description
creation_date_time:
type: string
format: date-time
description: "GMT (ISO 8601 YYYY-MM-DDTHH:MM:SS.sssZ) \n- Instant Payment (Debit) - Date time, generated by CitiConnect API, when CitiConnect API accepted a payment initiation after validation \n- Instant Payment (Credit) - Date time, either provided by the debtor bank or generated by Citi's transaction processing application, when a transaction was created \n- For US ACH Direct Debit, this parameter is mandatory \n- For Brazil PIX, this parameter is mandatory"
example: '2022-09-13T08:23:49.114Z'
title: creation_date_time
tax_id:
maxLength: 128
minLength: 1
type: string
description: "Merchant's payee identification (e.g., email address) \n - For Brazil QR creation merchant.payee_id parameter is mandatory, allowed maxlength is 77 \n- This parameter is optional for Brazil QR PIX transaction"
example: 1.020.340/8910-22
title: tax_id
remittance_info:
type: array
description: Unstructured remittance information
items:
$ref: '#/components/schemas/Unstructured'
url:
$ref: '#/components/schemas/Url'
value_date:
type: string
format: date
description: "YYYY-MM-DD Date in local time zone (e.g., EST for a United States RTP network transaction IST for IN IMPS) when Citi's transaction processing application starts processing a transaction \n- For US ACH Direct Debit, this parameter is mandatory \n- For Brazil PIX, this parameter is mandatory"
example: '2022-09-07'
title: value_date
expiry_date:
type: string
format: date
description: "Expiry Date Format is YYYY-MM-DD \n- For US RFP this parameter is mandatory"
title: expiry_date
reference:
description: "Transaction additional information. \n - For UK PAYBYBANK Creation reference parameter is optional and allowed maximum length is 128 \n- For US ACH Direct Debit, this parameter is mandatory with max length 7"
example: REPAY
maxLength: 250
minLength: 1
type: string
title: reference
reason:
description: Cancellation/adjustment reason.
example: REPAY
maxLength: 140
minLength: 1
type: string
title: reason
batch_id:
maxLength: 35
minLength: 1
type: string
description: Identification for your Citi account consolidated credit posting including the transaction
example: batch12345
title: batch_id
network_id:
maxLength: 128
minLength: 1
type: string
description: "Transaction identification generated by the network (clearing) \n- This parameter is optional for India UPI and UK PAYBYBANK transaction"
example: clr02052023478
title: network_id
network:
type: string
enum:
- RTP
- FDN
description: Financial market infrastructure or clearing system (e.g., RTP Network in the United States)
title: network
full_amount:
type: number
minimum: 0.01
maximum: 1000000000000000000
description: "Amount that is the gross amount payable by client \n- For US RFP transaction, this parameter is optional"
title: full_amount
discount_amount:
type: number
minimum: 0.01
maximum: 100000000000000000
description: "Amount that is the discount from the gross amount \n- Optional for US RFP. If populated, message.transaction.full_amount must also be popluated."
title: discount_amount
original_amount:
type: number
minimum: 0.01
maximum: 100000000000000000
description: "Amount that was originally sent by our client \n- For US RFP transaction, this parameter is optional"
title: original_amount
uetr:
type: string
pattern: ^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][a-f0-9]{3}-[a-f0-9]{12}$
description: "UUID v4 format unique end-to-end transaction reference \n- This parameter is optional for India UPI and UK PAYBYBANK transaction \n- For Brazil PIX, this parameter is mandatory"
example: 4f09214d-296c-494b-8e9c-810bf1d9fc93
title: uetr
redirect_url:
type: string
maxLength: 500
description: The URL to which you must redirect the payer's browser to complete the payment when using the payment provider's website.
example: https://greenzone-api.uat.nam.nsroot.net/api/notification
title: redirect_url
psp_reference:
type: string
maxLength: 36
minLength: 1
description: "Payment session id generated by Banked (third party system). Will be present in case of link creation being successful \n - For UK PAYBYBANK Creation payment_session_field parameter is mandatory for success link creation."
example: PAY1234567
title: psp_reference
product_info:
type: array
items:
$ref: '#/components/schemas/Product-Info'
retry_possible:
description: Identifier to indicate if the payment journey has ended or further retries are possibility Y - indicates that a retry is possible on the same link N - indicates no further retry is possible on this link
enum:
- Y
- N
example: Y
type: string
title: retry_possible
status_date_time:
format: date-time
type: string
description: "Date & Time when Payer bank provided their response GMT (ISO 8601 YYYY-MM-DDTHH:MM:SS.sssZ) \n- This parameter is mandatory for Brazil PIX"
example: '2022-09-13T08:23:49.114Z'
title: status_date_time
clearing_local_code:
maxLength: 4
minLength: 1
type: string
description: Local Clearing code
example: 008T
title: clearing_local_code
bill_id_1:
description: Bill identification for a bill payment
maxLength: 128
minLength: 1
pattern: ^[0-9A-Z]{1,128}$
type: string
example: '77889900'
title: bill_id_1
bill_id_2:
description: Bill identification for a bill payment
maxLength: 128
minLength: 1
pattern: ^[0-9A-Z]{1,128}$
type: string
example: '77889901'
title: bill_id_2
bill_id_3:
description: Bill identification for a bill payment
maxLength: 128
minLength: 1
pattern: ^[0-9A-Z]{1,128}$
type: string
example: '77889902'
title: bill_id_3
bill_due_date:
description: ISO 8601 (YYYY-MM-DD) bill due date
type: string
format: date
example: '2025-01-01'
title: bill_due_date
wht_rate:
description: Withholding tax (WHT) rate
type: number
minimum: 0
maximum: 100
example: 10
title: wht_rate
wht_amount:
description: Withholding tax (WHT) amount
type: number
minimum: 0.01
maximum: 1000000000000000
example: 1000
title: wht_amount
wht_code:
description: Withholding tax (WHT) code A for WHT always paid by the seller, S for WHT once paid by the seller and B for WHT paid by the buyer
type: string
enum:
- A
- S
- B
example: A
title: wht_code
processing_code:
description: Code defined by regulator to identify different kind of payments
type: string
minLength: 1
maxLength: 35
example: '550000'
title: processing_code
purpose:
$ref: '#/components/schemas/Purpose'
income_type:
description: Income type
type: string
pattern: ^(00[0-9]|01[0-2])$
example: '001'
title: income_type
vat_rate:
description: Value-added tax (VAT) rate
type: number
minimum: 0
maximum: 100
example: 10
title: wht_rate
vat_amount:
description: Value-added tax (VAT) amount
type: number
minimum: 0.01
maximum: 1000000000000000
example: 100
title: vat_amount
holiday_flag:
description: Specifies if a request should consider holiday
type: boolean
example: true
title: holiday_flag
Rfp-Mandate-Notification:
type: object
title: Rfp Mandate Notification
properties:
id:
type: string
maxLength: 35
description: "Unique Id assigned to identify the mandate \n- This parameter is mandatory for Brazil PIX Initiation with max length 29."
example: RR3347902320251109BRF12345678
title: id
Upi:
title: Upi
description: India UPI Transaction
properties:
initiation_type:
description: "Mode of payment \n- For India UPI trasnaction, this parameter is Mandatory"
maxLength: 50
minLength: 1
type: string
example: UPI QR Code
title: initiation_type
Customer:
title: Customer
properties:
account:
title: customer account
description: Account Details
properties:
number:
maxLength: 40
minLength: 1
type: string
description: "Customer's bank account \n- For US RFP this parameter is mandatory with max length 40 \n- For ACH, max length is 17 \n - For ACH Pay and verify transaction customer.account.number parameter is mandatory \n- For US ACH Direct Debit, customer.account.number parameter is mandatory with max length 17"
example: '1122334455'
title: number
bank_id:
maxLength: 35
minLength: 1
type: string
description: "Customer bank's network identification \n- For US RFP this parameter is mandatory with max length 16 \n- For ACH, length is equal to 9 \n - For ACH Pay and verify transaction customer.account.bank_id parameter is mandatory \n- For US ACH Direct Debit, customer.account.bank_id parameter is mandatory with maximum length 9 \n- For Brazil PIX Initiation, this parameter is mandatory with min & max length 8"
example: CITIIN77
title: bank_id
bank_name:
maxLength: 35
minLength: 1
type: string
description: "Name of the bank where customer is maintaining the account \n- For US ACH Direct Debit, customer.account.bank_name parameter is mandatory with max length 35"
example: CITI
title: bank_name
bank_country_code:
type: string
pattern: ^[A-Z]{2,2}$
description: "Country code of the bank where customer is maintaining the account \n- For US ACH Direct Debit, customer.account.bank_country parameter is mandatory"
example: US
title: bank_country_code
name:
maxLength: 70
minLength: 1
type: string
description: "Customer's Account Name \n- For US RFP transaction, customer.account.name parameter is optional"
title: name
type:
description: "An indicator identifying the type of bank account \n - For ACH Pay and verify transaction customer.account.type parameter is mandatory \n - For US ACH Direct Debit, customer.account.type parameter is mandatory with allowed values - SAVINGS & CORPORATE_CHECKING"
enum:
- SAVINGS
- CURRENT
- CARD
- OVERDRAFT
- VIRTUAL_ACCOUNT
- CORPORATE_CHECKING
example: SAVINGS
type: string
title: type
id:
description: Merchant internal customer ID.
example: 1234abcjki
maxLength: 40
minLength: 1
type: string
title: id
name:
$ref: '#/components/schemas/Name'
tax_id:
description: "Customer's payer identification (e.g., email address) \n- For Brazil PIX Initiation, this parameter is mandatory, individual person tax identification (CPF) allowed length = 11 or business entity tax identification (CNPJ) allowed length = 14"
example: 234.453.678-21
maxLength: 100
minLength: 1
type: string
title: tax_id
national_id:
description: An identifier for the payer assigned by a government authority.
example: 234.453.678-21
maxLength: 30
minLength: 1
type: string
title: national_id
email:
description: "Customer email \n - For UK PAYBYBANK creation, customer.email parameter is mandatory."
example: customer.raj2024@gmail.com
type: string
pattern: '[a-z0-9._%+-]+@[a-z0-9.-]+\.[a-z]{2,4}$'
title: email
phone:
description: Customer phone.
example: '+919962125789'
pattern: \+[0-9]{1,3}[-\ ][0-9()+\-]{1,30}
type: string
title: phone
line_of_business:
description: Your payment service provider might have configured your merchant profile to support several lines of business.
example: SMALL BUSINESS
maxLength: 100
minLength: 1
type: string
title: line_of_business
type:
description: "Customer type \n - For Brazil QR Creation customer.type parameter is mandatory \n- For US RFP, this parameter is optional"
enum:
- INDIVIDUAL
- BUSINESS
example: BUSINESS
type: string
title: type
organization_id:
description: 'Customer Organization Id/ Legal Entity as provided at the time of payment request.
- For US RFP max length is 20'
example: ORG123456
maxLength: 35
minLength: 1
type: string
title: organization_id
birth_date:
type: string
format: date
description: "ISO 8601 (YYYY-MM-DD), Customer's birth_date \n- For US RFP and PAYPAL transactions, customer.birth_date parameter is optional"
title: birth_date
birth_city:
maxLength: 35
minLength: 1
type: string
description: "Customer's birth_city \n- For US RFP max length is 35"
title: birth_city
birth_country:
type: string
description: "Customer's birth_country \n- For US RFP transaction, customer.birth_country parameter is optional"
pattern: ^[A-Z]{2,2}$
title: birth_country
additional_info:
type: array
items:
$ref: '#/components/schemas/Additional-Info'
device:
$ref: '#/components/schemas/Customer-Device'
address:
$ref: '#/components/schemas/Address'
Rfp-Sender-Notification:
type: object
title: RFP Sender Notification
properties:
name:
maxLength: 140
minLength: 1
type: string
description: "Sender Name \n- For US RFP transaction, this parameter is optional"
title: name
address:
$ref: '#/components/schemas/Address'
organization_id:
description: 'Sender Organization Id/ Legal Entity as provided at the time of payment request.
- For US RFP max length is 20'
example: ORG123456
maxLength: 35
minLength: 1
type: string
title: organization_id
birth_date:
type: string
format: date
description: "ISO 8601 (YYYY-MM-DD), Sender's birth_date \n- For US RFP transaction, this parameter is optional"
title: birth_date
birth_city:
maxLength: 35
minLength: 1
type: string
description: "Sender's birth_city \n- For US RFP max length is 35"
title: birth_city
birth_country:
type: string
description: "Sender's birth_country \n- For US RFP transaction, this parameter is optional"
pattern: ^[A-Z]{2,2}$
title: birth_country
private_id:
maxLength: 35
minLength: 1
type: string
description: "Sender's private ID \n- For US RFP transaction, this parameter is optional"
title: private_id
Customer-Update:
type: object
title: Customer Update
properties:
id:
description: Merchant internal customer ID.
example: 1234abcjki
maxLength: 40
minLength: 1
type: string
title: id
type:
type: string
enum:
- INDIVIDUAL
- BUSINESS
description: "Merchant customer type \n - For Brazil QR update customer.type parameter is mandatory, if anyone of the parameter method.pix.tax_id and customer.name is provided"
example: BUSINESS
title: type
tax_id:
description: Customer's payer identification (e.g., email address).
example: 234.453.678-21
maxLength: 100
minLength: 1
type: string
title: tax_id
name:
$ref: '#/components/schemas/Name'
address:
$ref: '#/components/schemas/Address'
additional_info:
type: array
items:
$ref: '#/components/schemas/Additional-Info'
Url-Update:
title: url
description: URL.
properties:
accepted:
description: Acceptance URL.
example: accepted
maxLength: 128
minLength: 1
type: string
title: accepted_url
declined:
description: Declined URL.
example: declined
maxLength: 128
minLength: 1
type: string
title: declined_url
Receiver:
type: object
title: receiver
properties:
name:
maxLength: 140
minLength: 1
type: string
description: "Receiver Name \n- For US RFP transaction, this parameter is optional \n- For US ACH Direct Debit, receiver.name parameter is mandatory with max length 16"
title: name
address:
$ref: '#/components/schemas/Address'
organization_id:
description: "Receiver Organization Id/ Legal Entity as provided at the time of payment request.\n- For US RFP max length is 20 \n- For US ACH Direct Debit, receiver.organization_ID parameter is mandatory with max length 10"
example: ORG123456
maxLength: 35
minLength: 1
type: string
title: organization_id
birth_date:
type: string
format: date
description: "ISO 8601 (YYYY-MM-DD), Receiver's birth_date \n- For US RFP transaction, this parameter is optional"
title: birth_date
birth_city:
maxLength: 35
minLength: 1
type: string
description: "Receiver's birth_city \n- For US RFP max length is 35"
title: birth_city
birth_country:
type: string
description: "Receiver's birth_country \n- For US RFP transaction, this parameter is optional"
pattern: ^[A-Z]{2,2}$
title: birth_country
private_id:
maxLength: 35
minLength: 1
type: string
description: "Receiver's private ID \n- For US RFP transaction, this parameter is optional"
title: private_id
Billing-Agreement:
title: Billing Agreement
description: Paypal Billing Method Response
properties:
cardinality:
description: Indicates the number of billing agreements between you and this payer.
example: '4'
maxLength: 100
minLength: 1
type: string
title: cardinality
description:
description: Your description for the PayPal billing agreement.This description is displayed to the payer when they are asked to approve the billing agreement.
example: '4'
maxLength: 255
minLength: 1
type: string
title: description
id:
description: An identifier provided by PayPal for the billing agreement
example: '4'
maxLength: 100
minLength: 1
type: string
title: id
name:
description: Your name for the PayPal billing agreement
example: '4'
maxLength: 255
minLength: 1
type: string
title: name
Card:
title: card
description: "\n- For CARD Authorize operation method.card parameter is mandatory when method.type parameter is selected as CARD \n- For CARD Capture operation method.card parameter is mandatory when method.type parameter is selected as CARD \n- For CARD Pay operation method.card parameter is mandatory when method.type parameter is selected as CARD \n- For CARD Verify operation method.card parameter is mandatory when method.type parameter is selected as CARD"
properties:
number:
description: "The customer’s payment card number, also known as the Primary Account Number (PAN). \n- For CARD Authorize operation method.card.number parameter is mandatory \n- For CARD Pay operation method.card.number parameter is mandatory \n- For CARD Verify operation method.card.number parameter is mandatory \n- For India card transaction, method.card.number parameter is mandatory when token number is not provided"
example: PA123456789
maxLength: 23
minLength: 9
type: string
title: number
expiry_month:
description: "Two-digit month in which the payment card expires. \n- For CARD Authorize operation method.card.expiry_month parameter is mandatory \n- For CARD Pay operation method.card.expiry_month parameter is mandatory \n- For CARD Verify operation method.card.expiry_month parameter is mandatory \n- For India card transaction, method.card.expiry_month parameter is mandatory"
example: '01'
type: string
pattern: ^(0?[1-9]|1[0-2])$
title: expiry_month
expiry_year:
description: "Four-digit year in which the payment card expires. \n- For CARD Authorize operation method.card.expiry_year parameter is mandatory \n- For CARD Pay operation method.card.expiry_year parameter is mandatory \n- For CARD Verify operation method.card.expiry_year parameter is mandatory \n- For India card transaction, method.card.expiry_year parameter is mandatory"
type: string
pattern: ^[0-9]{2,2}$
example: '25'
title: expiry_year
cvv:
description: "Card security code. \n- For India card transaction, method.card.cvv parameter is mandatory"
example: '311'
maxLength: 4
minLength: 3
type: string
title: cvv
type:
description: You can provide this parameter for card types that have a savings/checking option, such as Maestro cards.If you do not provide a value, we will use the acquirer's default. You can use paymentTypes.card.cardTypes in the 'Retrieve Payment Options' operation response to determine the card type.
enum:
- CHECKING
- SAVINGS
example: SAVINGS
type: string
title: type
card_type:
description: This parameter is only applicable if the gateway has identified the card as a co-branded card.
example: JOHN
maxLength: 50
minLength: 3
type: string
title: card_type
last_4_digits:
description: "The customer’s payment card last four number. \n- For India card transaction, method.card.last_4_digits parameter is mandatory when token number is provided"
example: '1234'
maxLength: 4
minLength: 4
type: string
title: last_4_digits
cryptogram:
description: "The card cryptogram details. \n- For India card transaction, method.card.cryptogram parameter is mandatory when token number is provided and allowed maximum length is 50."
example: PA123456789
maxLength: 50
minLength: 1
type: string
title: cryptogram
diner_token_reference:
description: The card diner token reference.
example: PA123456789
maxLength: 50
minLength: 1
type: string
title: diner_token_reference
diner_merchant_id:
description: The card diner merchant id.
example: ADFEGTYYUU
maxLength: 50
minLength: 1
type: string
title: diner_merchant_id
device:
$ref: '#/components/schemas/Device'
Device:
title: device
type: object
description: Device
properties:
eci_indicator:
description: The Electronic Commerce Indicator generated for payments made using a device payment method.
example: '12'
maxLength: 2
minLength: 1
type: string
title: eci_indicator
cryptogram:
description: A cryptogram used to authenticate the transaction.
example: '56789'
maxLength: 128
minLength: 1
type: string
title: cryptogram
cryptogram_format:
description: The format of the cryptogram provided for the digital payment.
enum:
- 3DSECURE
- EMV
example: EMV
type: string
title: cryptogram_format
payment_token:
description: This is the payment token that you received from the device's payment SDK.
example: '56789'
maxLength: 16384
minLength: 1
type: string
title: payment_token
masked_fpan:
description: The Funding Primary Account Number (FPAN) of the payer's account in 6.4 masking format.
example: '5678967898'
maxLength: 19
minLength: 9
type: string
title: masked_fpan
masked_fpan_expiry_month:
description: The expiration month for the Funding Primary Account Number (FPAN).
example: '12'
type: string
pattern: ^(0?[1-9]|1[0-2])$
title: masked_fpan_expiry_month
masked_fpan_expiry_year:
description: The expiration year for the Funding Primary Account Number (FPAN).
type: string
pattern: ^[0-9]{2,2}$
example: '25'
title: masked_fpan_expiry_year
sequence_number:
description: A number used to differentiate between cards with the same Primary Account Number (PAN).
example: '879'
maxLength: 999
minLength: 1
type: string
title: sequence_number
Mandate:
title: Mandate
properties:
offer_id:
description: The unique identifier of the payment plan offer that the payer has accepted.
example: OF123456789
maxLength: 60
minLength: 1
type: string
title: offer_id
amount_variability:
description: Indicates if all the payments within the agreement use the same amount or if the amount differs between the payments. The parameter must be provided for recurring payment agreements.
enum:
- FIXED
- VARIABLE
example: VARIABLE
type: string
title: amount_variability
custom_data:
description: Additional information requested for the agreement which cannot be passed using other available data parameters. This parameter must not contain sensitive data.
example: '7788'
maxLength: 2048
minLength: 1
type: string
title: custom_data
expiry_date:
description: "Date at which your agreement with the payer to process payments expires. \n- For Brazil PIX Initiation, this parameter is mandatory."
example: '2024-02-15'
format: date
type: string
title: expiry_date
id:
description: "Your identifier for the agreement you have with the payer to process payments.When you collect cards from your payers and store them for later use, you must provide an agreement ID when you use the stored values for: Recurring payments: you have an agreement with the payer that authorizes you to automatically debit their account at agreed intervals for fixed or variable amounts. For example, gym membership, phone bills, or magazine subscriptions. Installment payments: you have an agreement with the payer that authorizes you to process multiple payments over an agreed period of time for a single purchase. For example, the payer purchases an item for $1000 and pays for it in four monthly installments. Unscheduled: you have an agreement with the payer that authorizes you to process future payments when required. For example, the payer authorizes you to process an account top-up transaction for a transit card when the account balance drops below a certain threshold.Industry Practice: you have an agreement with the payer that authorizes you to initiate additional transactions to fulfil a standard business practice related to an original payment initiated by the payer. For example, a delayed charge for use of the hotel mini bar after the payer has checked out or a no show penalty charge when the payer fails to show for a booking. When you first establish an agreement with the payer you should also specify the type of agreement in agreement.type. \n- For Brazil PIX Initiation, this parameter is mandatory with max length 29 in format RR33479023yyyyMMddBRkkkkkkkkk and this should be same id received as part of push notification while creating the mandate"
example: RR123456789
maxLength: 100
minLength: 1
type: string
title: id
maximum_amount:
description: The maximum amount for a single payment in the series as agreed with the payer under your agreement with them. The amount must be provided in the currency of the order.
example: '200'
maxLength: 14
minLength: 1
type: string
title: maximum_amount
minimum_amount:
description: The minimum amount for a single payment in the series as agreed with the payer under your agreement with them. The amount must be provided in the currency of the order.
example: '200'
maxLength: 14
minLength: 1
type: string
title: minimum_amount
minimum_days:
description: The minimum number of days between payments agreed with the payer under your agreement with them.
example: 7788
maximum: 9999
minimum: 1
type: number
title: minimum_days
number_of_payments:
description: The number of merchant-initiated payments within the recurring payment agreement.
example: 778
maximum: 999
minimum: 1
type: number
title: number_of_payments
frequency:
description: The frequency of the payments within the series as agreed with the payer under your agreement with them.
enum:
- AD_HOC
- DAILY
- FORTNIGHTLY
- MONTHLY
- OTHER
- QUARTERLY
- TWICE_YEARLY
- WEEKLY
- YEARLY
example: YEARLY
type: string
title: frequency
type:
description: The type of commercial agreement that the payer has with you.Specify the agreement type when you have provided a value for agreement.id and this payment is the first in a series of payments. The default value is OTHER.
enum:
- INSTALLMENT
- OTHER
- RECURRING
- UNSCHEDULED
example: UNSCHEDULED
type: string
title: frequency
start_date:
description: This is the effective start date for the payment agreement.
example: '2024-02-15'
format: date
type: string
title: start_date
charges_owned_by:
description: Indicates who ownes the charges fees
enum:
- MERCHANT
- CONSUMER
example: CONSUMER
type: string
title: charges_owned_by
additional_info:
type: array
items:
$ref: '#/components/schemas/Additional-Info'
type: object
Payment-Method-Response:
type: object
title: Payment Method Response
properties:
method:
$ref: '#/components/schemas/Payment-Method'
additionalProperties: false
description: Payment method response
Merchant-Notification:
title: Merchant Notification
properties:
name:
description: "Merchant internal customer name. \n- For US RFP, IN UPI, UK PAYBYBANK transactions, merchant.name parameter is optional \n- For US ACH Direct Debit, this parameter is mandatory with max length 16 \n- For Brazil PIX, this parameter is mandatory with max length 105"
example: JOHN
maxLength: 140
minLength: 1
type: string
title: name
tax_id:
maxLength: 128
minLength: 1
type: string
description: "Merchant's payee identification (e.g., email address) \n - For Brazil QR creation merchant.tax_id parameter is mandatory, allowed maxlength is 77"
example: 1.020.340/8910-22
title: tax_id
account:
title: merchant account
description: Account Details
properties:
number:
maxLength: 40
minLength: 1
type: string
description: "Merchant's bank account \n- TFor US RFP, IN UPI, UK PAYBYBANK transactions, merchant.number parameter is optional \n- For US ACH Direct Debit, this parameter is mandatory with max length 17 \n- For Brazil PIX, thi parameter is mandatory with max length 10"
example: '1122334455'
title: number
bank_id:
maxLength: 35
minLength: 1
type: string
description: "Merchant bank's network identification \n- For US RFP, IN UPI,UK PAYBYBANK transactions, merchant.bank_id parameter is optional \n- For US ACH Direct Debit, this parameter is mandatory with max length 9 \n- For Brazil PIX, thi parameter is mandatory with max length 8"
example: CITIIN77
title: bank_id
branch_id:
description: Merchant bank's branch id
minLength: 1
maxLength: 35
type: string
example: BR123
title: branch_id
name:
maxLength: 70
minLength: 1
type: string
description: "Merchant's Account Name \n- For US RFP transaction, merchant.account.name parameter is optional "
title: name
proxy_id:
description: "Merchant's proxy identification (e.g., email address) \n - For IN UPI Instant payment debtor.proxy_id is mandatory, with an allowed value of VPA ID"
example: vinu@citi.com
maxLength: 320
minLength: 1
type: string
title: proxy_id
proxy_type:
type: string
enum:
- BIID
- EMAL
- EWAL
- MBNO
- NIDN
description: Merchant's proxy type (BIID for bill identification, EMAL for email address, EWAL for electronic wallet identification, MBNO for mobile number and NIDN for national identification)
title: proxy_type
virtual_number:
description: Merchant's Virtual account number
type: string
maxLength: 140
minLength: 1
example: '123456789'
title: virtual_number
issuer:
description: Entity that assigned account to the party
type: string
maxLength: 35
minLength: 1
example: ABC Ltd
title: issuer
private_id:
description: "Merchant's prvt_id \n- For UK PAYBYBANK, merchant.private_id parameter is optional"
example: '8899775544'
maxLength: 18
minLength: 1
type: string
title: private_id
organization_id:
description: 'Merchant Organization Id/ Legal Entity as provided at the time of payment request.
- For US RFP max length is 20'
example: ORG123456
maxLength: 35
minLength: 1
type: string
title: organization_id
birth_date:
type: string
format: date
description: "ISO 8601 (YYYY-MM-DD), Merchant's birth_date \n- For US RFP, merchant.birth_date parameter is optional"
title: birth_date
birth_city:
maxLength: 35
minLength: 1
type: string
description: "Merchant's birth_city \n- For US RFP, merchant.birth_city parameter is optional and allowed max length is 35"
title: birth_city
birth_country:
type: string
description: "Merchant's birth_country \n- For US RFP, merchant.birth_country parameter is optional"
pattern: ^[A-Z]{2,2}$
title: birth_country
birth_province:
description: Merchant's birth province
type: string
maxLength: 35
minLength: 1
title: birth_province
address:
$ref: '#/components/schemas/Notification-Address'
Paypal-Response:
title: Paypal
description: Paypal Method Response
properties:
account_email:
description: The email address of the payer's PayPal account.
example: john@gmail.com
maxLength: 100
minLength: 4
type: string
title: account_email
account_holder:
description: The name of the account holder of the payer's PayPal account
example: john@gmail.com
maxLength: 255
minLength: 1
type: string
title: account_holder
billing_agreement:
$ref: '#/components/schemas/Billing-Agreement'
payer_id:
description: The unique identifier for the payer assigned by PayPal
example: '4'
maxLength: 13
minLength: 1
type: string
title: payer_id
Payments:
type: object
title: Payments
properties:
customer:
$ref: '#/components/schemas/Customer-Get'
sender:
$ref: '#/components/schemas/Sender-Notification'
merchant:
$ref: '#/components/schemas/Merchant-Status'
receiver:
$ref: '#/components/schemas/Receiver-Notification'
method:
$ref: '#/components/schemas/Method-Status'
transaction:
$ref: '#/components/schemas/Transaction-Status'
response_rfp:
$ref: '#/components/schemas/Rfp-Response-Rfp-Notification'
order:
$ref: '#/components/schemas/Order-Get-Notification'
mandate:
$ref: '#/components/schemas/Mandate'
shipping:
$ref: '#/components/schemas/Shipping'
risk:
$ref: '#/components/schemas/Risk'
additionalProperties: false
description: Payment status notification / inquiry response
Boleto:
title: boleto
type: object
description: '
- For BOLETO Pay operation method.boleto parameter is mandatory when method.type parameter is selected as BOLETO'
properties:
action_type:
description: The action to take if the payment is not honored.
enum:
- WRITE_OFF
example: WRITE_OFF
type: string
title: action_type
days_before_action:
description: Number of days granted by you to the customer after the due date of Boleto payment before the specified action is taken.
example: '2'
maxLength: 2
minLength: 1
type: string
title: days_before_action
due_date:
description: "The date by which the Boleto amount needs to be paid. \n- For BOLETO Pay operation method.boleto.days_before_action parameter is mandatory"
example: '2024-03-24'
format: date
title: due_date
Constraints:
title: constraints
type: object
description: Constraints
properties:
deferral_period:
description: The allowable number of deferral months for the payment plan.
example: PAYEMNT FOR GOODS
maxLength: 99
minLength: 1
type: string
title: deferral_period
number_of_payments:
description: The allowable number of installments for the payment plan.
maxLength: 99
minLength: 1
type: string
title: number_of_payments
supported:
description: The identifiers for the payment plans supported for this transaction.
example: '67'
maxLength: 40
minLength: 1
type: string
title: supported
Unstructured:
type: string
maxLength: 140
minLength: 1
description: “Unstructured remittance information”
title: Unstructured
Order-Get-Notification:
title: Order
properties:
id:
description: "A unique identifier for this order to distinguish it from any other order you create. \n- For CARD Authorize, Capture, Pay and Verify operation order.id parameter is mandatory \n- For ACH Pay and Verify transaction order.id parameter is mandatory"
example: OR123456789
maxLength: 40
minLength: 1
type: string
title: id
amount:
description: "The total amount for the order \n- For CARD Authorize operation order.amount parameter is mandatory \n- For CARD Capture operation order.amount parameter is mandatory \n- For CARD Pay operation order.amount parameter is mandatory \n- For CARD Verify operation order.amount parameter is mandatory and allowed maximum amount is 2 \n- For ACH PAY and Verify transaction, order.amount parameter is mandatory"
example: 200
maximum: 1000000000000000000
minimum: 0.01
type: number
title: amount
creation_date_time:
type: string
format: date-time
description: "GMT (ISO 8601 YYYY-MM-DDTHH:MM:SS.sssZ) \n- Instant Payment (Debit) - Date time, generated by CitiConnect API, when CitiConnect API accepted a payment initiation after validation \n- Instant Payment (Credit) - Date time, either provided by the debtor bank or generated by Citi's transaction processing application, when a transaction was created \n- For ACH PAY and Verify transaction, order.creation_date_time parameter is mandatory"
example: '2022-09-13T08:23:49.114Z'
title: creation_date_time
update_time:
type: string
format: date-time
description: "Indicates the date and time the gateway considers the order to have last been updated GMT (ISO 8601 YYYY-MM-DDTHH:MM:SS.sssZ) \n- Instant Payment (Debit) - Date time, generated by CitiConnect API, when CitiConnect API accepted a payment initiation after validation \n- Instant Payment (Credit) - Date time, either provided by the debtor bank or generated by Citi's transaction processing application, when a transaction was created \n- For ACH PAY and Verify transaction, order.last_update_time parameter is mandatory"
example: '2022-09-13T08:23:49.114Z'
title: update_time
reference:
description: An optional identifier for the orderFor example, a shopping cart number, an order number, or an invoice number.
example: REPAY789541
maxLength: 200
minLength: 1
type: string
title: reference
invoice_number:
description: The invoice number you issued for this order
example: INV789541
maxLength: 25
minLength: 1
type: string
title: invoice_number
currency_code:
description: "ISO 4217 Currency Code for instance USD/GBP/EUR \n- order.currency_code parameter is mandatory for all transaction type creation"
enum:
- BRL
- USD
- GBP
- INR
- EUR
- CAD
- HKD
- AUD
- SGD
- DKK
- NOK
- SEK
- PLN
- IDR
- MYR
- THB
- CHF
- PHP
- CZK
example: BRL
type: string
title: currency_code
merchant_amount:
description: "The total amount for the order in order.merchantCurrency units. \n- For CARD Authorize operation order.merchant_amount parameter is mandatory \n- For CARD Capture operation order.merchant_amount parameter is mandatory \n- For CARD Pay operation order.merchant_amount parameter is mandatory \n- For CARD Verify operation order.merchant_amount parameter is mandatory"
example: 200
maximum: 1000000000000000000
minimum: 0.01
type: number
title: merchant_amount
merchant_currency:
description: " The currency in which you priced your inventory for this order, expressed as an ISO 4217 alpha codeISO 4217 Currency Code for instance USD/GBP/EUR \n- order.merchant_currency parameter is mandatory for all transaction type creation"
enum:
- BRL
- USD
- INR
example: BRL
type: string
title: merchant_currency
status:
type: string
maxLength: 30
description: "Order Status, following status you will receive in response \n- AUTHENTICATED - The payer was successfully authenticated. \n- AUTHENTICATION_INITIATED - Payer authentication has been initiated but not completed. \n- AUTHENTICATION_NOT_NEEDED - Payer authentication was not performed as it was not needed. \n- AUTHENTICATION_UNSUCCESSFUL - Payer authentication was not able to be successfully completed. \n- AUTHORIZED - The payment has been authorized successfully but the authorized amount has not yet been captured, in part, full, or excess. \n- CANCELLED - The initial transaction for this order has been voided successfully. \n- CAPTURED - The authorized amount for this order, in full or excess, has been captured successfully. \n- CHARGEBACK_PROCESSED - A Chargeback has been processed against this order. \n- DISPUTED - The payment has been disputed and is under investigation. A request for information has been received or a chargeback is pending. \n- EXCESSIVELY_REFUNDED - The payment has been captured in part, full, or excess, but the captured amount in excess has been refunded successfully. \n- FAILED - The payment has not been successful. \n- FUNDING - The order transfers money to or from the merchant, without the involvement of a payer. For example, recording monthly merchant service fees from the payment service provider. \n- INITIATED - A browser payment that has successfully been initiated for this order. No payment has yet been made. \n- PARTIALLY_CAPTURED - The authorized amount for this order, in part, has been captured successfully. \n- PARTIALLY_REFUNDED - The payment has been captured in part, full, or excess, but the captured amount in part has been refunded successfully. \n- REFUNDED - The payment has been captured in part, full, or excess, but the captured amount in full has been refunded successfully. \n- REFUND_REQUESTED - A refund against captured amounts on this order has been requested but not executed. Requires further action to approve the refund. \n- VERIFIED - The card details for this order have successfully been verified. No payment has yet been initiated or made. \n- DISBURSED - The order amount has successfully been disbursed to the payer."
example: AUTHENTICATED
title: status
total_auth_amount:
description: "The amount that has been successfully authorized for this order. \n- For CARD Authorize operation order.total_auth_amount parameter is mandatory \n- For CARD Capture operation order.total_auth_amount parameter is mandatory \n- For CARD Pay operation order.total_auth_amount parameter is mandatory \n- For CARD Verify operation order.total_auth_amount parameter is mandatory"
example: 200
maximum: 1000000000000000000
minimum: 0.01
type: number
title: total_auth_amount
total_captured_amount:
description: "The amount that has been successfully captured for this order. \n- For CARD Authorize operation order.total_captured_amount parameter is mandatory \n- For CARD Capture operation order.total_captured_amount parameter is mandatory \n- For CARD Pay operation order.total_captured_amount parameter is mandatory \n- For CARD Verify operation order.total_captured_amount parameter is mandatory"
example: 200
maximum: 1000000000000000000
minimum: 0.01
type: number
title: total_captured_amount
total_disbursed_amount:
description: "The amount that has been successfully captured for this order. \n- For CARD Authorize operation order.total_disbursed_amount parameter is mandatory \n- For CARD Capture operation order.total_disbursed_amount parameter is mandatory \n- For CARD Pay operation order.total_disbursed_amount parameter is mandatory \n- For CARD Verify operation order.total_disbursed_amount parameter is mandatory"
example: 200
maximum: 1000000000000000000
minimum: 0.01
type: number
title: total_disbursed_amount
total_refunded_amount:
description: "The amount that has been successfully captured for this order. \n- For CARD Authorize operation order.total_refunded_amount parameter is mandatory \n- For CARD Capture operation order.total_refunded_amount parameter is mandatory \n- For CARD Pay operation order.total_refunded_amount parameter is mandatory \n- For CARD Verify operation order.total_refunded_amount parameter is mandatory"
example: 200
maximum: 1000000000000000000
minimum: 0.01
type: number
title: total_refunded_amount
item_amount:
description: The total item amount for the order.If you do not provide this value but provide line item data, then this amount is calculated as the sum of the item.quantity times the item.unitPrice for all the line items (total item amount).If you provide both this value and line item data, then the order.itemAmount MUST equal the total item amount.
example: '100.00'
maxLength: 14
minLength: 1
type: string
title: item_amount
Sender-Notification:
type: object
title: Sender Notification
properties:
name:
description: "Sender name. \n- For US RFP and UK PAYBYBANK transactions, sender.name parameter is optional"
example: JOHN
maxLength: 140
minLength: 1
type: string
title: name
organization_id:
description: "Sender's org_id. \n- For US RFP and UK PAYBYBANK transactions, sender.organizatio_id parameter is optional"
example: ORG123456
maxLength: 35
minLength: 1
type: string
title: organization_id
birth_date:
type: string
format: date
description: "ISO 8601 (YYYY-MM-DD), Sender's birth_date \n- For US RFP and UK PAYBYBANK transactions, sender.birth_date parameter is optional"
title: birth_date
birth_city:
maxLength: 35
minLength: 1
type: string
description: "Sender's birth_city \n- For US RFP and UK PAYBYBANK transactions, sender.birth_city parameter is optional"
title: birth_city
birth_country:
type: string
description: "Sender's birth_country \n- For US RFP and UK PAYBYBANK transactions, sender.birth_country parameter is optional"
pattern: ^[A-Z]{2,2}$
title: birth_country
birth_province:
description: Sender's birth province
type: string
maxLength: 35
minLength: 1
title: birth_province
private_id:
maxLength: 35
minLength: 1
type: string
description: "Sender's private ID \n - For US RFP transaction, sender.private_id parameter is optional"
title: private_id
account:
title: Sender account
description: Account details
properties:
bank_id:
description: Sender's bank network identification
minLength: 1
maxLength: 35
type: string
example: CITIBRSP
title: bank_id
issuer:
description: Entity that assigned account to the party
type: string
maxLength: 35
minLength: 1
example: ABC Ltd
title: issuer
address:
$ref: '#/components/schemas/Notification-Address'
Holder-Name:
title: Holder-Name
description: The name of the bank account holder for the payer's bank account.
properties:
first_name:
description: "first_name. \n - For ACH Pay and verify transaction method.holder.first_name parameter is mandatory \n - For India Card transactions, method.holder.first_name parameter is mandatory"
example: PETER
maxLength: 50
minLength: 1
type: string
title: first_name
last_name:
description: "last_name. \n - For ACH Pay and verify transaction method.holder.last_name parameter is mandatory \n - For India Card transactions, method.holder.last_name parameter is mandatory"
example: A
maxLength: 50
minLength: 1
type: string
title: last_name
Mandate-Notification:
type: object
title: Mandate Notification
properties:
id:
type: string
maxLength: 35
description: "Unique Id assigned to identify the mandate \n- This parameter is mandatory for Brazil PIX Credit notification."
example: RR3347902320251109BRF12345678
title: id
Device-Response:
title: Device Response
description: Device Response
properties:
cryptogram_format:
description: The format of the cryptogram provided for the digital payment.
enum:
- 3DSECURE
- EMV
example: EMV
type: string
title: cryptogram_format
Address:
type: object
description: Address
title: Address
properties:
floor:
description: Floor
maxLength: 70
minLength: 1
type: string
example: Second Floor
title: floor
room:
description: Room
maxLength: 70
minLength: 1
type: string
example: Magna
title: room
street_name:
maxLength: 70
minLength: 1
type: string
description: "Street Name.\n- For US RFP max length is 70 \n- For US ACH Direct Debit, customer.address.sreet_name parameter is mandatory with max length 17 (optional if address_lines is given) \n- For US ACH Direct Debit, merchant.address.street_name parameter is mandatory with max length 17 (optional if address_lines is given) \n- For ACH Direct Debit, receiver.address.street_name parameter is mandatory with max length 17 (optional if address_lines is given)"
example: Federal Street
title: street_name
building_number:
maxLength: 16
minLength: 1
type: string
description: "Building Number. \n- For US RFP max length is 16 \n- For US ACH Direct Debit, customer.address.building_number is mandatory with max length 16 (optional if address_lines is given) \n- For US ACH Direct Debit, merchant.address.building_number parameter is mandatory with max length 16 (optional if address_lines is given) \n- For US ACH Direct Debit, receiver.address.building_number parameter is mandatory with max length 16 (optional if address_lines is given)"
example: '20'
title: building_number
building_name:
maxLength: 35
minLength: 1
type: string
description: Building name
example: Venice
title: building_name
department:
maxLength: 70
minLength: 1
type: string
description: Address Department
example: Castle
title: department
sub_department:
maxLength: 70
minLength: 1
type: string
description: Address Sub Department
example: Mortgage
title: sub_department
district:
description: District name
maxLength: 70
minLength: 1
type: string
example: New ark
title: district
city:
maxLength: 100
minLength: 1
type: string
description: "City. \n- For US RFP max length is 35 \n- For US ACH Direct Debit, customer.address.city parameter is mandatory with max length 31 (optional if address_lines is given) \n- For US ACH Direct Debit merchant.address.city parameter is mandatory with max length 31 (optional if address_lines is given) \n- For US ACH Direct Debit, receiver.address.city parameter is mandatory with max length 31 (optional if address_lines is given)"
example: Abis Brasil
title: city
city_location:
maxLength: 100
minLength: 1
type: string
description: Customer location name
example: Churchil
title: city_location
post_box:
maxLength: 16
minLength: 1
type: string
description: Post box
example: '123'
title: post_box
postal_code:
maxLength: 16
minLength: 1
type: string
description: "Postal code. \n- For US RFP max length is 16 \n- For US ACH Direct Debit, customer.address.postal_code parameter is mandatory with max length 16 (optional if address_lines is given) \n- For US ACH Direct Debit merchant.address.postal_code is mandatory with max length 16 (optional if address_lines is given) \n- For US ACH Direct Debit, receiver.address.postal_code parameter is mandatory with max length 16 (optional if address_lines is given)"
example: 69935-000
title: postal_code
state:
maxLength: 50
minLength: 1
type: string
description: "State. \n- For US RFP max length is 35 \n- For US ACH Direct Debit, customer.address.state parameter is mandatory with max length 2, for example 'NJ' for New Jersey (optional if address_lines is given) \n- For US ACH Direct Debit merchant.address.state parameter is mandatory with max length 2, for example 'NJ' for New Jersey (optional if address_lines is given) \n- For US ACH Direct Debit, receiver.address.state parameter is mandatory with max length 2, for example 'NJ' for New Jersey (optional if address_lines is given)"
example: san francisco
title: state
country_code:
type: string
pattern: ^[A-Z]{2,2}$
description: "Country. \n- For US ACH Direct Debit, customer.address.country_code parameter is mandatory (optional if address_lines is given) \n- For US ACH Direct Debit merchant.adress.country_code parameter is mandatory (optional if address_lines is given) \n- For US ACH Direct Debit, receiver.address.country_code parameter is mandatory (optional if address_lines is given)"
example: BR
title: country_code
province_code:
description: The three character ISO 3166-2 country subdivision code for the state or province of the address
example: IN
maxLength: 3
minLength: 1
type: string
title: province_code
lines:
type: array
minItems: 1
maxItems: 7
items:
$ref: '#/components/schemas/Lines'
title: lines
Customer-Device:
title: Customer-Device
description: Customer-Device.
properties:
ani:
description: The telephone number captured by ANI (Automatic Number Identification) when the customer calls to place the order.
example: M1234567890
maxLength: 10
minLength: 1
type: string
title: ani
ani_call_type:
description: The 2 digit ANI information identifier provided by the telephone company to indicate the call type, for example, cellular (61-63), toll free (24,25), etc.
example: '63'
maxLength: 2
minLength: 1
type: string
title: ani_call_type
browser:
description: The User-Agent header of the browser the customer used to place the order.
example: '63'
maxLength: 2048
minLength: 1
type: string
title: browser
fingerprint:
description: Information collected about a remote computing device for the purpose of providing a unique identifier for the device.
example: '63'
maxLength: 4000
minLength: 1
type: string
title: fingerprint
hostname:
description: The name of the server to which the customer is connected.
example: '63'
maxLength: 60
minLength: 1
type: string
title: hostname
ip_address:
description: The name of the server to which the customer is connected.
example: '63'
maxLength: 15
minLength: 7
type: string
title: ip_address
mobile_phone_model:
description: The name of the server to which the customer is connected.
example: '63'
maxLength: 255
minLength: 1
type: string
title: mobile_phone_model
Notification-Address:
type: object
description: Notification-Address
title: Notification-Address
properties:
lines:
type: array
maxItems: 7
items:
$ref: '#/components/schemas/Lines'
title: lines
floor:
description: Floor
maxLength: 70
minLength: 1
type: string
example: Second Floor
title: floor
room:
description: Room
maxLength: 70
minLength: 1
type: string
example: Magna
title: room
street_name:
maxLength: 70
minLength: 1
type: string
description: Customer Street Name.
example: Federal Street
title: street_name
building_number:
maxLength: 16
minLength: 1
type: string
description: Building number
example: '20'
title: building_number
building_name:
maxLength: 35
minLength: 1
type: string
description: Building name
example: Venice
title: building_name
department:
maxLength: 70
minLength: 1
type: string
description: Address Department
example: Castle
title: department
sub_department:
maxLength: 70
minLength: 1
type: string
description: Address Sub Department
example: Mortgage
title: sub_department
district:
description: District name
maxLength: 70
minLength: 1
type: string
example: New ark
title: district
city:
maxLength: 100
minLength: 1
type: string
description: Customer city.
example: Abis Brasil
title: city
city_location:
maxLength: 100
minLength: 1
type: string
description: Customer location name
example: Churchil
title: city_location
post_box:
maxLength: 16
minLength: 1
type: string
description: Post box
example: '123'
title: post_box
postal_code:
maxLength: 16
minLength: 1
type: string
description: Customer postal code.
example: 69935-000
title: postal_code
state:
maxLength: 35
minLength: 1
type: string
description: Customer state.
example: san francisco
title: state
country_code:
type: string
pattern: ^[A-Z]{2,2}$
description: Customer country.
example: BR
title: country_code
province_code:
description: The three character ISO 3166-2 country subdivision code for the state or province of the address
example: IN
maxLength: 3
minLength: 1
type: string
title: province_code
Recipient-Name:
title: recipient name
type: object
description: Recipient Name
properties:
first_name:
description: The first name of the person to whom the order is being shipped.
example: JOHN
maxLength: 50
minLength: 1
type: string
title: first_name
last_name:
description: The last name or surname of the person to whom the order is being shipped.
example: PETER
maxLength: 50
minLength: 1
type: string
title: last_name
company_name:
description: The name of the company associated with this address.
example: COMPANY NAME
maxLength: 100
minLength: 1
type: string
title: company_name
Method-Status:
type: object
title: Method Status
properties:
type:
description: Method specified by the customer for the transaction
type: string
enum:
- PIX
- UPI
- IMPS
- IP
- CARD
- BOLETO
- ALIPAY
- GOOGLEPAY
- APPLEPAY
- ACH
- FPS
- RTP
- PAYPAL
- AFTERPAY
- AMAZON_PAY
- BITPAY
- BIZUM
- TRUSTLY
- BLIK
- BLIK_BNPL
- CASH_APP
- DOKU_WALLET
- EPS
- ESTONIAN_BANKS
- VERKKOPANKKI
- FLOAPAY
- FPX
- GOPAY
- IDEAL
- INDOMARET
- INDONESIAN_BANKS
- JENIUS_PAY
- KREDIVO
- LATVIAN_BANKS
- LINK_AJA
- LITHUANIAN_BANKS
- MBWAY
- MULTIBANCO
- OVO_WALLET
- PAYSAFECARD
- P24
- SATISPAY
- SCALAPAY
- SKRILL
- SWISH
- THAIBANKS
- TWINT
- WERO
- ZIP
- BANCOMATPAY
- DRAGONPAY
- MYBANK
- ALFAMART
- PAYU
- BANCONTACT
- STABLECOINS
- OXXO_PAY
example: PIX
title: type
token_id:
description: "Token_number. \n- For India card transaction, method.card.token_number parameter is mandatory when token number is provided and allowed maximum length is 50."
example: PA123456789
maxLength: 50
minLength: 1
type: string
title: token_number
session_id:
description: Session identification number
type: string
minLength: 36
maxLength: 37
example: SES1234567890123456789012345678
title: session_id
upi:
$ref: '#/components/schemas/Upi'
pix:
$ref: '#/components/schemas/Pix'
ach:
$ref: '#/components/schemas/Ach'
Error-Detail:
type: object
title: Error Detail
properties:
issue:
type: string
maxLength: 150
description: more details about the issue
title: issue
action:
type: string
maxLength: 150
description: corrective action to be taken to resolve above issue
title: action
code:
type: string
maxLength: 10
description: unique code representing the issue
title: code
Payments-Response:
type: array
items:
$ref: '#/components/schemas/Payments'
Merchant-Update:
type: object
title: Merchant Update
properties:
tax_id:
maxLength: 128
minLength: 1
type: string
description: "Merchant's payee identification (e.g., email address) \n - For Brazil QR creation merchant.tax_id parameter is mandatory, allowed maxlength is 77"
example: 1.020.340/8910-22
title: tax_id
additional_info:
type: array
items:
$ref: '#/components/schemas/Additional-Info'
additionalProperties: false
Sdk-Payer-Authentication-Response:
title: sdk payer authentication
description: sdk payer authentication response
properties:
callback_url:
description: URL to call after a 3DS challenge has been completed (valid RFC 1738 URL).
example: PA123456789
maxLength: 500
minLength: 1
type: string
title: callback_url
device_interface:
description: The UI formats the payer's device supports for challenges (EMVCosdkInterface).
example: PA123456789
maxLength: 256
minLength: 1
type: string
title: device_interface
redirect_url:
description: Indicates if the application should expect a Redirect URL in CRes to redirect the payer to their issuer's mobile banking app (true/false).
type: boolean
example: false
title: redirect_url
time_out:
description: 'The duration (in seconds) available to the payer to authenticate (Default: 900, range 300-900).'
example: PA123456789
maximum: 900
minimum: 300
type: number
title: time_out
ui_type:
type: array
items:
type: string
description: The UI types the SDK supports for displaying challenges within the app (EMVCosdkUiType).
title: ui_type
Payment-Qr-Failed:
type: object
title: Payment QR Failed
properties:
transaction:
type: object
title: Payment QR Failed Transaction
properties:
id:
maxLength: 128
minLength: 1
type: string
description: "Unique Transaction identification provided by the merchant during transaction creation \n- transaction.id parameter is mandatory for all transaction type creation \n- For Brazil QR Creation - Maximum length is 35."
example: pay02052023456r
title: id
status:
type: string
enum:
- SYSTEM_ERROR
- FAILED
description: "Transaction Status \n- SYSTEM_ERROR - Internal system error occurred processing the transaction"
title: status
description:
type: string
maxLength: 200
description: "Transaction Status Description \n- SETTLED - Transaction settled"
example: Transaction settled
title: description
Paypal-Update:
title: paypal Update
type: object
description: '
- For PAYPAL Pay operation method.paypal parameter is mandatory when method.type parameter is selected as PAYPAL'
properties:
browser_payment_operation:
description: The operation values for browser payments
enum:
- CONFIRM
example: CONFIRM
type: string
title: browser_payment_operation
Aggregated-Fare:
title: aggregated
properties:
type:
description: "Provide the transport mode used by the payer for the first trip when fare collection is aggregated across one or more trips as well as for merchant-initiated debt recovery transactions. \n- DEBT_RECOVERY_MERCHANT_INITIATED Transaction for a debt recovery for an known transit fare initiated by Merchant (according to the scheme rules). \n- DEBT_RECOVERY_PAYER_INITIATED Transaction for a debt recovery for an known transit fare initiated by payer (according to the scheme rules). \n- DEBT_RECOVERY_TAP_INITIATED Transaction for a debt recovery for an known transit fare tap initiated (according to the scheme rules). \n- FARE_DEFERRED_AUTHORIZATION Known transit fare payment where you are submitting the Authorization after the payer has already gained access to the transit service (deferred Authorization). \n- FARE_REAL_TIME_AUTHORIZATION Known transit fare payment where you are submitting the Authorization at the time of travel."
enum:
- DEBT_RECOVERY_MERCHANT_INITIATED
- DEBT_RECOVERY_PAYER_INITIATED
- DEBT_RECOVERY_TAP_INITIATED
- FARE_DEFERRED_AUTHORIZATION
- FARE_REAL_TIME_AUTHORIZATION
example: DEBT_RECOVERY_TAP_INITIATED
type: string
title: type
transportation_mode:
description: Indicates if this is a transaction for an aggregated transit fare or a merchant-initiated, tap-initiated or payer-initiated debt recovery for an aggregated transit fare.
enum:
- CABLE_CAR
- COACH
- COMMUTER_TRAIN
- EXPRESS_COMMUTER_TRAIN
- FUNICULAR_TRAIN
- HIGH_SPEED_TRAIN
- INTERURBAN_BUS
- INTER_CITY
- LIGHT_TRAIN_MASS_TRANSIT
- LOCOMOTIVE
- OTHER
- PARA_TRANSIT
- PARKING
- POWERED_MOTOR_VEHICLE
- REGIONAL_TRAIN
- RURAL_BUS
- SELF_DRIVE_VEHICLE
- TAXI
- TOLL
- TRAILER
- TRAIN
- URBAN_BUS
- WATER_BORNE_VEHICLE
example: COMMUTER_TRAIN
type: string
title: transportation_mode
start_date:
description: This is the start date of an aggregation and matches the date of the first travel or first tap within the aggregation period.
example: '2024-03-07'
format: date
type: string
title: start_date
Rfp-Notification:
type: object
title: Payment RFP Notification
required:
- method
- transaction
- merchant
properties:
method:
$ref: '#/components/schemas/Rfp-Method-Notification'
transaction:
$ref: '#/components/schemas/Rfp-Transaction-Notification'
customer:
$ref: '#/components/schemas/Rfp-Customer-Notification'
merchant:
$ref: '#/components/schemas/Rfp-Merchant-Notification'
sender:
$ref: '#/components/schemas/Rfp-Sender-Notification'
receiver:
$ref: '#/components/schemas/Rfp-Receiver-Notification'
response_rfp:
$ref: '#/components/schemas/Rfp-Response-Rfp-Notification'
mandate:
$ref: '#/components/schemas/Rfp-Mandate-Notification'
Alipay:
title: alipay
type: object
description: '
- For ALIPAY Pay operation method.alipay parameter is mandatory when method.type parameter selected as ALIPAY'
properties:
payer_code:
description: The end customer's bank account number (e.g. IBAN).
example: DE1245678945123
maxLength: 255
minLength: 1
type: string
title: payer_code
Product-Info:
title: Product-Info
type: object
description: Product related information
properties:
id:
description: Product ID
example: PAYEMNTFORGOODS
maxLength: 128
minLength: 1
type: string
title: id
name:
description: "Product Name \n - For UK PAYBYBANK creation, product_info.name parameter is mandatory, if product_info object is selected"
example: GOODS
maxLength: 128
minLength: 1
type: string
title: name
quantity:
description: "Product Quantity \n - For UK PAYBYBANK creation, product_info.quantity parameter is mandatory, if product_info object is selected"
example: 200
maximum: 1000000
minimum: 1
type: number
title: quantity
amount:
description: "Product amount \n - For UK PAYBYBANK creation, product_info.amount parameter is mandatory, if product_info object is selected"
example: 200
maximum: 1000000000000000000
minimum: 0.01
type: number
title: amount
description:
description: Description of the product
example: GOODS
maxLength: 300
minLength: 1
type: string
title: description
Purpose:
description: Purpose of a payment
type: string
minLength: 1
maxLength: 35
example: SALARY PAYMENT
title: purpose
Acquirer-Request:
title: acquirer
description: acquirer
properties:
transaction_id:
description: Identifier used by the acquirer to identify the transaction. This identifier may be used by the acquirer in settlement reports.
example: ACQ7894561
maxLength: 100
minLength: 1
type: string
title: transaction_id
Merchant:
type: object
title: merchant
properties:
tax_id:
maxLength: 128
minLength: 1
type: string
description: "Merchant's payee identification (e.g., email address) \n - For Brazil QR creation merchant.tax_id parameter is mandatory, allowed maxlength is 77 \n- For Brazil PIX Initiation, this parameter is mandatory, individual person tax identification (CPF) allowed length = 11 or business entity tax identification (CNPJ) allowed length = 14"
example: 1.020.340/8910-22
title: tax_id
additional_info:
type: array
items:
$ref: '#/components/schemas/Additional-Info'
account:
title: merchant account
description: Account Details
properties:
number:
maxLength: 40
minLength: 1
type: string
description: "Merchant's bank account \n- For US RFP this parameter is mandatory with max length 40 \n- For US ACH Direct Debit, merchant.account.number is mandatory parameter with max length 17 and allowed value is Virtual account number\n- For Brazil PIX Initiation, this parameter is mandatory with min & max length 10"
example: '1122334455'
title: number
bank_id:
maxLength: 35
minLength: 1
type: string
description: "Merchant bank's network identification \n- For US RFP this parameter is mandatory with max length 16 \n- For US ACH Direct Debit, merchant.account.bank_id is mandatory with max length 9"
example: CITIIN77
title: bank_id
bank_name:
maxLength: 35
minLength: 1
type: string
description: "Merchant's bank name \n- For US ACH Direct Debit, merchant.account.bank_name parameter is mandatory with max length 35"
example: CITI
title: bank_name
bank_country_code:
type: string
pattern: ^[A-Z]{2,2}$
description: "Country code of the bank where merchant is maintaining the account \n- For US ACH Direct Debit, merchant.account.bank_country parameter is mandatory"
example: US
title: bank_country_code
name:
maxLength: 70
minLength: 1
type: string
description: "Merchant's Account Name \n- Mandatory for US RFP "
title: name
name:
maxLength: 140
minLength: 1
type: string
description: "Merchant Name \n- For US RFP this parameter is mandatory with max length 140 \n- For US ACH Direct Debit, merchant.name parameter is mandatory with max length 16"
title: name
address:
$ref: '#/components/schemas/Address'
organization_id:
description: "Merchant Organization Id/ Legal Entity as provided at the time of payment request.\n- For US RFP max length is 20 \n- For US ACH Direct Debit, merchant.organization_id (organization's tax id) parameter is optional with max length 10"
example: ORG123456
maxLength: 35
minLength: 1
type: string
title: organization_id
birth_date:
type: string
format: date
description: "ISO 8601 (YYYY-MM-DD), Merchant's birth_date \n- This parameter is optional only for US RFP"
title: birth_date
birth_city:
maxLength: 35
minLength: 1
type: string
description: "Merchant's birth_city \n- For US RFP max length is 35"
title: birth_city
birth_country:
type: string
description: "Merchant's birth_country \n- This parameter is optional only for US RFP"
pattern: ^[A-Z]{2,2}$
title: birth_country
phone_number:
type: string
description: "Merchant's phone number \n- For US RFP transaction, this parameter is optional"
pattern: \+[0-9]{1,3}-[0-9()+\-]{1,30}
title: phone_number
additionalProperties: false
Payment-Notification:
type: object
title: Payment Notification
properties:
customer:
type: object
title: Customer
properties:
id:
description: Merchant internal customer ID.
example: 1234abcjki
maxLength: 40
minLength: 1
type: string
title: id
name:
$ref: '#/components/schemas/Name'
tax_id:
description: "Customer's payer identification (e.g., email address) \n- For Brazil PIX Initiation, this parameter is mandatory, individual person tax identification (CPF) allowed length = 11 or business entity tax identification (CNPJ) allowed length = 14"
example: 234.453.678-21
maxLength: 100
minLength: 1
type: string
title: tax_id
email:
description: "Customer email \n - For UK PAYBYBANK creation, customer.email parameter is mandatory."
example: customer.raj2024@gmail.com
type: string
pattern: '[a-z0-9._%+-]+@[a-z0-9.-]+\.[a-z]{2,4}$'
title: email
phone:
description: Customer phone.
example: '+919962125789'
pattern: \+[0-9]{1,3}[-\ ][0-9()+\-]{1,30}
type: string
title: phone
device:
$ref: '#/components/schemas/Customer-Device'
address:
$ref: '#/components/schemas/Address'
authentication:
title: ' Authentication Sub Response'
required:
- channel
- method_completed
- method_supported
- requestor_id
- requestor_name
- accept_versions
- version
properties:
acs_eci:
description: Electronic Commerce Indicator (ECI) value provided by the issuer's ACS.
example: '56'
maxLength: 2
minLength: 1
type: string
title: acs_eci
token:
description: The base64 encoded value generated by the issuer (CAVV/AAV/AEVV/Authentication Value).
example: '56'
maxLength: 32
minLength: 28
type: string
title: token
3ds_transaction_id:
description: A unique identifier for the 3-D Secure authentication transaction (XID for v1, DS ID for v2).
example: '56'
maxLength: 50
minLength: 1
type: string
title: 3ds_transaction_id
server_transaction_id:
description: Unique identifier assigned by the 3DS Server (threeDSServerTransID).
example: '56'
maxLength: 50
minLength: 1
type: string
title: server_transaction_id
acs_transaction_id:
description: A unique transaction identifier assigned by the Access Control Server (ACS).
example: '56'
maxLength: 36
minLength: 36
type: string
title: acs_transaction_id
scheme:
description: The EMV 3DS authentication scheme used (e.g., MADA, MASTERCARD, VISA) for externally authenticated transactions.
example: CART123456
maxLength: 50
minLength: 2
type: string
title: scheme
custom:
description: Additional information returned by the scheme or issuer in the authentication response.
example: '56'
maxLength: 4000
minLength: 1
type: string
title: custom
directory_server_id:
description: Unique identifier for the Directory Server (RID) for in-app authentication.
example: CART123456
maxLength: 10
minLength: 10
type: string
title: directory_server_id
directory_server_reference:
description: Reference number assigned to the Directory Server (DS) by EMV Co.
example: '56'
maxLength: 32
minLength: 1
type: string
title: directory_server_reference
directory_transaction_id:
description: A unique transaction identifier assigned by the scheme Directory Server.
example: '56'
maxLength: 50
minLength: 1
type: string
title: directory_transaction_id
method_completed:
description: Indicates if the issuer's ACS completed the method call to obtain browser info.
type: boolean
example: true
title: method_completed
method_supported:
description: Indicates if the issuer's ACS supports the method call protocol.
enum:
- NOT_SUPPORTED
- SUPPORTED
example: NOT_SUPPORTED
type: string
title: method_supported
protocol_version:
description: The version of the EMV 3-D Secure protocol used (e.g., 2.1.0).
example: CART123456
maxLength: 20
minLength: 1
type: string
title: protocol_version
requestor_id:
description: The unique identifier assigned to the merchant by the card scheme directory server for 3DS2.
example: CART123456
maxLength: 20
minLength: 1
type: string
title: requestor_id
requestor_name:
description: The unique name assigned to the merchant by the card scheme directory server for 3DS2.
example: CART123456
maxLength: 40
minLength: 1
type: string
title: requestor_name
accept_versions:
type: array
items:
type: string
description: A comma separated list of the forms of payer authentication that you will accept.
title: accept_versions
channel:
description: Indicates the channel in which the authentication request is initiated.
enum:
- MERCHANT_REQUESTED
- PAYER_APP
- PAYER_BROWSER
example: MERCHANT_REQUESTED
type: string
title: channel
method:
description: The method that the issuer will use to authenticate the payer.
enum:
- DYNAMIC
- OUT_OF_BAND
- STATIC
example: STATIC
type: string
title: method
purpose:
description: Indicates the context in which payer authentication is requested.
enum:
- ADD_CARD
- AGREEMENT_CANCELLATION
- MAINTAIN_CARD
- PAYMENT_TRANSACTION
- REFRESH_AUTHENTICATION
example: ADD_CARD
type: string
title: purpose
method_post_data:
description: Base64 URL encoded frame contents to be posted to the method URL for risk assessment.
example: https://greenzone-api.uat.nam.nsroot.net/api/notification
maxLength: 100
minLength: 1
type: string
title: method_post_data
method_url:
type: string
maxLength: 500
minLength: 1
description: The URL provided by the issuer to which the method post data must be sent.
example: https://greenzone-api.uat.nam.nsroot.net/api/notification
title: method_url
redirect_html:
type: string
maxLength: 40960
minLength: 1
description: The URL provided by the issuer to which the method post data must be sent.
example: https://greenzone-api.uat.nam.nsroot.net/api/notification
title: redirect_html
version:
description: Indicates the available payer authentication method or NONE if unavailable.
enum:
- 3DS2
- RUPAY
- PASSKEY
- NONE
example: RUPAY
type: string
title: version
line_of_business:
description: Identifier for different lines of business configured in the merchant profile.
example: CART123456
maxLength: 100
minLength: 1
type: string
title: line_of_business
sdk:
$ref: '#/components/schemas/Sdk-Payer-Authentication-Response'
status_reason_code:
description: A code indicating the reason for the transaction status (EMVCo specification).
example: '56'
maxLength: 2
minLength: 2
type: string
title: status_reason_code
status:
description: Indicates the result of payer authentication with the issuer (e.g., Y, N, U, A, R).
example: Y
maxLength: 1
minLength: 1
type: string
title: status
acs_reference:
description: Reference number assigned to the issuer's ACS by EMV Co.
example: AFT123456
maxLength: 32
minLength: 1
type: string
title: acs_reference
amount:
description: Transaction amount
example: 200
maximum: 1000000000000000000
minimum: 0.01
type: number
title: amount
payer_interaction:
description: Indicates if payer interaction was used to complete the authentication process.
enum:
- NOT_POSSIBLE
- NOT_REQUIRED
- REQUIRED
example: NOT_REQUIRED
type: string
title: payer_interaction
payment_exemption:
description: Indicates why this payment qualifies for an SCA exemption.
enum:
- AUTO
- LOW_RISK
- LOW_VALUE_PAYMENT
- TRUSTED_MERCHANT
- MERCHANT_INITIATED_TRANSACTION
- RECURRING_PAYMENT
- SECURE_CORPORATE_PAYMENT
example: TRUSTED_MERCHANT
type: string
title: payment_exemption
trusted_merchant_status:
description: Indicates if the payer has added you to their list of trusted merchants for this card.
enum:
- NOT_ON_LIST
- ON_LIST
example: ON_LIST
type: string
title: trusted_merchant_status
redirect_domain_name:
type: string
maxLength: 253
minLength: 1
description: The domain name of the site where payer authentication was performed (e.g., ACS domain name).
example: https://greenzone-api.uat.nam.nsroot.net/api/notification
title: redirect_domain_name
status_code:
type: string
maxLength: 100
minLength: 1
description: Indicates the status of payer authentication with the issuer (e.g., NPCI BEPG status code).
example: '500'
title: status_code
status_description:
type: string
maxLength: 1024
minLength: 1
description: Indicates the status of payer authentication with the issuer (e.g., NPCI BEPG status code).
example: '500'
title: status_description
time:
type: string
format: date-time
description: Date and time of the payer authentication being performed (YYYY-MM-DDThh:mm:ss.SSSZ).
example: '2022-09-13T08:23:49.114Z'
title: time
transaction_id:
description: Identifier used by the acquirer to identify the transaction. This identifier may be used by the acquirer in settlement reports.
example: ACQ7894561
maxLength: 100
minLength: 1
type: string
title: transaction_id
transaction:
type: object
title: PN_transaction
properties:
id:
description: "Unique Transaction identification provided by the merchant during transaction creation \n- transaction.id parameter is mandatory for all transaction type creation \n- For Brazil QR Creation transaction.reference parameter should be of length between 26 to 35 and allowed datatype is Alphanumeric and should not be filled with spaces or zeroes \n- For CARD Authorize operation transaction.id parameter is mandatory \n- For CARD Capture operation transaction.id parameter is mandatory \n- For CARD Pay operation transaction.id parameter is mandatory \n- For CARD Verify operation transaction.id parameter is mandatory \n- For ACH Pay and Verify transaction, transaction.id parameter is mandatory"
example: pay02052023456r
maxLength: 128
minLength: 1
type: string
title: id
amount:
description: "Transaction amount \n - For Brazil QR Creation decimal values are mandatory for transaction.amount and it must have 2 digits \n - For Brazil QR Creation maxmium amount limit is 9999999999.99 and transaction.amount parameter is mandatory\n- For CARD Authorize operation transaction.amount parameter is mandatory \n- For CARD Capture operation transaction.amount parameter is mandatory \n- For CARD Pay operation transaction.amount parameter is mandatory \n- For CARD Verify operation transaction.amount parameter is mandatory \n- For ACH Pay and Verify transaction, transaction.amount parameter is mandatory \n- For Brazil PIX cancellation, this parameter is mandatory with 18 digits including 2 decimals."
example: 200
maximum: 1000000000000000000
minimum: 0.01
type: number
title: amount
country_code:
description: Country code
enum:
- US
- BR
- GB
- IN
- TH
- AU
- CA
- MX
- DE
- NL
- IE
- IT
- FR
- ES
- HK
- SG
- NZ
- DK
- 'NO'
- SE
- SW
- BE
- FI
- CH
- CZ
- AT
- PT
example: BR
type: string
title: country_code
currency_code:
description: "ISO 4217 Currency Code for instance USD/GBP/EUR \n- transaction.currency_code parameter is mandatory for all transaction type creation"
enum:
- BRL
- USD
- GBP
- INR
- EUR
- CAD
- HKD
- AUD
- SGD
- DKK
- NOK
- SEK
- PLN
- IDR
- MYR
- THB
- CHF
- PHP
- CZK
example: BRL
type: string
title: currency_code
product_info:
type: array
items:
$ref: '#/components/schemas/Product-Info'
expiry_time:
description: Expiration time for QR collection, specified in seconds.
example: 3600
format: int32
minimum: 10
type: integer
title: expiry_time
status:
type: string
maxLength: 20
description: "Transaction Status, following status you will receive in response \n- CREATED - The transaction has successfully been created \n- PENDING - Transaction pending action from customer \n- AUTHORIZED - Authorization approved \n- CAPTURED - Transaction fully captured \n- CAPTURED_PARTIALLY - Transaction partially captured \n- CANCELLED - Transaction cancelled \n- DECLINED - Transaction declined by the payment processor \n- REJECTED - Request rejected after business logic check \n- SYSTEM_ERROR- Internal system error occurred processing the transaction \n- FAILED - Transaction failed for invalid payload \n- SETTLED - Transaction settled \n- SUCCESS - The operation was successfully processed \n- UNKNOWN - The result of the operation is unknown"
example: SUCCESS
title: status
description:
type: string
maxLength: 256
description: "Transaction Status, following status you will receive in response \n- CREATED - The transaction has successfully been created \n- PENDING - Transaction pending action from customer \n- AUTHORIZED - Authorization approved \n- CAPTURED - Transaction fully captured \n- CAPTURED_PARTIALLY - Transaction partially captured \n- CANCELLED - Transaction cancelled \n- DECLINED - Transaction declined by the payment processor \n- REJECTED - Request rejected after business logic check \n- SYSTEM_ERROR- Internal system error occurred processing the transaction \n- FAILED - Transaction failed for invalid payload \n- SETTLED - Transaction settled \n- SUCCESS - The operation was successfully processed \n- UNKNOWN - The result of the operation is unknown"
example: Transaction declined by the payment processor
title: description
redirect_url:
type: string
maxLength: 500
description: The URL to which you must redirect the payer's browser to complete the payment when using the payment provider's website.
example: https://greenzone-api.uat.nam.nsroot.net/api/notification
title: redirect_url
creation_date_time:
type: string
format: date-time
description: "GMT (ISO 8601 YYYY-MM-DDTHH:MM:SS.sssZ) \n- Instant Payment (Debit) - Date time, generated by CitiConnect API, when CitiConnect API accepted a payment initiation after validation \n- Instant Payment (Credit) - Date time, either provided by the debtor bank or generated by Citi's transaction processing application, when a transaction was created \n- For ACH PAY and Verify transaction, order.creation_date_time parameter is mandatory \n- For Brazil PIX, this parameter is mandatory"
example: '2022-09-13T08:23:49.114Z'
title: creation_date_time
update_time:
type: string
format: date-time
description: "Indicates the date and time the gateway considers the order to have last been updated GMT (ISO 8601 YYYY-MM-DDTHH:MM:SS.sssZ) \n- Instant Payment (Debit) - Date time, generated by CitiConnect API, when CitiConnect API accepted a payment initiation after validation \n- Instant Payment (Credit) - Date time, either provided by the debtor bank or generated by Citi's transaction processing application, when a transaction was created \n- For ACH PAY and Verify transaction, order.update_time parameter is mandatory"
example: '2022-09-13T08:23:49.114Z'
title: update_time
psp_reference:
type: string
maxLength: 36
minLength: 1
description: "Payment session id generated by Banked (third party system). Will be present in case of link creation being successful \n - For UK PAYBYBANK Creation payment_session_field parameter is mandatory for success link creation."
example: PAY1234567
title: psp_reference
type:
description: Indicates the type of action performed on the order.
enum:
- AUTHENTICATION
- AUTHORIZATION
- AUTHORIZATION_UPDATE
- CAPTURE
- CHARGEBACK
- DISBURSEMENT
- FUNDING
- PAYMENT
- REFUND
- REFUND_REQUEST
- VERIFICATION
- VOID_AUTHORIZATION
- VOID_CAPTURE
- VOID_PAYMENT
- VOID_REFUND
example: VERIFICATION
type: string
title: type
reference:
description: An optional identifier for this transaction
example: REPAY789541
maxLength: 250
minLength: 1
type: string
title: reference
authorization_code:
description: Value generated by the issuing bank in response to a proposal to transfer funds
example: AUTH123456
maxLength: 100
minLength: 1
type: string
title: authorization_code
acquirer:
$ref: '#/components/schemas/Acquirer-Request'
terminal:
description: Identifier used by the acquirer to identify the transaction. This identifier may be used by the acquirer in settlement reports.
example: ACQ7894561
maxLength: 16
minLength: 1
type: string
title: terminal
retrieval_reference_number:
description: When a transaction registration succeeds, the value of this parameter contains the 44-digit number that was used to create the bar code on the Boleto slip. This bar code can then be scanned by the vendor if a payer elects to pay Boleto at a registered location.
example: ACQ7894561
maxLength: 100
minLength: 1
type: string
title: retrieval_reference_number
reason_code:
description: "Transaction rejection Code \n- For Brazil PIX, this parameter is mandatory with max length 4, expected values are ACCT, BLCK, CCLD, FAIL, OTHR, SLBD & SLCR"
example: SC0020
maxLength: 10
minLength: 1
type: string
title: reason_code
authorization_response:
$ref: '#/components/schemas/Authorization-Response'
response:
$ref: '#/components/schemas/Response'
receipt:
description: When a transaction registration succeeds, the value of this parameter contains the 44-digit number that was used to create the bar code on the Boleto slip. This bar code can then be scanned by the vendor if a payer elects to pay Boleto at a registered location.
example: MSG12345
maxLength: 100
minLength: 1
type: string
title: receipt
additional_response_data:
description: A 47-digit number the payer can use to make a Boleto payment.When a transaction registration succeeds, the value of this parameter contains the 44-digit number that was used to create the bar code on the Boleto slip. This bar code can then be scanned by the vendor if a payer elects to pay Boleto at a registered location.If the transaction registration fails, this parameter contains an error code and a description in key-value pair format.
example: MSG12345
maxLength: 4000
minLength: 1
type: string
title: additional_response_data
status_date_time:
format: date-time
type: string
description: "Date & Time when Payer bank provided their response GMT (ISO 8601 YYYY-MM-DDTHH:MM:SS.sssZ) \n- This parameter is mandatory for Brazil PIX"
example: '2022-09-13T08:23:49.114Z'
title: status_date_time
method:
type: object
title: Payment Notification Method
properties:
card:
$ref: '#/components/schemas/Card-Response'
paypal:
$ref: '#/components/schemas/Paypal-Response'
type:
description: "Method specified by the customer for the transaction \n- For Brazil PIX, this is mandatory parameter with the allowed value PIX"
type: string
enum:
- PIX
- CARD
- BOLETO
- ALIPAY
- GOOGLEPAY
- APPLEPAY
- ACH
- FPS
- RTP
- PAYPAL
- AFTERPAY
- AMAZON_PAY
- BITPAY
- BIZUM
- TRUSTLY
- BLIK
- BLIK_BNPL
- CASH_APP
- DOKU_WALLET
- EPS
- ESTONIAN_BANKS
- VERKKOPANKKI
- FLOAPAY
- FPX
- GOPAY
- IDEAL
- INDOMARET
- INDONESIAN_BANKS
- JENIUS_PAY
- KREDIVO
- LATVIAN_BANKS
- LINK_AJA
- LITHUANIAN_BANKS
- MBWAY
- MULTIBANCO
- OVO_WALLET
- PAYSAFECARD
- P24
- SATISPAY
- SCALAPAY
- SKRILL
- SWISH
- THAIBANKS
- TWINT
- WERO
- ZIP
- BANCOMATPAY
- DRAGONPAY
- MYBANK
- ALFAMART
- PAYU
- BANCONTACT
- STABLECOINS
- OXXO_PAY
example: PIX
title: type
token_id:
description: "Token_number. \n- For India card transaction, method.card.token_number parameter is mandatory when token number is provided and allowed maximum length is 50."
example: PA123456789
maxLength: 50
minLength: 1
type: string
title: token_number
session_id:
description: Session identification number
type: string
minLength: 36
maxLength: 37
example: SES1234567890123456789012345678
title: session_id
order:
type: object
title: Payment-Notification Order
properties:
id:
description: "A unique identifier for this order to distinguish it from any other order you create. \n- For CARD Authorize, Capture, Pay and Verify operation order.id parameter is mandatory \n- For ACH Pay and Verify transaction order.id parameter is mandatory"
example: OR123456789
maxLength: 40
minLength: 1
type: string
title: id
amount:
description: "The total amount for the order \n- For CARD Authorize operation order.amount parameter is mandatory \n- For CARD Capture operation order.amount parameter is mandatory \n- For CARD Pay operation order.amount parameter is mandatory \n- For CARD Verify operation order.amount parameter is mandatory and allowed maximum amount is 2 \n- For ACH PAY and Verify transaction, order.amount parameter is mandatory"
example: 200
maximum: 1000000000000000000
minimum: 0.01
type: number
title: amount
creation_date_time:
type: string
format: date-time
description: "GMT (ISO 8601 YYYY-MM-DDTHH:MM:SS.sssZ) \n- Instant Payment (Debit) - Date time, generated by CitiConnect API, when CitiConnect API accepted a payment initiation after validation \n- Instant Payment (Credit) - Date time, either provided by the debtor bank or generated by Citi's transaction processing application, when a transaction was created \n- For ACH PAY and Verify transaction, order.creation_date_time parameter is mandatory"
example: '2022-09-13T08:23:49.114Z'
title: creation_date_time
update_time:
type: string
format: date-time
description: "Indicates the date and time the gateway considers the order to have last been updated GMT (ISO 8601 YYYY-MM-DDTHH:MM:SS.sssZ) \n- Instant Payment (Debit) - Date time, generated by CitiConnect API, when CitiConnect API accepted a payment initiation after validation \n- Instant Payment (Credit) - Date time, either provided by the debtor bank or generated by Citi's transaction processing application, when a transaction was created \n- For ACH PAY and Verify transaction, order.last_update_time parameter is mandatory"
example: '2022-09-13T08:23:49.114Z'
title: update_time
reference:
description: An optional identifier for the orderFor example, a shopping cart number, an order number, or an invoice number.
example: REPAY789541
maxLength: 200
minLength: 1
type: string
title: reference
invoice_number:
description: The invoice number you issued for this order
example: INV789541
maxLength: 25
minLength: 1
type: string
title: invoice_number
currency_code:
description: "ISO 4217 Currency Code for instance USD/GBP/EUR \n- order.currency_code parameter is mandatory for all transaction type creation"
enum:
- BRL
- USD
- GBP
- INR
- EUR
- CAD
- HKD
- AUD
- SGD
- DKK
- NOK
- SEK
- PLN
- IDR
- MYR
- THB
- CHF
- PHP
- CZK
example: BRL
type: string
title: currency_code
merchant_amount:
description: "The total amount for the order in order.merchantCurrency units. \n- For CARD Authorize operation order.merchant_amount parameter is mandatory \n- For CARD Capture operation order.merchant_amount parameter is mandatory \n- For CARD Pay operation order.merchant_amount parameter is mandatory \n- For CARD Verify operation order.merchant_amount parameter is mandatory"
example: 200
maximum: 1000000000000000000
minimum: 0.01
type: number
title: merchant_amount
merchant_currency:
description: " The currency in which you priced your inventory for this order, expressed as an ISO 4217 alpha codeISO 4217 Currency Code for instance USD/GBP/EUR \n- order.merchant_currency parameter is mandatory for all transaction type creation"
enum:
- BRL
- USD
- INR
example: BRL
type: string
title: merchant_currency
status:
type: string
maxLength: 30
description: "Order Status, following status you will receive in response \n- AUTHENTICATED - The payer was successfully authenticated. \n- AUTHENTICATION_INITIATED - Payer authentication has been initiated but not completed. \n- AUTHENTICATION_NOT_NEEDED - Payer authentication was not performed as it was not needed. \n- AUTHENTICATION_UNSUCCESSFUL - Payer authentication was not able to be successfully completed. \n- AUTHORIZED - The payment has been authorized successfully but the authorized amount has not yet been captured, in part, full, or excess. \n- CANCELLED - The initial transaction for this order has been voided successfully. \n- CAPTURED - The authorized amount for this order, in full or excess, has been captured successfully. \n- CHARGEBACK_PROCESSED - A Chargeback has been processed against this order. \n- DISPUTED - The payment has been disputed and is under investigation. A request for information has been received or a chargeback is pending. \n- EXCESSIVELY_REFUNDED - The payment has been captured in part, full, or excess, but the captured amount in excess has been refunded successfully. \n- FAILED - The payment has not been successful. \n- FUNDING - The order transfers money to or from the merchant, without the involvement of a payer. For example, recording monthly merchant service fees from the payment service provider. \n- INITIATED - A browser payment that has successfully been initiated for this order. No payment has yet been made. \n- PARTIALLY_CAPTURED - The authorized amount for this order, in part, has been captured successfully. \n- PARTIALLY_REFUNDED - The payment has been captured in part, full, or excess, but the captured amount in part has been refunded successfully. \n- REFUNDED - The payment has been captured in part, full, or excess, but the captured amount in full has been refunded successfully. \n- REFUND_REQUESTED - A refund against captured amounts on this order has been requested but not executed. Requires further action to approve the refund. \n- VERIFIED - The card details for this order have successfully been verified. No payment has yet been initiated or made. \n- DISBURSED - The order amount has successfully been disbursed to the payer."
example: AUTHENTICATED
title: status
total_auth_amount:
description: "The amount that has been successfully authorized for this order. \n- For CARD Authorize operation order.total_auth_amount parameter is mandatory \n- For CARD Capture operation order.total_auth_amount parameter is mandatory \n- For CARD Pay operation order.total_auth_amount parameter is mandatory \n- For CARD Verify operation order.total_auth_amount parameter is mandatory"
example: 200
maximum: 1000000000000000000
minimum: 0.01
type: number
title: total_auth_amount
total_captured_amount:
description: "The amount that has been successfully captured for this order. \n- For CARD Authorize operation order.total_captured_amount parameter is mandatory \n- For CARD Capture operation order.total_captured_amount parameter is mandatory \n- For CARD Pay operation order.total_captured_amount parameter is mandatory \n- For CARD Verify operation order.total_captured_amount parameter is mandatory"
example: 200
maximum: 1000000000000000000
minimum: 0.01
type: number
title: total_captured_amount
total_disbursed_amount:
description: "The amount that has been successfully captured for this order. \n- For CARD Authorize operation order.total_disbursed_amount parameter is mandatory \n- For CARD Capture operation order.total_disbursed_amount parameter is mandatory \n- For CARD Pay operation order.total_disbursed_amount parameter is mandatory \n- For CARD Verify operation order.total_disbursed_amount parameter is mandatory"
example: 200
maximum: 1000000000000000000
minimum: 0.01
type: number
title: total_disbursed_amount
total_refunded_amount:
description: "The amount that has been successfully captured for this order. \n- For CARD Authorize operation order.total_refunded_amount parameter is mandatory \n- For CARD Capture operation order.total_refunded_amount parameter is mandatory \n- For CARD Pay operation order.total_refunded_amount parameter is mandatory \n- For CARD Verify operation order.total_refunded_amount parameter is mandatory"
example: 200
maximum: 1000000000000000000
minimum: 0.01
type: number
title: total_refunded_amount
item_amount:
description: The total item amount for the order.If you do not provide this value but provide line item data, then this amount is calculated as the sum of the item.quantity times the item.unitPrice for all the line items (total item amount).If you provide both this value and line item data, then the order.itemAmount MUST equal the total item amount.
example: '100.00'
maxLength: 14
minLength: 1
type: string
title: item_amount
merchant:
type: object
title: Payment-Notification Merchant
properties:
account:
title: merchant account
description: Account Details
properties:
bank_id:
maxLength: 35
minLength: 1
type: string
description: "Customer bank's network identification \n- For Brazil PIX, this parameter is mandatory with max length 8"
example: CITIIN77
title: bank_id
mandate:
type: object
title: Payment-Notification Mandate
properties:
id:
description: "Unique Id given during initiation to identify the mandate \n- This parameter is mandatory for Brazil with max length 29"
minLength: 1
maxLength: 35
type: string
example: RR3347902320251109REF12345678
title: id
shipping:
$ref: '#/components/schemas/Shipping'
Rfp-Transaction-Notification:
type: object
title: RFP Transaction Notification
required:
- status
- description
- uetr
properties:
id:
description: "Unique Transaction identification provided by the merchant during transaction creation \n- For US RFP this parameter is mandatory with max length 35 \n- For Brazil PIX, this is mandatory parameter with min length 26 & max length 35"
example: pay02052023456r
maxLength: 128
minLength: 1
type: string
title: id
uetr:
type: string
pattern: ^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][a-f0-9]{3}-[a-f0-9]{12}$
description: "UUID v4 format unique end-to-end transaction reference \n- This parameter is madnatory for US RFP \n- For Brazil PIX, this is mandatory parameter"
example: 4f09214d-296c-494b-8e9c-810bf1d9fc93
title: uetr
creation_date_time:
type: string
format: date-time
description: "GMT (ISO 8601 YYYY-MM-DDTHH:MM:SS.sssZ) \n- Instant Payment (Debit) - Date time, generated by CitiConnect API, when CitiConnect API accepted a payment initiation after validation \n- Instant Payment (Credit) - Date time, either provided by the customer bank or generated by Citi's transaction processing application, when a transaction was created \n- For Brazil PIX, this is mandatory parameter"
title: creation_date_time
value_date:
type: string
format: date
description: "Value Date Format is YYYY-MM-DD. \n- For US RFP this parameter is mandatory"
title: value_date
expiry_date:
type: string
format: date
description: "Expiry Date Format is YYYY-MM-DD \n- For US RFP this parameter is mandatory"
title: expiry_date
update_flag:
description: "Indicator if the exact amount indicated in amount must be paid, or if under/over payment is permitted.\n- For QR Creation (ex. Brazil), during transaction processing if the merchant want to allow his client to change QR Amount then the value should be Y otherwise default value will be N \n- For US RFP, if Y then Amount may be modified by the customer, if N then Amount of payment must equal the Instructed Amount.If no value passed, default behavior is same as Y"
enum:
- Y
- N
example: Y
type: string
title: update_flag
amount:
description: "Transaction amount \n- For US RFP, this parameter is mandatory with maximum amount limit 1000000.00. \n- For Brazil PIX initiation, this parameter is mandatory with 18 digits including 2 decimals. "
example: 200
maximum: 1000000000000000000
minimum: 0.01
type: number
title: amount
currency_code:
description: "ISO 4217 Currency Code for instance USD/GBP/EUR \n- transaction.currency_code parameter is mandatory for all transaction type creation"
enum:
- BRL
- USD
- GBP
example: BRL
type: string
title: currency_code
country_code:
description: "The order country \n- transaction.country_code parameter is mandatory for all transaction type creation"
enum:
- US
- BR
- GB
example: US
type: string
title: country_code
full_amount:
type: number
minimum: 0.01
maximum: 100000000000000000
description: "Amount that is the gross amount payable by client \n- For US RFP transaction, this parameter is optional"
title: full_amount
discount_amount:
type: number
minimum: 0.01
maximum: 100000000000000000
description: "Amount that is the discount from the gross amount \n- Optional for US RFP.If populated, message.transaction.full_amount must also be popluated."
title: discount_amount
purpose:
$ref: '#/components/schemas/Purpose'
remittance_info:
type: array
description: "Unstructured remittance information \n - For US RFP, transaction.remittance_info parameter is optional and only one(1) line of 140 characters is allowed. \n- For Brazil PIX initiation, this parameter is optional and only one(1) line of 140 characters is allowed."
items:
$ref: '#/components/schemas/Unstructured'
title: remittance_info
reference:
type: string
maxLength: 35
minLength: 1
description: "Reference Id \n- For US RFP, this parameter will contain the unique reference (instruction) id with max length 35"
title: reference
network_id:
type: string
maxLength: 35
minLength: 1
description: "Network ID \n- This parameter is mandatory for US RFP with max length 35"
title: network_id
network:
type: string
enum:
- RTP
- FDN
description: Financial market infrastructure or clearing system (e.g., RTP Network in the United States)
title: network
status:
type: string
maxLength: 20
description: "Transaction Status, following status you will receive in response \n- WAIT_CONFIRMATION - Transaction awaiting confirmation from user \n- PENDING_SETTLEMENT - Transaction accepted settlement in process \n- SETTLED - Transaction settled \n- FAILED - 'rejection code - rejection description' "
example: SETTLED
title: status
enum:
- WAIT_CONFIRMATION
- PENDING_SETTLEMENT
- SETTLED
- FAILED
description:
type: string
maxLength: 256
description: "Transaction Status, following status you will receive in response \n- WAIT_CONFIRMATION - Transaction awaiting confirmation from user \n- PENDING_SETTLEMENT - Transaction accepted settlement in process \n- SETTLED - Transaction settled \n- FAILED - 'rejection code - rejection description'"
title: description
reason_code:
maxLength: 10
minLength: 1
type: string
description: "Transaction reason code \n- For Brazil PIX this parameter is mandatory with max length 4"
example: AGND
title: reason_code
status_date_time:
format: date-time
type: string
description: "Date & Time when Payer bank provided their response GMT (ISO 8601 YYYY-MM-DDTHH:MM:SS.sssZ) \n- This parameter is mandatory for Brazil PIX"
example: '2022-09-13T08:23:49.114Z'
title: status_date_time
holiday_flag:
description: Specifies if a request should consider holiday
type: boolean
example: true
title: holiday_flag
Card-Response:
title: card
description: Card Method Response
properties:
number:
description: The account number of the payer's account used for the payment. On requests, provide the number in the form that you receive it (as explained below). On responses, the gateway populates it with a form that the payer would recognize.
example: PA123456789
maxLength: 23
minLength: 9
type: string
title: number
expiry_month:
description: Two-digit month in which the payment card expires.
example: '01'
type: string
pattern: ^(0?[1-9]|1[0-2])$
title: expiry_month
expiry_year:
description: Four-digit year in which the payment card expires.
type: string
pattern: ^[0-9]{2,2}$
example: '25'
title: expiry_year
encryption:
description: The encryption framework used for the payment details received by the gateway.
enum:
- DEVICE
- DIGITAL_WALLET
- DUKPT
example: DEVICE
type: string
title: encryption
funding_method:
description: Funding method.
example: '24'
maxLength: 50
minLength: 1
type: string
title: funding_method
scheme:
description: Card scheme details.
example: '24'
maxLength: 50
minLength: 1
type: string
title: scheme
issuer:
description: The issuer details.
example: '24'
maxLength: 50
minLength: 1
type: string
title: issuer
product_name:
description: The card product name.
example: '24'
maxLength: 50
minLength: 1
type: string
title: product_name
category:
description: The card category details.
example: '24'
maxLength: 50
minLength: 1
type: string
title: category
country_code:
description: The card issuer country code
pattern: ^[A-Z]{2,2}$
example: IN
type: string
title: country_code
device:
$ref: '#/components/schemas/Device-Response'
device_specific:
$ref: '#/components/schemas/Device-Specific-Response'
responses:
Gateway-Timeout:
description: Gateway Timeout
headers:
apim-guid:
$ref: '#/components/headers/Request-Id'
content:
application/json:
schema:
oneOf:
- $ref: '#/components/schemas/Gateway-Error-Response'
examples:
Gateway-Timeout-Gateway-Error-Example:
$ref: '#/components/examples/Gateway-Timeout-Gateway-Error-Example'
Unsupported-Media-Type:
description: Unsupported Media Type
headers:
apim-guid:
$ref: '#/components/headers/Request-Id'
content:
application/json:
schema:
oneOf:
- $ref: '#/components/schemas/Gateway-Error-Response'
- $ref: '#/components/schemas/Error-Response'
examples:
Unsupported-Media-Type-Service-Error-Example:
$ref: '#/components/examples/Unsupported-Media-Type-Example'
Unsupported-Media-Type-Gateway-Error-Example:
$ref: '#/components/examples/Un-Supported-Media-Type-Gateway-Error-Example'
Accepted:
description: Accepted
headers:
apim-guid:
$ref: '#/components/headers/Request-Id'
Merchant-Id:
schema:
type: string
description: The unique identifier issued to you by your payment provider
content:
application/json:
schema:
$ref: '#/components/schemas/Payment-Response'
Rate-Limit-Exceeded:
description: Rate Limit Exceeded
headers:
apim-guid:
$ref: '#/components/headers/Request-Id'
content:
application/json:
schema:
oneOf:
- $ref: '#/components/schemas/Gateway-Error-Response'
examples:
Rate-Limit-Exceeded-Gateway-Error-Example:
$ref: '#/components/examples/Rate-Limit-Exceeded-Gateway-Error-Example'
Not-Found:
description: Not Found
headers:
apim-guid:
$ref: '#/components/headers/Request-Id'
content:
application/json:
schema:
oneOf:
- $ref: '#/components/schemas/Gateway-Error-Response'
- $ref: '#/components/schemas/Error-Response'
examples:
Not-Found-Service-Error-Example:
$ref: '#/components/examples/Not-Found-Example'
Not-Found-Gateway-Error-Example:
$ref: '#/components/examples/Not-Found-Gateway-Error-Example'
Conflict:
description: Conflict
headers:
apim-guid:
$ref: '#/components/headers/Request-Id'
content:
application/json:
schema:
$ref: '#/components/schemas/Error-Response'
examples:
Idempotency-Id-Conflict-Example:
$ref: '#/components/examples/Idempotency-Id-Conflict-Example'
Internal-Server-Error:
description: Internal Server Error
headers:
apim-guid:
$ref: '#/components/headers/Request-Id'
content:
application/json:
schema:
oneOf:
- $ref: '#/components/schemas/Gateway-Error-Response'
- $ref: '#/components/schemas/Error-Response'
examples:
Internal-Server-Error-Example:
$ref: '#/components/examples/Internal-Server-Error-Example'
Internal-Server-Gateway-Error-Example:
$ref: '#/components/examples/Internal-Server-Gateway-Error-Example'
Method-Not-Allowed:
description: Method Not Allowed
headers:
apim-guid:
$ref: '#/components/headers/Request-Id'
content:
application/json:
schema:
oneOf:
- $ref: '#/components/schemas/Gateway-Error-Response'
- $ref: '#/components/schemas/Error-Response'
examples:
Method-Not-Allowed-Service-Error-Example:
$ref: '#/components/examples/Method-Not-Allowed-Example'
Method-Not-Allowed-Gateway-Error-Example:
$ref: '#/components/examples/Method-Not-Allowed-Gateway-Error-Example'
Bad-Request:
description: Bad Request
headers:
apim-guid:
$ref: '#/components/headers/Request-Id'
content:
application/json:
schema:
oneOf:
- $ref: '#/components/schemas/Gateway-Error-Response'
- $ref: '#/components/schemas/Error-Response'
examples:
Bad-Request-Service-Error-Example:
$ref: '#/components/examples/Bad-Request-Example'
Bad-Request-Gateway-Error-Example:
$ref: '#/components/examples/Bad-Request-Gateway-Error-Example'
Unauthorized:
description: Unauthorized
headers:
apim-guid:
$ref: '#/components/headers/Request-Id'
content:
application/json:
schema:
oneOf:
- $ref: '#/components/schemas/Gateway-Error-Response'
- $ref: '#/components/schemas/Error-Response'
examples:
Unauthorized-Service-Error-Example:
$ref: '#/components/examples/Unauthorized-Example'
Unauthorized-Gateway-Error-Example:
$ref: '#/components/examples/Unauthorized-Gateway-Error-Example'
Bad-Get-Request2:
description: Bad Get Request
headers:
apim-guid:
$ref: '#/components/headers/Request-Id'
content:
application/json:
schema:
$ref: '#/components/schemas/Error-Response'
examples:
Bad-Request-Example:
$ref: '#/components/examples/Bad-Request-Get2-Example'
Bad-Get-Request:
description: Bad Get Request
headers:
apim-guid:
$ref: '#/components/headers/Request-Id'
content:
application/json:
schema:
$ref: '#/components/schemas/Error-Response'
examples:
Bad-Request-Example:
$ref: '#/components/examples/Bad-Request-Get-Example'
callbacks:
Payment-Failed-Status-Notification:
/payment-qr-failed:
post:
parameters:
- $ref: '#/components/parameters/Apim-Guid'
- $ref: '#/components/parameters/Event-Type'
- $ref: '#/components/parameters/Event-Name'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/Payment-Qr-Failed'
examples:
Payment-Failed-Status-Notification:
$ref: '#/components/examples/Payment-Failed-Status-Notification'
responses:
'202':
description: Accepted
content:
application/json:
schema:
type: object
payment-Authorize-Success:
/payment-authorize-success:
post:
parameters:
- $ref: '#/components/parameters/Event-Type'
- $ref: '#/components/parameters/Event-Name'
- $ref: '#/components/parameters/Operation'
- $ref: '#/components/parameters/Reference-Id'
- $ref: '#/components/parameters/Merchant-Post-Id'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/Payment-Notification'
examples:
IndiaCardCapturePaymentResponse:
$ref: '#/components/examples/India-Card-Authorize-Payment-Response-Example'
responses:
'202':
description: Accepted
content:
application/json:
schema:
type: object
Payment-Capture-Success:
/payment-capture-success:
post:
parameters:
- $ref: '#/components/parameters/Event-Type'
- $ref: '#/components/parameters/Event-Name'
- $ref: '#/components/parameters/Operation'
- $ref: '#/components/parameters/Reference-Id'
- $ref: '#/components/parameters/Merchant-Post-Id'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/Payment-Notification'
examples:
IndiaCardCapturePaymentResponse:
$ref: '#/components/examples/India-Card-Capture-Payment-Response-Example'
US-Alipay-Payment-Capture-Success-Notification:
$ref: '#/components/examples/US-Alipay-Payment-Capture-Success-Notification'
US-Trustly-Payment-Capture-Success-Notification:
$ref: '#/components/examples/US-Trustly-Payment-Capture-Success-Notification'
responses:
'202':
description: Accepted
content:
application/json:
schema:
type: object
Payment-Cancel-Failed:
/payment-cancel-failed:
post:
parameters:
- $ref: '#/components/parameters/Event-Type'
- $ref: '#/components/parameters/Event-Name'
- $ref: '#/components/parameters/Operation'
- $ref: '#/components/parameters/Reference-Id'
- $ref: '#/components/parameters/Merchant-Post-Id'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/Payment-Notification'
examples:
Brazil-PIX-Payment-Cancel-Failed-Notification-Example:
$ref: '#/components/examples/Brazil-PIX-Payment-Cancel-Failed-Notification-Example'
responses:
'202':
description: Accepted
content:
application/json:
schema:
type: object
Payment-Rfp-Failed:
/payment-rfp-failed:
post:
parameters:
- $ref: '#/components/parameters/Apim-Guid'
- $ref: '#/components/parameters/Event-Type'
- $ref: '#/components/parameters/Event-Name'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/Rfp-Notification'
examples:
US-RFP-Reject-Notification:
$ref: '#/components/examples/Us-Rfp-Reject-Notification-Example'
Brazil-PIX-Reject-Notification:
$ref: '#/components/examples/Brazil-PIX-Reject-Notification-Example'
responses:
'202':
description: Accepted
content:
application/json:
schema:
type: object
Payment-Capture-Failed:
/payment-capture-failed:
post:
parameters:
- $ref: '#/components/parameters/Event-Type'
- $ref: '#/components/parameters/Event-Name'
- $ref: '#/components/parameters/Operation'
- $ref: '#/components/parameters/Reference-Id'
- $ref: '#/components/parameters/Merchant-Post-Id'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/Payment-Notification'
examples:
Card-Payment-Capture-Failed-Notification:
$ref: '#/components/examples/Payment-Capture-Failed-Notification'
Alipay-Payment-Capture-Failed-Notification:
$ref: '#/components/examples/Alipay-Payment-Capture-Failed-Notification'
Trustly-Payment-Capture-Failed-Notification:
$ref: '#/components/examples/Trustly-Payment-Capture-Failed-Notification'
responses:
'202':
description: Accepted
content:
application/json:
schema:
type: object
payment-Authorize-Failed:
/payment-authorize-failed:
post:
parameters:
- $ref: '#/components/parameters/Event-Type'
- $ref: '#/components/parameters/Event-Name'
- $ref: '#/components/parameters/Operation'
- $ref: '#/components/parameters/Reference-Id'
- $ref: '#/components/parameters/Merchant-Post-Id'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/Payment-Notification'
examples:
US-Alipay-Payment-Capture-Success-Notification:
$ref: '#/components/examples/US-Alipay-Payment-Capture-Success-Notification'
US-Trustly-Payment-Capture-Success-Notification:
$ref: '#/components/examples/US-Trustly-Payment-Capture-Success-Notification'
responses:
'202':
description: Accepted
content:
application/json:
schema:
type: object
Payment-Success-Status-Notification:
/payment-settled:
post:
parameters:
- $ref: '#/components/parameters/Apim-Guid'
- $ref: '#/components/parameters/Event-Type'
- $ref: '#/components/parameters/Event-Name'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/Payment-Credit-Notification'
examples:
Brazil-Payment-Success-Qr-Status-Notification:
$ref: '#/components/examples/Brazil-Payment-Success-Qr-Status-Notification'
India-Payment-Success-Upi-Status-Notification:
$ref: '#/components/examples/Payment-Success-Upi-Status-Notification'
Payment-Success-UK-Paybybank-Status-Notification:
$ref: '#/components/examples/Payment-Success-Uk-Paybybank-Status-Notification'
Payment-Success-US-Rfp-Status-Notification:
$ref: '#/components/examples/Payment-Success-Us-Rfp-Status-Notification'
Payment-Success-US-Ach-Direct-Debit-Status-Notification:
$ref: '#/components/examples/Payment-Success-Us-Ach-Direct-Debit-Status-Notification'
Payment-Success-US-Wire-Status-Notification:
$ref: '#/components/examples/Payment-Success-Us-Wire-Status-Notification'
Payment-Success-US-Ach-Status-Notification:
$ref: '#/components/examples/Payment-Success-Us-ACH-Status-Notification'
Payment-Success-Brazil-PIX-Credit-Status-Notification:
$ref: '#/components/examples/Payment-Success-Brazil-PIX-Credit-Status-Notification'
Payment-Success-Incoming-Brazil-PIX-Credit-Status-Notification:
$ref: '#/components/examples/Payment-Success-Incoming-Brazil-PIX-Credit-Status-Notification'
Payment-Success-India-IMPS-Credit-Status-Notification:
$ref: '#/components/examples/Payment-Success-India-IMPS-Credit-Status-Notification'
Payment-Success-Thailand-IP-Credit-Status-Notification:
$ref: '#/components/examples/Payment-Success-Thailand-IP-Credit-Status-Notification'
Payment-Failed-Thailand-IP-Credit-Status-Notification:
$ref: '#/components/examples/Payment-Failed-Thailand-IP-Credit-Status-Notification'
Payment-Success-Australia-IP-Credit-Status-Notification:
$ref: '#/components/examples/Payment-Success-Australia-IP-Credit-Status-Notification'
Payment-Failed-Australia-IP-Credit-Status-Notification:
$ref: '#/components/examples/Payment-Failed-Australia-IP-Credit-Status-Notification'
responses:
'202':
description: Accepted
content:
application/json:
schema:
type: object
Payment-Rfp-Success:
/payment-rfp-success:
post:
parameters:
- $ref: '#/components/parameters/Apim-Guid'
- $ref: '#/components/parameters/Event-Type'
- $ref: '#/components/parameters/Event-Name'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/Rfp-Notification'
examples:
US-RFP-Success-Notification:
$ref: '#/components/examples/Us-Rfp-Success-Notification-Example'
Brazil-RTP-Success-Notification:
$ref: '#/components/examples/Brazil-PIX-Success-Notification-Example'
responses:
'202':
description: Accepted
content:
application/json:
schema:
type: object
Payment-Created-Status:
/payment-qr-created:
post:
parameters:
- $ref: '#/components/parameters/Apim-Guid'
- $ref: '#/components/parameters/Event-Type'
- $ref: '#/components/parameters/Event-Name'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/Payment-Created-Notification'
examples:
Payment-Created-Notification:
$ref: '#/components/examples/Payment-Created-Notification'
responses:
'202':
description: Accepted
content:
application/json:
schema:
type: object
Payment-Failed:
/payment-failed:
post:
parameters:
- $ref: '#/components/parameters/Event-Type'
- $ref: '#/components/parameters/Event-Name'
- $ref: '#/components/parameters/Apim-Guid'
- $ref: '#/components/parameters/Operation'
- $ref: '#/components/parameters/Reference-Id'
- $ref: '#/components/parameters/Merchant-Post-Id'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/Payment-Notification'
examples:
US-Trustly-Payment-Failed-Timedout-Notification:
$ref: '#/components/examples/US-Trustly-Payment-Failed-Timedout-Notification'
US-Alipay-Payment-Failed-Timedout-Notification:
$ref: '#/components/examples/US-Alipay-Payment-Failed-Timedout-Notification'
responses:
'202':
description: Accepted
content:
application/json:
schema:
type: object
Payment-Cancelled-Status:
/payment-cancelled:
post:
parameters:
- $ref: '#/components/parameters/Apim-Guid'
- $ref: '#/components/parameters/Event-Type'
- $ref: '#/components/parameters/Event-Name'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/Payment-Cancelled-Notification'
examples:
Payment-Cancelled-Notification:
$ref: '#/components/examples/Payment-Cancelled-Notification'
responses:
'202':
description: Accepted
content:
application/json:
schema:
type: object
Payment-Cancel-Success:
/payment-cancel-success:
post:
parameters:
- $ref: '#/components/parameters/Event-Type'
- $ref: '#/components/parameters/Event-Name'
- $ref: '#/components/parameters/Operation'
- $ref: '#/components/parameters/Reference-Id'
- $ref: '#/components/parameters/Merchant-Post-Id'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/Payment-Notification'
examples:
BrazilPIXPaymenCancelSuccessNotification-Example:
$ref: '#/components/examples/Brazil-PIX-Payment-Cancel-Success-Notification-Example'
IndiaCardCancelPaymentResponse:
$ref: '#/components/examples/India-Card-Cancel-Payment-Response-Example'
responses:
'202':
description: Accepted
content:
application/json:
schema:
type: object
parameters:
Get-Payment-End-To-End-Id:
name: id
in: query
schema:
type: string
maxLength: 128
minLength: 1
description: "The transaction ID provided by client during transaction creation or transaction end-to-end-id received in incoming credit notification, \n- The id parameter is mandatory for inqury request."
example: 1L00IF2BCWUZF09
Operation:
name: Operation
in: header
required: true
description: Event Type
schema:
type: string
Post-Operation:
in: header
name: Operation
required: false
description: API operation
schema:
type: string
enum:
- CAPTURE
- AUTHORIZE
- PAY
- VERIFY
- DIRECTDEBIT
description: API operation
example: CAPTURE
Id:
name: id
in: path
required: true
description: Your unique End To End identification
schema:
type: string
maxLength: 128
minLength: 1
description: Your unique End To End identification
example: abc-pay-123
Patch-Operation:
in: header
name: Operation
required: false
description: API operation
schema:
type: string
enum:
- AUTHORIZE
- CANCEL
- PAY
description: API operation
example: CANCEL
Type:
name: type
in: query
schema:
type: string
enum:
- ID
- ENDTOENDID
- ORDERID
- UETR
description: "Transaction identifier type. \n- Default search will be based on ID, if client not provided any value from dropdown list"
example: ID
Idempotency-Id:
name: Idempotency-Id
in: header
required: true
description: "Your unique identification for a POST request \n - Maximum length is 128. \n- CitiConnect API responds with an error (HTTP status 4XX) if your POST request idempotency identification value is a duplicate across a recent history of idempotency identifications in Citi's database."
schema:
type: string
maxLength: 128
description: "Your unique identification for a POST request \n - Maximum length is 128. \n- CitiConnect API responds with an error (HTTP status 4XX) if your POST request idempotency identification value is a duplicate across a recent history of idempotency identifications in Citi's database. \n- If you don't receive any response (HTTP status 2XX, 4XX or 5XX) from Citi to your POST request and you wish to retry, reinitiate your request with the same idempotency identification to prevent accidental duplicate payment."
example: a44cbb60-6de4-4edb-9a7a-123414bba3bb
Event-Type:
name: Event-Type
in: header
required: true
description: Event Type
schema:
type: string
Apim-Guid:
name: Apim-Guid
in: header
required: true
description: Your unique Apim-Guid
schema:
type: string
maxLength: 52
minLength: 1
description: Your unique Apim-Guid
example: na-apimgwgtds04~4a98cbc5-d813-4e65-bc81-d70f0f87f6ec
Post-Country-Code:
name: Country-Code
in: header
schema:
type: string
maxLength: 2
minLength: 2
description: Country Code
example: IN
Merchant-Id:
name: Merchant-Id
in: header
required: true
description: Your unique Merchant Identification number
schema:
type: string
maxLength: 40
minLength: 1
description: Your unique Merchant Identification number
example: M123456987
Merchant-Post-Id:
name: Merchant-Id
in: header
required: false
description: "Your unique Merchant Identification number \n - Merchant ID header parameter is mandatory for payment methods - PIX (Brazil QR creation), CARD, BOLETO, PPRO, GOOGLEPAY, APPLEPAY, FPS and PAYPAL. \n- Merchant ID header parameter is not applicable for payment methods - ACH and RTP."
schema:
type: string
maxLength: 40
minLength: 1
description: Your unique Merchant Identification number
example: M123456987
Reference-Id:
name: Reference-Id
in: header
required: true
description: Event Type
schema:
type: string
Event-Name:
name: Event-Name
in: header
required: true
description: Event Type
schema:
type: string
Client-Id:
in: query
name: client_id
required: true
description: Your unique identification, same as the identification you use for OAuth token generation, Citi shared with you during your CitiConnect API onboarding
schema:
type: string
description: Your unique identification, same as the identification you use for OAuth token generation, Citi shared with you during your CitiConnect API onboarding
example: 9a10a5d6-63d4-4885-b6bd-19e79629496d
headers:
Request-Id:
schema:
type: string
description: Citi's unique identification for your request
securitySchemes:
clientCredentials:
description: 'All CitiConnect APIs use the oAuth2 authentication scheme, which requires a bearer token to authenticate your API call. The Token URL includes the version of authentication used by this API. See the Citi Authentication API reference for information on requesting a token.
'
oAuth2:
type: oauth2
flows:
authorizationCode:
authorizationUrl: /authenticationservices/v3/oauth/token
tokenUrl: /authenticationservices/v3/oauth/token
scopes:
authenticationservices/v1: Grant read-only access to payment initation service