Retrieve a recipient

get https://production.hifibridge.com/v2/multi-currency-account/transfers/recipients/{recipientId}

Get the details of a recipient.

Responses

Response body

object

string

Recipient ID.

createdAt

date-time

The date and time when the recipient was created.

updatedAt

date-time

The date and time when the recipient was last updated.

status

string

Recipient KYC status：
CREATED: recipient kyc application created
NOT_INITIATED: recipient kyc application not initiated
PENDING: recipient kyc application submitted and in process
AVAILABLE: recipient kyc application approved and available for payout
DECLINED: recipient kyc application declined

CREATED NOT_INITIATED PENDING AVAILABLE DECLINED

rejectionReasons

string

Rejection reasons.

failedReason

string

Failed reason.

userId

string

User ID.

type

string

Recipient type.

individual business

recipient

object

recipient info

type

string

type of recipient.

00 UBO (bank.accountName must match the user's KYC name)
10 Supplier other
11 Supplier procurement
12 Supplier logistics
13 Supplier advertising
14 Supplier warehousing
15 Supplier operation agent
16 Supplier freelancer
20 General other
21 General freelance
22 General employee
23 General platform user
24 General remittance

address

object

recipient address

phone

string

recipient phone number

string

recipient email

name

string

recipient name

nationality

string

recipient nationality. Required when recipient.type is 24.

occupation

string

recipient occupation code. Required when recipient.type is 24.
Here is the list of occupation codes.

certificationType

string

recipient certification type. Required when recipient.type is 24.

Certificate type:
00 = Chinese Mainland ID Card
01 = Chinese Mainland Residence Permit
02 = Passport
03 = Hong Kong, Macao and Taiwan ID Card
04 = Hong Kong, Macao and Taiwan Residence Permit
05 = Hong Kong, Macao and Taiwan Exit-Entry Permit
06 = Non-Chinese ID Card
07 = Non-Chinese Residence Permit

certificationNumber

string

recipient certification number. Required when recipient.type is 24.

certificationFrontUrl

string

recipient certification front URL. Required when recipient.type is 24.

certificationBackUrl

string

recipient certification back URL. Required when recipient.type is 24.

certificationIssuanceDate

string

recipient certification issuance date. Required when recipient.type is 24.

certificationExpirationDate

string

recipient certification expiration date. Required when recipient.type is 24.

certificationIssuanceAuthority

string

recipient certification issuance authority. Required when recipient.type is 24.

bank

object

bank info

currency

string

Bank account currency. See the full list of payout currencies and channels by region here.

accountName

string

individual's name or business name.

accountNumber

string

Bank account number. Required if bank.iban is not provided.

routingNumber

string

Routing number for local payment channels.

bankName

string

Bank name in the local language.

bankCode

string

Bank code.

accountType

string

Account type.

SAVINGS CHECKING STANDARD

accountPurpose

string

Purpose of the bank account

accountHolder

object

Account holder info

branchName

string

Name of the account opening branch.

branchCode

string

Opening branch code/ interbank number.

ifscCode

string

India bank code.

sortCode

string

UK bank sort code (6 digits).

address

object

Bank branch address.

swiftCode

string

International SWIFT code. This field only supports 8 or 11 digits. Required for international payments.

iban

string

EU international bank account number. Required if bank.accountNumber is not provided.

Language

Credentials

Bearer

JWT

URL


xxxxxxxxxx
1
curl --request GET \
2
     --url https://production.hifibridge.com/v2/multi-currency-account/transfers/recipients/recipientId \
3
     --header 'accept: application/json'

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Success

401Unauthorized

404Not Found

500Internal Server Error