GET Payment by context, contextId

Overview

Retrieve payments by Booking ID

Request

GET /[context]/[contextId]/Payment

Request Information

Request Parameters

Name
Type
Requirement
Description
context
String
Mandatory 
Context in Request URI should be 'bookings' or 'customers'
contextId
Integer
Mandatory 
ContextId in Request URI should be Booking ID or Customer ID

Response Information

Response Properties

Name
Type
Description
payments
List<Payment>
List of Payments

Payments

Name
Type
Description
currencyCode
String
Currency Code
totalAmount
Decimal
Total Amount (DonationAmount + Amount)
amount
Decimal
Amount paid for the booking
donationAmount
Decimal
Donation Amount
paymentDate
String
Payment date
paymentMethod
String
Payment Method
creditCardFeeAmount
Decimal
Credit Card Fee Amount
contextType
String
Context Type
contextId
Integer
Context Id
id
Integer
ID of the resource
href
String
URI of the resource
sequence
Int64
Sequence of product
externalReference
String
Unique external reference assigned when booking the component

Response Codes

HTTP status code
Description
200 OK
The resource was retrieved successfully
400 Bad Request
The resource was malformed
401 Unauthorized
Missing or invalid API key
404 Not Found
The specified resource was not found
500 Internal Server Error
An unexpected error occurred on the API server

Response Example

{
  "payments": [
    {
      "currencyCode": "AU",
      "totalAmount": 2500.0,
      "amount": 2500.0,
      "donationAmount": 25.0,
      "paymentDate": "2019-02-10",
      "paymentMethod": "Adyen",
      "creditCardFeeAmount": 30.0,
      "contextType": "Booking",
      "contextId": 1926919,
      "id": 887124,
      "href": "context/contextid/payment/887124",
      "sequence": "202403312359580000",
      "externalReference": "20240330"
    },
    {
      "currencyCode": "AU",
      "totalAmount": 2500.0,
      "amount": 2500.0,
      "donationAmount": 25.0,
      "paymentDate": "2019-02-10",
      "paymentMethod": "Adyen",
      "creditCardFeeAmount": 30.0,
      "contextType": "Booking",
      "contextId": 1926919,
      "id": 887124,
      "href": "context/contextid/payment/887124",
      "sequence": "202403312359580000",
      "externalReference": "20240330"
    }
  ]
}