Sale status

Introduction

Sale status is initiated through HTTPS POST request by using URLs and the parameters.
Sale status request is made by Connecting Party’s app to GitPay to get the status of sale transaction.
It is recommended to send Sale status request for a period of 2-3 minutes with interval of 3-5 seconds between requests. Connecting Party’s server should rely on the callback for final status.

API URLs

Integration	Production
https://sandbox.gitpay.tech/paynet/dapi/v1/sale/{endpointId}/{invoiceId}/status	https://gate.gitpay.tech/paynet/dapi/v1/sale/{endpointId}/{invoiceId}/status

Request Parameters

Parameter Name	Description	Value
session		`Type`: Object
session.accessToken	The access token key received in Optional consumer authentication.	`Type`: String `Length`: 32-128
session.token	The session token of sale transaction.	`Type`: String `Length`: 16-36

Success Response Parameters

Parameter Name	Description	Value
invoiceId	Sale transaction identifier.	`Type`: String
session		`Type`: Object
session.token	The session token of sale transaction	`Type`: String
state	Possible values: `PROCESSING`, `REDIRECT_REQUEST`, `APPROVED`, `DECLINED`.	`Type`: Enum
bankOrderId	Required if state is `APPROVED` or `DECLINED`.	`Necessity`: Conditional `Type`: String `Length`: 128
redirectUrl	Required if state is `REDIRECT_REQUEST`.	`Necessity`: Conditional `Type`: String `Length`: 128
orderId	Order identifier in payment processing system.	`Necessity`: Conditional `Type`: String
transaction		`Necessity`: Conditional `Type`: Object
transaction.amountCentis	Amount of money transfered in centis, 1.00 EUR = 100 centis.	`Necessity`: Conditional `Type`: Integer
transaction.commissionCentis	Amount of commission held in centis (depends on the integration).	`Necessity`: Conditional `Type`: Integer
transaction.orderCreatedDate	Order creation date in payment processing system.	`Necessity`: Conditional `Type`: String
transaction.transactionCreatedDate	Transaction creation date in payment processing system.	`Necessity`: Conditional `Type`: String
errorCode	Decline reason code, may present if state is `DECLINED`.	`Necessity`: Optional `Type`: Integer
errorMessage	Decline reason message, may present if state is `DECLINED`.	`Necessity`: Optional `Type`: String `Length`: 128
secure3DAuthStatus	Possible values: `AUTHENTICATED`, `NOT_AUTHENTICATED`, `UNSUPPORTED`, `UNSUPPORTED` means that card does not support 3-D Secure or 3DS authentication process finished with an unknown status.	`Necessity`: Optional `Type`: Enum
randomSumAuthStatus	Possible values: `AUTHENTICATED`, `NOT_AUTHENTICATED`.	`Necessity`: Optional `Type`: Enum

Fail Response Parameters

Parameter Name	Description	Value
error		`Type`: Object
error.cause	Cause of the error. Possible values: `FILTERED`, `INVALID_REQUEST`, `INTERNAL_ERROR`, `PROCESSING_FAILED`, `ORDER_NOT_FOUND`.	`Type`: Enum
error.code	The unique error code.	`Type`: String
error.message	Description of the error.	`Type`: String
invoiceId	Sale transaction identifier.	`Type`: String

Request Example

{
  "session": {
    "accessToken": "string",
    "token": "string"
  }
}

Success Response Example

{
  "bankOrderId": "string",
  "invoiceId": "string",
  "redirectUrl": "string",
  "session": {
    "token": "string"
  },
  "state": "enum"
}

Fail Response Example

{
  "error": {
    "cause": "enum",
    "code": "string",
    "message": "string"
  },
  "invoiceId": "string"
}

Request Builder

Endpoint Id
Invoice Id	Generated by Merchant's server in "Initiate sale"
session.accessToken	Generated by Merchant's server in "Consumer authentication"
session.token	Obtained in "Perform sale" response

Curl for Unix
Curl for Windows