# Retrieve Payment Session
This endpoint allows you to retrieve and view information and parameters related to a specific payment, using a session ID
Live
Sandbox
GET: https://api.openacquiring.com/v1/merchants/YOUR_MERCHANT_ID/payment/session/SESSION_ID
Request example
- Shell
- JavaScript
curl -X GET \
https://api.openacquiring.com/v1/merchants/w3z8dfhkzvfq0j9n/payment/session/9c22d208-4e25-47f8-8d32-c0e6d97c17c2 \
-H 'authorization: Basic ODZidWQ0Y2JremlxOXZmYzoweHI1ZDkwOHo2bmo4a2h6' \
-H 'content-type: application/json'
}
Response example
{
"id": "35ZQXK7H9YRD17JI6DNU",
"reference_id": "35ZQXK7H9YRD17JI6DNU",
"state": "authorised",
"result": {
"authorisation_code": "058607",
"risk_check": true,
"code": "0000"
},
"intent": "AUTH",
"payer": {
"payment_type": "CC",
"funding_instrument": {
"credit_card": {
"id": "9c22d208-4e25-47f8-8d32-c0e6d97c17c2",
"type": "Visa",
"expire_month": 12,
"expire_year": 2020,
"name": "Tom Hanks",
"cvv_check": "Y",
"avs_check": "S",
"last4": "4821",
"bin": "400552",
"bin_data": {
"bin": "400552",
"country_code": "MU",
"country_name": "Mauritius",
"bank_name": "MCB",
"card_scheme": "Visa",
"card_type": "Credit",
"card_category": "1"
}
}
},
"payer_info": {
"id": "0f053a05-9fa2-49a1-871f-3098e4b114e2",
"email": "TomHanks@gmail.com",
"name": "Tom Hanks",
"billing_address": {
"phone": {
"country_code": "230",
"number": "57976041"
},
"line1": "18 Avenue",
"line2": "cassidy",
"city": "Rose-Hill",
"country_code": "MU",
"postal_code": "72101",
"state": ""
}
}
},
"transaction": {
"amount": {
"currency": "USD",
"total": "300"
},
"type": "1",
"mode": "1",
"items": [
{
"sku": "100299S",
"name": "Ultrawatch",
"description": "Smart watch",
"quantity": "1",
"price": "500",
"shipping": "",
"url": ""
},
{
"sku": "100269S",
"name": "Drone",
"description": "drone x",
"quantity": "1",
"price": "500",
"shipping": "",
"url": ""
}
],
"shipping_address": {
"recipient_name": "Tom Hanks",
"phone": {}
},
"invoice_number": "123455"
},
"custom": {},
"delayed_capture_time": "2020-09-06T21:53:18Z",
"create_time": "2020-09-06T21:50:18Z",
"three_d": {}
}
# Request
# Header parameters
The request require a Basic authentication in the header. For more information about HTTP request headers, see HTTP request headers.
# Request parameters
| Parameter | Type | Description |
|---|---|---|
| merchant_id required | string | Encrypted Merchant account identifier for the Merchant |
| session_id required | guid | Session ID for a particular payment transction |
# Response
status 200
status 400
{
"id": "35ZQXK7H9YRD17JI6DNU",
"reference_id": "35ZQXK7H9YRD17JI6DNU",
"state": "authorised",
"result": {
"authorisation_code": "058607",
"risk_check": true,
"code": "0000"
},
"intent": "AUTH",
"payer": {
"payment_type": "CC",
"funding_instrument": {
"credit_card": {
"id": "9c22d208-4e25-47f8-8d32-c0e6d97c17c2",
"type": "Visa",
"expire_month": 12,
"expire_year": 2020,
"name": "Tom Hanks",
"cvv_check": "Y",
"avs_check": "S",
"last4": "4821",
"bin": "400552",
"bin_data": {
"bin": "400552",
"country_code": "MU",
"country_name": "Mauritius",
"bank_name": "MCB",
"card_scheme": "Visa",
"card_type": "Credit",
"card_category": "1"
}
}
},
"payer_info": {
"id": "0f053a05-9fa2-49a1-871f-3098e4b114e2",
"email": "TomHanks@gmail.com",
"name": "Tom Hanks",
"billing_address": {
"phone": {
"country_code": "230",
"number": "57976041"
},
"line1": "18 Avenue",
"line2": "cassidy",
"city": "Rose-Hill",
"country_code": "MU",
"postal_code": "72101",
"state": ""
}
}
},
"transaction": {
"amount": {
"currency": "USD",
"total": "300"
},
"type": "1",
"mode": "1",
"items": [
{
"sku": "100299S",
"name": "Ultrawatch",
"description": "Smart watch",
"quantity": "1",
"price": "500",
"shipping": "",
"url": ""
},
{
"sku": "100269S",
"name": "Drone",
"description": "drone x",
"quantity": "1",
"price": "500",
"shipping": "",
"url": ""
}
],
"shipping_address": {
"recipient_name": "Tom Hanks",
"phone": {}
},
"invoice_number": "123455"
},
"custom": {},
"delayed_capture_time": "2020-09-06T21:53:18Z",
"create_time": "2020-09-06T21:50:18Z",
"three_d": {}
}
# Response Body
# Status 200 Success
| Parameter | Type | Description | Value |
|---|---|---|---|
| id | string | Identifier of the payment resource created | |
| reference_id | string | In case of referenced payment (e.g., Capture or Refund), this fields included to see which payment was referenced | |
| state | string | The state of the payment, authorization, or order transaction | - Authorised. The transaction was successfully authorised.- Pending. The transaction is currently pending.- Captured. The transaction has been captured.- Refunded. The transaction has been refunded.- Declined. The transaction has been declined.- Expired. The transaction has been expired.- Cancelled. The transaction has been cancelled.- Voided. The transaction has been voided.- Timeout. The transaction has been timeout.- Deferred Refund. The transaction refund has been deferred.- Flagged. The transaction has been flagged.- Deferred Capture. The transaction Capture has been deferred.- Card Verified. The card has been verified. |
| result | object | Contain result of the payment request | |
| intent | string | The payment intent | - sale. Makes an immediate payment.- auth. Authorizes a payment for capture later |
| payer | object | Source of the funds for this payment represented by a direct credit card | |
| payee | object | A resource representing a Payee who receives the funds and fulfills the order | |
| transaction | object | Transactional details including the amount and item details | |
| custom | object | Free-form field for the use of clients | |
| create_time | datetime | Payment creation time as defined in RFC 3339 Section 5.6 | |
| three_d | object | ThreeD Secure details pertaining to the transaction | |
| delayed_capture_time | datetime | Payment capture time in case the capture is delayed. (as defined in RFC 3339 Section 5.6 | |
| metadata | ArrayOf( KeyValuePair(string, string)) | contains additional information about the transaction |
# Error Response Body
# Status 400 Bad Request
| Parameter | Type | Description |
|---|---|---|
| code | string | Code indentifying the error on our system |
| name | string | Name indentifying the error on our system |
| message | string | Message related to the error |
| eventId | string | Unique Identifier for the request |