Transaction Status

This page provides a comprehensive guide to the status object returned in Localpayment API responses for various transaction types. Understanding these statuses is crucial for tracking the lifecycle of your transactions and handling different scenarios appropriately.

Introduction

The status object is a key component of many API responses related to financial operations. It provides information about the current state of a transaction. Each status is represented by a combination of:

  • status (String): A human-readable label describing the status (e.g., "Completed," "Rejected," "Approved").
  • code (Integer): A numerical code corresponding to the specific status.
  • description (String): A detailed explanation of the status and, in some cases, the reason for the status.

While each operation type has its specific statuses, many fall under these general categories:

  • InProgress: The transaction has been initiated but is not yet completed. This often involves asynchronous processing or external approvals.
  • Completed: The transaction has been successfully processed.
  • Rejected: The transaction could not be completed due to an error. The description field will usually provide more details.
  • Cancelled: The transaction was cancelled, either by the user or by the system.

Important Considerations:

  • Idempotency: When handling API responses, especially for operations that might be retried, design your system to be idempotent. This means that repeated requests with the same parameters should not result in duplicate transactions or unintended side effects. Use unique identifiers (e.g., request IDs) to track and manage requests.
  • Webhooks: Localpayment offers webhooks to notify your system about transaction status changes. Relying solely on querying the API for status updates can be inefficient. Use webhooks to get real-time updates.
  • Error Handling: Implement robust error handling to gracefully handle failed transactions and provide informative feedback to users. Log failed transaction details for debugging and analysis.
  • Asynchronous Operations: Be aware that many operations, especially those involving external payment processors or banks, are asynchronous. Your system should be able to handle pending statuses and update the transaction status accordingly when it changes.
  • Status Changes: Be aware that one transaction can have multiple status. You need to check the transaction history.

The following sections detail the possible status codes for each transaction type.

Payin

Payin transactions represent funds being deposited into a Localpayment account.

CodeStatusDescription
100InProgressThe payin is pending the confirmation
101OnHoldThe payin is on hold
102AuthorizedThe payin was authorized
103ApprovedThe payin was confirmed but not credited yet
107ApprovedCard update success
200CompletedThe payin was credited
201CompletedThe payin was credited with a different account than the requested
303RejectedInvalid exchange rate token
500RejectedExternal ID already used - Duplication
501RejectedCountry not found
502RejectedCurrency not allowed
503RejectedTransactions not found
504RejectedLimit exceeded
505RejectedInsufficient funds
506RejectedTransaction could not be cancelled
507RejectedTransaction could not be received
508RejectedInvalid merchant
509RejectedInvalid date
510RejectedTransaction could not be executed
511RejectedZeroAmount
512RejectedNotAllowedAmount
513RejectedInvalid Bank
514RejectedInvalid Service
537RejectedAccess Denied
538RejectedInvalid Password
539RejectedComunication Error
600RejectedSender Blacklisted
601RejectedBeneficiary blacklisted
602RejectedAmount exceeds max limit
603RejectedRejected by AML
604RejectedRejected compliance limits
701RejectedIncorrectAccountNumber
702RejectedInactive Account
703RejectedInactive Transaccion Account
707RejectedInvalidAccountCurrency
716RejectedTransactionNotSupported
719RejectedAmount must not be empty and more than 0
721RejectedNotAllowedCurrency
736RejectedInvalidCountry
771RejectedYour Client Payin Settings have not been configured
772RejectedYour Provider Payin Settings have not been configured
801RejectedParams error
802RejectedRejected by provider
803RejectedInvalid card cvv
804RejectedInvalid card number
805RejectedInvalid payment method code
806RejectedInvalid card cvv length
807RejectedInvalid card token provider
808RejectedGeneric provider error
809RejectedInvalid card number length
810RejectedNot allowed to process Credit or Debit Card of foreign countries - Only Local cards
811RejectedRequested amount is higher or lower than allowed max/min values
812RejectedExternal Id already used - duplication
813RejectedInvalid country
815RejectedInvalid email
817RejectedInvalid concept code
818RejectedInvalid payment method type
819RejectedInvalid payment method
820RejectedUnknown error
821RejectedInvalid card for payment method
822RejectedInvalid relationship between provider and payment method
823RejectedPayment method not supported by provider
824RejectedInvalid document
825RejectedSystem error to generate payin
826RejectedSystem error to cancel payin
827RejectedSystem error to refund payin
828RejectedSystem error to validate BIN
829RejectedSystem error to generate Installment Plan
830RejectedInstalments Plan token is invalid or expired
831RejectedFX Token not valid
832RejectedRejected by client
833RejectedSystem error to capture payin
835RejectedThe cardholder did not take a further authentication step
836Rejected3D Secure authentication time expired
850RejectedThis Source is not admited
851RejectedError update subscription
900CancelledThe payin was cancelled
901ExpiredThe payin has expired
902RefundedThe payin was refunded
905CancelledThe authorization was cancelled
906ChargeBackThe payin has a chargeback
907ExpiredThe authorization was expired
908RejectedThe payer's account is unable to use this service
909RejectedThe user did not complete the checkout
910RejectedThe bank is currently unavailable for this payment method. Please consider using an alternative bank or try again later.
911RejectedThe Payer's bank account credentials are invalid, Please contact your bank or try again later
912RejectedAmount exceeds max limit for new contacts
913RejectedThe maximum number of transfers for new contacts was reached.
915RejectedThe phone number provided doesn't match any account
920RejectedThe payment method is currently not available for this country. Consider using another payment method or try again later.

Subscriptions

Subscription statuses relate to the overall state of a subscription, not individual payments. Individual payment attempts within a subscription are treated as Payin transactions (see above).

CodeStatusDescription
104ReceivedThe subscription was received
105InprogressThe subscription is in progress
106OnholdThe subscrition is on hold
202CompletedThe subscription was completed
300RejectedInvalid param + [param name] + [reason]
301RejectedEmpty mandatory param + [param name]
834RejectedSystem error to generate subscription
851RejectedError update subscription
903CancelledThe subscription was canceled - merchant request
904CancelledThe subscription was canceled - too many failed attempts
921CancelledSubscription was canceled - due to lost chargeback
922ChargeBackThe subscription on hold - Chargeback in progress

Payout

Payout transactions represent funds being withdrawn from a Localpayment account.

CodeStatusDescription
100ReceivedThe payout was received
101LockedThe payout has been confirmed and passed AML validations
102InProgressThe payout has been sent to the bank
103OnHoldThe provider is not configured
104PendingAuthThe payout is pending of authorization by client
105OnHoldOnHold by AML
200CompletedThe payout was debited
300RejectedInvalid param + [param name] + [reason]
301RejectedEmpty mandatory param + [param name]
302RejectedInvalid control string characters
303RejectedInvalid exchange rate token
400RejectedUnregistered IP address
401RejectedInvalid credentials
402RejectedUnauthorized
403RejectedFailure to conecct to API
404RejectedToo many requests
500RejectedExternal ID already used - Duplication
501RejectedCountry not found
502RejectedCurrency not allowed
503RejectedTransactions not found
504RejectedLimit exceeded
505RejectedInsufficient funds
506RejectedTransaction could not be cancelled
507RejectedTransaction could not be received
508RejectedInvalid merchant
509RejectedInvalid date
510RejectedTransaction could not be executed
511RejectedZeroAmount
512RejectedNotAllowedAmount
513RejectedRestricted payment: Payment to a Virtual Account is not allowed
600RejectedSender Blacklisted
601RejectedBeneficiary blacklisted
602RejectedAmount exceeds max limit
603RejectedRejected by AML
604RejectedRejected compliance limits
701RejectedInvalidAccountNumber - Alias does not exist or could not be found
702RejectedInvalidAccountNumber - Account Closed
703RejectedInvalidAccountNumber - Account Bloqued
704RejectedInvalidAccountType - Non-existent or invalid Account Type
705RejectedIncorrectAccountNumber - Doesn´t match regex
707RejectedInvalidAccountCurrency
708RejectedInvalidAccountOwner - ID informed is not consistent with the Account Holder
709RejectedInvalidAccountOwner - ID informed is incorrect
710RejectedProcessingError
715RejectedInvalidAccountNumber - Alias does not exist or could not be found.
716RejectedTransactionNotSupported
719RejectedAmount must not be empty and more than 0
720RejectedBank Not Supported
721RejectedNotAllowedCurrency
736RejectedInvalidCountry
771RejectedInvalidPaymentTypeInformation
773RejectedThe bank does not work with this account type
801RejectedParams error
802RejectedRejected by provider
805RejectedInvalid payment method code
808RejectedGeneric provider error
809RejectedPayment not allowed to this beneficiary bank
810RejectedPayment amount exceeds the limit allowed for the beneficiary account.
811RejectedInvalid amount
812RejectedExternal Id already used - duplication
813RejectedInvalid country
815RejectedInvalid email
817RejectedInvalid concept code
818RejectedInvalid payment method type
819RejectedInvalid payment method
820RejectedUnknown error
821RejectedPIX not allowed to this beneficiary bank institution
822RejectedInvalid relationship between provider and payment method
823RejectedPayment method not supported by provider
824RejectedInvalid document
825RejectedSystem error to generate payout
826RejectedSystem error to cancel payout
827RejectedSystem error to refund payout
828RejectedSystem error to validate BIN
829RejectedPIX not allowed to this beneficiary bank account
830RejectedIncorrect data of the Bank
831RejectedError account not match beneficiary name
832RejectedError bank branch incorret
833RejectedError account not accept transfers
834RejectedError beneficiary document does not match name
835RejectedThis Source is not admited
836RejectedThis account does not match the beneficiary's identification document
900CancelledThe payout was cancelled
901ReturnedThe payout was returned
902RecalledThe payout was recalled
903RejectedInvalid QR code
904RejectedQR code has been cancelled
905RejectedQR code has expired
906RejectedQR code has already been paid
920RejectedThe payment method is currently not available for this country. Consider using another payment method or try again later.
921RejectedRechazado por cuenta fraudulenta
tDisRejectedNo test disable
tEnaRejectedYes test enable

Chargeback

Chargebacks are initiated by the cardholder's bank and represent a reversal of a previous Payin.

CodeStatusCategoryDescription
100Received0Chargeback has been received
101DocReceived0Dispute documentation received
102InDispute0Dispute documentation was sent to the acquire
200Completed0Chargeback has been completed
201DisputeLost0Dispute debited
202DisputeWon0Dispute credited

Credit

Credit transactions represent operations performed using credit cards.

CodeStatusDescription
200CompletedEE REFUNDED
201CompletedCOMMISSION REFUNDED
202CompletedTAX REFUNDED
203CompletedTRANSACTION REFUNDED
204CompletedINVESTMENT
205CompletedCOLLECTION

Currency Exchange

Currency Exchange transactions represent the conversion of funds from one currency to another.

CodeStatusCategoryDescription
200CompletedCURRENCY EXCHANGE
405RejectedBusinessLogicErrorExternal not admin user cannot create currency exchange bulk transactions
511RejectedBusinessLogicErrorZeroAmount
701RejectedProcessingErrorDebited Account Not Exists
702RejectedProcessingErrorAccounts owner client must be same
703RejectedProcessingErrorAccounts countries must be match
704RejectedProcessingErrorCredited account not exists
705RejectedProcessingErrorCredited account currency not match
706RejectedProcessingErrorTransaction type not allowed for credited account
716RejectedProcessingErrorDebited account not admit transaction type
825RejectedProcessingErrorSystem error to generate currency exchange
826RejectedProcessingErrorInvalid account balance amount

Debit

Debit transactions represent operations performed using debit cards.

CodeStatusDescription
200CompletedSWIFT FEE DEBITED
201CompletedCOMMISSION DEBITED
202CompletedTAX DEBITED
203CompletedTRANSACTION DEBITED
204CompletedBANK FEE
205CompletedSUPPLIERS
206CompletedBANK CHARGERS
207CompletedINTEREST

Expenses

Expenses track costs associated with operations (e.g., fees).

CodeStatusDescription
200CompletedBank fees
201CompletedInvoice
202CompletedLawyer
203CompletedAccountant

Recall

Recalls are requests to reverse a payment, typically used in specific payment methods or regions.

CodeStatusDescription
200CompletedTHE PAYOUT HAS BEEN RECALLED

Refund

Refunds represent the return of funds to a customer for a specific, previously completed Payin.

CodeStatusDescription
100ReceivedThe refund was received
101LockedThe refund has been confirmed and passed AML validations
102InProgressThe refund has been sent to the bank
103OnHoldThe refund is on hold
104PendingAuthThe refund is pending of authorization by client
200CompletedThe payin has been refunded
300RejectedInvalid param + [param name] + [reason]
301RejectedEmpty mandatory param + [param name]
302RejectedInvalid control string characters
303RejectedInvalid exchange rate token
400RejectedUnregistered IP address
401RejectedInvalid credentials
402RejectedUnauthorized
403RejectedFailure to conecct to API
404RejectedToo many requests
500RejectedExternal ID already used - Duplication
501RejectedCountry not found
502RejectedCurrency not allowed
503RejectedTransactions not found
504RejectedLimit exceeded
505RejectedInsufficient funds
506RejectedTransaction could not be cancelled
507RejectedTransaction could not be received
508RejectedInvalid merchant
509RejectedInvalid date
510RejectedTransaction could not be executed
511RejectedZeroAmount
512RejectedNotAllowedAmount
600RejectedSender Blacklisted
601RejectedBeneficiary blacklisted
602RejectedAmount exceeds max limit
603RejectedRejected by AML
604RejectedRejected compliance limits
701RejectedIncorrectAccountNumber
702RejectedInvalidAccountNumber - Account Closed
703RejectedInvalidAccountNumber - Account Bloqued
704RejectedInvalidAccountType - Non-existent or invalid Account Type
705RejectedIncorrectAccountNumber - Doesn´t match regex
707RejectedInvalidAccountCurrency
708RejectedInvalidAccountOwner - ID informed is not consistent with the Account Holder
709RejectedInvalidAccountOwner - ID informed is incorrect
710RejectedInvalidAccountOwner - Not informed
716RejectedTransactionNotSupported
721RejectedNotAllowedCurrency
736RejectedInvalidCountry
771RejectedInvalidPaymentTypeInformation
801RejectedParams error
802RejectedRejected by provider
805RejectedInvalid payment method code
808RejectedGeneric provider error
809RejectedPayment not allowed to this beneficiary bank
810RejectedPayment amount exceeds the limit allowed for the beneficiary account.
811RejectedInvalid amount
812RejectedExternal Id already used - duplication
813RejectedInvalid country
815RejectedInvalid email
817RejectedInvalid concept code
818RejectedInvalid payment method type
819RejectedInvalid payment method
820RejectedUnknown error
821RejectedPIX not allowed to this beneficiary bank institution
822RejectedInvalid relationship between provider and payment method
823RejectedPayment method not supported by provider
824RejectedInvalid document
825RejectedSystem error to generate payout
826RejectedSystem error to cancel payout
827RejectedSystem error to refund payout
828RejectedSystem error to validate BIN
829RejectedPIX not allowed to this beneficiary bank account
831RejectedError account not match beneficiary name
832RejectedError bank branch incorrect
833RejectedError account not accept transfers
834RejectedError beneficiary document does not match name
900CancelledThe refund was cancelled
901ReturnedThe refund was returned
902RecalledThe refund was recalled

Return

A Return typically indicates a payment that was sent but could not be delivered to the recipient. This is distinct from a Refund (initiated by the merchant) or a Chargeback (initiated by the cardholder).

CodeStatusDescription
200CompletedTHE PAYOUT HAS BEEN RETURNED

Recurring Fee

Recurring Fees are charges related to subscription or account maintenance.

CodeStatusDescription
200CompletedMONTHLY COMMISION
201CompletedANNUAL COMMISION
202CompletedTAX PROCESSING COMMISION
203CompletedACCOUNT MAINTENANCE FEE

Wire In

Wire In transactions represent incoming wire transfers.

CodeStatusDescription
100PendingCreditPending Credit
200CompletedCompleted
717RejectedByBankRejected

Wire Out

Wire Out transactions represent outgoing wire transfers.

CodeStatusDescription
100PendingAuthPending Authorization
101PendingDebitIn Progress
102ReceivedAuthorized
200CompletedCompleted
404RejectedProvider Code not matching with account number
511RejectedZeroAmount
716RejectedRejected by admin
717RejectedByBankRejected by bank
718RejectedByBankDestination account not found
719RejectedByBankRejected
826RejectedInvalid accoun