Get Payment Status

The GetPaymentStatus method enables to receive 'Payment Status Request against received Inbound Transaction' initiated by the sender for which the bank responds with the current status of the transaction

Method: InboundServiceClient:GetPaymentStatus

Headers

Name	Value
Credential	"Basic c3VwcG9ydCsxQG5ldHN5cy1pbmMuY29tOjM5ZDYxOGJkNTVmN5NWQxY2RlNDE5"
Signature	"{{signature}}"

Example

Payload Parameters

Parameter	Description
instructedAmount Mandatory	Object
amount Mandatory	Number Amount of transaction as instructed by the sender Example – 343400
currency Mandatory	String Currency code in which the transaction happens Example – "USD"
msgID Mandatory	String Unique message identifier to identify the pacs.008 message Example – "20240531101110802HlHiR6JQO50N4ZO"
processor Mandatory	String Payment channel through which the transaction happens Example – "FEDNOW"
rawMessage Mandatory	String Raw response message related to the transaction encoded in Base64 Example – "Base64 encoded data for received xml message"
referenceNumber Mandatory	String Reference number of the transaction Example – "20240531101110802tzdG6SLGjfr9Ufk"
uuid Mandatory	String Unique ID present in the message Example – "5383c79f-76bb-4f24-be43-c7e0c61761e0"

Request Body (Applicable only for FedNow)

{
  "instructedAmount": {
    "amount": 343400,
    "currency": "USD"
  },
  "msgID": "20240531101110802HlHiR6JQO50N4ZO",
  "processor": "FEDNOW",
  "rawMessage": "Base64 encoded data for received xml message",
  "referenceNumber": "20240531101110802tzdG6SLGjfr9Ufk",
  "uuid": "5383c79f-76bb-4f24-be43-c7e0c61761e0"
}

Response

Response Parameters

Parameter	Description
referenceNumber	String Reference number of the transaction Example – "20240531101110802tzdG6SLGjfr9Ufk"
status	String Status of the transaction Example – "ACCC"

Response Body (Applicable only for FedNow)

{
  "referenceNumber": "20240531101110802tzdG6SLGjfr9Ufk",
  "status": "ACCC"
}