Payment status retrieval

Payment status retrieval
  • Payment gateway provides 4 possibilities to get current status of payment or transaction. There are methods for receiving invoice status by invoice reference or order identifier.
  • There is the possibility get whole information of transaction using invoice reference and transaction identifier or order identifier and transaction identifier. Methods with examples of responses are described below.
Payment status retrieval using invoice_ref
  • Method: POST , URL /get/invoice/{invoice_ref}
  • Fields for signature calculation: <invoice_ref><X-Shop-Name><X-Nonce><ShopPassword>
  • Based on invoice type (non-recurring or recurring) the appropriate response will be given.
Example response
{
  "type": "InvoiceDto",
  "invoice_ref": "Tpn01456cSRFjHdqWPfPaWcdy",
  "amount": 20.00,
  "currency": "EUR",
  "created_date": "2017-12-20T07:53:53.647Z",
  "updated_date": "2017-12-20T07:53:55.656Z",
  "due_date": null,
  "shop_code": "TEST",
  "invoice_status": "SUCCEEDED",
  "payment_id": "21678654",
  "target_payment_id": null,
  "order_id": "cgW14563SztuNlJoFY89",
  "error_code": null,
  "error_message": null,
  "payment_method": "FD_SMS",
  "merchant_name_a": null,
  "merchant_name_b": null,
  "customer": {
    "additional_data": null,
    "address": null,
    "email": null,
    "first_name": null,
    "last_name": null,
    "personal_code": null,
    "phone": null,
    "site_id": null,
    "country": null,
    "user_time": null,
    "user_timezone": null,
    "zip": null,
    "city": null,
    "ip": "128.101.101.101",
    "referer": null,
    "mcc": null,
    "additional_params": {

    }
  },
  "products": [

  ],
  "details": {

  }
}
          
Payment status retrieval using order_id
  • Method: POST , URL /get/order/{order_id}
  • Fields for signature calculation: <order_id><X-Shop-Name><X-Nonce><ShopPassword>
  • Based on invoice type (non-recurring or recurring) the appropriate response will be given.
Example response
{
  "type": "InvoiceDto",
  "invoice_ref": "Tpn01456cSRFjHdqWPfPaWcdy",
  "amount": 20.00,
  "currency": "EUR",
  "created_date": "2017-12-20T07:53:53.647Z",
  "updated_date": "2017-12-20T07:53:55.656Z",
  "due_date": null,
  "shop_code": "TEST",
  "invoice_status": "SUCCEEDED",
  "payment_id": "21678654",
  "target_payment_id": null,
  "order_id": "cgW14563SztuNlJoFY89",
  "error_code": null,
  "error_message": null,
  "payment_method": "FD_SMS",
  "merchant_name_a": null,
  "merchant_name_b": null,
  "customer": {
    "additional_data": null,
    "address": null,
    "email": null,
    "first_name": null,
    "last_name": null,
    "personal_code": null,
    "phone": null,
    "site_id": null,
    "country": null,
    "user_time": null,
    "user_timezone": null,
    "zip": null,
    "city": null,
    "ip": "128.101.101.101",
    "referer": null,
    "mcc": null,
    "additional_params": {

    }
  },
  "products": [

  ],
  "details": {

  }
}
          
Transaction status retrieval using invoice_ref and transaction_id
  • Method: POST , URL /get/invoice/{invoice_ref}/{transaction_id}
  • Fields for signature calculation: <invoice_ref><X-Shop-Name><X-Nonce><ShopPassword>
  • Returns information about transaction (amount, date, status etc) or error, if specified object by shop/invoice_ref/transaction_id cant be found.
Example response
{
  "id": 372214,
  "amount": 10.00,
  "payment_id": "21353644",
  "target_payment_id": null,
  "currency": "EUR",
  "minor_amount": 1000,
  "created_date": "2017-12-20T07:41:52.944Z",
  "updated_date": "2017-12-20T07:41:53.317Z",
  "transaction_type": "PAYOUT",
  "status": "SUCCEEDED",
  "error_code": null,
  "error_message": null,
  "shop_code": "TEST",
  "invoice_ref": "qohrghu2bv8kF2UTKgQzhvreQ"
}
          
Transaction status retrieval using order_id and transaction_id
  • Method: POST , URL /get/order/{order_id}/{transaction_id}
  • Fields for signature calculation: <invoice_ref><X-Shop-Name><X-Nonce><ShopPassword>
  • Returns information about transaction (amount, date, status etc) or error, if specified object by shop/order_id/transaction_id cant be found.
Example response
{
  "id": 372214,
  "amount": 10.00,
  "payment_id": "21353644",
  "target_payment_id": null,
  "currency": "EUR",
  "minor_amount": 1000,
  "created_date": "2017-12-20T07:41:52.944Z",
  "updated_date": "2017-12-20T07:41:53.317Z",
  "transaction_type": "PAYOUT",
  "status": "SUCCEEDED",
  "error_code": null,
  "error_message": null,
  "shop_code": "TEST",
  "invoice_ref": "qohrghu2bv8kF2UTKgQzhvreQ"
}