PUT v1/Order/GetRecipientOrderFields
Gets the recipient-specific fields required for a money transfer order
Request Information
Parameters (ParameterName * = required)
Name
Description
Sample Value
DeliveryMethod *
Delivery method of the funds.
OfficePickup
PaymentMethod
The payment method used for the order.
CreditCard
RecipientId
Recipient id to send funds to.
421020
AgentToId
The agent id that the recipient will pick up funds at.
421020
AgentToLocationId
The agent location id (actual store) that the recipient will pick up funds at.
421020
BankId
The recipient's bank id used for bank deposit transfers.
421020
AmountFrom
The base amount that the customer wants to send.
121.87
AmountTo
The base amount that the customer wants beneficiary to receive.
121.87
ShouldCalcAmountFrom
No description available
Not available
Language
The language for transfer reasons.
EnUs
VirtualPaymentAccountNo
No description available
Not available
CustomerProfileRefreshEnabled
No description available
Not available
CountryTo *
The 2-letter country code the customer is sending to
MX
CountryFrom
The 2-letter country code the customer is sending from
MX
CurrencyTo *
The 3-letter currency code that the funds will be paid out in
MXN
CurrencyFrom
The 3-letter currency code that the funds will be paid out in
MXN
Response Information
Response body formats
application/json, text/json
Sample:
[
{
"category": "Other",
"minValue": 1.1,
"maxValue": 1.1,
"validationGroupId": 1,
"validationSubgroupId": 1,
"regEx": "sample string 1",
"regexValueOptions": {
"sample string 1": "sample string 2",
"sample string 3": "sample string 4",
"sample string 5": "sample string 6"
},
"name": "sample string 2",
"type": "Button",
"required": true,
"minLength": 1,
"maxLength": 1,
"defaultValue": "sample string 4",
"values": [
{
"id": "sample string 1",
"value": "sample string 2"
},
{
"id": "sample string 1",
"value": "sample string 2"
},
{
"id": "sample string 1",
"value": "sample string 2"
}
],
"prefillValue": "sample string 5",
"fieldCategory": "sample string 6",
"pattern": "sample string 7",
"storeValueWithPattern": true
},
{
"category": "Other",
"minValue": 1.1,
"maxValue": 1.1,
"validationGroupId": 1,
"validationSubgroupId": 1,
"regEx": "sample string 1",
"regexValueOptions": {
"sample string 1": "sample string 2",
"sample string 3": "sample string 4",
"sample string 5": "sample string 6"
},
"name": "sample string 2",
"type": "Button",
"required": true,
"minLength": 1,
"maxLength": 1,
"defaultValue": "sample string 4",
"values": [
{
"id": "sample string 1",
"value": "sample string 2"
},
{
"id": "sample string 1",
"value": "sample string 2"
},
{
"id": "sample string 1",
"value": "sample string 2"
}
],
"prefillValue": "sample string 5",
"fieldCategory": "sample string 6",
"pattern": "sample string 7",
"storeValueWithPattern": true
},
{
"category": "Other",
"minValue": 1.1,
"maxValue": 1.1,
"validationGroupId": 1,
"validationSubgroupId": 1,
"regEx": "sample string 1",
"regexValueOptions": {
"sample string 1": "sample string 2",
"sample string 3": "sample string 4",
"sample string 5": "sample string 6"
},
"name": "sample string 2",
"type": "Button",
"required": true,
"minLength": 1,
"maxLength": 1,
"defaultValue": "sample string 4",
"values": [
{
"id": "sample string 1",
"value": "sample string 2"
},
{
"id": "sample string 1",
"value": "sample string 2"
},
{
"id": "sample string 1",
"value": "sample string 2"
}
],
"prefillValue": "sample string 5",
"fieldCategory": "sample string 6",
"pattern": "sample string 7",
"storeValueWithPattern": true
}
]
application/xml, text/xml
Sample:
<ArrayOfFormField xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Ria.Digital.WebServices.DataModels">
<FormField>
<_x003C_DefaultValue_x003E_k__BackingField>sample string 4</_x003C_DefaultValue_x003E_k__BackingField>
<_x003C_FieldCategory_x003E_k__BackingField>sample string 6</_x003C_FieldCategory_x003E_k__BackingField>
<_x003C_MaxLength_x003E_k__BackingField>1</_x003C_MaxLength_x003E_k__BackingField>
<_x003C_MinLength_x003E_k__BackingField>1</_x003C_MinLength_x003E_k__BackingField>
<_x003C_Name_x003E_k__BackingField>sample string 2</_x003C_Name_x003E_k__BackingField>
<_x003C_Pattern_x003E_k__BackingField>sample string 7</_x003C_Pattern_x003E_k__BackingField>
<_x003C_PrefillValue_x003E_k__BackingField>sample string 5</_x003C_PrefillValue_x003E_k__BackingField>
<_x003C_Required_x003E_k__BackingField>true</_x003C_Required_x003E_k__BackingField>
<_x003C_StoreValueWithPattern_x003E_k__BackingField>true</_x003C_StoreValueWithPattern_x003E_k__BackingField>
<_x003C_Type_x003E_k__BackingField>Button</_x003C_Type_x003E_k__BackingField>
<_x003C_Values_x003E_k__BackingField>
<FieldData>
<_x003C_Id_x003E_k__BackingField>sample string 1</_x003C_Id_x003E_k__BackingField>
<_x003C_Value_x003E_k__BackingField>sample string 2</_x003C_Value_x003E_k__BackingField>
</FieldData>
<FieldData>
<_x003C_Id_x003E_k__BackingField>sample string 1</_x003C_Id_x003E_k__BackingField>
<_x003C_Value_x003E_k__BackingField>sample string 2</_x003C_Value_x003E_k__BackingField>
</FieldData>
<FieldData>
<_x003C_Id_x003E_k__BackingField>sample string 1</_x003C_Id_x003E_k__BackingField>
<_x003C_Value_x003E_k__BackingField>sample string 2</_x003C_Value_x003E_k__BackingField>
</FieldData>
</_x003C_Values_x003E_k__BackingField>
<_x003C_Category_x003E_k__BackingField>Other</_x003C_Category_x003E_k__BackingField>
<_x003C_MaxValue_x003E_k__BackingField>1.1</_x003C_MaxValue_x003E_k__BackingField>
<_x003C_MinValue_x003E_k__BackingField>1.1</_x003C_MinValue_x003E_k__BackingField>
<_x003C_RegEx_x003E_k__BackingField>sample string 1</_x003C_RegEx_x003E_k__BackingField>
<_x003C_RegexValueOptions_x003E_k__BackingField xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d3p1:KeyValueOfstringstring>
<d3p1:Key>sample string 1</d3p1:Key>
<d3p1:Value>sample string 2</d3p1:Value>
</d3p1:KeyValueOfstringstring>
<d3p1:KeyValueOfstringstring>
<d3p1:Key>sample string 3</d3p1:Key>
<d3p1:Value>sample string 4</d3p1:Value>
</d3p1:KeyValueOfstringstring>
<d3p1:KeyValueOfstringstring>
<d3p1:Key>sample string 5</d3p1:Key>
<d3p1:Value>sample string 6</d3p1:Value>
</d3p1:KeyValueOfstringstring>
</_x003C_RegexValueOptions_x003E_k__BackingField>
<_x003C_ValidationGroupId_x003E_k__BackingField>1</_x003C_ValidationGroupId_x003E_k__BackingField>
<_x003C_ValidationSubgroupId_x003E_k__BackingField>1</_x003C_ValidationSubgroupId_x003E_k__BackingField>
</FormField>
<FormField>
<_x003C_DefaultValue_x003E_k__BackingField>sample string 4</_x003C_DefaultValue_x003E_k__BackingField>
<_x003C_FieldCategory_x003E_k__BackingField>sample string 6</_x003C_FieldCategory_x003E_k__BackingField>
<_x003C_MaxLength_x003E_k__BackingField>1</_x003C_MaxLength_x003E_k__BackingField>
<_x003C_MinLength_x003E_k__BackingField>1</_x003C_MinLength_x003E_k__BackingField>
<_x003C_Name_x003E_k__BackingField>sample string 2</_x003C_Name_x003E_k__BackingField>
<_x003C_Pattern_x003E_k__BackingField>sample string 7</_x003C_Pattern_x003E_k__BackingField>
<_x003C_PrefillValue_x003E_k__BackingField>sample string 5</_x003C_PrefillValue_x003E_k__BackingField>
<_x003C_Required_x003E_k__BackingField>true</_x003C_Required_x003E_k__BackingField>
<_x003C_StoreValueWithPattern_x003E_k__BackingField>true</_x003C_StoreValueWithPattern_x003E_k__BackingField>
<_x003C_Type_x003E_k__BackingField>Button</_x003C_Type_x003E_k__BackingField>
<_x003C_Values_x003E_k__BackingField>
<FieldData>
<_x003C_Id_x003E_k__BackingField>sample string 1</_x003C_Id_x003E_k__BackingField>
<_x003C_Value_x003E_k__BackingField>sample string 2</_x003C_Value_x003E_k__BackingField>
</FieldData>
<FieldData>
<_x003C_Id_x003E_k__BackingField>sample string 1</_x003C_Id_x003E_k__BackingField>
<_x003C_Value_x003E_k__BackingField>sample string 2</_x003C_Value_x003E_k__BackingField>
</FieldData>
<FieldData>
<_x003C_Id_x003E_k__BackingField>sample string 1</_x003C_Id_x003E_k__BackingField>
<_x003C_Value_x003E_k__BackingField>sample string 2</_x003C_Value_x003E_k__BackingField>
</FieldData>
</_x003C_Values_x003E_k__BackingField>
<_x003C_Category_x003E_k__BackingField>Other</_x003C_Category_x003E_k__BackingField>
<_x003C_MaxValue_x003E_k__BackingField>1.1</_x003C_MaxValue_x003E_k__BackingField>
<_x003C_MinValue_x003E_k__BackingField>1.1</_x003C_MinValue_x003E_k__BackingField>
<_x003C_RegEx_x003E_k__BackingField>sample string 1</_x003C_RegEx_x003E_k__BackingField>
<_x003C_RegexValueOptions_x003E_k__BackingField xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d3p1:KeyValueOfstringstring>
<d3p1:Key>sample string 1</d3p1:Key>
<d3p1:Value>sample string 2</d3p1:Value>
</d3p1:KeyValueOfstringstring>
<d3p1:KeyValueOfstringstring>
<d3p1:Key>sample string 3</d3p1:Key>
<d3p1:Value>sample string 4</d3p1:Value>
</d3p1:KeyValueOfstringstring>
<d3p1:KeyValueOfstringstring>
<d3p1:Key>sample string 5</d3p1:Key>
<d3p1:Value>sample string 6</d3p1:Value>
</d3p1:KeyValueOfstringstring>
</_x003C_RegexValueOptions_x003E_k__BackingField>
<_x003C_ValidationGroupId_x003E_k__BackingField>1</_x003C_ValidationGroupId_x003E_k__BackingField>
<_x003C_ValidationSubgroupId_x003E_k__BackingField>1</_x003C_ValidationSubgroupId_x003E_k__BackingField>
</FormField>
<FormField>
<_x003C_DefaultValue_x003E_k__BackingField>sample string 4</_x003C_DefaultValue_x003E_k__BackingField>
<_x003C_FieldCategory_x003E_k__BackingField>sample string 6</_x003C_FieldCategory_x003E_k__BackingField>
<_x003C_MaxLength_x003E_k__BackingField>1</_x003C_MaxLength_x003E_k__BackingField>
<_x003C_MinLength_x003E_k__BackingField>1</_x003C_MinLength_x003E_k__BackingField>
<_x003C_Name_x003E_k__BackingField>sample string 2</_x003C_Name_x003E_k__BackingField>
<_x003C_Pattern_x003E_k__BackingField>sample string 7</_x003C_Pattern_x003E_k__BackingField>
<_x003C_PrefillValue_x003E_k__BackingField>sample string 5</_x003C_PrefillValue_x003E_k__BackingField>
<_x003C_Required_x003E_k__BackingField>true</_x003C_Required_x003E_k__BackingField>
<_x003C_StoreValueWithPattern_x003E_k__BackingField>true</_x003C_StoreValueWithPattern_x003E_k__BackingField>
<_x003C_Type_x003E_k__BackingField>Button</_x003C_Type_x003E_k__BackingField>
<_x003C_Values_x003E_k__BackingField>
<FieldData>
<_x003C_Id_x003E_k__BackingField>sample string 1</_x003C_Id_x003E_k__BackingField>
<_x003C_Value_x003E_k__BackingField>sample string 2</_x003C_Value_x003E_k__BackingField>
</FieldData>
<FieldData>
<_x003C_Id_x003E_k__BackingField>sample string 1</_x003C_Id_x003E_k__BackingField>
<_x003C_Value_x003E_k__BackingField>sample string 2</_x003C_Value_x003E_k__BackingField>
</FieldData>
<FieldData>
<_x003C_Id_x003E_k__BackingField>sample string 1</_x003C_Id_x003E_k__BackingField>
<_x003C_Value_x003E_k__BackingField>sample string 2</_x003C_Value_x003E_k__BackingField>
</FieldData>
</_x003C_Values_x003E_k__BackingField>
<_x003C_Category_x003E_k__BackingField>Other</_x003C_Category_x003E_k__BackingField>
<_x003C_MaxValue_x003E_k__BackingField>1.1</_x003C_MaxValue_x003E_k__BackingField>
<_x003C_MinValue_x003E_k__BackingField>1.1</_x003C_MinValue_x003E_k__BackingField>
<_x003C_RegEx_x003E_k__BackingField>sample string 1</_x003C_RegEx_x003E_k__BackingField>
<_x003C_RegexValueOptions_x003E_k__BackingField xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d3p1:KeyValueOfstringstring>
<d3p1:Key>sample string 1</d3p1:Key>
<d3p1:Value>sample string 2</d3p1:Value>
</d3p1:KeyValueOfstringstring>
<d3p1:KeyValueOfstringstring>
<d3p1:Key>sample string 3</d3p1:Key>
<d3p1:Value>sample string 4</d3p1:Value>
</d3p1:KeyValueOfstringstring>
<d3p1:KeyValueOfstringstring>
<d3p1:Key>sample string 5</d3p1:Key>
<d3p1:Value>sample string 6</d3p1:Value>
</d3p1:KeyValueOfstringstring>
</_x003C_RegexValueOptions_x003E_k__BackingField>
<_x003C_ValidationGroupId_x003E_k__BackingField>1</_x003C_ValidationGroupId_x003E_k__BackingField>
<_x003C_ValidationSubgroupId_x003E_k__BackingField>1</_x003C_ValidationSubgroupId_x003E_k__BackingField>
</FormField>
</ArrayOfFormField>