Create payment method

post https://api.loopcrypto.xyz/api/v2/payment-method

Creates a new payment method in the system. A payment method represents a payment method that can be used to make a payment. Returns the newly created payment method details including its unique identifier and status.

Body Params

name

string

required

A descriptive name to identify this payment method

merchantId

string

required

The ID of the merchant to associate this payment method with.

customerId

string

required

The ID of the customer to associate this payment method with.

Note: This is not the customerRefId from the customer object, it is the customerId

networkId

int32

required

≥ 1

The blockchain network ID the payout destination is associated with.

Valid values:

1 (Ethereum)
10 (Optimism)
56 (BNB)
137 (Polygon)
8453 (Base)
42161 (Arbitrum)
900 (Solana)
11155111 (Sepolia) - Only available on the demo environment
901 (Solana devnet) - Only available on the demo environment

walletAddress

string

required

The blockchain wallet address where payments will be sent from. Must be a valid address for the specified network.

tokenAddress

string

The token contract address for the payment type. Must be a valid token contract address for the specified network. Either 'tokenAddress' or 'tokenSymbol' must be provided.

tokenSymbol

string

The token symbol that identifies the token on the blockchain network. Must match the symbol of the token contract. Either 'tokenAddress' or 'tokenSymbol' must be provided.

isDefault

boolean

Whether the payment method is the default payment method for wallet address. Defaults to true.

authorizationSignature

string

required

A base64 encoded JWT token containing a signature proving ownership of the wallet address being registered as a payment method.

Responses

Response body

object

paymentMethodId

string

required

The unique identifier for the payment method

merchantId

string

required

The unique identifier of the merchant this payment method is associated with

paymentMethodName

string

required

The name of the payment method

customer

object

required

The customers that are associated with the payment method

customerId

string

required

The unique identifier that represents the customer

customerRefId

string

required

The external customer reference ID used to tie this customer to a customer in an external system.

networkId

double

required

The blockchain network ID the payment method is associated with

walletAddress

string

required

The blockchain wallet address where payments will be sent from

isDefault

boolean

required

Whether the payment method is the default payment method for wallet address

token

object

required

The token associated with the payment method

symbol

string

required

The token symbol that identifies the token on the blockchain network

tokenId

string

required

The unique identifier for the token used by the payment type.

address

string

required

The token contract address for the payment type

decimals

double

required

The number of decimal places used to represent token amounts

exchangeRates

array of objects

required

The exchange rate of the token

exchangeRates*

object

currency

string

required

The currency code. Only "USD" is supported at this time.

price

string

required

The price of the token in the specified currency code. Accurate to 4 decimal places, e.g. a price of "1.9900" represents $1.99

timestamp

double

required

The Unix timestamp (in seconds) when this exchange rate was last updated

preAuthorization

object | null

required

The status of the payment method, including the wallet's balance and authorization status

balance

string

required

The balance of the payment method formatted in the token amount

authorization

string

required

The authorization amount of the payment method formatted in the token amount

dateCreated

double

required

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

Language

Credentials

URL


xxxxxxxxxx
1
curl --request POST \
2
     --url https://api.loopcrypto.xyz/api/v2/payment-method \
3
     --header 'accept: application/json' \
4
     --header 'content-type: application/json'

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Ok

400Bad Request

401Unauthorized

403Forbidden

422Unprocessable Content

500Internal Server Error

504Gateway Timeout