Skip to content

Payout Gateway: Payouts

General

Definition

Payout — refers to the financial return or monetary disbursement of investment or annuity.

Workflow State diagram

Payout Workflow

Payout status

Definition

Payout status — is a property, based on which it can be unambiguously stated at what stage the payout is.

Payout Statuses are divided into TWO groups in the context of their level of completion.

  • Final : means, that current status is the last (in current flow)
  • Intermediate: means, that paycout can go into another state after current

Info

Sleep - means that operation can wait in this status for some moderation.

CodeFinalSleepDescription
CREATE_FAILEDYesNoPayout was not created. Using for Pauout Request section
CREATEDNoNoPayout was successfuly created
READYNoYesPayout is ready to be processed.Depending on the autoprocess field value payout waits command for processing (autoprocess is TRUE) or manual processing (autoprocess is FALSE)
TERMINATEDYesNoUser refused the entering of additional information and finished the payout
EXPIREDYesNoPayout operation is expired
INVOKINGNoYesPayout is registered by payment provider
INVOKE_FAILEDYesNoFailed to register a payout on the side of payment provider
PROCESSINGNoYesPayout is processing by payment provider
PENDINGNoYesPayout was created by payment provider and is waiting for resolution
PROCESSEDNoYesPayout was successfuly processed
PARTIALLY_PROCESSEDNoYesPayout was successfuly processed with part of amount
PROCESS_FAILEDYesNoPayment provider could not process the transaction
CANCELLINGNoYes Payout is cancelling
CANCELLEDYesNoPayout was cancelled
CANCEL_FAILEDYesNoPayout cancelling faliled
REVOKINGNoYesPayout is revoking
REVOKEDYesNoPayout was revoked
REVOKE_FAILEDYesNoPayout revoke failed

Payout Resolution

Definition

Payout resolution - the status of the request to the API of the payment provider and, in general, can be successful (OK) or not successful (for example, INVALID_REQUEST, FORBIDDEN_IP, SIGNATURE_ERROR),

Info

The resolution explains why the payout is in this status and, in fact, is the code (or group of codes) of the error that occurred when requesting the payment provider API.

CodeDescriptionComment
OK GROUP
OKRequest completed successfully
ERROR GROUP
(not final resolution, needed to determining)
CONNECTION_ERRORTransport level errorInvalid SSL certificate, HTTP 5**, 4**, 3**
(NOT 200)
PROVIDER_INTERNAL_ERRORError on Payment provider sideFor example: INTERNAL_SERVER_ERROR, 500 Internal Server Error
CONNECTION_TIMEOUT_ERRORRequest time limit exceeded
GENERAL_ERRORGeneral not critical error
UNKNOWNAny other resolution missing in mapping
FATAL ERROR GROUP
(final resolution)
INVALID_DETAILSInvalid payout details
INVALID_REQUESTThe protocol may have changed and/or the extension is outdated
REQUEST_ERRORAn error occurred while processing the request by the payment provider Invalid data passed
INVALID_AMOUNTInvalid payout amountAmount format or route limits violation
INVALID_METHODInvalid payout method
INVALID_CREDENTIALSInvalid authentication data
FORBIDDEN_IPForbidden IP Perhaps you did not register PayCore.io IP addresses in Whitelist
SIGNATURE_ERRORSignature verification errorPerhaps key was changed or it is outdated
DUPLICATED_IDOperation ID already exists
INSUFFICIENT_FUNDSInsufficient funds for payout
ANTIFRAUD_ERRORPayout did not pass the fraud test
DECLINED_ERROROperation rejected by providerUnknown reason
RECIPIENT_NOT_FOUNDPayout Recipient not found
INVALID_RECIPIENTPayout Recipient is invalid or inaccessible
LIMIT_VIOLATIONPayout limits violation
INTERNAL_ERRORSystem errorInternal PayCore.io error
ACCESS_ERRORThere are not enough permissions to perform the operationCheck the configuration in the payment provider
ACCESS_DENIEDUser is not authorized to perform these actions
GENERAL_FATAL_ERRORCritical errorFurther processing of the operation is meaningless
OPERATION_EXPIREDOperation is expired
PROCESSING_ERRORProcessing error

Warning

Any resolution from the ERROR GROUP transfers the payout to the moderation required state and it will not be processed by the processor.

Concept Difference

Info

The difference between these concepts lies in the fact that status is a property of the payout, and resolution relates to all sub-operations and has an explanatory meaning of the cause of the error that occurred during the processing of this request.