pullTransactionDataSignature required
WorldFirst collects transaction data after transfers. This process is completed by WorldFirst calling the Partner with the pullTransactionData interface.
WorldFirst pulls transaction data from the Partner on the next day after a transfer is initiated.
Note: Before WorldFirst pulls transaction data, the Partner needs to gain authorization for accessing transaction data from the Customer.
Structure
A message consists of a header and body. The following sections are focused on the body structure. For the header structure, see:
Request parameters
referenceCustomerId String REQUIRED
The unique ID assigned by the Partner to identify a Customer. This is used for idempotence control when Customers apply for Receiving Accounts.
More information:
- Maximum length: 64 characters
extBizPartnerId String REQUIRED
The unique ID assigned by WorldFirst to identify an external Partner that is not onboard with WorldFirst.
More information:
- Maximum length: 64 characters
pageIndex Integer REQUIRED
Page number of the transaction data that WorldFirst pulls from. For example, for a total number of 20 pieces of data, the pageIndex is 1 and pageSize is 20
More information:
- Maximum length: 8 characters
pageSize Integer REQUIRED
Number of the transaction data per page. The default value for pageSize is 37. For example: for a total number of 20 pieces of data, the pageIndex is 1 and pageSize is 20.
More information:
- Maximum length: 8 characters
startTime DateTime object REQUIRED
Indicates the starting time of the transaction record.
More information:
- The value follows the ISO 8601 standard format. For example, "2019-11-27T12:01:01+08:00".
endTime DateTime object REQUIRED
Indicates the ending time of the transaction record.
More information:
- The value follows the ISO 8601 standard format. For example, "2019-11-27T12:01:01+08:00".
Response parameters
result Result REQUIRED
Indicates whether this API is called successfully.
referenceCustomerId String REQUIRED
The unique ID assigned by the Partner to identify a Customer. This is used for idempotence control when Customers apply for Receiving Accounts.
More information:
- Maximum length: 64 characters
extBizPartnerId String REQUIRED
The unique ID assigned by WorldFirst to identify an external Partner that is not onboard with WorldFirst.
More information:
- Maximum length: 64 characters
totalPageNumber Integer REQUIRED
Number of the pages that the Partner submits in total.
More information:
- Maximum length: 8 characters
pageIndex Integer REQUIRED
Page number of the transaction data that WorldFirst pulls from. For example, for a total number of 20 pieces of data, the pageIndex is 1 and pageSize is 20
More information:
- Maximum length: 8 characters
pageSize Integer REQUIRED
Number of the transaction data per page. The default value for pageSize is 37. For example: for a total number of 20 pieces of data, the pageIndex is 1 and pageSize is 20.
More information:
- Maximum length: 8 characters
startTime DateTime object REQUIRED
Indicates the starting time of the transaction record.
More information:
- The value follows the ISO 8601 standard format. For example, "2019-11-27T12:01:01+08:00".
endTime DateTime object REQUIRED
Indicates the ending time of the transaction record.
More information:
- The value follows the ISO 8601 standard format. For example, "2019-11-27T12:01:01+08:00".
transactionDataList List<TransactionData> REQUIRED
A list of the transaction details. If there is no relevant transaction data, leave the list empty.