Payouts

Modified on Wed, 31 Jan at 11:11 AM

Payouts are the daily transfers of sales less refunds, fees, chargebacks and adjustments between your ACME FBO account and your sellers. This API endpoint allows you to see what batches have been created and report on their lifecycle.

It requires your MerchantID {mid} in the URL and PaymentKey as a request header.

Payouts are batched around a seller's calendar day, midnight to midnight local time, and contains all transactions within that time frame.

Get a List of Payouts

This allows you to retrieve all batches associated with this {mid} in a paginated response.

GET v1/payment/{mid}/payouts

HTML

Request Parameters

The {mid} is the merchant ID of the seller that the payouts are associated with, filtered by a status.

Query String Parameters

Field	Type	Description	Default
acmeProcessingStatus	string	Allows filtering of results by status of the payouts batch. ("PENDING", "FUNDED") Pending batches have yet to be sent to be funded. Funded batches should see money movement within 2 days of initiation date.	all
batchNetAmount	amount	The page that you want to retrieve	1st page
batchedDate	date	The number of transactions to return per page. Maximum is 500 pages.If a larger number is entered, it will be reduced to 500.	100 tr
approvedOn	date	Results sorting direction (“asc” or “desc”)	ascending

Sample Request

GET https://sandX-api.acmepayments.net/v1/payment/987654321/payouts?acmeProcessingStatus=FUNDED

JSON

Response

This will return the funded payouts batches for MID=987654321

Batches List

{
    "list": [
    {
        "payoutId": "po_f22d31337a014f33abccb37af2b1ae20",
        "status": "FUNDED",
        "batchedDate": "2023-06-15",
        "batchTransactions": 3,
        "batchGrossAmount": "1020.00",
        "batchNetFees": "0.00",
        "batchNetAmount": "1020.00",
        "adjustments": 3,
        "adjustmentsAmount": "1020.00"
    }
}

JavaScript

Retrieving a Payout by ID

GET v1/payment/{mid}/payouts/{payoutid}

HTML

Request Parameters

The {mid} is the merchant ID of the seller that the transaction is associated with.
The {payoutid} (po_) in the URL of the request. The payoutid was returned in a successful payouts listing or referenced in a payout summary.

Sample Request

GET https://sandX-api.acmepayments.net/v1/payment/987654321/payouts/po_f22d31337a014f33abcccb37af2b1ae20

HTML

Response

The corresponding payout object.

Sample Response Body

Single Sale Transaction

{
    "id": "sale_a71b4398-91f8-446f-b5cb-547f4395feee",
    "type": "Sale",
    "createdOn": "2021-11-08T10:00:00-08:00",
    "paymentMethod": "CreditCard",
    "readMethod": "Card not present",
    "card": {
        "lastFour": "4242",
        "expirationDate": {
            "month": "01",
            "year": "2023"
        },
        "postalCode": "T1X 0V6",
        "brand": "Visa",
        "firstName": "VISA",
        "lastName": "CARDHOLDER"
    },
    "amount": {
        "totalAmount": "174.00",
        "netAmount": "172.13",
        "fee": {
            "totalFee": "1.87",
            "fixedFee": "1.00",
            "percentageFee": "0.87",
            "percentageRate": "0.50"
        }
    }
}