v1

latestOpenAPI 3.0.22026-08-061303782.1 MB
Receipts

Create a Delivery Attempt

Create a Delivery Attempt on an existing Receipt resource.

post/receipts/{receipt_id}/delivery_attempts

Headers

Finix-Versionstring
Example:2022-02-01

Specify the API version of your request. For more details, see Versioning.

Content-Typestring
Example:application/json

The data type being sent in the request body must be application/json.

Request body

Response

A single Receipt

idstring

The ID of the resource.

created_atstring date-time

Timestamp of when the object was created.

updated_atstring date-time

Timestamp of when the object was last updated.

destinationstring

The receipt delivery attempt destination.

receipt_idstring

The ID of the Receipt resource associated with the Delivery Attempt.

state'SUCCEEDED' | 'FAILED'

Whether the delivery attempt succeeded or failed.

type'EMAIL' | 'SMS' | 'PRINT'

The type of delivery method used to send the receipt.