plaid2.model.payment_initiation_payment_reverse_request module

class plaid2.model.payment_initiation_payment_reverse_request.PaymentInitiationPaymentReverseRequest(*, reference: str, payment_id: str, idempotency_key: str)

Bases: BaseModel

dict(**kwargs: Any) → Dict[str, Any]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

idempotency_key: str

A random key provided by the client, per unique wallet transaction. Maximum of 128 characters.

The API supports idempotency for safely retrying requests without accidentally performing the same operation twice. If a request to execute a wallet transaction fails due to a network connection error, then after a minimum delay of one minute, you can retry the request with the same idempotency key to guarantee that only a single wallet transaction is created. If the request was successfully processed, it will prevent any transaction that uses the same idempotency key, and was received within 24 hours of the first request, from being processed.

json(**kwargs: Any) → str

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

classmethod parse_obj(data: Any) → PaymentInitiationPaymentReverseRequest

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → PaymentInitiationPaymentReverseRequest

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

payment_id: str

The ID of the payment to reverse

reference: str

A reference for the refund. This must be an alphanumeric string with at most 18 characters and must not contain any special characters or spaces.