When you send an Initialize (initialize-payment) POST request, the Velocity API initializes the payment process, and it returns information about the transaction (such as transaction ID and amount) and the configured payment methods or card types the customer can use.

The Initialize response contains these types of information:

• Merchant configuration - The client-config element provides merchant-set configurations, like the callback URL.
• Transaction information - The transaction element contains information about the transaction, such as the transaction ID and amount.
• Card information - The cards element provides the configured payment methods that the customer can use.

Prerequisite - Work with your CellPoint Digital sales representative or account manager to sign up, set up your test account, and access your testing credentials.

For API reference, see Initialize.

The Authorize (authorize-payment) operation authorizes a transaction. There are alternative request formats depending on the payment methods selected.

Prerequisite - Work with your CellPoint Digital sales representative or account manager to sign up, set up your test account, and access your testing credentials.

Response - Velocity API's Authorize response confirms successful authorization; otherwise, it has minimal data. Most of the relevant data in response to a proper authorization is provided in the Webhook body. For example, a Webhook can include authorization approval code, address verification, fraud results, and 3DS results. For more information, see our Webhooks integration guide.

3-D Secure (3DS) - Part of CellPoint's 3DS flow can be triggered by the Authorize operation. If you receive an Authorize response with the 3DS trigger, see our 3-D Secure integration guide for more information.

For API reference, see Authorize.

The Pay operation is normally used for an alternative payment method (APM) payment. The request is an internal request from a merchant’s portal to the Velocity API when a customer initializes a payment. The operation does the following:

• Retrieve information about how to proceed with the payment or PSP confirmation. This information gives an idea about the parameters required to authorize a transaction.
• Ensure that a complete audit trail is maintained for each payment transaction.
• It can also return different responses depending on the type of payment, such as 3DS, non-3DS, wallet, other APM, or stored card.

📘

Note: Merchants are not required to send a Pay request in the following situations:

• Card payment.
• Using stored card information that is in Velocity's store vault.

Prerequisite - Work with your CellPoint Digital sales representative or account manager to sign up, set up your test account, and access your testing credentials.

The structure of the Pay response depends on the type of payment being made.

After using the Pay operation, merchants must send an Authorize request. See Authorize for details.

For API reference, see Pay.

The Capture (capture-payment) operation captures an authorized transaction. Use it to facilitate a complete capture or a partial capture, depending on the value of the amount field in your request. (A partial capture uses an amount that's greater than 0 and less than the authorized amount.)

🚧

Note: Only use the Capture operation if you have enabled manual capture. Do not use it if you have enabled auto-capture.

Prerequisite - Work with your CellPoint Digital sales representative or account manager to sign up, set up your test account, and access your testing credentials.

Integration notes:

• When sending a Capture request, include transaction details from your successful Authorize request.
• The Velocity API returns a Capture response confirming if the request succeeded or failed. If your Capture request was successful, the Velocity server returns a Capture response containing the transaction ID and status code="1000”.

For API reference, see Capture.

The Ticket-level Capture (update-order-data) operation is applicable to use by an airline; it facilitates automatic ticket-level captures. After updating Airline Itinerary Data (AID), Velocity captures the transaction amount internally and passes the information to PSPs for payment processing. After that, it is passed to the merchant system. You do not need to use the Capture operation.

🚧

Note: You do not need to use the Capture operation if you are using this operation.

Prerequisite - Work with your CellPoint Digital sales representative or account manager to sign up, set up your test account, and access your testing credentials.

Integration notes:

You must send a separate Ticket-level Capture request for each transaction associated with the order number (order-no). Each request contains one or more line-item objects; each line-item object is associated with a distinct order-ref value (the ticket/emd number). See the example below:

For API reference, see Ticket-level Capture.

The Reversal/Refund (refund) operation reverses or refunds a transaction. To refund multiple transactions to a customer in a single request, use the Bulk Refund operation.

Please note:

• The Refund (refund) operation voids an authorized transaction or refunds a captured transaction based on the status of the transaction.
• If refunding a captured transaction, you can provide a partial refund or a complete refund. The amount field can take values equal to or less than the captured amount. If you do not specify an amount, a customer receives the complete refund.
• If voiding an authorized transaction, you must void the full authorized amount.

Prerequisites:

• Work with your CellPoint Digital sales representative or account manager to sign up, set up your test account, and access your testing credentials.
• Do one or both of the following:
  • Use the Authorize operation to authorize a transaction, or
  • Use the Capture operation to capture a transaction.

For API reference, see Reversal / Refund.

The Bulk Refund (bulk-refund) operation refunds multiple transactions to a customer in a single request. To reverse or refund a single transaction, use the Reversal/Refund operation.

Please note:

• This operation voids an authorized transaction or refunds a captured transaction based on the status of the transaction.
• If refunding a captured transaction, you can provide a partial refund or a complete refund. The amount field can take values equal to or less than the captured amount. If you do not specify an amount, a customer receives the complete refund.
• If voiding an authorized transaction, you must void the full authorized amount.

Prerequisites:

• Work with your CellPoint Digital sales representative or account manager to sign up, set up your test account, and access your testing credentials.
• Do one of the following:
  • Use the Authorize operation to authorize a transaction, or
  • Use the Capture operation to capture a transaction.
• Repeat the step above to authorize or capture at least one more transaction.

For API reference, see Bulk Refund.

The Get Payment Methods operation returns a list of payment methods with which a customer is eligible to pay. This eligibility is based on the Curated Payment Business Rule that is applicable to the transaction.

Prerequisite - Work with your CellPoint Digital sales representative or account manager to sign up, set up your test account, and access your testing credentials.

For API reference, see Get Payment Methods.

The Get Transaction Status operation (get-transaction-status) returns a transaction status based on its transaction ID, or a session status based on its session ID. The operation is useful to reverify a transaction status when, for example, the Authorize operation does not show a success response due to network issues or after redirection flow.

Please note:

• CellPoint Digital recommends integrating Get Transaction Status, but it is optional.
• You can configure this operation to view a transaction's status on your web portal or on your server.

Prerequisites:

• Work with your CellPoint Digital sales representative or account manager to sign up, set up your test account, and access your testing credentials.
• Use the Initialize, Authorize, or Capture operation to start a payment transaction (and, optionally, capture it).

Integration notes:

• You can change whether you request a transaction status or a session status by varying the content of the request.
• Once you have sent your Get Transaction Status request, Velocity API sends a response containing information about the transaction or the session whose status you have requested.

For API reference, see Get Transaction Status.

The Get Payment Summary operation (get-payment-summary) retrieves the decrypted summary of one or more payments, including the masked card numbers from various wallets.

Get Payment Summary is only applicable to wallet integration. For instance, if you have integrated Apple Pay or Google Pay and want to show the masked card number to the customer, you can use this operation.

Prerequisites:

• Work with your CellPoint Digital sales representative or account manager to sign up, set up your test account, and access your testing credentials.
• Do one or both of the following:
  • Use the Authorize operation to authorize a transaction, or
  • Use the Capture operation to capture a transaction.

For API reference, see Get Payment Summary.

The Get Installment Plans operation returns a list of installment plans available for a selected credit card. It is not applicable to wallet integrations.

Prerequisites:

• Work with your CellPoint Digital sales representative or account manager to sign up, set up your test account, and access your testing credentials, and set up your account to allow for installment payments.
• Follow the Installments guide to send an Initialize request for a payment option that is eligible for installments.

For more information on integrating this operation see our Installments integrations guide.

For API reference, see Get Installment Plans.

The FX: Offer Criteria operation (foreignexchange/offers) is used as part of the Foreign Exchange (FX) feature. The operation returns currency exchange rates for a selected card's currency.

Prerequisite - Work with your CellPoint Digital sales representative or account manager to sign up, set up your test account, and access your testing credentials.

For more information on the integration and use of this API operation, see the Foreign Exchange (FX) integration guide.

For API reference, see FX: Offer Criteria.

You can use the Pay By Link (PBL) operation to create a payment link for a customer using Velocity POP. When a customer clicks the payment link, it directs them to a hosted payment page for them to complete their payment. This operation also supports generation of payment links in bulk, up to 20 payment links at a time.

Prerequisite - Work with your CellPoint Digital sales representative or account manager to sign up, set up your test account, and access your testing credentials.

Response - The response contains one or more payment links with the expiration of each link configured in the request body of the API. Each payment link is mapped to its request using the reference value present in both request and response.

For API reference information, see Pay By Link (PBL).

You can use Velocity API's Deactivate PBL operation to deactivate a payment link that you previously generated using the Pay By Link (PBL) operation. For information on generating a payment link, see the Pay By Link (PBL) section above.

Prerequisite - Work with your CellPoint Digital sales representative or account manager to sign up, set up your test account, and access your testing credentials.

For API reference information, see Deactivate PBL.