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 Request

Example
1{
2  "requestId": "123e4567-e89b-12d3-a456-426614174000",
3  "amount": {
4    "amount": "100.00",
5    "currency": "AUD"
6  },
7  "token": "005.2fkv5o963b132z8ppa34srlh60987y87d55re237wsg9tr4q2"
8}
Was this page helpful?
Previous

Offers Response

Next
Built with

Response

offers_requestobjectRequired
Request to retrieve available billing agreement offers