NEnewline53
Returns

List Returns

Retrieves a list of return transactions. You can filter the results based on parameters such as status, date, and transaction type. This endpoint is available in Sandbox and Production environments.

get/returns

Request

Query parameters

customer_uidstring

The UID of the customer requesting a return.

Example:Trzqy9t6j6tFGoG3
requestor_type'customer' | 'subclient'

Type of the customer requesting a return.

Example:customer

Response

A list of Returns is returned

created_atstring

The DateTime at which this Return was created.

external_uidExternalUid (unresolved $ref)
original_transaction_uidOriginalTransactionUid (unresolved $ref)
customer_uidSchema (unresolved $ref)
requestor_typeSchema (unresolved $ref)
return_reasonReturnReason (unresolved $ref)
return_transaction_uidstring

The transaction returning the funds.

status'canceled' | 'queued' | 'pending' | 'settled' | 'failed'

A value indicating the overall status of the Return.

uidstring

Unique identifier for the Return

Changes

No recorded changes to this operation across all 4 revisions of this API.