Test/Dev API Documentation: Refunds

Posting URL
https://portalDev.brightspeed.com/api/v1/payments/transaction/{TRANSACTIONID}/refund

Implementation Notes
Refunds are only authorized on transactions that have the status of Deposited. You
may allow a partial refund as long as the value is greater than $0.00 and less than or
equal to the transaction amount.

Response Samples
{
"success": false,
"message": "insert failed",
"errors": [],
"warnings": []
}
{
"success": true,
"message": "insert successful",
"data":
{
"refund_id": "12345",
"amount": "150.00",
"created_at": "YYYY-MM-DD HH:MM:SS"
},
"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





Test/Dev API Documentation: Refunds

warnings

array

Array containing warnings with insert. Insert

still processing with errors

Data
refund_id

varchar

ID associated to refund transaction

amount

varchar

Amount refunded

created_at

datetime

Date and time of issued refund

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
amount*

Sample

Data Type

Description

decimal

Amount to be refunded. Must be >

0 <= transaction amount.