POST///
This Original Credit Transaction (OCT) enables the cardholder to receive funds on the specified card from an external source via the card network. Use this endpoint to simulate a transaction that is similar to a wire transfer and not linked to any purchase.
Simulate an OCT by including the card_token, amount, mid, and type in your request.
Body field details
| Fields | Description |
|---|---|
| amount decimal Required | Amount of the transaction. Allowable Values: Format: 0.00 Must be greater than zero |
| card_token string Required | Unique identifier of the card receiving original credit. Allowable Values: Existing card token. 36 char max |
| mid string Required | Merchant Identifier of the merchant participating in the transaction. Allowable Values: 50 char max |
| card_acceptor object Optional | Contains attributes that describe the merchant. Allowable Values: A valid card_acceptor object. |
| screening_score string Optional | Sanctions screening score to assist with meeting Anti-Money Laundering (AML) obligations. Higher scores indicate that the sender’s data more closely resembles an entry on the regulatory watchlist. Allowable Values: 000-100 or 999 Value of 999 means no score available. |
| type string Required | Type of original credit transaction. Allowable Values: account_to_account, person_to_person, wallet_transfer, money_transfer_by_bank, business_to_business, disbursement, government_disbursement, gambling_payout, loyalty, merchant_disbursement, online_gambling_payout, pension_disbursement, prepaid_loads, card_bill_payment, bill_payment, cash_claim, cash_in, cash_out, mobile_air_time_payment, money_transfer_by_merchant, face_to_face_merchant_payment, government_payment, payments_goods_services |
| sender_data object Optional | Contains sender-related information. Allowable Values: A valid sender_data object. |
| webhook object Optional | Allows information to be posted asynchronously to endpoints hosted in your environment. Allowable Values: A valid webhook object. |
The card_acceptor object
| Fields | Description |
|---|---|
| mcc string Optional | Merchant category code. Allowable Values: 5 char max |
| partial_approval_capable boolean Optional | Whether the response can approve an amount less than the requested amount. Allowable Values: true, falseDefault value: false |
| name string Optional | Merchant name. Allowable Values: 255 char max |
| address string Optional | Merchant address. Allowable Values: 255 char max |
| city string Optional | Merchant city. Allowable Values: 255 char max |
| state string Optional | Merchant state. Allowable Values: 2 char max |
| zip string Optional | Merchant ZIP or postal code. Allowable Values: 10 char max |
| country string Optional | Merchant country. Allowable Values: 40 char max |
| ecommerce_security_level_indicator string Optional | Represents the security protocol and cardholder authentication type associated with the transaction. Allowable Values: 0-9 |
The sender_data object
| Fields | Description |
|---|---|
| sender_name string Optional | Sender full name. Allowable Values: 255 char max |
| sender_reference_number string Optional | Transaction reference number provided by the originating bank used to uniquely identify the sender. Allowable Values: 16 char max |
| sender_account_number string Optional | Sender’s simulated account number. Allowable Values: 34 char max |
| sender_address string Optional | Sender street address. Allowable Values: 255 char max |
| sender_city string Optional | Sender city. Allowable Values: 36 char max |
| sender_state string Optional | Sender state. Allowable Values: 2 char max |
| sender_country string Optional | Sender country. Allowable Values: 40 char max |
| funding_source string Optional | Sender’s simulated account from which the OCT draws funds. Allowable Values: credit, debit, prepaid, deposit_account, cash, mobile_money_account, non_visa_credit |
The webhook object
| Fields | Description |
|---|---|
| endpoint string Optional | Endpoint to which a copy of the response is sent. Allowable Values: - HTTPS URL - 250 char max - Empty string not allowed |
| username string Optional | Username for accessing the endpoint. Allowable Values: 50 char max |
| password string Optional | Password for accessing the endpoint. Allowable Values: No restrictions |
Sample request body
Send the following request to simulate adisbursement type transaction.
JSON
{
"amount": 10,
"card_token": "ce2002fd-5e9a-4c9b-a82d-cc74da4e8280",
"mid": "11111",
"type": "disbursement"
}
Sample response body
The following response simulates adisbursement type transaction.
JSON
{
"transaction": {
"type": "original.credit.auth_plus_capture",
"state": "COMPLETION",
"token": "84f39ded-0700-41e5-911e-89215a77104c",
"user_token": "fc7c4a77-f105-44b0-8424-f9f9c3d4d090",
"acting_user_token": "fc7c4a77-f105-44b0-8424-f9f9c3d4d090",
"card_token": "380e26fe-4f9f-4ee0-9fb8-e26062be8445",
"original_credit": {
"transaction_type": "disbursement"
},
"gpa": {
"currency_code": "USD",
"ledger_balance": 10,
"available_balance": 10,
"credit_balance": 0,
"pending_credits": 0,
"impacted_amount": 10,
"balances": {
"USD": {
"currency_code": "USD",
"ledger_balance": 10,
"available_balance": 10,
"credit_balance": 0,
"pending_credits": 0,
"impacted_amount": 10
}
}
},
"duration": 199,
"created_time": "2024-07-08T23:47:04Z",
"user_transaction_time": "2024-07-08T23:47:04Z",
"request_amount": 10,
"amount": 10,
"currency_code": "USD",
"approval_code": "206645",
"response": {
"code": "0000",
"memo": "Approved or completed successfully"
},
"merchant": {
"name": "John Doe Merchant Inc.",
"active": true,
"contact": "John D. Doe",
"contact_email": "jdoe@domain.com",
"longitude": 0,
"latitude": 0,
"address1": "180 Grand Avenue",
"address2": "Suite 2303",
"city": "Oakland",
"state": "CA",
"zip": "94612",
"country": "USA",
"token": "c0b3f6cd-146e-45a8-9440-efcce623dd37",
"partial_auth_flag": true,
"created_time": "2024-02-14T00:57:02Z",
"last_modified_time": "2024-02-14T00:57:02Z"
},
"store": {
"name": "Aegis Fleet Services",
"active": false,
"longitude": 0,
"latitude": 0,
"address1": "111 Main St",
"city": "Berkeley",
"state": "CA",
"zip": "94702",
"token": "8f195870-94ce-4bfd-ac46-75a4fcf17500",
"partial_auth_flag": true,
"mid": "11111",
"merchant_token": "c0b3f6cd-146e-45a8-9440-efcce623dd37",
"partial_approval_capable": true,
"keyed_auth_cvv_enforced": false,
"created_time": "2024-02-14T01:18:38Z",
"last_modified_time": "2024-02-14T01:18:38Z"
},
"network": "VISA",
"subnetwork": "VISANET",
"acquirer_fee_amount": 0,
"acquirer": {
"institution_id_code": "05779900106",
"retrieval_reference_number": "726213433770",
"system_trace_audit_number": "881236"
},
"fees": [
{
"type": "ISSUER_LOAD_SURCHARGE_FEE",
"amount": 0
}
],
"user": {
"metadata": {}
},
"card": {
"last_four": "3201",
"metadata": {}
},
"issuer_received_time": "2024-07-08T23:47:04.577Z",
"issuer_payment_node": "715de90f8dd6eeb2d87251dd691d7de2",
"card_acceptor": {
"mid": "11111",
"mcc": "00",
"country_code": "USA"
},
"pos": {
"terminal_id": "TR100000",
"partial_approval_capable": false,
"purchase_amount_only": false,
"is_recurring": false
}
},
"raw_iso8583": {
"0": "2210",
"2": "1111119311153201",
"3": "260000",
"4": 10,
"5": 10,
"7": "0708234704",
"11": "881236",
"12": "114704",
"13": "0708",
"14": "2307",
"15": "0708",
"17": "0708",
"22": "10000000020000000100000001000000",
"26": "00",
"32": "05779900106",
"33": "13747132476",
"37": "726213433770",
"38": "206645",
"39": "0000",
"41": "TR100000",
"42": "11111",
"43": {
"7": "840"
},
"44": {
"1": "Approved or completed successfully",
"3": "00",
"4": "Approved or completed successfully"
},
"48": "OCT 07012020",
"50": "840",
"54": "00028402C00000000100000018402C000000001000",
"58": "00000000022",
"59": "0000000",
"63": "VISA",
"112": {
"101": "10.00",
"102": "10.00",
"103": "840"
},
"113": {
"2": "106",
"32": "VISANET",
"35": "API",
"42": "DISBURSEMENT",
"46": "true"
},
"123": "123 Main St. "
}
}