Refunds

Retrieve a refund

Changed on

A refund is a request, not a guaranteed outcome. This read is how you find out whether it was honored.

get/v1/refunds/{actionId}

Request

  • Base URL
    https://api.sandbox.alfredpay.io
  • URL
    https://api.sandbox.alfredpay.io/v1/refunds/{actionId}
  • Auth
    • HTTP bearer
    • or API key in header api-key and API key in header api-secret

Response

OK

actionIdstring
actionType'REFUND'
parentTransactionIdstring
status'REQUESTED' | 'PROCESSING' | 'COMPLETED' | 'DECLINED'
parentOutcome'CANCELLED' | 'null' nullable

The parent lands CANCELLED whether unwound pre-execution or returned after a leg went out.

createdAtstring date-time
updatedAtstring date-time

Changes