Scribd
Upload
76 views

Posting URL: Test/Dev API Documentation

This document provides documentation for an API endpoint to create transaction records. It describes the endpoint URL, sample request and response formats, possible response codes and errors, required authentication headers, and details of the required and optional parameters for a transaction.

Uploaded by

Richard
Copyright
© © All Rights Reserved
Available Formats
Download as PDF, TXT or read online on Scribd
76 views

Posting URL: Test/Dev API Documentation

This document provides documentation for an API endpoint to create transaction records. It describes the endpoint URL, sample request and response formats, possible response codes and errors, required authentication headers, and details of the required and optional parameters for a transaction.

Uploaded by

Richard
Copyright
© © All Rights Reserved
Available Formats
Download as PDF, TXT or read online on Scribd
You are on page 1/ 3

Test/Dev API Documentation: Transactions

Posting URL
https://portalDev.bright-speed.com/api/v1/payments/transaction

Implementation Notes
Creates an individual transaction.

Response
{
"success": false,
"message": "insert failed",
"errors": [],
"warnings": []
}
{
"success": true,
"message": "insert successful",
"data":
{
"TRANSACTIONID": "AB_123456",
"STATUS": "Pending"
},
"warnings": []
}
Name

Data Type

Description

success

bool

Success or fail on insert

message

string

Message to describe result

errors

array

Array containing errors with insert

warnings

array

Array containing warnings with insert. Insert


still processing with errors





Test/Dev API Documentation: Transactions

Data
TRANSACTIONID

varchar

Identifier for specific transaction

STATUS

varchar

Current status of transaction

Response Errors
HTTP Status Code

Reason

400

Bad request

401

Unauthorized

404
405

Not Found
Method not allowed

429

Rate limit exceeded

500

Internal server error

503

Service unavailable

Authentication & Headers


HTTP Basic Authentication is used with all API calls. The unique API Token sent via
email should be used as the username and the password should be left blank.

Path Parameters
* = required field
Name

Sample

Data Type

Description

SOURCE*

abc123

varchar

Distinguishes transaction sources

LASTNAME*

Doe

varchar

FIRSTNAME*

John

varchar

MIDDLEINITIAL

varchar

COMPANYOR2NDNAME

varchar

ADDRESS*

123

varchar

Anystreet
CITY*

Anytown

varchar





Test/Dev API Documentation: Transactions

STATE*

QX

varchar

Must be 2 character abbreviation.


Both characters must be
capitalized. No spaces.

ZIPCODE*

12345

varchar

PHONENUMBER

varchar

OTHERPHONENUMBER

varchar

ABANUMBER*

123456789

varchar

Routing number, must be exactly


nine (9) digits

ACCOUNTNUMBER*

123456789

varchar

Must be between 4 and 17 digits

varchar

Decimal-formatted, without "$"

012
AMOUNT*

450.00

TRANSITNUM*

varchar

BANKNAME

ABC Bank

varchar

BANKADDRESS

456

varchar

Anystreet
BANKCITY

Anytown

varchar

BANKSTATE

QX

varchar

BANKZIPCODE

varchar

BANKPHONE

varchar

BANKFAX

varchar

CUSTOMFIELD1

varchar

Custom data from your system

CUSTOMFIELD2

varchar

Custom data from your system

CUSTOMFIELD3

varchar

Custom data from your system

CUSTOMFIELD4

varchar

Custom data from your system

CUSTOMFIELD5

varchar

Custom data from your system

CUSTOMFIELD6

varchar

Custom data from your system

POSTBACKURL

varchar
(150)

Reference the Postback API docs


on how to set up a postback URL
in order to receive status updates
on transactions

You might also like