For AI agents: a documentation index is available at the root level at /llms.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.

Home Guides API Reference

Reference

Introduction
Request Headers
Authentication
Errors
Data Requirements
Create Checkout
Get Checkout
Checkout Request
Checkout Response
Get Configuration
Get Configuration Mappings
Merchant Limit
Configuration Mappings
Retrieve Dispute
Receive Dispute
Respond to Dispute
Accept Dispute
Upload File
Retrieve file
Dispute
Meta
Evidence
Create Grant Approval
Create Grant
Retrieve Grant
Revoke Grant
Create Grant Alias
Start Grant Link Flow
Grant status updated
Create Billing Agreement
Create Billing Agreement Alias
Start Billing Agreement Approval Process
Cancel Billing Agreement (Alternative)
Retrieve Billing Agreement Offers
Retrieve Billing Agreement
Start Billing Agreement Link Flow
Get Billing Agreement Details
Cancel Billing Agreement
Capture Full Recurring Payment
Authorize Recurring Payment
Create Order
List Payments
Auth
Capture Full Payment
Get Payment By Order ID
Update Payment by Order ID
Capture Payment
Update Shipping Courier
Create Refund
Void
Get Payment By Token
Reverse Payment By Token
Authorize Payment
Capture Payment
Enrichments
Ping
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

Reference Payments Schemas

Authorize Payment

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": "MERCHANT"
25     }
26   }
27 }

Response

authorize_paymentobjectRequired

Was this page helpful?