payment
payout

Retrieve a payout

Changed on
get/payment/{connection_id}/payout/{id}

Request

  • Base URL: https://api.unified.to
  • URL: https://api.unified.to/payment/{connection_id}/payout/{id}
  • Auth: API key in header authorization

Path parameters

connection_idstring required

ID of the connection

idstring required

ID of the Payout

Query parameters

fieldsstring[]

Fields to return

rawstring

Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar

Response

Successful

idstring
created_atstring

(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

updated_atstring

(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

total_amountnumber
currencystring
notesstring
status'SUCCEEDED' | 'PENDING' | 'FAILED' | 'CANCELED'
arrival_atstring date-time

Date the funds land in the destination account (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

fee_amountnumber

Processor fee deducted from the payout

net_amountnumber

total_amount minus fee_amount

account_idstring

ref -> AccountingAccount; the destination account (reference to AccountingAccount)

rawobject

Changes

  • 39502239a975Revision changes
    • info

      added the enum value metadata to the property items/ of the query request parameter fields

    • info

      added the optional property to the response with the status

  • 669f9277e173Revision changes
    • info

      added the enum value account_id to the property items/ of the query request parameter fields

    • info

      added the enum value arrival_at to the property items/ of the query request parameter fields

    • info

      added the enum value fee_amount to the property items/ of the query request parameter fields

    • info

      added the enum value lineitems to the property items/ of the query request parameter fields

    • info

      added the enum value net_amount to the property items/ of the query request parameter fields

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status