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.
GuidesAPI Reference
GuidesAPI Reference
  • Reference
    • Introduction
      • GETList Payments
      • POSTAuth
      • POSTCapture Full Payment
      • GETGet Payment By Order ID
      • PUTUpdate Payment by Order ID
      • POSTCapture Payment
      • PUTUpdate Shipping Courier
      • POSTCreate Refund
      • POSTVoid
      • GETGet Payment By Token
      • POSTReverse Payment By Token
        • AuthorizePayment
        • CapturePayment
LogoLogo
ReferencePaymentsSchemas

AuthorizePayment

Example
1{
2  "requestid": "d22f5305-05f3-48a0-9131-a4e6e5f58b9a",
3  "token": "005.2fkv5o963b132z8ppa34srlh60987y87d55re237wsg9tr4q2",
4  "merchantReference": "merchant-order-123",
5  "amount": {
6    "amount": "100.00",
7    "currency": "AUD"
8  },
9  "isCheckoutAdjusted": true,
10  "paymentScheduleChecksum": "string",
11  "items": [],
12  "shipping": {
13    "name": "Joe Consumer",
14    "line1": "Level 5",
15    "line2": "390 Collins Street",
16    "area1": "Melbourne",
17    "region": "VIC",
18    "postcode": "3000",
19    "countryCode": "AU",
20    "phoneNumber": "0400 000 000"
21  },
22  "enrichments": {
23    "initiation": {
24      "actor": "CUSTOMER"
25    },
26    "subscription": {
27      "type": "FIXED",
28      "interval": "DAY",
29      "intervalCount": 1
30    }
31  }
32}
Was this page helpful?
Previous

CapturePayment

Next
Built with

Response

authorize_paymentobjectRequired