Skip to content

Account Deposit

Receive Remittance Flow Diagrams#

Agents should follow the diagrams below to correctly execute the Receive process.

The diagram below illustrates the flow for receiving an Account Deposit remittance.

The diagram below illustrates the sequence of steps for receiving an Account Deposit remittance.

Get Ready Account Deposit Remittances List#

getReadyAccountDepositRemittancesList Mandatory

This method retrieves all Account Deposit remittances (a list of RTC numbers) sent to the Agent.

Info

Retrieves remittances with status of READY.

Request Inputs#

Field Type Size Mandatory Description
agentCode String 5 Yes Receive agent code assigned by SHIFT
userId String 20 Yes User ID assigned by SHIFT
userPassword String 30 Yes User password assigned by SHIFT

Response Outputs#

Field Type Description
resultCode String See the Result Codes and Messages table
resultMessage String
RemittancesList List of Strings List of Remittance numbers

SOAP Request#

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:web="http://webservice/">
  <soapenv:Header/>
  <soapenv:Body>
    <web:getReadyAccountDepositRemittancesList>
      <agentCode>*****</agentCode>
      <userId>*****</userId>
      <userPassword>*****</userPassword>
    </web:getReadyAccountDepositRemittancesList>
  </soapenv:Body>
</soapenv:Envelope>

SOAP Response#

<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
  <S:Body>
    <ns3:getReadyAccountDepositRemittancesListResponse xmlns:ns2="http://xml.netbeans.org/schema/ApiSchema" xmlns:ns3="http://webservice/">
      <return>
        <ns2:resultCode>9000</ns2:resultCode>
        <ns2:resultMessage>Operation successfully</ns2:resultMessage>
        <ns2:remittancesList>46355266381</ns2:remittancesList>
        <ns2:remittancesList>42144170400</ns2:remittancesList>
        <ns2:remittancesList>52447059232</ns2:remittancesList>
      </return>
    </ns3:getReadyAccountDepositRemittancesListResponse>
  </S:Body>
</S:Envelope>

Get and Process Account Deposit Remittance#

getAndProcessAccountDepositRemittance Mandatory

This method retrieves Account Deposit remittance information and allows the agent to start deposit process.

Status Change

Calling this method changes the remittance status to IN PROCESS.

Request Inputs#

Field Type Size Mandatory Description
agentCode String 5 Yes Receive agent code assigned by SHIFT
userId String 20 Yes User ID assigned by SHIFT
userPassword String 30 Yes User password assigned by SHIFT
remittanceTrackingCode String 20 Yes The number retrieved from getReadyAccountDepositRemittancesList

Response Outputs#

Field Type Description
resultCode String See the Result Codes and Messages table
resultMessage String
remittanceInfo Object Remittance information object.
See below remittanceInfo

remittanceInfo#

remittanceInfo Object fields
Field Type Description
remittanceTrackingCode String
remittanceRecordingDate Date Format: dd/MM/yyyy
sendingCountryCode String ISO Alpha-3 (3166)
destinationCountryCode String ISO Alpha-3 (3166)
PayoutAmount Decimal Final amount that should be delivered to the receiver.
PayoutCurrencyCode String
remittanceStatus String Status READY
payoutSettlementRate Decimal
settlementPayoutAmount Decimal Payout amount in settlement currency "USD"
receiveBankName String Bank name
receiveBranchName String Branch name
receiveAccountNumber String Bank account number
otherBank String YES or NO
receiveBankCode String Bank code
receiveBranchCode String Bank branch code
receiveRoutingNumbe String Routing Number
receiverSortCode String Sort Code
receiverSwiftBIC String Swift/BIC
sender Object See below sender
receiver Object See below receiver
sendingReason String
sender#
sender Object fields
Field Type Description
senderID String
type Integer See the type table
firstName String This field is available if the sender type is 1
Allowed characters: English letters (A-Z, a-z) and spaces only
middleName String This field may available if the sender type is 1
Allowed characters: English letters (A-Z, a-z) and spaces only
lastName String This field is available if the sender type is 1
Allowed characters: English letters (A-Z, a-z) and spaces only
enName String This field is available if the sender type is 2
Allowed characters: English letters (A-Z, a-z) and spaces only
telephone String
mobile String
address String
nationalityCountryCode String ISO Alpha-3 (3166)
birthDateOrEstablishDate Date Format: dd/MM/yyyy
identityTypeCode Integer
identityTypeName String
identityNumber String
receiver#
receiver fields
Field Type Description
receiverID String
type Integer See the type table
firstName String This field is available if the receiver type is 1
Allowed characters: English letters (A-Z, a-z) and spaces only
middleName String This field may be available if the receiver type is 1
Allowed characters: English letters (A-Z, a-z) and spaces only
lastName String This field is available if the receiver type is 1
Allowed characters: English letters (A-Z, a-z) and spaces only
enName String This field is available if the receiver type is 2
Allowed characters: English letters (A-Z, a-z) and spaces only
telephone String
mobile String
address String
nationalityCountryCode String ISO Alpha-3 (3166)

SOAP Request#

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:web="http://webservice/">
  <soapenv:Header/>
  <soapenv:Body>
    <web:getAndProcessAccountDepositRemittance>
      <remittancTrackingCode>46355266381</remittancTrackingCode>
      <agentCode>*****</agentCode>
      <userId>*****</userId>
      <userPassword>*****</userPassword>
    </web:getAndProcessAccountDepositRemittance>
  </soapenv:Body>
</soapenv:Envelope>

SOAP Response#

<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
  <S:Body>
    <ns3:getAndProcessAccountDepositRemittanceResponse xmlns:ns2="http://xml.netbeans.org/schema/ApiSchema" xmlns:ns3="http://webservice/">
      <return>
        <ns2:resultCode>9000</ns2:resultCode>
        <ns2:resultMessage>Operation successfully</ns2:resultMessage>
        <ns2:remittanceInfo>
          <ns2:remittanceTrackingCode>46355266381</ns2:remittanceTrackingCode>
          <ns2:remittanceRecordingDate>13/07/2020 09:56:09 AM</ns2:remittanceRecordingDate>
          <ns2:sendingCountryCode>JOR</ns2:sendingCountryCode>
          <ns2:destintationCountryCode>JOR</ns2:destintationCountryCode>
          <ns2:payingAmount>0.0</ns2:payingAmount>
          <ns2:PayoutAmount>100.0</ns2:PayoutAmount>
          <ns2:payoutCurrencyCode>JOD</ns2:payoutCurrencyCode>
          <ns2:remittanceStatus>READY</ns2:remittanceStatus>
          <ns2:payoutSettlementRate>0.7084</ns2:payoutSettlementRate>
          <ns2:settlementPayoutAmount>141.16</ns2:settlementPayoutAmount>
          <ns2:sender>
            <ns2:senderId>200299</ns2:senderId>
            <ns2:firstName>Mohammed</ns2:firstName>
            <ns2:lastName>Alsheik</ns2:lastName>
            <ns2:telephone/>
            <ns2:mobile>962798420540</ns2:mobile>
            <ns2:email>mohammedata79@gmail.com</ns2:email>
            <ns2:address>Test AddressssseeeTRETRETRET</ns2:address>
            <ns2:nationalityCountryCode>JOR</ns2:nationalityCountryCode>
            <ns2:birthDate>07/11/1979</ns2:birthDate>
            <ns2:identityTypeCode>1</ns2:identityTypeCode>
            <ns2:identityTypeName>Passport</ns2:identityTypeName>
            <ns2:identityNumber>1236587888</ns2:identityNumber>
          </ns2:sender>
          <ns2:receiver>
            <ns2:receiverId>271588</ns2:receiverId>
            <ns2:type>1</ns2:type>
            <ns2:firstName>Sdfs</ns2:firstName>
            <ns2:lastName>Sdf</ns2:lastName>
            <ns2:telephone/>
            <ns2:mobile>242342332424</ns2:mobile>
            <ns2:address>dfdsdsfsd</ns2:address>
            <ns2:nationalityCountryCode>JOR</ns2:nationalityCountryCode>
          </ns2:receiver>
          <ns2:receiveBankName>Arab Bank</ns2:receiveBankName>
          <ns2:receiveAccountNumber>3234234234</ns2:receiveAccountNumber>
          <ns2:otherBank>YES</ns2:otherBank>
          <ns2:payingToPayoutRate>0.0</ns2:payingToPayoutRate>
          <ns2:receiveBankCode>A12345</ns2:receiveBankCode>
          <ns2:receiveRountringNumber>111110000</ns2:receiveRountringNumber>
          <ns2:receiveSortCode>453543543</ns2:receiveSortCode>
          <ns2:receiveSwiftBic>BJORJOAX</ns2:receiveSwiftBic>
          <ns2:sendingReason>Travel Expenses</ns2:sendingReason>
        </ns2:remittanceInfo>
      </return>
    </ns3:getAndProcessAccountDepositRemittanceResponse>
  </S:Body>
</S:Envelope>

Pay Account Deposit Remittance#

PayAccountDepositRemittance Mandatory

This method is used to complete the receiving process for an Account Deposit remittance.

Status Change

Calling this method changes the remittance status to PAIDOUT.

Request Inputs#

Field Type Size Mandatory Description
agentCode String 5 Yes Receive agent code assigned by SHIFT
userId String 20 Yes User ID assigned by SHIFT
userPassword String 30 Yes User password assigned by SHIFT
remittancTrackingCode String 20 Yes

Response Outputs#

Field Type Description
resultCode String See the Result Codes and Messages table
resultMessage String

SOAP Request#

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:web="http://webservice/">
  <soapenv:Header/>
  <soapenv:Body>
    <web:PayAccountDepositRemittance>
      <remittancTrackingCode>46355266381</remittancTrackingCode>
      <agentCode>*****</agentCode>
      <userId>*****</userId>
      <userPassword>*****</userPassword>
    </web:PayAccountDepositRemittance>
  </soapenv:Body>
</soapenv:Envelope>

SOAP Response#

<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
  <S:Body>
    <ns3:PayAccountDepositRemittanceResponse xmlns:ns2="http://xml.netbeans.org/schema/ApiSchema" xmlns:ns3="http://webservice/">
      <return>
        <ns2:resultCode>9000</ns2:resultCode>
        <ns2:resultMessage>Operation successfully</ns2:resultMessage>
      </return>
    </ns3:PayAccountDepositRemittanceResponse>
  </S:Body>
</S:Envelope>