GET api/Payment/ExternalCode/{GrantorTaxId}/{ExternalId}

Obtener pago por ExternalId

Request Information

URI Parameters

NameDescriptionTypeAdditional information
GrantorTaxId

RFC del grantor

 string

Required
ExternalId

Identificador externo del pago

 string

Required

Body Parameters

None.

Response Information

Resource Description

ResponseModelApiOfpaymentModelpApi
NameDescriptionTypeAdditional 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

 paymentModelpApi

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": {
    "GrantorTaxId": "sample string 1",
    "GrantorBusinessName": "sample string 2",
    "CustomerTaxId": "sample string 3",
    "CustomerBusinessName": "sample string 4",
    "Serial": "sample string 5",
    "Folio": "sample string 6",
    "ExternalDocumentId": "08dd2e4e-2f85-670a-ba1f-9f167cb487d0",
    "ReferenceDocumentId": "08dd2e4e-2f85-670a-ba1f-9f167cb487d1",
    "DocumentId": "08dd2e4e-2f85-670a-ba1f-9f167cb487d2",
    "IsExternal": true,
    "IsInKind": true,
    "Comments": "sample string 8",
    "IsLoadedByAPI": true,
    "ReferencePayment": "sample string 9",
    "BankCode": "sample string 10",
    "BankAccountNumber": "sample string 11",
    "BankTrackingId": "sample string 12",
    "TecSouTrackingId": "sample string 13",
    "TransactionDate": "2025-01-06T06:32:29.6077066-06:00",
    "ValueDate": "2025-01-06T06:32:29.6077066-06:00",
    "ReconciliationTypeId": 64,
    "PaymentDate": "2025-01-06T06:32:29.6077066-06:00",
    "AmountPayment": 1.0,
    "PaymentId": "08dd2e4e-2f85-670a-ba1f-9f167cb487d3",
    "PaymentMethodId": 1,
    "Status": "sample string 14",
    "WayToPaySAT_ID": "sample string 15",
    "WayToPaySAT_Name": "sample string 16",
    "PaymentType": "sample string 17",
    "HolderAccount": "sample string 18",
    "HolderName": "sample string 19",
    "CurrencyId": "sample string 20",
    "CurrencyName": "sample string 21",
    "ExchangeRate": 1.0,
    "CreationDate": "2025-01-06T06:32:29.6077066-06:00",
    "StatusRep": "sample string 22",
    "StatusPayment": "sample string 23",
    "Metadata": "sample string 24",
    "Files": [
      {
        "FileId": "08dd2e4e-2f85-670a-ba1f-9f167cb487d4",
        "FileName": "sample string 2",
        "FileContent": "sample string 3",
        "FileTypeName": "sample string 4",
        "IsFiscal": true,
        "CreationDate": "2025-01-06T06:32:29.6077066-06:00"
      },
      {
        "FileId": "08dd2e4e-2f85-670a-ba1f-9f167cb487d4",
        "FileName": "sample string 2",
        "FileContent": "sample string 3",
        "FileTypeName": "sample string 4",
        "IsFiscal": true,
        "CreationDate": "2025-01-06T06:32:29.6077066-06:00"
      }
    ]
  }
}

application/xml, text/xml

Sample: 
<ResponseModelApiOfpaymentModelpApi 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>
    <GrantorTaxId>sample string 1</GrantorTaxId>
    <GrantorBusinessName>sample string 2</GrantorBusinessName>
    <CustomerTaxId>sample string 3</CustomerTaxId>
    <CustomerBusinessName>sample string 4</CustomerBusinessName>
    <Serial>sample string 5</Serial>
    <Folio>sample string 6</Folio>
    <ExternalDocumentId>08dd2e4e-2f85-670a-ba1f-9f167cb487d0</ExternalDocumentId>
    <ReferenceDocumentId>08dd2e4e-2f85-670a-ba1f-9f167cb487d1</ReferenceDocumentId>
    <DocumentId>08dd2e4e-2f85-670a-ba1f-9f167cb487d2</DocumentId>
    <IsExternal>true</IsExternal>
    <IsInKind>true</IsInKind>
    <Comments>sample string 8</Comments>
    <IsLoadedByAPI>true</IsLoadedByAPI>
    <ReferencePayment>sample string 9</ReferencePayment>
    <BankCode>sample string 10</BankCode>
    <BankAccountNumber>sample string 11</BankAccountNumber>
    <BankTrackingId>sample string 12</BankTrackingId>
    <TecSouTrackingId>sample string 13</TecSouTrackingId>
    <TransactionDate>2025-01-06T06:32:29.6077066-06:00</TransactionDate>
    <ValueDate>2025-01-06T06:32:29.6077066-06:00</ValueDate>
    <ReconciliationTypeId>64</ReconciliationTypeId>
    <PaymentDate>2025-01-06T06:32:29.6077066-06:00</PaymentDate>
    <AmountPayment>1</AmountPayment>
    <PaymentId>08dd2e4e-2f85-670a-ba1f-9f167cb487d3</PaymentId>
    <PaymentMethodId>1</PaymentMethodId>
    <Status>sample string 14</Status>
    <WayToPaySAT_ID>sample string 15</WayToPaySAT_ID>
    <WayToPaySAT_Name>sample string 16</WayToPaySAT_Name>
    <PaymentType>sample string 17</PaymentType>
    <HolderAccount>sample string 18</HolderAccount>
    <HolderName>sample string 19</HolderName>
    <CurrencyId>sample string 20</CurrencyId>
    <CurrencyName>sample string 21</CurrencyName>
    <ExchangeRate>1</ExchangeRate>
    <CreationDate>2025-01-06T06:32:29.6077066-06:00</CreationDate>
    <StatusRep>sample string 22</StatusRep>
    <StatusPayment>sample string 23</StatusPayment>
    <Metadata>sample string 24</Metadata>
    <Files>
      <FilesModelApi>
        <FileId>08dd2e4e-2f85-670a-ba1f-9f167cb487d4</FileId>
        <FileName>sample string 2</FileName>
        <FileContent>sample string 3</FileContent>
        <FileTypeName>sample string 4</FileTypeName>
        <IsFiscal>true</IsFiscal>
        <CreationDate>2025-01-06T06:32:29.6077066-06:00</CreationDate>
      </FilesModelApi>
      <FilesModelApi>
        <FileId>08dd2e4e-2f85-670a-ba1f-9f167cb487d4</FileId>
        <FileName>sample string 2</FileName>
        <FileContent>sample string 3</FileContent>
        <FileTypeName>sample string 4</FileTypeName>
        <IsFiscal>true</IsFiscal>
        <CreationDate>2025-01-06T06:32:29.6077066-06:00</CreationDate>
      </FilesModelApi>
    </Files>
  </data>
</ResponseModelApiOfpaymentModelpApi>