A Payout Profile
configures how fees and payouts get calculated and processed.
Related Guides: Configuring Payouts
Retrieve a list of payout_profiles
.
For details on how to query endpoints using the available parameters, see Query Parameters.
Authentication information is missing or invalid
Forbidden
Object does not exist
Not Acceptable
Invalid field
curl "https://finix.sandbox-payments-api.com/payout_profiles" \ -H "Finix-Version: 2022-02-01" \ -u US4UKYcdgmg3CKPxDRyV3FtA:88214476-3d56-4708-adc2-a7f001b0d5a1
{- "_embedded": {
- "payout_profiles": [
- {
- "id": "PO6UbajkQrbFd5nAvs57dwyn",
- "created_at": "2022-10-24T21:38:23.72Z",
- "updated_at": "2022-10-24T21:38:23.72Z",
- "tags": { },
- "linked_id": "MU6TXYpA37uM9H4GwitQr8E3",
- "linked_type": "MERCHANT",
- "type": "GROSS",
- "gross": {
- "payouts": {
- "frequency": "DAILY",
- "submission_delay_days": 1,
- "payment_instrument_id": "PI2EmosKE8tvfSiF7Pd4SYE",
- "rail": "SAME_DAY_ACH"
}, - "fees": {
- "frequency": "MONTHLY",
- "day_of_month": 1,
- "submission_delay_days": 3,
- "payment_instrument_id": "PI2EmosKE8tvfSiF7Pd4SYE",
- "rail": "NEXT_DAY_ACH"
}
}, - "_links": {
}
}, - {
- "id": "POf5rP3c3XyRX7M6PuCvmgxf",
- "created_at": "2022-10-20T19:43:18.02Z",
- "updated_at": "2022-10-20T19:43:18.02Z",
- "tags": { },
- "linked_id": "MUfbbKm7vRmBX2bP92pKw9zZ",
- "linked_type": "MERCHANT",
- "type": "CUSTOM",
- "custom": { },
- "_links": {
}
}
]
}, - "_links": {
}, - "page": {
- "limit": 100,
- "next_cursor": "POf5rP3c3XyRX7M6PuCvmgxf"
}
}
Retrieve the details of a previously created Payout Profile
.
Authentication information is missing or invalid
Forbidden
Object does not exist
Not Acceptable
Invalid field
curl "https://finix.sandbox-payments-api.com/payout_profiles/POf5rP3c3XyRX7M6PuCvmgxf" \ -H "Finix-Version: 2022-02-01" \ -u US4UKYcdgmg3CKPxDRyV3FtA:88214476-3d56-4708-adc2-a7f001b0d5a1
{- "id": "POmhJeq1AsfwetG8LwhA4S9U",
- "created_at": "2022-10-25T16:54:08.20Z",
- "updated_at": "2022-10-25T16:54:08.20Z",
- "linked_id": "MU6TXYpA37uM9H4GwitQr8E3",
- "linked_type": "MERCHANT",
- "gross": {
- "payouts": {
- "frequency": "DAILY",
- "submission_delay_days": 1,
- "payment_instrument_id": "PI2EmosKE8tvfSiF7Pd4SYE",
- "rail": "SAME_DAY_ACH"
}, - "fees": {
- "frequency": "MONTHLY",
- "day_of_month": 1,
- "submission_delay_days": 3,
- "payment_instrument_id": "PI2EmosKE8tvfSiF7Pd4SYE",
- "rail": "SAME_DAY_ACH"
}
}, - "tags": { },
- "type": "GROSS",
- "_links": {
}
}
Update a Payout Profile
to configure how fees and payouts get calculated, credited, and debited.
By default, Merchants
get configured with daily net settlements. Payouts get submitted using the Next-Day ACH rail
. Contact Finix Support to configure payouts on a custom schedule.
object or null Configure how | |
object or null Include up to 50
| |
type | string Configures how fees are calculated and billed from payouts. For more infromation, see Payout Types. |
Authentication information is missing or invalid
Forbidden
Object does not exist
Not Acceptable
Invalid field
curl "https://finix.sandbox-payments-api.com/payout_profiles/POmhJeq1AsfwetG8LwhA4S9U" \ -H "Content-Type: application/json" \ -H "Finix-Version: 2022-02-01" \ -u US4UKYcdgmg3CKPxDRyV3FtA:88214476-3d56-4708-adc2-a7f001b0d5a1 \ -X PUT \ -d ' { "type": "GROSS", "gross": { "payouts": { "frequency": "DAILY", "submission_delay_days": "1", "payment_instrument_id": "PI2EmosKE8tvfSiF7Pd4SYE", "rail": "SAME_DAY_ACH" }, "fees": { "frequency": "MONTHLY", "day_of_month": "1", "submission_delay_days": "3", "payment_instrument_id": "PI2EmosKE8tvfSiF7Pd4SYE", "rail": "NEXT_DAY_ACH" } } }'
{- "id": "POmhJeq1AsfwetG8LwhA4S9U",
- "created_at": "2022-10-25T16:54:08.20Z",
- "updated_at": "2022-10-25T16:54:08.20Z",
- "linked_id": "MU6TXYpA37uM9H4GwitQr8E3",
- "linked_type": "MERCHANT",
- "gross": {
- "payouts": {
- "frequency": "DAILY",
- "submission_delay_days": 1,
- "payment_instrument_id": "PI2EmosKE8tvfSiF7Pd4SYE",
- "rail": "SAME_DAY_ACH"
}, - "fees": {
- "frequency": "MONTHLY",
- "day_of_month": 1,
- "submission_delay_days": 3,
- "payment_instrument_id": "PI2EmosKE8tvfSiF7Pd4SYE",
- "rail": "SAME_DAY_ACH"
}
}, - "tags": { },
- "type": "GROSS",
- "_links": {
}
}
Fetch the the Payout Profile
createrd for a specific Merchant
.
Authentication information is missing or invalid
Forbidden
Object does not exist
Not Acceptable
Invalid field
curl "https://finix.sandbox-payments-api.com/merchants/MUfbbKm7vRmBX2bP92pKw9zZ/payout_profile" \ -H "Finix-Version: 2022-02-01" \ -u US4UKYcdgmg3CKPxDRyV3FtA:88214476-3d56-4708-adc2-a7f001b0d5a1
{- "id": "POmhJeq1AsfwetG8LwhA4S9U",
- "created_at": "2022-10-25T16:54:08.20Z",
- "updated_at": "2022-10-25T16:54:08.20Z",
- "linked_id": "MU6TXYpA37uM9H4GwitQr8E3",
- "linked_type": "MERCHANT",
- "gross": {
- "payouts": {
- "frequency": "DAILY",
- "submission_delay_days": 1,
- "payment_instrument_id": "PI2EmosKE8tvfSiF7Pd4SYE",
- "rail": "SAME_DAY_ACH"
}, - "fees": {
- "frequency": "MONTHLY",
- "day_of_month": 1,
- "submission_delay_days": 3,
- "payment_instrument_id": "PI2EmosKE8tvfSiF7Pd4SYE",
- "rail": "SAME_DAY_ACH"
}
}, - "tags": { },
- "type": "GROSS",
- "_links": {
}
}