Resend Payout Email Notification

The Resend Payout Email Notification API enables bulk resending of the "Payment Notification From [Business Name]" email to recipients.

For each resend request, the system performs the following checks:

Payment Method Check: Verify if the recipient already has a payment method selected for the payout.

Default Method Check: Verify if the recipient already has a default payment method selected.

Resend Trigger: If neither condition is met, the email notification is resent to the recipient.

Email & Link Behavior:

If the recipientEmailAddress matches the recipient's existing email, the notification is simply resent.

If a new email address is provided, the system updates the recipient's email and sends the notification to the new address.

Any previous payment link ("Click here to receive your payment") is expired upon resend.

Note: The email field is unique per recipient. You cannot update a recipient's email to one already used by another active recipient.

Field: `actionCode`

The actionCode field indicates the overall result of the bulk resend operation:

Code	Result	Description
00	All Success	All transactions in the batch were processed successfully.
01	Partial Success	Mix of successful and failed transactions in the batch.
02	All Failed	All transactions in the batch failed.

Field: `statusCode`

Code	Status	Description
200	Success	API body was correct and all emails sent successfully.
207	Partial Success	API body was correct; mix of success and fail responses.
400	Bad Request	One or more required fields are missing or all emails failed.
401	Unauthorized	API session key at header was incorrect.
404	Not Found	A referenced entity was not found (see `message` for details).
500	Server Error	Internal server error.

curl --location 'https://staginggateway.fintainium.com/gateway/api/payouts/batch/resendEmail' \ --header 'sessionKey: YOUR_API_KEY_HERE' \ --header 'Content-Type: application/json' \ --data-raw '{ "businessId": 217819, "recipients": [ { "recipientInternalId": "379", "transactionId": "1231", "recipientEmailAddress": "abc@xyz.com" }, { "recipientInternalId": "380", "transactionId": "1232", "recipientEmailAddress": "abc2@xyz.com" }, { "recipientInternalId": "381", "transactionId": "1233", "recipientEmailAddress": "abc3@xyz.com" } ] }'

{ "statusCode": 200, "actionCode": "00", "message": "3 emails sent successfully", "failedCount": 0, "failedMessageList": [], "successCount": 3, "transactions": [ { "transactionId": "1231", "status": "sent" }, { "transactionId": "1232", "status": "sent" }, { "transactionId": "1233", "status": "sent" } ], "transmissionDateTime": "2023-08-30T06:10:13.505+00:00" }

Resend Payout Email Notification

Field: actionCode#

Field: statusCode#

Request

Responses

Field: `actionCode`

Field: `statusCode`