Skip to main content
GET
Get Payin
Returns one payin belonging to the account, with the sender details the receiving bank reported and the balance the money was credited to. A voided payin is still retrievable by id even though List Payins hides it by default. Requires an API key with read access on the payments scope.

Path Parameters

string
required
The account’s external ID (starts with acct_)
string
required
The payin’s external ID (starts with pi_)

Response

string
Payin identifier (starts with pi_)
string
Always returns "payin"
string
Account ID (starts with acct_)
string
Payin amount (decimal)
string
Currency code: a supported fiat code or one of USDC, USDT
string
Blockchain network for a crypto payin, otherwise null
string
Amount converted to USD, or null when no rate was available
string
Payin status: pending, completed, failed or voided. A payin moves pending → completed or pending → failed; a completed payin can later be voided. failed and voided are terminal.
string
Rail the money arrived on: swift, ach, ach_same_day, fedwire, fednow, rtp, sepa, sepa_instant, faster_payments, chaps, spei, pix, crypto or manual. null when the bank reported no rail, for example an internal transfer.
string
Remittance reference attached by the sender. Read-only. null when none was provided.
string
Blockchain transaction hash for a crypto payin, otherwise null
string
Hop wallet the crypto payin was credited to (starts with wal_), otherwise null
string
On-chain address the crypto payin was sent to, otherwise null
string
On-chain address the crypto payin was sent from, otherwise null. Also null when no sender address was reported for the deposit.
string
Sender name as reported by the bank, or null
string
Masked sender account. An IBAN is masked as first 4 + **** + last 4 (GB29****6819); an account number as **** + last 4 (****4412). null when the bank reported neither.
string
Sender bank BIC, or null
string
Sender country as an ISO 3166-1 alpha-2 code, or null
object
Which balance was credited: {"type": "trading_account"} or {"type": "virtual_account", "virtual_account_id": "va_…"}
string
Payin type: standard or manual (booked by Hop)
string
ISO 8601 timestamp when the payin was initiated
string
ISO 8601 timestamp when the payin completed, or null
string
ISO 8601 timestamp when the payin failed, or null
string
Reason for failure, or null
string
ISO 8601 timestamp when the payin was voided, or null
string
Reason the payin was voided, or null
string
ISO 8601 timestamp when created
string
ISO 8601 timestamp when last updated
string
Actor that created the payin: the API key id (starts with ak_), or hop_admin for a manual payin
string
Actor that last updated the payin, or null

Errors

Request Example

Response Example