POST api/Grantor/GetReference

Generar referencia para pago de onboarding

Request Information

URI Parameters

None.

Body Parameters

Name	Description	Type	Additional information
GrantorTaxId	RFC de la empresa	string	None.
CustomerTaxId	RFC del cliente	string	None.
CustomerBusinessName	Razón social del cliente	string	None.
ApplicationCode	Aplicación	string	None.
Amount	Cantidad	decimal number	None.

Request Formats

application/json, text/json

Sample:

{
  "GrantorTaxId": "sample string 1",
  "CustomerTaxId": "sample string 2",
  "CustomerBusinessName": "sample string 3",
  "ApplicationCode": "sample string 4",
  "Amount": 5.0
}

application/xml, text/xml

Sample:

<OnboardingReferenceApiModel xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <GrantorTaxId>sample string 1</GrantorTaxId>
  <CustomerTaxId>sample string 2</CustomerTaxId>
  <CustomerBusinessName>sample string 3</CustomerBusinessName>
  <ApplicationCode>sample string 4</ApplicationCode>
  <Amount>5</Amount>
</OnboardingReferenceApiModel>

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'OnboardingReferenceApiModel'.

Response Information

Resource Description

ResponseModelApiOfOnboardingReferenceModel

Name	Description	Type	Additional information
success	Indica si la solicitud se procesó de manera satisfactoria	boolean	None.
message	Mensaje de la solicitud	string	None.
messageDetail	Lista de mensajes	Collection of string	None.
failureCode	Código de error en caso de existir	string	None.
data	Layout de respuesta de la solicitud	OnboardingReferenceModel	None.

Response Formats

application/json, text/json

Sample:

{
  "success": true,
  "message": "sample string 2",
  "messageDetail": [
    "sample string 1",
    "sample string 2"
  ],
  "failureCode": "sample string 3",
  "data": {
    "Reference": "sample string 1",
    "StandarizedBankingKey": "sample string 2",
    "Bank": "sample string 3",
    "Beneficiary": "sample string 4"
  }
}

application/xml, text/xml

Sample:

<ResponseModelApiOfOnboardingReferenceModel xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <success>true</success>
  <message>sample string 2</message>
  <messageDetail>
    <string>sample string 1</string>
    <string>sample string 2</string>
  </messageDetail>
  <failureCode>sample string 3</failureCode>
  <data>
    <Reference>sample string 1</Reference>
    <StandarizedBankingKey>sample string 2</StandarizedBankingKey>
    <Bank>sample string 3</Bank>
    <Beneficiary>sample string 4</Beneficiary>
  </data>
</ResponseModelApiOfOnboardingReferenceModel>