When to use it? A transaction has been received in Toqio or has been initiated in Toqio side. You must update the object via notification with any status update received from the provider.
webhookType: SYNC_TRANSACTION_STATUS
model:
{
"id": "string",
"status": "FAILED | PENDING | PENDING\_APPROVAL | ACCEPTED | WITHHELD |CANCELLED | FAILED| BLOCKED | SETTLED | CAPTURED | IN DISPUTE",
"failureReason": "string", // deprecated
"corePaymentType": "payment-type-Global-SWIFT | payment-type-UK-BACS | payment-type-EU-SEPA-Target2 | payment-type-UK-Chaps | payment-type-EU-SEPA-Step2 | payment-type-virtual-debit-card-debit | payment-type-inter-ledger | payment-type-UK-FasterPayments | payment-type-fx | payment-type-card | payment-type-card-reserve | payment-type-EU-SEPA-Instant | payment-type-AU-NPP | payment-type-EU-Target2 | payment-type-AU-DE | payment-type-US-ACH | payment-type-SG-FAST | payment-type-US-Wires | SPEI | AUS-PAY-NET | EFT | NCS | CERTIS | STRAKSCLEARING-Instant | INTRADAGCLEARING | CHATS | GIRO_ZRT | IMPS | NEFT | SKN | IBG | NORWEGIAN-INTERBANK-CLEARING-SYSTEM | PESONET | ELIXIR | TRANSFOND_SENT_ACH | FAST | INTERNAL-TRANSFER | RIX | FEDACH | FEDWIRE | CHIPS | SEPA | TARGET2 | DIRECT_DEBIT_OUTBOUND",
"cardTransactionType": "PURCHASE | Purchase | WITHDRAWAL | Withdrawal | ADJUSTMENT_CREDIT | Adjustment Credit | PURCHASE_WITH_CASHBACK | Purchase with Cashback | ACCOUNT_FUNDING | Account Funding | QUASI_CASH | Quasi cash | CASH_ADVANCE | Cash Advance | UNIQUE_MCC_TRANSACTION | Unique MCC Transaction | ADJUSTMENT_DEBIT | Adjustment Debit | PURCHASE_RETURN | Purchase Return/Refund | DEPOSIT | Deposit | CARD_LOAD | Card Load | CARD_UNLOAD | Card Unload | CHECK_DEPOSIT | Check Deposit | ORIGINAL_CREDIT | Original Credit | PAYMENT_TRANSACTION | Payment Transaction | ACCOUNT_VERIFICATION | Account Verification",
"balance": "number (double)",
"date": "yyyy-MM-dd'T'HH:mm:ss.SSS'Z",
"baseTotal": "number (double)",
"paymentProviderDetails":// deprecated {
"shortReference": "string",
"internalReference": "string",
"paymentId": "string",
"conversionId": "string",
"settlementDate": "string (date)",
"rate": "number (double)"
}
}
Request body parameter explained:
"id": “string”//mandatory: This field represents transactionNumber
"status": "enum" //mandatory: "FAILED | PENDING | PENDING_APPROVAL | ACCEPTED | WITHHELD |CANCELLED | FAILED| BLOCKED | SETTLED | CAPTURED | IN DISPUTE"
This field identifies the transaction status. Read more.
"failureReason": "string"// deprecated: This is an optional field which can be null.
"corePaymentType": "enum"//mandatory: "payment-type-Global-SWIFT | payment-type-UK-BACS | payment-type-EU-SEPA-Target2 | payment-type-UK-Chaps | payment-type-EU-SEPA-Step2 | payment-type-virtual-debit-card-debit | payment-type-inter-ledger | payment-type-UK-FasterPayments | payment-type-fx | payment-type-card | payment-type-card-reserve | payment-type-EU-SEPA-Instant | payment-type-AU-NPP | payment-type-EU-Target2 | payment-type-AU-DE | payment-type-US-ACH | payment-type-SG-FAST | payment-type-US-Wires | SPEI | AUS-PAY-NET | EFT | NCS | CERTIS | STRAKSCLEARING-Instant | INTRADAGCLEARING | CHATS | GIRO_ZRT | IMPS | NEFT | SKN | IBG | NORWEGIAN-INTERBANK-CLEARING-SYSTEM | PESONET | ELIXIR | TRANSFOND_SENT_ACH | FAST | INTERNAL-TRANSFER | RIX | FEDACH | FEDWIRE | CHIPS | SEPA | TARGET2 | DIRECT_DEBIT_OUTBOUND" :
Identifies the payment type used for this transaction. Read more.
"cardTransactionType":"enum" "PURCHASE | Purchase | WITHDRAWAL | Withdrawal | ADJUSTMENT_CREDIT | Adjustment Credit | PURCHASE_WITH_CASHBACK | Purchase with Cashback | ACCOUNT_FUNDING | Account Funding | QUASI_CASH | Quasi cash | CASH_ADVANCE | Cash Advance | UNIQUE_MCC_TRANSACTION | Unique MCC Transaction | ADJUSTMENT_DEBIT | Adjustment Debit | PURCHASE_RETURN | Purchase Return/Refund | DEPOSIT | Deposit | CARD_LOAD | Card Load | CARD_UNLOAD | Card Unload | CHECK_DEPOSIT | Check Deposit | ORIGINAL_CREDIT | Original Credit | PAYMENT_TRANSACTION | Payment Transaction | ACCOUNT_VERIFICATION | Account Verification"
This field provides an enum value to identify the type of use of the card. It can be an enum value or null.
"balance": "number (double)": The account balance after the transaction. Can be sent as a null value, if not available. For example, “01.23”.
"date": "yyyy-MM-dd'T'HH:mm:ss.SSS'Z" //mandatory: This is the date when the transaction was initiated
"baseTotal": "number (double)" //mandatory: Represents the total in the original currency in which the transaction was initiated. The value will be the same as in “currency” if no exchange was required. Can be sent as a null value, if not available.
"paymentProviderDetails": object// deprecated: Can be sent as a null value, if not available.
example:
{
"id": "c14a080d-7bd3-4bab-8e2f-1d71a0123e5f",
"status": "ACCEPTED",
"failureReason": "",
"corePaymentType": "payment-type-UK-BACS",
"cardTransactionType": "PURCHASE",
"balance": 100.5,
"date": "2024-06-27",
"baseTotal": 105.75,
"paymentProviderDetails": {
"shortReference": "SR123456",
"internalReference": "IR789012",
"paymentId": "PID987654",
"conversionId": "CID345678",
"settlementDate": "2024-06-28",
"rate": 1.05
}
}