Skip to main content
GET
/
api
/
v2
/
payin
/
{payinId}
Get payin
curl --request GET \
  --url https://demo.api.loopcrypto.xyz/api/v2/payin/{payinId} \
  --header 'Authorization: Bearer <token>'
{
  "payinId": "8f47c6e9-2b3a-4d5c-9f8e-1a2b3c4d5e6f",
  "merchantId": "67e55044-10b1-426f-9247-bb680e5fe0c8",
  "amount": "100.00",
  "amountType": "fiat",
  "billDate": 1716211200,
  "invoiceId": "1234567890abcdef",
  "description": "Payment for Developer plan",
  "externalInvoiceRef": "1234567890abcdef",
  "externalSubscriptionRefId": "sub_1234abcd",
  "payinType": "subscription",
  "payinStatus": "scheduled",
  "transaction": {
    "transactionId": "0xcfdfbb523c079e47e9a17ba236fa978257d4331e96ec43997e974b97522047fe",
    "transactionUrl": "https://etherscan.io/tx/0xcfdfbb523c079e47e9a17ba236fa978257d4331e96ec43997e974b97522047fe",
    "amountTransferred": "1990000",
    "exchangeRate": {
      "currency": "USD",
      "price": "10000",
      "provider": "CoinMarketCap",
      "timestamp": 1715731200
    }
  },
  "paymentMethod": {
    "networkId": 1,
    "paymentMethodId": "1234567890abcdef",
    "paymentMethodName": "My Crypto Wallet",
    "active": true,
    "customer": {
      "customerId": "1234567890abcdef",
      "customerRefId": "1234567890abcdef"
    },
    "walletAddress": "0x1234567890abcdef",
    "isDefault": true,
    "token": {
      "symbol": "USDC",
      "tokenId": "123e4567-e89b-12d3-a456-426614174000",
      "address": "0x1234567890abcdef",
      "decimals": 6,
      "exchangeRates": [
        {
          "currency": "USD",
          "price": "10000",
          "provider": "CoinMarketCap",
          "timestamp": 1715731200
        }
      ]
    },
    "preAuthorization": {
      "balance": "100",
      "authorization": "49.9"
    },
    "status": "ok"
  },
  "payoutDestination": {
    "networkId": 1,
    "walletAddress": "0x1234567890abcdef",
    "payoutDestinationId": "1234567890abcdef",
    "settlementType": "Crypto"
  },
  "dateCreated": 1716211200
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
payinId
string
required

The unique identifier of the payin to retrieve. This must be a valid payin ID associated with your entity. Used to look up the specific payin's details including configuration, status, and other relevant information

Response

Ok

​
payinId
string
required

The unique identifier for the payin

Example:

"8f47c6e9-2b3a-4d5c-9f8e-1a2b3c4d5e6f"

​
merchantId
string
required

The unique identifier of the merchant this payin is associated with

Example:

"67e55044-10b1-426f-9247-bb680e5fe0c8"

​
amount
string
required

The amount to be paid, specified in either fiat or crypto based on amountType

Example:

"100.00"

​
amountType
enum<string>
required

The type of the amount, either "fiat" or "token"

Available options:
fiat,
token
Example:

"fiat"

​
billDate
number
required

The date the payment will take place, represented as a Unix timestamp

Example:

1716211200

​
invoiceId
string
required

The unique invoice identifier representing this payin transaction

Example:

"1234567890abcdef"

​
description
string | null
required

(Optional) A description or note that provides additional context about this payin. This can be used to help identify or provide details about the payment for internal reference or customer communications.

Example:

"Payment for Developer plan"

​
externalInvoiceRef
string | null
required

(Optional) The external invoice ID used to tie this payin to an invoice in an external system

Example:

"1234567890abcdef"

​
externalSubscriptionRefId
string | null
required

(Optional) The external subscription ID used to tie this payin to a subscription in an external system

Example:

"sub_1234abcd"

​
payinType
enum<string>
required

The type of the payin, either "subscription" or "invoice"

Available options:
subscription,
invoice
Example:

"subscription"

​
payinStatus
enum<string>
required

The status of the payin, can be "scheduled", "pending", "completed", or "failed"

Available options:
scheduled,
pending,
completed,
failed,
canceled,
uncollectible,
draft
Example:

"scheduled"

​
transaction
object
required

The transaction details for the payin

​
paymentMethod
object
required

The payment method used for this payin

​
payoutDestination
object
required

The payout destination used for this payin

​
dateCreated
number
required

The date the payin record was created, represented as a Unix timestamp in seconds.

Example:

1716211200

⌘I