UPI OVERVIEW
Citcon offers a number of endpoints associated with the UPI – API with each one being associated with a particular payment action.
API CATEGORY
Public/Private
Endpoint
Authentication
Access Token
Public
POST /v1/access-tokens
private_key
Charge
Public
POST /v1/charges
server access token
Capture
Public
POST /v1/captures
server access token
Refund
Public
POST /v1/refunds
server access token
Cancellation
Public
POST /v1/cancels
server access token
Vault
Public
POST /v1/vault GET/v1/vault
GET/v1/vault/:id
DELETE /v1/vault/:id
GET/v1/vault/:id
DELETE /v1/vault/:id
Client access token
server access token
Inquiry
Public
GET /v1/transactions/:id
server access token
Consult
Public
GET /v1/consults
Client access token
server access token
API Request and Response Format
Request
Name
type
value
Description
version
String
v1.0.0
(Optional) Citcon UPI Version
key
-
value
JSON key-value pairs
app
String
citcon-upi
(Optional) App version string
Response
Name
type
value
Description
status
String
success,fail
Response Status
data
Object
Subject to API call
Response data content
app
String
citcon-upi
API name
version
String
v.1.0.0
Citcon UPI Version
ACCESS TOKEN
This API generates a new access token; a merchant can have multiple access tokens but should always maintain a valid access token to call thecitcon UPI – API. By default, Citcon tokens are set to expire 24 hours from the time they were created; it is recommended that a merchant generate a new token before an existing one is set to expire. Token status can be checked based on the following info:
This API generates a new access token; a merchant can have multiple access tokens but should always maintain a valid access token to call thecitcon UPI – API. By default, Citcon tokens are set to expire 24 hours from the time they were created; it is recommended that a merchant generate a new token before an existing one is set to expire. Token status can be checked based on the following info:
- expiry
- http response status code: 401 Unauthorized
Request Headers
Header Field
Value
Required/Optional/ Conditonal
Description
Content-Type
application/json
R
The Media type of the body of the request
Authentication
Name
type
value
Description
HTTP Bearer
Private Key
C
-H “Authorization: Bearer
Request body
Name
type
value
Description
token_type
String
R
client,server
Response body data object
Authentication
value
Required/Optional/ Conditonal
access-token
String
client, server
token_type
String
client, server
expiry
timestamp
UTC timestamp, 1617182374
permissions
Array
[“charge“, “inquiry”, “capture”…]
CHARGE
The Charge request is the endpoint the merchant will call when initiating a payment request. This endpoint is the unified API point for initiating all transactions. What parameter being passed depends on the overall consumer use case as well as the merchant gateway provider and region.
Based on the user journey, merchant can decide if the payment method will be passed when sending the charge request. If the payment method is not passed, a Confirm Charge request would need to be sent separately in order to authorize the charge request.
Based on the user journey, merchant can decide if the payment method will be passed when sending the charge request. If the payment method is not passed, a Confirm Charge request would need to be sent separately in order to authorize the charge request.
Attributes
Request body
Transaction Object (Required)
This object represents data related to the overall payment transaction
child ATTRIBUTES
reference String (Required)
Merchant's identifier to help locate a transaction. This is used for merchants to inquire or internally track order and payment status. Within a merchant, this reference should be unique
Please Note: duplicate reference numbers will result in the transaction being rejected.
Please Note: duplicate reference numbers will result in the transaction being rejected.
amount Number (Required)
The total amount with tax included that your customers are going to payAnd the amount is in the smallest supported unit of the specified currency. For instance, for USD, the amount would be in cents.
currency String (Required)
The currency of the amount and tax that is passed in the API call.
The currency of the amount and tax that is passed in the API call.
- ISO 4217
locale String (Optional)
The language to display when consumers are redirected to a hosted payment page.
- ISO 639
Currently the following payments support this param.
- klarna
country String (Conditional)
The country of the settlement currency used in the amount and tax that is passed in the API call.
- ISO 3166-2
auto_capture Bolean (Optional)
Merchant Indicator to confirm that this charge should be captured without the need of the merchant sending a separate capture transaction In the event this field is not sent in or is blank then it is expected that the merchant will send in a separate capture request in order to capture this charge for settlement
Default: false
Default: false
payment Object (Required)
This object is a group of information that represents the payment method being used for this transaction
child ATTRIBUTES
method String (Required)
This is the consumer-selected payment method
- card
- banktransfer
- oxxo
- oxxopay
- toss
- samsungpay
- dana
- truemoney
- spei
- mercadopago
- klarna
- payco
- lpay
- alipay+
- rabbit_line_pay
- lgpay
- naverpay
- kakaopay
- linepay
- paypay
- paypal
- alipay_hk
- tng
- rakutenpay
- aalipay
- wechatpay
- upop
- venmo
- gcash
- bpi
indicator String (Required)
Merchant identifier to indicate the source of a customer transaction. Possible values are.
- authenticated
- non_authenticated
- installment
- recurring
- bnpl
request_token Bolean (Conditional)
This field would inform Citcon that the merchant wishes to request a token as it relates to the payment information being provided in this transaction.
- True
- False
If this field is not sent or blank no token will be created. Please note: a token will only be created on a successful authorization. If the authorization is declined, then no token will be created. A Token can only be requested for the following payment methods.
- card
- venmo
- paypal
If a token is requested for any other payment method no token will be returned.
token String (Conditional)
The merchant-specific token is distributed by Citcon when the merchant has requested Citcon to token and vault a specific card used by a customer. When a token is created and provided to a merchant it can be used in subsequent transaction requests when the token is available.
client Array (Conditional)
This field represents the client in which you wish to receive the alternative payment in. Wallet payments can be supported in several environments.
- desktop
- mobile_browser
- mobile_native
- mini_program
data Object (Conditional)
This object represents the card or data information related to a payment object.
child ATTRIBUTES
pan String (Conditional)
This field represents the card number of either the credit card or debit card entered to process the order. This field is only required if a Token is not being used. Under payment information it is required to send either a PAN or Token but not both.
first_name String (Conditional)
First name of the payment account holder.
last_name String (Conditional)
Last name of the payment account holder.
expiry String (Conditional)
The expiration date is related to the card or token being used.This field is required if a PAN is being used for the transaction.This field is not required when a token is being used but can be sent.MM/YY
cvv Number (Conditional)
The CVV related to the card or token being used. This field is required if a PAN is being used for the authorization. This field is not required when a token is being used but can be sent. In the event this field is sent with the token the gateway will use the CVV passed in the authorization to process the authorization.
check Object (Conditional)
This object is related to payment checks related to certain payment features.
child ATTRIBUTES
ccv Bolean (Conditional)
This field represents whether a CVV check needs to be completed as part of the authorization transaction.
- True
In the event nothing is passed then the CVV check will be skipped. Note: cvv check is only available for card payment method.
avs Bolean (Conditional)
This field represents whether an AVS check needs to be completed as part of the authorization transaction.
- True
In the event nothing is passed then the AVS check will be skipped. Note: cvv check is only available for card payment method.
billing_address Object (Conditional)
Consumer's billing address that's provided to a merchant and it can be used in subsequent transaction requests when the token is used.
child ATTRIBUTES
street String (Conditional)
This field represents the street number and street name related to the billing address
street2 String (Conditional)
This field represents the unit number related to the billing address.
city String (Conditional)
This field represents the city, town, or village related to the billing address
state String (Conditional)
This field represents the State or Province related to the billing address.
zip String (Conditional)
This field represents the ZipCode related to the billing address.
country String (Conditional)
This field represents the Country related to the billing address.
3ds Object (Conditional)
This object represents the required data that a merchant needs to send when sending a 3ds payment.
child ATTRIBUTES
indicator String (Conditional)
This field indicates the response sent back in the 3DS attempt. Once 3DS has been completed the information needs to be passed back in the API
- Authenticated
- Failed
- Never Attempted
tranx_id String (Conditional)
This field indicates the response sent back in the 3DS attempt. Once 3DS has been completed the information needs to be passed back in the API
- Transaction ID
authentication String (Conditional)
This field indicates the response sent back in the 3DS attempt. Once 3DS has been completed the information needs to be passed back in the API
- Authentication Crypto (CAVV)
id String (Conditional)
This field indicates the response sent back in the 3DS attempt. Once 3DS has been completed the information needs to be passed back in the API.
- Server Information
version String (Conditional)
This field indicates the response sent back in the 3DS attempt. Once 3DS has been completed the information needs to be passed back in the API.
- 3DS Version
Goods Object (Optional)
child ATTRIBUTES
data Array-Object (Conditional)
The data is represented as part of the goods object.
child ATTRIBUTES
name String (Optional)
This object represents the data around the goods that are being purchased as part of the transaction
sku String (Optional)
This field represents the SKU data related to the items being purchased.
url String (Optional)
This field represents the URL that the products being purchased as part of this transaction can be found.
quantity String (Optional)
This field represents the quantity items being purchased related to goods_name.
total_amount Number (Optional)
This field represents the total amount for the item being purchased including tax and discount.
unit_amount Number (Optional)
This object is related to payment checks related to certain payment features.
total_tax_rate Number (Optional)
The tax rate the consumer is being charged for the item being purchased
taxable_amount Number (Optional)
This field represents the amount of the item that is taxable.
tax_exempt_amount Number (Optional)
This field represents the amount of the item that is tax exempted.
total_tax_amount Number (Optional)
This field represents the total tax amount being charged for the item.
total_discount_amount Number (Optional)
This field represents the total discount amount related to the item.
Shipping Object
This object represents the shipping details related to the overall purchase of goods.
child ATTRIBUTES
first_name String (Optional)
This field represents the first name of the consumer the items are being shipped to as per shipping details
last_name String (Optional)
This field represents the last name of the consumer the items are being shipped to as per shipping details.
phone String (Optional)
This field represents the phone number of the consumer the items are being shipped to as per shipping details.
email String (Optional)
This field represents the email address of the consumer the items are being shipped to as per shipping details
street String (Optional)
This field represents the street number and street name related to the shipping address
street2 String (Optional)
This field represents the unit number related to the shipping address.
city String (Optional)
This field represents the city, town, or village related to the shipping address
state String (Optional)
This field represents the State or Province related to the shipping address.
zip String (Optional)
This field represents the ZipCode related to the shipping address.
country String (Optional)
This field represents the country related to the shipping address.
Consumer Object (Optional)
This object is a grouping of consumer data that can be optional or required depending on region and payment method.
child ATTRIBUTES
reference String (Conditional)
Merchant's identifier to identify a specific client related to a transaction. Within a merchant, this reference should be unique per consumer. This is used to identify a consumer as it relates to the card on file
first_name String (Conditional)
This field represents the first name related to the consumer reference This field is required as it relates to the first credential on file transaction. Once it is sent on the first transaction with the customer name it will be vaulted against the consumer reference for subsequent transactions.
last_name String (Conditional)
This field represents the last name related to the consumer reference. This field is required as it relates to the first credential on file transaction. Once it is sent on the first transaction with the consumer name it will be vaulted against the consumer reference for subsequent transactions
phone String (Conditional)
This field represents the phone number of the consumer. This field is required as it relates to the first credential on file transaction. Once it is sent on the first transaction with the phone number it will be vaulted against the consumer reference for subsequent transactions.
email String (Conditional)
This field represents the phone number of the consumer. This field is required as it relates to the first credential on file transaction. Once it is sent on the first transaction with the phone number it will be vaulted against the consumer reference for subsequent transactions.
ext_data Object (Conditional)
This object represents additional data of a consumer beyond the basic information that has been collected
child ATTRIBUTES
document_id String (Conditional)
This field represents a document ID related to certain regions that require a specific document to identify the consumer.
Installments Object (Optional)
This object is a grouping of consumer data that can be optional or required depending on region and payment method.
child ATTRIBUTES
id String (Conditional)
This field is to pass the plan ID related to a gateway controlled installment plan. This field represents an installment plan that will be managed at the gateway or issuer level. These plans will be negotiated with the merchant during onboarding. Supported payment methods:
- CreditCard (Mexico)
payment_number Number (Conditional)
This field represents a merchant controlled installment plan similar to collections or loan payments. The merchant would pass the payment number represented for this transaction in this field.
quantity Number (Conditional)
This field represents a merchant controlled installment plan similar to bad debt or loan payments. The merchant would pass the payment number represented for this transaction in this field.
promo Number (Conditional)
This field represents any promo being offered as part of the installment plan.
Urls Object (Optional)
This object is a grouping of consumer data that can be optional or required depending on region and payment method.
child ATTRIBUTES
ipn String (Conditional)
This url is invoked when a payment method has a change to the payment status. It serves the purpose to notify merchants of this payment status. This URL should be able to accept HTTP POST with multiple transaction parameters. See section Webhooks for details.This URL should be the same for all transaction types
success String (Conditional)
URL sent by the merchant indicating the URL to redirect the consumer to after the payment has been completed successfully if supported by payment method
fail String (Conditional)
URL sent by the merchant indicating the URL to redirect the consumer to after the payment has failed if supported by payment method.
cancel String (Conditional)
URL sent by the merchant indicating the URL to redirect the consumer to after the consumer has canceled the payment method if supported by the payment method.
mobile String (Conditional)
URL sent by the merchant indicating the URL to redirect the consumer to after the payment has been completed successfully when the payment environment is a mobile device if supported by payment method.
Ext Object (Optional)
This object represents additional data related to the consumer but not necessarily needed for the payment.
child ATTRIBUTES
device Object (Optional)
This object represents data related to the device the consumer is using.
child ATTRIBUTES
id String (Optional)
This field is to pass along the device ID captured by the merchant.
ip String (Optional)
This field is to pass along the IP of the customer.
fingerprint String (Optional)
This field is to pass along the device fingerprint captured by the merchant.
object String
Indicates the transaction that was called (Charge, Verification, Inquire, Cancel, Refund, Etc.)
id String
A transaction id passed back by Citcon should be saved by the merchant and may be used for subsequent transactions. (refund, cancel, capture)
reference String
This field is an echo back of the reference id that is passed by the merchant during the request.
amount Number
The transaction amount initiated with the charge
time_created Timestamp
The time in which the charge was created on the Citcon system.
amount_captured Number
The amount currently captured by the charge and expected to be settled if approved
status String
init, pending, success, canceled
currency String
init, pending, success, canceled
country String
Country indicated in the initial charge transaction.
Exchange Object
This object is related to specific information related to conversion for settlement. This field will only be passed if conversion is done in real-time
child ATTRIBUTES
currency String
This field represents the currency in which the funds have been converted to
amount String
This field represents the currency in which the funds have been converted to
rate String
URL This field represents the rate which was used for the conversion.
Payment Object
This object represents any detail specific to the payment.
child ATTRIBUTES
method String
Payment method of the charge
token String
Citcon merchant token returned if a token is requested in the request or if a token was used in the initial request.
type String
In the event a cc is used this returns the card brand related to the transaction
- Visa
- Mc
- Etc
data Object
Object related to the specific data related to the payment method
child ATTRIBUTES
pan String
Masked card pan returned to the merchant. (First 6 and last 4)
expiry String
The Expiry date of card used in the payment
CONFIRM CHARGE
The Charge request allows merchants to request user authorization in one step when the payment method is passed. However, in certain scenarios, the payment method can’t be passed when creating the charge. In those scenarios, a separate Confirm Charge request is needed to pass payment method and to obtain user authorization.
Confirm charge can also be used when transaction details needs to be changed. For example, the amount needs to be changed due to shipping cost recalculation. This would be achieved using confirm charge call if the charge hasn’t been authorized.
In all the scenarios, the reference value has to be identical to the reference in the original charge.
Confirm charge can also be used when transaction details needs to be changed. For example, the amount needs to be changed due to shipping cost recalculation. This would be achieved using confirm charge call if the charge hasn’t been authorized.
In all the scenarios, the reference value has to be identical to the reference in the original charge.
Attributes
Request body
Transaction Object (Required)
This object represents data related to the overall payment transaction
child ATTRIBUTES
reference String (Required)
Merchant's identifier to help locate a transaction. This is used for merchants to inquire or internally track order and payment status. Within a merchant, this reference should be unique
Please Note: duplicate reference numbers will result in the transaction being rejected.
Please Note: duplicate reference numbers will result in the transaction being rejected.
amount Number (Required)
The total amount with tax included that your customers are going to payAnd the amount is in the smallest supported unit of the specified currency. For instance, for USD, the amount would be in cents.
currency String (Required)
The currency of the amount and tax that is passed in the API call.
The currency of the amount and tax that is passed in the API call.
- ISO 4217
locale String (Optional)
The language to display when consumers are redirected to a hosted payment page.
- ISO 639
Currently the following payments support this param.
- klarna
country String (Conditional)
The country of the settlement currency used in the amount and tax that is passed in the API call.
- ISO 3166-2
auto_capture Bolean (Optional)
Merchant Indicator to confirm that this charge should be captured without the need of the merchant sending a separate capture transaction In the event this field is not sent in or is blank then it is expected that the merchant will send in a separate capture request in order to capture this charge for settlement
Default: false
Default: false
payment Object (Required)
This object is a group of information that represents the payment method being used for this transaction
child ATTRIBUTES
method String (Required)
This is the consumer-selected payment method
- card
- banktransfer
- oxxo
- oxxopay
- toss
- samsungpay
- dana
- truemoney
- spei
- mercadopago
- klarna
- payco
- lpay
- alipay+
- rabbit_line_pay
- lgpay
- naverpay
- kakaopay
- linepay
- paypay
- paypal
- alipay_hk
- tng
- rakutenpay
- aalipay
- wechatpay
- upop
- venmo
- gcash
- bpi
indicator String (Required)
Merchant identifier to indicate the source of a customer transaction. Possible values are.
- authenticated
- non_authenticated
- installment
- recurring
- bnpl
request_token Bolean (Conditional)
This field would inform Citcon that the merchant wishes to request a token as it relates to the payment information being provided in this transaction.
- True
- False
If this field is not sent or blank no token will be created. Please note: a token will only be created on a successful authorization. If the authorization is declined, then no token will be created. A Token can only be requested for the following payment methods.
- card
- venmo
- paypal
If a token is requested for any other payment method no token will be returned.
token String (Conditional)
The merchant-specific token is distributed by Citcon when the merchant has requested Citcon to token and vault a specific card used by a customer. When a token is created and provided to a merchant it can be used in subsequent transaction requests when the token is available.
client Array (Conditional)
This field represents the client in which you wish to receive the alternative payment in. Wallet payments can be supported in several environments.
- desktop
- mobile_browser
- mobile_native
- mini_program
data Object (Conditional)
This object represents the card or data information related to a payment object.
child ATTRIBUTES
pan String (Conditional)
This field represents the card number of either the credit card or debit card entered to process the order. This field is only required if a Token is not being used. Under payment information it is required to send either a PAN or Token but not both.
first_name String (Conditional)
First name of the payment account holder.
last_name String (Conditional)
Last name of the payment account holder.
expiry String (Conditional)
The expiration date is related to the card or token being used.This field is required if a PAN is being used for the transaction.This field is not required when a token is being used but can be sent.MM/YY
cvv Number (Conditional)
The CVV related to the card or token being used. This field is required if a PAN is being used for the authorization. This field is not required when a token is being used but can be sent. In the event this field is sent with the token the gateway will use the CVV passed in the authorization to process the authorization.
check Object (Conditional)
This object is related to payment checks related to certain payment features.
child ATTRIBUTES
ccv Bolean (Conditional)
This field represents whether a CVV check needs to be completed as part of the authorization transaction.
- True
In the event nothing is passed then the CVV check will be skipped.
Note: cvv check is only available for card payment method.
Note: cvv check is only available for card payment method.
avs Bolean (Conditional)
This field represents whether an AVS check needs to be completed as part of the authorization transaction.
- True
In the event nothing is passed then the AVS check will be skipped.
Note: cvv check is only available for card payment method.
Note: cvv check is only available for card payment method.
billing_address Object (Conditional)
Consumer's billing address that's provided to a merchant and it can be used in subsequent transaction requests when the token is used.
child ATTRIBUTES
street String (Conditional)
This field represents the street number and street name related to the billing address
street2 String (Conditional)
This field represents the unit number related to the billing address.
city String (Conditional)
This field represents the city, town, or village related to the billing address
state String (Conditional)
This field represents the State or Province related to the billing address.
zip String (Conditional)
This field represents the ZipCode related to the billing address.
country String (Conditional)
This field represents the Country related to the billing address.
3ds Object (Conditional)
This object represents the required data that a merchant needs to send when sending a 3ds payment.
child ATTRIBUTES
indicator String (Conditional)
This field indicates the response sent back in the 3DS attempt. Once 3DS has been completed the information needs to be passed back in the API
- Authenticated
- Failed
- Never Attempted
tranx_id String (Conditional)
This field indicates the response sent back in the 3DS attempt. Once 3DS has been completed the information needs to be passed back in the API
- Transaction ID
authentication String (Conditional)
This field indicates the response sent back in the 3DS attempt. Once 3DS has been completed the information needs to be passed back in the API
- Authentication Crypto (CAVV)
id String (Conditional)
This field indicates the response sent back in the 3DS attempt. Once 3DS has been completed the information needs to be passed back in the API.
- Server Information
version String (Conditional)
This field indicates the response sent back in the 3DS attempt. Once 3DS has been completed the information needs to be passed back in the API.
- 3DS Version
Goods Object (Optional)
child ATTRIBUTES
data Array-Object (Conditional)
The data is represented as part of the goods object.
child ATTRIBUTES
name String (Optional)
This object represents the data around the goods that are being purchased as part of the transaction
sku String (Optional)
This field represents the SKU data related to the items being purchased.
url String (Optional)
This field represents the URL that the products being purchased as part of this transaction can be found.
quantity String (Optional)
This field represents the quantity items being purchased related to goods_name.
total_amount Number (Optional)
This field represents the total amount for the item being purchased including tax and discount.
unit_amount Number (Optional)
This object is related to payment checks related to certain payment features.
total_tax_rate Number (Optional)
The tax rate the consumer is being charged for the item being purchased
taxable_amount Number (Optional)
This field represents the amount of the item that is taxable.
tax_exempt_amount Number (Optional)
This field represents the amount of the item that is tax exempted.
total_tax_amount Number (Optional)
This field represents the total tax amount being charged for the item.
total_discount_amount Number (Optional)
This field represents the total discount amount related to the item.
Shipping Object
This object represents the shipping details related to the overall purchase of goods.
child ATTRIBUTES
first_name String (Optional)
This field represents the first name of the consumer the items are being shipped to as per shipping details
last_name String (Optional)
This field represents the last name of the consumer the items are being shipped to as per shipping details.
phone String (Optional)
This field represents the phone number of the consumer the items are being shipped to as per shipping details.
email String (Optional)
This field represents the email address of the consumer the items are being shipped to as per shipping details
street String (Optional)
This field represents the street number and street name related to the shipping address
street2 String (Optional)
This field represents the unit number related to the shipping address.
city String (Optional)
This field represents the city, town, or village related to the shipping address
state String (Optional)
This field represents the State or Province related to the shipping address.
zip String (Optional)
This field represents the ZipCode related to the shipping address.
country String (Optional)
This field represents the country related to the shipping address.
Consumer Object (Optional)
This object is a grouping of consumer data that can be optional or required depending on region and payment method.
child ATTRIBUTES
reference String (Conditional)
Merchant's identifier to identify a specific client related to a transaction. Within a merchant, this reference should be unique per consumer. This is used to identify a consumer as it relates to the card on file
first_name String (Conditional)
This field represents the first name related to the consumer reference This field is required as it relates to the first credential on file transaction. Once it is sent on the first transaction with the customer name it will be vaulted against the consumer reference for subsequent transactions.
last_name String (Conditional)
This field represents the last name related to the consumer reference. This field is required as it relates to the first credential on file transaction. Once it is sent on the first transaction with the consumer name it will be vaulted against the consumer reference for subsequent transactions
phone String (Conditional)
This field represents the phone number of the consumer. This field is required as it relates to the first credential on file transaction. Once it is sent on the first transaction with the phone number it will be vaulted against the consumer reference for subsequent transactions.
email String (Conditional)
This field represents the phone number of the consumer. This field is required as it relates to the first credential on file transaction. Once it is sent on the first transaction with the phone number it will be vaulted against the consumer reference for subsequent transactions.
ext_data Object (Conditional)
This object represents additional data of a consumer beyond the basic information that has been collected
child ATTRIBUTES
document_id String (Conditional)
This field represents a document ID related to certain regions that require a specific document to identify the consumer.
Installments Object (Optional)
This object is a grouping of consumer data that can be optional or required depending on region and payment method.
child ATTRIBUTES
id String (Conditional)
This field is to pass the plan ID related to a gateway controlled installment plan. This field represents an installment plan that will be managed at the gateway or issuer level. These plans will be negotiated with the merchant during onboarding. Supported payment methods:
- CreditCard (Mexico)
payment_number Number (Conditional)
This field represents a merchant controlled installment plan similar to collections or loan payments. The merchant would pass the payment number represented for this transaction in this field.
quantity Number (Conditional)
This field represents a merchant controlled installment plan similar to bad debt or loan payments. The merchant would pass the payment number represented for this transaction in this field.
promo Number (Conditional)
This field represents any promo being offered as part of the installment plan.
Urls Object (Optional)
This object is a grouping of consumer data that can be optional or required depending on region and payment method.
child ATTRIBUTES
ipn String (Conditional)
This url is invoked when a payment method has a change to the payment status. It serves the purpose to notify merchants of this payment status. This URL should be able to accept HTTP POST with multiple transaction parameters. See section Webhooks for details.This URL should be the same for all transaction types
success String (Conditional)
URL sent by the merchant indicating the URL to redirect the consumer to after the payment has been completed successfully if supported by payment method.
fail String (Conditional)
URL sent by the merchant indicating the URL to redirect the consumer to after the payment has failed if supported by payment method.
cancel String (Conditional)
URL sent by the merchant indicating the URL to redirect the consumer to after the consumer has canceled the payment method if supported by the payment method.
mobile String (Conditional)
URL sent by the merchant indicating the URL to redirect the consumer to after the payment has been completed successfully when the payment environment is a mobile device if supported by payment method.
Ext Object (Optional)
This object represents additional data related to the consumer but not necessarily needed for the payment.
child ATTRIBUTES
device Object (Optional)
This object represents data related to the device the consumer is using.
child ATTRIBUTES
id String (Optional)
This field is to pass along the device ID captured by the merchant.
ip String (Optional)
This field is to pass along the IP of the customer.
fingerprint String (Optional)
This field is to pass along the device fingerprint captured by the merchant.
object String
Indicates the transaction that was called (Charge, Verification, Inquire, Cancel, Refund, Etc.)
id String
A transaction id passed back by Citcon should be saved by the merchant and may be used for subsequent transactions. (refund, cancel, capture)
reference String
This field is an echo back of the reference id that is passed by the merchant during the request.
amount Number
The transaction amount initiated with the charge
amount_captured Number
The amount currently captured by the charge and expected to be settled if approved
currency String
This field represents the currency of the transaction
time_created Timestamp
The time in which the charge was created in Citcon system.
time_captured Timestamp
The time in which the charge was captured in Citcon system
time_canceled Timestamp
The time in which the charge was canceled in Citcon system
auto_captured Boolean
Indication of whether the initial charge was auto captured or not.
status String
Status of the transaction. Possible values are authorized, initiated, pending, succeeded, and canceled.
country String
The country indicated in the initial charge transaction.
Exchange Object
This object is related to specific information related to conversion for settlement. This field will only be returned if currency conversion is done in real time.
child ATTRIBUTES
ammounnt Number
The conversion amount represents the amount that will be settled.
currency String
This field represents the currency in which the funds have been converted to
rate Number
This field represents the rate which was used for the conversion.
Payment Object
This object represents the details of the payment.
child ATTRIBUTES
method String
Payment method of the charge
token String
Citcon merchant token returned if a token is requested in the request or if a token was used in the initial request.
type String
In the event a Credit Card is used this returns the card scheme related to the transaction
- Visa
- Mc
- Etc
client Array
Represents the client environment used for this transaction
- desktop
- mobile_browser
- mobile_native
- mini_program
format Array
Represents the format used for the wallet transaction
- barcode
- qr
- json
- url
method Array
Represents the HTTP method used
- GET
- POST
content String
Represents the HRepresents the content of the details of the Wallet client and format.TTP method used
data Object
Object related to the specific data related to the payment method
child ATTRIBUTES
pan String
Masked card pan returned to the merchant. (First 6 and last 4)
expiry String
The Expiry date of card used in the payment
cof Object
Object related to the specific data related to the credential on file
child ATTRIBUTES
id String
This is the ID returned when the issuer notified a transaction is being stored for future use. This ID allows the issuer to look up the original transaction where the card was stored.
Note: required in certain regions when using a credential on file.
Note: required in certain regions when using a credential on file.
- United States
- Canada
check Object
This object represent the check response from the payment method
child ATTRIBUTES
ccv String
Response from cvv check
avs String
Response from avs check
CAPTURE
The Capture endpoint allows merchants to capture a charge authorization that hasn’t been captured. The merchant should send a capture request only if an authorized transaction is open and available to be captured. Below are some prerequisites that are needed to accept a capture transaction:
The charge authorization is open and still active to be captured.Additionally, the current used in the capture and authorization need to be the same. And a merchant can never capture more than the charge authorization amount. However, the merchant can still do a partial capture which would result in settlement amount of the transaction to be less than the original amount.
The charge authorization is open and still active to be captured.Additionally, the current used in the capture and authorization need to be the same. And a merchant can never capture more than the charge authorization amount. However, the merchant can still do a partial capture which would result in settlement amount of the transaction to be less than the original amount.
Attributes
Request body
id (Conditional)
Required if transaction_reference is absent. The transaction id returned as part of the original charge transaction. The transaction_reference or id will allow Citcon to know which transaction the merchant is trying to capture.
transaction_reference (Conditional)
Required if id is absent. The merchant-specific reference returned as part of the original charge transaction. The transaction_reference or id will allow Citcon to know which transaction the merchant is trying to capture.
reference (Required)
Merchant's identifier for this capture transaction. This is used for merchants to inquire or internally track order and payment status.Within the merchant, this reference should uniquely identify a transaction. In addition, this reference is different from the reference from the original charge request.
Please Note: Duplicate reference would result in the request being rejected.
Please Note: Duplicate reference would result in the request being rejected.
transaction_amount Number (Optional)
Amount to be captured. If not provided, it's a full amount captured.
multi_capture (optional)
This field represents a flag if the charge being captured includes multiple captures against it.This field is only supported with certain payment methods listed below.
- klarna
last_capture Boolean (Optional)
This field represents a flag for multi_capture transactions to indicate this transaction will be the last transaction captured against the original charge.This field is only supported with certain payment methods listed below.
- klarna
shipping (Optional)
This object represents the shipping information to be passed in the capture transaction.
child ATTRIBUTES
vendor String (Optional)
This field represents the vendor that handles the shipping.
tracking Number (Optional)
This field represents the tracking number of this shipment.
object String
Indicates the transaction that was called (Charge, Verification, Inquire, Cancel, Refund, Etc.)
id String
A transaction id passed back by Citcon should be saved by the merchant and may be used for subsequent transactions. (refund, cancel, capture)
reference String
This field is an echo back of the reference id that is passed by the merchant during the request.
amount Number
The transaction amount initiated with the charge
time_created Timestamp
The time in which the charge was created on the Citcon system.
amount_captured Number
The amount currently captured by the charge and expected to be settled if approved
status String
init, pending, success, canceled
currency String
This field represents the currency of the transaction
country String
Country indicated in the initial charge transaction.
Exchange Object
This object is related to specific information related to conversion for settlement. This field will only be passed if conversion is done in real-time
child ATTRIBUTES
currency String
This field represents the currency in which the funds have been converted to
ammounnt String
This field represents the currency in which the funds have been converted to
rate String
URL This field represents the rate which was used for the conversion.
Payment Object
This object represents any detail specific to the payment.
child ATTRIBUTES
method String
Payment method of the charge
token String
Citcon merchant token returned if a token is requested in the request or if a token was used in the initial request.
type String
In the event a cc is used this returns the card brand related to the transaction
- Visa
- Mc
- Etc
data Object
Object related to the specific data related to the payment method
child ATTRIBUTES
pan String
Masked card pan returned to the merchant. (First 6 and last 4)
expiry String
The Expiry date of card used in the payment
REFUND
The refund endpoint is used by merchants to issue a refund back to the consumer. There might be many reasons that a refund is needed. Possible reasons include inventory issues, customerdisputes, defective items, etc. When calling the refund endpoint, please keep the following in mind:
- Only captured transactions can be refunded
- The amount to be refunded can never be greater than the captured amount
- It’s possible to refund an amount that’s less than the captured amount
- Refunds should be sent in the same currency as the original charge transaction.
- Refund request must always correspond to a capture transaction
Additionally, refunds are restricted to the amount of funds available in the merchant’s open balance, i.e., merchant must have enough funds available in order for a refund to be processed successfully.
Attributes
Request body
id String (Conditional)
The Citcon charge transaction id that was passed back in the charge response. This field is required if transaction_reference is not provided.
transaction_reference String (Conditional)
The merchant provided reference in the capture request or charge request. This represents the reference of the captured transaction. This field is required if the id field is not provided
reference String (Required)
Merchant's identifier to help locate a transaction. This is used for merchants to inquire or internally track order and payment status.Within a merchant, this reference should be unique Please Note: duplicate reference numbers will result in the transaction being rejected.
amount Number (Conditional)
The amount to be refunded. If not provided, a full refund will be processed.
note String (Conditional)
An explanation of the reason behind the refund. And this is required for some regions or payment methods. Please see example below
- klarna
last_capture Boolean (Optional)
This field represents a flag for multi_capture transactions to indicate this transaction will be the last transaction captured against the original charge.This field is only supported with certain payment methods listed below.
- Inventory issue
- Consumer requested
- Product issue
- Fraud
ext (Optional)
This object represents the extra information to be passed in the refund transaction.
child ATTRIBUTES
tax_free_amount Number (Optional)
This field represents the tax free portion of the refund amount.
object String
Indicates the transaction that was called (Charge, Verification, Inquire, Cancel, Refund, Etc.)
id String
A transaction id passed back by Citcon should be saved by the merchant and may be used for subsequent transactions. (refund, cancel, capture.
reference String
This field is an echo back of the reference id that is passed by the merchant during the request.
amount Number
The amount of the refund transaction.
amount_refund Number
The total amount refunded against this charge transaction.
currency String
This field represents the currency of the transaction
time_created Timestamp
The time in which the charge was created on the Citcon system.
status String
This field would inform Citcon that the merchant init, pending, success, canceled
country String
Country indicated in the initial charge transaction.
Exchange Object
This object is related to specific information related to conversion for settlement. This field will only be passed if conversion is done in real-time
child ATTRIBUTES
amount String
This field is to pass along the device ID captured by the merchant.
currency String
This field is to pass along the IP of the customer.
rate String
This field represents the rate which was used for the conversion.
Payment Object
This object is related to specific information related to conversion for settlement. This field will only be passed if conversion is done in real-time
child ATTRIBUTES
method String
Payment method of the charge
token String
Citcon merchant token returned if a token is requested in the request or if a token was used in the initial request.
type String
In the event a cc is used this returns the card brand related to the transaction
- Visa
- Mc
- Etc
client Array
Represents the client used for the wallet transaction
- desktop
- mobile_brower
- mobile_native
- mini_program
rate Array
Represents the format used for the wallet transaction
- barcode
- qr
- json
- url
method Array
Represents when a URL if the method is one of the below
- GET
- POST
content Array
Represents the content of the details of the Wallet client and format.
CANCEL
The Cancel Endpoint is used by merchants to cancel an active charge authorization that has not been captured in order to release the hold on consumer’s funds.
When merchants decide to cancel an active transaction, as followed are what they should take into consideration.
When merchants decide to cancel an active transaction, as followed are what they should take into consideration.
- Merchants cannot cancel a captured transaction. If they need to revert a captured transaction then a refund call will be required.
- Merchants can only cancel charge transactions. It is not allowed to cancel refund transactions.
Attributes
Request body
id String (Conditional)
Citcon charge transaction id that was passed back in the charge request. This field is required if transaction_reference is not provided.
transaction_reference String (Conditional)
The merchant provided reference in the charge transaction. This field is required if the id field is not provided
reference String (Required)
Merchant's identifier to help locate a transaction. This is used for merchants to inquire or internally track order and payment status.Within a merchant, this reference should be unique Please Note: duplicate reference numbers will result in the transaction being rejected.
object String
Indicates the transaction that was called (Charge, Verification, Inquire, Cancel, Refund, Etc.)
id String
A transaction id passed back by Citcon should be saved by the merchant and may be used for subsequent transactions. (refund, cancel, capture.)
reference String
This field is an echo back of the reference id that is passed by the merchant during the request.
amount Number
The amount of the refund transaction.
currency String
This field represents the currency of the transaction
time_created Timestamp
The time in which the charge was created on the Citcon system.
status String
This field would inform Citcon that the merchant init, pending, success, canceled
country String
Country indicated in the initial charge transaction.
Payment Object
This object represents any detail specific to the payment.
child ATTRIBUTES
method String
Payment method of the charge
token String
Citcon merchant token returned if a token is requested in the request or if a token was used in the initial request.
type String
In the event a cc is used this returns the card brand related to the transaction
- Visa
- Mc
- Etc
data object
Object related to the specific data related to the payment method
child ATTRIBUTES
pan String
Masked card pan returned to the merchant. (First 6 and last 4)
expiry String
The Expiry date of card used in the payment
INQUIRY
The Inquire endpoint allows merchants to inquire the details of a previously submitted transaction. The merchant can inquire transactions that was submitted through the following endpoints.
- charge
- capture
- refund
- verification
Attributes
Request body
No payload.
object String
Indicates the transaction that was called (Charge, Verification, Inquire, Cancel, Refund, Etc.)
id String
A transaction id passed back by Citcon should be saved by the merchant and may be used for subsequent transactions. (refund, cancel, capture.
reference String
This field is an echo back of the reference id that is passed by the merchant during the request.
amount Number
The amount of the charge transaction.
amount_refunded Number
The total amount refunded against the charge transaction.
currency String
This field represents the currency of the transaction
time_created Timestamp
The time in which the charge was created on the Citcon system.
time_captured Timestamp
The time in which the charge was captured on the system
time_canceled Timestamp
The time in which the charge was canceled on the system
auto_capture Boolean
Indication of if the initial charge was auto_captured or if it was not.
status String
The status of the transaction. Possible values are init, pending, authorized, success, canceled
country String
Country indicated in the initial charge transaction.
exchange Object
This object is related to specific information related to conversion for settlement. This field will only be passed if conversion is done in real-time
child ATTRIBUTES
exchange_amount String
This field is to pass along the device ID captured by the merchant.
exchange_currency String
This field is to pass along the IP of the customer.
payment Object
This object represents any detail specific to the payment.
child ATTRIBUTES
method String
Payment method of the charge
token String
Citcon merchant token returned if a token is requested in the request or if a token was used in the initial request.
type String
In the event a cc is used this returns the card brand related to the transaction
- Visa
- Mc
- Etc
data object
Object related to the specific data related to the payment method
child ATTRIBUTES
pan String
Masked card pan returned to the merchant. (First 6 and last 4)
expiry String
The Expiry date of card used in the payment
refunds Object
This object represents the data related to the refunds received for this transaction
child ATTRIBUTES
data Array
Data array related to the refunds
id String
This param indicates the transaction ID related to the refund transaction.
amount Number
This param represents the amount of the refund transaction
currency String
This param represents the currency of the refund transaction
time_created Timestamp
This param indicates the time in which the refund transaction was created at Citcon
captures Object
This object represents the data related to the captures received for this transaction
child ATTRIBUTES
data Array
Data array related to the captures
id String
This param indicates the transaction ID related to the capture transaction
amount Number
This param represents the amount of the capture transaction
currency String
This param represents the currency of the capture transaction
time_created Timestamp
This param indicates the time in which the capture transaction was created at Citcon
chargebacks Object
This object represents the data related to the chargebacks received for this transaction
child ATTRIBUTES
data Array
Data array related to the charges
id String
This param indicates the transaction ID related to the charge transaction.
amount String
This param represents the amount of the charge transaction
currency String
This param represents the currency of the charge transaction
time_created Timestamp
This param indicates the time in which the charge transaction was created at Citcon
VAULT - Add token
Besides supporting payment using payment instrument directly, Citcon also allow tokenizing payment instruments and using them for future payment transactions. The tokenization is done through the Citcon payment vault. The Token endpoint can be used by the merchant for a number of reasons but the main objective is to allow the merchant to be able to manage their vault. Possible operations are as followed:
● Add a token
This is used when merchants want to add a token outside of a charge request. When making a charge request, merchants have the option to request tokenize the provided payment method. As a result, the token of vaulted payment method would be returned in the response. The Token endpoint allows merchants to add a token outside of a payment transaction.
● Delete Token
When merchants want to delete a token from the vault as they no longer need to keep the payment instrument on file. It is suggested that all merchants supportingtokenization have the ability to delete tokens in the event the consumer payment information should no longer be saved.
Attributes
Request Body
reference String (Required)
Merchant's identifier to help locate a transaction. This is used for merchants to inquire or internally track order and payment status. Within a merchant, this reference should be unique.
Please Note: duplicate references will result in the transaction being rejected.
Please Note: duplicate references will result in the transaction being rejected.
payment Object (Required)
This object is a group of information that represents the payment method being used for this transaction
child ATTRIBUTES
method String (Required)
This is the consumer-selected payment method. As followed are the supported methods:
- card
token String (Conditional)
The merchant-specific token that was distributed by Citcon when the merchant has requested Citcon to tokenize and vault a specific card used by a customer. When a token is created and provided to a merchant it can be used in subsequent transaction requests when the token is available.
urls Object (Optional)
This object represents the urls associated with redirecting back to the merchant after certain events.
child ATTRIBUTES
ipn String (Optional)
This url is invoked when a payment method has a change to the payment status. It serves the purpose to notify merchants of this payment status. This URL should be able to accept HTTP POST with multiple transaction parameters. See section Webhooks for details. This URL should be the same for all transaction types.
success String (Optional)
URL sent by the merchant indicating the URL to redirect the consumer to after the payment has been completed successfully if supported by payment method.
fail String (Optional)
URL sent by the merchant indicating the URL to redirect the consumer to after the payment has failed if supported by payment method
cancel String (Optional)
URL sent by the merchant indicating the URL to redirect the consumer to after the payment has cancelled the payment method if supported by payment method
mobile String (Optional)
URL sent by the merchant to redirect the consumer to an e-wallet app once payment is complete
Consumer Object (Optional)
This object is a grouping of consumer data that can be optional or required depending on region and payment method.
child ATTRIBUTES
reference String (Conditional)
Merchant's identifier to identify a specific client related to a transaction. Within a merchant, this reference should be unique per consumer. This is used to identify a consumer as it relates to the card on file
first_name String (Conditional)
This field represents the first name related to the consumer reference. This field is required as it relates to the first credential on file transaction. Once it is sent on the first transaction with the customer name it will be vaulted against the consumer reference for subsequent transactions.
last_name String (Conditional)
This field represents the last name related to the consumer reference. This field is required as it relates to the first credential on file transaction. Once it is sent on the first transaction with the consumer name it will be vaulted against the consumer reference for subsequent transactions
phone String (Conditional)
This field represents the phone number of the consumer. This field is required as it relates to the first credential on file transaction. Once it is sent on the first transaction with the phone number it will be vaulted against the consumer reference for subsequent transactions.
email String (Conditional)
This field represents the phone number of the consumer. This field is required as it relates to the first credential on file transaction. Once it is sent on the first transaction with the phone number it will be vaulted against the consumer reference for subsequent transactions.
ext_data Object (Conditional)
This object represents additional data of a consumer beyond the basic information that has been collected
child ATTRIBUTES
document_id String (Conditional)
This field represents a document ID related to certain regions that require a specific document to identify the consumer.
Response Body
object String
Indicates the transaction that was called (Charge, Verification, Inquire, Cancel, Refund, Etc.)
reference String
This field is an echo back of the reference id that is passed by the merchant during the request.
time_created Timestamp
The time in which the charge was created on the Citcon system.
status String
active, deleted
country
Country indicated in the initial charge transaction
payment Object
This object represents any detail specific to the payment.
child ATTRIBUTES
method String
Payment method of the charge
token String
Citcon merchant token returned if a token is requested in the request or if a token was used in the initial request.
type String
In the event a cc is used this returns the card brand related to the transaction
- Visa
- Mc
- Etc
data String
Object related to the specific data related to the payment method
child ATTRIBUTES
pan String
Masked card pan returned to the merchant. (First 6 and last 4)
expiry String
The Expiry date of card used in the payment
VAULT - Delete token
This endpoint is used when a merchant wishes to delete a token from the vault as they no longer wish to keep the payment information on file. It is suggested that all merchants supporting tokenization have the ability to delete tokens in the event the consumer payment information should no longer be saved.
Attributes
Request Body
No payload.
Response Body
object String
Indicates the transaction that was called (Charge, Verification, Inquire, Cancel, Refund, Etc.) and it should be vault in this response.
reference String
This field is an echo back of the reference id that is passed by the merchant during the request.
time_created Timestamp
The time in which the charge was created on the Citcon system.
status String
The status of the request.
country
Country indicated in the initial charge transaction
payment Object
This object represents any detail specific to the payment.
child ATTRIBUTES
method String
Payment method of the charge
token String
Citcon merchant token returned if a token is requested in the request or if a token was used in the initial request.
type String
In the event a cc is used this returns the card brand related to the transaction
- Visa
- Mc
- Etc
data Object
Object related to the specific data related to the payment method
child ATTRIBUTES
pan String
Masked card pan returned to the merchant. (First 6 and last 4)
expiry String
The Expiry date of card used in the payment
VAULT - Inquire token
This endpoint is used when merchants want to fetch details of a token that has been vaulted in Citcon.
Attributes
Request Body
No payload.
Response Body
object String
Indicates the transaction that was called (Charge, Verification, Inquire, Cancel, Refund, vault Etc.) and it should be vault in this response.
reference String
This field is an echo back of the reference id that is passed by the merchant during the request.
time_created Timestamp
The time in which the charge was created on the Citcon system.
status String
The status of the request.
country
Country indicated in the initial charge transaction
payment Object
This object represents any detail specific to the payment.
child ATTRIBUTES
method String
Payment method of the charge
token String
Citcon merchant token returned if a token is requested in the request or if a token was used in the initial request.
type String
In the event a cc is used this returns the card brand related to the transaction
- Visa
- Mc
- Etc
data Object
Object related to the specific data related to the payment method
child ATTRIBUTES
pan String
Masked card pan returned to the merchant. (First 6 and last 4)
expiry String
The Expiry date of card used in the payment
CONSULT
The consult endpoint from the merchant is to get a set amount of data back related to an API call before a charge transaction. When a merchant is beginning the process in order to offer a promo or installment plan to the consumer they may send a consult request to determine the different promo’s or plans that are available as well as the data related to them for the merchant to use in payment request.
Attributes
Request parameters
method String (Required)
This field represents the payment method that is used for lookup in this request.
- alipay+
- card
amount String (Required)
Field to pass the amount with tax included your customers are going to payMinimum unit supported.
currency String (Required)
Field to indicate the currency related to the amount and tax that is passed in the API call.
- ISO 4217
country String (Required)
Field to indicate the country related to the order indicating the country the payment is being processed in
- ISO 3166-2
client String (Conditional)
The client from which this request is initiated. Possible values are:
- desktop
- mobile_browser
device String (Conditional)
The device from which this request is initiated. Possible values are:
- ios
- android
Response body
installments
This object represents the installment details provided by the specified payment method.
child ATTRIBUTES
data Object
Object that contains the list of installment object that's related to the specified payment method
child ATTRIBUTES
total_amount Number
This field shows the available installment the merchant can offer the customer with the total amount adjusted to include the interest and fees
installment_number Number
This field shows the total number of payments associated with the installment plan.
installment_amount Number
This field shows the total payment amount associated with the installment plan. This will indicate what amount the customer will pay per installment payment.
promotions
This object represents the promotion details provided by the specified payment method.
child ATTRIBUTES
data Object
Object that contains the list of promotion object that's related to the specified payment method
child ATTRIBUTES
discount_amount Number
This field shows the amount of discount as part of this promotion.
max_original_amount Number
This field shows the maximum original payment amount that qualifies this promotion.
min_original_amount Number
This field shows the minimum original payment amount that qualifies this promotion.
discount_code String
This field represents the discount code that's associated with this promotion.
expiry Number
This field represents the timestamp when this promotion expires.
issuer String
This field represents the issuer of this promotion.
balance Number
This field represents the remaining balance allocated for this promotion.
token_payment Boolean
This field indicates if a token payment is required for this promotion.
WEBHOOK / IPN
Webhooks are used for Citcon to update merchants on transaction status change. If the merchants would like to to get notified when a payment or refund has been successful or a chargeback has been initiated, they would use Webhooks. Upon status change, Citconasynchronously sends an HTTP POST to the webhook URL and passes in the parameters as followed: (Please note that the IPN param in the transaction needs to be set if you wish to receive status updates via webhook)
Name
Value
id
The Citcon transaction_ id that was provided as part of the original transaction was processed.
transaction_type
The transaction type related to the webhook charge, refund. chargeback, Vault
reference
Merchant reference associated with the transactions
amount
For charge and refund, it is transaction amount, the same meaning ofamount in transactions. For chargeback. it is directly associated with the amount being contested or won / lost
currency
Currency related to the transaction that was processed
status
The new transaction status:
- charge transactions.
- values may be: authorized, captured, success,
- refund transactions.
- values may be: success, fail
- chargeback transactions.
- values may be: “Notification of Claim”, “Request For Informa-tion”, “Information Supplied”, “Lost”. “Won”. “Case Closed”
- Vault.
- values may be: success, fail
time_completed
Timestamp of the point when the transaction was completed.
time_created
Timestamp of the point when the transaction was created.
The payment method associated with this transaction. As followed are some sample values, though it’s not the complete list.
The payment method associated with this transaction. As followed are some sample values, though it’s not the complete list.
payment_method
- paypal
- card
- venmo
amount_captured
Captured amount for the charge, only visible for charge transaction
amount_refunded
Refunded amount for the charge. only visible for charge transaction
fields
These are the fields participated in generating the signing signature
A JSON string that includes specific data related to the token. Thisparam is returned as part of the Vault transaction type and includesthe below information as an example.
payment
“NtokenVA-111-222-333V.Vtypen”VisaVA”dataVVpan \ “378282*0005V,Vexpiry V12/12VD”
UPI Error Codes
Code
Message
http_status
4000
bad request
400
4203
bad request
406
4201
bad request
406
4200
charge failed
406
4204
deletion failed
406
4100
duplicate request
400
4107
gateway error
508
4105
gateway timeout
508
4106
gateway unavailable
508
5100
internal server error
500
4102
invalid header
400
4205
modification failed
406
4103
not found
404
4202
refund failed
406
2000
success
200
4010
unauthorized
401
4101
unknown error
500
4206
vault failed
406