UPI RuPay transaction created

UPI RuPay transaction event. The following endpoint generates this event: Transfer funds

Type: object
Domain: upi-api
Event: upi_rupay
Version: 1

|
account_reference_number required

Title: Account reference number
Description: Payer card account reference number
Type: string
Example:
789012000087442038

external_transaction_id required

Title: External transaction ID
Description: Provider-assigned unique transaction ID
Type: string
Example:
MGS46F7F8F81EC6486695D18E6541E8FF82

mcc required

Title: Merchant category code
Description: Provider-assigned ISO 18245 4-digit merchant category code for this transaction
Type: string
Example:
6012

merchant_name required

Title: Merchant name
Description: Merchant name
Type: string
Example:
Cafe Coffee Day

phone required

Title: Phone
Type: object

country_code required

Title: Country phone code
Description: ISO 3166 phone country code. For example: 91 = India
Type: string
Example:
91

phone required

Title: Phone
Description: Payer's phone number
Type: string
Example:
9792714978

upi_reference_number required

Title: UPI reference number
Description: National Payments Corporation of India's (NPCI) assigned 12-digit code for this transaction
Type: string
Example:
7D70AE03F327

transaction_type required

Title: Transaction type
Description: Transaction type. C = Credit, D = Debit, R = Reversal
Type: string
Must be one of the following:
D
C
R
Example:
D

card_bin required

Title: Card BIN
Description: Payer card's Bank Identifcation Number (BIN)
Type: string
Example:
553376

card_last_4_digit required

Title: Card's last 4 digits
Description: Last 4 PAN digits of payer's card
Type: string
Example:
2242

credit_account_number required

Title: Credit account number
Description: Payee's virtual private address
Type: string
Example:
paytmqr2810bt4a521u@paytm

card_status required

Title: Card status
Description: Card's current status
Type: string
Must be one of the following:
CREATED
NORMAL
BLOCKED
INOPERATIVE
UNBOUND
REISSUED
PENDING
WARNING
LOST
ROBBED
EXPIRED
DAMAGED
FRAUD
CANCELED
DELETED
BROKEN
DEFECT
Example:
NORMAL

transaction_status required

Title: Transaction status
Description: Transaction's current status
Type: string
Must be one of the following:
ACCEPTED
CANCELLED
PROCESSING
FAILED
Example:
ACCEPTED

{
    "$schema": "http://json-schema.org/draft-07/schema",
    "type": "object",
    "title": "UPI RuPay transaction created",
    "description": "UPI RuPay transaction event. The following endpoint generates this event:  <a href='https://developers.pismo.io/pismo-docs/reference/post-funds-transfer' >Transfer funds</a>",
    "examples": [
        {
            "domain": "upi",
            "event_type": "upi_rupay",
            "schema_version": 1,
            "org_id": "TN-cf522199-6ea9-43a7-b0b7-d7d49914734d",
            "cid": "51011dc9-5ecf-49c9-9fe4-1a7b14dfaf54",
            "timestamp": "2024-10-13T18:39:33Z",
            "data": {
                "account_reference_number": "789012000087442038",
                "external_transaction_id": "MGS46F7F8F81EC6486695D18E6541E8FF82",
                "mcc": "6012",
                "merchant_name": "Cafe Coffee Day",
                "phone": {
                    "country_code": "91",
                    "phone": "9792714987"
                },
                "upi_reference_number": "7D70AE03F327",
                "transaction_type": "D",
                "card_bin": "553376",
                "card_last_4_digit": "2242",
                "credit_account_number": "paytmqr2810bt4a521u@paytm",
                "card_status": "NORMAL",
                "transaction_status": "ACCEPTED"
            }
        }
    ],
    "required": [
        "account_reference_number",
        "external_transaction_id",
        "mcc",
        "merchant_name",
        "phone",
        "upi_reference_number",
        "transaction_type",
        "card_bin",
        "card_last_4_digit",
        "credit_account_number",
        "card_status",
        "transaction_status"
    ],
    "properties": {
        "account_reference_number": {
            "type": "string",
            "title": "Account reference number",
            "description": "Payer card account reference number",
            "examples": [
                "789012000087442038"
            ]
        },
        "external_transaction_id": {
            "type": "string",
            "title": "External transaction ID",
            "description": "Provider-assigned unique transaction ID",
            "examples": [
                "MGS46F7F8F81EC6486695D18E6541E8FF82"
            ]
        },
        "mcc": {
            "type": "string",
            "title": "Merchant category code",
            "description": "Provider-assigned ISO 18245 4-digit merchant category code for this transaction",
            "examples": [
                "6012"
            ]
        },
        "merchant_name": {
            "type": "string",
            "title": "Merchant name",
            "description": "Merchant name",
            "examples": [
                "Cafe Coffee Day"
            ]
        },
        "phone": {
            "type": "object",
            "title": "Phone",
            "required": [
                "country_code",
                "phone"
            ],
            "properties": {
                "country_code": {
                    "type": "string",
                    "title": "Country phone code",
                    "description": "ISO 3166 phone country code. For example: 91 = India",
                    "examples": [
                        "91"
                    ]
                },
                "phone": {
                    "type": "string",
                    "title": "Phone",
                    "description": "Payer's phone number",
                    "examples": [
                        "9792714978"
                    ]
                }
            }
        },
        "upi_reference_number": {
            "type": "string",
            "title": "UPI reference number",
            "description": "National Payments Corporation of India's (NPCI) assigned 12-digit code for this transaction",
            "examples": [
                "7D70AE03F327"
            ]
        },
        "transaction_type": {
            "type": "string",
            "title": "Transaction type",
            "description": "Transaction type. C = Credit, D = Debit, R = Reversal",
            "enum": [
                "D",
                "C",
                "R"
            ],
            "examples": [
                "D"
            ]
        },
        "card_bin": {
            "type": "string",
            "title": "Card BIN",
            "description": "Payer card's Bank Identifcation Number (BIN)",
            "examples": [
                "553376"
            ]
        },
        "card_last_4_digit": {
            "type": "string",
            "title": "Card's last 4 digits",
            "description": "Last 4 PAN digits of payer's card",
            "examples": [
                "2242"
            ]
        },
        "credit_account_number": {
            "type": "string",
            "title": "Credit account number",
            "description": "Payee's virtual private address",
            "examples": [
                "paytmqr2810bt4a521u@paytm"
            ]
        },
        "card_status": {
            "type": "string",
            "title": "Card status",
            "description": "Card's current status",
            "enum": [
                "CREATED",
                "NORMAL",
                "BLOCKED",
                "INOPERATIVE",
                "UNBOUND",
                "REISSUED",
                "PENDING",
                "WARNING",
                "LOST",
                "ROBBED",
                "EXPIRED",
                "DAMAGED",
                "FRAUD",
                "CANCELED",
                "DELETED",
                "BROKEN",
                "DEFECT"
            ],
            "examples": [
                "NORMAL"
            ]
        },
        "transaction_status": {
            "type": "string",
            "title": "Transaction status",
            "description": "Transaction's current status",
            "enum": [
                "ACCEPTED",
                "CANCELLED",
                "PROCESSING",
                "FAILED"
            ],
            "examples": [
                "ACCEPTED"
            ]
        }
    }
}
{
    "domain": "upi",
    "event_type": "upi_rupay",
    "schema_version": 1,
    "org_id": "TN-cf522199-6ea9-43a7-b0b7-d7d49914734d",
    "cid": "51011dc9-5ecf-49c9-9fe4-1a7b14dfaf54",
    "timestamp": "2024-10-13T18:39:33Z",
    "data": {
        "account_reference_number": "789012000087442038",
        "external_transaction_id": "MGS46F7F8F81EC6486695D18E6541E8FF82",
        "mcc": "6012",
        "merchant_name": "Cafe Coffee Day",
        "phone": {
            "country_code": "91",
            "phone": "9792714987"
        },
        "upi_reference_number": "7D70AE03F327",
        "transaction_type": "D",
        "card_bin": "553376",
        "card_last_4_digit": "2242",
        "credit_account_number": "paytmqr2810bt4a521u@paytm",
        "card_status": "NORMAL",
        "transaction_status": "ACCEPTED"
    }
}