RSL Payment API

<back to all web services

QueuePaymentSyncStatus

The following routes are available for this service:
POST/payments/syncStatusAsyncSync the payment status asyncRetrieves the payment status from Braintree and updates the payment database
QueuePaymentSyncStatus Parameters:
NameParameterData TypeRequiredDescription
PaymentIdentifiersbodyList<PaymentIdentifier>YesList of transaction Identifiers that need to their status updated.
PaymentIdentifier Parameters:
NameParameterData TypeRequiredDescription
ReferenceNumberformstringYesUnique payment reference number.
TransactionIdformstringNoUnique Braintree transaction Id .
QueuePaymentSyncStatusResponse Parameters:
NameParameterData TypeRequiredDescription
ResponseStatusformResponseStatusNo

To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv

HTTP + JSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /payments/syncStatusAsync HTTP/1.1 
Host: azs-dev-payment-web.azurewebsites.net 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	paymentIdentifiers: 
	[
		{
			referenceNumber: String,
			transactionId: String
		}
	]
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	responseStatus: 
	{
		errorCode: String,
		message: String,
		stackTrace: String,
		errors: 
		[
			{
				errorCode: String,
				fieldName: String,
				message: String,
				meta: 
				{
					String: String
				}
			}
		],
		meta: 
		{
			String: String
		}
	}
}