MOmoneyhash
v1.1

Retrieve loyalty earn

Changed on

Returns the current state of a loyalty earn transaction belonging to the authenticated account.

get/api/v1.4/loyalty/earn/{id}/

Request

  • Base URL
    https://web.moneyhash.io
  • URL
    https://web.moneyhash.io/api/v1.4/loyalty/earn/{id}/
  • Auth
    • API key in header X-Api-Key
    • or API key in query parameter access_token

Path parameters

idstring required

Loyalty earn transaction UUID is a unique identifier for the loyalty earn transaction.

Response

idstring required

UUID is a unique identifier for the loyalty earn transaction.

status'PENDING' | 'EARNED' | 'PENDING_REVERSE' | 'REVERSE_FAILED' | 'REVERSED' | 'FAILED'

Lifecycle state: pending earn, earned, reversal, terminal failure, etc.

  • PENDING - PENDING
  • EARNED - EARNED
  • PENDING_REVERSE - PENDING_REVERSE
  • REVERSE_FAILED - REVERSE_FAILED
  • REVERSED - REVERSED
  • FAILED - FAILED
providerstring required

Display name of the loyalty provider.

provider_idstring required

MoneyHash loyalty service id (hashid)

identifierstring required

Customer identifier

identifier_type'PHONE_NUMBER' | 'NATIONAL_ID' | 'EMAIL' required

How the identifier value should be interpreted (e.g. phone number).

  • PHONE_NUMBER - PHONE_NUMBER
  • NATIONAL_ID - NATIONAL_ID
  • EMAIL - EMAIL
amountstring decimal required

Earn amount.

currencystring required

ISO currency code of the earn amount.

merchant_referencestring required

Merchant-supplied reference.

provider_reference_idstring nullable

Provider-side id returned by the earn call.

reverse_provider_reference_idstring nullable

Provider-side id returned by the reverse call.

failure_reasonstring nullable required
reversed_atstring date-time nullable
createdstring date-time required
modifiedstring date-time required

Changes