Retrieve a Payout Request
Get a payout request by its id.
Authorizations
Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.
Path Parameters
Id of the payout request
Response
The payout-request id.
Amount in cents of the payout-request.
Date that the payout-request was created.
ID of the payout-request.
Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
The payout-link that was sent when the payout-request was approved.
The amount to pay in cents.
ID of the user that has claimed the payout-link.
Date the payout-link was created.
ID of the payout flow UI that is sent to the user.
ID of the payout-link.
URL to access the payout-link.
Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
Information about the payee. It is used to pre-fill information.
Country code of the payee's phone number e.g. "1" for USA.
Payee's email address.
Payee's first name.
Payee's last name.
Rest of the payee's phone number.
Status of the payout-link.
created, delivery_pending, delivery_failed, sent, delivered, claimed, reversed, canceled, expired Transfers marked as tax_exempt will not be counted towards the 1099 threshold.
Status of the payout-request.
created, approved, rejected The user that requested the payout.
The user's 1099 information was collected.
Deprecated. Use w9.address_collected instead.
The user's date of birth was collected.
The user is flagged for review. For more information, see the flags object.
True when the user is flagged for potential OFAC compliance issues.
Status of the user's OFAC compliance verification.
unflagged, id_verification_required, in_review, flagged True when two or more users share the same payout method.
True when the user has connected or disconnected payout methods repeatedly over a short period of time.
The user has criminal activity based on a background check.
The user's id was verified.
The user's 1099 information needs to be collected to resume payouts.
Deprecated. Use w9.tax_id_collected instead.
Tax ID verification status. A mismatched tax ID may be corrected and resubmitted.
unsubmitted, pending, matched, mismatched The user's W8-BEN information was collected.
ach, paypal, venmo, cash_app, intl_bank, airtm, payoneer ach, paypal, venmo, cash_app, intl_transfer, airtm, payoneer ID of the payment-method.
Indicates if RTP is enabled for the payment method (applies to ach only).
Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
verified, unverified, disabled, in_review