Skip to main content
PATCH
Update card account activity

Authorizations

x-api-key
string
header
required

Enter your API key

Path Parameters

activityId
string
required

The activity's id, as returned by List card account activities.

Required string length: 1 - 255

Body

application/json
note
string | null

The note, for example a PO number. Spaces at the start and end are removed, then it must be 1 to 500 characters. Send null to clear it.

Required string length: 1 - 500
categoryId
string<uuid>

An id from List transaction categories. IDs differ between environments. You can't clear a category.

Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$

Response

id
string
required

Reap's unique ID for this activity.

chargeId
string | null
required

The transaction ID (TID) of a card transaction, the same one shown in the dashboard. Give it to Reap Support when asking about a card transaction. Null for other activity types.

type
enum<string>
required

What kind of activity this is: CHARGE (a card transaction), REPAYMENT (a repayment of your card balance), ADJUSTMENT (a correction made by Reap), REBATE (a rebate credited to your card account) or INTEREST (interest charged on an unpaid balance).

Available options:
CHARGE,
REPAYMENT,
ADJUSTMENT,
REBATE,
INTEREST
status
enum<string> | null
required

Where a card transaction is in its lifecycle: PENDING (authorised, not yet settled by the merchant), CLEARED (settled), DECLINED (not approved) or VOIDED (cancelled before settling). Null for other activity types.

Available options:
PENDING,
CLEARED,
DECLINED,
VOIDED,
null
declineReason
object | null
required

Why a card transaction was declined. Null for card transactions that weren't declined and for other activity types.

createdAt
string<date-time>
required

When the activity happened, in UTC.

Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z))$
clearedAt
string<date-time> | null
required

When a card transaction settled, in UTC. Null while it's still pending, or if it never settles.

Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z))$
isCredit
boolean | null
required

true when funds come back to the card account (such as a refund, repayment or rebate), and false when they go out.

billAmount
object | null
required

The amount applied to your card account, in your card's currency (USD or HKD). Use this for accounting and reconciliation.

transactionAmount
object | null
required

The amount in the merchant's own currency. It differs from billAmount when the merchant charges in another currency.

conversionRate
string | null
required

The exchange rate used to convert transactionAmount into billAmount, as a string. It's 1 when both are in the same currency.

merchant
string | null
required

The merchant's name as it appears on the card transaction.

card
object | null
required

The card the activity happened on. Null for activity that isn't tied to a card, such as a repayment.

category
object | null
required

The card transaction's transaction category, mapped automatically by Reap from the card network's merchant data, or corrected by your team. Null if it hasn't been categorised yet.

note
string | null
required

A free-text note your team added to the card transaction in the dashboard or through Update card account activity. Null if there is none.

hasReceipt
boolean
required

Whether a receipt has been attached to this card transaction.