Skip to content

Remittance Inquiry

Get Remittance Status#

getRemittanceStatus

This method is used to retrieve the current remittance status.

Request Inputs#

Field Type Size Mandatory Description
agentCode String 5 Yes 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 The agent can provide apiAgentReferenceNumber in this field instead of remittanceTrackingCode, if available.

Response Outputs#

Field Type Description
resultCode String See the Result Codes and Messages table
resultMessage String
remittanceStatus String Current status of the remittance See Remittance Status Values
description String Additional description of the status

SOAP Request#

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

SOAP Response#

    <S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
    <S:Body>
        <ns3:getRemittanceStatusResponse 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:remittanceStatus>PAIDOUT</ns2:remittanceStatus>
                <ns2:description>Remittance delivered to the receiver</ns2:description>
            </return>
        </ns3:getRemittanceStatusResponse>
    </S:Body>
    </S:Envelope>

Inquiry Remittance#

inquiryRemittance

This method is used to retrieve remittance information associated with the agent.

Request Inputs#

Field Type Size Mandatory Description
agentCode String 5 Yes 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 The agent can provide apiAgentReferenceNumber in this field instead of remittanceTrackingCode, if available.

Response Outputs#

Field Type Description
resultCode String See the Result Codes and Messages table
resultMessage String
remittanceInfo Object See below remittanceInfo
sender Object See below sender
receiver Object See below receiver

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)
payingAmount Decimal
payoutAmount Decimal
payingCurrencyCode String
payoutCurrencyCode String
remittanceStatus String Current status of the remittance. See Remittance Status Values
sendingReason String
payingSettlementRate Decimal
payoutSettlementRate Decimal
settlementPayingAmount Decimal
settlementPayoutAmount Decimal
payingToPayoutRate Decimal
charges Decimal
settlementCharges Decimal
agentChargesShare Decimal
agentFXChargesShare Decimal
receiveBankName String
receiveBankCode String
receiveAccountNumber String
receiveBankBranchCode String
receiveCityName String
serviceType String
apiAgentReferenceNumber String Will be returned if available

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 be 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.
If sender type is 1, sender's birthday; if 2, company establishment date.
identityTypeCode Integer
identityTypeName String
identityNumber String
identityIssuePlace String
identityExpiryDate Date dd/MM/yyyy

receiver#

receiver Object 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)
identityTypeCode Integer
identityTypeName String
identityNumber String
identityIssuePlace String
identityExpiryDate Date dd/MM/yyyy

SOAP Request#

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

SOAP Response#

    <S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
    <S:Body>
        <ns3:inquiryRemittanceResponse 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>43598199835</ns2:remittanceTrackingCode>
                <ns2:apiAgentReferenceNumber></ns2:apiAgentReferenceNumber>
                <ns2:remittanceRecordingDate>13/07/2020 11:03:30 AM</ns2:remittanceRecordingDate>
                <ns2:sendingCountryCode>JOR</ns2:sendingCountryCode>
                <ns2:destintationCountryCode>EGY</ns2:destintationCountryCode>
                <ns2:payingAmount>0.0</ns2:payingAmount>
                <ns2:PayoutAmount>1080.99</ns2:PayoutAmount>
                <ns2:payoutCurrencyCode>EGP</ns2:payoutCurrencyCode>
                <ns2:remittanceStatus>PAIDOUT</ns2:remittanceStatus>
                <ns2:payoutSettlementRate>15.95</ns2:payoutSettlementRate>
                <ns2:settlementPayoutAmount>67.77</ns2:settlementPayoutAmount>
                <ns2:settlementPayingAmount>0.0</ns2:settlementPayingAmount>
                <ns2:payingSettlementRate>0.0</ns2:payingSettlementRate>
                <ns2:charges>2.81</ns2:charges>
                <ns2:settlementCharges>4.0</ns2:settlementPayoutCharges>
                <ns2:agentChargesShare>1.32</ns2:agentChargesShare>
                <ns2:agentFXChargesShare>0.0</ns2:agentFXChargesShare>
                </ns2:remittanceInfo>
                <ns2:sender>
                <ns2:senderId>198420</ns2:senderId>
                <ns2:type>1</ns2:type>
                <ns2:firstName>Fahid</ns2:firstName>
                <ns2:lastName>Rami</ns2:lastName>
                <ns2:mobile>00967900041</ns2:mobile>
                <ns2:address>amman</ns2:address>
                <ns2:nationalityCountryCode>JOR</ns2:nationalityCountryCode>
                <ns2:birthDateOrEstablishDate>27/02/1980</ns2:birthDateOrEstablishDate>
                <ns2:identityTypeCode>1</ns2:identityTypeCode>
                <ns2:identityTypeName>Passport</ns2:identityTypeName>
                <ns2:identityNumber>123123</ns2:identityNumber>
                <ns2:identityIssuePlace>issuer place</ns2:identityIssuePlace>
                <ns2:identityExpiryDate>27/02/2025</ns2:identityExpiryDate>
                </ns2:sender>
                <ns2:receiver>
                <ns2:receiverId>271593</ns2:receiverId>
                <ns2:type>1</ns2:type>
                <ns2:firstName>Sami</ns2:firstName>
                <ns2:middelName>Moha</ns2:middelName>
                <ns2:lastName>Dawwod</ns2:lastName>
                <ns2:mobile>2011123455555</ns2:mobile>
                <ns2:address>test</ns2:address>
                <ns2:nationalityCountryCode>EGY</ns2:nationalityCountryCode>
                <ns2:identityTypeCode>1</ns2:identityTypeCode>
                <ns2:identityTypeName>Passport</ns2:identityTypeName>
                <ns2:identityNumber>123123</ns2:identityNumber>
                <ns2:identityIssuePlace>issuer place</ns2:identityIssuePlace>
                <ns2:identityExpiryDate>27/02/2025</ns2:identityExpiryDate>
                </ns2:receiver>
            </return>
        </ns3:inquiryRemittanceResponse>
    </S:Body>
    </S:Envelope>