POST PaymentAdvice by context, contextId

Overview

Request

POST /[context]/[contextId]/PaymentAdvice

Request Information

Request Parameters

Name
Type
Requirement
Description
context
String
Mandatory 
Context in Request URI should be 'bookings'
contextId
Integer
Mandatory 
ContextId in Request URI should be Booking ID
currency
String
Mandatory 
Currency
paymentMethodId
Integer
Optional 
Payment Method Id
paidAmount
Decimal
Mandatory 
Paid Amount
paymentReference
String
Mandatory 
Payment Reference

Request Example

{
  "currency": "AUD",
  "paymentMethodId": 1,
  "paidAmount": 2500.0,
  "paymentReference": "B6412232-3EEE-4A5A-A0EC-EF704B5A9D50"
}

Response Information

Response Properties

Name
Type
Description
message
String
Message

Response Codes

HTTP status code
Description
200 OK
The resource was updated successfully
201 Created
The resource was created
400 Bad Request
The resource was malformed
401 Unauthorized
Missing or invalid API key
500 Internal Server Error
An unexpected error occurred on the API server
202 Accepted
The request was accepted
404 Not Found
The specified resource was not found
403 Forbidden
One or more parameters has already been set on the resource record and cannot be updated

Response Example

{
  "message": "Payment Advice is Success"
}