| **PARAMETER**
| **VALUE**
| **DESCRIPTION**
|
| `payment_disbursement.disbursement_reference`
| HAPPYPATH\_DISB\_000001
| string
Required. A partner-assigned unique reference identifier for the disbursement. Alphanumeric and \* , - . \_ ~. Length 6-40.
|
| `payment_disbursement.payment_type`
| GMR
| string
Conditional. Payment type of the disbursement. The allowed payment types for the partner must be enabled by Mastercard during onboarding. If the partner is enabled for multiple payment types, the appropriate payment type must be provided. Otherwise the field is optional. Valid values:
AMS = Rapid Merchant Settlement
B2B = General Business-to-Business Transfer
FRD = Fast Refund
GMR = Gaming Repay
|
| `payment_disbursement.amount`
| 5300
| number
Required. The amount to be transferred. Numeric integer, 1-999999999999. The decimal point is implied based on the relevant currency exponent. For example, a US Dollar $53 amount is a value of 5300.
|
| `payment_disbursement.currency`
| USD
| string
Required. The currency of the amount as an ISO 4217 uppercase alpha-3 currency code; For example, US Dollars is USD.
|
| `payment_disbursement.sender_account_uri`
| pan:5102589999999921;exp=2077-02;cvc=123
| string
URI identifying the Sender's account number for this disbursement (payment transaction). For disbursements to Mastercard accounts, you must provide a value in this field, for example the full PAN or token (for a card account), full account number (for a Deposit or Bank Account), or full wallet ID (for a wallet).
|
| `payment_disbursement.recipient_account_uri`
| pan:5102589999999111;exp=2055-01;cvc=231
| string
URI identifying the recipient's account number for this disbursement (payment transaction). For disbursements to Mastercard accounts, you must provide a value in this field, for example the full PAN or token (for a card account), full account number (for a Deposit or Bank Account), or full wallet ID (for a wallet).
|
| `payment_disbursement.sender`
| | object
Information about the sender of the transaction.
Optional.
If you provide this object, you must provide first\_name and last\_name.
|
| `payment_disbursement.sender.first_name`
| Metal
| string
The sender's first name. When sender.first\_name is present in request, then sender.last\_name is required. Alphanumeric Special \[a-zA-Z0-9 !"#$%&'()\*+,-./\\:;<=>?@\[\]\_`{|}~ÀÁÂÃÄÅÇÈÉÊËÌÍÎÏÑÒÓÔÕÖÙÚÛÜÝàáâãäåçèéêëìíîïñòóôõöùúûüýÿ\], length 1-40. If the disburser is a business, provide the business name using both the first\_name and last\_name fields.
|
| `payment_disbursement.sender.last_name`
| Record Store
| String
required
The sender's last name. When sender.last\_name is present in request, then sender.first\_name is required. Alphanumeric Special \[a-zA-Z0-9 !"#$%&'()\*+,-./\\:;<=>?@\[\]\_`{|}~ÀÁÂÃÄÅÇÈÉÊËÌÍÎÏÑÒÓÔÕÖÙÚÛÜÝàáâãäåçèéêëìíîïñòóôõöùúûüýÿ\], length 1-40. If the disburser is a business, provide the business name using both the first\_name and last\_name fields.
|
| `payment_disbursement.sender.account_type`
| 03
| String
optional
Identifies the sender's account number type. This field is optional. Valid values: '00' Other, '01' RTN + Bank Account, '02' IBAN, '03' Card Account, '04' Email, '05' Phone Number, '06' Bank account number (BAN) + Bank Identification Сode (BIC), '07' Wallet ID, '08' Social Network ID. Numeric, 2 characters.
|
| `payment_disbursement.sender.address`
| | object
Sender's address.
Optional.
If you provide this object, you must provide line1, city and country.
|
| `payment_disbursement.sender.address.line1`
| 101 Main St
| string
Required. First line of the sender's address. Alphanumeric Special \[a-zA-Z0-9 !"#$%&'()\*+,-./\\:;<=>?@\[\]\_`{|}~ÀÁÂÃÄÅÇÈÉÊËÌÍÎÏÑÒÓÔÕÖÙÚÛÜÝàáâãäåçèéêëìíîïñòóôõöùúûüýÿ\], length: 1-50. If you cannot provide the actual value, you must provide the alternative value '#NOTINCLUDED'.
|
| `payment_disbursement.sender.address.line2`
| Unit 5
| string
Second line of the sender's address. Alphanumeric Special \[a-zA-Z0-9 !"#$%&'()\*+,-./\\:;<=>?@\[\]\_`{|}~ÀÁÂÃÄÅÇÈÉÊËÌÍÎÏÑÒÓÔÕÖÙÚÛÜÝàáâãäåçèéêëìíîïñòóôõöùúûüýÿ\]
|
| `payment_disbursement.sender.address.city`
| Chicago
| string
Required. The sender's city. Alphanumeric Special \[a-zA-Z0-9 !"#$%&'()\*+,-./\\:;<=>?@\[\]\_`{|}~ÀÁÂÃÄÅÇÈÉÊËÌÍÎÏÑÒÓÔÕÖÙÚÛÜÝàáâãäåçèéêëìíîïñòóôõöùúûüýÿ\], length: 1-25. If you cannot provide the actual value, you must provide the alternative value '#NOTINCLUDED'.
|
| `payment_disbursement.sender.address.country_subdivision`
| IL
| string
The sender's province, state or territory. Conditional, required if sender's country is USA or CAN. Must be an ISO 3166-2 uppercase alpha 2 or 3 character country subdivision code. For example, Missouri is MO.
|
| `payment_disbursement.sender.address.postal_code`
| 60618
| string
The sender's postal code. For USA, this must be a valid value of 5 digits or 5 digits hyphen 4 digits, for example '63368', '63368-5555'. For other regions, this can be alphanumeric, length 1-10.
|
| `payment_disbursement.sender.address.country`
| USA
| string
Required. The sender's country as an ISO 3166-1 uppercase alpha-3 country code; For example, the United States of America is USA.
|
| `payment_disbursement.recipient`
| | Recipient
Information about the recipient of the transaction.
Conditional.
If a 'pan' scheme is provided in the recipient\_account\_uri, this recipient object is required. If you provide this object, you must provide first\_name and last\_name.
|
| `payment_disbursement.recipient.last_name`
| Vinyl
| string
Required. The recipient's last name. Alphanumeric Special \[a-zA-Z0-9 !"#$%&'()\*+,-./\\:;<=>?@\[\]\_`{|}~ÀÁÂÃÄÅÇÈÉÊËÌÍÎÏÑÒÓÔÕÖÙÚÛÜÝàáâãäåçèéêëìíîïñòóôõöùúûüýÿ\], length 1-40. If you cannot provide the actual value, you must provide the alternative value '#NOTINCLUDED'.
|
| `payment_disbursement.recipient.first_name`
| Importers
| string
Required. The recipient's first name. Alphanumeric Special \[a-zA-Z0-9 !"#$%&'()\*+,-./\\:;<=>?@\[\]\_`{|}~ÀÁÂÃÄÅÇÈÉÊËÌÍÎÏÑÒÓÔÕÖÙÚÛÜÝàáâãäåçèéêëìíîïñòóôõöùúûüýÿ\], length 1-40. If you cannot provide the actual value, you must provide the alternative value '#NOTINCLUDED'.
|
| `payment_disbursement.recipient.account_type`
| 03
| string
Identifies the recipient's account number type. This field is optional. Valid values: '00' Other, '01' RTN + Bank Account, '02' IBAN, '03' Card Account, '04' Email, '05' Phone Number, '06' Bank account number (BAN) + Bank Identification Сode (BIC), '07' Wallet ID, '08' Social Network ID. Numeric, 2 characters.
|
| `payment_disbursement.recipient.address`
| | object
Recipient's home address. Conditional, required when it is a Visa OCT disbursement and Recipient Account URI institution country is CAN. If you provide this object, you must provide line1 and city.
|
| `payment_disbursement.recipient.address.line1`
| 234 Spiral Drive
| string
Required. First line of the recipient's address. Alphanumeric Special \[a-zA-Z0-9 !"#$%&'()\*+,-./\\:;<=>?@\[\]\_`{|}~ÀÁÂÃÄÅÇÈÉÊËÌÍÎÏÑÒÓÔÕÖÙÚÛÜÝàáâãäåçèéêëìíîïñòóôõöùúûüýÿ\], length: 1-50. If you cannot provide the actual value, you must provide the alternative value '#NOTINCLUDED'.
|
| `payment_disbursement.recipient.address.line2`
| Unit B
| string
Second line of the recipient's address. Alphanumeric Special \[a-zA-Z0-9 !"#$%&'()\*+,-./\\:;<=>?@\[\]\_`{|}~ÀÁÂÃÄÅÇÈÉÊËÌÍÎÏÑÒÓÔÕÖÙÚÛÜÝàáâãäåçèéêëìíîïñòóôõöùúûüýÿ\]
|
| `payment_disbursement.recipient.address.city`
| St. Louis
| string
Required. The recipient's city. Alphanumeric Special \[a-zA-Z0-9 !"#$%&'()\*+,-./\\:;<=>?@\[\]\_`{|}~ÀÁÂÃÄÅÇÈÉÊËÌÍÎÏÑÒÓÔÕÖÙÚÛÜÝàáâãäåçèéêëìíîïñòóôõöùúûüýÿ\], length: 1-25. If you cannot provide the actual value, you must provide the alternative value '#NOTINCLUDED'.
|
| `payment_disbursement.recipient.address.country_subdivision`
| MO
| string
The recipient's province, state or territory. Conditional, required if sender's country is USA or CAN. Must be an ISO 3166-2 uppercase alpha 2 or 3 character country subdivision code. For example, Missouri is MO.
|
| `payment_disbursement.recipient.address.postal_code`
| 63368
| string
The recipient's postal code. For USA, this must be a valid value of 5 digits or 5 digits hyphen 4 digits, for example '63368', '63368-5555'. For other regions, this can be alphanumeric, length 1-10.
|
| `payment_disbursement.recipient.address.country`
| USA
| string
Required. The sender's country as an ISO 3166-1 uppercase alpha-3 country code; For example, the United States of America is USA.
|
| `payment_disbursement.recipient.name_on_account`
| Lucy Lawrence
| string
Name on the account. Applicable for non-card only. Details- 1-40
|
| `payment_disbursement.participant`
| | Participant
Object
Information about a participant that may be passed along to the network. For example Bank which is registered in MC Send program.
|
| `payment_disbursement.participant.merchant_category_code`
| 7995
| string
Classification of the merchant's type of business or service. Please contact your Mastercard representative to enable the usage of fields in this section.
|
| `payment_disbursement.participant.mastercard_assigned_merchant_id`
| 12AB46
| string
The Merchant ID assigned by Mastercard. Alphanumeric, length 6.
|
| `payment_disbursement.participant.purchase_trace_id`
| MS12ybwmc020404
| This field is to associate Original Purchase transaction with payment transaction for Fast Refund use case. Applicable for both Single and Dual message transaction. Alphanumeric, length 15.
|
| `payment_disbursement.funding_source`
| CASH
| string
Funding source must contain one of the following: CREDIT, DEBIT, PREPAID, DEPOSIT\_ACCOUNT, MOBILE\_MONEY\_ACCOUNT, CASH or OTHER. Optional, required for Visa OCT payment. If not provided, defaults to DEPOSIT\_ACCOUNT.
|
| `payment_disbursement.transaction_purpose`
| 08
| string
The purpose of the transaction. String, numeric, length 2. Valid numeric values:
00 = Family Support
01 = Regular Labor Transfers (expatriates)
02 = Travel & Tourism
03 = Education
04 = Hospitalization and Medical Treatment
05 = Emergency Need
06 = Savings
07 = Gifts
08 = Other
09 = Salary
10 = Crowd lending
11 = Crypto currency
12 = Refund to original card
13 = Refund to new card
17 = Recycling Deposit Return
18 = Value Added Tax (VAT) Payment
|