---
title: "OCT Payout"
method: POST
path: "/oct/payout"
tags: ["OCT"]
---

# OCT Payout

`POST /oct/payout`

Used to process an original credit transaction to transfer funds from the merchant to the recipient.

**Integration Methods:**
- Host Direct

See the [Integration Methods](/guides/quickstart#integration-methods) and [URLs Section](/guides/quickstart#urls) sections of the Development Quick Start guide for details regarding each processing option.

See the [JSON Body Schemas](/guides/quickstart#json-body-schemas) for more details on the various JSON body formats.

## Headers

- `InterfaceVersion` string, required
- `InterfaceName` string, required
- `CompanyName` string, required
- `AccessToken` string, uuid, required

## Request body

- union
  - OctPayoutUnencryptedcard
    - `dateTime` string, ISO 8601, required — The date and time in ISO 8601 format including the timezone offset (yyyy-mm-ddThh:mm:ss.nnn+hh:mm). Must be sent as the local date/time of the merchant. For example, a request processed at a merchant in the Pacific time zone at 9:18am on April 15th 2021 would be sent as 2021-04-15T09:18:23.283-07:00
    - `amount` AmountTotalOnly, required — Object containing information regarding the amount being requested. The `total` field within the object is required and specifies the amount being requested. Note: For merchants that are configured to allow multiple currencies, the amount fields can specify up to three decimal places. However, the number of decimal places can not exceed the number allowed for the specified currency. See the [Currency Codes](/guides/appendices/currency-codes) section for details.
      - `total` number, required — The amount being charged for a particular transaction. If other amount fields are sent, they must be included in the total amount. Amount cannot be zero.
    - `transaction` object, required
      - `invoice` string, required — 10 character invoice number assigned by the interface to identify a transaction. An invoice number serves as a unique key that identifies a transaction within a batch in Shift4's Gateway.
      - `notes` string — A free-form notes field that supports the use of HTML tags. This can be used for reference in [Lighthouse Transaction Manager](https://ltm.shift4test.com/) and is not sent to the authorization host. Escaped quotation marks should not be sent in the Notes field.
      - `vendorReference` string — Optional field for information that can be searched in the merchant portal.
    - `card` object, required
      - `entryMode` 'M', required — The method used to capture a payment card. Value|Description -----|----------- M | Manual Entry
      - `present` 'Y' | 'N', required — **Conditional: Send in the initial authorization/sale request** Indicates whether a card was present (‘Y’) or not (‘N’) at the time a transaction took place. This should be set appropriately in the initial authorization/sale request. In subsequent requests, this field should be left blank or should not be sent. **Note:** Subsequent request here does not apply to the secondary request for card on file type transactions or reuse of the same card. An example of a subsequent request would be a capture after an authorization. You would not include `card.present` in the capture, which is the subsequent request. Another example is when performing an incremental authorization where you perform an authorization, followed by an incremental authorization then a capture. The second authorization (incremental) and the capture are the subsequent requests where you would not include `card.present`.
      - `number` string, required — The payment card number entered in an initial authorization/sale request. This field will always be masked when returned in a response.
      - `expirationDate` integer, required — **Conditional: Send only when card data is manually entered or when using a token. This field should not be specified when using an encrypted device.** Card expiration date in MMYY format. This value should only be populated in the initial sale/authorization request.
    - `customer` union, required
      - object
        - `firstName` string, required — Customer first name
        - `lastName` string, required — Customer last name
        - `emailAddress` string, required — Customer email address.
        - `ipAddress` string, required — Public source IP Address where the request originates, not the IP Address of the web server.
      - object
        - `companyName` string, required — Customer Company name
        - `emailAddress` string, required — Customer email address.
        - `ipAddress` string, required — Public source IP Address where the request originates, not the IP Address of the web server.
    - `currencyCode` string, ISO 4217 3 Character Alphabetic Code — Transaction currency code. See the [Currency Codes](/guides/appendices/currency-codes) section for details. **Note: This is currently supported when processing for a merchant outside of the US and Canada. If processing for a US or Canadian merchant then this field will be ignored and the transaction will process in the merchant's configured currency.**
    - `sourceIp` string, required — Public source IP Address where the request originates, not the IP Address of the web server.
  - OctPayoutTokenGtv
    - `dateTime` string, ISO 8601, required — The date and time in ISO 8601 format including the timezone offset (yyyy-mm-ddThh:mm:ss.nnn+hh:mm). Must be sent as the local date/time of the merchant. For example, a request processed at a merchant in the Pacific time zone at 9:18am on April 15th 2021 would be sent as 2021-04-15T09:18:23.283-07:00
    - `amount` AmountTotalOnly, required — Object containing information regarding the amount being requested. The `total` field within the object is required and specifies the amount being requested. Note: For merchants that are configured to allow multiple currencies, the amount fields can specify up to three decimal places. However, the number of decimal places can not exceed the number allowed for the specified currency. See the [Currency Codes](/guides/appendices/currency-codes) section for details.
      - `total` number, required — The amount being charged for a particular transaction. If other amount fields are sent, they must be included in the total amount. Amount cannot be zero.
    - `transaction` object, required
      - `invoice` string, required — 10 character invoice number assigned by the interface to identify a transaction. An invoice number serves as a unique key that identifies a transaction within a batch in Shift4's Gateway.
      - `notes` string — A free-form notes field that supports the use of HTML tags. This can be used for reference in [Lighthouse Transaction Manager](https://ltm.shift4test.com/) and is not sent to the authorization host. Escaped quotation marks should not be sent in the Notes field.
      - `vendorReference` string — Optional field for information that can be searched in the merchant portal.
    - `card` object, required
      - `entryMode` 'M' — The method used to capture a payment card. Value|Description -----|----------- M | Manual Entry
      - `present` 'Y' | 'N' — **Conditional: Send in the initial authorization/sale request** Indicates whether a card was present (‘Y’) or not (‘N’) at the time a transaction took place. This should be set appropriately in the initial authorization/sale request. In subsequent requests, this field should be left blank or should not be sent. **Note:** Subsequent request here does not apply to the secondary request for card on file type transactions or reuse of the same card. An example of a subsequent request would be a capture after an authorization. You would not include `card.present` in the capture, which is the subsequent request. Another example is when performing an incremental authorization where you perform an authorization, followed by an incremental authorization then a capture. The second authorization (incremental) and the capture are the subsequent requests where you would not include `card.present`.
      - `token` CardTokenRequired, required
        - `value` string, required — This field is used to specify a card token. Whenever CHD is sent in a request, a card token will be returned in this field. Your interface should be designed to store this card token for future use. The latest card token received should be used in any subsequent request that references the same card data.
      - `expirationDate` integer — **Conditional: Send only when card data is manually entered or when using a token. This field should not be specified when using an encrypted device.** Card expiration date in MMYY format. This value should only be populated in the initial sale/authorization request.
    - `customer` union, required
      - object
        - `firstName` string, required — Customer first name
        - `lastName` string, required — Customer last name
        - `emailAddress` string, required — Customer email address.
        - `ipAddress` string, required — Public source IP Address where the request originates, not the IP Address of the web server.
      - object
        - `companyName` string, required — Customer Company name
        - `emailAddress` string, required — Customer email address.
        - `ipAddress` string, required — Public source IP Address where the request originates, not the IP Address of the web server.
    - `currencyCode` string, ISO 4217 3 Character Alphabetic Code — Transaction currency code. See the [Currency Codes](/guides/appendices/currency-codes) section for details. **Note: This is currently supported when processing for a merchant outside of the US and Canada. If processing for a US or Canadian merchant then this field will be ignored and the transaction will process in the merchant's configured currency.**
    - `sourceIp` string, required — Public source IP Address where the request originates, not the IP Address of the web server.

## Response `200`

Transaction was processed

- object
  - `result` object[]
    - `dateTime` string, ISO 8601 — The date and time in ISO 8601 format including the timezone offset (yyyy-mm-ddThh:mm:ss.nnn+hh:mm). Must be sent as the local date/time of the merchant. For example, a request processed at a merchant in the Pacific time zone at 9:18am on April 15th 2021 would be sent as 2021-04-15T09:18:23.283-07:00
    - `amount` object — Object containing information regarding the amount being requested. The `total` field within the object is required and specifies the amount being requested.
      - `total` number — The amount being charged for a particular transaction. If other amount fields are sent, they must be included in the total amount. Amount cannot be zero.
      - `fee` number — The fee charged to process the OCT transaction.
    - `card` object
      - `number` string — The card number field will always be masked when returned in a response.
      - `type` 'AX' | 'AP' | 'BC' | 'CI' | 'DB' | 'GC' | 'JC' | 'MC' | 'NS' | 'PL' | 'SC' | 'VS' | 'WP' | 'YC' — An abbreviation used to specify the type of card that was used when processing a transaction. Value| Description -----|------------ AX | American Express AP | Alipay BC | Backed Card CI | Citgo DB | Debit card GC | Gift Card JC | JCB MC | Mastercard NS | Discover/JCB/Novus PL | Private Label SC | Sears Canada VS | Visa WP | WeChat Pay YC | IT’S YOUR CARD
      - `token` CardTokenResponse
        - `value` string — This field is used to specify a card token. Whenever CHD is sent in a request, a card token will be returned in this field. Your interface should be designed to store this card token for future use. The latest card token received should be used in any subsequent request that references the same card data.
    - `customer` object
      - `firstName` string — Specifies a consumer’s first name. This field is returned whenever the customer name is supplied in the request or if the track/EMV data contains the cardholder name.
      - `lastName` string — Specifies a consumer’s last name. This field is returned whenever the customer name is supplied in the request or if the track/EMV data contains the cardholder name.
      - `emailAddress` string — Customer email address.
      - `ipAddress` string — Public source IP Address where the request originates, not the IP Address of the web server.
    - `merchant` MerchantResponse
      - `mid` number — The merchant ID associated with the merchant account.
      - `name` string — The merchant’s business name as configured with Shift4.
    - `server` Server
      - `name` string — The name of the server that processed the request.
    - `transaction` object
      - `authSource` 'A' — In a response, a code returned by the processor to indicate which host issued the response. Value | Description -------|---------------------------- A | APM (Online)
      - `invoice` string — 10 character invoice number assigned by the interface to identify a transaction. An invoice number serves as a unique key that identifies a transaction within a batch in Shift4's Gateway.
      - `responseCode` 'A' | 'D' — Code indicating the Shift4 host response. Value | Description | Details -------|-------------|-------- A | Approved | The transaction is approved. D | Declined | The transaction is declined.
      - `hostResponse` HostResponseOCT — Returns the response code detailing why the transaction was declined.
        - `reasonCode` string — Returns a response code from the host. Value |Category|Description ------|--------|----------- 04 | 1 | Pick Up Card 07 | 1 | Pick Up Card, Special Condition 12 | 1 | Invalid Transaction 15 | 1 | No Such Issuer 41 | 1 | Lost Card 43 | 1 | Stolen Card 46 | 1 | Closed Account 57 | 1 | Trans. not Permitted to Cardholder R0 | 1 | Stop Payment Order R1 | 1 | Revocation of Auth Order R3 | 1 | Revocation of all Authorization 03 | 2 | Invalid Merchant 19 | 2 | Re-enter Transaction 51 | 2 | Not sufficient funds 59 | 2 | Suspected Fraud 61 | 2 | Exceeds approval amount limit 62 | 2 | Restricted Card (card invalid in region or country) 65 | 2 | Exceeds withdrawal frequency limit 75 | 2 | Allowable number of PIN-entry tried exceeded 78 | 2 | Blocked, first used 86 | 2 | Cannot Verify PIN 91 | 2 | Issuer or switch inoperative 93 | 2 | Transaction cannot be completed - violation of law 96 | 2 | System malfunction N3 | 2 | Cash service not available N4 | 2 | Cash request exceeds issuer of approved limit 14 | 3 | Invalid Account 54 | 3 | Expired card or expiration date missing 55 | 3 | PIN incorrect or missing 70 | 3 | PIN data required 82 | 3 | Negative Online CAM, dCVV, iCVV, or CVV results 1A | 3 | Additional customer authentication required N7 | 3 | Decline for CVV2 Failure 05 | 4 | Do not honor 06 | 4 | General error 08 | 4 | Honor MasterCard with ID 13 | 4 | Invalid amount 21 | 4 | Invalid amount 30 | 4 | Format error 39 | 4 | No credit account 52 | 4 | No checking account 53 | 4 | No savings account 58 | 4 | Transaction not permitted-Terminal 63 | 4 | Security violation 66 | 4 | Card Acceptor call Acquirer’s security dept 67 | 4 | Hard capture (requires ATM pick-up) 68 | 4 | Response received too late 71 | 4 | PIN Not Changed 76 | 4 | Unsolicited reversal 77 | 4 | Invalid Data including AVS failures. 79 | 4 | Already reversed at switch 80 | 4 | No Financial impact 81 | 4 | Cryptographic error 92 | 4 | Unable to route transaction 94 | 4 | Duplicate Transaction B1 | 4 | Surcharge amount not permitted on debit cards or EBTfoodstamps B2 | 4 | Surcharge amount not supported by debit network issuer CV | 4 | Card Type VerificationError EA | 4 | Acct Length Err EB | 4 | Check Digit Err EC | 4 | CID Format Error HV | 4 | Hierarchy Verification Error N0 | 4 | Force STIP P5 | 4 | PIN Change/Unblock failed P6 | 4 | New PIN not accepted Z3 | 4 | Unable to go online; offline-declined \-38 | 4 | The transaction has been denied by the Gateway because 3D secure Authentication failed. Reason: {}<br><br>Note: The “Reason” part is optional and may appear according to detected reason. | D2 | 4 | Decline Retry Later All other, generic declines may be classified as a Category 4 response code.
        - `reasonDescription` string — Returns a description from the host.
      - `retrievalReference` string — Reference retrieval number assigned by the authorizing agency. This value is printed on some receipts.
      - `vendorReference` string — Optional field for information that can be searched in the merchant portal.

## Other responses

- `400` — Error
- `504` — Timeout

---

[API](https://skmtc.net/shift4/apis/shift4-payment-api.md) · [All operations](https://skmtc.net/shift4/apis/shift4-payment-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/shift4/shift4-payment-api/versions/b923fc55b203/schema)