lookupOrder

Queries the details of an existing money transfer order.

SecurityhttpBasic or oauth2

Request

query Parameters

orderRedeemRef	string Reference used by the recipient to redeem the order. If both this value and remittanceRef are supplied then this takes precedence.
merchantId	string The assigned merchant identifier. Also known as card acceptor ID.
originatorInstId	string Identifies the institution from which the transaction originates. Value to be assigned by Electrum.
receiverId required	string Identifies the service provider to whom this request must be directed.
settlementEntityId	string Identifies the entity with whom the Merchant will settle the transaction.
remittanceRef	string Reference used by the recipient to refer to the order when no redemption is to occur (e.g. direct account deposits). If both this value and orderRedeemRef are supplied then orderRedeemRef takes precedence.
idNumber	string Customer's identification number as per presented identification document.
idType	string Type of presented identification document. This must be supplied if idNumber is supplied. Enum: "NATIONAL_ID" "PASSPORT" "DRIVERS_LICENCE" "ASYLUM_DOCUMENT" "UNKNOWN" "CUSTOMER_PROFILE_ID"

Responses

200

400

Bad request

500

Internal Server Error

501

Not implemented

503

Service Unavailable

504

Gateway Timeout

get/orders

Request samples

curl
Java
Node.js

Response samples

application/json

{"amount": {"amount": 0,
"currency": "string",
"ledgerIndicator": "DEBIT"
},
"status": "UNREDEEMED",
"statusDescription": "string",
"originator": {"institution": {"id": "string",
"name": "string"
},
"terminalId": "stringst",
"merchant": {"merchantType": "string",
"merchantId": "stringstringstr",
"merchantName": {"name": "string",
"city": "string",
"region": "st",
"country": "st"
}
},
"operatorId": "string",
"channelId": "string"
},
"receiver": {"id": "string",
"name": "string"
},
"settlementEntity": {"id": "string",
"name": "string"
},
"orderRedeemRef": "string",
"orderRedeemRefAlt": "string",
"orderId": "string"
}