Payments

Payment Statuses

The current stage of a payment lifecycle is represented in status field. The status of a payment can be one of the following:

Name	Description
processing	Salt Edge PSD2 Compliance is processing the request or response.
redirect	Provider requires a redirect for authentication.
waiting_confirmation	Provider is waiting for the consent of Customer.
waiting_confirmation_code	Provider is waiting for a confirmation code, be it OTP for authentication or Dynamic linking for performing a payment.
closed	Session is closed.

Create

Create a payment order on behalf of PSU

CURL

curl -i \ -H "Authorization: Bearer eyJhbGciOiJSUzI1NiJ9.eyJkYXRhIjp7InJlZGlyZWN0X3VybCI6Imh0dHBzOi8vdXNlci53aWxsLmJlL3JlZGlyZWN0ZWQvaGVyZSIsImJlbmVmaWNpYXJ5X2lkIjozODMsImZvcmNlX3NjYSI6dHJ1ZSwiZXh0cmEiOnt9LCJ0ZW1wbGF0ZV9pZCI6ODI0LCJwYXltZW50X2F0dHJpYnV0ZXMiOnsiZnJvbV9hY2NvdW50IjoiOTU0MjM0MjMxMiIsInRvX2FjY291bnQiOiIzNDU4OTc5NTcwIiwiYW1vdW50IjoiMTUwLjAwIiwiZGVzY3JpcHRpb24iOiJUZXN0IHBheW1lbnQuIn0sInByb3ZpZGVyX2NvZGUiOiJkZW1vYmFuayJ9LCJleHAiOjE3NDMzMTAwMDYsImlzcyI6InByaW9yYS5zYWx0ZWRnZS5jb20ifQ.kIL2phDsDiBbuJhWtMbFh86dpaYQHkxpYL-_--BCo3Hl7WnwVPnfQZAeZcz7r9P1wpct6BykNH8ASn02EiFSxQ2p5STqc32OV20CZzkb-kZUu-WZqNdbIajSCF8UTTCXqNnVQQlO5l19qk1zR5tR9aJKTNDVE35YrjFzAvfTZeDLx0o2d1RDBH6lU5_-C7rO9_Hdqq9Rp0Gjdhilyu-FpLpqfg2sPa-vqrHZvBwvCRUdvtgsDi_HbldQAwo2cjlKeeh20tvcqyDOJsPh3czGkInUMMJn4K6mLGeM-s7_FLfO1H079wpY05o9adyOsQxdomb8mNm9mzhyxe3Lci4rbw" \ -H "App-Id: pRhi4X5YXwmccpgmDsLb1w" \ -H "App-Secret: dszz3LNHbWnqz9HnnH8DhA" \ -H "Access-Token: aacd4e18fab5b180b5e3cc4d35f8600ec08e1be219e5ec9400bc819357928a9283e8d6941215742aaa127d9076496bf210044545cbc1dc00489f295024c926c8" \ -H "Client-Request-Id: 17" \ -X POST "/api/v2/payments"

curl -i  \ 
 -H "Authorization: Bearer eyJhbGciOiJSUzI1NiJ9.eyJkYXRhIjp7InJlZGlyZWN0X3VybCI6Imh0dHBzOi8vdXNlci53aWxsLmJlL3JlZGlyZWN0ZWQvaGVyZSIsImJlbmVmaWNpYXJ5X2lkIjozODMsImZvcmNlX3NjYSI6dHJ1ZSwiZXh0cmEiOnt9LCJ0ZW1wbGF0ZV9pZCI6ODI0LCJwYXltZW50X2F0dHJpYnV0ZXMiOnsiZnJvbV9hY2NvdW50IjoiOTU0MjM0MjMxMiIsInRvX2FjY291bnQiOiIzNDU4OTc5NTcwIiwiYW1vdW50IjoiMTUwLjAwIiwiZGVzY3JpcHRpb24iOiJUZXN0IHBheW1lbnQuIn0sInByb3ZpZGVyX2NvZGUiOiJkZW1vYmFuayJ9LCJleHAiOjE3NDMzMTAwMDYsImlzcyI6InByaW9yYS5zYWx0ZWRnZS5jb20ifQ.kIL2phDsDiBbuJhWtMbFh86dpaYQHkxpYL-_--BCo3Hl7WnwVPnfQZAeZcz7r9P1wpct6BykNH8ASn02EiFSxQ2p5STqc32OV20CZzkb-kZUu-WZqNdbIajSCF8UTTCXqNnVQQlO5l19qk1zR5tR9aJKTNDVE35YrjFzAvfTZeDLx0o2d1RDBH6lU5_-C7rO9_Hdqq9Rp0Gjdhilyu-FpLpqfg2sPa-vqrHZvBwvCRUdvtgsDi_HbldQAwo2cjlKeeh20tvcqyDOJsPh3czGkInUMMJn4K6mLGeM-s7_FLfO1H079wpY05o9adyOsQxdomb8mNm9mzhyxe3Lci4rbw" \ 
 -H "App-Id: pRhi4X5YXwmccpgmDsLb1w" \ 
 -H "App-Secret: dszz3LNHbWnqz9HnnH8DhA" \ 
 -H "Access-Token: aacd4e18fab5b180b5e3cc4d35f8600ec08e1be219e5ec9400bc819357928a9283e8d6941215742aaa127d9076496bf210044545cbc1dc00489f295024c926c8" \ 
 -H "Client-Request-Id: 17" \ 
 -X POST "/api/v2/payments"

Example of request parameters

{
  "data": {
    "redirect_url": "https://user.will.be/redirected/here",
    "beneficiary_id": 383,
    "force_sca": true,
    "extra": {},
    "template_id": 824,
    "payment_attributes": {
      "from_account": "9542342312",
      "to_account": "3458979570",
      "amount": "150.00",
      "description": "Test payment."
    },
    "provider_code": "demobank"
  },
  "exp": 1574093209
}

Example of response

{
  "data": {
    "status": "pending",
    "description": "Internal payment.",
    "fees": [
      {
        "amount": 0.25,
        "description": "Bank fee.",
        "currency_code": "EUR"
      },
      {
        "amount": 0.1,
        "description": "Payment fee.",
        "currency_code": "EUR"
      }
    ],
    "updated_at": "2019-11-18T16:04:50.320Z",
    "id": 997,
    "payment_attributes": {
      "from_account": "9542342312",
      "to_account": "3458979570",
      "amount": "150.00",
      "description": "Test payment."
    },
    "session": {
      "fail_message": "",
      "id": 611,
      "secret": "x2xxJojJkQ9u56EyU_NS",
      "status": "processing",
      "events": [
        {}
      ],
      "success_at": "2019-11-18T16:04:50.320Z",
      "expires_at": "2019-11-18T17:04:50.320Z",
      "fail_at": ""
    },
    "created_at": "2019-11-18T16:04:50.320Z"
  }
}

Request

POST /api/v2/payments

Headers

Header	Type	Description
`Authorization`	string, required	JSON Web Token containing payload, signed using RSA256 and `application.private_key`. Can raise: AuthorizationMissing
`App-Id`	string, required	Application’s `app_id` from connection details tab. Can raise: OauthAppNotFound, CertificateNotFound
`App-Secret`	string, required	Application’s `app_secret` from connection details tab.
`Access-Token`	string, required	Token for which we are requesting info. Can raise: TokenMissing, TokenNotFound, TokenRevoked, TokenExpired
`Client-Request-Id`	string, optional	Request identifier. If present, it will be returned within `meta` field in response.

Unpacked Request Authorization

data

object, required

Wrapper for the data.

provider_code

string, required

Human readable Provider identifier. Can raise: ProviderNotFound, AccessDenied

redirect_url

string, optional

The URL that the PSU will be redirected to proceed with payment. Used for oauth flow.

beneficiary_id

integer, optional

Trusted Beneficiary identifier. Can raise: TrustedBeneficiaryNotFound

force_sca

boolean, optional

Whether to disregard exemptions and force SCA as a required step to process the payment.

extra

object, optional

Extra details that should persist in the session. Default value: {}

template_id

integer, required

Payment template identifier on Salt Edge PSD2 Compliance side. Can raise: TemplateNotFound

payment_attributes

object, required

All attributes (required and optional) that belong to a payment template which PSU fills before creating the payment order.

exp

integer, required

The lifetime of the request in timestamp UTC format. Values greater than: Current time.

Response

Upon successful request, 200 status code will be returned. See ‘Related Errors’ table for other possibilities.

data

object, required

Wrapper for the data.

integer, required

Payment identifier in Salt Edge PSD2 Compliance.

status

string, required

Current status of the payment.

description

string, required

Payment's description.

fees

array, required

List of all fees applied to given payment. Default value: []

amount

float, required

Amount of bank's fee related to the payment.

description

string, required

Fee's description.

currency_code

string, required

Currency code of bank's fee related to the payment.

payment_attributes

object, required

All attributes(required and optional) that are needed for a successful payment initiation.

session

object, required

Related session.

integer, required

Payment identifier in Salt Edge PSD2 Compliance.

secret

string, required

Another session identifier that can be used for session lookup and confirmation.

status

string, required

Current status of the payment. Allowed values: processing, redirect, waiting_confirmation, waiting_confirmation_code, executing, closed, fetched_kyc, fetched_accounts, fetched_transactions, fetched_trusted_beneficiaries

events

array, optional

Related session's events.

success_at

datetime, optional

Datetime of session successful closure.

expires_at

datetime, required

Datetime of session expiration.

fail_at

datetime, optional

Datetime of session failure.

fail_message

string, optional

Session fail message.

created_at

datetime, required

Datetime of payment creation.

updated_at

datetime, required

Datetime of last payment update.

Related Errors

Class	Code	Description
TokenMissing	400	This request cannot be performed without `Access_Token` header.
AccessDenied	401	Action you want to perform is not allowed. More in `error_message`
AuthorizationMissing	401	Authorization header is missing.
TokenNotFound	401	Token specified in request does not exist or cannot be retrieved.
TokenRevoked	401	Token specified in request is revoked and cannot be used anymore.
TokenExpired	401	Token specified in request is expired and cannot be used.
ProviderNotFound	404	Provider specified in request does not exist or cannot be retrieved.
TrustedBeneficiaryNotFound	404	Trusted Beneficiary specified in request does not exist or cannot be retrieved.
TemplateNotFound	404	Template specified in request does not exist or cannot be retrieved.
OauthAppNotFound	404	OAuth Application specified in request does not exist or cannot be retrieved.
CertificateNotFound	404	Certificate has no permissions.

Show

Endpoint used to fetch all data relevant to a payment including fees, status and other.

CURL

curl -i \ -H "Authorization: Bearer eyJhbGciOiJSUzI1NiJ9.eyJkYXRhIjp7ImlkIjo5NjF9LCJleHAiOjE3NDMzMTAwMDYsImlzcyI6InByaW9yYS5zYWx0ZWRnZS5jb20ifQ.J1_husTrCIh5zgt7_uZLzOAd4PCgJB_Uc3L7ciH4HWB-PMtFsXzC3hEDlb65UbBT4aN9I9RC_LCBQQjDui9QpDJB5ORDjSUJCAf8CqK6CgxLxv3Job7aMYwo9i7Zsn3ga3yI6vgUdJeM2PMXwsS6XG0cAOv94d7Es5jN9vBMAYPUXdobVA1zVEqu4QRSHE52cEvaqeNsJ9bYcOqAT2J0_N0UQpUvOpYEXBcVMZd30Y9evQ5jvx6Gd7UqwdFmXft__nltvq0sL8OmRK7Itn39YpfzG7zeodf5IYGIgJTF7BfdHwYG21D9SUIAgtvgNme8XrixIiFa6WI7BSqnKwVqOA" \ -H "App-Id: xiPaOjVpBugwMgcYacdZtA" \ -H "App-Secret: -vhQNUkweQ8udbSof_w-Fg" \ -H "Access-Token: 057b31e63213d7c1f825398fb26de481c5d97ff2d89caad409c2b765418f84ca398f9338df21012f3e004d4c73fef623ce8464e829ce9e58ffc52fdbc48da467" \ -H "Client-Request-Id: 17" \ -X GET "/api/v2/payments/:id"

curl -i  \ 
 -H "Authorization: Bearer eyJhbGciOiJSUzI1NiJ9.eyJkYXRhIjp7ImlkIjo5NjF9LCJleHAiOjE3NDMzMTAwMDYsImlzcyI6InByaW9yYS5zYWx0ZWRnZS5jb20ifQ.J1_husTrCIh5zgt7_uZLzOAd4PCgJB_Uc3L7ciH4HWB-PMtFsXzC3hEDlb65UbBT4aN9I9RC_LCBQQjDui9QpDJB5ORDjSUJCAf8CqK6CgxLxv3Job7aMYwo9i7Zsn3ga3yI6vgUdJeM2PMXwsS6XG0cAOv94d7Es5jN9vBMAYPUXdobVA1zVEqu4QRSHE52cEvaqeNsJ9bYcOqAT2J0_N0UQpUvOpYEXBcVMZd30Y9evQ5jvx6Gd7UqwdFmXft__nltvq0sL8OmRK7Itn39YpfzG7zeodf5IYGIgJTF7BfdHwYG21D9SUIAgtvgNme8XrixIiFa6WI7BSqnKwVqOA" \ 
 -H "App-Id: xiPaOjVpBugwMgcYacdZtA" \ 
 -H "App-Secret: -vhQNUkweQ8udbSof_w-Fg" \ 
 -H "Access-Token: 057b31e63213d7c1f825398fb26de481c5d97ff2d89caad409c2b765418f84ca398f9338df21012f3e004d4c73fef623ce8464e829ce9e58ffc52fdbc48da467" \ 
 -H "Client-Request-Id: 17" \ 
 -X GET "/api/v2/payments/:id"

Example of request parameters

{
  "data": {
    "id": 961
  },
  "exp": 1574093210,
  "id": 141
}

Example of response

{
  "data": {
    "status": "closed",
    "description": "Test payment",
    "fees": [
      {
        "amount": 0.25,
        "description": "Bank fee.",
        "currency_code": "EUR"
      },
      {
        "amount": 0.1,
        "description": "Payment fee.",
        "currency_code": "EUR"
      }
    ],
    "updated_at": "2019-11-18T16:04:50.451Z",
    "id": 305,
    "payment_attributes": {
      "from_account": "9542342312",
      "to_account": "3458979570",
      "amount": "150.00",
      "description": "Test payment."
    },
    "interactive_step_instruction": {
      "interactive_field": "sms_pincode",
      "instruction": {}
    },
    "session": {
      "fail_message": "",
      "id": 501,
      "secret": "oxL4oeiCApNvSKQYKGoi",
      "status": "processing",
      "events": [
        {}
      ],
      "success_at": "2019-11-18T16:04:51.450Z",
      "expires_at": "2019-11-18T17:04:50.450Z",
      "fail_at": ""
    },
    "created_at": "2019-11-18T16:04:50.451Z"
  }
}

Request

GET /api/v2/payments/:id

Headers

Header	Type	Description
`Authorization`	string, required	JSON Web Token containing payload, signed using RSA256 and `application.private_key`. Can raise: AuthorizationMissing
`App-Id`	string, required	Application’s `app_id` from connection details tab. Can raise: OauthAppNotFound, CertificateNotFound
`App-Secret`	string, required	Application’s `app_secret` from connection details tab.
`Access-Token`	string, required	Token for which we are requesting info. Can raise: TokenMissing, TokenNotFound, TokenRevoked, TokenExpired
`Client-Request-Id`	string, optional	Request identifier. If present, it will be returned within `meta` field in response.

Unpacked Request Authorization

data

object, required

Wrapper for the data.

exp

integer, required

The lifetime of the request in timestamp UTC format. Values greater than: Current time.

integer, required

Payment identifier in Salt Edge PSD2 Compliance. Can raise: PaymentNotFound

Response

Upon successful request, 200 status code will be returned. See ‘Related Errors’ table for other possibilities.

data

object, required

Wrapper for the data.

integer, required

Payment identifier in Salt Edge PSD2 Compliance.

status

string, required

Current status of the payment. Allowed values: initiated, processing, redirect, waiting_confirmation, waiting_confirmation_code, closed, executing

description

string, required

Payment's description.

fees

array, required

List of all fees applied to given payment. Default value: []

amount

float, required

Amount of bank's fee related to the payment.

description

string, required

Fee's description.

currency_code

string, required

Currency code of bank's fee related to the payment.

payment_attributes

object, required

All attributes (required and optional) that belong to a payment template which PSU fills before creating the payment order.

interactive_step_instruction

object, required

Object which maps the field with interactive field and it's instruction. Default value: {}

instruction

string, optional

Interactive step instruction.

interactive_field

string, optional

MFA interactive field name.

session

object, required

Related session.

integer, required

Payment identifier in Salt Edge PSD2 Compliance.

secret

string, required

Another session identifier that can be used for session lookup and confirmation.

status

string, required

events

array, optional

Related session's events.

success_at

datetime, optional

Datetime of session successful closure.

expires_at

datetime, required

Datetime of session expiration.

fail_at

datetime, optional

Datetime of session failure.

fail_message

string, optional

Session fail message.

created_at

datetime, required

Datetime of payment creation.

updated_at

datetime, required

Datetime of last payment update.

Related Errors

Class	Code	Description
TokenMissing	400	This request cannot be performed without `Access_Token` header.
AuthorizationMissing	401	Authorization header is missing.
TokenNotFound	401	Token specified in request does not exist or cannot be retrieved.
TokenRevoked	401	Token specified in request is revoked and cannot be used anymore.
TokenExpired	401	Token specified in request is expired and cannot be used.
PaymentNotFound	404	Payment specified in request does not exist or cannot be retrieved.
OauthAppNotFound	404	OAuth Application specified in request does not exist or cannot be retrieved.
CertificateNotFound	404	Certificate has no permissions.

Confirm

This endpoint is used for processing additional interactive steps in the process of payment creation.

CURL

curl -i \ -H "Authorization: Bearer eyJhbGciOiJSUzI1NiJ9.eyJkYXRhIjp7ImNyZWRlbnRpYWxzIjp7InNtc19waW5jb2RlIjoiMTIzNDU2In19LCJleHAiOjE3NDMzMTAwMDYsImlzcyI6InByaW9yYS5zYWx0ZWRnZS5jb20ifQ.IyDf7mFrVmZlAivZQsiYkzV1lkUru6Omp-Ldt3kPDx-WeTmprA-6Jzf1c-aHA3Z5lBlml2vhv1uPeNMAjCzAWE2uoFxC5Z_HJGzq__6xAbEZmJxTNxmLbLz5wG5BY8Y0lI0SX4eOAnRNQxxjNn1aI_qCdJxxUua5hwSL_GN1bymNii-TUdhUyI6H5Hks--bx7tvnZKoH9j06bY7W5EQhb-b-6o-iz0iNStTA0Q9V4wnWntTK9FuM3wyuW2msAaIRn6zgafEccvqE0LpiSJtThsKLtLsEXA_RRn-sNEQUtWWT4k2PKXkgco7oPdFUpOm2nxVqC4jyLSGgwlIkFc30YA" \ -H "App-Id: kai5JbcoWosdVUzLG2ib1A" \ -H "App-Secret: H9EhmbtXlqm73MML5Z8E8w" \ -H "Access-Token: 19561f4a7115f1c8cd6818748e4f2f90aafa24ac42c139a0c99c92784a786e70eb7755be5582867fca28c78addd743f17c2758de65b0c69eb8ef78c049c62af6" \ -H "Client-Request-Id: 17" \ -X PUT "/api/v2/payments/:id"

curl -i  \ 
 -H "Authorization: Bearer eyJhbGciOiJSUzI1NiJ9.eyJkYXRhIjp7ImNyZWRlbnRpYWxzIjp7InNtc19waW5jb2RlIjoiMTIzNDU2In19LCJleHAiOjE3NDMzMTAwMDYsImlzcyI6InByaW9yYS5zYWx0ZWRnZS5jb20ifQ.IyDf7mFrVmZlAivZQsiYkzV1lkUru6Omp-Ldt3kPDx-WeTmprA-6Jzf1c-aHA3Z5lBlml2vhv1uPeNMAjCzAWE2uoFxC5Z_HJGzq__6xAbEZmJxTNxmLbLz5wG5BY8Y0lI0SX4eOAnRNQxxjNn1aI_qCdJxxUua5hwSL_GN1bymNii-TUdhUyI6H5Hks--bx7tvnZKoH9j06bY7W5EQhb-b-6o-iz0iNStTA0Q9V4wnWntTK9FuM3wyuW2msAaIRn6zgafEccvqE0LpiSJtThsKLtLsEXA_RRn-sNEQUtWWT4k2PKXkgco7oPdFUpOm2nxVqC4jyLSGgwlIkFc30YA" \ 
 -H "App-Id: kai5JbcoWosdVUzLG2ib1A" \ 
 -H "App-Secret: H9EhmbtXlqm73MML5Z8E8w" \ 
 -H "Access-Token: 19561f4a7115f1c8cd6818748e4f2f90aafa24ac42c139a0c99c92784a786e70eb7755be5582867fca28c78addd743f17c2758de65b0c69eb8ef78c049c62af6" \ 
 -H "Client-Request-Id: 17" \ 
 -X PUT "/api/v2/payments/:id"

Example of request parameters

{
  "data": {
    "credentials": {
      "sms_pincode": "123456"
    }
  },
  "exp": 1574093209,
  "id": 794
}

Example of response

{
  "data": {
    "status": "good",
    "description": "Internal transfer.",
    "fees": [
      {
        "amount": 0.25,
        "description": "Bank fee.",
        "currency_code": "EUR"
      },
      {
        "amount": 0.1,
        "description": "Payment fee.",
        "currency_code": "EUR"
      }
    ],
    "updated_at": "2019-11-18T16:04:50.249Z",
    "id": 691,
    "payment_attributes": {
      "from_account": "9542342312",
      "to_account": "3458979570",
      "amount": "150.00",
      "description": "Test payment."
    },
    "session": {
      "fail_message": "",
      "id": 461,
      "secret": "yua36KyKycry_hAPQQVQ",
      "status": "processing",
      "events": [],
      "success_at": "",
      "expires_at": "2019-11-18T16:04:50.249Z",
      "fail_at": ""
    },
    "created_at": "2019-11-18T16:04:50.249Z"
  }
}

Request

PUT /api/v2/payments/:id

Headers

Header	Type	Description
`Authorization`	string, required	JSON Web Token containing payload, signed using RSA256 and `application.private_key`. Can raise: AuthorizationMissing
`App-Id`	string, required	Application’s `app_id` from connection details tab. Can raise: OauthAppNotFound, CertificateNotFound
`App-Secret`	string, required	Application’s `app_secret` from connection details tab.
`Access-Token`	string, required	Token for which we are requesting info. Can raise: TokenMissing, TokenNotFound, TokenRevoked, TokenExpired
`Client-Request-Id`	string, optional	Request identifier. If present, it will be returned within `meta` field in response.

Unpacked Request Authorization

data

object, required

Wrapper for credentials pair.

credentials

object, required

Wraps PSU's credentials, it is used for both first(e.g. login, password) and second factors(e.g. one time password). Contents may vary depending on authorization types supported by your Bank.

exp

integer, required

The lifetime of the request in timestamp UTC format. Values greater than: Current time.

integer, required

Payment identifier in Salt Edge PSD2 Compliance. Can raise: PaymentNotFound, SessionExpired, SessionClosed

Response

Upon successful request, 200 status code will be returned. See ‘Related Errors’ table for other possibilities.

data

object, required

Wrapper for credentials pair.

integer, required

Payment identifier in Salt Edge PSD2 Compliance.

status

string, required

Current status of the payment.

description

string, required

Payment's description.

fees

array, required

List of all fees applied to given payment. Default value: []

amount

float, required

Amount of bank's fee related to the payment.

description

string, required

Fee's description.

currency_code

string, required

Currency code of bank's fee related to the payment.

payment_attributes

object, required

All attributes (required and optional) that belong to a payment template which PSU fills before creating the payment order.

session

object, required

Related session.

integer, required

Payment identifier in Salt Edge PSD2 Compliance.

secret

string, required

Another session identifier that can be used for session lookup and confirmation.

status

string, required

events

array, optional

Related session's events.

success_at

datetime, optional

Datetime of session successful closure.

expires_at

datetime, required

Datetime of session expiration.

fail_at

datetime, optional

Datetime of session failure.

fail_message

string, optional

Session fail message.

created_at

datetime, required

Datetime of payment creation.

updated_at

datetime, required

Datetime of last payment update.

Related Errors

Class	Code	Description
SessionClosed	400	Session specified in request is already closed and cannot be modified.
TokenMissing	400	This request cannot be performed without `Access_Token` header.
SessionExpired	401	Found session is expired and cannot be processed anymore.
AuthorizationMissing	401	Authorization header is missing.
TokenNotFound	401	Token specified in request does not exist or cannot be retrieved.
TokenRevoked	401	Token specified in request is revoked and cannot be used anymore.
TokenExpired	401	Token specified in request is expired and cannot be used.
PaymentNotFound	404	Payment specified in request does not exist or cannot be retrieved.
OauthAppNotFound	404	OAuth Application specified in request does not exist or cannot be retrieved.
CertificateNotFound	404	Certificate has no permissions.

Destroy

Cancel the payment that is in the process of creation, meaning it has not been confirmed yet.

CURL

curl -i \ -H "Authorization: Bearer eyJhbGciOiJSUzI1NiJ9.eyJkYXRhIjp7fSwiZXhwIjoxNzQzMzEwMDA2LCJpc3MiOiJwcmlvcmEuc2FsdGVkZ2UuY29tIn0.HVzWpgsD5IhgzI_4nB18VbMcz0eoEIxg6luRej6zYutlwyJ3Hmzwp-adlpUwNXjcZV3dyeV-1b2kkMz-TZogQ6o4ira-cUHBQuZhBHPRgrhbsNiuUVhV2hC5-CEyqLruhMii1UY651Tu0dRTEKGMLWmFCVDkJBqTAz22wpigaqhfqokIFl3xDiYGpHNr2hryE36oxftiicDlI6UHXitQf0yLlRTZ6VmovuWPs_fyRe_WXUY2EM0b2IVQcsy7LhqIlO53Y8NFKzEibT8n7BDK4HQdmDKUJiqBtBt7_mAHBZfo169y-lF1YwaznGxA4OFrMduUfrrcj3XB2kSzDs40UQ" \ -H "App-Id: DZ8IEYmbfDvS3eMeLhA-Lw" \ -H "App-Secret: 5FXgZCioWalfvTGVHqNe0g" \ -H "Access-Token: 55de2eb27669505499da9cdfd7d8f9dccbc61b3c2d158df4959c35d01fc0dc856505986f750f4d84b6bee0b85d4e6dfb3e6309e59078ec81832274c72bb62d1a" \ -H "Client-Request-Id: 17" \ -X DELETE "/api/v2/payments/:id"

curl -i  \ 
 -H "Authorization: Bearer eyJhbGciOiJSUzI1NiJ9.eyJkYXRhIjp7fSwiZXhwIjoxNzQzMzEwMDA2LCJpc3MiOiJwcmlvcmEuc2FsdGVkZ2UuY29tIn0.HVzWpgsD5IhgzI_4nB18VbMcz0eoEIxg6luRej6zYutlwyJ3Hmzwp-adlpUwNXjcZV3dyeV-1b2kkMz-TZogQ6o4ira-cUHBQuZhBHPRgrhbsNiuUVhV2hC5-CEyqLruhMii1UY651Tu0dRTEKGMLWmFCVDkJBqTAz22wpigaqhfqokIFl3xDiYGpHNr2hryE36oxftiicDlI6UHXitQf0yLlRTZ6VmovuWPs_fyRe_WXUY2EM0b2IVQcsy7LhqIlO53Y8NFKzEibT8n7BDK4HQdmDKUJiqBtBt7_mAHBZfo169y-lF1YwaznGxA4OFrMduUfrrcj3XB2kSzDs40UQ" \ 
 -H "App-Id: DZ8IEYmbfDvS3eMeLhA-Lw" \ 
 -H "App-Secret: 5FXgZCioWalfvTGVHqNe0g" \ 
 -H "Access-Token: 55de2eb27669505499da9cdfd7d8f9dccbc61b3c2d158df4959c35d01fc0dc856505986f750f4d84b6bee0b85d4e6dfb3e6309e59078ec81832274c72bb62d1a" \ 
 -H "Client-Request-Id: 17" \ 
 -X DELETE "/api/v2/payments/:id"

Example of request parameters

{
  "data": {},
  "exp": 1574093210,
  "id": 546
}

Example of response

{
  "data": {
    "payment_id": 324
  }
}

Request

DELETE /api/v2/payments/:id

Headers

Header	Type	Description
`Authorization`	string, required	JSON Web Token containing payload, signed using RSA256 and `application.private_key`. Can raise: AuthorizationMissing
`App-Id`	string, required	Application’s `app_id` from connection details tab. Can raise: OauthAppNotFound, CertificateNotFound
`App-Secret`	string, required	Application’s `app_secret` from connection details tab.
`Access-Token`	string, required	Token for which we are requesting info. Can raise: TokenMissing, TokenNotFound, TokenRevoked, TokenExpired
`Client-Request-Id`	string, optional	Request identifier. If present, it will be returned within `meta` field in response.

Unpacked Request Authorization

data

object, required

Wrapper for the data.

exp

integer, required

The lifetime of the request in timestamp UTC format. Values greater than: Current time.

string, required

Payment identifier in Salt Edge PSD2 Compliance. Can raise: PaymentNotFound, SessionExpired, SessionClosed

Response

Upon successful request, 200 status code will be returned. See ‘Related Errors’ table for other possibilities.

data

object, required

Wrapper for the data.

payment_id

string, required

Payment order identifier on Connector side. Used to map Salt Edge PSD2 Compliance payments to Connector ones.

Related Errors

Class	Code	Description
SessionClosed	400	Session specified in request is already closed and cannot be modified.
TokenMissing	400	This request cannot be performed without `Access_Token` header.
SessionExpired	401	Found session is expired and cannot be processed anymore.
AuthorizationMissing	401	Authorization header is missing.
TokenNotFound	401	Token specified in request does not exist or cannot be retrieved.
TokenRevoked	401	Token specified in request is revoked and cannot be used anymore.
TokenExpired	401	Token specified in request is expired and cannot be used.
PaymentNotFound	404	Payment specified in request does not exist or cannot be retrieved.
OauthAppNotFound	404	OAuth Application specified in request does not exist or cannot be retrieved.
CertificateNotFound	404	Certificate has no permissions.