orderStatus

Advises of a change in an order's status.

Request
Security:
Request Body schema: application/json

The new status of the order.

updateTime
required
string <date-time>

The date and time at which the order was updated on the money transfer service provider's system. This is relevant so that if multiple status updates were sent, but delivered out of order, the receiving system can ignore any older status updates. The format shall be as defined for date-time in RFC 3339 section 5.6. It is recommended that the optional time-secfrac be included up to millisecond precision.

orderRedeemRef
string

Reference used by the recipient to redeem the order. (this is the same as the query param in the lookupOrder operation). Should be supplied if remittanceRef is not supplied.

remittanceRef
string

Reference for a remittance transaction. Should be supplied if orderRedeemRef is not supplied.

status
required
string

The new status of the order.

Enum: "UNREDEEMED" "REDEEMED" "CANCELLED" "EXPIRED" "ON_HOLD" "UNCONFIRMED"
statusDescription
string

The new detailed description of the status of an order.

object (Originator)

The Originator object encapsulates data relating to the originator of the transaction

object (Institution)

Originating, acquiring, processing, or receiving institution details

object (Institution)

Originating, acquiring, processing, or receiving institution details

object (Institution)

Originating, acquiring, processing, or receiving institution details

Array of objects (ThirdPartyIdentifier)

An array of identifiers which each identify the transaction within each entity's system.

object (LedgerAmount)

An amount object only containing value and currency, and optionally an indicator of DEBIT/CREDIT

object (PersonalDetails)

Personal details of a customer.

orderRedeemRefAlt
string

An alternate reference used by the recipient to redeem the order. This must be printed on the receipt.

orderId
string

Reference used by the service provider to uniquely identify the money transfer order on their system. This field can be used if the provider supplies a supplementary reference for the order in addition to the orderRedeemRef. Note that any reference issued by the provider that is specific to a particular leg of the order process should be set as a ThirdPartyIdentifier (i.e. the authorization and redeem legs of the order should each have its own reference).

customerProfileId
string

Uniquely identifies customer's profile on the upstream entity's system.

Responses
204

No Content

400

Bad request

500

Internal Server Error

501

Not implemented

503

Service Unavailable

504

Gateway Timeout

put/orders/status
Request samples
application/json
{
  • "updateTime": "2019-08-24T14:15:22Z",
  • "orderRedeemRef": "string",
  • "remittanceRef": "string",
  • "status": "UNREDEEMED",
  • "statusDescription": "string",
  • "originator": {
    },
  • "client": {
    },
  • "settlementEntity": {
    },
  • "receiver": {
    },
  • "thirdPartyIdentifiers": [
    ],
  • "amount": {
    },
  • "senderDetails": {
    },
  • "orderRedeemRefAlt": "string",
  • "orderId": "string",
  • "customerProfileId": "string"
}
Copyright © Electrum Payments (Pty) Ltd. 2019-2022. All right reserved.