Payout Invoice: Overview¶
There are three types of outgoing transactions that occur in PayCore.io®:
A Payout is a low-level operation that initiates a financial transaction in the defined payment provider using the specified payout method, it simply provides communication with an external provider and the mapping of statuses. Payout refers to the financial return or monetary disbursement of investment or annuity.
A Payout Request is an operation with rich functionality that initiates one or many payouts depending on the conditions set in the routing and exchange rate schemes.
A Payout Invoice is a high-level operation that initiates accompanying Payout Request and Ledger account transactions.
The Payout Invoice includes information on the
exchange rate and other properties.
In contradistinction to Payment Invoice — Payout Invoice has
It means that this type of commerce operations can be processed as automaticaly as manualy.
The full list of properties can be found in the API Reference launch .
Below is a description of each status:
|created||No||No||Initial status after a Payout Invoice is created, processing has not started. |
If PayCore.io® will not return response 201 (Created) HTTP status code on your request, you should consider that the payout invoice was failed to be created
|expired||Yes||No||Means the Payout Invoice hit the lifetime limit (configurable in the 'Invoice lifetime' property) without being successfully processed, but also did not either cancelled or terminated, e.g. your customer has abandoned the payout|
|terminated||Yes||No||Means that the payout process was terminated by a payer prior to the payout invoice lifetime limit|
|processing||No||Yes||Signifies that the payout invoice is processing by PayCore.io® but its processing is not finished and there will be further status updates|
|process_pending||No||Yes||Means that the result of the payout process still being unknown and may not be known for an extended period of time|
|processed||No||No||Confirms the payout has been processed successfully. |
This isn't a final status since the payout can be refunded for different reasons
|partially_processed||No||No||Means that the amount paid is less than the payout invoice amount and that amount is successfully processed, e.g. your customer has entered an amount less than the invoice amount while making an online payout|
|process_failed||Yes||No||Signifies that the Payout Invoice processing has failed, may be set when an error occurs and the corresponding payout request has failed. |
This status is considered final due to the maximum number of attempts has been reached (default – 5 attempts)
|refunding||No||Yes||Means the payout invoice is refunding and the result of the payout invoice refunding still being unknown|
|refund_pending||No||Yes||Means that the result of the payout refunding still being unknown and may not be known for an extended period of time|
|partially_refunded||Yes||No||Means that the amount refunded is less than the payout invoice amount and that amount is successfully refunded.|
|refunded||Yes||No||Means the payout invoice is successfully refunded in full|
|refund_failed||Yes||No||Means that the payout invoice refunding has been failed or cannot be completed|