Skip to main content
POST
/
fees
/
charge
Charge Fee
curl --request POST \
  --url https://access.utgl.io/v1/fees/charge \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "accountId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "intent": "CARD_APPLICATION_FEE",
  "amount": 10.5,
  "currency": "HKD",
  "xid": "1d931723-b386-4632-98aa-070c407ca3f0",
  "xmetadata": {
    "key1": "value1",
    "key2": [
      "value2.1",
      "value2.2"
    ]
  }
}
'
{
  "id": "<string>",
  "transaction": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "xid": "<string>",
    "xmetadata": {
      "key1": "value1",
      "key2": [
        "value2.1",
        "value2.2"
      ]
    },
    "refId": "CT34567890",
    "cardAccountId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "cardId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "cardLast4": "<string>",
    "cardEmbossedName": "<string>",
    "createdAt": "2022-11-10T07:47:09.415Z",
    "status": "pending",
    "postedAt": "2022-11-10T07:47:09.415Z",
    "intent": "charge",
    "authorization": {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "currency": "USD",
      "amount": 128.29,
      "createdAt": "2022-11-10T07:47:09.415Z",
      "type": "Payment authorization type",
      "responseCode": "<string>",
      "responseMessage": "<string>",
      "cardPresent": true
    },
    "merchant": {
      "name": "UBER * PENDING Amsterdam NLD",
      "mcc": "4121",
      "category": "Taxicabs and limousines",
      "country": "HK"
    },
    "currency": "HKD",
    "amount": 1000,
    "entryType": "CREDIT",
    "description": "UBER * PENDING Amsterdam NLD",
    "grossAmount": 1000
  },
  "amount": 123,
  "currency": "<string>",
  "status": "pending",
  "intent": "<string>",
  "intentId": "<string>",
  "createdAt": "2023-11-07T05:31:56Z"
}

Authorizations

​
Authorization
string
header
required

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.

Body

application/json
​
accountId
string<uuid>
required

account ID or card account ID

​
intent
string
required

supported fee intents

Example:

"CARD_APPLICATION_FEE"

​
amount
number

amount overrides the existing fee schedule

Required range: x >= 0
Example:

10.5

​
currency
string

current overrides the existing fee schedule

Example:

"HKD"

​
xid
string

UUID

Example:

"1d931723-b386-4632-98aa-070c407ca3f0"

​
xmetadata
object

External metadata

Example:
{
  "key1": "value1",
  "key2": ["value2.1", "value2.2"]
}

Response

Charge fee successful

Charged fee entry for account or card account

​
id
string
​
transaction
Card Account Transaction · object

Card account transaction

​
amount
number
​
currency
string
​
status
enum<string>

Status of the fee

Available options:
pending,
posted,
void
​
intent
string

Fee intent of the fee entry.

​
intentId
string

id of the instruction that caused the fee charge.

​
createdAt
string<date-time>