Update credits by order ID
Use this endpoint to update the credit status, as well as to add any associated notes and additional attributes.
Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Headers
A header used by fabric to identify the tenant making the request. You must include tenant id in the authentication header for an API request to access any of fabric’s endpoints. You can retrieve the tenant id , which is also called account id, from Copilot. This header is required.
x-fabric-channel-id identifies the sales channel where the API request is being made; primarily for multichannel use cases. The channel ids are 12 corresponding to US and 13 corresponding to Canada. The default channel id is 12. This field is required.
Unique request ID
Path Parameters
24-character system-generated order ID returned in the response of Create Order - POST /orders endpoint.
Body
Request to update credits details
Merchant-defined custom attributes. This is a placeholder for additional info (in key: value pairs).
Unique UUID of credit
Placeholder for additional information, if any.
Credit status
PENDING, CONFIRMED, FAILED, CANCELED Response
Credit response
Credits amount
Merchant-defined custom attributes. This is a placeholder for additional info in key: value pairs
Credits creation time, in UTC format
Unique UUID of credit
Three-letter currency code as defined by ISO-4217
Employee (ID or name) who initiated a the credits request
Note
A sequential or incremental counter associated with a payment for an order. Applicable in refund scenarios to identify the specific payment for refund.
Merchant-defined policy code, varies from merchant to merchant. If omitted, the default policy is used.
Reason code
Source of credits request
Credit status
PENDING, CONFIRMED, FAILED, CANCELED Subreason code
Credit type. Currently, supports only Gift Card
GIFT_CARD Time of last update to credits, in UTC format.
Was this page helpful?