Get payments for an order
curl --request GET \
--url https://server.twicecommerce.com/v1/admin/orders/{orderId}/payments \
--header 'X-API-KEY: <api-key>'import requests
url = "https://server.twicecommerce.com/v1/admin/orders/{orderId}/payments"
headers = {"X-API-KEY": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'X-API-KEY': '<api-key>'}};
fetch('https://server.twicecommerce.com/v1/admin/orders/{orderId}/payments', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://server.twicecommerce.com/v1/admin/orders/{orderId}/payments",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"X-API-KEY: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://server.twicecommerce.com/v1/admin/orders/{orderId}/payments"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("X-API-KEY", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://server.twicecommerce.com/v1/admin/orders/{orderId}/payments")
.header("X-API-KEY", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://server.twicecommerce.com/v1/admin/orders/{orderId}/payments")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["X-API-KEY"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"id": "<string>",
"type": "sale",
"status": "pending",
"pricing": {
"currency": "<string>",
"total": 0,
"subtotal": 0,
"totalTaxes": 0,
"totalDiscounts": 0,
"taxExcluded": true,
"taxLines": [
{
"price": 0,
"rate": 123,
"combinedLabel": {
"def": "<string>"
},
"label": {
"def": "<string>"
},
"taxableAmount": 0
}
],
"listPrice": 0,
"originalListPrice": 0,
"additionalInfo": "<string>",
"discountCodes": {},
"manualDiscount": 0,
"deposit": 0
},
"receiptNumber": 123,
"issuedAt": "<string>",
"lines": {
"id": "<string>",
"paymentId": "<string>",
"type": "line_item",
"name": "<string>",
"quantity": 123,
"pricing": {
"currency": "<string>",
"total": 0,
"subtotal": 0,
"totalTaxes": 0,
"totalDiscounts": 0,
"taxExcluded": true,
"taxLines": [
{
"price": 0,
"rate": 123,
"combinedLabel": {
"def": "<string>"
},
"label": {
"def": "<string>"
},
"taxableAmount": 0
}
],
"listPrice": 0,
"originalListPrice": 0,
"additionalInfo": "<string>",
"discountCodes": {},
"manualDiscount": 0,
"deposit": 0
},
"createdAt": "<string>",
"updatedAt": "<string>",
"modificationSummary": {
"refundedTotal": 123,
"refundReversedTotal": 123,
"cancelledTotal": 123,
"expiredTotal": 123,
"capturedTotal": 123,
"isFullyRefunded": true,
"isPartiallyRefunded": true,
"pendingRefundsTotal": 123,
"pendingCapturesTotal": 123,
"isCancelled": true,
"isReversed": true,
"isExpired": true
},
"orderLineItemId": "<string>",
"invoiceId": "<string>",
"invoiceLineId": "<string>",
"meta": "<unknown>"
},
"transactions": {
"id": "<string>",
"paymentId": "<string>",
"type": "authorize",
"status": "pending",
"method": "<string>",
"provider": "<string>",
"currency": "<string>",
"total": 123,
"occurredAt": "<string>",
"modificationSummary": {
"refundedTotal": 123,
"refundReversedTotal": 123,
"cancelledTotal": 123,
"expiredTotal": 123,
"capturedTotal": 123,
"isFullyRefunded": true,
"isPartiallyRefunded": true,
"pendingRefundsTotal": 123,
"pendingCapturesTotal": 123,
"isCancelled": true,
"isReversed": true,
"isExpired": true
},
"createdAt": "<string>",
"updatedAt": "<string>",
"originalTransactionId": "<string>",
"customMethodId": "<string>",
"providerReferenceId": "<string>",
"providerResponse": "<unknown>",
"cardBrand": "<string>",
"cardLast4": "<string>",
"meta": "<unknown>"
},
"modificationSummary": {
"refundedTotal": 123,
"refundReversedTotal": 123,
"cancelledTotal": 123,
"expiredTotal": 123,
"capturedTotal": 123,
"isFullyRefunded": true,
"isPartiallyRefunded": true,
"pendingRefundsTotal": 123,
"pendingCapturesTotal": 123,
"isCancelled": true,
"isReversed": true,
"isExpired": true
},
"createdAt": "<string>",
"updatedAt": "<string>",
"orderId": "<string>",
"originalPaymentId": "<string>",
"meta": "<unknown>",
"tenantInfo": {
"name": "<string>",
"legalName": "<string>",
"businessId": "<string>",
"address": "<string>",
"phone": "<string>"
}
}Lists the payment transactions recorded for the order: captures, refunds, deposit holds, gateway and manual payments. Money movement itself happens via the transaction endpoints.
GET
/
v1
/
admin
/
orders
/
{orderId}
/
payments
Get payments for an order
curl --request GET \
--url https://server.twicecommerce.com/v1/admin/orders/{orderId}/payments \
--header 'X-API-KEY: <api-key>'import requests
url = "https://server.twicecommerce.com/v1/admin/orders/{orderId}/payments"
headers = {"X-API-KEY": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'X-API-KEY': '<api-key>'}};
fetch('https://server.twicecommerce.com/v1/admin/orders/{orderId}/payments', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://server.twicecommerce.com/v1/admin/orders/{orderId}/payments",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"X-API-KEY: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://server.twicecommerce.com/v1/admin/orders/{orderId}/payments"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("X-API-KEY", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://server.twicecommerce.com/v1/admin/orders/{orderId}/payments")
.header("X-API-KEY", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://server.twicecommerce.com/v1/admin/orders/{orderId}/payments")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["X-API-KEY"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"id": "<string>",
"type": "sale",
"status": "pending",
"pricing": {
"currency": "<string>",
"total": 0,
"subtotal": 0,
"totalTaxes": 0,
"totalDiscounts": 0,
"taxExcluded": true,
"taxLines": [
{
"price": 0,
"rate": 123,
"combinedLabel": {
"def": "<string>"
},
"label": {
"def": "<string>"
},
"taxableAmount": 0
}
],
"listPrice": 0,
"originalListPrice": 0,
"additionalInfo": "<string>",
"discountCodes": {},
"manualDiscount": 0,
"deposit": 0
},
"receiptNumber": 123,
"issuedAt": "<string>",
"lines": {
"id": "<string>",
"paymentId": "<string>",
"type": "line_item",
"name": "<string>",
"quantity": 123,
"pricing": {
"currency": "<string>",
"total": 0,
"subtotal": 0,
"totalTaxes": 0,
"totalDiscounts": 0,
"taxExcluded": true,
"taxLines": [
{
"price": 0,
"rate": 123,
"combinedLabel": {
"def": "<string>"
},
"label": {
"def": "<string>"
},
"taxableAmount": 0
}
],
"listPrice": 0,
"originalListPrice": 0,
"additionalInfo": "<string>",
"discountCodes": {},
"manualDiscount": 0,
"deposit": 0
},
"createdAt": "<string>",
"updatedAt": "<string>",
"modificationSummary": {
"refundedTotal": 123,
"refundReversedTotal": 123,
"cancelledTotal": 123,
"expiredTotal": 123,
"capturedTotal": 123,
"isFullyRefunded": true,
"isPartiallyRefunded": true,
"pendingRefundsTotal": 123,
"pendingCapturesTotal": 123,
"isCancelled": true,
"isReversed": true,
"isExpired": true
},
"orderLineItemId": "<string>",
"invoiceId": "<string>",
"invoiceLineId": "<string>",
"meta": "<unknown>"
},
"transactions": {
"id": "<string>",
"paymentId": "<string>",
"type": "authorize",
"status": "pending",
"method": "<string>",
"provider": "<string>",
"currency": "<string>",
"total": 123,
"occurredAt": "<string>",
"modificationSummary": {
"refundedTotal": 123,
"refundReversedTotal": 123,
"cancelledTotal": 123,
"expiredTotal": 123,
"capturedTotal": 123,
"isFullyRefunded": true,
"isPartiallyRefunded": true,
"pendingRefundsTotal": 123,
"pendingCapturesTotal": 123,
"isCancelled": true,
"isReversed": true,
"isExpired": true
},
"createdAt": "<string>",
"updatedAt": "<string>",
"originalTransactionId": "<string>",
"customMethodId": "<string>",
"providerReferenceId": "<string>",
"providerResponse": "<unknown>",
"cardBrand": "<string>",
"cardLast4": "<string>",
"meta": "<unknown>"
},
"modificationSummary": {
"refundedTotal": 123,
"refundReversedTotal": 123,
"cancelledTotal": 123,
"expiredTotal": 123,
"capturedTotal": 123,
"isFullyRefunded": true,
"isPartiallyRefunded": true,
"pendingRefundsTotal": 123,
"pendingCapturesTotal": 123,
"isCancelled": true,
"isReversed": true,
"isExpired": true
},
"createdAt": "<string>",
"updatedAt": "<string>",
"orderId": "<string>",
"originalPaymentId": "<string>",
"meta": "<unknown>",
"tenantInfo": {
"name": "<string>",
"legalName": "<string>",
"businessId": "<string>",
"address": "<string>",
"phone": "<string>"
}
}Authorizations
API key for the Twice API
Path Parameters
Pattern:
^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$Response
200
Available options:
sale, deposit_auth, deposit_capture, refund, refund_reverse, cancel, expire Available options:
pending, succeeded, failed, voided Hide child attributes
Hide child attributes
Required range:
-9007199254740991 <= x <= 9007199254740991Required range:
-9007199254740991 <= x <= 9007199254740991Required range:
-9007199254740991 <= x <= 9007199254740991Required range:
-9007199254740991 <= x <= 9007199254740991Hide child attributes
Hide child attributes
Required range:
-9007199254740991 <= x <= 9007199254740991Required range:
-9007199254740991 <= x <= 9007199254740991Required range:
-9007199254740991 <= x <= 9007199254740991Required range:
-9007199254740991 <= x <= 9007199254740991Hide child attributes
Hide child attributes
Hide child attributes
Hide child attributes
Required range:
-9007199254740991 <= x <= 9007199254740991Required range:
-9007199254740991 <= x <= 9007199254740991Hide child attributes
Hide child attributes
Available options:
line_item, shipping, deposit, fee, rounding Hide child attributes
Hide child attributes
Required range:
-9007199254740991 <= x <= 9007199254740991Required range:
-9007199254740991 <= x <= 9007199254740991Required range:
-9007199254740991 <= x <= 9007199254740991Required range:
-9007199254740991 <= x <= 9007199254740991Hide child attributes
Hide child attributes
Required range:
-9007199254740991 <= x <= 9007199254740991Required range:
-9007199254740991 <= x <= 9007199254740991Required range:
-9007199254740991 <= x <= 9007199254740991Required range:
-9007199254740991 <= x <= 9007199254740991Hide child attributes
Hide child attributes
Hide child attributes
Hide child attributes
Required range:
-9007199254740991 <= x <= 9007199254740991Required range:
-9007199254740991 <= x <= 9007199254740991Hide child attributes
Hide child attributes
Hide child attributes
Hide child attributes
Available options:
authorize, capture, refund, refund_reverse, cancel, expire Available options:
pending, succeeded, failed Hide child attributes
Hide child attributes
Hide child attributes
Hide child attributes
Was this page helpful?