Payment Initiation

paymentInitiationPaymentReverse

POST
/payment_initiation/payment/reverse

Reverse a previously initiated payment.

A payment can only be reversed once and will be refunded to the original sender's account.

Authorization

PLAID-CLIENT-ID PLAID-SECRET Plaid-Version
PLAID-CLIENT-ID<token>

In: header

PLAID-SECRET<token>

In: header

Plaid-Version<token>

In: header

Request Body

application/json

PaymentInitiationPaymentReverseRequest defines the request schema for /payment_initiation/payment/reverse

client_id?string

Your Plaid API client_id. The client_id is required and may be provided either in the PLAID-CLIENT-ID header or as part of a request body.

secret?string

Your Plaid API secret. The secret is required and may be provided either in the PLAID-SECRET header or as part of a request body.

payment_id*string

The ID of the payment to reverse

Length1 <= length

Response Body

application/json

curl -X POST "https://example.com/payment_initiation/payment/reverse" \  -H "Content-Type: application/json" \  -d '{    "payment_id": "string"  }'
{  "refund_id": "refund-id-sandbox-c5f8cd31-6cae-4cad-9b0d-f7c10be9cc4b",  "request_id": "HtlKzBX0fMeF7mU",  "status": "INITIATED"}