BYbyaccrue
Counterparties

Create Counterparty Payout

Initiate a payout from the counterparty's available balance to their bank account.

In sandbox, the counterparty's account number decides whether the payout completes, is returned, or fails. See Simulating returned and failed payouts for the test account numbers and ACH Return Codes for every return code.

post/api/v1/counterparties/:counterpartyId/payouts

Request

Path parameters

counterpartyIdstring uuid required

ID of the counterparty from which to payout.

Example:123e4567-e89b-12d3-a456-426614174000

Headers

Client-IDstring uuid required

The unique identifier of the client making the request. This header is required to retrieve the client-specific configuration and ensure that the response is tailored to the client's settings and permissions.

Example:123e4567-e89b-12d3-a456-426614174000
Authorizationstring uuid required

Secure secret to access privileged endpoints.

Example:Bearer 633b336e4f57f095a405f6685e208cc7dd16de3e82494662f2acfeec3af1cdef

Request body

Example request

{
  "data": {
    "attributes": {
      "amount": 5000,
      "idempotencyKey": "payout_12345"
    }
  }
}

Response

Payout initiated successfully

Example response

{
  "data": {
    "attributes": {
      "amount": 5000,
      "status": "Sent",
      "description": "Payout to vendor",
      "effectiveDate": "2024-01-15",
      "counterpartyId": "123e4567-e89b-12d3-a456-426614174000"
    }
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.