Payment Refund
A refund sent through a payment connector, with its state.
Area: Payments and payment methods · Why it is here: contract paygw · Fields: 23
Read and write it
Every call runs as your app's own user, with its key in one header, at the retailer's own address. The user reads and writes only what its role allows: your app's user, and the rights the retailer gives it.
Read a list (only name unless you ask for fields):
curl -s "https://⟨site⟩/api/resource/Payment%20Refund?fields=%5B%22*%22%5D&limit_page_length=20" \
-H "Authorization: token ⟨api key⟩:⟨api secret⟩"
Read one:
curl -s "https://⟨site⟩/api/resource/Payment%20Refund/⟨name⟩" -H "Authorization: token ⟨api key⟩:⟨api secret⟩"
Create one, if your app's role may:
curl -s -X POST "https://⟨site⟩/api/resource/Payment%20Refund" -H "Authorization: token ⟨api key⟩:⟨api secret⟩" \
-H "Content-Type: application/json" -d '{"⟨field⟩": …}'
Change one with PUT /api/resource/Payment%20Refund/⟨name⟩ and the fields you change; a table sent there replaces its rows, so send its existing rows too. All the record calls and their answers: the API reference.
Fields
Read from the product at POS 2.1.0.667 (till app 60147699c): its own fields, the fields iVendNext adds to it, and iVendNext's changes to any of them. Read-only fields are set by iVendNext; a hidden one is not on the form but can be read. Every record also has name (its id, in the address), owner, creation, modified, modified_by and docstatus (0 a draft, 1 submitted, 2 cancelled), all read-only.
| Field | Field name | Type | Required | Read-only | Hidden | Links to |
|---|---|---|---|---|---|---|
| Refund Reference | reference |
Data | yes | yes | ||
| Original Payment | original_reference |
Link | yes | Retail Card Terminal Txn | ||
| Return's Key | return_key |
Data | yes | |||
| POS Profile | pos_profile |
Link | yes | POS Profile | ||
| Company | company |
Link | yes | Company | ||
| Status | status |
Select | yes | one of: Pending, Refunded, Declined, Timeout | ||
| Amount | amount |
Currency | yes | |||
| Currency | currency |
Link | yes | Currency | ||
| Customer | customer |
Link | yes | Customer | ||
| Wallet | mode_of_payment |
Data | yes | |||
| Provider | adapter |
Data | yes | |||
| Payment Account | payment_account |
Data | yes | |||
| Provider's Refund ID | correlation_id |
Data | yes | |||
| Requested By | requested_by |
Link | yes | User | ||
| Refunded At | refunded_at |
Datetime | yes | |||
| Checks | attempts |
Int | yes | |||
| Needs a Person | reconcile_alert |
Check | yes | |||
| Booked | booked |
Check | yes | |||
| No Return Names It | unbooked_alert |
Check | yes | |||
| Amount the Wallet Gave Back | answered_amount |
Currency | yes | |||
| Wallet Answered Another Amount | answered_other_amount |
Check | yes | |||
| Settled by Hand | hand_note |
Small Text | yes | |||
| Last Answer | response_json |
Long Text | yes |