Payments

Payments provide endpoints to filter both Charges and Payouts with multiple different parameters.

Search payments

client.Payments.List(ctx, params) (*PageNumberSchema[PaymentSummaryPagedV1Data], error)

GET/v1/payments

ModelsExpand Collapse

type PaymentSummaryPagedV1 struct{…}

Data []PaymentSummaryPagedV1Data

ID string

Unique identifier for the charge or payout.

formatuuid

Amount int64

The amount of the charge or payout in cents.

formatint32

CreatedAt Time

The time the charge or payout was created.

formatdate-time

Currency string

The currency of the charge or payout. Only USD is supported.

Description string

An arbitrary description for the charge or payout.

ExternalID string

Unique identifier for the charge or payout in your database. This value must be unique across all charges or payouts.

FundingIDs []string

Funding ids.

Paykey string

Value of the paykey used for the charge or payout.

PaymentDate Time

The desired date on which the payment should be occur. For charges, this means the date you want the customer to be debited on. For payouts, this means the date you want the funds to be sent from your bank account.

formatdate

PaymentType string

The type of payment. Valid values are charge or payout.

One of the following:

const PaymentSummaryPagedV1DataPaymentTypeCharge PaymentSummaryPagedV1DataPaymentType = "charge"

const PaymentSummaryPagedV1DataPaymentTypePayout PaymentSummaryPagedV1DataPaymentType = "payout"

Status string

The current status of the charge or payout.

One of the following:

const PaymentSummaryPagedV1DataStatusCreated PaymentSummaryPagedV1DataStatus = "created"

const PaymentSummaryPagedV1DataStatusScheduled PaymentSummaryPagedV1DataStatus = "scheduled"

const PaymentSummaryPagedV1DataStatusFailed PaymentSummaryPagedV1DataStatus = "failed"

const PaymentSummaryPagedV1DataStatusCancelled PaymentSummaryPagedV1DataStatus = "cancelled"

const PaymentSummaryPagedV1DataStatusOnHold PaymentSummaryPagedV1DataStatus = "on_hold"

const PaymentSummaryPagedV1DataStatusPending PaymentSummaryPagedV1DataStatus = "pending"

const PaymentSummaryPagedV1DataStatusPaid PaymentSummaryPagedV1DataStatus = "paid"

const PaymentSummaryPagedV1DataStatusReversed PaymentSummaryPagedV1DataStatus = "reversed"

const PaymentSummaryPagedV1DataStatusValidating PaymentSummaryPagedV1DataStatus = "validating"

StatusDetails StatusDetailsV1

Details about the current status of the charge or payout.

ChangedAt Time

The time the status change occurred.

formatdate-time

Message string

A human-readable description of the current status.

Reason StatusDetailsV1Reason

A machine-readable identifier for the specific status, useful for programmatic handling.

One of the following:

const StatusDetailsV1ReasonInsufficientFunds StatusDetailsV1Reason = "insufficient_funds"

const StatusDetailsV1ReasonClosedBankAccount StatusDetailsV1Reason = "closed_bank_account"

const StatusDetailsV1ReasonInvalidBankAccount StatusDetailsV1Reason = "invalid_bank_account"

const StatusDetailsV1ReasonInvalidRouting StatusDetailsV1Reason = "invalid_routing"

const StatusDetailsV1ReasonDisputed StatusDetailsV1Reason = "disputed"

const StatusDetailsV1ReasonPaymentStopped StatusDetailsV1Reason = "payment_stopped"

const StatusDetailsV1ReasonOwnerDeceased StatusDetailsV1Reason = "owner_deceased"

const StatusDetailsV1ReasonFrozenBankAccount StatusDetailsV1Reason = "frozen_bank_account"

const StatusDetailsV1ReasonRiskReview StatusDetailsV1Reason = "risk_review"

const StatusDetailsV1ReasonFraudulent StatusDetailsV1Reason = "fraudulent"

const StatusDetailsV1ReasonDuplicateEntry StatusDetailsV1Reason = "duplicate_entry"

const StatusDetailsV1ReasonInvalidPaykey StatusDetailsV1Reason = "invalid_paykey"

const StatusDetailsV1ReasonPaymentBlocked StatusDetailsV1Reason = "payment_blocked"

const StatusDetailsV1ReasonAmountTooLarge StatusDetailsV1Reason = "amount_too_large"

const StatusDetailsV1ReasonTooManyAttempts StatusDetailsV1Reason = "too_many_attempts"

const StatusDetailsV1ReasonInternalSystemError StatusDetailsV1Reason = "internal_system_error"

const StatusDetailsV1ReasonUserRequest StatusDetailsV1Reason = "user_request"

const StatusDetailsV1ReasonOk StatusDetailsV1Reason = "ok"

const StatusDetailsV1ReasonOtherNetworkReturn StatusDetailsV1Reason = "other_network_return"

const StatusDetailsV1ReasonPayoutRefused StatusDetailsV1Reason = "payout_refused"

const StatusDetailsV1ReasonCancelRequest StatusDetailsV1Reason = "cancel_request"

const StatusDetailsV1ReasonFailedVerification StatusDetailsV1Reason = "failed_verification"

const StatusDetailsV1ReasonRequireReview StatusDetailsV1Reason = "require_review"

const StatusDetailsV1ReasonBlockedBySystem StatusDetailsV1Reason = "blocked_by_system"

const StatusDetailsV1ReasonWatchtowerReview StatusDetailsV1Reason = "watchtower_review"

const StatusDetailsV1ReasonValidating StatusDetailsV1Reason = "validating"

const StatusDetailsV1ReasonAutoHold StatusDetailsV1Reason = "auto_hold"

Source StatusDetailsV1Source

Identifies the origin of the status change (e.g., bank_decline, watchtower). This helps in tracking the cause of status updates.

One of the following:

const StatusDetailsV1SourceWatchtower StatusDetailsV1Source = "watchtower"

const StatusDetailsV1SourceBankDecline StatusDetailsV1Source = "bank_decline"

const StatusDetailsV1SourceCustomerDispute StatusDetailsV1Source = "customer_dispute"

const StatusDetailsV1SourceUserAction StatusDetailsV1Source = "user_action"

const StatusDetailsV1SourceSystem StatusDetailsV1Source = "system"

Code stringoptional

The status code if applicable.

TraceIDs map[string, string]

Trace ids.

UpdatedAt Time

The time the charge or payout was last updated.

formatdate-time

CustomerDetails CustomerDetailsV1optional

Information about the customer associated with the charge or payout.

ID string

Unique identifier for the customer

formatuuid

CustomerType CustomerDetailsV1CustomerType

The type of customer

One of the following:

const CustomerDetailsV1CustomerTypeIndividual CustomerDetailsV1CustomerType = "individual"

const CustomerDetailsV1CustomerTypeBusiness CustomerDetailsV1CustomerType = "business"

Email string

The customer's email address

Name string

The name of the customer

Phone string

The customer's phone number in E.164 format

EffectiveAt Timeoptional

The actual date on which the payment occurred. For charges, this is the date the customer was debited. For payouts, this is the date the funds were sent from your bank account.

formatdate-time

FundingID stringoptional

Unique identifier for the funding event associated with the charge or payout.

formatuuid

Metadata map[string, string]optional

Metadata for payment - only included if requested.

PaykeyDetails PaykeyDetailsV1optional

Information about the paykey used for the charge or payout.

ID string

Unique identifier for the paykey.

formatuuid

CustomerID string

Unique identifier for the customer associated with the paykey.

formatuuid

Label string

Human-readable label that combines the bank name and masked account number to help easility represent this paykey in a UI

Balance int64optional

The most recent balance of the bank account associated with the paykey in dollars.

formatint32

Meta PaymentSummaryPagedV1Meta

APIRequestID string

Unique identifier for this API request, useful for troubleshooting.

formatuuid

APIRequestTimestamp Time

Timestamp for this API request, useful for troubleshooting.

formatdate-time

MaxPageSize int64

Maximum allowed page size for this endpoint.

formatint32

PageNumber int64

Page number for paginated results.

formatint32

PageSize int64

Number of items per page in this response.

formatint32

SortBy string

The field that the results were sorted by.

SortOrder string

One of the following:

const PaymentSummaryPagedV1MetaSortOrderAsc PaymentSummaryPagedV1MetaSortOrder = "asc"

const PaymentSummaryPagedV1MetaSortOrderDesc PaymentSummaryPagedV1MetaSortOrder = "desc"

TotalItems int64

TotalPages int64

The number of pages available.

formatint32

ResponseType PaymentSummaryPagedV1ResponseType

Indicates the structure of the returned content.

"object" means the data field contains a single JSON object.
"array" means the data field contains an array of objects.
"error" means the data field contains an error object with details of the issue.
"none" means no data is returned.

One of the following:

const PaymentSummaryPagedV1ResponseTypeObject PaymentSummaryPagedV1ResponseType = "object"

const PaymentSummaryPagedV1ResponseTypeArray PaymentSummaryPagedV1ResponseType = "array"

const PaymentSummaryPagedV1ResponseTypeError PaymentSummaryPagedV1ResponseType = "error"

const PaymentSummaryPagedV1ResponseTypeNone PaymentSummaryPagedV1ResponseType = "none"