Check Transfer Status

This endpoint is used by a user to check the status of a transfer which they initiated.

To check the status of the transfer, send the GET /payment/v1/transfers/{transactionReference} request.

In the successful response, you receive the details on the transfer and its status.

{
   "transactionReference":"493fe5f3-5cbe-49cb-9786-f1a03e1e61f1",
   "paymentReference":"REF850136",
   "amount":{
      "value":25,
      "currency":"USD"
   },
   "fee":{
      "value":0.0,
      "currency":"USD"
   },
   "walletId": "a:23120645967001:kIlS5t3:1",
   "status": "COMPLETED",
   "createdAt": "2024-08-09T10:49:33.809785Z"
   "details":{
      "type": "WALLET",
      "beneficiary": {
         "entityType": "COMPANY",
         "companyDetails": {
            "name":"some-name"
         },
         "individualDetails": null,
         "address":{
            "addressLine1": "Level 3",
            "addressLine2": "89 Charterhouse St, Barbican",
            "city": "London",
            "region": "London",
            "postCode": "EC1M 6PE",
            "countryCode": "GB"
         },
         "walletId": "a:23120645967001:kIlS5t1:1"
      }
   }
}

Attribute	Description
`transactionReference`	Unique reference identifier for the transaction (UUID).
`paymentReference`	Reference or description for the payment.
`amount`	Object containing the amount and currency of the transfer.
`amount.value`	The value of the transfer.
`amount.currency`	The currency of the transfer.
`fee`	Contains information about the fees related to the transfer.
`fee.value`	The value of the fee.
`fee.currency`	The currency of the fee.
`walletId`	Unique identifier for the wallet from where funds are being transferred out.
`status`	The status for the transfer. Can be one of the following: `PENDING` `COMPLETED` `FAILED` `REJECTED`
`createdAt`	The date the transfer was created.
`details`	Contains details of the transfer, including the entity and bank info.
`details.type`	Type of transaction (e.g., "FIAT").
`details. beneficiary`	Contains beneficiary information.
`details.beneficiary.entityType`	Specifies the type of beneficiary.
`details.beneficiary companyDetails`	Specifies the company details of the beneficiary.
`details.beneficiary.individualDetails`	Specifies the company details of the beneficiary.
`details.beneficiary.address`	Specifies the address details of the beneficiary.
`details.beneficiary.walletId`	Specifies the walletId details of the beneficiary where the funds should be transferred to.