transactions

Get a List of Transactions

Securityx-api-key

Request

header Parameters

broker-id

required

integer (broker_id)

The id of the broker

Example: 66305

Responses

200

Example response

get/transactions

Request samples

curl
JavaScript
Node.js
Python

Response samples

application/json

[{"id": 87346,
"amount": 123.45,
"idempotency_key": "bac613de-5j27-1347-ka1n-q3p6173jacj4",
"status": "PENDING",
"created_datetime": "2023-10-26T00:00:00+00:00",
"payment_method": "ACH_NEXT_DAY",
"eta": "2023-10-27T13:00:00+00:00",
"payables": [{"amount": 123.45,
"carrier_payee": {"id": 87346,
"payee_name": "Camila Trucking LLC",
"is_verified": false
},
"created_datetime": "2023-10-26T00:00:00+00:00",
"id": 87346,
"idempotency_key": "bac613de-5j27-1347-ka1n-q3p6173jacj4",
"invoice_number": "355da12b-774b-41fc-9124-92d5f5a795ed",
"po_number": "AP12345",
"scheduled_for_date": "2023-10-29T00:00:00+00:00",
"updated_datetime": "2023-10-26T00:00:00+00:00"
}
],
"broker": {"id": 66305,
"name": "Atlanta Brokerage"
},
"payee": {"id": 87346,
"payee_name": "Camila Trucking LLC",
"is_verified": false,
"is_factoring_company": true
}
}
]

Create a Single Transaction

Securityx-api-key

Request

header Parameters

broker-id

required

integer (broker_id)

The id of the broker

Example: 66305

Request Body schema: application/json

payee_id	integer (payee_id) The unique identifier of the Payee who will receive the funds. It could be a Carrier or a Factoring Company.
carrier_payee_id	string (carrier_payee_id) If the Transaction is created for a Factoring Company, then a Carrier can be associated to the Transaction.
payment_method	any (payment_method) The method used to settle a payable. Enum: "ACH" "ACH_NEXT_DAY" "ACH_SAME_DAY" "PAPER_CHECK" "WALLET_ACH" "WALLET_ACH_NEXT_DAY" "WALLET_ACH_SAME_DAY" "WALLET_RTP"
amount	string (amount) Money in USD to transfer or has been transferred.
reference_id	string (reference_id) An identifier used by the Broker to correlate the Transaction with another system or document.

Responses

201

Example response

post/transactions

Request samples

Payload
curl
JavaScript
Node.js
Python

application/json

{"payee_id": 896876,
"carrier_payee_id": 10204,
"payment_method": "ACH_NEXT_DAY",
"amount": "18.32",
"reference_id": "123XYZ"
}

Response samples

application/json

{"id": 87346
}

Get a Single Transaction

Securityx-api-key

Request

path Parameters

required

string

header Parameters

broker-id

required

integer (broker_id)

The id of the broker

Example: 66305

Responses

200

Example response

401

Unauthorized

403

Forbidden

404

Not Found

get/transactions/{id}

Request samples

curl
JavaScript
Node.js
Python

Response samples

application/json

{"id": 87346,
"amount": 123.45,
"idempotency_key": "bac613de-5j27-1347-ka1n-q3p6173jacj4",
"status": "PENDING",
"created_datetime": "2023-10-26T00:00:00+00:00",
"payment_method": "ACH_NEXT_DAY",
"eta": "2023-10-27T13:00:00+00:00",
"payables": [{"amount": 123.45,
"carrier_payee": {"id": 87346,
"payee_name": "Camila Trucking LLC",
"is_verified": false
},
"created_datetime": "2023-10-26T00:00:00+00:00",
"id": 87346,
"idempotency_key": "bac613de-5j27-1347-ka1n-q3p6173jacj4",
"invoice_number": "355da12b-774b-41fc-9124-92d5f5a795ed",
"po_number": "AP12345",
"scheduled_for_date": "2023-10-29T00:00:00+00:00",
"updated_datetime": "2023-10-26T00:00:00+00:00"
}
],
"broker": {"id": 66305,
"name": "Atlanta Brokerage"
},
"payee": {"id": 87346,
"payee_name": "Camila Trucking LLC",
"is_verified": false,
"is_factoring_company": true
},
"check_preview": {"url": "https://www.example-url-image.com/paper-check/1234567"
}
}