npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@datafire/mastercard_masterpassqr

v3.0.0

Published

DataFire integration for Send Person to Merchant

Downloads

2

Vulnerabilities

Powered byPowered by Snyk
  • 0High
  • 0Medium
  • 0Low

Links

Git

Maintainers

datafiredatafire

Keywords

Readme

@datafire/mastercard_masterpassqr

Client library for Send Person to Merchant

Installation and Usage

npm install --save @datafire/mastercard_masterpassqr
let mastercard_masterpassqr = require('@datafire/mastercard_masterpassqr').create();

.then(data => {
  console.log(data);
});

Description

Actions

createMerchantTransfer

Initiates a Mastercard Merchant Presented QR purchase transaction by securing funds from a consumer’s account with a Funding Transaction and pushing funds to a merchant account with a Payment Transaction.

mastercard_masterpassqr.createMerchantTransfer({
  "partnerId": "",
  "merchant_transfer": null
}, context)

Input

  • input object

Output

getMerchantTransferByRef

Purpose of this service is to retrieve the Transfer resource associated with a specified transfer_reference value.

mastercard_masterpassqr.getMerchantTransferByRef({
  "partnerId": "",
  "ref": ""
}, context)

Input

  • input object
    • partnerId required string: Path Param - Provider assigned partner id. Details - string, 32
    • ref required string: Query Param - Is the client specified transfer reference when initiating the transfer. Allowable characters are alphanumeric and * , - . _ ~. Details- 6-40 Example- DEF123456

Output

createMerchantPayment

Initiates a Mastercard Merchant Presented QR purchase transaction by pushing funds to a merchant account.

mastercard_masterpassqr.createMerchantPayment({
  "partnerId": ""
}, context)

Input

Output

createMerchantRefund

Initiates a Mastercard Merchant Presented QR Refund transaction by pushing funds from a merchant account back to the customer's account.

mastercard_masterpassqr.createMerchantRefund({
  "partnerId": ""
}, context)

Input

Output

getMerchantTransferById

Purpose of this service is to retrieve the Transfer resource associated with the specified transfer-id.

mastercard_masterpassqr.getMerchantTransferById({
  "partnerId": "",
  "transferId": ""
}, context)

Input

  • input object
    • partnerId required string: Path Param - Provider assigned partner id. Details - string, 32
    • transferId required string: Path Param - Valid transfer id

Output

createFundingReversal

Funding Reversals must be submitted within 30 minutes of the funding transfer request, and should only be submitted for the following conditions: Funding Transaction must be reversed if payment transaction cannot complete successfully, i.e. the payment transaction is rejected or declined. Upon a successful reversal of a funding transaction, the refund must be credited to the sending consumer’s Funding Account.

mastercard_masterpassqr.createFundingReversal({
  "partner-id": "",
  "transfer-id": "",
  "transaction-id": ""
}, context)

Input

  • input object
    • partner-id required string: Path Param - Provider assigned partner id. Details - string, 32
    • transfer-id required string: Valid transfer id
    • transaction-id required string: Valid transaction id
    • funding_reversal FundingReversal_144_wrapper

Output

sendNotificationPaymentRetry

Client can simulate a Mastercard Merchant Presented QR Payment notification to the registered URL endpoint.

mastercard_masterpassqr.sendNotificationPaymentRetry({
  "partnerId": ""
}, context)

Input

Output

sendNotificationRefundRetry

Client can simulate a Mastercard Merchant Presented QR Refund notification to the registered URL endpoint.

mastercard_masterpassqr.sendNotificationRefundRetry({
  "partnerId": ""
}, context)

Input

Output

createTransferNotificationRegistration

This service allows Mastercard Merchant QR originating and receiving partners to register a PAN and service provider to receive notifications on an inbound Merchant Refund or Merchant Payment Transaction.

mastercard_masterpassqr.createTransferNotificationRegistration({
  "partnerId": ""
}, context)

Input

  • input object
    • partnerId required string: Path Param - Provider assigned partner id. Type: Alphanumeric Special Length: 40
    • accountregistration Accountregistration_167_wrapper

Output

deleteTransferNotificationRegistration

This service allows Mastercard Merchant QR originating and receiving partners to delete a registered PAN for notifications.

mastercard_masterpassqr.deleteTransferNotificationRegistration({
  "partnerId": "",
  "account-reg-ref": ""
}, context)

Input

  • input object
    • partnerId required string: Path Param - Provider assigned partner id. Type: Alphanumeric Special Length: 40
    • account-reg-ref required string: Path Param - System generated unique account registration identifier. Type: Alphanumeric Special Length: 40

Output

NotificationRegistrationAPIReadBy

This service allows Mastercard Merchant QR originating and receiving partners to retrieve the service provider's information for a registered PAN for notifications.

mastercard_masterpassqr.NotificationRegistrationAPIReadBy({
  "partnerId": "",
  "account-reg-ref": ""
}, context)

Input

  • input object
    • partnerId required string: Path Param - Provider assigned partner id. Type: Alphanumeric Special Length: 40
    • account-reg-ref required string: Path Param - System generated unique account registration identifier. Type: Alphanumberic Special Length: 40

Output

NotificationRegistrationAPIUpdate

This service allows Mastercard Merchant QR originating and receiving partners to update the notitification service provider for a registered PAN.

mastercard_masterpassqr.NotificationRegistrationAPIUpdate({
  "partnerId": "",
  "account-reg-ref": ""
}, context)

Input

  • input object
    • partnerId required string: Path Param - Provider assigned partner id. Type: Alphanumeric Special Length: 40
    • account-reg-ref required string: Path Param - System generated unique account registration identifier. Type: Alphanumeric Special Length: 40
    • accountregistration Accountregistration_169_wrapper

Output

createFunding

The Funding Transaction enables the 'pull' of money from the sender's card to the Transaction Originator who is providing the Person to Merchant service. The amount that is debited from the Funding Account (sending consumer's account) will be the amount 'pushed' to the recipient via a payment transfer request. Funds can be transferred from Mastercard® or Maestro® debit card accounts. To initiate the funding transaction, users can provide the sending consumer's Primary Account Number (PAN) or a unique identifier previously mapped to the sending consumer's account.

mastercard_masterpassqr.createFunding({
  "partnerId": ""
}, context)

Input

  • input object

Output

createDigitalAccntRefNum

Used to create a digital account reference number from Incontrol

mastercard_masterpassqr.createDigitalAccntRefNum({
  "partnerId": ""
}, context)

Input

Output

retrieveDigitalAccntRefNumList

Used to retreive a digital account reference list from Incontrol

mastercard_masterpassqr.retrieveDigitalAccntRefNumList({
  "partnerId": ""
}, context)

Input

  • input object
    • partnerId required string: Path Param - Provider assigned partner id. Details - string, 32
    • digital_account DigitalAccount_89_wrapper

Output

Definitions

Accountregistration_167

  • Accountregistration_167 object: Contains the details of the request message.
    • account_uri required string: URI describing the account. It must be a direct account reference, i.e. URI scheme must be pan. Valid Values- Refer 'Account URIs'.
    • notification_partner_id required string: Service provider partner id being registered to receive notifications. Type: Alphanumeric Special Length: 40

Accountregistration_167_wrapper

  • Accountregistration_167_wrapper object: Contains the details of the request message.

Accountregistration_168

  • Accountregistration_168 object: Response details
    • account_registration_reference string: System generated unique account registration identifier. Type: Alphanumeric Special Length: 40
    • account_uri string: URI describing the account. It will be a direct account reference, i.e. URI scheme will be pan. Valid Values- Refer 'Account URIs'.
    • notification_partner_id string: Service provider partner id registered to receive notifications. Type: Alphanumeric Special Length: 40
    • notification_partner_name string: Name of the service provider partner id registered. Type: Alphanumeric Special Length: 100

Accountregistration_168_wrapper

Accountregistration_169

  • Accountregistration_169 object: Contains the details of the request message.
    • account_uri required string: URI describing the account. It must be a direct account reference, i.e. URI scheme must be pan. Valid Values- Refer 'Account URIs'.
    • notification_partner_id required string: Service provider partner id being registered to receive notifications. Type: Alphanumeric Special Length: 40

Accountregistration_169_wrapper

  • Accountregistration_169_wrapper object: Contains the details of the request message.

Accountregistration_170

  • Accountregistration_170 object: Response details
    • account_registration_reference string: System generated unique account registration identifier. Type: Alphanumeric Special Length: 40
    • account_uri string: URI describing the account. It will be a direct account reference, i.e. URI scheme will be pan. Valid Values- Refer 'Account URIs'.
    • notification_partner_id string: Service provider partner id registered to receive notifications. Type: Alphanumeric Special Length: 40
    • notification_partner_name string: Name of the service provider partner id registered. Type: Alphanumeric Special Length: 100

Accountregistration_170_wrapper

Accountregistration_171

  • Accountregistration_171 object: Response details
    • account_registration_reference string: System generated unique account registration identifier. Type: Alphanumeric Special Length: 40
    • account_uri string: URI describing the account. It will be a direct account reference, i.e. URI scheme will be pan. Valid Values- Refer 'Account URIs'.
    • notification_partner_id string: Service provider partner id registered to receive notifications. Type: Alphanumeric Special Length: 40
    • notification_partner_name string: Name of the service provider partner id registered. Type: Alphanumeric Special Length: 100

Accountregistration_171_wrapper

Accountregistration_172

  • Accountregistration_172 object: Response details
    • account_registration_reference string: System generated unique account registration identifier. Type: Alphanumberic Special Length: 40
    • account_uri string: URI describing the account. It will be a direct account reference, i.e. URI scheme will be pan. Valid Values- Refer 'Account URIs'.
    • notification_partner_id string: Service provider partner id registered to receive notifications. Type: Alphanumeric Special Length: 40
    • notification_partner_name string: Name of the service provider partner id registered. Type: Alphanumeric Special Length: 100

Accountregistration_172_wrapper

AdditionalMerchantData_109

  • AdditionalMerchantData_109 object: Additional merchant data of recipient
    • payment_facilitator_id integer: This ID is the Company ID that will be assigned during the time of registration with Mastercard for a Service Provider as Payment Facilitator. Type: Numeric [0-9],Maximum-Length: 11.
    • sub_merchant_id string: The Sub-Merchant ID must always be the merchant ID of the sub-merchant whenever a payment facilitator is involved in a transaction,Type: Alphanumeric [a-zA-Z 0-9],Maximum-Length: 15

AdditionalMerchantData_121

  • AdditionalMerchantData_121 object: Additional merchant data of sender.
    • payment_facilitator_id required integer: This ID is the Company ID that will be assigned during the time of registration with Mastercard for a Service Provider as Payment Facilitator. Type: Numeric [0-9] Length: 1-11.
    • sub_merchant_id required string: The Sub-Merchant ID must always be the merchant ID of the sub-merchant whenever a payment facilitator is involved in a transaction. Type: Alphanumeric [a-zA-Z 0-9], Length: 1-15.

AdditionalMerchantData_132

  • AdditionalMerchantData_132 object: Additional merchant data of sender
    • payment_facilitator_id integer: This ID is the Company ID that will be assigned during the time of registration with Mastercard for a Service Provider as Payment Facilitator. Type: Numeric [0-9], Maximum-Length: 11.
    • sub_merchant_id string: The Sub-Merchant ID must always be the merchant ID of the sub-merchant whenever a payment facilitator is involved in a transaction. Type: Alphanumeric [a-zA-Z 0-9], Maximum-Length: 15.

AdditionalMerchantData_17

  • AdditionalMerchantData_17 object: Additional merchant data of sender.
    • payment_facilitator_id integer: This ID is the Company ID that will be assigned during the time of registration with Mastercard for a Service Provider as Payment Facilitator. Type: Numeric [0-9], Maximum-Length: 11.
    • sub_merchant_id string: The Sub-Merchant ID must always be the merchant ID of the sub-merchant whenever a payment facilitator is involved in a transaction. Type: Alphanumeric [a-zA-Z 0-9], Maximum- Length: 15.

AdditionalMerchantData_20

  • AdditionalMerchantData_20 object: Additional merchant data of recipient
    • payment_facilitator_id integer: This ID is the Company ID that will be assigned during the time of registration with Mastercard for a Service Provider as Payment Facilitator. Type: Numeric [0-9], Maximum-Length: 11.
    • sub_merchant_id string: The Sub-Merchant ID must always be the merchant ID of the sub-merchant whenever a payment facilitator is involved in a transaction. Type: Alphanumeric [a-zA-Z 0-9], Maximum-Length: 15.

AdditionalMerchantData_34

  • AdditionalMerchantData_34 object: Additional merchant data of recipient
    • payment_facilitator_id required integer: This ID is the Company ID that will be assigned during the time of registration with Mastercard for a Service Provider as Payment Facilitator. Type: Numeric [0-9],Length: 1-11
    • sub_merchant_id required string: The Sub-Merchant ID must always be the merchant ID of the sub-merchant whenever a payment facilitator is involved in a transaction, Type :Alphanumeric [a-zA-Z 0-9] , Maximum- Length : 1-15

AdditionalMerchantData_45

  • AdditionalMerchantData_45 object: Additonal merchant data of recipient.
    • payment_facilitator_id integer: This ID is the Company ID that will be assigned during the time of registration with Mastercard for a Service Provider as Payment Facilitator. Type: Numeric [0-9],Maximum-Length: 11
    • sub_merchant_id string: The Sub-Merchant ID must always be the merchant ID of the sub-merchant whenever a payment facilitator is involved in a transaction, Type :Alphanumeric [a-zA-Z 0-9] , Maximum- Length :15

AdditionalMerchantData_5

  • AdditionalMerchantData_5 object: Additional merchant data of sender.
    • payment_facilitator_id required integer: This ID is the Company ID that will be assigned during the time of registration with Mastercard for a Service Provider as Payment Facilitator. Type: Numeric [0-9], Length:1- 11.
    • sub_merchant_id required string: The Sub-Merchant ID must always be the merchant ID of the sub-merchant whenever a payment facilitator is involved in a transaction. Type: Alphanumeric [a-zA-Z 0-9], Length: 1-15.

AdditionalMerchantData_57

  • AdditionalMerchantData_57 object: Additional merchant data of sender.
    • payment_facilitator_id integer: This ID is the Company ID that will be assigned during the time of registration with Mastercard for a Service Provider as Payment Facilitator.Type:Numeric [0-9], Maximum-Length: 11.
    • sub_merchant_id string: The Sub-Merchant ID must always be the merchant ID of the sub-merchant whenever a payment facilitator is involved in a transaction, Type: Alphanumeric [a-zA-Z 0-9], Maximum-Length: 15

AdditionalMerchantData_60

  • AdditionalMerchantData_60 object: Additional merchant data of recipinet.
    • payment_facilitator_id integer: This ID is the Company ID that will be assigned during the time of registration with Mastercard for a Service Provider as Payment Facilitator.Type:Numeric [0-9], Maximum-Length: 11.
    • sub_merchant_id string: The Sub-Merchant ID must always be the merchant ID of the sub-merchant whenever a payment facilitator is involved in a transaction, Type: Alphanumeric [a-zA-Z 0-9], Maximum-Length: 15

AdditionalMerchantData_74

  • AdditionalMerchantData_74 object: Additional merchant data of sender.
    • payment_facilitator_id integer: This ID is the Company ID that will be assigned during the time of registration with Mastercard for a Service Provider as Payment Facilitator.Type:Numeric [0-9],Maximum-Length: 11.
    • sub_merchant_id string: The Sub-Merchant ID must always be the merchant ID of the sub-merchant whenever a payment facilitator is involved in a transaction, Type: Alphanumeric [a-zA-Z 0-9],Maximum-Length: 15

AdditionalMerchantData_77

  • AdditionalMerchantData_77 object: Additional merchant data of recipient.
    • payment_facilitator_id integer: This ID is the Company ID that will be assigned during the time of registration with Mastercard for a Service Provider as Payment Facilitator.Type:Numeric [0-9],Maximum-Length: 11.
    • sub_merchant_id string: The Sub-Merchant ID must always be the merchant ID of the sub-merchant whenever a payment facilitator is involved in a transaction, Type: Alphanumeric [a-zA-Z 0-9],Maximum-Length: 15

AdditionalMerchantData_9

  • AdditionalMerchantData_9 object: Additional merchant data of recipient.
    • payment_facilitator_id required integer: This ID is the Company ID that will be assigned during the time of registration with Mastercard for a Service Provider as Payment Facilitator. Type: Numeric [0-9] Length: 1-11.
    • sub_merchant_id required string: The Sub-Merchant ID must always be the merchant ID of the sub-merchant whenever a payment facilitator is involved in a transaction. Type: Alphanumeric [a-zA-Z 0-9], Length: 1-15.

AdditionalMerchantData_98

  • AdditionalMerchantData_98 object: Additional merchant data of recipient.
    • payment_facilitator_id required integer: This ID is the Company ID that will be assigned during the time of registration with Mastercard for a Service Provider as Payment Facilitator.Type: Numeric [0-9], Length:1- 11.
    • sub_merchant_id required string: The Sub-Merchant ID must always be the merchant ID of the sub-merchant whenever a payment facilitator is involved in a transaction, Type: Alphanumeric [a-zA-Z 0-9],Length:1- 15

Address_106

  • Address_106 object: Address of the sender.
    • city string: City of the sender. Details- 1-25
    • country string: Country of the sender as an ISO alpha country code. Details- Alpha, Length: 3
    • country_subdivision string: State or province of the sender. If the payment_transfer.sender.address.country is USA or CAN, the country subdivision is required. Details- Conditional, Alpha, 2-3
    • line1 string: First line of the address of the sender. Details- 1-50
    • line2 string: Second line of the address of the sender. Details- 1-50
    • postal_code string: Postal code of the sender. Format in 5 digits or 5 digits hyphen 4 digits. Details numeric length: 5 or 5-4

Address_108

  • Address_108 object: Address of the recipient/merchant.
    • city string: City of the recipient/merchant.
    • country string: Country of the recipient as an ISO alpha country code.
    • country_subdivision string: State or province of the recipient/merchant.
    • line1 string: First line of the address of the recipient/merchant.
    • line2 string: Second line of the address of the recipient/merchant.
    • postal_code string: Postal code of the recipient/merchant.

Address_120

  • Address_120 object: Sender's home address.
    • city string: Home city. Details- 1-25
    • country string: The sender's home country as an ISO 3166-1 alpha-3 country code, in uppercase. Conditional - required if Sanction Screening validation is enabled. Details- alpha-3
    • country_subdivision string: Home state or province. US or Canada country subdivision code is required. Details- 2-3
    • line1 string: First line of sender's home address. Details- 1-50
    • line2 string: Second line of sender's home address. Details- 1-50
    • postal_code string: Home postal code. Format in 5 digits or 5 digits hyphen 4 digits. Details numeric length: 5 or 5-4

Address_124

  • Address_124 object: Recipient's home address.
    • city required string: Home city. Details- 1-25
    • country required string: The recipient's home country as an ISO 3166-1 alpha-3 country code, in uppercase. Details- alpha-3
    • country_subdivision string: Home state or province. US or Canada country subdivision code is required. Details- 2-3
    • line1 required string: First line of recipient's home address. Details- 1-50
    • line2 string: Second line of recipient's home address. Details- 1-50
    • postal_code required string: Home postal code. Format in 5 digits or 5 digits hyphen 4 digits. Details numeric length: 5 or 5-4

Address_131

  • Address_131 object: Address of the sender.
    • city string: City of the sender.
    • country string: Country of the sender as an ISO alpha country code.
    • country_subdivision string: State or province of the sender.
    • line1 string: First line of the address of the sender.
    • line2 string: Second line of the address of the sender.
    • postal_code string: Postal code of the sender.

Address_135

  • Address_135 object: Address of the recipient.
    • city string: City of the recipient
    • country string: Country of the recipient as an ISO alpha country code.
    • country_subdivision string: State or province of the recipient.
    • line1 string: First line of the address of the recipient.
    • line2 string: Second line of the address of the recipient.
    • postal_code string: Postal code of the recipient.

Address_147

  • Address_147 object: Address of the sender.
    • city string: City of the sender.
    • country string: Country of the sender as an ISO alpha country code.
    • country_subdivision string: State or province of the sender.
    • line1 string: First line of the address of the sender.
    • line2 string: Second line of the address of the sender.
    • postal_code string: Postal code of the sender.

Address_150

  • Address_150 object: Address of the recipient.
    • city string: City of the recipient
    • country string: Country of the recipient as an ISO alpha country code.
    • country_subdivision string: State or province of the recipient.
    • line1 string: First line of the address of the recipient.
    • line2 string: Second line of the address of the recipient.
    • postal_code string: Postal code of the recipient.

Address_16

  • Address_16 object: Address of the sender.
    • city string: City of the sender. \n\nType: Alphanumeric Special [a-zA-Z0-9 !"#$%&'()*+,-./:;<=>?@[]_`{|}~ÀÁÂÃÄÅÇÈÉÊËÌÍÎÏÑÒÓÔÕÖÙÚÚÚÝàáâãäåçèéêëìíîïñòóôõöùúûüýÿ], Maximum Length: 25
    • country string: Country of the sender as an ISO alpha country code.
    • country_subdivision string: State or province of the sender. If the merchant_transfer.sender.address.country is USA or CAN, the country subdivision is required.
    • line1 string: First line of the address of the sender. \n\nType: Alphanumeric Special [a-zA-Z0-9 !"#$%&'()*+,-./:;<=>?@[]_`{|}~ÀÁÂÃÄÅÇÈÉÊËÌÍÎÏÑÒÓÔÕÖÙÚÚÚÝàáâãäåçèéêëìíîïñòóôõöùúûüýÿ], Maximum Length: 50
    • line2 string: Second line of the address of the sender. \n\nType: Alphanumeric Special [a-zA-Z0-9 !"#$%&'()*+,-./:;<=>?@[]_`{|}~ÀÁÂÃÄÅÇÈÉÊËÌÍÎÏÑÒÓÔÕÖÙÚÚÚÝàáâãäåçèéêëìíîïñòóôõöùúûüýÿ], Maximum Length: 50
    • postal_code string: Postal code of the sender.

Address_19

  • Address_19 object: Address of the recipient/merchant.
    • city string: City of the recipient/merchant.\n\nType: Alphanumeric Special [a-zA-Z0-9 !"#$%&'()*+,-./:;<=>?@[]_`{|}~ÀÁÂÃÄÅÇÈÉÊËÌÍÎÏÑÒÓÔÕÖÙÚÚÚÝàáâãäåçèéêëìíîïñòóôõöùúûüýÿ], Maximum Length: 25
    • country string: Country of the recipient as an ISO alpha country code.
    • country_subdivision string: State or province of the recipient/merchant. If the merchant_transfer.recipient.address.country is USA or CAN, the country subdivision code is required.
    • line1 string: First line of the address of the recipient/merchant.\n\nType: Alphanumeric Special [a-zA-Z0-9 !"#$%&'()*+,-./:;<=>?@[]_`{|}~ÀÁÂÃÄÅÇÈÉÊËÌÍÎÏÑÒÓÔÕÖÙÚÚÚÝàáâãäåçèéêëìíîïñòóôõöùúûüýÿ], Maximum Length: 50
    • line2 string: Second line of the address of the recipient/merchant.\n\nType: Alphanumeric Special [a-zA-Z0-9 !"#$%&'()*+,-./:;<=>?@[]_`{|}~ÀÁÂÃÄÅÇÈÉÊËÌÍÎÏÑÒÓÔÕÖÙÚÚÚÝàáâãäåçèéêëìíîïñòóôõöùúûüýÿ], Maximum Length: 50
    • postal_code string: Postal code of the recipient.

Address_31

  • Address_31 object: Address of the sender. Optional.
    • city required string: City of the sender.\n\nType: Alphanumeric Special [a-zA-Z0-9 !"#$%&'()*+,-./:;<=>?@[]_`{|}~ÀÁÂÃÄÅÇÈÉÊËÌÍÎÏÑÒÓÔÕÖÙÚÚÚÝàáâãäåçèéêëìíîïñòóôõöùúûüýÿ], Length: 1-25
    • country required string: Country of the sender as an ISO alpha country code. Details- Alpha, Length: 3
    • country_subdivision string: State or province of the sender. If the payment_transfer.sender.address.country is USA or CAN, the country subdivision is required. Details- Conditional, Alpha, 2-3
    • line1 string: First line of the address of the sender.\n\nType: Alphanumeric Special [a-zA-Z0-9 !"#$%&'()*+,-./:;<=>?@[]_`{|}~ÀÁÂÃÄÅÇÈÉÊËÌÍÎÏÑÒÓÔÕÖÙÚÚÚÝàáâãäåçèéêëìíîïñòóôõöùúûüýÿ], Length: 1-50
    • line2 string: Second line of the address of the sender.\n\nType: Alphanumeric Special [a-zA-Z0-9 !"#$%&'()*+,-./:;<=>?@[]_`{|}~ÀÁÂÃÄÅÇÈÉÊËÌÍÎÏÑÒÓÔÕÖÙÚÚÚÝàáâãäåçèéêëìíîïñòóôõöùúûüýÿ], Length: 1-50
    • postal_code string: Postal code of the sender. Format in 5 digits or 5 digits hyphen 4 digits. Details numeric length: 5 or 5-4

Address_33

  • Address_33 object: Address of the recipient/merchant.
    • city required string: City of the recipient/merchant.\n\nType: Alphanumeric Special [a-zA-Z0-9 !"#$%&'()*+,-./:;<=>?@[]_`{|}~ÀÁÂÃÄÅÇÈÉÊËÌÍÎÏÑÒÓÔÕÖÙÚÚÚÝàáâãäåçèéêëìíîïñòóôõöùúûüýÿ], Length: 1-25
    • country required string: The recipient's/merchant's home country as an ISO 3166-1 alpha-3 country code, in uppercase. Details- Alpha, Length: 3
    • country_subdivision string: State or province of the recipient/merchant. If the merchant_transfer.recipient.address.country is USA or CAN, the country subdivision code is required.
    • line1 string: First line of the address of the recipient/merchant.\n\nType: Alphanumeric Special [a-zA-Z0-9 !"#$%&'()*+,-./:;<=>?@[]_`{|}~ÀÁÂÃÄÅÇÈÉÊËÌÍÎÏÑÒÓÔÕÖÙÚÚÚÝàáâãäåçèéêëìíîïñòóôõöùúûüýÿ], Length: 1-50
    • line2 string: Second line of the address of the recipient/merchant.\n\nType: Alphanumeric Special [a-zA-Z0-9 !"#$%&'()*+,-./:;<=>?@[]_`{|}~ÀÁÂÃÄÅÇÈÉÊËÌÍÎÏÑÒÓÔÕÖÙÚÚÚÝàáâãäåçèéêëìíîïñòóôõöùúûüýÿ], Length: 1-50
    • postal_code string: Postal code of the recipient/merchant. Format in 5 digits or 5 digits hyphen 4 digits. Details numeric length: 5 or 5-4

Address_4

  • Address_4 object: Address of the sender. Optional
    • city required string: City of the sender.\n\nType: Alphanumeric Special [a-zA-Z0-9 !"#$%&'()*+,-./:;<=>?@[]_`{|}~ÀÁÂÃÄÅÇÈÉÊËÌÍÎÏÑÒÓÔÕÖÙÚÚÚÝàáâãäåçèéêëìíîïñòóôõöùúûüýÿ], Length: 1-25.
    • country required string: Country of the sender as an ISO alpha country code.
    • country_subdivision string: State or province of the sender. If the merchant_transfer.sender.address.country is USA or CAN, the country subdivision is required.
    • line1 string: First line of the address of the sender.\n\nType: Alphanumeric Special [a-zA-Z0-9 !"#$%&'()*+,-./:;<=>?@[]_`{|}~ÀÁÂÃÄÅÇÈÉÊËÌÍÎÏÑÒÓÔÕÖÙÚÚÚÝàáâãäåçèéêëìíîïñòóôõöùúûüýÿ], Length: 1-50
    • line2 string: Second line of the address of the sender.\n\nType: Alphanumeric Special [a-zA-Z0-9 !"#$%&'()*+,-./:;<=>?@[]_`{|}~ÀÁÂÃÄÅÇÈÉÊËÌÍÎÏÑÒÓÔÕÖÙÚÚÚÝàáâãäåçèéêëìíîïñòóôõöùúûüýÿ], Length: 1-50
    • postal_code string: Postal code of the sender.

Address_42

  • Address_42 object: Address of the sender.
    • city string: City of the sender. Details- 1-25
    • country string: Country of the sender as an ISO alpha country code. Details- Alpha, Length: 3
    • country_subdivision string: State or province of the sender. If the payment_transfer.sender.address.country is USA or CAN, the country subdivision is required. Details- Conditional, Alpha, 2-3
    • line1 string: First line of the address of the sender. Details- 1-50
    • line2 string: Second line of the address of the sender. Details- 1-50
    • postal_code string: Postal code of the sender. Format in 5 digits or 5 digits hyphen 4 digits. Details numeric length: 5 or 5-4

Address_44

  • Address_44 object: Address of the recipient/merchant.
    • city string: City of the recipient/merchant.
    • country string: Country of the recipient as an ISO alpha country code.
    • country_subdivision string: State or province of the recipient/merchant.
    • line1 string: First line of the address of the recipient/merchant.
    • line2 string: Second line of the address of the recipient/merchant.
    • postal_code string: Postal code of the recipient/merchant.

Address_56

  • Address_56 object: Address of the sender.
    • city string: City of the sender. Details- 1-25
    • country string: Country of the sender as an ISO alpha country code. Details- Alpha, Length: 3
    • country_subdivision string: State or province of the sender. If the payment_transfer.sender.address.country is USA or CAN, the country subdivision is required. Details- Conditional, Alpha, 2-3
    • line1 string: First line of the address of the sender. Details- 1-50
    • line2 string: Second line of the address of the sender. Details- 1-50
    • postal_code string: Postal code of the sender. Format in 5 digits or 5 digits hyphen 4 digits. Details numeric length: 5 or 5-4

Address_59

  • Address_59 object: Address of the recipient/merchant.
    • city string: City of the recipient/merchant.
    • country string: Country of the recipient as an ISO alpha country code.
    • country_subdivision string: State or province of the recipient/merchant.
    • line1 string: First line of the address of the recipient/merchant.
    • line2 string: Second line of the address of the recipient/merchant.
    • postal_code string: Postal code of the recipient/merchant.

Address_73

  • Address_73 object: Address of the sender.
    • city string: City of the sender. Details- 1-25
    • country string: Country of the sender as an ISO alpha country code. Details- Alpha, Length: 3
    • country_subdivision string: State or province of the sender. If the payment_transfer.sender.address.country is USA or CAN, the country subdivision is required. Details- Conditional, Alpha, 2-3
    • line1 string: First line of the address of the sender. Details- 1-50
    • line2 string: Second line of the address of the sender. Details- 1-50
    • postal_code string: Postal code of the sender. Format in 5 digits or 5 digits hyphen 4 digits. Details numeric length: 5 or 5-4

Address_76

  • Address_76 object: Address of the recipient/merchant.
    • city string: City of the recipient/merchant.
    • country string: Country of the recipient/merchant as an ISO alpha country code.
    • country_subdivision string: State or province of the recipient/merchant.
    • line1 string: First line of the address of the recipient/merchant.
    • line2 string: Second line of the address of the recipient/merchant.
    • postal_code string: Postal code of the recipient/merchant.

Address_8

  • Address_8 object: Address of the recipient/merchant.
    • city required string: City of the recipient/merchant.\n\nType: Alphanumeric Special [a-zA-Z0-9 !"#$%&'()*+,-./:;<=>?@[]_`{|}~ÀÁÂÃÄÅÇÈÉÊËÌÍÎÏÑÒÓÔÕÖÙÚÚÚÝàáâãäåçèéêëìíîïñòóôõöùúûüýÿ], Length: 1-25
    • country required string: The recipient''s/merchant''s home country as an ISO 3166-1 alpha-3 country code.
    • country_subdivision string: State or province of the recipient/merchant. If the merchant_transfer.recipient.address.country is USA or CAN, the country subdivision code is required.
    • line1 string: First line of the address of the recipient/merchant.\n\nType: Alphanumeric Special [a-zA-Z0-9 !"#$%&'()*+,-./:;<=>?@[]_`{|}~ÀÁÂÃÄÅÇÈÉÊËÌÍÎÏÑÒÓÔÕÖÙÚÚÚÝàáâãäåçèéêëìíîïñòóôõöùúûüýÿ], Length: 1-50
    • line2 string: Second line of the address of the recipient/merchant.\n\nType: Alphanumeric Special [a-zA-Z0-9 !"#$%&'()*+,-./:;<=>?@[]_`{|}~ÀÁÂÃÄÅÇÈÉÊËÌÍÎÏÑÒÓÔÕÖÙÚÚÚÝàáâãäåçèéêëìíîïñòóôõöùúûüýÿ], Length: 1-50
    • postal_code string: Postal code of the receipent.

Address_95

  • Address_95 object: Address of the sender. If this field is included then city and country field are also required.
    • city required string: City of the sender.\n\nType: Alphanumeric Special [a-zA-Z0-9 !"#$%&'()*+,-./:;<=>?@[]_`{|}~ÀÁÂÃÄÅÇÈÉÊËÌÍÎÏÑÒÓÔÕÖÙÚÚÚÝàáâãäåçèéêëìíîïñòóôõöùúûüýÿ], Length: 1-25
    • country required string: Country of the sender as an ISO alpha country code. Details- Alpha, Length: 3
    • country_subdivision string: State or province of the sender. If the payment_transfer.sender.address.country is USA or CAN, the country subdivision is required. Details- Conditional, Alpha, 2-3
    • line1 string: First line of the address of the sender.\n\nType: Alphanumeric Special [a-zA-Z0-9 !"#$%&'()*+,-./:;<=>?@[]_`{|}~ÀÁÂÃÄÅÇÈÉÊËÌÍÎÏÑÒÓÔÕÖÙÚÚÚÝàáâãäåçèéêëìíîïñòóôõöùúûüýÿ], Length: 1-50
    • line2 string: Second line of the address of the sender.\n\nType: Alphanumeric Special [a-zA-Z0-9 !"#$%&'()*+,-./:;<=>?@[]_`{|}~ÀÁÂÃÄÅÇÈÉÊËÌÍÎÏÑÒÓÔÕÖÙÚÚÚÝàáâãäåçèéêëìíîïñòóôõöùúûüýÿ], Length: 1-50
    • postal_code string: Postal code of the sender. Format in 5 digits or 5 digits hyphen 4 digits. Details numeric length: 5 or 5-4

Address_97

  • Address_97 object: Address of the recipient/merchant.
    • city required string: City of the recipient/merchant.\n\nType: Alphanumeric Special [a-zA-Z0-9 !"#$%&'()*+,-./:;<=>?@[]_`{|}~ÀÁÂÃÄÅÇÈÉÊËÌÍÎÏÑÒÓÔÕÖÙÚÚÚÝàáâãäåçèéêëìíîïñòóôõöùúûüýÿ], Length: 1-25
    • country required string: The recipient's/merchant's home country as an ISO 3166-1 alpha-3 country code, in uppercase. Details- Alpha, Length: 3
    • country_subdivision string: State or province of the recipient/merchant. If the merchant_transfer.recipient.address.country is USA or CAN, the country subdivision code is required.
    • line1 string: First line of the address of the recipient/merchant.\n\nType: Alphanumeric Special [a-zA-Z0-9 !"#$%&'()*+,-./:;<=>?@[]_`{|}~ÀÁÂÃÄÅÇÈÉÊËÌÍÎÏÑÒÓÔÕÖÙÚÚÚÝàáâãäåçèéêëìíîïñòóôõöùúûüýÿ], Length: 1-50
    • line2 string: Second line of the address of the recipient/merchant.\n\nType: Alphanumeric Special [a-zA-Z0-9 !"#$%&'()*+,-./:;<=>?@[]_`{|}~ÀÁÂÃÄÅÇÈÉÊËÌÍÎÏÑÒÓÔÕÖÙÚÚÚÝàáâãäåçèéêëìíîïñòóôõöùúûüýÿ], Length: 1-50
    • postal_code string: Postal code of the recipient/merchant. Format in 5 digits or 5 digits hyphen 4 digits. Details numeric length: 5 or 5-4

CustomField_100

  • CustomField_100 object: Contains custom field names and values to appear in the reconciliation report. This can be a list of multiple name/value pairs. The names provided must match the configured in the partner setup.
    • name required string: Name to be displayed in the reconciliation report. This value will appear as a header in the reconciliation reports. Name values to be defined during the onboarding process. Details- 1-40
    • value required string: Value to be displayed in the reconciliation report. Details- 1-40

CustomField_116

  • CustomField_116 object: Contains custom field names and values to appear in the reconciliation report. This can be a list of multiple name/value pairs. The names provided must match the configured in the partner setup.
    • name string: Name to be displayed in the reconciliation report. This value will appear as a header in the reconciliation reports. Name values to be defined during the onboarding process. Details- 1-40
    • value string: Value to be displayed in the reconciliation report. Details- 1-40

CustomField_12

  • CustomField_12 object: Contains custom field names and values to appear in the reconciliation report. This can be a list of multiple name/value pairs.
    • name required string: Name to be displayed in the reconciliation report. This value will appear as a header in the reconciliation reports. Name values to be defined during the onboarding process. \n\nType: Alphanumeric Special [a-zA-Z0-9!"#$%&'()*+,-./\:;<=>?@[]_`{|}~], Length: 1-40
    • value required string: Value to be displayed in the reconciliation report. \n\nType: Alphanumeric Special [a-zA-Z0-9!"#$%&'()*+,-./\:;<=>?@[]_`{|}~], Length: 1-40

CustomField_127

  • CustomField_127 object: Contains custom field names and values to appear in the reconciliation report for this transfer. This could be a list of multiple values. These should match with the information during onboarding.
    • name required string: Name to be displayed in the reconciliation report for this transfer. This value will appear as a header in the column name of the report. The fields that can be used have to be defined during the onboarding process. Details- 1-40
    • value required string: Value to be displayed in the reconciliation report for this transfer. Details- 1-40

CustomField_143

  • CustomField_143 object: Contains custom field names and values to appear in the reconciliation report. This can be a list of multiple name/value pairs. The names provided must match the configured in the partner setup.
    • name string: Name to be displayed in the reconciliation report. This value will appear as a header in the reconciliation reports. Name values to be defined during the onboarding process. Details- 1-40
    • value string: Value to be displayed in the reconciliation report. Details- 1-40

CustomField_158

  • CustomField_158 object: Contains custom field names and values to appear in the reconciliation report. This can be a list of multiple name/value pairs. The names provided must match the configured in the partner setup.
    • name string: Name to be displayed in the reconciliation report. This value will appear as a header in the reconciliation reports. Name values to be defined during the onboarding process. Details- 1-40
    • value string: Value to be displayed in the reconciliation report. Details- 1-40

CustomField_27

  • CustomField_27 object: Contains custom field names and values to appear in the reconciliation report. This can be a list of multiple name/value pairs.
    • name string: Name to be displayed in the reconciliation report. This value will appear as a header in the reconciliation reports. Name values to be defined during the onboarding process.\n\nType: Alphanumeric Special [a-zA-Z0-9!"#$%&'()*+,-./\:;<=>?@[]_`{|}~], Maximum Length: 40
    • value string: Value to be displayed in the reconciliation report.\n\nType: Alphanumeric Special [a-zA-Z0-9!"#$%&'()*+,-./\:;<=>?@[]_`{|}~], Maximum Length: 40

CustomField_36

  • CustomField_36 object: Contains custom field names and values to appear in the reconciliation report. This can be a list of multiple name/value pairs. The names provided must match the configured in the partner setup.
    • name required string: Name to be displayed in the reconciliation report. This value will appear as a header in the reconciliation reports. Name values to be defined during the onboarding process. Details- 1-40
    • value required string: Value to be displayed in the reconciliation report. Details- 1-40

CustomField_52

  • CustomField_52 object: Contains custom field names and values to appear in the reconciliation report. This can be a list of multiple name/value pairs. The names provided must match the configured in the partner setup.
    • name string: Name to be displayed in the reconciliation report. This value will appear as a header in the reconciliation reports. Name values to be defined during the onboarding process. Details- 1-40
    • value string: Value to be displayed in the reconciliation report. Details- 1-40

CustomField_67

  • CustomField_67 object: Contains custom field names and values to appear in the reconciliation report. This can be a list of multiple name/value pairs. The names provided must match the configured in the partner setup.
    • name string: Name to be displayed in the reconciliation report. This value will appear as a header in the reconciliation reports. Name values to be defined during the onboarding process. Details- 1-40
    • value string: Value to be displayed in the reconciliation report. Details- 1-40

CustomField_84

  • CustomField_84 object: Contains custom field names and values to appear in the reconciliation report. This can be a list of multiple name/value pairs. The names provided must match the configured in the partner setup.
    • name string: Name to be displayed in the reconciliation report. This value will appear as a header in the reconciliation reports. Name values to be defined during the onboarding process. Details- 1-40
    • value string: Value to be displayed in the reconciliation report. Details- 1-40

Data_112

  • Data_112 object: An array containing the Transactions in the transfer. Valid Values- Refer 'Transaction Data'

Data_139

  • Data_139 object: An array containing the Transactions in the transfer.

Data_154

  • Data_154 object: An array containing the Transactions in the transfer.

Data_23

  • Data_23 object: An array containing the Transactions in the transfer. Valid Values- Refer 'Transaction Data'

Data_48

  • Data_48 object: An array containing the Transactions in the transfer. Valid Values- Refer 'Transaction Data'

Data_63

  • Data_63 object: An array containing the Transactions in the transfer. Valid Values- Refer 'Transaction Data'

Data_70

  • Data_70 object: An array containing the Transactions in the transfer
    • merchant_transfer array: An array containing the Transactions in the transfer

Data_80

  • Data_80 object: An array containing the Transactions in the transfer. Valid Values- Refer 'Transaction Data'

DigitalAccountReferenceNumber_88

  • DigitalAccountReferenceNumber_88 object: Information about the digital account reference number
    • issue_timestamp string: Local date and time when the transaction is submitted. Details-YYYY-MM-DDTHH:MM:SS±hh[:mm]
    • pan string: URI describing the account. It will include the account information but will not include security codes (e.g. CVC or expiration date for a card account).

DigitalAccountReferenceNumber_92

  • DigitalAccountReferenceNumber_92 object: Contains the details of an individual digital account reference number.
    • issue_timestamp string: Date and time the Digital Account Reference Number was created. Details- YYYY-MM-DDTHH:MM:SSZ Valid Values- Refer 'Date And Time Formats'
    • pan string: URI describing the account. URI scheme must be pan.Valid Values- Refer 'Account URIs'.

DigitalAccountReferenceNumbers_91

  • DigitalAccountReferenceNumbers_91 object: Contains the list of digital account reference numbers. This can be a list of multiple pan/timestamp pairs

DigitalAccount_86

  • DigitalAccount_86 object: Contains the details of the request message.
    • account_type required string: Account type must contain one of the following: CREDIT, DEBIT, PREPAID, DEPOSIT_ACCOUNT, MOBILE_MONEY_ACCOUNT or CASH.
    • account_uri required string: URI describing the account. URI scheme must be rawl. Valid Values- Refer 'Account URIs'.
    • reference required string: Provide a unique reference number. It must be a unique value for the partner. Details- 6-40, Allowable characters are alphanumeric and * , - . _ ~

DigitalAccount_86_wrapper

  • DigitalAccount_86_wrapper object: Contains the details of the request message.

DigitalAccount_87

  • DigitalAccount_87 object: Response details for a create digital account reference number
    • account_type string: Account type must contain one of the following: CREDIT, DEBIT, PREPAID, DEPOSIT_ACCOUNT, MOBILE_MONEY_ACCOUNT, CASH.
    • account_uri string: URI describing the account. URI scheme must be raw. Valid Values- Refer 'Account URIs'.
    • digital_account_reference_number DigitalAccountReferenceNumber_88
    • reference string: Provide a unique transaction reference number. It must be a unique value for the partner. Details- 6-40, Allowable characters are alphanumeric and * , - . _ ~

DigitalAccount_87_wrapper

  • DigitalAccount_87_wrapper object: Response details for a create digital account reference number

DigitalAccount_89

  • DigitalAccount_89 object: Contains the details of the request message.
    • account_type required string: Account type must contain one of the following: CREDIT, DEBIT, PREPAID, DEPOSIT_ACCOUNT, MOBILE_MONEY_ACCOUNT or CASH.
    • account_uri required string: URI describing the account. URI scheme must be raw. Valid Values- Refer 'Account URIs'.
    • reference required string: Provide a unique reference number. It must be a unique value for the partner. Details- 6-40, Allowable characters are alphanumeric and * , - . _ ~

DigitalAccount_89_wrapper

  • DigitalAccount_89_wrapper object: Contains the details of the request message.

DigitalAccount_90

  • DigitalAccount_90 object: Response details for a retrieve digital account reference number
    • account_type string: Account type must contain one of the following: CREDIT, DEBIT, PREPAID, DEPOSIT_ACCOUNT, MOBILE_MONEY_ACCOUNT or CASH.
    • account_uri string: URI describing the account. URI scheme must be raw. Valid Values- Refer 'Account URIs'.
    • digital_account_reference_numbers DigitalAccountReferenceNumbers_91
    • reference string: Provide a unique reference number. It must be a unique value for the partner. Details- 6-40, Allowable characters are alphanumeric and * , - . _ ~

DigitalAccount_90_wrapper

  • DigitalAccount_90_wrapper object: Response details for a retrieve digital account reference number

FundingReversal_144

  • FundingReversal_144 object: Contains the details of the request message.
    • reversal_reason required string: Brief description of reason for reversal. Details- alpha-numeric 1-50

FundingReversal_144_wrapper

  • FundingReversal_144_wrapper object: Contains the details of the request message.

FundingTransactionReference_38

  • FundingTransactionReference_38 object: This section describes information used by the Mastercard and Visa networks to link a funding and payment transaction when both card accounts are Visa accounts or both accounts are Mastercard accounts.
    • network string: Network on which funding transaction is processed required. Valid values will be provided during partner onboarding.
    • reference_number required string: Provide the id from the funding transfer resource.\n\nType: Alphanumeric Special [a-zA-Z0-9 * , - . _ ~ ], Length: 1-19

FundingTransfer_118

  • FundingTransfer_118 object: Contains the details of the request message.
    • additional_message string: Additional Message. Details- alpha-numeric 1-65
    • amount required string: Amount of the transfer in the smallest unit of currency. Decimal implied before last two positions. Example: 100 = $1.00USD Details- numeric, 1-999999999999
    • authentication_value string: List of name/value pairs containing authentication values. Refer 'Authentication Value URIs'
    • channel string: Initiation channel of the payment request. This value can be defined in the onboarding process instead of passing in every call One of the WEB, MOBILE, BANK, KIOSK. Details- Conditional
    • currency required string: Three-letter ISO currency code representing the currency of the transfer amount. Details- alpha, length: 3
    • device_id string: The serial number of a device. Details- 1-40
    • funding_hints string: List of name/value pairs containing funding parameter values. Valid Values- Refer 'Funding Hints URIs'
    • interchange_rate_designator string: Indicates the interchange rate and editing rules applied to the transaction.
    • language_data string: Language Data Details- binary 1-65
    • language_identification string: Language Identification. Details- alpha - 3
    • location string: Location where the transaction is initiated from. Details- 1-40. Valid Values- Refer 'Location URIs'
    • participation_id string: Participation Id. An identifier agreed by both the issuing institution and the merchant. Details- alpha-numeric 1-30
    • payment_type string: Payment type used for transfer. Value - P2M: Person to Merchant.
    • recipient Recipient_123
    • recipient_account_uri required string: URI identifying receiver's account to receive the transfer. Valid Values- Refer 'Account URIs'
    • reconciliation_data ReconciliationData_126
    • sanction_screening_override boolean: Override indicator if partner has opted into Sanction Screening validation as part of transaction processing. If Sanction Screening score on either sender or receiver is equal to or above threshold configured for partner, the payment will error. To bypass the Sanction Screening validation and process the payment the value 'true' should be submitted. Details: Optional – If partner has not enabled Sanction Screening validation default is 'true'. Required - If partner has opted into Sanction Screening validation but wants to bypass Sanction Screening validation and process the payment, value should be 'true'.
    • sender Sender_119
    • sender_account_uri string: URI identifying sender's account to fund the transfer. Only a pan based account is valid. Valid Values- Refer 'Account URIs' Details- Conditional
    • statement_descriptor string: The statement descriptor is a string which will be displayed on the recipient's bank or card statement. It consists of one or two parts: the prefix and the content. The prefix is an optional short string typically used to identify the client/merchant. It is defined during client/merchant onboarding and the same value should be used. If not provided in the API call, system will use the value defined in the onboarding process. The content portion of the statement descriptor will be displayed on the recipient's statement. If both the prefix and content portions are defined, they both are appended <prefix>+<content> The overall length may be at most 22 characters, including the prefix (even if not provided in the API call) and the content. Note: While most financial institutions display this information consistently, some may display it incorrectly or not at all. Details- Conditional, 22
    • token_cryptogram TokenCryptogram_128
    • transfer_reference required string: Unique transaction reference number. It must be unique within the partner's domain. Allowable characters are alphanumeric and * , - . _ ~. Details- 6-40

FundingTransfer_118_wrapper

  • FundingTransfer_118_wrapper object: Contains the details of the request message.

GovernmentIds_122

  • GovernmentIds_122 object: Government id’s may be required in certain markets like LAC region and also by certain Networks. The partner must provide where applicable else there is a potential for the transaction to be rejected.
    • government_id_uri array: URI describing the government id. [see Government ID URIs]
      • items string

GovernmentIds_125

  • GovernmentIds_125 object: Government id’s may be required in certain markets. The partner must provide where applicable.
    • government_id_uri array: URI describing the government id. [see Government ID URIs]
      • items string

GovernmentIds_133

  • GovernmentIds_133 object: Sender Government ID.
    • government_id_uri array: URI describing the sender government id. See 'Government ID URIs'.
      • items string

GovernmentIds_136

  • GovernmentIds_136 object: Recipient Government ID.
    • government_id_uri array: URI describing the recipient government id. See 'Government ID URIs'.
      • items string

GovernmentIds_148

  • GovernmentIds_148 object: Sender Government ID.
    • government_id_uri array: URI describing the sender government id. See 'Government ID URIs'.
      • items string

GovernmentIds_151

  • GovernmentIds_151 object: Recipient Government ID.
    • government_id_uri array: URI describing the recipient government id. See 'Government ID URIs'.
      • items string

MerchantPaymentTransfer_29

  • MerchantPaymentTransfer_29 object: Contains the details of the request message.
    • additional_message string: Message a financial institution will associate to the transfer and may display. \n\nType: Alphanumeric Special [a-zA-Z0-9!"#$%&'()*+,-./\:;<=>?@[]_`{|}~], Length: 1-65
    • amount required string: Amount of the transfer. The decimal point is implied based on the payment transfer currency. Details- 1-999999999999
    • authentication_value string: List of name/value pairs containing authentication values. Refer 'Authentication Value URIs'
    • channel string: Initiation channel of the transfer request. This value can be defined in the onboarding process instead of passing in every call. Values: WEB, MOBILE, BANK, KIOSK. Details- Conditional
    • convenience_amount string: Tip or convenience amount in transaction currency. Length:1-12 numeric. If present, then convenience_indicator is also required.
    • convenience_indicator string: Convenience fee type code. Min length: 2. Max Length: 2. Valid values are 01,02 or 03. 01:Indicates consumer should be prompted to enter tip. 02:Indicates the merchant would mandatorily charge a flat convenience fee. 03:Indicates that merchant would charge a percentage convenience fee. Required if convenience_amount is provided.
    • currency required string: Currency of the transfer amount as an ISO alpha currency code. Details- Alpha, Length: 3
    • device_id string: The serial number of a device initiating the transfer. Details- 1-40
    • digital_account_reference_number string: URI to identify the digital account reference number. URI scheme must be pan. Valid Values- Refer 'Account URIs'.
    • funding_source required string: Funding source must contain one of the following: CREDIT, DEBIT, PREPAID, DEPOSIT_ACCOUNT, MOBILE_MONEY_ACCOUNT, CASH. In the Asia/Pacific region, funding sources are limited to Mastercard cards. In Subfield 1 values 04, 05, 06, and 07 are not applicable.
    • funding_transaction_reference FundingTransactionReference_38
    • interchange_rate_designator string: Indicates the interchange rate and editing rules applied to the transaction.
    • location string: Location where the transaction is initiated. Valid Values- Refer 'Location URIs'.
    • mastercard_assigned_id string: Mastercard Assigned ID for tiered interchange calculations. \n\nType: Numeric [0-9], Length: 6
    • participant Participant_37
    • participation_id string: Participation identifier of the sender. The receiving financial institution will associate the value to the transfer. Details- 1-30
    • payment_origination_country string: The country where the payment originates from as an ISO 3166-1 alpha-3 country code, in uppercase. Details - Conditional. If provided, this should match a valid country configured for the partner during onboarding. If the partner is configured for multiple origination countries this field is required and must be provided. Alpha, length: 3
    • payment_type required string: P2M: Person to Merchant
    • processor_id string: The processor ID is a ten-digit number of the form: 9000xxxxxx, where the Single Message System-assigned processor ID will be up to the last six digits xxxxxx. If the partner is enrolled in multiple processorId numbers, the processorId number must be specified. If the partner is only enrolled in a single processorId number then system takes the onboarded value. Please contact your MasterCard Representative to enable the usage of fields in this section. Details- Numeric, 10
    • qr_data string: Contains QR data. For future use. Details- alpha numeric special characters 1-237.
    • recipient required Recipient_32
    • recipient_account_uri required string: URI to identify the account of the recipient/merchant. When PAN is the URI then recipient/merchant information is required. Pan, Manual Entry Alias and Alias are valid schemas. Valid Values- Refer 'Account URIs'
    • reconciliation_data ReconciliationData_35
    • routing_transit_number string: The nine-digit Federal Reserve Routing and Transit (R & T) number of the acquiring institution or the nine-digit pseudo-number assigned to the acquiring institution by Mastercard. If the partner is enrolled in multiple routing transit numbers, the routing transit number must be specified. If the partner is only enrolled in a single routing transit number then system takes the onboarded value. Please contact your MasterCard Representative to enable the usage of fields in this section. Details- Numeric, 9
    • sender Sender_30
    • sender_account_uri required string: URI to identify the account information of the sender. When PAN is the URI then sender information is required. If scheme chosen is raw, then funding_source must be other than CREDIT, DEBIT or PREPAID. Valid Values- Refer 'Account URIs'
    • token_cryptogram TokenCryptogram_39
    • transaction_local_date_time required string: Local date and time when the transaction is submitted. Details-YYYY-MM-DDTHH:MM:SS±hh[:mm]
    • transfer_reference required string: Provide a unique transaction reference number. It must be a unique value for the partner. Details- 6-40, Allowable characters are alphanumeric and * , - . _ ~

MerchantPaymentTransfer_29_wrapper

  • MerchantPaymentTransfer_29_wrapper object: Contains the details of the request message.

MerchantRefundTransfer_93

  • MerchantRefundTransfer_93 object: Contains the details of the request message.
    • additional_message string: Message a financial institution will associate to the transfer and may display. \n\nType: Alphanumeric Special [a-zA-Z0-9!"#$%&'()*+,-./\:;<=>?@[]_`{|}~], Length: 1-65
    • amount required string: Amount of the transfer. The decimal point is implied based on the payment transfer currency. Details- 1-999999999999
    • authentication_value string: List of name/value pairs containing authentication values. Refer 'Authentication Value URIs'
    • channel string: Initiation channel of the transfer request. This value can be defined in the onboarding process instead of passing in every call. Values: WEB, MOBILE, BANK, KIOSK. Details- Conditional
    • currency required string: Currency of the transfer amount as an ISO alpha currency code. Details- Alpha, Length: 3
    • device_id string: The serial number of a device initiating the transfer. Details- 1-40
    • digital_account_reference_number string: URI to identify the digital account reference number. URI scheme must be pan. If merchant_refund_transfer.sender_account_uri does not start with PAN, the Digital Account Reference Number is required. Valid Values- Refer 'Account URIs'.
    • funding_source required string: Funding source must contain one of the following: CREDIT, DEBIT, PREPAID, DEPOSIT_ACCOUNT, MOBILE_MONEY_ACCOUNT, CASH. In the Asia/Pacific region, funding sources are limited to Mastercard cards. In Subfield 1 values 04, 05, 06, and 07 are not applicable.
    • interchange_rate_designator string: Indicates the interchange rate and editing rules applied to the transaction.
    • location string: Location where the transaction is initiated. Valid Values- Refer 'Location URIs'.
    • mastercard_assigned_id string: Mastercard Assigned ID for t