Creating an Instant Payout

Access Endpoint URL: https://rest.everyware.com/api/payouts [POST]

The Create Payout method generates an instant payout record to be sent by SMS text to a payee's specified (and validated) mobile number.

🚧

Contacts Must Be Created

Note: A valid contact will be created when the Create Payout API is used. You can also create a contact with the or the Create Customer API or Create Invoice API.

🚧

Date of Birth Validation

Note: Curently, Date of Birth (DOB) is the key variable available for contact verification. A Payee will have five attempts to verify their identity with their DOB before the instant payout record is placed into hold status, requiring manual review.

🚧

FIFO methodology

Note: We apply a First-In, First-Out approach to sending instant payout text messages based on the order in which records are ingested. You may provide an optional scheduled date in the future according to your timing requirements.

Inbound Parameters

Custom fields are noted below with a ^ in the Required/Not column.

Parameter NameDescriptionRequired/Not
PayoutBatchIdAlphanumeric ID for the payout batch. Required for any payouts that are intended for a single batch.OPTIONAL for a Single Payout
REQUIRED for a Payout Batch
PayoutBatchNameName of the Payout Batch. Defaults to "[DateAdded YYYY/MM/DD] Payout Batch" if left blank.Optional. If missing Everyware will populate with a default batch name.
NA for Single Payout
ExternalPayoutIdUnique identifier Everyware can store with each individual payout, optionally. Data will populate the Payouts report if the records are successfully added.OPTIONAL
ClientReferenceMerchant may provide an original payment transaction ID associated with the intended payout - for example, to acknowledge that the contact/payee is receiving a transfer for an amount previously paid outside of Everyware.

Ex "Patient Payment for Invoice #2209"
OPTIONAL
FirstNameFirst name of Payout recipientREQUIRED^
LastNameLast name of Payout recipientREQUIRED^
PhoneNumber1Mobile phone number of payee provided in 10 digit format: 3055551212.

Must be a valid mobile number or the transaction will be declined
REQUIRED^
PhoneNumber2Additional phone number of payee, provided in 10 digit format: 3055551212. OPTIONAL
emailEmail address - existing contact fieldOPTIONAL^
AddressAddress - existing contact fieldOPTIONAL^
CityCity - existing contact fieldOPTIONAL^
StateCodeState - existing contact fieldOPTIONAL^
ZipCodeZip Code - existing contact fieldOPTIONAL^
ValidationIdUnique identifier that the payee must match to pass the security check step required to accept their payout. E.g., date of birthREQUIRED
ValidationIdTypeThis required ID type will be utilized for the payee to validate on the Payout Payment form. It will change dynamically depending on the validation ID passed by the Merchant.

Will be date, numeric or text.
REQUIRED
ValidationIdDescriptionDescription of required unique identifier - for example, Date of BirthREQUIRED
ValidationId2Unique identifier that the payee must match to pass the security check step required to accept their payout. E.g., date of birthOPTIONAL
ValidationId2TypeThis required ID type will be utilized for the payee to validate on the Payout Payment form. It will change dynamically depending on the validation ID passed by the Merchant.

Will be date, numeric or text.
OPTIONAL
ValidationId2DescriptionDescription of required unique identifier - for example, Date of BirthOPTIONAL
PayoutAmountAmount to be paid to payout recipientREQUIRED
PayoutShortDescriptionShort description that can be used to further describe the payout. For example, you were issued a refund for "Dentistry Overpayment."

25 character max
OPTIONAL
PayoutScheduleDateMinThe intended date for the payout link to be generated and sent by text message to the contact. This can also be used to schedule payouts in the future (do not send before 7/1/2024). If left blank, tomorrow's date is default.
Format: mm/dd/yyyy
Note, some payout links may not send on their intended schedule date depending on security and payout account threshold settings.
OPTIONAL
PayoutScheduleDateMaxMerchant may specify a required date that the payout must be sent. This represents the last desired date that the payout text link to be offered to the payee. The payee will have until the Payout Link Expiration as defined below to complete the payout.
Format: mm/dd/yyyy
OPTIONAL
PayoutLinkExpirationNumber of calendar days that the payout link is available from the date the payout was sent to the payee. Default (max) is 7 days.OPTIONAL
MetadataUtilized for Merchant Reporting. JSON FormatOPTIONAL
MessageTextInitialMerchant can provide a custom text message that will be sent to the payout target payee.OPTIONAL
MessageTextReminderAppend payout link to message.OPTIONAL

Code Sample

{
  "payoutBatchId": "a24e0357-df47-44f5-b31c-730576bcf476",
  "externalPayoutId": "ExternalPayoutId",
  "clientReference": "ClientReference-89f7c151-dc3d-4f19-9668-5fc3e7fa5ec1",
  "firstName": "John",
  "lastName": "Doe",
  "phoneNumber1": "202-555-0172",
  "email": "[email protected]",
  "address": "Brazos str.",
  "city": "Austin",
  "stateCode": "TX",
  "zipCode": "123456",
  "validationId": "DOB",
  "validationIdType": "date",
  "validationIdDescription": "Enter your DOB to validate",
  "payoutAmount": 1,
  "payoutShortDescription": "Lorem ipsum",
  "payoutScheduleDateMax": "05/23/2024",
  "payoutLinkExpiration": 4
}
curl --location 'https://rest.everyware.com/api/payouts' \
--header 'Authorization: Basic [xxx]' \
--header 'Content-Type: application/json' \
--data-raw '{
  "payoutBatchId": "a24e0357-df47-44f5-b31c-730576bcf476",
  "externalPayoutId": "ExternalPayoutId",
  "clientReference": "ClientReference-89f7c151-dc3d-4f19-9668-5fc3e7fa5ec1",
  "firstName": "John",
  "lastName": "Doe",
  "phoneNumber1": "202-555-0172",
  "email": "[email protected]",
  "address": "Brazos str.",
  "city": "Austin",
  "stateCode": "TX",
  "zipCode": "123456",
  "validationId": "DOB",
  "validationIdType": "date",
  "validationIdDescription": "Enter your DOB to validate",
  "payoutAmount": 1,
  "payoutShortDescription": "Lorem ipsum",
  "payoutScheduleDateMax": "05/23/2024",
  "payoutLinkExpiration": 4
}
{
  "Data": {
    "CorrelationId": "a9da5784-192e-4f5c-8867-66840f92ef6c"
  },
  "IsSuccessful": true,
  "Message": "The payout has been successfully received"
}