MOmoneyhash
v1.1

Reverse loyalty earn

Changed on

Queues a reversal of an EARNED loyalty transaction. The amount in the body must match the original earn amount. Status moves to PENDING_REVERSE status. while the provider is called. When the reversal is successful, the status moves to REVERSED status.

post/api/v1.4/loyalty/earn/{id}/reverse/

Request

  • Base URL
    https://web.moneyhash.io
  • URL
    https://web.moneyhash.io/api/v1.4/loyalty/earn/{id}/reverse/
  • 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.

Request body

amountstring decimal required

Amount to be reversed

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
reversed_atstring date-time nullable

Changes