Create an authorization hold

POST

authorization-holds

authorizations

curl --request POST \
  --url 'https://integration-api-cat2.{{environment}}.ext.{{realm}}.cia.enfuce.com/transaction/v3/authorization-holds/authorizations' \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "accountId": "<string>",
  "type": "AHOLD",
  "amount": 1,
  "currency": "EUR",
  "text": "<string>",
  "ref": "<string>",
  "message": "<string>",
  "paymentReceiver": "<string>",
  "transferId": "<string>",
  "paymentReference": "<string>",
  "payerName": "<string>",
  "fromAddress": "<string>",
  "fromZip": "<string>",
  "fromCity": "<string>",
  "fromBankAccountNumber": "<string>",
  "fromCustomerAccountNumber": "<string>",
  "fromOrganizationalNumber": "<string>",
  "fromBankName": "<string>",
  "toBic": "<string>",
  "fromBankAccountType": "BBAN",
  "toBankAccountType": "BBAN",
  "toBankAccountNumber": "<string>"
}
'

{
  "authorizationTransactionId": "<string>"
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

auditUser

string

required

The audit user to log the request

Body

application/json

The fields that you want to apply to your newly created authorization hold transaction

accountId

string<biginteger>

required

Account id

type

enum<string>

required

Authorization hold type

Available options:

AHOLD,

PBALPAY

amount

number

required

Amount to hold

Required range: x > 0

currency

string

required

A valid ISO 4217 currency code

Example:

"EUR"

text

string

Free text

Maximum string length: 255

ref

string

message

string

paymentReceiver

string

transferId

string

paymentReference

string

payerName

string

fromAddress

string

fromZip

string

fromCity

string

fromBankAccountNumber

string

fromCustomerAccountNumber

string

fromOrganizationalNumber

string

fromBankName

string

toBic

string

fromBankAccountType

enum<string>

Available options:

BBAN

toBankAccountType

enum<string>

Available options:

BBAN

toBankAccountNumber

string

Response

Authorization hold created successfully

authorizationTransactionId

string<biginteger>

Transaction Id of generated authorization request

⌘I

Create an authorization hold

curl --request POST \
  --url 'https://integration-api-cat2.{{environment}}.ext.{{realm}}.cia.enfuce.com/transaction/v3/authorization-holds/authorizations' \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "accountId": "<string>",
  "type": "AHOLD",
  "amount": 1,
  "currency": "EUR",
  "text": "<string>",
  "ref": "<string>",
  "message": "<string>",
  "paymentReceiver": "<string>",
  "transferId": "<string>",
  "paymentReference": "<string>",
  "payerName": "<string>",
  "fromAddress": "<string>",
  "fromZip": "<string>",
  "fromCity": "<string>",
  "fromBankAccountNumber": "<string>",
  "fromCustomerAccountNumber": "<string>",
  "fromOrganizationalNumber": "<string>",
  "fromBankName": "<string>",
  "toBic": "<string>",
  "fromBankAccountType": "BBAN",
  "toBankAccountType": "BBAN",
  "toBankAccountNumber": "<string>"
}
'

{
  "authorizationTransactionId": "<string>"
}