Show Menu

Create Beneficiary Company

Create Beneficiary Company

This allows you to create your company beneficiaries, i.e. companies you want to pay. These will be reviewed for KYC (Know Your Customer) compliance so be sure the information submitted is real and accurate. Do not create test companies or emails on production servers.

post/API/v4/Beneficiary/CreateBeneficiary

Header Parameters

Authorizationstring

bearer access_token

Content-typestring

application/json

Request Parameters

IssuerAccountNumberstring

String length: inclusive between 1 and 25

BeneficiaryCompanyNamestring

String length: inclusive between 1 and 50. This will be reviewed for KYC (Know Your Customer) compliance so be sure the information submitted is real and accurate. Do not create test companies or emails on production servers.

WebAddressstring

String length: inclusive between 1 and 50. This will be reviewed for KYC (Know Your Customer) compliance so be sure the information submitted is real and accurate. Do not create test companies or emails on production servers.

BeneficiaryCompanyAdminDetails

AdminEmailstring

String length: inclusive between 1 and 50. This will be reviewed for KYC (Know Your Customer) compliance so be sure the information submitted is real and accurate. Do not create test companies or emails on production servers. Please do not use generic email domains like @gmail.com or @hotmail.com or email groups like support@acme.com or development@acme.com. Please use the personal email of the main administrator or contact at the company to avoid compliance issues and the company account being closed.

EmailNotificationboolean

AdminFirstNamestring

String length: inclusive between 2 and 50. This will be reviewed for KYC (Know Your Customer) compliance so be sure the information submitted is real and accurate. Do not create test companies or emails on production servers.

AdminLastNamestring

String length: inclusive between 2 and 40. This will be reviewed for KYC (Know Your Customer) compliance so be sure the information submitted is real and accurate. Do not create test companies or emails on production servers.

AdminMobileNumberstring

String length: inclusive between 1 and 25

Citystring

String length: inclusive between 1 and 50

Countrystring

String length: inclusive between 1 and 50. This will be reviewed for KYC (Know Your Customer) compliance so be sure the information submitted is real and accurate. Do not create test companies or emails on production servers.

Regionstring

String length: inclusive between 1 and 50

PostalCodestring

String length: inclusive between 1 and 50

SalesProgramDetails

PartnerAccountManagerstring

String length: inclusive between 1 and 100

SalesforcePartnerIDstring

String length: inclusive between 1 and 50

OtherPartnerIDstring

String length: inclusive between 1 and 50

OtherPartnerIDstring

String length: inclusive between 1 and 50

PartnerLevelstring

String length: inclusive between 1 and 50

Response Parameters

CreateBeneficiaryResponsestring

Returned if successful BeneficiaryID—Beneficiary ID
ClientID—Client ID
SecretKey—Secret Key

OperationStatusstring

Always returned Indicates the status of the operation. Allowed parameters are:
Errors - Displays an error message if the Property name Obligation Definition/value operation was unsuccessful. For more information, see API Error Message Appendix.
Success—Indicates whether the operation was successful. Returns True if the action was successful or False if it was not successful.

Sample Request:

sandbox.xapi.xtrm.com/API/v4/Beneficiary/CreateBeneficiary

{
  "CreateBeneficiary": {
    "Request": {
      "IssuerAccountNumber": "SPN Account Number",
      "BeneficiaryCompanyName": "Company Name",
      "WebAddress": "Website URL",
      "BeneficiaryCompanyAdminDetails": {
      	"AdminEmail":"Email ID",
        "EmailNotification" :"true/false",
      	"AdminFirstName":"First Name",
        "AdminLastName":"Last Name",
        "AdminMobileNumber":"Mobile Number",
        "City":"City",
        "Country":"Country",
        "Region":"Region/State/County",
         "PostalCode":"Postal Code"
      },
      "SalesProgramDetails": {
        "PartnerAccountManager": "Partner Account Manager",
        "SalesforcePartnerID": "Salesforce Partner ID",
        "OtherPartnerID": "Other Partner ID",
        "Region": "Region",
        "PartnerLevel": "Partner Level"
      }
    }
  }
}
						

Sample Response:


{
	"CreateBeneficiaryResponse": {
		"CreateBeneficiaryResult": {
			"BeneficiaryID": "SPN1781903",
            "AccountIdentityLevel": "Pending",
			"ClientID": "1710033_API_User",
			"SecretKey": "yyWTjFS6MPXBx5DYxyKN9KgROopx0UAL810K/9R3EI=",
			"OperationStatus": {
				"Success": true,
				"Errors": []
			}
		}
	}
}