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

Offer

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

Offers Request

Next
Built with

Response

offerobjectRequired
Represents an offer with payment details