Response parameters in a Get Status call

Follow

Following is a list of all the possible parameters that you can receive in the transaction response when you execute the Get Status step:

Format of the response

The GetStatus call of COPYandPAY delivers the status of the payment in json format.

Sample response Expand source
 

 


Token

JSON path: data.token

Parameter
sent by the merchant...(true|false)
mandatory...(true|false)
token true true

Example:

Payment Session Token
"token":"86DFD8B5954589B2C15B0AC0F3D529EC.sbg-vm-fe02",

 


Account data

Card payments

JSON path: data.transaction.account

Parameter
sent by the merchant...(true|false)
mandatory...(true|false)
bin false true
brand true true
expiry month true true
expiry year true

true

holder true true
last4Digits false true

Example:

Credit card/Debit card
"account":{ 
         "bin":"420000",
         "brand":"VISA",
         "expiry":{ 
            "month":"12",
            "year":"2014"
         },
         "holder":"test",
         "last4Digits":"0000"
      },

Bank payments

JSON path: data.transaction.account

Parameter
sent by the merchant...(true|false)
mandatory...(true|false)
bic true true
brand true true
country false true
iban true

true

holder true true

Example:

Direct Debit
"account":{ 
        "bic":"MARKDEF1100",
        "brand":"DIRECTDEBIT_SEPA",
        "country":"DE",
        "holder":"Hans Mueller",
        "iban":"DE23100000001234567890"
      },

Online Transfer

JSON path: data.transaction.account

Parameter
sent by the merchant...(true|false)
mandatory...(true|false)
brand true true
country false true

Example:

Online Transfer
"account":{
        "brand":"SOFORTUEBERWEISUNG",
        "country":"DE"
      },

Wallet payments

JSON path: data.transaction.account

Parameter
sent by the merchant...(true|false)
mandatory...(true|false)
brand true true

Example:

Virtual Account
"account":{ 
        "brand":"PAYPAL"
      },

 


Channel

JSON path: data.transaction.channel

Parameter
sent by the merchant...(true|false)
mandatory...(true|false)
channel true true

Example:

Channel data
"channel":"8a8294174739d75b01473a26bfd400b8",

 


Criterions (optional)

In case Criterions were sent as part of the original payment request those Criterions are returned in the response.

JSON path: data.transaction.criterions

Parameter
sent by the merchant...(true|false)
mandatory...(true|false)
criterions true false

Example:

Criterion data
"criterions":[ 
         
            "name":"mode",
            "value":"copyandpay"
         }
      ],

 


Customer

JSON path: data.transaction.customer

Parameter
sent by the merchant...(true|false)
mandatory...(true|false)
city true false
country true false
street true false
zip true false
ip true|false true
ipCountry false true

Example:

Customer data
"customer":{ 
         "address":{ 
            "city":"MUNCHEN",
            "country":"DE",
            "street":"BAYERN",
            "zip":"12345"
         },
         "contact":{ 
            "ip":"82.135.34.186",
            "ipCountry":"de"
         }
      },

 


Identification

JSON path: data.transaction.identification

Parameter
sent by the merchant...(true|false)
mandatory...(true|false)
shopperid true false
transactionId true false
shortId false true
uniqueId false true

Example:

Identification data
"identification": {
       "shopperid": "4133704761",
       "transactionId": "1233704761"
       "shortId": "9666.2410.9218",
       "uniqueId": "8a82944a4748bd97014757aa73b84cda"
   },

 


Mode

JSON path: data.transaction.mode

Parameter
sent by the merchant...(true|false)
mandatory...(true|false)
mode true true

Example:

Mode
"mode": "CONNECTOR_TEST",

 


Payment

JSON path: data.transaction.payment

Parameter
sent by the merchant...(true|false)
mandatory...(true|false)
amount (clearing) true true
currency (clearing) true true
code true true
amount (presentation) true true
currency (presentation) true true

Example:

Payment data
"payment": {
     "clearing": {
       "amount": "50.0",
       "currency": "EUR"
     },
     "code": "CC.DB",
     "presentation": {
       "amount": "50.0",
       "currency": "EUR"
     }
   },

 


Processing data

JSON path: data.transaction.processing

Parameter
sent by the merchant...(true|false)
mandatory...(true|false)
code false true
connectorDetails false false
reason false true
result false true
code false true
message false true

Example:

Processing data
"processing": {
     "code": "CC.DB.90.00",
     "connectorDetails": [
       {
         "name": "ConnectorTxID1",
         "value": "260417"
       },
       {
         "name": "ConnectorTxID3",
         "value": "26K00001"
       }
     ],
     "reason": {
       "code": "00",
       "message": "Successful Processing"
     },
     "result": "ACK",
     "return": {
       "code": "000.100.112",
       "message": "Request successfully processed in 'Merchant in Connector Test Mode'"
     },
     "timestamp": "2014-07-21 06:45:53"
   },

 


Response type

JSON path: data.transaction.response

Parameter
sent by the merchant...(true|false)
mandatory...(true|false)
response false true

Example:

Processing data
"response": "ASYNC"

 

Have more questions? Submit a request

Comments

Powered by Zendesk