Execute Payment for a Client-Generated Invoice

post https://api.wingspan.app/payments/client/invoice/{invoice_id}/pay

Process a payment for a specific client-generated invoice using the provided details, ensuring the invoice is marked as settled.

Response

Response body

object

additionalRecipientEmails

array of strings

required

additionalRecipientEmails*

amount

number

required

client

object

required

comment

string | null

payDate

string | null

workflowStatus

string | null

Pending PreApproved Approved PaymentInitiated Funded Declined

workflowSubStatus

string | null

Submitted

createdAt

string

required

currency

string

required

USD CAD

dueDate

string

required

events

object

required

approvedAt

string | null

cancelledAt

string | null

clientDeclinedAt

string | null

clientResolvedDisputeAt

string | null

depositedAt

string | null

depositedToPayoutPlatformAt

string | null

disputedAt

string | null

emailMarkedAsSpamAt

string | null

emailReceivedAt

array of strings or null | null

emailReceivedAt

emailUndeliverableAt

string | null

emailViewedAt

array of strings or null | null

emailViewedAt

estimatedDepositAt

string | null

instantPayoutAt

string | null

instantPayoutEligibleAt

string | null

instantPayoutFailedAt

string | null

intlPayoutFailedAt

string | null

markedPaidAt

string | null

memberAcceptedAt

string | null

memberDisputedAt

string | null

memberResubmittedAt

string | null

openedAt

string | null

paidAt

string | null

payAfterAccountVerified

string | null

paymentFailedAt

array of strings or null | null

paymentFailedAt

paymentInTransitAt

string | null

paymentRetriedAt

array of strings or null | null

paymentRetriedAt

payoutFailedAt

string | null

preApprovedAt

string | null

refundedAt

string | null

sentAt

string | null

sentDue3DaysAgoAt

string | null

sentDue7DaysAgoAt

string | null

sentDueIn3DaysAt

string | null

sentDueTodayAt

string | null

sentInstantPayoutFailedToMember

string | null

sentInvoiceHasBeenSentToMember

string | null

sentManuallyAt

array of strings or null | null

sentManuallyAt

sentPaymentConfirmationToClient

string | null

sentPaymentConfirmationToMember

string | null

sentPaymentInTransitReminderAt

string | null

sentPayoutMightBeDelayedToClient

string | null

sentRecurringPaymentFailedAt

string | null

unapprovedAt

string | null

invoiceId

string

required

invoiceNumber

string

required

lineItems

array of objects

required

lineItems*

object

costPerUnit

number

required

createdAt

string

required

labels

object

required

Has additional fields

labelsBak2

object

required

Has additional fields

quantity

number

required

reimbursableExpense

boolean

required

totalCost

number

required

unit

string

required

updatedAt

string

required

description

string | null

detail

string | null

discount

integration

member

object

required

comment

string | null

payoutPreferences

string | null

Standard Instant Expedited Check ECheck

workflowStatus

string | null

Disputed Accepted Resubmitted

workflowSubStatus

string | null

Submitted

memberAcceptsPayments

boolean

required

memberAddress

object

required

addressLine1

string

required

city

string

required

postalCode

string

required

state

string

required

addressLine2

string | null

country

string | null

memberClient

object

required

achCreditAccount

object

required

client

object

required

clientData

object

required

clientId

string

required

clientUserAccountType

string

required

member enterprise

createdAt

string

required

emailTo

string

required

eventActors

object

required

Has additional fields

events

object

required

externalIds

object

required

form1099Balances

object

required

formW9Data

object

required

internationalWireAccount

object

required

labels

object

required

Has additional fields

member

object

required

memberClientId

string

required

memberData

object

required

memberId

string

required

parentMemberClientId

string

required

payerPayeeId

string

required

status

string

required

Active Inactive Pending

taxStatus

string

required

Complete Failed Pending Incomplete

updatedAt

string

required

userRoles

object

required

autoPaySettings

collaboratorGroupId

string | null

collaboratorGroupIds

array of strings or null | null

collaboratorGroupIds

company

string | null

eligibilityRequirements

array | null

eligibilityRequirements

emailCC

array of strings or null | null

emailCC

integration

name

string | null

requirements

array | null

requirements

memberCompany

string

required

memberEmail

string

required

memberLogoUrl

string

required

memberName

string

required

memberPaymentsVersion

number

required

memberStripeAccountId

string

required

projectName

string

required

status

string

required

Draft Open Overdue Cancelled Pending PaymentInTransit Paid

updatedAt

string

required

usePaymentCard

boolean

required

acceptedPaymentMethods

array of strings or null | null

acceptedPaymentMethods

accountId

string | null

attachments

bankTransferInfo

chargedFees

creditFeeHandling

integration

internationalBankTransferInfo

invoiceNotes

string | null

invoiceTemplateId

string | null

lateFeeHandling

memberFormattedAddressLines

array of strings or null | null

memberFormattedAddressLines

metadata

paymentInfo

paymentMethodId

string | null

processingFees

sourceId

string | null

Language

Credentials

Bearer

JWT

URL


xxxxxxxxxx
1
curl --request POST \
2
     --url https://api.wingspan.app/payments/client/invoice/invoice_id/pay \
3
     --header 'accept: application/json' \
4
     --header 'content-type: application/json'

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200A client created invoice