Server API version 1.0
Java

Results for

icon-search-large No search results yet
Enter your search query above

Get capture

GET https://{domainname}/v1/{merchantId}/captures/{captureId}

Captures

The captures REST services allow you to retrieve details of a capture created through the capture payment API. A capture is identified by its captureId.

Request

Retrieves the details of the capture with the captureId provided in the URL. This captureId was returned to you with the capture payment request. The request does not have any additional input parameters.

Request example

SDK: Java

This scenario you will probably use the most

  • CaptureResponse response = client.merchant("merchantId").captures().get("captureId");
    

Responses

Please find below an overview of the possible responses.

Response 200 - OKCaptureResponse

An HTTP 200 response is returned with the details of the captures if the retrieval is successful.

       Property Type Required Description
object no SDK object type: CaptureOutput
Object containing capture details
object no SDK object type: AmountOfMoney
Object containing amount and ISO currency code attributes
amount integer (12) yes

Amount in cents and always having 2 decimals

currencyCode string (3) yes

Three-letter ISO currency code representing the currency for the amount

amountPaid integer no

Amount that has been paid

object yes,

one of group

SDK object type: BankTransferPaymentMethodSpecificOutput
Object containing the bank transfer payment method details
paymentProductId integer no

Payment product identifier
Please see payment products for a full overview of possible values.

object yes,

one of group

SDK object type: CardPaymentMethodSpecificOutput
Object containing the card payment method details
authorisationCode string no

Card Authorization code as returned by the acquirer

object no SDK object type: CardEssentials
Object containing card details
cardNumber string (19) no

The complete credit/debit card number

expiryDate string (4) no

Expiry date of the card
Format: MMYY

object no SDK object type: CardFraudResults
Fraud results contained in the CardFraudResults object
avsResult string no

Result of the Address Verification Service checks. Possible values are:
  • A - Address (Street) matches, Zip does not
  • B - Street address match for international transactions—Postal code not verified due to incompatible formats
  • C - Street address and postal code not verified for international transaction due to incompatible formats
  • D - Street address and postal code match for international transaction, cardholder name is incorrect
  • E - AVS error
  • F - Address does match and five digit ZIP code does match (UK only)
  • G - Address information is unavailable; international transaction; non-AVS participant
  • H - Billing address and postal code match, cardholder name is incorrect (Amex)
  • I - Address information not verified for international transaction
  • K - Cardholder name matches (Amex)
  • L - Cardholder name and postal code match (Amex)
  • M - Cardholder name, street address, and postal code match for international transaction
  • N - No Match on Address (Street) or Zip
  • O - Cardholder name and address match (Amex)
  • P - Postal codes match for international transaction—Street address not verified due to incompatible formats
  • Q - Billing address matches, cardholder is incorrect (Amex)
  • R - Retry, System unavailable or Timed out
  • S - Service not supported by issuer
  • U - Address information is unavailable
  • W - 9 digit Zip matches, Address (Street) does not
  • X - Exact AVS Match
  • Y - Address (Street) and 5 digit Zip match
  • Z - 5 digit Zip matches, Address (Street) does not
  • 0 - No service available

cvvResult string no

Result of the Card Verification Value checks. Possible values are:
  • M - CVV check performed and valid value
  • N - CVV checked and no match
  • P - CVV check not performed, not requested
  • S - Cardholder claims no CVV code on card, issuer states CVV-code should be on card
  • U - Issuer not certified for CVV2
  • Y - Server provider did not respond
  • 0 - No service available

fraudServiceResult string no

Resulting advice of the fraud prevention checks. Possible values are:
  • accepted - Based on the checks performed the transaction can be accepted
  • challenged - Based on the checks performed the transaction should be manually reviewed
  • denied - Based on the checks performed the transaction should be rejected
  • no-advice - No fraud check was requested/performed
  • error - The fraud check resulted an error. Note that the fraud check was thus not performed.

object no SDK object type: FraudResultsRetailDecisions
Additional response data returned by RetailDecisions
fraudCode string no

Result of the fraud service. Provides additional information about the fraud result

fraudNeural string no

Returns the raw score of the neural

fraudRCF string no

Result of the fraud service Represent sets of fraud rules returned during the evaluation of the transaction

paymentProductId integer no

Payment product identifier
Please see payment products for a full overview of possible values.

object no SDK object type: ThreeDSecureResults
3D Secure results object
cavv string no

CAVV or AVV result indicating authentication validation value

eci string no

Indicates Authentication validation results returned after AuthenticationValidation

xid string no

Transaction ID for the Authentication

token string no

ID of the token. This property is populated for the Ogone payment platform when the payment was done with a token or when the payment was tokenized.

object yes,

one of group

SDK object type: CashPaymentMethodSpecificOutput
Object containing the cash payment method details
paymentProductId integer no

Payment product identifier
Please see payment products for a full overview of possible values.

object yes,

one of group

SDK object type: NonSepaDirectDebitPaymentMethodSpecificOutput
Object containing the non SEPA direct debit payment method details
object no SDK object type: FraudResults
Object containing the results of the fraud screening
fraudServiceResult string no

Results from the fraud prevention check. Possible values are:
  • accepted - Based on the checks performed the transaction can be accepted
  • challenged - Based on the checks performed the transaction should be manually reviewed
  • denied - Based on the checks performed the transaction should be rejected
  • no-advice - No fraud check was requested/performed
  • error - The fraud check resulted in an error and the fraud check was thus not performed

paymentProductId integer no

Payment product identifier
Please see payment products for a full overview of possible values.

object yes,

one of group

SDK object type: EInvoicePaymentMethodSpecificOutput
Object containing the e-invoice payment method details
object no SDK object type: EInvoicePaymentProduct9000SpecificOutput
AfterPay Installments (payment product 9000) specific details
installmentId string yes

The ID of the installment plan used for the payment.

paymentProductId integer no

Payment product identifier
Please see payment products for a full overview of possible values.

object yes,

one of group

SDK object type: InvoicePaymentMethodSpecificOutput
Object containing the invoice payment method details
paymentProductId integer no

Payment product identifier
Please see payment products for a full overview of possible values.

object yes,

one of group

SDK object type: MobilePaymentMethodSpecificOutput
Object containing the mobile payment method details
authorisationCode string no

Card Authorization code as returned by the acquirer

object no SDK object type: CardFraudResults
Fraud results contained in the CardFraudResults object
avsResult string no

Result of the Address Verification Service checks. Possible values are:
  • A - Address (Street) matches, Zip does not
  • B - Street address match for international transactions—Postal code not verified due to incompatible formats
  • C - Street address and postal code not verified for international transaction due to incompatible formats
  • D - Street address and postal code match for international transaction, cardholder name is incorrect
  • E - AVS error
  • F - Address does match and five digit ZIP code does match (UK only)
  • G - Address information is unavailable; international transaction; non-AVS participant
  • H - Billing address and postal code match, cardholder name is incorrect (Amex)
  • I - Address information not verified for international transaction
  • K - Cardholder name matches (Amex)
  • L - Cardholder name and postal code match (Amex)
  • M - Cardholder name, street address, and postal code match for international transaction
  • N - No Match on Address (Street) or Zip
  • O - Cardholder name and address match (Amex)
  • P - Postal codes match for international transaction—Street address not verified due to incompatible formats
  • Q - Billing address matches, cardholder is incorrect (Amex)
  • R - Retry, System unavailable or Timed out
  • S - Service not supported by issuer
  • U - Address information is unavailable
  • W - 9 digit Zip matches, Address (Street) does not
  • X - Exact AVS Match
  • Y - Address (Street) and 5 digit Zip match
  • Z - 5 digit Zip matches, Address (Street) does not
  • 0 - No service available

cvvResult string no

Result of the Card Verification Value checks. Possible values are:
  • M - CVV check performed and valid value
  • N - CVV checked and no match
  • P - CVV check not performed, not requested
  • S - Cardholder claims no CVV code on card, issuer states CVV-code should be on card
  • U - Issuer not certified for CVV2
  • Y - Server provider did not respond
  • 0 - No service available

fraudServiceResult string no

Resulting advice of the fraud prevention checks. Possible values are:
  • accepted - Based on the checks performed the transaction can be accepted
  • challenged - Based on the checks performed the transaction should be manually reviewed
  • denied - Based on the checks performed the transaction should be rejected
  • no-advice - No fraud check was requested/performed
  • error - The fraud check resulted an error. Note that the fraud check was thus not performed.

object no SDK object type: FraudResultsRetailDecisions
Additional response data returned by RetailDecisions
fraudCode string no

Result of the fraud service. Provides additional information about the fraud result

fraudNeural string no

Returns the raw score of the neural

fraudRCF string no

Result of the fraud service Represent sets of fraud rules returned during the evaluation of the transaction

network string no

The network that was used for the refund

object no SDK object type: MobilePaymentData
Object containing payment details
dpan string (19) yes

The obfuscated DPAN. Only the last four digits are visible.

expiryDate string (4) yes

Expiry date of the tokenized card
Format: MMYY

paymentProductId integer no

Payment product identifier
Please see payment products for a full overview of possible values.

object no SDK object type: ThreeDSecureResults
3D Secure results object
cavv string no

CAVV or AVV result indicating authentication validation value

eci string no

Indicates Authentication validation results returned after AuthenticationValidation

xid string no

Transaction ID for the Authentication

object yes,

one of group

SDK object type: RedirectPaymentMethodSpecificOutput
Object containing the redirect payment product details
object no SDK object type: BankAccountIban
Object containing account holder name and IBAN information
accountHolderName string (30) depends

Name in which the account is held.
Depends on: Required for the creation of a Payout
Required for Create and Update token calls.

iban string (50) depends

The IBAN is the International Bank Account Number. It is an internationally agreed format for the BBAN and includes the ISO country code and two check digits.
Depends on: Required for the creation of a Payout
Required for Create and Update token.
Required for payments with product 9000 in Austria (AT) and Germany (DE).
Required for Create mandate and Create payment with mandate calls

object no SDK object type: FraudResults
Object containing the results of the fraud screening
fraudServiceResult string no

Results from the fraud prevention check. Possible values are:
  • accepted - Based on the checks performed the transaction can be accepted
  • challenged - Based on the checks performed the transaction should be manually reviewed
  • denied - Based on the checks performed the transaction should be rejected
  • no-advice - No fraud check was requested/performed
  • error - The fraud check resulted in an error and the fraud check was thus not performed

object no,

one of group

SDK object type: PaymentProduct836SpecificOutput
Sofort (payment product 836) specific details
securityIndicator string no

Indicates if SofortBank could estabilish if the transaction could successfully be processed.
  • 0 - You should wait for the transaction to be reported as paid before shipping any goods.
  • 1 - You can ship the goods. In case the transaction is not reported as paid you can initiate a claims process with SofortBank.

object no,

one of group

SDK object type: PaymentProduct840SpecificOutput
PayPal (payment product 840) specific details
object no SDK object type: PaymentProduct840CustomerAccount
Object containing the details of the PayPal account
accountId string no

Username with which the PayPal account holder has registered at PayPal

billingAgreementId string no

Identification of the PayPal recurring billing agreement

companyName string no

Name of the company in case the PayPal account is owned by a business

countryCode string no

Country where the PayPal account is located

customerAccountStatus string no

Status of the PayPal account.
Possible values are:
  • verified - PayPal has verified the funding means for this account
  • unverified - PayPal has not verified the funding means for this account

customerAddressStatus string no

Status of the consumer's shipping address as registered by PayPal
Possible values are:
  • none - Status is unknown at PayPal
  • confirmed - The address has been confirmed
  • unconfirmed - The address has not been confirmed

firstName string no

First name of the PayPal account holder

payerId string no

The unique identifier of a PayPal account and will never change in the life cycle of a PayPal account

surname string no

Surname of the PayPal account holder

object no SDK object type: Address
Object containing the address details of the consumer
additionalInfo string (50) no

Additional address information

city string (40) depends

City
Depends on: Required for Invoice payments (201)
Required for Direct Debit UK (705), except when a token has been included in the request that includes this value.
Required for the creation of a Payout.
Required for payments with product 9000 or 9001.
Required when address is included in Seller.

countryCode string (2) depends

ISO 3166-1 alpha-2 country code
Depends on: Required, except when a token has been included in the request that includes this value.
Required when address is included in Seller.

houseNumber string (15) depends

House number
Depends on: Required when address is included in Seller.

state string (35) no

Full name of the state or province

stateCode string (9) no

State code

street string (50) depends

Streetname
Depends on: Required for Invoice payments (201)
Required for Direct Debit UK (705), except when a token has been included in the request that includes this value.
Required for the creation of a Payout.
Required for payments with product 9000 or 9001.
Required when address is included in Seller.

zip string (10) depends

Zip code
Depends on: Required for Direct Debit UK (705), except when a token has been included in the request that includes this value.
Required for payments with product 9000 or 9001.

object no SDK object type: ProtectionEligibility
Protection Eligibility data of the PayPal customer
eligibility string no

Possible values:
  • Eligible
  • PartiallyEligible
  • Ineligible

type string no

Possible values:
  • ItemNotReceivedEligible
  • UnauthorizedPaymentEligible
  • Ineligible

paymentProductId integer no

Payment product identifier
Please see payment products for a full overview of possible values.

token string no

ID of the token. This property is populated for the Ogone payment platform when the payment was done with a token or when the payment was tokenized.

object yes,

one of group

SDK object type: SepaDirectDebitPaymentMethodSpecificOutput
Object containing the SEPA direct debit details
object no SDK object type: FraudResults
Object containing the results of the fraud screening
fraudServiceResult string no

Results from the fraud prevention check. Possible values are:
  • accepted - Based on the checks performed the transaction can be accepted
  • challenged - Based on the checks performed the transaction should be manually reviewed
  • denied - Based on the checks performed the transaction should be rejected
  • no-advice - No fraud check was requested/performed
  • error - The fraud check resulted in an error and the fraud check was thus not performed

object no SDK object type: PaymentProduct771SpecificOutput
Output that is SEPA Direct Debit specific (i.e. the used mandate)
mandateReference string no

Unique reference to a Mandate

paymentProductId integer no

Payment product identifier
Please see payment products for a full overview of possible values.

paymentMethod string no

Payment method identifier used by the our payment engine with the following possible values:
  • bankRefund
  • bankTransfer
  • card
  • cash
  • directDebit
  • eInvoice
  • invoice
  • redirect

object no SDK object type: PaymentReferences
Object that holds all reference fields that are linked to this transaction
merchantOrderId integer no

Your order ID for this transaction that is also returned in our report files

merchantReference string no

Your unique reference of the transaction that is also returned in our report files. This is almost always used for your reconciliation of our report files.

paymentReference string no

Payment Reference generated by WebCollect

providerId string no

Provides an additional means of reconciliation for Gateway merchants

providerReference string no

Provides an additional means of reconciliation for Gateway merchants

referenceOrigPayment string no

When you did not supply a merchantReference for your payment, you need to fill this field with the reference of the original payment when you want to refund it

id string no

Our unique capture transaction identifier.

status enum no

Current high-level status of the captures in a human-readable form. Possible values are :
  • CAPTURE_REQUESTED - The transaction is in the queue to be captured
  • CAPTURED - The transaction has been captured and we have received online confirmation
  • CANCELLED - You have cancelled the capture
  • REJECTED_CAPTURE - The capture has been rejected
  • REVERSED - The capture has been reversed

Please see Statuses for a full overview of possible values.

object no SDK object type: CaptureStatusOutput
This object has the numeric representation of the current capture status, timestamp of last status change and performable action on the current capture resource. In case of failed captures and negative scenarios, detailed error information is listed.
statusCode integer no

Numeric status code that is returned by either Ingenico's Global Collect Payment Platform or Ingenico's Ogone Payment Platform. It is returned to ease the migration from the local APIs to Ingenico Connect. You should not write new business logic based on this field as it will be deprecated in a future version of the API. The value can also be found in the Global Collect Payment Console, in the Global Collect report files and the Ogone BackOffice and report files.

Response example

SDK: Java

This scenario you will probably use the most

  • {
        "id" : "000000000100000000010000100001",
        "captureOutput" : {
            "amountOfMoney" : {
                "amount" : 100,
                "currencyCode" : "EUR"
            },
            "references" : {
                "merchantReference" : "AcmeOrder0001",
                "paymentReference" : "0"
            },
            "paymentMethod" : "card",
            "cardPaymentMethodSpecificOutput" : {
                "paymentProductId" : 1,
                "authorisationCode" : "726747",
                "card" : {
                    "cardNumber" : "************7977",
                    "expiryDate" : "1220"
                },
                "fraudResults" : {
                    "avsResult" : "0",
                    "cvvResult" : "0",
                    "fraudServiceResult" : "no-advice"
                }
            }
        },
        "status" : "CAPTURE_REQUESTED",
        "statusOutput" : {
            "statusCode" : 91
        }
    }
    
icon_top_1