{"info":{"_postman_id":"7245cd17-b114-4f58-8936-dafbbfaf4ccc","name":"Full-Stack Payments","description":"

The docs comprise comprehensive payment solutions including but not limited to collection, payout, issuing, acquiring, etc.

\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"34780078","collectionId":"7245cd17-b114-4f58-8936-dafbbfaf4ccc","publishedId":"2sAXxTcqqX","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"00acea"},"publishDate":"2026-03-18T12:43:27.000Z"},"item":[{"name":"International Payments & Commercial Cards","item":[{"name":"🧑 Onboarding","item":[{"name":"Submit KYC","event":[{"listen":"test","script":{"id":"0423c642-13d7-4d53-a86d-6af309996903","exec":[""],"type":"text/javascript","packages":{}}}],"id":"a7f598d4-767f-4e33-a0a6-953551cf3aa3","request":{"method":"POST","header":[],"url":"/openapi/v3/register/create/","description":"

Request Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

No.	Parameter	Type	Length	Required/Optional	Remarks
1.	outBizId	String	26	M	Unique registration identifier assigned by client
2.	registerName	String	60	M	Name of registrant
3.	registerEname	String	255	M	Name of registrant in English
4.	userAlias	Array		O	Alias of registrant
5.	registerEmail	String	60	M	Unique email address used for registration. Email address cannot be re-used
6.	registerMobile	String	30	M	Mobile number used for registration
7.	zoneNumber	String	6	O	Default to +86 if not provided
8.	registerType	String	1	M	Used to specify the type of onboarding entity 1：Individual 2：Business
9.	identityType	String	1	M	Used to specify the identity of registrant 1：Legal person 2：Authorised representative
10.	frontFilePath	String	255	C	Mandatory when registrant is authorised representative
11.	behindFilePath	String	255	C	Mandatory when registrant is authorised representative
12.	authFilePath	String	255	C	Mandatory when registrant is authorised representative
13.	remark	String	255	O
14.	companyInfo	JSON		C	Mandatory when type of onboarding entity is business
14.1.	companyName	String	varchar(128)	M	Business name
14.2.	companyNameEn	String	varchar(128)	M	Business name in English
14.3.	registerCountryCode	String	2	M	Country code of the country where the business is registered
14.4.	openAddress	String	varchar(255)	M	Business address
14.5.	openAddressEn	String	varchar(255)	M	Business address in English
14.6.	registerFilePath	String	varchar(255)	M	File path for certificate of incorporation
14.7.	registerExtraFilePath	String	varchar(255)	O	File path for any additional business documents
14.8.	payCur	String	255	M	Transaction currencies
14.9.	payMonthAmt	Number		M	Projected monthly volume in USD
14.10.	tradeType	String	1	M	Used to specify the type of business 1: Cross-border e-commerce 2: B2B export 3: Both 1 and 2 4: Logistics services 5: B2B import 6: Travel services 7: Content economy 8: Others (such as information services provider)
14.11.	legalInfoList	Array		M
14.11.1.	legalUserAlias	Array		M	Alias of legal person
14.11.2.	name	String	255	M	Name of legal person
14.11.3.	legalCardType	String	1	M	Used to specify the type of ID document 1: National ID 2: Passport
14.11.4.	cardNumber	String	128	M	ID number
14.11.5.	nationality	String	2	M	Nationality of legal person
14.11.6.	legalFrontFilePath	String	varchar(255)	M	File path for front page of the ID document specified
14.11.7.	legalBehindFilePath	String	varchar(255)	O	File path for back page of the ID document specified
14.12.	shareholderInfoList	Array		M
14.12.1.	shareholderAlias	Array	255	M	Alias of shareholder
14.12.2.	name	String	255	M	Name of shareholder
14.12.3.	shareholderPercent	String		M	Shareholding ratio, a maximum of 2 decimals supported
14.12.4.	shareholderCardType	String	1	M	Used to specify the type of ID document for shareholder 1: National ID 2: Passport
14.12.5.	cardNumber	String	128	M	ID number
14.12.6.	shareholderFrontFilePath	String	varchar(255)	M	File path for front page of the ID document specified
14.12.7.	shareholderBehindFilePath	String	varchar(255)	O	File path for back page of the ID document specified
15	individualInfo	JSON		C	Mandatory when type of onboarding entity is individual
15.1	cardType	String	1	M	Type of personal ID document, possible values: 1: National ID 2: Passport
15.2	name	String	128	M	Full name of the individual
15.3	ename	String	128	O	Individual's full name in English
15.4	orgCode	String	30	M	ID number of the individual
15.5	sex	String	1	M	1: Male 2: Female
15.6	occupation	String	20	M	Possible values: GOVERNMENT_OFFICERS GOVERNMENT_WORKERS SOE_AND_STATE_ORGAN_EXECUTIVES SOE_AND_STATE_ORGAN_EMPLOYEES PRIVATE_BUSINESS_OWNERS_AND_EXECUTIVES PRIVATE_BUSINESS_EMPLOYEES NONE-GOVERNMENT_ORGANIZATION_EXECUTIVES NONE-GOVERNMENT_ORGANIZATION_EMPLOYEES SOLE_TRADERS RETIREES STUDENTS UNEMPLOYED FREELANCER
15.7	nationality	String	2	M	Nationality of the individual
15.8	countryCode	String	2	M	ISO 3166 2-digit country code of residential address of the individual
15.9	birthDate	Date		M	DOB of the individual
15.10	province	String	128	M	Province of the residential address
15.11	city	String	128	M	City of the residential address
15.12	district	String	128	O	District of the residential address
15.13	address	String	255	M	Full residential address
15.14	addressEn	String	255	M	Full residential address in English
15.15	frontFilePath	String	255	M	File path to the front page of National ID, or Passport e.g.: /INPUT/......
15.16	behindFilePath	String	255	O	File path to the back page of National ID
15.17	handFilePath	String	255	C	File path to selfie of the individual holding their passport Mandatory when type of personal ID document is Passport Supported file types: PNG, JPG, JPEG, BMP
15.18	attachFilePath	String	255	C	File path to specific supplementary document Supported file types: PNG, JPG, JPEG, BMP

Response Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

No.	Parameter	Type	Length	Remarks
1.	registerId	String	30	Unique registration reference number assigned by SUNRATE
2.	outBizId	String	26	Unique registration identifier assigned by client
3.	acctId	String	8	Unique 8-digit user account identifier assigned by SUNRATE

Request Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

No.	Parameter	Type	Length	Required/Optional	Remarks
1.	acctId	String	8	M	Unique 8-digit user account identifier assigned by SUNRATE
2.	registerName	String	60	M	Name of the registrant
3.	registerEmail	String	60	M	Email address used for registration
4.	registerMobile	String	30	M	Mobile number used for registration
5.	registerStatus	String	1	M	Possible values: 1, 2 1：KYC is complete, account has been verified 2：KYC is incomplete, additional information is required
6.	remark	String	128	O
7.	checkRemark	String	128	C	Compliance review opinion when KYC is incomplete

Response Parameters
None

Request Parameters

No.	Parameter	Type	Length	Required/Optional	Remarks
1.	outBizId	String	26	M	Unique registration identifier assigned by client
2.	registerName	String	varchar（60）	M	Name of registrant
3.	registerEname	String	varchar(255)	M	Name of registrant in English
4.	registerType	String	1	M	Used to specify the type of onboarding entity 1：Individual 2：Business
5.	identityType	String	1	M	Used to specify the identity of registrant 1：Legal person 2：Authorised representative
6.	remark	String	varchar （255）	O
7.	companyInfo	JSON		C	Mandatory when type of onboarding entity is business
7.1.	companyName	String	varchar(128)	M	Business name
7.2.	companyNameEn	String	varchar(128)	M	Business name in English
7.3.	registerCountryCode	String	2	M	Country code of the country where the business is registered
7.4.	openAddress	String	varchar(255)	M	Business address
7.5.	openAddressEn	String	varchar(255)	M	Business address in English
7.6.	registerFilePath	String	varchar(255)	M	File path for certificate of incorporation
7.7.	registerExtraFilePath	String	varchar(255)	O	File path for any additional business documents
8.	legalInfoList	Array		O
8.1.	legalUserAlias	Array		M	Alias of legal person
8.2.	name	String	255	M	Name of legal person
8.3.	legalCardType	String	1	O	Used to specify the type of ID document for legal person 1: National ID 2: Passport
8.4.	cardNumber	String	128	M	ID number
8.5.	legalFrontFilePath	String	varchar(255)	M	File path of front page of the ID document specified
8.6.	legalBehindFilePath	String	varchar(255)	O	File path for back page of the ID document specified
9.	shareHolderInfoList	Array		M
9.1.	shareholderAlias	String		M	Alias of shareholder
9.2.	shareholderPercent	String		M	Shareholding ratio, a maximum of 2 demicals supported
9.3.	name	String	255	M	Name of shareholder
9.4.	shareholderCardType	String	1	M	Used to specify the type of ID document for shareholder 1: National ID 2: Passport
9.5.	cardNumber	String	128	M	ID number
9.6.	shareholderFrontFilePath	String	varchar(255)	M	File path for front page of the ID document specified
9.7.	shareholderBehindFilePath	String	varchar(255)	O	File path for back page of the ID document specified
10	individualInfo	JSON		C	Mandatory when type of onboarding entity is individual
10.1	cardType	String	1	M	Type of personal ID document, possible values: 1: National ID 2: Passport
10.2	name	String	128	M	Full name of the individual
10.3	ename	String	128	O	Individual's full name in English
10.4	orgCode	String	30	M	ID number of the individual
10.5	sex	String	1	M	1: Male 2: Female
10.6	occupation	String	20	M	Possible values: GOVERNMENT_OFFICERS GOVERNMENT_WORKERS SOE_AND_STATE_ORGAN_EXECUTIVES SOE_AND_STATE_ORGAN_EMPLOYEES PRIVATE_BUSINESS_OWNERS_AND_EXECUTIVES PRIVATE_BUSINESS_EMPLOYEES NONE-GOVERNMENT_ORGANIZATION_EXECUTIVES NONE-GOVERNMENT_ORGANIZATION_EMPLOYEES SOLE_TRADERS RETIREES STUDENTS UNEMPLOYED FREELANCER
10.7	nationality	String	2	M	Nationality of the individual
10.8	countryCode	String	2	M	ISO 3166 2-digit country code of residential address of the individual
10.9	birthDate	Date		M	DOB of the individual
10.10	province	String	128	M	Province of the residential address
10.11	city	String	128	M	City of the residential address
10.12	district	String	128	O	District of the residential address
10.13	address	String	255	M	Full residential address
10.14	addressEn	String	255	M	Full residential address in English
10.15	frontFilePath	String	255	M	File path to the front page of National ID, or Passport e.g.: /INPUT/......
10.16	behindFilePath	String	255	O	File path to the back page of National ID
10.17	handFilePath	String	255	C	File path to selfie of the individual holding their passport Mandatory when type of personal ID document is Passport Supported file types: PNG, JPG, JPEG, BMP
10.18	attachFilePath	String	255	C	File path to specific supplementary document Supported file types: PNG, JPG, JPEG, BMP

Response Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

No.	Parameter	Type	Length	Remarks
1.	outBizId	String	26	Unique registration identifier assigned by client
2.	acctId	String	8	Unique 8-digit user account identifier assigned by SUNRATE

Request Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

No.	Parameter	Type	Length	Required/Optional	Remarks
1.	outBizId	String	26	M	Unique registration identifier assigned by client

Response Parameters

No.	Parameter	Type	Length	Remarks
1.	outBizId	String	26	Unique registration identifier assigned by client
2.	acctId	String	8	Unique 8-digit user account identifier assigned by SUNRATE
3.	registerName	String	60	Name of registrant
4.	registerEname	String	255	Name of registrant in English
5.	registerMobile	String	30	Mobile number used for registration
6.	zoneNumber	String	6	International dialing code of the mobile number
7.	registerType	String	1	Possible values: 0, 1 1：Individual 2：Business
8.	identityType	String	1	Possible values: 1, 2 1：Legal person 2：Authorised representative
9.	remark	String	255
10.	status	String	1	Possible values: 0, 1 0：KYC is being reviewed 1：KYC is complete, account has been verified
11.	companyInfo	JSON
11.1.	companyName	String	varchar(128)	Business name
11.2.	companyNameEn	String	varchar(128)	Business name in English
11.3.	registerCountryCode	String	2	Country code of the country where business is registered
11.4.	openAddress	String	varchar(255)	Business address
11.5.	openAddressEn	String	varchar(255)	Business address in English
12.	legalInfoList	Array
12.1.	legalUserAlias	Array		Alias of legal person
12.2.	legalCarType	String	1	Possible values: 1, 2 1: National ID 2: Passport
13.	shareHolderInfoList	Array
13.1.	shareholderAlias	Array		Alias of shareholder
13.2.	shareholderCardType	String	1	Possible values: 1, 2 1: National ID 2: Passport
14	individualInfo	JSON		C
14.1	cardType	String	1	M
14.2	name	String	128	M
14.3	ename	String	128	O
14.4	orgCode	String	30	M
14.5	sex	String	1	M
14.6	occupation	String	20	M
14.7	nationality	String	2	M
14.8	countryCode	String	2	M
14.9	birthDate	Date		M
14.10	province	String	128	M
14.11	city	String	128	M
14.12	district	String	128	O
14.13	address	String	255	M
14.14	addressEn	String	255	M
14.15	frontFilePath	String	255	M
14.16	behindFilePath	String	255	O
14.17	handFilePath	String	255	C
14.18	attachFilePath	String	255	C

Request Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

No.	Parameter	Type	Length	Required/Optional	Remarks
1.	acctId	String	8	M	Unique 8-digit user account identifier assigned by SUNRATE
2.	eventType	String	10	M	Type of event, possible values: REG_INFO_EXPIRE ACCT_STATUS_UPDATE REG_INFO_EXPIRE: KYC expiration ACCT_STATUS_UPDATE: account status update
3.	changeStatus	String	10	M	Type of change, possible values: EXPIRED FROZEN NORMAL
4.	acctType	String	1	M	1: Individual 2: Business
5.	reginfoExpire	JSON		C	Mandatory when the event type is KYC expiration
5.1	expireinfoType	String	5	C	Type of expired information, possible values: ACCT, RELATE ACCT: Document of the onboarding entity RELATE: Document of the legal person / shareholder
5.2	cardNumber	String	26	M	Number of expired document
5.3	cardType	String	1	C	1: National ID 2: Passport
5.4	userType	String	10	C	LEGAL: legal person SHAREHOLDER: shareholder

**
Response Parameters**
None

Request Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

No.	Parameter	Type	Length	Required/Optional	Remarks
1.	registerType	String	1	M	Used to specify the type of onboarding entity 1：Individual 2：Business
2.	companyInfo	JSON		C	Mandatory when type of onboarding entity is business
2.1.	cardNumber	String	30	M	Business registration number
2.2.	registerFilePath	String	255	M	File path to business registration document Supported file types: PNG, JPG, JPEG, BMP
2.3.	registerExtraFilePath	String	255	O	File path to specific supplementary document Supported file types: PNG, JPG, JPEG, BMP
3	individualInfo	JSON		C	Mandatory when type of onboarding entity is individual
3.1	cardNumber	String	128	M	ID number
3.2	cardType	String	1	M	1: National ID 2: Passport
3.3.	frontFilePath	String	255	M	File path to the front page of national ID or passport Supported file types: PNG, JPG, JPEG, BMP
3.4.	behindFilePath	String	255	M	File path to the back page of national ID Supported file types: PNG, JPG, JPEG, BMP

Response Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

No.	Parameter	Type	Length	Remarks
1.	acctId	String	8	Unique 8-digit user account identifier assigned by SUNRATE

Request Parameters

No.	Parameter	Type	Length	Required/Optional	Remarks
1.	registerType	String	1	M	Used to specify the type of onboarding entity 1：Individual 2：Business
2.	legalInfo	JSON		C
2.1.	cardNumber	String	128	M	ID number of legal person
2.2.	legalCarType	String	1	M	1: National ID 2: Passport
2.3.	legalFrontFilePath	String	255	O	File path to the front page of national ID or passport Supported file types: PNG, JPG, JPEG, BMP
2.4.	legalBehindFilePath	String	255	O	File path to the back page of national ID Supported file types: PNG, JPG, JPEG, BMP
3	shareholderInfo	JSON		C
3.1	cardNumber	String	128	M	ID number of shareholder
3.2	cardType	String	1	M	1: National ID 2: Passport
3.3.	shareholderFrontFilePath	String	255	M	File path to the front page of national ID or passport Supported file types: PNG, JPG, JPEG, BMP
3.4.	shareholderBehindFilePath	String	255	M	File path to the back page of national ID Supported file types: PNG, JPG, JPEG, BMP

Response Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

No.	Parameter	Type	Length	Remarks
1.	acctId	String	8	Unique 8-digit user account identifier assigned by SUNRATE

Request Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

No.	Parameter	Type	Length	Required/Optional	Remarks
1.	acctId	String	8	M	Unique 8-digit user account identifier assigned by SUNRATE
2.	registerType	String	1	M	1: Individual 2: Business
3.	expireinfoType	String	5	C	Type of expired information, possible values: ACCT, RELATE ACCT: Document of the onboarding entity RELATE: Document of the legal person / shareholder
4.	cardNumber	String	26	M	Number of expired document
5.	cardType	String	1	C	1: National ID 2: Passport
6.	userType	String	10	C	LEGAL: legal person SHAREHOLDER: shareholder
7.	status	String	10	M	Review result, possible values: PASS, RETURNED
8.	remark	String	255	C	Note from SUNRATE Compliance when updated document has failed review

**
Response Parameters**
None

This suite of APIs let you create a user account within SUNRATE and complete account verification to unlock the payment services SUNRATE provides.

\n","_postman_id":"4f31a3ab-d4ca-43f1-a94c-1aa33f089c57","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-API-Key"},{"key":"value","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"7245cd17-b114-4f58-8936-dafbbfaf4ccc","id":"7245cd17-b114-4f58-8936-dafbbfaf4ccc","name":"Full-Stack Payments","type":"collection"}}},{"name":"💰 Collections","item":[{"name":"Receive fund arrival notice","id":"08606f14-f2b6-4254-9ba2-2a7a8b1c2e42","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"url":"Provided by client","description":"

Request Parameteres

No.	Parameter	Type	Length	Required/Optional	Remarks
1.	transinNoticeId	String	10	M	Unique inward transaction identifier assigned by SUNRATE
2.	orgCode	String	18	M	Business registration number of client
3.	acctId	String	8	M	Unique 8-digit user account identifier assigned by client
4.	bankCardNo	String	50	M	Virtual account number
5.	sendAccountName	String	50	M	Sender name
6.	transinCur	String	3	M	Currency of fund received
7.	transinAmt	Number	15,2	M	Amount of fund received
8.	availableAmt	Number	15,2	M	New available amount on the user account, equal to the amount of fund received
9.	sysTxnDate	String	10	M	Date when fund is received
10.	noticeStat	String	1	M	Possible values: 2, 3 2: Supporting documents are required for the funds to be credited into the user account 3: Funds have been credited to the user account since the sender has been verified and whitelisted
11.	remark	String	100	O

Response Parameters

None

Request Parameteres

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

No.	Parameter	Type	Length	Required/Optional	Remarks
1.	transinNoticeId	String	10	M	Unique inward transaction identifier assigned by SUNRATE
2.	fileId	String	255	M	File ID obtained from Get file ID endpoint

Response Parameters

None

Request Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

No.	Parameter	Type	Length	Required/Optional	Remarks
1.	transinNoticeId	String	10	M	Unique inward transaction identifier assigned by SUNRATE
2.	orgCode	String	18	M	Business registration number of client
3.	acctId	String	8	M	Unique 8-digit user account identifier assigned by SUNRATE
4.	noticeStat	String	1	M	Possible values: 2, 3 2: Supporting documents are required for the funds to be credited into the user account 3: Funds have been credited to the user account
5.	transinFileStatus	String	1	M	Possible values: 1, 2 1: Supporting documents are sufficient, noticeStat will be 3 when transinFileStatus is 1 2: Supporting documents are insufficient, noticeStat will be 2 when transinFileStatus is 2
6.	transinFileRemark	String	255	M	transinFileRemark will be compliance review opinion when transinFileStatus is 2

Response Parameters
None

Request Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

No.	Parameter	Type	Length	Required/Optional	Remarks
1.	transinNoticeId	String	10	M	Unique inward transaction identifier assigned by SUNRATE 1: Supporting documents are sufficient, noticeStat will be 3 when transinFileStatus is 1 2: Supporting documents are insufficient, noticeStat will be 2 when transinFileStatus is 2
6.	transinFileRemark	String	255	M	transinFileRemark will be compliance review opinion when transinFileStatus is 2

Response Parameters

No.	Parameter	Type	Length	Required/Optional	Remarks
1.	acctId	String	8	M	Unique 8-digit user account identifier assigned by SUNRATE
2.	transinNoticeId	String	10	M	Unique inward transaction identifier assigned by SUNRATE
3.	bankCardNo	String	50	M	Virtual account number
4.	sendAccountName	String	50	M	Sender name
5.	transinCur	String	3	M	Currency of fund received
6.	transinAmt	Number	15,2	M	Amount of fund received
7.	availableAmt	Number	15,2	M	New available amount on the user account, equal to the amount of fund received
8.	feeAmt	Number	15,2	O	Amount of processing fees charged by SUNRATE for the inward transaction
9.	transinDate	String	10	M	Date when fund is received
10.	transinFileStatus	String	1	M	Used to specify the status of supporting documents. Possible values: 0, 1, 2, 3, 9 0: Supporting documents have been submitted 1: Supporting documents are sufficient for the funds to be credited into the user account 2: Supporting documents are insufficient and have to be supplemented 3: Supporting documents are under review 9: Supporting documents have not been provided
11.	status	String	1	M	Used to specify the status of the inward transaction. Possible values: 0, 1, 2, 3, 9 0：Inward transaction has been reported 1：Inward transaction is under review 2：Inward transaction has been reviewed 3：Inward transaction has been approved, fund has been credited into the user account 9：Inward transaction is on-hold, additional supporting documents are required
12.	remark	String	100	O

Request Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

No.	Parameter	Type	Length	Required/Optional	Remarks
1.	startDate	Date		M	Date after which fund is received
2.	endDate	Date		M	Date before which fund is received
3.	pageNum	Number	500	M	Count of pages, default to 1 if not provided
4.	pageSize	Number	100	M	Count of records per page. Ranges from 1 to 100. Default to 20 if not provided
5.	cur	String	3	C	Currency code for currency of fund received

Response Parameters

No.	Parameter	Type	Length	Required/Optional	Remarks
1.	acctId	String	8	M	Unique 8-digit user account identifier assigned by SUNRATE
2.	totalRecordNum	Number	-	M	Count of total records queried
3.	currentPageNum	Number	500	M	Page number of current page
4.	currentPageSize	Number	100	M	Count of records of current page
5.	list	Array		M
5.1.	transinNoticeId	String	10	M	Unique inward transaction identifier assigned by SUNRATE
5.2.	bankCardNo	String	50	M	Virtual account number
5.3.	sendAccountName	String	50	M	Sender name
5.4.	transinCur	String	3	M	Currency of fund received
5.5.	transinAmt	Number	15,2	M	Amount of fund received
5.6.	availableAmt	Number	15,2	M	New available amount on the user account, equal to the amount of fund received
5.7.	feeAmt	Number	15,2	O	Amount of processing fees charged by SUNRAET for the inward transaction
5.8.	transinDate	String	10	M	Date when fund is received
5.9.	transinFileStatus	String	1	M	Used to specify the status of supporting documents. Possible values: 0, 1, 2, 3, 9 0: Submitted 1: Passed 2: Rejected 3: Under review 9: Not provided
5.10.	status	String	1	M	Used to specify the status of the inward transaction. Possible values: 0, 1, 2, 3, 9 0：Pending 1：Under review 2：Passed 3：Approved 9：Rejected
5.11.	remark	String	100	O

This suite of APIs let you receive real-time notification for inward transactions sent into virtual accounts, and retrieve transaction details.

\n","_postman_id":"2af50a0b-c122-4b9c-97a9-233a7a0432f8","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-API-Key"},{"key":"value","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"7245cd17-b114-4f58-8936-dafbbfaf4ccc","id":"7245cd17-b114-4f58-8936-dafbbfaf4ccc","name":"Full-Stack Payments","type":"collection"}}},{"name":"💲Payouts","item":[{"name":"📥Payees","item":[{"name":"Create payee","id":"2f1614e7-d399-4bea-b925-0487cd81fbca","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"url":"/openapi/v3/beneficiary/create/","description":"

Request Parameters

No.	Parameter	Type	Length	Required/Optional	Remarks
1.	countryCode	String	2	M	Country code for country where payee’s bank is located
2.	bankName	String	128	M	Full name of payee’s bank, include branch when possible
3.	routeType	String	1	M	Used to specify the necessary payee’s account information for a payment to be delivered to payee 1: ABA 2: IBAN 3: SWIFT Code
4.	aba	String	9	C	9-digit ACH routing number, mandatory when routeType is 1
5.	iban	String	34	C	IBAN, mandatory when routeType is 2
6.	swiftcode	String	8、11	C	SWIFT Code, mandatory when routeType is 3
7.	beneficiaryName	String	128	M	Payee’s full bank account name
8.	beneficiaryAcctNo	String	60	M	Payee's full bank account number, equal to IBAN when routeType is 2
9.	beneficiaryCountryCode	String	2	M	Country code for country where payee is registered
10.	cur	String	3	M	Currency code for currency of payee’s bank account
11.	beneficiaryType	String	1	M	Used to specify type of payee 0：Own bank accounts 1：Third-party bank accounts
12.	beneficiaryEntityType	String	1	O	Used to specify type of payee’s bank account 1：Business bank account
13.	beneficiaryAddr	String	55	M	Payee’s business address or residential address
14.	intermediarySwiftBic	String	8、11	O	Intermediary bank SWIFT Code
15.	remark	String	255	O

Response Parameters

No.	Parameter	Type	Length	Remarks
1.	beneficiaryId	String	10	Unique payee identifier assigned by SUNRATE
2.	acctId	String	8	Unique 8-digit user account identifier assigned by SUNRATE
3.	beneficiaryStatus	String	1	Status of payee, only when beneficiaryStatus is 2, can a payout to payee be created. Possible values: 0, 1, 2 0：Payee has been submitted and will be reviewed 1：Payee has been approved 2：Payee has been denied, additional information might be required
4.	countryCode	String	2	Country code for country where payee’s bank is located
5.	bankName	String	128	Full name of payee’s bank
6.	routeType	String	1	Used to specify the necessary payee’s account information for a payment to be delivered to payee 1: ABA 2: IBAN 3: SWIFT Code
7.	aba	String	9	9-digit ACH routing number, mandatory when routeType is 1
8.	iban	String	34	IBAN, mandatory when routeType is 2
9.	swiftcode	String	8、11	SWIFT Code, mandatory when routeType is 3
10.	beneficiaryName	String	128	Payee’s full bank account name
11.	beneficiaryAcctNo	String	60	Payee's full bank account number, equal to IBAN when routeType is 2
12.	beneficiaryCountryCode	String	2	Country code for country where payee is registered
13.	cur	String	3	Currency code for currency of payee’s bank account
14.	beneficiaryType	String	1	Used to specify type of payee 0：Own bank accounts 1：Third-party bank accounts
15.	beneficiaryEntityType	String	1	Used to specify type of payee’s bank account 1：Business bank account
16.	beneficiaryAddr	String	55	Payee’s business address or residential address
17.	intermediarySwiftBic	String	8、11	Intermediary bank SWIFT Code
18.	remark	String	255

Request Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

No.	Parameter	Type	Length	Required/Optional	Remarks
1.	beneficiaryId	String	10	M	Unique payee identifier assigned by SUNRATE
2.	orgCode	String	18	M	Business registration number of client
3.	acctId	String	8	M	Unique 8-digit user account identifier assigned by SUNRATE
4.	beneficiaryStatus	String	1	M	Status of payee. Possible values: 1, 2 1：Payee has been approved 2：Payee has been denied, additional information might be required
5.	remark	String	100	C	Reason for denial when beneficiaryStatus is 2

Response Parameters

None

Request Parameters

No.	Parameter	Type	Length	Required/Optional	Remarks
1.	beneficiaryId	String	char（10）	M	Unique payee identifier assigned by SUNRATE
2.	countryCode	String	2	M	Country code for country where payee’s bank is located
3.	bankName	String	128	M	Payee’s bank name
4.	routeType	String	1	M	Used to specify the necessary payee’s account information for a payment to be delivered to payee 1: ABA 2: IBAN 3: SWIFT Code
5.	aba	String	9	C	9-digit ACH routing number, mandatory when routeType is 1
6.	iban	String	34	C	IBAN, mandatory when routeType is 2
7.	swiftcode	String	8、11	C	SWIFT code, mandatory when routeType is 3
8.	beneficiaryName	String	128	M	Payee’s full bank account name
9.	beneficiaryAcctNo	String	60	M	Payee’s bank account number, equal to IBAN when routeType is 2
10.	beneficiaryCountryCode	String	2	M	Country code for country where payee is registered
11.	cur	String	3	M	Currency code for currency of payee’s bank account
12.	beneficiaryType	String	1	M	Used to specify type of payee 0：Own bank accounts 1：Third-party bank accounts
13.	beneficiaryEntityType	String	1	O	Used to specify type of payee’s bank account 1：Business bank account
14.	beneficiaryAddr	String	55	M	Payee’s business address or residential address
15.	intermediarySwiftBic	String	8、11	O	Intermediary bank SWIFT Code
16.	remark	String	255	O

Response Parameters

No.	Parameter	Type	Length	Remarks
1.	beneficiaryId	String	10	Unique payee identifier assigned by SUNRATE
2.	acctId	String	8	Unique 8-digit user account identifier assigned by SUNRATE
3.	beneficiaryStatus	String	1	Status of payee. Possible values: 0, 1, 2 0: Payee has been submitted, and will be reviewed 1：Payee has been approved 2：Payee has been denied, additional information might be required
4.	countryCode	String	2	Country code for country where payee’s bank is located
5.	bankName	String	128	Payee’s bank name
6.	routeType	String	1	Used to specify the necessary payee’s account information for a payment to be delivered to payee 1: ABA 2: IBAN 3: SWIFT Code
7.	aba	String	9	9-digit ACH routing number
8.	iban	String	34	IBAN
9.	swiftcode	String	8、11	SWIFT Code
10.	beneficiaryName	String	128	Payee's full bank account name
11.	beneficiaryAcctNo	String	60	Payee’s bank account number
12.	beneficiaryCountryCode	String	2	Country code for country where payee is registered
13.	cur	String	3	Currency code for currency of payee’s bank account
14.	beneficiaryType	String	1	Used to specify type of payee 0：Own bank accounts 1：Third-party bank accounts
15.	beneficiaryEntityType	String	1	Used to specify type of payee’s bank account 1：Business bank account
16.	beneficiaryAddr	String	55	Payee’s business address or residential address
17.	intermediarySwiftBic	String	8、11	Intermediary bank Swift Code
18.	remark	String	255

Request Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

No.	Parameter	Type	Length	Required/Optional	Remarks
1.	beneficiaryId	String	10	M	Unique payee identifier assigned by SUNRATE

Response Parameters

No.	Parameter	Type	Length	Remarks
1.	beneficiaryId	String	char（10）	Unique payee identifier assigned by SUNRATE
2.	beneficiaryStatus	String	1	Status of payee, only when beneficiaryStatus is 2, can a payout to payee be created. Possible values: 0, 1, 2 0：Payee has been submitted and will be reviewed 1：Payee has been approved 2：Payee has been denied, additional information might be required
3.	orgCode	String	18	Business registration number of client
4.	acctId	String	8	Unique 8-digit user account identifier assigned by SUNRATE
5.	countryCode	String	2	Country code for country where payee’s bank is located
6.	bankName	String	varchar（128）	Full name of payee's bank
7.	routeType	String	1	Used to specify the necessary payee’s account information for a payment to be delivered to payee 1: ABA 2: IBAN 3: SWIFT Code
8.	aba	String	9	9-digit ACH routing number
9.	iban	String	varchar （34）	IBAN
10.	swiftcode	String	8、11	SWIFT code
11.	beneficiaryName	String	varchar（128）	Payee’s full bank account name
12.	beneficiaryAcctNo	String	60	Payee's full bank account number
13.	cur	String	3	Currency code for currency of payee’s bank account
14.	beneficiaryAddr	String	varchar（255）	Payee’s business address or residential address
15.	remark	String	varchar（255）

Request Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

No.	Parameter	Type	Length	Required/Optional	Remarks
1.	pageNum	Number	500	M	Count of pages, default to 1 if not provided
2.	pageSize	Number	100	M	Count of records per page. Ranges from 1 to 100. Default to 20 if not provided

Response Parameters

No.	Parameter	Type	Length	Remarks
1.	acctId	String	8	Unique 8-digit user account identifier assigned by SUNRATE
2.	totalRecordNum	Number	-	Count of total records queried
3.	currentPageNum	Number	500	Page number of current page
4.	currentPageSize	Number	100	Count of records of current page
5.	list	Array
5.1.	beneficiaryId	String	10	Unique payee identifier assigned by SUNRATE
5.2.	beneficiaryStatus	String	1	Status of payee, only when beneficiaryStatus is 2, can a payout to payee be created. Possible values: 0, 1, 2 0：Payee has been submitted and will be reviewed 1：Payee has been approved 2：Payee has been denied, additional information might be required
5.3.	countryCode	String	2	Country code for country where payee’s bank is located
5.4.	routeType	String	1	Used to specify the necessary payee’s account information for a payment to be delivered to payee 1: ABA 2: IBAN 3: SWIFT Code
5.5.	aba	String	9	9-digit ACH routing number
5.6.	iban	String	34	IBAN
5.7.	swiftcode	String	11	SWIFT code
5.8.	beneficiaryName	String	128	Payee’s bank account name
5.9.	beneficiaryAcctNo	String	60	Payee's full bank account number
5.10.	beneficiaryAddr	String	255	Payee’s business address or residential address
5.11.	cur	String	3	Currency code for currency of payee’s bank account
5.12.	beneficiaryRejectRemark	String	255	Reason for payee denial when beneficiaryStatus is 2
5.13.	intermediarySwiftBic	String	11	Intermediary bank for payee’s bank
5.14.	beneficiaryType	String	1	Used to specify type of payee 0：Payee’s bank account holder is client themselves 1：Payee’s bank account holder is not client themselves

Request Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

No.	Parameter	Type	Length	Required/Optional	Remarks
1.	queryNo	String	26	M	Unique query identifier assigned by client
2.	buyCur	String	3	M	Currency to be purchased
3.	sellCur	String	3	M	Currency to be sold
4.	txnMode	String	1	M	Used to specify currency for txnAmt 0：txnAmt is based on currency to be purchased 1：txnAmt is based on currency to be sold
5.	txnAmt	Number	15,2	M	Amount to be purchased when txnMode is 0, amount to be sold when txnMode is 1
6.	tradeType	String	1	C	Used to specify type of transaction, must be 0 if beneficiaryType is 0, must be 1 if beneficiaryType is 1, default to 0 if not provided 0：Payout to third-party payee 1：FX and payout to client’s own account
7.	feeType	String	3	C	Used to specify the bearer of bank charges, default to SHA if not provided OUR: bank charges will be borne by client SHA: bank charges will be borne by client and payee

Response Parameters

No.	Parameter	Type	Length	Required/Optional	Remarks
1.	queryNo	String	26	M	Unique query identifier assigned by client
2.	orgCode	String	9	M	Business registration number of client
3.	acctId	String	8	M	Unique 8-digit user account identifier assigned by SUNRATE
4.	buyCur	String	3	M	Currency to be purchased
5.	buyAmt	Number	15,2	M	Amount to be purchased
6.	sellCur	String	3	M	Currency to be sold
7.	sellAmt	Number	15,2	M	Amount to be sold
8.	feeCur	String	3	M	Currency of processing fee
9.	feeAmt	Number	15,2	M	Amount of processing fee
10.	payAmt	Number	15,2	M	Total amount to be deducted from user account
11.	txnMode	String	1	M	Possible values: 0,1 0：txnAmt is based on currency to be sent 1：txnAmt is based on currency to be sold
12.	queryRate	Number	9,4	M	Exchange rate for the currency pair
13.	tradeType	String	1	C	Possible values: 0, 1 0：Payout to third-party recipient 1：FX and payout to client’s own account

Request Parameters

No.	Parameter	Type	Length	Required/Optional	Remarks
1.	lockNo	String	26	M	Unique payout identifier assigned by client
2.	queryNo	String	26	M	Unique query identifier assigned by client
3.	buyCur	String	3	M	Currency to be purchased
4.	buyAmt	Number	15,2	M	Amount to be purchased
5.	sellCur	String	3	M	Currency to be sold
6.	sellAmt	Number	15,2	M	Amount to be sold
7.	feeAmt	Number	15,2	M	Amount of processing fee
8.	payAmt	Number	15,2	M	Total amount to be deducted from user account
9.	txnMode	String	1	M	Used to specify the currency for txnAmt 0：txnAmt is based on currency to be purchased 1：txnAmt is based on currency to be sold
10.	queryRate	Number	9,4	M	Exchange rate for the currency pair, obtained from Query exchange rate
11.	valueDate	String	10	C	Format: YYYY-MM-DD
12.	beneficiaryId	String	10	M	Unique payee identifier assigned by SUNRATE
13.	oboId	String	20	C	Unique obo identifier assigned by SUNRATE, contact SUNRATE for details
14.	remark	String	Varchar(100)	O	Remittance information

Response Parameters

No.	Parameter	Type	Length	Required/Optional	Remarks
1.	txnNo	String	10	M	Unique payout identifier assigned by SUNRATE
2.	lockNo	String	26	M	Unique payout identifier assigned by client
3.	queryNo	String	26	M	Unique query identifier assigned by client
4.	orgCode	String	18	M	Business registration number of client
5.	acctId	String	8	M	Unique 8-digit user account identifier assigned by SUNRATE
6.	buyCur	String	3	M	Currency to be purchased
7.	sellCur	String	3	M	Currency to be sold
8.	buyAmt	Number	15,2	M	Amount to be purchased
9.	sellAmt	Number	15,2	M	Amount to be sold
10.	feeCur	String	3	M	Currency of processing fee
11.	feeAmt	Number	15,2	M	Amount of processing fee
12.	payAmt	Number	15,2	M	Total amount to be deducted from user account
13.	txnMode	String	1	M	Possible values: 0, 1 0：txnAmt is based on currency to be purchased 1：txnAmt is based on currency to be sold
14.	finRate	Number	9,4	M	Exchange rate for transaction
15.	oboId	String	20	C	Unique obo identifier assigned by SUNRATE
16.	remark	String	varchar(100)	M	Remittance information
17.	txnStatus	String	2	M	Used to specify status of payout, possible values: 02 02：Transaction has been confirmed by SUNRATE

Request Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

No.	Parameter	Type	Length	Required/Optional	Remarks
1.	lockNo	String	26	M	Unique payout identifier assigned by client
2.	buyCur	String	3	M	Currency to be purchased
3.	sellCur	String	3	M	Currency to be sold
4.	txnMode	String	1	M	Used to specify the currency for txnAmt 0：txnAmt is based on currency to be purchased 1：txnAmt is based on currency to be sold
5.	txnAmt	Number	15,2	M	Amount to be purchased when txnMode is 0, amount to be sold when txnMode is 1
6.	valueDate	String	10	C	Format: YYYY-MM-DD, only T, T+1, T+2 can be accepted
7.	beneficiaryId	String	10	M	Unique payee identifier assigned by SUNRATE
8.	remark	String	varchar(100)	O	Remittance information
9.	tradeType	String	1	C	Used to specify type of transaction, must be 0 if beneficiaryType is 0, must be 1 if beneficiaryType is 1, default to 0 if not provided 0：Payout to third-party payee 1：FX and payout to client’s own account
10.	feeType	String	3	C	Used to specify the bearer of bank charges, default to SHA if not provided OUR: bank charges will be borne by client SHA: bank charges will be shared by client and payee

Response Parameters

No.	Parameter	Type	Length	Required/Optional	Remarks
1.	txnNo	String	10	M	Unique payout identifier assigned by SUNRATE
2.	lockNo	String	26	M	Unique payout identifier assigned by client
3.	orgCode	String	9	M	Business registration number of client
4.	acctId	String	8	M	Unique 8-digit user account identifier assigned by SUNRATE
5.	buyCur	String	3	M	Currency to be purchased
6.	buyAmt	Number	15,2	M	Amount to be purchased
7.	sellCur	String	3	M	Currency to be purchased
8.	sellAmt	Number	15,2	M	Amount to be purchased
9.	txnMode	String	1	M	Possible values: 0, 1 0：txnAmt is based on currency to be purchased 1：txnAmt is based on currency to be sold
10.	finRate	Number	9,4	M	Exchange rate for transaction
11.	feeCur	String	3	M	Currency of processing fee
12.	feeAmt	Number	15,2	M	Amount of processing fee
13.	payAmt	Number	15,2	M	Total mount to be deducted from user account
14.	remark	String	varchar(100)	O	Remittance information
15.	txnStatus	String	2	M	Used to specify status of payout, possible values: 02 02：Transaction has been confirmed by SUNRATE

Request Parameters

No.	Parameter	Type	Length	Required/Optional	Remarks
1.	payoutNoticeId	String	26	M	Unique payout notification identifier assigned by SUNRATE
2.	lockNo	String	26	M	Unique payout identifier assigned by client
3.	txnNo	String	10	M	Unique payout identifier assigned by SUNRATE
4.	orgCode	String	18	M	Business registration number of client
5.	acctId	String	8	M	Unique user account identifier assigned by SUNRATE
6.	beneficiaryId	String	varchar（20）	M	Unique payee identifier assigned by SUNRATE
7.	beneficiaryName	String	varchar（100）	M	Payee’s full bank account name
8.	beneficiaryAcctNo	String	varchar（30）	M	Payee’s full bank account number
9.	payCur	String	3	M	Currency to be sent
10.	payAmt	Number	15,2	M	Amount to be sent
11.	payStatus	String	1	M	Used to specify status of payer, possible values: 1, 9, 8 9：Payout has not been processed 8：Payout is being processed 1：Payout has been processed by SUNRATE
12.	remark	String	100	O

Response Parameters

None

Request Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

No.	Parameter	Type	Length	Required/Optional	Remarks
1.	lockNo	String	26	M	Unique payout identifier assigned by client
2.	txnNo	String	10	M	Unique payout identifier assigned by SUNRATE
3.	acctId	String	8	M	Unique user account identifier assigned by SUNRATE
4.	txnStatus	String	2	M	02, 03: Transaction has been confirmed by SUNRATE
5.	fileStatus	String	1	M	Possible values: 2, 3 2: Supporting document needs further supplements 3: Supporting document is rejected, payout cannot be processed
6.	remark	String	256	C	Review opinion provided by SUNRATE Compliance

Response Parameters

None

Request Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

No.	Parameter	Type	Length	Required/Optional	Remarks
1.	lockNo	String	26	M	Unique payout identifier assigned by client
2.	verifyNoList	Array	26	M	List of verifyNo obtained from Get supporting document ID endpoint

Response Parameters

None

Request Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

No.	Parameter	Type	Length	Required/Optional	Remarks
1.	lockNo	String	26	M	Unique payout identifier assigned by client

Respoonse Parameters

No.	Parameter	Type	Length	Required/Optional	Remarks
1.	txnNo	String	10	M	Unique payout identifier assigned by SUNRATE
2.	lockNo	String	26	M	Unique payout identifier assigned by client
3.	buyCur	String	3	M	Currency to be purchased
4.	sellCur	String	3	M	Currency to be sold
5.	buyAmt	Number	15,2	M	Amount to be purchased
6.	sellAmt	Number	15,2	M	Amount to be sold
7.	feeAmt	Number	15,2	M	Amount of processing fee
8.	payAmt	Number	15,2	M	Total amount to be deducted from user account
9.	txnMode	String	1	M	Possible values: 0, 1 0：txnAmt is based on currency to be purchased 1：txnAmt is based on currency to be sold
10.	finRate	Number	9,4	M	Exchange rate for transaction
11.	txnDate	String	10	M	Date set for transaction, format: YYYY-MM-DD
12.	remark	String	varchar(100)	O	Remittance information
13.	txnStatus	String	2	M	Used to specify status of payout, possible values: 02, 04, 05, 09, 20 02：Transaction has been confirmed by SUNRATE 04, 05： Transaction is being processed 09：Payout has been processed by SUNRATE 20：Transaction has been canceled by client

Request Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

No.	Parameter	Type	Length	Required/Optional	Remarks
1.	startDate	Date		M	Date after which payout is created
2.	endDate	Date		M	Date before which payout is created
3.	pageNum	Number	500	M	Count of pages, default to 1 if not provided
4.	pageSize	Number	100	M	Count of records per page. Ranges from 1 to 100. Default to 20 if not provided

Respoonse Parameters

No.	Parameter	Type	Length	Remarks
1.	acctId	String	8	Unique 8-digit user account identifier assigned by SUNRATE
2.	totalRecordNum	Number	-	Count of total records queried
3.	currentPageNum	Number	500	Page number of current page
4.	currentPageSize	Number	100	Count of records of current page
5.	list	Array
5.1.	txnNo	String	10	Unique payout identifier assigned by SUNRATE
5.2.	lockNo	String	26	Unique payout identifier assigned by client
5.3.	buyCur	String	3	Currency to be purchased
5.4.	buyAmt	Price	20	Amount to be purchased
5.5.	sellCur	String	3	Currency to be sold
5.6.	sellAmt	Price	20	Amount to be sold
5.7.	feeCur	String	3	Currency of processing fee
5.8.	feeAmt	Price	20	Amount of processing fee
5.9.	payAmt	Price	20	Amount to be sent
5.10.	txnMode	String	1	Possible values: 0, 1 0：txnAmt is based on currency to be purchased 1：txnAmt is based on currency to be sold
5.11.	finRate	Price	20	Exchange rate for transaction
5.12.	txnStatus	String	2	Used to specify status of payout, possible values: 03, 04, 05, 09, 20 03：User account has sufficient balance for payout 04, 05：Transaction is being processed 09：Payout has been processed by SUNRATE 20：Transaction has been canceled by client
5.13.	oboId	String	21	Unique obo identifier assigned by SUNRATE
5.14.	oboName	String	128	Obo name
5.15.	oboCountryCode	String	2	Country code for country where obo is registered
5.16.	oboAddress	String	70	Business address of obo
5.17.	beneficiaryId	String	10	Unique payee identifier assigned by SUNRATE

Request Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

No.	Parameter	Type	Length	Required/Optional	Remarks
1.	txnNo	String	10	M	Unique payout identifier assigned by SUNRATE
2.	lockNo	String	26	M	Unique payout identifier assigned by client
3.	voucherType	String	1	M	Used to specify type of confirmation, must be 1
4.	subType	String	1	M	Used to specify use of confirmation, must be 1

Response Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

No.	Parameter	Type	Length	Required/Optional	Remarks
1.	orgCode	String	18	M	Business registration number of client
2.	acctId	String	8	M	Unique 8-digit user account identifier assigned by SUNRATE
3.	lockNo	String	26	M	Unique payout identifier assigned by SUNRATE
4.	txnNo	String	10	M	Unique payout identifier assigned by SUNRATE
5.	filePath	String	128	M	Path for document

This suite of APIs let you initiate payments to bank accounts utilising SUNRATE’s
global payment network, and obtain real-time transaction status.

\n","_postman_id":"17597292-3701-4324-89b4-e3e6ed4fe4e8","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-API-Key"},{"key":"value","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"7245cd17-b114-4f58-8936-dafbbfaf4ccc","id":"7245cd17-b114-4f58-8936-dafbbfaf4ccc","name":"Full-Stack Payments","type":"collection"}}},{"name":"➡️ Book Transfers","item":[{"name":"Create transfer","id":"b713a677-7eb8-46c8-b890-41e2fca9f9f3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"url":"/openapi/v3/transfer/create/","description":"

Request Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

No.	Parameter	Type	Length	Required/Optional	Remarks
1.	outBizId	String	26	M	Unique transfer identifier assigned by client
2.	beneAcctId	String	8	M	Unique 8-digit user account identifier of recipient’s user account
3.	beneAcctName	String	128	M	Recipient’s user account name
4.	txnCur	String	3	M	Currency of transfer
5.	txnAmt	Number	15,2	M	Transfer amount
6.	cause	String	1	M	Used to specify purpose of payment 0：Payment to supplier 1：Payment to affiliate
7.	remark	String	128	O	Message to recipient

Response Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

No.	Parameter	Type	Length	Remarks
1.	id	String	21	Unique transfer identifier assigned by SUNRATE
2.	txnAmt	Number	15,2	Transfer amount
3.	txnRealAmt	Number	15,2	Amount to be received
4.	txnFee	Number	15,2	Processing fee amount borne by payer
5.	txnStatus	String	1	Used to specify transfer status. Possible values: 0, 1, 2, 3, 4, 5 0：Transfer has been submitted 1：Transfer has been approved 2：Transfer has been completed 3：Transfer has been canceled 4：Transfer has been denied 5：Transfer is being processed

Request Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

No.	Parameter	Type	Length	Required/Optional	Remarks
1.	outBizId	String	26	M	Unique transfer identifier assigned by client

Response Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

No.	Parameter	Type	Length	Remarks
1.	payId	String	21	Unique transfer identifier assigned by SUNRATE
2.	outBizId	String	26	Unique transfer identifier assigned by client
3.	acctId	String	8	Client’s unique 8-digit user account identifier
4.	acctName	String	128	Client’s user account name
5.	beneAcctId	String	8	Recipient’s unique 8-digit user account identifier
6.	beneAcctName	String	128	Recipient’s user account name
7.	txnCur	String	3	Currency of transfer
8.	txnAmt	Number	15,2	Transfer amount
9.	txnRealAmt	Number	15,2	Amount to be received
10.	txnFee	Number	15,2	Processing fee amount borne by payer
11.	remark	String	128	Message to recipient
12.	txnStatus	String	1	Used to specify transfer status. Possible values: 0, 1, 2, 3, 4, 5 0：Transfer has been submitted 1：Transfer has been approved 2：Transfer has been completed 3：Transfer has been canceled 4：Transfer has been denied 5：Transfer is being processed

Request Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

No.	Parameter	Type	Length	Required/Optional	Remarks
1.	beneAcctId	String	8	O	Recipient’s unique 8-digit user account identifier
2.	start	Number		M	Start position of records queried, equal to (page number to query-1) * limit
3.	limit	Number		M	Count of records per page. Ranges from 1 to 100. Default to 20 if not provided
4.	startDate	Date	10	O	Date after which transfer is created
5.	endDate	Date	10	O	Date before which transfer is created

Response Parameters

No.	Parameter	Type	Length	Remarks
1.	payId	String	21	Unique transfer identifier assigned by SUNRATE
2.	outBizId	String	26	Unique transfer identifier assigned by client
3.	acctId	String	8	Client’s unique 8-digit user account identifier
4.	acctName	String	128	Client’s user account name
5.	beneAcctId	String	8	Recipient’s unique 8-digit user account identifier
6.	beneAcctName	String	128	Recipient’s user account name
7.	txnCur	String	3	Currency of transfer
8.	txnAmt	Number	15,2	Transfer amount
9.	txnRealAmt	Number	15,2	Amount to be received
10.	txnFee	Number	15,2	Processing fee amount borne by payer
11.	remark	String	128	Message to recipient
12.	txnStatus	String	1	Used to specify transfer status. Possible values: 0, 1, 2, 3, 4, 5 0：Transfer has been submitted 1：Transfer has been approved 2：Transfer has been completed 3：Transfer has been canceled 4：Transfer has been denied 5：Transfer is being processed
13.	totalCounts	Number		Count of total transfers queried

Request Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

No.	Parameter	Type	Length	Required/Optional	Remarks
1.	payAcctId	String	8	O	Payer’s unique 8-digit user account identifier
2.	start	Number		M	Start position of records queried, equal to (page number to query-1) * limit
3.	limit	Number		M	Count of records per page. Ranges from 1 to 100. Default to 20 if not provided
4.	startDate	Date	10	O	Date after which transfer is created
5.	endDate	Date	10	O	Date before which transfer is created

Response Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

No.	Parameter	Type	Length	Required/Optional	Remarks
1.	payAcctId	String	8	O	Payer’s unique 8-digit user account identifier
2.	start	Number		M	Start position of records queried, equal to (page number to query-1) * limit
3.	limit	Number		M	Count of records per page. Ranges from 1 to 100. Default to 20 if not provided
4.	startDate	Date	10	O	Date after which transfer is created
5.	endDate	Date	10	O	Date before which transfer is created

This suite of APIs let you initiate like-for-like transfers to other SUNRATE user accounts and retrieve details of such transfers. Book transfers can only be created with sufficient balance on user account to cover the transfer.

\n","_postman_id":"ff5346a3-527b-4d23-aafa-8e148903760e","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-API-Key"},{"key":"value","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"7245cd17-b114-4f58-8936-dafbbfaf4ccc","id":"7245cd17-b114-4f58-8936-dafbbfaf4ccc","name":"Full-Stack Payments","type":"collection"}}},{"name":"💱 FX","item":[{"name":"Get quote","id":"19915f3a-be0b-43be-8a3d-07ffa0661b05","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"url":"/openapi/v3/fxquote/getSingleQuote","description":"

Request Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

No	Parameter	Type	Length	Required/Optional	Remarks
1.	buyCur	String	3	M	Currency to be purchased
2.	buyAmt	BigDecimal(15,2)		M	Amount to be purchased. Either buyAmt or sellAmt is mandatory
3.	sellCur	String	3	M	Currency to be sold
4.	sellAmt	BigDecimal(15,2)		M	Amount to be sold. Either buyAmt or sellAmt is mandatory

Response Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

No	Parameter	Type	Length	Remarks
1.	prdId	String	6	Currency pair based on market convention
2.	quoteId	String	22	Unique quote identifier assigned by SUNRATE

3.	custRate	String		Exchange rate for the currency pair
4.	buyCur	String	3	Currency to be purchased
5.	buyAmt	BigDecimal(15,2)		Amount to be purchased
6.	sellCur	String	3	Currency to be sold
7.	sellAmt	BigDecimal(15,2)		Amount to be sold
8.	validTill	String		Time when the quote is expired. Format: YYYY-MM-DDTHH:mm:ss.SSS

Request Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

No.	Parameter	Type	Length	Required/Optional	Remarks
1.	outRefNo	String	Varchar（64）	M	Unique transaction identifier assigned by client
2.	quoteId	String	22	M	Unique quote identifier assigned by SUNRATE obtained from Get a quote API

Response Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

No.	Parameter	Type	Length	Remarks
1.	txnId	String	22	Unique transaction identifier assigned by SUNRATE
2.	prdId	String	6	Currency pair based on market convention
3.	buyCur	String	3	Currency to be purchased
4.	buyAmt	BigDecimal(15,2)		Amount to be purchased
5.	sellCur	String	3	Currency to be sold
6.	sellAmt	BigDecimal(15,2)		Amount to be sold
7.	custRate	String		Exchange rate for the currency pair
8.	txnMode	String	1	Possible values: 0, 1 0：Transaction amount is based on the amount of purchasing currency 1：Transaction amount is based on the amount of selling currency
9.	valueDate	String		Format: YYYY-MM-DD
10.	txnDate	String		Format: YYYY-MM-DD

Request Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

No.	Parameter	Type	Length	Required/Optional	Remarks
1	outRefNo	String	Varchar（64）	M	Unique transaction identifier assigned by client

Response Parameters

Standard response, trade can be considered as settled with a successful response.

Request Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

No.	Parameter	Type	Length	Required/Optional	Remarks
1	outRefNo	String	Varchar（64）	M	Unique transaction identifier assigned by client

Response Parameters

No.	Parameter	Type	Length	Remarks
1.	txnId	String	22	Unique transaction identifier assigned by SUNRATE
2.	quoteId	String	22	Unique quote identifier assigned by SUNRATE
3.	prdId	String	3	Currency pair based on market convention
4.	buyCur	String	3	Currency to be purchased
5.	buyAmt	BigDecimal(15,2)		Amount to be purchased
6.	sellCur	String	3	Currency to be sold
7.	sellAmt	BigDecimal(15,2)		Amount to be sold
8.	custRate	BigDecimal(9,4)		Exchange rate for the currency pair
9.	txnDate	String		Format: YYYY-MM-DD
10.	valueDate	String		Format: YYYY-MM-DD
11.	txnMode	String	1	Possible values: 0, 1 0：Transaction amount is based on the amount of purchasing currency 1：Transaction amount is based on the amount of selling currency
12.	closeTime	String		Time of settlement or transaction cancellation. Format: YYYY-MM-DDTHH:mm:ss.SSS
13.	dealStatus	String	1	Possible values: 0, 1 1：Transaction has been settled 0：Transaction has been canceled
14.	settleOptStatus	String	1	Possible values: 0, 1 1：Transaction can be settled 0：Transaction cannot be settled

Request Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

No.	Parameter	Type	Length	Required/Optional	Remarks
1.	cur	String	3	M	Currency of the transfer
2.	amt	String	BigDecimal(15,2)	M	Amount of the transfer
3.	transType	String	3	M	Used to specify direction of the transfer 000：Transfer balance from user account into FX Management 001：Transfer balance from FX Management to user account
4.	outRefNo	String	Varchar（64）	M	Unique transfer identifier assigned by client

Response Parameters

Standard response, transfer can be considered as completed with a successful response.

Request Parameters

Standard request header

Response Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

No.	Parameter	Type	Length	Remarks
1.	list	Array
2.	cur	String	3	Currency with available balance
3.	avlBar	BigDecimal		Available balance of the currency

Request Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

No.	Parameter	Type	Length	Required/Optional	Remarks
1.	outRefNo	String	Varchar（64）	M	Unique transaction identifier assigned by client

Response Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

No.	Parameter	Type	Length	Remarks
1.	jnlId	String	22	Unique identifier for the fund movement
2.	acctId	String	8	Unique client identifier
3.	txnCur	String		Currency of the transaction
4.	txnAmt	BigDecimal(15,2)		Amount of the transaction
5.	initBal	BigDecimal(15,2)		Available balance before the transaction
6.	closeBal	BigDecimal(15,2)		Available balance after the transaction
7.	dcFlag	String	1	Used to indicate whether it’s a debit or credit to the account. Possible values: D, C
8.	txnType	String	3	Possible values: 000, 001, 002, 100, 101 000：Balance transferred into FX Management 001：Balance transferred out of FX Management 002：Transfer reversal 100：Currency purchased 101：Currency sold
9.	txnDesc	String
10.	outRefNo	String		Unique transaction identifier assigned by client
11.	txnDate	String		Format: YYYY-MM-DD

This suite of APIs let you book FX spot contracts within SUNRATE’s FX Management solutions and to manage the execution of the contracts.

\n","_postman_id":"589cb237-b55b-4eb1-823b-8df5a3adca1f","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-API-Key"},{"key":"value","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"7245cd17-b114-4f58-8936-dafbbfaf4ccc","id":"7245cd17-b114-4f58-8936-dafbbfaf4ccc","name":"Full-Stack Payments","type":"collection"}}},{"name":"💳 Commercial Cards","item":[{"name":"Account","item":[{"name":"Query card wallet balance","id":"91113915-bd05-4e07-9963-1ce71e8e60e9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"url":"/openapi/v1/acctBal/list","description":"

Request Parameters

None

Response Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

No.	Parameter Name	Details	Type	Max Length	Label	Remarks
1.	list	List of results	List		M	Refer to “list” for details

list

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

No.	Parameter Name	Details	Type	Max Length	Label	Remarks
1.	ccy	Currency	String	3	M
2.	acctBal	Account Balance	BigDecimal	15,2	M
3.	creditAmt	Credit Amount	BigDecimal	15,2	C
4.	pendingAmt	Pending Amount	BigDecimal	15,2	M	Funds that have been authorised but not settled.
5.	cardFrozenAmt	Frozen Amount on card	BigDecimal	15,2	C	Used in mode 3

Note: Available Balance = acctBal + creditAmt – pendingAmt – cardPendingAmt

Request Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

No.	Parameter Name	Details	Type	Max Length	Label	Remarks
1.	txnDate	Transaction Date	Date		M	yyyy-MM-dd Supports account records lookup by any specific date
2.	pageInfo	Page information	Object		M	{ \"current\": \"1\", \"size\": \"100\" }

Response Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

No.	Parameter Name	Details	****	Type	Max Length	Label	Remarks
1.	list	List of results		List		M	Refer to “list” for details
2	pageInfo	Page information	Object			M	{ \"current\": \"1\", \"size\": \"100\", \"total\": \"1000 }

list

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

No.	Parameter Name	Details	Type	Max Length	Label	Remarks
1.	jnlId	Record ID	String	21	M
2.	ccy	Currency	String	3	M
3.	txnAmt	Transaction Amount	BigDecimal	15,2	M
4.	preBal	Pre-transaction Balance	BigDecimal	15,2	M
5.	postBal	Post-transaction Balance	BigDecimal	15,2	M
6.	txnType	Transaction Type	String	2	M	00-Transfer-In 01-Transfer-Out 10-Card Fee 11-Txn Fee 12-Refund Fee 13-Auth Fee 14-Chargeback Fee 20-Settlement 21-Refund
7.	cardId	Card UID	String	19	C
8.	refNo	Reference Number	String	64	C	Chargeback ID
9.	createTime	Transaction Time	DateTime		M

Transfer funds from SUNRATE user account into SUNRATE card wallet

Request Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

No.	Parameter Name	Details	Type	Max Length	Label	Remarks
1.	outTradeNo	Merchant request ID	String	32	M	Internal reference number within requestor’s system. outTradeNo must be unique for each request.
2.	ccy	Currency	String	3	M
3.	amt	Amount	BigDecimal	15，2	M
4.	remark	Remark	String	255	O

Response Parameters

No.	Parameter Name	Details	Type	Max Length	Label	Remarks
1.	tioJnlId	Transaction ID	String	21	M	SUNRATE transaction ID
2.	txnCcy	Currency	String	3	M
3.	txnAmt	Amount	String	15，2	M
4.	txnType	Type	String	2	M	00 – Transfer in
5.	txnDesc	Description	String	128	M
6.	txnStatus	Status	String	1	M	9 - Processing, 0 - Failed, 1 - Successful
7.	txnRemark	Transaction Remark	String	255	O
8.	remark	Remark	String	255	O
9.	outTradeNo	Merchant request ID	String	32	M
10.	txnDate	Transaction Date	Date		M	yyyy-MM-dd
11.	createTime	Creation Time	DateTime		M	yyyy-MM-dd HH:mm:ss
12.	lastTime	Last Updated Time	Datetime		M	yyyy-MM-dd HH:mm:ss

Transfer Funds from SUNRATE Card Wallet into SUNRATE user account

Request Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

No.	Parameter Name	Details	Type	Max Length	Label	Remarks
1.	outTradeNo	Merchant request ID	String	32	M	Internal reference number within requestor’s system. outTradeNo must be unique for each request.
2.	ccy	Currency	String	3	M
3.	amt	Amount	BigDecimal	15，2	M
4.	remark	Remark	String	255	O

Response Parameters

No.	Parameter Name	Details	Type	Max Length	Label	Remarks
1.	tioJnlId	Transaction ID	String	21	M	SUNRATE transaction ID
2.	txnCcy	Currency	String	3	M
3.	txnAmt	Amount	String	15，2	M
4.	txnType	Type	String	2	M	01 - Transfer Out
5.	txnDesc	Description	String	128	M
6.	txnStatus	Status	String	1	M	9 - Processing, 0 - Failed, 1 - Successful
7.	txnRemark	Transaction Remark	String	255	O
8.	remark	Remark	String	255	O
9.	outTradeNo	Merchant request ID	String	32	M
10.	txnDate	Transaction Date	Date		M	yyyy-MM-dd
11.	createTime	Creation Time	DateTime		M	yyyy-MM-dd HH:mm:ss
12.	lastTime	Last Updated Time	Datetime		M	yyyy-MM-dd HH:mm:ss

Request Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

No.	Parameter Name	Details	Type	Max Length	Label	Remarks
1.	outTradeNo	Merchant request ID	String	32	M	Internal reference number within requestor’s system.

Response Parameters

No.	Parameter Name	Details	Type	Max Length	Label	Remarks
1.	tioJnlId	Transaction ID	String	21	M	SUNRATE transaction ID
2.	txnCcy	Currency	String	3	M
3.	txnAmt	Amount	BigDecimal	15，2	M
4.	txnType	Type	String	2	M	00 – Transfer in 01 – Transfer out
5.	txnDesc	Description	String	128	M
6.	txnStatus	Status	String	1	M	9 - Processing, 0 - Failed, 1 - Successful
7.	txnRemark	Transaction Remark	String	255	O
8.	remark	Remark	String	255	O
9.	outTradeNo	Merchant request ID	String	32	O
10.	txnDate	Transaction Date	Date
11.	createTime	Creation Time	DateTime
12.	lastTime	Last Updated Time	Datetime

Response Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

No.	Parameter	Details	Type	Max Length	Label	Remarks
1.	genericList	Result List	List		M	Refer to \"list\" for details. General transaction scenarios, cannot be modified.
2.	List	Result List	List		M	Refer to \"list\" for details. Customer-defined transaction scenarios, can be modified.

list

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

No.	Parameter	Details	Type	Max Length	Label
1.	groupId	Group ID	String	21	M
2.	groupName	Group Name	String	64	M
3.	mcc	MCC	List		M
4.	remark	Remark	String	128	O

Request Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

No.	Parameter	Details	Type	Max Length	Label	Remarks
1.	groupId	Card ID	String	21	M
2.	mcc	MCC	List		M

Request Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

No.	Parameter	Details	Type	Max Length	Label
1.	groupName	Group Name	String	64	M
2.	mcc	MCC	List		M
3.	remark	Remark	String	128	O

Request Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

No.	Parameter	Details	Type	Max Length	Label	Remarks
1.	groupId	Group ID	String	21	M

Request Parameters

No.	Parameter	Details	Type	Max Length	Label	Remarks
1.	outTradeNo	Merchant request ID	String	32	M	Unique to each card issuance request
2.	productCode	Product code	String	8	M	Please refer to configuration document.
3.	cardBin	Card BIN	String	10	O	Certain products support appointing for a specific BIN. A list of supported card BINs for a particular productCode can be retrieved via “Get card BINs for Card Product” endpoint. BIN will be allocated randomly for those card products if this field is omitted.
4.	cardUse	Card Type	String	1	M	S：Single-use M：Multiple-use
5.	ccy	Currency	String	3	M	ISO 3-Letter Currency Code
6.	expDate	Expiry Date	Date		M	yyyy-MM-dd dd has to be the the last day of the month. Card expiry date can range from: Earliest: One month later of issuance date Latest: Within 4 years of issuance date
7.	cardAmt	Amount on card	BigDecimal	15, 2	C	Applicable for certain card productCode, contact manager-in-charge for details.
8.	nickName	Card Alias	String	32	O	Added user-defined field support.
9.	profileId	MDES Card Profile	String	10	C
10.	extra1	Additional information	String	32	O	Added user-defined field support.
11.	extra2	Additional information	String	32	O	Added user-defined field support.
12.	extra3	Additional information	String	32	O	Added user-defined field support.
13.	createImage	Whether to generate card image	String	1		0 – No 1 – Yes Card image is not generated by default.
14.	velocityControl	Velocity Control Config	Object		O	1. If no value is provided, the default configuration will apply. 2. Configuration must follow logic: Per Transaction Limit ≤ Daily Limit ≤ Monthly Limit ≤ Cumulative Limit For details, see velocityControl
15.	riskCtrl	Risk Control	List		O	See riskCtrl
16.	cardGroupId	Card Group ID	String	21	O
17.	txnAmountCtrl	Transaction Currency Limit (Map)	Map<>	5	O	Supports up to 5 transaction currencies. Map

Response Parameters

No.	Parameter	Details	Type	Max Length	Label	Remarks
1.	outTradeNo	Merchant Card ID	String	32	M
2.	cardId	Card ID	String	19	M
3.	cardUse	Card use type	String	1	M	S：Single-use M：Multiple-use
4.	ccy	currency	String	3	M
5.	cardNo	Card No.	String	20	M
6.	expiry	Valid thru date	String	5	M	MM/YY
7.	cvv	cvv	String	3	M
8.	cardStatus	Card Status	String	1	M	Refer to Appendix F for the list of enumerated values.
9.	nickName	Card alias	String	32	O
10.	extra1	Additional information	String	32	O
11.	extra2	Additional information	String	32	O
12.	extra3	Additional information	String	32	O
13.	cardImage	Image file	String		M	Base64 Png format
14.	createTime	Date and time of creation	DateTime		M	yyyy-MM-dd HH:mm:ss
15.	serviceFeePct	Service Fee Percentage	BigDecimal	8, 6	M

","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-API-Key"},{"key":"value","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"7245cd17-b114-4f58-8936-dafbbfaf4ccc","id":"7245cd17-b114-4f58-8936-dafbbfaf4ccc","name":"Full-Stack Payments","type":"collection"}},"urlObject":{"path":["openapi","v1","card","createCard"],"host":[""],"query":[],"variable":[]}},"response":[{"id":"022fa868-44eb-41e4-bd98-38884c76caa6","name":"Issue card","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"outTradeNo\": \"V2023011520545791400Me10000001\", \r\n \"productCode\": \"00000000\", \r\n \"cardUse\": \"M\", \r\n \"ccy\": \"USD\", \r\n \"expDate\": \"2023-05-31\", \r\n \"nickName\": \"abc\", \r\n \"velocityControl\": {\r\n \"perTransactionLimit\": {\r\n \"txnMaxAmt\": 999, \r\n \"txnMinAmt\": 1\r\n }, \r\n \"velocityList\": [\r\n {\r\n \"period\": \"D\", \r\n \"maxTrans\": 10, \r\n \"cumulativeAmt\": 5000\r\n }, \r\n {\r\n \"period\": \"C\", \r\n \"maxTrans\": 100, \r\n \"cumulativeAmt\": 10000\r\n }\r\n ]\r\n }, \r\n \"txnAmountCtrl\": {\r\n \"USD\": {\r\n \"perTransactionLimit\": {\r\n \"txnMaxAmt\": \"12.00\", \r\n \"txnMinAmt\": 0\r\n }, \r\n \"velocityList\": [\r\n {\r\n \"cumulativeAmt\": \"13.00\", \r\n \"maxTrans\": \"1\", \r\n \"period\": \"D\"\r\n }, \r\n {\r\n \"cumulativeAmt\": \"15.00\", \r\n \"maxTrans\": \"1\", \r\n \"period\": \"C\"\r\n }\r\n ]\r\n }\r\n }, \r\n \"riskCtrl\": [\r\n {\r\n \"created\": \"2024-03-27T10:31:19.319\", \r\n \"name\": \"txnCcy\", \r\n \"action\": \"deny\", \r\n \"list\": [\r\n \"PHP\", \r\n \"GIP\", \r\n \"GBP\"\r\n ]\r\n }, \r\n {\r\n \"created\": \"2024-03-27T10:31:19.319\", \r\n \"name\": \"txnDate\", \r\n \"action\": \"deny\", \r\n \"list\": [\r\n \"2024-05-01\", \r\n \"2024-05-20\"\r\n ]\r\n }, \r\n {\r\n \"created\": \"2024-03-27T10:31:19.319\", \r\n \"name\": \"txnTime\", \r\n \"action\": \"deny\", \r\n \"list\": [\r\n \"08:00:00\", \r\n \"20:00:00\"\r\n ]\r\n }\r\n ]}","options":{"raw":{"language":"json"}}},"url":"/openapi/v1/card/createCard"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\r\n \"outTradeNo\": \"V2025011520545791400Me10000001\", \r\n \"cardId\": \"1934921922136588000\", \r\n \"cardUse\": \"M\", \r\n \"ccy\": \"USD\", \r\n \"cardNo\": \"5257970688216000\", \r\n \"expiry\": \"05/26\", \r\n \"cvv\": \"577\", \r\n \"cardStatus\": \"1\", \r\n \"nickName\": \"abc\", \r\n \"extra1\": null, \r\n \"extra2\": null, \r\n \"extra3\": null, \r\n \"extra\": null, \r\n \"cardImage\": null, \r\n \"createTime\": \"2025-06-17T18:31:52.456\", \r\n \"serviceFeePct\": null}\r\n"}],"_postman_id":"eda8fa5e-72ff-4821-8743-07cae9a99eb7"},{"name":"Query card information","id":"c1ecbf2b-9019-4dab-adc5-b2a9f8eae729","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"url":"/openapi/v1/card/getCardInfo","description":"

Request Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

No.	Parameter	Details	Type	Max Length	Label	Remarks
1.	outTradeNo	Card Order No.	String	32	C	use either outTradeNo or cardId
2.	cardId	SUNRATE Card ID	String	19	C	Internal reference number within requestor’s system

Response Parameters

No.	Parameter	Details	Type	Max Length	Label	Remarks
1.	outTradeNo	Merchant Card ID	String	32	M
2.	cardId	Card ID	String	19	M
3.	cardUse	Card Type	String	1	M	S：Single-use M：Multiple-use
4.	ccy	Currency Type	String	3	M
5.	cardStatus	Card Status	String	1	M	0：Deactivated 1：Activated 2：Frozen 3：Expired 4: Locked 9: Inactive
6.	nickName	Card Alias / Nickname	String	32	O
7.	extra1	Additional information	String	32	O
8.	extra2	Additional information	String	32	O
9.	extra3	Additional information	String	32	O
10.	velocityControl	Velocity Control Config	Object		C	For details, see velocityControl
11.	velocityUsedList	Velocity Control Used	List		O	For details, see velocityList
12.	riskCtrl	Risk Control	List		O	For details, see riskCtrl
13.	createTime	Date and time of creation	DateTime		M	yyyy-MM-dd HH:mm:ss
14.	txnAmountCtrl	Transaction Currency Limit	Map<>	5	O	Map
15.	txnAmountLimitUsed	Transaction Currency Limit	Map<>		O	Map

","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-API-Key"},{"key":"value","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"7245cd17-b114-4f58-8936-dafbbfaf4ccc","id":"7245cd17-b114-4f58-8936-dafbbfaf4ccc","name":"Full-Stack Payments","type":"collection"}},"urlObject":{"path":["openapi","v1","card","getCardInfo"],"host":[""],"query":[],"variable":[]}},"response":[{"id":"5f7b6d9b-c976-4a37-a78f-d3cfade210a2","name":"Query card information","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n\"outTradeNo\": \"V2023011520545791400Me10000001\", \n\"cardId\": \"1651788535293970000\"\n}","options":{"raw":{"language":"json"}}},"url":"/openapi/v1/card/getCardInfo"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\n \"outTradeNo\": \"V2025011520545791400Me10000001\", \n \"cardId\": \"1651788535293970000\", \n \"cardGroupId\": \"0\", \n \"cardUse\": \"M\", \n \"ccy\": \"USD\", \n \"cardStatus\": \"1\", \n \"velocityControl\": {\n \"perTransactionLimit\": {\n \"txnMinAmt\": 1, \n \"txnMaxAmt\": 999\n }, \n \"velocityList\": [\n {\n \"period\": \"D\", \n \"maxTrans\": 10, \n \"cumulativeAmt\": 5000\n }, \n {\n \"period\": \"C\", \n \"maxTrans\": 100, \n \"cumulativeAmt\": 10000\n }\n ]\n }, \n \"velocityUsedList\": [\n {\n \"period\": \"D\", \n \"maxTrans\": 0, \n \"cumulativeAmt\": 0\n }, \n {\n \"period\": \"M\", \n \"maxTrans\": 0, \n \"cumulativeAmt\": 0\n }, \n {\n \"period\": \"C\", \n \"maxTrans\": 0, \n \"cumulativeAmt\": 0\n }\n ], \n \"txnAmountCtrl\": {\n \"USD\": {\n \"perTransactionLimit\": {\n \"txnMinAmt\": 0, \n \"txnMaxAmt\": 12\n }, \n \"velocityList\": [\n {\n \"period\": \"D\", \n \"maxTrans\": 1, \n \"cumulativeAmt\": 13\n }, \n {\n \"period\": \"C\", \n \"maxTrans\": 1, \n \"cumulativeAmt\": 15\n }\n ]\n }\n }, \n \"txnAmountLimitUsed\": {\n \"USD\": [\n {\n \"period\": \"D\", \n \"maxTrans\": 1, \n \"cumulativeAmt\": 4\n }, \n {\n \"period\": \"M\", \n \"maxTrans\": 1, \n \"cumulativeAmt\": 4\n }, \n {\n \"period\": \"C\", \n \"maxTrans\": 1, \n \"cumulativeAmt\": 4\n }\n ]\n }, \n \"riskCtrl\": [\n {\n \"name\": \"txnCcy\", \n \"action\": \"deny\", \n \"list\": [\n \"PHP\", \n \"GIP\", \n \"GBP\"\n ], \n \"created\": \"2024-03-27T10:31:19.319\"\n }, \n {\n \"name\": \"txnDate\", \n \"action\": \"deny\", \n \"list\": [\n \"2024-05-01\", \n \"2024-05-20\"\n ], \n \"created\": \"2024-03-27T10:31:19.319\"\n }, \n {\n \"name\": \"txnTime\", \n \"action\": \"deny\", \n \"list\": [\n \"08:00:00\", \n \"20:00:00\"\n ], \n \"created\": \"2024-03-27T10:31:19.319\"\n }\n ], \n \"nickName\": \"abc\", \n \"extra1\": null, \n \"extra2\": null, \n \"extra3\": null, \n \"extra\": null, \n \"createTime\": \"2025-06-17T18:31:52.456\"}"}],"_postman_id":"c1ecbf2b-9019-4dab-adc5-b2a9f8eae729"},{"name":"Query card sensitive information","id":"dab9df60-7aee-4384-b7bc-ee07e9baef58","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"url":"/openapi/v1/card/getCardSensitiveInfo","description":"

Request Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

No.	Parameter	Details	Type	Max Length	Label	Remarks
1.	cardId	Card ID	String	19	M

Response Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

No.	Parameter	Details	Type	Max Length	Label	Remarks
1.	cardNo	Card Number	String	20	M
2.	cvv	CVV	String	3	M
3.	expiry	Valid thru date	String	5	M	MM/YY

Request Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

No.	Parameter	Details	Type	Max Length	Label	Remarks
1.	cardId	Card ID	String	19	M
2.	velocityControl	Card limit	Object		C	For details, see velocityControl
3.	riskCtrl	RIsk Control	List		C	For details, see riskCtrl
4.	txnAmountCtrl	Transaction Currency Limit	Map<>	5	C	Supports up to 5 transaction currencies. Map

Response Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

No.	Parameter	Details	Type	Max Length	Label	Remarks
1.	cardId	Card ID	String	19	M
2.	velocityControl	Card limit	Object		O	For details, see velocityControl
3.	riskCtrl	Risk Control	List		O	For details, see riskCtrl
4.	txnAmount Ctrl	Transaction Currency Limit	Map<>	5	O	Supports up to 5 transaction currencies. Map

","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-API-Key"},{"key":"value","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"7245cd17-b114-4f58-8936-dafbbfaf4ccc","id":"7245cd17-b114-4f58-8936-dafbbfaf4ccc","name":"Full-Stack Payments","type":"collection"}},"urlObject":{"path":["openapi","v1","card","updateCardLimit"],"host":[""],"query":[],"variable":[]}},"response":[{"id":"ffe7b14d-01df-4357-a49a-fd202b617463","name":"Update card limit","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"cardId\": \"1651788535293970000\", \r\n \"velocityControl\": {\r\n \"perTransactionLimit\": {\r\n \"txnMaxAmt\": 100000, \r\n \"txnMinAmt\": 5\r\n }, \r\n \"velocityList\": [\r\n {\r\n \"period\": \"D\", \r\n \"maxTrans\": 1, \r\n \"cumulativeAmt\": 1000\r\n }, \r\n {\r\n \"period\": \"C\", \r\n \"maxTrans\": 100, \r\n \"cumulativeAmt\": 100000000\r\n }\r\n ]\r\n }, \r\n \"riskCtrl\": [\r\n {\r\n \"created\": \"2024-03-27T10:31:19.319\", \r\n \"name\": \"txnCcy\", \r\n \"action\": \"deny\", \r\n \"list\": [\r\n \"PHP\", \r\n \"GIP\"\r\n ]\r\n }, \r\n {\r\n \"created\": \"2024-03-27T10:31:19.319\", \r\n \"name\": \"txnDate\", \r\n \"action\": \"deny\", \r\n \"list\": [\r\n \"2024-05-01\", \r\n \"2024-05-20\"\r\n ]\r\n }, \r\n {\r\n \"created\": \"2024-03-27T10:31:19.319\", \r\n \"name\": \"txnTime\", \r\n \"action\": \"deny\", \r\n \"list\": [\r\n \"08:00:00\", \r\n \"20:00:00\"\r\n ]\r\n }\r\n ]}\r\n","options":{"raw":{"language":"json"}}},"url":"/openapi/v1/card/updateCardLimit"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\r\n \"cardId\": \"1651788535293970000\", \r\n \"velocityControl\": {\r\n \"perTransactionLimit\": {\r\n \"txnMaxAmt\": 100000, \r\n \"txnMinAmt\": 5\r\n }, \r\n \"velocityList\": [\r\n {\r\n \"period\": \"D\", \r\n \"maxTrans\": 1, \r\n \"cumulativeAmt\": 1000\r\n }, \r\n {\r\n \"period\": \"C\", \r\n \"maxTrans\": 100, \r\n \"cumulativeAmt\": 100000000\r\n }\r\n ]\r\n }, \r\n \"txnAmountCtrl\": {\r\n \"USD\": {\r\n \"perTransactionLimit\": {\r\n \"txnMaxAmt\": \"12.00\", \r\n \"txnMinAmt\": 0\r\n }, \r\n \"velocityList\": [\r\n {\r\n \"cumulativeAmt\": \"13.00\", \r\n \"maxTrans\": \"1\", \r\n \"period\": \"D\"\r\n }, \r\n {\r\n \"cumulativeAmt\": \"15.00\", \r\n \"maxTrans\": \"1\", \r\n \"period\": \"C\"\r\n }\r\n ]\r\n }\r\n }, \r\n \"riskCtrl\": [\r\n {\r\n \"created\": \"2024-03-27T10:31:19.319\", \r\n \"name\": \"txnCcy\", \r\n \"action\": \"deny\", \r\n \"list\": [\r\n \"PHP\", \r\n \"GIP\"\r\n ]\r\n }, \r\n {\r\n \"created\": \"2024-03-27T10:31:19.319\", \r\n \"name\": \"txnDate\", \r\n \"action\": \"deny\", \r\n \"list\": [\r\n \"2024-05-01\", \r\n \"2024-05-20\"\r\n ]\r\n }, \r\n {\r\n \"created\": \"2024-03-27T10:31:19.319\", \r\n \"name\": \"txnTime\", \r\n \"action\": \"deny\", \r\n \"list\": [\r\n \"08:00:00\", \r\n \"20:00:00\"\r\n ]\r\n }\r\n ]}"}],"_postman_id":"14b555d1-6584-4e74-9e55-e7303ed730c3"},{"name":"Update card status","id":"a9a19261-dd8e-48e5-a174-3f2558d5a15a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"url":"/openapi/v1/card/updateCardStatus","description":"

Request Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

No.	Parameter	Details	Type	Max Length	Label	Remarks
1.	cardId	Card ID	String	19	M
2.	cardStatus	Card status	String	1	M	0： Deactivated 1：Activated 2：Frozen
3.	remark	Additional remarks	String	128	O

Response Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

No.	Parameter	Details	Type	Max Length	Label	Remarks
1.	cardId	Card ID	String	19	M
2.	cardStatus	Card status	String	1	M	0：Deactivated 1：Activated 2：Frozen 3：Expired 4：Locked

Request Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

No.	Parameter	Details	Type	Max Length	Label	Remarks
1.	cardId	Card ID	String	19	M
2.	nickName	Card Alias	String	32	O	Added user-defined field support

Request Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

No.	Parameter	Details	Type	Max Length	Label	Remarks
1.	cardId	Card ID	String	19	C
2.	txnDateStart	Transaction Date - Start	Date		C	yyyy-MM-dd When card ID is not present, transaction date is mandatory. Transaction Date-Start and Transaction Date-End must be of the same date
3.	txnDateEnd	Transaction Date - End	Date		C	yyyy-MM-dd When card ID is not present, transaction date is mandatory. Transaction Date-Start and Transaction Date-End must be of the same date
4.	pageInfo	Page Information	Object		M	{ \"current\": \"1\", \"size\": \"100\" }

Response Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

No.	Parameter	Details	Type	Max Length	Label	Remarks
1.	list	List of results	List		M	Refer to “list” for details
2.	pageInfo	Page Information	Object		M	{ \"current\": \"1\", size\": \"100\", \"total\": \"1000 }

list

No.	Parameter	Details	Type	Max Length	Label	Remarks
1.	txnId	Transaction ID	String	20	M
2.	originTxnId	Original transaction ID	String	20	C	Original transaction ID used in the event of a reversal
3.	cardId	Card ID	String	19	M
4.	productCode	Product Code	String	8	M
5.	txnType	Transaction Type	String	1	M	A：Authorization D：Reversal
6.	bizType	Business Type	String	2	M	01: Cash Withdrawal 30: Balance Enquiry 99: Purchase / Spending
7.	txnStatus	Transaction Status	String	1	M	0: Failed 1: Success
8.	txnCcy	Transaction Currency	String	3	M
9.	txnAmt	Transaction Amount	BigDecimal	15, 2	M
10.	billCcy	Bill Currency	String	3	M
11.	billAmt	Bill Amount	BigDecimal	15, 2	M
12.	merchId	Merchant ID	String	32	M
13.	merchName	Merchant Name	String	128	M
14.	merchCtry	Merchant Country	String	3	M	3-digit ISO Standard Country Code
15.	mcc	Merchant Category Code	String	128	M
16.	declineReason	Reason for Decline	String	128	C
17.	txnTime	Transaction Time	DateTime		M	yyyy-MM-dd hh:mm:ss
18.	clearingDate	Settlement Date	Date		C	yyyy-MM-dd
19.	remark	Remark	String	512	C
20.	rspCode	Response Code	String	2	M
21.	authCode	Authorisation Code	String	6	C
22.	processCode	Process Code	String	6	C
23.	originalRefNo	Original Reference Number	String	64	C
24.	preAuth	Pre-authorisation	Boolean		C
25.	forcePost	Force Post	Boolean		C
26.	dpan	DPAN	String	32
27.	walletId	Wallet ID	String	3		Wallet ID: 216 - Google Pay 102 - Apple Pay 327 - Merchant 337 - Garmin Pay Note: Any other values (e.g. A01, C46) can be ignored.
28.	threedsFlag	3DS Authentication	Boolean			True; False

","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-API-Key"},{"key":"value","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"7245cd17-b114-4f58-8936-dafbbfaf4ccc","id":"7245cd17-b114-4f58-8936-dafbbfaf4ccc","name":"Full-Stack Payments","type":"collection"}},"urlObject":{"path":["openapi","v1","card","listCardTxn"],"host":[""],"query":[],"variable":[]}},"response":[{"id":"fbe49a87-9b36-43a0-b408-a75443517de4","name":"Get card authorization record","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"txnDateStart\": \"2023-04-24\", \r\n \"txnDateEnd\": \"2023-04-24\", \r\n \"pageInfo\": {\r\n \"current\": 1, \r\n \"size\": 10\r\n }}\r\n","options":{"raw":{"language":"json"}}},"url":"/openapi/v1/card/listCardTxn"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\r\n \"list\": [\r\n {\r\n \"cardId\": \"1651788535293970000\", \r\n \"txnId\": \"A1650337673904330000\", \r\n \"originTxnId\": null, \r\n \"txnType\": \"A\", \r\n \"txnStatus\": \"1\", \r\n \"txnCcy\": \"GBP\", \r\n \"txnAmt\": 56.33, \r\n \"billCcy\": \"USD\", \r\n \"billAmt\": 58.09, \r\n\t \"merchId\": \"123456\",\r\n \"merchName\": \"Department Store Vegas NV\", \r\n \"merchCtry\": \"GBR\", \r\n \"mcc\": \"0780 Landscaping and horticultural services\", \r\n\t \"rspCode\": \"00\",\r\n \"declineReason\": null, \r\n \"txnTime\": \"2023-04-24T11:23:24.015\", \r\n \"clearingDate\": \"2023-04-24\"\r\n }, \r\n {\r\n \"cardId\": \"1651788535293970000\", \r\n \"txnId\": \"A1650337673904330001\", \r\n \"originTxnId\": \"A1628643391916802049\", \r\n \"txnType\": \"D\", \r\n \"txnStatus\": \"1\", \r\n \"txnCcy\": \"USD\", \r\n \"txnAmt\": -5, \r\n \"billCcy\": \"USD\", \r\n \"billAmt\": -5, \r\n \"merchName\": \"PAYPAL\", \r\n \"merchCtry\": \"GBR\", \r\n \"mcc\": \"5999 Miscellaneous Specialty Retail\", \r\n\t \"rspCode\": \"00\",\r\n \"declineReason\": null, \r\n \"txnTime\": \"2023-04-24T11:15:37.987\", \r\n \"clearingDate\": null\r\n }\r\n ], \r\n \"pageInfo\": {\r\n \"total\": 2, \r\n \"size\": 10, \r\n \"current\": 1\r\n }}"}],"_postman_id":"3d53e0c6-5a9f-4065-96b9-605f8297adfc"},{"name":"Get clearing record","id":"9a5fdb8d-0898-4968-9881-79f4a039d7f2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"/openapi/v1/card/listCardClearing","description":"

Request Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

No.	Parameter	Details	Type	Max Length	Label	Remarks
1.	cardId	CardID	String	19	C
2.	txnDateStart	Transaction Clearing Date - Start	Date		C	yyyy-MM-dd When card ID is not present, transaction date is mandatory. Transaction Date-Start and Transaction Date-End must be of the same date
3.	txnDateEnd	Transaction Clearing Date - End	Date		C	yyyy-MM-dd When card ID is not present, transaction date is mandatory. Transaction Date-Start and Transaction Date-End must be of the same date
4.	pageInfo	Page Information	Object		M	{ \"current\": \"1\", \"size\": \"100\" }

Response Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

No.	Parameter	Details	Type	Max Length	Label	Remarks
1.	list	List of results	List		M	See list
2.	pageInfo	Page Information	Object		M	{ \"current\": \"1\", size\": \"100\", \"total\": \"1000 }

list

No.	Parameter	Details	Type	Max Length	Label	Remarks
1.	txnId	Transaction ID	String	20	M
2.	authTxnId	Corresponding Authorization ID	String	20	M
3.	cardId	Card ID	String	19	M
4.	productCode	Product Code	String	8
5.	txnType	Transaction Type	String	1	M	C：Settlement R：Refund
6.	bizType	Business type	String	2	M	01: Cash Withdrawal 99: Purchase
7.	txnCcy	Transaction Currency	String	3	M
8.	txnAmt	Transaction Amount	BigDecimal	15,2	M
9.	billCcy	Bill Currency	String	3	M
10.	billAmt	Bill Amount	BigDecimal	15,2	M
11.	merchId	Merchant ID	String	32	M
12.	merchName	Merchant Name	String	128	M
13.	merchCtry	Merchant Country	String	3	M	3-digit ISO Country Code
14.	mcc	Merchant Category Code	String	128	M
15.	clearingDate	Clearing Date	Date		M
16.	clearingTime	Clearing Time	DateTime		M
17.	remark	Remark	String	512	C
18.	authCode	Authorization Code	String	6	C
19.	processCode	Process Code	String	6	C
20.	arn	ARN	String	23	C
21.	aid	AID	String	64	C
22.	fid	FID	String	64	C
23.	originalRefNo	Original Reference Number	String	64	C
24.	dpan	DPAN	String	32	O
25.	ticketNumber	Ticket Number	String	16
26.	walletId	Wallet ID	String	3		Wallet ID: 216 - Google Pay 103 - Apple Pay 327 - Merchang 337 - Garmin Pay Note: Any other values (e.g. A01, C46, etc.) can be ignored.
27.	threedsFlag	3DS Authentication	Boolean			True; False

Note: For \"C\" series products only

Request Parameters

None

Responsne Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

No.	Parameter	Details	Type	Max Length	Label	Remarks
1.	list	Results list	List		M	See list

list

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

No.	Parameter	Details	Type	Max Length	Label	Remarks
1.	productCode	Product code	String	8	M	Product code
2.	cardUse	Card use type	String	1	M	S：Single-use M：Multiple-use
3.	ccy	Currency	String	3	M	3-digit standard ISO currency code
4.	cardBinList	List of card BINs	List		M

Note: For \"C\" series products only

Request Parameters

None

Responsne Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

No.	Parameter	Details	Type	Max Length	Label	Remarks
1.	cardNo	Card No.	String	20	M

list

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

No.	Parameter	Details	Type	Max Length	Label	Remarks
1.	cardId	Card ID	String	19	M

Request Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

No.	Parameter	Details	Type	Max Length	Label	Remarks
1.	cardId	Card ID	String	19	M

Response Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

No.	Parameter	Details	Type	Max Length	Label	Remarks
1.	cardId	Card ID	String	19	M
2.	cardStatus	Card Status	String	1	M	1: Activated

Request Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

No.	Parameter	Details	Type	Max Length	Label	Remarks
1.	ccy	Currency	String	3	M	ISO 3-Letter Currency Code
2.	velocityControl	Velocity Control Config	Object		M	For details, see velocityControl

Response Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

No.	Parameter	Details	Type	Max Length	Label	Remarks
1.	cardGroupId	Card Group ID	String	21	M
2.	ccy	Currency	String	3	M	ISO 3-Letter Currency Code
3.	velocityControl	Velocity Control Config	Object		M	For details, see velocityControl

Request Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

No.	Parameter	Details	Type	Max Length	Label	Remarks
1.	cardGroupId	Card Grouop ID	String	21	M
2.	velocityControl	Velocity Control Config	Object		M	For details, see velocityControl

Response Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

No.	Parameter	Details	Type	Max Length	Label	Remarks
1.	cardGroupId	Card Group ID	String	21	M
2.	velocityControl	Velocity Control Config	Object		M	For details, see velocityControl

Request Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

No.	Parameter	Details	Type	Max Length	Label	Remarks
1.	cardGroupId	Card Group ID	String	21	M

Request Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

No.	Parameter	Details	Type	Max Length	Label	Remarks
1.	cardGroupId	Card ID	String	21	M
2.	cardGroupStatus	Card Group Status	String	2	M	1: Enable 2: Lock

Request Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

No.	Parameter	Details	Type	Max Length	Label	Remarks
1.	cardId	Card ID	String	19	M
2.	expDate	Expiry Date	Date		M	yyy-MM-dd dd has to be the last day of the month. Valid date range: From 1 month later up to 4 years from date of issuance.

Request Parameters

No.	Parameter	Details	Type	Max Length	Label	Remarks
1.	outBizId	Business Partner D	String	64	M
2.	acctId	Account ID	String	8	M
3.	username	Username	String	128	M	Full username (max. 128 characters)
4.	firstNameEn	First Name	String	128	M	User's first name (English)
5.	lastNameEn	Last Name	String	128	M	User's last name (English)
6.	dateBirth	Date of Birth	LocalDate		M	Date of birth (e.g., 2000-01-01)
7.	Sex	Sex	String	1	M	Gender: 1 = Male, 2 = Female
8.	cardType	Card Type	String	2	M	ID Type: 1 - ID Card 2 - Passport 3 - Driver's Licence 4 - Residence Permit
9.	cardNumber	Card Number	String	30	M	Card ID number
10.	issueCountryCode	Country Code issued	String	2	M	Country Code (e.g. CN)
11.	zoneNumber	Zone Number	String	6	M	Mobile number country/area code (e.g., +86)
12.	cellphone	Mobile Phone Number	String	15	M	Mobile number (7 - 15 digits, international standard)
13.	email	Email	String	30	M	Email address
14.	remark	Remark	String	128	O	Optional notes

Response Parameters

No.	Parameter	Details	Type	Max Length	Label	Remarks
1.	outBizId	Business Partner D	String	64	M
2.	userId	User ID	String	128	M
3.	acctI	Account ID	String	128	M
4.	username	Username	String	128	M	Full username (max. 128 characters)
5.	firstNameEn	First Name	String	128	M	User's first name (English)
6.	lastNameEn	Last Name	String	128	M	User's last name (English)
7.	dateBirth	Date of Birth	LocalDate		M	Date of birth (e.g., 2000-01-01)
8.	Sex	Sex	String	1	M	Gender: 1 = Male, 2 = Female
9.	cardType	Card Type	String	2	M	ID Type: 1 - ID Card 2 - Passport 3 - Driver's Licence 4 - Residence Permit
10.	cardNumber	Card Number	String	30	M	Card ID number
11.	issueCountryCode	Country Code issued	String	2	M	Country Code (e.g. CN)
12.	zoneNumber	Zone Number	String	6	M	Mobile number country/area code (e.g., +86)
13.	cellphone	Mobile Phone Number	String	15	M	Mobile number (7 - 15 digits, international standard)
14.	email	Email	String	30	M	Email address
15.	remark	Remark	String	128	O	Optional notes
16.	userStatus	User Status	String	2	M	User Status: 0: Not Enabled 1: Enabled 2: Disabled 3: Activating 4: Rejected 5: Deleted
17.	sysTxnTime	System Transaction Time	LocalDateTime		M

velocityControl

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

No.	Parameter	Details	Type	Max Length	Label	Remarks
1.	perTransactionLimit	Per Transaction Limit	Object		O	For details, see perTransactionLimit
2.	velocityList	Velocity Control List	List		O	For details, see velocityList

perTransactionLimit

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

No.	Parameter	Details	Type	Max Length	Label	Remarks
1.	txnMinAmt	Minimum Amount per Transaction	BigDecimal	15,2	O
2.	txnMaxAmt	Maximum Amount per Transaction	BigDecimal	15,2	C

velocityList

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

No.	Parameter	Details	Type	Max Length	Label	Remarks
1.	period	Period param	String	1	C	D：Daily M：Monthly C：Cumulative/Total
2.	maxTrans	Maximum No. of Transactions	Integer	10	C	If there is no limit, pass -1
3.	cumulativeAmt	Cumulative Amount	BigDecimal	15,2	C

riskCtrl

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

No.	Parameter	Details	Type	Max Length	Label	Remarks
1.	name	Risk Control	String	10	M	txnCcy: Transaction currency txnMcc: MCC txnCountry: Merchant Country txnMerchId: Merchant ID txnDate: Transaction Date txnTime: Transaction Time
2.	action	Action Type	String	10	M	allow: Allow list deny: Deny list
3.	list	Control List	List		M	List When setting risk controls with txnDate or txnTime, set the start date and end date and then first and second position of the array. e.g., [“start date” , “end date”]
4.	created	Creation Time	DateTime		M	yyyy-MM-dd HH:mm:ss

shippingAddress

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

No.	Parameter	Details	Type	Max Length	Label	Remarks
1.	country	Country	String	3	M	3-Letter Country Code
2.	province	Province / State	String	32	M
3.	city	City	String	32	M
4.	district	District	String	32	O
5.	detail	Detailed Address	String	256	M
6.	receiver	Recipient	String	128	M
7.	zoneNumber	Area Code	String	10	M
8.	phone	Phone Number	String	32	M
9.	postalCode	Postal Code	String	16	M

","_postman_id":"503be1f0-eb2d-4e75-843a-778f02ced5b5","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-API-Key"},{"key":"value","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"7245cd17-b114-4f58-8936-dafbbfaf4ccc","id":"7245cd17-b114-4f58-8936-dafbbfaf4ccc","name":"Full-Stack Payments","type":"collection"}}},{"name":"Webhook Notifications","item":[{"name":"Authorization record notification","id":"1aa9f64b-fdbc-41b9-a7df-b20fed501b11","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"url":"url/callBack/cardAuth","description":"

SUNRATE will PUSH authorization records to client’s notification URL. HTTPS Port 443 must be used.

Notification Parameters

No.	Parameter	Details	Type	Max Length	Label	Remarks
1.	txnId	Transaction ID	String	20	M
2.	originTxnId	Original transaction ID	String	20	C	Original transaction ID used in the event of a reversal
3.	cardId	Card ID	String	19	M
4.	productCode	Product Code	String	8
5.	txnType	Transaction Type	String	1	M	A：Authorisation D：Reversal
6.	bizType	Business Type	String	2	M	01: Cash Withdrawal 30: Balance Enquiry 99: Purchase / Spending
7.	txnStatus	Status	String	1	M	0: Failed 1: Successful
8.	txnCcy	Currency	String	3	M
9.	txnAmt	Transaction Amount	BigDecimal	15, 2	M
10.	billCcy	Bill Currency	String	3	M
11.	billAmt	Bill Amount	BigDecimal	15, 2	M
12.	merchId	Merchant ID	String	32	M
13.	merchName	Merchant Name	String	128	M
14.	merchCtry	Merchant Country	String	3	M	3-digit ISO Standard Country Code
15.	mcc	Merchant Category Code	String	128	M
16.	declineReason	Reason for decline	String	128	M
17.	txnTime	Transaction Time	DateTime		M	yyyy-MM-dd'T'hh:mm:ss
18.	clearingDate	Clearing Date	Date		C	yyyy-MM-dd
19.	remark	Remark	String	512	C
20.	rspCode	Response Code	String	2	M	See appendix C
21.	authCode	Authorisation Code	String	6	C
22.	processCode	Process Code	String	6	C
23.	originalRefNo	Original Reference Number	String	64	C
24.	preAuth	Pre-authorisation	Boolean		C
25.	forcePost	Force Post	Boolean		C
26.	dpan	DPAN	String	32	C
27.	walletid	Wallet ID	String	3		Wallet ID: 216 - Google Pay 103 - Apple Pay 327 - Merchant 337 - Garmin Pay Note: Any other values can be ignored, e.g. A02, C46, etc.
28.	threedsFlag	3DS Authentication	Boolean			True; False

The client must provide a callback URL to SUNRATE. The callback URL must use HTTPS on port 443.

Callback Parameters

No.	Parameter	Details	Type	Max Length	Label	Remarks
1.	txnId	Transaction ID	String	20	M
2.	authTxnId	Authorisatio Transaction ID	String	20	M
3.	cardId	Card ID	String	19	M
4.	productCode	Product Code	String	8
5.	txnType	Transaction Type	String	1	M	C：Expense R：Refund
6.	bizType	Business Type	String	2	M	01: Cash Withdrawal 99: Purchase / Spending
7.	txnCcy	Currency	String	3	M
8.	txnAmt	Transaction Amount	BigDecimal	15, 2	M
9.	billCcy	Bill Currency	String	3	M
10.	billAmt	Bill Amount	BigDecimal	15, 2	M
11.	merchId	Merchant ID	String	32	M
12.	merchName	Merchant Name	String	128	M
13.	merchCtry	Merchant Country	String	3	M	3-digit ISO Standard Country Code
14.	mcc	Merchant Category Code	String	128	M
15.	clearingDate	Clearing Date	Date		M
16.	clearingTime	ClearingTime	DateTime		M
17.	remark	Remark	String	512	C
18.	authCode	Authorisation Code	String	6	C
19.	processCode	Process Code	String	6	C
20.	arn	ARN	String	23	C
21.	aid	AID	String	64	C
22.	fid	FID	String	64	C
23.	originalRefNo	Original Reference Number	String	64	C
24.	dpan	DPAN	String	32	C
25.	ticketNumber	Ticket Number	String	16	O
26.	walletid	Wallet ID	String	3		Wallet ID: 216 - Google Pay 103 - Apple Pay 327 - Merchant 337 - Garmin Pay Note: Any other values can be ignored, e.g. A02, C46, etc.
27.	threedsFlag	3DS Authentication	Boolean			True; False

The client must provide a callback URL to SUNRATE. The callback URL must use HTTPS on port 443.

\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-API-Key"},{"key":"value","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"7245cd17-b114-4f58-8936-dafbbfaf4ccc","id":"7245cd17-b114-4f58-8936-dafbbfaf4ccc","name":"Full-Stack Payments","type":"collection"}},"urlObject":{"path":["callBack","notification"],"host":["callback_url"],"query":[],"variable":[]}},"response":[{"id":"0861b62b-69a4-4ac5-97e8-453695b931b2","name":"Record notification","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"cardId\": \"1628587609561490000\", \r\n \"txnId\": \"F1637755936363580000\", \r\n \"authTxnId\": null, \r\n \"txnType\": \"R\", \r\n \"txnCcy\": \"USD\", \r\n \"txnAmt\": -15.22, \r\n \"billCcy\": \"HKD\", \r\n \"billAmt\": -119.77, \r\n \"merchName\": \"RYANAIR PHZ0\", \r\n \"merchCtry\": \"GBR\",\r\n \"mcc\": \"3246 RYANAIR\", \r\n \"clearingDate\": \"2023-03-20\"}\r\n","options":{"raw":{"language":"json"}}},"url":"callback_url/callBack/notification"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\r\n \"msgId\": \"123456789\", \r\n \"code\": \"000000\", \r\n \"msg\": \"success\", \r\n \"timestamp\": \"2023-04-24T11:23:24.015\"}\r\n"}],"_postman_id":"1a6512d8-b73f-46bb-9c76-9ce71c160e25"},{"name":"Physical card production status notification","id":"0564b54c-3ee0-42a5-aa2f-c4f64bfbc2ac","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"graphql","graphql":{"query":"{\n \"cardId\": \"1628587609561490000\", \n \"txnId\": \"F1637755936363580000\", \n \"authTxnId\": null, \n \"txnType\": \"R\", \n \"txnCcy\": \"USD\", \n \"txnAmt\": -15.22, \n \"billCcy\": \"HKD\", \n\"billAmt\": -119.77, \n\"merchId\": \"123456\",\n\"merchName\": \"RYANAIR PHZ0\", \n\"merchCtry\": \"GBR\",\n \"mcc\": \"3246 RYANAIR\", \n \"clearingDate\": \"2023-03-20\"}","variables":""}},"url":"eventType: cardManufacturingStatusChange","description":"

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

No.	Parameter	Details	Type	Max Length	Label	Remarks
1.	cardId	Card ID	String	19	M
2.	cardOrderId	Card Order ID	String	19	M
3.	CardNo	Card No.	String	20	M	Returned when the cards issuance status is set to 1.
4.	cardManufacturingStatus	Card Manufacturing Status	String	1	M	Refer to Appendix E for the list of enumerated values.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

No.	Parameter	Details	Type	Max Length	Label	Remarks
1.	cardOrderId	Card Order ID	String	19	M
2.	cardOrderStatus	Card Order Status	String	1	M	For more details, refer to Appendix D
3.	auditRemark	Audit Remark	String	128	C	Reason rejected

Notification Request Headers

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter Name	Type	Max Length	Label	Details
msgId	String	21	M	messageId, the request message ID
timestamp	String	23	M	Timestamp of request，formatted as \"yyyy-MM-ddTHH:mm:ss.SSS\" For example, 2008-08-08T08:08:08.888
key	String	16	M	Private key value of 16-digit AES after encryption. The 16-digit AES key is to be generated randomly by merchant.
sign	String		M	Signature value
requestBody	String		M	Encrypted request body.
				Note: format the request in JSON before encryption. No restriction on max. length

Notification Response Headers

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter Name	Type	Max Length	Label	Details
msgId	String	21	M	messageId, the request message ID
code	String	6	M	Response Code “000000” signifies a successful request
msg	String	128	M	Response Code description
key	String	16	M	Private key value of 16-digit AES after encryption. The 16-digit AES key is to be generated randomly by merchant.
sign	String		M	Signature value
timestamp	String	23	M	Timestamp of request，formatted as \"yyyy-MM-ddTHH:mm:ss.SSS\" For example, 2008-08-08T08:08:08.888
responseBody	String		M	Note: format the request in JSON before encryption. No restriction on max. length

","_postman_id":"4883c432-1fa3-4cee-be90-a630903dedb2","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-API-Key"},{"key":"value","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"7245cd17-b114-4f58-8936-dafbbfaf4ccc","id":"7245cd17-b114-4f58-8936-dafbbfaf4ccc","name":"Full-Stack Payments","type":"collection"}}}],"id":"af4edecb-34b7-48c1-9020-402717d08a3a","_postman_id":"af4edecb-34b7-48c1-9020-402717d08a3a","description":"","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-API-Key"},{"key":"value","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"7245cd17-b114-4f58-8936-dafbbfaf4ccc","id":"7245cd17-b114-4f58-8936-dafbbfaf4ccc","name":"Full-Stack Payments","type":"collection"}}},{"name":"🏦 Finance","item":[{"name":"Query balance","id":"245fdeb2-4aeb-4fb1-b744-b755fd2a2c31","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"url":"/openapi/v3/balance/list/","description":"

Request Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

No.	Parameter	Type	Length	Required/Optional	Remarks
1.	curId	String	3	O	Currency code for currency

Response Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

No.	Parameter	Type	Length	Remarks
Array
1.	curId	String	char（3）	Currency code
2.	currBal	Number	15,2	Total balance of the currency, equal to sum of availableBal and frozenBal
3.	availableBal	Number	15,2	Available balance of the currency for transaction creation
4.	frozenBal	Number	15,2	Frozen balance of the currency due to transaction(s) created

Request Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

No.	Parameter	Type	Length	Required/Optional	Remarks
1.	curId	String	3	O	Currency code for currency
2.	startDate	Date	10	O	Date after which transaction is created
3.	endDate	Date	10	O	Date before which transaction is created
4.	start	String		M	Start position of records queried, equal to (page number to query-1) * limit
5.	limit	String		M	Count of records per page. Ranges from 1 to 100. Default to 20 if not provided

Response Parameters

No.	Parameter	Type	Length	Required/Optional	Remarks
1.	orgCode	String	18	M	Business registration number of client
2.	acctId	String	8	M	Unique 8-digit user account identifier
3.	curId	String	char（3）	M	Currency of balance change
4.	txnAmt	Number	15,2	M	txnAmt can be positive or negative, postive value suggests a credit, negative value suggests a debit
5.	initBal	Number	15,2	M	Balance before transaction
6.	closeBal	Number	15,2	M	Balance after transaction
7.	refNo	String	18	M	Unique identifier of balance change
8.	txnType	String	4	M	Used to specify type of transaction that incurs balance change
9.	remark	String	100	O	Used to describe details of transaction
10.	sysTxnDate	String	10	M	Date of balance change
11.	totalCounts	Number		M	Count of total records queried

This suite of APIs let you retrieve account statement for reconciliation.

\n","_postman_id":"c18129cf-1f40-49ea-84cc-22039595edab","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-API-Key"},{"key":"value","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"7245cd17-b114-4f58-8936-dafbbfaf4ccc","id":"7245cd17-b114-4f58-8936-dafbbfaf4ccc","name":"Full-Stack Payments","type":"collection"}}},{"name":"🗂️Files","item":[{"name":"Get file ID","id":"e155b1c2-aba3-4636-9911-519c9a5aa331","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"url":"/openapi/v3/file/upload/","description":"

Request Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

No.	Parameter	Type	Length	Required/Optional	Remarks
1.	acctId	String	8	M	Unique 8-digit user account identifier assigned by SUNRATE
2.	filePath	String	128	M	Path to the file on SFTP server

Response Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

No.	Parameter	Type	Length	Required/Optional	Remarks
1.	fileId	String	15	M	Unique file identifier assigned by SUNRATE

Request Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

No.	Parameter	Type	Length	Required/Optional	Remarks
1.	fileType	String	2	M	Unique 8-digit user account identifier assigned by SUNRATE
2.	dirPath	String	100	M	Path to the supporting document on SFTP server
3.	fileNameList	Array		M
4.	remark	String	100	O

Response Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

No.	Parameter	Type	Length	Required/Optional	Remarks
1.	verifyNo	String	26	M	Unique identifier for the supporting document assigned by SUNRATE

This suite of APIs let you generate unique ID for supporting documents you have uploaded via SFTP.

Note:

All files have to be exchanged via SFTP. You need to log into SUNRATE's SFTP server with your username (assigned by SUNRATE) and your private key.
\n
You need to provide SUNRATE a SSH-RSA public key for authentication.
\n

\n","_postman_id":"87070987-b12a-4b45-99d6-0ea458dca35b","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-API-Key"},{"key":"value","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"7245cd17-b114-4f58-8936-dafbbfaf4ccc","id":"7245cd17-b114-4f58-8936-dafbbfaf4ccc","name":"Full-Stack Payments","type":"collection"}}}],"id":"bfe906c2-a996-4777-a319-b659b207248c","description":"

📒 Developer's Guide

SUNRATE is committed to providing global enterprises with safe and efficient global payment and treasury management solutions.

This document comprises standard API integration process, security solutions and an overview of our APIs, which aims to help your integration project run smoothly.

⚙️Integration Process

Read our Developer's Guide and API Documentation
\n
Before you confirm to integrate with SUNRATE API, we recommend that you
read our Developer’s Guide and API Documentation to understand the product
capabilities and workflow.
\n
Talk with us about your business scenarios and requirements
\n
Let us know about your business scenarios and requirements through your dedicated account manager at SUNRATE, or leave your enquiry via email at service@sunrate.com.
\n
Our Product and Tech team will be happy to set up some time for solution consulting and project planning.
\n
Test in UAT environment
\n
We will provide you with configuration document before setting you up for testing. You will need to provide information such as your IP address (for whitelisting), public key, callback address, etc.
\n
UAT configuration will be completed within 1~3 working days after we have received your response. You’ll then be able to start testing the in-scope APIs in the UAT environment.
\n
Sign off before going live
\n
Pre-launch testing will be necessary for us to move you into the Production environment.
\n
Go live!
\n
We will provide you with configuration document for production environment after signoff. Once your production configuration is complete, you're free to make your first live API call!
\n
Technical support will be available throughout your API integration journey with us, even after going live.
\n

🔒Security Solution

Guide: Randomly generate a 16-character string as an AES private key and encrypt operational parameters using AES encryption in base64 format. Place this under the requestBody parameter and exchange it for RSA public key. Use SUNRATE’s RSA public key to encrypt the AES private key encoded in base64 and place it under the ‘key’ parameter. Lastly, order all public messaging parameters in ascending order, and concatenate using
key=value&key=value (excluding null values). Use your own RSA private key
to encrypt in base64 and place the signature value under the ‘sign’ field.

Once you’ve received the response parameters, similarly, encrypt them as mentioned above, using the SUNRATE public key to authenticate and using the SUNRATE private key to decode and retrieve the AES private key. Use the AES private key to decode the operational parameters to retrieve the operational parameters.

Note: The RSA private key is 1024-bits.

Generate AES Private Key

Generate a random 16-digit AES private key including alphanumeric values.

RSA Encrypt AES Key

Use SUNRATE's public key to RSA encrypt the AES key.
\n
Base64 encode the encrypted result.
\n
The encoded value is value of key.
\n

Encrypt Request Body

Use AES symmetric encryption on the request body (specific business parameters).
\n
Base64 encode the encrypted result.
\n
The encoded value is value of requestBody.
\n

Generate Signature

Remove the sign field from the request message.
\n
Sort the non-empty fields in ascending order based on the ASCII value of the first character; for fields with the same first character, sort them by the ASCII value of the second character, and so on.
\n
Combine the sorted parameters in key=value format and connect them with the & character.
\n
Use the merchant's private key to SHA256WithRSA sign the combined string.
\n
Base64 encode the signature result.
\n
The encoded value is value of sign.
\n

Construct Final Request

Combine key, requestBody, and sign to form the final request. (Refer to Public Request Headers)

API Overview

Network Protocol

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Type	Description
Network Protocol	HTTP
Request Method	POST
Data Format	application/json
Character Encoding	UTF-8

Public Request & Response

Public Request Headers

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Length	Required/Optional	Details
channelId	String	21	M	Unique identifier of a client who will be submitting client information to SUNRATE Channel ID will be assigned by SUNRATE
acctId	String	8	M	Unique 8-digit client account identifier assigned by SUNRATE Note: acctId is not required in calling Submit KYC
msgId	String	21	M	The request message ID
bizId	String	21	O	Business ID
ip	String	15	M	User’s browser IP address
version	String	5	M	Endpoint version. Fixed value “3.0”
callbackUrl	String	256	O
timestamp	String	23	M	Timestamp of request，formatted as \"yyyy-MM-ddTHH:mm:ss.SSS\" For example, 2008-08-08T08:08:08.888
key	String	16	M	Private key value of 16-digit AES after encryption. The 16-digit AES key is to be generated randomly by client.
sign	String		M	Signature value
requestBody	String		M	Encrypted request body. Note: format the request in JSON before encryption. No restriction on max. length

Public Response Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Length	Required/Optional	Details
msgId	String	21	M	Serial number of response message.
code	String	6	M	Response code
				“000000” indicates a successful request.
msg	String	128	M	Response message
timestamp	String	23	M	Timestamp of response，formatted as \"yyyy-MM-ddTHH:mm:ss.SSS\" For example, 2008-08-08T08:08:08.888
key	String	16	M	Private key value of 16-digit AES after encryption
sign	String		M	Signature value
responseBody	String		M	Encrypted response body. Refer to response parameters.

International Payments API list

Module	Name	Endpoint
Onboarding	Submit KYC	/openapi/v3/register/create/
	Receive KYC status update	Provided by client
	Update KYC	/openapi/v3/register/modify/
	Query KYC	/openapi/v3/register/get/
Collections	Receive fund arrival notice	Provided by client
	Receive collection status update	Provided by client
	Query collection details	/openapi/v3/transin/globalCollectionAccount/get/
	Query collections	/openapi/v3/transin/globalCollectionAccount/list/
Payees	Create payee	/openapi/v3/beneficiary/create/
	Receive payee status update	Provided by client
	Update payee	/openapi/v3/beneficiary/modify/
	Query payee	/openapi/v3/beneficiary/get/
	Query payees	/openapi/v3/beneficiary/list/
Payouts	Query exchange rate	/openapi/v3/trade/queryPrice/
	Create payout	/openapi/v3/trade/create/
	Create payout without quote	/openapi/v3/trade/marketOrder/
	Receive payout status update	Provided by client
	Query payout	/openapi/v3/trade/get/
	Query payouts	/openapi/v3/trade/list/
	Download confirmation	/openapi/v3/voucher/transFile/download/
Trade	Get quote	/openapi/v3/fxquote/getSingleQuote
	Create trade	/openapi/v3/fxtxn/createFxTxn
	Settle trade	/openapi/v3/fxtxn/dealFxTxn
	Query trade	/openapi/v3/fxtxn/getFxTxn
	Fund for trade	/openapi/v3/acctbal/trans
	Query balance for trade	/openapi/v3/acctbal/listAcctBal
	Query trade records	/openapi/v3/acctjnl/getAcctJnl
Book Transfers	Create transfer	/openapi/v3/ transfer/create/
	Query outward transfer	/openapi/v3/ transfer/get/
	Query outward transfers	/openapi/v3/ transfer/listOut/
	Query inward transfers	/openapi/v3/ transfer/listIn/
Finance	Query balance	/openapi/v3/balance/list/
	Query statement	/openapi/v3/acctFlow/query/

","_postman_id":"bfe906c2-a996-4777-a319-b659b207248c","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-API-Key"},{"key":"value","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"7245cd17-b114-4f58-8936-dafbbfaf4ccc","id":"7245cd17-b114-4f58-8936-dafbbfaf4ccc","name":"Full-Stack Payments","type":"collection"}}},{"name":"Global Merchant Acquiring","item":[{"name":"Online Payment","item":[{"name":"Alternative Payments","item":[{"name":"Direct Payment","id":"b70e4644-bd30-495c-a939-4c7d8a599871","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"url":"/api/v5/createorder","description":"

Direct Payment

API description

Provide online payment function for merchants, applicable to UnionPay, Alipay, Alipay+, WeChat Pay and so on.

Transaction process

/createorder The merchant system submit a payment request to the SUNRATE system to obtain payment parameters. Merchants open the user's payment page through payment parameters, and the user makes the payment.
\n
Payment Result Notification After the user successfully makes the payment, the merchant system will receive a notification of the payment result.
\n
/order_query, supports merchant systems to actively query the payment status of orders, this step is optional.
\n

Request path

\n
POST /api/v5/createorder
\n

Request parameters

Parameter	Value Type	Status	Description
paymentMethod	String	Required	Payment method. Go to Payment Methods for details.
consumerArea	String	Required	Consumer area. 2-digit ISO country code, such as: `CN`. Refer to paymentMethod for details.
tradeFrom	String	Required	Transaction scenarios:`H5`,`WEB`,`JSAPI`,`APPLET`,`QRCODE`,`SDK` ,`EXT`
orderNum	String	Required	Order number. Defined by the merchant, and the order number must not be repeated for the same merchant ID.
orderAmount	String	Required	Order amount. For example \"100\" or \"100.00\"
orderCurrency	String	Required	Order currency. ISO standard, such as \"CNY\", \"USD\" and so on.
frontURL	String	Required	Redirect to this URL by `GET` method with [Payment Result Notification] when payment is completed.
backURL	String	Required	Asynchronously request this URL by `POST JSON` method to send [Payment Result Notification], and the URL required to response String `OK`, otherwise SUNRATE will resend the result in intervals of [15, 15, 30, 180, 1800, 3600, 7200, 14400, 14400] seconds.
merID	String	Required	Merchant ID, assigned by SUNRATE.
goodsInfo	String	Required	Goods information. Note: Don't include special symbols, such as \"#\", \"&\", \"+\", etc.
detailInfo	String	Required	Base64 encoded goods details. The goods details consist of \"goods_name\" and \"quantity\", and in JSON array format. Note: \"goods_name\" can't include special symbols, such as \"#\", \"&\", \"+\", etc. Example goods details: [{\"goods_name\":\"iPhone X\",\"quantity\":\"2\"},{\"goods_name\":\"iPhone 8\",\"quantity\":\"4\"}] Example input value: \"W3siZ29vZHNfbmFtZSI6ImlQaG9uZSBYIiwicXVhbnRpdHkiOiIyIn0seyJnb29kc19uYW1lIjoiaVBob25lIDgiLCJxdWFudGl0eSI6IjQifV0=\"
transTime	String	Required	Transaction time. Format: \"yyyyMMddHHmmss\"
merReserve	String	Optional	Merchant reserved content, customized by the merchant. Note: Don't include special symbols, such as \"#\", \"&\", \"+\", etc.
osType	String	Required	User's OS type. Options: \"IOS\", \"ANDROID\", \"WINDOWS\", \"MAC\", \"OTHER\"
osVersion	String	Optional	User's OS version. Example: \"10.0.19043\"
userIP	String	Required	User IP
userID	String	Required	The user's unique ID at the merchant.
logisticsAddress	String	Required	Shipping address. If it is a virtual item, fill in the user's email.
openid	String	Conditional	WeChat openid. Required for WeChat Mini Program.
documentId	String	Optional	Payer document ID number
email	String	Optional	Consumer E-Mail
profitSharing	Boolean	Optional	Only applicable to profit sharing
signType	String	Required	\"SHA256\"
signature	String	Required	Signature

Response parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Value Type	Status	Description
respCode	String	Required	Response code. \"00\" stands for success. [More]
respMsg	String	Required	Response message
merID	String	Required	Merchant ID
orderNum	String	Required	Order number
transID	String	Conditional	Transaction ID
parameter	Object	Conditional	Payment parameters. Go to Response parameter `parameter` description for details.

Response parameter `parameter` description

Web page mode (tradeFrom=****H5,WEB,JSAPI****)

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Value Type	Status	Description
payUrl	String	Conditional	Payment URL

Mini Program / SDK mode (tradeFrom=****APPLET,SDK****)

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Value Type	Status	Description
sdk_params	Object	Conditional	Mini Program payment parameters.

QRCODE mode (tradeFrom=QRCODE)

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Value Type	Status	Description
code_url	String	Conditional	QR code string
image_url	String	Conditional	QR code picture

EXT mode (tradeFrom=EXT)
For details, please refer to Payment Method Extra .

References

Payment method details

Cashier Payment

API description

Applicable to SUNRATE Cashier and international card.

Transaction process

Request path

\n
POST /api/v5/createcashier
\n

Request parameters

It consists of General parameters and Special parameters. All upload parameters must be signed.

General parameters:

Parameter	Value Type	Status	Description
paymentMethod	String	Required	Payment method. `sunrate_cashier`
filters	String	Optional	Only works if paymentMethod is \"sunrate_cashier\". Its value is a specific payment brand, such as \"unionpay\" or \"alipay_cn\" and so on. Or multiple payment brands, separated by commas, like \"unionpay,alipay_cn\". If no this field, all matching payment brands are displayed. Options: Payment brands
orderNum	String	Required	Order number. Defined by the merchant, and the order number must not be repeated for the same merchant ID.
orderAmount	String	Required	Order amount. For example \"100\" or \"100.00\"
orderCurrency	String	Required	Order currency. ISO standard, such as \"CNY\", \"USD\" and so on.
frontURL	String	Required	Redirect to this URL by `GET` method with [Payment Result Notification] when payment is completed.
backURL	String	Required	Asynchronously request this URL by `POST JSON` method to send [Payment Result Notification], and the URL required to response String `OK`, otherwise SUNRATE will resend the result in intervals of [15, 15, 30, 180, 1800, 3600, 7200, 14400, 14400] seconds.
merID	String	Required	Merchant ID, assigned by SUNRATE.
goodsInfo	String	Required	Goods information. Note: Don't include special symbols, such as \"#\", \"&\", \"+\", etc.
detailInfo	String	Required	Base64 encoded goods details. The goods details consist of \"goods_name\" and \"quantity\", and in JSON array format. Note: \"goods_name\" can't include special symbols, such as \"#\", \"&\", \"+\", etc. Example goods details: [{\"goods_name\":\"iPhone X\",\"quantity\":\"2\"},{\"goods_name\":\"iPhone 8\",\"quantity\":\"4\"}] Example input value: \"W3siZ29vZHNfbmFtZSI6ImlQaG9uZSBYIiwicXVhbnRpdHkiOiIyIn0seyJnb29kc19uYW1lIjoiaVBob25lIDgiLCJxdWFudGl0eSI6IjQifV0=\"
transTime	String	Required	Transaction time. Format: \"yyyyMMddHHmmss\"
merReserve	String	Optional	Reserved content, customized by the merchant. Note: Don't include special symbols, such as \"#\", \"&\", \"+\", etc.
osType	String	Required	User's OS type. Options: \"IOS\", \"ANDROID\", \"WINDOWS\", \"MAC\", \"OTHER\"
osVersion	String	Optional	User's OS version. Example: \"10.0.19043\"
userIP	String	Required	User IP
userID	String	Required	The user's unique ID at the merchant.
logisticsAddress	String	Required	Shipping address. If it is a virtual item, fill in the user's email.
documentId	String	Optional	Payer document ID number
consumerArea	String	Optional	The country and region code for the payment method that the merchant has enabled. Default: all consumer area.
profitSharing	Boolean	Optional	Only applicable to profit sharing
signType	String	Required	\"SHA256\"
signature	String	Required	Signature

\n
Special parameters
\n

Order logistics information
\n
Some payment methods require submission of logistics information for orders. Merchants should confirm with SUNRATE support team during development testing.
\n

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Value Type	Status	Description
logisticsCountry	String	Conditional	Logistics country/region, 2-digit country code, such as: US
logisticsState	String	Conditional	Logistics state/province/state, 2-digit code, such as: CA
logisticsCity	String	Conditional	Logistics city
logisticsStreet	String	Conditional	Logistics street
logisticsPostalCode	String	Conditional	Logistics zip code
logisticsEmail	String	Conditional	Logistics email
logisticsPhone	String	Conditional	Logistics phone
logisticsHouseNo	String	Conditional	Logistics house number or name

Response parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Value Type	Status	Description
respCode	String	Required	Response code. \"00\" stands for success. [More]
respMsg	String	Required	Response message
merID	String	Required	Merchant ID
orderNum	String	Required	Order number
transID	String	Conditional	SUNRATE transaction ID. Returned if paymentMethod is \"international_card\"
parameter	Object	Conditional	Payment parameters. Go to [Response parameter parameter description] for details.

Response parameter `parameter` description

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Value Type	Status	Description
payUrl	String	Conditional	Payment URL

References

Payment method details

Cashier Payment - Card

API description

Applicable to SUNRATE Cashier and bank card payment.

Transaction process

Request path

\n
POST /api/v5/createcashier
\n

Request parameters

It consists of General parameters and Special parameters. All upload parameters must be signed.

General parameters:

Parameter	Value Type	Status	Description
paymentMethod	String	Required	Payment method: `card`
transType	String	Required	Transaction type: `PURC` - Purchase,`PAUT` - Authorization
orderNum	String	Required	Order number. Defined by the merchant, and the order number must not be repeated for the same merchant ID.
orderAmount	String	Required	Order amount. For example \"100\" or \"100.00\"
orderCurrency	String	Required	Order currency. ISO standard, such as \"CNY\", \"USD\" and so on.
frontURL	String	Required	Redirect to this URL by `GET` method with [Payment Result Notification] when payment is completed.
backURL	String	Required	Asynchronously request this URL by `POST JSON` method to send [Payment Result Notification], and the URL required to response String `OK`, otherwise SUNRATE will resend the result in intervals of [15, 15, 30, 180, 1800, 3600, 7200, 14400, 14400] seconds.
merID	String	Required	Merchant ID, assigned by SUNRATE.
goodsInfo	String	Required	Goods information. Note: Don't include special symbols, such as \"#\", \"&\", \"+\", etc.
detailInfo	String	Required	Base64 encoded goods details. The goods details consist of \"goods_name\" and \"quantity\", and in JSON array format. Note: \"goods_name\" can't include special symbols, such as \"#\", \"&\", \"+\", etc. Example goods details: [{\"goods_name\":\"iPhone X\",\"quantity\":\"2\"},{\"goods_name\":\"iPhone 8\",\"quantity\":\"4\"}] Example input value: \"W3siZ29vZHNfbmFtZSI6ImlQaG9uZSBYIiwicXVhbnRpdHkiOiIyIn0seyJnb29kc19uYW1lIjoiaVBob25lIDgiLCJxdWFudGl0eSI6IjQifV0=\"
transTime	String	Required	Transaction time. Format: \"yyyyMMddHHmmss\"
merReserve	String	Optional	Reserved content, customized by the merchant. Note: Don't include special symbols, such as \"#\", \"&\", \"+\", etc.
osType	String	Required	User's OS type. Options: \"IOS\", \"ANDROID\", \"WINDOWS\", \"MAC\", \"OTHER\"
osVersion	String	Optional	User's OS version. Example: \"10.0.19043\"
userIP	String	Required	User IP
userID	String	Required	The user's unique ID at the merchant.
logisticsAddress	String	Required	Shipping address. If it is a virtual item, fill in the user's email.
documentId	String	Optional	Payer document ID number
consumerArea	String	Optional	The consumer area code for the payment method that the merchant has enabled. Default: All consumer area.
profitSharing	Boolean	Optional	Only applicable to profit sharing
signType	String	Required	\"SHA256\"
signature	String	Required	Signature

\n
Special parameters
\n

Order logistics information
\n
Some payment methods require submission of logistics information for orders. Merchants should confirm with SUNRATE support team during development testing.
\n

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Value Type	Status	Description
logisticsCountry	String	Conditional	Logistics country/region, 2-digit country code, such as: US
logisticsState	String	Conditional	Logistics state/province/state, 2-digit code, such as: CA
logisticsCity	String	Conditional	Logistics city
logisticsStreet	String	Conditional	Logistics street
logisticsPostalCode	String	Conditional	Logistics zip code
logisticsEmail	String	Conditional	Logistics email
logisticsPhone	String	Conditional	Logistics phone
logisticsHouseNo	String	Conditional	Logistics house number or name

Response parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Value Type	Status	Description
respCode	String	Required	Response code. \"00\" stands for success. [More]
respMsg	String	Required	Response message
merID	String	Required	Merchant ID
orderNum	String	Required	Order number
transID	String	Conditional	SUNRATE transaction ID. Returned if paymentMethod is \"international_card\"
parameter	Object	Conditional	Payment parameters. Go to [Response parameter parameter description] for details.

Response parameter `parameter` description

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Value Type	Status	Description
payUrl	String	Conditional	Payment URL

References

Payment method details

Card Payment - Capture

API description

This API is used to perform capture (settlement) for card authorization transactions.

When the transType (transaction type) of the following APIs is set to PAUT (Authorization / Pre-authorization):

Cashier Payment - Card
\n
Direct Payment - Card
\n

The Merchant must invoke the Card Payment - Capture API to complete the fund capture.
Otherwise, the authorized transaction will not be settled.

This API is applicable to scenarios where authorization is performed first and capture is completed later, including but not limited to:

Hotel pre-authorization
\n
Car rental deposit transactions
\n
Other delayed capture business scenarios
\n

Transaction process

Request path

\n
POST /api/v5/capture
\n

Request parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Value Type	Status	Description
orderNum	String	Required	Capture order number
origOrderNum	String	Required	Original authorization order number
merID	String	Required	Merchant ID
captureAmount	String	Required	Capture Amount
orderCurrency	String	Required	Order currency. Same as the payment order currency.
paymentBrand	String	Required	Payment brand. Returned by Payment Result Notification or Payment Result Inquiry.
transTime	String	Required	Transaction time. Format: \"yyyyMMddHHmmss\"
signType	String	Required	\"SHA256\"
signature	String	Required	Signature

Response parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Value Type	Status	Description
transType	String	Required	\"PURC\"
orderNum	String	Required	Order number.
transID	String	Required	Transaction ID.
merID	String	Required	Merchant ID.
transAmount	String	Required	Capture Amount
transCurrency	String	Required	Order currency.
paymentBrand	String	Required	Payment brand.
respCode	String	Required	Response code. \"00\" stands for success. [More]
respMsg	String	Required	Response message
transTime	String	Required	Transaction time.
gwTime	String	Required	Gateway time. Format: \"yyyyMMddHHmmss\"
signType	String	Required	\"SHA256\"
signature	String	Required	Signature

Payment Result Notification

Function description

SUNRATE returns the successful payment result to backURL.

Request method

\n
Request direction SUNRATE → Merchant
\n

POST backURL

Data format JSON

Request parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Value Type	Status	Description
transType	String	Required	\"PURC\"
orderNum	String	Required	Order number
orderAmount	String	Required	Order amount
orderCurrency	String	Required	Order currency
merID	String	Required	Merchant ID
respCode	String	Required	Response code. \"00\" stands for success.
respMsg	String	Required	Response message.
transID	String	Required	SUNRATE transaction ID
gwTime	String	Required	SUNRATE gateway time. Format: \"yyyyMMddHHmmss\"
transTime	String	Required	Transaction time.
merReserve	String	Optional	Merchant reserved content.
paymentBrand	String	Required	Payment brand. Details
signType	String	Required	\"SHA256\"
signature	String	Required	Signature

Response parameters

String OK

Payment Result Inquiry

API description

Applicable to Payment Result Inquiry.

Request path

\n
POST /api/v5/order_query
\n

Request parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Value Type	Status	Description
paymentMethod	String	Required	Payment method. Same as the value of Payment API.
orderNum	String	Required	Payment order number. Same as the value of Payment API.
merID	String	Required	Merchant ID, assigned by SUNRATE
transTime	String	Required	Transaction time. Format: \"yyyyMMddHHmmss\"
signType	String	Required	\"SHA256\"
signature	String	Required	Signature

Response parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Value Type	Status	Description
transType	String	Required	Transaction type. `PURC` - Purchase,`PAUT` - Authorization
orderNum	String	Required	Payment order number.
transID	String	Conditional	SUNRATE transaction ID. Returned when respCode is \"00\".
paymentBrand	String	Conditional	Payment brand. Returned when respCode is \"00\".
merID	String	Required	Merchant ID.
respCode	String	Required	Response code. \"00\" stands for success. [More]
respMsg	String	Required	Response message.
transTime	String	Required	Transaction time.
gwTime	String	Required	SUNRATE gateway time. Format: \"yyyyMMddHHmmss\"
signType	String	Required	\"SHA256\"
signature	String	Required	Signature

Refund

API description {docsify-ignore}

Applicable to Refund function.

Used after the payment is successful. Both the payment order number and refund order number are required, and the refund order number is different from the payment order number.
\n
Merchant refund amount shall not be greater than the successful payment amount.
\n

Transaction process

Request path

\n
POST /api/v5/refund
\n

Request parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Value Type	Status	Description
orderNum	String	Required	Refund order number. Defined by the merchant, and it must not be repeated for the same merchant ID and is different from the payment order number.
origOrderNum	String	Required	Payment order number.
returnAmount	String	Required	Refund amount. For example \"100\" or \"100.00\"
orderCurrency	String	Required	Order currency. Same as the payment order currency.
merID	String	Required	Merchant ID, assigned by GoAllPay.
paymentBrand	String	Required	Payment brand. Returned by Payment Result Notification or Payment Result Inquiry.
transTime	String	Required	Transaction time. Format: \"yyyyMMddHHmmss\"
backURL	String	Required	Refund results are asynchronously notified to this URL. After the refund is successful, the GoAllPay server will call the backURL by `POST JSON` method to notify the [Refund Result Notification]. When merchant receive the notification, it is required to response String `OK`, or GoAllPay will resend the result, the second interval is [15, 15, 15, 30, 180, 1800, 3600, 7200, 14400].
signType	String	Required	\"SHA256\"
signature	String	Required	Signature

Response parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Value Type	Status	Description
transType	String	Required	\"REFD\"
orderNum	String	Required	Refund order number.
transID	String	Required	GoAllPay refund transaction ID.
merID	String	Required	Merchant ID.
paymentBrand	String	Required	Payment brand.
respCode	String	Required	Response code. \"00\" stands for success. [More]
respMsg	String	Required	Response message
transTime	String	Required	Transaction time.
gwTime	String	Required	GoAllPay gateway time. Format: \"yyyyMMddHHmmss\"
returnAmount	String	Required	Refund amount.
orderCurrency	String	Required	Order currency.
signType	String	Required	\"SHA256\"
signature	String	Required	Signature

Refund Result Notification

Function description

SUNRATE returns the successful refund result to backURL.

Request method

\n
Request direction SUNRATE → Merchant
\n

POST backURL

Data format JSON

Request parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Value Type	Status	Description
transType	String	Required	\"REFD\"
orderNum	String	Required	Refund order number.
transID	String	Required	SUNRATE refund transaction ID.
merID	String	Required	Merchant ID.
paymentBrand	String	Required	Payment brand. Details
respCode	String	Required	Response code. \"00\" stands for success.
respMsg	String	Required	Response message.
transTime	String	Required	Transaction time.
gwTime	String	Required	SUNRATE gateway time. Format: \"yyyyMMddHHmmss\"
returnAmount	String	Required	Refund amount.
orderCurrency	String	Required	Order currency.
signType	String	Required	\"SHA256\"
signature	String	Required	Signature

Response parameters

String OK

Refund Result Inquiry

API description

Applicable to Refund Result Inquiry.

Request path

\n
POST /api/v5/refund_query
\n

Request parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Value Type	Status	Description
paymentBrand	String	Required	Payment brand. Same as the value of Refund API.
orderNum	String	Required	Refund order number. Same as the value of Refund API.
merID	String	Required	Merchant ID, assigned by SUNRATE
transTime	String	Required	Transaction time. Format: \"yyyyMMddHHmmss\"
signType	String	Required	\"SHA256\"
signature	String	Required	Signature

Response parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Value Type	Status	Description
transType	String	Required	Transaction type. \"REFD\"
orderNum	String	Required	Refund order number.
transID	String	Conditional	SUNRATE transaction ID. Returned when respCode is \"00\".
paymentBrand	String	Conditional	Payment brand. Returned when respCode is \"00\".
merID	String	Required	Merchant ID.
respCode	String	Required	Response code. \"00\" stands for success. [More]
respMsg	String	Required	Response message.
transTime	String	Required	Transaction time.
gwTime	String	Required	SUNRATE gateway time. Format: \"yyyyMMddHHmmss\"
signType	String	Required	\"SHA256\"
signature	String	Required	Signature

Overview

\n
Version: V5.3.6
\n

Update Time: 2026/2/24

Online merchants can integrate global payments through API or SDK.

Service hosts

Test environment host: https://test-api.xunhuiacq.com
Production environment host: https://api.acq.sunrate.com

Signature rules

For the request message sent to the Acquirer system, in which all incoming parameters (except parameter signature) according to the field name of ASCII smallest sequence (dictionary), using the format of the URL key/value pair (key1 = value1 & key2 = value2... ) spliced into a string string1.
\n
At the end of string1, the signature Key (assigned at Acquirer upon access) agreed by both parties is spliced directly (no need to connect with \"&\"), resulting in a stringSignTemp string, and an encryption on stringSignTemp to get the value of signature (The encryption algorithm is subject to the parameter \"signType\" value).
\n
Example of signing process:
\n

string1: backURL=https://testapi.xxxxxx.com/test&detailInfo=W3siZ29vZHNfbmFtZSI6ICJhcHBsZSIsICJxdWFudGl0eSI6ICIyIn1d&frontURL=https://example.com&goodsInfo=apples&logisticsAddress=Room 2203 ,Wang Sin House ,Cheung Wang Estate, Tsing Yi,Hong Kong&merID=merchant_id&merReserve=&orderAmount=0.1&orderCurrency=CNY&orderNum=231225140859743282&osType=WINDOWS&osVersion=&paymentMethod=unionpay&signType=SHA256&tradeFrom=WEB&transTime=20231225140859&userID=user01&userIP=116.230.182.159\nstringSignTemp: backURL=https://testapi.xxxxxx.com/test&detailInfo=W3siZ29vZHNfbmFtZSI6ICJhcHBsZSIsICJxdWFudGl0eSI6ICIyIn1d&frontURL=https://example.com&goodsInfo=apples&logisticsAddress=Room 2203 ,Wang Sin House ,Cheung Wang Estate, Tsing Yi,Hong Kong&merID=merchant_id&merReserve=&orderAmount=0.1&orderCurrency=CNY&orderNum=231225140859743282&osType=WINDOWS&osVersion=&paymentMethod=unionpay&signType=SHA256&tradeFrom=WEB&transTime=20231225140859&userID=user01&userIP=116.230.182.159key\nsignature: 7542b52fe5fa81d79390187bba0babe8e66ff6164c1993b1f707e4ab8fe73911\n\n

APIs

Alternative Payments

Direct Payment

Direct Payment: Merchants initiate payment requests through this interface using a specified method.

\n\n

Cashier Payment

Cashier Payment: Merchants initiate aggregated cashier payment through this interface. On the cashier page, users can choose from various payment methods, including international credit cards and local cards.

\n\n

We recommend merchants to use Cashier Payment Mode, which has the following advantages:

When merchants need to add new payment methods, there is no need for technical changes;
\n
Reduced technology development volume for merchants
\n

Bank Card Payments

Cashier Payment - Card

This API enables merchant customers to make bank card payments through the checkout counter.

Direct Payment - Card

This API provides merchants with the capability for backend payment processing of international credit cards. It requires merchants' systems to be PCI DSS certified and to ensure user data security in compliance with PCI DSS standards.

Card Payment Capture

This API is used to perform capture (settlement) for card authorization transactions.

When the transType (transaction type) of the following APIs is set to PAUT (Authorization / Pre-authorization):

Cashier Payment - Card
\n
Direct Payment - Card
\n

The Merchant must invoke the Card Payment - Capture API to complete the fund capture.
Otherwise, the authorized transaction will not be settled.

This API is applicable to scenarios where authorization is performed first and capture is completed later, including but not limited to:

Hotel pre-authorization
\n
Car rental deposit transactions
\n
Other delayed capture business scenarios
\n

Payment Result Notification

Acquirer system returns the successful payment result to backURL.

Payment Result Inquiry

Applicable to Payment Result Inquiry.

Refund

Applicable to Refund function.

Used after the payment is successful. Both the payment order number and refund order number are required, and the refund order number is different from the payment order number.
\n
Merchant refund amount shall not be greater than the successful payment amount.
\n

Refund Result Notification

Acquirer returns the successful refund result to backURL.

Refund Result Inquiry

Applicable to Refund Result Inquiry.

Appendixes

\n","_postman_id":"21750d79-2d9a-484f-b6f9-f41120312e71","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-API-Key"},{"key":"value","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"7245cd17-b114-4f58-8936-dafbbfaf4ccc","id":"7245cd17-b114-4f58-8936-dafbbfaf4ccc","name":"Full-Stack Payments","type":"collection"}}}],"id":"c9784f17-d66b-4ead-a250-81158051eb68","_postman_id":"c9784f17-d66b-4ead-a250-81158051eb68","description":"","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-API-Key"},{"key":"value","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"7245cd17-b114-4f58-8936-dafbbfaf4ccc","id":"7245cd17-b114-4f58-8936-dafbbfaf4ccc","name":"Full-Stack Payments","type":"collection"}}}],"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-API-Key"},{"key":"value","value":"{{token}}"}]}},"event":[{"listen":"prerequest","script":{"id":"898b352a-f664-4aee-9f9a-b4bcf106236a","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"9ed27871-ba7d-4b8b-acc5-8552ada8de3d","type":"text/javascript","exec":[""]}}],"variable":[{"key":"baseUrl","value":""}]}

velocityControl

perTransactionLimit

velocityList

riskCtrl

shippingAddress

📒 Developer's Guide

⚙️Integration Process

🔒Security Solution

Generate AES Private Key

RSA Encrypt AES Key

Encrypt Request Body

Generate Signature

Construct Final Request

API Overview

Network Protocol

Public Request & Response

Public Request Headers

Public Response Parameters

International Payments API list

Direct Payment

API description

Transaction process

Request path

Request parameters

Response parameters

Response parameter parameter description

References

Cashier Payment

API description

Transaction process

Request path

Request parameters

Response parameters

Response parameter parameter description

References

Cashier Payment - Card

API description

Transaction process

Request path

Request parameters

Response parameters

Response parameter parameter description

References

Card Payment - Capture

API description

Transaction process

Request path

Request parameters

Response parameters

Payment Result Notification

Function description

Request method

Request parameters

Response parameters

Payment Result Inquiry

API description

Request path

Request parameters

Response parameters

Refund

API description {docsify-ignore}

Transaction process

Request path

Request parameters

Response parameters

Refund Result Notification

Function description

Request method

Request parameters

Response parameters

Refund Result Inquiry

API description

Request path

Request parameters

Response parameters

Overview

Service hosts

Signature rules

APIs

Alternative Payments

Response parameter `parameter` description

Response parameter `parameter` description

Response parameter `parameter` description