PIpier-finance
Payments

Cancel a payment

Cancels a submitted payment before it is sent to the ACH network. Payments can only be canceled if they are still in the pending state and have not been submitted to the ACH network. After a payment is sent to the ACH network, you must wait for the it to settle and then you may refund it instead.

In some cases if you cancel while the payment is in the process of being submitted to the ACH network you may see a status of cancellation_pending in the response. In this case, you can check the status of the payment or wait for a subsequent webhook to see if it was successfully canceled or processed.

post/payments/{payment_id}/cancel

Request

  • Base URL
    https://production.pier-finance.com/api
  • Auth
    HTTP bearer

Path parameters

payment_idstring required

Response

idstring required
amountinteger required

The amount of the payment, in cents

facility_idstring required

The facility_id of the credit facility to make a payment for

status'pending' | 'processing' | 'processed' | 'settled' | 'failed' | 'canceled' | 'cancellation_pending' required
transfer_type'standard' | 'none' | 'refund' | 'credit' | 'cancellation' | 'suspense_credit' required

Transfer types that are not standard/none are set by special operations like the refund endpoint for example. Special types, like refund, will reference the original transaction transfer type of standard/none to determine if ACH was used if this knowledge is needed (e.g. does an ACH refund need to happen or was this ledgering only).

created_onstring date-time required

Timestamp the payment is created on

failure_reasonstring nullable

A reason for the failure if one exists

is_autopayboolean nullable

If the payment was a result of an autopay

Example response

{
  "amount": 100000,
  "facility_id": "fac_18e5a3726b3943cda2635f40e1041ba4",
  "created_on": "2023-02-27T00:00:00Z"
}

Changes

No recorded changes to this operation across all 1 revision of this API.