--- title: Post Transaction for Earnings Processing slug: post-transaction-for-earnings-processing docTags: createdAt: 2025-09-12T20:51:26.464Z --- { "id": "0ufm-QZgy1PkjoAhRSOTd", "type": "api-oas-v2", "data": { "method": "POST", "url": "https://api.b.preview.loyaltyservices.io/api/v3/transactions", "servers": [ { "url": "https://api.b.preview.loyaltyservices.io/api/v3/transactions" } ], "name": "Post Transaction for Earnings Processing", "description": "

This will submit a transaction through the earnings process. If a member identifier is associated to the transaction, it will go through the entire process. If not, it will be staged for future processing.

", "contentType": "application/json", "request": { "pathParameters": [], "headerParameters": [ { "name": "accept", "type": "string", "kind": "optional", "description": "Generated from available response content types", "enum": [ "application/json" ], "default": "application/json" } ], "queryParameters": [], "bodyDataParameters": [ { "kind": "required", "name": "body", "type": "object", "description": "Transaction Request", "customType": "TransactionRequest", "schema": [ { "name": "referenceId", "kind": "optional", "type": "string", "description": "Client transaction identifier" }, { "name": "member", "kind": "optional", "type": "object", "description": "", "modelRef": "#/components/schemas/TransactionMember", "customType": "TransactionMember", "schema": [ { "name": "memberIdentifier", "kind": "optional", "type": "string", "description": "

Channel/Partner specific member identifier. For requests with memberIdentifier in the path, this field is optional - if not provided, the memberIdentifier from the path will be used. If provided, it must match the memberIdentifier in the URL path.

", "minLength": 1, "maxLength": 200 }, { "name": "firstName", "kind": "optional", "type": "string", "description": "Member's first name", "minLength": 1, "maxLength": 100 }, { "name": "lastName", "kind": "optional", "type": "string", "description": "Member's last name", "minLength": 1, "maxLength": 100 }, { "name": "alias", "kind": "optional", "type": "string", "description": "Member alias as defined by program configuration", "minLength": 1, "maxLength": 200 } ] }, { "name": "transactionDateTime", "kind": "optional", "type": "string", "description": "Business date time of the transaction", "format": "date-time" }, { "name": "description", "kind": "optional", "type": "string", "description": "Description of the transaction", "maxLength": 250 }, { "name": "originationDate", "kind": "optional", "type": "string", "description": "

Date transaction was originally placed/booked/reserved

", "format": "date" }, { "name": "awardNumber", "kind": "optional", "type": "string", "description": "Identifies the associated redemption for this transaction", "maxLength": 100 }, { "name": "providedAmount", "kind": "optional", "type": "number", "description": "

Value of earning in loyalty currency (Points, Miles). Set on migrated transactions.

", "example": 100 }, { "name": "sourceCode", "kind": "optional", "type": "string", "description": "SourceCode of transaction", "example": "RT" }, { "name": "migrateStatusCode", "kind": "optional", "type": "string", "description": "

Status of the migrated transaction (used if the migrate parameter is true): posted (default) or cancelled

" }, { "name": "customData", "kind": "optional", "type": "object", "description": "", "modelRef": "#/components/schemas/CustomData", "customType": "CustomData", "schema": [ { "name": "ace01", "kind": "optional", "type": "string", "description": "

Client-defined custom attribute. Value is program-specific; valid values are defined in the client program's custom data configuration. To get the human-readable label, refer to the paired ace01Description field.

" }, { "name": "ace01Description", "kind": "optional", "type": "string", "description": "

Human-readable label for the corresponding ace01 code value. Use this field to interpret the meaning of the paired ACE code within the context of the client program.

" }, { "name": "ace02", "kind": "optional", "type": "string", "description": "

Client-defined custom attribute. Value is program-specific; valid values are defined in the client program's custom data configuration. To get the human-readable label, refer to the paired ace02Description field.

" }, { "name": "ace02Description", "kind": "optional", "type": "string", "description": "

Human-readable label for the corresponding ace02 code value. Use this field to interpret the meaning of the paired ACE code within the context of the client program.

" }, { "name": "ace03", "kind": "optional", "type": "string", "description": "

Client-defined custom attribute. Value is program-specific; valid values are defined in the client program's custom data configuration. To get the human-readable label, refer to the paired ace03Description field.

" }, { "name": "ace03Description", "kind": "optional", "type": "string", "description": "

Human-readable label for the corresponding ace03 code value. Use this field to interpret the meaning of the paired ACE code within the context of the client program.

" }, { "name": "ace04", "kind": "optional", "type": "string", "description": "

Client-defined custom attribute. Value is program-specific; valid values are defined in the client program's custom data configuration. To get the human-readable label, refer to the paired ace04Description field.

" }, { "name": "ace04Description", "kind": "optional", "type": "string", "description": "

Human-readable label for the corresponding ace04 code value. Use this field to interpret the meaning of the paired ACE code within the context of the client program.

" }, { "name": "ace05", "kind": "optional", "type": "string", "description": "

Client-defined custom attribute. Value is program-specific; valid values are defined in the client program's custom data configuration. To get the human-readable label, refer to the paired ace05Description field.

" }, { "name": "ace05Description", "kind": "optional", "type": "string", "description": "

Human-readable label for the corresponding ace05 code value. Use this field to interpret the meaning of the paired ACE code within the context of the client program.

" }, { "name": "ace06", "kind": "optional", "type": "string", "description": "

Client-defined custom attribute. Value is program-specific; valid values are defined in the client program's custom data configuration. To get the human-readable label, refer to the paired ace06Description field.

" }, { "name": "ace06Description", "kind": "optional", "type": "string", "description": "

Human-readable label for the corresponding ace06 code value. Use this field to interpret the meaning of the paired ACE code within the context of the client program.

" }, { "name": "ace07", "kind": "optional", "type": "string", "description": "

Client-defined custom attribute. Value is program-specific; valid values are defined in the client program's custom data configuration. To get the human-readable label, refer to the paired ace07Description field.

" }, { "name": "ace07Description", "kind": "optional", "type": "string", "description": "

Human-readable label for the corresponding ace07 code value. Use this field to interpret the meaning of the paired ACE code within the context of the client program.

" }, { "name": "ace08", "kind": "optional", "type": "string", "description": "

Client-defined custom attribute. Value is program-specific; valid values are defined in the client program's custom data configuration. To get the human-readable label, refer to the paired ace08Description field.

" }, { "name": "ace08Description", "kind": "optional", "type": "string", "description": "

Human-readable label for the corresponding ace08 code value. Use this field to interpret the meaning of the paired ACE code within the context of the client program.

" }, { "name": "ace09", "kind": "optional", "type": "string", "description": "

Client-defined custom attribute. Value is program-specific; valid values are defined in the client program's custom data configuration. To get the human-readable label, refer to the paired ace09Description field.

" }, { "name": "ace09Description", "kind": "optional", "type": "string", "description": "

Human-readable label for the ace09 code value. Use this field to interpret the meaning of ace09 within the context of the client program.

" }, { "name": "ace10", "kind": "optional", "type": "string", "description": "

Client-defined custom attribute. Value is program-specific; valid values are defined in the client program's custom data configuration. To get the human-readable label, refer to the paired ace10Description field.

" }, { "name": "ace10Description", "kind": "optional", "type": "string", "description": "

Human-readable label for the ace10 code value. Use this field to interpret the meaning of ace10 within the context of the client program.

" }, { "name": "ace11", "kind": "optional", "type": "string", "description": "

Client-defined custom attribute. Value is program-specific; valid values are defined in the client program's custom data configuration. To get the human-readable label, refer to the paired ace11Description field.

" }, { "name": "ace11Description", "kind": "optional", "type": "string", "description": "

Human-readable label for the corresponding ace11 code value. Use this field to interpret the meaning of the paired ACE code within the context of the client program.

" }, { "name": "ace12", "kind": "optional", "type": "string", "description": "

Client-defined custom attribute. Value is program-specific; valid values are defined in the client program's custom data configuration. To get the human-readable label, refer to the paired ace12Description field.

" }, { "name": "ace12Description", "kind": "optional", "type": "string", "description": "

Human-readable label for the corresponding ace12 code value. Use this field to interpret the meaning of the paired ACE code within the context of the client program.

" }, { "name": "ace13", "kind": "optional", "type": "string", "description": "

Client-defined custom attribute. Value is program-specific; valid values are defined in the client program's custom data configuration. To get the human-readable label, refer to the paired ace13Description field.

" }, { "name": "ace13Description", "kind": "optional", "type": "string", "description": "

Human-readable label for the corresponding ace13 code value. Use this field to interpret the meaning of the paired ACE code within the context of the client program.

" }, { "name": "ace14", "kind": "optional", "type": "string", "description": "

Client-defined custom attribute. Value is program-specific; valid values are defined in the client program's custom data configuration. To get the human-readable label, refer to the paired ace14Description field.

" }, { "name": "ace14Description", "kind": "optional", "type": "string", "description": "

Human-readable label for the corresponding ace14 code value. Use this field to interpret the meaning of the paired ACE code within the context of the client program.

" }, { "name": "ace15", "kind": "optional", "type": "string", "description": "

Client-defined custom attribute. Value is program-specific; valid values are defined in the client program's custom data configuration. To get the human-readable label, refer to the paired ace15Description field.

" }, { "name": "ace15Description", "kind": "optional", "type": "string", "description": "

Human-readable label for the corresponding ace15 code value. Use this field to interpret the meaning of the paired ACE code within the context of the client program.

" } ] }, { "name": "spend", "kind": "optional", "type": "object", "description": "", "modelRef": "#/components/schemas/TransactionSpend", "customType": "TransactionSpend", "schema": [ { "name": "perItem", "kind": "optional", "type": "number", "description": "

Cost per item (defaults to spendAmount)

", "minimum": 0, "maximum": 9999999999.99 }, { "name": "spendAmount", "kind": "optional", "type": "number", "description": "The fiat or currency amount qualified for earning", "minimum": 0, "maximum": 9999999999.99 }, { "name": "currencyTypeCode", "kind": "optional", "type": "string", "description": "

Identifies the currency type (Points, Mile) code

", "minLength": 0, "maxLength": 50 }, { "name": "currencyCategoryCode", "kind": "optional", "type": "string", "description": "

Identifies the currency (Base, Tax, etc.) category code

", "minLength": 0, "maxLength": 50 }, { "name": "isoCurrencyCode", "kind": "optional", "type": "string", "description": "

ISO currency (default to USD if null)

", "minLength": 0, "maxLength": 3 }, { "name": "currencyConversionRatio", "kind": "optional", "type": "number", "description": "Identifies the currency conversion ratio that was used to convert the international currency to USD", "format": "double" }, { "name": "quantity", "kind": "optional", "type": "integer", "description": "Number of items purchased", "format": "int32", "minimum": 0, "maximum": 999999999 } ] }, { "name": "hotelTransaction", "kind": "optional", "type": "object", "description": "", "modelRef": "#/components/schemas/HotelTransaction", "customType": "HotelTransaction", "schema": [ { "name": "checkInDate", "kind": "optional", "type": "string", "description": "

Date of check-in

", "format": "date" }, { "name": "checkOutDate", "kind": "optional", "type": "string", "description": "

Date of check-out

", "format": "date" }, { "name": "eligibleStays", "kind": "optional", "type": "integer", "description": "Number of eligible stays associated with the transaction", "format": "int32" }, { "name": "eligibleCappedNights", "kind": "optional", "type": "integer", "description": "

Number of capped nights (as defined by program configuration) associated with the transaction

", "format": "int32" }, { "name": "eligibleNights", "kind": "optional", "type": "integer", "description": "

Number of eligible nights of the stay. Optional - if null, system calculates from stay duration. When provided, uses minimum of specified value and actual stay duration.

", "format": "int32" }, { "name": "roomNumber", "kind": "optional", "type": "string", "description": "The room number associated with the stay" }, { "name": "roomType", "kind": "optional", "type": "string", "description": "Type of room the member stayed in" }, { "name": "roomRate", "kind": "optional", "type": "number", "description": "

The room rate (in USD). If not present, the system will calculate from international amounts.

" }, { "name": "roomRateIntl", "kind": "optional", "type": "number", "description": "

The room rate (in local currency)

" }, { "name": "totalRevenueAmount", "kind": "optional", "type": "number", "description": "

The total revenue amount (in USD). If not present, the system will calculate from international amounts.

" }, { "name": "totalRevenueAmountIntl", "kind": "optional", "type": "number", "description": "

The total revenue amount (in local currency)

" }, { "name": "loyaltyEligibleAmount", "kind": "optional", "type": "number", "description": "

The loyalty eligible amount (in USD). If not present, the system will calculate from international amounts.

" }, { "name": "loyaltyEligibleAmountIntl", "kind": "optional", "type": "number", "description": "

The loyalty eligible amount (in local currency)

" }, { "name": "loyaltyIneligibleAmount", "kind": "optional", "type": "number", "description": "

The loyalty ineligible amount (in USD). If not present, the system will calculate from international amounts.

" }, { "name": "loyaltyIneligibleAmountIntl", "kind": "optional", "type": "number", "description": "

The loyalty ineligible amount (in local currency)

" }, { "name": "isoCurrencyCode", "kind": "optional", "type": "string", "description": "The currency code utilized to convert from international to USD. Defaults to currency of location." }, { "name": "bookingSource", "kind": "optional", "type": "string", "description": "Source of the booking" }, { "name": "paymentCode", "kind": "optional", "type": "string", "description": "Indicator of the member's payment type" }, { "name": "purposeOfVisit", "kind": "optional", "type": "string", "description": "Purpose of the member's visit" }, { "name": "travelAgentName", "kind": "optional", "type": "string", "description": "Name of the member's travel agent" }, { "name": "groupName", "kind": "optional", "type": "string", "description": "Group the member was a part of" }, { "name": "companyName", "kind": "optional", "type": "string", "description": "Name of the company the member was a part of" }, { "name": "reservationConfirmationNumber", "kind": "optional", "type": "string", "description": "Confirmation from the reservation management system" }, { "name": "noShow", "kind": "optional", "type": "boolean", "description": "Indicator that the member did not show up for their stay" }, { "name": "pmsConfirmationNumber", "kind": "optional", "type": "string", "description": "Confirmation number from the property management system" }, { "name": "overlappingStayPoolId", "kind": "optional", "type": "string", "description": "Overlapping Stay Pool Id" }, { "name": "nonStayIndicator", "kind": "optional", "type": "boolean", "description": "Indicator that the transaction represents something other than a stay" }, { "name": "nonStayLocationId", "kind": "optional", "type": "string", "description": "Non stay location identifier" }, { "name": "nonStayEligibleRevenue", "kind": "optional", "type": "number", "description": "

The non stay (F&B, spa, etc.) eligible revenue (in USD). If not present, the system will calculate from international amounts.

" }, { "name": "nonStayEligibleRevenueIntl", "kind": "optional", "type": "number", "description": "

The non stay (F&B, spa, etc.) eligible revenue (in local currency)

" }, { "name": "nonStayIneligibleRevenue", "kind": "optional", "type": "number", "description": "

The non stay (F&B, spa, etc.) eligible revenue (in USD). If not present, the system will calculate from international amounts.

" }, { "name": "nonStayIneligibleRevenueIntl", "kind": "optional", "type": "number", "description": "

The non stay (F&B, spa, etc.) eligible revenue (in local currency)

" }, { "name": "checkNumber", "kind": "optional", "type": "string", "description": "

Check number associated with the non-stay data

" } ] }, { "name": "retailTransaction", "kind": "optional", "type": "object", "description": "", "modelRef": "#/components/schemas/RetailTransaction", "customType": "RetailTransaction", "schema": [ { "name": "transactionNbr", "kind": "optional", "type": "string", "description": "Online order transaction number" }, { "name": "pointOfSaleTransNbr", "kind": "optional", "type": "string", "description": "

In-store point-of-sale transaction number

" }, { "name": "transactionSequenceNbr", "kind": "optional", "type": "string", "description": "Transaction line item sequence number" }, { "name": "store", "kind": "optional", "type": "string", "description": "Store identifier" }, { "name": "register", "kind": "optional", "type": "string", "description": "Register number" } ] }, { "name": "travelTransaction", "kind": "optional", "type": "object", "description": "", "modelRef": "#/components/schemas/TravelTransaction", "customType": "TravelTransaction", "schema": [ { "name": "activityStartDateTime", "kind": "optional", "type": "string", "description": "Transaction activity start date time", "format": "date-time" }, { "name": "activityEndDateTime", "kind": "optional", "type": "string", "description": "Transaction activity end date time", "format": "date-time" }, { "name": "totalSpendAmount", "kind": "optional", "type": "number", "description": "The fiat or currency amount spent in total", "minimum": 0, "maximum": 9999999999.99 } ] }, { "name": "transactionPartner", "kind": "optional", "type": "object", "description": "", "modelRef": "#/components/schemas/TransactionPartnerEarn", "customType": "TransactionPartnerEarn", "schema": [ { "name": "partnerProgramCode", "kind": "optional", "type": "string", "description": "The partner program's code" }, { "name": "amount", "kind": "optional", "type": "number", "description": "The partner earning point amount", "maximum": 9999999999 } ] }, { "name": "transactionMemberPaymentCardAccount", "kind": "optional", "type": "object", "description": "", "modelRef": "#/components/schemas/TransactionMemberPaymentCardAccount", "customType": "TransactionMemberPaymentCardAccount", "schema": [ { "name": "memberPaymentCardAccountId", "kind": "optional", "type": "integer", "description": "Member Payment Card Account Id", "format": "int64" }, { "name": "typeCode", "kind": "optional", "type": "string", "description": "

Card Type - As defined by program configuration

", "maxLength": 50 }, { "name": "paymentCardAccountNumber", "kind": "optional", "type": "string", "description": "

Account number associated to the payment card account, typically Acquirer Reference Number

", "maxLength": 50 } ] }, { "name": "transactionReference", "kind": "optional", "type": "map", "description": "Client custom data defined by the program configuration", "example": "", "customType": "map", "schema": [] }, { "name": "useCouponCodes", "kind": "optional", "type": "array", "description": "List of unique couponCodes associated with the accrual for which a coupon use will be posted upon processing. Only Held coupons are accepted in this array.", "example": "", "itemType": "string", "customType": "string[]", "itemExample": "", "itemDefault": "" } ], "modelRef": "#/components/schemas/TransactionRequest", "isExpanded": true } ], "formDataParameters": [], "oAuthParameters": [ { "id": "OAuth2", "name": "OAuth2", "kind": "optional", "type": "oauth2", "description": "

See https://docs.wearephaedon.com/docs/platform-api-authentication

", "oauth2Flows": { "clientCredentials": { "tokenUrl": "https://phaedon.oktapreview.com/oauth2/auscfbbmieFBGGOzR1d7/v1/token", "scopes": { "api:custom-data:read": "Grants read access to custom data information", "api:custom-data:modify": "Grants modify access to custom data information", "api:data-codes:read": "Grants read access to data codes", "api:data-codes:modify": "Grants modify access to data codes", "api:coupon-compensation:read": "Grants read access to compensations for coupon code", "api:coupon-compensation:create": "Grants access to create compensations for coupon code", "api:coupon-compensation:modify": "Grants access to edit compensation nights for coupon code", "api:coupon-request:modify": "Grants modify access to create coupons", "api:member:search": "Grants search access to member information", "api:member:verify": "Grants verify access to member information", "api:member:merge": "Grants access to merge members", "api:member:enroll": "Grants access to enroll members", "api:member:modify": "Grants modify access to member information", "api:member:read": "Grants read access to member information", "api:member:close": "Grants access to close member account", "api:member:migrate": "Grants access to migrate member accounts", "api:member-address:read": "Grants read access to member address information", "api:member-address:modify": "Grants modify access to member address information", "api:member-alias:read": "Grants read access to member alias information", "api:member-alias:modify": "Grants modify access to member alias information", "api:member-badge:read": "Grants read access to member badge information", "api:member-badge:modify": "Grants modify access to member badge information", "api:member-bonus:add": "Grants access to add a bonus to a member", "api:member-bonus:read": "Grants read access to member bonus information", "api:member-comments:read": "Grants read access to member comments information", "api:member-comments:modify": "Grants modify access to member comments information", "api:member-communication:read": "Grants read access to member communication information", "api:member-communication:modify": "Grants modify access to member communication information", "api:member-coupon:read": "Grants read access to member coupon information", "api:member-coupon-use:cancel": "Grants access to cancel member coupon uses", "api:member-coupon:transfer": "Grants access to transfer a member coupon", "api:member-coupon-use:update": "Grants access to update member coupon uses", "api:member-currency:read": "Grants read access to member currency information", "api:member-currency:adjust": "Grants access to adjust member currency", "api:member-currency:migrate": "Grants access to migrate member currency", "api:member-currency-conversion:convert": "Grants access to convert member currency", "api:member-email:read": "Grants read access to member email information", "api:member-email:modify": "Grants modify access to member email information", "api:member-event:read": "Grants read access to member events", "api:member-event:modify": "Grants modify access to member events", "api:event-rule:read": "Grants read access to event rules", "api:event-rule:modify": "Grants access to modify event rule", "api:event-rule:admin": "Grants full admin access to event rules", "api:member-list:read": "Grants read access to member list information", "api:member-list:modify": "Grants modify access to member list information", "api:member-partner-link:read": "Grants read access to member partner link information", "api:member-partner-link:modify": "Grants modify access to member partner link information", "api:member-payment-card:read": "Grants read access to member payment card information", "api:member-payment-card:modify": "Grants modify access to member payment card information", "api:member-phone:read": "Grants read access to member phone information", "api:member-phone:modify": "Grants modify access to member phone information", "api:member-preference:read": "Grants read access to member preference information", "api:member-preference:modify": "Grants modify access to member preference information", "api:member-promotion:read": "Grants read access to member promotion information", "api:member-promotion:register": "Grants access to register a member into a promotion", "api:member-redemption:create": "Grants redeem access to member redemption information", "api:member-redemption:over-redeem": "Grants access to over redeem", "api:member-redemption:read": "Grants read access to member redemption information", "api:member-redemption:cancel": "Grants access to cancel member redemptions", "api:member-redemption:migrate": "Allows migration of member redemption information", "api:member-redemption:patch": "Grants patching access to member redemption", "api:member-tier:read": "Grants read access to member tier information", "api:member-tier:adjust": "Grants access to adjust member tiers", "api:member-tier:migrate": "Grants access to migrate member tiers", "api:member-transaction:read": "Grants read access to transaction information", "api:member-transaction:cancel": "Grants access to cancel transactions", "api:member-transaction:clone": "Grants access to clone transactions", "api:member-transfer:transfer": "Grants access to do member to member transfers", "api:preference:read": "Grants read access to preference information", "api:promotion:read": "Grants read access to promotion information", "api:tier:read": "Grant read access to tier information", "api:promotion:register": "Grants access to register a member into a promotion using token", "api:promotion-token:manage": "Grants access to generate promotion token", "api:redemption:read": "Grants read access to redemption information", "api:redemption:modify": "Grants access to modify redemption information", "api:bonus-rule:read": "Grants read access to bonus rule configuration", "api:bonus-rule:modify": "Grants access to modify bonus rule configuration", "api:bonus-rule:manage": "Grants limited admin access to bonus rule configuration", "api:bonus-rule:admin": "Grants full admin access to bonus rules", "api:promotion-rule:read": "Grants read access to promotion rule configuration", "api:promotion-rule:modify": "Grants access to modify promotion rule configuration", "api:promotion-rule:manage": "Grants limited admin access to promotion rule configuration", "api:promotion-rule:admin": "Grants full admin access to promotion rules", "api:reports:under-investigation": "Grants access to under investigation report", "api:transaction:submit": "Grants access to submit transactions", "api:transaction:migrate": "Grants access to migrate transactions", "api:user:read": "Grants access to read user information", "api:user:modify": "Grants access to create user", "api:user-task:read": "Grants read access to user tasks", "api:user-task:modify": "Grants modify access to user tasks", "api:user-role:read": "Grants read access to user roles", "api:user-role:modify": "Grants modify access to user roles", "api:compensation:read": "Grants read access to hotel summary information", "api:compensation:modify": "Grants modify access to hotel summary information", "api:member-referral:read": "Grants read access to member referral information", "api:member-referral:modify": "Grants modify access to member referral information", "api:member-referral-codes:read": "Grants read access to member referral codes", "api:member-referral-codes:create": "Grants access to create member referral codes", "api:outbound-notification:modify": "Grants access to send outbound notification", "api:outbound-notification:read": "Grants access to read outbound notification types", "api:background-task:read": "Grants read access to background task information", "api:async-task:create": "Grants access to submit operations for background processing", "api:async-task:read": "Grants read access to background processing results", "api:audit-configuration:read": "Grants read access to audit configuration information", "api:audit-configuration:modify": "Grants modify access to audit configuration information", "api:badge:read": "Grant read access to badge information", "api:broadcast-messages:read": "Grant Read access to broadcast messages", "api:expression-config:read": "Grant read access to expression builder configuration", "api:managed-entity:read": "Grant read access to managed entity data", "api:customer-satisfaction:modify": "Grants modify access to customer satisfaction metrics", "api:member-linked-account:modify": "Grant modify access to member linked account", "api:member-linked-account:read": "Grants access to read linked member accounts", "api:enroll-codes:read": "Grants access to read enroll codes", "api:contact-us:modify": "Grants access to submit Contact Us inquiry", "api:data-release:read": "Grants read access to data releases", "api:points-pool:read": "Grants read access to points pools", "api:points-pool:modify": "Grants modify access to points pools", "api:segment:read": "Grants read access to segments", "api:segment:modify": "Grants modify access to segments", "api:communication-type:read": "Grants read access to communication types", "api:communication-type:modify": "Grants modify access to communication types", "api:member-status-match:read": "Grants read access to status match eligibility and submitted images/applications", "api:member-status-match:create": "Grants access to upload status match images and submit applications" } } }, "requiredScopes": [ "api:transaction:submit" ] } ], "cookieParameters": [] }, "responses": [ { "statusCode": "200", "description": "Success", "jsonExample": "", "isExpanded": true }, { "statusCode": "400", "description": "Bad request", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "object", "description": "", "customType": "ErrorResponse", "schema": [ { "name": "errors", "kind": "optional", "type": "array", "description": "List of errors", "modelRef": "#/components/schemas/ValidationError", "customType": "ValidationError[]", "schema": [ { "name": "code", "kind": "optional", "type": "string", "description": "Error code assigned to this violation" }, { "name": "fieldName", "kind": "optional", "type": "string", "description": "

Name of field that violated validation constraint (optional)

" }, { "name": "message", "kind": "optional", "type": "string", "description": "Internal message describing the error" }, { "name": "messageParameters", "kind": "optional", "type": "array", "description": "Error message parameters", "example": "", "itemType": "object", "customType": "object[]", "schema": [] } ] } ], "modelRef": "#/components/schemas/ErrorResponse", "isExpanded": true } ] }, { "statusCode": "401", "description": "Unauthorized", "jsonExample": "", "isExpanded": true }, { "statusCode": "403", "description": "Forbidden", "jsonExample": "", "isExpanded": true }, { "statusCode": "500", "description": "Internal error", "jsonExample": "", "isExpanded": true } ], "hasXCodeSamples": false, "examples": { "languages": [ { "id": "5PQskqDMBpFzuRdKB0NyN", "language": "curl", "label": "cURL", "code": "curl --request POST \\\n --url https://api.b.preview.loyaltyservices.io/api/v3/transactions \\\n --header 'accept: application/json'" }, { "id": "Y6fIbwud6fpF1GVLvX9lq", "language": "ruby", "label": "Ruby", "code": "require \"uri\"\nrequire \"json\"\nrequire \"net/http\"\n\nurl = URI(\"https://api.b.preview.loyaltyservices.io/api/v3/transactions\")\n\nhttps = Net::HTTP.new(url.host, url.port)\nhttps.use_ssl = true\n\nrequest = Net::HTTP::Post.new(url)\nrequest[\"accept\"] = \"application/json\"\nrequest[\"content-type\"] = \"application/json\"\n\nresponse = https.request(request)\nputs response.read_body\n" }, { "id": "D4J517mAveHQIoCg7uQwr", "language": "python", "label": "Python", "code": "import requests\nimport json\n\nurl = \"https://api.b.preview.loyaltyservices.io/api/v3/transactions\"\n\npayload = {}\nheaders = {\n 'accept': 'application/json',\n 'content-type': 'application/json'\n}\n\nresponse = requests.request(\"POST\", url, headers=headers, data=payload)\n\nprint(response.text)\n" }, { "id": "nPrbCBjuO9jP5fp-XEDhr", "language": "java", "label": "Java", "code": "OkHttpClient client = new OkHttpClient().newBuilder()\n .build();\nMediaType mediaType = MediaType.parse(\"application/json\");\nRequestBody body = RequestBody.create(mediaType, \"\");\nRequest request = new Request.Builder()\n .url(\"https://api.b.preview.loyaltyservices.io/api/v3/transactions\")\n .method(\"POST\", body)\n .addHeader(\"accept\", \"application/json\")\n .addHeader(\"content-type\", \"application/json\")\n .build();\nResponse response = client.newCall(request).execute();" } ], "selectedLanguageId": "5PQskqDMBpFzuRdKB0NyN" }, "results": { "languages": [ { "id": "gOiqfidWGyG8vQNZZMeYu", "language": "200", "code": "// Success\n" }, { "id": "rHMpXBekyIpAK4yJtj7uK", "language": "400", "code": "// Bad request\n{\n \"errors\": [\n {\n \"code\": \"\",\n \"fieldName\": \"\",\n \"message\": \"\",\n \"messageParameters\": [\n {}\n ]\n }\n ]\n}" }, { "id": "7RsP7CwCoY6X2l4dQCmrl", "language": "401", "code": "// Unauthorized\n" }, { "id": "ojPDnwZUfmFqNvA6Ytm_8", "language": "403", "code": "// Forbidden\n" }, { "id": "cwr7O8xSeVDEu75x_JxSR", "language": "500", "code": "// Internal error\n" } ], "selectedLanguageId": "gOiqfidWGyG8vQNZZMeYu" } }, "children": [ { "text": "" } ] }