Get settlement by ID

GET 
https://api.publicsquare.com/settlements/:id

Get a settlement by ID in the Account.

Permissions

• settlement:read

Request

Path Parameters

id stringrequired

Responses

200

OK

application/json

Schema

Schema

idstringnullable
Settlement ID
Example: stl_BGDLZjBLAgNbyqCzJxchSoh5k
account_idstringnullable
Account ID
Example: acc_B518niGwGYKzig6vtrRVZGGGV
environmentstringnullable
Environment - Can be test or production
Example: production
transaction_idstringnullable
Transaction ID
Example: trx_95rvMJvAVeG68W4NtLdfkN3LG
payment_amountint64
Total payment amount of the settlement in cents. 1000 is $10.00
Example: 1500
payment_countint32
Total number of payments in the settlement
Example: 3
refund_amountint64
Total refund amount of the settlement in cents. 1000 is $10.00
Example: 500
refund_countint32
Total number of refunds in the settlement
Example: 1
total_countint64
Total number of transactions in the settlement
Example: 4
amountint64
Total amount of the settlement in cents. 1000 is $10.00
Example: 1000
currencystringnullable
3 character ISO currency code
Example: USD
settled_atdate-time
Date of the Settlement
Example: 2024-06-30T00:00:00.000Z
transaction object
idstringnullable
Transaction ID
Example: trx_95rvMJvAVeG68W4NtLdfkN3LG
account_idstringnullable
Account ID
Example: acc_B518niGwGYKzig6vtrRVZGGGV
environmentstringnullable
Environment - Can be test or production
Example: production
external_idstringnullable
Payment or Refund ID in merchant's system
Example: e797ef3c-b586-4333-af90-7168d8427d85
statusstringnullable
Transaction status
Example: successful
amountint64
Amount of the transaction in cents. 1000 is $10.00
Example: 10000
fee_amountint64nullable
Fee of the transaction in cents
Example: 360
net_amountint64
Net amount of the transaction in cents
Example: 9640
currencystringnullable
3 character ISO currency code
Example: USD
type_idstringnullable
ID of the transaction type
Example: pmt_2YKewBonG4tgk12MheY3PiHDy
typestringnullable
Type of the transaction
Example: payment
settlement_idstringnullable
ID of the settlement if the transaction has been settled
Example: stl_BGDLZjBLAgNbyqCzJxchSoh5k
processorstringnullable
Payment processor that processed the transaction
Example: nuvei
processor_idstringnullable
Payment processor transaction ID
Example: 7110000000010554769
acquirer_idstringnullable
Payment acquirer transaction ID
Example: 2630000240513800
payment object
idstringnullable
Payment ID
Example: pmt_2YKewBonG4tgk12MheY3PiHDy
account_idstringnullable
Account ID
Example: acc_B518niGwGYKzig6vtrRVZGGGV
environmentstringnullable
Environment - Can be test or production
Example: production
external_idstringnullable
Payment ID in merchant's system
Example: e797ef3c-b586-4333-af90-7168d8427d85
statusstringnullable
Payment status
Example: successful
declined_reasonstringnullable
Decline reason
Example: Card lost/stolen
transaction_idstringnullable
Transaction ID
Example: trx_95rvMJvAVeG68W4NtLdfkN3LG
amountint64
Current amount of the payment in cents
Example: 9500
amount_capturableint64
Amount that is capturable by payment in cents. Will be the amount authorized for capture
Example: 10000
amount_chargedint64
Amount of the payment charged in cents. Will be 0 if the payment requires capture
Example: 10000
amount_refundedint64
Amount refunded of the payment in cents
Example: 500
refundedboolean
Flag if payment has been fully refunded
Example: false
currencystringnullable
3 character ISO currency code
Example: USD
payment_method object
card object
idstringnullable
Payment Method ID
Example: card_8PajTnDVrviEJ8zYJDALFQm5t
cardholder_namestringnullable
Cardholder name
Example: John Smith
last4stringnullable
Last 4 digits of the card
Example: 4242
exp_monthstringnullable
Card expiration month
Example: 12
exp_yearstringnullable
Card expiration year
Example: 2025
fingerprintstringnullable
Fingerprint of the card to identify uniqueness
Example: CC2XvyoohnqecEq4r3FtXv6MdCx4TbaW1UUTdCCN5MNL
brandstringnullable
Card brand
Example: visa
avs_codestringnullable
AVS code
Example: Y
cvv2_replystringnullable
CVV2 reply
Example: M
bank_account object
idstringnullable
Payment Method ID
Example: ba_7Ay5mcUXAxwrN6wQEQUVEHBCJ
account_holder_namestringnullable
Account Holder Name
Example: John Doe
account_holder_typestringnullable
AccountHolderType - Can be individual or company
Example: individual
account_typestringnullable
AccountType - Can be checking or savings
Example: individual
routing_numberstringnullable
Routing Number
Example: 123456789
account_number_last4stringnullable
Last 4 digits of the account number
Example: 1011
account_balance object
account_idstringnullable
Account ID
Example: acc_B518niGwGYKzig6vtrRVZGGGV
account_namestringnullable
Account Name
Example: Test Company, LLC
customer object
idstringnullable
Customer ID
Example: cus_7Ay5mcUXAxwrN6wQEQUVEHBCJ
external_idstringnullable
Customer ID in merchant's system
Example: e797ef3c-b586-4333-af90-7168d8427d85
business_namestringnullable
Name of the business if business customer type
Example: Awesome Company, LLC
first_namestringnullable
First name of the person if person customer type
Example: John
last_namestringnullable
Last name of the person if person customer type
Example: Smith
government_identifier_last4stringnullable
Last 4 of the SSN or EIN
Example: 9642
emailstringnullable
Email address
Example: john.smith@email.com
phonestringnullable
Phone number
Example: +15554829347
billing_details object
address_line_1stringrequired
Street name
Possible values: non-empty and <= 250 characters
Example: 111 Colorado Ave.
address_line_2stringnullable
Apt, Suite or PO Box
Possible values: <= 250 characters
Example: Apt 403
citystringrequired
City
Possible values: non-empty and <= 100 characters
Example: Des Moines
statestringrequired
2 or 3 character ISO state code
Possible values: >= 2 characters and <= 3 characters
Example: IA
postal_codestringrequired
Postal or zip code
Possible values: non-empty and <= 30 characters
Example: 51111
countrystringrequired
2 character ISO country code
Possible values: non-empty and <= 2 characters
Example: US
shipping_address object
address_line_1stringrequired
Street name
Possible values: non-empty and <= 250 characters
Example: 111 Colorado Ave.
address_line_2stringnullable
Apt, Suite or PO Box
Possible values: <= 250 characters
Example: Apt 403
citystringrequired
City
Possible values: non-empty and <= 100 characters
Example: Des Moines
statestringrequired
2 or 3 character ISO state code
Possible values: >= 2 characters and <= 3 characters
Example: IA
postal_codestringrequired
Postal or zip code
Possible values: non-empty and <= 30 characters
Example: 51111
countrystringrequired
2 character ISO country code
Possible values: non-empty and <= 2 characters
Example: US
fraud_details object
decisionstringnullable
Fraud decision for the payment. Values can be accept, reject, or review
Example: accept
rules object[]nullable
Triggered fraud rules
Array [
rule_enginestringnullable
Rule engine name
Example: nuvei
rule_idstringnullable
Rule Id
Example: 1287
rule_descriptionstringnullable
Description
Example: Stolen card
]
transaction
dynamic_descriptor object
merchant_namestringnullable
Merchant name
Example: Test Corporation
merchant_contactstringnullable
Merchant contact information
Example: +15552604982
transfers object[]nullable
Transfers
Array [
idstringnullable
Transfer ID
Example: trnf_7yFLQWACr3DYDSz1xpoEAVfdq
account_idstringnullable
Account ID
Example: acc_B518niGwGYKzig6vtrRVZGGGV
environmentstringnullable
Environment - Can be test or production
Example: production
external_idstringnullable
Transfer ID in merchant's system
Example: e797ef3c-b586-4333-af90-7168d8427d85
typestringnullable
Transfer type
Example: payment
statusstringnullable
Transfer status
Example: successful
payment_transfer_idstringnullable
Transfer ID for the payment transfer
Example: trnf_7yFLQWACr3DYDSz1xpoEAVfdq
payment_idstringnullable
Payment ID
Example: pmt_2YKewBonG4tgk12MheY3PiHDy
refund_idstringnullable
Refund ID if associated with a refund
Example: rfd_2YKewBonG4tgk12MheY3PiHDy
transaction_idstringnullable
Transaction ID
Example: trx_95rvMJvAVeG68W4NtLdfkN3LG
seller_account_idstringnullable
Seller Account ID
Example: acc_8ooQs32UCdriBvrHnVWbTmJbY
amountint64
Amount of the transfer in cents
Example: 10000
transfer_feeint64nullable
Transfer fee in cents. 1000 is $10.00
Example: 100
currencystringnullable
3 character ISO currency code
Example: USD
transaction
created_atdate-timenullable
Date payment was created
Example: 2024-06-30T01:02:29.212Z
modified_atdate-timenullable
Date payment was modified
Example: 2024-06-30T01:02:29.212Z
]
device_information object
browser_familystringnullable
Browser information
Example: Mobile Safari
os_familystringnullable
Operating system information
Example: iOS
device_familystringnullable
Device information
Example: iPhone
ip_addressstringrequired
IP address of the customer
Possible values: non-empty and <= 40 characters
Example: 192.168.1.1
user_agentstringnullable
Customer user agent
Possible values: <= 500 characters
Example: Mozilla/5.0 (iPhone; CPU iPhone OS 5_1_1 like Mac OS X) AppleWebKit/534.46 (KHTML, like Gecko) Version/5.1 Mobile/9B206 Safari/7534.48.3
created_atdate-timenullable
Date payment was created
Example: 2024-06-30T01:02:29.212Z
modified_atdate-timenullable
Date payment was modified
Example: 2024-06-30T01:02:29.212Z
payout object
idstringnullable
Payout ID
Example: pyt_24NFPd3jSZFTxiaH9UwjuqNdP
account_idstringnullable
Account ID
Example: acc_B518niGwGYKzig6vtrRVZGGGV
environmentstringnullable
Environment - Can be test or production
Example: production
external_idstringnullable
Payout ID in merchant's system
Example: 1268ce56-a4b5-43fa-8526-a500fc2140bb
statusstringnullable
Payout status
Example: successful
declined_reasonstringnullable
Decline reason
Example: Card lost/stolen
transaction_idstringnullable
Transaction ID
Example: trx_6QgmXzQzk3S5K5EsR3DfEiMRj
amountint64
Amount of the payout in cents
Example: 9500
currencystringnullable
3 character ISO currency code
Example: USD
payment_method object
card object
idstringnullable
Payment Method ID
Example: card_8PajTnDVrviEJ8zYJDALFQm5t
cardholder_namestringnullable
Cardholder name
Example: John Smith
last4stringnullable
Last 4 digits of the card
Example: 4242
exp_monthstringnullable
Card expiration month
Example: 12
exp_yearstringnullable
Card expiration year
Example: 2025
fingerprintstringnullable
Fingerprint of the card to identify uniqueness
Example: CC2XvyoohnqecEq4r3FtXv6MdCx4TbaW1UUTdCCN5MNL
brandstringnullable
Card brand
Example: visa
avs_codestringnullable
AVS code
Example: Y
cvv2_replystringnullable
CVV2 reply
Example: M
bank_account object
idstringnullable
Payment Method ID
Example: ba_7Ay5mcUXAxwrN6wQEQUVEHBCJ
account_holder_namestringnullable
Account Holder Name
Example: John Doe
account_holder_typestringnullable
AccountHolderType - Can be individual or company
Example: individual
account_typestringnullable
AccountType - Can be checking or savings
Example: individual
routing_numberstringnullable
Routing Number
Example: 123456789
account_number_last4stringnullable
Last 4 digits of the account number
Example: 1011
account_balance object
account_idstringnullable
Account ID
Example: acc_B518niGwGYKzig6vtrRVZGGGV
account_namestringnullable
Account Name
Example: Test Company, LLC
customer object
idstringnullable
Customer ID
Example: cus_7Ay5mcUXAxwrN6wQEQUVEHBCJ
external_idstringnullable
Customer ID in merchant's system
Example: e797ef3c-b586-4333-af90-7168d8427d85
business_namestringnullable
Name of the business if business customer type
Example: Awesome Company, LLC
first_namestringnullable
First name of the person if person customer type
Example: John
last_namestringnullable
Last name of the person if person customer type
Example: Smith
government_identifier_last4stringnullable
Last 4 of the SSN or EIN
Example: 9642
emailstringnullable
Email address
Example: john.smith@email.com
phonestringnullable
Phone number
Example: +15554829347
billing_details object
address_line_1stringrequired
Street name
Possible values: non-empty and <= 250 characters
Example: 111 Colorado Ave.
address_line_2stringnullable
Apt, Suite or PO Box
Possible values: <= 250 characters
Example: Apt 403
citystringrequired
City
Possible values: non-empty and <= 100 characters
Example: Des Moines
statestringrequired
2 or 3 character ISO state code
Possible values: >= 2 characters and <= 3 characters
Example: IA
postal_codestringrequired
Postal or zip code
Possible values: non-empty and <= 30 characters
Example: 51111
countrystringrequired
2 character ISO country code
Possible values: non-empty and <= 2 characters
Example: US
transaction
dynamic_descriptor object
merchant_namestringnullable
Merchant name
Example: Test Corporation
merchant_contactstringnullable
Merchant contact information
Example: +15552604982
device_information object
browser_familystringnullable
Browser information
Example: Mobile Safari
os_familystringnullable
Operating system information
Example: iOS
device_familystringnullable
Device information
Example: iPhone
ip_addressstringrequired
IP address of the customer
Possible values: non-empty and <= 40 characters
Example: 192.168.1.1
user_agentstringnullable
Customer user agent
Possible values: <= 500 characters
Example: Mozilla/5.0 (iPhone; CPU iPhone OS 5_1_1 like Mac OS X) AppleWebKit/534.46 (KHTML, like Gecko) Version/5.1 Mobile/9B206 Safari/7534.48.3
created_atdate-timenullable
Date payment was created
Example: 2024-06-30T01:02:29.212Z
modified_atdate-timenullable
Date payment was modified
Example: 2024-06-30T01:02:29.212Z
refund object
idstringnullable
Refund ID
Example: rfd_2YKewBonG4tgk12MheY3PiHDy
account_idstringnullable
Account ID
Example: acc_B518niGwGYKzig6vtrRVZGGGV
environmentstringnullable
Environment - Can be test or production
Example: production
external_idstringnullable
Refund ID in merchant's system
Example: e797ef3c-b586-4333-af90-7168d8427d85
statusstringnullable
Refund status
Example: successful
transaction_idstringnullable
Transaction ID
Example: trx_95rvMJvAVeG68W4NtLdfkN3LG
payment_idstringnullable
Payment ID
Example: pmt_2YKewBonG4tgk12MheY3PiHDy
amountint64
Amount of the refund in cents. 1000 is $10.00
Example: 500
currencystringnullable
3 character ISO currency code
Example: USD
reasonstringnullable
Reason for the refund
Example: Refunding shipping
declined_reasonstringnullable
Decline reason
Example: Suspected fraud
transaction
transfers object[]nullable
Transfers
Array [
idstringnullable
Transfer ID
Example: trnf_7yFLQWACr3DYDSz1xpoEAVfdq
account_idstringnullable
Account ID
Example: acc_B518niGwGYKzig6vtrRVZGGGV
environmentstringnullable
Environment - Can be test or production
Example: production
external_idstringnullable
Transfer ID in merchant's system
Example: e797ef3c-b586-4333-af90-7168d8427d85
typestringnullable
Transfer type
Example: payment
statusstringnullable
Transfer status
Example: successful
payment_transfer_idstringnullable
Transfer ID for the payment transfer
Example: trnf_7yFLQWACr3DYDSz1xpoEAVfdq
payment_idstringnullable
Payment ID
Example: pmt_2YKewBonG4tgk12MheY3PiHDy
refund_idstringnullable
Refund ID if associated with a refund
Example: rfd_2YKewBonG4tgk12MheY3PiHDy
transaction_idstringnullable
Transaction ID
Example: trx_95rvMJvAVeG68W4NtLdfkN3LG
seller_account_idstringnullable
Seller Account ID
Example: acc_8ooQs32UCdriBvrHnVWbTmJbY
amountint64
Amount of the transfer in cents
Example: 10000
transfer_feeint64nullable
Transfer fee in cents. 1000 is $10.00
Example: 100
currencystringnullable
3 character ISO currency code
Example: USD
transaction
created_atdate-timenullable
Date payment was created
Example: 2024-06-30T01:02:29.212Z
modified_atdate-timenullable
Date payment was modified
Example: 2024-06-30T01:02:29.212Z
]
device_information object
browser_familystringnullable
Browser information
Example: Mobile Safari
os_familystringnullable
Operating system information
Example: iOS
device_familystringnullable
Device information
Example: iPhone
ip_addressstringrequired
IP address of the customer
Possible values: non-empty and <= 40 characters
Example: 192.168.1.1
user_agentstringnullable
Customer user agent
Possible values: <= 500 characters
Example: Mozilla/5.0 (iPhone; CPU iPhone OS 5_1_1 like Mac OS X) AppleWebKit/534.46 (KHTML, like Gecko) Version/5.1 Mobile/9B206 Safari/7534.48.3
created_atdate-timenullable
Date refund was created
Example: 2024-06-30T01:02:29.212Z
modified_atdate-timenullable
Date refund was modified
Example: 2024-06-30T01:02:29.212Z
settlement
transfer object
idstringnullable
Transfer ID
Example: trnf_7yFLQWACr3DYDSz1xpoEAVfdq
account_idstringnullable
Account ID
Example: acc_B518niGwGYKzig6vtrRVZGGGV
environmentstringnullable
Environment - Can be test or production
Example: production
external_idstringnullable
Transfer ID in merchant's system
Example: e797ef3c-b586-4333-af90-7168d8427d85
typestringnullable
Transfer type
Example: payment
statusstringnullable
Transfer status
Example: successful
payment_transfer_idstringnullable
Transfer ID for the payment transfer
Example: trnf_7yFLQWACr3DYDSz1xpoEAVfdq
payment_idstringnullable
Payment ID
Example: pmt_2YKewBonG4tgk12MheY3PiHDy
refund_idstringnullable
Refund ID if associated with a refund
Example: rfd_2YKewBonG4tgk12MheY3PiHDy
transaction_idstringnullable
Transaction ID
Example: trx_95rvMJvAVeG68W4NtLdfkN3LG
seller_account_idstringnullable
Seller Account ID
Example: acc_8ooQs32UCdriBvrHnVWbTmJbY
amountint64
Amount of the transfer in cents
Example: 10000
transfer_feeint64nullable
Transfer fee in cents. 1000 is $10.00
Example: 100
currencystringnullable
3 character ISO currency code
Example: USD
transaction
created_atdate-timenullable
Date payment was created
Example: 2024-06-30T01:02:29.212Z
modified_atdate-timenullable
Date payment was modified
Example: 2024-06-30T01:02:29.212Z
created_atdate-timenullable
Date transaction was created
Example: 2024-06-30T01:02:29.212Z
modified_atdate-timenullable
Date transaction was modified
Example: 2024-06-30T01:02:29.212Z
created_atdate-timenullable
Date settlement was created
Example: 2024-06-30T01:02:29.212Z
modified_atdate-timenullable
Date settlement was modified
Example: 2024-06-30T01:02:29.212Z

Example (auto)

{
  "id": "stl_BGDLZjBLAgNbyqCzJxchSoh5k",
  "account_id": "acc_B518niGwGYKzig6vtrRVZGGGV",
  "environment": "production",
  "transaction_id": "trx_95rvMJvAVeG68W4NtLdfkN3LG",
  "payment_amount": 1500,
  "payment_count": 3,
  "refund_amount": 500,
  "refund_count": 1,
  "total_count": 4,
  "amount": 1000,
  "currency": "USD",
  "settled_at": "2024-06-30T00:00:00.000Z",
  "transaction": {
    "id": "trx_95rvMJvAVeG68W4NtLdfkN3LG",
    "account_id": "acc_B518niGwGYKzig6vtrRVZGGGV",
    "environment": "production",
    "external_id": "e797ef3c-b586-4333-af90-7168d8427d85",
    "status": "successful",
    "amount": 10000,
    "fee_amount": 360,
    "net_amount": 9640,
    "currency": "USD",
    "type_id": "pmt_2YKewBonG4tgk12MheY3PiHDy",
    "type": "payment",
    "settlement_id": "stl_BGDLZjBLAgNbyqCzJxchSoh5k",
    "processor": "nuvei",
    "processor_id": "7110000000010554769",
    "acquirer_id": "2630000240513800",
    "payment": {
      "id": "pmt_2YKewBonG4tgk12MheY3PiHDy",
      "account_id": "acc_B518niGwGYKzig6vtrRVZGGGV",
      "environment": "production",
      "external_id": "e797ef3c-b586-4333-af90-7168d8427d85",
      "status": "successful",
      "declined_reason": "Card lost/stolen",
      "transaction_id": "trx_95rvMJvAVeG68W4NtLdfkN3LG",
      "amount": 9500,
      "amount_capturable": 10000,
      "amount_charged": 10000,
      "amount_refunded": 500,
      "refunded": false,
      "currency": "USD",
      "payment_method": {
        "card": {
          "id": "card_8PajTnDVrviEJ8zYJDALFQm5t",
          "cardholder_name": "John Smith",
          "last4": "4242",
          "exp_month": "12",
          "exp_year": "2025",
          "fingerprint": "CC2XvyoohnqecEq4r3FtXv6MdCx4TbaW1UUTdCCN5MNL",
          "brand": "visa",
          "avs_code": "Y",
          "cvv2_reply": "M"
        },
        "bank_account": {
          "id": "ba_7Ay5mcUXAxwrN6wQEQUVEHBCJ",
          "account_holder_name": "John Doe",
          "account_holder_type": "individual",
          "account_type": "individual",
          "routing_number": "123456789",
          "account_number_last4": "1011"
        },
        "account_balance": {
          "account_id": "acc_B518niGwGYKzig6vtrRVZGGGV",
          "account_name": "Test Company, LLC"
        }
      },
      "customer": {
        "id": "cus_7Ay5mcUXAxwrN6wQEQUVEHBCJ",
        "external_id": "e797ef3c-b586-4333-af90-7168d8427d85",
        "business_name": "Awesome Company, LLC",
        "first_name": "John",
        "last_name": "Smith",
        "government_identifier_last4": "9642",
        "email": "john.smith@email.com",
        "phone": "+15554829347"
      },
      "billing_details": {
        "address_line_1": "111 Colorado Ave.",
        "address_line_2": "Apt 403",
        "city": "Des Moines",
        "state": "IA",
        "postal_code": "51111",
        "country": "US"
      },
      "shipping_address": {
        "address_line_1": "111 Colorado Ave.",
        "address_line_2": "Apt 403",
        "city": "Des Moines",
        "state": "IA",
        "postal_code": "51111",
        "country": "US"
      },
      "fraud_details": {
        "decision": "accept",
        "rules": [
          {
            "rule_engine": "nuvei",
            "rule_id": "1287",
            "rule_description": "Stolen card"
          }
        ]
      },
      "dynamic_descriptor": {
        "merchant_name": "Test Corporation",
        "merchant_contact": "+15552604982"
      },
      "transfers": [
        {
          "id": "trnf_7yFLQWACr3DYDSz1xpoEAVfdq",
          "account_id": "acc_B518niGwGYKzig6vtrRVZGGGV",
          "environment": "production",
          "external_id": "e797ef3c-b586-4333-af90-7168d8427d85",
          "type": "payment",
          "status": "successful",
          "payment_transfer_id": "trnf_7yFLQWACr3DYDSz1xpoEAVfdq",
          "payment_id": "pmt_2YKewBonG4tgk12MheY3PiHDy",
          "refund_id": "rfd_2YKewBonG4tgk12MheY3PiHDy",
          "transaction_id": "trx_95rvMJvAVeG68W4NtLdfkN3LG",
          "seller_account_id": "acc_8ooQs32UCdriBvrHnVWbTmJbY",
          "amount": 10000,
          "transfer_fee": 100,
          "currency": "USD",
          "created_at": "2024-06-30T01:02:29.212Z",
          "modified_at": "2024-06-30T01:02:29.212Z"
        }
      ],
      "device_information": {
        "browser_family": "Mobile Safari",
        "os_family": "iOS",
        "device_family": "iPhone",
        "ip_address": "192.168.1.1",
        "user_agent": "Mozilla/5.0 (iPhone; CPU iPhone OS 5_1_1 like Mac OS X) AppleWebKit/534.46 (KHTML, like Gecko) Version/5.1 Mobile/9B206 Safari/7534.48.3"
      },
      "created_at": "2024-06-30T01:02:29.212Z",
      "modified_at": "2024-06-30T01:02:29.212Z"
    },
    "payout": {
      "id": "pyt_24NFPd3jSZFTxiaH9UwjuqNdP",
      "account_id": "acc_B518niGwGYKzig6vtrRVZGGGV",
      "environment": "production",
      "external_id": "1268ce56-a4b5-43fa-8526-a500fc2140bb",
      "status": "successful",
      "declined_reason": "Card lost/stolen",
      "transaction_id": "trx_6QgmXzQzk3S5K5EsR3DfEiMRj",
      "amount": 9500,
      "currency": "USD",
      "payment_method": {
        "card": {
          "id": "card_8PajTnDVrviEJ8zYJDALFQm5t",
          "cardholder_name": "John Smith",
          "last4": "4242",
          "exp_month": "12",
          "exp_year": "2025",
          "fingerprint": "CC2XvyoohnqecEq4r3FtXv6MdCx4TbaW1UUTdCCN5MNL",
          "brand": "visa",
          "avs_code": "Y",
          "cvv2_reply": "M"
        },
        "bank_account": {
          "id": "ba_7Ay5mcUXAxwrN6wQEQUVEHBCJ",
          "account_holder_name": "John Doe",
          "account_holder_type": "individual",
          "account_type": "individual",
          "routing_number": "123456789",
          "account_number_last4": "1011"
        },
        "account_balance": {
          "account_id": "acc_B518niGwGYKzig6vtrRVZGGGV",
          "account_name": "Test Company, LLC"
        }
      },
      "customer": {
        "id": "cus_7Ay5mcUXAxwrN6wQEQUVEHBCJ",
        "external_id": "e797ef3c-b586-4333-af90-7168d8427d85",
        "business_name": "Awesome Company, LLC",
        "first_name": "John",
        "last_name": "Smith",
        "government_identifier_last4": "9642",
        "email": "john.smith@email.com",
        "phone": "+15554829347"
      },
      "billing_details": {
        "address_line_1": "111 Colorado Ave.",
        "address_line_2": "Apt 403",
        "city": "Des Moines",
        "state": "IA",
        "postal_code": "51111",
        "country": "US"
      },
      "dynamic_descriptor": {
        "merchant_name": "Test Corporation",
        "merchant_contact": "+15552604982"
      },
      "device_information": {
        "browser_family": "Mobile Safari",
        "os_family": "iOS",
        "device_family": "iPhone",
        "ip_address": "192.168.1.1",
        "user_agent": "Mozilla/5.0 (iPhone; CPU iPhone OS 5_1_1 like Mac OS X) AppleWebKit/534.46 (KHTML, like Gecko) Version/5.1 Mobile/9B206 Safari/7534.48.3"
      },
      "created_at": "2024-06-30T01:02:29.212Z",
      "modified_at": "2024-06-30T01:02:29.212Z"
    },
    "refund": {
      "id": "rfd_2YKewBonG4tgk12MheY3PiHDy",
      "account_id": "acc_B518niGwGYKzig6vtrRVZGGGV",
      "environment": "production",
      "external_id": "e797ef3c-b586-4333-af90-7168d8427d85",
      "status": "successful",
      "transaction_id": "trx_95rvMJvAVeG68W4NtLdfkN3LG",
      "payment_id": "pmt_2YKewBonG4tgk12MheY3PiHDy",
      "amount": 500,
      "currency": "USD",
      "reason": "Refunding shipping",
      "declined_reason": "Suspected fraud",
      "transfers": [
        {
          "id": "trnf_7yFLQWACr3DYDSz1xpoEAVfdq",
          "account_id": "acc_B518niGwGYKzig6vtrRVZGGGV",
          "environment": "production",
          "external_id": "e797ef3c-b586-4333-af90-7168d8427d85",
          "type": "payment",
          "status": "successful",
          "payment_transfer_id": "trnf_7yFLQWACr3DYDSz1xpoEAVfdq",
          "payment_id": "pmt_2YKewBonG4tgk12MheY3PiHDy",
          "refund_id": "rfd_2YKewBonG4tgk12MheY3PiHDy",
          "transaction_id": "trx_95rvMJvAVeG68W4NtLdfkN3LG",
          "seller_account_id": "acc_8ooQs32UCdriBvrHnVWbTmJbY",
          "amount": 10000,
          "transfer_fee": 100,
          "currency": "USD",
          "created_at": "2024-06-30T01:02:29.212Z",
          "modified_at": "2024-06-30T01:02:29.212Z"
        }
      ],
      "device_information": {
        "browser_family": "Mobile Safari",
        "os_family": "iOS",
        "device_family": "iPhone",
        "ip_address": "192.168.1.1",
        "user_agent": "Mozilla/5.0 (iPhone; CPU iPhone OS 5_1_1 like Mac OS X) AppleWebKit/534.46 (KHTML, like Gecko) Version/5.1 Mobile/9B206 Safari/7534.48.3"
      },
      "created_at": "2024-06-30T01:02:29.212Z",
      "modified_at": "2024-06-30T01:02:29.212Z"
    },
    "transfer": {
      "id": "trnf_7yFLQWACr3DYDSz1xpoEAVfdq",
      "account_id": "acc_B518niGwGYKzig6vtrRVZGGGV",
      "environment": "production",
      "external_id": "e797ef3c-b586-4333-af90-7168d8427d85",
      "type": "payment",
      "status": "successful",
      "payment_transfer_id": "trnf_7yFLQWACr3DYDSz1xpoEAVfdq",
      "payment_id": "pmt_2YKewBonG4tgk12MheY3PiHDy",
      "refund_id": "rfd_2YKewBonG4tgk12MheY3PiHDy",
      "transaction_id": "trx_95rvMJvAVeG68W4NtLdfkN3LG",
      "seller_account_id": "acc_8ooQs32UCdriBvrHnVWbTmJbY",
      "amount": 10000,
      "transfer_fee": 100,
      "currency": "USD",
      "created_at": "2024-06-30T01:02:29.212Z",
      "modified_at": "2024-06-30T01:02:29.212Z"
    },
    "created_at": "2024-06-30T01:02:29.212Z",
    "modified_at": "2024-06-30T01:02:29.212Z"
  },
  "created_at": "2024-06-30T01:02:29.212Z",
  "modified_at": "2024-06-30T01:02:29.212Z"
}

400

Bad Request

application/json

Schema

Schema

errors objectnullable
property name* string[]
Array [
string
]
typestringnullable
titlestringnullable
statusint32nullable
detailstringnullable
instancestringnullable
property name*any

Example (auto)

{
  "errors": {},
  "type": "string",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string"
}

401

Unauthorized

application/json

Schema

Schema

typestringnullable
titlestringnullable
statusint32nullable
detailstringnullable
instancestringnullable
property name*any

Example (auto)

{
  "type": "string",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string"
}

403

Forbidden

application/json

Schema

Schema

typestringnullable
titlestringnullable
statusint32nullable
detailstringnullable
instancestringnullable
property name*any

Example (auto)

{
  "type": "string",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string"
}

404

Not Found

application/json

Schema

Schema

typestringnullable
titlestringnullable
statusint32nullable
detailstringnullable
instancestringnullable
property name*any

Example (auto)

{
  "type": "string",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string"
}

Authorization: X-API-KEY

name: X-API-KEYtype: apiKeyscopes: settlement:readdescription: Authorization by API Key inside request's X-API-KEY headerin: header

• csharp
• curl
• dart
• go
• http
• java
• javascript
• kotlin
• c
• nodejs
• objective-c
• ocaml
• php
• powershell
• python
• r
• ruby
• rust
• shell
• swift

• HTTPCLIENT
• RESTSHARP

var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Get, "https://api.publicsquare.com/settlements/:id");
request.Headers.Add("Accept", "application/json");
request.Headers.Add("X-API-KEY", "<X-API-KEY>");
var response = await client.SendAsync(request);
response.EnsureSuccessStatusCode();
Console.WriteLine(await response.Content.ReadAsStringAsync());

Request Collapse all

Base URL

https://api.publicsquare.com

Auth

ApiKey

Parameters

id — pathrequired

ResponseClear

Click the Send API Request button above and see the response here!