• Home
  • Our APIs
  • Guides
  • Our Products
    • Nothing Found
  • Home
  • Our APIs
  • Guides
  • Our Products
    • Nothing Found
    1.0.0
    Introduction
    Authentication
    Customers
    Payments
      post
      Create Payment Request
      get
      Remind Payment Request
      get
      Cancel Payment Request
      get
      Get Payment Request
      get
      Get Payment Request List
    Transactions

Get Payment Request List

Endpoint to get payment requests by division

Securityapi_key
Request
path Parameters
divisionID
required
string

Division Identifier.

query Parameters
ci
string

Customer Identifier

da
string

Date created after

db
string

Date created before

aa
string

Amount Above

ab
string

Amount Below

rn
string

Reference Number

st
string

Status

pl
string

Page Length

pn
string

Page number

ia
boolean

Is Active

Responses
200

OK

401

Invalid API key/MID.

403

Forbidden from performing this action.

404
500
get/divisions/{divisionID}/paymentRequests/query
Response samples
  • 200
  • 401
  • 403
  • 404
  • 500
application/json
{
  • "paymentRequests": [
    • {
      • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      • "createdAt": "string",
      • "updatedAt": "string",
      • "userId": "string",
      • "amount": "string",
      • "paymentLink": "string",
      • "formId": "string",
      • "referenceNumber": "string",
      • "status": "string",
      • "threeDSStatus": "string",
      • "paymentType": "string",
      • "deletedAt": "string",
      • "canceledAt": "string",
      • "notifiedAt": "string",
      • "retryAttempt": 0,
      • "expiryDate": "string",
      • "paymentDocumentFileName": "string",
      • "paymentMethod": "string",
      • "bnplPaymentRequestId": "string",
      • "customer": {
        • "name": "Test Customer",
        • "email": "[email protected]",
        • "cards": [
          • {
            • "lastFourDigits": "string",
            • "token": "string",
            • "holder": "string",
            • "expiryYear": "string",
            • "expiryMonth": "string",
            • "type": "visa",
            • "isActive": true
            }
          ],
        • "phoneNumber": 61431306461,
        • "postcode": 2000,
        • "addressNumber": "12 Kings Road",
        • "addressLineOne": "Sydney CBD",
        • "addressLineTwo": "string",
        • "state": "NSW",
        • "city": "Sydney",
        • "country": "Australia",
        • "isActive": false
        },
      • "division": {
        • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
        • "name": "string",
        • "createdAt": "string",
        • "updatedAt": "string",
        • "type": "string",
        • "merchantId": "string",
        • "brn": "string",
        • "isFundingEnabled": true,
        • "isCreditEnabled": true,
        • "isBrnVerified": true,
        • "phoneNumber": "string",
        • "postcode": "string",
        • "addressLineOne": "string",
        • "addressLineTwo": "string",
        • "state": "string",
        • "city": "string",
        • "country": "string",
        • "website": "string",
        • "currency": "string",
        • "threeDS": true,
        • "accountNumber": "string",
        • "accountName": "string",
        • "branchCode": "string",
        • "paymentPageConfigCode": "string",
        • "paymentChannels": [
          • {
            • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
            • "createdAt": "string",
            • "updatedAt": "string",
            • "paymentChannelType": "instant payment",
            • "channelId": "string"
            }
          ]
        },
      • "paymentDocumentUrl": "string",
      • "userFirstName": "string",
      • "userLastName": "string",
      • "formName": "string"
      }
    ],
  • "meta": {
    • "currentPage": 0,
    • "itemsPerPage": 0,
    • "totalItems": 0,
    • "itemCount": 0,
    • "totalPages": 0
    }
}
Legal
  • Privacy Policy
Support
  • Contact us
© Copyright Till Payments 2023. All right reserved.