This page provides API reference for Velocity API's Capture (capture-payment) operation. For information on how to integrate this operation, see API.

Request

Endpoint: /mpoint/capture-payment
Method: POST

Sample Request

See the following sample request:

<?xml version="1.0" encoding="UTF-8"?>
<root>
  <capture client-id="[integer]" account="[integer]">
    <transaction id="[integer]" order-no="UAT-28577880">
      <amount country-id="100">10000</amount>
    </transaction>
  </capture>
</root>

Request Parameters

`capture`

Parent: root

The capture element is required, and it has the following attributes:

Parameter	Format	Requirement	Description
client-id	Integer	Required	The unique ID configured for a merchant on the Velocity POP.
account	Integer	Optional	The unique ID associated with a payment transaction. It is optional. If you omit this parameter, the payment transaction is associated with the default sub-account.

`transaction`

Parents: root: capture

The transaction element is required, and it has the following attributes:

Parameter	Format	Requirement	Description
`id`	Integer	Required	The unique ID of the transaction.
`order-no`	String	Required	The order ID that a merchant generates. Note: Some payment providers have strict guidelines for the `order-no`. The recommended pattern is `"[a-zA-Z0-9._-]`.
`amount`	Integer	Required	The total amount that a customer is charged for a payment transaction in a country’s smallest currency. For example, the smallest currency of USD is the penny ($0.01). If the transaction amount is $120.30, then the `amount` field contains the value `12030`.
`country-id`	Integer	Required	The CellPoint Digital-specific country code. This is available in Reference.

`amount`

Parents: root: capture: transaction

The amount element is required, and it has the following attribute:

Parameter	Format	Requirement	Description
`country-id`	Integer	Required	The CellPoint Digital-specific country code. This is available in Reference.

The amount element has the following in its text content:

Parameter	Format	Requirement	Description
amount	Integer	Required	The total amount that a customer is charged for a payment transaction in a country’s smallest currency. For example, the smallest currency of USD is the penny ($0.01). If the transaction amount is $120.30, then the `amount` field contains the value `12030`. This can be a value ranging from 0 to the authorized amount.

Response

Sample Response

See the sample success response below:

<?xml version="1.0" encoding="UTF-8"?>
<root>
  <transactions client-id="[integer]">
    <transaction id="[integer]" order-no="28577880">
      <status code="1000"/>
    </transaction>
  </transactions>
</root>

If you do not receive a status code of 1000, see the Reference section for failure codes.

Response Parameters

`transactions`

Parent: root

The transactions element is required, and it has the following attribute:

Parameter	Format	Requirement	Description
`client-id`	Integer	Required	The unique ID configured for a merchant on the Velocity POP.

`transaction`

Parents: root: transactions

Each transactions element requires at least one transaction child, and it may have multiple transaction children. Each transaction child element has the following attributes:

Parameter	Format	Requirement	Description
`id`	Integer	Required	The unique ID of the transaction.
`order-no`	String	Required	The order ID that a merchant generates. Note: Some payment providers have strict guidelines for order-no. The recommended pattern is `"[a-zA-Z0-9._-]`.

`status`

Parents: root: transactions: transaction

Each transaction element requires a status child. Each status child element has the following attribute:

Parameter	Format	Requirement	Description
`code`	Integer	Required	The status code of a transaction. This depends on the payment provider.