POST Capture/Capture
Request Information
URI Parameters
None.
Body Parameters
CreateTransactionCaptureRequestName | Description | Type | Additional information |
---|---|---|---|
transaction_token | string |
None. |
|
amount | string |
None. |
|
description | string |
None. |
|
currency | string |
None. |
|
shipping_address | Address |
None. |
|
billing_address | Address |
None. |
|
client | Client |
None. |
|
customer_ip | string |
None. |
|
merchant_ip | string |
None. |
|
merchant_txn_ref | string |
None. |
|
items | Collection of Product |
None. |
Request Formats
application/json, text/json
Sample:
{ "transaction_token": "sample string 1", "amount": "sample string 2", "description": "sample string 3", "currency": "sample string 4", "shipping_address": { "Name": "sample string 2", "Address1": "sample string 3", "Address2": "sample string 4", "City": "sample string 5", "State": "sample string 6", "Postal_code": "sample string 7", "Country": "sample string 8", "Phone": "sample string 9", "Email": "sample string 10", "Fax": "sample string 11" }, "billing_address": { "Name": "sample string 2", "Address1": "sample string 3", "Address2": "sample string 4", "City": "sample string 5", "State": "sample string 6", "Postal_code": "sample string 7", "Country": "sample string 8", "Phone": "sample string 9", "Email": "sample string 10", "Fax": "sample string 11" }, "client": { "ID": "sample string 1", "Description": "sample string 2", "Email": "sample string 3", "Name": "sample string 4", "CreatedAt": "2024-05-17T13:42:23.1909615+09:00", "UpdatedAt": "2024-05-17T13:42:23.1909615+09:00" }, "customer_ip": "sample string 5", "merchant_ip": "sample string 6", "merchant_txn_ref": "sample string 7", "items": [ { "Name": "sample string 3", "Description": "sample string 4", "Amount": 5.0, "Quantity": 6, "Url": "sample string 7", "Image": "sample string 8", "sku": "sample string 9" }, { "Name": "sample string 3", "Description": "sample string 4", "Amount": 5.0, "Quantity": 6, "Url": "sample string 7", "Image": "sample string 8", "sku": "sample string 9" } ] }
text/html
Sample:
{"transaction_token":"sample string 1","amount":"sample string 2","description":"sample string 3","currency":"sample string 4","shipping_address":{"Name":"sample string 2","Address1":"sample string 3","Address2":"sample string 4","City":"sample string 5","State":"sample string 6","Postal_code":"sample string 7","Country":"sample string 8","Phone":"sample string 9","Email":"sample string 10","Fax":"sample string 11"},"billing_address":{"Name":"sample string 2","Address1":"sample string 3","Address2":"sample string 4","City":"sample string 5","State":"sample string 6","Postal_code":"sample string 7","Country":"sample string 8","Phone":"sample string 9","Email":"sample string 10","Fax":"sample string 11"},"client":{"ID":"sample string 1","Description":"sample string 2","Email":"sample string 3","Name":"sample string 4","CreatedAt":"2024-05-17T13:42:23.1909615+09:00","UpdatedAt":"2024-05-17T13:42:23.1909615+09:00"},"customer_ip":"sample string 5","merchant_ip":"sample string 6","merchant_txn_ref":"sample string 7","items":[{"Name":"sample string 3","Description":"sample string 4","Amount":5.0,"Quantity":6,"Url":"sample string 7","Image":"sample string 8","sku":"sample string 9"},{"Name":"sample string 3","Description":"sample string 4","Amount":5.0,"Quantity":6,"Url":"sample string 7","Image":"sample string 8","sku":"sample string 9"}]}
application/xml, text/xml
Sample:
<CreateTransactionCaptureRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Core.TransactionToken.Contracts"> <amount>sample string 2</amount> <billing_address xmlns:d2p1="http://schemas.datacontract.org/2004/07/Entities"> <d2p1:Address1>sample string 3</d2p1:Address1> <d2p1:Address2>sample string 4</d2p1:Address2> <d2p1:City>sample string 5</d2p1:City> <d2p1:Country>sample string 8</d2p1:Country> <d2p1:Email>sample string 10</d2p1:Email> <d2p1:Fax>sample string 11</d2p1:Fax> <d2p1:Name>sample string 2</d2p1:Name> <d2p1:Phone>sample string 9</d2p1:Phone> <d2p1:Postal_code>sample string 7</d2p1:Postal_code> <d2p1:State>sample string 6</d2p1:State> </billing_address> <client xmlns:d2p1="http://schemas.datacontract.org/2004/07/Entities"> <d2p1:CreatedAt>2024-05-17T13:42:23.1909615+09:00</d2p1:CreatedAt> <d2p1:Description>sample string 2</d2p1:Description> <d2p1:Email>sample string 3</d2p1:Email> <d2p1:ID>sample string 1</d2p1:ID> <d2p1:Name>sample string 4</d2p1:Name> <d2p1:UpdatedAt>2024-05-17T13:42:23.1909615+09:00</d2p1:UpdatedAt> </client> <currency>sample string 4</currency> <customer_ip>sample string 5</customer_ip> <description>sample string 3</description> <items xmlns:d2p1="http://schemas.datacontract.org/2004/07/Entities"> <d2p1:Product> <d2p1:Amount>5</d2p1:Amount> <d2p1:Description>sample string 4</d2p1:Description> <d2p1:Image>sample string 8</d2p1:Image> <d2p1:Name>sample string 3</d2p1:Name> <d2p1:Quantity>6</d2p1:Quantity> <d2p1:Url>sample string 7</d2p1:Url> <d2p1:sku>sample string 9</d2p1:sku> </d2p1:Product> <d2p1:Product> <d2p1:Amount>5</d2p1:Amount> <d2p1:Description>sample string 4</d2p1:Description> <d2p1:Image>sample string 8</d2p1:Image> <d2p1:Name>sample string 3</d2p1:Name> <d2p1:Quantity>6</d2p1:Quantity> <d2p1:Url>sample string 7</d2p1:Url> <d2p1:sku>sample string 9</d2p1:sku> </d2p1:Product> </items> <merchant_ip>sample string 6</merchant_ip> <merchant_txn_ref>sample string 7</merchant_txn_ref> <shipping_address xmlns:d2p1="http://schemas.datacontract.org/2004/07/Entities"> <d2p1:Address1>sample string 3</d2p1:Address1> <d2p1:Address2>sample string 4</d2p1:Address2> <d2p1:City>sample string 5</d2p1:City> <d2p1:Country>sample string 8</d2p1:Country> <d2p1:Email>sample string 10</d2p1:Email> <d2p1:Fax>sample string 11</d2p1:Fax> <d2p1:Name>sample string 2</d2p1:Name> <d2p1:Phone>sample string 9</d2p1:Phone> <d2p1:Postal_code>sample string 7</d2p1:Postal_code> <d2p1:State>sample string 6</d2p1:State> </shipping_address> <transaction_token>sample string 1</transaction_token> </CreateTransactionCaptureRequest>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
CreateTransactionResponseName | Description | Type | Additional information |
---|---|---|---|
transaction_token | string |
None. |
|
merchant_txn_ref | string |
None. |
|
action | string |
None. |
|
merchant_ip | string |
None. |
|
visit_ip | string |
None. |
|
created_at | date |
None. |
|
currency | string |
None. |
|
description | string |
None. |
|
auth_code | string |
None. |
|
cvc_check | string |
None. |
|
avs_check | string |
None. |
|
arn | string |
None. |
|
client | Client |
None. |
|
transaction | Transaction |
None. |
|
items | Collection of Product |
None. |
|
tracking | Tracking |
None. |
|
device | Device |
None. |
|
fraud_details | Fraud_Details |
None. |
|
url | URL |
None. |
|
failure_information | Collection of ErrorResponse |
None. |
|
response | Collection of APIResponse |
None. |
|
success | boolean |
None. |
Response Formats
application/json, text/json
Sample:
{ "transaction_token": "sample string 1", "merchant_txn_ref": "sample string 2", "action": "sample string 3", "merchant_ip": "sample string 4", "visit_ip": "sample string 5", "created_at": "2024-05-17T13:42:23.1909615+09:00", "currency": "sample string 7", "description": "sample string 8", "auth_code": "sample string 9", "cvc_check": "sample string 10", "avs_check": "sample string 11", "arn": "sample string 12", "client": { "ID": "sample string 1", "Description": "sample string 2", "Email": "sample string 3", "Name": "sample string 4", "CreatedAt": "2024-05-17T13:42:23.1909615+09:00", "UpdatedAt": "2024-05-17T13:42:23.1909615+09:00" }, "transaction": { "payment_token": "sample string 1", "amount": "sample string 2", "mode": "sample string 3", "brand": "sample string 4", "country": "sample string 5", "card": "sample string 6", "TransactionIdentifier": "sample string 7" }, "items": [ { "Name": "sample string 3", "Description": "sample string 4", "Amount": 5.0, "Quantity": 6, "Url": "sample string 7", "Image": "sample string 8", "sku": "sample string 9" }, { "Name": "sample string 3", "Description": "sample string 4", "Amount": 5.0, "Quantity": 6, "Url": "sample string 7", "Image": "sample string 8", "sku": "sample string 9" } ], "tracking": { "offer_url": "sample string 1", "referral": "sample string 2", "affiliate": { "name": "sample string 1", "Aff_Sub_ID_1": "sample string 2", "Aff_Sub_ID_2": "sample string 3", "Aff_Sub_ID_3": "sample string 4" }, "device": { "Device_type": "sample string 1", "Device_Brand": "sample string 2", "Device_OS": "sample string 3", "Browser": "sample string 4" } }, "device": { "Device_type": "sample string 1", "Device_Brand": "sample string 2", "Device_OS": "sample string 3", "Browser": "sample string 4" }, "fraud_details": { "risk1": "sample string 1" }, "url": { "refund": "sample string 1", "capture": "sample string 2" }, "failure_information": [ { "errorcode": "sample string 1", "errormessage": "sample string 2" }, { "errorcode": "sample string 1", "errormessage": "sample string 2" } ], "response": [ { "responsecode": "sample string 1", "responsemessage": "sample string 2" }, { "responsecode": "sample string 1", "responsemessage": "sample string 2" } ], "success": true }
text/html
Sample:
{"transaction_token":"sample string 1","merchant_txn_ref":"sample string 2","action":"sample string 3","merchant_ip":"sample string 4","visit_ip":"sample string 5","created_at":"2024-05-17T13:42:23.1909615+09:00","currency":"sample string 7","description":"sample string 8","auth_code":"sample string 9","cvc_check":"sample string 10","avs_check":"sample string 11","arn":"sample string 12","client":{"ID":"sample string 1","Description":"sample string 2","Email":"sample string 3","Name":"sample string 4","CreatedAt":"2024-05-17T13:42:23.1909615+09:00","UpdatedAt":"2024-05-17T13:42:23.1909615+09:00"},"transaction":{"payment_token":"sample string 1","amount":"sample string 2","mode":"sample string 3","brand":"sample string 4","country":"sample string 5","card":"sample string 6","TransactionIdentifier":"sample string 7"},"items":[{"Name":"sample string 3","Description":"sample string 4","Amount":5.0,"Quantity":6,"Url":"sample string 7","Image":"sample string 8","sku":"sample string 9"},{"Name":"sample string 3","Description":"sample string 4","Amount":5.0,"Quantity":6,"Url":"sample string 7","Image":"sample string 8","sku":"sample string 9"}],"tracking":{"offer_url":"sample string 1","referral":"sample string 2","affiliate":{"name":"sample string 1","Aff_Sub_ID_1":"sample string 2","Aff_Sub_ID_2":"sample string 3","Aff_Sub_ID_3":"sample string 4"},"device":{"Device_type":"sample string 1","Device_Brand":"sample string 2","Device_OS":"sample string 3","Browser":"sample string 4"}},"device":{"Device_type":"sample string 1","Device_Brand":"sample string 2","Device_OS":"sample string 3","Browser":"sample string 4"},"fraud_details":{"risk1":"sample string 1"},"url":{"refund":"sample string 1","capture":"sample string 2"},"failure_information":[{"errorcode":"sample string 1","errormessage":"sample string 2"},{"errorcode":"sample string 1","errormessage":"sample string 2"}],"response":[{"responsecode":"sample string 1","responsemessage":"sample string 2"},{"responsecode":"sample string 1","responsemessage":"sample string 2"}],"success":true}
application/xml, text/xml
Sample:
<CreateTransactionResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Core.TransactionToken.Contracts"> <failure_information xmlns="http://schemas.datacontract.org/2004/07/Core"> <ErrorResponse> <errorcode>sample string 1</errorcode> <errormessage>sample string 2</errormessage> </ErrorResponse> <ErrorResponse> <errorcode>sample string 1</errorcode> <errormessage>sample string 2</errormessage> </ErrorResponse> </failure_information> <response xmlns="http://schemas.datacontract.org/2004/07/Core"> <APIResponse> <responsecode>sample string 1</responsecode> <responsemessage>sample string 2</responsemessage> </APIResponse> <APIResponse> <responsecode>sample string 1</responsecode> <responsemessage>sample string 2</responsemessage> </APIResponse> </response> <success xmlns="http://schemas.datacontract.org/2004/07/Core">true</success> <action>sample string 3</action> <arn>sample string 12</arn> <auth_code>sample string 9</auth_code> <avs_check>sample string 11</avs_check> <client xmlns:d2p1="http://schemas.datacontract.org/2004/07/Entities"> <d2p1:CreatedAt>2024-05-17T13:42:23.1909615+09:00</d2p1:CreatedAt> <d2p1:Description>sample string 2</d2p1:Description> <d2p1:Email>sample string 3</d2p1:Email> <d2p1:ID>sample string 1</d2p1:ID> <d2p1:Name>sample string 4</d2p1:Name> <d2p1:UpdatedAt>2024-05-17T13:42:23.1909615+09:00</d2p1:UpdatedAt> </client> <created_at>2024-05-17T13:42:23.1909615+09:00</created_at> <currency>sample string 7</currency> <cvc_check>sample string 10</cvc_check> <description>sample string 8</description> <device xmlns:d2p1="http://schemas.datacontract.org/2004/07/ContractEntities"> <d2p1:Browser>sample string 4</d2p1:Browser> <d2p1:Device_Brand>sample string 2</d2p1:Device_Brand> <d2p1:Device_OS>sample string 3</d2p1:Device_OS> <d2p1:Device_type>sample string 1</d2p1:Device_type> </device> <fraud_details xmlns:d2p1="http://schemas.datacontract.org/2004/07/ContractEntities"> <d2p1:risk1>sample string 1</d2p1:risk1> </fraud_details> <items xmlns:d2p1="http://schemas.datacontract.org/2004/07/Entities"> <d2p1:Product> <d2p1:Amount>5</d2p1:Amount> <d2p1:Description>sample string 4</d2p1:Description> <d2p1:Image>sample string 8</d2p1:Image> <d2p1:Name>sample string 3</d2p1:Name> <d2p1:Quantity>6</d2p1:Quantity> <d2p1:Url>sample string 7</d2p1:Url> <d2p1:sku>sample string 9</d2p1:sku> </d2p1:Product> <d2p1:Product> <d2p1:Amount>5</d2p1:Amount> <d2p1:Description>sample string 4</d2p1:Description> <d2p1:Image>sample string 8</d2p1:Image> <d2p1:Name>sample string 3</d2p1:Name> <d2p1:Quantity>6</d2p1:Quantity> <d2p1:Url>sample string 7</d2p1:Url> <d2p1:sku>sample string 9</d2p1:sku> </d2p1:Product> </items> <merchant_ip>sample string 4</merchant_ip> <merchant_txn_ref>sample string 2</merchant_txn_ref> <tracking xmlns:d2p1="http://schemas.datacontract.org/2004/07/ContractEntities"> <d2p1:affiliate> <d2p1:Aff_Sub_ID_1>sample string 2</d2p1:Aff_Sub_ID_1> <d2p1:Aff_Sub_ID_2>sample string 3</d2p1:Aff_Sub_ID_2> <d2p1:Aff_Sub_ID_3>sample string 4</d2p1:Aff_Sub_ID_3> <d2p1:name>sample string 1</d2p1:name> </d2p1:affiliate> <d2p1:device> <d2p1:Browser>sample string 4</d2p1:Browser> <d2p1:Device_Brand>sample string 2</d2p1:Device_Brand> <d2p1:Device_OS>sample string 3</d2p1:Device_OS> <d2p1:Device_type>sample string 1</d2p1:Device_type> </d2p1:device> <d2p1:offer_url>sample string 1</d2p1:offer_url> <d2p1:referral>sample string 2</d2p1:referral> </tracking> <transaction xmlns:d2p1="http://schemas.datacontract.org/2004/07/ContractEntities"> <d2p1:TransactionIdentifier>sample string 7</d2p1:TransactionIdentifier> <d2p1:amount>sample string 2</d2p1:amount> <d2p1:brand>sample string 4</d2p1:brand> <d2p1:card>sample string 6</d2p1:card> <d2p1:country>sample string 5</d2p1:country> <d2p1:mode>sample string 3</d2p1:mode> <d2p1:payment_token>sample string 1</d2p1:payment_token> </transaction> <transaction_token>sample string 1</transaction_token> <url xmlns:d2p1="http://schemas.datacontract.org/2004/07/ContractEntities"> <d2p1:capture>sample string 2</d2p1:capture> <d2p1:refund>sample string 1</d2p1:refund> </url> <visit_ip>sample string 5</visit_ip> </CreateTransactionResponse>