Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.


Expand
titlepayment cancellation object response data


Available from CRM.COM R5.0.0

Available from CRM.COM R5.0.0

Name

Type

Description

id

String

The ID of the retrieved payment cancellation

number

String

The number of the retrieved payment cancellation

reference_number

String

The reference number of the retrieved payment cancellation

life_cycle_state

String

The life cycle state of the payment cancellation. One of the following values is returned:

DRAFT, REJECTED, POSTED, CANCELLED

the only available value is POSTED.

issued_onDateThe date that the payment cancellation was issued
posted_onDateThe date that the payment cancellation was posted
payment_amountNumberThe total amount of the payment cancellation
processed_by_payment_gatewayString

The payment gateway that processed the payment cancellation.

Tip
payment_gateway_reference_numberString

A reference to the number of the payment cancellation that was created on the payment gateway

Tip