getCustomerOrderHistory

Queries the details of a client's existing money transfer orders.

Request
Security:
query Parameters
customerProfileId
required
string

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

receiverId
required
string

Identifies the service provider to whom this request must be directed.

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.

fromDateTime
string

The date from which to start searching for orders (inclusive).

toDateTime
string

The date from which to end searching for orders (exclusive).

status
string

Should be among the options of the MoneyTransferLookupResponse Statuses.

paymentType
string

Payment type to filter orders by.

paymentIdentifierName
string

Payment identifier for the payment type indicated. Required if 'paymentType' is defined.

paymentIdentifierValue
string

Payment identifier value for the payment type indicated. Required if 'paymentType' is defined.

limit
integer <int64>
Default: 20

Maximum number of orders to return. Use in conjunction with the "offset" parameter to tune which subset of the entire result set (as constrained by fromDate and toDate) is returned.

offset
integer <int64>
Default: 0

Offset the entire result set by this amount of top-ordered results. Use in conjunction with the "limit" parameter to tune which subset of the entire result set (as constrained by fromDate and toDate) is returned.

Responses
200

OK

400

Bad request

500

Internal Server Error

501

Not implemented

503

Service Unavailable

504

Gateway Timeout

get/admin/customers/orders
Request samples
curl -i -X GET \
  -u <username>:<password> \
  'https://sandbox.electrum.io/moneytransfer/v2/admin/customers/orders?customerProfileId=string&receiverId=string&merchantId=string&originatorInstId=string&fromDateTime=string&toDateTime=string&status=string&paymentType=string&paymentIdentifierName=string&paymentIdentifierValue=string&limit=20&offset=0'
Response samples
application/json
{
  • "receiver": {
    },
  • "orders": [
    ],
  • "originator": {
    },
  • "paging": {
    }
}
Copyright © Electrum Payments (Pty) Ltd. 2019-2022. All right reserved.