Retrieve a payment instrument setup transaction

Retrieves the latest setup transaction for a payment instrument with a specified ID.

For more information, see Transactions.

SecurityHTTP: CustomerJWT
Request
path Parameters
id
required
string <= 50 characters ^[@~\-\.\w]+$

ID of the resource.

get
/storefront/payment-instruments/{id}/setup
Responses

200

Setup transaction retrieved.

Response Schema: application/json
id
string (TransactionId) <= 50 characters

ID of the transaction.

websiteId
string <= 50 characters
type
string

Type of transaction.

Enum: "3ds-authentication" "authorize" "capture" "credit" "refund" "sale" "setup" "void"
status
string

Status of the transaction.

Enum: "completed" "conn-error" "disputed" "never-sent" "offsite" "partially-refunded" "pending" "refunded" "sending" "timeout" "voided" "waiting-approval" "waiting-capture" "waiting-gateway" "waiting-refund"
result
string

Result of the transaction.

Enum: "abandoned" "approved" "canceled" "declined" "unknown"
amount
number <double>

Total amount of the transaction.

currency
string (CurrencyCode) = 3 characters

Currency code in ISO 4217 format.

purchaseAmount
number <double>

Amount by which the purchase is completed. If an adjustment occurs, the purchased amount may differ from the requested amount.

purchaseCurrency
string (CurrencyCode) = 3 characters

Currency code in ISO 4217 format.

requestAmount
number <double>

Amount of the payment request. If an adjustment occurs, the purchase amount may differ from the billing amount.

requestCurrency
string (CurrencyCode) = 3 characters

Currency code in ISO 4217 format.

parentTransactionId
string (TransactionId) <= 50 characters

ID of the transaction.

childTransactions
Array of strings (ResourceId)

IDs of child transactions.

invoiceIds
Array of strings (ResourceId)

Related invoice IDs.

orderIds
Array of strings (ResourceId)

Subscription IDs of invoices that are related to the transaction.

planIds
Array of strings (ResourceId)

Plan IDs of orders that are related to the transaction.

isRebill
boolean

Specifies if the transaction is one of a number of recurring payments in a subscription, excluding trials or setup fees.

rebillNumber
integer

Rebill number of the transaction. A rebill number is the number of recurring payments in a subscription, excluding trials or setup fees.

object (ContactObject)

Contact's information.

redirectUrl
string or null <uri>

URL where the end-user is redirected to when an offsite transaction is completed. The default value is the website URL.

retryNumber
integer

Position of the transaction in the sequence of retries.

isRetry
boolean

Specifies if a transaction is a retry.

billingDescriptor
string or null

Billing descriptor that appears on the periodic billing statement. For a credit card statement, this field commonly contains 12 or fewer characters.

description
string <= 255 characters

Description of the payment.

requestId
string

Request ID of the transaction. This ID must be unique within a 24 hour period. Use this field to prevent duplicated transactions.

hasAmountAdjustment
boolean

Specifies if the transaction has amount adjustment.

gatewayName
string or null

Payment gateway name.

Enum: "A1Gateway" "ACI" "Adyen" "Aircash" "Airpay" "Airwallex" "AmazonPay" "AmexVPC" "ApcoPay" "AsiaPaymentGateway" "AstroPayCard" "AuthorizeNet" "Awepay" "Bambora" "BankSEND" "BitPay" "BlueSnap" "BraintreePayments" "Buckaroo" "BVNK" "Cardknox" "Cashflows" "CASHlib" "Cashterminal" "CashToCode" "CauriPayment" "Cayan" "CCAvenue" "Chase" "CheckoutCom" "Chillstock" "Circle" "Citadel" "Clearhaus" "Cleo" "CODVoucher" "Coinbase" "CoinGate" "CoinPayments" "Conekta" "Coppr" "Credorax" "Cryptonator" "CyberSource" "DataCash" "Dengi" "Dimoco" "Directa24" "dLocal" "Dragonphoenix" "Dropayment" "EasyPayDirect" "EBANX" "ecoPayz" "EcorePay" "Elavon" "Euteller" "eMerchantPay" "EMS" "ePay" "EPG" "EPro" "Ezeebill" "eZeeWallet" "ezyEFT" "FasterPay" "Finrax" "Flexepin" "FinTecSystems" "FundSend" "Forte" "GET" "Gigadat" "GlobalOnePay" "Gooney" "Gpaysafe" "Greenbox" "HiPay" "iCanPay" "ICEPAY" "iCheque" "iDebit" "Ilixium" "Ingenico" "INOVAPAY" "Inovio" "Intuit" "InstaDebit" "IpayOptions" "JetPay" "Jeton" "JPMOrbital" "Khelocard" "Klarna" "Konnektive" "LaCore" "loonie" "LPG" "MaxiCash" "MercadoPago" "MiFinity" "MobilePay" "Moneris" "MtaPay" "MuchBetter" "MuchBetterGateway" "MyFatoorah" "Neosurf" "Netbanking" "Neteller" "NGenius" "NinjaWallet" "NMI" "NordikCoin" "NOWPayments" "NuaPay" "OchaPay" "Onlineueberweisen" "OnRamp" "Orbital" "Pagadito" "Pagsmile" "Panamerican" "ParamountCommerce" "ParamountEft" "ParamountInterac" "PandaGateway" "Pay4Fun" "PayCash" "PayClub" "PayEcards" "Payeezy" "Payflow" "Paynote" "PaymentAsia" "PaymenTechnologies" "PaymentsOS" "Paymero" "PayPal" "Payper" "Payr" "PayRedeem" "PayRetailers" "Paysafe" "Paysafecard" "Paysafecash" "PayTabs" "PayULatam" "Payvision" "PharosPayments" "Piastrix" "Pin4Pay" "Plugnpay" "PostFinance" "PPRO" "Prosa" "PSiGate" "Rapyd" "Realex" "Realtime" "Redsys" "Rotessa" "RPN" "Safecharge" "SaltarPay" "Sagepay" "SeamlessChex" "SecureTrading" "SecurionPay" "Skrill" "SmartInvoice" "SMSVoucher" "Sofort" "SparkPay" "StaticGateway" "STPMexico" "Stripe" "Telr" "TestProcessor" "ToditoCash" "Truevo" "TrustsPay" "Trustly" "TWINT" "Unlimit" "UPayCard" "USAePay" "VantivLitle" "vegaaH" "VCreditos" "VegaWallet" "Wallet88" "Walpay" "WesternUnion" "Wirecard" "WorldlineAtosFrankfurt" "Worldpay" "XPay" "Zimpler" "Zotapay"
object

Related gateway information.

customFields
object (ResourceCustomFields)

Use custom fields to extend a resource scheme to include custom data that is not provided as a common field. For more information, see Custom fields.

processedTime
string <date-time> (ServerTimestamp)

Read-only timestamp in ISO 8601 date-time format.

createdTime
string <date-time> (CreatedTime)

Date and time which is set automatically when the resource is created.

updatedTime
string <date-time> (UpdatedTime)

Date and time which updates automatically when the resource is updated.

object

Default payment instrument information.

approvalUrl
string <uri>

URL to redirect the end-customer when transaction status is waiting-approval or offsite.

token
string

Session token that is used for authentication. This token provides access to created orders, invoices, and transactions.

depositRequestId
string or null <= 50 characters

ID of the deposit request if applicable. The created transaction is based on the properties of this deposit request.

Array of objects

Related links.

401

Unauthorized access. Invalid credentials used.

403

Access forbidden.

404

Resource not found.

Response samples
application/json
{ "id": "txn_0YVDTQJ8YWDGQACV2N2N5SPWQ0", "websiteId": "web_0YV7DE4Z26DQSA1AC92FBJ7SEG", "type": "3ds-authentication", "status": "completed", "result": "abandoned", "amount": 0.1, "currency": "USD", "purchaseAmount": 0.1, "purchaseCurrency": "USD", "requestAmount": 0.1, "requestCurrency": "USD", "parentTransactionId": "txn_0YVDTQJ8YWDGQACV2N2N5SPWQ0", "childTransactions": [ "4f6cf35x-2c4y-483z-a0a9-158621f77a21" ], "invoiceIds": [ "4f6cf35x-2c4y-483z-a0a9-158621f77a21" ], "orderIds": [ "4f6cf35x-2c4y-483z-a0a9-158621f77a21" ], "planIds": [ "4f6cf35x-2c4y-483z-a0a9-158621f77a21" ], "isRebill": true, "rebillNumber": 0, "billingAddress": { "firstName": "Benjamin", "lastName": "Franklin", "organization": "Rebilly", "address": "36 Craven St", "address2": "string", "city": "Austin", "region": "Texas", "country": "GB", "postalCode": "WC2N 5NF", "dob": "1980-04-01", "jobTitle": "CEO", "hash": "056ae6d97c788b9e98b049ebafd7b229bf852221" }, "redirectUrl": "http://example.com", "retryNumber": 0, "isRetry": true, "billingDescriptor": "string", "description": "string", "requestId": "string", "hasAmountAdjustment": true, "gatewayName": "A1Gateway", "gateway": { }, "customFields": { "foo": "bar" }, "processedTime": "2019-08-24T14:15:22Z", "createdTime": "2019-08-24T14:15:22Z", "updatedTime": "2019-08-24T14:15:22Z", "paymentInstrument": { "method": "payment-card", "paymentInstrumentId": "inst_0YVB8KPKNXCBR9EDX7JHSED75N" }, "approvalUrl": "http://example.com", "token": "string", "depositRequestId": "dep_req_0YVJ65BSGYC3EAT58SEX8KY6J7", "_links": [ ] }