Skip to content

SHIFT Remittances API Version 3.8.0#

Agent Integration Guide & Technical Documentation

Introduction#

SHIFT aims to enter and serve markets that need its services through a planned and targeted expansion. It also works to build a network of agents that can provide customers with reliable services at the most convenient time and place.

To improve SHIFT's products and services and simplify the integration process between agents' systems and SHIFT, this document explains how to connect with SHIFT Online Remittance Services using web services.

SHIFT Standards#

  • Fast Service: Your money is in the hands of your loved ones in moments.
  • Secure Service: High-end technology that ensures the security of the information, transfers, and full protection of your transfers against piracy and theft.
  • Reliable Service: Ensure the preservation of the highest quality standards and reliability in all ordinary and urgent circumstances.
  • Service Efficiency: The capability of the SHIFT system to serve the clients with high efficiency at all the locations that provide the service and around the clock.

Remittance concept#

Remittance Life Cycle#

SHIFT Web Service Overview#

SHIFT Web Service is a collection of web methods hosted on an application server. These web methods can be invoked remotely over a network or the Internet. To call a web method, a SOAP message (described later) is created and sent to the web service via HTTP or another supported transport protocol. Typically, the web service returns a response message for each method call, containing either the requested data or fault information in case of an error.

A SOAP message is an XML-based document that follows a defined standard. The SOAP specification provides a structured way to package a request to a web method and to return its corresponding response.

The SHIFT API enables seamless integration between agents' client-service systems and the SHIFT core system, allowing real-time processing of remittances. The API is implemented as a SOAP web service and defined through a WSDL (Web Services Description Language) file. The WSDL specifies a single web service operation with an input parameter named Request and an output parameter named Response, allowing the exchange of valid XML data as both input and output.

SHIFT also provides a set of XML Schemas that define the format of the request and response elements. These schemas can be used to validate the XML request on the client side before it is sent to the server. As a result, the web service is considered strongly typed, ensuring consistent and structured communication between systems.

SHIFT Web Services Security#

The web service is secured using transport-level security (SSL over HTTP) to ensure encrypted communication between the agent system and SHIFT.

  • Agent IP Authentication:
    The agent must provide the public IP addresses of their client-service systems. The SHIFT security team will configure these IP addresses within the trusted zone to authenticate all incoming SOAP requests from the agent side.

  • Agent Credentials Authentication:
    Each API call (SOAP request) must include valid agent credentials. Every method within the SHIFT API requires the agent credentials as part of the input fields to verify and authenticate the request.

Agent Credentials fields#

Credentials will be assigned and provided by SHIFT

Field Type Size Mandatory
agentCode String 5 Yes
userId String 20 Yes
userPassword String 30 Yes

Security Recommendation

It is recommended to change the provided password upon first login. See Change User Password

SHIFT Web Services URL#

  • Demo & Testing Environment:

https://apidemo.shifttransfer.com:1663/SHIFTApiV3/SHIFTApiV3Service?wsdl

  • Production Environment:

The production endpoint will be provided by the SHIFT Support Team.

Deliverables and Integration Plan#

SHIFT API implementation project details, stakeholders and deadlines will be shared and agreed upon by the API Support team and the agent via a document called the Project Charter.