Payouts

Get transfer by merchant transfer id

Retrieves a payout transfer using the merchantTransferId your own systems assigned to it, so you can reconcile against your records without having to store Kashier's transferId. merchantTransferId is unique per merchant.

get/v2/transfers/merchant-transfer-id/{merchantTransferId}

Request

  • Base URL: https://test-api.kashier.io
  • URL: https://test-api.kashier.io/v2/transfers/merchant-transfer-id/{merchantTransferId}
  • Auth: API key in header Authorization

Path parameters

merchantTransferIdstring required

The unique identifier your systems assigned to the transfer.

Response

The transfer matching that merchant transfer id.

transferIdstring
merchantTransferIdstring
recipientNamestring
recipientNumberstring
recipientBankstring
amountnumber
method'bank' | 'wallet' | 'instant wallet' | 'card'

How the money reaches the recipient. bank and card payouts also require a recipientBank.

status'PENDING' | 'INITIATED' | 'IN_TRANSIT' | 'TRANSFERRED' | 'FAILED'

Where a transfer is in its lifecycle. A transfer starts PENDING, is debited from your balance (INITIATED), is sent to the provider (IN_TRANSIT), and finishes as TRANSFERRED or FAILED. A FAILED transfer is credited back to your balance.

openForReturnboolean

Set on a TRANSFERRED transfer that the receiving bank or wallet may still bounce back. Treat true as not yet final when you reconcile.

createdAtstring
updatedAtstring

Changes

No recorded changes to this operation across all 1 revision of this API.