List Payout Profiles

Retrieve a list of payout_profiles.

For details on how to query endpoints using the available parameters, see Query Parameters.

Request
query Parameters
after_cursor
string

Return every resource created after the cursor value.

Example: after_cursor=TRnasXQ5AmjsLnPMwnme7TL4
limit
integer

The numbers of items to return.

Example: limit=10
Responses
200
401

Authentication information is missing or invalid

403

Forbidden

404

Object does not exist

406

Not Acceptable

422

Invalid field

get/payout_profiles
Request samples 
curl "https://finix.sandbox-payments-api.com/payout_profiles" \
  -H "Finix-Version: 2022-02-01" \
  -u US4UKYcdgmg3CKPxDRyV3FtA:88214476-3d56-4708-adc2-a7f001b0d5a1
Response samples
application/json
{}

Fetch a Payout Profile

Retrieve the details of a previously created Payout Profile.

Request
path Parameters
payout_profile_id
required
string

ID of the Payout Profile.

header Parameters
Accept
string
Default: application/hal+json
Responses
200
401

Authentication information is missing or invalid

403

Forbidden

404

Object does not exist

406

Not Acceptable

422

Invalid field

get/payout_profiles/{payout_profile_id}
Request samples 
curl "https://finix.sandbox-payments-api.com/payout_profiles/POf5rP3c3XyRX7M6PuCvmgxf" \
  -H "Finix-Version: 2022-02-01" \
  -u US4UKYcdgmg3CKPxDRyV3FtA:88214476-3d56-4708-adc2-a7f001b0d5a1
Response samples
application/json
{
  • "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": {
      },
    • "fees": {
      }
    },
  • "tags": { },
  • "type": "GROSS",
  • "_links": {}
}

Update a Payout Profile

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.

Request
path Parameters
payout_profile_id
required
string

ID of the Payout Profile.

header Parameters
Accept
string
Default: application/hal+json
Request Body schema: application/json
One of:
object or null

Configure how Payout Profiles with type GROSS are setup.

object or null

Include up to 50 key: value pairs to annotate requests with custom metadata.

  • Maximum character length for individual keys is 40.
  • Maximum character length for individual values is 500. (For example, order_number: 25, item_type: produce, department: sales)
type
string

Configures how fees are calculated and billed from payouts. For more infromation, see Payout Types.

Enum: "CUSTOM" "GROSS" "NET"
Responses
200
401

Authentication information is missing or invalid

403

Forbidden

404

Object does not exist

406

Not Acceptable

422

Invalid field

put/payout_profiles/{payout_profile_id}
Request samples 
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"
    }
    }
}'
Response samples
application/json
{
  • "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": {
      },
    • "fees": {
      }
    },
  • "tags": { },
  • "type": "GROSS",
  • "_links": {}
}

Fetch Payout Profile by Merchant

Fetch the the Payout Profile created for a specific Merchant.

Request
path Parameters
merchant_id
required
string

ID of the Merchant.

header Parameters
Accept
string
Default: application/hal+json
Responses
200
401

Authentication information is missing or invalid

403

Forbidden

404

Object does not exist

406

Not Acceptable

422

Invalid field

get/merchants/{merchant_id}/payout_profile
Request samples 
curl "https://finix.sandbox-payments-api.com/merchants/MUfbbKm7vRmBX2bP92pKw9zZ/payout_profile" \
  -H "Finix-Version: 2022-02-01" \
  -u US4UKYcdgmg3CKPxDRyV3FtA:88214476-3d56-4708-adc2-a7f001b0d5a1
Response samples
application/json
{
  • "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": {
      },
    • "fees": {
      }
    },
  • "tags": { },
  • "type": "GROSS",
  • "_links": {}
}