Operations

getCustomerInfo

getCustomerInfo

GET /admin/customers

Returns information of the customer's profile as registered on the service provider's system.

Security

  • httpBasic

Request

Parameters

Name Located in Required Description Default Schema
idNumber query yes Customer's identification number as per presented identification document. string
idType query no Type of presented identification document. string
idCountryCode query no Country of issue of presented identification document, expressed as an ISO 3166-1 Alpha-2 country code. string
merchantId query no The assigned merchant identifier. Also known as card acceptor id. string
originatorInstId query no Identifies the institution from which the transaction originates. Value to be assigned by Electrum. string
receiverId query yes Identifies the service provider to whom this request must be directed. string

Response

Content-Type: application/json

Status Code Reason Response Model
200 OK MoneyTransferAdminMessage
400 Bad request ErrorDetail
500 Internal Server Error ErrorDetail
501 Not implemented ErrorDetail
503 Service Unavailable ErrorDetail
504 Gateway Timeout ErrorDetail

createOrUpdateCustomer

createOrUpdateCustomer

POST 504

Request to create a new or update an existing customer profile on the service provider's system.

Security

  • httpBasic

Request

Content-Type: application/json

Parameters

Name Located in Required Description Default Schema
body body yes A message containing the data required to carry out the admin request, as well as information about the point-of-sale from which the transaction originates. MoneyTransferAdminMessage

Response

Content-Type: application/json

Status Code Reason Response Model
200 successful operation MoneyTransferAdminMessage
201 Created MoneyTransferAdminMessage
400 Bad request ErrorDetail
500 Internal Server Error ErrorDetail
501 Not implemented ErrorDetail
503 Service Unavailable ErrorDetail
504 Gateway Timeout ErrorDetail

getExchangeRate

getExchangeRate

GET /admin/exchangerate

Returns an exchange rate between two currencies.

Security

  • httpBasic

Request

Parameters

Name Located in Required Description Default Schema
fromCurrency query yes The currency which amounts are converted from. One unit of this currency multiplied by the rate returned by this operation is equal to one unit of the toCurrency. This currency is expressed as a three digit number as specified in ISO 4217, e.g. South African Rand is encoded as 710. string
toCurrency query yes The currency which amounts are converted to. One unit of this currency multiplied by the rate returned by this operation is equal to one unit of the fromCurrency. This currency is expressed as a three digit number as specified in ISO 4217, e.g. South African Rand is encoded as 710. string
receiverId query no The ID of the receiver who would process such a currency exchange. If this is supplied then a specific institution's exchange rate may be returned. If this parameter is not supplied then the exchange rate may simply be the market exchange rate. string

Response

Content-Type: application/json

Status Code Reason Response Model
200 OK ExchangeRate
400 Bad request ErrorDetail
500 Internal Server Error ErrorDetail
501 Not implemented ErrorDetail
503 Service Unavailable ErrorDetail
504 Gateway Timeout ErrorDetail

getFeeQuote

getFeeQuote

GET /admin/fees

Returns the fee that will be charged to the customer for the transfer.

Security

  • httpBasic

Request

Parameters

Name Located in Required Description Default Schema
amount query yes The amount the customer wishes to transfer. integer (int64)
amountIncludesFee query yes Whether or not the amount is inclusive of the fee. boolean
idNumber query no National identity number of the customer. string
merchantId query no The assigned merchant identifier. Also known as card acceptor ID. string
originatorInstId query yes Identifies the institution from which the transaction originates. Value to be assigned by Electrum. string
receiverId query yes Identifies the service provider to whom this request must be directed. string
senderCell query no The cellphone number of the sender of the funds. This field is required by some providers. This must conform to the ITU E.164 numbering plan (https://www.itu.int/rec/T-REC-E.164/en) e.g. 27821234567 for a South Africa number. string
recipientCell query no The cellphone number of the recipient of the funds. This field is required by some providers. This must conform to the ITU E.164 numbering plan (https://www.itu.int/rec/T-REC-E.164/en) e.g. 27821234567 for a South Africa number. string

Response

Content-Type: application/json

Status Code Reason Response Model
200 OK MoneyTransferFeeQuote
400 Bad request ErrorDetail
500 Internal Server Error ErrorDetail
501 Not implemented ErrorDetail
503 Service Unavailable ErrorDetail
504 Gateway Timeout ErrorDetail

getFeeQuote

getFeeQuote

POST 504

Returns the fee that will be charged to the customer for the transfer.

Security

  • httpBasic

Request

Content-Type: application/json

Parameters

Name Located in Required Description Default Schema
body body no Details necessary to provide a quote. MoneyTransferQuoteRequest

Response

Content-Type: application/json

Status Code Reason Response Model
200 OK MoneyTransferFeeQuote
400 Bad request ErrorDetail
500 Internal Server Error ErrorDetail
501 Not implemented ErrorDetail
503 Service Unavailable ErrorDetail
504 Gateway Timeout ErrorDetail

lookupOrder

lookupOrder

GET /orders

Queries the details of an existing money transfer order.

Security

  • httpBasic

Request

Parameters

Name Located in Required Description Default Schema
orderRedeemRef query no Reference used by the recipient to redeem the order. If both this value and remittanceRef are supplied then this takes precedence. string
merchantId query no The assigned merchant identifier. Also known as card acceptor id. string
originatorInstId query no Identifies the institution from which the transaction originates. Value to be assigned by Electrum. string
receiverId query yes Identifies the service provider to whom this request must be directed. string
remittanceRef query no 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. string

Response

Content-Type: application/json

Status Code Reason Response Model
200 OK MoneyTransferLookupResponse
400 Bad request ErrorDetail
500 Internal Server Error ErrorDetail
501 Not implemented ErrorDetail
503 Service Unavailable ErrorDetail
504 Gateway Timeout ErrorDetail

createOrder

createOrder

POST 504

Requests that an order be created for the specified payment amount. The request is treated as an online financial authorization message. If the client calling this resource does not receive a response, then a `reversePayment` call must be made to the `/orders/reversals` resource to ensure the transaction is cancelled with no financial impact.

Security

  • httpBasic

Request

Content-Type: application/json

Parameters

Name Located in Required Description Default Schema
body body yes A message containing the data required to carry out the payment order, as well as information about the point-of-sale from which the transaction originates. MoneyTransferAuthRequest

Response

Content-Type: application/json

Status Code Reason Response Model
200 successful operation MoneyTransferAuthResponse
201 Created MoneyTransferAuthResponse
400 Bad request ErrorDetail
500 Internal Server Error ErrorDetail
501 Not implemented ErrorDetail
503 Service Unavailable ErrorDetail
504 Gateway Timeout ErrorDetail

cancelOrder

cancelOrder

POST /orders/cancel

Requests that an order be cancelled and that a sender be refunded. This requested is treated as an online message. If no response is received, the cancellation will be reversed.

Security

  • httpBasic

Request

Content-Type: application/json

Parameters

Name Located in Required Description Default Schema
body body yes A message containing the data required to cancel a payment order, as well as information about the point-of-sale from which the transaction originates. MoneyTransferOrderCancelRequest

Response

Content-Type: application/json

Status Code Reason Response Model
200 Ok MoneyTransferOrderCancelResponse
400 Bad request ErrorDetail
404 Not Found ErrorDetail
500 Internal Server Error ErrorDetail
501 Not implemented ErrorDetail
503 Service Unavailable ErrorDetail
504 Gateway Timeout ErrorDetail

cancelOrderReversal

cancelOrderReversal

POST /orders/cancel/reversals

Requests that a cancellation be reversed. This is treated as a store-and-forward transaction. Upon receipt, it's recommended that implementors respond immediately to acknowledge receipt and place the message on a queue for guaranteed delivery to the service provider.

Security

  • httpBasic

Request

Content-Type: application/json

Parameters

Name Located in Required Description Default Schema
body body yes A message containing the data required to reverse an order cancellation. MoneyTransferCancelOrderReversal

Response

Content-Type: application/json

Status Code Reason Response Model
200 OK MoneyTransferCancelOrderReversal
202 Accepted MoneyTransferCancelOrderReversal
400 Bad request ErrorDetail
404 Not Found ErrorDetail
500 Internal Server Error ErrorDetail
501 Not implemented ErrorDetail
503 Service Unavailable ErrorDetail
504 Gateway Timeout ErrorDetail

confirmPayment

confirmPayment

POST /orders/confirmations

Advises that a money transfer payment has been made successfully. This is treated as a store-and-forward transaction. Upon receipt, the Electrum service will respond immediately to acknowledge receipt and place the message on a queue for guaranteed delivery to the service provider. If the service provider does not support positive advice messages, then this is simply stored for reporting purposes.

Security

  • httpBasic

Request

Content-Type: application/json

Parameters

Name Located in Required Description Default Schema
body body yes A payment confirmation. MoneyTransferConfirmation

Response

Content-Type: application/json

Status Code Reason Response Model
200 successful operation MoneyTransferConfirmation
202 Accepted MoneyTransferConfirmation
400 Bad request ErrorDetail
500 Internal Server Error ErrorDetail
501 Not implemented ErrorDetail
503 Service Unavailable ErrorDetail
504 Gateway Timeout ErrorDetail

redeemOrder

redeemOrder

POST /orders/redemptions

Requests that an existing order be paid out to the recipient. The request is treated as an online financial authorization message. If the client calling this resource does not receive a response, then a `reverseRedeem` call must be made to the `/orders/redemptions/reversals` resource to ensure the transaction is cancelled with no financial impact.

Security

  • httpBasic

Request

Content-Type: application/json

Parameters

Name Located in Required Description Default Schema
body body yes A message containing the data required to redeem the order, as well as information about the point-of-sale from which the transaction originates. MoneyTransferRedeemRequest

Response

Content-Type: application/json

Status Code Reason Response Model
200 successful operation MoneyTransferRedeemResponse
201 OK MoneyTransferRedeemResponse
400 Bad request ErrorDetail
500 Internal Server Error ErrorDetail
501 Not implemented ErrorDetail
503 Service Unavailable ErrorDetail
504 Gateway Timeout ErrorDetail

confirmRedeem

confirmRedeem

POST /orders/redemptions/confirmations

Advises that a money transfer order has been successfully redeemed. This is treated as a store-and-forward transaction. Upon receipt, the Electrum service will respond immediately to acknowledge receipt and place the message on a queue for guaranteed delivery to the service provider. If the service provider does not support positive advice messages, then this is simply stored for reporting purposes.

Security

  • httpBasic

Request

Content-Type: application/json

Parameters

Name Located in Required Description Default Schema
body body yes A redemption confirmation. MoneyTransferConfirmation

Response

Content-Type: application/json

Status Code Reason Response Model
200 successful operation MoneyTransferConfirmation
202 Accepted MoneyTransferConfirmation
400 Bad request ErrorDetail
500 Internal Server Error ErrorDetail
501 Not implemented ErrorDetail
503 Service Unavailable ErrorDetail
504 Gateway Timeout ErrorDetail

reverseRedeem

reverseRedeem

POST /orders/redemptions/reversals

Requests that a money transfer redemption be reversed. This is treated as a store-and-forward transaction. Upon receipt, the Electrum service will respond immediately to acknowledge receipt and place the message on a queue for guaranteed delivery to the service provider.

Security

  • httpBasic

Request

Content-Type: application/json

Parameters

Name Located in Required Description Default Schema
body body yes A redemption reversal. MoneyTransferReversal

Response

Content-Type: application/json

Status Code Reason Response Model
200 successful operation MoneyTransferReversal
202 Accepted MoneyTransferReversal
400 Bad request ErrorDetail
500 Internal Server Error ErrorDetail
501 Not implemented ErrorDetail
503 Service Unavailable ErrorDetail
504 Gateway Timeout ErrorDetail

reversePayment

reversePayment

POST /orders/reversals

Requests that a money transfer payment be reversed. This is treated as a store-and-forward transaction. Upon receipt, the Electrum service will respond immediately to acknowledge receipt and place the message on a queue for guaranteed delivery to the service provider.

Security

  • httpBasic

Request

Content-Type: application/json

Parameters

Name Located in Required Description Default Schema
body body yes A payment reversal. MoneyTransferReversal

Response

Content-Type: application/json

Status Code Reason Response Model
200 successful operation MoneyTransferReversal
202 Accepted MoneyTransferReversal
400 Bad request ErrorDetail
500 Internal Server Error ErrorDetail
501 Not implemented ErrorDetail
503 Service Unavailable ErrorDetail
504 Gateway Timeout ErrorDetail

updateOrderStatus

orderStatus

PUT /orders/status

Advises of a change in an order's status.

Security

  • httpBasic

Request

Content-Type: application/json

Parameters

Name Located in Required Description Default Schema
body body yes The new status of the order. MoneyTransferOrderStatusUpdateRequest

Response

Status Code Reason Response Model
204 No Content
400 Bad request ErrorDetail
500 Internal Server Error ErrorDetail
501 Not implemented ErrorDetail
503 Service Unavailable ErrorDetail
504 Gateway Timeout ErrorDetail