POST v1/Partner/CreateRecipient

Create a recipient for a customer.

Request Information

Parameters (ParameterName * = required)

Name
Description
Sample Value
Country *
The 2-letter country code of the recipient's address
MX
LastName1 *
The last name of the recipient.
Durden
CustomerRecipientRelationship *
The relationship between customer and recipient.
Friend
Id
No description available
Not available
BeneficiaryId
No description available
Not available
CustomerId
No description available
Not available
CountryOfBirth
No description available
Not available
Nationality
No description available
Not available
FirstName *
The first name of the recipient.
Tyler
MiddleName
The middle name of the recipient.
Jack
LastName2
The 2nd last name of the recipient.
Singer
Address
Address of the recipient.
1503 Ria St.
UnitNumber
Unit Number of the Recipient's Address.
Apt. 10
City *
The city of the recipient's address.
Tijuana
State *
The state abbreviation of the recipient's address.
BCN
PostalCode
Zip / Postal code of the recipient's address
80201
EmailAddress
The email of the recipient
yourname@example.com
TelephoneNumber
The phone number for the recipient.
555-555-5555
TelephoneNumberCell
The cell phone number for the recipient.
555-555-5555
MobileWalletAccountNo
The account for mobile wallet payment method
159841532582758
VirtualPaymentAccountNo
No description available
Not available
VirtualPaymentType
No description available
Not available
MobileWalletAccountTypeId
No description available
Not available
MobileWalletAccountNoPrefix
No description available
Not available
BankAccountFormatId
No description available
Not available

Response Information

Response body formats

application/json, text/json

Sample: 
{
  "lastName1": "sample string 1",
  "customerRecipientRelationship": "None",
  "id": 1,
  "beneficiaryId": 1,
  "customerId": 1,
  "country": "sample string 2",
  "countryOfBirth": "sample string 3",
  "nationality": "sample string 4",
  "firstName": "sample string 5",
  "middleName": "sample string 6",
  "lastName2": "sample string 7",
  "address": "sample string 8",
  "unitNumber": "sample string 9",
  "city": "sample string 10",
  "state": "sample string 11",
  "postalCode": "sample string 12",
  "emailAddress": "sample string 13",
  "telephoneNumber": "sample string 14",
  "telephoneNumberCell": "sample string 15",
  "mobileWalletAccountNo": "sample string 16",
  "virtualPaymentAccountNo": "sample string 17",
  "virtualPaymentType": "UPI",
  "mobileWalletAccountTypeId": 1,
  "mobileWalletAccountNoPrefix": "sample string 18",
  "bankAccountFormatId": 1
}

application/xml, text/xml

Sample: 
<BasePartnerRecipient xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Ria.Digital.WebServices.DataModels">
  <_x003C_Address_x003E_k__BackingField>sample string 8</_x003C_Address_x003E_k__BackingField>
  <_x003C_BankAccountFormatId_x003E_k__BackingField>1</_x003C_BankAccountFormatId_x003E_k__BackingField>
  <_x003C_City_x003E_k__BackingField>sample string 10</_x003C_City_x003E_k__BackingField>
  <_x003C_CountryOfBirth_x003E_k__BackingField i:nil="true" />
  <_x003C_EmailAddress_x003E_k__BackingField>sample string 13</_x003C_EmailAddress_x003E_k__BackingField>
  <_x003C_FirstName_x003E_k__BackingField>sample string 5</_x003C_FirstName_x003E_k__BackingField>
  <_x003C_LastName1_x003E_k__BackingField i:nil="true" />
  <_x003C_LastName2_x003E_k__BackingField>sample string 7</_x003C_LastName2_x003E_k__BackingField>
  <_x003C_MiddleName_x003E_k__BackingField>sample string 6</_x003C_MiddleName_x003E_k__BackingField>
  <_x003C_MobileWalletAccountNoPrefix_x003E_k__BackingField>sample string 18</_x003C_MobileWalletAccountNoPrefix_x003E_k__BackingField>
  <_x003C_MobileWalletAccountNo_x003E_k__BackingField>sample string 16</_x003C_MobileWalletAccountNo_x003E_k__BackingField>
  <_x003C_MobileWalletAccountTypeId_x003E_k__BackingField>1</_x003C_MobileWalletAccountTypeId_x003E_k__BackingField>
  <_x003C_PostalCode_x003E_k__BackingField>sample string 12</_x003C_PostalCode_x003E_k__BackingField>
  <_x003C_State_x003E_k__BackingField>sample string 11</_x003C_State_x003E_k__BackingField>
  <_x003C_TelephoneNumberCell_x003E_k__BackingField>sample string 15</_x003C_TelephoneNumberCell_x003E_k__BackingField>
  <_x003C_TelephoneNumber_x003E_k__BackingField>sample string 14</_x003C_TelephoneNumber_x003E_k__BackingField>
  <_x003C_UnitNumber_x003E_k__BackingField>sample string 9</_x003C_UnitNumber_x003E_k__BackingField>
  <_x003C_VirtualPaymentAccountNo_x003E_k__BackingField>sample string 17</_x003C_VirtualPaymentAccountNo_x003E_k__BackingField>
  <_x003C_VirtualPaymentType_x003E_k__BackingField>UPI</_x003C_VirtualPaymentType_x003E_k__BackingField>
  <_x003C_BeneficiaryId_x003E_k__BackingField>1</_x003C_BeneficiaryId_x003E_k__BackingField>
  <_x003C_CountryOfBirth_x003E_k__BackingField>sample string 3</_x003C_CountryOfBirth_x003E_k__BackingField>
  <_x003C_Country_x003E_k__BackingField>sample string 2</_x003C_Country_x003E_k__BackingField>
  <_x003C_CustomerId_x003E_k__BackingField>1</_x003C_CustomerId_x003E_k__BackingField>
  <_x003C_Id_x003E_k__BackingField>1</_x003C_Id_x003E_k__BackingField>
  <_x003C_Nationality_x003E_k__BackingField>sample string 4</_x003C_Nationality_x003E_k__BackingField>
  <_x003C_CustomerRecipientRelationship_x003E_k__BackingField>None</_x003C_CustomerRecipientRelationship_x003E_k__BackingField>
  <_x003C_LastName1_x003E_k__BackingField>sample string 1</_x003C_LastName1_x003E_k__BackingField>
</BasePartnerRecipient>