Order status
POST
https://api.forter-secure.com/v2/status/{id}
idstring
acceptstringGenerated from available response content types
api-versionstringSpecify the version of the API to target.
x-forter-siteidstring<p>Forter-assigned ID for your account. Note that your Site ID for your test site is different from your production site.</p>
bodyobject<p>Inform of updates to the status of an order, including payment authorization, fulfillment, shipping details, and compensation granted. For pre-authorization flows, use this endpoint to supply Forter with authorization results from your payment processor. While no decision is provided on this request, it is a required input that improves the decision model.</p>
200Example statusResponse
400<p>Bad Request (Often missing a required parameter)</p>
401<p>Unauthorized (No valid API key provided)</p>
404<p>Not Found (The requested item doesn't exist)</p>
500<p>Server Error (Something went wrong on Forter's end)</p>
curl --request POST \
--url https://api.forter-secure.com/v2/status/{id} \
--header 'accept: application/json' \
--header 'content-type: application/json' \
--header 'api-version: 10.3' \
--header 'x-forter-siteid: a1b2c3d4e5f6' \
--data '{
"additionalInformation": {},
"cartItems": [
{
"basicItemData": {
"discount": {
"couponCodeUsed": "FATHERSDAY2015",
"couponDiscountAmount": {}
},
"name": "White GenericBrand handbag",
"price": {},
"quantity": 1,
"type": "TANGIBLE"
},
"beneficiaries": [
{
"additionalVerificationDocuments": {
"documentSource": "UPLOADED_FILE",
"documentType": "Passport",
"documentVerificationServiceResponsePayload": {}
},
"address": {
"address1": "235 Montgomery st.",
"city": "San Francisco",
"country": "US",
"savedData": {
"usedSavedData": true
}
},
"bankAccount": {
"paymentGatewayData": {}
},
"comments": {},
"cryptoWallet": {
"cryptoWalletType": "EXTERNAL"
},
"personalDetails": {},
"phone": [
{
"phone": "15557654321",
"smsVerified": {
"sent": true,
"verified": false
}
}
]
}
],
"deliveryDetails": {
"deliveryMethod": "USPS - Ground Mail",
"deliveryPrice": {},
"deliveryType": "PHYSICAL"
},
"itemReturnData": {
"posDetails": {
"address": {
"address1": "235 Montgomery st.",
"city": "San Francisco",
"country": "US",
"savedData": {
"usedSavedData": true
}
},
"cardEntryMethod": "SCANNED",
"cashierId": "fgh5e0rr48923d",
"departmentId": "e0r4592356fds",
"storeBusinessUnit": "Full Line",
"storeId": "2356fdse0rr489",
"storeName": "Union Square",
"workStationId": "923e5th5e0rr48"
},
"returnStatusLog": {}
},
"itemSpecificData": {
"accommodation": {
"accommodationAddress": {
"address1": "235 Montgomery st.",
"city": "San Francisco",
"country": "US",
"savedData": {
"usedSavedData": true
}
},
"duration": {
"endDate": "2014-11-15",
"startDate": "2014-10-28"
},
"location": {},
"numberOfGuests": 2,
"rating": [
{
"score": "4.5",
"source": "yelp",
"type": "INTERNAL_PEERS"
}
],
"type": "HOTEL"
},
"cryptocurrency": {},
"digitalGoodsAndServices": {
"duration": {
"endDate": "2014-11-15",
"startDate": "2014-10-28"
},
"webHosting": {
"domains": []
}
},
"food": {
"restaurantAddress": {
"address1": "235 Montgomery st.",
"city": "San Francisco",
"country": "US",
"savedData": {
"usedSavedData": true
}
},
"tipAmount": {}
},
"gaming": {
"gameItemAmount": 1000,
"gameName": "WorldOfSampleGamecrat"
},
"physicalGoods": {},
"professionalServices": {
"tipAmount": {}
},
"ticketsAndEvents": {
"eventLocation": {
"address1": "235 Montgomery st.",
"city": "San Francisco",
"country": "US",
"savedData": {
"usedSavedData": true
}
},
"eventName": "FIFA World Cup Final"
},
"transport": [
{
"driverDetails": {
"availableFundsForWithdrawal": {},
"ratingAsBuyer": {
"score": "4.5",
"source": "yelp",
"type": "INTERNAL_PEERS"
},
"ratingAsSeller": {
"score": "4.5",
"source": "yelp",
"type": "INTERNAL_PEERS"
},
"sellerAccountCreationDate": 1415273168,
"sellerLastLoginIP": {
"ip": "10.0.0.128",
"updateTimes": {}
},
"sellerPersonalDetails": {},
"sellerRegistrationIP": {
"ip": "10.0.0.128",
"updateTimes": {}
}
},
"duration": {
"startTime": 1412345911
},
"endPoint": {
"address": {
"address1": "235 Montgomery st.",
"city": "San Francisco",
"country": "US",
"savedData": {}
},
"exactLocation": {
"latitude": 32.07332,
"longitude": 34.79675,
"source": "MOBILE"
},
"locationName": {},
"roughLocation": {},
"savedLocation": {
"usedSavedData": true
}
},
"locationAtTimeOfReservation": {
"address": {
"address1": "235 Montgomery st.",
"city": "San Francisco",
"country": "US",
"savedData": {}
},
"exactLocation": {
"latitude": 32.07332,
"longitude": 34.79675,
"source": "MOBILE"
},
"locationName": {},
"roughLocation": {},
"savedLocation": {
"usedSavedData": true
}
},
"startPoint": {
"address": {
"address1": "235 Montgomery st.",
"city": "San Francisco",
"country": "US",
"savedData": {}
},
"exactLocation": {
"latitude": 32.07332,
"longitude": 34.79675,
"source": "MOBILE"
},
"locationName": {},
"roughLocation": {},
"savedLocation": {
"usedSavedData": true
}
},
"type": "AIR_TRAVEL"
}
]
},
"seller": {
"sellerDetails": {
"availableFundsForWithdrawal": {},
"ratingAsBuyer": {
"score": "4.5",
"source": "yelp",
"type": "INTERNAL_PEERS"
},
"ratingAsSeller": {
"score": "4.5",
"source": "yelp",
"type": "INTERNAL_PEERS"
},
"sellerAccountCreationDate": 1415273168,
"sellerLastLoginIP": {
"ip": "10.0.0.128",
"updateTimes": {
"creationTime": 1448549922
}
},
"sellerPersonalDetails": {},
"sellerRegistrationIP": {
"ip": "10.0.0.128",
"updateTimes": {
"creationTime": 1448549922
}
}
}
},
"shopifyAdditionalItemData": {
"properties": {}
}
}
],
"compensationStatus": {
"itemStatus": [
{
"basicItemData": {
"discount": {
"couponCodeUsed": "FATHERSDAY2015",
"couponDiscountAmount": {}
},
"name": "White GenericBrand handbag",
"price": {},
"quantity": 1,
"type": "TANGIBLE"
},
"statusData": {
"compensationTypeGranted": "REFUND",
"reasonCategory": "CHANGED_MY_MIND",
"returnMethodGranted": "SHIP_TO_WAREHOUSE",
"statusLog": {},
"updatedStatus": "ACCEPTED_BY_MERCHANT"
}
}
],
"merchantAgentData": {},
"shippingRefundedAmount": {},
"statusData": {
"compensationTypeGranted": "REFUND",
"reasonCategory": "CHANGED_MY_MIND",
"returnMethodGranted": "SHIP_TO_WAREHOUSE",
"statusLog": {},
"updatedStatus": "ACCEPTED_BY_MERCHANT"
},
"totalGrantedAmount": {}
},
"deliveryStatusInfo": {},
"endPointLocation": {
"address": {
"address1": "235 Montgomery st.",
"city": "San Francisco",
"country": "US",
"savedData": {
"usedSavedData": true
}
},
"exactLocation": {
"latitude": 32.07332,
"longitude": 34.79675,
"source": "MOBILE"
},
"locationName": {},
"roughLocation": {},
"savedLocation": {
"usedSavedData": true
}
},
"eventTime": 1415287568000,
"orderId": "2356fdse0rr489",
"refundInformation": {
"refundAmount": {}
},
"returnedCartItems": [
{
"basicItemData": {
"discount": {
"couponCodeUsed": "FATHERSDAY2015",
"couponDiscountAmount": {}
},
"name": "White GenericBrand handbag",
"price": {},
"quantity": 1,
"type": "TANGIBLE"
},
"beneficiaries": [
{
"additionalVerificationDocuments": {
"documentSource": "UPLOADED_FILE",
"documentType": "Passport",
"documentVerificationServiceResponsePayload": {}
},
"address": {
"address1": "235 Montgomery st.",
"city": "San Francisco",
"country": "US",
"savedData": {
"usedSavedData": true
}
},
"bankAccount": {
"paymentGatewayData": {}
},
"comments": {},
"cryptoWallet": {
"cryptoWalletType": "EXTERNAL"
},
"personalDetails": {},
"phone": [
{
"phone": "15557654321",
"smsVerified": {
"sent": true,
"verified": false
}
}
]
}
],
"deliveryDetails": {
"deliveryMethod": "USPS - Ground Mail",
"deliveryPrice": {},
"deliveryType": "PHYSICAL"
},
"itemReturnData": {
"posDetails": {
"address": {
"address1": "235 Montgomery st.",
"city": "San Francisco",
"country": "US",
"savedData": {
"usedSavedData": true
}
},
"cardEntryMethod": "SCANNED",
"cashierId": "fgh5e0rr48923d",
"departmentId": "e0r4592356fds",
"storeBusinessUnit": "Full Line",
"storeId": "2356fdse0rr489",
"storeName": "Union Square",
"workStationId": "923e5th5e0rr48"
},
"returnStatusLog": {}
},
"itemSpecificData": {
"accommodation": {
"accommodationAddress": {
"address1": "235 Montgomery st.",
"city": "San Francisco",
"country": "US",
"savedData": {
"usedSavedData": true
}
},
"duration": {
"endDate": "2014-11-15",
"startDate": "2014-10-28"
},
"location": {},
"numberOfGuests": 2,
"rating": [
{
"score": "4.5",
"source": "yelp",
"type": "INTERNAL_PEERS"
}
],
"type": "HOTEL"
},
"cryptocurrency": {},
"digitalGoodsAndServices": {
"duration": {
"endDate": "2014-11-15",
"startDate": "2014-10-28"
},
"webHosting": {
"domains": []
}
},
"food": {
"restaurantAddress": {
"address1": "235 Montgomery st.",
"city": "San Francisco",
"country": "US",
"savedData": {
"usedSavedData": true
}
},
"tipAmount": {}
},
"gaming": {
"gameItemAmount": 1000,
"gameName": "WorldOfSampleGamecrat"
},
"physicalGoods": {},
"professionalServices": {
"tipAmount": {}
},
"ticketsAndEvents": {
"eventLocation": {
"address1": "235 Montgomery st.",
"city": "San Francisco",
"country": "US",
"savedData": {
"usedSavedData": true
}
},
"eventName": "FIFA World Cup Final"
},
"transport": [
{
"driverDetails": {
"availableFundsForWithdrawal": {},
"ratingAsBuyer": {
"score": "4.5",
"source": "yelp",
"type": "INTERNAL_PEERS"
},
"ratingAsSeller": {
"score": "4.5",
"source": "yelp",
"type": "INTERNAL_PEERS"
},
"sellerAccountCreationDate": 1415273168,
"sellerLastLoginIP": {
"ip": "10.0.0.128",
"updateTimes": {}
},
"sellerPersonalDetails": {},
"sellerRegistrationIP": {
"ip": "10.0.0.128",
"updateTimes": {}
}
},
"duration": {
"startTime": 1412345911
},
"endPoint": {
"address": {
"address1": "235 Montgomery st.",
"city": "San Francisco",
"country": "US",
"savedData": {}
},
"exactLocation": {
"latitude": 32.07332,
"longitude": 34.79675,
"source": "MOBILE"
},
"locationName": {},
"roughLocation": {},
"savedLocation": {
"usedSavedData": true
}
},
"locationAtTimeOfReservation": {
"address": {
"address1": "235 Montgomery st.",
"city": "San Francisco",
"country": "US",
"savedData": {}
},
"exactLocation": {
"latitude": 32.07332,
"longitude": 34.79675,
"source": "MOBILE"
},
"locationName": {},
"roughLocation": {},
"savedLocation": {
"usedSavedData": true
}
},
"startPoint": {
"address": {
"address1": "235 Montgomery st.",
"city": "San Francisco",
"country": "US",
"savedData": {}
},
"exactLocation": {
"latitude": 32.07332,
"longitude": 34.79675,
"source": "MOBILE"
},
"locationName": {},
"roughLocation": {},
"savedLocation": {
"usedSavedData": true
}
},
"type": "AIR_TRAVEL"
}
]
},
"seller": {
"sellerDetails": {
"availableFundsForWithdrawal": {},
"ratingAsBuyer": {
"score": "4.5",
"source": "yelp",
"type": "INTERNAL_PEERS"
},
"ratingAsSeller": {
"score": "4.5",
"source": "yelp",
"type": "INTERNAL_PEERS"
},
"sellerAccountCreationDate": 1415273168,
"sellerLastLoginIP": {
"ip": "10.0.0.128",
"updateTimes": {
"creationTime": 1448549922
}
},
"sellerPersonalDetails": {},
"sellerRegistrationIP": {
"ip": "10.0.0.128",
"updateTimes": {
"creationTime": 1448549922
}
}
}
},
"shopifyAdditionalItemData": {
"properties": {}
}
}
],
"updatedStatus": "SENT",
"updatedTotalAmount": {},
"updatedTotalDiscount": {
"couponCodeUsed": "FATHERSDAY2015",
"couponDiscountAmount": {}
},
"verificationResults": {
"external3dsVendorPayload": {}
}
}'