Refunds before clearing files

This endpoint is deprecated. Paybyrd continues to support implementations using this endpoint for an indefinite period. However, we recommend using the FinanceHub Settlement files endpoint instead.

The Refunds Before Clearing file supplements the settlement file. It records transactions refunded before the acquirer’s clearing process — transactions that did not incur fees or other charges.

Authentication

Authenticate requests using an x-api-key header. You can find your API key in the API Keys page of the dashboard.

Retrieving the refunds before clearing file

To retrieve the list of files for a period, send a GET request to: https://settlements.paybyrd.com/api/v1/authorization-files?createdFrom={startDateTime}&createdTo={endDateTime}

Response content structure

Field	Type	Description
groupId	String (UUID)	Customer-defined group or organization hierarchy.
id	String (UUID)	Unique identifier of the file.
checksum	String	MD5 hash of the file contents, represented as a hexadecimal string.
createdAt	String (ISO 8601)	UTC timestamp when the file was generated.
url	String (URL)	URL to download the file.

Usage recommendations

Paybyrd normally generates one file per day. However, there may be situations where more than one file is generated for the same day, in which case these files are complementary and must be fully processed to obtain all refunds before clearing information. To receive all settlements consistently each day, make requests with sequential date periods. For example, an automated system could make one request per day, using the createdTo value from the previous request as the createdFrom value for the next.

Retrieving a list of refunds before clearing files for a specific day

To retrieve files for a specific day, set the period from 00:00 to 23:59, as in the example below.

curl --location --request GET 'https://settlements.paybyrd.com/api/v1/authorization-files?createdFrom=2023-11-27T00:00:00&createdTo=2023-11-27T23:59:59' \
--header 'x-api-key: <your_api_key>'

// Success (HTTP Status Code: 200)
{
    "data": [
        {
            "checksum": "d41d8cd98f00b204e9800998ecf8427e",
            "createdAt": "2023-11-27T01:00:00Z",
            "groupId": "07b52763-6268-4ad5-82de-2b6db4bc0aad",
            "id": "34a815e7-40b3-4936-b689-70984ec7ad4e",
            "url": "https://paybyrd-settlements.blob.core.windows.net/authorizations-paybyrd/2678/2023-11-27T01-00-00-8192727%2B0-PaybyrdAuthorizations.csv?..."
        }
    ]
}

// Not Found (HTTP Status Code: 404)
{
    "error": {
        "code": "BYRD901",
        "message": "Settlement file not found."
    }
}

Retrieving a list of refunds before clearing files (period filtering)

When filtering by period, days with no file are omitted from the results. Use from and to as query parameters and the authorizations-paybyrd endpoint for period filtering.

curl --location --request GET 'https://settlements.paybyrd.com/api/v1/authorizations-paybyrd?from=2023-11-01T00:00:00&to=2023-11-27T23:59:59' \
--header 'x-api-key: <your_api_key>'

// Not Found (HTTP Status Code: 404)
{
    "error": {
        "code": "BYRD901",
        "message": "Settlement file not found."
    }
}

// Bad Request (HTTP Status Code: 400)
{
    "error": {
        "code": "BYRD900",
        "message": "Invalid settlement filter date (createdAt)."
    }
}

// Unexpected errors (HTTP Status Code: 500)
{
    "error": {
        "code": "BYRD999",
        "message": "Internal server error."
    }
}

File specification

The file is created in CSV format using | (pipe) as a separator. The filename follows this pattern: yyyy-MM-ddThh-mm-ssZ-PaybyrdSettlement.csv Example: 2022-11-18T16-49-58Z-PaybyrdSettlement.csv

Field specifications

Field name	Type	Format	Description
ACQUIRER_TRANSACTION_REFERENCE	String(72)	***	The identifier of the transaction in the Acquirer
PAYBYRD_TRANSACTION_REFERENCE	String(36)	***	The identifier of the transaction at Paybyrd
STORE_LEGAL_NAME	String(200)	***	Doing Business As (DBA) Name
GROUP_ID	Long	Numeric	Customer-defined group or organization hierarchy assigned with DBA/MID locations
MERCHANT_ID	Long	Numeric	Customer-defined subgroup or organization hierarchy assigned with DBA/MID locations
STORE_ID	Long	Numeric	Customer Facing Merchant Identification Number
ORDER_ID	String(36)	GUID	A unique reference number generated by Paybyrd to initiate transactions by HPP
TRANSACTION_TYPE	Char(1)	“P” = Payment, “PA” = PreAuth, “R” = Refund	Detailed record tag identifying
TRANSACTION_CARD_BRAND	String(15)	Visa, Maestro, Mastercard, DinersClub, UnionPay	High-level scheme tag
TRANSACTION_AUTHORIZATION_CODE	Int	***	The six-digit “APPROVED” reference associated with the purchase transaction
TRANSACTION_CURRENCY	String(3)	***	Cardholder Currency Code
TRANSACTION_AMOUNT	Long	ISO amount	The transaction amount
TRANSACTION_DATE	DateTime	yyyy-MM-dd hh:mm:ss	The calendar date time the transaction was processed in UTC
TRANSACTION_CARD_TYPE	String(20)	Consumer, Commercial	Card scheme defined type of card used in the transaction payment record
TRANSACTION_MASKED_CARD_NUMBER	String(19)	679128*****4259	The masked number of the cardholder account. Field length can vary from 16 to 19 digits (Amex cards).
TRANSACTION_CARD_USAGE	String(25)	Credit, Debit	The payment method of the transaction
ORDER_REF	String(100)	***	The Order Reference
TICKET_NUMBER	String(100)	***	Flight Ticket Number
TRANSACTION_MARKET_ID	String(36)	***	An identification of the Market sent by the client when the Transaction is processed
TRANSACTION_APPLICATION_ID	String(36)	Alphanumeric	The application Id that generated the transaction
TRANSACTION_INITIATED_FROM	String(4)	Alphanumeric	The source font of the transaction (ECOM / POS)
AIRPORT_CODE	String(3)	Alphanumeric	The Airport Code where the POS is installed
TRANSACTION_POS_SERIAL_NUMBER	String(20)	Alphanumeric	The Serial Number of POS that process the Transaction

Accept Payments

Manage Payments

Refunds before clearing files

Authentication

Retrieving the refunds before clearing file

Response content structure

Usage recommendations

Retrieving a list of refunds before clearing files for a specific day

Retrieving a list of refunds before clearing files (period filtering)

File specification

Field specifications

​Authentication

​Retrieving the refunds before clearing file

​Response content structure

​Usage recommendations

​Retrieving a list of refunds before clearing files for a specific day

​Retrieving a list of refunds before clearing files (period filtering)

​File specification

​Field specifications

Authentication

Retrieving the refunds before clearing file

Response content structure

Usage recommendations

Retrieving a list of refunds before clearing files for a specific day

Retrieving a list of refunds before clearing files (period filtering)

File specification

Field specifications