The core of this functionality revolves around the Payout Resource. This resource enables you to create payouts to saved credit cards without the need for a previously settled charge.

However, it is essential to have a card acquiring agreement in place that can handle such payouts.

Below, we describe the various components of the Payout Resource.

Payout Object

The Payout Object is structured as follows:

Name	Type	Description
Handle	String • Required	A unique reference for each payout, specific to your Billwerk+ account. The handle should be a maximum of 255 characters and is recommended to be kept within 20 characters for reference on bank statements without truncation.
State	String • Required	This indicates the current state of the payout, which can be one of the following: - Created - Processing - Failed - Paid
Amount	Integer • Required	The payout amount, measured in the smallest currency unit.
Currency	String • Optional	An optional field that specifies the currency for the payout in ISO 4217 three-letter alpha code.
Text	String • Optional	Optional text associated with the payout.
Customer	String • Required	Customer handle associated with the payout.
Paid	String • Optional	The timestamp indicating when the payout was successfully paid in ISO-8601 extended offset date-time format.
Failed	String • Optional	The timestamp indicating when the payout failed in ISO-8601 extended offset date-time format.
Created	String • Required	The timestamp indicating when the payout was initially created in ISO-8601 extended offset date-time format.
Transactions	Array of PayoutTransaction • Required	A list of transactions related to the payout.

Payout Transaction

The PayoutTransaction is a component of the Payout Object and contains detailed information about each transaction.

It includes:

Name	Type	Description
ID	String	A unique identifier for the transaction.
State	String	The state of the transaction, which can be paid.
Payout	String	Reference to the associated payout.
Amount	Integer	The amount of the transaction.
Paid	String	The timestamp indicating when the payout was successfully paid in ISO-8601 extended offset date-time format.
Failed	String	The timestamp indicating when the payout failed in ISO-8601 extended offset date-time format.
Card	Object	Detailed information about the card used in the transaction, including its state, customer, reference, and more.
Error	String	Description of any error encountered during the transaction.
Card Type	String	The type of card used, e.g., `hard_declined`.
Exp Date	String	The card's expiration date.
Masked Card	String	A partially masked version of the card number.
Acquirer Code	String	The acquirer code associated with the transaction.
Acquirer Message	String	A message from the acquirer, e.g., Card expired.
Acquirer Reference	String	An optional reference for the transaction at the acquirer.
Text on Statement	String	Optional text to appear on the customer's bank statement.