POST api/Withdrawal?callId={callId}&withdrawalType={withdrawalType}&pin={pin}

Metodo que invoca el servicio web para ejecutar retiros.

Request Information

URI Parameters

Name	Description	Type	Additional information
callId	Id de la llamada	string	Required
withdrawalType	Tipo de retiro. Parcial, total, express	WithdrawalType	Required
pin	Pin para el retiro	string	Required

Body Parameters

Parametros del retiro

WithdrawalParams

Name	Type	Additional information
AditionalParams	Collection of AditionalParam	None.
BankAccountInfo	BankAccountInfo	None.
ChequeInfo	ChequeInfo	None.
Comments	string	None.
ContractNumber	integer	None.
DestinationType	DestinationType	None.
DocNumber	string	None.
DocType	string	None.
Flags	WithdrawalFlags	None.
PlanCode	string	None.
ProductCode	string	None.
ThirdPartyInfo	PersonInfo	None.
TransferInfo	TransferInfo	None.
Value	decimal number	None.

Request Formats

application/json, text/json

Sample:

{
  "AditionalParams": [
    {
      "Key": "sample string 1",
      "Value": "sample string 2"
    },
    {
      "Key": "sample string 1",
      "Value": "sample string 2"
    }
  ],
  "BankAccountInfo": {
    "AccountNumber": "sample string 1",
    "AccountType": 0,
    "BankId": "sample string 2",
    "BankName": "sample string 3"
  },
  "ChequeInfo": {
    "AuthorizedPersonInfo": {
      "DocNumber": "sample string 1",
      "DocType": "sample string 2",
      "FirstName": "sample string 3",
      "LastName": "sample string 4"
    },
    "BankId": "sample string 1",
    "BankName": "sample string 2",
    "BranchName": "sample string 3",
    "CityName": "sample string 4"
  },
  "Comments": "sample string 1",
  "ContractNumber": 2,
  "DestinationType": 0,
  "DocNumber": "sample string 3",
  "DocType": "sample string 4",
  "Flags": 0,
  "PlanCode": "sample string 5",
  "ProductCode": "sample string 6",
  "ThirdPartyInfo": {
    "DocNumber": "sample string 1",
    "DocType": "sample string 2",
    "FirstName": "sample string 3",
    "LastName": "sample string 4"
  },
  "TransferInfo": {
    "ContractNumber": 1,
    "PlanCode": "sample string 2",
    "ProductCode": "sample string 3"
  },
  "Value": 7.0
}

application/xml, text/xml

Sample:

<WithdrawalParams xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OM.Withdrawals.Entities">
  <AditionalParams>
    <AditionalParam>
      <Key>sample string 1</Key>
      <Value>sample string 2</Value>
    </AditionalParam>
    <AditionalParam>
      <Key>sample string 1</Key>
      <Value>sample string 2</Value>
    </AditionalParam>
  </AditionalParams>
  <BankAccountInfo>
    <AccountNumber>sample string 1</AccountNumber>
    <AccountType>Savings</AccountType>
    <BankId>sample string 2</BankId>
    <BankName>sample string 3</BankName>
  </BankAccountInfo>
  <ChequeInfo>
    <AuthorizedPersonInfo>
      <DocNumber>sample string 1</DocNumber>
      <DocType>sample string 2</DocType>
      <FirstName>sample string 3</FirstName>
      <LastName>sample string 4</LastName>
    </AuthorizedPersonInfo>
    <BankId>sample string 1</BankId>
    <BankName>sample string 2</BankName>
    <BranchName>sample string 3</BranchName>
    <CityName>sample string 4</CityName>
  </ChequeInfo>
  <Comments>sample string 1</Comments>
  <ContractNumber>2</ContractNumber>
  <DestinationType>None</DestinationType>
  <DocNumber>sample string 3</DocNumber>
  <DocType>sample string 4</DocType>
  <Flags>None</Flags>
  <PlanCode>sample string 5</PlanCode>
  <ProductCode>sample string 6</ProductCode>
  <ThirdPartyInfo>
    <DocNumber>sample string 1</DocNumber>
    <DocType>sample string 2</DocType>
    <FirstName>sample string 3</FirstName>
    <LastName>sample string 4</LastName>
  </ThirdPartyInfo>
  <TransferInfo>
    <ContractNumber>1</ContractNumber>
    <PlanCode>sample string 2</PlanCode>
    <ProductCode>sample string 3</ProductCode>
  </TransferInfo>
  <Value>7</Value>
</WithdrawalParams>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

Respuesta del retiro

WithdrawalResponse

Name	Type	Additional information
AdditionalInfo	string	None.
ConfirmationNumber	string	None.
ProccessDate	date	None.
Success	boolean	None.
TransferDate	date	None.

Response Formats

application/json, text/json

Sample:

{
  "AdditionalInfo": "sample string 1",
  "ConfirmationNumber": "sample string 2",
  "ProccessDate": "2026-05-16T13:10:49.0134419-05:00",
  "Success": true,
  "TransferDate": "2026-05-16T13:10:49.0134419-05:00"
}

application/xml, text/xml

Sample:

<WithdrawalResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OM.Withdrawals.Entities">
  <AdditionalInfo>sample string 1</AdditionalInfo>
  <ConfirmationNumber>sample string 2</ConfirmationNumber>
  <ProccessDate>2026-05-16T13:10:49.0134419-05:00</ProccessDate>
  <Success>true</Success>
  <TransferDate>2026-05-16T13:10:49.0134419-05:00</TransferDate>
</WithdrawalResponse>