As a Branch partner you can access transaction data from PayAdmin. To help automate your integration however Branch can upload standard or custom reports for you to a Branch-hosted shared SFTP folder.

Reports are available as enterprise reports, for all partners, and white label reports for white label partners. Speak with your Branch team for more details.

Standard reports:

Disbursement report line item detail of all attempted disbursements sent the previous day.
Invoice summary report line item detail of all invoices generated the previous day.

See details about the content of these files below.

Delivery Timing

White label report files are sent daily at roughly 13:30 UTC.

Enterprise report files are sent daily at roughly 17:00 UTC.

Set up SFTP

Working with your Branch team, generate a key pair and send Branch the public SSH key.

Your Branch team will set up the connection and send you details similar to the following:

Host: ftp.branchmessenger.io

Port: 22

User: [orgkey]

Directories: 

/in - Inbound files sent to Branch. Branch will pull from this directory.

/out - Outbound files sent from Branch. Branch will push to this directory. 

Auth: Authenticated by public key provided.

Path example

sftp -i /path/to/private/key [orgkey]@ftp.branchmessenger.io

Transaction File Details

Disbursement report detail

Column Name	Example Data
CREATED_DATE	2023-09-17 14:01:00+00:00
WORKER_ID	68034
NAME	Daphnee Anderson
AMOUNT	969.66
TYPE	DEPOSIT
INVOICE_ID	1845861
EXTERNAL_STORE_ID	(Blank)
STATUS	COMPLETED
STATUS_REASON	(Blank)
DESCRIPTION	Timecard InstaPay for work date 2023-09-16 6:30 PM - 7:10 AM
TRANSACTION_ID	a16b8c00-5562-11ee-9272-8bd2fed25a80
SCHEDULED_DATE	N/A
INVOICE_STATUS	COMPLETED
INVOICE_FINALIZED_DATE	2023-09-18 06:18:08+00:00
METADATA (name can vary, ex: TIMECARD ID)	1988326

Invoicing Summary Report detail

Column Name	Example Data
INVOICE_ID	1847198
INVOICE_DATE	2023-09-17
DESCRIPTION	Acme Invoice Configuration
TOTAL	23201.62
FUNDING_SOURCE	1181961
STATUS	COMPLETED

Branch can send you a data file detailing card transactions for a specified time period. Branch sends the file daily by default, but you can choose to receive it less frequently.

File Type

\[file type}\_file_YYYYMMDD_YYYYMMDD_YYYYMMDDhhmmss.csv

1st YYYYMMDD is start date of file (>=)

2nd YYYYMMDD is end date of file (\<)

YYYYMMDDhhmmss is when file was pulled

start and end date will be filled with 00000000 for historic pull

Field	Format	Date Filter Field	Description	Nullable	Primary Key
event_timestamp	TIMESTAMP	Y	The timestamp (UTC) when a transaction occured or cleared. cleared transactions will occur in bulk batch processes	N
event_token	STRING			N	Y
initiating_event_id	STRING		Initiating transaction id to link auths (initiating) to clearings, auths (initiating) to cash back and backup balance (initiating) to repayment. For auths that include multiple events (i.e.auth advice), the initiating transaction is the same and event_timestamp can be used to determine the order of the events. NOTE: returns/refunds DO NOT map to their originating authorization. The network does not provide this information.	Y
event_type	STRING		Label of overal "swipe" of card, either 'Signature', 'Pindebit' or 'Load' -- Authorizations do NOT impact users balance	Y
event_subtype	STRING		Branch categorization of transaction: Authorization, Clearing or type of Load (Reward, Cashback, Disbursement)	N
kpi	STRING		Branch categorization of transaction: ACH_Transfer, ATM_In_Network, ATM_Out_Network, Card_Spend, Instant_Transfer, Non_Payout_Deposits, Reversals_and_Refunds	N
transaction_type	STRING		Raw transaction label from marqeta	N
card_type	STRING		Labels a card as physical or virtual	Y
card_product	STRING		Labels a unqiue card product, if multiple exist within a given card program	Y
merchant	STRING		Clean merchant name	Y
merchant_category_code	STRING		4-digit value used to classify businesses into market segments	Y
merchant_category _code_group	STRING		High-level group labeling used in classifying businesses into market segments	Y
merchant_category _code_description	STRING		A more granular labeling used in classifying businesses into market segments	Y
balance_impact	STRING		C or D if it is credit then amount should be multiplied by a (+) if debit then multipled by a (-) NB for non-balance	Y
amount	INTEGER		Always positive, amount is in cents (no decimals)	N
transaction_fee	INTEGER		Always positive, amount is in cents (no decimals) - fees charged to the user in certain transaction types	Y