PUT api/Grantor/ExternalPaymentAffiliation

Afiliación de medios de pago.

Request Information

URI Parameters

None.

Body Parameters

Datos necesarios para la afilación

Name	Description	Type	Additional information
GrantorTaxId	RFC de la empresa	string	Required
WebSiteURL	Sitio Web	string	Required Max length: 45
WebSiteDescription	Descripción	string	Required Max length: 100
OpenPayClassificationId	Clasificación	string	Required
SendPhysicalProducts	Realiza envíos de productos físicos	boolean	Required
TypeOfProduct	Tipo de productos	string	None.
Activity	Actividad comercial	string	None.
MonthlySales	Ventas mensuales	string	Required
AverageSale	Venta promedio	string	Required
ProofOfAddress	Comprobante de domicilio	FileApiModel	Required
FiscalSituationCertificate	Constancia de situación fiscal	FileApiModel	Required
ConstitutiveAct	Acta constitutiva (requerido personas morales)	FileApiModel	None.
ElectoralIDCardPassport_Image	Credencial de elector/pasaporte (requerido personas morales)	FileApiModel	Required
ElectoralIDCardPassport_Number	Número de credencial de elector/pasaporte (requerido personas morales)	string	Required
PowerOfAttorney	Carta poder (requerido personas morales)	FileApiModel	None.
BithDateLegalRepresentative	Carta poder (requerido personas morales)	date	None.
FunctionaryPhone	Teléfono del representante	string	Required Min length: 10
FunctionaryExtension	Extensión del representante	string	Matching regular expression pattern: ^[0-9]*$
FunctionaryCellphone	Celular del representante	string	Required Min length: 10
BankCc	Institución de cuenta concentradora	integer	Required
DayOfWeekToReceivePayment	Selecciona el día que quieres recibir tu pago	integer	Required Max length: 45
PaymentProviderTypeId	Proveedor de medio de pago para Visa y MasterCard	integer	None.
ContractsSigned	Lista de contratos firmados	Collection of SimpleLegalContractApiModel	None.

Request Formats

application/json, text/json

Sample:

{
  "GrantorTaxId": "sample string 1",
  "WebSiteURL": "sample string 2",
  "WebSiteDescription": "sample string 3",
  "OpenPayClassificationId": "sample string 4",
  "SendPhysicalProducts": true,
  "TypeOfProduct": "sample string 6",
  "Activity": "sample string 7",
  "MonthlySales": "sample string 8",
  "AverageSale": "sample string 9",
  "ProofOfAddress": {
    "Filename": "sample string 1",
    "ContentType": "sample string 2",
    "Content": "sample string 3",
    "Name": "sample string 4"
  },
  "FiscalSituationCertificate": {
    "Filename": "sample string 1",
    "ContentType": "sample string 2",
    "Content": "sample string 3",
    "Name": "sample string 4"
  },
  "ConstitutiveAct": {
    "Filename": "sample string 1",
    "ContentType": "sample string 2",
    "Content": "sample string 3",
    "Name": "sample string 4"
  },
  "ElectoralIDCardPassport_Image": {
    "Filename": "sample string 1",
    "ContentType": "sample string 2",
    "Content": "sample string 3",
    "Name": "sample string 4"
  },
  "ElectoralIDCardPassport_Number": "sample string 10",
  "PowerOfAttorney": {
    "Filename": "sample string 1",
    "ContentType": "sample string 2",
    "Content": "sample string 3",
    "Name": "sample string 4"
  },
  "BithDateLegalRepresentative": "2025-01-06T06:46:47.1629391-06:00",
  "FunctionaryPhone": "sample string 12",
  "FunctionaryExtension": "sample string 13",
  "FunctionaryCellphone": "sample string 14",
  "BankCc": 1,
  "DayOfWeekToReceivePayment": 15,
  "PaymentProviderTypeId": 16,
  "ContractsSigned": [
    {
      "ContractId": "08dd2e50-2ea9-f24f-522b-6e467c15d3a0",
      "Text": "sample string 2",
      "Name": "sample string 3",
      "BankAccountId": "08dd2e50-2ea9-f24f-522b-6e467c15d3a1",
      "LegalContractId": 4
    },
    {
      "ContractId": "08dd2e50-2ea9-f24f-522b-6e467c15d3a0",
      "Text": "sample string 2",
      "Name": "sample string 3",
      "BankAccountId": "08dd2e50-2ea9-f24f-522b-6e467c15d3a1",
      "LegalContractId": 4
    }
  ]
}

application/xml, text/xml

Sample:

<ProviderCreditCardApiModel xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <GrantorTaxId>sample string 1</GrantorTaxId>
  <WebSiteURL>sample string 2</WebSiteURL>
  <WebSiteDescription>sample string 3</WebSiteDescription>
  <OpenPayClassificationId>sample string 4</OpenPayClassificationId>
  <SendPhysicalProducts>true</SendPhysicalProducts>
  <TypeOfProduct>sample string 6</TypeOfProduct>
  <Activity>sample string 7</Activity>
  <MonthlySales>sample string 8</MonthlySales>
  <AverageSale>sample string 9</AverageSale>
  <ProofOfAddress>
    <Filename>sample string 1</Filename>
    <ContentType>sample string 2</ContentType>
    <Content>sample string 3</Content>
    <Name>sample string 4</Name>
  </ProofOfAddress>
  <FiscalSituationCertificate>
    <Filename>sample string 1</Filename>
    <ContentType>sample string 2</ContentType>
    <Content>sample string 3</Content>
    <Name>sample string 4</Name>
  </FiscalSituationCertificate>
  <ConstitutiveAct>
    <Filename>sample string 1</Filename>
    <ContentType>sample string 2</ContentType>
    <Content>sample string 3</Content>
    <Name>sample string 4</Name>
  </ConstitutiveAct>
  <ElectoralIDCardPassport_Image>
    <Filename>sample string 1</Filename>
    <ContentType>sample string 2</ContentType>
    <Content>sample string 3</Content>
    <Name>sample string 4</Name>
  </ElectoralIDCardPassport_Image>
  <ElectoralIDCardPassport_Number>sample string 10</ElectoralIDCardPassport_Number>
  <PowerOfAttorney>
    <Filename>sample string 1</Filename>
    <ContentType>sample string 2</ContentType>
    <Content>sample string 3</Content>
    <Name>sample string 4</Name>
  </PowerOfAttorney>
  <BithDateLegalRepresentative>2025-01-06T06:46:47.1629391-06:00</BithDateLegalRepresentative>
  <FunctionaryPhone>sample string 12</FunctionaryPhone>
  <FunctionaryExtension>sample string 13</FunctionaryExtension>
  <FunctionaryCellphone>sample string 14</FunctionaryCellphone>
  <BankCc>1</BankCc>
  <DayOfWeekToReceivePayment>15</DayOfWeekToReceivePayment>
  <PaymentProviderTypeId>16</PaymentProviderTypeId>
  <ContractsSigned>
    <SimpleLegalContractApiModel>
      <ContractId>08dd2e50-2ea9-f24f-522b-6e467c15d3a0</ContractId>
      <Text>sample string 2</Text>
      <Name>sample string 3</Name>
      <BankAccountId>08dd2e50-2ea9-f24f-522b-6e467c15d3a1</BankAccountId>
      <LegalContractId>4</LegalContractId>
    </SimpleLegalContractApiModel>
    <SimpleLegalContractApiModel>
      <ContractId>08dd2e50-2ea9-f24f-522b-6e467c15d3a0</ContractId>
      <Text>sample string 2</Text>
      <Name>sample string 3</Name>
      <BankAccountId>08dd2e50-2ea9-f24f-522b-6e467c15d3a1</BankAccountId>
      <LegalContractId>4</LegalContractId>
    </SimpleLegalContractApiModel>
  </ContractsSigned>
</ProviderCreditCardApiModel>

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 'ProviderCreditCardApiModel'.

Response Information

Resource Description

ResponseModelApiOfBoolean

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	boolean	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": true
}

application/xml, text/xml

Sample:

<ResponseModelApiOfBoolean 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>true</data>
</ResponseModelApiOfBoolean>