Update a Payment Intent

patch https://connect.sandbox.plastiq.com/api/payment-intents/{id}

Path Params

string

required

The ID of the Payment Intent

Body Params

Payment Intent to update

targetAmount

details

object

feeAmendments

object

metadata

object

additional payment information to support operational requirements

payer

object

required

isExpedited

boolean

Used to expedite a payment's delivery. If true, the delivery date will be set to the fastest available.

deliveryDate

date

The date to deliver the payment by. Note: will override isExpedited flag.

Headers

Trace-Id

string

A valid UUID (V4) for tracing requests. Will be returned as a header. If not present or invalid, a generated UUID will be returned.

End-User-Agent

string

A string representing the User Agent of the end user. Recommended for compliance. Required only when the request is not coming from the end user's browser.

End-User-Ip

string

The IP address of the end user. Recommended for compliance.

End-User-OS

string

The Operating System of the end user. Recommended for compliance.

End-User-Device-Id

string

A unique identifier for the end user's device. Recommended for compliance.

End-User-Device-Manufacturer

string

The manufacturer of the device used by the end user. Recommended for compliance.

End-User-Device-Model

string

The device model used by the end user. Recommended for compliance.

Responses

Response body

object

string

fees

array of objects

fees

object

amount

object

Amount that will be credited to Recipient

type

string

The type of fee applied to the payment

PLASTIQ_SERVICE_FEE PLASTIQ_CROSS_BORDER_FEE DELIVERY_FEE EXPEDITED_PROCESSING_FEE EXPEDITED_HANDLING_FEE

rate

string

The rate of the fee assessed, presented in percentage.

sourceAmount

object

Amount that will be credited to Recipient

value

number

required

Value of the currency between 1 and 99999999.99

currency

string

required

Currency value

USD

targetAmount

object

Amount that will be credited to Recipient

value

number

required

Value of the currency between 1 and 99999999.99

currency

string

required

Currency value

USD

paymentMethod

object

string

required

recipient

object

string

required

payer

object

string

required

details

object

accountName

string

length between 1 and 64

The name of the account. Used by the receiving entity for reconciling payments.

accountNumber

string

length between 1 and 25

The invoice or account number. Used by the receiving entity for reconciling payments.

memo

string

length between 1 and 25

Short description of the payment. Used by the receiving entity for reconciling payments.

disbursementInformation

object

The disbursement bank account or originator account for the payment.

traceInformation

object

The trace information for locating the payment.

status

string

CAPTURABLE CAPTURED EXPIRED UNCAPTURABLE

statusReasons

array of objects

statusReasons

object

warnings

array of objects

warnings

object

code

string

required

message

string

required

deliveryDate

date

createdAt

date-time

expiresAt

date-time

deliveryOptions

array of objects

deliveryOptions

object

cutoffTime

date-time

The date and time in which the delivery date is valid for.

deliveryDate

date

The date the payment can be delivered by.

fees

array of objects

fees

object

amount

object

Amount that will be credited to Recipient

type

string

The type of fee applied to the payment

PLASTIQ_SERVICE_FEE PLASTIQ_CROSS_BORDER_FEE DELIVERY_FEE EXPEDITED_PROCESSING_FEE EXPEDITED_HANDLING_FEE

rate

string

The rate of the fee assessed, presented in percentage.

Headers

object

Trace-Id

string

The trace ID for the request

Language

Credentials

Bearer

token

URL


xxxxxxxxxx
11
1
curl --request PATCH \
2
     --url https://connect.sandbox.plastiq.com/api/payment-intents/id \
3
     --header 'accept: application/json' \
4
     --header 'content-type: application/json' \
5
     --data '
6
{
7
  "targetAmount": {
8
    "currency": "USD"
9
  }
10
}
11
'

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

application/json

200Payment Intent updated successfully

400Bad Request

401Unauthorized

403Forbidden

500Internal Server Error