Get Card Settlement By Id

get https://api.cloud.mbanq.com/v1/cardSettlements/{settlementId}

Use this API to retrieve details of a card settlement by its unique identifier.

This endpoint allows you to fetch specific information related to a card settlement based on the settlement Id.

Behaviour: A successful response from this API provides card settlement for specified Id.

Responses

Response body

object

clientId

integer

The client ID associated with the settlement.
Example: 426

firstName

string

The first name of the client associated with the settlement.
Example: Ramesh

lastName

string

The last name of the client associated with the settlement.
Example: Kumar

accountNumber

string

The account number associated with the settlement.
Example: 000000253

integer

The unique identifier of the settlement.
Example: 4

type

string

The type of the settlement (e.g., DEBIT).
Example: DEBIT

internalClearingId

string

The internal clearing ID associated with the settlement.
Example: #413101101234#10223#3685210#VISA

internalAuthId

string

The internal authorization ID associated with the settlement.
Example: #413101101234#10223#3685210

externalClearingId

string

The external clearing ID associated with the settlement.
Example: #3685210#VISA

externalAuthId

string

The external authorization ID associated with the settlement.
Example: 3685210

externalOriginalAuthId

string

The external original authorization ID associated with the settlement.
Example: 0

externalCardId

string

The external card ID associated with the settlement.
Example: #413101446172#3685210

cardToken

string

The token of the card associated with the settlement.
Example: 1dade702-a25a-4b97-b52a-bf2245133597

merchant

object

Details of the merchant involved in the settlement.

merchant_number

string

The merchant number associated with the settlement.
Example: 242661000053360

merchantId

string

The merchant ID associated with the settlement.
Example: #413101101234#10223#3685210

merchant_location

string

The location of the merchant associated with the settlement.
Example: 840

mcc

string

The MCC (Merchant Category Code) associated with the settlement.
Example: 5999

description

string

The description of the merchant associated with the settlement.
Example: SQ *CHAMOY EXPRESS Rancho CucamoCAUS

amount

number

The amount of the settlement.
Example: 35

network

string

The network associated with the settlement.
Example: VISA

currency

string

The currency associated with the settlement.
Example: USD

requestedAt

string

The timestamp when the settlement was requested.
Example: 2024-02-16 18:24:05

createdAt

string

The timestamp when the settlement was created.
Example: 2024-02-16 18:24:05

status

string

The status of the settlement.
Example: COMPLETED

batchDate

string

The timestamp of the batch date related to the settlement.
Example: 2022-01-18 16:33:16

batchIdentifier

string

The identifier of the batch related to the settlement.
Example: postedtransactions_20220203.txt.gpg

mcSequenceNumber

integer

The MC (Merchant Category) sequence number associated with the settlement.
Example: 0

mcSequenceCount

integer

The MC (Merchant Category) sequence count associated with the settlement.
Example: 0

completedInternalClearingId

integer

The completed internal clearing ID associated with the settlement.
Example: 0

interchangeFeeAmount

number

The interchange fee amount associated with the settlement.
Example: 0.13

Language

Credentials

Bearer

JWT


xxxxxxxxxx
1
curl --request GET \
2
     --url https://api.cloud.mbanq.com/v1/cardSettlements/10 \
3
     --header 'accept: application/json' \
4
     --header 'tenantId: z01j3e71zd6zkq908vyf5861a8'

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200The card settlement by Id fetched successfully.

400The request fails if the card Id is incorrect.