# Get Payout Instructions

Retrieves a paginated list of payout instructions, optionally filtered by campaign id, status, external id, or email. 
                A payout instruction represents an intention to pay a specific amount of money to a beneficiary and is associated with exactly one campaign.

Endpoint: GET /v2/campaign-manager/payout-instructions
Version: v2
Security: oauth2

## Query parameters:

  - `campaignId` (string)

  - `status` (integer)
    Enum: "Draft", "Ready", "PushInitiated", "Initiated", "InitiationFailed", "PayoutMethodSelected", "Requested", "Restored", "Reinitiated", "ReinitiationFailed", "ExpiryRequested", "Fulfilled", "Expired", "Cancelled"

  - `externalId` (string)

  - `email` (string)

  - `pageNumber` (integer, required)

  - `pageSize` (integer, required)

## Response 200 fields (application/json):

  - `pageNumber` (integer)

  - `pageSize` (integer)

  - `totalPages` (integer)

  - `totalItems` (integer)

  - `data` (array)

  - `data.payoutInstructionId` (string)
    The unique identifier for the payout instruction.

  - `data.campaignId` (string)
    The identifier of the campaign this payout instruction belongs to.

  - `data.amount` (number,null)
    The monetary amount of the payout instruction.

  - `data.firstName` (string,null)
    The first name of the beneficiary.

  - `data.lastName` (string,null)
    The last name of the beneficiary.

  - `data.email` (string, required)
    The email address of the beneficiary. This is the primary contact method.

  - `data.phoneNumber` (string,null)
    The phone number of the beneficiary. May be required for certain payout methods.

  - `data.addressLine1` (string,null)
    The first line of the beneficiary's address.

  - `data.addressLine2` (string,null)
    The second line of the beneficiary's address.

  - `data.city` (string,null)
    The city of the beneficiary's address.

  - `data.stateCode` (integer)
    Enum: "AL", "AK", "AR", "AZ", "CA", "CO", "CT", "DC", "DE", "FL", "GA", "HI", "IA", "ID", "IL", "IN", "KS", "KY", "LA", "MA", "MD", "ME", "MI", "MN", "MO", "MS", "MT", "NC", "ND", "NE", "NH", "NJ", "NM", "NV", "NY", "OK", "OH", "OR", "PA", "RI", "SC", "SD", "TN", "TX", "UT", "VA", "VT", "WA", "WI", "WV", "WY"

  - `data.zipCode` (string,null)
    The ZIP/postal code of the beneficiary's address.

  - `data.status` (integer)
    Enum: "Draft", "Ready", "PushInitiated", "Initiated", "InitiationFailed", "PayoutMethodSelected", "Requested", "Restored", "Reinitiated", "ReinitiationFailed", "ExpiryRequested", "Fulfilled", "Expired", "Cancelled"

  - `data.disabledPayoutMethods` (object)
    A dictionary of payout methods that are disabled for this instruction, with reasons.

  - `data.cancellationReason` (integer)
    Enum: "Unknown", "BeneficiaryRequest", "CampaignManagerRequest", "EmailHardBounce", "EmailSpamComplaint", "UnsubscribedFromEmails", "EmailScreeningFailed"

  - `data.selectedPayoutMethodId` (string,null)
    The identifier of the payout method selected by the beneficiary, if any.

  - `data.externalId` (string, required)
    An external identifier for this payout instruction, used for integration with client systems.

  - `data.nextReminderDate` (string,null)
    The next reminder date for this payout instruction if automatic reminders are enabled, otherwise null.

## Response 400 fields (application/problem+json):

  - `type` (string,null)

  - `title` (string,null)

  - `status` (integer,null)

  - `detail` (string,null)

  - `instance` (string,null)

## Response 401 fields (application/problem+json):

  - `type` (string,null)

  - `title` (string,null)

  - `status` (integer,null)

  - `detail` (string,null)

  - `instance` (string,null)

## Response 403 fields (application/problem+json):

  - `type` (string,null)

  - `title` (string,null)

  - `status` (integer,null)

  - `detail` (string,null)

  - `instance` (string,null)