Create Payment Account
Create a new Payment Account for Mandates, Payments or Payouts.
Access: This flow is available on demand for Finverse customers who want to directly manage Payment Users and Payment Accounts. Contact [email protected] to request access.
Authorization: customer_token
Request body
account_number (object, required)
Bank account number details.
Response fields
The response is a Payment Account object.
Refer to Payment Account object data model in GET /payment_users/{user_id}/payment_accounts.
Authorizations
The access token received from the authorization server in the OAuth 2.0 flow.
Body
request body for creating payment account
Type of payment account. Currently only allow creating external account.
EXTERNAL_ACCOUNT "EXTERNAL_ACCOUNT"
Accountholder name of the payment account
"Chan Li Pak"
Finverse Institution ID for the payment institution.
100"hsbc-hk"
A unique identifier generated after creating user (Finverse Payment User ID)
100"01GY6H0JA7BS8EVGY56NSHFX2E"
Masked account number of the payment account. Optional for EXTERNAL_ACCOUNT type. Can be provided when account_number is not available. Only one of account_number or account_number_masked can be provided.
List of currencies supported by the payment account
3Response
Successful
Payment account id
Masked Account number of the payment account
Type of payment account.
EXTERNAL_ACCOUNT, SETTLEMENT_ACCOUNT "EXTERNAL_ACCOUNT"
Accountholder name of the payment account
"Chan Li Pak"
3-digit code associated with bank
"004"
3-digit code used to identify specific bank branch
"123"
The business units the payment account belongs to
Timestamp of when the payment link was created in ISO format (YYYY-MM-DDTHH:MM:SS.SSSZ)
List of currencies supported by the payment account
The customer app ID
"01ARZ3NDEKTSV4RRFFQ69G5FAV"
Finverse Institution ID for the payment institution.
"hsbc-hk"
Institution Name for the sender’s institution.
"HSBC"
This field is only applicable to settlement account
Additional attributes of the sender account in key:value format (e.g. sender_id: 1234). It supports up to 10 key:value pairs, whereas the key and value supports up to 50 and 1000 characters respectively.
Timestamp of when the payment link was last updated in ISO format (YYYY-MM-DDTHH:MM:SS.SSSZ)
A unique identifier generated after creating user (Finverse Payment User ID)
"01GY6H0JA7BS8EVGY56NSHFX2E"