For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
HomeGuidesAPI Reference
HomeGuidesAPI Reference
  • Reference
    • Introduction
      • Capture Payment
      • Consumer
      • Consumer Offers
      • Contact
      • Create Refund
      • Discount
      • Interval
      • Item
      • Money
      • Offer
      • Offers Request
      • Offers Response
      • Order Details
      • Payment Event
      • Payment
      • Payment (Auth)
      • Payment Schedule
      • Refund
      • Shipping Courier
LogoLogo
ReferenceModels

Offers Response

Example
1{
2  "consumerMaskedEmail": "j***@e***.com",
3  "consumerAmount": {
4    "amount": "100.00",
5    "currency": "AUD"
6  },
7  "offers": [
8    {
9      "type": "PAY_IN_4",
10      "merchantAmount": {},
11      "exchangeRate": 1.35,
12      "amountDueToday": {},
13      "payments": [
14        {
15          "amount": {
16            "amount": "50.00",
17            "currency": "USD"
18          },
19          "dueDate": "2024-03-04"
20        },
21        {
22          "amount": {
23            "amount": "50.00",
24            "currency": "USD"
25          },
26          "dueDate": "2024-03-18"
27        },
28        {
29          "amount": {
30            "amount": "50.00",
31            "currency": "USD"
32          },
33          "dueDate": "2024-04-01"
34        },
35        {
36          "amount": {
37            "amount": "50.00",
38            "currency": "USD"
39          },
40          "dueDate": "2024-04-15"
41        }
42      ],
43      "crossBorder": false,
44      "appliedPromotion": {},
45      "consumer": {
46        "noPaymentUpfront": {}
47      }
48    }
49  ]
50}
Was this page helpful?
Previous

Order Details

Next
Built with

Response

offers_responseobjectRequired
Response containing available offers for the consumer