---
title: "Run APM transaction"
method: POST
path: "/apm/v3/process"
tags: ["Alternative Payment Methods"]
---

# Run APM transaction

`POST /apm/v3/process`

Allows you to securely process an alternative payment method transaction without a browser, such as for merchant-initiated transactions using [PayPal (with Braintree)](https://docs.nexiopay.com/docs/paypal-with-braintree-integration-guide).

<!-- theme: info -->
> 📘 Note
> 
> In order to use this endpoint, the following two things must be true: 
> - You must have already set `processingOptions.saveRecurringToken` to `true` in the [APM one-time-use token](https://docs.nexiopay.com/reference/createapmonetimeusetoken) request for the initial transaction.
> - Your customer must have already checked out and paid through the alternative payment method for that initial transaction.

<!-- theme: warning -->
> ⚠️ Try It
> 
> To use the Try It feature for this endpoint, you must use the credentials for your [Sandbox API user](https://docs.nexiopay.com/docs/sandbox-environments).


<div style="display:none;">

## Request parameters
- apm
- apm.token
- data
- data.amount
- data.currency
- data.customer
- data.customer.orderNumber
- data.customer.billToAddressOne
- data.customer.billToAddressTwo
- data.customer.billToCity
- data.customer.billToCountry
- data.customer.billToPhone
- data.customer.billToPostal
- data.customer.billToState
- data.customer.birthDate
- data.customer.companyName
- data.customer.createdAtDate
- data.customer.customerRef
- data.customer.email
- data.customer.invoice
- data.customer.firstName
- data.customer.lastName
- data.customer.orderDate
- data.customer.phone
- data.customer.shipToAddressOne
- data.customer.shipToAddressTwo
- data.customer.shipToCity
- data.customer.shipToCountry
- data.customer.shipToPhone
- data.customer.shipToPostal
- data.customer.shipToState
- data.customFields
- data.customFields.exampleKey
- data.description
- isAuthOnly
- processingOptions
- processingOptions.merchantId
- processingOptions.paymentOptionTag
- processingOptions.webhookFailUrl

## Response parameters
- id
- merchantId
- transactionDate
- transactionStatus
- amount
- transactionType
- currency
- gatewayResponse
- gatewayResponse.gatewayName
- gatewayResponse.refNumber
- data
- data.amount
- data.currency
- data.settlementCurrency
- data.customer
- data.customer.customerRef
- data.customer.orderNumber
- data.customer.orderDate
- data.customer.invoice
- data.customer.firstName
- data.customer.lastName
- data.customer.birthDate
- data.customer.billToAddressOne
- data.customer.billToAddressTwo
- data.customer.billToCity
- data.customer.billToCountry
- data.customer.billToPhone
- data.customer.billToPostal
- data.customer.billToState
- data.customer.email
- data.customer.phone
- data.customer.shipToAddressOne
- data.customer.shipToAddressTwo
- data.customer.shipToCity
- data.customer.shipToCountry
- data.customer.shipToPhone
- data.customer.shipToPostal
- data.customer.shipToState
- data.customer.createdAt
- data.customFields
- data.customFields.exampleKey
- data.description
- apm
- apm.token

</div>

## Request body

- object
  - `apm` object, required
    - `token` string, required — The APM token to be used for this merchant-initiated recurring payments, such as with Braintree PayPal.
  - `data` object, required — Transaction data
    - `amount` number, required — The transaction amount for this merchant-initiated transaction.
    - `currency` Currency, required — unresolved $ref
    - `customer` object, required — Customer information to be used in checking fraud or sent to the processing gateway, when applicable.
      - `orderNumber` string, required — The order number. This must be a unique value. Nexio recommends a format for the order number of a unique value that also includes an attempt number so that you can track attempts per order, such as when a payment attempt fails. For example, something like `[order_number]-[attempt_number]`.
      - `customerRef` CustomerRef — unresolved $ref
      - `orderDate` string — The date of the customer's order. This field is required by certain gateways. For information on gateway-specific required fields, see the [Connections](https://docs.nexiopay.com/docs/connections) documentation. Use any of the following formats for the date: - Four-digit year, two-digit month and day, separated with hyphens: YYYY-MM-DD.<br>For example, `2021-08-26`. - [ISO-8601](https://www.iso.org/iso-8601-date-and-time-format.html) date expressed in UTC, with as much of the time part as wanted.<br>For example, `2001-08-26T13:35:00.978Z` or `1990-12-05T00:00Z`. - UNIX date (as an integer representing seconds).<br>For example, `1630006518`. <!-- theme:info --> > #### Note > This is NOT a quick way to schedule a transaction. Specifying a date in the future does not cause the order to be run automatically at the indicated date or time.
      - `invoice` string — The invoice number. This value is cached in the one-time-use token.
      - `firstName` string — The customer's first name, as it appears on the card. This value is cached in the one-time-use token.
      - `lastName` string — The customer's last name, as it appears on the card. This value is cached in the one-time-use token.
      - `birthDate` string — The customer's date of birth. Use any of the following formats for the date: - Four-digit year, two-digit month and day, separated with hyphens: YYYY-MM-DD.<br>For example, `2001-08-26`. - [ISO-8601](https://www.iso.org/iso-8601-date-and-time-format.html) date expressed in UTC, with as much of the time part as wanted.<br>For example, `2001-08-26T13:35:00Z` or `1990-12-05T00:00Z`. - UNIX date (as an integer representing seconds).<br>For example, `998854500`.
      - `email` string — The customer's email address. This value is cached in the one-time-use token.
      - `phone` string — The customer's phone number. This value is cached in the one-time-use token.
      - `companyName` string — This field may be included if the bank account being used for payment is a business account.
      - `billToAddressOne` string — The street address on file with the card provider. This value is cached in the one-time-use token.
      - `billToAddressTwo` string — Additional street address information, if required. This value is cached in the one-time-use token.
      - `billToCity` string — The city on file with the card provider. This value is cached in the one-time-use token.
      - `billToState` string — The state or province on file with the card provider. (If in the US, this must be the [two-character state abbreviation](https://pe.usps.com/text/pub28/28apb.htm)). This value is cached in the one-time-use token.
      - `billToPostal` string — The postal code on file with the card provider. This value is cached in the one-time-use token.
      - `billToCountry` string — The [two-character (Alpha-2) ISO country code](https://www.iso.org/obp/ui/#search/code/) for the address on file with the card provider. This value is cached in the one-time-use token.
      - `billToPhone` string — The billing phone number. This value is cached in the one-time-use token.
      - `shipToAddressOne` string — The shipping address, if different from the billing address. This value is cached in the one-time-use token.
      - `shipToAddressTwo` string — Additional shipping address information, if required. This value is cached in the one-time-use token.
      - `shipToCity` string — The shipping city. This value is cached in the one-time-use token.
      - `shipToState` string — The shipping state or province. (If in the US, this must be the [two-character state abbreviation](https://pe.usps.com/text/pub28/28apb.htm).) This value is cached in the one-time-use token.
      - `shipToPostal` string — The shipping postal code. This value is cached in the one-time-use token.
      - `shipToCountry` string — The [two-character (Alpha-2) ISO](https://www.iso.org/obp/ui/#search/code/) shipping country code. This value is cached in the one-time-use token.
      - `shipToPhone` string — The shipping phone number. This value is cached in the one-time-use token.
      - `createdAtDate` string — The date the customer was created in your system. The format is four-digit year, two-digit month and day, separated with hyphens: YYYY-MM-DD.<p><b>Note:</b> This information is only used to allow you to more fully customize your fraud rules. <b>Nexio does not store this data.</b></p>
    - `customFields` object — Nexio stores information in custom fields and passes custom fields to gateways that support them. <!-- theme: warning --> > #### Important > * Do not use custom fields to store sensitive data, such as cardholder information.
      - `exampleKey` string — You may use any key as a custom field. Values must be strings.
      - `exampleRefNumber` string — A reference value used by the gateway.
    - `description` string — A description of the transaction. This value is cached in the one-time-use token.
  - `isAuthOnly` boolean — Set to `true` to run an auth only transaction. This value is cached in the one-time-use token.
  - `processingOptions` object — Processing Options
    - `paymentOptionTag` PaymentOptionTag — unresolved $ref
    - `webhookFailUrl` string — The URL to which Nexio will send the results of a failed transaction. This URL must use the HTTPS protocol.
    - `merchantId` MerchantId — unresolved $ref

## Response `200`

Success

- object — The response from a successful merchant-initiated payment, such as through Braintree PayPal.
  - `id` Id — unresolved $ref
  - `merchantId` string — The Nexio merchant ID (MID) through which the transaction was processed. Returned for regular and 3DS-enabled transactions.
  - `transactionDate` TransactionDate — unresolved $ref
  - `transactionStatus` string — The [transaction status](https://docs.nexiopay.com/docs/constant-transaction-values#transaction-status-transactionstatus).
  - `amount` Amount — unresolved $ref
  - `transactionType` TransactionType — unresolved $ref
  - `currency` string — The [three-digit ISO numeric currency code](https://en.wikipedia.org/wiki/ISO_4217). For information about valid values, see the [currency table](https://docs.nexiopay.com/docs/constant-transaction-values#currency-id-currencyid) in Guides.
  - `gatewayResponse` GatewayResponse — unresolved $ref
  - `data` object — Transaction and customer data.
    - `amount` Amount — unresolved $ref
    - `currency` Currency — unresolved $ref
    - `settlementCurrency` SettlementCurrency — unresolved $ref
    - `customer` object — Customer information returned when checking fraud or from the processing gateway, when applicable.
      - `orderNumber` OrderNumber — unresolved $ref
      - `customerRef` CustomerRef — unresolved $ref
      - `orderDate` OrderDate — unresolved $ref
      - `invoice` Invoice — unresolved $ref
      - `firstName` FirstName — unresolved $ref
      - `lastName` LastName — unresolved $ref
      - `birthDate` BirthDate — unresolved $ref
      - `email` Email — unresolved $ref
      - `phone` Phone — unresolved $ref
      - `companyName` CompanyName — unresolved $ref
      - `billToAddressOne` BillToAddressOne — unresolved $ref
      - `billToAddressTwo` BillToAddressTwo — unresolved $ref
      - `billToCity` BillToCity — unresolved $ref
      - `billToCountry` BillToCountry — unresolved $ref
      - `billToPhone` BillToPhone — unresolved $ref
      - `billToPostal` BillToPostal — unresolved $ref
      - `billToState` BillToState — unresolved $ref
      - `shipToAddressOne` ShipToAddressOne — unresolved $ref
      - `shipToAddressTwo` ShipToAddressTwo — unresolved $ref
      - `shipToCity` ShipToCity — unresolved $ref
      - `shipToCountry` ShipToCountry — unresolved $ref
      - `shipToPhone` ShipToPhone — unresolved $ref
      - `shipToPostal` ShipToPostal — unresolved $ref
      - `shipToState` ShipToState — unresolved $ref
      - `createdAtDate` CreatedAtDate — unresolved $ref
    - `customFields` CustomFields — unresolved $ref
    - `description` Description — unresolved $ref
  - `apm` object
    - `token` string — The APM token to be used for future merchant-initiated recurring payments, such as with Braintree PayPal.

## Other responses

- `401` — Unauthorized. For help with this error and other error codes, see [Common errors](https://docs.nexiopay.com/docs/common-errors) in the Guides area.

---

[API](https://skmtc.dev/nexiopay/apis/payments-api-reference.md) · [All operations](https://skmtc.dev/nexiopay/apis/payments-api-reference/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/nexiopay/payments-api-reference/revisions/b414b73979e5/schema)