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.
Code | Status | Description |
---|---|---|
100 | InProgress | The payin is pending the confirmation |
101 | OnHold | The payin is on hold |
102 | Authorized | The payin was authorized |
103 | Approved | The payin was confirmed but not credited yet |
107 | Approved | Card update success |
200 | Completed | The payin was credited |
201 | Completed | The payin was credited with a different account than the requested |
303 | Rejected | Invalid exchange rate token |
500 | Rejected | External ID already used - Duplication |
501 | Rejected | Country not found |
502 | Rejected | Currency not allowed |
503 | Rejected | Transactions not found |
504 | Rejected | Limit exceeded |
505 | Rejected | Insufficient funds |
506 | Rejected | Transaction could not be cancelled |
507 | Rejected | Transaction could not be received |
508 | Rejected | Invalid merchant |
509 | Rejected | Invalid date |
510 | Rejected | Transaction could not be executed |
511 | Rejected | ZeroAmount |
512 | Rejected | NotAllowedAmount |
513 | Rejected | Invalid Bank |
514 | Rejected | Invalid Service |
537 | Rejected | Access Denied |
538 | Rejected | Invalid Password |
539 | Rejected | Comunication Error |
600 | Rejected | Sender Blacklisted |
601 | Rejected | Beneficiary blacklisted |
602 | Rejected | Amount exceeds max limit |
603 | Rejected | Rejected by AML |
604 | Rejected | Rejected compliance limits |
701 | Rejected | IncorrectAccountNumber |
702 | Rejected | Inactive Account |
703 | Rejected | Inactive Transaccion Account |
707 | Rejected | InvalidAccountCurrency |
716 | Rejected | TransactionNotSupported |
719 | Rejected | Amount must not be empty and more than 0 |
721 | Rejected | NotAllowedCurrency |
736 | Rejected | InvalidCountry |
771 | Rejected | Your Client Payin Settings have not been configured |
772 | Rejected | Your Provider Payin Settings have not been configured |
801 | Rejected | Params error |
802 | Rejected | Rejected by provider |
803 | Rejected | Invalid card cvv |
804 | Rejected | Invalid card number |
805 | Rejected | Invalid payment method code |
806 | Rejected | Invalid card cvv length |
807 | Rejected | Invalid card token provider |
808 | Rejected | Generic provider error |
809 | Rejected | Invalid card number length |
810 | Rejected | Not allowed to process Credit or Debit Card of foreign countries - Only Local cards |
811 | Rejected | Requested amount is higher or lower than allowed max/min values |
812 | Rejected | External Id already used - duplication |
813 | Rejected | Invalid country |
815 | Rejected | Invalid email |
817 | Rejected | Invalid concept code |
818 | Rejected | Invalid payment method type |
819 | Rejected | Invalid payment method |
820 | Rejected | Unknown error |
821 | Rejected | Invalid card for payment method |
822 | Rejected | Invalid relationship between provider and payment method |
823 | Rejected | Payment method not supported by provider |
824 | Rejected | Invalid document |
825 | Rejected | System error to generate payin |
826 | Rejected | System error to cancel payin |
827 | Rejected | System error to refund payin |
828 | Rejected | System error to validate BIN |
829 | Rejected | System error to generate Installment Plan |
830 | Rejected | Instalments Plan token is invalid or expired |
831 | Rejected | FX Token not valid |
832 | Rejected | Rejected by client |
833 | Rejected | System error to capture payin |
835 | Rejected | The cardholder did not take a further authentication step |
836 | Rejected | 3D Secure authentication time expired |
850 | Rejected | This Source is not admited |
851 | Rejected | Error update subscription |
900 | Cancelled | The payin was cancelled |
901 | Expired | The payin has expired |
902 | Refunded | The payin was refunded |
905 | Cancelled | The authorization was cancelled |
906 | ChargeBack | The payin has a chargeback |
907 | Expired | The authorization was expired |
908 | Rejected | The payer's account is unable to use this service |
909 | Rejected | The user did not complete the checkout |
910 | Rejected | The bank is currently unavailable for this payment method. Please consider using an alternative bank or try again later. |
911 | Rejected | The Payer's bank account credentials are invalid, Please contact your bank or try again later |
912 | Rejected | Amount exceeds max limit for new contacts |
913 | Rejected | The maximum number of transfers for new contacts was reached. |
915 | Rejected | The phone number provided doesn't match any account |
920 | Rejected | The 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).
Code | Status | Description |
---|---|---|
104 | Received | The subscription was received |
105 | Inprogress | The subscription is in progress |
106 | Onhold | The subscrition is on hold |
202 | Completed | The subscription was completed |
300 | Rejected | Invalid param + [param name] + [reason] |
301 | Rejected | Empty mandatory param + [param name] |
834 | Rejected | System error to generate subscription |
851 | Rejected | Error update subscription |
903 | Cancelled | The subscription was canceled - merchant request |
904 | Cancelled | The subscription was canceled - too many failed attempts |
921 | Cancelled | Subscription was canceled - due to lost chargeback |
922 | ChargeBack | The subscription on hold - Chargeback in progress |
Payout
Payout transactions represent funds being withdrawn from a Localpayment account.
Code | Status | Description |
---|---|---|
100 | Received | The payout was received |
101 | Locked | The payout has been confirmed and passed AML validations |
102 | InProgress | The payout has been sent to the bank |
103 | OnHold | The provider is not configured |
104 | PendingAuth | The payout is pending of authorization by client |
105 | OnHold | OnHold by AML |
200 | Completed | The payout was debited |
300 | Rejected | Invalid param + [param name] + [reason] |
301 | Rejected | Empty mandatory param + [param name] |
302 | Rejected | Invalid control string characters |
303 | Rejected | Invalid exchange rate token |
400 | Rejected | Unregistered IP address |
401 | Rejected | Invalid credentials |
402 | Rejected | Unauthorized |
403 | Rejected | Failure to conecct to API |
404 | Rejected | Too many requests |
500 | Rejected | External ID already used - Duplication |
501 | Rejected | Country not found |
502 | Rejected | Currency not allowed |
503 | Rejected | Transactions not found |
504 | Rejected | Limit exceeded |
505 | Rejected | Insufficient funds |
506 | Rejected | Transaction could not be cancelled |
507 | Rejected | Transaction could not be received |
508 | Rejected | Invalid merchant |
509 | Rejected | Invalid date |
510 | Rejected | Transaction could not be executed |
511 | Rejected | ZeroAmount |
512 | Rejected | NotAllowedAmount |
513 | Rejected | Restricted payment: Payment to a Virtual Account is not allowed |
600 | Rejected | Sender Blacklisted |
601 | Rejected | Beneficiary blacklisted |
602 | Rejected | Amount exceeds max limit |
603 | Rejected | Rejected by AML |
604 | Rejected | Rejected compliance limits |
701 | Rejected | InvalidAccountNumber - Alias does not exist or could not be found |
702 | Rejected | InvalidAccountNumber - Account Closed |
703 | Rejected | InvalidAccountNumber - Account Bloqued |
704 | Rejected | InvalidAccountType - Non-existent or invalid Account Type |
705 | Rejected | IncorrectAccountNumber - Doesn´t match regex |
707 | Rejected | InvalidAccountCurrency |
708 | Rejected | InvalidAccountOwner - ID informed is not consistent with the Account Holder |
709 | Rejected | InvalidAccountOwner - ID informed is incorrect |
710 | Rejected | ProcessingError |
715 | Rejected | InvalidAccountNumber - Alias does not exist or could not be found. |
716 | Rejected | TransactionNotSupported |
719 | Rejected | Amount must not be empty and more than 0 |
720 | Rejected | Bank Not Supported |
721 | Rejected | NotAllowedCurrency |
736 | Rejected | InvalidCountry |
771 | Rejected | InvalidPaymentTypeInformation |
773 | Rejected | The bank does not work with this account type |
801 | Rejected | Params error |
802 | Rejected | Rejected by provider |
805 | Rejected | Invalid payment method code |
808 | Rejected | Generic provider error |
809 | Rejected | Payment not allowed to this beneficiary bank |
810 | Rejected | Payment amount exceeds the limit allowed for the beneficiary account. |
811 | Rejected | Invalid amount |
812 | Rejected | External Id already used - duplication |
813 | Rejected | Invalid country |
815 | Rejected | Invalid email |
817 | Rejected | Invalid concept code |
818 | Rejected | Invalid payment method type |
819 | Rejected | Invalid payment method |
820 | Rejected | Unknown error |
821 | Rejected | PIX not allowed to this beneficiary bank institution |
822 | Rejected | Invalid relationship between provider and payment method |
823 | Rejected | Payment method not supported by provider |
824 | Rejected | Invalid document |
825 | Rejected | System error to generate payout |
826 | Rejected | System error to cancel payout |
827 | Rejected | System error to refund payout |
828 | Rejected | System error to validate BIN |
829 | Rejected | PIX not allowed to this beneficiary bank account |
830 | Rejected | Incorrect data of the Bank |
831 | Rejected | Error account not match beneficiary name |
832 | Rejected | Error bank branch incorret |
833 | Rejected | Error account not accept transfers |
834 | Rejected | Error beneficiary document does not match name |
835 | Rejected | This Source is not admited |
836 | Rejected | This account does not match the beneficiary's identification document |
900 | Cancelled | The payout was cancelled |
901 | Returned | The payout was returned |
902 | Recalled | The payout was recalled |
903 | Rejected | Invalid QR code |
904 | Rejected | QR code has been cancelled |
905 | Rejected | QR code has expired |
906 | Rejected | QR code has already been paid |
920 | Rejected | The payment method is currently not available for this country. Consider using another payment method or try again later. |
921 | Rejected | Rechazado por cuenta fraudulenta |
tDis | Rejected | No test disable |
tEna | Rejected | Yes test enable |
Chargeback
Chargebacks are initiated by the cardholder's bank and represent a reversal of a previous Payin.
Code | Status | Category | Description |
---|---|---|---|
100 | Received | 0 | Chargeback has been received |
101 | DocReceived | 0 | Dispute documentation received |
102 | InDispute | 0 | Dispute documentation was sent to the acquire |
200 | Completed | 0 | Chargeback has been completed |
201 | DisputeLost | 0 | Dispute debited |
202 | DisputeWon | 0 | Dispute credited |
Credit
Credit transactions represent operations performed using credit cards.
Code | Status | Description |
---|---|---|
200 | Completed | EE REFUNDED |
201 | Completed | COMMISSION REFUNDED |
202 | Completed | TAX REFUNDED |
203 | Completed | TRANSACTION REFUNDED |
204 | Completed | INVESTMENT |
205 | Completed | COLLECTION |
Currency Exchange
Currency Exchange transactions represent the conversion of funds from one currency to another.
Code | Status | Category | Description |
---|---|---|---|
200 | Completed | CURRENCY EXCHANGE | |
405 | Rejected | BusinessLogicError | External not admin user cannot create currency exchange bulk transactions |
511 | Rejected | BusinessLogicError | ZeroAmount |
701 | Rejected | ProcessingError | Debited Account Not Exists |
702 | Rejected | ProcessingError | Accounts owner client must be same |
703 | Rejected | ProcessingError | Accounts countries must be match |
704 | Rejected | ProcessingError | Credited account not exists |
705 | Rejected | ProcessingError | Credited account currency not match |
706 | Rejected | ProcessingError | Transaction type not allowed for credited account |
716 | Rejected | ProcessingError | Debited account not admit transaction type |
825 | Rejected | ProcessingError | System error to generate currency exchange |
826 | Rejected | ProcessingError | Invalid account balance amount |
Debit
Debit transactions represent operations performed using debit cards.
Code | Status | Description |
---|---|---|
200 | Completed | SWIFT FEE DEBITED |
201 | Completed | COMMISSION DEBITED |
202 | Completed | TAX DEBITED |
203 | Completed | TRANSACTION DEBITED |
204 | Completed | BANK FEE |
205 | Completed | SUPPLIERS |
206 | Completed | BANK CHARGERS |
207 | Completed | INTEREST |
Expenses
Expenses track costs associated with operations (e.g., fees).
Code | Status | Description |
---|---|---|
200 | Completed | Bank fees |
201 | Completed | Invoice |
202 | Completed | Lawyer |
203 | Completed | Accountant |
Recall
Recalls are requests to reverse a payment, typically used in specific payment methods or regions.
Code | Status | Description |
---|---|---|
200 | Completed | THE PAYOUT HAS BEEN RECALLED |
Refund
Refunds represent the return of funds to a customer for a specific, previously completed Payin.
Code | Status | Description |
---|---|---|
100 | Received | The refund was received |
101 | Locked | The refund has been confirmed and passed AML validations |
102 | InProgress | The refund has been sent to the bank |
103 | OnHold | The refund is on hold |
104 | PendingAuth | The refund is pending of authorization by client |
200 | Completed | The payin has been refunded |
300 | Rejected | Invalid param + [param name] + [reason] |
301 | Rejected | Empty mandatory param + [param name] |
302 | Rejected | Invalid control string characters |
303 | Rejected | Invalid exchange rate token |
400 | Rejected | Unregistered IP address |
401 | Rejected | Invalid credentials |
402 | Rejected | Unauthorized |
403 | Rejected | Failure to conecct to API |
404 | Rejected | Too many requests |
500 | Rejected | External ID already used - Duplication |
501 | Rejected | Country not found |
502 | Rejected | Currency not allowed |
503 | Rejected | Transactions not found |
504 | Rejected | Limit exceeded |
505 | Rejected | Insufficient funds |
506 | Rejected | Transaction could not be cancelled |
507 | Rejected | Transaction could not be received |
508 | Rejected | Invalid merchant |
509 | Rejected | Invalid date |
510 | Rejected | Transaction could not be executed |
511 | Rejected | ZeroAmount |
512 | Rejected | NotAllowedAmount |
600 | Rejected | Sender Blacklisted |
601 | Rejected | Beneficiary blacklisted |
602 | Rejected | Amount exceeds max limit |
603 | Rejected | Rejected by AML |
604 | Rejected | Rejected compliance limits |
701 | Rejected | IncorrectAccountNumber |
702 | Rejected | InvalidAccountNumber - Account Closed |
703 | Rejected | InvalidAccountNumber - Account Bloqued |
704 | Rejected | InvalidAccountType - Non-existent or invalid Account Type |
705 | Rejected | IncorrectAccountNumber - Doesn´t match regex |
707 | Rejected | InvalidAccountCurrency |
708 | Rejected | InvalidAccountOwner - ID informed is not consistent with the Account Holder |
709 | Rejected | InvalidAccountOwner - ID informed is incorrect |
710 | Rejected | InvalidAccountOwner - Not informed |
716 | Rejected | TransactionNotSupported |
721 | Rejected | NotAllowedCurrency |
736 | Rejected | InvalidCountry |
771 | Rejected | InvalidPaymentTypeInformation |
801 | Rejected | Params error |
802 | Rejected | Rejected by provider |
805 | Rejected | Invalid payment method code |
808 | Rejected | Generic provider error |
809 | Rejected | Payment not allowed to this beneficiary bank |
810 | Rejected | Payment amount exceeds the limit allowed for the beneficiary account. |
811 | Rejected | Invalid amount |
812 | Rejected | External Id already used - duplication |
813 | Rejected | Invalid country |
815 | Rejected | Invalid email |
817 | Rejected | Invalid concept code |
818 | Rejected | Invalid payment method type |
819 | Rejected | Invalid payment method |
820 | Rejected | Unknown error |
821 | Rejected | PIX not allowed to this beneficiary bank institution |
822 | Rejected | Invalid relationship between provider and payment method |
823 | Rejected | Payment method not supported by provider |
824 | Rejected | Invalid document |
825 | Rejected | System error to generate payout |
826 | Rejected | System error to cancel payout |
827 | Rejected | System error to refund payout |
828 | Rejected | System error to validate BIN |
829 | Rejected | PIX not allowed to this beneficiary bank account |
831 | Rejected | Error account not match beneficiary name |
832 | Rejected | Error bank branch incorrect |
833 | Rejected | Error account not accept transfers |
834 | Rejected | Error beneficiary document does not match name |
900 | Cancelled | The refund was cancelled |
901 | Returned | The refund was returned |
902 | Recalled | The 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).
Code | Status | Description |
---|---|---|
200 | Completed | THE PAYOUT HAS BEEN RETURNED |
Recurring Fee
Recurring Fees are charges related to subscription or account maintenance.
Code | Status | Description |
---|---|---|
200 | Completed | MONTHLY COMMISION |
201 | Completed | ANNUAL COMMISION |
202 | Completed | TAX PROCESSING COMMISION |
203 | Completed | ACCOUNT MAINTENANCE FEE |
Wire In
Wire In transactions represent incoming wire transfers.
Code | Status | Description |
---|---|---|
100 | PendingCredit | Pending Credit |
200 | Completed | Completed |
717 | RejectedByBank | Rejected |
Wire Out
Wire Out transactions represent outgoing wire transfers.
Code | Status | Description |
---|---|---|
100 | PendingAuth | Pending Authorization |
101 | PendingDebit | In Progress |
102 | Received | Authorized |
200 | Completed | Completed |
404 | Rejected | Provider Code not matching with account number |
511 | Rejected | ZeroAmount |
716 | Rejected | Rejected by admin |
717 | RejectedByBank | Rejected by bank |
718 | RejectedByBank | Destination account not found |
719 | RejectedByBank | Rejected |
826 | Rejected | Invalid accoun |