FundingInformation: Difference between revisions

From Barion Documentation
Jump to navigation Jump to search
mNo edit summary
m (replaced reference to v2 GetPaymentState with v4 PaymentState)
 
(12 intermediate revisions by 4 users not shown)
Line 1: Line 1:
{{PageTitle|title=Funding information structure}}
{{PageTitle|title=Funding information structure}}


This structure represents the details about a funding source that was used when completing a payment. At the moment this is only used when the funding source is a bank card.
This structure represents the details about the funding source of the last payment attempt. At the moment this is only used when the funding source is a bank card.


= API usage =
= API usage =


This structure is used by the following API endpoints:
This structure is used by the following API endpoints:
* [[Payment-GetPaymentState-v2]]
* [[Payment-PaymentState-v4]]


= Property list =
= Property list =
Line 12: Line 12:
{{api_output_table_header}}
{{api_output_table_header}}
|-
|-
| BankCard || [[BankCard]] || The bank card used to complete the payment.
| BankCard || [[BankCard]] || The bank card used to complete the payment. If there was no bank card used in the attempt, this is empty.
|-
|-
| AuthorizationCode || string || The authorization code received by the card processing system when executing the payment.
| AuthorizationCode || string || The authorization code received by the card processing system when executing the payment. If authorization was not successful, this is empty.
|-
|-
| ProcessResult || string || The result of the last card payment attempt. Possible values:
| ProcessResult || string || The result of the last card payment attempt. If there was no charge attempt, this is empty.<br>Possible values:
* Successful: the card transaction was successful
* <b>Successful</b>: the card transaction was successful
* ProblemWithCard: the card transaction was unsuccessful: card number, CVC or/and expiry is wrong.  
* <b>ProblemWithCard</b>: the card transaction was unsuccessful: card number, CVC or/and expiry is wrong. The card may have been stolen, deleted, disabled or disabled for online transactions.
* LowFunds: the card transaction was unsuccessful due to insufficient funds
* <b>LowFunds</b>: the card transaction was unsuccessful due to insufficient funds or limits were reached
* LostOrStolenCard: the credit card has been reported lost or stolen
* <b>LostOrStolenCard</b>: the credit card has been reported lost or stolen
* CardNotSupported: the payment card is not supported at the time of the transaction
* <b>Declined</b>:  the payment card was declined by the acquirer
* Declined:  the payment card was declined by the acquirer
* <b>FraudulentTransaction</b>: potentially fraudulent transaction, the monitoring system declined the transaction
* FraudulentTransaction: potentially fraudulent transaction, the monitoring system declined the transaction
* <b>CardSystemError</b>: the card transaction failed due to the card system
* CardSystemError: the card transaction failed due to the card system
* <b>ScaSoftDeclined</b>: the payment card did not support SCA at the time of the transaction
* SystemError: system error, in this case we try to refund the transaction amount if we have enough information to initiate it
* <b>FailedDuringAuthentication</b>: there was an  error during the SCA process thus authentication failed. This may not be returned if ChallengePreference was set to "NoChallengeNeeded"
* SoftDeclined: the payment card did not support SCA at the time of the transaction
* <b>CardNotSupported</b>: the payment card is not supported at the time of the transaction
* <b>Unknown</b>: the bank system did not provide information about the operation, the result of the process could not be determined
|-
|-
|}
|}

Latest revision as of 10:03, 25 March 2024

Funding information structure

This structure represents the details about the funding source of the last payment attempt. At the moment this is only used when the funding source is a bank card.

API usage

This structure is used by the following API endpoints:

Property list

Property name Property type Description
BankCard BankCard The bank card used to complete the payment. If there was no bank card used in the attempt, this is empty.
AuthorizationCode string The authorization code received by the card processing system when executing the payment. If authorization was not successful, this is empty.
ProcessResult string The result of the last card payment attempt. If there was no charge attempt, this is empty.
Possible values:
  • Successful: the card transaction was successful
  • ProblemWithCard: the card transaction was unsuccessful: card number, CVC or/and expiry is wrong. The card may have been stolen, deleted, disabled or disabled for online transactions.
  • LowFunds: the card transaction was unsuccessful due to insufficient funds or limits were reached
  • LostOrStolenCard: the credit card has been reported lost or stolen
  • Declined: the payment card was declined by the acquirer
  • FraudulentTransaction: potentially fraudulent transaction, the monitoring system declined the transaction
  • CardSystemError: the card transaction failed due to the card system
  • ScaSoftDeclined: the payment card did not support SCA at the time of the transaction
  • FailedDuringAuthentication: there was an error during the SCA process thus authentication failed. This may not be returned if ChallengePreference was set to "NoChallengeNeeded"
  • CardNotSupported: the payment card is not supported at the time of the transaction
  • Unknown: the bank system did not provide information about the operation, the result of the process could not be determined